amrex::MultiMask Class Reference

#include <AMReX_MultiMask.H>

Public Member Functions
	MultiMask ()
	Construct an empty MultiMask; call define() before use.
	MultiMask (const BoxArray &ba, const DistributionMapping &dm, int ncomp)
	Construct masks over ba with mapping dm and ncomp components.
	MultiMask (const BoxArray &regba, const DistributionMapping &dm, const Geometry &geom, Orientation face, int in_rad, int out_rad, int extent_rad, int ncomp, bool initval)
	Construct masks surrounding coarse/fine interfaces.
	~MultiMask ()=default
	MultiMask (MultiMask &&rhs) noexcept=default
	MultiMask (const MultiMask &rhs)=delete
MultiMask &	operator= (const MultiMask &rhs)=delete
MultiMask &	operator= (MultiMask &&rhs)=delete
void	define (const BoxArray &ba, const DistributionMapping &dm, int ncomp)
	Define masks over ba with mapping dm and ncomp components.
void	define (const BoxArray &regba, const DistributionMapping &dm, const Geometry &geom, Orientation face, int in_rad, int out_rad, int extent_rad, int ncomp, bool initval)
	Define masks for a coarse/fine interface region described by regba, dm, geom, face, and stencil widths in_rad/out_rad/extent_rad.
Mask &	operator[] (const MFIter &mfi) noexcept
	Mutable access to the mask referenced by iterator mfi.
const Mask &	operator[] (const MFIter &mfi) const noexcept
	Const access to the mask referenced by iterator mfi.
Array4< int const >	array (const MFIter &mfi) const noexcept
	Return an Array4 view (const) for iterator mfi.
Array4< int >	array (const MFIter &mfi) noexcept
	Return an Array4 view (mutable) for iterator mfi.
Array4< int const >	const_array (const MFIter &mfi) const noexcept
	Return a const Array4 view for iterator mfi.
MultiArray4< int const >	arrays () const noexcept
	Return const multi-array views of every mask.
MultiArray4< int >	arrays () noexcept
	Return mutable multi-array views of every mask.
MultiArray4< int const >	const_arrays () const noexcept
	Return const multi-array views (alias of arrays()).
int	nComp () const noexcept
	Number of components stored in each mask.
const BoxArray &	boxArray () const noexcept
	BoxArray used to build this MultiMask.
const DistributionMapping &	DistributionMap () const noexcept
	DistributionMapping describing mask ownership.

Static Public Member Functions
static void	Copy (MultiMask &dst, const MultiMask &src)
	Copy multi-mask data from src into dst.

Friends
class	MultiMaskIter

Constructor & Destructor Documentation

MultiMask() [1/5]

amrex::MultiMask::MultiMask ( )

inline

Construct an empty MultiMask; call define() before use.

MultiMask() [2/5]

amrex::MultiMask::MultiMask	(	const BoxArray &	ba,
		const DistributionMapping &	dm,
		int	ncomp
	)

Construct masks over ba with mapping dm and ncomp components.

MultiMask() [3/5]

amrex::MultiMask::MultiMask	(	const BoxArray &	regba,
		const DistributionMapping &	dm,
		const Geometry &	geom,
		Orientation	face,
		int	in_rad,
		int	out_rad,
		int	extent_rad,
		int	ncomp,
		bool	initval
	)

Construct masks surrounding coarse/fine interfaces.

Parameters

regba	Regular BoxArray to cover.
dm	Distribution mapping.
geom	Geometry describing the physical domain.
face	Orientation for which to build masks.
in_rad	Number of inward cells.
out_rad	Number of outward cells.
extent_rad	Tangential extent.
ncomp	Number of components.
initval	Whether to initialize mask values immediately.

~MultiMask()

amrex::MultiMask::~MultiMask ( )

default

MultiMask() [4/5]

amrex::MultiMask::MultiMask ( MultiMask &&  rhs )

defaultnoexcept

MultiMask() [5/5]

amrex::MultiMask::MultiMask ( const MultiMask &  rhs )

delete

Member Function Documentation

array() [1/2]

Array4< int const > amrex::MultiMask::array ( const MFIter &  mfi ) const

inlinenoexcept

Return an Array4 view (const) for iterator mfi.

array() [2/2]

Array4< int > amrex::MultiMask::array ( const MFIter &  mfi )

inlinenoexcept

Return an Array4 view (mutable) for iterator mfi.

arrays() [1/2]

MultiArray4< int const > amrex::MultiMask::arrays ( ) const

inlinenoexcept

Return const multi-array views of every mask.

arrays() [2/2]

MultiArray4< int > amrex::MultiMask::arrays ( )

inlinenoexcept

Return mutable multi-array views of every mask.

boxArray()

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

inlinenoexcept

BoxArray used to build this MultiMask.

const_array()

Array4< int const > amrex::MultiMask::const_array ( const MFIter &  mfi ) const

inlinenoexcept

Return a const Array4 view for iterator mfi.

const_arrays()

MultiArray4< int const > amrex::MultiMask::const_arrays ( ) const

inlinenoexcept

Return const multi-array views (alias of arrays()).

Copy()

void amrex::MultiMask::Copy ( MultiMask &  dst, const MultiMask &  src  )

static

Copy multi-mask data from src into dst.

Parameters

dst	Destination MultiMask.
src	Source MultiMask.

define() [1/2]

void amrex::MultiMask::define	(	const BoxArray &	ba,
		const DistributionMapping &	dm,
		int	ncomp
	)

Define masks over ba with mapping dm and ncomp components.

define() [2/2]

void amrex::MultiMask::define	(	const BoxArray &	regba,
		const DistributionMapping &	dm,
		const Geometry &	geom,
		Orientation	face,
		int	in_rad,
		int	out_rad,
		int	extent_rad,
		int	ncomp,
		bool	initval
	)

Define masks for a coarse/fine interface region described by regba, dm, geom, face, and stencil widths in_rad/out_rad/extent_rad.

DistributionMap()

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

inlinenoexcept

DistributionMapping describing mask ownership.

nComp()

int amrex::MultiMask::nComp ( ) const

inlinenoexcept

Number of components stored in each mask.

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

operator[]() [1/2]

const Mask & amrex::MultiMask::operator[] ( const MFIter &  mfi ) const

inlinenoexcept

Const access to the mask referenced by iterator mfi.

operator[]() [2/2]

Mask & amrex::MultiMask::operator[] ( const MFIter &  mfi )

inlinenoexcept

Mutable access to the mask referenced by iterator mfi.

Friends And Related Symbol Documentation

MultiMaskIter

friend class MultiMaskIter

friend

---

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

• /home/runner/work/amrex/amrex/Src/Boundary/AMReX_MultiMask.H
• /home/runner/work/amrex/amrex/Src/Boundary/AMReX_MultiMask.cpp