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)
	Construct an error record that uses the ErrorFunc2 interface.
	ErrorRec (std::string nm, int ng, ErrorType etyp, const ErrorRec::ErrorFunc &f)
	Construct an error record that uses the ErrorFunc interface (same parameters as above).
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.
int	nGrow () const noexcept
	The number of extra zones needed for derivation.
ErrorType	errType () const noexcept
	The type of the error tagging.
virtual const ErrorRec::ErrorFunc &	errFunc () const
	The extern "C" functions to do the error tagging.
virtual const ErrorRec::ErrorFunc2 &	errFunc2 () const

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,
		ErrorType	etyp,
		const ErrorRec::ErrorFunc2 &	f2 )

Construct an error record that uses the ErrorFunc2 interface.

Parameters

nm	Derived quantity name used for tagging.
ng	Number of grow cells required by the tagging functor.
etyp	Error tagging type (Special/Standard/UseAverage).
f2	Functor describing how to tag cells.

ErrorRec() [2/4]

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

Construct an error record that uses the ErrorFunc interface (same parameters as above).

~ErrorRec()

virtual 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()

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

nodiscardvirtual

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

errFunc2()

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

nodiscardvirtual

errType()

ErrorType amrex::ErrorRec::errType ( ) const

nodiscardnoexcept

The type of the error tagging.

name()

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

nodiscardnoexcept

The name of the quantity to derive.

nGrow()

int amrex::ErrorRec::nGrow ( ) const

nodiscardnoexcept

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

---

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

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