WarpX
Public Member Functions | Private Attributes | List of all members
BreitWheelerEvolveOpticalDepth Class Reference

#include <BreitWheelerEngineWrapper.H>

Public Member Functions

 BreitWheelerEvolveOpticalDepth ()=default
 
 BreitWheelerEvolveOpticalDepth (const BW_dndt_table_view table_view, const amrex::ParticleReal bw_minimum_chi_phot)
 
AMREX_GPU_DEVICE AMREX_FORCE_INLINE int operator() (const amrex::ParticleReal ux, const amrex::ParticleReal uy, const amrex::ParticleReal uz, const amrex::ParticleReal ex, const amrex::ParticleReal ey, const amrex::ParticleReal ez, const amrex::ParticleReal bx, const amrex::ParticleReal by, const amrex::ParticleReal bz, const amrex::Real dt, amrex::ParticleReal &opt_depth) const noexcept
 

Private Attributes

BW_dndt_table_view m_table_view
 
amrex::ParticleReal m_bw_minimum_chi_phot
 

Detailed Description

Functor to evolve the optical depth of photons due to the Breit-Wheeler process

Constructor & Destructor Documentation

◆ BreitWheelerEvolveOpticalDepth() [1/2]

BreitWheelerEvolveOpticalDepth::BreitWheelerEvolveOpticalDepth ( )
default

Default constructor: it leaves the functor in a non-initialized state.

◆ BreitWheelerEvolveOpticalDepth() [2/2]

BreitWheelerEvolveOpticalDepth::BreitWheelerEvolveOpticalDepth ( const BW_dndt_table_view  table_view,
const amrex::ParticleReal  bw_minimum_chi_phot 
)
inline

Constructor to be used to initialize the functor.

Parameters
[in]table_viewa view of a BW_dndt_table lookup table
[in]bw_minimum_chi_photthe minimum quantum parameter to evolve the optical depth

Member Function Documentation

◆ operator()()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE int BreitWheelerEvolveOpticalDepth::operator() ( const amrex::ParticleReal  ux,
const amrex::ParticleReal  uy,
const amrex::ParticleReal  uz,
const amrex::ParticleReal  ex,
const amrex::ParticleReal  ey,
const amrex::ParticleReal  ez,
const amrex::ParticleReal  bx,
const amrex::ParticleReal  by,
const amrex::ParticleReal  bz,
const amrex::Real  dt,
amrex::ParticleReal &  opt_depth 
) const
inlinenoexcept

Evolves the optical depth. It can be used on GPU. If the quantum parameter parameter of the photon is < bw_minimum_chi_phot, the method returns immediately. The method returns also if the energy of the photon is insufficient to generate a pair.

Parameters
[in]ux,uy,uzgamma*v components of the photon.
[in]ex,ey,ezelectric field components (SI units)
[in]bx,by,bzmagnetic field components (SI units)
[in]dttimestep (SI units)
[in,out]opt_depthoptical depth of the photon.
Returns
a flag which is 1 if chi_phot was out of table

Member Data Documentation

◆ m_bw_minimum_chi_phot

amrex::ParticleReal BreitWheelerEvolveOpticalDepth::m_bw_minimum_chi_phot
private

◆ m_table_view

BW_dndt_table_view BreitWheelerEvolveOpticalDepth::m_table_view
private

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