Scaled projection to the outer normal for a given vector user data. More...

#include <dim_dim_user_data.h>

Inheritance diagram for ug::ScaledOutNormCmp< TDomain >:

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

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

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

void	operator() (vec_type 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.

	ScaledOutNormCmp (SmartPtr< domain_type > spDomain, SmartPtr< UserData< number, dim, void > > spScalData, SmartPtr< UserData< vec_type, dim, void > > spVecData)
	constructor

	ScaledOutNormCmp (SmartPtr< domain_type > spDomain, SmartPtr< UserData< number, dim, void > > spScalData, SmartPtr< UserData< vec_type, dim, void > > spVecData, const char *ss_names)
	constructor

Public Member Functions inherited from ug::StdUserData< ScaledOutNormCmp< TDomain >, MathVector< TDomain::dim >, TDomain::dim, void, UserData< MathVector< TDomain::dim >, TDomain::dim, void > >
virtual void	operator() (MathVector< TDomain::dim > &value, const MathVector< dim > &globIP, number time, int si) const=0
	returns value for a global position

virtual void	operator() (MathVector< TDomain::dim > vValue[], const MathVector< dim > vGlobIP[], number time, int si, const size_t nip) const=0
	returns value for global positions

virtual void	operator() (MathVector< TDomain::dim > 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() (MathVector< TDomain::dim > 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() (MathVector< TDomain::dim > 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< MathVector< TDomain::dim >, TDomain::dim, void >
int	get_dim () const
	returns dimension

virtual void	operator() (MathVector< TDomain::dim > &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() (MathVector< TDomain::dim > &value, const MathVector< dim > &globIP, number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 1 > &locIP, LocalVector u) const

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

void	operator() (MathVector< TDomain::dim > &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

typedef MathVector< dim >	vec_type
	the original data type

Private Attributes
SmartPtr< domain_type >	m_spDomain
	the domain

SmartPtr< UserData< number, dim, void > >	m_spScalData
	the scaling data

SmartPtr< UserData< vec_type, dim, void > >	m_spVecData
	the original vector field data

SubsetGroup	m_ssGrp
	the subset group for the inner part

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

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

typedef void	return_type

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

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

Scaled projection to the outer normal for a given vector user data.

This class implements the UserData for evaluation of the normal component of vectors computed by the other user data object. The normal component is evaluation only for WDim-1-dimensional subsets - sides of WDim-dimensional elements. It is scaled by a furthe (scalar) UserData.

ToDo: Note that the LocalVector provided for the evaluate function is not properly used. Thus, the passed UserData objects should not use it.

Member Typedef Documentation

◆ domain_type

template<typename TDomain >

typedef TDomain ug::ScaledOutNormCmp< TDomain >::domain_type

private

the domain type

◆ grid_type

template<typename TDomain >

typedef TDomain::grid_type ug::ScaledOutNormCmp< TDomain >::grid_type

private

the grid type

◆ vec_type

template<typename TDomain >

typedef MathVector<dim> ug::ScaledOutNormCmp< TDomain >::vec_type

private

the original data type

Constructor & Destructor Documentation

◆ ScaledOutNormCmp() [1/2]

template<typename TDomain >

ug::ScaledOutNormCmp< TDomain >::ScaledOutNormCmp	(	SmartPtr< domain_type >	spDomain,
		SmartPtr< UserData< number, dim, void > >	spScalData,
		SmartPtr< UserData< vec_type, dim, void > >	spVecData,
		const char *	ss_names
	)

inline

constructor

Parameters

spDomain	the domain
spScalData	the scaling data
spVecData	the original vector field data
ss_names	the subsets

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

◆ ScaledOutNormCmp() [2/2]

template<typename TDomain >

ug::ScaledOutNormCmp< TDomain >::ScaledOutNormCmp	(	SmartPtr< domain_type >	spDomain,
		SmartPtr< UserData< number, dim, void > >	spScalData,
		SmartPtr< UserData< vec_type, dim, void > >	spVecData
	)

inline

constructor

Parameters

spDomain	the domain
spScalData	the scaling data
spVecData	the original vector field data

Member Function Documentation

◆ continuous()

template<typename TDomain >

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

inlinevirtual

Indicator functions are discontinuous.

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

◆ evaluate()

template<typename TDomain >

template<int refDim>

void ug::ScaledOutNormCmp< TDomain >::evaluate	(	vec_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