density_driven_flow_fv1.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__DENSITY_DRIVEN_FLOW_FV1_
#define __H__UG__LIB_DISC__DENSITY_DRIVEN_FLOW__DENSITY_DRIVEN_FLOW_FV1_
 
// 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 "../../river_networks/river_sss.h"
#include "../../extravol.h"
#include "../../d3f_sss.h"
 
#include "../density_driven_flow_base.h"
 
#include "../../d3f_limex.h"
 
 
namespace ug{
namespace d3f{
 
 
 
template<typename TDomain>
class DensityDrivenFlowFV1
  : public DensityDrivenFlowBase<TDomain>
{
  private:
    typedef DensityDrivenFlowBase<TDomain> base_type;
 
    typedef DensityDrivenFlowFV1<TDomain> this_type;
 
  public:
    static const int dim = base_type::dim;
 
  public:
    DensityDrivenFlowFV1(const char* functions, const char* subsets);
    DensityDrivenFlowFV1(const std::vector<std::string>& vFct,
                         const std::vector<std::string>& vSubset);
 
    void set_consistent_gravity(bool bUse);
 
    void set_volume_stabilization(SmartPtr<FlowVolStabData<TDomain> > volStabData);
 
 
    void set_upwind(SmartPtr<IConvectionShapes<dim> > shape);
 
    virtual void set_porosity(SmartPtr<CplUserData<number, dim> > user);
    virtual void set_gravity(SmartPtr<CplUserData<MathVector<dim>, dim> > user);
    virtual void set_molecular_diffusion(SmartPtr<CplUserData<MathMatrix<dim, dim>, dim> > user);
    virtual void set_permeability(SmartPtr<CplUserData<MathMatrix<dim, dim>, dim> > user);
    virtual void set_relative_permeability(SmartPtr<CplUserData<number, dim> >  user);
    virtual void set_saturation(SmartPtr<CplUserData<number, dim> >  user);
    virtual void set_viscosity(SmartPtr<CplUserData<number, dim> > user);
    virtual void set_density(SmartPtr<CplUserData<number,dim> > data);
    virtual void set_dispersion(SmartPtr<CplUserData<MathMatrix<dim,dim>,dim> > data);
    void set_scheidegger_dispersion(const number alphaLong, const number alphaTrans, const number wlimex=1.0);
    void set_scheidegger_dispersion(const number alphaLong, const number alphaTrans)
    { set_scheidegger_dispersion(alphaLong, alphaTrans, 1.0); }
    
 
    void set_beta_p(SmartPtr<CplUserData<number, dim> > user);
    void set_sss_manager(SmartPtr<DDSingularSourcesAndSinks<dim> > sss_mngr) {m_sss_mngr = sss_mngr;}
    void set_river_sss_manager(SmartPtr<RiverSingularSourcesAndSinks<dim> > sss_mngr){m_river_sss_mngr = sss_mngr;}
    SmartPtr<DDSingularSourcesAndSinks<dim> > sss_manager() {return m_sss_mngr;}
    
    void set_condensed_FV(bool condensed) {m_bCondensedFV = condensed;}
    
    bool condensed_FV() {return m_bCondensedFV;}
 
  protected:
    void init();
 
    virtual void prep_assemble_loop();
 
    template <typename TElem, typename TFVGeom>
    void prep_elem_loop(const ReferenceObjectID roid, const int si);
 
    template <typename TElem, typename TFVGeom>
    void prep_elem(const LocalVector& u, GridObject* elem, const ReferenceObjectID roid, const MathVector<dim> vCornerCoords[]);
 
    template <typename TElem, typename TFVGeom>
    void fsh_elem_loop();
 
    template <typename TElem, typename TFVGeom>
    void add_jac_A_elem(LocalMatrix& J, const LocalVector& u, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    template <typename TElem, typename TFVGeom>
    void add_jac_M_elem(LocalMatrix& J, const LocalVector& u, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    template <typename TElem, typename TFVGeom>
    void add_def_A_elem(LocalVector& d, const LocalVector& u, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    template <typename TElem, typename TFVGeom>
    void add_def_M_elem(LocalVector& d, const LocalVector& u, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    template <typename TElem, typename TFVGeom>
    void add_rhs_elem(LocalVector& d, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    virtual bool requests_local_time_series();
    
  private:
    
    template<typename TElem, typename TFVGeom>
    void add_sss_jac_elem
    (
      LocalMatrix& J, 
      const LocalVector& u, 
      GridObject* elem, 
      const TFVGeom& geo, 
      size_t i, 
      number intensity, 
      number concentration
      );
  
    template<typename TElem, typename TFVGeom>
    void add_sss_def_elem
    (
      LocalVector& d, 
      const LocalVector& u, 
      GridObject* elem, 
      const TFVGeom& geo, 
      size_t i, 
      number intensity, 
      number concentration 
      );
 
  template<typename TElem, typename TFVGeom>
    void add_river_sss_jac_elem
    (
      LocalMatrix& J, 
      const LocalVector& u, 
      GridObject* elem, 
      const TFVGeom& geo, 
      size_t i, 
      number intensity, 
      number concentration, 
      number bottom_permeability,
      number len = 1
      );
 
    template<typename TElem, typename TFVGeom>
    void add_river_sss_def_elem
    (
      LocalVector& d, 
      const LocalVector& u, 
      GridObject* elem, 
      const TFVGeom& geo, 
      size_t i, 
      number intensity, 
      number concentration, 
      number bottom_permeability,
      number len = 1
      );
 
 
  
  protected:
    SmartPtr<IConvectionShapes<dim> > m_spUpwind;
 
    bool m_bConsGravity;
    
    SmartPtr<FlowVolStabData<TDomain> > m_spVolStabData;
    bool m_bVolStabDataActive;
 
    MathVector<dim> m_Gravity;
 
    static const size_t _C_ = 0;
 
    static const size_t _P_ = 1;
 
  private:
  
    SmartPtr<DDSingularSourcesAndSinks<dim> > m_sss_mngr;
 
    SmartPtr<RiverSingularSourcesAndSinks<dim> > m_river_sss_mngr;
  
    DataImport<number, dim> m_imBrineScvf;
    DataImport<MathVector<dim>, dim> m_imBrineGradScvf;
 
    DataImport<number, dim> m_imPressureScvf;
    DataImport<MathVector<dim>, dim> m_imPressureGradScvf;
 
    DataImport<number, dim> m_imPorosityScv;
    DataImport<number, dim> m_imPorosityScvf;
 
    // DataImport<number, dim> m_imBetaPScv;
 
    DataImport<MathVector<dim>, dim> m_imConstGravity;
 
    DataImport<MathMatrix<dim, dim>, dim> m_imPermeabilityScvf;
    DataImport<MathMatrix<dim, dim>, dim> m_imPermeabilityScv;
 
    DataImport<number, dim> m_imRelativePermeabilityScv;
    DataImport<number, dim> m_imRelativePermeabilityScvf;
 
    DataImport<number, dim> m_imSaturationScv;
 
    DataImport<MathMatrix<dim, dim>, dim> m_imMolDiffusionScvf;
 
    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;
 
  protected:
    template <typename TElem, typename TFVGeom>
    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<TFVGeom::dim> vLocIP[],
                      const size_t nip,
                      bool bDeriv,
                      std::vector<std::vector<MathVector<dim> > > vvvDeriv[]);
 
    template <typename TElem, typename TFVGeom>
    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<TFVGeom::dim> vLocIP[],
                            const size_t nip,
                            bool bDeriv,
                            std::vector<std::vector<MathVector<dim> > > vvvDeriv[]);
 
    template <typename TElem, typename TFVGeom>
    void ex_brine(number vValue[],
                  const MathVector<dim> vGlobIP[],
                  number time, int si,
                  const LocalVector& u,
                  GridObject* elem,
                  const MathVector<dim> vCornerCoords[],
                  const MathVector<TFVGeom::dim> vLocIP[],
                  const size_t nip,
                  bool bDeriv,
                  std::vector<std::vector<number> > vvvDeriv[]);
 
    template <typename TElem, typename TFVGeom>
    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<TFVGeom::dim> vLocIP[],
                       const size_t nip,
                       bool bDeriv,
                       std::vector<std::vector<MathVector<dim> > > vvvDeriv[]);
 
    template <typename TElem, typename TFVGeom>
    void ex_pressure(number vValue[],
             const MathVector<dim> vGlobIP[],
             number time, int si,
             const LocalVector& u,
             GridObject* elem,
             const MathVector<dim> vCornerCoords[],
             const MathVector<TFVGeom::dim> vLocIP[],
             const size_t nip,
             bool bDeriv,
             std::vector<std::vector<number> > vvvDeriv[]);
 
    template <typename TElem, typename TFVGeom>
    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<TFVGeom::dim> vLocIP[],
                const size_t nip,
                bool bDeriv,
                std::vector<std::vector<MathVector<dim> > > vvvDeriv[]);
 
    template <typename TElem, typename TFVGeom>
    void ex_brine_tensor(MathMatrix<dim,dim> vValue[],
                           const MathVector<dim> vGlobIP[],
                           number time, int si,
                           const LocalVector& u,
                           GridObject* elem,
                           const MathVector<dim> vCornerCoords[],
                           const MathVector<TFVGeom::dim> vLocIP[],
                           const size_t nip,
                           bool bDeriv,
                           std::vector<std::vector<MathMatrix<dim,dim> > > vvvDeriv[]);
    template <typename TElem, typename TFVGeom>
    void ex_pressure_tensor(MathMatrix<dim,dim> vValue[],
                               const MathVector<dim> vGlobIP[],
                               number time, int si,
                               const LocalVector& u,
                               GridObject* elem,
                               const MathVector<dim> vCornerCoords[],
                               const MathVector<TFVGeom::dim> vLocIP[],
                               const size_t nip,
                               bool bDeriv,
                               std::vector<std::vector<MathMatrix<dim,dim> > > vvvDeriv[]);
 
 
    using base_type::m_exBrine;
    using base_type::m_exBrineGrad;
    using base_type::m_exBrineTensor;
    using base_type::m_exPressureTensor;
    using base_type::m_exDarcyVel;
    using base_type::m_exPressure;
    using base_type::m_exPressureGrad;
    using base_type::m_BoussinesqFlow;
    using base_type::m_BoussinesqTransport;
    using base_type::compute_ip_darcy_velocity_std;
 
  public:
    virtual void prepare_setting(const std::vector<LFEID>& vLfeID, bool bNonRegularGrid);
 
    virtual bool use_hanging() const;
 
  protected:
    bool m_bNonRegularGrid;
  
    bool m_bCondensedFV;
 
  private:
    void register_all_funcs(bool bHang);
    template <typename TElem> void register_func_for_(bool bHang);
    template <typename TElem, typename TFVGeom> void register_func();
    struct RegisterLocalDiscr
    {
      this_type * m_pThis; bool m_bHang;
      RegisterLocalDiscr(this_type * pThis, bool bHang) : m_pThis(pThis), m_bHang(bHang) {}
      template< typename TElem > void operator() (TElem &)
      {m_pThis->register_func_for_<TElem> (m_bHang);}
    };
#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__DENSITY_DRIVEN_FLOW__DENSITY_DRIVEN_FLOW_FV1_*/