amrex::AmrLevel Class Reference

Virtual base class for managing individual levels. AmrLevel functions both as a container for state data on a level and also manages the advancement of data in time. More...

#include <AMReX_AmrLevel.H>

Public Types
enum	TimeLevel {   AmrOldTime , AmrHalfTime , AmrNewTime , Amr1QtrTime ,   Amr3QtrTime , AmrOtherTime }
	What time are we at? More...

Public Member Functions
virtual	~AmrLevel ()
	The destructor.
	AmrLevel (const AmrLevel &)=delete
	Disable copying because AmrLevel owns state data and geometry caches.
	AmrLevel (AmrLevel &&)=delete
	Disable moving; derived classes manage non-movable FillPatch caches.
AmrLevel &	operator= (const AmrLevel &)=delete
	Copy assignment is undefined for the same ownership reasons.
AmrLevel &	operator= (AmrLevel &&)=delete
	Move assignment is also disabled—use factory methods instead.
void	LevelDirectoryNames (const std::string &dir, std::string &LevelDir, std::string &FullPath) const
	Derive the directory name for this level inside a plot/checkpoint tree.
virtual void	CreateLevelDirectory (const std::string &dir)
	Create the Level_* directory inside dir (if needed) before writing plots/checkpoints.
void	SetLevelDirectoryCreated (bool ldc) noexcept
	Record whether CreateLevelDirectory() has already created the folder.
virtual std::string	thePlotFileType () const
	A string written as the first item in writePlotFile() at level zero. It is so we can distinguish between different types of plot files. This default "HyperCLaw-V1.1" is for VisIt software and some of our internal postprocessing routines.
virtual void	writePlotFile (const std::string &dir, std::ostream &os, VisMF::How how=VisMF::NFiles)
	Write plot file data for this level into directory dir.
virtual void	writePlotFilePre (const std::string &dir, std::ostream &os)
	Perform pre-plotfile operations (e.g., gather metadata) for directory dir using os.
virtual void	writePlotFilePost (const std::string &dir, std::ostream &os)
	Perform post-plotfile cleanup for directory dir once writes complete.
virtual void	writeSmallPlotFile (const std::string &dir, std::ostream &os, VisMF::How how=VisMF::NFiles)
	Write a reduced plot file (same parameters as writePlotFile()) to dir.
virtual void	checkPoint (const std::string &dir, std::ostream &os, VisMF::How how=VisMF::NFiles, bool dump_old=true)
	Write current state to a checkpoint directory.
virtual void	checkPointPre (const std::string &dir, std::ostream &os)
	Do pre-checkpoint work (e.g., directory creation) for dir using os.
virtual void	checkPointPost (const std::string &dir, std::ostream &os)
	Do post-checkpoint cleanup for dir once writes complete.
virtual void	restart (Amr &papa, std::istream &is, bool bReadSpecial=false)
	Populate this level from checkpoint input stream is.
virtual void	set_state_in_checkpoint (Vector< int > &state_in_checkpoint)
	Hook to adjust which state descriptors are expected in checkpoint streams.
virtual void	computeInitialDt (int finest_level, int sub_cycle, Vector< int > &n_cycle, const Vector< IntVect > &ref_ratio, Vector< Real > &dt_level, Real stop_time)=0
	Compute the initial time step size for each level.
virtual void	computeNewDt (int finest_level, int sub_cycle, Vector< int > &n_cycle, const Vector< IntVect > &ref_ratio, Vector< Real > &dt_min, Vector< Real > &dt_level, Real stop_time, int post_regrid_flag)=0
	Compute the next time step sizes after an advance.
virtual Real	advance (Real time, Real dt, int iteration, int ncycle)=0
	Advance solution on this level by dt and return the next stable dt.
virtual void	post_timestep (int iteration)
	Perform level-specific updates after each subcycle.
virtual void	postCoarseTimeStep (Real time)
	Called once per coarse step after fine levels finish refluxing.
virtual void	post_restart ()
	Override to perform any fixups immediately after restart (default: no-op).
virtual void	post_regrid (int lbase, int new_finest)=0
	Operations to be performed immediately after regridding completes.
virtual void	post_init (Real stop_time)=0
	Operations to run after initialization finishes.
virtual int	okToContinue ()
	Return nonzero to continue advancing; zero to halt the run.
virtual int	okToRegrid ()
	Return nonzero if refinement starting from this level is allowed this cycle.
virtual void	initData ()=0
	Init grid data at problem start-up. This is a pure virtual function and hence MUST be implemented by derived classes.
virtual void	setTimeLevel (Real time, Real dt_old, Real dt_new)
	Set the time metadata stored in the state data arrays (old/new).
virtual void	allocOldData ()
	Allocate storage for "old" time slices before an advance.
virtual void	removeOldData ()
	Delete the old-time slots once they are no longer needed.
virtual void	init (AmrLevel &old)=0
	Init data on this level from another AmrLevel (during regrid). This is a pure virtual function and hence MUST be implemented by derived classes.
virtual void	init ()=0
void	reset ()
	Reset data to initial time by swapping new and old time slots.
int	Level () const noexcept
	Returns this AmrLevel index (0 = coarsest).
const BoxArray &	boxArray () const noexcept
	List of grids at this level.
const BoxArray &	getEdgeBoxArray (int dir) const noexcept
	Return the edge-centered grid layout for direction dir (cached).
const BoxArray &	getNodalBoxArray () const noexcept
	Return the nodal grid layout for this level (cached).
const DistributionMapping &	DistributionMap () const noexcept
const FabFactory< FArrayBox > &	Factory () const noexcept
const EBFArrayBoxFactory &	EBFactory () const noexcept
int	numGrids () const noexcept
	Number of grids at this level.
int	numStates () const noexcept
	Number of states at this level.
const Box &	Domain () const noexcept
	Returns the indices defining physical domain.
int	nStep () const noexcept
	Timestep n at this level.
const Geometry &	Geom () const noexcept
	Returns the geometry object.
const IntVect &	fineRatio () const noexcept
Long	countCells () const noexcept
	Returns number of valid cells on this level.
const BoxArray &	getAreaNotToTag () noexcept
	Get the cached BoxArray describing regions that should not be tagged.
const Box &	getAreaToTag () noexcept
	Get the Box (single region) that is permitted to be tagged.
void	constructAreaNotToTag ()
	Build internal data structures defining the area not to tag.
void	setAreaNotToTag (BoxArray &ba) noexcept
	Override the area-not-to-tag cache with user-supplied BoxArray ba.
void	resetFillPatcher ()
	Clear cached FillPatcher objects (call after reflux/averaging).
virtual void	errorEst (TagBoxArray &tb, int clearval, int tagval, Real time, int n_error_buf=0, int ngrow=0)=0
	Error estimation for regridding. This is a pure virtual function and hence MUST be implemented by derived classes.
void	FillCoarsePatch (MultiFab &mf, int dcomp, Real time, int state_idx, int scomp, int ncomp, int nghost=0)
	Interpolate from coarse level to the valid area in mf.
virtual void	setPhysBoundaryValues (FArrayBox &dest, int state_indx, Real time, int dest_comp, int src_comp, int num_comp)
	Apply physical boundary conditions to cell-centered data.
virtual std::unique_ptr< MultiFab >	derive (const std::string &name, Real time, int ngrow)
	Returns a MultiFab containing the derived data for this level. If ngrow>0 the MultiFab is built on the appropriately grown BoxArray.
virtual void	derive (const std::string &name, Real time, MultiFab &mf, int dcomp)
	This version of derive() fills the component range of mf starting at dcomp with the derived quantity.
StateData &	get_state_data (int state_indx) noexcept
	State data object accessor for descriptor state_indx.
MultiFab &	get_old_data (int state_indx) noexcept
	Mutable access to the MultiFab at the old time slot for state state_indx.
const MultiFab &	get_old_data (int state_indx) const noexcept
	Const access to the MultiFab at the old time slot for state state_indx.
MultiFab &	get_new_data (int state_indx) noexcept
	Mutable access to the MultiFab at the new time slot for state state_indx.
const MultiFab &	get_new_data (int state_indx) const noexcept
	Const access to the MultiFab at the new time slot for state state_indx.
int	postStepRegrid () const noexcept
	Returns whether a post-timestep regrid is currently requested (nonzero for true).
void	setPostStepRegrid (int new_val) noexcept
	Set the post-timestep regrid trigger (nonzero requests a regrid).
void	UpdateDistributionMaps (DistributionMapping &dmap)
	Update every StateData's DistributionMapping to match dmap (e.g., after rebalancing).
Vector< int >	getBCArray (int State_Type, int gridno, int strt_comp, int ncomp)
	Return an array describing boundary types for components [strt_comp,strt_comp+ncomp).
MultiFab &	get_data (int state_indx, Real time)
	Fetch the MultiFab (old or new) that best matches time for state state_indx.
virtual void	set_preferred_boundary_values (MultiFab &S, int state_index, int scomp, int dcomp, int ncomp, Real time) const
	Hook to override fillpatched boundary values before applying physical BCs (default no-op).
virtual void	manual_tags_placement (TagBoxArray &tags, const Vector< IntVect > &bf_lev)
	Adjust tags after core tagging routines run (default: no-op).
virtual void	setPlotVariables ()
	Override to customize which variables appear in full plotfiles on this level (default uses global list).
virtual void	setSmallPlotVariables ()
	Override to customize which variables appear in small plotfiles on this level.
virtual Real	estimateWork ()
	Estimate the amount of work required to advance just this level, typically based on cell counts.
virtual int	WorkEstType ()
	Select which state descriptor drives work estimates.
TimeLevel	which_time (int state_indx, Real time) const noexcept
	Returns one the TimeLevel enums. Asserts that time is between AmrOldTime and AmrNewTime.
virtual bool	checkPointNow ()
	Return true if this level requests an immediate checkpoint (default false).
virtual bool	writePlotNow ()
	Return true if this level requests an immediate plotfile (default false).
virtual bool	writeSmallPlotNow ()
	Return true if this level requests an immediate small-plot file (default false).
virtual void	particle_redistribute (int lbase=0, bool a_init=false)
	Optional particle redistribution hook called by the parent Amr object.
void	FillPatcherFill (amrex::MultiFab &mf, int dcomp, int ncomp, int nghost, amrex::Real time, int state_index, int scomp)
	Fill ghost cells using cached FillPatcher (level>0) or FillPatch (level 0).
template<typename F , typename P = RungeKutta::PostStageNoOp>
void	RK (int order, int state_type, Real time, Real dt, int iteration, int ncycle, F &&f, P &&p=RungeKutta::PostStageNoOp())
	Evolve one step with Runge-Kutta (2, 3, or 4)

Static Public Member Functions
static bool	isStateVariable (const std::string &name, int &state_indx, int &ncomp)
	Return true if name matches a registered state variable, also providing descriptor info.
static void	FlushFPICache ()
	Resize/clear cached FillPatchIterator state in preparation for new fill operations.
static const DescriptorList &	get_desc_lst () noexcept
	Returns list of Descriptors.
static DeriveList &	get_derive_lst () noexcept
	Returns list of derived variables.
static void	FillPatch (AmrLevel &amrlevel, MultiFab &leveldata, int boxGrow, Real time, int index, int scomp, int ncomp, int dcomp=0)
	Convenience wrapper around FillPatchSingleLevel/TwoLevels.
static void	FillPatchAdd (AmrLevel &amrlevel, MultiFab &leveldata, int boxGrow, Real time, int index, int scomp, int ncomp, int dcomp=0)
	Same as FillPatch(), but adds into leveldata instead of overwriting.
static void	SetEBMaxGrowCells (int nbasic, int nvolume, int nfull) noexcept
	Configure the ghost-cell requirements (basic/volume/full) for EB FillPatch operations.
static void	SetEBSupportLevel (EBSupport ebs)
	Select which level of EB data to build (basic, volume, full) via ebs.
static IntVect	ProperBlockingFactor (AmrLevel const &amr_level, int boxGrow, IndexType const &boxType, StateDescriptor const &desc, int SComp)
	Recommendation of a proper blocking factor for filling.

Static Public Attributes
static int	m_eb_basic_grow_cells = 5
static int	m_eb_volume_grow_cells = 4
static int	m_eb_full_grow_cells = 2
static EBSupport	m_eb_support_level = EBSupport::volume

Protected Member Functions
	AmrLevel () noexcept
	The constructors – for derived classes.
	AmrLevel (Amr &papa, int lev, const Geometry &level_geom, const BoxArray &ba, const DistributionMapping &dm, Real time)
void	finishConstructor ()
	Common code used by all constructors.

Protected Attributes
int	level {-1}
Geometry	geom
BoxArray	grids
DistributionMapping	dmap
Amr *	parent {nullptr}
IntVect	crse_ratio
IntVect	fine_ratio
Vector< StateData >	state
BoxArray	m_AreaNotToTag
Box	m_AreaToTag
int	post_step_regrid {0}
bool	levelDirectoryCreated {false}
std::unique_ptr< FabFactory< FArrayBox > >	m_factory
Vector< std::unique_ptr< FillPatcher< MultiFab > > >	m_fillpatcher

Static Protected Attributes
static DeriveList	derive_lst
static DescriptorList	desc_lst

Friends
class	Amr
class	FillPatchIterator
class	FillPatchIteratorHelper

Detailed Description

Virtual base class for managing individual levels. AmrLevel functions both as a container for state data on a level and also manages the advancement of data in time.

Member Enumeration Documentation

TimeLevel

enum amrex::AmrLevel::TimeLevel

What time are we at?

Enumerator
AmrOldTime
AmrHalfTime
AmrNewTime
Amr1QtrTime
Amr3QtrTime
AmrOtherTime

Constructor & Destructor Documentation

~AmrLevel()

amrex::AmrLevel::~AmrLevel ( )

virtual

The destructor.

AmrLevel() [1/4]

amrex::AmrLevel::AmrLevel ( const AmrLevel &  )

delete

Disable copying because AmrLevel owns state data and geometry caches.

AmrLevel() [2/4]

amrex::AmrLevel::AmrLevel ( AmrLevel &&  )

delete

Disable moving; derived classes manage non-movable FillPatch caches.

AmrLevel() [3/4]

amrex::AmrLevel::AmrLevel ( )

inlineprotectednoexcept

The constructors – for derived classes.

AmrLevel() [4/4]

amrex::AmrLevel::AmrLevel ( Amr &  papa, int  lev, const Geometry &  level_geom, const BoxArray &  ba, const DistributionMapping &  dm, Real  time  )

protected

Member Function Documentation

advance()

virtual Real amrex::AmrLevel::advance ( Real  time, Real  dt, int  iteration, int  ncycle  )

pure virtual

Advance solution on this level by dt and return the next stable dt.

Parameters

time	Start time of the advance.
dt	Step size to take.
iteration	Sub-step counter within the coarse step.
ncycle	Number of fine subcycles per coarse step.

Returns

Recommended dt for the next call (based on CFL, etc.).

allocOldData()

void amrex::AmrLevel::allocOldData ( )

virtual

Allocate storage for "old" time slices before an advance.

boxArray()

const BoxArray & amrex::AmrLevel::boxArray ( ) const

inlinenoexcept

List of grids at this level.

checkPoint()

void amrex::AmrLevel::checkPoint ( const std::string &  dir, std::ostream &  os, VisMF::How  how = VisMF::NFiles, bool  dump_old = true  )

virtual

Write current state to a checkpoint directory.

Parameters

dir	Destination directory (e.g., chk00010).
os	Metadata stream shared across levels.
how	VisMF write mode.
dump_old	Whether to include the "old" state data.

checkPointNow()

bool amrex::AmrLevel::checkPointNow ( )

virtual

Return true if this level requests an immediate checkpoint (default false).

Overrides can trigger checkpointing after conditional events.

checkPointPost()

void amrex::AmrLevel::checkPointPost ( const std::string &  dir, std::ostream &  os  )

virtual

Do post-checkpoint cleanup for dir once writes complete.

Parameters

dir	Checkpoint directory that was just written.
os	Metadata stream used during writing.

checkPointPre()

void amrex::AmrLevel::checkPointPre ( const std::string &  dir, std::ostream &  os  )

virtual

Do pre-checkpoint work (e.g., directory creation) for dir using os.

Parameters

dir	Checkpoint directory being created.
os	Metadata stream for header output.

computeInitialDt()

virtual void amrex::AmrLevel::computeInitialDt ( int  finest_level, int  sub_cycle, Vector< int > &  n_cycle, const Vector< IntVect > &  ref_ratio, Vector< Real > &  dt_level, Real  stop_time  )

pure virtual

Compute the initial time step size for each level.

Parameters

finest_level	Finest AMR level existing so far.
sub_cycle	Whether subcycling is enabled.
n_cycle	In/out: number of subcycles per level.
ref_ratio	Level-to-level refinement ratios.
dt_level	Output per-level dt.
stop_time	Simulation stop time (used to clamp dt if needed).

computeNewDt()

virtual void amrex::AmrLevel::computeNewDt ( int  finest_level, int  sub_cycle, Vector< int > &  n_cycle, const Vector< IntVect > &  ref_ratio, Vector< Real > &  dt_min, Vector< Real > &  dt_level, Real  stop_time, int  post_regrid_flag  )

pure virtual

Compute the next time step sizes after an advance.

Parameters

finest_level	Finest AMR level existing.
sub_cycle	Whether subcycling is enabled.
n_cycle	In/out: number of subcycles per level.
ref_ratio	Level-to-level refinement ratios.
dt_min	Output per-level dt upper bounds (physics-limited).
dt_level	Output per-level dt to use.
stop_time	Simulation stop time (used to clamp dt).
post_regrid_flag	Flag describing regrid state (0 normal, 1 immediate post-regrid).

constructAreaNotToTag()

void amrex::AmrLevel::constructAreaNotToTag

(

)

Build internal data structures defining the area not to tag.

countCells()

Long amrex::AmrLevel::countCells ( ) const

noexcept

Returns number of valid cells on this level.

CreateLevelDirectory()

void amrex::AmrLevel::CreateLevelDirectory ( const std::string &  dir )

virtual

Create the Level_* directory inside dir (if needed) before writing plots/checkpoints.

Parameters

dir	Base output directory (plot or checkpoint root).

derive() [1/2]

std::unique_ptr< MultiFab > amrex::AmrLevel::derive ( const std::string &  name, Real  time, int  ngrow  )

virtual

Returns a MultiFab containing the derived data for this level. If ngrow>0 the MultiFab is built on the appropriately grown BoxArray.

Parameters

name	Derived quantity identifier.
time	Physical time at which to evaluate the quantity.
ngrow	How many ghost cells to include.

Returns

Owning pointer to a freshly allocated MultiFab.

derive() [2/2]

void amrex::AmrLevel::derive ( const std::string &  name, Real  time, MultiFab &  mf, int  dcomp  )

virtual

This version of derive() fills the component range of mf starting at dcomp with the derived quantity.

Parameters

name	Derived quantity identifier.
time	Physical time at which to evaluate the quantity.
mf	Destination MultiFab.
dcomp	Starting destination component index.

DistributionMap()

const DistributionMapping & amrex::AmrLevel::DistributionMap ( ) const

inlinenoexcept

Domain()

const Box & amrex::AmrLevel::Domain ( ) const

inlinenoexcept

Returns the indices defining physical domain.

EBFactory()

const EBFArrayBoxFactory & amrex::AmrLevel::EBFactory ( ) const

inlinenoexcept

errorEst()

virtual void amrex::AmrLevel::errorEst ( TagBoxArray &  tb, int  clearval, int  tagval, Real  time, int  n_error_buf = 0, int  ngrow = 0  )

pure virtual

Error estimation for regridding. This is a pure virtual function and hence MUST be implemented by derived classes.

Parameters

tb	Tag array to mark for refinement (output).
clearval	Value that clears a tag entry.
tagval	Value that marks a cell for refinement.
time	Physical time at which tagging occurs.
n_error_buf	Number of grow cells added around tagged features (default 0).
ngrow	Number of ghost layers available in tb (default 0).

estimateWork()

Real amrex::AmrLevel::estimateWork ( )

virtual

Estimate the amount of work required to advance just this level, typically based on cell counts.

Returns

Work units proportional to the expected compute effort (higher means more expensive).

Factory()

const FabFactory< FArrayBox > & amrex::AmrLevel::Factory ( ) const

inlinenoexcept

FillCoarsePatch()

void amrex::AmrLevel::FillCoarsePatch	(	MultiFab &	mf,
		int	dcomp,
		Real	time,
		int	state_idx,
		int	scomp,
		int	ncomp,
		int	nghost = 0
	)

Interpolate from coarse level to the valid area in mf.

Fill mf on this level using data interpolated from the coarser level.

Parameters

mf	Destination MultiFab.
dcomp	Destination component offset in mf.
time	Time at which to sample coarse data.
state_idx	State descriptor index selecting which state to fill.
scomp	Source component index within the coarse state.
ncomp	Number of components to fill.
nghost	Number of ghost cells to fill (default 0).

FillPatch()

void amrex::AmrLevel::FillPatch ( AmrLevel &  amrlevel, MultiFab &  leveldata, int  boxGrow, Real  time, int  index, int  scomp, int  ncomp, int  dcomp = 0  )

static

Convenience wrapper around FillPatchSingleLevel/TwoLevels.

Parameters

amrlevel	Level providing state data.
leveldata	Destination MultiFab to fill.
boxGrow	Number of grow cells to request.
time	Time at which to sample.
index	State descriptor index.
scomp	Source component.
ncomp	Number of components.
dcomp	Destination component (default 0).

FillPatchAdd()

void amrex::AmrLevel::FillPatchAdd ( AmrLevel &  amrlevel, MultiFab &  leveldata, int  boxGrow, Real  time, int  index, int  scomp, int  ncomp, int  dcomp = 0  )

static

Same as FillPatch(), but adds into leveldata instead of overwriting.

Parameters

amrlevel	Level providing state data.
leveldata	Destination MultiFab to accumulate into.
boxGrow	Number of grow cells to request.
time	Time at which to sample.
index	State descriptor index.
scomp	Source component.
ncomp	Number of components.
dcomp	Destination component (default 0).

FillPatcherFill()

void amrex::AmrLevel::FillPatcherFill	(	amrex::MultiFab &	mf,
		int	dcomp,
		int	ncomp,
		int	nghost,
		amrex::Real	time,
		int	state_index,
		int	scomp
	)

Fill ghost cells using cached FillPatcher (level>0) or FillPatch (level 0).

All components in [scomp,scomp+ncomp) must have the same interpolater. Because the FillPatcher is cached per state, that interpolater must also be the one used by earlier calls for the same state_index.

Parameters

mf	Destination MultiFab.
dcomp	Destination component offset.
ncomp	Number of components to fill.
nghost	Number of ghost cells to fill.
time	Time at which to sample data.
state_index	State descriptor index to pull from.
scomp	Source component offset within the state.

fineRatio()

const IntVect & amrex::AmrLevel::fineRatio ( ) const

inlinenoexcept

finishConstructor()

void amrex::AmrLevel::finishConstructor ( )

protected

Common code used by all constructors.

FlushFPICache()

static void amrex::AmrLevel::FlushFPICache ( )

static

Resize/clear cached FillPatchIterator state in preparation for new fill operations.

Geom()

const Geometry & amrex::AmrLevel::Geom ( ) const

inlinenoexcept

Returns the geometry object.

get_data()

MultiFab & amrex::AmrLevel::get_data	(	int	state_indx,
		Real	time
	)

Fetch the MultiFab (old or new) that best matches time for state state_indx.

Parameters

state_indx	State descriptor index.
time	Target physical time.

Returns

Reference to either the old or new MultiFab, whichever brackets time.

get_derive_lst()

DeriveList & amrex::AmrLevel::get_derive_lst ( )

staticnoexcept

Returns list of derived variables.

get_desc_lst()

static const DescriptorList & amrex::AmrLevel::get_desc_lst ( )

inlinestaticnoexcept

Returns list of Descriptors.

get_new_data() [1/2]

const MultiFab & amrex::AmrLevel::get_new_data ( int  state_indx ) const

inlinenoexcept

Const access to the MultiFab at the new time slot for state state_indx.

get_new_data() [2/2]

MultiFab & amrex::AmrLevel::get_new_data ( int  state_indx )

inlinenoexcept

Mutable access to the MultiFab at the new time slot for state state_indx.

get_old_data() [1/2]

const MultiFab & amrex::AmrLevel::get_old_data ( int  state_indx ) const

inlinenoexcept

Const access to the MultiFab at the old time slot for state state_indx.

get_old_data() [2/2]

MultiFab & amrex::AmrLevel::get_old_data ( int  state_indx )

inlinenoexcept

Mutable access to the MultiFab at the old time slot for state state_indx.

get_state_data()

StateData & amrex::AmrLevel::get_state_data ( int  state_indx )

inlinenoexcept

State data object accessor for descriptor state_indx.

getAreaNotToTag()

const BoxArray & amrex::AmrLevel::getAreaNotToTag ( )

noexcept

Get the cached BoxArray describing regions that should not be tagged.

getAreaToTag()

const Box & amrex::AmrLevel::getAreaToTag ( )

noexcept

Get the Box (single region) that is permitted to be tagged.

getBCArray()

Vector< int > amrex::AmrLevel::getBCArray	(	int	State_Type,
		int	gridno,
		int	strt_comp,
		int	ncomp
	)

Return an array describing boundary types for components [strt_comp,strt_comp+ncomp).

Parameters

State_Type	State descriptor index.
gridno	Grid index on this level.
strt_comp	Starting component.
ncomp	Number of components.

getEdgeBoxArray()

const BoxArray & amrex::AmrLevel::getEdgeBoxArray ( int  dir ) const

noexcept

Return the edge-centered grid layout for direction dir (cached).

getNodalBoxArray()

const BoxArray & amrex::AmrLevel::getNodalBoxArray ( ) const

noexcept

Return the nodal grid layout for this level (cached).

init() [1/2]

virtual void amrex::AmrLevel::init ( )

pure virtual

Init data on this level after regridding if old AmrLevel did not previously exist. This is a pure virtual function and hence MUST be implemented by derived classes.

init() [2/2]

virtual void amrex::AmrLevel::init ( AmrLevel &  old )

pure virtual

Init data on this level from another AmrLevel (during regrid). This is a pure virtual function and hence MUST be implemented by derived classes.

Parameters

old	Source level to interpolate from.

initData()

virtual void amrex::AmrLevel::initData ( )

pure virtual

Init grid data at problem start-up. This is a pure virtual function and hence MUST be implemented by derived classes.

isStateVariable()

bool amrex::AmrLevel::isStateVariable ( const std::string &  name, int &  state_indx, int &  ncomp  )

static

Return true if name matches a registered state variable, also providing descriptor info.

Parameters

name	State variable identifier.
state_indx	Output: descriptor index when found.
ncomp	Output: number of components associated with that state.

Level()

int amrex::AmrLevel::Level ( ) const

inlinenoexcept

Returns this AmrLevel index (0 = coarsest).

LevelDirectoryNames()

void amrex::AmrLevel::LevelDirectoryNames	(	const std::string &	dir,
		std::string &	LevelDir,
		std::string &	FullPath
	)		const

Derive the directory name for this level inside a plot/checkpoint tree.

Parameters

dir	Root directory (typically plot or checkpoint folder).
LevelDir	Output: relative level directory (e.g., Level_3).
FullPath	Output: absolute path combining dir and LevelDir.

manual_tags_placement()

void amrex::AmrLevel::manual_tags_placement ( TagBoxArray &  tags, const Vector< IntVect > &  bf_lev  )

virtual

Adjust tags after core tagging routines run (default: no-op).

Parameters

tags	Tag arrays built on this level.
bf_lev	Buffer sizes per level from Amr.

nStep()

int amrex::AmrLevel::nStep ( ) const

inlinenoexcept

Timestep n at this level.

numGrids()

int amrex::AmrLevel::numGrids ( ) const

inlinenoexcept

Number of grids at this level.

numStates()

int amrex::AmrLevel::numStates ( ) const

inlinenoexcept

Number of states at this level.

okToContinue()

virtual int amrex::AmrLevel::okToContinue ( )

inlinevirtual

Return nonzero to continue advancing; zero to halt the run.

okToRegrid()

int amrex::AmrLevel::okToRegrid ( )

virtual

Return nonzero if refinement starting from this level is allowed this cycle.

Only evaluated when regrid_int > 0 and level_count >= regrid_int. Default returns true.

operator=() [1/2]

AmrLevel & amrex::AmrLevel::operator= ( AmrLevel &&  )

delete

Move assignment is also disabled—use factory methods instead.

operator=() [2/2]

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

delete

Copy assignment is undefined for the same ownership reasons.

particle_redistribute()

virtual void amrex::AmrLevel::particle_redistribute ( int  lbase = 0, bool  a_init = false  )

inlinevirtual

Optional particle redistribution hook called by the parent Amr object.

Parameters

lbase	Coarsest level whose particles should be considered.
a_init	Whether the call happens during initialization.

post_init()

virtual void amrex::AmrLevel::post_init ( Real  stop_time )

pure virtual

Operations to run after initialization finishes.

Parameters

stop_time

Simulation stop time (useful for multi-stage inits).

post_regrid()

virtual void amrex::AmrLevel::post_regrid ( int  lbase, int  new_finest  )

pure virtual

Operations to be performed immediately after regridding completes.

Parameters

lbase	Coarsest level that triggered the regrid.
new_finest	New finest level index after regridding.

post_restart()

virtual void amrex::AmrLevel::post_restart ( )

inlinevirtual

Override to perform any fixups immediately after restart (default: no-op).

post_timestep()

void amrex::AmrLevel::post_timestep ( int  iteration )

virtual

Perform level-specific updates after each subcycle.

Parameters

iteration

Sub-step index within the coarse step.

Note

Override implementations should reset any FillPatcher caches they own.

postCoarseTimeStep()

void amrex::AmrLevel::postCoarseTimeStep ( Real  time )

virtual

Called once per coarse step after fine levels finish refluxing.

Parameters

time	Current coarse-level time.

postStepRegrid()

int amrex::AmrLevel::postStepRegrid ( ) const

inlinenoexcept

Returns whether a post-timestep regrid is currently requested (nonzero for true).

ProperBlockingFactor()

IntVect amrex::AmrLevel::ProperBlockingFactor ( AmrLevel const &  amr_level, int  boxGrow, IndexType const &  boxType, StateDescriptor const &  desc, int  SComp  )

static

Recommendation of a proper blocking factor for filling.

Parameters

amr_level	Owning level supplying geometry.
boxGrow	Grow cells requested by the caller.
boxType	Index type (cell-centered, nodal, etc.).
desc	State descriptor tied to the data.
SComp	Starting component index.

removeOldData()

void amrex::AmrLevel::removeOldData ( )

virtual

Delete the old-time slots once they are no longer needed.

reset()

void amrex::AmrLevel::reset

(

)

Reset data to initial time by swapping new and old time slots.

resetFillPatcher()

void amrex::AmrLevel::resetFillPatcher

(

)

Clear cached FillPatcher objects (call after reflux/averaging).

restart()

void amrex::AmrLevel::restart ( Amr &  papa, std::istream &  is, bool  bReadSpecial = false  )

virtual

Populate this level from checkpoint input stream is.

Parameters

papa	Owning Amr driver (provides geometry and config).
is	Input stream pointing at the level's checkpoint data.
bReadSpecial	Whether to parse additional application-specific fields.

RK()

template<typename F , typename P >

void amrex::AmrLevel::RK	(	int	order,
		int	state_type,
		Real	time,
		Real	dt,
		int	iteration,
		int	ncycle,
		F &&	f,
		P &&	p = RungeKutta::PostStageNoOp()
	)

Evolve one step with Runge-Kutta (2, 3, or 4)

To use RK, the StateData must have all the ghost cells needed. See namespace RungeKutta for expected function signatures of the callable parameters. All components of the StateData must have the same interpolater. Note that RK3 and RK4 do not support post-step regrid, because the coarse level RK data are lost when a level is rebuilt.

Parameters

order	order of RK
state_type	index of StateData
time	time at the beginning of the step.
dt	time step
iteration	iteration number on fine level during a coarse time step. For an AMR simulation with subcycling and a refinement ratio of 2, the number is either 1 or 2, denoting the first and second substep, respectively.
ncycle	number of subcyling steps. It's usually 2 or 4. Without subcycling, this will be 1.
f	computing right-hand side for evolving the StateData. One can also register data for flux registers in this.
p	optionally post-processing RK stage results

set_preferred_boundary_values()

void amrex::AmrLevel::set_preferred_boundary_values ( MultiFab &  S, int  state_index, int  scomp, int  dcomp, int  ncomp, Real  time  ) const

virtual

Hook to override fillpatched boundary values before applying physical BCs (default no-op).

Parameters

S	MultiFab to edit.
state_index	State descriptor index.
scomp	Source component offset.
dcomp	Destination component offset.
ncomp	Number of components to adjust.
time	Physical time at which BCs are evaluated.

set_state_in_checkpoint()

void amrex::AmrLevel::set_state_in_checkpoint ( Vector< int > &  state_in_checkpoint )

virtual

Hook to adjust which state descriptors are expected in checkpoint streams.

Parameters

state_in_checkpoint

Array of flags (one per descriptor) that this level may modify.

setAreaNotToTag()

void amrex::AmrLevel::setAreaNotToTag ( BoxArray &  ba )

noexcept

Override the area-not-to-tag cache with user-supplied BoxArray ba.

SetEBMaxGrowCells()

static void amrex::AmrLevel::SetEBMaxGrowCells ( int  nbasic, int  nvolume, int  nfull  )

inlinestaticnoexcept

Configure the ghost-cell requirements (basic/volume/full) for EB FillPatch operations.

SetEBSupportLevel()

static void amrex::AmrLevel::SetEBSupportLevel ( EBSupport  ebs )

inlinestatic

Select which level of EB data to build (basic, volume, full) via ebs.

SetLevelDirectoryCreated()

void amrex::AmrLevel::SetLevelDirectoryCreated ( bool  ldc )

inlinenoexcept

Record whether CreateLevelDirectory() has already created the folder.

Parameters

ldc	True if the level directory exists; false to clear the flag.

setPhysBoundaryValues()

void amrex::AmrLevel::setPhysBoundaryValues ( FArrayBox &  dest, int  state_indx, Real  time, int  dest_comp, int  src_comp, int  num_comp  )

virtual

Apply physical boundary conditions to cell-centered data.

Parameters

dest	Destination FArrayBox.
state_indx	State descriptor index associated with dest.
time	Physical time at which BCs should be evaluated.
dest_comp	Destination component offset in dest.
src_comp	Component offset in the state data.
num_comp	Number of components to update.

setPlotVariables()

void amrex::AmrLevel::setPlotVariables ( )

virtual

Override to customize which variables appear in full plotfiles on this level (default uses global list).

setPostStepRegrid()

void amrex::AmrLevel::setPostStepRegrid ( int  new_val )

inlinenoexcept

Set the post-timestep regrid trigger (nonzero requests a regrid).

Parameters

new_val

Trigger value applied after each step.

setSmallPlotVariables()

void amrex::AmrLevel::setSmallPlotVariables ( )

virtual

Override to customize which variables appear in small plotfiles on this level.

setTimeLevel()

void amrex::AmrLevel::setTimeLevel ( Real  time, Real  dt_old, Real  dt_new  )

virtual

Set the time metadata stored in the state data arrays (old/new).

Parameters

time	New-time value to record.
dt_old	Dt associated with the old slot.
dt_new	Dt associated with the new slot.

thePlotFileType()

virtual std::string amrex::AmrLevel::thePlotFileType ( ) const

inlinevirtual

A string written as the first item in writePlotFile() at level zero. It is so we can distinguish between different types of plot files. This default "HyperCLaw-V1.1" is for VisIt software and some of our internal postprocessing routines.

< Default identifier consumed by VisIt and AMReX tools.

UpdateDistributionMaps()

void amrex::AmrLevel::UpdateDistributionMaps

(

DistributionMapping &

dmap

)

Update every StateData's DistributionMapping to match dmap (e.g., after rebalancing).

Update the distribution maps in StateData based on the size of the map.

Parameters

dmap	Distribution mapping describing the new ownership.

which_time()

AmrLevel::TimeLevel amrex::AmrLevel::which_time ( int  state_indx, Real  time  ) const

noexcept

Returns one the TimeLevel enums. Asserts that time is between AmrOldTime and AmrNewTime.

Parameters

state_indx	State descriptor index providing time metadata.
time	Target physical time.

WorkEstType()

virtual int amrex::AmrLevel::WorkEstType ( )

inlinevirtual

Select which state descriptor drives work estimates.

Returns

State descriptor index used for estimateWork() sampling, or -1 to disable.

writePlotFile()

void amrex::AmrLevel::writePlotFile ( const std::string &  dir, std::ostream &  os, VisMF::How  how = VisMF::NFiles  )

virtual

Write plot file data for this level into directory dir.

Parameters

dir	Output root (e.g., plt00010).
os	Metadata stream shared across levels.
how	VisMF write mode (NFiles or OneFilePerCPU).

writePlotFilePost()

void amrex::AmrLevel::writePlotFilePost ( const std::string &  dir, std::ostream &  os  )

virtual

Perform post-plotfile cleanup for directory dir once writes complete.

Parameters

dir	Plotfile directory that was just written.
os	Metadata stream (same one passed to writePlotFilePre()).

writePlotFilePre()

void amrex::AmrLevel::writePlotFilePre ( const std::string &  dir, std::ostream &  os  )

virtual

Perform pre-plotfile operations (e.g., gather metadata) for directory dir using os.

Parameters

dir	Plotfile directory about to be written.
os	Stream receiving metadata (often the Header).

writePlotNow()

bool amrex::AmrLevel::writePlotNow ( )

virtual

Return true if this level requests an immediate plotfile (default false).

writeSmallPlotFile()

virtual void amrex::AmrLevel::writeSmallPlotFile ( const std::string &  dir, std::ostream &  os, VisMF::How  how = VisMF::NFiles  )

inlinevirtual

Write a reduced plot file (same parameters as writePlotFile()) to dir.

Parameters

dir	Target directory.
os	Metadata stream.
how	VisMF write mode.

writeSmallPlotNow()

bool amrex::AmrLevel::writeSmallPlotNow ( )

virtual

Return true if this level requests an immediate small-plot file (default false).

Friends And Related Symbol Documentation

Amr

friend class Amr

friend

FillPatchIterator

friend class FillPatchIterator

friend

FillPatchIteratorHelper

friend class FillPatchIteratorHelper

friend

Member Data Documentation

crse_ratio

IntVect amrex::AmrLevel::crse_ratio

protected

derive_lst

DeriveList amrex::AmrLevel::derive_lst

staticprotected

desc_lst

DescriptorList amrex::AmrLevel::desc_lst

staticprotected

dmap

DistributionMapping amrex::AmrLevel::dmap

protected

fine_ratio

IntVect amrex::AmrLevel::fine_ratio

protected

geom

Geometry amrex::AmrLevel::geom

protected

grids

BoxArray amrex::AmrLevel::grids

protected

level

int amrex::AmrLevel::level {-1}

protected

levelDirectoryCreated

bool amrex::AmrLevel::levelDirectoryCreated {false}

protected

m_AreaNotToTag

BoxArray amrex::AmrLevel::m_AreaNotToTag

protected

m_AreaToTag

Box amrex::AmrLevel::m_AreaToTag

protected

m_eb_basic_grow_cells

int amrex::AmrLevel::m_eb_basic_grow_cells = 5

static

m_eb_full_grow_cells

int amrex::AmrLevel::m_eb_full_grow_cells = 2

static

m_eb_support_level

EBSupport amrex::AmrLevel::m_eb_support_level = EBSupport::volume

static

m_eb_volume_grow_cells

int amrex::AmrLevel::m_eb_volume_grow_cells = 4

static

m_factory

std::unique_ptr<FabFactory<FArrayBox> > amrex::AmrLevel::m_factory

protected

m_fillpatcher

Vector<std::unique_ptr<FillPatcher<MultiFab> > > amrex::AmrLevel::m_fillpatcher

protected

parent

Amr* amrex::AmrLevel::parent {nullptr}

protected

post_step_regrid

int amrex::AmrLevel::post_step_regrid {0}

protected

state

Vector<StateData> amrex::AmrLevel::state

protected

---

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

• /home/runner/work/amrex/amrex/Src/Amr/AMReX_AmrLevel.H
• /home/runner/work/amrex/amrex/Src/Amr/AMReX_AmrLevel.cpp