CORSIKA  @c8_version@
The framework to simulate particle cascades for astroparticle physics
corsika::CoREAS< TRadioDetector, TPropagator > Class Template Referencefinal
Inheritance diagram for corsika::CoREAS< TRadioDetector, TPropagator >:

Public Types

using Base = RadioProcess< TRadioDetector, CoREAS< TRadioDetector, TPropagator >, TPropagator >
 
- Public Types inherited from corsika::RadioProcess< TRadioDetector, CoREAS< TRadioDetector, TPropagator >, TPropagator >
using axistype = std::vector< long double >
 
- Public Types inherited from corsika::BaseProcess< RadioProcess< TRadioDetector, CoREAS< TRadioDetector, TPropagator >, TPropagator > >
using process_type = RadioProcess< TRadioDetector, CoREAS< TRadioDetector, TPropagator >, TPropagator >
 Base processor type for use in other template classes.
 

Public Member Functions

template<typename... TArgs>
 CoREAS (TRadioDetector &detector, TArgs &&... args)
 Construct a new CoREAS instance. More...
 
template<typename Particle >
ProcessReturn simulate (Step< Particle > const &step)
 Simulate the radio emission from a particle across a track. More...
 
- Public Member Functions inherited from corsika::RadioProcess< TRadioDetector, CoREAS< TRadioDetector, TPropagator >, TPropagator >
 RadioProcess (TRadioDetector &antennas, TPropagator &propagator)
 Construct a new RadioProcess.
 
ProcessReturn doContinuous (Step< Particle > const &step, bool const)
 Perform the continuous process (radio emission). More...
 
LengthType getMaxStepLength (Particle const &vParticle, Track const &vTrack) const
 Return the maximum step length for this particle and track. More...
 
void startOfLibrary (boost::filesystem::path const &directory) final override
 Called at the start of each library.
 
virtual void endOfShower (unsigned int const) final override
 Called at the end of each shower.
 
void endOfLibrary () final override
 Called at the end of each library.
 
YAML::Node getConfig () const final
 Get the configuration of this output.
 
- Public Member Functions inherited from corsika::BaseOutput
virtual void startOfShower (unsigned int const)
 Called at the start of each event/shower. More...
 
bool isInit () const
 Flag to indicate readiness.
 
virtual YAML::Node getSummary () const
 Provide YAML Summary for this BaseOutput.
 

Static Public Attributes

static constexpr auto algorithm = "CoREAS"
 
static constexpr auto emConstant_
 
- Static Public Attributes inherited from corsika::BaseProcess< RadioProcess< TRadioDetector, CoREAS< TRadioDetector, TPropagator >, TPropagator > >
static bool const is_process_sequence
 
static bool const is_switch_process_sequence
 

Additional Inherited Members

- Protected Member Functions inherited from corsika::BaseProcess< RadioProcess< TRadioDetector, CoREAS< TRadioDetector, TPropagator >, TPropagator > >
RadioProcess< TRadioDetector, CoREAS< TRadioDetector, TPropagator >, TPropagator > & getRef ()
 
const RadioProcess< TRadioDetector, CoREAS< TRadioDetector, TPropagator >, TPropagator > & getRef () const
 
- Protected Member Functions inherited from corsika::BaseOutput
void setInit (bool const v)
 Set init flag.
 
- Protected Attributes inherited from corsika::RadioProcess< TRadioDetector, CoREAS< TRadioDetector, TPropagator >, TPropagator >
TRadioDetector & antennas_
 The radio antennas we store into.
 
TPropagator propagator_
 The propagator implementation.
 
unsigned int showerId_
 The current event ID.
 
ParquetStreamer output_
 The parquet streamer for this process.
 
- Protected Attributes inherited from corsika::BaseProcess< RadioProcess< TRadioDetector, CoREAS< TRadioDetector, TPropagator >, TPropagator > >
friend TDerived
 

Detailed Description

template<typename TRadioDetector, typename TPropagator>
class corsika::CoREAS< TRadioDetector, TPropagator >

Definition at line 17 of file CoREAS.hpp.

Constructor & Destructor Documentation

◆ CoREAS()

template<typename TRadioDetector , typename TPropagator >
template<typename... TArgs>
corsika::CoREAS< TRadioDetector, TPropagator >::CoREAS ( TRadioDetector &  detector,
TArgs &&...  args 
)
inline

Construct a new CoREAS instance.

This forwards the detector and other arguments to the RadioProcess parent.

Definition at line 33 of file CoREAS.hpp.

Member Function Documentation

◆ simulate()

template<typename TRadioDetector , typename TPropagator >
template<typename Particle >
ProcessReturn corsika::CoREAS< TRadioDetector, TPropagator >::simulate ( Step< Particle > const &  step)

Simulate the radio emission from a particle across a track.

This must be provided by the TRadioImpl.

Parameters
particleThe current particle.
trackThe current track.

Member Data Documentation

◆ emConstant_

template<typename TRadioDetector , typename TPropagator >
constexpr auto corsika::CoREAS< TRadioDetector, TPropagator >::emConstant_
static
Initial value:
{1.0 / (4.0 * M_PI) / (constants::epsilonZero) /
constants::c}

Definition at line 47 of file CoREAS.hpp.


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