convection_diffusion_base.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-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__CONVECTION_DIFFUSION__CONVECTION_DIFFUSION_BASE__
#define __H__UG__LIB_DISC__CONVECTION_DIFFUSION__CONVECTION_DIFFUSION_BASE__
 
// other ug4 modules
#include "common/common.h"
#include "lib_grid/lg_base.h"
 
// library intern headers
#include "lib_disc/spatial_disc/elem_disc/elem_disc_interface.h"
#include "lib_disc/spatial_disc/user_data/data_export.h"
#include "lib_disc/spatial_disc/user_data/data_import.h"
 
namespace ug{
namespace ConvectionDiffusionPlugin{
 
 
 
template< typename TDomain>
class ConvectionDiffusionBase
: public IElemDisc<TDomain>
{
  private:
    typedef IElemDisc<TDomain> base_type;
 
  public:
    static const int dim = base_type::dim;
 
  public:
    ConvectionDiffusionBase(const char* functions, const char* subsets);
  protected:
    void init_imports();
  public:
 
    void set_diffusion(SmartPtr<CplUserData<MathMatrix<dim, dim>, dim> > user);
    void set_diffusion(number val);
#ifdef UG_FOR_LUA
    void set_diffusion(const char* fctName);
    void set_diffusion(LuaFunctionHandle fct);
#endif
 
 
    void set_velocity(SmartPtr<CplUserData<MathVector<dim>, dim> > user);
    void set_velocity(const std::vector<number>& vVel);
#ifdef UG_FOR_LUA
    void set_velocity(const char* fctName);
    void set_velocity(LuaFunctionHandle fct);
#endif
 
 
    void set_flux(SmartPtr<CplUserData<MathVector<dim>, dim> > user);
    void set_flux(const std::vector<number>& vVel);
#ifdef UG_FOR_LUA
    void set_flux(const char* fctName);
    void set_flux(LuaFunctionHandle fct);
#endif
 
 
    void set_reaction_rate(SmartPtr<CplUserData<number, dim> > user);
    void set_reaction_rate(number val);
#ifdef UG_FOR_LUA
    void set_reaction_rate(const char* fctName);
    void set_reaction_rate(LuaFunctionHandle fct);
#endif
 
 
    void set_reaction(SmartPtr<CplUserData<number, dim> > user);
    void set_reaction(number val);
#ifdef UG_FOR_LUA
    void set_reaction(const char* fctName);
    void set_reaction(LuaFunctionHandle fct);
#endif
 
    void set_reaction_rate_explicit(SmartPtr<CplUserData<number, dim> > user);
    void set_reaction_rate_explicit(number val);
#ifdef UG_FOR_LUA
    void set_reaction_rate_explicit(const char* fctName);
#endif
 
    void set_reaction_explicit(SmartPtr<CplUserData<number, dim> > user);
    void set_reaction_explicit(number val);
#ifdef UG_FOR_LUA
    void set_reaction_explicit(const char* fctName);
#endif
 
    void set_source_explicit(SmartPtr<CplUserData<number, dim> > user);
    void set_source_explicit(number val);
#ifdef UG_FOR_LUA
    void set_source_explicit(const char* fctName);
#endif
 
 
    void set_source(SmartPtr<CplUserData<number, dim> > user);
    void set_source(number val);
#ifdef UG_FOR_LUA
    void set_source(const char* fctName);
    void set_source(LuaFunctionHandle fct);
#endif
 
 
    void set_vector_source(SmartPtr<CplUserData<MathVector<dim>, dim> > user);
    void set_vector_source(const std::vector<number>& vVel);
#ifdef UG_FOR_LUA
    void set_vector_source(const char* fctName);
    void set_vector_source(LuaFunctionHandle fct);
#endif
 
 
    void set_mass_scale(SmartPtr<CplUserData<number, dim> > user);
    void set_mass_scale(number val);
#ifdef UG_FOR_LUA
    void set_mass_scale(const char* fctName);
    void set_mass_scale(LuaFunctionHandle fct);
#endif
 
 
    void set_mass(SmartPtr<CplUserData<number, dim> > user);
    void set_mass(number val);
#ifdef UG_FOR_LUA
    void set_mass(const char* fctName);
    void set_mass(LuaFunctionHandle fct);
#endif
 
  protected:
    DataImport<MathMatrix<dim,dim>, dim> m_imDiffusion;
 
    DataImport<MathVector<dim>, dim > m_imVelocity;
 
    DataImport<MathVector<dim>, dim > m_imFlux;
 
    DataImport<number, dim> m_imReactionRate;
 
    DataImport<number, dim> m_imReaction;
 
    DataImport<number, dim> m_imReactionRateExpl;
 
    DataImport<number, dim> m_imReactionExpl;
 
    DataImport<number, dim> m_imSourceExpl;
 
    DataImport<number, dim> m_imSource;
 
    DataImport<MathVector<dim>, dim > m_imVectorSource;
 
    DataImport<number, dim> m_imMassScale;
 
    DataImport<number, dim> m_imMass;
 
  private:
    virtual bool requests_local_time_series() {return false;}
 
  public:
    typedef SmartPtr<CplUserData<number, dim> > NumberExport;
    typedef SmartPtr<CplUserData<MathVector<dim>, dim> > GradExport;
 
    virtual SmartPtr<CplUserData<number, dim> > value();
 
    virtual SmartPtr<CplUserData<MathVector<dim>, dim> > gradient();
 
  protected:
    SmartPtr<DataExport<number, dim> > m_exValue;
 
    SmartPtr<DataExport<MathVector<dim>, dim> > m_exGrad;
};
 
// end group convection_diffusion
 
} // end ConvectionDiffusionPlugin
} // end namespace ug
 
 
#endif /*__H__UG__LIB_DISC__CONVECTION_DIFFUSION__CONVECTION_DIFFUSION_BASE__*/