celeritas::test::GlobalTestBase Class Reference

Lazily construct core parameters, individually or together. More...

#include <GlobalTestBase.hh>

Inheritance diagram for celeritas::test::GlobalTestBase:

Public Member Functions
SPConstPrimariesAction const &	primaries_action ()
void	insert_primaries (CoreStateInterface &state, SpanConstPrimary primaries)
SPOutputRegistry const &	output_reg () const
	Access output manager.
void	write_output ()
	Write output to a debug text file.
Public Member Functions inherited from celeritas::test::Test
std::string	make_unique_filename (std::string_view ext={})
	Generate test-unique filename.
Public Member Functions inherited from celeritas::test::LazyGeantGeoManager
virtual SPConstGeantGeo	build_geant_geo (std::string const &filename) const
	Build a Geant4 geometry.
std::string const &	cached_gdml_basename () const
	Access the basename of the geometry that's currently cached.
SPConstGeoI	lazy_geo () const
	Construct a geometry for the first time.
SPConstGeantGeo	geant_geo () const
	Access persistent geant geometry after construction.
SPConstVolumes	volumes () const
	Access volumes from built geometry or geant4 model.

Protected Member Functions
virtual SPConstMaterial	build_material ()=0
virtual SPConstCoreGeo	build_geometry ()
virtual SPConstGeoMaterial	build_geomaterial ()=0
virtual SPConstParticle	build_particle ()=0
virtual SPConstCutoff	build_cutoff ()=0
virtual SPConstPhysics	build_physics ()=0
virtual SPConstSim	build_sim ()=0
virtual SPConstTrackInit	build_init ()=0
virtual SPConstWentzelOKVI	build_wentzel ()=0
virtual SPConstAction	build_along_step ()=0
virtual SPConstCherenkov	build_cherenkov ()=0
virtual SPConstOpticalMaterial	build_optical_material ()=0
virtual SPConstOpticalPhysics	build_optical_physics ()=0
virtual SPConstScintillation	build_scintillation ()=0
void	disable_status_checker ()
SPConstSurface const &	surface () const
SPConstVolume const &	volume () const
SPConstGeoI	build_geo_from_geant (SPConstGeantGeo const &) const final
SPConstGeoI	build_geo_from_gdml (std::string const &filename) const final
	Build from a GDML path as a fallback.
virtual std::string_view	gdml_basename () const=0
	Get an identifying key for the geometry (basename, description, etc)

Type aliases
template<class T >
using	SP = std::shared_ptr< T >
using	SPConstAction = SP< CoreStepActionInterface const >
using	SPConstCoreGeo = SP< CoreGeoParams const >
using	SPConstCutoff = SP< CutoffParams const >
using	SPConstGeoMaterial = SP< GeoMaterialParams const >
using	SPConstMaterial = SP< MaterialParams const >
using	SPConstParticle = SP< ParticleParams const >
using	SPConstPhysics = SP< PhysicsParams const >
using	SPConstRng = SP< RngParams const >
using	SPConstSim = SP< SimParams const >
using	SPConstTrackInit = SP< TrackInitParams const >
using	SPConstSurface = SP< SurfaceParams const >
using	SPConstVolume = SP< VolumeParams const >
using	SPConstWentzelOKVI = SP< WentzelOKVIParams const >
using	SPActionRegistry = SP< ActionRegistry >
using	SPOutputRegistry = SP< OutputRegistry >
using	SPUserRegistry = SP< AuxParamsRegistry >
using	SPConstCore = SP< CoreParams const >
using	SPConstCherenkov = SP< CherenkovParams const >
using	SPConstOpticalMaterial = SP< optical::MaterialParams const >
using	SPOpticalParams = SP< optical::CoreParams >
using	SPConstOpticalPhysics = SP< optical::PhysicsParams const >
using	SPConstScintillation = SP< ScintillationParams const >
using	SPConstPrimariesAction = SP< ExtendFromPrimariesAction const >
using	SpanConstPrimary = Span< Primary const >
SPConstCoreGeo const &	geometry ()
SPConstMaterial const &	material ()
SPConstGeoMaterial const &	geomaterial ()
SPConstParticle const &	particle ()
SPConstCutoff const &	cutoff ()
SPConstPhysics const &	physics ()
SPConstAction const &	along_step ()
SPConstRng const &	rng ()
SPConstSim const &	sim ()
SPConstTrackInit const &	init ()
SPConstWentzelOKVI const &	wentzel ()
SPActionRegistry const &	action_reg ()
SPUserRegistry const &	aux_reg ()
SPConstCore const &	core ()
SPConstCherenkov const &	cherenkov ()
SPActionRegistry const &	optical_action_reg ()
SPConstOpticalMaterial const &	optical_material ()
SPOpticalParams const &	optical_params ()
SPConstOpticalPhysics const &	optical_physics ()
SPConstScintillation const &	scintillation ()
SPConstCoreGeo const &	geometry () const
SPConstMaterial const &	material () const
SPConstGeoMaterial const &	geomaterial () const
SPConstParticle const &	particle () const
SPConstCutoff const &	cutoff () const
SPConstPhysics const &	physics () const
SPConstAction const &	along_step () const
SPConstRng const &	rng () const
SPConstSim const &	sim () const
SPConstTrackInit const &	init () const
SPConstWentzelOKVI const &	wentzel () const
SPActionRegistry const &	action_reg () const
SPUserRegistry const &	aux_reg () const
SPConstCore const &	core () const
SPConstCherenkov const &	cherenkov () const
SPActionRegistry const &	optical_action_reg () const
SPConstOpticalMaterial const &	optical_material () const
SPOpticalParams const &	optical_params () const
SPConstOpticalPhysics const &	optical_physics () const
SPConstScintillation const &	scintillation () const

Additional Inherited Members
Public Types inherited from celeritas::test::LazyGeantGeoManager
using	SPConstGeoI = std::shared_ptr< GeoParamsInterface const >
using	SPConstGeantGeo = std::shared_ptr< GeantGeoParams const >
using	SPConstVolumes = std::shared_ptr< VolumeParams const >
Static Public Member Functions inherited from celeritas::test::Test
static std::string	test_data_path (std::string_view subdir, std::string_view filename)
	Get the path to a test file at {source}/test/{subdir}/data/{filename}.
static bool	strict_testing ()
	True if strict testing is required.
Static Public Member Functions inherited from celeritas::test::LazyGeantGeoManager
static void	clear_lazy_geo ()
	Reset the secondary geometry manually.
Static Public Attributes inherited from celeritas::test::Test
static constexpr double	inf = HUGE_VAL
static constexpr float	inff = HUGE_VALF
static constexpr double	fine_eps = 1e-12
static constexpr double	coarse_eps = 1e-6

Detailed Description

Lazily construct core parameters, individually or together.

Note

Inherit from this class using virtual public so that tests can create mixins (see e.g. SimpleStepperTest).

Todo:

Replace the construction with modifiers to celeritas::inp data structures, and build the core geometry with celeritas::setup.

Member Typedef Documentation

SP

template<class T >

using celeritas::test::GlobalTestBase::SP = std::shared_ptr<T>

Access lazily constructed objects.

SPActionRegistry

using celeritas::test::GlobalTestBase::SPActionRegistry = SP<ActionRegistry>

Access lazily constructed objects.

SpanConstPrimary

using celeritas::test::GlobalTestBase::SpanConstPrimary = Span<Primary const>

Access lazily constructed objects.

SPConstAction

using celeritas::test::GlobalTestBase::SPConstAction = SP<CoreStepActionInterface const>

Access lazily constructed objects.

SPConstCherenkov

using celeritas::test::GlobalTestBase::SPConstCherenkov = SP<CherenkovParams const>

Access lazily constructed objects.

SPConstCore

using celeritas::test::GlobalTestBase::SPConstCore = SP<CoreParams const>

Access lazily constructed objects.

SPConstCoreGeo

using celeritas::test::GlobalTestBase::SPConstCoreGeo = SP<CoreGeoParams const>

Access lazily constructed objects.

SPConstCutoff

using celeritas::test::GlobalTestBase::SPConstCutoff = SP<CutoffParams const>

Access lazily constructed objects.

SPConstGeoMaterial

using celeritas::test::GlobalTestBase::SPConstGeoMaterial = SP<GeoMaterialParams const>

Access lazily constructed objects.

SPConstMaterial

using celeritas::test::GlobalTestBase::SPConstMaterial = SP<MaterialParams const>

Access lazily constructed objects.

SPConstOpticalMaterial

using celeritas::test::GlobalTestBase::SPConstOpticalMaterial = SP<optical::MaterialParams const>

Access lazily constructed objects.

SPConstOpticalPhysics

using celeritas::test::GlobalTestBase::SPConstOpticalPhysics = SP<optical::PhysicsParams const>

Access lazily constructed objects.

SPConstParticle

using celeritas::test::GlobalTestBase::SPConstParticle = SP<ParticleParams const>

Access lazily constructed objects.

SPConstPhysics

using celeritas::test::GlobalTestBase::SPConstPhysics = SP<PhysicsParams const>

Access lazily constructed objects.

SPConstPrimariesAction

using celeritas::test::GlobalTestBase::SPConstPrimariesAction = SP<ExtendFromPrimariesAction const>

Access lazily constructed objects.

SPConstRng

using celeritas::test::GlobalTestBase::SPConstRng = SP<RngParams const>

Access lazily constructed objects.

SPConstScintillation

using celeritas::test::GlobalTestBase::SPConstScintillation = SP<ScintillationParams const>

Access lazily constructed objects.

SPConstSim

using celeritas::test::GlobalTestBase::SPConstSim = SP<SimParams const>

Access lazily constructed objects.

SPConstSurface

using celeritas::test::GlobalTestBase::SPConstSurface = SP<SurfaceParams const>

Access lazily constructed objects.

SPConstTrackInit

using celeritas::test::GlobalTestBase::SPConstTrackInit = SP<TrackInitParams const>

Access lazily constructed objects.

SPConstVolume

using celeritas::test::GlobalTestBase::SPConstVolume = SP<VolumeParams const>

Access lazily constructed objects.

SPConstWentzelOKVI

using celeritas::test::GlobalTestBase::SPConstWentzelOKVI = SP<WentzelOKVIParams const>

Access lazily constructed objects.

SPOpticalParams

using celeritas::test::GlobalTestBase::SPOpticalParams = SP<optical::CoreParams>

Access lazily constructed objects.

SPOutputRegistry

using celeritas::test::GlobalTestBase::SPOutputRegistry = SP<OutputRegistry>

Access lazily constructed objects.

SPUserRegistry

using celeritas::test::GlobalTestBase::SPUserRegistry = SP<AuxParamsRegistry>

Access lazily constructed objects.

Member Function Documentation

action_reg() [1/2]

auto celeritas::test::GlobalTestBase::action_reg ( )

inline

Access lazily constructed objects.

action_reg() [2/2]

auto celeritas::test::GlobalTestBase::action_reg ( ) const

inline

Access lazily constructed objects.

along_step() [1/2]

auto celeritas::test::GlobalTestBase::along_step ( )

inline

Access lazily constructed objects.

along_step() [2/2]

auto celeritas::test::GlobalTestBase::along_step ( ) const

inline

Access lazily constructed objects.

aux_reg() [1/2]

auto celeritas::test::GlobalTestBase::aux_reg ( )

inline

Access lazily constructed objects.

aux_reg() [2/2]

auto celeritas::test::GlobalTestBase::aux_reg ( ) const

inline

Access lazily constructed objects.

build_geo_from_gdml()

SPConstGeoI celeritas::test::GlobalTestBase::build_geo_from_gdml ( std::string const &  filename ) const

finalprotectedvirtual

Build from a GDML path as a fallback.

Reimplemented from celeritas::test::LazyGeantGeoManager.

build_geo_from_geant()

SPConstGeoI celeritas::test::GlobalTestBase::build_geo_from_geant ( SPConstGeantGeo const &  ) const

finalprotectedvirtual

Implements celeritas::test::LazyGeantGeoManager.

cherenkov() [1/2]

auto celeritas::test::GlobalTestBase::cherenkov ( )

inline

Access lazily constructed objects.

cherenkov() [2/2]

auto celeritas::test::GlobalTestBase::cherenkov ( ) const

inline

Access lazily constructed objects.

core() [1/2]

auto celeritas::test::GlobalTestBase::core ( )

inline

Access lazily constructed objects.

core() [2/2]

auto celeritas::test::GlobalTestBase::core ( ) const

inline

Access lazily constructed objects.

cutoff() [1/2]

auto celeritas::test::GlobalTestBase::cutoff ( )

inline

Access lazily constructed objects.

cutoff() [2/2]

auto celeritas::test::GlobalTestBase::cutoff ( ) const

inline

Access lazily constructed objects.

gdml_basename()

virtual std::string_view celeritas::test::LazyGeantGeoManager::gdml_basename ( ) const

protectedvirtual

Get an identifying key for the geometry (basename, description, etc)

Implements celeritas::test::LazyGeantGeoManager.

Reimplemented in celeritas::test::MscTestBase, celeritas::test::InvalidOrangeTestBase, celeritas::test::LArSphereBase, celeritas::test::LeadBoxTestBase, celeritas::test::MockTestBase, celeritas::test::OneSteelSphereBase, celeritas::optical::test::OpticalMockTestBase, celeritas::test::SimpleCmsTestBase, celeritas::test::SimpleTestBase, celeritas::test::TestEm15Base, and celeritas::test::TestEm3Base.

geomaterial() [1/2]

auto celeritas::test::GlobalTestBase::geomaterial ( )

inline

Access lazily constructed objects.

geomaterial() [2/2]

auto celeritas::test::GlobalTestBase::geomaterial ( ) const

inline

Access lazily constructed objects.

geometry() [1/2]

auto celeritas::test::GlobalTestBase::geometry ( )

inline

Access lazily constructed objects.

geometry() [2/2]

auto celeritas::test::GlobalTestBase::geometry ( ) const

inline

Access lazily constructed objects.

init() [1/2]

auto celeritas::test::GlobalTestBase::init ( )

inline

Access lazily constructed objects.

init() [2/2]

auto celeritas::test::GlobalTestBase::init ( ) const

inline

Access lazily constructed objects.

material() [1/2]

auto celeritas::test::GlobalTestBase::material ( )

inline

Access lazily constructed objects.

material() [2/2]

auto celeritas::test::GlobalTestBase::material ( ) const

inline

Access lazily constructed objects.

optical_action_reg() [1/2]

auto celeritas::test::GlobalTestBase::optical_action_reg ( )

inline

Access lazily constructed objects.

optical_action_reg() [2/2]

auto celeritas::test::GlobalTestBase::optical_action_reg ( ) const

inline

Access lazily constructed objects.

optical_material() [1/2]

auto celeritas::test::GlobalTestBase::optical_material ( )

inline

Access lazily constructed objects.

optical_material() [2/2]

auto celeritas::test::GlobalTestBase::optical_material ( ) const

inline

Access lazily constructed objects.

optical_params() [1/2]

auto celeritas::test::GlobalTestBase::optical_params ( )

inline

Access lazily constructed objects.

optical_params() [2/2]

auto celeritas::test::GlobalTestBase::optical_params ( ) const

inline

Access lazily constructed objects.

optical_physics() [1/2]

auto celeritas::test::GlobalTestBase::optical_physics ( )

inline

Access lazily constructed objects.

optical_physics() [2/2]

auto celeritas::test::GlobalTestBase::optical_physics ( ) const

inline

Access lazily constructed objects.

particle() [1/2]

auto celeritas::test::GlobalTestBase::particle ( )

inline

Access lazily constructed objects.

particle() [2/2]

auto celeritas::test::GlobalTestBase::particle ( ) const

inline

Access lazily constructed objects.

physics() [1/2]

auto celeritas::test::GlobalTestBase::physics ( )

inline

Access lazily constructed objects.

physics() [2/2]

auto celeritas::test::GlobalTestBase::physics ( ) const

inline

Access lazily constructed objects.

rng() [1/2]

auto celeritas::test::GlobalTestBase::rng ( )

inline

Access lazily constructed objects.

rng() [2/2]

auto celeritas::test::GlobalTestBase::rng ( ) const

inline

Access lazily constructed objects.

scintillation() [1/2]

auto celeritas::test::GlobalTestBase::scintillation ( )

inline

Access lazily constructed objects.

scintillation() [2/2]

auto celeritas::test::GlobalTestBase::scintillation ( ) const

inline

Access lazily constructed objects.

sim() [1/2]

auto celeritas::test::GlobalTestBase::sim ( )

inline

Access lazily constructed objects.

sim() [2/2]

auto celeritas::test::GlobalTestBase::sim ( ) const

inline

Access lazily constructed objects.

wentzel() [1/2]

auto celeritas::test::GlobalTestBase::wentzel ( )

inline

Access lazily constructed objects.

wentzel() [2/2]

auto celeritas::test::GlobalTestBase::wentzel ( ) const

inline

Access lazily constructed objects.

---

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

• GlobalTestBase.hh