CollisionBase Class Reference

#include <CollisionBase.H>

Inheritance diagram for CollisionBase:

Public Member Functions
	CollisionBase (const std::string &collision_name)
virtual void	doCollisions (amrex::Real, amrex::Real, MultiParticleContainer *)
	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

Protected Attributes
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

CollisionBase() [1/3]

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

explicit

CollisionBase() [2/3]

CollisionBase::CollisionBase ( CollisionBase const & )

delete

CollisionBase() [3/3]

CollisionBase::CollisionBase ( CollisionBase && )

delete

~CollisionBase()

virtual CollisionBase::~CollisionBase ( )

virtualdefault

Member Function Documentation

BackwardCompatibility()

void CollisionBase::BackwardCompatibility

(

)

doCollisions()

virtual void CollisionBase::doCollisions ( amrex::Real , amrex::Real , MultiParticleContainer *  )

inlinevirtual

Reimplemented in BackgroundMCCCollision, BackgroundStopping, BinaryCollision< CollisionFunctor, CopyTransformFunctor >, InverseBremsstrahlung, and PulsedDecay.

get_collision_stepping_mode()

CollisionSteppingMode CollisionBase::get_collision_stepping_mode ( ) const

inlinenodiscard

get_ndt()

int CollisionBase::get_ndt ( ) const

inlinenodiscard

operator=() [1/2]

CollisionBase & CollisionBase::operator= ( CollisionBase const && )

delete

operator=() [2/2]

CollisionBase & CollisionBase::operator= ( CollisionBase const & )

delete

use_global_debye_length()

bool CollisionBase::use_global_debye_length ( ) const

inlinenodiscard

Member Data Documentation

m_collision_name

std::string CollisionBase::m_collision_name

protected

m_collision_stepping_mode

CollisionSteppingMode CollisionBase::m_collision_stepping_mode = CollisionSteppingMode::Supercycle

protected

m_ndt

int CollisionBase::m_ndt = 1

protected

m_species_names

amrex::Vector<std::string> CollisionBase::m_species_names

protected

m_use_global_debye_length

bool CollisionBase::m_use_global_debye_length = false

protected

---

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