This class defines an operator to create product particles from DSMC collisions and sets the particle properties (position, momentum, weight). More...

#include <SplitAndScatterFunc.H>

Public Member Functions
	SplitAndScatterFunc ()=default
	Default constructor of the SplitAndScatterFunc class.

	SplitAndScatterFunc (const std::string &collision_name, MultiParticleContainer const *mypc)
	Constructor of the SplitAndScatterFunc class.

AMREX_INLINE amrex::Vector< int >	operator() (const index_type &n_total_pairs, ParticleTileType &ptile0, ParticleTileType &ptile1, const amrex::Vector< WarpXParticleContainer * > &pc_products, ParticleTileType *AMREX_RESTRICT tile_products, const amrex::ParticleReal m0, const amrex::ParticleReal m1, const amrex::Vector< amrex::ParticleReal > &, const index_type AMREX_RESTRICT mask, amrex::Vector< index_type > &products_np, const SmartCopy AMREX_RESTRICT copy_species0, const SmartCopy AMREX_RESTRICT copy_species1, const index_type AMREX_RESTRICT p_pair_indices_0, const index_type AMREX_RESTRICT p_pair_indices_1, const amrex::ParticleReal AMREX_RESTRICT p_pair_reaction_weight, const amrex::ParticleReal ) const
	Function that performs binary collision between macroparticle pairs (referred to as "reactant species" in the code below)

Private Types
using	ParticleType = typename WarpXParticleContainer::ParticleType

using	ParticleTileType = typename WarpXParticleContainer::ParticleTileType

using	ParticleTileDataType = typename ParticleTileType::ParticleTileDataType

using	ParticleBins = amrex::DenseBins<ParticleTileDataType>

using	index_type = typename ParticleBins::index_type

using	SoaData_type = WarpXParticleContainer::ParticleTileType::ParticleTileDataType

Private Attributes
int	m_num_product_species

amrex::ParticleReal	m_reaction_energy = 0.0

amrex::Gpu::HostVector< int >	m_num_products_host

CollisionType	m_collision_type

Detailed Description

This class defines an operator to create product particles from DSMC collisions and sets the particle properties (position, momentum, weight).

Member Typedef Documentation

◆ index_type

using SplitAndScatterFunc::index_type = typename ParticleBins::index_type

private

◆ ParticleBins

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

private

◆ ParticleTileDataType

using SplitAndScatterFunc::ParticleTileDataType = typename ParticleTileType::ParticleTileDataType

private

◆ ParticleTileType

using SplitAndScatterFunc::ParticleTileType = typename WarpXParticleContainer::ParticleTileType

private

◆ ParticleType

using SplitAndScatterFunc::ParticleType = typename WarpXParticleContainer::ParticleType

private

◆ SoaData_type

using SplitAndScatterFunc::SoaData_type = WarpXParticleContainer::ParticleTileType::ParticleTileDataType

private

Constructor & Destructor Documentation

◆ SplitAndScatterFunc() [1/2]

SplitAndScatterFunc::SplitAndScatterFunc ( )

default

Default constructor of the SplitAndScatterFunc class.

◆ SplitAndScatterFunc() [2/2]

SplitAndScatterFunc::SplitAndScatterFunc	(	const std::string &	collision_name,
		MultiParticleContainer const *	mypc )

Constructor of the SplitAndScatterFunc class.

Parameters

[in]	collision_name	the name of the collision
[in]	mypc	pointer to the MultiParticleContainer

Member Function Documentation

◆ operator()()

AMREX_INLINE amrex::Vector< int > SplitAndScatterFunc::operator()	(	const index_type &	n_total_pairs,
		ParticleTileType &	ptile0,
		ParticleTileType &	ptile1,
		const amrex::Vector< WarpXParticleContainer * > &	pc_products,
		ParticleTileType **AMREX_RESTRICT	tile_products,
		const amrex::ParticleReal	m0,
		const amrex::ParticleReal	m1,
		const amrex::Vector< amrex::ParticleReal > &	,
		const index_type *AMREX_RESTRICT	mask,
		amrex::Vector< index_type > &	products_np,
		const SmartCopy *AMREX_RESTRICT	copy_species0,
		const SmartCopy *AMREX_RESTRICT	copy_species1,
		const index_type *AMREX_RESTRICT	p_pair_indices_0,
		const index_type *AMREX_RESTRICT	p_pair_indices_1,
		const amrex::ParticleReal *AMREX_RESTRICT	p_pair_reaction_weight,
		const amrex::ParticleReal *	) const

inline

Function that performs binary collision between macroparticle pairs (referred to as "reactant species" in the code below)

During a collision, new macroparticles can be created in different species, which are arranged in slots 0 through m_num_product_species-1.

Slots 0 and 1 always correspond to the first and second reactant species, respectively. This is because, physically, some of the reacting particles can still be present after the collision (e.g., if the collision is elastic scattering), but with modified properties (e.g., modified momentum). In the code, this is handled by creating new macroparticles in the reactant species, whose weight is subtracted from the reacting macroparticles. (This approach is used in order to handle the fact that the two reactant macroparticles may have different weights.)

For collisions that, physically, produce new particles (e.g., ionization, charge exchange, two-product reaction), slots 2 and 3 hold the true product species.

Parameters

[in]	n_total_pairs	total number of colliding particle pairs (across all cells) handled by this kernel.
[in,out]	ptile0	particle tile for the first reactant species (slot 0); weights may be reduced by the collision.
[in,out]	ptile1	particle tile for the other reactant species (slot 1); weights may be reduced by the collision.
[in]	pc_products	pointers to all product species containers (size m_num_product_species); used for mass queries and runtime attribute initialization.
[in,out]	tile_products	array of pointers to product particle tiles (size m_num_product_species); new particles are appended to each tile.
[in]	m0	rest mass of the first reactant species (slot 0).
[in]	m1	rest mass of the other reactant species (slot 1).
[in]	mask	per-pair collision type: 0 = no collision, otherwise cast of ScatteringProcessType to int.
[in,out]	products_np	macroparticle count of each product tile; updated in this kernel to reflect the number of new macroparticles added in each species.
[in]	copy_species0	array of SmartCopy functors (size m_num_product_species); copy_species0[k] copies a particle FROM the first reactant species (slot 0) INTO product slot k.
[in]	copy_species1	array of SmartCopy functors (size m_num_product_species); copy_species1[k] copies a particle FROM the other reactant species (slot 1) INTO product slot k.
[in]	p_pair_indices_0	per-pair index of the first reactant species (slot 0) particle.
[in]	p_pair_indices_1	per-pair index of the other reactant species (slot 1) particle.
[in]	p_pair_reaction_weight	per-pair weight assigned to newly created product macroparticles; also the amount subtracted from the colliding macroparticle weights.

Returns: num_added number of particles added to each product slot.

Member Data Documentation

◆ m_collision_type

CollisionType SplitAndScatterFunc::m_collision_type

private

◆ m_num_product_species

int SplitAndScatterFunc::m_num_product_species

private

◆ m_num_products_host

amrex::Gpu::HostVector<int> SplitAndScatterFunc::m_num_products_host

private

◆ m_reaction_energy

amrex::ParticleReal SplitAndScatterFunc::m_reaction_energy = 0.0

private

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

/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6814/Source/Particles/Collision/BinaryCollision/DSMC/SplitAndScatterFunc.H
/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6814/Source/Particles/Collision/BinaryCollision/DSMC/SplitAndScatterFunc.cpp

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ index_type

◆ ParticleBins

◆ ParticleTileDataType

◆ ParticleTileType

◆ ParticleType

◆ SoaData_type

Constructor & Destructor Documentation

◆ SplitAndScatterFunc() [1/2]

◆ SplitAndScatterFunc() [2/2]

Member Function Documentation

◆ operator()()

Member Data Documentation

◆ m_collision_type

◆ m_num_product_species

◆ m_num_products_host

◆ m_reaction_energy