amrex::StateDescriptor::BndryFunc Class Reference

#include <AMReX_StateDescriptor.H>

Public Member Functions
	BndryFunc () noexcept=default
	Bogus constructor.
	BndryFunc (BndryFuncDefault inFunc) noexcept
	Construct from a scalar boundary-fill callback inFunc.
	BndryFunc (BndryFunc3DDefault inFunc) noexcept
	Construct from a 3-D boundary-fill callback inFunc.
	BndryFunc (BndryFuncFabDefault inFunc) noexcept
	Construct from a FAB-aware functor inFunc.
	BndryFunc (BndryFuncDefault inFunc, BndryFuncDefault gFunc) noexcept
	Constructor that installs both regular and group boundary callbacks.
	BndryFunc (BndryFunc3DDefault inFunc, BndryFunc3DDefault gFunc) noexcept
	3D counterpart installing per-cell function inFunc and group function gFunc.
void	operator() (Real *data, const int *lo, const int *hi, const int *dom_lo, const int *dom_hi, const Real *dx, const Real *grd_lo, const Real *time, const int *bc) const
	Fill boundary cells using the "regular" scalar function pointer.
void	operator() (Real *data, const int *lo, const int *hi, const int *dom_lo, const int *dom_hi, const Real *dx, const Real *grd_lo, const Real *time, const int *bc, int ng) const
	Fill boundary cells using the "group" function (supports grown regions).
void	operator() (Box const &bx, FArrayBox &data, int dcomp, int numcomp, Geometry const &geom, Real time, const Vector< BCRec > &bcr, int bcomp, int scomp) const
	FAB-aware overload that operates directly on data over bx at time time.
bool	RunOnGPU () const noexcept
void	setRunOnGPU (bool b) noexcept
bool	hasFabVersion () const noexcept

Detailed Description

Type of function called by BCRec for user-supplied boundary data.

Class wrapper around BndryFuncDefault.

Constructor & Destructor Documentation

BndryFunc() [1/6]

amrex::StateDescriptor::BndryFunc::BndryFunc ( )

defaultnoexcept

Bogus constructor.

BndryFunc() [2/6]

amrex::StateDescriptor::BndryFunc::BndryFunc ( BndryFuncDefault inFunc )

inlinenoexcept

Construct from a scalar boundary-fill callback inFunc.

Parameters

inFunc

Function that fills ghost cells one component at a time.

BndryFunc() [3/6]

amrex::StateDescriptor::BndryFunc::BndryFunc ( BndryFunc3DDefault inFunc )

inlinenoexcept

Construct from a 3-D boundary-fill callback inFunc.

Parameters

inFunc

Function that fills ghost cells using 3-D array arguments.

BndryFunc() [4/6]

amrex::StateDescriptor::BndryFunc::BndryFunc ( BndryFuncFabDefault inFunc )

inlinenoexcept

Construct from a FAB-aware functor inFunc.

Parameters

inFunc

Callable that operates directly on FArrayBox data.

BndryFunc() [5/6]

amrex::StateDescriptor::BndryFunc::BndryFunc ( BndryFuncDefault inFunc, BndryFuncDefault gFunc )

inlinenoexcept

Constructor that installs both regular and group boundary callbacks.

Parameters

inFunc	Function used for per-cell BC fills.
gFunc	Function used when treating grown regions as a whole.

BndryFunc() [6/6]

amrex::StateDescriptor::BndryFunc::BndryFunc ( BndryFunc3DDefault inFunc, BndryFunc3DDefault gFunc )

inlinenoexcept

3D counterpart installing per-cell function inFunc and group function gFunc.

Member Function Documentation

hasFabVersion()

bool amrex::StateDescriptor::BndryFunc::hasFabVersion ( ) const

inlinenodiscardnoexcept

operator()() [1/3]

void amrex::StateDescriptor::BndryFunc::operator()	(	Box const &	bx,
		FArrayBox &	data,
		int	dcomp,
		int	numcomp,
		Geometry const &	geom,
		Real	time,
		const Vector< BCRec > &	bcr,
		int	bcomp,
		int	scomp ) const

FAB-aware overload that operates directly on data over bx at time time.

Parameters

bx	Region to fill.
data	FAB storing the components.
dcomp	Destination component offset in data.
numcomp	Number of components to update.
geom	Geometry describing the level.
time	Physical time at which BCs are evaluated.
bcr	Array of BCRecs (one per component).
bcomp	Starting component offset into bcr.
scomp	Source component offset when referencing BC metadata.

operator()() [2/3]

void amrex::StateDescriptor::BndryFunc::operator()	(	Real *	data,
		const int *	lo,
		const int *	hi,
		const int *	dom_lo,
		const int *	dom_hi,
		const Real *	dx,
		const Real *	grd_lo,
		const Real *	time,
		const int *	bc ) const

Fill boundary cells using the "regular" scalar function pointer.

Parameters

data	Pointer to the raw FAB data.
lo	Lower bounds of the region being filled.
hi	Upper bounds of the region being filled.
dom_lo	Lower bounds of the domain.
dom_hi	Upper bounds of the domain.
dx	Cell spacing array.
grd_lo	Index-space location of the owning grid.
time	Physical time (as an array for compatibility).
bc	Encoded boundary condition types.

operator()() [3/3]

void amrex::StateDescriptor::BndryFunc::operator()	(	Real *	data,
		const int *	lo,
		const int *	hi,
		const int *	dom_lo,
		const int *	dom_hi,
		const Real *	dx,
		const Real *	grd_lo,
		const Real *	time,
		const int *	bc,
		int	ng ) const

Fill boundary cells using the "group" function (supports grown regions).

Parameters

data	Pointer to the raw FAB data.
lo	Lower bounds of the region being filled.
hi	Upper bounds of the region being filled.
dom_lo	Lower bounds of the domain.
dom_hi	Upper bounds of the domain.
dx	Cell spacing array.
grd_lo	Index-space location of the owning grid.
time	Physical time (as an array for compatibility).
bc	Encoded boundary condition types.
ng	Number of ghost cells to treat as a group.

RunOnGPU()

bool amrex::StateDescriptor::BndryFunc::RunOnGPU ( ) const

inlinenodiscardnoexcept

setRunOnGPU()

void amrex::StateDescriptor::BndryFunc::setRunOnGPU ( bool b )

inlinenoexcept

---

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

• /home/runner/work/amrex/amrex/Src/Amr/AMReX_StateDescriptor.H
• /home/runner/work/amrex/amrex/Src/Amr/AMReX_StateDescriptor.cpp