amrex::AMRErrorTag Class Reference

Flexible tagging rule that supports gradients, thresholds, boxes, and user functors. More...

#include <AMReX_ErrorList.H>

Classes
struct	UserFunc

Public Types
enum	TEST {   GRAD =0 , RELGRAD , LESS , GREATER ,   VORT , BOX , USER , PARSER }

Public Member Functions
	AMRErrorTag (const AMRErrorTagInfo &info=AMRErrorTagInfo()) noexcept
	Construct a tag with default BOX test and the supplied metadata.
	AMRErrorTag (amrex::Real value, AMRErrorTag::TEST test, std::string field, const AMRErrorTagInfo &info=AMRErrorTagInfo()) noexcept
	Construct a tag using a scalar threshold across all levels.
	AMRErrorTag (amrex::Vector< amrex::Real > value, AMRErrorTag::TEST test, std::string field, const AMRErrorTagInfo &info=AMRErrorTagInfo()) noexcept
	Construct a tag with per-level threshold values.
	AMRErrorTag (AMRErrorTag::UserFunc *userfunc, std::string field, int ngrow, const AMRErrorTagInfo &info=AMRErrorTagInfo()) noexcept
	Construct a tag that delegates to a user functor.
	AMRErrorTag (Parser parser, const AMRErrorTagInfo &info=AMRErrorTagInfo())
void	operator() (amrex::TagBoxArray &tb, const amrex::MultiFab *mf, char clearval, char tagval, amrex::Real time, int level, const amrex::Geometry &geom) const noexcept
	Apply the tagging rule to a TagBoxArray/MultiFab pair.
int	NGrow () const noexcept
const std::string &	Field () const noexcept
AMRErrorTagInfo &	GetInfo () noexcept
AMRErrorTagInfo const &	GetInfo () const noexcept
void	SetInfo (AMRErrorTagInfo const &info) noexcept

Protected Member Functions
int	SetNGrow () const noexcept

Protected Attributes
Vector< Real >	m_value
TEST	m_test {BOX}
UserFunc *	m_userfunc = nullptr
std::unique_ptr< Parser >	m_parser
ParserExecutor< 4 >	m_parser_exe
std::string	m_field
AMRErrorTagInfo	m_info
int	m_ngrow = 0

Detailed Description

Flexible tagging rule that supports gradients, thresholds, boxes, and user functors.

Member Enumeration Documentation

TEST

enum amrex::AMRErrorTag::TEST

Enumerator
GRAD
RELGRAD
LESS
GREATER
VORT
BOX
USER
PARSER

Constructor & Destructor Documentation

AMRErrorTag() [1/5]

amrex::AMRErrorTag::AMRErrorTag ( const AMRErrorTagInfo &  info = AMRErrorTagInfo() )

inlineexplicitnoexcept

Construct a tag with default BOX test and the supplied metadata.

AMRErrorTag() [2/5]

amrex::AMRErrorTag::AMRErrorTag ( amrex::Real  value, AMRErrorTag::TEST  test, std::string  field, const AMRErrorTagInfo &  info = AMRErrorTagInfo()  )

inlinenoexcept

Construct a tag using a scalar threshold across all levels.

Parameters

value	Threshold (or reference) value.
test	Test mode (e.g., GREATER, LESS).
field	MultiFab component name to examine.
info	Optional metadata describing min/max time, level limits, etc.

AMRErrorTag() [3/5]

amrex::AMRErrorTag::AMRErrorTag ( amrex::Vector< amrex::Real >  value, AMRErrorTag::TEST  test, std::string  field, const AMRErrorTagInfo &  info = AMRErrorTagInfo()  )

inlinenoexcept

Construct a tag with per-level threshold values.

Parameters

value	Vector of thresholds (last entry reused for higher levels if needed).
test	Test mode.
field	MultiFab component name to examine.
info	Optional metadata (time window, level window, etc.).

AMRErrorTag() [4/5]

amrex::AMRErrorTag::AMRErrorTag ( AMRErrorTag::UserFunc *  userfunc, std::string  field, int  ngrow, const AMRErrorTagInfo &  info = AMRErrorTagInfo()  )

inlinenoexcept

Construct a tag that delegates to a user functor.

Parameters

userfunc	User-defined functor (ownership retained by caller).
field	MultiFab component name to examine.
ngrow	Number of grow cells the functor requires.
info	Optional metadata.

AMRErrorTag() [5/5]

amrex::AMRErrorTag::AMRErrorTag ( Parser  parser, const AMRErrorTagInfo &  info = AMRErrorTagInfo()  )

explicit

Construct AMRErrorTag from a Parser that returns Real for given (x,y,z,t). This class's operator() can then be used to tag regions where the Parser's return value is greater than 0.

Member Function Documentation

Field()

const std::string & amrex::AMRErrorTag::Field ( ) const

inlinenoexcept

GetInfo() [1/2]

AMRErrorTagInfo const & amrex::AMRErrorTag::GetInfo ( ) const

inlinenoexcept

GetInfo() [2/2]

AMRErrorTagInfo & amrex::AMRErrorTag::GetInfo ( )

inlinenoexcept

NGrow()

int amrex::AMRErrorTag::NGrow ( ) const

inlinenoexcept

operator()()

void amrex::AMRErrorTag::operator() ( amrex::TagBoxArray &  tb, const amrex::MultiFab *  mf, char  clearval, char  tagval, amrex::Real  time, int  level, const amrex::Geometry &  geom  ) const

noexcept

Apply the tagging rule to a TagBoxArray/MultiFab pair.

Parameters

tb	Destination TagBoxArray to update.
mf	Optional pointer to the MultiFab whose data drive the tagging (can be nullptr for USER mode).
clearval	Value indicating an untagged cell.
tagval	Value indicating a tagged cell.
time	Simulation time.
level	AMR level index.
geom	Geometry describing the level (for coordinate-dependent tests).

SetInfo()

void amrex::AMRErrorTag::SetInfo ( AMRErrorTagInfo const &  info )

inlinenoexcept

SetNGrow()

int amrex::AMRErrorTag::SetNGrow ( ) const

protectednoexcept

Member Data Documentation

m_field

std::string amrex::AMRErrorTag::m_field

protected

m_info

AMRErrorTagInfo amrex::AMRErrorTag::m_info

protected

m_ngrow

int amrex::AMRErrorTag::m_ngrow = 0

protected

m_parser

std::unique_ptr<Parser> amrex::AMRErrorTag::m_parser

protected

m_parser_exe

ParserExecutor<4> amrex::AMRErrorTag::m_parser_exe

protected

m_test

TEST amrex::AMRErrorTag::m_test {BOX}

protected

m_userfunc

UserFunc* amrex::AMRErrorTag::m_userfunc = nullptr

protected

m_value

Vector<Real> amrex::AMRErrorTag::m_value

protected

---

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

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