CORSIKA  @c8_version@
The framework to simulate particle cascades for astroparticle physics
corsika::Environment< IEnvironmentModel > Class Template Reference

Base Environment class. More...

#include <Environment.hpp>

Inheritance diagram for corsika::Environment< IEnvironmentModel >:

Public Types

using BaseNodeType = VolumeTreeNode< IEnvironmentModel >
 

Public Member Functions

CoordinateSystemPtr const & getCoordinateSystem () const
 Getter for the CoordinateSystem used in the Environment. More...
 
BaseNodeType::VTNUPtr & getUniverse ()
 Getters for the universe stored in the Environment. More...
 
BaseNodeType::VTNUPtr const & getUniverse () const
 Get const universe.
 

Detailed Description

template<typename IEnvironmentModel>
class corsika::Environment< IEnvironmentModel >

Base Environment class.

Describes the Environment in which the shower is propagated.

Definition at line 29 of file Environment.hpp.

Member Function Documentation

◆ createNode()

template<typename IEnvironmentModel>
template<class TVolumeType , typename... TVolumeArgs>
static std::unique_ptr<BaseNodeType> corsika::Environment< IEnvironmentModel >::createNode ( TVolumeArgs &&...  args)
static

Factory method for creation of VolumeTreeNodes.

Template Parameters
TVolumeTypeType of volume to be created
TVolumeArgsTypes to forward to the constructor
Parameters
argsParameter forwarded to the constructor of TVolumeType
Return values
Returnsunique pointer to a VolumeTreeNode with the same EnvitonmentModel as this class.

◆ getCoordinateSystem()

template<typename IEnvironmentModel>
CoordinateSystemPtr const& corsika::Environment< IEnvironmentModel >::getCoordinateSystem ( ) const

Getter for the CoordinateSystem used in the Environment.

Return values
Retunsa const reference to the CoordinateSystem used.

◆ getUniverse()

template<typename IEnvironmentModel>
BaseNodeType::VTNUPtr& corsika::Environment< IEnvironmentModel >::getUniverse ( )

Getters for the universe stored in the Environment.

Return values
Retunsreference to a Universe object with infinite size. Get non const universe

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