Error estimator data class storing one scalar number per side. More...

#include <err_est_data.h>

Inheritance diagram for ug::SideFluxErrEstData< TDomain >:

Public Types
typedef TDomain	domain_type
	domain type

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

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

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

number &	operator() (side_type *pSide)
	get the data reference for a given side

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

	SideFluxErrEstData ()
	constructor

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

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

virtual	~SideFluxErrEstData ()
	virtual class destructor

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

	IErrEstData ()
	class constructor

number	scaling_factor ()
	get scaling factor

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

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

virtual	~IErrEstData ()
	virtual class destructor

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

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

Private Attributes
MultiGrid::AttachmentAccessor< side_type, ANumber >	m_aaFluxJump
	Attachment accessor.

ANumber	m_aFluxJumpOverSide
	Flux jumps for the error estimator.

GridLevel	m_errEstGL
	Finest grid level.

ConstSmartPtr< SurfaceView >	m_spSV
	Grid for the attachment.

Detailed Description

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

Error estimator data class storing one scalar number per side.

This class allocates an attachment keeping one number per full-dimensional element side. Furthermore, the data are collected at the boundaries of the patches (in the case of the adaptive refinement).

Template Parameters

TDomain domain type

Member Typedef Documentation

◆ domain_type

template<typename TDomain >

typedef TDomain ug::SideFluxErrEstData< TDomain >::domain_type

domain type

◆ side_type

template<typename TDomain >

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

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

Constructor & Destructor Documentation

◆ SideFluxErrEstData()

template<typename TDomain >

ug::SideFluxErrEstData< TDomain >::SideFluxErrEstData ( )

inline

constructor

◆ ~SideFluxErrEstData()

template<typename TDomain >

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

inlinevirtual

virtual class destructor

Member Function Documentation

◆ alloc_err_est_data()

template<typename TDomain >

void ug::SideFluxErrEstData< 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_THROW.

◆ get_elem_error_indicator()

template<typename TDomain >

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

inlinevirtual

calculate L2 integrals

Implements ug::IErrEstData< TDomain >.

◆ operator()()

template<typename TDomain >

number & ug::SideFluxErrEstData< TDomain >::operator() ( side_type * pSide )

inline

get the data reference for a given side

Parameters

pSide pointer to the side

References ug::SideFluxErrEstData< TDomain >::m_aaFluxJump.

◆ release_err_est_data()

template<typename TDomain >

void ug::SideFluxErrEstData< 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 >.

◆ summarize_err_est_data()

template<typename TDomain >

void ug::SideFluxErrEstData< 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.

Implements ug::IErrEstData< TDomain >.

References ug::SurfaceView::SHADOW_RIM, and UG_THROW.

◆ surface_view()

template<typename TDomain >

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

inline

get the surface view

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

Member Data Documentation

◆ dim

template<typename TDomain >

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

static

world dimension

◆ m_aaFluxJump

template<typename TDomain >

MultiGrid::AttachmentAccessor<side_type, ANumber> ug::SideFluxErrEstData< TDomain >::m_aaFluxJump

private

Attachment accessor.

Referenced by ug::SideFluxErrEstData< TDomain >::operator()().

◆ m_aFluxJumpOverSide

template<typename TDomain >

ANumber ug::SideFluxErrEstData< TDomain >::m_aFluxJumpOverSide

private

Flux jumps for the error estimator.

◆ m_errEstGL

template<typename TDomain >

GridLevel ug::SideFluxErrEstData< TDomain >::m_errEstGL

private

Finest grid level.

◆ m_spSV

template<typename TDomain >

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

private

Grid for the attachment.

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

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

Public Types

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ domain_type

◆ side_type

Constructor & Destructor Documentation

◆ SideFluxErrEstData()

◆ ~SideFluxErrEstData()

Member Function Documentation

◆ alloc_err_est_data()

◆ get_elem_error_indicator()

◆ operator()()

◆ release_err_est_data()

◆ summarize_err_est_data()

◆ surface_view()

Member Data Documentation

◆ dim

◆ m_aaFluxJump

◆ m_aFluxJumpOverSide

◆ m_errEstGL

◆ m_spSV