Construct helper action and set up stepper/primary inputs. More...

#include <StepperTestBase.hh>

Inheritance diagram for celeritas::test::StepperTestBase:

[legend]

Classes
struct	RunResult

struct	SetupCheckResult

Public Member Functions
StepperInput	make_stepper_input (size_type tracks)

virtual std::vector< Primary >	make_primaries (size_type count) const =0
	Create a vector of primaries inside the 'run' function.

virtual size_type	max_average_steps () const =0
	Maximum number of steps on average before aborting.

SetupCheckResult	check_setup ()

RunResult	run (StepperInterface &step, size_type num_primaries) const

Public Member Functions inherited from celeritas::test::GlobalTestBase
optical::CoreParams::Input	optical_params_input ()

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.

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 ()

SPConstOpticalSurfacePhysics const &	optical_surface_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

SPConstOpticalSurfacePhysics const &	optical_surface_physics () const

SPConstScintillation const &	scintillation () const

Public Member Functions inherited from celeritas::test::Test
virtual std::string	make_unique_filename (std::string_view ext)
	Generate test-unique filename.

std::string	make_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.

Static Public Member Functions
static bool	is_default_build ()

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.

Additional Inherited Members
Public Types inherited from celeritas::test::GlobalTestBase
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	SPConstOpticalSurfacePhysics = SP< optical::SurfacePhysicsParams const >

using	SPConstScintillation = SP< ScintillationParams const >

using	SPConstPrimariesAction = SP< ExtendFromPrimariesAction const >

using	SpanConstPrimary = Span< Primary const >

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 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

Protected Member Functions inherited from celeritas::test::GlobalTestBase
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 SPConstOpticalSurfacePhysics	build_optical_surface_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)

Detailed Description

Construct helper action and set up stepper/primary inputs.

This class must be virtual so that it can be used as a mixin to other class definitions.

Example:

class TestEm3Test : public TestEm3Base,
                    public StepperTestBase
{
  public:
    std::vector<Primary> make_primaries(size_type count) const override;
};

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

StepperTestBase.hh

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description