InjectorDensity Struct Reference

#include <InjectorDensity.H>

Classes
union	Object

Public Member Functions
	InjectorDensity (InjectorDensityConstant *t, amrex::Real a_rho)
	InjectorDensity (InjectorDensityParser *t, amrex::ParserExecutor< 3 > const &a_parser)
	InjectorDensity (InjectorDensityPredefined *t, std::string const &a_species_name)
	InjectorDensity (InjectorDensityFromFile *t, std::string const &a_file_name, amrex::Geometry const &a_geom, bool a_distributed)
	InjectorDensity (InjectorDensity const &)=delete
	InjectorDensity (InjectorDensity &&)=delete
void	operator= (InjectorDensity const &)=delete
void	operator= (InjectorDensity &&)=delete
	~InjectorDensity ()=default
void	clear ()
void	prepare (amrex::BoxArray const &grids, amrex::DistributionMapping const &dmap, amrex::IntVect const &ngrow, std::function< amrex::Real(amrex::Real)> const &get_zlab)
void	prepare (amrex::RealBox const &pbox, int moving_dir, int moving_sign, std::function< amrex::Real(amrex::Real)> const &get_zlab)
void	prepare (int li, InjectorDensity **inj_rho)
bool	needPreparation () const
bool	distributed () const
AMREX_GPU_HOST_DEVICE amrex::Real	getDensity (amrex::Real x, amrex::Real y, amrex::Real z) const noexcept

Private Types
enum struct	Type { constant , predefined , parser , fromfile }

Private Attributes
Type	type
Object	object
std::unique_ptr< void, amrex::DataDeleter >	inj_rho_data
amrex::Vector< InjectorDensity * >	inj_rho_omp

Member Enumeration Documentation

Type

enum struct InjectorDensity::Type

strongprivate

Enumerator
constant
predefined
parser
fromfile

Constructor & Destructor Documentation

InjectorDensity() [1/6]

InjectorDensity::InjectorDensity ( InjectorDensityConstant * t, amrex::Real a_rho )

inline

InjectorDensity() [2/6]

InjectorDensity::InjectorDensity ( InjectorDensityParser * t, amrex::ParserExecutor< 3 > const & a_parser )

inline

InjectorDensity() [3/6]

InjectorDensity::InjectorDensity ( InjectorDensityPredefined * t, std::string const & a_species_name )

inline

InjectorDensity() [4/6]

InjectorDensity::InjectorDensity ( InjectorDensityFromFile * t, std::string const & a_file_name, amrex::Geometry const & a_geom, bool a_distributed )

inline

InjectorDensity() [5/6]

InjectorDensity::InjectorDensity ( InjectorDensity const & )

delete

InjectorDensity() [6/6]

InjectorDensity::InjectorDensity ( InjectorDensity && )

delete

~InjectorDensity()

InjectorDensity::~InjectorDensity ( )

default

Member Function Documentation

clear()

void InjectorDensity::clear

(

)

distributed()

bool InjectorDensity::distributed ( ) const

nodiscard

getDensity()

AMREX_GPU_HOST_DEVICE amrex::Real InjectorDensity::getDensity ( amrex::Real x, amrex::Real y, amrex::Real z ) const

inlinenodiscardnoexcept

needPreparation()

bool InjectorDensity::needPreparation ( ) const

nodiscard

operator=() [1/2]

void InjectorDensity::operator= ( InjectorDensity && )

delete

operator=() [2/2]

void InjectorDensity::operator= ( InjectorDensity const & )

delete

prepare() [1/3]

void InjectorDensity::prepare	(	amrex::BoxArray const &	grids,
		amrex::DistributionMapping const &	dmap,
		amrex::IntVect const &	ngrow,
		std::function< amrex::Real(amrex::Real)> const &	get_zlab )

prepare() [2/3]

void InjectorDensity::prepare	(	amrex::RealBox const &	pbox,
		int	moving_dir,
		int	moving_sign,
		std::function< amrex::Real(amrex::Real)> const &	get_zlab )

prepare() [3/3]

void InjectorDensity::prepare	(	int	li,
		InjectorDensity **	inj_rho )

Member Data Documentation

inj_rho_data

std::unique_ptr<void,amrex::DataDeleter> InjectorDensity::inj_rho_data

private

inj_rho_omp

amrex::Vector<InjectorDensity*> InjectorDensity::inj_rho_omp

private

object

Object InjectorDensity::object

private

type

Type InjectorDensity::type

private

---

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

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