Base class for error estimator data. More...
#include <err_est_data.h>
Inheritance diagram for ug::IErrEstData< TDomain >:
Public Member Functions | |
| virtual void | alloc_err_est_data (ConstSmartPtr< SurfaceView > spSV, const GridLevel &gl)=0 |
| virtual function to allocate data structures for the error estimator More... | |
| bool | consider_me () const |
| virtual function granting get access to the m_consider member More... | |
| virtual number | get_elem_error_indicator (GridObject *elem, const MathVector< dim > vCornerCoords[])=0 |
| calculate L2 integrals More... | |
| IErrEstData () | |
| class constructor More... | |
| virtual void | release_err_est_data ()=0 |
| virtual function to release data structures for the error estimator 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 void | summarize_err_est_data (SmartPtr< TDomain > spDomain)=0 |
| virtual function called after the computation of the error estimator data in all the elements More... | |
| virtual | ~IErrEstData () |
| virtual class destructor More... | |
Static Public Attributes | |
| static const int | dim = TDomain::dim |
| world dimension More... | |
Private Attributes | |
| bool | m_consider |
| number | m_scale |
Detailed Description
template<typename TDomain>
class ug::IErrEstData< TDomain >
Base class for error estimator data.
This virtual class should be the base of any particular error estimator implemented in the elem_disc's. Every elem_disc class (not object!) should declare its own derived class for keeping intermediate information that should be accumulated in the computation of the local error estimators. Several objects of the elem_disc class may share the same object of the derived class for a consistent computation of the error estimator.
Constructor & Destructor Documentation
◆ IErrEstData()
|
inline |
class constructor
◆ ~IErrEstData()
|
inlinevirtual |
virtual class destructor
Member Function Documentation
◆ alloc_err_est_data()
|
pure virtual |
virtual function to allocate data structures for the error estimator
Implemented in ug::MultipleErrEstData< TDomain, TErrEstData >, ug::MultipleErrEstData< TDomain, SideAndElemErrEstData< TDomain > >, ug::SideAndElemErrEstData< TDomain >, and ug::SideFluxErrEstData< TDomain >.
◆ consider_me()
|
inline |
virtual function granting get access to the m_consider member
References ug::IErrEstData< TDomain >::m_consider.
Referenced by ug::CollectIErrEstData().
◆ get_elem_error_indicator()
|
pure virtual |
calculate L2 integrals
Implemented in ug::MultipleErrEstData< TDomain, TErrEstData >, ug::MultipleErrEstData< TDomain, SideAndElemErrEstData< TDomain > >, ug::SideAndElemErrEstData< TDomain >, and ug::SideFluxErrEstData< TDomain >.
◆ release_err_est_data()
|
pure virtual |
virtual function to release data structures for the error estimator
Implemented in ug::MultipleErrEstData< TDomain, TErrEstData >, ug::MultipleErrEstData< TDomain, SideAndElemErrEstData< TDomain > >, ug::SideAndElemErrEstData< TDomain >, and ug::SideFluxErrEstData< TDomain >.
◆ scaling_factor()
|
inline |
get scaling factor
This factor is used in the element-wise calculation of error indicators. After calculation of indicators for each IErrEstData object in the domain discretization (typically one per equation), the final overall indicator is calculated as weighted sum (with the scaling factors as weights). The default value (if not set) is 1.0.
- Returns
- scale scaling factor
References ug::IErrEstData< TDomain >::m_scale.
◆ set_consider_me()
|
inline |
whether or not this instance is to be considered by domainDisc
The domainDisc calls alloc_err_est_data(), summarize_err_est_data(), get_elem_error_indicator() etc. only for ErrEstData objects that have consider_me() == true. This is useful when using a MultipleErrEstData object combining ErrEstData objects which are already set to some ElemDisc. In this case, set_consider_me(false). The default value is true.
References ug::IErrEstData< TDomain >::m_consider.
Referenced by ug::MultipleErrEstData< TDomain, TErrEstData >::MultipleErrEstData().
◆ set_scaling_factor()
|
inline |
set scaling factor for final error calculation
References ug::IErrEstData< TDomain >::m_scale.
◆ summarize_err_est_data()
|
pure virtual |
virtual function called after the computation of the error estimator data in all the elements
Implemented in ug::MultipleErrEstData< TDomain, TErrEstData >, ug::MultipleErrEstData< TDomain, SideAndElemErrEstData< TDomain > >, ug::SideAndElemErrEstData< TDomain >, and ug::SideFluxErrEstData< TDomain >.
Member Data Documentation
◆ dim
|
static |
world dimension
◆ m_consider
|
private |
◆ m_scale
|
private |
The documentation for this class was generated from the following file:
- ugbase/lib_disc/spatial_disc/elem_disc/err_est_data.h
