InjectorMomentum Struct Reference

#include <InjectorMomentum.H>

Classes
union	Object

Public Member Functions
	InjectorMomentum (InjectorMomentumConstant *t, amrex::Real a_ux, amrex::Real a_uy, amrex::Real a_uz)
	InjectorMomentum (InjectorMomentumParser *t, WarpXParser const &a_ux_parser, WarpXParser const &a_uy_parser, WarpXParser 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 (InjectorMomentumBoltzmann *t, amrex::Real theta, amrex::Real beta, int dir)
	InjectorMomentum (InjectorMomentumJuttner *t, amrex::Real theta, amrex::Real beta, int dir)
	InjectorMomentum (InjectorMomentumCustom *t, std::string const &a_species_name)
	InjectorMomentum (InjectorMomentumRadialExpansion *t, amrex::Real u_over_r)
	InjectorMomentum (InjectorMomentum const &)=delete
	InjectorMomentum (InjectorMomentum &&)=delete
void	operator= (InjectorMomentum const &)=delete
void	operator= (InjectorMomentum &&)=delete
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

Private Types
enum	Type {   Type::constant, Type::custom, Type::gaussian, Type::boltzmann,   Type::juttner, Type::radial_expansion, Type::parser }

Private Attributes
Type	type
Object	object

Member Enumeration Documentation

Type

enum InjectorMomentum::Type

strongprivate

Enumerator
constant
custom
gaussian
boltzmann
juttner
radial_expansion
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, WarpXParser const &  a_ux_parser, WarpXParser const &  a_uy_parser, WarpXParser 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 ( InjectorMomentumBoltzmann *  t, amrex::Real  theta, amrex::Real  beta, int  dir  )

inline

InjectorMomentum() [5/9]

InjectorMomentum::InjectorMomentum ( InjectorMomentumJuttner *  t, amrex::Real  theta, amrex::Real  beta, int  dir  )

inline

InjectorMomentum() [6/9]

InjectorMomentum::InjectorMomentum ( InjectorMomentumCustom *  t, std::string const &  a_species_name  )

inline

InjectorMomentum() [7/9]

InjectorMomentum::InjectorMomentum ( InjectorMomentumRadialExpansion *  t, amrex::Real  u_over_r  )

inline

InjectorMomentum() [8/9]

InjectorMomentum::InjectorMomentum ( InjectorMomentum const &  )

delete

InjectorMomentum() [9/9]

InjectorMomentum::InjectorMomentum ( InjectorMomentum &&  )

delete

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

inlinenoexcept

getMomentum()

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

inlinenoexcept

operator=() [1/2]

void InjectorMomentum::operator= ( InjectorMomentum const &  )

delete

operator=() [2/2]

void InjectorMomentum::operator= ( InjectorMomentum &&  )

delete

Member Data Documentation

object

Object InjectorMomentum::object

private

type

Type InjectorMomentum::type

private

---

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

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