BackgroundMCCCollision Class Reference

#include <BackgroundMCCCollision.H>

Inheritance diagram for BackgroundMCCCollision:

Public Member Functions
	BackgroundMCCCollision (std::string collision_name)
virtual	~BackgroundMCCCollision ()=default
amrex::Real	get_nu_max (amrex::Vector< MCCProcess > const &mcc_processes)
void	doCollisions (amrex::Real cur_time, MultiParticleContainer *mypc) override
void	doBackgroundCollisionsWithinTile (WarpXParIter &pti)
void	doBackgroundIonization (int lev, WarpXParticleContainer &species1, WarpXParticleContainer &species2)
Public Member Functions inherited from CollisionBase
	CollisionBase (std::string collision_name)
	CollisionBase (CollisionBase const &)=delete
	CollisionBase (CollisionBase &&)=delete
CollisionBase &	operator= (CollisionBase const &)=delete
virtual	~CollisionBase ()=default

Private Attributes
amrex::Vector< MCCProcess >	m_scattering_processes
amrex::Vector< MCCProcess >	m_ionization_processes
amrex::Gpu::DeviceVector< MCCProcess::Executor >	m_scattering_processes_exe
amrex::Gpu::DeviceVector< MCCProcess::Executor >	m_ionization_processes_exe
bool	init_flag = false
bool	ionization_flag = false
amrex::Real	m_mass1
amrex::Real	m_background_temperature
amrex::Real	m_background_density
amrex::Real	m_background_mass
amrex::Real	m_total_collision_prob
amrex::Real	m_total_collision_prob_ioniz = 0
amrex::Real	m_nu_max
amrex::Real	m_nu_max_ioniz

Additional Inherited Members
Protected Attributes inherited from CollisionBase
amrex::Vector< std::string >	m_species_names
int	m_ndt

Constructor & Destructor Documentation

BackgroundMCCCollision()

BackgroundMCCCollision::BackgroundMCCCollision

(

std::string

collision_name

)

~BackgroundMCCCollision()

virtual BackgroundMCCCollision::~BackgroundMCCCollision ( )

virtualdefault

Member Function Documentation

doBackgroundCollisionsWithinTile()

void BackgroundMCCCollision::doBackgroundCollisionsWithinTile

(

WarpXParIter &

pti

)

Perform particle conserving MCC collisions within a tile

Parameters

pti	particle iterator

Perform all particle conserving MCC collisions within a tile

Parameters

pti	particle iterator

doBackgroundIonization()

void BackgroundMCCCollision::doBackgroundIonization	(	int	lev,
		WarpXParticleContainer &	species1,
		WarpXParticleContainer &	species2
	)

Perform MCC ionization interactions

Parameters

pti	particle iterator
species1/2	reference to species container used to inject new particles

Perform MCC ionization interactions

Parameters

pti	particle iterator
species1/2	reference to species container used to inject new particles from ionization events

doCollisions()

void BackgroundMCCCollision::doCollisions ( amrex::Real  cur_time, MultiParticleContainer *  mypc  )

overridevirtual

Perform the collisions

Parameters

cur_time	Current time
mypc	Container of species involved

Reimplemented from CollisionBase.

get_nu_max()

amrex::Real BackgroundMCCCollision::get_nu_max

(

amrex::Vector< MCCProcess > const &

mcc_processes

)

Calculate the maximum collision frequency using a fixed energy grid that ranges from 1e-4 to 5000 eV in 0.2 eV increments

Member Data Documentation

init_flag

bool BackgroundMCCCollision::init_flag = false

private

ionization_flag

bool BackgroundMCCCollision::ionization_flag = false

private

m_background_density

amrex::Real BackgroundMCCCollision::m_background_density

private

m_background_mass

amrex::Real BackgroundMCCCollision::m_background_mass

private

m_background_temperature

amrex::Real BackgroundMCCCollision::m_background_temperature

private

m_ionization_processes

amrex::Vector<MCCProcess> BackgroundMCCCollision::m_ionization_processes

private

m_ionization_processes_exe

amrex::Gpu::DeviceVector<MCCProcess::Executor> BackgroundMCCCollision::m_ionization_processes_exe

private

m_mass1

amrex::Real BackgroundMCCCollision::m_mass1

private

m_nu_max

amrex::Real BackgroundMCCCollision::m_nu_max

private

m_nu_max_ioniz

amrex::Real BackgroundMCCCollision::m_nu_max_ioniz

private

m_scattering_processes

amrex::Vector<MCCProcess> BackgroundMCCCollision::m_scattering_processes

private

m_scattering_processes_exe

amrex::Gpu::DeviceVector<MCCProcess::Executor> BackgroundMCCCollision::m_scattering_processes_exe

private

m_total_collision_prob

amrex::Real BackgroundMCCCollision::m_total_collision_prob

private

m_total_collision_prob_ioniz

amrex::Real BackgroundMCCCollision::m_total_collision_prob_ioniz = 0

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/BackgroundMCCCollision.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/21.10/Source/Particles/Collision/BackgroundMCCCollision.cpp