amrex::StateDescriptor::BndryFunc Class Reference

#include <AMReX_StateDescriptor.H>

Public Member Functions
	BndryFunc () noexcept=default
	Bogus constructor. More...
	BndryFunc (BndryFuncDefault inFunc) noexcept
	A Constructor. More...
	BndryFunc (BndryFunc3DDefault inFunc) noexcept
	BndryFunc (BndryFuncFabDefault inFunc) noexcept
	BndryFunc (BndryFuncDefault inFunc, BndryFuncDefault gFunc) noexcept
	Another Constructor. More...
	BndryFunc (BndryFunc3DDefault inFunc, BndryFunc3DDefault gFunc) noexcept
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
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 "group" function. More...
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
bool	RunOnGPU () const noexcept
void	setRunOnGPU (bool b) noexcept
bool	hasFabVersion () const noexcept

Private Attributes
BndryFuncDefault	m_func = nullptr
BndryFunc3DDefault	m_func3D = nullptr
BndryFuncDefault	m_gfunc = nullptr
BndryFunc3DDefault	m_gfunc3D = nullptr
BndryFuncFabDefault	m_funcfab = nullptr
bool	m_run_on_gpu = false

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

A Constructor.

BndryFunc() [3/6]

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

inlinenoexcept

BndryFunc() [4/6]

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

inlinenoexcept

BndryFunc() [5/6]

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

inlinenoexcept

Another Constructor.

Parameters

inFunc
gFunc

BndryFunc() [6/6]

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

inlinenoexcept

Member Function Documentation

hasFabVersion()

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

inlinenoexcept

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

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 "regular" function.

Parameters

data
lo
hi
dom_lo
dom_hi
dx
grd_lo
time
bc

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 "group" function.

Parameters

data
lo
hi
dom_lo
dom_hi
dx
grd_lo
time
bc
ng

RunOnGPU()

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

inlinenoexcept

setRunOnGPU()

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

inlinenoexcept

Member Data Documentation

m_func

BndryFuncDefault amrex::StateDescriptor::BndryFunc::m_func = nullptr

private

m_func3D

BndryFunc3DDefault amrex::StateDescriptor::BndryFunc::m_func3D = nullptr

private

m_funcfab

BndryFuncFabDefault amrex::StateDescriptor::BndryFunc::m_funcfab = nullptr

private

m_gfunc

BndryFuncDefault amrex::StateDescriptor::BndryFunc::m_gfunc = nullptr

private

m_gfunc3D

BndryFunc3DDefault amrex::StateDescriptor::BndryFunc::m_gfunc3D = nullptr

private

m_run_on_gpu

bool amrex::StateDescriptor::BndryFunc::m_run_on_gpu = false

private

---

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