Geant4 11.4.0
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
MCGIDI::Distributions::Unspecified Class Reference

#include <MCGIDI_distributions.hpp>

Inheritance diagram for MCGIDI::Distributions::Unspecified:

Public Member Functions

LUPI_HOST_DEVICE Unspecified ()
LUPI_HOST Unspecified (GIDI::Distributions::Distribution const &a_distribution, SetupInfo &a_setupInfo)
LUPI_HOST_DEVICE ~Unspecified ()
template<typename RNG>
LUPI_HOST_DEVICE void sample (double a_X, Sampling::Input &a_input, RNG &&a_rng) const
template<typename RNG>
LUPI_HOST_DEVICE double angleBiasing (Reaction const *a_reaction, double a_temperature, double a_energy_in, double a_mu_lab, RNG &&a_rng, double &a_energy_out) const
LUPI_HOST_DEVICE void serialize (LUPI::DataBuffer &a_buffer, LUPI::DataBuffer::Mode a_mode)
template<typename RNG>
LUPI_HOST_DEVICE void sample (LUPI_maybeUnused double a_X, Sampling::Input &a_input, LUPI_maybeUnused RNG &&a_rng) const
template<typename RNG>
LUPI_HOST_DEVICE double angleBiasing (LUPI_maybeUnused Reaction const *a_reaction, LUPI_maybeUnused double a_temperature, LUPI_maybeUnused double a_energy_in, LUPI_maybeUnused double a_mu_lab, LUPI_maybeUnused RNG &&a_rng, double &a_energy_out) const
Public Member Functions inherited from MCGIDI::Distributions::Distribution
LUPI_HOST_DEVICE Distribution ()
LUPI_HOST Distribution (Type a_type, GIDI::Distributions::Distribution const &a_distribution, SetupInfo &a_setupInfo)
LUPI_HOST Distribution (Type a_type, GIDI::Frame a_productFrame, SetupInfo &a_setupInfo)
LUPI_HOST_DEVICE MCGIDI_VIRTUAL_FUNCTION ~Distribution () MCGIDI_TRUE_VIRTUAL
LUPI_HOST_DEVICE Type type () const
LUPI_HOST_DEVICE GIDI::Frame productFrame () const
LUPI_HOST_DEVICE double projectileMass () const
LUPI_HOST_DEVICE double targetMass () const
LUPI_HOST_DEVICE double productMass () const
LUPI_HOST void setModelDBRC_data (Sampling::Upscatter::ModelDBRC_data *a_modelDBRC_data)
template<typename RNG>
LUPI_HOST_DEVICE MCGIDI_VIRTUAL_FUNCTION void sample (double a_X, Sampling::Input &a_input, RNG &&a_rng) const MCGIDI_TRUE_VIRTUAL
template<typename RNG>
LUPI_HOST_DEVICE MCGIDI_VIRTUAL_FUNCTION double angleBiasing (Reaction const *a_reaction, double a_temperature, double a_energy_in, double a_mu_lab, RNG &&a_rng, double &a_energy_out) const MCGIDI_TRUE_VIRTUAL
LUPI_HOST_DEVICE void serialize (LUPI::DataBuffer &a_buffer, LUPI::DataBuffer::Mode a_mode)
template<typename RNG>
LUPI_HOST_DEVICE void sample (double a_X, MCGIDI::Sampling::Input &a_input, RNG &&a_rng) const
template<typename RNG>
LUPI_HOST_DEVICE double angleBiasing (Reaction const *a_reaction, double a_temperature, double a_energy_in, double a_mu_lab, RNG &&a_rng, double &a_energy_out) const

Detailed Description

This class represents the distribution for an outgoing product whose distribution is not specified.

Definition at line 437 of file MCGIDI_distributions.hpp.

Constructor & Destructor Documentation

◆ Unspecified() [1/2]

LUPI_HOST_DEVICE MCGIDI::Distributions::Unspecified::Unspecified ( )

Definition at line 1383 of file MCGIDI_distributions.cc.

1383 {
1384
1385}

◆ Unspecified() [2/2]

LUPI_HOST MCGIDI::Distributions::Unspecified::Unspecified ( GIDI::Distributions::Distribution const & a_distribution,
SetupInfo & a_setupInfo )
Parameters
a_distribution[in] The GIDI::Distributions::Unspecified instance whose data is to be used to construct this.
a_setupInfo[in] Used internally when constructing a Protare to pass information to other constructors.

Definition at line 1392 of file MCGIDI_distributions.cc.

1392 :
1393 Distribution( Type::unspecified, a_distribution, a_setupInfo ) {
1394
1395}

◆ ~Unspecified()

LUPI_HOST_DEVICE MCGIDI::Distributions::Unspecified::~Unspecified ( )

Definition at line 1400 of file MCGIDI_distributions.cc.

1400 {
1401
1402}

Member Function Documentation

◆ angleBiasing() [1/2]

template<typename RNG>
LUPI_HOST_DEVICE double MCGIDI::Distributions::Unspecified::angleBiasing ( LUPI_maybeUnused Reaction const * a_reaction,
LUPI_maybeUnused double a_temperature,
LUPI_maybeUnused double a_energy_in,
LUPI_maybeUnused double a_mu_lab,
LUPI_maybeUnused RNG && a_rng,
double & a_energy_out ) const

Returns the probability for a projectile with energy a_energy_in to cause a particle to be emitted at angle a_mu_lab as seen in the lab frame. a_energy_out is the sampled outgoing energy. This one should never be called. If called, returns 0.0 for a probability.

Parameters
a_reaction[in] The reaction containing the particle which this distribution describes.
a_temperature[in] Specifies the temperature of the material.
a_energy_in[in] The energy of the incident particle.
a_mu_lab[in] The desired mu in the lab frame for the emitted particle.
a_rng[in] The random number generator function that returns a double in the range [0, 1.0).
a_energy_out[in] The energy of the emitted outgoing particle.
Returns
The probability of emitting outgoing particle into lab angle a_mu_lab.

Definition at line 1579 of file MCGIDI_headerSource.hpp.

1580 {
1581
1582 a_energy_out = 0.0;
1583 return( 0.0 );
1584}

◆ angleBiasing() [2/2]

template<typename RNG>
LUPI_HOST_DEVICE double MCGIDI::Distributions::Unspecified::angleBiasing ( Reaction const * a_reaction,
double a_temperature,
double a_energy_in,
double a_mu_lab,
RNG && a_rng,
double & a_energy_out ) const

◆ sample() [1/2]

template<typename RNG>
LUPI_HOST_DEVICE void MCGIDI::Distributions::Unspecified::sample ( double a_X,
Sampling::Input & a_input,
RNG && a_rng ) const

◆ sample() [2/2]

template<typename RNG>
LUPI_HOST_DEVICE void MCGIDI::Distributions::Unspecified::sample ( LUPI_maybeUnused double a_X,
Sampling::Input & a_input,
LUPI_maybeUnused RNG && a_rng ) const

The method sets all outgoing product data to 0.0 and set the sampledType to Sampling::unspecified.

Parameters
a_X[in] The energy of the projectile.
a_input[in] Sample options requested by user.
a_rng[in] The random number generator function that returns a double in the range [0, 1.0).

Definition at line 1554 of file MCGIDI_headerSource.hpp.

1554 {
1555
1556 a_input.setSampledType( Sampling::SampledType::unspecified );
1557 a_input.m_energyOut1 = 0.;
1558 a_input.m_mu = 0.;
1559 a_input.m_phi = 0.;
1560 a_input.m_frame = productFrame( );
1561}
LUPI_HOST_DEVICE GIDI::Frame productFrame() const

◆ serialize()

LUPI_HOST_DEVICE void MCGIDI::Distributions::Unspecified::serialize ( LUPI::DataBuffer & a_buffer,
LUPI::DataBuffer::Mode a_mode )

This method serializes this for broadcasting as needed for MPI and GPUs. The method can count the number of required bytes, pack this or unpack this depending on a_mode.

Parameters
a_buffer[in] The buffer to read or write data to depending on a_mode.
a_mode[in] Specifies the action of this method.

Definition at line 1412 of file MCGIDI_distributions.cc.

1412 {
1413
1414 Distribution::serialize( a_buffer, a_mode );
1415}
LUPI_HOST_DEVICE void serialize(LUPI::DataBuffer &a_buffer, LUPI::DataBuffer::Mode a_mode)

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