diff --git a/docs/html/annotated.html b/docs/html/annotated.html index 3d6d0d36..ef61ae5f 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -116,23 +116,29 @@ $(function(){initNavTree('annotated.html',''); initResizable(true); });  CFailedToPartitionEngineError  CHashingError  CJacobianError - CNetworkResizedError - CStaleEngineError - CStaleEngineTrigger - Cstate - CStaleJacobianError - CUnableToSetNetworkReactionsError - CUninitializedJacobianError - CUnknownJacobianError - CUtilityError + CMissingBaseReactionErrorException thrown when a required reaction is missing from the underlying database (e.g., REACLIB) + CMissingKeyReactionErrorException thrown when a constructed network fails to include a key reaction required by the policy + CMissingSeedSpeciesErrorException thrown when a required seed species is not found in the initial composition + CNetworkResizedError + CPolicyErrorBase class for all exceptions related to network policy operations + CStaleEngineError + CStaleEngineTrigger + Cstate + CStaleJacobianError + CUnableToSetNetworkReactionsError + CUninitializedJacobianError + CUnknownJacobianError + CUtilityError  Nexpectations  CEngineError  CEngineIndexError  CStaleEngineError  Nio - CMESANetworkFileParserA parser for MESA-format network files - CNetworkFileParserAn abstract base class for network file parsers - CSimpleReactionListFileParserA parser for simple text files containing a list of reactions + Ngen + CPyFunctionDef + CMESANetworkFileParserA parser for MESA-format network files + CNetworkFileParserAn abstract base class for network file parsers + CSimpleReactionListFileParserA parser for simple text files containing a list of reactions  Npartition  Nrecord  CRauscherThielemannPartitionDataRecordPacked binary record of Rauscher-Thielemann partition function data for an isotope @@ -143,97 +149,106 @@ $(function(){initNavTree('annotated.html',''); initResizable(true); });  CIdentifiedIsotope  CInterpolationPoints  CIsotopeData - Nrates - Nweak - CBoundsErrorInfoDetailed bounds information for a BOUNDS_ERROR - CInterpolationErrorInterpolation error with optional per-axis bounds details - CIsotopeGridRegular 2D grid and payloads for a single isotope (A,Z) - CRateDataRowOne row of the unified weak-rate data table for a specific isotope and state - CWeakRateDerivativesPartial derivatives of the log10() fields w.r.t. (T9, log10(rho*Ye)) - CWeakRateInterpolator3D table interpolator for tabulated weak reaction data by isotope - CWeakRatePayloadInterpolated weak-rate payload at a single state - CWeakReactionConcrete Reaction representing a single weak process (beta±, e−/e+ capture) - CAtomicWeakRateCppAD atomic that wraps weak-rate interpolation for AD evaluation - Cconstants - CWeakReactionEntryA single weak-reaction data point (type, state, and log values) - CWeakReactionMapIndex of available weak reactions keyed by species - Nreaclib - CReactionRecord - Nreaction - CLogicalReaclibReactionRepresents a "logical" reaction that aggregates rates from multiple sources - CRateCoefficientSetHolds the seven coefficients for the REACLIB rate equation - CReaclibReaction - CReactionRepresents a single nuclear reaction from a specific data source - CReactionSet - Nscreening - CBareScreeningModelA screening model that applies no screening effect - CIntermediateScreeningModel - CScreeningModelAn abstract base class for plasma screening models - CWeakScreeningModelImplements the weak screening model based on the Debye-Hückel approximation - Nsolver - CCVODESolverStrategyStiff ODE integrator backed by SUNDIALS CVODE (BDF) for network + energy - CCVODEUserDataA helper struct to pass C++ context to C-style CVODE callbacks - CTimestepContextImmutable view of the current integration state passed to callbacks - CNetworkSolverStrategyAbstract base class for network solver strategies - CSolverContextBaseBase class for solver callback contexts - Ntrigger - Nsolver - NCVODE - CConvergenceFailureTrigger - COffDiagonalTriggerTriggers when any off-diagonal Jacobian entry magnitude exceeds a threshold - CSimulationTimeTriggerTriggers when the current simulation time advances by at least a fixed interval - CTimestepCollapseTriggerTriggers when the timestep deviates from its recent average beyond a threshold - CAndTriggerLogical conjunction of two triggers with short-circuit evaluation - CEveryNthTriggerPass-through trigger that fires every Nth time its child trigger is true - CLogicalTrigger - CNotTriggerLogical negation of a trigger - COrTriggerLogical disjunction of two triggers with short-circuit evaluation - CTriggerGeneric trigger interface for signaling events/conditions during integration - CTriggerResult - Nutils - CColumn - CColumnBase - CAdaptiveEngineViewAn engine view that dynamically adapts the reaction network based on runtime conditions - CReactionFlowA struct to hold a reaction and its flow rate - CDefinedEngineView - CDynamicEngineAbstract class for engines supporting Jacobian and stoichiometry operations - CEnergyDerivatives - CEngineAbstract base class for a reaction network engine - CEngineViewAbstract base class for a "view" of a reaction network engine - CFileDefinedEngineView - CGraphEngineA reaction network engine that uses a graph-based representation - CAtomicReverseRate - Cconstants - CPrecomputedReaction - CMultiscalePartitioningEngineViewAn engine view that partitions the reaction network into multiple groups based on timescales - CCacheStatsStruct for tracking cache statistics - CEigenFunctorFunctor for solving QSE abundances using Eigen's nonlinear optimization - CQSEGroupStruct representing a QSE group - CNetIn - CNetOut - CNetwork - CNetworkPrimingEngineViewProvides a view of a DynamicEngine filtered to reactions involving a specified priming species - CPrimingReportCaptures the result of a network priming operation - CQSECacheConfigConfiguration struct for the QSE cache - CQSECacheKeyKey struct for the QSE abundance cache - CReactionRepresents a single nuclear reaction from a specific data source - CReactionSet - CStepDerivativesStructure holding derivatives and energy generation for a network step - NstdSTL namespace - Chash< gridfire::QSECacheKey > - Chash< gridfire::rates::weak::TableAxes > - Chash< gridfire::reaction::Reaction > - Chash< gridfire::reaction::ReactionSet > - CPyDynamicEngine - CPyDynamicEngineView - CPyDynamicNetworkSolverStrategy - CPyEngine - CPyEngineView - CPyNetworkFileParser - CPyPartitionFunction - CPyScreening - CPySolverContextBase - CSolverPluginInterface + Npolicy + CCNOChainPolicyA ReactionChainPolicy for the Carbon-Nitrogen-Oxygen (CNO) cycle + CHotCNOChainPolicyA ReactionChainPolicy for the Hot CNO (HCNO) cycle + CLowMassMainSequencePolicyA NetworkPolicy for building reaction networks suitable for low-mass main-sequence stars + CLowMassMainSequenceReactionChainPolicyA MultiReactionChainPolicy for low-mass main-sequence stars + CMultiReactionChainPolicyA ReactionChainPolicy composed of multiple child ReactionChainPolicy instances + CNetworkPolicyAbstract interface for policies that construct DynamicEngine networks from a seed composition + CProtonProtonChainPolicyA ReactionChainPolicy for the Proton-Proton (PP) chain + CReactionChainPolicyAbstract interface encapsulating a set of reactions representing a single chain or pathway + Nrates + Nweak + CBoundsErrorInfoDetailed bounds information for a BOUNDS_ERROR + CInterpolationErrorInterpolation error with optional per-axis bounds details + CIsotopeGridRegular 2D grid and payloads for a single isotope (A,Z) + CRateDataRowOne row of the unified weak-rate data table for a specific isotope and state + CWeakRateDerivativesPartial derivatives of the log10() fields w.r.t. (T9, log10(rho*Ye)) + CWeakRateInterpolator3D table interpolator for tabulated weak reaction data by isotope + CWeakRatePayloadInterpolated weak-rate payload at a single state + CWeakReactionConcrete Reaction representing a single weak process (beta±, e−/e+ capture) + CAtomicWeakRateCppAD atomic that wraps weak-rate interpolation for AD evaluation + Cconstants + CWeakReactionEntryA single weak-reaction data point (type, state, and log values) + CWeakReactionMapIndex of available weak reactions keyed by species + Nreaclib + CReactionRecord + Nreaction + CLogicalReaclibReactionRepresents a "logical" reaction that aggregates rates from multiple sources + CRateCoefficientSetHolds the seven coefficients for the REACLIB rate equation + CReaclibReaction + CReactionRepresents a single nuclear reaction from a specific data source + CReactionSet + Nscreening + CBareScreeningModelA screening model that applies no screening effect + CIntermediateScreeningModel + CScreeningModelAn abstract base class for plasma screening models + CWeakScreeningModelImplements the weak screening model based on the Debye-Hückel approximation + Nsolver + CCVODESolverStrategyStiff ODE integrator backed by SUNDIALS CVODE (BDF) for network + energy + CCVODEUserDataA helper struct to pass C++ context to C-style CVODE callbacks + CTimestepContextImmutable view of the current integration state passed to callbacks + CNetworkSolverStrategyAbstract base class for network solver strategies + CSolverContextBaseBase class for solver callback contexts + Ntrigger + Nsolver + NCVODE + CConvergenceFailureTrigger + COffDiagonalTriggerTriggers when any off-diagonal Jacobian entry magnitude exceeds a threshold + CSimulationTimeTriggerTriggers when the current simulation time advances by at least a fixed interval + CTimestepCollapseTriggerTriggers when the timestep deviates from its recent average beyond a threshold + CAndTriggerLogical conjunction of two triggers with short-circuit evaluation + CEveryNthTriggerPass-through trigger that fires every Nth time its child trigger is true + CLogicalTrigger + CNotTriggerLogical negation of a trigger + COrTriggerLogical disjunction of two triggers with short-circuit evaluation + CTriggerGeneric trigger interface for signaling events/conditions during integration + CTriggerResult + Nutils + CColumn + CColumnBase + CAdaptiveEngineViewAn engine view that dynamically adapts the reaction network based on runtime conditions + CReactionFlowA struct to hold a reaction and its flow rate + CDefinedEngineView + CDynamicEngineAbstract class for engines supporting Jacobian and stoichiometry operations + CEnergyDerivatives + CEngineAbstract base class for a reaction network engine + CEngineViewAbstract base class for a "view" of a reaction network engine + CFileDefinedEngineView + CGraphEngineA reaction network engine that uses a graph-based representation + CAtomicReverseRate + Cconstants + CPrecomputedReaction + CMultiscalePartitioningEngineViewAn engine view that partitions the reaction network into multiple groups based on timescales + CCacheStatsStruct for tracking cache statistics + CEigenFunctorFunctor for solving QSE abundances using Eigen's nonlinear optimization + CQSEGroupStruct representing a QSE group + CNetIn + CNetOut + CNetwork + CNetworkPrimingEngineViewProvides a view of a DynamicEngine filtered to reactions involving a specified priming species + CPrimingReportCaptures the result of a network priming operation + CQSECacheConfigConfiguration struct for the QSE cache + CQSECacheKeyKey struct for the QSE abundance cache + CReactionRepresents a single nuclear reaction from a specific data source + CReactionSet + CStepDerivativesStructure holding derivatives and energy generation for a network step + NstdSTL namespace + Chash< gridfire::QSECacheKey > + Chash< gridfire::rates::weak::TableAxes > + Chash< gridfire::reaction::Reaction > + Chash< gridfire::reaction::ReactionSet > + CPyDynamicEngine + CPyDynamicEngineView + CPyDynamicNetworkSolverStrategy + CPyEngine + CPyEngineView + CPyNetworkFileParser + CPyPartitionFunction + CPyScreening + CPySolverContextBase + CSolverPluginInterface diff --git a/docs/html/annotated_dup.js b/docs/html/annotated_dup.js index a87446cc..0fd0a3e4 100644 --- a/docs/html/annotated_dup.js +++ b/docs/html/annotated_dup.js @@ -13,7 +13,11 @@ var annotated_dup = [ "FailedToPartitionEngineError", "classgridfire_1_1exceptions_1_1_failed_to_partition_engine_error.html", "classgridfire_1_1exceptions_1_1_failed_to_partition_engine_error" ], [ "HashingError", "classgridfire_1_1exceptions_1_1_hashing_error.html", "classgridfire_1_1exceptions_1_1_hashing_error" ], [ "JacobianError", "classgridfire_1_1exceptions_1_1_jacobian_error.html", null ], + [ "MissingBaseReactionError", "classgridfire_1_1exceptions_1_1_missing_base_reaction_error.html", "classgridfire_1_1exceptions_1_1_missing_base_reaction_error" ], + [ "MissingKeyReactionError", "classgridfire_1_1exceptions_1_1_missing_key_reaction_error.html", "classgridfire_1_1exceptions_1_1_missing_key_reaction_error" ], + [ "MissingSeedSpeciesError", "classgridfire_1_1exceptions_1_1_missing_seed_species_error.html", "classgridfire_1_1exceptions_1_1_missing_seed_species_error" ], [ "NetworkResizedError", "classgridfire_1_1exceptions_1_1_network_resized_error.html", "classgridfire_1_1exceptions_1_1_network_resized_error" ], + [ "PolicyError", "classgridfire_1_1exceptions_1_1_policy_error.html", "classgridfire_1_1exceptions_1_1_policy_error" ], [ "StaleEngineError", "classgridfire_1_1exceptions_1_1_stale_engine_error.html", "classgridfire_1_1exceptions_1_1_stale_engine_error" ], [ "StaleEngineTrigger", "classgridfire_1_1exceptions_1_1_stale_engine_trigger.html", "classgridfire_1_1exceptions_1_1_stale_engine_trigger" ], [ "StaleJacobianError", "classgridfire_1_1exceptions_1_1_stale_jacobian_error.html", "classgridfire_1_1exceptions_1_1_stale_jacobian_error" ], @@ -28,6 +32,9 @@ var annotated_dup = [ "StaleEngineError", "structgridfire_1_1expectations_1_1_stale_engine_error.html", "structgridfire_1_1expectations_1_1_stale_engine_error" ] ] ], [ "io", "namespacegridfire_1_1io.html", [ + [ "gen", "namespacegridfire_1_1io_1_1gen.html", [ + [ "PyFunctionDef", "structgridfire_1_1io_1_1gen_1_1_py_function_def.html", "structgridfire_1_1io_1_1gen_1_1_py_function_def" ] + ] ], [ "MESANetworkFileParser", "classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.html", "classgridfire_1_1io_1_1_m_e_s_a_network_file_parser" ], [ "NetworkFileParser", "classgridfire_1_1io_1_1_network_file_parser.html", "classgridfire_1_1io_1_1_network_file_parser" ], [ "SimpleReactionListFileParser", "classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html", "classgridfire_1_1io_1_1_simple_reaction_list_file_parser" ] @@ -41,6 +48,16 @@ var annotated_dup = [ "PartitionFunction", "classgridfire_1_1partition_1_1_partition_function.html", "classgridfire_1_1partition_1_1_partition_function" ], [ "RauscherThielemannPartitionFunction", "classgridfire_1_1partition_1_1_rauscher_thielemann_partition_function.html", "classgridfire_1_1partition_1_1_rauscher_thielemann_partition_function" ] ] ], + [ "policy", "namespacegridfire_1_1policy.html", [ + [ "CNOChainPolicy", "classgridfire_1_1policy_1_1_c_n_o_chain_policy.html", "classgridfire_1_1policy_1_1_c_n_o_chain_policy" ], + [ "HotCNOChainPolicy", "classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy.html", "classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy" ], + [ "LowMassMainSequencePolicy", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy" ], + [ "LowMassMainSequenceReactionChainPolicy", "classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy.html", "classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy" ], + [ "MultiReactionChainPolicy", "classgridfire_1_1policy_1_1_multi_reaction_chain_policy.html", "classgridfire_1_1policy_1_1_multi_reaction_chain_policy" ], + [ "NetworkPolicy", "classgridfire_1_1policy_1_1_network_policy.html", "classgridfire_1_1policy_1_1_network_policy" ], + [ "ProtonProtonChainPolicy", "classgridfire_1_1policy_1_1_proton_proton_chain_policy.html", "classgridfire_1_1policy_1_1_proton_proton_chain_policy" ], + [ "ReactionChainPolicy", "classgridfire_1_1policy_1_1_reaction_chain_policy.html", "classgridfire_1_1policy_1_1_reaction_chain_policy" ] + ] ], [ "rates", "namespacegridfire_1_1rates.html", [ [ "weak", "namespacegridfire_1_1rates_1_1weak.html", [ [ "BoundsErrorInfo", "structgridfire_1_1rates_1_1weak_1_1_bounds_error_info.html", "structgridfire_1_1rates_1_1weak_1_1_bounds_error_info" ], diff --git a/docs/html/chains_8h.html b/docs/html/chains_8h.html new file mode 100644 index 00000000..a83bb584 --- /dev/null +++ b/docs/html/chains_8h.html @@ -0,0 +1,154 @@ + + + + + + + +GridFire: src/include/gridfire/policy/chains.h File Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+ +
chains.h File Reference
+
+
+ +

Concrete implementations of ReactionChainPolicy for key stellar reaction chains. +More...

+ + + + + + + + + + + + + + +

+Classes

class  gridfire::policy::ProtonProtonChainPolicy
 A ReactionChainPolicy for the Proton-Proton (PP) chain. More...
 
class  gridfire::policy::CNOChainPolicy
 A ReactionChainPolicy for the Carbon-Nitrogen-Oxygen (CNO) cycle. More...
 
class  gridfire::policy::HotCNOChainPolicy
 A ReactionChainPolicy for the Hot CNO (HCNO) cycle. More...
 
class  gridfire::policy::LowMassMainSequenceReactionChainPolicy
 A MultiReactionChainPolicy for low-mass main-sequence stars. More...
 
+ + + + + +

+Namespaces

namespace  gridfire
 
namespace  gridfire::policy
 
+

Detailed Description

+

Concrete implementations of ReactionChainPolicy for key stellar reaction chains.

+

This file provides concrete policies for fundamental nuclear reaction chains, such as the Proton-Proton chain and the CNO cycle. These policies inherit from ReactionChainPolicy (see policy_abstract.h) and provide a pre-defined set of reactions.

+

They are typically used by higher-level NetworkPolicy implementations (e.g., LowMassMainSequencePolicy in stellar_policy.h) to compose a complete set of required reactions for a particular stellar environment.

+
Note
Constructors for these policies may throw gridfire::exceptions::MissingBaseReactionError if a required reaction is not found in the underlying REACLIB database. This usually indicates an issue with the GridFire installation or the bundled reaction data.
+
+
+ + + + diff --git a/docs/html/chains_8h.js b/docs/html/chains_8h.js new file mode 100644 index 00000000..dc82927f --- /dev/null +++ b/docs/html/chains_8h.js @@ -0,0 +1,7 @@ +var chains_8h = +[ + [ "gridfire::policy::ProtonProtonChainPolicy", "classgridfire_1_1policy_1_1_proton_proton_chain_policy.html", "classgridfire_1_1policy_1_1_proton_proton_chain_policy" ], + [ "gridfire::policy::CNOChainPolicy", "classgridfire_1_1policy_1_1_c_n_o_chain_policy.html", "classgridfire_1_1policy_1_1_c_n_o_chain_policy" ], + [ "gridfire::policy::HotCNOChainPolicy", "classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy.html", "classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy" ], + [ "gridfire::policy::LowMassMainSequenceReactionChainPolicy", "classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy.html", "classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy" ] +]; \ No newline at end of file diff --git a/docs/html/classes.html b/docs/html/classes.html index e777c917..f728e1e2 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -112,7 +112,7 @@ $(function(){initNavTree('classes.html',''); initResizable(true); });
BadCollectionError (gridfire::exceptions)
BareScreeningModel (gridfire::screening)
BoundsErrorInfo (gridfire::rates::weak)
C
-
MultiscalePartitioningEngineView::CacheStats (gridfire)
Column (gridfire::utils)
ColumnBase (gridfire::utils)
CompositePartitionFunction (gridfire::partition)
GraphEngine::constants (gridfire)
WeakReaction::constants (gridfire::rates::weak)
ConvergenceFailureTrigger (gridfire::trigger::solver::CVODE)
CVODESolverStrategy (gridfire::solver)
CVODESolverStrategy::CVODEUserData (gridfire::solver)
+
MultiscalePartitioningEngineView::CacheStats (gridfire)
CNOChainPolicy (gridfire::policy)
Column (gridfire::utils)
ColumnBase (gridfire::utils)
CompositePartitionFunction (gridfire::partition)
GraphEngine::constants (gridfire)
WeakReaction::constants (gridfire::rates::weak)
ConvergenceFailureTrigger (gridfire::trigger::solver::CVODE)
CVODESolverStrategy (gridfire::solver)
CVODESolverStrategy::CVODEUserData (gridfire::solver)
D
DefinedEngineView (gridfire)
DynamicEngine (gridfire)
@@ -127,7 +127,7 @@ $(function(){initNavTree('classes.html',''); initResizable(true); });
GraphEngine (gridfire)
GroundStatePartitionFunction (gridfire::partition)
H
-
hash< gridfire::QSECacheKey > (std)
hash< gridfire::rates::weak::TableAxes > (std)
hash< gridfire::reaction::Reaction > (std)
hash< gridfire::reaction::ReactionSet > (std)
HashingError (gridfire::exceptions)
+
hash< gridfire::QSECacheKey > (std)
hash< gridfire::rates::weak::TableAxes > (std)
hash< gridfire::reaction::Reaction > (std)
hash< gridfire::reaction::ReactionSet > (std)
HashingError (gridfire::exceptions)
HotCNOChainPolicy (gridfire::policy)
I
RauscherThielemannPartitionFunction::IdentifiedIsotope (gridfire::partition)
IntermediateScreeningModel (gridfire::screening)
InterpolationError (gridfire::rates::weak)
RauscherThielemannPartitionFunction::InterpolationPoints (gridfire::partition)
RauscherThielemannPartitionFunction::IsotopeData (gridfire::partition)
IsotopeGrid (gridfire::rates::weak)
@@ -136,25 +136,25 @@ $(function(){initNavTree('classes.html',''); initResizable(true); });
Jacobian (gridfire::approx8)
JacobianError (gridfire::exceptions)
L
-
LogicalReaclibReaction (gridfire::reaction)
LogicalTrigger (gridfire::trigger)
+
LogicalReaclibReaction (gridfire::reaction)
LogicalTrigger (gridfire::trigger)
LowMassMainSequencePolicy (gridfire::policy)
LowMassMainSequenceReactionChainPolicy (gridfire::policy)
M
-
MESANetworkFileParser (gridfire::io)
MultiscalePartitioningEngineView (gridfire)
+
MESANetworkFileParser (gridfire::io)
MissingBaseReactionError (gridfire::exceptions)
MissingKeyReactionError (gridfire::exceptions)
MissingSeedSpeciesError (gridfire::exceptions)
MultiReactionChainPolicy (gridfire::policy)
MultiscalePartitioningEngineView (gridfire)
N
-
NetIn (gridfire)
NetOut (gridfire)
Network (gridfire)
NetworkFileParser (gridfire::io)
NetworkPrimingEngineView (gridfire)
NetworkResizedError (gridfire::exceptions)
NetworkSolverStrategy (gridfire::solver)
NotTrigger (gridfire::trigger)
+
NetIn (gridfire)
NetOut (gridfire)
Network (gridfire)
NetworkFileParser (gridfire::io)
NetworkPolicy (gridfire::policy)
NetworkPrimingEngineView (gridfire)
NetworkResizedError (gridfire::exceptions)
NetworkSolverStrategy (gridfire::solver)
NotTrigger (gridfire::trigger)
O
ODE (gridfire::approx8)
OffDiagonalTrigger (gridfire::trigger::solver::CVODE)
OrTrigger (gridfire::trigger)
P
-
PartitionFunction (gridfire::partition)
GraphEngine::PrecomputedReaction (gridfire)
PrimingReport (gridfire)
PyDynamicEngine
PyDynamicEngineView
PyDynamicNetworkSolverStrategy
PyEngine
PyEngineView
PyNetworkFileParser
PyPartitionFunction
PyScreening
PySolverContextBase
+
PartitionFunction (gridfire::partition)
PolicyError (gridfire::exceptions)
GraphEngine::PrecomputedReaction (gridfire)
PrimingReport (gridfire)
ProtonProtonChainPolicy (gridfire::policy)
PyDynamicEngine
PyDynamicEngineView
PyDynamicNetworkSolverStrategy
PyEngine
PyEngineView
PyFunctionDef (gridfire::io::gen)
PyNetworkFileParser
PyPartitionFunction
PyScreening
PySolverContextBase
Q
QSECacheConfig (gridfire)
QSECacheKey (gridfire)
MultiscalePartitioningEngineView::QSEGroup (gridfire)
R
-
RateCoefficientSet (gridfire::reaction)
RateDataRow (gridfire::rates::weak)
RauscherThielemannPartitionDataRecord (gridfire::partition::record)
RauscherThielemannPartitionFunction (gridfire::partition)
ReaclibReaction (gridfire::reaction)
Reaction (gridfire)
Reaction (gridfire::reaction)
AdaptiveEngineView::ReactionFlow (gridfire)
ReactionRecord (gridfire::reaclib)
ReactionSet (gridfire::reaction)
ReactionSet (gridfire)
+
RateCoefficientSet (gridfire::reaction)
RateDataRow (gridfire::rates::weak)
RauscherThielemannPartitionDataRecord (gridfire::partition::record)
RauscherThielemannPartitionFunction (gridfire::partition)
ReaclibReaction (gridfire::reaction)
Reaction (gridfire)
Reaction (gridfire::reaction)
ReactionChainPolicy (gridfire::policy)
AdaptiveEngineView::ReactionFlow (gridfire)
ReactionRecord (gridfire::reaclib)
ReactionSet (gridfire::reaction)
ReactionSet (gridfire)
S
ScreeningModel (gridfire::screening)
SimpleReactionListFileParser (gridfire::io)
SimulationTimeTrigger (gridfire::trigger::solver::CVODE)
SolverContextBase (gridfire::solver)
SolverPluginInterface
StaleEngineError (gridfire::exceptions)
StaleEngineError (gridfire::expectations)
StaleEngineTrigger (gridfire::exceptions)
StaleJacobianError (gridfire::exceptions)
StaleEngineTrigger::state (gridfire::exceptions)
StepDerivatives (gridfire)
diff --git a/docs/html/classgridfire_1_1_reaction-members.html b/docs/html/classgridfire_1_1_reaction-members.html index fea4bfee..6d2c33e8 100644 --- a/docs/html/classgridfire_1_1_reaction-members.html +++ b/docs/html/classgridfire_1_1_reaction-members.html @@ -115,20 +115,21 @@ $(function(){initNavTree('classgridfire_1_1_reaction.html',''); initResizable(tr contains(const fourdst::atomic::Species &species) const=0gridfire::Reactionpure virtual contains_product(const fourdst::atomic::Species &species) const=0gridfire::Reactionpure virtual contains_reactant(const fourdst::atomic::Species &species) const=0gridfire::Reactionpure virtual - hash(uint64_t seed) const=0gridfire::Reactionpure virtual - id() const=0gridfire::Reactionpure virtual - is_reverse() const=0gridfire::Reactionpure virtual - num_species() const=0gridfire::Reactionpure virtual - operator<<(std::ostream &os, const Reaction &r)gridfire::Reactionfriend - product_species() const=0gridfire::Reactionpure virtual - products() const=0gridfire::Reactionpure virtual - qValue() const=0gridfire::Reactionpure virtual - reactant_species() const=0gridfire::Reactionpure virtual - reactants() const=0gridfire::Reactionpure virtual - stoichiometry() const=0gridfire::Reactionpure virtual - stoichiometry(const fourdst::atomic::Species &species) const=0gridfire::Reactionpure virtual - type() const=0gridfire::Reactionpure virtual - ~Reaction()=defaultgridfire::Reactionvirtual + getRateCoefficients() const=0gridfire::Reactionpure virtual + hash(uint64_t seed) const=0gridfire::Reactionpure virtual + id() const=0gridfire::Reactionpure virtual + is_reverse() const=0gridfire::Reactionpure virtual + num_species() const=0gridfire::Reactionpure virtual + operator<<(std::ostream &os, const Reaction &r)gridfire::Reactionfriend + product_species() const=0gridfire::Reactionpure virtual + products() const=0gridfire::Reactionpure virtual + qValue() const=0gridfire::Reactionpure virtual + reactant_species() const=0gridfire::Reactionpure virtual + reactants() const=0gridfire::Reactionpure virtual + stoichiometry() const=0gridfire::Reactionpure virtual + stoichiometry(const fourdst::atomic::Species &species) const=0gridfire::Reactionpure virtual + type() const=0gridfire::Reactionpure virtual + ~Reaction()=defaultgridfire::Reactionvirtual diff --git a/docs/html/classgridfire_1_1_reaction.html b/docs/html/classgridfire_1_1_reaction.html index 151824da..12e63575 100644 --- a/docs/html/classgridfire_1_1_reaction.html +++ b/docs/html/classgridfire_1_1_reaction.html @@ -194,6 +194,8 @@ Public Member Functions virtual std::unique_ptr< Reactionclone () const=0  Polymorphic deep copy.
  +virtual std::optional< std::vector< RateCoefficientSet > > getRateCoefficients () const=0 +  @@ -709,6 +711,31 @@ Friends
Returns
Whether the species is a reactant.
+ + + +

◆ getRateCoefficients()

+ +
+
+

Friends

+ + + + +
+ + + + + + + +
virtual std::optional< std::vector< RateCoefficientSet > > gridfire::reaction::Reaction::getRateCoefficients () const
+
+pure virtual
+
+
diff --git a/docs/html/classgridfire_1_1_reaction.js b/docs/html/classgridfire_1_1_reaction.js index cf46ddd4..0065157c 100644 --- a/docs/html/classgridfire_1_1_reaction.js +++ b/docs/html/classgridfire_1_1_reaction.js @@ -11,6 +11,7 @@ var classgridfire_1_1_reaction = [ "contains", "classgridfire_1_1_reaction.html#adaeb5d72faf7d55d4e26f6e1fcba21c1", null ], [ "contains_product", "classgridfire_1_1_reaction.html#a5a17ca61d069749960e5a83e58c0b8a1", null ], [ "contains_reactant", "classgridfire_1_1_reaction.html#afca3afba45a3db79980c8fe18c87c750", null ], + [ "getRateCoefficients", "classgridfire_1_1_reaction.html#a5580701c64abce60b0253e79ffac3d88", null ], [ "hash", "classgridfire_1_1_reaction.html#a41b1c16f499c9255251ed43725cf698c", null ], [ "id", "classgridfire_1_1_reaction.html#a768329002a4f0b8604b1aa51d56b5d1b", null ], [ "is_reverse", "classgridfire_1_1_reaction.html#a640b0bdbed9ed7c2a2e9880ddbcafc1d", null ], diff --git a/docs/html/classgridfire_1_1_reaction_set-members.html b/docs/html/classgridfire_1_1_reaction_set-members.html index 1056f4d4..1681b615 100644 --- a/docs/html/classgridfire_1_1_reaction_set-members.html +++ b/docs/html/classgridfire_1_1_reaction_set-members.html @@ -118,24 +118,25 @@ $(function(){initNavTree('classgridfire_1_1_reaction_set.html',''); initResizabl end()gridfire::ReactionSetinline end() constgridfire::ReactionSetinline extend(const ReactionSet &other)gridfire::ReactionSet - getReactionSetSpecies() constgridfire::ReactionSet - hash(uint64_t seed) constgridfire::ReactionSet - m_idgridfire::ReactionSetprivate - m_loggergridfire::ReactionSetprivate - m_reactionNameMapgridfire::ReactionSetprivate - m_reactionsgridfire::ReactionSetprivate - operator!=(const ReactionSet &other) constgridfire::ReactionSet - operator<<(std::ostream &os, const ReactionSet &rs)gridfire::ReactionSetfriend - operator=(const ReactionSet &other)gridfire::ReactionSet - operator==(const ReactionSet &other) constgridfire::ReactionSet - operator[](size_t index) constgridfire::ReactionSet - operator[](const std::string_view &id) constgridfire::ReactionSet - ReactionSet(std::vector< std::unique_ptr< Reaction > > &&reactions)gridfire::ReactionSetexplicit - ReactionSet(const std::vector< Reaction * > &reactions)gridfire::ReactionSetexplicit - ReactionSet()gridfire::ReactionSet - ReactionSet(const ReactionSet &other)gridfire::ReactionSet - remove_reaction(const Reaction &reaction)gridfire::ReactionSet - size() constgridfire::ReactionSetinline + get(const std::string_view &id) constgridfire::ReactionSet + getReactionSetSpecies() constgridfire::ReactionSet + hash(uint64_t seed) constgridfire::ReactionSet + m_idgridfire::ReactionSetprivate + m_loggergridfire::ReactionSetprivate + m_reactionNameMapgridfire::ReactionSetprivate + m_reactionsgridfire::ReactionSetprivate + operator!=(const ReactionSet &other) constgridfire::ReactionSet + operator<<(std::ostream &os, const ReactionSet &rs)gridfire::ReactionSetfriend + operator=(const ReactionSet &other)gridfire::ReactionSet + operator==(const ReactionSet &other) constgridfire::ReactionSet + operator[](size_t index) constgridfire::ReactionSet + operator[](const std::string_view &id) constgridfire::ReactionSet + ReactionSet(std::vector< std::unique_ptr< Reaction > > &&reactions)gridfire::ReactionSetexplicit + ReactionSet(const std::vector< Reaction * > &reactions)gridfire::ReactionSetexplicit + ReactionSet()gridfire::ReactionSet + ReactionSet(const ReactionSet &other)gridfire::ReactionSet + remove_reaction(const Reaction &reaction)gridfire::ReactionSet + size() constgridfire::ReactionSetinline diff --git a/docs/html/classgridfire_1_1_reaction_set.html b/docs/html/classgridfire_1_1_reaction_set.html index db77769e..f37501c1 100644 --- a/docs/html/classgridfire_1_1_reaction_set.html +++ b/docs/html/classgridfire_1_1_reaction_set.html @@ -132,6 +132,8 @@ Public Member Functions   void extend (const ReactionSet &other)   +std::optional< std::unique_ptr< Reaction > > get (const std::string_view &id) const +  void remove_reaction (const Reaction &reaction)  Removes a reaction from the set.
  @@ -658,6 +660,31 @@ Friends
+
+ + +

◆ get()

+ +
+
+ + + + + +
+ + + + + + + +
std::optional< std::unique_ptr< Reaction > > gridfire::reaction::ReactionSet::get (const std::string_view & id) const
+
+nodiscard
+
+
diff --git a/docs/html/classgridfire_1_1_reaction_set.js b/docs/html/classgridfire_1_1_reaction_set.js index 90500237..213150e8 100644 --- a/docs/html/classgridfire_1_1_reaction_set.js +++ b/docs/html/classgridfire_1_1_reaction_set.js @@ -17,6 +17,7 @@ var classgridfire_1_1_reaction_set = [ "end", "classgridfire_1_1_reaction_set.html#abae9fbc4b4306479a6cd3173ac628987", null ], [ "end", "classgridfire_1_1_reaction_set.html#a436f9c4b8f8a4e115b19728d57d8e105", null ], [ "extend", "classgridfire_1_1_reaction_set.html#a6a4836776f5dd00158d2336e5bcc3222", null ], + [ "get", "classgridfire_1_1_reaction_set.html#a85314ee0dde7e12915f63237086b5eb6", null ], [ "getReactionSetSpecies", "classgridfire_1_1_reaction_set.html#a133ad8cca6a75d31ef8efe67801aef1b", null ], [ "hash", "classgridfire_1_1_reaction_set.html#ad28907fc08de978461d68cc5b77a3a99", null ], [ "operator!=", "classgridfire_1_1_reaction_set.html#a529189f464aebc6b5ac5c717f70e14b8", null ], diff --git a/docs/html/classgridfire_1_1exceptions_1_1_missing_base_reaction_error-members.html b/docs/html/classgridfire_1_1exceptions_1_1_missing_base_reaction_error-members.html new file mode 100644 index 00000000..fd423551 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1_missing_base_reaction_error-members.html @@ -0,0 +1,121 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::MissingBaseReactionError Member List
+
+
+ +

This is the complete list of members for gridfire::exceptions::MissingBaseReactionError, including all inherited members.

+ + + + + +
m_messagegridfire::exceptions::PolicyErrorprivate
MissingBaseReactionError(const std::string &msg)gridfire::exceptions::MissingBaseReactionErrorinlineexplicit
PolicyError(const std::string &msg)gridfire::exceptions::PolicyErrorinlineexplicit
what() const noexcept overridegridfire::exceptions::PolicyErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1_missing_base_reaction_error.html b/docs/html/classgridfire_1_1exceptions_1_1_missing_base_reaction_error.html new file mode 100644 index 00000000..aaed12e1 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1_missing_base_reaction_error.html @@ -0,0 +1,186 @@ + + + + + + + +GridFire: gridfire::exceptions::MissingBaseReactionError Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+ +
gridfire::exceptions::MissingBaseReactionError Class Referencefinal
+
+
+ +

Exception thrown when a required reaction is missing from the underlying database (e.g., REACLIB). + More...

+ +

#include <error_policy.h>

+
+Inheritance diagram for gridfire::exceptions::MissingBaseReactionError:
+
+
+ + +gridfire::exceptions::PolicyError + +
+ + + + + + + + + + + + +

+Public Member Functions

 MissingBaseReactionError (const std::string &msg)
 Constructs a MissingBaseReactionError with a descriptive message.
 
- Public Member Functions inherited from gridfire::exceptions::PolicyError
 PolicyError (const std::string &msg)
 Constructs a PolicyError with a descriptive message.
 
const char * what () const noexcept override
 Returns the explanatory string.
 
+

Detailed Description

+

Exception thrown when a required reaction is missing from the underlying database (e.g., REACLIB).

+

This typically occurs during the construction of a ReactionChainPolicy if the reaction library used by GridFire does not contain a reaction specified by the policy.

+

Constructor & Destructor Documentation

+ +

◆ MissingBaseReactionError()

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::exceptions::MissingBaseReactionError::MissingBaseReactionError (const std::string & msg)
+
+inlineexplicit
+
+ +

Constructs a MissingBaseReactionError with a descriptive message.

+
Parameters
+ + +
msgThe error message.
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1_missing_base_reaction_error.js b/docs/html/classgridfire_1_1exceptions_1_1_missing_base_reaction_error.js new file mode 100644 index 00000000..4ab2a041 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1_missing_base_reaction_error.js @@ -0,0 +1,4 @@ +var classgridfire_1_1exceptions_1_1_missing_base_reaction_error = +[ + [ "MissingBaseReactionError", "classgridfire_1_1exceptions_1_1_missing_base_reaction_error.html#ad6bfd78cd760c4632a5d2a508d206fb9", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1_missing_base_reaction_error.png b/docs/html/classgridfire_1_1exceptions_1_1_missing_base_reaction_error.png new file mode 100644 index 00000000..3ff2d553 Binary files /dev/null and b/docs/html/classgridfire_1_1exceptions_1_1_missing_base_reaction_error.png differ diff --git a/docs/html/classgridfire_1_1exceptions_1_1_missing_key_reaction_error-members.html b/docs/html/classgridfire_1_1exceptions_1_1_missing_key_reaction_error-members.html new file mode 100644 index 00000000..625ced4c --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1_missing_key_reaction_error-members.html @@ -0,0 +1,121 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::MissingKeyReactionError Member List
+
+
+ +

This is the complete list of members for gridfire::exceptions::MissingKeyReactionError, including all inherited members.

+ + + + + +
m_messagegridfire::exceptions::PolicyErrorprivate
MissingKeyReactionError(const std::string &msg)gridfire::exceptions::MissingKeyReactionErrorinlineexplicit
PolicyError(const std::string &msg)gridfire::exceptions::PolicyErrorinlineexplicit
what() const noexcept overridegridfire::exceptions::PolicyErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1_missing_key_reaction_error.html b/docs/html/classgridfire_1_1exceptions_1_1_missing_key_reaction_error.html new file mode 100644 index 00000000..b467d517 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1_missing_key_reaction_error.html @@ -0,0 +1,186 @@ + + + + + + + +GridFire: gridfire::exceptions::MissingKeyReactionError Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+ +
gridfire::exceptions::MissingKeyReactionError Class Referencefinal
+
+
+ +

Exception thrown when a constructed network fails to include a key reaction required by the policy. + More...

+ +

#include <error_policy.h>

+
+Inheritance diagram for gridfire::exceptions::MissingKeyReactionError:
+
+
+ + +gridfire::exceptions::PolicyError + +
+ + + + + + + + + + + + +

+Public Member Functions

 MissingKeyReactionError (const std::string &msg)
 Constructs a MissingKeyReactionError with a descriptive message.
 
- Public Member Functions inherited from gridfire::exceptions::PolicyError
 PolicyError (const std::string &msg)
 Constructs a PolicyError with a descriptive message.
 
const char * what () const noexcept override
 Returns the explanatory string.
 
+

Detailed Description

+

Exception thrown when a constructed network fails to include a key reaction required by the policy.

+

This error is typically thrown from the construct() method of a NetworkPolicy after the network has been built but fails the final verification step.

+

Constructor & Destructor Documentation

+ +

◆ MissingKeyReactionError()

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::exceptions::MissingKeyReactionError::MissingKeyReactionError (const std::string & msg)
+
+inlineexplicit
+
+ +

Constructs a MissingKeyReactionError with a descriptive message.

+
Parameters
+ + +
msgThe error message.
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1_missing_key_reaction_error.js b/docs/html/classgridfire_1_1exceptions_1_1_missing_key_reaction_error.js new file mode 100644 index 00000000..b7fbcc85 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1_missing_key_reaction_error.js @@ -0,0 +1,4 @@ +var classgridfire_1_1exceptions_1_1_missing_key_reaction_error = +[ + [ "MissingKeyReactionError", "classgridfire_1_1exceptions_1_1_missing_key_reaction_error.html#ab7487832a8f530586a159df774c3ad5d", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1_missing_key_reaction_error.png b/docs/html/classgridfire_1_1exceptions_1_1_missing_key_reaction_error.png new file mode 100644 index 00000000..c06b1662 Binary files /dev/null and b/docs/html/classgridfire_1_1exceptions_1_1_missing_key_reaction_error.png differ diff --git a/docs/html/classgridfire_1_1exceptions_1_1_missing_seed_species_error-members.html b/docs/html/classgridfire_1_1exceptions_1_1_missing_seed_species_error-members.html new file mode 100644 index 00000000..f698891f --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1_missing_seed_species_error-members.html @@ -0,0 +1,121 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::MissingSeedSpeciesError Member List
+
+
+ +

This is the complete list of members for gridfire::exceptions::MissingSeedSpeciesError, including all inherited members.

+ + + + + +
m_messagegridfire::exceptions::PolicyErrorprivate
MissingSeedSpeciesError(const std::string &msg)gridfire::exceptions::MissingSeedSpeciesErrorinlineexplicit
PolicyError(const std::string &msg)gridfire::exceptions::PolicyErrorinlineexplicit
what() const noexcept overridegridfire::exceptions::PolicyErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1_missing_seed_species_error.html b/docs/html/classgridfire_1_1exceptions_1_1_missing_seed_species_error.html new file mode 100644 index 00000000..eb1e5ff9 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1_missing_seed_species_error.html @@ -0,0 +1,186 @@ + + + + + + + +GridFire: gridfire::exceptions::MissingSeedSpeciesError Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+ +
gridfire::exceptions::MissingSeedSpeciesError Class Referencefinal
+
+
+ +

Exception thrown when a required seed species is not found in the initial composition. + More...

+ +

#include <error_policy.h>

+
+Inheritance diagram for gridfire::exceptions::MissingSeedSpeciesError:
+
+
+ + +gridfire::exceptions::PolicyError + +
+ + + + + + + + + + + + +

+Public Member Functions

 MissingSeedSpeciesError (const std::string &msg)
 Constructs a MissingSeedSpeciesError with a descriptive message.
 
- Public Member Functions inherited from gridfire::exceptions::PolicyError
 PolicyError (const std::string &msg)
 Constructs a PolicyError with a descriptive message.
 
const char * what () const noexcept override
 Returns the explanatory string.
 
+

Detailed Description

+

Exception thrown when a required seed species is not found in the initial composition.

+

This error occurs when a NetworkPolicy is initialized with a composition that lacks one or more of the essential species needed to construct the network.

+

Constructor & Destructor Documentation

+ +

◆ MissingSeedSpeciesError()

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::exceptions::MissingSeedSpeciesError::MissingSeedSpeciesError (const std::string & msg)
+
+inlineexplicit
+
+ +

Constructs a MissingSeedSpeciesError with a descriptive message.

+
Parameters
+ + +
msgThe error message.
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1_missing_seed_species_error.js b/docs/html/classgridfire_1_1exceptions_1_1_missing_seed_species_error.js new file mode 100644 index 00000000..05a09d9a --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1_missing_seed_species_error.js @@ -0,0 +1,4 @@ +var classgridfire_1_1exceptions_1_1_missing_seed_species_error = +[ + [ "MissingSeedSpeciesError", "classgridfire_1_1exceptions_1_1_missing_seed_species_error.html#abb0f1caca063a502d9e00167ea5901b0", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1_missing_seed_species_error.png b/docs/html/classgridfire_1_1exceptions_1_1_missing_seed_species_error.png new file mode 100644 index 00000000..6cfe38be Binary files /dev/null and b/docs/html/classgridfire_1_1exceptions_1_1_missing_seed_species_error.png differ diff --git a/docs/html/classgridfire_1_1exceptions_1_1_policy_error-members.html b/docs/html/classgridfire_1_1exceptions_1_1_policy_error-members.html new file mode 100644 index 00000000..f1c38eea --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1_policy_error-members.html @@ -0,0 +1,120 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::PolicyError Member List
+
+
+ +

This is the complete list of members for gridfire::exceptions::PolicyError, including all inherited members.

+ + + + +
m_messagegridfire::exceptions::PolicyErrorprivate
PolicyError(const std::string &msg)gridfire::exceptions::PolicyErrorinlineexplicit
what() const noexcept overridegridfire::exceptions::PolicyErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1_policy_error.html b/docs/html/classgridfire_1_1exceptions_1_1_policy_error.html new file mode 100644 index 00000000..f779c25e --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1_policy_error.html @@ -0,0 +1,242 @@ + + + + + + + +GridFire: gridfire::exceptions::PolicyError Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+ +
gridfire::exceptions::PolicyError Class Reference
+
+
+ +

Base class for all exceptions related to network policy operations. + More...

+ +

#include <error_policy.h>

+
+Inheritance diagram for gridfire::exceptions::PolicyError:
+
+
+ + +gridfire::exceptions::MissingBaseReactionError +gridfire::exceptions::MissingKeyReactionError +gridfire::exceptions::MissingSeedSpeciesError + +
+ + + + + + + + +

+Public Member Functions

 PolicyError (const std::string &msg)
 Constructs a PolicyError with a descriptive message.
 
const char * what () const noexcept override
 Returns the explanatory string.
 
+ + + +

+Private Attributes

std::string m_message
 
+

Detailed Description

+

Base class for all exceptions related to network policy operations.

+

This exception is the parent for more specific policy-related errors. Catching this type will catch any exception originating from the policy system.

+

Constructor & Destructor Documentation

+ +

◆ PolicyError()

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::exceptions::PolicyError::PolicyError (const std::string & msg)
+
+inlineexplicit
+
+ +

Constructs a PolicyError with a descriptive message.

+
Parameters
+ + +
msgThe error message.
+
+
+ +
+
+

Member Function Documentation

+ +

◆ what()

+ +
+
+ + + + + +
+ + + + + + + +
const char * gridfire::exceptions::PolicyError::what () const
+
+inlinenodiscardoverridenoexcept
+
+ +

Returns the explanatory string.

+
Returns
A C-style string with the error message.
+ +
+
+

Member Data Documentation

+ +

◆ m_message

+ +
+
+ + + + + +
+ + + + +
std::string gridfire::exceptions::PolicyError::m_message
+
+private
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1_policy_error.js b/docs/html/classgridfire_1_1exceptions_1_1_policy_error.js new file mode 100644 index 00000000..f74f7088 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1_policy_error.js @@ -0,0 +1,6 @@ +var classgridfire_1_1exceptions_1_1_policy_error = +[ + [ "PolicyError", "classgridfire_1_1exceptions_1_1_policy_error.html#a97d84f2b8e7bf7860ac61ff01f919d39", null ], + [ "what", "classgridfire_1_1exceptions_1_1_policy_error.html#a8f69b68aa7e81088df4d4e51c12c1c89", null ], + [ "m_message", "classgridfire_1_1exceptions_1_1_policy_error.html#a9b7b9f98d295135e35d4bb91d27f5d78", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1_policy_error.png b/docs/html/classgridfire_1_1exceptions_1_1_policy_error.png new file mode 100644 index 00000000..37657527 Binary files /dev/null and b/docs/html/classgridfire_1_1exceptions_1_1_policy_error.png differ diff --git a/docs/html/classgridfire_1_1policy_1_1_c_n_o_chain_policy-members.html b/docs/html/classgridfire_1_1policy_1_1_c_n_o_chain_policy-members.html new file mode 100644 index 00000000..4bfc426e --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_c_n_o_chain_policy-members.html @@ -0,0 +1,122 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::CNOChainPolicy Member List
+
+
+ +

This is the complete list of members for gridfire::policy::CNOChainPolicy, including all inherited members.

+ + + + + + +
CNOChainPolicy()gridfire::policy::CNOChainPolicyinline
get_reactions() const overridegridfire::policy::CNOChainPolicyinlinevirtual
m_reactionIDsgridfire::policy::CNOChainPolicyprivate
m_reactionsgridfire::policy::CNOChainPolicyprivate
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1_c_n_o_chain_policy.html b/docs/html/classgridfire_1_1policy_1_1_c_n_o_chain_policy.html new file mode 100644 index 00000000..06a29775 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_c_n_o_chain_policy.html @@ -0,0 +1,304 @@ + + + + + + + +GridFire: gridfire::policy::CNOChainPolicy Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+ +
gridfire::policy::CNOChainPolicy Class Referencefinal
+
+
+ +

A ReactionChainPolicy for the Carbon-Nitrogen-Oxygen (CNO) cycle. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::CNOChainPolicy:
+
+
+ + +gridfire::policy::ReactionChainPolicy + +
+ + + + + + + + + + + +

+Public Member Functions

 CNOChainPolicy ()
 Constructs the policy and initializes its reaction set from REACLIB.
 
const reaction::ReactionSetget_reactions () const override
 Returns the set of reactions in the CNO cycle.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + +

+Private Attributes

std::set< std::string > m_reactionIDs
 
reaction::ReactionSet m_reactions
 
+

Detailed Description

+

A ReactionChainPolicy for the Carbon-Nitrogen-Oxygen (CNO) cycle.

+

Encapsulates the reactions of the CNO cycle, a catalytic cycle that is the dominant source of energy in massive stars.

+
Exceptions
+ + +
gridfire::exceptions::MissingBaseReactionErrorif a required reaction for the CNO cycle is not found in the REACLIB database during construction.
+
+
+

Constructor & Destructor Documentation

+ +

◆ CNOChainPolicy()

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::policy::CNOChainPolicy::CNOChainPolicy ()
+
+inline
+
+ +

Constructs the policy and initializes its reaction set from REACLIB.

+ +
+
+

Member Function Documentation

+ +

◆ get_reactions()

+ +
+
+ + + + + +
+ + + + + + + +
const reaction::ReactionSet & gridfire::policy::CNOChainPolicy::get_reactions () const
+
+inlinenodiscardoverridevirtual
+
+ +

Returns the set of reactions in the CNO cycle.

+
Returns
const reaction::ReactionSet&
+
Example
CNOChainPolicy cno_policy;
+
const auto& reactions = cno_policy.get_reactions();
+
assert(reactions.contains("c12(p,g)n13"));
+
CNOChainPolicy()
Constructs the policy and initializes its reaction set from REACLIB.
Definition chains.h:233
+
const reaction::ReactionSet & get_reactions() const override
Returns the set of reactions in the CNO cycle.
Definition chains.h:101
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+

Member Data Documentation

+ +

◆ m_reactionIDs

+ +
+
+ + + + + +
+ + + + +
std::set<std::string> gridfire::policy::CNOChainPolicy::m_reactionIDs
+
+private
+
+Initial value:
= {
+
"c12(p,g)n13",
+
"n13(,e+)c13",
+
"c13(p,g)n14",
+
"n14(p,g)o15",
+
"o15(,e+)n15",
+
"n15(p,a)c12",
+
+
"n15(p,g)o16",
+
"o16(p,g)f17",
+
"f17(,e+)o17",
+
"o17(p,a)n14",
+
"n14(p,g)o15",
+
"o15(,e+)n15",
+
+
"o17(p,g)f18",
+
"f18(,e+)o18",
+
"o18(p,a)n15",
+
"n15(p,g)o16",
+
"o16(p,g)f17",
+
"f17(,e+)o17",
+
+
"o18(p,g)f19",
+
"f19(p,a)o16",
+
"o16(p,g)f17",
+
"f17(,e+)o17",
+
"o17(p,g)f18",
+
"f18(,e+)o18"
+
}
+
+
+
+ +

◆ m_reactions

+ +
+
+ + + + + +
+ + + + +
reaction::ReactionSet gridfire::policy::CNOChainPolicy::m_reactions
+
+private
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1_c_n_o_chain_policy.js b/docs/html/classgridfire_1_1policy_1_1_c_n_o_chain_policy.js new file mode 100644 index 00000000..c619a366 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_c_n_o_chain_policy.js @@ -0,0 +1,7 @@ +var classgridfire_1_1policy_1_1_c_n_o_chain_policy = +[ + [ "CNOChainPolicy", "classgridfire_1_1policy_1_1_c_n_o_chain_policy.html#a5a526c6239c3a321c81484061a7a53e4", null ], + [ "get_reactions", "classgridfire_1_1policy_1_1_c_n_o_chain_policy.html#a670c22968a167508f80e7b44f6c06aee", null ], + [ "m_reactionIDs", "classgridfire_1_1policy_1_1_c_n_o_chain_policy.html#aca0ee28b14a65c1145bec367478d8424", null ], + [ "m_reactions", "classgridfire_1_1policy_1_1_c_n_o_chain_policy.html#ab671c885822618749cdfdd8d2aa75333", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1_c_n_o_chain_policy.png b/docs/html/classgridfire_1_1policy_1_1_c_n_o_chain_policy.png new file mode 100644 index 00000000..1b46de07 Binary files /dev/null and b/docs/html/classgridfire_1_1policy_1_1_c_n_o_chain_policy.png differ diff --git a/docs/html/classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy-members.html b/docs/html/classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy-members.html new file mode 100644 index 00000000..3774cfa9 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy-members.html @@ -0,0 +1,122 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::HotCNOChainPolicy Member List
+
+
+ +

This is the complete list of members for gridfire::policy::HotCNOChainPolicy, including all inherited members.

+ + + + + + +
get_reactions() const overridegridfire::policy::HotCNOChainPolicyinlinevirtual
HotCNOChainPolicy()gridfire::policy::HotCNOChainPolicyinline
m_reactionIDsgridfire::policy::HotCNOChainPolicyprivate
m_reactionsgridfire::policy::HotCNOChainPolicyprivate
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy.html b/docs/html/classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy.html new file mode 100644 index 00000000..0bc83468 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy.html @@ -0,0 +1,291 @@ + + + + + + + +GridFire: gridfire::policy::HotCNOChainPolicy Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+ +
gridfire::policy::HotCNOChainPolicy Class Referencefinal
+
+
+ +

A ReactionChainPolicy for the Hot CNO (HCNO) cycle. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::HotCNOChainPolicy:
+
+
+ + +gridfire::policy::ReactionChainPolicy + +
+ + + + + + + + + + + +

+Public Member Functions

 HotCNOChainPolicy ()
 Constructs the policy and initializes its reaction set from REACLIB.
 
const reaction::ReactionSetget_reactions () const override
 Returns the set of reactions in the HCNO cycle.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + +

+Private Attributes

std::set< std::string > m_reactionIDs
 
reaction::ReactionSet m_reactions
 
+

Detailed Description

+

A ReactionChainPolicy for the Hot CNO (HCNO) cycle.

+

Encapsulates the reactions of the HCNO cycle, which becomes significant at higher temperatures and densities than the standard CNO cycle, often in explosive scenarios.

+
Exceptions
+ + +
gridfire::exceptions::MissingBaseReactionErrorif a required reaction for the HCNO cycle is not found in the REACLIB database during construction.
+
+
+

Constructor & Destructor Documentation

+ +

◆ HotCNOChainPolicy()

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::policy::HotCNOChainPolicy::HotCNOChainPolicy ()
+
+inline
+
+ +

Constructs the policy and initializes its reaction set from REACLIB.

+ +
+
+

Member Function Documentation

+ +

◆ get_reactions()

+ +
+
+ + + + + +
+ + + + + + + +
const reaction::ReactionSet & gridfire::policy::HotCNOChainPolicy::get_reactions () const
+
+inlinenodiscardoverridevirtual
+
+ +

Returns the set of reactions in the HCNO cycle.

+
Returns
const reaction::ReactionSet&
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+

Member Data Documentation

+ +

◆ m_reactionIDs

+ +
+
+ + + + + +
+ + + + +
std::set<std::string> gridfire::policy::HotCNOChainPolicy::m_reactionIDs
+
+private
+
+Initial value:
= {
+
"c12(p,g)n13",
+
"n13(p,g)o14",
+
"o14(,e+)n14",
+
"n14(p,g)o15",
+
"o15(,e+)n15",
+
"n15(p,a)c12",
+
+
"n15(p,g)o16",
+
"o16(p,g)f17",
+
"f17(p,g)ne18",
+
"ne18(,e+)f18",
+
"f18(p,a)o15",
+
"o15(,e+)n15",
+
+
"f18(p,g)ne19",
+
"ne19(,e+)f19",
+
"f19(p,a)o16",
+
"o16(p,g)f17",
+
"f17(p,g)ne18",
+
"ne18(,e+)f18"
+
}
+
+
+
+ +

◆ m_reactions

+ +
+
+ + + + + +
+ + + + +
reaction::ReactionSet gridfire::policy::HotCNOChainPolicy::m_reactions
+
+private
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy.js b/docs/html/classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy.js new file mode 100644 index 00000000..6b2fba4a --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy.js @@ -0,0 +1,7 @@ +var classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy = +[ + [ "HotCNOChainPolicy", "classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy.html#ad46d00a57325130798948616acf4c920", null ], + [ "get_reactions", "classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy.html#ae07b692a3b22a805e925f809fec6baaa", null ], + [ "m_reactionIDs", "classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy.html#a97d21edf1e9c9c0228ccc041f6c491e0", null ], + [ "m_reactions", "classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy.html#a34b95a475f456433b9821641c8d69f36", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy.png b/docs/html/classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy.png new file mode 100644 index 00000000..bbfe3e95 Binary files /dev/null and b/docs/html/classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy.png differ diff --git a/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_policy-members.html b/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_policy-members.html new file mode 100644 index 00000000..126f9748 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_policy-members.html @@ -0,0 +1,133 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::LowMassMainSequencePolicy Member List
+
+
+ +

This is the complete list of members for gridfire::policy::LowMassMainSequencePolicy, including all inherited members.

+ + + + + + + + + + + + + + + + + +
build_partition_function()gridfire::policy::LowMassMainSequencePolicyinlineprivatestatic
check_status() constgridfire::policy::LowMassMainSequencePolicyinlineprivate
construct() overridegridfire::policy::LowMassMainSequencePolicyinlinevirtual
get_seed_reactions() const overridegridfire::policy::LowMassMainSequencePolicyinlinevirtual
get_seed_species() const overridegridfire::policy::LowMassMainSequencePolicyinlinevirtual
getStatus() const overridegridfire::policy::LowMassMainSequencePolicyinlinevirtual
LowMassMainSequencePolicy(const fourdst::composition::Composition &composition)gridfire::policy::LowMassMainSequencePolicyinlineexplicit
LowMassMainSequencePolicy(std::vector< fourdst::atomic::Species > seed_species, std::vector< double > mass_fractions)gridfire::policy::LowMassMainSequencePolicyinlineexplicit
m_initializing_compositiongridfire::policy::LowMassMainSequencePolicyprivate
m_network_stackgridfire::policy::LowMassMainSequencePolicyprivate
m_partition_functiongridfire::policy::LowMassMainSequencePolicyprivate
m_reaction_policygridfire::policy::LowMassMainSequencePolicyprivate
m_seed_speciesgridfire::policy::LowMassMainSequencePolicyprivate
m_statusgridfire::policy::LowMassMainSequencePolicyprivate
name() const overridegridfire::policy::LowMassMainSequencePolicyinlinevirtual
~NetworkPolicy()=defaultgridfire::policy::NetworkPolicyvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html b/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html new file mode 100644 index 00000000..62b65f1d --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html @@ -0,0 +1,668 @@ + + + + + + + +GridFire: gridfire::policy::LowMassMainSequencePolicy Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+ +
gridfire::policy::LowMassMainSequencePolicy Class Referencefinal
+
+
+ +

A NetworkPolicy for building reaction networks suitable for low-mass main-sequence stars. + More...

+ +

#include <stellar_policy.h>

+
+Inheritance diagram for gridfire::policy::LowMassMainSequencePolicy:
+
+
+ + +gridfire::policy::NetworkPolicy + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 LowMassMainSequencePolicy (const fourdst::composition::Composition &composition)
 Constructs the policy from an existing composition object.
 
 LowMassMainSequencePolicy (std::vector< fourdst::atomic::Species > seed_species, std::vector< double > mass_fractions)
 Constructs the policy from a list of species and their mass fractions.
 
std::string name () const override
 Returns the name of the policy.
 
const std::set< fourdst::atomic::Species > get_seed_species () const override
 Returns the set of seed species required by this policy.
 
const reaction::ReactionSetget_seed_reactions () const override
 Returns the set of seed reactions required by this policy (from the PP and CNO chains).
 
DynamicEngineconstruct () override
 Constructs and returns the complete, multi-layered dynamic engine.
 
NetworkPolicyStatus getStatus () const override
 Gets the current status of the policy.
 
- Public Member Functions inherited from gridfire::policy::NetworkPolicy
virtual ~NetworkPolicy ()=default
 
+ + + +

+Private Member Functions

NetworkPolicyStatus check_status () const
 
+ + + +

+Static Private Member Functions

static std::unique_ptr< partition::PartitionFunctionbuild_partition_function ()
 
+ + + + + + + + + + + + + +

+Private Attributes

std::set< fourdst::atomic::Species > m_seed_species
 
std::unique_ptr< ReactionChainPolicym_reaction_policy = std::make_unique<LowMassMainSequenceReactionChainPolicy>()
 
fourdst::composition::Composition m_initializing_composition
 
std::unique_ptr< partition::PartitionFunctionm_partition_function
 
std::vector< std::unique_ptr< DynamicEngine > > m_network_stack
 
NetworkPolicyStatus m_status = NetworkPolicyStatus::UNINITIALIZED
 
+

Detailed Description

+

A NetworkPolicy for building reaction networks suitable for low-mass main-sequence stars.

+

This policy ensures that a constructed network contains all necessary species and reactions for modeling the core hydrogen burning phase in low-mass stars, primarily the PP-chain and the CNO-cycle.

+

The construct() method builds a stack of engine views (GraphEngine -> MultiscalePartitioningEngineView -> AdaptiveEngineView) to provide a dynamically adjusting, performance-optimized reaction network.

+

This policy requires the following seed species:

    +
  • H-1
  • +
  • He-3
  • +
  • He-4
  • +
  • C-12
  • +
  • N-14
  • +
  • O-16
  • +
  • Ne-20
  • +
  • Mg-24
  • +
+

This policy composes the ProtonProtonChainPolicy and CNOChainPolicy to define the required reactions.

+

Constructor & Destructor Documentation

+ +

◆ LowMassMainSequencePolicy() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::policy::LowMassMainSequencePolicy::LowMassMainSequencePolicy (const fourdst::composition::Composition & composition)
+
+inlineexplicit
+
+ +

Constructs the policy from an existing composition object.

+
Parameters
+ + +
compositionThe initial composition, which must contain all seed species required by the policy.
+
+
+
Exceptions
+ + +
exceptions::MissingSeedSpeciesErrorif the provided composition is missing a required species.
+
+
+
Example
fourdst::composition::Composition comp;
+
// ... populate composition ...
+ +
LowMassMainSequencePolicy(const fourdst::composition::Composition &composition)
Constructs the policy from an existing composition object.
Definition stellar_policy.h:174
+
Definition chains.h:28
+
+ +
+
+ +

◆ LowMassMainSequencePolicy() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + +
gridfire::policy::LowMassMainSequencePolicy::LowMassMainSequencePolicy (std::vector< fourdst::atomic::Species > seed_species,
std::vector< double > mass_fractions )
+
+inlineexplicit
+
+ +

Constructs the policy from a list of species and their mass fractions.

+
Parameters
+ + + +
seed_speciesA vector of atomic species.
mass_fractionsA vector of corresponding mass fractions.
+
+
+
Exceptions
+ + + +
exceptions::MissingSeedSpeciesErrorif the provided species list is missing a required seed species.
fourdst::composition::exceptions::CompositionNotFinalizedErrorif the internal composition fails to finalize.
+
+
+
Example
using namespace fourdst::atomic;
+
std::vector<Species> species = {H_1, He_4, C_12, O_16};
+
std::vector<double> mass_fractions = {0.7, 0.28, 0.01, 0.01};
+
LowMassMainSequencePolicy policy(species, mass_fractions);
+
+ +
+
+

Member Function Documentation

+ +

◆ build_partition_function()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< partition::PartitionFunction > gridfire::policy::LowMassMainSequencePolicy::build_partition_function ()
+
+inlinestaticprivate
+
+ +
+
+ +

◆ check_status()

+ +
+
+ + + + + +
+ + + + + + + +
NetworkPolicyStatus gridfire::policy::LowMassMainSequencePolicy::check_status () const
+
+inlineprivate
+
+ +
+
+ +

◆ construct()

+ +
+
+ + + + + +
+ + + + + + + +
DynamicEngine & gridfire::policy::LowMassMainSequencePolicy::construct ()
+
+inlineoverridevirtual
+
+ +

Constructs and returns the complete, multi-layered dynamic engine.

+

This method builds the full network engine stack:

    +
  • A base GraphEngine is created with the initial composition. This is constructed three layers deep which is sufficient to capture all required reactions. Further a composite ground state and Rauscher Thielemann partition function is used.
  • +
  • A MultiscalePartitioningEngineView is layered on top for performance optimization. This will put some species into equilibrium groups based on their reaction timescales.
  • +
  • An AdaptiveEngineView is added as the final layer to dynamically cull reaction pathways based on molar reaction flows.
  • +
+

After construction, it verifies that the resulting network meets the policy's requirements.

+
Returns
DynamicEngine& A reference to the top-level AdaptiveEngineView.
+
Exceptions
+ + + + +
exceptions::MissingKeyReactionErrorif the final network is missing a required reaction.
exceptions::MissingSeedSpeciesErrorif the final network is missing a required species.
exceptions::PolicyErroron other verification failures.
+
+
+
Example
LowMassMainSequencePolicy enginePolicy(composition);
+
DynamicEngine& engine = enginePolicy.construct();
+ +
// ... run solver ...
+
Abstract class for engines supporting Jacobian and stoichiometry operations.
Definition engine_abstract.h:143
+
Stiff ODE integrator backed by SUNDIALS CVODE (BDF) for network + energy.
Definition CVODE_solver_strategy.h:81
+
Definition solver.h:12
+
+ +

Implements gridfire::policy::NetworkPolicy.

+ +
+
+ +

◆ get_seed_reactions()

+ +
+
+ + + + + +
+ + + + + + + +
const reaction::ReactionSet & gridfire::policy::LowMassMainSequencePolicy::get_seed_reactions () const
+
+inlinenodiscardoverridevirtual
+
+ +

Returns the set of seed reactions required by this policy (from the PP and CNO chains).

+
Returns
const reaction::ReactionSet&
+ +

Implements gridfire::policy::NetworkPolicy.

+ +
+
+ +

◆ get_seed_species()

+ +
+
+ + + + + +
+ + + + + + + +
const std::set< fourdst::atomic::Species > gridfire::policy::LowMassMainSequencePolicy::get_seed_species () const
+
+inlinenodiscardoverridevirtual
+
+ +

Returns the set of seed species required by this policy.

+
Returns
const std::set<fourdst::atomic::Species>&
+ +

Implements gridfire::policy::NetworkPolicy.

+ +
+
+ +

◆ getStatus()

+ +
+
+ + + + + +
+ + + + + + + +
NetworkPolicyStatus gridfire::policy::LowMassMainSequencePolicy::getStatus () const
+
+inlinenodiscardoverridevirtual
+
+ +

Gets the current status of the policy.

+
Returns
NetworkPolicyStatus The construction and verification status.
+ +

Implements gridfire::policy::NetworkPolicy.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::policy::LowMassMainSequencePolicy::name () const
+
+inlinenodiscardoverridevirtual
+
+ +

Returns the name of the policy.

+
Returns
"LowMassMainSequencePolicy"
+ +

Implements gridfire::policy::NetworkPolicy.

+ +
+
+

Member Data Documentation

+ +

◆ m_initializing_composition

+ +
+
+ + + + + +
+ + + + +
fourdst::composition::Composition gridfire::policy::LowMassMainSequencePolicy::m_initializing_composition
+
+private
+
+ +
+
+ +

◆ m_network_stack

+ +
+
+ + + + + +
+ + + + +
std::vector<std::unique_ptr<DynamicEngine> > gridfire::policy::LowMassMainSequencePolicy::m_network_stack
+
+private
+
+ +
+
+ +

◆ m_partition_function

+ +
+
+ + + + + +
+ + + + +
std::unique_ptr<partition::PartitionFunction> gridfire::policy::LowMassMainSequencePolicy::m_partition_function
+
+private
+
+ +
+
+ +

◆ m_reaction_policy

+ +
+
+ + + + + +
+ + + + +
std::unique_ptr<ReactionChainPolicy> gridfire::policy::LowMassMainSequencePolicy::m_reaction_policy = std::make_unique<LowMassMainSequenceReactionChainPolicy>()
+
+private
+
+ +
+
+ +

◆ m_seed_species

+ +
+
+ + + + + +
+ + + + +
std::set<fourdst::atomic::Species> gridfire::policy::LowMassMainSequencePolicy::m_seed_species
+
+private
+
+Initial value:
= {
+
fourdst::atomic::H_1,
+
fourdst::atomic::He_3,
+
fourdst::atomic::He_4,
+
fourdst::atomic::C_12,
+
fourdst::atomic::N_14,
+
fourdst::atomic::O_16,
+
fourdst::atomic::Ne_20,
+
fourdst::atomic::Mg_24
+
}
+
+
+
+ +

◆ m_status

+ +
+
+ + + + + +
+ + + + +
NetworkPolicyStatus gridfire::policy::LowMassMainSequencePolicy::m_status = NetworkPolicyStatus::UNINITIALIZED
+
+private
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.js b/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.js new file mode 100644 index 00000000..7e1b152a --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.js @@ -0,0 +1,18 @@ +var classgridfire_1_1policy_1_1_low_mass_main_sequence_policy = +[ + [ "LowMassMainSequencePolicy", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html#acc43584af88751fd5414a934d80663df", null ], + [ "LowMassMainSequencePolicy", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html#ad1c9983e84c65a45c0b9629652c49b62", null ], + [ "build_partition_function", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html#a1be0b6a5f6c41651d15538cdaffdda6c", null ], + [ "check_status", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html#aefabc60db9fc1ba957b40e1ef5535e4c", null ], + [ "construct", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html#a839215fa85ba50d3bf79bb04c4a7a000", null ], + [ "get_seed_reactions", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html#a2f1937193a0d5b3cafb93741b09192a4", null ], + [ "get_seed_species", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html#ae9ece10bb091c24224c4b7b7da552274", null ], + [ "getStatus", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html#aea7d8c250d60c371daeada639d14421b", null ], + [ "name", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html#acee26d3bb68a3ba4971f94abf4710f7f", null ], + [ "m_initializing_composition", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html#ad9ca48098514649584a05f28b1a3c12e", null ], + [ "m_network_stack", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html#ab9e4c9ff333e8147d7b844d50154438e", null ], + [ "m_partition_function", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html#adc5d438fff611aa1d246818c5df0d346", null ], + [ "m_reaction_policy", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html#a3100eb24719e50d7b3e35706b0016085", null ], + [ "m_seed_species", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html#ab4707fbad25643ecdd3f0a338ee7df7b", null ], + [ "m_status", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html#a5892e35d7c8b75fd0971c9895a6b5888", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.png b/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.png new file mode 100644 index 00000000..37e517cf Binary files /dev/null and b/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.png differ diff --git a/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy-members.html b/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy-members.html new file mode 100644 index 00000000..293803b1 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy-members.html @@ -0,0 +1,123 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::LowMassMainSequenceReactionChainPolicy Member List
+
+
+ +

This is the complete list of members for gridfire::policy::LowMassMainSequenceReactionChainPolicy, including all inherited members.

+ + + + + + + +
get_chain_policies() const overridegridfire::policy::LowMassMainSequenceReactionChainPolicyinlinevirtual
get_reactions() const overridegridfire::policy::LowMassMainSequenceReactionChainPolicyinlinevirtual
LowMassMainSequenceReactionChainPolicy()gridfire::policy::LowMassMainSequenceReactionChainPolicyinline
m_chain_policiesgridfire::policy::LowMassMainSequenceReactionChainPolicyprivate
m_reactionsgridfire::policy::LowMassMainSequenceReactionChainPolicyprivate
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy.html b/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy.html new file mode 100644 index 00000000..67cec64a --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy.html @@ -0,0 +1,303 @@ + + + + + + + +GridFire: gridfire::policy::LowMassMainSequenceReactionChainPolicy Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+ +
gridfire::policy::LowMassMainSequenceReactionChainPolicy Class Referencefinal
+
+
+ +

A MultiReactionChainPolicy for low-mass main-sequence stars. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::LowMassMainSequenceReactionChainPolicy:
+
+
+ + +gridfire::policy::MultiReactionChainPolicy +gridfire::policy::ReactionChainPolicy + +
+ + + + + + + + + + + + + + +

+Public Member Functions

 LowMassMainSequenceReactionChainPolicy ()
 Constructs the policy and initializes its child policies.
 
const reaction::ReactionSetget_reactions () const override
 Returns the combined set of reactions from all child policies (PP and CNO).
 
const std::vector< std::unique_ptr< ReactionChainPolicy > > & get_chain_policies () const override
 Returns the vector of child policies.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + +

+Private Attributes

std::vector< std::unique_ptr< ReactionChainPolicy > > m_chain_policies
 
reaction::ReactionSet m_reactions
 
+

Detailed Description

+

A MultiReactionChainPolicy for low-mass main-sequence stars.

+

This policy composes the ProtonProtonChainPolicy and CNOChainPolicy to represent the key energy-generating reaction chains active in low-mass stars like the Sun.

+

Constructor & Destructor Documentation

+ +

◆ LowMassMainSequenceReactionChainPolicy()

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::policy::LowMassMainSequenceReactionChainPolicy::LowMassMainSequenceReactionChainPolicy ()
+
+inline
+
+ +

Constructs the policy and initializes its child policies.

+ +
+
+

Member Function Documentation

+ +

◆ get_chain_policies()

+ +
+
+ + + + + +
+ + + + + + + +
const std::vector< std::unique_ptr< ReactionChainPolicy > > & gridfire::policy::LowMassMainSequenceReactionChainPolicy::get_chain_policies () const
+
+inlinenodiscardoverridevirtual
+
+ +

Returns the vector of child policies.

+
Returns
const std::vector<std::unique_ptr<ReactionChainPolicy>>&
+
Example
+
const auto& child_policies = lmms_policy.get_chain_policies();
+
std::cout << "Low-mass policy has " << child_policies.size() << " child policies." << std::endl;
+
const std::vector< std::unique_ptr< ReactionChainPolicy > > & get_chain_policies() const override
Returns the vector of child policies.
Definition chains.h:268
+
LowMassMainSequenceReactionChainPolicy()
Constructs the policy and initializes its child policies.
Definition chains.h:256
+
+ +

Implements gridfire::policy::MultiReactionChainPolicy.

+ +
+
+ +

◆ get_reactions()

+ +
+
+ + + + + +
+ + + + + + + +
const reaction::ReactionSet & gridfire::policy::LowMassMainSequenceReactionChainPolicy::get_reactions () const
+
+inlinenodiscardoverridevirtual
+
+ +

Returns the combined set of reactions from all child policies (PP and CNO).

+
Returns
const reaction::ReactionSet&
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+

Member Data Documentation

+ +

◆ m_chain_policies

+ +
+
+ + + + + +
+ + + + +
std::vector<std::unique_ptr<ReactionChainPolicy> > gridfire::policy::LowMassMainSequenceReactionChainPolicy::m_chain_policies
+
+private
+
+ +
+
+ +

◆ m_reactions

+ +
+
+ + + + + +
+ + + + +
reaction::ReactionSet gridfire::policy::LowMassMainSequenceReactionChainPolicy::m_reactions
+
+private
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy.js b/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy.js new file mode 100644 index 00000000..90f77295 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy.js @@ -0,0 +1,8 @@ +var classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy = +[ + [ "LowMassMainSequenceReactionChainPolicy", "classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy.html#a9ac3c39a2056499b0315ed8946886857", null ], + [ "get_chain_policies", "classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy.html#a464c976671a9885b2cb0e12f499b6486", null ], + [ "get_reactions", "classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy.html#a30dd355b6ef553ea4e978fbc7d19286f", null ], + [ "m_chain_policies", "classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy.html#ad72bbcc9896231e68456c937001e4bde", null ], + [ "m_reactions", "classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy.html#a708f5c77d2fc444464fd80508f659bc4", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy.png b/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy.png new file mode 100644 index 00000000..dba43cf0 Binary files /dev/null and b/docs/html/classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy.png differ diff --git a/docs/html/classgridfire_1_1policy_1_1_multi_reaction_chain_policy-members.html b/docs/html/classgridfire_1_1policy_1_1_multi_reaction_chain_policy-members.html new file mode 100644 index 00000000..355bb16c --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_multi_reaction_chain_policy-members.html @@ -0,0 +1,120 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::MultiReactionChainPolicy Member List
+
+
+ +

This is the complete list of members for gridfire::policy::MultiReactionChainPolicy, including all inherited members.

+ + + + +
get_chain_policies() const =0gridfire::policy::MultiReactionChainPolicypure virtual
get_reactions() const =0gridfire::policy::ReactionChainPolicypure virtual
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1_multi_reaction_chain_policy.html b/docs/html/classgridfire_1_1policy_1_1_multi_reaction_chain_policy.html new file mode 100644 index 00000000..77dead2b --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_multi_reaction_chain_policy.html @@ -0,0 +1,189 @@ + + + + + + + +GridFire: gridfire::policy::MultiReactionChainPolicy Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+ +
gridfire::policy::MultiReactionChainPolicy Class Referenceabstract
+
+
+ +

A ReactionChainPolicy composed of multiple child ReactionChainPolicy instances. + More...

+ +

#include <policy_abstract.h>

+
+Inheritance diagram for gridfire::policy::MultiReactionChainPolicy:
+
+
+ + +gridfire::policy::ReactionChainPolicy +gridfire::policy::LowMassMainSequenceReactionChainPolicy + +
+ + + + + + + + + + + +

+Public Member Functions

virtual const std::vector< std::unique_ptr< ReactionChainPolicy > > & get_chain_policies () const =0
 Returns the vector of child ReactionChainPolicy instances.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
virtual const reaction::ReactionSetget_reactions () const =0
 Returns the ReactionSet describing this chain.
 
+

Detailed Description

+

A ReactionChainPolicy composed of multiple child ReactionChainPolicy instances.

+

Useful for policies that represent a union of several reaction chains (for example the LowMassMainSequenceReactionChainPolicy composes the proton-proton and CNO chains).

+
Example
+
const auto &chains = multi.get_chain_policies();
+
for (const auto &ch : chains) { std::cout << ch->get_reactions().size() << " reactions\n"; }
+
A MultiReactionChainPolicy for low-mass main-sequence stars.
Definition chains.h:190
+
const std::vector< std::unique_ptr< ReactionChainPolicy > > & get_chain_policies() const override
Returns the vector of child policies.
Definition chains.h:268
+
+

Member Function Documentation

+ +

◆ get_chain_policies()

+ +
+
+ + + + + +
+ + + + + + + +
virtual const std::vector< std::unique_ptr< ReactionChainPolicy > > & gridfire::policy::MultiReactionChainPolicy::get_chain_policies () const
+
+nodiscardpure virtual
+
+ +

Returns the vector of child ReactionChainPolicy instances.

+
Returns
const std::vector<std::unique_ptr<ReactionChainPolicy>>&
+ +

Implemented in gridfire::policy::LowMassMainSequenceReactionChainPolicy.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1_multi_reaction_chain_policy.js b/docs/html/classgridfire_1_1policy_1_1_multi_reaction_chain_policy.js new file mode 100644 index 00000000..04802ff6 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_multi_reaction_chain_policy.js @@ -0,0 +1,4 @@ +var classgridfire_1_1policy_1_1_multi_reaction_chain_policy = +[ + [ "get_chain_policies", "classgridfire_1_1policy_1_1_multi_reaction_chain_policy.html#aa0b3581eadfa1eaa06b586e5762d2ce8", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1_multi_reaction_chain_policy.png b/docs/html/classgridfire_1_1policy_1_1_multi_reaction_chain_policy.png new file mode 100644 index 00000000..5339eacd Binary files /dev/null and b/docs/html/classgridfire_1_1policy_1_1_multi_reaction_chain_policy.png differ diff --git a/docs/html/classgridfire_1_1policy_1_1_network_policy-members.html b/docs/html/classgridfire_1_1policy_1_1_network_policy-members.html new file mode 100644 index 00000000..49bdd40f --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_network_policy-members.html @@ -0,0 +1,123 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::NetworkPolicy Member List
+
+
+ +

This is the complete list of members for gridfire::policy::NetworkPolicy, including all inherited members.

+ + + + + + + +
construct()=0gridfire::policy::NetworkPolicypure virtual
get_seed_reactions() const =0gridfire::policy::NetworkPolicypure virtual
get_seed_species() const =0gridfire::policy::NetworkPolicypure virtual
getStatus() const =0gridfire::policy::NetworkPolicypure virtual
name() const =0gridfire::policy::NetworkPolicypure virtual
~NetworkPolicy()=defaultgridfire::policy::NetworkPolicyvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1_network_policy.html b/docs/html/classgridfire_1_1policy_1_1_network_policy.html new file mode 100644 index 00000000..4b80355e --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_network_policy.html @@ -0,0 +1,384 @@ + + + + + + + +GridFire: gridfire::policy::NetworkPolicy Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+ +
gridfire::policy::NetworkPolicy Class Referenceabstract
+
+
+ +

Abstract interface for policies that construct DynamicEngine networks from a seed composition. + More...

+ +

#include <policy_abstract.h>

+
+Inheritance diagram for gridfire::policy::NetworkPolicy:
+
+
+ + +gridfire::policy::LowMassMainSequencePolicy + +
+ + + + + + + + + + + + + + + + + + + +

+Public Member Functions

virtual ~NetworkPolicy ()=default
 
virtual std::string name () const =0
 Human-readable name for the policy.
 
virtual const std::set< fourdst::atomic::Species > get_seed_species () const =0
 Returns the seed species the policy requires to initialize the network.
 
virtual const reaction::ReactionSetget_seed_reactions () const =0
 Returns the set of seed reactions the policy requires.
 
virtual DynamicEngineconstruct ()=0
 Construct and return a DynamicEngine instance (or engine view stack) satisfying the policy.
 
virtual NetworkPolicyStatus getStatus () const =0
 Returns the current verification/construction status of the policy.
 
+

Detailed Description

+

Abstract interface for policies that construct DynamicEngine networks from a seed composition.

+

A NetworkPolicy provides three main pieces of information:

    +
  • A name identifying the policy.
  • +
  • A set of seed species and seed reactions required to initialize the network.
  • +
  • A constructor method that returns a fully constructed DynamicEngine (or view stack) built to satisfy the policy.
  • +
+

Concrete implementations include LowMassMainSequencePolicy (see stellar_policy.h) and may throw policy-specific exceptions during construction (for example when required reactions or species are missing).

+
Example
// Example usage (see tests/graphnet_sandbox/main.cpp for a complete example):
+
// fourdst::composition::Composition comp = prepared composition
+
// gridfire::policy::LowMassMainSequencePolicy policy(comp);
+
// // construct() returns a reference to a DynamicEngine (could be a view stack)
+
// DynamicEngine &engine = policy.construct();
+
// // engine can now be passed to a solver (e.g. CVODESolverStrategy)
+
+

Constructor & Destructor Documentation

+ +

◆ ~NetworkPolicy()

+ +
+
+ + + + + +
+ + + + + + + +
virtual gridfire::policy::NetworkPolicy::~NetworkPolicy ()
+
+virtualdefault
+
+ +
+
+

Member Function Documentation

+ +

◆ construct()

+ +
+
+ + + + + +
+ + + + + + + +
virtual DynamicEngine & gridfire::policy::NetworkPolicy::construct ()
+
+nodiscardpure virtual
+
+ +

Construct and return a DynamicEngine instance (or engine view stack) satisfying the policy.

+

Implementations typically build one or more engine layers (GraphEngine, MultiscalePartitioningEngineView, AdaptiveEngineView, etc.) and return a reference to the top-most DynamicEngine. The storage lifetime of the returned reference is implementation-defined (usually owned by the policy instance).

+
Returns
DynamicEngine& reference to a running/constructed engine ready for solver consumption.
+
Exceptions
+ + + + +
gridfire::exceptions::MissingKeyReactionErrorif required reactions are not present in the constructed network (see gridfire/exceptions/error_policy.h).
gridfire::exceptions::MissingSeedSpeciesErrorif required seed species are missing from the initializing composition.
gridfire::exceptions::PolicyErrorfor other construction/verification failures.
+
+
+
Example
DynamicEngine &engine = policy.construct();
+ +
NetOut out = solver.evaluate(netIn, true);
+
Abstract class for engines supporting Jacobian and stoichiometry operations.
Definition engine_abstract.h:143
+
Stiff ODE integrator backed by SUNDIALS CVODE (BDF) for network + energy.
Definition CVODE_solver_strategy.h:81
+
Definition chains.h:28
+
Definition solver.h:12
+
Definition network.h:63
+
+ +

Implemented in gridfire::policy::LowMassMainSequencePolicy.

+ +
+
+ +

◆ get_seed_reactions()

+ +
+
+ + + + + +
+ + + + + + + +
virtual const reaction::ReactionSet & gridfire::policy::NetworkPolicy::get_seed_reactions () const
+
+nodiscardpure virtual
+
+ +

Returns the set of seed reactions the policy requires.

+

The ReactionSet describes reactions that must be present in the constructed network for the policy to be considered satisfied. Concrete policies often implement their reaction requirements by composing one or more ReactionChainPolicy instances (see chains.h).

+
Example
const reaction::ReactionSet &reacs = policy.get_seed_reactions();
+
// inspect reaction IDs or count
+
std::cout << "Policy requires " << reacs.size() << " reactions" << std::endl;
+
Definition reaction.h:756
+
size_t size() const
Gets the number of reactions in the set.
Definition reaction.h:817
+
+ +

Implemented in gridfire::policy::LowMassMainSequencePolicy.

+ +
+
+ +

◆ get_seed_species()

+ +
+
+ + + + + +
+ + + + + + + +
virtual const std::set< fourdst::atomic::Species > gridfire::policy::NetworkPolicy::get_seed_species () const
+
+nodiscardpure virtual
+
+ +

Returns the seed species the policy requires to initialize the network.

+

The returned set contains atomic species identifiers (fourdst::atomic::Species) which the policy expects to be present in the initial composition used to build the network.

+

Implementations should return a copy or an immutable reference to their internal set of required seed species.

+
Example
const auto seeds = policy.get_seed_species();
+
for (const auto &s : seeds) { std::cout << s.name() << std::endl; }
+
+ +

Implemented in gridfire::policy::LowMassMainSequencePolicy.

+ +
+
+ +

◆ getStatus()

+ +
+
+ + + + + +
+ + + + + + + +
virtual NetworkPolicyStatus gridfire::policy::NetworkPolicy::getStatus () const
+
+nodiscardpure virtual
+
+ +

Returns the current verification/construction status of the policy.

+

The status reports whether the policy has been initialized and whether the constructed network satisfies the policy's key requirements.

+
Example
NetworkPolicyStatus s = policy.getStatus();
+
if (s != NetworkPolicyStatus::INITIALIZED_VERIFIED) { // handle error }
+
NetworkPolicyStatus
Lifecycle/verification status for a NetworkPolicy instance.
Definition policy_abstract.h:42
+
@ INITIALIZED_VERIFIED
Definition policy_abstract.h:47
+
+ +

Implemented in gridfire::policy::LowMassMainSequencePolicy.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::string gridfire::policy::NetworkPolicy::name () const
+
+nodiscardpure virtual
+
+ +

Human-readable name for the policy.

+
Returns
a std::string identifying the policy implementation (e.g. "LowMassMainSequencePolicy").
+
Example
std::string n = policy.name();
+
std::cout << "Using policy: " << n << std::endl;
+
+ +

Implemented in gridfire::policy::LowMassMainSequencePolicy.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1_network_policy.js b/docs/html/classgridfire_1_1policy_1_1_network_policy.js new file mode 100644 index 00000000..06233e16 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_network_policy.js @@ -0,0 +1,9 @@ +var classgridfire_1_1policy_1_1_network_policy = +[ + [ "~NetworkPolicy", "classgridfire_1_1policy_1_1_network_policy.html#a0d32c22a2d3794c328e8dd24d2cda2be", null ], + [ "construct", "classgridfire_1_1policy_1_1_network_policy.html#af0e40382c7ad71892c1ed453a721ff71", null ], + [ "get_seed_reactions", "classgridfire_1_1policy_1_1_network_policy.html#aa33fcee020f5acd8e14aadaf3758ad2f", null ], + [ "get_seed_species", "classgridfire_1_1policy_1_1_network_policy.html#a724d71e9ce168d528d080017cfefcbc4", null ], + [ "getStatus", "classgridfire_1_1policy_1_1_network_policy.html#a22105519f14ce382dc5404c26b63e723", null ], + [ "name", "classgridfire_1_1policy_1_1_network_policy.html#aa59c1baf7077a5d35d45ff753b32a565", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1_network_policy.png b/docs/html/classgridfire_1_1policy_1_1_network_policy.png new file mode 100644 index 00000000..e5c09904 Binary files /dev/null and b/docs/html/classgridfire_1_1policy_1_1_network_policy.png differ diff --git a/docs/html/classgridfire_1_1policy_1_1_proton_proton_chain_policy-members.html b/docs/html/classgridfire_1_1policy_1_1_proton_proton_chain_policy-members.html new file mode 100644 index 00000000..eacf5ad7 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_proton_proton_chain_policy-members.html @@ -0,0 +1,122 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::ProtonProtonChainPolicy Member List
+
+
+ +

This is the complete list of members for gridfire::policy::ProtonProtonChainPolicy, including all inherited members.

+ + + + + + +
get_reactions() const overridegridfire::policy::ProtonProtonChainPolicyinlinevirtual
m_reactionIDsgridfire::policy::ProtonProtonChainPolicyprivate
m_reactionsgridfire::policy::ProtonProtonChainPolicyprivate
ProtonProtonChainPolicy()gridfire::policy::ProtonProtonChainPolicyinline
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1_proton_proton_chain_policy.html b/docs/html/classgridfire_1_1policy_1_1_proton_proton_chain_policy.html new file mode 100644 index 00000000..6681e791 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_proton_proton_chain_policy.html @@ -0,0 +1,287 @@ + + + + + + + +GridFire: gridfire::policy::ProtonProtonChainPolicy Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+ +
gridfire::policy::ProtonProtonChainPolicy Class Referencefinal
+
+
+ +

A ReactionChainPolicy for the Proton-Proton (PP) chain. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::ProtonProtonChainPolicy:
+
+
+ + +gridfire::policy::ReactionChainPolicy + +
+ + + + + + + + + + + +

+Public Member Functions

 ProtonProtonChainPolicy ()
 Constructs the policy and initializes its reaction set from REACLIB.
 
const reaction::ReactionSetget_reactions () const override
 Returns the set of reactions in the PP chain.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + +

+Private Attributes

std::vector< std::string > m_reactionIDs
 
reaction::ReactionSet m_reactions
 
+

Detailed Description

+

A ReactionChainPolicy for the Proton-Proton (PP) chain.

+

Encapsulates the set of reactions that constitute the three branches of the PP chain, which is the primary energy generation mechanism in stars like the Sun.

+
Exceptions
+ + +
gridfire::exceptions::MissingBaseReactionErrorif a required reaction for the PP chain is not found in the REACLIB database during construction.
+
+
+

Constructor & Destructor Documentation

+ +

◆ ProtonProtonChainPolicy()

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::policy::ProtonProtonChainPolicy::ProtonProtonChainPolicy ()
+
+inline
+
+ +

Constructs the policy and initializes its reaction set from REACLIB.

+ +
+
+

Member Function Documentation

+ +

◆ get_reactions()

+ +
+
+ + + + + +
+ + + + + + + +
const reaction::ReactionSet & gridfire::policy::ProtonProtonChainPolicy::get_reactions () const
+
+inlinenodiscardoverridevirtual
+
+ +

Returns the set of reactions in the PP chain.

+
Returns
const reaction::ReactionSet&
+
Example
+
const auto& reactions = pp_policy.get_reactions();
+
std::cout << "PP chain has " << reactions.size() << " reactions." << std::endl;
+
ProtonProtonChainPolicy()
Constructs the policy and initializes its reaction set from REACLIB.
Definition chains.h:221
+
const reaction::ReactionSet & get_reactions() const override
Returns the set of reactions in the PP chain.
Definition chains.h:58
+
size_t size() const
Gets the number of reactions in the set.
Definition reaction.h:817
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+

Member Data Documentation

+ +

◆ m_reactionIDs

+ +
+
+ + + + + +
+ + + + +
std::vector<std::string> gridfire::policy::ProtonProtonChainPolicy::m_reactionIDs
+
+private
+
+Initial value:
= {
+
"p(p,e+)d",
+
"d(p,g)he3",
+
"he3(he3,2p)he4",
+
"he4(he3,g)be7",
+
"be7(e-,)li7",
+
"li7(p,a)he4",
+
"be7(p,g)b8",
+
"b8(,e+)be8",
+
"be8(,a)he4"
+
}
+
+
+
+ +

◆ m_reactions

+ +
+
+ + + + + +
+ + + + +
reaction::ReactionSet gridfire::policy::ProtonProtonChainPolicy::m_reactions
+
+private
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1_proton_proton_chain_policy.js b/docs/html/classgridfire_1_1policy_1_1_proton_proton_chain_policy.js new file mode 100644 index 00000000..13aa9a92 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_proton_proton_chain_policy.js @@ -0,0 +1,7 @@ +var classgridfire_1_1policy_1_1_proton_proton_chain_policy = +[ + [ "ProtonProtonChainPolicy", "classgridfire_1_1policy_1_1_proton_proton_chain_policy.html#a0700dc96acfae24b242e5556a1bcbf26", null ], + [ "get_reactions", "classgridfire_1_1policy_1_1_proton_proton_chain_policy.html#a3c91d407767a8cb9bc1cc724996e40cd", null ], + [ "m_reactionIDs", "classgridfire_1_1policy_1_1_proton_proton_chain_policy.html#aafd344c915b625bcbc5bb6bee01a192a", null ], + [ "m_reactions", "classgridfire_1_1policy_1_1_proton_proton_chain_policy.html#ae85dfe8b8edf66dac2bcf0376d3e9fb6", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1_proton_proton_chain_policy.png b/docs/html/classgridfire_1_1policy_1_1_proton_proton_chain_policy.png new file mode 100644 index 00000000..98cd0277 Binary files /dev/null and b/docs/html/classgridfire_1_1policy_1_1_proton_proton_chain_policy.png differ diff --git a/docs/html/classgridfire_1_1policy_1_1_reaction_chain_policy-members.html b/docs/html/classgridfire_1_1policy_1_1_reaction_chain_policy-members.html new file mode 100644 index 00000000..6dc7e4d2 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_reaction_chain_policy-members.html @@ -0,0 +1,119 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::ReactionChainPolicy Member List
+
+
+ +

This is the complete list of members for gridfire::policy::ReactionChainPolicy, including all inherited members.

+ + + +
get_reactions() const =0gridfire::policy::ReactionChainPolicypure virtual
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1_reaction_chain_policy.html b/docs/html/classgridfire_1_1policy_1_1_reaction_chain_policy.html new file mode 100644 index 00000000..cfea4c2f --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_reaction_chain_policy.html @@ -0,0 +1,225 @@ + + + + + + + +GridFire: gridfire::policy::ReactionChainPolicy Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+ +
gridfire::policy::ReactionChainPolicy Class Referenceabstract
+
+
+ +

Abstract interface encapsulating a set of reactions representing a single chain or pathway. + More...

+ +

#include <policy_abstract.h>

+
+Inheritance diagram for gridfire::policy::ReactionChainPolicy:
+
+
+ + +gridfire::policy::CNOChainPolicy +gridfire::policy::HotCNOChainPolicy +gridfire::policy::MultiReactionChainPolicy +gridfire::policy::ProtonProtonChainPolicy +gridfire::policy::LowMassMainSequenceReactionChainPolicy + +
+ + + + + + + +

+Public Member Functions

virtual ~ReactionChainPolicy ()=default
 
virtual const reaction::ReactionSetget_reactions () const =0
 Returns the ReactionSet describing this chain.
 
+

Detailed Description

+

Abstract interface encapsulating a set of reactions representing a single chain or pathway.

+

ReactionChainPolicy implementations (see chains.h) supply a ReactionSet describing the reactions that comprise a nuclear reaction chain (for example the proton-proton chain, CNO cycle, etc.).

+
Example
+
const auto &reacs = pp.get_reactions();
+
A ReactionChainPolicy for the Proton-Proton (PP) chain.
Definition chains.h:40
+
const reaction::ReactionSet & get_reactions() const override
Returns the set of reactions in the PP chain.
Definition chains.h:58
+
+
Note
Concrete implementations may throw exceptions on construction if the underlying reaction database (e.g. REACLIB) does not include requested reactions. See chains.h for details.
+

Constructor & Destructor Documentation

+ +

◆ ~ReactionChainPolicy()

+ +
+
+ + + + + +
+ + + + + + + +
virtual gridfire::policy::ReactionChainPolicy::~ReactionChainPolicy ()
+
+virtualdefault
+
+ +
+
+

Member Function Documentation

+ +

◆ get_reactions()

+ +
+
+ + + + + +
+ + + + + + + +
virtual const reaction::ReactionSet & gridfire::policy::ReactionChainPolicy::get_reactions () const
+
+nodiscardpure virtual
+
+ +

Returns the ReactionSet describing this chain.

+
Returns
const reaction::ReactionSet& reference to the chain's reactions.
+
Example
const reaction::ReactionSet &set = chainPolicy.get_reactions();
+
std::cout << "Chain contains " << set.size() << " reactions\n";
+
Definition reaction.h:756
+
size_t size() const
Gets the number of reactions in the set.
Definition reaction.h:817
+
+
Exceptions
+ + +
gridfire::exceptions::MissingBaseReactionErrormay be thrown by concrete implementations at construction time if the required reactions cannot be found in the base reaction set.
+
+
+ +

Implemented in gridfire::policy::CNOChainPolicy, gridfire::policy::HotCNOChainPolicy, gridfire::policy::LowMassMainSequenceReactionChainPolicy, and gridfire::policy::ProtonProtonChainPolicy.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1_reaction_chain_policy.js b/docs/html/classgridfire_1_1policy_1_1_reaction_chain_policy.js new file mode 100644 index 00000000..495e392b --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1_reaction_chain_policy.js @@ -0,0 +1,5 @@ +var classgridfire_1_1policy_1_1_reaction_chain_policy = +[ + [ "~ReactionChainPolicy", "classgridfire_1_1policy_1_1_reaction_chain_policy.html#aa3e6c1e4844fe788aeb08d272070ae13", null ], + [ "get_reactions", "classgridfire_1_1policy_1_1_reaction_chain_policy.html#ad8bccf78e7fc99d08387aec5015e8849", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1_reaction_chain_policy.png b/docs/html/classgridfire_1_1policy_1_1_reaction_chain_policy.png new file mode 100644 index 00000000..e34140ef Binary files /dev/null and b/docs/html/classgridfire_1_1policy_1_1_reaction_chain_policy.png differ diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction-members.html b/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction-members.html index 7e54ccd9..94c66eff 100644 --- a/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction-members.html +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction-members.html @@ -118,34 +118,35 @@ $(function(){initNavTree('classgridfire_1_1rates_1_1weak_1_1_weak_reaction.html' contains_reactant(const fourdst::atomic::Species &species) const overridegridfire::rates::weak::WeakReactionvirtual get_log_neutrino_loss_from_payload(const WeakRatePayload &payload) constgridfire::rates::weak::WeakReactionprivate get_log_rate_from_payload(const WeakRatePayload &payload) constgridfire::rates::weak::WeakReactionprivate - getWeakRateInterpolator() constgridfire::rates::weak::WeakReaction - hash(uint64_t seed) const overridegridfire::rates::weak::WeakReactionvirtual - id() const overridegridfire::rates::weak::WeakReactionvirtual - is_reverse() const overridegridfire::rates::weak::WeakReactionvirtual - m_atomicgridfire::rates::weak::WeakReactionmutableprivate - m_constantsgridfire::rates::weak::WeakReactionprivate - m_idgridfire::rates::weak::WeakReactionprivate - m_interpolatorgridfire::rates::weak::WeakReactionprivate - m_productgridfire::rates::weak::WeakReactionprivate - m_product_agridfire::rates::weak::WeakReactionprivate - m_product_zgridfire::rates::weak::WeakReactionprivate - m_productsgridfire::rates::weak::WeakReactionprivate - m_reactantgridfire::rates::weak::WeakReactionprivate - m_reactant_agridfire::rates::weak::WeakReactionprivate - m_reactant_zgridfire::rates::weak::WeakReactionprivate - m_reactantsgridfire::rates::weak::WeakReactionprivate - m_typegridfire::rates::weak::WeakReactionprivate - num_species() const overridegridfire::rates::weak::WeakReactionvirtual - product_species() const overridegridfire::rates::weak::WeakReactionvirtual - products() const overridegridfire::rates::weak::WeakReactionvirtual - qValue() const overridegridfire::rates::weak::WeakReactionvirtual - reactant_species() const overridegridfire::rates::weak::WeakReactionvirtual - reactants() const overridegridfire::rates::weak::WeakReactionvirtual - stoichiometry() const overridegridfire::rates::weak::WeakReactionvirtual - stoichiometry(const fourdst::atomic::Species &species) const overridegridfire::rates::weak::WeakReactionvirtual - type() const overridegridfire::rates::weak::WeakReactionvirtual - WeakReaction(const fourdst::atomic::Species &species, WeakReactionType type, const WeakRateInterpolator &interpolator)gridfire::rates::weak::WeakReactionexplicit - ~Reaction()=defaultgridfire::reaction::Reactionvirtual + getRateCoefficients() const overridegridfire::rates::weak::WeakReactioninlinevirtual + getWeakRateInterpolator() constgridfire::rates::weak::WeakReaction + hash(uint64_t seed) const overridegridfire::rates::weak::WeakReactionvirtual + id() const overridegridfire::rates::weak::WeakReactionvirtual + is_reverse() const overridegridfire::rates::weak::WeakReactionvirtual + m_atomicgridfire::rates::weak::WeakReactionmutableprivate + m_constantsgridfire::rates::weak::WeakReactionprivate + m_idgridfire::rates::weak::WeakReactionprivate + m_interpolatorgridfire::rates::weak::WeakReactionprivate + m_productgridfire::rates::weak::WeakReactionprivate + m_product_agridfire::rates::weak::WeakReactionprivate + m_product_zgridfire::rates::weak::WeakReactionprivate + m_productsgridfire::rates::weak::WeakReactionprivate + m_reactantgridfire::rates::weak::WeakReactionprivate + m_reactant_agridfire::rates::weak::WeakReactionprivate + m_reactant_zgridfire::rates::weak::WeakReactionprivate + m_reactantsgridfire::rates::weak::WeakReactionprivate + m_typegridfire::rates::weak::WeakReactionprivate + num_species() const overridegridfire::rates::weak::WeakReactionvirtual + product_species() const overridegridfire::rates::weak::WeakReactionvirtual + products() const overridegridfire::rates::weak::WeakReactionvirtual + qValue() const overridegridfire::rates::weak::WeakReactionvirtual + reactant_species() const overridegridfire::rates::weak::WeakReactionvirtual + reactants() const overridegridfire::rates::weak::WeakReactionvirtual + stoichiometry() const overridegridfire::rates::weak::WeakReactionvirtual + stoichiometry(const fourdst::atomic::Species &species) const overridegridfire::rates::weak::WeakReactionvirtual + type() const overridegridfire::rates::weak::WeakReactionvirtual + WeakReaction(const fourdst::atomic::Species &species, WeakReactionType type, const WeakRateInterpolator &interpolator)gridfire::rates::weak::WeakReactionexplicit + ~Reaction()=defaultgridfire::reaction::Reactionvirtual diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction.html b/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction.html index 2770297f..3cd32d9f 100644 --- a/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction.html +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction.html @@ -205,6 +205,8 @@ Public Member Functions const WeakRateInterpolatorgetWeakRateInterpolator () const  Access the underlying rate interpolator used by this reaction.
  +std::optional< std::vector< reaction::RateCoefficientSet > > getRateCoefficients () const override +  - Public Member Functions inherited from gridfire::reaction::Reaction virtual ~Reaction ()=default  Virtual destructor for correct polymorphic cleanup.
@@ -930,6 +932,33 @@ template<IsArithmeticOrAD T>

Extract the channel-specific log10(rate) from an interpolated payload. Mapping: β−→log_beta_minus, β+→log_beta_plus, e− capture→log_electron_capture, e+ capture→log_positron_capture.

+ + + +

◆ getRateCoefficients()

+ +
+
+ + + + + +
+ + + + + + + +
std::optional< std::vector< reaction::RateCoefficientSet > > gridfire::rates::weak::WeakReaction::getRateCoefficients () const
+
+inlinenodiscardoverridevirtual
+
+ +

Implements gridfire::reaction::Reaction.

+
diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction.js b/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction.js index c8dac2de..907e4087 100644 --- a/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction.js +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction.js @@ -16,6 +16,7 @@ var classgridfire_1_1rates_1_1weak_1_1_weak_reaction = [ "contains_reactant", "classgridfire_1_1rates_1_1weak_1_1_weak_reaction.html#a98095e6536d9a6434c5955f4c169d505", null ], [ "get_log_neutrino_loss_from_payload", "classgridfire_1_1rates_1_1weak_1_1_weak_reaction.html#a7f0d21c80fbbf94ead613e678d44b835", null ], [ "get_log_rate_from_payload", "classgridfire_1_1rates_1_1weak_1_1_weak_reaction.html#a14555633289fc3822e927afca7401e49", null ], + [ "getRateCoefficients", "classgridfire_1_1rates_1_1weak_1_1_weak_reaction.html#a768eed406cc08057ed09e5daf5494650", null ], [ "getWeakRateInterpolator", "classgridfire_1_1rates_1_1weak_1_1_weak_reaction.html#aefc75b3149bee2da878177279ad375da", null ], [ "hash", "classgridfire_1_1rates_1_1weak_1_1_weak_reaction.html#ad2ba6b584cb2df7c15633fca81ce6af1", null ], [ "id", "classgridfire_1_1rates_1_1weak_1_1_weak_reaction.html#ad01a15d95878c9edbf57cd9045c4413b", null ], diff --git a/docs/html/classgridfire_1_1reaction_1_1_logical_reaclib_reaction-members.html b/docs/html/classgridfire_1_1reaction_1_1_logical_reaclib_reaction-members.html index a6c170e6..183e957e 100644 --- a/docs/html/classgridfire_1_1reaction_1_1_logical_reaclib_reaction-members.html +++ b/docs/html/classgridfire_1_1reaction_1_1_logical_reaclib_reaction-members.html @@ -123,43 +123,44 @@ $(function(){initNavTree('classgridfire_1_1reaction_1_1_logical_reaclib_reaction end()gridfire::reaction::LogicalReaclibReactioninline end() constgridfire::reaction::LogicalReaclibReactioninline excess_energy() constgridfire::reaction::ReaclibReaction - hash(uint64_t seed) const overridegridfire::reaction::ReaclibReactionvirtual - id() const overridegridfire::reaction::ReaclibReactioninlinevirtual - is_reverse() const overridegridfire::reaction::ReaclibReactioninlinevirtual - LogicalReaclibReaction(const std::vector< ReaclibReaction > &reactions)gridfire::reaction::LogicalReaclibReactionexplicit - LogicalReaclibReaction(const std::vector< ReaclibReaction > &reactions, bool reverse)gridfire::reaction::LogicalReaclibReactionexplicit - m_chaptergridfire::reaction::ReaclibReactionprotected - m_idgridfire::reaction::ReaclibReactionprotected - m_loggergridfire::reaction::ReaclibReactionprotected - m_peNamegridfire::reaction::ReaclibReactionprotected - m_productsgridfire::reaction::ReaclibReactionprotected - m_qValuegridfire::reaction::ReaclibReactionprotected - m_rateCoefficientsgridfire::reaction::ReaclibReactionprotected - m_ratesgridfire::reaction::LogicalReaclibReactionprivate - m_reactantsgridfire::reaction::ReaclibReactionprotected - m_reversegridfire::reaction::ReaclibReactionprotected - m_sourceLabelgridfire::reaction::ReaclibReactionprotected - m_sourcesgridfire::reaction::LogicalReaclibReactionprivate - num_species() const overridegridfire::reaction::ReaclibReactionvirtual - operator!=(const ReaclibReaction &other) constgridfire::reaction::ReaclibReactioninline - operator<<(std::ostream &os, const LogicalReaclibReaction &r)gridfire::reaction::LogicalReaclibReactionfriend - operator==(const ReaclibReaction &other) constgridfire::reaction::ReaclibReactioninline - peName() constgridfire::reaction::ReaclibReactioninlinevirtual - product_species() const overridegridfire::reaction::ReaclibReactionvirtual - products() const overridegridfire::reaction::ReaclibReactioninlinevirtual - qValue() const overridegridfire::reaction::ReaclibReactioninlinevirtual - rateCoefficients() constgridfire::reaction::ReaclibReactioninline - ReaclibReaction(std::string_view id, std::string_view peName, int chapter, const std::vector< fourdst::atomic::Species > &reactants, const std::vector< fourdst::atomic::Species > &products, double qValue, std::string_view label, const RateCoefficientSet &sets, bool reverse=false)gridfire::reaction::ReaclibReaction - reactant_species() const overridegridfire::reaction::ReaclibReactionvirtual - reactants() const overridegridfire::reaction::ReaclibReactioninlinevirtual - size() constgridfire::reaction::LogicalReaclibReactioninline - sourceLabel() constgridfire::reaction::ReaclibReactioninline - sources() constgridfire::reaction::LogicalReaclibReactioninline - stoichiometry(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactionvirtual - stoichiometry() const overridegridfire::reaction::ReaclibReactionvirtual - type() const overridegridfire::reaction::LogicalReaclibReactioninlinevirtual - ~ReaclibReaction() override=defaultgridfire::reaction::ReaclibReaction - ~Reaction()=defaultgridfire::reaction::Reactionvirtual + getRateCoefficients() const overridegridfire::reaction::LogicalReaclibReactionvirtual + hash(uint64_t seed) const overridegridfire::reaction::ReaclibReactionvirtual + id() const overridegridfire::reaction::ReaclibReactioninlinevirtual + is_reverse() const overridegridfire::reaction::ReaclibReactioninlinevirtual + LogicalReaclibReaction(const std::vector< ReaclibReaction > &reactions)gridfire::reaction::LogicalReaclibReactionexplicit + LogicalReaclibReaction(const std::vector< ReaclibReaction > &reactions, bool reverse)gridfire::reaction::LogicalReaclibReactionexplicit + m_chaptergridfire::reaction::ReaclibReactionprotected + m_idgridfire::reaction::ReaclibReactionprotected + m_loggergridfire::reaction::ReaclibReactionprotected + m_peNamegridfire::reaction::ReaclibReactionprotected + m_productsgridfire::reaction::ReaclibReactionprotected + m_qValuegridfire::reaction::ReaclibReactionprotected + m_rateCoefficientsgridfire::reaction::ReaclibReactionprotected + m_ratesgridfire::reaction::LogicalReaclibReactionprivate + m_reactantsgridfire::reaction::ReaclibReactionprotected + m_reversegridfire::reaction::ReaclibReactionprotected + m_sourceLabelgridfire::reaction::ReaclibReactionprotected + m_sourcesgridfire::reaction::LogicalReaclibReactionprivate + num_species() const overridegridfire::reaction::ReaclibReactionvirtual + operator!=(const ReaclibReaction &other) constgridfire::reaction::ReaclibReactioninline + operator<<(std::ostream &os, const LogicalReaclibReaction &r)gridfire::reaction::LogicalReaclibReactionfriend + operator==(const ReaclibReaction &other) constgridfire::reaction::ReaclibReactioninline + peName() constgridfire::reaction::ReaclibReactioninlinevirtual + product_species() const overridegridfire::reaction::ReaclibReactionvirtual + products() const overridegridfire::reaction::ReaclibReactioninlinevirtual + qValue() const overridegridfire::reaction::ReaclibReactioninlinevirtual + rateCoefficients() constgridfire::reaction::ReaclibReactioninline + ReaclibReaction(std::string_view id, std::string_view peName, int chapter, const std::vector< fourdst::atomic::Species > &reactants, const std::vector< fourdst::atomic::Species > &products, double qValue, std::string_view label, const RateCoefficientSet &sets, bool reverse=false)gridfire::reaction::ReaclibReaction + reactant_species() const overridegridfire::reaction::ReaclibReactionvirtual + reactants() const overridegridfire::reaction::ReaclibReactioninlinevirtual + size() constgridfire::reaction::LogicalReaclibReactioninline + sourceLabel() constgridfire::reaction::ReaclibReactioninline + sources() constgridfire::reaction::LogicalReaclibReactioninline + stoichiometry(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactionvirtual + stoichiometry() const overridegridfire::reaction::ReaclibReactionvirtual + type() const overridegridfire::reaction::LogicalReaclibReactioninlinevirtual + ~ReaclibReaction() override=defaultgridfire::reaction::ReaclibReaction + ~Reaction()=defaultgridfire::reaction::Reactionvirtual diff --git a/docs/html/classgridfire_1_1reaction_1_1_logical_reaclib_reaction.html b/docs/html/classgridfire_1_1reaction_1_1_logical_reaclib_reaction.html index 964c6e6a..2508fe7e 100644 --- a/docs/html/classgridfire_1_1reaction_1_1_logical_reaclib_reaction.html +++ b/docs/html/classgridfire_1_1reaction_1_1_logical_reaclib_reaction.html @@ -155,6 +155,8 @@ Public Member Functions CppAD::AD< double > calculate_rate (CppAD::AD< double > T9, CppAD::AD< double > rho, CppAD::AD< double > Ye, CppAD::AD< double > mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const override  Calculates the total reaction rate using CppAD types.
  +std::optional< std::vector< RateCoefficientSet > > getRateCoefficients () const override + 
Iterators

Provides iterators to loop over the rate coefficient sets.

@@ -196,6 +198,8 @@ Public Member Functions const RateCoefficientSetrateCoefficients () const  Gets the set of rate coefficients.
  +std::optional< std::vector< RateCoefficientSet > > getRateCoefficients () const override +  bool contains (const fourdst::atomic::Species &species) const override  Checks if the reaction involves a given species as a reactant or product.
  @@ -791,6 +795,33 @@ template<typename T>
+
+ + +

◆ getRateCoefficients()

+ +
+
+ + + + + +
+ + + + + + + +
std::optional< std::vector< RateCoefficientSet > > gridfire::reaction::LogicalReaclibReaction::getRateCoefficients () const
+
+nodiscardoverridevirtual
+
+ +

Implements gridfire::reaction::Reaction.

+
diff --git a/docs/html/classgridfire_1_1reaction_1_1_logical_reaclib_reaction.js b/docs/html/classgridfire_1_1reaction_1_1_logical_reaclib_reaction.js index 581e0f6e..7882549f 100644 --- a/docs/html/classgridfire_1_1reaction_1_1_logical_reaclib_reaction.js +++ b/docs/html/classgridfire_1_1reaction_1_1_logical_reaclib_reaction.js @@ -12,6 +12,7 @@ var classgridfire_1_1reaction_1_1_logical_reaclib_reaction = [ "clone", "classgridfire_1_1reaction_1_1_logical_reaclib_reaction.html#ad113b9cb64c449f9449c4cce4fa64076", null ], [ "end", "classgridfire_1_1reaction_1_1_logical_reaclib_reaction.html#aefaf6c4c32ae54a2882da0e031632a74", null ], [ "end", "classgridfire_1_1reaction_1_1_logical_reaclib_reaction.html#ae0b38d499bf0c9ca58461ea2862a7d5a", null ], + [ "getRateCoefficients", "classgridfire_1_1reaction_1_1_logical_reaclib_reaction.html#adfef828853172ca573395160e2ce9c49", null ], [ "size", "classgridfire_1_1reaction_1_1_logical_reaclib_reaction.html#a4c58951d9f7ab252717c226b0da80a9d", null ], [ "sources", "classgridfire_1_1reaction_1_1_logical_reaclib_reaction.html#ad4979f437dc787a5475c3a029804ed99", null ], [ "type", "classgridfire_1_1reaction_1_1_logical_reaclib_reaction.html#acbfa2d4e23dff6641be21cc1e754be15", null ], diff --git a/docs/html/classgridfire_1_1reaction_1_1_reaclib_reaction-members.html b/docs/html/classgridfire_1_1reaction_1_1_reaclib_reaction-members.html index c08b58d1..da655a9d 100644 --- a/docs/html/classgridfire_1_1reaction_1_1_reaclib_reaction-members.html +++ b/docs/html/classgridfire_1_1reaction_1_1_reaclib_reaction-members.html @@ -118,37 +118,38 @@ $(function(){initNavTree('classgridfire_1_1reaction_1_1_reaclib_reaction.html',' contains_product(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactionvirtual contains_reactant(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactionvirtual excess_energy() constgridfire::reaction::ReaclibReaction - hash(uint64_t seed) const overridegridfire::reaction::ReaclibReactionvirtual - id() const overridegridfire::reaction::ReaclibReactioninlinevirtual - is_reverse() const overridegridfire::reaction::ReaclibReactioninlinevirtual - m_chaptergridfire::reaction::ReaclibReactionprotected - m_idgridfire::reaction::ReaclibReactionprotected - m_loggergridfire::reaction::ReaclibReactionprotected - m_peNamegridfire::reaction::ReaclibReactionprotected - m_productsgridfire::reaction::ReaclibReactionprotected - m_qValuegridfire::reaction::ReaclibReactionprotected - m_rateCoefficientsgridfire::reaction::ReaclibReactionprotected - m_reactantsgridfire::reaction::ReaclibReactionprotected - m_reversegridfire::reaction::ReaclibReactionprotected - m_sourceLabelgridfire::reaction::ReaclibReactionprotected - num_species() const overridegridfire::reaction::ReaclibReactionvirtual - operator!=(const ReaclibReaction &other) constgridfire::reaction::ReaclibReactioninline - operator<<(std::ostream &os, const ReaclibReaction &r)gridfire::reaction::ReaclibReactionfriend - operator==(const ReaclibReaction &other) constgridfire::reaction::ReaclibReactioninline - peName() constgridfire::reaction::ReaclibReactioninlinevirtual - product_species() const overridegridfire::reaction::ReaclibReactionvirtual - products() const overridegridfire::reaction::ReaclibReactioninlinevirtual - qValue() const overridegridfire::reaction::ReaclibReactioninlinevirtual - rateCoefficients() constgridfire::reaction::ReaclibReactioninline - ReaclibReaction(std::string_view id, std::string_view peName, int chapter, const std::vector< fourdst::atomic::Species > &reactants, const std::vector< fourdst::atomic::Species > &products, double qValue, std::string_view label, const RateCoefficientSet &sets, bool reverse=false)gridfire::reaction::ReaclibReaction - reactant_species() const overridegridfire::reaction::ReaclibReactionvirtual - reactants() const overridegridfire::reaction::ReaclibReactioninlinevirtual - sourceLabel() constgridfire::reaction::ReaclibReactioninline - stoichiometry(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactionvirtual - stoichiometry() const overridegridfire::reaction::ReaclibReactionvirtual - type() const overridegridfire::reaction::ReaclibReactioninlinevirtual - ~ReaclibReaction() override=defaultgridfire::reaction::ReaclibReaction - ~Reaction()=defaultgridfire::reaction::Reactionvirtual + getRateCoefficients() const overridegridfire::reaction::ReaclibReactionvirtual + hash(uint64_t seed) const overridegridfire::reaction::ReaclibReactionvirtual + id() const overridegridfire::reaction::ReaclibReactioninlinevirtual + is_reverse() const overridegridfire::reaction::ReaclibReactioninlinevirtual + m_chaptergridfire::reaction::ReaclibReactionprotected + m_idgridfire::reaction::ReaclibReactionprotected + m_loggergridfire::reaction::ReaclibReactionprotected + m_peNamegridfire::reaction::ReaclibReactionprotected + m_productsgridfire::reaction::ReaclibReactionprotected + m_qValuegridfire::reaction::ReaclibReactionprotected + m_rateCoefficientsgridfire::reaction::ReaclibReactionprotected + m_reactantsgridfire::reaction::ReaclibReactionprotected + m_reversegridfire::reaction::ReaclibReactionprotected + m_sourceLabelgridfire::reaction::ReaclibReactionprotected + num_species() const overridegridfire::reaction::ReaclibReactionvirtual + operator!=(const ReaclibReaction &other) constgridfire::reaction::ReaclibReactioninline + operator<<(std::ostream &os, const ReaclibReaction &r)gridfire::reaction::ReaclibReactionfriend + operator==(const ReaclibReaction &other) constgridfire::reaction::ReaclibReactioninline + peName() constgridfire::reaction::ReaclibReactioninlinevirtual + product_species() const overridegridfire::reaction::ReaclibReactionvirtual + products() const overridegridfire::reaction::ReaclibReactioninlinevirtual + qValue() const overridegridfire::reaction::ReaclibReactioninlinevirtual + rateCoefficients() constgridfire::reaction::ReaclibReactioninline + ReaclibReaction(std::string_view id, std::string_view peName, int chapter, const std::vector< fourdst::atomic::Species > &reactants, const std::vector< fourdst::atomic::Species > &products, double qValue, std::string_view label, const RateCoefficientSet &sets, bool reverse=false)gridfire::reaction::ReaclibReaction + reactant_species() const overridegridfire::reaction::ReaclibReactionvirtual + reactants() const overridegridfire::reaction::ReaclibReactioninlinevirtual + sourceLabel() constgridfire::reaction::ReaclibReactioninline + stoichiometry(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactionvirtual + stoichiometry() const overridegridfire::reaction::ReaclibReactionvirtual + type() const overridegridfire::reaction::ReaclibReactioninlinevirtual + ~ReaclibReaction() override=defaultgridfire::reaction::ReaclibReaction + ~Reaction()=defaultgridfire::reaction::Reactionvirtual diff --git a/docs/html/classgridfire_1_1reaction_1_1_reaclib_reaction.html b/docs/html/classgridfire_1_1reaction_1_1_reaclib_reaction.html index d232c552..d91120a9 100644 --- a/docs/html/classgridfire_1_1reaction_1_1_reaclib_reaction.html +++ b/docs/html/classgridfire_1_1reaction_1_1_reaclib_reaction.html @@ -152,6 +152,8 @@ Public Member Functions const RateCoefficientSetrateCoefficients () const  Gets the set of rate coefficients.
  +std::optional< std::vector< RateCoefficientSet > > getRateCoefficients () const override +  bool contains (const fourdst::atomic::Species &species) const override  Checks if the reaction involves a given species as a reactant or product.
  @@ -818,6 +820,33 @@ template<typename T>

Calculates the excess energy from the mass difference of reactants and products.

Returns
The excess energy in MeV.
+ + + +

◆ getRateCoefficients()

+ +
+
+ + + + + +
+ + + + + + + +
std::optional< std::vector< RateCoefficientSet > > gridfire::reaction::ReaclibReaction::getRateCoefficients () const
+
+nodiscardoverridevirtual
+
+ +

Implements gridfire::reaction::Reaction.

+
diff --git a/docs/html/classgridfire_1_1reaction_1_1_reaclib_reaction.js b/docs/html/classgridfire_1_1reaction_1_1_reaclib_reaction.js index d89c15f7..79b07dbe 100644 --- a/docs/html/classgridfire_1_1reaction_1_1_reaclib_reaction.js +++ b/docs/html/classgridfire_1_1reaction_1_1_reaclib_reaction.js @@ -13,6 +13,7 @@ var classgridfire_1_1reaction_1_1_reaclib_reaction = [ "contains_product", "classgridfire_1_1reaction_1_1_reaclib_reaction.html#a4e4811436d09afaa4a14c51d9af71f88", null ], [ "contains_reactant", "classgridfire_1_1reaction_1_1_reaclib_reaction.html#a65a12e5f6180873866cfaaf130fd1156", null ], [ "excess_energy", "classgridfire_1_1reaction_1_1_reaclib_reaction.html#a0b30c49925823c87980b4fca17c8282e", null ], + [ "getRateCoefficients", "classgridfire_1_1reaction_1_1_reaclib_reaction.html#aefd0436ae72880358214d5b79c9c79eb", null ], [ "hash", "classgridfire_1_1reaction_1_1_reaclib_reaction.html#a661dd461e51c37133f7f9931389fd3cc", null ], [ "id", "classgridfire_1_1reaction_1_1_reaclib_reaction.html#a06312f834439ccf93012dea53cab47ce", null ], [ "is_reverse", "classgridfire_1_1reaction_1_1_reaclib_reaction.html#a181b2c75af1f2701c43594c5bb2bac2d", null ], diff --git a/docs/html/classgridfire_1_1reaction_1_1_reaction-members.html b/docs/html/classgridfire_1_1reaction_1_1_reaction-members.html index d7a7fa9f..5a37ad87 100644 --- a/docs/html/classgridfire_1_1reaction_1_1_reaction-members.html +++ b/docs/html/classgridfire_1_1reaction_1_1_reaction-members.html @@ -115,20 +115,21 @@ $(function(){initNavTree('classgridfire_1_1reaction_1_1_reaction.html',''); init contains(const fourdst::atomic::Species &species) const =0gridfire::reaction::Reactionpure virtual contains_product(const fourdst::atomic::Species &species) const =0gridfire::reaction::Reactionpure virtual contains_reactant(const fourdst::atomic::Species &species) const =0gridfire::reaction::Reactionpure virtual - hash(uint64_t seed) const =0gridfire::reaction::Reactionpure virtual - id() const =0gridfire::reaction::Reactionpure virtual - is_reverse() const =0gridfire::reaction::Reactionpure virtual - num_species() const =0gridfire::reaction::Reactionpure virtual - operator<<(std::ostream &os, const Reaction &r)gridfire::reaction::Reactionfriend - product_species() const =0gridfire::reaction::Reactionpure virtual - products() const =0gridfire::reaction::Reactionpure virtual - qValue() const =0gridfire::reaction::Reactionpure virtual - reactant_species() const =0gridfire::reaction::Reactionpure virtual - reactants() const =0gridfire::reaction::Reactionpure virtual - stoichiometry() const =0gridfire::reaction::Reactionpure virtual - stoichiometry(const fourdst::atomic::Species &species) const =0gridfire::reaction::Reactionpure virtual - type() const =0gridfire::reaction::Reactionpure virtual - ~Reaction()=defaultgridfire::reaction::Reactionvirtual + getRateCoefficients() const =0gridfire::reaction::Reactionpure virtual + hash(uint64_t seed) const =0gridfire::reaction::Reactionpure virtual + id() const =0gridfire::reaction::Reactionpure virtual + is_reverse() const =0gridfire::reaction::Reactionpure virtual + num_species() const =0gridfire::reaction::Reactionpure virtual + operator<<(std::ostream &os, const Reaction &r)gridfire::reaction::Reactionfriend + product_species() const =0gridfire::reaction::Reactionpure virtual + products() const =0gridfire::reaction::Reactionpure virtual + qValue() const =0gridfire::reaction::Reactionpure virtual + reactant_species() const =0gridfire::reaction::Reactionpure virtual + reactants() const =0gridfire::reaction::Reactionpure virtual + stoichiometry() const =0gridfire::reaction::Reactionpure virtual + stoichiometry(const fourdst::atomic::Species &species) const =0gridfire::reaction::Reactionpure virtual + type() const =0gridfire::reaction::Reactionpure virtual + ~Reaction()=defaultgridfire::reaction::Reactionvirtual diff --git a/docs/html/classgridfire_1_1reaction_1_1_reaction.html b/docs/html/classgridfire_1_1reaction_1_1_reaction.html index 87af8c64..82123f72 100644 --- a/docs/html/classgridfire_1_1reaction_1_1_reaction.html +++ b/docs/html/classgridfire_1_1reaction_1_1_reaction.html @@ -194,6 +194,8 @@ Public Member Functions virtual std::unique_ptr< Reactionclone () const =0  Polymorphic deep copy.
  +virtual std::optional< std::vector< RateCoefficientSet > > getRateCoefficients () const =0 +  @@ -729,6 +731,33 @@ Friends

Implemented in gridfire::rates::weak::WeakReaction, and gridfire::reaction::ReaclibReaction.

+ + + +

◆ getRateCoefficients()

+ +
+
+

Friends

+ + + + +
+ + + + + + + +
virtual std::optional< std::vector< RateCoefficientSet > > gridfire::reaction::Reaction::getRateCoefficients () const
+
+pure virtual
+
+ +

Implemented in gridfire::rates::weak::WeakReaction, gridfire::reaction::LogicalReaclibReaction, and gridfire::reaction::ReaclibReaction.

+
diff --git a/docs/html/classgridfire_1_1reaction_1_1_reaction.js b/docs/html/classgridfire_1_1reaction_1_1_reaction.js index 2e772bd1..8ca13e9d 100644 --- a/docs/html/classgridfire_1_1reaction_1_1_reaction.js +++ b/docs/html/classgridfire_1_1reaction_1_1_reaction.js @@ -11,6 +11,7 @@ var classgridfire_1_1reaction_1_1_reaction = [ "contains", "classgridfire_1_1reaction_1_1_reaction.html#a768db057d358240d4825c21869af0792", null ], [ "contains_product", "classgridfire_1_1reaction_1_1_reaction.html#a2708d2e8f42159df6605a5948b13c4c5", null ], [ "contains_reactant", "classgridfire_1_1reaction_1_1_reaction.html#ab28bf4f9417ecabcc8350bae449fedd5", null ], + [ "getRateCoefficients", "classgridfire_1_1reaction_1_1_reaction.html#a6c51c30a0eec2f00c7d1f1c0be44cb0b", null ], [ "hash", "classgridfire_1_1reaction_1_1_reaction.html#a7ba8c18cd5445aa3499a6fd351183f7a", null ], [ "id", "classgridfire_1_1reaction_1_1_reaction.html#a94b92308b9619ec20c690e55157786ba", null ], [ "is_reverse", "classgridfire_1_1reaction_1_1_reaction.html#a3906a668410e02239f9031b5fc580214", null ], diff --git a/docs/html/classgridfire_1_1reaction_1_1_reaction_set-members.html b/docs/html/classgridfire_1_1reaction_1_1_reaction_set-members.html index 59e2f644..fe400bbf 100644 --- a/docs/html/classgridfire_1_1reaction_1_1_reaction_set-members.html +++ b/docs/html/classgridfire_1_1reaction_1_1_reaction_set-members.html @@ -118,24 +118,25 @@ $(function(){initNavTree('classgridfire_1_1reaction_1_1_reaction_set.html',''); end()gridfire::reaction::ReactionSetinline end() constgridfire::reaction::ReactionSetinline extend(const ReactionSet &other)gridfire::reaction::ReactionSet - getReactionSetSpecies() constgridfire::reaction::ReactionSet - hash(uint64_t seed) constgridfire::reaction::ReactionSet - m_idgridfire::reaction::ReactionSetprivate - m_loggergridfire::reaction::ReactionSetprivate - m_reactionNameMapgridfire::reaction::ReactionSetprivate - m_reactionsgridfire::reaction::ReactionSetprivate - operator!=(const ReactionSet &other) constgridfire::reaction::ReactionSet - operator<<(std::ostream &os, const ReactionSet &rs)gridfire::reaction::ReactionSetfriend - operator=(const ReactionSet &other)gridfire::reaction::ReactionSet - operator==(const ReactionSet &other) constgridfire::reaction::ReactionSet - operator[](size_t index) constgridfire::reaction::ReactionSet - operator[](const std::string_view &id) constgridfire::reaction::ReactionSet - ReactionSet(std::vector< std::unique_ptr< Reaction > > &&reactions)gridfire::reaction::ReactionSetexplicit - ReactionSet(const std::vector< Reaction * > &reactions)gridfire::reaction::ReactionSetexplicit - ReactionSet()gridfire::reaction::ReactionSet - ReactionSet(const ReactionSet &other)gridfire::reaction::ReactionSet - remove_reaction(const Reaction &reaction)gridfire::reaction::ReactionSet - size() constgridfire::reaction::ReactionSetinline + get(const std::string_view &id) constgridfire::reaction::ReactionSet + getReactionSetSpecies() constgridfire::reaction::ReactionSet + hash(uint64_t seed) constgridfire::reaction::ReactionSet + m_idgridfire::reaction::ReactionSetprivate + m_loggergridfire::reaction::ReactionSetprivate + m_reactionNameMapgridfire::reaction::ReactionSetprivate + m_reactionsgridfire::reaction::ReactionSetprivate + operator!=(const ReactionSet &other) constgridfire::reaction::ReactionSet + operator<<(std::ostream &os, const ReactionSet &rs)gridfire::reaction::ReactionSetfriend + operator=(const ReactionSet &other)gridfire::reaction::ReactionSet + operator==(const ReactionSet &other) constgridfire::reaction::ReactionSet + operator[](size_t index) constgridfire::reaction::ReactionSet + operator[](const std::string_view &id) constgridfire::reaction::ReactionSet + ReactionSet(std::vector< std::unique_ptr< Reaction > > &&reactions)gridfire::reaction::ReactionSetexplicit + ReactionSet(const std::vector< Reaction * > &reactions)gridfire::reaction::ReactionSetexplicit + ReactionSet()gridfire::reaction::ReactionSet + ReactionSet(const ReactionSet &other)gridfire::reaction::ReactionSet + remove_reaction(const Reaction &reaction)gridfire::reaction::ReactionSet + size() constgridfire::reaction::ReactionSetinline diff --git a/docs/html/classgridfire_1_1reaction_1_1_reaction_set.html b/docs/html/classgridfire_1_1reaction_1_1_reaction_set.html index af17e687..9b7551f6 100644 --- a/docs/html/classgridfire_1_1reaction_1_1_reaction_set.html +++ b/docs/html/classgridfire_1_1reaction_1_1_reaction_set.html @@ -132,6 +132,8 @@ Public Member Functions   void extend (const ReactionSet &other)   +std::optional< std::unique_ptr< Reaction > > get (const std::string_view &id) const +  void remove_reaction (const Reaction &reaction)  Removes a reaction from the set.
  @@ -658,6 +660,31 @@ Friends
+
+ + +

◆ get()

+ +
+
+ + + + + +
+ + + + + + + +
std::optional< std::unique_ptr< Reaction > > gridfire::reaction::ReactionSet::get (const std::string_view & id) const
+
+nodiscard
+
+
diff --git a/docs/html/classgridfire_1_1reaction_1_1_reaction_set.js b/docs/html/classgridfire_1_1reaction_1_1_reaction_set.js index 17df9d96..ebd7cc9a 100644 --- a/docs/html/classgridfire_1_1reaction_1_1_reaction_set.js +++ b/docs/html/classgridfire_1_1reaction_1_1_reaction_set.js @@ -17,6 +17,7 @@ var classgridfire_1_1reaction_1_1_reaction_set = [ "end", "classgridfire_1_1reaction_1_1_reaction_set.html#abae9fbc4b4306479a6cd3173ac628987", null ], [ "end", "classgridfire_1_1reaction_1_1_reaction_set.html#a436f9c4b8f8a4e115b19728d57d8e105", null ], [ "extend", "classgridfire_1_1reaction_1_1_reaction_set.html#a6a4836776f5dd00158d2336e5bcc3222", null ], + [ "get", "classgridfire_1_1reaction_1_1_reaction_set.html#a85314ee0dde7e12915f63237086b5eb6", null ], [ "getReactionSetSpecies", "classgridfire_1_1reaction_1_1_reaction_set.html#a133ad8cca6a75d31ef8efe67801aef1b", null ], [ "hash", "classgridfire_1_1reaction_1_1_reaction_set.html#ad28907fc08de978461d68cc5b77a3a99", null ], [ "operator!=", "classgridfire_1_1reaction_1_1_reaction_set.html#a529189f464aebc6b5ac5c717f70e14b8", null ], diff --git a/docs/html/dir_1c671bae89ad45c4f6571bd7c3fca7f2.html b/docs/html/dir_1c671bae89ad45c4f6571bd7c3fca7f2.html index 17f003d9..2bb3500c 100644 --- a/docs/html/dir_1c671bae89ad45c4f6571bd7c3fca7f2.html +++ b/docs/html/dir_1c671bae89ad45c4f6571bd7c3fca7f2.html @@ -103,6 +103,11 @@ $(function(){initNavTree('dir_1c671bae89ad45c4f6571bd7c3fca7f2.html',''); initRe
+ + + +

+Directories

 generative
 
diff --git a/docs/html/dir_1c671bae89ad45c4f6571bd7c3fca7f2.js b/docs/html/dir_1c671bae89ad45c4f6571bd7c3fca7f2.js index 9e5dd1ca..79aa8dfe 100644 --- a/docs/html/dir_1c671bae89ad45c4f6571bd7c3fca7f2.js +++ b/docs/html/dir_1c671bae89ad45c4f6571bd7c3fca7f2.js @@ -1,5 +1,6 @@ var dir_1c671bae89ad45c4f6571bd7c3fca7f2 = [ + [ "generative", "dir_50276930ebaab8fc53381456974784ee.html", "dir_50276930ebaab8fc53381456974784ee" ], [ "io.h", "io_8h.html", null ], [ "network_file.h", "network__file_8h.html", "network__file_8h" ] ]; \ No newline at end of file diff --git a/docs/html/dir_2adadb1daf94a265dd4b6962493aba6e.html b/docs/html/dir_2adadb1daf94a265dd4b6962493aba6e.html new file mode 100644 index 00000000..110efda9 --- /dev/null +++ b/docs/html/dir_2adadb1daf94a265dd4b6962493aba6e.html @@ -0,0 +1,128 @@ + + + + + + + +GridFire: src/include/gridfire/policy Directory Reference + + + + + + + + + + + + + + + + + +
+
+

Files

 io.h
+ + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + + +
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
policy Directory Reference
+
+
+ + + + + + + + + + + +

+Files

 chains.h
 Concrete implementations of ReactionChainPolicy for key stellar reaction chains.
 
 policy_abstract.h
 Abstract policy interfaces used to construct reaction networks (DynamicEngine) from seed compositions.
 
 stellar_policy.h
 High-level concrete NetworkPolicy for specific stellar environments.
 
+
+
+ + + + diff --git a/docs/html/dir_2adadb1daf94a265dd4b6962493aba6e.js b/docs/html/dir_2adadb1daf94a265dd4b6962493aba6e.js new file mode 100644 index 00000000..67f1728e --- /dev/null +++ b/docs/html/dir_2adadb1daf94a265dd4b6962493aba6e.js @@ -0,0 +1,6 @@ +var dir_2adadb1daf94a265dd4b6962493aba6e = +[ + [ "chains.h", "chains_8h.html", "chains_8h" ], + [ "policy_abstract.h", "policy__abstract_8h.html", "policy__abstract_8h" ], + [ "stellar_policy.h", "stellar__policy_8h.html", "stellar__policy_8h" ] +]; \ No newline at end of file diff --git a/docs/html/dir_3626e0c0e3c5d7812d6b277dfa4ec364.html b/docs/html/dir_3626e0c0e3c5d7812d6b277dfa4ec364.html index 7f352943..ca209c62 100644 --- a/docs/html/dir_3626e0c0e3c5d7812d6b277dfa4ec364.html +++ b/docs/html/dir_3626e0c0e3c5d7812d6b277dfa4ec364.html @@ -117,6 +117,8 @@ Directories    partition   + policy reaction    screening diff --git a/docs/html/dir_3626e0c0e3c5d7812d6b277dfa4ec364.js b/docs/html/dir_3626e0c0e3c5d7812d6b277dfa4ec364.js index 6f468ae9..e758618d 100644 --- a/docs/html/dir_3626e0c0e3c5d7812d6b277dfa4ec364.js +++ b/docs/html/dir_3626e0c0e3c5d7812d6b277dfa4ec364.js @@ -6,6 +6,7 @@ var dir_3626e0c0e3c5d7812d6b277dfa4ec364 = [ "interfaces", "dir_f4383b1846ef599868e873d917f1344c.html", "dir_f4383b1846ef599868e873d917f1344c" ], [ "io", "dir_1c671bae89ad45c4f6571bd7c3fca7f2.html", "dir_1c671bae89ad45c4f6571bd7c3fca7f2" ], [ "partition", "dir_1d1d50ce0d70b163d7d102a960190628.html", "dir_1d1d50ce0d70b163d7d102a960190628" ], + [ "policy", "dir_2adadb1daf94a265dd4b6962493aba6e.html", "dir_2adadb1daf94a265dd4b6962493aba6e" ], [ "reaction", "dir_f2d7b0c77cb2532170ac94ead6e4ba70.html", "dir_f2d7b0c77cb2532170ac94ead6e4ba70" ], [ "screening", "dir_ad59de2d6f32552fa0ecb4acca2fbb0b.html", "dir_ad59de2d6f32552fa0ecb4acca2fbb0b" ], [ "solver", "dir_e2a8863ee8e7cd9122c04bdba1c35a3b.html", "dir_e2a8863ee8e7cd9122c04bdba1c35a3b" ], diff --git a/docs/html/dir_50276930ebaab8fc53381456974784ee.html b/docs/html/dir_50276930ebaab8fc53381456974784ee.html new file mode 100644 index 00000000..f3671edc --- /dev/null +++ b/docs/html/dir_50276930ebaab8fc53381456974784ee.html @@ -0,0 +1,121 @@ + + + + + + + +GridFire: src/include/gridfire/io/generative Directory Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
generative Directory Reference
+
+
+ + + + +

+Files

 python.h
 
+
+
+ + + + diff --git a/docs/html/dir_50276930ebaab8fc53381456974784ee.js b/docs/html/dir_50276930ebaab8fc53381456974784ee.js new file mode 100644 index 00000000..e5ff2eb3 --- /dev/null +++ b/docs/html/dir_50276930ebaab8fc53381456974784ee.js @@ -0,0 +1,4 @@ +var dir_50276930ebaab8fc53381456974784ee = +[ + [ "python.h", "python_8h.html", "python_8h" ] +]; \ No newline at end of file diff --git a/docs/html/dir_65bc51589f8002bfcb72faf47ab41180.html b/docs/html/dir_65bc51589f8002bfcb72faf47ab41180.html index 3783ef28..ec0af871 100644 --- a/docs/html/dir_65bc51589f8002bfcb72faf47ab41180.html +++ b/docs/html/dir_65bc51589f8002bfcb72faf47ab41180.html @@ -103,6 +103,11 @@ $(function(){initNavTree('dir_65bc51589f8002bfcb72faf47ab41180.html',''); initRe
+ + + +

+Directories

 generative
 
diff --git a/docs/html/dir_65bc51589f8002bfcb72faf47ab41180.js b/docs/html/dir_65bc51589f8002bfcb72faf47ab41180.js index c3d06068..df024a09 100644 --- a/docs/html/dir_65bc51589f8002bfcb72faf47ab41180.js +++ b/docs/html/dir_65bc51589f8002bfcb72faf47ab41180.js @@ -1,4 +1,5 @@ var dir_65bc51589f8002bfcb72faf47ab41180 = [ + [ "generative", "dir_92702fa8b7ad81d706ff2de191dc2c50.html", "dir_92702fa8b7ad81d706ff2de191dc2c50" ], [ "network_file.cpp", "network__file_8cpp.html", null ] ]; \ No newline at end of file diff --git a/docs/html/dir_92702fa8b7ad81d706ff2de191dc2c50.html b/docs/html/dir_92702fa8b7ad81d706ff2de191dc2c50.html new file mode 100644 index 00000000..3a942b12 --- /dev/null +++ b/docs/html/dir_92702fa8b7ad81d706ff2de191dc2c50.html @@ -0,0 +1,121 @@ + + + + + + + +GridFire: src/lib/io/generative Directory Reference + + + + + + + + + + + + + + + + + +
+
+

Files

 network_file.cpp
+ + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + + +
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
generative Directory Reference
+
+
+ + + + +

+Files

 python.cpp
 
+
+
+ + + + diff --git a/docs/html/dir_92702fa8b7ad81d706ff2de191dc2c50.js b/docs/html/dir_92702fa8b7ad81d706ff2de191dc2c50.js new file mode 100644 index 00000000..3308e21b --- /dev/null +++ b/docs/html/dir_92702fa8b7ad81d706ff2de191dc2c50.js @@ -0,0 +1,4 @@ +var dir_92702fa8b7ad81d706ff2de191dc2c50 = +[ + [ "python.cpp", "python_8cpp.html", "python_8cpp" ] +]; \ No newline at end of file diff --git a/docs/html/dir_cd87a60aa1dbf4ee960e0533fd7a9743.html b/docs/html/dir_cd87a60aa1dbf4ee960e0533fd7a9743.html index a6dd43ad..5fcdfd43 100644 --- a/docs/html/dir_cd87a60aa1dbf4ee960e0533fd7a9743.html +++ b/docs/html/dir_cd87a60aa1dbf4ee960e0533fd7a9743.html @@ -107,6 +107,9 @@ $(function(){initNavTree('dir_cd87a60aa1dbf4ee960e0533fd7a9743.html',''); initRe Files  error_engine.h   + error_policy.h + Defines custom exception types related to network policy construction and verification.
 error_utils.h    exceptions.h diff --git a/docs/html/dir_cd87a60aa1dbf4ee960e0533fd7a9743.js b/docs/html/dir_cd87a60aa1dbf4ee960e0533fd7a9743.js index aac57677..0159ca0c 100644 --- a/docs/html/dir_cd87a60aa1dbf4ee960e0533fd7a9743.js +++ b/docs/html/dir_cd87a60aa1dbf4ee960e0533fd7a9743.js @@ -1,6 +1,7 @@ var dir_cd87a60aa1dbf4ee960e0533fd7a9743 = [ [ "error_engine.h", "error__engine_8h.html", "error__engine_8h" ], + [ "error_policy.h", "error__policy_8h.html", "error__policy_8h" ], [ "error_utils.h", "error__utils_8h.html", "error__utils_8h" ], [ "exceptions.h", "exceptions_8h.html", null ] ]; \ No newline at end of file diff --git a/docs/html/doxygen_crawl.html b/docs/html/doxygen_crawl.html index 0cc61d5f..5460b611 100644 --- a/docs/html/doxygen_crawl.html +++ b/docs/html/doxygen_crawl.html @@ -15,6 +15,7 @@ + @@ -406,6 +407,7 @@ + @@ -439,6 +441,7 @@ + @@ -484,11 +487,25 @@ + + + + + + + + + + + + + + @@ -597,6 +614,63 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -625,6 +699,7 @@ + @@ -686,6 +761,7 @@ + @@ -729,6 +805,7 @@ + @@ -740,6 +817,7 @@ + @@ -775,6 +853,7 @@ + @@ -1063,6 +1142,7 @@ + @@ -1070,6 +1150,7 @@ + @@ -1084,6 +1165,7 @@ + @@ -1167,6 +1249,7 @@ + @@ -1430,6 +1513,10 @@ + + + + @@ -1438,6 +1525,13 @@ + + + + + + + @@ -1543,6 +1637,7 @@ + @@ -1556,6 +1651,8 @@ + + @@ -1592,6 +1689,7 @@ + @@ -1766,6 +1864,11 @@ + + + + + diff --git a/docs/html/error__policy_8h.html b/docs/html/error__policy_8h.html new file mode 100644 index 00000000..0803f43e --- /dev/null +++ b/docs/html/error__policy_8h.html @@ -0,0 +1,150 @@ + + + + + + + +GridFire: src/include/gridfire/exceptions/error_policy.h File Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.0-alpha +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+ +
error_policy.h File Reference
+
+
+ +

Defines custom exception types related to network policy construction and verification. +More...

+
#include <exception>
+#include <string>
+
+ + + + + + + + + + + + + +

+Classes

class  gridfire::exceptions::PolicyError
 Base class for all exceptions related to network policy operations. More...
 
class  gridfire::exceptions::MissingBaseReactionError
 Exception thrown when a required reaction is missing from the underlying database (e.g., REACLIB). More...
 
class  gridfire::exceptions::MissingSeedSpeciesError
 Exception thrown when a required seed species is not found in the initial composition. More...
 
class  gridfire::exceptions::MissingKeyReactionError
 Exception thrown when a constructed network fails to include a key reaction required by the policy. More...
 
+ + + + + +

+Namespaces

namespace  gridfire
 
namespace  gridfire::exceptions
 
+

Detailed Description

+

Defines custom exception types related to network policy construction and verification.

+

This file contains a hierarchy of exception classes that are thrown by NetworkPolicy implementations (see stellar_policy.h) and ReactionChainPolicy implementations (see chains.h) when errors occur.

+

The base class PolicyError inherits from std::exception, and specific error conditions are represented by derived classes.

+
+
+ + + + diff --git a/docs/html/error__policy_8h.js b/docs/html/error__policy_8h.js new file mode 100644 index 00000000..c66b004c --- /dev/null +++ b/docs/html/error__policy_8h.js @@ -0,0 +1,7 @@ +var error__policy_8h = +[ + [ "gridfire::exceptions::PolicyError", "classgridfire_1_1exceptions_1_1_policy_error.html", "classgridfire_1_1exceptions_1_1_policy_error" ], + [ "gridfire::exceptions::MissingBaseReactionError", "classgridfire_1_1exceptions_1_1_missing_base_reaction_error.html", "classgridfire_1_1exceptions_1_1_missing_base_reaction_error" ], + [ "gridfire::exceptions::MissingSeedSpeciesError", "classgridfire_1_1exceptions_1_1_missing_seed_species_error.html", "classgridfire_1_1exceptions_1_1_missing_seed_species_error" ], + [ "gridfire::exceptions::MissingKeyReactionError", "classgridfire_1_1exceptions_1_1_missing_key_reaction_error.html", "classgridfire_1_1exceptions_1_1_missing_key_reaction_error" ] +]; \ No newline at end of file diff --git a/docs/html/files.html b/docs/html/files.html index 7b2763f9..0d6f5ce5 100644 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -133,8 +133,9 @@ $(function(){initNavTree('files.html',''); initResizable(true); });  engine_graph.h   exceptions  error_engine.h - error_utils.h - exceptions.h + error_policy.hDefines custom exception types related to network policy construction and verification + error_utils.h + exceptions.h   expectations  expectations.h  expected_engine.h @@ -142,8 +143,10 @@ $(function(){initNavTree('files.html',''); initResizable(true); });   solver  solver_interfaces.h   io - io.h - network_file.h +  generative + python.h + io.h + network_file.h   partition   composite  partition_composite.h @@ -154,56 +157,62 @@ $(function(){initNavTree('files.html',''); initResizable(true); });  partition_types.h  rauscher_thielemann_partition_data.h  rauscher_thielemann_partition_data_record.h -  reaction -  weak - weak.h - weak_interpolator.h - weak_rate_library.h - weak_types.hPlain data structures and enums for weak reaction tables, interpolation payloads, and errors - reaclib.h - reaction.hDefines classes for representing and managing nuclear reactions - reactions_data.h -  screening - screening.h - screening_abstract.h - screening_bare.h - screening_intermediate.h - screening_types.h - screening_weak.h -  solver -  strategies -  triggers - engine_partitioning_trigger.hCVODE-specific triggers that decide when to (re)partition the reaction network engine - CVODE_solver_strategy.h - solver.h -  trigger -  procedures - trigger_pprint.h - trigger_abstract.h - trigger_logical.hCombinators for composing triggers with boolean logic (AND/OR/NOT/EveryNth) - trigger_result.hStructured explanation node for trigger evaluations -  utils - general_composition.h - hashing.h - logging.h - table_format.h - network.h -  lib -  engine -  diagnostics - dynamic_engine_diagnostics.cpp -  procedures - construction.cpp - priming.cpp -  views - engine_adaptive.cpp - engine_defined.cpp - engine_multiscale.cpp - engine_priming.cpp - engine_approx8.cpp - engine_graph.cpp -  io - network_file.cpp +  policy + chains.hConcrete implementations of ReactionChainPolicy for key stellar reaction chains + policy_abstract.hAbstract policy interfaces used to construct reaction networks (DynamicEngine) from seed compositions + stellar_policy.hHigh-level concrete NetworkPolicy for specific stellar environments +  reaction +  weak + weak.h + weak_interpolator.h + weak_rate_library.h + weak_types.hPlain data structures and enums for weak reaction tables, interpolation payloads, and errors + reaclib.h + reaction.hDefines classes for representing and managing nuclear reactions + reactions_data.h +  screening + screening.h + screening_abstract.h + screening_bare.h + screening_intermediate.h + screening_types.h + screening_weak.h +  solver +  strategies +  triggers + engine_partitioning_trigger.hCVODE-specific triggers that decide when to (re)partition the reaction network engine + CVODE_solver_strategy.h + solver.h +  trigger +  procedures + trigger_pprint.h + trigger_abstract.h + trigger_logical.hCombinators for composing triggers with boolean logic (AND/OR/NOT/EveryNth) + trigger_result.hStructured explanation node for trigger evaluations +  utils + general_composition.h + hashing.h + logging.h + table_format.h + network.h +  lib +  engine +  diagnostics + dynamic_engine_diagnostics.cpp +  procedures + construction.cpp + priming.cpp +  views + engine_adaptive.cpp + engine_defined.cpp + engine_multiscale.cpp + engine_priming.cpp + engine_approx8.cpp + engine_graph.cpp +  io +  generative + python.cpp + network_file.cpp   partition   composite  partition_composite.cpp diff --git a/docs/html/functions_b.html b/docs/html/functions_b.html index 90bea59f..ae00e8ef 100644 --- a/docs/html/functions_b.html +++ b/docs/html/functions_b.html @@ -109,6 +109,7 @@ $(function(){initNavTree('functions_b.html',''); initResizable(true); });
  • bound : gridfire::partition::RauscherThielemannPartitionFunction::IdentifiedIsotope
  • Bounds : gridfire::partition::RauscherThielemannPartitionFunction
  • boundsErrorInfo : gridfire::rates::weak::InterpolationError
  • +
  • build_partition_function() : gridfire::policy::LowMassMainSequencePolicy
  • buildConnectivityGraph() : gridfire::MultiscalePartitioningEngineView
  • diff --git a/docs/html/functions_c.html b/docs/html/functions_c.html index 91daca8d..b5bc4b52 100644 --- a/docs/html/functions_c.html +++ b/docs/html/functions_c.html @@ -123,9 +123,11 @@ $(function(){initNavTree('functions_c.html',''); initResizable(true); });
  • causes : gridfire::trigger::TriggerResult
  • chapter : gridfire::reaclib::ReactionRecord, gridfire::reaction::ReaclibReaction
  • check() : gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger, gridfire::trigger::Trigger< TriggerContextStruct >
  • +
  • check_status() : gridfire::policy::LowMassMainSequencePolicy
  • cleanup_cvode_resources() : gridfire::solver::CVODESolverStrategy
  • clear() : gridfire::reaction::ReactionSet, gridfire::ReactionSet
  • clone() : gridfire::partition::CompositePartitionFunction, gridfire::partition::GroundStatePartitionFunction, gridfire::partition::PartitionFunction, gridfire::partition::RauscherThielemannPartitionFunction, gridfire::rates::weak::WeakReaction, gridfire::Reaction, gridfire::reaction::LogicalReaclibReaction, gridfire::reaction::ReaclibReaction, gridfire::reaction::Reaction, PyPartitionFunction
  • +
  • CNOChainPolicy() : gridfire::policy::CNOChainPolicy
  • coeffs : gridfire::reaclib::ReactionRecord
  • collect() : gridfire::DefinedEngineView
  • collectAtomicReverseRateAtomicBases() : gridfire::GraphEngine
  • @@ -135,6 +137,7 @@ $(function(){initNavTree('functions_c.html',''); initResizable(true); });
  • CompositePartitionFunction() : gridfire::partition::CompositePartitionFunction
  • composition : gridfire::NetIn, gridfire::NetOut
  • Config : gridfire::AdaptiveEngineView, gridfire::FileDefinedEngineView, gridfire::io::MESANetworkFileParser, gridfire::io::SimpleReactionListFileParser
  • +
  • construct() : gridfire::policy::LowMassMainSequencePolicy, gridfire::policy::NetworkPolicy
  • constructCandidateGroups() : gridfire::MultiscalePartitioningEngineView
  • constructPrimingReactionSet() : gridfire::NetworkPrimingEngineView
  • constructReactionIndexMap() : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView
  • diff --git a/docs/html/functions_f.html b/docs/html/functions_f.html index 56ec35ac..db688eac 100644 --- a/docs/html/functions_f.html +++ b/docs/html/functions_f.html @@ -111,6 +111,8 @@ $(function(){initNavTree('functions_f.html',''); initResizable(true); });
  • for_sparse_jac() : gridfire::GraphEngine::AtomicReverseRate, gridfire::rates::weak::WeakReaction::AtomicWeakRate
  • forward() : gridfire::GraphEngine::AtomicReverseRate, gridfire::rates::weak::WeakReaction::AtomicWeakRate
  • FRONT : gridfire::partition::RauscherThielemannPartitionFunction
  • +
  • func_code : gridfire::io::gen::PyFunctionDef
  • +
  • func_name : gridfire::io::gen::PyFunctionDef
  • diff --git a/docs/html/functions_func_b.html b/docs/html/functions_func_b.html index 42c34316..454f233c 100644 --- a/docs/html/functions_func_b.html +++ b/docs/html/functions_func_b.html @@ -105,6 +105,7 @@ $(function(){initNavTree('functions_func_b.html',''); initResizable(true); });
  • BadCollectionError() : gridfire::exceptions::BadCollectionError
  • begin() : gridfire::reaction::LogicalReaclibReaction, gridfire::reaction::ReactionSet, gridfire::ReactionSet
  • bin() : gridfire::QSECacheKey
  • +
  • build_partition_function() : gridfire::policy::LowMassMainSequencePolicy
  • buildConnectivityGraph() : gridfire::MultiscalePartitioningEngineView
  • diff --git a/docs/html/functions_func_c.html b/docs/html/functions_func_c.html index 29ea48e7..bf96b0fd 100644 --- a/docs/html/functions_func_c.html +++ b/docs/html/functions_func_c.html @@ -120,15 +120,18 @@ $(function(){initNavTree('functions_func_c.html',''); initResizable(true); });
  • calculateScreeningFactors() : gridfire::screening::BareScreeningModel, gridfire::screening::IntermediateScreeningModel, gridfire::screening::ScreeningModel, gridfire::screening::WeakScreeningModel, PyScreening
  • chapter() : gridfire::reaction::ReaclibReaction
  • check() : gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger, gridfire::trigger::Trigger< TriggerContextStruct >
  • +
  • check_status() : gridfire::policy::LowMassMainSequencePolicy
  • cleanup_cvode_resources() : gridfire::solver::CVODESolverStrategy
  • clear() : gridfire::reaction::ReactionSet, gridfire::ReactionSet
  • clone() : gridfire::partition::CompositePartitionFunction, gridfire::partition::GroundStatePartitionFunction, gridfire::partition::PartitionFunction, gridfire::partition::RauscherThielemannPartitionFunction, gridfire::rates::weak::WeakReaction, gridfire::Reaction, gridfire::reaction::LogicalReaclibReaction, gridfire::reaction::ReaclibReaction, gridfire::reaction::Reaction, PyPartitionFunction
  • +
  • CNOChainPolicy() : gridfire::policy::CNOChainPolicy
  • collect() : gridfire::DefinedEngineView
  • collectAtomicReverseRateAtomicBases() : gridfire::GraphEngine
  • collectComposition() : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView, gridfire::DynamicEngine, gridfire::GraphEngine, gridfire::MultiscalePartitioningEngineView, PyDynamicEngine
  • collectNetworkSpecies() : gridfire::GraphEngine
  • Column() : gridfire::utils::Column< T >
  • CompositePartitionFunction() : gridfire::partition::CompositePartitionFunction
  • +
  • construct() : gridfire::policy::LowMassMainSequencePolicy, gridfire::policy::NetworkPolicy
  • constructCandidateGroups() : gridfire::MultiscalePartitioningEngineView
  • constructPrimingReactionSet() : gridfire::NetworkPrimingEngineView
  • constructReactionIndexMap() : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView
  • diff --git a/docs/html/functions_func_g.html b/docs/html/functions_func_g.html index ced85826..356fcb8a 100644 --- a/docs/html/functions_func_g.html +++ b/docs/html/functions_func_g.html @@ -104,12 +104,17 @@ $(function(){initNavTree('functions_func_g.html',''); initResizable(true); });

    - g -

    diff --git a/docs/html/functions_func_l.html b/docs/html/functions_func_l.html index e436aacb..b79e2a75 100644 --- a/docs/html/functions_func_l.html +++ b/docs/html/functions_func_l.html @@ -105,6 +105,8 @@ $(function(){initNavTree('functions_func_l.html',''); initResizable(true); });
  • log_step_diagnostics() : gridfire::solver::CVODESolverStrategy
  • log_time() : SolverPluginInterface
  • LogicalReaclibReaction() : gridfire::reaction::LogicalReaclibReaction
  • +
  • LowMassMainSequencePolicy() : gridfire::policy::LowMassMainSequencePolicy
  • +
  • LowMassMainSequenceReactionChainPolicy() : gridfire::policy::LowMassMainSequenceReactionChainPolicy
  • diff --git a/docs/html/functions_func_m.html b/docs/html/functions_func_m.html index e8711e77..1d53cf83 100644 --- a/docs/html/functions_func_m.html +++ b/docs/html/functions_func_m.html @@ -115,6 +115,9 @@ $(function(){initNavTree('functions_func_m.html',''); initResizable(true); });
  • MESANetworkFileParser() : gridfire::io::MESANetworkFileParser
  • miss() : gridfire::MultiscalePartitioningEngineView::CacheStats
  • misses() : gridfire::MultiscalePartitioningEngineView::CacheStats
  • +
  • MissingBaseReactionError() : gridfire::exceptions::MissingBaseReactionError
  • +
  • MissingKeyReactionError() : gridfire::exceptions::MissingKeyReactionError
  • +
  • MissingSeedSpeciesError() : gridfire::exceptions::MissingSeedSpeciesError
  • MolarAbundance() : gridfire::NetIn
  • MultiscalePartitioningEngineView() : gridfire::MultiscalePartitioningEngineView
  • diff --git a/docs/html/functions_func_n.html b/docs/html/functions_func_n.html index 18627ab2..b11c25e6 100644 --- a/docs/html/functions_func_n.html +++ b/docs/html/functions_func_n.html @@ -102,7 +102,7 @@ $(function(){initNavTree('functions_func_n.html',''); initResizable(true); });
    Here is a list of all functions with links to the classes they belong to:

    - n -

    diff --git a/docs/html/functions_func_w.html b/docs/html/functions_func_w.html index 560923e3..8eb84620 100644 --- a/docs/html/functions_func_w.html +++ b/docs/html/functions_func_w.html @@ -105,7 +105,7 @@ $(function(){initNavTree('functions_func_w.html',''); initResizable(true); });
  • WeakRateInterpolator() : gridfire::rates::weak::WeakRateInterpolator
  • WeakReaction() : gridfire::rates::weak::WeakReaction
  • WeakReactionMap() : gridfire::rates::weak::WeakReactionMap
  • -
  • what() : gridfire::exceptions::BadCollectionError, gridfire::exceptions::FailedToPartitionEngineError, gridfire::exceptions::HashingError, gridfire::exceptions::NetworkResizedError, gridfire::exceptions::StaleEngineError, gridfire::exceptions::StaleEngineTrigger, gridfire::exceptions::StaleJacobianError, gridfire::exceptions::UnableToSetNetworkReactionsError, gridfire::exceptions::UninitializedJacobianError, gridfire::exceptions::UnknownJacobianError
  • +
  • what() : gridfire::exceptions::BadCollectionError, gridfire::exceptions::FailedToPartitionEngineError, gridfire::exceptions::HashingError, gridfire::exceptions::NetworkResizedError, gridfire::exceptions::PolicyError, gridfire::exceptions::StaleEngineError, gridfire::exceptions::StaleEngineTrigger, gridfire::exceptions::StaleJacobianError, gridfire::exceptions::UnableToSetNetworkReactionsError, gridfire::exceptions::UninitializedJacobianError, gridfire::exceptions::UnknownJacobianError
  • why() : gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger, gridfire::trigger::Trigger< TriggerContextStruct >
  • diff --git a/docs/html/functions_func_~.html b/docs/html/functions_func_~.html index f9ba9a70..d6867e89 100644 --- a/docs/html/functions_func_~.html +++ b/docs/html/functions_func_~.html @@ -111,12 +111,14 @@ $(function(){initNavTree('functions_func_~.html',''); initResizable(true); });
  • ~EveryNthTrigger() : gridfire::trigger::EveryNthTrigger< TriggerContextStruct >
  • ~Network() : gridfire::Network
  • ~NetworkFileParser() : gridfire::io::NetworkFileParser
  • +
  • ~NetworkPolicy() : gridfire::policy::NetworkPolicy
  • ~NetworkSolverStrategy() : gridfire::solver::NetworkSolverStrategy< EngineT >
  • ~NotTrigger() : gridfire::trigger::NotTrigger< TriggerContextStruct >
  • ~OrTrigger() : gridfire::trigger::OrTrigger< TriggerContextStruct >
  • ~PartitionFunction() : gridfire::partition::PartitionFunction
  • ~ReaclibReaction() : gridfire::reaction::ReaclibReaction
  • ~Reaction() : gridfire::reaction::Reaction, gridfire::Reaction
  • +
  • ~ReactionChainPolicy() : gridfire::policy::ReactionChainPolicy
  • ~ScreeningModel() : gridfire::screening::ScreeningModel
  • ~SolverContextBase() : gridfire::solver::SolverContextBase
  • ~SolverPluginInterface() : SolverPluginInterface
  • diff --git a/docs/html/functions_g.html b/docs/html/functions_g.html index 2dc2dbc7..79add516 100644 --- a/docs/html/functions_g.html +++ b/docs/html/functions_g.html @@ -106,12 +106,17 @@ $(function(){initNavTree('functions_g.html',''); initResizable(true); });
  • G_norm_low : gridfire::partition::RauscherThielemannPartitionFunction::InterpolationPoints
  • generateJacobianMatrix() : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView, gridfire::DynamicEngine, gridfire::GraphEngine, gridfire::MultiscalePartitioningEngineView, PyDynamicEngine
  • generateStoichiometryMatrix() : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView, gridfire::DynamicEngine, gridfire::GraphEngine, gridfire::MultiscalePartitioningEngineView, PyDynamicEngine
  • +
  • get() : gridfire::reaction::ReactionSet, gridfire::ReactionSet
  • get_all_reactions() : gridfire::rates::weak::WeakReactionMap
  • +
  • get_chain_policies() : gridfire::policy::LowMassMainSequenceReactionChainPolicy, gridfire::policy::MultiReactionChainPolicy
  • get_interpolation_points() : gridfire::partition::RauscherThielemannPartitionFunction
  • get_log_neutrino_loss_from_payload() : gridfire::rates::weak::WeakReaction
  • get_log_rate_from_payload() : gridfire::rates::weak::WeakReaction
  • get_rate_derivatives() : gridfire::rates::weak::WeakRateInterpolator
  • get_rates() : gridfire::rates::weak::WeakRateInterpolator
  • +
  • get_reactions() : gridfire::policy::CNOChainPolicy, gridfire::policy::HotCNOChainPolicy, gridfire::policy::LowMassMainSequenceReactionChainPolicy, gridfire::policy::ProtonProtonChainPolicy, gridfire::policy::ReactionChainPolicy
  • +
  • get_seed_reactions() : gridfire::policy::LowMassMainSequencePolicy, gridfire::policy::NetworkPolicy
  • +
  • get_seed_species() : gridfire::policy::LowMassMainSequencePolicy, gridfire::policy::NetworkPolicy
  • get_species_reactions() : gridfire::rates::weak::WeakReactionMap
  • get_stdout_logging_enabled() : gridfire::solver::CVODESolverStrategy
  • getBaseEngine() : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView, gridfire::EngineView< EngineT >, gridfire::MultiscalePartitioningEngineView, PyDynamicEngineView, PyEngineView
  • @@ -129,6 +134,7 @@ $(function(){initNavTree('functions_g.html',''); initResizable(true); });
  • getNetworkSpecies() : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView, gridfire::Engine, gridfire::GraphEngine, gridfire::MultiscalePartitioningEngineView, PyDynamicEngine, PyEngine
  • getParser() : gridfire::FileDefinedEngineView
  • getPartitionFunction() : gridfire::GraphEngine
  • +
  • getRateCoefficients() : gridfire::rates::weak::WeakReaction, gridfire::Reaction, gridfire::reaction::LogicalReaclibReaction, gridfire::reaction::ReaclibReaction, gridfire::reaction::Reaction
  • getReactionSetSpecies() : gridfire::reaction::ReactionSet, gridfire::ReactionSet
  • getRowCount() : gridfire::utils::Column< T >, gridfire::utils::ColumnBase
  • getScreeningModel() : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView, gridfire::DynamicEngine, gridfire::GraphEngine, gridfire::MultiscalePartitioningEngineView, PyDynamicEngine
  • @@ -136,6 +142,7 @@ $(function(){initNavTree('functions_g.html',''); initResizable(true); });
  • getSpeciesIndex() : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView, gridfire::DynamicEngine, gridfire::GraphEngine, gridfire::MultiscalePartitioningEngineView, PyDynamicEngine
  • getSpeciesTimescales() : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView, gridfire::DynamicEngine, gridfire::GraphEngine, gridfire::MultiscalePartitioningEngineView, PyDynamicEngine
  • getState() : gridfire::exceptions::StaleEngineTrigger
  • +
  • getStatus() : gridfire::policy::LowMassMainSequencePolicy, gridfire::policy::NetworkPolicy
  • getStoichiometryMatrixEntry() : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView, gridfire::DynamicEngine, gridfire::GraphEngine, gridfire::MultiscalePartitioningEngineView, PyDynamicEngine
  • getWeakRateInterpolator() : gridfire::rates::weak::WeakReaction
  • GraphEngine() : gridfire::GraphEngine
  • diff --git a/docs/html/functions_h.html b/docs/html/functions_h.html index 5ce12e09..3d34f64d 100644 --- a/docs/html/functions_h.html +++ b/docs/html/functions_h.html @@ -106,6 +106,7 @@ $(function(){initNavTree('functions_h.html',''); initResizable(true); });
  • HashingError() : gridfire::exceptions::HashingError
  • hit() : gridfire::MultiscalePartitioningEngineView::CacheStats
  • hits() : gridfire::MultiscalePartitioningEngineView::CacheStats
  • +
  • HotCNOChainPolicy() : gridfire::policy::HotCNOChainPolicy
  • diff --git a/docs/html/functions_l.html b/docs/html/functions_l.html index 704f4485..287fe3be 100644 --- a/docs/html/functions_l.html +++ b/docs/html/functions_l.html @@ -119,6 +119,8 @@ $(function(){initNavTree('functions_l.html',''); initResizable(true); });
  • LogicalReaclibReaction() : gridfire::reaction::LogicalReaclibReaction
  • LogManager : gridfire::AdaptiveEngineView, gridfire::FileDefinedEngineView, gridfire::io::MESANetworkFileParser, gridfire::io::SimpleReactionListFileParser
  • lowerIndex : gridfire::partition::RauscherThielemannPartitionFunction::IdentifiedIsotope
  • +
  • LowMassMainSequencePolicy() : gridfire::policy::LowMassMainSequencePolicy
  • +
  • LowMassMainSequenceReactionChainPolicy() : gridfire::policy::LowMassMainSequenceReactionChainPolicy
  • diff --git a/docs/html/functions_m.html b/docs/html/functions_m.html index 482b84cf..16c0fbc7 100644 --- a/docs/html/functions_m.html +++ b/docs/html/functions_m.html @@ -118,6 +118,7 @@ $(function(){initNavTree('functions_m.html',''); initResizable(true); });
  • m_cacheConfig : gridfire::QSECacheKey
  • m_cacheStats : gridfire::MultiscalePartitioningEngineView
  • m_callback : gridfire::solver::CVODESolverStrategy
  • +
  • m_chain_policies : gridfire::policy::LowMassMainSequenceReactionChainPolicy
  • m_chapter : gridfire::reaction::ReaclibReaction
  • m_config : gridfire::AdaptiveEngineView, gridfire::FileDefinedEngineView, gridfire::GraphEngine, gridfire::io::MESANetworkFileParser, gridfire::io::SimpleReactionListFileParser, gridfire::Network, gridfire::solver::CVODESolverStrategy
  • m_constants : gridfire::GraphEngine, gridfire::Network, gridfire::rates::weak::WeakReaction
  • @@ -145,6 +146,7 @@ $(function(){initNavTree('functions_m.html',''); initResizable(true); });
  • m_index : gridfire::expectations::EngineIndexError
  • m_indexToSpeciesMap : gridfire::GraphEngine
  • m_initial_comp : gridfire::MultiscalePartitioningEngineView::EigenFunctor
  • +
  • m_initializing_composition : gridfire::policy::LowMassMainSequencePolicy
  • m_interpolator : gridfire::rates::weak::WeakReaction::AtomicWeakRate, gridfire::rates::weak::WeakReaction
  • m_interval : gridfire::trigger::solver::CVODE::SimulationTimeTrigger
  • m_isStale : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView
  • @@ -158,16 +160,18 @@ $(function(){initNavTree('functions_m.html',''); initResizable(true); });
  • m_logger : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView, gridfire::FileDefinedEngineView, gridfire::GraphEngine, gridfire::io::MESANetworkFileParser, gridfire::io::SimpleReactionListFileParser, gridfire::MultiscalePartitioningEngineView, gridfire::Network, gridfire::NetworkPrimingEngineView, gridfire::partition::CompositePartitionFunction, gridfire::partition::GroundStatePartitionFunction, gridfire::partition::RauscherThielemannPartitionFunction, gridfire::rates::weak::WeakRateInterpolator, gridfire::reaction::ReaclibReaction, gridfire::reaction::ReactionSet, gridfire::ReactionSet, gridfire::screening::WeakScreeningModel, gridfire::solver::CVODESolverStrategy, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger
  • m_logManager : gridfire::Network
  • m_LS : gridfire::solver::CVODESolverStrategy
  • -
  • m_message : gridfire::exceptions::BadCollectionError, gridfire::exceptions::FailedToPartitionEngineError, gridfire::exceptions::HashingError, gridfire::exceptions::NetworkResizedError, gridfire::exceptions::StaleEngineError, gridfire::exceptions::StaleJacobianError, gridfire::exceptions::UnableToSetNetworkReactionsError, gridfire::exceptions::UninitializedJacobianError, gridfire::exceptions::UnknownJacobianError, gridfire::expectations::EngineError
  • +
  • m_message : gridfire::exceptions::BadCollectionError, gridfire::exceptions::FailedToPartitionEngineError, gridfire::exceptions::HashingError, gridfire::exceptions::NetworkResizedError, gridfire::exceptions::PolicyError, gridfire::exceptions::StaleEngineError, gridfire::exceptions::StaleJacobianError, gridfire::exceptions::UnableToSetNetworkReactionsError, gridfire::exceptions::UninitializedJacobianError, gridfire::exceptions::UnknownJacobianError, gridfire::expectations::EngineError
  • m_miss : gridfire::MultiscalePartitioningEngineView::CacheStats
  • m_misses : gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger
  • m_N : gridfire::trigger::EveryNthTrigger< TriggerContextStruct >
  • +
  • m_network_stack : gridfire::policy::LowMassMainSequencePolicy
  • m_networkSpecies : gridfire::GraphEngine
  • m_networkSpeciesMap : gridfire::GraphEngine
  • m_num_steps : gridfire::solver::CVODESolverStrategy
  • m_operatorHits : gridfire::MultiscalePartitioningEngineView::CacheStats
  • m_operatorMisses : gridfire::MultiscalePartitioningEngineView::CacheStats
  • m_parser : gridfire::FileDefinedEngineView
  • +
  • m_partition_function : gridfire::policy::LowMassMainSequencePolicy
  • m_partitionData : gridfire::partition::RauscherThielemannPartitionFunction
  • m_partitionFunction : gridfire::GraphEngine
  • m_partitionFunctions : gridfire::partition::CompositePartitionFunction
  • @@ -192,10 +196,12 @@ $(function(){initNavTree('functions_m.html',''); initResizable(true); });
  • m_reactant_z : gridfire::rates::weak::WeakReaction
  • m_reactants : gridfire::rates::weak::WeakReaction, gridfire::reaction::ReaclibReaction
  • m_reaction : gridfire::GraphEngine::AtomicReverseRate
  • +
  • m_reaction_policy : gridfire::policy::LowMassMainSequencePolicy
  • m_reactionIDMap : gridfire::GraphEngine
  • +
  • m_reactionIDs : gridfire::policy::CNOChainPolicy, gridfire::policy::HotCNOChainPolicy, gridfire::policy::ProtonProtonChainPolicy
  • m_reactionIndexMap : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView
  • m_reactionNameMap : gridfire::reaction::ReactionSet, gridfire::ReactionSet
  • -
  • m_reactions : gridfire::GraphEngine, gridfire::reaction::ReactionSet, gridfire::ReactionSet
  • +
  • m_reactions : gridfire::GraphEngine, gridfire::policy::CNOChainPolicy, gridfire::policy::HotCNOChainPolicy, gridfire::policy::LowMassMainSequenceReactionChainPolicy, gridfire::policy::ProtonProtonChainPolicy, gridfire::reaction::ReactionSet, gridfire::ReactionSet
  • m_relative : gridfire::trigger::solver::CVODE::TimestepCollapseTrigger
  • m_relativeFailureRate : gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger
  • m_resets : gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger
  • @@ -204,12 +210,14 @@ $(function(){initNavTree('functions_m.html',''); initResizable(true); });
  • m_rhsADFun : gridfire::GraphEngine
  • m_screeningModel : gridfire::GraphEngine
  • m_screeningType : gridfire::GraphEngine
  • +
  • m_seed_species : gridfire::policy::LowMassMainSequencePolicy
  • m_sourceLabel : gridfire::reaction::ReaclibReaction
  • m_sources : gridfire::reaction::LogicalReaclibReaction
  • m_species_cache : PyDynamicEngine, PyEngine
  • m_speciesIndexMap : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView
  • m_speciesToIndexMap : gridfire::GraphEngine
  • m_state : gridfire::exceptions::StaleEngineTrigger
  • +
  • m_status : gridfire::policy::LowMassMainSequencePolicy
  • m_stdout_logging_enabled : gridfire::solver::CVODESolverStrategy
  • m_steps : gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >
  • m_stiff : gridfire::approx8::Approx8Network, gridfire::Network
  • @@ -257,6 +265,10 @@ $(function(){initNavTree('functions_m.html',''); initResizable(true); });
  • mIon : gridfire::approx8::Approx8Net
  • miss() : gridfire::MultiscalePartitioningEngineView::CacheStats
  • misses() : gridfire::MultiscalePartitioningEngineView::CacheStats
  • +
  • MissingBaseReactionError() : gridfire::exceptions::MissingBaseReactionError
  • +
  • MissingKeyReactionError() : gridfire::exceptions::MissingKeyReactionError
  • +
  • MissingSeedSpeciesError() : gridfire::exceptions::MissingSeedSpeciesError
  • +
  • module_req : gridfire::io::gen::PyFunctionDef
  • MolarAbundance() : gridfire::NetIn
  • mu_e : gridfire::rates::weak::RateDataRow, gridfire::rates::weak::WeakReactionEntry
  • MultiscalePartitioningEngineView() : gridfire::MultiscalePartitioningEngineView
  • diff --git a/docs/html/functions_n.html b/docs/html/functions_n.html index 584f197b..8068c06e 100644 --- a/docs/html/functions_n.html +++ b/docs/html/functions_n.html @@ -103,7 +103,7 @@ $(function(){initNavTree('functions_n.html',''); initResizable(true); });

    - n -

    diff --git a/docs/html/functions_vars_f.html b/docs/html/functions_vars_f.html index a97f5a8b..866e1937 100644 --- a/docs/html/functions_vars_f.html +++ b/docs/html/functions_vars_f.html @@ -103,6 +103,8 @@ $(function(){initNavTree('functions_vars_f.html',''); initResizable(true); });

    - f -

    diff --git a/docs/html/functions_vars_m.html b/docs/html/functions_vars_m.html index 562b2994..97830d22 100644 --- a/docs/html/functions_vars_m.html +++ b/docs/html/functions_vars_m.html @@ -118,6 +118,7 @@ $(function(){initNavTree('functions_vars_m.html',''); initResizable(true); });
  • m_cacheConfig : gridfire::QSECacheKey
  • m_cacheStats : gridfire::MultiscalePartitioningEngineView
  • m_callback : gridfire::solver::CVODESolverStrategy
  • +
  • m_chain_policies : gridfire::policy::LowMassMainSequenceReactionChainPolicy
  • m_chapter : gridfire::reaction::ReaclibReaction
  • m_config : gridfire::AdaptiveEngineView, gridfire::FileDefinedEngineView, gridfire::GraphEngine, gridfire::io::MESANetworkFileParser, gridfire::io::SimpleReactionListFileParser, gridfire::Network, gridfire::solver::CVODESolverStrategy
  • m_constants : gridfire::GraphEngine, gridfire::Network, gridfire::rates::weak::WeakReaction
  • @@ -145,6 +146,7 @@ $(function(){initNavTree('functions_vars_m.html',''); initResizable(true); });
  • m_index : gridfire::expectations::EngineIndexError
  • m_indexToSpeciesMap : gridfire::GraphEngine
  • m_initial_comp : gridfire::MultiscalePartitioningEngineView::EigenFunctor
  • +
  • m_initializing_composition : gridfire::policy::LowMassMainSequencePolicy
  • m_interpolator : gridfire::rates::weak::WeakReaction::AtomicWeakRate, gridfire::rates::weak::WeakReaction
  • m_interval : gridfire::trigger::solver::CVODE::SimulationTimeTrigger
  • m_isStale : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView
  • @@ -158,16 +160,18 @@ $(function(){initNavTree('functions_vars_m.html',''); initResizable(true); });
  • m_logger : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView, gridfire::FileDefinedEngineView, gridfire::GraphEngine, gridfire::io::MESANetworkFileParser, gridfire::io::SimpleReactionListFileParser, gridfire::MultiscalePartitioningEngineView, gridfire::Network, gridfire::NetworkPrimingEngineView, gridfire::partition::CompositePartitionFunction, gridfire::partition::GroundStatePartitionFunction, gridfire::partition::RauscherThielemannPartitionFunction, gridfire::rates::weak::WeakRateInterpolator, gridfire::reaction::ReaclibReaction, gridfire::reaction::ReactionSet, gridfire::ReactionSet, gridfire::screening::WeakScreeningModel, gridfire::solver::CVODESolverStrategy, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger
  • m_logManager : gridfire::Network
  • m_LS : gridfire::solver::CVODESolverStrategy
  • -
  • m_message : gridfire::exceptions::BadCollectionError, gridfire::exceptions::FailedToPartitionEngineError, gridfire::exceptions::HashingError, gridfire::exceptions::NetworkResizedError, gridfire::exceptions::StaleEngineError, gridfire::exceptions::StaleJacobianError, gridfire::exceptions::UnableToSetNetworkReactionsError, gridfire::exceptions::UninitializedJacobianError, gridfire::exceptions::UnknownJacobianError, gridfire::expectations::EngineError
  • +
  • m_message : gridfire::exceptions::BadCollectionError, gridfire::exceptions::FailedToPartitionEngineError, gridfire::exceptions::HashingError, gridfire::exceptions::NetworkResizedError, gridfire::exceptions::PolicyError, gridfire::exceptions::StaleEngineError, gridfire::exceptions::StaleJacobianError, gridfire::exceptions::UnableToSetNetworkReactionsError, gridfire::exceptions::UninitializedJacobianError, gridfire::exceptions::UnknownJacobianError, gridfire::expectations::EngineError
  • m_miss : gridfire::MultiscalePartitioningEngineView::CacheStats
  • m_misses : gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger
  • m_N : gridfire::trigger::EveryNthTrigger< TriggerContextStruct >
  • +
  • m_network_stack : gridfire::policy::LowMassMainSequencePolicy
  • m_networkSpecies : gridfire::GraphEngine
  • m_networkSpeciesMap : gridfire::GraphEngine
  • m_num_steps : gridfire::solver::CVODESolverStrategy
  • m_operatorHits : gridfire::MultiscalePartitioningEngineView::CacheStats
  • m_operatorMisses : gridfire::MultiscalePartitioningEngineView::CacheStats
  • m_parser : gridfire::FileDefinedEngineView
  • +
  • m_partition_function : gridfire::policy::LowMassMainSequencePolicy
  • m_partitionData : gridfire::partition::RauscherThielemannPartitionFunction
  • m_partitionFunction : gridfire::GraphEngine
  • m_partitionFunctions : gridfire::partition::CompositePartitionFunction
  • @@ -192,10 +196,12 @@ $(function(){initNavTree('functions_vars_m.html',''); initResizable(true); });
  • m_reactant_z : gridfire::rates::weak::WeakReaction
  • m_reactants : gridfire::rates::weak::WeakReaction, gridfire::reaction::ReaclibReaction
  • m_reaction : gridfire::GraphEngine::AtomicReverseRate
  • +
  • m_reaction_policy : gridfire::policy::LowMassMainSequencePolicy
  • m_reactionIDMap : gridfire::GraphEngine
  • +
  • m_reactionIDs : gridfire::policy::CNOChainPolicy, gridfire::policy::HotCNOChainPolicy, gridfire::policy::ProtonProtonChainPolicy
  • m_reactionIndexMap : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView
  • m_reactionNameMap : gridfire::reaction::ReactionSet, gridfire::ReactionSet
  • -
  • m_reactions : gridfire::GraphEngine, gridfire::reaction::ReactionSet, gridfire::ReactionSet
  • +
  • m_reactions : gridfire::GraphEngine, gridfire::policy::CNOChainPolicy, gridfire::policy::HotCNOChainPolicy, gridfire::policy::LowMassMainSequenceReactionChainPolicy, gridfire::policy::ProtonProtonChainPolicy, gridfire::reaction::ReactionSet, gridfire::ReactionSet
  • m_relative : gridfire::trigger::solver::CVODE::TimestepCollapseTrigger
  • m_relativeFailureRate : gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger
  • m_resets : gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger
  • @@ -204,12 +210,14 @@ $(function(){initNavTree('functions_vars_m.html',''); initResizable(true); });
  • m_rhsADFun : gridfire::GraphEngine
  • m_screeningModel : gridfire::GraphEngine
  • m_screeningType : gridfire::GraphEngine
  • +
  • m_seed_species : gridfire::policy::LowMassMainSequencePolicy
  • m_sourceLabel : gridfire::reaction::ReaclibReaction
  • m_sources : gridfire::reaction::LogicalReaclibReaction
  • m_species_cache : PyDynamicEngine, PyEngine
  • m_speciesIndexMap : gridfire::AdaptiveEngineView, gridfire::DefinedEngineView
  • m_speciesToIndexMap : gridfire::GraphEngine
  • m_state : gridfire::exceptions::StaleEngineTrigger
  • +
  • m_status : gridfire::policy::LowMassMainSequencePolicy
  • m_stdout_logging_enabled : gridfire::solver::CVODESolverStrategy
  • m_steps : gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >
  • m_stiff : gridfire::approx8::Approx8Network, gridfire::Network
  • @@ -243,6 +251,7 @@ $(function(){initNavTree('functions_vars_m.html',''); initResizable(true); });
  • MeVgRelation : gridfire::rates::weak::WeakReaction::constants
  • MeVPerGraph : gridfire::rates::weak::WeakReaction::constants
  • mIon : gridfire::approx8::Approx8Net
  • +
  • module_req : gridfire::io::gen::PyFunctionDef
  • mu_e : gridfire::rates::weak::RateDataRow, gridfire::rates::weak::WeakReactionEntry
  • diff --git a/docs/html/functions_w.html b/docs/html/functions_w.html index 943ac4c7..bc1c238a 100644 --- a/docs/html/functions_w.html +++ b/docs/html/functions_w.html @@ -105,7 +105,7 @@ $(function(){initNavTree('functions_w.html',''); initResizable(true); });
  • WeakRateInterpolator() : gridfire::rates::weak::WeakRateInterpolator
  • WeakReaction() : gridfire::rates::weak::WeakReaction
  • WeakReactionMap() : gridfire::rates::weak::WeakReactionMap
  • -
  • what() : gridfire::exceptions::BadCollectionError, gridfire::exceptions::FailedToPartitionEngineError, gridfire::exceptions::HashingError, gridfire::exceptions::NetworkResizedError, gridfire::exceptions::StaleEngineError, gridfire::exceptions::StaleEngineTrigger, gridfire::exceptions::StaleJacobianError, gridfire::exceptions::UnableToSetNetworkReactionsError, gridfire::exceptions::UninitializedJacobianError, gridfire::exceptions::UnknownJacobianError
  • +
  • what() : gridfire::exceptions::BadCollectionError, gridfire::exceptions::FailedToPartitionEngineError, gridfire::exceptions::HashingError, gridfire::exceptions::NetworkResizedError, gridfire::exceptions::PolicyError, gridfire::exceptions::StaleEngineError, gridfire::exceptions::StaleEngineTrigger, gridfire::exceptions::StaleJacobianError, gridfire::exceptions::UnableToSetNetworkReactionsError, gridfire::exceptions::UninitializedJacobianError, gridfire::exceptions::UnknownJacobianError
  • why() : gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger, gridfire::trigger::Trigger< TriggerContextStruct >
  • diff --git a/docs/html/functions_~.html b/docs/html/functions_~.html index 7c45e96c..cabab74e 100644 --- a/docs/html/functions_~.html +++ b/docs/html/functions_~.html @@ -111,12 +111,14 @@ $(function(){initNavTree('functions_~.html',''); initResizable(true); });
  • ~EveryNthTrigger() : gridfire::trigger::EveryNthTrigger< TriggerContextStruct >
  • ~Network() : gridfire::Network
  • ~NetworkFileParser() : gridfire::io::NetworkFileParser
  • +
  • ~NetworkPolicy() : gridfire::policy::NetworkPolicy
  • ~NetworkSolverStrategy() : gridfire::solver::NetworkSolverStrategy< EngineT >
  • ~NotTrigger() : gridfire::trigger::NotTrigger< TriggerContextStruct >
  • ~OrTrigger() : gridfire::trigger::OrTrigger< TriggerContextStruct >
  • ~PartitionFunction() : gridfire::partition::PartitionFunction
  • ~ReaclibReaction() : gridfire::reaction::ReaclibReaction
  • ~Reaction() : gridfire::reaction::Reaction, gridfire::Reaction
  • +
  • ~ReactionChainPolicy() : gridfire::policy::ReactionChainPolicy
  • ~ScreeningModel() : gridfire::screening::ScreeningModel
  • ~SolverContextBase() : gridfire::solver::SolverContextBase
  • ~SolverPluginInterface() : SolverPluginInterface
  • diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html index 0d7872bc..fc2a8737 100644 --- a/docs/html/hierarchy.html +++ b/docs/html/hierarchy.html @@ -151,8 +151,12 @@ $(function(){initNavTree('hierarchy.html',''); initResizable(true); });  Cgridfire::exceptions::StaleEngineError  Cgridfire::exceptions::StaleEngineTrigger  Cgridfire::exceptions::UnableToSetNetworkReactionsError - Cgridfire::exceptions::UtilityError - Cgridfire::exceptions::HashingError + Cgridfire::exceptions::PolicyErrorBase class for all exceptions related to network policy operations + Cgridfire::exceptions::MissingBaseReactionErrorException thrown when a required reaction is missing from the underlying database (e.g., REACLIB) + Cgridfire::exceptions::MissingKeyReactionErrorException thrown when a constructed network fails to include a key reaction required by the policy + Cgridfire::exceptions::MissingSeedSpeciesErrorException thrown when a required seed species is not found in the initial composition + Cgridfire::exceptions::UtilityError + Cgridfire::exceptions::HashingError  Cstd::hash< gridfire::QSECacheKey >  Cstd::hash< gridfire::rates::weak::TableAxes >  Cstd::hash< gridfire::reaction::Reaction > @@ -171,64 +175,73 @@ $(function(){initNavTree('hierarchy.html',''); initResizable(true); });  CPyNetworkFileParser  Cgridfire::io::MESANetworkFileParserA parser for MESA-format network files  Cgridfire::io::SimpleReactionListFileParserA parser for simple text files containing a list of reactions - Cgridfire::solver::NetworkSolverStrategy< EngineT >Abstract base class for network solver strategies - Cgridfire::solver::NetworkSolverStrategy< DynamicEngine > - CPyDynamicNetworkSolverStrategy - Cgridfire::solver::CVODESolverStrategyStiff ODE integrator backed by SUNDIALS CVODE (BDF) for network + energy - Cgridfire::approx8::ODEFunctor to calculate the derivatives for the ODE solver - Cgridfire::partition::PartitionFunctionAbstract interface for evaluating nuclear partition functions - CPyPartitionFunction - Cgridfire::partition::CompositePartitionFunctionCombines multiple PartitionFunction instances into a single composite strategy - Cgridfire::partition::GroundStatePartitionFunctionPartition function implementation for nuclear ground states - Cgridfire::partition::RauscherThielemannPartitionFunctionPartition function using Rauscher-Thielemann tabulated normalized G-values - Cfourdst::plugin::PluginBase - CSolverPluginInterface - Cgridfire::GraphEngine::PrecomputedReaction - Cgridfire::PrimingReportCaptures the result of a network priming operation - Cgridfire::QSECacheConfigConfiguration struct for the QSE cache - Cgridfire::QSECacheKeyKey struct for the QSE abundance cache - Cgridfire::MultiscalePartitioningEngineView::QSEGroupStruct representing a QSE group - Cgridfire::reaction::RateCoefficientSetHolds the seven coefficients for the REACLIB rate equation - Cgridfire::rates::weak::RateDataRowOne row of the unified weak-rate data table for a specific isotope and state - Cgridfire::partition::record::RauscherThielemannPartitionDataRecordPacked binary record of Rauscher-Thielemann partition function data for an isotope - Cgridfire::ReactionRepresents a single nuclear reaction from a specific data source - Cgridfire::rates::weak::WeakReactionConcrete Reaction representing a single weak process (beta±, e−/e+ capture) - Cgridfire::reaction::ReaclibReaction - Cgridfire::reaction::LogicalReaclibReactionRepresents a "logical" reaction that aggregates rates from multiple sources - Cgridfire::reaction::ReactionRepresents a single nuclear reaction from a specific data source - Cgridfire::rates::weak::WeakReactionConcrete Reaction representing a single weak process (beta±, e−/e+ capture) - Cgridfire::reaction::ReaclibReaction - Cgridfire::AdaptiveEngineView::ReactionFlowA struct to hold a reaction and its flow rate - Cgridfire::reaclib::ReactionRecord - Cgridfire::reaction::ReactionSet - Cgridfire::ReactionSet - Cgridfire::screening::ScreeningModelAn abstract base class for plasma screening models - CPyScreening - Cgridfire::screening::BareScreeningModelA screening model that applies no screening effect - Cgridfire::screening::IntermediateScreeningModel - Cgridfire::screening::WeakScreeningModelImplements the weak screening model based on the Debye-Hückel approximation - Cgridfire::solver::SolverContextBaseBase class for solver callback contexts - CPySolverContextBase - Cgridfire::solver::CVODESolverStrategy::TimestepContextImmutable view of the current integration state passed to callbacks - Cgridfire::exceptions::StaleEngineTrigger::state - Cgridfire::StepDerivatives< T >Structure holding derivatives and energy generation for a network step - Cgridfire::trigger::Trigger< TriggerContextStruct >Generic trigger interface for signaling events/conditions during integration - Cgridfire::trigger::LogicalTrigger< TriggerContextStruct > - Cgridfire::trigger::AndTrigger< TriggerContextStruct >Logical conjunction of two triggers with short-circuit evaluation - Cgridfire::trigger::EveryNthTrigger< TriggerContextStruct >Pass-through trigger that fires every Nth time its child trigger is true - Cgridfire::trigger::NotTrigger< TriggerContextStruct >Logical negation of a trigger - Cgridfire::trigger::OrTrigger< TriggerContextStruct >Logical disjunction of two triggers with short-circuit evaluation - Cgridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext > - Cgridfire::trigger::solver::CVODE::ConvergenceFailureTrigger - Cgridfire::trigger::solver::CVODE::OffDiagonalTriggerTriggers when any off-diagonal Jacobian entry magnitude exceeds a threshold - Cgridfire::trigger::solver::CVODE::SimulationTimeTriggerTriggers when the current simulation time advances by at least a fixed interval - Cgridfire::trigger::solver::CVODE::TimestepCollapseTriggerTriggers when the timestep deviates from its recent average beyond a threshold - Cgridfire::trigger::TriggerResult - Cgridfire::rates::weak::WeakRateDerivativesPartial derivatives of the log10() fields w.r.t. (T9, log10(rho*Ye)) - Cgridfire::rates::weak::WeakRateInterpolator3D table interpolator for tabulated weak reaction data by isotope - Cgridfire::rates::weak::WeakRatePayloadInterpolated weak-rate payload at a single state - Cgridfire::rates::weak::WeakReactionEntryA single weak-reaction data point (type, state, and log values) - Cgridfire::rates::weak::WeakReactionMapIndex of available weak reactions keyed by species + Cgridfire::policy::NetworkPolicyAbstract interface for policies that construct DynamicEngine networks from a seed composition + Cgridfire::policy::LowMassMainSequencePolicyA NetworkPolicy for building reaction networks suitable for low-mass main-sequence stars + Cgridfire::solver::NetworkSolverStrategy< EngineT >Abstract base class for network solver strategies + Cgridfire::solver::NetworkSolverStrategy< DynamicEngine > + CPyDynamicNetworkSolverStrategy + Cgridfire::solver::CVODESolverStrategyStiff ODE integrator backed by SUNDIALS CVODE (BDF) for network + energy + Cgridfire::approx8::ODEFunctor to calculate the derivatives for the ODE solver + Cgridfire::partition::PartitionFunctionAbstract interface for evaluating nuclear partition functions + CPyPartitionFunction + Cgridfire::partition::CompositePartitionFunctionCombines multiple PartitionFunction instances into a single composite strategy + Cgridfire::partition::GroundStatePartitionFunctionPartition function implementation for nuclear ground states + Cgridfire::partition::RauscherThielemannPartitionFunctionPartition function using Rauscher-Thielemann tabulated normalized G-values + Cfourdst::plugin::PluginBase + CSolverPluginInterface + Cgridfire::GraphEngine::PrecomputedReaction + Cgridfire::PrimingReportCaptures the result of a network priming operation + Cgridfire::io::gen::PyFunctionDef + Cgridfire::QSECacheConfigConfiguration struct for the QSE cache + Cgridfire::QSECacheKeyKey struct for the QSE abundance cache + Cgridfire::MultiscalePartitioningEngineView::QSEGroupStruct representing a QSE group + Cgridfire::reaction::RateCoefficientSetHolds the seven coefficients for the REACLIB rate equation + Cgridfire::rates::weak::RateDataRowOne row of the unified weak-rate data table for a specific isotope and state + Cgridfire::partition::record::RauscherThielemannPartitionDataRecordPacked binary record of Rauscher-Thielemann partition function data for an isotope + Cgridfire::ReactionRepresents a single nuclear reaction from a specific data source + Cgridfire::rates::weak::WeakReactionConcrete Reaction representing a single weak process (beta±, e−/e+ capture) + Cgridfire::reaction::ReaclibReaction + Cgridfire::reaction::LogicalReaclibReactionRepresents a "logical" reaction that aggregates rates from multiple sources + Cgridfire::reaction::ReactionRepresents a single nuclear reaction from a specific data source + Cgridfire::rates::weak::WeakReactionConcrete Reaction representing a single weak process (beta±, e−/e+ capture) + Cgridfire::reaction::ReaclibReaction + Cgridfire::policy::ReactionChainPolicyAbstract interface encapsulating a set of reactions representing a single chain or pathway + Cgridfire::policy::CNOChainPolicyA ReactionChainPolicy for the Carbon-Nitrogen-Oxygen (CNO) cycle + Cgridfire::policy::HotCNOChainPolicyA ReactionChainPolicy for the Hot CNO (HCNO) cycle + Cgridfire::policy::MultiReactionChainPolicyA ReactionChainPolicy composed of multiple child ReactionChainPolicy instances + Cgridfire::policy::LowMassMainSequenceReactionChainPolicyA MultiReactionChainPolicy for low-mass main-sequence stars + Cgridfire::policy::ProtonProtonChainPolicyA ReactionChainPolicy for the Proton-Proton (PP) chain + Cgridfire::AdaptiveEngineView::ReactionFlowA struct to hold a reaction and its flow rate + Cgridfire::reaclib::ReactionRecord + Cgridfire::reaction::ReactionSet + Cgridfire::ReactionSet + Cgridfire::screening::ScreeningModelAn abstract base class for plasma screening models + CPyScreening + Cgridfire::screening::BareScreeningModelA screening model that applies no screening effect + Cgridfire::screening::IntermediateScreeningModel + Cgridfire::screening::WeakScreeningModelImplements the weak screening model based on the Debye-Hückel approximation + Cgridfire::solver::SolverContextBaseBase class for solver callback contexts + CPySolverContextBase + Cgridfire::solver::CVODESolverStrategy::TimestepContextImmutable view of the current integration state passed to callbacks + Cgridfire::exceptions::StaleEngineTrigger::state + Cgridfire::StepDerivatives< T >Structure holding derivatives and energy generation for a network step + Cgridfire::trigger::Trigger< TriggerContextStruct >Generic trigger interface for signaling events/conditions during integration + Cgridfire::trigger::LogicalTrigger< TriggerContextStruct > + Cgridfire::trigger::AndTrigger< TriggerContextStruct >Logical conjunction of two triggers with short-circuit evaluation + Cgridfire::trigger::EveryNthTrigger< TriggerContextStruct >Pass-through trigger that fires every Nth time its child trigger is true + Cgridfire::trigger::NotTrigger< TriggerContextStruct >Logical negation of a trigger + Cgridfire::trigger::OrTrigger< TriggerContextStruct >Logical disjunction of two triggers with short-circuit evaluation + Cgridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext > + Cgridfire::trigger::solver::CVODE::ConvergenceFailureTrigger + Cgridfire::trigger::solver::CVODE::OffDiagonalTriggerTriggers when any off-diagonal Jacobian entry magnitude exceeds a threshold + Cgridfire::trigger::solver::CVODE::SimulationTimeTriggerTriggers when the current simulation time advances by at least a fixed interval + Cgridfire::trigger::solver::CVODE::TimestepCollapseTriggerTriggers when the timestep deviates from its recent average beyond a threshold + Cgridfire::trigger::TriggerResult + Cgridfire::rates::weak::WeakRateDerivativesPartial derivatives of the log10() fields w.r.t. (T9, log10(rho*Ye)) + Cgridfire::rates::weak::WeakRateInterpolator3D table interpolator for tabulated weak reaction data by isotope + Cgridfire::rates::weak::WeakRatePayloadInterpolated weak-rate payload at a single state + Cgridfire::rates::weak::WeakReactionEntryA single weak-reaction data point (type, state, and log values) + Cgridfire::rates::weak::WeakReactionMapIndex of available weak reactions keyed by species diff --git a/docs/html/hierarchy.js b/docs/html/hierarchy.js index 3f904931..78df1bc6 100644 --- a/docs/html/hierarchy.js +++ b/docs/html/hierarchy.js @@ -58,6 +58,11 @@ var hierarchy = [ "gridfire::exceptions::StaleEngineTrigger", "classgridfire_1_1exceptions_1_1_stale_engine_trigger.html", null ], [ "gridfire::exceptions::UnableToSetNetworkReactionsError", "classgridfire_1_1exceptions_1_1_unable_to_set_network_reactions_error.html", null ] ] ], + [ "gridfire::exceptions::PolicyError", "classgridfire_1_1exceptions_1_1_policy_error.html", [ + [ "gridfire::exceptions::MissingBaseReactionError", "classgridfire_1_1exceptions_1_1_missing_base_reaction_error.html", null ], + [ "gridfire::exceptions::MissingKeyReactionError", "classgridfire_1_1exceptions_1_1_missing_key_reaction_error.html", null ], + [ "gridfire::exceptions::MissingSeedSpeciesError", "classgridfire_1_1exceptions_1_1_missing_seed_species_error.html", null ] + ] ], [ "gridfire::exceptions::UtilityError", "classgridfire_1_1exceptions_1_1_utility_error.html", [ [ "gridfire::exceptions::HashingError", "classgridfire_1_1exceptions_1_1_hashing_error.html", null ] ] ] @@ -82,6 +87,9 @@ var hierarchy = [ "gridfire::io::MESANetworkFileParser", "classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.html", null ], [ "gridfire::io::SimpleReactionListFileParser", "classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html", null ] ] ], + [ "gridfire::policy::NetworkPolicy", "classgridfire_1_1policy_1_1_network_policy.html", [ + [ "gridfire::policy::LowMassMainSequencePolicy", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html", null ] + ] ], [ "gridfire::solver::NetworkSolverStrategy< EngineT >", "classgridfire_1_1solver_1_1_network_solver_strategy.html", null ], [ "gridfire::solver::NetworkSolverStrategy< DynamicEngine >", "classgridfire_1_1solver_1_1_network_solver_strategy.html", [ [ "PyDynamicNetworkSolverStrategy", "class_py_dynamic_network_solver_strategy.html", null ], @@ -99,6 +107,7 @@ var hierarchy = ] ], [ "gridfire::GraphEngine::PrecomputedReaction", "structgridfire_1_1_graph_engine_1_1_precomputed_reaction.html", null ], [ "gridfire::PrimingReport", "structgridfire_1_1_priming_report.html", null ], + [ "gridfire::io::gen::PyFunctionDef", "structgridfire_1_1io_1_1gen_1_1_py_function_def.html", null ], [ "gridfire::QSECacheConfig", "structgridfire_1_1_q_s_e_cache_config.html", null ], [ "gridfire::QSECacheKey", "structgridfire_1_1_q_s_e_cache_key.html", null ], [ "gridfire::MultiscalePartitioningEngineView::QSEGroup", "structgridfire_1_1_multiscale_partitioning_engine_view_1_1_q_s_e_group.html", null ], @@ -115,6 +124,14 @@ var hierarchy = [ "gridfire::rates::weak::WeakReaction", "classgridfire_1_1rates_1_1weak_1_1_weak_reaction.html", null ], [ "gridfire::reaction::ReaclibReaction", "classgridfire_1_1reaction_1_1_reaclib_reaction.html", null ] ] ], + [ "gridfire::policy::ReactionChainPolicy", "classgridfire_1_1policy_1_1_reaction_chain_policy.html", [ + [ "gridfire::policy::CNOChainPolicy", "classgridfire_1_1policy_1_1_c_n_o_chain_policy.html", null ], + [ "gridfire::policy::HotCNOChainPolicy", "classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy.html", null ], + [ "gridfire::policy::MultiReactionChainPolicy", "classgridfire_1_1policy_1_1_multi_reaction_chain_policy.html", [ + [ "gridfire::policy::LowMassMainSequenceReactionChainPolicy", "classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy.html", null ] + ] ], + [ "gridfire::policy::ProtonProtonChainPolicy", "classgridfire_1_1policy_1_1_proton_proton_chain_policy.html", null ] + ] ], [ "gridfire::AdaptiveEngineView::ReactionFlow", "structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html", null ], [ "gridfire::reaclib::ReactionRecord", "structgridfire_1_1reaclib_1_1_reaction_record.html", null ], [ "gridfire::reaction::ReactionSet", "classgridfire_1_1reaction_1_1_reaction_set.html", null ], diff --git a/docs/html/menudata.js b/docs/html/menudata.js index f5dd9e24..9477e199 100644 --- a/docs/html/menudata.js +++ b/docs/html/menudata.js @@ -52,6 +52,7 @@ var menudata={children:[ {text:"b",url:"namespacemembers_func.html#index_b"}, {text:"c",url:"namespacemembers_func.html#index_c"}, {text:"d",url:"namespacemembers_func.html#index_d"}, +{text:"e",url:"namespacemembers_func.html#index_e"}, {text:"f",url:"namespacemembers_func.html#index_f"}, {text:"g",url:"namespacemembers_func.html#index_g"}, {text:"h",url:"namespacemembers_func.html#index_h"}, diff --git a/docs/html/namespacegridfire.html b/docs/html/namespacegridfire.html index ad4b2686..81f116ef 100644 --- a/docs/html/namespacegridfire.html +++ b/docs/html/namespacegridfire.html @@ -125,6 +125,8 @@ Namespaces   namespace  partition   +namespace  policy +  namespace  rates   namespace  reaclib diff --git a/docs/html/namespacegridfire.js b/docs/html/namespacegridfire.js index ae426fec..102d5857 100644 --- a/docs/html/namespacegridfire.js +++ b/docs/html/namespacegridfire.js @@ -10,6 +10,7 @@ var namespacegridfire = [ "expectations", "namespacegridfire_1_1expectations.html", "namespacegridfire_1_1expectations" ], [ "io", "namespacegridfire_1_1io.html", "namespacegridfire_1_1io" ], [ "partition", "namespacegridfire_1_1partition.html", "namespacegridfire_1_1partition" ], + [ "policy", "namespacegridfire_1_1policy.html", "namespacegridfire_1_1policy" ], [ "rates", "namespacegridfire_1_1rates.html", "namespacegridfire_1_1rates" ], [ "reaclib", "namespacegridfire_1_1reaclib.html", "namespacegridfire_1_1reaclib" ], [ "reaction", "namespacegridfire_1_1reaction.html", "namespacegridfire_1_1reaction" ], diff --git a/docs/html/namespacegridfire_1_1exceptions.html b/docs/html/namespacegridfire_1_1exceptions.html index 4cc93aa3..3c474f3c 100644 --- a/docs/html/namespacegridfire_1_1exceptions.html +++ b/docs/html/namespacegridfire_1_1exceptions.html @@ -117,8 +117,20 @@ Classes   class  JacobianError   +class  MissingBaseReactionError + Exception thrown when a required reaction is missing from the underlying database (e.g., REACLIB). More...
    +  +class  MissingKeyReactionError + Exception thrown when a constructed network fails to include a key reaction required by the policy. More...
    +  +class  MissingSeedSpeciesError + Exception thrown when a required seed species is not found in the initial composition. More...
    +  class  NetworkResizedError   +class  PolicyError + Base class for all exceptions related to network policy operations. More...
    +  class  StaleEngineError   class  StaleEngineTrigger diff --git a/docs/html/namespacegridfire_1_1exceptions.js b/docs/html/namespacegridfire_1_1exceptions.js index ac36aa04..b4c190bb 100644 --- a/docs/html/namespacegridfire_1_1exceptions.js +++ b/docs/html/namespacegridfire_1_1exceptions.js @@ -5,7 +5,11 @@ var namespacegridfire_1_1exceptions = [ "FailedToPartitionEngineError", "classgridfire_1_1exceptions_1_1_failed_to_partition_engine_error.html", "classgridfire_1_1exceptions_1_1_failed_to_partition_engine_error" ], [ "HashingError", "classgridfire_1_1exceptions_1_1_hashing_error.html", "classgridfire_1_1exceptions_1_1_hashing_error" ], [ "JacobianError", "classgridfire_1_1exceptions_1_1_jacobian_error.html", null ], + [ "MissingBaseReactionError", "classgridfire_1_1exceptions_1_1_missing_base_reaction_error.html", "classgridfire_1_1exceptions_1_1_missing_base_reaction_error" ], + [ "MissingKeyReactionError", "classgridfire_1_1exceptions_1_1_missing_key_reaction_error.html", "classgridfire_1_1exceptions_1_1_missing_key_reaction_error" ], + [ "MissingSeedSpeciesError", "classgridfire_1_1exceptions_1_1_missing_seed_species_error.html", "classgridfire_1_1exceptions_1_1_missing_seed_species_error" ], [ "NetworkResizedError", "classgridfire_1_1exceptions_1_1_network_resized_error.html", "classgridfire_1_1exceptions_1_1_network_resized_error" ], + [ "PolicyError", "classgridfire_1_1exceptions_1_1_policy_error.html", "classgridfire_1_1exceptions_1_1_policy_error" ], [ "StaleEngineError", "classgridfire_1_1exceptions_1_1_stale_engine_error.html", "classgridfire_1_1exceptions_1_1_stale_engine_error" ], [ "StaleEngineTrigger", "classgridfire_1_1exceptions_1_1_stale_engine_trigger.html", "classgridfire_1_1exceptions_1_1_stale_engine_trigger" ], [ "StaleJacobianError", "classgridfire_1_1exceptions_1_1_stale_jacobian_error.html", "classgridfire_1_1exceptions_1_1_stale_jacobian_error" ], diff --git a/docs/html/namespacegridfire_1_1io.html b/docs/html/namespacegridfire_1_1io.html index 9d404e22..6d2dc163 100644 --- a/docs/html/namespacegridfire_1_1io.html +++ b/docs/html/namespacegridfire_1_1io.html @@ -100,12 +100,18 @@ $(function(){initNavTree('namespacegridfire_1_1io.html',''); initResizable(true)
    +Namespaces | Classes | Typedefs
    gridfire::io Namespace Reference
    + + + +

    +Namespaces

    namespace  gen
     
    diff --git a/docs/html/namespacegridfire_1_1io.js b/docs/html/namespacegridfire_1_1io.js index d829cf5b..06771160 100644 --- a/docs/html/namespacegridfire_1_1io.js +++ b/docs/html/namespacegridfire_1_1io.js @@ -1,5 +1,6 @@ var namespacegridfire_1_1io = [ + [ "gen", "namespacegridfire_1_1io_1_1gen.html", "namespacegridfire_1_1io_1_1gen" ], [ "MESANetworkFileParser", "classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.html", "classgridfire_1_1io_1_1_m_e_s_a_network_file_parser" ], [ "NetworkFileParser", "classgridfire_1_1io_1_1_network_file_parser.html", "classgridfire_1_1io_1_1_network_file_parser" ], [ "SimpleReactionListFileParser", "classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html", "classgridfire_1_1io_1_1_simple_reaction_list_file_parser" ], diff --git a/docs/html/namespacegridfire_1_1io_1_1gen.html b/docs/html/namespacegridfire_1_1io_1_1gen.html new file mode 100644 index 00000000..b64aee5b --- /dev/null +++ b/docs/html/namespacegridfire_1_1io_1_1gen.html @@ -0,0 +1,189 @@ + + + + + + + +GridFire: gridfire::io::gen Namespace Reference + + + + + + + + + + + + + + + + + +
    +
    +

    Classes

    class  MESANetworkFileParser
    + + + + + +
    +
    GridFire v0.7.0-alpha +
    +
    General Purpose Nuclear Network
    +
    +
    + + + + + + + + + +
    + +
    +
    +
    + +
    + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + +
    + +
    gridfire::io::gen Namespace Reference
    +
    +
    + + + + +

    +Classes

    struct  PyFunctionDef
     
    + + + + + + + +

    +Functions

    PyFunctionDef exportReactionToPy (const reaction::Reaction &reaction)
     
    std::string exportEngineToPy (const DynamicEngine &engine)
     
    void exportEngineToPy (const DynamicEngine &engine, const std::string &fileName)
     
    +

    Function Documentation

    + +

    ◆ exportEngineToPy() [1/2]

    + +
    +
    + + + + + + + +
    std::string gridfire::io::gen::exportEngineToPy (const DynamicEngine & engine)
    +
    + +
    +
    + +

    ◆ exportEngineToPy() [2/2]

    + +
    +
    + + + + + + + + + + + +
    void gridfire::io::gen::exportEngineToPy (const DynamicEngine & engine,
    const std::string & fileName )
    +
    + +
    +
    + +

    ◆ exportReactionToPy()

    + +
    +
    + + + + + + + +
    PyFunctionDef gridfire::io::gen::exportReactionToPy (const reaction::Reaction & reaction)
    +
    + +
    +
    +
    +
    + + + + diff --git a/docs/html/namespacegridfire_1_1io_1_1gen.js b/docs/html/namespacegridfire_1_1io_1_1gen.js new file mode 100644 index 00000000..bf3e2d33 --- /dev/null +++ b/docs/html/namespacegridfire_1_1io_1_1gen.js @@ -0,0 +1,7 @@ +var namespacegridfire_1_1io_1_1gen = +[ + [ "PyFunctionDef", "structgridfire_1_1io_1_1gen_1_1_py_function_def.html", "structgridfire_1_1io_1_1gen_1_1_py_function_def" ], + [ "exportEngineToPy", "namespacegridfire_1_1io_1_1gen.html#ab8969bfd2c29b0497886fbbee91cba49", null ], + [ "exportEngineToPy", "namespacegridfire_1_1io_1_1gen.html#aae1daede9709cb8e4d5a8a086d5a94ea", null ], + [ "exportReactionToPy", "namespacegridfire_1_1io_1_1gen.html#aed61026cbd83e7a15565e4a0ad0849b9", null ] +]; \ No newline at end of file diff --git a/docs/html/namespacegridfire_1_1policy.html b/docs/html/namespacegridfire_1_1policy.html new file mode 100644 index 00000000..b4426b81 --- /dev/null +++ b/docs/html/namespacegridfire_1_1policy.html @@ -0,0 +1,193 @@ + + + + + + + +GridFire: gridfire::policy Namespace Reference + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    GridFire v0.7.0-alpha +
    +
    General Purpose Nuclear Network
    +
    +
    + + + + + + + + +
    +
    + +
    +
    +
    + +
    + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + +
    + +
    gridfire::policy Namespace Reference
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Classes

    class  CNOChainPolicy
     A ReactionChainPolicy for the Carbon-Nitrogen-Oxygen (CNO) cycle. More...
     
    class  HotCNOChainPolicy
     A ReactionChainPolicy for the Hot CNO (HCNO) cycle. More...
     
    class  LowMassMainSequencePolicy
     A NetworkPolicy for building reaction networks suitable for low-mass main-sequence stars. More...
     
    class  LowMassMainSequenceReactionChainPolicy
     A MultiReactionChainPolicy for low-mass main-sequence stars. More...
     
    class  MultiReactionChainPolicy
     A ReactionChainPolicy composed of multiple child ReactionChainPolicy instances. More...
     
    class  NetworkPolicy
     Abstract interface for policies that construct DynamicEngine networks from a seed composition. More...
     
    class  ProtonProtonChainPolicy
     A ReactionChainPolicy for the Proton-Proton (PP) chain. More...
     
    class  ReactionChainPolicy
     Abstract interface encapsulating a set of reactions representing a single chain or pathway. More...
     
    + + + + +

    +Enumerations

    enum class  NetworkPolicyStatus {
    +  UNINITIALIZED +, INITIALIZED_UNVERIFIED +, MISSING_KEY_REACTION +, MISSING_KEY_SPECIES +,
    +  INITIALIZED_VERIFIED +
    + }
     Lifecycle/verification status for a NetworkPolicy instance. More...
     
    +

    Enumeration Type Documentation

    + +

    ◆ NetworkPolicyStatus

    + +
    +
    + + + + + +
    + + + + +
    enum class gridfire::policy::NetworkPolicyStatus
    +
    +strong
    +
    + +

    Lifecycle/verification status for a NetworkPolicy instance.

    +

    Used by concrete NetworkPolicy implementations to report the state of the policy and the constructed network during/after construction. Tests and callers can inspect the status to determine whether the resulting network meets the policy's requirements.

    + + + + + + +
    Enumerator
    UNINITIALIZED 
    INITIALIZED_UNVERIFIED 
    MISSING_KEY_REACTION 
    MISSING_KEY_SPECIES 
    INITIALIZED_VERIFIED 
    + +
    +
    +
    +
    + + + + diff --git a/docs/html/namespacegridfire_1_1policy.js b/docs/html/namespacegridfire_1_1policy.js new file mode 100644 index 00000000..a57d8a40 --- /dev/null +++ b/docs/html/namespacegridfire_1_1policy.js @@ -0,0 +1,18 @@ +var namespacegridfire_1_1policy = +[ + [ "CNOChainPolicy", "classgridfire_1_1policy_1_1_c_n_o_chain_policy.html", "classgridfire_1_1policy_1_1_c_n_o_chain_policy" ], + [ "HotCNOChainPolicy", "classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy.html", "classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy" ], + [ "LowMassMainSequencePolicy", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy.html", "classgridfire_1_1policy_1_1_low_mass_main_sequence_policy" ], + [ "LowMassMainSequenceReactionChainPolicy", "classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy.html", "classgridfire_1_1policy_1_1_low_mass_main_sequence_reaction_chain_policy" ], + [ "MultiReactionChainPolicy", "classgridfire_1_1policy_1_1_multi_reaction_chain_policy.html", "classgridfire_1_1policy_1_1_multi_reaction_chain_policy" ], + [ "NetworkPolicy", "classgridfire_1_1policy_1_1_network_policy.html", "classgridfire_1_1policy_1_1_network_policy" ], + [ "ProtonProtonChainPolicy", "classgridfire_1_1policy_1_1_proton_proton_chain_policy.html", "classgridfire_1_1policy_1_1_proton_proton_chain_policy" ], + [ "ReactionChainPolicy", "classgridfire_1_1policy_1_1_reaction_chain_policy.html", "classgridfire_1_1policy_1_1_reaction_chain_policy" ], + [ "NetworkPolicyStatus", "namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109", [ + [ "UNINITIALIZED", "namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109add652546039b18970b8dcf2cff824268", null ], + [ "INITIALIZED_UNVERIFIED", "namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109af8392674ffb9a1455835c2cd5eb3f5ae", null ], + [ "MISSING_KEY_REACTION", "namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109a2f017cce8fa4a6b50e2034ff16d1eda3", null ], + [ "MISSING_KEY_SPECIES", "namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109ae0584675cd48c19691ed09c98b2d2730", null ], + [ "INITIALIZED_VERIFIED", "namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109aff6473ea13033c0680a084b372f5755e", null ] + ] ] +]; \ No newline at end of file diff --git a/docs/html/namespacemembers.html b/docs/html/namespacemembers.html index ed66d2e5..acd24f0b 100644 --- a/docs/html/namespacemembers.html +++ b/docs/html/namespacemembers.html @@ -133,6 +133,8 @@ $(function(){initNavTree('namespacemembers.html',''); initResizable(true); });

    - e -

    @@ -194,6 +196,7 @@ $(function(){initNavTree('namespacemembers.html',''); initResizable(true); });
  • NetworkConstructionFlags : gridfire
  • NetworkConstructionFlagsToString() : gridfire
  • NetworkFormat : gridfire
  • +
  • NetworkPolicyStatus : gridfire::policy
  • NeutrinoTypes : gridfire::rates::weak
  • diff --git a/docs/html/namespacemembers_enum.html b/docs/html/namespacemembers_enum.html index 9e0dc187..80b457eb 100644 --- a/docs/html/namespacemembers_enum.html +++ b/docs/html/namespacemembers_enum.html @@ -106,6 +106,7 @@ $(function(){initNavTree('namespacemembers_enum.html',''); initResizable(true);
  • NetworkBuildDepth : gridfire
  • NetworkConstructionFlags : gridfire
  • NetworkFormat : gridfire
  • +
  • NetworkPolicyStatus : gridfire::policy
  • NeutrinoTypes : gridfire::rates::weak
  • PrimingReportStatus : gridfire
  • ReactionType : gridfire::reaction
  • diff --git a/docs/html/namespacemembers_func.html b/docs/html/namespacemembers_func.html index 63a474d4..a8e58307 100644 --- a/docs/html/namespacemembers_func.html +++ b/docs/html/namespacemembers_func.html @@ -121,6 +121,12 @@ $(function(){initNavTree('namespacemembers_func.html',''); initResizable(true); +

    - e -

    + +

    - f -