#include <richards_linker.h>

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

Public Types
typedef MathVector< dim >	math_vector_type

typedef number	TData

typedef bool	TRet

typedef UserData< MathVector< dim >, dim >	TVectorData

typedef UserData< number, dim, bool >	user_data_base_type

Public Types inherited from ug::UserData< number, dim, bool >
typedef TData	data_type

typedef TRet	return_type

Public Member Functions
bool	continuous () const
	returns if provided data is continuous over geometric object boundaries

	OnSurfaceCondition (SmartPtr< TVectorData > spFlux)

virtual TRet	operator() (TData &value, const MathVector< dim > &globIP, number time, int si) const
	returns value for a global position

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

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< 3 > vLocIP[], const size_t nip, LocalVector u, const MathMatrix< 3, dim > *vJT=NULL) const

bool	requires_grid_fct () const
	returns if grid function is needed for evaluation

virtual	~OnSurfaceCondition ()

Public Member Functions inherited from ug::UserData< number, dim, bool >
int	get_dim () const

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

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

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

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

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

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

TRet	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

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

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 =0

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 =0

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 =0

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 =0

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 =0

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 =0

std::string	type () const

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

virtual void	set_function_pattern (ConstSmartPtr< FunctionPattern > fctPatt)

void	set_obj_name (const char *name)

virtual	~UserDataInfo ()

Protected Attributes
SmartPtr< TVectorData >	m_spFlux

Protected Attributes inherited from ug::UserDataInfo
FunctionGroup	m_fctGrp

FunctionIndexMapping	m_map

SmartPtr< char >	m_objName

Member Typedef Documentation

◆ math_vector_type

template<int dim>

typedef MathVector<dim> ug::Richards::OnSurfaceCondition< dim >::math_vector_type

◆ TData

template<int dim>

typedef number ug::Richards::OnSurfaceCondition< dim >::TData

◆ TRet

template<int dim>

typedef bool ug::Richards::OnSurfaceCondition< dim >::TRet

◆ TVectorData

template<int dim>

typedef UserData<MathVector<dim>, dim> ug::Richards::OnSurfaceCondition< dim >::TVectorData

◆ user_data_base_type

template<int dim>

typedef UserData<number, dim, bool> ug::Richards::OnSurfaceCondition< dim >::user_data_base_type

Constructor & Destructor Documentation

◆ OnSurfaceCondition()

template<int dim>

ug::Richards::OnSurfaceCondition< dim >::OnSurfaceCondition ( SmartPtr< TVectorData > spFlux )

inline

◆ ~OnSurfaceCondition()

template<int dim>

virtual ug::Richards::OnSurfaceCondition< dim >::~OnSurfaceCondition ( )

inlinevirtual

Member Function Documentation

◆ continuous()

template<int dim>

bool ug::Richards::OnSurfaceCondition< dim >::continuous ( ) const

inlinevirtual

returns if provided data is continuous over geometric object boundaries

Implements ug::UserData< number, dim, bool >.

◆ operator()() [1/5]

template<int dim>

virtual TRet ug::Richards::OnSurfaceCondition< dim >::operator()	(	TData &	value,
		const MathVector< dim > &	globIP,
		number	time,
		int	si
	)		const

inlinevirtual

returns value for a global position

References ug::Richards::OnSurfaceCondition< dim >::m_spFlux.

◆ operator()() [2/5]

template<int dim>

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

inlinevirtual

returns values for global positions

◆ operator()() [3/5]

template<int dim>

virtual void ug::Richards::OnSurfaceCondition< dim >::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

inlinevirtual

◆ operator()() [4/5]

template<int dim>

virtual void ug::Richards::OnSurfaceCondition< dim >::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

inlinevirtual

◆ operator()() [5/5]

template<int dim>

virtual void ug::Richards::OnSurfaceCondition< dim >::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

inlinevirtual

◆ requires_grid_fct()

template<int dim>

bool ug::Richards::OnSurfaceCondition< dim >::requires_grid_fct ( ) const

inlinevirtual

returns if grid function is needed for evaluation

Implements ug::UserData< number, dim, bool >.

Member Data Documentation

◆ m_spFlux

template<int dim>

SmartPtr<TVectorData> ug::Richards::OnSurfaceCondition< dim >::m_spFlux

protected

Referenced by ug::Richards::OnSurfaceCondition< dim >::operator()().

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

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

Public Types

Public Member Functions

Protected Attributes

Member Typedef Documentation

◆ math_vector_type

◆ TData

◆ TRet

◆ TVectorData

◆ user_data_base_type

Constructor & Destructor Documentation

◆ OnSurfaceCondition()

◆ ~OnSurfaceCondition()

Member Function Documentation

◆ continuous()

◆ operator()() [1/5]

◆ operator()() [2/5]

◆ operator()() [3/5]

◆ operator()() [4/5]

◆ operator()() [5/5]

◆ requires_grid_fct()

Member Data Documentation

◆ m_spFlux