WarpX
Public Member Functions | Private Attributes | List of all members
BackgroundStopping Class Referencefinal

#include <BackgroundStopping.H>

Inheritance diagram for BackgroundStopping:
CollisionBase

Public Member Functions

 BackgroundStopping (const std::string &collision_name)
 
 ~BackgroundStopping () override=default
 
 BackgroundStopping (BackgroundStopping const &)=delete
 
BackgroundStoppingoperator= (BackgroundStopping const &)=delete
 
 BackgroundStopping (BackgroundStopping &&)=delete
 
BackgroundStoppingoperator= (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
 
CollisionBaseoperator= (CollisionBase const &)=delete
 
CollisionBaseoperator= (CollisionBase const &&)=delete
 
virtual ~CollisionBase ()=default
 
int get_ndt () 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
amrex::Vector< std::string > m_species_names
 
int m_ndt
 

Constructor & Destructor Documentation

◆ BackgroundStopping() [1/3]

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

◆ ~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
ptiparticle iterator
dttime step size
tcurrent simulation time
species_massmass of the active species
species_chargecharge 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
ptiparticle iterator
dttime step size
tcurrent simulation time
species_massmass of the active species
species_chargecharge of the active species

◆ doCollisions()

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

Perform the stopping calculation

Parameters
cur_timeCurrent time
dtTime step size
mypcContainer 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: