celeritas::test::StepperTestBase Class Reference

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

#include <StepperTestBase.hh>

Inheritance diagram for celeritas::test::StepperTestBase:

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
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.
SPConstGeo 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 ()
SPConstOpticalMaterial const &	optical_material ()
SPConstScintillation const &	scintillation ()
SPConstGeo 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
SPConstOpticalMaterial const &	optical_material () const
SPConstScintillation const &	scintillation () const
Public Member Functions inherited from celeritas::test::Test
std::string	make_unique_filename (std::string_view ext={})
	Generate test-unique filename.

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 std::string	genericize_pointers (std::string_view s)
	Replace pointer addresses with 0x0 for improved testability.
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	SPConstGeo = SP< GeoParams const >
using	SPConstMaterial = SP< MaterialParams const >
using	SPConstGeoMaterial = SP< GeoMaterialParams const >
using	SPConstParticle = SP< ParticleParams const >
using	SPConstCutoff = SP< CutoffParams const >
using	SPConstPhysics = SP< PhysicsParams const >
using	SPConstAction = SP< CoreStepActionInterface const >
using	SPConstRng = SP< RngParams const >
using	SPConstSim = SP< SimParams const >
using	SPConstTrackInit = SP< TrackInitParams const >
using	SPConstWentzelOKVI = SP< WentzelOKVIParams const >
using	SPConstCore = SP< CoreParams const >
using	SPActionRegistry = SP< ActionRegistry >
using	SPOutputRegistry = SP< OutputRegistry >
using	SPUserRegistry = SP< AuxParamsRegistry >
using	SPConstCherenkov = SP< optical::CherenkovParams const >
using	SPConstOpticalMaterial = SP< optical::MaterialParams const >
using	SPConstScintillation = SP< optical::ScintillationParams const >
using	SPConstPrimariesAction = SP< ExtendFromPrimariesAction const >
using	SpanConstPrimary = Span< Primary const >
Static Public Attributes inherited from celeritas::test::Test
static constexpr double	inf = HUGE_VAL
static constexpr float	inff = HUGE_VALF
static constexpr double	coarse_eps = 1e-6
Protected Member Functions inherited from celeritas::test::GlobalTestBase
virtual SPConstGeo	build_geometry ()=0
virtual SPConstMaterial	build_material ()=0
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 SPConstScintillation	build_scintillation ()=0
void	disable_status_checker ()

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