amrex::AuxBoundaryData Class Reference

#include <AMReX_AuxBoundaryData.H>

Public Member Functions
	AuxBoundaryData () noexcept=default
	Construct an empty container; call initialize() before use.
	AuxBoundaryData (const BoxArray &ba, int n_grow, int n_comp, const Geometry &geom)
	Construct and allocate storage for boundary data.
	~AuxBoundaryData ()=default
	Trivial destructor; MultiFab members handle their own cleanup.
	AuxBoundaryData (AuxBoundaryData &&rhs)=default
	Move constructor keeps the bookkeeping simple when containers relocate.
AuxBoundaryData &	operator= (AuxBoundaryData &&rhs)=default
	Move assignment likewise transfers ownership of the cached MultiFab.
	AuxBoundaryData (const AuxBoundaryData &rhs)
	Deep-copy constructor.
AuxBoundaryData &	operator= (const AuxBoundaryData &rhs)=delete
	Copy assignment is disabled; construct a new container instead.
void	copyTo (MultiFab &destmf, int src_comp, int dst_comp, int num_comp) const
	Copy data from the auxiliary storage into destmf.
void	copyFrom (const MultiFab &srcmf, int src_comp, int dst_comp, int num_comp, int src_ng=0)
	Populate the auxiliary storage from srcmf.
size_t	size () const noexcept
	Number of FArrayBoxes currently cached (0 if empty/uninitialized).
void	copy (const AuxBoundaryData &src, int src_comp, int dst_comp, int num_comp)
	Copy data from another AuxBoundaryData src (component-wise).
void	initialize (const BoxArray &ba, int n_grow, int n_comp, const Geometry &geom)
	Allocate and configure storage.
const BoxArray &	equivBoxArray () const noexcept
void	setVal (Real r)
	Fill all stored data with scalar value r (if initialized).
const DistributionMapping &	DistributionMap () const noexcept
	Distribution mapping associated with the cached grids.
FArrayBox &	operator[] (const MFIter &mfi) noexcept
	Mutable access to the boundary data at given mfi.
const FArrayBox &	operator[] (const MFIter &mfi) const noexcept
	Read-only access to the boundary data at given mfi.
int	nGrow () const noexcept
	Number of ghost cells captured when the container was initialized.
int	nComp () const noexcept
	Number of components stored per entry.
bool	isEmpty () const noexcept
	True if the container manages no data (either default constructed or after reset()).

Constructor & Destructor Documentation

AuxBoundaryData() [1/4]

amrex::AuxBoundaryData::AuxBoundaryData ( )

defaultnoexcept

Construct an empty container; call initialize() before use.

AuxBoundaryData() [2/4]

amrex::AuxBoundaryData::AuxBoundaryData	(	const BoxArray &	ba,
		int	n_grow,
		int	n_comp,
		const Geometry &	geom
	)

Construct and allocate storage for boundary data.

Parameters

ba	BoxArray describing the owning level.
n_grow	Number of grow cells to capture around each box.
n_comp	Number of components per FArrayBox.
geom	Geometry describing the level (used for periodicity).

~AuxBoundaryData()

amrex::AuxBoundaryData::~AuxBoundaryData ( )

default

Trivial destructor; MultiFab members handle their own cleanup.

AuxBoundaryData() [3/4]

amrex::AuxBoundaryData::AuxBoundaryData ( AuxBoundaryData &&  rhs )

default

Move constructor keeps the bookkeeping simple when containers relocate.

AuxBoundaryData() [4/4]

amrex::AuxBoundaryData::AuxBoundaryData

(

const AuxBoundaryData &

rhs

)

Deep-copy constructor.

Parameters

rhs	Source AuxBoundaryData whose storage is duplicated.

Member Function Documentation

copy()

void amrex::AuxBoundaryData::copy	(	const AuxBoundaryData &	src,
		int	src_comp,
		int	dst_comp,
		int	num_comp
	)

Copy data from another AuxBoundaryData src (component-wise).

Parameters

src	Source container.
src_comp	Starting component inside src.
dst_comp	Destination component inside this container.
num_comp	Number of components to copy.

copyFrom()

void amrex::AuxBoundaryData::copyFrom	(	const MultiFab &	srcmf,
		int	src_comp,
		int	dst_comp,
		int	num_comp,
		int	src_ng = 0
	)

Populate the auxiliary storage from srcmf.

Parameters

srcmf	Source MultiFab supplying data.
src_comp	Starting component inside srcmf.
dst_comp	Destination component inside this container.
num_comp	Number of components to copy.
src_ng	Number of valid grow cells present in srcmf.

copyTo()

void amrex::AuxBoundaryData::copyTo	(	MultiFab &	destmf,
		int	src_comp,
		int	dst_comp,
		int	num_comp
	)		const

Copy data from the auxiliary storage into destmf.

Parameters

destmf	Destination MultiFab.
src_comp	Starting component inside this container.
dst_comp	Destination component index.
num_comp	Number of components to copy.

DistributionMap()

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

inlinenoexcept

Distribution mapping associated with the cached grids.

equivBoxArray()

const BoxArray & amrex::AuxBoundaryData::equivBoxArray ( ) const

inlinenoexcept

Returns

BoxArray describing the cached boundary regions.

initialize()

void amrex::AuxBoundaryData::initialize	(	const BoxArray &	ba,
		int	n_grow,
		int	n_comp,
		const Geometry &	geom
	)

Allocate and configure storage.

Parameters

ba	BoxArray describing the owning level.
n_grow	Number of grow cells to capture.
n_comp	Number of components per face.
geom	Geometry describing the level.

isEmpty()

bool amrex::AuxBoundaryData::isEmpty ( ) const

inlinenoexcept

True if the container manages no data (either default constructed or after reset()).

nComp()

int amrex::AuxBoundaryData::nComp ( ) const

inlinenoexcept

Number of components stored per entry.

nGrow()

int amrex::AuxBoundaryData::nGrow ( ) const

inlinenoexcept

Number of ghost cells captured when the container was initialized.

operator=() [1/2]

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

default

Move assignment likewise transfers ownership of the cached MultiFab.

operator=() [2/2]

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

delete

Copy assignment is disabled; construct a new container instead.

operator[]() [1/2]

const FArrayBox & amrex::AuxBoundaryData::operator[] ( const MFIter &  mfi ) const

inlinenoexcept

Read-only access to the boundary data at given mfi.

operator[]() [2/2]

FArrayBox & amrex::AuxBoundaryData::operator[] ( const MFIter &  mfi )

inlinenoexcept

Mutable access to the boundary data at given mfi.

setVal()

void amrex::AuxBoundaryData::setVal ( Real  r )

inline

Fill all stored data with scalar value r (if initialized).

size()

size_t amrex::AuxBoundaryData::size ( ) const

inlinenoexcept

Number of FArrayBoxes currently cached (0 if empty/uninitialized).

---

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

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