#include <AMReX_InterpBndryData.H>

Inheritance diagram for amrex::InterpBndryData:

Public Member Functions
	InterpBndryData () noexcept
	default constructor More...

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

	InterpBndryData (const InterpBndryData &rhs)
	Copy constructor. More...

virtual	~InterpBndryData () override

InterpBndryData &	operator= (const InterpBndryData &rhs)
	Copy assignment operator. More...

	InterpBndryData (InterpBndryData &&rhs)=delete

InterpBndryData &	operator= (InterpBndryData &&rhs)=delete

virtual void	setBndryConds (const BCRec &phys_bc, int ratio)
	interpret user BCs to those expected by LinOp: takes integer ratio and is a wrapper to the IntVect version More...

virtual void	setBndryConds (const BCRec &, const IntVect &, int=0)
	interpret user BCs to those expected by LinOp: takes IntVect ratio More...

virtual void	setBndryValues (const MultiFab &mf, int mf_start, int bnd_start, int num_comp, const BCRec &phys_bc)
	set bndry values at coarse level (non interpolation performed) More...

virtual void	setBndryValues (const MultiFab &mf, int mf_start, int bnd_start, int num_comp, int ratio, const BCRec &phys_bc)

virtual void	setBndryValues (const MultiFab &mf, int mf_start, int bnd_start, int num_comp, const IntVect &ratio, const BCRec &phys_bc)

virtual void	setBndryValues (BndryRegister &crse, int c_start, const MultiFab &fine, int f_start, int bnd_start, int num_comp, int ratio, const BCRec &phys_bc, int max_order=IBD_max_order_DEF)
	set bndry values at fine level, performing necessary interpolations More...

virtual void	setBndryValues (BndryRegister &crse, int c_start, const MultiFab &fine, int f_start, int bnd_start, int num_comp, const IntVect &ratio, const BCRec &phys_bc, int max_order=IBD_max_order_DEF)
	set bndry values at fine level, performing necessary interpolations More...

void	updateBndryValues (BndryRegister &crse, int c_start, int bnd_start, int num_comp, const IntVect &ratio, int max_order=IBD_max_order_DEF)

void	updateBndryValues (BndryRegister &crse, int c_start, int bnd_start, int num_comp, int ratio, int max_order=IBD_max_order_DEF)

void	setHomogValues ()

void	BndryValuesDoIt (BndryRegister &crse, int c_start, const MultiFab fine, int f_start, int bnd_start, int num_comp, const IntVect &ratio, const BCRec phys_bc, int max_order)

Public Member Functions inherited from amrex::BndryData
	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...

Static Public Member Functions
static int	maxOrderDEF ()

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

Static Public Attributes
static int	IBD_max_order_DEF = 3

Additional Inherited Members
Public Types inherited from amrex::BndryData
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...

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

Protected Attributes inherited from amrex::BndryData
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

Detailed Description

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 virtual base 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

Constructor & Destructor Documentation

◆ InterpBndryData() [1/4]

amrex::InterpBndryData::InterpBndryData ( )

noexcept

default constructor

◆ InterpBndryData() [2/4]

amrex::InterpBndryData::InterpBndryData	(	const BoxArray &	_grids,
		const DistributionMapping &	_dmap,
		int	_ncomp,
		const Geometry &	geom
	)

constructor for given BoxArray, etc

Parameters

_grids
_dmap
_ncomp
geom

◆ InterpBndryData() [3/4]

amrex::InterpBndryData::InterpBndryData ( const InterpBndryData & rhs )

Copy constructor.

Parameters

rhs

◆ ~InterpBndryData()

amrex::InterpBndryData::~InterpBndryData ( )

overridevirtual

◆ InterpBndryData() [4/4]

amrex::InterpBndryData::InterpBndryData ( InterpBndryData && rhs )

delete

Member Function Documentation

◆ BndryValuesDoIt()

void amrex::InterpBndryData::BndryValuesDoIt	(	BndryRegister &	crse,
		int	c_start,
		const MultiFab *	fine,
		int	f_start,
		int	bnd_start,
		int	num_comp,
		const IntVect &	ratio,
		const BCRec *	phys_bc,
		int	max_order
	)

◆ maxOrderDEF()

static int amrex::InterpBndryData::maxOrderDEF ( )

inlinestatic

◆ operator=() [1/2]

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

Copy assignment operator.

◆ operator=() [2/2]

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

delete

◆ setBndryConds() [1/2]

virtual void amrex::InterpBndryData::setBndryConds	(	const BCRec &	,
		const IntVect &	,
		int	= `0`
	)

inlinevirtual

interpret user BCs to those expected by LinOp: takes IntVect ratio

Parameters

phys_bc
ratio
comp

Reimplemented in amrex::MacBndry.

◆ setBndryConds() [2/2]

void amrex::InterpBndryData::setBndryConds	(	const BCRec &	phys_bc,
		int	ratio
	)

virtual

interpret user BCs to those expected by LinOp: takes integer ratio and is a wrapper to the IntVect version

Parameters

phys_bc
ratio

Reimplemented in amrex::MacBndry.

◆ setBndryValues() [1/5]

void amrex::InterpBndryData::setBndryValues	(	BndryRegister &	crse,
		int	c_start,
		const MultiFab &	fine,
		int	f_start,
		int	bnd_start,
		int	num_comp,
		const IntVect &	ratio,
		const BCRec &	phys_bc,
		int	max_order = `IBD_max_order_DEF`
	)

virtual

set bndry values at fine level, performing necessary interpolations

Parameters

crse
c_start
fine
f_start
bnd_start
num_comp
ratio
phys_bc
max_order

◆ setBndryValues() [2/5]

void amrex::InterpBndryData::setBndryValues	(	BndryRegister &	crse,
		int	c_start,
		const MultiFab &	fine,
		int	f_start,
		int	bnd_start,
		int	num_comp,
		int	ratio,
		const BCRec &	phys_bc,
		int	max_order = `IBD_max_order_DEF`
	)

virtual

set bndry values at fine level, performing necessary interpolations

Parameters

crse
c_start
fine
f_start
bnd_start
num_comp
ratio
phys_bc
max_order

◆ setBndryValues() [3/5]

void amrex::InterpBndryData::setBndryValues	(	const MultiFab &	mf,
		int	mf_start,
		int	bnd_start,
		int	num_comp,
		const BCRec &	phys_bc
	)

virtual

set bndry values at coarse level (non interpolation performed)

Parameters

mf
mf_start
bnd_start
num_comp
phys_bc

◆ setBndryValues() [4/5]

void amrex::InterpBndryData::setBndryValues	(	const MultiFab &	mf,
		int	mf_start,
		int	bnd_start,
		int	num_comp,
		const IntVect &	ratio,
		const BCRec &	phys_bc
	)

virtual

◆ setBndryValues() [5/5]

void amrex::InterpBndryData::setBndryValues	(	const MultiFab &	mf,
		int	mf_start,
		int	bnd_start,
		int	num_comp,
		int	ratio,
		const BCRec &	phys_bc
	)

virtual

◆ setHomogValues()

void amrex::InterpBndryData::setHomogValues ( )

◆ updateBndryValues() [1/2]

void amrex::InterpBndryData::updateBndryValues	(	BndryRegister &	crse,
		int	c_start,
		int	bnd_start,
		int	num_comp,
		const IntVect &	ratio,
		int	max_order = `IBD_max_order_DEF`
	)

◆ updateBndryValues() [2/2]

void amrex::InterpBndryData::updateBndryValues	(	BndryRegister &	crse,
		int	c_start,
		int	bnd_start,
		int	num_comp,
		int	ratio,
		int	max_order = `IBD_max_order_DEF`
	)

Member Data Documentation

◆ IBD_max_order_DEF

int amrex::InterpBndryData::IBD_max_order_DEF = 3

static

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

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InterpBndryData() [1/4]

◆ InterpBndryData() [2/4]

◆ InterpBndryData() [3/4]

◆ ~InterpBndryData()

◆ InterpBndryData() [4/4]

Member Function Documentation

◆ BndryValuesDoIt()

◆ maxOrderDEF()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setBndryConds() [1/2]

◆ setBndryConds() [2/2]

◆ setBndryValues() [1/5]

◆ setBndryValues() [2/5]

◆ setBndryValues() [3/5]

◆ setBndryValues() [4/5]

◆ setBndryValues() [5/5]

◆ setHomogValues()

◆ updateBndryValues() [1/2]

◆ updateBndryValues() [2/2]

Member Data Documentation

◆ IBD_max_order_DEF