Current and previous level-time data. More...

#include <AMReX_StateData.H>

Public Member Functions
	StateData ()
	The default constructor.

	StateData (const Box &p_domain, const BoxArray &grds, const DistributionMapping &dm, const StateDescriptor *d, Real cur_time, Real dt, const FabFactory< FArrayBox > &factory)
	Construct and allocate state storage for a level.

	~StateData ()
	The destructor.

	StateData (StateData &&rhs) noexcept
	Move constructor; transfers ownership of stored MultiFabs and metadata.

StateData &	operator= (StateData const &rhs)
	Copy-assignment; deep-copies metadata and allocates new FAB storage.

	StateData (StateData const &rhs)=delete
	Copy construction is disabled to avoid ambiguous ownership of state buffers.

StateData &	operator= (StateData &&rhs)=delete
	Move assignment is disabled (use define()/swap helpers instead).

void	define (const Box &p_domain, const BoxArray &grds, const DistributionMapping &dm, const StateDescriptor &d, Real cur_time, Real dt, const FabFactory< FArrayBox > &factory)
	Initialize the object after default construction.

void	copyOld (const StateData &state)
	Copy the "old" time slice from `state`, allocating storage if needed.

void	copyNew (const StateData &state)
	Copy the "new" time slice from `state`, allocating storage if needed.

void	allocOldData ()
	Allocates space for old timestep data.

void	removeOldData ()
	Deletes the space used by the old timestep data.

void	reset ()
	Reverts back to initial state.

void	swapTimeLevels (Real dt)
	Old data becomes new data and new time is incremented by `dt`.

void	replaceOldData (MultiFab &&mf)
	Swaps old data with a new MultiFab. Deletes the previous old data.

void	replaceOldData (StateData &s)
	Swaps old data with another StateData. Does not delete the previous old data.

void	replaceNewData (MultiFab &&mf)
	Swaps new data with a new MultiFab. Deletes the previous new data.

void	replaceNewData (StateData &s)
	Swaps new data with another StateData. Does not delete the previous new data.

void	setTimeLevel (Real time, Real dt_old, Real dt_new)
	Sets time of old and new data.

void	setOldTimeLevel (Real time)
	Sets time of old data.

void	setNewTimeLevel (Real time)
	Sets time of new data.

void	syncNewTimeLevel (Real time)
	Set both start/stop endpoints of the new-time interval to `time`.

void	RegisterData (MultiFabCopyDescriptor &multiFabCopyDesc, Vector< MultiFabId > &mfid)
	Register the state data with a MultiFabCopyDescriptor for later interpolation/fills.

void	InterpAddBox (MultiFabCopyDescriptor &multiFabCopyDesc, Vector< MultiFabId > &mfid, BoxList *returnedUnfillableBoxes, Vector< FillBoxId > &returnedFillBoxIds, const Box &subbox, Real time, int src_comp, int dest_comp, int num_comp, bool extrap=false)
	Request interpolation/copied data covering `subbox`.

void	InterpFillFab (MultiFabCopyDescriptor &fabCopyDesc, const Vector< MultiFabId > &mfid, const Vector< FillBoxId > &fillBoxIds, FArrayBox &dest, Real time, int src_comp, int dest_comp, int num_comp, bool extrap=false)
	Complete outstanding interpolation requests and fill `dest`.

void	FillBoundary (FArrayBox &dest, Real time, const Real *dx, const RealBox &prob_domain, int dest_comp, int src_comp, int num_comp=1)
	Set physical boundary values for a FAB extracted from the MultiFab.

void	FillBoundary (Box const &bx, FArrayBox &dest, Real time, Geometry const &geom, int dest_comp, int src_comp, int num_comp)

void	checkPoint (const std::string &name, const std::string &fullpathname, std::ostream &os, VisMF::How how, bool dump_old=true)
	Write the state data to a checkpoint file.

void	restart (std::istream &is, const Box &p_domain, const BoxArray &grds, const DistributionMapping &dm, const FabFactory< FArrayBox > &factory, const StateDescriptor &d, const std::string &chkfile)
	Restart with domain box, grids, and dmap provided.

void	restart (const StateDescriptor &d, const StateData &rhs)
	Initialize from another StateData sharing descriptor `d`.

const StateDescriptor *	descriptor () const noexcept
	Returns the StateDescriptor.

const Box &	getDomain () const noexcept
	Returns the valid domain.

const BoxArray &	boxArray () const noexcept
	Returns the BoxArray.

void	setBoxArray (BoxArray const &a_grids) noexcept
	Replace the stored BoxArray layout with `a_grids` (no redistribution occurs).

const DistributionMapping &	DistributionMap () const noexcept

void	setDistributionMap (DistributionMapping &new_dmap) noexcept
	Replace the stored DistributionMapping with `new_dmap` (no redistribution occurs).

const FabFactory< FArrayBox > &	Factory () const noexcept

void	setFactory (FabFactory< FArrayBox > const &a_factory)
	Replace the internal factory with a clone of `a_factory`.

Real	curTime () const noexcept
	Returns the current time.

Real	prevTime () const noexcept
	Returns the previous time.

MultiFab &	newData () noexcept
	Returns the new data.

const MultiFab &	newData () const noexcept
	Returns the new data.

MultiFab &	oldData () noexcept
	Returns the old data.

const MultiFab &	oldData () const noexcept
	Returns the old data.

FArrayBox &	newGrid (int i) noexcept
	Returns the FAB of new data at grid index `i`.

FArrayBox &	oldGrid (int i) noexcept
	Returns the FAB of old data at grid index `i`.

BCRec	getBC (int comp, int i) const noexcept
	Returns boundary conditions of specified component on the specified grid.

void	printTimeInterval (std::ostream &os) const
	Prints out the time interval.

bool	hasOldData () const noexcept
	True if there is any old data available.

bool	hasNewData () const noexcept
	True if there is any new data available.

void	getData (Vector< MultiFab * > &data, Vector< Real > &datatime, Real time) const
	Gather data pointers and their time stamps corresponding to `time`.

Arena *	getArena () const noexcept
	Get the Arena used.

void	setArena (Arena *ar) noexcept
	Set the Arena used for subsequent allocations to `ar`.

Static Public Member Functions
static const Vector< std::string > &	FabArrayHeaderNames ()
	These facilitate prereading FabArray headers to avoid synchronization when reading multiple FabArrays.

static void	ClearFabArrayHeaderNames ()
	Clear the cached list of FabArray header names.

static void	SetFAHeaderMapPtr (std::map< std::string, Vector< char > > *fahmp)
	Install a pointer `fahmp` to the global map storing pre-read FabArray headers.

Friends
class	StateDataPhysBCFunct

Detailed Description

Current and previous level-time data.

StateData holds state data on a level for the current and previous time step.

Constructor & Destructor Documentation

◆ StateData() [1/4]

amrex::StateData::StateData ( )

The default constructor.

◆ StateData() [2/4]

amrex::StateData::StateData	(	const Box &	p_domain,
		const BoxArray &	grds,
		const DistributionMapping &	dm,
		const StateDescriptor *	d,
		Real	cur_time,
		Real	dt,
		const FabFactory< FArrayBox > &	factory
	)

Construct and allocate state storage for a level.

Parameters

p_domain	Domain box of the AMR problem (used for BCs).
grds	Cell-centered BoxArray for this level.
dm	Distribution mapping describing ownership of grids.
d	State descriptor providing metadata (components, BCs, etc.).
cur_time	Current simulation time.
dt	Initial time step (dt_old = dt_new = dt).
factory	Fab factory controlling allocation (EB-aware, etc.).

◆ ~StateData()

amrex::StateData::~StateData ( )

The destructor.

◆ StateData() [3/4]

amrex::StateData::StateData ( StateData && rhs )

noexcept

Move constructor; transfers ownership of stored MultiFabs and metadata.

◆ StateData() [4/4]

amrex::StateData::StateData ( StateData const & rhs )

delete

Copy construction is disabled to avoid ambiguous ownership of state buffers.

Member Function Documentation

◆ allocOldData()

void amrex::StateData::allocOldData ( )

Allocates space for old timestep data.

◆ boxArray()

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

inlinenoexcept

Returns the BoxArray.

◆ checkPoint()

void amrex::StateData::checkPoint	(	const std::string &	name,
		const std::string &	fullpathname,
		std::ostream &	os,
		VisMF::How	how,
		bool	dump_old = `true`
	)

Write the state data to a checkpoint file.

Parameters

name	State name (prefix for component folders).
fullpathname	Directory that will hold the data.
os	Output stream for metadata.
how	VisMF write mode.
dump_old	Whether to include the old-time slot.

◆ ClearFabArrayHeaderNames()

static void amrex::StateData::ClearFabArrayHeaderNames ( )

inlinestatic

Clear the cached list of FabArray header names.

◆ copyNew()

void amrex::StateData::copyNew ( const StateData & state )

Copy the "new" time slice from state, allocating storage if needed.

Parameters

state Source StateData whose new data/time level are cloned.

◆ copyOld()

void amrex::StateData::copyOld ( const StateData & state )

Copy the "old" time slice from state, allocating storage if needed.

Parameters

state Source StateData whose old data/time level are cloned.

◆ curTime()

Real amrex::StateData::curTime ( ) const

inlinenoexcept

Returns the current time.

◆ define()

void amrex::StateData::define	(	const Box &	p_domain,
		const BoxArray &	grds,
		const DistributionMapping &	dm,
		const StateDescriptor &	d,
		Real	cur_time,
		Real	dt,
		const FabFactory< FArrayBox > &	factory
	)

Initialize the object after default construction.

Parameters

p_domain	Domain box of the AMR problem (used for BCs).
grds	Cell-centered BoxArray for this level.
dm	Distribution mapping for that grid layout.
d	State descriptor describing component layout.
cur_time	Current simulation time.
dt	Initial dt (applied to both old/new slots).
factory	Fab factory used for allocation.

◆ descriptor()

const StateDescriptor * amrex::StateData::descriptor ( ) const

inlinenoexcept

Returns the StateDescriptor.

◆ DistributionMap()

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

inlinenoexcept

◆ FabArrayHeaderNames()

static const Vector< std::string > & amrex::StateData::FabArrayHeaderNames ( )

inlinestatic

These facilitate prereading FabArray headers to avoid synchronization when reading multiple FabArrays.

View of FabArray header filenames recorded during the last checkpoint write.

◆ Factory()

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

inlinenoexcept

◆ FillBoundary() [1/2]

void amrex::StateData::FillBoundary	(	Box const &	bx,
		FArrayBox &	dest,
		Real	time,
		Geometry const &	geom,
		int	dest_comp,
		int	src_comp,
		int	num_comp
	)

Variant that fills data on region bx into dest at components starting dest_comp, sampling state components beginning at src_comp for num_comp values using geometry geom at time.

◆ FillBoundary() [2/2]

void amrex::StateData::FillBoundary	(	FArrayBox &	dest,
		Real	time,
		const Real *	dx,
		const RealBox &	prob_domain,
		int	dest_comp,
		int	src_comp,
		int	num_comp = `1`
	)

Set physical boundary values for a FAB extracted from the MultiFab.

Parameters

dest	Destination FAB to modify.
time	Physical time at which BCs are evaluated.
dx	Cell spacing array.
prob_domain	Real-space domain extents.
dest_comp	Destination component offset in `dest`.
src_comp	Source component offset in the state data.
num_comp	Number of components to update (default 1).

◆ getArena()

Arena * amrex::StateData::getArena ( ) const

inlinenoexcept

Get the Arena used.

◆ getBC()

BCRec amrex::StateData::getBC	(	int	comp,
		int	i
	)		const

noexcept

Returns boundary conditions of specified component on the specified grid.

Parameters

comp	Component index.
i	Grid index.

◆ getData()

void amrex::StateData::getData	(	Vector< MultiFab * > &	data,
		Vector< Real > &	datatime,
		Real	time
	)		const

Gather data pointers and their time stamps corresponding to time.

Parameters

data	Output list receiving pointers to MultiFabs.
datatime	Output list receiving the associated times.
time	Requested interpolation time.

◆ getDomain()

const Box & amrex::StateData::getDomain ( ) const

inlinenoexcept

Returns the valid domain.

◆ hasNewData()

bool amrex::StateData::hasNewData ( ) const

inlinenoexcept

True if there is any new data available.

◆ hasOldData()

bool amrex::StateData::hasOldData ( ) const

inlinenoexcept

True if there is any old data available.

◆ InterpAddBox()

void amrex::StateData::InterpAddBox	(	MultiFabCopyDescriptor &	multiFabCopyDesc,
		Vector< MultiFabId > &	mfid,
		BoxList *	returnedUnfillableBoxes,
		Vector< FillBoxId > &	returnedFillBoxIds,
		const Box &	subbox,
		Real	time,
		int	src_comp,
		int	dest_comp,
		int	num_comp,
		bool	extrap = `false`
	)

Request interpolation/copied data covering subbox.

Parameters

multiFabCopyDesc	Descriptor returned by RegisterData().
mfid	Identifiers previously produced by RegisterData().
returnedUnfillableBoxes	Optional output list of boxes that could not be filled.
returnedFillBoxIds	Output fill-box identifiers referencing queued requests.
subbox	Region that needs to be populated.
time	Physical time at which data should be sampled.
src_comp	Source component index in the state data.
dest_comp	Destination component index inside the caller's buffers.
num_comp	Number of components requested.
extrap	If true, allow extrapolation beyond old/new time intervals.

◆ InterpFillFab()

void amrex::StateData::InterpFillFab	(	MultiFabCopyDescriptor &	fabCopyDesc,
		const Vector< MultiFabId > &	mfid,
		const Vector< FillBoxId > &	fillBoxIds,
		FArrayBox &	dest,
		Real	time,
		int	src_comp,
		int	dest_comp,
		int	num_comp,
		bool	extrap = `false`
	)

Complete outstanding interpolation requests and fill dest.

Parameters

fabCopyDesc	Descriptor produced by RegisterData().
mfid	Identifiers previously produced by RegisterData().
fillBoxIds	Identifiers returned by InterpAddBox().
dest	Destination FAB.
time	Physical time at which data should be sampled.
src_comp	Source component offset in the state data.
dest_comp	Destination component offset inside `dest`.
num_comp	Number of components to fill.
extrap	If true, allow extrapolation beyond old/new time intervals.

◆ newData() [1/2]

const MultiFab & amrex::StateData::newData ( ) const

inlinenoexcept

Returns the new data.

◆ newData() [2/2]

MultiFab & amrex::StateData::newData ( )

inlinenoexcept

Returns the new data.

◆ newGrid()

FArrayBox & amrex::StateData::newGrid ( int i )

inlinenoexcept

Returns the FAB of new data at grid index i.

◆ oldData() [1/2]

const MultiFab & amrex::StateData::oldData ( ) const

inlinenoexcept

Returns the old data.

◆ oldData() [2/2]

MultiFab & amrex::StateData::oldData ( )

inlinenoexcept

Returns the old data.

◆ oldGrid()

FArrayBox & amrex::StateData::oldGrid ( int i )

inlinenoexcept

Returns the FAB of old data at grid index i.

◆ operator=() [1/2]

StateData & amrex::StateData::operator= ( StateData && rhs )

delete

Move assignment is disabled (use define()/swap helpers instead).

◆ operator=() [2/2]

StateData & amrex::StateData::operator= ( StateData const & rhs )

Copy-assignment; deep-copies metadata and allocates new FAB storage.

◆ prevTime()

Real amrex::StateData::prevTime ( ) const

inlinenoexcept

Returns the previous time.

◆ printTimeInterval()

void amrex::StateData::printTimeInterval ( std::ostream & os ) const

Prints out the time interval.

Parameters

os	Output stream receiving a textual summary of old/new times.

◆ RegisterData()

void amrex::StateData::RegisterData	(	MultiFabCopyDescriptor &	multiFabCopyDesc,
		Vector< MultiFabId > &	mfid
	)

Register the state data with a MultiFabCopyDescriptor for later interpolation/fills.

Parameters

multiFabCopyDesc	Descriptor that tracks MultiFabs participating in copy/interp operations.
mfid	Output vector receiving identifiers for the registered MultiFabs.

◆ removeOldData()

void amrex::StateData::removeOldData ( )

inline

Deletes the space used by the old timestep data.

◆ replaceNewData() [1/2]

void amrex::StateData::replaceNewData ( MultiFab && mf )

Swaps new data with a new MultiFab. Deletes the previous new data.

Parameters

mf	MultiFab that will replace the stored new data (ownership transferred).

◆ replaceNewData() [2/2]

void amrex::StateData::replaceNewData ( StateData & s )

Swaps new data with another StateData. Does not delete the previous new data.

Parameters

s	Peer whose new data will be exchanged with this instance.

◆ replaceOldData() [1/2]

void amrex::StateData::replaceOldData ( MultiFab && mf )

Swaps old data with a new MultiFab. Deletes the previous old data.

Parameters

mf	MultiFab that will replace the stored old data (ownership transferred).

◆ replaceOldData() [2/2]

void amrex::StateData::replaceOldData ( StateData & s )

Swaps old data with another StateData. Does not delete the previous old data.

Parameters

s	Peer whose old data will be exchanged with this instance.

◆ reset()

void amrex::StateData::reset ( )

Reverts back to initial state.

◆ restart() [1/2]

void amrex::StateData::restart	(	const StateDescriptor &	d,
		const StateData &	rhs
	)

Initialize from another StateData sharing descriptor d.

Parameters

d	State descriptor describing the components.
rhs	Source data that will be cloned.

◆ restart() [2/2]

void amrex::StateData::restart	(	std::istream &	is,
		const Box &	p_domain,
		const BoxArray &	grds,
		const DistributionMapping &	dm,
		const FabFactory< FArrayBox > &	factory,
		const StateDescriptor &	d,
		const std::string &	chkfile
	)

Restart with domain box, grids, and dmap provided.

Parameters

is	Input stream tied to the checkpoint data.
p_domain	Domain box for the level.
grds	Cell-centered grid layout.
dm	Distribution mapping describing ownership of grids.
factory	Fab factory controlling allocation strategy.
d	State descriptor describing components/BCs.
chkfile	Name of the checkpoint file (for logging).

◆ setArena()

void amrex::StateData::setArena ( Arena * ar )

inlinenoexcept

Set the Arena used for subsequent allocations to ar.

◆ setBoxArray()

void amrex::StateData::setBoxArray ( BoxArray const & a_grids )

inlinenoexcept

Replace the stored BoxArray layout with a_grids (no redistribution occurs).

◆ setDistributionMap()

void amrex::StateData::setDistributionMap ( DistributionMapping & new_dmap )

inlinenoexcept

Replace the stored DistributionMapping with new_dmap (no redistribution occurs).

◆ setFactory()

void amrex::StateData::setFactory ( FabFactory< FArrayBox > const & a_factory )

inline

Replace the internal factory with a clone of a_factory.

◆ SetFAHeaderMapPtr()

static void amrex::StateData::SetFAHeaderMapPtr ( std::map< std::string, Vector< char > > * fahmp )

inlinestatic

Install a pointer fahmp to the global map storing pre-read FabArray headers.

◆ setNewTimeLevel()

void amrex::StateData::setNewTimeLevel ( Real time )

Sets time of new data.

Parameters

time	New-time value to record.

◆ setOldTimeLevel()

void amrex::StateData::setOldTimeLevel ( Real time )

Sets time of old data.

Parameters

time	Old-time value to record.

◆ setTimeLevel()

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

Sets time of old and new data.

Parameters

time	New-time value.
dt_old	Dt associated with the old time interval.
dt_new	Dt associated with the new time interval.

◆ swapTimeLevels()

void amrex::StateData::swapTimeLevels ( Real dt )

Old data becomes new data and new time is incremented by dt.

Parameters

dt	Time step separating the old and new slots.

◆ syncNewTimeLevel()

void amrex::StateData::syncNewTimeLevel ( Real time )

Set both start/stop endpoints of the new-time interval to time.

Friends And Related Symbol Documentation

◆ StateDataPhysBCFunct

friend class StateDataPhysBCFunct

friend

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

/home/runner/work/amrex/amrex/Src/Amr/AMReX_StateData.H
/home/runner/work/amrex/amrex/Src/Amr/AMReX_StateData.cpp

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ StateData() [1/4]

◆ StateData() [2/4]

◆ ~StateData()

◆ StateData() [3/4]

◆ StateData() [4/4]

Member Function Documentation

◆ allocOldData()

◆ boxArray()

◆ checkPoint()

◆ ClearFabArrayHeaderNames()

◆ copyNew()

◆ copyOld()

◆ curTime()

◆ define()

◆ descriptor()

◆ DistributionMap()

◆ FabArrayHeaderNames()

◆ Factory()

◆ FillBoundary() [1/2]

◆ FillBoundary() [2/2]

◆ getArena()

◆ getBC()

◆ getData()

◆ getDomain()

◆ hasNewData()

◆ hasOldData()

◆ InterpAddBox()

◆ InterpFillFab()

◆ newData() [1/2]

◆ newData() [2/2]

◆ newGrid()

◆ oldData() [1/2]

◆ oldData() [2/2]

◆ oldGrid()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ prevTime()

◆ printTimeInterval()

◆ RegisterData()

◆ removeOldData()

◆ replaceNewData() [1/2]

◆ replaceNewData() [2/2]

◆ replaceOldData() [1/2]

◆ replaceOldData() [2/2]

◆ reset()

◆ restart() [1/2]

◆ restart() [2/2]

◆ setArena()

◆ setBoxArray()

◆ setDistributionMap()

◆ setFactory()

◆ SetFAHeaderMapPtr()

◆ setNewTimeLevel()

◆ setOldTimeLevel()

◆ setTimeLevel()

◆ swapTimeLevels()

◆ syncNewTimeLevel()

Friends And Related Symbol Documentation

◆ StateDataPhysBCFunct