ScatteringProcess Class Reference

#include <ScatteringProcess.H>

Classes
struct	Executor

Public Member Functions
	ScatteringProcess (const std::string &scattering_process, const std::string &cross_section_file, amrex::ParticleReal energy, ScatteringAngleModel scattering_angle_model)
template<typename InputVector>
	ScatteringProcess (const std::string &scattering_process, const InputVector &&energies, const InputVector &&sigmas, amrex::ParticleReal energy, ScatteringAngleModel scattering_angle_model)
	~ScatteringProcess ()=default
	ScatteringProcess (ScatteringProcess const &)=delete
ScatteringProcess &	operator= (ScatteringProcess const &)=delete
	ScatteringProcess (ScatteringProcess &&)=default
ScatteringProcess &	operator= (ScatteringProcess &&)=default
Executor const &	executor () const
amrex::ParticleReal	getCrossSection (amrex::ParticleReal E_coll) const
amrex::ParticleReal	getEnergyPenalty () const
amrex::ParticleReal	getMinEnergyInput () const
amrex::ParticleReal	getMaxEnergyInput () const
amrex::ParticleReal	getEnergyInputStep () const
ScatteringProcessType	type () const

Static Public Member Functions
static void	readCrossSectionFile (const std::string &cross_section_file, amrex::Vector< amrex::ParticleReal > &energies, amrex::Gpu::HostVector< amrex::ParticleReal > &sigmas)
static void	sanityCheckEnergyGrid (const amrex::Vector< amrex::ParticleReal > &energies, amrex::ParticleReal dE)
static ScatteringProcessType	parseProcessType (const std::string &process)

Private Member Functions
void	init (const std::string &scattering_process, amrex::ParticleReal energy, ScatteringAngleModel scattering_angle_model)

Private Attributes
amrex::Vector< amrex::ParticleReal >	m_energies
amrex::Gpu::HostVector< amrex::ParticleReal >	m_sigmas_h
Executor	m_exe_h
int	m_grid_size

Constructor & Destructor Documentation

ScatteringProcess() [1/4]

ScatteringProcess::ScatteringProcess	(	const std::string &	scattering_process,
		const std::string &	cross_section_file,
		amrex::ParticleReal	energy,
		ScatteringAngleModel	scattering_angle_model )

ScatteringProcess() [2/4]

template<typename InputVector>

ScatteringProcess::ScatteringProcess	(	const std::string &	scattering_process,
		const InputVector &&	energies,
		const InputVector &&	sigmas,
		amrex::ParticleReal	energy,
		ScatteringAngleModel	scattering_angle_model )

~ScatteringProcess()

ScatteringProcess::~ScatteringProcess ( )

default

ScatteringProcess() [3/4]

ScatteringProcess::ScatteringProcess ( ScatteringProcess const & )

delete

ScatteringProcess() [4/4]

ScatteringProcess::ScatteringProcess ( ScatteringProcess && )

default

Member Function Documentation

executor()

Executor const & ScatteringProcess::executor ( ) const

inlinenodiscard

getCrossSection()

amrex::ParticleReal ScatteringProcess::getCrossSection ( amrex::ParticleReal E_coll ) const

inlinenodiscard

getEnergyInputStep()

amrex::ParticleReal ScatteringProcess::getEnergyInputStep ( ) const

inlinenodiscard

getEnergyPenalty()

amrex::ParticleReal ScatteringProcess::getEnergyPenalty ( ) const

inlinenodiscard

getMaxEnergyInput()

amrex::ParticleReal ScatteringProcess::getMaxEnergyInput ( ) const

inlinenodiscard

getMinEnergyInput()

amrex::ParticleReal ScatteringProcess::getMinEnergyInput ( ) const

inlinenodiscard

init()

void ScatteringProcess::init ( const std::string & scattering_process, amrex::ParticleReal energy, ScatteringAngleModel scattering_angle_model )

private

operator=() [1/2]

ScatteringProcess & ScatteringProcess::operator= ( ScatteringProcess && )

default

operator=() [2/2]

ScatteringProcess & ScatteringProcess::operator= ( ScatteringProcess const & )

delete

parseProcessType()

ScatteringProcessType ScatteringProcess::parseProcessType ( const std::string & process )

static

readCrossSectionFile()

void ScatteringProcess::readCrossSectionFile ( const std::string & cross_section_file, amrex::Vector< amrex::ParticleReal > & energies, amrex::Gpu::HostVector< amrex::ParticleReal > & sigmas )

static

Read the given cross-section data file to memory.

Parameters

cross_section_file	the path to the file containing the cross- section data
energies	vector storing energy values in eV
sigmas	vector storing cross-section values

sanityCheckEnergyGrid()

void ScatteringProcess::sanityCheckEnergyGrid ( const amrex::Vector< amrex::ParticleReal > & energies, amrex::ParticleReal dE )

static

type()

ScatteringProcessType ScatteringProcess::type ( ) const

inlinenodiscard

Member Data Documentation

m_energies

amrex::Vector<amrex::ParticleReal> ScatteringProcess::m_energies

private

m_exe_h

Executor ScatteringProcess::m_exe_h

private

m_grid_size

int ScatteringProcess::m_grid_size

private

m_sigmas_h

amrex::Gpu::HostVector<amrex::ParticleReal> ScatteringProcess::m_sigmas_h

private

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/latest/Source/Particles/Collision/ScatteringProcess.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/latest/Source/Particles/Collision/ScatteringProcess.cpp