BackgroundStopping Class Reference

#include <BackgroundStopping.H>

Inheritance diagram for BackgroundStopping:

Public Member Functions
	BackgroundStopping (const std::string &collision_name)
	~BackgroundStopping () override=default
	BackgroundStopping (BackgroundStopping const &)=delete
BackgroundStopping &	operator= (BackgroundStopping const &)=delete
	BackgroundStopping (BackgroundStopping &&)=delete
BackgroundStopping &	operator= (BackgroundStopping &&)=delete
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 (const std::string &collision_name)
	CollisionBase (CollisionBase const &)=delete
	CollisionBase (CollisionBase &&)=delete
CollisionBase &	operator= (CollisionBase const &)=delete
CollisionBase &	operator= (CollisionBase const &&)=delete
virtual	~CollisionBase ()=default
void	BackwardCompatibility ()
int	get_ndt () const
CollisionSteppingMode	get_collision_stepping_mode () const
bool	use_global_debye_length () const

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
std::string	m_collision_name
amrex::Vector< std::string >	m_species_names
int	m_ndt = 1
CollisionSteppingMode	m_collision_stepping_mode = CollisionSteppingMode::Supercycle
bool	m_use_global_debye_length = false

Constructor & Destructor Documentation

BackgroundStopping() [1/3]

BackgroundStopping::BackgroundStopping ( const std::string & collision_name )

explicit

~BackgroundStopping()

BackgroundStopping::~BackgroundStopping ( )

overridedefault

BackgroundStopping() [2/3]

BackgroundStopping::BackgroundStopping ( BackgroundStopping const & )

delete

BackgroundStopping() [3/3]

BackgroundStopping::BackgroundStopping ( BackgroundStopping && )

delete

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.

operator=() [1/2]

BackgroundStopping & BackgroundStopping::operator= ( BackgroundStopping && )

delete

operator=() [2/2]

BackgroundStopping & BackgroundStopping::operator= ( BackgroundStopping const & )

delete

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