const_user_data.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2015:  G-CSC, Goethe University Frankfurt
 * Author: Andreas Vogel
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 */
 
#ifndef __H__UG__LIB_DISC__SPATIAL_DISC__USER_DATA__CONST_USER_DATA__
#define __H__UG__LIB_DISC__SPATIAL_DISC__USER_DATA__CONST_USER_DATA__
 
#include "common/common.h"
#include "common/math/ugmath.h"
 
#include "std_user_data.h"
 
namespace ug {
 
 
// Base class for Constant Data
 
template <typename TImpl, typename TData, int dim>
class StdConstData
  :   public StdUserData<StdConstData<TImpl,TData,dim>, TData, dim>
{
  public:
    virtual void operator() (TData& value,
                 const MathVector<dim>& globIP,
                 number time, int si) const
    {
      getImpl().evaluate(value);
    }
 
    virtual void operator()(TData vValue[],
                const MathVector<dim> vGlobIP[],
                number time, int si, const size_t nip) const
    {
      for(size_t ip = 0; ip < nip; ++ip)
        getImpl().evaluate(vValue[ip]);
    }
 
    template <int refDim>
    inline void evaluate(TData vValue[],
                         const MathVector<dim> vGlobIP[],
                         number time, int si,
                         GridObject* elem,
                         const MathVector<dim> vCornerCoords[],
                         const MathVector<refDim> vLocIP[],
                         const size_t nip,
                         LocalVector* u,
                         const MathMatrix<refDim, dim>* vJT = NULL) const
    {
      for(size_t ip = 0; ip < nip; ++ip)
        getImpl().evaluate(vValue[ip]);
    }
 
    virtual void compute(LocalVector* u, GridObject* elem,
                         const MathVector<dim> vCornerCoords[], bool bDeriv = false)
    {
      for(size_t s = 0; s < this->num_series(); ++s)
        for(size_t ip = 0; ip < this->num_ip(s); ++ip)
          getImpl().evaluate(this->value(s,ip));
    }
 
    virtual void compute(LocalVectorTimeSeries* u, GridObject* elem,
                         const MathVector<dim> vCornerCoords[], bool bDeriv = false)
    {
      for(size_t s = 0; s < this->num_series(); ++s)
        for(size_t ip = 0; ip < this->num_ip(s); ++ip)
          getImpl().evaluate(this->value(s,ip));
    }
 
    virtual void value_storage_changed(const size_t seriesID)
    {
      for(size_t ip = 0; ip < this->num_ip(seriesID); ++ip)
        getImpl().evaluate(this->value(seriesID,ip));
    }
 
    virtual bool constant() const {return true;}
 
    virtual bool requires_grid_fct() const {return false;}
 
    virtual bool continuous() const {return true;}
 
  protected:
    TImpl& getImpl() {return static_cast<TImpl&>(*this);}
 
    const TImpl& getImpl() const {return static_cast<const TImpl&>(*this);}
};
 
// Constant UserData
 
 
template <int dim>
class ConstUserNumber
  : public StdConstData<ConstUserNumber<dim>, number, dim>
{
  public:
    ConstUserNumber() {set(0.0);}
 
    ConstUserNumber(number val) {set(val);}
 
    void set(number val) {m_Number = val;}
 
    void print() const {UG_LOG("ConstUserNumber:" << m_Number << "\n");}
 
    inline void evaluate (number& value) const {value = m_Number;}
 
    number get() const {return m_Number;}
 
  protected:
    number m_Number;
};
 
 
template <int dim, int worldDim = dim>
class ConstUserVector
  : public StdConstData<ConstUserVector<dim, worldDim>, MathVector<dim>, worldDim>
{
  public:
    ConstUserVector() {set_all_entries(0.0);}
 
    ConstUserVector(number val) {set_all_entries(val);}
 
    ConstUserVector(const std::vector<number>& val) {set_vector(val);}
 
    void set_all_entries(number val) { m_Vector = val;}
 
    void set_entry(size_t i, number val){m_Vector[i] = val;}
  
    void set_vector(const std::vector<number>& val)
    {
      if(val.size() != dim) UG_THROW("Size mismatch in ConstUserVector");
      for(size_t i = 0; i < dim; i++) m_Vector[i] = val[i];
    }
 
    void print() const {UG_LOG("ConstUserVector:" << m_Vector << "\n");}
 
    inline void evaluate (MathVector<dim>& value) const{value = m_Vector;}
 
  protected:
    MathVector<dim> m_Vector;
};
 
 
template <int N, int M = N, int worldDim = N>
class ConstUserMatrix
  : public StdConstData<ConstUserMatrix<N, M, worldDim>, MathMatrix<N, M>, worldDim>
{
  public:
    ConstUserMatrix() {set_diag_tensor(1.0);}
 
    ConstUserMatrix(number val) {set_diag_tensor(val);}
 
    void set_diag_tensor(number val)
    {
      for(size_t i = 0; i < N; ++i){
        for(size_t j = 0; j < M; ++j){
          m_Tensor[i][j] = 0;
        }
        m_Tensor[i][i] = val;
      }
    }
 
    void set_all_entries(number val)
    {
      for(size_t i = 0; i < N; ++i){
        for(size_t j = 0; j < M; ++j){
          m_Tensor[i][j] = val;
        }
      }
    }
 
    void set_entry(size_t i, size_t j, number val){m_Tensor[i][j] = val;}
 
    void print() const{UG_LOG("ConstUserMatrix:\n" << m_Tensor << "\n");}
 
    inline void evaluate (MathMatrix<N, M>& value) const{value = m_Tensor;}
 
  protected:
    MathMatrix<N, M> m_Tensor;
};
 
template <int TRank, int dim>
class ConstUserTensor
  : public StdConstData<ConstUserTensor<TRank,dim>, MathTensor<TRank, dim>, dim>
{
  public:
    ConstUserTensor() {set(0.0);}
 
    ConstUserTensor(number val) {set(val);}
 
    void set(number val) {m_Tensor.set(val);}
 
    void print() const{UG_LOG("ConstUserTensor:\n" << m_Tensor << "\n");}
 
    inline void evaluate (MathTensor<TRank, dim>& value) const{value = m_Tensor;}
 
  protected:
    MathTensor<TRank, dim> m_Tensor;
};
 
template <typename TData, int dim>
SmartPtr<CplUserData<TData,dim> > CreateConstUserData(number val, TData dummy);
 
template <int dim>
inline SmartPtr<CplUserData<number,dim> > CreateConstUserData(number val, number)
{
  return make_sp(new ConstUserNumber<dim>(val));
};
 
template <int dim, int worldDim=dim>
SmartPtr<CplUserData<MathVector<dim>,worldDim> > CreateConstUserData(number val, MathVector<dim>)
{
  return make_sp(new ConstUserVector<dim,worldDim>(val));
}
 
template <int dim>
SmartPtr<CplUserData<MathMatrix<dim,dim>,dim> > CreateConstUserData(number val, MathMatrix<dim,dim>)
{
  return make_sp(new ConstUserMatrix<dim>(val));
}
 
template <int dim>
SmartPtr<CplUserData<MathTensor<4,dim>,dim> > CreateConstUserData(number val, MathTensor<4,dim>)
{
  return make_sp(new ConstUserTensor<4,dim>(val));
}
 
 
} 
 
#endif /* __H__UG__LIB_DISC__SPATIAL_DISC__USER_DATA__CONST_USER_DATA__ */