InjectorMomentum Struct Reference

#include <InjectorMomentum.H>

Classes
union	Object

Public Types
enum struct	Type {   constant , gaussian , gaussianflux , uniform ,   maxwellian , juttner , parser }

Public Member Functions
	InjectorMomentum (InjectorMomentumConstant *t, amrex::Real a_ux, amrex::Real a_uy, amrex::Real a_uz)
	InjectorMomentum (InjectorMomentumParser *t, amrex::ParserExecutor< 3 > const &a_ux_parser, amrex::ParserExecutor< 3 > const &a_uy_parser, amrex::ParserExecutor< 3 > const &a_uz_parser)
	InjectorMomentum (InjectorMomentumGaussian *t, amrex::Real a_ux_m, amrex::Real a_uy_m, amrex::Real a_uz_m, amrex::Real a_ux_th, amrex::Real a_uy_th, amrex::Real a_uz_th)
	InjectorMomentum (InjectorMomentumGaussianFlux *t, amrex::Real a_ux_m, amrex::Real a_uy_m, amrex::Real a_uz_m, amrex::Real a_ux_th, amrex::Real a_uy_th, amrex::Real a_uz_th, int a_flux_normal_axis, int a_flux_direction)
	InjectorMomentum (InjectorMomentumUniform *t, amrex::Real a_ux_min, amrex::Real a_uy_min, amrex::Real a_uz_min, amrex::Real a_ux_max, amrex::Real a_uy_max, amrex::Real a_uz_max)
	InjectorMomentum (InjectorMomentumMaxwellian *t, GetTemperatureVector const &temperature, GetVelocityVector const &velocity)
	InjectorMomentum (InjectorMomentumJuttner *t, GetTemperature const &temperature, GetVelocity const &velocity)
	InjectorMomentum (InjectorMomentum const &)=delete
	InjectorMomentum (InjectorMomentum &&)=delete
void	operator= (InjectorMomentum const &)=delete
void	operator= (InjectorMomentum &&)=delete
	~InjectorMomentum ()=default
void	clear ()
AMREX_GPU_HOST_DEVICE amrex::XDim3	getMomentum (amrex::Real x, amrex::Real y, amrex::Real z, amrex::RandomEngine const &engine) const noexcept
AMREX_GPU_HOST_DEVICE amrex::XDim3	getBulkMomentum (amrex::Real x, amrex::Real y, amrex::Real z) const noexcept

Public Attributes
Type	type

Private Attributes
Object	object

Member Enumeration Documentation

Type

enum struct InjectorMomentum::Type

strong

Enumerator
constant
gaussian
gaussianflux
uniform
maxwellian
juttner
parser

Constructor & Destructor Documentation

InjectorMomentum() [1/9]

InjectorMomentum::InjectorMomentum ( InjectorMomentumConstant * t, amrex::Real a_ux, amrex::Real a_uy, amrex::Real a_uz )

inline

InjectorMomentum() [2/9]

InjectorMomentum::InjectorMomentum ( InjectorMomentumParser * t, amrex::ParserExecutor< 3 > const & a_ux_parser, amrex::ParserExecutor< 3 > const & a_uy_parser, amrex::ParserExecutor< 3 > const & a_uz_parser )

inline

InjectorMomentum() [3/9]

InjectorMomentum::InjectorMomentum ( InjectorMomentumGaussian * t, amrex::Real a_ux_m, amrex::Real a_uy_m, amrex::Real a_uz_m, amrex::Real a_ux_th, amrex::Real a_uy_th, amrex::Real a_uz_th )

inline

InjectorMomentum() [4/9]

InjectorMomentum::InjectorMomentum ( InjectorMomentumGaussianFlux * t, amrex::Real a_ux_m, amrex::Real a_uy_m, amrex::Real a_uz_m, amrex::Real a_ux_th, amrex::Real a_uy_th, amrex::Real a_uz_th, int a_flux_normal_axis, int a_flux_direction )

inline

InjectorMomentum() [5/9]

InjectorMomentum::InjectorMomentum ( InjectorMomentumUniform * t, amrex::Real a_ux_min, amrex::Real a_uy_min, amrex::Real a_uz_min, amrex::Real a_ux_max, amrex::Real a_uy_max, amrex::Real a_uz_max )

inline

InjectorMomentum() [6/9]

InjectorMomentum::InjectorMomentum ( InjectorMomentumMaxwellian * t, GetTemperatureVector const & temperature, GetVelocityVector const & velocity )

inline

InjectorMomentum() [7/9]

InjectorMomentum::InjectorMomentum ( InjectorMomentumJuttner * t, GetTemperature const & temperature, GetVelocity const & velocity )

inline

InjectorMomentum() [8/9]

InjectorMomentum::InjectorMomentum ( InjectorMomentum const & )

delete

InjectorMomentum() [9/9]

InjectorMomentum::InjectorMomentum ( InjectorMomentum && )

delete

~InjectorMomentum()

InjectorMomentum::~InjectorMomentum ( )

default

Member Function Documentation

clear()

void InjectorMomentum::clear

(

)

getBulkMomentum()

AMREX_GPU_HOST_DEVICE amrex::XDim3 InjectorMomentum::getBulkMomentum ( amrex::Real x, amrex::Real y, amrex::Real z ) const

inlinenodiscardnoexcept

getMomentum()

AMREX_GPU_HOST_DEVICE amrex::XDim3 InjectorMomentum::getMomentum ( amrex::Real x, amrex::Real y, amrex::Real z, amrex::RandomEngine const & engine ) const

inlinenodiscardnoexcept

operator=() [1/2]

void InjectorMomentum::operator= ( InjectorMomentum && )

delete

operator=() [2/2]

void InjectorMomentum::operator= ( InjectorMomentum const & )

delete

Member Data Documentation

object

Object InjectorMomentum::object

private

type

Type InjectorMomentum::type

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/26.06/Source/Initialization/InjectorMomentum.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/26.06/Source/Initialization/InjectorMomentum.cpp