DSMCFunc Class Reference

This class performs DSMC (direct simulation Monte Carlo) collisions within a cell. Particles are paired up and for each pair a stochastic process determines whether a collision occurs. The algorithm is similar to the one used for binary Coulomb collisions and the nuclear fusion module. More...

#include <DSMCFunc.H>

Classes
struct	Executor

Public Member Functions
	DSMCFunc ()=default
	Constructor of the DSMCFunc class.
	DSMCFunc (const std::string &collision_name, MultiParticleContainer const *mypc, const bool isSameSpecies)
	Constructor of the DSMCFunc 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::Vector< ScatteringProcess >	m_scattering_processes
amrex::Gpu::DeviceVector< ScatteringProcess::Executor >	m_scattering_processes_exe
bool	m_isSameSpecies
Executor	m_exe

Detailed Description

This class performs DSMC (direct simulation Monte Carlo) collisions within a cell. Particles are paired up and for each pair a stochastic process determines whether a collision occurs. The algorithm is similar to the one used for binary Coulomb collisions and the nuclear fusion module.

Member Typedef Documentation

index_type

using DSMCFunc::index_type = ParticleBins::index_type

private

ParticleBins

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

private

ParticleTileDataType

using DSMCFunc::ParticleTileDataType = ParticleTileType::ParticleTileDataType

private

ParticleTileType

using DSMCFunc::ParticleTileType = WarpXParticleContainer::ParticleTileType

private

ParticleType

using DSMCFunc::ParticleType = WarpXParticleContainer::ParticleType

private

SoaData_type

using DSMCFunc::SoaData_type = WarpXParticleContainer::ParticleTileType::ParticleTileDataType

private

Constructor & Destructor Documentation

DSMCFunc() [1/2]

DSMCFunc::DSMCFunc ( )

default

Constructor of the DSMCFunc class.

DSMCFunc() [2/2]

DSMCFunc::DSMCFunc	(	const std::string &	collision_name,
		MultiParticleContainer const *	mypc,
		const bool	isSameSpecies )

Constructor of the DSMCFunc class.

Parameters

[in]	collision_name	the name of the collision
[in]	mypc	pointer to the MultiParticleContainer
[in]	isSameSpecies	whether the two colliding species are the same

Member Function Documentation

executor()

Executor const & DSMCFunc::executor ( ) const

inlinenodiscard

use_global_debye_length()

bool DSMCFunc::use_global_debye_length ( )

inline

Member Data Documentation

m_exe

Executor DSMCFunc::m_exe

private

m_isSameSpecies

bool DSMCFunc::m_isSameSpecies

private

m_scattering_processes

amrex::Vector<ScatteringProcess> DSMCFunc::m_scattering_processes

private

m_scattering_processes_exe

amrex::Gpu::DeviceVector<ScatteringProcess::Executor> DSMCFunc::m_scattering_processes_exe

private

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6102/Source/Particles/Collision/BinaryCollision/DSMC/DSMCFunc.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6102/Source/Particles/Collision/BinaryCollision/DSMC/DSMCFunc.cpp