diff --git a/docs/html/____init_____8py.html b/docs/html/____init_____8py.html index 1d94d459..9a3c4830 100644 --- a/docs/html/____init_____8py.html +++ b/docs/html/____init_____8py.html @@ -3,16 +3,18 @@
- +Namespaces | |
| namespace | gridfire |
| namespace | gridfire |
+Functions | |
| gridfire.gf_metadata () | |
| gridfire.gf_version () | |
| gridfire.gf_author () | |
| gridfire.gf_license () | |
| gridfire.gf_email () | |
| gridfire.gf_url () | |
| gridfire.gf_description () | |
| gridfire.gf_collaboration () | |
| gridfire.gf_credits () | |
Variables | |
| list | gridfire.__all__ = ['type', 'utils', 'engine', 'solver', 'exceptions', 'partition', 'reaction', 'screening', 'io', 'policy'] |
| list | gridfire.__all__ = ['type', 'utils', 'engine', 'solver', 'exceptions', 'partition', 'reaction', 'screening', 'io', 'policy', 'config'] |
| str | gridfire.__version__ = "v0.7.1_rc2" |
| gridfire._meta = importlib.metadata.metadata('gridfire') | |
| gridfire.__version__ = _meta['Version'] | |
| gridfire.__author__ = _meta['Author'] | |
| gridfire.__license__ = _meta['License'] | |
| gridfire.__email__ = _meta['Author-email'] | |
| gridfire.__url__ = _meta['Home-page'] or _meta.get('Project-URL', '').split(',')[0].split(' ')[-1].strip() | |
| gridfire.__description__ = _meta['Summary'] | |
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
#include "gridfire/solver/strategies/GridSolver.h"#include "gridfire/exceptions/error_solver.h"#include "gridfire/solver/strategies/PointSolver.h"#include "gridfire/utils/macros.h"#include "gridfire/utils/gf_omp.h"#include <cstdio>#include <print>+Namespaces | |
| namespace | gridfire |
| namespace | gridfire::solver |
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
+Classes | |
| struct | gridfire::solver::GridSolverContext |
| class | gridfire::solver::GridSolver |
+Namespaces | |
| namespace | gridfire |
| namespace | gridfire::solver |
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
#include "gridfire/solver/strategies/PointSolver.h"#include "gridfire/types/types.h"#include "gridfire/utils/table_format.h"#include "gridfire/engine/diagnostics/dynamic_engine_diagnostics.h"#include "quill/LogMacros.h"#include "fourdst/composition/composition.h"#include <cstdint>#include <limits>#include <string>#include <unordered_map>#include <stdexcept>#include <algorithm>#include "fourdst/atomic/species.h"#include "fourdst/composition/exceptions/exceptions_composition.h"#include "gridfire/engine/engine_graph.h"#include "gridfire/solver/strategies/triggers/engine_partitioning_trigger.h"#include "gridfire/trigger/procedures/trigger_pprint.h"#include "gridfire/exceptions/error_solver.h"#include "gridfire/utils/sundials.h"#include "gridfire/config/config.h"+Namespaces | |
| namespace | gridfire |
| namespace | gridfire::solver |
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
#include "gridfire/solver/strategies/strategy_abstract.h"#include "gridfire/engine/engine_abstract.h"#include "gridfire/types/types.h"#include "gridfire/exceptions/exceptions.h"#include "gridfire/config/config.h"#include "fourdst/atomic/atomicSpecies.h"#include "fourdst/config/config.h"#include <functional>#include <any>#include <string>#include <vector>#include <tuple>#include <cvode/cvode.h>#include <sundials/sundials_types.h>#include <sundials/sundials_context.h>#include <sunmatrix/sunmatrix_dense.h>#include <sunlinsol/sunlinsol_dense.h>#include <nvector/nvector_serial.h>+Classes | |
| struct | gridfire::solver::PointSolverTimestepContext |
| struct | gridfire::solver::PointSolverContext |
| class | gridfire::solver::PointSolver |
| Stiff ODE integrator backed by SUNDIALS CVODE (BDF) for network + energy. More... | |
| struct | gridfire::solver::PointSolver::CVODEUserData |
| A helper struct to pass C++ context to C-style CVODE callbacks. More... | |
| struct | gridfire::solver::PointSolver::CVODERHSOutputData |
+Namespaces | |
| namespace | gridfire |
| namespace | gridfire::solver |
+Typedefs | |
| using | gridfire::solver::TimestepCallback = std::function<void(const PointSolverTimestepContext& context)> |
| Type alias for a timestep callback function. | |
| ▼Ngridfire | |
| ►Nengine | |
| ►Nexceptions | Namespace for GridFire exception classes. All custom exceptions defined in GridFire inherit from std::exception and are organized within this namespace for clarity and modularity |
| ►Nio | |
| ►Npartition | |
| ►Npolicy | |
| ►Nrates | |
| ►Nreaclib | |
| ►Nreaction | |
| ►Nscreening | |
| ►Nsolver | |
| ►Ntrigger | |
| ►Nutils | |
| CNetIn | |
| CNetOut | |
| ▼Mgridfire_mod | |
| Cgf_construct_engine_from_policy | |
| Cgf_construct_solver_from_engine | |
| Cgf_evolve | |
| Cgf_free | |
| Cgf_get_last_error_message | |
| Cgf_init | |
| Cgf_register_species | |
| Cgridfire | |
| ▼Nstd | STL namespace |
| Cformatter< gridfire::engine::NetworkJacobian > | |
| Chash< gridfire::rates::weak::TableAxes > | |
| Chash< gridfire::reaction::Reaction > | |
| Chash< gridfire::reaction::ReactionSet > | |
| CGridFireContext | |
| CPyDynamicEngine | |
| CPyDynamicEngineView | |
| CPyDynamicNetworkSolverStrategy | |
| CPyEngine | |
| CPyEngineView | |
| CPyNetworkFileParser | |
| CPyNetworkPolicy | |
| CPyPartitionFunction | |
| CPyReactionChainPolicy | |
| CPyScreening | |
| CPySolverContextBase | |
| CSolverPluginInterface | |
|
- GridFire v0.7.1_rc2
+ GridFire v0.7.6rc4.0
General Purpose Nuclear Network
|
@@ -36,19 +38,24 @@
#include "types/bindings.h"#include "partition/bindings.h"#include "engine/bindings.h"#include "engine/scratchpads/bindings.h"#include "exceptions/bindings.h"#include "io/bindings.h"#include "reaction/bindings.h"#include "solver/bindings.h"#include "utils/bindings.h"#include "policy/bindings.h"#include "config/bindings.h"Functions | |
| PYBIND11_MODULE (_gridfire, m) | |
| PYBIND11_MODULE (_gridfire, m) | |
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
Container class for managing multiple scratchpad instances. +More...
+#include "gridfire/engine/scratchpads/scratchpad_abstract.h"#include "gridfire/engine/scratchpads/types.h"#include "gridfire/exceptions/error_scratchpad.h"#include <unordered_map>#include <memory>#include <expected>#include <unordered_set>+Classes | |
| class | gridfire::engine::scratch::StateBlob |
| Container for managing a collection of typed scratchpad instances. More... | |
+Namespaces | |
| namespace | gridfire |
| namespace | gridfire::engine |
| namespace | gridfire::engine::scratch |
| Scratchpad memory management for computational engines. | |
+Concepts | |
| concept | gridfire::engine::scratch::IsScratchPad |
| Concept that constrains types to valid scratchpad implementations. | |
Container class for managing multiple scratchpad instances.
+This header defines the StateBlob class, which serves as a centralized registry for managing multiple scratchpad instances used by computational engines. It provides type-safe enrollment, retrieval, and cloning of scratchpads using compile-time type checking via C++20 concepts.
+Namespaces | |
| namespace | gridfire |
| namespace | gridfire |
| namespace | gridfire::engine |
| namespace | gridfire::engine |
Typedefs | |
| using | gridfire::engine::BuildDepthType = std::variant< NetworkBuildDepth, int > |
| Variant specifying either a predefined NetworkBuildDepth or a custom integer depth. | |
| using | gridfire::engine::BuildDepthType = std::variant<NetworkBuildDepth, int> |
| Variant specifying either a predefined NetworkBuildDepth or a custom integer depth. | |
Enumerations | ||||||||||||||||||||||||||||||||||||||||||
|
- GridFire v0.7.0_rc2
+ GridFire v0.7.6rc4.0
General Purpose Nuclear Network
|
diff --git a/docs/html/class_py_network_file_parser.html b/docs/html/class_py_network_file_parser.html
index 232c5274..145be29e 100644
--- a/docs/html/class_py_network_file_parser.html
+++ b/docs/html/class_py_network_file_parser.html
@@ -29,7 +29,7 @@
||||||||||||||||||||||||||||||||||||||||||
|
- GridFire v0.7.0_rc2
+ GridFire v0.7.6rc4.0
General Purpose Nuclear Network
|
diff --git a/docs/html/class_py_network_policy-members.html b/docs/html/class_py_network_policy-members.html
index 407dd53b..efafe23c 100644
--- a/docs/html/class_py_network_policy-members.html
+++ b/docs/html/class_py_network_policy-members.html
@@ -29,7 +29,7 @@
||||||||||||||||||||||||||||||||||||||||||
|
- GridFire v0.7.0_rc2
+ GridFire v0.7.6rc4.0
General Purpose Nuclear Network
|
@@ -105,15 +105,16 @@ $(function(){initNavTree('class_py_network_policy.html',''); initResizable(true)
||||||||||||||||||||||||||||||||||||||||||
| construct() override | PyNetworkPolicy | virtual |
| construct() override | PyNetworkPolicy | virtual |
| get_engine_stack() const override | PyNetworkPolicy | virtual |
| get_engine_types_stack() const override | PyNetworkPolicy | virtual |
| get_partition_function() const override | PyNetworkPolicy | virtual |
| get_seed_reactions() const override | PyNetworkPolicy | virtual |
| get_seed_species() const override | PyNetworkPolicy | virtual |
| get_status() const override | PyNetworkPolicy | virtual |
| name() const override | PyNetworkPolicy | virtual |
| ~NetworkPolicy()=default | gridfire::policy::NetworkPolicy | virtual |
| get_stack_scratch_blob() const override | PyNetworkPolicy | virtual |
| get_status() const override | PyNetworkPolicy | virtual |
| name() const override | PyNetworkPolicy | virtual |
| ~NetworkPolicy()=default | gridfire::policy::NetworkPolicy | virtual |
Public Member Functions inherited from gridfire::policy::NetworkPolicy| gridfire::engine::DynamicEngine & PyNetworkPolicy::construct | +gridfire::policy::ConstructionResults PyNetworkPolicy::construct | ( | ) | @@ -185,7 +187,7 @@ Public Member Functions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+
|
+ +nodiscardoverridevirtual | +
Implements gridfire::policy::NetworkPolicy.
+|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
This is the complete list of members for PySingleZoneDynamicNetworkSolver, including all inherited members.
+| evaluate(gridfire::solver::SolverContextBase &solver_ctx, const gridfire::NetIn &netIn) const override | PySingleZoneDynamicNetworkSolver | virtual |
| m_engine | gridfire::solver::SingleZoneNetworkSolver< engine::DynamicEngine > | protected |
| m_engine | gridfire::solver::SingleZoneNetworkSolver< engine::DynamicEngine > | protected |
| PySingleZoneDynamicNetworkSolver(const gridfire::engine::DynamicEngine &engine) | PySingleZoneDynamicNetworkSolver | inlineexplicit |
| SingleZoneNetworkSolver(const EngineT &engine) | gridfire::solver::SingleZoneNetworkSolver< engine::DynamicEngine > | inlineexplicit |
| SingleZoneNetworkSolver(const EngineT &engine) | gridfire::solver::SingleZoneNetworkSolver< engine::DynamicEngine > | inlineexplicit |
| ~SingleZoneNetworkSolver()=default | gridfire::solver::SingleZoneNetworkSolver< engine::DynamicEngine > | virtual |
| ~SingleZoneNetworkSolver()=default | gridfire::solver::SingleZoneNetworkSolver< engine::DynamicEngine > | virtual |
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
#include <py_solver.h>
+Public Member Functions | |
| PySingleZoneDynamicNetworkSolver (const gridfire::engine::DynamicEngine &engine) | |
| gridfire::NetOut | evaluate (gridfire::solver::SolverContextBase &solver_ctx, const gridfire::NetIn &netIn) const override |
| Evaluates the network for a given timestep. | |
Public Member Functions inherited from gridfire::solver::SingleZoneNetworkSolver< engine::DynamicEngine > | |
| SingleZoneNetworkSolver (const EngineT &engine) | |
| Constructor for the NetworkSolverStrategy. | |
| virtual | ~SingleZoneNetworkSolver ()=default |
| Virtual destructor. | |
| SingleZoneNetworkSolver (const EngineT &engine) | |
| Constructor for the NetworkSolverStrategy. | |
| virtual | ~SingleZoneNetworkSolver ()=default |
| Virtual destructor. | |
+Additional Inherited Members | |
Protected Attributes inherited from gridfire::solver::SingleZoneNetworkSolver< engine::DynamicEngine > | |
| const EngineT & | m_engine |
| The engine used by this solver strategy. | |
| const EngineT & | m_engine |
| The engine used by this solver strategy. | |
+
|
+ +inlineexplicit | +
+
|
+ +overridevirtual | +
Evaluates the network for a given timestep.
+| solver_ctx | |
| engine_ctx | |
| netIn | The input conditions for the network. |
Implements gridfire::solver::SingleZoneNetworkSolver< engine::DynamicEngine >.
+ +This is the complete list of members for PySolverContextBase, including all inherited members.
| describe() const override | PySolverContextBase | virtual |
| ~SolverContextBase()=default | gridfire::solver::SolverContextBase | virtual |
| init() override | PySolverContextBase | virtual |
| set_detailed_logging(bool enable) override | PySolverContextBase | virtual |
| set_stdout_logging(bool enable) override | PySolverContextBase | virtual |
| ~SolverContextBase()=default | gridfire::solver::SolverContextBase | virtual |
Public Member Functions | |
| std::vector< std::tuple< std::string, std::string > > | describe () const override |
| Describe the context for callback functions. | |
Public Member Functions inherited from gridfire::solver::SolverContextBase | |
| virtual | ~SolverContextBase ()=default |
| void | init () override |
| void | set_stdout_logging (bool enable) override |
| void | set_detailed_logging (bool enable) override |
Public Member Functions inherited from gridfire::solver::SolverContextBase | |
| virtual | ~SolverContextBase ()=default |
| std::vector< std::tuple< std::string, std::string > > PySolverContextBase::describe | +void PySolverContextBase::init | ( | ) | -const | +
Describe the context for callback functions.
-This method should be overridden by derived classes to provide a description of the context that will be passed to the callback function. The intent of this method is that an end user can investigate the context that will be passed to the callback function, and use this information to craft their own callback function.
+Implements gridfire::solver::SolverContextBase.
-Implements gridfire::solver::SolverContextBase.
+
+
|
+ +overridevirtual | +
Implements gridfire::solver::SolverContextBase.
+ +
+
|
+ +overridevirtual | +
Implements gridfire::solver::SolverContextBase.
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
This is the complete list of members for PyTimestepContextBase, including all inherited members.
+| describe() const override | PyTimestepContextBase | virtual |
| ~TimestepContextBase()=default | gridfire::solver::TimestepContextBase | virtual |
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
#include <py_solver.h>
+Public Member Functions | |
| std::vector< std::tuple< std::string, std::string > > | describe () const override |
| Describe the context for callback functions. | |
Public Member Functions inherited from gridfire::solver::TimestepContextBase | |
| virtual | ~TimestepContextBase ()=default |
+
|
+ +nodiscardoverridevirtual | +
Describe the context for callback functions.
+This method should be overridden by derived classes to provide a description of the context that will be passed to the callback function. The intent of this method is that an end user can investigate the context that will be passed to the callback function, and use this information to craft their own callback function.
+ +Implements gridfire::solver::TimestepContextBase.
+ +This is the complete list of members for gridfire::engine::AdaptiveEngineView, including all inherited members.
| AdaptiveEngineView(DynamicEngine &baseEngine) | gridfire::engine::AdaptiveEngineView | explicit |
| calculateAllReactionFlows(const NetIn &netIn) const | gridfire::engine::AdaptiveEngineView | private |
| calculateEpsDerivatives(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override | gridfire::engine::AdaptiveEngineView | virtual |
| calculateMolarReactionFlow(const reaction::Reaction &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override | gridfire::engine::AdaptiveEngineView | virtual |
| calculateRHSAndEnergy(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override | gridfire::engine::AdaptiveEngineView | virtual |
| collectComposition(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override | gridfire::engine::AdaptiveEngineView | virtual |
| Config typedef | gridfire::engine::AdaptiveEngineView | private |
| cullReactionsByFlow(const std::vector< ReactionFlow > &allFlows, const std::unordered_set< fourdst::atomic::Species > &reachableSpecies, const fourdst::composition::Composition &comp, double maxFlow) const | gridfire::engine::AdaptiveEngineView | private |
| finalizeActiveSet(const std::vector< const reaction::Reaction * > &finalReactions) | gridfire::engine::AdaptiveEngineView | private |
| findReachableSpecies(const NetIn &netIn) const | gridfire::engine::AdaptiveEngineView | private |
| generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override | gridfire::engine::AdaptiveEngineView | virtual |
| generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies) const override | gridfire::engine::AdaptiveEngineView | virtual |
| generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const override | gridfire::engine::AdaptiveEngineView | virtual |
| generateStoichiometryMatrix() override | gridfire::engine::AdaptiveEngineView | virtual |
| getBaseEngine() const override | gridfire::engine::AdaptiveEngineView | inlinevirtual |
| getDepth() const | gridfire::engine::DynamicEngine | inlinevirtual |
| getNetworkReactions() const override | gridfire::engine::AdaptiveEngineView | virtual |
| getNetworkSpecies() const override | gridfire::engine::AdaptiveEngineView | virtual |
| getScreeningModel() const override | gridfire::engine::AdaptiveEngineView | virtual |
| getSpeciesDestructionTimescales(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override | gridfire::engine::AdaptiveEngineView | virtual |
| getSpeciesIndex(const fourdst::atomic::Species &species) const override | gridfire::engine::AdaptiveEngineView | virtual |
| getSpeciesStatus(const fourdst::atomic::Species &species) const override | gridfire::engine::AdaptiveEngineView | virtual |
| getSpeciesTimescales(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override | gridfire::engine::AdaptiveEngineView | virtual |
| getStoichiometryMatrixEntry(const fourdst::atomic::Species &species, const reaction::Reaction &reaction) const override | gridfire::engine::AdaptiveEngineView | virtual |
| isStale(const NetIn &netIn) override | gridfire::engine::AdaptiveEngineView | virtual |
| LogManager typedef | gridfire::engine::AdaptiveEngineView | private |
| m_activeReactions | gridfire::engine::AdaptiveEngineView | private |
| m_activeSpecies | gridfire::engine::AdaptiveEngineView | private |
| m_baseEngine | gridfire::engine::AdaptiveEngineView | private |
| m_config | gridfire::engine::AdaptiveEngineView | private |
| m_isStale | gridfire::engine::AdaptiveEngineView | private |
| calculateAllReactionFlows(scratch::StateBlob &ctx, const NetIn &netIn) const | gridfire::engine::AdaptiveEngineView | private |
| calculateEpsDerivatives(scratch::StateBlob &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override | gridfire::engine::AdaptiveEngineView | virtual |
| calculateMolarReactionFlow(scratch::StateBlob &ctx, const reaction::Reaction &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override | gridfire::engine::AdaptiveEngineView | virtual |
| calculateRHSAndEnergy(scratch::StateBlob &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho, bool trust) const override | gridfire::engine::AdaptiveEngineView | virtual |
| collectComposition(scratch::StateBlob &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override | gridfire::engine::AdaptiveEngineView | virtual |
| constructStateBlob(const scratch::StateBlob *blob) const override | gridfire::engine::AdaptiveEngineView | virtual |
| cullReactionsByFlow(scratch::StateBlob &ctx, const std::vector< ReactionFlow > &allFlows, const std::unordered_set< fourdst::atomic::Species > &reachableSpecies, const fourdst::composition::Composition &comp, double maxFlow) const | gridfire::engine::AdaptiveEngineView | private |
| finalizeActiveSet(scratch::StateBlob &ctx, const std::vector< const reaction::Reaction * > &finalReactions) const | gridfire::engine::AdaptiveEngineView | private |
| findReachableSpecies(scratch::StateBlob &ctx, const NetIn &netIn) const | gridfire::engine::AdaptiveEngineView | private |
| generateJacobianMatrix(scratch::StateBlob &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override | gridfire::engine::AdaptiveEngineView | virtual |
| generateJacobianMatrix(scratch::StateBlob &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies) const override | gridfire::engine::AdaptiveEngineView | virtual |
| generateJacobianMatrix(scratch::StateBlob &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const override | gridfire::engine::AdaptiveEngineView | virtual |
| getBaseEngine() const override | gridfire::engine::AdaptiveEngineView | inlinevirtual |
| getInactiveNetworkReactions(scratch::StateBlob &ctx) const override | gridfire::engine::AdaptiveEngineView | virtual |
| getInactiveReactionMolarReactionFlow(scratch::StateBlob &ctx, const reaction::Reaction &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override | gridfire::engine::AdaptiveEngineView | virtual |
| getMostRecentRHSCalculation(scratch::StateBlob &ctx) const override | gridfire::engine::AdaptiveEngineView | virtual |
| getNetworkReactions(scratch::StateBlob &ctx) const override | gridfire::engine::AdaptiveEngineView | virtual |
| getNetworkSpecies(scratch::StateBlob &ctx) const override | gridfire::engine::AdaptiveEngineView | virtual |
| getScreeningModel(scratch::StateBlob &ctx) const override | gridfire::engine::AdaptiveEngineView | virtual |
| getSpeciesDestructionTimescales(scratch::StateBlob &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override | gridfire::engine::AdaptiveEngineView | virtual |
| getSpeciesIndex(scratch::StateBlob &ctx, const fourdst::atomic::Species &species) const override | gridfire::engine::AdaptiveEngineView | virtual |
| getSpeciesStatus(scratch::StateBlob &ctx, const fourdst::atomic::Species &species) const override | gridfire::engine::AdaptiveEngineView | virtual |
| getSpeciesTimescales(scratch::StateBlob &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override | gridfire::engine::AdaptiveEngineView | virtual |
| LogManager typedef | gridfire::engine::AdaptiveEngineView | private |
| m_baseEngine | gridfire::engine::AdaptiveEngineView | private |
| m_config | gridfire::engine::AdaptiveEngineView | private |
| m_logger | gridfire::engine::AdaptiveEngineView | private |
| mapNetInToMolarAbundanceVector(const NetIn &netIn) const override | gridfire::engine::AdaptiveEngineView | virtual |
| primeEngine(const NetIn &netIn) override | gridfire::engine::AdaptiveEngineView | virtual |
| rebuild(const fourdst::composition::CompositionAbstract &comp, BuildDepthType depth) | gridfire::engine::DynamicEngine | inlinevirtual |
| rescueEdgeSpeciesDestructionChannel(const fourdst::composition::Composition &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies, const reaction::ReactionSet &activeReactions) const | gridfire::engine::AdaptiveEngineView | private |
| RescueSet typedef | gridfire::engine::AdaptiveEngineView | private |
| setNetworkReactions(const reaction::ReactionSet &reactions) override | gridfire::engine::AdaptiveEngineView | virtual |
| setScreeningModel(screening::ScreeningType model) override | gridfire::engine::AdaptiveEngineView | virtual |
| update(const NetIn &netIn) override | gridfire::engine::AdaptiveEngineView | virtual |
| validateState() const | gridfire::engine::AdaptiveEngineView | private |
| ~Engine()=default | gridfire::engine::Engine | virtual |
| ~EngineView()=default | gridfire::engine::EngineView< DynamicEngine > | virtual |
| primeEngine(scratch::StateBlob &ctx, const NetIn &netIn) const override | gridfire::engine::AdaptiveEngineView | virtual |
| project(scratch::StateBlob &ctx, const NetIn &netIn) const override | gridfire::engine::AdaptiveEngineView | virtual |
| rescueEdgeSpeciesDestructionChannel(scratch::StateBlob &ctx, const fourdst::composition::Composition &comp, double T9, double rho) const | gridfire::engine::AdaptiveEngineView | private |
| RescueSet typedef | gridfire::engine::AdaptiveEngineView | private |
| ~Engine()=default | gridfire::engine::Engine | virtual |
| ~EngineView()=default | gridfire::engine::EngineView< DynamicEngine > | virtual |
@@ -136,81 +136,65 @@ Public Member Functions | |
| AdaptiveEngineView (DynamicEngine &baseEngine) | |
| Constructs an AdaptiveEngineView. | |
| fourdst::composition::Composition | update (const NetIn &netIn) override |
| Updates the active species and reactions based on the current conditions. | |
| bool | isStale (const NetIn &netIn) override |
| Check if the engine's internal state is stale. | |
| const std::vector< fourdst::atomic::Species > & | getNetworkSpecies () const override |
| Gets the list of active species in the network. | |
| std::expected< StepDerivatives< double >, engine::EngineStatus > | calculateRHSAndEnergy (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override |
| Calculates the right-hand side (dY/dt) and energy generation for the active species. | |
| EnergyDerivatives | calculateEpsDerivatives (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override |
| NetworkJacobian | generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override |
| Generates the Jacobian matrix for the active species. | |
| NetworkJacobian | generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies) const override |
| Generates the Jacobian matrix for some set of active species such that that set is a subset of the active species in the view. | |
| NetworkJacobian | generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const override |
| Generates the Jacobian matrix for the active species with a given sparsity pattern. | |
| void | generateStoichiometryMatrix () override |
| Generates the stoichiometry matrix for the active reactions and species. | |
| int | getStoichiometryMatrixEntry (const fourdst::atomic::Species &species, const reaction::Reaction &reaction) const override |
| Gets an entry from the stoichiometry matrix for the active species and reactions. | |
| double | calculateMolarReactionFlow (const reaction::Reaction &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override |
| Calculates the molar reaction flow for a given reaction in the active network. | |
| const reaction::ReactionSet & | getNetworkReactions () const override |
| Gets the set of active logical reactions in the network. | |
| void | setNetworkReactions (const reaction::ReactionSet &reactions) override |
| Sets the reaction set for the base engine. | |
| std::expected< std::unordered_map< fourdst::atomic::Species, double >, EngineStatus > | getSpeciesTimescales (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override |
| Computes timescales for all active species in the network. | |
| std::expected< std::unordered_map< fourdst::atomic::Species, double >, EngineStatus > | getSpeciesDestructionTimescales (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override |
| Computes destruction timescales for all active species in the network. | |
| fourdst::composition::Composition | project (scratch::StateBlob &ctx, const NetIn &netIn) const override |
| Updates the active species and reactions based on the current conditions. | |
| const std::vector< fourdst::atomic::Species > & | getNetworkSpecies (scratch::StateBlob &ctx) const override |
| Gets the list of active species in the network. | |
| std::expected< StepDerivatives< double >, EngineStatus > | calculateRHSAndEnergy (scratch::StateBlob &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho, bool trust) const override |
| Calculates the right-hand side (dY/dt) and energy generation for the active species. | |
| EnergyDerivatives | calculateEpsDerivatives (scratch::StateBlob &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override |
| NetworkJacobian | generateJacobianMatrix (scratch::StateBlob &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override |
| Generates the Jacobian matrix for the active species. | |
| NetworkJacobian | generateJacobianMatrix (scratch::StateBlob &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies) const override |
| Generates the Jacobian matrix for some set of active species such that that set is a subset of the active species in the view. | |
| NetworkJacobian | generateJacobianMatrix (scratch::StateBlob &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const override |
| Generates the Jacobian matrix for the active species with a given sparsity pattern. | |
| double | calculateMolarReactionFlow (scratch::StateBlob &ctx, const reaction::Reaction &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override |
| Calculates the molar reaction flow for a given reaction in the active network. | |
| const reaction::ReactionSet & | getNetworkReactions (scratch::StateBlob &ctx) const override |
| Gets the set of active logical reactions in the network. | |
| reaction::ReactionSet | getInactiveNetworkReactions (scratch::StateBlob &ctx) const override |
| Gets the set of inactive logical reactions in the network. | |
| double | getInactiveReactionMolarReactionFlow (scratch::StateBlob &ctx, const reaction::Reaction &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override |
| std::expected< std::unordered_map< fourdst::atomic::Species, double >, EngineStatus > | getSpeciesTimescales (scratch::StateBlob &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override |
| Computes timescales for all active species in the network. | |
| std::expected< std::unordered_map< fourdst::atomic::Species, double >, EngineStatus > | getSpeciesDestructionTimescales (scratch::StateBlob &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override |
| Computes destruction timescales for all active species in the network. | |
| const DynamicEngine & | getBaseEngine () const override |
| Gets the base engine. | |
| void | setScreeningModel (screening::ScreeningType model) override |
| Sets the screening model for the base engine. | |
| screening::ScreeningType | getScreeningModel () const override |
| Gets the screening model from the base engine. | |
| size_t | getSpeciesIndex (const fourdst::atomic::Species &species) const override |
| Gets the index of a species in the active species list. | |
| std::vector< double > | mapNetInToMolarAbundanceVector (const NetIn &netIn) const override |
| Maps the molar abundance vector from the active species to the full network species. | |
| PrimingReport | primeEngine (const NetIn &netIn) override |
| Primes the engine with the given network input. | |
| fourdst::composition::Composition | collectComposition (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override |
| Collect the composition of the base engine, ensure all active species are registered, and pass the composition back to the caller. | |
| SpeciesStatus | getSpeciesStatus (const fourdst::atomic::Species &species) const override |
| Gets the status of a species in the network. | |
Public Member Functions inherited from gridfire::engine::DynamicEngine | |
| virtual BuildDepthType | getDepth () const |
| Get the depth of the network. | |
| virtual void | rebuild (const fourdst::composition::CompositionAbstract &comp, BuildDepthType depth) |
| Rebuild the network with a specified depth. | |
| screening::ScreeningType | getScreeningModel (scratch::StateBlob &ctx) const override |
| Gets the screening model from the base engine. | |
| size_t | getSpeciesIndex (scratch::StateBlob &ctx, const fourdst::atomic::Species &species) const override |
| Gets the index of a species in the active species list. | |
| PrimingReport | primeEngine (scratch::StateBlob &ctx, const NetIn &netIn) const override |
| Primes the engine with the given network input. | |
| fourdst::composition::Composition | collectComposition (scratch::StateBlob &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override |
| Collect the composition of the base engine, ensure all active species are registered, and pass the composition back to the caller. | |
| SpeciesStatus | getSpeciesStatus (scratch::StateBlob &ctx, const fourdst::atomic::Species &species) const override |
| Gets the status of a species in the network. | |
| std::optional< StepDerivatives< double > > | getMostRecentRHSCalculation (scratch::StateBlob &ctx) const override |
| std::unique_ptr< scratch::StateBlob > | constructStateBlob (const scratch::StateBlob *blob) const override |
Public Member Functions inherited from gridfire::engine::Engine | |
| virtual | ~Engine ()=default |
| Virtual destructor. | |
Private Types | |
| using | Config = fourdst::config::Config |
| using | LogManager = fourdst::logging::LogManager |
| typedef std::pair< std::unordered_set< const reaction::Reaction * >, std::unordered_set< fourdst::atomic::Species > > | RescueSet |
Private Member Functions | |
| void | validateState () const |
| Validates that the AdaptiveEngineView is not stale. | |
| std::pair< std::vector< ReactionFlow >, fourdst::composition::Composition > | calculateAllReactionFlows (const NetIn &netIn) const |
| Calculates the molar reaction flow rate for all reactions in the full network. | |
| std::unordered_set< fourdst::atomic::Species > | findReachableSpecies (const NetIn &netIn) const |
| Finds all species that are reachable from the initial fuel through the reaction network. | |
| std::vector< const reaction::Reaction * > | cullReactionsByFlow (const std::vector< ReactionFlow > &allFlows, const std::unordered_set< fourdst::atomic::Species > &reachableSpecies, const fourdst::composition::Composition &comp, double maxFlow) const |
| Culls reactions from the network based on their flow rates. | |
| RescueSet | rescueEdgeSpeciesDestructionChannel (const fourdst::composition::Composition &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies, const reaction::ReactionSet &activeReactions) const |
| void | finalizeActiveSet (const std::vector< const reaction::Reaction * > &finalReactions) |
| Finalizes the set of active species and reactions. | |
| std::pair< std::vector< ReactionFlow >, fourdst::composition::Composition > | calculateAllReactionFlows (scratch::StateBlob &ctx, const NetIn &netIn) const |
| Calculates the molar reaction flow rate for all reactions in the full network. | |
| std::unordered_set< fourdst::atomic::Species > | findReachableSpecies (scratch::StateBlob &ctx, const NetIn &netIn) const |
| Finds all species that are reachable from the initial fuel through the reaction network. | |
| std::vector< const reaction::Reaction * > | cullReactionsByFlow (scratch::StateBlob &ctx, const std::vector< ReactionFlow > &allFlows, const std::unordered_set< fourdst::atomic::Species > &reachableSpecies, const fourdst::composition::Composition &comp, double maxFlow) const |
| Culls reactions from the network based on their flow rates. | |
| RescueSet | rescueEdgeSpeciesDestructionChannel (scratch::StateBlob &ctx, const fourdst::composition::Composition &comp, double T9, double rho) const |
| void | finalizeActiveSet (scratch::StateBlob &ctx, const std::vector< const reaction::Reaction * > &finalReactions) const |
| Finalizes the set of active species and reactions. | |
Private Attributes | |
| Config & | m_config = Config::getInstance() |
| A reference to the singleton Config instance, used for retrieving configuration parameters. | |
| fourdst::config::Config< config::GridFireConfig > | m_config |
| quill::Logger * | m_logger = LogManager::getInstance().getLogger("log") |
| A pointer to the logger instance, used for logging messages. | |
| DynamicEngine & | m_baseEngine |
| The underlying engine to which this view delegates calculations. | |
| std::vector< fourdst::atomic::Species > | m_activeSpecies |
| The set of species that are currently active in the network. | |
| reaction::ReactionSet | m_activeReactions |
| The set of reactions that are currently active in the network. | |
| bool | m_isStale = true |
| A flag indicating whether the view is stale and needs to be updated. | |
An engine view that dynamically adapts the reaction network based on runtime conditions.
This class implements an EngineView that dynamically culls species and reactions from the full reaction network based on their reaction flow rates and connectivity. This allows for efficient simulation of reaction networks by focusing computational effort on the most important species and reactions.
The AdaptiveEngineView maintains a subset of "active" species and reactions, and maps between the full network indices and the active subset indices. This allows the base engine to operate on the full network data, while the AdaptiveEngineView provides a reduced view for external clients.
-The adaptation process is driven by the update() method, which performs the following steps:
The adaptation process is driven by the update() method, which performs the following steps:
-
|
- -private | -
This method iterates through all reactions in the base engine's network and calculates their molar flow rates based on the provided network input conditions (temperature, density, and composition). It also constructs a vector of molar abundances for all species in the full network.
| ctx | The scratchpad context for storing thread-local data. |
| netIn | The current network input, containing temperature, density, and composition. |
| ctx | The scratchpad context for storing thread-local data. | ||||||||||||||||||||
| comp | The current composition of the system. | ||||||||||||||||||||
| T9 | The temperature in units of 10^9 K. | ||||||||||||||||||||
| rho | The density in g/cm^3. | ||||||||||||||||||||
| double gridfire::engine::AdaptiveEngineView::calculateMolarReactionFlow | ( | +scratch::StateBlob & | ctx, | +||||||||||||||||||
| + | const reaction::Reaction & | reaction, | |||||||||||||||||||
| ctx | The scratchpad context for storing thread-local data. | ||||
| reaction | The reaction for which to calculate the flow. | ||||
| comp | Composition object containing current abundances. | ||||
| T9 | Temperature in units of 10^9 K. |
| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
| std::runtime_error | If the reaction is not part of the active reactions in the adaptive engine view. |
Implements gridfire::engine::DynamicEngine.
+Implements gridfire::engine::DynamicEngine.
- -Calculates the right-hand side (dY/dt) and energy generation for the active species.
| ctx | The scratchpad context for storing thread-local data. |
| comp | The current composition of the system. |
| T9 | The temperature in units of 10^9 K. |
| rho | The density in g/cm^3. |
| trust |
This method maps the culled abundances to the full network abundances, calls the base engine to calculate the RHS and energy generation, and then maps the full network derivatives back to the culled derivatives.
| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
Implements gridfire::engine::Engine.
+Implements gridfire::engine::Engine.
Collect the composition of the base engine, ensure all active species are registered, and pass the composition back to the caller.
| ctx | The scratchpad context for storing thread-local data. | ||||||
| comp | The current composition of the system. | ||||||
| T9 | The temperature in units of 10^9 K. | ||||||
| rho | The density in g/cm^3. |
+
|
+ +nodiscardoverridevirtual | +
Implements gridfire::engine::DynamicEngine.
+ +This method filters the list of all reactions, keeping only those with a flow rate above an absolute culling threshold. The threshold is calculated by multiplying the maximum flow rate by a relative culling threshold read from the configuration.
| ctx | The scratchpad context for storing thread-local data. | |||||
| allFlows | A vector of all reactions and their flow rates. | |||||
| reachableSpecies | A set of all species reachable from the initial fuel. | |||||
| comp | The current composition of the system. | |||||
| void gridfire::engine::AdaptiveEngineView::finalizeActiveSet | ( | -const std::vector< const reaction::Reaction * > & | finalReactions | ) | +scratch::StateBlob & | ctx, | +
| + | const std::vector< const reaction::Reaction * > & | finalReactions ) const |
This method takes the final list of culled reactions and populates the m_activeReactions and m_activeSpecies members. The active species are determined by collecting all reactants and products from the final reactions. The active species list is then sorted by mass.
| ctx | The scratchpad context for storing thread-local data. |
| finalReactions | A vector of pointers to the reactions to be included in the active set. |
This method performs a connectivity analysis to identify all species that can be produced starting from the initial fuel species. A species is considered part of the initial fuel if its mass fraction is above a certain threshold (ABUNDANCE_FLOOR).
| ctx | The scratchpad context for storing thread-local data. |
| netIn | The current network input, containing the initial composition. |
Generates the Jacobian matrix for the active species.
| ctx | The scratchpad context for storing thread-local data. | ||||||||||||||||||||
| comp | The current composition of the system. | ||||||||||||||||||||
| T9 | The temperature in units of 10^9 K. | ||||||||||||||||||||
| rho | The density in g/cm^3. |
| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
Implements gridfire::engine::DynamicEngine.
+Implements gridfire::engine::DynamicEngine.
- -Generates the Jacobian matrix for the active species with a given sparsity pattern.
| ctx | The scratchpad context for storing thread-local data. | ||||||||||||||||||||
| comp | The current composition of the system. | ||||||||||||||||||||
| T9 | The temperature in units of 10^9 K. | ||||||||||||||||||||
| rho | The density in g/cm^3. |
| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
Implements gridfire::engine::DynamicEngine.
+Implements gridfire::engine::DynamicEngine.
- -Generates the Jacobian matrix for some set of active species such that that set is a subset of the active species in the view.
| ctx | The scratchpad context for storing thread-local data. | ||||||||||||||||||||
| comp | The current composition of the system. | ||||||||||||||||||||
| T9 | The temperature in units of 10^9 K. | ||||||||||||||||||||
| rho | The density in g/cm^3. |
| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
Implements gridfire::engine::DynamicEngine.
- - - - -
-
|
- -overridevirtual | -
Generates the stoichiometry matrix for the active reactions and species.
-This method calls the base engine to generate the stoichiometry matrix.
-| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
Implements gridfire::engine::DynamicEngine.
+Implements gridfire::engine::DynamicEngine.
+
|
+ +nodiscardoverridevirtual | +
Gets the set of inactive logical reactions in the network.
+This method returns the set of reactions that have been culled from the active network based on the adaptation criteria.
+ +Reimplemented from gridfire::engine::DynamicEngine.
+ +
+
|
+ +nodiscardoverridevirtual | +
Reimplemented from gridfire::engine::DynamicEngine.
+ +
+
|
+ +nodiscardoverridevirtual | +
Implements gridfire::engine::DynamicEngine.
+ +Gets the set of active logical reactions in the network.
Implements gridfire::engine::DynamicEngine.
+Implements gridfire::engine::DynamicEngine.
Gets the list of active species in the network.
Implements gridfire::engine::Engine.
+Implements gridfire::engine::Engine.
Implements gridfire::engine::DynamicEngine.
+Implements gridfire::engine::DynamicEngine.
Computes destruction timescales for all active species in the network.
| ctx | The scratchpad context for storing thread-local data. | ||||||
| comp | Composition object containing current abundances. | ||||||
| T9 | Temperature in units of 10^9 K. | ||||||
| rho | Density in g/cm^3. |
| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
Implements gridfire::engine::DynamicEngine.
+Implements gridfire::engine::DynamicEngine.
- -Gets the index of a species in the active species list.
| ctx | The scratchpad context for storing thread-local data. |
| species | The species for which to get the index. |
| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
| std::out_of_range | If the species is not part of the active species in the adaptive engine view. |
Implements gridfire::engine::DynamicEngine.
+Implements gridfire::engine::DynamicEngine.
Gets the status of a species in the network.
| ctx | The scratchpad context for storing thread-local data. |
| species | The species for which to get the status. |
This method delegates the call to the base engine to get the species status. If the base engine says that the species is active but it is not in the active species list of this view, the status is returned as INACTIVE_FLOW.
+This method delegates the call to the base engine to get the species status. If the base engine says that the species is active, but it is not in the active species list of this view, the status is returned as INACTIVE_FLOW.
-Implements gridfire::engine::DynamicEngine.
+Implements gridfire::engine::DynamicEngine.
Computes timescales for all active species in the network.
| ctx | The scratchpad context for storing thread-local data. | ||||||||
| comp | Composition object containing current abundances. | ||||||||
| T9 | Temperature in units of 10^9 K. | ||||||||
| rho | Density in g/cm^3. |
| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
Implements gridfire::engine::DynamicEngine.
+Implements gridfire::engine::DynamicEngine.
- -
-
|
- -nodiscardoverridevirtual | -
Gets an entry from the stoichiometry matrix for the active species and reactions.
-| species | The species for which to get the stoichiometric coefficient. |
| reaction | The reaction for which to get the stoichiometric coefficient. |
This method maps the culled indices to the full network indices and calls the base engine to get the stoichiometry matrix entry.
-| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
| std::out_of_range | If the culled index is out of bounds for the species or reaction index map. |
Implements gridfire::engine::DynamicEngine.
- -
-
|
- -overridevirtual | -
Check if the engine's internal state is stale.
-| netIn | A struct containing the current network input, such as temperature, density, and composition. |
This method allows derived classes to determine if their internal state is out-of-date with respect to the provided network conditions. If the engine is stale, it may require a call to update() before performing calculations.
Implements gridfire::engine::DynamicEngine.
- -
-
|
- -nodiscardoverridevirtual | -
Maps the molar abundance vector from the active species to the full network species.
-| netIn | The current network input, containing temperature, density, and composition. |
This method constructs a molar abundance vector for the full network by mapping the abundances from the active species in netIn to their corresponding indices in the full network. Species not present in netIn are assigned an abundance of zero.
| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
Implements gridfire::engine::DynamicEngine.
- -Primes the engine with the given network input.
| ctx | The scratchpad context for storing thread-local data. |
| netIn | The current network input, containing temperature, density, and composition. |
This method delegates the priming operation to the base engine.
-Implements gridfire::engine::DynamicEngine.
+Implements gridfire::engine::DynamicEngine.
| AdaptiveEngineView::RescueSet gridfire::engine::AdaptiveEngineView::rescueEdgeSpeciesDestructionChannel | +fourdst::composition::Composition gridfire::engine::AdaptiveEngineView::project | ( | -const fourdst::composition::Composition & | comp, | +scratch::StateBlob & | ctx, |
| - | double | T9, | -||||
| - | - | double | rho, | -|||
| - | - | const std::vector< fourdst::atomic::Species > & | activeSpecies, | -|||
| - | - | const reaction::ReactionSet & | activeReactions ) const | -
-
|
- -overridevirtual | -
Sets the reaction set for the base engine.
-This method delegates the call to the base engine to set the reaction set.
-| reactions | The ReactionSet to set in the base engine. |
Implements gridfire::engine::DynamicEngine.
- -
-
|
- -overridevirtual | -
Sets the screening model for the base engine.
-This method delegates the call to the base engine to set the electron screening model.
-| model | The electron screening model to set. |
Implements gridfire::engine::DynamicEngine.
- -
-
|
@@ -1631,6 +1514,7 @@ Private Attributes
| ctx | The scratchpad context for storing thread-local data. |
| netIn | The current network input, containing temperature, density, and composition. |
Implements gridfire::engine::DynamicEngine.
+Implements gridfire::engine::DynamicEngine.
- -| void gridfire::engine::AdaptiveEngineView::validateState | +AdaptiveEngineView::RescueSet gridfire::engine::AdaptiveEngineView::rescueEdgeSpeciesDestructionChannel | ( | -) | -const | +scratch::StateBlob & | ctx, | +|
| + | + | const fourdst::composition::Composition & | comp, | +||||
| + | + | double | T9, | +||||
| + | + | double | rho ) const |
Validates that the AdaptiveEngineView is not stale.
-| std::runtime_error | If the AdaptiveEngineView is stale (i.e., update() has not been called). |
-
|
- -private | -
The set of reactions that are currently active in the network.
- -
-
|
- -private | -
The set of species that are currently active in the network.
- -| Config& gridfire::engine::AdaptiveEngineView::m_config = Config::getInstance() | +fourdst::config::Config<config::GridFireConfig> gridfire::engine::AdaptiveEngineView::m_config |
A reference to the singleton Config instance, used for retrieving configuration parameters.
- -
-
|
- -private | -
A flag indicating whether the view is stale and needs to be updated.
-|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
This is the complete list of members for gridfire::exceptions::ScratchPadError, including all inherited members.
+| GridFireError(std::string msg) | gridfire::exceptions::GridFireError | inlineexplicit |
| m_msg | gridfire::exceptions::GridFireError | private |
| ScratchPadError(const std::string &msg) | gridfire::exceptions::ScratchPadError | inlineexplicit |
| what() const noexcept override | gridfire::exceptions::GridFireError | inline |
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
#include <error_scratchpad.h>
+Public Member Functions | |
| ScratchPadError (const std::string &msg) | |
Public Member Functions inherited from gridfire::exceptions::GridFireError | |
| GridFireError (std::string msg) | |
| const char * | what () const noexcept override |
+
|
+ +inlineexplicit | +
This is the complete list of members for gridfire::io::MESANetworkFileParser, including all inherited members.
Private Types | |
| using | Config = fourdst::config::Config |
| using | LogManager = fourdst::logging::LogManager |
Private Attributes | |||||||||||||||||||||||||||||||||||||||
| Config & | m_config = Config::getInstance() | ||||||||||||||||||||||||||||||||||||||
| fourdst::config::Config< config::GridFireConfig > | m_config | ||||||||||||||||||||||||||||||||||||||
| quill::Logger * | m_logger = LogManager::getInstance().getLogger("log") | ||||||||||||||||||||||||||||||||||||||
| std::string | m_filename | ||||||||||||||||||||||||||||||||||||||
-
|
- -private | -
| Config& gridfire::io::MESANetworkFileParser::m_config = Config::getInstance() | +fourdst::config::Config<config::GridFireConfig> gridfire::io::MESANetworkFileParser::m_config |
Implemented in gridfire::io::MESANetworkFileParser, gridfire::io::SimpleReactionListFileParser, and PyNetworkFileParser.
diff --git a/docs/html/classgridfire_1_1io_1_1_simple_reaction_list_file_parser-members.html b/docs/html/classgridfire_1_1io_1_1_simple_reaction_list_file_parser-members.html index 884a421b..9ddfb191 100644 --- a/docs/html/classgridfire_1_1io_1_1_simple_reaction_list_file_parser-members.html +++ b/docs/html/classgridfire_1_1io_1_1_simple_reaction_list_file_parser-members.html @@ -29,7 +29,7 @@This is the complete list of members for gridfire::io::SimpleReactionListFileParser, including all inherited members.
| Config typedef | gridfire::io::SimpleReactionListFileParser | private |
| LogManager typedef | gridfire::io::SimpleReactionListFileParser | private |
| m_config | gridfire::io::SimpleReactionListFileParser | private |
| m_logger | gridfire::io::SimpleReactionListFileParser | private |
| parse(const std::string &filename) const override | gridfire::io::SimpleReactionListFileParser | virtual |
| SimpleReactionListFileParser() | gridfire::io::SimpleReactionListFileParser | explicit |
| ~NetworkFileParser()=default | gridfire::io::NetworkFileParser | virtual |
| LogManager typedef | gridfire::io::SimpleReactionListFileParser | private |
| m_config | gridfire::io::SimpleReactionListFileParser | private |
| m_logger | gridfire::io::SimpleReactionListFileParser | private |
| parse(const std::string &filename) const override | gridfire::io::SimpleReactionListFileParser | virtual |
| SimpleReactionListFileParser() | gridfire::io::SimpleReactionListFileParser | explicit |
| ~NetworkFileParser()=default | gridfire::io::NetworkFileParser | virtual |
Private Types | |
| using | Config = fourdst::config::Config |
| using | LogManager = fourdst::logging::LogManager |
Private Attributes | |
| Config & | m_config = Config::getInstance() |
| fourdst::config::Config< config::GridFireConfig > | m_config |
| quill::Logger * | m_logger = LogManager::getInstance().getLogger("log") |
A parser for simple text files containing a list of reactions.
This parser reads a file where each line contains a single reaction name. It supports comments (lines starting with '#') and ignores empty lines.
-
|
- -private | -
Implements gridfire::io::NetworkFileParser.
| Config& gridfire::io::SimpleReactionListFileParser::m_config = Config::getInstance() | +fourdst::config::Config<config::GridFireConfig> gridfire::io::SimpleReactionListFileParser::m_config |
This is the complete list of members for gridfire::policy::MainSequencePolicy, including all inherited members.
Public Member Functions inherited from gridfire::policy::NetworkPolicyPrivate Member Functions | |
| NetworkPolicyStatus | check_status () const |
| NetworkPolicyStatus | check_status (engine::scratch::StateBlob &ctx) const |
Static Private Member Functions | |||||||
| NetworkPolicyStatus gridfire::policy::MainSequencePolicy::check_status | ( | -) | +engine::scratch::StateBlob & | ctx | ) | const | |
| engine::DynamicEngine & gridfire::policy::MainSequencePolicy::construct | +ConstructionResults gridfire::policy::MainSequencePolicy::construct | ( | ) | @@ -390,14 +392,13 @@ Private Attributes | ||||||||||||||||||||||||||||||||||||||
+
|
+ +nodiscardoverridevirtual | +
Implements gridfire::policy::NetworkPolicy.
+This is the complete list of members for gridfire::policy::NetworkPolicy, including all inherited members.
| construct()=0 | gridfire::policy::NetworkPolicy | pure virtual |
| construct()=0 | gridfire::policy::NetworkPolicy | pure virtual |
| get_engine_stack() const =0 | gridfire::policy::NetworkPolicy | pure virtual |
| get_engine_types_stack() const =0 | gridfire::policy::NetworkPolicy | pure virtual |
| get_partition_function() const =0 | gridfire::policy::NetworkPolicy | pure virtual |
| get_seed_reactions() const =0 | gridfire::policy::NetworkPolicy | pure virtual |
| get_seed_species() const =0 | gridfire::policy::NetworkPolicy | pure virtual |
| get_status() const =0 | gridfire::policy::NetworkPolicy | pure virtual |
| name() const =0 | gridfire::policy::NetworkPolicy | pure virtual |
| ~NetworkPolicy()=default | gridfire::policy::NetworkPolicy | virtual |
| get_stack_scratch_blob() const =0 | gridfire::policy::NetworkPolicy | pure virtual |
| get_status() const =0 | gridfire::policy::NetworkPolicy | pure virtual |
| name() const =0 | gridfire::policy::NetworkPolicy | pure virtual |
| ~NetworkPolicy()=default | gridfire::policy::NetworkPolicy | virtual |
Abstract interface for policies that construct DynamicEngine networks from a seed composition.
@@ -184,8 +186,8 @@ Public Member Functions| virtual engine::DynamicEngine & gridfire::policy::NetworkPolicy::construct | +virtual ConstructionResults gridfire::policy::NetworkPolicy::construct | ( | ) | @@ -219,16 +221,15 @@ Public Member Functions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+
|
+ +nodiscardpure virtual | +
Implemented in gridfire::policy::MainSequencePolicy, and PyNetworkPolicy.
+The status reports whether the policy has been initialized and whether the constructed network satisfies the policy's key requirements.
Implemented in gridfire::policy::MainSequencePolicy, and PyNetworkPolicy.
diff --git a/docs/html/classgridfire_1_1policy_1_1_network_policy.js b/docs/html/classgridfire_1_1policy_1_1_network_policy.js index 0fae8c2b..14b3aff1 100644 --- a/docs/html/classgridfire_1_1policy_1_1_network_policy.js +++ b/docs/html/classgridfire_1_1policy_1_1_network_policy.js @@ -1,12 +1,13 @@ 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#a13cd74c967592392b01d8fe9a5b34d88", null ], + [ "construct", "classgridfire_1_1policy_1_1_network_policy.html#a1ee276d40dfdfe1bf313b29436cbcfba", null ], [ "get_engine_stack", "classgridfire_1_1policy_1_1_network_policy.html#a92891fe37b8684fe9f1c5958674de2d5", null ], [ "get_engine_types_stack", "classgridfire_1_1policy_1_1_network_policy.html#aac63625678d287d0ca36c98f51e86dd2", null ], [ "get_partition_function", "classgridfire_1_1policy_1_1_network_policy.html#a1c395eb83b0bcf728db230e7772aabcf", 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#afb599d76b423f7a39b322c967302b49b", null ], + [ "get_stack_scratch_blob", "classgridfire_1_1policy_1_1_network_policy.html#a07ae9888263f627d8a3516ecf6a0cf9b", null ], [ "get_status", "classgridfire_1_1policy_1_1_network_policy.html#a3d0f2aee8ead71da4d421fb659fb30f7", 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_proton_proton_chain_policy-members.html b/docs/html/classgridfire_1_1policy_1_1_proton_proton_chain_policy-members.html index 73a12aa0..6878585b 100644 --- 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 @@ -29,7 +29,7 @@chains.h for details. |
- GridFire v0.7.0_rc2
+ GridFire v0.7.6rc4.0
General Purpose Nuclear Network
|
diff --git a/docs/html/classgridfire_1_1policy_1_1_temperature_dependent_chain_policy.html b/docs/html/classgridfire_1_1policy_1_1_temperature_dependent_chain_policy.html
index 114ab0e8..5bd41854 100644
--- a/docs/html/classgridfire_1_1policy_1_1_temperature_dependent_chain_policy.html
+++ b/docs/html/classgridfire_1_1policy_1_1_temperature_dependent_chain_policy.html
@@ -29,7 +29,7 @@
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
- GridFire v0.7.0_rc2
+ GridFire v0.7.6rc4.0
General Purpose Nuclear Network
|
diff --git a/docs/html/classgridfire_1_1policy_1_1_triple_alpha_chain_policy-members.html b/docs/html/classgridfire_1_1policy_1_1_triple_alpha_chain_policy-members.html
index f7998e11..b31cc4b8 100644
--- a/docs/html/classgridfire_1_1policy_1_1_triple_alpha_chain_policy-members.html
+++ b/docs/html/classgridfire_1_1policy_1_1_triple_alpha_chain_policy-members.html
@@ -29,7 +29,7 @@
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
- GridFire v0.7.0_rc2
+ GridFire v0.7.6rc4.0
General Purpose Nuclear Network
|
diff --git a/docs/html/classgridfire_1_1policy_1_1_triple_alpha_chain_policy.html b/docs/html/classgridfire_1_1policy_1_1_triple_alpha_chain_policy.html
index 64f88e99..78c5f918 100644
--- a/docs/html/classgridfire_1_1policy_1_1_triple_alpha_chain_policy.html
+++ b/docs/html/classgridfire_1_1policy_1_1_triple_alpha_chain_policy.html
@@ -29,7 +29,7 @@
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
- GridFire v0.7.0_rc2
+ GridFire v0.7.6rc4.0
General Purpose Nuclear Network
|
diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_rate_interpolator-members.html b/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_rate_interpolator-members.html
index 78219b19..b9b045a8 100644
--- a/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_rate_interpolator-members.html
+++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_rate_interpolator-members.html
@@ -29,7 +29,7 @@
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
- GridFire v0.7.0_rc2
+ GridFire v0.7.6rc4.0
General Purpose Nuclear Network
|
diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_rate_interpolator.html b/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_rate_interpolator.html
index 2a18b729..89e71c20 100644
--- a/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_rate_interpolator.html
+++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_rate_interpolator.html
@@ -29,7 +29,7 @@
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
- GridFire v0.7.0_rc2
+ GridFire v0.7.6rc4.0
General Purpose Nuclear Network
|
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 b336fab9..adcd06be 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
@@ -29,7 +29,7 @@
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
- GridFire v0.7.0_rc2
+ GridFire v0.7.6rc4.0
General Purpose Nuclear Network
|
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 df1a3d71..7f57fd11 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
@@ -29,7 +29,7 @@
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
- GridFire v0.7.0_rc2
+ GridFire v0.7.6rc4.0
General Purpose Nuclear Network
|
diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction_1_1_atomic_weak_rate-members.html b/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction_1_1_atomic_weak_rate-members.html
index d99d8e76..b7df7c95 100644
--- a/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction_1_1_atomic_weak_rate-members.html
+++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction_1_1_atomic_weak_rate-members.html
@@ -29,7 +29,7 @@
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
- GridFire v0.7.0_rc2
+ GridFire v0.7.6rc4.0
General Purpose Nuclear Network
|
diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction_1_1_atomic_weak_rate.html b/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction_1_1_atomic_weak_rate.html
index f79b4318..05619edf 100644
--- a/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction_1_1_atomic_weak_rate.html
+++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction_1_1_atomic_weak_rate.html
@@ -29,7 +29,7 @@
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
- GridFire v0.7.0_rc2
+ GridFire v0.7.6rc4.0
General Purpose Nuclear Network
|
diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction_map-members.html b/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction_map-members.html
index de108a9c..6fddf675 100644
--- a/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction_map-members.html
+++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction_map-members.html
@@ -29,7 +29,7 @@
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
- GridFire v0.7.0_rc2
+ GridFire v0.7.6rc4.0
General Purpose Nuclear Network
|
diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction_map.html b/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction_map.html
index 5a79cac7..5e7b83ec 100644
--- a/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction_map.html
+++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1_weak_reaction_map.html
@@ -29,7 +29,7 @@
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
- GridFire v0.7.0_rc2
+ GridFire v0.7.6rc4.0
General Purpose Nuclear Network
|
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 f2bfe65f..d3268d19 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
@@ -29,7 +29,7 @@
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
- GridFire v0.7.0_rc2
+ GridFire v0.7.6rc4.0
General Purpose Nuclear Network
|
@@ -131,7 +131,9 @@ $(function(){initNavTree('classgridfire_1_1reaction_1_1_logical_reaclib_reaction
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| is_reverse() const override | gridfire::reaction::ReaclibReaction | inlinevirtual | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LogicalReaclibReaction(const std::vector< std::unique_ptr< ReaclibReaction > > &reactions) | gridfire::reaction::LogicalReaclibReaction | explicit | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LogicalReaclibReaction(const std::vector< std::unique_ptr< ReaclibReaction > > &reactions, bool reverse) | gridfire::reaction::LogicalReaclibReaction | explicit | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| m_chapter | gridfire::reaction::ReaclibReaction | protected | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| m_cached_rates | gridfire::reaction::LogicalReaclibReaction | mutableprivate | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| m_chapter | gridfire::reaction::ReaclibReaction | protected | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| m_hashCache | gridfire::reaction::ReaclibReaction | mutableprotected | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| m_id | gridfire::reaction::ReaclibReaction | protected | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| m_logger | gridfire::reaction::ReaclibReaction | protected | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| m_peName | gridfire::reaction::ReaclibReaction | protected | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
- GridFire v0.7.0_rc2
+ GridFire v0.7.6rc4.0
General Purpose Nuclear Network
|
@@ -121,7 +121,7 @@ Inheritance diagram for gridfire::reaction::LogicalReaclibReaction:
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@@ -289,6 +289,8 @@ Private Attributes | |
| bool | m_weak = false |
| std::unordered_map< double, double > | m_cached_rates |
Friends | ||
| std::optional< std::vector< fourdst::atomic::Species > > | m_productsVec | |
| std::optional< std::size_t > | m_hashCache = std::nullopt | |
| Cached hash value for the reaction. | ||
| std::string | m_sourceLabel | |
| Source label for the rate data (e.g., "wc12w", "st08"). | ||
+
|
+ +mutableprivate | +
Chapter number from the REACLIB database, defining the reaction structure.
+ + + +
+
|
+ +mutableprotected | +
Cached hash value for the reaction.
+Friends |
+
|
+ +nodiscard | +
+
|
+ +mutableprivate | +
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
This is the complete list of members for gridfire::solver::GridSolver, including all inherited members.
+|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
#include <GridSolver.h>
+Public Member Functions | |
| GridSolver (const engine::DynamicEngine &engine, const SingleZoneDynamicNetworkSolver &solver) | |
| ~GridSolver () override=default | |
| std::vector< NetOut > | evaluate (SolverContextBase &ctx, const std::vector< NetIn > &netIns) const override |
Public Member Functions inherited from gridfire::solver::MultiZoneNetworkSolver< engine::DynamicEngine > | |
| MultiZoneNetworkSolver (const EngineT &engine, const SingleZoneNetworkSolver< EngineT > &solver) | |
| virtual | ~MultiZoneNetworkSolver ()=default |
| MultiZoneNetworkSolver (const EngineT &engine, const SingleZoneNetworkSolver< EngineT > &solver) | |
| virtual | ~MultiZoneNetworkSolver ()=default |
+Additional Inherited Members | |
Protected Attributes inherited from gridfire::solver::MultiZoneNetworkSolver< engine::DynamicEngine > | |
| const EngineT & | m_engine |
| The engine used by this solver strategy. | |
| const SingleZoneNetworkSolver< EngineT > & | m_solver |
| const EngineT & | m_engine |
| The engine used by this solver strategy. | |
| const SingleZoneNetworkSolver< EngineT > & | m_solver |
| gridfire::solver::GridSolver::GridSolver | +( | +const engine::DynamicEngine & | engine, | +
| + | + | const SingleZoneDynamicNetworkSolver & | solver ) | +
+
|
+ +overridedefault | +
+
|
+ +overridevirtual | +
Implements gridfire::solver::MultiZoneNetworkSolver< engine::DynamicEngine >.
+ +|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
This is the complete list of members for gridfire::solver::MultiZoneNetworkSolver< EngineT >, including all inherited members.
+| evaluate(SolverContextBase &solver_ctx, const std::vector< NetIn > &netIns) const =0 | gridfire::solver::MultiZoneNetworkSolver< EngineT > | pure virtual |
| m_engine | gridfire::solver::MultiZoneNetworkSolver< EngineT > | protected |
| m_solver | gridfire::solver::MultiZoneNetworkSolver< EngineT > | protected |
| MultiZoneNetworkSolver(const EngineT &engine, const SingleZoneNetworkSolver< EngineT > &solver) | gridfire::solver::MultiZoneNetworkSolver< EngineT > | inlineexplicit |
| ~MultiZoneNetworkSolver()=default | gridfire::solver::MultiZoneNetworkSolver< EngineT > | virtual |
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
#include <strategy_abstract.h>
+Public Member Functions | |
| MultiZoneNetworkSolver (const EngineT &engine, const SingleZoneNetworkSolver< EngineT > &solver) | |
| virtual | ~MultiZoneNetworkSolver ()=default |
| virtual std::vector< NetOut > | evaluate (SolverContextBase &solver_ctx, const std::vector< NetIn > &netIns) const =0 |
+Protected Attributes | |
| const EngineT & | m_engine |
| The engine used by this solver strategy. | |
| const SingleZoneNetworkSolver< EngineT > & | m_solver |
+
|
+ +inlineexplicit | +
+
|
+ +virtualdefault | +
+
|
+ +pure virtual | +
Implemented in gridfire::solver::GridSolver, and PyMultiZoneDynamicNetworkSolver.
+ +
+
|
+ +protected | +
The engine used by this solver strategy.
+ +
+
|
+ +protected | +
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
This is the complete list of members for gridfire::solver::PointSolver, including all inherited members.
+| calculate_rhs(sunrealtype t, N_Vector y, N_Vector ydot, const CVODEUserData *data) const | gridfire::solver::PointSolver | private |
| cvode_error_handler(int line, const char *func, const char *file, const char *msg, SUNErrCode err_code, void *err_user_data, SUNContext sunctx) | gridfire::solver::PointSolver | privatestatic |
| cvode_jac_wrapper(sunrealtype t, N_Vector y, N_Vector ydot, SUNMatrix J, void *user_data, N_Vector tmp1, N_Vector tmp2, N_Vector tmp3) | gridfire::solver::PointSolver | privatestatic |
| cvode_rhs_wrapper(sunrealtype t, N_Vector y, N_Vector ydot, void *user_data) | gridfire::solver::PointSolver | privatestatic |
| evaluate(SolverContextBase &solver_ctx, const NetIn &netIn) const override | gridfire::solver::PointSolver | virtual |
| evaluate(SolverContextBase &solver_ctx, const NetIn &netIn, bool displayTrigger, bool forceReinitialize=false) const | gridfire::solver::PointSolver | |
| getConfig() const | gridfire::solver::PointSolver | inline |
| initialize_cvode_integration_resources(PointSolverContext *ctx, uint64_t N, size_t numSpecies, double current_time, const fourdst::composition::Composition &composition, double absTol, double relTol, double accumulatedEnergy) const | gridfire::solver::PointSolver | private |
| log_step_diagnostics(PointSolverContext *sctx_p, engine::scratch::StateBlob &ctx, const CVODEUserData &user_data, bool displayJacobianStiffness, bool displaySpeciesBalance, bool to_file, std::optional< std::string > filename) const | gridfire::solver::PointSolver | private |
| m_config | gridfire::solver::PointSolver | private |
| m_engine | gridfire::solver::SingleZoneNetworkSolver< engine::DynamicEngine > | protected |
| m_engine | gridfire::solver::SingleZoneNetworkSolver< engine::DynamicEngine > | protected |
| m_logger | gridfire::solver::PointSolver | private |
| PointSolver(const engine::DynamicEngine &engine) | gridfire::solver::PointSolver | explicit |
| PointSolver(const engine::DynamicEngine &engine, const config::GridFireConfig &config) | gridfire::solver::PointSolver | |
| SingleZoneNetworkSolver(const EngineT &engine) | gridfire::solver::SingleZoneNetworkSolver< engine::DynamicEngine > | inlineexplicit |
| SingleZoneNetworkSolver(const EngineT &engine) | gridfire::solver::SingleZoneNetworkSolver< engine::DynamicEngine > | inlineexplicit |
| ~SingleZoneNetworkSolver()=default | gridfire::solver::SingleZoneNetworkSolver< engine::DynamicEngine > | virtual |
| ~SingleZoneNetworkSolver()=default | gridfire::solver::SingleZoneNetworkSolver< engine::DynamicEngine > | virtual |
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
Stiff ODE integrator backed by SUNDIALS CVODE (BDF) for network + energy. + More...
+ +#include <PointSolver.h>
+Classes | |
| struct | CVODERHSOutputData |
| struct | CVODEUserData |
| A helper struct to pass C++ context to C-style CVODE callbacks. More... | |
+Public Member Functions | |
| PointSolver (const engine::DynamicEngine &engine) | |
| Construct the CVODE strategy and create a SUNDIALS context. | |
| PointSolver (const engine::DynamicEngine &engine, const config::GridFireConfig &config) | |
| config::GridFireConfig | getConfig () const |
| NetOut | evaluate (SolverContextBase &solver_ctx, const NetIn &netIn) const override |
| Integrate from t=0 to netIn.tMax and return final composition and energy. | |
| NetOut | evaluate (SolverContextBase &solver_ctx, const NetIn &netIn, bool displayTrigger, bool forceReinitialize=false) const |
| Call to evaluate which will let the user control if the trigger reasoning is displayed. | |
Public Member Functions inherited from gridfire::solver::SingleZoneNetworkSolver< engine::DynamicEngine > | |
| SingleZoneNetworkSolver (const EngineT &engine) | |
| Constructor for the NetworkSolverStrategy. | |
| virtual | ~SingleZoneNetworkSolver ()=default |
| Virtual destructor. | |
| SingleZoneNetworkSolver (const EngineT &engine) | |
| Constructor for the NetworkSolverStrategy. | |
| virtual | ~SingleZoneNetworkSolver ()=default |
| Virtual destructor. | |
+Private Member Functions | |
| CVODERHSOutputData | calculate_rhs (sunrealtype t, N_Vector y, N_Vector ydot, const CVODEUserData *data) const |
| Compute RHS into ydot at time t from the engine and current state y. | |
| void | initialize_cvode_integration_resources (PointSolverContext *ctx, uint64_t N, size_t numSpecies, double current_time, const fourdst::composition::Composition &composition, double absTol, double relTol, double accumulatedEnergy) const |
| Allocate and initialize CVODE vectors, linear algebra, tolerances, and constraints. | |
| void | log_step_diagnostics (PointSolverContext *sctx_p, engine::scratch::StateBlob &ctx, const CVODEUserData &user_data, bool displayJacobianStiffness, bool displaySpeciesBalance, bool to_file, std::optional< std::string > filename) const |
| Compute and print per-component error ratios; run diagnostic helpers. | |
+Static Private Member Functions | |
| static int | cvode_rhs_wrapper (sunrealtype t, N_Vector y, N_Vector ydot, void *user_data) |
| CVODE RHS C-wrapper that delegates to calculate_rhs and captures exceptions. | |
| static int | cvode_jac_wrapper (sunrealtype t, N_Vector y, N_Vector ydot, SUNMatrix J, void *user_data, N_Vector tmp1, N_Vector tmp2, N_Vector tmp3) |
| CVODE dense Jacobian C-wrapper that fills SUNDenseMatrix using the engine. | |
| static void | cvode_error_handler (int line, const char *func, const char *file, const char *msg, SUNErrCode err_code, void *err_user_data, SUNContext sunctx) |
| CVODE error handler that logs errors and warnings from SUNDIALS using the solver's logger. | |
+Private Attributes | |
| fourdst::config::Config< config::GridFireConfig > | m_config |
| quill::Logger * | m_logger = fourdst::logging::LogManager::getInstance().getLogger("log") |
+Additional Inherited Members | |
Protected Attributes inherited from gridfire::solver::SingleZoneNetworkSolver< engine::DynamicEngine > | |
| const EngineT & | m_engine |
| The engine used by this solver strategy. | |
| const EngineT & | m_engine |
| The engine used by this solver strategy. | |
Stiff ODE integrator backed by SUNDIALS CVODE (BDF) for network + energy.
+Integrates the nuclear network abundances along with a final accumulator entry for specific energy using CVODE's BDF method and a dense linear solver. The state vector layout is: [y_0, y_1, ..., y_{N-1}, eps], where eps is the accumulated specific energy (erg/g).
+Implementation summary:
+
|
+ +explicit | +
Construct the CVODE strategy and create a SUNDIALS context.
+| engine | DynamicEngine used for RHS/Jacobian evaluation and network access. |
| std::runtime_error | If SUNContext_Create fails. |
| gridfire::solver::PointSolver::PointSolver | +( | +const engine::DynamicEngine & | engine, | +
| + | + | const config::GridFireConfig & | config ) | +
+
|
+ +private | +
Compute RHS into ydot at time t from the engine and current state y.
+Converts the CVODE state to a Composition (mass fractions) and calls engine.calculateRHSAndEnergy(T9, rho). Negative small abundances are clamped to zero before constructing Composition. On stale engine, throws exceptions::StaleEngineTrigger.
+ +
+
|
+ +staticprivate | +
CVODE error handler that logs errors and warnings from SUNDIALS using the solver's logger.
+| line | |
| func | |
| file | |
| msg | |
| err_code | |
| err_user_data | |
| sunctx |
+
|
+ +staticprivate | +
CVODE dense Jacobian C-wrapper that fills SUNDenseMatrix using the engine.
+Assembles J(i,j) = d(f_i)/d(y_j) for all species using engine->getJacobianMatrixEntry, then zeros the last row and column corresponding to the energy variable.
+ +
+
|
+ +staticprivate | +
CVODE RHS C-wrapper that delegates to calculate_rhs and captures exceptions.
+
+
|
+ +overridevirtual | +
Integrate from t=0 to netIn.tMax and return final composition and energy.
+Implementation summary:
| solver_ctx | |
| netIn | Inputs: temperature [K], density [g cm^-3], tMax [s], composition. |
| std::runtime_error | If any CVODE or SUNDIALS call fails (negative return codes), or if internal consistency checks fail during engine updates. |
| exceptions::StaleEngineTrigger | Propagated if the engine signals a stale state during RHS evaluation (captured in the wrapper then rethrown here). |
Implements gridfire::solver::SingleZoneNetworkSolver< engine::DynamicEngine >.
+ +| NetOut gridfire::solver::PointSolver::evaluate | +( | +SolverContextBase & | solver_ctx, | +
| + | + | const NetIn & | netIn, | +
| + | + | bool | displayTrigger, | +
| + | + | bool | forceReinitialize = false ) const | +
Call to evaluate which will let the user control if the trigger reasoning is displayed.
+| solver_ctx | |
| netIn | Inputs: temperature [K], density [g cm^-3], tMax [s], composition. |
| displayTrigger | Boolean flag to control if trigger reasoning is displayed |
| forceReinitialize | Boolean flag to force reinitialization of CVODE resources at the start |
| std::runtime_error | If any CVODE or SUNDIALS call fails (negative return codes), or if internal consistency checks fail during engine updates. |
| exceptions::StaleEngineTrigger | Propagated if the engine signals a stale state during RHS evaluation (captured in the wrapper then rethrown here). |
+
|
+ +inline | +
+
|
+ +private | +
Allocate and initialize CVODE vectors, linear algebra, tolerances, and constraints.
+State vector m_Y is sized to N (numSpecies + 1). Species slots are initialized from Composition molar abundances when present, otherwise a tiny positive value; the last slot is set to accumulatedEnergy. Sets scalar tolerances, non-negativity constraints for species, maximum step size, creates a dense matrix and dense linear solver, and registers the Jacobian.
+ +
+
|
+ +private | +
Compute and print per-component error ratios; run diagnostic helpers.
+Gathers CVODE's estimated local errors, converts the state to a Composition, and prints a sorted table of species with the highest error ratios; then invokes diagnostic routines to inspect Jacobian stiffness and species balance.
+ +
+
|
+ +private | +
+
|
+ +private | +
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
This is the complete list of members for gridfire::solver::SingleZoneNetworkSolver< EngineT >, including all inherited members.
+| evaluate(SolverContextBase &solver_ctx, const NetIn &netIn) const =0 | gridfire::solver::SingleZoneNetworkSolver< EngineT > | pure virtual |
| m_engine | gridfire::solver::SingleZoneNetworkSolver< EngineT > | protected |
| SingleZoneNetworkSolver(const EngineT &engine) | gridfire::solver::SingleZoneNetworkSolver< EngineT > | inlineexplicit |
| ~SingleZoneNetworkSolver()=default | gridfire::solver::SingleZoneNetworkSolver< EngineT > | virtual |
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
Abstract base class for network solver strategies. + More...
+ +#include <strategy_abstract.h>
+Public Member Functions | |
| SingleZoneNetworkSolver (const EngineT &engine) | |
| Constructor for the NetworkSolverStrategy. | |
| virtual | ~SingleZoneNetworkSolver ()=default |
| Virtual destructor. | |
| virtual NetOut | evaluate (SolverContextBase &solver_ctx, const NetIn &netIn) const =0 |
| Evaluates the network for a given timestep. | |
+Protected Attributes | |
| const EngineT & | m_engine |
| The engine used by this solver strategy. | |
Abstract base class for network solver strategies.
+This class defines the interface for network solver strategies, which are responsible for integrating the reaction network ODEs over a given timestep. It is templated on the engine type to allow for different engine implementations to be used with the same solver.
+| EngineT | The type of engine to use with this solver strategy. Must inherit from Engine. |
+
|
+ +inlineexplicit | +
Constructor for the NetworkSolverStrategy.
+| engine | The engine to use for evaluating the network. |
+
|
+ +virtualdefault | +
Virtual destructor.
+ +
+
|
+ +pure virtual | +
Evaluates the network for a given timestep.
+| solver_ctx | |
| engine_ctx | |
| netIn | The input conditions for the network. |
Implemented in gridfire::solver::PointSolver, and PySingleZoneDynamicNetworkSolver.
+ +
+
|
+ +protected | +
The engine used by this solver strategy.
+ +|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
This is the complete list of members for gridfire::solver::TimestepContextBase, including all inherited members.
+| describe() const =0 | gridfire::solver::TimestepContextBase | pure virtual |
| ~TimestepContextBase()=default | gridfire::solver::TimestepContextBase | virtual |
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
Base class for solver callback contexts. + More...
+ +#include <strategy_abstract.h>
+Public Member Functions | |
| virtual | ~TimestepContextBase ()=default |
| virtual std::vector< std::tuple< std::string, std::string > > | describe () const =0 |
| Describe the context for callback functions. | |
Base class for solver callback contexts.
+This struct serves as a base class for contexts that can be passed to solver callbacks, it enforces that derived classes implement a describe method that returns a vector of tuples describing the context that a callback will receive when called.
+
|
+ +virtualdefault | +
+
|
+ +nodiscardpure virtual | +
Describe the context for callback functions.
+This method should be overridden by derived classes to provide a description of the context that will be passed to the callback function. The intent of this method is that an end user can investigate the context that will be passed to the callback function, and use this information to craft their own callback function.
+ +Implemented in gridfire::solver::PointSolverTimestepContext, and PyTimestepContextBase.
+ +Implemented in 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, and gridfire::trigger::solver::CVODE::TimestepCollapseTrigger.
+Implemented in gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::solver::CVODE::BoundaryFluxTrigger, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, and gridfire::trigger::solver::CVODE::TimestepCollapseTrigger.
@@ -263,7 +263,7 @@ template<typename TriggerContextStruct>Human-readable description of this trigger's logic.
-Implemented in 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, and gridfire::trigger::solver::CVODE::TimestepCollapseTrigger.
+Implemented in gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::solver::CVODE::BoundaryFluxTrigger, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, and gridfire::trigger::solver::CVODE::TimestepCollapseTrigger.
@@ -294,7 +294,7 @@ template<typename TriggerContextStruct>Short, stable name for this trigger (suitable for logs/UI).
-Implemented in 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, and gridfire::trigger::solver::CVODE::TimestepCollapseTrigger.
+Implemented in gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::solver::CVODE::BoundaryFluxTrigger, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, and gridfire::trigger::solver::CVODE::TimestepCollapseTrigger.
@@ -325,7 +325,7 @@ template<typename TriggerContextStruct>Total number of times this trigger evaluated to false since last reset.
-Implemented in 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, and gridfire::trigger::solver::CVODE::TimestepCollapseTrigger.
+Implemented in gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::solver::CVODE::BoundaryFluxTrigger, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, and gridfire::trigger::solver::CVODE::TimestepCollapseTrigger.
@@ -356,7 +356,7 @@ template<typename TriggerContextStruct>Total number of times this trigger evaluated to true since last reset.
-Implemented in 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, and gridfire::trigger::solver::CVODE::TimestepCollapseTrigger.
+Implemented in gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::solver::CVODE::BoundaryFluxTrigger, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, and gridfire::trigger::solver::CVODE::TimestepCollapseTrigger.
@@ -387,7 +387,7 @@ template<typename TriggerContextStruct>Reset internal state and diagnostics counters.
-Implemented in 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, and gridfire::trigger::solver::CVODE::TimestepCollapseTrigger.
+Implemented in gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::solver::CVODE::BoundaryFluxTrigger, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, and gridfire::trigger::solver::CVODE::TimestepCollapseTrigger.
@@ -424,7 +424,7 @@ template<typename TriggerContextStruct> -Implemented in 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, and gridfire::trigger::solver::CVODE::TimestepCollapseTrigger.
+Implemented in gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::solver::CVODE::BoundaryFluxTrigger, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, and gridfire::trigger::solver::CVODE::TimestepCollapseTrigger.
@@ -461,7 +461,7 @@ template<typename TriggerContextStruct> -Implemented in 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, and gridfire::trigger::solver::CVODE::TimestepCollapseTrigger.
+Implemented in gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::solver::CVODE::BoundaryFluxTrigger, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, and gridfire::trigger::solver::CVODE::TimestepCollapseTrigger.
@@ -499,7 +499,7 @@ template<typename TriggerContextStruct>Implemented in 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, and gridfire::trigger::solver::CVODE::TimestepCollapseTrigger.
+Implemented in gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::solver::CVODE::BoundaryFluxTrigger, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::SimulationTimeTrigger, and gridfire::trigger::solver::CVODE::TimestepCollapseTrigger.
diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_boundary_flux_trigger-members.html b/docs/html/classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_boundary_flux_trigger-members.html new file mode 100644 index 00000000..ef19e5a7 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_boundary_flux_trigger-members.html @@ -0,0 +1,137 @@ + + + + + + + +|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
This is the complete list of members for gridfire::trigger::solver::CVODE::BoundaryFluxTrigger, including all inherited members.
+|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
#include <engine_partitioning_trigger.h>
+Public Member Functions | |
| BoundaryFluxTrigger (double relativeThreshold, double absoluteThreshold) | |
| bool | check (const gridfire::solver::PointSolverTimestepContext &ctx) const override |
| Evaluate the trigger condition against the provided context. | |
| void | update (const gridfire::solver::PointSolverTimestepContext &ctx) override |
| Update any internal state with the given context (e.g., counters, windows). | |
| void | step (const gridfire::solver::PointSolverTimestepContext &ctx) override |
| similar to update but intended to be run on every step not just those where the trigger triggered | |
| void | reset () override |
| Reset internal state and diagnostics counters. | |
| std::string | name () const override |
| Short, stable name for this trigger (suitable for logs/UI). | |
| TriggerResult | why (const gridfire::solver::PointSolverTimestepContext &ctx) const override |
| Explain why the last evaluation would be true/false in a structured way. | |
| std::string | describe () const override |
| Human-readable description of this trigger's logic. | |
| size_t | numTriggers () const override |
| Total number of times this trigger evaluated to true since last reset. | |
| size_t | numMisses () const override |
| Total number of times this trigger evaluated to false since last reset. | |
Public Member Functions inherited from gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext > | |
| virtual | ~Trigger ()=default |
| Virtual destructor for polymorphic use. | |
+Private Types | |
| enum class | ReactionSetType : uint8_t { ACTIVE +, INACTIVE + } |
+Static Private Member Functions | |
| static double | get_reaction_set_flow (const reaction::ReactionSet &reactions, const gridfire::solver::PointSolverTimestepContext &ctx, const fourdst::composition::Composition &comp, double T9, double rho, ReactionSetType type) |
+Private Attributes | |
| quill::Logger * | m_logger = fourdst::logging::LogManager::getInstance().getLogger("log") |
| size_t | m_hits = 0 |
| size_t | m_misses = 0 |
| size_t | m_updates = 0 |
| size_t | m_resets = 0 |
| double | m_relativeThreshold |
| double | m_absoluteThreshold |
+
|
+ +strongprivate | +
+
|
+ +explicit | +
+
|
+ +overridevirtual | +
Evaluate the trigger condition against the provided context.
+| ctx | Context snapshot (immutable view) used to evaluate the condition. |
Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
+ +
+
|
+ +overridevirtual | +
Human-readable description of this trigger's logic.
+ +Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
+ +
+
|
+ +staticprivate | +
+
|
+ +overridevirtual | +
Short, stable name for this trigger (suitable for logs/UI).
+ +Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
+ +
+
|
+ +overridevirtual | +
Total number of times this trigger evaluated to false since last reset.
+ +Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
+ +
+
|
+ +overridevirtual | +
Total number of times this trigger evaluated to true since last reset.
+ +Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
+ +
+
|
+ +overridevirtual | +
Reset internal state and diagnostics counters.
+ +Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
+ +
+
|
+ +overridevirtual | +
similar to update but intended to be run on every step not just those where the trigger triggered
+| ctx | Context snapshot used to update state. |
Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
+ +
+
|
+ +overridevirtual | +
Update any internal state with the given context (e.g., counters, windows).
+| ctx | Context snapshot used to update state. |
Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
+ +
+
|
+ +overridevirtual | +
Explain why the last evaluation would be true/false in a structured way.
+| ctx | Context snapshot for the explanation. |
Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
+ +
+
|
+ +private | +
+
|
+ +mutableprivate | +
+
|
+ +private | +
+
|
+ +mutableprivate | +
+
|
+ +private | +
+
|
+ +mutableprivate | +
+
|
+ +mutableprivate | +
This is the complete list of members for gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, including all inherited members.
Public Member Functions | |
| ConvergenceFailureTrigger (size_t totalFailures, float relativeFailureRate, size_t windowSize) | |
| bool | check (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const override |
| Evaluate the trigger condition against the provided context. | |
| void | update (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) override |
| Update any internal state with the given context (e.g., counters, windows). | |
| void | step (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) override |
| similar to update but intended to be run on every step not just those where the trigger triggered | |
| bool | check (const gridfire::solver::PointSolverTimestepContext &ctx) const override |
| Evaluate the trigger condition against the provided context. | |
| void | update (const gridfire::solver::PointSolverTimestepContext &ctx) override |
| Update any internal state with the given context (e.g., counters, windows). | |
| void | step (const gridfire::solver::PointSolverTimestepContext &ctx) override |
| similar to update but intended to be run on every step not just those where the trigger triggered | |
| void | reset () override |
| Reset internal state and diagnostics counters. | |
| std::string | describe () const override |
| Human-readable description of this trigger's logic. | |
| TriggerResult | why (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const override |
| Explain why the last evaluation would be true/false in a structured way. | |
| TriggerResult | why (const gridfire::solver::PointSolverTimestepContext &ctx) const override |
| Explain why the last evaluation would be true/false in a structured way. | |
| size_t | numTriggers () const override |
| Total number of times this trigger evaluated to true since last reset. | |
| size_t | numMisses () const override |
| Total number of times this trigger evaluated to false since last reset. | |
Public Member Functions inherited from gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext > | |
Public Member Functions inherited from gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext > | |
| virtual | ~Trigger ()=default |
| Virtual destructor for polymorphic use. | |
| float | current_mean () const |
| bool | abs_failure (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const |
| bool | rel_failure (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const |
| bool | abs_failure (const gridfire::solver::PointSolverTimestepContext &ctx) const |
| bool | rel_failure (const gridfire::solver::PointSolverTimestepContext &ctx) const |
Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
Human-readable description of this trigger's logic.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
@@ -361,7 +361,7 @@ Private AttributesShort, stable name for this trigger (suitable for logs/UI).
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
@@ -390,7 +390,7 @@ Private AttributesTotal number of times this trigger evaluated to false since last reset.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
@@ -419,12 +419,12 @@ Private AttributesTotal number of times this trigger evaluated to true since last reset.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
- -Reset internal state and diagnostics counters.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
This is the complete list of members for gridfire::trigger::solver::CVODE::OffDiagonalTrigger, including all inherited members.
@@ -127,24 +127,24 @@ Public Member Functions | ||||||||
| OffDiagonalTrigger (double threshold) | ||||||||
| Construct with a non-negative magnitude threshold. | ||||||||
| bool | check (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const override | |||||||
| Check if any off-diagonal Jacobian entry exceeds the threshold. | ||||||||
| void | update (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) override | |||||||
| Record an update; does not mutate any Jacobian-related state. | ||||||||
| void | step (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) override | |||||||
| similar to update but intended to be run on every step not just those where the trigger triggered | ||||||||
| bool | check (const gridfire::solver::PointSolverTimestepContext &ctx) const override | |||||||
| Check if any off-diagonal Jacobian entry exceeds the threshold. | ||||||||
| void | update (const gridfire::solver::PointSolverTimestepContext &ctx) override | |||||||
| Record an update; does not mutate any Jacobian-related state. | ||||||||
| void | step (const gridfire::solver::PointSolverTimestepContext &ctx) override | |||||||
| similar to update but intended to be run on every step not just those where the trigger triggered | ||||||||
| void | reset () override | |||||||
| Reset counters to zero. | ||||||||
| std::string | name () const override | |||||||
| Stable human-readable name. | ||||||||
| TriggerResult | why (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const override | |||||||
| Structured explanation of the evaluation outcome. | ||||||||
| TriggerResult | why (const gridfire::solver::PointSolverTimestepContext &ctx) const override | |||||||
| Structured explanation of the evaluation outcome. | ||||||||
| std::string | describe () const override | |||||||
| Textual description including configured threshold. | ||||||||
| size_t | numMisses () const override | |||||||
| Number of false evaluations since last reset. | ||||||||
Public Member Functions inherited from gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext > | ||||||||
Public Member Functions inherited from gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext > | ||||||||
| virtual | ~Trigger ()=default | |||||||
| Virtual destructor for polymorphic use. | ||||||||
| bool gridfire::trigger::solver::CVODE::OffDiagonalTrigger::check | ( | -const gridfire::solver::CVODESolverStrategy::TimestepContext & | ctx | ) | +const gridfire::solver::PointSolverTimestepContext & | ctx | ) | const |
Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
@@ -295,7 +295,7 @@ Private AttributesTextual description including configured threshold.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
@@ -324,7 +324,7 @@ Private AttributesStable human-readable name.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
@@ -353,7 +353,7 @@ Private AttributesNumber of false evaluations since last reset.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
@@ -382,7 +382,7 @@ Private AttributesNumber of true evaluations since last reset.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
@@ -411,12 +411,12 @@ Private AttributesReset counters to zero.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
- -Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
This is the complete list of members for gridfire::trigger::solver::CVODE::SimulationTimeTrigger, including all inherited members.
@@ -127,24 +127,24 @@ Public Member Functions | ||||||||
| SimulationTimeTrigger (double interval) | ||||||||
| Construct with a positive time interval between firings. | ||||||||
| bool | check (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const override | |||||||
| Evaluate whether enough simulated time has elapsed since the last trigger. | ||||||||
| void | update (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) override | |||||||
| Update internal state; if check(ctx) is true, advance last_trigger_time. | ||||||||
| void | step (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) override | |||||||
| similar to update but intended to be run on every step not just those where the trigger triggered | ||||||||
| bool | check (const gridfire::solver::PointSolverTimestepContext &ctx) const override | |||||||
| Evaluate whether enough simulated time has elapsed since the last trigger. | ||||||||
| void | update (const gridfire::solver::PointSolverTimestepContext &ctx) override | |||||||
| Update internal state; if check(ctx) is true, advance last_trigger_time. | ||||||||
| void | step (const gridfire::solver::PointSolverTimestepContext &ctx) override | |||||||
| similar to update but intended to be run on every step not just those where the trigger triggered | ||||||||
| void | reset () override | |||||||
| Reset counters and last trigger bookkeeping (time and delta) to zero. | ||||||||
| std::string | name () const override | |||||||
| Stable human-readable name. | ||||||||
| TriggerResult | why (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const override | |||||||
| Structured explanation of the evaluation outcome. | ||||||||
| TriggerResult | why (const gridfire::solver::PointSolverTimestepContext &ctx) const override | |||||||
| Structured explanation of the evaluation outcome. | ||||||||
| std::string | describe () const override | |||||||
| Textual description including configured interval. | ||||||||
| size_t | numMisses () const override | |||||||
| Number of false evaluations since last reset. | ||||||||
Public Member Functions inherited from gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext > | ||||||||
Public Member Functions inherited from gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext > | ||||||||
| virtual | ~Trigger ()=default | |||||||
| Virtual destructor for polymorphic use. | ||||||||
| bool gridfire::trigger::solver::CVODE::SimulationTimeTrigger::check | ( | -const gridfire::solver::CVODESolverStrategy::TimestepContext & | ctx | ) | +const gridfire::solver::PointSolverTimestepContext & | ctx | ) | const |
Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
@@ -299,7 +299,7 @@ Private AttributesTextual description including configured interval.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
@@ -328,7 +328,7 @@ Private AttributesStable human-readable name.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
@@ -357,7 +357,7 @@ Private AttributesNumber of false evaluations since last reset.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
@@ -386,7 +386,7 @@ Private AttributesNumber of true evaluations since last reset.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
@@ -415,12 +415,12 @@ Private AttributesReset counters and last trigger bookkeeping (time and delta) to zero.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
- -Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
This is the complete list of members for gridfire::trigger::solver::CVODE::TimestepCollapseTrigger, including all inherited members.
@@ -130,24 +130,24 @@ Public Member Functions | ||||||||
| TimestepCollapseTrigger (double threshold, bool relative, size_t windowSize) | ||||||||
| Construct with threshold, mode, and window size. | ||||||||
| bool | check (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const override | |||||||
| Evaluate whether the current dt deviates sufficiently from recent average. | ||||||||
| void | update (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) override | |||||||
| Update sliding window with the most recent dt and increment update counter. | ||||||||
| void | step (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) override | |||||||
| similar to update but intended to be run on every step not just those where the trigger triggered | ||||||||
| bool | check (const gridfire::solver::PointSolverTimestepContext &ctx) const override | |||||||
| Evaluate whether the current dt deviates sufficiently from recent average. | ||||||||
| void | update (const gridfire::solver::PointSolverTimestepContext &ctx) override | |||||||
| Update sliding window with the most recent dt and increment update counter. | ||||||||
| void | step (const gridfire::solver::PointSolverTimestepContext &ctx) override | |||||||
| similar to update but intended to be run on every step not just those where the trigger triggered | ||||||||
| void | reset () override | |||||||
| Reset counters and clear the dt window. | ||||||||
| std::string | name () const override | |||||||
| Stable human-readable name. | ||||||||
| TriggerResult | why (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const override | |||||||
| Structured explanation of the evaluation outcome. | ||||||||
| TriggerResult | why (const gridfire::solver::PointSolverTimestepContext &ctx) const override | |||||||
| Structured explanation of the evaluation outcome. | ||||||||
| std::string | describe () const override | |||||||
| Textual description including threshold, mode, and window size. | ||||||||
| size_t | numMisses () const override | |||||||
| Number of false evaluations since last reset. | ||||||||
Public Member Functions inherited from gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext > | ||||||||
Public Member Functions inherited from gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext > | ||||||||
| virtual | ~Trigger ()=default | |||||||
| Virtual destructor for polymorphic use. | ||||||||
| bool gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::check | ( | -const gridfire::solver::CVODESolverStrategy::TimestepContext & | ctx | ) | +const gridfire::solver::PointSolverTimestepContext & | ctx | ) | const |
Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
@@ -373,7 +373,7 @@ Private AttributesTextual description including threshold, mode, and window size.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
@@ -402,7 +402,7 @@ Private AttributesStable human-readable name.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
@@ -431,7 +431,7 @@ Private AttributesNumber of false evaluations since last reset.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
@@ -460,7 +460,7 @@ Private AttributesNumber of true evaluations since last reset.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
@@ -489,12 +489,12 @@ Private AttributesReset counters and clear the dt window.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
- -Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
Structured explanation of the evaluation outcome.
-Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.
+Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
Concept that constrains types to valid scratchpad implementations. +More...
+ +#include <blob.h>
Concept that constrains types to valid scratchpad implementations.
+A type satisfies IsScratchPad if:
| T | The type to check against the concept. |
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
#include <strategy_abstract.h>
| ▼Ngridfire | |||||
| ▼Nengine | |||||
| REngineType | Concept for types allowed as engine bases in EngineView | ||||
| ▼Nutils | |||||
| RStreamable | |||||
| RIsArithmeticOrAD | Concept for types allowed in engine calculations | ||||
| ▼Ngridfire | |
| ▼Nengine | |
| ▼Nscratch | Scratchpad memory management for computational engines |
| RIsScratchPad | Concept that constrains types to valid scratchpad implementations |
| REngineType | Concept for types allowed as engine bases in EngineView |
| ▼Nsolver | |
| RIsEngine | |
| ▼Nutils | |
| RStreamable | |
| RIsArithmeticOrAD | Concept for types allowed in engine calculations |
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
+Functions | |
| void | register_config_bindings (pybind11::module &m) |
| void register_config_bindings | +( | +pybind11::module & | m | ) | ++ |
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
#include <pybind11/pybind11.h>+Functions | |
| void | register_config_bindings (pybind11::module &m) |
| void register_config_bindings | +( | +pybind11::module & | m | ) | ++ |
|
+ GridFire v0.7.6rc4.0
+
+ General Purpose Nuclear Network
+ |
+
#include "fourdst/config/config.h"+Classes | |
| struct | gridfire::config::BoundaryFluxConfig |
| struct | gridfire::config::TriggerConfig |
| struct | gridfire::config::PointSolverConfig |
| struct | gridfire::config::SolverConfig |
| struct | gridfire::config::AdaptiveEngineViewConfig |
| struct | gridfire::config::EngineViewConfig |
| struct | gridfire::config::EngineConfig |
| struct | gridfire::config::GridFireConfig |
+Namespaces | |
| namespace | gridfire |
| namespace | gridfire::config |
+Classes | |
| class | gridfire::engine::ReactionSet |
| class | gridfire::engine::Reaction |
| Represents a single nuclear reaction from a specific data source. More... | |
Namespaces | |
| namespace | gridfire |
| namespace | gridfire |
| namespace | gridfire::engine |
| namespace | gridfire::engine |
Functions | |
| reaction::ReactionSet | gridfire::engine::build_nuclear_network (const fourdst::composition::CompositionAbstract &composition, const rates::weak::WeakRateInterpolator &weakInterpolator, BuildDepthType maxLayers=NetworkBuildDepth::Full, NetworkConstructionFlags ReactionTypes=NetworkConstructionFlags::DEFAULT) |
| reaction::ReactionSet | gridfire::engine::build_nuclear_network (const fourdst::composition::CompositionAbstract &composition, const rates::weak::WeakRateInterpolator &weakInterpolator, BuildDepthType maxLayers=NetworkBuildDepth::Full, NetworkConstructionFlags ReactionTypes=NetworkConstructionFlags::DEFAULT) |
| Builds a nuclear reaction network from the Reaclib library based on an initial composition. | |