WarpX
Classes | Public Member Functions | Private Types | Private Attributes | List of all members
PairWiseCoulombCollisionFunc Class Reference

This functor performs pairwise Coulomb collision on a single cell by calling the function ElasticCollisionPerez. It also reads and contains the Coulomb logarithm. More...

#include <PairWiseCoulombCollisionFunc.H>

Classes

struct  Executor
 

Public Member Functions

 PairWiseCoulombCollisionFunc ()=default
 Default constructor of the PairWiseCoulombCollisionFunc class. More...
 
 PairWiseCoulombCollisionFunc (const std::string &collision_name, [[maybe_unused]] MultiParticleContainer const *const mypc, const bool isSameSpecies)
 Constructor of the PairWiseCoulombCollisionFunc class. More...
 
Executor const & executor () const
 

Private Types

using ParticleType = WarpXParticleContainer::ParticleType
 
using ParticleTileType = WarpXParticleContainer::ParticleTileType
 
using ParticleTileDataType = ParticleTileType::ParticleTileDataType
 
using ParticleBins = amrex::DenseBins< ParticleTileDataType >
 
using index_type = ParticleBins::index_type
 
using SoaData_type = WarpXParticleContainer::ParticleTileType::ParticleTileDataType
 

Private Attributes

amrex::ParticleReal m_CoulombLog
 
bool m_isSameSpecies
 
Executor m_exe
 

Detailed Description

This functor performs pairwise Coulomb collision on a single cell by calling the function ElasticCollisionPerez. It also reads and contains the Coulomb logarithm.

Member Typedef Documentation

◆ index_type

◆ ParticleBins

◆ ParticleTileDataType

◆ ParticleTileType

◆ ParticleType

◆ SoaData_type

Constructor & Destructor Documentation

◆ PairWiseCoulombCollisionFunc() [1/2]

PairWiseCoulombCollisionFunc::PairWiseCoulombCollisionFunc ( )
default

Default constructor of the PairWiseCoulombCollisionFunc class.

◆ PairWiseCoulombCollisionFunc() [2/2]

PairWiseCoulombCollisionFunc::PairWiseCoulombCollisionFunc ( const std::string &  collision_name,
[[maybe_unused] ] MultiParticleContainer const *const  mypc,
const bool  isSameSpecies 
)
inline

Constructor of the PairWiseCoulombCollisionFunc class.

Parameters
[in]collision_namethe name of the collision
[in]mypcthe particle container (unused)
[in]isSameSpeciestrue if this is an intra-species colission

Member Function Documentation

◆ executor()

Executor const& PairWiseCoulombCollisionFunc::executor ( ) const
inline

Member Data Documentation

◆ m_CoulombLog

amrex::ParticleReal PairWiseCoulombCollisionFunc::m_CoulombLog
private

◆ m_exe

Executor PairWiseCoulombCollisionFunc::m_exe
private

◆ m_isSameSpecies

bool PairWiseCoulombCollisionFunc::m_isSameSpecies
private

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