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

#include <density_driven_flow_base.h>

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

Public Member Functions
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

virtual void	set_dispersion (SmartPtr< CplUserData< MathMatrix< dim, dim >, dim > > data)=0
	set dispersion


virtual void	set_porosity (SmartPtr< CplUserData< number, dim > > user)=0
	sets the porosity

void	set_porosity (number val)
	sets the porosity


virtual void	set_gravity (SmartPtr< CplUserData< MathVector< dim >, dim > > user)=0
	sets the gravity vector

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


virtual void	set_molecular_diffusion (SmartPtr< CplUserData< MathMatrix< dim, dim >, dim > > user)=0
	sets the molecular diffusion tensor

void	set_molecular_diffusion (number val)
	sets the molecular diffusion tensor


virtual void	set_permeability (SmartPtr< CplUserData< MathMatrix< dim, dim >, dim > > user)=0
	sets the permeability tensor

void	set_permeability (number val)
	sets the permeability tensor


virtual void	set_viscosity (SmartPtr< CplUserData< number, dim > > user)=0
	sets the viscosity tensor

void	set_viscosity (number val)
	sets the viscosity tensor


virtual void	set_density (SmartPtr< CplUserData< number, dim > > data)=0
	sets the density

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_elem (LocalVector &d, const LocalVector &u, GridObject *elem, const MathVector< dim > vCornerCoords[])

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

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

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

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

virtual void	add_rhs_elem (LocalVector &rhs, 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_elem_loop ()

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_assemble_loop ()

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

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

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

virtual void	prepare_setting (const std::vector< LFEID > &vLfeID, bool bNonRegularGrid)=0

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 bool	use_hanging () 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::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
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

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

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_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

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

typedef DensityDrivenFlowBase< TDomain >	this_type
	own type

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

private

Base class type.

◆ this_type

template<typename TDomain >

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

private

own type

Constructor & Destructor Documentation

◆ DensityDrivenFlowBase() [1/2]

template<typename TDomain >

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

Constructor.

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

◆ DensityDrivenFlowBase() [2/2]

template<typename TDomain >

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

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

Member Function Documentation

◆ brine()

template<typename TDomain >

SmartPtr< CplUserData< number, dim > > ug::d3f::DensityDrivenFlowBase< TDomain >::brine ( )

inline

returns the export of brine mass fracture

References ug::d3f::DensityDrivenFlowBase< TDomain >::m_exBrine.

◆ brine_grad()

template<typename TDomain >

SmartPtr< CplUserData< MathVector< dim >, dim > > ug::d3f::DensityDrivenFlowBase< TDomain >::brine_grad ( )

inline

returns the export of brine mass fracture

References ug::d3f::DensityDrivenFlowBase< TDomain >::m_exBrineGrad.

◆ brine_tensor()

template<typename TDomain >

SmartPtr< CplUserData< MathMatrix< dim, dim >, dim > > ug::d3f::DensityDrivenFlowBase< TDomain >::brine_tensor ( )

inline

returns the export of brine tensor

References ug::d3f::DensityDrivenFlowBase< TDomain >::m_exBrineTensor.

◆ 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

◆ darcy_velocity()

template<typename TDomain >

SmartPtr< CplUserData< MathVector< dim >, dim > > ug::d3f::DensityDrivenFlowBase< TDomain >::darcy_velocity ( )

inline

returns the export of the darcy velocity

References ug::d3f::DensityDrivenFlowBase< TDomain >::m_exDarcyVel.

◆ init()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowBase< TDomain >::init ( const char * functions )

protected

standard initialization

References make_sp(), and UG_THROW.

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

◆ pressure()

template<typename TDomain >

SmartPtr< CplUserData< number, dim > > ug::d3f::DensityDrivenFlowBase< TDomain >::pressure ( )

inline

returns the export of pressure

References ug::d3f::DensityDrivenFlowBase< TDomain >::m_exPressure.

◆ pressure_grad()

template<typename TDomain >

SmartPtr< CplUserData< MathVector< dim >, dim > > ug::d3f::DensityDrivenFlowBase< TDomain >::pressure_grad ( )

inline

returns the export of brine mass fracture

References ug::d3f::DensityDrivenFlowBase< TDomain >::m_exPressureGrad.

◆ pressure_tensor()

template<typename TDomain >

SmartPtr< CplUserData< MathMatrix< dim, dim >, dim > > ug::d3f::DensityDrivenFlowBase< TDomain >::pressure_tensor ( )

inline

returns the export of brine tensor

References ug::d3f::DensityDrivenFlowBase< TDomain >::m_exPressureTensor.

◆ requests_local_time_series()

template<typename TDomain >

virtual bool ug::d3f::DensityDrivenFlowBase< TDomain >::requests_local_time_series ( )

inlineprotectedvirtual

returns if local time series is needed

Reimplemented from ug::IElemDiscBase< typename TDomain >.

Reimplemented in ug::d3f::DensityDrivenFlowFV1< TDomain >.

◆ set_boussinesq_flow()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowBase< TDomain >::set_boussinesq_flow ( bool bUse )

inline

sets usage of boussinesq approximation for flow equation

References ug::d3f::DensityDrivenFlowBase< TDomain >::m_BoussinesqFlow.

◆ set_boussinesq_transport()

template<typename TDomain >

void ug::d3f::DensityDrivenFlowBase< TDomain >::set_boussinesq_transport ( bool bUse )

inline

sets usage of boussinesq approximation for transport equation

References ug::d3f::DensityDrivenFlowBase< TDomain >::m_BoussinesqTransport.

◆ set_density() [1/2]

template<typename TDomain >

void ug::d3f::DensityDrivenFlowBase< TDomain >::set_density ( number val )

sets the density

This method sets the Density.

References make_sp().

◆ set_density() [2/2]

template<typename TDomain >

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

pure virtual

sets the density

This method sets the Density.

Implemented in ug::d3f::DensityDrivenFlowFV< TDomain >, and ug::d3f::DensityDrivenFlowFV1< TDomain >.

◆ set_dispersion()

template<typename TDomain >

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

pure virtual

set dispersion

Implemented in ug::d3f::DensityDrivenFlowFV< TDomain >, and ug::d3f::DensityDrivenFlowFV1< TDomain >.

◆ set_gravity() [1/2]

template<typename TDomain >

void ug::d3f::DensityDrivenFlowBase< TDomain >::set_gravity ( const std::vector< number > & vVel )

sets the gravity vector

This method sets the Gravity. (Unit is \( \frac{m}{s^2} \))

◆ set_gravity() [2/2]

template<typename TDomain >

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

pure virtual

sets the gravity vector

This method sets the Gravity. (Unit is \( \frac{m}{s^2} \))

Implemented in ug::d3f::DensityDrivenFlowFV< TDomain >, and ug::d3f::DensityDrivenFlowFV1< TDomain >.

◆ set_molecular_diffusion() [1/2]

template<typename TDomain >

void ug::d3f::DensityDrivenFlowBase< TDomain >::set_molecular_diffusion ( number val )

sets the molecular diffusion tensor

This method sets the molecular Diffusion tensor.

References make_sp().

◆ set_molecular_diffusion() [2/2]

template<typename TDomain >

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

pure virtual

sets the molecular diffusion tensor

This method sets the molecular Diffusion tensor.

Implemented in ug::d3f::DensityDrivenFlowFV< TDomain >, and ug::d3f::DensityDrivenFlowFV1< TDomain >.

◆ set_permeability() [1/2]

template<typename TDomain >

void ug::d3f::DensityDrivenFlowBase< TDomain >::set_permeability ( number val )

sets the permeability tensor

This method sets the Permeability tensor.

References make_sp().

◆ set_permeability() [2/2]

template<typename TDomain >

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

pure virtual

sets the permeability tensor

This method sets the Permeability tensor.

Implemented in ug::d3f::DensityDrivenFlowFV< TDomain >, and ug::d3f::DensityDrivenFlowFV1< TDomain >.

◆ set_porosity() [1/2]

template<typename TDomain >

void ug::d3f::DensityDrivenFlowBase< TDomain >::set_porosity ( number val )

sets the porosity

This method sets the Porosity. (Dimensionless)

References make_sp().

◆ set_porosity() [2/2]

template<typename TDomain >

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

pure virtual

sets the porosity

This method sets the Porosity. (Dimensionless)

Implemented in ug::d3f::DensityDrivenFlowFV< TDomain >, and ug::d3f::DensityDrivenFlowFV1< TDomain >.

◆ set_viscosity() [1/2]

template<typename TDomain >

void ug::d3f::DensityDrivenFlowBase< TDomain >::set_viscosity ( number val )

sets the viscosity tensor

This method sets the Viscosity.

References make_sp().

◆ set_viscosity() [2/2]

template<typename TDomain >

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

pure virtual

sets the viscosity tensor

This method sets the Viscosity.

Implemented in ug::d3f::DensityDrivenFlowFV< TDomain >, and ug::d3f::DensityDrivenFlowFV1< TDomain >.

Member Data Documentation

◆ dim

template<typename TDomain >

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

static

World dimension.

◆ m_BoussinesqFlow

template<typename TDomain >

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

protected

flag if using boussinesq flow

Referenced by ug::d3f::DensityDrivenFlowBase< TDomain >::set_boussinesq_flow().

◆ m_BoussinesqTransport

template<typename TDomain >

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

protected

flag if using boussinesq transport

Referenced by ug::d3f::DensityDrivenFlowBase< TDomain >::set_boussinesq_transport().

◆ m_exBrine

template<typename TDomain >

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

protected

Export for the brine mass fraction.

Referenced by ug::d3f::DensityDrivenFlowBase< TDomain >::brine().

◆ 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.

Referenced by ug::d3f::DensityDrivenFlowBase< TDomain >::brine_grad().

◆ m_exBrineTensor

template<typename TDomain >

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

protected

Export for the brine related tensor.

Referenced by ug::d3f::DensityDrivenFlowBase< TDomain >::brine_tensor().

◆ m_exDarcyVel

template<typename TDomain >

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

protected

Export for the Darcy velocity.

Referenced by ug::d3f::DensityDrivenFlowBase< TDomain >::darcy_velocity().

◆ m_exPressure

template<typename TDomain >

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

protected

Export for the brine mass fraction.

Referenced by ug::d3f::DensityDrivenFlowBase< TDomain >::pressure().

◆ 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.

Referenced by ug::d3f::DensityDrivenFlowBase< TDomain >::pressure_grad().

◆ m_exPressureTensor

template<typename TDomain >

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

protected

Export for the pressure related tensor.

Referenced by ug::d3f::DensityDrivenFlowBase< TDomain >::pressure_tensor().

◆ m_Gravity

template<typename TDomain >

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

protected

constant Gravity, read in once

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

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

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Types

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ base_type

◆ this_type

Constructor & Destructor Documentation

◆ DensityDrivenFlowBase() [1/2]

◆ DensityDrivenFlowBase() [2/2]

Member Function Documentation

◆ brine()

◆ brine_grad()

◆ brine_tensor()

◆ compute_ip_darcy_velocity_std()

◆ darcy_velocity()

◆ init()

◆ pressure()

◆ pressure_grad()

◆ pressure_tensor()

◆ requests_local_time_series()

◆ set_boussinesq_flow()

◆ set_boussinesq_transport()

◆ set_density() [1/2]

◆ set_density() [2/2]

◆ set_dispersion()

◆ set_gravity() [1/2]

◆ set_gravity() [2/2]

◆ set_molecular_diffusion() [1/2]

◆ set_molecular_diffusion() [2/2]

◆ set_permeability() [1/2]

◆ set_permeability() [2/2]

◆ set_porosity() [1/2]

◆ set_porosity() [2/2]

◆ set_viscosity() [1/2]

◆ set_viscosity() [2/2]

Member Data Documentation

◆ dim

◆ m_BoussinesqFlow

◆ m_BoussinesqTransport

◆ m_exBrine

◆ m_exBrineGrad

◆ m_exBrineTensor

◆ m_exDarcyVel

◆ m_exPressure

◆ m_exPressureGrad

◆ m_exPressureTensor

◆ m_Gravity