Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::BoundarySurfaceT< volume_t > Class Template Reference

#include <acts/blob/sPHENIX/Core/include/Acts/Geometry/BoundarySurfaceT.hpp>

Public Member Functions

 BoundarySurfaceT ()
 
 BoundarySurfaceT (std::shared_ptr< const Surface > surface, const volume_t *inside, const volume_t *outside)
 
 BoundarySurfaceT (std::shared_ptr< const Surface > surface, VolumePtr inside, VolumePtr outside)
 
 BoundarySurfaceT (std::shared_ptr< const Surface > surface, std::shared_ptr< const VolumeArray > insideArray, std::shared_ptr< const VolumeArray > outsideArray)
 
virtual ~BoundarySurfaceT ()=default
 
virtual const volume_tattachedVolume (const GeometryContext &gctx, const Vector3 &pos, const Vector3 &mom, Direction dir) const
 
template<class parameters_t >
bool onBoundary (const GeometryContext &gctx, const parameters_t &pars) const
 
virtual const SurfacesurfaceRepresentation () const
 The Surface Representation of this.
 
void attachVolume (const volume_t *volume, Direction dir)
 
void attachVolumeArray (std::shared_ptr< const VolumeArray > volumes, Direction dir)
 

Protected Attributes

std::shared_ptr< const Surfacem_surface
 the represented surface by this
 
const volume_tm_oppositeVolume
 the inside (w.r.t. normal vector) volume to point to if only one exists
 
const volume_tm_alongVolume
 the outside (w.r.t. normal vector) volume to point to if only one exists
 
std::shared_ptr< const
VolumeArray
m_oppositeVolumeArray
 the inside (w.r.t. normal vector) volume array to point to
 
std::shared_ptr< const
VolumeArray
m_alongVolumeArray
 the outside (w.r.t. normal vector) volume array to point to
 

Private Types

using VolumePtr = std::shared_ptr< const volume_t >
 
using VolumeArray = BinnedArray< VolumePtr >
 

Private Attributes

friend volume_t
 

Detailed Description

template<class volume_t>
class Acts::BoundarySurfaceT< volume_t >

Template Parameters
volume_tthe type of volume.

The boundary surface class combines a Surface with the information of a volume. It's templated in the type of volume in order to allow for a return type tat is usable in the navigation stream.

Note
along/oppose definitions are given with respect to the normal vector of the boundary surface.

Definition at line 38 of file BoundarySurfaceT.hpp.

View newest version in sPHENIX GitHub at line 38 of file BoundarySurfaceT.hpp

Member Typedef Documentation

template<class volume_t >
using Acts::BoundarySurfaceT< volume_t >::VolumeArray = BinnedArray<VolumePtr>
private

Definition at line 44 of file BoundarySurfaceT.hpp.

View newest version in sPHENIX GitHub at line 44 of file BoundarySurfaceT.hpp

template<class volume_t >
using Acts::BoundarySurfaceT< volume_t >::VolumePtr = std::shared_ptr<const volume_t>
private

Definition at line 43 of file BoundarySurfaceT.hpp.

View newest version in sPHENIX GitHub at line 43 of file BoundarySurfaceT.hpp

Constructor & Destructor Documentation

template<class volume_t >
Acts::BoundarySurfaceT< volume_t >::BoundarySurfaceT ( )
inline

Definition at line 47 of file BoundarySurfaceT.hpp.

View newest version in sPHENIX GitHub at line 47 of file BoundarySurfaceT.hpp

template<class volume_t >
Acts::BoundarySurfaceT< volume_t >::BoundarySurfaceT ( std::shared_ptr< const Surface surface,
const volume_t inside,
const volume_t outside 
)
inline

Constructor for a Boundary with exact two Volumes attached to it

  • usually used in a volume constructor
Parameters
surfaceThe unique surface the boundary represents
insideThe inside volume the boundary surface points to
outsideThe outside volume the boundary surface points to

Definition at line 60 of file BoundarySurfaceT.hpp.

View newest version in sPHENIX GitHub at line 60 of file BoundarySurfaceT.hpp

template<class volume_t >
Acts::BoundarySurfaceT< volume_t >::BoundarySurfaceT ( std::shared_ptr< const Surface surface,
VolumePtr  inside,
VolumePtr  outside 
)
inline

Constructor for a Boundary with exact two Volumes attached to it

  • usually used in a volume constructor
Parameters
surfaceThe unique surface the boundary represents
insideThe inside volume the boundary surface points to
outsideThe outside volume the boundary surface points to

Definition at line 74 of file BoundarySurfaceT.hpp.

View newest version in sPHENIX GitHub at line 74 of file BoundarySurfaceT.hpp

template<class volume_t >
Acts::BoundarySurfaceT< volume_t >::BoundarySurfaceT ( std::shared_ptr< const Surface surface,
std::shared_ptr< const VolumeArray insideArray,
std::shared_ptr< const VolumeArray outsideArray 
)
inline

Constructor for a Boundary with exact multiple Volumes attached to it

  • usually used in a volume constructor
Parameters
surfaceThe unique surface the boundary represents
insideArrayThe inside volume array the boundary surface points to
outsideArrayThe outside volume array the boundary surface points to

Definition at line 89 of file BoundarySurfaceT.hpp.

View newest version in sPHENIX GitHub at line 89 of file BoundarySurfaceT.hpp

template<class volume_t >
virtual Acts::BoundarySurfaceT< volume_t >::~BoundarySurfaceT ( )
virtualdefault

Member Function Documentation

template<class volume_t >
const volume_t * BoundarySurfaceT< volume_t >::attachedVolume ( const GeometryContext gctx,
const Vector3 pos,
const Vector3 mom,
Direction  dir 
) const
virtual

Get the next Volume depending on GlobalPosition, GlobalMomentum, dir on the TrackParameters and the requested direction

Parameters
gctxThe current geometry context object, e.g. alignment
posThe global position on surface
momThe direction on the surface
diris an additional direction corrective
Returns
The attached volume at that position

Definition at line 182 of file BoundarySurfaceT.hpp.

View newest version in sPHENIX GitHub at line 182 of file BoundarySurfaceT.hpp

template<class volume_t >
void BoundarySurfaceT< volume_t >::attachVolume ( const volume_t volume,
Direction  dir 
)

Helper method: attach a Volume to this BoundarySurfaceT this is done during the geometry construction.

Parameters
volumeThe volume to be attached
dirThe direction for attaching

Definition at line 162 of file BoundarySurfaceT.hpp.

View newest version in sPHENIX GitHub at line 162 of file BoundarySurfaceT.hpp

References Acts::Direction::Backward.

Referenced by Acts::TrackingVolume::glueTrackingVolume().

+ Here is the caller graph for this function:

template<class volume_t >
void BoundarySurfaceT< volume_t >::attachVolumeArray ( std::shared_ptr< const VolumeArray volumes,
Direction  dir 
)

Helper method: attach a Volume to this BoundarySurfaceT this is done during the geometry construction.

Parameters
volumesThe volume array to be attached
dirThe direction for attaching

Definition at line 172 of file BoundarySurfaceT.hpp.

View newest version in sPHENIX GitHub at line 172 of file BoundarySurfaceT.hpp

References Acts::Direction::Backward, and volumes.

Referenced by Acts::TrackingVolume::glueTrackingVolumes().

+ Here is the caller graph for this function:

template<class volume_t >
template<class parameters_t >
bool Acts::BoundarySurfaceT< volume_t >::onBoundary ( const GeometryContext gctx,
const parameters_t &  pars 
) const
inline

templated onBoundary method

Template Parameters
parameters_tare the parameters to be checked
Parameters
gctxThe current geometry context object, e.g. alignment
parsThe parameters used for this call

Definition at line 120 of file BoundarySurfaceT.hpp.

View newest version in sPHENIX GitHub at line 120 of file BoundarySurfaceT.hpp

References Acts::Surface::isOnSurface(), and Acts::BoundarySurfaceT< volume_t >::surfaceRepresentation().

+ Here is the call graph for this function:

template<class volume_t >
const Surface & BoundarySurfaceT< volume_t >::surfaceRepresentation ( ) const
inlinevirtual

The Surface Representation of this.

Definition at line 156 of file BoundarySurfaceT.hpp.

View newest version in sPHENIX GitHub at line 156 of file BoundarySurfaceT.hpp

Referenced by Acts::BoundarySurfaceT< volume_t >::onBoundary().

+ Here is the caller graph for this function:

Member Data Documentation

template<class volume_t >
const volume_t* Acts::BoundarySurfaceT< volume_t >::m_alongVolume
protected

the outside (w.r.t. normal vector) volume to point to if only one exists

Definition at line 148 of file BoundarySurfaceT.hpp.

View newest version in sPHENIX GitHub at line 148 of file BoundarySurfaceT.hpp

template<class volume_t >
std::shared_ptr<const VolumeArray> Acts::BoundarySurfaceT< volume_t >::m_alongVolumeArray
protected

the outside (w.r.t. normal vector) volume array to point to

Definition at line 152 of file BoundarySurfaceT.hpp.

View newest version in sPHENIX GitHub at line 152 of file BoundarySurfaceT.hpp

template<class volume_t >
const volume_t* Acts::BoundarySurfaceT< volume_t >::m_oppositeVolume
protected

the inside (w.r.t. normal vector) volume to point to if only one exists

Definition at line 146 of file BoundarySurfaceT.hpp.

View newest version in sPHENIX GitHub at line 146 of file BoundarySurfaceT.hpp

template<class volume_t >
std::shared_ptr<const VolumeArray> Acts::BoundarySurfaceT< volume_t >::m_oppositeVolumeArray
protected

the inside (w.r.t. normal vector) volume array to point to

Definition at line 150 of file BoundarySurfaceT.hpp.

View newest version in sPHENIX GitHub at line 150 of file BoundarySurfaceT.hpp

template<class volume_t >
std::shared_ptr<const Surface> Acts::BoundarySurfaceT< volume_t >::m_surface
protected

the represented surface by this

Definition at line 144 of file BoundarySurfaceT.hpp.

View newest version in sPHENIX GitHub at line 144 of file BoundarySurfaceT.hpp

template<class volume_t >
friend Acts::BoundarySurfaceT< volume_t >::volume_t
private

Definition at line 40 of file BoundarySurfaceT.hpp.

View newest version in sPHENIX GitHub at line 40 of file BoundarySurfaceT.hpp


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