Error estimator data class storing a number vector per side and per element. More...

#include <err_est_data.h>

Inheritance diagram for ug::SideAndElemErrEstData< TDomain >:

Classes
struct	GetQuadRules
	helper struct for getting quadrature rules by use of mpl::lists More...

Public Types
typedef Attachment< std::vector< number > >	attachment_type
	attachment type More...

typedef TDomain	domain_type
	domain type More...

typedef domain_traits< dim >::element_type	elem_type

typedef domain_traits< dim >::side_type	side_type
	type of the sides (face, edge) and the elems (volume, face) More...

typedef SideAndElemErrEstData< TDomain >	this_type
	this class More...

Public Member Functions
MathVector< TDomain::dim > *	all_side_global_ips (GridObject *elem, const MathVector< dim > vCornerCoords[])
	get all global side integration points More...

virtual void	alloc_err_est_data (ConstSmartPtr< SurfaceView > spSV, const GridLevel &gl)
	virtual function to allocate data structures for the error estimator More...

MathVector< TDomain::dim > *	elem_global_ips (GridObject *elem, const MathVector< dim > vCornerCoords[])
	get the global elem integration points for a specific roid More...

template<int refDim>
const MathVector< refDim > *	elem_local_ips (const ReferenceObjectID roid)
	get the local elem integration points for a specific roid More...

size_t	elem_order () const
	getting the elem integration order More...

size_t	first_side_ips (const ReferenceObjectID roid, const size_t side)
	get number of first IP belonging to a specific side More...

virtual number	get_elem_error_indicator (GridObject *elem, const MathVector< dim > vCornerCoords[])
	calculate L2 integrals More...

size_t	num_all_side_ips (const ReferenceObjectID roid)
	get number of side IPs More...

size_t	num_elem_ips (const ReferenceObjectID roid)
	get number of elem IPs More...

size_t	num_side_ips (const ReferenceObjectID roid)
	get number of side IPs of a specific side type More...

size_t	num_side_ips (const side_type *pSide)
	get number of side IPs of a specific side More...

number &	operator() (elem_type *pElem, size_t ip)
	get the data reference for a given elem and ip More...

number &	operator() (side_type *pSide, size_t ip)
	get the data reference for a given side and ip More...

virtual void	release_err_est_data ()
	virtual function to release data structures of the error estimator More...

void	set_type (int type)
	select L2/H1 Estimator More...

MathVector< TDomain::dim > *	side_global_ips (GridObject *elem, const MathVector< dim > vCornerCoords[])
	get the global side integration points for a specific side roid More...

size_t	side_ip_index (const ReferenceObjectID roid, const size_t side, const size_t ip)
	get index of specific side IP in sideIP array returned by side_local_ips More...

template<int refDim>
const MathVector< refDim > *	side_local_ips (const ReferenceObjectID roid)
	get the local side integration points for a specific roid More...

size_t	side_order () const
	getting the side integration order More...

	SideAndElemErrEstData (size_t _sideOrder, size_t _elemOrder, const char *subsets)
	constructors More...

	SideAndElemErrEstData (size_t _sideOrder, size_t _elemOrder, std::vector< std::string > subsets=std::vector< std::string >(0))

virtual void	summarize_err_est_data (SmartPtr< TDomain > spDomain)
	virtual function called after the computation of the error estimator data in all the elements More...

ConstSmartPtr< SurfaceView > &	surface_view ()
	get the surface view More...

virtual	~SideAndElemErrEstData ()
	virtual class destructor More...

Public Member Functions inherited from ug::IErrEstData< TDomain >
bool	consider_me () const
	virtual function granting get access to the m_consider member More...

	IErrEstData ()
	class constructor More...

number	scaling_factor ()
	get scaling factor More...

void	set_consider_me (bool b)
	whether or not this instance is to be considered by domainDisc More...

void	set_scaling_factor (number scale)
	set scaling factor for final error calculation More...

virtual	~IErrEstData ()
	virtual class destructor More...

Static Public Attributes
static const int	dim = TDomain::dim
	world dimension More...

static const int	MAX_NUM_SIDES = 8
	maximal number of sides of any element More...

Static Public Attributes inherited from ug::IErrEstData< TDomain >
static const int	dim = TDomain::dim
	world dimension More...

Protected Member Functions
void	init_quadrature ()
	initialization of quadrature (to be called during construction) More...

Private Types
enum	type { L2_ERROR_TYPE =0 , H1_ERROR_TYPE }
	set type More...

Private Attributes
size_t	elemOrder

MultiGrid::AttachmentAccessor< elem_type, attachment_type >	m_aaElem
	vector of elem attachment accessors More...

MultiGrid::AttachmentAccessor< side_type, attachment_type >	m_aaSide
	vector of side attachment accessors More...

attachment_type	m_aElem
	vector of attachments for elems More...

attachment_type	m_aSide
	vector of attachments for sides More...

std::vector< MathVector< TDomain::dim > >	m_elemGlobalIPcoords

GridLevel	m_errEstGL
	Finest grid level. More...

std::vector< MathVector< TDomain::dim > >	m_sideGlobalIPcoords
	storage for global elem and side IPs More...

std::vector< MathVector< TDomain::dim > >	m_SideIPcoords [NUM_REFERENCE_OBJECTS]
	extra storage for local side IPs (elem IPs are contained in elem quad rules) More...

size_t	m_sideIPsStartIndex [NUM_REFERENCE_OBJECTS][MAX_NUM_SIDES]
	the first index for IPs of a specific side in the sideIP series for a roid More...

std::vector< MathVector< TDomain::dim > >	m_singleSideGlobalIPcoords

ConstSmartPtr< SurfaceView >	m_spSV
	Grid for the attachment. More...

SubsetGroup	m_ssg

int	m_type

std::vector< std::string >	m_vSs
	the subsets this error estimator will produce values for More...

QuadratureRule< dim > *	quadRuleElem [NUM_REFERENCE_OBJECTS]

QuadratureRule< dim-1 > *	quadRuleSide [NUM_REFERENCE_OBJECTS]
	storage for integration rules More...

size_t	sideOrder
	order of side and elem function approximations for integrating More...

Detailed Description

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

Error estimator data class storing a number vector per side and per element.

This class represents an H1 error estimator. It can integrate expressions on elements and their sides with arbitrary order. A vector of values at defined integration points is attached to any element and side to that end.

RECOMMENDED (INTENDED) USAGE The data will typically consist of the values of certain functions at integration points (IP) on the sides and the element. A pointer to an object of this class can be handed to any element discretization involved in a discretization. They will access the attachments in their method compute_err_est_elem and add their respective parts of the function to be integrated for the error estimator. Exactly one of them (or maybe some other object) then has to do the actual integration using the given values at the IPs and add up side and element terms according to the error estimator formula used.

Template Parameters

TDomain domain type

Member Typedef Documentation

◆ attachment_type

template<typename TDomain >

typedef Attachment<std::vector<number> > ug::SideAndElemErrEstData< TDomain >::attachment_type

attachment type

◆ domain_type

template<typename TDomain >

typedef TDomain ug::SideAndElemErrEstData< TDomain >::domain_type

domain type

◆ elem_type

template<typename TDomain >

typedef domain_traits<dim>::element_type ug::SideAndElemErrEstData< TDomain >::elem_type

◆ side_type

template<typename TDomain >

typedef domain_traits<dim>::side_type ug::SideAndElemErrEstData< TDomain >::side_type

type of the sides (face, edge) and the elems (volume, face)

◆ this_type

template<typename TDomain >

typedef SideAndElemErrEstData<TDomain> ug::SideAndElemErrEstData< TDomain >::this_type

this class

Member Enumeration Documentation

◆ type

template<typename TDomain >

enum ug::SideAndElemErrEstData::type

private

set type

Enumerator
L2_ERROR_TYPE
H1_ERROR_TYPE

Constructor & Destructor Documentation

◆ SideAndElemErrEstData() [1/2]

template<typename TDomain >

ug::SideAndElemErrEstData< TDomain >::SideAndElemErrEstData	(	size_t	_sideOrder,
		size_t	_elemOrder,
		const char *	subsets
	)

constructors

References ug::check_subset_strings(), ug::SideAndElemErrEstData< TDomain >::init_quadrature(), ug::SideAndElemErrEstData< TDomain >::m_vSs, and ug::TokenizeString().

◆ SideAndElemErrEstData() [2/2]

template<typename TDomain >

ug::SideAndElemErrEstData< TDomain >::SideAndElemErrEstData	(	size_t	_sideOrder,
		size_t	_elemOrder,
		std::vector< std::string >	subsets = `std::vector<std::string>(0)`
	)

References ug::check_subset_strings(), ug::SideAndElemErrEstData< TDomain >::init_quadrature(), and ug::SideAndElemErrEstData< TDomain >::m_vSs.

◆ ~SideAndElemErrEstData()

template<typename TDomain >

virtual ug::SideAndElemErrEstData< TDomain >::~SideAndElemErrEstData ( )

inlinevirtual

virtual class destructor

Member Function Documentation

◆ all_side_global_ips()

template<typename TDomain >

MathVector< TDomain::dim > * ug::SideAndElemErrEstData< TDomain >::all_side_global_ips	(	GridObject *	elem,
		const MathVector< dim >	vCornerCoords[]
	)

get all global side integration points

References ug::DimReferenceMapping< TDim, TWorldDim >::local_to_global(), ug::GridObject::reference_object_id(), and UG_THROW.

Referenced by ug::NeumannBoundaryFV1< TDomain >::compute_err_est_rhs_elem(), and ug::NeumannBoundaryFV1< TDomain >::prep_err_est_elem().

◆ alloc_err_est_data()

template<typename TDomain >

void ug::SideAndElemErrEstData< TDomain >::alloc_err_est_data	(	ConstSmartPtr< SurfaceView >	spSV,
		const GridLevel &	gl
	)

virtual

virtual function to allocate data structures for the error estimator

Allocates data structures for the error estimator.

Implements ug::IErrEstData< TDomain >.

References ug::GridLevel::SURFACE, ug::GridLevel::type(), and UG_COND_THROW.

◆ elem_global_ips()

template<typename TDomain >

MathVector< TDomain::dim > * ug::SideAndElemErrEstData< TDomain >::elem_global_ips	(	GridObject *	elem,
		const MathVector< dim >	vCornerCoords[]
	)

get the global elem integration points for a specific roid

References ug::DimReferenceMapping< TDim, TWorldDim >::local_to_global(), ug::GridObject::reference_object_id(), and UG_THROW.

◆ elem_local_ips()

template<typename TDomain >

template<int refDim>

const MathVector< refDim > * ug::SideAndElemErrEstData< TDomain >::elem_local_ips ( const ReferenceObjectID roid )

get the local elem integration points for a specific roid

References dim, and UG_COND_THROW.

◆ elem_order()

template<typename TDomain >

size_t ug::SideAndElemErrEstData< TDomain >::elem_order ( ) const

inline

getting the elem integration order

References ug::SideAndElemErrEstData< TDomain >::elemOrder.

◆ first_side_ips()

template<typename TDomain >

size_t ug::SideAndElemErrEstData< TDomain >::first_side_ips	(	const ReferenceObjectID	roid,
		const size_t	side
	)

get number of first IP belonging to a specific side

Referenced by ug::NeumannBoundaryFV1< TDomain >::compute_err_est_rhs_elem().

◆ get_elem_error_indicator()

template<typename TDomain >

number ug::SideAndElemErrEstData< TDomain >::get_elem_error_indicator	(	GridObject *	elem,
		const MathVector< dim >	vCornerCoords[]
	)

virtual

calculate L2 integrals

Implements ug::IErrEstData< TDomain >.

References ug::Grid::associated_elements(), dim, ug::ReferenceMappingProvider::get(), ug::ReferenceElement::id(), ug::ReferenceElement::num(), ug::GridObject::reference_object_id(), ug::DimReferenceMapping< TDim, TWorldDim >::sqrt_gram_det(), UG_COND_THROW, UG_THROW, and ug::DimReferenceMapping< TDim, TWorldDim >::update().

◆ init_quadrature()

template<typename TDomain >

void ug::SideAndElemErrEstData< TDomain >::init_quadrature

protected

initialization of quadrature (to be called during construction)

References ug::DimReferenceElement< d >::corner(), dim, ug::ReferenceElement::dimension(), ug::ReferenceElementProvider::get(), ug::ReferenceMappingProvider::get(), ug::ReferenceElement::id(), ug::ReferenceElement::num(), ug::NUM_REFERENCE_OBJECTS, ug::ReferenceElement::roid(), ug::ROID_VERTEX, and UG_THROW.

Referenced by ug::SideAndElemErrEstData< TDomain >::SideAndElemErrEstData().

◆ num_all_side_ips()

template<typename TDomain >

size_t ug::SideAndElemErrEstData< TDomain >::num_all_side_ips ( const ReferenceObjectID roid )

get number of side IPs

Referenced by ug::NeumannBoundaryFV1< TDomain >::prep_err_est_elem(), and ug::NeumannBoundaryFV1< TDomain >::prep_err_est_elem_loop().

◆ num_elem_ips()

template<typename TDomain >

size_t ug::SideAndElemErrEstData< TDomain >::num_elem_ips ( const ReferenceObjectID roid )

get number of elem IPs

References UG_COND_THROW.

◆ num_side_ips() [1/2]

template<typename TDomain >

size_t ug::SideAndElemErrEstData< TDomain >::num_side_ips ( const ReferenceObjectID roid )

get number of side IPs of a specific side type

References UG_COND_THROW.

◆ num_side_ips() [2/2]

template<typename TDomain >

size_t ug::SideAndElemErrEstData< TDomain >::num_side_ips ( const side_type * pSide )

get number of side IPs of a specific side

Referenced by ug::NeumannBoundaryFV1< TDomain >::compute_err_est_rhs_elem().

◆ operator()() [1/2]

template<typename TDomain >

number & ug::SideAndElemErrEstData< TDomain >::operator()	(	elem_type *	pElem,
		size_t	ip
	)

get the data reference for a given elem and ip

Parameters

pElem	pointer to the elem
ip	integration point id on the elem

References UG_CATCH_THROW, and UG_THROW.

◆ operator()() [2/2]

template<typename TDomain >

number & ug::SideAndElemErrEstData< TDomain >::operator()	(	side_type *	pSide,
		size_t	ip
	)

get the data reference for a given side and ip

Parameters

pSide	pointer to the side
ip	integration point id on the side

References UG_CATCH_THROW, and UG_THROW.

◆ release_err_est_data()

template<typename TDomain >

void ug::SideAndElemErrEstData< TDomain >::release_err_est_data

virtual

virtual function to release data structures of the error estimator

Releases data structures of the error estimator.

Implements ug::IErrEstData< TDomain >.

◆ set_type()

template<typename TDomain >

void ug::SideAndElemErrEstData< TDomain >::set_type ( int type )

inline

select L2/H1 Estimator

References ug::SideAndElemErrEstData< TDomain >::H1_ERROR_TYPE, and ug::SideAndElemErrEstData< TDomain >::m_type.

◆ side_global_ips()

template<typename TDomain >

MathVector< TDomain::dim > * ug::SideAndElemErrEstData< TDomain >::side_global_ips	(	GridObject *	elem,
		const MathVector< dim >	vCornerCoords[]
	)

get the global side integration points for a specific side roid

References dim, ug::ReferenceMappingProvider::get(), ug::GridObject::reference_object_id(), and UG_THROW.

◆ side_ip_index()

template<typename TDomain >

size_t ug::SideAndElemErrEstData< TDomain >::side_ip_index	(	const ReferenceObjectID	roid,
		const size_t	side,
		const size_t	ip
	)

get index of specific side IP in sideIP array returned by side_local_ips

◆ side_local_ips()

template<typename TDomain >

template<int refDim>

const MathVector< refDim > * ug::SideAndElemErrEstData< TDomain >::side_local_ips ( const ReferenceObjectID roid )

get the local side integration points for a specific roid

References dim, and UG_THROW.

◆ side_order()

template<typename TDomain >

size_t ug::SideAndElemErrEstData< TDomain >::side_order ( ) const

inline

getting the side integration order

References ug::SideAndElemErrEstData< TDomain >::sideOrder.

◆ summarize_err_est_data()

template<typename TDomain >

void ug::SideAndElemErrEstData< TDomain >::summarize_err_est_data ( SmartPtr< TDomain > spDomain )

virtual

virtual function called after the computation of the error estimator data in all the elements

Called after the computation of the error estimator data in all the elements.

Because of the multigrid hierarchy, the sides at the rim of a multigrid level only have one of the two flux terms (cis or trans). In order to calculate a jump, we need to add up the resp. attachments on parent and child for that side.

Implements ug::IErrEstData< TDomain >.

References ug::CollectCornerCoordinates(), pcl::InterfaceCommunicator< TLayout >::communicate(), ug::Grid::distributed_grid_manager(), pcl::InterfaceCommunicator< TLayout >::exchange_data(), ug::ComPol_CopyAttachment< TLayout, TAttachment >::extract_on_constrained_elems_only(), ug::DistributedGridManager::grid_layout_map(), ug::INT_H_MASTER, ug::INT_H_SLAVE, ug::INT_V_MASTER, ug::INT_V_SLAVE, PCL_RO_SUM, ug::SurfaceView::SHADOW_RIM, UG_THROW, ug::VecLengthSq(), and ug::VecSubtract().

◆ surface_view()

template<typename TDomain >

ConstSmartPtr<SurfaceView>& ug::SideAndElemErrEstData< TDomain >::surface_view ( )

inline

get the surface view

References ug::SideAndElemErrEstData< TDomain >::m_spSV.

Referenced by ug::NeumannBoundaryFV1< TDomain >::compute_err_est_rhs_elem().

Member Data Documentation

◆ dim

template<typename TDomain >

const int ug::SideAndElemErrEstData< TDomain >::dim = TDomain::dim

static

world dimension

◆ elemOrder

template<typename TDomain >

size_t ug::SideAndElemErrEstData< TDomain >::elemOrder

private

Referenced by ug::SideAndElemErrEstData< TDomain >::elem_order().

◆ m_aaElem

template<typename TDomain >

MultiGrid::AttachmentAccessor<elem_type, attachment_type > ug::SideAndElemErrEstData< TDomain >::m_aaElem

private

vector of elem attachment accessors

◆ m_aaSide

template<typename TDomain >

MultiGrid::AttachmentAccessor<side_type, attachment_type > ug::SideAndElemErrEstData< TDomain >::m_aaSide

private

vector of side attachment accessors

◆ m_aElem

template<typename TDomain >

attachment_type ug::SideAndElemErrEstData< TDomain >::m_aElem

private

vector of attachments for elems

◆ m_aSide

template<typename TDomain >

attachment_type ug::SideAndElemErrEstData< TDomain >::m_aSide

private

vector of attachments for sides

◆ m_elemGlobalIPcoords

template<typename TDomain >

std::vector<MathVector<TDomain::dim> > ug::SideAndElemErrEstData< TDomain >::m_elemGlobalIPcoords

private

◆ m_errEstGL

template<typename TDomain >

GridLevel ug::SideAndElemErrEstData< TDomain >::m_errEstGL

private

Finest grid level.

◆ m_sideGlobalIPcoords

template<typename TDomain >

std::vector<MathVector<TDomain::dim> > ug::SideAndElemErrEstData< TDomain >::m_sideGlobalIPcoords

private

storage for global elem and side IPs

◆ m_SideIPcoords

template<typename TDomain >

std::vector<MathVector<TDomain::dim> > ug::SideAndElemErrEstData< TDomain >::m_SideIPcoords[NUM_REFERENCE_OBJECTS]

private

extra storage for local side IPs (elem IPs are contained in elem quad rules)

◆ m_sideIPsStartIndex

template<typename TDomain >

size_t ug::SideAndElemErrEstData< TDomain >::m_sideIPsStartIndex[NUM_REFERENCE_OBJECTS][MAX_NUM_SIDES]

private

the first index for IPs of a specific side in the sideIP series for a roid

◆ m_singleSideGlobalIPcoords

template<typename TDomain >

std::vector<MathVector<TDomain::dim> > ug::SideAndElemErrEstData< TDomain >::m_singleSideGlobalIPcoords

private

◆ m_spSV

template<typename TDomain >

ConstSmartPtr<SurfaceView> ug::SideAndElemErrEstData< TDomain >::m_spSV

private

Grid for the attachment.

Referenced by ug::SideAndElemErrEstData< TDomain >::surface_view().

◆ m_ssg

template<typename TDomain >

SubsetGroup ug::SideAndElemErrEstData< TDomain >::m_ssg

private

◆ m_type

template<typename TDomain >

int ug::SideAndElemErrEstData< TDomain >::m_type

private

Referenced by ug::SideAndElemErrEstData< TDomain >::set_type().

◆ m_vSs

template<typename TDomain >

std::vector<std::string> ug::SideAndElemErrEstData< TDomain >::m_vSs

private

the subsets this error estimator will produce values for

Referenced by ug::SideAndElemErrEstData< TDomain >::SideAndElemErrEstData().

◆ MAX_NUM_SIDES

template<typename TDomain >

const int ug::SideAndElemErrEstData< TDomain >::MAX_NUM_SIDES = 8

static

maximal number of sides of any element

◆ quadRuleElem

template<typename TDomain >

QuadratureRule<dim>* ug::SideAndElemErrEstData< TDomain >::quadRuleElem[NUM_REFERENCE_OBJECTS]

private

◆ quadRuleSide

template<typename TDomain >

QuadratureRule<dim-1>* ug::SideAndElemErrEstData< TDomain >::quadRuleSide[NUM_REFERENCE_OBJECTS]

private

storage for integration rules

◆ sideOrder

template<typename TDomain >

size_t ug::SideAndElemErrEstData< TDomain >::sideOrder

private

order of side and elem function approximations for integrating

Referenced by ug::SideAndElemErrEstData< TDomain >::side_order().

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

ugbase/lib_disc/spatial_disc/elem_disc/err_est_data.h
ugbase/lib_disc/spatial_disc/elem_disc/err_est_data_impl.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ attachment_type

◆ domain_type

◆ elem_type

◆ side_type

◆ this_type

Member Enumeration Documentation

◆ type

Constructor & Destructor Documentation

◆ SideAndElemErrEstData() [1/2]

◆ SideAndElemErrEstData() [2/2]

◆ ~SideAndElemErrEstData()

Member Function Documentation

◆ all_side_global_ips()

◆ alloc_err_est_data()

◆ elem_global_ips()

◆ elem_local_ips()

◆ elem_order()

◆ first_side_ips()

◆ get_elem_error_indicator()

◆ init_quadrature()

◆ num_all_side_ips()

◆ num_elem_ips()

◆ num_side_ips() [1/2]

◆ num_side_ips() [2/2]

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ release_err_est_data()

◆ set_type()

◆ side_global_ips()

◆ side_ip_index()

◆ side_local_ips()

◆ side_order()

◆ summarize_err_est_data()

◆ surface_view()

Member Data Documentation

◆ dim

◆ elemOrder

◆ m_aaElem

◆ m_aaSide

◆ m_aElem

◆ m_aSide

◆ m_elemGlobalIPcoords

◆ m_errEstGL

◆ m_sideGlobalIPcoords

◆ m_SideIPcoords

◆ m_sideIPsStartIndex

◆ m_singleSideGlobalIPcoords

◆ m_spSV

◆ m_ssg

◆ m_type

◆ m_vSs

◆ MAX_NUM_SIDES

◆ quadRuleElem

◆ quadRuleSide

◆ sideOrder

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