#include <level_set_ave_data.h>

Inheritance diagram for ug::LevelSet::LSAveData< TGridFunction >:

Public Types
typedef gf_type::algebra_type	algebra_type
	algebra type

typedef StdDependentUserData< this_type, number, dim >	base_type
	the base type

typedef gf_type::domain_type	domain_type
	domain type

typedef IInterfaceExtrapolation< domain_type, algebra_type >	extrapol_type
	extrapolation type

typedef TGridFunction	gf_type
	type of the grid function

typedef LSAveData< gf_type >	this_type
	this type

Public Types inherited from ug::CplUserData< typename TData, int dim, typename TRet >
typedef ICplUserData< dim >	base_type

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

typedef TRet	return_type

Public Member Functions
virtual bool	continuous () const
	These are element-based data, they are not continuous.

template<int refDim>
void	eval_and_deriv (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, bool bDeriv, int s, std::vector< std::vector< number > > vvvDeriv[], const MathMatrix< refDim, dim > *vJT=NULL)
	Performs the main computations:

	LSAveData (SmartPtr< gf_type > sp_gf, const char *fct_name)
	Constructor.

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

void	set_extrapolation (SmartPtr< extrapol_type > sp_extrapol)
	Set the extrapolation (if any)

virtual	~LSAveData ()
	Destructor.

Public Member Functions inherited from ug::StdDependentUserData< LSAveData< TGridFunction >, number, TGridFunction::dim >
virtual void	compute (LocalVector u, GridObject elem, const MathVector< dim > vCornerCoords[], bool bDeriv=false)

virtual void	compute (LocalVectorTimeSeries u, GridObject elem, const MathVector< dim > vCornerCoords[], bool bDeriv=false)

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

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

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

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

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

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::CplUserData< typename TData, int dim, typename TRet >
bool	defined (size_t s, size_t ip) const

size_t	num_ip (size_t s) const

size_t	num_series () const

void	register_storage_callback (DataImport< TData, dim > obj, void(DataImport< TData, dim >::func)())

void	unregister_storage_callback (DataImport< TData, dim > *obj)

TData &	value (size_t s, size_t ip)

const TData &	value (size_t s, size_t ip) const

TData *	values (size_t s)

const TData *	values (size_t s) const

	~CplUserData ()

Public Member Functions inherited from ug::ICplUserData< int dim >
bool	at_current_time (size_t s) const

virtual void	check_setup () const

void	clear ()

virtual bool	constant () const

int	dim_local_ips () const

	ICplUserData ()

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

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

const MathVector< ldim > &	local_ip (size_t s, size_t ip) const

const MathVector< ldim > *	local_ips (size_t s) const

virtual SmartPtr< ICplUserData >	needed_data (size_t i)

size_t	num_ip (size_t s) const

virtual size_t	num_needed_data () const

size_t	num_series () const

virtual void	prepare_element (GridObject *e, const MathVector< dim > vCornerCoords[])

size_t	register_local_ip_series (const MathVector< ldim > *vPos, const size_t numIP, bool bMayChange=true)

size_t	register_local_ip_series (const MathVector< ldim > *vPos, const size_t numIP, const int timePointSpec, bool bMayChange=true)

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

void	set_local_ips (const size_t seriesId, const MathVector< ldim > *vPos, const size_t numIP)

void	set_subset (int si)

void	set_time_point (const size_t seriesId, const int timePointSpec)

void	set_time_point (size_t timePoint)

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

int	subset () const

number	time () const

number	time (size_t s) const

size_t	time_point ()

size_t	time_point (size_t s) const

int	time_point_specification (size_t s) const

virtual void	update_dof_sizes (const LocalIndices &ind)

virtual bool	zero_derivative () const

virtual	~ICplUserData ()

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

Public Member Functions inherited from ug::UserData< typename TData, int dim, typename TRet >
int	get_dim () 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< 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

std::string	type () const

Static Public Attributes
static const int	dim = gf_type::dim
	world dimension

Private Attributes
size_t	m_fct
	the function inside of the grid function

SmartPtr< extrapol_type >	m_sp_extrapol
	the extrapolation (if any)

SmartPtr< gf_type >	m_sp_gf
	the grid function

Additional Inherited Members
Protected Member Functions inherited from ug::StdDependentUserData< LSAveData< TGridFunction >, number, TGridFunction::dim >
TImpl &	getImpl ()

const TImpl &	getImpl () const

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

const TImpl &	getImpl () const

Protected Member Functions inherited from ug::CplUserData< typename TData, int dim, typename TRet >
void	call_storage_callback () const

void	check_series (size_t s) const

void	check_series_ip (size_t s, size_t ip) const

virtual void	local_ip_series_added (const size_t seriesID)

virtual void	local_ip_series_to_be_cleared ()

virtual void	local_ips_changed (const size_t seriesID, const size_t newNumIP)

virtual void	value_storage_changed (const size_t seriesID)

Protected Member Functions inherited from ug::ICplUserData< int dim >
void	check_s (size_t s) const

void	check_s_ip (size_t s, size_t ip) const

std::vector< const MathVector< 1 > * > &	get_local_ips (Int2Type< 1 >)

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)

Protected Attributes inherited from ug::ICplUserData< int dim >
int	m_defaultTimePoint

int	m_locPosDim

std::vector< const MathVector< 1 > * >	m_pvLocIP1d

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

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

int	m_si

size_t	m_timePoint

std::vector< bool >	m_vMayChange

std::vector< size_t >	m_vNumIP

std::vector< number >	m_vTime

std::vector< int >	m_vTimePoint

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

Protected Attributes inherited from ug::UserDataInfo
FunctionGroup	m_fctGrp

FunctionIndexMapping	m_map

SmartPtr< char >	m_objName

Detailed Description

template<typename TGridFunction>
class ug::LevelSet::LSAveData< TGridFunction >

Class for averaging of a grid function in the elements

This class computes the average of a given grid function over the element.

Template Parameters

TGridFunc type of the grid function with the values to averate

Member Typedef Documentation

◆ algebra_type

template<typename TGridFunction >

typedef gf_type::algebra_type ug::LevelSet::LSAveData< TGridFunction >::algebra_type

algebra type

◆ base_type

template<typename TGridFunction >

typedef StdDependentUserData<this_type, number, dim> ug::LevelSet::LSAveData< TGridFunction >::base_type

the base type

◆ domain_type

template<typename TGridFunction >

typedef gf_type::domain_type ug::LevelSet::LSAveData< TGridFunction >::domain_type

domain type

◆ extrapol_type

template<typename TGridFunction >

typedef IInterfaceExtrapolation<domain_type, algebra_type> ug::LevelSet::LSAveData< TGridFunction >::extrapol_type

extrapolation type

◆ gf_type

template<typename TGridFunction >

typedef TGridFunction ug::LevelSet::LSAveData< TGridFunction >::gf_type

type of the grid function

◆ this_type

template<typename TGridFunction >

typedef LSAveData<gf_type> ug::LevelSet::LSAveData< TGridFunction >::this_type

this type

Constructor & Destructor Documentation

◆ LSAveData()

template<typename TGridFunction >

ug::LevelSet::LSAveData< TGridFunction >::LSAveData	(	SmartPtr< gf_type >	sp_gf,
		const char *	fct_name
	)

inline

Constructor.

Parameters

sp_gf	the grid function
fct_name	'function' to take the data from

References ug::LevelSet::LSAveData< TGridFunction >::dim, ug::LFEID::LAGRANGE, ug::LevelSet::LSAveData< TGridFunction >::m_fct, and UG_THROW.

◆ ~LSAveData()

template<typename TGridFunction >

virtual ug::LevelSet::LSAveData< TGridFunction >::~LSAveData ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ continuous()

template<typename TGridFunction >

virtual bool ug::LevelSet::LSAveData< TGridFunction >::continuous ( ) const

inlinevirtual

These are element-based data, they are not continuous.

Implements ug::UserDataInfo.

◆ eval_and_deriv()

template<typename TGridFunction >

template<int refDim>

void ug::LevelSet::LSAveData< TGridFunction >::eval_and_deriv	(	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,
		bool	bDeriv,
		int	s,
		std::vector< std::vector< number > >	vvvDeriv[],
		const MathMatrix< refDim, dim > *	vJT = `NULL`
	)

inline

Performs the main computations:

Parameters

vValue for the computed value

References ug::DoFRef(), ug::ICplUserData< int dim >::ip(), ug::LevelSet::LSAveData< TGridFunction >::m_fct, ug::LevelSet::LSAveData< TGridFunction >::m_sp_extrapol, ug::LevelSet::LSAveData< TGridFunction >::m_sp_gf, ug::ReferenceElement::num(), ug::GridObject::reference_object_id(), ug::ICplUserData< int dim >::time(), ug::GridLevel::TOP, and UG_THROW.

◆ requires_grid_fct()

template<typename TGridFunction >

virtual bool ug::LevelSet::LSAveData< TGridFunction >::requires_grid_fct ( ) const

inlinevirtual

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

Implements ug::UserDataInfo.

◆ set_extrapolation()

template<typename TGridFunction >

void ug::LevelSet::LSAveData< TGridFunction >::set_extrapolation ( SmartPtr< extrapol_type > sp_extrapol )

inline

Set the extrapolation (if any)

References ug::LevelSet::LSAveData< TGridFunction >::m_sp_extrapol.

Member Data Documentation

◆ dim

template<typename TGridFunction >

const int ug::LevelSet::LSAveData< TGridFunction >::dim = gf_type::dim

static

world dimension

Referenced by ug::LevelSet::LSAveData< TGridFunction >::LSAveData().

◆ m_fct

template<typename TGridFunction >

size_t ug::LevelSet::LSAveData< TGridFunction >::m_fct

private

the function inside of the grid function

Referenced by ug::LevelSet::LSAveData< TGridFunction >::eval_and_deriv(), and ug::LevelSet::LSAveData< TGridFunction >::LSAveData().

◆ m_sp_extrapol

template<typename TGridFunction >

SmartPtr<extrapol_type> ug::LevelSet::LSAveData< TGridFunction >::m_sp_extrapol

private

the extrapolation (if any)

Referenced by ug::LevelSet::LSAveData< TGridFunction >::eval_and_deriv(), and ug::LevelSet::LSAveData< TGridFunction >::set_extrapolation().

◆ m_sp_gf

template<typename TGridFunction >

SmartPtr<gf_type> ug::LevelSet::LSAveData< TGridFunction >::m_sp_gf

private

the grid function

Referenced by ug::LevelSet::LSAveData< TGridFunction >::eval_and_deriv().

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

/home/runner/work/docs/docs/ug4/plugins/LevelSet/level_set_ave_data.h

Public Types

Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ algebra_type

◆ base_type

◆ domain_type

◆ extrapol_type

◆ gf_type

◆ this_type

Constructor & Destructor Documentation

◆ LSAveData()

◆ ~LSAveData()

Member Function Documentation

◆ continuous()

◆ eval_and_deriv()

◆ requires_grid_fct()

◆ set_extrapolation()

Member Data Documentation

◆ dim

◆ m_fct

◆ m_sp_extrapol

◆ m_sp_gf