BackgroundStopping Class Reference

#include <BackgroundStopping.H>

Inheritance diagram for BackgroundStopping:

Public Member Functions
	BackgroundStopping (std::string collision_name)
virtual	~BackgroundStopping ()=default
void	doCollisions (amrex::Real cur_time, amrex::Real dt, MultiParticleContainer *mypc) override
void	doBackgroundStoppingOnElectronsWithinTile (WarpXParIter &pti, amrex::Real dt, amrex::Real t, amrex::ParticleReal species_mass, amrex::ParticleReal species_charge)
void	doBackgroundStoppingOnIonsWithinTile (WarpXParIter &pti, amrex::Real dt, amrex::Real t, amrex::ParticleReal species_mass, amrex::ParticleReal species_charge)
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
int	get_ndt ()

Private Attributes
amrex::ParticleReal	m_background_mass
amrex::ParticleReal	m_background_charge_state
BackgroundStoppingType	m_background_type
amrex::Parser	m_background_density_parser
amrex::Parser	m_background_temperature_parser
amrex::ParserExecutor< 4 >	m_background_density_func
amrex::ParserExecutor< 4 >	m_background_temperature_func

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

Constructor & Destructor Documentation

BackgroundStopping()

BackgroundStopping::BackgroundStopping

(

std::string

collision_name

)

~BackgroundStopping()

virtual BackgroundStopping::~BackgroundStopping ( )

virtualdefault

Member Function Documentation

doBackgroundStoppingOnElectronsWithinTile()

void BackgroundStopping::doBackgroundStoppingOnElectronsWithinTile	(	WarpXParIter &	pti,
		amrex::Real	dt,
		amrex::Real	t,
		amrex::ParticleReal	species_mass,
		amrex::ParticleReal	species_charge
	)

Perform the stopping calculation within a tile for stopping on electrons

Parameters

pti	particle iterator
dt	time step size
t	current simulation time
species_mass	mass of the active species
species_charge	charge of the active species

doBackgroundStoppingOnIonsWithinTile()

void BackgroundStopping::doBackgroundStoppingOnIonsWithinTile	(	WarpXParIter &	pti,
		amrex::Real	dt,
		amrex::Real	t,
		amrex::ParticleReal	species_mass,
		amrex::ParticleReal	species_charge
	)

Perform the stopping calculation within a tile for stopping on ions

Parameters

pti	particle iterator
dt	time step size
t	current simulation time
species_mass	mass of the active species
species_charge	charge of the active species

doCollisions()

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

overridevirtual

Perform the stopping calculation

Parameters

cur_time	Current time
dt	Time step size
mypc	Container of species involved

Reimplemented from CollisionBase.

Member Data Documentation

m_background_charge_state

amrex::ParticleReal BackgroundStopping::m_background_charge_state

private

m_background_density_func

amrex::ParserExecutor<4> BackgroundStopping::m_background_density_func

private

m_background_density_parser

amrex::Parser BackgroundStopping::m_background_density_parser

private

m_background_mass

amrex::ParticleReal BackgroundStopping::m_background_mass

private

m_background_temperature_func

amrex::ParserExecutor<4> BackgroundStopping::m_background_temperature_func

private

m_background_temperature_parser

amrex::Parser BackgroundStopping::m_background_temperature_parser

private

m_background_type

BackgroundStoppingType BackgroundStopping::m_background_type

private

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/artemis-em/checkouts/latest/Source/Particles/Collision/BackgroundStopping/BackgroundStopping.H
• /home/docs/checkouts/readthedocs.org/user_builds/artemis-em/checkouts/latest/Source/Particles/Collision/BackgroundStopping/BackgroundStopping.cpp