amrex::ErrorRec Class Reference

Error Record. More...

#include <AMReX_ErrorList.H>

Classes
class	ErrorFunc
class	ErrorFunc2

Public Types
enum	ErrorType { Special =0 , Standard , UseAverage }

Public Member Functions
	ErrorRec (std::string nm, int ng, ErrorType etyp, const ErrorRec::ErrorFunc2 &f2)
	The constructors. More...
	ErrorRec (std::string nm, int ng, ErrorType etyp, const ErrorRec::ErrorFunc &f)
virtual	~ErrorRec ()
	ErrorRec (ErrorRec const &)=delete
	ErrorRec (ErrorRec &&)=delete
ErrorRec &	operator= (ErrorRec const &)=delete
ErrorRec &	operator= (ErrorRec &&)=delete
const std::string &	name () const noexcept
	The name of the quantity to derive. More...
int	nGrow () const noexcept
	The number of extra zones needed for derivation. More...
ErrorType	errType () const noexcept
	The type of the error tagging. More...
virtual const ErrorRec::ErrorFunc &	errFunc () const
	The extern "C" functions to do the error tagging. More...
virtual const ErrorRec::ErrorFunc2 &	errFunc2 () const

Private Attributes
std::string	derive_name
	Name of quantity to derive. More...
int	ngrow
	Number of extra zones. More...
ErrorType	err_type
	The type of Error. More...
ErrorFunc *	err_func
	Functions to do error estimation. More...
ErrorFunc2 *	err_func2

Detailed Description

Error Record.

ErrorRec is designed to tag cells for regridding based on the state data contained in AmrLevel and its derivatives. It is conceivable that actual error tagging will be through derivation, so provision is made for this as well.

Member Enumeration Documentation

ErrorType

enum amrex::ErrorRec::ErrorType

Enumerator
Special
Standard
UseAverage

Constructor & Destructor Documentation

ErrorRec() [1/4]

amrex::ErrorRec::ErrorRec	(	std::string	nm,
		int	ng,
		ErrorRec::ErrorType	etyp,
		const ErrorRec::ErrorFunc2 &	f2
	)

The constructors.

Parameters

nm
ng
etyp
f2

ErrorRec() [2/4]

amrex::ErrorRec::ErrorRec	(	std::string	nm,
		int	ng,
		ErrorRec::ErrorType	etyp,
		const ErrorRec::ErrorFunc &	f
	)

~ErrorRec()

amrex::ErrorRec::~ErrorRec ( )

virtual

ErrorRec() [3/4]

amrex::ErrorRec::ErrorRec ( ErrorRec const &  )

delete

ErrorRec() [4/4]

amrex::ErrorRec::ErrorRec ( ErrorRec &&  )

delete

Member Function Documentation

errFunc()

const ErrorRec::ErrorFunc & amrex::ErrorRec::errFunc ( ) const

virtual

The extern "C" functions to do the error tagging.

errFunc2()

const ErrorRec::ErrorFunc2 & amrex::ErrorRec::errFunc2 ( ) const

virtual

errType()

ErrorRec::ErrorType amrex::ErrorRec::errType ( ) const

noexcept

The type of the error tagging.

name()

const std::string & amrex::ErrorRec::name ( ) const

noexcept

The name of the quantity to derive.

nGrow()

int amrex::ErrorRec::nGrow ( ) const

noexcept

The number of extra zones needed for derivation.

operator=() [1/2]

ErrorRec& amrex::ErrorRec::operator= ( ErrorRec &&  )

delete

operator=() [2/2]

ErrorRec& amrex::ErrorRec::operator= ( ErrorRec const &  )

delete

Member Data Documentation

derive_name

std::string amrex::ErrorRec::derive_name

private

Name of quantity to derive.

err_func

ErrorFunc* amrex::ErrorRec::err_func

private

Functions to do error estimation.

err_func2

ErrorFunc2* amrex::ErrorRec::err_func2

private

err_type

ErrorType amrex::ErrorRec::err_type

private

The type of Error.

ngrow

int amrex::ErrorRec::ngrow

private

Number of extra zones.

---

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

• /home/runner/work/amrex/amrex/Src/AmrCore/AMReX_ErrorList.H
• /home/runner/work/amrex/amrex/Src/AmrCore/AMReX_ErrorList.cpp