Block-Structured AMR Software Framework
Loading...
Searching...
No Matches
amrex::ErrorRec::ErrorFunc Class Reference

#include <AMReX_ErrorList.H>

Public Member Functions

 ErrorFunc ()
 Bogus constructor.
 
 ErrorFunc (ErrorFuncDefault inFunc)
 A Constructor.
 
 ErrorFunc (ErrorFunc3DDefault inFunc)
 A Constructor.
 
virtual ErrorFuncclone () const
 Return a ptr to a clone of this object. It is the responsibility of the caller to delete the result.
 
virtual ~ErrorFunc ()=default
 Destructor.
 
 ErrorFunc (ErrorFunc const &)=default
 
 ErrorFunc (ErrorFunc &&)=delete
 
ErrorFuncoperator= (ErrorFunc const &)=default
 
ErrorFuncoperator= (ErrorFunc &&)=delete
 
virtual void operator() (int *tag, const int &, const int &, const int &, const int &, const int &, const int &, const int *tagval, const int *clearval, Real *data, const int &, const int &, const int &, const int &, const int &, const int &, const int *lo, const int *hi, const int *nvar, const int *domain_lo, const int *domain_hi, const Real *dx, const Real *xlo, const Real *prob_lo, const Real *time, const int *level) const
 Tag cells using "regular" function.
 
virtual void operator() (int *tag, const int *tlo, const int *thi, const int *tagval, const int *clearval, Real *data, const int *dlo, const int *dhi, const int *lo, const int *hi, const int *nvar, const int *domain_lo, const int *domain_hi, const Real *dx, const Real *xlo, const Real *prob_lo, const Real *time, const int *level) const
 Tag cells using dimension-agnostic "regular" function.
 

Protected Attributes

ErrorFuncDefault m_func {nullptr}
 
ErrorFunc3DDefault m_func3D {nullptr}
 

Constructor & Destructor Documentation

◆ ErrorFunc() [1/5]

amrex::ErrorRec::ErrorFunc::ErrorFunc ( )

Bogus constructor.

◆ ErrorFunc() [2/5]

amrex::ErrorRec::ErrorFunc::ErrorFunc ( ErrorFuncDefault  inFunc)

A Constructor.

Parameters
inFunc

◆ ErrorFunc() [3/5]

amrex::ErrorRec::ErrorFunc::ErrorFunc ( ErrorFunc3DDefault  inFunc)

A Constructor.

Parameters
inFunc

◆ ~ErrorFunc()

virtual amrex::ErrorRec::ErrorFunc::~ErrorFunc ( )
virtualdefault

Destructor.

◆ ErrorFunc() [4/5]

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

◆ ErrorFunc() [5/5]

amrex::ErrorRec::ErrorFunc::ErrorFunc ( ErrorFunc &&  )
delete

Member Function Documentation

◆ clone()

virtual ErrorFunc * amrex::ErrorRec::ErrorFunc::clone ( ) const
virtual

Return a ptr to a clone of this object. It is the responsibility of the caller to delete the result.

◆ operator()() [1/2]

virtual void amrex::ErrorRec::ErrorFunc::operator() ( int tag,
const int ,
const int ,
const int ,
const int ,
const int ,
const int ,
const int tagval,
const int clearval,
Real data,
const int ,
const int ,
const int ,
const int ,
const int ,
const int ,
const int lo,
const int hi,
const int nvar,
const int domain_lo,
const int domain_hi,
const Real dx,
const Real xlo,
const Real prob_lo,
const Real time,
const int level 
) const
virtual

Tag cells using "regular" function.

◆ operator()() [2/2]

virtual void amrex::ErrorRec::ErrorFunc::operator() ( int tag,
const int tlo,
const int thi,
const int tagval,
const int clearval,
Real data,
const int dlo,
const int dhi,
const int lo,
const int hi,
const int nvar,
const int domain_lo,
const int domain_hi,
const Real dx,
const Real xlo,
const Real prob_lo,
const Real time,
const int level 
) const
virtual

Tag cells using dimension-agnostic "regular" function.

Parameters
tagCell-status array to update (tagged or clear).
tloLower bounds of the tag array.
thiUpper bounds of the tag array.
tagvalValue that indicates a tagged cell.
clearvalValue that indicates an untagged cell.
dataPointer to data.
dloLower bounds of the data array.
dhiUpper bounds of the data array.
loLower bounds of the tile being tagged.
hiUpper bounds of the tile being tagged.
nvarNumber of data components supplied.
domain_loLower bounds of the problem domain.
domain_hiUpper bounds of the problem domain.
dxCell spacing vector.
xloPhysical location of the lower corner of the tile.
prob_loPhysical location of the lower domain corner.
timeCurrent simulation time.
levelAMR level index being tagged.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

Member Data Documentation

◆ m_func

ErrorFuncDefault amrex::ErrorRec::ErrorFunc::m_func {nullptr}
protected

◆ m_func3D

ErrorFunc3DDefault amrex::ErrorRec::ErrorFunc::m_func3D {nullptr}
protected

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