"Heaviside step function" based on the value of values of a further userdata More...

#include <subset_indicator_user_data.h>

Inheritance diagram for ug::ValueIndicatorUserData< TDomain >:

Public Member Functions
virtual bool	continuous () const
	Indicator functions are discontinuous.

template<int refDim>
void	evaluate (number 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
	Evaluator.

void	operator() (number &vValue, const MathVector< dim > &globIP, number time, int si) const
	This function should not be used.

void	operator() (number vValue[], const MathVector< dim > vGlobIP[], number time, int si, const size_t nip) const
	This function should not be used.

virtual bool	requires_grid_fct () const
	Returns true to get the grid element in the evaluation routine.

	ValueIndicatorUserData (SmartPtr< UserData< number, dim, void > > spData, number threshold, bool greater)
	constructor

Public Member Functions inherited from ug::StdUserData< ValueIndicatorUserData< TDomain >, number, TDomain::dim, void, UserData< number, TDomain::dim, void > >
virtual void	operator() (number 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() (number 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() (number 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::UserData< number, TDomain::dim, void >
int	get_dim () const
	returns dimension

virtual void	operator() (number &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")

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

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

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

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)

virtual void	set_function_pattern (ConstSmartPtr< FunctionPattern > fctPatt)
	sets the function pattern for a possibly needed grid function

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

virtual	~UserDataInfo ()
	virtual destructor

Private Types
typedef TDomain	domain_type
	the domain type

typedef TDomain::grid_type	grid_type
	the grid type

Private Member Functions
void	reset_values (number vValue[], const size_t nip) const

Private Attributes
bool	m_greater
	if less or greater

SmartPtr< UserData< number, dim, void > >	m_spData
	the original data

number	m_threshold
	the threshold value

Static Private Attributes
static const int	dim = TDomain::dim
	the world dimension

Additional Inherited Members
Public Types inherited from ug::UserData< number, TDomain::dim, void >
typedef number	data_type

typedef void	return_type

Protected Member Functions inherited from ug::StdUserData< ValueIndicatorUserData< TDomain >, number, TDomain::dim, void, UserData< number, TDomain::dim, void > >
ValueIndicatorUserData< TDomain > &	getImpl ()
	access to implementation

const ValueIndicatorUserData< TDomain > &	getImpl () const
	const access to implementation

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.

Detailed Description

template<typename TDomain>
class ug::ValueIndicatorUserData< TDomain >

"Heaviside step function" based on the value of values of a further userdata

This class implements the UserData that returns 1 if the given user data is greater/less or equal than a given value.

Member Typedef Documentation

◆ domain_type

template<typename TDomain >

typedef TDomain ug::ValueIndicatorUserData< TDomain >::domain_type

private

the domain type

◆ grid_type

template<typename TDomain >

typedef TDomain::grid_type ug::ValueIndicatorUserData< TDomain >::grid_type

private

the grid type

Constructor & Destructor Documentation

◆ ValueIndicatorUserData()

template<typename TDomain >

ug::ValueIndicatorUserData< TDomain >::ValueIndicatorUserData	(	SmartPtr< UserData< number, dim, void > >	spData,
		number	threshold,
		bool	greater
	)

inline

constructor

Parameters

spData	the original data
threshold	the threshold value
greater	if greater or less

References ug::ValueIndicatorUserData< TDomain >::m_spData, and UG_THROW.

Member Function Documentation

◆ continuous()

template<typename TDomain >

virtual bool ug::ValueIndicatorUserData< TDomain >::continuous ( ) const

inlinevirtual

Indicator functions are discontinuous.

Implements ug::UserData< number, TDomain::dim, void >.

References ug::ValueIndicatorUserData< TDomain >::m_spData.

◆ evaluate()

template<typename TDomain >

template<int refDim>

void ug::ValueIndicatorUserData< TDomain >::evaluate	(	number	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