amrex::AMRErrorTag Class Reference

#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
	AMRErrorTag (amrex::Real value, AMRErrorTag::TEST test, std::string field, const AMRErrorTagInfo &info=AMRErrorTagInfo()) noexcept
	AMRErrorTag (amrex::Vector< amrex::Real > value, AMRErrorTag::TEST test, std::string field, const AMRErrorTagInfo &info=AMRErrorTagInfo()) noexcept
	AMRErrorTag (AMRErrorTag::UserFunc *userfunc, std::string field, int ngrow, const AMRErrorTagInfo &info=AMRErrorTagInfo()) noexcept
	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
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

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

AMRErrorTag() [2/5]

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

inlinenoexcept

AMRErrorTag() [3/5]

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

inlinenoexcept

AMRErrorTag() [4/5]

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

inlinenoexcept

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

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 files:

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