density_driven_flow_fv.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_FV_
#define __H__UG__LIB_DISC__DENSITY_DRIVEN_FLOW__DENSITY_DRIVEN_FLOW_FV_
 
// 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 "../density_driven_flow_base.h"
 
namespace ug{
namespace d3f{
 
 
 
template<typename TDomain>
class DensityDrivenFlowFV
  : public DensityDrivenFlowBase<TDomain>
{
  private:
    typedef DensityDrivenFlowBase<TDomain> base_type;
 
    typedef DensityDrivenFlowFV<TDomain> this_type;
 
  public:
    static const int dim = base_type::dim;
 
  public:
    DensityDrivenFlowFV(const char* functions, const char* subsets);
 
    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_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);
 
  protected:
    template<typename TElem, typename CGeom, typename PGeom>
    void prep_elem_loop(const ReferenceObjectID roid, const int si);
 
    template<typename TElem, typename CGeom, typename PGeom>
    void prep_elem(const LocalVector& u, GridObject* elem, const ReferenceObjectID roid, const MathVector<dim> vCornerCoords[]);
 
    template<typename TElem, typename CGeom, typename PGeom>
    void fsh_elem_loop();
 
    template<typename TElem, typename CGeom, typename PGeom>
    void add_jac_A_elem(LocalMatrix& J, const LocalVector& u, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    template<typename TElem, typename CGeom, typename PGeom>
    void add_jac_M_elem(LocalMatrix& J, const LocalVector& u, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    template<typename TElem, typename CGeom, typename PGeom>
    void add_def_A_elem(LocalVector& d, const LocalVector& u, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    template<typename TElem, typename CGeom, typename PGeom>
    void add_def_M_elem(LocalVector& d, const LocalVector& u, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    template<typename TElem, typename CGeom, typename PGeom>
    void add_rhs_elem(LocalVector& d, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
  protected:
    MathVector<dim> m_Gravity;
 
    static const size_t _C_ = 0;
 
    static const size_t _P_ = 1;
 
  private:
    DataImport<number, dim> m_imBrine_cscvf;
    DataImport<MathVector<dim>, dim> m_imBrineGrad_cscvf;
 
    DataImport<MathVector<dim>, dim> m_imPressureGrad_cscvf;
    DataImport<MathVector<dim>, dim> m_imPressureGrad_pscvf;
 
    DataImport<number, dim> m_imPorosity_cscv;
    DataImport<number, dim> m_imPorosity_pscv;
    DataImport<number, dim> m_imPorosity_cscvf;
    DataImport<number, dim> m_imPorosity_pscvf;
 
    DataImport<MathVector<dim>, dim> m_imConstGravity;
 
    DataImport<MathMatrix<dim, dim>, dim> m_imPermeability_cscvf;
    DataImport<MathMatrix<dim, dim>, dim> m_imPermeability_pscvf;
 
    DataImport<MathMatrix<dim, dim>, dim> m_imMolDiffusion_cscvf;
    DataImport<MathMatrix<dim, dim>, dim> m_imMolDiffusion_pscvf;
 
    DataImport<number, dim> m_imViscosity_cscvf;
    DataImport<number, dim> m_imViscosity_pscvf;
 
    DataImport<number, dim> m_imDensity_cscv;
    DataImport<number, dim> m_imDensity_pscv;
    DataImport<number, dim> m_imDensity_cscvf;
    DataImport<number, dim> m_imDensity_pscvf;
 
    DataImport<MathVector<dim>, dim> m_imDarcyVel_cscvf;
    DataImport<MathVector<dim>, dim> m_imDarcyVel_pscvf;
 
  protected:
    template<typename TElem, typename CGeom, typename PGeom>
    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<CGeom::dim> vLocIP[],
                      const size_t nip,
                      bool bDeriv,
                      std::vector<std::vector<MathVector<dim> > > vvvDeriv[]);
 
    template<typename TElem, typename CGeom, typename PGeom>
    void ex_brine(number vValue[],
                  const MathVector<dim> vGlobIP[],
                  number time, int si,
                  const LocalVector& u,
                  GridObject* elem,
                  const MathVector<dim> vCornerCoords[],
                  const MathVector<CGeom::dim> vLocIP[],
                  const size_t nip,
                  bool bDeriv,
                  std::vector<std::vector<number> > vvvDeriv[]);
 
    template<typename TElem, typename CGeom, typename PGeom>
    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<CGeom::dim> vLocIP[],
                       const size_t nip,
                       bool bDeriv,
                       std::vector<std::vector<MathVector<dim> > > vvvDeriv[]);
 
    template<typename TElem, typename CGeom, typename PGeom>
    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<CGeom::dim> vLocIP[],
                const size_t nip,
                bool bDeriv,
                std::vector<std::vector<MathVector<dim> > > vvvDeriv[]);
 
    using base_type::m_exBrine;
    using base_type::m_exBrineGrad;
    using base_type::m_exDarcyVel;
    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:
    LFEID m_c_lfeID;
    LFEID m_p_lfeID;
 
  protected:
    void register_all_funcs(const LFEID& vLfeID, const LFEID& pLfeID);
    template<typename TElem, typename CGeom, typename PGeom> void register_func();
};
 
 
} // namespace d3f
} // end namespace ug
 
#endif /*__H__UG__LIB_DISC__DENSITY_DRIVEN_FLOW__DENSITY_DRIVEN_FLOW_FV_*/