A BndryData stores and manipulates boundary data information on each side of each box in a BoxArray. More...

#include <AMReX_BndryData.H>

Inheritance diagram for amrex::BndryDataT< MF >:

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

using	value_type = typename MF::value_type

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

Public Types inherited from amrex::BndryRegisterT< MF >
using	value_type = typename MF::value_type

Public Member Functions
	BndryDataT () noexcept=default
	Default constructor.

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

	~BndryDataT ()=default
	destructor

	BndryDataT (const BndryDataT< MF > &src)=delete

	BndryDataT (BndryDataT< MF > &&rhs)=delete

BndryDataT< MF > &	operator= (const BndryDataT< MF > &src)=delete

BndryDataT< MF > &	operator= (BndryDataT< MF > &&rhs)=delete

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

const MultiMask &	bndryMasks (Orientation face) const noexcept

const FabSetT< MF > &	bndryValues (Orientation face) const noexcept
	Return FabSet on given face.

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.

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.

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

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

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

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

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

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

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

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

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

const FabSetT< MF > &	operator[] (Orientation face) const noexcept
	implement public access to const BndryRegister::operator[]

FabSetT< MF > &	operator[] (Orientation face) noexcept
	implement public access to BndryRegister::operator[]

Public Member Functions inherited from amrex::BndryRegisterT< MF >
	BndryRegisterT () noexcept=default
	The default constructor.

	BndryRegisterT (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)

	~BndryRegisterT ()=default
	The destructor.

	BndryRegisterT (BndryRegisterT< MF > &&rhs) noexcept=default

	BndryRegisterT (const BndryRegisterT< MF > &src)=delete

BndryRegisterT &	operator= (const BndryRegisterT< MF > &src)=delete

BndryRegisterT &	operator= (BndryRegisterT< MF > &&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.

void	clear ()

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

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

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

FabSetT< MF > &	operator[] (Orientation face) noexcept
	Return set of FABs bounding the domain grid boxes on a given orientation.

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

BndryRegisterT< MF > &	operator+= (const BndryRegisterT< MF > &rhs)
	register += rhs

BndryRegisterT< MF > &	plus (const BndryRegisterT< MF > &rhs)

BndryRegisterT< MF > &	copyFrom (const MF &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 MF.

BndryRegisterT< MF > &	plusFrom (const MF &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 MF.

BndryRegisterT< MF > &	linComb (value_type a, const MF &mfa, int a_comp, value_type b, const MF &mfb, int b_comp, int dest_comp, int num_comp, int n_ghost=0)
	Linear combination: this := amfa + bmfb on intersection of MFs with the boundary FABs.

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

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

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

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

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

LayoutData< RealTuple >	bcloc

Vector< MultiMask >	masks
	Boundary condition mask.

Geometry	geom
	Domain used for mask definitions.

int	m_ncomp {-1}

bool	m_defined {false}

Protected Attributes inherited from amrex::BndryRegisterT< MF >
FabSetT< MF >	bndry [2 *AMREX_SPACEDIM]
	The data.

BoxArray	grids

Static Private Attributes
static constexpr int	NTangHalfWidth = 5

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

Detailed Description

template<typename MF>
class amrex::BndryDataT< MF >

A BndryData stores and manipulates boundary data information on each side of each box in a BoxArray.

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

template<typename MF >

using amrex::BndryDataT< MF >::RealTuple = Array<value_type,2*AMREX_SPACEDIM>

Some useful typedefs.

◆ value_type

template<typename MF >

using amrex::BndryDataT< MF >::value_type = typename MF::value_type

Member Enumeration Documentation

◆ MaskVal

template<typename MF >

enum amrex::BndryDataT::MaskVal

mask values enumeration

Enumerator
covered
not_covered
outside_domain
NumMaskVals

Constructor & Destructor Documentation

◆ BndryDataT() [1/4]

template<typename MF >

amrex::BndryDataT< MF >::BndryDataT ( )

defaultnoexcept

Default constructor.

◆ BndryDataT() [2/4]

template<typename MF >

amrex::BndryDataT< MF >::BndryDataT	(	const BoxArray &	grids,
		const DistributionMapping &	dmap,
		int	ncomp,
		const Geometry &	geom
	)

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

◆ ~BndryDataT()

template<typename MF >

amrex::BndryDataT< MF >::~BndryDataT ( )

default

destructor

◆ BndryDataT() [3/4]

template<typename MF >

amrex::BndryDataT< MF >::BndryDataT ( const BndryDataT< MF > & src )

delete

◆ BndryDataT() [4/4]

template<typename MF >

amrex::BndryDataT< MF >::BndryDataT ( BndryDataT< MF > && rhs )

delete

Member Function Documentation

◆ bndryConds() [1/2]

template<typename MF >

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

noexcept

◆ bndryConds() [2/2]

template<typename MF >

const Vector< Vector< BoundCond > > & amrex::BndryDataT< MF >::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]

template<typename MF >

const BndryDataT< MF >::RealTuple & amrex::BndryDataT< MF >::bndryLocs ( const MFIter & mfi ) const

noexcept

◆ bndryLocs() [2/2]

template<typename MF >

const BndryDataT< MF >::RealTuple & amrex::BndryDataT< MF >::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()

template<typename MF >

const MultiMask & amrex::BndryDataT< MF >::bndryMasks ( Orientation face ) const

inlinenoexcept

◆ bndryValues()

template<typename MF >

const FabSetT< MF > & amrex::BndryDataT< MF >::bndryValues ( Orientation face ) const

inlinenoexcept

Return FabSet on given face.

◆ define()

template<typename MF >

void amrex::BndryDataT< MF >::define	(	const BoxArray &	grids,
		const DistributionMapping &	dmap,
		int	ncomp,
		const Geometry &	geom
	)

allocate bndry fabs along given face

◆ getDomain()

template<typename MF >

const Box & amrex::BndryDataT< MF >::getDomain ( ) const

inlinenoexcept

return domain used to define masks

◆ getGeom()

template<typename MF >

const Geometry & amrex::BndryDataT< MF >::getGeom ( ) const

inlinenoexcept

return geometry used to define masks

◆ nComp()

template<typename MF >

int amrex::BndryDataT< MF >::nComp ( ) const

inlinenoexcept

return number of components for which this object is intended

◆ operator=() [1/2]

template<typename MF >

BndryDataT< MF > & amrex::BndryDataT< MF >::operator= ( BndryDataT< MF > && rhs )

delete

◆ operator=() [2/2]

template<typename MF >

BndryDataT< MF > & amrex::BndryDataT< MF >::operator= ( const BndryDataT< MF > & src )

delete

◆ operator[]() [1/2]

template<typename MF >

const FabSetT< MF > & amrex::BndryDataT< MF >::operator[] ( Orientation face ) const

inlinenoexcept

implement public access to const BndryRegister::operator[]

◆ operator[]() [2/2]

template<typename MF >

FabSetT< MF > & amrex::BndryDataT< MF >::operator[] ( Orientation face )

inlinenoexcept

implement public access to BndryRegister::operator[]

◆ setBoundCond() [1/2]

template<typename MF >

void amrex::BndryDataT< MF >::setBoundCond	(	Orientation	face,
		const MFIter &	mfi,
		int	comp,
		const BoundCond &	bcn
	)

noexcept

◆ setBoundCond() [2/2]

template<typename MF >

void amrex::BndryDataT< MF >::setBoundCond	(	Orientation	face,
		int	n,
		int	comp,
		const BoundCond &	bcn
	)

noexcept

set boundary type specifier for given orientation on nth grid

◆ setBoundLoc() [1/2]

template<typename MF >

void amrex::BndryDataT< MF >::setBoundLoc	(	Orientation	face,
		const MFIter &	mfi,
		value_type	val
	)

noexcept

◆ setBoundLoc() [2/2]

template<typename MF >

void amrex::BndryDataT< MF >::setBoundLoc	(	Orientation	face,
		int	n,
		value_type	val
	)

noexcept

set boundary location for given orientation on nth grid

◆ setValue()

template<typename MF >

void amrex::BndryDataT< MF >::setValue	(	Orientation	face,
		int	n,
		Real	val
	)

noexcept

set values of boundary Fab for given orientation on nth grid

Member Data Documentation

◆ bcloc

template<typename MF >

LayoutData<RealTuple> amrex::BndryDataT< MF >::bcloc

protected

◆ bcond

template<typename MF >

LayoutData<Vector< Vector<BoundCond> > > amrex::BndryDataT< MF >::bcond

protected

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

◆ geom

template<typename MF >

Geometry amrex::BndryDataT< MF >::geom

protected

Domain used for mask definitions.

◆ m_defined

template<typename MF >

bool amrex::BndryDataT< MF >::m_defined {false}

protected

◆ m_ncomp

template<typename MF >

int amrex::BndryDataT< MF >::m_ncomp {-1}

protected

◆ masks

template<typename MF >

Vector<MultiMask> amrex::BndryDataT< MF >::masks

protected

Boundary condition mask.

◆ NTangHalfWidth

template<typename MF >

constexpr int amrex::BndryDataT< MF >::NTangHalfWidth = 5

staticconstexprprivate

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

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

Public Types

Public Member Functions

Protected Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ RealTuple

◆ value_type

Member Enumeration Documentation

◆ MaskVal

Constructor & Destructor Documentation

◆ BndryDataT() [1/4]

◆ BndryDataT() [2/4]

◆ ~BndryDataT()

◆ BndryDataT() [3/4]

◆ BndryDataT() [4/4]

Member Function Documentation

◆ bndryConds() [1/2]

◆ bndryConds() [2/2]

◆ bndryLocs() [1/2]

◆ bndryLocs() [2/2]

◆ bndryMasks()

◆ bndryValues()

◆ define()

◆ getDomain()

◆ getGeom()

◆ 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