The slug C++ API
This section documents slug’s C++ core (the src/ tree,
excluding the vendored third-party libraries under
src/extern and the compiled-extension glue under
src/pybind – see slugpy for that), generated
directly from its own Doxygen docstrings via Exhale, which organizes them the
same way Doxygen’s own native HTML output does – separate,
alphabetized Namespace, Class, and File listings – rather
than one undivided page.
Class Hierarchy
-
- Namespace core
- Class Cluster
- Class Galaxy
- Struct Galaxy::FieldStar
- Struct Galaxy::NoDeathRateHook
- Class SimCluster
- Class SimGalaxy
- Namespace elem
- Struct IsotopeDecayData
- Class DecayChain
- Class ElemData
- Class IonizationData
- Class IsotopeData
- Class IsotopeTable
- Enum Symbols
- Namespace extinct
- Class Extinct
- Namespace feedback
- Class Winds
- Enum AGBwindModel
- Enum OBwindModel
- Enum OtherwindModel
- Enum WRwindModel
- Namespace interp
- Template Class Interpolator1D
- Template Class LazyValueSource
- Class Mesh2DGrid
- Struct Mesh2DGrid::xIntersectionDescriptor
- Struct Mesh2DGrid::yIntersectionDescriptor
- Class Mesh2DGrid::MView
- Class Mesh2DGrid::SView
- Class Mesh2DGrid::XView
- Template Class Mesh2DInterpolator
- Template Class Mesh3DInterpolator
- Namespace io
- Class OutputManager
- Class OutputManagerAscii
- Class OutputManagerH5
- Class SimControls
- Namespace nebular
- Struct NebularControls
- Class Nebular
- Namespace pdfs
- Class PDF
- Class PDFReflect
- Class PDFSegment
- Class PDFSegmentDelta
- Class PDFSegmentExponential
- Class PDFSegmentLognormal
- Class PDFSegmentNormal
- Class PDFSegmentPowerlaw
- Class PDFSegmentSchechter
- Enum FileFormats
- Enum SamplingMethods
- Namespace phot
- Class Filter
- Class FilterCollection
- Class FilterIdeal
- Class FilterTabulated
- Class VegaSpectrum
- Enum PhotSystem
- Namespace specsyn
- Class Specsyn
- Class SpecsynBlackbody
- Template Class SpecsynLib
- Template Class SpecsynLib2D
- Class SpecsynLibChained
- Template Class SpecsynLibNoWind
- Template Class SpecsynLibWD
- Template Class SpecsynLibWR
- Enum GridType
- Enum OOBPolicy
- Namespace tracks
- Namespace utils
- Struct Bracket
- Struct DeckKeyReport
- Struct GKIntegrationInterval
- Template Struct GKRule
- Template Struct GKRule< GKOrder::GK15 >
- Template Struct GKRule< GKOrder::GK21 >
- Template Struct GKRule< GKOrder::GK31 >
- Template Struct GKRule< GKOrder::GK41 >
- Template Struct GKRule< GKOrder::GK51 >
- Template Struct GKRule< GKOrder::GK61 >
- Class DiscreteDist
- Template Class GKIntegrator
- Class LognormalDist
- Class MPIGuard
- Class NormalDist
- Template Class PDFIntegrator
- Class PoissonDist
- Class RngThread
- Class SigtermGuard
- Template Class ThreadVec
- Class TrackedDeck
- Struct TrackedDeck::Leaf
- Class UniqueIDManager
- Enum GKOrder
- Namespace yields
- Struct YieldChannelDescriptor
- Class YieldChannel
- Class Yields
- Enum Channel
- Namespace core
File Hierarchy
-
- Directory src
- Directory core
- File Cluster.hpp
- File Galaxy.hpp
- File SimCluster.hpp
- File SimGalaxy.hpp
- Directory elem
- File DecayChain.hpp
- File ElemCommons.hpp
- File ElemData.hpp
- File IonizationData.hpp
- File IsotopeData.hpp
- File IsotopeTable.hpp
- Directory extinct
- File Extinct.hpp
- Directory feedback
- File FeedbackCommons.hpp
- File Winds.hpp
- Directory interpolation
- File Interpolator1D.hpp
- File Mesh2DGrid.hpp
- File Mesh2DInterpolator.hpp
- File Mesh3DInterpolator.hpp
- Directory io
- File OutputManager.hpp
- File OutputManagerAscii.hpp
- File OutputManagerH5.hpp
- File SimControls.hpp
- Directory nebular
- File Nebular.hpp
- File NebularCommons.hpp
- Directory pdfs
- File PDF.hpp
- File PDFCommons.hpp
- File PDFFileParser.hpp
- File PDFReflect.hpp
- File PDFSegment.hpp
- File PDFSegmentDelta.hpp
- File PDFSegmentExponential.hpp
- File PDFSegmentLognormal.hpp
- File PDFSegmentNormal.hpp
- File PDFSegmentPowerlaw.hpp
- File PDFSegmentSchechter.hpp
- Directory phot
- File Filter.hpp
- File FilterCollection.hpp
- File FilterCommons.hpp
- File FilterIdeal.hpp
- File FilterTabulated.hpp
- File PhotCommons.hpp
- File VegaSpectrum.hpp
- Directory specsyn
- File Specsyn.hpp
- File SpecsynBlackbody.hpp
- File SpecsynCommons.hpp
- File SpecsynLib.hpp
- File SpecsynLib2D.hpp
- File SpecsynLibChained.hpp
- File SpecsynLibNoWind.hpp
- File SpecsynLibWD.hpp
- File SpecsynLibWR.hpp
- File SpecsynUtils.hpp
- Directory tracks
- File TrackCommons.hpp
- File Tracks2D.hpp
- File Tracks3D.hpp
- File TrackUtils.hpp
- Directory utils
- File Constants.hpp
- File GKIntegrator.hpp
- File GKIntegratorData.hpp
- File GridBracket.hpp
- File HDF5Utils.hpp
- File MiscUtils.hpp
- File MPIUtils.hpp
- File ParseUtils.hpp
- File PDFIntegrator.hpp
- File RandomDist.hpp
- File RngThread.hpp
- File SigtermGuard.hpp
- File ThreadVec.hpp
- File TOMLUtils.hpp
- File TrackedDeck.hpp
- File UniqueIDManager.hpp
- Directory yields
- File YieldChannel.hpp
- File YieldCommons.hpp
- File Yields.hpp
- Directory core
- Directory src
Full API
Namespaces
Classes and Structs
- Class Cluster
- Class Documentation
core::ClusterSegmentInterp1dPtrTrack2DVarCluster()Cluster()rngState()uid()targetMass()birthMass()formTime()feH()aV()avNeb()starMasses()deadStarMasses()starDeathTimes()deadStarDeathTimes()tracks()spec()specExtinct()phot()photExtinct()specNeb()specNebExtinct()lineLum()lineLumExtinct()photNeb()photNebExtinct()lbol()yields()cumSNe()mDotWind()pDotWind()eDotWind()isDisrupted()advance()
- Class Documentation
- Class Galaxy
- Nested Relationships
- Class Documentation
core::GalaxySFRVarGalaxy()sfr()curTime()clusters()disruptedClusters()fieldStars()deadFieldStars()spec()specExtinct()phot()photExtinct()specNeb()specNebExtinct()lineLum()lineLumExtinct()photNeb()photNebExtinct()lbol()yields()cumSNe()mDotWind()pDotWind()eDotWind()yieldsRate()yieldsRate()continuousDeathQuantity()targetMass()actualMass()advance()core::Galaxy::FieldStarcore::Galaxy::NoDeathRateHook
- Class Mesh2DGrid
- Nested Relationships
- Class Documentation
interp::Mesh2DGridIntersectionTypeArray2DArray1DMesh2DGrid()Mesh2DGrid()~Mesh2DGrid()Mesh2DGrid()Mesh2DGrid()operator=()operator=()size()nx()ny()convex()xData()yData()sData()xMin()xMin()xMax()xMax()yMin()yMax()yLim()yEdgeSlope()contains()xIdx()yIdx()xyIdx()onMesh()xIntersect()xIntersectN()yIntersect()bigNuminterp::Mesh2DGrid::MViewinterp::Mesh2DGrid::SViewinterp::Mesh2DGrid::xIntersectionDescriptorinterp::Mesh2DGrid::XViewinterp::Mesh2DGrid::yIntersectionDescriptor
- Template Class Mesh2DInterpolator
- Class Documentation
interp::Mesh2DInterpolatorArray3DArray2DArray1DMesh2DInterpolator()Mesh2DInterpolator()Mesh2DInterpolator()~Mesh2DInterpolator()Mesh2DInterpolator()Mesh2DInterpolator()operator=()operator=()size()nx()ny()convex()x()y()s()xMin()xMin()xMax()xMax()yMin()yMax()yLim()yEdgeSlope()contains()interpConstX()interpConstY()operator()()
- Class Documentation
- Template Class Mesh3DInterpolator
- Nested Relationships
- Class Documentation
interp::Mesh3DInterpolatorArray4DArray3DArray1DMesh3DInterpolator()Mesh3DInterpolator()~Mesh3DInterpolator()Mesh3DInterpolator()Mesh3DInterpolator()operator=()operator=()size()nx()ny()nz()x()y()z()f()xMin()xMax()yMin()yMax()zMin()zMax()sy()sz()yInterp()zInterp()sliceConstYCopy()sliceConstZCopy()lazySliceConstZ()
- Class OutputManager
- Inheritance Relationships
- Class Documentation
io::OutputManagerOutputManager()~OutputManager()OutputManager()operator=()OutputManager()operator=()writeCluster()writeClusterSpec()writeClusterPhot()writeClusterYields()writeGalaxy()writeGalaxySpec()writeGalaxyPhot()writeGalaxyYields()writeClusterFeedback()writeGalaxyFeedback()checkpoint()restartTrialsDone()restartMaxTrial()notifyEarlyTermination()simControls_currentDateAndTime()currentRngStateString()feedbackRow()feedbackRow()
- Class OutputManagerAscii
- Inheritance Relationships
- Class Documentation
io::OutputManagerAsciiOutputManagerAscii()~OutputManagerAscii()OutputManagerAscii()operator=()OutputManagerAscii()operator=()writeCluster()writeClusterSpec()writeClusterPhot()writeClusterYields()writeGalaxy()writeGalaxySpec()writeGalaxyPhot()writeGalaxyYields()writeClusterFeedback()writeGalaxyFeedback()checkpoint()restartTrialsDone()restartMaxTrial()notifyEarlyTermination()
- Class OutputManagerH5
- Inheritance Relationships
- Class Documentation
io::OutputManagerH5OutputManagerH5()~OutputManagerH5()OutputManagerH5()operator=()OutputManagerH5()operator=()writeCluster()writeClusterSpec()writeClusterPhot()writeClusterYields()writeGalaxy()writeGalaxySpec()writeGalaxyPhot()writeGalaxyYields()writeClusterFeedback()writeGalaxyFeedback()checkpoint()restartTrialsDone()restartMaxTrial()notifyEarlyTermination()
- Class SimControls
- Class Documentation
io::SimControlsOutputModeSimTypeSimControls()SimControls()SimControls()operator=()SimControls()operator=()~SimControls()simType()outputMode()modelName()outDir()verbosity()strictInput()unusedKeys()ignoredKeys()nTrial()outTimes()intRelTol()intAbsTol()intMaxIter()z()checkpointInterval()inputDeckStr()writeCluster()writeClusterSpec()writeClusterPhot()writeGalaxy()writeGalaxySpec()writeGalaxyPhot()writeClusterYields()writeGalaxyYields()writeClusterFeedback()writeGalaxyFeedback()setIntRelTol()setIntAbsTol()setIntMaxIter()setZ()setCheckpointInterval()setModelName()setOutDir()setNTrial()setOutputMode()setVerbosity()setOutTimes()setWriteCluster()setWriteClusterSpec()setWriteClusterPhot()setWriteGalaxy()setWriteGalaxySpec()setWriteGalaxyPhot()setWriteClusterYields()setWriteGalaxyYields()setWriteClusterFeedback()setWriteGalaxyFeedback()setYieldsChannelDecomposed()setNoDecay()setMinIsotopeLifetime()imf()cmf()fehDist()constFeH()sfr()sfrDist()clf()fCluster()tracks()tracks2D()minStochMass()fracStochMass()nonStochIMFMass()specsyn()filters()avDist()avDistField()avNebFac()extinct()yieldChannels()yields()yieldsChannelDecomposed()noDecay()minIsotopeLifetime()snMassLimits()setSNMassLimits()hasSN()hasSN()wrWindModel()setWRWindModel()obWindModel()setOBWindModel()agbWindModel()setAGBWindModel()otherWindModel()setOtherWindModel()winds()nebControls()nebular()computeLbol()setComputeLbol()setIMF()setCMF()setFeH()setAVDist()setAVDistField()setAVNebFac()setCLF()setSFR()setSFRDist()setFCluster()setNebControls()setSpecsyn()setFilters()setTracks()checkTracksCoverFeH()checkTracksCoverIMF()setExtinct()setNebular()setYields()setWinds()checkSpecsynReplacement()checkYieldsReplacement()checkWindsReplacement()setMinStochMass()buildConstantSFR()
- Class Documentation
- Class PDF
- Inheritance Relationships
- Class Documentation
pdfs::PDFPDF()PDF()PDF()~PDF()PDF()operator=()PDF()operator=()valid()getMin()getMax()getWeights()getSampling()setSampling()normalizePDF()normalized()operator()()expectationValue()expectationValue()integral()integral()deltas()draw()draw()drawTarget()seg_wgt_sMin_sMax_method_normalized_
- Class Specsyn
- Inheritance Relationships
- Class Documentation
specsyn::SpecsynSegmentIsochroneStarDataSpecsyn()~Specsyn()Specsyn()Specsyn()operator=()operator=()wl()controls()wlObs()fehMin()fehMax()requestedFehMin()requestedFehMax()loggMin()loggMax()spec()specForce()specForIntegration()spec()specWl()specWlForIntegration()specCts()specCts()specAndLbolCts()intRelTol()intAbsTol()intMaxIter()setRequestedFehRange()controls_wl_describeStar()getSAandLogg()
- Class Yields
- Class Documentation
yields::YieldsArray2DYields()Yields()Yields()operator=()operator=()~Yields()addChannel()addChannel()checkInstalledCoverage()deleteChannel()setChannels()setChannels()rebuildYieldGrid()controls()registryName()yieldChannels()isotopes()skippedIsotopes()requestedIsotopes()requestedFehMin()requestedFehMax()yield()yieldSum()hasYield()hasYield()applyDecay()applyDecay()
- Class Documentation
Enums
- Enum Symbols
- Enum Documentation
SymbolsHHeLiBeBCNOFNeNaMgAlSiPSClArKCaScTiVCrMnFeCoNiCuZnGaGeAsSeBrKrRbSrYZrNbMoTcRuRhPdAgCdInSnSbTeIXeCsBaLaCePrNdPmSmEuGdTbDyHoErTmYbLuHfTaWReOsIrPtAuHgTlPbBiPoAtRnFrRaAcThPaUNpPuAmCmBkCfEsFmMdNoLrRfDbSgBhHsMtDsRgCnNhFlMcLvTsOgnElem
- Enum Documentation