A BndryData contains a BndryRegister about each side of each grid in a Boxarray. These data are used to store information along the outer layer of each grid (at the same level of coarseness), such as the value of boundary conditions there. Also, for each boundary, this class maintains a BoundCond identifier and a location. This "location" often specifies where, in physical space, a value, which is stored in the boundary registers, will be applied by a solver (although interpretation of this information is application-specific). More...

#include <AMReX_BndryData.H>

Inheritance diagram for amrex::BndryData:

Public Types
enum	MaskVal { covered = 0, not_covered = 1, outside_domain = 2, NumMaskVals = 3 }
	mask values enumeration More...

using	RealTuple = Array< Real, 2 *AMREX_SPACEDIM >
	Some useful typedefs. More...

Public Member Functions
	BndryData () noexcept
	Default constructor. More...

	BndryData (const BoxArray &grids, const DistributionMapping &dmap, int ncomp, const Geometry &geom)
	constructor specifying number of components and box of physical domain (cell-centered) More...

virtual	~BndryData ()
	destructor More...

	BndryData (const BndryData &src)
	copy constructor More...

BndryData &	operator= (const BndryData &src)
	copy assignment operator More...

	BndryData (BndryData &&rhs)=delete

BndryData &	operator= (BndryData &&rhs)=delete

void	define (const BoxArray &grids, const DistributionMapping &dmap, int ncomp, const Geometry &geom)
	allocate bndry fabs along given face More...

const MultiMask &	bndryMasks (Orientation face) const noexcept

const FabSet &	bndryValues (Orientation face) const noexcept
	Return FabSet on given face. More...

const RealTuple &	bndryLocs (int igrid) const noexcept
	Return boundary location on given face for grids we own. It's an error if we don't own that grid. RealTuple is indexed with Orientation. More...

const RealTuple &	bndryLocs (const MFIter &mfi) const noexcept

const Vector< Vector< BoundCond > > &	bndryConds (int igrid) const noexcept
	Return boundary type specifier on given face for grids we own. It's an error if we don't own that grid. More...

const Vector< Vector< BoundCond > > &	bndryConds (const MFIter &mfi) const noexcept

int	nComp () const noexcept
	return number of components for which this object is intended More...

const Box &	getDomain () const noexcept
	return domain used to define masks More...

const Geometry &	getGeom () const noexcept
	return geometry used to define masks More...

void	setValue (Orientation face, int n, Real val) noexcept
	set values of boundary Fab for given orientation on nth grid More...

void	setBoundCond (Orientation face, int n, int comp, const BoundCond &bcn) noexcept
	set boundary type specifier for given orientation on nth grid More...

void	setBoundCond (Orientation face, const MFIter &mfi, int comp, const BoundCond &bcn) noexcept

void	setBoundLoc (Orientation face, int n, Real val) noexcept
	set boundary location for given orientation on nth grid More...

void	setBoundLoc (Orientation face, const MFIter &mfi, Real val) noexcept

const FabSet &	operator[] (Orientation face) const noexcept
	implement public access to const BndryRegister::operator[] More...

FabSet &	operator[] (Orientation face) noexcept
	implement public access to BndryRegister::operator[] More...

Public Member Functions inherited from amrex::BndryRegister
	BndryRegister () noexcept
	The default constructor. More...

	BndryRegister (const BoxArray &grids_, const DistributionMapping &dmap, int in_rad, int out_rad, int extent_rad, int ncomp)
	The constructor, given number of cells in/out, extent and number of components (assumes cell-centered boxes, and allocates cell-centered FABs) More...

	BndryRegister (const BndryRegister &src)
	The copy constructor. More...

BndryRegister &	operator= (const BndryRegister &src)
	The copy assignment operator. More...

virtual	~BndryRegister ()
	The destructor. More...

	BndryRegister (BndryRegister &&rhs) noexcept=default

BndryRegister &	operator= (BndryRegister &&rhs)=delete

void	define (const BoxArray &grids_, const DistributionMapping &dmap, int in_rad, int out_rad, int extent_rad, int ncomp)

void	define (Orientation face, IndexType typ, int in_rad, int out_rad, int extent_rad, int ncomp, const DistributionMapping &dm)
	Build FABs along given face, specifying the DistributionMapping. More...

void	clear ()

const BoxArray &	boxes () const noexcept
	Get box domain (as an array of boxes). More...

int	size () const noexcept
	Return the number of grids in this domain. More...

const FabSet &	operator[] (Orientation face) const noexcept
	Return const set of FABs bounding the domain grid boxes on a given orientation. More...

FabSet &	operator[] (Orientation face) noexcept
	Return set of FABs bounding the domain grid boxes on a given orientation. More...

void	setVal (Real v)
	Set all boundary FABs to given value. More...

BndryRegister &	operator+= (const BndryRegister &rhs)
	register += rhs More...

BndryRegister &	plus (const BndryRegister &rhs)

BndryRegister &	copyFrom (const MultiFab &src, int nghost, int src_comp, int dest_comp, int num_comp, const Periodicity &period=Periodicity::NonPeriodic())
	Fill the boundary FABs on intersection with given MultiFab. More...

BndryRegister &	plusFrom (const MultiFab &src, int nghost, int src_comp, int dest_comp, int num_comp, const Periodicity &period=Periodicity::NonPeriodic())
	Increment the boundary FABs on intersect with given MultiFab. More...

BndryRegister &	linComb (Real a, const MultiFab &mfa, int a_comp, Real b, const MultiFab &mfb, int b_comp, int dest_comp, int num_comp, int n_ghost=0)
	Linear combination: this := amfa + bmfb on intersection of MultiFabs with the boundary FABs. More...

void	setBoxes (const BoxArray &grids)
	Set box domain, if not set previously. More...

const DistributionMapping &	DistributionMap () const noexcept
	Returns constant reference to associated DistributionMapping. More...

void	write (const std::string &name, std::ostream &os) const
	Write (used for writing to checkpoint) More...

void	read (const std::string &name, std::istream &is)
	Read (used for reading from checkpoint) More...

void	init (const BndryRegister &src)
	Used by the copy constructor and assignment operator. More...

Protected Member Functions
void	init (const BndryData &src)
	Helper function for copy constructor and assignment operator. More...

Protected Attributes
LayoutData< Vector< Vector< BoundCond > > >	bcond
	Map of boundary condition type specifiers. The outer Array dimension is over Orientation. More...

LayoutData< RealTuple >	bcloc

Vector< MultiMask >	masks
	Boundary condition mask. More...

Geometry	geom
	Domain used for mask definitions. More...

int	m_ncomp

bool	m_defined

Protected Attributes inherited from amrex::BndryRegister
FabSet	bndry [2 *AMREX_SPACEDIM]
	The data. More...

BoxArray	grids

Static Private Attributes
static int	NTangHalfWidth = 5

Additional Inherited Members
Static Public Member Functions inherited from amrex::BndryRegister
static void	Copy (BndryRegister &dst, const BndryRegister &src)
	Local copy function. More...

Detailed Description

A BndryData contains a BndryRegister about each side of each grid in a Boxarray. These data are used to store information along the outer layer of each grid (at the same level of coarseness), such as the value of boundary conditions there. Also, for each boundary, this class maintains a BoundCond identifier and a location. This "location" often specifies where, in physical space, a value, which is stored in the boundary registers, will be applied by a solver (although interpretation of this information is application-specific).

In addition to boundary condition values, types and locations, and BndryDate object maintains a mask for each boundary value. Given a Geometry describing the physical "domain" of application, a BndryData object fills the mask arrays with a mask value to indicate if the node is outside the domain (outside_domain), or, if not, whether it lays within the valid region of an adjacent grid (covered), or not (not_covered). This mask data is created upon non-default class instantiation.

Member Typedef Documentation

◆ RealTuple

using amrex::BndryData::RealTuple = Array<Real,2*AMREX_SPACEDIM>

Some useful typedefs.

Member Enumeration Documentation

◆ MaskVal

enum amrex::BndryData::MaskVal

mask values enumeration

Enumerator
covered
not_covered
outside_domain
NumMaskVals

Constructor & Destructor Documentation

◆ BndryData() [1/4]

amrex::BndryData::BndryData ( )

noexcept

Default constructor.

◆ BndryData() [2/4]

amrex::BndryData::BndryData	(	const BoxArray &	grids,
		const DistributionMapping &	dmap,
		int	ncomp,
		const Geometry &	geom
	)

constructor specifying number of components and box of physical domain (cell-centered)

◆ ~BndryData()

amrex::BndryData::~BndryData ( )

virtual

destructor

◆ BndryData() [3/4]

amrex::BndryData::BndryData ( const BndryData & src )

copy constructor

◆ BndryData() [4/4]

amrex::BndryData::BndryData ( BndryData && rhs )

delete

Member Function Documentation

◆ bndryConds() [1/2]

const Vector< Vector< BoundCond > > & amrex::BndryData::bndryConds ( const MFIter & mfi ) const

noexcept

◆ bndryConds() [2/2]

const Vector< Vector< BoundCond > > & amrex::BndryData::bndryConds ( int igrid ) const

noexcept

Return boundary type specifier on given face for grids we own. It's an error if we don't own that grid.

◆ bndryLocs() [1/2]

const BndryData::RealTuple & amrex::BndryData::bndryLocs ( const MFIter & mfi ) const

noexcept

◆ bndryLocs() [2/2]

const BndryData::RealTuple & amrex::BndryData::bndryLocs ( int igrid ) const

noexcept

Return boundary location on given face for grids we own. It's an error if we don't own that grid. RealTuple is indexed with Orientation.

◆ bndryMasks()

const MultiMask& amrex::BndryData::bndryMasks ( Orientation face ) const

inlinenoexcept

◆ bndryValues()

const FabSet& amrex::BndryData::bndryValues ( Orientation face ) const

inlinenoexcept

Return FabSet on given face.

◆ define()

void amrex::BndryData::define	(	const BoxArray &	grids,
		const DistributionMapping &	dmap,
		int	ncomp,
		const Geometry &	geom
	)

allocate bndry fabs along given face

◆ getDomain()

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

inlinenoexcept

return domain used to define masks

◆ getGeom()

const Geometry& amrex::BndryData::getGeom ( ) const

inlinenoexcept

return geometry used to define masks

◆ init()

void amrex::BndryData::init ( const BndryData & src )

protected

Helper function for copy constructor and assignment operator.

◆ nComp()

int amrex::BndryData::nComp ( ) const

inlinenoexcept

return number of components for which this object is intended

◆ operator=() [1/2]

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

delete

◆ operator=() [2/2]

BndryData & amrex::BndryData::operator= ( const BndryData & src )

copy assignment operator

◆ operator[]() [1/2]

const FabSet& amrex::BndryData::operator[] ( Orientation face ) const

inlinenoexcept

implement public access to const BndryRegister::operator[]

◆ operator[]() [2/2]

FabSet& amrex::BndryData::operator[] ( Orientation face )

inlinenoexcept

implement public access to BndryRegister::operator[]

◆ setBoundCond() [1/2]

void amrex::BndryData::setBoundCond	(	Orientation	face,
		const MFIter &	mfi,
		int	comp,
		const BoundCond &	bcn
	)

noexcept

◆ setBoundCond() [2/2]

void amrex::BndryData::setBoundCond	(	Orientation	face,
		int	n,
		int	comp,
		const BoundCond &	bcn
	)

noexcept

set boundary type specifier for given orientation on nth grid

◆ setBoundLoc() [1/2]

void amrex::BndryData::setBoundLoc	(	Orientation	face,
		const MFIter &	mfi,
		Real	val
	)

noexcept

◆ setBoundLoc() [2/2]

void amrex::BndryData::setBoundLoc	(	Orientation	face,
		int	n,
		Real	val
	)

noexcept

set boundary location for given orientation on nth grid

◆ setValue()

void amrex::BndryData::setValue	(	Orientation	face,
		int	n,
		Real	val
	)

noexcept

set values of boundary Fab for given orientation on nth grid

Member Data Documentation

◆ bcloc

LayoutData<RealTuple> amrex::BndryData::bcloc

protected

◆ bcond

LayoutData<Vector< Vector<BoundCond> > > amrex::BndryData::bcond

protected

Map of boundary condition type specifiers. The outer Array dimension is over Orientation.

◆ geom

Geometry amrex::BndryData::geom

protected

Domain used for mask definitions.

◆ m_defined

bool amrex::BndryData::m_defined

protected

◆ m_ncomp

int amrex::BndryData::m_ncomp

protected

◆ masks

Vector<MultiMask> amrex::BndryData::masks

protected

Boundary condition mask.

◆ NTangHalfWidth

int amrex::BndryData::NTangHalfWidth = 5

staticprivate

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

/home/runner/work/amrex/amrex/Src/Boundary/AMReX_BndryData.H
/home/runner/work/amrex/amrex/Src/Boundary/AMReX_BndryData.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ RealTuple

Member Enumeration Documentation

◆ MaskVal

Constructor & Destructor Documentation

◆ BndryData() [1/4]

◆ BndryData() [2/4]

◆ ~BndryData()

◆ BndryData() [3/4]

◆ BndryData() [4/4]

Member Function Documentation

◆ bndryConds() [1/2]

◆ bndryConds() [2/2]

◆ bndryLocs() [1/2]

◆ bndryLocs() [2/2]

◆ bndryMasks()

◆ bndryValues()

◆ define()

◆ getDomain()

◆ getGeom()

◆ init()

◆ nComp()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ setBoundCond() [1/2]

◆ setBoundCond() [2/2]

◆ setBoundLoc() [1/2]

◆ setBoundLoc() [2/2]

◆ setValue()

Member Data Documentation

◆ bcloc

◆ bcond

◆ geom

◆ m_defined

◆ m_ncomp

◆ masks

◆ NTangHalfWidth