User data of a subset indicator (1 in the subset, 0 everywhere else) More...

#include <subset_indicator_user_data.h>

Inheritance diagram for ug::SubsetIndicatorUserData< TDomain >:

Public Types
typedef TDomain	domain_type
	Type of domain.

typedef domain_type::subset_handler_type	subset_handler_type
	subset handler type

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

typedef void	return_type

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.

	SubsetIndicatorUserData (ConstSmartPtr< domain_type > domain, const char *ss_names)
	Constructor.

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

Static Public Attributes
static const int	dim = domain_type::dim
	World dimension.

Private Attributes
SubsetGroup	m_ssGrp
	subset group representing the specified subdomain

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

const SubsetIndicatorUserData< 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::SubsetIndicatorUserData< TDomain >

User data of a subset indicator (1 in the subset, 0 everywhere else)

User data based class for the indicator function. The subset names specified in the constructor define a subdomain \( S \) of the whole domain \( \Omega \). This user data class computes the indicator function that is \( 1 \) in \( S \) and zero in \( \Omega \setminus S \).

Member Typedef Documentation

◆ domain_type

template<typename TDomain >

typedef TDomain ug::SubsetIndicatorUserData< TDomain >::domain_type

Type of domain.

◆ subset_handler_type

template<typename TDomain >

typedef domain_type::subset_handler_type ug::SubsetIndicatorUserData< TDomain >::subset_handler_type

subset handler type

Constructor & Destructor Documentation

◆ SubsetIndicatorUserData()

template<typename TDomain >

ug::SubsetIndicatorUserData< TDomain >::SubsetIndicatorUserData	(	ConstSmartPtr< domain_type >	domain,
		const char *	ss_names
	)

inline

Constructor.

Parameters

domain	domain of the problem
ss_names	subset names

References ug::SubsetGroup::add(), ug::SubsetGroup::clear(), ug::SubsetIndicatorUserData< TDomain >::m_ssGrp, ug::RemoveWhitespaceFromString(), ug::TokenizeString(), and UG_CATCH_THROW.

Member Function Documentation

◆ continuous()

template<typename TDomain >

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

inlinevirtual

Indicator functions are discontinuous.

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

◆ evaluate()

template<typename TDomain >

template<int refDim>

void ug::SubsetIndicatorUserData< 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

inline

Evaluator.

References ug::SubsetGroup::contains(), ug::SubsetIndicatorUserData< TDomain >::m_ssGrp, and ug::SubsetGroup::subset_handler().

◆ operator()() [1/2]

template<typename TDomain >

void ug::SubsetIndicatorUserData< TDomain >::operator()	(	number &	vValue,
		const MathVector< dim > &	globIP,
		number	time,
		int	si
	)		const

inlinevirtual

This function should not be used.

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

References ug::SubsetGroup::contains(), and ug::SubsetIndicatorUserData< TDomain >::m_ssGrp.

◆ operator()() [2/2]

template<typename TDomain >

void ug::SubsetIndicatorUserData< TDomain >::operator()	(	number	vValue[],
		const MathVector< dim >	vGlobIP[],
		number	time,
		int	si,
		const size_t	nip
	)		const

inlinevirtual

This function should not be used.

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

References ug::SubsetGroup::contains(), and ug::SubsetIndicatorUserData< TDomain >::m_ssGrp.

◆ requires_grid_fct()

template<typename TDomain >

virtual bool ug::SubsetIndicatorUserData< TDomain >::requires_grid_fct ( ) const

inlinevirtual

Returns true to get the grid element in the evaluation routine.

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

Member Data Documentation

◆ dim

template<typename TDomain >

const int ug::SubsetIndicatorUserData< TDomain >::dim = domain_type::dim

static

World dimension.

◆ m_ssGrp

template<typename TDomain >

SubsetGroup ug::SubsetIndicatorUserData< TDomain >::m_ssGrp

private

subset group representing the specified subdomain

Referenced by ug::SubsetIndicatorUserData< TDomain >::evaluate(), ug::SubsetIndicatorUserData< TDomain >::operator()(), ug::SubsetIndicatorUserData< TDomain >::operator()(), and ug::SubsetIndicatorUserData< TDomain >::SubsetIndicatorUserData().

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

ugbase/lib_disc/spatial_disc/user_data/common_user_data/subset_indicator_user_data.h

Public Types

Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ domain_type

◆ subset_handler_type

Constructor & Destructor Documentation

◆ SubsetIndicatorUserData()

Member Function Documentation

◆ continuous()

◆ evaluate()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ requires_grid_fct()

Member Data Documentation

◆ dim

◆ m_ssGrp