celeritas::test::GenericGeoTestInterface Class Reference

Access capabilities from any templated GenericGeo test. More...

#include <GenericGeoTestInterface.hh>

Inheritance diagram for celeritas::test::GenericGeoTestInterface:

Public Types
Type aliases
using	TrackingResult = GenericGeoTrackingResult
using	VolumeStackResult = GenericGeoVolumeStackResult

Public Member Functions
virtual TrackingResult	track (Real3 const &pos_cm, Real3 const &dir)=0
	Generate a track.
virtual GenericGeoTrackingTolerance	tracking_tol () const
	Get the safety tolerance (defaults to SoftEq tol) for tracking result.
virtual std::string_view	geometry_type () const =0
	Get the label for this geometry: Geant4, VecGeom, ORANGE.
virtual GeoParamsInterface const &	geometry_interface () const =0
	Access the geometry interface.
virtual std::string_view	gdml_basename () const =0
virtual bool	supports_surface_normal () const
	Whether surface normals work for the current geometry/test.
virtual real_type	bump_tol () const
	Get the threshold for a movement being a "bump".
virtual Constant	unit_length () const
	Unit length for "track" testing and other results.
virtual VolumeStackResult	volume_stack (Real3 const &pos_cm)=0

Detailed Description

Access capabilities from any templated GenericGeo test.

The volume/instance offsets are usually used with Geant4, which has volume IDs that may not start with zero if the problem has been reinitaialized. (This is because geant4 uses global static integers for counting.) It can also be used in other circumstances (vecgeom internal construction) where fake volumes/instances are inserted before the "real" volumes/instances.

Member Function Documentation

bump_tol()

real_type celeritas::test::GenericGeoTestInterface::bump_tol ( ) const

virtual

Get the threshold for a movement being a "bump".

This unitless tolerance is multiplied by the test's unit length when used.

gdml_basename()

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

pure virtual

Implemented in celeritas::test::GenericGeoTestBase< G >, celeritas::test::GenericGeoTestBase< HP >, celeritas::test::GenericGeoTestBase< OrangeParams >, and celeritas::test::GenericGeoTestBase< VecgeomParams >.

geometry_interface()

virtual GeoParamsInterface const & celeritas::test::GenericGeoTestInterface::geometry_interface ( ) const

pure virtual

Access the geometry interface.

Implemented in celeritas::test::GenericGeoTestBase< G >, celeritas::test::GenericGeoTestBase< HP >, celeritas::test::GenericGeoTestBase< OrangeParams >, and celeritas::test::GenericGeoTestBase< VecgeomParams >.

geometry_type()

virtual std::string_view celeritas::test::GenericGeoTestInterface::geometry_type ( ) const

pure virtual

Get the label for this geometry: Geant4, VecGeom, ORANGE.

Implemented in celeritas::test::GenericGeoTestBase< G >, celeritas::test::GenericGeoTestBase< HP >, celeritas::test::GenericGeoTestBase< OrangeParams >, and celeritas::test::GenericGeoTestBase< VecgeomParams >.

supports_surface_normal()

bool celeritas::test::GenericGeoTestInterface::supports_surface_normal ( ) const

virtual

Whether surface normals work for the current geometry/test.

This defaults to true and should be disabled per geometry implementation/geometry class.

Reimplemented in celeritas::test::VecgeomTestBase.

track()

virtual TrackingResult celeritas::test::GenericGeoTestInterface::track ( Real3 const &  pos_cm, Real3 const &  dir  )

pure virtual

Generate a track.

Implemented in celeritas::test::GenericGeoTestBase< G >, celeritas::test::GenericGeoTestBase< HP >, celeritas::test::GenericGeoTestBase< OrangeParams >, and celeritas::test::GenericGeoTestBase< VecgeomParams >.

tracking_tol()

GenericGeoTrackingTolerance celeritas::test::GenericGeoTestInterface::tracking_tol ( ) const

virtual

Get the safety tolerance (defaults to SoftEq tol) for tracking result.

Get the safety tolerance (defaults to SoftEq tol).

volume_stack()

virtual VolumeStackResult celeritas::test::GenericGeoTestInterface::volume_stack ( Real3 const &  pos_cm )

pure virtual

Obtain the "touchable history" at a point

Implemented in celeritas::test::GenericGeoTestBase< G >, celeritas::test::GenericGeoTestBase< HP >, celeritas::test::GenericGeoTestBase< OrangeParams >, and celeritas::test::GenericGeoTestBase< VecgeomParams >.

---

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

• GenericGeoTestInterface.hh
• GenericGeoTestInterface.cc