EGSnrc C++ class library  Report PIRS-898 (2021)
Iwan Kawrakow, Ernesto Mainegra-Hing, Frederic Tessier, Reid Townson and Blake Walters
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
oNvolcorRegion discovery/volume correction for auto envelope geometries
oCAEnvelopeAuxA helper class for initializing auto envelopes
oCAlphaRecord
oCBEAM_DoseScoringA dose scoring object: header
oCBetaMinusRecord
oCBetaPlusRecord
oCBetaRecordLeaf
oCBranch
oCCommentRecord
oCCSSSLayerA conical shell shape
oCEGS_2DPolygonA class to represent a polygon in a plane (a 2D polygon)
oCEGS_2DVectorA class representing 2D vectors
oCEGS_AdvancedApplicationBase class for advanced EGSnrc applications based on the mortran EGSnrc back-end
oCEGS_AEnvelopeA fast envelope geometry with automatic region detection
oCEGS_AffineTransformA class providing affine transformations
oCEGS_AliasTableA class for sampling random values from a given probability distribution using the alias table technique
oCEGS_AngularSpreadSourceA source that adds additional Gaussian angular spread to another source
oCEGS_ApplicationBase class for advanced EGSnrc C++ applications
oCEGS_ASwitchedEnvelopeThis geometry type allows you to activate and deactivate inscribed geometries in custom egspp user codes
oCEGS_AtomicRelaxations
oCEGS_AusgabObject
oCEGS_BaseGeometryBase geometry class. Every geometry class must be derived from EGS_BaseGeometry
oCEGS_BaseShapeBase shape class. All shapes in the EGSnrc C++ class library are derived from EGS_BaseShape
oCEGS_BaseSimpleSourceBase class for 'simple' particle sources
oCEGS_BaseSourceBase source class. All particle sources must be derived from this class
oCEGS_BaseSpectrumBase class for energy spectra. All energy spectra in the EGSnrc C++ class library are derived from this class
oCEGS_BeamSourceA BEAM simulation source
oCEGS_BoundsA structure corresponding to the EGSnrc transport threshold energies common block BOUNDS
oCEGS_BoxA box geometry
oCEGS_BoxShapeA box shape
oCEGS_CDGeometryA "combinatorial dimension" geometry
oCEGS_CirclePerpendicularShapeA circle shape perpendicular to source particles
oCEGS_CircleShapeA circle shape
oCEGS_CollimatedSourceA collimated particle source
oCEGS_ConeSetA set of cones with different opening angles but the same axis and apexes
oCEGS_ConeStackA cone stack
oCEGS_ConicalShellStackShape
oCEGS_cSpheresA set of concentric spheres
oCEGS_cSphericalShellImplements a spherical shell geometry with a hollow centre
oCEGS_CylinderShapeA cylinder shape
oCEGS_CylindersTA set of concentric cylinders
oCEGS_DeformedXYZA deformed XYZ-geometry
oCEGS_DoseScoringA dose scoring object: header
oCEGS_DoubleGaussianSpectrumA double-Gaussian spectrum
oCEGS_DynamicSourceA source with time-varying rotations/translations
oCEGS_ElementRelaxData
oCEGS_EllipseShapeAn elliptical shape
oCEGS_emfInputsA structure corresponding to the EMF_INPUTS common block
oCEGS_EnsdfThe ensdf class for reading ensdf format data files
oCEGS_EnvelopeGeometryAn envelope geometry class
oCEGS_EpcontA structure corresponding to the EPCONT common block
oCEGS_EtControlA structure corresponding to the ET_control common block
oCEGS_ExtendedShapeAn extended shape
oCEGS_FanoSourceA Fano source
oCEGS_FastEnvelopeAn envelope geometry class
oCEGS_FloatInputLoopVariableA base class for real valued input loops. Basic functionality for input loops is provided by this class
oCEGS_FluenceScoringBase class for fluence scoring
oCEGS_GaussianShapeA Gaussian shape
oCEGS_GaussianSpectrumA Gaussian spectrum
oCEGS_GeometryHistory
oCEGS_GeometryIntersections
oCEGS_GeometryTesterA class for testing geometries
oCEGS_Hexagonal_Lattice
oCEGS_InputA class for storing information in a tree-like structure of key-value pairs. This class is used throughout the egspp class library for passing information to the various objects
oCEGS_InputLoopVariableA base class for input loops. Basic functionality for input loops is provided by this class. Input loops can be used whenever a large number of similar input blocks are needed
oCEGS_IntegerInputLoopVariableA base class for integer valued input loops. Basic functionality for input loops is provided by this class
oCEGS_InterpolatorA class for fast run-time interpolations
oCEGS_IOA structure corresponding to the egs_io common block
oCEGS_IPlanesA set of planes intersecting in the same axis
oCEGS_IsotropicSourceAn isotropic source
oCEGS_JCFControlA 'job control file' (JCF) RCO
oCEGS_LatticeA Bravais, cubic, and hexagonal lattice geometryA geometry which embeds a lattice of one geometry (named subgeometry below) into one region of a second geometry (named base geometry). This geometry effectively recurses the subgeometry at every position defined by a Bravais, cubic, or hexagonal lattice. As such, you can model an infinite amount of subgeometries (e.g., region 0 of egs_space) and the only slow down to your simulation would depend on how many subgeometries you would expect over a particle track
oCEGS_LibraryA class for dynamically loading shared libraries
oCEGS_LineShapeA line shape
oCEGS_ListInputLoopVariable
oCEGS_MediaA structure corresponding to the MEDIA common block
oCEGS_MeshA tetrahedral mesh geometry
oCEGS_MeshSpecA container for raw unstructured tetrahedral mesh data
oCEGS_MonoEnergyA monoenergetic particle spectrum
oCEGS_NDGeometryA class modeling a N-dimensional geometry
oCEGS_ObjectBase egspp object
oCEGS_ObjectFactoryAn object factory
oCEGS_OctreeAn octree geometry
oCEGS_Octree_bbox
oCEGS_Octree_node
oCEGS_ParallelBeamA parallel beam
oCEGS_ParallelConesA set of "parallel cones" (i.e. cones with the same axis and opening angles but different apexes)
oCEGS_ParticleA structure holding the information of one particle
oCEGS_ParticleTrackA class representing a single track of a particle
oCEGS_ParticleTrackContainerA class that stores all the tracks in a simulation
oCEGS_PhspScoringA phase space scoring object: header
oCEGS_PhspSourceA phase-space file source
oCEGS_PlanarFluenceAusgab object for scoring fluence at circular or rectangular fields
oCEGS_PlaneCollectionA collection of non-parallel planes
oCEGS_PlanesTA set of parallel planes
oCEGS_PointShapeA point shape. This is the simplest shape possible: it simply always returns the same point
oCEGS_PointSourceA point source
oCEGS_PolygonShapeA polygon shape
oCEGS_PolygonTA template class for 3D polygons
oCEGS_PrismTA class for modeling prisms
oCEGS_ProjectorA projector into any plane
oCEGS_PyramidTA template class for modeling pyramids
oCEGS_RadialRepeaterA radial geometry replicator
oCEGS_RadiativeSplittingA radiative splitting object: header
oCEGS_RadionuclideBetaSpectrumBeta spectrum generation for EGS_RadionuclideSpectrum
oCEGS_RadionuclideSourceA radionuclide source
oCEGS_RadionuclideSpectrumA radionuclide spectrum
oCEGS_RandomGeneratorBase random number generator class. All random number generators should be derived from this class
oCEGS_RanmarA ranmar RNG class
oCEGS_RayleighA structure corresponding to the rayleigh_inputs common block
oCEGS_RectangleShapeA rectangular shape
oCEGS_RectangularRingA "rectangular ring"
oCEGS_RelaxationParticle
oCEGS_RelaxImplementation
oCEGS_RotationMatrixA class for vector rotations
oCEGS_RoundRectCylindersTA set of concentric rounded rectangles
oCEGS_RunControlA simple run control object for advanced EGSnrc C++ applications
oCEGS_RZGeometrySubclass of EGS_NDGeometry for conveniently defining an RZ geometry
oCEGS_ScoringArrayA class for scoring an array of quantities (e.g. a dose distribution) in a Monte Carlo simulation
oCEGS_ScoringSingleA class for scoring a single quantity of interest in a Monte Carlo simulation
oCEGS_ShapeCollectionA shape collection
oCEGS_ShellData
oCEGS_SimpleAliasTableA class for sampling random bins from a given probability distribution using the alias table technique
oCEGS_SimpleApplicationA base class for developing simple EGSnrc applications
oCEGS_SimpleConeA single cone that may be open (i.e. extends to infinity or closed by a plane perpendicular to the cone axis
oCEGS_SimpleContainer
oCEGS_SmartEnvelope
oCEGS_SourceCollectionA source collection
oCEGS_SpaceThe entire space as a geometry object
oCEGS_SphereShapeA sphere shape
oCEGS_SphericalShellShapeA spherical shell shape
oCEGS_StackA structure corresponding to the EGSnrc particle stack common block STACK
oCEGS_StackGeometryA stack of geometries
oCEGS_SurfaceShapeA surface shape
oCEGS_TabulatedSpectrumA tabulated spectrum
oCEGS_TestMicro
oCEGS_ThreshA structure corresponding to the particle production threshold energies common block THRESH
oCEGS_TimerA simple class for measuring CPU time
oCEGS_TrackScoringA track scoring object: header
oCEGS_TransformedGeometryA transformed geometry
oCEGS_TransformedSourceA transformed source
oCEGS_TriangleShapeA triangular shape
oCEGS_TypedObjectFactoryA typed object factory
oCEGS_UniformRunControlA job control object for homogeneous computing environments (HCE)
oCEGS_UniformSpectrumA uniform energy spectrum
oCEGS_UnionGeometryA geometry constructed as the union of other geometries
oCEGS_UsefulA structure corresponding to the USEFUL common block
oCEGS_VarianceReductionA structure corresponding to the egs_vr common block
oCEGS_VectorA class representing 3D vectors
oCEGS_VHPGeometryA Voxelized Human Phantom (VHP) geometry
oCEGS_VolumetricFluenceAusgab object for scoring fluence in arbitrary geometry regions
oCEGS_VoxelizedShapeA "voxelized shape"
oCEGS_XOptionsA structure corresponding to the xsection_options common block
oCEGS_XProjectorA projector into the x-plane
oCEGS_XYZGeometryAn XYZ-geometry
oCEGS_XYZRepeaterA geometry repeated on a regular XYZ grid
oCEGS_YProjectorA projector into the y-plane
oCEGS_ZProjectorA projector into the z-plane
oCEnvelopeAux
oCGammaRecord
oCIAEA_PhspSourceAn IAEA phase-space file source
oClabel
oCLeaf
oCLevelRecord
oCLevelRecordLeaf
oCNormalizationRecord
oCNormalizationRecordLeaf
oCParentRecord
oCParentRecordLeaf
oCRecord
\CSmartEnvelopeAux