#include <std_user_data.h>

Inheritance diagram for ug::StdDependentUserData< TImpl, TData, dim >:

Public Member Functions
virtual void	compute (LocalVector u, GridObject elem, const MathVector< dim > vCornerCoords[], bool bDeriv=false)
	compute values (and derivatives iff compDeriv == true)

virtual void	compute (LocalVectorTimeSeries u, GridObject elem, const MathVector< dim > vCornerCoords[], bool bDeriv=false)
	compute values (and derivatives iff compDeriv == true, but only for the 'current' time point)

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

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

template<int refDim>
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 void	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 value for global positions

	StdDependentUserData ()

	StdDependentUserData (const char *symbFct)

	StdDependentUserData (const std::string &symbFct)

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

Public Member Functions inherited from ug::StdUserData< StdDependentUserData< 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< 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

Public Member Functions inherited from ug::DependentUserData< TData, dim >
	DependentUserData ()
	default constructor

TData *	deriv (size_t s, size_t ip, size_t fct)
	returns the derivatives of the local function, at ip

const TData *	deriv (size_t s, size_t ip, size_t fct) const
	returns the derivatives of the local function, at ip

TData &	deriv (size_t s, size_t ip, size_t fct, size_t dof)
	returns the derivative of the local function, at ip and for a dof

const TData &	deriv (size_t s, size_t ip, size_t fct, size_t dof) const
	returns the derivative of the local function, at ip and for a dof

size_t	num_ip (size_t s) const
	returns the number of integration points

size_t	num_series () const
	explicitly forward some functions

size_t	num_sh (size_t fct) const
	number of shapes for local function

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

virtual void	set_function_pattern (ConstSmartPtr< FunctionPattern > fctPatt)
	sets the associated function pattern

virtual void	update_dof_sizes (const LocalIndices &ind)
	resize lin defect arrays

virtual bool	zero_derivative () const
	returns that data depends on solution

	DependentUserData (const char *symbFct)

	DependentUserData (const std::string &symbFct)

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

void	set_functions (const char *symbFct)

void	set_functions (const std::string &symbFct)

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

Public Member Functions inherited from ug::CplUserData< TData, dim, TRet >
bool	defined (size_t s, size_t ip) const
	returns flag, if data is evaluated (for conditional data)

size_t	num_ip (size_t s) const
	returns the number of integration points

size_t	num_series () const
	explicitly forward some functions

void	register_storage_callback (DataImport< TData, dim > obj, void(DataImport< TData, dim >::func)())
	register external callback, invoked when data storage changed

void	unregister_storage_callback (DataImport< TData, dim > *obj)
	register all callbacks registered by class

TData &	value (size_t s, size_t ip)
	returns the value at ip

const TData &	value (size_t s, size_t ip) const
	returns the value at ip

TData *	values (size_t s)
	returns all values for a series

const TData *	values (size_t s) const
	returns all values for a series

	~CplUserData ()
	destructor

Public Member Functions inherited from ug::ICplUserData< dim >
bool	at_current_time (size_t s) const
	returns true iff the time point specification is equal to the current one, or not specified

virtual void	check_setup () const
	returns if the dependent data is ready for evaluation

void	clear ()
	clear all data

virtual bool	constant () const
	returns if data is constant

int	dim_local_ips () const
	returns current local ip dimension

	ICplUserData ()
	default constructor

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

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

template<int ldim>
const MathVector< ldim > &	local_ip (size_t s, size_t ip) const
	returns local ip

template<int ldim>
const MathVector< ldim > *	local_ips (size_t s) const
	returns local ips

virtual SmartPtr< ICplUserData >	needed_data (size_t i)
	return needed data

size_t	num_ip (size_t s) const
	returns the number of integration points

virtual size_t	num_needed_data () const
	number of other Data this data depends on

size_t	num_series () const
	returns the number of ip series

template<int ldim>
size_t	register_local_ip_series (const MathVector< ldim > *vPos, const size_t numIP, bool bMayChange=true)
	set local positions without the specification of the time point, returns series id

template<int ldim>
size_t	register_local_ip_series (const MathVector< ldim > *vPos, const size_t numIP, const int timePointSpec, bool bMayChange=true)
	set local positions, returns series id

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

template<int ldim>
void	set_local_ips (const size_t seriesId, const MathVector< ldim > *vPos, const size_t numIP)
	sets new local ip positions for a local ip series

void	set_subset (int si)
	set the subset of evaluation

void	set_time_point (const size_t seriesId, const int timePointSpec)
	sets a new time point for a local ip series

void	set_time_point (size_t timePoint)
	sets the current time point

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

int	subset () const
	returns the subset of evaluation

number	time () const
	get the current evaluation time

number	time (size_t s) const
	get the specified evaluation time

size_t	time_point ()
	returns the current time point

size_t	time_point (size_t s) const
	returns the time point specification (in particular, the current one, if the own one not specified)

int	time_point_specification (size_t s) const
	returns the time point specification (note: it may be -1, i.e. not specified)

virtual	~ICplUserData ()
	virtual desctructor

Public Member Functions inherited from ug::UserDataInfo
const FunctionGroup &	function_group () const
	Function Group of functions.

const FunctionIndexMapping &	map () const
	get function mapping

size_t	num_fct () const
	number of functions this export depends on

const char *	obj_name ()
	gets the name of the object (s. the field m_objName)

void	set_obj_name (const char *name)
	sets the name of the object (s. the field m_objName)

virtual	~UserDataInfo ()
	virtual destructor

Public Member Functions inherited from ug::UserData< TData, dim, TRet >
virtual bool	continuous () const =0
	returns if provided data is continuous over geometric object boundaries

int	get_dim () const
	returns dimension

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

std::string	type () const
	returns type of data as string (e.g. "Number", "Vector", "Matrix")

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< 3 > &locIP, LocalVector u) const

Protected Member Functions
TImpl &	getImpl ()
	access to implementation

const TImpl &	getImpl () const
	const access to implementation

Protected Member Functions inherited from ug::StdUserData< StdDependentUserData< TImpl, TData, dim >, TData, dim, void, DependentUserData< TData, dim > >
StdDependentUserData< TImpl, TData, dim > &	getImpl ()
	access to implementation

const StdDependentUserData< TImpl, TData, dim > &	getImpl () const
	const access to implementation

Protected Member Functions inherited from ug::DependentUserData< TData, dim >
void	check_s_ip (size_t s, size_t ip) const
	checks in debug mode the correct usage of indices

void	check_s_ip_fct (size_t s, size_t ip, size_t fct) const
	checks in debug mode the correct usage of indices

void	check_s_ip_fct_dof (size_t s, size_t ip, size_t fct, size_t dof) const
	checks in debug mode the correct usage of indices

void	extract_fct_grp ()
	extracts the function group

virtual void	local_ip_series_added (const size_t seriesID)
	resizes the derivative field when local ip change is signaled

virtual void	local_ip_series_to_be_cleared ()
	implement callback, invoked when local ips are cleared

virtual void	local_ips_changed (const size_t seriesID, const size_t newNumIP)
	implement callback, called when local IPs changed

void	resize_deriv_array ()
	resizes the derivative arrays for current number of ips.

void	resize_deriv_array (const size_t seriesID)
	resizes the derivative arrays for current number of ips of a single series

Protected Member Functions inherited from ug::CplUserData< TData, dim, TRet >
void	call_storage_callback () const
	calls are registered external storage callbacks

void	check_series (size_t s) const
	checks in debug mode the correct index

void	check_series_ip (size_t s, size_t ip) const
	checks in debug mode the correct index

virtual void	value_storage_changed (const size_t seriesID)
	callback, invoked when storage of data has changed for a series

Protected Member Functions inherited from ug::ICplUserData< dim >
void	check_s (size_t s) const
	checks in debug mode the correct usage of indices

void	check_s_ip (size_t s, size_t ip) const
	checks in debug mode the correct usage of indices

std::vector< const MathVector< 1 > * > &	get_local_ips (Int2Type< 1 >)
	help function to get local ips

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

virtual void	global_ips_changed (const size_t seriesID, const MathVector< dim > *vPos, const size_t numIP)
	callback invoked after global ips have been changed

Additional Inherited Members
Public Types inherited from ug::DependentUserData< TData, dim >
typedef CplUserData< TData, dim >	base_type
	Base class type.

Public Types inherited from ug::CplUserData< TData, dim, TRet >
typedef ICplUserData< dim >	base_type
	type of base class

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

typedef TRet	return_type

Static Public Member Functions inherited from ug::DependentUserData< TData, dim >
static void	set_zero (std::vector< std::vector< TData > > vvvDeriv[], const size_t nip)
	sets all derivative values to zero

Protected Attributes inherited from ug::DependentUserData< TData, dim >
std::vector< std::string >	m_SymbFct
	string of symbolic functions required

std::vector< size_t >	m_vvNumDoFPerFct
	number of functions and their dofs

std::vector< std::vector< std::vector< std::vector< TData > > > >	m_vvvvDeriv
	Derivatives.

Protected Attributes inherited from ug::ICplUserData< dim >
int	m_defaultTimePoint
	default time point (or -1 if not specified)

int	m_locPosDim
	dimension of local position (-1 indicates no dim set)

std::vector< const MathVector< 1 > * >	m_pvLocIP1d
	local ips of dimension 1d-3d

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

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

int	m_si
	subset for evaluation

size_t	m_timePoint
	current time point (used if no explicit specification for series)

std::vector< bool >	m_vMayChange
	flags if local ips may change

std::vector< size_t >	m_vNumIP
	number of evaluation points (-1 indicates no ips set)

std::vector< number >	m_vTime
	time for evaluation

std::vector< int >	m_vTimePoint
	time points for the series

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

Protected Attributes inherited from ug::UserDataInfo
FunctionGroup	m_fctGrp
	functions the data depends on

FunctionIndexMapping	m_map
	Mapping for import fct.

SmartPtr< char >	m_objName
	This field is used mainly for debugging: One can assign a name to the object to identify it when running.

Constructor & Destructor Documentation

◆ StdDependentUserData() [1/4]

template<typename TImpl , typename TData , int dim>

ug::StdDependentUserData< TImpl, TData, dim >::StdDependentUserData ( )

inline

◆ StdDependentUserData() [2/4]

template<typename TImpl , typename TData , int dim>

ug::StdDependentUserData< TImpl, TData, dim >::StdDependentUserData ( const char * symbFct )

inline

References ug::DependentUserData< TData, dim >::set_functions().

◆ StdDependentUserData() [3/4]

template<typename TImpl , typename TData , int dim>

ug::StdDependentUserData< TImpl, TData, dim >::StdDependentUserData ( const std::string & symbFct )

inline

References ug::DependentUserData< TData, dim >::set_functions().

◆ StdDependentUserData() [4/4]

template<typename TImpl , typename TData , int dim>

ug::StdDependentUserData< TImpl, TData, dim >::StdDependentUserData ( const std::vector< std::string > & symbFct )

inline

References ug::DependentUserData< TData, dim >::set_functions().

Member Function Documentation

◆ compute() [1/2]

template<typename TImpl , typename TData , int dim>

virtual void ug::StdDependentUserData< TImpl, TData, dim >::compute	(	LocalVector *	u,
		GridObject *	elem,
		const MathVector< dim >	vCornerCoords[],
		bool	bDeriv = `false`
	)

inlinevirtual

compute values (and derivatives iff compDeriv == true)

Implements ug::ICplUserData< dim >.

References ug::GridObject::base_object_id(), ug::ICplUserData< dim >::dim_local_ips(), UG_ASSERT, and UG_THROW.

◆ compute() [2/2]

template<typename TImpl , typename TData , int dim>

virtual void ug::StdDependentUserData< TImpl, TData, dim >::compute	(	LocalVectorTimeSeries *	u,
		GridObject *	elem,
		const MathVector< dim >	vCornerCoords[],
		bool	bDeriv = `false`
	)

inlinevirtual

compute values (and derivatives iff compDeriv == true, but only for the 'current' time point)

Implements ug::ICplUserData< dim >.

References ug::GridObject::base_object_id(), ug::ICplUserData< dim >::dim_local_ips(), UG_ASSERT, and UG_THROW.

◆ eval_deriv() [1/2]

template<typename TImpl , typename TData , int dim>

template<int refDim>

void ug::StdDependentUserData< TImpl, TData, dim >::eval_deriv	(	LocalVector *	u,
		GridObject *	elem,
		const MathVector< dim >	vCornerCoords[],
		bool	bDeriv = `false`
	)

inline

References ug::StdDependentUserData< TImpl, TData, dim >::getImpl(), ug::ICplUserData< dim >::ips(), ug::DependentUserData< TData, dim >::m_vvvvDeriv, ug::DependentUserData< TData, dim >::num_ip(), ug::DependentUserData< TData, dim >::num_series(), s, ug::ICplUserData< dim >::subset(), ug::ICplUserData< dim >::time(), and ug::CplUserData< TData, dim, TRet >::values().

◆ eval_deriv() [2/2]

template<typename TImpl , typename TData , int dim>

template<int refDim>

void ug::StdDependentUserData< TImpl, TData, dim >::eval_deriv	(	LocalVectorTimeSeries *	u,
		GridObject *	elem,
		const MathVector< dim >	vCornerCoords[],
		bool	bDeriv = `false`
	)

inline

References ug::ICplUserData< dim >::at_current_time(), ug::StdDependentUserData< TImpl, TData, dim >::getImpl(), ug::ICplUserData< dim >::ips(), ug::DependentUserData< TData, dim >::m_vvvvDeriv, ug::DependentUserData< TData, dim >::num_ip(), ug::DependentUserData< TData, dim >::num_series(), s, ug::LocalVectorTimeSeries::solution(), ug::ICplUserData< dim >::subset(), ug::ICplUserData< dim >::time(), and ug::CplUserData< TData, dim, TRet >::values().

◆ evaluate()

template<typename TImpl , typename TData , int dim>

template<int refDim>

void ug::StdDependentUserData< TImpl, TData, dim >::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

inline

References ug::ICplUserData< dim >::time().

◆ getImpl() [1/2]

template<typename TImpl , typename TData , int dim>

TImpl & ug::StdDependentUserData< TImpl, TData, dim >::getImpl ( )

inlineprotected

access to implementation

Referenced by ug::StdDependentUserData< TImpl, TData, dim >::eval_deriv(), and ug::StdDependentUserData< TImpl, TData, dim >::eval_deriv().

◆ getImpl() [2/2]

template<typename TImpl , typename TData , int dim>

const TImpl & ug::StdDependentUserData< TImpl, TData, dim >::getImpl ( ) const

inlineprotected

const access to implementation

◆ operator()() [1/2]

template<typename TImpl , typename TData , int dim>

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

inlinevirtual

returns value for a global position

Implements ug::StdUserData< StdDependentUserData< TImpl, TData, dim >, TData, dim, void, DependentUserData< TData, dim > >.

References UG_THROW.

◆ operator()() [2/2]

template<typename TImpl , typename TData , int dim>

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

inlinevirtual

returns value for global positions

Implements ug::StdUserData< StdDependentUserData< TImpl, TData, dim >, TData, dim, void, DependentUserData< TData, dim > >.

References UG_THROW.

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

ugbase/lib_disc/spatial_disc/user_data/std_user_data.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ StdDependentUserData() [1/4]

◆ StdDependentUserData() [2/4]

◆ StdDependentUserData() [3/4]

◆ StdDependentUserData() [4/4]

Member Function Documentation

◆ compute() [1/2]

◆ compute() [2/2]

◆ eval_deriv() [1/2]

◆ eval_deriv() [2/2]

◆ evaluate()

◆ getImpl() [1/2]

◆ getImpl() [2/2]

◆ operator()() [1/2]

◆ operator()() [2/2]