MFEM v4.7.0
Finite element discretization library
No Matches
Public Member Functions | List of all members
mfem::ErrorEstimator Class Referenceabstract

Base class for all element based error estimators. More...

#include <estimators.hpp>

Inheritance diagram for mfem::ErrorEstimator:
Collaboration diagram for mfem::ErrorEstimator:

Public Member Functions

virtual real_t GetTotalError () const
 Return the total error from the last error estimate.
virtual const VectorGetLocalErrors ()=0
 Get a Vector with all element errors.
virtual void Reset ()=0
 Force recomputation of the estimates on the next call to GetLocalErrors.
virtual ~ErrorEstimator ()
 Destruct the error estimator.
- Public Member Functions inherited from mfem::AbstractErrorEstimator
virtual ~AbstractErrorEstimator ()

Detailed Description

Base class for all element based error estimators.

At a minimum, an ErrorEstimator must be able compute one non-negative real (double) number for each element in the Mesh.

Definition at line 41 of file estimators.hpp.

Constructor & Destructor Documentation

◆ ~ErrorEstimator()

virtual mfem::ErrorEstimator::~ErrorEstimator ( )

Destruct the error estimator.

Definition at line 56 of file estimators.hpp.

Member Function Documentation

◆ GetLocalErrors()

virtual const Vector & mfem::ErrorEstimator::GetLocalErrors ( )
pure virtual

◆ GetTotalError()

virtual real_t mfem::ErrorEstimator::GetTotalError ( ) const

Return the total error from the last error estimate.

This method is optional for derived classes to override and the base class implementation simply returns 0.

Reimplemented in mfem::ZienkiewiczZhuEstimator, mfem::LSZienkiewiczZhuEstimator, mfem::L2ZienkiewiczZhuEstimator, and mfem::KellyErrorEstimator.

Definition at line 47 of file estimators.hpp.

◆ Reset()

virtual void mfem::ErrorEstimator::Reset ( )
pure virtual

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