van Genuchten classes. (ideally, those could be type-def'ed as well..) More...

#include <richards_linker.h>

Inheritance diagram for ug::Richards::RichardsSaturation< dim >:

Public Types
typedef RichardsLinker< dim, vanGenuchtenSaturationAdapter >	base_type

Public Types inherited from ug::Richards::RichardsLinker< dim, vanGenuchtenSaturationAdapter >
typedef StdDataLinker< RichardsLinker< dim, vanGenuchtenSaturationAdapter >, number, dim >	base_type
	Base class type. More...

typedef number	data_type

enum	inputs

typedef IRichardsLinker< dim >	richards_base_type

typedef TFunctor::TModel	TModel

typedef base_type::base_type	user_data_base_type

Public Types inherited from ug::DependentUserData< class, dim >
typedef CplUserData< TData, dim >	base_type

Public Types inherited from ug::CplUserData< class, dim, class >
typedef ICplUserData< dim >	base_type

Public Types inherited from UserData< TData, dim, void >
typedef TData	data_type

typedef void	return_type

Public Member Functions
	RichardsSaturation (const typename base_type::TModel &model)

Public Member Functions inherited from ug::Richards::RichardsLinker< dim, vanGenuchtenSaturationAdapter >
void	eval_and_deriv (data_type vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< refDim > vLocIP[], const size_t nip, LocalVector u, bool bDeriv, int s, std::vector< std::vector< number > > vvvDeriv[], const MathMatrix< refDim, dim > *vJT=NULL) const

void	evaluate (data_type &value, const MathVector< dim > &globIP, number time, int si) const

void	evaluate (data_type vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< refDim > vLocIP[], const size_t nip, LocalVector u, const MathMatrix< refDim, dim > *vJT=NULL) const

TModel &	model ()

const TModel &	model () const

	RichardsLinker (const TModel &model)

void	set_capillary (SmartPtr< CplUserData< number, dim > > data)
	Implements IRichardsLinker interface. More...

Public Member Functions inherited from ug::StdDataLinker< class, class, dim >
virtual void	check_setup () const

virtual void	compute (LocalVector u, GridObject elem, const MathVector< dim > vCornerCoords[], bool bDeriv=false)

virtual void	compute (LocalVectorTimeSeries u, GridObject elem, const MathVector< dim > vCornerCoords[], bool bDeriv=false)

virtual bool	continuous () const

void	evaluate (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< refDim > vLocIP[], const size_t nip, LocalVector u, const MathMatrix< refDim, dim > *vJT=NULL) const

virtual SmartPtr< ICplUserData< dim > >	needed_data (size_t i)

virtual size_t	num_input () const

virtual size_t	num_needed_data () const

virtual void	operator() (TData &value, const MathVector< dim > &globIP, number time, int si) const

virtual void	operator() (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, const size_t nip) const

virtual bool	requires_grid_fct () const

virtual void	set_function_pattern (ConstSmartPtr< FunctionPattern > fctPatt)

virtual void	set_input (size_t i, SmartPtr< ICplUserData< dim > > input, SmartPtr< UserDataInfo > info)

void	set_num_input (size_t num)

virtual bool	zero_derivative () const

bool	zero_derivative (size_t i) const

Public Member Functions inherited from StdUserData< StdDataLinker< TImpl, TData, dim >, TData, dim, void, DependentUserData< TData, dim > >
virtual void	operator() (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 1 > vLocIP[], const size_t nip, LocalVector u, const MathMatrix< 1, dim > *vJT=NULL) const

virtual void	operator() (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 1 > vLocIP[], const size_t nip, LocalVector u, const MathMatrix< 1, dim > *vJT=NULL) const

virtual void	operator() (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 2 > vLocIP[], const size_t nip, LocalVector u, const MathMatrix< 2, dim > *vJT=NULL) const

virtual void	operator() (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 2 > vLocIP[], const size_t nip, LocalVector u, const MathMatrix< 2, dim > *vJT=NULL) const

virtual void	operator() (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 3 > vLocIP[], const size_t nip, LocalVector u, const MathMatrix< 3, dim > *vJT=NULL) const

virtual void	operator() (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 3 > vLocIP[], const size_t nip, LocalVector u, const MathMatrix< 3, dim > *vJT=NULL) const

Public Member Functions inherited from ug::DependentUserData< class, dim >
	DependentUserData ()

	DependentUserData (const char *symbFct)

	DependentUserData (const char *symbFct)

	DependentUserData (const std::string &symbFct)

	DependentUserData (const std::string &symbFct)

	DependentUserData (const std::vector< std::string > &symbFct)

	DependentUserData (const std::vector< std::string > &symbFct)

TData *	deriv (size_t s, size_t ip, size_t fct)

const TData *	deriv (size_t s, size_t ip, size_t fct) const

TData &	deriv (size_t s, size_t ip, size_t fct, size_t dof)

const TData &	deriv (size_t s, size_t ip, size_t fct, size_t dof) const

const MathVector< ldim > *	local_ips (size_t s) const

size_t	num_ip (size_t s) const

size_t	num_series () const

size_t	num_sh (size_t fct) const

void	set_functions (const char *symbFct)

void	set_functions (const char *symbFct)

void	set_functions (const std::string &symbFct)

void	set_functions (const std::string &symbFct)

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

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

virtual void	update_dof_sizes (const LocalIndices &ind)

Public Member Functions inherited from ug::CplUserData< class, dim, class >
bool	defined (size_t s, size_t ip) const

size_t	num_ip (size_t s) const

size_t	num_series () const

void	register_storage_callback (DataImport< TData, dim > obj, void(DataImport< TData, dim >::func)())

void	unregister_storage_callback (DataImport< TData, dim > *obj)

TData &	value (size_t s, size_t ip)

const TData &	value (size_t s, size_t ip) const

TData *	values (size_t s)

const TData *	values (size_t s) const

	~CplUserData ()

Public Member Functions inherited from ug::ICplUserData< dim >
bool	at_current_time (size_t s) const

void	clear ()

virtual bool	constant () const

int	dim_local_ips () const

	ICplUserData ()

const MathVector< dim > &	ip (size_t s, size_t ip) const

const MathVector< dim > *	ips (size_t s) const

const MathVector< ldim > &	local_ip (size_t s, size_t ip) const

const MathVector< ldim > *	local_ips (size_t s) const

size_t	num_ip (size_t s) const

size_t	num_series () const

size_t	register_local_ip_series (const MathVector< ldim > *vPos, const size_t numIP, bool bMayChange=true)

size_t	register_local_ip_series (const MathVector< ldim > *vPos, const size_t numIP, const int timePointSpec, bool bMayChange=true)

void	set_global_ips (size_t s, const MathVector< dim > *vPos, size_t numIP)

void	set_local_ips (const size_t seriesId, const MathVector< ldim > *vPos, const size_t numIP)

void	set_subset (int si)

void	set_time_point (const size_t seriesId, const int timePointSpec)

void	set_time_point (size_t timePoint)

void	set_times (const std::vector< number > &vTime)

int	subset () const

number	time () const

number	time (size_t s) const

size_t	time_point ()

size_t	time_point (size_t s) const

int	time_point_specification (size_t s) const

virtual	~ICplUserData ()

Public Member Functions inherited from ug::UserDataInfo
const FunctionGroup &	function_group () const

const FunctionIndexMapping &	map () const

size_t	num_fct () const

const char *	obj_name ()

void	set_obj_name (const char *name)

virtual	~UserDataInfo ()

Public Member Functions inherited from UserData< TData, dim, void >
int	get_dim () const

void	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 1 > &locIP, LocalVector u) const

void	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 1 > &locIP, LocalVector u) const

void	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 2 > &locIP, LocalVector u) const

void	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 2 > &locIP, LocalVector u) const

void	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 3 > &locIP, LocalVector u) const

void	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 3 > &locIP, LocalVector u) const

virtual void	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, Vertex *vrt) const

std::string	type () const

Public Member Functions inherited from ug::Richards::IRichardsLinker< dim >
	IRichardsLinker ()

virtual	~IRichardsLinker ()

Additional Inherited Members
Static Public Member Functions inherited from ug::DependentUserData< class, dim >
static void	set_zero (std::vector< std::vector< TData > > vvvDeriv[], const size_t nip)

Public Attributes inherited from ug::Richards::IRichardsLinker< dim >
SmartPtr< CplUserData< number, dim > >	m_spCapillary

SmartPtr< DependentUserData< number, dim > >	m_spDCapillary

Protected Member Functions inherited from ug::StdDataLinker< class, class, dim >
void	eval_deriv (LocalVector u, GridObject elem, const MathVector< dim > vCornerCoords[], bool bDeriv=false)

void	eval_deriv (LocalVectorTimeSeries u, GridObject elem, const MathVector< dim > vCornerCoords[], bool bDeriv=false)

TImpl &	getImpl ()

const TImpl &	getImpl () const

virtual void	global_ips_changed (const size_t seriesID, const MathVector< dim > *vPos, const size_t numIP)

size_t	input_common_fct (size_t i, size_t fct) const

size_t	input_num_fct (size_t i) const

virtual void	local_ip_series_added (const size_t seriesID)

virtual void	local_ips_changed (const size_t seriesID, const size_t newNumIP)

size_t	series_id (size_t i, size_t s) const

Protected Member Functions inherited from StdUserData< StdDataLinker< TImpl, TData, dim >, TData, dim, void, DependentUserData< TData, dim > >
StdDataLinker< TImpl, TData, dim > &	getImpl ()

const StdDataLinker< TImpl, TData, dim > &	getImpl () const

Protected Member Functions inherited from ug::DependentUserData< class, dim >
void	check_s_ip (size_t s, size_t ip) const

void	check_s_ip_fct (size_t s, size_t ip, size_t fct) const

void	check_s_ip_fct_dof (size_t s, size_t ip, size_t fct, size_t dof) const

void	extract_fct_grp ()

virtual void	local_ip_series_to_be_cleared ()

void	resize_deriv_array ()

void	resize_deriv_array (const size_t seriesID)

Protected Member Functions inherited from ug::CplUserData< class, dim, class >
void	call_storage_callback () const

void	check_series (size_t s) const

void	check_series_ip (size_t s, size_t ip) const

virtual void	value_storage_changed (const size_t seriesID)

Protected Member Functions inherited from ug::ICplUserData< dim >
void	check_s (size_t s) const

void	check_s_ip (size_t s, size_t ip) const

std::vector< const MathVector< 1 > * > &	get_local_ips (Int2Type< 1 >)

const std::vector< const MathVector< 1 > * > &	get_local_ips (Int2Type< 1 >) const

std::vector< const MathVector< 2 > * > &	get_local_ips (Int2Type< 2 >)

const std::vector< const MathVector< 2 > * > &	get_local_ips (Int2Type< 2 >) const

std::vector< const MathVector< 3 > * > &	get_local_ips (Int2Type< 3 >)

const std::vector< const MathVector< 3 > * > &	get_local_ips (Int2Type< 3 >) const

Protected Attributes inherited from ug::Richards::RichardsLinker< dim, vanGenuchtenSaturationAdapter >
TModel	m_model

Protected Attributes inherited from ug::StdDataLinker< class, class, dim >
std::vector< FunctionIndexMapping >	m_vMap

std::vector< SmartPtr< ICplUserData< dim > > >	m_vspICplUserData

std::vector< SmartPtr< UserDataInfo > >	m_vspUserDataInfo

std::vector< std::vector< size_t > >	m_vvSeriesID

Protected Attributes inherited from ug::DependentUserData< class, dim >
std::vector< std::string >	m_SymbFct

std::vector< size_t >	m_vvNumDoFPerFct

std::vector< std::vector< std::vector< std::vector< TData > > > >	m_vvvvDeriv

Protected Attributes inherited from ug::ICplUserData< dim >
int	m_defaultTimePoint

int	m_locPosDim

std::vector< const MathVector< 1 > * >	m_pvLocIP1d

std::vector< const MathVector< 2 > * >	m_pvLocIP2d

std::vector< const MathVector< 3 > * >	m_pvLocIP3d

int	m_si

size_t	m_timePoint

std::vector< bool >	m_vMayChange

std::vector< size_t >	m_vNumIP

std::vector< number >	m_vTime

std::vector< int >	m_vTimePoint

std::vector< const MathVector< dim > * >	m_vvGlobPos

Protected Attributes inherited from ug::UserDataInfo
FunctionGroup	m_fctGrp

FunctionIndexMapping	m_map

SmartPtr< char >	m_objName

Detailed Description

template<int dim>
struct ug::Richards::RichardsSaturation< dim >

van Genuchten classes. (ideally, those could be type-def'ed as well..)

Member Typedef Documentation

◆ base_type

template<int dim>

typedef RichardsLinker<dim,vanGenuchtenSaturationAdapter> ug::Richards::RichardsSaturation< dim >::base_type

Constructor & Destructor Documentation

◆ RichardsSaturation()

template<int dim>

ug::Richards::RichardsSaturation< dim >::RichardsSaturation ( const typename base_type::TModel & model )

inline

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

/home/runner/work/docs/docs/ug4/plugins/Richards/richards_linker.h

Public Types

Public Member Functions