ug::Richards::RichardsElemDiscFactory< TDomain > Class Template Reference

! Factory for creating elem discs. More...

#include <richards_elem_disc.h>

Public Types
typedef IRichardsLinker< dim >	TConductivity
typedef ConstUserNumber< dim >	TConstUserNumber
typedef ConstUserVector< dim >	TConstUserVector
typedef ug::ConvectionDiffusionPlugin::ConvectionDiffusionFV1< TDomain >	TConvDiff
typedef IElemDisc< TDomain >	TElemDisc
typedef CplUserData< number, dim >	TNumberData
typedef RichardsElemDisc< TDomain >	TRichards
typedef IRichardsLinker< dim >	TSaturation
typedef ScaleAddLinker< number, dim, number >	TScaleAddLinkerNumber
typedef ScaleAddLinker< MathVector< dim >, dim, number >	TScaleAddLinkerVector
typedef CplUserData< MathVector< dim >, dim >	TVectorData

Public Member Functions
SmartPtr< TRichards >	create_richards (const char *subsets)
	Create classic Richards equation.
const char *	get_disc_type ()
	RichardsElemDiscFactory ()
void	set_abs_conductivity (SmartPtr< TNumberData > data)
void	set_conductivity (SmartPtr< TConductivity > data)
void	set_function (const char *functions)
void	set_gravity (number g)
void	set_saturation (SmartPtr< TSaturation > data)

Static Public Attributes
static const int	dim = TDomain::dim

Protected Attributes
number	m_dGravity
std::string	m_functions
SmartPtr< TNumberData >	m_spAbsConductivity
SmartPtr< TConductivity >	m_spRelConductivity
SmartPtr< TSaturation >	m_spSaturation

Detailed Description

template<typename TDomain>
class ug::Richards::RichardsElemDiscFactory< TDomain >

! Factory for creating elem discs.

Member Typedef Documentation

TConductivity

template<typename TDomain >

typedef IRichardsLinker<dim> ug::Richards::RichardsElemDiscFactory< TDomain >::TConductivity

TConstUserNumber

template<typename TDomain >

typedef ConstUserNumber<dim> ug::Richards::RichardsElemDiscFactory< TDomain >::TConstUserNumber

TConstUserVector

template<typename TDomain >

typedef ConstUserVector<dim> ug::Richards::RichardsElemDiscFactory< TDomain >::TConstUserVector

TConvDiff

template<typename TDomain >

typedef ug::ConvectionDiffusionPlugin::ConvectionDiffusionFV1<TDomain> ug::Richards::RichardsElemDiscFactory< TDomain >::TConvDiff

TElemDisc

template<typename TDomain >

typedef IElemDisc<TDomain> ug::Richards::RichardsElemDiscFactory< TDomain >::TElemDisc

TNumberData

template<typename TDomain >

typedef CplUserData<number, dim> ug::Richards::RichardsElemDiscFactory< TDomain >::TNumberData

TRichards

template<typename TDomain >

typedef RichardsElemDisc<TDomain> ug::Richards::RichardsElemDiscFactory< TDomain >::TRichards

TSaturation

template<typename TDomain >

typedef IRichardsLinker<dim> ug::Richards::RichardsElemDiscFactory< TDomain >::TSaturation

TScaleAddLinkerNumber

template<typename TDomain >

typedef ScaleAddLinker<number, dim, number> ug::Richards::RichardsElemDiscFactory< TDomain >::TScaleAddLinkerNumber

TScaleAddLinkerVector

template<typename TDomain >

typedef ScaleAddLinker<MathVector<dim>, dim, number> ug::Richards::RichardsElemDiscFactory< TDomain >::TScaleAddLinkerVector

TVectorData

template<typename TDomain >

typedef CplUserData<MathVector<dim>, dim> ug::Richards::RichardsElemDiscFactory< TDomain >::TVectorData

Constructor & Destructor Documentation

RichardsElemDiscFactory()

template<typename TDomain >

ug::Richards::RichardsElemDiscFactory< TDomain >::RichardsElemDiscFactory ( )

inline

References SPNULL.

Member Function Documentation

create_richards()

template<typename TDomain >

SmartPtr< TRichards > ug::Richards::RichardsElemDiscFactory< TDomain >::create_richards ( const char *  subsets )

inline

Create classic Richards equation.

Element discretization for: \frac{\partial S(-h)}{\partial t} + \nabla \cdot [- C \nabla (h+z)] = 0

Input parameters: saturation S, conductivity C = Cabs*Crel, gravity $\nabla z$

Create elem disc.

References ug::Richards::RichardsElemDiscFactory< TDomain >::dim, ug::Richards::RichardsElemDiscFactory< TDomain >::m_dGravity, ug::Richards::RichardsElemDiscFactory< TDomain >::m_functions, ug::Richards::RichardsElemDiscFactory< TDomain >::m_spAbsConductivity, ug::Richards::RichardsElemDiscFactory< TDomain >::m_spRelConductivity, ug::Richards::RichardsElemDiscFactory< TDomain >::m_spSaturation, and UG_ASSERT.

get_disc_type()

template<typename TDomain >

const char * ug::Richards::RichardsElemDiscFactory< TDomain >::get_disc_type ( )

inline

set_abs_conductivity()

template<typename TDomain >

void ug::Richards::RichardsElemDiscFactory< TDomain >::set_abs_conductivity ( SmartPtr< TNumberData >  data )

inline

References ug::Richards::RichardsElemDiscFactory< TDomain >::m_spAbsConductivity.

set_conductivity()

template<typename TDomain >

void ug::Richards::RichardsElemDiscFactory< TDomain >::set_conductivity ( SmartPtr< TConductivity >  data )

inline

References ug::Richards::RichardsElemDiscFactory< TDomain >::m_spRelConductivity.

set_function()

template<typename TDomain >

void ug::Richards::RichardsElemDiscFactory< TDomain >::set_function ( const char *  functions )

inline

References ug::Richards::RichardsElemDiscFactory< TDomain >::m_functions.

set_gravity()

template<typename TDomain >

void ug::Richards::RichardsElemDiscFactory< TDomain >::set_gravity ( number  g )

inline

References ug::Richards::RichardsElemDiscFactory< TDomain >::m_dGravity.

set_saturation()

template<typename TDomain >

void ug::Richards::RichardsElemDiscFactory< TDomain >::set_saturation ( SmartPtr< TSaturation >  data )

inline

References ug::Richards::RichardsElemDiscFactory< TDomain >::m_spSaturation.

Member Data Documentation

dim

template<typename TDomain >

const int ug::Richards::RichardsElemDiscFactory< TDomain >::dim = TDomain::dim

static

Referenced by ug::Richards::RichardsElemDiscFactory< TDomain >::create_richards().

m_dGravity

template<typename TDomain >

number ug::Richards::RichardsElemDiscFactory< TDomain >::m_dGravity

protected

Referenced by ug::Richards::RichardsElemDiscFactory< TDomain >::create_richards(), and ug::Richards::RichardsElemDiscFactory< TDomain >::set_gravity().

m_functions

template<typename TDomain >

std::string ug::Richards::RichardsElemDiscFactory< TDomain >::m_functions

protected

Referenced by ug::Richards::RichardsElemDiscFactory< TDomain >::create_richards(), and ug::Richards::RichardsElemDiscFactory< TDomain >::set_function().

m_spAbsConductivity

template<typename TDomain >

SmartPtr<TNumberData> ug::Richards::RichardsElemDiscFactory< TDomain >::m_spAbsConductivity

protected

Referenced by ug::Richards::RichardsElemDiscFactory< TDomain >::create_richards(), and ug::Richards::RichardsElemDiscFactory< TDomain >::set_abs_conductivity().

m_spRelConductivity

template<typename TDomain >

SmartPtr<TConductivity> ug::Richards::RichardsElemDiscFactory< TDomain >::m_spRelConductivity

protected

Referenced by ug::Richards::RichardsElemDiscFactory< TDomain >::create_richards(), and ug::Richards::RichardsElemDiscFactory< TDomain >::set_conductivity().

m_spSaturation

template<typename TDomain >

SmartPtr<TSaturation> ug::Richards::RichardsElemDiscFactory< TDomain >::m_spSaturation

protected

Referenced by ug::Richards::RichardsElemDiscFactory< TDomain >::create_richards(), and ug::Richards::RichardsElemDiscFactory< TDomain >::set_saturation().

---

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

• /home/runner/work/docs/docs/ug4/plugins/Richards/richards_elem_disc.h