An InterpBndryData object adds to a BndryData object the ability to manipulate and set the data stored in the boundary cells. More...

#include <AMReX_InterpBndryData.H>

Inheritance diagram for amrex::InterpBndryDataT< MF >:

Public Types
using	value_type = typename MF::value_type

Public Types inherited from amrex::BndryDataT< MF >
enum	MaskVal { covered = 0 , not_covered = 1 , outside_domain = 2 , NumMaskVals = 3 }
	Mask classification used for each boundary cell. More...

using	value_type = typename MF::value_type

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

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

Public Member Functions
	InterpBndryDataT () noexcept=default
	default constructor

	InterpBndryDataT (const BoxArray &_grids, const DistributionMapping &_dmap, int _ncomp, const Geometry &geom)
	constructor for given BoxArray, etc

	~InterpBndryDataT ()=default

	InterpBndryDataT (const InterpBndryDataT< MF > &rhs)=delete

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

InterpBndryDataT< MF > &	operator= (const InterpBndryDataT< MF > &rhs)=delete

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

void	setPhysBndryValues (const MF &mf, int mf_start, int bnd_start, int num_comp)
	Set bndry values at physical boundaries.

void	setBndryValues (BndryRegisterT< MF > const &crse, int c_start, const MF &fine, int f_start, int bnd_start, int num_comp, const IntVect &ratio, int max_order=IBD_max_order_DEF, int max_width=2)
	Sset bndry values at coarse/fine and physical boundaries.

void	updateBndryValues (BndryRegisterT< MF > &crse, int c_start, int bnd_start, int num_comp, const IntVect &ratio, int max_order=IBD_max_order_DEF, int max_width=2)
	Update boundary values at coarse/fine boundaries.

void	setHomogValues ()
	Set boundary values to zero.

Public Member Functions inherited from amrex::BndryDataT< MF >
	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 masks and boundary registers for the supplied grids.

const MultiMask &	bndryMasks (Orientation face) const noexcept
	Return the per-face mask built during define() for orientation `face`.

const FabSetT< MF > &	bndryValues (Orientation face) const noexcept
	Access the boundary values stored on orientation `face`.

const RealTuple &	bndryLocs (int igrid) const noexcept
	Return physical boundary locations for all faces owned by a grid.

const RealTuple &	bndryLocs (const MFIter &mfi) const noexcept
	Same as bndryLocs(int) but uses iterator `mfi` to reference the grid.

const Vector< Vector< BoundCond > > &	bndryConds (int igrid) const noexcept
	Return boundary type specifiers stored for a grid.

const Vector< Vector< BoundCond > > &	bndryConds (const MFIter &mfi) const noexcept
	Same as bndryConds(int) but locates the grid via iterator `mfi`.

int	nComp () const noexcept
	Return number of components this boundary data manages.

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 all components on boundary face `face` of grid `n` to scalar value `val`.

void	setBoundCond (Orientation face, int n, int comp, const BoundCond &bcn) noexcept
	Set boundary type at grid index `n`, component `comp`, and face `face` to `bcn`.

void	setBoundCond (Orientation face, const MFIter &mfi, int comp, const BoundCond &bcn) noexcept
	Set boundary type using MFIter `mfi` to identify the grid, component `comp`, and identifier `bcn`.

void	setBoundLoc (Orientation face, int n, value_type val) noexcept
	Set the physical boundary location `val` for grid index `n` and face `face`.

void	setBoundLoc (Orientation face, const MFIter &mfi, value_type val) noexcept
	Set the boundary location value `val` by MFIter `mfi` on face `face`.

const FabSetT< MF > &	operator[] (Orientation face) const noexcept
	Provide access to boundary registers for orientation `face`.

FabSetT< MF > &	operator[] (Orientation face) noexcept
	Provide mutable access to boundary registers for orientation `face`.

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)
	Allocate boundary FabSets for all faces.

void	define (Orientation face, IndexType typ, int in_rad, int out_rad, int extent_rad, int ncomp, const DistributionMapping &dm)
	Build FABs along a particular face orientation.

void	clear ()
	Release all FABs and clear the associated BoxArray.

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 orientation `face`.

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

void	setVal (value_type v)
	Set all boundary FABs to the scalar value `v` across every component.

BndryRegisterT< MF > &	operator+= (const BndryRegisterT< MF > &rhs)
	Accumulate another register with identical layout into this one.

BndryRegisterT< MF > &	plus (const BndryRegisterT< MF > &rhs)
	Convenience alias for operator+=.

BndryRegisterT< MF > &	copyFrom (const MF &src, int nghost, int src_comp, int dest_comp, int num_comp, const Periodicity &period=Periodicity::NonPeriodic())
	Fill boundary FABs with `num_comp` components copied from `src` (component `src_comp`) into `dest_comp`, sampling `nghost` layers and honoring `period`.

BndryRegisterT< MF > &	plusFrom (const MF &src, int nghost, int src_comp, int dest_comp, int num_comp, const Periodicity &period=Periodicity::NonPeriodic())
	Increment boundary FABs with `num_comp` components from `src`, using the same arguments as copyFrom().

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 := `a` * `mfa` + `b` * `mfb` on the boundary, using components `a_comp`/`b_comp` and writing to `dest_comp` for `num_comp` entries with `n_ghost` layers.

void	setBoxes (const BoxArray &grids)
	Set the BoxArray domain to `grids` once prior to calling define().

const DistributionMapping &	DistributionMap () const noexcept
	Returns the DistributionMapping describing which MPI ranks own each boundary FAB.

void	write (const std::string &name, std::ostream &os) const
	Write all FabSets to disk (used for checkpoint data).

void	read (const std::string &name, std::istream &is)
	Read all FabSets from disk (used for checkpoint data).

Static Public Attributes
static constexpr int	IBD_max_order_DEF = 3

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 for duplicating boundary registers.

Protected Attributes inherited from amrex::BndryDataT< MF >
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 *3]
	The data.

BoxArray	grids

Detailed Description

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

An InterpBndryData object adds to a BndryData object the ability to manipulate and set the data stored in the boundary cells.

The InterpBndryData class is a class derived from BndryData. It is intended to provide a more physical method for filling boundary-related data. Boundary values in a BndryData object are stored in FabSets around each grid in the domain, and the InterpBndryData class provides a mechanism for filling these FabSets, consistent with AMR-like numerical discretizations. When asked to set its boundary values, an InterpBndryData object:

Fills with physical boundary values if the FAB is on the domain boundary - the corresponding values are presumed to be stored in the ghost cells of a MultiFab given to the boundary filling routine

Fills on intersection with data from the VALID region of the input MultiFab, ensuring that adjacent FABs use consistent data at their intersection, and otherwise,

Fills with values interpolated from a coarser FAB that bounds the cells that do not meet the above two criteria

Member Typedef Documentation

◆ value_type

template<typename MF >

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

Constructor & Destructor Documentation

◆ InterpBndryDataT() [1/4]

template<typename MF >

amrex::InterpBndryDataT< MF >::InterpBndryDataT ( )

defaultnoexcept

default constructor

◆ InterpBndryDataT() [2/4]

template<typename MF >

amrex::InterpBndryDataT< MF >::InterpBndryDataT	(	const BoxArray &	_grids,
		const DistributionMapping &	_dmap,
		int	_ncomp,
		const Geometry &	geom
	)

constructor for given BoxArray, etc

Parameters

_grids
_dmap
_ncomp
geom

◆ ~InterpBndryDataT()

template<typename MF >

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

default

◆ InterpBndryDataT() [3/4]

template<typename MF >

amrex::InterpBndryDataT< MF >::InterpBndryDataT ( const InterpBndryDataT< MF > & rhs )

delete

◆ InterpBndryDataT() [4/4]

template<typename MF >

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

delete

Member Function Documentation

◆ operator=() [1/2]

template<typename MF >

InterpBndryDataT< MF > & amrex::InterpBndryDataT< MF >::operator= ( const InterpBndryDataT< MF > & rhs )

delete

◆ operator=() [2/2]

template<typename MF >

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

delete

◆ setBndryValues()

template<typename MF >

void amrex::InterpBndryDataT< MF >::setBndryValues	(	BndryRegisterT< MF > const &	crse,
		int	c_start,
		const MF &	fine,
		int	f_start,
		int	bnd_start,
		int	num_comp,
		const IntVect &	ratio,
		int	max_order = `IBD_max_order_DEF`,
		int	max_width = `2`
	)

Sset bndry values at coarse/fine and physical boundaries.

Parameters

crse	BndryRegister storing coarse level data
c_start	starting component of the coarse data
fine	MF containing physical boundary values
f_start	starting component of the fine data
bnd_start	starting component in this InterpBndryData
num_comp	number of component
ratio	refinement ratio
max_order	interpolation order
max_width	max width of the interpolation stencil

◆ setHomogValues()

template<typename MF >

void amrex::InterpBndryDataT< MF >::setHomogValues ( )

Set boundary values to zero.

◆ setPhysBndryValues()

template<typename MF >

void amrex::InterpBndryDataT< MF >::setPhysBndryValues	(	const MF &	mf,
		int	mf_start,
		int	bnd_start,
		int	num_comp
	)

Set bndry values at physical boundaries.

Parameters

mf	MF containing physical boundary values
mf_start	starting component of the data in MF
bnd_start	starting component in this boundary register
num_comp	number of components

◆ updateBndryValues()

template<typename MF >

void amrex::InterpBndryDataT< MF >::updateBndryValues	(	BndryRegisterT< MF > &	crse,
		int	c_start,
		int	bnd_start,
		int	num_comp,
		const IntVect &	ratio,
		int	max_order = `IBD_max_order_DEF`,
		int	max_width = `2`
	)

Update boundary values at coarse/fine boundaries.

Parameters

crse	BndryRegister storing coarse level data
c_start	starting component of the coarse data
bnd_start	starting component in this InterpBndryData
num_comp	number of component
ratio	refinement ratio
max_order	interpolation order
max_width	max width of the interpolation stencil

Member Data Documentation

◆ IBD_max_order_DEF

template<typename MF >

constexpr int amrex::InterpBndryDataT< MF >::IBD_max_order_DEF = 3

staticconstexpr

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

/home/runner/work/amrex/amrex/Src/Boundary/AMReX_BoundaryFwd.H
/home/runner/work/amrex/amrex/Src/Boundary/AMReX_InterpBndryData.H

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ value_type

Constructor & Destructor Documentation

◆ InterpBndryDataT() [1/4]

◆ InterpBndryDataT() [2/4]

◆ ~InterpBndryDataT()

◆ InterpBndryDataT() [3/4]

◆ InterpBndryDataT() [4/4]

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setBndryValues()

◆ setHomogValues()

◆ setPhysBndryValues()

◆ updateBndryValues()

Member Data Documentation

◆ IBD_max_order_DEF