mfem::ErrorEstimator Class Reference

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 double	GetTotalError () const
	Return the total error from the last error estimate. More...
virtual const Vector &	GetLocalErrors ()=0
	Get a Vector with all element errors. More...
virtual void	Reset ()=0
	Force recomputation of the estimates on the next call to GetLocalErrors. More...
virtual	~ErrorEstimator ()
	Destruct the error estimator. More...
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 ( )

inlinevirtual

Destruct the error estimator.

Definition at line 56 of file estimators.hpp.

Member Function Documentation

GetLocalErrors()

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

pure virtual

Get a Vector with all element errors.

Implemented in mfem::KellyErrorEstimator, mfem::LpErrorEstimator, mfem::L2ZienkiewiczZhuEstimator, mfem::LSZienkiewiczZhuEstimator, mfem::ZienkiewiczZhuEstimator, mfem::TMOPDeRefinerEstimator, and mfem::TMOPRefinerEstimator.

GetTotalError()

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

inlinevirtual

Return the total error from the last error estimate.

Note

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

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

Definition at line 47 of file estimators.hpp.

Reset()

virtual void mfem::ErrorEstimator::Reset ( )

pure virtual

Force recomputation of the estimates on the next call to GetLocalErrors.

Implemented in mfem::KellyErrorEstimator, mfem::LpErrorEstimator, mfem::L2ZienkiewiczZhuEstimator, mfem::LSZienkiewiczZhuEstimator, mfem::ZienkiewiczZhuEstimator, mfem::TMOPDeRefinerEstimator, and mfem::TMOPRefinerEstimator.

---

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

• fem/estimators.hpp