thermohaline_flow.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__SPATIAL_DISC__ELEM_DISC__THERMOHALINE_FLOW__FV1__THERMOHALINE_FLOW__
#define __H__UG__LIB_DISC__SPATIAL_DISC__ELEM_DISC__THERMOHALINE_FLOW__FV1__THERMOHALINE_FLOW__
 
// 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"
 
#include "lib_disc/spatial_disc/disc_util/conv_shape_interface.h"
#include "lib_disc/spatial_disc/disc_util/consistent_gravity.h"
 
#include "../extravol.h"
#include "../d3f_sss.h"
#include "../d3f_limex.h"
 
namespace ug{
namespace d3f{
 
 
 
template<typename TDomain>
class ThermohalineFlow
  : public IElemDisc<TDomain>
{
  private:
    typedef IElemDisc<TDomain> base_type;
 
    typedef ThermohalineFlow<TDomain> this_type;
 
  public:
    typedef typename base_type::domain_type domain_type;
 
    static const int dim = base_type::dim;
 
    typedef typename base_type::position_type position_type;
 
  public:
    ThermohalineFlow(const char* functions, const char* subsets);
    ThermohalineFlow(const std::vector<std::string>& vFct, const std::vector<std::string>& vSubset);
 
    void set_consistent_gravity(bool bUse);
 
    void set_boussinesq_transport(bool bUse) {m_BoussinesqTransport = bUse;}
 
    void set_boussinesq_flow(bool bUse) {m_BoussinesqFlow = bUse;}
 
    void set_boussinesq_density(number den);
 
    void set_volume_stabilization(SmartPtr<FlowVolStabData<TDomain> > volStabData);
 
 
    void set_upwind(SmartPtr<IConvectionShapes<dim> > shape);
 
 
    void set_upwind_energy(SmartPtr<IConvectionShapes<dim> > shape);
 
 
    void set_porosity(SmartPtr<CplUserData<number, dim> > user);
    void set_porosity(number val);
#ifdef UG_FOR_LUA
    void set_porosity(const char* fctName);
#endif
 
 
    void set_gravity(SmartPtr<CplUserData<MathVector<dim>, dim> > user);
    void set_gravity(number vel_x);
    void set_gravity(number vel_x, number vel_y);
    void set_gravity(number vel_x, number vel_y, number vel_z);
#ifdef UG_FOR_LUA
    void set_gravity(const char* fctName);
#endif
 
 
    void set_molecular_diffusion(SmartPtr<CplUserData<MathMatrix<dim, dim>, dim> > user);
    void set_molecular_diffusion(number val);
#ifdef UG_FOR_LUA
    void set_molecular_diffusion(const char* fctName);
#endif
 
 
    void set_thermal_conductivity(SmartPtr<CplUserData<MathMatrix<dim, dim>, dim> > user);
    void set_thermal_conductivity(number val);
#ifdef UG_FOR_LUA
    void set_thermal_conductivity(const char* fctName);
#endif
 
 
    void set_permeability(SmartPtr<CplUserData<MathMatrix<dim, dim>, dim> > user);
    void set_permeability(number val);
#ifdef UG_FOR_LUA
    void set_permeability(const char* fctName);
    void set_permeability(LuaFunctionHandle fct);
#endif
 
 
    void set_viscosity(SmartPtr<CplUserData<number, dim> > user);
    void set_viscosity(number val);
#ifdef UG_FOR_LUA
    void set_viscosity(const char* fctName);
#endif
 
    void set_density(SmartPtr<CplUserData<number, dim> > data);
 
    void set_dispersion(SmartPtr<CplUserData<MathMatrix<dim,dim>,dim> > data);
    void set_scheidegger_dispersion(const number alphaLong, const number alphaTrans);
  
 
    void set_heat_capacity_solid(number data);
 
 
    void set_heat_capacity_fluid(number data);
 
 
    void set_mass_density_solid(number data);
 
    void set_sss_manager(SmartPtr<THSingularSourcesAndSinks<dim> > sss_mngr) {m_sss_mngr = sss_mngr;}
 
    SmartPtr<THSingularSourcesAndSinks<dim> > sss_manager() {return m_sss_mngr;}
 
  public:
    virtual void prepare_setting(const std::vector<LFEID>& vLfeID, bool bNonRegularGrid);
 
  private:
    void init(const char* functions);
 
    virtual bool requests_local_time_series();
 
    virtual void prep_assemble_loop();
 
    template <typename TElem>
    void prep_elem_loop(const ReferenceObjectID roid, const int si);
 
    template <typename TElem>
    void prep_elem(const LocalVector& u, GridObject* elem, const ReferenceObjectID roid, const MathVector<dim> vCornerCoords[]);
 
    template <typename TElem>
    void fsh_elem_loop();
 
    template <typename TElem>
    void add_jac_A_elem(LocalMatrix& J, const LocalVector& u, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    template <typename TElem>
    void add_jac_M_elem(LocalMatrix& J, const LocalVector& u, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    template <typename TElem>
    void add_def_A_elem(LocalVector& d, const LocalVector& u, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    template <typename TElem>
    void add_def_M_elem(LocalVector& d, const LocalVector& u, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    template <typename TElem>
    void add_rhs_elem(LocalVector& d, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
  private:
    
    template<typename TElem>
    void add_sss_jac_elem
    (
      LocalMatrix& J, 
      const LocalVector& u, 
      TElem* elem, 
      const FV1Geometry<TElem, dim>& geo, 
      size_t i, 
      number intensity, 
      number concentration, 
      number temperature, 
      number factor = 1 
    );
  
    template<typename TElem>
    void add_sss_def_elem
    (
      LocalVector& d, 
      const LocalVector& u, 
      TElem* elem, 
      const FV1Geometry<TElem, dim>& geo, 
      size_t i, 
      number intensity, 
      number concentration, 
      number temperature, 
      number factor = 1 
    );
  
  private:
    SmartPtr<IConvectionShapes<dim> > m_spUpwind;
 
    SmartPtr<IConvectionShapes<dim> > m_spUpwindEnergy;
 
    bool m_bConsGravity;
 
    bool m_BoussinesqTransport;
 
    bool m_BoussinesqFlow;
 
    bool m_BoussinesqEnergy;
 
    SmartPtr<FlowVolStabData<TDomain> > m_spVolStabData;
    bool m_bVolStabDataActive;
 
    MathVector<dim> m_Gravity;
 
    static const size_t _C_ = 0;
 
    static const size_t _P_ = 1;
 
    static const size_t _T_ = 2;
 
    SmartPtr<THSingularSourcesAndSinks<dim> > m_sss_mngr;
 
  private:
    DataImport<number, dim> m_imBrineScvf;
    DataImport<MathVector<dim>, dim> m_imBrineGradScvf;
 
    DataImport<MathVector<dim>, dim> m_imPressureGradScvf;
 
    DataImport<MathVector<dim>, dim> m_imTemperatureGradScvf;
 
    DataImport<number, dim> m_imPorosityScv;
    DataImport<number, dim> m_imPorosityScvf;
 
    DataImport<MathVector<dim>, dim> m_imConstGravity;
 
    DataImport<MathMatrix<dim, dim>, dim> m_imPermeabilityScvf;
 
    DataImport<MathMatrix<dim, dim>, dim> m_imMolDiffusionScvf;
 
    DataImport<MathMatrix<dim, dim>, dim> m_imThermalConductivityScvf;
 
    DataImport<number, dim> m_imViscosityScvf;
 
    DataImport<number, dim> m_imDensityScv;
    DataImport<number, dim> m_imDensityScvf;
    DataImport<number, dim> m_imOldDensityScv;
 
    DataImport<MathVector<dim>, dim> m_imDarcyVelScvf;
 
    DataImport<MathMatrix<dim,dim>, dim> m_imDispersionScvf;
 
    number m_imHeatCapacitySolid;
    number m_imHeatCapacityFluid;
 
    number m_imMassDensitySolid;
 
    number m_BoussinesqDensity;
 
  public:
    SmartPtr<CplUserData<MathVector<dim>, dim> > darcy_velocity() {return m_exDarcyVel;}
 
    SmartPtr<CplUserData<number, dim> > brine() {return m_exBrine;}
 
    SmartPtr<CplUserData<MathVector<dim>, dim> > brine_grad() {return m_exBrineGrad;}
 
    SmartPtr<CplUserData<number, dim> > temperature() {return m_exTemperature;}
 
    SmartPtr<CplUserData<MathVector<dim>, dim> > temperature_grad() {return m_exTemperatureGrad;}
 
    SmartPtr<CplUserData<MathVector<dim>, dim> > pressure_grad() {return m_exPressureGrad;}
 
  protected:
    void compute_darcy_velocity_ip_std(MathVector<dim>& DarcyVel,
                                       const MathMatrix<dim, dim>& Permeability,
                                       number Viscosity,
                                       const MathVector<dim>& DensityTimesGravity,
                                       const MathVector<dim>& PressureGrad,
                                       bool compDeriv,
                                       MathVector<dim>* DarcyVel_c,
                                       MathVector<dim>* DarcyVel_p,
                                       MathVector<dim>* DarcyVel_T,
                                       const MathVector<dim>* DensityTimesGravity_c,
                                       const MathVector<dim>* DensityTimesGravity_T,
                                       const number* Viscosity_c,
                                       const MathVector<dim>* PressureGrad_p,
                                       size_t numSh);
 
    template <typename TElem>
    void ex_darcy_std(MathVector<dim> vValue[],
                 const MathVector<dim> vGlobIP[],
                 number time, int si,
                 const LocalVector& u,
                 GridObject* elem,
                 const MathVector<dim> vCornerCoords[],
                 const MathVector<FV1Geometry<TElem,dim>::dim> vLocIP[],
                 const size_t nip,
                 bool bDeriv,
                 std::vector<std::vector<MathVector<dim> > > vvvDeriv[]);
 
    template <typename TElem>
    void ex_darcy_cons_grav(MathVector<dim> vValue[],
                            const MathVector<dim> vGlobIP[],
                            number time, int si,
                            const LocalVector& u,
                            GridObject* elem,
                            const MathVector<dim> vCornerCoords[],
                            const MathVector<FV1Geometry<TElem,dim>::dim> vLocIP[],
                            const size_t nip,
                            bool bDeriv,
                            std::vector<std::vector<MathVector<dim> > > vvvDeriv[]);
 
    template <typename TElem>
    void ex_brine(number vValue[],
                  const MathVector<dim> vGlobIP[],
                  number time, int si,
                  const LocalVector& u,
                  GridObject* elem,
                  const MathVector<dim> vCornerCoords[],
                  const MathVector<FV1Geometry<TElem,dim>::dim> vLocIP[],
                  const size_t nip,
                  bool bDeriv,
                  std::vector<std::vector<number> > vvvDeriv[]);
 
    template <typename TElem>
    void ex_brine_grad(MathVector<dim> vValue[],
                       const MathVector<dim> vGlobIP[],
                       number time, int si,
                       const LocalVector& u,
                       GridObject* elem,
                       const MathVector<dim> vCornerCoords[],
                       const MathVector<FV1Geometry<TElem,dim>::dim> vLocIP[],
                       const size_t nip,
                       bool bDeriv,
                       std::vector<std::vector<MathVector<dim> > > vvvDeriv[]);
 
    template <typename TElem>
    void ex_pressure_grad(MathVector<dim> vValue[],
                          const MathVector<dim> vGlobIP[],
                          number time, int si,
                          const LocalVector& u,
                          GridObject* elem,
                          const MathVector<dim> vCornerCoords[],
                          const MathVector<FV1Geometry<TElem,dim>::dim> vLocIP[],
                          const size_t nip,
                          bool bDeriv,
                          std::vector<std::vector<MathVector<dim> > > vvvDeriv[]);
 
    template <typename TElem>
    void ex_temperature(number vValue[],
                        const MathVector<dim> vGlobIP[],
                        number time, int si,
                        const LocalVector& u,
                        GridObject* elem,
                        const MathVector<dim> vCornerCoords[],
                        const MathVector<FV1Geometry<TElem,dim>::dim> vLocIP[],
                        const size_t nip,
                        bool bDeriv,
                        std::vector<std::vector<number> > vvvDeriv[]);
 
    template <typename TElem>
    void ex_temperature_grad(MathVector<dim> vValue[],
                          const MathVector<dim> vGlobIP[],
                          number time, int si,
                          const LocalVector& u,
                          GridObject* elem,
                          const MathVector<dim> vCornerCoords[],
                          const MathVector<FV1Geometry<TElem,dim>::dim> vLocIP[],
                          const size_t nip,
                          bool bDeriv,
                          std::vector<std::vector<MathVector<dim> > > vvvDeriv[]);
 
    SmartPtr<DataExport<MathVector<dim>, dim> > m_exDarcyVel;
 
    SmartPtr<DataExport<number, dim> > m_exBrine;
 
    SmartPtr<DataExport<MathVector<dim>, dim> > m_exBrineGrad;
 
    SmartPtr<DataExport<MathVector<dim>, dim> > m_exPressureGrad;
 
    SmartPtr<DataExport<number, dim> > m_exTemperature;
 
    SmartPtr<DataExport<MathVector<dim>, dim> > m_exTemperatureGrad;
 
  private:
 
    void register_all_fv1_funcs();
 
    struct RegisterFV1 {
        RegisterFV1(this_type* pThis) : m_pThis(pThis){}
        this_type* m_pThis;
        template< typename TElem > void operator()(TElem&)
        {m_pThis->register_fv1_func<TElem>();}
    };
 
    template <typename TElem>
    void register_fv1_func();
 
#ifdef DF_LIMEX_PATCH
  public:
    void set_partial_velocity(int mask) {m_partialAssMask_Conv = mask;}
  protected:
    // bit 1: do not assemble contribution of derivative
    // bit 2: do not assemble convection
    int m_partialAssMask_Conv;
#endif
 
};
 
 
} // namespace d3f
} // end namespace ug
 
 
#endif /*__H__UG__LIB_DISC__SPATIAL_DISC__ELEM_DISC__THERMOHALINE_FLOW__FV1__THERMOHALINE_FLOW__*/