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.
	PairWiseCoulombCollisionFunc (const std::string &collision_name, MultiParticleContainer const *const mypc, const bool isSameSpecies)
	Constructor of the PairWiseCoulombCollisionFunc class.
Executor const &	executor () const
bool	use_global_debye_length ()

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
bool	m_use_global_debye_length = false

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

using PairWiseCoulombCollisionFunc::index_type = ParticleBins::index_type

private

ParticleBins

using PairWiseCoulombCollisionFunc::ParticleBins = amrex::DenseBins<ParticleTileDataType>

private

ParticleTileDataType

using PairWiseCoulombCollisionFunc::ParticleTileDataType = ParticleTileType::ParticleTileDataType

private

ParticleTileType

using PairWiseCoulombCollisionFunc::ParticleTileType = WarpXParticleContainer::ParticleTileType

private

ParticleType

using PairWiseCoulombCollisionFunc::ParticleType = WarpXParticleContainer::ParticleType

private

SoaData_type

using PairWiseCoulombCollisionFunc::SoaData_type = WarpXParticleContainer::ParticleTileType::ParticleTileDataType

private

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, MultiParticleContainer const *const mypc, const bool isSameSpecies )

inline

Constructor of the PairWiseCoulombCollisionFunc class.

Parameters

[in]	collision_name	the name of the collision
[in]	mypc	the particle container (unused)
[in]	isSameSpecies	true if this is an intra-species colission

Member Function Documentation

executor()

Executor const & PairWiseCoulombCollisionFunc::executor ( ) const

inlinenodiscard

use_global_debye_length()

bool PairWiseCoulombCollisionFunc::use_global_debye_length ( )

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

m_use_global_debye_length

bool PairWiseCoulombCollisionFunc::m_use_global_debye_length = false

private

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6270/Source/Particles/Collision/BinaryCollision/Coulomb/PairWiseCoulombCollisionFunc.H