MCCProcess Class Reference

#include <MCCProcess.H>

Classes
struct	Executor

Public Member Functions
	MCCProcess (const std::string &scattering_process, const std::string &cross_section_file, const amrex::Real energy)
template<typename InputVector >
	MCCProcess (const std::string &scattering_process, const InputVector &&energies, const InputVector &&sigmas, const amrex::Real energy)
	MCCProcess (MCCProcess const &)=delete
MCCProcess &	operator= (MCCProcess const &)=delete
	MCCProcess (MCCProcess &&)=default
MCCProcess &	operator= (MCCProcess &&)=default
Executor const &	executor () const
amrex::Real	getCrossSection (amrex::Real E_coll) const
amrex::Real	getEnergyPenalty () const
MCCProcessType	type () const

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

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

Static Private Member Functions
static MCCProcessType	parseProcessType (const std::string &process)

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

Constructor & Destructor Documentation

MCCProcess() [1/4]

MCCProcess::MCCProcess	(	const std::string &	scattering_process,
		const std::string &	cross_section_file,
		const amrex::Real	energy
	)

MCCProcess() [2/4]

template<typename InputVector >

MCCProcess::MCCProcess	(	const std::string &	scattering_process,
		const InputVector &&	energies,
		const InputVector &&	sigmas,
		const amrex::Real	energy
	)

MCCProcess() [3/4]

MCCProcess::MCCProcess ( MCCProcess const &  )

delete

MCCProcess() [4/4]

MCCProcess::MCCProcess ( MCCProcess &&  )

default

Member Function Documentation

executor()

Executor const& MCCProcess::executor ( ) const

inline

getCrossSection()

amrex::Real MCCProcess::getCrossSection ( amrex::Real  E_coll ) const

inline

getEnergyPenalty()

amrex::Real MCCProcess::getEnergyPenalty ( ) const

inline

init()

void MCCProcess::init ( const std::string &  scattering_process, const amrex::Real  energy  )

private

operator=() [1/2]

MCCProcess& MCCProcess::operator= ( MCCProcess const &  )

delete

operator=() [2/2]

MCCProcess& MCCProcess::operator= ( MCCProcess &&  )

default

parseProcessType()

MCCProcessType MCCProcess::parseProcessType ( const std::string &  process )

staticprivate

readCrossSectionFile()

void MCCProcess::readCrossSectionFile ( const std::string  cross_section_file, amrex::Vector< amrex::Real > &  energies, amrex::Gpu::HostVector< amrex::Real > &  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 MCCProcess::sanityCheckEnergyGrid ( const amrex::Vector< amrex::Real > &  energies, amrex::Real  dE  )

static

type()

MCCProcessType MCCProcess::type ( ) const

inline

Member Data Documentation

m_energies

amrex::Vector<amrex::Real> MCCProcess::m_energies

private

m_exe_h

Executor MCCProcess::m_exe_h

private

m_grid_size

int MCCProcess::m_grid_size

private

m_sigmas_h

amrex::Gpu::HostVector<amrex::Real> MCCProcess::m_sigmas_h

private

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/21.10/Source/Particles/Collision/MCCProcess.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/21.10/Source/Particles/Collision/MCCProcess.cpp