Celeritas 0.6.0-129+develop.846910afa
Loading...
Searching...
No Matches
Public Member Functions | List of all members
celeritas::test::GenericGeoTestInterface Class Referenceabstract

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

#include <GenericGeoTestInterface.hh>

Inheritance diagram for celeritas::test::GenericGeoTestInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ModelInpResult model_inp () const =0
 Get the model input from the geometry.
 
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_view gdml_basename () const =0
 
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 Constant unit_length () const
 Unit length for "track" testing and other results.
 
virtual VolumeStackResult volume_stack (Real3 const &pos_cm)=0
 

Type aliases

using TrackingResult = GenericGeoTrackingResult
 
using VolumeStackResult = GenericGeoVolumeStackResult
 
using ModelInpResult = GenericGeoModelInp
 
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.

◆ gdml_basename()

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

◆ geometry_interface()

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

◆ geometry_type()

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

◆ model_inp()

virtual ModelInpResult celeritas::test::GenericGeoTestInterface::model_inp ( ) const
pure virtual

◆ volume_stack()

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

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