ug4
ug::SideFluxErrEstData< TDomain > Class Template Reference

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 More...
 
typedef domain_traits< dim >::side_type side_type
 type of the sides (face, edge) and the elems (volume, face) More...
 

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 More...
 
virtual number get_elem_error_indicator (GridObject *elem, const MathVector< dim > vCornerCoords[])
 calculate L2 integrals More...
 
numberoperator() (side_type *pSide)
 get the data reference for a given side More...
 
virtual void release_err_est_data ()
 virtual function to release data structures of the error estimator More...
 
 SideFluxErrEstData ()
 constructor More...
 
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 ~SideFluxErrEstData ()
 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 Public Attributes inherited from ug::IErrEstData< TDomain >
static const int dim = TDomain::dim
 world dimension More...
 

Private Attributes

MultiGrid::AttachmentAccessor< side_type, ANumberm_aaFluxJump
 Attachment accessor. More...
 
ANumber m_aFluxJumpOverSide
 Flux jumps for the error estimator. More...
 
GridLevel m_errEstGL
 Finest grid level. More...
 
ConstSmartPtr< SurfaceViewm_spSV
 Grid for the attachment. More...
 

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

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