Finite Volume Element Discretization for Density Driven Flow. More...

#include <density_driven_flow_fv1.h>

Inheritance diagram for ug::d3f::DensityDrivenFlowFV1< TDomain >:

Classes
struct	RegisterLocalDiscr

Public Member Functions
bool	condensed_FV ()
	returns the 'condensed scvf ip' flag

	DensityDrivenFlowFV1 (const char functions, const char subsets)
	Constructor.

	DensityDrivenFlowFV1 (const std::vector< std::string > &vFct, const std::vector< std::string > &vSubset)

virtual void	prepare_setting (const std::vector< LFEID > &vLfeID, bool bNonRegularGrid)
	type of trial space for each function used

void	set_beta_p (SmartPtr< CplUserData< number, dim > > user)

void	set_condensed_FV (bool condensed)
	activates/deactivates the condensed scvf ip's for the FV scheme

void	set_consistent_gravity (bool bUse)
	sets usage of consistent gravity

void	set_partial_velocity (int mask)

void	set_river_sss_manager (SmartPtr< RiverSingularSourcesAndSinks< dim > > sss_mngr)

void	set_sss_manager (SmartPtr< DDSingularSourcesAndSinks< dim > > sss_mngr)
	set singular sources and sinks

void	set_upwind (SmartPtr< IConvectionShapes< dim > > shape)
	sets the type of upwind

void	set_volume_stabilization (SmartPtr< FlowVolStabData< TDomain > > volStabData)
	sets usage of volume stabilization

SmartPtr< DDSingularSourcesAndSinks< dim > >	sss_manager ()
	get singular sources and sinks

virtual bool	use_hanging () const
	returns if hanging nodes are needed


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)

Public Member Functions inherited from ug::d3f::DensityDrivenFlowBase< TDomain >
SmartPtr< CplUserData< number, dim > >	brine ()
	returns the export of brine mass fracture

SmartPtr< CplUserData< MathVector< dim >, dim > >	brine_grad ()
	returns the export of brine mass fracture

SmartPtr< CplUserData< MathMatrix< dim, dim >, dim > >	brine_tensor ()
	returns the export of brine tensor

SmartPtr< CplUserData< MathVector< dim >, dim > >	darcy_velocity ()
	returns the export of the darcy velocity

	DensityDrivenFlowBase (const char functions, const char subsets)
	Constructor.

	DensityDrivenFlowBase (const std::vector< std::string > &vFct, const std::vector< std::string > &vSubset)

SmartPtr< CplUserData< number, dim > >	pressure ()
	returns the export of pressure

SmartPtr< CplUserData< MathVector< dim >, dim > >	pressure_grad ()
	returns the export of brine mass fracture

SmartPtr< CplUserData< MathMatrix< dim, dim >, dim > >	pressure_tensor ()
	returns the export of brine tensor

void	set_boussinesq_flow (bool bUse)
	sets usage of boussinesq approximation for flow equation

void	set_boussinesq_transport (bool bUse)
	sets usage of boussinesq approximation for transport equation

void	set_porosity (number val)
	sets the porosity

void	set_gravity (const std::vector< number > &vVel)
	sets the gravity vector

void	set_molecular_diffusion (number val)
	sets the molecular diffusion tensor

void	set_permeability (number val)
	sets the permeability tensor

void	set_viscosity (number val)
	sets the viscosity tensor

void	set_density (number val)
	sets the density

Public Member Functions inherited from ug::IElemDisc< TDomain >
void	add_elem_modifier (SmartPtr< IElemDiscModifier< TDomain > > elemModifier)

std::vector< SmartPtr< IElemDiscModifier< TDomain > > > &	get_elem_modifier ()

	IElemDisc (const char functions, const char subsets)

	IElemDisc (const std::vector< std::string > &vFct, const std::vector< std::string > &vSubset)

Public Member Functions inherited from ug::IElemAssembleFuncs< IElemDisc< TDomain >, TDomain >
virtual void	add_def_A_expl_elem (LocalVector &d, const LocalVector &u, GridObject *elem, const MathVector< dim > vCornerCoords[])

TLeaf &	asLeaf ()

void	check_roid (ReferenceObjectID roid, int discType)

void	do_add_def_A_elem (LocalVector &d, LocalVector &u, GridObject *elem, const MathVector< dim > vCornerCoords[])

void	do_add_def_A_expl_elem (LocalVector &d, LocalVector &u, GridObject *elem, const MathVector< dim > vCornerCoords[])

void	do_add_def_M_elem (LocalVector &d, LocalVector &u, GridObject *elem, const MathVector< dim > vCornerCoords[])

void	do_add_jac_A_elem (LocalMatrix &J, LocalVector &u, GridObject *elem, const MathVector< dim > vCornerCoords[])

void	do_add_jac_M_elem (LocalMatrix &J, LocalVector &u, GridObject *elem, const MathVector< dim > vCornerCoords[])

void	do_add_rhs_elem (LocalVector &rhs, GridObject *elem, const MathVector< dim > vCornerCoords[])

void	do_fsh_elem_loop ()

void	do_fsh_timestep (const number time, VectorProxyBase *u, size_t algebra_id)

void	do_fsh_timestep_elem (const number time, LocalVector &u, GridObject *elem, const MathVector< dim > vCornerCoords[])

void	do_prep_elem (LocalVector &u, GridObject *elem, const ReferenceObjectID roid, const MathVector< dim > vCornerCoords[])

void	do_prep_elem_loop (const ReferenceObjectID roid, const int si)

void	do_prep_timestep (number future_time, const number time, VectorProxyBase *u, size_t algebra_id)

void	do_prep_timestep_elem (const number time, LocalVector &u, GridObject *elem, const MathVector< dim > vCornerCoords[])

virtual void	fsh_timestep (number time, VectorProxyBase *u)

virtual void	fsh_timestep_elem (const number time, const LocalVector &u, GridObject *elem, const MathVector< dim > vCornerCoords[])

	IElemAssembleFuncs ()

virtual void	post_assemble_loop ()

virtual void	prep_timestep (number future_time, number time, VectorProxyBase *u)

virtual void	prep_timestep_elem (const number time, const LocalVector &u, GridObject *elem, const MathVector< dim > vCornerCoords[])

void	set_roid (ReferenceObjectID id, int discType)

virtual	~IElemAssembleFuncs ()

Public Member Functions inherited from ug::IElemError< typename TDomain >
	IElemError (const char functions, const char subsets)

	IElemError (const std::vector< std::string > &vFct, const std::vector< std::string > &vSubset)

Public Member Functions inherited from ug::IElemDiscBase< typename TDomain >
SmartPtr< ApproximationSpace< TDomain > >	approx_space ()

ConstSmartPtr< ApproximationSpace< TDomain > >	approx_space () const

void	check_setup (bool bNonRegularGrid)

void	clear_imports ()

SmartPtr< TDomain >	domain ()

ConstSmartPtr< TDomain >	domain () const

const FunctionGroup &	function_group () const

ConstSmartPtr< FunctionPattern >	function_pattern () const

IDataImport< dim > &	get_import (size_t i)

	IElemDiscBase (const char functions="", const char subsets="")

	IElemDiscBase (const std::vector< std::string > &vFct, const std::vector< std::string > &vSubset)

bool	is_time_dependent () const

bool	local_time_series_needed ()

const LocalVectorTimeSeries *	local_time_solutions () const

const FunctionIndexMapping &	map () const

number	mass_scale () const

number	mass_scale () const

number	mass_scale (const size_t timePoint) const

number	mass_scale (const size_t timePoint) const

const std::vector< number > &	mass_scales () const

const std::vector< number > &	mass_scales () const

size_t	num_fct () const

size_t	num_imports () const

size_t	num_subsets () const

void	register_import (IDataImport< dim > &Imp)

void	set_approximation_space (SmartPtr< ApproximationSpace< TDomain > > approxSpace)

void	set_functions (const std::string &functions)

void	set_functions (const std::vector< std::string > &functions)

void	set_stationary ()

void	set_stationary (bool bStationaryForced=true)

void	set_subsets (const std::string &subsets)

void	set_subsets (const std::vector< std::string > &subsets)

void	set_time_dependent (LocalVectorTimeSeries &locTimeSeries, const std::vector< number > &vScaleMass, const std::vector< number > &vScaleStiff)

void	set_time_independent ()

void	set_time_point (const size_t timePoint)

number	stiff_scale () const

number	stiff_scale () const

number	stiff_scale (const size_t timePoint) const

number	stiff_scale (const size_t timePoint) const

const std::vector< number > &	stiff_scales () const

const std::vector< number > &	stiff_scales () const

TDomain::subset_handler_type &	subset_handler ()

const TDomain::subset_handler_type &	subset_handler () const

const std::vector< std::string > &	symb_fcts () const

const std::vector< std::string > &	symb_subsets () const

number	time () const

size_t	time_point () const

virtual int	type () const

virtual	~IElemDiscBase ()

Public Member Functions inherited from ug::IElemEstimatorFuncs< IElemDisc< TDomain >, TDomain >
TLeaf &	asLeaf ()

void	check_roid (ReferenceObjectID roid, int discType)

virtual void	compute_err_est_A_elem (const LocalVector &u, GridObject *elem, const MathVector< dim > vCornerCoords[], const number &scale)

virtual void	compute_err_est_M_elem (const LocalVector &u, GridObject *elem, const MathVector< dim > vCornerCoords[], const number &scale)

virtual void	compute_err_est_rhs_elem (GridObject *elem, const MathVector< dim > vCornerCoords[], const number &scale)

void	do_compute_err_est_A_elem (LocalVector &u, GridObject *elem, const MathVector< dim > vCornerCoords[], const number &scale)

void	do_compute_err_est_M_elem (LocalVector &u, GridObject *elem, const MathVector< dim > vCornerCoords[], const number &scale)

void	do_compute_err_est_rhs_elem (GridObject *elem, const MathVector< dim > vCornerCoords[], const number &scale)

void	do_fsh_err_est_elem_loop ()

void	do_prep_err_est_elem (LocalVector &u, GridObject *elem, const MathVector< dim > vCornerCoords[])

void	do_prep_err_est_elem_loop (const ReferenceObjectID roid, const int si)

virtual SmartPtr< IErrEstData< TDomain > >	err_est_data ()

bool	err_est_enabled () const

virtual void	fsh_err_est_elem_loop ()

	IElemEstimatorFuncs ()

virtual void	prep_err_est_elem (const LocalVector &u, GridObject *elem, const MathVector< dim > vCornerCoords[])

virtual void	prep_err_est_elem_loop (const ReferenceObjectID roid, const int si)

void	set_error_estimator (SmartPtr< IErrEstData< TDomain > > ee)

void	set_roid (ReferenceObjectID id, int discType)

virtual	~IElemEstimatorFuncs ()

Static Public Attributes
static const int	dim = base_type::dim
	World dimension.

Static Public Attributes inherited from ug::d3f::DensityDrivenFlowBase< TDomain >
static const int	dim = base_type::dim
	World dimension.

Static Public Attributes inherited from ug::IElemDisc< TDomain >
static const int	dim

Static Public Attributes inherited from ug::IElemAssembleFuncs< IElemDisc< TDomain >, TDomain >
static const int	dim

Static Public Attributes inherited from ug::IElemError< typename TDomain >
static const int	dim

Static Public Attributes inherited from ug::IElemDiscBase< typename TDomain >
static const int	dim

Static Public Attributes inherited from ug::IElemEstimatorFuncs< IElemDisc< TDomain >, TDomain >
static const int	dim

Protected Member Functions
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_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_rhs_elem (LocalVector &d, GridObject *elem, const MathVector< dim > vCornerCoords[])

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)
	compute darcy velocity at one ip

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[])
	computes the value of the brine mass fraction

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[])
	computes the value of the gradient of the brine mass fraction

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[])
	computes the value of the gradient of the brine mass fraction

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[])
	computes the darcy velocity using consistent gravity

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[])
	computes the darcy velocity using consistent gravity

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[])
	computes the value of the brine mass fraction

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[])
	computes the value of the gradient of the pressure

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[])
	computes the value of the gradient of the brine mass fraction

template<typename TElem , typename TFVGeom >
void	fsh_elem_loop ()

void	init ()

virtual void	prep_assemble_loop ()

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	prep_elem_loop (const ReferenceObjectID roid, const int si)

virtual bool	requests_local_time_series ()
	returns if local time series is needed

Protected Member Functions inherited from ug::d3f::DensityDrivenFlowBase< TDomain >
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)
	compute darcy velocity at one ip

void	init (const char *functions)
	standard initialization

Protected Member Functions inherited from ug::IElemDisc< TDomain >
void	clear_add_fct ()

void	clear_add_fct (ReferenceObjectID id)

void	set_default_add_fct ()

Protected Member Functions inherited from ug::IElemAssembleFuncs< IElemDisc< TDomain >, TDomain >
void	clear_add_fct ()

void	clear_add_fct (ReferenceObjectID id)

void	remove_add_def_A_elem_fct (ReferenceObjectID id)

void	remove_add_def_A_expl_elem_fct (ReferenceObjectID id)

void	remove_add_def_M_elem_fct (ReferenceObjectID id)

void	remove_add_jac_A_elem_fct (ReferenceObjectID id)

void	remove_add_jac_M_elem_fct (ReferenceObjectID id)

void	remove_add_rhs_elem_fct (ReferenceObjectID id)

void	remove_fsh_elem_loop_fct (ReferenceObjectID id)

void	remove_fsh_timestep_elem_fct (ReferenceObjectID id)

void	remove_fsh_timestep_fct (size_t algebra_id)

void	remove_prep_elem_fct (ReferenceObjectID id)

void	remove_prep_elem_loop_fct (ReferenceObjectID id)

void	remove_prep_timestep_elem_fct (ReferenceObjectID id)

void	remove_prep_timestep_fct (size_t algebra_id)

void	set_add_def_A_elem_fct (ReferenceObjectID id, TAssFunc func)

void	set_add_def_A_expl_elem_fct (ReferenceObjectID id, TAssFunc func)

void	set_add_def_M_elem_fct (ReferenceObjectID id, TAssFunc func)

void	set_add_jac_A_elem_fct (ReferenceObjectID id, TAssFunc func)

void	set_add_jac_M_elem_fct (ReferenceObjectID id, TAssFunc func)

void	set_add_rhs_elem_fct (ReferenceObjectID id, TAssFunc func)

void	set_default_add_fct ()

void	set_fsh_elem_loop_fct (ReferenceObjectID id, TAssFunc func)

void	set_fsh_timestep_elem_fct (ReferenceObjectID id, TAssFunc func)

void	set_fsh_timestep_fct (size_t algebra_id, TAssFunc func)

void	set_prep_elem_fct (ReferenceObjectID id, TAssFunc func)

void	set_prep_elem_loop_fct (ReferenceObjectID id, TAssFunc func)

void	set_prep_timestep_elem_fct (ReferenceObjectID id, TAssFunc func)

void	set_prep_timestep_fct (size_t algebra_id, TAssFunc func)

Protected Member Functions inherited from ug::IElemError< typename TDomain >
void	clear_add_fct ()

void	clear_add_fct (ReferenceObjectID id)

Protected Member Functions inherited from ug::IElemDiscBase< typename TDomain >
virtual void	approximation_space_changed ()

void	set_function_pattern (ConstSmartPtr< FunctionPattern > fctPatt)

void	update_function_index_mapping ()

Protected Member Functions inherited from ug::IElemEstimatorFuncs< IElemDisc< TDomain >, TDomain >
void	clear_add_fct ()

void	clear_add_fct (ReferenceObjectID id)

void	remove_compute_err_est_A_elem (ReferenceObjectID id)

void	remove_compute_err_est_M_elem (ReferenceObjectID id)

void	remove_compute_err_est_rhs_elem (ReferenceObjectID id)

void	remove_fsh_err_est_elem_loop (ReferenceObjectID id)

void	remove_prep_err_est_elem (ReferenceObjectID id)

void	remove_prep_err_est_elem_loop (ReferenceObjectID id)

void	set_compute_err_est_A_elem (ReferenceObjectID id, TAssFunc func)

void	set_compute_err_est_M_elem (ReferenceObjectID id, TAssFunc func)

void	set_compute_err_est_rhs_elem (ReferenceObjectID id, TAssFunc func)

void	set_default_add_fct ()

void	set_fsh_err_est_elem_loop (ReferenceObjectID id, TAssFunc func)

void	set_prep_err_est_elem (ReferenceObjectID id, TAssFunc func)

void	set_prep_err_est_elem_loop (ReferenceObjectID id, TAssFunc func)

Protected Attributes
bool	m_bCondensedFV
	if to use the 'condensed' FV scvf ip's

bool	m_bConsGravity
	flag if using consistent gravity

bool	m_bNonRegularGrid
	current regular grid flag

bool	m_BoussinesqFlow
	flag if using boussinesq flow

bool	m_BoussinesqTransport
	flag if using boussinesq transport

bool	m_bVolStabDataActive
	whether the volume stabilization is active (i.e. m_spVolStabData is not SPNULL and active)

SmartPtr< DataExport< number, dim > >	m_exBrine
	Export for the brine mass fraction.

SmartPtr< DataExport< MathVector< dim >, dim > >	m_exBrineGrad
	Export for the gradient of brine mass fraction.

SmartPtr< DataExport< MathMatrix< dim, dim >, dim > >	m_exBrineTensor
	Export for the brine related tensor.

SmartPtr< DataExport< MathVector< dim >, dim > >	m_exDarcyVel
	Export for the Darcy velocity.

SmartPtr< DataExport< number, dim > >	m_exPressure
	Export for the brine mass fraction.

SmartPtr< DataExport< MathVector< dim >, dim > >	m_exPressureGrad
	Export for the gradient of brine mass fraction.

SmartPtr< DataExport< MathMatrix< dim, dim >, dim > >	m_exPressureTensor
	Export for the pressure related tensor.

MathVector< dim >	m_Gravity
	constant Gravity, read in once

int	m_partialAssMask_Conv

SmartPtr< IConvectionShapes< dim > >	m_spUpwind
	strategy to compute the upwind shapes

SmartPtr< FlowVolStabData< TDomain > >	m_spVolStabData
	the volume stabilization

Protected Attributes inherited from ug::d3f::DensityDrivenFlowBase< TDomain >
bool	m_BoussinesqFlow
	flag if using boussinesq flow

bool	m_BoussinesqTransport
	flag if using boussinesq transport

SmartPtr< DataExport< number, dim > >	m_exBrine
	Export for the brine mass fraction.

SmartPtr< DataExport< MathVector< dim >, dim > >	m_exBrineGrad
	Export for the gradient of brine mass fraction.

SmartPtr< DataExport< MathMatrix< dim, dim >, dim > >	m_exBrineTensor
	Export for the brine related tensor.

SmartPtr< DataExport< MathVector< dim >, dim > >	m_exDarcyVel
	Export for the Darcy velocity.

SmartPtr< DataExport< number, dim > >	m_exPressure
	Export for the brine mass fraction.

SmartPtr< DataExport< MathVector< dim >, dim > >	m_exPressureGrad
	Export for the gradient of brine mass fraction.

SmartPtr< DataExport< MathMatrix< dim, dim >, dim > >	m_exPressureTensor
	Export for the pressure related tensor.

MathVector< dim >	m_Gravity
	constant Gravity, read in once

Protected Attributes inherited from ug::IElemDisc< TDomain >
std::vector< SmartPtr< IElemDiscModifier< TDomain > > >	m_spElemModifier

Protected Attributes inherited from ug::IElemAssembleFuncs< IElemDisc< TDomain >, TDomain >
ReferenceObjectID	m_roid

Protected Attributes inherited from ug::IElemDiscBase< typename TDomain >
bool	m_bStationaryForced

FunctionGroup	m_fctGrp

FunctionIndexMapping	m_fctIndexMap

LocalVectorTimeSeries *	m_pLocalVectorTimeSeries

SmartPtr< ApproximationSpace< TDomain > >	m_spApproxSpace

ConstSmartPtr< FunctionPattern >	m_spFctPattern

size_t	m_timePoint

std::vector< std::string >	m_vFct

std::vector< IDataImport< dim > * >	m_vIImport

std::vector< number >	m_vScaleMass

std::vector< number >	m_vScaleStiff

std::vector< std::string >	m_vSubset

Protected Attributes inherited from ug::IElemEstimatorFuncs< IElemDisc< TDomain >, TDomain >
ReferenceObjectID	m_roid

SmartPtr< IErrEstData< TDomain > >	m_spErrEstData

Static Protected Attributes
static const size_t	_C_ = 0
	abbreviation for local function: brine mass fraction

static const size_t	_P_ = 1
	abbreviation for local function: pressure

Private Types
typedef DensityDrivenFlowBase< TDomain >	base_type
	Base class type.

typedef DensityDrivenFlowFV1< TDomain >	this_type
	own type

Private Member Functions
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)
	adds contributions of a singular source or sink to the defect

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_sss_def_elem (LocalVector &d, const LocalVector &u, GridObject *elem, const TFVGeom &geo, size_t i, number intensity, number concentration)
	adds contributions of a singular source or sink to the defect

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)
	adds contributions of a singular source or sink to the matrix


void	register_all_funcs (bool bHang)

template<typename TElem >
void	register_func_for_ (bool bHang)

template<typename TElem , typename TFVGeom >
void	register_func ()

Private Attributes
DataImport< MathVector< dim >, dim >	m_imBrineGradScvf

DataImport< number, dim >	m_imBrineScvf
	Data import for brine mass fraction at scvf ips.

DataImport< MathVector< dim >, dim >	m_imConstGravity
	Data import for gravity (must be constant in current implementation)

DataImport< MathVector< dim >, dim >	m_imDarcyVelScvf
	Data import for Darcy Velocity.

DataImport< number, dim >	m_imDensityScv
	Data import for density.

DataImport< number, dim >	m_imDensityScvf

DataImport< MathMatrix< dim, dim >, dim >	m_imDispersionScvf
	Data import for Dispersion.

DataImport< MathMatrix< dim, dim >, dim >	m_imMolDiffusionScvf
	Data import for molecular diffusion tensor.

DataImport< number, dim >	m_imOldDensityScv

DataImport< MathMatrix< dim, dim >, dim >	m_imPermeabilityScv

DataImport< MathMatrix< dim, dim >, dim >	m_imPermeabilityScvf
	Data import for permeability tensor.

DataImport< number, dim >	m_imPorosityScv
	Data import for the porosity term.

DataImport< number, dim >	m_imPorosityScvf

DataImport< MathVector< dim >, dim >	m_imPressureGradScvf

DataImport< number, dim >	m_imPressureScvf
	Data import for pressure at scvf ips.

DataImport< number, dim >	m_imRelativePermeabilityScv
	Data import for permeability scale.

DataImport< number, dim >	m_imRelativePermeabilityScvf

DataImport< number, dim >	m_imSaturationScv
	Data import for saturation.

DataImport< number, dim >	m_imViscosityScvf
	Data import for viscosity.

SmartPtr< RiverSingularSourcesAndSinks< dim > >	m_river_sss_mngr
	river singular sources and sinks manager

SmartPtr< DDSingularSourcesAndSinks< dim > >	m_sss_mngr
	singular sources and sinks manager

Additional Inherited Members
Public Types inherited from ug::IElemDisc< TDomain >
typedef IElemAssembleFuncs< IElemDisc< TDomain >, TDomain >	assemble_base_type

typedef IElemError< TDomain >	base_type

typedef TDomain	domain_type

typedef IElemEstimatorFuncs< IElemDisc< TDomain >, TDomain >	estimator_base_type

Public Types inherited from ug::IElemAssembleFuncs< IElemDisc< TDomain >, TDomain >
typedef TDomain	domain_type

typedef TLeaf	leaf_type

Public Types inherited from ug::IElemError< typename TDomain >
typedef TDomain	domain_type

typedef IElemEstimatorFuncs< IElemDisc< TDomain >, TDomain >	estimator_base_type

Public Types inherited from ug::IElemDiscBase< typename TDomain >
typedef TDomain	domain_type

typedef TDomain::position_type	position_type

Public Types inherited from ug::IElemEstimatorFuncs< IElemDisc< TDomain >, TDomain >
typedef TDomain	domain_type

typedef TLeaf	leaf_type

Detailed Description

template<typename TDomain>
class ug::d3f::DensityDrivenFlowFV1< TDomain >

Finite Volume Element Discretization for Density Driven Flow.

This class implements the IElemDisc interface for the density driven flow equations. It is a system of two coupled equations of the form.

\begin{align*} \partial_t (\phi \rho) + \nabla(\rho \vec{q}) &= 0\\ \partial_t (\phi \rho c) - \nabla(\rho D \nabla c -\rho c \vec{q}) &= 0\\ \vec{q} &:= - \frac{K}{\mu}(\nabla p - \rho \vec{g}) \end{align*}

with

\( c \) unknown brine mass fraction
\( p \) unknown pressure

and given data

\( \phi(\vec{x}, t) \) Porosity
\( K(\vec{x}, t) \) Permeability tensor
\( \vec{g} \) constant Gravity field
\( D(\vec{q}, \vec{x}, t) := \phi(\vec{x}, t) D_d(\vec{x}, t) + D_m(\vec{q}) \) Diffusion-Dispersion tensor
\( D_m(\vec{q}) \) mechanical Dispersion tensor
\( D_d(\vec{x}, t) \) molecular Diffusion tensor (prop. to Tortuosity)
\( \mu(c) \) Viscosity
\( \rho(c)\) Density

as well as the abbreviation

\( \vec{q} \) Darcy velocity

The first equation is usually referred to as the flow equation. The second equation is known as the transport equation.

Template Parameters

TFVGeom	Finite Volume Geometry
TDomain	Domain
TAlgebra	Algebra

Member Typedef Documentation

◆ base_type

template<typename TDomain >

typedef DensityDrivenFlowBase<TDomain> ug::d3f::DensityDrivenFlowFV1< TDomain >::base_type

private

Base class type.

◆ this_type

template<typename TDomain >

typedef DensityDrivenFlowFV1<TDomain> ug::d3f::DensityDrivenFlowFV1< TDomain >::this_type

private

own type

Constructor & Destructor Documentation

◆ DensityDrivenFlowFV1() [1/2]

template<typename TDomain >

ug::d3f::DensityDrivenFlowFV1< TDomain >::DensityDrivenFlowFV1	(	const char *	functions,
		const char *	subsets
	)

Constructor.

References ug::d3f::DensityDrivenFlowFV1< TDomain >::init().

◆ DensityDrivenFlowFV1() [2/2]

template<typename TDomain >

ug::d3f::DensityDrivenFlowFV1< TDomain >::DensityDrivenFlowFV1	(	const std::vector< std::string > &	vFct,
		const std::vector< std::string > &	vSubset
	)

References ug::d3f::DensityDrivenFlowFV1< TDomain >::init().

Member Function Documentation

◆ add_def_A_elem()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::add_def_A_elem	(	LocalVector &	d,
		const LocalVector &	u,
		GridObject *	elem,
		const MathVector< dim >	vCornerCoords[]
	)

protectedvirtual

Reimplemented from ug::IElemAssembleFuncs< IElemDisc< TDomain >, TDomain >.

References ug::GeomProvider< typename TGeom >::get(), grid(), ug::MatAdd(), ug::MatScale(), ug::MatVecMult(), p, ug::FVPointSourceOrSink< int dim, typename TData >::position(), s, UG_THROW, ug::VecDistance(), and ug::VecDot().

◆ add_def_M_elem()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::add_def_M_elem	(	LocalVector &	d,
		const LocalVector &	u,
		GridObject *	elem,
		const MathVector< dim >	vCornerCoords[]
	)

protectedvirtual

Reimplemented from ug::IElemAssembleFuncs< IElemDisc< TDomain >, TDomain >.

References ug::GeomProvider< typename TGeom >::get().

◆ add_jac_A_elem()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::add_jac_A_elem	(	LocalMatrix &	J,
		const LocalVector &	u,
		GridObject *	elem,
		const MathVector< dim >	vCornerCoords[]
	)

protectedvirtual

Reimplemented from ug::IElemAssembleFuncs< IElemDisc< TDomain >, TDomain >.

References ug::IConvectionShapes< int dim >::D_diffusion(), ug::IConvectionShapes< int dim >::D_vel(), ug::GeomProvider< typename TGeom >::get(), grid(), ug::MatAdd(), ug::MatContraction(), ug::MatScale(), ug::MatVecMult(), ug::IConvectionShapes< int dim >::non_zero_deriv_diffusion(), ug::FVPointSourceOrSink< int dim, typename TData >::position(), s, UG_THROW, ug::VecDistance(), and ug::VecDot().

◆ add_jac_M_elem()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::add_jac_M_elem	(	LocalMatrix &	J,
		const LocalVector &	u,
		GridObject *	elem,
		const MathVector< dim >	vCornerCoords[]
	)

protectedvirtual

Reimplemented from ug::IElemAssembleFuncs< IElemDisc< TDomain >, TDomain >.

References ug::GeomProvider< typename TGeom >::get().

◆ add_rhs_elem()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::add_rhs_elem	(	LocalVector &	d,
		GridObject *	elem,
		const MathVector< dim >	vCornerCoords[]
	)

protectedvirtual

Reimplemented from ug::IElemAssembleFuncs< IElemDisc< TDomain >, TDomain >.

◆ add_river_sss_def_elem()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::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`
	)

private

adds contributions of a singular source or sink to the defect

Parameters

d	the defect to update
u	current solution
elem	the element
geo	the FV geometry for that element
i	index of the SCV
intensity	intensity of the source/sink (premultiplied by the length for lines)
concentration	concentration in the source

◆ add_river_sss_jac_elem()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::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`
	)

private

Parameters

J	the matrix to update
u	current solution
elem	the element
geo	the FV geometry for that element
i	index of the SCV
intensity	intensity of the source/sink (premultiplied by the length for lines)
concentration	concentration in the source
bottom_permeability	bottom permeability

◆ add_sss_def_elem()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::add_sss_def_elem	(	LocalVector &	d,
		const LocalVector &	u,
		GridObject *	elem,
		const TFVGeom &	geo,
		size_t	i,
		number	intensity,
		number	concentration
	)

private

adds contributions of a singular source or sink to the defect

Parameters

d	the defect to update
u	current solution
elem	the element
geo	the FV geometry for that element
i	index of the SCV
intensity	intensity of the source/sink (premultiplied by the length for lines)
concentration	concentration in the source

◆ add_sss_jac_elem()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::add_sss_jac_elem	(	LocalMatrix &	J,
		const LocalVector &	u,
		GridObject *	elem,
		const TFVGeom &	geo,
		size_t	i,
		number	intensity,
		number	concentration
	)

private

adds contributions of a singular source or sink to the matrix

Parameters

J	the matrix to update
u	current solution
elem	the element
geo	the FV geometry for that element
i	index of the SCV
intensity	intensity of the source/sink (premultiplied by the length for lines)
concentration	concentration in the source

◆ compute_ip_darcy_velocity_std()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowBase< TDomain >::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

compute darcy velocity at one ip

◆ condensed_FV()

template<typename TDomain >

bool ug::d3f::DensityDrivenFlowFV1< TDomain >::condensed_FV ( )

inline

returns the 'condensed scvf ip' flag

References ug::d3f::DensityDrivenFlowFV1< TDomain >::m_bCondensedFV.

◆ ex_brine()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::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[]
	)

protected

computes the value of the brine mass fraction

References ug::GeomProvider< typename TGeom >::get(), get(), and ug::BaseLSFS< typename TImpl, int TDim, typename TShape, typename TGrad >::shapes().

◆ ex_brine_grad()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::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[]
	)

protected

computes the value of the gradient of the brine mass fraction

References ug::GeomProvider< typename TGeom >::get(), get(), ug::BaseLSFS< typename TImpl, int TDim, typename TShape, typename TGrad >::grads(), ug::ReferenceMapping< typename TRefElem, int TWorldDim >::jacobian_transposed_inverse(), ug::MatVecMult(), ug::VecScaleAppend(), and ug::VecSet().

◆ ex_brine_tensor()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::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[]
	)

protected

computes the value of the gradient of the brine mass fraction

References ug::GeomProvider< typename TGeom >::get(), ug::MatAdd(), ug::MatScale(), UG_ASSERT, and UG_THROW.

◆ ex_darcy_cons_grav()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::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[]
	)

protected

computes the darcy velocity using consistent gravity

Consistent gravity and its derivative at corners

References ug::GeomProvider< typename TGeom >::get(), to(), UG_ASSERT, UG_CATCH_THROW, UG_THROW, ug::VecDot(), ug::VecScale(), ug::VecScaleAppend(), and ug::VecSubtract().

◆ ex_darcy_std()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::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[]
	)

protected

computes the darcy velocity using consistent gravity

References ug::GeomProvider< typename TGeom >::get(), to(), UG_THROW, ug::VecDot(), ug::VecScale(), ug::VecScaleAppend(), and ug::VecSubtract().

◆ ex_pressure()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::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[]
	)

protected

computes the value of the brine mass fraction

References ug::GeomProvider< typename TGeom >::get(), get(), and ug::BaseLSFS< typename TImpl, int TDim, typename TShape, typename TGrad >::shapes().

◆ ex_pressure_grad()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::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[]
	)

protected

computes the value of the gradient of the pressure

References ug::GeomProvider< typename TGeom >::get(), get(), ug::BaseLSFS< typename TImpl, int TDim, typename TShape, typename TGrad >::grads(), ug::ReferenceMapping< typename TRefElem, int TWorldDim >::jacobian_transposed_inverse(), ug::MatVecMult(), ug::VecScaleAppend(), and ug::VecSet().

◆ ex_pressure_tensor()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::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[]
	)

protected

computes the value of the gradient of the brine mass fraction

References ug::GeomProvider< typename TGeom >::get(), ug::MatScale(), UG_ASSERT, and UG_THROW.

◆ fsh_elem_loop()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::fsh_elem_loop ( )

protectedvirtual

Reimplemented from ug::IElemAssembleFuncs< IElemDisc< TDomain >, TDomain >.

◆ init()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::init ( )

protected

References make_sp(), and SPNULL.

Referenced by ug::d3f::DensityDrivenFlowFV1< TDomain >::DensityDrivenFlowFV1(), and ug::d3f::DensityDrivenFlowFV1< TDomain >::DensityDrivenFlowFV1().

◆ prep_assemble_loop()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::prep_assemble_loop ( )

protectedvirtual

Reimplemented from ug::IElemAssembleFuncs< IElemDisc< TDomain >, TDomain >.

◆ prep_elem()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::prep_elem	(	const LocalVector &	u,
		GridObject *	elem,
		const ReferenceObjectID	roid,
		const MathVector< dim >	vCornerCoords[]
	)

protectedvirtual

Reimplemented from ug::IElemAssembleFuncs< IElemDisc< TDomain >, TDomain >.

References ug::GeomProvider< typename TGeom >::get(), subset_handler(), UG_CATCH_THROW, and UG_THROW.

◆ prep_elem_loop()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::prep_elem_loop	(	const ReferenceObjectID	roid,
		const int	si
	)

protectedvirtual

Reimplemented from ug::IElemAssembleFuncs< IElemDisc< TDomain >, TDomain >.

References ug::GeomProvider< typename TGeom >::get(), and UG_THROW.

◆ prepare_setting()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::prepare_setting	(	const std::vector< LFEID > &	vLfeID,
		bool	bNonRegularGrid
	)

virtual

type of trial space for each function used

Implements ug::IElemDiscBase< typename TDomain >.

References ug::LFEID::LAGRANGE, and UG_THROW.

◆ register_all_funcs()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::register_all_funcs ( bool bHang )

private

register utils

Registers the assembling functions for all the element types

◆ register_func()

template<typename TDomain >

template<typename TElem , typename TFVGeom >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::register_func ( )

private

Registers the assembling functions for an element type and a finite volume geometry type.

◆ register_func_for_()

template<typename TDomain >

template<typename TElem >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::register_func_for_ ( bool bHang )

private

Registers the assembling functions for an element type.

References UG_THROW.

Referenced by ug::d3f::DensityDrivenFlowFV1< TDomain >::RegisterLocalDiscr::operator()().

◆ requests_local_time_series()

template<typename TDomain >

bool ug::d3f::DensityDrivenFlowFV1< TDomain >::requests_local_time_series ( )

protectedvirtual

returns if local time series is needed

Reimplemented from ug::d3f::DensityDrivenFlowBase< TDomain >.

◆ set_beta_p()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_beta_p ( SmartPtr< CplUserData< number, dim > > user )

◆ set_condensed_FV()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_condensed_FV ( bool condensed )

inline

activates/deactivates the condensed scvf ip's for the FV scheme

References ug::d3f::DensityDrivenFlowFV1< TDomain >::m_bCondensedFV.

◆ set_consistent_gravity()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_consistent_gravity ( bool bUse )

sets usage of consistent gravity

◆ set_density()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_density ( SmartPtr< CplUserData< number, dim > > data )

virtual

user data as requested by base class

Implements ug::d3f::DensityDrivenFlowBase< TDomain >.

References SPNULL, and SmartPtr< typename T, template< class TT > class FreePolicy >::valid().

◆ set_dispersion()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_dispersion ( SmartPtr< CplUserData< MathMatrix< dim, dim >, dim > > data )

virtual

user data as requested by base class

Implements ug::d3f::DensityDrivenFlowBase< TDomain >.

◆ set_gravity()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_gravity ( SmartPtr< CplUserData< MathVector< dim >, dim > > user )

virtual

user data as requested by base class

Implements ug::d3f::DensityDrivenFlowBase< TDomain >.

◆ set_molecular_diffusion()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_molecular_diffusion ( SmartPtr< CplUserData< MathMatrix< dim, dim >, dim > > user )

virtual

user data as requested by base class

Implements ug::d3f::DensityDrivenFlowBase< TDomain >.

◆ set_partial_velocity()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_partial_velocity ( int mask )

inline

References ug::d3f::DensityDrivenFlowFV1< TDomain >::m_partialAssMask_Conv.

◆ set_permeability()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_permeability ( SmartPtr< CplUserData< MathMatrix< dim, dim >, dim > > user )

virtual

user data as requested by base class

Implements ug::d3f::DensityDrivenFlowBase< TDomain >.

References SmartPtr< typename T, template< class TT > class FreePolicy >::valid().

◆ set_porosity()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_porosity ( SmartPtr< CplUserData< number, dim > > user )

virtual

user data as requested by base class

Implements ug::d3f::DensityDrivenFlowBase< TDomain >.

◆ set_relative_permeability()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_relative_permeability ( SmartPtr< CplUserData< number, dim > > user )

virtual

user data as requested by base class

References SmartPtr< typename T, template< class TT > class FreePolicy >::valid().

◆ set_river_sss_manager()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_river_sss_manager ( SmartPtr< RiverSingularSourcesAndSinks< dim > > sss_mngr )

inline

References ug::d3f::DensityDrivenFlowFV1< TDomain >::m_river_sss_mngr.

◆ set_saturation()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_saturation ( SmartPtr< CplUserData< number, dim > > user )

virtual

user data as requested by base class

◆ set_scheidegger_dispersion() [1/2]

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_scheidegger_dispersion	(	const number	alphaLong,
		const number	alphaTrans
	)

inline

user data as requested by base class

References ug::d3f::DensityDrivenFlowFV1< TDomain >::set_scheidegger_dispersion().

◆ set_scheidegger_dispersion() [2/2]

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_scheidegger_dispersion	(	const number	alphaLong,
		const number	alphaTrans,
		const number	wlimex = `1.0`
	)

user data as requested by base class

Referenced by ug::d3f::DensityDrivenFlowFV1< TDomain >::set_scheidegger_dispersion().

◆ set_sss_manager()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_sss_manager ( SmartPtr< DDSingularSourcesAndSinks< dim > > sss_mngr )

inline

set singular sources and sinks

References ug::d3f::DensityDrivenFlowFV1< TDomain >::m_sss_mngr.

◆ set_upwind()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_upwind ( SmartPtr< IConvectionShapes< dim > > shape )

sets the type of upwind

This method sets the procedure that compute the upwinded flux.

◆ set_viscosity()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_viscosity ( SmartPtr< CplUserData< number, dim > > user )

virtual

user data as requested by base class

Implements ug::d3f::DensityDrivenFlowBase< TDomain >.

References SmartPtr< typename T, template< class TT > class FreePolicy >::valid().

◆ set_volume_stabilization()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowFV1< TDomain >::set_volume_stabilization ( SmartPtr< FlowVolStabData< TDomain > > volStabData )

sets usage of volume stabilization

References SPNULL.

◆ sss_manager()

template<typename TDomain >

SmartPtr< DDSingularSourcesAndSinks< dim > > ug::d3f::DensityDrivenFlowFV1< TDomain >::sss_manager ( )

inline

get singular sources and sinks

References ug::d3f::DensityDrivenFlowFV1< TDomain >::m_sss_mngr.

◆ use_hanging()

template<typename TDomain >

bool ug::d3f::DensityDrivenFlowFV1< TDomain >::use_hanging ( ) const

virtual

returns if hanging nodes are needed

Reimplemented from ug::IElemDiscBase< typename TDomain >.

Member Data Documentation

◆ _C_

template<typename TDomain >

const size_t ug::d3f::DensityDrivenFlowFV1< TDomain >::_C_ = 0

staticprotected

abbreviation for local function: brine mass fraction

◆ _P_

template<typename TDomain >

const size_t ug::d3f::DensityDrivenFlowFV1< TDomain >::_P_ = 1

staticprotected

abbreviation for local function: pressure

◆ dim

template<typename TDomain >

const int ug::d3f::DensityDrivenFlowFV1< TDomain >::dim = base_type::dim

static

World dimension.

◆ m_bCondensedFV

template<typename TDomain >

bool ug::d3f::DensityDrivenFlowFV1< TDomain >::m_bCondensedFV

protected

if to use the 'condensed' FV scvf ip's

Referenced by ug::d3f::DensityDrivenFlowFV1< TDomain >::condensed_FV(), and ug::d3f::DensityDrivenFlowFV1< TDomain >::set_condensed_FV().

◆ m_bConsGravity

template<typename TDomain >

bool ug::d3f::DensityDrivenFlowFV1< TDomain >::m_bConsGravity

protected

flag if using consistent gravity

◆ m_bNonRegularGrid

template<typename TDomain >

bool ug::d3f::DensityDrivenFlowFV1< TDomain >::m_bNonRegularGrid

protected

current regular grid flag

◆ m_BoussinesqFlow

template<typename TDomain >

bool ug::d3f::DensityDrivenFlowBase< TDomain >::m_BoussinesqFlow

protected

flag if using boussinesq flow

◆ m_BoussinesqTransport

template<typename TDomain >

bool ug::d3f::DensityDrivenFlowBase< TDomain >::m_BoussinesqTransport

protected

flag if using boussinesq transport

◆ m_bVolStabDataActive

template<typename TDomain >

bool ug::d3f::DensityDrivenFlowFV1< TDomain >::m_bVolStabDataActive

protected

whether the volume stabilization is active (i.e. m_spVolStabData is not SPNULL and active)

◆ m_exBrine

template<typename TDomain >

SmartPtr<DataExport<number, dim> > ug::d3f::DensityDrivenFlowBase< TDomain >::m_exBrine

protected

Export for the brine mass fraction.

◆ m_exBrineGrad

template<typename TDomain >

SmartPtr<DataExport<MathVector<dim>,dim> > ug::d3f::DensityDrivenFlowBase< TDomain >::m_exBrineGrad

protected

Export for the gradient of brine mass fraction.

◆ m_exBrineTensor

template<typename TDomain >

SmartPtr<DataExport<MathMatrix<dim,dim>,dim> > ug::d3f::DensityDrivenFlowBase< TDomain >::m_exBrineTensor

protected

Export for the brine related tensor.

◆ m_exDarcyVel

template<typename TDomain >

SmartPtr<DataExport<MathVector<dim>, dim> > ug::d3f::DensityDrivenFlowBase< TDomain >::m_exDarcyVel

protected

Export for the Darcy velocity.

◆ m_exPressure

template<typename TDomain >

SmartPtr<DataExport<number, dim> > ug::d3f::DensityDrivenFlowBase< TDomain >::m_exPressure

protected

Export for the brine mass fraction.

◆ m_exPressureGrad

template<typename TDomain >

SmartPtr<DataExport<MathVector<dim>,dim> > ug::d3f::DensityDrivenFlowBase< TDomain >::m_exPressureGrad

protected

Export for the gradient of brine mass fraction.

◆ m_exPressureTensor

template<typename TDomain >

SmartPtr<DataExport<MathMatrix<dim,dim>,dim> > ug::d3f::DensityDrivenFlowBase< TDomain >::m_exPressureTensor

protected

Export for the pressure related tensor.

◆ m_Gravity

template<typename TDomain >

MathVector<dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_Gravity

protected

constant Gravity, read in once

◆ m_imBrineGradScvf

template<typename TDomain >

DataImport<MathVector<dim>, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imBrineGradScvf

private

◆ m_imBrineScvf

template<typename TDomain >

DataImport<number, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imBrineScvf

private

Data import for brine mass fraction at scvf ips.

◆ m_imConstGravity

template<typename TDomain >

DataImport<MathVector<dim>, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imConstGravity

private

Data import for gravity (must be constant in current implementation)

◆ m_imDarcyVelScvf

template<typename TDomain >

DataImport<MathVector<dim>, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imDarcyVelScvf

private

Data import for Darcy Velocity.

◆ m_imDensityScv

template<typename TDomain >

DataImport<number, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imDensityScv

private

Data import for density.

◆ m_imDensityScvf

template<typename TDomain >

DataImport<number, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imDensityScvf

private

◆ m_imDispersionScvf

template<typename TDomain >

DataImport<MathMatrix<dim,dim>, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imDispersionScvf

private

Data import for Dispersion.

◆ m_imMolDiffusionScvf

template<typename TDomain >

DataImport<MathMatrix<dim, dim>, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imMolDiffusionScvf

private

Data import for molecular diffusion tensor.

◆ m_imOldDensityScv

template<typename TDomain >

DataImport<number, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imOldDensityScv

private

◆ m_imPermeabilityScv

template<typename TDomain >

DataImport<MathMatrix<dim, dim>, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imPermeabilityScv

private

◆ m_imPermeabilityScvf

template<typename TDomain >

DataImport<MathMatrix<dim, dim>, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imPermeabilityScvf

private

Data import for permeability tensor.

◆ m_imPorosityScv

template<typename TDomain >

DataImport<number, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imPorosityScv

private

Data import for the porosity term.

◆ m_imPorosityScvf

template<typename TDomain >

DataImport<number, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imPorosityScvf

private

◆ m_imPressureGradScvf

template<typename TDomain >

DataImport<MathVector<dim>, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imPressureGradScvf

private

◆ m_imPressureScvf

template<typename TDomain >

DataImport<number, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imPressureScvf

private

Data import for pressure at scvf ips.

◆ m_imRelativePermeabilityScv

template<typename TDomain >

DataImport<number, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imRelativePermeabilityScv

private

Data import for permeability scale.

◆ m_imRelativePermeabilityScvf

template<typename TDomain >

DataImport<number, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imRelativePermeabilityScvf

private

◆ m_imSaturationScv

template<typename TDomain >

DataImport<number, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imSaturationScv

private

Data import for saturation.

◆ m_imViscosityScvf

template<typename TDomain >

DataImport<number, dim> ug::d3f::DensityDrivenFlowFV1< TDomain >::m_imViscosityScvf

private

Data import for viscosity.

◆ m_partialAssMask_Conv

template<typename TDomain >

int ug::d3f::DensityDrivenFlowFV1< TDomain >::m_partialAssMask_Conv

protected

Referenced by ug::d3f::DensityDrivenFlowFV1< TDomain >::set_partial_velocity().

◆ m_river_sss_mngr

template<typename TDomain >

SmartPtr<RiverSingularSourcesAndSinks<dim> > ug::d3f::DensityDrivenFlowFV1< TDomain >::m_river_sss_mngr

private

river singular sources and sinks manager

Referenced by ug::d3f::DensityDrivenFlowFV1< TDomain >::set_river_sss_manager().

◆ m_spUpwind

template<typename TDomain >

SmartPtr<IConvectionShapes<dim> > ug::d3f::DensityDrivenFlowFV1< TDomain >::m_spUpwind

protected

strategy to compute the upwind shapes

◆ m_spVolStabData

template<typename TDomain >

SmartPtr<FlowVolStabData<TDomain> > ug::d3f::DensityDrivenFlowFV1< TDomain >::m_spVolStabData

protected

the volume stabilization

◆ m_sss_mngr

template<typename TDomain >

SmartPtr<DDSingularSourcesAndSinks<dim> > ug::d3f::DensityDrivenFlowFV1< TDomain >::m_sss_mngr

private

singular sources and sinks manager

Referenced by ug::d3f::DensityDrivenFlowFV1< TDomain >::set_sss_manager(), and ug::d3f::DensityDrivenFlowFV1< TDomain >::sss_manager().

The documentation for this class was generated from the following files:

/home/runner/work/docs/docs/ug4/plugins/d3f/density_driven_flow/fv1/density_driven_flow_fv1.h
/home/runner/work/docs/docs/ug4/plugins/d3f/density_driven_flow/fv1/density_driven_flow_fv1.cpp

Classes

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ base_type

◆ this_type

Constructor & Destructor Documentation

◆ DensityDrivenFlowFV1() [1/2]

◆ DensityDrivenFlowFV1() [2/2]

Member Function Documentation

◆ add_def_A_elem()

◆ add_def_M_elem()

◆ add_jac_A_elem()

◆ add_jac_M_elem()

◆ add_rhs_elem()

◆ add_river_sss_def_elem()

◆ add_river_sss_jac_elem()

◆ add_sss_def_elem()

◆ add_sss_jac_elem()

◆ compute_ip_darcy_velocity_std()

◆ condensed_FV()

◆ ex_brine()

◆ ex_brine_grad()

◆ ex_brine_tensor()

◆ ex_darcy_cons_grav()

◆ ex_darcy_std()

◆ ex_pressure()

◆ ex_pressure_grad()

◆ ex_pressure_tensor()

◆ fsh_elem_loop()

◆ init()

◆ prep_assemble_loop()

◆ prep_elem()

◆ prep_elem_loop()

◆ prepare_setting()

◆ register_all_funcs()

◆ register_func()

◆ register_func_for_()

◆ requests_local_time_series()

◆ set_beta_p()

◆ set_condensed_FV()

◆ set_consistent_gravity()

◆ set_density()

◆ set_dispersion()

◆ set_gravity()

◆ set_molecular_diffusion()

◆ set_partial_velocity()

◆ set_permeability()

◆ set_porosity()

◆ set_relative_permeability()

◆ set_river_sss_manager()

◆ set_saturation()

◆ set_scheidegger_dispersion() [1/2]

◆ set_scheidegger_dispersion() [2/2]

◆ set_sss_manager()

◆ set_upwind()

◆ set_viscosity()

◆ set_volume_stabilization()

◆ sss_manager()

◆ use_hanging()

Member Data Documentation

◆ _C_

◆ _P_

◆ dim

◆ m_bCondensedFV

◆ m_bConsGravity

◆ m_bNonRegularGrid

◆ m_BoussinesqFlow

◆ m_BoussinesqTransport

◆ m_bVolStabDataActive

◆ m_exBrine

◆ m_exBrineGrad