celeritas::test::GenericGeoTestInterface Class Reference

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

#include <GenericGeoTestInterface.hh>

Inheritance diagram for celeritas::test::GenericGeoTestInterface:

Public Member Functions
virtual std::string_view	geometry_type () const =0
	Get the label for this geometry: Geant4, VecGeom, ORANGE.
virtual SPConstGeoInterface	geometry_interface () const =0
	Access the geometry interface, building if needed.
virtual std::string	geometry_basename () const
	Get the basename or unique geometry key (defaults to suite name).
virtual real_type	safety_tol () const
	Get the safety tolerance (defaults to SoftEq tol).
virtual real_type	bump_tol () const
	Get the threshold for a movement being a "bump".
virtual VolumeId::size_type	volume_offset () const
	Ignore the first N VolumeId.
virtual VolumeInstanceId::size_type	volume_instance_offset () const
	Ignore the first N VolumeInstanceId.
virtual Constant	unit_length () const
	Unit length for "track" testing and other results.
virtual G4VPhysicalVolume const *	g4world () const
	Access the loaded geant4 world (if one exists)
std::vector< std::string >	get_volume_labels () const
	Get all logical volume labels.
std::vector< std::string >	get_volume_instance_labels () const
	Get all physical volume labels, including extensions.
std::vector< std::string >	get_g4pv_labels () const
	Get all Geant4 PV names corresponding to volume instances.
std::string_view	get_volume_name (VolumeId i) const
	Get the volume name, adjusting for offsets from loading multiple geo.
virtual VolumeStackResult	volume_stack (Real3 const &pos_cm)=0

Type aliases
using	TrackingResult = GenericGeoTrackingResult
using	VolumeStackResult = GenericGeoVolumeStackResult
using	SPConstGeoInterface = std::shared_ptr< GeoParamsInterface const >
virtual TrackingResult	track (Real3 const &pos_cm, Real3 const &dir)=0
virtual TrackingResult	track (Real3 const &pos_cm, Real3 const &dir, int max_step)=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.

g4world()

virtual G4VPhysicalVolume const * celeritas::test::GenericGeoTestInterface::g4world ( ) const

inlinevirtual

Access the loaded geant4 world (if one exists)

Reimplemented in celeritas::test::GeantGeoTestBase.

geometry_interface()

virtual SPConstGeoInterface celeritas::test::GenericGeoTestInterface::geometry_interface ( ) const

pure virtual

Access the geometry interface, building if needed.

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

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< GeantGeoParams >, and celeritas::test::GenericGeoTestBase< HP >.

volume_instance_offset()

virtual VolumeInstanceId::size_type celeritas::test::GenericGeoTestInterface::volume_instance_offset ( ) const

inlinevirtual

Ignore the first N VolumeInstanceId.

Reimplemented in celeritas::test::GeantGeoTestBase.

volume_offset()

virtual VolumeId::size_type celeritas::test::GenericGeoTestInterface::volume_offset ( ) const

inlinevirtual

Ignore the first N VolumeId.

Reimplemented in celeritas::test::GeantGeoTestBase.

volume_stack()

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

pure virtual

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

---

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

• GenericGeoTestInterface.hh
• GenericGeoTestInterface.cc