density_driven_flow_base.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2025 Gesellschaft fuer Anlagen- und Reaktorsicherheit gGmbH
 * SPDX-License-Identifier: EUPL-1.2
 * SPDX-FileContributor: Andreas Vogel
 * SPDX-FileContributor: Goethe Universität Frankfurt
 * SPDX-FileType: SOURCE
 * 
 * This file is part of d3f++.
 * d3f++ is an extension for UG4. Licensing information and citation requirements of UG4 are provided in LICENSES/UG4-LGPL_2.1
 */
 
 
#ifndef __H__UG__LIB_DISC__DENSITY_DRIVEN_FLOW__FV1__DENSITY_DRIVEN_FLOW_BASE_
#define __H__UG__LIB_DISC__DENSITY_DRIVEN_FLOW__FV1__DENSITY_DRIVEN_FLOW_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 d3f{
 
 
 
template<typename TDomain>
class DensityDrivenFlowBase
  : public IElemDisc<TDomain>
{
  private:
    typedef IElemDisc<TDomain> base_type;
 
    typedef DensityDrivenFlowBase<TDomain> this_type;
 
  public:
    static const int dim = base_type::dim;
 
  public:
    DensityDrivenFlowBase(const char* functions, const char* subsets);
    DensityDrivenFlowBase(const std::vector<std::string>& vFct, const std::vector<std::string>& vSubset);
 
    void set_boussinesq_transport(bool bUse) {m_BoussinesqTransport = bUse;}
 
    void set_boussinesq_flow(bool bUse) {m_BoussinesqFlow = bUse;}
 
 
    virtual void set_porosity(SmartPtr<CplUserData<number, dim> > user) = 0;
    void set_porosity(number val);
#ifdef UG_FOR_LUA
    void set_porosity(const char* fctName);
    void set_porosity(LuaFunctionHandle fct);
#endif
 
 
    virtual void set_gravity(SmartPtr<CplUserData<MathVector<dim>, dim> > user) = 0;
    void set_gravity(const std::vector<number>& vVel);
#ifdef UG_FOR_LUA
    void set_gravity(const char* fctName);
    void set_gravity(LuaFunctionHandle fct);
#endif
 
 
    virtual void set_molecular_diffusion(SmartPtr<CplUserData<MathMatrix<dim, dim>, dim> > user) = 0;
    void set_molecular_diffusion(number val);
#ifdef UG_FOR_LUA
    void set_molecular_diffusion(const char* fctName);
    void set_molecular_diffusion(LuaFunctionHandle fct);
#endif
 
 
    virtual void set_permeability(SmartPtr<CplUserData<MathMatrix<dim, dim>, dim> > user) = 0;
    void set_permeability(number val);
#ifdef UG_FOR_LUA
    void set_permeability(const char* fctName);
    void set_permeability(LuaFunctionHandle fct);
#endif
 
 
    virtual void set_viscosity(SmartPtr<CplUserData<number, dim> > user) = 0;
    void set_viscosity(number val);
#ifdef UG_FOR_LUA
    void set_viscosity(const char* fctName);
    void set_viscosity(LuaFunctionHandle fct);
#endif
 
 
    virtual void set_density(SmartPtr<CplUserData<number,dim> > data) = 0;
    void set_density(number val);
#ifdef UG_FOR_LUA
    void set_density(const char* fctName);
    void set_density(LuaFunctionHandle fct);
#endif
 
    virtual void set_dispersion(SmartPtr<CplUserData<MathMatrix<dim,dim>,dim> > data) = 0;
 
  protected:
    void init(const char* functions);
 
    virtual bool requests_local_time_series() {return false;}
 
  protected:
    bool m_BoussinesqTransport;
 
    bool m_BoussinesqFlow;
 
    MathVector<dim> m_Gravity;
 
  public:
    SmartPtr<CplUserData<MathVector<dim>, dim> > darcy_velocity() {return m_exDarcyVel;}
 
    SmartPtr<CplUserData<number, dim> > brine() {return m_exBrine;}
 
    SmartPtr<CplUserData<number, dim> > pressure() {return m_exPressure;}
 
    SmartPtr<CplUserData<MathVector<dim>, dim> > brine_grad() {return m_exBrineGrad;}
 
    SmartPtr<CplUserData<MathVector<dim>, dim> > pressure_grad() {return m_exPressureGrad;}
 
    SmartPtr<CplUserData<MathMatrix<dim, dim>, dim> > brine_tensor() {return m_exBrineTensor;}
 
    SmartPtr<CplUserData<MathMatrix<dim, dim>, dim> > pressure_tensor() {return m_exPressureTensor;}
 
  protected:
    void compute_ip_darcy_velocity_std(
        MathVector<dim>& DarcyVel,
        const MathMatrix<dim, dim>& Permeability,
        number Viscosity,
        const MathVector<dim>& DensityTimesGravity,
        const MathVector<dim>& PressureGrad,
        bool compDeriv = false,
        MathVector<dim>* DarcyVel_c = NULL,
        MathVector<dim>* DarcyVel_p = NULL,
        const MathVector<dim>* DensityTimesGravity_c = NULL,
        const number* Viscosity_c = NULL,
        const MathVector<dim>* PressureGrad_p = NULL,
        size_t numSh = 0);
 
  protected:
    SmartPtr<DataExport<MathVector<dim>, dim> > m_exDarcyVel;
 
    SmartPtr<DataExport<number, dim> > m_exBrine;
 
    SmartPtr<DataExport<MathVector<dim>,dim> > m_exBrineGrad;
 
    SmartPtr<DataExport<number, dim> > m_exPressure;
 
    SmartPtr<DataExport<MathVector<dim>,dim> > m_exPressureGrad;
 
    SmartPtr<DataExport<MathMatrix<dim,dim>,dim> > m_exBrineTensor;
 
    SmartPtr<DataExport<MathMatrix<dim,dim>,dim> > m_exPressureTensor;
};
 
 
} // namespace d3f
} // end namespace ug
 
#endif /*__H__UG__LIB_DISC__DENSITY_DRIVEN_FLOW__FV1__DENSITY_DRIVEN_FLOW_BASE_*/