InjectorPosition Struct Reference

#include <InjectorPosition.H>

Classes
union	Object

Public Member Functions
	InjectorPosition (InjectorPositionRandom *t, amrex::Real a_xmin, amrex::Real a_xmax, amrex::Real a_ymin, amrex::Real a_ymax, amrex::Real a_zmin, amrex::Real a_zmax)
	InjectorPosition (InjectorPositionRandomPlane *t, amrex::Real a_xmin, amrex::Real a_xmax, amrex::Real a_ymin, amrex::Real a_ymax, amrex::Real a_zmin, amrex::Real a_zmax, int const &a_dir)
	InjectorPosition (InjectorPositionRegular *t, amrex::Real a_xmin, amrex::Real a_xmax, amrex::Real a_ymin, amrex::Real a_ymax, amrex::Real a_zmin, amrex::Real a_zmax, amrex::Dim3 const &a_ppc)
	~InjectorPosition ()=default
	InjectorPosition (InjectorPosition const &)=delete
	InjectorPosition (InjectorPosition &&)=delete
void	operator= (InjectorPosition const &)=delete
void	operator= (InjectorPosition &&)=delete
AMREX_GPU_HOST_DEVICE amrex::XDim3	getPositionUnitBox (int const i_part, amrex::IntVect const ref_fac, amrex::RandomEngine const &engine) const noexcept
AMREX_GPU_HOST_DEVICE bool	insideBounds (amrex::Real x, amrex::Real y, amrex::Real z) const noexcept
AMREX_GPU_HOST_DEVICE bool	insideBoundsInclusive (amrex::Real x, amrex::Real y, amrex::Real z) const noexcept
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool	overlapsWith (const amrex::XDim3 &lo, const amrex::XDim3 &hi) const noexcept

Private Types
enum struct	Type { random , randomplane , regular }

Private Attributes
Type	type
Object	object
amrex::Real	xmin
amrex::Real	xmax
amrex::Real	ymin
amrex::Real	ymax
amrex::Real	zmin
amrex::Real	zmax

Member Enumeration Documentation

Type

enum struct InjectorPosition::Type

strongprivate

Enumerator
random
randomplane
regular

Constructor & Destructor Documentation

InjectorPosition() [1/5]

InjectorPosition::InjectorPosition ( InjectorPositionRandom * t, amrex::Real a_xmin, amrex::Real a_xmax, amrex::Real a_ymin, amrex::Real a_ymax, amrex::Real a_zmin, amrex::Real a_zmax )

inline

InjectorPosition() [2/5]

InjectorPosition::InjectorPosition ( InjectorPositionRandomPlane * t, amrex::Real a_xmin, amrex::Real a_xmax, amrex::Real a_ymin, amrex::Real a_ymax, amrex::Real a_zmin, amrex::Real a_zmax, int const & a_dir )

inline

InjectorPosition() [3/5]

InjectorPosition::InjectorPosition ( InjectorPositionRegular * t, amrex::Real a_xmin, amrex::Real a_xmax, amrex::Real a_ymin, amrex::Real a_ymax, amrex::Real a_zmin, amrex::Real a_zmax, amrex::Dim3 const & a_ppc )

inline

~InjectorPosition()

InjectorPosition::~InjectorPosition ( )

default

InjectorPosition() [4/5]

InjectorPosition::InjectorPosition ( InjectorPosition const & )

delete

InjectorPosition() [5/5]

InjectorPosition::InjectorPosition ( InjectorPosition && )

delete

Member Function Documentation

getPositionUnitBox()

AMREX_GPU_HOST_DEVICE amrex::XDim3 InjectorPosition::getPositionUnitBox ( int const i_part, amrex::IntVect const ref_fac, amrex::RandomEngine const & engine ) const

inlinenodiscardnoexcept

insideBounds()

AMREX_GPU_HOST_DEVICE bool InjectorPosition::insideBounds ( amrex::Real x, amrex::Real y, amrex::Real z ) const

inlinenodiscardnoexcept

insideBoundsInclusive()

AMREX_GPU_HOST_DEVICE bool InjectorPosition::insideBoundsInclusive ( amrex::Real x, amrex::Real y, amrex::Real z ) const

inlinenodiscardnoexcept

operator=() [1/2]

void InjectorPosition::operator= ( InjectorPosition && )

delete

operator=() [2/2]

void InjectorPosition::operator= ( InjectorPosition const & )

delete

overlapsWith()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool InjectorPosition::overlapsWith ( const amrex::XDim3 & lo, const amrex::XDim3 & hi ) const

inlinenodiscardnoexcept

Member Data Documentation

object

Object InjectorPosition::object

private

type

Type InjectorPosition::type

private

xmax

amrex::Real InjectorPosition::xmax

private

xmin

amrex::Real InjectorPosition::xmin

private

ymax

amrex::Real InjectorPosition::ymax

private

ymin

amrex::Real InjectorPosition::ymin

private

zmax

amrex::Real InjectorPosition::zmax

private

zmin

amrex::Real InjectorPosition::zmin

private

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6368/Source/Initialization/InjectorPosition.H