diff --git a/docs/html/CVODE__solver__strategy_8cpp.html b/docs/html/CVODE__solver__strategy_8cpp.html new file mode 100644 index 00000000..fbed9d72 --- /dev/null +++ b/docs/html/CVODE__solver__strategy_8cpp.html @@ -0,0 +1,143 @@ + + + + + + + +GridFire: src/lib/solver/strategies/CVODE_solver_strategy.cpp File Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Namespaces
+
CVODE_solver_strategy.cpp File Reference
+
+
+
#include "gridfire/solver/strategies/CVODE_solver_strategy.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/engine/types/engine_types.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 dependency graph for CVODE_solver_strategy.cpp:
+
+
+
+
+ + + + + +

+Namespaces

namespace  gridfire
 
namespace  gridfire::solver
 
+
+
+ + + + diff --git a/docs/html/CVODE__solver__strategy_8cpp__incl.map b/docs/html/CVODE__solver__strategy_8cpp__incl.map new file mode 100644 index 00000000..93b2110c --- /dev/null +++ b/docs/html/CVODE__solver__strategy_8cpp__incl.map @@ -0,0 +1,158 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/CVODE__solver__strategy_8cpp__incl.md5 b/docs/html/CVODE__solver__strategy_8cpp__incl.md5 new file mode 100644 index 00000000..d88b1ce0 --- /dev/null +++ b/docs/html/CVODE__solver__strategy_8cpp__incl.md5 @@ -0,0 +1 @@ +4ef6feb637cca9354f3d5e12f58efef8 \ No newline at end of file diff --git a/docs/html/CVODE__solver__strategy_8cpp__incl.svg b/docs/html/CVODE__solver__strategy_8cpp__incl.svg new file mode 100644 index 00000000..85a4c1e5 --- /dev/null +++ b/docs/html/CVODE__solver__strategy_8cpp__incl.svg @@ -0,0 +1,1519 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +src/lib/solver/strategies/CVODE_solver_strategy.cpp + + +Node1 + + +src/lib/solver/strategies +/CVODE_solver_strategy.cpp + + + + + +Node2 + + +gridfire/solver/strategies +/CVODE_solver_strategy.h + + + + + +Node1->Node2 + + + + + + + + +Node11 + + +unordered_map + + + + + +Node1->Node11 + + + + + + + + +Node15 + + +fourdst/composition +/composition.h + + + + + +Node1->Node15 + + + + + + + + +Node16 + + +gridfire/types/types.h + + + + + +Node1->Node16 + + + + + + + + +Node22 + + +string + + + + + +Node1->Node22 + + + + + + + + +Node46 + + +gridfire/exceptions +/error_solver.h + + + + + +Node1->Node46 + + + + + + + + +Node54 + + +gridfire/utils/table +_format.h + + + + + +Node1->Node54 + + + + + + + + +Node56 + + +algorithm + + + + + +Node1->Node56 + + + + + + + + +Node61 + + +gridfire/engine/diagnostics +/dynamic_engine_diagnostics.h + + + + + +Node1->Node61 + + + + + + + + +Node62 + + +quill/LogMacros.h + + + + + +Node1->Node62 + + + + + + + + +Node63 + + +cstdint + + + + + +Node1->Node63 + + + + + + + + +Node64 + + +limits + + + + + +Node1->Node64 + + + + + + + + +Node65 + + +stdexcept + + + + + +Node1->Node65 + + + + + + + + +Node66 + + +fourdst/atomic/species.h + + + + + +Node1->Node66 + + + + + + + + +Node67 + + +fourdst/composition +/exceptions/exceptions +_composition.h + + + + + +Node1->Node67 + + + + + + + + +Node68 + + +gridfire/engine/engine +_graph.h + + + + + +Node1->Node68 + + + + + + + + +Node79 + + +gridfire/engine/types +/engine_types.h + + + + + +Node1->Node79 + + + + + + + + +Node80 + + +gridfire/solver/strategies +/triggers/engine_partitioning +_trigger.h + + + + + +Node1->Node80 + + + + + + + + +Node84 + + +gridfire/trigger/procedures +/trigger_pprint.h + + + + + +Node1->Node84 + + + + + + + + +Node86 + + +gridfire/utils/sundials.h + + + + + +Node1->Node86 + + + + + + + + +Node3 + + +gridfire/solver/strategies +/strategy_abstract.h + + + + + +Node2->Node3 + + + + + + + + +Node4 + + +gridfire/engine/engine +_abstract.h + + + + + +Node2->Node4 + + + + + + + + +Node8 + + +fourdst/atomic/atomicSpecies.h + + + + + +Node2->Node8 + + + + + + + + +Node12 + + +vector + + + + + +Node2->Node12 + + + + + + + + +Node2->Node16 + + + + + + + + +Node31 + + +functional + + + + + +Node2->Node31 + + + + + + + + +Node35 + + +any + + + + + +Node2->Node35 + + + + + + + + +Node30 + + +tuple + + + + + +Node2->Node30 + + + + + + + + +Node2->Node22 + + + + + + + + +Node36 + + +gridfire/exceptions +/exceptions.h + + + + + +Node2->Node36 + + + + + + + + +Node47 + + +fourdst/config/config.h + + + + + +Node2->Node47 + + + + + + + + +Node48 + + +cvode/cvode.h + + + + + +Node2->Node48 + + + + + + + + +Node49 + + +sundials/sundials_types.h + + + + + +Node2->Node49 + + + + + + + + +Node50 + + +sundials/sundials_context.h + + + + + +Node2->Node50 + + + + + + + + +Node51 + + +sunmatrix/sunmatrix +_dense.h + + + + + +Node2->Node51 + + + + + + + + +Node52 + + +sunlinsol/sunlinsol +_dense.h + + + + + +Node2->Node52 + + + + + + + + +Node53 + + +nvector/nvector_serial.h + + + + + +Node2->Node53 + + + + + + + + +Node3->Node4 + + + + + + + + +Node3->Node12 + + + + + + + + +Node3->Node16 + + + + + + + + +Node3->Node31 + + + + + + + + +Node3->Node35 + + + + + + + + +Node3->Node30 + + + + + + + + +Node3->Node22 + + + + + + + + +Node5 + + +gridfire/reaction/reaction.h + + + + + +Node4->Node5 + + + + + + + + +Node4->Node11 + + + + + + + + +Node4->Node12 + + + + + + + + +Node4->Node16 + + + + + + + + +Node17 + + +gridfire/screening +/screening_abstract.h + + + + + +Node4->Node17 + + + + + + + + +Node18 + + +gridfire/screening +/screening_types.h + + + + + +Node4->Node18 + + + + + + + + +Node33 + + +utility + + + + + +Node4->Node33 + + + + + + + + +Node5->Node8 + + + + + + + + +Node9 + + +fourdst/logging/logging.h + + + + + +Node5->Node9 + + + + + + + + +Node5->Node11 + + + + + + + + +Node5->Node12 + + + + + + + + +Node14 + + +cppad/cppad.hpp + + + + + +Node5->Node14 + + + + + + + + +Node5->Node15 + + + + + + + + +Node16->Node14 + + + + + + + + +Node16->Node15 + + + + + + + + +Node17->Node5 + + + + + + + + +Node17->Node8 + + + + + + + + +Node17->Node12 + + + + + + + + +Node17->Node14 + + + + + + + + +Node18->Node17 + + + + + + + + +Node19 + + +memory + + + + + +Node18->Node19 + + + + + + + + +Node36->Node46 + + + + + + + + +Node54->Node12 + + + + + + + + +Node54->Node19 + + + + + + + + +Node54->Node33 + + + + + + + + +Node54->Node22 + + + + + + + + +Node24 + + +sstream + + + + + +Node54->Node24 + + + + + + + + +Node55 + + +iomanip + + + + + +Node54->Node55 + + + + + + + + +Node54->Node56 + + + + + + + + +Node57 + + +numeric + + + + + +Node54->Node57 + + + + + + + + +Node58 + + +print + + + + + +Node54->Node58 + + + + + + + + +Node59 + + +cwchar + + + + + +Node54->Node59 + + + + + + + + +Node60 + + +nlohmann/json.hpp + + + + + +Node54->Node60 + + + + + + + + +Node61->Node4 + + + + + + + + +Node61->Node12 + + + + + + + + +Node61->Node22 + + + + + + + + +Node61->Node60 + + + + + + + + +Node68->Node4 + + + + + + + + +Node68->Node5 + + + + + + + + +Node68->Node8 + + + + + + + + +Node68->Node9 + + + + + + + + +Node68->Node11 + + + + + + + + +Node68->Node12 + + + + + + + + +Node68->Node14 + + + + + + + + +Node68->Node15 + + + + + + + + +Node68->Node16 + + + + + + + + +Node68->Node17 + + + + + + + + +Node68->Node18 + + + + + + + + +Node68->Node19 + + + + + + + + +Node68->Node31 + + + + + + + + +Node68->Node22 + + + + + + + + +Node68->Node47 + + + + + + + + +Node69 + + +gridfire/partition +/partition_abstract.h + + + + + +Node68->Node69 + + + + + + + + +Node69->Node19 + + + + + + + + +Node69->Node22 + + + + + + + + +Node80->Node2 + + + + + + + + +Node80->Node9 + + + + + + + + +Node80->Node19 + + + + + + + + +Node80->Node22 + + + + + + + + +Node86->Node11 + + + + + + + + +Node86->Node46 + + + + + + + + +Node86->Node53 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/CVODE__solver__strategy_8cpp__incl_org.svg b/docs/html/CVODE__solver__strategy_8cpp__incl_org.svg new file mode 100644 index 00000000..3717053b --- /dev/null +++ b/docs/html/CVODE__solver__strategy_8cpp__incl_org.svg @@ -0,0 +1,1437 @@ + + + + + + +src/lib/solver/strategies/CVODE_solver_strategy.cpp + + +Node1 + + +src/lib/solver/strategies +/CVODE_solver_strategy.cpp + + + + + +Node2 + + +gridfire/solver/strategies +/CVODE_solver_strategy.h + + + + + +Node1->Node2 + + + + + + + + +Node11 + + +unordered_map + + + + + +Node1->Node11 + + + + + + + + +Node15 + + +fourdst/composition +/composition.h + + + + + +Node1->Node15 + + + + + + + + +Node16 + + +gridfire/types/types.h + + + + + +Node1->Node16 + + + + + + + + +Node22 + + +string + + + + + +Node1->Node22 + + + + + + + + +Node46 + + +gridfire/exceptions +/error_solver.h + + + + + +Node1->Node46 + + + + + + + + +Node54 + + +gridfire/utils/table +_format.h + + + + + +Node1->Node54 + + + + + + + + +Node56 + + +algorithm + + + + + +Node1->Node56 + + + + + + + + +Node61 + + +gridfire/engine/diagnostics +/dynamic_engine_diagnostics.h + + + + + +Node1->Node61 + + + + + + + + +Node62 + + +quill/LogMacros.h + + + + + +Node1->Node62 + + + + + + + + +Node63 + + +cstdint + + + + + +Node1->Node63 + + + + + + + + +Node64 + + +limits + + + + + +Node1->Node64 + + + + + + + + +Node65 + + +stdexcept + + + + + +Node1->Node65 + + + + + + + + +Node66 + + +fourdst/atomic/species.h + + + + + +Node1->Node66 + + + + + + + + +Node67 + + +fourdst/composition +/exceptions/exceptions +_composition.h + + + + + +Node1->Node67 + + + + + + + + +Node68 + + +gridfire/engine/engine +_graph.h + + + + + +Node1->Node68 + + + + + + + + +Node79 + + +gridfire/engine/types +/engine_types.h + + + + + +Node1->Node79 + + + + + + + + +Node80 + + +gridfire/solver/strategies +/triggers/engine_partitioning +_trigger.h + + + + + +Node1->Node80 + + + + + + + + +Node84 + + +gridfire/trigger/procedures +/trigger_pprint.h + + + + + +Node1->Node84 + + + + + + + + +Node86 + + +gridfire/utils/sundials.h + + + + + +Node1->Node86 + + + + + + + + +Node3 + + +gridfire/solver/strategies +/strategy_abstract.h + + + + + +Node2->Node3 + + + + + + + + +Node4 + + +gridfire/engine/engine +_abstract.h + + + + + +Node2->Node4 + + + + + + + + +Node8 + + +fourdst/atomic/atomicSpecies.h + + + + + +Node2->Node8 + + + + + + + + +Node12 + + +vector + + + + + +Node2->Node12 + + + + + + + + +Node2->Node16 + + + + + + + + +Node31 + + +functional + + + + + +Node2->Node31 + + + + + + + + +Node35 + + +any + + + + + +Node2->Node35 + + + + + + + + +Node30 + + +tuple + + + + + +Node2->Node30 + + + + + + + + +Node2->Node22 + + + + + + + + +Node36 + + +gridfire/exceptions +/exceptions.h + + + + + +Node2->Node36 + + + + + + + + +Node47 + + +fourdst/config/config.h + + + + + +Node2->Node47 + + + + + + + + +Node48 + + +cvode/cvode.h + + + + + +Node2->Node48 + + + + + + + + +Node49 + + +sundials/sundials_types.h + + + + + +Node2->Node49 + + + + + + + + +Node50 + + +sundials/sundials_context.h + + + + + +Node2->Node50 + + + + + + + + +Node51 + + +sunmatrix/sunmatrix +_dense.h + + + + + +Node2->Node51 + + + + + + + + +Node52 + + +sunlinsol/sunlinsol +_dense.h + + + + + +Node2->Node52 + + + + + + + + +Node53 + + +nvector/nvector_serial.h + + + + + +Node2->Node53 + + + + + + + + +Node3->Node4 + + + + + + + + +Node3->Node12 + + + + + + + + +Node3->Node16 + + + + + + + + +Node3->Node31 + + + + + + + + +Node3->Node35 + + + + + + + + +Node3->Node30 + + + + + + + + +Node3->Node22 + + + + + + + + +Node5 + + +gridfire/reaction/reaction.h + + + + + +Node4->Node5 + + + + + + + + +Node4->Node11 + + + + + + + + +Node4->Node12 + + + + + + + + +Node4->Node16 + + + + + + + + +Node17 + + +gridfire/screening +/screening_abstract.h + + + + + +Node4->Node17 + + + + + + + + +Node18 + + +gridfire/screening +/screening_types.h + + + + + +Node4->Node18 + + + + + + + + +Node33 + + +utility + + + + + +Node4->Node33 + + + + + + + + +Node5->Node8 + + + + + + + + +Node9 + + +fourdst/logging/logging.h + + + + + +Node5->Node9 + + + + + + + + +Node5->Node11 + + + + + + + + +Node5->Node12 + + + + + + + + +Node14 + + +cppad/cppad.hpp + + + + + +Node5->Node14 + + + + + + + + +Node5->Node15 + + + + + + + + +Node16->Node14 + + + + + + + + +Node16->Node15 + + + + + + + + +Node17->Node5 + + + + + + + + +Node17->Node8 + + + + + + + + +Node17->Node12 + + + + + + + + +Node17->Node14 + + + + + + + + +Node18->Node17 + + + + + + + + +Node19 + + +memory + + + + + +Node18->Node19 + + + + + + + + +Node36->Node46 + + + + + + + + +Node54->Node12 + + + + + + + + +Node54->Node19 + + + + + + + + +Node54->Node33 + + + + + + + + +Node54->Node22 + + + + + + + + +Node24 + + +sstream + + + + + +Node54->Node24 + + + + + + + + +Node55 + + +iomanip + + + + + +Node54->Node55 + + + + + + + + +Node54->Node56 + + + + + + + + +Node57 + + +numeric + + + + + +Node54->Node57 + + + + + + + + +Node58 + + +print + + + + + +Node54->Node58 + + + + + + + + +Node59 + + +cwchar + + + + + +Node54->Node59 + + + + + + + + +Node60 + + +nlohmann/json.hpp + + + + + +Node54->Node60 + + + + + + + + +Node61->Node4 + + + + + + + + +Node61->Node12 + + + + + + + + +Node61->Node22 + + + + + + + + +Node61->Node60 + + + + + + + + +Node68->Node4 + + + + + + + + +Node68->Node5 + + + + + + + + +Node68->Node8 + + + + + + + + +Node68->Node9 + + + + + + + + +Node68->Node11 + + + + + + + + +Node68->Node12 + + + + + + + + +Node68->Node14 + + + + + + + + +Node68->Node15 + + + + + + + + +Node68->Node16 + + + + + + + + +Node68->Node17 + + + + + + + + +Node68->Node18 + + + + + + + + +Node68->Node19 + + + + + + + + +Node68->Node31 + + + + + + + + +Node68->Node22 + + + + + + + + +Node68->Node47 + + + + + + + + +Node69 + + +gridfire/partition +/partition_abstract.h + + + + + +Node68->Node69 + + + + + + + + +Node69->Node19 + + + + + + + + +Node69->Node22 + + + + + + + + +Node80->Node2 + + + + + + + + +Node80->Node9 + + + + + + + + +Node80->Node19 + + + + + + + + +Node80->Node22 + + + + + + + + +Node86->Node11 + + + + + + + + +Node86->Node46 + + + + + + + + +Node86->Node53 + + + + + + + + diff --git a/docs/html/CVODE__solver__strategy_8h.html b/docs/html/CVODE__solver__strategy_8h.html new file mode 100644 index 00000000..44ad1a27 --- /dev/null +++ b/docs/html/CVODE__solver__strategy_8h.html @@ -0,0 +1,160 @@ + + + + + + + +GridFire: src/include/gridfire/solver/strategies/CVODE_solver_strategy.h File Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Classes | +Namespaces
+
CVODE_solver_strategy.h File Reference
+
+
+
#include "gridfire/solver/strategies/strategy_abstract.h"
+#include "gridfire/engine/engine_abstract.h"
+#include "gridfire/types/types.h"
+#include "gridfire/exceptions/exceptions.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>
+
+Include dependency graph for CVODE_solver_strategy.h:
+
+
+
+
+This graph shows which files directly or indirectly include this file:
+
+
+
+
+ + + + + + + + + + + + +

+Classes

class  gridfire::solver::CVODESolverStrategy
 Stiff ODE integrator backed by SUNDIALS CVODE (BDF) for network + energy. More...
 
struct  gridfire::solver::CVODESolverStrategy::TimestepContext
 Immutable view of the current integration state passed to callbacks. More...
 
struct  gridfire::solver::CVODESolverStrategy::CVODEUserData
 A helper struct to pass C++ context to C-style CVODE callbacks. More...
 
struct  gridfire::solver::CVODESolverStrategy::CVODERHSOutputData
 
+ + + + + +

+Namespaces

namespace  gridfire
 
namespace  gridfire::solver
 
+
+
+ + + + diff --git a/docs/html/CVODE__solver__strategy_8h.js b/docs/html/CVODE__solver__strategy_8h.js new file mode 100644 index 00000000..03a63e00 --- /dev/null +++ b/docs/html/CVODE__solver__strategy_8h.js @@ -0,0 +1,7 @@ +var CVODE__solver__strategy_8h = +[ + [ "gridfire::solver::CVODESolverStrategy", "classgridfire_1_1solver_1_1CVODESolverStrategy.html", "classgridfire_1_1solver_1_1CVODESolverStrategy" ], + [ "gridfire::solver::CVODESolverStrategy::TimestepContext", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext" ], + [ "gridfire::solver::CVODESolverStrategy::CVODEUserData", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData" ], + [ "gridfire::solver::CVODESolverStrategy::CVODERHSOutputData", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData.html", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData" ] +]; \ No newline at end of file diff --git a/docs/html/CVODE__solver__strategy_8h__dep__incl.map b/docs/html/CVODE__solver__strategy_8h__dep__incl.map new file mode 100644 index 00000000..80de5536 --- /dev/null +++ b/docs/html/CVODE__solver__strategy_8h__dep__incl.map @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/CVODE__solver__strategy_8h__dep__incl.md5 b/docs/html/CVODE__solver__strategy_8h__dep__incl.md5 new file mode 100644 index 00000000..e6ca6613 --- /dev/null +++ b/docs/html/CVODE__solver__strategy_8h__dep__incl.md5 @@ -0,0 +1 @@ +11658f31d55b9660868aec405a5ead80 \ No newline at end of file diff --git a/docs/html/CVODE__solver__strategy_8h__dep__incl.svg b/docs/html/CVODE__solver__strategy_8h__dep__incl.svg new file mode 100644 index 00000000..70dfc52c --- /dev/null +++ b/docs/html/CVODE__solver__strategy_8h__dep__incl.svg @@ -0,0 +1,456 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +src/include/gridfire/solver/strategies/CVODE_solver_strategy.h + + +Node1 + + +src/include/gridfire +/solver/strategies/CVODE +_solver_strategy.h + + + + + +Node2 + + +src/include/gridfire +/solver/strategies/strategies.h + + + + + +Node1->Node2 + + + + + + + + +Node8 + + +src/lib/engine/procedures +/priming.cpp + + + + + +Node1->Node8 + + + + + + + + +Node12 + + +src/python/solver/bindings.cpp + + + + + +Node1->Node12 + + + + + + + + +Node13 + + +src/include/gridfire +/solver/strategies/triggers +/engine_partitioning_trigger.h + + + + + +Node1->Node13 + + + + + + + + +Node15 + + +src/lib/solver/strategies +/CVODE_solver_strategy.cpp + + + + + +Node1->Node15 + + + + + + + + +Node16 + + +src/lib/solver/strategies +/triggers/engine_partitioning +_trigger.cpp + + + + + +Node1->Node16 + + + + + + + + +Node3 + + +src/include/gridfire +/solver/solver.h + + + + + +Node2->Node3 + + + + + + + + +Node4 + + +src/include/gridfire +/gridfire.h + + + + + +Node3->Node4 + + + + + + + + +Node3->Node8 + + + + + + + + +Node9 + + +src/lib/engine/views +/engine_priming.cpp + + + + + +Node3->Node9 + + + + + + + + +Node10 + + +src/python/solver/trampoline +/py_solver.cpp + + + + + +Node3->Node10 + + + + + + + + +Node11 + + +src/python/solver/trampoline +/py_solver.h + + + + + +Node3->Node11 + + + + + + + + +Node5 + + +src/extern/include +/gridfire/extern/gridfire +_context.h + + + + + +Node4->Node5 + + + + + + + + +Node7 + + +src/extern/lib/gridfire +_extern.cpp + + + + + +Node4->Node7 + + + + + + + + +Node6 + + +src/extern/lib/gridfire +_context.cpp + + + + + +Node5->Node6 + + + + + + + + +Node5->Node7 + + + + + + + + +Node11->Node10 + + + + + + + + +Node11->Node12 + + + + + + + + +Node14 + + +src/include/gridfire +/solver/strategies/triggers +/triggers.h + + + + + +Node13->Node14 + + + + + + + + +Node13->Node15 + + + + + + + + +Node13->Node16 + + + + + + + + +Node14->Node2 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/CVODE__solver__strategy_8h__dep__incl_org.svg b/docs/html/CVODE__solver__strategy_8h__dep__incl_org.svg new file mode 100644 index 00000000..6edbf8fc --- /dev/null +++ b/docs/html/CVODE__solver__strategy_8h__dep__incl_org.svg @@ -0,0 +1,374 @@ + + + + + + +src/include/gridfire/solver/strategies/CVODE_solver_strategy.h + + +Node1 + + +src/include/gridfire +/solver/strategies/CVODE +_solver_strategy.h + + + + + +Node2 + + +src/include/gridfire +/solver/strategies/strategies.h + + + + + +Node1->Node2 + + + + + + + + +Node8 + + +src/lib/engine/procedures +/priming.cpp + + + + + +Node1->Node8 + + + + + + + + +Node12 + + +src/python/solver/bindings.cpp + + + + + +Node1->Node12 + + + + + + + + +Node13 + + +src/include/gridfire +/solver/strategies/triggers +/engine_partitioning_trigger.h + + + + + +Node1->Node13 + + + + + + + + +Node15 + + +src/lib/solver/strategies +/CVODE_solver_strategy.cpp + + + + + +Node1->Node15 + + + + + + + + +Node16 + + +src/lib/solver/strategies +/triggers/engine_partitioning +_trigger.cpp + + + + + +Node1->Node16 + + + + + + + + +Node3 + + +src/include/gridfire +/solver/solver.h + + + + + +Node2->Node3 + + + + + + + + +Node4 + + +src/include/gridfire +/gridfire.h + + + + + +Node3->Node4 + + + + + + + + +Node3->Node8 + + + + + + + + +Node9 + + +src/lib/engine/views +/engine_priming.cpp + + + + + +Node3->Node9 + + + + + + + + +Node10 + + +src/python/solver/trampoline +/py_solver.cpp + + + + + +Node3->Node10 + + + + + + + + +Node11 + + +src/python/solver/trampoline +/py_solver.h + + + + + +Node3->Node11 + + + + + + + + +Node5 + + +src/extern/include +/gridfire/extern/gridfire +_context.h + + + + + +Node4->Node5 + + + + + + + + +Node7 + + +src/extern/lib/gridfire +_extern.cpp + + + + + +Node4->Node7 + + + + + + + + +Node6 + + +src/extern/lib/gridfire +_context.cpp + + + + + +Node5->Node6 + + + + + + + + +Node5->Node7 + + + + + + + + +Node11->Node10 + + + + + + + + +Node11->Node12 + + + + + + + + +Node14 + + +src/include/gridfire +/solver/strategies/triggers +/triggers.h + + + + + +Node13->Node14 + + + + + + + + +Node13->Node15 + + + + + + + + +Node13->Node16 + + + + + + + + +Node14->Node2 + + + + + + + + diff --git a/docs/html/CVODE__solver__strategy_8h__incl.map b/docs/html/CVODE__solver__strategy_8h__incl.map new file mode 100644 index 00000000..e9693dfe --- /dev/null +++ b/docs/html/CVODE__solver__strategy_8h__incl.map @@ -0,0 +1,137 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/CVODE__solver__strategy_8h__incl.md5 b/docs/html/CVODE__solver__strategy_8h__incl.md5 new file mode 100644 index 00000000..b5939ce6 --- /dev/null +++ b/docs/html/CVODE__solver__strategy_8h__incl.md5 @@ -0,0 +1 @@ +0ef744fecf613df8054713f6bdba2ea8 \ No newline at end of file diff --git a/docs/html/CVODE__solver__strategy_8h__incl.svg b/docs/html/CVODE__solver__strategy_8h__incl.svg new file mode 100644 index 00000000..e8538ee6 --- /dev/null +++ b/docs/html/CVODE__solver__strategy_8h__incl.svg @@ -0,0 +1,1330 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +src/include/gridfire/solver/strategies/CVODE_solver_strategy.h + + +Node1 + + +src/include/gridfire +/solver/strategies/CVODE +_solver_strategy.h + + + + + +Node2 + + +gridfire/solver/strategies +/strategy_abstract.h + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire/engine/engine +_abstract.h + + + + + +Node1->Node3 + + + + + + + + +Node7 + + +fourdst/atomic/atomicSpecies.h + + + + + +Node1->Node7 + + + + + + + + +Node11 + + +vector + + + + + +Node1->Node11 + + + + + + + + +Node15 + + +gridfire/types/types.h + + + + + +Node1->Node15 + + + + + + + + +Node21 + + +string + + + + + +Node1->Node21 + + + + + + + + +Node29 + + +tuple + + + + + +Node1->Node29 + + + + + + + + +Node30 + + +functional + + + + + +Node1->Node30 + + + + + + + + +Node34 + + +any + + + + + +Node1->Node34 + + + + + + + + +Node35 + + +gridfire/exceptions +/exceptions.h + + + + + +Node1->Node35 + + + + + + + + +Node46 + + +fourdst/config/config.h + + + + + +Node1->Node46 + + + + + + + + +Node47 + + +cvode/cvode.h + + + + + +Node1->Node47 + + + + + + + + +Node48 + + +sundials/sundials_types.h + + + + + +Node1->Node48 + + + + + + + + +Node49 + + +sundials/sundials_context.h + + + + + +Node1->Node49 + + + + + + + + +Node50 + + +sunmatrix/sunmatrix +_dense.h + + + + + +Node1->Node50 + + + + + + + + +Node51 + + +sunlinsol/sunlinsol +_dense.h + + + + + +Node1->Node51 + + + + + + + + +Node52 + + +nvector/nvector_serial.h + + + + + +Node1->Node52 + + + + + + + + +Node2->Node3 + + + + + + + + +Node2->Node11 + + + + + + + + +Node2->Node15 + + + + + + + + +Node2->Node21 + + + + + + + + +Node2->Node29 + + + + + + + + +Node2->Node30 + + + + + + + + +Node2->Node34 + + + + + + + + +Node4 + + +gridfire/reaction/reaction.h + + + + + +Node3->Node4 + + + + + + + + +Node10 + + +unordered_map + + + + + +Node3->Node10 + + + + + + + + +Node3->Node11 + + + + + + + + +Node3->Node15 + + + + + + + + +Node16 + + +gridfire/screening +/screening_abstract.h + + + + + +Node3->Node16 + + + + + + + + +Node17 + + +gridfire/screening +/screening_types.h + + + + + +Node3->Node17 + + + + + + + + +Node19 + + +gridfire/engine/types +/reporting.h + + + + + +Node3->Node19 + + + + + + + + +Node24 + + +gridfire/engine/types +/building.h + + + + + +Node3->Node24 + + + + + + + + +Node26 + + +gridfire/engine/types +/jacobian.h + + + + + +Node3->Node26 + + + + + + + + +Node27 + + +fourdst/composition +/composition_abstract.h + + + + + +Node3->Node27 + + + + + + + + +Node32 + + +utility + + + + + +Node3->Node32 + + + + + + + + +Node33 + + +expected + + + + + +Node3->Node33 + + + + + + + + +Node5 + + +ranges + + + + + +Node4->Node5 + + + + + + + + +Node6 + + +string_view + + + + + +Node4->Node6 + + + + + + + + +Node4->Node7 + + + + + + + + +Node8 + + +fourdst/logging/logging.h + + + + + +Node4->Node8 + + + + + + + + +Node9 + + +quill/Logger.h + + + + + +Node4->Node9 + + + + + + + + +Node4->Node10 + + + + + + + + +Node4->Node11 + + + + + + + + +Node12 + + +unordered_set + + + + + +Node4->Node12 + + + + + + + + +Node13 + + +cppad/cppad.hpp + + + + + +Node4->Node13 + + + + + + + + +Node14 + + +fourdst/composition +/composition.h + + + + + +Node4->Node14 + + + + + + + + +Node15->Node13 + + + + + + + + +Node15->Node14 + + + + + + + + +Node16->Node4 + + + + + + + + +Node16->Node7 + + + + + + + + +Node16->Node11 + + + + + + + + +Node16->Node13 + + + + + + + + +Node17->Node16 + + + + + + + + +Node18 + + +memory + + + + + +Node17->Node18 + + + + + + + + +Node19->Node14 + + + + + + + + +Node20 + + +map + + + + + +Node19->Node20 + + + + + + + + +Node19->Node21 + + + + + + + + +Node22 + + +ostream + + + + + +Node19->Node22 + + + + + + + + +Node23 + + +sstream + + + + + +Node19->Node23 + + + + + + + + +Node25 + + +variant + + + + + +Node24->Node25 + + + + + + + + +Node26->Node7 + + + + + + + + +Node26->Node9 + + + + + + + + +Node26->Node10 + + + + + + + + +Node26->Node27 + + + + + + + + +Node28 + + +Eigen/SparseCore + + + + + +Node26->Node28 + + + + + + + + +Node26->Node29 + + + + + + + + +Node26->Node30 + + + + + + + + +Node31 + + +optional + + + + + +Node26->Node31 + + + + + + + + +Node36 + + +gridfire/exceptions +/error_gridfire.h + + + + + +Node35->Node36 + + + + + + + + +Node38 + + +gridfire/exceptions +/error_engine.h + + + + + +Node35->Node38 + + + + + + + + +Node39 + + +gridfire/exceptions +/error_utils.h + + + + + +Node35->Node39 + + + + + + + + +Node40 + + +gridfire/exceptions +/error_debug.h + + + + + +Node35->Node40 + + + + + + + + +Node43 + + +gridfire/exceptions +/error_policy.h + + + + + +Node35->Node43 + + + + + + + + +Node44 + + +gridfire/exceptions +/error_reaction.h + + + + + +Node35->Node44 + + + + + + + + +Node45 + + +gridfire/exceptions +/error_solver.h + + + + + +Node35->Node45 + + + + + + + + +Node36->Node21 + + + + + + + + +Node37 + + +exception + + + + + +Node36->Node37 + + + + + + + + +Node38->Node36 + + + + + + + + +Node39->Node36 + + + + + + + + +Node40->Node21 + + + + + + + + +Node40->Node36 + + + + + + + + +Node43->Node36 + + + + + + + + +Node44->Node21 + + + + + + + + +Node44->Node36 + + + + + + + + +Node45->Node36 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/CVODE__solver__strategy_8h__incl_org.svg b/docs/html/CVODE__solver__strategy_8h__incl_org.svg new file mode 100644 index 00000000..e099a94b --- /dev/null +++ b/docs/html/CVODE__solver__strategy_8h__incl_org.svg @@ -0,0 +1,1248 @@ + + + + + + +src/include/gridfire/solver/strategies/CVODE_solver_strategy.h + + +Node1 + + +src/include/gridfire +/solver/strategies/CVODE +_solver_strategy.h + + + + + +Node2 + + +gridfire/solver/strategies +/strategy_abstract.h + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire/engine/engine +_abstract.h + + + + + +Node1->Node3 + + + + + + + + +Node7 + + +fourdst/atomic/atomicSpecies.h + + + + + +Node1->Node7 + + + + + + + + +Node11 + + +vector + + + + + +Node1->Node11 + + + + + + + + +Node15 + + +gridfire/types/types.h + + + + + +Node1->Node15 + + + + + + + + +Node21 + + +string + + + + + +Node1->Node21 + + + + + + + + +Node29 + + +tuple + + + + + +Node1->Node29 + + + + + + + + +Node30 + + +functional + + + + + +Node1->Node30 + + + + + + + + +Node34 + + +any + + + + + +Node1->Node34 + + + + + + + + +Node35 + + +gridfire/exceptions +/exceptions.h + + + + + +Node1->Node35 + + + + + + + + +Node46 + + +fourdst/config/config.h + + + + + +Node1->Node46 + + + + + + + + +Node47 + + +cvode/cvode.h + + + + + +Node1->Node47 + + + + + + + + +Node48 + + +sundials/sundials_types.h + + + + + +Node1->Node48 + + + + + + + + +Node49 + + +sundials/sundials_context.h + + + + + +Node1->Node49 + + + + + + + + +Node50 + + +sunmatrix/sunmatrix +_dense.h + + + + + +Node1->Node50 + + + + + + + + +Node51 + + +sunlinsol/sunlinsol +_dense.h + + + + + +Node1->Node51 + + + + + + + + +Node52 + + +nvector/nvector_serial.h + + + + + +Node1->Node52 + + + + + + + + +Node2->Node3 + + + + + + + + +Node2->Node11 + + + + + + + + +Node2->Node15 + + + + + + + + +Node2->Node21 + + + + + + + + +Node2->Node29 + + + + + + + + +Node2->Node30 + + + + + + + + +Node2->Node34 + + + + + + + + +Node4 + + +gridfire/reaction/reaction.h + + + + + +Node3->Node4 + + + + + + + + +Node10 + + +unordered_map + + + + + +Node3->Node10 + + + + + + + + +Node3->Node11 + + + + + + + + +Node3->Node15 + + + + + + + + +Node16 + + +gridfire/screening +/screening_abstract.h + + + + + +Node3->Node16 + + + + + + + + +Node17 + + +gridfire/screening +/screening_types.h + + + + + +Node3->Node17 + + + + + + + + +Node19 + + +gridfire/engine/types +/reporting.h + + + + + +Node3->Node19 + + + + + + + + +Node24 + + +gridfire/engine/types +/building.h + + + + + +Node3->Node24 + + + + + + + + +Node26 + + +gridfire/engine/types +/jacobian.h + + + + + +Node3->Node26 + + + + + + + + +Node27 + + +fourdst/composition +/composition_abstract.h + + + + + +Node3->Node27 + + + + + + + + +Node32 + + +utility + + + + + +Node3->Node32 + + + + + + + + +Node33 + + +expected + + + + + +Node3->Node33 + + + + + + + + +Node5 + + +ranges + + + + + +Node4->Node5 + + + + + + + + +Node6 + + +string_view + + + + + +Node4->Node6 + + + + + + + + +Node4->Node7 + + + + + + + + +Node8 + + +fourdst/logging/logging.h + + + + + +Node4->Node8 + + + + + + + + +Node9 + + +quill/Logger.h + + + + + +Node4->Node9 + + + + + + + + +Node4->Node10 + + + + + + + + +Node4->Node11 + + + + + + + + +Node12 + + +unordered_set + + + + + +Node4->Node12 + + + + + + + + +Node13 + + +cppad/cppad.hpp + + + + + +Node4->Node13 + + + + + + + + +Node14 + + +fourdst/composition +/composition.h + + + + + +Node4->Node14 + + + + + + + + +Node15->Node13 + + + + + + + + +Node15->Node14 + + + + + + + + +Node16->Node4 + + + + + + + + +Node16->Node7 + + + + + + + + +Node16->Node11 + + + + + + + + +Node16->Node13 + + + + + + + + +Node17->Node16 + + + + + + + + +Node18 + + +memory + + + + + +Node17->Node18 + + + + + + + + +Node19->Node14 + + + + + + + + +Node20 + + +map + + + + + +Node19->Node20 + + + + + + + + +Node19->Node21 + + + + + + + + +Node22 + + +ostream + + + + + +Node19->Node22 + + + + + + + + +Node23 + + +sstream + + + + + +Node19->Node23 + + + + + + + + +Node25 + + +variant + + + + + +Node24->Node25 + + + + + + + + +Node26->Node7 + + + + + + + + +Node26->Node9 + + + + + + + + +Node26->Node10 + + + + + + + + +Node26->Node27 + + + + + + + + +Node28 + + +Eigen/SparseCore + + + + + +Node26->Node28 + + + + + + + + +Node26->Node29 + + + + + + + + +Node26->Node30 + + + + + + + + +Node31 + + +optional + + + + + +Node26->Node31 + + + + + + + + +Node36 + + +gridfire/exceptions +/error_gridfire.h + + + + + +Node35->Node36 + + + + + + + + +Node38 + + +gridfire/exceptions +/error_engine.h + + + + + +Node35->Node38 + + + + + + + + +Node39 + + +gridfire/exceptions +/error_utils.h + + + + + +Node35->Node39 + + + + + + + + +Node40 + + +gridfire/exceptions +/error_debug.h + + + + + +Node35->Node40 + + + + + + + + +Node43 + + +gridfire/exceptions +/error_policy.h + + + + + +Node35->Node43 + + + + + + + + +Node44 + + +gridfire/exceptions +/error_reaction.h + + + + + +Node35->Node44 + + + + + + + + +Node45 + + +gridfire/exceptions +/error_solver.h + + + + + +Node35->Node45 + + + + + + + + +Node36->Node21 + + + + + + + + +Node37 + + +exception + + + + + +Node36->Node37 + + + + + + + + +Node38->Node36 + + + + + + + + +Node39->Node36 + + + + + + + + +Node40->Node21 + + + + + + + + +Node40->Node36 + + + + + + + + +Node43->Node36 + + + + + + + + +Node44->Node21 + + + + + + + + +Node44->Node36 + + + + + + + + +Node45->Node36 + + + + + + + + diff --git a/docs/html/____init_____8py.html b/docs/html/____init_____8py.html index a984b600..1d94d459 100644 --- a/docs/html/____init_____8py.html +++ b/docs/html/____init_____8py.html @@ -3,18 +3,16 @@ - + GridFire: src/python/gridfire/__init__.py File Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -108,14 +101,14 @@ $(function(){initNavTree('____init_____8py.html',''); initResizable(true); }); - +

Namespaces

namespace  gridfire
namespace  gridfire
 
- +

Variables

list gridfire.__all__ = ['type', 'utils', 'engine', 'solver', 'exceptions', 'partition', 'reaction', 'screening', 'io', 'policy']
 
str gridfire.__version__ = "v0.7.0_rc1"
str gridfire.__version__ = "v0.7.1_rc2"
 
@@ -124,7 +117,7 @@ Variables diff --git a/docs/html/____init_____8py.js b/docs/html/____init_____8py.js index cfdb096c..adec46f4 100644 --- a/docs/html/____init_____8py.js +++ b/docs/html/____init_____8py.js @@ -1,5 +1,5 @@ var ____init_____8py = [ - [ "gridfire.__all__", "namespacegridfire.html#a2adfc910bd5466746bd71490d2cbdf1d", null ], - [ "gridfire.__version__", "namespacegridfire.html#a14116c4fbbb07c2fa95826dc543771a2", null ] + [ "__all__", "____init_____8py.html#a2adfc910bd5466746bd71490d2cbdf1d", null ], + [ "__version__", "____init_____8py.html#a14116c4fbbb07c2fa95826dc543771a2", null ] ]; \ No newline at end of file diff --git a/docs/html/annotated.html b/docs/html/annotated.html index 328aab4e..438bea52 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -3,18 +3,16 @@ - + GridFire: Class List - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -103,155 +96,153 @@ $(function(){initNavTree('annotated.html',''); initResizable(true); });
Here are the classes, structs, unions and interfaces with brief descriptions:
-
[detail level 12345]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
[detail level 12345]
 ▼Ngridfire
 ►Nengine
 ►NexceptionsNamespace 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
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -260,24 +251,24 @@ $(function(){initNavTree('annotated.html',''); initResizable(true); }); - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + +
 ▼Ngridfire
 ►Nengine
 ►NexceptionsNamespace 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_init
 Cgf_register_species
 Cgridfire
 ▼NstdSTL 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
 ▼NstdSTL 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
@@ -285,7 +276,7 @@ $(function(){initNavTree('annotated.html',''); initResizable(true); }); diff --git a/docs/html/annotated_dup.js b/docs/html/annotated_dup.js index a1dba8e6..67b28d5b 100644 --- a/docs/html/annotated_dup.js +++ b/docs/html/annotated_dup.js @@ -2,151 +2,149 @@ var annotated_dup = [ [ "gridfire", "namespacegridfire.html", [ [ "engine", "namespacegridfire_1_1engine.html", [ - [ "AdaptiveEngineView", "classgridfire_1_1engine_1_1_adaptive_engine_view.html", "classgridfire_1_1engine_1_1_adaptive_engine_view" ], - [ "DefinedEngineView", "classgridfire_1_1engine_1_1_defined_engine_view.html", "classgridfire_1_1engine_1_1_defined_engine_view" ], - [ "DynamicEngine", "classgridfire_1_1engine_1_1_dynamic_engine.html", "classgridfire_1_1engine_1_1_dynamic_engine" ], - [ "EnergyDerivatives", "structgridfire_1_1engine_1_1_energy_derivatives.html", "structgridfire_1_1engine_1_1_energy_derivatives" ], - [ "Engine", "classgridfire_1_1engine_1_1_engine.html", "classgridfire_1_1engine_1_1_engine" ], - [ "EngineView", "classgridfire_1_1engine_1_1_engine_view.html", "classgridfire_1_1engine_1_1_engine_view" ], - [ "FileDefinedEngineView", "classgridfire_1_1engine_1_1_file_defined_engine_view.html", "classgridfire_1_1engine_1_1_file_defined_engine_view" ], - [ "GraphEngine", "classgridfire_1_1engine_1_1_graph_engine.html", "classgridfire_1_1engine_1_1_graph_engine" ], - [ "MultiscalePartitioningEngineView", "classgridfire_1_1engine_1_1_multiscale_partitioning_engine_view.html", "classgridfire_1_1engine_1_1_multiscale_partitioning_engine_view" ], - [ "NetworkJacobian", "classgridfire_1_1engine_1_1_network_jacobian.html", "classgridfire_1_1engine_1_1_network_jacobian" ], - [ "NetworkPrimingEngineView", "classgridfire_1_1engine_1_1_network_priming_engine_view.html", "classgridfire_1_1engine_1_1_network_priming_engine_view" ], - [ "PrimingReport", "structgridfire_1_1engine_1_1_priming_report.html", "structgridfire_1_1engine_1_1_priming_report" ], - [ "Reaction", "classgridfire_1_1engine_1_1_reaction.html", "classgridfire_1_1engine_1_1_reaction" ], - [ "ReactionSet", "classgridfire_1_1engine_1_1_reaction_set.html", "classgridfire_1_1engine_1_1_reaction_set" ], - [ "StepDerivatives", "structgridfire_1_1engine_1_1_step_derivatives.html", "structgridfire_1_1engine_1_1_step_derivatives" ] + [ "AdaptiveEngineView", "classgridfire_1_1engine_1_1AdaptiveEngineView.html", "classgridfire_1_1engine_1_1AdaptiveEngineView" ], + [ "DefinedEngineView", "classgridfire_1_1engine_1_1DefinedEngineView.html", "classgridfire_1_1engine_1_1DefinedEngineView" ], + [ "DynamicEngine", "classgridfire_1_1engine_1_1DynamicEngine.html", "classgridfire_1_1engine_1_1DynamicEngine" ], + [ "EnergyDerivatives", "structgridfire_1_1engine_1_1EnergyDerivatives.html", "structgridfire_1_1engine_1_1EnergyDerivatives" ], + [ "Engine", "classgridfire_1_1engine_1_1Engine.html", "classgridfire_1_1engine_1_1Engine" ], + [ "EngineView", "classgridfire_1_1engine_1_1EngineView.html", "classgridfire_1_1engine_1_1EngineView" ], + [ "FileDefinedEngineView", "classgridfire_1_1engine_1_1FileDefinedEngineView.html", "classgridfire_1_1engine_1_1FileDefinedEngineView" ], + [ "GraphEngine", "classgridfire_1_1engine_1_1GraphEngine.html", "classgridfire_1_1engine_1_1GraphEngine" ], + [ "MultiscalePartitioningEngineView", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView" ], + [ "NetworkJacobian", "classgridfire_1_1engine_1_1NetworkJacobian.html", "classgridfire_1_1engine_1_1NetworkJacobian" ], + [ "NetworkPrimingEngineView", "classgridfire_1_1engine_1_1NetworkPrimingEngineView.html", "classgridfire_1_1engine_1_1NetworkPrimingEngineView" ], + [ "PrimingReport", "structgridfire_1_1engine_1_1PrimingReport.html", "structgridfire_1_1engine_1_1PrimingReport" ], + [ "StepDerivatives", "structgridfire_1_1engine_1_1StepDerivatives.html", "structgridfire_1_1engine_1_1StepDerivatives" ] ] ], [ "exceptions", "namespacegridfire_1_1exceptions.html", [ - [ "BadCollectionError", "classgridfire_1_1exceptions_1_1_bad_collection_error.html", null ], - [ "BadRHSEngineError", "classgridfire_1_1exceptions_1_1_bad_r_h_s_engine_error.html", null ], - [ "CVODESolverFailureError", "classgridfire_1_1exceptions_1_1_c_v_o_d_e_solver_failure_error.html", null ], - [ "DebugException", "classgridfire_1_1exceptions_1_1_debug_exception.html", "classgridfire_1_1exceptions_1_1_debug_exception" ], - [ "EngineError", "classgridfire_1_1exceptions_1_1_engine_error.html", "classgridfire_1_1exceptions_1_1_engine_error" ], - [ "FailedToPartitionEngineError", "classgridfire_1_1exceptions_1_1_failed_to_partition_engine_error.html", null ], - [ "GridFireError", "classgridfire_1_1exceptions_1_1_grid_fire_error.html", "classgridfire_1_1exceptions_1_1_grid_fire_error" ], - [ "HashingError", "classgridfire_1_1exceptions_1_1_hashing_error.html", null ], - [ "IllConditionedJacobianError", "classgridfire_1_1exceptions_1_1_ill_conditioned_jacobian_error.html", null ], - [ "InvalidQSESolutionError", "classgridfire_1_1exceptions_1_1_invalid_q_s_e_solution_error.html", null ], - [ "JacobianError", "classgridfire_1_1exceptions_1_1_jacobian_error.html", null ], - [ "KINSolSolverFailureError", "classgridfire_1_1exceptions_1_1_k_i_n_sol_solver_failure_error.html", null ], - [ "MissingBaseReactionError", "classgridfire_1_1exceptions_1_1_missing_base_reaction_error.html", null ], - [ "MissingKeyReactionError", "classgridfire_1_1exceptions_1_1_missing_key_reaction_error.html", null ], - [ "MissingSeedSpeciesError", "classgridfire_1_1exceptions_1_1_missing_seed_species_error.html", null ], - [ "NetworkResizedError", "classgridfire_1_1exceptions_1_1_network_resized_error.html", null ], - [ "PolicyError", "classgridfire_1_1exceptions_1_1_policy_error.html", "classgridfire_1_1exceptions_1_1_policy_error" ], - [ "ReactionError", "classgridfire_1_1exceptions_1_1_reaction_error.html", "classgridfire_1_1exceptions_1_1_reaction_error" ], - [ "ReactionParsingError", "classgridfire_1_1exceptions_1_1_reaction_parsing_error.html", "classgridfire_1_1exceptions_1_1_reaction_parsing_error" ], - [ "SingularJacobianError", "classgridfire_1_1exceptions_1_1_singular_jacobian_error.html", null ], - [ "SolverError", "classgridfire_1_1exceptions_1_1_solver_error.html", "classgridfire_1_1exceptions_1_1_solver_error" ], - [ "StaleJacobianError", "classgridfire_1_1exceptions_1_1_stale_jacobian_error.html", null ], - [ "SUNDIALSError", "classgridfire_1_1exceptions_1_1_s_u_n_d_i_a_l_s_error.html", null ], - [ "UnableToSetNetworkReactionsError", "classgridfire_1_1exceptions_1_1_unable_to_set_network_reactions_error.html", null ], - [ "UninitializedJacobianError", "classgridfire_1_1exceptions_1_1_uninitialized_jacobian_error.html", null ], - [ "UnknownJacobianError", "classgridfire_1_1exceptions_1_1_unknown_jacobian_error.html", null ], - [ "UtilityError", "classgridfire_1_1exceptions_1_1_utility_error.html", "classgridfire_1_1exceptions_1_1_utility_error" ] + [ "BadCollectionError", "classgridfire_1_1exceptions_1_1BadCollectionError.html", null ], + [ "BadRHSEngineError", "classgridfire_1_1exceptions_1_1BadRHSEngineError.html", null ], + [ "CVODESolverFailureError", "classgridfire_1_1exceptions_1_1CVODESolverFailureError.html", null ], + [ "DebugException", "classgridfire_1_1exceptions_1_1DebugException.html", "classgridfire_1_1exceptions_1_1DebugException" ], + [ "EngineError", "classgridfire_1_1exceptions_1_1EngineError.html", "classgridfire_1_1exceptions_1_1EngineError" ], + [ "FailedToPartitionEngineError", "classgridfire_1_1exceptions_1_1FailedToPartitionEngineError.html", null ], + [ "GridFireError", "classgridfire_1_1exceptions_1_1GridFireError.html", "classgridfire_1_1exceptions_1_1GridFireError" ], + [ "HashingError", "classgridfire_1_1exceptions_1_1HashingError.html", null ], + [ "IllConditionedJacobianError", "classgridfire_1_1exceptions_1_1IllConditionedJacobianError.html", null ], + [ "InvalidQSESolutionError", "classgridfire_1_1exceptions_1_1InvalidQSESolutionError.html", null ], + [ "JacobianError", "classgridfire_1_1exceptions_1_1JacobianError.html", null ], + [ "KINSolSolverFailureError", "classgridfire_1_1exceptions_1_1KINSolSolverFailureError.html", null ], + [ "MissingBaseReactionError", "classgridfire_1_1exceptions_1_1MissingBaseReactionError.html", null ], + [ "MissingKeyReactionError", "classgridfire_1_1exceptions_1_1MissingKeyReactionError.html", null ], + [ "MissingSeedSpeciesError", "classgridfire_1_1exceptions_1_1MissingSeedSpeciesError.html", null ], + [ "NetworkResizedError", "classgridfire_1_1exceptions_1_1NetworkResizedError.html", null ], + [ "PolicyError", "classgridfire_1_1exceptions_1_1PolicyError.html", "classgridfire_1_1exceptions_1_1PolicyError" ], + [ "ReactionError", "classgridfire_1_1exceptions_1_1ReactionError.html", "classgridfire_1_1exceptions_1_1ReactionError" ], + [ "ReactionParsingError", "classgridfire_1_1exceptions_1_1ReactionParsingError.html", "classgridfire_1_1exceptions_1_1ReactionParsingError" ], + [ "SingularJacobianError", "classgridfire_1_1exceptions_1_1SingularJacobianError.html", null ], + [ "SolverError", "classgridfire_1_1exceptions_1_1SolverError.html", "classgridfire_1_1exceptions_1_1SolverError" ], + [ "StaleJacobianError", "classgridfire_1_1exceptions_1_1StaleJacobianError.html", null ], + [ "SUNDIALSError", "classgridfire_1_1exceptions_1_1SUNDIALSError.html", null ], + [ "UnableToSetNetworkReactionsError", "classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError.html", null ], + [ "UninitializedJacobianError", "classgridfire_1_1exceptions_1_1UninitializedJacobianError.html", null ], + [ "UnknownJacobianError", "classgridfire_1_1exceptions_1_1UnknownJacobianError.html", null ], + [ "UtilityError", "classgridfire_1_1exceptions_1_1UtilityError.html", "classgridfire_1_1exceptions_1_1UtilityError" ] ] ], [ "io", "namespacegridfire_1_1io.html", [ [ "gen", "namespacegridfire_1_1io_1_1gen.html", [ - [ "PyFunctionDef", "structgridfire_1_1io_1_1gen_1_1_py_function_def.html", "structgridfire_1_1io_1_1gen_1_1_py_function_def" ] + [ "PyFunctionDef", "structgridfire_1_1io_1_1gen_1_1PyFunctionDef.html", "structgridfire_1_1io_1_1gen_1_1PyFunctionDef" ] ] ], - [ "MESANetworkFileParser", "classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.html", "classgridfire_1_1io_1_1_m_e_s_a_network_file_parser" ], - [ "NetworkFileParser", "classgridfire_1_1io_1_1_network_file_parser.html", "classgridfire_1_1io_1_1_network_file_parser" ], - [ "SimpleReactionListFileParser", "classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html", "classgridfire_1_1io_1_1_simple_reaction_list_file_parser" ] + [ "MESANetworkFileParser", "classgridfire_1_1io_1_1MESANetworkFileParser.html", "classgridfire_1_1io_1_1MESANetworkFileParser" ], + [ "NetworkFileParser", "classgridfire_1_1io_1_1NetworkFileParser.html", "classgridfire_1_1io_1_1NetworkFileParser" ], + [ "SimpleReactionListFileParser", "classgridfire_1_1io_1_1SimpleReactionListFileParser.html", "classgridfire_1_1io_1_1SimpleReactionListFileParser" ] ] ], [ "partition", "namespacegridfire_1_1partition.html", [ [ "record", "namespacegridfire_1_1partition_1_1record.html", [ - [ "RauscherThielemannPartitionDataRecord", "structgridfire_1_1partition_1_1record_1_1_rauscher_thielemann_partition_data_record.html", "structgridfire_1_1partition_1_1record_1_1_rauscher_thielemann_partition_data_record" ] + [ "RauscherThielemannPartitionDataRecord", "structgridfire_1_1partition_1_1record_1_1RauscherThielemannPartitionDataRecord.html", "structgridfire_1_1partition_1_1record_1_1RauscherThielemannPartitionDataRecord" ] ] ], - [ "CompositePartitionFunction", "classgridfire_1_1partition_1_1_composite_partition_function.html", "classgridfire_1_1partition_1_1_composite_partition_function" ], - [ "GroundStatePartitionFunction", "classgridfire_1_1partition_1_1_ground_state_partition_function.html", "classgridfire_1_1partition_1_1_ground_state_partition_function" ], - [ "PartitionFunction", "classgridfire_1_1partition_1_1_partition_function.html", "classgridfire_1_1partition_1_1_partition_function" ], - [ "RauscherThielemannPartitionFunction", "classgridfire_1_1partition_1_1_rauscher_thielemann_partition_function.html", "classgridfire_1_1partition_1_1_rauscher_thielemann_partition_function" ] + [ "CompositePartitionFunction", "classgridfire_1_1partition_1_1CompositePartitionFunction.html", "classgridfire_1_1partition_1_1CompositePartitionFunction" ], + [ "GroundStatePartitionFunction", "classgridfire_1_1partition_1_1GroundStatePartitionFunction.html", "classgridfire_1_1partition_1_1GroundStatePartitionFunction" ], + [ "PartitionFunction", "classgridfire_1_1partition_1_1PartitionFunction.html", "classgridfire_1_1partition_1_1PartitionFunction" ], + [ "RauscherThielemannPartitionFunction", "classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html", "classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction" ] ] ], [ "policy", "namespacegridfire_1_1policy.html", [ - [ "CNOChainPolicy", "classgridfire_1_1policy_1_1_c_n_o_chain_policy.html", "classgridfire_1_1policy_1_1_c_n_o_chain_policy" ], - [ "CNOIChainPolicy", "classgridfire_1_1policy_1_1_c_n_o_i_chain_policy.html", "classgridfire_1_1policy_1_1_c_n_o_i_chain_policy" ], - [ "CNOIIChainPolicy", "classgridfire_1_1policy_1_1_c_n_o_i_i_chain_policy.html", "classgridfire_1_1policy_1_1_c_n_o_i_i_chain_policy" ], - [ "CNOIIIChainPolicy", "classgridfire_1_1policy_1_1_c_n_o_i_i_i_chain_policy.html", "classgridfire_1_1policy_1_1_c_n_o_i_i_i_chain_policy" ], - [ "CNOIVChainPolicy", "classgridfire_1_1policy_1_1_c_n_o_i_v_chain_policy.html", "classgridfire_1_1policy_1_1_c_n_o_i_v_chain_policy" ], - [ "HotCNOChainPolicy", "classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy.html", "classgridfire_1_1policy_1_1_hot_c_n_o_chain_policy" ], - [ "HotCNOIChainPolicy", "classgridfire_1_1policy_1_1_hot_c_n_o_i_chain_policy.html", "classgridfire_1_1policy_1_1_hot_c_n_o_i_chain_policy" ], - [ "HotCNOIIChainPolicy", "classgridfire_1_1policy_1_1_hot_c_n_o_i_i_chain_policy.html", "classgridfire_1_1policy_1_1_hot_c_n_o_i_i_chain_policy" ], - [ "HotCNOIIIChainPolicy", "classgridfire_1_1policy_1_1_hot_c_n_o_i_i_i_chain_policy.html", "classgridfire_1_1policy_1_1_hot_c_n_o_i_i_i_chain_policy" ], - [ "MainSequencePolicy", "classgridfire_1_1policy_1_1_main_sequence_policy.html", "classgridfire_1_1policy_1_1_main_sequence_policy" ], - [ "MainSequenceReactionChainPolicy", "classgridfire_1_1policy_1_1_main_sequence_reaction_chain_policy.html", "classgridfire_1_1policy_1_1_main_sequence_reaction_chain_policy" ], - [ "MultiReactionChainPolicy", "classgridfire_1_1policy_1_1_multi_reaction_chain_policy.html", "classgridfire_1_1policy_1_1_multi_reaction_chain_policy" ], - [ "NetworkPolicy", "classgridfire_1_1policy_1_1_network_policy.html", "classgridfire_1_1policy_1_1_network_policy" ], - [ "ProtonProtonChainPolicy", "classgridfire_1_1policy_1_1_proton_proton_chain_policy.html", "classgridfire_1_1policy_1_1_proton_proton_chain_policy" ], - [ "ProtonProtonIChainPolicy", "classgridfire_1_1policy_1_1_proton_proton_i_chain_policy.html", "classgridfire_1_1policy_1_1_proton_proton_i_chain_policy" ], - [ "ProtonProtonIIChainPolicy", "classgridfire_1_1policy_1_1_proton_proton_i_i_chain_policy.html", "classgridfire_1_1policy_1_1_proton_proton_i_i_chain_policy" ], - [ "ProtonProtonIIIChainPolicy", "classgridfire_1_1policy_1_1_proton_proton_i_i_i_chain_policy.html", "classgridfire_1_1policy_1_1_proton_proton_i_i_i_chain_policy" ], - [ "ReactionChainPolicy", "classgridfire_1_1policy_1_1_reaction_chain_policy.html", "classgridfire_1_1policy_1_1_reaction_chain_policy" ], - [ "TemperatureDependentChainPolicy", "classgridfire_1_1policy_1_1_temperature_dependent_chain_policy.html", "classgridfire_1_1policy_1_1_temperature_dependent_chain_policy" ], - [ "TripleAlphaChainPolicy", "classgridfire_1_1policy_1_1_triple_alpha_chain_policy.html", "classgridfire_1_1policy_1_1_triple_alpha_chain_policy" ] + [ "CNOChainPolicy", "classgridfire_1_1policy_1_1CNOChainPolicy.html", "classgridfire_1_1policy_1_1CNOChainPolicy" ], + [ "CNOIChainPolicy", "classgridfire_1_1policy_1_1CNOIChainPolicy.html", "classgridfire_1_1policy_1_1CNOIChainPolicy" ], + [ "CNOIIChainPolicy", "classgridfire_1_1policy_1_1CNOIIChainPolicy.html", "classgridfire_1_1policy_1_1CNOIIChainPolicy" ], + [ "CNOIIIChainPolicy", "classgridfire_1_1policy_1_1CNOIIIChainPolicy.html", "classgridfire_1_1policy_1_1CNOIIIChainPolicy" ], + [ "CNOIVChainPolicy", "classgridfire_1_1policy_1_1CNOIVChainPolicy.html", "classgridfire_1_1policy_1_1CNOIVChainPolicy" ], + [ "HotCNOChainPolicy", "classgridfire_1_1policy_1_1HotCNOChainPolicy.html", "classgridfire_1_1policy_1_1HotCNOChainPolicy" ], + [ "HotCNOIChainPolicy", "classgridfire_1_1policy_1_1HotCNOIChainPolicy.html", "classgridfire_1_1policy_1_1HotCNOIChainPolicy" ], + [ "HotCNOIIChainPolicy", "classgridfire_1_1policy_1_1HotCNOIIChainPolicy.html", "classgridfire_1_1policy_1_1HotCNOIIChainPolicy" ], + [ "HotCNOIIIChainPolicy", "classgridfire_1_1policy_1_1HotCNOIIIChainPolicy.html", "classgridfire_1_1policy_1_1HotCNOIIIChainPolicy" ], + [ "MainSequencePolicy", "classgridfire_1_1policy_1_1MainSequencePolicy.html", "classgridfire_1_1policy_1_1MainSequencePolicy" ], + [ "MainSequenceReactionChainPolicy", "classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy.html", "classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy" ], + [ "MultiReactionChainPolicy", "classgridfire_1_1policy_1_1MultiReactionChainPolicy.html", "classgridfire_1_1policy_1_1MultiReactionChainPolicy" ], + [ "NetworkPolicy", "classgridfire_1_1policy_1_1NetworkPolicy.html", "classgridfire_1_1policy_1_1NetworkPolicy" ], + [ "ProtonProtonChainPolicy", "classgridfire_1_1policy_1_1ProtonProtonChainPolicy.html", "classgridfire_1_1policy_1_1ProtonProtonChainPolicy" ], + [ "ProtonProtonIChainPolicy", "classgridfire_1_1policy_1_1ProtonProtonIChainPolicy.html", "classgridfire_1_1policy_1_1ProtonProtonIChainPolicy" ], + [ "ProtonProtonIIChainPolicy", "classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy.html", "classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy" ], + [ "ProtonProtonIIIChainPolicy", "classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy.html", "classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy" ], + [ "ReactionChainPolicy", "classgridfire_1_1policy_1_1ReactionChainPolicy.html", "classgridfire_1_1policy_1_1ReactionChainPolicy" ], + [ "TemperatureDependentChainPolicy", "classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html", "classgridfire_1_1policy_1_1TemperatureDependentChainPolicy" ], + [ "TripleAlphaChainPolicy", "classgridfire_1_1policy_1_1TripleAlphaChainPolicy.html", "classgridfire_1_1policy_1_1TripleAlphaChainPolicy" ] ] ], [ "rates", "namespacegridfire_1_1rates.html", [ [ "weak", "namespacegridfire_1_1rates_1_1weak.html", [ - [ "BoundsErrorInfo", "structgridfire_1_1rates_1_1weak_1_1_bounds_error_info.html", "structgridfire_1_1rates_1_1weak_1_1_bounds_error_info" ], - [ "InterpolationError", "structgridfire_1_1rates_1_1weak_1_1_interpolation_error.html", "structgridfire_1_1rates_1_1weak_1_1_interpolation_error" ], - [ "IsotopeGrid", "structgridfire_1_1rates_1_1weak_1_1_isotope_grid.html", "structgridfire_1_1rates_1_1weak_1_1_isotope_grid" ], - [ "RateDataRow", "structgridfire_1_1rates_1_1weak_1_1_rate_data_row.html", "structgridfire_1_1rates_1_1weak_1_1_rate_data_row" ], - [ "WeakRateDerivatives", "structgridfire_1_1rates_1_1weak_1_1_weak_rate_derivatives.html", "structgridfire_1_1rates_1_1weak_1_1_weak_rate_derivatives" ], - [ "WeakRateInterpolator", "classgridfire_1_1rates_1_1weak_1_1_weak_rate_interpolator.html", "classgridfire_1_1rates_1_1weak_1_1_weak_rate_interpolator" ], - [ "WeakRatePayload", "structgridfire_1_1rates_1_1weak_1_1_weak_rate_payload.html", "structgridfire_1_1rates_1_1weak_1_1_weak_rate_payload" ], - [ "WeakReaction", "classgridfire_1_1rates_1_1weak_1_1_weak_reaction.html", "classgridfire_1_1rates_1_1weak_1_1_weak_reaction" ], - [ "WeakReactionEntry", "structgridfire_1_1rates_1_1weak_1_1_weak_reaction_entry.html", "structgridfire_1_1rates_1_1weak_1_1_weak_reaction_entry" ], - [ "WeakReactionMap", "classgridfire_1_1rates_1_1weak_1_1_weak_reaction_map.html", "classgridfire_1_1rates_1_1weak_1_1_weak_reaction_map" ] + [ "BoundsErrorInfo", "structgridfire_1_1rates_1_1weak_1_1BoundsErrorInfo.html", "structgridfire_1_1rates_1_1weak_1_1BoundsErrorInfo" ], + [ "InterpolationError", "structgridfire_1_1rates_1_1weak_1_1InterpolationError.html", "structgridfire_1_1rates_1_1weak_1_1InterpolationError" ], + [ "IsotopeGrid", "structgridfire_1_1rates_1_1weak_1_1IsotopeGrid.html", "structgridfire_1_1rates_1_1weak_1_1IsotopeGrid" ], + [ "RateDataRow", "structgridfire_1_1rates_1_1weak_1_1RateDataRow.html", "structgridfire_1_1rates_1_1weak_1_1RateDataRow" ], + [ "WeakRateDerivatives", "structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives.html", "structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives" ], + [ "WeakRateInterpolator", "classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator.html", "classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator" ], + [ "WeakRatePayload", "structgridfire_1_1rates_1_1weak_1_1WeakRatePayload.html", "structgridfire_1_1rates_1_1weak_1_1WeakRatePayload" ], + [ "WeakReaction", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html", "classgridfire_1_1rates_1_1weak_1_1WeakReaction" ], + [ "WeakReactionEntry", "structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry.html", "structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry" ], + [ "WeakReactionMap", "classgridfire_1_1rates_1_1weak_1_1WeakReactionMap.html", "classgridfire_1_1rates_1_1weak_1_1WeakReactionMap" ] ] ] ] ], [ "reaclib", "namespacegridfire_1_1reaclib.html", [ - [ "ReactionRecord", "structgridfire_1_1reaclib_1_1_reaction_record.html", "structgridfire_1_1reaclib_1_1_reaction_record" ] + [ "ReactionRecord", "structgridfire_1_1reaclib_1_1ReactionRecord.html", "structgridfire_1_1reaclib_1_1ReactionRecord" ] ] ], [ "reaction", "namespacegridfire_1_1reaction.html", [ - [ "LogicalReaclibReaction", "classgridfire_1_1reaction_1_1_logical_reaclib_reaction.html", "classgridfire_1_1reaction_1_1_logical_reaclib_reaction" ], - [ "RateCoefficientSet", "structgridfire_1_1reaction_1_1_rate_coefficient_set.html", "structgridfire_1_1reaction_1_1_rate_coefficient_set" ], - [ "ReaclibReaction", "classgridfire_1_1reaction_1_1_reaclib_reaction.html", "classgridfire_1_1reaction_1_1_reaclib_reaction" ], - [ "Reaction", "classgridfire_1_1reaction_1_1_reaction.html", "classgridfire_1_1reaction_1_1_reaction" ], - [ "ReactionSet", "classgridfire_1_1reaction_1_1_reaction_set.html", "classgridfire_1_1reaction_1_1_reaction_set" ], - [ "WeakReaclibReaction", "classgridfire_1_1reaction_1_1_weak_reaclib_reaction.html", "classgridfire_1_1reaction_1_1_weak_reaclib_reaction" ] + [ "LogicalReaclibReaction", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html", "classgridfire_1_1reaction_1_1LogicalReaclibReaction" ], + [ "RateCoefficientSet", "structgridfire_1_1reaction_1_1RateCoefficientSet.html", "structgridfire_1_1reaction_1_1RateCoefficientSet" ], + [ "ReaclibReaction", "classgridfire_1_1reaction_1_1ReaclibReaction.html", "classgridfire_1_1reaction_1_1ReaclibReaction" ], + [ "Reaction", "classgridfire_1_1reaction_1_1Reaction.html", "classgridfire_1_1reaction_1_1Reaction" ], + [ "ReactionSet", "classgridfire_1_1reaction_1_1ReactionSet.html", "classgridfire_1_1reaction_1_1ReactionSet" ], + [ "WeakReaclibReaction", "classgridfire_1_1reaction_1_1WeakReaclibReaction.html", "classgridfire_1_1reaction_1_1WeakReaclibReaction" ] ] ], [ "screening", "namespacegridfire_1_1screening.html", [ - [ "BareScreeningModel", "classgridfire_1_1screening_1_1_bare_screening_model.html", "classgridfire_1_1screening_1_1_bare_screening_model" ], - [ "IntermediateScreeningModel", "classgridfire_1_1screening_1_1_intermediate_screening_model.html", "classgridfire_1_1screening_1_1_intermediate_screening_model" ], - [ "ScreeningModel", "classgridfire_1_1screening_1_1_screening_model.html", "classgridfire_1_1screening_1_1_screening_model" ], - [ "WeakScreeningModel", "classgridfire_1_1screening_1_1_weak_screening_model.html", "classgridfire_1_1screening_1_1_weak_screening_model" ] + [ "BareScreeningModel", "classgridfire_1_1screening_1_1BareScreeningModel.html", "classgridfire_1_1screening_1_1BareScreeningModel" ], + [ "IntermediateScreeningModel", "classgridfire_1_1screening_1_1IntermediateScreeningModel.html", "classgridfire_1_1screening_1_1IntermediateScreeningModel" ], + [ "ScreeningModel", "classgridfire_1_1screening_1_1ScreeningModel.html", "classgridfire_1_1screening_1_1ScreeningModel" ], + [ "WeakScreeningModel", "classgridfire_1_1screening_1_1WeakScreeningModel.html", "classgridfire_1_1screening_1_1WeakScreeningModel" ] ] ], [ "solver", "namespacegridfire_1_1solver.html", [ - [ "CVODESolverStrategy", "classgridfire_1_1solver_1_1_c_v_o_d_e_solver_strategy.html", "classgridfire_1_1solver_1_1_c_v_o_d_e_solver_strategy" ], - [ "NetworkSolverStrategy", "classgridfire_1_1solver_1_1_network_solver_strategy.html", "classgridfire_1_1solver_1_1_network_solver_strategy" ], - [ "SolverContextBase", "classgridfire_1_1solver_1_1_solver_context_base.html", "classgridfire_1_1solver_1_1_solver_context_base" ] + [ "CVODESolverStrategy", "classgridfire_1_1solver_1_1CVODESolverStrategy.html", "classgridfire_1_1solver_1_1CVODESolverStrategy" ], + [ "NetworkSolverStrategy", "classgridfire_1_1solver_1_1NetworkSolverStrategy.html", "classgridfire_1_1solver_1_1NetworkSolverStrategy" ], + [ "SolverContextBase", "classgridfire_1_1solver_1_1SolverContextBase.html", "classgridfire_1_1solver_1_1SolverContextBase" ] ] ], [ "trigger", "namespacegridfire_1_1trigger.html", [ [ "solver", "namespacegridfire_1_1trigger_1_1solver.html", [ - [ "CVODE", "namespacegridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e.html", [ - [ "ConvergenceFailureTrigger", "classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_convergence_failure_trigger.html", "classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_convergence_failure_trigger" ], - [ "OffDiagonalTrigger", "classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_off_diagonal_trigger.html", "classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_off_diagonal_trigger" ], - [ "SimulationTimeTrigger", "classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_simulation_time_trigger.html", "classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_simulation_time_trigger" ], - [ "TimestepCollapseTrigger", "classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_timestep_collapse_trigger.html", "classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_timestep_collapse_trigger" ] + [ "CVODE", "namespacegridfire_1_1trigger_1_1solver_1_1CVODE.html", [ + [ "ConvergenceFailureTrigger", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger" ], + [ "OffDiagonalTrigger", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger" ], + [ "SimulationTimeTrigger", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger" ], + [ "TimestepCollapseTrigger", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger" ] ] ] ] ], - [ "AndTrigger", "classgridfire_1_1trigger_1_1_and_trigger.html", "classgridfire_1_1trigger_1_1_and_trigger" ], - [ "EveryNthTrigger", "classgridfire_1_1trigger_1_1_every_nth_trigger.html", "classgridfire_1_1trigger_1_1_every_nth_trigger" ], - [ "LogicalTrigger", "classgridfire_1_1trigger_1_1_logical_trigger.html", null ], - [ "NotTrigger", "classgridfire_1_1trigger_1_1_not_trigger.html", "classgridfire_1_1trigger_1_1_not_trigger" ], - [ "OrTrigger", "classgridfire_1_1trigger_1_1_or_trigger.html", "classgridfire_1_1trigger_1_1_or_trigger" ], - [ "Trigger", "classgridfire_1_1trigger_1_1_trigger.html", "classgridfire_1_1trigger_1_1_trigger" ], - [ "TriggerResult", "structgridfire_1_1trigger_1_1_trigger_result.html", "structgridfire_1_1trigger_1_1_trigger_result" ] + [ "AndTrigger", "classgridfire_1_1trigger_1_1AndTrigger.html", "classgridfire_1_1trigger_1_1AndTrigger" ], + [ "EveryNthTrigger", "classgridfire_1_1trigger_1_1EveryNthTrigger.html", "classgridfire_1_1trigger_1_1EveryNthTrigger" ], + [ "LogicalTrigger", "classgridfire_1_1trigger_1_1LogicalTrigger.html", null ], + [ "NotTrigger", "classgridfire_1_1trigger_1_1NotTrigger.html", "classgridfire_1_1trigger_1_1NotTrigger" ], + [ "OrTrigger", "classgridfire_1_1trigger_1_1OrTrigger.html", "classgridfire_1_1trigger_1_1OrTrigger" ], + [ "Trigger", "classgridfire_1_1trigger_1_1Trigger.html", "classgridfire_1_1trigger_1_1Trigger" ], + [ "TriggerResult", "structgridfire_1_1trigger_1_1TriggerResult.html", "structgridfire_1_1trigger_1_1TriggerResult" ] ] ], [ "utils", "namespacegridfire_1_1utils.html", [ - [ "Column", "classgridfire_1_1utils_1_1_column.html", "classgridfire_1_1utils_1_1_column" ], - [ "ColumnBase", "classgridfire_1_1utils_1_1_column_base.html", "classgridfire_1_1utils_1_1_column_base" ], - [ "Table", "classgridfire_1_1utils_1_1_table.html", "classgridfire_1_1utils_1_1_table" ], - [ "TableBase", "classgridfire_1_1utils_1_1_table_base.html", "classgridfire_1_1utils_1_1_table_base" ] + [ "Column", "classgridfire_1_1utils_1_1Column.html", "classgridfire_1_1utils_1_1Column" ], + [ "ColumnBase", "classgridfire_1_1utils_1_1ColumnBase.html", "classgridfire_1_1utils_1_1ColumnBase" ], + [ "Table", "classgridfire_1_1utils_1_1Table.html", "classgridfire_1_1utils_1_1Table" ], + [ "TableBase", "classgridfire_1_1utils_1_1TableBase.html", "classgridfire_1_1utils_1_1TableBase" ] ] ], - [ "NetIn", "structgridfire_1_1_net_in.html", "structgridfire_1_1_net_in" ], - [ "NetOut", "structgridfire_1_1_net_out.html", "structgridfire_1_1_net_out" ] + [ "NetIn", "structgridfire_1_1NetIn.html", "structgridfire_1_1NetIn" ], + [ "NetOut", "structgridfire_1_1NetOut.html", "structgridfire_1_1NetOut" ] ] ], [ "gridfire_mod", "namespacegridfire__mod.html", [ [ "gf_construct_engine_from_policy", "interfacegridfire__mod_1_1gf__construct__engine__from__policy.html", "interfacegridfire__mod_1_1gf__construct__engine__from__policy" ], @@ -159,22 +157,22 @@ var annotated_dup = [ "gridfire", "structgridfire__mod_1_1gridfire.html", "structgridfire__mod_1_1gridfire" ] ] ], [ "std", "namespacestd.html", [ - [ "formatter< gridfire::engine::NetworkJacobian >", "structstd_1_1formatter_3_01gridfire_1_1engine_1_1_network_jacobian_01_4.html", "structstd_1_1formatter_3_01gridfire_1_1engine_1_1_network_jacobian_01_4" ], - [ "hash< gridfire::rates::weak::TableAxes >", "structstd_1_1hash_3_01gridfire_1_1rates_1_1weak_1_1_table_axes_01_4.html", "structstd_1_1hash_3_01gridfire_1_1rates_1_1weak_1_1_table_axes_01_4" ], - [ "hash< gridfire::reaction::Reaction >", "structstd_1_1hash_3_01gridfire_1_1reaction_1_1_reaction_01_4.html", "structstd_1_1hash_3_01gridfire_1_1reaction_1_1_reaction_01_4" ], - [ "hash< gridfire::reaction::ReactionSet >", "structstd_1_1hash_3_01gridfire_1_1reaction_1_1_reaction_set_01_4.html", "structstd_1_1hash_3_01gridfire_1_1reaction_1_1_reaction_set_01_4" ] + [ "formatter< gridfire::engine::NetworkJacobian >", "structstd_1_1formatter_3_01gridfire_1_1engine_1_1NetworkJacobian_01_4.html", "structstd_1_1formatter_3_01gridfire_1_1engine_1_1NetworkJacobian_01_4" ], + [ "hash< gridfire::rates::weak::TableAxes >", "structstd_1_1hash_3_01gridfire_1_1rates_1_1weak_1_1TableAxes_01_4.html", "structstd_1_1hash_3_01gridfire_1_1rates_1_1weak_1_1TableAxes_01_4" ], + [ "hash< gridfire::reaction::Reaction >", "structstd_1_1hash_3_01gridfire_1_1reaction_1_1Reaction_01_4.html", "structstd_1_1hash_3_01gridfire_1_1reaction_1_1Reaction_01_4" ], + [ "hash< gridfire::reaction::ReactionSet >", "structstd_1_1hash_3_01gridfire_1_1reaction_1_1ReactionSet_01_4.html", "structstd_1_1hash_3_01gridfire_1_1reaction_1_1ReactionSet_01_4" ] ] ], - [ "GridFireContext", "struct_grid_fire_context.html", "struct_grid_fire_context" ], - [ "PyDynamicEngine", "class_py_dynamic_engine.html", "class_py_dynamic_engine" ], - [ "PyDynamicEngineView", "class_py_dynamic_engine_view.html", "class_py_dynamic_engine_view" ], - [ "PyDynamicNetworkSolverStrategy", "class_py_dynamic_network_solver_strategy.html", "class_py_dynamic_network_solver_strategy" ], - [ "PyEngine", "class_py_engine.html", "class_py_engine" ], - [ "PyEngineView", "class_py_engine_view.html", "class_py_engine_view" ], - [ "PyNetworkFileParser", "class_py_network_file_parser.html", "class_py_network_file_parser" ], - [ "PyNetworkPolicy", "class_py_network_policy.html", "class_py_network_policy" ], - [ "PyPartitionFunction", "class_py_partition_function.html", "class_py_partition_function" ], - [ "PyReactionChainPolicy", "class_py_reaction_chain_policy.html", "class_py_reaction_chain_policy" ], - [ "PyScreening", "class_py_screening.html", "class_py_screening" ], - [ "PySolverContextBase", "class_py_solver_context_base.html", "class_py_solver_context_base" ], - [ "SolverPluginInterface", "class_solver_plugin_interface.html", "class_solver_plugin_interface" ] + [ "GridFireContext", "structGridFireContext.html", "structGridFireContext" ], + [ "PyDynamicEngine", "classPyDynamicEngine.html", "classPyDynamicEngine" ], + [ "PyDynamicEngineView", "classPyDynamicEngineView.html", "classPyDynamicEngineView" ], + [ "PyDynamicNetworkSolverStrategy", "classPyDynamicNetworkSolverStrategy.html", "classPyDynamicNetworkSolverStrategy" ], + [ "PyEngine", "classPyEngine.html", "classPyEngine" ], + [ "PyEngineView", "classPyEngineView.html", "classPyEngineView" ], + [ "PyNetworkFileParser", "classPyNetworkFileParser.html", "classPyNetworkFileParser" ], + [ "PyNetworkPolicy", "classPyNetworkPolicy.html", "classPyNetworkPolicy" ], + [ "PyPartitionFunction", "classPyPartitionFunction.html", "classPyPartitionFunction" ], + [ "PyReactionChainPolicy", "classPyReactionChainPolicy.html", "classPyReactionChainPolicy" ], + [ "PyScreening", "classPyScreening.html", "classPyScreening" ], + [ "PySolverContextBase", "classPySolverContextBase.html", "classPySolverContextBase" ], + [ "SolverPluginInterface", "classSolverPluginInterface.html", "classSolverPluginInterface" ] ]; \ No newline at end of file diff --git a/docs/html/bindings_8cpp.html b/docs/html/bindings_8cpp.html index 2bfef408..f353de6a 100644 --- a/docs/html/bindings_8cpp.html +++ b/docs/html/bindings_8cpp.html @@ -3,18 +3,16 @@ - + GridFire: src/python/bindings.cpp File Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -124,7 +117,7 @@ Include dependency graph for bindings.cpp:
- +

Functions

 PYBIND11_MODULE (_gridfire, m)
 PYBIND11_MODULE (_gridfire, m)
 

Function Documentation

@@ -137,12 +130,19 @@ Functions PYBIND11_MODULE ( - _gridfire , + _gridfire  + , - m  ) + m  +   + + + + ) +
@@ -155,7 +155,7 @@ Functions diff --git a/docs/html/building_8h.html b/docs/html/building_8h.html index 22650200..01e9497b 100644 --- a/docs/html/building_8h.html +++ b/docs/html/building_8h.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/engine/types/building.h File Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -123,16 +116,16 @@ This graph shows which files directly or indirectly include this file:
- + - +

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.
 
@@ -158,7 +151,7 @@ Enumerations diff --git a/docs/html/building_8h.js b/docs/html/building_8h.js index c9ff1590..decda3b9 100644 --- a/docs/html/building_8h.js +++ b/docs/html/building_8h.js @@ -1,12 +1,12 @@ var building_8h = [ - [ "gridfire::engine::BuildDepthType", "namespacegridfire_1_1engine.html#a55cd7c313bbfafd5b6a1bcd6329ed99b", null ], - [ "gridfire::engine::NetworkBuildDepth", "namespacegridfire_1_1engine.html#a782fbc9eca00df10e4a204ae6da733e7", [ - [ "gridfire::engine::NetworkBuildDepth::Full", "namespacegridfire_1_1engine.html#a782fbc9eca00df10e4a204ae6da733e7abbd47109890259c0127154db1af26c75", null ], - [ "gridfire::engine::NetworkBuildDepth::Shallow", "namespacegridfire_1_1engine.html#a782fbc9eca00df10e4a204ae6da733e7a928d0f1285ee7d36c1c2fa1b1b7a164c", null ], - [ "gridfire::engine::NetworkBuildDepth::SecondOrder", "namespacegridfire_1_1engine.html#a782fbc9eca00df10e4a204ae6da733e7a264572d66aed5373d19dc80c7cde1f46", null ], - [ "gridfire::engine::NetworkBuildDepth::ThirdOrder", "namespacegridfire_1_1engine.html#a782fbc9eca00df10e4a204ae6da733e7a3fc719e07f9f63e7f11a3d4fb74b476f", null ], - [ "gridfire::engine::NetworkBuildDepth::FourthOrder", "namespacegridfire_1_1engine.html#a782fbc9eca00df10e4a204ae6da733e7a100e3bf0197221c19b222badf42aa964", null ], - [ "gridfire::engine::NetworkBuildDepth::FifthOrder", "namespacegridfire_1_1engine.html#a782fbc9eca00df10e4a204ae6da733e7a5105376c2b90747e00bed5bf2953dd56", null ] + [ "BuildDepthType", "building_8h.html#a540b6420c7b6271717ec9b640140f6c0", null ], + [ "NetworkBuildDepth", "building_8h.html#a782fbc9eca00df10e4a204ae6da733e7", [ + [ "Full", "building_8h.html#a782fbc9eca00df10e4a204ae6da733e7abbd47109890259c0127154db1af26c75", null ], + [ "Shallow", "building_8h.html#a782fbc9eca00df10e4a204ae6da733e7a928d0f1285ee7d36c1c2fa1b1b7a164c", null ], + [ "SecondOrder", "building_8h.html#a782fbc9eca00df10e4a204ae6da733e7a264572d66aed5373d19dc80c7cde1f46", null ], + [ "ThirdOrder", "building_8h.html#a782fbc9eca00df10e4a204ae6da733e7a3fc719e07f9f63e7f11a3d4fb74b476f", null ], + [ "FourthOrder", "building_8h.html#a782fbc9eca00df10e4a204ae6da733e7a100e3bf0197221c19b222badf42aa964", null ], + [ "FifthOrder", "building_8h.html#a782fbc9eca00df10e4a204ae6da733e7a5105376c2b90747e00bed5bf2953dd56", null ] ] ] ]; \ No newline at end of file diff --git a/docs/html/building_8h__dep__incl.map b/docs/html/building_8h__dep__incl.map index f485b06e..228309b8 100644 --- a/docs/html/building_8h__dep__incl.map +++ b/docs/html/building_8h__dep__incl.map @@ -1,155 +1,155 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/building_8h__dep__incl.md5 b/docs/html/building_8h__dep__incl.md5 index eea15c25..10f974a1 100644 --- a/docs/html/building_8h__dep__incl.md5 +++ b/docs/html/building_8h__dep__incl.md5 @@ -1 +1 @@ -730e4a1b843a7a85a80cdae6149b7dad \ No newline at end of file +cefc5c2d0fa27d2825aa041fb7a173c7 \ No newline at end of file diff --git a/docs/html/building_8h__dep__incl.svg b/docs/html/building_8h__dep__incl.svg index 38b0289b..ad76cdc0 100644 --- a/docs/html/building_8h__dep__incl.svg +++ b/docs/html/building_8h__dep__incl.svg @@ -1,13 +1,12 @@ - - + - + + + +PyDynamicEngineView + + +Node1 + + +PyDynamicEngineView + + + + + +Node2 + + +gridfire::engine::Engine +View< gridfire::engine +::DynamicEngine > + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPyDynamicEngineView__coll__graph_org.svg b/docs/html/classPyDynamicEngineView__coll__graph_org.svg new file mode 100644 index 00000000..64b18eab --- /dev/null +++ b/docs/html/classPyDynamicEngineView__coll__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +PyDynamicEngineView + + +Node1 + + +PyDynamicEngineView + + + + + +Node2 + + +gridfire::engine::Engine +View< gridfire::engine +::DynamicEngine > + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classPyDynamicEngineView__inherit__graph.map b/docs/html/classPyDynamicEngineView__inherit__graph.map new file mode 100644 index 00000000..cccc76f9 --- /dev/null +++ b/docs/html/classPyDynamicEngineView__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classPyDynamicEngineView__inherit__graph.md5 b/docs/html/classPyDynamicEngineView__inherit__graph.md5 new file mode 100644 index 00000000..5f2e3cd9 --- /dev/null +++ b/docs/html/classPyDynamicEngineView__inherit__graph.md5 @@ -0,0 +1 @@ +b7fd171708183f0ea6f7126c4f0097e2 \ No newline at end of file diff --git a/docs/html/classPyDynamicEngineView__inherit__graph.svg b/docs/html/classPyDynamicEngineView__inherit__graph.svg new file mode 100644 index 00000000..ae1bb09c --- /dev/null +++ b/docs/html/classPyDynamicEngineView__inherit__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +PyDynamicEngineView + + +Node1 + + +PyDynamicEngineView + + + + + +Node2 + + +gridfire::engine::Engine +View< gridfire::engine +::DynamicEngine > + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPyDynamicEngineView__inherit__graph_org.svg b/docs/html/classPyDynamicEngineView__inherit__graph_org.svg new file mode 100644 index 00000000..64b18eab --- /dev/null +++ b/docs/html/classPyDynamicEngineView__inherit__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +PyDynamicEngineView + + +Node1 + + +PyDynamicEngineView + + + + + +Node2 + + +gridfire::engine::Engine +View< gridfire::engine +::DynamicEngine > + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classPyDynamicEngine__coll__graph.map b/docs/html/classPyDynamicEngine__coll__graph.map new file mode 100644 index 00000000..8472412f --- /dev/null +++ b/docs/html/classPyDynamicEngine__coll__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/html/classPyDynamicEngine__coll__graph.md5 b/docs/html/classPyDynamicEngine__coll__graph.md5 new file mode 100644 index 00000000..0fc16319 --- /dev/null +++ b/docs/html/classPyDynamicEngine__coll__graph.md5 @@ -0,0 +1 @@ +f94e4b66580936c7bb1a740486c8dc50 \ No newline at end of file diff --git a/docs/html/classPyDynamicEngine__coll__graph.svg b/docs/html/classPyDynamicEngine__coll__graph.svg new file mode 100644 index 00000000..db4acaba --- /dev/null +++ b/docs/html/classPyDynamicEngine__coll__graph.svg @@ -0,0 +1,122 @@ + + + + + + + + + + + +PyDynamicEngine + + +Node1 + + +PyDynamicEngine + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node4->Node1 + + + + + + m_species_cache + + + +Node5 + + +Species + + + + + +Node5->Node4 + + + + + + elements + + + + + + + + diff --git a/docs/html/classPyDynamicEngine__coll__graph_org.svg b/docs/html/classPyDynamicEngine__coll__graph_org.svg new file mode 100644 index 00000000..ecebbdc3 --- /dev/null +++ b/docs/html/classPyDynamicEngine__coll__graph_org.svg @@ -0,0 +1,97 @@ + + + + + + +PyDynamicEngine + + +Node1 + + +PyDynamicEngine + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node4->Node1 + + + + + + m_species_cache + + + +Node5 + + +Species + + + + + +Node5->Node4 + + + + + + elements + + + diff --git a/docs/html/classPyDynamicEngine__inherit__graph.map b/docs/html/classPyDynamicEngine__inherit__graph.map new file mode 100644 index 00000000..7a46fce0 --- /dev/null +++ b/docs/html/classPyDynamicEngine__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classPyDynamicEngine__inherit__graph.md5 b/docs/html/classPyDynamicEngine__inherit__graph.md5 new file mode 100644 index 00000000..f75b50ae --- /dev/null +++ b/docs/html/classPyDynamicEngine__inherit__graph.md5 @@ -0,0 +1 @@ +0a844e6ed0600de23552701f993832d9 \ No newline at end of file diff --git a/docs/html/classPyDynamicEngine__inherit__graph.svg b/docs/html/classPyDynamicEngine__inherit__graph.svg new file mode 100644 index 00000000..66ff5a4d --- /dev/null +++ b/docs/html/classPyDynamicEngine__inherit__graph.svg @@ -0,0 +1,83 @@ + + + + + + + + + + + +PyDynamicEngine + + +Node1 + + +PyDynamicEngine + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classPyDynamicEngine__inherit__graph_org.svg b/docs/html/classPyDynamicEngine__inherit__graph_org.svg new file mode 100644 index 00000000..4ff2bb85 --- /dev/null +++ b/docs/html/classPyDynamicEngine__inherit__graph_org.svg @@ -0,0 +1,58 @@ + + + + + + +PyDynamicEngine + + +Node1 + + +PyDynamicEngine + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classPyDynamicNetworkSolverStrategy-members.html b/docs/html/classPyDynamicNetworkSolverStrategy-members.html new file mode 100644 index 00000000..e5e68179 --- /dev/null +++ b/docs/html/classPyDynamicNetworkSolverStrategy-members.html @@ -0,0 +1,117 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+

Enumerations

+ + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+ + + + + + + + + +
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
PyDynamicNetworkSolverStrategy Member List
+
+
+ +

This is the complete list of members for PyDynamicNetworkSolverStrategy, including all inherited members.

+ + + + + + + + +
describe_callback_context() const overridePyDynamicNetworkSolverStrategyprivatevirtual
evaluate(const gridfire::NetIn &netIn) overridePyDynamicNetworkSolverStrategyprivatevirtual
m_enginegridfire::solver::NetworkSolverStrategy< EngineT >protected
NetworkSolverStrategy(EngineT &engine)gridfire::solver::NetworkSolverStrategy< EngineT >inlineexplicit
PyDynamicNetworkSolverStrategy(gridfire::engine::DynamicEngine &engine)PyDynamicNetworkSolverStrategyinlineexplicitprivate
set_callback(const std::any &callback) overridePyDynamicNetworkSolverStrategyprivatevirtual
~NetworkSolverStrategy()=defaultgridfire::solver::NetworkSolverStrategy< EngineT >virtual
+
+ + + + diff --git a/docs/html/classPyDynamicNetworkSolverStrategy.html b/docs/html/classPyDynamicNetworkSolverStrategy.html new file mode 100644 index 00000000..0a7251a3 --- /dev/null +++ b/docs/html/classPyDynamicNetworkSolverStrategy.html @@ -0,0 +1,289 @@ + + + + + + + +GridFire: PyDynamicNetworkSolverStrategy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Private Member Functions | +List of all members
+
PyDynamicNetworkSolverStrategy Class Referencefinal
+
+
+ +

#include <py_solver.h>

+
+Inheritance diagram for PyDynamicNetworkSolverStrategy:
+
+
+
[legend]
+
+Collaboration diagram for PyDynamicNetworkSolverStrategy:
+
+
+
[legend]
+ + + + + + + + + + + + + +

+Private Member Functions

 PyDynamicNetworkSolverStrategy (gridfire::engine::DynamicEngine &engine)
 
gridfire::NetOut evaluate (const gridfire::NetIn &netIn) override
 Evaluates the network for a given timestep.
 
void set_callback (const std::any &callback) override
 set the callback function to be called at the end of each timestep.
 
std::vector< std::tuple< std::string, std::string > > describe_callback_context () const override
 Describe the context that will be passed to the callback function.
 
+ + + + + + + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::solver::NetworkSolverStrategy< EngineT >
 NetworkSolverStrategy (EngineT &engine)
 Constructor for the NetworkSolverStrategy.
 
virtual ~NetworkSolverStrategy ()=default
 Virtual destructor.
 
- Protected Attributes inherited from gridfire::solver::NetworkSolverStrategy< EngineT >
EngineT & m_engine
 The engine used by this solver strategy.
 
+

Constructor & Destructor Documentation

+ +

◆ PyDynamicNetworkSolverStrategy()

+ +
+
+ + + + + +
+ + + + + + + + +
PyDynamicNetworkSolverStrategy::PyDynamicNetworkSolverStrategy (gridfire::engine::DynamicEngine & engine)
+ 		+inlineexplicitprivate
+
+ +
+
+

Member Function Documentation

+ +

◆ describe_callback_context()

+ +
+
+ + + + + +
+ + + + + + + +
std::vector< std::tuple< std::string, std::string > > PyDynamicNetworkSolverStrategy::describe_callback_context () const
+ 		+overrideprivatevirtual
+
+ +

Describe the context that will be passed to the callback function.

+
Returns
A vector of tuples, each containing a string for the parameter's name and a string for its type.
+

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::NetworkSolverStrategy< EngineT >.

+ +
+
+ +

◆ evaluate()

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::NetOut PyDynamicNetworkSolverStrategy::evaluate (const gridfire::NetIn & netIn)
+ 		+overrideprivatevirtual
+
+ +

Evaluates the network for a given timestep.

+
Parameters
+ + +
netInThe input conditions for the network.
+
+
+
Returns
The output conditions after the timestep.
+ +

Implements gridfire::solver::NetworkSolverStrategy< EngineT >.

+ +
+
+ +

◆ set_callback()

+ +
+
+ + + + + +
+ + + + + + + + +
void PyDynamicNetworkSolverStrategy::set_callback (const std::any & callback)
+ 		+overrideprivatevirtual
+
+ +

set the callback function to be called at the end of each timestep.

+

This function allows the user to set a callback function that will be called at the end of each timestep. The callback function will receive a gridfire::solver::<SOMESOLVER>::TimestepContext object. Note that depending on the solver, this context may contain different information. Further, the exact signature of the callback function is left up to each solver. Every solver should provide a type or type alias TimestepCallback that defines the signature of the callback function so that the user can easily get that type information.

+
Parameters
+ + +
callbackThe callback function to be called at the end of each timestep.
+
+
+ +

Implements gridfire::solver::NetworkSolverStrategy< EngineT >.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classPyDynamicNetworkSolverStrategy.js b/docs/html/classPyDynamicNetworkSolverStrategy.js new file mode 100644 index 00000000..1dca2455 --- /dev/null +++ b/docs/html/classPyDynamicNetworkSolverStrategy.js @@ -0,0 +1,7 @@ +var classPyDynamicNetworkSolverStrategy = +[ + [ "PyDynamicNetworkSolverStrategy", "classPyDynamicNetworkSolverStrategy.html#a5adc2c51958c6114b4c46264e4d68917", null ], + [ "describe_callback_context", "classPyDynamicNetworkSolverStrategy.html#a147a0a543268427a5930143902217ac3", null ], + [ "evaluate", "classPyDynamicNetworkSolverStrategy.html#a2095abb83ed6229ebb27b4883cec51c4", null ], + [ "set_callback", "classPyDynamicNetworkSolverStrategy.html#a112a7babc03858a69d6994a7155370d3", null ] +]; \ No newline at end of file diff --git a/docs/html/classPyDynamicNetworkSolverStrategy__coll__graph.map b/docs/html/classPyDynamicNetworkSolverStrategy__coll__graph.map new file mode 100644 index 00000000..bd8bf6eb --- /dev/null +++ b/docs/html/classPyDynamicNetworkSolverStrategy__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classPyDynamicNetworkSolverStrategy__coll__graph.md5 b/docs/html/classPyDynamicNetworkSolverStrategy__coll__graph.md5 new file mode 100644 index 00000000..abfd703f --- /dev/null +++ b/docs/html/classPyDynamicNetworkSolverStrategy__coll__graph.md5 @@ -0,0 +1 @@ +cbb2178c18f6e07990532a6027434465 \ No newline at end of file diff --git a/docs/html/classPyDynamicNetworkSolverStrategy__coll__graph.svg b/docs/html/classPyDynamicNetworkSolverStrategy__coll__graph.svg new file mode 100644 index 00000000..bf88f50c --- /dev/null +++ b/docs/html/classPyDynamicNetworkSolverStrategy__coll__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +PyDynamicNetworkSolverStrategy + + +Node1 + + +PyDynamicNetworkSolverStrategy + + + + + +Node2 + + +gridfire::solver::Dynamic +NetworkSolverStrategy + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPyDynamicNetworkSolverStrategy__coll__graph_org.svg b/docs/html/classPyDynamicNetworkSolverStrategy__coll__graph_org.svg new file mode 100644 index 00000000..edb23ccc --- /dev/null +++ b/docs/html/classPyDynamicNetworkSolverStrategy__coll__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +PyDynamicNetworkSolverStrategy + + +Node1 + + +PyDynamicNetworkSolverStrategy + + + + + +Node2 + + +gridfire::solver::Dynamic +NetworkSolverStrategy + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classPyDynamicNetworkSolverStrategy__inherit__graph.map b/docs/html/classPyDynamicNetworkSolverStrategy__inherit__graph.map new file mode 100644 index 00000000..bd8bf6eb --- /dev/null +++ b/docs/html/classPyDynamicNetworkSolverStrategy__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classPyDynamicNetworkSolverStrategy__inherit__graph.md5 b/docs/html/classPyDynamicNetworkSolverStrategy__inherit__graph.md5 new file mode 100644 index 00000000..abfd703f --- /dev/null +++ b/docs/html/classPyDynamicNetworkSolverStrategy__inherit__graph.md5 @@ -0,0 +1 @@ +cbb2178c18f6e07990532a6027434465 \ No newline at end of file diff --git a/docs/html/classPyDynamicNetworkSolverStrategy__inherit__graph.svg b/docs/html/classPyDynamicNetworkSolverStrategy__inherit__graph.svg new file mode 100644 index 00000000..bf88f50c --- /dev/null +++ b/docs/html/classPyDynamicNetworkSolverStrategy__inherit__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +PyDynamicNetworkSolverStrategy + + +Node1 + + +PyDynamicNetworkSolverStrategy + + + + + +Node2 + + +gridfire::solver::Dynamic +NetworkSolverStrategy + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPyDynamicNetworkSolverStrategy__inherit__graph_org.svg b/docs/html/classPyDynamicNetworkSolverStrategy__inherit__graph_org.svg new file mode 100644 index 00000000..edb23ccc --- /dev/null +++ b/docs/html/classPyDynamicNetworkSolverStrategy__inherit__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +PyDynamicNetworkSolverStrategy + + +Node1 + + +PyDynamicNetworkSolverStrategy + + + + + +Node2 + + +gridfire::solver::Dynamic +NetworkSolverStrategy + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classPyEngine-members.html b/docs/html/classPyEngine-members.html new file mode 100644 index 00000000..5bd6c2e4 --- /dev/null +++ b/docs/html/classPyEngine-members.html @@ -0,0 +1,114 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
PyEngine Member List
+
+
+ +

This is the complete list of members for PyEngine, including all inherited members.

+ + + + + +
calculateRHSAndEnergy(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridePyEnginevirtual
getNetworkSpecies() const overridePyEnginevirtual
m_species_cachePyEnginemutableprivate
~Engine()=defaultgridfire::engine::Enginevirtual
+
+ + + + diff --git a/docs/html/classPyEngine.html b/docs/html/classPyEngine.html new file mode 100644 index 00000000..24b58d7b --- /dev/null +++ b/docs/html/classPyEngine.html @@ -0,0 +1,257 @@ + + + + + + + +GridFire: PyEngine Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
PyEngine Class Referencefinal
+
+
+ +

#include <py_engine.h>

+
+Inheritance diagram for PyEngine:
+
+
+
[legend]
+
+Collaboration diagram for PyEngine:
+
+
+
[legend]
+ + + + + + + + + + + + +

+Public Member Functions

const std::vector< fourdst::atomic::Species > & getNetworkSpecies () const override
 Get the list of species in the network.
 
std::expected< gridfire::engine::StepDerivatives< double >, gridfire::engine::EngineStatus > calculateRHSAndEnergy (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
 Calculate the right-hand side (dY/dt) and energy generation.
 
- Public Member Functions inherited from gridfire::engine::Engine
virtual ~Engine ()=default
 Virtual destructor.
 
+ + + +

+Private Attributes

std::vector< fourdst::atomic::Species > m_species_cache
 
+

Member Function Documentation

+ +

◆ calculateRHSAndEnergy()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
std::expected< gridfire::engine::StepDerivatives< double >, gridfire::engine::EngineStatus > PyEngine::calculateRHSAndEnergy (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Calculate the right-hand side (dY/dt) and energy generation.

+
Parameters
+ + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
expected<StepDerivatives<double>> containing either dY/dt and energy generation rate or a stale engine error indicating that the engine must be updated
+

This function must be implemented by derived classes to compute the time derivatives of all species and the specific nuclear energy generation rate for the current state.

+ +

Implements gridfire::engine::Engine.

+ +
+
+ +

◆ getNetworkSpecies()

+ +
+
+ + + + + +
+ + + + + + + +
const std::vector< fourdst::atomic::Species > & PyEngine::getNetworkSpecies () const
+ 		+overridevirtual
+
+ +

Get the list of species in the network.

+
Returns
Vector of Species objects representing all network species.
+ +

Implements gridfire::engine::Engine.

+ +
+
+

Member Data Documentation

+ +

◆ m_species_cache

+ +
+
+ + + + + +
+ + + + +
std::vector<fourdst::atomic::Species> PyEngine::m_species_cache
+ 		+mutableprivate
+
+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classPyEngine.js b/docs/html/classPyEngine.js new file mode 100644 index 00000000..0663848c --- /dev/null +++ b/docs/html/classPyEngine.js @@ -0,0 +1,6 @@ +var classPyEngine = +[ + [ "calculateRHSAndEnergy", "classPyEngine.html#abc26a86d4f93b37564d32814edbbac4d", null ], + [ "getNetworkSpecies", "classPyEngine.html#a2d240423899e039c2ca688e96f8af1f2", null ], + [ "m_species_cache", "classPyEngine.html#a73caaa7606e2cdfd1aa82729a78ebb73", null ] +]; \ No newline at end of file diff --git a/docs/html/classPyEngineView-members.html b/docs/html/classPyEngineView-members.html new file mode 100644 index 00000000..9c136564 --- /dev/null +++ b/docs/html/classPyEngineView-members.html @@ -0,0 +1,112 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
PyEngineView Member List
+
+
+ +

This is the complete list of members for PyEngineView, including all inherited members.

+ + + +
getBaseEngine() const overridePyEngineViewprivatevirtual
~EngineView()=defaultgridfire::engine::EngineView< gridfire::engine::Engine >virtual
+
+ + + + diff --git a/docs/html/classPyEngineView.html b/docs/html/classPyEngineView.html new file mode 100644 index 00000000..b74e0be2 --- /dev/null +++ b/docs/html/classPyEngineView.html @@ -0,0 +1,174 @@ + + + + + + + +GridFire: PyEngineView Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Private Member Functions | +List of all members
+
PyEngineView Class Referencefinal
+
+
+ +

#include <py_engine.h>

+
+Inheritance diagram for PyEngineView:
+
+
+
[legend]
+
+Collaboration diagram for PyEngineView:
+
+
+
[legend]
+ + + + + +

+Private Member Functions

const gridfire::engine::Engine & getBaseEngine () const override
 Access the underlying engine instance.
 
+ + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::engine::EngineView< gridfire::engine::Engine >
virtual ~EngineView ()=default
 Virtual destructor.
 
+

Member Function Documentation

+ +

◆ getBaseEngine()

+ +
+
+ + + + + +
+ + + + + + + +
const gridfire::engine::Engine & PyEngineView::getBaseEngine () const
+ 		+overrideprivatevirtual
+
+ +

Access the underlying engine instance.

+
Returns
Const reference to the underlying engine.
+

This method must be implemented by derived classes to provide access to the base engine. The returned reference should remain valid for the lifetime of the EngineView.

+

Example:

const DynamicEngine& engine = myView.getBaseEngine();
+
+

Implements gridfire::engine::EngineView< gridfire::engine::Engine >.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classPyEngineView.js b/docs/html/classPyEngineView.js new file mode 100644 index 00000000..f372c16c --- /dev/null +++ b/docs/html/classPyEngineView.js @@ -0,0 +1,4 @@ +var classPyEngineView = +[ + [ "getBaseEngine", "classPyEngineView.html#aea9da2bcfdf25f3d17d007091eece206", null ] +]; \ No newline at end of file diff --git a/docs/html/classPyEngineView__coll__graph.map b/docs/html/classPyEngineView__coll__graph.map new file mode 100644 index 00000000..65c12546 --- /dev/null +++ b/docs/html/classPyEngineView__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classPyEngineView__coll__graph.md5 b/docs/html/classPyEngineView__coll__graph.md5 new file mode 100644 index 00000000..08e5f15c --- /dev/null +++ b/docs/html/classPyEngineView__coll__graph.md5 @@ -0,0 +1 @@ +eea8cb142fd175e1dec1183f388c8195 \ No newline at end of file diff --git a/docs/html/classPyEngineView__coll__graph.svg b/docs/html/classPyEngineView__coll__graph.svg new file mode 100644 index 00000000..c42d2e41 --- /dev/null +++ b/docs/html/classPyEngineView__coll__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +PyEngineView + + +Node1 + + +PyEngineView + + + + + +Node2 + + +gridfire::engine::Engine +View< gridfire::engine +::Engine > + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPyEngineView__coll__graph_org.svg b/docs/html/classPyEngineView__coll__graph_org.svg new file mode 100644 index 00000000..ade6a554 --- /dev/null +++ b/docs/html/classPyEngineView__coll__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +PyEngineView + + +Node1 + + +PyEngineView + + + + + +Node2 + + +gridfire::engine::Engine +View< gridfire::engine +::Engine > + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classPyEngineView__inherit__graph.map b/docs/html/classPyEngineView__inherit__graph.map new file mode 100644 index 00000000..65c12546 --- /dev/null +++ b/docs/html/classPyEngineView__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classPyEngineView__inherit__graph.md5 b/docs/html/classPyEngineView__inherit__graph.md5 new file mode 100644 index 00000000..08e5f15c --- /dev/null +++ b/docs/html/classPyEngineView__inherit__graph.md5 @@ -0,0 +1 @@ +eea8cb142fd175e1dec1183f388c8195 \ No newline at end of file diff --git a/docs/html/classPyEngineView__inherit__graph.svg b/docs/html/classPyEngineView__inherit__graph.svg new file mode 100644 index 00000000..c42d2e41 --- /dev/null +++ b/docs/html/classPyEngineView__inherit__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +PyEngineView + + +Node1 + + +PyEngineView + + + + + +Node2 + + +gridfire::engine::Engine +View< gridfire::engine +::Engine > + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPyEngineView__inherit__graph_org.svg b/docs/html/classPyEngineView__inherit__graph_org.svg new file mode 100644 index 00000000..ade6a554 --- /dev/null +++ b/docs/html/classPyEngineView__inherit__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +PyEngineView + + +Node1 + + +PyEngineView + + + + + +Node2 + + +gridfire::engine::Engine +View< gridfire::engine +::Engine > + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classPyEngine__coll__graph.map b/docs/html/classPyEngine__coll__graph.map new file mode 100644 index 00000000..3acc16c5 --- /dev/null +++ b/docs/html/classPyEngine__coll__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classPyEngine__coll__graph.md5 b/docs/html/classPyEngine__coll__graph.md5 new file mode 100644 index 00000000..6226746a --- /dev/null +++ b/docs/html/classPyEngine__coll__graph.md5 @@ -0,0 +1 @@ +bf8c628118e3defe52c39c4fff9e1ce5 \ No newline at end of file diff --git a/docs/html/classPyEngine__coll__graph.svg b/docs/html/classPyEngine__coll__graph.svg new file mode 100644 index 00000000..886aabf0 --- /dev/null +++ b/docs/html/classPyEngine__coll__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +PyEngine + + +Node1 + + +PyEngine + + + + + +Node2 + + +gridfire::engine::Engine + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node3->Node1 + + + + + + m_species_cache + + + +Node4 + + +Species + + + + + +Node4->Node3 + + + + + + elements + + + + + + + + diff --git a/docs/html/classPyEngine__coll__graph_org.svg b/docs/html/classPyEngine__coll__graph_org.svg new file mode 100644 index 00000000..b228943f --- /dev/null +++ b/docs/html/classPyEngine__coll__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +PyEngine + + +Node1 + + +PyEngine + + + + + +Node2 + + +gridfire::engine::Engine + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node3->Node1 + + + + + + m_species_cache + + + +Node4 + + +Species + + + + + +Node4->Node3 + + + + + + elements + + + diff --git a/docs/html/classPyEngine__inherit__graph.map b/docs/html/classPyEngine__inherit__graph.map new file mode 100644 index 00000000..c8dfa3a7 --- /dev/null +++ b/docs/html/classPyEngine__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classPyEngine__inherit__graph.md5 b/docs/html/classPyEngine__inherit__graph.md5 new file mode 100644 index 00000000..ef15bc45 --- /dev/null +++ b/docs/html/classPyEngine__inherit__graph.md5 @@ -0,0 +1 @@ +3b41df95d316ebb43a7c0886bd941b53 \ No newline at end of file diff --git a/docs/html/classPyEngine__inherit__graph.svg b/docs/html/classPyEngine__inherit__graph.svg new file mode 100644 index 00000000..3c83833f --- /dev/null +++ b/docs/html/classPyEngine__inherit__graph.svg @@ -0,0 +1,64 @@ + + + + + + + + + + + +PyEngine + + +Node1 + + +PyEngine + + + + + +Node2 + + +gridfire::engine::Engine + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPyEngine__inherit__graph_org.svg b/docs/html/classPyEngine__inherit__graph_org.svg new file mode 100644 index 00000000..14e72ebb --- /dev/null +++ b/docs/html/classPyEngine__inherit__graph_org.svg @@ -0,0 +1,39 @@ + + + + + + +PyEngine + + +Node1 + + +PyEngine + + + + + +Node2 + + +gridfire::engine::Engine + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classPyNetworkFileParser-members.html b/docs/html/classPyNetworkFileParser-members.html new file mode 100644 index 00000000..e96fadf3 --- /dev/null +++ b/docs/html/classPyNetworkFileParser-members.html @@ -0,0 +1,112 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
PyNetworkFileParser Member List
+
+
+ +

This is the complete list of members for PyNetworkFileParser, including all inherited members.

+ + + +
parse(const std::string &filename) const overridePyNetworkFileParserprivatevirtual
~NetworkFileParser()=defaultgridfire::io::NetworkFileParservirtual
+
+ + + + diff --git a/docs/html/classPyNetworkFileParser.html b/docs/html/classPyNetworkFileParser.html new file mode 100644 index 00000000..c3c0d79c --- /dev/null +++ b/docs/html/classPyNetworkFileParser.html @@ -0,0 +1,195 @@ + + + + + + + +GridFire: PyNetworkFileParser Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Private Member Functions | +List of all members
+
PyNetworkFileParser Class Referencefinal
+
+
+ +

#include <py_io.h>

+
+Inheritance diagram for PyNetworkFileParser:
+
+
+
[legend]
+
+Collaboration diagram for PyNetworkFileParser:
+
+
+
[legend]
+ + + + + +

+Private Member Functions

gridfire::io::ParsedNetworkData parse (const std::string &filename) const override
 Parses a network file and returns the parsed data.
 
+ + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::io::NetworkFileParser
virtual ~NetworkFileParser ()=default
 Virtual destructor for the base class.
 
+

Member Function Documentation

+ +

◆ parse()

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::io::ParsedNetworkData PyNetworkFileParser::parse (const std::string & filename) const
+ 		+overrideprivatevirtual
+
+ +

Parses a network file and returns the parsed data.

+

This is a pure virtual function that must be implemented by derived classes. It takes a filename as input and returns a ParsedNetworkData struct containing the information extracted from the file.

+
Parameters
+ + +
filenameThe path to the network file to parse.
+
+
+
Returns
A ParsedNetworkData struct containing the parsed reaction data.
+
Exceptions
+ + +
std::runtime_errorIf the file cannot be opened or a parsing error occurs.
+
+
+

Usage

std::unique_ptr<NetworkFileParser> parser = std::make_unique<SimpleReactionListFileParser>();
+
try {
+
ParsedNetworkData data = parser->parse("my_reactions.txt");
+
for (const auto& reaction_name : data.reactionPENames) {
+
// ... process reaction name
+
}
+
} catch (const std::runtime_error& e) {
+
// ... handle error
+
}
+
+

Implements gridfire::io::NetworkFileParser.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classPyNetworkFileParser.js b/docs/html/classPyNetworkFileParser.js new file mode 100644 index 00000000..ff8efa6a --- /dev/null +++ b/docs/html/classPyNetworkFileParser.js @@ -0,0 +1,4 @@ +var classPyNetworkFileParser = +[ + [ "parse", "classPyNetworkFileParser.html#afe09d1e5b07110e62cf4c6ec713cff54", null ] +]; \ No newline at end of file diff --git a/docs/html/classPyNetworkFileParser__coll__graph.map b/docs/html/classPyNetworkFileParser__coll__graph.map new file mode 100644 index 00000000..6149e49c --- /dev/null +++ b/docs/html/classPyNetworkFileParser__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classPyNetworkFileParser__coll__graph.md5 b/docs/html/classPyNetworkFileParser__coll__graph.md5 new file mode 100644 index 00000000..24af0841 --- /dev/null +++ b/docs/html/classPyNetworkFileParser__coll__graph.md5 @@ -0,0 +1 @@ +8c3024f8b722aa13b6798c748121afe4 \ No newline at end of file diff --git a/docs/html/classPyNetworkFileParser__coll__graph.svg b/docs/html/classPyNetworkFileParser__coll__graph.svg new file mode 100644 index 00000000..50877a43 --- /dev/null +++ b/docs/html/classPyNetworkFileParser__coll__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +PyNetworkFileParser + + +Node1 + + +PyNetworkFileParser + + + + + +Node2 + + +gridfire::io::NetworkFile +Parser + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPyNetworkFileParser__coll__graph_org.svg b/docs/html/classPyNetworkFileParser__coll__graph_org.svg new file mode 100644 index 00000000..0f10181f --- /dev/null +++ b/docs/html/classPyNetworkFileParser__coll__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +PyNetworkFileParser + + +Node1 + + +PyNetworkFileParser + + + + + +Node2 + + +gridfire::io::NetworkFile +Parser + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classPyNetworkFileParser__inherit__graph.map b/docs/html/classPyNetworkFileParser__inherit__graph.map new file mode 100644 index 00000000..6149e49c --- /dev/null +++ b/docs/html/classPyNetworkFileParser__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classPyNetworkFileParser__inherit__graph.md5 b/docs/html/classPyNetworkFileParser__inherit__graph.md5 new file mode 100644 index 00000000..24af0841 --- /dev/null +++ b/docs/html/classPyNetworkFileParser__inherit__graph.md5 @@ -0,0 +1 @@ +8c3024f8b722aa13b6798c748121afe4 \ No newline at end of file diff --git a/docs/html/classPyNetworkFileParser__inherit__graph.svg b/docs/html/classPyNetworkFileParser__inherit__graph.svg new file mode 100644 index 00000000..50877a43 --- /dev/null +++ b/docs/html/classPyNetworkFileParser__inherit__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +PyNetworkFileParser + + +Node1 + + +PyNetworkFileParser + + + + + +Node2 + + +gridfire::io::NetworkFile +Parser + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPyNetworkFileParser__inherit__graph_org.svg b/docs/html/classPyNetworkFileParser__inherit__graph_org.svg new file mode 100644 index 00000000..0f10181f --- /dev/null +++ b/docs/html/classPyNetworkFileParser__inherit__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +PyNetworkFileParser + + +Node1 + + +PyNetworkFileParser + + + + + +Node2 + + +gridfire::io::NetworkFile +Parser + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classPyNetworkPolicy-members.html b/docs/html/classPyNetworkPolicy-members.html new file mode 100644 index 00000000..994e5c6c --- /dev/null +++ b/docs/html/classPyNetworkPolicy-members.html @@ -0,0 +1,119 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
PyNetworkPolicy Member List
+
+
+ +

This is the complete list of members for PyNetworkPolicy, including all inherited members.

+ + + + + + + + + + +
construct() overridePyNetworkPolicyvirtual
get_engine_stack() const overridePyNetworkPolicyvirtual
get_engine_types_stack() const overridePyNetworkPolicyvirtual
get_partition_function() const overridePyNetworkPolicyvirtual
get_seed_reactions() const overridePyNetworkPolicyvirtual
get_seed_species() const overridePyNetworkPolicyvirtual
get_status() const overridePyNetworkPolicyvirtual
name() const overridePyNetworkPolicyvirtual
~NetworkPolicy()=defaultgridfire::policy::NetworkPolicyvirtual
+
+ + + + diff --git a/docs/html/classPyNetworkPolicy.html b/docs/html/classPyNetworkPolicy.html new file mode 100644 index 00000000..bc63b20e --- /dev/null +++ b/docs/html/classPyNetworkPolicy.html @@ -0,0 +1,414 @@ + + + + + + + +GridFire: PyNetworkPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
PyNetworkPolicy Class Referencefinal
+
+
+ +

#include <py_policy.h>

+
+Inheritance diagram for PyNetworkPolicy:
+
+
+
[legend]
+
+Collaboration diagram for PyNetworkPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

std::string name () const override
 Human-readable name for the policy.
 
const std::set< fourdst::atomic::Species > & get_seed_species () const override
 Returns the seed species the policy requires to initialize the network.
 
const gridfire::reaction::ReactionSet & get_seed_reactions () const override
 Returns the set of seed reactions the policy requires.
 
gridfire::engine::DynamicEngine & construct () override
 Construct and return a DynamicEngine instance (or engine view stack) satisfying the policy.
 
gridfire::policy::NetworkPolicyStatus get_status () const override
 Returns the current verification/construction status of the policy.
 
const std::vector< std::unique_ptr< gridfire::engine::DynamicEngine > > & get_engine_stack () const override
 
std::vector< gridfire::engine::EngineTypes > get_engine_types_stack () const override
 
const std::unique_ptr< gridfire::partition::PartitionFunction > & get_partition_function () const override
 
- Public Member Functions inherited from gridfire::policy::NetworkPolicy
virtual ~NetworkPolicy ()=default
 
+

Member Function Documentation

+ +

◆ construct()

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::engine::DynamicEngine & PyNetworkPolicy::construct ()
+ 		+overridevirtual
+
+ +

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

+

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

+
Returns
DynamicEngine& reference to a running/constructed engine ready for solver consumption.
+
Exceptions
+ + + + +
gridfire::exceptions::MissingKeyReactionErrorif required reactions are not present in the constructed network (see gridfire/exceptions/error_policy.h).
gridfire::exceptions::MissingSeedSpeciesErrorif required seed species are missing from the initializing composition.
gridfire::exceptions::PolicyErrorfor other construction/verification failures.
+
+
+
Example
DynamicEngine &engine = policy.construct();
+
solver::CVODESolverStrategy solver(engine);
+
NetOut out = solver.evaluate(netIn, true);
+
+ +

Implements gridfire::policy::NetworkPolicy.

+ +
+
+ +

◆ get_engine_stack()

+ +
+
+ + + + + +
+ + + + + + + +
const std::vector< std::unique_ptr< gridfire::engine::DynamicEngine > > & PyNetworkPolicy::get_engine_stack () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::NetworkPolicy.

+ +
+
+ +

◆ get_engine_types_stack()

+ +
+
+ + + + + +
+ + + + + + + +
std::vector< gridfire::engine::EngineTypes > PyNetworkPolicy::get_engine_types_stack () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::NetworkPolicy.

+ +
+
+ +

◆ get_partition_function()

+ +
+
+ + + + + +
+ + + + + + + +
const std::unique_ptr< gridfire::partition::PartitionFunction > & PyNetworkPolicy::get_partition_function () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::NetworkPolicy.

+ +
+
+ +

◆ get_seed_reactions()

+ +
+
+ + + + + +
+ + + + + + + +
const gridfire::reaction::ReactionSet & PyNetworkPolicy::get_seed_reactions () const
+ 		+overridevirtual
+
+ +

Returns the set of seed reactions the policy requires.

+

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

+
Example
const reaction::ReactionSet &reactions = policy.get_seed_reactions();
+
// inspect reaction IDs or count
+
std::cout << "Policy requires " << reactions.size() << " reactions" << std::endl;
+
+ +

Implements gridfire::policy::NetworkPolicy.

+ +
+
+ +

◆ get_seed_species()

+ +
+
+ + + + + +
+ + + + + + + +
const std::set< fourdst::atomic::Species > & PyNetworkPolicy::get_seed_species () const
+ 		+overridevirtual
+
+ +

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

+

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

+

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

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

Implements gridfire::policy::NetworkPolicy.

+ +
+
+ +

◆ get_status()

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::policy::NetworkPolicyStatus PyNetworkPolicy::get_status () const
+ 		+overridevirtual
+
+ +

Returns the current verification/construction status of the policy.

+

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

+
Example
NetworkPolicyStatus s = policy.getStatus();
+
if (s != NetworkPolicyStatus::INITIALIZED_VERIFIED) { // handle error }
+
+ +

Implements gridfire::policy::NetworkPolicy.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string PyNetworkPolicy::name () const
+ 		+overridevirtual
+
+ +

Human-readable name for the policy.

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

Implements gridfire::policy::NetworkPolicy.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classPyNetworkPolicy.js b/docs/html/classPyNetworkPolicy.js new file mode 100644 index 00000000..eeca4955 --- /dev/null +++ b/docs/html/classPyNetworkPolicy.js @@ -0,0 +1,11 @@ +var classPyNetworkPolicy = +[ + [ "construct", "classPyNetworkPolicy.html#a6871d8aae79db9b784d40b05225b3445", null ], + [ "get_engine_stack", "classPyNetworkPolicy.html#ac640b306cf921c0793a296bd41e8d405", null ], + [ "get_engine_types_stack", "classPyNetworkPolicy.html#a62eed803e30afebbbc074a3bf334524b", null ], + [ "get_partition_function", "classPyNetworkPolicy.html#a86d85c133b7dba16f93e3a084201b931", null ], + [ "get_seed_reactions", "classPyNetworkPolicy.html#af0b892e995f58375144bd5559cf2b4c9", null ], + [ "get_seed_species", "classPyNetworkPolicy.html#a1d685fd5eb346871af5b8ed677dfcf36", null ], + [ "get_status", "classPyNetworkPolicy.html#a8506a1f9c22d47c266abe1519ffb9bc0", null ], + [ "name", "classPyNetworkPolicy.html#ac2c1ef3897e6491d5ab03e7342075245", null ] +]; \ No newline at end of file diff --git a/docs/html/classPyNetworkPolicy__coll__graph.map b/docs/html/classPyNetworkPolicy__coll__graph.map new file mode 100644 index 00000000..703133a7 --- /dev/null +++ b/docs/html/classPyNetworkPolicy__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classPyNetworkPolicy__coll__graph.md5 b/docs/html/classPyNetworkPolicy__coll__graph.md5 new file mode 100644 index 00000000..d242f2c7 --- /dev/null +++ b/docs/html/classPyNetworkPolicy__coll__graph.md5 @@ -0,0 +1 @@ +136df150730454d84ea5e5b202e840dd \ No newline at end of file diff --git a/docs/html/classPyNetworkPolicy__coll__graph.svg b/docs/html/classPyNetworkPolicy__coll__graph.svg new file mode 100644 index 00000000..3ff445b4 --- /dev/null +++ b/docs/html/classPyNetworkPolicy__coll__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +PyNetworkPolicy + + +Node1 + + +PyNetworkPolicy + + + + + +Node2 + + +gridfire::policy::Network +Policy + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPyNetworkPolicy__coll__graph_org.svg b/docs/html/classPyNetworkPolicy__coll__graph_org.svg new file mode 100644 index 00000000..539c5684 --- /dev/null +++ b/docs/html/classPyNetworkPolicy__coll__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +PyNetworkPolicy + + +Node1 + + +PyNetworkPolicy + + + + + +Node2 + + +gridfire::policy::Network +Policy + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classPyNetworkPolicy__inherit__graph.map b/docs/html/classPyNetworkPolicy__inherit__graph.map new file mode 100644 index 00000000..703133a7 --- /dev/null +++ b/docs/html/classPyNetworkPolicy__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classPyNetworkPolicy__inherit__graph.md5 b/docs/html/classPyNetworkPolicy__inherit__graph.md5 new file mode 100644 index 00000000..d242f2c7 --- /dev/null +++ b/docs/html/classPyNetworkPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +136df150730454d84ea5e5b202e840dd \ No newline at end of file diff --git a/docs/html/classPyNetworkPolicy__inherit__graph.svg b/docs/html/classPyNetworkPolicy__inherit__graph.svg new file mode 100644 index 00000000..3ff445b4 --- /dev/null +++ b/docs/html/classPyNetworkPolicy__inherit__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +PyNetworkPolicy + + +Node1 + + +PyNetworkPolicy + + + + + +Node2 + + +gridfire::policy::Network +Policy + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPyNetworkPolicy__inherit__graph_org.svg b/docs/html/classPyNetworkPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..539c5684 --- /dev/null +++ b/docs/html/classPyNetworkPolicy__inherit__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +PyNetworkPolicy + + +Node1 + + +PyNetworkPolicy + + + + + +Node2 + + +gridfire::policy::Network +Policy + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classPyPartitionFunction-members.html b/docs/html/classPyPartitionFunction-members.html new file mode 100644 index 00000000..c0192d18 --- /dev/null +++ b/docs/html/classPyPartitionFunction-members.html @@ -0,0 +1,116 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
PyPartitionFunction Member List
+
+
+ +

This is the complete list of members for PyPartitionFunction, including all inherited members.

+ + + + + + + +
clone() const overridePyPartitionFunctionprivatevirtual
evaluate(int z, int a, double T9) const overridePyPartitionFunctionprivatevirtual
evaluateDerivative(int z, int a, double T9) const overridePyPartitionFunctionprivatevirtual
supports(int z, int a) const overridePyPartitionFunctionprivatevirtual
type() const overridePyPartitionFunctionprivatevirtual
~PartitionFunction()=defaultgridfire::partition::PartitionFunctionvirtual
+
+ + + + diff --git a/docs/html/classPyPartitionFunction.html b/docs/html/classPyPartitionFunction.html new file mode 100644 index 00000000..3bb90dbf --- /dev/null +++ b/docs/html/classPyPartitionFunction.html @@ -0,0 +1,380 @@ + + + + + + + +GridFire: PyPartitionFunction Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Private Member Functions | +List of all members
+
PyPartitionFunction Class Referencefinal
+
+
+ +

#include <py_partition.h>

+
+Inheritance diagram for PyPartitionFunction:
+
+
+
[legend]
+
+Collaboration diagram for PyPartitionFunction:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + +

+Private Member Functions

double evaluate (int z, int a, double T9) const override
 Evaluate the partition function for a given isotope.
 
double evaluateDerivative (int z, int a, double T9) const override
 Evaluate the temperature derivative of the partition function.
 
bool supports (int z, int a) const override
 Check if this partition function supports an isotope.
 
std::string type () const override
 Get the human-readable type of this partition function.
 
std::unique_ptr< PartitionFunction > clone () const override
 Create a deep copy of this PartitionFunction.
 
+ + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::partition::PartitionFunction
virtual ~PartitionFunction ()=default
 Virtual destructor.
 
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< gridfire::partition::PartitionFunction > PyPartitionFunction::clone () const
+ 		+overrideprivatevirtual
+
+ +

Create a deep copy of this PartitionFunction.

+
Returns
Unique pointer to a new PartitionFunction instance with identical state.
+
Postcondition
The caller owns the returned object and must manage its lifetime.
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+ +

◆ evaluate()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
double PyPartitionFunction::evaluate (int z,
int a,
double T9 
) const
+ 		+overrideprivatevirtual
+
+ +

Evaluate the partition function for a given isotope.

+
Parameters
+ + + + +
zProton number (atomic number) of the isotope; must be >= 1.
aMass number of the isotope; must be >= z.
T9Temperature in units of 10^9 K; must be > 0.
+
+
+
Returns
Partition function value (dimensionless) at the specified temperature.
+
Precondition
Derived implementation supports (z, a) and T9 > 0.
+
Postcondition
No side effects; pure function.
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+ +

◆ evaluateDerivative()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
double PyPartitionFunction::evaluateDerivative (int z,
int a,
double T9 
) const
+ 		+overrideprivatevirtual
+
+ +

Evaluate the temperature derivative of the partition function.

+

Computes d/dT (partition function) at the given parameters.

+
Parameters
+ + + + +
zProton number (atomic number) of the isotope; must be >= 1.
aMass number of the isotope; must be >= z.
T9Temperature in units of 10^9 K; must be > 0.
+
+
+
Returns
Temperature derivative of the partition function.
+
Precondition
Derived implementation supports (z, a) and T9 > 0.
+
Postcondition
No side effects; pure function.
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+ +

◆ supports()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
bool PyPartitionFunction::supports (int z,
int a 
) const
+ 		+overrideprivatevirtual
+
+ +

Check if this partition function supports an isotope.

+
Parameters
+ + + +
zProton number of the isotope.
aMass number of the isotope.
+
+
+
Returns
true if evaluate and evaluateDerivative can be called for this isotope; false otherwise.
+
Postcondition
No side effects.
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+ +

◆ type()

+ +
+
+ + + + + +
+ + + + + + + +
std::string PyPartitionFunction::type () const
+ 		+overrideprivatevirtual
+
+ +

Get the human-readable type of this partition function.

+
Returns
String identifier for the partition function implementation.
+
Postcondition
No side effects.
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classPyPartitionFunction.js b/docs/html/classPyPartitionFunction.js new file mode 100644 index 00000000..dae9b959 --- /dev/null +++ b/docs/html/classPyPartitionFunction.js @@ -0,0 +1,8 @@ +var classPyPartitionFunction = +[ + [ "clone", "classPyPartitionFunction.html#af918b357e38fb82499ad53584557c43d", null ], + [ "evaluate", "classPyPartitionFunction.html#a83aca0bc261734b7d3df8269f730c69b", null ], + [ "evaluateDerivative", "classPyPartitionFunction.html#a260df9689bf698970ebf5104977a3dcf", null ], + [ "supports", "classPyPartitionFunction.html#a0f288a01a3ed7fb92fff5d9fd7d56aa8", null ], + [ "type", "classPyPartitionFunction.html#a07f4d0ff83822dd2800897161d2a3717", null ] +]; \ No newline at end of file diff --git a/docs/html/classPyPartitionFunction__coll__graph.map b/docs/html/classPyPartitionFunction__coll__graph.map new file mode 100644 index 00000000..c22ff63e --- /dev/null +++ b/docs/html/classPyPartitionFunction__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classPyPartitionFunction__coll__graph.md5 b/docs/html/classPyPartitionFunction__coll__graph.md5 new file mode 100644 index 00000000..5649bece --- /dev/null +++ b/docs/html/classPyPartitionFunction__coll__graph.md5 @@ -0,0 +1 @@ +e1a03e20168f904e5e20861f144b86e0 \ No newline at end of file diff --git a/docs/html/classPyPartitionFunction__coll__graph.svg b/docs/html/classPyPartitionFunction__coll__graph.svg new file mode 100644 index 00000000..7a235126 --- /dev/null +++ b/docs/html/classPyPartitionFunction__coll__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +PyPartitionFunction + + +Node1 + + +PyPartitionFunction + + + + + +Node2 + + +gridfire::partition +::PartitionFunction + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPyPartitionFunction__coll__graph_org.svg b/docs/html/classPyPartitionFunction__coll__graph_org.svg new file mode 100644 index 00000000..1d87cbd3 --- /dev/null +++ b/docs/html/classPyPartitionFunction__coll__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +PyPartitionFunction + + +Node1 + + +PyPartitionFunction + + + + + +Node2 + + +gridfire::partition +::PartitionFunction + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classPyPartitionFunction__inherit__graph.map b/docs/html/classPyPartitionFunction__inherit__graph.map new file mode 100644 index 00000000..c22ff63e --- /dev/null +++ b/docs/html/classPyPartitionFunction__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classPyPartitionFunction__inherit__graph.md5 b/docs/html/classPyPartitionFunction__inherit__graph.md5 new file mode 100644 index 00000000..5649bece --- /dev/null +++ b/docs/html/classPyPartitionFunction__inherit__graph.md5 @@ -0,0 +1 @@ +e1a03e20168f904e5e20861f144b86e0 \ No newline at end of file diff --git a/docs/html/classPyPartitionFunction__inherit__graph.svg b/docs/html/classPyPartitionFunction__inherit__graph.svg new file mode 100644 index 00000000..7a235126 --- /dev/null +++ b/docs/html/classPyPartitionFunction__inherit__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +PyPartitionFunction + + +Node1 + + +PyPartitionFunction + + + + + +Node2 + + +gridfire::partition +::PartitionFunction + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPyPartitionFunction__inherit__graph_org.svg b/docs/html/classPyPartitionFunction__inherit__graph_org.svg new file mode 100644 index 00000000..1d87cbd3 --- /dev/null +++ b/docs/html/classPyPartitionFunction__inherit__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +PyPartitionFunction + + +Node1 + + +PyPartitionFunction + + + + + +Node2 + + +gridfire::partition +::PartitionFunction + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classPyReactionChainPolicy-members.html b/docs/html/classPyReactionChainPolicy-members.html new file mode 100644 index 00000000..eb17a82a --- /dev/null +++ b/docs/html/classPyReactionChainPolicy-members.html @@ -0,0 +1,121 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
PyReactionChainPolicy Member List
+
+
+ +

This is the complete list of members for PyReactionChainPolicy, including all inherited members.

+ + + + + + + + + + + + +
clone() const overridePyReactionChainPolicyvirtual
contains(const std::string &id) const overridePyReactionChainPolicyvirtual
contains(const gridfire::reaction::Reaction &reaction) const overridePyReactionChainPolicyvirtual
get_reactions() const overridePyReactionChainPolicyvirtual
hash(uint64_t seed) const overridePyReactionChainPolicyvirtual
name() const overridePyReactionChainPolicyvirtual
operator!=(const ReactionChainPolicy &other) const overridePyReactionChainPolicy
gridfire::policy::ReactionChainPolicy::operator!=(const ReactionChainPolicy &other) const =0gridfire::policy::ReactionChainPolicypure virtual
operator==(const ReactionChainPolicy &other) const overridePyReactionChainPolicy
gridfire::policy::ReactionChainPolicy::operator==(const ReactionChainPolicy &other) const =0gridfire::policy::ReactionChainPolicypure virtual
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
+
+ + + + diff --git a/docs/html/classPyReactionChainPolicy.html b/docs/html/classPyReactionChainPolicy.html new file mode 100644 index 00000000..c6791612 --- /dev/null +++ b/docs/html/classPyReactionChainPolicy.html @@ -0,0 +1,385 @@ + + + + + + + +GridFire: PyReactionChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
PyReactionChainPolicy Class Referencefinal
+
+
+ +

#include <py_policy.h>

+
+Inheritance diagram for PyReactionChainPolicy:
+
+
+
[legend]
+
+Collaboration diagram for PyReactionChainPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

const gridfire::reaction::ReactionSet & get_reactions () const override
 Returns the ReactionSet describing this chain.
 
bool contains (const std::string &id) const override
 
bool contains (const gridfire::reaction::Reaction &reaction) const override
 
std::unique_ptr< ReactionChainPolicy > clone () const override
 
std::string name () const override
 
uint64_t hash (uint64_t seed) const override
 
bool operator== (const ReactionChainPolicy &other) const override
 
bool operator!= (const ReactionChainPolicy &other) const override
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
virtual bool operator== (const ReactionChainPolicy &other) const =0
 
virtual bool operator!= (const ReactionChainPolicy &other) const =0
 
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< gridfire::policy::ReactionChainPolicy > PyReactionChainPolicy::clone () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ contains() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + +
bool PyReactionChainPolicy::contains (const gridfire::reaction::Reaction & reaction) const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ contains() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
bool PyReactionChainPolicy::contains (const std::string & id) const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ get_reactions()

+ +
+
+ + + + + +
+ + + + + + + +
const gridfire::reaction::ReactionSet & PyReactionChainPolicy::get_reactions () const
+ 		+overridevirtual
+
+ +

Returns the ReactionSet describing this chain.

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

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ hash()

+ +
+
+ + + + + +
+ + + + + + + + +
uint64_t PyReactionChainPolicy::hash (uint64_t seed) const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string PyReactionChainPolicy::name () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ operator!=()

+ +
+
+ + + + + +
+ + + + + + + + +
bool PyReactionChainPolicy::operator!= (const ReactionChainPolicy & other) const
+ 		+override
+
+ +
+
+ +

◆ operator==()

+ +
+
+ + + + + +
+ + + + + + + + +
bool PyReactionChainPolicy::operator== (const ReactionChainPolicy & other) const
+ 		+override
+
+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classPyReactionChainPolicy.js b/docs/html/classPyReactionChainPolicy.js new file mode 100644 index 00000000..03e006f5 --- /dev/null +++ b/docs/html/classPyReactionChainPolicy.js @@ -0,0 +1,11 @@ +var classPyReactionChainPolicy = +[ + [ "clone", "classPyReactionChainPolicy.html#a0b44991bd6a5edebb861e78a26f783cd", null ], + [ "contains", "classPyReactionChainPolicy.html#ab30925d8253ecdabb73ea2b116e9c7da", null ], + [ "contains", "classPyReactionChainPolicy.html#a16f289efd1d92eead3a3ca6fcfceba4d", null ], + [ "get_reactions", "classPyReactionChainPolicy.html#a5fd4ff9137e1d76decf7318066d45969", null ], + [ "hash", "classPyReactionChainPolicy.html#a42d2f71522e7f13624c2598597f14809", null ], + [ "name", "classPyReactionChainPolicy.html#af148bf87fea9ebe61de745913a2fd504", null ], + [ "operator!=", "classPyReactionChainPolicy.html#a8e3c5cdd4c1901bedf93168868a759a9", null ], + [ "operator==", "classPyReactionChainPolicy.html#ad6671a30c99ad7a80edd60bd43a8a233", null ] +]; \ No newline at end of file diff --git a/docs/html/classPyReactionChainPolicy__coll__graph.map b/docs/html/classPyReactionChainPolicy__coll__graph.map new file mode 100644 index 00000000..94b893ce --- /dev/null +++ b/docs/html/classPyReactionChainPolicy__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classPyReactionChainPolicy__coll__graph.md5 b/docs/html/classPyReactionChainPolicy__coll__graph.md5 new file mode 100644 index 00000000..eed3ef68 --- /dev/null +++ b/docs/html/classPyReactionChainPolicy__coll__graph.md5 @@ -0,0 +1 @@ +c829e5e99023706d373970fba8b51e36 \ No newline at end of file diff --git a/docs/html/classPyReactionChainPolicy__coll__graph.svg b/docs/html/classPyReactionChainPolicy__coll__graph.svg new file mode 100644 index 00000000..36287e5b --- /dev/null +++ b/docs/html/classPyReactionChainPolicy__coll__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +PyReactionChainPolicy + + +Node1 + + +PyReactionChainPolicy + + + + + +Node2 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPyReactionChainPolicy__coll__graph_org.svg b/docs/html/classPyReactionChainPolicy__coll__graph_org.svg new file mode 100644 index 00000000..9ee5bbed --- /dev/null +++ b/docs/html/classPyReactionChainPolicy__coll__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +PyReactionChainPolicy + + +Node1 + + +PyReactionChainPolicy + + + + + +Node2 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classPyReactionChainPolicy__inherit__graph.map b/docs/html/classPyReactionChainPolicy__inherit__graph.map new file mode 100644 index 00000000..94b893ce --- /dev/null +++ b/docs/html/classPyReactionChainPolicy__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classPyReactionChainPolicy__inherit__graph.md5 b/docs/html/classPyReactionChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..eed3ef68 --- /dev/null +++ b/docs/html/classPyReactionChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +c829e5e99023706d373970fba8b51e36 \ No newline at end of file diff --git a/docs/html/classPyReactionChainPolicy__inherit__graph.svg b/docs/html/classPyReactionChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..36287e5b --- /dev/null +++ b/docs/html/classPyReactionChainPolicy__inherit__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +PyReactionChainPolicy + + +Node1 + + +PyReactionChainPolicy + + + + + +Node2 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPyReactionChainPolicy__inherit__graph_org.svg b/docs/html/classPyReactionChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..9ee5bbed --- /dev/null +++ b/docs/html/classPyReactionChainPolicy__inherit__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +PyReactionChainPolicy + + +Node1 + + +PyReactionChainPolicy + + + + + +Node2 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classPyScreening-members.html b/docs/html/classPyScreening-members.html new file mode 100644 index 00000000..60a83dfd --- /dev/null +++ b/docs/html/classPyScreening-members.html @@ -0,0 +1,114 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
PyScreening Member List
+
+
+ +

This is the complete list of members for PyScreening, including all inherited members.

+ + + + + +
ADDouble typedefgridfire::screening::ScreeningModel
calculateScreeningFactors(const gridfire::reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, double T9, double rho) const overridePyScreeningprivatevirtual
calculateScreeningFactors(const gridfire::reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< ADDouble > &Y, ADDouble T9, ADDouble rho) const overridePyScreeningprivatevirtual
~ScreeningModel()=defaultgridfire::screening::ScreeningModelvirtual
+
+ + + + diff --git a/docs/html/classPyScreening.html b/docs/html/classPyScreening.html new file mode 100644 index 00000000..db2acaf9 --- /dev/null +++ b/docs/html/classPyScreening.html @@ -0,0 +1,306 @@ + + + + + + + +GridFire: PyScreening Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Private Member Functions | +List of all members
+
PyScreening Class Referencefinal
+
+
+ +

#include <py_screening.h>

+
+Inheritance diagram for PyScreening:
+
+
+
[legend]
+
+Collaboration diagram for PyScreening:
+
+
+
[legend]
+ + + + + + + + +

+Private Member Functions

std::vector< double > calculateScreeningFactors (const gridfire::reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, double T9, double rho) const override
 Calculates screening factors for a set of reactions.
 
std::vector< ADDouble > calculateScreeningFactors (const gridfire::reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< ADDouble > &Y, ADDouble T9, ADDouble rho) const override
 Calculates screening factors using CppAD types for automatic differentiation.
 
+ + + + + + + + + +

+Additional Inherited Members

- Public Types inherited from gridfire::screening::ScreeningModel
using ADDouble = CppAD::AD< double >
 Alias for CppAD Automatic Differentiation type for double precision.
 
- Public Member Functions inherited from gridfire::screening::ScreeningModel
virtual ~ScreeningModel ()=default
 Virtual destructor.
 
+

Member Function Documentation

+ +

◆ calculateScreeningFactors() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< ADDouble > PyScreening::calculateScreeningFactors (const gridfire::reaction::ReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< ADDouble > & Y,
ADDouble T9,
ADDouble rho 
) const
+ 		+overrideprivatevirtual
+
+ +

Calculates screening factors using CppAD types for automatic differentiation.

+

This is a pure virtual function that provides an overload of calculateScreeningFactors for use with CppAD. It allows the derivatives of the screening factors with respect to abundances, temperature, and density to be computed automatically.

+
Parameters
+ + + + + + +
reactionsThe set of logical reactions in the network.
speciesA vector of all atomic species involved in the network.
YThe current composition, providing molar abundances (mol/g) for each species.
T9The temperature in units of 10^9 K, as an AD type.
rhoThe plasma density in g/cm^3, as an AD type.
+
+
+
Returns
A vector of screening factors (dimensionless), as AD types.
+

Note This method is essential for including the effects of screening in the Jacobian matrix of the reaction network.

+ +

Implements gridfire::screening::ScreeningModel.

+ +
+
+ +

◆ calculateScreeningFactors() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< double > PyScreening::calculateScreeningFactors (const gridfire::reaction::ReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< double > & Y,
double T9,
double rho 
) const
+ 		+overrideprivatevirtual
+
+ +

Calculates screening factors for a set of reactions.

+

This is a pure virtual function that must be implemented by derived classes. It computes the screening enhancement factor for each reaction in the provided set based on the given plasma conditions.

+
Parameters
+ + + + + + +
reactionsThe set of logical reactions in the network.
speciesA vector of all atomic species involved in the network.
YThe current composition, providing molar abundances (mol/g) for each species.
T9The temperature in units of 10^9 K.
rhoThe plasma density in g/cm^3.
+
+
+
Returns
A vector of screening factors (dimensionless), one for each reaction in the reactions set, in the same order.
+

Pre-conditions

    +
  • The size of the Y vector must match the size of the species vector.
    • +
  • T9 and rho must be positive.
    • +
+

Post-conditions

    +
  • The returned vector will have the same size as the reactions set.
    • +
  • Each element in the returned vector will be >= 1.0.
    • +
+

Usage

// Assume 'model' is a std::unique_ptr<ScreeningModel> to a concrete implementation
+
// and other parameters (reactions, species, Y, T9, rho) are initialized.
+
std::vector<double> screening_factors = model->calculateScreeningFactors(
+
reactions, species, Y, T9, rho
+
);
+
for (size_t i = 0; i < reactions.size(); ++i) {
+
// ... use screening_factors[i] ...
+
}
+
+

Implements gridfire::screening::ScreeningModel.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classPyScreening.js b/docs/html/classPyScreening.js new file mode 100644 index 00000000..070414b9 --- /dev/null +++ b/docs/html/classPyScreening.js @@ -0,0 +1,5 @@ +var classPyScreening = +[ + [ "calculateScreeningFactors", "classPyScreening.html#a68a126de903e1a87a1d7d1cfec8add0f", null ], + [ "calculateScreeningFactors", "classPyScreening.html#aa67b5f0528006d9c742033b8c5ab3a05", null ] +]; \ No newline at end of file diff --git a/docs/html/classPyScreening__coll__graph.map b/docs/html/classPyScreening__coll__graph.map new file mode 100644 index 00000000..3aacfc40 --- /dev/null +++ b/docs/html/classPyScreening__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classPyScreening__coll__graph.md5 b/docs/html/classPyScreening__coll__graph.md5 new file mode 100644 index 00000000..a8f27ffa --- /dev/null +++ b/docs/html/classPyScreening__coll__graph.md5 @@ -0,0 +1 @@ +b8e8d170d8942176c0c85debf789770c \ No newline at end of file diff --git a/docs/html/classPyScreening__coll__graph.svg b/docs/html/classPyScreening__coll__graph.svg new file mode 100644 index 00000000..3e96117c --- /dev/null +++ b/docs/html/classPyScreening__coll__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +PyScreening + + +Node1 + + +PyScreening + + + + + +Node2 + + +gridfire::screening +::ScreeningModel + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPyScreening__coll__graph_org.svg b/docs/html/classPyScreening__coll__graph_org.svg new file mode 100644 index 00000000..84883843 --- /dev/null +++ b/docs/html/classPyScreening__coll__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +PyScreening + + +Node1 + + +PyScreening + + + + + +Node2 + + +gridfire::screening +::ScreeningModel + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classPyScreening__inherit__graph.map b/docs/html/classPyScreening__inherit__graph.map new file mode 100644 index 00000000..3aacfc40 --- /dev/null +++ b/docs/html/classPyScreening__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classPyScreening__inherit__graph.md5 b/docs/html/classPyScreening__inherit__graph.md5 new file mode 100644 index 00000000..a8f27ffa --- /dev/null +++ b/docs/html/classPyScreening__inherit__graph.md5 @@ -0,0 +1 @@ +b8e8d170d8942176c0c85debf789770c \ No newline at end of file diff --git a/docs/html/classPyScreening__inherit__graph.svg b/docs/html/classPyScreening__inherit__graph.svg new file mode 100644 index 00000000..3e96117c --- /dev/null +++ b/docs/html/classPyScreening__inherit__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +PyScreening + + +Node1 + + +PyScreening + + + + + +Node2 + + +gridfire::screening +::ScreeningModel + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPyScreening__inherit__graph_org.svg b/docs/html/classPyScreening__inherit__graph_org.svg new file mode 100644 index 00000000..84883843 --- /dev/null +++ b/docs/html/classPyScreening__inherit__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +PyScreening + + +Node1 + + +PyScreening + + + + + +Node2 + + +gridfire::screening +::ScreeningModel + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classPySolverContextBase-members.html b/docs/html/classPySolverContextBase-members.html new file mode 100644 index 00000000..1403af04 --- /dev/null +++ b/docs/html/classPySolverContextBase-members.html @@ -0,0 +1,112 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
PySolverContextBase Member List
+
+
+ +

This is the complete list of members for PySolverContextBase, including all inherited members.

+ + + +
describe() const overridePySolverContextBasevirtual
~SolverContextBase()=defaultgridfire::solver::SolverContextBasevirtual
+
+ + + + diff --git a/docs/html/classPySolverContextBase.html b/docs/html/classPySolverContextBase.html new file mode 100644 index 00000000..4f57062b --- /dev/null +++ b/docs/html/classPySolverContextBase.html @@ -0,0 +1,169 @@ + + + + + + + +GridFire: PySolverContextBase Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
PySolverContextBase Class Referencefinal
+
+
+ +

#include <py_solver.h>

+
+Inheritance diagram for PySolverContextBase:
+
+
+
[legend]
+
+Collaboration diagram for PySolverContextBase:
+
+
+
[legend]
+ + + + + + + + +

+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
 
+

Member Function Documentation

+ +

◆ describe()

+ +
+
+ + + + + +
+ + + + + + + +
std::vector< std::tuple< std::string, std::string > > PySolverContextBase::describe () const
+ 		+overridevirtual
+
+ +

Describe the context for callback functions.

+
Returns
A vector of tuples, each containing a string for the parameters name and a string for its type.
+

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.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classPySolverContextBase.js b/docs/html/classPySolverContextBase.js new file mode 100644 index 00000000..e2ac2bee --- /dev/null +++ b/docs/html/classPySolverContextBase.js @@ -0,0 +1,4 @@ +var classPySolverContextBase = +[ + [ "describe", "classPySolverContextBase.html#af18f517d550c037d56c44144c07f1ee8", null ] +]; \ No newline at end of file diff --git a/docs/html/classPySolverContextBase__coll__graph.map b/docs/html/classPySolverContextBase__coll__graph.map new file mode 100644 index 00000000..fd5a1718 --- /dev/null +++ b/docs/html/classPySolverContextBase__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classPySolverContextBase__coll__graph.md5 b/docs/html/classPySolverContextBase__coll__graph.md5 new file mode 100644 index 00000000..4084b754 --- /dev/null +++ b/docs/html/classPySolverContextBase__coll__graph.md5 @@ -0,0 +1 @@ +6d0c74f9278039aa347fbd90c71d6ab6 \ No newline at end of file diff --git a/docs/html/classPySolverContextBase__coll__graph.svg b/docs/html/classPySolverContextBase__coll__graph.svg new file mode 100644 index 00000000..ec49fd49 --- /dev/null +++ b/docs/html/classPySolverContextBase__coll__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +PySolverContextBase + + +Node1 + + +PySolverContextBase + + + + + +Node2 + + +gridfire::solver::Solver +ContextBase + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPySolverContextBase__coll__graph_org.svg b/docs/html/classPySolverContextBase__coll__graph_org.svg new file mode 100644 index 00000000..0285614f --- /dev/null +++ b/docs/html/classPySolverContextBase__coll__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +PySolverContextBase + + +Node1 + + +PySolverContextBase + + + + + +Node2 + + +gridfire::solver::Solver +ContextBase + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classPySolverContextBase__inherit__graph.map b/docs/html/classPySolverContextBase__inherit__graph.map new file mode 100644 index 00000000..fd5a1718 --- /dev/null +++ b/docs/html/classPySolverContextBase__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classPySolverContextBase__inherit__graph.md5 b/docs/html/classPySolverContextBase__inherit__graph.md5 new file mode 100644 index 00000000..4084b754 --- /dev/null +++ b/docs/html/classPySolverContextBase__inherit__graph.md5 @@ -0,0 +1 @@ +6d0c74f9278039aa347fbd90c71d6ab6 \ No newline at end of file diff --git a/docs/html/classPySolverContextBase__inherit__graph.svg b/docs/html/classPySolverContextBase__inherit__graph.svg new file mode 100644 index 00000000..ec49fd49 --- /dev/null +++ b/docs/html/classPySolverContextBase__inherit__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +PySolverContextBase + + +Node1 + + +PySolverContextBase + + + + + +Node2 + + +gridfire::solver::Solver +ContextBase + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classPySolverContextBase__inherit__graph_org.svg b/docs/html/classPySolverContextBase__inherit__graph_org.svg new file mode 100644 index 00000000..0285614f --- /dev/null +++ b/docs/html/classPySolverContextBase__inherit__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +PySolverContextBase + + +Node1 + + +PySolverContextBase + + + + + +Node2 + + +gridfire::solver::Solver +ContextBase + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classSolverPluginInterface-members.html b/docs/html/classSolverPluginInterface-members.html new file mode 100644 index 00000000..24b9514c --- /dev/null +++ b/docs/html/classSolverPluginInterface-members.html @@ -0,0 +1,112 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
SolverPluginInterface Member List
+
+
+ +

This is the complete list of members for SolverPluginInterface, including all inherited members.

+ + + +
log_time(double t, double dt)=0SolverPluginInterfacepure virtual
~SolverPluginInterface() override=defaultSolverPluginInterface
+
+ + + + diff --git a/docs/html/classSolverPluginInterface.html b/docs/html/classSolverPluginInterface.html new file mode 100644 index 00000000..9215c252 --- /dev/null +++ b/docs/html/classSolverPluginInterface.html @@ -0,0 +1,197 @@ + + + + + + + +GridFire: SolverPluginInterface Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
SolverPluginInterface Class Referenceabstract
+
+
+ +

#include <solver_interfaces.h>

+
+Inheritance diagram for SolverPluginInterface:
+
+
+
[legend]
+
+Collaboration diagram for SolverPluginInterface:
+
+
+
[legend]
+ + + + + + +

+Public Member Functions

 ~SolverPluginInterface () override=default
 
virtual void log_time (double t, double dt)=0
 
+

Constructor & Destructor Documentation

+ +

◆ ~SolverPluginInterface()

+ +
+
+ + + + + +
+ + + + + + + +
SolverPluginInterface::~SolverPluginInterface ()
+ 		+overridedefault
+
+ +
+
+

Member Function Documentation

+ +

◆ log_time()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual void SolverPluginInterface::log_time (double t,
double dt 
)
+ 		+pure virtual
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classSolverPluginInterface.js b/docs/html/classSolverPluginInterface.js new file mode 100644 index 00000000..c75988cd --- /dev/null +++ b/docs/html/classSolverPluginInterface.js @@ -0,0 +1,5 @@ +var classSolverPluginInterface = +[ + [ "~SolverPluginInterface", "classSolverPluginInterface.html#a5611d046cd2fd4d4200785725854e39b", null ], + [ "log_time", "classSolverPluginInterface.html#a493a30c0ae4b2e1a89b7d03c02c0041c", null ] +]; \ No newline at end of file diff --git a/docs/html/classSolverPluginInterface__coll__graph.map b/docs/html/classSolverPluginInterface__coll__graph.map new file mode 100644 index 00000000..f4f078be --- /dev/null +++ b/docs/html/classSolverPluginInterface__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classSolverPluginInterface__coll__graph.md5 b/docs/html/classSolverPluginInterface__coll__graph.md5 new file mode 100644 index 00000000..5c0a7af8 --- /dev/null +++ b/docs/html/classSolverPluginInterface__coll__graph.md5 @@ -0,0 +1 @@ +1a212cac1f344bb7fdef14280610ef32 \ No newline at end of file diff --git a/docs/html/classSolverPluginInterface__coll__graph.svg b/docs/html/classSolverPluginInterface__coll__graph.svg new file mode 100644 index 00000000..ce7ab860 --- /dev/null +++ b/docs/html/classSolverPluginInterface__coll__graph.svg @@ -0,0 +1,64 @@ + + + + + + + + + + + +SolverPluginInterface + + +Node1 + + +SolverPluginInterface + + + + + +Node2 + + +fourdst::plugin::PluginBase + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classSolverPluginInterface__coll__graph_org.svg b/docs/html/classSolverPluginInterface__coll__graph_org.svg new file mode 100644 index 00000000..ddef2783 --- /dev/null +++ b/docs/html/classSolverPluginInterface__coll__graph_org.svg @@ -0,0 +1,39 @@ + + + + + + +SolverPluginInterface + + +Node1 + + +SolverPluginInterface + + + + + +Node2 + + +fourdst::plugin::PluginBase + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classSolverPluginInterface__inherit__graph.map b/docs/html/classSolverPluginInterface__inherit__graph.map new file mode 100644 index 00000000..f4f078be --- /dev/null +++ b/docs/html/classSolverPluginInterface__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classSolverPluginInterface__inherit__graph.md5 b/docs/html/classSolverPluginInterface__inherit__graph.md5 new file mode 100644 index 00000000..5c0a7af8 --- /dev/null +++ b/docs/html/classSolverPluginInterface__inherit__graph.md5 @@ -0,0 +1 @@ +1a212cac1f344bb7fdef14280610ef32 \ No newline at end of file diff --git a/docs/html/classSolverPluginInterface__inherit__graph.svg b/docs/html/classSolverPluginInterface__inherit__graph.svg new file mode 100644 index 00000000..ce7ab860 --- /dev/null +++ b/docs/html/classSolverPluginInterface__inherit__graph.svg @@ -0,0 +1,64 @@ + + + + + + + + + + + +SolverPluginInterface + + +Node1 + + +SolverPluginInterface + + + + + +Node2 + + +fourdst::plugin::PluginBase + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classSolverPluginInterface__inherit__graph_org.svg b/docs/html/classSolverPluginInterface__inherit__graph_org.svg new file mode 100644 index 00000000..ddef2783 --- /dev/null +++ b/docs/html/classSolverPluginInterface__inherit__graph_org.svg @@ -0,0 +1,39 @@ + + + + + + +SolverPluginInterface + + +Node1 + + +SolverPluginInterface + + + + + +Node2 + + +fourdst::plugin::PluginBase + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classes.html b/docs/html/classes.html index d9c21ca0..dca7a0f0 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -3,18 +3,16 @@ - + GridFire: Class Index - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -106,77 +99,77 @@ $(function(){initNavTree('classes.html',''); initResizable(true); });
A
-
TemperatureDependentChainPolicy::ActiveTempRange (gridfire::policy)
AdaptiveEngineView (gridfire::engine)
AndTrigger (gridfire::trigger)
GraphEngine::AtomicReverseRate (gridfire::engine)
WeakReaction::AtomicWeakRate (gridfire::rates::weak)
+
TemperatureDependentChainPolicy::ActiveTempRange (gridfire::policy)
AdaptiveEngineView (gridfire::engine)
AndTrigger (gridfire::trigger)
GraphEngine::AtomicReverseRate (gridfire::engine)
WeakReaction::AtomicWeakRate (gridfire::rates::weak)
B
-
BadCollectionError (gridfire::exceptions)
BadRHSEngineError (gridfire::exceptions)
BareScreeningModel (gridfire::screening)
BoundsErrorInfo (gridfire::rates::weak)
+
BadCollectionError (gridfire::exceptions)
BadRHSEngineError (gridfire::exceptions)
BareScreeningModel (gridfire::screening)
BoundsErrorInfo (gridfire::rates::weak)
C
-
CNOChainPolicy (gridfire::policy)
CNOIChainPolicy (gridfire::policy)
CNOIIChainPolicy (gridfire::policy)
CNOIIIChainPolicy (gridfire::policy)
CNOIVChainPolicy (gridfire::policy)
Column (gridfire::utils)
ColumnBase (gridfire::utils)
CompositePartitionFunction (gridfire::partition)
GraphEngine::constants (gridfire::engine)
WeakReaction::constants (gridfire::rates::weak)
ConvergenceFailureTrigger (gridfire::trigger::solver::CVODE)
CVODESolverStrategy::CVODERHSOutputData (gridfire::solver)
CVODESolverFailureError (gridfire::exceptions)
CVODESolverStrategy (gridfire::solver)
CVODESolverStrategy::CVODEUserData (gridfire::solver)
+
CNOChainPolicy (gridfire::policy)
CNOIChainPolicy (gridfire::policy)
CNOIIChainPolicy (gridfire::policy)
CNOIIIChainPolicy (gridfire::policy)
CNOIVChainPolicy (gridfire::policy)
Column (gridfire::utils)
ColumnBase (gridfire::utils)
CompositePartitionFunction (gridfire::partition)
GraphEngine::constants (gridfire::engine)
WeakReaction::constants (gridfire::rates::weak)
ConvergenceFailureTrigger (gridfire::trigger::solver::CVODE)
CVODESolverStrategy::CVODERHSOutputData (gridfire::solver)
CVODESolverFailureError (gridfire::exceptions)
CVODESolverStrategy (gridfire::solver)
CVODESolverStrategy::CVODEUserData (gridfire::solver)
D
-
DebugException (gridfire::exceptions)
DefinedEngineView (gridfire::engine)
DynamicEngine (gridfire::engine)
+
DebugException (gridfire::exceptions)
DefinedEngineView (gridfire::engine)
DynamicEngine (gridfire::engine)
E
-
EnergyDerivatives (gridfire::engine)
Engine (gridfire::engine)
EngineError (gridfire::exceptions)
EngineView (gridfire::engine)
EveryNthTrigger (gridfire::trigger)
+
EnergyDerivatives (gridfire::engine)
Engine (gridfire::engine)
EngineError (gridfire::exceptions)
EngineView (gridfire::engine)
EveryNthTrigger (gridfire::trigger)
F
-
FailedToPartitionEngineError (gridfire::exceptions)
FileDefinedEngineView (gridfire::engine)
MultiscalePartitioningEngineView::FluxValidationResult (gridfire::engine)
formatter< gridfire::engine::NetworkJacobian > (std)
+
FailedToPartitionEngineError (gridfire::exceptions)
FileDefinedEngineView (gridfire::engine)
MultiscalePartitioningEngineView::FluxValidationResult (gridfire::engine)
formatter< gridfire::engine::NetworkJacobian > (std)
G
-
gf_construct_engine_from_policy (gridfire_mod)
gf_construct_solver_from_engine (gridfire_mod)
gf_evolve (gridfire_mod)
gf_free (gridfire_mod)
gf_get_last_error_message (gridfire_mod)
gf_init (gridfire_mod)
gf_register_species (gridfire_mod)
GraphEngine (gridfire::engine)
gridfire (gridfire_mod)
GridFireContext
GridFireError (gridfire::exceptions)
GroundStatePartitionFunction (gridfire::partition)
+
gf_construct_engine_from_policy (gridfire_mod)
gf_construct_solver_from_engine (gridfire_mod)
gf_evolve (gridfire_mod)
gf_free (gridfire_mod)
gf_get_last_error_message (gridfire_mod)
gf_init (gridfire_mod)
gf_register_species (gridfire_mod)
GraphEngine (gridfire::engine)
gridfire (gridfire_mod)
GridFireContext
GridFireError (gridfire::exceptions)
GroundStatePartitionFunction (gridfire::partition)
H
-
hash< gridfire::rates::weak::TableAxes > (std)
hash< gridfire::reaction::Reaction > (std)
hash< gridfire::reaction::ReactionSet > (std)
HashingError (gridfire::exceptions)
HotCNOChainPolicy (gridfire::policy)
HotCNOIChainPolicy (gridfire::policy)
HotCNOIIChainPolicy (gridfire::policy)
HotCNOIIIChainPolicy (gridfire::policy)
+
hash< gridfire::rates::weak::TableAxes > (std)
hash< gridfire::reaction::Reaction > (std)
hash< gridfire::reaction::ReactionSet > (std)
HashingError (gridfire::exceptions)
HotCNOChainPolicy (gridfire::policy)
HotCNOIChainPolicy (gridfire::policy)
HotCNOIIChainPolicy (gridfire::policy)
HotCNOIIIChainPolicy (gridfire::policy)
I
-
RauscherThielemannPartitionFunction::IdentifiedIsotope (gridfire::partition)
IllConditionedJacobianError (gridfire::exceptions)
IntermediateScreeningModel (gridfire::screening)
InterpolationError (gridfire::rates::weak)
RauscherThielemannPartitionFunction::InterpolationPoints (gridfire::partition)
InvalidQSESolutionError (gridfire::exceptions)
RauscherThielemannPartitionFunction::IsotopeData (gridfire::partition)
IsotopeGrid (gridfire::rates::weak)
+
RauscherThielemannPartitionFunction::IdentifiedIsotope (gridfire::partition)
IllConditionedJacobianError (gridfire::exceptions)
IntermediateScreeningModel (gridfire::screening)
InterpolationError (gridfire::rates::weak)
RauscherThielemannPartitionFunction::InterpolationPoints (gridfire::partition)
InvalidQSESolutionError (gridfire::exceptions)
RauscherThielemannPartitionFunction::IsotopeData (gridfire::partition)
IsotopeGrid (gridfire::rates::weak)
J
-
JacobianError (gridfire::exceptions)
+
JacobianError (gridfire::exceptions)
K
-
KINSolSolverFailureError (gridfire::exceptions)
+
KINSolSolverFailureError (gridfire::exceptions)
L
-
LogicalReaclibReaction (gridfire::reaction)
LogicalTrigger (gridfire::trigger)
+
LogicalReaclibReaction (gridfire::reaction)
LogicalTrigger (gridfire::trigger)
M
-
MainSequencePolicy (gridfire::policy)
MainSequenceReactionChainPolicy (gridfire::policy)
MESANetworkFileParser (gridfire::io)
MissingBaseReactionError (gridfire::exceptions)
MissingKeyReactionError (gridfire::exceptions)
MissingSeedSpeciesError (gridfire::exceptions)
MultiReactionChainPolicy (gridfire::policy)
MultiscalePartitioningEngineView (gridfire::engine)
+
MainSequencePolicy (gridfire::policy)
MainSequenceReactionChainPolicy (gridfire::policy)
MESANetworkFileParser (gridfire::io)
MissingBaseReactionError (gridfire::exceptions)
MissingKeyReactionError (gridfire::exceptions)
MissingSeedSpeciesError (gridfire::exceptions)
MultiReactionChainPolicy (gridfire::policy)
MultiscalePartitioningEngineView (gridfire::engine)
N
-
NetIn (gridfire)
NetOut (gridfire)
NetworkFileParser (gridfire::io)
NetworkJacobian (gridfire::engine)
NetworkPolicy (gridfire::policy)
NetworkPrimingEngineView (gridfire::engine)
NetworkResizedError (gridfire::exceptions)
NetworkSolverStrategy (gridfire::solver)
NotTrigger (gridfire::trigger)
+
NetIn (gridfire)
NetOut (gridfire)
NetworkFileParser (gridfire::io)
NetworkJacobian (gridfire::engine)
NetworkPolicy (gridfire::policy)
NetworkPrimingEngineView (gridfire::engine)
NetworkResizedError (gridfire::exceptions)
NetworkSolverStrategy (gridfire::solver)
NotTrigger (gridfire::trigger)
O
-
OffDiagonalTrigger (gridfire::trigger::solver::CVODE)
OrTrigger (gridfire::trigger)
+
OffDiagonalTrigger (gridfire::trigger::solver::CVODE)
OrTrigger (gridfire::trigger)
P
-
PartitionFunction (gridfire::partition)
PolicyError (gridfire::exceptions)
GraphEngine::PrecomputedReaction (gridfire::engine)
PrimingReport (gridfire::engine)
ProtonProtonChainPolicy (gridfire::policy)
ProtonProtonIChainPolicy (gridfire::policy)
ProtonProtonIIChainPolicy (gridfire::policy)
ProtonProtonIIIChainPolicy (gridfire::policy)
PyDynamicEngine
PyDynamicEngineView
PyDynamicNetworkSolverStrategy
PyEngine
PyEngineView
PyFunctionDef (gridfire::io::gen)
PyNetworkFileParser
PyNetworkPolicy
PyPartitionFunction
PyReactionChainPolicy
PyScreening
PySolverContextBase
+
PartitionFunction (gridfire::partition)
PolicyError (gridfire::exceptions)
GraphEngine::PrecomputedReaction (gridfire::engine)
PrimingReport (gridfire::engine)
ProtonProtonChainPolicy (gridfire::policy)
ProtonProtonIChainPolicy (gridfire::policy)
ProtonProtonIIChainPolicy (gridfire::policy)
ProtonProtonIIIChainPolicy (gridfire::policy)
PyDynamicEngine
PyDynamicEngineView
PyDynamicNetworkSolverStrategy
PyEngine
PyEngineView
PyFunctionDef (gridfire::io::gen)
PyNetworkFileParser
PyNetworkPolicy
PyPartitionFunction
PyReactionChainPolicy
PyScreening
PySolverContextBase
Q
-
MultiscalePartitioningEngineView::QSEGroup (gridfire::engine)
MultiscalePartitioningEngineView::QSESolver (gridfire::engine)
+
MultiscalePartitioningEngineView::QSEGroup (gridfire::engine)
MultiscalePartitioningEngineView::QSESolver (gridfire::engine)
R
-
RateCoefficientSet (gridfire::reaction)
RateDataRow (gridfire::rates::weak)
RauscherThielemannPartitionDataRecord (gridfire::partition::record)
RauscherThielemannPartitionFunction (gridfire::partition)
ReaclibReaction (gridfire::reaction)
Reaction (gridfire::engine)
Reaction (gridfire::reaction)
ReactionChainPolicy (gridfire::policy)
ReactionError (gridfire::exceptions)
AdaptiveEngineView::ReactionFlow (gridfire::engine)
ReactionParsingError (gridfire::exceptions)
ReactionRecord (gridfire::reaclib)
ReactionSet (gridfire::engine)
ReactionSet (gridfire::reaction)
+
RateCoefficientSet (gridfire::reaction)
RateDataRow (gridfire::rates::weak)
RauscherThielemannPartitionDataRecord (gridfire::partition::record)
RauscherThielemannPartitionFunction (gridfire::partition)
ReaclibReaction (gridfire::reaction)
Reaction (gridfire::reaction)
ReactionChainPolicy (gridfire::policy)
ReactionError (gridfire::exceptions)
AdaptiveEngineView::ReactionFlow (gridfire::engine)
ReactionParsingError (gridfire::exceptions)
ReactionRecord (gridfire::reaclib)
ReactionSet (gridfire::reaction)
S
-
ScreeningModel (gridfire::screening)
SimpleReactionListFileParser (gridfire::io)
SimulationTimeTrigger (gridfire::trigger::solver::CVODE)
SingularJacobianError (gridfire::exceptions)
SolverContextBase (gridfire::solver)
SolverError (gridfire::exceptions)
SolverPluginInterface
StaleJacobianError (gridfire::exceptions)
StepDerivatives (gridfire::engine)
SUNDIALSError (gridfire::exceptions)
+
ScreeningModel (gridfire::screening)
SimpleReactionListFileParser (gridfire::io)
SimulationTimeTrigger (gridfire::trigger::solver::CVODE)
SingularJacobianError (gridfire::exceptions)
SolverContextBase (gridfire::solver)
SolverError (gridfire::exceptions)
SolverPluginInterface
StaleJacobianError (gridfire::exceptions)
StepDerivatives (gridfire::engine)
SUNDIALSError (gridfire::exceptions)
T
-
Table (gridfire::utils)
TableBase (gridfire::utils)
TemperatureDependentChainPolicy (gridfire::policy)
TimestepCollapseTrigger (gridfire::trigger::solver::CVODE)
CVODESolverStrategy::TimestepContext (gridfire::solver)
Trigger (gridfire::trigger)
TriggerResult (gridfire::trigger)
TripleAlphaChainPolicy (gridfire::policy)
+
Table (gridfire::utils)
TableBase (gridfire::utils)
TemperatureDependentChainPolicy (gridfire::policy)
TimestepCollapseTrigger (gridfire::trigger::solver::CVODE)
CVODESolverStrategy::TimestepContext (gridfire::solver)
Trigger (gridfire::trigger)
TriggerResult (gridfire::trigger)
TripleAlphaChainPolicy (gridfire::policy)
U
-
UnableToSetNetworkReactionsError (gridfire::exceptions)
UninitializedJacobianError (gridfire::exceptions)
UnknownJacobianError (gridfire::exceptions)
MultiscalePartitioningEngineView::QSESolver::UserData (gridfire::engine)
UtilityError (gridfire::exceptions)
+
UnableToSetNetworkReactionsError (gridfire::exceptions)
UninitializedJacobianError (gridfire::exceptions)
UnknownJacobianError (gridfire::exceptions)
MultiscalePartitioningEngineView::QSESolver::UserData (gridfire::engine)
UtilityError (gridfire::exceptions)
W
-
WeakRateDerivatives (gridfire::rates::weak)
WeakRateInterpolator (gridfire::rates::weak)
WeakRatePayload (gridfire::rates::weak)
WeakReaclibReaction (gridfire::reaction)
WeakReaction (gridfire::rates::weak)
WeakReactionEntry (gridfire::rates::weak)
WeakReactionMap (gridfire::rates::weak)
WeakScreeningModel (gridfire::screening)
+
WeakRateDerivatives (gridfire::rates::weak)
WeakRateInterpolator (gridfire::rates::weak)
WeakRatePayload (gridfire::rates::weak)
WeakReaclibReaction (gridfire::reaction)
WeakReaction (gridfire::rates::weak)
WeakReactionEntry (gridfire::rates::weak)
WeakReactionMap (gridfire::rates::weak)
WeakScreeningModel (gridfire::screening)
diff --git a/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView-members.html b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView-members.html new file mode 100644 index 00000000..dc5e52ce --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView-members.html @@ -0,0 +1,153 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::AdaptiveEngineView Member List
+
+
+ +

This is the complete list of members for gridfire::engine::AdaptiveEngineView, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AdaptiveEngineView(DynamicEngine &baseEngine)gridfire::engine::AdaptiveEngineViewexplicit
calculateAllReactionFlows(const NetIn &netIn) constgridfire::engine::AdaptiveEngineViewprivate
calculateEpsDerivatives(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::AdaptiveEngineViewvirtual
calculateMolarReactionFlow(const reaction::Reaction &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::AdaptiveEngineViewvirtual
calculateRHSAndEnergy(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::AdaptiveEngineViewvirtual
collectComposition(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::AdaptiveEngineViewvirtual
Config typedefgridfire::engine::AdaptiveEngineViewprivate
cullReactionsByFlow(const std::vector< ReactionFlow > &allFlows, const std::unordered_set< fourdst::atomic::Species > &reachableSpecies, const fourdst::composition::Composition &comp, double maxFlow) constgridfire::engine::AdaptiveEngineViewprivate
finalizeActiveSet(const std::vector< const reaction::Reaction * > &finalReactions)gridfire::engine::AdaptiveEngineViewprivate
findReachableSpecies(const NetIn &netIn) constgridfire::engine::AdaptiveEngineViewprivate
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::AdaptiveEngineViewvirtual
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies) const overridegridfire::engine::AdaptiveEngineViewvirtual
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const overridegridfire::engine::AdaptiveEngineViewvirtual
generateStoichiometryMatrix() overridegridfire::engine::AdaptiveEngineViewvirtual
getBaseEngine() const overridegridfire::engine::AdaptiveEngineViewinlinevirtual
getDepth() constgridfire::engine::DynamicEngineinlinevirtual
getNetworkReactions() const overridegridfire::engine::AdaptiveEngineViewvirtual
getNetworkSpecies() const overridegridfire::engine::AdaptiveEngineViewvirtual
getScreeningModel() const overridegridfire::engine::AdaptiveEngineViewvirtual
getSpeciesDestructionTimescales(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::AdaptiveEngineViewvirtual
getSpeciesIndex(const fourdst::atomic::Species &species) const overridegridfire::engine::AdaptiveEngineViewvirtual
getSpeciesStatus(const fourdst::atomic::Species &species) const overridegridfire::engine::AdaptiveEngineViewvirtual
getSpeciesTimescales(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::AdaptiveEngineViewvirtual
getStoichiometryMatrixEntry(const fourdst::atomic::Species &species, const reaction::Reaction &reaction) const overridegridfire::engine::AdaptiveEngineViewvirtual
isStale(const NetIn &netIn) overridegridfire::engine::AdaptiveEngineViewvirtual
LogManager typedefgridfire::engine::AdaptiveEngineViewprivate
m_activeReactionsgridfire::engine::AdaptiveEngineViewprivate
m_activeSpeciesgridfire::engine::AdaptiveEngineViewprivate
m_baseEnginegridfire::engine::AdaptiveEngineViewprivate
m_configgridfire::engine::AdaptiveEngineViewprivate
m_isStalegridfire::engine::AdaptiveEngineViewprivate
m_loggergridfire::engine::AdaptiveEngineViewprivate
mapNetInToMolarAbundanceVector(const NetIn &netIn) const overridegridfire::engine::AdaptiveEngineViewvirtual
primeEngine(const NetIn &netIn) overridegridfire::engine::AdaptiveEngineViewvirtual
rebuild(const fourdst::composition::CompositionAbstract &comp, BuildDepthType depth)gridfire::engine::DynamicEngineinlinevirtual
rescueEdgeSpeciesDestructionChannel(const fourdst::composition::Composition &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies, const reaction::ReactionSet &activeReactions) constgridfire::engine::AdaptiveEngineViewprivate
RescueSet typedefgridfire::engine::AdaptiveEngineViewprivate
setNetworkReactions(const reaction::ReactionSet &reactions) overridegridfire::engine::AdaptiveEngineViewvirtual
setScreeningModel(screening::ScreeningType model) overridegridfire::engine::AdaptiveEngineViewvirtual
update(const NetIn &netIn) overridegridfire::engine::AdaptiveEngineViewvirtual
validateState() constgridfire::engine::AdaptiveEngineViewprivate
~Engine()=defaultgridfire::engine::Enginevirtual
~EngineView()=defaultgridfire::engine::EngineView< DynamicEngine >virtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView.html b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView.html new file mode 100644 index 00000000..c189f291 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView.html @@ -0,0 +1,1957 @@ + + + + + + + +GridFire: gridfire::engine::AdaptiveEngineView Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Classes | +Public Member Functions | +Private Types | +Private Member Functions | +Private Attributes | +List of all members
+
gridfire::engine::AdaptiveEngineView Class Referencefinal
+
+
+ +

An engine view that dynamically adapts the reaction network based on runtime conditions. + More...

+ +

#include <engine_adaptive.h>

+
+Inheritance diagram for gridfire::engine::AdaptiveEngineView:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::engine::AdaptiveEngineView:
+
+
+
[legend]
+ + + + + +

+Classes

struct  ReactionFlow
 A struct to hold a reaction and its flow rate. More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+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.
 
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.
 
- Public Member Functions inherited from gridfire::engine::Engine
virtual ~Engine ()=default
 Virtual destructor.
 
- Public Member Functions inherited from gridfire::engine::EngineView< DynamicEngine >
virtual ~EngineView ()=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.
 
+ + + + + + + + + + + + + + + + + + + +

+Private Attributes

Config & m_config = Config::getInstance()
 A reference to the singleton Config instance, used for retrieving configuration parameters.
 
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.
 
+

Detailed Description

+

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:

    +
  1. Reaction Flow Calculation: Calculates the molar reaction flow rate for each reaction in the full network based on the current temperature, density, and composition.
    2. +
  2. Reaction Culling: Culls reactions with flow rates below a threshold, determined by a relative culling threshold multiplied by the maximum flow rate.
    3. +
  3. Connectivity Analysis: Performs a connectivity analysis to identify species that are reachable from the initial fuel species through the culled reaction network.
    4. +
  4. Species Culling: Culls species that are not reachable from the initial fuel.
    5. +
  5. Index Map Construction: Constructs index maps to map between the full network indices and the active subset indices for species and reactions.
    6. +
+

<DynamicEngine>

+
See also
engine_abstract.h
+
+engine_view_abstract.h
+
+AdaptiveEngineView::update()
+

Member Typedef Documentation

+ +

◆ Config

+ +
+
+ + + + + +
+ + + + +
using gridfire::engine::AdaptiveEngineView::Config = fourdst::config::Config
+ 		+private
+
+ +
+
+ +

◆ LogManager

+ +
+
+ + + + + +
+ + + + +
using gridfire::engine::AdaptiveEngineView::LogManager = fourdst::logging::LogManager
+ 		+private
+
+ +
+
+ +

◆ RescueSet

+ +
+
+ + + + + +
+ + + + +
typedef std::pair<std::unordered_set<const reaction::Reaction*>, std::unordered_set<fourdst::atomic::Species> > gridfire::engine::AdaptiveEngineView::RescueSet
+ 		+private
+
+ +
+
+

Constructor & Destructor Documentation

+ +

◆ AdaptiveEngineView()

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::engine::AdaptiveEngineView::AdaptiveEngineView (DynamicEngine & baseEngine)
+ 		+explicit
+
+ +

Constructs an AdaptiveEngineView.

+
Parameters
+ + +
baseEngineThe underlying DynamicEngine to which this view delegates calculations.
+
+
+

Initializes the active species and reactions to the full network, and constructs the initial index maps.

+ +
+
+

Member Function Documentation

+ +

◆ calculateAllReactionFlows()

+ +
+
+ + + + + +
+ + + + + + + + +
std::pair< std::vector< AdaptiveEngineView::ReactionFlow >, fourdst::composition::Composition > gridfire::engine::AdaptiveEngineView::calculateAllReactionFlows (const NetIn & netIn) const
+ 		+private
+
+ +

Calculates the molar reaction flow rate for all reactions in the full network.

+

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.

+
Parameters
+ + +
netInThe current network input, containing temperature, density, and composition.
+
+
+
Returns
A pair with the first element a vector of ReactionFlow structs, each containing a pointer to a reaction and its calculated flow rate and the second being a composition object where species which were not present in netIn but are present in the definition of the base engine are registered but have 0 mass fraction.
+
Algorithm:
    +
  1. Iterates through all species in the base engine's network.
    2. +
  2. For each species, it retrieves the molar abundance from netIn.composition. If the species is not found, its abundance is set to 0.0.
    3. +
  3. Converts the temperature from Kelvin to T9.
    4. +
  4. Iterates through all reactions in the base engine's network.
    5. +
  5. For each reaction, it calls the base engine's calculateMolarReactionFlow to get the flow rate.
    6. +
  6. Stores the reaction pointer and its flow rate in a ReactionFlow struct and adds it to the returned vector.
    7. +
+
+ +
+
+ +

◆ calculateEpsDerivatives()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
EnergyDerivatives gridfire::engine::AdaptiveEngineView::calculateEpsDerivatives (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+
Parameters
+ + + + +
compThe current composition of the system.
T9The temperature in units of 10^9 K.
rhoThe density in g/cm^3.
+
+
+
Returns
A struct containing the derivatives of the energy generation rate with respect to temperature and density.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ calculateMolarReactionFlow()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::engine::AdaptiveEngineView::calculateMolarReactionFlow (const reaction::Reaction & reaction,
const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Calculates the molar reaction flow for a given reaction in the active network.

+
Parameters
+ + + + + +
reactionThe reaction for which to calculate the flow.
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
Molar flow rate for the reaction (e.g., mol/g/s).
+

This method maps the culled abundances to the full network abundances and calls the base engine to calculate the molar reaction flow.

+
Exceptions
+ + + +
std::runtime_errorIf the AdaptiveEngineView is stale (i.e., update() has not been called).
std::runtime_errorIf the reaction is not part of the active reactions in the adaptive engine view.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ calculateRHSAndEnergy()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
std::expected< StepDerivatives< double >, EngineStatus > gridfire::engine::AdaptiveEngineView::calculateRHSAndEnergy (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Calculates the right-hand side (dY/dt) and energy generation for the active species.

+
Parameters
+ + + + +
compThe current composition of the system.
T9The temperature in units of 10^9 K.
rhoThe density in g/cm^3.
+
+
+
Returns
A StepDerivatives struct containing the derivatives of the active species and the nuclear energy generation rate.
+

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.

+
Exceptions
+ + +
std::runtime_errorIf the AdaptiveEngineView is stale (i.e., update() has not been called).
+
+
+
See also
AdaptiveEngineView::update()
+ +

Implements gridfire::engine::Engine.

+ +
+
+ +

◆ collectComposition()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
fourdst::composition::Composition gridfire::engine::AdaptiveEngineView::collectComposition (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Collect the composition of the base engine, ensure all active species are registered, and pass the composition back to the caller.

+
Parameters
+ + + + +
compThe current composition of the system.
T9The temperature in units of 10^9 K.
rhoThe density in g/cm^3.
+
+
+
Note
This function ensures that the state of both the base engine and the adaptive view are synchronized in the result back to the caller
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ cullReactionsByFlow()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< const reaction::Reaction * > gridfire::engine::AdaptiveEngineView::cullReactionsByFlow (const std::vector< ReactionFlow > & allFlows,
const std::unordered_set< fourdst::atomic::Species > & reachableSpecies,
const fourdst::composition::Composition & comp,
double maxFlow 
) const
+ 		+private
+
+ +

Culls reactions from the network based on their flow rates.

+

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.

+
Parameters
+ + + + + +
allFlowsA vector of all reactions and their flow rates.
reachableSpeciesA set of all species reachable from the initial fuel.
compThe current composition of the system.
maxFlowThe maximum reaction flow rate in the network.
+
+
+
Returns
A vector of pointers to the reactions that have been kept after culling.
+
Algorithm:
    +
  1. Retrieves the RelativeCullingThreshold from the configuration.
    2. +
  2. Calculates the absoluteCullingThreshold by multiplying maxFlow with the relative threshold.
    3. +
  3. Iterates through allFlows.
    4. +
  4. A reaction is kept if its flowRate is greater than the absoluteCullingThreshold.
    5. +
  5. The pointers to the kept reactions are stored in a vector and returned.
    6. +
+
+ +
+
+ +

◆ finalizeActiveSet()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::engine::AdaptiveEngineView::finalizeActiveSet (const std::vector< const reaction::Reaction * > & finalReactions)
+ 		+private
+
+ +

Finalizes the set of active species and reactions.

+

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.

+
Parameters
+ + +
finalReactionsA vector of pointers to the reactions to be included in the active set.
+
+
+
Postcondition
    +
  • m_activeReactions is cleared and populated with the reactions from finalReactions.
    • +
  • m_activeSpecies is cleared and populated with all unique species present in finalReactions.
    • +
  • m_activeSpecies is sorted by atomic mass.
    • +
+
+ +
+
+ +

◆ findReachableSpecies()

+ +
+
+ + + + + +
+ + + + + + + + +
std::unordered_set< Species > gridfire::engine::AdaptiveEngineView::findReachableSpecies (const NetIn & netIn) const
+ 		+private
+
+ +

Finds all species that are reachable from the initial fuel through the reaction network.

+

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).

+
Parameters
+ + +
netInThe current network input, containing the initial composition.
+
+
+
Returns
An unordered set of all reachable species.
+
Algorithm:
    +
  1. Initializes a set reachable and a queue to_visit with the initial fuel species.
    2. +
  2. Iteratively processes the reaction network until no new species can be reached.
    3. +
  3. In each pass, it iterates through all reactions in the base engine's network.
    4. +
  4. If all reactants of a reaction are in the reachable set, all products of that reaction are added to the reachable set.
    5. +
  5. The process continues until a full pass over all reactions does not add any new species to the reachable set.
    6. +
+
+ +
+
+ +

◆ generateJacobianMatrix() [1/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
NetworkJacobian gridfire::engine::AdaptiveEngineView::generateJacobianMatrix (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Generates the Jacobian matrix for the active species.

+
Parameters
+ + + + +
compThe current composition of the system.
T9The temperature in units of 10^9 K.
rhoThe density in g/cm^3.
+
+
+

This method maps the culled abundances to the full network abundances and calls the base engine to generate the Jacobian matrix.

+
Exceptions
+ + +
std::runtime_errorIf the AdaptiveEngineView is stale (i.e., update() has not been called).
+
+
+
See also
AdaptiveEngineView::update()
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ generateJacobianMatrix() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NetworkJacobian gridfire::engine::AdaptiveEngineView::generateJacobianMatrix (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho,
const SparsityPattern & sparsityPattern 
) const
+ 		+overridevirtual
+
+ +

Generates the Jacobian matrix for the active species with a given sparsity pattern.

+
Parameters
+ + + + + +
compThe current composition of the system.
T9The temperature in units of 10^9 K.
rhoThe density in g/cm^3.
sparsityPatternThe sparsity pattern to use for the Jacobian matrix.
+
+
+

This method maps the culled abundances to the full network abundances and calls the base engine to generate the Jacobian matrix.

+
Exceptions
+ + +
std::runtime_errorIf the AdaptiveEngineView is stale (i.e., update() has not been called).
+
+
+
See also
AdaptiveEngineView::update()
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ generateJacobianMatrix() [3/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NetworkJacobian gridfire::engine::AdaptiveEngineView::generateJacobianMatrix (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho,
const std::vector< fourdst::atomic::Species > & activeSpecies 
) const
+ 		+overridevirtual
+
+ +

Generates the Jacobian matrix for some set of active species such that that set is a subset of the active species in the view.

+
Parameters
+ + + + + +
compThe current composition of the system.
T9The temperature in units of 10^9 K.
rhoThe density in g/cm^3.
activeSpeciesThe list of active species for which to generate the Jacobian.
+
+
+

This method maps the culled abundances to the full network abundances and calls the base engine to generate the Jacobian matrix.

+
Exceptions
+ + +
std::runtime_errorIf the AdaptiveEngineView is stale (i.e., update() has not been called).
+
+
+
See also
AdaptiveEngineView::update()
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ generateStoichiometryMatrix()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::engine::AdaptiveEngineView::generateStoichiometryMatrix ()
+ 		+overridevirtual
+
+ +

Generates the stoichiometry matrix for the active reactions and species.

+

This method calls the base engine to generate the stoichiometry matrix.

+
Exceptions
+ + +
std::runtime_errorIf the AdaptiveEngineView is stale (i.e., update() has not been called).
+
+
+
Note
The stoichiometry matrix generated by the base engine is assumed to be consistent with the active species and reactions in this view.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getBaseEngine()

+ +
+
+ + + + + +
+ + + + + + + +
const DynamicEngine & gridfire::engine::AdaptiveEngineView::getBaseEngine () const
+ 		+inlineoverridevirtual
+
+ +

Gets the base engine.

+
Returns
A const reference to the base engine.
+ +

Implements gridfire::engine::EngineView< DynamicEngine >.

+ +
+
+ +

◆ getNetworkReactions()

+ +
+
+ + + + + +
+ + + + + + + +
const reaction::ReactionSet & gridfire::engine::AdaptiveEngineView::getNetworkReactions () const
+ 		+overridevirtual
+
+ +

Gets the set of active logical reactions in the network.

+
Returns
Reference to the LogicalReactionSet containing all active reactions.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getNetworkSpecies()

+ +
+
+ + + + + +
+ + + + + + + +
const std::vector< Species > & gridfire::engine::AdaptiveEngineView::getNetworkSpecies () const
+ 		+overridevirtual
+
+ +

Gets the list of active species in the network.

+
Returns
A const reference to the vector of active species.
+ +

Implements gridfire::engine::Engine.

+ +
+
+ +

◆ getScreeningModel()

+ +
+
+ + + + + +
+ + + + + + + +
screening::ScreeningType gridfire::engine::AdaptiveEngineView::getScreeningModel () const
+ 		+overridevirtual
+
+ +

Gets the screening model from the base engine.

+

This method delegates the call to the base engine to get the screening model.

+
Returns
The current screening model type.
+
Usage Example:
AdaptiveEngineView engineView(...);
+
screening::ScreeningType model = engineView.getScreeningModel();
+
gridfire::engine::AdaptiveEngineView
An engine view that dynamically adapts the reaction network based on runtime conditions.
Definition engine_adaptive.h:49
+
gridfire::screening::ScreeningType
ScreeningType
Enumerates the available plasma screening models.
Definition screening_types.h:15
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getSpeciesDestructionTimescales()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
std::expected< std::unordered_map< Species, double >, EngineStatus > gridfire::engine::AdaptiveEngineView::getSpeciesDestructionTimescales (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Computes destruction timescales for all active species in the network.

+
Parameters
+ + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
Map from Species to their destruction timescales (s).
+

This method maps the culled abundances to the full network abundances and calls the base engine to compute the species destruction timescales.

+
Exceptions
+ + +
std::runtime_errorIf the AdaptiveEngineView is stale (i.e., update() has not been called).
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getSpeciesIndex()

+ +
+
+ + + + + +
+ + + + + + + + +
size_t gridfire::engine::AdaptiveEngineView::getSpeciesIndex (const fourdst::atomic::Species & species) const
+ 		+overridevirtual
+
+ +

Gets the index of a species in the active species list.

+
Parameters
+ + +
speciesThe species for which to get the index.
+
+
+
Returns
The index of the species in the active species list.
+
Exceptions
+ + + +
std::runtime_errorIf the AdaptiveEngineView is stale (i.e., update() has not been called).
std::out_of_rangeIf the species is not part of the active species in the adaptive engine view.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getSpeciesStatus()

+ +
+
+ + + + + +
+ + + + + + + + +
SpeciesStatus gridfire::engine::AdaptiveEngineView::getSpeciesStatus (const fourdst::atomic::Species & species) const
+ 		+overridevirtual
+
+ +

Gets the status of a species in the network.

+
Parameters
+ + +
speciesThe species for which to get the status.
+
+
+
Returns
The SpeciesStatus indicating the status of the species.
+

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.

+ +
+
+ +

◆ getSpeciesTimescales()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
std::expected< std::unordered_map< Species, double >, EngineStatus > gridfire::engine::AdaptiveEngineView::getSpeciesTimescales (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Computes timescales for all active species in the network.

+
Parameters
+ + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
Map from Species to their characteristic timescales (s).
+

This method maps the culled abundances to the full network abundances and calls the base engine to compute the species timescales.

+
Exceptions
+ + +
std::runtime_errorIf the AdaptiveEngineView is stale (i.e., update() has not been called).
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getStoichiometryMatrixEntry()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int gridfire::engine::AdaptiveEngineView::getStoichiometryMatrixEntry (const fourdst::atomic::Species & species,
const reaction::Reaction & reaction 
) const
+ 		+overridevirtual
+
+ +

Gets an entry from the stoichiometry matrix for the active species and reactions.

+
Parameters
+ + + +
speciesThe species for which to get the stoichiometric coefficient.
reactionThe reaction for which to get the stoichiometric coefficient.
+
+
+
Returns
The stoichiometric coefficient for the given species and reaction.
+

This method maps the culled indices to the full network indices and calls the base engine to get the stoichiometry matrix entry.

+
Exceptions
+ + + +
std::runtime_errorIf the AdaptiveEngineView is stale (i.e., update() has not been called).
std::out_of_rangeIf the culled index is out of bounds for the species or reaction index map.
+
+
+
See also
AdaptiveEngineView::update()
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ isStale()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::engine::AdaptiveEngineView::isStale (const NetIn & netIn)
+ 		+overridevirtual
+
+ +

Check if the engine's internal state is stale.

+
Parameters
+ + +
netInA struct containing the current network input, such as temperature, density, and composition.
+
+
+
Returns
True if the engine's state is stale and needs to be updated; false otherwise.
+

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.

+
Usage Example:
NetIn input = { ... };
+
if (myEngine.isStale(input)) {
+
// Update the engine before proceeding
+
}
+
gridfire::NetIn
Definition types.h:27
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ mapNetInToMolarAbundanceVector()

+ +
+
+ + + + + +
+ + + + + + + + +
std::vector< double > gridfire::engine::AdaptiveEngineView::mapNetInToMolarAbundanceVector (const NetIn & netIn) const
+ 		+overridevirtual
+
+ +

Maps the molar abundance vector from the active species to the full network species.

+
Parameters
+ + +
netInThe current network input, containing temperature, density, and composition.
+
+
+
Returns
A vector of molar abundances for all species in the full network.
+

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.

+
Exceptions
+ + +
std::runtime_errorIf the AdaptiveEngineView is stale (i.e., update() has not been called).
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ primeEngine()

+ +
+
+ + + + + +
+ + + + + + + + +
PrimingReport gridfire::engine::AdaptiveEngineView::primeEngine (const NetIn & netIn)
+ 		+overridevirtual
+
+ +

Primes the engine with the given network input.

+
Parameters
+ + +
netInThe current network input, containing temperature, density, and composition.
+
+
+
Returns
A PrimingReport indicating the result of the priming operation.
+

This method delegates the priming operation to the base engine.

+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ rescueEdgeSpeciesDestructionChannel()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AdaptiveEngineView::RescueSet gridfire::engine::AdaptiveEngineView::rescueEdgeSpeciesDestructionChannel (const fourdst::composition::Composition & comp,
double T9,
double rho,
const std::vector< fourdst::atomic::Species > & activeSpecies,
const reaction::ReactionSet & activeReactions 
) const
+ 		+private
+
+ +
+
+ +

◆ setNetworkReactions()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::engine::AdaptiveEngineView::setNetworkReactions (const reaction::ReactionSet & reactions)
+ 		+overridevirtual
+
+ +

Sets the reaction set for the base engine.

+

This method delegates the call to the base engine to set the reaction set.

+
Parameters
+ + +
reactionsThe ReactionSet to set in the base engine.
+
+
+
Postcondition
The reaction set of the base engine is updated.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ setScreeningModel()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::engine::AdaptiveEngineView::setScreeningModel (screening::ScreeningType model)
+ 		+overridevirtual
+
+ +

Sets the screening model for the base engine.

+

This method delegates the call to the base engine to set the electron screening model.

+
Parameters
+ + +
modelThe electron screening model to set.
+
+
+
Usage Example:
AdaptiveEngineView engineView(...);
+
engineView.setScreeningModel(screening::ScreeningType::WEAK);
+
gridfire::screening::ScreeningType::WEAK
@ WEAK
Weak screening model (Salpeter, 1954).
+
+
Postcondition
The screening model of the base engine is updated.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ update()

+ +
+
+ + + + + +
+ + + + + + + + +
fourdst::composition::Composition gridfire::engine::AdaptiveEngineView::update (const NetIn & netIn)
+ 		+overridevirtual
+
+ +

Updates the active species and reactions based on the current conditions.

+
Parameters
+ + +
netInThe current network input, containing temperature, density, and composition.
+
+
+

This method performs the reaction flow calculation, reaction culling, connectivity analysis, and index map construction steps described above.

+

The culling thresholds are read from the configuration using the following keys:

    +
  • gridfire:AdaptiveEngineView:RelativeCullingThreshold (default: 1e-75)
    • +
+
Exceptions
+ + +
std::runtime_errorIf there is a mismatch between the active reactions and the base engine.
+
+
+
Postcondition
The active species and reactions are updated, and the index maps are reconstructed.
+
See also
AdaptiveEngineView
+
+AdaptiveEngineView::constructSpeciesIndexMap()
+
+AdaptiveEngineView::constructReactionIndexMap()
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ validateState()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::engine::AdaptiveEngineView::validateState () const
+ 		+private
+
+ +

Validates that the AdaptiveEngineView is not stale.

+
Exceptions
+ + +
std::runtime_errorIf the AdaptiveEngineView is stale (i.e., update() has not been called).
+
+
+ +
+
+

Member Data Documentation

+ +

◆ m_activeReactions

+ +
+
+ + + + + +
+ + + + +
reaction::ReactionSet gridfire::engine::AdaptiveEngineView::m_activeReactions
+ 		+private
+
+ +

The set of reactions that are currently active in the network.

+ +
+
+ +

◆ m_activeSpecies

+ +
+
+ + + + + +
+ + + + +
std::vector<fourdst::atomic::Species> gridfire::engine::AdaptiveEngineView::m_activeSpecies
+ 		+private
+
+ +

The set of species that are currently active in the network.

+ +
+
+ +

◆ m_baseEngine

+ +
+
+ + + + + +
+ + + + +
DynamicEngine& gridfire::engine::AdaptiveEngineView::m_baseEngine
+ 		+private
+
+ +

The underlying engine to which this view delegates calculations.

+ +
+
+ +

◆ m_config

+ +
+
+ + + + + +
+ + + + +
Config& gridfire::engine::AdaptiveEngineView::m_config = Config::getInstance()
+ 		+private
+
+ +

A reference to the singleton Config instance, used for retrieving configuration parameters.

+ +
+
+ +

◆ m_isStale

+ +
+
+ + + + + +
+ + + + +
bool gridfire::engine::AdaptiveEngineView::m_isStale = true
+ 		+private
+
+ +

A flag indicating whether the view is stale and needs to be updated.

+ +
+
+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::engine::AdaptiveEngineView::m_logger = LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +

A pointer to the logger instance, used for logging messages.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView.js b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView.js new file mode 100644 index 00000000..3fd2ceab --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView.js @@ -0,0 +1,43 @@ +var classgridfire_1_1engine_1_1AdaptiveEngineView = +[ + [ "ReactionFlow", "structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow.html", "structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow" ], + [ "Config", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a0a49d174e105adb3ffd9cf98ff58db3e", null ], + [ "LogManager", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#ae8810c067d301b2f620869b0a5c8d5ce", null ], + [ "RescueSet", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a21367fa61169e6f5185bc91b40cc04be", null ], + [ "AdaptiveEngineView", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#aea8914f56e34445aacf0a5d0af073897", null ], + [ "calculateAllReactionFlows", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a6f13f42773dec03a6b3e90b4997d42fb", null ], + [ "calculateEpsDerivatives", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a17bbc9c0d480a8533acb193cb9a46fea", null ], + [ "calculateMolarReactionFlow", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a5bd0174105e836dd98c71ab495357e5b", null ], + [ "calculateRHSAndEnergy", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a5de5211bc99a1995143307284be6df4a", null ], + [ "collectComposition", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a77d4c08eecfad5cc414161d0fc8db946", null ], + [ "cullReactionsByFlow", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a99ffb65b98dcbc1eae8643c25dbffe91", null ], + [ "finalizeActiveSet", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#aab32396ad3ab20960bfd505bb6128ff0", null ], + [ "findReachableSpecies", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a1bc1c462fe57cc30af5553c353e43db8", null ], + [ "generateJacobianMatrix", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a2a44dfae512b370bad6b977330e0636a", null ], + [ "generateJacobianMatrix", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#ae894f46c67a8b8e02b8988a6b73dc9e5", null ], + [ "generateJacobianMatrix", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a1b7b3b0b449d0859d57f99188cdd83d6", null ], + [ "generateStoichiometryMatrix", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a754445722193f11ae534b7c0afa9b8aa", null ], + [ "getBaseEngine", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a69122f748b873b872aa86350061b1b5c", null ], + [ "getNetworkReactions", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a722ea6e07d46f739c29ad681c7500f8c", null ], + [ "getNetworkSpecies", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#aaa2d47f44e5bb4d9660d7c017cc5085c", null ], + [ "getScreeningModel", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#acbd5b36262fa7d40f3274f4be6f0b8f6", null ], + [ "getSpeciesDestructionTimescales", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a420666d17650736e20402514294f9a14", null ], + [ "getSpeciesIndex", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#ad7a82578006e5c55ca7716e7ab7e710c", null ], + [ "getSpeciesStatus", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a5166197fd61060b2a9a445f707ee871b", null ], + [ "getSpeciesTimescales", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#ade5dad29a79209e677b259a9b28c5133", null ], + [ "getStoichiometryMatrixEntry", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#aae6d8bab169721f0b89682ce8c4b4f10", null ], + [ "isStale", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a6c08b4235996d12472d2a327eab8e984", null ], + [ "mapNetInToMolarAbundanceVector", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a24cc7e1a7471d707707b4d44ebd81068", null ], + [ "primeEngine", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a955a337f89a375637ac48071be45c54c", null ], + [ "rescueEdgeSpeciesDestructionChannel", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a85e70c0ff022c31702472aa39fc64816", null ], + [ "setNetworkReactions", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a5dbfcafa606c3242dc4ced62c2494a2d", null ], + [ "setScreeningModel", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#ab050409db954a3fa593633f9d2cd5d89", null ], + [ "update", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a8db6ba52f454c136ee0a1335436fab6e", null ], + [ "validateState", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a63837a6a4343a2ac6a61e21576b62655", null ], + [ "m_activeReactions", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a90a8fa566ca9fe2b74427ea497353e1b", null ], + [ "m_activeSpecies", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a8c7bf0f0e5ad83821e3959c47c81cd60", null ], + [ "m_baseEngine", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a541f54469c3d2d6ab7671b19057b4341", null ], + [ "m_config", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#ac68b44310985613bb5736dd32d415734", null ], + [ "m_isStale", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a8eba901e7c19989a9818ec8cbf1ebb7f", null ], + [ "m_logger", "classgridfire_1_1engine_1_1AdaptiveEngineView.html#a60c4792822f671f094a86378265a416a", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__coll__graph.map b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__coll__graph.map new file mode 100644 index 00000000..21e0d89e --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__coll__graph.map @@ -0,0 +1,31 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__coll__graph.md5 b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__coll__graph.md5 new file mode 100644 index 00000000..5cb6cda4 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__coll__graph.md5 @@ -0,0 +1 @@ +5b53298c1581b27ff90b125b0b3c91ad \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__coll__graph.svg b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__coll__graph.svg new file mode 100644 index 00000000..b6dc143e --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__coll__graph.svg @@ -0,0 +1,378 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::engine::AdaptiveEngineView + + +Node1 + + +gridfire::engine::Adaptive +EngineView + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node2->Node1 + + + + + + m_baseEngine + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node4->Node1 + + + + + + + + +Node5 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node5->Node1 + + + + + + m_activeSpecies + + + +Node6 + + +Species + + + + + +Node6->Node5 + + + + + + elements + + + +Node7 + + +gridfire::reaction +::ReactionSet + + + + + +Node7->Node1 + + + + + + m_activeReactions + + + +Node8 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node8->Node7 + + + + + + m_reactions + + + +Node9 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node9->Node8 + + + + + + elements + + + +Node10 + + +gridfire::reaction +::Reaction + + + + + +Node10->Node9 + + + + + + ptr + + + +Node11 + + +std::string + + + + + +Node11->Node7 + + + + + + m_id + + + +Node13 + + +std::unordered_map +< std::string, size_t > + + + + + +Node11->Node13 + + + + + + keys + + + +Node12 + + +std::basic_string< + Char > + + + + + +Node12->Node11 + + + + + + + + +Node13->Node7 + + + + + + m_reactionNameMap + + + +Node14 + + +std::unordered_set +< size_t > + + + + + +Node14->Node7 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__coll__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__coll__graph_org.svg new file mode 100644 index 00000000..7892f849 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__coll__graph_org.svg @@ -0,0 +1,296 @@ + + + + + + +gridfire::engine::AdaptiveEngineView + + +Node1 + + +gridfire::engine::Adaptive +EngineView + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node2->Node1 + + + + + + m_baseEngine + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node4->Node1 + + + + + + + + +Node5 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node5->Node1 + + + + + + m_activeSpecies + + + +Node6 + + +Species + + + + + +Node6->Node5 + + + + + + elements + + + +Node7 + + +gridfire::reaction +::ReactionSet + + + + + +Node7->Node1 + + + + + + m_activeReactions + + + +Node8 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node8->Node7 + + + + + + m_reactions + + + +Node9 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node9->Node8 + + + + + + elements + + + +Node10 + + +gridfire::reaction +::Reaction + + + + + +Node10->Node9 + + + + + + ptr + + + +Node11 + + +std::string + + + + + +Node11->Node7 + + + + + + m_id + + + +Node13 + + +std::unordered_map +< std::string, size_t > + + + + + +Node11->Node13 + + + + + + keys + + + +Node12 + + +std::basic_string< + Char > + + + + + +Node12->Node11 + + + + + + + + +Node13->Node7 + + + + + + m_reactionNameMap + + + +Node14 + + +std::unordered_set +< size_t > + + + + + +Node14->Node7 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__inherit__graph.map b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__inherit__graph.map new file mode 100644 index 00000000..9f04e176 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__inherit__graph.md5 b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__inherit__graph.md5 new file mode 100644 index 00000000..d5428fd8 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__inherit__graph.md5 @@ -0,0 +1 @@ +b00f8595ad81a68b157c9698d1b3c692 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__inherit__graph.svg b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__inherit__graph.svg new file mode 100644 index 00000000..e21fb067 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__inherit__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +gridfire::engine::AdaptiveEngineView + + +Node1 + + +gridfire::engine::Adaptive +EngineView + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node4->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__inherit__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__inherit__graph_org.svg new file mode 100644 index 00000000..0fe06d0b --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1AdaptiveEngineView__inherit__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +gridfire::engine::AdaptiveEngineView + + +Node1 + + +gridfire::engine::Adaptive +EngineView + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node4->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1DefinedEngineView-members.html b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView-members.html new file mode 100644 index 00000000..3b1ad013 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView-members.html @@ -0,0 +1,154 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::DefinedEngineView Member List
+
+
+ +

This is the complete list of members for gridfire::engine::DefinedEngineView, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
calculateEpsDerivatives(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
calculateMolarReactionFlow(const reaction::Reaction &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
calculateRHSAndEnergy(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
collect(const std::vector< std::string > &peNames)gridfire::engine::DefinedEngineViewprivate
collectComposition(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
constructReactionIndexMap() constgridfire::engine::DefinedEngineViewprivate
constructSpeciesIndexMap() constgridfire::engine::DefinedEngineViewprivate
DefinedEngineView(const std::vector< std::string > &peNames, GraphEngine &baseEngine)gridfire::engine::DefinedEngineView
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies) const overridegridfire::engine::DefinedEngineViewvirtual
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const overridegridfire::engine::DefinedEngineViewvirtual
generateStoichiometryMatrix() overridegridfire::engine::DefinedEngineViewvirtual
getBaseEngine() const overridegridfire::engine::DefinedEngineViewvirtual
getDepth() constgridfire::engine::DynamicEngineinlinevirtual
getNetworkReactions() const overridegridfire::engine::DefinedEngineViewvirtual
getNetworkSpecies() const overridegridfire::engine::DefinedEngineViewvirtual
getScreeningModel() const overridegridfire::engine::DefinedEngineViewvirtual
getSpeciesDestructionTimescales(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
getSpeciesIndex(const fourdst::atomic::Species &species) const overridegridfire::engine::DefinedEngineViewvirtual
getSpeciesStatus(const fourdst::atomic::Species &species) const overridegridfire::engine::DefinedEngineViewvirtual
getSpeciesTimescales(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
getStoichiometryMatrixEntry(const fourdst::atomic::Species &species, const reaction::Reaction &reaction) const overridegridfire::engine::DefinedEngineViewvirtual
isStale(const NetIn &netIn) overridegridfire::engine::DefinedEngineViewvirtual
m_activeReactionsgridfire::engine::DefinedEngineViewprivate
m_activeSpeciesgridfire::engine::DefinedEngineViewprivate
m_activeSpeciesVectorCachegridfire::engine::DefinedEngineViewmutableprivate
m_baseEnginegridfire::engine::DefinedEngineViewprotected
m_isStalegridfire::engine::DefinedEngineViewprotected
m_loggergridfire::engine::DefinedEngineViewprivate
m_reactionIndexMapgridfire::engine::DefinedEngineViewprivate
m_speciesIndexMapgridfire::engine::DefinedEngineViewprivate
mapFullToView(const std::vector< double > &full) constgridfire::engine::DefinedEngineViewprivate
mapNetInToMolarAbundanceVector(const NetIn &netIn) const overridegridfire::engine::DefinedEngineViewvirtual
mapViewToFull(const std::vector< double > &defined) constgridfire::engine::DefinedEngineViewprivate
mapViewToFullReactionIndex(size_t definedReactionIndex) constgridfire::engine::DefinedEngineViewprivate
mapViewToFullSpeciesIndex(size_t definedSpeciesIndex) constgridfire::engine::DefinedEngineViewprivate
primeEngine(const NetIn &netIn) overridegridfire::engine::DefinedEngineViewvirtual
rebuild(const fourdst::composition::CompositionAbstract &comp, BuildDepthType depth)gridfire::engine::DynamicEngineinlinevirtual
setNetworkReactions(const reaction::ReactionSet &reactions) overridegridfire::engine::DefinedEngineViewvirtual
setScreeningModel(screening::ScreeningType model) overridegridfire::engine::DefinedEngineViewvirtual
update(const NetIn &netIn) overridegridfire::engine::DefinedEngineViewvirtual
validateNetworkState() constgridfire::engine::DefinedEngineViewprivate
~Engine()=defaultgridfire::engine::Enginevirtual
~EngineView()=defaultgridfire::engine::EngineView< DynamicEngine >virtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1DefinedEngineView.html b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView.html new file mode 100644 index 00000000..5bc55788 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView.html @@ -0,0 +1,1837 @@ + + + + + + + +GridFire: gridfire::engine::DefinedEngineView Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Protected Attributes | +Private Member Functions | +Private Attributes | +List of all members
+
gridfire::engine::DefinedEngineView Class Reference
+
+
+ +

#include <engine_defined.h>

+
+Inheritance diagram for gridfire::engine::DefinedEngineView:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::engine::DefinedEngineView:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 DefinedEngineView (const std::vector< std::string > &peNames, GraphEngine &baseEngine)
 
const DynamicEngine & getBaseEngine () const override
 Get the base engine associated with this defined engine view.
 
const std::vector< fourdst::atomic::Species > & getNetworkSpecies () const override
 Gets the list of active species in the network defined by the file.
 
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
 Calculate the derivatives of the energy generation rate with respect to T and rho.
 
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 the active species.
 
NetworkJacobian generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const override
 Generates the Jacobian matrix for 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 active reactions in the network.
 
std::expected< std::unordered_map< fourdst::atomic::Species, double >, engine::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 >, engine::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 update (const NetIn &netIn) override
 Updates the engine view if it is marked as stale.
 
bool isStale (const NetIn &netIn) override
 Checks if the engine view is stale.
 
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
 Maps a species from the full network to its index in the defined active network.
 
std::vector< double > mapNetInToMolarAbundanceVector (const NetIn &netIn) const override
 Map from a NetIn object to a vector of molar abundances for the active species.
 
PrimingReport primeEngine (const NetIn &netIn) override
 Prime the engine view for calculations. This will delegate to the base engine.
 
fourdst::composition::Composition collectComposition (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
 Collects a Composition object from the base engine.
 
SpeciesStatus getSpeciesStatus (const fourdst::atomic::Species &species) const override
 Gets the status of a species in the active 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.
 
- Public Member Functions inherited from gridfire::engine::Engine
virtual ~Engine ()=default
 Virtual destructor.
 
- Public Member Functions inherited from gridfire::engine::EngineView< DynamicEngine >
virtual ~EngineView ()=default
 Virtual destructor.
 
+ + + + + +

+Protected Attributes

bool m_isStale = true
 
GraphEngine & m_baseEngine
 
+ + + + + + + + + + + + + + + + + + + + + + + +

+Private Member Functions

std::vector< size_t > constructSpeciesIndexMap () const
 Constructs the species index map.
 
std::vector< size_t > constructReactionIndexMap () const
 Constructs the reaction index map.
 
std::vector< double > mapViewToFull (const std::vector< double > &defined) const
 Maps a vector of culled abundances to a vector of full abundances.
 
std::vector< double > mapFullToView (const std::vector< double > &full) const
 Maps a vector of full abundances to a vector of culled abundances.
 
size_t mapViewToFullSpeciesIndex (size_t definedSpeciesIndex) const
 Maps a culled species index to a full species index.
 
size_t mapViewToFullReactionIndex (size_t definedReactionIndex) const
 Maps a culled reaction index to a full reaction index.
 
void validateNetworkState () const
 
void collect (const std::vector< std::string > &peNames)
 
+ + + + + + + + + + + + + + + + + + +

+Private Attributes

quill::Logger * m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
 Active species in the defined engine.
 
std::set< fourdst::atomic::Species > m_activeSpecies
 Cache for the active species vector to avoid dangling references.
 
std::optional< std::vector< fourdst::atomic::Species > > m_activeSpeciesVectorCache = std::nullopt
 Active reactions in the defined engine.
 
reaction::ReactionSet m_activeReactions
 Maps indices of active species to indices in the full network.
 
std::vector< size_t > m_speciesIndexMap
 Maps indices of active reactions to indices in the full network.
 
std::vector< size_t > m_reactionIndexMap
 
+

Constructor & Destructor Documentation

+ +

◆ DefinedEngineView()

+ +
+
+ + + + + + + + + + + + + + + + + + +
gridfire::engine::DefinedEngineView::DefinedEngineView (const std::vector< std::string > & peNames,
GraphEngine & baseEngine 
)
+
+ +
+
+

Member Function Documentation

+ +

◆ calculateEpsDerivatives()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
EnergyDerivatives gridfire::engine::DefinedEngineView::calculateEpsDerivatives (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Calculate the derivatives of the energy generation rate with respect to T and rho.

+
Parameters
+ + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
EnergyDerivatives containing dEps/dT and dEps/dRho.
+

This method computes the partial derivatives of the specific nuclear energy generation rate with respect to temperature and density for the current state.

+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ calculateMolarReactionFlow()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::engine::DefinedEngineView::calculateMolarReactionFlow (const reaction::Reaction & reaction,
const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Calculates the molar reaction flow for a given reaction in the active network.

+
Parameters
+ + + + + +
reactionThe reaction for which to calculate the flow.
compA Composition object containing the current composition of the system
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
Molar flow rate for the reaction (e.g., mol/g/s).
+
Exceptions
+ + +
std::runtime_errorIf the view is stale or if the reaction is not in the active set.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ calculateRHSAndEnergy()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
std::expected< StepDerivatives< double >, EngineStatus > gridfire::engine::DefinedEngineView::calculateRHSAndEnergy (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Calculates the right-hand side (dY/dt) and energy generation for the active species.

+
Parameters
+ + + + +
compA Composition object containing the current composition of the system
T9The temperature in units of 10^9 K.
rhoThe density in g/cm^3.
+
+
+
Returns
A StepDerivatives struct containing the derivatives of the active species and the nuclear energy generation rate.
+
Exceptions
+ + +
std::runtime_errorIf the view is stale (i.e., update() has not been called after setNetworkFile()).
+
+
+ +

Implements gridfire::engine::Engine.

+ +
+
+ +

◆ collect()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::engine::DefinedEngineView::collect (const std::vector< std::string > & peNames)
+ 		+private
+
+ +
+
+ +

◆ collectComposition()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
fourdst::composition::Composition gridfire::engine::DefinedEngineView::collectComposition (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Collects a Composition object from the base engine.

+
Parameters
+ + + + +
compThe full Composition object.
T9The temperature in units of 10^9 K.
rhoThe density in g/cm^3.
+
+
+
Returns
A composition object representing the state of the engine stack and the current view.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ constructReactionIndexMap()

+ +
+
+ + + + + +
+ + + + + + + +
std::vector< size_t > gridfire::engine::DefinedEngineView::constructReactionIndexMap () const
+ 		+private
+
+ +

Constructs the reaction index map.

+
Returns
A vector mapping defined reaction indices to full reaction indices.
+

This method creates a map from the indices of the active reactions to the indices of the corresponding reactions in the full network.

+
Exceptions
+ + +
std::runtime_errorIf an active reaction is not found in the base engine's reaction list.
+
+
+ +
+
+ +

◆ constructSpeciesIndexMap()

+ +
+
+ + + + + +
+ + + + + + + +
std::vector< size_t > gridfire::engine::DefinedEngineView::constructSpeciesIndexMap () const
+ 		+private
+
+ +

Constructs the species index map.

+
Returns
A vector mapping defined species indices to full species indices.
+

This method creates a map from the indices of the active species to the indices of the corresponding species in the full network.

+
Exceptions
+ + +
std::runtime_errorIf an active species is not found in the base engine's species list.
+
+
+ +
+
+ +

◆ generateJacobianMatrix() [1/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
NetworkJacobian gridfire::engine::DefinedEngineView::generateJacobianMatrix (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Generates the Jacobian matrix for the active species.

+
Parameters
+ + + + +
compA Composition object containing the current composition of the system
T9The temperature in units of 10^9 K.
rhoThe density in g/cm^3.
+
+
+
Exceptions
+ + +
std::runtime_errorIf the view is stale.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ generateJacobianMatrix() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NetworkJacobian gridfire::engine::DefinedEngineView::generateJacobianMatrix (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho,
const SparsityPattern & sparsityPattern 
) const
+ 		+overridevirtual
+
+ +

Generates the Jacobian matrix for a given sparsity pattern.

+
Parameters
+ + + + + +
compA Composition object containing the current composition of the system
T9The temperature in units of 10^9 K.
rhoThe density in g/cm^3.
sparsityPatternThe sparsity pattern to use for the Jacobian matrix.
+
+
+
Exceptions
+ + +
std::runtime_errorIf the view is stale.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ generateJacobianMatrix() [3/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NetworkJacobian gridfire::engine::DefinedEngineView::generateJacobianMatrix (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho,
const std::vector< fourdst::atomic::Species > & activeSpecies 
) const
+ 		+overridevirtual
+
+ +

Generates the Jacobian matrix for the active species.

+
Parameters
+ + + + + +
compA Composition object containing the current composition of the system
T9The temperature in units of 10^9 K.
rhoThe density in g/cm^3.
activeSpeciesThe vector of active species to include in the Jacobian.
+
+
+
Exceptions
+ + +
std::runtime_errorIf the view is stale.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ generateStoichiometryMatrix()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::engine::DefinedEngineView::generateStoichiometryMatrix ()
+ 		+overridevirtual
+
+ +

Generates the stoichiometry matrix for the active reactions and species.

+
Exceptions
+ + +
std::runtime_errorIf the view is stale.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getBaseEngine()

+ +
+
+ + + + + +
+ + + + + + + +
const DynamicEngine & gridfire::engine::DefinedEngineView::getBaseEngine () const
+ 		+overridevirtual
+
+ +

Get the base engine associated with this defined engine view.

+
Returns
A const reference to the base DynamicEngine.
+ +

Implements gridfire::engine::EngineView< DynamicEngine >.

+ +
+
+ +

◆ getNetworkReactions()

+ +
+
+ + + + + +
+ + + + + + + +
const reaction::ReactionSet & gridfire::engine::DefinedEngineView::getNetworkReactions () const
+ 		+overridevirtual
+
+ +

Gets the set of active logical reactions in the network.

+
Returns
Reference to the LogicalReactionSet containing all active reactions.
+
Exceptions
+ + +
std::runtime_errorIf the view is stale.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getNetworkSpecies()

+ +
+
+ + + + + +
+ + + + + + + +
const std::vector< Species > & gridfire::engine::DefinedEngineView::getNetworkSpecies () const
+ 		+overridevirtual
+
+ +

Gets the list of active species in the network defined by the file.

+
Returns
A const reference to the vector of active species.
+ +

Implements gridfire::engine::Engine.

+ +
+
+ +

◆ getScreeningModel()

+ +
+
+ + + + + +
+ + + + + + + +
screening::ScreeningType gridfire::engine::DefinedEngineView::getScreeningModel () const
+ 		+overridevirtual
+
+ +

Gets the screening model from the base engine.

+
Returns
The current screening model type.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getSpeciesDestructionTimescales()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
std::expected< std::unordered_map< Species, double >, EngineStatus > gridfire::engine::DefinedEngineView::getSpeciesDestructionTimescales (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Computes destruction timescales for all active species in the network.

+
Parameters
+ + + + +
compA Composition object containing the current composition of the system
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
Map from Species to their destruction timescales (s).
+
Exceptions
+ + +
std::runtime_errorIf the view is stale.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getSpeciesIndex()

+ +
+
+ + + + + +
+ + + + + + + + +
size_t gridfire::engine::DefinedEngineView::getSpeciesIndex (const fourdst::atomic::Species & species) const
+ 		+overridevirtual
+
+ +

Maps a species from the full network to its index in the defined active network.

+
Parameters
+ + +
speciesThe species to map.
+
+
+
Returns
The index of the species in the active network.
+
Exceptions
+ + +
std::runtime_errorIf the species is not in the active set.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getSpeciesStatus()

+ +
+
+ + + + + +
+ + + + + + + + +
SpeciesStatus gridfire::engine::DefinedEngineView::getSpeciesStatus (const fourdst::atomic::Species & species) const
+ 		+overridevirtual
+
+ +

Gets the status of a species in the active network.

+
Parameters
+ + +
speciesThe species for which to get the status.
+
+
+
Returns
The SpeciesStatus indicating if the species is active, inactive, or not present.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getSpeciesTimescales()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
std::expected< std::unordered_map< Species, double >, EngineStatus > gridfire::engine::DefinedEngineView::getSpeciesTimescales (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Computes timescales for all active species in the network.

+
Parameters
+ + + + +
compA Composition object containing the current composition of the system
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
Map from Species to their characteristic timescales (s).
+
Exceptions
+ + +
std::runtime_errorIf the view is stale.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getStoichiometryMatrixEntry()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int gridfire::engine::DefinedEngineView::getStoichiometryMatrixEntry (const fourdst::atomic::Species & species,
const reaction::Reaction & reaction 
) const
+ 		+overridevirtual
+
+ +

Gets an entry from the stoichiometry matrix for the active species and reactions.

+
Parameters
+ + + +
speciesThe species for which to get the stoichiometric coefficient.
reactionThe reaction for which to get the stoichiometric coefficient.
+
+
+
Returns
The stoichiometric coefficient for the given species and reaction.
+
Exceptions
+ + + +
std::runtime_errorIf the view is stale.
std::out_of_rangeIf an index is out of bounds.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ isStale()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::engine::DefinedEngineView::isStale (const NetIn & netIn)
+ 		+overridevirtual
+
+ +

Checks if the engine view is stale.

+
Parameters
+ + +
netInThe current network input (unused).
+
+
+
Returns
True if the view is stale and needs to be updated; false otherwise.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ mapFullToView()

+ +
+
+ + + + + +
+ + + + + + + + +
std::vector< double > gridfire::engine::DefinedEngineView::mapFullToView (const std::vector< double > & full) const
+ 		+private
+
+ +

Maps a vector of full abundances to a vector of culled abundances.

+
Parameters
+ + +
fullA vector of abundances for the full network.
+
+
+
Returns
A vector of abundances for the active species, with the abundances of the active species copied from the full vector.
+ +
+
+ +

◆ mapNetInToMolarAbundanceVector()

+ +
+
+ + + + + +
+ + + + + + + + +
std::vector< double > gridfire::engine::DefinedEngineView::mapNetInToMolarAbundanceVector (const NetIn & netIn) const
+ 		+overridevirtual
+
+ +

Map from a NetIn object to a vector of molar abundances for the active species.

+
Parameters
+ + +
netInThe NetIn object containing the full network abundances.
+
+
+
Returns
A vector of molar abundances for the active species.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ mapViewToFull()

+ +
+
+ + + + + +
+ + + + + + + + +
std::vector< double > gridfire::engine::DefinedEngineView::mapViewToFull (const std::vector< double > & defined) const
+ 		+private
+
+ +

Maps a vector of culled abundances to a vector of full abundances.

+
Parameters
+ + +
definedA vector of abundances for the active species.
+
+
+
Returns
A vector of abundances for the full network, with the abundances of the active species copied from the defined vector.
+ +
+
+ +

◆ mapViewToFullReactionIndex()

+ +
+
+ + + + + +
+ + + + + + + + +
size_t gridfire::engine::DefinedEngineView::mapViewToFullReactionIndex (size_t definedReactionIndex) const
+ 		+private
+
+ +

Maps a culled reaction index to a full reaction index.

+
Parameters
+ + +
definedReactionIndexThe index of the reaction in the defined reaction list.
+
+
+
Returns
The index of the corresponding reaction in the full network.
+
Exceptions
+ + +
std::out_of_rangeIf the defined index is out of bounds for the reaction index map.
+
+
+ +
+
+ +

◆ mapViewToFullSpeciesIndex()

+ +
+
+ + + + + +
+ + + + + + + + +
size_t gridfire::engine::DefinedEngineView::mapViewToFullSpeciesIndex (size_t definedSpeciesIndex) const
+ 		+private
+
+ +

Maps a culled species index to a full species index.

+
Parameters
+ + +
definedSpeciesIndexThe index of the species in the defined species list.
+
+
+
Returns
The index of the corresponding species in the full network.
+
Exceptions
+ + +
std::out_of_rangeIf the defined index is out of bounds for the species index map.
+
+
+ +
+
+ +

◆ primeEngine()

+ +
+
+ + + + + +
+ + + + + + + + +
PrimingReport gridfire::engine::DefinedEngineView::primeEngine (const NetIn & netIn)
+ 		+overridevirtual
+
+ +

Prime the engine view for calculations. This will delegate to the base engine.

+
Parameters
+ + +
netInThe current network input.
+
+
+
Returns
The PrimingReport from the base engine.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ setNetworkReactions()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::engine::DefinedEngineView::setNetworkReactions (const reaction::ReactionSet & reactions)
+ 		+overridevirtual
+
+ +

Sets the active reactions in the network.

+
Parameters
+ + +
reactionsThe ReactionSet containing the reactions to set as active.
+
+
+
Postcondition
The view is marked as stale and will need to be updated.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ setScreeningModel()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::engine::DefinedEngineView::setScreeningModel (screening::ScreeningType model)
+ 		+overridevirtual
+
+ +

Sets the screening model for the base engine.

+
Parameters
+ + +
modelThe screening model to set.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ update()

+ +
+
+ + + + + +
+ + + + + + + + +
fourdst::composition::Composition gridfire::engine::DefinedEngineView::update (const NetIn & netIn)
+ 		+overridevirtual
+
+ +

Updates the engine view if it is marked as stale.

+

This method checks if the view is stale (e.g., after setNetworkFile was called). If it is, it rebuilds the active network from the currently set file. The netIn parameter is not used by this implementation but is required by the interface.

+
Parameters
+ + +
netInThe current network input (unused).
+
+
+
Postcondition
If the view was stale, it is rebuilt and is no longer stale.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ validateNetworkState()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::engine::DefinedEngineView::validateNetworkState () const
+ 		+private
+
+ +
+
+

Member Data Documentation

+ +

◆ m_activeReactions

+ +
+
+ + + + + +
+ + + + +
reaction::ReactionSet gridfire::engine::DefinedEngineView::m_activeReactions
+ 		+private
+
+ +

Maps indices of active species to indices in the full network.

+ +
+
+ +

◆ m_activeSpecies

+ +
+
+ + + + + +
+ + + + +
std::set<fourdst::atomic::Species> gridfire::engine::DefinedEngineView::m_activeSpecies
+ 		+private
+
+ +

Cache for the active species vector to avoid dangling references.

+ +
+
+ +

◆ m_activeSpeciesVectorCache

+ +
+
+ + + + + +
+ + + + +
std::optional<std::vector<fourdst::atomic::Species> > gridfire::engine::DefinedEngineView::m_activeSpeciesVectorCache = std::nullopt
+ 		+mutableprivate
+
+ +

Active reactions in the defined engine.

+ +
+
+ +

◆ m_baseEngine

+ +
+
+ + + + + +
+ + + + +
GraphEngine& gridfire::engine::DefinedEngineView::m_baseEngine
+ 		+protected
+
+ +
+
+ +

◆ m_isStale

+ +
+
+ + + + + +
+ + + + +
bool gridfire::engine::DefinedEngineView::m_isStale = true
+ 		+protected
+
+ +
+
+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::engine::DefinedEngineView::m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +

Active species in the defined engine.

+

Logger instance for trace and debug information.

+ +
+
+ +

◆ m_reactionIndexMap

+ +
+
+ + + + + +
+ + + + +
std::vector<size_t> gridfire::engine::DefinedEngineView::m_reactionIndexMap
+ 		+private
+
+ +
+
+ +

◆ m_speciesIndexMap

+ +
+
+ + + + + +
+ + + + +
std::vector<size_t> gridfire::engine::DefinedEngineView::m_speciesIndexMap
+ 		+private
+
+ +

Maps indices of active reactions to indices in the full network.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1DefinedEngineView.js b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView.js new file mode 100644 index 00000000..ed3bec41 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView.js @@ -0,0 +1,43 @@ +var classgridfire_1_1engine_1_1DefinedEngineView = +[ + [ "DefinedEngineView", "classgridfire_1_1engine_1_1DefinedEngineView.html#ada2f326789dc8ae8305617c8d700ae05", null ], + [ "calculateEpsDerivatives", "classgridfire_1_1engine_1_1DefinedEngineView.html#a2a866a7ba9572d36efab8efe72a063f5", null ], + [ "calculateMolarReactionFlow", "classgridfire_1_1engine_1_1DefinedEngineView.html#a2f0ad1febc467bce87b5c6ad29b059fb", null ], + [ "calculateRHSAndEnergy", "classgridfire_1_1engine_1_1DefinedEngineView.html#a82cbef591ef1aafcb9a42e01bf38fc38", null ], + [ "collect", "classgridfire_1_1engine_1_1DefinedEngineView.html#a38191e2b3b219d348eba0109dce271c3", null ], + [ "collectComposition", "classgridfire_1_1engine_1_1DefinedEngineView.html#a25dc44af1a58561b665103b16abe9bbc", null ], + [ "constructReactionIndexMap", "classgridfire_1_1engine_1_1DefinedEngineView.html#a8464c50142f34583201c4abc7fbcba36", null ], + [ "constructSpeciesIndexMap", "classgridfire_1_1engine_1_1DefinedEngineView.html#a20b54c8b13616982eddb3ae3979b842d", null ], + [ "generateJacobianMatrix", "classgridfire_1_1engine_1_1DefinedEngineView.html#a4d90439d99da61107d95319b970760bc", null ], + [ "generateJacobianMatrix", "classgridfire_1_1engine_1_1DefinedEngineView.html#a1de5867a0e633de0d0d96ac4fbb141e5", null ], + [ "generateJacobianMatrix", "classgridfire_1_1engine_1_1DefinedEngineView.html#a4966f8cbc859ce2a8a465516d0c0abd0", null ], + [ "generateStoichiometryMatrix", "classgridfire_1_1engine_1_1DefinedEngineView.html#af4049e5570bd143d41cab1d4005b6824", null ], + [ "getBaseEngine", "classgridfire_1_1engine_1_1DefinedEngineView.html#ab6f82ef31b99bfe8a6c4e475bcdb96f8", null ], + [ "getNetworkReactions", "classgridfire_1_1engine_1_1DefinedEngineView.html#a81732c1b2d08451849c1ddf833246892", null ], + [ "getNetworkSpecies", "classgridfire_1_1engine_1_1DefinedEngineView.html#a0af3e1ac0314a485171f1dda39929cb4", null ], + [ "getScreeningModel", "classgridfire_1_1engine_1_1DefinedEngineView.html#a413b111f6a643d7aecbae01dd0f82640", null ], + [ "getSpeciesDestructionTimescales", "classgridfire_1_1engine_1_1DefinedEngineView.html#ab051d976dbecf325747d54efe7834d04", null ], + [ "getSpeciesIndex", "classgridfire_1_1engine_1_1DefinedEngineView.html#afb3c67ce20746b9acb2766920b8f397b", null ], + [ "getSpeciesStatus", "classgridfire_1_1engine_1_1DefinedEngineView.html#a65af092785759559f4697c7e66bef2e3", null ], + [ "getSpeciesTimescales", "classgridfire_1_1engine_1_1DefinedEngineView.html#a1edda1a27247480660cf7a63410f5799", null ], + [ "getStoichiometryMatrixEntry", "classgridfire_1_1engine_1_1DefinedEngineView.html#a600dd38a6011089527024f1625130935", null ], + [ "isStale", "classgridfire_1_1engine_1_1DefinedEngineView.html#a6ef3052fce2d5e4fdaec6659df64c2bc", null ], + [ "mapFullToView", "classgridfire_1_1engine_1_1DefinedEngineView.html#a391bc4b5d946ea606cf7661955191d12", null ], + [ "mapNetInToMolarAbundanceVector", "classgridfire_1_1engine_1_1DefinedEngineView.html#aa053696a7885b8e42562b2d22ee32d84", null ], + [ "mapViewToFull", "classgridfire_1_1engine_1_1DefinedEngineView.html#aa352f3ba0e689d3f81711c17f4f67dfc", null ], + [ "mapViewToFullReactionIndex", "classgridfire_1_1engine_1_1DefinedEngineView.html#afa9aeb6d11645e4b9cecf56fb63b51ef", null ], + [ "mapViewToFullSpeciesIndex", "classgridfire_1_1engine_1_1DefinedEngineView.html#ad6986fa5cda1d9ed9d4f54f444f402e8", null ], + [ "primeEngine", "classgridfire_1_1engine_1_1DefinedEngineView.html#a2bc32a84c9f5372587fca92f2da77595", null ], + [ "setNetworkReactions", "classgridfire_1_1engine_1_1DefinedEngineView.html#ae89529e13f2b7fd2febcfa5af40d4666", null ], + [ "setScreeningModel", "classgridfire_1_1engine_1_1DefinedEngineView.html#a68bd0e51d3e127e5f9fd74fdb8180fd9", null ], + [ "update", "classgridfire_1_1engine_1_1DefinedEngineView.html#a1d99b55bf8e94bc2397715aa1f916733", null ], + [ "validateNetworkState", "classgridfire_1_1engine_1_1DefinedEngineView.html#a91ea88e43c17f99ff0d95a8f54b09cbf", null ], + [ "m_activeReactions", "classgridfire_1_1engine_1_1DefinedEngineView.html#ae8ac4dc44a6c9f3588d6dd02b39a4cc9", null ], + [ "m_activeSpecies", "classgridfire_1_1engine_1_1DefinedEngineView.html#aad986ed7c9602ba042999cf0a30ed70c", null ], + [ "m_activeSpeciesVectorCache", "classgridfire_1_1engine_1_1DefinedEngineView.html#add093054fe3ba60f99b04f7f3bda4ba3", null ], + [ "m_baseEngine", "classgridfire_1_1engine_1_1DefinedEngineView.html#a1e46935f049537e675fb132564d6eacd", null ], + [ "m_isStale", "classgridfire_1_1engine_1_1DefinedEngineView.html#a3156dfef68cd3636f8cf7a13b5388e75", null ], + [ "m_logger", "classgridfire_1_1engine_1_1DefinedEngineView.html#a3ba348cf85f0098071d23b0a3cea7078", null ], + [ "m_reactionIndexMap", "classgridfire_1_1engine_1_1DefinedEngineView.html#aa9a26262300b0982b847a72425dc373a", null ], + [ "m_speciesIndexMap", "classgridfire_1_1engine_1_1DefinedEngineView.html#a26af4be40216ee3ea5b7fff49fe7a00c", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__coll__graph.map b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__coll__graph.map new file mode 100644 index 00000000..f5ca7e05 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__coll__graph.map @@ -0,0 +1,104 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__coll__graph.md5 b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__coll__graph.md5 new file mode 100644 index 00000000..d23e9d7b --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__coll__graph.md5 @@ -0,0 +1 @@ +9643959a1e151e6e59f2a846b53461e8 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__coll__graph.svg b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__coll__graph.svg new file mode 100644 index 00000000..63c3363e --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__coll__graph.svg @@ -0,0 +1,1115 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::engine::DefinedEngineView + + +Node1 + + +gridfire::engine::Defined +EngineView + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node5 + + +gridfire::engine::GraphEngine + + + + + +Node2->Node5 + + + + + + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node4->Node1 + + + + + + + + +Node5->Node1 + + + + + + m_baseEngine + + + +Node34 + + +gridfire::engine::GraphEngine +::AtomicReverseRate + + + + + +Node5->Node34 + + + + + + m_engine + + + +Node6 + + +std::unordered_map +< JacobianMatrixState, + std::string > + + + + + +Node6->Node5 + + + + + + m_jacobianMatrixStateNameMap + + + +Node7 + + +std::string + + + + + +Node7->Node6 + + + + + + elements + + + +Node17 + + +gridfire::reaction +::ReactionSet + + + + + +Node7->Node17 + + + + + + m_id + + + +Node21 + + +std::unordered_map +< std::string, size_t > + + + + + +Node7->Node21 + + + + + + keys + + + +Node8 + + +std::basic_string< + Char > + + + + + +Node8->Node7 + + + + + + + + +Node9 + + +Config + + + + + +Node9->Node5 + + + + + + m_config + + + +Node10 + + +gridfire::engine::GraphEngine +::constants + + + + + +Node10->Node5 + + + + + + m_constants + + + +Node11 + + +gridfire::rates::weak +::WeakRateInterpolator + + + + + +Node11->Node5 + + + + + + m_weakRateInterpolator + + + +Node12 + + +std::unordered_map +< uint32_t, gridfire +::rates::weak::IsotopeGrid > + + + + + +Node12->Node11 + + + + + + m_rate_table + + + +Node13 + + +gridfire::rates::weak +::IsotopeGrid + + + + + +Node13->Node12 + + + + + + elements + + + +Node14 + + +std::vector< double > + + + + + +Node14->Node13 + + + + + + rhoYe_axis +t9_axis + + + +Node15 + + +std::vector< gridfire +::rates::weak::WeakRatePayload > + + + + + +Node15->Node13 + + + + + + data + + + +Node16 + + +gridfire::rates::weak +::WeakRatePayload + + + + + +Node16->Node15 + + + + + + elements + + + +Node17->Node1 + + + + + + m_activeReactions + + + +Node17->Node5 + + + + + + m_reactions + + + +Node18 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node18->Node17 + + + + + + m_reactions + + + +Node19 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node19->Node18 + + + + + + elements + + + +Node20 + + +gridfire::reaction +::Reaction + + + + + +Node20->Node19 + + + + + + ptr + + + +Node23 + + +std::unordered_map +< std::string_view, + gridfire::reaction:: +Reaction * > + + + + + +Node20->Node23 + + + + + + elements + + + +Node20->Node34 + + + + + + m_reaction + + + +Node21->Node17 + + + + + + m_reactionNameMap + + + +Node22 + + +std::unordered_set +< size_t > + + + + + +Node22->Node17 + + + + + + m_reactionHashes + + + +Node23->Node5 + + + + + + m_reactionIDMap + + + +Node24 + + +std::string_view + + + + + +Node24->Node23 + + + + + + keys + + + +Node28 + + +std::unordered_map +< std::string_view, + fourdst::atomic::Species > + + + + + +Node24->Node28 + + + + + + keys + + + +Node25 + + +std::basic_string_view +< Char > + + + + + +Node25->Node24 + + + + + + + + +Node26 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node26->Node5 + + + + + + m_networkSpecies + + + +Node27 + + +Species + + + + + +Node27->Node26 + + + + + + elements + + + +Node27->Node28 + + + + + + elements + + + +Node29 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node27->Node29 + + + + + + keys + + + +Node30 + + +std::unordered_map +< size_t, fourdst::atomic +::Species > + + + + + +Node27->Node30 + + + + + + elements + + + +Node45 + + +std::set< fourdst:: +atomic::Species > + + + + + +Node27->Node45 + + + + + + keys + + + +Node28->Node5 + + + + + + m_networkSpeciesMap + + + +Node29->Node5 + + + + + + m_speciesToIndexMap + + + +Node30->Node5 + + + + + + m_indexToSpeciesMap + + + +Node31 + + +std::set< std::pair +< size_t, size_t > > + + + + + +Node31->Node5 + + + + + + m_full_sparsity_set + + + +Node32 + + +std::vector< std::unique +_ptr< gridfire::engine +::GraphEngine::AtomicReverseRate > > + + + + + +Node32->Node5 + + + + + + m_atomicReverseRates + + + +Node33 + + +std::unique_ptr< gridfire +::engine::GraphEngine:: +AtomicReverseRate > + + + + + +Node33->Node32 + + + + + + elements + + + +Node34->Node33 + + + + + + ptr + + + +Node35 + + +CppAD::atomic_base +< double > + + + + + +Node35->Node34 + + + + + + + + +Node36 + + +std::unique_ptr< gridfire +::screening::ScreeningModel > + + + + + +Node36->Node5 + + + + + + m_screeningModel + + + +Node37 + + +gridfire::screening +::ScreeningModel + + + + + +Node37->Node36 + + + + + + ptr + + + +Node38 + + +std::vector< gridfire +::engine::GraphEngine +::PrecomputedReaction > + + + + + +Node38->Node5 + + + + + + m_precomputedReactions + + + +Node39 + + +gridfire::engine::GraphEngine +::PrecomputedReaction + + + + + +Node39->Node38 + + + + + + elements + + + +Node40 + + +std::vector< size_t > + + + + + +Node40->Node1 + + + + + + m_reactionIndexMap +m_speciesIndexMap + + + +Node40->Node39 + + + + + + affected_species_indices +unique_product_indices +unique_reactant_indices + + + +Node41 + + +std::vector< int > + + + + + +Node41->Node39 + + + + + + product_powers +reactant_powers +stoichiometric_coefficients + + + +Node42 + + +std::unordered_map +< uint64_t, size_t > + + + + + +Node42->Node5 + + + + + + m_precomputedReactionIndexMap + + + +Node43 + + +std::unique_ptr< gridfire +::partition::PartitionFunction > + + + + + +Node43->Node5 + + + + + + m_partitionFunction + + + +Node44 + + +gridfire::partition +::PartitionFunction + + + + + +Node44->Node43 + + + + + + ptr + + + +Node45->Node1 + + + + + + m_activeSpecies + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__coll__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__coll__graph_org.svg new file mode 100644 index 00000000..c0e242a2 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__coll__graph_org.svg @@ -0,0 +1,1033 @@ + + + + + + +gridfire::engine::DefinedEngineView + + +Node1 + + +gridfire::engine::Defined +EngineView + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node5 + + +gridfire::engine::GraphEngine + + + + + +Node2->Node5 + + + + + + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node4->Node1 + + + + + + + + +Node5->Node1 + + + + + + m_baseEngine + + + +Node34 + + +gridfire::engine::GraphEngine +::AtomicReverseRate + + + + + +Node5->Node34 + + + + + + m_engine + + + +Node6 + + +std::unordered_map +< JacobianMatrixState, + std::string > + + + + + +Node6->Node5 + + + + + + m_jacobianMatrixStateNameMap + + + +Node7 + + +std::string + + + + + +Node7->Node6 + + + + + + elements + + + +Node17 + + +gridfire::reaction +::ReactionSet + + + + + +Node7->Node17 + + + + + + m_id + + + +Node21 + + +std::unordered_map +< std::string, size_t > + + + + + +Node7->Node21 + + + + + + keys + + + +Node8 + + +std::basic_string< + Char > + + + + + +Node8->Node7 + + + + + + + + +Node9 + + +Config + + + + + +Node9->Node5 + + + + + + m_config + + + +Node10 + + +gridfire::engine::GraphEngine +::constants + + + + + +Node10->Node5 + + + + + + m_constants + + + +Node11 + + +gridfire::rates::weak +::WeakRateInterpolator + + + + + +Node11->Node5 + + + + + + m_weakRateInterpolator + + + +Node12 + + +std::unordered_map +< uint32_t, gridfire +::rates::weak::IsotopeGrid > + + + + + +Node12->Node11 + + + + + + m_rate_table + + + +Node13 + + +gridfire::rates::weak +::IsotopeGrid + + + + + +Node13->Node12 + + + + + + elements + + + +Node14 + + +std::vector< double > + + + + + +Node14->Node13 + + + + + + rhoYe_axis +t9_axis + + + +Node15 + + +std::vector< gridfire +::rates::weak::WeakRatePayload > + + + + + +Node15->Node13 + + + + + + data + + + +Node16 + + +gridfire::rates::weak +::WeakRatePayload + + + + + +Node16->Node15 + + + + + + elements + + + +Node17->Node1 + + + + + + m_activeReactions + + + +Node17->Node5 + + + + + + m_reactions + + + +Node18 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node18->Node17 + + + + + + m_reactions + + + +Node19 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node19->Node18 + + + + + + elements + + + +Node20 + + +gridfire::reaction +::Reaction + + + + + +Node20->Node19 + + + + + + ptr + + + +Node23 + + +std::unordered_map +< std::string_view, + gridfire::reaction:: +Reaction * > + + + + + +Node20->Node23 + + + + + + elements + + + +Node20->Node34 + + + + + + m_reaction + + + +Node21->Node17 + + + + + + m_reactionNameMap + + + +Node22 + + +std::unordered_set +< size_t > + + + + + +Node22->Node17 + + + + + + m_reactionHashes + + + +Node23->Node5 + + + + + + m_reactionIDMap + + + +Node24 + + +std::string_view + + + + + +Node24->Node23 + + + + + + keys + + + +Node28 + + +std::unordered_map +< std::string_view, + fourdst::atomic::Species > + + + + + +Node24->Node28 + + + + + + keys + + + +Node25 + + +std::basic_string_view +< Char > + + + + + +Node25->Node24 + + + + + + + + +Node26 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node26->Node5 + + + + + + m_networkSpecies + + + +Node27 + + +Species + + + + + +Node27->Node26 + + + + + + elements + + + +Node27->Node28 + + + + + + elements + + + +Node29 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node27->Node29 + + + + + + keys + + + +Node30 + + +std::unordered_map +< size_t, fourdst::atomic +::Species > + + + + + +Node27->Node30 + + + + + + elements + + + +Node45 + + +std::set< fourdst:: +atomic::Species > + + + + + +Node27->Node45 + + + + + + keys + + + +Node28->Node5 + + + + + + m_networkSpeciesMap + + + +Node29->Node5 + + + + + + m_speciesToIndexMap + + + +Node30->Node5 + + + + + + m_indexToSpeciesMap + + + +Node31 + + +std::set< std::pair +< size_t, size_t > > + + + + + +Node31->Node5 + + + + + + m_full_sparsity_set + + + +Node32 + + +std::vector< std::unique +_ptr< gridfire::engine +::GraphEngine::AtomicReverseRate > > + + + + + +Node32->Node5 + + + + + + m_atomicReverseRates + + + +Node33 + + +std::unique_ptr< gridfire +::engine::GraphEngine:: +AtomicReverseRate > + + + + + +Node33->Node32 + + + + + + elements + + + +Node34->Node33 + + + + + + ptr + + + +Node35 + + +CppAD::atomic_base +< double > + + + + + +Node35->Node34 + + + + + + + + +Node36 + + +std::unique_ptr< gridfire +::screening::ScreeningModel > + + + + + +Node36->Node5 + + + + + + m_screeningModel + + + +Node37 + + +gridfire::screening +::ScreeningModel + + + + + +Node37->Node36 + + + + + + ptr + + + +Node38 + + +std::vector< gridfire +::engine::GraphEngine +::PrecomputedReaction > + + + + + +Node38->Node5 + + + + + + m_precomputedReactions + + + +Node39 + + +gridfire::engine::GraphEngine +::PrecomputedReaction + + + + + +Node39->Node38 + + + + + + elements + + + +Node40 + + +std::vector< size_t > + + + + + +Node40->Node1 + + + + + + m_reactionIndexMap +m_speciesIndexMap + + + +Node40->Node39 + + + + + + affected_species_indices +unique_product_indices +unique_reactant_indices + + + +Node41 + + +std::vector< int > + + + + + +Node41->Node39 + + + + + + product_powers +reactant_powers +stoichiometric_coefficients + + + +Node42 + + +std::unordered_map +< uint64_t, size_t > + + + + + +Node42->Node5 + + + + + + m_precomputedReactionIndexMap + + + +Node43 + + +std::unique_ptr< gridfire +::partition::PartitionFunction > + + + + + +Node43->Node5 + + + + + + m_partitionFunction + + + +Node44 + + +gridfire::partition +::PartitionFunction + + + + + +Node44->Node43 + + + + + + ptr + + + +Node45->Node1 + + + + + + m_activeSpecies + + + diff --git a/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__inherit__graph.map b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__inherit__graph.map new file mode 100644 index 00000000..327d52ed --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__inherit__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__inherit__graph.md5 b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__inherit__graph.md5 new file mode 100644 index 00000000..8ff98f32 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__inherit__graph.md5 @@ -0,0 +1 @@ +deb5438377838761c25ddf2cad3640db \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__inherit__graph.svg b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__inherit__graph.svg new file mode 100644 index 00000000..1a7359f7 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__inherit__graph.svg @@ -0,0 +1,198 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::engine::DefinedEngineView + + +Node1 + + +gridfire::engine::Defined +EngineView + + + + + +Node5 + + +gridfire::engine::FileDefined +EngineView + + + + + +Node1->Node5 + + + + + + + + +Node6 + + +gridfire::engine::Network +PrimingEngineView + + + + + +Node1->Node6 + + + + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node4->Node1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__inherit__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__inherit__graph_org.svg new file mode 100644 index 00000000..b6214a3d --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DefinedEngineView__inherit__graph_org.svg @@ -0,0 +1,116 @@ + + + + + + +gridfire::engine::DefinedEngineView + + +Node1 + + +gridfire::engine::Defined +EngineView + + + + + +Node5 + + +gridfire::engine::FileDefined +EngineView + + + + + +Node1->Node5 + + + + + + + + +Node6 + + +gridfire::engine::Network +PrimingEngineView + + + + + +Node1->Node6 + + + + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node4->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1DynamicEngine-members.html b/docs/html/classgridfire_1_1engine_1_1DynamicEngine-members.html new file mode 100644 index 00000000..ec4975ee --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DynamicEngine-members.html @@ -0,0 +1,135 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::DynamicEngine Member List
+
+
+ +

This is the complete list of members for gridfire::engine::DynamicEngine, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
calculateEpsDerivatives(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const =0gridfire::engine::DynamicEnginepure virtual
calculateMolarReactionFlow(const reaction::Reaction &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const =0gridfire::engine::DynamicEnginepure virtual
calculateRHSAndEnergy(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const =0gridfire::engine::Enginepure virtual
collectComposition(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const =0gridfire::engine::DynamicEnginepure virtual
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const =0gridfire::engine::DynamicEnginepure virtual
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies) const =0gridfire::engine::DynamicEnginepure virtual
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const =0gridfire::engine::DynamicEnginepure virtual
generateStoichiometryMatrix()=0gridfire::engine::DynamicEnginepure virtual
getDepth() constgridfire::engine::DynamicEngineinlinevirtual
getNetworkReactions() const =0gridfire::engine::DynamicEnginepure virtual
getNetworkSpecies() const =0gridfire::engine::Enginepure virtual
getScreeningModel() const =0gridfire::engine::DynamicEnginepure virtual
getSpeciesDestructionTimescales(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const =0gridfire::engine::DynamicEnginepure virtual
getSpeciesIndex(const fourdst::atomic::Species &species) const =0gridfire::engine::DynamicEnginepure virtual
getSpeciesStatus(const fourdst::atomic::Species &species) const =0gridfire::engine::DynamicEnginepure virtual
getSpeciesTimescales(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const =0gridfire::engine::DynamicEnginepure virtual
getStoichiometryMatrixEntry(const fourdst::atomic::Species &species, const reaction::Reaction &reaction) const =0gridfire::engine::DynamicEnginepure virtual
isStale(const NetIn &netIn)=0gridfire::engine::DynamicEnginepure virtual
mapNetInToMolarAbundanceVector(const NetIn &netIn) const =0gridfire::engine::DynamicEnginepure virtual
primeEngine(const NetIn &netIn)=0gridfire::engine::DynamicEnginepure virtual
rebuild(const fourdst::composition::CompositionAbstract &comp, BuildDepthType depth)gridfire::engine::DynamicEngineinlinevirtual
setNetworkReactions(const reaction::ReactionSet &reactions)=0gridfire::engine::DynamicEnginepure virtual
setScreeningModel(screening::ScreeningType model)=0gridfire::engine::DynamicEnginepure virtual
update(const NetIn &netIn)=0gridfire::engine::DynamicEnginepure virtual
~Engine()=defaultgridfire::engine::Enginevirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1DynamicEngine.html b/docs/html/classgridfire_1_1engine_1_1DynamicEngine.html new file mode 100644 index 00000000..a95166e8 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DynamicEngine.html @@ -0,0 +1,1224 @@ + + + + + + + +GridFire: gridfire::engine::DynamicEngine Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::engine::DynamicEngine Class Referenceabstract
+
+
+ +

Abstract class for engines supporting Jacobian and stoichiometry operations. + More...

+ +

#include <engine_abstract.h>

+
+Inheritance diagram for gridfire::engine::DynamicEngine:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::engine::DynamicEngine:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

virtual NetworkJacobian generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const =0
 Generate the Jacobian matrix for the current state.
 
virtual NetworkJacobian generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies) const =0
 Generate the Jacobian matrix for the current state using a subset of active species.
 
virtual NetworkJacobian generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const =0
 Generate the Jacobian matrix for the current state with a specified sparsity pattern.
 
virtual void generateStoichiometryMatrix ()=0
 Generate the stoichiometry matrix for the network.
 
virtual int getStoichiometryMatrixEntry (const fourdst::atomic::Species &species, const reaction::Reaction &reaction) const =0
 Get an entry from the stoichiometry matrix.
 
virtual double calculateMolarReactionFlow (const reaction::Reaction &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const =0
 Calculate the molar reaction flow for a given reaction.
 
virtual EnergyDerivatives calculateEpsDerivatives (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const =0
 Calculate the derivatives of the energy generation rate with respect to T and rho.
 
virtual const reaction::ReactionSet & getNetworkReactions () const =0
 Get the set of logical reactions in the network.
 
virtual void setNetworkReactions (const reaction::ReactionSet &reactions)=0
 Set the reactions for the network.
 
virtual std::expected< std::unordered_map< fourdst::atomic::Species, double >, EngineStatus > getSpeciesTimescales (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const =0
 Compute timescales for all species in the network.
 
virtual std::expected< std::unordered_map< fourdst::atomic::Species, double >, EngineStatus > getSpeciesDestructionTimescales (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const =0
 Compute destruction timescales for all species in the network.
 
virtual fourdst::composition::Composition update (const NetIn &netIn)=0
 Update the internal state of the engine.
 
virtual bool isStale (const NetIn &netIn)=0
 Check if the engine's internal state is stale.
 
virtual void setScreeningModel (screening::ScreeningType model)=0
 Set the electron screening model.
 
virtual screening::ScreeningType getScreeningModel () const =0
 Get the current electron screening model.
 
virtual size_t getSpeciesIndex (const fourdst::atomic::Species &species) const =0
 Get the index of a species in the network.
 
virtual std::vector< double > mapNetInToMolarAbundanceVector (const NetIn &netIn) const =0
 Map a NetIn object to a vector of molar abundances.
 
virtual PrimingReport primeEngine (const NetIn &netIn)=0
 Prime the engine with initial conditions.
 
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.
 
virtual fourdst::composition::Composition collectComposition (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const =0
 Recursively collect composition from current engine and any sub engines if they exist.
 
virtual SpeciesStatus getSpeciesStatus (const fourdst::atomic::Species &species) const =0
 Get the status of a species in the network.
 
- Public Member Functions inherited from gridfire::engine::Engine
virtual ~Engine ()=default
 Virtual destructor.
 
virtual const std::vector< fourdst::atomic::Species > & getNetworkSpecies () const =0
 Get the list of species in the network.
 
virtual std::expected< StepDerivatives< double >, EngineStatus > calculateRHSAndEnergy (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const =0
 Calculate the right-hand side (dY/dt) and energy generation.
 
+

Detailed Description

+

Abstract class for engines supporting Jacobian and stoichiometry operations.

+

Extends Engine with additional methods for:

    +
  • Generating and accessing the Jacobian matrix (for implicit solvers).
    • +
  • Generating and accessing the stoichiometry matrix.
    • +
  • Calculating molar reaction flows for individual reactions.
    • +
  • Accessing the set of logical reactions in the network.
    • +
  • Computing timescales for each species.
    • +
+

Intended usage: Derive from this class to implement engines that support advanced solver features such as implicit integration, sensitivity analysis, QSE (Quasi-Steady-State Equilibrium) handling, and more. Generally this will be the main engine type

+

Member Function Documentation

+ +

◆ calculateEpsDerivatives()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual EnergyDerivatives gridfire::engine::DynamicEngine::calculateEpsDerivatives (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+pure virtual
+
+ +

Calculate the derivatives of the energy generation rate with respect to T and rho.

+
Parameters
+ + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
EnergyDerivatives containing dEps/dT and dEps/dRho.
+

This method computes the partial derivatives of the specific nuclear energy generation rate with respect to temperature and density for the current state.

+ +

Implemented in gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, gridfire::engine::MultiscalePartitioningEngineView, and PyDynamicEngine.

+ +
+
+ +

◆ calculateMolarReactionFlow()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual double gridfire::engine::DynamicEngine::calculateMolarReactionFlow (const reaction::Reaction & reaction,
const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+pure virtual
+
+ +

Calculate the molar reaction flow for a given reaction.

+
Parameters
+ + + + + +
reactionThe reaction for which to calculate the flow.
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
Molar flow rate for the reaction (e.g., mol/g/s).
+

This method computes the net rate at which the given reaction proceeds under the current state.

+ +

Implemented in PyDynamicEngine, gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, and gridfire::engine::MultiscalePartitioningEngineView.

+ +
+
+ +

◆ collectComposition()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual fourdst::composition::Composition gridfire::engine::DynamicEngine::collectComposition (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+pure virtual
+
+ +

Recursively collect composition from current engine and any sub engines if they exist.

+

If species i is defined in comp and in any sub engine or self composition then the molar abundance of species i in the returned composition will be that defined in comp. If there are species defined in sub engine compositions which are not defined in comp then their molar abundances will be based on the reported values from each sub engine.

Note
It is up to each engine to decide how to handle filling in the return composition.
+
+These methods return an unfinalized composition which must then be finalized by the caller
+
Parameters
+ + + + +
compInput composition to "normalize".
T9
rho
+
+
+
Returns
An updated composition which is a superset of comp. This may contain species which were culled, for example, by either QSE partitioning or reaction flow rate culling
+ +

Implemented in gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, gridfire::engine::MultiscalePartitioningEngineView, and PyDynamicEngine.

+ +
+
+ +

◆ generateJacobianMatrix() [1/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual NetworkJacobian gridfire::engine::DynamicEngine::generateJacobianMatrix (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+pure virtual
+
+ +

Generate the Jacobian matrix for the current state.

+
Parameters
+ + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+

This method must compute and store the Jacobian matrix (∂(dY/dt)_i/∂Y_j) for the current state. The matrix can then be accessed via getJacobianMatrixEntry().

+ +

Implemented in gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, gridfire::engine::MultiscalePartitioningEngineView, and PyDynamicEngine.

+ +
+
+ +

◆ generateJacobianMatrix() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual NetworkJacobian gridfire::engine::DynamicEngine::generateJacobianMatrix (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho,
const SparsityPattern & sparsityPattern 
) const
+ 		+pure virtual
+
+ +

Generate the Jacobian matrix for the current state with a specified sparsity pattern.

+
Parameters
+ + + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
sparsityPatternThe sparsity pattern to use for the Jacobian matrix.
+
+
+

This method must compute and store the Jacobian matrix (∂(dY/dt)_i/∂Y_j) for the current state using automatic differentiation, taking into account the provided sparsity pattern. The matrix can then be accessed via getJacobianMatrixEntry().

+
See also
getJacobianMatrixEntry()
+ +

Implemented in PyDynamicEngine, gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, and gridfire::engine::MultiscalePartitioningEngineView.

+ +
+
+ +

◆ generateJacobianMatrix() [3/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual NetworkJacobian gridfire::engine::DynamicEngine::generateJacobianMatrix (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho,
const std::vector< fourdst::atomic::Species > & activeSpecies 
) const
+ 		+pure virtual
+
+ +

Generate the Jacobian matrix for the current state using a subset of active species.

+
Parameters
+ + + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
activeSpeciesThe set of species to include in the Jacobian calculation.
+
+
+

This method must compute and store the Jacobian matrix (∂(dY/dt)_i/∂Y_j) for the current state, considering only the specified subset of active species. The matrix can then be accessed via getJacobianMatrixEntry().

+ +

Implemented in gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, gridfire::engine::MultiscalePartitioningEngineView, and PyDynamicEngine.

+ +
+
+ +

◆ generateStoichiometryMatrix()

+ +
+
+ + + + + +
+ + + + + + + +
virtual void gridfire::engine::DynamicEngine::generateStoichiometryMatrix ()
+ 		+pure virtual
+
+ +

Generate the stoichiometry matrix for the network.

+

This method must compute and store the stoichiometry matrix, which encodes the net change of each species in each reaction.

+ +

Implemented in gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, gridfire::engine::MultiscalePartitioningEngineView, and PyDynamicEngine.

+ +
+
+ +

◆ getDepth()

+ +
+
+ + + + + +
+ + + + + + + +
virtual BuildDepthType gridfire::engine::DynamicEngine::getDepth () const
+ 		+inlinevirtual
+
+ +

Get the depth of the network.

+
Returns
The depth of the network, which may indicate the level of detail or complexity in the reaction network.
+

This method is intended to provide information about the network's structure, such as how many layers of reactions or species are present. It can be useful for diagnostics and understanding the network's complexity.

+ +

Reimplemented in gridfire::engine::GraphEngine, and PyDynamicEngine.

+ +
+
+ +

◆ getNetworkReactions()

+ +
+
+ + + + + +
+ + + + + + + +
virtual const reaction::ReactionSet & gridfire::engine::DynamicEngine::getNetworkReactions () const
+ 		+pure virtual
+
+ +

Get the set of logical reactions in the network.

+
Returns
Reference to the LogicalReactionSet containing all reactions.
+ +

Implemented in gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, gridfire::engine::MultiscalePartitioningEngineView, and PyDynamicEngine.

+ +
+
+ +

◆ getScreeningModel()

+ +
+
+ + + + + +
+ + + + + + + +
virtual screening::ScreeningType gridfire::engine::DynamicEngine::getScreeningModel () const
+ 		+pure virtual
+
+ +

Get the current electron screening model.

+
Returns
The currently active screening model type.
+
Usage Example:
screening::ScreeningType currentModel = myEngine.getScreeningModel();
+
gridfire::screening::ScreeningType
ScreeningType
Enumerates the available plasma screening models.
Definition screening_types.h:15
+
+ +

Implemented in gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, gridfire::engine::MultiscalePartitioningEngineView, and PyDynamicEngine.

+ +
+
+ +

◆ getSpeciesDestructionTimescales()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual std::expected< std::unordered_map< fourdst::atomic::Species, double >, EngineStatus > gridfire::engine::DynamicEngine::getSpeciesDestructionTimescales (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+pure virtual
+
+ +

Compute destruction timescales for all species in the network.

+
Parameters
+ + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
Map from Species to their destruction timescales (s).
+

This method estimates the destruction timescale for each species, which can be useful for understanding reaction flows and equilibrium states.

+ +

Implemented in gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, gridfire::engine::MultiscalePartitioningEngineView, and PyDynamicEngine.

+ +
+
+ +

◆ getSpeciesIndex()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual size_t gridfire::engine::DynamicEngine::getSpeciesIndex (const fourdst::atomic::Species & species) const
+ 		+pure virtual
+
+ +

Get the index of a species in the network.

+
Parameters
+ + +
speciesThe species to look up.
+
+
+

This method allows querying the index of a specific species in the engine's internal representation. It is useful for accessing species data efficiently.

+ +

Implemented in gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, gridfire::engine::MultiscalePartitioningEngineView, and PyDynamicEngine.

+ +
+
+ +

◆ getSpeciesStatus()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual SpeciesStatus gridfire::engine::DynamicEngine::getSpeciesStatus (const fourdst::atomic::Species & species) const
+ 		+pure virtual
+
+ +

Get the status of a species in the network.

+
Parameters
+ + +
speciesThe species to check.
+
+
+
Returns
SpeciesStatus indicating whether the species is active, inactive, or culled.
+

This method allows querying the current status of a specific species within the engine's network.

+ +

Implemented in gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, gridfire::engine::MultiscalePartitioningEngineView, and PyDynamicEngine.

+ +
+
+ +

◆ getSpeciesTimescales()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual std::expected< std::unordered_map< fourdst::atomic::Species, double >, EngineStatus > gridfire::engine::DynamicEngine::getSpeciesTimescales (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+pure virtual
+
+ +

Compute timescales for all species in the network.

+
Parameters
+ + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
Map from Species to their characteristic timescales (s).
+

This method estimates the timescale for abundance change of each species, which can be used for timestep control, diagnostics, and reaction network culling.

+ +

Implemented in gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, gridfire::engine::MultiscalePartitioningEngineView, and PyDynamicEngine.

+ +
+
+ +

◆ getStoichiometryMatrixEntry()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual int gridfire::engine::DynamicEngine::getStoichiometryMatrixEntry (const fourdst::atomic::Species & species,
const reaction::Reaction & reaction 
) const
+ 		+pure virtual
+
+ +

Get an entry from the stoichiometry matrix.

+
Parameters
+ + + +
speciesspecies to look up stoichiometry for.
reactionreaction to find
+
+
+
Returns
Stoichiometric coefficient for the species in the reaction.
+

The stoichiometry matrix must have been generated by generateStoichiometryMatrix().

+ +

Implemented in PyDynamicEngine, gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, and gridfire::engine::MultiscalePartitioningEngineView.

+ +
+
+ +

◆ isStale()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual bool gridfire::engine::DynamicEngine::isStale (const NetIn & netIn)
+ 		+pure virtual
+
+ +

Check if the engine's internal state is stale.

+
Parameters
+ + +
netInA struct containing the current network input, such as temperature, density, and composition.
+
+
+
Returns
True if the engine's state is stale and needs to be updated; false otherwise.
+

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.

+
Usage Example:
NetIn input = { ... };
+
if (myEngine.isStale(input)) {
+
// Update the engine before proceeding
+
}
+
gridfire::NetIn
Definition types.h:27
+
+ +

Implemented in PyDynamicEngine, gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, and gridfire::engine::MultiscalePartitioningEngineView.

+ +
+
+ +

◆ mapNetInToMolarAbundanceVector()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual std::vector< double > gridfire::engine::DynamicEngine::mapNetInToMolarAbundanceVector (const NetIn & netIn) const
+ 		+pure virtual
+
+ +

Map a NetIn object to a vector of molar abundances.

+
Parameters
+ + +
netInThe input conditions for the network.
+
+
+
Returns
A vector of molar abundances corresponding to the species in the network.
+

This method converts the input conditions into a vector of molar abundances, which can be used for further calculations or diagnostics.

+ +

Implemented in PyDynamicEngine, gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, and gridfire::engine::MultiscalePartitioningEngineView.

+ +
+
+ +

◆ primeEngine()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual PrimingReport gridfire::engine::DynamicEngine::primeEngine (const NetIn & netIn)
+ 		+pure virtual
+
+ +

Prime the engine with initial conditions.

+
Parameters
+ + +
netInThe input conditions for the network.
+
+
+
Returns
PrimingReport containing information about the priming process.
+

This method is used to prepare the engine for calculations by setting up initial conditions, reactions, and species. It may involve compiling reaction rates, initializing internal data structures, and performing any necessary pre-computation.

+ +

Implemented in PyDynamicEngine, gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, and gridfire::engine::MultiscalePartitioningEngineView.

+ +
+
+ +

◆ rebuild()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual void gridfire::engine::DynamicEngine::rebuild (const fourdst::composition::CompositionAbstract & comp,
BuildDepthType depth 
)
+ 		+inlinevirtual
+
+ +

Rebuild the network with a specified depth.

+
Parameters
+ + + +
compThe composition to rebuild the network with.
depthThe desired depth of the network.
+
+
+

This method is intended to allow dynamic adjustment of the network's depth, which may involve adding or removing species and reactions based on the specified depth. However, not all engines support this operation.

+ +

Reimplemented in gridfire::engine::GraphEngine, and PyDynamicEngine.

+ +
+
+ +

◆ setNetworkReactions()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual void gridfire::engine::DynamicEngine::setNetworkReactions (const reaction::ReactionSet & reactions)
+ 		+pure virtual
+
+ +

Set the reactions for the network.

+
Parameters
+ + +
reactionsThe set of reactions to use in the network.
+
+
+

This method replaces the current set of reactions in the network with the provided set. It marks the engine as stale, requiring regeneration of matrices and recalculation of rates.

+ +

Implemented in PyDynamicEngine, gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, and gridfire::engine::MultiscalePartitioningEngineView.

+ +
+
+ +

◆ setScreeningModel()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual void gridfire::engine::DynamicEngine::setScreeningModel (screening::ScreeningType model)
+ 		+pure virtual
+
+ +

Set the electron screening model.

+
Parameters
+ + +
modelThe type of screening model to use for reaction rate calculations.
+
+
+

This method allows changing the screening model at runtime. Screening corrections account for the electrostatic shielding of nuclei by electrons, which affects reaction rates in dense stellar plasmas.

+
Usage Example:
myEngine.setScreeningModel(screening::ScreeningType::WEAK);
+
gridfire::screening::ScreeningType::WEAK
@ WEAK
Weak screening model (Salpeter, 1954).
+
+
Postcondition
The engine will use the specified screening model for subsequent rate calculations.
+ +

Implemented in PyDynamicEngine, gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, and gridfire::engine::MultiscalePartitioningEngineView.

+ +
+
+ +

◆ update()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual fourdst::composition::Composition gridfire::engine::DynamicEngine::update (const NetIn & netIn)
+ 		+pure virtual
+
+ +

Update the internal state of the engine.

+
Parameters
+ + +
netInA struct containing the current network input, such as temperature, density, and composition.
+
+
+

This method is intended to be implemented by derived classes to update their internal state based on the provided network conditions. For example, an adaptive engine might use this to re-evaluate which reactions and species are active. For other engines that do not support manually updating, this method might do nothing.

+
Usage Example:
NetIn input = { ... };
+
myEngine.update(input);
+
+
Postcondition
The internal state of the engine is updated to reflect the new conditions.
+ +

Implemented in PyDynamicEngine, gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, and gridfire::engine::MultiscalePartitioningEngineView.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1DynamicEngine.js b/docs/html/classgridfire_1_1engine_1_1DynamicEngine.js new file mode 100644 index 00000000..c3f5095a --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DynamicEngine.js @@ -0,0 +1,25 @@ +var classgridfire_1_1engine_1_1DynamicEngine = +[ + [ "calculateEpsDerivatives", "classgridfire_1_1engine_1_1DynamicEngine.html#ada6a1295a92c2aede841672ecae0cede", null ], + [ "calculateMolarReactionFlow", "classgridfire_1_1engine_1_1DynamicEngine.html#aa57fa5e58b98a03fba31bcddda8001d4", null ], + [ "collectComposition", "classgridfire_1_1engine_1_1DynamicEngine.html#a41877719ae5e8de53c1692c7cf9bfbfc", null ], + [ "generateJacobianMatrix", "classgridfire_1_1engine_1_1DynamicEngine.html#a53276f09346b531f8676db355e1219eb", null ], + [ "generateJacobianMatrix", "classgridfire_1_1engine_1_1DynamicEngine.html#a51d55a21be28e372021b2b8e5ecdc551", null ], + [ "generateJacobianMatrix", "classgridfire_1_1engine_1_1DynamicEngine.html#a15d53dac8b622a3b7d0f928a3995dbde", null ], + [ "generateStoichiometryMatrix", "classgridfire_1_1engine_1_1DynamicEngine.html#a5e2c45a3e415b53e41def8f743f93464", null ], + [ "getDepth", "classgridfire_1_1engine_1_1DynamicEngine.html#ac5a0def6b6af0bd93bf9057c25f048ff", null ], + [ "getNetworkReactions", "classgridfire_1_1engine_1_1DynamicEngine.html#a26b59a4c7622bf820c0eeec6a7522aa8", null ], + [ "getScreeningModel", "classgridfire_1_1engine_1_1DynamicEngine.html#a24103027a38e02d4342161164554d332", null ], + [ "getSpeciesDestructionTimescales", "classgridfire_1_1engine_1_1DynamicEngine.html#aefc5d0f7842b27a108ba1e4ca346e9a0", null ], + [ "getSpeciesIndex", "classgridfire_1_1engine_1_1DynamicEngine.html#ac0f40017603e8e6887b75dc7360d7c5e", null ], + [ "getSpeciesStatus", "classgridfire_1_1engine_1_1DynamicEngine.html#a8aebefad50c1aa34207e118e92d7ccf0", null ], + [ "getSpeciesTimescales", "classgridfire_1_1engine_1_1DynamicEngine.html#aef6ed91d922c0b1733fd7835e99d0efe", null ], + [ "getStoichiometryMatrixEntry", "classgridfire_1_1engine_1_1DynamicEngine.html#a5ce6ff370e3f0964c6b2688fb3f4bb7e", null ], + [ "isStale", "classgridfire_1_1engine_1_1DynamicEngine.html#a79423b9f67b4cac702547b4f1d8bd14c", null ], + [ "mapNetInToMolarAbundanceVector", "classgridfire_1_1engine_1_1DynamicEngine.html#aa9d55b81c1963113aad86aa60c19676f", null ], + [ "primeEngine", "classgridfire_1_1engine_1_1DynamicEngine.html#a70e270bb50910c0055a75575c1ef1e95", null ], + [ "rebuild", "classgridfire_1_1engine_1_1DynamicEngine.html#a2444b9ed3bc61920ce23c546444269e4", null ], + [ "setNetworkReactions", "classgridfire_1_1engine_1_1DynamicEngine.html#ab321170954bffc53b1bedaf54f6976be", null ], + [ "setScreeningModel", "classgridfire_1_1engine_1_1DynamicEngine.html#a50e76977d0dc3cc23d52b51842d35003", null ], + [ "update", "classgridfire_1_1engine_1_1DynamicEngine.html#a8dd85442ec54f20d91743c72364e36ff", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1DynamicEngine__coll__graph.map b/docs/html/classgridfire_1_1engine_1_1DynamicEngine__coll__graph.map new file mode 100644 index 00000000..f4be0adc --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DynamicEngine__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1DynamicEngine__coll__graph.md5 b/docs/html/classgridfire_1_1engine_1_1DynamicEngine__coll__graph.md5 new file mode 100644 index 00000000..667215ae --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DynamicEngine__coll__graph.md5 @@ -0,0 +1 @@ +e25391cd7318d3212d8252379fdda887 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1DynamicEngine__coll__graph.svg b/docs/html/classgridfire_1_1engine_1_1DynamicEngine__coll__graph.svg new file mode 100644 index 00000000..3edf429b --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DynamicEngine__coll__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +gridfire::engine::DynamicEngine + + +Node1 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2 + + +gridfire::engine::Engine + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1DynamicEngine__coll__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1DynamicEngine__coll__graph_org.svg new file mode 100644 index 00000000..e05a5cee --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DynamicEngine__coll__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +gridfire::engine::DynamicEngine + + +Node1 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2 + + +gridfire::engine::Engine + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1DynamicEngine__inherit__graph.map b/docs/html/classgridfire_1_1engine_1_1DynamicEngine__inherit__graph.map new file mode 100644 index 00000000..ccb57c60 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DynamicEngine__inherit__graph.map @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1DynamicEngine__inherit__graph.md5 b/docs/html/classgridfire_1_1engine_1_1DynamicEngine__inherit__graph.md5 new file mode 100644 index 00000000..476277f4 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DynamicEngine__inherit__graph.md5 @@ -0,0 +1 @@ +956a86ab35cf75f94a00ca2c7a2e3011 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1DynamicEngine__inherit__graph.svg b/docs/html/classgridfire_1_1engine_1_1DynamicEngine__inherit__graph.svg new file mode 100644 index 00000000..df91c9cf --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DynamicEngine__inherit__graph.svg @@ -0,0 +1,253 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::engine::DynamicEngine + + +Node1 + + +gridfire::engine::Dynamic +Engine + + + + + +Node3 + + +PyDynamicEngine + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::engine::Adaptive +EngineView + + + + + +Node1->Node4 + + + + + + + + +Node5 + + +gridfire::engine::Defined +EngineView + + + + + +Node1->Node5 + + + + + + + + +Node8 + + +gridfire::engine::GraphEngine + + + + + +Node1->Node8 + + + + + + + + +Node9 + + +gridfire::engine::Multiscale +PartitioningEngineView + + + + + +Node1->Node9 + + + + + + + + +Node2 + + +gridfire::engine::Engine + + + + + +Node2->Node1 + + + + + + + + +Node6 + + +gridfire::engine::FileDefined +EngineView + + + + + +Node5->Node6 + + + + + + + + +Node7 + + +gridfire::engine::Network +PrimingEngineView + + + + + +Node5->Node7 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1DynamicEngine__inherit__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1DynamicEngine__inherit__graph_org.svg new file mode 100644 index 00000000..87fba88e --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1DynamicEngine__inherit__graph_org.svg @@ -0,0 +1,171 @@ + + + + + + +gridfire::engine::DynamicEngine + + +Node1 + + +gridfire::engine::Dynamic +Engine + + + + + +Node3 + + +PyDynamicEngine + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::engine::Adaptive +EngineView + + + + + +Node1->Node4 + + + + + + + + +Node5 + + +gridfire::engine::Defined +EngineView + + + + + +Node1->Node5 + + + + + + + + +Node8 + + +gridfire::engine::GraphEngine + + + + + +Node1->Node8 + + + + + + + + +Node9 + + +gridfire::engine::Multiscale +PartitioningEngineView + + + + + +Node1->Node9 + + + + + + + + +Node2 + + +gridfire::engine::Engine + + + + + +Node2->Node1 + + + + + + + + +Node6 + + +gridfire::engine::FileDefined +EngineView + + + + + +Node5->Node6 + + + + + + + + +Node7 + + +gridfire::engine::Network +PrimingEngineView + + + + + +Node5->Node7 + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1Engine-members.html b/docs/html/classgridfire_1_1engine_1_1Engine-members.html new file mode 100644 index 00000000..fbc8cf2e --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1Engine-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::Engine Member List
+
+
+ +

This is the complete list of members for gridfire::engine::Engine, including all inherited members.

+ + + + +
calculateRHSAndEnergy(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const =0gridfire::engine::Enginepure virtual
getNetworkSpecies() const =0gridfire::engine::Enginepure virtual
~Engine()=defaultgridfire::engine::Enginevirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1Engine.html b/docs/html/classgridfire_1_1engine_1_1Engine.html new file mode 100644 index 00000000..1375baa0 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1Engine.html @@ -0,0 +1,259 @@ + + + + + + + +GridFire: gridfire::engine::Engine Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::engine::Engine Class Referenceabstract
+
+
+ +

Abstract base class for a reaction network engine. + More...

+ +

#include <engine_abstract.h>

+
+Inheritance diagram for gridfire::engine::Engine:
+
+
+
[legend]
+ + + + + + + + + + + +

+Public Member Functions

virtual ~Engine ()=default
 Virtual destructor.
 
virtual const std::vector< fourdst::atomic::Species > & getNetworkSpecies () const =0
 Get the list of species in the network.
 
virtual std::expected< StepDerivatives< double >, EngineStatus > calculateRHSAndEnergy (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const =0
 Calculate the right-hand side (dY/dt) and energy generation.
 
+

Detailed Description

+

Abstract base class for a reaction network engine.

+

This class defines the minimal interface for a reaction network engine, which is responsible for evaluating the right-hand side (dY/dt) and energy generation for a given set of abundances, temperature, and density.

+

Intended usage: Derive from this class to implement a concrete engine for a specific network or integration method.

+

Example:

class MyEngine : public gridfire::Engine {
+
// Implement required methods...
+
};
+

Constructor & Destructor Documentation

+ +

◆ ~Engine()

+ +
+
+ + + + + +
+ + + + + + + +
virtual gridfire::engine::Engine::~Engine ()
+ 		+virtualdefault
+
+ +

Virtual destructor.

+ +
+
+

Member Function Documentation

+ +

◆ calculateRHSAndEnergy()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual std::expected< StepDerivatives< double >, EngineStatus > gridfire::engine::Engine::calculateRHSAndEnergy (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+pure virtual
+
+ +

Calculate the right-hand side (dY/dt) and energy generation.

+
Parameters
+ + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
expected<StepDerivatives<double>> containing either dY/dt and energy generation rate or a stale engine error indicating that the engine must be updated
+

This function must be implemented by derived classes to compute the time derivatives of all species and the specific nuclear energy generation rate for the current state.

+ +

Implemented in gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, gridfire::engine::MultiscalePartitioningEngineView, PyEngine, and PyDynamicEngine.

+ +
+
+ +

◆ getNetworkSpecies()

+ +
+
+ + + + + +
+ + + + + + + +
virtual const std::vector< fourdst::atomic::Species > & gridfire::engine::Engine::getNetworkSpecies () const
+ 		+pure virtual
+
+ +

Get the list of species in the network.

+
Returns
Vector of Species objects representing all network species.
+ +

Implemented in gridfire::engine::GraphEngine, gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, gridfire::engine::MultiscalePartitioningEngineView, PyEngine, and PyDynamicEngine.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1Engine.js b/docs/html/classgridfire_1_1engine_1_1Engine.js new file mode 100644 index 00000000..af4e16aa --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1Engine.js @@ -0,0 +1,6 @@ +var classgridfire_1_1engine_1_1Engine = +[ + [ "~Engine", "classgridfire_1_1engine_1_1Engine.html#af0ea99416c28933d364a872fc6aff556", null ], + [ "calculateRHSAndEnergy", "classgridfire_1_1engine_1_1Engine.html#a764fc091c72c12c8529105d7c96badb2", null ], + [ "getNetworkSpecies", "classgridfire_1_1engine_1_1Engine.html#a3263c3fde2509d5d8ec4da3b6e946c48", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1EngineView-members.html b/docs/html/classgridfire_1_1engine_1_1EngineView-members.html new file mode 100644 index 00000000..9c5c48f6 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1EngineView-members.html @@ -0,0 +1,112 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::EngineView< EngineT > Member List
+
+
+ +

This is the complete list of members for gridfire::engine::EngineView< EngineT >, including all inherited members.

+ + + +
getBaseEngine() const =0gridfire::engine::EngineView< EngineT >pure virtual
~EngineView()=defaultgridfire::engine::EngineView< EngineT >virtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1EngineView.html b/docs/html/classgridfire_1_1engine_1_1EngineView.html new file mode 100644 index 00000000..1b4b76b5 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1EngineView.html @@ -0,0 +1,215 @@ + + + + + + + +GridFire: gridfire::engine::EngineView< EngineT > Class Template Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::engine::EngineView< EngineT > Class Template Referenceabstract
+
+
+ +

Abstract base class for a "view" of a reaction network engine. + More...

+ +

#include <engine_view_abstract.h>

+ + + + + + + + +

+Public Member Functions

virtual ~EngineView ()=default
 Virtual destructor.
 
virtual const EngineT & getBaseEngine () const =0
 Access the underlying engine instance.
 
+

Detailed Description

+
template<EngineType EngineT>
+class gridfire::engine::EngineView< EngineT >

Abstract base class for a "view" of a reaction network engine.

+
Template Parameters
+ + +
EngineTThe engine type being viewed (must satisfy EngineType).
+
+
+

EngineView provides an interface for accessing an underlying engine instance, while presenting a potentially modified or reduced network structure to the user. This enables dynamic or adaptive network topologies (e.g., culling, masking, or remapping of species and reactions) without altering the core physics engine.

+

Intended usage: Derive from this class to implement a custom view or wrapper that manages a dynamic or adaptive network structure, delegating core calculations to the base engine. The contract is that getBaseEngine() must return a reference to the underlying engine instance, which remains responsible for the full physics.

+

Example (see also AdaptiveEngineView):

class MyAdaptiveView : public gridfire::EngineView<DynamicEngine> {
+
public:
+
MyAdaptiveView(DynamicEngine& engine) : engine_(engine) {}
+
const DynamicEngine& getBaseEngine() const override { return engine_; }
+
// Implement dynamic masking/culling logic...
+
private:
+
DynamicEngine& engine_;
+
};
+
gridfire::engine::DynamicEngine
Abstract class for engines supporting Jacobian and stoichiometry operations.
Definition engine_abstract.h:175
+
See also
gridfire::AdaptiveEngineView for a concrete example of dynamic culling.
+

Constructor & Destructor Documentation

+ +

◆ ~EngineView()

+ +
+
+
+template<EngineType EngineT>
+ + + + + +
+ + + + + + + +
virtual gridfire::engine::EngineView< EngineT >::~EngineView ()
+ 		+virtualdefault
+
+ +

Virtual destructor.

+ +
+
+

Member Function Documentation

+ +

◆ getBaseEngine()

+ +
+
+
+template<EngineType EngineT>
+ + + + + +
+ + + + + + + +
virtual const EngineT & gridfire::engine::EngineView< EngineT >::getBaseEngine () const
+ 		+pure virtual
+
+ +

Access the underlying engine instance.

+
Returns
Const reference to the underlying engine.
+

This method must be implemented by derived classes to provide access to the base engine. The returned reference should remain valid for the lifetime of the EngineView.

+

Example:

const DynamicEngine& engine = myView.getBaseEngine();
+
+

Implemented in gridfire::engine::AdaptiveEngineView, gridfire::engine::DefinedEngineView, gridfire::engine::MultiscalePartitioningEngineView, PyEngineView, and PyDynamicEngineView.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1EngineView.js b/docs/html/classgridfire_1_1engine_1_1EngineView.js new file mode 100644 index 00000000..31080806 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1EngineView.js @@ -0,0 +1,5 @@ +var classgridfire_1_1engine_1_1EngineView = +[ + [ "~EngineView", "classgridfire_1_1engine_1_1EngineView.html#a17d63e853d6efca31064e9147c80d497", null ], + [ "getBaseEngine", "classgridfire_1_1engine_1_1EngineView.html#a7884ea8e5618e295e64150f3ecf2c6b5", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1Engine__inherit__graph.map b/docs/html/classgridfire_1_1engine_1_1Engine__inherit__graph.map new file mode 100644 index 00000000..c77e0171 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1Engine__inherit__graph.map @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1Engine__inherit__graph.md5 b/docs/html/classgridfire_1_1engine_1_1Engine__inherit__graph.md5 new file mode 100644 index 00000000..d4e6ee6e --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1Engine__inherit__graph.md5 @@ -0,0 +1 @@ +0ff07e4d9bf86107a6f81912f762ba1d \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1Engine__inherit__graph.svg b/docs/html/classgridfire_1_1engine_1_1Engine__inherit__graph.svg new file mode 100644 index 00000000..f7fe28a0 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1Engine__inherit__graph.svg @@ -0,0 +1,271 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::engine::Engine + + +Node1 + + +gridfire::engine::Engine + + + + + +Node2 + + +PyEngine + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::engine::Dynamic +Engine + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +PyDynamicEngine + + + + + +Node3->Node4 + + + + + + + + +Node5 + + +gridfire::engine::Adaptive +EngineView + + + + + +Node3->Node5 + + + + + + + + +Node6 + + +gridfire::engine::Defined +EngineView + + + + + +Node3->Node6 + + + + + + + + +Node9 + + +gridfire::engine::GraphEngine + + + + + +Node3->Node9 + + + + + + + + +Node10 + + +gridfire::engine::Multiscale +PartitioningEngineView + + + + + +Node3->Node10 + + + + + + + + +Node7 + + +gridfire::engine::FileDefined +EngineView + + + + + +Node6->Node7 + + + + + + + + +Node8 + + +gridfire::engine::Network +PrimingEngineView + + + + + +Node6->Node8 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1Engine__inherit__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1Engine__inherit__graph_org.svg new file mode 100644 index 00000000..5a8fb2bf --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1Engine__inherit__graph_org.svg @@ -0,0 +1,189 @@ + + + + + + +gridfire::engine::Engine + + +Node1 + + +gridfire::engine::Engine + + + + + +Node2 + + +PyEngine + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::engine::Dynamic +Engine + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +PyDynamicEngine + + + + + +Node3->Node4 + + + + + + + + +Node5 + + +gridfire::engine::Adaptive +EngineView + + + + + +Node3->Node5 + + + + + + + + +Node6 + + +gridfire::engine::Defined +EngineView + + + + + +Node3->Node6 + + + + + + + + +Node9 + + +gridfire::engine::GraphEngine + + + + + +Node3->Node9 + + + + + + + + +Node10 + + +gridfire::engine::Multiscale +PartitioningEngineView + + + + + +Node3->Node10 + + + + + + + + +Node7 + + +gridfire::engine::FileDefined +EngineView + + + + + +Node6->Node7 + + + + + + + + +Node8 + + +gridfire::engine::Network +PrimingEngineView + + + + + +Node6->Node8 + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView-members.html b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView-members.html new file mode 100644 index 00000000..f59d353c --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView-members.html @@ -0,0 +1,162 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::FileDefinedEngineView Member List
+
+
+ +

This is the complete list of members for gridfire::engine::FileDefinedEngineView, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
calculateEpsDerivatives(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
calculateMolarReactionFlow(const reaction::Reaction &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
calculateRHSAndEnergy(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
collect(const std::vector< std::string > &peNames)gridfire::engine::DefinedEngineViewprivate
collectComposition(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
Config typedefgridfire::engine::FileDefinedEngineViewprivate
constructReactionIndexMap() constgridfire::engine::DefinedEngineViewprivate
constructSpeciesIndexMap() constgridfire::engine::DefinedEngineViewprivate
DefinedEngineView(const std::vector< std::string > &peNames, GraphEngine &baseEngine)gridfire::engine::DefinedEngineView
FileDefinedEngineView(GraphEngine &baseEngine, const std::string &fileName, const io::NetworkFileParser &parser)gridfire::engine::FileDefinedEngineViewexplicit
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies) const overridegridfire::engine::DefinedEngineViewvirtual
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const overridegridfire::engine::DefinedEngineViewvirtual
generateStoichiometryMatrix() overridegridfire::engine::DefinedEngineViewvirtual
getBaseEngine() const overridegridfire::engine::DefinedEngineViewvirtual
getDepth() constgridfire::engine::DynamicEngineinlinevirtual
getNetworkFile() constgridfire::engine::FileDefinedEngineViewinline
getNetworkReactions() const overridegridfire::engine::DefinedEngineViewvirtual
getNetworkSpecies() const overridegridfire::engine::DefinedEngineViewvirtual
getParser() constgridfire::engine::FileDefinedEngineViewinline
getScreeningModel() const overridegridfire::engine::DefinedEngineViewvirtual
getSpeciesDestructionTimescales(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
getSpeciesIndex(const fourdst::atomic::Species &species) const overridegridfire::engine::DefinedEngineViewvirtual
getSpeciesStatus(const fourdst::atomic::Species &species) const overridegridfire::engine::DefinedEngineViewvirtual
getSpeciesTimescales(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
getStoichiometryMatrixEntry(const fourdst::atomic::Species &species, const reaction::Reaction &reaction) const overridegridfire::engine::DefinedEngineViewvirtual
isStale(const NetIn &netIn) overridegridfire::engine::DefinedEngineViewvirtual
LogManager typedefgridfire::engine::FileDefinedEngineViewprivate
m_activeReactionsgridfire::engine::DefinedEngineViewprivate
m_activeSpeciesgridfire::engine::DefinedEngineViewprivate
m_activeSpeciesVectorCachegridfire::engine::DefinedEngineViewmutableprivate
m_baseEnginegridfire::engine::DefinedEngineViewprotected
m_configgridfire::engine::FileDefinedEngineViewprivate
m_fileNamegridfire::engine::FileDefinedEngineViewprivate
m_isStalegridfire::engine::DefinedEngineViewprotected
m_loggergridfire::engine::FileDefinedEngineViewprivate
m_parsergridfire::engine::FileDefinedEngineViewprivate
m_reactionIndexMapgridfire::engine::DefinedEngineViewprivate
m_speciesIndexMapgridfire::engine::DefinedEngineViewprivate
mapFullToView(const std::vector< double > &full) constgridfire::engine::DefinedEngineViewprivate
mapNetInToMolarAbundanceVector(const NetIn &netIn) const overridegridfire::engine::DefinedEngineViewvirtual
mapViewToFull(const std::vector< double > &defined) constgridfire::engine::DefinedEngineViewprivate
mapViewToFullReactionIndex(size_t definedReactionIndex) constgridfire::engine::DefinedEngineViewprivate
mapViewToFullSpeciesIndex(size_t definedSpeciesIndex) constgridfire::engine::DefinedEngineViewprivate
primeEngine(const NetIn &netIn) overridegridfire::engine::DefinedEngineViewvirtual
rebuild(const fourdst::composition::CompositionAbstract &comp, BuildDepthType depth)gridfire::engine::DynamicEngineinlinevirtual
setNetworkReactions(const reaction::ReactionSet &reactions) overridegridfire::engine::DefinedEngineViewvirtual
setScreeningModel(screening::ScreeningType model) overridegridfire::engine::DefinedEngineViewvirtual
update(const NetIn &netIn) overridegridfire::engine::DefinedEngineViewvirtual
validateNetworkState() constgridfire::engine::DefinedEngineViewprivate
~Engine()=defaultgridfire::engine::Enginevirtual
~EngineView()=defaultgridfire::engine::EngineView< DynamicEngine >virtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView.html b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView.html new file mode 100644 index 00000000..888b686a --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView.html @@ -0,0 +1,486 @@ + + + + + + + +GridFire: gridfire::engine::FileDefinedEngineView Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Types | +Private Attributes | +List of all members
+
gridfire::engine::FileDefinedEngineView Class Referencefinal
+
+
+ +

#include <engine_defined.h>

+
+Inheritance diagram for gridfire::engine::FileDefinedEngineView:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::engine::FileDefinedEngineView:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 FileDefinedEngineView (GraphEngine &baseEngine, const std::string &fileName, const io::NetworkFileParser &parser)
 FileDefinedEngineView Implementation ///.
 
std::string getNetworkFile () const
 
const io::NetworkFileParser & getParser () const
 
- Public Member Functions inherited from gridfire::engine::DefinedEngineView
 DefinedEngineView (const std::vector< std::string > &peNames, GraphEngine &baseEngine)
 
const DynamicEngine & getBaseEngine () const override
 Get the base engine associated with this defined engine view.
 
const std::vector< fourdst::atomic::Species > & getNetworkSpecies () const override
 Gets the list of active species in the network defined by the file.
 
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
 Calculate the derivatives of the energy generation rate with respect to T and rho.
 
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 the active species.
 
NetworkJacobian generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const override
 Generates the Jacobian matrix for 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 active reactions in the network.
 
std::expected< std::unordered_map< fourdst::atomic::Species, double >, engine::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 >, engine::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 update (const NetIn &netIn) override
 Updates the engine view if it is marked as stale.
 
bool isStale (const NetIn &netIn) override
 Checks if the engine view is stale.
 
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
 Maps a species from the full network to its index in the defined active network.
 
std::vector< double > mapNetInToMolarAbundanceVector (const NetIn &netIn) const override
 Map from a NetIn object to a vector of molar abundances for the active species.
 
PrimingReport primeEngine (const NetIn &netIn) override
 Prime the engine view for calculations. This will delegate to the base engine.
 
fourdst::composition::Composition collectComposition (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
 Collects a Composition object from the base engine.
 
SpeciesStatus getSpeciesStatus (const fourdst::atomic::Species &species) const override
 Gets the status of a species in the active 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.
 
- Public Member Functions inherited from gridfire::engine::Engine
virtual ~Engine ()=default
 Virtual destructor.
 
- Public Member Functions inherited from gridfire::engine::EngineView< DynamicEngine >
virtual ~EngineView ()=default
 Virtual destructor.
 
+ + + + + +

+Private Types

using Config = fourdst::config::Config
 
using LogManager = fourdst::logging::LogManager
 
+ + + + + + + + + + +

+Private Attributes

Config & m_config = Config::getInstance()
 
quill::Logger * m_logger = LogManager::getInstance().getLogger("log")
 
std::string m_fileName
 Parser for the network file.
 
const io::NetworkFileParser & m_parser
 
+ + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::engine::DefinedEngineView
bool m_isStale = true
 
GraphEngine & m_baseEngine
 
+

Member Typedef Documentation

+ +

◆ Config

+ +
+
+ + + + + +
+ + + + +
using gridfire::engine::FileDefinedEngineView::Config = fourdst::config::Config
+ 		+private
+
+ +
+
+ +

◆ LogManager

+ +
+
+ + + + + +
+ + + + +
using gridfire::engine::FileDefinedEngineView::LogManager = fourdst::logging::LogManager
+ 		+private
+
+ +
+
+

Constructor & Destructor Documentation

+ +

◆ FileDefinedEngineView()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
gridfire::engine::FileDefinedEngineView::FileDefinedEngineView (GraphEngine & baseEngine,
const std::string & fileName,
const io::NetworkFileParser & parser 
)
+ 		+explicit
+
+ +

FileDefinedEngineView Implementation ///.

+ +
+
+

Member Function Documentation

+ +

◆ getNetworkFile()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::engine::FileDefinedEngineView::getNetworkFile () const
+ 		+inline
+
+ +
+
+ +

◆ getParser()

+ +
+
+ + + + + +
+ + + + + + + +
const io::NetworkFileParser & gridfire::engine::FileDefinedEngineView::getParser () const
+ 		+inline
+
+ +
+
+

Member Data Documentation

+ +

◆ m_config

+ +
+
+ + + + + +
+ + + + +
Config& gridfire::engine::FileDefinedEngineView::m_config = Config::getInstance()
+ 		+private
+
+ +
+
+ +

◆ m_fileName

+ +
+
+ + + + + +
+ + + + +
std::string gridfire::engine::FileDefinedEngineView::m_fileName
+ 		+private
+
+ +

Parser for the network file.

+ +
+
+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::engine::FileDefinedEngineView::m_logger = LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +
+
+ +

◆ m_parser

+ +
+
+ + + + + +
+ + + + +
const io::NetworkFileParser& gridfire::engine::FileDefinedEngineView::m_parser
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView.js b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView.js new file mode 100644 index 00000000..1ab70434 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView.js @@ -0,0 +1,12 @@ +var classgridfire_1_1engine_1_1FileDefinedEngineView = +[ + [ "Config", "classgridfire_1_1engine_1_1FileDefinedEngineView.html#a8d066e95f4cc201cbda90c2aec5d98c4", null ], + [ "LogManager", "classgridfire_1_1engine_1_1FileDefinedEngineView.html#af2183aba50db8f91055042425fb84766", null ], + [ "FileDefinedEngineView", "classgridfire_1_1engine_1_1FileDefinedEngineView.html#a2ac3834f2d8b916db40fe71c0f070a00", null ], + [ "getNetworkFile", "classgridfire_1_1engine_1_1FileDefinedEngineView.html#a73fc090d69db6a99d7694c1de8ff46db", null ], + [ "getParser", "classgridfire_1_1engine_1_1FileDefinedEngineView.html#a6f2b445d16ea375ce00d7bd3318fed77", null ], + [ "m_config", "classgridfire_1_1engine_1_1FileDefinedEngineView.html#a6a664b568caf7ec207a10be6a56e52f1", null ], + [ "m_fileName", "classgridfire_1_1engine_1_1FileDefinedEngineView.html#a94b66aa4396d98aa78900c2b6bcf0526", null ], + [ "m_logger", "classgridfire_1_1engine_1_1FileDefinedEngineView.html#af8e65c1eee99938437aa649675182a06", null ], + [ "m_parser", "classgridfire_1_1engine_1_1FileDefinedEngineView.html#a3c438706106a7f1bf27f3015e2a64205", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__coll__graph.map b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__coll__graph.map new file mode 100644 index 00000000..183acc15 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__coll__graph.map @@ -0,0 +1,109 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__coll__graph.md5 b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__coll__graph.md5 new file mode 100644 index 00000000..3671c549 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__coll__graph.md5 @@ -0,0 +1 @@ +f54dd33f97c66560b686195bdce75177 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__coll__graph.svg b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__coll__graph.svg new file mode 100644 index 00000000..9e3fe377 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__coll__graph.svg @@ -0,0 +1,1164 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::engine::FileDefinedEngineView + + +Node1 + + +gridfire::engine::FileDefined +EngineView + + + + + +Node2 + + +gridfire::engine::Defined +EngineView + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Dynamic +Engine + + + + + +Node3->Node2 + + + + + + + + +Node6 + + +gridfire::engine::GraphEngine + + + + + +Node3->Node6 + + + + + + + + +Node4 + + +gridfire::engine::Engine + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node5->Node2 + + + + + + + + +Node6->Node2 + + + + + + m_baseEngine + + + +Node35 + + +gridfire::engine::GraphEngine +::AtomicReverseRate + + + + + +Node6->Node35 + + + + + + m_engine + + + +Node7 + + +std::unordered_map +< JacobianMatrixState, + std::string > + + + + + +Node7->Node6 + + + + + + m_jacobianMatrixStateNameMap + + + +Node8 + + +std::string + + + + + +Node8->Node1 + + + + + + m_fileName + + + +Node8->Node7 + + + + + + elements + + + +Node18 + + +gridfire::reaction +::ReactionSet + + + + + +Node8->Node18 + + + + + + m_id + + + +Node22 + + +std::unordered_map +< std::string, size_t > + + + + + +Node8->Node22 + + + + + + keys + + + +Node9 + + +std::basic_string< + Char > + + + + + +Node9->Node8 + + + + + + + + +Node10 + + +Config + + + + + +Node10->Node6 + + + + + + m_config + + + +Node11 + + +gridfire::engine::GraphEngine +::constants + + + + + +Node11->Node6 + + + + + + m_constants + + + +Node12 + + +gridfire::rates::weak +::WeakRateInterpolator + + + + + +Node12->Node6 + + + + + + m_weakRateInterpolator + + + +Node13 + + +std::unordered_map +< uint32_t, gridfire +::rates::weak::IsotopeGrid > + + + + + +Node13->Node12 + + + + + + m_rate_table + + + +Node14 + + +gridfire::rates::weak +::IsotopeGrid + + + + + +Node14->Node13 + + + + + + elements + + + +Node15 + + +std::vector< double > + + + + + +Node15->Node14 + + + + + + rhoYe_axis +t9_axis + + + +Node16 + + +std::vector< gridfire +::rates::weak::WeakRatePayload > + + + + + +Node16->Node14 + + + + + + data + + + +Node17 + + +gridfire::rates::weak +::WeakRatePayload + + + + + +Node17->Node16 + + + + + + elements + + + +Node18->Node2 + + + + + + m_activeReactions + + + +Node18->Node6 + + + + + + m_reactions + + + +Node19 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node19->Node18 + + + + + + m_reactions + + + +Node20 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node20->Node19 + + + + + + elements + + + +Node21 + + +gridfire::reaction +::Reaction + + + + + +Node21->Node20 + + + + + + ptr + + + +Node24 + + +std::unordered_map +< std::string_view, + gridfire::reaction:: +Reaction * > + + + + + +Node21->Node24 + + + + + + elements + + + +Node21->Node35 + + + + + + m_reaction + + + +Node22->Node18 + + + + + + m_reactionNameMap + + + +Node23 + + +std::unordered_set +< size_t > + + + + + +Node23->Node18 + + + + + + m_reactionHashes + + + +Node24->Node6 + + + + + + m_reactionIDMap + + + +Node25 + + +std::string_view + + + + + +Node25->Node24 + + + + + + keys + + + +Node29 + + +std::unordered_map +< std::string_view, + fourdst::atomic::Species > + + + + + +Node25->Node29 + + + + + + keys + + + +Node26 + + +std::basic_string_view +< Char > + + + + + +Node26->Node25 + + + + + + + + +Node27 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node27->Node6 + + + + + + m_networkSpecies + + + +Node28 + + +Species + + + + + +Node28->Node27 + + + + + + elements + + + +Node28->Node29 + + + + + + elements + + + +Node30 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node28->Node30 + + + + + + keys + + + +Node31 + + +std::unordered_map +< size_t, fourdst::atomic +::Species > + + + + + +Node28->Node31 + + + + + + elements + + + +Node46 + + +std::set< fourdst:: +atomic::Species > + + + + + +Node28->Node46 + + + + + + keys + + + +Node29->Node6 + + + + + + m_networkSpeciesMap + + + +Node30->Node6 + + + + + + m_speciesToIndexMap + + + +Node31->Node6 + + + + + + m_indexToSpeciesMap + + + +Node32 + + +std::set< std::pair +< size_t, size_t > > + + + + + +Node32->Node6 + + + + + + m_full_sparsity_set + + + +Node33 + + +std::vector< std::unique +_ptr< gridfire::engine +::GraphEngine::AtomicReverseRate > > + + + + + +Node33->Node6 + + + + + + m_atomicReverseRates + + + +Node34 + + +std::unique_ptr< gridfire +::engine::GraphEngine:: +AtomicReverseRate > + + + + + +Node34->Node33 + + + + + + elements + + + +Node35->Node34 + + + + + + ptr + + + +Node36 + + +CppAD::atomic_base +< double > + + + + + +Node36->Node35 + + + + + + + + +Node37 + + +std::unique_ptr< gridfire +::screening::ScreeningModel > + + + + + +Node37->Node6 + + + + + + m_screeningModel + + + +Node38 + + +gridfire::screening +::ScreeningModel + + + + + +Node38->Node37 + + + + + + ptr + + + +Node39 + + +std::vector< gridfire +::engine::GraphEngine +::PrecomputedReaction > + + + + + +Node39->Node6 + + + + + + m_precomputedReactions + + + +Node40 + + +gridfire::engine::GraphEngine +::PrecomputedReaction + + + + + +Node40->Node39 + + + + + + elements + + + +Node41 + + +std::vector< size_t > + + + + + +Node41->Node2 + + + + + + m_reactionIndexMap +m_speciesIndexMap + + + +Node41->Node40 + + + + + + affected_species_indices +unique_product_indices +unique_reactant_indices + + + +Node42 + + +std::vector< int > + + + + + +Node42->Node40 + + + + + + product_powers +reactant_powers +stoichiometric_coefficients + + + +Node43 + + +std::unordered_map +< uint64_t, size_t > + + + + + +Node43->Node6 + + + + + + m_precomputedReactionIndexMap + + + +Node44 + + +std::unique_ptr< gridfire +::partition::PartitionFunction > + + + + + +Node44->Node6 + + + + + + m_partitionFunction + + + +Node45 + + +gridfire::partition +::PartitionFunction + + + + + +Node45->Node44 + + + + + + ptr + + + +Node46->Node2 + + + + + + m_activeSpecies + + + +Node47 + + +gridfire::io::NetworkFile +Parser + + + + + +Node47->Node1 + + + + + + m_parser + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__coll__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__coll__graph_org.svg new file mode 100644 index 00000000..2e74b0fc --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__coll__graph_org.svg @@ -0,0 +1,1082 @@ + + + + + + +gridfire::engine::FileDefinedEngineView + + +Node1 + + +gridfire::engine::FileDefined +EngineView + + + + + +Node2 + + +gridfire::engine::Defined +EngineView + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Dynamic +Engine + + + + + +Node3->Node2 + + + + + + + + +Node6 + + +gridfire::engine::GraphEngine + + + + + +Node3->Node6 + + + + + + + + +Node4 + + +gridfire::engine::Engine + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node5->Node2 + + + + + + + + +Node6->Node2 + + + + + + m_baseEngine + + + +Node35 + + +gridfire::engine::GraphEngine +::AtomicReverseRate + + + + + +Node6->Node35 + + + + + + m_engine + + + +Node7 + + +std::unordered_map +< JacobianMatrixState, + std::string > + + + + + +Node7->Node6 + + + + + + m_jacobianMatrixStateNameMap + + + +Node8 + + +std::string + + + + + +Node8->Node1 + + + + + + m_fileName + + + +Node8->Node7 + + + + + + elements + + + +Node18 + + +gridfire::reaction +::ReactionSet + + + + + +Node8->Node18 + + + + + + m_id + + + +Node22 + + +std::unordered_map +< std::string, size_t > + + + + + +Node8->Node22 + + + + + + keys + + + +Node9 + + +std::basic_string< + Char > + + + + + +Node9->Node8 + + + + + + + + +Node10 + + +Config + + + + + +Node10->Node6 + + + + + + m_config + + + +Node11 + + +gridfire::engine::GraphEngine +::constants + + + + + +Node11->Node6 + + + + + + m_constants + + + +Node12 + + +gridfire::rates::weak +::WeakRateInterpolator + + + + + +Node12->Node6 + + + + + + m_weakRateInterpolator + + + +Node13 + + +std::unordered_map +< uint32_t, gridfire +::rates::weak::IsotopeGrid > + + + + + +Node13->Node12 + + + + + + m_rate_table + + + +Node14 + + +gridfire::rates::weak +::IsotopeGrid + + + + + +Node14->Node13 + + + + + + elements + + + +Node15 + + +std::vector< double > + + + + + +Node15->Node14 + + + + + + rhoYe_axis +t9_axis + + + +Node16 + + +std::vector< gridfire +::rates::weak::WeakRatePayload > + + + + + +Node16->Node14 + + + + + + data + + + +Node17 + + +gridfire::rates::weak +::WeakRatePayload + + + + + +Node17->Node16 + + + + + + elements + + + +Node18->Node2 + + + + + + m_activeReactions + + + +Node18->Node6 + + + + + + m_reactions + + + +Node19 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node19->Node18 + + + + + + m_reactions + + + +Node20 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node20->Node19 + + + + + + elements + + + +Node21 + + +gridfire::reaction +::Reaction + + + + + +Node21->Node20 + + + + + + ptr + + + +Node24 + + +std::unordered_map +< std::string_view, + gridfire::reaction:: +Reaction * > + + + + + +Node21->Node24 + + + + + + elements + + + +Node21->Node35 + + + + + + m_reaction + + + +Node22->Node18 + + + + + + m_reactionNameMap + + + +Node23 + + +std::unordered_set +< size_t > + + + + + +Node23->Node18 + + + + + + m_reactionHashes + + + +Node24->Node6 + + + + + + m_reactionIDMap + + + +Node25 + + +std::string_view + + + + + +Node25->Node24 + + + + + + keys + + + +Node29 + + +std::unordered_map +< std::string_view, + fourdst::atomic::Species > + + + + + +Node25->Node29 + + + + + + keys + + + +Node26 + + +std::basic_string_view +< Char > + + + + + +Node26->Node25 + + + + + + + + +Node27 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node27->Node6 + + + + + + m_networkSpecies + + + +Node28 + + +Species + + + + + +Node28->Node27 + + + + + + elements + + + +Node28->Node29 + + + + + + elements + + + +Node30 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node28->Node30 + + + + + + keys + + + +Node31 + + +std::unordered_map +< size_t, fourdst::atomic +::Species > + + + + + +Node28->Node31 + + + + + + elements + + + +Node46 + + +std::set< fourdst:: +atomic::Species > + + + + + +Node28->Node46 + + + + + + keys + + + +Node29->Node6 + + + + + + m_networkSpeciesMap + + + +Node30->Node6 + + + + + + m_speciesToIndexMap + + + +Node31->Node6 + + + + + + m_indexToSpeciesMap + + + +Node32 + + +std::set< std::pair +< size_t, size_t > > + + + + + +Node32->Node6 + + + + + + m_full_sparsity_set + + + +Node33 + + +std::vector< std::unique +_ptr< gridfire::engine +::GraphEngine::AtomicReverseRate > > + + + + + +Node33->Node6 + + + + + + m_atomicReverseRates + + + +Node34 + + +std::unique_ptr< gridfire +::engine::GraphEngine:: +AtomicReverseRate > + + + + + +Node34->Node33 + + + + + + elements + + + +Node35->Node34 + + + + + + ptr + + + +Node36 + + +CppAD::atomic_base +< double > + + + + + +Node36->Node35 + + + + + + + + +Node37 + + +std::unique_ptr< gridfire +::screening::ScreeningModel > + + + + + +Node37->Node6 + + + + + + m_screeningModel + + + +Node38 + + +gridfire::screening +::ScreeningModel + + + + + +Node38->Node37 + + + + + + ptr + + + +Node39 + + +std::vector< gridfire +::engine::GraphEngine +::PrecomputedReaction > + + + + + +Node39->Node6 + + + + + + m_precomputedReactions + + + +Node40 + + +gridfire::engine::GraphEngine +::PrecomputedReaction + + + + + +Node40->Node39 + + + + + + elements + + + +Node41 + + +std::vector< size_t > + + + + + +Node41->Node2 + + + + + + m_reactionIndexMap +m_speciesIndexMap + + + +Node41->Node40 + + + + + + affected_species_indices +unique_product_indices +unique_reactant_indices + + + +Node42 + + +std::vector< int > + + + + + +Node42->Node40 + + + + + + product_powers +reactant_powers +stoichiometric_coefficients + + + +Node43 + + +std::unordered_map +< uint64_t, size_t > + + + + + +Node43->Node6 + + + + + + m_precomputedReactionIndexMap + + + +Node44 + + +std::unique_ptr< gridfire +::partition::PartitionFunction > + + + + + +Node44->Node6 + + + + + + m_partitionFunction + + + +Node45 + + +gridfire::partition +::PartitionFunction + + + + + +Node45->Node44 + + + + + + ptr + + + +Node46->Node2 + + + + + + m_activeSpecies + + + +Node47 + + +gridfire::io::NetworkFile +Parser + + + + + +Node47->Node1 + + + + + + m_parser + + + diff --git a/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__inherit__graph.map b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__inherit__graph.map new file mode 100644 index 00000000..d1bcc36b --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__inherit__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__inherit__graph.md5 b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__inherit__graph.md5 new file mode 100644 index 00000000..d42e1ceb --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__inherit__graph.md5 @@ -0,0 +1 @@ +9a5bb8e3a74f5b34af3cbb0b1290d9bc \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__inherit__graph.svg b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__inherit__graph.svg new file mode 100644 index 00000000..a30b5eb8 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__inherit__graph.svg @@ -0,0 +1,122 @@ + + + + + + + + + + + +gridfire::engine::FileDefinedEngineView + + +Node1 + + +gridfire::engine::FileDefined +EngineView + + + + + +Node2 + + +gridfire::engine::Defined +EngineView + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Dynamic +Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::engine::Engine + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node5->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__inherit__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__inherit__graph_org.svg new file mode 100644 index 00000000..bb5f8e90 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1FileDefinedEngineView__inherit__graph_org.svg @@ -0,0 +1,97 @@ + + + + + + +gridfire::engine::FileDefinedEngineView + + +Node1 + + +gridfire::engine::FileDefined +EngineView + + + + + +Node2 + + +gridfire::engine::Defined +EngineView + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Dynamic +Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::engine::Engine + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node5->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine-members.html b/docs/html/classgridfire_1_1engine_1_1GraphEngine-members.html new file mode 100644 index 00000000..1b3e0788 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine-members.html @@ -0,0 +1,195 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::GraphEngine Member List
+
+
+ +

This is the complete list of members for gridfire::engine::GraphEngine, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
calculateAllDerivatives(const std::vector< T > &Y_in, T T9, T rho, T Ye, T mue, std::function< std::optional< size_t >(const fourdst::atomic::Species &)> speciesLookup, const std::function< bool(const reaction::Reaction &)> &reactionLookup) constgridfire::engine::GraphEngineprivate
calculateAllDerivatives(const std::vector< T > &Y_in, const T T9, const T rho, const T Ye, const T mue, const std::function< std::optional< size_t >(const fourdst::atomic::Species &)> speciesLookup, const std::function< bool(const reaction::Reaction &)> &reactionLookup) constgridfire::engine::GraphEngine
calculateAllDerivativesUsingPrecomputation(const fourdst::composition::CompositionAbstract &comp, const std::vector< double > &bare_rates, const std::vector< double > &bare_reverse_rates, double T9, double rho, const reaction::ReactionSet &activeReactions) constgridfire::engine::GraphEngineprivate
calculateEpsDerivatives(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::GraphEnginevirtual
calculateEpsDerivatives(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const reaction::ReactionSet &activeReactions) constgridfire::engine::GraphEngine
calculateMolarReactionFlow(const reaction::Reaction &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::GraphEnginevirtual
calculateMolarReactionFlow(const reaction::Reaction &reaction, const std::vector< T > &Y, T T9, T rho, T Ye, T mue, const std::function< std::optional< size_t >(const fourdst::atomic::Species &)> &speciesIDLookup) constgridfire::engine::GraphEngineprivate
calculateReverseMolarReactionFlow(T T9, T rho, std::vector< T > screeningFactors, const std::vector< T > &Y, size_t reactionIndex, const reaction::Reaction &reaction) constgridfire::engine::GraphEngineprivate
calculateReverseRate(const reaction::Reaction &reaction, double T9, double rho, const fourdst::composition::CompositionAbstract &comp) constgridfire::engine::GraphEngine
calculateReverseRateTwoBody(const reaction::Reaction &reaction, double T9, double forwardRate, double expFactor) constgridfire::engine::GraphEngine
calculateReverseRateTwoBodyDerivative(const reaction::Reaction &reaction, double T9, double rho, const fourdst::composition::Composition &comp, double reverseRate) constgridfire::engine::GraphEngine
calculateRHSAndEnergy(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::GraphEnginevirtual
calculateRHSAndEnergy(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const reaction::ReactionSet &activeReactions) constgridfire::engine::GraphEngine
collectAtomicReverseRateAtomicBases()gridfire::engine::GraphEngineprivate
collectComposition(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::GraphEnginevirtual
collectNetworkSpecies()gridfire::engine::GraphEngineprivate
exportToCSV(const std::string &filename) constgridfire::engine::GraphEngine
exportToDot(const std::string &filename) constgridfire::engine::GraphEngine
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::GraphEnginevirtual
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies) const overridegridfire::engine::GraphEnginevirtual
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const overridegridfire::engine::GraphEnginevirtual
generateStoichiometryMatrix() overridegridfire::engine::GraphEnginevirtual
getDepth() const overridegridfire::engine::GraphEnginevirtual
getNetReactionStoichiometry(const reaction::Reaction &reaction)gridfire::engine::GraphEnginestatic
getNetworkReactions() const overridegridfire::engine::GraphEnginevirtual
getNetworkSpecies() const overridegridfire::engine::GraphEnginevirtual
getPartitionFunction() constgridfire::engine::GraphEngine
getScreeningModel() const overridegridfire::engine::GraphEnginevirtual
getSpeciesDestructionTimescales(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::GraphEnginevirtual
getSpeciesDestructionTimescales(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const reaction::ReactionSet &activeReactions) constgridfire::engine::GraphEngine
getSpeciesIndex(const fourdst::atomic::Species &species) const overridegridfire::engine::GraphEnginevirtual
getSpeciesStatus(const fourdst::atomic::Species &species) const overridegridfire::engine::GraphEnginevirtual
getSpeciesTimescales(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::GraphEnginevirtual
getSpeciesTimescales(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const reaction::ReactionSet &activeReactions) constgridfire::engine::GraphEngine
getStoichiometryMatrixEntry(const fourdst::atomic::Species &species, const reaction::Reaction &reaction) const overridegridfire::engine::GraphEnginevirtual
GraphEngine(const fourdst::composition::Composition &composition, BuildDepthType=NetworkBuildDepth::Full)gridfire::engine::GraphEngineexplicit
GraphEngine(const fourdst::composition::Composition &composition, const partition::PartitionFunction &partitionFunction, BuildDepthType buildDepth=NetworkBuildDepth::Full)gridfire::engine::GraphEngineexplicit
GraphEngine(const fourdst::composition::Composition &composition, const partition::PartitionFunction &partitionFunction, BuildDepthType buildDepth, NetworkConstructionFlags reactionTypes)gridfire::engine::GraphEngineexplicit
GraphEngine(const reaction::ReactionSet &reactions)gridfire::engine::GraphEngineexplicit
involvesSpecies(const fourdst::atomic::Species &species) constgridfire::engine::GraphEngine
isPrecomputationEnabled() constgridfire::engine::GraphEngine
isStale(const NetIn &netIn) overridegridfire::engine::GraphEnginevirtual
isUsingReverseReactions() constgridfire::engine::GraphEngine
JacobianMatrixState enum namegridfire::engine::GraphEngineprivate
m_atomicReverseRatesgridfire::engine::GraphEngineprivate
m_configgridfire::engine::GraphEngineprivate
m_constantsgridfire::engine::GraphEngineprivate
m_depthgridfire::engine::GraphEngineprivate
m_epsADFungridfire::engine::GraphEnginemutableprivate
m_full_jacobian_sparsity_patterngridfire::engine::GraphEngineprivate
m_full_sparsity_setgridfire::engine::GraphEngineprivate
m_has_been_primedgridfire::engine::GraphEngineprivate
m_indexToSpeciesMapgridfire::engine::GraphEngineprivate
m_jac_workgridfire::engine::GraphEnginemutableprivate
m_jacobianMatrixStateNameMapgridfire::engine::GraphEngineprivate
m_loggergridfire::engine::GraphEngineprivate
m_networkSpeciesgridfire::engine::GraphEngineprivate
m_networkSpeciesMapgridfire::engine::GraphEngineprivate
m_partitionFunctiongridfire::engine::GraphEngineprivate
m_precomputedReactionIndexMapgridfire::engine::GraphEngineprivate
m_precomputedReactionsgridfire::engine::GraphEngineprivate
m_reactionIDMapgridfire::engine::GraphEngineprivate
m_reactionsgridfire::engine::GraphEngineprivate
m_rhsADFungridfire::engine::GraphEnginemutableprivate
m_screeningModelgridfire::engine::GraphEngineprivate
m_screeningTypegridfire::engine::GraphEngineprivate
m_speciesToIndexMapgridfire::engine::GraphEngineprivate
m_usePrecomputationgridfire::engine::GraphEngineprivate
m_useReverseReactionsgridfire::engine::GraphEngineprivate
m_weakRateInterpolatorgridfire::engine::GraphEngineprivate
mapNetInToMolarAbundanceVector(const NetIn &netIn) const overridegridfire::engine::GraphEnginevirtual
populateReactionIDMap()gridfire::engine::GraphEngineprivate
populateSpeciesToIndexMap()gridfire::engine::GraphEngineprivate
precomputeNetwork()gridfire::engine::GraphEngineprivate
primeEngine(const NetIn &netIn) overridegridfire::engine::GraphEnginevirtual
rebuild(const fourdst::composition::CompositionAbstract &comp, BuildDepthType depth) overridegridfire::engine::GraphEnginevirtual
recordADTape() constgridfire::engine::GraphEngineprivate
setNetworkReactions(const reaction::ReactionSet &reactions) overridegridfire::engine::GraphEnginevirtual
setPrecomputation(bool precompute)gridfire::engine::GraphEngine
setScreeningModel(screening::ScreeningType model) overridegridfire::engine::GraphEnginevirtual
setUseReverseReactions(bool useReverse)gridfire::engine::GraphEngine
syncInternalMaps()gridfire::engine::GraphEngineprivate
update(const NetIn &netIn) overridegridfire::engine::GraphEnginevirtual
validateConservation() constgridfire::engine::GraphEngineprivate
~Engine()=defaultgridfire::engine::Enginevirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine.html b/docs/html/classgridfire_1_1engine_1_1GraphEngine.html new file mode 100644 index 00000000..aa23086f --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine.html @@ -0,0 +1,3552 @@ + + + + + + + +GridFire: gridfire::engine::GraphEngine Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Classes | +Public Member Functions | +Static Public Member Functions | +Private Types | +Private Member Functions | +Private Attributes | +List of all members
+
gridfire::engine::GraphEngine Class Referencefinal
+
+
+ +

A reaction network engine that uses a graph-based representation. + More...

+ +

#include <engine_graph.h>

+
+Inheritance diagram for gridfire::engine::GraphEngine:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::engine::GraphEngine:
+
+
+
[legend]
+ + + + + + + + +

+Classes

class  AtomicReverseRate
 
struct  constants
 
struct  PrecomputedReaction
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 GraphEngine (const fourdst::composition::Composition &composition, BuildDepthType=NetworkBuildDepth::Full)
 Constructs a GraphEngine from a composition.
 
 GraphEngine (const fourdst::composition::Composition &composition, const partition::PartitionFunction &partitionFunction, BuildDepthType buildDepth=NetworkBuildDepth::Full)
 
 GraphEngine (const fourdst::composition::Composition &composition, const partition::PartitionFunction &partitionFunction, BuildDepthType buildDepth, NetworkConstructionFlags reactionTypes)
 
 GraphEngine (const reaction::ReactionSet &reactions)
 Constructs a GraphEngine from a set of reactions.
 
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 rate.
 
std::expected< StepDerivatives< double >, EngineStatus > calculateRHSAndEnergy (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const reaction::ReactionSet &activeReactions) const
 Calculates the right-hand side (dY/dt) and energy generation rate for a subset of reactions.
 
EnergyDerivatives calculateEpsDerivatives (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
 Calculates the derivatives of the energy generation rate with respect to temperature and density.
 
EnergyDerivatives calculateEpsDerivatives (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const reaction::ReactionSet &activeReactions) const
 Calculates the derivatives of the energy generation rate with respect to temperature and density for a subset of reactions.
 
NetworkJacobian generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
 Generates the Jacobian matrix for the current state.
 
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 the current state with a specified set of active species. generally this will be much faster than the full matrix generation. Here we use forward mode to generate the Jacobian only for the active species.
 
NetworkJacobian generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const override
 Generates the Jacobian matrix for the current state with a specified sparsity pattern.
 
void generateStoichiometryMatrix () override
 Generates the stoichiometry matrix for the network.
 
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.
 
const std::vector< fourdst::atomic::Species > & getNetworkSpecies () const override
 Gets the list of species in the network.
 
const reaction::ReactionSet & getNetworkReactions () const override
 Gets the set of logical reactions in the network.
 
void setNetworkReactions (const reaction::ReactionSet &reactions) override
 Sets the reactions for the network.
 
int getStoichiometryMatrixEntry (const fourdst::atomic::Species &species, const reaction::Reaction &reaction) const override
 Gets an entry from the stoichiometry matrix.
 
std::expected< std::unordered_map< fourdst::atomic::Species, double >, engine::EngineStatus > getSpeciesTimescales (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
 Computes timescales for all species in the network.
 
std::expected< std::unordered_map< fourdst::atomic::Species, double >, EngineStatus > getSpeciesTimescales (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const reaction::ReactionSet &activeReactions) const
 Computes timescales for all species in the network considering a subset of reactions.
 
std::expected< std::unordered_map< fourdst::atomic::Species, double >, engine::EngineStatus > getSpeciesDestructionTimescales (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
 Computes destruction timescales for all 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 reaction::ReactionSet &activeReactions) const
 Computes destruction timescales for all species in the network considering a subset of reactions.
 
fourdst::composition::Composition update (const NetIn &netIn) override
 Updates the state of the network and the composition to be usable for the current network.
 
bool isStale (const NetIn &netIn) override
 Checks if the engine view is stale and needs to be updated.
 
bool involvesSpecies (const fourdst::atomic::Species &species) const
 Checks if a given species is involved in the network.
 
void exportToDot (const std::string &filename) const
 Exports the network to a DOT file for visualization.
 
void exportToCSV (const std::string &filename) const
 Exports the network to a CSV file for analysis.
 
void setScreeningModel (screening::ScreeningType model) override
 Sets the electron screening model for reaction rate calculations.
 
screening::ScreeningType getScreeningModel () const override
 Gets the current electron screening model.
 
void setPrecomputation (bool precompute)
 Sets whether to precompute reaction rates.
 
bool isPrecomputationEnabled () const
 Checks if precomputation of reaction rates is enabled.
 
const partition::PartitionFunction & getPartitionFunction () const
 Gets the partition function used for reaction rate calculations.
 
double calculateReverseRate (const reaction::Reaction &reaction, double T9, double rho, const fourdst::composition::CompositionAbstract &comp) const
 Calculates the reverse rate for a given reaction.
 
double calculateReverseRateTwoBody (const reaction::Reaction &reaction, double T9, double forwardRate, double expFactor) const
 Calculates the reverse rate for a two-body reaction.
 
double calculateReverseRateTwoBodyDerivative (const reaction::Reaction &reaction, double T9, double rho, const fourdst::composition::Composition &comp, double reverseRate) const
 Calculates the derivative of the reverse rate for a two-body reaction with respect to temperature.
 
bool isUsingReverseReactions () const
 Checks if reverse reactions are enabled.
 
void setUseReverseReactions (bool useReverse)
 Sets whether to use reverse reactions in the engine.
 
size_t getSpeciesIndex (const fourdst::atomic::Species &species) const override
 Gets the index of a species in the network.
 
std::vector< double > mapNetInToMolarAbundanceVector (const NetIn &netIn) const override
 Maps the NetIn object to a vector of molar abundances.
 
PrimingReport primeEngine (const NetIn &netIn) override
 Prepares the engine for calculations with initial conditions.
 
BuildDepthType getDepth () const override
 Gets the depth of the network.
 
void rebuild (const fourdst::composition::CompositionAbstract &comp, BuildDepthType depth) override
 Rebuilds the reaction network based on a new composition.
 
fourdst::composition::Composition collectComposition (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
 This will return the input comp with the molar abundances of any species not registered in that but registered in the engine active species set to 0.0.
 
SpeciesStatus getSpeciesStatus (const fourdst::atomic::Species &species) const override
 Gets the status of a species in the network.
 
template<IsArithmeticOrAD T>
StepDerivatives< T > calculateAllDerivatives (const std::vector< T > &Y_in, const T T9, const T rho, const T Ye, const T mue, const std::function< std::optional< size_t >(const fourdst::atomic::Species &)> speciesLookup, const std::function< bool(const reaction::Reaction &)> &reactionLookup) const
 
- Public Member Functions inherited from gridfire::engine::Engine
virtual ~Engine ()=default
 Virtual destructor.
 
+ + + + +

+Static Public Member Functions

static std::unordered_map< fourdst::atomic::Species, int > getNetReactionStoichiometry (const reaction::Reaction &reaction)
 Gets the net stoichiometry for a given reaction.
 
+ + + +

+Private Types

enum class  JacobianMatrixState { UNINITIALIZED +, STALE +, READY_DENSE +, READY_SPARSE + }
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Private Member Functions

void syncInternalMaps ()
 Synchronizes the internal maps.
 
void collectNetworkSpecies ()
 Collects the unique species in the network.
 
void populateReactionIDMap ()
 Populates the reaction ID map.
 
void populateSpeciesToIndexMap ()
 Populates the species-to-index map.
 
void recordADTape () const
 Records the AD tape for the right-hand side of the ODE.
 
void collectAtomicReverseRateAtomicBases ()
 
void precomputeNetwork ()
 
bool validateConservation () const
 Validates mass and charge conservation across all reactions.
 
StepDerivatives< double > calculateAllDerivativesUsingPrecomputation (const fourdst::composition::CompositionAbstract &comp, const std::vector< double > &bare_rates, const std::vector< double > &bare_reverse_rates, double T9, double rho, const reaction::ReactionSet &activeReactions) const
 
template<IsArithmeticOrAD T>
T calculateMolarReactionFlow (const reaction::Reaction &reaction, const std::vector< T > &Y, T T9, T rho, T Ye, T mue, const std::function< std::optional< size_t >(const fourdst::atomic::Species &)> &speciesIDLookup) const
 Calculates the molar reaction flow for a given reaction.
 
template<IsArithmeticOrAD T>
T calculateReverseMolarReactionFlow (T T9, T rho, std::vector< T > screeningFactors, const std::vector< T > &Y, size_t reactionIndex, const reaction::Reaction &reaction) const
 
template<IsArithmeticOrAD T>
StepDerivatives< T > calculateAllDerivatives (const std::vector< T > &Y_in, T T9, T rho, T Ye, T mue, std::function< std::optional< size_t >(const fourdst::atomic::Species &)> speciesLookup, const std::function< bool(const reaction::Reaction &)> &reactionLookup) const
 Calculates all derivatives (dY/dt) and the energy generation rate.
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Private Attributes

std::unordered_map< JacobianMatrixState, std::string > m_jacobianMatrixStateNameMap
 
Config & m_config = Config::getInstance()
 
quill::Logger * m_logger = LogManager::getInstance().getLogger("log")
 
constants m_constants
 
rates::weak::WeakRateInterpolator m_weakRateInterpolator
 Interpolator for weak reaction rates.
 
reaction::ReactionSet m_reactions
 Set of REACLIB reactions in the network.
 
std::unordered_map< std::string_view, reaction::Reaction * > m_reactionIDMap
 Map from reaction ID to REACLIBReaction. //PERF: This makes copies of REACLIBReaction and could be a performance bottleneck.
 
std::vector< fourdst::atomic::Species > m_networkSpecies
 Vector of unique species in the network.
 
std::unordered_map< std::string_view, fourdst::atomic::Species > m_networkSpeciesMap
 Map from species name to Species object.
 
std::unordered_map< fourdst::atomic::Species, size_t > m_speciesToIndexMap
 Map from species to their index in the stoichiometry matrix.
 
std::unordered_map< size_t, fourdst::atomic::Species > m_indexToSpeciesMap
 Map from index to species in the stoichiometry matrix.
 
CppAD::ADFun< double > m_rhsADFun
 CppAD function for the right-hand side of the ODE.
 
CppAD::ADFun< double > m_epsADFun
 CppAD function for the energy generation rate.
 
CppAD::sparse_jac_work m_jac_work
 Work object for sparse Jacobian calculations.
 
bool m_has_been_primed = false
 Flag indicating if the engine has been primed.
 
CppAD::sparse_rc< std::vector< size_t > > m_full_jacobian_sparsity_pattern
 Full sparsity pattern for the Jacobian matrix.
 
std::set< std::pair< size_t, size_t > > m_full_sparsity_set
 For quick lookups of the base sparsity pattern.
 
std::vector< std::unique_ptr< AtomicReverseRate > > m_atomicReverseRates
 
screening::ScreeningType m_screeningType = screening::ScreeningType::BARE
 Screening type for the reaction network. Default to no screening.
 
std::unique_ptr< screening::ScreeningModel > m_screeningModel = screening::selectScreeningModel(m_screeningType)
 
bool m_usePrecomputation = true
 Flag to enable or disable using precomputed reactions for efficiency. Mathematically, this should not change the results. Generally end users should not need to change this.
 
bool m_useReverseReactions = true
 Flag to enable or disable reverse reactions. If false, only forward reactions are considered.
 
BuildDepthType m_depth
 
std::vector< PrecomputedReaction > m_precomputedReactions
 Precomputed reactions for efficiency.
 
std::unordered_map< uint64_t, size_t > m_precomputedReactionIndexMap
 Set of hashed precomputed reactions for quick lookup.
 
std::unique_ptr< partition::PartitionFunction > m_partitionFunction
 Partition function for the network.
 
+

Detailed Description

+

A reaction network engine that uses a graph-based representation.

+

The GraphEngine class implements the DynamicEngine interface using a graph-based representation of the reaction network. It uses sparse matrices for efficient storage and computation of the stoichiometry and Jacobian matrices. Automatic differentiation (AD) is used to calculate the Jacobian matrix.

+

The engine supports:

    +
  • Calculation of the right-hand side (dY/dt) and energy generation rate.
    • +
  • Generation and access to the Jacobian matrix.
    • +
  • Generation and access to the stoichiometry matrix.
    • +
  • Calculation of molar reaction flows.
    • +
  • Access to the set of logical reactions in the network.
    • +
  • Computation of timescales for each species.
    • +
  • Exporting the network to DOT and CSV formats for visualization and analysis.
    • +
+
See also
engine_abstract.h
+

Member Enumeration Documentation

+ +

◆ JacobianMatrixState

+ +
+
+ + + + + +
+ + + + +
enum class gridfire::engine::GraphEngine::JacobianMatrixState
+ 		+strongprivate
+
+ + + + + +
Enumerator
UNINITIALIZED 
STALE 
READY_DENSE 
READY_SPARSE 
+ +
+
+

Constructor & Destructor Documentation

+ +

◆ GraphEngine() [1/4]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
gridfire::engine::GraphEngine::GraphEngine (const fourdst::composition::Composition & composition,
BuildDepthType buildDepth = NetworkBuildDepth::Full 
)
+ 		+explicit
+
+ +

Constructs a GraphEngine from a composition.

+
Parameters
+ + +
compositionThe composition of the material.
+
+
+

This constructor builds the reaction network from the given composition using the build_reaclib_nuclear_network function.

+
See also
build_reaclib_nuclear_network
+ +
+
+ +

◆ GraphEngine() [2/4]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
gridfire::engine::GraphEngine::GraphEngine (const fourdst::composition::Composition & composition,
const partition::PartitionFunction & partitionFunction,
BuildDepthType buildDepth = NetworkBuildDepth::Full 
)
+ 		+explicit
+
+ +
+
+ +

◆ GraphEngine() [3/4]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
gridfire::engine::GraphEngine::GraphEngine (const fourdst::composition::Composition & composition,
const partition::PartitionFunction & partitionFunction,
BuildDepthType buildDepth,
NetworkConstructionFlags reactionTypes 
)
+ 		+explicit
+
+ +
+
+ +

◆ GraphEngine() [4/4]

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::engine::GraphEngine::GraphEngine (const reaction::ReactionSet & reactions)
+ 		+explicit
+
+ +

Constructs a GraphEngine from a set of reactions.

+
Parameters
+ + +
reactionsThe set of reactions to use in the network.
+
+
+

This constructor uses the given set of reactions to construct the reaction network.

+ +
+
+

Member Function Documentation

+ +

◆ calculateAllDerivatives() [1/2]

+ +
+
+
+template<IsArithmeticOrAD T>
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StepDerivatives< T > gridfire::engine::GraphEngine::calculateAllDerivatives (const std::vector< T > & Y_in,
const T T9,
const T rho,
const T Ye,
const T mue,
const std::function< std::optional< size_t >(const fourdst::atomic::Species &)> speciesLookup,
const std::function< bool(const reaction::Reaction &)> & reactionLookup 
) const
+
+ +
+
+ +

◆ calculateAllDerivatives() [2/2]

+ +
+
+
+template<IsArithmeticOrAD T>
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StepDerivatives< T > gridfire::engine::GraphEngine::calculateAllDerivatives (const std::vector< T > & Y_in,
T T9,
T rho,
T Ye,
T mue,
std::function< std::optional< size_t >(const fourdst::atomic::Species &)> speciesLookup,
const std::function< bool(const reaction::Reaction &)> & reactionLookup 
) const
+ 		+private
+
+ +

Calculates all derivatives (dY/dt) and the energy generation rate.

+
Template Parameters
+ + +
TThe numeric type to use for the calculation.
+
+
+
Parameters
+ + + + + + + + +
Y_inVector of molar abundances for all species in the network.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
Ye
mue
speciesLookup
reactionLookup
+
+
+
Returns
StepDerivatives<T> containing dY/dt and energy generation rate.
+

This method calculates the time derivatives of all species and the specific nuclear energy generation rate for the current state.

+ +
+
+ +

◆ calculateAllDerivativesUsingPrecomputation()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StepDerivatives< double > gridfire::engine::GraphEngine::calculateAllDerivativesUsingPrecomputation (const fourdst::composition::CompositionAbstract & comp,
const std::vector< double > & bare_rates,
const std::vector< double > & bare_reverse_rates,
double T9,
double rho,
const reaction::ReactionSet & activeReactions 
) const
+ 		+private
+
+ +
+
+ +

◆ calculateEpsDerivatives() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
EnergyDerivatives gridfire::engine::GraphEngine::calculateEpsDerivatives (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Calculates the derivatives of the energy generation rate with respect to temperature and density.

+
Parameters
+ + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
EnergyDerivatives struct containing the derivatives.
+

This method computes the partial derivatives of the specific nuclear energy generation rate with respect to temperature (∂ε/∂T) and density (∂ε/∂ρ)

+
See also
EnergyDerivatives
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ calculateEpsDerivatives() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
EnergyDerivatives gridfire::engine::GraphEngine::calculateEpsDerivatives (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho,
const reaction::ReactionSet & activeReactions 
) const
+
+ +

Calculates the derivatives of the energy generation rate with respect to temperature and density for a subset of reactions.

+
Parameters
+ + + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
activeReactionsThe set of reactions to include in the calculation.
+
+
+
Returns
EnergyDerivatives struct containing the derivatives.
+

This method computes the partial derivatives of the specific nuclear energy generation rate with respect to temperature (∂ε/∂T) and density (∂ε/∂ρ) considering only the specified subset of reactions. This allows for flexible calculations with different reaction sets without modifying the engine's internal state.

+
See also
EnergyDerivatives
+ +
+
+ +

◆ calculateMolarReactionFlow() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::engine::GraphEngine::calculateMolarReactionFlow (const reaction::Reaction & reaction,
const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Calculates the molar reaction flow for a given reaction.

+
Parameters
+ + + + + +
reactionThe reaction for which to calculate the flow.
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
Molar flow rate for the reaction (e.g., mol/g/s).
+

This method computes the net rate at which the given reaction proceeds under the current state.

+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ calculateMolarReactionFlow() [2/2]

+ +
+
+
+template<IsArithmeticOrAD T>
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
T gridfire::engine::GraphEngine::calculateMolarReactionFlow (const reaction::Reaction & reaction,
const std::vector< T > & Y,
T T9,
T rho,
T Ye,
T mue,
const std::function< std::optional< size_t >(const fourdst::atomic::Species &)> & speciesIDLookup 
) const
+ 		+private
+
+ +

Calculates the molar reaction flow for a given reaction.

+
Template Parameters
+ + +
TThe numeric type to use for the calculation.
+
+
+
Parameters
+ + + + + + + + +
reactionThe reaction for which to calculate the flow.
YVector of molar abundances for all species in the network.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
Ye
mue
speciesIDLookup
+
+
+
Returns
Molar flow rate for the reaction (e.g., mol/g/s).
+

This method computes the net rate at which the given reaction proceeds under the current state.

+ +
+
+ +

◆ calculateReverseMolarReactionFlow()

+ +
+
+
+template<IsArithmeticOrAD T>
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
T gridfire::engine::GraphEngine::calculateReverseMolarReactionFlow (T T9,
T rho,
std::vector< T > screeningFactors,
const std::vector< T > & Y,
size_t reactionIndex,
const reaction::Reaction & reaction 
) const
+ 		+private
+
+ +
+
+ +

◆ calculateReverseRate()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::engine::GraphEngine::calculateReverseRate (const reaction::Reaction & reaction,
double T9,
double rho,
const fourdst::composition::CompositionAbstract & comp 
) const
+
+ +

Calculates the reverse rate for a given reaction.

+
Parameters
+ + + + + +
reactionThe reaction for which to calculate the reverse rate.
T9Temperature in units of 10^9 K.
rho
compComposition object containing current abundances.
+
+
+
Returns
Reverse rate for the reaction (e.g., mol/g/s).
+

This method computes the reverse rate based on the forward rate and thermodynamic properties of the reaction.

+ +
+
+ +

◆ calculateReverseRateTwoBody()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::engine::GraphEngine::calculateReverseRateTwoBody (const reaction::Reaction & reaction,
double T9,
double forwardRate,
double expFactor 
) const
+
+ +

Calculates the reverse rate for a two-body reaction.

+
Parameters
+ + + + + +
reactionThe reaction for which to calculate the reverse rate.
T9Temperature in units of 10^9 K.
forwardRateThe forward rate of the reaction.
expFactorExponential factor for the reaction.
+
+
+
Returns
Reverse rate for the two-body reaction (e.g., mol/g/s).
+

This method computes the reverse rate using the forward rate and thermodynamic properties of the reaction.

+ +
+
+ +

◆ calculateReverseRateTwoBodyDerivative()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::engine::GraphEngine::calculateReverseRateTwoBodyDerivative (const reaction::Reaction & reaction,
double T9,
double rho,
const fourdst::composition::Composition & comp,
double reverseRate 
) const
+
+ +

Calculates the derivative of the reverse rate for a two-body reaction with respect to temperature.

+
Parameters
+ + + + + + +
reactionThe reaction for which to calculate the derivative.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
compComposition object containing current abundances.
reverseRateThe reverse rate of the reaction.
+
+
+
Returns
Derivative of the reverse rate with respect to temperature.
+

This method computes the derivative of the reverse rate using automatic differentiation.

+ +
+
+ +

◆ calculateRHSAndEnergy() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
std::expected< StepDerivatives< double >, EngineStatus > gridfire::engine::GraphEngine::calculateRHSAndEnergy (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Calculates the right-hand side (dY/dt) and energy generation rate.

+
Parameters
+ + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
StepDerivatives<double> containing dY/dt and energy generation rate.
+

This method calculates the time derivatives of all species and the specific nuclear energy generation rate for the current state.

+
See also
StepDerivatives
+ +

Implements gridfire::engine::Engine.

+ +
+
+ +

◆ calculateRHSAndEnergy() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::expected< StepDerivatives< double >, EngineStatus > gridfire::engine::GraphEngine::calculateRHSAndEnergy (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho,
const reaction::ReactionSet & activeReactions 
) const
+
+ +

Calculates the right-hand side (dY/dt) and energy generation rate for a subset of reactions.

+
Parameters
+ + + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
activeReactionsThe set of reactions to include in the calculation.
+
+
+
Returns
StepDerivatives<double> containing dY/dt and energy generation rate.
+

This method calculates the time derivatives of all species and the specific nuclear energy generation rate considering only the specified subset of reactions. This allows for flexible calculations with different reaction sets without modifying the engine's internal state.

+
See also
StepDerivatives
+ +
+
+ +

◆ collectAtomicReverseRateAtomicBases()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::engine::GraphEngine::collectAtomicReverseRateAtomicBases ()
+ 		+private
+
+ +
+
+ +

◆ collectComposition()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
fourdst::composition::Composition gridfire::engine::GraphEngine::collectComposition (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

This will return the input comp with the molar abundances of any species not registered in that but registered in the engine active species set to 0.0.

+
Note
Effectively this method does not change input composition; rather it ensures that all species which can be tracked by an instance of GraphEngine are registered in the composition object.
+
+If a species is in the input comp but not in the network
+
Parameters
+ + + + + + +
compInput Composition
T9
rho
T9
rho
+
+
+
Returns
A new composition where all members of the active species set are registered. And any members not in comp have a molar abundance set to 0.
+
Exceptions
+ + +
BadCollectionErrorIf the input composition contains species not present in the network species set
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ collectNetworkSpecies()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::engine::GraphEngine::collectNetworkSpecies ()
+ 		+private
+
+ +

Collects the unique species in the network.

+

This method collects the unique species in the network from the reactants and products of all reactions.

+ +
+
+ +

◆ exportToCSV()

+ +
+
+ + + + + + + + +
void gridfire::engine::GraphEngine::exportToCSV (const std::string & filename) const
+
+ +

Exports the network to a CSV file for analysis.

+
Parameters
+ + +
filenameThe name of the CSV file to create.
+
+
+

This method generates a CSV file containing information about the reactions in the network, including the reactants, products, Q-value, and reaction rate coefficients.

+
Exceptions
+ + +
std::runtime_errorIf the file cannot be opened for writing.
+
+
+

Example usage:

engine.exportToCSV("network.csv");
+
+
+
+ +

◆ exportToDot()

+ +
+
+ + + + + + + + +
void gridfire::engine::GraphEngine::exportToDot (const std::string & filename) const
+
+ +

Exports the network to a DOT file for visualization.

+
Parameters
+ + +
filenameThe name of the DOT file to create.
+
+
+

This method generates a DOT file that can be used to visualize the reaction network as a graph. The DOT file can be converted to a graphical image using Graphviz.

+
Exceptions
+ + +
std::runtime_errorIf the file cannot be opened for writing.
+
+
+

Example usage:

engine.exportToDot("network.dot");
+
+
+
+ +

◆ generateJacobianMatrix() [1/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
NetworkJacobian gridfire::engine::GraphEngine::generateJacobianMatrix (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Generates the Jacobian matrix for the current state.

+
Parameters
+ + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+

This method computes and stores the Jacobian matrix (∂(dY/dt)_i/∂Y_j) for the current state using automatic differentiation. The matrix can then be accessed via getJacobianMatrixEntry().

+
See also
getJacobianMatrixEntry()
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ generateJacobianMatrix() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NetworkJacobian gridfire::engine::GraphEngine::generateJacobianMatrix (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho,
const SparsityPattern & sparsityPattern 
) const
+ 		+overridevirtual
+
+ +

Generates the Jacobian matrix for the current state with a specified sparsity pattern.

+
Parameters
+ + + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
sparsityPatternThe sparsity pattern to use for the Jacobian matrix.
+
+
+

This method computes and stores the Jacobian matrix (∂(dY/dt)_i/∂Y_j) for the current state using automatic differentiation, taking into account the provided sparsity pattern. The matrix can then be accessed via getJacobianMatrixEntry().

+
See also
getJacobianMatrixEntry()
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ generateJacobianMatrix() [3/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NetworkJacobian gridfire::engine::GraphEngine::generateJacobianMatrix (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho,
const std::vector< fourdst::atomic::Species > & activeSpecies 
) const
+ 		+overridevirtual
+
+ +

Generates the Jacobian matrix for the current state with a specified set of active species. generally this will be much faster than the full matrix generation. Here we use forward mode to generate the Jacobian only for the active species.

+
Parameters
+ + + + + +
compThe Composition object containing current abundances.
T9The temperature in units of 10^9 K.
rhoThe density in g/cm^3.
activeSpeciesA vector of Species objects representing the active species.
+
+
+
See also
getJacobianMatrixEntry()
+
+generateJacobianMatrix()
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ generateStoichiometryMatrix()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::engine::GraphEngine::generateStoichiometryMatrix ()
+ 		+overridevirtual
+
+ +

Generates the stoichiometry matrix for the network.

+

This method computes and stores the stoichiometry matrix, which encodes the net change of each species in each reaction.

+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getDepth()

+ +
+
+ + + + + +
+ + + + + + + +
BuildDepthType gridfire::engine::GraphEngine::getDepth () const
+ 		+overridevirtual
+
+ +

Gets the depth of the network.

+
Returns
The build depth of the network.
+

This method returns the current build depth of the reaction network, which indicates how many levels of reactions are included in the network.

+ +

Reimplemented from gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getNetReactionStoichiometry()

+ +
+
+ + + + + +
+ + + + + + + + +
std::unordered_map< fourdst::atomic::Species, int > gridfire::engine::GraphEngine::getNetReactionStoichiometry (const reaction::Reaction & reaction)
+ 		+static
+
+ +

Gets the net stoichiometry for a given reaction.

+
Parameters
+ + +
reactionThe reaction for which to get the stoichiometry.
+
+
+
Returns
Map of species to their stoichiometric coefficients.
+ +
+
+ +

◆ getNetworkReactions()

+ +
+
+ + + + + +
+ + + + + + + +
const reaction::ReactionSet & gridfire::engine::GraphEngine::getNetworkReactions () const
+ 		+overridevirtual
+
+ +

Gets the set of logical reactions in the network.

+
Returns
Reference to the LogicalReactionSet containing all reactions.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getNetworkSpecies()

+ +
+
+ + + + + +
+ + + + + + + +
const std::vector< fourdst::atomic::Species > & gridfire::engine::GraphEngine::getNetworkSpecies () const
+ 		+overridevirtual
+
+ +

Gets the list of species in the network.

+
Returns
Vector of Species objects representing all network species.
+ +

Implements gridfire::engine::Engine.

+ +
+
+ +

◆ getPartitionFunction()

+ +
+
+ + + + + + + +
const partition::PartitionFunction & gridfire::engine::GraphEngine::getPartitionFunction () const
+
+ +

Gets the partition function used for reaction rate calculations.

+
Returns
Reference to the PartitionFunction object.
+

This method provides access to the partition function used in the engine, which is essential for calculating thermodynamic properties and reaction rates.

+ +
+
+ +

◆ getScreeningModel()

+ +
+
+ + + + + +
+ + + + + + + +
screening::ScreeningType gridfire::engine::GraphEngine::getScreeningModel () const
+ 		+overridevirtual
+
+ +

Gets the current electron screening model.

+
Returns
The currently active screening model type.
+

Example usage:

screening::ScreeningType currentModel = engine.getScreeningModel();
+
gridfire::screening::ScreeningType
ScreeningType
Enumerates the available plasma screening models.
Definition screening_types.h:15
+
+

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getSpeciesDestructionTimescales() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
std::expected< std::unordered_map< fourdst::atomic::Species, double >, EngineStatus > gridfire::engine::GraphEngine::getSpeciesDestructionTimescales (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Computes destruction timescales for all species in the network.

+
Parameters
+ + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
Map from Species to their destruction timescales (s).
+

This method estimates the destruction timescale for each species, which can be useful for understanding reaction flows and equilibrium states.

+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getSpeciesDestructionTimescales() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::expected< std::unordered_map< fourdst::atomic::Species, double >, EngineStatus > gridfire::engine::GraphEngine::getSpeciesDestructionTimescales (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho,
const reaction::ReactionSet & activeReactions 
) const
+
+ +

Computes destruction timescales for all species in the network considering a subset of reactions.

+
Parameters
+ + + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
activeReactionsThe set of reactions to include in the calculation.
+
+
+
Returns
Map from Species to their destruction timescales (s).
+

This method estimates the destruction timescale for each species, considering only the specified subset of reactions. This allows for flexible calculations with different reaction sets without modifying the engine's internal state.

+ +
+
+ +

◆ getSpeciesIndex()

+ +
+
+ + + + + +
+ + + + + + + + +
size_t gridfire::engine::GraphEngine::getSpeciesIndex (const fourdst::atomic::Species & species) const
+ 		+overridevirtual
+
+ +

Gets the index of a species in the network.

+
Parameters
+ + +
speciesThe species for which to get the index.
+
+
+
Returns
Index of the species in the network, or -1 if not found.
+

This method returns the index of the given species in the network's species vector. If the species is not found, it returns -1.

+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getSpeciesStatus()

+ +
+
+ + + + + +
+ + + + + + + + +
SpeciesStatus gridfire::engine::GraphEngine::getSpeciesStatus (const fourdst::atomic::Species & species) const
+ 		+overridevirtual
+
+ +

Gets the status of a species in the network.

+
Parameters
+ + +
speciesThe species for which to get the status.
+
+
+
Returns
SpeciesStatus indicating the status of the species.
+

This method checks if the given species is part of the network and returns its status (e.g., Active, Inactive, NotFound).

+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getSpeciesTimescales() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
std::expected< std::unordered_map< fourdst::atomic::Species, double >, EngineStatus > gridfire::engine::GraphEngine::getSpeciesTimescales (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Computes timescales for all species in the network.

+
Parameters
+ + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
Map from Species to their characteristic timescales (s).
+

This method estimates the timescale for abundance change of each species, which can be used for timestep control or diagnostics.

+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getSpeciesTimescales() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::expected< std::unordered_map< fourdst::atomic::Species, double >, EngineStatus > gridfire::engine::GraphEngine::getSpeciesTimescales (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho,
const reaction::ReactionSet & activeReactions 
) const
+
+ +

Computes timescales for all species in the network considering a subset of reactions.

+
Parameters
+ + + + + +
compComposition object containing current abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
activeReactionsThe set of reactions to include in the calculation.
+
+
+
Returns
Map from Species to their characteristic timescales (s).
+

This method estimates the timescale for abundance change of each species, considering only the specified subset of reactions. This allows for flexible calculations with different reaction sets without modifying the engine's internal state.

+ +
+
+ +

◆ getStoichiometryMatrixEntry()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int gridfire::engine::GraphEngine::getStoichiometryMatrixEntry (const fourdst::atomic::Species & species,
const reaction::Reaction & reaction 
) const
+ 		+overridevirtual
+
+ +

Gets an entry from the stoichiometry matrix.

+
Parameters
+ + + +
speciesSpecies to look up stoichiometry for.
reactionReaction to find.
+
+
+
Returns
Stoichiometric coefficient for the species in the reaction.
+

The stoichiometry matrix must have been generated by generateStoichiometryMatrix().

+
See also
generateStoichiometryMatrix()
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ involvesSpecies()

+ +
+
+ + + + + + + + +
bool gridfire::engine::GraphEngine::involvesSpecies (const fourdst::atomic::Species & species) const
+
+ +

Checks if a given species is involved in the network.

+
Parameters
+ + +
speciesThe species to check.
+
+
+
Returns
True if the species is involved in the network, false otherwise.
+ +
+
+ +

◆ isPrecomputationEnabled()

+ +
+
+ + + + + + + +
bool gridfire::engine::GraphEngine::isPrecomputationEnabled () const
+
+ +

Checks if precomputation of reaction rates is enabled.

+
Returns
True if precomputation is enabled, false otherwise.
+

This method allows checking the current state of precomputation for reaction rates in the engine.

+ +
+
+ +

◆ isStale()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::engine::GraphEngine::isStale (const NetIn & netIn)
+ 		+overridevirtual
+
+ +

Checks if the engine view is stale and needs to be updated.

+
Parameters
+ + +
netInThe current network input (unused).
+
+
+
Returns
True if the view is stale, false otherwise.
+
Deprecated:
This method is deprecated and will be removed in future versions. Stale states are returned as part of the results of methods that require the ability to report them.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ isUsingReverseReactions()

+ +
+
+ + + + + + + +
bool gridfire::engine::GraphEngine::isUsingReverseReactions () const
+
+ +

Checks if reverse reactions are enabled.

+
Returns
True if reverse reactions are enabled, false otherwise.
+

This method allows checking whether the engine is configured to use reverse reactions in its calculations.

+ +
+
+ +

◆ mapNetInToMolarAbundanceVector()

+ +
+
+ + + + + +
+ + + + + + + + +
std::vector< double > gridfire::engine::GraphEngine::mapNetInToMolarAbundanceVector (const NetIn & netIn) const
+ 		+overridevirtual
+
+ +

Maps the NetIn object to a vector of molar abundances.

+
Parameters
+ + +
netInThe NetIn object containing the input conditions.
+
+
+
Returns
Vector of molar abundances corresponding to the species in the network.
+

This method converts the NetIn object into a vector of molar abundances for each species in the network, which can be used for further calculations.

+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ populateReactionIDMap()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::engine::GraphEngine::populateReactionIDMap ()
+ 		+private
+
+ +

Populates the reaction ID map.

+

This method populates the reaction ID map, which maps reaction IDs to REACLIBReaction objects.

+ +
+
+ +

◆ populateSpeciesToIndexMap()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::engine::GraphEngine::populateSpeciesToIndexMap ()
+ 		+private
+
+ +

Populates the species-to-index map.

+

This method populates the species-to-index map, which maps species to their index in the stoichiometry matrix.

+ +
+
+ +

◆ precomputeNetwork()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::engine::GraphEngine::precomputeNetwork ()
+ 		+private
+
+ +
+
+ +

◆ primeEngine()

+ +
+
+ + + + + +
+ + + + + + + + +
PrimingReport gridfire::engine::GraphEngine::primeEngine (const NetIn & netIn)
+ 		+overridevirtual
+
+ +

Prepares the engine for calculations with initial conditions.

+
Parameters
+ + +
netInThe input conditions for the network.
+
+
+
Returns
PrimingReport containing information about the priming process.
+

This method initializes the engine with the provided input conditions, setting up reactions, species, and precomputing necessary data.

+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ rebuild()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void gridfire::engine::GraphEngine::rebuild (const fourdst::composition::CompositionAbstract & comp,
BuildDepthType depth 
)
+ 		+overridevirtual
+
+ +

Rebuilds the reaction network based on a new composition.

+
Parameters
+ + + +
compThe new composition to use for rebuilding the network.
depthThe build depth to use for the network.
+
+
+

This method rebuilds the reaction network using the provided composition and build depth. It updates all internal data structures accordingly.

+ +

Reimplemented from gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ recordADTape()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::engine::GraphEngine::recordADTape () const
+ 		+private
+
+ +

Records the AD tape for the right-hand side of the ODE.

+

This method records the AD tape for the right-hand side of the ODE, which is used to calculate the Jacobian matrix using automatic differentiation.

+
Exceptions
+ + +
std::runtime_errorIf there are no species in the network.
+
+
+ +
+
+ +

◆ setNetworkReactions()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::engine::GraphEngine::setNetworkReactions (const reaction::ReactionSet & reactions)
+ 		+overridevirtual
+
+ +

Sets the reactions for the network.

+
Parameters
+ + +
reactionsThe set of reactions to use in the network.
+
+
+

This method replaces the current set of reactions in the network with the provided set. It marks the engine as stale, requiring regeneration of matrices and recalculation of rates.

+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ setPrecomputation()

+ +
+
+ + + + + + + + +
void gridfire::engine::GraphEngine::setPrecomputation (bool precompute)
+
+ +

Sets whether to precompute reaction rates.

+
Parameters
+ + +
precomputeTrue to enable precomputation, false to disable.
+
+
+

This method allows enabling or disabling precomputation of reaction rates for performance optimization. When enabled, reaction rates are computed once and stored for later use.

+
Postcondition
If precomputation is enabled, reaction rates will be precomputed and cached. If disabled, reaction rates will be computed on-the-fly as needed.
+ +
+
+ +

◆ setScreeningModel()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::engine::GraphEngine::setScreeningModel (screening::ScreeningType model)
+ 		+overridevirtual
+
+ +

Sets the electron screening model for reaction rate calculations.

+
Parameters
+ + +
modelThe type of screening model to use.
+
+
+

This method allows changing the screening model at runtime. Screening corrections account for the electrostatic shielding of nuclei by electrons, which affects reaction rates in dense stellar plasmas.

+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ setUseReverseReactions()

+ +
+
+ + + + + + + + +
void gridfire::engine::GraphEngine::setUseReverseReactions (bool useReverse)
+
+ +

Sets whether to use reverse reactions in the engine.

+
Parameters
+ + +
useReverseTrue to enable reverse reactions, false to disable.
+
+
+

This method allows enabling or disabling reverse reactions in the engine. If disabled, only forward reactions will be considered in calculations.

+
Postcondition
If reverse reactions are enabled, the engine will consider both forward and reverse reactions in its calculations. If disabled, only forward reactions will be considered.
+ +
+
+ +

◆ syncInternalMaps()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::engine::GraphEngine::syncInternalMaps ()
+ 		+private
+
+ +

Synchronizes the internal maps.

+

This method synchronizes the internal maps used by the engine, including the species map, reaction ID map, and species-to-index map. It also generates the stoichiometry matrix and records the AD tape.

+ +
+
+ +

◆ update()

+ +
+
+ + + + + +
+ + + + + + + + +
fourdst::composition::Composition gridfire::engine::GraphEngine::update (const NetIn & netIn)
+ 		+overridevirtual
+
+ +

Updates the state of the network and the composition to be usable for the current network.

+

For graph engine all this does is ensure that the returned composition has all the species in the network registered. if a species was already in the composition is will keep its abundance, otherwise it will be added with zero abundance.

+
Parameters
+ + +
netInThe input netIn to use, this includes the composition, temperature, and density
+
+
+
Returns
The updated composition that includes all species in the network.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ validateConservation()

+ +
+
+ + + + + +
+ + + + + + + +
bool gridfire::engine::GraphEngine::validateConservation () const
+ 		+private
+
+ +

Validates mass and charge conservation across all reactions.

+
Returns
True if all reactions conserve mass and charge, false otherwise.
+

This method checks that all reactions in the network conserve mass and charge. If any reaction does not conserve mass or charge, an error message is logged and false is returned.

+ +
+
+

Member Data Documentation

+ +

◆ m_atomicReverseRates

+ +
+
+ + + + + +
+ + + + +
std::vector<std::unique_ptr<AtomicReverseRate> > gridfire::engine::GraphEngine::m_atomicReverseRates
+ 		+private
+
+ +
+
+ +

◆ m_config

+ +
+
+ + + + + +
+ + + + +
Config& gridfire::engine::GraphEngine::m_config = Config::getInstance()
+ 		+private
+
+ +
+
+ +

◆ m_constants

+ +
+
+ + + + + +
+ + + + +
constants gridfire::engine::GraphEngine::m_constants
+ 		+private
+
+ +
+
+ +

◆ m_depth

+ +
+
+ + + + + +
+ + + + +
BuildDepthType gridfire::engine::GraphEngine::m_depth
+ 		+private
+
+ +
+
+ +

◆ m_epsADFun

+ +
+
+ + + + + +
+ + + + +
CppAD::ADFun<double> gridfire::engine::GraphEngine::m_epsADFun
+ 		+mutableprivate
+
+ +

CppAD function for the energy generation rate.

+ +
+
+ +

◆ m_full_jacobian_sparsity_pattern

+ +
+
+ + + + + +
+ + + + +
CppAD::sparse_rc<std::vector<size_t> > gridfire::engine::GraphEngine::m_full_jacobian_sparsity_pattern
+ 		+private
+
+ +

Full sparsity pattern for the Jacobian matrix.

+ +
+
+ +

◆ m_full_sparsity_set

+ +
+
+ + + + + +
+ + + + +
std::set<std::pair<size_t, size_t> > gridfire::engine::GraphEngine::m_full_sparsity_set
+ 		+private
+
+ +

For quick lookups of the base sparsity pattern.

+ +
+
+ +

◆ m_has_been_primed

+ +
+
+ + + + + +
+ + + + +
bool gridfire::engine::GraphEngine::m_has_been_primed = false
+ 		+private
+
+ +

Flag indicating if the engine has been primed.

+ +
+
+ +

◆ m_indexToSpeciesMap

+ +
+
+ + + + + +
+ + + + +
std::unordered_map<size_t, fourdst::atomic::Species> gridfire::engine::GraphEngine::m_indexToSpeciesMap
+ 		+private
+
+ +

Map from index to species in the stoichiometry matrix.

+ +
+
+ +

◆ m_jac_work

+ +
+
+ + + + + +
+ + + + +
CppAD::sparse_jac_work gridfire::engine::GraphEngine::m_jac_work
+ 		+mutableprivate
+
+ +

Work object for sparse Jacobian calculations.

+ +
+
+ +

◆ m_jacobianMatrixStateNameMap

+ +
+
+ + + + + +
+ + + + +
std::unordered_map<JacobianMatrixState, std::string> gridfire::engine::GraphEngine::m_jacobianMatrixStateNameMap
+ 		+private
+
+Initial value:
= {
+
{JacobianMatrixState::UNINITIALIZED, "Uninitialized"},
+
{JacobianMatrixState::STALE, "Stale"},
+
{JacobianMatrixState::READY_DENSE, "Ready (dense)"},
+
{JacobianMatrixState::READY_SPARSE, "Ready (sparse)"},
+
}
+ + + + +
+
+
+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::engine::GraphEngine::m_logger = LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +
+
+ +

◆ m_networkSpecies

+ +
+
+ + + + + +
+ + + + +
std::vector<fourdst::atomic::Species> gridfire::engine::GraphEngine::m_networkSpecies
+ 		+private
+
+ +

Vector of unique species in the network.

+ +
+
+ +

◆ m_networkSpeciesMap

+ +
+
+ + + + + +
+ + + + +
std::unordered_map<std::string_view, fourdst::atomic::Species> gridfire::engine::GraphEngine::m_networkSpeciesMap
+ 		+private
+
+ +

Map from species name to Species object.

+ +
+
+ +

◆ m_partitionFunction

+ +
+
+ + + + + +
+ + + + +
std::unique_ptr<partition::PartitionFunction> gridfire::engine::GraphEngine::m_partitionFunction
+ 		+private
+
+ +

Partition function for the network.

+ +
+
+ +

◆ m_precomputedReactionIndexMap

+ +
+
+ + + + + +
+ + + + +
std::unordered_map<uint64_t, size_t> gridfire::engine::GraphEngine::m_precomputedReactionIndexMap
+ 		+private
+
+ +

Set of hashed precomputed reactions for quick lookup.

+ +
+
+ +

◆ m_precomputedReactions

+ +
+
+ + + + + +
+ + + + +
std::vector<PrecomputedReaction> gridfire::engine::GraphEngine::m_precomputedReactions
+ 		+private
+
+ +

Precomputed reactions for efficiency.

+ +
+
+ +

◆ m_reactionIDMap

+ +
+
+ + + + + +
+ + + + +
std::unordered_map<std::string_view, reaction::Reaction*> gridfire::engine::GraphEngine::m_reactionIDMap
+ 		+private
+
+ +

Map from reaction ID to REACLIBReaction. //PERF: This makes copies of REACLIBReaction and could be a performance bottleneck.

+ +
+
+ +

◆ m_reactions

+ +
+
+ + + + + +
+ + + + +
reaction::ReactionSet gridfire::engine::GraphEngine::m_reactions
+ 		+private
+
+ +

Set of REACLIB reactions in the network.

+ +
+
+ +

◆ m_rhsADFun

+ +
+
+ + + + + +
+ + + + +
CppAD::ADFun<double> gridfire::engine::GraphEngine::m_rhsADFun
+ 		+mutableprivate
+
+ +

CppAD function for the right-hand side of the ODE.

+ +
+
+ +

◆ m_screeningModel

+ +
+
+ + + + + +
+ + + + +
std::unique_ptr<screening::ScreeningModel> gridfire::engine::GraphEngine::m_screeningModel = screening::selectScreeningModel(m_screeningType)
+ 		+private
+
+ +
+
+ +

◆ m_screeningType

+ +
+
+ + + + + +
+ + + + +
screening::ScreeningType gridfire::engine::GraphEngine::m_screeningType = screening::ScreeningType::BARE
+ 		+private
+
+ +

Screening type for the reaction network. Default to no screening.

+ +
+
+ +

◆ m_speciesToIndexMap

+ +
+
+ + + + + +
+ + + + +
std::unordered_map<fourdst::atomic::Species, size_t> gridfire::engine::GraphEngine::m_speciesToIndexMap
+ 		+private
+
+ +

Map from species to their index in the stoichiometry matrix.

+ +
+
+ +

◆ m_usePrecomputation

+ +
+
+ + + + + +
+ + + + +
bool gridfire::engine::GraphEngine::m_usePrecomputation = true
+ 		+private
+
+ +

Flag to enable or disable using precomputed reactions for efficiency. Mathematically, this should not change the results. Generally end users should not need to change this.

+ +
+
+ +

◆ m_useReverseReactions

+ +
+
+ + + + + +
+ + + + +
bool gridfire::engine::GraphEngine::m_useReverseReactions = true
+ 		+private
+
+ +

Flag to enable or disable reverse reactions. If false, only forward reactions are considered.

+ +
+
+ +

◆ m_weakRateInterpolator

+ +
+
+ + + + + +
+ + + + +
rates::weak::WeakRateInterpolator gridfire::engine::GraphEngine::m_weakRateInterpolator
+ 		+private
+
+ +

Interpolator for weak reaction rates.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine.js b/docs/html/classgridfire_1_1engine_1_1GraphEngine.js new file mode 100644 index 00000000..c54d21fa --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine.js @@ -0,0 +1,95 @@ +var classgridfire_1_1engine_1_1GraphEngine = +[ + [ "AtomicReverseRate", "classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate.html", "classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate" ], + [ "constants", "structgridfire_1_1engine_1_1GraphEngine_1_1constants.html", "structgridfire_1_1engine_1_1GraphEngine_1_1constants" ], + [ "PrecomputedReaction", "structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction.html", "structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction" ], + [ "JacobianMatrixState", "classgridfire_1_1engine_1_1GraphEngine.html#a19305dc4affde99bb84056c9eeda9f1e", [ + [ "UNINITIALIZED", "classgridfire_1_1engine_1_1GraphEngine.html#a19305dc4affde99bb84056c9eeda9f1eadd652546039b18970b8dcf2cff824268", null ], + [ "STALE", "classgridfire_1_1engine_1_1GraphEngine.html#a19305dc4affde99bb84056c9eeda9f1ea4d855a061b3066dc14a3b12ed26b5456", null ], + [ "READY_DENSE", "classgridfire_1_1engine_1_1GraphEngine.html#a19305dc4affde99bb84056c9eeda9f1ea162cb379760275c9685281ee27025cdb", null ], + [ "READY_SPARSE", "classgridfire_1_1engine_1_1GraphEngine.html#a19305dc4affde99bb84056c9eeda9f1eabf43af1b1ac8bc6cb42296815a429ae3", null ] + ] ], + [ "GraphEngine", "classgridfire_1_1engine_1_1GraphEngine.html#a530a5563c5a7a76650edb1657868a289", null ], + [ "GraphEngine", "classgridfire_1_1engine_1_1GraphEngine.html#a885887bc4ff09c810e79eb68b79e7e2a", null ], + [ "GraphEngine", "classgridfire_1_1engine_1_1GraphEngine.html#ad73fec5f24f5ee74020ca70cdaa104e3", null ], + [ "GraphEngine", "classgridfire_1_1engine_1_1GraphEngine.html#a00f8aafa14ae665d8e556b35a7934587", null ], + [ "calculateAllDerivatives", "classgridfire_1_1engine_1_1GraphEngine.html#a23187ad3ee504de46f59e1644c715c9f", null ], + [ "calculateAllDerivatives", "classgridfire_1_1engine_1_1GraphEngine.html#a5970c97be4c7b5b764ce1155b5c7f870", null ], + [ "calculateAllDerivativesUsingPrecomputation", "classgridfire_1_1engine_1_1GraphEngine.html#abdd3ea788cbe3448b11969c7bbe09546", null ], + [ "calculateEpsDerivatives", "classgridfire_1_1engine_1_1GraphEngine.html#ac7e4624ed6eee72e7a8df42381d098bb", null ], + [ "calculateEpsDerivatives", "classgridfire_1_1engine_1_1GraphEngine.html#a194b03e287ec31348583f8d2078d4906", null ], + [ "calculateMolarReactionFlow", "classgridfire_1_1engine_1_1GraphEngine.html#aaff9cdc04ca01e7c927d36476bcf5da4", null ], + [ "calculateMolarReactionFlow", "classgridfire_1_1engine_1_1GraphEngine.html#aab80f2ab29ad9c7867e75e499148aa1f", null ], + [ "calculateReverseMolarReactionFlow", "classgridfire_1_1engine_1_1GraphEngine.html#a2e7012382ee44473478ebc37ac36695c", null ], + [ "calculateReverseRate", "classgridfire_1_1engine_1_1GraphEngine.html#a4dd5733c77e9a7ad8b5e541c187fabae", null ], + [ "calculateReverseRateTwoBody", "classgridfire_1_1engine_1_1GraphEngine.html#aa6b07108beeab1bc75c3099c25be7833", null ], + [ "calculateReverseRateTwoBodyDerivative", "classgridfire_1_1engine_1_1GraphEngine.html#a83ef40080c62d667b3fee71237efd2e0", null ], + [ "calculateRHSAndEnergy", "classgridfire_1_1engine_1_1GraphEngine.html#aee098a65f5cecded199d2c00422b398d", null ], + [ "calculateRHSAndEnergy", "classgridfire_1_1engine_1_1GraphEngine.html#ac77d4150b3b070a095fb65346968e51b", null ], + [ "collectAtomicReverseRateAtomicBases", "classgridfire_1_1engine_1_1GraphEngine.html#a5fadd1bb2692e1527ce24295c77cfc72", null ], + [ "collectComposition", "classgridfire_1_1engine_1_1GraphEngine.html#ae9d4d99c791876c012697fe5a0ba06c8", null ], + [ "collectNetworkSpecies", "classgridfire_1_1engine_1_1GraphEngine.html#a8f29c77e777fdc6517f2c7778537ba6f", null ], + [ "exportToCSV", "classgridfire_1_1engine_1_1GraphEngine.html#a2c0c50ba51537a2f565183e2f47eef69", null ], + [ "exportToDot", "classgridfire_1_1engine_1_1GraphEngine.html#a77d9755e68c81279316c96e6bb160ee4", null ], + [ "generateJacobianMatrix", "classgridfire_1_1engine_1_1GraphEngine.html#a9ca013f203d7a3ef9d1b9ee4b2982cb0", null ], + [ "generateJacobianMatrix", "classgridfire_1_1engine_1_1GraphEngine.html#ac4f9cd4e2304f681dd9af0f7b751cb81", null ], + [ "generateJacobianMatrix", "classgridfire_1_1engine_1_1GraphEngine.html#acc28ff627d46d8d4066a1acf830cbe27", null ], + [ "generateStoichiometryMatrix", "classgridfire_1_1engine_1_1GraphEngine.html#a2221feee40542efa1c07f01225bd3828", null ], + [ "getDepth", "classgridfire_1_1engine_1_1GraphEngine.html#ab29d6c4a7c789cf3d75767833c80c658", null ], + [ "getNetReactionStoichiometry", "classgridfire_1_1engine_1_1GraphEngine.html#a663fd2bd0eda255bc242c1dc6338bc11", null ], + [ "getNetworkReactions", "classgridfire_1_1engine_1_1GraphEngine.html#a749cc482a707cb3a38bdd5de894716e2", null ], + [ "getNetworkSpecies", "classgridfire_1_1engine_1_1GraphEngine.html#a8f5099bfda5f6d6e1494788beff9b7c8", null ], + [ "getPartitionFunction", "classgridfire_1_1engine_1_1GraphEngine.html#a4247cf6a551a7cbc951a733d3c31c325", null ], + [ "getScreeningModel", "classgridfire_1_1engine_1_1GraphEngine.html#a62c6f3bebe931bcd412fb492deb634a5", null ], + [ "getSpeciesDestructionTimescales", "classgridfire_1_1engine_1_1GraphEngine.html#ae026bc87dc8b24fd78d412ac7e58b148", null ], + [ "getSpeciesDestructionTimescales", "classgridfire_1_1engine_1_1GraphEngine.html#a0ea1eedfd79ccbd3d44241eadd65065b", null ], + [ "getSpeciesIndex", "classgridfire_1_1engine_1_1GraphEngine.html#ad67b0022cc783e63ae1954a04c4a68e1", null ], + [ "getSpeciesStatus", "classgridfire_1_1engine_1_1GraphEngine.html#afe93df16c69e7e10658c82874759dd2f", null ], + [ "getSpeciesTimescales", "classgridfire_1_1engine_1_1GraphEngine.html#a3c9b57d2842b6b5535313be845ca6175", null ], + [ "getSpeciesTimescales", "classgridfire_1_1engine_1_1GraphEngine.html#a2f196db621e81082430be117c72fa9d0", null ], + [ "getStoichiometryMatrixEntry", "classgridfire_1_1engine_1_1GraphEngine.html#aec867f0b43e74c8157f7d5085b55bb96", null ], + [ "involvesSpecies", "classgridfire_1_1engine_1_1GraphEngine.html#a147917aef40c3ec2751d742d3f862c70", null ], + [ "isPrecomputationEnabled", "classgridfire_1_1engine_1_1GraphEngine.html#ad031cc7869394bd37c0bb65d86153469", null ], + [ "isStale", "classgridfire_1_1engine_1_1GraphEngine.html#a07acc57c1015903ce3d1b0d0b7f09358", null ], + [ "isUsingReverseReactions", "classgridfire_1_1engine_1_1GraphEngine.html#a177a29cbdd8bae5a313cc391932a3cdd", null ], + [ "mapNetInToMolarAbundanceVector", "classgridfire_1_1engine_1_1GraphEngine.html#a915602acb18a69f34076bea401ffb49d", null ], + [ "populateReactionIDMap", "classgridfire_1_1engine_1_1GraphEngine.html#a6ccfb1813ce5b5c9568434f47e06726a", null ], + [ "populateSpeciesToIndexMap", "classgridfire_1_1engine_1_1GraphEngine.html#a7e5c8d9b996e5bc7fc130d34dd196a4b", null ], + [ "precomputeNetwork", "classgridfire_1_1engine_1_1GraphEngine.html#ac7814b9922c7fee4c5a2649127dcdadc", null ], + [ "primeEngine", "classgridfire_1_1engine_1_1GraphEngine.html#acc7f7fb7f0ef96135e7bda4bb532792e", null ], + [ "rebuild", "classgridfire_1_1engine_1_1GraphEngine.html#a6c5245a27da1b45e10fb410518b79d4e", null ], + [ "recordADTape", "classgridfire_1_1engine_1_1GraphEngine.html#a727ae752bcf5d6266a1cf3dedacf50fa", null ], + [ "setNetworkReactions", "classgridfire_1_1engine_1_1GraphEngine.html#a90251650123d0d8ce0281e18c4476f45", null ], + [ "setPrecomputation", "classgridfire_1_1engine_1_1GraphEngine.html#a0e0650a14247a7f43623d58de8eedb19", null ], + [ "setScreeningModel", "classgridfire_1_1engine_1_1GraphEngine.html#af842981deaf84a698b6cbfa66abcb715", null ], + [ "setUseReverseReactions", "classgridfire_1_1engine_1_1GraphEngine.html#a959928abbef89fd0a20264ef8b79c111", null ], + [ "syncInternalMaps", "classgridfire_1_1engine_1_1GraphEngine.html#a9af928bf8a5327d3cb45254c0e59f914", null ], + [ "update", "classgridfire_1_1engine_1_1GraphEngine.html#a7f6d98a9a4f22f1bbc015b1cbb8198e3", null ], + [ "validateConservation", "classgridfire_1_1engine_1_1GraphEngine.html#a87bf3a33fc21f7da2a26173ebdfa69f7", null ], + [ "m_atomicReverseRates", "classgridfire_1_1engine_1_1GraphEngine.html#ac02ff3a8828e281209013f5c564083d0", null ], + [ "m_config", "classgridfire_1_1engine_1_1GraphEngine.html#a903c99fc607b3e36f434ec2070c7344d", null ], + [ "m_constants", "classgridfire_1_1engine_1_1GraphEngine.html#aab2701ed1d1262071072175647674b43", null ], + [ "m_depth", "classgridfire_1_1engine_1_1GraphEngine.html#ae2fef545142356c7f2f2f5ae3cba6d90", null ], + [ "m_epsADFun", "classgridfire_1_1engine_1_1GraphEngine.html#a9087124f3e15614e76754a65d441ca08", null ], + [ "m_full_jacobian_sparsity_pattern", "classgridfire_1_1engine_1_1GraphEngine.html#a636caa7f8085153424e17dc6e343a326", null ], + [ "m_full_sparsity_set", "classgridfire_1_1engine_1_1GraphEngine.html#af68112da3edc1a8c88289b8e7242180e", null ], + [ "m_has_been_primed", "classgridfire_1_1engine_1_1GraphEngine.html#af794d0c7e7b78aebfbbf05381e3531a6", null ], + [ "m_indexToSpeciesMap", "classgridfire_1_1engine_1_1GraphEngine.html#aac9f28dd58bc0d40a643885c95c2ab52", null ], + [ "m_jac_work", "classgridfire_1_1engine_1_1GraphEngine.html#a81628fd98da5681396daab00ac573c6c", null ], + [ "m_jacobianMatrixStateNameMap", "classgridfire_1_1engine_1_1GraphEngine.html#a0a8d12341ecf52446faef9dd8c7dc81e", null ], + [ "m_logger", "classgridfire_1_1engine_1_1GraphEngine.html#a8a121839fe3a7a35e4214fd20e753f9f", null ], + [ "m_networkSpecies", "classgridfire_1_1engine_1_1GraphEngine.html#a544299e2495c6cac339b767e932e37b3", null ], + [ "m_networkSpeciesMap", "classgridfire_1_1engine_1_1GraphEngine.html#a3413c72ee010534a510160e38c3b2a0c", null ], + [ "m_partitionFunction", "classgridfire_1_1engine_1_1GraphEngine.html#a9f0e38be889a964d0b6e62934a1220db", null ], + [ "m_precomputedReactionIndexMap", "classgridfire_1_1engine_1_1GraphEngine.html#a6b4fe179421269045712cb417aa19eca", null ], + [ "m_precomputedReactions", "classgridfire_1_1engine_1_1GraphEngine.html#a08deff0296d504a23056e6f0382dc664", null ], + [ "m_reactionIDMap", "classgridfire_1_1engine_1_1GraphEngine.html#af7dab9063bb92aac64b6dfa755074739", null ], + [ "m_reactions", "classgridfire_1_1engine_1_1GraphEngine.html#a249a9237865b0cf6906b360e4cb7c1ec", null ], + [ "m_rhsADFun", "classgridfire_1_1engine_1_1GraphEngine.html#aac2420a91b43e1a949a48768e6f3b4f2", null ], + [ "m_screeningModel", "classgridfire_1_1engine_1_1GraphEngine.html#a3e91570fbffc48748ad352e4554a728b", null ], + [ "m_screeningType", "classgridfire_1_1engine_1_1GraphEngine.html#abdff5b7eeb73ed327ba6b758038ef776", null ], + [ "m_speciesToIndexMap", "classgridfire_1_1engine_1_1GraphEngine.html#a2421bbbdcc9fb02d9cb6e584da393c83", null ], + [ "m_usePrecomputation", "classgridfire_1_1engine_1_1GraphEngine.html#a1f4e11a70ce65d544e9800d552a65cc8", null ], + [ "m_useReverseReactions", "classgridfire_1_1engine_1_1GraphEngine.html#ac9a0d4d0eec32145bf8f2b688a1d988d", null ], + [ "m_weakRateInterpolator", "classgridfire_1_1engine_1_1GraphEngine.html#a4fd4daf4f4ef658e7c0617223a74d824", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate-members.html b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate-members.html new file mode 100644 index 00000000..92c311d3 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate-members.html @@ -0,0 +1,119 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::GraphEngine::AtomicReverseRate Member List
+
+
+ +

This is the complete list of members for gridfire::engine::GraphEngine::AtomicReverseRate, including all inherited members.

+ + + + + + + + + + +
AtomicReverseRate(const reaction::Reaction &reaction, const GraphEngine &engine)gridfire::engine::GraphEngine::AtomicReverseRateinline
for_sparse_jac(size_t q, const CppAD::vector< std::set< size_t > > &r, CppAD::vector< std::set< size_t > > &s) overridegridfire::engine::GraphEngine::AtomicReverseRate
for_sparse_jac(size_t q, const CppAD::vector< bool > &r, CppAD::vector< bool > &s, const CppAD::vector< double > &x) overridegridfire::engine::GraphEngine::AtomicReverseRate
forward(size_t p, size_t q, const CppAD::vector< bool > &vx, CppAD::vector< bool > &vy, const CppAD::vector< double > &tx, CppAD::vector< double > &ty) overridegridfire::engine::GraphEngine::AtomicReverseRate
m_enginegridfire::engine::GraphEngine::AtomicReverseRateprivate
m_reactiongridfire::engine::GraphEngine::AtomicReverseRateprivate
rev_sparse_jac(size_t q, const CppAD::vector< std::set< size_t > > &rt, CppAD::vector< std::set< size_t > > &st) overridegridfire::engine::GraphEngine::AtomicReverseRate
rev_sparse_jac(size_t q, const CppAD::vector< bool > &rt, CppAD::vector< bool > &st, const CppAD::vector< double > &x) overridegridfire::engine::GraphEngine::AtomicReverseRate
reverse(size_t q, const CppAD::vector< double > &tx, const CppAD::vector< double > &ty, CppAD::vector< double > &px, const CppAD::vector< double > &py) overridegridfire::engine::GraphEngine::AtomicReverseRate
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate.html b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate.html new file mode 100644 index 00000000..db961c9c --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate.html @@ -0,0 +1,528 @@ + + + + + + + +GridFire: gridfire::engine::GraphEngine::AtomicReverseRate Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
gridfire::engine::GraphEngine::AtomicReverseRate Class Referencefinal
+
+
+
+Inheritance diagram for gridfire::engine::GraphEngine::AtomicReverseRate:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::engine::GraphEngine::AtomicReverseRate:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + +

+Public Member Functions

 AtomicReverseRate (const reaction::Reaction &reaction, const GraphEngine &engine)
 
bool forward (size_t p, size_t q, const CppAD::vector< bool > &vx, CppAD::vector< bool > &vy, const CppAD::vector< double > &tx, CppAD::vector< double > &ty) override
 
bool reverse (size_t q, const CppAD::vector< double > &tx, const CppAD::vector< double > &ty, CppAD::vector< double > &px, const CppAD::vector< double > &py) override
 
bool for_sparse_jac (size_t q, const CppAD::vector< std::set< size_t > > &r, CppAD::vector< std::set< size_t > > &s) override
 
bool rev_sparse_jac (size_t q, const CppAD::vector< std::set< size_t > > &rt, CppAD::vector< std::set< size_t > > &st) override
 
bool for_sparse_jac (size_t q, const CppAD::vector< bool > &r, CppAD::vector< bool > &s, const CppAD::vector< double > &x) override
 
bool rev_sparse_jac (size_t q, const CppAD::vector< bool > &rt, CppAD::vector< bool > &st, const CppAD::vector< double > &x) override
 
+ + + + + +

+Private Attributes

const reaction::Reaction & m_reaction
 
const GraphEngine & m_engine
 
+

Constructor & Destructor Documentation

+ +

◆ AtomicReverseRate()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
gridfire::engine::GraphEngine::AtomicReverseRate::AtomicReverseRate (const reaction::Reaction & reaction,
const GraphEngine & engine 
)
+ 		+inline
+
+ +
+
+

Member Function Documentation

+ +

◆ for_sparse_jac() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
bool gridfire::engine::GraphEngine::AtomicReverseRate::for_sparse_jac (size_t q,
const CppAD::vector< bool > & r,
CppAD::vector< bool > & s,
const CppAD::vector< double > & x 
)
+ 		+override
+
+ +
+
+ +

◆ for_sparse_jac() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool gridfire::engine::GraphEngine::AtomicReverseRate::for_sparse_jac (size_t q,
const CppAD::vector< std::set< size_t > > & r,
CppAD::vector< std::set< size_t > > & s 
)
+ 		+override
+
+ +
+
+ +

◆ forward()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
bool gridfire::engine::GraphEngine::AtomicReverseRate::forward (size_t p,
size_t q,
const CppAD::vector< bool > & vx,
CppAD::vector< bool > & vy,
const CppAD::vector< double > & tx,
CppAD::vector< double > & ty 
)
+ 		+override
+
+ +
+
+ +

◆ rev_sparse_jac() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
bool gridfire::engine::GraphEngine::AtomicReverseRate::rev_sparse_jac (size_t q,
const CppAD::vector< bool > & rt,
CppAD::vector< bool > & st,
const CppAD::vector< double > & x 
)
+ 		+override
+
+ +
+
+ +

◆ rev_sparse_jac() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool gridfire::engine::GraphEngine::AtomicReverseRate::rev_sparse_jac (size_t q,
const CppAD::vector< std::set< size_t > > & rt,
CppAD::vector< std::set< size_t > > & st 
)
+ 		+override
+
+ +
+
+ +

◆ reverse()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
bool gridfire::engine::GraphEngine::AtomicReverseRate::reverse (size_t q,
const CppAD::vector< double > & tx,
const CppAD::vector< double > & ty,
CppAD::vector< double > & px,
const CppAD::vector< double > & py 
)
+ 		+override
+
+ +
+
+

Member Data Documentation

+ +

◆ m_engine

+ +
+
+ + + + + +
+ + + + +
const GraphEngine& gridfire::engine::GraphEngine::AtomicReverseRate::m_engine
+ 		+private
+
+ +
+
+ +

◆ m_reaction

+ +
+
+ + + + + +
+ + + + +
const reaction::Reaction& gridfire::engine::GraphEngine::AtomicReverseRate::m_reaction
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate.js b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate.js new file mode 100644 index 00000000..8eefd4a7 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate.js @@ -0,0 +1,12 @@ +var classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate = +[ + [ "AtomicReverseRate", "classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate.html#a29639c336e8a6786ec2edea98915c0a4", null ], + [ "for_sparse_jac", "classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate.html#a2726876d934a53364e205dbc00a17cc9", null ], + [ "for_sparse_jac", "classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate.html#a706c7a9a7c74333bb77a99c1ada8dc65", null ], + [ "forward", "classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate.html#a9bd23c85ea5e8ad14a0175931852640d", null ], + [ "rev_sparse_jac", "classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate.html#abaa48f3861797a4721ab8841424854d3", null ], + [ "rev_sparse_jac", "classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate.html#af5b5eff42682cf278fa4559e50c47eed", null ], + [ "reverse", "classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate.html#a23aed1727ab0cbba996561421e754018", null ], + [ "m_engine", "classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate.html#ac4e9b5a30752c13dcf872a1eeec3734c", null ], + [ "m_reaction", "classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate.html#a826f3f139f3767c72828990cd40dd415", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__coll__graph.map b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__coll__graph.map new file mode 100644 index 00000000..3d49e3c3 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__coll__graph.map @@ -0,0 +1,94 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__coll__graph.md5 b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__coll__graph.md5 new file mode 100644 index 00000000..2b7559f6 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__coll__graph.md5 @@ -0,0 +1 @@ +9084d50d360fc23aec6dda1ed45cafa0 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__coll__graph.svg b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__coll__graph.svg new file mode 100644 index 00000000..b7743555 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__coll__graph.svg @@ -0,0 +1,1016 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::engine::GraphEngine::AtomicReverseRate + + +Node1 + + +gridfire::engine::GraphEngine +::AtomicReverseRate + + + + + +Node33 + + +std::unique_ptr< gridfire +::engine::GraphEngine:: +AtomicReverseRate > + + + + + +Node1->Node33 + + + + + + ptr + + + +Node2 + + +CppAD::atomic_base +< double > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::reaction +::Reaction + + + + + +Node3->Node1 + + + + + + m_reaction + + + +Node20 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node3->Node20 + + + + + + ptr + + + +Node23 + + +std::unordered_map +< std::string_view, + gridfire::reaction:: +Reaction * > + + + + + +Node3->Node23 + + + + + + elements + + + +Node4 + + +gridfire::engine::GraphEngine + + + + + +Node4->Node1 + + + + + + m_engine + + + +Node5 + + +gridfire::engine::Dynamic +Engine + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +gridfire::engine::Engine + + + + + +Node6->Node5 + + + + + + + + +Node7 + + +std::unordered_map +< JacobianMatrixState, + std::string > + + + + + +Node7->Node4 + + + + + + m_jacobianMatrixStateNameMap + + + +Node8 + + +std::string + + + + + +Node8->Node7 + + + + + + elements + + + +Node18 + + +gridfire::reaction +::ReactionSet + + + + + +Node8->Node18 + + + + + + m_id + + + +Node21 + + +std::unordered_map +< std::string, size_t > + + + + + +Node8->Node21 + + + + + + keys + + + +Node9 + + +std::basic_string< + Char > + + + + + +Node9->Node8 + + + + + + + + +Node10 + + +Config + + + + + +Node10->Node4 + + + + + + m_config + + + +Node11 + + +gridfire::engine::GraphEngine +::constants + + + + + +Node11->Node4 + + + + + + m_constants + + + +Node12 + + +gridfire::rates::weak +::WeakRateInterpolator + + + + + +Node12->Node4 + + + + + + m_weakRateInterpolator + + + +Node13 + + +std::unordered_map +< uint32_t, gridfire +::rates::weak::IsotopeGrid > + + + + + +Node13->Node12 + + + + + + m_rate_table + + + +Node14 + + +gridfire::rates::weak +::IsotopeGrid + + + + + +Node14->Node13 + + + + + + elements + + + +Node15 + + +std::vector< double > + + + + + +Node15->Node14 + + + + + + rhoYe_axis +t9_axis + + + +Node16 + + +std::vector< gridfire +::rates::weak::WeakRatePayload > + + + + + +Node16->Node14 + + + + + + data + + + +Node17 + + +gridfire::rates::weak +::WeakRatePayload + + + + + +Node17->Node16 + + + + + + elements + + + +Node18->Node4 + + + + + + m_reactions + + + +Node19 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node19->Node18 + + + + + + m_reactions + + + +Node20->Node19 + + + + + + elements + + + +Node21->Node18 + + + + + + m_reactionNameMap + + + +Node22 + + +std::unordered_set +< size_t > + + + + + +Node22->Node18 + + + + + + m_reactionHashes + + + +Node23->Node4 + + + + + + m_reactionIDMap + + + +Node24 + + +std::string_view + + + + + +Node24->Node23 + + + + + + keys + + + +Node28 + + +std::unordered_map +< std::string_view, + fourdst::atomic::Species > + + + + + +Node24->Node28 + + + + + + keys + + + +Node25 + + +std::basic_string_view +< Char > + + + + + +Node25->Node24 + + + + + + + + +Node26 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node26->Node4 + + + + + + m_networkSpecies + + + +Node27 + + +Species + + + + + +Node27->Node26 + + + + + + elements + + + +Node27->Node28 + + + + + + elements + + + +Node29 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node27->Node29 + + + + + + keys + + + +Node30 + + +std::unordered_map +< size_t, fourdst::atomic +::Species > + + + + + +Node27->Node30 + + + + + + elements + + + +Node28->Node4 + + + + + + m_networkSpeciesMap + + + +Node29->Node4 + + + + + + m_speciesToIndexMap + + + +Node30->Node4 + + + + + + m_indexToSpeciesMap + + + +Node31 + + +std::set< std::pair +< size_t, size_t > > + + + + + +Node31->Node4 + + + + + + m_full_sparsity_set + + + +Node32 + + +std::vector< std::unique +_ptr< gridfire::engine +::GraphEngine::AtomicReverseRate > > + + + + + +Node32->Node4 + + + + + + m_atomicReverseRates + + + +Node33->Node32 + + + + + + elements + + + +Node34 + + +std::unique_ptr< gridfire +::screening::ScreeningModel > + + + + + +Node34->Node4 + + + + + + m_screeningModel + + + +Node35 + + +gridfire::screening +::ScreeningModel + + + + + +Node35->Node34 + + + + + + ptr + + + +Node36 + + +std::vector< gridfire +::engine::GraphEngine +::PrecomputedReaction > + + + + + +Node36->Node4 + + + + + + m_precomputedReactions + + + +Node37 + + +gridfire::engine::GraphEngine +::PrecomputedReaction + + + + + +Node37->Node36 + + + + + + elements + + + +Node38 + + +std::vector< size_t > + + + + + +Node38->Node37 + + + + + + affected_species_indices +unique_product_indices +unique_reactant_indices + + + +Node39 + + +std::vector< int > + + + + + +Node39->Node37 + + + + + + product_powers +reactant_powers +stoichiometric_coefficients + + + +Node40 + + +std::unordered_map +< uint64_t, size_t > + + + + + +Node40->Node4 + + + + + + m_precomputedReactionIndexMap + + + +Node41 + + +std::unique_ptr< gridfire +::partition::PartitionFunction > + + + + + +Node41->Node4 + + + + + + m_partitionFunction + + + +Node42 + + +gridfire::partition +::PartitionFunction + + + + + +Node42->Node41 + + + + + + ptr + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__coll__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__coll__graph_org.svg new file mode 100644 index 00000000..40f96ffb --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__coll__graph_org.svg @@ -0,0 +1,934 @@ + + + + + + +gridfire::engine::GraphEngine::AtomicReverseRate + + +Node1 + + +gridfire::engine::GraphEngine +::AtomicReverseRate + + + + + +Node33 + + +std::unique_ptr< gridfire +::engine::GraphEngine:: +AtomicReverseRate > + + + + + +Node1->Node33 + + + + + + ptr + + + +Node2 + + +CppAD::atomic_base +< double > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::reaction +::Reaction + + + + + +Node3->Node1 + + + + + + m_reaction + + + +Node20 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node3->Node20 + + + + + + ptr + + + +Node23 + + +std::unordered_map +< std::string_view, + gridfire::reaction:: +Reaction * > + + + + + +Node3->Node23 + + + + + + elements + + + +Node4 + + +gridfire::engine::GraphEngine + + + + + +Node4->Node1 + + + + + + m_engine + + + +Node5 + + +gridfire::engine::Dynamic +Engine + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +gridfire::engine::Engine + + + + + +Node6->Node5 + + + + + + + + +Node7 + + +std::unordered_map +< JacobianMatrixState, + std::string > + + + + + +Node7->Node4 + + + + + + m_jacobianMatrixStateNameMap + + + +Node8 + + +std::string + + + + + +Node8->Node7 + + + + + + elements + + + +Node18 + + +gridfire::reaction +::ReactionSet + + + + + +Node8->Node18 + + + + + + m_id + + + +Node21 + + +std::unordered_map +< std::string, size_t > + + + + + +Node8->Node21 + + + + + + keys + + + +Node9 + + +std::basic_string< + Char > + + + + + +Node9->Node8 + + + + + + + + +Node10 + + +Config + + + + + +Node10->Node4 + + + + + + m_config + + + +Node11 + + +gridfire::engine::GraphEngine +::constants + + + + + +Node11->Node4 + + + + + + m_constants + + + +Node12 + + +gridfire::rates::weak +::WeakRateInterpolator + + + + + +Node12->Node4 + + + + + + m_weakRateInterpolator + + + +Node13 + + +std::unordered_map +< uint32_t, gridfire +::rates::weak::IsotopeGrid > + + + + + +Node13->Node12 + + + + + + m_rate_table + + + +Node14 + + +gridfire::rates::weak +::IsotopeGrid + + + + + +Node14->Node13 + + + + + + elements + + + +Node15 + + +std::vector< double > + + + + + +Node15->Node14 + + + + + + rhoYe_axis +t9_axis + + + +Node16 + + +std::vector< gridfire +::rates::weak::WeakRatePayload > + + + + + +Node16->Node14 + + + + + + data + + + +Node17 + + +gridfire::rates::weak +::WeakRatePayload + + + + + +Node17->Node16 + + + + + + elements + + + +Node18->Node4 + + + + + + m_reactions + + + +Node19 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node19->Node18 + + + + + + m_reactions + + + +Node20->Node19 + + + + + + elements + + + +Node21->Node18 + + + + + + m_reactionNameMap + + + +Node22 + + +std::unordered_set +< size_t > + + + + + +Node22->Node18 + + + + + + m_reactionHashes + + + +Node23->Node4 + + + + + + m_reactionIDMap + + + +Node24 + + +std::string_view + + + + + +Node24->Node23 + + + + + + keys + + + +Node28 + + +std::unordered_map +< std::string_view, + fourdst::atomic::Species > + + + + + +Node24->Node28 + + + + + + keys + + + +Node25 + + +std::basic_string_view +< Char > + + + + + +Node25->Node24 + + + + + + + + +Node26 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node26->Node4 + + + + + + m_networkSpecies + + + +Node27 + + +Species + + + + + +Node27->Node26 + + + + + + elements + + + +Node27->Node28 + + + + + + elements + + + +Node29 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node27->Node29 + + + + + + keys + + + +Node30 + + +std::unordered_map +< size_t, fourdst::atomic +::Species > + + + + + +Node27->Node30 + + + + + + elements + + + +Node28->Node4 + + + + + + m_networkSpeciesMap + + + +Node29->Node4 + + + + + + m_speciesToIndexMap + + + +Node30->Node4 + + + + + + m_indexToSpeciesMap + + + +Node31 + + +std::set< std::pair +< size_t, size_t > > + + + + + +Node31->Node4 + + + + + + m_full_sparsity_set + + + +Node32 + + +std::vector< std::unique +_ptr< gridfire::engine +::GraphEngine::AtomicReverseRate > > + + + + + +Node32->Node4 + + + + + + m_atomicReverseRates + + + +Node33->Node32 + + + + + + elements + + + +Node34 + + +std::unique_ptr< gridfire +::screening::ScreeningModel > + + + + + +Node34->Node4 + + + + + + m_screeningModel + + + +Node35 + + +gridfire::screening +::ScreeningModel + + + + + +Node35->Node34 + + + + + + ptr + + + +Node36 + + +std::vector< gridfire +::engine::GraphEngine +::PrecomputedReaction > + + + + + +Node36->Node4 + + + + + + m_precomputedReactions + + + +Node37 + + +gridfire::engine::GraphEngine +::PrecomputedReaction + + + + + +Node37->Node36 + + + + + + elements + + + +Node38 + + +std::vector< size_t > + + + + + +Node38->Node37 + + + + + + affected_species_indices +unique_product_indices +unique_reactant_indices + + + +Node39 + + +std::vector< int > + + + + + +Node39->Node37 + + + + + + product_powers +reactant_powers +stoichiometric_coefficients + + + +Node40 + + +std::unordered_map +< uint64_t, size_t > + + + + + +Node40->Node4 + + + + + + m_precomputedReactionIndexMap + + + +Node41 + + +std::unique_ptr< gridfire +::partition::PartitionFunction > + + + + + +Node41->Node4 + + + + + + m_partitionFunction + + + +Node42 + + +gridfire::partition +::PartitionFunction + + + + + +Node42->Node41 + + + + + + ptr + + + diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__inherit__graph.map b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__inherit__graph.map new file mode 100644 index 00000000..99804fea --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__inherit__graph.md5 b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__inherit__graph.md5 new file mode 100644 index 00000000..e792fbdf --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__inherit__graph.md5 @@ -0,0 +1 @@ +d62dcee147836c04573f0ae1d90d1245 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__inherit__graph.svg b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__inherit__graph.svg new file mode 100644 index 00000000..73e1eb25 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__inherit__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +gridfire::engine::GraphEngine::AtomicReverseRate + + +Node1 + + +gridfire::engine::GraphEngine +::AtomicReverseRate + + + + + +Node2 + + +CppAD::atomic_base +< double > + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__inherit__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__inherit__graph_org.svg new file mode 100644 index 00000000..4b0d5da0 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine_1_1AtomicReverseRate__inherit__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +gridfire::engine::GraphEngine::AtomicReverseRate + + +Node1 + + +gridfire::engine::GraphEngine +::AtomicReverseRate + + + + + +Node2 + + +CppAD::atomic_base +< double > + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine__coll__graph.map b/docs/html/classgridfire_1_1engine_1_1GraphEngine__coll__graph.map new file mode 100644 index 00000000..22fd2e00 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine__coll__graph.map @@ -0,0 +1,94 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine__coll__graph.md5 b/docs/html/classgridfire_1_1engine_1_1GraphEngine__coll__graph.md5 new file mode 100644 index 00000000..88fca04c --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine__coll__graph.md5 @@ -0,0 +1 @@ +31f08ce0ccb338c6d380838e5d2db25a \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine__coll__graph.svg b/docs/html/classgridfire_1_1engine_1_1GraphEngine__coll__graph.svg new file mode 100644 index 00000000..3f51e143 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine__coll__graph.svg @@ -0,0 +1,1016 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::engine::GraphEngine + + +Node1 + + +gridfire::engine::GraphEngine + + + + + +Node32 + + +gridfire::engine::GraphEngine +::AtomicReverseRate + + + + + +Node1->Node32 + + + + + + m_engine + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::unordered_map +< JacobianMatrixState, + std::string > + + + + + +Node4->Node1 + + + + + + m_jacobianMatrixStateNameMap + + + +Node5 + + +std::string + + + + + +Node5->Node4 + + + + + + elements + + + +Node15 + + +gridfire::reaction +::ReactionSet + + + + + +Node5->Node15 + + + + + + m_id + + + +Node19 + + +std::unordered_map +< std::string, size_t > + + + + + +Node5->Node19 + + + + + + keys + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + +Node7 + + +Config + + + + + +Node7->Node1 + + + + + + m_config + + + +Node8 + + +gridfire::engine::GraphEngine +::constants + + + + + +Node8->Node1 + + + + + + m_constants + + + +Node9 + + +gridfire::rates::weak +::WeakRateInterpolator + + + + + +Node9->Node1 + + + + + + m_weakRateInterpolator + + + +Node10 + + +std::unordered_map +< uint32_t, gridfire +::rates::weak::IsotopeGrid > + + + + + +Node10->Node9 + + + + + + m_rate_table + + + +Node11 + + +gridfire::rates::weak +::IsotopeGrid + + + + + +Node11->Node10 + + + + + + elements + + + +Node12 + + +std::vector< double > + + + + + +Node12->Node11 + + + + + + rhoYe_axis +t9_axis + + + +Node13 + + +std::vector< gridfire +::rates::weak::WeakRatePayload > + + + + + +Node13->Node11 + + + + + + data + + + +Node14 + + +gridfire::rates::weak +::WeakRatePayload + + + + + +Node14->Node13 + + + + + + elements + + + +Node15->Node1 + + + + + + m_reactions + + + +Node16 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node16->Node15 + + + + + + m_reactions + + + +Node17 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node17->Node16 + + + + + + elements + + + +Node18 + + +gridfire::reaction +::Reaction + + + + + +Node18->Node17 + + + + + + ptr + + + +Node21 + + +std::unordered_map +< std::string_view, + gridfire::reaction:: +Reaction * > + + + + + +Node18->Node21 + + + + + + elements + + + +Node18->Node32 + + + + + + m_reaction + + + +Node19->Node15 + + + + + + m_reactionNameMap + + + +Node20 + + +std::unordered_set +< size_t > + + + + + +Node20->Node15 + + + + + + m_reactionHashes + + + +Node21->Node1 + + + + + + m_reactionIDMap + + + +Node22 + + +std::string_view + + + + + +Node22->Node21 + + + + + + keys + + + +Node26 + + +std::unordered_map +< std::string_view, + fourdst::atomic::Species > + + + + + +Node22->Node26 + + + + + + keys + + + +Node23 + + +std::basic_string_view +< Char > + + + + + +Node23->Node22 + + + + + + + + +Node24 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node24->Node1 + + + + + + m_networkSpecies + + + +Node25 + + +Species + + + + + +Node25->Node24 + + + + + + elements + + + +Node25->Node26 + + + + + + elements + + + +Node27 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node25->Node27 + + + + + + keys + + + +Node28 + + +std::unordered_map +< size_t, fourdst::atomic +::Species > + + + + + +Node25->Node28 + + + + + + elements + + + +Node26->Node1 + + + + + + m_networkSpeciesMap + + + +Node27->Node1 + + + + + + m_speciesToIndexMap + + + +Node28->Node1 + + + + + + m_indexToSpeciesMap + + + +Node29 + + +std::set< std::pair +< size_t, size_t > > + + + + + +Node29->Node1 + + + + + + m_full_sparsity_set + + + +Node30 + + +std::vector< std::unique +_ptr< gridfire::engine +::GraphEngine::AtomicReverseRate > > + + + + + +Node30->Node1 + + + + + + m_atomicReverseRates + + + +Node31 + + +std::unique_ptr< gridfire +::engine::GraphEngine:: +AtomicReverseRate > + + + + + +Node31->Node30 + + + + + + elements + + + +Node32->Node31 + + + + + + ptr + + + +Node33 + + +CppAD::atomic_base +< double > + + + + + +Node33->Node32 + + + + + + + + +Node34 + + +std::unique_ptr< gridfire +::screening::ScreeningModel > + + + + + +Node34->Node1 + + + + + + m_screeningModel + + + +Node35 + + +gridfire::screening +::ScreeningModel + + + + + +Node35->Node34 + + + + + + ptr + + + +Node36 + + +std::vector< gridfire +::engine::GraphEngine +::PrecomputedReaction > + + + + + +Node36->Node1 + + + + + + m_precomputedReactions + + + +Node37 + + +gridfire::engine::GraphEngine +::PrecomputedReaction + + + + + +Node37->Node36 + + + + + + elements + + + +Node38 + + +std::vector< size_t > + + + + + +Node38->Node37 + + + + + + affected_species_indices +unique_product_indices +unique_reactant_indices + + + +Node39 + + +std::vector< int > + + + + + +Node39->Node37 + + + + + + product_powers +reactant_powers +stoichiometric_coefficients + + + +Node40 + + +std::unordered_map +< uint64_t, size_t > + + + + + +Node40->Node1 + + + + + + m_precomputedReactionIndexMap + + + +Node41 + + +std::unique_ptr< gridfire +::partition::PartitionFunction > + + + + + +Node41->Node1 + + + + + + m_partitionFunction + + + +Node42 + + +gridfire::partition +::PartitionFunction + + + + + +Node42->Node41 + + + + + + ptr + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine__coll__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1GraphEngine__coll__graph_org.svg new file mode 100644 index 00000000..7dd2c469 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine__coll__graph_org.svg @@ -0,0 +1,934 @@ + + + + + + +gridfire::engine::GraphEngine + + +Node1 + + +gridfire::engine::GraphEngine + + + + + +Node32 + + +gridfire::engine::GraphEngine +::AtomicReverseRate + + + + + +Node1->Node32 + + + + + + m_engine + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::unordered_map +< JacobianMatrixState, + std::string > + + + + + +Node4->Node1 + + + + + + m_jacobianMatrixStateNameMap + + + +Node5 + + +std::string + + + + + +Node5->Node4 + + + + + + elements + + + +Node15 + + +gridfire::reaction +::ReactionSet + + + + + +Node5->Node15 + + + + + + m_id + + + +Node19 + + +std::unordered_map +< std::string, size_t > + + + + + +Node5->Node19 + + + + + + keys + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + +Node7 + + +Config + + + + + +Node7->Node1 + + + + + + m_config + + + +Node8 + + +gridfire::engine::GraphEngine +::constants + + + + + +Node8->Node1 + + + + + + m_constants + + + +Node9 + + +gridfire::rates::weak +::WeakRateInterpolator + + + + + +Node9->Node1 + + + + + + m_weakRateInterpolator + + + +Node10 + + +std::unordered_map +< uint32_t, gridfire +::rates::weak::IsotopeGrid > + + + + + +Node10->Node9 + + + + + + m_rate_table + + + +Node11 + + +gridfire::rates::weak +::IsotopeGrid + + + + + +Node11->Node10 + + + + + + elements + + + +Node12 + + +std::vector< double > + + + + + +Node12->Node11 + + + + + + rhoYe_axis +t9_axis + + + +Node13 + + +std::vector< gridfire +::rates::weak::WeakRatePayload > + + + + + +Node13->Node11 + + + + + + data + + + +Node14 + + +gridfire::rates::weak +::WeakRatePayload + + + + + +Node14->Node13 + + + + + + elements + + + +Node15->Node1 + + + + + + m_reactions + + + +Node16 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node16->Node15 + + + + + + m_reactions + + + +Node17 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node17->Node16 + + + + + + elements + + + +Node18 + + +gridfire::reaction +::Reaction + + + + + +Node18->Node17 + + + + + + ptr + + + +Node21 + + +std::unordered_map +< std::string_view, + gridfire::reaction:: +Reaction * > + + + + + +Node18->Node21 + + + + + + elements + + + +Node18->Node32 + + + + + + m_reaction + + + +Node19->Node15 + + + + + + m_reactionNameMap + + + +Node20 + + +std::unordered_set +< size_t > + + + + + +Node20->Node15 + + + + + + m_reactionHashes + + + +Node21->Node1 + + + + + + m_reactionIDMap + + + +Node22 + + +std::string_view + + + + + +Node22->Node21 + + + + + + keys + + + +Node26 + + +std::unordered_map +< std::string_view, + fourdst::atomic::Species > + + + + + +Node22->Node26 + + + + + + keys + + + +Node23 + + +std::basic_string_view +< Char > + + + + + +Node23->Node22 + + + + + + + + +Node24 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node24->Node1 + + + + + + m_networkSpecies + + + +Node25 + + +Species + + + + + +Node25->Node24 + + + + + + elements + + + +Node25->Node26 + + + + + + elements + + + +Node27 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node25->Node27 + + + + + + keys + + + +Node28 + + +std::unordered_map +< size_t, fourdst::atomic +::Species > + + + + + +Node25->Node28 + + + + + + elements + + + +Node26->Node1 + + + + + + m_networkSpeciesMap + + + +Node27->Node1 + + + + + + m_speciesToIndexMap + + + +Node28->Node1 + + + + + + m_indexToSpeciesMap + + + +Node29 + + +std::set< std::pair +< size_t, size_t > > + + + + + +Node29->Node1 + + + + + + m_full_sparsity_set + + + +Node30 + + +std::vector< std::unique +_ptr< gridfire::engine +::GraphEngine::AtomicReverseRate > > + + + + + +Node30->Node1 + + + + + + m_atomicReverseRates + + + +Node31 + + +std::unique_ptr< gridfire +::engine::GraphEngine:: +AtomicReverseRate > + + + + + +Node31->Node30 + + + + + + elements + + + +Node32->Node31 + + + + + + ptr + + + +Node33 + + +CppAD::atomic_base +< double > + + + + + +Node33->Node32 + + + + + + + + +Node34 + + +std::unique_ptr< gridfire +::screening::ScreeningModel > + + + + + +Node34->Node1 + + + + + + m_screeningModel + + + +Node35 + + +gridfire::screening +::ScreeningModel + + + + + +Node35->Node34 + + + + + + ptr + + + +Node36 + + +std::vector< gridfire +::engine::GraphEngine +::PrecomputedReaction > + + + + + +Node36->Node1 + + + + + + m_precomputedReactions + + + +Node37 + + +gridfire::engine::GraphEngine +::PrecomputedReaction + + + + + +Node37->Node36 + + + + + + elements + + + +Node38 + + +std::vector< size_t > + + + + + +Node38->Node37 + + + + + + affected_species_indices +unique_product_indices +unique_reactant_indices + + + +Node39 + + +std::vector< int > + + + + + +Node39->Node37 + + + + + + product_powers +reactant_powers +stoichiometric_coefficients + + + +Node40 + + +std::unordered_map +< uint64_t, size_t > + + + + + +Node40->Node1 + + + + + + m_precomputedReactionIndexMap + + + +Node41 + + +std::unique_ptr< gridfire +::partition::PartitionFunction > + + + + + +Node41->Node1 + + + + + + m_partitionFunction + + + +Node42 + + +gridfire::partition +::PartitionFunction + + + + + +Node42->Node41 + + + + + + ptr + + + diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine__inherit__graph.map b/docs/html/classgridfire_1_1engine_1_1GraphEngine__inherit__graph.map new file mode 100644 index 00000000..328339d6 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine__inherit__graph.md5 b/docs/html/classgridfire_1_1engine_1_1GraphEngine__inherit__graph.md5 new file mode 100644 index 00000000..8973980c --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine__inherit__graph.md5 @@ -0,0 +1 @@ +aecea00862f7aecf0f0c401bb6e8dd30 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine__inherit__graph.svg b/docs/html/classgridfire_1_1engine_1_1GraphEngine__inherit__graph.svg new file mode 100644 index 00000000..3f693003 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine__inherit__graph.svg @@ -0,0 +1,83 @@ + + + + + + + + + + + +gridfire::engine::GraphEngine + + +Node1 + + +gridfire::engine::GraphEngine + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1GraphEngine__inherit__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1GraphEngine__inherit__graph_org.svg new file mode 100644 index 00000000..1eabca44 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1GraphEngine__inherit__graph_org.svg @@ -0,0 +1,58 @@ + + + + + + +gridfire::engine::GraphEngine + + +Node1 + + +gridfire::engine::GraphEngine + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView-members.html b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView-members.html new file mode 100644 index 00000000..809af34a --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView-members.html @@ -0,0 +1,170 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::MultiscalePartitioningEngineView Member List
+
+
+ +

This is the complete list of members for gridfire::engine::MultiscalePartitioningEngineView, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
analyzeTimescalePoolConnectivity(const std::vector< std::vector< fourdst::atomic::Species > > &timescale_pools, const fourdst::composition::Composition &comp, double T9, double rho) constgridfire::engine::MultiscalePartitioningEngineViewprivate
buildConnectivityGraph(const std::vector< fourdst::atomic::Species > &species_pool, const fourdst::composition::Composition &comp, double T9, double rho) constgridfire::engine::MultiscalePartitioningEngineViewprivate
calculateEpsDerivatives(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
calculateMolarReactionFlow(const reaction::Reaction &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
calculateRHSAndEnergy(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
collectComposition(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
constructCandidateGroups(const std::vector< std::vector< fourdst::atomic::Species > > &candidate_pools, const fourdst::composition::Composition &comp, double T9, double rho) constgridfire::engine::MultiscalePartitioningEngineViewprivate
exportToDot(const std::string &filename, const fourdst::composition::Composition &comp, double T9, double rho) constgridfire::engine::MultiscalePartitioningEngineView
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies) const overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
generateStoichiometryMatrix() overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
getBaseEngine() const overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
getDepth() constgridfire::engine::DynamicEngineinlinevirtual
getDynamicSpecies() constgridfire::engine::MultiscalePartitioningEngineView
getFastSpecies() constgridfire::engine::MultiscalePartitioningEngineView
getNetworkReactions() const overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
getNetworkSpecies() const overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
getNormalizedEquilibratedComposition(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) constgridfire::engine::MultiscalePartitioningEngineView
getScreeningModel() const overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
getSpeciesDestructionTimescales(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
getSpeciesIndex(const fourdst::atomic::Species &species) const overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
getSpeciesStatus(const fourdst::atomic::Species &species) const overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
getSpeciesTimescales(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
getStoichiometryMatrixEntry(const fourdst::atomic::Species &species, const reaction::Reaction &reaction) const overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
group_is_a_qse_cluster(const fourdst::composition::Composition &comp, double T9, double rho, const QSEGroup &group) constgridfire::engine::MultiscalePartitioningEngineViewprivate
group_is_a_qse_pipeline(const fourdst::composition::Composition &comp, double T9, double rho, const QSEGroup &group) constgridfire::engine::MultiscalePartitioningEngineViewprivate
identifyMeanSlowestPool(const std::vector< std::vector< fourdst::atomic::Species > > &pools, const fourdst::composition::Composition &comp, double T9, double rho) constgridfire::engine::MultiscalePartitioningEngineViewprivate
involvesSpecies(const fourdst::atomic::Species &species) constgridfire::engine::MultiscalePartitioningEngineView
involvesSpeciesInDynamic(const fourdst::atomic::Species &species) constgridfire::engine::MultiscalePartitioningEngineView
involvesSpeciesInQSE(const fourdst::atomic::Species &species) constgridfire::engine::MultiscalePartitioningEngineView
isStale(const NetIn &netIn) overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
m_activeReactionIndicesgridfire::engine::MultiscalePartitioningEngineViewprivate
m_activeSpeciesIndicesgridfire::engine::MultiscalePartitioningEngineViewprivate
m_algebraic_abundancesgridfire::engine::MultiscalePartitioningEngineViewprivate
m_algebraic_speciesgridfire::engine::MultiscalePartitioningEngineViewprivate
m_baseEnginegridfire::engine::MultiscalePartitioningEngineViewprivate
m_composition_cachegridfire::engine::MultiscalePartitioningEngineViewmutableprivate
m_dynamic_speciesgridfire::engine::MultiscalePartitioningEngineViewprivate
m_loggergridfire::engine::MultiscalePartitioningEngineViewprivate
m_qse_groupsgridfire::engine::MultiscalePartitioningEngineViewprivate
m_qse_solversgridfire::engine::MultiscalePartitioningEngineViewprivate
m_sun_ctxgridfire::engine::MultiscalePartitioningEngineViewprivate
mapNetInToMolarAbundanceVector(const NetIn &netIn) const overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
merge_coupled_groups(const std::vector< QSEGroup > &groups, const std::vector< reaction::ReactionSet > &groupReactions)gridfire::engine::MultiscalePartitioningEngineViewprivatestatic
MultiscalePartitioningEngineView(DynamicEngine &baseEngine)gridfire::engine::MultiscalePartitioningEngineViewexplicit
partitionByTimescale(const fourdst::composition::Composition &comp, double T9, double rho) constgridfire::engine::MultiscalePartitioningEngineViewprivate
partitionNetwork(const NetIn &netIn)gridfire::engine::MultiscalePartitioningEngineView
primeEngine(const NetIn &netIn) overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
pruneValidatedGroups(const std::vector< QSEGroup > &groups, const std::vector< reaction::ReactionSet > &groupReactions, const fourdst::composition::Composition &comp, double T9, double rho) constgridfire::engine::MultiscalePartitioningEngineViewprivate
QSEPartition typedefgridfire::engine::MultiscalePartitioningEngineViewprivate
rebuild(const fourdst::composition::CompositionAbstract &comp, BuildDepthType depth)gridfire::engine::DynamicEngineinlinevirtual
setNetworkReactions(const reaction::ReactionSet &reactions) overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
setScreeningModel(screening::ScreeningType model) overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
solveQSEAbundances(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) constgridfire::engine::MultiscalePartitioningEngineViewprivate
update(const NetIn &netIn) overridegridfire::engine::MultiscalePartitioningEngineViewvirtual
validateGroupsWithFluxAnalysis(const std::vector< QSEGroup > &candidate_groups, const fourdst::composition::Composition &comp, double T9, double rho) constgridfire::engine::MultiscalePartitioningEngineViewprivate
~Engine()=defaultgridfire::engine::Enginevirtual
~EngineView()=defaultgridfire::engine::EngineView< DynamicEngine >virtual
~MultiscalePartitioningEngineView() overridegridfire::engine::MultiscalePartitioningEngineView
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html new file mode 100644 index 00000000..a0d2ebab --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html @@ -0,0 +1,2702 @@ + + + + + + + +GridFire: gridfire::engine::MultiscalePartitioningEngineView Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Classes | +Public Member Functions | +Private Types | +Private Member Functions | +Static Private Member Functions | +Private Attributes | +List of all members
+
gridfire::engine::MultiscalePartitioningEngineView Class Referencefinal
+
+
+ +

An engine view that partitions the reaction network into multiple groups based on timescales. + More...

+ +

#include <engine_multiscale.h>

+
+Inheritance diagram for gridfire::engine::MultiscalePartitioningEngineView:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::engine::MultiscalePartitioningEngineView:
+
+
+
[legend]
+ + + + + + + + + +

+Classes

struct  FluxValidationResult
 
struct  QSEGroup
 Struct representing a QSE group. More...
 
class  QSESolver
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 MultiscalePartitioningEngineView (DynamicEngine &baseEngine)
 Constructs a MultiscalePartitioningEngineView.
 
 ~MultiscalePartitioningEngineView () override
 
const std::vector< fourdst::atomic::Species > & getNetworkSpecies () const override
 Gets the list of 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.
 
EnergyDerivatives calculateEpsDerivatives (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
 Calculates the energy generation rate derivatives with respect to abundances.
 
NetworkJacobian generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
 Generates the Jacobian matrix for the current state.
 
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 a subset of active species.
 
NetworkJacobian generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const override
 Generates the Jacobian matrix using a sparsity pattern.
 
void generateStoichiometryMatrix () override
 Generates the stoichiometry matrix for the network.
 
int getStoichiometryMatrixEntry (const fourdst::atomic::Species &species, const reaction::Reaction &reaction) const override
 Gets an entry from the stoichiometry matrix.
 
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.
 
const reaction::ReactionSet & getNetworkReactions () const override
 Gets the set of logical reactions in the network.
 
void setNetworkReactions (const reaction::ReactionSet &reactions) override
 Sets the set of logical reactions in the network.
 
std::expected< std::unordered_map< fourdst::atomic::Species, double >, engine::EngineStatus > getSpeciesTimescales (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
 Computes timescales for all species in the network.
 
std::expected< std::unordered_map< fourdst::atomic::Species, double >, engine::EngineStatus > getSpeciesDestructionTimescales (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
 Computes destruction timescales for all species in the network.
 
fourdst::composition::Composition update (const NetIn &netIn) override
 Updates the internal state of the engine, performing partitioning and QSE equilibration.
 
bool isStale (const NetIn &netIn) override
 Checks if the engine's internal state is stale relative to the provided conditions.
 
void setScreeningModel (screening::ScreeningType model) override
 Sets the electron screening model.
 
screening::ScreeningType getScreeningModel () const override
 Gets the current electron screening model.
 
const DynamicEngine & getBaseEngine () const override
 Gets the base engine.
 
fourdst::composition::Composition partitionNetwork (const NetIn &netIn)
 Partitions the network based on timescales from a NetIn struct.
 
void exportToDot (const std::string &filename, const fourdst::composition::Composition &comp, double T9, double rho) const
 Exports the network to a DOT file for visualization.
 
size_t getSpeciesIndex (const fourdst::atomic::Species &species) const override
 Gets the index of a species in the full network.
 
std::vector< double > mapNetInToMolarAbundanceVector (const NetIn &netIn) const override
 Maps a NetIn struct to a molar abundance vector for the full network.
 
PrimingReport primeEngine (const NetIn &netIn) override
 Primes the engine with a specific species.
 
std::vector< fourdst::atomic::Species > getFastSpecies () const
 Gets the fast species in the network.
 
const std::vector< fourdst::atomic::Species > & getDynamicSpecies () const
 Gets the dynamic species in the network.
 
bool involvesSpecies (const fourdst::atomic::Species &species) const
 Checks if a species is involved in the partitioned network.
 
bool involvesSpeciesInQSE (const fourdst::atomic::Species &species) const
 Check if a species is involved in the QSE (algebraic) set.
 
bool involvesSpeciesInDynamic (const fourdst::atomic::Species &species) const
 Check if a species is involved in the dynamic set.
 
fourdst::composition::Composition getNormalizedEquilibratedComposition (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const
 Gets a normalized composition with QSE species equilibrated.
 
fourdst::composition::Composition collectComposition (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
 Collect the composition from this and sub engines.
 
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.
 
- Public Member Functions inherited from gridfire::engine::Engine
virtual ~Engine ()=default
 Virtual destructor.
 
- Public Member Functions inherited from gridfire::engine::EngineView< DynamicEngine >
virtual ~EngineView ()=default
 Virtual destructor.
 
+ + + + +

+Private Types

typedef std::tuple< std::vector< fourdst::atomic::Species >, std::vector< size_t >, std::vector< fourdst::atomic::Species >, std::vector< size_t > > QSEPartition
 Type alias for a QSE partition.
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Private Member Functions

std::vector< std::vector< fourdst::atomic::Species > > partitionByTimescale (const fourdst::composition::Composition &comp, double T9, double rho) const
 Partitions the network by timescale.
 
std::pair< bool, reaction::ReactionSet > group_is_a_qse_cluster (const fourdst::composition::Composition &comp, double T9, double rho, const QSEGroup &group) const
 
bool group_is_a_qse_pipeline (const fourdst::composition::Composition &comp, double T9, double rho, const QSEGroup &group) const
 
FluxValidationResult validateGroupsWithFluxAnalysis (const std::vector< QSEGroup > &candidate_groups, const fourdst::composition::Composition &comp, double T9, double rho) const
 Validates candidate QSE groups using flux analysis.
 
fourdst::composition::Composition solveQSEAbundances (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const
 Solves for the QSE abundances of the algebraic species in a given state.
 
size_t identifyMeanSlowestPool (const std::vector< std::vector< fourdst::atomic::Species > > &pools, const fourdst::composition::Composition &comp, double T9, double rho) const
 Identifies the pool with the slowest mean timescale.
 
std::unordered_map< fourdst::atomic::Species, std::vector< fourdst::atomic::Species > > buildConnectivityGraph (const std::vector< fourdst::atomic::Species > &species_pool, const fourdst::composition::Composition &comp, double T9, double rho) const
 Builds a connectivity graph from a species pool.
 
std::vector< QSEGroup > constructCandidateGroups (const std::vector< std::vector< fourdst::atomic::Species > > &candidate_pools, const fourdst::composition::Composition &comp, double T9, double rho) const
 Constructs candidate QSE groups from connected timescale pools.
 
std::vector< std::vector< fourdst::atomic::Species > > analyzeTimescalePoolConnectivity (const std::vector< std::vector< fourdst::atomic::Species > > &timescale_pools, const fourdst::composition::Composition &comp, double T9, double rho) const
 Analyzes the connectivity of timescale pools.
 
std::vector< QSEGroup > pruneValidatedGroups (const std::vector< QSEGroup > &groups, const std::vector< reaction::ReactionSet > &groupReactions, const fourdst::composition::Composition &comp, double T9, double rho) const
 
+ + + +

+Static Private Member Functions

static std::vector< QSEGroup > merge_coupled_groups (const std::vector< QSEGroup > &groups, const std::vector< reaction::ReactionSet > &groupReactions)
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Private Attributes

quill::Logger * m_logger = LogManager::getInstance().getLogger("log")
 Logger instance for logging messages.
 
DynamicEngine & m_baseEngine
 The base engine to which this view delegates calculations.
 
std::vector< QSEGroup > m_qse_groups
 The list of identified equilibrium groups.
 
std::vector< std::unique_ptr< QSESolver > > m_qse_solvers
 A set of solvers, one for each QSE group.
 
std::vector< fourdst::atomic::Species > m_dynamic_species
 The simplified set of species presented to the solver (the "slow" species).
 
std::vector< fourdst::atomic::Species > m_algebraic_species
 Species that are treated as algebraic (in QSE) in the QSE groups.
 
std::unordered_map< fourdst::atomic::Species, double > m_algebraic_abundances
 Map from species to their calculated abundances in the QSE state.
 
std::vector< size_t > m_activeSpeciesIndices
 Indices of all species considered active in the current partition (dynamic + algebraic).
 
std::vector< size_t > m_activeReactionIndices
 Indices of all reactions involving only active species.
 
std::unordered_map< uint64_t, fourdst::composition::Composition > m_composition_cache
 
SUNContext m_sun_ctx = nullptr
 
+

Detailed Description

+

An engine view that partitions the reaction network into multiple groups based on timescales.

+
Purpose
This class is designed to accelerate the integration of stiff nuclear reaction networks. It identifies species that react on very short timescales ("fast" species) and treats them as being in Quasi-Steady-State Equilibrium (QSE). Their abundances are solved for algebraically, removing their stiff differential equations from the system. The remaining "slow" or "dynamic" species are integrated normally. This significantly improves the stability and performance of the solver.
+
How
The core logic resides in the partitionNetwork() and equilibrateNetwork() methods. The partitioning process involves:
    +
  1. Timescale Analysis: Using getSpeciesDestructionTimescales from the base engine, all species are sorted by their characteristic timescales.
    2. +
  2. Gap Detection: The sorted list of timescales is scanned for large gaps (e.g., several orders of magnitude) to create distinct "timescale pools".
    3. +
  3. Connectivity Analysis: Each pool is analyzed for internal reaction connectivity to form cohesive groups.
    4. +
  4. Flux Validation: Candidate QSE groups are validated by comparing the total reaction flux within the group to the flux leaving the group. A high internal-to-external flux ratio indicates a valid QSE group.
    5. +
  5. QSE Solve: For valid QSE groups, solveQSEAbundances uses a Levenberg-Marquardt nonlinear solver (Eigen::LevenbergMarquardt) to find the equilibrium abundances of the "algebraic" species, holding the "seed" species constant.
    6. +
+
+

All calculations are cached using QSECacheKey to avoid re-partitioning and re-solving for similar thermodynamic conditions.

+
Usage Example:
// 1. Create a base engine (e.g., GraphEngine)
+
gridfire::GraphEngine baseEngine(composition);
+
+
// 2. Wrap it with the MultiscalePartitioningEngineView
+
gridfire::MultiscalePartitioningEngineView multiscaleEngine(baseEngine);
+
+
// 3. Before integration, update the view to partition the network
+
// and find the initial equilibrium state.
+
NetIn initialConditions = { .composition = composition, .temperature = 1e8, .density = 1e3 };
+
fourdst::composition::Composition equilibratedComp = multiscaleEngine.update(initialConditions);
+
+
// 4. Use the multiscaleEngine for integration. It will use the cached QSE solution.
+
// The integrator will call calculateRHSAndEnergy, etc. on the multiscaleEngine.
+
auto Y_initial = multiscaleEngine.mapNetInToMolarAbundanceVector({equilibratedComp, ...});
+
auto derivatives = multiscaleEngine.calculateRHSAndEnergy(Y_initial, T9, rho);
+
gridfire::NetIn
Definition types.h:27
+
gridfire::NetIn::composition
fourdst::composition::Composition composition
Composition of the network.
Definition types.h:28
+
+

<DynamicEngine>

+

Member Typedef Documentation

+ +

◆ QSEPartition

+ +
+
+ + + + + +
+ + + + +
typedef std::tuple<std::vector<fourdst::atomic::Species>, std::vector<size_t>, std::vector<fourdst::atomic::Species>, std::vector<size_t> > gridfire::engine::MultiscalePartitioningEngineView::QSEPartition
+ 		+private
+
+ +

Type alias for a QSE partition.

+

A QSE partition is a tuple containing the fast species, their indices, the slow species, and their indices.

+ +
+
+

Constructor & Destructor Documentation

+ +

◆ MultiscalePartitioningEngineView()

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::engine::MultiscalePartitioningEngineView::MultiscalePartitioningEngineView (DynamicEngine & baseEngine)
+ 		+explicit
+
+ +

Constructs a MultiscalePartitioningEngineView.

+
Parameters
+ + +
baseEngineThe underlying GraphEngine to which this view delegates calculations. It must be a GraphEngine and not a more general DynamicEngine because this view relies on its specific implementation details.
+
+
+ +
+
+ +

◆ ~MultiscalePartitioningEngineView()

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::engine::MultiscalePartitioningEngineView::~MultiscalePartitioningEngineView ()
+ 		+override
+
+ +
+
+

Member Function Documentation

+ +

◆ analyzeTimescalePoolConnectivity()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< std::vector< Species > > gridfire::engine::MultiscalePartitioningEngineView::analyzeTimescalePoolConnectivity (const std::vector< std::vector< fourdst::atomic::Species > > & timescale_pools,
const fourdst::composition::Composition & comp,
double T9,
double rho 
) const
+ 		+private
+
+ +

Analyzes the connectivity of timescale pools.

+
Parameters
+ + + + + +
timescale_poolsA vector of vectors of species indices, where each inner vector represents a timescale pool.
comp
T9
rho
+
+
+
Returns
A vector of vectors of species indices, where each inner vector represents a single connected component.
+
Purpose
To merge timescale pools that are strongly connected by reactions, forming cohesive groups for QSE analysis.
+
How
For each pool, it builds a reaction connectivity graph using buildConnectivityGraph. It then finds the connected components within that graph using a Breadth-First Search (BFS). The resulting components from all pools are collected and returned.
+ +
+
+ +

◆ buildConnectivityGraph()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::unordered_map< Species, std::vector< Species > > gridfire::engine::MultiscalePartitioningEngineView::buildConnectivityGraph (const std::vector< fourdst::atomic::Species > & species_pool,
const fourdst::composition::Composition & comp,
double T9,
double rho 
) const
+ 		+private
+
+ +

Builds a connectivity graph from a species pool.

+
Parameters
+ + + + + +
species_poolA vector of species indices representing a species pool.
comp
T9
rho
+
+
+
Returns
An unordered map representing the adjacency list of the connectivity graph.
+
Purpose
To find reaction connections within a specific group of species.
+
How
It iterates through all reactions in the base engine. If a reaction involves at least two distinct species from the input species_pool (one as a reactant and one as a product), it adds edges between all reactants and products from that reaction that are also in the pool.
+ +
+
+ +

◆ calculateEpsDerivatives()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
EnergyDerivatives gridfire::engine::MultiscalePartitioningEngineView::calculateEpsDerivatives (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Calculates the energy generation rate derivatives with respect to abundances.

+
Parameters
+ + + + +
compThe current composition.
T9The temperature in units of 10^9 K.
rhoThe density in g/cm^3.
+
+
+
Returns
The energy generation rate derivatives (dEps/dT and dEps/drho).
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ calculateMolarReactionFlow()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::engine::MultiscalePartitioningEngineView::calculateMolarReactionFlow (const reaction::Reaction & reaction,
const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Calculates the molar reaction flow for a given reaction.

+
Parameters
+ + + + + +
reactionThe reaction for which to calculate the flow.
compThe current composition.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
Molar flow rate for the reaction (e.g., mol/g/s).
+
Purpose
To compute the net rate of a single reaction.
+
How
It first checks the QSE cache. On a hit, it retrieves the cached equilibrium abundances for the algebraic species. It creates a mutable copy of Y_full, overwrites the algebraic species abundances with the cached equilibrium values, and then calls the base engine's calculateMolarReactionFlow with this modified abundance vector.
+
Precondition
The engine must have a valid QSE cache entry for the given state.
+
Exceptions
+ + +
StaleEngineErrorIf the QSE cache misses.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ calculateRHSAndEnergy()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
std::expected< StepDerivatives< double >, EngineStatus > gridfire::engine::MultiscalePartitioningEngineView::calculateRHSAndEnergy (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Calculates the right-hand side (dY/dt) and energy generation.

+
Parameters
+ + + + +
compThe current composition.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
A std::expected containing StepDerivatives<double> on success, or a StaleEngineError if the engine's QSE cache does not contain a solution for the given state.
+
Purpose
To compute the time derivatives for the ODE solver. This implementation modifies the derivatives from the base engine to enforce the QSE condition.
+
How
It first performs a lookup in the QSE abundance cache (m_qse_abundance_cache). If a cache hit occurs, it calls the base engine's calculateRHSAndEnergy. It then manually sets the time derivatives (dydt) of all identified algebraic species to zero, effectively removing their differential equations from the system being solved.
+
Precondition
The engine must have been updated via update() or equilibrateNetwork() for the current thermodynamic conditions, so that a valid entry exists in the QSE cache.
+
Postcondition
The returned derivatives will have dydt=0 for all algebraic species.
+
Exceptions
+ + +
StaleEngineErrorIf the QSE cache does not contain an entry for the given (T9, rho, Y_full). This indicates update() was not called recently enough.
+
+
+ +

Implements gridfire::engine::Engine.

+ +
+
+ +

◆ collectComposition()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
fourdst::composition::Composition gridfire::engine::MultiscalePartitioningEngineView::collectComposition (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Collect the composition from this and sub engines.

+

This method operates by injecting the current equilibrium abundances for algebraic species into the composition object so that they can be bubbled up to the caller.

Parameters
+ + + + +
compInput Composition
T9
rho
+
+
+
Returns
New composition which is comp + any edits from lower levels + the equilibrium abundances of all algebraic species.
+
Exceptions
+ + +
BadCollectionErrorif there is a species in the algebraic species set which does not show up in the reported composition from the base engine.:w
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ constructCandidateGroups()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< MultiscalePartitioningEngineView::QSEGroup > gridfire::engine::MultiscalePartitioningEngineView::constructCandidateGroups (const std::vector< std::vector< fourdst::atomic::Species > > & candidate_pools,
const fourdst::composition::Composition & comp,
double T9,
double rho 
) const
+ 		+private
+
+ +

Constructs candidate QSE groups from connected timescale pools.

+
Parameters
+ + + + + +
candidate_poolsA vector of vectors of species indices, where each inner vector represents a connected pool of species with similar fast timescales.
compVector of current molar abundances.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
A vector of QSEGroup structs, ready for flux validation.
+
How
For each input pool, it identifies "bridge" reactions that connect the pool to species outside the pool. The reactants of these bridge reactions that are not in the pool are identified as "seed" species. The original pool members are the "algebraic" species. It then bundles the seed and algebraic species into a QSEGroup struct.
+
Precondition
The candidate_pools should be connected components from analyzeTimescalePoolConnectivity.
+
Postcondition
A list of candidate QSEGroup objects is returned.
+ +
+
+ +

◆ exportToDot()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void gridfire::engine::MultiscalePartitioningEngineView::exportToDot (const std::string & filename,
const fourdst::composition::Composition & comp,
double T9,
double rho 
) const
+
+ +

Exports the network to a DOT file for visualization.

+
Parameters
+ + + + + +
filenameThe name of the DOT file to create.
compComposition object
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Purpose
To visualize the partitioned network graph.
+
How
This method delegates the DOT file export to the base engine. It does not currently add any partitioning information to the output graph.
+ +
+
+ +

◆ generateJacobianMatrix() [1/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
NetworkJacobian gridfire::engine::MultiscalePartitioningEngineView::generateJacobianMatrix (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Generates the Jacobian matrix for the current state.

+
Parameters
+ + + + +
compThe current composition.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Purpose
To compute the Jacobian matrix required by implicit ODE solvers.
+
How
It first performs a QSE cache lookup. On a hit, it delegates the full Jacobian calculation to the base engine. While this view could theoretically return a modified, sparser Jacobian reflecting the QSE constraints, the current implementation returns the full Jacobian from the base engine. The solver is expected to handle the algebraic constraints (e.g., via dydt=0 from calculateRHSAndEnergy).
+
Precondition
The engine must have a valid QSE cache entry for the given state.
+
Postcondition
The base engine's internal Jacobian is updated.
+
Exceptions
+ + +
exceptions::StaleEngineErrorIf the QSE cache misses, as it cannot proceed without a valid partition.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ generateJacobianMatrix() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NetworkJacobian gridfire::engine::MultiscalePartitioningEngineView::generateJacobianMatrix (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho,
const SparsityPattern & sparsityPattern 
) const
+ 		+overridevirtual
+
+ +

Generates the Jacobian matrix using a sparsity pattern.

+
Parameters
+ + + + + +
compThe current composition.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
sparsityPatternThe sparsity pattern to use for the Jacobian.
+
+
+
Purpose
To compute the Jacobian matrix while leveraging a known sparsity pattern for efficiency. This is effectively a lower level version of the active species method.
+
How
It first checks the QSE cache. On a hit, it delegates to the base engine's generateJacobianMatrix method with the provided sparsity pattern.
+
Precondition
The engine must have a valid QSE cache entry for the given state.
+
Postcondition
The base engine's internal Jacobian is updated according to the sparsity pattern.
+
Exceptions
+ + +
exceptions::StaleEngineErrorIf the QSE cache misses.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ generateJacobianMatrix() [3/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NetworkJacobian gridfire::engine::MultiscalePartitioningEngineView::generateJacobianMatrix (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho,
const std::vector< fourdst::atomic::Species > & activeSpecies 
) const
+ 		+overridevirtual
+
+ +

Generates the Jacobian matrix for a subset of active species.

+
Parameters
+ + + + + +
compThe current composition.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
activeSpeciesThe subset of species to include in the Jacobian.
+
+
+
Purpose
To compute a reduced Jacobian matrix for implicit solvers that only consider a subset of species.
+
How
Similar to the full Jacobian generation, it first checks the QSE cache. On a hit, it calls the base engine's generateJacobianMatrix with the specified active species. The returned Jacobian still reflects the full network, but only for the active species subset.
+
Precondition
The engine must have a valid QSE cache entry for the given state.
+
Postcondition
The base engine's internal Jacobian is updated for the active species.
+
Exceptions
+ + +
exceptions::StaleEngineErrorIf the QSE cache misses.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ generateStoichiometryMatrix()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::engine::MultiscalePartitioningEngineView::generateStoichiometryMatrix ()
+ 		+overridevirtual
+
+ +

Generates the stoichiometry matrix for the network.

+
Purpose
To prepare the stoichiometry matrix for later queries.
+
How
This method delegates directly to the base engine's generateStoichiometryMatrix(). The stoichiometry is based on the full, unpartitioned network.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getBaseEngine()

+ +
+
+ + + + + +
+ + + + + + + +
const DynamicEngine & gridfire::engine::MultiscalePartitioningEngineView::getBaseEngine () const
+ 		+overridevirtual
+
+ +

Gets the base engine.

+
Returns
A const reference to the base engine.
+ +

Implements gridfire::engine::EngineView< DynamicEngine >.

+ +
+
+ +

◆ getDynamicSpecies()

+ +
+
+ + + + + + + +
const std::vector< Species > & gridfire::engine::MultiscalePartitioningEngineView::getDynamicSpecies () const
+
+ +

Gets the dynamic species in the network.

+
Returns
A const reference to the vector of species identified as "dynamic" or "slow".
+
Purpose
To allow external queries of the partitioning results.
+
How
It returns a const reference to the m_dynamic_species member vector.
+
Precondition
partitionNetwork() must have been called.
+ +
+
+ +

◆ getFastSpecies()

+ +
+
+ + + + + + + +
std::vector< Species > gridfire::engine::MultiscalePartitioningEngineView::getFastSpecies () const
+
+ +

Gets the fast species in the network.

+
Returns
A vector of species identified as "fast" or "algebraic" by the partitioning.
+
Purpose
To allow external queries of the partitioning results.
+
How
It returns a copy of the m_algebraic_species member vector.
+
Precondition
partitionNetwork() must have been called.
+ +
+
+ +

◆ getNetworkReactions()

+ +
+
+ + + + + +
+ + + + + + + +
const reaction::ReactionSet & gridfire::engine::MultiscalePartitioningEngineView::getNetworkReactions () const
+ 		+overridevirtual
+
+ +

Gets the set of logical reactions in the network.

+
Returns
A const reference to the LogicalReactionSet from the base engine, containing all reactions in the full network.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getNetworkSpecies()

+ +
+
+ + + + + +
+ + + + + + + +
const std::vector< Species > & gridfire::engine::MultiscalePartitioningEngineView::getNetworkSpecies () const
+ 		+overridevirtual
+
+ +

Gets the list of species in the network.

+
Returns
A const reference to the vector of Species objects representing all species in the underlying base engine. This view does not alter the species list itself, only how their abundances are evolved.
+ +

Implements gridfire::engine::Engine.

+ +
+
+ +

◆ getNormalizedEquilibratedComposition()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
fourdst::composition::Composition gridfire::engine::MultiscalePartitioningEngineView::getNormalizedEquilibratedComposition (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+
+ +

Gets a normalized composition with QSE species equilibrated.

+
Parameters
+ + + + +
compThe input composition.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
A new Composition object with algebraic species set to their equilibrium values.
+
Purpose
To provide a way to get the equilibrated composition without modifying the internal state.
+
How
It calls solveQSEAbundances() to compute the equilibrium abundances for the algebraic species, then constructs a new Composition object reflecting these values.
+
Precondition
The engine must have a valid QSE partition for the given state.
+
Exceptions
+ + +
StaleEngineErrorIf the QSE cache misses.
+
+
+ +
+
+ +

◆ getScreeningModel()

+ +
+
+ + + + + +
+ + + + + + + +
screening::ScreeningType gridfire::engine::MultiscalePartitioningEngineView::getScreeningModel () const
+ 		+overridevirtual
+
+ +

Gets the current electron screening model.

+
Returns
The currently active screening model type.
+
How
This method delegates directly to the base engine's getScreeningModel().
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getSpeciesDestructionTimescales()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
std::expected< std::unordered_map< Species, double >, EngineStatus > gridfire::engine::MultiscalePartitioningEngineView::getSpeciesDestructionTimescales (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Computes destruction timescales for all species in the network.

+
Parameters
+ + + + +
compThe current composition.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
A std::expected containing a map from Species to their characteristic destruction timescales (s) on success, or a StaleEngineError on failure.
+
Purpose
To get the timescale for species destruction, which is used as the primary metric for network partitioning.
+
How
It delegates the calculation to the base engine. For any species identified as algebraic (in QSE), it manually sets their timescale to 0.0.
+
Precondition
The engine must have a valid QSE cache entry for the given state.
+
Exceptions
+ + +
StaleEngineErrorIf the QSE cache misses.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getSpeciesIndex()

+ +
+
+ + + + + +
+ + + + + + + + +
size_t gridfire::engine::MultiscalePartitioningEngineView::getSpeciesIndex (const fourdst::atomic::Species & species) const
+ 		+overridevirtual
+
+ +

Gets the index of a species in the full network.

+
Parameters
+ + +
speciesThe species to get the index of.
+
+
+
Returns
The index of the species in the base engine's network.
+
How
This method delegates directly to the base engine's getSpeciesIndex().
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getSpeciesStatus()

+ +
+
+ + + + + +
+ + + + + + + + +
SpeciesStatus gridfire::engine::MultiscalePartitioningEngineView::getSpeciesStatus (const fourdst::atomic::Species & species) const
+ 		+overridevirtual
+
+ +

Gets the status of a species in the network.

+
Parameters
+ + +
speciesThe species to query.
+
+
+
Returns
The SpeciesStatus indicating if the species is dynamic, algebraic, or not involved.
+
Purpose
To allow external queries about the role of a species in the partitioned network.
+
How
It checks for membership in m_dynamic_species and m_algebraic_species to determine the appropriate status.
+
Precondition
partitionNetwork() must have been called.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getSpeciesTimescales()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
std::expected< std::unordered_map< Species, double >, EngineStatus > gridfire::engine::MultiscalePartitioningEngineView::getSpeciesTimescales (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Computes timescales for all species in the network.

+
Parameters
+ + + + +
compThe current composition.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
A std::expected containing a map from Species to their characteristic timescales (s) on success, or a StaleEngineError on failure.
+
Purpose
To get the characteristic timescale Y / (dY/dt) for each species.
+
How
It delegates the calculation to the base engine. For any species identified as algebraic (in QSE), it manually sets their timescale to 0.0 to signify that they equilibrate instantaneously on the timescale of the solver.
+
Precondition
The engine must have a valid QSE cache entry for the given state.
+
Exceptions
+ + +
StaleEngineErrorIf the QSE cache misses.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ getStoichiometryMatrixEntry()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int gridfire::engine::MultiscalePartitioningEngineView::getStoichiometryMatrixEntry (const fourdst::atomic::Species & species,
const reaction::Reaction & reaction 
) const
+ 		+overridevirtual
+
+ +

Gets an entry from the stoichiometry matrix.

+
Parameters
+ + + +
speciesSpecies to look up stoichiometry for.
reactionReaction to find.
+
+
+
Returns
Stoichiometric coefficient for the species in the reaction.
+
Purpose
To query the stoichiometric relationship between a species and a reaction.
+
How
This method delegates directly to the base engine's getStoichiometryMatrixEntry().
+
Precondition
generateStoichiometryMatrix() must have been called.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ group_is_a_qse_cluster()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::pair< bool, reaction::ReactionSet > gridfire::engine::MultiscalePartitioningEngineView::group_is_a_qse_cluster (const fourdst::composition::Composition & comp,
double T9,
double rho,
const QSEGroup & group 
) const
+ 		+private
+
+ +
+
+ +

◆ group_is_a_qse_pipeline()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
bool gridfire::engine::MultiscalePartitioningEngineView::group_is_a_qse_pipeline (const fourdst::composition::Composition & comp,
double T9,
double rho,
const QSEGroup & group 
) const
+ 		+private
+
+ +
+
+ +

◆ identifyMeanSlowestPool()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
size_t gridfire::engine::MultiscalePartitioningEngineView::identifyMeanSlowestPool (const std::vector< std::vector< fourdst::atomic::Species > > & pools,
const fourdst::composition::Composition & comp,
double T9,
double rho 
) const
+ 		+private
+
+ +

Identifies the pool with the slowest mean timescale.

+
Parameters
+ + + + + +
poolsA vector of vectors of species indices, where each inner vector represents a timescale pool.
compVector of current molar abundances for the full network.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
The index of the pool with the largest (slowest) mean destruction timescale.
+
Purpose
To identify the core set of dynamic species that will not be part of any QSE group.
+
How
It calculates the geometric mean of the destruction timescales for all species in each pool and returns the index of the pool with the maximum mean timescale.
+ +
+
+ +

◆ involvesSpecies()

+ +
+
+ + + + + + + + +
bool gridfire::engine::MultiscalePartitioningEngineView::involvesSpecies (const fourdst::atomic::Species & species) const
+
+ +

Checks if a species is involved in the partitioned network.

+
Parameters
+ + +
speciesThe species to check.
+
+
+
Returns
true if the species is in either the dynamic or algebraic sets, false otherwise.
+
Purpose
To allow external queries about species involvement in the partitioned network.
+
How
It checks for membership in both m_dynamic_species and m_algebraic_species.
+
Precondition
partitionNetwork() must have been called.
+ +
+
+ +

◆ involvesSpeciesInDynamic()

+ +
+
+ + + + + + + + +
bool gridfire::engine::MultiscalePartitioningEngineView::involvesSpeciesInDynamic (const fourdst::atomic::Species & species) const
+
+ +

Check if a species is involved in the dynamic set.

+
Parameters
+ + +
speciesThe species to check.
+
+
+
Returns
Boolean indicating if the species is in the dynamic set.
+ +
+
+ +

◆ involvesSpeciesInQSE()

+ +
+
+ + + + + + + + +
bool gridfire::engine::MultiscalePartitioningEngineView::involvesSpeciesInQSE (const fourdst::atomic::Species & species) const
+
+ +

Check if a species is involved in the QSE (algebraic) set.

+
Parameters
+ + +
speciesThe species to check.
+
+
+
Returns
Boolean indicating if the species is in the algebraic set.
+ +
+
+ +

◆ isStale()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::engine::MultiscalePartitioningEngineView::isStale (const NetIn & netIn)
+ 		+overridevirtual
+
+ +

Checks if the engine's internal state is stale relative to the provided conditions.

+
Parameters
+ + +
netInA struct containing the current network input.
+
+
+
Returns
true if the engine is stale, false otherwise.
+
Purpose
To determine if update() needs to be called.
+
How
It creates a QSECacheKey from the netIn data and checks for its existence in the m_qse_abundance_cache. A cache miss indicates the engine is stale because it does not have a valid QSE partition for the current conditions. It also queries the base engine's isStale() method.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ mapNetInToMolarAbundanceVector()

+ +
+
+ + + + + +
+ + + + + + + + +
std::vector< double > gridfire::engine::MultiscalePartitioningEngineView::mapNetInToMolarAbundanceVector (const NetIn & netIn) const
+ 		+overridevirtual
+
+ +

Maps a NetIn struct to a molar abundance vector for the full network.

+
Parameters
+ + +
netInA struct containing the current network input.
+
+
+
Returns
A vector of molar abundances corresponding to the species order in the base engine.
+
How
This method delegates directly to the base engine's mapNetInToMolarAbundanceVector().
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ merge_coupled_groups()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::vector< MultiscalePartitioningEngineView::QSEGroup > gridfire::engine::MultiscalePartitioningEngineView::merge_coupled_groups (const std::vector< QSEGroup > & groups,
const std::vector< reaction::ReactionSet > & groupReactions 
)
+ 		+staticprivate
+
+ +
+
+ +

◆ partitionByTimescale()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< std::vector< Species > > gridfire::engine::MultiscalePartitioningEngineView::partitionByTimescale (const fourdst::composition::Composition & comp,
double T9,
double rho 
) const
+ 		+private
+
+ +

Partitions the network by timescale.

+
Parameters
+ + + + +
compVector of current molar abundances for all species.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
A vector of vectors of species indices, where each inner vector represents a timescale pool.
+
Purpose
To group species into "pools" based on their destruction timescales.
+
How
It retrieves all species destruction timescales from the base engine, sorts them, and then iterates through the sorted list, creating a new pool whenever it detects a gap between consecutive timescales that is larger than a predefined threshold (e.g., a factor of 100).
+ +
+
+ +

◆ partitionNetwork()

+ +
+
+ + + + + + + + +
fourdst::composition::Composition gridfire::engine::MultiscalePartitioningEngineView::partitionNetwork (const NetIn & netIn)
+
+ +

Partitions the network based on timescales from a NetIn struct.

+
Parameters
+ + +
netInA struct containing the current network input.
+
+
+
Purpose
A convenience overload for partitionNetwork.
+
How
It unpacks the netIn struct into Y, T9, and rho and then calls the primary partitionNetwork method.
+ +
+
+ +

◆ primeEngine()

+ +
+
+ + + + + +
+ + + + + + + + +
PrimingReport gridfire::engine::MultiscalePartitioningEngineView::primeEngine (const NetIn & netIn)
+ 		+overridevirtual
+
+ +

Primes the engine with a specific species.

+
Parameters
+ + +
netInA struct containing the current network input.
+
+
+
Returns
A PrimingReport struct containing information about the priming process.
+
Purpose
To prepare the network for ignition or specific pathway studies.
+
How
This method delegates directly to the base engine's primeEngine(). The multiscale view does not currently interact with the priming process.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ pruneValidatedGroups()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< MultiscalePartitioningEngineView::QSEGroup > gridfire::engine::MultiscalePartitioningEngineView::pruneValidatedGroups (const std::vector< QSEGroup > & groups,
const std::vector< reaction::ReactionSet > & groupReactions,
const fourdst::composition::Composition & comp,
double T9,
double rho 
) const
+ 		+private
+
+ +
+
+ +

◆ setNetworkReactions()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::engine::MultiscalePartitioningEngineView::setNetworkReactions (const reaction::ReactionSet & reactions)
+ 		+overridevirtual
+
+ +

Sets the set of logical reactions in the network.

+
Parameters
+ + +
reactionsThe set of logical reactions to use.
+
+
+
Purpose
To modify the reaction network.
+
How
This operation is not supported by the MultiscalePartitioningEngineView as it would invalidate the partitioning logic. It logs a critical error and throws an exception. Network modifications should be done on the base engine before it is wrapped by this view.
+
Exceptions
+ + +
exceptions::UnableToSetNetworkReactionsErrorAlways.
+
+
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ setScreeningModel()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::engine::MultiscalePartitioningEngineView::setScreeningModel (screening::ScreeningType model)
+ 		+overridevirtual
+
+ +

Sets the electron screening model.

+
Parameters
+ + +
modelThe type of screening model to use for reaction rate calculations.
+
+
+
How
This method delegates directly to the base engine's setScreeningModel().
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ solveQSEAbundances()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
fourdst::composition::Composition gridfire::engine::MultiscalePartitioningEngineView::solveQSEAbundances (const fourdst::composition::CompositionAbstract & comp,
double T9,
double rho 
) const
+ 		+private
+
+ +

Solves for the QSE abundances of the algebraic species in a given state.

+
Parameters
+ + + + +
compVector of current molar abundances for all species in the base engine.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
A vector of molar abundances for the algebraic species.
+
Purpose
To find the equilibrium abundances of the algebraic species that satisfy the QSE conditions.
+
How
It uses the Levenberg-Marquardt algorithm via Eigen's LevenbergMarquardt class. The problem is defined by the EigenFunctor which computes the residuals and Jacobian for the QSE equations.
+
Precondition
The input state (Y_full, T9, rho) must be a valid physical state.
+
Postcondition
The algebraic species in the QSE cache are updated with the new equilibrium abundances.
+ +
+
+ +

◆ update()

+ +
+
+ + + + + +
+ + + + + + + + +
fourdst::composition::Composition gridfire::engine::MultiscalePartitioningEngineView::update (const NetIn & netIn)
+ 		+overridevirtual
+
+ +

Updates the internal state of the engine, performing partitioning and QSE equilibration.

+
Parameters
+ + +
netInA struct containing the current network input: temperature, density, and composition.
+
+
+
Returns
The new composition after QSE species have been brought to equilibrium.
+
Purpose
This is the main entry point for preparing the multiscale engine for use. It triggers the network partitioning and solves for the initial QSE abundances, caching the result.
+

@how

    +
  1. It first checks the QSE cache. If a valid entry already exists for the input state, it returns the input composition, as no work is needed.
    2. +
  2. If the cache misses, it calls equilibrateNetwork().
    3. +
  3. equilibrateNetwork() in turn calls partitionNetwork() to define the dynamic and algebraic species sets.
    4. +
  4. It then calls solveQSEAbundances() to compute the equilibrium abundances.
    5. +
  5. The resulting equilibrium abundances for the algebraic species are stored in the m_qse_abundance_cache.
    6. +
  6. A new fourdst::composition::Composition object reflecting the equilibrated state is created and returned.
    7. +
+
Precondition
The netIn struct should contain a valid physical state.
+
Postcondition
The engine is partitioned (m_dynamic_species, m_algebraic_species, etc. are populated). The m_qse_abundance_cache is populated with the QSE solution for the given state. The returned composition reflects the new equilibrium.
+ +

Implements gridfire::engine::DynamicEngine.

+ +
+
+ +

◆ validateGroupsWithFluxAnalysis()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MultiscalePartitioningEngineView::FluxValidationResult gridfire::engine::MultiscalePartitioningEngineView::validateGroupsWithFluxAnalysis (const std::vector< QSEGroup > & candidate_groups,
const fourdst::composition::Composition & comp,
double T9,
double rho 
) const
+ 		+private
+
+ +

Validates candidate QSE groups using flux analysis.

+
Parameters
+ + + + + +
candidate_groupsA vector of candidate QSE groups.
compVector of current molar abundances for the full network.
T9Temperature in units of 10^9 K.
rhoDensity in g/cm^3.
+
+
+
Returns
A vector of validated QSE groups that meet the flux criteria.
+
Purpose
To ensure that a candidate QSE group is truly in equilibrium by checking that the reaction fluxes within the group are much larger than the fluxes leaving the group.
+
How
For each candidate group, it calculates the sum of all internal reaction fluxes and the sum of all external (bridge) reaction fluxes. If the ratio of internal to external flux exceeds a configurable threshold, the group is considered valid and is added to the returned vector.
+ +
+
+

Member Data Documentation

+ +

◆ m_activeReactionIndices

+ +
+
+ + + + + +
+ + + + +
std::vector<size_t> gridfire::engine::MultiscalePartitioningEngineView::m_activeReactionIndices
+ 		+private
+
+ +

Indices of all reactions involving only active species.

+ +
+
+ +

◆ m_activeSpeciesIndices

+ +
+
+ + + + + +
+ + + + +
std::vector<size_t> gridfire::engine::MultiscalePartitioningEngineView::m_activeSpeciesIndices
+ 		+private
+
+ +

Indices of all species considered active in the current partition (dynamic + algebraic).

+ +
+
+ +

◆ m_algebraic_abundances

+ +
+
+ + + + + +
+ + + + +
std::unordered_map<fourdst::atomic::Species, double> gridfire::engine::MultiscalePartitioningEngineView::m_algebraic_abundances
+ 		+private
+
+ +

Map from species to their calculated abundances in the QSE state.

+ +
+
+ +

◆ m_algebraic_species

+ +
+
+ + + + + +
+ + + + +
std::vector<fourdst::atomic::Species> gridfire::engine::MultiscalePartitioningEngineView::m_algebraic_species
+ 		+private
+
+ +

Species that are treated as algebraic (in QSE) in the QSE groups.

+ +
+
+ +

◆ m_baseEngine

+ +
+
+ + + + + +
+ + + + +
DynamicEngine& gridfire::engine::MultiscalePartitioningEngineView::m_baseEngine
+ 		+private
+
+ +

The base engine to which this view delegates calculations.

+ +
+
+ +

◆ m_composition_cache

+ +
+
+ + + + + +
+ + + + +
std::unordered_map<uint64_t, fourdst::composition::Composition> gridfire::engine::MultiscalePartitioningEngineView::m_composition_cache
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_dynamic_species

+ +
+
+ + + + + +
+ + + + +
std::vector<fourdst::atomic::Species> gridfire::engine::MultiscalePartitioningEngineView::m_dynamic_species
+ 		+private
+
+ +

The simplified set of species presented to the solver (the "slow" species).

+ +
+
+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::engine::MultiscalePartitioningEngineView::m_logger = LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +

Logger instance for logging messages.

+ +
+
+ +

◆ m_qse_groups

+ +
+
+ + + + + +
+ + + + +
std::vector<QSEGroup> gridfire::engine::MultiscalePartitioningEngineView::m_qse_groups
+ 		+private
+
+ +

The list of identified equilibrium groups.

+ +
+
+ +

◆ m_qse_solvers

+ +
+
+ + + + + +
+ + + + +
std::vector<std::unique_ptr<QSESolver> > gridfire::engine::MultiscalePartitioningEngineView::m_qse_solvers
+ 		+private
+
+ +

A set of solvers, one for each QSE group.

+ +
+
+ +

◆ m_sun_ctx

+ +
+
+ + + + + +
+ + + + +
SUNContext gridfire::engine::MultiscalePartitioningEngineView::m_sun_ctx = nullptr
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.js b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.js new file mode 100644 index 00000000..be4c0c2d --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.js @@ -0,0 +1,62 @@ +var classgridfire_1_1engine_1_1MultiscalePartitioningEngineView = +[ + [ "FluxValidationResult", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult.html", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult" ], + [ "QSEGroup", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup" ], + [ "QSESolver", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver" ], + [ "QSEPartition", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a892741542388166db4dc55631567ee0a", null ], + [ "MultiscalePartitioningEngineView", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a0a500b19283ad3dd654ca4c4646b2604", null ], + [ "~MultiscalePartitioningEngineView", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#ae553a4d590c0cfae5591bcd8bbe6f9d3", null ], + [ "analyzeTimescalePoolConnectivity", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a8d4153f520b486dbb262888e22b95896", null ], + [ "buildConnectivityGraph", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a35482c1d5f1d2b3f2cd6c3976432644e", null ], + [ "calculateEpsDerivatives", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#ac720fcea2f0304c3d7e7ba8a6dfb84da", null ], + [ "calculateMolarReactionFlow", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#af030c9bd6a95686a09429b4619ad188c", null ], + [ "calculateRHSAndEnergy", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#aa960005503d18066015aef280680d616", null ], + [ "collectComposition", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a97d9616558f681ad010ee452394f3519", null ], + [ "constructCandidateGroups", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a28502c9e8fc0a40211fd3717c2b67214", null ], + [ "exportToDot", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#accbf5a67f126627833a4169a81f1be01", null ], + [ "generateJacobianMatrix", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a8950fb9c0c36684538805de4f0acf82e", null ], + [ "generateJacobianMatrix", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a64b6e7e5794cc42edf72899d348d15af", null ], + [ "generateJacobianMatrix", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#aae6c00cff4f7a992513d1e9481436f8f", null ], + [ "generateStoichiometryMatrix", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a552fa7e1f4e066fa577c55500e782014", null ], + [ "getBaseEngine", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#ad80faf5bea2153480cbfb323ed805686", null ], + [ "getDynamicSpecies", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a7d2f445ae7b75d4cd879afb6e960e0f7", null ], + [ "getFastSpecies", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#aebb0977daa8c6a9c496f0f989f950fae", null ], + [ "getNetworkReactions", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a9dc9de4359beb704b94024f159ae619d", null ], + [ "getNetworkSpecies", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#aa7aa38cf054988d050c04c59f28efdaa", null ], + [ "getNormalizedEquilibratedComposition", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a6fc4cb156a287f579cb0f0c5d88d74d0", null ], + [ "getScreeningModel", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#accdd09720d44cc5efb1ee267706f0500", null ], + [ "getSpeciesDestructionTimescales", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a27d68f2e6c4572445cd94dc472470a01", null ], + [ "getSpeciesIndex", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#ae0c02c830cf45568a7c4d35d4ed15e95", null ], + [ "getSpeciesStatus", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#aec5ebaccf625e39d0fa6c1330855d008", null ], + [ "getSpeciesTimescales", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a86390e410db48addfe8dbd094743c38e", null ], + [ "getStoichiometryMatrixEntry", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a1372e7a823841c819f6c1a15d38217a6", null ], + [ "group_is_a_qse_cluster", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#ae7f2939150a5ed84e51028c8ebd83d17", null ], + [ "group_is_a_qse_pipeline", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a6adac01afdd51cb3660e38731afbd265", null ], + [ "identifyMeanSlowestPool", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a72d813f71b378dfd6f632e6b9adf1cc5", null ], + [ "involvesSpecies", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#ad8615cd1f4b78ec1c1448c96c54913e4", null ], + [ "involvesSpeciesInDynamic", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#aa55fe8b346dca4a06027acac9a2547a3", null ], + [ "involvesSpeciesInQSE", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a4476e65dd6ce8700f5163ff7b29185e4", null ], + [ "isStale", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a10dd189ba40dbb604fdf55746b5d4b79", null ], + [ "mapNetInToMolarAbundanceVector", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#aa839c3893ff9fb8e5a4187224dac7b47", null ], + [ "merge_coupled_groups", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a4da0432598ecb0415b70b94d8300d3ef", null ], + [ "partitionByTimescale", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#aaba92340dd44399c48bc219ec63f94e2", null ], + [ "partitionNetwork", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a7629f98050d71160fc34e5c7c0b3e959", null ], + [ "primeEngine", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#afabb6222bd6cbe3277b6c8639203be25", null ], + [ "pruneValidatedGroups", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a601a4fb916f003c9ff7cf000a8006bab", null ], + [ "setNetworkReactions", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#aa378d0e0fa6018b989d83945daa47952", null ], + [ "setScreeningModel", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#ad11aa1e168ec03d0c3ed90eeddcefe52", null ], + [ "solveQSEAbundances", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a6c785a6334e5fd9593d3e279bafee592", null ], + [ "update", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a28c8ac1ec594cf55a297e3f9586e214a", null ], + [ "validateGroupsWithFluxAnalysis", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#acf5cfbd18ebb2566f637cb176f861423", null ], + [ "m_activeReactionIndices", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#ab6c4cddda054dfa35f6e0a083015dc9d", null ], + [ "m_activeSpeciesIndices", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a40ddd53c7f5482237e4bad38525ee100", null ], + [ "m_algebraic_abundances", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#abcf6a7ba929fe4c45e2a4deeb2bfca82", null ], + [ "m_algebraic_species", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#aac8ac0afe8fd443b661d849e9b1b5e72", null ], + [ "m_baseEngine", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a460e8e46d38b81efa510714a3375f674", null ], + [ "m_composition_cache", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a38b0eb7e7e454e001254aa823b1ec3f7", null ], + [ "m_dynamic_species", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a69baf327ba82f923859c569bc4d76ee8", null ], + [ "m_logger", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#add096961cacfa9206ae5227d4f3a3c36", null ], + [ "m_qse_groups", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a36ccf1d3b4cefba461acddcb238f27a5", null ], + [ "m_qse_solvers", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a3d0cde126563adc97b998bade1132603", null ], + [ "m_sun_ctx", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html#a76c2ce886f8774f56a2ee9e0ae1b9893", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver-members.html b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver-members.html new file mode 100644 index 00000000..fbb07e4a --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver-members.html @@ -0,0 +1,135 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::MultiscalePartitioningEngineView::QSESolver Member List
+
+
+ +

This is the complete list of members for gridfire::engine::MultiscalePartitioningEngineView::QSESolver, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
getLogger()gridfire::engine::MultiscalePartitioningEngineView::QSESolverinlineprivatestatic
log_diagnostics(const QSEGroup &group, const fourdst::composition::Composition &comp) constgridfire::engine::MultiscalePartitioningEngineView::QSESolver
m_constraintsgridfire::engine::MultiscalePartitioningEngineView::QSESolverprivate
m_enginegridfire::engine::MultiscalePartitioningEngineView::QSESolverprivate
m_f_scalegridfire::engine::MultiscalePartitioningEngineView::QSESolverprivate
m_func_tmplgridfire::engine::MultiscalePartitioningEngineView::QSESolverprivate
m_has_jacobiangridfire::engine::MultiscalePartitioningEngineView::QSESolvermutableprivate
m_Jgridfire::engine::MultiscalePartitioningEngineView::QSESolverprivate
m_kinsol_memgridfire::engine::MultiscalePartitioningEngineView::QSESolverprivate
m_LSgridfire::engine::MultiscalePartitioningEngineView::QSESolverprivate
m_Ngridfire::engine::MultiscalePartitioningEngineView::QSESolverprivate
m_scalegridfire::engine::MultiscalePartitioningEngineView::QSESolverprivate
m_solvesgridfire::engine::MultiscalePartitioningEngineView::QSESolvermutableprivate
m_speciesgridfire::engine::MultiscalePartitioningEngineView::QSESolverprivate
m_speciesMapgridfire::engine::MultiscalePartitioningEngineView::QSESolverprivate
m_sun_ctxgridfire::engine::MultiscalePartitioningEngineView::QSESolverprivate
m_Ygridfire::engine::MultiscalePartitioningEngineView::QSESolverprivate
operator=(const QSESolver &other)=deletegridfire::engine::MultiscalePartitioningEngineView::QSESolver
QSESolver(const std::vector< fourdst::atomic::Species > &species, const DynamicEngine &engine, SUNContext sun_ctx)gridfire::engine::MultiscalePartitioningEngineView::QSESolver
QSESolver(const QSESolver &other)=deletegridfire::engine::MultiscalePartitioningEngineView::QSESolver
solve(const fourdst::composition::Composition &comp, double T9, double rho) constgridfire::engine::MultiscalePartitioningEngineView::QSESolver
solves() constgridfire::engine::MultiscalePartitioningEngineView::QSESolver
sys_func(N_Vector y, N_Vector f, void *user_data)gridfire::engine::MultiscalePartitioningEngineView::QSESolverprivatestatic
sys_jac(N_Vector y, N_Vector fy, SUNMatrix J, void *user_data, N_Vector tmp1, N_Vector tmp2)gridfire::engine::MultiscalePartitioningEngineView::QSESolverprivatestatic
~QSESolver()gridfire::engine::MultiscalePartitioningEngineView::QSESolver
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html new file mode 100644 index 00000000..47d04846 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html @@ -0,0 +1,830 @@ + + + + + + + +GridFire: gridfire::engine::MultiscalePartitioningEngineView::QSESolver Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Classes | +Public Member Functions | +Static Private Member Functions | +Private Attributes | +List of all members
+
gridfire::engine::MultiscalePartitioningEngineView::QSESolver Class Reference
+
+
+
+Collaboration diagram for gridfire::engine::MultiscalePartitioningEngineView::QSESolver:
+
+
+
[legend]
+ + + + +

+Classes

struct  UserData
 
+ + + + + + + + + + + + + + + +

+Public Member Functions

 QSESolver (const std::vector< fourdst::atomic::Species > &species, const DynamicEngine &engine, SUNContext sun_ctx)
 
 QSESolver (const QSESolver &other)=delete
 
QSESolver & operator= (const QSESolver &other)=delete
 
 ~QSESolver ()
 
fourdst::composition::Composition solve (const fourdst::composition::Composition &comp, double T9, double rho) const
 
size_t solves () const
 
void log_diagnostics (const QSEGroup &group, const fourdst::composition::Composition &comp) const
 
+ + + + + + + +

+Static Private Member Functions

static int sys_func (N_Vector y, N_Vector f, void *user_data)
 
static int sys_jac (N_Vector y, N_Vector fy, SUNMatrix J, void *user_data, N_Vector tmp1, N_Vector tmp2)
 
static quill::Logger * getLogger ()
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Private Attributes

size_t m_solves = 0
 
bool m_has_jacobian = false
 
size_t m_N
 
const DynamicEngine & m_engine
 
std::vector< fourdst::atomic::Species > m_species
 
std::unordered_map< fourdst::atomic::Species, size_t > m_speciesMap
 
SUNContext m_sun_ctx = nullptr
 
void * m_kinsol_mem = nullptr
 
N_Vector m_Y = nullptr
 
N_Vector m_scale = nullptr
 
N_Vector m_f_scale = nullptr
 
N_Vector m_constraints = nullptr
 
N_Vector m_func_tmpl = nullptr
 
SUNMatrix m_J = nullptr
 
SUNLinearSolver m_LS = nullptr
 
+

Constructor & Destructor Documentation

+ +

◆ QSESolver() [1/2]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
gridfire::engine::MultiscalePartitioningEngineView::QSESolver::QSESolver (const std::vector< fourdst::atomic::Species > & species,
const DynamicEngine & engine,
SUNContext sun_ctx 
)
+
+ +
+
+ +

◆ QSESolver() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::engine::MultiscalePartitioningEngineView::QSESolver::QSESolver (const QSESolver & other)
+ 		+delete
+
+ +
+
+ +

◆ ~QSESolver()

+ +
+
+ + + + + + + +
gridfire::engine::MultiscalePartitioningEngineView::QSESolver::~QSESolver ()
+
+ +
+
+

Member Function Documentation

+ +

◆ getLogger()

+ +
+
+ + + + + +
+ + + + + + + +
static quill::Logger * gridfire::engine::MultiscalePartitioningEngineView::QSESolver::getLogger ()
+ 		+inlinestaticprivate
+
+ +
+
+ +

◆ log_diagnostics()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void gridfire::engine::MultiscalePartitioningEngineView::QSESolver::log_diagnostics (const QSEGroup & group,
const fourdst::composition::Composition & comp 
) const
+
+ +
+
+ +

◆ operator=()

+ +
+
+ + + + + +
+ + + + + + + + +
QSESolver & gridfire::engine::MultiscalePartitioningEngineView::QSESolver::operator= (const QSESolver & other)
+ 		+delete
+
+ +
+
+ +

◆ solve()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
fourdst::composition::Composition gridfire::engine::MultiscalePartitioningEngineView::QSESolver::solve (const fourdst::composition::Composition & comp,
double T9,
double rho 
) const
+
+ +
+
+ +

◆ solves()

+ +
+
+ + + + + + + +
size_t gridfire::engine::MultiscalePartitioningEngineView::QSESolver::solves () const
+
+ +
+
+ +

◆ sys_func()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
int gridfire::engine::MultiscalePartitioningEngineView::QSESolver::sys_func (N_Vector y,
N_Vector f,
void * user_data 
)
+ 		+staticprivate
+
+ +
+
+ +

◆ sys_jac()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int gridfire::engine::MultiscalePartitioningEngineView::QSESolver::sys_jac (N_Vector y,
N_Vector fy,
SUNMatrix J,
void * user_data,
N_Vector tmp1,
N_Vector tmp2 
)
+ 		+staticprivate
+
+ +
+
+

Member Data Documentation

+ +

◆ m_constraints

+ +
+
+ + + + + +
+ + + + +
N_Vector gridfire::engine::MultiscalePartitioningEngineView::QSESolver::m_constraints = nullptr
+ 		+private
+
+ +
+
+ +

◆ m_engine

+ +
+
+ + + + + +
+ + + + +
const DynamicEngine& gridfire::engine::MultiscalePartitioningEngineView::QSESolver::m_engine
+ 		+private
+
+ +
+
+ +

◆ m_f_scale

+ +
+
+ + + + + +
+ + + + +
N_Vector gridfire::engine::MultiscalePartitioningEngineView::QSESolver::m_f_scale = nullptr
+ 		+private
+
+ +
+
+ +

◆ m_func_tmpl

+ +
+
+ + + + + +
+ + + + +
N_Vector gridfire::engine::MultiscalePartitioningEngineView::QSESolver::m_func_tmpl = nullptr
+ 		+private
+
+ +
+
+ +

◆ m_has_jacobian

+ +
+
+ + + + + +
+ + + + +
bool gridfire::engine::MultiscalePartitioningEngineView::QSESolver::m_has_jacobian = false
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_J

+ +
+
+ + + + + +
+ + + + +
SUNMatrix gridfire::engine::MultiscalePartitioningEngineView::QSESolver::m_J = nullptr
+ 		+private
+
+ +
+
+ +

◆ m_kinsol_mem

+ +
+
+ + + + + +
+ + + + +
void* gridfire::engine::MultiscalePartitioningEngineView::QSESolver::m_kinsol_mem = nullptr
+ 		+private
+
+ +
+
+ +

◆ m_LS

+ +
+
+ + + + + +
+ + + + +
SUNLinearSolver gridfire::engine::MultiscalePartitioningEngineView::QSESolver::m_LS = nullptr
+ 		+private
+
+ +
+
+ +

◆ m_N

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::engine::MultiscalePartitioningEngineView::QSESolver::m_N
+ 		+private
+
+ +
+
+ +

◆ m_scale

+ +
+
+ + + + + +
+ + + + +
N_Vector gridfire::engine::MultiscalePartitioningEngineView::QSESolver::m_scale = nullptr
+ 		+private
+
+ +
+
+ +

◆ m_solves

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::engine::MultiscalePartitioningEngineView::QSESolver::m_solves = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_species

+ +
+
+ + + + + +
+ + + + +
std::vector<fourdst::atomic::Species> gridfire::engine::MultiscalePartitioningEngineView::QSESolver::m_species
+ 		+private
+
+ +
+
+ +

◆ m_speciesMap

+ +
+
+ + + + + +
+ + + + +
std::unordered_map<fourdst::atomic::Species, size_t> gridfire::engine::MultiscalePartitioningEngineView::QSESolver::m_speciesMap
+ 		+private
+
+ +
+
+ +

◆ m_sun_ctx

+ +
+
+ + + + + +
+ + + + +
SUNContext gridfire::engine::MultiscalePartitioningEngineView::QSESolver::m_sun_ctx = nullptr
+ 		+private
+
+ +
+
+ +

◆ m_Y

+ +
+
+ + + + + +
+ + + + +
N_Vector gridfire::engine::MultiscalePartitioningEngineView::QSESolver::m_Y = nullptr
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.js b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.js new file mode 100644 index 00000000..760e6abf --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.js @@ -0,0 +1,29 @@ +var classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver = +[ + [ "UserData", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData.html", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData" ], + [ "QSESolver", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#a953520d6b705533fbdea699a50e31d54", null ], + [ "QSESolver", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#a37c03744aea2c7e16b977c2f6a19691a", null ], + [ "~QSESolver", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#a308ee7b77cde2658ea0c1e43827cea49", null ], + [ "getLogger", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#a8759a711c25a587877fbccdebdb9ecd9", null ], + [ "log_diagnostics", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#a616b818685cc51e0c1926a46435cbb68", null ], + [ "operator=", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#a338cd55e34af1286f0f4593b04be7508", null ], + [ "solve", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#aa6f28cf2f5759efad7d428f6794cc151", null ], + [ "solves", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#a420ca8991dd60fac7a9d18fae0eda0c1", null ], + [ "sys_func", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#a58b7b2ac01c40084cc839309267e400e", null ], + [ "sys_jac", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#a9a34e36baa074c1b39b230e0b5010a82", null ], + [ "m_constraints", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#a4ca611a4c787c2f79ecd3b900547fac6", null ], + [ "m_engine", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#abea3337e56ce71edf783506ef47a9f50", null ], + [ "m_f_scale", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#a219705d977e7593574e6e5c30fcc417a", null ], + [ "m_func_tmpl", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#ae7a185c468a5aa89fc634564cbad11fb", null ], + [ "m_has_jacobian", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#a4015ddf2c8e43f67a92a3f7eb99d7ea8", null ], + [ "m_J", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#af1f5e08da10ac14cf89ca6cceaf5a107", null ], + [ "m_kinsol_mem", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#a3bdbe052602fbe5ef4c5e55234fabc3e", null ], + [ "m_LS", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#a4da5ce19b4dd8f09d57a21feb002c29e", null ], + [ "m_N", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#a5da604d8ef9f677e8eda68bda5755274", null ], + [ "m_scale", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#ac545aed391b0396e73dfbef6719d3887", null ], + [ "m_solves", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#ae23a4066b2300223c4d52242c19c2200", null ], + [ "m_species", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#a6cd6dd07a046bac3d177126be421b723", null ], + [ "m_speciesMap", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#ae214780e957d7dd0f17c7cacc604dd7e", null ], + [ "m_sun_ctx", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#a9c69bae124936b4843876306e9d03860", null ], + [ "m_Y", "classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html#ad5d00b0dfeb9dd9ba54f75e8c80f62ab", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver__coll__graph.map b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver__coll__graph.map new file mode 100644 index 00000000..b507bfd6 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver__coll__graph.map @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver__coll__graph.md5 b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver__coll__graph.md5 new file mode 100644 index 00000000..e32038f9 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver__coll__graph.md5 @@ -0,0 +1 @@ +9553c97d519d9aa5b015f274d1e352d0 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver__coll__graph.svg b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver__coll__graph.svg new file mode 100644 index 00000000..5f925465 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver__coll__graph.svg @@ -0,0 +1,213 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::engine::MultiscalePartitioningEngineView::QSESolver + + +Node1 + + +gridfire::engine::Multiscale +PartitioningEngineView:: +QSESolver + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + m_engine + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node4->Node1 + + + + + + m_species + + + +Node5 + + +Species + + + + + +Node5->Node4 + + + + + + elements + + + +Node6 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node5->Node6 + + + + + + keys + + + +Node6->Node1 + + + + + + m_speciesMap + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver__coll__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver__coll__graph_org.svg new file mode 100644 index 00000000..cbe827f5 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver__coll__graph_org.svg @@ -0,0 +1,131 @@ + + + + + + +gridfire::engine::MultiscalePartitioningEngineView::QSESolver + + +Node1 + + +gridfire::engine::Multiscale +PartitioningEngineView:: +QSESolver + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + m_engine + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node4->Node1 + + + + + + m_species + + + +Node5 + + +Species + + + + + +Node5->Node4 + + + + + + elements + + + +Node6 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node5->Node6 + + + + + + keys + + + +Node6->Node1 + + + + + + m_speciesMap + + + diff --git a/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__coll__graph.map b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__coll__graph.map new file mode 100644 index 00000000..719d4325 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__coll__graph.map @@ -0,0 +1,41 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__coll__graph.md5 b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__coll__graph.md5 new file mode 100644 index 00000000..4634d1e0 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__coll__graph.md5 @@ -0,0 +1 @@ +1c6e729080004c268490cb1576b59c5d \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__coll__graph.svg b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__coll__graph.svg new file mode 100644 index 00000000..5bfe5d9f --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__coll__graph.svg @@ -0,0 +1,489 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::engine::MultiscalePartitioningEngineView + + +Node1 + + +gridfire::engine::Multiscale +PartitioningEngineView + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node2->Node1 + + + + + + m_baseEngine + + + +Node11 + + +gridfire::engine::Multiscale +PartitioningEngineView:: +QSESolver + + + + + +Node2->Node11 + + + + + + m_engine + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node4->Node1 + + + + + + + + +Node5 + + +std::vector< gridfire +::engine::MultiscalePartitioning +EngineView::QSEGroup > + + + + + +Node5->Node1 + + + + + + m_qse_groups + + + +Node6 + + +gridfire::engine::Multiscale +PartitioningEngineView:: +QSEGroup + + + + + +Node6->Node5 + + + + + + elements + + + +Node7 + + +std::set< fourdst:: +atomic::Species > + + + + + +Node7->Node6 + + + + + + algebraic_species +seed_species + + + +Node8 + + +Species + + + + + +Node8->Node7 + + + + + + keys + + + +Node12 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node8->Node12 + + + + + + elements + + + +Node13 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node8->Node13 + + + + + + keys + + + +Node14 + + +std::unordered_map +< fourdst::atomic::Species, + double > + + + + + +Node8->Node14 + + + + + + keys + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::engine +::MultiscalePartitioningEngineView +::QSESolver > > + + + + + +Node9->Node1 + + + + + + m_qse_solvers + + + +Node10 + + +std::unique_ptr< gridfire +::engine::MultiscalePartitioning +EngineView::QSESolver > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node1 + + + + + + m_algebraic_species +m_dynamic_species + + + +Node12->Node11 + + + + + + m_species + + + +Node13->Node11 + + + + + + m_speciesMap + + + +Node14->Node1 + + + + + + m_algebraic_abundances + + + +Node15 + + +std::vector< size_t > + + + + + +Node15->Node1 + + + + + + m_activeReactionIndices +m_activeSpeciesIndices + + + +Node16 + + +std::unordered_map +< uint64_t, fourdst +::composition::Composition > + + + + + +Node16->Node1 + + + + + + m_composition_cache + + + +Node17 + + +Composition + + + + + +Node17->Node16 + + + + + + elements + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__coll__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__coll__graph_org.svg new file mode 100644 index 00000000..306eea51 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__coll__graph_org.svg @@ -0,0 +1,407 @@ + + + + + + +gridfire::engine::MultiscalePartitioningEngineView + + +Node1 + + +gridfire::engine::Multiscale +PartitioningEngineView + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node2->Node1 + + + + + + m_baseEngine + + + +Node11 + + +gridfire::engine::Multiscale +PartitioningEngineView:: +QSESolver + + + + + +Node2->Node11 + + + + + + m_engine + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node4->Node1 + + + + + + + + +Node5 + + +std::vector< gridfire +::engine::MultiscalePartitioning +EngineView::QSEGroup > + + + + + +Node5->Node1 + + + + + + m_qse_groups + + + +Node6 + + +gridfire::engine::Multiscale +PartitioningEngineView:: +QSEGroup + + + + + +Node6->Node5 + + + + + + elements + + + +Node7 + + +std::set< fourdst:: +atomic::Species > + + + + + +Node7->Node6 + + + + + + algebraic_species +seed_species + + + +Node8 + + +Species + + + + + +Node8->Node7 + + + + + + keys + + + +Node12 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node8->Node12 + + + + + + elements + + + +Node13 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node8->Node13 + + + + + + keys + + + +Node14 + + +std::unordered_map +< fourdst::atomic::Species, + double > + + + + + +Node8->Node14 + + + + + + keys + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::engine +::MultiscalePartitioningEngineView +::QSESolver > > + + + + + +Node9->Node1 + + + + + + m_qse_solvers + + + +Node10 + + +std::unique_ptr< gridfire +::engine::MultiscalePartitioning +EngineView::QSESolver > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node1 + + + + + + m_algebraic_species +m_dynamic_species + + + +Node12->Node11 + + + + + + m_species + + + +Node13->Node11 + + + + + + m_speciesMap + + + +Node14->Node1 + + + + + + m_algebraic_abundances + + + +Node15 + + +std::vector< size_t > + + + + + +Node15->Node1 + + + + + + m_activeReactionIndices +m_activeSpeciesIndices + + + +Node16 + + +std::unordered_map +< uint64_t, fourdst +::composition::Composition > + + + + + +Node16->Node1 + + + + + + m_composition_cache + + + +Node17 + + +Composition + + + + + +Node17->Node16 + + + + + + elements + + + diff --git a/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__inherit__graph.map b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__inherit__graph.map new file mode 100644 index 00000000..b7b4e5a1 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__inherit__graph.md5 b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__inherit__graph.md5 new file mode 100644 index 00000000..f1a08474 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__inherit__graph.md5 @@ -0,0 +1 @@ +1cd7313725a665fb58097862bb794aa0 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__inherit__graph.svg b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__inherit__graph.svg new file mode 100644 index 00000000..bce72078 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__inherit__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +gridfire::engine::MultiscalePartitioningEngineView + + +Node1 + + +gridfire::engine::Multiscale +PartitioningEngineView + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node4->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__inherit__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__inherit__graph_org.svg new file mode 100644 index 00000000..3a80f1ab --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1MultiscalePartitioningEngineView__inherit__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +gridfire::engine::MultiscalePartitioningEngineView + + +Node1 + + +gridfire::engine::Multiscale +PartitioningEngineView + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node4->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1NetworkJacobian-members.html b/docs/html/classgridfire_1_1engine_1_1NetworkJacobian-members.html new file mode 100644 index 00000000..a99d83ac --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1NetworkJacobian-members.html @@ -0,0 +1,131 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::NetworkJacobian Member List
+
+
+ +

This is the complete list of members for gridfire::engine::NetworkJacobian, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + +
data() constgridfire::engine::NetworkJacobian
infs() constgridfire::engine::NetworkJacobian
m_jacobianMatrixgridfire::engine::NetworkJacobianprivate
m_rankgridfire::engine::NetworkJacobianmutableprivate
m_speciesToIndexMapgridfire::engine::NetworkJacobianprivate
mapping() constgridfire::engine::NetworkJacobian
nans() constgridfire::engine::NetworkJacobian
NetworkJacobian(const Eigen::SparseMatrix< double > &jacobianMatrix, const std::function< fourdst::atomic::Species(size_t)> &indexToSpeciesFunc)gridfire::engine::NetworkJacobianexplicit
NetworkJacobian(const NetworkJacobian &jacobian)gridfire::engine::NetworkJacobian
NetworkJacobian(NetworkJacobian &&jacobian) noexceptgridfire::engine::NetworkJacobian
nnz() constgridfire::engine::NetworkJacobian
operator()(const fourdst::atomic::Species &row, const fourdst::atomic::Species &col) constgridfire::engine::NetworkJacobian
operator()(size_t i, size_t j) constgridfire::engine::NetworkJacobian
operator=(NetworkJacobian &&jacobian) noexceptgridfire::engine::NetworkJacobian
rank() constgridfire::engine::NetworkJacobian
set(const fourdst::atomic::Species &row, const fourdst::atomic::Species &col, double value)gridfire::engine::NetworkJacobian
set(size_t i, size_t j, double value)gridfire::engine::NetworkJacobian
set(const JacobianEntry &entry)gridfire::engine::NetworkJacobian
shape() constgridfire::engine::NetworkJacobian
singular() constgridfire::engine::NetworkJacobian
to_csv(const std::string &filename) constgridfire::engine::NetworkJacobian
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1NetworkJacobian.html b/docs/html/classgridfire_1_1engine_1_1NetworkJacobian.html new file mode 100644 index 00000000..3bcce7c4 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1NetworkJacobian.html @@ -0,0 +1,783 @@ + + + + + + + +GridFire: gridfire::engine::NetworkJacobian Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
gridfire::engine::NetworkJacobian Class Reference
+
+
+ +

A wrapper class for handling the network Jacobian matrix. + More...

+ +

#include <jacobian.h>

+
+Collaboration diagram for gridfire::engine::NetworkJacobian:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 NetworkJacobian (const Eigen::SparseMatrix< double > &jacobianMatrix, const std::function< fourdst::atomic::Species(size_t)> &indexToSpeciesFunc)
 Constructs a NetworkJacobian with the given sparse matrix and species index mapping function.
 
 NetworkJacobian (const NetworkJacobian &jacobian)
 Copy constructor for NetworkJacobian.
 
 NetworkJacobian (NetworkJacobian &&jacobian) noexcept
 Copy assignment operator for NetworkJacobian.
 
NetworkJacobian & operator= (NetworkJacobian &&jacobian) noexcept
 Move constructor for NetworkJacobian.
 
double operator() (const fourdst::atomic::Species &row, const fourdst::atomic::Species &col) const
 Accesses the value at the specified row and column corresponding to the given species.
 
double operator() (size_t i, size_t j) const
 Accesses the value at the specified row and column indices.
 
void set (const fourdst::atomic::Species &row, const fourdst::atomic::Species &col, double value)
 Sets the value at the specified row and column corresponding to the given species.
 
void set (size_t i, size_t j, double value)
 Sets the value at the specified row and column indices.
 
void set (const JacobianEntry &entry)
 Sets the value in the Jacobian matrix based on a JacobianEntry.
 
std::tuple< size_t, size_t > shape () const
 Retrieves the shape of the Jacobian matrix as a tuple (rows, columns).
 
size_t rank () const
 Retrieves the rank of the Jacobian matrix.
 
size_t nnz () const
 Get the number of non-zero entries in the Jacobian matrix.
 
bool singular () const
 Checks if the Jacobian matrix is singular.
 
std::vector< JacobianEntry > infs () const
 Retrieves all entries in the Jacobian matrix that are infinite.
 
std::vector< JacobianEntry > nans () const
 Retrieves all entries in the Jacobian matrix that are NaN (Not a Number).
 
Eigen::SparseMatrix< double > data () const
 Provides access to the underlying sparse matrix data.
 
const std::unordered_map< fourdst::atomic::Species, size_t > & mapping () const
 Provides access to the species-to-index mapping.
 
void to_csv (const std::string &filename) const
 Exports the Jacobian matrix to a CSV file.
 
+ + + + + + + +

+Private Attributes

Eigen::SparseMatrix< double > m_jacobianMatrix
 
std::unordered_map< fourdst::atomic::Species, size_t > m_speciesToIndexMap
 
std::optional< size_t > m_rank = std::nullopt
 
+

Detailed Description

+

A wrapper class for handling the network Jacobian matrix.

+

This class encapsulates an Eigen::SparseMatrix to represent the Jacobian matrix of a reaction network. It provides methods for accessing and modifying matrix entries using species identifiers, as well as utility functions for analyzing the matrix (e.g., checking for singularity, counting non-zero entries).

+

Constructor & Destructor Documentation

+ +

◆ NetworkJacobian() [1/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
gridfire::engine::NetworkJacobian::NetworkJacobian (const Eigen::SparseMatrix< double > & jacobianMatrix,
const std::function< fourdst::atomic::Species(size_t)> & indexToSpeciesFunc 
)
+ 		+explicit
+
+ +

Constructs a NetworkJacobian with the given sparse matrix and species index mapping function.

+
Parameters
+ + + +
jacobianMatrixThe sparse matrix representing the Jacobian.
indexToSpeciesFuncA function that maps matrix indices to species identifiers.
+
+
+ +
+
+ +

◆ NetworkJacobian() [2/3]

+ +
+
+ + + + + + + + +
gridfire::engine::NetworkJacobian::NetworkJacobian (const NetworkJacobian & jacobian)
+
+ +

Copy constructor for NetworkJacobian.

+
Parameters
+ + +
jacobianThe NetworkJacobian instance to copy from.
+
+
+ +
+
+ +

◆ NetworkJacobian() [3/3]

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::engine::NetworkJacobian::NetworkJacobian (NetworkJacobian && jacobian)
+ 		+noexcept
+
+ +

Copy assignment operator for NetworkJacobian.

+
Parameters
+ + +
jacobianThe NetworkJacobian instance to copy from.
+
+
+
Returns
Reference to the assigned NetworkJacobian instance.
+ +
+
+

Member Function Documentation

+ +

◆ data()

+ +
+
+ + + + + + + +
Eigen::SparseMatrix< double > gridfire::engine::NetworkJacobian::data () const
+
+ +

Provides access to the underlying sparse matrix data.

+
Returns
The Eigen::SparseMatrix representing the Jacobian.
+ +
+
+ +

◆ infs()

+ +
+
+ + + + + + + +
std::vector< JacobianEntry > gridfire::engine::NetworkJacobian::infs () const
+
+ +

Retrieves all entries in the Jacobian matrix that are infinite.

+
Returns
A vector of JacobianEntry representing infinite entries.
+ +
+
+ +

◆ mapping()

+ +
+
+ + + + + + + +
const std::unordered_map< fourdst::atomic::Species, size_t > & gridfire::engine::NetworkJacobian::mapping () const
+
+ +

Provides access to the species-to-index mapping.

+
Returns
A constant reference to the species-to-index mapping.
+ +
+
+ +

◆ nans()

+ +
+
+ + + + + + + +
std::vector< JacobianEntry > gridfire::engine::NetworkJacobian::nans () const
+
+ +

Retrieves all entries in the Jacobian matrix that are NaN (Not a Number).

+
Returns
A vector of JacobianEntry representing NaN entries.
+ +
+
+ +

◆ nnz()

+ +
+
+ + + + + + + +
size_t gridfire::engine::NetworkJacobian::nnz () const
+
+ +

Get the number of non-zero entries in the Jacobian matrix.

+
Returns
The number of non-zero entries.
+ +
+
+ +

◆ operator()() [1/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
double gridfire::engine::NetworkJacobian::operator() (const fourdst::atomic::Species & row,
const fourdst::atomic::Species & col 
) const
+
+ +

Accesses the value at the specified row and column corresponding to the given species.

+
Parameters
+ + + +
rowSpecies for the row
colSpecies for the column
+
+
+
Returns
value at the specified position
+ +
+
+ +

◆ operator()() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
double gridfire::engine::NetworkJacobian::operator() (size_t i,
size_t j 
) const
+
+ +

Accesses the value at the specified row and column indices.

+
Parameters
+ + + +
iRow index
jColumn index
+
+
+
Returns
value at the specified position
+ +
+
+ +

◆ operator=()

+ +
+
+ + + + + +
+ + + + + + + + +
NetworkJacobian & gridfire::engine::NetworkJacobian::operator= (NetworkJacobian && jacobian)
+ 		+noexcept
+
+ +

Move constructor for NetworkJacobian.

+
Parameters
+ + +
jacobianThe NetworkJacobian instance to move from.
+
+
+
Returns
Reference to the assigned NetworkJacobian instance.
+ +
+
+ +

◆ rank()

+ +
+
+ + + + + + + +
size_t gridfire::engine::NetworkJacobian::rank () const
+
+ +

Retrieves the rank of the Jacobian matrix.

+
Returns
The rank of the matrix.
+
Note
Rank is computed using QR decomposition and cached for efficiency. The rank is computed the first time this method is called and stored for subsequent calls. If any set operation is performed on the matrix, the cached rank is invalidated.
+ +
+
+ +

◆ set() [1/3]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void gridfire::engine::NetworkJacobian::set (const fourdst::atomic::Species & row,
const fourdst::atomic::Species & col,
double value 
)
+
+ +

Sets the value at the specified row and column corresponding to the given species.

+
Parameters
+ + + + +
rowRow species
colColumn species
valueValue to set
+
+
+ +
+
+ +

◆ set() [2/3]

+ +
+
+ + + + + + + + +
void gridfire::engine::NetworkJacobian::set (const JacobianEntry & entry)
+
+ +

Sets the value in the Jacobian matrix based on a JacobianEntry.

+
Parameters
+ + +
entryThe JacobianEntry containing row species, column species, and value.
+
+
+ +
+
+ +

◆ set() [3/3]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void gridfire::engine::NetworkJacobian::set (size_t i,
size_t j,
double value 
)
+
+ +

Sets the value at the specified row and column indices.

+
Parameters
+ + + + +
iRow index
jColumn index
valueValue to set
+
+
+ +
+
+ +

◆ shape()

+ +
+
+ + + + + + + +
std::tuple< size_t, size_t > gridfire::engine::NetworkJacobian::shape () const
+
+ +

Retrieves the shape of the Jacobian matrix as a tuple (rows, columns).

+
Returns
A tuple containing the number of rows and columns.
+ +
+
+ +

◆ singular()

+ +
+
+ + + + + + + +
bool gridfire::engine::NetworkJacobian::singular () const
+
+ +

Checks if the Jacobian matrix is singular.

+
Returns
True if the matrix is singular, false otherwise.
+ +
+
+ +

◆ to_csv()

+ +
+
+ + + + + + + + +
void gridfire::engine::NetworkJacobian::to_csv (const std::string & filename) const
+
+ +

Exports the Jacobian matrix to a CSV file.

+
Parameters
+ + +
filenameThe name of the CSV file to export to.
+
+
+ +
+
+

Member Data Documentation

+ +

◆ m_jacobianMatrix

+ +
+
+ + + + + +
+ + + + +
Eigen::SparseMatrix<double> gridfire::engine::NetworkJacobian::m_jacobianMatrix
+ 		+private
+
+ +
+
+ +

◆ m_rank

+ +
+
+ + + + + +
+ + + + +
std::optional<size_t> gridfire::engine::NetworkJacobian::m_rank = std::nullopt
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_speciesToIndexMap

+ +
+
+ + + + + +
+ + + + +
std::unordered_map<fourdst::atomic::Species, size_t> gridfire::engine::NetworkJacobian::m_speciesToIndexMap
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1NetworkJacobian.js b/docs/html/classgridfire_1_1engine_1_1NetworkJacobian.js new file mode 100644 index 00000000..7c2d81c3 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1NetworkJacobian.js @@ -0,0 +1,24 @@ +var classgridfire_1_1engine_1_1NetworkJacobian = +[ + [ "NetworkJacobian", "classgridfire_1_1engine_1_1NetworkJacobian.html#aee558bd90f26fdb6172a04fb63d2572e", null ], + [ "NetworkJacobian", "classgridfire_1_1engine_1_1NetworkJacobian.html#a78eea5d1a0d09cb30cf0b387924b5179", null ], + [ "NetworkJacobian", "classgridfire_1_1engine_1_1NetworkJacobian.html#ad215d47784258e42cfbcb45c771aaa19", null ], + [ "data", "classgridfire_1_1engine_1_1NetworkJacobian.html#adb5643398b6f5fbf0ab8f09580b93402", null ], + [ "infs", "classgridfire_1_1engine_1_1NetworkJacobian.html#adc4bcf002e276e36d9d29db7f82015fd", null ], + [ "mapping", "classgridfire_1_1engine_1_1NetworkJacobian.html#aa15b6de68c69b48c57ed1cc943164d32", null ], + [ "nans", "classgridfire_1_1engine_1_1NetworkJacobian.html#a9292384722bcb0245acab9affcdb8c6d", null ], + [ "nnz", "classgridfire_1_1engine_1_1NetworkJacobian.html#a2016fcfe27363650817b5be1ce6aaa32", null ], + [ "operator()", "classgridfire_1_1engine_1_1NetworkJacobian.html#a6aef41de3c48ac77ae991ca427ce46a9", null ], + [ "operator()", "classgridfire_1_1engine_1_1NetworkJacobian.html#a3022b0f46c78adb4053b16a425a8b026", null ], + [ "operator=", "classgridfire_1_1engine_1_1NetworkJacobian.html#ac5372d721127646e75c0f177661566f9", null ], + [ "rank", "classgridfire_1_1engine_1_1NetworkJacobian.html#af9544f4cec7b450027fe991614adabfa", null ], + [ "set", "classgridfire_1_1engine_1_1NetworkJacobian.html#a6fc63f3c5d3fe7a1fd8b0704f2e71e2c", null ], + [ "set", "classgridfire_1_1engine_1_1NetworkJacobian.html#a82c4fb3d75b1a30e0259ad888bd508cc", null ], + [ "set", "classgridfire_1_1engine_1_1NetworkJacobian.html#ac47692fd4cc13174373d2a2f3abd956d", null ], + [ "shape", "classgridfire_1_1engine_1_1NetworkJacobian.html#a699933e9f807ec196157f92ffb46b9ba", null ], + [ "singular", "classgridfire_1_1engine_1_1NetworkJacobian.html#a485321469d84b3cf923ec79957044406", null ], + [ "to_csv", "classgridfire_1_1engine_1_1NetworkJacobian.html#a8267f02eacb52d238da6daa19dbea764", null ], + [ "m_jacobianMatrix", "classgridfire_1_1engine_1_1NetworkJacobian.html#ad14ba25ee22e6b0c73e21e19165814e8", null ], + [ "m_rank", "classgridfire_1_1engine_1_1NetworkJacobian.html#ad30cd63facc761a71d70e60249a22576", null ], + [ "m_speciesToIndexMap", "classgridfire_1_1engine_1_1NetworkJacobian.html#ae5a03ec75859d300f8f63ac465f1206c", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1NetworkJacobian__coll__graph.map b/docs/html/classgridfire_1_1engine_1_1NetworkJacobian__coll__graph.map new file mode 100644 index 00000000..61d3a816 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1NetworkJacobian__coll__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1NetworkJacobian__coll__graph.md5 b/docs/html/classgridfire_1_1engine_1_1NetworkJacobian__coll__graph.md5 new file mode 100644 index 00000000..c38f3991 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1NetworkJacobian__coll__graph.md5 @@ -0,0 +1 @@ +b1c6e80f3de838324459d21ce986d291 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1NetworkJacobian__coll__graph.svg b/docs/html/classgridfire_1_1engine_1_1NetworkJacobian__coll__graph.svg new file mode 100644 index 00000000..ddfeac4f --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1NetworkJacobian__coll__graph.svg @@ -0,0 +1,87 @@ + + + + + + + + + + + +gridfire::engine::NetworkJacobian + + +Node1 + + +gridfire::engine::Network +Jacobian + + + + + +Node2 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node2->Node1 + + + + + + m_speciesToIndexMap + + + +Node3 + + +Species + + + + + +Node3->Node2 + + + + + + keys + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1NetworkJacobian__coll__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1NetworkJacobian__coll__graph_org.svg new file mode 100644 index 00000000..edb2bd71 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1NetworkJacobian__coll__graph_org.svg @@ -0,0 +1,62 @@ + + + + + + +gridfire::engine::NetworkJacobian + + +Node1 + + +gridfire::engine::Network +Jacobian + + + + + +Node2 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node2->Node1 + + + + + + m_speciesToIndexMap + + + +Node3 + + +Species + + + + + +Node3->Node2 + + + + + + keys + + + diff --git a/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView-members.html b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView-members.html new file mode 100644 index 00000000..a3b6544c --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView-members.html @@ -0,0 +1,158 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::NetworkPrimingEngineView Member List
+
+
+ +

This is the complete list of members for gridfire::engine::NetworkPrimingEngineView, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
calculateEpsDerivatives(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
calculateMolarReactionFlow(const reaction::Reaction &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
calculateRHSAndEnergy(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
collect(const std::vector< std::string > &peNames)gridfire::engine::DefinedEngineViewprivate
collectComposition(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
constructPrimingReactionSet(const fourdst::atomic::Species &primingSpecies, const GraphEngine &baseEngine) constgridfire::engine::NetworkPrimingEngineViewprivate
constructReactionIndexMap() constgridfire::engine::DefinedEngineViewprivate
constructSpeciesIndexMap() constgridfire::engine::DefinedEngineViewprivate
DefinedEngineView(const std::vector< std::string > &peNames, GraphEngine &baseEngine)gridfire::engine::DefinedEngineView
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies) const overridegridfire::engine::DefinedEngineViewvirtual
generateJacobianMatrix(const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const overridegridfire::engine::DefinedEngineViewvirtual
generateStoichiometryMatrix() overridegridfire::engine::DefinedEngineViewvirtual
getBaseEngine() const overridegridfire::engine::DefinedEngineViewvirtual
getDepth() constgridfire::engine::DynamicEngineinlinevirtual
getNetworkReactions() const overridegridfire::engine::DefinedEngineViewvirtual
getNetworkSpecies() const overridegridfire::engine::DefinedEngineViewvirtual
getScreeningModel() const overridegridfire::engine::DefinedEngineViewvirtual
getSpeciesDestructionTimescales(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
getSpeciesIndex(const fourdst::atomic::Species &species) const overridegridfire::engine::DefinedEngineViewvirtual
getSpeciesStatus(const fourdst::atomic::Species &species) const overridegridfire::engine::DefinedEngineViewvirtual
getSpeciesTimescales(const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const overridegridfire::engine::DefinedEngineViewvirtual
getStoichiometryMatrixEntry(const fourdst::atomic::Species &species, const reaction::Reaction &reaction) const overridegridfire::engine::DefinedEngineViewvirtual
isStale(const NetIn &netIn) overridegridfire::engine::DefinedEngineViewvirtual
m_activeReactionsgridfire::engine::DefinedEngineViewprivate
m_activeSpeciesgridfire::engine::DefinedEngineViewprivate
m_activeSpeciesVectorCachegridfire::engine::DefinedEngineViewmutableprivate
m_baseEnginegridfire::engine::DefinedEngineViewprotected
m_isStalegridfire::engine::DefinedEngineViewprotected
m_loggergridfire::engine::NetworkPrimingEngineViewprivate
m_primingSpeciesgridfire::engine::NetworkPrimingEngineViewprivate
m_reactionIndexMapgridfire::engine::DefinedEngineViewprivate
m_speciesIndexMapgridfire::engine::DefinedEngineViewprivate
mapFullToView(const std::vector< double > &full) constgridfire::engine::DefinedEngineViewprivate
mapNetInToMolarAbundanceVector(const NetIn &netIn) const overridegridfire::engine::DefinedEngineViewvirtual
mapViewToFull(const std::vector< double > &defined) constgridfire::engine::DefinedEngineViewprivate
mapViewToFullReactionIndex(size_t definedReactionIndex) constgridfire::engine::DefinedEngineViewprivate
mapViewToFullSpeciesIndex(size_t definedSpeciesIndex) constgridfire::engine::DefinedEngineViewprivate
NetworkPrimingEngineView(const std::string &primingSymbol, GraphEngine &baseEngine)gridfire::engine::NetworkPrimingEngineView
NetworkPrimingEngineView(const fourdst::atomic::Species &primingSpecies, GraphEngine &baseEngine)gridfire::engine::NetworkPrimingEngineView
primeEngine(const NetIn &netIn) overridegridfire::engine::DefinedEngineViewvirtual
rebuild(const fourdst::composition::CompositionAbstract &comp, BuildDepthType depth)gridfire::engine::DynamicEngineinlinevirtual
setNetworkReactions(const reaction::ReactionSet &reactions) overridegridfire::engine::DefinedEngineViewvirtual
setScreeningModel(screening::ScreeningType model) overridegridfire::engine::DefinedEngineViewvirtual
update(const NetIn &netIn) overridegridfire::engine::DefinedEngineViewvirtual
validateNetworkState() constgridfire::engine::DefinedEngineViewprivate
~Engine()=defaultgridfire::engine::Enginevirtual
~EngineView()=defaultgridfire::engine::EngineView< DynamicEngine >virtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView.html b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView.html new file mode 100644 index 00000000..85a257ff --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView.html @@ -0,0 +1,450 @@ + + + + + + + +GridFire: gridfire::engine::NetworkPrimingEngineView Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Member Functions | +Private Attributes | +List of all members
+
gridfire::engine::NetworkPrimingEngineView Class Referencefinal
+
+
+ +

Provides a view of a DynamicEngine filtered to reactions involving a specified priming species. + More...

+ +

#include <engine_priming.h>

+
+Inheritance diagram for gridfire::engine::NetworkPrimingEngineView:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::engine::NetworkPrimingEngineView:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 NetworkPrimingEngineView (const std::string &primingSymbol, GraphEngine &baseEngine)
 Constructs the view by looking up the priming species by symbol.
 
 NetworkPrimingEngineView (const fourdst::atomic::Species &primingSpecies, GraphEngine &baseEngine)
 Constructs the view using an existing Species object.
 
- Public Member Functions inherited from gridfire::engine::DefinedEngineView
 DefinedEngineView (const std::vector< std::string > &peNames, GraphEngine &baseEngine)
 
const DynamicEngine & getBaseEngine () const override
 Get the base engine associated with this defined engine view.
 
const std::vector< fourdst::atomic::Species > & getNetworkSpecies () const override
 Gets the list of active species in the network defined by the file.
 
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
 Calculate the derivatives of the energy generation rate with respect to T and rho.
 
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 the active species.
 
NetworkJacobian generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const override
 Generates the Jacobian matrix for 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 active reactions in the network.
 
std::expected< std::unordered_map< fourdst::atomic::Species, double >, engine::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 >, engine::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 update (const NetIn &netIn) override
 Updates the engine view if it is marked as stale.
 
bool isStale (const NetIn &netIn) override
 Checks if the engine view is stale.
 
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
 Maps a species from the full network to its index in the defined active network.
 
std::vector< double > mapNetInToMolarAbundanceVector (const NetIn &netIn) const override
 Map from a NetIn object to a vector of molar abundances for the active species.
 
PrimingReport primeEngine (const NetIn &netIn) override
 Prime the engine view for calculations. This will delegate to the base engine.
 
fourdst::composition::Composition collectComposition (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
 Collects a Composition object from the base engine.
 
SpeciesStatus getSpeciesStatus (const fourdst::atomic::Species &species) const override
 Gets the status of a species in the active 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.
 
- Public Member Functions inherited from gridfire::engine::Engine
virtual ~Engine ()=default
 Virtual destructor.
 
- Public Member Functions inherited from gridfire::engine::EngineView< DynamicEngine >
virtual ~EngineView ()=default
 Virtual destructor.
 
+ + + + +

+Private Member Functions

std::vector< std::string > constructPrimingReactionSet (const fourdst::atomic::Species &primingSpecies, const GraphEngine &baseEngine) const
 Constructs the set of reaction names that involve the priming species.
 
+ + + + + + +

+Private Attributes

quill::Logger * m_logger = LogManager::getInstance().getLogger("log")
 
fourdst::atomic::Species m_primingSpecies
 The priming species, if specified.
 
+ + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::engine::DefinedEngineView
bool m_isStale = true
 
GraphEngine & m_baseEngine
 
+

Detailed Description

+

Provides a view of a DynamicEngine filtered to reactions involving a specified priming species.

+

This view constructs a subset of the network reactions from the base engine that contain the given priming species and delegates all engine operations to the underlying engine.

+

See implementation in engine_priming.cpp for details on reaction set construction.

+
Note
Throws std::runtime_error if no priming reactions are found for the species.
+

Constructor & Destructor Documentation

+ +

◆ NetworkPrimingEngineView() [1/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
gridfire::engine::NetworkPrimingEngineView::NetworkPrimingEngineView (const std::string & primingSymbol,
GraphEngine & baseEngine 
)
+
+ +

Constructs the view by looking up the priming species by symbol.

+
Parameters
+ + + +
primingSymbolSymbol string of the species to prime.
baseEngineReference to the base DynamicEngine to wrap.
+
+
+
Precondition
primingSymbol must correspond to a valid species in atomic::species registry.
+
Postcondition
The view will contain only reactions that involve the priming species.
+
Exceptions
+ + + +
std::out_of_rangeIf primingSymbol is not found in the species registry.
std::runtime_errorIf no reactions contain the priming species.
+
+
+ +
+
+ +

◆ NetworkPrimingEngineView() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
gridfire::engine::NetworkPrimingEngineView::NetworkPrimingEngineView (const fourdst::atomic::Species & primingSpecies,
GraphEngine & baseEngine 
)
+
+ +

Constructs the view using an existing Species object.

+
Parameters
+ + + +
primingSpeciesThe species object to prime.
baseEngineReference to the base DynamicEngine to wrap.
+
+
+
Precondition
primingSpecies must be valid and present in the network of baseEngine.
+
Postcondition
The view will contain only reactions that involve the priming species.
+
Exceptions
+ + +
std::runtime_errorIf no reactions contain the priming species.
+
+
+ +
+
+

Member Function Documentation

+ +

◆ constructPrimingReactionSet()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::vector< std::string > gridfire::engine::NetworkPrimingEngineView::constructPrimingReactionSet (const fourdst::atomic::Species & primingSpecies,
const GraphEngine & baseEngine 
) const
+ 		+private
+
+ +

Constructs the set of reaction names that involve the priming species.

+
Parameters
+ + + +
primingSpeciesSpecies for which to collect priming reactions.
baseEngineBase engine containing the full network of reactions.
+
+
+
Precondition
baseEngine.getNetworkReactions() returns a valid iterable set of reactions.
+
Postcondition
Returns a vector of unique reaction name strings containing the priming species.
+
Returns
Vector of reaction name strings containing the priming species.
+
Exceptions
+ + +
std::runtime_errorIf no reactions involve the priming species.
+
+
+ +
+
+

Member Data Documentation

+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::engine::NetworkPrimingEngineView::m_logger = LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +
+
+ +

◆ m_primingSpecies

+ +
+
+ + + + + +
+ + + + +
fourdst::atomic::Species gridfire::engine::NetworkPrimingEngineView::m_primingSpecies
+ 		+private
+
+ +

The priming species, if specified.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView.js b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView.js new file mode 100644 index 00000000..7bcf5f14 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView.js @@ -0,0 +1,8 @@ +var classgridfire_1_1engine_1_1NetworkPrimingEngineView = +[ + [ "NetworkPrimingEngineView", "classgridfire_1_1engine_1_1NetworkPrimingEngineView.html#ad4eec8af1ab1f918fd4e92fac47adaf4", null ], + [ "NetworkPrimingEngineView", "classgridfire_1_1engine_1_1NetworkPrimingEngineView.html#a0d505b967dc3b50f6966a0110e53a6d7", null ], + [ "constructPrimingReactionSet", "classgridfire_1_1engine_1_1NetworkPrimingEngineView.html#acaf9433246a58f2365c5bd8907cbacbb", null ], + [ "m_logger", "classgridfire_1_1engine_1_1NetworkPrimingEngineView.html#af5d4b8d6b11e83d57d6e08b12ce5882d", null ], + [ "m_primingSpecies", "classgridfire_1_1engine_1_1NetworkPrimingEngineView.html#ad78f293f31a7ff8120b85e26e5d6dcfd", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__coll__graph.map b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__coll__graph.map new file mode 100644 index 00000000..8afb786b --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__coll__graph.map @@ -0,0 +1,107 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__coll__graph.md5 b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__coll__graph.md5 new file mode 100644 index 00000000..10d89842 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__coll__graph.md5 @@ -0,0 +1 @@ +d3e4aafc8abe0b27a6bda45b74635556 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__coll__graph.svg b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__coll__graph.svg new file mode 100644 index 00000000..f098b9e5 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__coll__graph.svg @@ -0,0 +1,1144 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::engine::NetworkPrimingEngineView + + +Node1 + + +gridfire::engine::Network +PrimingEngineView + + + + + +Node2 + + +gridfire::engine::Defined +EngineView + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Dynamic +Engine + + + + + +Node3->Node2 + + + + + + + + +Node6 + + +gridfire::engine::GraphEngine + + + + + +Node3->Node6 + + + + + + + + +Node4 + + +gridfire::engine::Engine + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node5->Node2 + + + + + + + + +Node6->Node2 + + + + + + m_baseEngine + + + +Node35 + + +gridfire::engine::GraphEngine +::AtomicReverseRate + + + + + +Node6->Node35 + + + + + + m_engine + + + +Node7 + + +std::unordered_map +< JacobianMatrixState, + std::string > + + + + + +Node7->Node6 + + + + + + m_jacobianMatrixStateNameMap + + + +Node8 + + +std::string + + + + + +Node8->Node7 + + + + + + elements + + + +Node18 + + +gridfire::reaction +::ReactionSet + + + + + +Node8->Node18 + + + + + + m_id + + + +Node22 + + +std::unordered_map +< std::string, size_t > + + + + + +Node8->Node22 + + + + + + keys + + + +Node9 + + +std::basic_string< + Char > + + + + + +Node9->Node8 + + + + + + + + +Node10 + + +Config + + + + + +Node10->Node6 + + + + + + m_config + + + +Node11 + + +gridfire::engine::GraphEngine +::constants + + + + + +Node11->Node6 + + + + + + m_constants + + + +Node12 + + +gridfire::rates::weak +::WeakRateInterpolator + + + + + +Node12->Node6 + + + + + + m_weakRateInterpolator + + + +Node13 + + +std::unordered_map +< uint32_t, gridfire +::rates::weak::IsotopeGrid > + + + + + +Node13->Node12 + + + + + + m_rate_table + + + +Node14 + + +gridfire::rates::weak +::IsotopeGrid + + + + + +Node14->Node13 + + + + + + elements + + + +Node15 + + +std::vector< double > + + + + + +Node15->Node14 + + + + + + rhoYe_axis +t9_axis + + + +Node16 + + +std::vector< gridfire +::rates::weak::WeakRatePayload > + + + + + +Node16->Node14 + + + + + + data + + + +Node17 + + +gridfire::rates::weak +::WeakRatePayload + + + + + +Node17->Node16 + + + + + + elements + + + +Node18->Node2 + + + + + + m_activeReactions + + + +Node18->Node6 + + + + + + m_reactions + + + +Node19 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node19->Node18 + + + + + + m_reactions + + + +Node20 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node20->Node19 + + + + + + elements + + + +Node21 + + +gridfire::reaction +::Reaction + + + + + +Node21->Node20 + + + + + + ptr + + + +Node24 + + +std::unordered_map +< std::string_view, + gridfire::reaction:: +Reaction * > + + + + + +Node21->Node24 + + + + + + elements + + + +Node21->Node35 + + + + + + m_reaction + + + +Node22->Node18 + + + + + + m_reactionNameMap + + + +Node23 + + +std::unordered_set +< size_t > + + + + + +Node23->Node18 + + + + + + m_reactionHashes + + + +Node24->Node6 + + + + + + m_reactionIDMap + + + +Node25 + + +std::string_view + + + + + +Node25->Node24 + + + + + + keys + + + +Node29 + + +std::unordered_map +< std::string_view, + fourdst::atomic::Species > + + + + + +Node25->Node29 + + + + + + keys + + + +Node26 + + +std::basic_string_view +< Char > + + + + + +Node26->Node25 + + + + + + + + +Node27 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node27->Node6 + + + + + + m_networkSpecies + + + +Node28 + + +Species + + + + + +Node28->Node1 + + + + + + m_primingSpecies + + + +Node28->Node27 + + + + + + elements + + + +Node28->Node29 + + + + + + elements + + + +Node30 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node28->Node30 + + + + + + keys + + + +Node31 + + +std::unordered_map +< size_t, fourdst::atomic +::Species > + + + + + +Node28->Node31 + + + + + + elements + + + +Node46 + + +std::set< fourdst:: +atomic::Species > + + + + + +Node28->Node46 + + + + + + keys + + + +Node29->Node6 + + + + + + m_networkSpeciesMap + + + +Node30->Node6 + + + + + + m_speciesToIndexMap + + + +Node31->Node6 + + + + + + m_indexToSpeciesMap + + + +Node32 + + +std::set< std::pair +< size_t, size_t > > + + + + + +Node32->Node6 + + + + + + m_full_sparsity_set + + + +Node33 + + +std::vector< std::unique +_ptr< gridfire::engine +::GraphEngine::AtomicReverseRate > > + + + + + +Node33->Node6 + + + + + + m_atomicReverseRates + + + +Node34 + + +std::unique_ptr< gridfire +::engine::GraphEngine:: +AtomicReverseRate > + + + + + +Node34->Node33 + + + + + + elements + + + +Node35->Node34 + + + + + + ptr + + + +Node36 + + +CppAD::atomic_base +< double > + + + + + +Node36->Node35 + + + + + + + + +Node37 + + +std::unique_ptr< gridfire +::screening::ScreeningModel > + + + + + +Node37->Node6 + + + + + + m_screeningModel + + + +Node38 + + +gridfire::screening +::ScreeningModel + + + + + +Node38->Node37 + + + + + + ptr + + + +Node39 + + +std::vector< gridfire +::engine::GraphEngine +::PrecomputedReaction > + + + + + +Node39->Node6 + + + + + + m_precomputedReactions + + + +Node40 + + +gridfire::engine::GraphEngine +::PrecomputedReaction + + + + + +Node40->Node39 + + + + + + elements + + + +Node41 + + +std::vector< size_t > + + + + + +Node41->Node2 + + + + + + m_reactionIndexMap +m_speciesIndexMap + + + +Node41->Node40 + + + + + + affected_species_indices +unique_product_indices +unique_reactant_indices + + + +Node42 + + +std::vector< int > + + + + + +Node42->Node40 + + + + + + product_powers +reactant_powers +stoichiometric_coefficients + + + +Node43 + + +std::unordered_map +< uint64_t, size_t > + + + + + +Node43->Node6 + + + + + + m_precomputedReactionIndexMap + + + +Node44 + + +std::unique_ptr< gridfire +::partition::PartitionFunction > + + + + + +Node44->Node6 + + + + + + m_partitionFunction + + + +Node45 + + +gridfire::partition +::PartitionFunction + + + + + +Node45->Node44 + + + + + + ptr + + + +Node46->Node2 + + + + + + m_activeSpecies + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__coll__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__coll__graph_org.svg new file mode 100644 index 00000000..ef979afa --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__coll__graph_org.svg @@ -0,0 +1,1062 @@ + + + + + + +gridfire::engine::NetworkPrimingEngineView + + +Node1 + + +gridfire::engine::Network +PrimingEngineView + + + + + +Node2 + + +gridfire::engine::Defined +EngineView + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Dynamic +Engine + + + + + +Node3->Node2 + + + + + + + + +Node6 + + +gridfire::engine::GraphEngine + + + + + +Node3->Node6 + + + + + + + + +Node4 + + +gridfire::engine::Engine + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node5->Node2 + + + + + + + + +Node6->Node2 + + + + + + m_baseEngine + + + +Node35 + + +gridfire::engine::GraphEngine +::AtomicReverseRate + + + + + +Node6->Node35 + + + + + + m_engine + + + +Node7 + + +std::unordered_map +< JacobianMatrixState, + std::string > + + + + + +Node7->Node6 + + + + + + m_jacobianMatrixStateNameMap + + + +Node8 + + +std::string + + + + + +Node8->Node7 + + + + + + elements + + + +Node18 + + +gridfire::reaction +::ReactionSet + + + + + +Node8->Node18 + + + + + + m_id + + + +Node22 + + +std::unordered_map +< std::string, size_t > + + + + + +Node8->Node22 + + + + + + keys + + + +Node9 + + +std::basic_string< + Char > + + + + + +Node9->Node8 + + + + + + + + +Node10 + + +Config + + + + + +Node10->Node6 + + + + + + m_config + + + +Node11 + + +gridfire::engine::GraphEngine +::constants + + + + + +Node11->Node6 + + + + + + m_constants + + + +Node12 + + +gridfire::rates::weak +::WeakRateInterpolator + + + + + +Node12->Node6 + + + + + + m_weakRateInterpolator + + + +Node13 + + +std::unordered_map +< uint32_t, gridfire +::rates::weak::IsotopeGrid > + + + + + +Node13->Node12 + + + + + + m_rate_table + + + +Node14 + + +gridfire::rates::weak +::IsotopeGrid + + + + + +Node14->Node13 + + + + + + elements + + + +Node15 + + +std::vector< double > + + + + + +Node15->Node14 + + + + + + rhoYe_axis +t9_axis + + + +Node16 + + +std::vector< gridfire +::rates::weak::WeakRatePayload > + + + + + +Node16->Node14 + + + + + + data + + + +Node17 + + +gridfire::rates::weak +::WeakRatePayload + + + + + +Node17->Node16 + + + + + + elements + + + +Node18->Node2 + + + + + + m_activeReactions + + + +Node18->Node6 + + + + + + m_reactions + + + +Node19 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node19->Node18 + + + + + + m_reactions + + + +Node20 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node20->Node19 + + + + + + elements + + + +Node21 + + +gridfire::reaction +::Reaction + + + + + +Node21->Node20 + + + + + + ptr + + + +Node24 + + +std::unordered_map +< std::string_view, + gridfire::reaction:: +Reaction * > + + + + + +Node21->Node24 + + + + + + elements + + + +Node21->Node35 + + + + + + m_reaction + + + +Node22->Node18 + + + + + + m_reactionNameMap + + + +Node23 + + +std::unordered_set +< size_t > + + + + + +Node23->Node18 + + + + + + m_reactionHashes + + + +Node24->Node6 + + + + + + m_reactionIDMap + + + +Node25 + + +std::string_view + + + + + +Node25->Node24 + + + + + + keys + + + +Node29 + + +std::unordered_map +< std::string_view, + fourdst::atomic::Species > + + + + + +Node25->Node29 + + + + + + keys + + + +Node26 + + +std::basic_string_view +< Char > + + + + + +Node26->Node25 + + + + + + + + +Node27 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node27->Node6 + + + + + + m_networkSpecies + + + +Node28 + + +Species + + + + + +Node28->Node1 + + + + + + m_primingSpecies + + + +Node28->Node27 + + + + + + elements + + + +Node28->Node29 + + + + + + elements + + + +Node30 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node28->Node30 + + + + + + keys + + + +Node31 + + +std::unordered_map +< size_t, fourdst::atomic +::Species > + + + + + +Node28->Node31 + + + + + + elements + + + +Node46 + + +std::set< fourdst:: +atomic::Species > + + + + + +Node28->Node46 + + + + + + keys + + + +Node29->Node6 + + + + + + m_networkSpeciesMap + + + +Node30->Node6 + + + + + + m_speciesToIndexMap + + + +Node31->Node6 + + + + + + m_indexToSpeciesMap + + + +Node32 + + +std::set< std::pair +< size_t, size_t > > + + + + + +Node32->Node6 + + + + + + m_full_sparsity_set + + + +Node33 + + +std::vector< std::unique +_ptr< gridfire::engine +::GraphEngine::AtomicReverseRate > > + + + + + +Node33->Node6 + + + + + + m_atomicReverseRates + + + +Node34 + + +std::unique_ptr< gridfire +::engine::GraphEngine:: +AtomicReverseRate > + + + + + +Node34->Node33 + + + + + + elements + + + +Node35->Node34 + + + + + + ptr + + + +Node36 + + +CppAD::atomic_base +< double > + + + + + +Node36->Node35 + + + + + + + + +Node37 + + +std::unique_ptr< gridfire +::screening::ScreeningModel > + + + + + +Node37->Node6 + + + + + + m_screeningModel + + + +Node38 + + +gridfire::screening +::ScreeningModel + + + + + +Node38->Node37 + + + + + + ptr + + + +Node39 + + +std::vector< gridfire +::engine::GraphEngine +::PrecomputedReaction > + + + + + +Node39->Node6 + + + + + + m_precomputedReactions + + + +Node40 + + +gridfire::engine::GraphEngine +::PrecomputedReaction + + + + + +Node40->Node39 + + + + + + elements + + + +Node41 + + +std::vector< size_t > + + + + + +Node41->Node2 + + + + + + m_reactionIndexMap +m_speciesIndexMap + + + +Node41->Node40 + + + + + + affected_species_indices +unique_product_indices +unique_reactant_indices + + + +Node42 + + +std::vector< int > + + + + + +Node42->Node40 + + + + + + product_powers +reactant_powers +stoichiometric_coefficients + + + +Node43 + + +std::unordered_map +< uint64_t, size_t > + + + + + +Node43->Node6 + + + + + + m_precomputedReactionIndexMap + + + +Node44 + + +std::unique_ptr< gridfire +::partition::PartitionFunction > + + + + + +Node44->Node6 + + + + + + m_partitionFunction + + + +Node45 + + +gridfire::partition +::PartitionFunction + + + + + +Node45->Node44 + + + + + + ptr + + + +Node46->Node2 + + + + + + m_activeSpecies + + + diff --git a/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__inherit__graph.map b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__inherit__graph.map new file mode 100644 index 00000000..62f3008c --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__inherit__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__inherit__graph.md5 b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__inherit__graph.md5 new file mode 100644 index 00000000..5ef6e7d2 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__inherit__graph.md5 @@ -0,0 +1 @@ +697a7871f0b7d9c30f41915100fcea0c \ No newline at end of file diff --git a/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__inherit__graph.svg b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__inherit__graph.svg new file mode 100644 index 00000000..c8609309 --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__inherit__graph.svg @@ -0,0 +1,122 @@ + + + + + + + + + + + +gridfire::engine::NetworkPrimingEngineView + + +Node1 + + +gridfire::engine::Network +PrimingEngineView + + + + + +Node2 + + +gridfire::engine::Defined +EngineView + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Dynamic +Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::engine::Engine + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node5->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__inherit__graph_org.svg b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__inherit__graph_org.svg new file mode 100644 index 00000000..d720abef --- /dev/null +++ b/docs/html/classgridfire_1_1engine_1_1NetworkPrimingEngineView__inherit__graph_org.svg @@ -0,0 +1,97 @@ + + + + + + +gridfire::engine::NetworkPrimingEngineView + + +Node1 + + +gridfire::engine::Network +PrimingEngineView + + + + + +Node2 + + +gridfire::engine::Defined +EngineView + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Dynamic +Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::engine::Engine + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +gridfire::engine::Engine +View< DynamicEngine > + + + + + +Node5->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError-members.html b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError-members.html new file mode 100644 index 00000000..f23eb865 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::BadCollectionError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::EngineErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError.html b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError.html new file mode 100644 index 00000000..e542eecc --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::BadCollectionError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::BadCollectionError Class Referencefinal
+
+
+ +

Exception for invalid composition collection in the engine. + More...

+ +

#include <error_engine.h>

+
+Inheritance diagram for gridfire::exceptions::BadCollectionError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::BadCollectionError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Exception for invalid composition collection in the engine.

+

This exception is thrown when the engine encounters an invalid state while trying to collect the composition from the entire engine stack

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__coll__graph.map new file mode 100644 index 00000000..5ca22bd4 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__coll__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__coll__graph.md5 new file mode 100644 index 00000000..09486b97 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__coll__graph.md5 @@ -0,0 +1 @@ +36b0c61adf04128a9680a5674167dea1 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__coll__graph.svg new file mode 100644 index 00000000..6e5848cc --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__coll__graph.svg @@ -0,0 +1,141 @@ + + + + + + + + + + + +gridfire::exceptions::BadCollectionError + + +Node1 + + +gridfire::exceptions +::BadCollectionError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__coll__graph_org.svg new file mode 100644 index 00000000..a78ac480 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__coll__graph_org.svg @@ -0,0 +1,116 @@ + + + + + + +gridfire::exceptions::BadCollectionError + + +Node1 + + +gridfire::exceptions +::BadCollectionError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__inherit__graph.map new file mode 100644 index 00000000..27db797b --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__inherit__graph.md5 new file mode 100644 index 00000000..6f4db9e4 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__inherit__graph.md5 @@ -0,0 +1 @@ +605e94707f9e8ab1aaa8887de798b2eb \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__inherit__graph.svg new file mode 100644 index 00000000..9277d63a --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__inherit__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +gridfire::exceptions::BadCollectionError + + +Node1 + + +gridfire::exceptions +::BadCollectionError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__inherit__graph_org.svg new file mode 100644 index 00000000..5e578537 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadCollectionError__inherit__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +gridfire::exceptions::BadCollectionError + + +Node1 + + +gridfire::exceptions +::BadCollectionError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError-members.html b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError-members.html new file mode 100644 index 00000000..554b686e --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::BadRHSEngineError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::EngineErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError.html b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError.html new file mode 100644 index 00000000..bd9b9e6f --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::BadRHSEngineError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::BadRHSEngineError Class Referencefinal
+
+
+ +

Exception for errors in calculating the right-hand side (RHS). + More...

+ +

#include <error_engine.h>

+
+Inheritance diagram for gridfire::exceptions::BadRHSEngineError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::BadRHSEngineError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Exception for errors in calculating the right-hand side (RHS).

+

This exception is thrown when the engine encounters an error while calculating the right-hand side of the reaction network equations.

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__coll__graph.map new file mode 100644 index 00000000..b4334fa1 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__coll__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__coll__graph.md5 new file mode 100644 index 00000000..4a5a083f --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__coll__graph.md5 @@ -0,0 +1 @@ +35e03081366af80044578c41893cbeac \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__coll__graph.svg new file mode 100644 index 00000000..dc668610 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__coll__graph.svg @@ -0,0 +1,141 @@ + + + + + + + + + + + +gridfire::exceptions::BadRHSEngineError + + +Node1 + + +gridfire::exceptions +::BadRHSEngineError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__coll__graph_org.svg new file mode 100644 index 00000000..8a4ea5fb --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__coll__graph_org.svg @@ -0,0 +1,116 @@ + + + + + + +gridfire::exceptions::BadRHSEngineError + + +Node1 + + +gridfire::exceptions +::BadRHSEngineError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__inherit__graph.map new file mode 100644 index 00000000..65b0355c --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__inherit__graph.md5 new file mode 100644 index 00000000..f274a09f --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__inherit__graph.md5 @@ -0,0 +1 @@ +81be7c2f931c1b262f07ce19b5116246 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__inherit__graph.svg new file mode 100644 index 00000000..6972aecb --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__inherit__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +gridfire::exceptions::BadRHSEngineError + + +Node1 + + +gridfire::exceptions +::BadRHSEngineError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__inherit__graph_org.svg new file mode 100644 index 00000000..9b252e6b --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1BadRHSEngineError__inherit__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +gridfire::exceptions::BadRHSEngineError + + +Node1 + + +gridfire::exceptions +::BadRHSEngineError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError-members.html b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError-members.html new file mode 100644 index 00000000..2f668872 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::CVODESolverFailureError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::SolverErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError.html b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError.html new file mode 100644 index 00000000..3074ec60 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::CVODESolverFailureError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::CVODESolverFailureError Class Referencefinal
+
+
+ +

Exception for failures in the CVODE solver. + More...

+ +

#include <error_solver.h>

+
+Inheritance diagram for gridfire::exceptions::CVODESolverFailureError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::CVODESolverFailureError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Exception for failures in the CVODE solver.

+

This exception is thrown when the CVODE solver from the SUNDIALS suite encounters a failure during its operation.

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__coll__graph.map new file mode 100644 index 00000000..4713a397 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__coll__graph.map @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__coll__graph.md5 new file mode 100644 index 00000000..3cad378f --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__coll__graph.md5 @@ -0,0 +1 @@ +6a054480455f4fde3d4018928677df4f \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__coll__graph.svg new file mode 100644 index 00000000..026f5f08 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__coll__graph.svg @@ -0,0 +1,160 @@ + + + + + + + + + + + +gridfire::exceptions::CVODESolverFailureError + + +Node1 + + +gridfire::exceptions +::CVODESolverFailureError + + + + + +Node2 + + +gridfire::exceptions +::SUNDIALSError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::SolverError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +std::string + + + + + +Node6->Node4 + + + + + + m_msg + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__coll__graph_org.svg new file mode 100644 index 00000000..6317ec1d --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__coll__graph_org.svg @@ -0,0 +1,135 @@ + + + + + + +gridfire::exceptions::CVODESolverFailureError + + +Node1 + + +gridfire::exceptions +::CVODESolverFailureError + + + + + +Node2 + + +gridfire::exceptions +::SUNDIALSError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::SolverError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +std::string + + + + + +Node6->Node4 + + + + + + m_msg + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__inherit__graph.map new file mode 100644 index 00000000..5791979a --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__inherit__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__inherit__graph.md5 new file mode 100644 index 00000000..ba2a5c68 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__inherit__graph.md5 @@ -0,0 +1 @@ +4c6d7839ec707e7e25450cac396432c8 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__inherit__graph.svg new file mode 100644 index 00000000..ce069411 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__inherit__graph.svg @@ -0,0 +1,122 @@ + + + + + + + + + + + +gridfire::exceptions::CVODESolverFailureError + + +Node1 + + +gridfire::exceptions +::CVODESolverFailureError + + + + + +Node2 + + +gridfire::exceptions +::SUNDIALSError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::SolverError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__inherit__graph_org.svg new file mode 100644 index 00000000..5c58000b --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1CVODESolverFailureError__inherit__graph_org.svg @@ -0,0 +1,97 @@ + + + + + + +gridfire::exceptions::CVODESolverFailureError + + +Node1 + + +gridfire::exceptions +::CVODESolverFailureError + + + + + +Node2 + + +gridfire::exceptions +::SUNDIALSError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::SolverError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1DebugException-members.html b/docs/html/classgridfire_1_1exceptions_1_1DebugException-members.html new file mode 100644 index 00000000..82180147 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1DebugException-members.html @@ -0,0 +1,115 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::DebugException Member List
+
+
+ +

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

+ + + + + + +
DebugException(const std::string_view message, const std::source_location loc=std::source_location::current())gridfire::exceptions::DebugExceptioninlineexplicit
format_error(std::string_view message, const std::source_location loc)gridfire::exceptions::DebugExceptioninlineprivatestatic
GridFireError(std::string msg)gridfire::exceptions::GridFireErrorinlineexplicit
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1DebugException.html b/docs/html/classgridfire_1_1exceptions_1_1DebugException.html new file mode 100644 index 00000000..80dd5cea --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1DebugException.html @@ -0,0 +1,227 @@ + + + + + + + +GridFire: gridfire::exceptions::DebugException Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Static Private Member Functions | +List of all members
+
gridfire::exceptions::DebugException Class Referencefinal
+
+
+ +

Exception class for debug-only errors. + More...

+ +

#include <error_debug.h>

+
+Inheritance diagram for gridfire::exceptions::DebugException:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::DebugException:
+
+
+
[legend]
+ + + + + + + + + +

+Public Member Functions

 DebugException (const std::string_view message, const std::source_location loc=std::source_location::current())
 
- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+ + + +

+Static Private Member Functions

static std::string format_error (std::string_view message, const std::source_location loc)
 
+

Detailed Description

+

Exception class for debug-only errors.

+

This exception is intended to be used for errors that should only occur during development and debugging. In release builds, attempts to throw this exception will result in a compilation error.

+

Example usage:

if (debug_condition_failed) {
+
throw DebugException("Debug condition failed");
+
}
+
gridfire::exceptions::DebugException
Exception class for debug-only errors.
Definition error_debug.h:24
+

Constructor & Destructor Documentation

+ +

◆ DebugException()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
gridfire::exceptions::DebugException::DebugException (const std::string_view message,
const std::source_location loc = std::source_location::current() 
)
+ 		+inlineexplicit
+
+ +
+
+

Member Function Documentation

+ +

◆ format_error()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
static std::string gridfire::exceptions::DebugException::format_error (std::string_view message,
const std::source_location loc 
)
+ 		+inlinestaticprivate
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1DebugException.js b/docs/html/classgridfire_1_1exceptions_1_1DebugException.js new file mode 100644 index 00000000..7eb2c4c3 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1DebugException.js @@ -0,0 +1,5 @@ +var classgridfire_1_1exceptions_1_1DebugException = +[ + [ "DebugException", "classgridfire_1_1exceptions_1_1DebugException.html#a4c9767a6ef00a5b185ee121f79775b0c", null ], + [ "format_error", "classgridfire_1_1exceptions_1_1DebugException.html#a0eb41e70d1d06e45632e157507aec2c3", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1DebugException__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1DebugException__coll__graph.map new file mode 100644 index 00000000..7a7346d3 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1DebugException__coll__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1DebugException__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1DebugException__coll__graph.md5 new file mode 100644 index 00000000..4cd0c219 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1DebugException__coll__graph.md5 @@ -0,0 +1 @@ +d4031839a69cfe097c0ffdf98fdc4b25 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1DebugException__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1DebugException__coll__graph.svg new file mode 100644 index 00000000..d7af84d5 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1DebugException__coll__graph.svg @@ -0,0 +1,122 @@ + + + + + + + + + + + +gridfire::exceptions::DebugException + + +Node1 + + +gridfire::exceptions +::DebugException + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::string + + + + + +Node4->Node2 + + + + + + m_msg + + + +Node5 + + +std::basic_string< + Char > + + + + + +Node5->Node4 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1DebugException__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1DebugException__coll__graph_org.svg new file mode 100644 index 00000000..f5ee4789 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1DebugException__coll__graph_org.svg @@ -0,0 +1,97 @@ + + + + + + +gridfire::exceptions::DebugException + + +Node1 + + +gridfire::exceptions +::DebugException + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::string + + + + + +Node4->Node2 + + + + + + m_msg + + + +Node5 + + +std::basic_string< + Char > + + + + + +Node5->Node4 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1DebugException__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1DebugException__inherit__graph.map new file mode 100644 index 00000000..c5e0be50 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1DebugException__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1DebugException__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1DebugException__inherit__graph.md5 new file mode 100644 index 00000000..7a1aa1a7 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1DebugException__inherit__graph.md5 @@ -0,0 +1 @@ +336ebb6638e829268c283d9f11de83de \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1DebugException__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1DebugException__inherit__graph.svg new file mode 100644 index 00000000..8be0c91d --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1DebugException__inherit__graph.svg @@ -0,0 +1,84 @@ + + + + + + + + + + + +gridfire::exceptions::DebugException + + +Node1 + + +gridfire::exceptions +::DebugException + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1DebugException__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1DebugException__inherit__graph_org.svg new file mode 100644 index 00000000..db7ce68e --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1DebugException__inherit__graph_org.svg @@ -0,0 +1,59 @@ + + + + + + +gridfire::exceptions::DebugException + + +Node1 + + +gridfire::exceptions +::DebugException + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1EngineError-members.html b/docs/html/classgridfire_1_1exceptions_1_1EngineError-members.html new file mode 100644 index 00000000..165da823 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1EngineError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::EngineError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::EngineErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1EngineError.html b/docs/html/classgridfire_1_1exceptions_1_1EngineError.html new file mode 100644 index 00000000..6143679d --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1EngineError.html @@ -0,0 +1,173 @@ + + + + + + + +GridFire: gridfire::exceptions::EngineError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Private Member Functions | +List of all members
+
gridfire::exceptions::EngineError Class Reference
+
+
+ +

Base class for engine-related exceptions. + More...

+ +

#include <error_engine.h>

+
+Inheritance diagram for gridfire::exceptions::EngineError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::EngineError:
+
+
+
[legend]
+ + + + +

+Private Member Functions

 GridFireError (std::string msg)
 
+ + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Base class for engine-related exceptions.

+

This class serves as the base for all exceptions specific to the reaction network engine in the GridFire library. It extends the GridFireError class and allows for custom error messages related to engine operations.

+

Member Function Documentation

+ +

◆ GridFireError()

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::exceptions::GridFireError::GridFireError (std::string msg)
+ 		+inlineexplicitprivate
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1EngineError.js b/docs/html/classgridfire_1_1exceptions_1_1EngineError.js new file mode 100644 index 00000000..8f31d5c1 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1EngineError.js @@ -0,0 +1,4 @@ +var classgridfire_1_1exceptions_1_1EngineError = +[ + [ "GridFireError", "classgridfire_1_1exceptions_1_1EngineError.html#a672d340ff9287f5511342a4e5f4fbb23", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1EngineError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1EngineError__coll__graph.map new file mode 100644 index 00000000..8b21319f --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1EngineError__coll__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1EngineError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1EngineError__coll__graph.md5 new file mode 100644 index 00000000..91d0be87 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1EngineError__coll__graph.md5 @@ -0,0 +1 @@ +b13afbfc24df65a9c6b4acd9c2cb51f0 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1EngineError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1EngineError__coll__graph.svg new file mode 100644 index 00000000..8252434c --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1EngineError__coll__graph.svg @@ -0,0 +1,122 @@ + + + + + + + + + + + +gridfire::exceptions::EngineError + + +Node1 + + +gridfire::exceptions +::EngineError + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::string + + + + + +Node4->Node2 + + + + + + m_msg + + + +Node5 + + +std::basic_string< + Char > + + + + + +Node5->Node4 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1EngineError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1EngineError__coll__graph_org.svg new file mode 100644 index 00000000..faef78c0 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1EngineError__coll__graph_org.svg @@ -0,0 +1,97 @@ + + + + + + +gridfire::exceptions::EngineError + + +Node1 + + +gridfire::exceptions +::EngineError + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::string + + + + + +Node4->Node2 + + + + + + m_msg + + + +Node5 + + +std::basic_string< + Char > + + + + + +Node5->Node4 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1EngineError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1EngineError__inherit__graph.map new file mode 100644 index 00000000..dd756a9c --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1EngineError__inherit__graph.map @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1EngineError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1EngineError__inherit__graph.md5 new file mode 100644 index 00000000..ec69401b --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1EngineError__inherit__graph.md5 @@ -0,0 +1 @@ +ce318fa3bc97adb2b2c3f6584746ebf2 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1EngineError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1EngineError__inherit__graph.svg new file mode 100644 index 00000000..e3432768 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1EngineError__inherit__graph.svg @@ -0,0 +1,332 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::exceptions::EngineError + + +Node1 + + +gridfire::exceptions +::EngineError + + + + + +Node4 + + +gridfire::exceptions +::BadCollectionError + + + + + +Node1->Node4 + + + + + + + + +Node5 + + +gridfire::exceptions +::BadRHSEngineError + + + + + +Node1->Node5 + + + + + + + + +Node6 + + +gridfire::exceptions +::FailedToPartitionEngineError + + + + + +Node1->Node6 + + + + + + + + +Node7 + + +gridfire::exceptions +::InvalidQSESolutionError + + + + + +Node1->Node7 + + + + + + + + +Node8 + + +gridfire::exceptions +::JacobianError + + + + + +Node1->Node8 + + + + + + + + +Node12 + + +gridfire::exceptions +::NetworkResizedError + + + + + +Node1->Node12 + + + + + + + + +Node13 + + +gridfire::exceptions +::UnableToSetNetworkReactions +Error + + + + + +Node1->Node13 + + + + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + +Node9 + + +gridfire::exceptions +::StaleJacobianError + + + + + +Node8->Node9 + + + + + + + + +Node10 + + +gridfire::exceptions +::UninitializedJacobianError + + + + + +Node8->Node10 + + + + + + + + +Node11 + + +gridfire::exceptions +::UnknownJacobianError + + + + + +Node8->Node11 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1EngineError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1EngineError__inherit__graph_org.svg new file mode 100644 index 00000000..a5dece66 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1EngineError__inherit__graph_org.svg @@ -0,0 +1,250 @@ + + + + + + +gridfire::exceptions::EngineError + + +Node1 + + +gridfire::exceptions +::EngineError + + + + + +Node4 + + +gridfire::exceptions +::BadCollectionError + + + + + +Node1->Node4 + + + + + + + + +Node5 + + +gridfire::exceptions +::BadRHSEngineError + + + + + +Node1->Node5 + + + + + + + + +Node6 + + +gridfire::exceptions +::FailedToPartitionEngineError + + + + + +Node1->Node6 + + + + + + + + +Node7 + + +gridfire::exceptions +::InvalidQSESolutionError + + + + + +Node1->Node7 + + + + + + + + +Node8 + + +gridfire::exceptions +::JacobianError + + + + + +Node1->Node8 + + + + + + + + +Node12 + + +gridfire::exceptions +::NetworkResizedError + + + + + +Node1->Node12 + + + + + + + + +Node13 + + +gridfire::exceptions +::UnableToSetNetworkReactions +Error + + + + + +Node1->Node13 + + + + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + +Node9 + + +gridfire::exceptions +::StaleJacobianError + + + + + +Node8->Node9 + + + + + + + + +Node10 + + +gridfire::exceptions +::UninitializedJacobianError + + + + + +Node8->Node10 + + + + + + + + +Node11 + + +gridfire::exceptions +::UnknownJacobianError + + + + + +Node8->Node11 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError-members.html b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError-members.html new file mode 100644 index 00000000..08b444c6 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::FailedToPartitionEngineError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::EngineErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError.html b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError.html new file mode 100644 index 00000000..803e9122 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::FailedToPartitionEngineError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::FailedToPartitionEngineError Class Referencefinal
+
+
+ +

Exception for failures in partitioning the engine. + More...

+ +

#include <error_engine.h>

+
+Inheritance diagram for gridfire::exceptions::FailedToPartitionEngineError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::FailedToPartitionEngineError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Exception for failures in partitioning the engine.

+

This exception is thrown when the engine fails to partition the reaction network as required for certain calculations or optimizations.

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__coll__graph.map new file mode 100644 index 00000000..316dbc4a --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__coll__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__coll__graph.md5 new file mode 100644 index 00000000..c4761c24 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__coll__graph.md5 @@ -0,0 +1 @@ +482085b7b04a7edef45e73bc55e5e698 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__coll__graph.svg new file mode 100644 index 00000000..974b1a39 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__coll__graph.svg @@ -0,0 +1,141 @@ + + + + + + + + + + + +gridfire::exceptions::FailedToPartitionEngineError + + +Node1 + + +gridfire::exceptions +::FailedToPartitionEngineError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__coll__graph_org.svg new file mode 100644 index 00000000..6119f86e --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__coll__graph_org.svg @@ -0,0 +1,116 @@ + + + + + + +gridfire::exceptions::FailedToPartitionEngineError + + +Node1 + + +gridfire::exceptions +::FailedToPartitionEngineError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__inherit__graph.map new file mode 100644 index 00000000..1d5f2bfc --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__inherit__graph.md5 new file mode 100644 index 00000000..0360403f --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__inherit__graph.md5 @@ -0,0 +1 @@ +4e6c137b8323437faf2a5c59a7b95f32 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__inherit__graph.svg new file mode 100644 index 00000000..39fbc5fe --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__inherit__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +gridfire::exceptions::FailedToPartitionEngineError + + +Node1 + + +gridfire::exceptions +::FailedToPartitionEngineError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__inherit__graph_org.svg new file mode 100644 index 00000000..9adcb356 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1FailedToPartitionEngineError__inherit__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +gridfire::exceptions::FailedToPartitionEngineError + + +Node1 + + +gridfire::exceptions +::FailedToPartitionEngineError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1GridFireError-members.html b/docs/html/classgridfire_1_1exceptions_1_1GridFireError-members.html new file mode 100644 index 00000000..716adf06 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1GridFireError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::GridFireError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::GridFireErrorinlineexplicit
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1GridFireError.html b/docs/html/classgridfire_1_1exceptions_1_1GridFireError.html new file mode 100644 index 00000000..29cbddac --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1GridFireError.html @@ -0,0 +1,222 @@ + + + + + + + +GridFire: gridfire::exceptions::GridFireError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
gridfire::exceptions::GridFireError Class Reference
+
+
+ +

Base class for GridFire exceptions. + More...

+ +

#include <error_gridfire.h>

+
+Inheritance diagram for gridfire::exceptions::GridFireError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::GridFireError:
+
+
+
[legend]
+ + + + + + +

+Public Member Functions

 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+ + + +

+Private Attributes

std::string m_msg
 
+

Detailed Description

+

Base class for GridFire exceptions.

+

This class serves as the base for all exceptions specific to the GridFire library. It extends the standard std::exception class and allows for custom error messages.

+

Constructor & Destructor Documentation

+ +

◆ GridFireError()

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::exceptions::GridFireError::GridFireError (std::string msg)
+ 		+inlineexplicit
+
+ +
+
+

Member Function Documentation

+ +

◆ what()

+ +
+
+ + + + + +
+ + + + + + + +
const char * gridfire::exceptions::GridFireError::what () const
+ 		+inlineoverridenoexcept
+
+ +
+
+

Member Data Documentation

+ +

◆ m_msg

+ +
+
+ + + + + +
+ + + + +
std::string gridfire::exceptions::GridFireError::m_msg
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1GridFireError.js b/docs/html/classgridfire_1_1exceptions_1_1GridFireError.js new file mode 100644 index 00000000..4bec20ba --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1GridFireError.js @@ -0,0 +1,6 @@ +var classgridfire_1_1exceptions_1_1GridFireError = +[ + [ "GridFireError", "classgridfire_1_1exceptions_1_1GridFireError.html#a672d340ff9287f5511342a4e5f4fbb23", null ], + [ "what", "classgridfire_1_1exceptions_1_1GridFireError.html#a6986522d45e8d94da310d1b37373414c", null ], + [ "m_msg", "classgridfire_1_1exceptions_1_1GridFireError.html#a7c554458220cedf87907df652fc81301", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1GridFireError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1GridFireError__coll__graph.map new file mode 100644 index 00000000..b0690ce2 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1GridFireError__coll__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1GridFireError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1GridFireError__coll__graph.md5 new file mode 100644 index 00000000..52509153 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1GridFireError__coll__graph.md5 @@ -0,0 +1 @@ +a3fecd44e22357866adf035bc5f59fce \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1GridFireError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1GridFireError__coll__graph.svg new file mode 100644 index 00000000..b88b1acc --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1GridFireError__coll__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +gridfire::exceptions::GridFireError + + +Node1 + + +gridfire::exceptions +::GridFireError + + + + + +Node2 + + +std::exception + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::string + + + + + +Node3->Node1 + + + + + + m_msg + + + +Node4 + + +std::basic_string< + Char > + + + + + +Node4->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1GridFireError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1GridFireError__coll__graph_org.svg new file mode 100644 index 00000000..9d71f851 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1GridFireError__coll__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +gridfire::exceptions::GridFireError + + +Node1 + + +gridfire::exceptions +::GridFireError + + + + + +Node2 + + +std::exception + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::string + + + + + +Node3->Node1 + + + + + + m_msg + + + +Node4 + + +std::basic_string< + Char > + + + + + +Node4->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1GridFireError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1GridFireError__inherit__graph.map new file mode 100644 index 00000000..74df3235 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1GridFireError__inherit__graph.map @@ -0,0 +1,57 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1GridFireError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1GridFireError__inherit__graph.md5 new file mode 100644 index 00000000..c6090d76 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1GridFireError__inherit__graph.md5 @@ -0,0 +1 @@ +c48b6d2d7aaa7c8e75cadf2c8350b322 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1GridFireError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1GridFireError__inherit__graph.svg new file mode 100644 index 00000000..ef703082 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1GridFireError__inherit__graph.svg @@ -0,0 +1,617 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::exceptions::GridFireError + + +Node1 + + +gridfire::exceptions +::GridFireError + + + + + +Node3 + + +gridfire::exceptions +::DebugException + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::exceptions +::EngineError + + + + + +Node1->Node4 + + + + + + + + +Node15 + + +gridfire::exceptions +::PolicyError + + + + + +Node1->Node15 + + + + + + + + +Node19 + + +gridfire::exceptions +::ReactionError + + + + + +Node1->Node19 + + + + + + + + +Node21 + + +gridfire::exceptions +::SolverError + + + + + +Node1->Node21 + + + + + + + + +Node27 + + +gridfire::exceptions +::UtilityError + + + + + +Node1->Node27 + + + + + + + + +Node2 + + +std::exception + + + + + +Node2->Node1 + + + + + + + + +Node5 + + +gridfire::exceptions +::BadCollectionError + + + + + +Node4->Node5 + + + + + + + + +Node6 + + +gridfire::exceptions +::BadRHSEngineError + + + + + +Node4->Node6 + + + + + + + + +Node7 + + +gridfire::exceptions +::FailedToPartitionEngineError + + + + + +Node4->Node7 + + + + + + + + +Node8 + + +gridfire::exceptions +::InvalidQSESolutionError + + + + + +Node4->Node8 + + + + + + + + +Node9 + + +gridfire::exceptions +::JacobianError + + + + + +Node4->Node9 + + + + + + + + +Node13 + + +gridfire::exceptions +::NetworkResizedError + + + + + +Node4->Node13 + + + + + + + + +Node14 + + +gridfire::exceptions +::UnableToSetNetworkReactions +Error + + + + + +Node4->Node14 + + + + + + + + +Node10 + + +gridfire::exceptions +::StaleJacobianError + + + + + +Node9->Node10 + + + + + + + + +Node11 + + +gridfire::exceptions +::UninitializedJacobianError + + + + + +Node9->Node11 + + + + + + + + +Node12 + + +gridfire::exceptions +::UnknownJacobianError + + + + + +Node9->Node12 + + + + + + + + +Node16 + + +gridfire::exceptions +::MissingBaseReactionError + + + + + +Node15->Node16 + + + + + + + + +Node17 + + +gridfire::exceptions +::MissingKeyReactionError + + + + + +Node15->Node17 + + + + + + + + +Node18 + + +gridfire::exceptions +::MissingSeedSpeciesError + + + + + +Node15->Node18 + + + + + + + + +Node20 + + +gridfire::exceptions +::ReactionParsingError + + + + + +Node19->Node20 + + + + + + + + +Node22 + + +gridfire::exceptions +::IllConditionedJacobianError + + + + + +Node21->Node22 + + + + + + + + +Node23 + + +gridfire::exceptions +::SUNDIALSError + + + + + +Node21->Node23 + + + + + + + + +Node26 + + +gridfire::exceptions +::SingularJacobianError + + + + + +Node21->Node26 + + + + + + + + +Node24 + + +gridfire::exceptions +::CVODESolverFailureError + + + + + +Node23->Node24 + + + + + + + + +Node25 + + +gridfire::exceptions +::KINSolSolverFailureError + + + + + +Node23->Node25 + + + + + + + + +Node28 + + +gridfire::exceptions +::HashingError + + + + + +Node27->Node28 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1GridFireError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1GridFireError__inherit__graph_org.svg new file mode 100644 index 00000000..bd981bff --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1GridFireError__inherit__graph_org.svg @@ -0,0 +1,535 @@ + + + + + + +gridfire::exceptions::GridFireError + + +Node1 + + +gridfire::exceptions +::GridFireError + + + + + +Node3 + + +gridfire::exceptions +::DebugException + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::exceptions +::EngineError + + + + + +Node1->Node4 + + + + + + + + +Node15 + + +gridfire::exceptions +::PolicyError + + + + + +Node1->Node15 + + + + + + + + +Node19 + + +gridfire::exceptions +::ReactionError + + + + + +Node1->Node19 + + + + + + + + +Node21 + + +gridfire::exceptions +::SolverError + + + + + +Node1->Node21 + + + + + + + + +Node27 + + +gridfire::exceptions +::UtilityError + + + + + +Node1->Node27 + + + + + + + + +Node2 + + +std::exception + + + + + +Node2->Node1 + + + + + + + + +Node5 + + +gridfire::exceptions +::BadCollectionError + + + + + +Node4->Node5 + + + + + + + + +Node6 + + +gridfire::exceptions +::BadRHSEngineError + + + + + +Node4->Node6 + + + + + + + + +Node7 + + +gridfire::exceptions +::FailedToPartitionEngineError + + + + + +Node4->Node7 + + + + + + + + +Node8 + + +gridfire::exceptions +::InvalidQSESolutionError + + + + + +Node4->Node8 + + + + + + + + +Node9 + + +gridfire::exceptions +::JacobianError + + + + + +Node4->Node9 + + + + + + + + +Node13 + + +gridfire::exceptions +::NetworkResizedError + + + + + +Node4->Node13 + + + + + + + + +Node14 + + +gridfire::exceptions +::UnableToSetNetworkReactions +Error + + + + + +Node4->Node14 + + + + + + + + +Node10 + + +gridfire::exceptions +::StaleJacobianError + + + + + +Node9->Node10 + + + + + + + + +Node11 + + +gridfire::exceptions +::UninitializedJacobianError + + + + + +Node9->Node11 + + + + + + + + +Node12 + + +gridfire::exceptions +::UnknownJacobianError + + + + + +Node9->Node12 + + + + + + + + +Node16 + + +gridfire::exceptions +::MissingBaseReactionError + + + + + +Node15->Node16 + + + + + + + + +Node17 + + +gridfire::exceptions +::MissingKeyReactionError + + + + + +Node15->Node17 + + + + + + + + +Node18 + + +gridfire::exceptions +::MissingSeedSpeciesError + + + + + +Node15->Node18 + + + + + + + + +Node20 + + +gridfire::exceptions +::ReactionParsingError + + + + + +Node19->Node20 + + + + + + + + +Node22 + + +gridfire::exceptions +::IllConditionedJacobianError + + + + + +Node21->Node22 + + + + + + + + +Node23 + + +gridfire::exceptions +::SUNDIALSError + + + + + +Node21->Node23 + + + + + + + + +Node26 + + +gridfire::exceptions +::SingularJacobianError + + + + + +Node21->Node26 + + + + + + + + +Node24 + + +gridfire::exceptions +::CVODESolverFailureError + + + + + +Node23->Node24 + + + + + + + + +Node25 + + +gridfire::exceptions +::KINSolSolverFailureError + + + + + +Node23->Node25 + + + + + + + + +Node28 + + +gridfire::exceptions +::HashingError + + + + + +Node27->Node28 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1HashingError-members.html b/docs/html/classgridfire_1_1exceptions_1_1HashingError-members.html new file mode 100644 index 00000000..0b4ba387 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1HashingError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::HashingError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::UtilityErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1HashingError.html b/docs/html/classgridfire_1_1exceptions_1_1HashingError.html new file mode 100644 index 00000000..d9da9bda --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1HashingError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::HashingError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::HashingError Class Referencefinal
+
+
+ +

Exception class for hashing-related errors in GridFire. + More...

+ +

#include <error_utils.h>

+
+Inheritance diagram for gridfire::exceptions::HashingError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::HashingError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Exception class for hashing-related errors in GridFire.

+

This class is used to represent errors that occur during hashing operations.

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1HashingError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1HashingError__coll__graph.map new file mode 100644 index 00000000..9d3d8d51 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1HashingError__coll__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1HashingError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1HashingError__coll__graph.md5 new file mode 100644 index 00000000..40693582 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1HashingError__coll__graph.md5 @@ -0,0 +1 @@ +1ede3308d73c154a93dc6e8554824eec \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1HashingError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1HashingError__coll__graph.svg new file mode 100644 index 00000000..01b9f1e1 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1HashingError__coll__graph.svg @@ -0,0 +1,141 @@ + + + + + + + + + + + +gridfire::exceptions::HashingError + + +Node1 + + +gridfire::exceptions +::HashingError + + + + + +Node2 + + +gridfire::exceptions +::UtilityError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1HashingError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1HashingError__coll__graph_org.svg new file mode 100644 index 00000000..1dd7cffc --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1HashingError__coll__graph_org.svg @@ -0,0 +1,116 @@ + + + + + + +gridfire::exceptions::HashingError + + +Node1 + + +gridfire::exceptions +::HashingError + + + + + +Node2 + + +gridfire::exceptions +::UtilityError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1HashingError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1HashingError__inherit__graph.map new file mode 100644 index 00000000..7d7dbc97 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1HashingError__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1HashingError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1HashingError__inherit__graph.md5 new file mode 100644 index 00000000..bec7c340 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1HashingError__inherit__graph.md5 @@ -0,0 +1 @@ +48c90769aa1ed63fae631ed8496e939c \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1HashingError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1HashingError__inherit__graph.svg new file mode 100644 index 00000000..4e2e197e --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1HashingError__inherit__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +gridfire::exceptions::HashingError + + +Node1 + + +gridfire::exceptions +::HashingError + + + + + +Node2 + + +gridfire::exceptions +::UtilityError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1HashingError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1HashingError__inherit__graph_org.svg new file mode 100644 index 00000000..58062d18 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1HashingError__inherit__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +gridfire::exceptions::HashingError + + +Node1 + + +gridfire::exceptions +::HashingError + + + + + +Node2 + + +gridfire::exceptions +::UtilityError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError-members.html b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError-members.html new file mode 100644 index 00000000..15b01b86 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::IllConditionedJacobianError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::SolverErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError.html b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError.html new file mode 100644 index 00000000..f9edcc71 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::IllConditionedJacobianError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::IllConditionedJacobianError Class Referencefinal
+
+
+ +

Exception thrown when the Jacobian matrix is ill-conditioned. + More...

+ +

#include <error_solver.h>

+
+Inheritance diagram for gridfire::exceptions::IllConditionedJacobianError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::IllConditionedJacobianError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Exception thrown when the Jacobian matrix is ill-conditioned.

+

This exception is thrown when the solver detects that the Jacobian matrix is ill-conditioned, which may lead to inaccurate or unstable solutions.

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__coll__graph.map new file mode 100644 index 00000000..d2fb3fc6 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__coll__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__coll__graph.md5 new file mode 100644 index 00000000..fc895209 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__coll__graph.md5 @@ -0,0 +1 @@ +66854a30830ff30f80bb36a34f891561 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__coll__graph.svg new file mode 100644 index 00000000..cfb31539 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__coll__graph.svg @@ -0,0 +1,141 @@ + + + + + + + + + + + +gridfire::exceptions::IllConditionedJacobianError + + +Node1 + + +gridfire::exceptions +::IllConditionedJacobianError + + + + + +Node2 + + +gridfire::exceptions +::SolverError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__coll__graph_org.svg new file mode 100644 index 00000000..f99f5ecb --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__coll__graph_org.svg @@ -0,0 +1,116 @@ + + + + + + +gridfire::exceptions::IllConditionedJacobianError + + +Node1 + + +gridfire::exceptions +::IllConditionedJacobianError + + + + + +Node2 + + +gridfire::exceptions +::SolverError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__inherit__graph.map new file mode 100644 index 00000000..0afa032e --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__inherit__graph.md5 new file mode 100644 index 00000000..d5379a21 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__inherit__graph.md5 @@ -0,0 +1 @@ +1ae9672be64defbb6ca9cf67940d7b3f \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__inherit__graph.svg new file mode 100644 index 00000000..ee1c9652 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__inherit__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +gridfire::exceptions::IllConditionedJacobianError + + +Node1 + + +gridfire::exceptions +::IllConditionedJacobianError + + + + + +Node2 + + +gridfire::exceptions +::SolverError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__inherit__graph_org.svg new file mode 100644 index 00000000..b04569cb --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1IllConditionedJacobianError__inherit__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +gridfire::exceptions::IllConditionedJacobianError + + +Node1 + + +gridfire::exceptions +::IllConditionedJacobianError + + + + + +Node2 + + +gridfire::exceptions +::SolverError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError-members.html b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError-members.html new file mode 100644 index 00000000..968b92e0 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::InvalidQSESolutionError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::EngineErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError.html b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError.html new file mode 100644 index 00000000..55d686fe --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::InvalidQSESolutionError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::InvalidQSESolutionError Class Referencefinal
+
+
+ +

Exception for invalid QSE solution in the engine. + More...

+ +

#include <error_engine.h>

+
+Inheritance diagram for gridfire::exceptions::InvalidQSESolutionError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::InvalidQSESolutionError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Exception for invalid QSE solution in the engine.

+

This exception is thrown when the engine computes an invalid solution while performing Quasi-Statistical Equilibrium (QSE) calculations.

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__coll__graph.map new file mode 100644 index 00000000..b44937f8 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__coll__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__coll__graph.md5 new file mode 100644 index 00000000..60af7331 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__coll__graph.md5 @@ -0,0 +1 @@ +693419b452c2018f1d4c6a93011153f6 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__coll__graph.svg new file mode 100644 index 00000000..63361348 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__coll__graph.svg @@ -0,0 +1,141 @@ + + + + + + + + + + + +gridfire::exceptions::InvalidQSESolutionError + + +Node1 + + +gridfire::exceptions +::InvalidQSESolutionError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__coll__graph_org.svg new file mode 100644 index 00000000..1c8418ef --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__coll__graph_org.svg @@ -0,0 +1,116 @@ + + + + + + +gridfire::exceptions::InvalidQSESolutionError + + +Node1 + + +gridfire::exceptions +::InvalidQSESolutionError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__inherit__graph.map new file mode 100644 index 00000000..7a772bb5 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__inherit__graph.md5 new file mode 100644 index 00000000..b68d0f0c --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__inherit__graph.md5 @@ -0,0 +1 @@ +232db5b21f12fa5deea9fd3048340204 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__inherit__graph.svg new file mode 100644 index 00000000..7f22e75e --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__inherit__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +gridfire::exceptions::InvalidQSESolutionError + + +Node1 + + +gridfire::exceptions +::InvalidQSESolutionError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__inherit__graph_org.svg new file mode 100644 index 00000000..9fe27035 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1InvalidQSESolutionError__inherit__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +gridfire::exceptions::InvalidQSESolutionError + + +Node1 + + +gridfire::exceptions +::InvalidQSESolutionError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1JacobianError-members.html b/docs/html/classgridfire_1_1exceptions_1_1JacobianError-members.html new file mode 100644 index 00000000..09255187 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1JacobianError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::JacobianError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::EngineErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1JacobianError.html b/docs/html/classgridfire_1_1exceptions_1_1JacobianError.html new file mode 100644 index 00000000..57d53d1b --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1JacobianError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::JacobianError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::JacobianError Class Reference
+
+
+ +

Base class for Jacobian-related exceptions. + More...

+ +

#include <error_engine.h>

+
+Inheritance diagram for gridfire::exceptions::JacobianError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::JacobianError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Base class for Jacobian-related exceptions.

+

This class serves as the base for all exceptions specific to Jacobian matrix operations in the reaction network engine.

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1JacobianError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1JacobianError__coll__graph.map new file mode 100644 index 00000000..bfe470e1 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1JacobianError__coll__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1JacobianError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1JacobianError__coll__graph.md5 new file mode 100644 index 00000000..4621ab08 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1JacobianError__coll__graph.md5 @@ -0,0 +1 @@ +781711b7c7bda6f943d94408229ecc3c \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1JacobianError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1JacobianError__coll__graph.svg new file mode 100644 index 00000000..9b0cacd7 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1JacobianError__coll__graph.svg @@ -0,0 +1,141 @@ + + + + + + + + + + + +gridfire::exceptions::JacobianError + + +Node1 + + +gridfire::exceptions +::JacobianError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1JacobianError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1JacobianError__coll__graph_org.svg new file mode 100644 index 00000000..8839a445 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1JacobianError__coll__graph_org.svg @@ -0,0 +1,116 @@ + + + + + + +gridfire::exceptions::JacobianError + + +Node1 + + +gridfire::exceptions +::JacobianError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1JacobianError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1JacobianError__inherit__graph.map new file mode 100644 index 00000000..b21f1b6a --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1JacobianError__inherit__graph.map @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1JacobianError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1JacobianError__inherit__graph.md5 new file mode 100644 index 00000000..3cf3c63b --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1JacobianError__inherit__graph.md5 @@ -0,0 +1 @@ +be68aa2430c52b3065aed3bba821fa1b \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1JacobianError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1JacobianError__inherit__graph.svg new file mode 100644 index 00000000..b371634c --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1JacobianError__inherit__graph.svg @@ -0,0 +1,217 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::exceptions::JacobianError + + +Node1 + + +gridfire::exceptions +::JacobianError + + + + + +Node5 + + +gridfire::exceptions +::StaleJacobianError + + + + + +Node1->Node5 + + + + + + + + +Node6 + + +gridfire::exceptions +::UninitializedJacobianError + + + + + +Node1->Node6 + + + + + + + + +Node7 + + +gridfire::exceptions +::UnknownJacobianError + + + + + +Node1->Node7 + + + + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1JacobianError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1JacobianError__inherit__graph_org.svg new file mode 100644 index 00000000..1ba05435 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1JacobianError__inherit__graph_org.svg @@ -0,0 +1,135 @@ + + + + + + +gridfire::exceptions::JacobianError + + +Node1 + + +gridfire::exceptions +::JacobianError + + + + + +Node5 + + +gridfire::exceptions +::StaleJacobianError + + + + + +Node1->Node5 + + + + + + + + +Node6 + + +gridfire::exceptions +::UninitializedJacobianError + + + + + +Node1->Node6 + + + + + + + + +Node7 + + +gridfire::exceptions +::UnknownJacobianError + + + + + +Node1->Node7 + + + + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError-members.html b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError-members.html new file mode 100644 index 00000000..4ad914ab --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::KINSolSolverFailureError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::SolverErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError.html b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError.html new file mode 100644 index 00000000..b1ce2471 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::KINSolSolverFailureError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::KINSolSolverFailureError Class Referencefinal
+
+
+ +

Exception for failures in the KINSOL solver. + More...

+ +

#include <error_solver.h>

+
+Inheritance diagram for gridfire::exceptions::KINSolSolverFailureError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::KINSolSolverFailureError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Exception for failures in the KINSOL solver.

+

This exception is thrown when the KINSOL solver from the SUNDIALS suite encounters a failure during its operation.

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__coll__graph.map new file mode 100644 index 00000000..7e4d4bf7 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__coll__graph.map @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__coll__graph.md5 new file mode 100644 index 00000000..814d4f6c --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__coll__graph.md5 @@ -0,0 +1 @@ +d443a5900e9208b97375d0b06b06fca0 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__coll__graph.svg new file mode 100644 index 00000000..f7925d76 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__coll__graph.svg @@ -0,0 +1,160 @@ + + + + + + + + + + + +gridfire::exceptions::KINSolSolverFailureError + + +Node1 + + +gridfire::exceptions +::KINSolSolverFailureError + + + + + +Node2 + + +gridfire::exceptions +::SUNDIALSError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::SolverError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +std::string + + + + + +Node6->Node4 + + + + + + m_msg + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__coll__graph_org.svg new file mode 100644 index 00000000..c63589d3 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__coll__graph_org.svg @@ -0,0 +1,135 @@ + + + + + + +gridfire::exceptions::KINSolSolverFailureError + + +Node1 + + +gridfire::exceptions +::KINSolSolverFailureError + + + + + +Node2 + + +gridfire::exceptions +::SUNDIALSError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::SolverError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +std::string + + + + + +Node6->Node4 + + + + + + m_msg + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__inherit__graph.map new file mode 100644 index 00000000..f3a132d8 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__inherit__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__inherit__graph.md5 new file mode 100644 index 00000000..76952dd4 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__inherit__graph.md5 @@ -0,0 +1 @@ +92fc1a104d4e868b4f4c1519a8c04ec8 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__inherit__graph.svg new file mode 100644 index 00000000..e369e3d5 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__inherit__graph.svg @@ -0,0 +1,122 @@ + + + + + + + + + + + +gridfire::exceptions::KINSolSolverFailureError + + +Node1 + + +gridfire::exceptions +::KINSolSolverFailureError + + + + + +Node2 + + +gridfire::exceptions +::SUNDIALSError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::SolverError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__inherit__graph_org.svg new file mode 100644 index 00000000..12121cb4 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1KINSolSolverFailureError__inherit__graph_org.svg @@ -0,0 +1,97 @@ + + + + + + +gridfire::exceptions::KINSolSolverFailureError + + +Node1 + + +gridfire::exceptions +::KINSolSolverFailureError + + + + + +Node2 + + +gridfire::exceptions +::SUNDIALSError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::SolverError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError-members.html b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError-members.html new file mode 100644 index 00000000..402d572f --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::MissingBaseReactionError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::PolicyErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError.html b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError.html new file mode 100644 index 00000000..5e840965 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::MissingBaseReactionError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::MissingBaseReactionError Class Referencefinal
+
+
+ +

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

+ +

#include <error_policy.h>

+
+Inheritance diagram for gridfire::exceptions::MissingBaseReactionError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::MissingBaseReactionError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

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

+

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

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__coll__graph.map new file mode 100644 index 00000000..b120dbfe --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__coll__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__coll__graph.md5 new file mode 100644 index 00000000..c2cdfc27 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__coll__graph.md5 @@ -0,0 +1 @@ +63aacf82cc905e3f1472a3b9c6486ea6 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__coll__graph.svg new file mode 100644 index 00000000..0eac0c3b --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__coll__graph.svg @@ -0,0 +1,141 @@ + + + + + + + + + + + +gridfire::exceptions::MissingBaseReactionError + + +Node1 + + +gridfire::exceptions +::MissingBaseReactionError + + + + + +Node2 + + +gridfire::exceptions +::PolicyError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__coll__graph_org.svg new file mode 100644 index 00000000..ddec8a91 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__coll__graph_org.svg @@ -0,0 +1,116 @@ + + + + + + +gridfire::exceptions::MissingBaseReactionError + + +Node1 + + +gridfire::exceptions +::MissingBaseReactionError + + + + + +Node2 + + +gridfire::exceptions +::PolicyError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__inherit__graph.map new file mode 100644 index 00000000..9c15f835 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__inherit__graph.md5 new file mode 100644 index 00000000..2b589818 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__inherit__graph.md5 @@ -0,0 +1 @@ +5b05abf7ab781ce421ba7ca7fef50bd4 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__inherit__graph.svg new file mode 100644 index 00000000..293f4852 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__inherit__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +gridfire::exceptions::MissingBaseReactionError + + +Node1 + + +gridfire::exceptions +::MissingBaseReactionError + + + + + +Node2 + + +gridfire::exceptions +::PolicyError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__inherit__graph_org.svg new file mode 100644 index 00000000..c182d7e1 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingBaseReactionError__inherit__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +gridfire::exceptions::MissingBaseReactionError + + +Node1 + + +gridfire::exceptions +::MissingBaseReactionError + + + + + +Node2 + + +gridfire::exceptions +::PolicyError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError-members.html b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError-members.html new file mode 100644 index 00000000..26c1c6f3 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::MissingKeyReactionError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::PolicyErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError.html b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError.html new file mode 100644 index 00000000..e32db859 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::MissingKeyReactionError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::MissingKeyReactionError Class Referencefinal
+
+
+ +

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

+ +

#include <error_policy.h>

+
+Inheritance diagram for gridfire::exceptions::MissingKeyReactionError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::MissingKeyReactionError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

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

+

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

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__coll__graph.map new file mode 100644 index 00000000..194da2c8 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__coll__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__coll__graph.md5 new file mode 100644 index 00000000..c6cc698f --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__coll__graph.md5 @@ -0,0 +1 @@ +60e2405dee734b5c402d11deef07abd2 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__coll__graph.svg new file mode 100644 index 00000000..58198049 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__coll__graph.svg @@ -0,0 +1,141 @@ + + + + + + + + + + + +gridfire::exceptions::MissingKeyReactionError + + +Node1 + + +gridfire::exceptions +::MissingKeyReactionError + + + + + +Node2 + + +gridfire::exceptions +::PolicyError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__coll__graph_org.svg new file mode 100644 index 00000000..43f34545 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__coll__graph_org.svg @@ -0,0 +1,116 @@ + + + + + + +gridfire::exceptions::MissingKeyReactionError + + +Node1 + + +gridfire::exceptions +::MissingKeyReactionError + + + + + +Node2 + + +gridfire::exceptions +::PolicyError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__inherit__graph.map new file mode 100644 index 00000000..e14ae368 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__inherit__graph.md5 new file mode 100644 index 00000000..8af14937 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__inherit__graph.md5 @@ -0,0 +1 @@ +07f46cf47361e3289c425da3d77d676f \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__inherit__graph.svg new file mode 100644 index 00000000..f7f4c355 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__inherit__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +gridfire::exceptions::MissingKeyReactionError + + +Node1 + + +gridfire::exceptions +::MissingKeyReactionError + + + + + +Node2 + + +gridfire::exceptions +::PolicyError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__inherit__graph_org.svg new file mode 100644 index 00000000..eb566e9d --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingKeyReactionError__inherit__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +gridfire::exceptions::MissingKeyReactionError + + +Node1 + + +gridfire::exceptions +::MissingKeyReactionError + + + + + +Node2 + + +gridfire::exceptions +::PolicyError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError-members.html b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError-members.html new file mode 100644 index 00000000..0ecddc7b --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::MissingSeedSpeciesError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::PolicyErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError.html b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError.html new file mode 100644 index 00000000..51ce57ee --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::MissingSeedSpeciesError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::MissingSeedSpeciesError Class Referencefinal
+
+
+ +

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

+ +

#include <error_policy.h>

+
+Inheritance diagram for gridfire::exceptions::MissingSeedSpeciesError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::MissingSeedSpeciesError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

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

+

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

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__coll__graph.map new file mode 100644 index 00000000..f20e6cc0 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__coll__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__coll__graph.md5 new file mode 100644 index 00000000..38a4c0d6 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__coll__graph.md5 @@ -0,0 +1 @@ +9a22abcc3a876d2f73d0508505ab4484 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__coll__graph.svg new file mode 100644 index 00000000..cdd4064f --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__coll__graph.svg @@ -0,0 +1,141 @@ + + + + + + + + + + + +gridfire::exceptions::MissingSeedSpeciesError + + +Node1 + + +gridfire::exceptions +::MissingSeedSpeciesError + + + + + +Node2 + + +gridfire::exceptions +::PolicyError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__coll__graph_org.svg new file mode 100644 index 00000000..a86d350f --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__coll__graph_org.svg @@ -0,0 +1,116 @@ + + + + + + +gridfire::exceptions::MissingSeedSpeciesError + + +Node1 + + +gridfire::exceptions +::MissingSeedSpeciesError + + + + + +Node2 + + +gridfire::exceptions +::PolicyError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__inherit__graph.map new file mode 100644 index 00000000..182e81e2 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__inherit__graph.md5 new file mode 100644 index 00000000..46956944 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__inherit__graph.md5 @@ -0,0 +1 @@ +ea0f65c1fb8ee54f7964e186f1e5ac24 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__inherit__graph.svg new file mode 100644 index 00000000..4f4eee40 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__inherit__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +gridfire::exceptions::MissingSeedSpeciesError + + +Node1 + + +gridfire::exceptions +::MissingSeedSpeciesError + + + + + +Node2 + + +gridfire::exceptions +::PolicyError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__inherit__graph_org.svg new file mode 100644 index 00000000..ddd8d595 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1MissingSeedSpeciesError__inherit__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +gridfire::exceptions::MissingSeedSpeciesError + + +Node1 + + +gridfire::exceptions +::MissingSeedSpeciesError + + + + + +Node2 + + +gridfire::exceptions +::PolicyError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError-members.html b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError-members.html new file mode 100644 index 00000000..59bf4f20 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::NetworkResizedError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::EngineErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError.html b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError.html new file mode 100644 index 00000000..34b78466 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::NetworkResizedError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::NetworkResizedError Class Referencefinal
+
+
+ +

Exception for errors during network resizing. + More...

+ +

#include <error_engine.h>

+
+Inheritance diagram for gridfire::exceptions::NetworkResizedError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::NetworkResizedError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Exception for errors during network resizing.

+

This exception is thrown when the engine encounters an error while attempting to resize the reaction network, such as when adding or removing species or reactions.

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__coll__graph.map new file mode 100644 index 00000000..54076e2d --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__coll__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__coll__graph.md5 new file mode 100644 index 00000000..736a1f68 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__coll__graph.md5 @@ -0,0 +1 @@ +c20ae9dc929830d328870cd360fccd07 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__coll__graph.svg new file mode 100644 index 00000000..474afbda --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__coll__graph.svg @@ -0,0 +1,141 @@ + + + + + + + + + + + +gridfire::exceptions::NetworkResizedError + + +Node1 + + +gridfire::exceptions +::NetworkResizedError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__coll__graph_org.svg new file mode 100644 index 00000000..a2a9fff3 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__coll__graph_org.svg @@ -0,0 +1,116 @@ + + + + + + +gridfire::exceptions::NetworkResizedError + + +Node1 + + +gridfire::exceptions +::NetworkResizedError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__inherit__graph.map new file mode 100644 index 00000000..850de3e4 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__inherit__graph.md5 new file mode 100644 index 00000000..4baa2337 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__inherit__graph.md5 @@ -0,0 +1 @@ +61fd920dcb86d09ca160e11606823fef \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__inherit__graph.svg new file mode 100644 index 00000000..acf3adae --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__inherit__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +gridfire::exceptions::NetworkResizedError + + +Node1 + + +gridfire::exceptions +::NetworkResizedError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__inherit__graph_org.svg new file mode 100644 index 00000000..e9dca396 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1NetworkResizedError__inherit__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +gridfire::exceptions::NetworkResizedError + + +Node1 + + +gridfire::exceptions +::NetworkResizedError + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1PolicyError-members.html b/docs/html/classgridfire_1_1exceptions_1_1PolicyError-members.html new file mode 100644 index 00000000..099cb200 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1PolicyError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::PolicyError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::PolicyErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1PolicyError.html b/docs/html/classgridfire_1_1exceptions_1_1PolicyError.html new file mode 100644 index 00000000..0ee2464b --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1PolicyError.html @@ -0,0 +1,173 @@ + + + + + + + +GridFire: gridfire::exceptions::PolicyError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Private Member Functions | +List of all members
+
gridfire::exceptions::PolicyError Class Reference
+
+
+ +

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

+ +

#include <error_policy.h>

+
+Inheritance diagram for gridfire::exceptions::PolicyError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::PolicyError:
+
+
+
[legend]
+ + + + +

+Private Member Functions

 GridFireError (std::string msg)
 
+ + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Base class for all exceptions related to network policy operations.

+

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

+

Member Function Documentation

+ +

◆ GridFireError()

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::exceptions::GridFireError::GridFireError (std::string msg)
+ 		+inlineexplicitprivate
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1PolicyError.js b/docs/html/classgridfire_1_1exceptions_1_1PolicyError.js new file mode 100644 index 00000000..2220b800 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1PolicyError.js @@ -0,0 +1,4 @@ +var classgridfire_1_1exceptions_1_1PolicyError = +[ + [ "GridFireError", "classgridfire_1_1exceptions_1_1PolicyError.html#a672d340ff9287f5511342a4e5f4fbb23", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1PolicyError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1PolicyError__coll__graph.map new file mode 100644 index 00000000..d7fd9656 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1PolicyError__coll__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1PolicyError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1PolicyError__coll__graph.md5 new file mode 100644 index 00000000..5533bc79 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1PolicyError__coll__graph.md5 @@ -0,0 +1 @@ +e73d262f725ebbf70d492a91ebe755d8 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1PolicyError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1PolicyError__coll__graph.svg new file mode 100644 index 00000000..02e55a0b --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1PolicyError__coll__graph.svg @@ -0,0 +1,122 @@ + + + + + + + + + + + +gridfire::exceptions::PolicyError + + +Node1 + + +gridfire::exceptions +::PolicyError + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::string + + + + + +Node4->Node2 + + + + + + m_msg + + + +Node5 + + +std::basic_string< + Char > + + + + + +Node5->Node4 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1PolicyError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1PolicyError__coll__graph_org.svg new file mode 100644 index 00000000..80f27972 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1PolicyError__coll__graph_org.svg @@ -0,0 +1,97 @@ + + + + + + +gridfire::exceptions::PolicyError + + +Node1 + + +gridfire::exceptions +::PolicyError + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::string + + + + + +Node4->Node2 + + + + + + m_msg + + + +Node5 + + +std::basic_string< + Char > + + + + + +Node5->Node4 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1PolicyError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1PolicyError__inherit__graph.map new file mode 100644 index 00000000..b0c0a553 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1PolicyError__inherit__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1PolicyError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1PolicyError__inherit__graph.md5 new file mode 100644 index 00000000..67de2f09 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1PolicyError__inherit__graph.md5 @@ -0,0 +1 @@ +d5bb3d864e20f3f17171d405dde0e94c \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1PolicyError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1PolicyError__inherit__graph.svg new file mode 100644 index 00000000..7df1cd61 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1PolicyError__inherit__graph.svg @@ -0,0 +1,198 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::exceptions::PolicyError + + +Node1 + + +gridfire::exceptions +::PolicyError + + + + + +Node4 + + +gridfire::exceptions +::MissingBaseReactionError + + + + + +Node1->Node4 + + + + + + + + +Node5 + + +gridfire::exceptions +::MissingKeyReactionError + + + + + +Node1->Node5 + + + + + + + + +Node6 + + +gridfire::exceptions +::MissingSeedSpeciesError + + + + + +Node1->Node6 + + + + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1PolicyError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1PolicyError__inherit__graph_org.svg new file mode 100644 index 00000000..f3c5ec79 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1PolicyError__inherit__graph_org.svg @@ -0,0 +1,116 @@ + + + + + + +gridfire::exceptions::PolicyError + + +Node1 + + +gridfire::exceptions +::PolicyError + + + + + +Node4 + + +gridfire::exceptions +::MissingBaseReactionError + + + + + +Node1->Node4 + + + + + + + + +Node5 + + +gridfire::exceptions +::MissingKeyReactionError + + + + + +Node1->Node5 + + + + + + + + +Node6 + + +gridfire::exceptions +::MissingSeedSpeciesError + + + + + +Node1->Node6 + + + + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionError-members.html b/docs/html/classgridfire_1_1exceptions_1_1ReactionError-members.html new file mode 100644 index 00000000..066bd0ba --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionError-members.html @@ -0,0 +1,116 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::ReactionError Member List
+
+
+ +

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

+ + + + + + + +
GridFireError(std::string msg)gridfire::exceptions::GridFireErrorinlineexplicit
m_messagegridfire::exceptions::ReactionErrorprivate
m_msggridfire::exceptions::GridFireErrorprivate
m_reactionIDgridfire::exceptions::ReactionErrorprivate
ReactionError(const std::string &msg, const std::string &reactionId)gridfire::exceptions::ReactionErrorinline
what() const noexcept overridegridfire::exceptions::ReactionErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionError.html b/docs/html/classgridfire_1_1exceptions_1_1ReactionError.html new file mode 100644 index 00000000..515331d0 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionError.html @@ -0,0 +1,261 @@ + + + + + + + +GridFire: gridfire::exceptions::ReactionError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
gridfire::exceptions::ReactionError Class Reference
+
+
+ +

Base class for all exceptions related to reaction operations. + More...

+ +

#include <error_reaction.h>

+
+Inheritance diagram for gridfire::exceptions::ReactionError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::ReactionError:
+
+
+
[legend]
+ + + + + + + + + + + +

+Public Member Functions

 ReactionError (const std::string &msg, const std::string &reactionId)
 
const char * what () const noexcept override
 
- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+ + + + + +

+Private Attributes

std::string m_message
 
std::string m_reactionID
 
+

Detailed Description

+

Base class for all exceptions related to reaction operations.

+

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

+

Constructor & Destructor Documentation

+ +

◆ ReactionError()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
gridfire::exceptions::ReactionError::ReactionError (const std::string & msg,
const std::string & reactionId 
)
+ 		+inline
+
+ +
+
+

Member Function Documentation

+ +

◆ what()

+ +
+
+ + + + + +
+ + + + + + + +
const char * gridfire::exceptions::ReactionError::what () const
+ 		+inlineoverridenoexcept
+
+ +
+
+

Member Data Documentation

+ +

◆ m_message

+ +
+
+ + + + + +
+ + + + +
std::string gridfire::exceptions::ReactionError::m_message
+ 		+private
+
+ +
+
+ +

◆ m_reactionID

+ +
+
+ + + + + +
+ + + + +
std::string gridfire::exceptions::ReactionError::m_reactionID
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionError.js b/docs/html/classgridfire_1_1exceptions_1_1ReactionError.js new file mode 100644 index 00000000..27ef9de4 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionError.js @@ -0,0 +1,7 @@ +var classgridfire_1_1exceptions_1_1ReactionError = +[ + [ "ReactionError", "classgridfire_1_1exceptions_1_1ReactionError.html#a51a26442fb905643a6d871ab733f0ab5", null ], + [ "what", "classgridfire_1_1exceptions_1_1ReactionError.html#a7bc47cdb02c2f8a803306cb9bb75b1af", null ], + [ "m_message", "classgridfire_1_1exceptions_1_1ReactionError.html#a980c78dbdeac44fd3eec976221799647", null ], + [ "m_reactionID", "classgridfire_1_1exceptions_1_1ReactionError.html#ae3531af904d90838ac856cf72cb555f8", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1ReactionError__coll__graph.map new file mode 100644 index 00000000..44d179c5 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionError__coll__graph.map @@ -0,0 +1,12 @@ + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1ReactionError__coll__graph.md5 new file mode 100644 index 00000000..ccbbfa70 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionError__coll__graph.md5 @@ -0,0 +1 @@ +06e1ae308028ebba3487bfc14595a862 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1ReactionError__coll__graph.svg new file mode 100644 index 00000000..77a616d6 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionError__coll__graph.svg @@ -0,0 +1,133 @@ + + + + + + + + + + + +gridfire::exceptions::ReactionError + + +Node1 + + +gridfire::exceptions +::ReactionError + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::string + + + + + +Node4->Node1 + + + + + + m_message +m_reactionID + + + +Node4->Node2 + + + + + + m_msg + + + +Node5 + + +std::basic_string< + Char > + + + + + +Node5->Node4 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1ReactionError__coll__graph_org.svg new file mode 100644 index 00000000..5ffcd84d --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionError__coll__graph_org.svg @@ -0,0 +1,108 @@ + + + + + + +gridfire::exceptions::ReactionError + + +Node1 + + +gridfire::exceptions +::ReactionError + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::string + + + + + +Node4->Node1 + + + + + + m_message +m_reactionID + + + +Node4->Node2 + + + + + + m_msg + + + +Node5 + + +std::basic_string< + Char > + + + + + +Node5->Node4 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1ReactionError__inherit__graph.map new file mode 100644 index 00000000..58f6582e --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionError__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1ReactionError__inherit__graph.md5 new file mode 100644 index 00000000..66e937c7 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionError__inherit__graph.md5 @@ -0,0 +1 @@ +d852c1e57f37df114fd1d50508e30302 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1ReactionError__inherit__graph.svg new file mode 100644 index 00000000..57f14217 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionError__inherit__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +gridfire::exceptions::ReactionError + + +Node1 + + +gridfire::exceptions +::ReactionError + + + + + +Node4 + + +gridfire::exceptions +::ReactionParsingError + + + + + +Node1->Node4 + + + + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1ReactionError__inherit__graph_org.svg new file mode 100644 index 00000000..486d40da --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionError__inherit__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +gridfire::exceptions::ReactionError + + +Node1 + + +gridfire::exceptions +::ReactionError + + + + + +Node4 + + +gridfire::exceptions +::ReactionParsingError + + + + + +Node1->Node4 + + + + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError-members.html b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError-members.html new file mode 100644 index 00000000..aa48b7c4 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError-members.html @@ -0,0 +1,116 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::ReactionParsingError Member List
+
+
+ +

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

+ + + + + + + +
GridFireError(std::string msg)gridfire::exceptions::GridFireErrorinlineexplicit
m_messagegridfire::exceptions::ReactionErrorprivate
m_msggridfire::exceptions::GridFireErrorprivate
m_reactionIDgridfire::exceptions::ReactionErrorprivate
ReactionError(const std::string &msg, const std::string &reactionId)gridfire::exceptions::ReactionParsingErrorinlineprivate
what() const noexcept overridegridfire::exceptions::ReactionErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError.html b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError.html new file mode 100644 index 00000000..512f2e2c --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError.html @@ -0,0 +1,182 @@ + + + + + + + +GridFire: gridfire::exceptions::ReactionParsingError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Private Member Functions | +List of all members
+
gridfire::exceptions::ReactionParsingError Class Referencefinal
+
+
+ +

#include <error_reaction.h>

+
+Inheritance diagram for gridfire::exceptions::ReactionParsingError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::ReactionParsingError:
+
+
+
[legend]
+ + + + +

+Private Member Functions

 ReactionError (const std::string &msg, const std::string &reactionId)
 
+ + + + + + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::ReactionError
 ReactionError (const std::string &msg, const std::string &reactionId)
 
const char * what () const noexcept override
 
- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Member Function Documentation

+ +

◆ ReactionError()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
gridfire::exceptions::ReactionError::ReactionError (const std::string & msg,
const std::string & reactionId 
)
+ 		+inlineprivate
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError.js b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError.js new file mode 100644 index 00000000..e963e684 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError.js @@ -0,0 +1,4 @@ +var classgridfire_1_1exceptions_1_1ReactionParsingError = +[ + [ "ReactionError", "classgridfire_1_1exceptions_1_1ReactionParsingError.html#a51a26442fb905643a6d871ab733f0ab5", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__coll__graph.map new file mode 100644 index 00000000..ec67b8ff --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__coll__graph.map @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__coll__graph.md5 new file mode 100644 index 00000000..83243630 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__coll__graph.md5 @@ -0,0 +1 @@ +a6f141ba9a69e9e9dc51073d864e59b0 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__coll__graph.svg new file mode 100644 index 00000000..5c5da267 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__coll__graph.svg @@ -0,0 +1,152 @@ + + + + + + + + + + + +gridfire::exceptions::ReactionParsingError + + +Node1 + + +gridfire::exceptions +::ReactionParsingError + + + + + +Node2 + + +gridfire::exceptions +::ReactionError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node2 + + + + + + m_message +m_reactionID + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__coll__graph_org.svg new file mode 100644 index 00000000..bfc101e3 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__coll__graph_org.svg @@ -0,0 +1,127 @@ + + + + + + +gridfire::exceptions::ReactionParsingError + + +Node1 + + +gridfire::exceptions +::ReactionParsingError + + + + + +Node2 + + +gridfire::exceptions +::ReactionError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node2 + + + + + + m_message +m_reactionID + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__inherit__graph.map new file mode 100644 index 00000000..543d54f2 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__inherit__graph.md5 new file mode 100644 index 00000000..c94197a7 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__inherit__graph.md5 @@ -0,0 +1 @@ +96d43370cd1146b07a74d937a7cc8cad \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__inherit__graph.svg new file mode 100644 index 00000000..ccd83779 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__inherit__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +gridfire::exceptions::ReactionParsingError + + +Node1 + + +gridfire::exceptions +::ReactionParsingError + + + + + +Node2 + + +gridfire::exceptions +::ReactionError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__inherit__graph_org.svg new file mode 100644 index 00000000..c3ccaa6b --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1ReactionParsingError__inherit__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +gridfire::exceptions::ReactionParsingError + + +Node1 + + +gridfire::exceptions +::ReactionParsingError + + + + + +Node2 + + +gridfire::exceptions +::ReactionError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError-members.html b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError-members.html new file mode 100644 index 00000000..e30a09ea --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::SUNDIALSError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::SolverErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError.html b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError.html new file mode 100644 index 00000000..f51c84b4 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::SUNDIALSError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::SUNDIALSError Class Reference
+
+
+ +

Base class for exceptions related to SUNDIALS solver operations. + More...

+ +

#include <error_solver.h>

+
+Inheritance diagram for gridfire::exceptions::SUNDIALSError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::SUNDIALSError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Base class for exceptions related to SUNDIALS solver operations.

+

This class serves as the base for all exceptions specific to SUNDIALS solver errors in the GridFire library.

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__coll__graph.map new file mode 100644 index 00000000..31f84c43 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__coll__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__coll__graph.md5 new file mode 100644 index 00000000..21d7d2ef --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__coll__graph.md5 @@ -0,0 +1 @@ +54e1db8f7a17ee43492dafb8bc8a1a62 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__coll__graph.svg new file mode 100644 index 00000000..b009da5f --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__coll__graph.svg @@ -0,0 +1,141 @@ + + + + + + + + + + + +gridfire::exceptions::SUNDIALSError + + +Node1 + + +gridfire::exceptions +::SUNDIALSError + + + + + +Node2 + + +gridfire::exceptions +::SolverError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__coll__graph_org.svg new file mode 100644 index 00000000..19b13295 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__coll__graph_org.svg @@ -0,0 +1,116 @@ + + + + + + +gridfire::exceptions::SUNDIALSError + + +Node1 + + +gridfire::exceptions +::SUNDIALSError + + + + + +Node2 + + +gridfire::exceptions +::SolverError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__inherit__graph.map new file mode 100644 index 00000000..de001c44 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__inherit__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__inherit__graph.md5 new file mode 100644 index 00000000..663df2f8 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__inherit__graph.md5 @@ -0,0 +1 @@ +b37b4246258b4eb7cb237508d3edaeb0 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__inherit__graph.svg new file mode 100644 index 00000000..1567df24 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__inherit__graph.svg @@ -0,0 +1,198 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::exceptions::SUNDIALSError + + +Node1 + + +gridfire::exceptions +::SUNDIALSError + + + + + +Node5 + + +gridfire::exceptions +::CVODESolverFailureError + + + + + +Node1->Node5 + + + + + + + + +Node6 + + +gridfire::exceptions +::KINSolSolverFailureError + + + + + +Node1->Node6 + + + + + + + + +Node2 + + +gridfire::exceptions +::SolverError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__inherit__graph_org.svg new file mode 100644 index 00000000..af87fecf --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SUNDIALSError__inherit__graph_org.svg @@ -0,0 +1,116 @@ + + + + + + +gridfire::exceptions::SUNDIALSError + + +Node1 + + +gridfire::exceptions +::SUNDIALSError + + + + + +Node5 + + +gridfire::exceptions +::CVODESolverFailureError + + + + + +Node1->Node5 + + + + + + + + +Node6 + + +gridfire::exceptions +::KINSolSolverFailureError + + + + + +Node1->Node6 + + + + + + + + +Node2 + + +gridfire::exceptions +::SolverError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError-members.html b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError-members.html new file mode 100644 index 00000000..85cb1c36 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::SingularJacobianError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::SolverErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError.html b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError.html new file mode 100644 index 00000000..a14e3bd1 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::SingularJacobianError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::SingularJacobianError Class Referencefinal
+
+
+ +

Exception thrown when the Jacobian matrix is singular. + More...

+ +

#include <error_solver.h>

+
+Inheritance diagram for gridfire::exceptions::SingularJacobianError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::SingularJacobianError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Exception thrown when the Jacobian matrix is singular.

+

This exception is thrown when the solver encounters a singular Jacobian matrix, which prevents it from proceeding with the solution of the system.

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__coll__graph.map new file mode 100644 index 00000000..4f4d3f44 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__coll__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__coll__graph.md5 new file mode 100644 index 00000000..858393f0 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__coll__graph.md5 @@ -0,0 +1 @@ +9d68d779a2096aa8c65dea60daa3a8a5 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__coll__graph.svg new file mode 100644 index 00000000..2e4e6b77 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__coll__graph.svg @@ -0,0 +1,141 @@ + + + + + + + + + + + +gridfire::exceptions::SingularJacobianError + + +Node1 + + +gridfire::exceptions +::SingularJacobianError + + + + + +Node2 + + +gridfire::exceptions +::SolverError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__coll__graph_org.svg new file mode 100644 index 00000000..e593cd47 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__coll__graph_org.svg @@ -0,0 +1,116 @@ + + + + + + +gridfire::exceptions::SingularJacobianError + + +Node1 + + +gridfire::exceptions +::SingularJacobianError + + + + + +Node2 + + +gridfire::exceptions +::SolverError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__inherit__graph.map new file mode 100644 index 00000000..94bf9236 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__inherit__graph.md5 new file mode 100644 index 00000000..f779eedb --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__inherit__graph.md5 @@ -0,0 +1 @@ +5a1567a991a93c5bb0e1f05b8e306eee \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__inherit__graph.svg new file mode 100644 index 00000000..3f8f8df6 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__inherit__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +gridfire::exceptions::SingularJacobianError + + +Node1 + + +gridfire::exceptions +::SingularJacobianError + + + + + +Node2 + + +gridfire::exceptions +::SolverError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__inherit__graph_org.svg new file mode 100644 index 00000000..e3428506 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SingularJacobianError__inherit__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +gridfire::exceptions::SingularJacobianError + + +Node1 + + +gridfire::exceptions +::SingularJacobianError + + + + + +Node2 + + +gridfire::exceptions +::SolverError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SolverError-members.html b/docs/html/classgridfire_1_1exceptions_1_1SolverError-members.html new file mode 100644 index 00000000..fe22a628 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SolverError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::SolverError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::SolverErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SolverError.html b/docs/html/classgridfire_1_1exceptions_1_1SolverError.html new file mode 100644 index 00000000..6278caa5 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SolverError.html @@ -0,0 +1,173 @@ + + + + + + + +GridFire: gridfire::exceptions::SolverError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Private Member Functions | +List of all members
+
gridfire::exceptions::SolverError Class Reference
+
+
+ +

Base class for all exceptions related to solver operations. + More...

+ +

#include <error_solver.h>

+
+Inheritance diagram for gridfire::exceptions::SolverError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::SolverError:
+
+
+
[legend]
+ + + + +

+Private Member Functions

 GridFireError (std::string msg)
 
+ + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Base class for all exceptions related to solver operations.

+

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

+

Member Function Documentation

+ +

◆ GridFireError()

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::exceptions::GridFireError::GridFireError (std::string msg)
+ 		+inlineexplicitprivate
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SolverError.js b/docs/html/classgridfire_1_1exceptions_1_1SolverError.js new file mode 100644 index 00000000..ebc2af20 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SolverError.js @@ -0,0 +1,4 @@ +var classgridfire_1_1exceptions_1_1SolverError = +[ + [ "GridFireError", "classgridfire_1_1exceptions_1_1SolverError.html#a672d340ff9287f5511342a4e5f4fbb23", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1SolverError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1SolverError__coll__graph.map new file mode 100644 index 00000000..fba76538 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SolverError__coll__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SolverError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1SolverError__coll__graph.md5 new file mode 100644 index 00000000..ee551821 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SolverError__coll__graph.md5 @@ -0,0 +1 @@ +ebc67995c543d62c82b8069389371230 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1SolverError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1SolverError__coll__graph.svg new file mode 100644 index 00000000..6f35c432 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SolverError__coll__graph.svg @@ -0,0 +1,122 @@ + + + + + + + + + + + +gridfire::exceptions::SolverError + + +Node1 + + +gridfire::exceptions +::SolverError + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::string + + + + + +Node4->Node2 + + + + + + m_msg + + + +Node5 + + +std::basic_string< + Char > + + + + + +Node5->Node4 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SolverError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1SolverError__coll__graph_org.svg new file mode 100644 index 00000000..15416620 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SolverError__coll__graph_org.svg @@ -0,0 +1,97 @@ + + + + + + +gridfire::exceptions::SolverError + + +Node1 + + +gridfire::exceptions +::SolverError + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::string + + + + + +Node4->Node2 + + + + + + m_msg + + + +Node5 + + +std::basic_string< + Char > + + + + + +Node5->Node4 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SolverError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1SolverError__inherit__graph.map new file mode 100644 index 00000000..ac74efc9 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SolverError__inherit__graph.map @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SolverError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1SolverError__inherit__graph.md5 new file mode 100644 index 00000000..15f26cab --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SolverError__inherit__graph.md5 @@ -0,0 +1 @@ +e9d7b07c7577d3f188ddbfc7868ec397 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1SolverError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1SolverError__inherit__graph.svg new file mode 100644 index 00000000..1370062a --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SolverError__inherit__graph.svg @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::exceptions::SolverError + + +Node1 + + +gridfire::exceptions +::SolverError + + + + + +Node4 + + +gridfire::exceptions +::IllConditionedJacobianError + + + + + +Node1->Node4 + + + + + + + + +Node5 + + +gridfire::exceptions +::SUNDIALSError + + + + + +Node1->Node5 + + + + + + + + +Node8 + + +gridfire::exceptions +::SingularJacobianError + + + + + +Node1->Node8 + + + + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + +Node6 + + +gridfire::exceptions +::CVODESolverFailureError + + + + + +Node5->Node6 + + + + + + + + +Node7 + + +gridfire::exceptions +::KINSolSolverFailureError + + + + + +Node5->Node7 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1SolverError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1SolverError__inherit__graph_org.svg new file mode 100644 index 00000000..b9b8fe1c --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1SolverError__inherit__graph_org.svg @@ -0,0 +1,154 @@ + + + + + + +gridfire::exceptions::SolverError + + +Node1 + + +gridfire::exceptions +::SolverError + + + + + +Node4 + + +gridfire::exceptions +::IllConditionedJacobianError + + + + + +Node1->Node4 + + + + + + + + +Node5 + + +gridfire::exceptions +::SUNDIALSError + + + + + +Node1->Node5 + + + + + + + + +Node8 + + +gridfire::exceptions +::SingularJacobianError + + + + + +Node1->Node8 + + + + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + +Node6 + + +gridfire::exceptions +::CVODESolverFailureError + + + + + +Node5->Node6 + + + + + + + + +Node7 + + +gridfire::exceptions +::KINSolSolverFailureError + + + + + +Node5->Node7 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError-members.html b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError-members.html new file mode 100644 index 00000000..41b4ca26 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::StaleJacobianError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::EngineErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError.html b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError.html new file mode 100644 index 00000000..fa1f39a1 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::StaleJacobianError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::StaleJacobianError Class Referencefinal
+
+
+ +

Exception for stale Jacobian matrix access. + More...

+ +

#include <error_engine.h>

+
+Inheritance diagram for gridfire::exceptions::StaleJacobianError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::StaleJacobianError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Exception for stale Jacobian matrix access.

+

This exception is thrown when an attempt is made to access a Jacobian matrix that is stale and needs to be regenerated.

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__coll__graph.map new file mode 100644 index 00000000..c877a109 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__coll__graph.map @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__coll__graph.md5 new file mode 100644 index 00000000..bc29da8b --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__coll__graph.md5 @@ -0,0 +1 @@ +9b9bc1ccacd1cb94677a96bf27c87a71 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__coll__graph.svg new file mode 100644 index 00000000..db9a9a01 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__coll__graph.svg @@ -0,0 +1,160 @@ + + + + + + + + + + + +gridfire::exceptions::StaleJacobianError + + +Node1 + + +gridfire::exceptions +::StaleJacobianError + + + + + +Node2 + + +gridfire::exceptions +::JacobianError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::EngineError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +std::string + + + + + +Node6->Node4 + + + + + + m_msg + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__coll__graph_org.svg new file mode 100644 index 00000000..fa20710f --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__coll__graph_org.svg @@ -0,0 +1,135 @@ + + + + + + +gridfire::exceptions::StaleJacobianError + + +Node1 + + +gridfire::exceptions +::StaleJacobianError + + + + + +Node2 + + +gridfire::exceptions +::JacobianError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::EngineError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +std::string + + + + + +Node6->Node4 + + + + + + m_msg + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__inherit__graph.map new file mode 100644 index 00000000..298ab956 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__inherit__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__inherit__graph.md5 new file mode 100644 index 00000000..8a9ac983 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__inherit__graph.md5 @@ -0,0 +1 @@ +0cdb3014093725a7b1aa2a9b2d0e1170 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__inherit__graph.svg new file mode 100644 index 00000000..b2b9f32f --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__inherit__graph.svg @@ -0,0 +1,122 @@ + + + + + + + + + + + +gridfire::exceptions::StaleJacobianError + + +Node1 + + +gridfire::exceptions +::StaleJacobianError + + + + + +Node2 + + +gridfire::exceptions +::JacobianError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::EngineError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__inherit__graph_org.svg new file mode 100644 index 00000000..30d8a338 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1StaleJacobianError__inherit__graph_org.svg @@ -0,0 +1,97 @@ + + + + + + +gridfire::exceptions::StaleJacobianError + + +Node1 + + +gridfire::exceptions +::StaleJacobianError + + + + + +Node2 + + +gridfire::exceptions +::JacobianError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::EngineError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError-members.html b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError-members.html new file mode 100644 index 00000000..d54e4d18 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::UnableToSetNetworkReactionsError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::EngineErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError.html b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError.html new file mode 100644 index 00000000..a920b247 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::UnableToSetNetworkReactionsError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::UnableToSetNetworkReactionsError Class Referencefinal
+
+
+ +

Exception for failures in setting network reactions. + More...

+ +

#include <error_engine.h>

+
+Inheritance diagram for gridfire::exceptions::UnableToSetNetworkReactionsError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::UnableToSetNetworkReactionsError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Exception for failures in setting network reactions.

+

This exception is thrown when the engine fails to properly set or initialize the reactions in the reaction network.

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__coll__graph.map new file mode 100644 index 00000000..3b042cd4 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__coll__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__coll__graph.md5 new file mode 100644 index 00000000..639e3663 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__coll__graph.md5 @@ -0,0 +1 @@ +7c616f45b6e20e962b8f5cab5f051ae2 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__coll__graph.svg new file mode 100644 index 00000000..b189e88c --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__coll__graph.svg @@ -0,0 +1,142 @@ + + + + + + + + + + + +gridfire::exceptions::UnableToSetNetworkReactionsError + + +Node1 + + +gridfire::exceptions +::UnableToSetNetworkReactions +Error + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__coll__graph_org.svg new file mode 100644 index 00000000..7d3d5a6d --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__coll__graph_org.svg @@ -0,0 +1,117 @@ + + + + + + +gridfire::exceptions::UnableToSetNetworkReactionsError + + +Node1 + + +gridfire::exceptions +::UnableToSetNetworkReactions +Error + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::string + + + + + +Node5->Node3 + + + + + + m_msg + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__inherit__graph.map new file mode 100644 index 00000000..2facecea --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__inherit__graph.md5 new file mode 100644 index 00000000..72eb6037 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__inherit__graph.md5 @@ -0,0 +1 @@ +15292e6a72b980c786d624266be66815 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__inherit__graph.svg new file mode 100644 index 00000000..2a52912b --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__inherit__graph.svg @@ -0,0 +1,104 @@ + + + + + + + + + + + +gridfire::exceptions::UnableToSetNetworkReactionsError + + +Node1 + + +gridfire::exceptions +::UnableToSetNetworkReactions +Error + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__inherit__graph_org.svg new file mode 100644 index 00000000..22091312 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnableToSetNetworkReactionsError__inherit__graph_org.svg @@ -0,0 +1,79 @@ + + + + + + +gridfire::exceptions::UnableToSetNetworkReactionsError + + +Node1 + + +gridfire::exceptions +::UnableToSetNetworkReactions +Error + + + + + +Node2 + + +gridfire::exceptions +::EngineError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::GridFireError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::exception + + + + + +Node4->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError-members.html b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError-members.html new file mode 100644 index 00000000..8542c20a --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::UninitializedJacobianError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::EngineErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError.html b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError.html new file mode 100644 index 00000000..eddcf6cd --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::UninitializedJacobianError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::UninitializedJacobianError Class Referencefinal
+
+
+ +

Exception for uninitialized Jacobian matrix access. + More...

+ +

#include <error_engine.h>

+
+Inheritance diagram for gridfire::exceptions::UninitializedJacobianError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::UninitializedJacobianError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Exception for uninitialized Jacobian matrix access.

+

This exception is thrown when an attempt is made to access a Jacobian matrix that has not been initialized.

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__coll__graph.map new file mode 100644 index 00000000..82a14275 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__coll__graph.map @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__coll__graph.md5 new file mode 100644 index 00000000..dc135f77 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__coll__graph.md5 @@ -0,0 +1 @@ +d6c832c6cdc36077052e14567fee6495 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__coll__graph.svg new file mode 100644 index 00000000..74b28ebd --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__coll__graph.svg @@ -0,0 +1,160 @@ + + + + + + + + + + + +gridfire::exceptions::UninitializedJacobianError + + +Node1 + + +gridfire::exceptions +::UninitializedJacobianError + + + + + +Node2 + + +gridfire::exceptions +::JacobianError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::EngineError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +std::string + + + + + +Node6->Node4 + + + + + + m_msg + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__coll__graph_org.svg new file mode 100644 index 00000000..fcb34dbf --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__coll__graph_org.svg @@ -0,0 +1,135 @@ + + + + + + +gridfire::exceptions::UninitializedJacobianError + + +Node1 + + +gridfire::exceptions +::UninitializedJacobianError + + + + + +Node2 + + +gridfire::exceptions +::JacobianError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::EngineError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +std::string + + + + + +Node6->Node4 + + + + + + m_msg + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__inherit__graph.map new file mode 100644 index 00000000..0ae59cae --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__inherit__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__inherit__graph.md5 new file mode 100644 index 00000000..1d855ccd --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__inherit__graph.md5 @@ -0,0 +1 @@ +8f799b085681f6398dfdbb0aba8cbeaa \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__inherit__graph.svg new file mode 100644 index 00000000..fd0e0b46 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__inherit__graph.svg @@ -0,0 +1,122 @@ + + + + + + + + + + + +gridfire::exceptions::UninitializedJacobianError + + +Node1 + + +gridfire::exceptions +::UninitializedJacobianError + + + + + +Node2 + + +gridfire::exceptions +::JacobianError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::EngineError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__inherit__graph_org.svg new file mode 100644 index 00000000..560ce8fe --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UninitializedJacobianError__inherit__graph_org.svg @@ -0,0 +1,97 @@ + + + + + + +gridfire::exceptions::UninitializedJacobianError + + +Node1 + + +gridfire::exceptions +::UninitializedJacobianError + + + + + +Node2 + + +gridfire::exceptions +::JacobianError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::EngineError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError-members.html b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError-members.html new file mode 100644 index 00000000..78dfb04a --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::UnknownJacobianError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::EngineErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError.html b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError.html new file mode 100644 index 00000000..7eb3efe1 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError.html @@ -0,0 +1,140 @@ + + + + + + + +GridFire: gridfire::exceptions::UnknownJacobianError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::exceptions::UnknownJacobianError Class Referencefinal
+
+
+ +

Exception for unknown Jacobian matrix access. + More...

+ +

#include <error_engine.h>

+
+Inheritance diagram for gridfire::exceptions::UnknownJacobianError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::UnknownJacobianError:
+
+
+
[legend]
+ + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Exception for unknown Jacobian matrix access.

+

This exception is thrown when an attempt is made to access a Jacobian matrix that is unknown or not recognized by the engine.

+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__coll__graph.map new file mode 100644 index 00000000..285a306b --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__coll__graph.map @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__coll__graph.md5 new file mode 100644 index 00000000..5de652f0 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__coll__graph.md5 @@ -0,0 +1 @@ +e6b27fb34ad961275ce8ee4c8e993343 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__coll__graph.svg new file mode 100644 index 00000000..df2bc211 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__coll__graph.svg @@ -0,0 +1,160 @@ + + + + + + + + + + + +gridfire::exceptions::UnknownJacobianError + + +Node1 + + +gridfire::exceptions +::UnknownJacobianError + + + + + +Node2 + + +gridfire::exceptions +::JacobianError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::EngineError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +std::string + + + + + +Node6->Node4 + + + + + + m_msg + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__coll__graph_org.svg new file mode 100644 index 00000000..a4d802c1 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__coll__graph_org.svg @@ -0,0 +1,135 @@ + + + + + + +gridfire::exceptions::UnknownJacobianError + + +Node1 + + +gridfire::exceptions +::UnknownJacobianError + + + + + +Node2 + + +gridfire::exceptions +::JacobianError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::EngineError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +std::string + + + + + +Node6->Node4 + + + + + + m_msg + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__inherit__graph.map new file mode 100644 index 00000000..eef71d1a --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__inherit__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__inherit__graph.md5 new file mode 100644 index 00000000..7b1e257a --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__inherit__graph.md5 @@ -0,0 +1 @@ +0394a057b9bc6de89a0d4d70f7e596e4 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__inherit__graph.svg new file mode 100644 index 00000000..5490c539 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__inherit__graph.svg @@ -0,0 +1,122 @@ + + + + + + + + + + + +gridfire::exceptions::UnknownJacobianError + + +Node1 + + +gridfire::exceptions +::UnknownJacobianError + + + + + +Node2 + + +gridfire::exceptions +::JacobianError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::EngineError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__inherit__graph_org.svg new file mode 100644 index 00000000..a5fbe555 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UnknownJacobianError__inherit__graph_org.svg @@ -0,0 +1,97 @@ + + + + + + +gridfire::exceptions::UnknownJacobianError + + +Node1 + + +gridfire::exceptions +::UnknownJacobianError + + + + + +Node2 + + +gridfire::exceptions +::JacobianError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::exceptions +::EngineError + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::exceptions +::GridFireError + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::exception + + + + + +Node5->Node4 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UtilityError-members.html b/docs/html/classgridfire_1_1exceptions_1_1UtilityError-members.html new file mode 100644 index 00000000..fdab5c5a --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UtilityError-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::exceptions::UtilityError Member List
+
+
+ +

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

+ + + + +
GridFireError(std::string msg)gridfire::exceptions::UtilityErrorinlineexplicitprivate
m_msggridfire::exceptions::GridFireErrorprivate
what() const noexcept overridegridfire::exceptions::GridFireErrorinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UtilityError.html b/docs/html/classgridfire_1_1exceptions_1_1UtilityError.html new file mode 100644 index 00000000..c14a2ec0 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UtilityError.html @@ -0,0 +1,173 @@ + + + + + + + +GridFire: gridfire::exceptions::UtilityError Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Private Member Functions | +List of all members
+
gridfire::exceptions::UtilityError Class Reference
+
+
+ +

Base class for utility-related errors in GridFire. + More...

+ +

#include <error_utils.h>

+
+Inheritance diagram for gridfire::exceptions::UtilityError:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::exceptions::UtilityError:
+
+
+
[legend]
+ + + + +

+Private Member Functions

 GridFireError (std::string msg)
 
+ + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::exceptions::GridFireError
 GridFireError (std::string msg)
 
const char * what () const noexcept override
 
+

Detailed Description

+

Base class for utility-related errors in GridFire.

+

This class serves as a base for all exceptions related to utility functions

+

Member Function Documentation

+ +

◆ GridFireError()

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::exceptions::GridFireError::GridFireError (std::string msg)
+ 		+inlineexplicitprivate
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UtilityError.js b/docs/html/classgridfire_1_1exceptions_1_1UtilityError.js new file mode 100644 index 00000000..724da211 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UtilityError.js @@ -0,0 +1,4 @@ +var classgridfire_1_1exceptions_1_1UtilityError = +[ + [ "GridFireError", "classgridfire_1_1exceptions_1_1UtilityError.html#a672d340ff9287f5511342a4e5f4fbb23", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1UtilityError__coll__graph.map b/docs/html/classgridfire_1_1exceptions_1_1UtilityError__coll__graph.map new file mode 100644 index 00000000..801b9819 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UtilityError__coll__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UtilityError__coll__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1UtilityError__coll__graph.md5 new file mode 100644 index 00000000..4ee46b40 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UtilityError__coll__graph.md5 @@ -0,0 +1 @@ +23f4d82d1cd5ec139b0026dd91d3642d \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1UtilityError__coll__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1UtilityError__coll__graph.svg new file mode 100644 index 00000000..c806556a --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UtilityError__coll__graph.svg @@ -0,0 +1,122 @@ + + + + + + + + + + + +gridfire::exceptions::UtilityError + + +Node1 + + +gridfire::exceptions +::UtilityError + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::string + + + + + +Node4->Node2 + + + + + + m_msg + + + +Node5 + + +std::basic_string< + Char > + + + + + +Node5->Node4 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UtilityError__coll__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1UtilityError__coll__graph_org.svg new file mode 100644 index 00000000..5b8074fa --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UtilityError__coll__graph_org.svg @@ -0,0 +1,97 @@ + + + + + + +gridfire::exceptions::UtilityError + + +Node1 + + +gridfire::exceptions +::UtilityError + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::string + + + + + +Node4->Node2 + + + + + + m_msg + + + +Node5 + + +std::basic_string< + Char > + + + + + +Node5->Node4 + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UtilityError__inherit__graph.map b/docs/html/classgridfire_1_1exceptions_1_1UtilityError__inherit__graph.map new file mode 100644 index 00000000..555b1cbc --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UtilityError__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UtilityError__inherit__graph.md5 b/docs/html/classgridfire_1_1exceptions_1_1UtilityError__inherit__graph.md5 new file mode 100644 index 00000000..ab25c605 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UtilityError__inherit__graph.md5 @@ -0,0 +1 @@ +dfe047616c9deed14911218166236bb9 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1exceptions_1_1UtilityError__inherit__graph.svg b/docs/html/classgridfire_1_1exceptions_1_1UtilityError__inherit__graph.svg new file mode 100644 index 00000000..e7953c48 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UtilityError__inherit__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +gridfire::exceptions::UtilityError + + +Node1 + + +gridfire::exceptions +::UtilityError + + + + + +Node4 + + +gridfire::exceptions +::HashingError + + + + + +Node1->Node4 + + + + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1exceptions_1_1UtilityError__inherit__graph_org.svg b/docs/html/classgridfire_1_1exceptions_1_1UtilityError__inherit__graph_org.svg new file mode 100644 index 00000000..c59ff784 --- /dev/null +++ b/docs/html/classgridfire_1_1exceptions_1_1UtilityError__inherit__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +gridfire::exceptions::UtilityError + + +Node1 + + +gridfire::exceptions +::UtilityError + + + + + +Node4 + + +gridfire::exceptions +::HashingError + + + + + +Node1->Node4 + + + + + + + + +Node2 + + +gridfire::exceptions +::GridFireError + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::exception + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser-members.html b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser-members.html new file mode 100644 index 00000000..b1d237ff --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser-members.html @@ -0,0 +1,118 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::io::MESANetworkFileParser Member List
+
+
+ +

This is the complete list of members for gridfire::io::MESANetworkFileParser, including all inherited members.

+ + + + + + + + + +
Config typedefgridfire::io::MESANetworkFileParserprivate
LogManager typedefgridfire::io::MESANetworkFileParserprivate
m_configgridfire::io::MESANetworkFileParserprivate
m_filenamegridfire::io::MESANetworkFileParserprivate
m_loggergridfire::io::MESANetworkFileParserprivate
MESANetworkFileParser(const std::string &filename)gridfire::io::MESANetworkFileParserexplicit
parse(const std::string &filename) const overridegridfire::io::MESANetworkFileParservirtual
~NetworkFileParser()=defaultgridfire::io::NetworkFileParservirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser.html b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser.html new file mode 100644 index 00000000..6ccebe10 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser.html @@ -0,0 +1,357 @@ + + + + + + + +GridFire: gridfire::io::MESANetworkFileParser Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Types | +Private Attributes | +List of all members
+
gridfire::io::MESANetworkFileParser Class Referencefinal
+
+
+ +

A parser for MESA-format network files. + More...

+ +

#include <network_file.h>

+
+Inheritance diagram for gridfire::io::MESANetworkFileParser:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::io::MESANetworkFileParser:
+
+
+
[legend]
+ + + + + + + + + + + + +

+Public Member Functions

 MESANetworkFileParser (const std::string &filename)
 Constructs a MESANetworkFileParser.
 
ParsedNetworkData parse (const std::string &filename) const override
 Parses a MESA-format network file.
 
- Public Member Functions inherited from gridfire::io::NetworkFileParser
virtual ~NetworkFileParser ()=default
 Virtual destructor for the base class.
 
+ + + + + +

+Private Types

using Config = fourdst::config::Config
 
using LogManager = fourdst::logging::LogManager
 
+ + + + + + + +

+Private Attributes

Config & m_config = Config::getInstance()
 
quill::Logger * m_logger = LogManager::getInstance().getLogger("log")
 
std::string m_filename
 
+

Detailed Description

+

A parser for MESA-format network files.

+

This class is designed to parse reaction network files that follow the format used by the MESA stellar evolution code.

+

Member Typedef Documentation

+ +

◆ Config

+ +
+
+ + + + + +
+ + + + +
using gridfire::io::MESANetworkFileParser::Config = fourdst::config::Config
+ 		+private
+
+ +
+
+ +

◆ LogManager

+ +
+
+ + + + + +
+ + + + +
using gridfire::io::MESANetworkFileParser::LogManager = fourdst::logging::LogManager
+ 		+private
+
+ +
+
+

Constructor & Destructor Documentation

+ +

◆ MESANetworkFileParser()

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::io::MESANetworkFileParser::MESANetworkFileParser (const std::string & filename)
+ 		+explicit
+
+ +

Constructs a MESANetworkFileParser.

+
Parameters
+ + +
filenameThe path to the MESA network file. This may be used to pre-configure the parser.
+
+
+
Postcondition
The parser is initialized with the context of the given file.
+ +
+
+

Member Function Documentation

+ +

◆ parse()

+ +
+
+ + + + + +
+ + + + + + + + +
ParsedNetworkData gridfire::io::MESANetworkFileParser::parse (const std::string & filename) const
+ 		+overridevirtual
+
+ +

Parses a MESA-format network file.

+

This method will read and interpret the structure of a MESA network file to extract the list of reactions.

+
Parameters
+ + +
filenameThe path to the MESA network file.
+
+
+
Returns
A ParsedNetworkData struct containing the list of reaction names.
+
Exceptions
+ + +
std::runtime_errorIf the file cannot be opened or if it contains formatting errors.
+
+
+ +

Implements gridfire::io::NetworkFileParser.

+ +
+
+

Member Data Documentation

+ +

◆ m_config

+ +
+
+ + + + + +
+ + + + +
Config& gridfire::io::MESANetworkFileParser::m_config = Config::getInstance()
+ 		+private
+
+ +
+
+ +

◆ m_filename

+ +
+
+ + + + + +
+ + + + +
std::string gridfire::io::MESANetworkFileParser::m_filename
+ 		+private
+
+ +
+
+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::io::MESANetworkFileParser::m_logger = LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser.js b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser.js new file mode 100644 index 00000000..b39d1805 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser.js @@ -0,0 +1,10 @@ +var classgridfire_1_1io_1_1MESANetworkFileParser = +[ + [ "Config", "classgridfire_1_1io_1_1MESANetworkFileParser.html#af43ad8375abf1cedfdccc296b9958c2b", null ], + [ "LogManager", "classgridfire_1_1io_1_1MESANetworkFileParser.html#a84aa6894a331ad57bdab1e1ab85d4055", null ], + [ "MESANetworkFileParser", "classgridfire_1_1io_1_1MESANetworkFileParser.html#ac5963d0da6780de753df996b490f8d2c", null ], + [ "parse", "classgridfire_1_1io_1_1MESANetworkFileParser.html#a568194277733b5c537901f8af32ee329", null ], + [ "m_config", "classgridfire_1_1io_1_1MESANetworkFileParser.html#aea206c3a7600db8d657666fef88fa20d", null ], + [ "m_filename", "classgridfire_1_1io_1_1MESANetworkFileParser.html#ab7f82597abf17f16c401bcdf528bd099", null ], + [ "m_logger", "classgridfire_1_1io_1_1MESANetworkFileParser.html#ab9c683289d48e58edf06bf59215b4937", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__coll__graph.map b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__coll__graph.map new file mode 100644 index 00000000..0230a58d --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__coll__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__coll__graph.md5 b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__coll__graph.md5 new file mode 100644 index 00000000..9faa8655 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__coll__graph.md5 @@ -0,0 +1 @@ +0b55d84143ec0d16f4d27f51e341150e \ No newline at end of file diff --git a/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__coll__graph.svg b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__coll__graph.svg new file mode 100644 index 00000000..c5b157b1 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__coll__graph.svg @@ -0,0 +1,104 @@ + + + + + + + + + + + +gridfire::io::MESANetworkFileParser + + +Node1 + + +gridfire::io::MESANetwork +FileParser + + + + + +Node2 + + +gridfire::io::NetworkFile +Parser + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::string + + + + + +Node3->Node1 + + + + + + m_filename + + + +Node4 + + +std::basic_string< + Char > + + + + + +Node4->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__coll__graph_org.svg b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__coll__graph_org.svg new file mode 100644 index 00000000..926434cd --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__coll__graph_org.svg @@ -0,0 +1,79 @@ + + + + + + +gridfire::io::MESANetworkFileParser + + +Node1 + + +gridfire::io::MESANetwork +FileParser + + + + + +Node2 + + +gridfire::io::NetworkFile +Parser + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::string + + + + + +Node3->Node1 + + + + + + m_filename + + + +Node4 + + +std::basic_string< + Char > + + + + + +Node4->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__inherit__graph.map b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__inherit__graph.map new file mode 100644 index 00000000..5fc69754 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__inherit__graph.md5 b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__inherit__graph.md5 new file mode 100644 index 00000000..63d25fd3 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__inherit__graph.md5 @@ -0,0 +1 @@ +3add0e9577d1ff54ee04f99537e57f16 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__inherit__graph.svg b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__inherit__graph.svg new file mode 100644 index 00000000..77038be4 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__inherit__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +gridfire::io::MESANetworkFileParser + + +Node1 + + +gridfire::io::MESANetwork +FileParser + + + + + +Node2 + + +gridfire::io::NetworkFile +Parser + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__inherit__graph_org.svg b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__inherit__graph_org.svg new file mode 100644 index 00000000..57045448 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser__inherit__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +gridfire::io::MESANetworkFileParser + + +Node1 + + +gridfire::io::MESANetwork +FileParser + + + + + +Node2 + + +gridfire::io::NetworkFile +Parser + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1io_1_1NetworkFileParser-members.html b/docs/html/classgridfire_1_1io_1_1NetworkFileParser-members.html new file mode 100644 index 00000000..faf710ff --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1NetworkFileParser-members.html @@ -0,0 +1,112 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::io::NetworkFileParser Member List
+
+
+ +

This is the complete list of members for gridfire::io::NetworkFileParser, including all inherited members.

+ + + +
parse(const std::string &filename) const =0gridfire::io::NetworkFileParserpure virtual
~NetworkFileParser()=defaultgridfire::io::NetworkFileParservirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1io_1_1NetworkFileParser.html b/docs/html/classgridfire_1_1io_1_1NetworkFileParser.html new file mode 100644 index 00000000..efcf7398 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1NetworkFileParser.html @@ -0,0 +1,220 @@ + + + + + + + +GridFire: gridfire::io::NetworkFileParser Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::io::NetworkFileParser Class Referenceabstract
+
+
+ +

An abstract base class for network file parsers. + More...

+ +

#include <network_file.h>

+
+Inheritance diagram for gridfire::io::NetworkFileParser:
+
+
+
[legend]
+ + + + + + + + +

+Public Member Functions

virtual ~NetworkFileParser ()=default
 Virtual destructor for the base class.
 
virtual ParsedNetworkData parse (const std::string &filename) const =0
 Parses a network file and returns the parsed data.
 
+

Detailed Description

+

An abstract base class for network file parsers.

+

This class defines the interface for parsing files that contain reaction network definitions. Derived classes must implement the parse method to handle specific file formats.

+

Constructor & Destructor Documentation

+ +

◆ ~NetworkFileParser()

+ +
+
+ + + + + +
+ + + + + + + +
virtual gridfire::io::NetworkFileParser::~NetworkFileParser ()
+ 		+virtualdefault
+
+ +

Virtual destructor for the base class.

+ +
+
+

Member Function Documentation

+ +

◆ parse()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual ParsedNetworkData gridfire::io::NetworkFileParser::parse (const std::string & filename) const
+ 		+pure virtual
+
+ +

Parses a network file and returns the parsed data.

+

This is a pure virtual function that must be implemented by derived classes. It takes a filename as input and returns a ParsedNetworkData struct containing the information extracted from the file.

+
Parameters
+ + +
filenameThe path to the network file to parse.
+
+
+
Returns
A ParsedNetworkData struct containing the parsed reaction data.
+
Exceptions
+ + +
std::runtime_errorIf the file cannot be opened or a parsing error occurs.
+
+
+

Usage

std::unique_ptr<NetworkFileParser> parser = std::make_unique<SimpleReactionListFileParser>();
+
try {
+
ParsedNetworkData data = parser->parse("my_reactions.txt");
+
for (const auto& reaction_name : data.reactionPENames) {
+
// ... process reaction name
+
}
+
} catch (const std::runtime_error& e) {
+
// ... handle error
+
}
+
gridfire::io::ParsedNetworkData
std::vector< std::string > ParsedNetworkData
Definition network_file.h:12
+
+

Implemented in gridfire::io::SimpleReactionListFileParser, gridfire::io::MESANetworkFileParser, and PyNetworkFileParser.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1io_1_1NetworkFileParser.js b/docs/html/classgridfire_1_1io_1_1NetworkFileParser.js new file mode 100644 index 00000000..714651c1 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1NetworkFileParser.js @@ -0,0 +1,5 @@ +var classgridfire_1_1io_1_1NetworkFileParser = +[ + [ "~NetworkFileParser", "classgridfire_1_1io_1_1NetworkFileParser.html#a9b4095d06fad5df3805c92ae97b3eab3", null ], + [ "parse", "classgridfire_1_1io_1_1NetworkFileParser.html#a66e8e724c903d6ef4dd1c8103276bdbf", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1io_1_1NetworkFileParser__inherit__graph.map b/docs/html/classgridfire_1_1io_1_1NetworkFileParser__inherit__graph.map new file mode 100644 index 00000000..46d4c43a --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1NetworkFileParser__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1io_1_1NetworkFileParser__inherit__graph.md5 b/docs/html/classgridfire_1_1io_1_1NetworkFileParser__inherit__graph.md5 new file mode 100644 index 00000000..77e5d14c --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1NetworkFileParser__inherit__graph.md5 @@ -0,0 +1 @@ +2bcc43ed1f2c79d4ce41fae2823b3214 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1io_1_1NetworkFileParser__inherit__graph.svg b/docs/html/classgridfire_1_1io_1_1NetworkFileParser__inherit__graph.svg new file mode 100644 index 00000000..879ed72b --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1NetworkFileParser__inherit__graph.svg @@ -0,0 +1,103 @@ + + + + + + + + + + + +gridfire::io::NetworkFileParser + + +Node1 + + +gridfire::io::NetworkFile +Parser + + + + + +Node2 + + +PyNetworkFileParser + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::io::MESANetwork +FileParser + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::io::SimpleReaction +ListFileParser + + + + + +Node1->Node4 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1io_1_1NetworkFileParser__inherit__graph_org.svg b/docs/html/classgridfire_1_1io_1_1NetworkFileParser__inherit__graph_org.svg new file mode 100644 index 00000000..01bc750d --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1NetworkFileParser__inherit__graph_org.svg @@ -0,0 +1,78 @@ + + + + + + +gridfire::io::NetworkFileParser + + +Node1 + + +gridfire::io::NetworkFile +Parser + + + + + +Node2 + + +PyNetworkFileParser + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::io::MESANetwork +FileParser + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::io::SimpleReaction +ListFileParser + + + + + +Node1->Node4 + + + + + + + + diff --git a/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser-members.html b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser-members.html new file mode 100644 index 00000000..57a496cd --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser-members.html @@ -0,0 +1,117 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::io::SimpleReactionListFileParser Member List
+
+
+ +

This is the complete list of members for gridfire::io::SimpleReactionListFileParser, including all inherited members.

+ + + + + + + + +
Config typedefgridfire::io::SimpleReactionListFileParserprivate
LogManager typedefgridfire::io::SimpleReactionListFileParserprivate
m_configgridfire::io::SimpleReactionListFileParserprivate
m_loggergridfire::io::SimpleReactionListFileParserprivate
parse(const std::string &filename) const overridegridfire::io::SimpleReactionListFileParservirtual
SimpleReactionListFileParser()gridfire::io::SimpleReactionListFileParserexplicit
~NetworkFileParser()=defaultgridfire::io::NetworkFileParservirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser.html b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser.html new file mode 100644 index 00000000..5701de41 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser.html @@ -0,0 +1,340 @@ + + + + + + + +GridFire: gridfire::io::SimpleReactionListFileParser Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Types | +Private Attributes | +List of all members
+
gridfire::io::SimpleReactionListFileParser Class Referencefinal
+
+
+ +

A parser for simple text files containing a list of reactions. + More...

+ +

#include <network_file.h>

+
+Inheritance diagram for gridfire::io::SimpleReactionListFileParser:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::io::SimpleReactionListFileParser:
+
+
+
[legend]
+ + + + + + + + + + + + +

+Public Member Functions

 SimpleReactionListFileParser ()
 Constructs a SimpleReactionListFileParser.
 
ParsedNetworkData parse (const std::string &filename) const override
 Parses a simple reaction list file.
 
- Public Member Functions inherited from gridfire::io::NetworkFileParser
virtual ~NetworkFileParser ()=default
 Virtual destructor for the base class.
 
+ + + + + +

+Private Types

using Config = fourdst::config::Config
 
using LogManager = fourdst::logging::LogManager
 
+ + + + + +

+Private Attributes

Config & m_config = Config::getInstance()
 
quill::Logger * m_logger = LogManager::getInstance().getLogger("log")
 
+

Detailed Description

+

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.

+

Member Typedef Documentation

+ +

◆ Config

+ +
+
+ + + + + +
+ + + + +
using gridfire::io::SimpleReactionListFileParser::Config = fourdst::config::Config
+ 		+private
+
+ +
+
+ +

◆ LogManager

+ +
+
+ + + + + +
+ + + + +
using gridfire::io::SimpleReactionListFileParser::LogManager = fourdst::logging::LogManager
+ 		+private
+
+ +
+
+

Constructor & Destructor Documentation

+ +

◆ SimpleReactionListFileParser()

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::io::SimpleReactionListFileParser::SimpleReactionListFileParser ()
+ 		+explicitdefault
+
+ +

Constructs a SimpleReactionListFileParser.

+
Postcondition
The parser is initialized and ready to parse files.
+ +
+
+

Member Function Documentation

+ +

◆ parse()

+ +
+
+ + + + + +
+ + + + + + + + +
ParsedNetworkData gridfire::io::SimpleReactionListFileParser::parse (const std::string & filename) const
+ 		+overridevirtual
+
+ +

Parses a simple reaction list file.

+

This method reads the specified file line by line. It trims whitespace from each line, ignores lines that are empty or start with a '#' comment character, and stores the remaining lines as reaction names.

+
Parameters
+ + +
filenameThe path to the simple reaction list file.
+
+
+
Returns
A ParsedNetworkData struct containing the list of reaction names.
+
Exceptions
+ + +
std::runtime_errorIf the file cannot be opened for reading.
+
+
+

Algorithm

    +
  1. Opens the specified file.
    2. +
  2. Reads the file line by line.
    3. +
  3. For each line, it removes any trailing comments (starting with '#').
    4. +
  4. Trims leading and trailing whitespace.
    5. +
  5. If the line is not empty, it is added to the list of reaction names.
    6. +
  6. Returns the populated ParsedNetworkData struct.
    7. +
+

Usage

SimpleReactionListFileParser parser;
+
ParsedNetworkData data = parser.parse("reactions.txt");
+
gridfire::io::SimpleReactionListFileParser
A parser for simple text files containing a list of reactions.
Definition network_file.h:68
+
gridfire::io::SimpleReactionListFileParser::parse
ParsedNetworkData parse(const std::string &filename) const override
Parses a simple reaction list file.
Definition network_file.cpp:44
+
gridfire::io::ParsedNetworkData
std::vector< std::string > ParsedNetworkData
Definition network_file.h:12
+
+

Implements gridfire::io::NetworkFileParser.

+ +
+
+

Member Data Documentation

+ +

◆ m_config

+ +
+
+ + + + + +
+ + + + +
Config& gridfire::io::SimpleReactionListFileParser::m_config = Config::getInstance()
+ 		+private
+
+ +
+
+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::io::SimpleReactionListFileParser::m_logger = LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser.js b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser.js new file mode 100644 index 00000000..24e17a0a --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser.js @@ -0,0 +1,9 @@ +var classgridfire_1_1io_1_1SimpleReactionListFileParser = +[ + [ "Config", "classgridfire_1_1io_1_1SimpleReactionListFileParser.html#ad913155a5a2a36b29e4ce4ca8d71c036", null ], + [ "LogManager", "classgridfire_1_1io_1_1SimpleReactionListFileParser.html#a6f8f9a1f54cd2be5ec66c3181be892de", null ], + [ "SimpleReactionListFileParser", "classgridfire_1_1io_1_1SimpleReactionListFileParser.html#afc8ed91e8c98205c505e3d9f0cff1993", null ], + [ "parse", "classgridfire_1_1io_1_1SimpleReactionListFileParser.html#a4df01e3a93e1291d2cde0458545325f8", null ], + [ "m_config", "classgridfire_1_1io_1_1SimpleReactionListFileParser.html#a4061e99bd77a3de0d6d9e317bfc74874", null ], + [ "m_logger", "classgridfire_1_1io_1_1SimpleReactionListFileParser.html#acef7eafe3cbea159259f69c88d309b66", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__coll__graph.map b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__coll__graph.map new file mode 100644 index 00000000..4f9ab219 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__coll__graph.md5 b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__coll__graph.md5 new file mode 100644 index 00000000..d838253e --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__coll__graph.md5 @@ -0,0 +1 @@ +f9db583caf373f5da1cd1412aebd3a29 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__coll__graph.svg b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__coll__graph.svg new file mode 100644 index 00000000..5c1577a8 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__coll__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +gridfire::io::SimpleReactionListFileParser + + +Node1 + + +gridfire::io::SimpleReaction +ListFileParser + + + + + +Node2 + + +gridfire::io::NetworkFile +Parser + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__coll__graph_org.svg b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__coll__graph_org.svg new file mode 100644 index 00000000..ca6972c9 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__coll__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +gridfire::io::SimpleReactionListFileParser + + +Node1 + + +gridfire::io::SimpleReaction +ListFileParser + + + + + +Node2 + + +gridfire::io::NetworkFile +Parser + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__inherit__graph.map b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__inherit__graph.map new file mode 100644 index 00000000..4f9ab219 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__inherit__graph.md5 b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__inherit__graph.md5 new file mode 100644 index 00000000..d838253e --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__inherit__graph.md5 @@ -0,0 +1 @@ +f9db583caf373f5da1cd1412aebd3a29 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__inherit__graph.svg b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__inherit__graph.svg new file mode 100644 index 00000000..5c1577a8 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__inherit__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +gridfire::io::SimpleReactionListFileParser + + +Node1 + + +gridfire::io::SimpleReaction +ListFileParser + + + + + +Node2 + + +gridfire::io::NetworkFile +Parser + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__inherit__graph_org.svg b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__inherit__graph_org.svg new file mode 100644 index 00000000..ca6972c9 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser__inherit__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +gridfire::io::SimpleReactionListFileParser + + +Node1 + + +gridfire::io::SimpleReaction +ListFileParser + + + + + +Node2 + + +gridfire::io::NetworkFile +Parser + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction-members.html b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction-members.html new file mode 100644 index 00000000..3f66496a --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction-members.html @@ -0,0 +1,122 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::partition::CompositePartitionFunction Member List
+
+
+ +

This is the complete list of members for gridfire::partition::CompositePartitionFunction, including all inherited members.

+ + + + + + + + + + + + + +
clone() const overridegridfire::partition::CompositePartitionFunctioninlinevirtual
CompositePartitionFunction(const std::vector< BasePartitionType > &partitionFunctions)gridfire::partition::CompositePartitionFunctionexplicit
CompositePartitionFunction(const CompositePartitionFunction &other)gridfire::partition::CompositePartitionFunction
evaluate(int z, int a, double T9) const overridegridfire::partition::CompositePartitionFunctionvirtual
evaluateDerivative(int z, int a, double T9) const overridegridfire::partition::CompositePartitionFunctionvirtual
m_loggergridfire::partition::CompositePartitionFunctionprivate
m_partitionFunctionsgridfire::partition::CompositePartitionFunctionprivate
m_supportCachegridfire::partition::CompositePartitionFunctionmutableprivate
selectPartitionFunction(BasePartitionType type) constgridfire::partition::CompositePartitionFunctionprivate
supports(int z, int a) const overridegridfire::partition::CompositePartitionFunctionvirtual
type() const overridegridfire::partition::CompositePartitionFunctionvirtual
~PartitionFunction()=defaultgridfire::partition::PartitionFunctionvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction.html b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction.html new file mode 100644 index 00000000..e9b46510 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction.html @@ -0,0 +1,579 @@ + + + + + + + +GridFire: gridfire::partition::CompositePartitionFunction Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Member Functions | +Private Attributes | +List of all members
+
gridfire::partition::CompositePartitionFunction Class Referencefinal
+
+
+ +

Combines multiple PartitionFunction instances into a single composite strategy. + More...

+ +

#include <partition_composite.h>

+
+Inheritance diagram for gridfire::partition::CompositePartitionFunction:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::partition::CompositePartitionFunction:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 CompositePartitionFunction (const std::vector< BasePartitionType > &partitionFunctions)
 
 CompositePartitionFunction (const CompositePartitionFunction &other)
 
double evaluate (int z, int a, double T9) const override
 
double evaluateDerivative (int z, int a, double T9) const override
 
bool supports (int z, int a) const override
 
std::string type () const override
 
std::unique_ptr< PartitionFunction > clone () const override
 
- Public Member Functions inherited from gridfire::partition::PartitionFunction
virtual ~PartitionFunction ()=default
 Virtual destructor.
 
+ + + +

+Private Member Functions

std::unique_ptr< PartitionFunction > selectPartitionFunction (BasePartitionType type) const
 
+ + + + + + + + + +

+Private Attributes

quill::Logger * m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
 
std::vector< std::unique_ptr< PartitionFunction > > m_partitionFunctions
 Set of partition functions to use in the composite partition function.
 
std::unordered_map< uint_fast32_t, const PartitionFunction & > m_supportCache
 Cache mapping isotope keys to supporting partition functions for fast lookup.
 
+

Detailed Description

+

Combines multiple PartitionFunction instances into a single composite strategy.

+

Maintains an ordered list of sub-functions and delegates evaluation and derivative calls to the first function that supports the requested isotope.

+

See partition_composite.cpp for details on sub-function selection and error logging.

+
Exceptions
+ + +
std::runtime_errorIf no sub-function supports a given (z,a,T9) in evaluate or evaluateDerivative.
+
+
+

Constructor & Destructor Documentation

+ +

◆ CompositePartitionFunction() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::partition::CompositePartitionFunction::CompositePartitionFunction (const std::vector< BasePartitionType > & partitionFunctions)
+ 		+explicit
+
+
       @brief Construct a composite function from specified types.
+
+       Instantiates sub-functions according to the order of types provided.
+       @param partitionFunctions List of BasePartitionType identifiers for sub-functions.
+       @pre partitionFunctions must not be empty.
+       @post m_partitionFunctions contains instances matching each type.
+
    +

  • +
    • +
+ +
+
+ +

◆ CompositePartitionFunction() [2/2]

+ +
+
+ + + + + + + + +
gridfire::partition::CompositePartitionFunction::CompositePartitionFunction (const CompositePartitionFunction & other)
+
+
       @brief Copy constructor.
+
+       Creates deep clones of the sub-functions in another composite.
+       @param other Existing composite to copy from.
+       @post m_partitionFunctions contains clones of other's sub-functions.
+
    +

  • +
    • +
+ +
+
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< PartitionFunction > gridfire::partition::CompositePartitionFunction::clone () const
+ 		+inlineoverridevirtual
+
+
       @brief Clone this composite partition function.
+
+       @return Unique pointer to a deep copy of this object.
+
    +

  • +
    • +
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+ +

◆ evaluate()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::partition::CompositePartitionFunction::evaluate (int z,
int a,
double T9 
) const
+ 		+overridevirtual
+
+
       @brief Evaluate the composite partition function.
+
+       Calls evaluate on the first sub-function supporting the isotope.
+       @param z Atomic number (>=1).
+       @param a Mass number (>=z).
+       @param T9 Temperature in 10^9 K.
+       @return Partition function value from supporting sub-function.
+       @throws std::runtime_error If no sub-function supports (z,a,T9).
+
    +

  • +
    • +
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+ +

◆ evaluateDerivative()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::partition::CompositePartitionFunction::evaluateDerivative (int z,
int a,
double T9 
) const
+ 		+overridevirtual
+
+
       @brief Evaluate temperature derivative of the composite function.
+
+       Delegates to the first supporting sub-function's derivative.
+       @param z Atomic number.
+       @param a Mass number.
+       @param T9 Temperature in 10^9 K.
+       @return d/dT9 of the partition function.
+       @throws std::runtime_error If no sub-function supports (z,a,T9).
+
    +

  • +
    • +
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+ +

◆ selectPartitionFunction()

+ +
+
+ + + + + +
+ + + + + + + + +
std::unique_ptr< PartitionFunction > gridfire::partition::CompositePartitionFunction::selectPartitionFunction (BasePartitionType type) const
+ 		+private
+
+
       @brief Instantiate a sub-function by its type.
+
+       @param type Enumeration value selecting the desired function implementation.
+       @return Unique pointer to a new PartitionFunction instance of the given type.
+       @throws std::runtime_error If the given type is not recognized.
+
    +

  • +
    • +
+ +
+
+ +

◆ supports()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
bool gridfire::partition::CompositePartitionFunction::supports (int z,
int a 
) const
+ 		+overridevirtual
+
+
       @brief Check support across all sub-functions.
+
+       @param z Atomic number.
+       @param a Mass number.
+       @return true if any sub-function supports (z,a); false otherwise.
+
    +

  • +
    • +
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+ +

◆ type()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::partition::CompositePartitionFunction::type () const
+ 		+overridevirtual
+
+
       @brief Get composite type identifier.
+
+       Concatenates the type() strings of all sub-functions.
+       @return A string like "CompositePartitionFunction(func1, func2, ...)".
+
    +

  • +
    • +
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+

Member Data Documentation

+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::partition::CompositePartitionFunction::m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +
+
+ +

◆ m_partitionFunctions

+ +
+
+ + + + + +
+ + + + +
std::vector<std::unique_ptr<PartitionFunction> > gridfire::partition::CompositePartitionFunction::m_partitionFunctions
+ 		+private
+
+ +

Set of partition functions to use in the composite partition function.

+ +
+
+ +

◆ m_supportCache

+ +
+
+ + + + + +
+ + + + +
std::unordered_map<uint_fast32_t, const PartitionFunction&> gridfire::partition::CompositePartitionFunction::m_supportCache
+ 		+mutableprivate
+
+ +

Cache mapping isotope keys to supporting partition functions for fast lookup.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction.js b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction.js new file mode 100644 index 00000000..ff847b7f --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction.js @@ -0,0 +1,14 @@ +var classgridfire_1_1partition_1_1CompositePartitionFunction = +[ + [ "CompositePartitionFunction", "classgridfire_1_1partition_1_1CompositePartitionFunction.html#ad80743933712de627c6a69d06d42ceb5", null ], + [ "CompositePartitionFunction", "classgridfire_1_1partition_1_1CompositePartitionFunction.html#ac1bc5bedabef400fab6aceb477dbc6b9", null ], + [ "clone", "classgridfire_1_1partition_1_1CompositePartitionFunction.html#a7b000d55c7d1f489e54a57f7f4e3808a", null ], + [ "evaluate", "classgridfire_1_1partition_1_1CompositePartitionFunction.html#a8d6d278fcb5b8478b0e27535f877ee2b", null ], + [ "evaluateDerivative", "classgridfire_1_1partition_1_1CompositePartitionFunction.html#ac8900afaa5edd24fcb8eaf19e7379183", null ], + [ "selectPartitionFunction", "classgridfire_1_1partition_1_1CompositePartitionFunction.html#a32f397abf9e9ace9f0c721e4e14eb60b", null ], + [ "supports", "classgridfire_1_1partition_1_1CompositePartitionFunction.html#ae8908a78f087ea516cdd5a4cdd449a9c", null ], + [ "type", "classgridfire_1_1partition_1_1CompositePartitionFunction.html#a66560e21a4a7b08e8da135ce8279ed88", null ], + [ "m_logger", "classgridfire_1_1partition_1_1CompositePartitionFunction.html#ae0fc1c6abdc86009ba0fc6c9f270ff8b", null ], + [ "m_partitionFunctions", "classgridfire_1_1partition_1_1CompositePartitionFunction.html#a85aaac230e9de2fd50d4d453f6d5def8", null ], + [ "m_supportCache", "classgridfire_1_1partition_1_1CompositePartitionFunction.html#a9aea5eda63b9be4d3b8f65c13d317dcc", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__coll__graph.map b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__coll__graph.map new file mode 100644 index 00000000..a948d1df --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__coll__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__coll__graph.md5 b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__coll__graph.md5 new file mode 100644 index 00000000..b814cc5b --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__coll__graph.md5 @@ -0,0 +1 @@ +9fcc1f9a76ee01a910bdaf6eeb357409 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__coll__graph.svg b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__coll__graph.svg new file mode 100644 index 00000000..ef06b845 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__coll__graph.svg @@ -0,0 +1,206 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::partition::CompositePartitionFunction + + +Node1 + + +gridfire::partition +::CompositePartitionFunction + + + + + +Node2 + + +gridfire::partition +::PartitionFunction + + + + + +Node2->Node1 + + + + + + + + +Node4 + + +std::unique_ptr< gridfire +::partition::PartitionFunction > + + + + + +Node2->Node4 + + + + + + ptr + + + +Node5 + + +std::unordered_map +< uint_fast32_t, const + gridfire::partition:: +PartitionFunction & > + + + + + +Node2->Node5 + + + + + + elements + + + +Node3 + + +std::vector< std::unique +_ptr< gridfire::partition +::PartitionFunction > > + + + + + +Node3->Node1 + + + + + + m_partitionFunctions + + + +Node4->Node3 + + + + + + elements + + + +Node5->Node1 + + + + + + m_supportCache + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__coll__graph_org.svg b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__coll__graph_org.svg new file mode 100644 index 00000000..0585c39c --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__coll__graph_org.svg @@ -0,0 +1,124 @@ + + + + + + +gridfire::partition::CompositePartitionFunction + + +Node1 + + +gridfire::partition +::CompositePartitionFunction + + + + + +Node2 + + +gridfire::partition +::PartitionFunction + + + + + +Node2->Node1 + + + + + + + + +Node4 + + +std::unique_ptr< gridfire +::partition::PartitionFunction > + + + + + +Node2->Node4 + + + + + + ptr + + + +Node5 + + +std::unordered_map +< uint_fast32_t, const + gridfire::partition:: +PartitionFunction & > + + + + + +Node2->Node5 + + + + + + elements + + + +Node3 + + +std::vector< std::unique +_ptr< gridfire::partition +::PartitionFunction > > + + + + + +Node3->Node1 + + + + + + m_partitionFunctions + + + +Node4->Node3 + + + + + + elements + + + +Node5->Node1 + + + + + + m_supportCache + + + diff --git a/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__inherit__graph.map b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__inherit__graph.map new file mode 100644 index 00000000..6fecfca9 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__inherit__graph.md5 b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__inherit__graph.md5 new file mode 100644 index 00000000..e3ae0ac4 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__inherit__graph.md5 @@ -0,0 +1 @@ +d22644602077f49e249b1582f6859cda \ No newline at end of file diff --git a/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__inherit__graph.svg b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__inherit__graph.svg new file mode 100644 index 00000000..c5b0dc8a --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__inherit__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +gridfire::partition::CompositePartitionFunction + + +Node1 + + +gridfire::partition +::CompositePartitionFunction + + + + + +Node2 + + +gridfire::partition +::PartitionFunction + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__inherit__graph_org.svg b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__inherit__graph_org.svg new file mode 100644 index 00000000..92538137 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1CompositePartitionFunction__inherit__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +gridfire::partition::CompositePartitionFunction + + +Node1 + + +gridfire::partition +::CompositePartitionFunction + + + + + +Node2 + + +gridfire::partition +::PartitionFunction + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction-members.html b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction-members.html new file mode 100644 index 00000000..8778cce3 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction-members.html @@ -0,0 +1,120 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::partition::GroundStatePartitionFunction Member List
+
+
+ +

This is the complete list of members for gridfire::partition::GroundStatePartitionFunction, including all inherited members.

+ + + + + + + + + + + +
clone() const overridegridfire::partition::GroundStatePartitionFunctioninlinevirtual
evaluate(const int z, const int a, const double T9) const overridegridfire::partition::GroundStatePartitionFunctionvirtual
evaluateDerivative(const int z, const int a, const double T9) const overridegridfire::partition::GroundStatePartitionFunctionvirtual
GroundStatePartitionFunction()gridfire::partition::GroundStatePartitionFunction
m_ground_state_spingridfire::partition::GroundStatePartitionFunctionprivate
m_loggergridfire::partition::GroundStatePartitionFunctionprivate
make_key(int z, int a)gridfire::partition::GroundStatePartitionFunctionprivatestatic
supports(const int z, const int a) const overridegridfire::partition::GroundStatePartitionFunctionvirtual
type() const overridegridfire::partition::GroundStatePartitionFunctioninlinevirtual
~PartitionFunction()=defaultgridfire::partition::PartitionFunctionvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction.html b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction.html new file mode 100644 index 00000000..60b3cc23 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction.html @@ -0,0 +1,545 @@ + + + + + + + +GridFire: gridfire::partition::GroundStatePartitionFunction Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Static Private Member Functions | +Private Attributes | +List of all members
+
gridfire::partition::GroundStatePartitionFunction Class Referencefinal
+
+
+ +

Partition function implementation for nuclear ground states. + More...

+ +

#include <partition_ground.h>

+
+Inheritance diagram for gridfire::partition::GroundStatePartitionFunction:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::partition::GroundStatePartitionFunction:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + +

+Public Member Functions

 GroundStatePartitionFunction ()
 
double evaluate (const int z, const int a, const double T9) const override
 
double evaluateDerivative (const int z, const int a, const double T9) const override
 
bool supports (const int z, const int a) const override
 
std::string type () const override
 
std::unique_ptr< PartitionFunction > clone () const override
 
- Public Member Functions inherited from gridfire::partition::PartitionFunction
virtual ~PartitionFunction ()=default
 Virtual destructor.
 
+ + + +

+Static Private Member Functions

static constexpr int make_key (int z, int a)
 
+ + + + + +

+Private Attributes

quill::Logger * m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
 
std::unordered_map< int, double > m_ground_state_spin
 
+

Detailed Description

+

Partition function implementation for nuclear ground states.

+

Computes the partition function as (2J + 1) based on the ground state spin J of each isotope. The temperature derivative is always zero. Ground state spins are loaded from the fourdst::atomic::species registry at construction.

See also
partition_ground.cpp for implementation details.
+

Constructor & Destructor Documentation

+ +

◆ GroundStatePartitionFunction()

+ +
+
+ + + + + + + +
gridfire::partition::GroundStatePartitionFunction::GroundStatePartitionFunction ()
+
+
       @brief Construct and populate the ground state spin map.
+
    +
  • * Loads spins for all isotopes from the atomic species registry into m_ground_state_spin.
    Precondition
    atomic::species registry is initialized and non-empty.
    +
    Postcondition
    m_ground_state_spin contains entries for each isotope.
    +
    • +

  • +
    • +
+ +
+
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< PartitionFunction > gridfire::partition::GroundStatePartitionFunction::clone () const
+ 		+inlineoverridevirtual
+
+
       @brief Create a deep copy of this partition function.
+       @return Unique_ptr to a new GroundStatePartitionFunction cloned from this object.
+       @post Caller owns the returned instance.
+
    +

  • +
    • +
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+ +

◆ evaluate()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::partition::GroundStatePartitionFunction::evaluate (const int z,
const int a,
const double T9 
) const
+ 		+overridevirtual
+
+
       @brief Evaluate the ground state partition function.
+
    +
  • *
    Parameters
    + + + + +
    zProton number (atomic number) of the isotope; must be >= 1.
    aMass number of the isotope; must be >= z.
    T9Temperature in units of 10^9 K; unused for ground state.
    +
    +
    +
    Precondition
    supports(z,a) returns true.
    +
    Postcondition
    No side effects.
    +
    Returns
    Dimensionless partition function value = 2*spin + 1.
    +
    Exceptions
    + + +
    std::out_of_rangeIf the isotope key is not found in m_ground_state_spin.
    +
    +
    +
    • +

  • +
    • +
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+ +

◆ evaluateDerivative()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::partition::GroundStatePartitionFunction::evaluateDerivative (const int z,
const int a,
const double T9 
) const
+ 		+overridevirtual
+
+
       @brief Evaluate the temperature derivative of the ground state partition function.
+
    +
  • * Always returns zero as ground state has no temperature dependence.
    Parameters
    + + + + +
    zProton number of the isotope; must be supported.
    aMass number of the isotope; must be supported.
    T9Temperature in units of 10^9 K; unused.
    +
    +
    +
    Precondition
    supports(z,a) returns true.
    +
    Postcondition
    No side effects.
    +
    Returns
    Zero.
    +
    Exceptions
    + + +
    std::out_of_rangeIf the isotope key is not found.
    +
    +
    +
    • +

  • +
    • +
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+ +

◆ make_key()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
constexpr int gridfire::partition::GroundStatePartitionFunction::make_key (int z,
int a 
)
+ 		+staticconstexprprivate
+
+
       @brief Generate a unique lookup key for an isotope.
+
    +
  • * Combines atomic number z and mass number an into a single integer.
    Parameters
    + + + +
    zProton number of the isotope.
    aMass number of the isotope; should be < 1000 to avoid collisions.
    +
    +
    +
    Precondition
    a < 1000.
    +
    Returns
    Integer key = z * 1000 + a.
    +
    • +

  • +
    • +
+ +
+
+ +

◆ supports()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
bool gridfire::partition::GroundStatePartitionFunction::supports (const int z,
const int a 
) const
+ 		+overridevirtual
+
+
       @brief Check if ground state data exists for the given isotope.
+
    +
  • *
    Parameters
    + + + +
    zProton number of the isotope.
    aMass number of the isotope.
    +
    +
    +
    Returns
    True if m_ground_state_spin contains the key; false otherwise.
    +
    Postcondition
    No side effects.
    +
    • +

  • +
    • +
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+ +

◆ type()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::partition::GroundStatePartitionFunction::type () const
+ 		+inlineoverridevirtual
+
+
       @brief Get the type identifier of this partition function.
+       @return The string literal "GroundState".
+       @post No side effects.
+
    +

  • +
    • +
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+

Member Data Documentation

+ +

◆ m_ground_state_spin

+ +
+
+ + + + + +
+ + + + +
std::unordered_map<int, double> gridfire::partition::GroundStatePartitionFunction::m_ground_state_spin
+ 		+private
+
+ +
+
+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::partition::GroundStatePartitionFunction::m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction.js b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction.js new file mode 100644 index 00000000..0c3c8637 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction.js @@ -0,0 +1,12 @@ +var classgridfire_1_1partition_1_1GroundStatePartitionFunction = +[ + [ "GroundStatePartitionFunction", "classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#a8afa2aee993eb3ed8d01c887d39b57eb", null ], + [ "clone", "classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#ade2b0f92a3d9b74968166793466a11e4", null ], + [ "evaluate", "classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#af16da0015489307eb64639efbafbbdd5", null ], + [ "evaluateDerivative", "classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#a0eff10c7b134d9d4081ad72bbc785c5b", null ], + [ "make_key", "classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#a0e75ec9b97529783e07953aaf7d70f68", null ], + [ "supports", "classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#a49b18aae58eb6250aaa23d43d55f02bd", null ], + [ "type", "classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#af8d0146fc2afedf3785ae9ec932d3250", null ], + [ "m_ground_state_spin", "classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#af7f710edff96b1623c517ddab137c245", null ], + [ "m_logger", "classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#aff8f82f918380795e98c30a00fcd939b", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__coll__graph.map b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__coll__graph.map new file mode 100644 index 00000000..05433ec0 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__coll__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__coll__graph.md5 b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__coll__graph.md5 new file mode 100644 index 00000000..bbf754d3 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__coll__graph.md5 @@ -0,0 +1 @@ +3f24149f3d09031a63923ac0faeb884c \ No newline at end of file diff --git a/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__coll__graph.svg b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__coll__graph.svg new file mode 100644 index 00000000..c413db1d --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__coll__graph.svg @@ -0,0 +1,86 @@ + + + + + + + + + + + +gridfire::partition::GroundStatePartitionFunction + + +Node1 + + +gridfire::partition +::GroundStatePartitionFunction + + + + + +Node2 + + +gridfire::partition +::PartitionFunction + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::unordered_map +< int, double > + + + + + +Node3->Node1 + + + + + + m_ground_state_spin + + + + + + + + diff --git a/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__coll__graph_org.svg b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__coll__graph_org.svg new file mode 100644 index 00000000..dd64c7d5 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__coll__graph_org.svg @@ -0,0 +1,61 @@ + + + + + + +gridfire::partition::GroundStatePartitionFunction + + +Node1 + + +gridfire::partition +::GroundStatePartitionFunction + + + + + +Node2 + + +gridfire::partition +::PartitionFunction + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::unordered_map +< int, double > + + + + + +Node3->Node1 + + + + + + m_ground_state_spin + + + diff --git a/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__inherit__graph.map b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__inherit__graph.map new file mode 100644 index 00000000..7d4e2304 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__inherit__graph.md5 b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__inherit__graph.md5 new file mode 100644 index 00000000..cb1b853a --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__inherit__graph.md5 @@ -0,0 +1 @@ +2da1385aab9bb95a888176987cd48c66 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__inherit__graph.svg b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__inherit__graph.svg new file mode 100644 index 00000000..96b74dbe --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__inherit__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +gridfire::partition::GroundStatePartitionFunction + + +Node1 + + +gridfire::partition +::GroundStatePartitionFunction + + + + + +Node2 + + +gridfire::partition +::PartitionFunction + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__inherit__graph_org.svg b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__inherit__graph_org.svg new file mode 100644 index 00000000..9b7bf76b --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1GroundStatePartitionFunction__inherit__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +gridfire::partition::GroundStatePartitionFunction + + +Node1 + + +gridfire::partition +::GroundStatePartitionFunction + + + + + +Node2 + + +gridfire::partition +::PartitionFunction + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1partition_1_1PartitionFunction-members.html b/docs/html/classgridfire_1_1partition_1_1PartitionFunction-members.html new file mode 100644 index 00000000..75798962 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1PartitionFunction-members.html @@ -0,0 +1,116 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::partition::PartitionFunction Member List
+
+
+ +

This is the complete list of members for gridfire::partition::PartitionFunction, including all inherited members.

+ + + + + + + +
clone() const =0gridfire::partition::PartitionFunctionpure virtual
evaluate(int z, int a, double T9) const =0gridfire::partition::PartitionFunctionpure virtual
evaluateDerivative(int z, int a, double T9) const =0gridfire::partition::PartitionFunctionpure virtual
supports(int z, int a) const =0gridfire::partition::PartitionFunctionpure virtual
type() const =0gridfire::partition::PartitionFunctionpure virtual
~PartitionFunction()=defaultgridfire::partition::PartitionFunctionvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1partition_1_1PartitionFunction.html b/docs/html/classgridfire_1_1partition_1_1PartitionFunction.html new file mode 100644 index 00000000..6898d4c1 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1PartitionFunction.html @@ -0,0 +1,405 @@ + + + + + + + +GridFire: gridfire::partition::PartitionFunction Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::partition::PartitionFunction Class Referenceabstract
+
+
+ +

Abstract interface for evaluating nuclear partition functions. + More...

+ +

#include <partition_abstract.h>

+
+Inheritance diagram for gridfire::partition::PartitionFunction:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

virtual ~PartitionFunction ()=default
 Virtual destructor.
 
virtual double evaluate (int z, int a, double T9) const =0
 Evaluate the partition function for a given isotope.
 
virtual double evaluateDerivative (int z, int a, double T9) const =0
 Evaluate the temperature derivative of the partition function.
 
virtual bool supports (int z, int a) const =0
 Check if this partition function supports an isotope.
 
virtual std::string type () const =0
 Get the human-readable type of this partition function.
 
virtual std::unique_ptr< PartitionFunction > clone () const =0
 Create a deep copy of this PartitionFunction.
 
+

Detailed Description

+

Abstract interface for evaluating nuclear partition functions.

+

Provides methods to compute the partition function and its temperature derivative for a given isotope, to query if the function supports that isotope, and to clone the function object. Concrete implementations must provide temperature- dependent statistical models.

+

Constructor & Destructor Documentation

+ +

◆ ~PartitionFunction()

+ +
+
+ + + + + +
+ + + + + + + +
virtual gridfire::partition::PartitionFunction::~PartitionFunction ()
+ 		+virtualdefault
+
+ +

Virtual destructor.

+

Ensures proper cleanup in derived classes.

+ +
+
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::unique_ptr< PartitionFunction > gridfire::partition::PartitionFunction::clone () const
+ 		+pure virtual
+
+ +

Create a deep copy of this PartitionFunction.

+
Returns
Unique pointer to a new PartitionFunction instance with identical state.
+
Postcondition
The caller owns the returned object and must manage its lifetime.
+ +

Implemented in gridfire::partition::CompositePartitionFunction, gridfire::partition::GroundStatePartitionFunction, gridfire::partition::RauscherThielemannPartitionFunction, and PyPartitionFunction.

+ +
+
+ +

◆ evaluate()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual double gridfire::partition::PartitionFunction::evaluate (int z,
int a,
double T9 
) const
+ 		+pure virtual
+
+ +

Evaluate the partition function for a given isotope.

+
Parameters
+ + + + +
zProton number (atomic number) of the isotope; must be >= 1.
aMass number of the isotope; must be >= z.
T9Temperature in units of 10^9 K; must be > 0.
+
+
+
Returns
Partition function value (dimensionless) at the specified temperature.
+
Precondition
Derived implementation supports (z, a) and T9 > 0.
+
Postcondition
No side effects; pure function.
+ +

Implemented in gridfire::partition::GroundStatePartitionFunction, gridfire::partition::CompositePartitionFunction, gridfire::partition::RauscherThielemannPartitionFunction, and PyPartitionFunction.

+ +
+
+ +

◆ evaluateDerivative()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual double gridfire::partition::PartitionFunction::evaluateDerivative (int z,
int a,
double T9 
) const
+ 		+pure virtual
+
+ +

Evaluate the temperature derivative of the partition function.

+

Computes d/dT (partition function) at the given parameters.

+
Parameters
+ + + + +
zProton number (atomic number) of the isotope; must be >= 1.
aMass number of the isotope; must be >= z.
T9Temperature in units of 10^9 K; must be > 0.
+
+
+
Returns
Temperature derivative of the partition function.
+
Precondition
Derived implementation supports (z, a) and T9 > 0.
+
Postcondition
No side effects; pure function.
+ +

Implemented in gridfire::partition::GroundStatePartitionFunction, gridfire::partition::CompositePartitionFunction, gridfire::partition::RauscherThielemannPartitionFunction, and PyPartitionFunction.

+ +
+
+ +

◆ supports()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual bool gridfire::partition::PartitionFunction::supports (int z,
int a 
) const
+ 		+pure virtual
+
+ +

Check if this partition function supports an isotope.

+
Parameters
+ + + +
zProton number of the isotope.
aMass number of the isotope.
+
+
+
Returns
true if evaluate and evaluateDerivative can be called for this isotope; false otherwise.
+
Postcondition
No side effects.
+ +

Implemented in gridfire::partition::GroundStatePartitionFunction, gridfire::partition::CompositePartitionFunction, gridfire::partition::RauscherThielemannPartitionFunction, and PyPartitionFunction.

+ +
+
+ +

◆ type()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::string gridfire::partition::PartitionFunction::type () const
+ 		+pure virtual
+
+ +

Get the human-readable type of this partition function.

+
Returns
String identifier for the partition function implementation.
+
Postcondition
No side effects.
+ +

Implemented in gridfire::partition::CompositePartitionFunction, gridfire::partition::GroundStatePartitionFunction, gridfire::partition::RauscherThielemannPartitionFunction, and PyPartitionFunction.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1partition_1_1PartitionFunction.js b/docs/html/classgridfire_1_1partition_1_1PartitionFunction.js new file mode 100644 index 00000000..69f5e06d --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1PartitionFunction.js @@ -0,0 +1,9 @@ +var classgridfire_1_1partition_1_1PartitionFunction = +[ + [ "~PartitionFunction", "classgridfire_1_1partition_1_1PartitionFunction.html#a197a0663dcfb4ab4be3b0e14b98391db", null ], + [ "clone", "classgridfire_1_1partition_1_1PartitionFunction.html#a677a90f992fd56b8718e36655c33ce6d", null ], + [ "evaluate", "classgridfire_1_1partition_1_1PartitionFunction.html#a08ee79b7d8723b4e00ee1fc9cdfbe817", null ], + [ "evaluateDerivative", "classgridfire_1_1partition_1_1PartitionFunction.html#a14009bdaca47f3eddf2c6c023845db5a", null ], + [ "supports", "classgridfire_1_1partition_1_1PartitionFunction.html#a6df4191d10516477371a0384e1e55bf5", null ], + [ "type", "classgridfire_1_1partition_1_1PartitionFunction.html#ab0c67985a972707eac0ebc64417dfb97", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1partition_1_1PartitionFunction__inherit__graph.map b/docs/html/classgridfire_1_1partition_1_1PartitionFunction__inherit__graph.map new file mode 100644 index 00000000..8cbbd414 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1PartitionFunction__inherit__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1partition_1_1PartitionFunction__inherit__graph.md5 b/docs/html/classgridfire_1_1partition_1_1PartitionFunction__inherit__graph.md5 new file mode 100644 index 00000000..b39ac9db --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1PartitionFunction__inherit__graph.md5 @@ -0,0 +1 @@ +29cdb26748b8df3d497572ed0cb5b9be \ No newline at end of file diff --git a/docs/html/classgridfire_1_1partition_1_1PartitionFunction__inherit__graph.svg b/docs/html/classgridfire_1_1partition_1_1PartitionFunction__inherit__graph.svg new file mode 100644 index 00000000..6954fe1f --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1PartitionFunction__inherit__graph.svg @@ -0,0 +1,123 @@ + + + + + + + + + + + +gridfire::partition::PartitionFunction + + +Node1 + + +gridfire::partition +::PartitionFunction + + + + + +Node2 + + +PyPartitionFunction + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::partition +::CompositePartitionFunction + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::partition +::GroundStatePartitionFunction + + + + + +Node1->Node4 + + + + + + + + +Node5 + + +gridfire::partition +::RauscherThielemannPartition +Function + + + + + +Node1->Node5 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1partition_1_1PartitionFunction__inherit__graph_org.svg b/docs/html/classgridfire_1_1partition_1_1PartitionFunction__inherit__graph_org.svg new file mode 100644 index 00000000..c02cd3ce --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1PartitionFunction__inherit__graph_org.svg @@ -0,0 +1,98 @@ + + + + + + +gridfire::partition::PartitionFunction + + +Node1 + + +gridfire::partition +::PartitionFunction + + + + + +Node2 + + +PyPartitionFunction + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::partition +::CompositePartitionFunction + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::partition +::GroundStatePartitionFunction + + + + + +Node1->Node4 + + + + + + + + +Node5 + + +gridfire::partition +::RauscherThielemannPartition +Function + + + + + +Node1->Node5 + + + + + + + + diff --git a/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction-members.html b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction-members.html new file mode 100644 index 00000000..696e3c47 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction-members.html @@ -0,0 +1,126 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::partition::RauscherThielemannPartitionFunction Member List
+
+
+ +

This is the complete list of members for gridfire::partition::RauscherThielemannPartitionFunction, including all inherited members.

+ + + + + + + + + + + + + + + + + +
BACK enum valuegridfire::partition::RauscherThielemannPartitionFunctionprivate
Bounds enum namegridfire::partition::RauscherThielemannPartitionFunctionprivate
clone() const overridegridfire::partition::RauscherThielemannPartitionFunctioninlinevirtual
evaluate(int z, int a, double T9) const overridegridfire::partition::RauscherThielemannPartitionFunctionvirtual
evaluateDerivative(int z, int a, double T9) const overridegridfire::partition::RauscherThielemannPartitionFunctionvirtual
find(int z, int a, double T9) constgridfire::partition::RauscherThielemannPartitionFunctionprivate
FRONT enum valuegridfire::partition::RauscherThielemannPartitionFunctionprivate
get_interpolation_points(const size_t upper_index, const size_t lower_index, const std::array< double, 24 > &normalized_g_values)gridfire::partition::RauscherThielemannPartitionFunctionprivatestatic
m_loggergridfire::partition::RauscherThielemannPartitionFunctionprivate
m_partitionDatagridfire::partition::RauscherThielemannPartitionFunctionprivate
make_key(int z, int a)gridfire::partition::RauscherThielemannPartitionFunctionprivatestatic
MIDDLE enum valuegridfire::partition::RauscherThielemannPartitionFunctionprivate
RauscherThielemannPartitionFunction()gridfire::partition::RauscherThielemannPartitionFunction
supports(int z, int a) const overridegridfire::partition::RauscherThielemannPartitionFunctionvirtual
type() const overridegridfire::partition::RauscherThielemannPartitionFunctioninlinevirtual
~PartitionFunction()=defaultgridfire::partition::PartitionFunctionvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html new file mode 100644 index 00000000..bd2199c7 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html @@ -0,0 +1,709 @@ + + + + + + + +GridFire: gridfire::partition::RauscherThielemannPartitionFunction Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Classes | +Public Member Functions | +Private Types | +Private Member Functions | +Static Private Member Functions | +Private Attributes | +List of all members
+
gridfire::partition::RauscherThielemannPartitionFunction Class Referencefinal
+
+
+ +

Partition function using Rauscher-Thielemann tabulated normalized G-values. + More...

+ +

#include <partition_rauscher_thielemann.h>

+
+Inheritance diagram for gridfire::partition::RauscherThielemannPartitionFunction:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::partition::RauscherThielemannPartitionFunction:
+
+
+
[legend]
+ + + + + + + + +

+Classes

struct  IdentifiedIsotope
 
struct  InterpolationPoints
 
struct  IsotopeData
 
+ + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 RauscherThielemannPartitionFunction ()
 Construct and populate partition data.
 
double evaluate (int z, int a, double T9) const override
 Evaluate partition function for isotope at temperature.
 
double evaluateDerivative (int z, int a, double T9) const override
 Evaluate temperature derivative of partition function.
 
bool supports (int z, int a) const override
 Check if partition data exists for given isotope.
 
std::string type () const override
 Get type identifier for this partition function.
 
std::unique_ptr< PartitionFunction > clone () const override
 Clone this partition function instance.
 
- Public Member Functions inherited from gridfire::partition::PartitionFunction
virtual ~PartitionFunction ()=default
 Virtual destructor.
 
+ + + + +

+Private Types

enum  Bounds { FRONT +, BACK +, MIDDLE + }
 Indicator for temperature grid bound position. More...
 
+ + + + +

+Private Member Functions

IdentifiedIsotope find (int z, int a, double T9) const
 Identify isotope entry and grid indices for given T9.
 
+ + + + + + + +

+Static Private Member Functions

static InterpolationPoints get_interpolation_points (const size_t upper_index, const size_t lower_index, const std::array< double, 24 > &normalized_g_values)
 Get interpolation points from normalized G array.
 
static constexpr int make_key (int z, int a)
 Generate integer key for isotope (z,a).
 
+ + + + + + +

+Private Attributes

quill::Logger * m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
 
std::unordered_map< int, IsotopeData > m_partitionData
 Map of isotope key to data.
 
+

Detailed Description

+

Partition function using Rauscher-Thielemann tabulated normalized G-values.

+

Loads isotope partition data from embedded records and computes values by selecting boundary data or interpolating between grid points on a fixed T9 grid. Implementation in partition_rauscher_thielemann.cpp.

+
Exceptions
+ + +
std::out_of_rangeIf requested isotope data is missing.
+
+
+

Member Enumeration Documentation

+ +

◆ Bounds

+ +
+
+ + + + + +
+ + + + +
enum gridfire::partition::RauscherThielemannPartitionFunction::Bounds
+ 		+private
+
+ +

Indicator for temperature grid bound position.

+ + + + +
Enumerator
FRONT 

Below first grid point.

+
BACK 

Above last grid point.

+
MIDDLE 

Between grid points.

+
+ +
+
+

Constructor & Destructor Documentation

+ +

◆ RauscherThielemannPartitionFunction()

+ +
+
+ + + + + + + +
gridfire::partition::RauscherThielemannPartitionFunction::RauscherThielemannPartitionFunction ()
+
+ +

Construct and populate partition data.

+

Reads embedded RT partition data records and fills m_partitionData.

Precondition
Embedded data arrays are available and non-empty.
+
Postcondition
m_partitionData contains entries for all isotopes in data.
+ +
+
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< PartitionFunction > gridfire::partition::RauscherThielemannPartitionFunction::clone () const
+ 		+inlineoverridevirtual
+
+ +

Clone this partition function instance.

+
Returns
Unique pointer to a copy of this object.
+
Postcondition
Caller owns the returned object.
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+ +

◆ evaluate()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::partition::RauscherThielemannPartitionFunction::evaluate (int z,
int a,
double T9 
) const
+ 		+overridevirtual
+
+ +

Evaluate partition function for isotope at temperature.

+

Retrieves boundary or interpolated normalized G-value and scales by (2J+1).

Parameters
+ + + + +
zAtomic number of the isotope (>=1).
aMass number of the isotope (>=z).
T9Temperature in units of 10^9 K.
+
+
+
Returns
Dimensionless partition function.
+
Precondition
supports(z,a) returns true.
+
Postcondition
No side effects.
+
Exceptions
+ + +
std::out_of_rangeIf isotope key not found in m_partitionData.
+
+
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+ +

◆ evaluateDerivative()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::partition::RauscherThielemannPartitionFunction::evaluateDerivative (int z,
int a,
double T9 
) const
+ 		+overridevirtual
+
+ +

Evaluate temperature derivative of partition function.

+

Zero at grid extremes; otherwise derivative of linear interpolation.

Parameters
+ + + + +
zAtomic number (>=1).
aMass number (>=z).
T9Temperature in 10^9 K.
+
+
+
Returns
d(PartitionFunction)/dT9.
+
Precondition
supports(z,a) returns true.
+
Postcondition
No side effects.
+
Exceptions
+ + +
std::out_of_rangeIf isotope data is missing.
+
+
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+ +

◆ find()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
RauscherThielemannPartitionFunction::IdentifiedIsotope gridfire::partition::RauscherThielemannPartitionFunction::find (int z,
int a,
double T9 
) const
+ 		+private
+
+ +

Identify isotope entry and grid indices for given T9.

+
Parameters
+ + + + +
zAtomic number of isotope.
aMass number of isotope.
T9Temperature in 10^9 K.
+
+
+
Returns
IdentifiedIsotope with data reference and indices.
+
Exceptions
+ + +
std::out_of_rangeIf isotope not found in m_partitionData.
+
+
+ +
+
+ +

◆ get_interpolation_points()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
RauscherThielemannPartitionFunction::InterpolationPoints gridfire::partition::RauscherThielemannPartitionFunction::get_interpolation_points (const size_t upper_index,
const size_t lower_index,
const std::array< double, 24 > & normalized_g_values 
)
+ 		+staticprivate
+
+ +

Get interpolation points from normalized G array.

+
Parameters
+ + + + +
upper_indexIndex of upper grid point.
lower_indexIndex of lower grid point.
normalized_g_valuesArray of normalized G values.
+
+
+
Returns
InterpolationPoints containing bounds and G values.
+ +
+
+ +

◆ make_key()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
constexpr int gridfire::partition::RauscherThielemannPartitionFunction::make_key (int z,
int a 
)
+ 		+staticconstexprprivate
+
+ +

Generate integer key for isotope (z,a).

+
Parameters
+ + + +
zAtomic number.
aMass number (<1000).
+
+
+
Returns
Key computed as z*1000 + a.
+ +
+
+ +

◆ supports()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
bool gridfire::partition::RauscherThielemannPartitionFunction::supports (int z,
int a 
) const
+ 		+overridevirtual
+
+ +

Check if partition data exists for given isotope.

+
Parameters
+ + + +
zAtomic number.
aMass number.
+
+
+
Returns
true if data available; false otherwise.
+
Postcondition
No side effects.
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+ +

◆ type()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::partition::RauscherThielemannPartitionFunction::type () const
+ 		+inlineoverridevirtual
+
+ +

Get type identifier for this partition function.

+
Returns
Literal string "RauscherThielemann".
+
Postcondition
No side effects.
+ +

Implements gridfire::partition::PartitionFunction.

+ +
+
+

Member Data Documentation

+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::partition::RauscherThielemannPartitionFunction::m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +
+
+ +

◆ m_partitionData

+ +
+
+ + + + + +
+ + + + +
std::unordered_map<int, IsotopeData> gridfire::partition::RauscherThielemannPartitionFunction::m_partitionData
+ 		+private
+
+ +

Map of isotope key to data.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.js b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.js new file mode 100644 index 00000000..7ed7a9d0 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.js @@ -0,0 +1,22 @@ +var classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction = +[ + [ "IdentifiedIsotope", "structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope.html", "structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope" ], + [ "InterpolationPoints", "structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1InterpolationPoints.html", "structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1InterpolationPoints" ], + [ "IsotopeData", "structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData.html", "structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData" ], + [ "Bounds", "classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html#a7002ebbef966f89b2426f5ea0df33329", [ + [ "FRONT", "classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html#a7002ebbef966f89b2426f5ea0df33329aa692ae3131928d57ddcd2408d6b44d71", null ], + [ "BACK", "classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html#a7002ebbef966f89b2426f5ea0df33329ad8c6323fcc54dfc5319fbd935ae4f75d", null ], + [ "MIDDLE", "classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html#a7002ebbef966f89b2426f5ea0df33329abb276a700ba6a5b912fa0bf0a668d735", null ] + ] ], + [ "RauscherThielemannPartitionFunction", "classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html#ae67464baee3b12cdc0470be74524866c", null ], + [ "clone", "classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html#ad229cac0a84df5ebbcaf0550f83debf6", null ], + [ "evaluate", "classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html#aebe49d06b50a18ea4484ff15cb301681", null ], + [ "evaluateDerivative", "classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html#aaa1e11579b44a88c5f18943cc303c4b4", null ], + [ "find", "classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html#a12058e121981294f447e69a467fd84cd", null ], + [ "get_interpolation_points", "classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html#a3baed110ab1b12e22071dc2d92c55db9", null ], + [ "make_key", "classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html#ac58b95c8530f69f063c8ed8293487aec", null ], + [ "supports", "classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html#a588a11c654751765b04d6425c99041f5", null ], + [ "type", "classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html#a3aa478acf12e09b6dd268f744071b2a0", null ], + [ "m_logger", "classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html#a57384ffb1c81cf982614d90e23b173b6", null ], + [ "m_partitionData", "classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html#a50ce19df4c12e22bbcb61422248a4038", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__coll__graph.map b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__coll__graph.map new file mode 100644 index 00000000..031517b4 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__coll__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__coll__graph.md5 b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__coll__graph.md5 new file mode 100644 index 00000000..23b036fb --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__coll__graph.md5 @@ -0,0 +1 @@ +bda0b6890963000ae9cdfab32afa86f0 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__coll__graph.svg b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__coll__graph.svg new file mode 100644 index 00000000..e35473db --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__coll__graph.svg @@ -0,0 +1,187 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::partition::RauscherThielemannPartitionFunction + + +Node1 + + +gridfire::partition +::RauscherThielemannPartition +Function + + + + + +Node2 + + +gridfire::partition +::PartitionFunction + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::unordered_map +< int, gridfire::partition +::RauscherThielemannPartitionFunction +::IsotopeData > + + + + + +Node3->Node1 + + + + + + m_partitionData + + + +Node4 + + +gridfire::partition +::RauscherThielemannPartition +Function::IsotopeData + + + + + +Node4->Node3 + + + + + + elements + + + +Node5 + + +std::array< double, + 24 > + + + + + +Node5->Node4 + + + + + + normalized_g_values + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__coll__graph_org.svg b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__coll__graph_org.svg new file mode 100644 index 00000000..0bebcf06 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__coll__graph_org.svg @@ -0,0 +1,105 @@ + + + + + + +gridfire::partition::RauscherThielemannPartitionFunction + + +Node1 + + +gridfire::partition +::RauscherThielemannPartition +Function + + + + + +Node2 + + +gridfire::partition +::PartitionFunction + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::unordered_map +< int, gridfire::partition +::RauscherThielemannPartitionFunction +::IsotopeData > + + + + + +Node3->Node1 + + + + + + m_partitionData + + + +Node4 + + +gridfire::partition +::RauscherThielemannPartition +Function::IsotopeData + + + + + +Node4->Node3 + + + + + + elements + + + +Node5 + + +std::array< double, + 24 > + + + + + +Node5->Node4 + + + + + + normalized_g_values + + + diff --git a/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__inherit__graph.map b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__inherit__graph.map new file mode 100644 index 00000000..f5a7a339 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__inherit__graph.md5 b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__inherit__graph.md5 new file mode 100644 index 00000000..7170e0ee --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__inherit__graph.md5 @@ -0,0 +1 @@ +bd38228a463f68c909a431f73d4604e8 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__inherit__graph.svg b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__inherit__graph.svg new file mode 100644 index 00000000..b6f66c28 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__inherit__graph.svg @@ -0,0 +1,67 @@ + + + + + + + + + + + +gridfire::partition::RauscherThielemannPartitionFunction + + +Node1 + + +gridfire::partition +::RauscherThielemannPartition +Function + + + + + +Node2 + + +gridfire::partition +::PartitionFunction + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__inherit__graph_org.svg b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__inherit__graph_org.svg new file mode 100644 index 00000000..28f89f00 --- /dev/null +++ b/docs/html/classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction__inherit__graph_org.svg @@ -0,0 +1,42 @@ + + + + + + +gridfire::partition::RauscherThielemannPartitionFunction + + +Node1 + + +gridfire::partition +::RauscherThielemannPartition +Function + + + + + +Node2 + + +gridfire::partition +::PartitionFunction + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy-members.html new file mode 100644 index 00000000..26c81de8 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy-members.html @@ -0,0 +1,129 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::CNOChainPolicy Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + + +
begin()gridfire::policy::MultiReactionChainPolicyinline
begin() constgridfire::policy::MultiReactionChainPolicyinline
clone() const overridegridfire::policy::MultiReactionChainPolicyvirtual
CNOChainPolicy()gridfire::policy::CNOChainPolicy
contains(const std::string &id) const overridegridfire::policy::MultiReactionChainPolicyvirtual
contains(const reaction::Reaction &reaction) const overridegridfire::policy::MultiReactionChainPolicyvirtual
end()gridfire::policy::MultiReactionChainPolicyinline
end() constgridfire::policy::MultiReactionChainPolicyinline
get_chain_policies() constgridfire::policy::MultiReactionChainPolicy
get_reactions() const overridegridfire::policy::MultiReactionChainPolicyvirtual
hash(uint64_t seed) const overridegridfire::policy::MultiReactionChainPolicyvirtual
m_chain_policiesgridfire::policy::MultiReactionChainPolicyprotected
m_reactionsgridfire::policy::MultiReactionChainPolicyprotected
MultiReactionChainPolicy(std::vector< std::unique_ptr< ReactionChainPolicy > > &&chain_policies)gridfire::policy::MultiReactionChainPolicyexplicit
name() const overridegridfire::policy::CNOChainPolicyvirtual
operator!=(const ReactionChainPolicy &other) const overridegridfire::policy::MultiReactionChainPolicyvirtual
operator==(const ReactionChainPolicy &other) const overridegridfire::policy::MultiReactionChainPolicyvirtual
size() constgridfire::policy::MultiReactionChainPolicy
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy.html b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy.html new file mode 100644 index 00000000..bcbee21c --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy.html @@ -0,0 +1,253 @@ + + + + + + + +GridFire: gridfire::policy::CNOChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::policy::CNOChainPolicy Class Referencefinal
+
+
+ +

CNO Chain Policy. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::CNOChainPolicy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::policy::CNOChainPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 CNOChainPolicy ()
 
std::string name () const override
 
- Public Member Functions inherited from gridfire::policy::MultiReactionChainPolicy
 MultiReactionChainPolicy (std::vector< std::unique_ptr< ReactionChainPolicy > > &&chain_policies)
 Constructs a MultiReactionChainPolicy from a vector of ReactionChainPolicy instances.
 
const std::vector< std::unique_ptr< ReactionChainPolicy > > & get_chain_policies () const
 Returns the vector of child ReactionChainPolicy instances.
 
const reaction::ReactionSet & get_reactions () const override
 Returns the combined ReactionSet of all child chain policies.
 
bool contains (const std::string &id) const override
 Checks if the MultiReactionChainPolicy contains a reaction by ID.
 
bool contains (const reaction::Reaction &reaction) const override
 Checks if the MultiReactionChainPolicy contains a specific reaction.
 
std::unique_ptr< ReactionChainPolicy > clone () const override
 Creates a deep copy of the MultiReactionChainPolicy.
 
std::string name () const override
 Returns the name of the MultiReactionChainPolicy.
 
uint64_t hash (uint64_t seed) const override
 Computes a hash value for the MultiReactionChainPolicy.
 
bool operator== (const ReactionChainPolicy &other) const override
 Equality comparison operator.
 
bool operator!= (const ReactionChainPolicy &other) const override
 Inequality comparison operator.
 
size_t size () const
 Returns the number of child ReactionChainPolicy instances.
 
auto begin ()
 Returns iterator to the beginning of the child ReactionChainPolicy instances.
 
auto begin () const
 Returns const iterator to the beginning of the child ReactionChainPolicy instances.
 
auto end ()
 Returns iterator to the end of the child ReactionChainPolicy instances.
 
auto end () const
 Returns const iterator to the end of the child ReactionChainPolicy instances.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::policy::MultiReactionChainPolicy
std::vector< std::unique_ptr< ReactionChainPolicy > > m_chain_policies {}
 Child chain policies.
 
reaction::ReactionSet m_reactions
 Combined reactions from all child policies.
 
+

Detailed Description

+

CNO Chain Policy.

+

This class implements the overall CNO cycle of nuclear reactions, combining the CNO I, II, III, and IV chains. Enforcing this chain in the policy will ensure that all the CNO reactions are included in the network.

+
See also
CNOIChainPolicy
+
+CNOIIChainPolicy
+
+CNOIIIChainPolicy
+
+CNOIVChainPolicy
+

Constructor & Destructor Documentation

+ +

◆ CNOChainPolicy()

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

Member Function Documentation

+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::policy::CNOChainPolicy::name () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy.js b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy.js new file mode 100644 index 00000000..83c5e104 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy.js @@ -0,0 +1,5 @@ +var classgridfire_1_1policy_1_1CNOChainPolicy = +[ + [ "CNOChainPolicy", "classgridfire_1_1policy_1_1CNOChainPolicy.html#a5a526c6239c3a321c81484061a7a53e4", null ], + [ "name", "classgridfire_1_1policy_1_1CNOChainPolicy.html#a66511726b37f0e114cba2dd15db42440", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__coll__graph.map b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__coll__graph.map new file mode 100644 index 00000000..e30b7a93 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__coll__graph.map @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__coll__graph.md5 b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__coll__graph.md5 new file mode 100644 index 00000000..382d1d85 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__coll__graph.md5 @@ -0,0 +1 @@ +14eeee40adf74a78748908d348d7f934 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__coll__graph.svg b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__coll__graph.svg new file mode 100644 index 00000000..4e46595c --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__coll__graph.svg @@ -0,0 +1,362 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::CNOChainPolicy + + +Node1 + + +gridfire::policy::CNOChain +Policy + + + + + +Node2 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node5 + + +std::unique_ptr< gridfire +::policy::ReactionChainPolicy > + + + + + +Node3->Node5 + + + + + + ptr + + + +Node4 + + +std::vector< std::unique +_ptr< gridfire::policy +::ReactionChainPolicy > > + + + + + +Node4->Node2 + + + + + + m_chain_policies + + + +Node5->Node4 + + + + + + elements + + + +Node6 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node2 + + + + + + m_reactions + + + +Node7 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node7->Node6 + + + + + + m_reactions + + + +Node8 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node8->Node7 + + + + + + elements + + + +Node9 + + +gridfire::reaction +::Reaction + + + + + +Node9->Node8 + + + + + + ptr + + + +Node10 + + +std::string + + + + + +Node10->Node6 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node10->Node12 + + + + + + keys + + + +Node11 + + +std::basic_string< + Char > + + + + + +Node11->Node10 + + + + + + + + +Node12->Node6 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node6 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__coll__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__coll__graph_org.svg new file mode 100644 index 00000000..818029a3 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__coll__graph_org.svg @@ -0,0 +1,280 @@ + + + + + + +gridfire::policy::CNOChainPolicy + + +Node1 + + +gridfire::policy::CNOChain +Policy + + + + + +Node2 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node5 + + +std::unique_ptr< gridfire +::policy::ReactionChainPolicy > + + + + + +Node3->Node5 + + + + + + ptr + + + +Node4 + + +std::vector< std::unique +_ptr< gridfire::policy +::ReactionChainPolicy > > + + + + + +Node4->Node2 + + + + + + m_chain_policies + + + +Node5->Node4 + + + + + + elements + + + +Node6 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node2 + + + + + + m_reactions + + + +Node7 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node7->Node6 + + + + + + m_reactions + + + +Node8 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node8->Node7 + + + + + + elements + + + +Node9 + + +gridfire::reaction +::Reaction + + + + + +Node9->Node8 + + + + + + ptr + + + +Node10 + + +std::string + + + + + +Node10->Node6 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node10->Node12 + + + + + + keys + + + +Node11 + + +std::basic_string< + Char > + + + + + +Node11->Node10 + + + + + + + + +Node12->Node6 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node6 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__inherit__graph.map new file mode 100644 index 00000000..3ddae166 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..e0a87de8 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +1e91368ed11080c17b696257b2322162 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..0c0ee0e3 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__inherit__graph.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + +gridfire::policy::CNOChainPolicy + + +Node1 + + +gridfire::policy::CNOChain +Policy + + + + + +Node2 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..5de5462a --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOChainPolicy__inherit__graph_org.svg @@ -0,0 +1,60 @@ + + + + + + +gridfire::policy::CNOChainPolicy + + +Node1 + + +gridfire::policy::CNOChain +Policy + + + + + +Node2 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy-members.html new file mode 100644 index 00000000..b3f3e605 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy-members.html @@ -0,0 +1,128 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::CNOIChainPolicy Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + +
clone() const overridegridfire::policy::CNOIChainPolicyvirtual
CNOIChainPolicy()gridfire::policy::CNOIChainPolicy
contains(const std::string &id) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
contains(const reaction::Reaction &reaction) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
get_reactions() const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
hash(uint64_t seed) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
is_active(double T9) constgridfire::policy::TemperatureDependentChainPolicy
m_reactionIDsgridfire::policy::TemperatureDependentChainPolicyprotected
m_reactionsgridfire::policy::TemperatureDependentChainPolicyprotected
m_tempRangegridfire::policy::TemperatureDependentChainPolicyprotected
name() const overridegridfire::policy::CNOIChainPolicyvirtual
operator!=(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
operator==(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
~TemperatureDependentChainPolicy() override=defaultgridfire::policy::TemperatureDependentChainPolicy
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy.html b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy.html new file mode 100644 index 00000000..3cf2416a --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy.html @@ -0,0 +1,273 @@ + + + + + + + +GridFire: gridfire::policy::CNOIChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::policy::CNOIChainPolicy Class Referencefinal
+
+
+ +

CNO I Chain Policy. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::CNOIChainPolicy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::policy::CNOIChainPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 CNOIChainPolicy ()
 
std::unique_ptr< ReactionChainPolicy > clone () const override
 
std::string name () const override
 
- Public Member Functions inherited from gridfire::policy::TemperatureDependentChainPolicy
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 ~TemperatureDependentChainPolicy () override=default
 Virtual destructor.
 
const reaction::ReactionSet & get_reactions () const override
 Get the reactions that comprise the chain.
 
bool contains (const std::string &id) const override
 Check if a reaction or reaction ID is part of the chain.
 
bool contains (const reaction::Reaction &reaction) const override
 Check if a reaction is part of the chain.
 
uint64_t hash (uint64_t seed) const override
 Generate the hash for the reaction chain policy.
 
bool operator== (const ReactionChainPolicy &other) const override
 Equality operator.
 
bool operator!= (const ReactionChainPolicy &other) const override
 Inequality operator.
 
bool is_active (double T9) const
 Check if the reaction chain is active at a given temperature.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::policy::TemperatureDependentChainPolicy
ActiveTempRange m_tempRange
 Active temperature range for the reaction chain.
 
std::vector< std::string > m_reactionIDs
 Vector of reaction IDs that comprise the chain.
 
reaction::ReactionSet m_reactions
 Set of reactions that comprise the chain.
 
+

Detailed Description

+

CNO I Chain Policy.

+

This class implements the CNO I cycle of nuclear reactions. This chain's minimum temperature is set to T9=0.001 (or 1e6K). This chain includes reactions:

    +
  • c12(p,g)n13
    • +
  • n13(,e+)c13
    • +
  • c13(p,g)n14
    • +
  • n14(p,g)o15
    • +
  • o15(,e+)n15
    • +
  • n15(p,a)c12
    • +
+

Constructor & Destructor Documentation

+ +

◆ CNOIChainPolicy()

+ +
+
+ + + + + + + +
gridfire::policy::CNOIChainPolicy::CNOIChainPolicy ()
+
+ +
+
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< ReactionChainPolicy > gridfire::policy::CNOIChainPolicy::clone () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::policy::CNOIChainPolicy::name () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy.js b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy.js new file mode 100644 index 00000000..26d22f42 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy.js @@ -0,0 +1,6 @@ +var classgridfire_1_1policy_1_1CNOIChainPolicy = +[ + [ "CNOIChainPolicy", "classgridfire_1_1policy_1_1CNOIChainPolicy.html#a7b428233b7cd85bac48c0b4906f990ce", null ], + [ "clone", "classgridfire_1_1policy_1_1CNOIChainPolicy.html#a83042f4626ec22810314fa5181d3392a", null ], + [ "name", "classgridfire_1_1policy_1_1CNOIChainPolicy.html#ad3d4721e3046d792c0aa8e5c6c99aa2d", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__coll__graph.map b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__coll__graph.map new file mode 100644 index 00000000..4baba6bc --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__coll__graph.map @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__coll__graph.md5 b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__coll__graph.md5 new file mode 100644 index 00000000..ddcdec62 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__coll__graph.md5 @@ -0,0 +1 @@ +815c24c3fabb93044446e924ec6b60c2 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__coll__graph.svg b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__coll__graph.svg new file mode 100644 index 00000000..8b16e19e --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__coll__graph.svg @@ -0,0 +1,360 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::CNOIChainPolicy + + +Node1 + + +gridfire::policy::CNOIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__coll__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__coll__graph_org.svg new file mode 100644 index 00000000..a77484d3 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__coll__graph_org.svg @@ -0,0 +1,278 @@ + + + + + + +gridfire::policy::CNOIChainPolicy + + +Node1 + + +gridfire::policy::CNOIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__inherit__graph.map new file mode 100644 index 00000000..f28521bd --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..b2fc8b19 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +e1b3f01e5357e06e97200b87ce48d616 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..5a601ad3 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__inherit__graph.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + +gridfire::policy::CNOIChainPolicy + + +Node1 + + +gridfire::policy::CNOIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..dd9868c0 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIChainPolicy__inherit__graph_org.svg @@ -0,0 +1,60 @@ + + + + + + +gridfire::policy::CNOIChainPolicy + + +Node1 + + +gridfire::policy::CNOIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy-members.html new file mode 100644 index 00000000..ca09cc41 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy-members.html @@ -0,0 +1,128 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::CNOIIChainPolicy Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + +
clone() const overridegridfire::policy::CNOIIChainPolicyvirtual
CNOIIChainPolicy()gridfire::policy::CNOIIChainPolicy
contains(const std::string &id) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
contains(const reaction::Reaction &reaction) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
get_reactions() const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
hash(uint64_t seed) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
is_active(double T9) constgridfire::policy::TemperatureDependentChainPolicy
m_reactionIDsgridfire::policy::TemperatureDependentChainPolicyprotected
m_reactionsgridfire::policy::TemperatureDependentChainPolicyprotected
m_tempRangegridfire::policy::TemperatureDependentChainPolicyprotected
name() const overridegridfire::policy::CNOIIChainPolicyvirtual
operator!=(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
operator==(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
~TemperatureDependentChainPolicy() override=defaultgridfire::policy::TemperatureDependentChainPolicy
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy.html b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy.html new file mode 100644 index 00000000..a30382dd --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy.html @@ -0,0 +1,273 @@ + + + + + + + +GridFire: gridfire::policy::CNOIIChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::policy::CNOIIChainPolicy Class Referencefinal
+
+
+ +

CNO II Chain Policy. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::CNOIIChainPolicy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::policy::CNOIIChainPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 CNOIIChainPolicy ()
 
std::unique_ptr< ReactionChainPolicy > clone () const override
 
std::string name () const override
 
- Public Member Functions inherited from gridfire::policy::TemperatureDependentChainPolicy
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 ~TemperatureDependentChainPolicy () override=default
 Virtual destructor.
 
const reaction::ReactionSet & get_reactions () const override
 Get the reactions that comprise the chain.
 
bool contains (const std::string &id) const override
 Check if a reaction or reaction ID is part of the chain.
 
bool contains (const reaction::Reaction &reaction) const override
 Check if a reaction is part of the chain.
 
uint64_t hash (uint64_t seed) const override
 Generate the hash for the reaction chain policy.
 
bool operator== (const ReactionChainPolicy &other) const override
 Equality operator.
 
bool operator!= (const ReactionChainPolicy &other) const override
 Inequality operator.
 
bool is_active (double T9) const
 Check if the reaction chain is active at a given temperature.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::policy::TemperatureDependentChainPolicy
ActiveTempRange m_tempRange
 Active temperature range for the reaction chain.
 
std::vector< std::string > m_reactionIDs
 Vector of reaction IDs that comprise the chain.
 
reaction::ReactionSet m_reactions
 Set of reactions that comprise the chain.
 
+

Detailed Description

+

CNO II Chain Policy.

+

This class implements the CNO II cycle of nuclear reactions. This chain's minimum temperature is set to T9=0.001 (or 1e6K). This chain includes reactions:

    +
  • n15(p,g)o16
    • +
  • o16(p,g)f17
    • +
  • f17(p,g)ne18
    • +
  • ne18(,e+)f18
    • +
  • f18(p,a)o15
    • +
  • o15(,e+)n15
    • +
+

Constructor & Destructor Documentation

+ +

◆ CNOIIChainPolicy()

+ +
+
+ + + + + + + +
gridfire::policy::CNOIIChainPolicy::CNOIIChainPolicy ()
+
+ +
+
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< ReactionChainPolicy > gridfire::policy::CNOIIChainPolicy::clone () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::policy::CNOIIChainPolicy::name () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy.js b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy.js new file mode 100644 index 00000000..7013ecfd --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy.js @@ -0,0 +1,6 @@ +var classgridfire_1_1policy_1_1CNOIIChainPolicy = +[ + [ "CNOIIChainPolicy", "classgridfire_1_1policy_1_1CNOIIChainPolicy.html#aebcb36cb5cfbde4cf0e5b785c4b8cbd8", null ], + [ "clone", "classgridfire_1_1policy_1_1CNOIIChainPolicy.html#ab3aa5daaf2d9274770f981d8f67ae20b", null ], + [ "name", "classgridfire_1_1policy_1_1CNOIIChainPolicy.html#a6bf1057d28cb37db4f9ffde9cb3815ed", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__coll__graph.map b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__coll__graph.map new file mode 100644 index 00000000..925dfc91 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__coll__graph.map @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__coll__graph.md5 b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__coll__graph.md5 new file mode 100644 index 00000000..a32b1471 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__coll__graph.md5 @@ -0,0 +1 @@ +c9bf8730b30b79e395c1bc2e21d3f49b \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__coll__graph.svg b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__coll__graph.svg new file mode 100644 index 00000000..4b002a4a --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__coll__graph.svg @@ -0,0 +1,360 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::CNOIIChainPolicy + + +Node1 + + +gridfire::policy::CNOIIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__coll__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__coll__graph_org.svg new file mode 100644 index 00000000..b6eeb85c --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__coll__graph_org.svg @@ -0,0 +1,278 @@ + + + + + + +gridfire::policy::CNOIIChainPolicy + + +Node1 + + +gridfire::policy::CNOIIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__inherit__graph.map new file mode 100644 index 00000000..733bf290 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..d0968e6b --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +ad56c9453ce64df91cd4c732f413e29f \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..8c71f686 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__inherit__graph.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + +gridfire::policy::CNOIIChainPolicy + + +Node1 + + +gridfire::policy::CNOIIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..f2a61f38 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIChainPolicy__inherit__graph_org.svg @@ -0,0 +1,60 @@ + + + + + + +gridfire::policy::CNOIIChainPolicy + + +Node1 + + +gridfire::policy::CNOIIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy-members.html new file mode 100644 index 00000000..b7420fda --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy-members.html @@ -0,0 +1,128 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::CNOIIIChainPolicy Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + +
clone() const overridegridfire::policy::CNOIIIChainPolicyvirtual
CNOIIIChainPolicy()gridfire::policy::CNOIIIChainPolicy
contains(const std::string &id) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
contains(const reaction::Reaction &reaction) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
get_reactions() const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
hash(uint64_t seed) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
is_active(double T9) constgridfire::policy::TemperatureDependentChainPolicy
m_reactionIDsgridfire::policy::TemperatureDependentChainPolicyprotected
m_reactionsgridfire::policy::TemperatureDependentChainPolicyprotected
m_tempRangegridfire::policy::TemperatureDependentChainPolicyprotected
name() const overridegridfire::policy::CNOIIIChainPolicyvirtual
operator!=(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
operator==(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
~TemperatureDependentChainPolicy() override=defaultgridfire::policy::TemperatureDependentChainPolicy
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy.html b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy.html new file mode 100644 index 00000000..c3d453be --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy.html @@ -0,0 +1,273 @@ + + + + + + + +GridFire: gridfire::policy::CNOIIIChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::policy::CNOIIIChainPolicy Class Referencefinal
+
+
+ +

CNO III Chain Policy. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::CNOIIIChainPolicy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::policy::CNOIIIChainPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 CNOIIIChainPolicy ()
 
std::unique_ptr< ReactionChainPolicy > clone () const override
 
std::string name () const override
 
- Public Member Functions inherited from gridfire::policy::TemperatureDependentChainPolicy
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 ~TemperatureDependentChainPolicy () override=default
 Virtual destructor.
 
const reaction::ReactionSet & get_reactions () const override
 Get the reactions that comprise the chain.
 
bool contains (const std::string &id) const override
 Check if a reaction or reaction ID is part of the chain.
 
bool contains (const reaction::Reaction &reaction) const override
 Check if a reaction is part of the chain.
 
uint64_t hash (uint64_t seed) const override
 Generate the hash for the reaction chain policy.
 
bool operator== (const ReactionChainPolicy &other) const override
 Equality operator.
 
bool operator!= (const ReactionChainPolicy &other) const override
 Inequality operator.
 
bool is_active (double T9) const
 Check if the reaction chain is active at a given temperature.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::policy::TemperatureDependentChainPolicy
ActiveTempRange m_tempRange
 Active temperature range for the reaction chain.
 
std::vector< std::string > m_reactionIDs
 Vector of reaction IDs that comprise the chain.
 
reaction::ReactionSet m_reactions
 Set of reactions that comprise the chain.
 
+

Detailed Description

+

CNO III Chain Policy.

+

This class implements the CNO III cycle of nuclear reactions. This chain's minimum temperature is set to T9=0.001 (or 1e6K). This chain includes reactions:

    +
  • o17(p,g)f18
    • +
  • f18(,e+)o18
    • +
  • o18(p,a)n15
    • +
  • n15(p,g)o16
    • +
  • o16(p,g)f17
    • +
  • f17(,e+)o17
    • +
+

Constructor & Destructor Documentation

+ +

◆ CNOIIIChainPolicy()

+ +
+
+ + + + + + + +
gridfire::policy::CNOIIIChainPolicy::CNOIIIChainPolicy ()
+
+ +
+
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< ReactionChainPolicy > gridfire::policy::CNOIIIChainPolicy::clone () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::policy::CNOIIIChainPolicy::name () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy.js b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy.js new file mode 100644 index 00000000..782dfbc8 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy.js @@ -0,0 +1,6 @@ +var classgridfire_1_1policy_1_1CNOIIIChainPolicy = +[ + [ "CNOIIIChainPolicy", "classgridfire_1_1policy_1_1CNOIIIChainPolicy.html#af5ba73b9349e97fd1e2876ce9e9fac0b", null ], + [ "clone", "classgridfire_1_1policy_1_1CNOIIIChainPolicy.html#a9c0e056615742b3d77f47b3eb676ff28", null ], + [ "name", "classgridfire_1_1policy_1_1CNOIIIChainPolicy.html#a96abfb16ec2b692c070da139444435e3", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__coll__graph.map b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__coll__graph.map new file mode 100644 index 00000000..b9c0a6f3 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__coll__graph.map @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__coll__graph.md5 b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__coll__graph.md5 new file mode 100644 index 00000000..fbde12b8 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__coll__graph.md5 @@ -0,0 +1 @@ +ce1299e95d4559c8652424e6cacfb36e \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__coll__graph.svg b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__coll__graph.svg new file mode 100644 index 00000000..b9ea9ec7 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__coll__graph.svg @@ -0,0 +1,360 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::CNOIIIChainPolicy + + +Node1 + + +gridfire::policy::CNOIIIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__coll__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__coll__graph_org.svg new file mode 100644 index 00000000..5eab6236 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__coll__graph_org.svg @@ -0,0 +1,278 @@ + + + + + + +gridfire::policy::CNOIIIChainPolicy + + +Node1 + + +gridfire::policy::CNOIIIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__inherit__graph.map new file mode 100644 index 00000000..a11c7483 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..51caf5fb --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +66295ecd6270144d0da57b1eca048f14 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..dea382c5 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__inherit__graph.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + +gridfire::policy::CNOIIIChainPolicy + + +Node1 + + +gridfire::policy::CNOIIIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..4793afb4 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIIIChainPolicy__inherit__graph_org.svg @@ -0,0 +1,60 @@ + + + + + + +gridfire::policy::CNOIIIChainPolicy + + +Node1 + + +gridfire::policy::CNOIIIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy-members.html new file mode 100644 index 00000000..1de374d0 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy-members.html @@ -0,0 +1,128 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::CNOIVChainPolicy Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + +
clone() const overridegridfire::policy::CNOIVChainPolicyvirtual
CNOIVChainPolicy()gridfire::policy::CNOIVChainPolicy
contains(const std::string &id) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
contains(const reaction::Reaction &reaction) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
get_reactions() const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
hash(uint64_t seed) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
is_active(double T9) constgridfire::policy::TemperatureDependentChainPolicy
m_reactionIDsgridfire::policy::TemperatureDependentChainPolicyprotected
m_reactionsgridfire::policy::TemperatureDependentChainPolicyprotected
m_tempRangegridfire::policy::TemperatureDependentChainPolicyprotected
name() const overridegridfire::policy::CNOIVChainPolicyvirtual
operator!=(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
operator==(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
~TemperatureDependentChainPolicy() override=defaultgridfire::policy::TemperatureDependentChainPolicy
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy.html b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy.html new file mode 100644 index 00000000..772fe28a --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy.html @@ -0,0 +1,273 @@ + + + + + + + +GridFire: gridfire::policy::CNOIVChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::policy::CNOIVChainPolicy Class Referencefinal
+
+
+ +

CNO IV Chain Policy. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::CNOIVChainPolicy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::policy::CNOIVChainPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 CNOIVChainPolicy ()
 
std::unique_ptr< ReactionChainPolicy > clone () const override
 
std::string name () const override
 
- Public Member Functions inherited from gridfire::policy::TemperatureDependentChainPolicy
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 ~TemperatureDependentChainPolicy () override=default
 Virtual destructor.
 
const reaction::ReactionSet & get_reactions () const override
 Get the reactions that comprise the chain.
 
bool contains (const std::string &id) const override
 Check if a reaction or reaction ID is part of the chain.
 
bool contains (const reaction::Reaction &reaction) const override
 Check if a reaction is part of the chain.
 
uint64_t hash (uint64_t seed) const override
 Generate the hash for the reaction chain policy.
 
bool operator== (const ReactionChainPolicy &other) const override
 Equality operator.
 
bool operator!= (const ReactionChainPolicy &other) const override
 Inequality operator.
 
bool is_active (double T9) const
 Check if the reaction chain is active at a given temperature.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::policy::TemperatureDependentChainPolicy
ActiveTempRange m_tempRange
 Active temperature range for the reaction chain.
 
std::vector< std::string > m_reactionIDs
 Vector of reaction IDs that comprise the chain.
 
reaction::ReactionSet m_reactions
 Set of reactions that comprise the chain.
 
+

Detailed Description

+

CNO IV Chain Policy.

+

This class implements the CNO IV cycle of nuclear reactions. This chain's minimum temperature is set to T9=0.001 (or 1e6K). This chain includes reactions:

    +
  • o18(p,g)f19
    • +
  • f19(p,a)o16
    • +
  • o16(p,g)f17
    • +
  • f17(,e+)o17
    • +
  • o17(p,g)f18
    • +
  • f18(,e+)o18
    • +
+

Constructor & Destructor Documentation

+ +

◆ CNOIVChainPolicy()

+ +
+
+ + + + + + + +
gridfire::policy::CNOIVChainPolicy::CNOIVChainPolicy ()
+
+ +
+
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< ReactionChainPolicy > gridfire::policy::CNOIVChainPolicy::clone () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::policy::CNOIVChainPolicy::name () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy.js b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy.js new file mode 100644 index 00000000..544f3f40 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy.js @@ -0,0 +1,6 @@ +var classgridfire_1_1policy_1_1CNOIVChainPolicy = +[ + [ "CNOIVChainPolicy", "classgridfire_1_1policy_1_1CNOIVChainPolicy.html#a3a73e280dca833ff6517bef9b9193aa1", null ], + [ "clone", "classgridfire_1_1policy_1_1CNOIVChainPolicy.html#a35bef8035035eb85bb188ede6045556c", null ], + [ "name", "classgridfire_1_1policy_1_1CNOIVChainPolicy.html#a101a884a8ead5d961fd5d43a0dbffde8", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__coll__graph.map b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__coll__graph.map new file mode 100644 index 00000000..c167e376 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__coll__graph.map @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__coll__graph.md5 b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__coll__graph.md5 new file mode 100644 index 00000000..d6e8f83a --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__coll__graph.md5 @@ -0,0 +1 @@ +51c4a2259d7b4826a9afc4443d700dad \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__coll__graph.svg b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__coll__graph.svg new file mode 100644 index 00000000..c0031ca8 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__coll__graph.svg @@ -0,0 +1,360 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::CNOIVChainPolicy + + +Node1 + + +gridfire::policy::CNOIVChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__coll__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__coll__graph_org.svg new file mode 100644 index 00000000..a3b0b4b9 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__coll__graph_org.svg @@ -0,0 +1,278 @@ + + + + + + +gridfire::policy::CNOIVChainPolicy + + +Node1 + + +gridfire::policy::CNOIVChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__inherit__graph.map new file mode 100644 index 00000000..eb008cde --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..b824c5ed --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +73a1cf0f117f7945587a548f7cc9230d \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..09db5cc8 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__inherit__graph.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + +gridfire::policy::CNOIVChainPolicy + + +Node1 + + +gridfire::policy::CNOIVChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..b91dd387 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1CNOIVChainPolicy__inherit__graph_org.svg @@ -0,0 +1,60 @@ + + + + + + +gridfire::policy::CNOIVChainPolicy + + +Node1 + + +gridfire::policy::CNOIVChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy-members.html new file mode 100644 index 00000000..e63ee1ed --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy-members.html @@ -0,0 +1,129 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::HotCNOChainPolicy Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + + +
begin()gridfire::policy::MultiReactionChainPolicyinline
begin() constgridfire::policy::MultiReactionChainPolicyinline
clone() const overridegridfire::policy::MultiReactionChainPolicyvirtual
contains(const std::string &id) const overridegridfire::policy::MultiReactionChainPolicyvirtual
contains(const reaction::Reaction &reaction) const overridegridfire::policy::MultiReactionChainPolicyvirtual
end()gridfire::policy::MultiReactionChainPolicyinline
end() constgridfire::policy::MultiReactionChainPolicyinline
get_chain_policies() constgridfire::policy::MultiReactionChainPolicy
get_reactions() const overridegridfire::policy::MultiReactionChainPolicyvirtual
hash(uint64_t seed) const overridegridfire::policy::MultiReactionChainPolicyvirtual
HotCNOChainPolicy()gridfire::policy::HotCNOChainPolicy
m_chain_policiesgridfire::policy::MultiReactionChainPolicyprotected
m_reactionsgridfire::policy::MultiReactionChainPolicyprotected
MultiReactionChainPolicy(std::vector< std::unique_ptr< ReactionChainPolicy > > &&chain_policies)gridfire::policy::MultiReactionChainPolicyexplicit
name() const overridegridfire::policy::HotCNOChainPolicyvirtual
operator!=(const ReactionChainPolicy &other) const overridegridfire::policy::MultiReactionChainPolicyvirtual
operator==(const ReactionChainPolicy &other) const overridegridfire::policy::MultiReactionChainPolicyvirtual
size() constgridfire::policy::MultiReactionChainPolicy
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy.html b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy.html new file mode 100644 index 00000000..e3932251 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy.html @@ -0,0 +1,251 @@ + + + + + + + +GridFire: gridfire::policy::HotCNOChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::policy::HotCNOChainPolicy Class Referencefinal
+
+
+ +

Hot CNO Chain Policy. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::HotCNOChainPolicy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::policy::HotCNOChainPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 HotCNOChainPolicy ()
 
std::string name () const override
 
- Public Member Functions inherited from gridfire::policy::MultiReactionChainPolicy
 MultiReactionChainPolicy (std::vector< std::unique_ptr< ReactionChainPolicy > > &&chain_policies)
 Constructs a MultiReactionChainPolicy from a vector of ReactionChainPolicy instances.
 
const std::vector< std::unique_ptr< ReactionChainPolicy > > & get_chain_policies () const
 Returns the vector of child ReactionChainPolicy instances.
 
const reaction::ReactionSet & get_reactions () const override
 Returns the combined ReactionSet of all child chain policies.
 
bool contains (const std::string &id) const override
 Checks if the MultiReactionChainPolicy contains a reaction by ID.
 
bool contains (const reaction::Reaction &reaction) const override
 Checks if the MultiReactionChainPolicy contains a specific reaction.
 
std::unique_ptr< ReactionChainPolicy > clone () const override
 Creates a deep copy of the MultiReactionChainPolicy.
 
std::string name () const override
 Returns the name of the MultiReactionChainPolicy.
 
uint64_t hash (uint64_t seed) const override
 Computes a hash value for the MultiReactionChainPolicy.
 
bool operator== (const ReactionChainPolicy &other) const override
 Equality comparison operator.
 
bool operator!= (const ReactionChainPolicy &other) const override
 Inequality comparison operator.
 
size_t size () const
 Returns the number of child ReactionChainPolicy instances.
 
auto begin ()
 Returns iterator to the beginning of the child ReactionChainPolicy instances.
 
auto begin () const
 Returns const iterator to the beginning of the child ReactionChainPolicy instances.
 
auto end ()
 Returns iterator to the end of the child ReactionChainPolicy instances.
 
auto end () const
 Returns const iterator to the end of the child ReactionChainPolicy instances.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::policy::MultiReactionChainPolicy
std::vector< std::unique_ptr< ReactionChainPolicy > > m_chain_policies {}
 Child chain policies.
 
reaction::ReactionSet m_reactions
 Combined reactions from all child policies.
 
+

Detailed Description

+

Hot CNO Chain Policy.

+

This class implements the overall Hot CNO cycle of nuclear reactions, combining the Hot CNO I, II, and III chains. Enforcing this chain in the policy will ensure that all the Hot CNO reactions are included in the network.

+
See also
HotCNOIChainPolicy
+
+HotCNOIIChainPolicy
+
+HotCNOIIIChainPolicy
+

Constructor & Destructor Documentation

+ +

◆ HotCNOChainPolicy()

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

Member Function Documentation

+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::policy::HotCNOChainPolicy::name () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy.js b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy.js new file mode 100644 index 00000000..29acf03a --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy.js @@ -0,0 +1,5 @@ +var classgridfire_1_1policy_1_1HotCNOChainPolicy = +[ + [ "HotCNOChainPolicy", "classgridfire_1_1policy_1_1HotCNOChainPolicy.html#ad46d00a57325130798948616acf4c920", null ], + [ "name", "classgridfire_1_1policy_1_1HotCNOChainPolicy.html#a95e2f3c1a32b3f2dd5d5601c2a81f42f", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__coll__graph.map b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__coll__graph.map new file mode 100644 index 00000000..fced127a --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__coll__graph.map @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__coll__graph.md5 b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__coll__graph.md5 new file mode 100644 index 00000000..a5912f1a --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__coll__graph.md5 @@ -0,0 +1 @@ +ab1d45b023018ef00db944d2b0573214 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__coll__graph.svg b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__coll__graph.svg new file mode 100644 index 00000000..bc21ecb0 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__coll__graph.svg @@ -0,0 +1,362 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::HotCNOChainPolicy + + +Node1 + + +gridfire::policy::HotCNOChain +Policy + + + + + +Node2 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node5 + + +std::unique_ptr< gridfire +::policy::ReactionChainPolicy > + + + + + +Node3->Node5 + + + + + + ptr + + + +Node4 + + +std::vector< std::unique +_ptr< gridfire::policy +::ReactionChainPolicy > > + + + + + +Node4->Node2 + + + + + + m_chain_policies + + + +Node5->Node4 + + + + + + elements + + + +Node6 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node2 + + + + + + m_reactions + + + +Node7 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node7->Node6 + + + + + + m_reactions + + + +Node8 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node8->Node7 + + + + + + elements + + + +Node9 + + +gridfire::reaction +::Reaction + + + + + +Node9->Node8 + + + + + + ptr + + + +Node10 + + +std::string + + + + + +Node10->Node6 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node10->Node12 + + + + + + keys + + + +Node11 + + +std::basic_string< + Char > + + + + + +Node11->Node10 + + + + + + + + +Node12->Node6 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node6 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__coll__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__coll__graph_org.svg new file mode 100644 index 00000000..17038986 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__coll__graph_org.svg @@ -0,0 +1,280 @@ + + + + + + +gridfire::policy::HotCNOChainPolicy + + +Node1 + + +gridfire::policy::HotCNOChain +Policy + + + + + +Node2 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node5 + + +std::unique_ptr< gridfire +::policy::ReactionChainPolicy > + + + + + +Node3->Node5 + + + + + + ptr + + + +Node4 + + +std::vector< std::unique +_ptr< gridfire::policy +::ReactionChainPolicy > > + + + + + +Node4->Node2 + + + + + + m_chain_policies + + + +Node5->Node4 + + + + + + elements + + + +Node6 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node2 + + + + + + m_reactions + + + +Node7 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node7->Node6 + + + + + + m_reactions + + + +Node8 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node8->Node7 + + + + + + elements + + + +Node9 + + +gridfire::reaction +::Reaction + + + + + +Node9->Node8 + + + + + + ptr + + + +Node10 + + +std::string + + + + + +Node10->Node6 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node10->Node12 + + + + + + keys + + + +Node11 + + +std::basic_string< + Char > + + + + + +Node11->Node10 + + + + + + + + +Node12->Node6 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node6 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__inherit__graph.map new file mode 100644 index 00000000..3a25476b --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..2462e316 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +31e7bb9cabca17f92280d643a0878787 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..668bea78 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__inherit__graph.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + +gridfire::policy::HotCNOChainPolicy + + +Node1 + + +gridfire::policy::HotCNOChain +Policy + + + + + +Node2 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..a00fbe88 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOChainPolicy__inherit__graph_org.svg @@ -0,0 +1,60 @@ + + + + + + +gridfire::policy::HotCNOChainPolicy + + +Node1 + + +gridfire::policy::HotCNOChain +Policy + + + + + +Node2 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy-members.html new file mode 100644 index 00000000..95bd273e --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy-members.html @@ -0,0 +1,128 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::HotCNOIChainPolicy Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + +
clone() const overridegridfire::policy::HotCNOIChainPolicyvirtual
contains(const std::string &id) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
contains(const reaction::Reaction &reaction) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
get_reactions() const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
hash(uint64_t seed) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
HotCNOIChainPolicy()gridfire::policy::HotCNOIChainPolicy
is_active(double T9) constgridfire::policy::TemperatureDependentChainPolicy
m_reactionIDsgridfire::policy::TemperatureDependentChainPolicyprotected
m_reactionsgridfire::policy::TemperatureDependentChainPolicyprotected
m_tempRangegridfire::policy::TemperatureDependentChainPolicyprotected
name() const overridegridfire::policy::HotCNOIChainPolicyvirtual
operator!=(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
operator==(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
~TemperatureDependentChainPolicy() override=defaultgridfire::policy::TemperatureDependentChainPolicy
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy.html b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy.html new file mode 100644 index 00000000..cf4758a1 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy.html @@ -0,0 +1,273 @@ + + + + + + + +GridFire: gridfire::policy::HotCNOIChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::policy::HotCNOIChainPolicy Class Referencefinal
+
+
+ +

Hot CNO I Chain Policy. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::HotCNOIChainPolicy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::policy::HotCNOIChainPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 HotCNOIChainPolicy ()
 
std::unique_ptr< ReactionChainPolicy > clone () const override
 
std::string name () const override
 
- Public Member Functions inherited from gridfire::policy::TemperatureDependentChainPolicy
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 ~TemperatureDependentChainPolicy () override=default
 Virtual destructor.
 
const reaction::ReactionSet & get_reactions () const override
 Get the reactions that comprise the chain.
 
bool contains (const std::string &id) const override
 Check if a reaction or reaction ID is part of the chain.
 
bool contains (const reaction::Reaction &reaction) const override
 Check if a reaction is part of the chain.
 
uint64_t hash (uint64_t seed) const override
 Generate the hash for the reaction chain policy.
 
bool operator== (const ReactionChainPolicy &other) const override
 Equality operator.
 
bool operator!= (const ReactionChainPolicy &other) const override
 Inequality operator.
 
bool is_active (double T9) const
 Check if the reaction chain is active at a given temperature.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::policy::TemperatureDependentChainPolicy
ActiveTempRange m_tempRange
 Active temperature range for the reaction chain.
 
std::vector< std::string > m_reactionIDs
 Vector of reaction IDs that comprise the chain.
 
reaction::ReactionSet m_reactions
 Set of reactions that comprise the chain.
 
+

Detailed Description

+

Hot CNO I Chain Policy.

+

This class implements the Hot CNO I cycle of nuclear reactions. This chain's minimum temperature is set to T9=0.1 (or 1e8K). This chain includes reactions:

    +
  • c12(p,g)n13
    • +
  • n13(p,g)o14
    • +
  • o14(,e+)n14
    • +
  • n14(p,g)o15
    • +
  • o15(,e+)n15
    • +
  • n15(p,a)c12
    • +
+

Constructor & Destructor Documentation

+ +

◆ HotCNOIChainPolicy()

+ +
+
+ + + + + + + +
gridfire::policy::HotCNOIChainPolicy::HotCNOIChainPolicy ()
+
+ +
+
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< ReactionChainPolicy > gridfire::policy::HotCNOIChainPolicy::clone () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::policy::HotCNOIChainPolicy::name () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy.js b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy.js new file mode 100644 index 00000000..4b587c97 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy.js @@ -0,0 +1,6 @@ +var classgridfire_1_1policy_1_1HotCNOIChainPolicy = +[ + [ "HotCNOIChainPolicy", "classgridfire_1_1policy_1_1HotCNOIChainPolicy.html#a1816056fac2742369cc475bad4533dd6", null ], + [ "clone", "classgridfire_1_1policy_1_1HotCNOIChainPolicy.html#ae70a448fdeee35e159784fd6a506dce7", null ], + [ "name", "classgridfire_1_1policy_1_1HotCNOIChainPolicy.html#a13b2857d96e42f162888dcc294a27b9b", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__coll__graph.map b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__coll__graph.map new file mode 100644 index 00000000..e2272dc9 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__coll__graph.map @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__coll__graph.md5 b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__coll__graph.md5 new file mode 100644 index 00000000..5bfc2080 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__coll__graph.md5 @@ -0,0 +1 @@ +93761db5804082f038b1b6e07f79cabf \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__coll__graph.svg b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__coll__graph.svg new file mode 100644 index 00000000..7920b09a --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__coll__graph.svg @@ -0,0 +1,360 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::HotCNOIChainPolicy + + +Node1 + + +gridfire::policy::HotCNOIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__coll__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__coll__graph_org.svg new file mode 100644 index 00000000..17140bae --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__coll__graph_org.svg @@ -0,0 +1,278 @@ + + + + + + +gridfire::policy::HotCNOIChainPolicy + + +Node1 + + +gridfire::policy::HotCNOIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__inherit__graph.map new file mode 100644 index 00000000..cc1e24b6 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..52b043c7 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +d898bca7574f017563873ec84da9c3a8 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..c9fee593 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__inherit__graph.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + +gridfire::policy::HotCNOIChainPolicy + + +Node1 + + +gridfire::policy::HotCNOIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..682e673a --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIChainPolicy__inherit__graph_org.svg @@ -0,0 +1,60 @@ + + + + + + +gridfire::policy::HotCNOIChainPolicy + + +Node1 + + +gridfire::policy::HotCNOIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy-members.html new file mode 100644 index 00000000..e1d27d8d --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy-members.html @@ -0,0 +1,128 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::HotCNOIIChainPolicy Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + +
clone() const overridegridfire::policy::HotCNOIIChainPolicyvirtual
contains(const std::string &id) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
contains(const reaction::Reaction &reaction) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
get_reactions() const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
hash(uint64_t seed) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
HotCNOIIChainPolicy()gridfire::policy::HotCNOIIChainPolicy
is_active(double T9) constgridfire::policy::TemperatureDependentChainPolicy
m_reactionIDsgridfire::policy::TemperatureDependentChainPolicyprotected
m_reactionsgridfire::policy::TemperatureDependentChainPolicyprotected
m_tempRangegridfire::policy::TemperatureDependentChainPolicyprotected
name() const overridegridfire::policy::HotCNOIIChainPolicyvirtual
operator!=(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
operator==(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
~TemperatureDependentChainPolicy() override=defaultgridfire::policy::TemperatureDependentChainPolicy
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy.html b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy.html new file mode 100644 index 00000000..ec375cd7 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy.html @@ -0,0 +1,273 @@ + + + + + + + +GridFire: gridfire::policy::HotCNOIIChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::policy::HotCNOIIChainPolicy Class Referencefinal
+
+
+ +

Hot CNO II Chain Policy. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::HotCNOIIChainPolicy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::policy::HotCNOIIChainPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 HotCNOIIChainPolicy ()
 
std::unique_ptr< ReactionChainPolicy > clone () const override
 
std::string name () const override
 
- Public Member Functions inherited from gridfire::policy::TemperatureDependentChainPolicy
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 ~TemperatureDependentChainPolicy () override=default
 Virtual destructor.
 
const reaction::ReactionSet & get_reactions () const override
 Get the reactions that comprise the chain.
 
bool contains (const std::string &id) const override
 Check if a reaction or reaction ID is part of the chain.
 
bool contains (const reaction::Reaction &reaction) const override
 Check if a reaction is part of the chain.
 
uint64_t hash (uint64_t seed) const override
 Generate the hash for the reaction chain policy.
 
bool operator== (const ReactionChainPolicy &other) const override
 Equality operator.
 
bool operator!= (const ReactionChainPolicy &other) const override
 Inequality operator.
 
bool is_active (double T9) const
 Check if the reaction chain is active at a given temperature.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::policy::TemperatureDependentChainPolicy
ActiveTempRange m_tempRange
 Active temperature range for the reaction chain.
 
std::vector< std::string > m_reactionIDs
 Vector of reaction IDs that comprise the chain.
 
reaction::ReactionSet m_reactions
 Set of reactions that comprise the chain.
 
+

Detailed Description

+

Hot CNO II Chain Policy.

+

This class implements the Hot CNO II cycle of nuclear reactions. This chain's minimum temperature is set to T9=0.1 (or 1e8K). This chain includes reactions:

    +
  • n15(p,g)o16
    • +
  • o16(p,g)f17
    • +
  • f17(p,g)ne18
    • +
  • ne18(,e+)f18
    • +
  • f18(p,a)o15
    • +
  • o15(,e+)n15
    • +
+

Constructor & Destructor Documentation

+ +

◆ HotCNOIIChainPolicy()

+ +
+
+ + + + + + + +
gridfire::policy::HotCNOIIChainPolicy::HotCNOIIChainPolicy ()
+
+ +
+
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< ReactionChainPolicy > gridfire::policy::HotCNOIIChainPolicy::clone () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::policy::HotCNOIIChainPolicy::name () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy.js b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy.js new file mode 100644 index 00000000..1a160028 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy.js @@ -0,0 +1,6 @@ +var classgridfire_1_1policy_1_1HotCNOIIChainPolicy = +[ + [ "HotCNOIIChainPolicy", "classgridfire_1_1policy_1_1HotCNOIIChainPolicy.html#abc78c12c490661bfa984791748b3e770", null ], + [ "clone", "classgridfire_1_1policy_1_1HotCNOIIChainPolicy.html#afeb9b237b70963715adc64ad68e11675", null ], + [ "name", "classgridfire_1_1policy_1_1HotCNOIIChainPolicy.html#a262a18dafbc68db925beefb14c43668f", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__coll__graph.map b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__coll__graph.map new file mode 100644 index 00000000..a70f78aa --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__coll__graph.map @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__coll__graph.md5 b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__coll__graph.md5 new file mode 100644 index 00000000..c75cbd6f --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__coll__graph.md5 @@ -0,0 +1 @@ +1207fe8c4344d97f9da6a8918cc1779c \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__coll__graph.svg b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__coll__graph.svg new file mode 100644 index 00000000..d117a49d --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__coll__graph.svg @@ -0,0 +1,360 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::HotCNOIIChainPolicy + + +Node1 + + +gridfire::policy::HotCNOIIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__coll__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__coll__graph_org.svg new file mode 100644 index 00000000..c935fd5e --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__coll__graph_org.svg @@ -0,0 +1,278 @@ + + + + + + +gridfire::policy::HotCNOIIChainPolicy + + +Node1 + + +gridfire::policy::HotCNOIIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__inherit__graph.map new file mode 100644 index 00000000..271c0f49 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..9c7155f9 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +b188cce4c0e42ed7331fe0efcea7aa9f \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..b3813911 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__inherit__graph.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + +gridfire::policy::HotCNOIIChainPolicy + + +Node1 + + +gridfire::policy::HotCNOIIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..4be51869 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIChainPolicy__inherit__graph_org.svg @@ -0,0 +1,60 @@ + + + + + + +gridfire::policy::HotCNOIIChainPolicy + + +Node1 + + +gridfire::policy::HotCNOIIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy-members.html new file mode 100644 index 00000000..d92ea396 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy-members.html @@ -0,0 +1,128 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::HotCNOIIIChainPolicy Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + +
clone() const overridegridfire::policy::HotCNOIIIChainPolicyvirtual
contains(const std::string &id) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
contains(const reaction::Reaction &reaction) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
get_reactions() const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
hash(uint64_t seed) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
HotCNOIIIChainPolicy()gridfire::policy::HotCNOIIIChainPolicy
is_active(double T9) constgridfire::policy::TemperatureDependentChainPolicy
m_reactionIDsgridfire::policy::TemperatureDependentChainPolicyprotected
m_reactionsgridfire::policy::TemperatureDependentChainPolicyprotected
m_tempRangegridfire::policy::TemperatureDependentChainPolicyprotected
name() const overridegridfire::policy::HotCNOIIIChainPolicyvirtual
operator!=(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
operator==(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
~TemperatureDependentChainPolicy() override=defaultgridfire::policy::TemperatureDependentChainPolicy
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy.html b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy.html new file mode 100644 index 00000000..f1edc824 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy.html @@ -0,0 +1,273 @@ + + + + + + + +GridFire: gridfire::policy::HotCNOIIIChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::policy::HotCNOIIIChainPolicy Class Referencefinal
+
+
+ +

Hot CNO III Chain Policy. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::HotCNOIIIChainPolicy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::policy::HotCNOIIIChainPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 HotCNOIIIChainPolicy ()
 
std::unique_ptr< ReactionChainPolicy > clone () const override
 
std::string name () const override
 
- Public Member Functions inherited from gridfire::policy::TemperatureDependentChainPolicy
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 ~TemperatureDependentChainPolicy () override=default
 Virtual destructor.
 
const reaction::ReactionSet & get_reactions () const override
 Get the reactions that comprise the chain.
 
bool contains (const std::string &id) const override
 Check if a reaction or reaction ID is part of the chain.
 
bool contains (const reaction::Reaction &reaction) const override
 Check if a reaction is part of the chain.
 
uint64_t hash (uint64_t seed) const override
 Generate the hash for the reaction chain policy.
 
bool operator== (const ReactionChainPolicy &other) const override
 Equality operator.
 
bool operator!= (const ReactionChainPolicy &other) const override
 Inequality operator.
 
bool is_active (double T9) const
 Check if the reaction chain is active at a given temperature.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::policy::TemperatureDependentChainPolicy
ActiveTempRange m_tempRange
 Active temperature range for the reaction chain.
 
std::vector< std::string > m_reactionIDs
 Vector of reaction IDs that comprise the chain.
 
reaction::ReactionSet m_reactions
 Set of reactions that comprise the chain.
 
+

Detailed Description

+

Hot CNO III Chain Policy.

+

This class implements the Hot CNO III cycle of nuclear reactions. This chain's minimum temperature is set to T9=0.1 (or 1e8K). This chain includes reactions:

    +
  • f18(p,g)ne19
    • +
  • ne19(,e+)f19
    • +
  • f19(p,a)o16
    • +
  • o16(p,g)f17
    • +
  • f17(p,g)ne18
    • +
  • ne18(,e+)f18
    • +
+

Constructor & Destructor Documentation

+ +

◆ HotCNOIIIChainPolicy()

+ +
+
+ + + + + + + +
gridfire::policy::HotCNOIIIChainPolicy::HotCNOIIIChainPolicy ()
+
+ +
+
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< ReactionChainPolicy > gridfire::policy::HotCNOIIIChainPolicy::clone () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::policy::HotCNOIIIChainPolicy::name () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy.js b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy.js new file mode 100644 index 00000000..a64fc149 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy.js @@ -0,0 +1,6 @@ +var classgridfire_1_1policy_1_1HotCNOIIIChainPolicy = +[ + [ "HotCNOIIIChainPolicy", "classgridfire_1_1policy_1_1HotCNOIIIChainPolicy.html#aacf63705a61338cc56c081e3f0f66e89", null ], + [ "clone", "classgridfire_1_1policy_1_1HotCNOIIIChainPolicy.html#a5d86341bb4370647762c889519793d41", null ], + [ "name", "classgridfire_1_1policy_1_1HotCNOIIIChainPolicy.html#a59168da23f2d6b4d8667f5118153b514", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__coll__graph.map b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__coll__graph.map new file mode 100644 index 00000000..b8f29f20 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__coll__graph.map @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__coll__graph.md5 b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__coll__graph.md5 new file mode 100644 index 00000000..5913196e --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__coll__graph.md5 @@ -0,0 +1 @@ +e397f2619b201b04a2469941f4820e53 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__coll__graph.svg b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__coll__graph.svg new file mode 100644 index 00000000..53097f37 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__coll__graph.svg @@ -0,0 +1,360 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::HotCNOIIIChainPolicy + + +Node1 + + +gridfire::policy::HotCNOIIIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__coll__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__coll__graph_org.svg new file mode 100644 index 00000000..c53e9f98 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__coll__graph_org.svg @@ -0,0 +1,278 @@ + + + + + + +gridfire::policy::HotCNOIIIChainPolicy + + +Node1 + + +gridfire::policy::HotCNOIIIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__inherit__graph.map new file mode 100644 index 00000000..620b8f60 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..01f0945a --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +ea16b45da44c753f4e264c1982d1efc5 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..975984e3 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__inherit__graph.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + +gridfire::policy::HotCNOIIIChainPolicy + + +Node1 + + +gridfire::policy::HotCNOIIIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..25ebb220 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1HotCNOIIIChainPolicy__inherit__graph_org.svg @@ -0,0 +1,60 @@ + + + + + + +gridfire::policy::HotCNOIIIChainPolicy + + +Node1 + + +gridfire::policy::HotCNOIIIChain +Policy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy-members.html b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy-members.html new file mode 100644 index 00000000..4308ae75 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy-members.html @@ -0,0 +1,129 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::MainSequencePolicy Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + + +
build_partition_function()gridfire::policy::MainSequencePolicyinlineprivatestatic
check_status() constgridfire::policy::MainSequencePolicyinlineprivate
construct() overridegridfire::policy::MainSequencePolicyvirtual
get_engine_stack() const overridegridfire::policy::MainSequencePolicyvirtual
get_engine_types_stack() const overridegridfire::policy::MainSequencePolicyvirtual
get_partition_function() const overridegridfire::policy::MainSequencePolicyvirtual
get_seed_reactions() const overridegridfire::policy::MainSequencePolicyinlinevirtual
get_seed_species() const overridegridfire::policy::MainSequencePolicyinlinevirtual
get_status() const overridegridfire::policy::MainSequencePolicyinlinevirtual
m_initializing_compositiongridfire::policy::MainSequencePolicyprivate
m_network_stackgridfire::policy::MainSequencePolicyprivate
m_partition_functiongridfire::policy::MainSequencePolicyprivate
m_reaction_policygridfire::policy::MainSequencePolicyprivate
m_seed_speciesgridfire::policy::MainSequencePolicyprivate
m_statusgridfire::policy::MainSequencePolicyprivate
MainSequencePolicy(const fourdst::composition::Composition &composition)gridfire::policy::MainSequencePolicyexplicit
MainSequencePolicy(std::vector< fourdst::atomic::Species > seed_species, const std::vector< double > &mass_fractions)gridfire::policy::MainSequencePolicyexplicit
name() const overridegridfire::policy::MainSequencePolicyinlinevirtual
~NetworkPolicy()=defaultgridfire::policy::NetworkPolicyvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy.html b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy.html new file mode 100644 index 00000000..111cba3b --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy.html @@ -0,0 +1,762 @@ + + + + + + + +GridFire: gridfire::policy::MainSequencePolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Member Functions | +Static Private Member Functions | +Private Attributes | +List of all members
+
gridfire::policy::MainSequencePolicy Class Referencefinal
+
+
+ +

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

+ +

#include <stellar_policy.h>

+
+Inheritance diagram for gridfire::policy::MainSequencePolicy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::policy::MainSequencePolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

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

+Private Member Functions

NetworkPolicyStatus check_status () const
 
+ + + +

+Static Private Member Functions

static std::unique_ptr< partition::PartitionFunction > build_partition_function ()
 
+ + + + + + + + + + + + + + + + + + + +

+Private Attributes

std::set< fourdst::atomic::Species > m_seed_species
 The set of seed species required by this policy. These are H-1, He-3, He-4, C-12, N-14, O-16, Ne-20, Mg-24.
 
std::unique_ptr< ReactionChainPolicy > m_reaction_policy = std::make_unique<MainSequenceReactionChainPolicy>()
 The composed reaction chain policy (PP-chain + CNO-cycle).
 
fourdst::composition::Composition m_initializing_composition
 The initial composition used to build the network.
 
std::unique_ptr< partition::PartitionFunction > m_partition_function
 The partition function used in network construction.
 
std::vector< std::unique_ptr< engine::DynamicEngine > > m_network_stack
 The stack of dynamic engines constructed by the policy.
 
NetworkPolicyStatus m_status = NetworkPolicyStatus::UNINITIALIZED
 The current status of the policy.
 
+

Detailed Description

+

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

+

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

+

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

+

This policy requires the following seed species:

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

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

+

Constructor & Destructor Documentation

+ +

◆ MainSequencePolicy() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::policy::MainSequencePolicy::MainSequencePolicy (const fourdst::composition::Composition & composition)
+ 		+explicit
+
+ +

Constructs the policy from an existing composition object.

+
Parameters
+ + +
compositionThe initial composition, which must contain all seed species required by the policy.
+
+
+
Exceptions
+ + +
exceptions::MissingSeedSpeciesErrorif the provided composition is missing a required species.
+
+
+
Example
fourdst::composition::Composition comp;
+
// ... populate composition ...
+
LowMassMainSequencePolicy policy(comp);
+
+ +
+
+ +

◆ MainSequencePolicy() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
gridfire::policy::MainSequencePolicy::MainSequencePolicy (std::vector< fourdst::atomic::Species > seed_species,
const std::vector< double > & mass_fractions 
)
+ 		+explicit
+
+ +

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

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

Member Function Documentation

+ +

◆ build_partition_function()

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

◆ check_status()

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

◆ construct()

+ +
+
+ + + + + +
+ + + + + + + +
engine::DynamicEngine & gridfire::policy::MainSequencePolicy::construct ()
+ 		+overridevirtual
+
+ +

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

+

This method builds the full network engine stack:

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

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

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

Implements gridfire::policy::NetworkPolicy.

+ +
+
+ +

◆ get_engine_stack()

+ +
+
+ + + + + +
+ + + + + + + +
const std::vector< std::unique_ptr< engine::DynamicEngine > > & gridfire::policy::MainSequencePolicy::get_engine_stack () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::NetworkPolicy.

+ +
+
+ +

◆ get_engine_types_stack()

+ +
+
+ + + + + +
+ + + + + + + +
std::vector< engine::EngineTypes > gridfire::policy::MainSequencePolicy::get_engine_types_stack () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::NetworkPolicy.

+ +
+
+ +

◆ get_partition_function()

+ +
+
+ + + + + +
+ + + + + + + +
const std::unique_ptr< partition::PartitionFunction > & gridfire::policy::MainSequencePolicy::get_partition_function () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::NetworkPolicy.

+ +
+
+ +

◆ get_seed_reactions()

+ +
+
+ + + + + +
+ + + + + + + +
const reaction::ReactionSet & gridfire::policy::MainSequencePolicy::get_seed_reactions () const
+ 		+inlineoverridevirtual
+
+ +

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

+
Returns
const reaction::ReactionSet&
+ +

Implements gridfire::policy::NetworkPolicy.

+ +
+
+ +

◆ get_seed_species()

+ +
+
+ + + + + +
+ + + + + + + +
const std::set< fourdst::atomic::Species > & gridfire::policy::MainSequencePolicy::get_seed_species () const
+ 		+inlineoverridevirtual
+
+ +

Returns the set of seed species required by this policy.

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

Implements gridfire::policy::NetworkPolicy.

+ +
+
+ +

◆ get_status()

+ +
+
+ + + + + +
+ + + + + + + +
NetworkPolicyStatus gridfire::policy::MainSequencePolicy::get_status () const
+ 		+inlineoverridevirtual
+
+ +

Gets the current status of the policy.

+
Returns
NetworkPolicyStatus The construction and verification status.
+ +

Implements gridfire::policy::NetworkPolicy.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::policy::MainSequencePolicy::name () const
+ 		+inlineoverridevirtual
+
+ +

Returns the name of the policy.

+
Returns
"MainSequencePolicy"
+ +

Implements gridfire::policy::NetworkPolicy.

+ +
+
+

Member Data Documentation

+ +

◆ m_initializing_composition

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

The initial composition used to build the network.

+ +
+
+ +

◆ m_network_stack

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

The stack of dynamic engines constructed by the policy.

+ +
+
+ +

◆ m_partition_function

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

The partition function used in network construction.

+ +
+
+ +

◆ m_reaction_policy

+ +
+
+ + + + + +
+ + + + +
std::unique_ptr<ReactionChainPolicy> gridfire::policy::MainSequencePolicy::m_reaction_policy = std::make_unique<MainSequenceReactionChainPolicy>()
+ 		+private
+
+ +

The composed reaction chain policy (PP-chain + CNO-cycle).

+ +
+
+ +

◆ m_seed_species

+ +
+
+ + + + + +
+ + + + +
std::set<fourdst::atomic::Species> gridfire::policy::MainSequencePolicy::m_seed_species
+ 		+private
+
+ +

The set of seed species required by this policy. These are H-1, He-3, He-4, C-12, N-14, O-16, Ne-20, Mg-24.

+ +
+
+ +

◆ m_status

+ +
+
+ + + + + +
+ + + + +
NetworkPolicyStatus gridfire::policy::MainSequencePolicy::m_status = NetworkPolicyStatus::UNINITIALIZED
+ 		+private
+
+ +

The current status of the policy.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy.js b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy.js new file mode 100644 index 00000000..ca427153 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy.js @@ -0,0 +1,21 @@ +var classgridfire_1_1policy_1_1MainSequencePolicy = +[ + [ "MainSequencePolicy", "classgridfire_1_1policy_1_1MainSequencePolicy.html#acd3224e5781f3d19a8ff300b7fd9a21c", null ], + [ "MainSequencePolicy", "classgridfire_1_1policy_1_1MainSequencePolicy.html#a0fcac0f9d41917f888788a772daaaebc", null ], + [ "build_partition_function", "classgridfire_1_1policy_1_1MainSequencePolicy.html#a5f38cd1549544854e60c2c7a847c0ea7", null ], + [ "check_status", "classgridfire_1_1policy_1_1MainSequencePolicy.html#af5101829bcb344aa29ea65983732333d", null ], + [ "construct", "classgridfire_1_1policy_1_1MainSequencePolicy.html#aa9b4e39dacada73756bfd78885da60bd", null ], + [ "get_engine_stack", "classgridfire_1_1policy_1_1MainSequencePolicy.html#a43724347608826a613f6c65385050186", null ], + [ "get_engine_types_stack", "classgridfire_1_1policy_1_1MainSequencePolicy.html#a70c617ea5b13a1cdc62fbfe21963098c", null ], + [ "get_partition_function", "classgridfire_1_1policy_1_1MainSequencePolicy.html#a8dbef0e799968af4103e184b6e30c221", null ], + [ "get_seed_reactions", "classgridfire_1_1policy_1_1MainSequencePolicy.html#adcefccb171b339350a9b4a61d89adbbc", null ], + [ "get_seed_species", "classgridfire_1_1policy_1_1MainSequencePolicy.html#a041b0a99120efdc6abae312c568a9e15", null ], + [ "get_status", "classgridfire_1_1policy_1_1MainSequencePolicy.html#a1ecfb6ea2e18e8cf55228f80ee5c50ed", null ], + [ "name", "classgridfire_1_1policy_1_1MainSequencePolicy.html#a6520ddfead2ba2700e2b1329774b4ff6", null ], + [ "m_initializing_composition", "classgridfire_1_1policy_1_1MainSequencePolicy.html#a9b55ccd1a059ede5127b07a18274f6e9", null ], + [ "m_network_stack", "classgridfire_1_1policy_1_1MainSequencePolicy.html#a0416e55a72362487212a92b3d18dfb14", null ], + [ "m_partition_function", "classgridfire_1_1policy_1_1MainSequencePolicy.html#a57a7bbb55eb6f96396d87811f34cc0a4", null ], + [ "m_reaction_policy", "classgridfire_1_1policy_1_1MainSequencePolicy.html#a145fe245a253e8ecd4da9726b9379b3c", null ], + [ "m_seed_species", "classgridfire_1_1policy_1_1MainSequencePolicy.html#a67cda11c3ef95f5ac2ff384965c5a500", null ], + [ "m_status", "classgridfire_1_1policy_1_1MainSequencePolicy.html#a023a7cbb9971a787713abaf344848211", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__coll__graph.map b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__coll__graph.map new file mode 100644 index 00000000..244ceb9e --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__coll__graph.map @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__coll__graph.md5 b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__coll__graph.md5 new file mode 100644 index 00000000..0750892a --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__coll__graph.md5 @@ -0,0 +1 @@ +48ce4c60cd6f50d00bbe2ddfff7dc4e7 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__coll__graph.svg b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__coll__graph.svg new file mode 100644 index 00000000..30925eb7 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__coll__graph.svg @@ -0,0 +1,340 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::MainSequencePolicy + + +Node1 + + +gridfire::policy::MainSequence +Policy + + + + + +Node2 + + +gridfire::policy::Network +Policy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::set< fourdst:: +atomic::Species > + + + + + +Node3->Node1 + + + + + + m_seed_species + + + +Node4 + + +Species + + + + + +Node4->Node3 + + + + + + keys + + + +Node5 + + +std::unique_ptr< gridfire +::policy::ReactionChainPolicy > + + + + + +Node5->Node1 + + + + + + m_reaction_policy + + + +Node6 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node6->Node5 + + + + + + ptr + + + +Node7 + + +Composition + + + + + +Node7->Node1 + + + + + + m_initializing_composition + + + +Node8 + + +std::unique_ptr< gridfire +::partition::PartitionFunction > + + + + + +Node8->Node1 + + + + + + m_partition_function + + + +Node9 + + +gridfire::partition +::PartitionFunction + + + + + +Node9->Node8 + + + + + + ptr + + + +Node10 + + +std::vector< std::unique +_ptr< gridfire::engine +::DynamicEngine > > + + + + + +Node10->Node1 + + + + + + m_network_stack + + + +Node11 + + +std::unique_ptr< gridfire +::engine::DynamicEngine > + + + + + +Node11->Node10 + + + + + + elements + + + +Node12 + + +gridfire::engine::Dynamic +Engine + + + + + +Node12->Node11 + + + + + + ptr + + + +Node13 + + +gridfire::engine::Engine + + + + + +Node13->Node12 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__coll__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__coll__graph_org.svg new file mode 100644 index 00000000..2664c2e5 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__coll__graph_org.svg @@ -0,0 +1,258 @@ + + + + + + +gridfire::policy::MainSequencePolicy + + +Node1 + + +gridfire::policy::MainSequence +Policy + + + + + +Node2 + + +gridfire::policy::Network +Policy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::set< fourdst:: +atomic::Species > + + + + + +Node3->Node1 + + + + + + m_seed_species + + + +Node4 + + +Species + + + + + +Node4->Node3 + + + + + + keys + + + +Node5 + + +std::unique_ptr< gridfire +::policy::ReactionChainPolicy > + + + + + +Node5->Node1 + + + + + + m_reaction_policy + + + +Node6 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node6->Node5 + + + + + + ptr + + + +Node7 + + +Composition + + + + + +Node7->Node1 + + + + + + m_initializing_composition + + + +Node8 + + +std::unique_ptr< gridfire +::partition::PartitionFunction > + + + + + +Node8->Node1 + + + + + + m_partition_function + + + +Node9 + + +gridfire::partition +::PartitionFunction + + + + + +Node9->Node8 + + + + + + ptr + + + +Node10 + + +std::vector< std::unique +_ptr< gridfire::engine +::DynamicEngine > > + + + + + +Node10->Node1 + + + + + + m_network_stack + + + +Node11 + + +std::unique_ptr< gridfire +::engine::DynamicEngine > + + + + + +Node11->Node10 + + + + + + elements + + + +Node12 + + +gridfire::engine::Dynamic +Engine + + + + + +Node12->Node11 + + + + + + ptr + + + +Node13 + + +gridfire::engine::Engine + + + + + +Node13->Node12 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__inherit__graph.map new file mode 100644 index 00000000..e0b41ad2 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__inherit__graph.md5 new file mode 100644 index 00000000..ce5d6bc4 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__inherit__graph.md5 @@ -0,0 +1 @@ +040360f3e5d59a5e80b3cdc117fe38cd \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__inherit__graph.svg new file mode 100644 index 00000000..78b156ba --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__inherit__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +gridfire::policy::MainSequencePolicy + + +Node1 + + +gridfire::policy::MainSequence +Policy + + + + + +Node2 + + +gridfire::policy::Network +Policy + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__inherit__graph_org.svg new file mode 100644 index 00000000..a9e15874 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequencePolicy__inherit__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +gridfire::policy::MainSequencePolicy + + +Node1 + + +gridfire::policy::MainSequence +Policy + + + + + +Node2 + + +gridfire::policy::Network +Policy + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy-members.html new file mode 100644 index 00000000..2c5a0bb5 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy-members.html @@ -0,0 +1,129 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::MainSequenceReactionChainPolicy Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + + +
begin()gridfire::policy::MultiReactionChainPolicyinline
begin() constgridfire::policy::MultiReactionChainPolicyinline
clone() const overridegridfire::policy::MultiReactionChainPolicyvirtual
contains(const std::string &id) const overridegridfire::policy::MultiReactionChainPolicyvirtual
contains(const reaction::Reaction &reaction) const overridegridfire::policy::MultiReactionChainPolicyvirtual
end()gridfire::policy::MultiReactionChainPolicyinline
end() constgridfire::policy::MultiReactionChainPolicyinline
get_chain_policies() constgridfire::policy::MultiReactionChainPolicy
get_reactions() const overridegridfire::policy::MultiReactionChainPolicyvirtual
hash(uint64_t seed) const overridegridfire::policy::MultiReactionChainPolicyvirtual
m_chain_policiesgridfire::policy::MultiReactionChainPolicyprotected
m_reactionsgridfire::policy::MultiReactionChainPolicyprotected
MainSequenceReactionChainPolicy()gridfire::policy::MainSequenceReactionChainPolicy
MultiReactionChainPolicy(std::vector< std::unique_ptr< ReactionChainPolicy > > &&chain_policies)gridfire::policy::MultiReactionChainPolicyexplicit
name() const overridegridfire::policy::MainSequenceReactionChainPolicyvirtual
operator!=(const ReactionChainPolicy &other) const overridegridfire::policy::MultiReactionChainPolicyvirtual
operator==(const ReactionChainPolicy &other) const overridegridfire::policy::MultiReactionChainPolicyvirtual
size() constgridfire::policy::MultiReactionChainPolicy
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy.html b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy.html new file mode 100644 index 00000000..521c3d6d --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy.html @@ -0,0 +1,249 @@ + + + + + + + +GridFire: gridfire::policy::MainSequenceReactionChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::policy::MainSequenceReactionChainPolicy Class Referencefinal
+
+
+ +

Main Sequence Reaction Chain Policy. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::MainSequenceReactionChainPolicy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::policy::MainSequenceReactionChainPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 MainSequenceReactionChainPolicy ()
 
std::string name () const override
 
- Public Member Functions inherited from gridfire::policy::MultiReactionChainPolicy
 MultiReactionChainPolicy (std::vector< std::unique_ptr< ReactionChainPolicy > > &&chain_policies)
 Constructs a MultiReactionChainPolicy from a vector of ReactionChainPolicy instances.
 
const std::vector< std::unique_ptr< ReactionChainPolicy > > & get_chain_policies () const
 Returns the vector of child ReactionChainPolicy instances.
 
const reaction::ReactionSet & get_reactions () const override
 Returns the combined ReactionSet of all child chain policies.
 
bool contains (const std::string &id) const override
 Checks if the MultiReactionChainPolicy contains a reaction by ID.
 
bool contains (const reaction::Reaction &reaction) const override
 Checks if the MultiReactionChainPolicy contains a specific reaction.
 
std::unique_ptr< ReactionChainPolicy > clone () const override
 Creates a deep copy of the MultiReactionChainPolicy.
 
std::string name () const override
 Returns the name of the MultiReactionChainPolicy.
 
uint64_t hash (uint64_t seed) const override
 Computes a hash value for the MultiReactionChainPolicy.
 
bool operator== (const ReactionChainPolicy &other) const override
 Equality comparison operator.
 
bool operator!= (const ReactionChainPolicy &other) const override
 Inequality comparison operator.
 
size_t size () const
 Returns the number of child ReactionChainPolicy instances.
 
auto begin ()
 Returns iterator to the beginning of the child ReactionChainPolicy instances.
 
auto begin () const
 Returns const iterator to the beginning of the child ReactionChainPolicy instances.
 
auto end ()
 Returns iterator to the end of the child ReactionChainPolicy instances.
 
auto end () const
 Returns const iterator to the end of the child ReactionChainPolicy instances.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::policy::MultiReactionChainPolicy
std::vector< std::unique_ptr< ReactionChainPolicy > > m_chain_policies {}
 Child chain policies.
 
reaction::ReactionSet m_reactions
 Combined reactions from all child policies.
 
+

Detailed Description

+

Main Sequence Reaction Chain Policy.

+

This class implements the main sequence reaction chains, combining the Proton-Proton chain and the CNO cycle. Enforcing this chain in the policy will ensure that all the primary reactions for main sequence stars are included in the network.

+
See also
ProtonProtonChainPolicy
+
+CNOChainPolicy
+

Constructor & Destructor Documentation

+ +

◆ MainSequenceReactionChainPolicy()

+ +
+
+ + + + + + + +
gridfire::policy::MainSequenceReactionChainPolicy::MainSequenceReactionChainPolicy ()
+
+ +
+
+

Member Function Documentation

+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::policy::MainSequenceReactionChainPolicy::name () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy.js b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy.js new file mode 100644 index 00000000..b646e748 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy.js @@ -0,0 +1,5 @@ +var classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy = +[ + [ "MainSequenceReactionChainPolicy", "classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy.html#ae5835bde640ea7af5752a09c2be1c6cf", null ], + [ "name", "classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy.html#a7411e9a885d7ebb79590d8e1c5834881", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__coll__graph.map b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__coll__graph.map new file mode 100644 index 00000000..131db8e5 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__coll__graph.map @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__coll__graph.md5 b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__coll__graph.md5 new file mode 100644 index 00000000..db18b9dd --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__coll__graph.md5 @@ -0,0 +1 @@ +8b9f1f47e8a9021af886d73d333c39e6 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__coll__graph.svg b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__coll__graph.svg new file mode 100644 index 00000000..abf2bb7e --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__coll__graph.svg @@ -0,0 +1,362 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::MainSequenceReactionChainPolicy + + +Node1 + + +gridfire::policy::MainSequence +ReactionChainPolicy + + + + + +Node2 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node5 + + +std::unique_ptr< gridfire +::policy::ReactionChainPolicy > + + + + + +Node3->Node5 + + + + + + ptr + + + +Node4 + + +std::vector< std::unique +_ptr< gridfire::policy +::ReactionChainPolicy > > + + + + + +Node4->Node2 + + + + + + m_chain_policies + + + +Node5->Node4 + + + + + + elements + + + +Node6 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node2 + + + + + + m_reactions + + + +Node7 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node7->Node6 + + + + + + m_reactions + + + +Node8 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node8->Node7 + + + + + + elements + + + +Node9 + + +gridfire::reaction +::Reaction + + + + + +Node9->Node8 + + + + + + ptr + + + +Node10 + + +std::string + + + + + +Node10->Node6 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node10->Node12 + + + + + + keys + + + +Node11 + + +std::basic_string< + Char > + + + + + +Node11->Node10 + + + + + + + + +Node12->Node6 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node6 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__coll__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__coll__graph_org.svg new file mode 100644 index 00000000..34ea2a60 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__coll__graph_org.svg @@ -0,0 +1,280 @@ + + + + + + +gridfire::policy::MainSequenceReactionChainPolicy + + +Node1 + + +gridfire::policy::MainSequence +ReactionChainPolicy + + + + + +Node2 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node5 + + +std::unique_ptr< gridfire +::policy::ReactionChainPolicy > + + + + + +Node3->Node5 + + + + + + ptr + + + +Node4 + + +std::vector< std::unique +_ptr< gridfire::policy +::ReactionChainPolicy > > + + + + + +Node4->Node2 + + + + + + m_chain_policies + + + +Node5->Node4 + + + + + + elements + + + +Node6 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node2 + + + + + + m_reactions + + + +Node7 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node7->Node6 + + + + + + m_reactions + + + +Node8 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node8->Node7 + + + + + + elements + + + +Node9 + + +gridfire::reaction +::Reaction + + + + + +Node9->Node8 + + + + + + ptr + + + +Node10 + + +std::string + + + + + +Node10->Node6 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node10->Node12 + + + + + + keys + + + +Node11 + + +std::basic_string< + Char > + + + + + +Node11->Node10 + + + + + + + + +Node12->Node6 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node6 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__inherit__graph.map new file mode 100644 index 00000000..133c7cf0 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..68912403 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +05297dc8196decf8c68e21ab0986e9ab \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..77e95258 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__inherit__graph.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + +gridfire::policy::MainSequenceReactionChainPolicy + + +Node1 + + +gridfire::policy::MainSequence +ReactionChainPolicy + + + + + +Node2 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..0c62c859 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy__inherit__graph_org.svg @@ -0,0 +1,60 @@ + + + + + + +gridfire::policy::MainSequenceReactionChainPolicy + + +Node1 + + +gridfire::policy::MainSequence +ReactionChainPolicy + + + + + +Node2 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy-members.html new file mode 100644 index 00000000..75cc03f0 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy-members.html @@ -0,0 +1,128 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::MultiReactionChainPolicy Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + +
begin()gridfire::policy::MultiReactionChainPolicyinline
begin() constgridfire::policy::MultiReactionChainPolicyinline
clone() const overridegridfire::policy::MultiReactionChainPolicyvirtual
contains(const std::string &id) const overridegridfire::policy::MultiReactionChainPolicyvirtual
contains(const reaction::Reaction &reaction) const overridegridfire::policy::MultiReactionChainPolicyvirtual
end()gridfire::policy::MultiReactionChainPolicyinline
end() constgridfire::policy::MultiReactionChainPolicyinline
get_chain_policies() constgridfire::policy::MultiReactionChainPolicy
get_reactions() const overridegridfire::policy::MultiReactionChainPolicyvirtual
hash(uint64_t seed) const overridegridfire::policy::MultiReactionChainPolicyvirtual
m_chain_policiesgridfire::policy::MultiReactionChainPolicyprotected
m_reactionsgridfire::policy::MultiReactionChainPolicyprotected
MultiReactionChainPolicy(std::vector< std::unique_ptr< ReactionChainPolicy > > &&chain_policies)gridfire::policy::MultiReactionChainPolicyexplicit
name() const overridegridfire::policy::MultiReactionChainPolicyvirtual
operator!=(const ReactionChainPolicy &other) const overridegridfire::policy::MultiReactionChainPolicyvirtual
operator==(const ReactionChainPolicy &other) const overridegridfire::policy::MultiReactionChainPolicyvirtual
size() constgridfire::policy::MultiReactionChainPolicy
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy.html b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy.html new file mode 100644 index 00000000..fd353c9f --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy.html @@ -0,0 +1,764 @@ + + + + + + + +GridFire: gridfire::policy::MultiReactionChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Protected Attributes | +List of all members
+
gridfire::policy::MultiReactionChainPolicy Class Reference
+
+
+ +

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

+ +

#include <policy_logical.h>

+
+Inheritance diagram for gridfire::policy::MultiReactionChainPolicy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::policy::MultiReactionChainPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 MultiReactionChainPolicy (std::vector< std::unique_ptr< ReactionChainPolicy > > &&chain_policies)
 Constructs a MultiReactionChainPolicy from a vector of ReactionChainPolicy instances.
 
const std::vector< std::unique_ptr< ReactionChainPolicy > > & get_chain_policies () const
 Returns the vector of child ReactionChainPolicy instances.
 
const reaction::ReactionSet & get_reactions () const override
 Returns the combined ReactionSet of all child chain policies.
 
bool contains (const std::string &id) const override
 Checks if the MultiReactionChainPolicy contains a reaction by ID.
 
bool contains (const reaction::Reaction &reaction) const override
 Checks if the MultiReactionChainPolicy contains a specific reaction.
 
std::unique_ptr< ReactionChainPolicy > clone () const override
 Creates a deep copy of the MultiReactionChainPolicy.
 
std::string name () const override
 Returns the name of the MultiReactionChainPolicy.
 
uint64_t hash (uint64_t seed) const override
 Computes a hash value for the MultiReactionChainPolicy.
 
bool operator== (const ReactionChainPolicy &other) const override
 Equality comparison operator.
 
bool operator!= (const ReactionChainPolicy &other) const override
 Inequality comparison operator.
 
size_t size () const
 Returns the number of child ReactionChainPolicy instances.
 
auto begin ()
 Returns iterator to the beginning of the child ReactionChainPolicy instances.
 
auto begin () const
 Returns const iterator to the beginning of the child ReactionChainPolicy instances.
 
auto end ()
 Returns iterator to the end of the child ReactionChainPolicy instances.
 
auto end () const
 Returns const iterator to the end of the child ReactionChainPolicy instances.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + + + +

+Protected Attributes

std::vector< std::unique_ptr< ReactionChainPolicy > > m_chain_policies {}
 Child chain policies.
 
reaction::ReactionSet m_reactions
 Combined reactions from all child policies.
 
+

Detailed Description

+

A ReactionChainPolicy composed of multiple child ReactionChainPolicy instances.

+

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

+
Example
LowMassMainSequenceReactionChainPolicy multi;
+
const auto &chains = multi.get_chain_policies();
+
for (const auto &ch : chains) { std::cout << ch->get_reactions().size() << " reactions\n"; }
+
+

Constructor & Destructor Documentation

+ +

◆ MultiReactionChainPolicy()

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::policy::MultiReactionChainPolicy::MultiReactionChainPolicy (std::vector< std::unique_ptr< ReactionChainPolicy > > && chain_policies)
+ 		+explicit
+
+ +

Constructs a MultiReactionChainPolicy from a vector of ReactionChainPolicy instances.

+

The provided chain policies are moved into the new MultiReactionChainPolicy instance.

+
Parameters
+ + +
chain_policiesvector of unique_ptr to ReactionChainPolicy instances.
+
+
+
Example
std::vector<std::unique_ptr<ReactionChainPolicy>> chains;
+
chains.push_back(std::make_unique<ProtonProtonChainPolicy>());
+
chains.push_back(std::make_unique<CNOChainPolicy>());
+
MultiReactionChainPolicy multi(std::move(chains));
+
gridfire::policy::MultiReactionChainPolicy
A ReactionChainPolicy composed of multiple child ReactionChainPolicy instances.
Definition policy_logical.h:23
+
+ +
+
+

Member Function Documentation

+ +

◆ begin() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
auto gridfire::policy::MultiReactionChainPolicy::begin ()
+ 		+inline
+
+ +

Returns iterator to the beginning of the child ReactionChainPolicy instances.

+
Returns
iterator to the beginning.
+
Example
for (auto it = multi.begin(); it != multi.end(); ++it) {
+
std::cout << (*it)->name() << std::endl;
+
}
+
+ +
+
+ +

◆ begin() [2/2]

+ +
+
+ + + + + +
+ + + + + + + +
auto gridfire::policy::MultiReactionChainPolicy::begin () const
+ 		+inline
+
+ +

Returns const iterator to the beginning of the child ReactionChainPolicy instances.

+
Returns
const iterator to the beginning.
+
Example
for (auto it = multi.begin(); it != multi.end(); ++it) {
+
std::cout << (*it)->name() << std::endl;
+
}
+
+ +
+
+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< ReactionChainPolicy > gridfire::policy::MultiReactionChainPolicy::clone () const
+ 		+overridevirtual
+
+ +

Creates a deep copy of the MultiReactionChainPolicy.

+
Returns
std::unique_ptr<ReactionChainPolicy> unique pointer to the cloned instance.
+
Example
std::unique_ptr<ReactionChainPolicy> clone = multi.clone();
+
gridfire::policy::MultiReactionChainPolicy::clone
std::unique_ptr< ReactionChainPolicy > clone() const override
Creates a deep copy of the MultiReactionChainPolicy.
Definition policy_logical.cpp:32
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ contains() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::policy::MultiReactionChainPolicy::contains (const reaction::Reaction & reaction) const
+ 		+overridevirtual
+
+ +

Checks if the MultiReactionChainPolicy contains a specific reaction.

+
Parameters
+ + +
reactionthe Reaction to check for.
+
+
+
Returns
true if the reaction is present in the combined ReactionSet, false otherwise.
+
Example
reaction::Reaction r = ...; // obtain a Reaction instance
+
bool has_reaction = multi.contains(r);
+
gridfire::reaction::Reaction
Represents a single nuclear reaction from a specific data source.
Definition reaction.h:98
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ contains() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::policy::MultiReactionChainPolicy::contains (const std::string & id) const
+ 		+overridevirtual
+
+ +

Checks if the MultiReactionChainPolicy contains a reaction by ID.

+
Parameters
+ + +
idthe reaction ID to check for.
+
+
+
Returns
true if the reaction ID is present in the combined ReactionSet, false otherwise.
+
Example
bool has_pp = multi.contains("p(p,e+)d");
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ end() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
auto gridfire::policy::MultiReactionChainPolicy::end ()
+ 		+inline
+
+ +

Returns iterator to the end of the child ReactionChainPolicy instances.

+
Returns
iterator to the end.
+
Example
for (auto it = multi.begin(); it != multi.end(); ++it) {
+
std::cout << (*it)->name() << std::endl;
+
}
+
+ +
+
+ +

◆ end() [2/2]

+ +
+
+ + + + + +
+ + + + + + + +
auto gridfire::policy::MultiReactionChainPolicy::end () const
+ 		+inline
+
+ +

Returns const iterator to the end of the child ReactionChainPolicy instances.

+
Returns
const iterator to the end.
+
Example
for (auto it = multi.begin(); it != multi.end(); ++it) {
+
std::cout << (*it)->name() << std::endl;
+
}
+
+ +
+
+ +

◆ get_chain_policies()

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

Returns the vector of child ReactionChainPolicy instances.

+
Returns
const std::vector<std::unique_ptr<ReactionChainPolicy>>& reference to the child chain policies.
+
Example
const auto &chains = multi.get_chain_policies();
+
for (const auto &ch : chains) { std::cout << ch->get_reactions().size() << " reactions\n"; }
+
+ +
+
+ +

◆ get_reactions()

+ +
+
+ + + + + +
+ + + + + + + +
const reaction::ReactionSet & gridfire::policy::MultiReactionChainPolicy::get_reactions () const
+ 		+overridevirtual
+
+ +

Returns the combined ReactionSet of all child chain policies.

+
Returns
const reaction::ReactionSet& reference to the combined reactions.
+
Example
const auto &reactions = multi.get_reactions();
+
std::cout << "Multi chain contains " << reactions.size() << " reactions\n";
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ hash()

+ +
+
+ + + + + +
+ + + + + + + + +
uint64_t gridfire::policy::MultiReactionChainPolicy::hash (uint64_t seed) const
+ 		+overridevirtual
+
+ +

Computes a hash value for the MultiReactionChainPolicy.

+
Parameters
+ + +
seedthe seed value for the hash computation.
+
+
+
Returns
uint64_t the computed hash value.
+
Example
uint64_t h = multi.hash(0);
+
std::cout << "Policy hash: " << h << std::endl;
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::policy::MultiReactionChainPolicy::name () const
+ 		+overridevirtual
+
+ +

Returns the name of the MultiReactionChainPolicy.

+
Returns
std::string the name of the policy.
+
Example
std::string n = multi.name();
+
std::cout << "Using policy: " << n << std::endl;
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +

Reimplemented in gridfire::policy::ProtonProtonChainPolicy.

+ +
+
+ +

◆ operator!=()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::policy::MultiReactionChainPolicy::operator!= (const ReactionChainPolicy & other) const
+ 		+overridevirtual
+
+ +

Inequality comparison operator.

+
Parameters
+ + +
otherthe other ReactionChainPolicy to compare against.
+
+
+
Returns
true if the policies are not equal, false otherwise.
+
Example
bool not_equal = (multi1 != multi2);
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ operator==()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::policy::MultiReactionChainPolicy::operator== (const ReactionChainPolicy & other) const
+ 		+overridevirtual
+
+ +

Equality comparison operator.

+
Parameters
+ + +
otherthe other ReactionChainPolicy to compare against.
+
+
+
Returns
true if the policies are equal, false otherwise.
+
Example
bool equal = (multi1 == multi2);
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ size()

+ +
+
+ + + + + + + +
size_t gridfire::policy::MultiReactionChainPolicy::size () const
+
+ +

Returns the number of child ReactionChainPolicy instances.

+
Returns
size_t the number of child chain policies.
+
Example
size_t n = multi.size();
+
std::cout << "Multi chain has " << n << " child policies\n";
+
+ +
+
+

Member Data Documentation

+ +

◆ m_chain_policies

+ +
+
+ + + + + +
+ + + + +
std::vector<std::unique_ptr<ReactionChainPolicy> > gridfire::policy::MultiReactionChainPolicy::m_chain_policies {}
+ 		+protected
+
+ +

Child chain policies.

+ +
+
+ +

◆ m_reactions

+ +
+
+ + + + + +
+ + + + +
reaction::ReactionSet gridfire::policy::MultiReactionChainPolicy::m_reactions
+ 		+protected
+
+ +

Combined reactions from all child policies.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy.js b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy.js new file mode 100644 index 00000000..535c7f65 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy.js @@ -0,0 +1,20 @@ +var classgridfire_1_1policy_1_1MultiReactionChainPolicy = +[ + [ "MultiReactionChainPolicy", "classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ab0e3ba293b5e52d595dfa02db4fcbee7", null ], + [ "begin", "classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#a2317c6351bb1fc07ff0a27cd358b4f73", null ], + [ "begin", "classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#a6b340b7bdb8cf9e32f004074b1901815", null ], + [ "clone", "classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ab3bbbf21164211a01c5398a0ee281bb2", null ], + [ "contains", "classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#a864a00097e80db7b0f3838d696aa9f5d", null ], + [ "contains", "classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#a792cf0af8e5c365d0332cd585968dae1", null ], + [ "end", "classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#aaa71cb8b9c72af7047c4ae54b8c33915", null ], + [ "end", "classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#a8f2f648e161d1935c27729bcd6054187", null ], + [ "get_chain_policies", "classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#aeec13e231994234c1ae2b12a0dd7220b", null ], + [ "get_reactions", "classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ae689a0dfeb36f85ddc6db5a8dc4f630a", null ], + [ "hash", "classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ae5ac6534ec96cfcdefcad2f9694efd36", null ], + [ "name", "classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ac21f837d0d452d32588451f48d5482e6", null ], + [ "operator!=", "classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#aa36844fe4417617175d31124e541da50", null ], + [ "operator==", "classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#abc3ed7c255b3e6c06e292aee8ef7f46d", null ], + [ "size", "classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#a84fcdc2adab96284d850f8dd43315278", null ], + [ "m_chain_policies", "classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#a8ef92bf3b66d77f8141bb6010e909e99", null ], + [ "m_reactions", "classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#adaf3fa4b8cd0fde5994f54494701c32d", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__coll__graph.map b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__coll__graph.map new file mode 100644 index 00000000..3986b5ff --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__coll__graph.map @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__coll__graph.md5 b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__coll__graph.md5 new file mode 100644 index 00000000..ed94dc5e --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__coll__graph.md5 @@ -0,0 +1 @@ +5e3e7637cd3f2e7f8e0c1f574c4a303b \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__coll__graph.svg b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__coll__graph.svg new file mode 100644 index 00000000..3e9d35ba --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__coll__graph.svg @@ -0,0 +1,343 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::MultiReactionChainPolicy + + +Node1 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node2 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node4 + + +std::unique_ptr< gridfire +::policy::ReactionChainPolicy > + + + + + +Node2->Node4 + + + + + + ptr + + + +Node3 + + +std::vector< std::unique +_ptr< gridfire::policy +::ReactionChainPolicy > > + + + + + +Node3->Node1 + + + + + + m_chain_policies + + + +Node4->Node3 + + + + + + elements + + + +Node5 + + +gridfire::reaction +::ReactionSet + + + + + +Node5->Node1 + + + + + + m_reactions + + + +Node6 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node6->Node5 + + + + + + m_reactions + + + +Node7 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node7->Node6 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::Reaction + + + + + +Node8->Node7 + + + + + + ptr + + + +Node9 + + +std::string + + + + + +Node9->Node5 + + + + + + m_id + + + +Node11 + + +std::unordered_map +< std::string, size_t > + + + + + +Node9->Node11 + + + + + + keys + + + +Node10 + + +std::basic_string< + Char > + + + + + +Node10->Node9 + + + + + + + + +Node11->Node5 + + + + + + m_reactionNameMap + + + +Node12 + + +std::unordered_set +< size_t > + + + + + +Node12->Node5 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__coll__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__coll__graph_org.svg new file mode 100644 index 00000000..465fd78b --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__coll__graph_org.svg @@ -0,0 +1,261 @@ + + + + + + +gridfire::policy::MultiReactionChainPolicy + + +Node1 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node2 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node4 + + +std::unique_ptr< gridfire +::policy::ReactionChainPolicy > + + + + + +Node2->Node4 + + + + + + ptr + + + +Node3 + + +std::vector< std::unique +_ptr< gridfire::policy +::ReactionChainPolicy > > + + + + + +Node3->Node1 + + + + + + m_chain_policies + + + +Node4->Node3 + + + + + + elements + + + +Node5 + + +gridfire::reaction +::ReactionSet + + + + + +Node5->Node1 + + + + + + m_reactions + + + +Node6 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node6->Node5 + + + + + + m_reactions + + + +Node7 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node7->Node6 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::Reaction + + + + + +Node8->Node7 + + + + + + ptr + + + +Node9 + + +std::string + + + + + +Node9->Node5 + + + + + + m_id + + + +Node11 + + +std::unordered_map +< std::string, size_t > + + + + + +Node9->Node11 + + + + + + keys + + + +Node10 + + +std::basic_string< + Char > + + + + + +Node10->Node9 + + + + + + + + +Node11->Node5 + + + + + + m_reactionNameMap + + + +Node12 + + +std::unordered_set +< size_t > + + + + + +Node12->Node5 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__inherit__graph.map new file mode 100644 index 00000000..1179415d --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__inherit__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..fe88d14f --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +f92d5d4ecd32fca68e5bcf991eb1a1ca \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..659658d2 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__inherit__graph.svg @@ -0,0 +1,199 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::MultiReactionChainPolicy + + +Node1 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node3 + + +gridfire::policy::CNOChain +Policy + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::policy::HotCNOChain +Policy + + + + + +Node1->Node4 + + + + + + + + +Node5 + + +gridfire::policy::MainSequence +ReactionChainPolicy + + + + + +Node1->Node5 + + + + + + + + +Node6 + + +gridfire::policy::Proton +ProtonChainPolicy + + + + + +Node1->Node6 + + + + + + + + +Node2 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..a43b8a62 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1MultiReactionChainPolicy__inherit__graph_org.svg @@ -0,0 +1,117 @@ + + + + + + +gridfire::policy::MultiReactionChainPolicy + + +Node1 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node3 + + +gridfire::policy::CNOChain +Policy + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::policy::HotCNOChain +Policy + + + + + +Node1->Node4 + + + + + + + + +Node5 + + +gridfire::policy::MainSequence +ReactionChainPolicy + + + + + +Node1->Node5 + + + + + + + + +Node6 + + +gridfire::policy::Proton +ProtonChainPolicy + + + + + +Node1->Node6 + + + + + + + + +Node2 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1NetworkPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1NetworkPolicy-members.html new file mode 100644 index 00000000..e30326a7 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1NetworkPolicy-members.html @@ -0,0 +1,119 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::NetworkPolicy Member List
+
+
+ +

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

+ + + + + + + + + + +
construct()=0gridfire::policy::NetworkPolicypure virtual
get_engine_stack() const =0gridfire::policy::NetworkPolicypure virtual
get_engine_types_stack() const =0gridfire::policy::NetworkPolicypure virtual
get_partition_function() const =0gridfire::policy::NetworkPolicypure virtual
get_seed_reactions() const =0gridfire::policy::NetworkPolicypure virtual
get_seed_species() const =0gridfire::policy::NetworkPolicypure virtual
get_status() const =0gridfire::policy::NetworkPolicypure virtual
name() const =0gridfire::policy::NetworkPolicypure virtual
~NetworkPolicy()=defaultgridfire::policy::NetworkPolicyvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1NetworkPolicy.html b/docs/html/classgridfire_1_1policy_1_1NetworkPolicy.html new file mode 100644 index 00000000..a78ebd4d --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1NetworkPolicy.html @@ -0,0 +1,457 @@ + + + + + + + +GridFire: gridfire::policy::NetworkPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::policy::NetworkPolicy Class Referenceabstract
+
+
+ +

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

+ +

#include <policy_abstract.h>

+
+Inheritance diagram for gridfire::policy::NetworkPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

virtual ~NetworkPolicy ()=default
 
virtual std::string name () const =0
 Human-readable name for the policy.
 
virtual const std::set< fourdst::atomic::Species > & get_seed_species () const =0
 Returns the seed species the policy requires to initialize the network.
 
virtual const reaction::ReactionSet & get_seed_reactions () const =0
 Returns the set of seed reactions the policy requires.
 
virtual engine::DynamicEngine & construct ()=0
 Construct and return a DynamicEngine instance (or engine view stack) satisfying the policy.
 
virtual NetworkPolicyStatus get_status () const =0
 Returns the current verification/construction status of the policy.
 
virtual const std::vector< std::unique_ptr< engine::DynamicEngine > > & get_engine_stack () const =0
 
virtual std::vector< engine::EngineTypes > get_engine_types_stack () const =0
 
virtual const std::unique_ptr< partition::PartitionFunction > & get_partition_function () const =0
 
+

Detailed Description

+

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

+

A NetworkPolicy provides three main pieces of information:

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

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

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

Constructor & Destructor Documentation

+ +

◆ ~NetworkPolicy()

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

Member Function Documentation

+ +

◆ construct()

+ +
+
+ + + + + +
+ + + + + + + +
virtual engine::DynamicEngine & gridfire::policy::NetworkPolicy::construct ()
+ 		+pure virtual
+
+ +

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

+

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

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

Implemented in gridfire::policy::MainSequencePolicy, and PyNetworkPolicy.

+ +
+
+ +

◆ get_engine_stack()

+ +
+
+ + + + + +
+ + + + + + + +
virtual const std::vector< std::unique_ptr< engine::DynamicEngine > > & gridfire::policy::NetworkPolicy::get_engine_stack () const
+ 		+pure virtual
+
+ +

Implemented in gridfire::policy::MainSequencePolicy, and PyNetworkPolicy.

+ +
+
+ +

◆ get_engine_types_stack()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::vector< engine::EngineTypes > gridfire::policy::NetworkPolicy::get_engine_types_stack () const
+ 		+pure virtual
+
+ +

Implemented in gridfire::policy::MainSequencePolicy, and PyNetworkPolicy.

+ +
+
+ +

◆ get_partition_function()

+ +
+
+ + + + + +
+ + + + + + + +
virtual const std::unique_ptr< partition::PartitionFunction > & gridfire::policy::NetworkPolicy::get_partition_function () const
+ 		+pure virtual
+
+ +

Implemented in gridfire::policy::MainSequencePolicy, and PyNetworkPolicy.

+ +
+
+ +

◆ get_seed_reactions()

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

Returns the set of seed reactions the policy requires.

+

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

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

Implemented in gridfire::policy::MainSequencePolicy, and PyNetworkPolicy.

+ +
+
+ +

◆ get_seed_species()

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

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

+

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

+

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

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

Implemented in gridfire::policy::MainSequencePolicy, and PyNetworkPolicy.

+ +
+
+ +

◆ get_status()

+ +
+
+ + + + + +
+ + + + + + + +
virtual NetworkPolicyStatus gridfire::policy::NetworkPolicy::get_status () const
+ 		+pure virtual
+
+ +

Returns the current verification/construction status of the policy.

+

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

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

Implemented in gridfire::policy::MainSequencePolicy, and PyNetworkPolicy.

+ +
+
+ +

◆ name()

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

Human-readable name for the policy.

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

Implemented in gridfire::policy::MainSequencePolicy, and PyNetworkPolicy.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1NetworkPolicy.js b/docs/html/classgridfire_1_1policy_1_1NetworkPolicy.js new file mode 100644 index 00000000..f4c2e754 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1NetworkPolicy.js @@ -0,0 +1,12 @@ +var classgridfire_1_1policy_1_1NetworkPolicy = +[ + [ "~NetworkPolicy", "classgridfire_1_1policy_1_1NetworkPolicy.html#a0d32c22a2d3794c328e8dd24d2cda2be", null ], + [ "construct", "classgridfire_1_1policy_1_1NetworkPolicy.html#a13cd74c967592392b01d8fe9a5b34d88", null ], + [ "get_engine_stack", "classgridfire_1_1policy_1_1NetworkPolicy.html#a92891fe37b8684fe9f1c5958674de2d5", null ], + [ "get_engine_types_stack", "classgridfire_1_1policy_1_1NetworkPolicy.html#aac63625678d287d0ca36c98f51e86dd2", null ], + [ "get_partition_function", "classgridfire_1_1policy_1_1NetworkPolicy.html#a1c395eb83b0bcf728db230e7772aabcf", null ], + [ "get_seed_reactions", "classgridfire_1_1policy_1_1NetworkPolicy.html#aa33fcee020f5acd8e14aadaf3758ad2f", null ], + [ "get_seed_species", "classgridfire_1_1policy_1_1NetworkPolicy.html#afb599d76b423f7a39b322c967302b49b", null ], + [ "get_status", "classgridfire_1_1policy_1_1NetworkPolicy.html#a3d0f2aee8ead71da4d421fb659fb30f7", null ], + [ "name", "classgridfire_1_1policy_1_1NetworkPolicy.html#aa59c1baf7077a5d35d45ff753b32a565", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1NetworkPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1NetworkPolicy__inherit__graph.map new file mode 100644 index 00000000..626c58e0 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1NetworkPolicy__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1NetworkPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1NetworkPolicy__inherit__graph.md5 new file mode 100644 index 00000000..c17862b5 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1NetworkPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +d7ded68581f7b67e55b045e96a551787 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1NetworkPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1NetworkPolicy__inherit__graph.svg new file mode 100644 index 00000000..5186487c --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1NetworkPolicy__inherit__graph.svg @@ -0,0 +1,84 @@ + + + + + + + + + + + +gridfire::policy::NetworkPolicy + + +Node1 + + +gridfire::policy::Network +Policy + + + + + +Node2 + + +PyNetworkPolicy + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::policy::MainSequence +Policy + + + + + +Node1->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1NetworkPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1NetworkPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..72df3c03 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1NetworkPolicy__inherit__graph_org.svg @@ -0,0 +1,59 @@ + + + + + + +gridfire::policy::NetworkPolicy + + +Node1 + + +gridfire::policy::Network +Policy + + + + + +Node2 + + +PyNetworkPolicy + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::policy::MainSequence +Policy + + + + + +Node1->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy-members.html new file mode 100644 index 00000000..e7ded960 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy-members.html @@ -0,0 +1,129 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::ProtonProtonChainPolicy Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + + +
begin()gridfire::policy::MultiReactionChainPolicyinline
begin() constgridfire::policy::MultiReactionChainPolicyinline
clone() const overridegridfire::policy::MultiReactionChainPolicyvirtual
contains(const std::string &id) const overridegridfire::policy::MultiReactionChainPolicyvirtual
contains(const reaction::Reaction &reaction) const overridegridfire::policy::MultiReactionChainPolicyvirtual
end()gridfire::policy::MultiReactionChainPolicyinline
end() constgridfire::policy::MultiReactionChainPolicyinline
get_chain_policies() constgridfire::policy::MultiReactionChainPolicy
get_reactions() const overridegridfire::policy::MultiReactionChainPolicyvirtual
hash(uint64_t seed) const overridegridfire::policy::MultiReactionChainPolicyvirtual
m_chain_policiesgridfire::policy::ProtonProtonChainPolicyprivate
m_reactionsgridfire::policy::MultiReactionChainPolicyprotected
MultiReactionChainPolicy(std::vector< std::unique_ptr< ReactionChainPolicy > > &&chain_policies)gridfire::policy::MultiReactionChainPolicyexplicit
name() const overridegridfire::policy::ProtonProtonChainPolicyvirtual
operator!=(const ReactionChainPolicy &other) const overridegridfire::policy::MultiReactionChainPolicyvirtual
operator==(const ReactionChainPolicy &other) const overridegridfire::policy::MultiReactionChainPolicyvirtual
ProtonProtonChainPolicy()gridfire::policy::ProtonProtonChainPolicy
size() constgridfire::policy::MultiReactionChainPolicy
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy.html b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy.html new file mode 100644 index 00000000..9f5964d2 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy.html @@ -0,0 +1,284 @@ + + + + + + + +GridFire: gridfire::policy::ProtonProtonChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
gridfire::policy::ProtonProtonChainPolicy Class Referencefinal
+
+
+ +

Proton-Proton Chain Policy. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::ProtonProtonChainPolicy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::policy::ProtonProtonChainPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 ProtonProtonChainPolicy ()
 
std::string name () const override
 Returns the name of the MultiReactionChainPolicy.
 
- Public Member Functions inherited from gridfire::policy::MultiReactionChainPolicy
 MultiReactionChainPolicy (std::vector< std::unique_ptr< ReactionChainPolicy > > &&chain_policies)
 Constructs a MultiReactionChainPolicy from a vector of ReactionChainPolicy instances.
 
const std::vector< std::unique_ptr< ReactionChainPolicy > > & get_chain_policies () const
 Returns the vector of child ReactionChainPolicy instances.
 
const reaction::ReactionSet & get_reactions () const override
 Returns the combined ReactionSet of all child chain policies.
 
bool contains (const std::string &id) const override
 Checks if the MultiReactionChainPolicy contains a reaction by ID.
 
bool contains (const reaction::Reaction &reaction) const override
 Checks if the MultiReactionChainPolicy contains a specific reaction.
 
std::unique_ptr< ReactionChainPolicy > clone () const override
 Creates a deep copy of the MultiReactionChainPolicy.
 
uint64_t hash (uint64_t seed) const override
 Computes a hash value for the MultiReactionChainPolicy.
 
bool operator== (const ReactionChainPolicy &other) const override
 Equality comparison operator.
 
bool operator!= (const ReactionChainPolicy &other) const override
 Inequality comparison operator.
 
size_t size () const
 Returns the number of child ReactionChainPolicy instances.
 
auto begin ()
 Returns iterator to the beginning of the child ReactionChainPolicy instances.
 
auto begin () const
 Returns const iterator to the beginning of the child ReactionChainPolicy instances.
 
auto end ()
 Returns iterator to the end of the child ReactionChainPolicy instances.
 
auto end () const
 Returns const iterator to the end of the child ReactionChainPolicy instances.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + +

+Private Attributes

std::vector< std::unique_ptr< ReactionChainPolicy > > m_chain_policies
 
+ + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::policy::MultiReactionChainPolicy
std::vector< std::unique_ptr< ReactionChainPolicy > > m_chain_policies {}
 Child chain policies.
 
reaction::ReactionSet m_reactions
 Combined reactions from all child policies.
 
+

Detailed Description

+

Proton-Proton Chain Policy.

+

This class implements the overall Proton-Proton chain of nuclear reactions, combining the Proton-Proton I, II, and III chains. Enforcing this chain in the policy will ensure that all the Proton-Proton reactions are included in the network.

+
See also
ProtonProtonIChainPolicy
+
+ProtonProtonIIChainPolicy
+
+ProtonProtonIIIChainPolicy
+

Constructor & Destructor Documentation

+ +

◆ ProtonProtonChainPolicy()

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

Member Function Documentation

+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::policy::ProtonProtonChainPolicy::name () const
+ 		+overridevirtual
+
+ +

Returns the name of the MultiReactionChainPolicy.

+
Returns
std::string the name of the policy.
+
Example
std::string n = multi.name();
+
std::cout << "Using policy: " << n << std::endl;
+
+ +

Reimplemented from gridfire::policy::MultiReactionChainPolicy.

+ +
+
+

Member Data Documentation

+ +

◆ m_chain_policies

+ +
+
+ + + + + +
+ + + + +
std::vector<std::unique_ptr<ReactionChainPolicy> > gridfire::policy::ProtonProtonChainPolicy::m_chain_policies
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy.js b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy.js new file mode 100644 index 00000000..f371ff63 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy.js @@ -0,0 +1,6 @@ +var classgridfire_1_1policy_1_1ProtonProtonChainPolicy = +[ + [ "ProtonProtonChainPolicy", "classgridfire_1_1policy_1_1ProtonProtonChainPolicy.html#a0700dc96acfae24b242e5556a1bcbf26", null ], + [ "name", "classgridfire_1_1policy_1_1ProtonProtonChainPolicy.html#a2e818c9a269bc859b01985fea8423ac0", null ], + [ "m_chain_policies", "classgridfire_1_1policy_1_1ProtonProtonChainPolicy.html#a43d461d976f9cff765db92c05765d0a3", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__coll__graph.map b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__coll__graph.map new file mode 100644 index 00000000..2b88352c --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__coll__graph.map @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__coll__graph.md5 b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__coll__graph.md5 new file mode 100644 index 00000000..092428e6 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__coll__graph.md5 @@ -0,0 +1 @@ +2e5e17b2ec34dd4022f1a4265d157024 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__coll__graph.svg b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__coll__graph.svg new file mode 100644 index 00000000..62461d31 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__coll__graph.svg @@ -0,0 +1,372 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::ProtonProtonChainPolicy + + +Node1 + + +gridfire::policy::Proton +ProtonChainPolicy + + + + + +Node2 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node5 + + +std::unique_ptr< gridfire +::policy::ReactionChainPolicy > + + + + + +Node3->Node5 + + + + + + ptr + + + +Node4 + + +std::vector< std::unique +_ptr< gridfire::policy +::ReactionChainPolicy > > + + + + + +Node4->Node1 + + + + + + m_chain_policies + + + +Node4->Node2 + + + + + + m_chain_policies + + + +Node5->Node4 + + + + + + elements + + + +Node6 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node2 + + + + + + m_reactions + + + +Node7 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node7->Node6 + + + + + + m_reactions + + + +Node8 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node8->Node7 + + + + + + elements + + + +Node9 + + +gridfire::reaction +::Reaction + + + + + +Node9->Node8 + + + + + + ptr + + + +Node10 + + +std::string + + + + + +Node10->Node6 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node10->Node12 + + + + + + keys + + + +Node11 + + +std::basic_string< + Char > + + + + + +Node11->Node10 + + + + + + + + +Node12->Node6 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node6 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__coll__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__coll__graph_org.svg new file mode 100644 index 00000000..9e40dae0 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__coll__graph_org.svg @@ -0,0 +1,290 @@ + + + + + + +gridfire::policy::ProtonProtonChainPolicy + + +Node1 + + +gridfire::policy::Proton +ProtonChainPolicy + + + + + +Node2 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node5 + + +std::unique_ptr< gridfire +::policy::ReactionChainPolicy > + + + + + +Node3->Node5 + + + + + + ptr + + + +Node4 + + +std::vector< std::unique +_ptr< gridfire::policy +::ReactionChainPolicy > > + + + + + +Node4->Node1 + + + + + + m_chain_policies + + + +Node4->Node2 + + + + + + m_chain_policies + + + +Node5->Node4 + + + + + + elements + + + +Node6 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node2 + + + + + + m_reactions + + + +Node7 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node7->Node6 + + + + + + m_reactions + + + +Node8 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node8->Node7 + + + + + + elements + + + +Node9 + + +gridfire::reaction +::Reaction + + + + + +Node9->Node8 + + + + + + ptr + + + +Node10 + + +std::string + + + + + +Node10->Node6 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node10->Node12 + + + + + + keys + + + +Node11 + + +std::basic_string< + Char > + + + + + +Node11->Node10 + + + + + + + + +Node12->Node6 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node6 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__inherit__graph.map new file mode 100644 index 00000000..e0cbb757 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..347f35cc --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +e149383812a9634de38372f07a0e86fe \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..9f2b58eb --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__inherit__graph.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + +gridfire::policy::ProtonProtonChainPolicy + + +Node1 + + +gridfire::policy::Proton +ProtonChainPolicy + + + + + +Node2 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..8093799e --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonChainPolicy__inherit__graph_org.svg @@ -0,0 +1,60 @@ + + + + + + +gridfire::policy::ProtonProtonChainPolicy + + +Node1 + + +gridfire::policy::Proton +ProtonChainPolicy + + + + + +Node2 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy-members.html new file mode 100644 index 00000000..170ce7ee --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy-members.html @@ -0,0 +1,128 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::ProtonProtonIChainPolicy Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + +
clone() const overridegridfire::policy::ProtonProtonIChainPolicyvirtual
contains(const std::string &id) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
contains(const reaction::Reaction &reaction) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
get_reactions() const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
hash(uint64_t seed) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
is_active(double T9) constgridfire::policy::TemperatureDependentChainPolicy
m_reactionIDsgridfire::policy::TemperatureDependentChainPolicyprotected
m_reactionsgridfire::policy::TemperatureDependentChainPolicyprotected
m_tempRangegridfire::policy::TemperatureDependentChainPolicyprotected
name() const overridegridfire::policy::ProtonProtonIChainPolicyvirtual
operator!=(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
operator==(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
ProtonProtonIChainPolicy()gridfire::policy::ProtonProtonIChainPolicy
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
~TemperatureDependentChainPolicy() override=defaultgridfire::policy::TemperatureDependentChainPolicy
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy.html b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy.html new file mode 100644 index 00000000..3421718a --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy.html @@ -0,0 +1,271 @@ + + + + + + + +GridFire: gridfire::policy::ProtonProtonIChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::policy::ProtonProtonIChainPolicy Class Referencefinal
+
+
+ +

Proton-Proton I Chain Policy. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::ProtonProtonIChainPolicy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::policy::ProtonProtonIChainPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 ProtonProtonIChainPolicy ()
 
std::unique_ptr< ReactionChainPolicy > clone () const override
 
std::string name () const override
 
- Public Member Functions inherited from gridfire::policy::TemperatureDependentChainPolicy
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 ~TemperatureDependentChainPolicy () override=default
 Virtual destructor.
 
const reaction::ReactionSet & get_reactions () const override
 Get the reactions that comprise the chain.
 
bool contains (const std::string &id) const override
 Check if a reaction or reaction ID is part of the chain.
 
bool contains (const reaction::Reaction &reaction) const override
 Check if a reaction is part of the chain.
 
uint64_t hash (uint64_t seed) const override
 Generate the hash for the reaction chain policy.
 
bool operator== (const ReactionChainPolicy &other) const override
 Equality operator.
 
bool operator!= (const ReactionChainPolicy &other) const override
 Inequality operator.
 
bool is_active (double T9) const
 Check if the reaction chain is active at a given temperature.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::policy::TemperatureDependentChainPolicy
ActiveTempRange m_tempRange
 Active temperature range for the reaction chain.
 
std::vector< std::string > m_reactionIDs
 Vector of reaction IDs that comprise the chain.
 
reaction::ReactionSet m_reactions
 Set of reactions that comprise the chain.
 
+

Detailed Description

+

Proton-Proton I Chain Policy.

+

This class implements the Proton-Proton I chain of nuclear reactions. This chain's minimum temperature is set to T9=0.001 (or 1e6K). This chain includes reactions:

    +
  • p(p,e+)d
    • +
  • d(p,g)he3
    • +
  • he3(he3,2p)he4
    • +
+

Constructor & Destructor Documentation

+ +

◆ ProtonProtonIChainPolicy()

+ +
+
+ + + + + + + +
gridfire::policy::ProtonProtonIChainPolicy::ProtonProtonIChainPolicy ()
+
+

Specific Implementations *

+ +
+
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< ReactionChainPolicy > gridfire::policy::ProtonProtonIChainPolicy::clone () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::policy::ProtonProtonIChainPolicy::name () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy.js b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy.js new file mode 100644 index 00000000..fbab3d2d --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy.js @@ -0,0 +1,6 @@ +var classgridfire_1_1policy_1_1ProtonProtonIChainPolicy = +[ + [ "ProtonProtonIChainPolicy", "classgridfire_1_1policy_1_1ProtonProtonIChainPolicy.html#a2721f00e9edefeb3d4bfc02a37777a47", null ], + [ "clone", "classgridfire_1_1policy_1_1ProtonProtonIChainPolicy.html#affd234a60ba31decca25b3367c7ede5e", null ], + [ "name", "classgridfire_1_1policy_1_1ProtonProtonIChainPolicy.html#ab9542fd71e87159216cdd51501b6d1d3", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__coll__graph.map b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__coll__graph.map new file mode 100644 index 00000000..c533e1e5 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__coll__graph.map @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__coll__graph.md5 b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__coll__graph.md5 new file mode 100644 index 00000000..d747c177 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__coll__graph.md5 @@ -0,0 +1 @@ +08cc837666a577f5fccc691741316d9e \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__coll__graph.svg b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__coll__graph.svg new file mode 100644 index 00000000..ab524cdb --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__coll__graph.svg @@ -0,0 +1,360 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::ProtonProtonIChainPolicy + + +Node1 + + +gridfire::policy::Proton +ProtonIChainPolicy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__coll__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__coll__graph_org.svg new file mode 100644 index 00000000..d8fbcac9 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__coll__graph_org.svg @@ -0,0 +1,278 @@ + + + + + + +gridfire::policy::ProtonProtonIChainPolicy + + +Node1 + + +gridfire::policy::Proton +ProtonIChainPolicy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__inherit__graph.map new file mode 100644 index 00000000..30abc98d --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..a1df28cd --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +747d4d726b3ae13b542f97b7837b6a3e \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..b49fa990 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__inherit__graph.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + +gridfire::policy::ProtonProtonIChainPolicy + + +Node1 + + +gridfire::policy::Proton +ProtonIChainPolicy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..5774af17 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIChainPolicy__inherit__graph_org.svg @@ -0,0 +1,60 @@ + + + + + + +gridfire::policy::ProtonProtonIChainPolicy + + +Node1 + + +gridfire::policy::Proton +ProtonIChainPolicy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy-members.html new file mode 100644 index 00000000..4a747ef7 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy-members.html @@ -0,0 +1,128 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::ProtonProtonIIChainPolicy Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + +
clone() const overridegridfire::policy::ProtonProtonIIChainPolicyvirtual
contains(const std::string &id) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
contains(const reaction::Reaction &reaction) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
get_reactions() const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
hash(uint64_t seed) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
is_active(double T9) constgridfire::policy::TemperatureDependentChainPolicy
m_reactionIDsgridfire::policy::TemperatureDependentChainPolicyprotected
m_reactionsgridfire::policy::TemperatureDependentChainPolicyprotected
m_tempRangegridfire::policy::TemperatureDependentChainPolicyprotected
name() const overridegridfire::policy::ProtonProtonIIChainPolicyvirtual
operator!=(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
operator==(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
ProtonProtonIIChainPolicy()gridfire::policy::ProtonProtonIIChainPolicy
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
~TemperatureDependentChainPolicy() override=defaultgridfire::policy::TemperatureDependentChainPolicy
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy.html b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy.html new file mode 100644 index 00000000..1442242f --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy.html @@ -0,0 +1,272 @@ + + + + + + + +GridFire: gridfire::policy::ProtonProtonIIChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::policy::ProtonProtonIIChainPolicy Class Referencefinal
+
+
+ +

Proton-Proton II Chain Policy. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::ProtonProtonIIChainPolicy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::policy::ProtonProtonIIChainPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 ProtonProtonIIChainPolicy ()
 
std::unique_ptr< ReactionChainPolicy > clone () const override
 
std::string name () const override
 
- Public Member Functions inherited from gridfire::policy::TemperatureDependentChainPolicy
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 ~TemperatureDependentChainPolicy () override=default
 Virtual destructor.
 
const reaction::ReactionSet & get_reactions () const override
 Get the reactions that comprise the chain.
 
bool contains (const std::string &id) const override
 Check if a reaction or reaction ID is part of the chain.
 
bool contains (const reaction::Reaction &reaction) const override
 Check if a reaction is part of the chain.
 
uint64_t hash (uint64_t seed) const override
 Generate the hash for the reaction chain policy.
 
bool operator== (const ReactionChainPolicy &other) const override
 Equality operator.
 
bool operator!= (const ReactionChainPolicy &other) const override
 Inequality operator.
 
bool is_active (double T9) const
 Check if the reaction chain is active at a given temperature.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::policy::TemperatureDependentChainPolicy
ActiveTempRange m_tempRange
 Active temperature range for the reaction chain.
 
std::vector< std::string > m_reactionIDs
 Vector of reaction IDs that comprise the chain.
 
reaction::ReactionSet m_reactions
 Set of reactions that comprise the chain.
 
+

Detailed Description

+

Proton-Proton II Chain Policy.

+

This class implements the Proton-Proton II chain of nuclear reactions. This chain's minimum temperature is set to T9=0.001 (or 1e6K). This chain includes reactions:

    +
  • p(p,e+)d
    • +
  • d(p,g)he3
    • +
  • he4(he3,g)be7
    • +
  • be7(e-,)li7
    • +
  • li7(p,a)he4
    • +
+

Constructor & Destructor Documentation

+ +

◆ ProtonProtonIIChainPolicy()

+ +
+
+ + + + + + + +
gridfire::policy::ProtonProtonIIChainPolicy::ProtonProtonIIChainPolicy ()
+
+ +
+
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< ReactionChainPolicy > gridfire::policy::ProtonProtonIIChainPolicy::clone () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::policy::ProtonProtonIIChainPolicy::name () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy.js b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy.js new file mode 100644 index 00000000..5fab604f --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy.js @@ -0,0 +1,6 @@ +var classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy = +[ + [ "ProtonProtonIIChainPolicy", "classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy.html#a1b8c1ebf376a8ddcafb89d6cda5d5989", null ], + [ "clone", "classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy.html#ad70b081f8623fad207050c0f81f6a457", null ], + [ "name", "classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy.html#a2782c6abea3596cf566a246239b96f80", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__coll__graph.map b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__coll__graph.map new file mode 100644 index 00000000..7bdbfc00 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__coll__graph.map @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__coll__graph.md5 b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__coll__graph.md5 new file mode 100644 index 00000000..8c5fbed1 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__coll__graph.md5 @@ -0,0 +1 @@ +441c7ef62930d3c3e57d1b999a9ef758 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__coll__graph.svg b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__coll__graph.svg new file mode 100644 index 00000000..cc6f250b --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__coll__graph.svg @@ -0,0 +1,360 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::ProtonProtonIIChainPolicy + + +Node1 + + +gridfire::policy::Proton +ProtonIIChainPolicy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__coll__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__coll__graph_org.svg new file mode 100644 index 00000000..cd8e4255 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__coll__graph_org.svg @@ -0,0 +1,278 @@ + + + + + + +gridfire::policy::ProtonProtonIIChainPolicy + + +Node1 + + +gridfire::policy::Proton +ProtonIIChainPolicy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__inherit__graph.map new file mode 100644 index 00000000..fac01b1c --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..55031743 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +5e9b7dc732a4b376d4b7b912b2f3a049 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..05bae650 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__inherit__graph.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + +gridfire::policy::ProtonProtonIIChainPolicy + + +Node1 + + +gridfire::policy::Proton +ProtonIIChainPolicy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..78fb3f3a --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy__inherit__graph_org.svg @@ -0,0 +1,60 @@ + + + + + + +gridfire::policy::ProtonProtonIIChainPolicy + + +Node1 + + +gridfire::policy::Proton +ProtonIIChainPolicy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy-members.html new file mode 100644 index 00000000..309e5e7e --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy-members.html @@ -0,0 +1,128 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::ProtonProtonIIIChainPolicy Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + +
clone() const overridegridfire::policy::ProtonProtonIIIChainPolicyvirtual
contains(const std::string &id) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
contains(const reaction::Reaction &reaction) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
get_reactions() const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
hash(uint64_t seed) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
is_active(double T9) constgridfire::policy::TemperatureDependentChainPolicy
m_reactionIDsgridfire::policy::TemperatureDependentChainPolicyprotected
m_reactionsgridfire::policy::TemperatureDependentChainPolicyprotected
m_tempRangegridfire::policy::TemperatureDependentChainPolicyprotected
name() const overridegridfire::policy::ProtonProtonIIIChainPolicyvirtual
operator!=(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
operator==(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
ProtonProtonIIIChainPolicy()gridfire::policy::ProtonProtonIIIChainPolicy
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
~TemperatureDependentChainPolicy() override=defaultgridfire::policy::TemperatureDependentChainPolicy
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy.html b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy.html new file mode 100644 index 00000000..ac9f7625 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy.html @@ -0,0 +1,272 @@ + + + + + + + +GridFire: gridfire::policy::ProtonProtonIIIChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::policy::ProtonProtonIIIChainPolicy Class Referencefinal
+
+
+ +

Proton-Proton III Chain Policy. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::ProtonProtonIIIChainPolicy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::policy::ProtonProtonIIIChainPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 ProtonProtonIIIChainPolicy ()
 
std::unique_ptr< ReactionChainPolicy > clone () const override
 
std::string name () const override
 
- Public Member Functions inherited from gridfire::policy::TemperatureDependentChainPolicy
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 ~TemperatureDependentChainPolicy () override=default
 Virtual destructor.
 
const reaction::ReactionSet & get_reactions () const override
 Get the reactions that comprise the chain.
 
bool contains (const std::string &id) const override
 Check if a reaction or reaction ID is part of the chain.
 
bool contains (const reaction::Reaction &reaction) const override
 Check if a reaction is part of the chain.
 
uint64_t hash (uint64_t seed) const override
 Generate the hash for the reaction chain policy.
 
bool operator== (const ReactionChainPolicy &other) const override
 Equality operator.
 
bool operator!= (const ReactionChainPolicy &other) const override
 Inequality operator.
 
bool is_active (double T9) const
 Check if the reaction chain is active at a given temperature.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::policy::TemperatureDependentChainPolicy
ActiveTempRange m_tempRange
 Active temperature range for the reaction chain.
 
std::vector< std::string > m_reactionIDs
 Vector of reaction IDs that comprise the chain.
 
reaction::ReactionSet m_reactions
 Set of reactions that comprise the chain.
 
+

Detailed Description

+

Proton-Proton III Chain Policy.

+

This class implements the Proton-Proton III chain of nuclear reactions. This chain's minimum temperature is set to T9=0.001 (or 1e6K). This chain includes reactions:

    +
  • p(p,e+)d
    • +
  • d(p,g)he3
    • +
  • he4(he3,g)be7
    • +
  • be7(p,g)b8
    • +
  • b8(,e+ a)he4
    • +
+

Constructor & Destructor Documentation

+ +

◆ ProtonProtonIIIChainPolicy()

+ +
+
+ + + + + + + +
gridfire::policy::ProtonProtonIIIChainPolicy::ProtonProtonIIIChainPolicy ()
+
+ +
+
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< ReactionChainPolicy > gridfire::policy::ProtonProtonIIIChainPolicy::clone () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::policy::ProtonProtonIIIChainPolicy::name () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy.js b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy.js new file mode 100644 index 00000000..2d9a5c82 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy.js @@ -0,0 +1,6 @@ +var classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy = +[ + [ "ProtonProtonIIIChainPolicy", "classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy.html#a80008d679d5084e6990da37b8e5784ac", null ], + [ "clone", "classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy.html#ac84ab054fc0f600f783ea3282d6fd4f6", null ], + [ "name", "classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy.html#a06d103e970b19c9a40cbae8d52ef0d0c", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__coll__graph.map b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__coll__graph.map new file mode 100644 index 00000000..8135787c --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__coll__graph.map @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__coll__graph.md5 b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__coll__graph.md5 new file mode 100644 index 00000000..2964dc39 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__coll__graph.md5 @@ -0,0 +1 @@ +ef7d1430edc1a88deeca741fa6618e15 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__coll__graph.svg b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__coll__graph.svg new file mode 100644 index 00000000..3a9411f2 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__coll__graph.svg @@ -0,0 +1,360 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::ProtonProtonIIIChainPolicy + + +Node1 + + +gridfire::policy::Proton +ProtonIIIChainPolicy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__coll__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__coll__graph_org.svg new file mode 100644 index 00000000..bf24ef3d --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__coll__graph_org.svg @@ -0,0 +1,278 @@ + + + + + + +gridfire::policy::ProtonProtonIIIChainPolicy + + +Node1 + + +gridfire::policy::Proton +ProtonIIIChainPolicy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__inherit__graph.map new file mode 100644 index 00000000..fa30cc70 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..647dd0e1 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +4ce39c3d836b1b2bc2408b92d4864938 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..0bfdfcdc --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__inherit__graph.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + +gridfire::policy::ProtonProtonIIIChainPolicy + + +Node1 + + +gridfire::policy::Proton +ProtonIIIChainPolicy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..fc7948ce --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy__inherit__graph_org.svg @@ -0,0 +1,60 @@ + + + + + + +gridfire::policy::ProtonProtonIIIChainPolicy + + +Node1 + + +gridfire::policy::Proton +ProtonIIIChainPolicy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy-members.html new file mode 100644 index 00000000..6f692e4e --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy-members.html @@ -0,0 +1,120 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::ReactionChainPolicy Member List
+
+
+ +

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

+ + + + + + + + + + + +
clone() const =0gridfire::policy::ReactionChainPolicypure virtual
contains(const std::string &id) const =0gridfire::policy::ReactionChainPolicypure virtual
contains(const reaction::Reaction &reaction) const =0gridfire::policy::ReactionChainPolicypure virtual
get_reactions() const =0gridfire::policy::ReactionChainPolicypure virtual
hash(uint64_t seed) const =0gridfire::policy::ReactionChainPolicypure virtual
name() const =0gridfire::policy::ReactionChainPolicypure virtual
operator!=(const ReactionChainPolicy &other) const =0gridfire::policy::ReactionChainPolicypure virtual
operator<<gridfire::policy::ReactionChainPolicyfriend
operator==(const ReactionChainPolicy &other) const =0gridfire::policy::ReactionChainPolicypure virtual
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy.html b/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy.html new file mode 100644 index 00000000..7de20a72 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy.html @@ -0,0 +1,461 @@ + + + + + + + +GridFire: gridfire::policy::ReactionChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Friends | +List of all members
+
gridfire::policy::ReactionChainPolicy Class Referenceabstract
+
+
+ +

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

+ +

#include <policy_abstract.h>

+
+Inheritance diagram for gridfire::policy::ReactionChainPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

virtual ~ReactionChainPolicy ()=default
 
virtual const reaction::ReactionSet & get_reactions () const =0
 Returns the ReactionSet describing this chain.
 
virtual bool contains (const std::string &id) const =0
 
virtual bool contains (const reaction::Reaction &reaction) const =0
 
virtual std::unique_ptr< ReactionChainPolicy > clone () const =0
 
virtual std::string name () const =0
 
virtual uint64_t hash (uint64_t seed) const =0
 
virtual bool operator== (const ReactionChainPolicy &other) const =0
 
virtual bool operator!= (const ReactionChainPolicy &other) const =0
 
+ + + +

+Friends

std::ostream & operator<< (std::ostream &os, const ReactionChainPolicy &rcp)
 
+

Detailed Description

+

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

+

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

+
Example
ProtonProtonChainPolicy pp;
+
const gridfire::reaction::ReactionSet& reactions = pp.get_reactions();
+
gridfire::policy::MultiReactionChainPolicy::get_reactions
const reaction::ReactionSet & get_reactions() const override
Returns the combined ReactionSet of all child chain policies.
Definition policy_logical.cpp:20
+
gridfire::policy::ProtonProtonChainPolicy
Proton-Proton Chain Policy.
Definition chains.h:197
+
gridfire::reaction::ReactionSet
Definition reaction.h:842
+
+
Note
Concrete implementations may throw exceptions on construction if the underlying reaction database (e.g. REACLIB) does not include requested reactions. See chains.h for details.
+

Constructor & Destructor Documentation

+ +

◆ ~ReactionChainPolicy()

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

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::unique_ptr< ReactionChainPolicy > gridfire::policy::ReactionChainPolicy::clone () const
+ 		+pure virtual
+
+ +

Implemented in gridfire::policy::ProtonProtonIChainPolicy, gridfire::policy::ProtonProtonIIChainPolicy, gridfire::policy::ProtonProtonIIIChainPolicy, gridfire::policy::CNOIChainPolicy, gridfire::policy::CNOIIChainPolicy, gridfire::policy::CNOIIIChainPolicy, gridfire::policy::CNOIVChainPolicy, gridfire::policy::HotCNOIChainPolicy, gridfire::policy::HotCNOIIChainPolicy, gridfire::policy::HotCNOIIIChainPolicy, gridfire::policy::TripleAlphaChainPolicy, gridfire::policy::MultiReactionChainPolicy, and PyReactionChainPolicy.

+ +
+
+ +

◆ contains() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + +
virtual bool gridfire::policy::ReactionChainPolicy::contains (const reaction::Reaction & reaction) const
+ 		+pure virtual
+
+ +

Implemented in PyReactionChainPolicy, gridfire::policy::TemperatureDependentChainPolicy, and gridfire::policy::MultiReactionChainPolicy.

+ +
+
+ +

◆ contains() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
virtual bool gridfire::policy::ReactionChainPolicy::contains (const std::string & id) const
+ 		+pure virtual
+
+ +

Implemented in gridfire::policy::TemperatureDependentChainPolicy, gridfire::policy::MultiReactionChainPolicy, and PyReactionChainPolicy.

+ +
+
+ +

◆ get_reactions()

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

Returns the ReactionSet describing this chain.

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

Implemented in gridfire::policy::TemperatureDependentChainPolicy, gridfire::policy::MultiReactionChainPolicy, and PyReactionChainPolicy.

+ +
+
+ +

◆ hash()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual uint64_t gridfire::policy::ReactionChainPolicy::hash (uint64_t seed) const
+ 		+pure virtual
+
+ +

Implemented in gridfire::policy::TemperatureDependentChainPolicy, gridfire::policy::MultiReactionChainPolicy, and PyReactionChainPolicy.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::string gridfire::policy::ReactionChainPolicy::name () const
+ 		+pure virtual
+
+ +

Implemented in gridfire::policy::ProtonProtonIChainPolicy, gridfire::policy::ProtonProtonIIChainPolicy, gridfire::policy::ProtonProtonIIIChainPolicy, gridfire::policy::ProtonProtonChainPolicy, gridfire::policy::CNOIChainPolicy, gridfire::policy::CNOIIChainPolicy, gridfire::policy::CNOIIIChainPolicy, gridfire::policy::CNOIVChainPolicy, gridfire::policy::CNOChainPolicy, gridfire::policy::HotCNOIChainPolicy, gridfire::policy::HotCNOIIChainPolicy, gridfire::policy::HotCNOIIIChainPolicy, gridfire::policy::HotCNOChainPolicy, gridfire::policy::TripleAlphaChainPolicy, gridfire::policy::MainSequenceReactionChainPolicy, gridfire::policy::MultiReactionChainPolicy, and PyReactionChainPolicy.

+ +
+
+ +

◆ operator!=()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual bool gridfire::policy::ReactionChainPolicy::operator!= (const ReactionChainPolicy & other) const
+ 		+pure virtual
+
+ +

Implemented in gridfire::policy::TemperatureDependentChainPolicy, and gridfire::policy::MultiReactionChainPolicy.

+ +
+
+ +

◆ operator==()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual bool gridfire::policy::ReactionChainPolicy::operator== (const ReactionChainPolicy & other) const
+ 		+pure virtual
+
+ +

Implemented in gridfire::policy::TemperatureDependentChainPolicy, and gridfire::policy::MultiReactionChainPolicy.

+ +
+
+

Friends And Related Symbol Documentation

+ +

◆ operator<<

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::ostream & operator<< (std::ostream & os,
const ReactionChainPolicy & rcp 
)
+ 		+friend
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy.js b/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy.js new file mode 100644 index 00000000..818b5a04 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy.js @@ -0,0 +1,13 @@ +var classgridfire_1_1policy_1_1ReactionChainPolicy = +[ + [ "~ReactionChainPolicy", "classgridfire_1_1policy_1_1ReactionChainPolicy.html#aa3e6c1e4844fe788aeb08d272070ae13", null ], + [ "clone", "classgridfire_1_1policy_1_1ReactionChainPolicy.html#ac24ff49b7715ad3eefea4bed1bf23686", null ], + [ "contains", "classgridfire_1_1policy_1_1ReactionChainPolicy.html#a68239737ada169238251f1994680fc7e", null ], + [ "contains", "classgridfire_1_1policy_1_1ReactionChainPolicy.html#a0c9a42646920ac02c8d1e63dfe6f9461", null ], + [ "get_reactions", "classgridfire_1_1policy_1_1ReactionChainPolicy.html#ad8bccf78e7fc99d08387aec5015e8849", null ], + [ "hash", "classgridfire_1_1policy_1_1ReactionChainPolicy.html#a5d1b5640d654f49399145f912e77c19b", null ], + [ "name", "classgridfire_1_1policy_1_1ReactionChainPolicy.html#a41758d921a2d7e83f446aa4fec00d598", null ], + [ "operator!=", "classgridfire_1_1policy_1_1ReactionChainPolicy.html#ac19e354a8bcd28f60783b70d8a761030", null ], + [ "operator==", "classgridfire_1_1policy_1_1ReactionChainPolicy.html#a30420a3881779c822ab06c0405ea7b28", null ], + [ "operator<<", "classgridfire_1_1policy_1_1ReactionChainPolicy.html#a264e0d1d13c7d4d5f05bdda5d5ada5c0", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy__inherit__graph.map new file mode 100644 index 00000000..3724d6bf --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy__inherit__graph.map @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..7d03a049 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +e90f25f2ae756927c71f60d02282628e \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..f9759844 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy__inherit__graph.svg @@ -0,0 +1,445 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::ReactionChainPolicy + + +Node1 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node2 + + +PyReactionChainPolicy + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node1->Node3 + + + + + + + + +Node8 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node1->Node8 + + + + + + + + +Node4 + + +gridfire::policy::CNOChain +Policy + + + + + +Node3->Node4 + + + + + + + + +Node5 + + +gridfire::policy::HotCNOChain +Policy + + + + + +Node3->Node5 + + + + + + + + +Node6 + + +gridfire::policy::MainSequence +ReactionChainPolicy + + + + + +Node3->Node6 + + + + + + + + +Node7 + + +gridfire::policy::Proton +ProtonChainPolicy + + + + + +Node3->Node7 + + + + + + + + +Node9 + + +gridfire::policy::CNOIChain +Policy + + + + + +Node8->Node9 + + + + + + + + +Node10 + + +gridfire::policy::CNOIIChain +Policy + + + + + +Node8->Node10 + + + + + + + + +Node11 + + +gridfire::policy::CNOIIIChain +Policy + + + + + +Node8->Node11 + + + + + + + + +Node12 + + +gridfire::policy::CNOIVChain +Policy + + + + + +Node8->Node12 + + + + + + + + +Node13 + + +gridfire::policy::HotCNOIChain +Policy + + + + + +Node8->Node13 + + + + + + + + +Node14 + + +gridfire::policy::HotCNOIIChain +Policy + + + + + +Node8->Node14 + + + + + + + + +Node15 + + +gridfire::policy::HotCNOIIIChain +Policy + + + + + +Node8->Node15 + + + + + + + + +Node16 + + +gridfire::policy::Proton +ProtonIChainPolicy + + + + + +Node8->Node16 + + + + + + + + +Node17 + + +gridfire::policy::Proton +ProtonIIChainPolicy + + + + + +Node8->Node17 + + + + + + + + +Node18 + + +gridfire::policy::Proton +ProtonIIIChainPolicy + + + + + +Node8->Node18 + + + + + + + + +Node19 + + +gridfire::policy::Triple +AlphaChainPolicy + + + + + +Node8->Node19 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..451ddd59 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1ReactionChainPolicy__inherit__graph_org.svg @@ -0,0 +1,363 @@ + + + + + + +gridfire::policy::ReactionChainPolicy + + +Node1 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node2 + + +PyReactionChainPolicy + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::policy::MultiReaction +ChainPolicy + + + + + +Node1->Node3 + + + + + + + + +Node8 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node1->Node8 + + + + + + + + +Node4 + + +gridfire::policy::CNOChain +Policy + + + + + +Node3->Node4 + + + + + + + + +Node5 + + +gridfire::policy::HotCNOChain +Policy + + + + + +Node3->Node5 + + + + + + + + +Node6 + + +gridfire::policy::MainSequence +ReactionChainPolicy + + + + + +Node3->Node6 + + + + + + + + +Node7 + + +gridfire::policy::Proton +ProtonChainPolicy + + + + + +Node3->Node7 + + + + + + + + +Node9 + + +gridfire::policy::CNOIChain +Policy + + + + + +Node8->Node9 + + + + + + + + +Node10 + + +gridfire::policy::CNOIIChain +Policy + + + + + +Node8->Node10 + + + + + + + + +Node11 + + +gridfire::policy::CNOIIIChain +Policy + + + + + +Node8->Node11 + + + + + + + + +Node12 + + +gridfire::policy::CNOIVChain +Policy + + + + + +Node8->Node12 + + + + + + + + +Node13 + + +gridfire::policy::HotCNOIChain +Policy + + + + + +Node8->Node13 + + + + + + + + +Node14 + + +gridfire::policy::HotCNOIIChain +Policy + + + + + +Node8->Node14 + + + + + + + + +Node15 + + +gridfire::policy::HotCNOIIIChain +Policy + + + + + +Node8->Node15 + + + + + + + + +Node16 + + +gridfire::policy::Proton +ProtonIChainPolicy + + + + + +Node8->Node16 + + + + + + + + +Node17 + + +gridfire::policy::Proton +ProtonIIChainPolicy + + + + + +Node8->Node17 + + + + + + + + +Node18 + + +gridfire::policy::Proton +ProtonIIIChainPolicy + + + + + +Node8->Node18 + + + + + + + + +Node19 + + +gridfire::policy::Triple +AlphaChainPolicy + + + + + +Node8->Node19 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy-members.html new file mode 100644 index 00000000..308e4cc1 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy-members.html @@ -0,0 +1,127 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::TemperatureDependentChainPolicy Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + +
clone() const =0gridfire::policy::ReactionChainPolicypure virtual
contains(const std::string &id) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
contains(const reaction::Reaction &reaction) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
get_reactions() const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
hash(uint64_t seed) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
is_active(double T9) constgridfire::policy::TemperatureDependentChainPolicy
m_reactionIDsgridfire::policy::TemperatureDependentChainPolicyprotected
m_reactionsgridfire::policy::TemperatureDependentChainPolicyprotected
m_tempRangegridfire::policy::TemperatureDependentChainPolicyprotected
name() const =0gridfire::policy::ReactionChainPolicypure virtual
operator!=(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
operator==(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
~TemperatureDependentChainPolicy() override=defaultgridfire::policy::TemperatureDependentChainPolicy
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html new file mode 100644 index 00000000..f9ba5d11 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html @@ -0,0 +1,674 @@ + + + + + + + +GridFire: gridfire::policy::TemperatureDependentChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Classes | +Public Member Functions | +Protected Attributes | +List of all members
+
gridfire::policy::TemperatureDependentChainPolicy Class Reference
+
+
+ +

Base class for reaction chain policies that are active only within specific temperature ranges. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::TemperatureDependentChainPolicy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::policy::TemperatureDependentChainPolicy:
+
+
+
[legend]
+ + + + + +

+Classes

struct  ActiveTempRange
 Struct to hold the active temperature range for the reaction chain. More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 ~TemperatureDependentChainPolicy () override=default
 Virtual destructor.
 
const reaction::ReactionSet & get_reactions () const override
 Get the reactions that comprise the chain.
 
bool contains (const std::string &id) const override
 Check if a reaction or reaction ID is part of the chain.
 
bool contains (const reaction::Reaction &reaction) const override
 Check if a reaction is part of the chain.
 
uint64_t hash (uint64_t seed) const override
 Generate the hash for the reaction chain policy.
 
bool operator== (const ReactionChainPolicy &other) const override
 Equality operator.
 
bool operator!= (const ReactionChainPolicy &other) const override
 Inequality operator.
 
bool is_active (double T9) const
 Check if the reaction chain is active at a given temperature.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
virtual std::unique_ptr< ReactionChainPolicy > clone () const =0
 
virtual std::string name () const =0
 
+ + + + + + + + + + +

+Protected Attributes

ActiveTempRange m_tempRange
 Active temperature range for the reaction chain.
 
std::vector< std::string > m_reactionIDs
 Vector of reaction IDs that comprise the chain.
 
reaction::ReactionSet m_reactions
 Set of reactions that comprise the chain.
 
+

Detailed Description

+

Base class for reaction chain policies that are active only within specific temperature ranges.

+

Such chains may only operate effectively within certain temperature regimes, reflecting the physical conditions required for the reactions to proceed. This class allows defining such temperature-dependent behavior. This is one of the locations where domain specific knowledge is allowed within GridFire.

+

Constructor & Destructor Documentation

+ +

◆ TemperatureDependentChainPolicy() [1/3]

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::policy::TemperatureDependentChainPolicy::TemperatureDependentChainPolicy (const std::vector< std::string > & reactionIDs)
+ 		+explicit
+
+ +

Construct a new Temperature Dependent Chain Policy object.

+
Parameters
+ + +
reactionIDsVector of reaction IDs that comprise the chain
+
+
+
Note
The chain is considered active at all temperatures if no min/max T9 are provided.
+ +
+
+ +

◆ TemperatureDependentChainPolicy() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
gridfire::policy::TemperatureDependentChainPolicy::TemperatureDependentChainPolicy (const std::vector< std::string > & reactionIDs,
std::optional< double > minT9 
)
+ 		+explicit
+
+ +

Construct a new Temperature Dependent Chain Policy object.

+
Parameters
+ + + +
reactionIDsVector of reaction IDs that comprise the chain
minT9Minimum temperature (in T9) for which the chain is active
+
+
+
Note
The chain is considered active at all temperatures above minT9.
+ +
+
+ +

◆ TemperatureDependentChainPolicy() [3/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
gridfire::policy::TemperatureDependentChainPolicy::TemperatureDependentChainPolicy (const std::vector< std::string > & reactionIDs,
std::optional< double > minT9,
std::optional< double > maxT9 
)
+ 		+explicit
+
+ +

Construct a new Temperature Dependent Chain Policy object.

+
Parameters
+ + + + +
reactionIDsVector of reaction IDs that comprise the chain
minT9Minimum temperature (in T9) for which the chain is active
maxT9Maximum temperature (in T9) for which the chain is active
+
+
+ +
+
+ +

◆ ~TemperatureDependentChainPolicy()

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::policy::TemperatureDependentChainPolicy::~TemperatureDependentChainPolicy ()
+ 		+overridedefault
+
+ +

Virtual destructor.

+ +
+
+

Member Function Documentation

+ +

◆ contains() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::policy::TemperatureDependentChainPolicy::contains (const reaction::Reaction & reaction) const
+ 		+overridevirtual
+
+ +

Check if a reaction is part of the chain.

+
Parameters
+ + +
reactionThe reaction to check
+
+
+
Returns
True if the reaction is part of the chain, false otherwise
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ contains() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::policy::TemperatureDependentChainPolicy::contains (const std::string & id) const
+ 		+overridevirtual
+
+ +

Check if a reaction or reaction ID is part of the chain.

+
Parameters
+ + +
idThe reaction ID to check
+
+
+
Returns
True if the reaction ID is part of the chain, false otherwise
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ get_reactions()

+ +
+
+ + + + + +
+ + + + + + + +
const reaction::ReactionSet & gridfire::policy::TemperatureDependentChainPolicy::get_reactions () const
+ 		+overridevirtual
+
+ +

Get the reactions that comprise the chain.

+
Returns
The set of reactions comprising the chain
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ hash()

+ +
+
+ + + + + +
+ + + + + + + + +
uint64_t gridfire::policy::TemperatureDependentChainPolicy::hash (uint64_t seed) const
+ 		+overridevirtual
+
+ +

Generate the hash for the reaction chain policy.

+
Parameters
+ + +
seedSeed value for the hash
+
+
+
Returns
Unique hash representing the reaction chain policy. XXHash64 is used internally for speed and collision resistance.
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ is_active()

+ +
+
+ + + + + + + + +
bool gridfire::policy::TemperatureDependentChainPolicy::is_active (double T9) const
+
+ +

Check if the reaction chain is active at a given temperature.

+
Parameters
+ + +
T9Temperature in billions of Kelvin (T9)
+
+
+
Returns
True if the chain is active at the given temperature, false otherwise
+ +
+
+ +

◆ operator!=()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::policy::TemperatureDependentChainPolicy::operator!= (const ReactionChainPolicy & other) const
+ 		+overridevirtual
+
+ +

Inequality operator.

+
Parameters
+ + +
otherThe other ReactionChainPolicy to compare against
+
+
+
Returns
True if the two policies are not equal, false otherwise
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ operator==()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::policy::TemperatureDependentChainPolicy::operator== (const ReactionChainPolicy & other) const
+ 		+overridevirtual
+
+ +

Equality operator.

+
Parameters
+ + +
otherThe other ReactionChainPolicy to compare against
+
+
+
Returns
True if the two policies are equal, false otherwise
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+

Member Data Documentation

+ +

◆ m_reactionIDs

+ +
+
+ + + + + +
+ + + + +
std::vector<std::string> gridfire::policy::TemperatureDependentChainPolicy::m_reactionIDs
+ 		+protected
+
+ +

Vector of reaction IDs that comprise the chain.

+ +
+
+ +

◆ m_reactions

+ +
+
+ + + + + +
+ + + + +
reaction::ReactionSet gridfire::policy::TemperatureDependentChainPolicy::m_reactions
+ 		+protected
+
+ +

Set of reactions that comprise the chain.

+ +
+
+ +

◆ m_tempRange

+ +
+
+ + + + + +
+ + + + +
ActiveTempRange gridfire::policy::TemperatureDependentChainPolicy::m_tempRange
+ 		+protected
+
+ +

Active temperature range for the reaction chain.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.js b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.js new file mode 100644 index 00000000..3c25895f --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.js @@ -0,0 +1,18 @@ +var classgridfire_1_1policy_1_1TemperatureDependentChainPolicy = +[ + [ "ActiveTempRange", "structgridfire_1_1policy_1_1TemperatureDependentChainPolicy_1_1ActiveTempRange.html", "structgridfire_1_1policy_1_1TemperatureDependentChainPolicy_1_1ActiveTempRange" ], + [ "TemperatureDependentChainPolicy", "classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a07f5a057d382874ec641b3494338dc65", null ], + [ "TemperatureDependentChainPolicy", "classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#ab7f64e19d0ce405aba55b518ed301b92", null ], + [ "TemperatureDependentChainPolicy", "classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a4886c44a082151ebf7b75594dbc6856b", null ], + [ "~TemperatureDependentChainPolicy", "classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a74b59b1cb02703834373fb7a3d09614e", null ], + [ "contains", "classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a8984d58dee6865d4bd98aedf31bb445e", null ], + [ "contains", "classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a8869287d36b3ff143e7f84799ef35dd9", null ], + [ "get_reactions", "classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#ae93a5a2d753ddd32f2a4a5a750ef44b4", null ], + [ "hash", "classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a0b2c469f8e17ccba0f45632b19395731", null ], + [ "is_active", "classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a2e10b0f832b1addbaa90c14363732c7a", null ], + [ "operator!=", "classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a264dc45c3410ab3ec49a340633aa5950", null ], + [ "operator==", "classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#add9c0230ad7c3e6e2cb182bdb4849c52", null ], + [ "m_reactionIDs", "classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a69882ddefb0f27b13433616411a1484a", null ], + [ "m_reactions", "classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#ad9cd9e4826f60e066feda2ffc5d37338", null ], + [ "m_tempRange", "classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a22d731c0a0bf804f7c8b0e22cf13b688", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__coll__graph.map b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__coll__graph.map new file mode 100644 index 00000000..1c23182e --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__coll__graph.map @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__coll__graph.md5 b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__coll__graph.md5 new file mode 100644 index 00000000..0b81daca --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__coll__graph.md5 @@ -0,0 +1 @@ +57def7185d2b26d1df4824b457e32217 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__coll__graph.svg b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__coll__graph.svg new file mode 100644 index 00000000..7925b10b --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__coll__graph.svg @@ -0,0 +1,341 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::TemperatureDependentChainPolicy + + +Node1 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node3->Node1 + + + + + + m_tempRange + + + +Node4 + + +std::vector< std::string > + + + + + +Node4->Node1 + + + + + + m_reactionIDs + + + +Node5 + + +std::string + + + + + +Node5->Node4 + + + + + + elements + + + +Node7 + + +gridfire::reaction +::ReactionSet + + + + + +Node5->Node7 + + + + + + m_id + + + +Node11 + + +std::unordered_map +< std::string, size_t > + + + + + +Node5->Node11 + + + + + + keys + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + +Node7->Node1 + + + + + + m_reactions + + + +Node8 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node8->Node7 + + + + + + m_reactions + + + +Node9 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node9->Node8 + + + + + + elements + + + +Node10 + + +gridfire::reaction +::Reaction + + + + + +Node10->Node9 + + + + + + ptr + + + +Node11->Node7 + + + + + + m_reactionNameMap + + + +Node12 + + +std::unordered_set +< size_t > + + + + + +Node12->Node7 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__coll__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__coll__graph_org.svg new file mode 100644 index 00000000..8bf27fc5 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__coll__graph_org.svg @@ -0,0 +1,259 @@ + + + + + + +gridfire::policy::TemperatureDependentChainPolicy + + +Node1 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node3->Node1 + + + + + + m_tempRange + + + +Node4 + + +std::vector< std::string > + + + + + +Node4->Node1 + + + + + + m_reactionIDs + + + +Node5 + + +std::string + + + + + +Node5->Node4 + + + + + + elements + + + +Node7 + + +gridfire::reaction +::ReactionSet + + + + + +Node5->Node7 + + + + + + m_id + + + +Node11 + + +std::unordered_map +< std::string, size_t > + + + + + +Node5->Node11 + + + + + + keys + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + +Node7->Node1 + + + + + + m_reactions + + + +Node8 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node8->Node7 + + + + + + m_reactions + + + +Node9 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node9->Node8 + + + + + + elements + + + +Node10 + + +gridfire::reaction +::Reaction + + + + + +Node10->Node9 + + + + + + ptr + + + +Node11->Node7 + + + + + + m_reactionNameMap + + + +Node12 + + +std::unordered_set +< size_t > + + + + + +Node12->Node7 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__inherit__graph.map new file mode 100644 index 00000000..f714c1b5 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__inherit__graph.map @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..381433ab --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +f84b046c3a2b0ddce482adf99ae5affc \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..63181461 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__inherit__graph.svg @@ -0,0 +1,332 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::TemperatureDependentChainPolicy + + +Node1 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node3 + + +gridfire::policy::CNOIChain +Policy + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::policy::CNOIIChain +Policy + + + + + +Node1->Node4 + + + + + + + + +Node5 + + +gridfire::policy::CNOIIIChain +Policy + + + + + +Node1->Node5 + + + + + + + + +Node6 + + +gridfire::policy::CNOIVChain +Policy + + + + + +Node1->Node6 + + + + + + + + +Node7 + + +gridfire::policy::HotCNOIChain +Policy + + + + + +Node1->Node7 + + + + + + + + +Node8 + + +gridfire::policy::HotCNOIIChain +Policy + + + + + +Node1->Node8 + + + + + + + + +Node9 + + +gridfire::policy::HotCNOIIIChain +Policy + + + + + +Node1->Node9 + + + + + + + + +Node10 + + +gridfire::policy::Proton +ProtonIChainPolicy + + + + + +Node1->Node10 + + + + + + + + +Node11 + + +gridfire::policy::Proton +ProtonIIChainPolicy + + + + + +Node1->Node11 + + + + + + + + +Node12 + + +gridfire::policy::Proton +ProtonIIIChainPolicy + + + + + +Node1->Node12 + + + + + + + + +Node13 + + +gridfire::policy::Triple +AlphaChainPolicy + + + + + +Node1->Node13 + + + + + + + + +Node2 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..d40b2ba0 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__inherit__graph_org.svg @@ -0,0 +1,250 @@ + + + + + + +gridfire::policy::TemperatureDependentChainPolicy + + +Node1 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node3 + + +gridfire::policy::CNOIChain +Policy + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::policy::CNOIIChain +Policy + + + + + +Node1->Node4 + + + + + + + + +Node5 + + +gridfire::policy::CNOIIIChain +Policy + + + + + +Node1->Node5 + + + + + + + + +Node6 + + +gridfire::policy::CNOIVChain +Policy + + + + + +Node1->Node6 + + + + + + + + +Node7 + + +gridfire::policy::HotCNOIChain +Policy + + + + + +Node1->Node7 + + + + + + + + +Node8 + + +gridfire::policy::HotCNOIIChain +Policy + + + + + +Node1->Node8 + + + + + + + + +Node9 + + +gridfire::policy::HotCNOIIIChain +Policy + + + + + +Node1->Node9 + + + + + + + + +Node10 + + +gridfire::policy::Proton +ProtonIChainPolicy + + + + + +Node1->Node10 + + + + + + + + +Node11 + + +gridfire::policy::Proton +ProtonIIChainPolicy + + + + + +Node1->Node11 + + + + + + + + +Node12 + + +gridfire::policy::Proton +ProtonIIIChainPolicy + + + + + +Node1->Node12 + + + + + + + + +Node13 + + +gridfire::policy::Triple +AlphaChainPolicy + + + + + +Node1->Node13 + + + + + + + + +Node2 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy-members.html b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy-members.html new file mode 100644 index 00000000..6225c3d8 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy-members.html @@ -0,0 +1,128 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::TripleAlphaChainPolicy Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + +
clone() const overridegridfire::policy::TripleAlphaChainPolicyvirtual
contains(const std::string &id) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
contains(const reaction::Reaction &reaction) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
get_reactions() const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
hash(uint64_t seed) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
is_active(double T9) constgridfire::policy::TemperatureDependentChainPolicy
m_reactionIDsgridfire::policy::TemperatureDependentChainPolicyprotected
m_reactionsgridfire::policy::TemperatureDependentChainPolicyprotected
m_tempRangegridfire::policy::TemperatureDependentChainPolicyprotected
name() const overridegridfire::policy::TripleAlphaChainPolicyvirtual
operator!=(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
operator==(const ReactionChainPolicy &other) const overridegridfire::policy::TemperatureDependentChainPolicyvirtual
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
TemperatureDependentChainPolicy(const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)gridfire::policy::TemperatureDependentChainPolicyexplicit
TripleAlphaChainPolicy()gridfire::policy::TripleAlphaChainPolicy
~ReactionChainPolicy()=defaultgridfire::policy::ReactionChainPolicyvirtual
~TemperatureDependentChainPolicy() override=defaultgridfire::policy::TemperatureDependentChainPolicy
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy.html b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy.html new file mode 100644 index 00000000..b915b095 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy.html @@ -0,0 +1,269 @@ + + + + + + + +GridFire: gridfire::policy::TripleAlphaChainPolicy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::policy::TripleAlphaChainPolicy Class Referencefinal
+
+
+ +

Triple-Alpha Chain Policy. + More...

+ +

#include <chains.h>

+
+Inheritance diagram for gridfire::policy::TripleAlphaChainPolicy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::policy::TripleAlphaChainPolicy:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 TripleAlphaChainPolicy ()
 
std::unique_ptr< ReactionChainPolicy > clone () const override
 
std::string name () const override
 
- Public Member Functions inherited from gridfire::policy::TemperatureDependentChainPolicy
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 TemperatureDependentChainPolicy (const std::vector< std::string > &reactionIDs, std::optional< double > minT9, std::optional< double > maxT9)
 Construct a new Temperature Dependent Chain Policy object.
 
 ~TemperatureDependentChainPolicy () override=default
 Virtual destructor.
 
const reaction::ReactionSet & get_reactions () const override
 Get the reactions that comprise the chain.
 
bool contains (const std::string &id) const override
 Check if a reaction or reaction ID is part of the chain.
 
bool contains (const reaction::Reaction &reaction) const override
 Check if a reaction is part of the chain.
 
uint64_t hash (uint64_t seed) const override
 Generate the hash for the reaction chain policy.
 
bool operator== (const ReactionChainPolicy &other) const override
 Equality operator.
 
bool operator!= (const ReactionChainPolicy &other) const override
 Inequality operator.
 
bool is_active (double T9) const
 Check if the reaction chain is active at a given temperature.
 
- Public Member Functions inherited from gridfire::policy::ReactionChainPolicy
virtual ~ReactionChainPolicy ()=default
 
+ + + + + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::policy::TemperatureDependentChainPolicy
ActiveTempRange m_tempRange
 Active temperature range for the reaction chain.
 
std::vector< std::string > m_reactionIDs
 Vector of reaction IDs that comprise the chain.
 
reaction::ReactionSet m_reactions
 Set of reactions that comprise the chain.
 
+

Detailed Description

+

Triple-Alpha Chain Policy.

+

This class implements the Triple-Alpha process of nuclear reactions. This chain's minimum temperature is set to T9=0.01 (or 1e7K). This chain includes reactions:

    +
  • he4(he4,a)be8
    • +
  • be8(he4,g)c12
    • +
+

Constructor & Destructor Documentation

+ +

◆ TripleAlphaChainPolicy()

+ +
+
+ + + + + + + +
gridfire::policy::TripleAlphaChainPolicy::TripleAlphaChainPolicy ()
+
+ +
+
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< ReactionChainPolicy > gridfire::policy::TripleAlphaChainPolicy::clone () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::policy::TripleAlphaChainPolicy::name () const
+ 		+overridevirtual
+
+ +

Implements gridfire::policy::ReactionChainPolicy.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy.js b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy.js new file mode 100644 index 00000000..5c69637d --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy.js @@ -0,0 +1,6 @@ +var classgridfire_1_1policy_1_1TripleAlphaChainPolicy = +[ + [ "TripleAlphaChainPolicy", "classgridfire_1_1policy_1_1TripleAlphaChainPolicy.html#a857760f885820ad7cb0cee2d8512d36d", null ], + [ "clone", "classgridfire_1_1policy_1_1TripleAlphaChainPolicy.html#a447ff0d2de9df09400e63f0fc087efa3", null ], + [ "name", "classgridfire_1_1policy_1_1TripleAlphaChainPolicy.html#a2d6543b9fa7f96b8b21d7e7545f9a22d", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__coll__graph.map b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__coll__graph.map new file mode 100644 index 00000000..d1127742 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__coll__graph.map @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__coll__graph.md5 b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__coll__graph.md5 new file mode 100644 index 00000000..597222e7 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__coll__graph.md5 @@ -0,0 +1 @@ +8d2caff5b155ff0dbb18cc96a3044025 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__coll__graph.svg b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__coll__graph.svg new file mode 100644 index 00000000..077b8377 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__coll__graph.svg @@ -0,0 +1,360 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::policy::TripleAlphaChainPolicy + + +Node1 + + +gridfire::policy::Triple +AlphaChainPolicy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__coll__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__coll__graph_org.svg new file mode 100644 index 00000000..1e5db7e0 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__coll__graph_org.svg @@ -0,0 +1,278 @@ + + + + + + +gridfire::policy::TripleAlphaChainPolicy + + +Node1 + + +gridfire::policy::Triple +AlphaChainPolicy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::policy::Temperature +DependentChainPolicy::ActiveTempRange + + + + + +Node4->Node2 + + + + + + m_tempRange + + + +Node5 + + +std::vector< std::string > + + + + + +Node5->Node2 + + + + + + m_reactionIDs + + + +Node6 + + +std::string + + + + + +Node6->Node5 + + + + + + elements + + + +Node8 + + +gridfire::reaction +::ReactionSet + + + + + +Node6->Node8 + + + + + + m_id + + + +Node12 + + +std::unordered_map +< std::string, size_t > + + + + + +Node6->Node12 + + + + + + keys + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8->Node2 + + + + + + m_reactions + + + +Node9 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node9->Node8 + + + + + + m_reactions + + + +Node10 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +gridfire::reaction +::Reaction + + + + + +Node11->Node10 + + + + + + ptr + + + +Node12->Node8 + + + + + + m_reactionNameMap + + + +Node13 + + +std::unordered_set +< size_t > + + + + + +Node13->Node8 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__inherit__graph.map b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__inherit__graph.map new file mode 100644 index 00000000..eb6b44dc --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__inherit__graph.md5 b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__inherit__graph.md5 new file mode 100644 index 00000000..b6b30ff8 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__inherit__graph.md5 @@ -0,0 +1 @@ +135618db32bba9605e97e1b283fbc852 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__inherit__graph.svg b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__inherit__graph.svg new file mode 100644 index 00000000..9459aec7 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__inherit__graph.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + +gridfire::policy::TripleAlphaChainPolicy + + +Node1 + + +gridfire::policy::Triple +AlphaChainPolicy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__inherit__graph_org.svg b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__inherit__graph_org.svg new file mode 100644 index 00000000..f865ae02 --- /dev/null +++ b/docs/html/classgridfire_1_1policy_1_1TripleAlphaChainPolicy__inherit__graph_org.svg @@ -0,0 +1,60 @@ + + + + + + +gridfire::policy::TripleAlphaChainPolicy + + +Node1 + + +gridfire::policy::Triple +AlphaChainPolicy + + + + + +Node2 + + +gridfire::policy::Temperature +DependentChainPolicy + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::policy::Reaction +ChainPolicy + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator-members.html b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator-members.html new file mode 100644 index 00000000..4e192828 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator-members.html @@ -0,0 +1,117 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::rates::weak::WeakRateInterpolator Member List
+
+
+ +

This is the complete list of members for gridfire::rates::weak::WeakRateInterpolator, including all inherited members.

+ + + + + + + + +
available_isotopes() constgridfire::rates::weak::WeakRateInterpolator
get_rate_derivatives(uint16_t A, uint8_t Z, double t9, double log_rhoYe) constgridfire::rates::weak::WeakRateInterpolator
get_rates(uint16_t A, uint8_t Z, double t9, double log_rhoYe) constgridfire::rates::weak::WeakRateInterpolator
m_loggergridfire::rates::weak::WeakRateInterpolatorprivate
m_rate_tablegridfire::rates::weak::WeakRateInterpolatorprivate
RowDataTable typedefgridfire::rates::weak::WeakRateInterpolator
WeakRateInterpolator(const RowDataTable &raw_data)gridfire::rates::weak::WeakRateInterpolatorexplicit
+
+ + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator.html b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator.html new file mode 100644 index 00000000..e40a2d79 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator.html @@ -0,0 +1,407 @@ + + + + + + + +GridFire: gridfire::rates::weak::WeakRateInterpolator Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Types | +Public Member Functions | +Private Attributes | +List of all members
+
gridfire::rates::weak::WeakRateInterpolator Class Reference
+
+
+ +

3D table interpolator for tabulated weak reaction data by isotope. + More...

+ +

#include <weak_interpolator.h>

+
+Collaboration diagram for gridfire::rates::weak::WeakRateInterpolator:
+
+
+
[legend]
+ + + + + +

+Public Types

using RowDataTable = std::array< RateDataRow, 77400 >
 Raw weak-rate table type expected by the constructor.
 
+ + + + + + + + + + + + + +

+Public Member Functions

 WeakRateInterpolator (const RowDataTable &raw_data)
 Construct the interpolator from raw weak-rate rows.
 
std::vector< fourdst::atomic::Species > available_isotopes () const
 List isotopes for which tables are available.
 
std::expected< WeakRatePayload, InterpolationError > get_rates (uint16_t A, uint8_t Z, double t9, double log_rhoYe) const
 Trilinear interpolation of weak-rate payload at a state.
 
std::expected< WeakRateDerivatives, InterpolationError > get_rate_derivatives (uint16_t A, uint8_t Z, double t9, double log_rhoYe) const
 Finite-difference partial derivatives of the log10() fields.
 
+ + + + + + +

+Private Attributes

quill::Logger * m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
 
std::unordered_map< uint32_t, IsotopeGrid > m_rate_table
 Per-isotope grids over (T9, log10(rho*Ye), mu_e) with payloads at lattice nodes.
 
+

Detailed Description

+

3D table interpolator for tabulated weak reaction data by isotope.

+

Builds per-isotope 3D grids over (T9, log10(rho*Ye), mu_e) and provides:

+

Implementation summary (constructor): rows are grouped by (A,Z), then each group's unique axis values are collected and sorted to form the three axes; the 3D payload array is populated at each lattice point with the 6 log10() fields from the raw table.

+

Member Typedef Documentation

+ +

◆ RowDataTable

+ +
+
+ + + + +
using gridfire::rates::weak::WeakRateInterpolator::RowDataTable = std::array<RateDataRow, 77400>
+
+ +

Raw weak-rate table type expected by the constructor.

+

The size must match the number of rows compiled into the weak-rate library.

+ +
+
+

Constructor & Destructor Documentation

+ +

◆ WeakRateInterpolator()

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::rates::weak::WeakRateInterpolator::WeakRateInterpolator (const RowDataTable & raw_data)
+ 		+explicit
+
+ +

Construct the interpolator from raw weak-rate rows.

+

Groups rows by isotope (A,Z), extracts unique sorted axes for T9, log10(rho*Ye), and mu_e, and fills an internal regular grid with the log10(rate) and neutrino-loss payloads at each node. No interpolation occurs at construction time.

+ +
+
+

Member Function Documentation

+ +

◆ available_isotopes()

+ +
+
+ + + + + + + +
std::vector< fourdst::atomic::Species > gridfire::rates::weak::WeakRateInterpolator::available_isotopes () const
+
+ +

List isotopes for which tables are available.

+
Returns
Vector of available Species (A,Z) derived from internal tables.
+
Exceptions
+ + +
std::runtime_errorIf any packed (A,Z) cannot be converted to Species.
+
+
+
Example
WeakRateInterpolator interp(rows);
+
auto isotopes = interp.available_isotopes();
+
gridfire::rates::weak::WeakRateInterpolator
3D table interpolator for tabulated weak reaction data by isotope.
Definition weak_interpolator.h:29
+
+ +
+
+ +

◆ get_rate_derivatives()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::expected< WeakRateDerivatives, InterpolationError > gridfire::rates::weak::WeakRateInterpolator::get_rate_derivatives (uint16_t A,
uint8_t Z,
double t9,
double log_rhoYe 
) const
+
+ +

Finite-difference partial derivatives of the log10() fields.

+

Uses central differences with small fixed (1e-6) perturbations in each variable (T9, log10(rho*Ye), mu_e) and returns arrays of d(log10(field))/d(var) for all fields. If any perturbed state falls outside the table, returns a BOUNDS_ERROR with per-axis bounds; if the isotope is unknown, returns UNKNOWN_SPECIES_ERROR.

+
Parameters
+ + + + + +
AMass number of the isotope.
ZProton number of the isotope.
t9Temperature in GK (10^9 K).
log_rhoYeLog10 of rho*Ye (cgs density times electron fraction).
+
+
+
Returns
expected<WeakRateDerivatives, InterpolationError>: derivative payload on success; otherwise an InterpolationError as described above.
+
Example
if (auto d = interp.get_rate_derivatives(52, 26, 3.0, 6.0, 2.0); d) {
+
// use d->d_log_beta_minus[0..2], etc.
+
}
+
+ +
+
+ +

◆ get_rates()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::expected< WeakRatePayload, InterpolationError > gridfire::rates::weak::WeakRateInterpolator::get_rates (uint16_t A,
uint8_t Z,
double t9,
double log_rhoYe 
) const
+
+ +

Trilinear interpolation of weak-rate payload at a state.

+

Interpolates the 6 log10() fields (rates and neutrino losses) at the given state for the requested isotope. If the isotope is unknown or the state lies outside the tabulated ranges, returns an error via std::expected with detailed bounds info.

+
Parameters
+ + + + + +
AMass number of the isotope.
ZProton number of the isotope.
t9Temperature in GK (10^9 K).
log_rhoYeLog10 of rho*Ye (cgs density times electron fraction).
+
+
+
Returns
expected<WeakRatePayload, InterpolationError>: payload on success; InterpolationError::UNKNOWN_SPECIES_ERROR if (A,Z) not present; or InterpolationError::BOUNDS_ERROR if any coordinate is outside the table (with per-axis bounds included).
+
Example
if (auto res = interp.get_rates(52, 26, 3.0, 6.0, 2.0); res) {
+
const WeakRatePayload& p = *res;
+
} else {
+
// inspect res.error().type and optional bounds info
+
}
+
gridfire::rates::weak::WeakRatePayload
Interpolated weak-rate payload at a single state.
Definition weak_types.h:86
+
+ +
+
+

Member Data Documentation

+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::rates::weak::WeakRateInterpolator::m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +
+
+ +

◆ m_rate_table

+ +
+
+ + + + + +
+ + + + +
std::unordered_map<uint32_t, IsotopeGrid> gridfire::rates::weak::WeakRateInterpolator::m_rate_table
+ 		+private
+
+ +

Per-isotope grids over (T9, log10(rho*Ye), mu_e) with payloads at lattice nodes.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator.js b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator.js new file mode 100644 index 00000000..47325d69 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator.js @@ -0,0 +1,10 @@ +var classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator = +[ + [ "RowDataTable", "classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator.html#afd3e0e1c5edaf12609b5fc81c379e3e5", null ], + [ "WeakRateInterpolator", "classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator.html#a1efafe82d25d36b93a60a6fccbd5ca3d", null ], + [ "available_isotopes", "classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator.html#a976f84b6f6e33b5f3dd733a771afd7ba", null ], + [ "get_rate_derivatives", "classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator.html#ac04ae382defc51645c632db6ad3830d7", null ], + [ "get_rates", "classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator.html#a730c8e7fe5218c5ce077531bc7924d79", null ], + [ "m_logger", "classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator.html#a2962864d8a6f8760a4228729838b6edb", null ], + [ "m_rate_table", "classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator.html#a7a01f956eccd3a0a90dd08984ca3f009", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator__coll__graph.map b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator__coll__graph.map new file mode 100644 index 00000000..c12b7464 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator__coll__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator__coll__graph.md5 b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator__coll__graph.md5 new file mode 100644 index 00000000..e5c5cdfc --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator__coll__graph.md5 @@ -0,0 +1 @@ +acdc9f1db9ee3c29e7b6e954d4abd66e \ No newline at end of file diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator__coll__graph.svg b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator__coll__graph.svg new file mode 100644 index 00000000..e1d42c69 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator__coll__graph.svg @@ -0,0 +1,148 @@ + + + + + + + + + + + +gridfire::rates::weak::WeakRateInterpolator + + +Node1 + + +gridfire::rates::weak +::WeakRateInterpolator + + + + + +Node2 + + +std::unordered_map +< uint32_t, gridfire +::rates::weak::IsotopeGrid > + + + + + +Node2->Node1 + + + + + + m_rate_table + + + +Node3 + + +gridfire::rates::weak +::IsotopeGrid + + + + + +Node3->Node2 + + + + + + elements + + + +Node4 + + +std::vector< double > + + + + + +Node4->Node3 + + + + + + rhoYe_axis +t9_axis + + + +Node5 + + +std::vector< gridfire +::rates::weak::WeakRatePayload > + + + + + +Node5->Node3 + + + + + + data + + + +Node6 + + +gridfire::rates::weak +::WeakRatePayload + + + + + +Node6->Node5 + + + + + + elements + + + + + + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator__coll__graph_org.svg b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator__coll__graph_org.svg new file mode 100644 index 00000000..f4e8c6ec --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakRateInterpolator__coll__graph_org.svg @@ -0,0 +1,123 @@ + + + + + + +gridfire::rates::weak::WeakRateInterpolator + + +Node1 + + +gridfire::rates::weak +::WeakRateInterpolator + + + + + +Node2 + + +std::unordered_map +< uint32_t, gridfire +::rates::weak::IsotopeGrid > + + + + + +Node2->Node1 + + + + + + m_rate_table + + + +Node3 + + +gridfire::rates::weak +::IsotopeGrid + + + + + +Node3->Node2 + + + + + + elements + + + +Node4 + + +std::vector< double > + + + + + +Node4->Node3 + + + + + + rhoYe_axis +t9_axis + + + +Node5 + + +std::vector< gridfire +::rates::weak::WeakRatePayload > + + + + + +Node5->Node3 + + + + + + data + + + +Node6 + + +gridfire::rates::weak +::WeakRatePayload + + + + + +Node6->Node5 + + + + + + elements + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction-members.html b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction-members.html new file mode 100644 index 00000000..63ea147b --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction-members.html @@ -0,0 +1,154 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::rates::weak::WeakReaction Member List
+
+
+ +

This is the complete list of members for gridfire::rates::weak::WeakReaction, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
all_species() const overridegridfire::rates::weak::WeakReactionvirtual
calculate_energy_generation_rate(double T9, double rho, double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const overridegridfire::rates::weak::WeakReactionvirtual
calculate_energy_generation_rate(const CppAD::AD< double > &T9, const CppAD::AD< double > &rho, const CppAD::AD< double > &Ye, const CppAD::AD< double > &mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const overridegridfire::rates::weak::WeakReactionvirtual
calculate_log_rate_partial_deriv_wrt_T9(double T9, double rho, double Ye, double mue, const fourdst::composition::Composition &composition) const overridegridfire::rates::weak::WeakReactionvirtual
calculate_rate(double T9, double rho, double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const overridegridfire::rates::weak::WeakReactionvirtual
calculate_rate(CppAD::AD< double > T9, CppAD::AD< double > rho, CppAD::AD< double > Ye, CppAD::AD< double > mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const overridegridfire::rates::weak::WeakReactionvirtual
calculate_rate(T T9, T rho, T Ye, T mue, const std::vector< T > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) constgridfire::rates::weak::WeakReactionprivate
clone() const overridegridfire::rates::weak::WeakReactionvirtual
contains(const fourdst::atomic::Species &species) const overridegridfire::rates::weak::WeakReactionvirtual
contains_product(const fourdst::atomic::Species &species) const overridegridfire::rates::weak::WeakReactionvirtual
contains_reactant(const fourdst::atomic::Species &species) const overridegridfire::rates::weak::WeakReactionvirtual
countProductOccurrences(const fourdst::atomic::Species &species) const overridegridfire::rates::weak::WeakReactionvirtual
countReactantOccurrences(const fourdst::atomic::Species &species) const overridegridfire::rates::weak::WeakReactionvirtual
get_log_neutrino_loss_from_payload(const WeakRatePayload &payload) constgridfire::rates::weak::WeakReactionprivate
get_log_rate_from_payload(const WeakRatePayload &payload) constgridfire::rates::weak::WeakReactionprivate
getRateCoefficients() const overridegridfire::rates::weak::WeakReactioninlinevirtual
getWeakRateInterpolator() constgridfire::rates::weak::WeakReaction
hash(uint64_t seed) const overridegridfire::rates::weak::WeakReactionvirtual
id() const overridegridfire::rates::weak::WeakReactionvirtual
is_reverse() const overridegridfire::rates::weak::WeakReactionvirtual
m_atomicgridfire::rates::weak::WeakReactionmutableprivate
m_constantsgridfire::rates::weak::WeakReactionprivate
m_idgridfire::rates::weak::WeakReactionprivate
m_interpolatorgridfire::rates::weak::WeakReactionprivate
m_productgridfire::rates::weak::WeakReactionprivate
m_product_agridfire::rates::weak::WeakReactionprivate
m_product_zgridfire::rates::weak::WeakReactionprivate
m_productsgridfire::rates::weak::WeakReactionprivate
m_reactantgridfire::rates::weak::WeakReactionprivate
m_reactant_agridfire::rates::weak::WeakReactionprivate
m_reactant_zgridfire::rates::weak::WeakReactionprivate
m_reactantsgridfire::rates::weak::WeakReactionprivate
m_typegridfire::rates::weak::WeakReactionprivate
num_species() const overridegridfire::rates::weak::WeakReactionvirtual
product_species() const overridegridfire::rates::weak::WeakReactionvirtual
products() const overridegridfire::rates::weak::WeakReactionvirtual
qValue() const overridegridfire::rates::weak::WeakReactionvirtual
reactant_species() const overridegridfire::rates::weak::WeakReactionvirtual
reactants() const overridegridfire::rates::weak::WeakReactionvirtual
stoichiometry() const overridegridfire::rates::weak::WeakReactionvirtual
stoichiometry(const fourdst::atomic::Species &species) const overridegridfire::rates::weak::WeakReactionvirtual
type() const overridegridfire::rates::weak::WeakReactionvirtual
WeakReaction(const fourdst::atomic::Species &species, WeakReactionType type, const WeakRateInterpolator &interpolator)gridfire::rates::weak::WeakReactionexplicit
~Reaction()=defaultgridfire::reaction::Reactionvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction.html b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction.html new file mode 100644 index 00000000..cce1bec8 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction.html @@ -0,0 +1,1770 @@ + + + + + + + +GridFire: gridfire::rates::weak::WeakReaction Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Classes | +Public Member Functions | +Private Member Functions | +Private Attributes | +List of all members
+
gridfire::rates::weak::WeakReaction Class Referencefinal
+
+
+ +

Concrete Reaction representing a single weak process (beta±, e−/e+ capture). + More...

+ +

#include <weak.h>

+
+Inheritance diagram for gridfire::rates::weak::WeakReaction:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::rates::weak::WeakReaction:
+
+
+
[legend]
+ + + + + + + +

+Classes

class  AtomicWeakRate
 CppAD atomic that wraps weak-rate interpolation for AD evaluation. More...
 
struct  constants
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 WeakReaction (const fourdst::atomic::Species &species, WeakReactionType type, const WeakRateInterpolator &interpolator)
 Construct a WeakReaction for a specific weak channel and parent species.
 
double calculate_rate (double T9, double rho, double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const override
 Scalar weak reaction rate λ(T9, rho, Ye, μe) in 1/s.
 
CppAD::AD< double > calculate_rate (CppAD::AD< double > T9, CppAD::AD< double > rho, CppAD::AD< double > Ye, CppAD::AD< double > mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const override
 AD-enabled weak reaction rate λ(T9, rho, Ye, μe) in 1/s.
 
std::string_view id () const override
 Unique identifier string for the weak channel.
 
const std::vector< fourdst::atomic::Species > & reactants () const override
 Reactants list (parent nuclide only).
 
const std::vector< fourdst::atomic::Species > & products () const override
 Products list (daughter nuclide only).
 
bool contains (const fourdst::atomic::Species &species) const override
 Check if a species participates in this weak reaction.
 
bool contains_reactant (const fourdst::atomic::Species &species) const override
 Check if a species is the reactant (parent).
 
bool contains_product (const fourdst::atomic::Species &species) const override
 Check if a species is the product (daughter).
 
std::unordered_set< fourdst::atomic::Species > all_species () const override
 Set of both parent and daughter species.
 
std::unordered_set< fourdst::atomic::Species > reactant_species () const override
 Singleton set containing only the parent species.
 
std::unordered_set< fourdst::atomic::Species > product_species () const override
 Singleton set containing only the daughter species.
 
size_t num_species () const override
 Number of unique species involved (always 2 for weak reactions).
 
std::unordered_map< fourdst::atomic::Species, int > stoichiometry () const override
 Full stoichiometry map: parent -1, daughter +1.
 
int stoichiometry (const fourdst::atomic::Species &species) const override
 Stoichiometric coefficient for a species: -1 (parent), +1 (daughter), 0 otherwise.
 
uint64_t hash (uint64_t seed) const override
 Content-based 64-bit hash for this reaction.
 
double qValue () const override
 Q-value (MeV) based on nuclear mass differences and channel.
 
double calculate_energy_generation_rate (double T9, double rho, double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const override
 Net energy generation rate (MeV/s) for this weak reaction.
 
CppAD::AD< double > calculate_energy_generation_rate (const CppAD::AD< double > &T9, const CppAD::AD< double > &rho, const CppAD::AD< double > &Ye, const CppAD::AD< double > &mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const override
 AD-enabled net energy generation rate (MeV/s).
 
double calculate_log_rate_partial_deriv_wrt_T9 (double T9, double rho, double Ye, double mue, const fourdst::composition::Composition &composition) const override
 Logarithmic temperature sensitivity of the rate at the given state.
 
reaction::ReactionType type () const override
 Reaction type tag for runtime dispatch.
 
std::unique_ptr< Reaction > clone () const override
 Polymorphic deep copy.
 
bool is_reverse () const override
 Weak reactions are parameterized in the forward sense (never reverse).
 
const WeakRateInterpolator & getWeakRateInterpolator () const
 Access the underlying rate interpolator used by this reaction.
 
std::optional< std::vector< reaction::RateCoefficientSet > > getRateCoefficients () const override
 
size_t countReactantOccurrences (const fourdst::atomic::Species &species) const override
 
size_t countProductOccurrences (const fourdst::atomic::Species &species) const override
 
- Public Member Functions inherited from gridfire::reaction::Reaction
virtual ~Reaction ()=default
 Virtual destructor for correct polymorphic cleanup.
 
+ + + + + + + + + + + +

+Private Member Functions

template<IsArithmeticOrAD T>
T calculate_rate (T T9, T rho, T Ye, T mue, const std::vector< T > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const
 Internal unified implementation for scalar/AD rate evaluation.
 
double get_log_rate_from_payload (const WeakRatePayload &payload) const
 Extract the channel-specific log10(rate) from an interpolated payload. Mapping: β−→log_beta_minus, β+→log_beta_plus, e− capture→log_electron_capture, e+ capture→log_positron_capture.
 
double get_log_neutrino_loss_from_payload (const WeakRatePayload &payload) const
 Extract the channel-specific log10(neutrino loss) from a payload. Mapping: β−/e+ capture→log_antineutrino_loss_bd; β+/e− capture→log_neutrino_loss_ec.
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Private Attributes

const constants m_constants
 
fourdst::atomic::Species m_reactant
 
fourdst::atomic::Species m_product
 
std::vector< fourdst::atomic::Species > m_reactants
 
std::vector< fourdst::atomic::Species > m_products
 
size_t m_reactant_a
 
size_t m_reactant_z
 
size_t m_product_a
 
size_t m_product_z
 
std::string m_id
 
WeakReactionType m_type
 
const WeakRateInterpolator & m_interpolator
 
AtomicWeakRate m_atomic
 
+

Detailed Description

+

Concrete Reaction representing a single weak process (beta±, e−/e+ capture).

+

Wraps interpolation logic for tabulated weak rates and provides both scalar and AD interfaces for rate and energy generation. The reactants/products are the parent/daughter nuclei of the weak process.

+

the product nucleus is resolved from (A,Z) and channel via simple charge-changing rules (β−: Z+1; β+: Z−1; e− capture: Z−1; e+ capture: Z+1). The reaction ID is formatted like "Parent(channel)Product" with ν/ν̄ decorations, and an internal CppAD atomic (AtomicWeakRate) is prepared for AD energy calculations.

+

Constructor & Destructor Documentation

+ +

◆ WeakReaction()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
gridfire::rates::weak::WeakReaction::WeakReaction (const fourdst::atomic::Species & species,
WeakReactionType type,
const WeakRateInterpolator & interpolator 
)
+ 		+explicit
+
+ +

Construct a WeakReaction for a specific weak channel and parent species.

+
Parameters
+ + + + +
speciesParent nuclide undergoing the weak process.
typeThe weak reaction channel (beta−, beta+, e− capture, e+ capture).
interpolatorReference to a WeakRateInterpolator providing tabulated data.
+
+
+
Precondition
The product nuclide must be resolvable for the given (species, type).
+
Postcondition
Object is ready to compute rates using the provided interpolator.
+
Exceptions
+ + +
std::runtime_errorIf the product species cannot be resolved for the channel (product resolution uses the charge-changing rules described above).
+
+
+ +
+
+

Member Function Documentation

+ +

◆ all_species()

+ +
+
+ + + + + +
+ + + + + + + +
std::unordered_set< fourdst::atomic::Species > gridfire::rates::weak::WeakReaction::all_species () const
+ 		+overridevirtual
+
+ +

Set of both parent and daughter species.

+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ calculate_energy_generation_rate() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CppAD::AD< double > gridfire::rates::weak::WeakReaction::calculate_energy_generation_rate (const CppAD::AD< double > & T9,
const CppAD::AD< double > & rho,
const CppAD::AD< double > & Ye,
const CppAD::AD< double > & mue,
const std::vector< CppAD::AD< double > > & Y,
const std::unordered_map< size_t, fourdst::atomic::Species > & index_to_species_map 
) const
+ 		+overridevirtual
+
+ +

AD-enabled net energy generation rate (MeV/s).

+

Uses an internal CppAD atomic to compute two outputs at once: the rate λ and the neutrino loss ν_loss at (T9, log10(rho*Ye), μe). Returns λ · (Q − ν_loss). The atomic throws on interpolation failure.

+
Exceptions
+ + +
std::runtime_errorIf the atomic rate evaluation fails to interpolate.
+
+
+ +

Reimplemented from gridfire::reaction::Reaction.

+ +
+
+ +

◆ calculate_energy_generation_rate() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::rates::weak::WeakReaction::calculate_energy_generation_rate (double T9,
double rho,
double Ye,
double mue,
const std::vector< double > & Y,
const std::unordered_map< size_t, fourdst::atomic::Species > & index_to_species_map 
) const
+ 		+overridevirtual
+
+ +

Net energy generation rate (MeV/s) for this weak reaction.

+

Interpolates once to obtain both the log10(rate) and the appropriate log10(neutrino-loss) for the channel, converts to linear values, computes E_deposited = Q − ν_loss, and returns λ · E_deposited. Throws on interpolation failure.

+

Channel mapping for neutrino-loss column:

    +
  • β− decay and e+ capture: use log_antineutrino_loss_bd
    • +
  • β+ decay and e− capture: use log_neutrino_loss_ec
    • +
+
Parameters
+ + + + + + + +
T9Temperature in GK.
rhoDensity in g cm^-3.
YeElectron fraction.
mueElectron chemical potential (MeV).
YComposition vector (unused for weak channels).
index_to_species_mapIndex-to-species map (unused for weak channels).
+
+
+
Returns
Energy generation rate in MeV/s.
+
Exceptions
+ + +
std::runtime_errorOn interpolation failure.
+
+
+
Example
double eps = rxn.calculate_energy_generation_rate(3.0, 1e7, 0.5, 2.0, {}, {});
+
+ +

Reimplemented from gridfire::reaction::Reaction.

+ +
+
+ +

◆ calculate_log_rate_partial_deriv_wrt_T9()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::rates::weak::WeakReaction::calculate_log_rate_partial_deriv_wrt_T9 (double T9,
double rho,
double Ye,
double mue,
const fourdst::composition::Composition & composition 
) const
+ 		+overridevirtual
+
+ +

Logarithmic temperature sensitivity of the rate at the given state.

+

Implementation status: requests derivative tables from the interpolator and throws on failure; otherwise the function is not yet implemented and does not return a value. Avoid calling until implemented.

+
Parameters
+ + + + + + +
T9Temperature in GK.
rhoDensity in g cm^-3.
YeElectron fraction.
mueElectron chemical potential (MeV).
compositionComposition context (not used by weak channels presently).
+
+
+
Returns
d ln λ / d ln T9.
+
Exceptions
+ + +
std::runtime_errorOn interpolation failure.
+
+
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ calculate_rate() [1/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CppAD::AD< double > gridfire::rates::weak::WeakReaction::calculate_rate (CppAD::AD< double > T9,
CppAD::AD< double > rho,
CppAD::AD< double > Ye,
CppAD::AD< double > mue,
const std::vector< CppAD::AD< double > > & Y,
const std::unordered_map< size_t, fourdst::atomic::Species > & index_to_species_map 
) const
+ 		+overridevirtual
+
+ +

AD-enabled weak reaction rate λ(T9, rho, Ye, μe) in 1/s.

+

Current implementation returns 0.0. AD support is provided for the energy-generation overload below using an internal CppAD atomic that evaluates both the rate and neutrino loss consistently. A future implementation may mirror that atomic here and return the AD rate.

+
Parameters
+ + + + + + + +
T9Temperature in GK (AD type).
rhoMass density (g cm^-3, AD type).
YeElectron fraction (AD type).
mueElectron chemical potential (MeV, AD type).
YComposition vector (unused for weak channels).
index_to_species_mapIndex-to-species map (unused for weak channels).
+
+
+
Returns
Reaction rate (1/s) as CppAD::AD<double> (currently 0.0).
+
Example
using AD = CppAD::AD<double>;
+
AD lambda_ad = rxn.calculate_rate(AD(3.0), AD(1e7), AD(0.5), AD(2.0), {}, {});
+
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ calculate_rate() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::rates::weak::WeakReaction::calculate_rate (double T9,
double rho,
double Ye,
double mue,
const std::vector< double > & Y,
const std::unordered_map< size_t, fourdst::atomic::Species > & index_to_species_map 
) const
+ 		+overridevirtual
+
+ +

Scalar weak reaction rate λ(T9, rho, Ye, μe) in 1/s.

+

Performs a single interpolation of the weak-rate tables at (T9, log10(rho*Ye), μe). If the selected log10(rate) is ≤ sentinel (-60), returns 0; otherwise returns 10^{log10(rate)}. On interpolation failure, throws with a message including (A,Z) and the state point.

+
Parameters
+ + + + + + + +
T9Temperature in GK (1e9 K).
rhoMass density (g cm^-3).
YeElectron fraction.
mueElectron chemical potential (MeV).
YComposition vector (unused for weak channels).
index_to_species_mapIndex-to-species map (unused for weak channels).
+
+
+
Returns
Reaction rate (1/s).
+
Exceptions
+ + +
std::runtime_errorOn interpolation failure.
+
+
+
Example
double lambda = rxn.calculate_rate(2.0, 1e8, 0.4, 1.5, {}, {});
+
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ calculate_rate() [3/3]

+ +
+
+
+template<IsArithmeticOrAD T>
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
T gridfire::rates::weak::WeakReaction::calculate_rate (T T9,
T rho,
T Ye,
T mue,
const std::vector< T > & Y,
const std::unordered_map< size_t, fourdst::atomic::Species > & index_to_species_map 
) const
+ 		+private
+
+ +

Internal unified implementation for scalar/AD rate evaluation.

+
Template Parameters
+ + +
Tdouble or CppAD::AD<double>.
+
+
+
Parameters
+ + + + +
T9,rho,Ye,mueThermodynamic state.
YComposition vector (unused for weak channels).
index_to_species_mapIndex-to-species map (unused for weak channels).
+
+
+
Returns
Reaction rate (1/s) as T. For double, performs table interpolation and returns 0 when the tabulated log10(rate) ≤ sentinel; for AD, calls the atomic and returns the first output.
+
Precondition
T9 > 0, rho > 0, 0 < Ye <= 1.
+
Postcondition
No persistent state is modified.
+
Exceptions
+ + +
std::runtime_errorIf interpolation fails (double path) or the atomic fails (AD path).
+
+
+ +
+
+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< reaction::Reaction > gridfire::rates::weak::WeakReaction::clone () const
+ 		+overridevirtual
+
+ +

Polymorphic deep copy.

+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ contains()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::rates::weak::WeakReaction::contains (const fourdst::atomic::Species & species) const
+ 		+overridevirtual
+
+ +

Check if a species participates in this weak reaction.

+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ contains_product()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::rates::weak::WeakReaction::contains_product (const fourdst::atomic::Species & species) const
+ 		+overridevirtual
+
+ +

Check if a species is the product (daughter).

+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ contains_reactant()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::rates::weak::WeakReaction::contains_reactant (const fourdst::atomic::Species & species) const
+ 		+overridevirtual
+
+ +

Check if a species is the reactant (parent).

+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ countProductOccurrences()

+ +
+
+ + + + + +
+ + + + + + + + +
size_t gridfire::rates::weak::WeakReaction::countProductOccurrences (const fourdst::atomic::Species & species) const
+ 		+overridevirtual
+
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ countReactantOccurrences()

+ +
+
+ + + + + +
+ + + + + + + + +
size_t gridfire::rates::weak::WeakReaction::countReactantOccurrences (const fourdst::atomic::Species & species) const
+ 		+overridevirtual
+
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ get_log_neutrino_loss_from_payload()

+ +
+
+ + + + + +
+ + + + + + + + +
double gridfire::rates::weak::WeakReaction::get_log_neutrino_loss_from_payload (const WeakRatePayload & payload) const
+ 		+private
+
+ +

Extract the channel-specific log10(neutrino loss) from a payload. Mapping: β−/e+ capture→log_antineutrino_loss_bd; β+/e− capture→log_neutrino_loss_ec.

+ +
+
+ +

◆ get_log_rate_from_payload()

+ +
+
+ + + + + +
+ + + + + + + + +
double gridfire::rates::weak::WeakReaction::get_log_rate_from_payload (const WeakRatePayload & payload) const
+ 		+private
+
+ +

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

+ +
+
+ +

◆ getRateCoefficients()

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

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ getWeakRateInterpolator()

+ +
+
+ + + + + + + +
const WeakRateInterpolator & gridfire::rates::weak::WeakReaction::getWeakRateInterpolator () const
+
+ +

Access the underlying rate interpolator used by this reaction.

+ +
+
+ +

◆ hash()

+ +
+
+ + + + + +
+ + + + + + + + +
uint64_t gridfire::rates::weak::WeakReaction::hash (uint64_t seed) const
+ 		+overridevirtual
+
+ +

Content-based 64-bit hash for this reaction.

+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ id()

+ +
+
+ + + + + +
+ + + + + + + +
std::string_view gridfire::rates::weak::WeakReaction::id () const
+ 		+overridevirtual
+
+ +

Unique identifier string for the weak channel.

+
Returns
A stable string view (e.g., "Fe52(e-,ν)Mn52").
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ is_reverse()

+ +
+
+ + + + + +
+ + + + + + + +
bool gridfire::rates::weak::WeakReaction::is_reverse () const
+ 		+overridevirtual
+
+ +

Weak reactions are parameterized in the forward sense (never reverse).

+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ num_species()

+ +
+
+ + + + + +
+ + + + + + + +
size_t gridfire::rates::weak::WeakReaction::num_species () const
+ 		+overridevirtual
+
+ +

Number of unique species involved (always 2 for weak reactions).

+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ product_species()

+ +
+
+ + + + + +
+ + + + + + + +
std::unordered_set< fourdst::atomic::Species > gridfire::rates::weak::WeakReaction::product_species () const
+ 		+overridevirtual
+
+ +

Singleton set containing only the daughter species.

+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ products()

+ +
+
+ + + + + +
+ + + + + + + +
const std::vector< fourdst::atomic::Species > & gridfire::rates::weak::WeakReaction::products () const
+ 		+overridevirtual
+
+ +

Products list (daughter nuclide only).

+
Returns
Vector with the daughter species.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ qValue()

+ +
+
+ + + + + +
+ + + + + + + +
double gridfire::rates::weak::WeakReaction::qValue () const
+ 		+overridevirtual
+
+ +

Q-value (MeV) based on nuclear mass differences and channel.

+

Computes Q = (M_parent − M_daughter) c^2 converted to MeV. For β+ decay subtract 2 m_e c^2, for e+ capture add 2 m_e c^2; for β− and e− capture it is just the nuclear mass difference. Neutrino rest mass is ignored.

+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ reactant_species()

+ +
+
+ + + + + +
+ + + + + + + +
std::unordered_set< fourdst::atomic::Species > gridfire::rates::weak::WeakReaction::reactant_species () const
+ 		+overridevirtual
+
+ +

Singleton set containing only the parent species.

+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ reactants()

+ +
+
+ + + + + +
+ + + + + + + +
const std::vector< fourdst::atomic::Species > & gridfire::rates::weak::WeakReaction::reactants () const
+ 		+overridevirtual
+
+ +

Reactants list (parent nuclide only).

+
Returns
Vector with the parent species.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ stoichiometry() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
std::unordered_map< fourdst::atomic::Species, int > gridfire::rates::weak::WeakReaction::stoichiometry () const
+ 		+overridevirtual
+
+ +

Full stoichiometry map: parent -1, daughter +1.

+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ stoichiometry() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
int gridfire::rates::weak::WeakReaction::stoichiometry (const fourdst::atomic::Species & species) const
+ 		+overridevirtual
+
+ +

Stoichiometric coefficient for a species: -1 (parent), +1 (daughter), 0 otherwise.

+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ type()

+ +
+
+ + + + + +
+ + + + + + + +
reaction::ReactionType gridfire::rates::weak::WeakReaction::type () const
+ 		+overridevirtual
+
+ +

Reaction type tag for runtime dispatch.

+ +

Implements gridfire::reaction::Reaction.

+ +
+
+

Member Data Documentation

+ +

◆ m_atomic

+ +
+
+ + + + + +
+ + + + +
AtomicWeakRate gridfire::rates::weak::WeakReaction::m_atomic
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_constants

+ +
+
+ + + + + +
+ + + + +
const constants gridfire::rates::weak::WeakReaction::m_constants
+ 		+private
+
+ +
+
+ +

◆ m_id

+ +
+
+ + + + + +
+ + + + +
std::string gridfire::rates::weak::WeakReaction::m_id
+ 		+private
+
+ +
+
+ +

◆ m_interpolator

+ +
+
+ + + + + +
+ + + + +
const WeakRateInterpolator& gridfire::rates::weak::WeakReaction::m_interpolator
+ 		+private
+
+ +
+
+ +

◆ m_product

+ +
+
+ + + + + +
+ + + + +
fourdst::atomic::Species gridfire::rates::weak::WeakReaction::m_product
+ 		+private
+
+ +
+
+ +

◆ m_product_a

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::rates::weak::WeakReaction::m_product_a
+ 		+private
+
+ +
+
+ +

◆ m_product_z

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::rates::weak::WeakReaction::m_product_z
+ 		+private
+
+ +
+
+ +

◆ m_products

+ +
+
+ + + + + +
+ + + + +
std::vector<fourdst::atomic::Species> gridfire::rates::weak::WeakReaction::m_products
+ 		+private
+
+ +
+
+ +

◆ m_reactant

+ +
+
+ + + + + +
+ + + + +
fourdst::atomic::Species gridfire::rates::weak::WeakReaction::m_reactant
+ 		+private
+
+ +
+
+ +

◆ m_reactant_a

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::rates::weak::WeakReaction::m_reactant_a
+ 		+private
+
+ +
+
+ +

◆ m_reactant_z

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::rates::weak::WeakReaction::m_reactant_z
+ 		+private
+
+ +
+
+ +

◆ m_reactants

+ +
+
+ + + + + +
+ + + + +
std::vector<fourdst::atomic::Species> gridfire::rates::weak::WeakReaction::m_reactants
+ 		+private
+
+ +
+
+ +

◆ m_type

+ +
+
+ + + + + +
+ + + + +
WeakReactionType gridfire::rates::weak::WeakReaction::m_type
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction.js b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction.js new file mode 100644 index 00000000..2b254c2c --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction.js @@ -0,0 +1,48 @@ +var classgridfire_1_1rates_1_1weak_1_1WeakReaction = +[ + [ "AtomicWeakRate", "classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate.html", "classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate" ], + [ "constants", "structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.html", "structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants" ], + [ "WeakReaction", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a222c0662bf5323037c9fdddfb929d4f7", null ], + [ "all_species", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a6e567323ca019eadcbb9dbb814ebeb0b", null ], + [ "calculate_energy_generation_rate", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#af515e3587a1050c4bc59657696be5f9b", null ], + [ "calculate_energy_generation_rate", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a091d6d4aa59f788c97f9b5481f46f1b5", null ], + [ "calculate_log_rate_partial_deriv_wrt_T9", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#ac2d5366d4b5766413db34558dbce3cb3", null ], + [ "calculate_rate", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a90ca346e2321516656b83d863416671e", null ], + [ "calculate_rate", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a05df0657efed55eb4262c7834d81400a", null ], + [ "calculate_rate", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#aa28f151d4ce14e0d6fcbecb07d03cd28", null ], + [ "clone", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#ac10e1451d20876f6eab199e127f213c7", null ], + [ "contains", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a745b161968f37873b5d40fe6bf9d2118", null ], + [ "contains_product", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a957b5bfe70e536290ef677a7c5b6643f", null ], + [ "contains_reactant", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a98095e6536d9a6434c5955f4c169d505", null ], + [ "countProductOccurrences", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#aeba08ed8204fc4999dc0324076d67d2a", null ], + [ "countReactantOccurrences", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#acfc3740ed0aa72986b2c1bc2666974d6", null ], + [ "get_log_neutrino_loss_from_payload", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a7f0d21c80fbbf94ead613e678d44b835", null ], + [ "get_log_rate_from_payload", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a14555633289fc3822e927afca7401e49", null ], + [ "getRateCoefficients", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a768eed406cc08057ed09e5daf5494650", null ], + [ "getWeakRateInterpolator", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#aefc75b3149bee2da878177279ad375da", null ], + [ "hash", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#ad2ba6b584cb2df7c15633fca81ce6af1", null ], + [ "id", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#ad01a15d95878c9edbf57cd9045c4413b", null ], + [ "is_reverse", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a90b62d922d91832859516450cf8e3876", null ], + [ "num_species", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a1210917ca1727ea474bb606cf8279edb", null ], + [ "product_species", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a5c60feacb0ac48b35323d9f688315316", null ], + [ "products", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#aed0ea28ed3ba96a9f86aa9db947ec01c", null ], + [ "qValue", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#afedb724bf9f1c8fc91d853f2bedb10cb", null ], + [ "reactant_species", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#aae06ff559026e3ce242a42cdd888c5a0", null ], + [ "reactants", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a1362d46630f30203027093e35883d1b1", null ], + [ "stoichiometry", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a8bf7dc26d9f1375625df99bceba08a44", null ], + [ "stoichiometry", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a1f4acfdb39bb861aaee9f3f28cfc406e", null ], + [ "type", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#aade329265a26bdc005c0793ba7a36ab2", null ], + [ "m_atomic", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a4f2bf61b35566e439ac8a48da265d215", null ], + [ "m_constants", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a2f0ee4c0d52db0f58781f90dd39dc0f7", null ], + [ "m_id", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a79877bd387bd891e602adff3f99cb4c5", null ], + [ "m_interpolator", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#adf203cbae7d7afcd274020b5210b426b", null ], + [ "m_product", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#aee395d13ed3a515d5c1d69bedffca5de", null ], + [ "m_product_a", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a2567545c89eb847a15909b02fa0f383e", null ], + [ "m_product_z", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#ab1be1d3010ff539b8a911506734fd9cf", null ], + [ "m_products", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a71ca233a081c7aed54ace061ea362231", null ], + [ "m_reactant", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#aeaceef054714e2a9667986406107ba3a", null ], + [ "m_reactant_a", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a37dfb1d460e78e81a6def62e7217e6f8", null ], + [ "m_reactant_z", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a3d1b52076e102d07acb7200a7ee99165", null ], + [ "m_reactants", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a46c36a6e517fb00a2ac3cbb0f546a341", null ], + [ "m_type", "classgridfire_1_1rates_1_1weak_1_1WeakReaction.html#a92c3590161c63c6ed4e7650d2b7beee3", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap-members.html b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap-members.html new file mode 100644 index 00000000..3d6fb32d --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap-members.html @@ -0,0 +1,116 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::rates::weak::WeakReactionMap Member List
+
+
+ +

This is the complete list of members for gridfire::rates::weak::WeakReactionMap, including all inherited members.

+ + + + + + + +
get_all_reactions() constgridfire::rates::weak::WeakReactionMap
get_species_reactions(const fourdst::atomic::Species &species) constgridfire::rates::weak::WeakReactionMap
get_species_reactions(const std::string &species_name) constgridfire::rates::weak::WeakReactionMap
m_weak_networkgridfire::rates::weak::WeakReactionMapprivate
WeakReactionMap()gridfire::rates::weak::WeakReactionMap
~WeakReactionMap()=defaultgridfire::rates::weak::WeakReactionMap
+
+ + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap.html b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap.html new file mode 100644 index 00000000..8cc3f8ee --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap.html @@ -0,0 +1,318 @@ + + + + + + + +GridFire: gridfire::rates::weak::WeakReactionMap Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
gridfire::rates::weak::WeakReactionMap Class Reference
+
+
+ +

Index of available weak reactions keyed by species. + More...

+ +

#include <weak.h>

+
+Collaboration diagram for gridfire::rates::weak::WeakReactionMap:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + +

+Public Member Functions

 WeakReactionMap ()
 Construct the map by loading all weak reaction entries.
 
 ~WeakReactionMap ()=default
 
std::vector< WeakReactionEntry > get_all_reactions () const
 Return a flat list of all weak reaction entries.
 
std::expected< std::vector< WeakReactionEntry >, WeakMapError > get_species_reactions (const fourdst::atomic::Species &species) const
 Get all weak reaction entries for a given species.
 
std::expected< std::vector< WeakReactionEntry >, WeakMapError > get_species_reactions (const std::string &species_name) const
 Get all weak reaction entries for a given species by name.
 
+ + + +

+Private Attributes

std::unordered_map< fourdst::atomic::Species, std::vector< WeakReactionEntry > > m_weak_network
 
+

Detailed Description

+

Index of available weak reactions keyed by species.

+

Builds an in-memory map from the compiled weak-rate tables and provides simple query helpers to retrieve all weak reactions or those that involve a particular nuclide.

+

Implementation summary: the constructor iterates over UNIFIED_WEAK_DATA and inserts entries keyed by the parent Species. For each channel (β−, β+, e−-capture, e+-capture), if the tabulated log10(rate) is above the sentinel (-60), a WeakReactionEntry is pushed containing the grids t9, log10(rho*Ye), mu_e, the log10(rate), and the corresponding log10(neutrino loss) column.

+

Constructor & Destructor Documentation

+ +

◆ WeakReactionMap()

+ +
+
+ + + + + + + +
gridfire::rates::weak::WeakReactionMap::WeakReactionMap ()
+
+ +

Construct the map by loading all weak reaction entries.

+
Postcondition
All valid reactions from the compiled data are available via get_all_reactions() and get_species_reactions(). Implementation: iterates UNIFIED_WEAK_DATA, filters any log(rate) <= -60, and groups entries by parent Species.
+ +
+
+ +

◆ ~WeakReactionMap()

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::rates::weak::WeakReactionMap::~WeakReactionMap ()
+ 		+default
+
+ +
+
+

Member Function Documentation

+ +

◆ get_all_reactions()

+ +
+
+ + + + + + + +
std::vector< WeakReactionEntry > gridfire::rates::weak::WeakReactionMap::get_all_reactions () const
+
+ +

Return a flat list of all weak reaction entries.

+
Returns
Vector of WeakReactionEntry records.
+
Example
WeakReactionMap map;
+
auto all = map.get_all_reactions();
+
// iterate or group as needed
+
gridfire::rates::weak::WeakReactionMap
Index of available weak reactions keyed by species.
Definition weak.h:41
+
gridfire::rates::weak::WeakReactionMap::get_all_reactions
std::vector< WeakReactionEntry > get_all_reactions() const
Return a flat list of all weak reaction entries.
Definition weak.cpp:166
+
+ +
+
+ +

◆ get_species_reactions() [1/2]

+ +
+
+ + + + + + + + +
std::expected< std::vector< WeakReactionEntry >, WeakMapError > gridfire::rates::weak::WeakReactionMap::get_species_reactions (const fourdst::atomic::Species & species) const
+
+ +

Get all weak reaction entries for a given species.

+
Parameters
+ + +
speciesNuclide to query (A,Z).
+
+
+
Returns
expected<vector<WeakReactionEntry>, WeakMapError> containing reactions on success or SPECIES_NOT_FOUND on failure.
+
Example
using fourdst::atomic::Species;
+
WeakReactionMap map;
+
Species fe52 = fourdst::atomic::az_to_species(52, 26);
+
if (auto res = map.get_species_reactions(fe52); res) {
+
for (const auto& e : *res) { } // use e
+
} else {
+
// handle WeakMapError::SPECIES_NOT_FOUND
+
}
+
gridfire::rates::weak::WeakReactionMap::get_species_reactions
std::expected< std::vector< WeakReactionEntry >, WeakMapError > get_species_reactions(const fourdst::atomic::Species &species) const
Get all weak reaction entries for a given species.
Definition weak.cpp:174
+
+ +
+
+ +

◆ get_species_reactions() [2/2]

+ +
+
+ + + + + + + + +
std::expected< std::vector< WeakReactionEntry >, WeakMapError > gridfire::rates::weak::WeakReactionMap::get_species_reactions (const std::string & species_name) const
+
+ +

Get all weak reaction entries for a given species by name.

+
Parameters
+ + +
species_nameSymbolic name (e.g., "Fe52").
+
+
+
Returns
expected<vector<WeakReactionEntry>, WeakMapError> containing reactions on success or SPECIES_NOT_FOUND on failure.
+
Example
WeakReactionMap map;
+
if (auto res = map.get_species_reactions("Fe52"); res) {
+
// use *res
+
}
+
+ +
+
+

Member Data Documentation

+ +

◆ m_weak_network

+ +
+
+ + + + + +
+ + + + +
std::unordered_map<fourdst::atomic::Species, std::vector<WeakReactionEntry> > gridfire::rates::weak::WeakReactionMap::m_weak_network
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap.js b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap.js new file mode 100644 index 00000000..aa351113 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap.js @@ -0,0 +1,9 @@ +var classgridfire_1_1rates_1_1weak_1_1WeakReactionMap = +[ + [ "WeakReactionMap", "classgridfire_1_1rates_1_1weak_1_1WeakReactionMap.html#aecc8c1b92d63da87827879ad5330c11e", null ], + [ "~WeakReactionMap", "classgridfire_1_1rates_1_1weak_1_1WeakReactionMap.html#a73cc5a9d4a236091bbb40f22ed66b2f1", null ], + [ "get_all_reactions", "classgridfire_1_1rates_1_1weak_1_1WeakReactionMap.html#a9ab9f6f64455eb46172ebda5e8cc3ec5", null ], + [ "get_species_reactions", "classgridfire_1_1rates_1_1weak_1_1WeakReactionMap.html#a290da6766a6d3094a5aae8b7cbcd0d70", null ], + [ "get_species_reactions", "classgridfire_1_1rates_1_1weak_1_1WeakReactionMap.html#ad7345da84824495fb21c969c1a9c80f5", null ], + [ "m_weak_network", "classgridfire_1_1rates_1_1weak_1_1WeakReactionMap.html#a8169adef9b4b3c7552c7a8fdc945cf6f", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap__coll__graph.map b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap__coll__graph.map new file mode 100644 index 00000000..512989db --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap__coll__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap__coll__graph.md5 b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap__coll__graph.md5 new file mode 100644 index 00000000..640bf76c --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap__coll__graph.md5 @@ -0,0 +1 @@ +ebc75cac75393d6c7c89e8d88b845a1c \ No newline at end of file diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap__coll__graph.svg b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap__coll__graph.svg new file mode 100644 index 00000000..576eae35 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap__coll__graph.svg @@ -0,0 +1,186 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::rates::weak::WeakReactionMap + + +Node1 + + +gridfire::rates::weak +::WeakReactionMap + + + + + +Node2 + + +std::unordered_map +< fourdst::atomic::Species, + std::vector< gridfire:: +rates::weak::WeakReactionEntry > > + + + + + +Node2->Node1 + + + + + + m_weak_network + + + +Node3 + + +Species + + + + + +Node3->Node2 + + + + + + keys + + + +Node4 + + +std::vector< gridfire +::rates::weak::WeakReaction +Entry > + + + + + +Node4->Node2 + + + + + + elements + + + +Node5 + + +gridfire::rates::weak +::WeakReactionEntry + + + + + +Node5->Node4 + + + + + + elements + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap__coll__graph_org.svg b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap__coll__graph_org.svg new file mode 100644 index 00000000..4aa1c2c8 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReactionMap__coll__graph_org.svg @@ -0,0 +1,104 @@ + + + + + + +gridfire::rates::weak::WeakReactionMap + + +Node1 + + +gridfire::rates::weak +::WeakReactionMap + + + + + +Node2 + + +std::unordered_map +< fourdst::atomic::Species, + std::vector< gridfire:: +rates::weak::WeakReactionEntry > > + + + + + +Node2->Node1 + + + + + + m_weak_network + + + +Node3 + + +Species + + + + + +Node3->Node2 + + + + + + keys + + + +Node4 + + +std::vector< gridfire +::rates::weak::WeakReaction +Entry > + + + + + +Node4->Node2 + + + + + + elements + + + +Node5 + + +gridfire::rates::weak +::WeakReactionEntry + + + + + +Node5->Node4 + + + + + + elements + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate-members.html b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate-members.html new file mode 100644 index 00000000..4f90c27d --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate-members.html @@ -0,0 +1,121 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::rates::weak::WeakReaction::AtomicWeakRate Member List
+
+
+ +

This is the complete list of members for gridfire::rates::weak::WeakReaction::AtomicWeakRate, including all inherited members.

+ + + + + + + + + + + + +
AtomicWeakRate(const WeakRateInterpolator &interpolator, const size_t a, const size_t z, const WeakReactionType type)gridfire::rates::weak::WeakReaction::AtomicWeakRateinline
for_sparse_jac(size_t q, const CppAD::vector< std::set< size_t > > &r, CppAD::vector< std::set< size_t > > &s) overridegridfire::rates::weak::WeakReaction::AtomicWeakRate
for_sparse_jac(size_t q, const CppAD::vector< bool > &r, CppAD::vector< bool > &s, const CppAD::vector< double > &x) overridegridfire::rates::weak::WeakReaction::AtomicWeakRate
forward(size_t p, size_t q, const CppAD::vector< bool > &vx, CppAD::vector< bool > &vy, const CppAD::vector< double > &tx, CppAD::vector< double > &ty) overridegridfire::rates::weak::WeakReaction::AtomicWeakRate
m_agridfire::rates::weak::WeakReaction::AtomicWeakRateprivate
m_interpolatorgridfire::rates::weak::WeakReaction::AtomicWeakRateprivate
m_typegridfire::rates::weak::WeakReaction::AtomicWeakRateprivate
m_zgridfire::rates::weak::WeakReaction::AtomicWeakRateprivate
rev_sparse_jac(size_t q, const CppAD::vector< std::set< size_t > > &rt, CppAD::vector< std::set< size_t > > &st) overridegridfire::rates::weak::WeakReaction::AtomicWeakRate
rev_sparse_jac(size_t q, const CppAD::vector< bool > &rt, CppAD::vector< bool > &st, const CppAD::vector< double > &x) overridegridfire::rates::weak::WeakReaction::AtomicWeakRate
reverse(size_t q, const CppAD::vector< double > &tx, const CppAD::vector< double > &ty, CppAD::vector< double > &px, const CppAD::vector< double > &py) overridegridfire::rates::weak::WeakReaction::AtomicWeakRate
+
+ + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate.html b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate.html new file mode 100644 index 00000000..a499c64c --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate.html @@ -0,0 +1,618 @@ + + + + + + + +GridFire: gridfire::rates::weak::WeakReaction::AtomicWeakRate Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
gridfire::rates::weak::WeakReaction::AtomicWeakRate Class Referencefinal
+
+
+ +

CppAD atomic that wraps weak-rate interpolation for AD evaluation. + More...

+
+Inheritance diagram for gridfire::rates::weak::WeakReaction::AtomicWeakRate:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::rates::weak::WeakReaction::AtomicWeakRate:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 AtomicWeakRate (const WeakRateInterpolator &interpolator, const size_t a, const size_t z, const WeakReactionType type)
 Construct the atomic operation for a specific (A,Z) and channel.
 
bool forward (size_t p, size_t q, const CppAD::vector< bool > &vx, CppAD::vector< bool > &vy, const CppAD::vector< double > &tx, CppAD::vector< double > &ty) override
 Forward pass: compute rate and neutrino-loss values for AD. On failure to interpolate, throws a std::runtime_error with details; sets output sparsity such that both outputs depend on all inputs when any input is variable.
 
bool reverse (size_t q, const CppAD::vector< double > &tx, const CppAD::vector< double > &ty, CppAD::vector< double > &px, const CppAD::vector< double > &py) override
 Reverse pass: propagate adjoints using tabulated derivatives. Uses d log10 columns, converting to linear-scale derivatives via ln(10) scaling and chain rule with the forward-pass outputs.
 
bool for_sparse_jac (size_t q, const CppAD::vector< std::set< size_t > > &r, CppAD::vector< std::set< size_t > > &s) override
 Forward-mode sparsity for Jacobian.
 
bool rev_sparse_jac (size_t q, const CppAD::vector< std::set< size_t > > &rt, CppAD::vector< std::set< size_t > > &st) override
 Reverse-mode sparsity for Jacobian.
 
bool for_sparse_jac (size_t q, const CppAD::vector< bool > &r, CppAD::vector< bool > &s, const CppAD::vector< double > &x) override
 
bool rev_sparse_jac (size_t q, const CppAD::vector< bool > &rt, CppAD::vector< bool > &st, const CppAD::vector< double > &x) override
 
+ + + + + + + + + +

+Private Attributes

const WeakRateInterpolator & m_interpolator
 
const size_t m_a
 
const size_t m_z
 
const WeakReactionType m_type
 
+

Detailed Description

+

CppAD atomic that wraps weak-rate interpolation for AD evaluation.

+

Forward pass computes two outputs (λ, ν_loss) by interpolating the tables at the provided state; reverse pass uses derivative tables to backpropagate adjoints for all three inputs (T9, log10(rho*Ye), μe). Sparsity routines declare full dependence of both outputs on all inputs.

+

Constructor & Destructor Documentation

+ +

◆ AtomicWeakRate()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
gridfire::rates::weak::WeakReaction::AtomicWeakRate::AtomicWeakRate (const WeakRateInterpolator & interpolator,
const size_t a,
const size_t z,
const WeakReactionType type 
)
+ 		+inline
+
+ +

Construct the atomic operation for a specific (A,Z) and channel.

+
Parameters
+ + + + + +
interpolatorRate source.
aMass number A of the parent.
zProton number Z of the parent.
typeWeak channel.
+
+
+ +
+
+

Member Function Documentation

+ +

◆ for_sparse_jac() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
bool gridfire::rates::weak::WeakReaction::AtomicWeakRate::for_sparse_jac (size_t q,
const CppAD::vector< bool > & r,
CppAD::vector< bool > & s,
const CppAD::vector< double > & x 
)
+ 		+override
+
+ +
+
+ +

◆ for_sparse_jac() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool gridfire::rates::weak::WeakReaction::AtomicWeakRate::for_sparse_jac (size_t q,
const CppAD::vector< std::set< size_t > > & r,
CppAD::vector< std::set< size_t > > & s 
)
+ 		+override
+
+ +

Forward-mode sparsity for Jacobian.

+ +
+
+ +

◆ forward()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
bool gridfire::rates::weak::WeakReaction::AtomicWeakRate::forward (size_t p,
size_t q,
const CppAD::vector< bool > & vx,
CppAD::vector< bool > & vy,
const CppAD::vector< double > & tx,
CppAD::vector< double > & ty 
)
+ 		+override
+
+ +

Forward pass: compute rate and neutrino-loss values for AD. On failure to interpolate, throws a std::runtime_error with details; sets output sparsity such that both outputs depend on all inputs when any input is variable.

+ +
+
+ +

◆ rev_sparse_jac() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
bool gridfire::rates::weak::WeakReaction::AtomicWeakRate::rev_sparse_jac (size_t q,
const CppAD::vector< bool > & rt,
CppAD::vector< bool > & st,
const CppAD::vector< double > & x 
)
+ 		+override
+
+ +
+
+ +

◆ rev_sparse_jac() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool gridfire::rates::weak::WeakReaction::AtomicWeakRate::rev_sparse_jac (size_t q,
const CppAD::vector< std::set< size_t > > & rt,
CppAD::vector< std::set< size_t > > & st 
)
+ 		+override
+
+ +

Reverse-mode sparsity for Jacobian.

+ +
+
+ +

◆ reverse()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
bool gridfire::rates::weak::WeakReaction::AtomicWeakRate::reverse (size_t q,
const CppAD::vector< double > & tx,
const CppAD::vector< double > & ty,
CppAD::vector< double > & px,
const CppAD::vector< double > & py 
)
+ 		+override
+
+ +

Reverse pass: propagate adjoints using tabulated derivatives. Uses d log10 columns, converting to linear-scale derivatives via ln(10) scaling and chain rule with the forward-pass outputs.

+ +
+
+

Member Data Documentation

+ +

◆ m_a

+ +
+
+ + + + + +
+ + + + +
const size_t gridfire::rates::weak::WeakReaction::AtomicWeakRate::m_a
+ 		+private
+
+ +
+
+ +

◆ m_interpolator

+ +
+
+ + + + + +
+ + + + +
const WeakRateInterpolator& gridfire::rates::weak::WeakReaction::AtomicWeakRate::m_interpolator
+ 		+private
+
+ +
+
+ +

◆ m_type

+ +
+
+ + + + + +
+ + + + +
const WeakReactionType gridfire::rates::weak::WeakReaction::AtomicWeakRate::m_type
+ 		+private
+
+ +
+
+ +

◆ m_z

+ +
+
+ + + + + +
+ + + + +
const size_t gridfire::rates::weak::WeakReaction::AtomicWeakRate::m_z
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate.js b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate.js new file mode 100644 index 00000000..f9a75811 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate.js @@ -0,0 +1,14 @@ +var classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate = +[ + [ "AtomicWeakRate", "classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate.html#a46d76ca50ee00198a9f4a873c6ceb874", null ], + [ "for_sparse_jac", "classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate.html#ae4c3bb00eafddb923be7ba4c3b6a25ff", null ], + [ "for_sparse_jac", "classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate.html#a976a2ef2e58439429c1a6e94c27f4662", null ], + [ "forward", "classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate.html#ab4f12e8da29d4d158fb0adf2db31b4bb", null ], + [ "rev_sparse_jac", "classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate.html#a9f2681d58e10b6b740b4588efbce5ae5", null ], + [ "rev_sparse_jac", "classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate.html#ae9d61bdda761da89733408c232d7220e", null ], + [ "reverse", "classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate.html#aad13654ea15547c2c95035c3b7937d58", null ], + [ "m_a", "classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate.html#a0beb567afdecd85e336b493ff85326bd", null ], + [ "m_interpolator", "classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate.html#a874efa5a57427c8afecd0375094da6e9", null ], + [ "m_type", "classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate.html#ae78d2a9b20c22a6ad624f4d968cbf639", null ], + [ "m_z", "classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate.html#a292dfe5fdfd3b90a36906f5f609a4c1c", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__coll__graph.map b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__coll__graph.map new file mode 100644 index 00000000..fd906883 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__coll__graph.map @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__coll__graph.md5 b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__coll__graph.md5 new file mode 100644 index 00000000..ef38c7f5 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__coll__graph.md5 @@ -0,0 +1 @@ +5064867800593b339765bcffe62d525c \ No newline at end of file diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__coll__graph.svg b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__coll__graph.svg new file mode 100644 index 00000000..b08ef968 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__coll__graph.svg @@ -0,0 +1,187 @@ + + + + + + + + + + + +gridfire::rates::weak::WeakReaction::AtomicWeakRate + + +Node1 + + +gridfire::rates::weak +::WeakReaction::AtomicWeakRate + + + + + +Node2 + + +CppAD::atomic_base +< double > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::rates::weak +::WeakRateInterpolator + + + + + +Node3->Node1 + + + + + + m_interpolator + + + +Node4 + + +std::unordered_map +< uint32_t, gridfire +::rates::weak::IsotopeGrid > + + + + + +Node4->Node3 + + + + + + m_rate_table + + + +Node5 + + +gridfire::rates::weak +::IsotopeGrid + + + + + +Node5->Node4 + + + + + + elements + + + +Node6 + + +std::vector< double > + + + + + +Node6->Node5 + + + + + + rhoYe_axis +t9_axis + + + +Node7 + + +std::vector< gridfire +::rates::weak::WeakRatePayload > + + + + + +Node7->Node5 + + + + + + data + + + +Node8 + + +gridfire::rates::weak +::WeakRatePayload + + + + + +Node8->Node7 + + + + + + elements + + + + + + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__coll__graph_org.svg b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__coll__graph_org.svg new file mode 100644 index 00000000..e4ecccbf --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__coll__graph_org.svg @@ -0,0 +1,162 @@ + + + + + + +gridfire::rates::weak::WeakReaction::AtomicWeakRate + + +Node1 + + +gridfire::rates::weak +::WeakReaction::AtomicWeakRate + + + + + +Node2 + + +CppAD::atomic_base +< double > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::rates::weak +::WeakRateInterpolator + + + + + +Node3->Node1 + + + + + + m_interpolator + + + +Node4 + + +std::unordered_map +< uint32_t, gridfire +::rates::weak::IsotopeGrid > + + + + + +Node4->Node3 + + + + + + m_rate_table + + + +Node5 + + +gridfire::rates::weak +::IsotopeGrid + + + + + +Node5->Node4 + + + + + + elements + + + +Node6 + + +std::vector< double > + + + + + +Node6->Node5 + + + + + + rhoYe_axis +t9_axis + + + +Node7 + + +std::vector< gridfire +::rates::weak::WeakRatePayload > + + + + + +Node7->Node5 + + + + + + data + + + +Node8 + + +gridfire::rates::weak +::WeakRatePayload + + + + + +Node8->Node7 + + + + + + elements + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__inherit__graph.map b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__inherit__graph.map new file mode 100644 index 00000000..dfd95d4e --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__inherit__graph.md5 b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__inherit__graph.md5 new file mode 100644 index 00000000..eb0adfd5 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__inherit__graph.md5 @@ -0,0 +1 @@ +38ab655efc4d36623d11bd02be730560 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__inherit__graph.svg b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__inherit__graph.svg new file mode 100644 index 00000000..f6a92ad9 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__inherit__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +gridfire::rates::weak::WeakReaction::AtomicWeakRate + + +Node1 + + +gridfire::rates::weak +::WeakReaction::AtomicWeakRate + + + + + +Node2 + + +CppAD::atomic_base +< double > + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__inherit__graph_org.svg b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__inherit__graph_org.svg new file mode 100644 index 00000000..48b153d0 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1AtomicWeakRate__inherit__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +gridfire::rates::weak::WeakReaction::AtomicWeakRate + + +Node1 + + +gridfire::rates::weak +::WeakReaction::AtomicWeakRate + + + + + +Node2 + + +CppAD::atomic_base +< double > + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__coll__graph.map b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__coll__graph.map new file mode 100644 index 00000000..194150a6 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__coll__graph.map @@ -0,0 +1,33 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__coll__graph.md5 b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__coll__graph.md5 new file mode 100644 index 00000000..aa34af55 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__coll__graph.md5 @@ -0,0 +1 @@ +d9b4b16ecbffefc5d8e228aa4070c27b \ No newline at end of file diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__coll__graph.svg b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__coll__graph.svg new file mode 100644 index 00000000..0add4b47 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__coll__graph.svg @@ -0,0 +1,402 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::rates::weak::WeakReaction + + +Node1 + + +gridfire::rates::weak +::WeakReaction + + + + + +Node2 + + +gridfire::reaction +::Reaction + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::rates::weak +::WeakReaction::constants + + + + + +Node3->Node1 + + + + + + m_constants + + + +Node4 + + +Species + + + + + +Node4->Node1 + + + + + + m_product +m_reactant + + + +Node5 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node4->Node5 + + + + + + elements + + + +Node5->Node1 + + + + + + m_products +m_reactants + + + +Node6 + + +std::string + + + + + +Node6->Node1 + + + + + + m_id + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8 + + +gridfire::rates::weak +::WeakRateInterpolator + + + + + +Node8->Node1 + + + + + + m_interpolator + + + +Node14 + + +gridfire::rates::weak +::WeakReaction::AtomicWeakRate + + + + + +Node8->Node14 + + + + + + m_interpolator + + + +Node9 + + +std::unordered_map +< uint32_t, gridfire +::rates::weak::IsotopeGrid > + + + + + +Node9->Node8 + + + + + + m_rate_table + + + +Node10 + + +gridfire::rates::weak +::IsotopeGrid + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +std::vector< double > + + + + + +Node11->Node10 + + + + + + rhoYe_axis +t9_axis + + + +Node12 + + +std::vector< gridfire +::rates::weak::WeakRatePayload > + + + + + +Node12->Node10 + + + + + + data + + + +Node13 + + +gridfire::rates::weak +::WeakRatePayload + + + + + +Node13->Node12 + + + + + + elements + + + +Node14->Node1 + + + + + + m_atomic + + + +Node15 + + +CppAD::atomic_base +< double > + + + + + +Node15->Node14 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__coll__graph_org.svg b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__coll__graph_org.svg new file mode 100644 index 00000000..d8d0fe6a --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__coll__graph_org.svg @@ -0,0 +1,320 @@ + + + + + + +gridfire::rates::weak::WeakReaction + + +Node1 + + +gridfire::rates::weak +::WeakReaction + + + + + +Node2 + + +gridfire::reaction +::Reaction + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::rates::weak +::WeakReaction::constants + + + + + +Node3->Node1 + + + + + + m_constants + + + +Node4 + + +Species + + + + + +Node4->Node1 + + + + + + m_product +m_reactant + + + +Node5 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node4->Node5 + + + + + + elements + + + +Node5->Node1 + + + + + + m_products +m_reactants + + + +Node6 + + +std::string + + + + + +Node6->Node1 + + + + + + m_id + + + +Node7 + + +std::basic_string< + Char > + + + + + +Node7->Node6 + + + + + + + + +Node8 + + +gridfire::rates::weak +::WeakRateInterpolator + + + + + +Node8->Node1 + + + + + + m_interpolator + + + +Node14 + + +gridfire::rates::weak +::WeakReaction::AtomicWeakRate + + + + + +Node8->Node14 + + + + + + m_interpolator + + + +Node9 + + +std::unordered_map +< uint32_t, gridfire +::rates::weak::IsotopeGrid > + + + + + +Node9->Node8 + + + + + + m_rate_table + + + +Node10 + + +gridfire::rates::weak +::IsotopeGrid + + + + + +Node10->Node9 + + + + + + elements + + + +Node11 + + +std::vector< double > + + + + + +Node11->Node10 + + + + + + rhoYe_axis +t9_axis + + + +Node12 + + +std::vector< gridfire +::rates::weak::WeakRatePayload > + + + + + +Node12->Node10 + + + + + + data + + + +Node13 + + +gridfire::rates::weak +::WeakRatePayload + + + + + +Node13->Node12 + + + + + + elements + + + +Node14->Node1 + + + + + + m_atomic + + + +Node15 + + +CppAD::atomic_base +< double > + + + + + +Node15->Node14 + + + + + + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__inherit__graph.map b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__inherit__graph.map new file mode 100644 index 00000000..ae0cf453 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__inherit__graph.md5 b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__inherit__graph.md5 new file mode 100644 index 00000000..fe04e494 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__inherit__graph.md5 @@ -0,0 +1 @@ +0df39b08aa84b3d3832e0e5ecf1437d4 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__inherit__graph.svg b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__inherit__graph.svg new file mode 100644 index 00000000..934f9eb0 --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__inherit__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +gridfire::rates::weak::WeakReaction + + +Node1 + + +gridfire::rates::weak +::WeakReaction + + + + + +Node2 + + +gridfire::reaction +::Reaction + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__inherit__graph_org.svg b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__inherit__graph_org.svg new file mode 100644 index 00000000..d7174f7c --- /dev/null +++ b/docs/html/classgridfire_1_1rates_1_1weak_1_1WeakReaction__inherit__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +gridfire::rates::weak::WeakReaction + + +Node1 + + +gridfire::rates::weak +::WeakReaction + + + + + +Node2 + + +gridfire::reaction +::Reaction + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction-members.html b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction-members.html new file mode 100644 index 00000000..55057729 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction-members.html @@ -0,0 +1,171 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::reaction::LogicalReaclibReaction Member List
+
+
+ +

This is the complete list of members for gridfire::reaction::LogicalReaclibReaction, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
add_reaction(const ReaclibReaction &reaction)gridfire::reaction::LogicalReaclibReaction
all_species() const overridegridfire::reaction::ReaclibReactionvirtual
begin()gridfire::reaction::LogicalReaclibReactioninline
begin() constgridfire::reaction::LogicalReaclibReactioninline
calculate_energy_generation_rate(const double T9, const double rho, const double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) constgridfire::reaction::Reactioninlinevirtual
calculate_energy_generation_rate(const CppAD::AD< double > &T9, const CppAD::AD< double > &rho, const CppAD::AD< double > &Ye, const CppAD::AD< double > &mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) constgridfire::reaction::Reactioninlinevirtual
calculate_log_rate_partial_deriv_wrt_T9(double T9, double rho, double Ye, double mue, const fourdst::composition::Composition &comp) const overridegridfire::reaction::LogicalReaclibReactionvirtual
calculate_rate(double T9, double rho, double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const overridegridfire::reaction::LogicalReaclibReactionvirtual
calculate_rate(CppAD::AD< double > T9, CppAD::AD< double > rho, CppAD::AD< double > Ye, CppAD::AD< double > mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const overridegridfire::reaction::LogicalReaclibReactionvirtual
calculate_rate(const T T9) constgridfire::reaction::LogicalReaclibReactioninlineprivate
chapter() constgridfire::reaction::ReaclibReactioninline
clone() const overridegridfire::reaction::LogicalReaclibReactionvirtual
contains(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactionvirtual
contains_product(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactionvirtual
contains_reactant(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactionvirtual
countProductOccurrences(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactioninlinevirtual
countReactantOccurrences(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactioninlinevirtual
end()gridfire::reaction::LogicalReaclibReactioninline
end() constgridfire::reaction::LogicalReaclibReactioninline
excess_energy() constgridfire::reaction::ReaclibReaction
getRateCoefficients() const overridegridfire::reaction::LogicalReaclibReactionvirtual
hash(uint64_t seed) const overridegridfire::reaction::ReaclibReactionvirtual
id() const overridegridfire::reaction::ReaclibReactioninlinevirtual
is_reverse() const overridegridfire::reaction::ReaclibReactioninlinevirtual
LogicalReaclibReaction(const std::vector< std::unique_ptr< ReaclibReaction > > &reactions)gridfire::reaction::LogicalReaclibReactionexplicit
LogicalReaclibReaction(const std::vector< std::unique_ptr< ReaclibReaction > > &reactions, bool reverse)gridfire::reaction::LogicalReaclibReactionexplicit
m_chaptergridfire::reaction::ReaclibReactionprotected
m_idgridfire::reaction::ReaclibReactionprotected
m_loggergridfire::reaction::ReaclibReactionprotected
m_peNamegridfire::reaction::ReaclibReactionprotected
m_productsgridfire::reaction::ReaclibReactionprotected
m_productsVecgridfire::reaction::ReaclibReactionmutableprotected
m_qValuegridfire::reaction::ReaclibReactionprotected
m_rateCoefficientsgridfire::reaction::ReaclibReactionprotected
m_ratesgridfire::reaction::LogicalReaclibReactionprivate
m_reactantsgridfire::reaction::ReaclibReactionprotected
m_reactantsVecgridfire::reaction::ReaclibReactionmutableprotected
m_reversegridfire::reaction::ReaclibReactionprotected
m_sourceLabelgridfire::reaction::ReaclibReactionprotected
m_sourcesgridfire::reaction::LogicalReaclibReactionprivate
m_weakgridfire::reaction::LogicalReaclibReactionprivate
num_species() const overridegridfire::reaction::ReaclibReactionvirtual
operator!=(const ReaclibReaction &other) constgridfire::reaction::ReaclibReactioninline
operator<<gridfire::reaction::LogicalReaclibReactionfriend
operator==(const ReaclibReaction &other) constgridfire::reaction::ReaclibReactioninline
peName() constgridfire::reaction::ReaclibReactioninlinevirtual
product_species() const overridegridfire::reaction::ReaclibReactionvirtual
products() const overridegridfire::reaction::ReaclibReactioninlinevirtual
qValue() const overridegridfire::reaction::ReaclibReactioninlinevirtual
rateCoefficients() constgridfire::reaction::ReaclibReactioninline
ReaclibReaction(std::string_view id, std::string_view peName, int chapter, const std::vector< fourdst::atomic::Species > &reactants, const std::vector< fourdst::atomic::Species > &products, double qValue, std::string_view label, const RateCoefficientSet &sets, bool reverse=false)gridfire::reaction::ReaclibReaction
reactant_species() const overridegridfire::reaction::ReaclibReactionvirtual
reactants() const overridegridfire::reaction::ReaclibReactioninlinevirtual
size() constgridfire::reaction::LogicalReaclibReactioninline
sourceLabel() constgridfire::reaction::ReaclibReactioninline
sources() constgridfire::reaction::LogicalReaclibReactioninline
stoichiometry(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactionvirtual
stoichiometry() const overridegridfire::reaction::ReaclibReactionvirtual
type() const overridegridfire::reaction::LogicalReaclibReactioninlinevirtual
~ReaclibReaction() override=defaultgridfire::reaction::ReaclibReaction
~Reaction()=defaultgridfire::reaction::Reactionvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction.html b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction.html new file mode 100644 index 00000000..9ac44ddf --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction.html @@ -0,0 +1,1080 @@ + + + + + + + +GridFire: gridfire::reaction::LogicalReaclibReaction Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Member Functions | +Private Attributes | +Friends | +List of all members
+
gridfire::reaction::LogicalReaclibReaction Class Referencefinal
+
+
+ +

Represents a "logical" reaction that aggregates rates from multiple sources. + More...

+ +

#include <reaction.h>

+
+Inheritance diagram for gridfire::reaction::LogicalReaclibReaction:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::reaction::LogicalReaclibReaction:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 LogicalReaclibReaction (const std::vector< std::unique_ptr< ReaclibReaction > > &reactions)
 Constructs a LogicalReaction from a vector of Reaction objects. Implicitly assumes that the logical reaction is for a forward (i.e. not reverse) reaction.
 
 LogicalReaclibReaction (const std::vector< std::unique_ptr< ReaclibReaction > > &reactions, bool reverse)
 
void add_reaction (const ReaclibReaction &reaction)
 Adds another Reaction source to this logical reaction.
 
size_t size () const
 Gets the number of source rates contributing to this logical reaction.
 
std::vector< std::string > sources () const
 Gets the list of source labels for the aggregated rates.
 
double calculate_rate (double T9, double rho, double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const override
 Calculates the total reaction rate by summing all source rates.
 
double calculate_log_rate_partial_deriv_wrt_T9 (double T9, double rho, double Ye, double mue, const fourdst::composition::Composition &comp) const override
 Logarithmic partial derivative of the rate with respect to temperature.
 
ReactionType type () const override
 Category of this reaction (e.g., REACLIB, WEAK, LOGICAL_REACLIB).
 
std::unique_ptr< Reaction > clone () const override
 Polymorphic deep copy.
 
CppAD::AD< double > calculate_rate (CppAD::AD< double > T9, CppAD::AD< double > rho, CppAD::AD< double > Ye, CppAD::AD< double > mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const override
 Calculates the total reaction rate using CppAD types.
 
std::optional< std::vector< RateCoefficientSet > > getRateCoefficients () const override
 
Iterators

Provides iterators to loop over the rate coefficient sets.

+
auto begin ()
 
auto begin () const
 
auto end ()
 
auto end () const
 
- Public Member Functions inherited from gridfire::reaction::ReaclibReaction
 ~ReaclibReaction () override=default
 
 ReaclibReaction (std::string_view id, std::string_view peName, int chapter, const std::vector< fourdst::atomic::Species > &reactants, const std::vector< fourdst::atomic::Species > &products, double qValue, std::string_view label, const RateCoefficientSet &sets, bool reverse=false)
 Constructs a Reaction object.
 
double calculate_rate (double T9, double rho, double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const override
 Calculates the reaction rate for a given temperature.
 
CppAD::AD< double > calculate_rate (CppAD::AD< double > T9, CppAD::AD< double > rho, CppAD::AD< double > Ye, CppAD::AD< double > mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const override
 Calculates the reaction rate for a given temperature using CppAD types.
 
double calculate_log_rate_partial_deriv_wrt_T9 (double T9, double rho, double Ye, double mue, const fourdst::composition::Composition &comp) const override
 Logarithmic partial derivative of the rate with respect to temperature.
 
virtual std::string_view peName () const
 Gets the reaction name in (projectile, ejectile) notation.
 
int chapter () const
 Gets the REACLIB chapter number.
 
std::string_view sourceLabel () const
 Gets the source label for the rate data.
 
ReactionType type () const override
 Category of this reaction (e.g., REACLIB, WEAK, LOGICAL_REACLIB).
 
const RateCoefficientSet & rateCoefficients () const
 Gets the set of rate coefficients.
 
std::optional< std::vector< RateCoefficientSet > > getRateCoefficients () const override
 
bool contains (const fourdst::atomic::Species &species) const override
 Checks if the reaction involves a given species as a reactant or product.
 
bool contains_reactant (const fourdst::atomic::Species &species) const override
 Checks if the reaction involves a given species as a reactant.
 
bool contains_product (const fourdst::atomic::Species &species) const override
 Checks if the reaction involves a given species as a product.
 
std::unordered_set< fourdst::atomic::Species > all_species () const override
 Gets a set of all unique species involved in the reaction.
 
std::unordered_set< fourdst::atomic::Species > reactant_species () const override
 Gets a set of all unique reactant species.
 
std::unordered_set< fourdst::atomic::Species > product_species () const override
 Gets a set of all unique product species.
 
size_t num_species () const override
 Gets the number of unique species involved in the reaction.
 
int stoichiometry (const fourdst::atomic::Species &species) const override
 Calculates the stoichiometric coefficient for a given species.
 
std::unordered_map< fourdst::atomic::Species, int > stoichiometry () const override
 Gets a map of all species to their stoichiometric coefficients.
 
std::string_view id () const override
 Gets the unique identifier of the reaction.
 
double qValue () const override
 Gets the Q-value of the reaction.
 
const std::vector< fourdst::atomic::Species > & reactants () const override
 Gets the vector of reactant species.
 
const std::vector< fourdst::atomic::Species > & products () const override
 Gets the vector of product species.
 
bool is_reverse () const override
 Checks if this is a reverse reaction rate.
 
double excess_energy () const
 Calculates the excess energy from the mass difference of reactants and products.
 
bool operator== (const ReaclibReaction &other) const
 Compares this reaction with another for equality based on their IDs.
 
bool operator!= (const ReaclibReaction &other) const
 Compares this reaction with another for inequality.
 
uint64_t hash (uint64_t seed) const override
 Computes a hash for the reaction based on its ID.
 
std::unique_ptr< Reaction > clone () const override
 Polymorphic deep copy.
 
size_t countReactantOccurrences (const fourdst::atomic::Species &species) const override
 
size_t countProductOccurrences (const fourdst::atomic::Species &species) const override
 
- Public Member Functions inherited from gridfire::reaction::Reaction
virtual ~Reaction ()=default
 Virtual destructor for correct polymorphic cleanup.
 
virtual double calculate_energy_generation_rate (const double T9, const double rho, const double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const
 Convenience: energy generation rate from this reaction (double version).
 
virtual CppAD::AD< double > calculate_energy_generation_rate (const CppAD::AD< double > &T9, const CppAD::AD< double > &rho, const CppAD::AD< double > &Ye, const CppAD::AD< double > &mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const
 Convenience: AD-enabled energy generation rate (AD version).
 
+ + + + + +

+Private Member Functions

template<typename T >
T calculate_rate (const T T9) const
 Template implementation for calculating the total reaction rate.
 
+ + + + + + + + + +

+Private Attributes

std::vector< std::string > m_sources
 List of source labels.
 
std::vector< RateCoefficientSet > m_rates
 List of rate coefficient sets from each source.
 
bool m_weak = false
 
+ + + +

+Friends

std::ostream & operator<< (std::ostream &os, const LogicalReaclibReaction &r)
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::reaction::ReaclibReaction
quill::Logger * m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
 
std::string m_id
 Unique identifier for the reaction (e.g., "h1+h1=>h2+e+nu").
 
std::string m_peName
 Name of the reaction in (projectile, ejectile) notation (e.g. "p(p,g)d").
 
int m_chapter
 Chapter number from the REACLIB database, defining the reaction structure.
 
double m_qValue = 0.0
 Q-value of the reaction in MeV.
 
std::unordered_map< fourdst::atomic::Species, size_t > m_reactants
 Reactants of the reaction.
 
std::unordered_map< fourdst::atomic::Species, size_t > m_products
 Products of the reaction.
 
std::optional< std::vector< fourdst::atomic::Species > > m_reactantsVec
 
std::optional< std::vector< fourdst::atomic::Species > > m_productsVec
 
std::string m_sourceLabel
 Source label for the rate data (e.g., "wc12w", "st08").
 
RateCoefficientSet m_rateCoefficients
 The seven rate coefficients.
 
bool m_reverse = false
 Flag indicating if this is a reverse reaction rate.
 
+

Detailed Description

+

Represents a "logical" reaction that aggregates rates from multiple sources.

+

A LogicalReaclibReaction shares the same reactants and products but combines rates from different evaluations (e.g., "wc12" and "st08" for the same physical reaction). The total rate is the sum of the individual rates. It inherits from Reaction, using the properties of the first provided reaction as its base properties (reactants, products, Q-value, etc.).

+

Constructor & Destructor Documentation

+ +

◆ LogicalReaclibReaction() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::reaction::LogicalReaclibReaction::LogicalReaclibReaction (const std::vector< std::unique_ptr< ReaclibReaction > > & reactions)
+ 		+explicit
+
+ +

Constructs a LogicalReaction from a vector of Reaction objects. Implicitly assumes that the logical reaction is for a forward (i.e. not reverse) reaction.

+
Parameters
+ + +
reactionsA vector of reactions that represent the same logical process.
+
+
+
Exceptions
+ + +
std::runtime_errorif the provided reactions have inconsistent Q-values.
+
+
+ +
+
+ +

◆ LogicalReaclibReaction() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
gridfire::reaction::LogicalReaclibReaction::LogicalReaclibReaction (const std::vector< std::unique_ptr< ReaclibReaction > > & reactions,
bool reverse 
)
+ 		+explicit
+
+

@breif Constructs a LogicalReaction from a vector of Reaction objects and allows the user to specify if the logical set is for a reverse reaction explicitly

Parameters
+ + + +
reactionsA vector of reactions that represent the same logical process
reverseA flag to control if this logical reaction is reverse or not
+
+
+
Returns
std::runtime_error if the provided reactions have inconsistent Q-values.
+ +
+
+

Member Function Documentation

+ +

◆ add_reaction()

+ +
+
+ + + + + + + + +
void gridfire::reaction::LogicalReaclibReaction::add_reaction (const ReaclibReaction & reaction)
+
+ +

Adds another Reaction source to this logical reaction.

+
Parameters
+ + +
reactionThe reaction to add.
+
+
+
Exceptions
+ + +
std::runtime_errorif the reaction has a different peName, a duplicate source label, or an inconsistent Q-value.
+
+
+ +
+
+ +

◆ begin() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
auto gridfire::reaction::LogicalReaclibReaction::begin ()
+ 		+inline
+
+ +
+
+ +

◆ begin() [2/2]

+ +
+
+ + + + + +
+ + + + + + + +
auto gridfire::reaction::LogicalReaclibReaction::begin () const
+ 		+inline
+
+ +
+
+ +

◆ calculate_log_rate_partial_deriv_wrt_T9()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::reaction::LogicalReaclibReaction::calculate_log_rate_partial_deriv_wrt_T9 (double T9,
double rho,
double Ye,
double mue,
const fourdst::composition::Composition & comp 
) const
+ 		+overridevirtual
+
+ +

Logarithmic partial derivative of the rate with respect to temperature.

+

Implementations return d(ln rate)/d(ln T9) or an equivalent measure (as documented by the concrete class), evaluated at the provided state.

+
Parameters
+ + + + + + +
T9Temperature in GK (10^9 K).
rhoMass density (g cm^-3).
YeElectron fraction.
mueElectron chemical potential.
compComposition object providing composition in a convenient form.
+
+
+
Returns
The logarithmic temperature derivative of the rate.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ calculate_rate() [1/3]

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + + +
T gridfire::reaction::LogicalReaclibReaction::calculate_rate (const T T9) const
+ 		+inlineprivate
+
+ +

Template implementation for calculating the total reaction rate.

+
Template Parameters
+ + +
TThe numeric type (double or CppAD::AD<double>).
+
+
+
Parameters
+ + +
T9The temperature in units of 10^9 K.
+
+
+
Returns
The total calculated reaction rate.
+

This method iterates through all stored RateCoefficientSets, calculates the rate for each, and returns their sum.

+ +
+
+ +

◆ calculate_rate() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CppAD::AD< double > gridfire::reaction::LogicalReaclibReaction::calculate_rate (CppAD::AD< double > T9,
CppAD::AD< double > rho,
CppAD::AD< double > Ye,
CppAD::AD< double > mue,
const std::vector< CppAD::AD< double > > & Y,
const std::unordered_map< size_t, fourdst::atomic::Species > & index_to_species_map 
) const
+ 		+overridevirtual
+
+ +

Calculates the total reaction rate using CppAD types.

+
Parameters
+ + + + + + + +
T9The temperature in units of 10^9 K, as a CppAD::AD<double>.
rho
Ye
mue
Y
index_to_species_map
+
+
+
Returns
The total calculated reaction rate, as a CppAD::AD<double>.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ calculate_rate() [3/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::reaction::LogicalReaclibReaction::calculate_rate (double T9,
double rho,
double Ye,
double mue,
const std::vector< double > & Y,
const std::unordered_map< size_t, fourdst::atomic::Species > & index_to_species_map 
) const
+ 		+overridevirtual
+
+ +

Calculates the total reaction rate by summing all source rates.

+
Parameters
+ + + + + + + +
T9The temperature in units of 10^9 K.
rho
Ye
mue
Y
index_to_species_map
+
+
+
Returns
The total calculated reaction rate.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< Reaction > gridfire::reaction::LogicalReaclibReaction::clone () const
+ 		+overridevirtual
+
+ +

Polymorphic deep copy.

+
Returns
A std::unique_ptr owning a new Reaction equal to this one.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ end() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
auto gridfire::reaction::LogicalReaclibReaction::end ()
+ 		+inline
+
+ +
+
+ +

◆ end() [2/2]

+ +
+
+ + + + + +
+ + + + + + + +
auto gridfire::reaction::LogicalReaclibReaction::end () const
+ 		+inline
+
+ +
+
+ +

◆ getRateCoefficients()

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

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ size()

+ +
+
+ + + + + +
+ + + + + + + +
size_t gridfire::reaction::LogicalReaclibReaction::size () const
+ 		+inline
+
+ +

Gets the number of source rates contributing to this logical reaction.

+
Returns
The number of aggregated rates.
+ +
+
+ +

◆ sources()

+ +
+
+ + + + + +
+ + + + + + + +
std::vector< std::string > gridfire::reaction::LogicalReaclibReaction::sources () const
+ 		+inline
+
+ +

Gets the list of source labels for the aggregated rates.

+
Returns
A vector of source label strings.
+ +
+
+ +

◆ type()

+ +
+
+ + + + + +
+ + + + + + + +
ReactionType gridfire::reaction::LogicalReaclibReaction::type () const
+ 		+inlineoverridevirtual
+
+ +

Category of this reaction (e.g., REACLIB, WEAK, LOGICAL_REACLIB).

+
Returns
Enumerated reaction type for runtime dispatch and filtering.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+

Friends And Related Symbol Documentation

+ +

◆ operator<<

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::ostream & operator<< (std::ostream & os,
const LogicalReaclibReaction & r 
)
+ 		+friend
+
+ +
+
+

Member Data Documentation

+ +

◆ m_rates

+ +
+
+ + + + + +
+ + + + +
std::vector<RateCoefficientSet> gridfire::reaction::LogicalReaclibReaction::m_rates
+ 		+private
+
+ +

List of rate coefficient sets from each source.

+ +
+
+ +

◆ m_sources

+ +
+
+ + + + + +
+ + + + +
std::vector<std::string> gridfire::reaction::LogicalReaclibReaction::m_sources
+ 		+private
+
+ +

List of source labels.

+ +
+
+ +

◆ m_weak

+ +
+
+ + + + + +
+ + + + +
bool gridfire::reaction::LogicalReaclibReaction::m_weak = false
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction.js b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction.js new file mode 100644 index 00000000..5578cb14 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction.js @@ -0,0 +1,23 @@ +var classgridfire_1_1reaction_1_1LogicalReaclibReaction = +[ + [ "LogicalReaclibReaction", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#a2b38a9e8a4bdfc964ba76be3f718eab6", null ], + [ "LogicalReaclibReaction", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#a3d96384887b5b7f0022d1bc43f6d45b5", null ], + [ "add_reaction", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#a69508797ca0793f6d3f58de4e0b97667", null ], + [ "begin", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#a1353d7d2208497b38799bf69f574c275", null ], + [ "begin", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#a211b1332dc12a1fee942523dbc688272", null ], + [ "calculate_log_rate_partial_deriv_wrt_T9", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#a9b1363314159eaf9c56aaa233f5eebd6", null ], + [ "calculate_rate", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#a19462806927500f72b7d3f578b3040de", null ], + [ "calculate_rate", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#ab5bdbe13239f1180f32fb0a14a60d0a9", null ], + [ "calculate_rate", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#ac21a726884930e6a00792e7c3eb43f42", null ], + [ "clone", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#ad113b9cb64c449f9449c4cce4fa64076", null ], + [ "end", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#aefaf6c4c32ae54a2882da0e031632a74", null ], + [ "end", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#ae0b38d499bf0c9ca58461ea2862a7d5a", null ], + [ "getRateCoefficients", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#adfef828853172ca573395160e2ce9c49", null ], + [ "size", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#a4c58951d9f7ab252717c226b0da80a9d", null ], + [ "sources", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#ad4979f437dc787a5475c3a029804ed99", null ], + [ "type", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#acbfa2d4e23dff6641be21cc1e754be15", null ], + [ "operator<<", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#a495ca800cc1dd224ce2a821a825afafd", null ], + [ "m_rates", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#afe1b95bf9d81f7521b9f19bbd1305d01", null ], + [ "m_sources", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#a8c6f12a01c6d1fdeba1f0cc73128731e", null ], + [ "m_weak", "classgridfire_1_1reaction_1_1LogicalReaclibReaction.html#a853458f525bf3270b5ad826c6fd9e1ca", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__coll__graph.map b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__coll__graph.map new file mode 100644 index 00000000..b42cc64f --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__coll__graph.map @@ -0,0 +1,23 @@ + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__coll__graph.md5 b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__coll__graph.md5 new file mode 100644 index 00000000..a3f76a58 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__coll__graph.md5 @@ -0,0 +1 @@ +f250f6677abc47cda8eb651cfa461ba3 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__coll__graph.svg b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__coll__graph.svg new file mode 100644 index 00000000..7f50a670 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__coll__graph.svg @@ -0,0 +1,303 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::reaction::LogicalReaclibReaction + + +Node1 + + +gridfire::reaction +::LogicalReaclibReaction + + + + + +Node2 + + +gridfire::reaction +::ReaclibReaction + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::reaction +::Reaction + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::string + + + + + +Node4->Node2 + + + + + + m_id +m_peName +m_sourceLabel + + + +Node9 + + +std::vector< std::string > + + + + + +Node4->Node9 + + + + + + elements + + + +Node5 + + +std::basic_string< + Char > + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node6->Node2 + + + + + + m_products +m_reactants + + + +Node7 + + +Species + + + + + +Node7->Node6 + + + + + + keys + + + +Node8 + + +gridfire::reaction +::RateCoefficientSet + + + + + +Node8->Node2 + + + + + + m_rateCoefficients + + + +Node10 + + +std::vector< gridfire +::reaction::RateCoefficient +Set > + + + + + +Node8->Node10 + + + + + + elements + + + +Node9->Node1 + + + + + + m_sources + + + +Node10->Node1 + + + + + + m_rates + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__coll__graph_org.svg b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__coll__graph_org.svg new file mode 100644 index 00000000..aba4cd5c --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__coll__graph_org.svg @@ -0,0 +1,221 @@ + + + + + + +gridfire::reaction::LogicalReaclibReaction + + +Node1 + + +gridfire::reaction +::LogicalReaclibReaction + + + + + +Node2 + + +gridfire::reaction +::ReaclibReaction + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::reaction +::Reaction + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::string + + + + + +Node4->Node2 + + + + + + m_id +m_peName +m_sourceLabel + + + +Node9 + + +std::vector< std::string > + + + + + +Node4->Node9 + + + + + + elements + + + +Node5 + + +std::basic_string< + Char > + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node6->Node2 + + + + + + m_products +m_reactants + + + +Node7 + + +Species + + + + + +Node7->Node6 + + + + + + keys + + + +Node8 + + +gridfire::reaction +::RateCoefficientSet + + + + + +Node8->Node2 + + + + + + m_rateCoefficients + + + +Node10 + + +std::vector< gridfire +::reaction::RateCoefficient +Set > + + + + + +Node8->Node10 + + + + + + elements + + + +Node9->Node1 + + + + + + m_sources + + + +Node10->Node1 + + + + + + m_rates + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__inherit__graph.map b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__inherit__graph.map new file mode 100644 index 00000000..18ff5ab2 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__inherit__graph.md5 b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__inherit__graph.md5 new file mode 100644 index 00000000..06c55f54 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__inherit__graph.md5 @@ -0,0 +1 @@ +39b16b63c1f7fc739a68a403f8e7fbcf \ No newline at end of file diff --git a/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__inherit__graph.svg b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__inherit__graph.svg new file mode 100644 index 00000000..4ceb7dec --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__inherit__graph.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + +gridfire::reaction::LogicalReaclibReaction + + +Node1 + + +gridfire::reaction +::LogicalReaclibReaction + + + + + +Node2 + + +gridfire::reaction +::ReaclibReaction + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::reaction +::Reaction + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__inherit__graph_org.svg b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__inherit__graph_org.svg new file mode 100644 index 00000000..b091e960 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1LogicalReaclibReaction__inherit__graph_org.svg @@ -0,0 +1,60 @@ + + + + + + +gridfire::reaction::LogicalReaclibReaction + + +Node1 + + +gridfire::reaction +::LogicalReaclibReaction + + + + + +Node2 + + +gridfire::reaction +::ReaclibReaction + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::reaction +::Reaction + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction-members.html b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction-members.html new file mode 100644 index 00000000..76eaa24a --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction-members.html @@ -0,0 +1,159 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::reaction::ReaclibReaction Member List
+
+
+ +

This is the complete list of members for gridfire::reaction::ReaclibReaction, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
all_species() const overridegridfire::reaction::ReaclibReactionvirtual
calculate_energy_generation_rate(const double T9, const double rho, const double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) constgridfire::reaction::Reactioninlinevirtual
calculate_energy_generation_rate(const CppAD::AD< double > &T9, const CppAD::AD< double > &rho, const CppAD::AD< double > &Ye, const CppAD::AD< double > &mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) constgridfire::reaction::Reactioninlinevirtual
calculate_log_rate_partial_deriv_wrt_T9(double T9, double rho, double Ye, double mue, const fourdst::composition::Composition &comp) const overridegridfire::reaction::ReaclibReactionvirtual
calculate_rate(double T9, double rho, double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const overridegridfire::reaction::ReaclibReactionvirtual
calculate_rate(CppAD::AD< double > T9, CppAD::AD< double > rho, CppAD::AD< double > Ye, CppAD::AD< double > mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const overridegridfire::reaction::ReaclibReactionvirtual
calculate_rate(const T T9) constgridfire::reaction::ReaclibReactioninlineprivate
chapter() constgridfire::reaction::ReaclibReactioninline
clone() const overridegridfire::reaction::ReaclibReactionvirtual
contains(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactionvirtual
contains_product(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactionvirtual
contains_reactant(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactionvirtual
countProductOccurrences(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactioninlinevirtual
countReactantOccurrences(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactioninlinevirtual
excess_energy() constgridfire::reaction::ReaclibReaction
getRateCoefficients() const overridegridfire::reaction::ReaclibReactionvirtual
hash(uint64_t seed) const overridegridfire::reaction::ReaclibReactionvirtual
id() const overridegridfire::reaction::ReaclibReactioninlinevirtual
is_reverse() const overridegridfire::reaction::ReaclibReactioninlinevirtual
m_chaptergridfire::reaction::ReaclibReactionprotected
m_idgridfire::reaction::ReaclibReactionprotected
m_loggergridfire::reaction::ReaclibReactionprotected
m_peNamegridfire::reaction::ReaclibReactionprotected
m_productsgridfire::reaction::ReaclibReactionprotected
m_productsVecgridfire::reaction::ReaclibReactionmutableprotected
m_qValuegridfire::reaction::ReaclibReactionprotected
m_rateCoefficientsgridfire::reaction::ReaclibReactionprotected
m_reactantsgridfire::reaction::ReaclibReactionprotected
m_reactantsVecgridfire::reaction::ReaclibReactionmutableprotected
m_reversegridfire::reaction::ReaclibReactionprotected
m_sourceLabelgridfire::reaction::ReaclibReactionprotected
num_species() const overridegridfire::reaction::ReaclibReactionvirtual
operator!=(const ReaclibReaction &other) constgridfire::reaction::ReaclibReactioninline
operator<<gridfire::reaction::ReaclibReactionfriend
operator==(const ReaclibReaction &other) constgridfire::reaction::ReaclibReactioninline
peName() constgridfire::reaction::ReaclibReactioninlinevirtual
product_species() const overridegridfire::reaction::ReaclibReactionvirtual
products() const overridegridfire::reaction::ReaclibReactioninlinevirtual
qValue() const overridegridfire::reaction::ReaclibReactioninlinevirtual
rateCoefficients() constgridfire::reaction::ReaclibReactioninline
ReaclibReaction(std::string_view id, std::string_view peName, int chapter, const std::vector< fourdst::atomic::Species > &reactants, const std::vector< fourdst::atomic::Species > &products, double qValue, std::string_view label, const RateCoefficientSet &sets, bool reverse=false)gridfire::reaction::ReaclibReaction
reactant_species() const overridegridfire::reaction::ReaclibReactionvirtual
reactants() const overridegridfire::reaction::ReaclibReactioninlinevirtual
sourceLabel() constgridfire::reaction::ReaclibReactioninline
stoichiometry(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactionvirtual
stoichiometry() const overridegridfire::reaction::ReaclibReactionvirtual
type() const overridegridfire::reaction::ReaclibReactioninlinevirtual
~ReaclibReaction() override=defaultgridfire::reaction::ReaclibReaction
~Reaction()=defaultgridfire::reaction::Reactionvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction.html b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction.html new file mode 100644 index 00000000..4bb41d2f --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction.html @@ -0,0 +1,1818 @@ + + + + + + + +GridFire: gridfire::reaction::ReaclibReaction Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Protected Attributes | +Private Member Functions | +Friends | +List of all members
+
gridfire::reaction::ReaclibReaction Class Reference
+
+
+ +

#include <reaction.h>

+
+Inheritance diagram for gridfire::reaction::ReaclibReaction:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::reaction::ReaclibReaction:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 ~ReaclibReaction () override=default
 
 ReaclibReaction (std::string_view id, std::string_view peName, int chapter, const std::vector< fourdst::atomic::Species > &reactants, const std::vector< fourdst::atomic::Species > &products, double qValue, std::string_view label, const RateCoefficientSet &sets, bool reverse=false)
 Constructs a Reaction object.
 
double calculate_rate (double T9, double rho, double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const override
 Calculates the reaction rate for a given temperature.
 
CppAD::AD< double > calculate_rate (CppAD::AD< double > T9, CppAD::AD< double > rho, CppAD::AD< double > Ye, CppAD::AD< double > mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const override
 Calculates the reaction rate for a given temperature using CppAD types.
 
double calculate_log_rate_partial_deriv_wrt_T9 (double T9, double rho, double Ye, double mue, const fourdst::composition::Composition &comp) const override
 Logarithmic partial derivative of the rate with respect to temperature.
 
virtual std::string_view peName () const
 Gets the reaction name in (projectile, ejectile) notation.
 
int chapter () const
 Gets the REACLIB chapter number.
 
std::string_view sourceLabel () const
 Gets the source label for the rate data.
 
ReactionType type () const override
 Category of this reaction (e.g., REACLIB, WEAK, LOGICAL_REACLIB).
 
const RateCoefficientSet & rateCoefficients () const
 Gets the set of rate coefficients.
 
std::optional< std::vector< RateCoefficientSet > > getRateCoefficients () const override
 
bool contains (const fourdst::atomic::Species &species) const override
 Checks if the reaction involves a given species as a reactant or product.
 
bool contains_reactant (const fourdst::atomic::Species &species) const override
 Checks if the reaction involves a given species as a reactant.
 
bool contains_product (const fourdst::atomic::Species &species) const override
 Checks if the reaction involves a given species as a product.
 
std::unordered_set< fourdst::atomic::Species > all_species () const override
 Gets a set of all unique species involved in the reaction.
 
std::unordered_set< fourdst::atomic::Species > reactant_species () const override
 Gets a set of all unique reactant species.
 
std::unordered_set< fourdst::atomic::Species > product_species () const override
 Gets a set of all unique product species.
 
size_t num_species () const override
 Gets the number of unique species involved in the reaction.
 
int stoichiometry (const fourdst::atomic::Species &species) const override
 Calculates the stoichiometric coefficient for a given species.
 
std::unordered_map< fourdst::atomic::Species, int > stoichiometry () const override
 Gets a map of all species to their stoichiometric coefficients.
 
std::string_view id () const override
 Gets the unique identifier of the reaction.
 
double qValue () const override
 Gets the Q-value of the reaction.
 
const std::vector< fourdst::atomic::Species > & reactants () const override
 Gets the vector of reactant species.
 
const std::vector< fourdst::atomic::Species > & products () const override
 Gets the vector of product species.
 
bool is_reverse () const override
 Checks if this is a reverse reaction rate.
 
double excess_energy () const
 Calculates the excess energy from the mass difference of reactants and products.
 
bool operator== (const ReaclibReaction &other) const
 Compares this reaction with another for equality based on their IDs.
 
bool operator!= (const ReaclibReaction &other) const
 Compares this reaction with another for inequality.
 
uint64_t hash (uint64_t seed) const override
 Computes a hash for the reaction based on its ID.
 
std::unique_ptr< Reaction > clone () const override
 Polymorphic deep copy.
 
size_t countReactantOccurrences (const fourdst::atomic::Species &species) const override
 
size_t countProductOccurrences (const fourdst::atomic::Species &species) const override
 
- Public Member Functions inherited from gridfire::reaction::Reaction
virtual ~Reaction ()=default
 Virtual destructor for correct polymorphic cleanup.
 
virtual double calculate_energy_generation_rate (const double T9, const double rho, const double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const
 Convenience: energy generation rate from this reaction (double version).
 
virtual CppAD::AD< double > calculate_energy_generation_rate (const CppAD::AD< double > &T9, const CppAD::AD< double > &rho, const CppAD::AD< double > &Ye, const CppAD::AD< double > &mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const
 Convenience: AD-enabled energy generation rate (AD version).
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

quill::Logger * m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
 
std::string m_id
 Unique identifier for the reaction (e.g., "h1+h1=>h2+e+nu").
 
std::string m_peName
 Name of the reaction in (projectile, ejectile) notation (e.g. "p(p,g)d").
 
int m_chapter
 Chapter number from the REACLIB database, defining the reaction structure.
 
double m_qValue = 0.0
 Q-value of the reaction in MeV.
 
std::unordered_map< fourdst::atomic::Species, size_t > m_reactants
 Reactants of the reaction.
 
std::unordered_map< fourdst::atomic::Species, size_t > m_products
 Products of the reaction.
 
std::optional< std::vector< fourdst::atomic::Species > > m_reactantsVec
 
std::optional< std::vector< fourdst::atomic::Species > > m_productsVec
 
std::string m_sourceLabel
 Source label for the rate data (e.g., "wc12w", "st08").
 
RateCoefficientSet m_rateCoefficients
 The seven rate coefficients.
 
bool m_reverse = false
 Flag indicating if this is a reverse reaction rate.
 
+ + + + + +

+Private Member Functions

template<typename T >
T calculate_rate (const T T9) const
 Template implementation for calculating the reaction rate.
 
+ + + +

+Friends

std::ostream & operator<< (std::ostream &os, const ReaclibReaction &r)
 
+

Constructor & Destructor Documentation

+ +

◆ ~ReaclibReaction()

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::reaction::ReaclibReaction::~ReaclibReaction ()
+ 		+overridedefault
+
+ +
+
+ +

◆ ReaclibReaction()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
gridfire::reaction::ReaclibReaction::ReaclibReaction (std::string_view id,
std::string_view peName,
int chapter,
const std::vector< fourdst::atomic::Species > & reactants,
const std::vector< fourdst::atomic::Species > & products,
double qValue,
std::string_view label,
const RateCoefficientSet & sets,
bool reverse = false 
)
+
+ +

Constructs a Reaction object.

+
Parameters
+ + + + + + + + + + +
idA unique identifier for the reaction.
peNameThe name in (projectile, ejectile) notation (e.g., "p(p,g)d").
chapterThe REACLIB chapter number, defining reaction structure.
reactantsA vector of reactant species.
productsA vector of product species.
qValueThe Q-value of the reaction in MeV.
labelThe sources label for the rate data (e.g., "wc12", "st08").
setsThe set of rate coefficients.
reverseTrue if this is a reverse reaction rate.
+
+
+ +
+
+

Member Function Documentation

+ +

◆ all_species()

+ +
+
+ + + + + +
+ + + + + + + +
std::unordered_set< Species > gridfire::reaction::ReaclibReaction::all_species () const
+ 		+overridevirtual
+
+ +

Gets a set of all unique species involved in the reaction.

+
Returns
An unordered_set of all reactant and product species.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ calculate_log_rate_partial_deriv_wrt_T9()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::reaction::ReaclibReaction::calculate_log_rate_partial_deriv_wrt_T9 (double T9,
double rho,
double Ye,
double mue,
const fourdst::composition::Composition & comp 
) const
+ 		+overridevirtual
+
+ +

Logarithmic partial derivative of the rate with respect to temperature.

+

Implementations return d(ln rate)/d(ln T9) or an equivalent measure (as documented by the concrete class), evaluated at the provided state.

+
Parameters
+ + + + + + +
T9Temperature in GK (10^9 K).
rhoMass density (g cm^-3).
YeElectron fraction.
mueElectron chemical potential.
compComposition object providing composition in a convenient form.
+
+
+
Returns
The logarithmic temperature derivative of the rate.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ calculate_rate() [1/3]

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + + +
T gridfire::reaction::ReaclibReaction::calculate_rate (const T T9) const
+ 		+inlineprivate
+
+ +

Template implementation for calculating the reaction rate.

+
Template Parameters
+ + +
TThe numeric type (double or CppAD::AD<double>).
+
+
+
Parameters
+ + +
T9The temperature in units of 10^9 K.
+
+
+
Returns
The calculated reaction rate.
+

The rate is calculated using the standard REACLIB formula: rate = exp(a0 + a1/T9 + a2/T9^(1/3) + a3*T9^(1/3) + a4*T9 + a5*T9^(5/3) + a6*ln(T9))

+ +
+
+ +

◆ calculate_rate() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CppAD::AD< double > gridfire::reaction::ReaclibReaction::calculate_rate (CppAD::AD< double > T9,
CppAD::AD< double > rho,
CppAD::AD< double > Ye,
CppAD::AD< double > mue,
const std::vector< CppAD::AD< double > > & Y,
const std::unordered_map< size_t, fourdst::atomic::Species > & index_to_species_map 
) const
+ 		+overridevirtual
+
+ +

Calculates the reaction rate for a given temperature using CppAD types.

+
Parameters
+ + + + + + + +
T9The temperature in units of 10^9 K, as a CppAD::AD<double>.
rhoDensity, as a CppAD::AD<double> [Not used in this implementation].
Ye
mue
YMolar abundances of species, as a vector of CppAD::AD<double> [Not used in this implementation].
index_to_species_map
+
+
+
Returns
The calculated reaction rate, as a CppAD::AD<double>.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ calculate_rate() [3/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
double gridfire::reaction::ReaclibReaction::calculate_rate (double T9,
double rho,
double Ye,
double mue,
const std::vector< double > & Y,
const std::unordered_map< size_t, fourdst::atomic::Species > & index_to_species_map 
) const
+ 		+overridevirtual
+
+ +

Calculates the reaction rate for a given temperature.

+
Parameters
+ + + + + + + +
T9The temperature in units of 10^9 K.
rhoDensity [Not used in this implementation].
Ye
mue
Y
index_to_species_map
+
+
+
Returns
The calculated reaction rate.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ chapter()

+ +
+
+ + + + + +
+ + + + + + + +
int gridfire::reaction::ReaclibReaction::chapter () const
+ 		+inline
+
+ +

Gets the REACLIB chapter number.

+
Returns
The chapter number.
+ +
+
+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< Reaction > gridfire::reaction::ReaclibReaction::clone () const
+ 		+overridevirtual
+
+ +

Polymorphic deep copy.

+
Returns
A std::unique_ptr owning a new Reaction equal to this one.
+ +

Implements gridfire::reaction::Reaction.

+ +

Reimplemented in gridfire::reaction::WeakReaclibReaction.

+ +
+
+ +

◆ contains()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::reaction::ReaclibReaction::contains (const fourdst::atomic::Species & species) const
+ 		+overridevirtual
+
+ +

Checks if the reaction involves a given species as a reactant or product.

+
Parameters
+ + +
speciesThe species to check for.
+
+
+
Returns
True if the species is involved, false otherwise.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ contains_product()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::reaction::ReaclibReaction::contains_product (const fourdst::atomic::Species & species) const
+ 		+overridevirtual
+
+ +

Checks if the reaction involves a given species as a product.

+
Parameters
+ + +
speciesThe species to check for.
+
+
+
Returns
True if the species is a product, false otherwise.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ contains_reactant()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::reaction::ReaclibReaction::contains_reactant (const fourdst::atomic::Species & species) const
+ 		+overridevirtual
+
+ +

Checks if the reaction involves a given species as a reactant.

+
Parameters
+ + +
speciesThe species to check for.
+
+
+
Returns
True if the species is a reactant, false otherwise.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ countProductOccurrences()

+ +
+
+ + + + + +
+ + + + + + + + +
size_t gridfire::reaction::ReaclibReaction::countProductOccurrences (const fourdst::atomic::Species & species) const
+ 		+inlineoverridevirtual
+
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ countReactantOccurrences()

+ +
+
+ + + + + +
+ + + + + + + + +
size_t gridfire::reaction::ReaclibReaction::countReactantOccurrences (const fourdst::atomic::Species & species) const
+ 		+inlineoverridevirtual
+
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ excess_energy()

+ +
+
+ + + + + + + +
double gridfire::reaction::ReaclibReaction::excess_energy () const
+
+ +

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

+
Returns
The excess energy in MeV.
+ +
+
+ +

◆ getRateCoefficients()

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

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ hash()

+ +
+
+ + + + + +
+ + + + + + + + +
uint64_t gridfire::reaction::ReaclibReaction::hash (uint64_t seed) const
+ 		+overridevirtual
+
+ +

Computes a hash for the reaction based on its ID.

+
Parameters
+ + +
seedThe seed for the hash function.
+
+
+
Returns
A 64-bit hash value.
+

Uses the XXHash64 algorithm on the reaction's ID string.

+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ id()

+ +
+
+ + + + + +
+ + + + + + + +
std::string_view gridfire::reaction::ReaclibReaction::id () const
+ 		+inlineoverridevirtual
+
+ +

Gets the unique identifier of the reaction.

+
Returns
The reaction ID.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ is_reverse()

+ +
+
+ + + + + +
+ + + + + + + +
bool gridfire::reaction::ReaclibReaction::is_reverse () const
+ 		+inlineoverridevirtual
+
+ +

Checks if this is a reverse reaction rate.

+
Returns
True if it is a reverse rate, false otherwise.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ num_species()

+ +
+
+ + + + + +
+ + + + + + + +
size_t gridfire::reaction::ReaclibReaction::num_species () const
+ 		+overridevirtual
+
+ +

Gets the number of unique species involved in the reaction.

+
Returns
The count of unique species.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ operator!=()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::reaction::ReaclibReaction::operator!= (const ReaclibReaction & other) const
+ 		+inline
+
+ +

Compares this reaction with another for inequality.

+
Parameters
+ + +
otherThe other Reaction to compare with.
+
+
+
Returns
True if the reactions are not equal.
+ +
+
+ +

◆ operator==()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::reaction::ReaclibReaction::operator== (const ReaclibReaction & other) const
+ 		+inline
+
+ +

Compares this reaction with another for equality based on their IDs.

+
Parameters
+ + +
otherThe other Reaction to compare with.
+
+
+
Returns
True if the reaction IDs are the same.
+ +
+
+ +

◆ peName()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::string_view gridfire::reaction::ReaclibReaction::peName () const
+ 		+inlinevirtual
+
+ +

Gets the reaction name in (projectile, ejectile) notation.

+
Returns
The reaction name (e.g., "p(p,g)d").
+ +
+
+ +

◆ product_species()

+ +
+
+ + + + + +
+ + + + + + + +
std::unordered_set< Species > gridfire::reaction::ReaclibReaction::product_species () const
+ 		+overridevirtual
+
+ +

Gets a set of all unique product species.

+
Returns
An unordered_set of product species.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ products()

+ +
+
+ + + + + +
+ + + + + + + +
const std::vector< fourdst::atomic::Species > & gridfire::reaction::ReaclibReaction::products () const
+ 		+inlineoverridevirtual
+
+ +

Gets the vector of product species.

+
Returns
A const reference to the vector of products.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ qValue()

+ +
+
+ + + + + +
+ + + + + + + +
double gridfire::reaction::ReaclibReaction::qValue () const
+ 		+inlineoverridevirtual
+
+ +

Gets the Q-value of the reaction.

+
Returns
The Q-value in whatever units the reaction was defined in (usually MeV).
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ rateCoefficients()

+ +
+
+ + + + + +
+ + + + + + + +
const RateCoefficientSet & gridfire::reaction::ReaclibReaction::rateCoefficients () const
+ 		+inline
+
+ +

Gets the set of rate coefficients.

+
Returns
A const reference to the RateCoefficientSet.
+ +
+
+ +

◆ reactant_species()

+ +
+
+ + + + + +
+ + + + + + + +
std::unordered_set< Species > gridfire::reaction::ReaclibReaction::reactant_species () const
+ 		+overridevirtual
+
+ +

Gets a set of all unique reactant species.

+
Returns
An unordered_set of reactant species.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ reactants()

+ +
+
+ + + + + +
+ + + + + + + +
const std::vector< fourdst::atomic::Species > & gridfire::reaction::ReaclibReaction::reactants () const
+ 		+inlineoverridevirtual
+
+ +

Gets the vector of reactant species.

+
Returns
A const reference to the vector of reactants.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ sourceLabel()

+ +
+
+ + + + + +
+ + + + + + + +
std::string_view gridfire::reaction::ReaclibReaction::sourceLabel () const
+ 		+inline
+
+ +

Gets the source label for the rate data.

+
Returns
The source label (e.g., "wc12w", "st08").
+ +
+
+ +

◆ stoichiometry() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
std::unordered_map< Species, int > gridfire::reaction::ReaclibReaction::stoichiometry () const
+ 		+overridevirtual
+
+ +

Gets a map of all species to their stoichiometric coefficients.

+
Returns
An unordered_map from species to their integer coefficients.
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ stoichiometry() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
int gridfire::reaction::ReaclibReaction::stoichiometry (const fourdst::atomic::Species & species) const
+ 		+overridevirtual
+
+ +

Calculates the stoichiometric coefficient for a given species.

+
Parameters
+ + +
speciesThe species for which to find the coefficient.
+
+
+
Returns
The stoichiometric coefficient (negative for reactants, positive for products).
+ +

Implements gridfire::reaction::Reaction.

+ +
+
+ +

◆ type()

+ +
+
+ + + + + +
+ + + + + + + +
ReactionType gridfire::reaction::ReaclibReaction::type () const
+ 		+inlineoverridevirtual
+
+ +

Category of this reaction (e.g., REACLIB, WEAK, LOGICAL_REACLIB).

+
Returns
Enumerated reaction type for runtime dispatch and filtering.
+ +

Implements gridfire::reaction::Reaction.

+ +

Reimplemented in gridfire::reaction::WeakReaclibReaction.

+ +
+
+

Friends And Related Symbol Documentation

+ +

◆ operator<<

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::ostream & operator<< (std::ostream & os,
const ReaclibReaction & r 
)
+ 		+friend
+
+ +
+
+

Member Data Documentation

+ +

◆ m_chapter

+ +
+
+ + + + + +
+ + + + +
int gridfire::reaction::ReaclibReaction::m_chapter
+ 		+protected
+
+ +

Chapter number from the REACLIB database, defining the reaction structure.

+ +
+
+ +

◆ m_id

+ +
+
+ + + + + +
+ + + + +
std::string gridfire::reaction::ReaclibReaction::m_id
+ 		+protected
+
+ +

Unique identifier for the reaction (e.g., "h1+h1=>h2+e+nu").

+ +
+
+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::reaction::ReaclibReaction::m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
+ 		+protected
+
+ +
+
+ +

◆ m_peName

+ +
+
+ + + + + +
+ + + + +
std::string gridfire::reaction::ReaclibReaction::m_peName
+ 		+protected
+
+ +

Name of the reaction in (projectile, ejectile) notation (e.g. "p(p,g)d").

+ +
+
+ +

◆ m_products

+ +
+
+ + + + + +
+ + + + +
std::unordered_map<fourdst::atomic::Species, size_t> gridfire::reaction::ReaclibReaction::m_products
+ 		+protected
+
+ +

Products of the reaction.

+ +
+
+ +

◆ m_productsVec

+ +
+
+ + + + + +
+ + + + +
std::optional<std::vector<fourdst::atomic::Species> > gridfire::reaction::ReaclibReaction::m_productsVec
+ 		+mutableprotected
+
+ +
+
+ +

◆ m_qValue

+ +
+
+ + + + + +
+ + + + +
double gridfire::reaction::ReaclibReaction::m_qValue = 0.0
+ 		+protected
+
+ +

Q-value of the reaction in MeV.

+ +
+
+ +

◆ m_rateCoefficients

+ +
+
+ + + + + +
+ + + + +
RateCoefficientSet gridfire::reaction::ReaclibReaction::m_rateCoefficients
+ 		+protected
+
+ +

The seven rate coefficients.

+ +
+
+ +

◆ m_reactants

+ +
+
+ + + + + +
+ + + + +
std::unordered_map<fourdst::atomic::Species, size_t> gridfire::reaction::ReaclibReaction::m_reactants
+ 		+protected
+
+ +

Reactants of the reaction.

+ +
+
+ +

◆ m_reactantsVec

+ +
+
+ + + + + +
+ + + + +
std::optional<std::vector<fourdst::atomic::Species> > gridfire::reaction::ReaclibReaction::m_reactantsVec
+ 		+mutableprotected
+
+ +
+
+ +

◆ m_reverse

+ +
+
+ + + + + +
+ + + + +
bool gridfire::reaction::ReaclibReaction::m_reverse = false
+ 		+protected
+
+ +

Flag indicating if this is a reverse reaction rate.

+ +
+
+ +

◆ m_sourceLabel

+ +
+
+ + + + + +
+ + + + +
std::string gridfire::reaction::ReaclibReaction::m_sourceLabel
+ 		+protected
+
+ +

Source label for the rate data (e.g., "wc12w", "st08").

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction.js b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction.js new file mode 100644 index 00000000..f99a1a5f --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction.js @@ -0,0 +1,49 @@ +var classgridfire_1_1reaction_1_1ReaclibReaction = +[ + [ "~ReaclibReaction", "classgridfire_1_1reaction_1_1ReaclibReaction.html#ae2b9b41a598c5f0dcd050b32985ea44e", null ], + [ "ReaclibReaction", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a264112a230817a6080c770686e5bcc01", null ], + [ "all_species", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a445777acbbee2032d83a256181a90e3c", null ], + [ "calculate_log_rate_partial_deriv_wrt_T9", "classgridfire_1_1reaction_1_1ReaclibReaction.html#ada6ec1ae05b9a92b58e6a4ecdf5a1656", null ], + [ "calculate_rate", "classgridfire_1_1reaction_1_1ReaclibReaction.html#aeb177f9cf69e4f97c4518a27e6480523", null ], + [ "calculate_rate", "classgridfire_1_1reaction_1_1ReaclibReaction.html#afec5ccf7a8fb1ba56c8cc852ce858c5e", null ], + [ "calculate_rate", "classgridfire_1_1reaction_1_1ReaclibReaction.html#acd16b1daf13456b3523362a37b1bf9b0", null ], + [ "chapter", "classgridfire_1_1reaction_1_1ReaclibReaction.html#abe189c43e4d509d9d05dd205861ceddc", null ], + [ "clone", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a54fde02e7010e806136f976ab64b1740", null ], + [ "contains", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a171b690e1abaf23f11a94c39e9f8c944", null ], + [ "contains_product", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a4e4811436d09afaa4a14c51d9af71f88", null ], + [ "contains_reactant", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a65a12e5f6180873866cfaaf130fd1156", null ], + [ "countProductOccurrences", "classgridfire_1_1reaction_1_1ReaclibReaction.html#abe3ab72b2577cbe0f87436b063ce812c", null ], + [ "countReactantOccurrences", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a79928f9c52822202b3156bd145e35ad8", null ], + [ "excess_energy", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a0b30c49925823c87980b4fca17c8282e", null ], + [ "getRateCoefficients", "classgridfire_1_1reaction_1_1ReaclibReaction.html#aefd0436ae72880358214d5b79c9c79eb", null ], + [ "hash", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a661dd461e51c37133f7f9931389fd3cc", null ], + [ "id", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a06312f834439ccf93012dea53cab47ce", null ], + [ "is_reverse", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a181b2c75af1f2701c43594c5bb2bac2d", null ], + [ "num_species", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a9205126955ad38f56e8aca3112bc150a", null ], + [ "operator!=", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a8b6008e0f629329bfc62256f4f081b77", null ], + [ "operator==", "classgridfire_1_1reaction_1_1ReaclibReaction.html#ae7c930525db447e39b4de18fbc1251a8", null ], + [ "peName", "classgridfire_1_1reaction_1_1ReaclibReaction.html#af775f97f4d5e144e33bc6e0ba58a5851", null ], + [ "product_species", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a67c8fa4d5929c7a8cbca9b3d9dd2b704", null ], + [ "products", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a5f563b99bb550d5bafa2a989502de019", null ], + [ "qValue", "classgridfire_1_1reaction_1_1ReaclibReaction.html#ae47931948f12816eb890c0db4fff4d68", null ], + [ "rateCoefficients", "classgridfire_1_1reaction_1_1ReaclibReaction.html#adfed51cf788a7ed4770cbd5945ddab2f", null ], + [ "reactant_species", "classgridfire_1_1reaction_1_1ReaclibReaction.html#ad85ca288289b25d482cbb8e3ff270028", null ], + [ "reactants", "classgridfire_1_1reaction_1_1ReaclibReaction.html#ad095aba46860fec0e68386bf04f7f142", null ], + [ "sourceLabel", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a96d4ab87de02e9b0be3c248e2e955b4b", null ], + [ "stoichiometry", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a0f629cbfe95dc5643b5e3724be0db2f9", null ], + [ "stoichiometry", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a57b2695d152360a6ba08776cc760e3a1", null ], + [ "type", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a3c0fbdd07f9a837bd031c5bdc58e0e8f", null ], + [ "operator<<", "classgridfire_1_1reaction_1_1ReaclibReaction.html#ae24ad1e38daab536aec6ac72c67e8615", null ], + [ "m_chapter", "classgridfire_1_1reaction_1_1ReaclibReaction.html#adbcb383bac0f47c66251ee1b7c5f539d", null ], + [ "m_id", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a8ca86e0f8f95ffb6d87ca295e44f14c5", null ], + [ "m_logger", "classgridfire_1_1reaction_1_1ReaclibReaction.html#abab0ed78925789856ebb119d60c6a53d", null ], + [ "m_peName", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a51f658789f34f96e0e6bd42cef5cbfe4", null ], + [ "m_products", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a4c6ba4d6355f33cbe2e72614fa72363f", null ], + [ "m_productsVec", "classgridfire_1_1reaction_1_1ReaclibReaction.html#ad89d4b413c507e850dba624e1b36b886", null ], + [ "m_qValue", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a498c202a259cbc315997ec68a2cb8a59", null ], + [ "m_rateCoefficients", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a8ea3de0412395b7b617c4b71cbc2ab68", null ], + [ "m_reactants", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a9ecfb28ccb32904a28217fe2eb0c659d", null ], + [ "m_reactantsVec", "classgridfire_1_1reaction_1_1ReaclibReaction.html#aae29f755030c51fc9c8f7db52a022f84", null ], + [ "m_reverse", "classgridfire_1_1reaction_1_1ReaclibReaction.html#af52b42d940f6a09dba5d28898d2b0b1f", null ], + [ "m_sourceLabel", "classgridfire_1_1reaction_1_1ReaclibReaction.html#a7e79437a68947e176b8dd7dcbe27baab", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__coll__graph.map b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__coll__graph.map new file mode 100644 index 00000000..53ff0c44 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__coll__graph.map @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__coll__graph.md5 b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__coll__graph.md5 new file mode 100644 index 00000000..aea7b313 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__coll__graph.md5 @@ -0,0 +1 @@ +4742531bee99a987c895ddcc80bdf34a \ No newline at end of file diff --git a/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__coll__graph.svg b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__coll__graph.svg new file mode 100644 index 00000000..dd62327b --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__coll__graph.svg @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::reaction::ReaclibReaction + + +Node1 + + +gridfire::reaction +::ReaclibReaction + + + + + +Node2 + + +gridfire::reaction +::Reaction + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::string + + + + + +Node3->Node1 + + + + + + m_id +m_peName +m_sourceLabel + + + +Node4 + + +std::basic_string< + Char > + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node5->Node1 + + + + + + m_products +m_reactants + + + +Node6 + + +Species + + + + + +Node6->Node5 + + + + + + keys + + + +Node7 + + +gridfire::reaction +::RateCoefficientSet + + + + + +Node7->Node1 + + + + + + m_rateCoefficients + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__coll__graph_org.svg b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__coll__graph_org.svg new file mode 100644 index 00000000..0f6f5076 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__coll__graph_org.svg @@ -0,0 +1,142 @@ + + + + + + +gridfire::reaction::ReaclibReaction + + +Node1 + + +gridfire::reaction +::ReaclibReaction + + + + + +Node2 + + +gridfire::reaction +::Reaction + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::string + + + + + +Node3->Node1 + + + + + + m_id +m_peName +m_sourceLabel + + + +Node4 + + +std::basic_string< + Char > + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node5->Node1 + + + + + + m_products +m_reactants + + + +Node6 + + +Species + + + + + +Node6->Node5 + + + + + + keys + + + +Node7 + + +gridfire::reaction +::RateCoefficientSet + + + + + +Node7->Node1 + + + + + + m_rateCoefficients + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__inherit__graph.map b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__inherit__graph.map new file mode 100644 index 00000000..66f7cbad --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__inherit__graph.md5 b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__inherit__graph.md5 new file mode 100644 index 00000000..ed7cf10e --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__inherit__graph.md5 @@ -0,0 +1 @@ +d7a1ebd7f638e222340bd6e454c12c3b \ No newline at end of file diff --git a/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__inherit__graph.svg b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__inherit__graph.svg new file mode 100644 index 00000000..94ba1de2 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__inherit__graph.svg @@ -0,0 +1,104 @@ + + + + + + + + + + + +gridfire::reaction::ReaclibReaction + + +Node1 + + +gridfire::reaction +::ReaclibReaction + + + + + +Node3 + + +gridfire::reaction +::LogicalReaclibReaction + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::reaction +::WeakReaclibReaction + + + + + +Node1->Node4 + + + + + + + + +Node2 + + +gridfire::reaction +::Reaction + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__inherit__graph_org.svg b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__inherit__graph_org.svg new file mode 100644 index 00000000..ab2b09fa --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1ReaclibReaction__inherit__graph_org.svg @@ -0,0 +1,79 @@ + + + + + + +gridfire::reaction::ReaclibReaction + + +Node1 + + +gridfire::reaction +::ReaclibReaction + + + + + +Node3 + + +gridfire::reaction +::LogicalReaclibReaction + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::reaction +::WeakReaclibReaction + + + + + +Node1->Node4 + + + + + + + + +Node2 + + +gridfire::reaction +::Reaction + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1Reaction-members.html b/docs/html/classgridfire_1_1reaction_1_1Reaction-members.html new file mode 100644 index 00000000..0927d11e --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1Reaction-members.html @@ -0,0 +1,137 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::reaction::Reaction Member List
+
+
+ +

This is the complete list of members for gridfire::reaction::Reaction, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
all_species() const =0gridfire::reaction::Reactionpure virtual
calculate_energy_generation_rate(const double T9, const double rho, const double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) constgridfire::reaction::Reactioninlinevirtual
calculate_energy_generation_rate(const CppAD::AD< double > &T9, const CppAD::AD< double > &rho, const CppAD::AD< double > &Ye, const CppAD::AD< double > &mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) constgridfire::reaction::Reactioninlinevirtual
calculate_log_rate_partial_deriv_wrt_T9(double T9, double rho, double Ye, double mue, const fourdst::composition::Composition &comp) const =0gridfire::reaction::Reactionpure virtual
calculate_rate(double T9, double rho, double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const =0gridfire::reaction::Reactionpure virtual
calculate_rate(CppAD::AD< double > T9, CppAD::AD< double > rho, CppAD::AD< double > Ye, CppAD::AD< double > mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const =0gridfire::reaction::Reactionpure virtual
clone() const =0gridfire::reaction::Reactionpure virtual
contains(const fourdst::atomic::Species &species) const =0gridfire::reaction::Reactionpure virtual
contains_product(const fourdst::atomic::Species &species) const =0gridfire::reaction::Reactionpure virtual
contains_reactant(const fourdst::atomic::Species &species) const =0gridfire::reaction::Reactionpure virtual
countProductOccurrences(const fourdst::atomic::Species &species) const =0gridfire::reaction::Reactionpure virtual
countReactantOccurrences(const fourdst::atomic::Species &species) const =0gridfire::reaction::Reactionpure virtual
getRateCoefficients() const =0gridfire::reaction::Reactionpure virtual
hash(uint64_t seed) const =0gridfire::reaction::Reactionpure virtual
id() const =0gridfire::reaction::Reactionpure virtual
is_reverse() const =0gridfire::reaction::Reactionpure virtual
num_species() const =0gridfire::reaction::Reactionpure virtual
operator<<gridfire::reaction::Reactionfriend
product_species() const =0gridfire::reaction::Reactionpure virtual
products() const =0gridfire::reaction::Reactionpure virtual
qValue() const =0gridfire::reaction::Reactionpure virtual
reactant_species() const =0gridfire::reaction::Reactionpure virtual
reactants() const =0gridfire::reaction::Reactionpure virtual
stoichiometry() const =0gridfire::reaction::Reactionpure virtual
stoichiometry(const fourdst::atomic::Species &species) const =0gridfire::reaction::Reactionpure virtual
type() const =0gridfire::reaction::Reactionpure virtual
~Reaction()=defaultgridfire::reaction::Reactionvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1Reaction.html b/docs/html/classgridfire_1_1reaction_1_1Reaction.html new file mode 100644 index 00000000..3dfd474e --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1Reaction.html @@ -0,0 +1,1291 @@ + + + + + + + +GridFire: gridfire::reaction::Reaction Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Friends | +List of all members
+
gridfire::reaction::Reaction Class Referenceabstract
+
+
+ +

Represents a single nuclear reaction from a specific data source. + More...

+ +

#include <reaction.h>

+
+Inheritance diagram for gridfire::reaction::Reaction:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

virtual ~Reaction ()=default
 Virtual destructor for correct polymorphic cleanup.
 
virtual double calculate_rate (double T9, double rho, double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const =0
 Compute the temperature- and composition-dependent reaction rate.
 
virtual CppAD::AD< double > calculate_rate (CppAD::AD< double > T9, CppAD::AD< double > rho, CppAD::AD< double > Ye, CppAD::AD< double > mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const =0
 AD-enabled reaction rate for algorithmic differentiation.
 
virtual std::string_view id () const =0
 A stable, unique identifier for this reaction instance.
 
virtual const std::vector< fourdst::atomic::Species > & reactants () const =0
 Ordered list of reactant species.
 
virtual const std::vector< fourdst::atomic::Species > & products () const =0
 Ordered list of product species.
 
virtual bool contains (const fourdst::atomic::Species &species) const =0
 True if the species appears as a reactant or a product.
 
virtual bool contains_reactant (const fourdst::atomic::Species &species) const =0
 True if the species appears among the reactants.
 
virtual bool contains_product (const fourdst::atomic::Species &species) const =0
 True if the species appears among the products.
 
virtual bool is_reverse () const =0
 Whether this object represents a reverse (backward) rate.
 
virtual std::unordered_set< fourdst::atomic::Species > all_species () const =0
 Set of all unique species appearing in the reaction.
 
virtual std::unordered_set< fourdst::atomic::Species > reactant_species () const =0
 Set of unique reactant species.
 
virtual std::unordered_set< fourdst::atomic::Species > product_species () const =0
 Set of unique product species.
 
virtual size_t countReactantOccurrences (const fourdst::atomic::Species &species) const =0
 
virtual size_t countProductOccurrences (const fourdst::atomic::Species &species) const =0
 
virtual size_t num_species () const =0
 Number of unique species involved in the reaction.
 
virtual std::unordered_map< fourdst::atomic::Species, int > stoichiometry () const =0
 Full stoichiometry map for this reaction.
 
virtual int stoichiometry (const fourdst::atomic::Species &species) const =0
 Stoichiometric coefficient for a particular species.
 
virtual uint64_t hash (uint64_t seed) const =0
 Stable content-based hash for this reaction.
 
virtual double qValue () const =0
 Q-value of the reaction (typically MeV), positive if exothermic.
 
virtual double calculate_energy_generation_rate (const double T9, const double rho, const double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const
 Convenience: energy generation rate from this reaction (double version).
 
virtual CppAD::AD< double > calculate_energy_generation_rate (const CppAD::AD< double > &T9, const CppAD::AD< double > &rho, const CppAD::AD< double > &Ye, const CppAD::AD< double > &mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const
 Convenience: AD-enabled energy generation rate (AD version).
 
virtual double calculate_log_rate_partial_deriv_wrt_T9 (double T9, double rho, double Ye, double mue, const fourdst::composition::Composition &comp) const =0
 Logarithmic partial derivative of the rate with respect to temperature.
 
virtual ReactionType type () const =0
 Category of this reaction (e.g., REACLIB, WEAK, LOGICAL_REACLIB).
 
virtual std::unique_ptr< Reaction > clone () const =0
 Polymorphic deep copy.
 
virtual std::optional< std::vector< RateCoefficientSet > > getRateCoefficients () const =0
 
+ + + +

+Friends

std::ostream & operator<< (std::ostream &os, const Reaction &r)
 
+

Detailed Description

+

Represents a single nuclear reaction from a specific data source.

+

This class encapsulates all properties of a single nuclear reaction as defined in formats like REACLIB, including reactants, products, Q-value, and rate coefficients from a particular evaluation (source).

+

Example:

// Assuming species and rate coefficients are defined
+
Reaction p_gamma_d(
+
"H_1_H_1_to_H_2", "p(p,g)d", 1, {H_1, H_1}, {H_2}, 5.493, "st08", rate_coeffs
+
);
+
double rate = p_gamma_d.calculate_rate(0.1); // T9 = 0.1
+
gridfire::reaction::Reaction
Represents a single nuclear reaction from a specific data source.
Definition reaction.h:98
+
gridfire::reaction::Reaction::calculate_rate
virtual double calculate_rate(double T9, double rho, double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const =0
Compute the temperature- and composition-dependent reaction rate.
+

Constructor & Destructor Documentation

+ +

◆ ~Reaction()

+ +
+
+ + + + + +
+ + + + + + + +
virtual gridfire::reaction::Reaction::~Reaction ()
+ 		+virtualdefault
+
+ +

Virtual destructor for correct polymorphic cleanup.

+ +
+
+

Member Function Documentation

+ +

◆ all_species()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::unordered_set< fourdst::atomic::Species > gridfire::reaction::Reaction::all_species () const
+ 		+pure virtual
+
+ +

Set of all unique species appearing in the reaction.

+
Returns
Unordered set of all reactants and products (no duplicates).
+ +

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

+ +
+
+ +

◆ calculate_energy_generation_rate() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual CppAD::AD< double > gridfire::reaction::Reaction::calculate_energy_generation_rate (const CppAD::AD< double > & T9,
const CppAD::AD< double > & rho,
const CppAD::AD< double > & Ye,
const CppAD::AD< double > & mue,
const std::vector< CppAD::AD< double > > & Y,
const std::unordered_map< size_t, fourdst::atomic::Species > & index_to_species_map 
) const
+ 		+inlinevirtual
+
+ +

Convenience: AD-enabled energy generation rate (AD version).

+

Default implementation multiplies the AD rate by the reaction Q-value. Electron quantities (Ye, mue) are ignored in this default, so override if they contribute.

+
Parameters
+ + + + + + + +
T9Temperature in GK as CppAD::AD<double>.
rhoMass density as CppAD::AD<double>.
YeElectron fraction as CppAD::AD<double> (ignored by default).
mueElectron chemical potential as CppAD::AD<double> (ignored by default).
YComposition vector as CppAD::AD<double> values.
index_to_species_mapMapping from state-vector index to Species.
+
+
+
Returns
Energy generation rate as CppAD::AD<double>.
+ +

Reimplemented in gridfire::rates::weak::WeakReaction.

+ +
+
+ +

◆ calculate_energy_generation_rate() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual double gridfire::reaction::Reaction::calculate_energy_generation_rate (const double T9,
const double rho,
const double Ye,
double mue,
const std::vector< double > & Y,
const std::unordered_map< size_t, fourdst::atomic::Species > & index_to_species_map 
) const
+ 		+inlinevirtual
+
+ +

Convenience: energy generation rate from this reaction (double version).

+

Default implementation multiplies the scalar rate by the reaction Q-value. Electron quantities (Ye, mue) are ignored in this default, so override in derived classes if needed. Sign convention follows qValue().

+
Parameters
+ + + + + + + +
T9Temperature in GK (10^9 K).
rhoMass density (g cm^-3).
YeElectron fraction (ignored by default implementation).
mueElectron chemical potential (ignored by default implementation).
YComposition vector.
index_to_species_mapMapping from state-vector index to Species.
+
+
+
Returns
Energy generation rate, typically rate * qValue().
+ +

Reimplemented in gridfire::rates::weak::WeakReaction.

+ +
+
+ +

◆ calculate_log_rate_partial_deriv_wrt_T9()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual double gridfire::reaction::Reaction::calculate_log_rate_partial_deriv_wrt_T9 (double T9,
double rho,
double Ye,
double mue,
const fourdst::composition::Composition & comp 
) const
+ 		+pure virtual
+
+ +

Logarithmic partial derivative of the rate with respect to temperature.

+

Implementations return d(ln rate)/d(ln T9) or an equivalent measure (as documented by the concrete class), evaluated at the provided state.

+
Parameters
+ + + + + + +
T9Temperature in GK (10^9 K).
rhoMass density (g cm^-3).
YeElectron fraction.
mueElectron chemical potential.
compComposition object providing composition in a convenient form.
+
+
+
Returns
The logarithmic temperature derivative of the rate.
+ +

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

+ +
+
+ +

◆ calculate_rate() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual CppAD::AD< double > gridfire::reaction::Reaction::calculate_rate (CppAD::AD< double > T9,
CppAD::AD< double > rho,
CppAD::AD< double > Ye,
CppAD::AD< double > mue,
const std::vector< CppAD::AD< double > > & Y,
const std::unordered_map< size_t, fourdst::atomic::Species > & index_to_species_map 
) const
+ 		+pure virtual
+
+ +

AD-enabled reaction rate for algorithmic differentiation.

+

This overload mirrors calculate_rate(double, ...) but operates on CppAD types to enable derivative calculations w.r.t. its inputs.

+
Parameters
+ + + + + + + +
T9Temperature in GK as CppAD::AD<double>.
rhoMass density as CppAD::AD<double>.
YeElectron fraction as CppAD::AD<double>.
mueElectron chemical potential as CppAD::AD<double>.
YComposition vector as CppAD::AD<double> values.
index_to_species_mapMapping from state-vector index to Species, used to interpret Y.
+
+
+
Returns
The reaction rate as a CppAD::AD<double> value.
+ +

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

+ +
+
+ +

◆ calculate_rate() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual double gridfire::reaction::Reaction::calculate_rate (double T9,
double rho,
double Ye,
double mue,
const std::vector< double > & Y,
const std::unordered_map< size_t, fourdst::atomic::Species > & index_to_species_map 
) const
+ 		+pure virtual
+
+ +

Compute the temperature- and composition-dependent reaction rate.

+

This is the primary interface used by the network to obtain the rate of a single reaction at the given thermodynamic state and composition. The exact units and normalization are defined by the concrete implementation (e.g., REACLIB typically provides NA<sigma v> with units depending on the reaction order). Implementations may use density/electron properties for weak processes or screening, and the composition vector for multi-body reactions.

+
Parameters
+ + + + + + + +
T9Temperature in GK (10^9 K).
rhoMass density (g cm^-3). May be unused for some reaction types.
YeElectron fraction. May be unused depending on the reaction type.
mueElectron chemical potential. May be unused depending on the reaction type.
YComposition vector (molar abundances or number fractions) indexed consistently with index_to_species_map.
index_to_species_mapMapping from state-vector index to Species, used to interpret Y.
+
+
+
Returns
The reaction rate for the forward direction, with units/normalization defined by the specific model (implementation must document its convention).
+ +

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

+ +
+
+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::unique_ptr< Reaction > gridfire::reaction::Reaction::clone () const
+ 		+pure virtual
+
+ +

Polymorphic deep copy.

+
Returns
A std::unique_ptr owning a new Reaction equal to this one.
+ +

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

+ +
+
+ +

◆ contains()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual bool gridfire::reaction::Reaction::contains (const fourdst::atomic::Species & species) const
+ 		+pure virtual
+
+ +

True if the species appears as a reactant or a product.

+
Parameters
+ + +
speciesSpecies to test.
+
+
+
Returns
Whether the species participates in the reaction (either side).
+ +

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

+ +
+
+ +

◆ contains_product()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual bool gridfire::reaction::Reaction::contains_product (const fourdst::atomic::Species & species) const
+ 		+pure virtual
+
+ +

True if the species appears among the products.

+
Parameters
+ + +
speciesSpecies to test.
+
+
+
Returns
Whether the species is a product.
+ +

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

+ +
+
+ +

◆ contains_reactant()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual bool gridfire::reaction::Reaction::contains_reactant (const fourdst::atomic::Species & species) const
+ 		+pure virtual
+
+ +

True if the species appears among the reactants.

+
Parameters
+ + +
speciesSpecies to test.
+
+
+
Returns
Whether the species is a reactant.
+ +

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

+ +
+
+ +

◆ countProductOccurrences()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual size_t gridfire::reaction::Reaction::countProductOccurrences (const fourdst::atomic::Species & species) const
+ 		+pure virtual
+
+ +

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

+ +
+
+ +

◆ countReactantOccurrences()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual size_t gridfire::reaction::Reaction::countReactantOccurrences (const fourdst::atomic::Species & species) const
+ 		+pure virtual
+
+ +

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

+ +
+
+ +

◆ getRateCoefficients()

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

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

+ +
+
+ +

◆ hash()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual uint64_t gridfire::reaction::Reaction::hash (uint64_t seed) const
+ 		+pure virtual
+
+ +

Stable content-based hash for this reaction.

+

Intended for use in caches, sets, and order-independent hashing of Reaction collections. Implementations should produce the same value across processes for the same content and seed.

Parameters
+ + +
seedSeed value to initialize/mix into the hash.
+
+
+
Returns
64-bit hash value.
+ +

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

+ +
+
+ +

◆ id()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::string_view gridfire::reaction::Reaction::id () const
+ 		+pure virtual
+
+ +

A stable, unique identifier for this reaction instance.

+
Returns
String view of the reaction ID (stable across runs and suitable for lookups).
+ +

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

+ +
+
+ +

◆ is_reverse()

+ +
+
+ + + + + +
+ + + + + + + +
virtual bool gridfire::reaction::Reaction::is_reverse () const
+ 		+pure virtual
+
+ +

Whether this object represents a reverse (backward) rate.

+

Implementations may pair forward/reverse rates for detailed balance. This flag indicates that the parameterization corresponds to the reverse direction.

Returns
True for a reverse rate, false for a forward rate.
+ +

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

+ +
+
+ +

◆ num_species()

+ +
+
+ + + + + +
+ + + + + + + +
virtual size_t gridfire::reaction::Reaction::num_species () const
+ 		+pure virtual
+
+ +

Number of unique species involved in the reaction.

+
Returns
Count of distinct species across reactants and products.
+ +

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

+ +
+
+ +

◆ product_species()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::unordered_set< fourdst::atomic::Species > gridfire::reaction::Reaction::product_species () const
+ 		+pure virtual
+
+ +

Set of unique product species.

+
Returns
Unordered set of product species (no duplicates).
+ +

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

+ +
+
+ +

◆ products()

+ +
+
+ + + + + +
+ + + + + + + +
virtual const std::vector< fourdst::atomic::Species > & gridfire::reaction::Reaction::products () const
+ 		+pure virtual
+
+ +

Ordered list of product species.

+

Multiplicity is represented by duplicates if applicable.

Returns
Const reference to the vector of products.
+ +

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

+ +
+
+ +

◆ qValue()

+ +
+
+ + + + + +
+ + + + + + + +
virtual double gridfire::reaction::Reaction::qValue () const
+ 		+pure virtual
+
+ +

Q-value of the reaction (typically MeV), positive if exothermic.

+
Returns
Reaction Q-value used for energy accounting.
+ +

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

+ +
+
+ +

◆ reactant_species()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::unordered_set< fourdst::atomic::Species > gridfire::reaction::Reaction::reactant_species () const
+ 		+pure virtual
+
+ +

Set of unique reactant species.

+
Returns
Unordered set of reactant species (no duplicates).
+ +

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

+ +
+
+ +

◆ reactants()

+ +
+
+ + + + + +
+ + + + + + + +
virtual const std::vector< fourdst::atomic::Species > & gridfire::reaction::Reaction::reactants () const
+ 		+pure virtual
+
+ +

Ordered list of reactant species.

+

Multiplicity is represented by duplicates, e.g., (p, p) would list H1 twice.

Returns
Const reference to the vector of reactants.
+ +

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

+ +
+
+ +

◆ stoichiometry() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::unordered_map< fourdst::atomic::Species, int > gridfire::reaction::Reaction::stoichiometry () const
+ 		+pure virtual
+
+ +

Full stoichiometry map for this reaction.

+

Coefficients are negative for reactants and positive for products; multiplicity is reflected in the magnitude (e.g., 2H -> He gives H: -2, He: +1).

Returns
Map from Species to integer stoichiometric coefficient.
+ +

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

+ +
+
+ +

◆ stoichiometry() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
virtual int gridfire::reaction::Reaction::stoichiometry (const fourdst::atomic::Species & species) const
+ 		+pure virtual
+
+ +

Stoichiometric coefficient for a particular species.

+
Parameters
+ + +
speciesSpecies for which to query the coefficient.
+
+
+
Returns
Negative for reactants, positive for products, zero if absent.
+ +

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

+ +
+
+ +

◆ type()

+ +
+
+ + + + + +
+ + + + + + + +
virtual ReactionType gridfire::reaction::Reaction::type () const
+ 		+pure virtual
+
+ +

Category of this reaction (e.g., REACLIB, WEAK, LOGICAL_REACLIB).

+
Returns
Enumerated reaction type for runtime dispatch and filtering.
+ +

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

+ +
+
+

Friends And Related Symbol Documentation

+ +

◆ operator<<

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::ostream & operator<< (std::ostream & os,
const Reaction & r 
)
+ 		+friend
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1Reaction.js b/docs/html/classgridfire_1_1reaction_1_1Reaction.js new file mode 100644 index 00000000..e6487941 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1Reaction.js @@ -0,0 +1,30 @@ +var classgridfire_1_1reaction_1_1Reaction = +[ + [ "~Reaction", "classgridfire_1_1reaction_1_1Reaction.html#ab1860df84843be70f97469761e11ab6a", null ], + [ "all_species", "classgridfire_1_1reaction_1_1Reaction.html#aa13cd9097229fcc99128d9286b8f17e6", null ], + [ "calculate_energy_generation_rate", "classgridfire_1_1reaction_1_1Reaction.html#a4282f85c34d6db1994c07e7a40f66d80", null ], + [ "calculate_energy_generation_rate", "classgridfire_1_1reaction_1_1Reaction.html#ae66b446c98add7e00a1d960f4e7c60dd", null ], + [ "calculate_log_rate_partial_deriv_wrt_T9", "classgridfire_1_1reaction_1_1Reaction.html#aa2b615e764bb005e526ca9327319c735", null ], + [ "calculate_rate", "classgridfire_1_1reaction_1_1Reaction.html#af8303d67df61fc9e31ce054f0e8a3e14", null ], + [ "calculate_rate", "classgridfire_1_1reaction_1_1Reaction.html#a83c121480533593adfd68c4a67a649f1", null ], + [ "clone", "classgridfire_1_1reaction_1_1Reaction.html#ab95ce7fb022a9432bdc77f14679221ee", null ], + [ "contains", "classgridfire_1_1reaction_1_1Reaction.html#a768db057d358240d4825c21869af0792", null ], + [ "contains_product", "classgridfire_1_1reaction_1_1Reaction.html#a2708d2e8f42159df6605a5948b13c4c5", null ], + [ "contains_reactant", "classgridfire_1_1reaction_1_1Reaction.html#ab28bf4f9417ecabcc8350bae449fedd5", null ], + [ "countProductOccurrences", "classgridfire_1_1reaction_1_1Reaction.html#a62fc82b29bacc10cfbceaa1571b14525", null ], + [ "countReactantOccurrences", "classgridfire_1_1reaction_1_1Reaction.html#a036773e4dc917facbf2308dbbe853633", null ], + [ "getRateCoefficients", "classgridfire_1_1reaction_1_1Reaction.html#a6c51c30a0eec2f00c7d1f1c0be44cb0b", null ], + [ "hash", "classgridfire_1_1reaction_1_1Reaction.html#a7ba8c18cd5445aa3499a6fd351183f7a", null ], + [ "id", "classgridfire_1_1reaction_1_1Reaction.html#a94b92308b9619ec20c690e55157786ba", null ], + [ "is_reverse", "classgridfire_1_1reaction_1_1Reaction.html#a3906a668410e02239f9031b5fc580214", null ], + [ "num_species", "classgridfire_1_1reaction_1_1Reaction.html#ae2a1b0395ac127c792a8049cd0bcc249", null ], + [ "product_species", "classgridfire_1_1reaction_1_1Reaction.html#a0d16572ae2b664374d32ee6c4e22123a", null ], + [ "products", "classgridfire_1_1reaction_1_1Reaction.html#a3d7451045d8df41ea98b5e419e0e5ab0", null ], + [ "qValue", "classgridfire_1_1reaction_1_1Reaction.html#a7e06936f9e8bb74e68eaa10e708e5d3c", null ], + [ "reactant_species", "classgridfire_1_1reaction_1_1Reaction.html#a82c14096308cdc9126ab6d9667febcd2", null ], + [ "reactants", "classgridfire_1_1reaction_1_1Reaction.html#ac7b08c61cdc97268b9442afec4d08dad", null ], + [ "stoichiometry", "classgridfire_1_1reaction_1_1Reaction.html#ad49f4cad024db72c966d949c75f1ce4d", null ], + [ "stoichiometry", "classgridfire_1_1reaction_1_1Reaction.html#ab7888b57507d6d27de6e5fcaea40fff5", null ], + [ "type", "classgridfire_1_1reaction_1_1Reaction.html#a7f2590eee9f0dfb7b73cd92170a844b7", null ], + [ "operator<<", "classgridfire_1_1reaction_1_1Reaction.html#a2b05ab608187216fc751bd2e42e8b7d8", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1reaction_1_1ReactionSet-members.html b/docs/html/classgridfire_1_1reaction_1_1ReactionSet-members.html new file mode 100644 index 00000000..ca7d957a --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1ReactionSet-members.html @@ -0,0 +1,144 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::reaction::ReactionSet Member List
+
+
+ +

This is the complete list of members for gridfire::reaction::ReactionSet, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
add_reaction(const Reaction &reaction)gridfire::reaction::ReactionSet
add_reaction(std::unique_ptr< Reaction > &&reaction)gridfire::reaction::ReactionSet
begin()gridfire::reaction::ReactionSetinline
begin() constgridfire::reaction::ReactionSetinline
clear()gridfire::reaction::ReactionSet
contains(const std::string_view &id) constgridfire::reaction::ReactionSet
contains(const Reaction &reaction) constgridfire::reaction::ReactionSet
contains_product(const fourdst::atomic::Species &species) constgridfire::reaction::ReactionSet
contains_reactant(const fourdst::atomic::Species &species) constgridfire::reaction::ReactionSet
contains_species(const fourdst::atomic::Species &species) constgridfire::reaction::ReactionSet
empty() constgridfire::reaction::ReactionSetinline
end()gridfire::reaction::ReactionSetinline
end() constgridfire::reaction::ReactionSetinline
extend(const ReactionSet &other)gridfire::reaction::ReactionSet
get(const std::string_view &id) constgridfire::reaction::ReactionSet
getReactionSetSpecies() constgridfire::reaction::ReactionSet
hash(uint64_t seed) constgridfire::reaction::ReactionSet
m_idgridfire::reaction::ReactionSetprivate
m_loggergridfire::reaction::ReactionSetprivate
m_reactionHashesgridfire::reaction::ReactionSetprivate
m_reactionNameMapgridfire::reaction::ReactionSetprivate
m_reactionsgridfire::reaction::ReactionSetprivate
operator!=(const ReactionSet &other) constgridfire::reaction::ReactionSet
operator<<gridfire::reaction::ReactionSetfriend
operator=(const ReactionSet &other)gridfire::reaction::ReactionSet
operator==(const ReactionSet &other) constgridfire::reaction::ReactionSet
operator[](size_t index) constgridfire::reaction::ReactionSet
operator[](const std::string_view &id) constgridfire::reaction::ReactionSet
ReactionSet(std::vector< std::unique_ptr< Reaction > > &&reactions)gridfire::reaction::ReactionSetexplicit
ReactionSet(const std::vector< Reaction * > &reactions)gridfire::reaction::ReactionSetexplicit
ReactionSet()gridfire::reaction::ReactionSet
ReactionSet(const ReactionSet &other)gridfire::reaction::ReactionSet
remove_reaction(const Reaction &reaction)gridfire::reaction::ReactionSet
size() constgridfire::reaction::ReactionSetinline
+
+ + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1ReactionSet.html b/docs/html/classgridfire_1_1reaction_1_1ReactionSet.html new file mode 100644 index 00000000..26c2cee6 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1ReactionSet.html @@ -0,0 +1,1091 @@ + + + + + + + +GridFire: gridfire::reaction::ReactionSet Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +Friends | +List of all members
+
gridfire::reaction::ReactionSet Class Referencefinal
+
+
+ +

#include <reaction.h>

+
+Collaboration diagram for gridfire::reaction::ReactionSet:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 ReactionSet (std::vector< std::unique_ptr< Reaction > > &&reactions)
 Constructs a ReactionSet from a vector of reactions.
 
 ReactionSet (const std::vector< Reaction * > &reactions)
 
 ReactionSet ()
 
 ReactionSet (const ReactionSet &other)
 Copy constructor.
 
ReactionSet & operator= (const ReactionSet &other)
 Copy assignment operator.
 
void add_reaction (const Reaction &reaction)
 Adds a reaction to the set.
 
void add_reaction (std::unique_ptr< Reaction > &&reaction)
 
void extend (const ReactionSet &other)
 
std::optional< std::unique_ptr< Reaction > > get (const std::string_view &id) const
 
void remove_reaction (const Reaction &reaction)
 Removes a reaction from the set.
 
bool contains (const std::string_view &id) const
 Checks if the set contains a reaction with the given ID.
 
bool contains (const Reaction &reaction) const
 Checks if the set contains the given reaction.
 
size_t size () const
 Gets the number of reactions in the set.
 
bool empty () const
 
void clear ()
 Removes all reactions from the set.
 
bool contains_species (const fourdst::atomic::Species &species) const
 Checks if any reaction in the set involves the given species.
 
bool contains_reactant (const fourdst::atomic::Species &species) const
 Checks if any reaction in the set contains the given species as a reactant.
 
bool contains_product (const fourdst::atomic::Species &species) const
 Checks if any reaction in the set contains the given species as a product.
 
const Reaction & operator[] (size_t index) const
 Accesses a reaction by its index.
 
const Reaction & operator[] (const std::string_view &id) const
 Accesses a reaction by its ID.
 
bool operator== (const ReactionSet &other) const
 Compares this set with another for equality.
 
bool operator!= (const ReactionSet &other) const
 Compares this set with another for inequality.
 
uint64_t hash (uint64_t seed) const
 Computes a hash for the entire set.
 
std::unordered_set< fourdst::atomic::Species > getReactionSetSpecies () const
 
Iterators

Provides iterators to loop over the reactions in the set.

+
auto begin ()
 
auto begin () const
 
auto end ()
 
auto end () const
 
+ + + + + + + + + + + + +

+Private Attributes

quill::Logger * m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
 
std::vector< std::unique_ptr< Reaction > > m_reactions
 
std::string m_id
 
std::unordered_map< std::string, size_t > m_reactionNameMap
 Maps reaction IDs to Reaction objects for quick lookup.
 
std::unordered_set< size_t > m_reactionHashes
 
+ + + +

+Friends

std::ostream & operator<< (std::ostream &os, const ReactionSet &rs)
 
+

Constructor & Destructor Documentation

+ +

◆ ReactionSet() [1/4]

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::reaction::ReactionSet::ReactionSet (std::vector< std::unique_ptr< Reaction > > && reactions)
+ 		+explicit
+
+ +

Constructs a ReactionSet from a vector of reactions.

+
Parameters
+ + +
reactionsThe initial vector of Reaction objects.
+
+
+ +
+
+ +

◆ ReactionSet() [2/4]

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::reaction::ReactionSet::ReactionSet (const std::vector< Reaction * > & reactions)
+ 		+explicit
+
+ +
+
+ +

◆ ReactionSet() [3/4]

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::reaction::ReactionSet::ReactionSet ()
+ 		+default
+
+ +
+
+ +

◆ ReactionSet() [4/4]

+ +
+
+ + + + + + + + +
gridfire::reaction::ReactionSet::ReactionSet (const ReactionSet & other)
+
+ +

Copy constructor.

+
Parameters
+ + +
otherThe ReactionSet to copy.
+
+
+ +
+
+

Member Function Documentation

+ +

◆ add_reaction() [1/2]

+ +
+
+ + + + + + + + +
void gridfire::reaction::ReactionSet::add_reaction (const Reaction & reaction)
+
+ +

Adds a reaction to the set.

+
Parameters
+ + +
reactionThe Reaction to add.
+
+
+ +
+
+ +

◆ add_reaction() [2/2]

+ +
+
+ + + + + + + + +
void gridfire::reaction::ReactionSet::add_reaction (std::unique_ptr< Reaction > && reaction)
+
+ +
+
+ +

◆ begin() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
auto gridfire::reaction::ReactionSet::begin ()
+ 		+inline
+
+ +
+
+ +

◆ begin() [2/2]

+ +
+
+ + + + + +
+ + + + + + + +
auto gridfire::reaction::ReactionSet::begin () const
+ 		+inline
+
+ +
+
+ +

◆ clear()

+ +
+
+ + + + + + + +
void gridfire::reaction::ReactionSet::clear ()
+
+ +

Removes all reactions from the set.

+ +
+
+ +

◆ contains() [1/2]

+ +
+
+ + + + + + + + +
bool gridfire::reaction::ReactionSet::contains (const Reaction & reaction) const
+
+ +

Checks if the set contains the given reaction.

+
Parameters
+ + +
reactionThe Reaction to find.
+
+
+
Returns
True if the reaction is in the set, false otherwise.
+ +
+
+ +

◆ contains() [2/2]

+ +
+
+ + + + + + + + +
bool gridfire::reaction::ReactionSet::contains (const std::string_view & id) const
+
+ +

Checks if the set contains a reaction with the given ID.

+
Parameters
+ + +
idThe ID of the reaction to find.
+
+
+
Returns
True if the reaction is in the set, false otherwise.
+ +
+
+ +

◆ contains_product()

+ +
+
+ + + + + + + + +
bool gridfire::reaction::ReactionSet::contains_product (const fourdst::atomic::Species & species) const
+
+ +

Checks if any reaction in the set contains the given species as a product.

+
Parameters
+ + +
speciesThe species to check for.
+
+
+
Returns
True if the species is a product in any reaction.
+ +
+
+ +

◆ contains_reactant()

+ +
+
+ + + + + + + + +
bool gridfire::reaction::ReactionSet::contains_reactant (const fourdst::atomic::Species & species) const
+
+ +

Checks if any reaction in the set contains the given species as a reactant.

+
Parameters
+ + +
speciesThe species to check for.
+
+
+
Returns
True if the species is a reactant in any reaction.
+ +
+
+ +

◆ contains_species()

+ +
+
+ + + + + + + + +
bool gridfire::reaction::ReactionSet::contains_species (const fourdst::atomic::Species & species) const
+
+ +

Checks if any reaction in the set involves the given species.

+
Parameters
+ + +
speciesThe species to check for.
+
+
+
Returns
True if the species is involved in any reaction.
+ +
+
+ +

◆ empty()

+ +
+
+ + + + + +
+ + + + + + + +
bool gridfire::reaction::ReactionSet::empty () const
+ 		+inline
+
+ +
+
+ +

◆ end() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
auto gridfire::reaction::ReactionSet::end ()
+ 		+inline
+
+ +
+
+ +

◆ end() [2/2]

+ +
+
+ + + + + +
+ + + + + + + +
auto gridfire::reaction::ReactionSet::end () const
+ 		+inline
+
+ +
+
+ +

◆ extend()

+ +
+
+ + + + + + + + +
void gridfire::reaction::ReactionSet::extend (const ReactionSet & other)
+
+ +
+
+ +

◆ get()

+ +
+
+ + + + + + + + +
std::optional< std::unique_ptr< Reaction > > gridfire::reaction::ReactionSet::get (const std::string_view & id) const
+
+ +
+
+ +

◆ getReactionSetSpecies()

+ +
+
+ + + + + + + +
std::unordered_set< Species > gridfire::reaction::ReactionSet::getReactionSetSpecies () const
+
+ +
+
+ +

◆ hash()

+ +
+
+ + + + + + + + +
uint64_t gridfire::reaction::ReactionSet::hash (uint64_t seed) const
+
+ +

Computes a hash for the entire set.

+
Parameters
+ + +
seedThe seed for the hash function.
+
+
+
Returns
A 64-bit hash value.
+

The algorithm computes the hash of each individual reaction, sorts the hashes, and then computes a final hash over the sorted list of hashes. This ensures the hash is order-independent.

+ +
+
+ +

◆ operator!=()

+ +
+
+ + + + + + + + +
bool gridfire::reaction::ReactionSet::operator!= (const ReactionSet & other) const
+
+ +

Compares this set with another for inequality.

+
Parameters
+ + +
otherThe other ReactionSet to compare with.
+
+
+
Returns
True if the sets are not equal.
+ +
+
+ +

◆ operator=()

+ +
+
+ + + + + + + + +
ReactionSet & gridfire::reaction::ReactionSet::operator= (const ReactionSet & other)
+
+ +

Copy assignment operator.

+
Parameters
+ + +
otherThe ReactionSet to assign from.
+
+
+
Returns
A reference to this ReactionSet.
+ +
+
+ +

◆ operator==()

+ +
+
+ + + + + + + + +
bool gridfire::reaction::ReactionSet::operator== (const ReactionSet & other) const
+
+ +

Compares this set with another for equality.

+
Parameters
+ + +
otherThe other ReactionSet to compare with.
+
+
+
Returns
True if the sets are equal (same size and hash).
+ +
+
+ +

◆ operator[]() [1/2]

+ +
+
+ + + + + + + + +
const Reaction & gridfire::reaction::ReactionSet::operator[] (const std::string_view & id) const
+
+ +

Accesses a reaction by its ID.

+
Parameters
+ + +
idThe ID of the reaction to access.
+
+
+
Returns
A const reference to the Reaction.
+
Exceptions
+ + +
std::out_of_rangeif no reaction with the given ID exists.
+
+
+ +
+
+ +

◆ operator[]() [2/2]

+ +
+
+ + + + + + + + +
const Reaction & gridfire::reaction::ReactionSet::operator[] (size_t index) const
+
+ +

Accesses a reaction by its index.

+
Parameters
+ + +
indexThe index of the reaction to access.
+
+
+
Returns
A const reference to the Reaction.
+
Exceptions
+ + +
std::out_of_rangeif the index is out of bounds.
+
+
+ +
+
+ +

◆ remove_reaction()

+ +
+
+ + + + + + + + +
void gridfire::reaction::ReactionSet::remove_reaction (const Reaction & reaction)
+
+ +

Removes a reaction from the set.

+
Parameters
+ + +
reactionThe Reaction to remove.
+
+
+ +
+
+ +

◆ size()

+ +
+
+ + + + + +
+ + + + + + + +
size_t gridfire::reaction::ReactionSet::size () const
+ 		+inline
+
+ +

Gets the number of reactions in the set.

+
Returns
The size of the set.
+ +
+
+

Friends And Related Symbol Documentation

+ +

◆ operator<<

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::ostream & operator<< (std::ostream & os,
const ReactionSet & rs 
)
+ 		+friend
+
+ +
+
+

Member Data Documentation

+ +

◆ m_id

+ +
+
+ + + + + +
+ + + + +
std::string gridfire::reaction::ReactionSet::m_id
+ 		+private
+
+ +
+
+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::reaction::ReactionSet::m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +
+
+ +

◆ m_reactionHashes

+ +
+
+ + + + + +
+ + + + +
std::unordered_set<size_t> gridfire::reaction::ReactionSet::m_reactionHashes
+ 		+private
+
+ +
+
+ +

◆ m_reactionNameMap

+ +
+
+ + + + + +
+ + + + +
std::unordered_map<std::string, size_t> gridfire::reaction::ReactionSet::m_reactionNameMap
+ 		+private
+
+ +

Maps reaction IDs to Reaction objects for quick lookup.

+ +
+
+ +

◆ m_reactions

+ +
+
+ + + + + +
+ + + + +
std::vector<std::unique_ptr<Reaction> > gridfire::reaction::ReactionSet::m_reactions
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1ReactionSet.js b/docs/html/classgridfire_1_1reaction_1_1ReactionSet.js new file mode 100644 index 00000000..c0797254 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1ReactionSet.js @@ -0,0 +1,37 @@ +var classgridfire_1_1reaction_1_1ReactionSet = +[ + [ "ReactionSet", "classgridfire_1_1reaction_1_1ReactionSet.html#a9a63306b92e23e3651c955ab614084de", null ], + [ "ReactionSet", "classgridfire_1_1reaction_1_1ReactionSet.html#a789dee5d93810b85062e59508fe0adea", null ], + [ "ReactionSet", "classgridfire_1_1reaction_1_1ReactionSet.html#ab9edff40316b42ce41b2f895962c1041", null ], + [ "ReactionSet", "classgridfire_1_1reaction_1_1ReactionSet.html#acfe2341ae1f016ad82098b6f5a1efc45", null ], + [ "add_reaction", "classgridfire_1_1reaction_1_1ReactionSet.html#ad9dbc77e93467c95ebda908b53e9a9d1", null ], + [ "add_reaction", "classgridfire_1_1reaction_1_1ReactionSet.html#ad7e95562ea0860bf492b447341f41fb5", null ], + [ "begin", "classgridfire_1_1reaction_1_1ReactionSet.html#a228f2a00f46a6ee01be887490a722613", null ], + [ "begin", "classgridfire_1_1reaction_1_1ReactionSet.html#adb73fe9ff0178359409e2bea46a620c2", null ], + [ "clear", "classgridfire_1_1reaction_1_1ReactionSet.html#aa8e0d65aafc6e0320690b4906e1bf300", null ], + [ "contains", "classgridfire_1_1reaction_1_1ReactionSet.html#a2f6b165c86634a68f35032c2267255f8", null ], + [ "contains", "classgridfire_1_1reaction_1_1ReactionSet.html#ae5f8078e77a700a8356487fbd69ba387", null ], + [ "contains_product", "classgridfire_1_1reaction_1_1ReactionSet.html#a4bdf50219d686a6cbc0b3cc5365dc18e", null ], + [ "contains_reactant", "classgridfire_1_1reaction_1_1ReactionSet.html#a256998eddf292f744d51cdc3e178d4c2", null ], + [ "contains_species", "classgridfire_1_1reaction_1_1ReactionSet.html#a5b872a8519740a6d06cfaed03784826a", null ], + [ "empty", "classgridfire_1_1reaction_1_1ReactionSet.html#a7cfce57192993e71c8437a64030caa2d", null ], + [ "end", "classgridfire_1_1reaction_1_1ReactionSet.html#abae9fbc4b4306479a6cd3173ac628987", null ], + [ "end", "classgridfire_1_1reaction_1_1ReactionSet.html#a436f9c4b8f8a4e115b19728d57d8e105", null ], + [ "extend", "classgridfire_1_1reaction_1_1ReactionSet.html#a6a4836776f5dd00158d2336e5bcc3222", null ], + [ "get", "classgridfire_1_1reaction_1_1ReactionSet.html#a85314ee0dde7e12915f63237086b5eb6", null ], + [ "getReactionSetSpecies", "classgridfire_1_1reaction_1_1ReactionSet.html#a133ad8cca6a75d31ef8efe67801aef1b", null ], + [ "hash", "classgridfire_1_1reaction_1_1ReactionSet.html#ad28907fc08de978461d68cc5b77a3a99", null ], + [ "operator!=", "classgridfire_1_1reaction_1_1ReactionSet.html#a529189f464aebc6b5ac5c717f70e14b8", null ], + [ "operator=", "classgridfire_1_1reaction_1_1ReactionSet.html#aac890bf7fdf689890d765ff67489520a", null ], + [ "operator==", "classgridfire_1_1reaction_1_1ReactionSet.html#a4e572e823a80b905e7d002b612123135", null ], + [ "operator[]", "classgridfire_1_1reaction_1_1ReactionSet.html#a896b4e492ef596d9174aeda4b59c46cd", null ], + [ "operator[]", "classgridfire_1_1reaction_1_1ReactionSet.html#a4057f74ae647b691f4f61f150553c52b", null ], + [ "remove_reaction", "classgridfire_1_1reaction_1_1ReactionSet.html#a1177193b1e46b4e5be630028883ab8dd", null ], + [ "size", "classgridfire_1_1reaction_1_1ReactionSet.html#af14cf34d7367cb6a6be5191724c2d4cf", null ], + [ "operator<<", "classgridfire_1_1reaction_1_1ReactionSet.html#a5a5e6ed364794f872c2c819536e24c20", null ], + [ "m_id", "classgridfire_1_1reaction_1_1ReactionSet.html#af92e3003b2a3606b48ab857cdedc3111", null ], + [ "m_logger", "classgridfire_1_1reaction_1_1ReactionSet.html#aff5ae284012009164d4b3033577709eb", null ], + [ "m_reactionHashes", "classgridfire_1_1reaction_1_1ReactionSet.html#a4200939ccf088dd83c3d264df171d568", null ], + [ "m_reactionNameMap", "classgridfire_1_1reaction_1_1ReactionSet.html#a62965c04447909462bb4f2112661ef44", null ], + [ "m_reactions", "classgridfire_1_1reaction_1_1ReactionSet.html#abd6feda1b3f65a6177904755581f6efe", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1reaction_1_1ReactionSet__coll__graph.map b/docs/html/classgridfire_1_1reaction_1_1ReactionSet__coll__graph.map new file mode 100644 index 00000000..c828c646 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1ReactionSet__coll__graph.map @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1ReactionSet__coll__graph.md5 b/docs/html/classgridfire_1_1reaction_1_1ReactionSet__coll__graph.md5 new file mode 100644 index 00000000..9175c48f --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1ReactionSet__coll__graph.md5 @@ -0,0 +1 @@ +f488c816f7ecb458dc9144097149f961 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1reaction_1_1ReactionSet__coll__graph.svg b/docs/html/classgridfire_1_1reaction_1_1ReactionSet__coll__graph.svg new file mode 100644 index 00000000..d2349641 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1ReactionSet__coll__graph.svg @@ -0,0 +1,253 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::reaction::ReactionSet + + +Node1 + + +gridfire::reaction +::ReactionSet + + + + + +Node2 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node2->Node1 + + + + + + m_reactions + + + +Node3 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node3->Node2 + + + + + + elements + + + +Node4 + + +gridfire::reaction +::Reaction + + + + + +Node4->Node3 + + + + + + ptr + + + +Node5 + + +std::string + + + + + +Node5->Node1 + + + + + + m_id + + + +Node7 + + +std::unordered_map +< std::string, size_t > + + + + + +Node5->Node7 + + + + + + keys + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + +Node7->Node1 + + + + + + m_reactionNameMap + + + +Node8 + + +std::unordered_set +< size_t > + + + + + +Node8->Node1 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1ReactionSet__coll__graph_org.svg b/docs/html/classgridfire_1_1reaction_1_1ReactionSet__coll__graph_org.svg new file mode 100644 index 00000000..5521ec33 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1ReactionSet__coll__graph_org.svg @@ -0,0 +1,171 @@ + + + + + + +gridfire::reaction::ReactionSet + + +Node1 + + +gridfire::reaction +::ReactionSet + + + + + +Node2 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node2->Node1 + + + + + + m_reactions + + + +Node3 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node3->Node2 + + + + + + elements + + + +Node4 + + +gridfire::reaction +::Reaction + + + + + +Node4->Node3 + + + + + + ptr + + + +Node5 + + +std::string + + + + + +Node5->Node1 + + + + + + m_id + + + +Node7 + + +std::unordered_map +< std::string, size_t > + + + + + +Node5->Node7 + + + + + + keys + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + +Node7->Node1 + + + + + + m_reactionNameMap + + + +Node8 + + +std::unordered_set +< size_t > + + + + + +Node8->Node1 + + + + + + m_reactionHashes + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1Reaction__inherit__graph.map b/docs/html/classgridfire_1_1reaction_1_1Reaction__inherit__graph.map new file mode 100644 index 00000000..09990d7b --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1Reaction__inherit__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1Reaction__inherit__graph.md5 b/docs/html/classgridfire_1_1reaction_1_1Reaction__inherit__graph.md5 new file mode 100644 index 00000000..ae9f6c22 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1Reaction__inherit__graph.md5 @@ -0,0 +1 @@ +ec30f0c81a2e768a78f9d3888c03d390 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1reaction_1_1Reaction__inherit__graph.svg b/docs/html/classgridfire_1_1reaction_1_1Reaction__inherit__graph.svg new file mode 100644 index 00000000..32c01f1f --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1Reaction__inherit__graph.svg @@ -0,0 +1,123 @@ + + + + + + + + + + + +gridfire::reaction::Reaction + + +Node1 + + +gridfire::reaction +::Reaction + + + + + +Node2 + + +gridfire::rates::weak +::WeakReaction + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::reaction +::ReaclibReaction + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::reaction +::LogicalReaclibReaction + + + + + +Node3->Node4 + + + + + + + + +Node5 + + +gridfire::reaction +::WeakReaclibReaction + + + + + +Node3->Node5 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1Reaction__inherit__graph_org.svg b/docs/html/classgridfire_1_1reaction_1_1Reaction__inherit__graph_org.svg new file mode 100644 index 00000000..db09935f --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1Reaction__inherit__graph_org.svg @@ -0,0 +1,98 @@ + + + + + + +gridfire::reaction::Reaction + + +Node1 + + +gridfire::reaction +::Reaction + + + + + +Node2 + + +gridfire::rates::weak +::WeakReaction + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::reaction +::ReaclibReaction + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::reaction +::LogicalReaclibReaction + + + + + +Node3->Node4 + + + + + + + + +Node5 + + +gridfire::reaction +::WeakReaclibReaction + + + + + +Node3->Node5 + + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction-members.html b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction-members.html new file mode 100644 index 00000000..7b39ac46 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction-members.html @@ -0,0 +1,158 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::reaction::WeakReaclibReaction Member List
+
+
+ +

This is the complete list of members for gridfire::reaction::WeakReaclibReaction, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
all_species() const overridegridfire::reaction::ReaclibReactionvirtual
calculate_energy_generation_rate(const double T9, const double rho, const double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) constgridfire::reaction::Reactioninlinevirtual
calculate_energy_generation_rate(const CppAD::AD< double > &T9, const CppAD::AD< double > &rho, const CppAD::AD< double > &Ye, const CppAD::AD< double > &mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) constgridfire::reaction::Reactioninlinevirtual
calculate_log_rate_partial_deriv_wrt_T9(double T9, double rho, double Ye, double mue, const fourdst::composition::Composition &comp) const overridegridfire::reaction::ReaclibReactionvirtual
calculate_rate(double T9, double rho, double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const overridegridfire::reaction::ReaclibReactionvirtual
calculate_rate(CppAD::AD< double > T9, CppAD::AD< double > rho, CppAD::AD< double > Ye, CppAD::AD< double > mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const overridegridfire::reaction::ReaclibReactionvirtual
calculate_rate(const T T9) constgridfire::reaction::ReaclibReactioninlineprivate
chapter() constgridfire::reaction::ReaclibReactioninline
clone() const overridegridfire::reaction::WeakReaclibReactioninlinevirtual
contains(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactionvirtual
contains_product(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactionvirtual
contains_reactant(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactionvirtual
countProductOccurrences(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactioninlinevirtual
countReactantOccurrences(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactioninlinevirtual
excess_energy() constgridfire::reaction::ReaclibReaction
getRateCoefficients() const overridegridfire::reaction::ReaclibReactionvirtual
hash(uint64_t seed) const overridegridfire::reaction::ReaclibReactionvirtual
id() const overridegridfire::reaction::ReaclibReactioninlinevirtual
is_reverse() const overridegridfire::reaction::ReaclibReactioninlinevirtual
m_chaptergridfire::reaction::ReaclibReactionprotected
m_idgridfire::reaction::ReaclibReactionprotected
m_loggergridfire::reaction::ReaclibReactionprotected
m_peNamegridfire::reaction::ReaclibReactionprotected
m_productsgridfire::reaction::ReaclibReactionprotected
m_productsVecgridfire::reaction::ReaclibReactionmutableprotected
m_qValuegridfire::reaction::ReaclibReactionprotected
m_rateCoefficientsgridfire::reaction::ReaclibReactionprotected
m_reactantsgridfire::reaction::ReaclibReactionprotected
m_reactantsVecgridfire::reaction::ReaclibReactionmutableprotected
m_reversegridfire::reaction::ReaclibReactionprotected
m_sourceLabelgridfire::reaction::ReaclibReactionprotected
num_species() const overridegridfire::reaction::ReaclibReactionvirtual
operator!=(const ReaclibReaction &other) constgridfire::reaction::ReaclibReactioninline
operator==(const ReaclibReaction &other) constgridfire::reaction::ReaclibReactioninline
peName() constgridfire::reaction::ReaclibReactioninlinevirtual
product_species() const overridegridfire::reaction::ReaclibReactionvirtual
products() const overridegridfire::reaction::ReaclibReactioninlinevirtual
qValue() const overridegridfire::reaction::ReaclibReactioninlinevirtual
rateCoefficients() constgridfire::reaction::ReaclibReactioninline
ReaclibReaction(std::string_view id, std::string_view peName, int chapter, const std::vector< fourdst::atomic::Species > &reactants, const std::vector< fourdst::atomic::Species > &products, double qValue, std::string_view label, const RateCoefficientSet &sets, bool reverse=false)gridfire::reaction::WeakReaclibReaction
reactant_species() const overridegridfire::reaction::ReaclibReactionvirtual
reactants() const overridegridfire::reaction::ReaclibReactioninlinevirtual
sourceLabel() constgridfire::reaction::ReaclibReactioninline
stoichiometry(const fourdst::atomic::Species &species) const overridegridfire::reaction::ReaclibReactionvirtual
stoichiometry() const overridegridfire::reaction::ReaclibReactionvirtual
type() const overridegridfire::reaction::WeakReaclibReactioninlinevirtual
~ReaclibReaction() override=defaultgridfire::reaction::ReaclibReaction
~Reaction()=defaultgridfire::reaction::Reactionvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction.html b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction.html new file mode 100644 index 00000000..c35a5aa6 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction.html @@ -0,0 +1,420 @@ + + + + + + + +GridFire: gridfire::reaction::WeakReaclibReaction Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::reaction::WeakReaclibReaction Class Referencefinal
+
+
+ +

#include <reaction.h>

+
+Inheritance diagram for gridfire::reaction::WeakReaclibReaction:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::reaction::WeakReaclibReaction:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

ReactionType type () const override
 Category of this reaction (e.g., REACLIB, WEAK, LOGICAL_REACLIB).
 
std::unique_ptr< Reaction > clone () const override
 Polymorphic deep copy.
 
 ReaclibReaction (std::string_view id, std::string_view peName, int chapter, const std::vector< fourdst::atomic::Species > &reactants, const std::vector< fourdst::atomic::Species > &products, double qValue, std::string_view label, const RateCoefficientSet &sets, bool reverse=false)
 Constructs a Reaction object.
 
- Public Member Functions inherited from gridfire::reaction::ReaclibReaction
 ~ReaclibReaction () override=default
 
 ReaclibReaction (std::string_view id, std::string_view peName, int chapter, const std::vector< fourdst::atomic::Species > &reactants, const std::vector< fourdst::atomic::Species > &products, double qValue, std::string_view label, const RateCoefficientSet &sets, bool reverse=false)
 Constructs a Reaction object.
 
double calculate_rate (double T9, double rho, double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const override
 Calculates the reaction rate for a given temperature.
 
CppAD::AD< double > calculate_rate (CppAD::AD< double > T9, CppAD::AD< double > rho, CppAD::AD< double > Ye, CppAD::AD< double > mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const override
 Calculates the reaction rate for a given temperature using CppAD types.
 
double calculate_log_rate_partial_deriv_wrt_T9 (double T9, double rho, double Ye, double mue, const fourdst::composition::Composition &comp) const override
 Logarithmic partial derivative of the rate with respect to temperature.
 
virtual std::string_view peName () const
 Gets the reaction name in (projectile, ejectile) notation.
 
int chapter () const
 Gets the REACLIB chapter number.
 
std::string_view sourceLabel () const
 Gets the source label for the rate data.
 
const RateCoefficientSet & rateCoefficients () const
 Gets the set of rate coefficients.
 
std::optional< std::vector< RateCoefficientSet > > getRateCoefficients () const override
 
bool contains (const fourdst::atomic::Species &species) const override
 Checks if the reaction involves a given species as a reactant or product.
 
bool contains_reactant (const fourdst::atomic::Species &species) const override
 Checks if the reaction involves a given species as a reactant.
 
bool contains_product (const fourdst::atomic::Species &species) const override
 Checks if the reaction involves a given species as a product.
 
std::unordered_set< fourdst::atomic::Species > all_species () const override
 Gets a set of all unique species involved in the reaction.
 
std::unordered_set< fourdst::atomic::Species > reactant_species () const override
 Gets a set of all unique reactant species.
 
std::unordered_set< fourdst::atomic::Species > product_species () const override
 Gets a set of all unique product species.
 
size_t num_species () const override
 Gets the number of unique species involved in the reaction.
 
int stoichiometry (const fourdst::atomic::Species &species) const override
 Calculates the stoichiometric coefficient for a given species.
 
std::unordered_map< fourdst::atomic::Species, int > stoichiometry () const override
 Gets a map of all species to their stoichiometric coefficients.
 
std::string_view id () const override
 Gets the unique identifier of the reaction.
 
double qValue () const override
 Gets the Q-value of the reaction.
 
const std::vector< fourdst::atomic::Species > & reactants () const override
 Gets the vector of reactant species.
 
const std::vector< fourdst::atomic::Species > & products () const override
 Gets the vector of product species.
 
bool is_reverse () const override
 Checks if this is a reverse reaction rate.
 
double excess_energy () const
 Calculates the excess energy from the mass difference of reactants and products.
 
bool operator== (const ReaclibReaction &other) const
 Compares this reaction with another for equality based on their IDs.
 
bool operator!= (const ReaclibReaction &other) const
 Compares this reaction with another for inequality.
 
uint64_t hash (uint64_t seed) const override
 Computes a hash for the reaction based on its ID.
 
size_t countReactantOccurrences (const fourdst::atomic::Species &species) const override
 
size_t countProductOccurrences (const fourdst::atomic::Species &species) const override
 
- Public Member Functions inherited from gridfire::reaction::Reaction
virtual ~Reaction ()=default
 Virtual destructor for correct polymorphic cleanup.
 
virtual double calculate_energy_generation_rate (const double T9, const double rho, const double Ye, double mue, const std::vector< double > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const
 Convenience: energy generation rate from this reaction (double version).
 
virtual CppAD::AD< double > calculate_energy_generation_rate (const CppAD::AD< double > &T9, const CppAD::AD< double > &rho, const CppAD::AD< double > &Ye, const CppAD::AD< double > &mue, const std::vector< CppAD::AD< double > > &Y, const std::unordered_map< size_t, fourdst::atomic::Species > &index_to_species_map) const
 Convenience: AD-enabled energy generation rate (AD version).
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::reaction::ReaclibReaction
quill::Logger * m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
 
std::string m_id
 Unique identifier for the reaction (e.g., "h1+h1=>h2+e+nu").
 
std::string m_peName
 Name of the reaction in (projectile, ejectile) notation (e.g. "p(p,g)d").
 
int m_chapter
 Chapter number from the REACLIB database, defining the reaction structure.
 
double m_qValue = 0.0
 Q-value of the reaction in MeV.
 
std::unordered_map< fourdst::atomic::Species, size_t > m_reactants
 Reactants of the reaction.
 
std::unordered_map< fourdst::atomic::Species, size_t > m_products
 Products of the reaction.
 
std::optional< std::vector< fourdst::atomic::Species > > m_reactantsVec
 
std::optional< std::vector< fourdst::atomic::Species > > m_productsVec
 
std::string m_sourceLabel
 Source label for the rate data (e.g., "wc12w", "st08").
 
RateCoefficientSet m_rateCoefficients
 The seven rate coefficients.
 
bool m_reverse = false
 Flag indicating if this is a reverse reaction rate.
 
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr< Reaction > gridfire::reaction::WeakReaclibReaction::clone () const
+ 		+inlineoverridevirtual
+
+ +

Polymorphic deep copy.

+
Returns
A std::unique_ptr owning a new Reaction equal to this one.
+ +

Reimplemented from gridfire::reaction::ReaclibReaction.

+ +
+
+ +

◆ ReaclibReaction()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
gridfire::reaction::ReaclibReaction::ReaclibReaction (std::string_view id,
std::string_view peName,
int chapter,
const std::vector< fourdst::atomic::Species > & reactants,
const std::vector< fourdst::atomic::Species > & products,
double qValue,
std::string_view label,
const RateCoefficientSet & sets,
bool reverse = false 
)
+
+ +

Constructs a Reaction object.

+
Parameters
+ + + + + + + + + + +
idA unique identifier for the reaction.
peNameThe name in (projectile, ejectile) notation (e.g., "p(p,g)d").
chapterThe REACLIB chapter number, defining reaction structure.
reactantsA vector of reactant species.
productsA vector of product species.
qValueThe Q-value of the reaction in MeV.
labelThe sources label for the rate data (e.g., "wc12", "st08").
setsThe set of rate coefficients.
reverseTrue if this is a reverse reaction rate.
+
+
+ +
+
+ +

◆ type()

+ +
+
+ + + + + +
+ + + + + + + +
ReactionType gridfire::reaction::WeakReaclibReaction::type () const
+ 		+inlineoverridevirtual
+
+ +

Category of this reaction (e.g., REACLIB, WEAK, LOGICAL_REACLIB).

+
Returns
Enumerated reaction type for runtime dispatch and filtering.
+ +

Reimplemented from gridfire::reaction::ReaclibReaction.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction.js b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction.js new file mode 100644 index 00000000..455115df --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction.js @@ -0,0 +1,6 @@ +var classgridfire_1_1reaction_1_1WeakReaclibReaction = +[ + [ "clone", "classgridfire_1_1reaction_1_1WeakReaclibReaction.html#ac3fc463a1cea6854ea989732e1e5f65a", null ], + [ "ReaclibReaction", "classgridfire_1_1reaction_1_1WeakReaclibReaction.html#a264112a230817a6080c770686e5bcc01", null ], + [ "type", "classgridfire_1_1reaction_1_1WeakReaclibReaction.html#af191b4afdf41a9916ecf9647e88d8037", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__coll__graph.map b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__coll__graph.map new file mode 100644 index 00000000..185cc64c --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__coll__graph.map @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__coll__graph.md5 b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__coll__graph.md5 new file mode 100644 index 00000000..17fc984d --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__coll__graph.md5 @@ -0,0 +1 @@ +529117ae4c9cbd432d1fabb7d2509dc0 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__coll__graph.svg b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__coll__graph.svg new file mode 100644 index 00000000..69ac2d45 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__coll__graph.svg @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::reaction::WeakReaclibReaction + + +Node1 + + +gridfire::reaction +::WeakReaclibReaction + + + + + +Node2 + + +gridfire::reaction +::ReaclibReaction + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::reaction +::Reaction + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::string + + + + + +Node4->Node2 + + + + + + m_id +m_peName +m_sourceLabel + + + +Node5 + + +std::basic_string< + Char > + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node6->Node2 + + + + + + m_products +m_reactants + + + +Node7 + + +Species + + + + + +Node7->Node6 + + + + + + keys + + + +Node8 + + +gridfire::reaction +::RateCoefficientSet + + + + + +Node8->Node2 + + + + + + m_rateCoefficients + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__coll__graph_org.svg b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__coll__graph_org.svg new file mode 100644 index 00000000..d41a2791 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__coll__graph_org.svg @@ -0,0 +1,161 @@ + + + + + + +gridfire::reaction::WeakReaclibReaction + + +Node1 + + +gridfire::reaction +::WeakReaclibReaction + + + + + +Node2 + + +gridfire::reaction +::ReaclibReaction + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::reaction +::Reaction + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::string + + + + + +Node4->Node2 + + + + + + m_id +m_peName +m_sourceLabel + + + +Node5 + + +std::basic_string< + Char > + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node6->Node2 + + + + + + m_products +m_reactants + + + +Node7 + + +Species + + + + + +Node7->Node6 + + + + + + keys + + + +Node8 + + +gridfire::reaction +::RateCoefficientSet + + + + + +Node8->Node2 + + + + + + m_rateCoefficients + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__inherit__graph.map b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__inherit__graph.map new file mode 100644 index 00000000..d6d7cd07 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__inherit__graph.md5 b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__inherit__graph.md5 new file mode 100644 index 00000000..cef92436 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__inherit__graph.md5 @@ -0,0 +1 @@ +8219d028de6e1a6e4a62cd8658489e3f \ No newline at end of file diff --git a/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__inherit__graph.svg b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__inherit__graph.svg new file mode 100644 index 00000000..123c0794 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__inherit__graph.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + +gridfire::reaction::WeakReaclibReaction + + +Node1 + + +gridfire::reaction +::WeakReaclibReaction + + + + + +Node2 + + +gridfire::reaction +::ReaclibReaction + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::reaction +::Reaction + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__inherit__graph_org.svg b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__inherit__graph_org.svg new file mode 100644 index 00000000..2f9c3060 --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1WeakReaclibReaction__inherit__graph_org.svg @@ -0,0 +1,60 @@ + + + + + + +gridfire::reaction::WeakReaclibReaction + + +Node1 + + +gridfire::reaction +::WeakReaclibReaction + + + + + +Node2 + + +gridfire::reaction +::ReaclibReaction + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::reaction +::Reaction + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1BareScreeningModel-members.html b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel-members.html new file mode 100644 index 00000000..2aa54b92 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel-members.html @@ -0,0 +1,115 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::screening::BareScreeningModel Member List
+
+
+ +

This is the complete list of members for gridfire::screening::BareScreeningModel, including all inherited members.

+ + + + + + +
ADDouble typedefgridfire::screening::BareScreeningModelprivate
calculateFactors_impl(const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< T > &Y, const T &T9, const T &rho) constgridfire::screening::BareScreeningModelprivate
calculateScreeningFactors(const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, double T9, double rho) const overridegridfire::screening::BareScreeningModelvirtual
calculateScreeningFactors(const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< CppAD::AD< double > > &Y, ADDouble T9, ADDouble rho) const overridegridfire::screening::BareScreeningModelvirtual
~ScreeningModel()=defaultgridfire::screening::ScreeningModelvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1screening_1_1BareScreeningModel.html b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel.html new file mode 100644 index 00000000..cfb74466 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel.html @@ -0,0 +1,436 @@ + + + + + + + +GridFire: gridfire::screening::BareScreeningModel Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Types | +Private Member Functions | +List of all members
+
gridfire::screening::BareScreeningModel Class Referencefinal
+
+
+ +

A screening model that applies no screening effect. + More...

+ +

#include <screening_bare.h>

+
+Inheritance diagram for gridfire::screening::BareScreeningModel:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::screening::BareScreeningModel:
+
+
+
[legend]
+ + + + + + + + + + + + +

+Public Member Functions

std::vector< double > calculateScreeningFactors (const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, double T9, double rho) const override
 Calculates screening factors, which are always 1.0.
 
std::vector< ADDouble > calculateScreeningFactors (const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< CppAD::AD< double > > &Y, ADDouble T9, ADDouble rho) const override
 Calculates screening factors for AD types, which are always 1.0.
 
- Public Member Functions inherited from gridfire::screening::ScreeningModel
virtual ~ScreeningModel ()=default
 Virtual destructor.
 
+ + + + +

+Private Types

using ADDouble = CppAD::AD< double >
 Alias for CppAD Automatic Differentiation type for double precision.
 
+ + + + + +

+Private Member Functions

template<typename T >
std::vector< T > calculateFactors_impl (const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< T > &Y, const T &T9, const T &rho) const
 Template implementation for calculating screening factors.
 
+ + + + + +

+Additional Inherited Members

- Public Types inherited from gridfire::screening::ScreeningModel
using ADDouble = CppAD::AD< double >
 Alias for CppAD Automatic Differentiation type for double precision.
 
+

Detailed Description

+

A screening model that applies no screening effect.

+

This class implements the ScreeningModel interface but returns a screening factor of 1.0 for all reactions, regardless of the plasma conditions. It represents the case of bare, unscreened nuclei and serves as a baseline or can be used when screening effects are negligible or intentionally ignored.

+

Member Typedef Documentation

+ +

◆ ADDouble

+ +
+
+ + + + + +
+ + + + +
using gridfire::screening::BareScreeningModel::ADDouble = CppAD::AD<double>
+ 		+private
+
+ +

Alias for CppAD Automatic Differentiation type for double precision.

+ +
+
+

Member Function Documentation

+ +

◆ calculateFactors_impl()

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< T > gridfire::screening::BareScreeningModel::calculateFactors_impl (const reaction::ReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< T > & Y,
const T & T9,
const T & rho 
) const
+ 		+private
+
+ +

Template implementation for calculating screening factors.

+

Template implementation for the bare screening model.

+

This private helper function contains the core logic for both the double and ADDouble versions of calculateScreeningFactors. It is templated to handle both numeric types seamlessly.

+
Template Parameters
+ + +
TThe numeric type, either double or CppAD::AD<double>.
+
+
+
Parameters
+ + + + + + +
reactionsThe set of reactions for which to calculate factors.
speciesA vector of all atomic species (unused).
YThe current molar composition (unused).
T9The temperature (unused).
rhoThe density (unused).
+
+
+
Returns
A vector of type T with all elements initialized to 1.0.
+

This function provides the actual implementation for calculateFactors_impl. It creates a vector of the appropriate numeric type (T) and size, and initializes all its elements to 1.0, representing no screening.

+
Template Parameters
+ + +
TThe numeric type, either double or CppAD::AD<double>.
+
+
+
Parameters
+ + + + +
reactionsThe set of reactions, used to determine the size of the output vector.
speciesUnused parameter.
YUnused parameter. @param T9 Unused parameter. @param rho Unused parameter. @return Astd::vector<T>of the same size asreactions`, with all elements set to 1.0.
+
+
+ +
+
+ +

◆ calculateScreeningFactors() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< ADDouble > gridfire::screening::BareScreeningModel::calculateScreeningFactors (const reaction::ReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< CppAD::AD< double > > & Y,
ADDouble T9,
ADDouble rho 
) const
+ 		+overridevirtual
+
+ +

Calculates screening factors for AD types, which are always 1.0.

+

This implementation returns a vector of AD-typed screening factors where every element is 1.0. This is the automatic differentiation-compatible version.

+
Parameters
+ + + + + + +
reactionsThe set of logical reactions in the network.
speciesA vector of all atomic species (unused).
YThe current composition, providing molar abundances (mol/g) for each species (unused).
T9The temperature as an AD type (unused).
rhoThe plasma density as an AD type (unused).
+
+
+
Returns
A vector of ADDouble, with each element being 1.0, of the same size as the reactions set.
+ +

Implements gridfire::screening::ScreeningModel.

+ +
+
+ +

◆ calculateScreeningFactors() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< double > gridfire::screening::BareScreeningModel::calculateScreeningFactors (const reaction::ReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< double > & Y,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Calculates screening factors, which are always 1.0.

+

This implementation returns a vector of screening factors where every element is 1.0, effectively applying no screening correction to the reaction rates.

+
Parameters
+ + + + + + +
reactionsThe set of logical reactions in the network.
speciesA vector of all atomic species (unused).
YA vector of the molar abundances.
T9The temperature (unused).
rhoThe plasma density (unused).
+
+
+
Returns
A vector of doubles, with each element being 1.0, of the same size as the reactions set.
+

Algorithm The function simply creates and returns a std::vector<double> of the same size as the input reactions set, with all elements initialized to 1.0.

+

Usage

BareScreeningModel bare_model;
+
// ... (initialize reactions, species, Y, T9, rho)
+
std::vector<double> factors = bare_model.calculateScreeningFactors(
+
reactions, species, Y, T9, rho
+
);
+
// 'factors' will contain [1.0, 1.0, ...]
+
gridfire::screening::BareScreeningModel
A screening model that applies no screening effect.
Definition screening_bare.h:21
+
gridfire::screening::BareScreeningModel::calculateScreeningFactors
std::vector< double > calculateScreeningFactors(const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, double T9, double rho) const override
Calculates screening factors, which are always 1.0.
Definition screening_bare.cpp:22
+
+

Implements gridfire::screening::ScreeningModel.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1screening_1_1BareScreeningModel.js b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel.js new file mode 100644 index 00000000..6cdfac79 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel.js @@ -0,0 +1,7 @@ +var classgridfire_1_1screening_1_1BareScreeningModel = +[ + [ "ADDouble", "classgridfire_1_1screening_1_1BareScreeningModel.html#a51119d705267e0b415aae8b4881d8c96", null ], + [ "calculateFactors_impl", "classgridfire_1_1screening_1_1BareScreeningModel.html#a48a3392d735c61b15b4855c823acfada", null ], + [ "calculateScreeningFactors", "classgridfire_1_1screening_1_1BareScreeningModel.html#a0ac3685a90c1e65a84e03cfb2fed29e5", null ], + [ "calculateScreeningFactors", "classgridfire_1_1screening_1_1BareScreeningModel.html#ad252ce1de82401bab24747aabf0c8a3a", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__coll__graph.map b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__coll__graph.map new file mode 100644 index 00000000..274259f8 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__coll__graph.md5 b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__coll__graph.md5 new file mode 100644 index 00000000..912a56e3 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__coll__graph.md5 @@ -0,0 +1 @@ +00784c45754dbe0179ca880df9ce9ac8 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__coll__graph.svg b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__coll__graph.svg new file mode 100644 index 00000000..09b5c4e4 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__coll__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +gridfire::screening::BareScreeningModel + + +Node1 + + +gridfire::screening +::BareScreeningModel + + + + + +Node2 + + +gridfire::screening +::ScreeningModel + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__coll__graph_org.svg b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__coll__graph_org.svg new file mode 100644 index 00000000..82f9e02f --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__coll__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +gridfire::screening::BareScreeningModel + + +Node1 + + +gridfire::screening +::BareScreeningModel + + + + + +Node2 + + +gridfire::screening +::ScreeningModel + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__inherit__graph.map b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__inherit__graph.map new file mode 100644 index 00000000..274259f8 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__inherit__graph.md5 b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__inherit__graph.md5 new file mode 100644 index 00000000..912a56e3 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__inherit__graph.md5 @@ -0,0 +1 @@ +00784c45754dbe0179ca880df9ce9ac8 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__inherit__graph.svg b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__inherit__graph.svg new file mode 100644 index 00000000..09b5c4e4 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__inherit__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +gridfire::screening::BareScreeningModel + + +Node1 + + +gridfire::screening +::BareScreeningModel + + + + + +Node2 + + +gridfire::screening +::ScreeningModel + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__inherit__graph_org.svg b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__inherit__graph_org.svg new file mode 100644 index 00000000..82f9e02f --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1BareScreeningModel__inherit__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +gridfire::screening::BareScreeningModel + + +Node1 + + +gridfire::screening +::BareScreeningModel + + + + + +Node2 + + +gridfire::screening +::ScreeningModel + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel-members.html b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel-members.html new file mode 100644 index 00000000..91dce5e8 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel-members.html @@ -0,0 +1,115 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::screening::IntermediateScreeningModel Member List
+
+
+ +

This is the complete list of members for gridfire::screening::IntermediateScreeningModel, including all inherited members.

+ + + + + + +
ADDouble typedefgridfire::screening::ScreeningModel
calculateFactors_impl(const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< T > &Y, T T9, T rho) constgridfire::screening::IntermediateScreeningModelprivate
calculateScreeningFactors(const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, double T9, double rho) const overridegridfire::screening::IntermediateScreeningModelvirtual
calculateScreeningFactors(const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< ADDouble > &Y, ADDouble T9, ADDouble rho) const overridegridfire::screening::IntermediateScreeningModelvirtual
~ScreeningModel()=defaultgridfire::screening::ScreeningModelvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel.html b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel.html new file mode 100644 index 00000000..7a72dce8 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel.html @@ -0,0 +1,368 @@ + + + + + + + +GridFire: gridfire::screening::IntermediateScreeningModel Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Member Functions | +List of all members
+
gridfire::screening::IntermediateScreeningModel Class Referencefinal
+
+
+ +

#include <screening_intermediate.h>

+
+Inheritance diagram for gridfire::screening::IntermediateScreeningModel:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::screening::IntermediateScreeningModel:
+
+
+
[legend]
+ + + + + + + + + + + + +

+Public Member Functions

std::vector< double > calculateScreeningFactors (const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, double T9, double rho) const override
 Calculates screening factors for a set of reactions.
 
std::vector< ADDouble > calculateScreeningFactors (const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< ADDouble > &Y, ADDouble T9, ADDouble rho) const override
 Calculates screening factors using CppAD types for automatic differentiation.
 
- Public Member Functions inherited from gridfire::screening::ScreeningModel
virtual ~ScreeningModel ()=default
 Virtual destructor.
 
+ + + + +

+Private Member Functions

template<typename T >
std::vector< T > calculateFactors_impl (const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< T > &Y, T T9, T rho) const
 
+ + + + + +

+Additional Inherited Members

- Public Types inherited from gridfire::screening::ScreeningModel
using ADDouble = CppAD::AD< double >
 Alias for CppAD Automatic Differentiation type for double precision.
 
+

Member Function Documentation

+ +

◆ calculateFactors_impl()

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< T > gridfire::screening::IntermediateScreeningModel::calculateFactors_impl (const reaction::ReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< T > & Y,
T T9,
T rho 
) const
+ 		+private
+
+ +
+
+ +

◆ calculateScreeningFactors() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< ADDouble > gridfire::screening::IntermediateScreeningModel::calculateScreeningFactors (const reaction::ReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< ADDouble > & Y,
ADDouble T9,
ADDouble rho 
) const
+ 		+overridevirtual
+
+ +

Calculates screening factors using CppAD types for automatic differentiation.

+

This is a pure virtual function that provides an overload of calculateScreeningFactors for use with CppAD. It allows the derivatives of the screening factors with respect to abundances, temperature, and density to be computed automatically.

+
Parameters
+ + + + + + +
reactionsThe set of logical reactions in the network.
speciesA vector of all atomic species involved in the network.
YThe current composition, providing molar abundances (mol/g) for each species.
T9The temperature in units of 10^9 K, as an AD type.
rhoThe plasma density in g/cm^3, as an AD type.
+
+
+
Returns
A vector of screening factors (dimensionless), as AD types.
+

Note This method is essential for including the effects of screening in the Jacobian matrix of the reaction network.

+ +

Implements gridfire::screening::ScreeningModel.

+ +
+
+ +

◆ calculateScreeningFactors() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< double > gridfire::screening::IntermediateScreeningModel::calculateScreeningFactors (const reaction::ReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< double > & Y,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Calculates screening factors for a set of reactions.

+

This is a pure virtual function that must be implemented by derived classes. It computes the screening enhancement factor for each reaction in the provided set based on the given plasma conditions.

+
Parameters
+ + + + + + +
reactionsThe set of logical reactions in the network.
speciesA vector of all atomic species involved in the network.
YThe current composition, providing molar abundances (mol/g) for each species.
T9The temperature in units of 10^9 K.
rhoThe plasma density in g/cm^3.
+
+
+
Returns
A vector of screening factors (dimensionless), one for each reaction in the reactions set, in the same order.
+

Pre-conditions

    +
  • The size of the Y vector must match the size of the species vector.
    • +
  • T9 and rho must be positive.
    • +
+

Post-conditions

    +
  • The returned vector will have the same size as the reactions set.
    • +
  • Each element in the returned vector will be >= 1.0.
    • +
+

Usage

// Assume 'model' is a std::unique_ptr<ScreeningModel> to a concrete implementation
+
// and other parameters (reactions, species, Y, T9, rho) are initialized.
+
std::vector<double> screening_factors = model->calculateScreeningFactors(
+
reactions, species, Y, T9, rho
+
);
+
for (size_t i = 0; i < reactions.size(); ++i) {
+
// ... use screening_factors[i] ...
+
}
+
+

Implements gridfire::screening::ScreeningModel.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel.js b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel.js new file mode 100644 index 00000000..d7a4f677 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel.js @@ -0,0 +1,6 @@ +var classgridfire_1_1screening_1_1IntermediateScreeningModel = +[ + [ "calculateFactors_impl", "classgridfire_1_1screening_1_1IntermediateScreeningModel.html#a794b7781f07343383da3894208cfbfa9", null ], + [ "calculateScreeningFactors", "classgridfire_1_1screening_1_1IntermediateScreeningModel.html#a765e369256282f0f25e66e13c33dcbd9", null ], + [ "calculateScreeningFactors", "classgridfire_1_1screening_1_1IntermediateScreeningModel.html#a86a218ce82306ed582296cbeb3de0250", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__coll__graph.map b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__coll__graph.map new file mode 100644 index 00000000..e8280fc2 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__coll__graph.md5 b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__coll__graph.md5 new file mode 100644 index 00000000..a1bde105 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__coll__graph.md5 @@ -0,0 +1 @@ +7e499adc3bfd2b4f1d6e26d96d53d981 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__coll__graph.svg b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__coll__graph.svg new file mode 100644 index 00000000..004df1f1 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__coll__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +gridfire::screening::IntermediateScreeningModel + + +Node1 + + +gridfire::screening +::IntermediateScreeningModel + + + + + +Node2 + + +gridfire::screening +::ScreeningModel + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__coll__graph_org.svg b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__coll__graph_org.svg new file mode 100644 index 00000000..14c690cb --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__coll__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +gridfire::screening::IntermediateScreeningModel + + +Node1 + + +gridfire::screening +::IntermediateScreeningModel + + + + + +Node2 + + +gridfire::screening +::ScreeningModel + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__inherit__graph.map b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__inherit__graph.map new file mode 100644 index 00000000..e8280fc2 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__inherit__graph.md5 b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__inherit__graph.md5 new file mode 100644 index 00000000..a1bde105 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__inherit__graph.md5 @@ -0,0 +1 @@ +7e499adc3bfd2b4f1d6e26d96d53d981 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__inherit__graph.svg b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__inherit__graph.svg new file mode 100644 index 00000000..004df1f1 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__inherit__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +gridfire::screening::IntermediateScreeningModel + + +Node1 + + +gridfire::screening +::IntermediateScreeningModel + + + + + +Node2 + + +gridfire::screening +::ScreeningModel + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__inherit__graph_org.svg b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__inherit__graph_org.svg new file mode 100644 index 00000000..14c690cb --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1IntermediateScreeningModel__inherit__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +gridfire::screening::IntermediateScreeningModel + + +Node1 + + +gridfire::screening +::IntermediateScreeningModel + + + + + +Node2 + + +gridfire::screening +::ScreeningModel + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1ScreeningModel-members.html b/docs/html/classgridfire_1_1screening_1_1ScreeningModel-members.html new file mode 100644 index 00000000..12f3fb8b --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1ScreeningModel-members.html @@ -0,0 +1,114 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::screening::ScreeningModel Member List
+
+
+ +

This is the complete list of members for gridfire::screening::ScreeningModel, including all inherited members.

+ + + + + +
ADDouble typedefgridfire::screening::ScreeningModel
calculateScreeningFactors(const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, double T9, double rho) const =0gridfire::screening::ScreeningModelpure virtual
calculateScreeningFactors(const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< CppAD::AD< double > > &Y, ADDouble T9, ADDouble rho) const =0gridfire::screening::ScreeningModelpure virtual
~ScreeningModel()=defaultgridfire::screening::ScreeningModelvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1screening_1_1ScreeningModel.html b/docs/html/classgridfire_1_1screening_1_1ScreeningModel.html new file mode 100644 index 00000000..8819ffd8 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1ScreeningModel.html @@ -0,0 +1,352 @@ + + + + + + + +GridFire: gridfire::screening::ScreeningModel Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Types | +Public Member Functions | +List of all members
+
gridfire::screening::ScreeningModel Class Referenceabstract
+
+
+ +

An abstract base class for plasma screening models. + More...

+ +

#include <screening_abstract.h>

+
+Inheritance diagram for gridfire::screening::ScreeningModel:
+
+
+
[legend]
+ + + + + +

+Public Types

using ADDouble = CppAD::AD< double >
 Alias for CppAD Automatic Differentiation type for double precision.
 
+ + + + + + + + + + +

+Public Member Functions

virtual ~ScreeningModel ()=default
 Virtual destructor.
 
virtual std::vector< double > calculateScreeningFactors (const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, double T9, double rho) const =0
 Calculates screening factors for a set of reactions.
 
virtual std::vector< ADDouble > calculateScreeningFactors (const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< CppAD::AD< double > > &Y, ADDouble T9, ADDouble rho) const =0
 Calculates screening factors using CppAD types for automatic differentiation.
 
+

Detailed Description

+

An abstract base class for plasma screening models.

+

This class defines the interface for models that calculate the enhancement factor for nuclear reaction rates due to the electrostatic screening of interacting nuclei by the surrounding plasma. Concrete implementations of this class will provide specific screening prescriptions (e.g., WEAK, BARE, STRONG, etc.).

+

The interface provides methods for calculating screening factors for both standard double-precision inputs and for CppAD's automatic differentiation types, allowing the screening contributions to be included in Jacobian calculations.

+

Member Typedef Documentation

+ +

◆ ADDouble

+ +
+
+ + + + +
using gridfire::screening::ScreeningModel::ADDouble = CppAD::AD<double>
+
+ +

Alias for CppAD Automatic Differentiation type for double precision.

+ +
+
+

Constructor & Destructor Documentation

+ +

◆ ~ScreeningModel()

+ +
+
+ + + + + +
+ + + + + + + +
virtual gridfire::screening::ScreeningModel::~ScreeningModel ()
+ 		+virtualdefault
+
+ +

Virtual destructor.

+

Ensures that derived class destructors are called correctly.

+ +
+
+

Member Function Documentation

+ +

◆ calculateScreeningFactors() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual std::vector< ADDouble > gridfire::screening::ScreeningModel::calculateScreeningFactors (const reaction::ReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< CppAD::AD< double > > & Y,
ADDouble T9,
ADDouble rho 
) const
+ 		+pure virtual
+
+ +

Calculates screening factors using CppAD types for automatic differentiation.

+

This is a pure virtual function that provides an overload of calculateScreeningFactors for use with CppAD. It allows the derivatives of the screening factors with respect to abundances, temperature, and density to be computed automatically.

+
Parameters
+ + + + + + +
reactionsThe set of logical reactions in the network.
speciesA vector of all atomic species involved in the network.
YThe current composition, providing molar abundances (mol/g) for each species.
T9The temperature in units of 10^9 K, as an AD type.
rhoThe plasma density in g/cm^3, as an AD type.
+
+
+
Returns
A vector of screening factors (dimensionless), as AD types.
+

Note This method is essential for including the effects of screening in the Jacobian matrix of the reaction network.

+ +

Implemented in PyScreening, gridfire::screening::IntermediateScreeningModel, gridfire::screening::BareScreeningModel, and gridfire::screening::WeakScreeningModel.

+ +
+
+ +

◆ calculateScreeningFactors() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual std::vector< double > gridfire::screening::ScreeningModel::calculateScreeningFactors (const reaction::ReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< double > & Y,
double T9,
double rho 
) const
+ 		+pure virtual
+
+ +

Calculates screening factors for a set of reactions.

+

This is a pure virtual function that must be implemented by derived classes. It computes the screening enhancement factor for each reaction in the provided set based on the given plasma conditions.

+
Parameters
+ + + + + + +
reactionsThe set of logical reactions in the network.
speciesA vector of all atomic species involved in the network.
YThe current composition, providing molar abundances (mol/g) for each species.
T9The temperature in units of 10^9 K.
rhoThe plasma density in g/cm^3.
+
+
+
Returns
A vector of screening factors (dimensionless), one for each reaction in the reactions set, in the same order.
+

Pre-conditions

    +
  • The size of the Y vector must match the size of the species vector.
    • +
  • T9 and rho must be positive.
    • +
+

Post-conditions

    +
  • The returned vector will have the same size as the reactions set.
    • +
  • Each element in the returned vector will be >= 1.0.
    • +
+

Usage

// Assume 'model' is a std::unique_ptr<ScreeningModel> to a concrete implementation
+
// and other parameters (reactions, species, Y, T9, rho) are initialized.
+
std::vector<double> screening_factors = model->calculateScreeningFactors(
+
reactions, species, Y, T9, rho
+
);
+
for (size_t i = 0; i < reactions.size(); ++i) {
+
// ... use screening_factors[i] ...
+
}
+
+

Implemented in PyScreening, gridfire::screening::BareScreeningModel, gridfire::screening::IntermediateScreeningModel, and gridfire::screening::WeakScreeningModel.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1screening_1_1ScreeningModel.js b/docs/html/classgridfire_1_1screening_1_1ScreeningModel.js new file mode 100644 index 00000000..515c58a6 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1ScreeningModel.js @@ -0,0 +1,7 @@ +var classgridfire_1_1screening_1_1ScreeningModel = +[ + [ "ADDouble", "classgridfire_1_1screening_1_1ScreeningModel.html#a107ff2897f040d6f27f69d56a0bdd28d", null ], + [ "~ScreeningModel", "classgridfire_1_1screening_1_1ScreeningModel.html#adef175acdbd911527f56a1f1592579a7", null ], + [ "calculateScreeningFactors", "classgridfire_1_1screening_1_1ScreeningModel.html#a1da8242c7591ab32453d1e0109999d6c", null ], + [ "calculateScreeningFactors", "classgridfire_1_1screening_1_1ScreeningModel.html#ab08c4490f9da18254a7c6f29be1f62ce", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1screening_1_1ScreeningModel__inherit__graph.map b/docs/html/classgridfire_1_1screening_1_1ScreeningModel__inherit__graph.map new file mode 100644 index 00000000..eeddb9ef --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1ScreeningModel__inherit__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1ScreeningModel__inherit__graph.md5 b/docs/html/classgridfire_1_1screening_1_1ScreeningModel__inherit__graph.md5 new file mode 100644 index 00000000..6ca6bd59 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1ScreeningModel__inherit__graph.md5 @@ -0,0 +1 @@ +906f6678c4880421156771fa0e071b88 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1screening_1_1ScreeningModel__inherit__graph.svg b/docs/html/classgridfire_1_1screening_1_1ScreeningModel__inherit__graph.svg new file mode 100644 index 00000000..b90e9efc --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1ScreeningModel__inherit__graph.svg @@ -0,0 +1,122 @@ + + + + + + + + + + + +gridfire::screening::ScreeningModel + + +Node1 + + +gridfire::screening +::ScreeningModel + + + + + +Node2 + + +PyScreening + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::screening +::BareScreeningModel + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::screening +::IntermediateScreeningModel + + + + + +Node1->Node4 + + + + + + + + +Node5 + + +gridfire::screening +::WeakScreeningModel + + + + + +Node1->Node5 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1ScreeningModel__inherit__graph_org.svg b/docs/html/classgridfire_1_1screening_1_1ScreeningModel__inherit__graph_org.svg new file mode 100644 index 00000000..2c38c782 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1ScreeningModel__inherit__graph_org.svg @@ -0,0 +1,97 @@ + + + + + + +gridfire::screening::ScreeningModel + + +Node1 + + +gridfire::screening +::ScreeningModel + + + + + +Node2 + + +PyScreening + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::screening +::BareScreeningModel + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::screening +::IntermediateScreeningModel + + + + + +Node1->Node4 + + + + + + + + +Node5 + + +gridfire::screening +::WeakScreeningModel + + + + + +Node1->Node5 + + + + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel-members.html b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel-members.html new file mode 100644 index 00000000..04cd29d0 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel-members.html @@ -0,0 +1,116 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::screening::WeakScreeningModel Member List
+
+
+ +

This is the complete list of members for gridfire::screening::WeakScreeningModel, including all inherited members.

+ + + + + + + +
ADDouble typedefgridfire::screening::ScreeningModel
calculateFactors_impl(const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< T > &Y, T T9, T rho) constgridfire::screening::WeakScreeningModelprivate
calculateScreeningFactors(const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, double T9, double rho) const overridegridfire::screening::WeakScreeningModelvirtual
calculateScreeningFactors(const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< CppAD::AD< double > > &Y, CppAD::AD< double > T9, CppAD::AD< double > rho) const overridegridfire::screening::WeakScreeningModelvirtual
m_loggergridfire::screening::WeakScreeningModelprivate
~ScreeningModel()=defaultgridfire::screening::ScreeningModelvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel.html b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel.html new file mode 100644 index 00000000..d120c82c --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel.html @@ -0,0 +1,450 @@ + + + + + + + +GridFire: gridfire::screening::WeakScreeningModel Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Member Functions | +Private Attributes | +List of all members
+
gridfire::screening::WeakScreeningModel Class Referencefinal
+
+
+ +

Implements the weak screening model based on the Debye-Hückel approximation. + More...

+ +

#include <screening_weak.h>

+
+Inheritance diagram for gridfire::screening::WeakScreeningModel:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::screening::WeakScreeningModel:
+
+
+
[legend]
+ + + + + + + + + + + + +

+Public Member Functions

std::vector< double > calculateScreeningFactors (const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, double T9, double rho) const override
 Calculates weak screening factors for a set of reactions.
 
std::vector< CppAD::AD< double > > calculateScreeningFactors (const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< CppAD::AD< double > > &Y, CppAD::AD< double > T9, CppAD::AD< double > rho) const override
 Calculates weak screening factors using CppAD types.
 
- Public Member Functions inherited from gridfire::screening::ScreeningModel
virtual ~ScreeningModel ()=default
 Virtual destructor.
 
+ + + + + +

+Private Member Functions

template<IsArithmeticOrAD T>
std::vector< T > calculateFactors_impl (const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< T > &Y, T T9, T rho) const
 Template implementation for calculating weak screening factors.
 
+ + + + +

+Private Attributes

quill::Logger * m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
 Logger instance for recording trace and debug information.
 
+ + + + + +

+Additional Inherited Members

- Public Types inherited from gridfire::screening::ScreeningModel
using ADDouble = CppAD::AD< double >
 Alias for CppAD Automatic Differentiation type for double precision.
 
+

Detailed Description

+

Implements the weak screening model based on the Debye-Hückel approximation.

+

This class provides a concrete implementation of the ScreeningModel interface for the weak screening regime, following the formulation of Salpeter (1954). This approach applies the Debye-Hückel theory to model the electrostatic shielding of nuclei in a plasma. It is applicable to non-degenerate, non-relativistic plasmas where thermal energy dominates the electrostatic potential energy.

+

Member Function Documentation

+ +

◆ calculateFactors_impl()

+ +
+
+
+template<IsArithmeticOrAD T>
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< T > gridfire::screening::WeakScreeningModel::calculateFactors_impl (const reaction::ReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< T > & Y,
T T9,
T rho 
) const
+ 		+private
+
+ +

Template implementation for calculating weak screening factors.

+

Core implementation of the weak screening calculation (Debye-Hückel model).

+

This private helper function contains the core logic for calculating weak screening factors. It is templated to handle both double and CppAD::AD<double> numeric types, avoiding code duplication.

+
Template Parameters
+ + +
TThe numeric type, either double or CppAD::AD<double>.
+
+
+
Parameters
+ + + + + + +
reactionsThe set of reactions.
speciesA vector of all species in the network.
YThe composition object with current molar abundances.
T9The temperature in 10^9 K.
rhoThe density in g/cm^3.
+
+
+
Returns
A vector of screening factors of type T.
+

This function calculates the screening factor exp(H_12) for each reaction, based on the Debye-Hückel approximation as formulated by Salpeter (1954).

+
Template Parameters
+ + +
TThe numeric type (double or CppAD::AD<double>).
+
+
+
Parameters
+ + + + + + +
reactionsThe set of reactions to be screened.
speciesThe list of all species in the network.
YThe composition object providing current molar abundances.
T9The temperature in 10^9 K.
rhoThe density in g/cm^3.
+
+
+
Returns
A vector of screening factors, one for each reaction.
+

Algorithm

    +
  1. Low-Temperature Cutoff: If T9 is below a small threshold (1e-9), screening is effectively turned off to prevent numerical instability.
    2. +
  2. Zeta Factor (ζ): A composition-dependent term is calculated: ζ = ∑(Z_i² + Z_i) * Y_i, where Z_i is the charge and Y_i is the molar abundance of species i.
    3. +
  3. Prefactor: A key prefactor is computed: prefactor = 0.188 * sqrt(ρ / T₇³) * sqrt(ζ), where T₇ is the temperature in units of 10^7 K.
    4. +
  4. Screening Term (H_12): For each reaction, the term H_12 is calculated:
      +
    • For a two-body reaction (reactants Z₁ and Z₂): H_12 = prefactor * Z₁ * Z₂.
      • +
    • For the triple-alpha reaction (3 * He4): H_12 = 3 * (prefactor * Z_α * Z_α).
      • +
    • For one-body reactions (decays), H_12 is 0, so the factor is 1.
      • +
    +
    5. +
  5. Capping: The value of H_12 is capped at 2.0 to prevent excessively large and unphysical screening factors (exp(2) ≈ 7.4).
    6. +
  6. Final Factor: The screening factor for the reaction is exp(H_12).
    7. +
+ +
+
+ +

◆ calculateScreeningFactors() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< ADDouble > gridfire::screening::WeakScreeningModel::calculateScreeningFactors (const reaction::ReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< CppAD::AD< double > > & Y,
CppAD::AD< double > T9,
CppAD::AD< double > rho 
) const
+ 		+overridevirtual
+
+ +

Calculates weak screening factors using CppAD types.

+

This is the automatic differentiation-compatible version of the method. It allows the derivatives of the screening factors to be computed with respect to plasma conditions.

+
Parameters
+ + + + + + +
reactionsThe set of logical reactions in the network.
speciesA vector of all atomic species involved in the network.
YThe composition object giving the current molar abundances.
T9The temperature as an AD type.
rhoThe plasma density as an AD type.
+
+
+
Returns
A vector of screening factors as AD types.
+ +

Implements gridfire::screening::ScreeningModel.

+ +
+
+ +

◆ calculateScreeningFactors() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< double > gridfire::screening::WeakScreeningModel::calculateScreeningFactors (const reaction::ReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< double > & Y,
double T9,
double rho 
) const
+ 		+overridevirtual
+
+ +

Calculates weak screening factors for a set of reactions.

+

This method computes the screening enhancement factor for each reaction based on the Salpeter (1954) formula.

+
Parameters
+ + + + + + +
reactionsThe set of logical reactions in the network.
speciesA vector of all atomic species involved in the network.
YThe composition object giving the current molar abundances.
T9The temperature in units of 10^9 K.
rhoThe plasma density in g/cm^3.
+
+
+
Returns
A vector of screening factors (dimensionless), one for each reaction.
+

Usage

WeakScreeningModel weak_model;
+
// ... (initialize reactions, species, Y, T9, rho)
+
std::vector<double> factors = weak_model.calculateScreeningFactors(
+
reactions, species, Y, T9, rho
+
);
+
gridfire::screening::WeakScreeningModel
Implements the weak screening model based on the Debye-Hückel approximation.
Definition screening_weak.h:27
+
gridfire::screening::WeakScreeningModel::calculateScreeningFactors
std::vector< double > calculateScreeningFactors(const reaction::ReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, double T9, double rho) const override
Calculates weak screening factors for a set of reactions.
Definition screening_weak.cpp:22
+
+

Implements gridfire::screening::ScreeningModel.

+ +
+
+

Member Data Documentation

+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::screening::WeakScreeningModel::m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +

Logger instance for recording trace and debug information.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel.js b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel.js new file mode 100644 index 00000000..3f66efd6 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel.js @@ -0,0 +1,7 @@ +var classgridfire_1_1screening_1_1WeakScreeningModel = +[ + [ "calculateFactors_impl", "classgridfire_1_1screening_1_1WeakScreeningModel.html#aa9f95ba8c052dacb72295775516b7e5f", null ], + [ "calculateScreeningFactors", "classgridfire_1_1screening_1_1WeakScreeningModel.html#a8b0590814e7058b4ff3f0cd6f4124773", null ], + [ "calculateScreeningFactors", "classgridfire_1_1screening_1_1WeakScreeningModel.html#a6a215d082b0d05126fb2b19fd1983446", null ], + [ "m_logger", "classgridfire_1_1screening_1_1WeakScreeningModel.html#a0a4d7d6d36dbe7b764b613d34f18386f", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__coll__graph.map b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__coll__graph.map new file mode 100644 index 00000000..1fdaabd1 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__coll__graph.md5 b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__coll__graph.md5 new file mode 100644 index 00000000..75d53a8b --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__coll__graph.md5 @@ -0,0 +1 @@ +167b7454a7d46b229692007b971c8b79 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__coll__graph.svg b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__coll__graph.svg new file mode 100644 index 00000000..e5d75183 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__coll__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +gridfire::screening::WeakScreeningModel + + +Node1 + + +gridfire::screening +::WeakScreeningModel + + + + + +Node2 + + +gridfire::screening +::ScreeningModel + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__coll__graph_org.svg b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__coll__graph_org.svg new file mode 100644 index 00000000..c9cb9436 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__coll__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +gridfire::screening::WeakScreeningModel + + +Node1 + + +gridfire::screening +::WeakScreeningModel + + + + + +Node2 + + +gridfire::screening +::ScreeningModel + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__inherit__graph.map b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__inherit__graph.map new file mode 100644 index 00000000..1fdaabd1 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__inherit__graph.md5 b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__inherit__graph.md5 new file mode 100644 index 00000000..75d53a8b --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__inherit__graph.md5 @@ -0,0 +1 @@ +167b7454a7d46b229692007b971c8b79 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__inherit__graph.svg b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__inherit__graph.svg new file mode 100644 index 00000000..e5d75183 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__inherit__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +gridfire::screening::WeakScreeningModel + + +Node1 + + +gridfire::screening +::WeakScreeningModel + + + + + +Node2 + + +gridfire::screening +::ScreeningModel + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__inherit__graph_org.svg b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__inherit__graph_org.svg new file mode 100644 index 00000000..c9cb9436 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1WeakScreeningModel__inherit__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +gridfire::screening::WeakScreeningModel + + +Node1 + + +gridfire::screening +::WeakScreeningModel + + + + + +Node2 + + +gridfire::screening +::ScreeningModel + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy-members.html b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy-members.html new file mode 100644 index 00000000..12e7d4d4 --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy-members.html @@ -0,0 +1,152 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::solver::CVODESolverStrategy Member List
+
+
+ +

This is the complete list of members for gridfire::solver::CVODESolverStrategy, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
calculate_rhs(sunrealtype t, N_Vector y, N_Vector ydot, const CVODEUserData *data) constgridfire::solver::CVODESolverStrategyprivate
cleanup_cvode_resources(bool memFree)gridfire::solver::CVODESolverStrategyprivate
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::CVODESolverStrategyprivatestatic
cvode_rhs_wrapper(sunrealtype t, N_Vector y, N_Vector ydot, void *user_data)gridfire::solver::CVODESolverStrategyprivatestatic
CVODESolverStrategy(engine::DynamicEngine &engine)gridfire::solver::CVODESolverStrategyexplicit
CVODESolverStrategy(const CVODESolverStrategy &)=deletegridfire::solver::CVODESolverStrategy
CVODESolverStrategy(CVODESolverStrategy &&)=deletegridfire::solver::CVODESolverStrategy
describe_callback_context() const overridegridfire::solver::CVODESolverStrategyvirtual
evaluate(const NetIn &netIn) overridegridfire::solver::CVODESolverStrategyvirtual
evaluate(const NetIn &netIn, bool displayTrigger)gridfire::solver::CVODESolverStrategy
get_absTol() constgridfire::solver::CVODESolverStrategy
get_relTol() constgridfire::solver::CVODESolverStrategy
get_stdout_logging_enabled() constgridfire::solver::CVODESolverStrategy
initialize_cvode_integration_resources(uint64_t N, size_t numSpecies, double current_time, const fourdst::composition::Composition &composition, double absTol, double relTol, double accumulatedEnergy)gridfire::solver::CVODESolverStrategyprivate
log_step_diagnostics(const CVODEUserData &user_data, bool displayJacobianStiffness, bool displaySpeciesBalance, bool to_file, std::optional< std::string > filename) constgridfire::solver::CVODESolverStrategyprivate
m_absTolgridfire::solver::CVODESolverStrategyprivate
m_callbackgridfire::solver::CVODESolverStrategyprivate
m_configgridfire::solver::CVODESolverStrategyprivate
m_constraintsgridfire::solver::CVODESolverStrategyprivate
m_cvode_memgridfire::solver::CVODESolverStrategyprivate
m_detailed_step_logginggridfire::solver::CVODESolverStrategyprivate
m_enginegridfire::solver::NetworkSolverStrategy< EngineT >protected
m_Jgridfire::solver::CVODESolverStrategyprivate
m_loggergridfire::solver::CVODESolverStrategyprivate
m_LSgridfire::solver::CVODESolverStrategyprivate
m_num_stepsgridfire::solver::CVODESolverStrategyprivate
m_relTolgridfire::solver::CVODESolverStrategyprivate
m_stdout_logging_enabledgridfire::solver::CVODESolverStrategyprivate
m_sun_ctxgridfire::solver::CVODESolverStrategyprivate
m_Ygridfire::solver::CVODESolverStrategyprivate
m_YErrgridfire::solver::CVODESolverStrategyprivate
NetworkSolverStrategy(EngineT &engine)gridfire::solver::NetworkSolverStrategy< EngineT >inlineexplicit
operator=(const CVODESolverStrategy &)=deletegridfire::solver::CVODESolverStrategy
operator=(CVODESolverStrategy &&)=deletegridfire::solver::CVODESolverStrategy
set_absTol(double absTol)gridfire::solver::CVODESolverStrategy
set_callback(const std::any &callback) overridegridfire::solver::CVODESolverStrategyvirtual
set_detailed_step_logging(bool enabled)gridfire::solver::CVODESolverStrategyprivate
set_relTol(double relTol)gridfire::solver::CVODESolverStrategy
set_stdout_logging_enabled(bool logging_enabled)gridfire::solver::CVODESolverStrategy
TimestepCallback typedefgridfire::solver::CVODESolverStrategy
~CVODESolverStrategy() overridegridfire::solver::CVODESolverStrategy
~NetworkSolverStrategy()=defaultgridfire::solver::NetworkSolverStrategy< EngineT >virtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy.html b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy.html new file mode 100644 index 00000000..14c391d5 --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy.html @@ -0,0 +1,1504 @@ + + + + + + + +GridFire: gridfire::solver::CVODESolverStrategy Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Classes | +Public Types | +Public Member Functions | +Private Member Functions | +Static Private Member Functions | +Private Attributes | +List of all members
+
gridfire::solver::CVODESolverStrategy Class Referencefinal
+
+
+ +

Stiff ODE integrator backed by SUNDIALS CVODE (BDF) for network + energy. + More...

+ +

#include <CVODE_solver_strategy.h>

+
+Inheritance diagram for gridfire::solver::CVODESolverStrategy:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::solver::CVODESolverStrategy:
+
+
+
[legend]
+ + + + + + + + + + +

+Classes

struct  CVODERHSOutputData
 
struct  CVODEUserData
 A helper struct to pass C++ context to C-style CVODE callbacks. More...
 
struct  TimestepContext
 Immutable view of the current integration state passed to callbacks. More...
 
+ + + + +

+Public Types

using TimestepCallback = std::function< void(const TimestepContext &context)>
 Type alias for a timestep callback function.
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 CVODESolverStrategy (engine::DynamicEngine &engine)
 Construct the CVODE strategy and create a SUNDIALS context.
 
 ~CVODESolverStrategy () override
 Destructor: cleans CVODE/SUNDIALS resources and frees SUNContext.
 
 CVODESolverStrategy (const CVODESolverStrategy &)=delete
 
CVODESolverStrategy & operator= (const CVODESolverStrategy &)=delete
 
 CVODESolverStrategy (CVODESolverStrategy &&)=delete
 
CVODESolverStrategy & operator= (CVODESolverStrategy &&)=delete
 
NetOut evaluate (const NetIn &netIn) override
 Integrate from t=0 to netIn.tMax and return final composition and energy.
 
NetOut evaluate (const NetIn &netIn, bool displayTrigger)
 Call to evaluate which will let the user control if the trigger reasoning is displayed.
 
void set_callback (const std::any &callback) override
 Install a timestep callback.
 
bool get_stdout_logging_enabled () const
 Whether per-step logs are printed to stdout and CVode is stepped with CV_ONE_STEP.
 
void set_stdout_logging_enabled (bool logging_enabled)
 Enable/disable per-step stdout logging.
 
void set_absTol (double absTol)
 
void set_relTol (double relTol)
 
double get_absTol () const
 
double get_relTol () const
 
std::vector< std::tuple< std::string, std::string > > describe_callback_context () const override
 Schema of fields exposed to the timestep callback context.
 
- Public Member Functions inherited from gridfire::solver::NetworkSolverStrategy< EngineT >
 NetworkSolverStrategy (EngineT &engine)
 Constructor for the NetworkSolverStrategy.
 
virtual ~NetworkSolverStrategy ()=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 (uint64_t N, size_t numSpecies, double current_time, const fourdst::composition::Composition &composition, double absTol, double relTol, double accumulatedEnergy)
 Allocate and initialize CVODE vectors, linear algebra, tolerances, and constraints.
 
void cleanup_cvode_resources (bool memFree)
 Destroy CVODE vectors/linear algebra and optionally the CVODE memory block.
 
void set_detailed_step_logging (bool enabled)
 
void log_step_diagnostics (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.
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Private Attributes

fourdst::config::Config & m_config = fourdst::config::Config::getInstance()
 
quill::Logger * m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
 
SUNContext m_sun_ctx = nullptr
 SUNDIALS context (lifetime of the solver).
 
void * m_cvode_mem = nullptr
 CVODE memory block.
 
N_Vector m_Y = nullptr
 CVODE state vector (species + energy accumulator).
 
N_Vector m_YErr = nullptr
 Estimated local errors.
 
SUNMatrix m_J = nullptr
 Dense Jacobian matrix.
 
SUNLinearSolver m_LS = nullptr
 Dense linear solver.
 
std::optional< TimestepCallback > m_callback
 Optional per-step callback.
 
int m_num_steps = 0
 CVODE step counter (used for diagnostics and triggers).
 
bool m_stdout_logging_enabled = true
 If true, print per-step logs and use CV_ONE_STEP.
 
N_Vector m_constraints = nullptr
 CVODE constraints vector (>= 0 for species entries).
 
std::optional< double > m_absTol
 User-specified absolute tolerance.
 
std::optional< double > m_relTol
 User-specified relative tolerance.
 
bool m_detailed_step_logging = false
 If true, log detailed step diagnostics (error ratios, Jacobian, species balance).
 
+ + + + + +

+Additional Inherited Members

- Protected Attributes inherited from gridfire::solver::NetworkSolverStrategy< EngineT >
EngineT & m_engine
 The engine used by this solver strategy.
 
+

Detailed Description

+

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:

    +
  • Creates a SUNContext and CVODE memory; initializes the state from a Composition.
    • +
  • Enforces non-negativity on species via CVodeSetConstraints (>= 0 for all species slots).
    • +
  • Uses a user-provided DynamicEngine to compute RHS and to fill the dense Jacobian.
    • +
  • The Jacobian is assembled column-major into a SUNDenseMatrix; the energy row/column is currently set to zero (decoupled from abundances in the linearization).
    • +
  • An internal trigger can rebuild the engine/network; when triggered, CVODE resources are torn down and recreated with the new network size, preserving the energy accumulator.
    • +
  • The CVODE RHS wrapper captures exceptions::StaleEngineTrigger from the engine evaluation path as recoverable (return code 1) and stores a copy in user-data for the driver loop.
    • +
+
Example
using gridfire::solver::CVODESolverStrategy;
+
using gridfire::solver::NetIn;
+
+
CVODESolverStrategy solver(engine);
+
NetIn in;
+
in.temperature = 1.0e9; // K
+
in.density = 1.0e6; // g/cm^3
+
in.tMax = 1.0; // s
+
in.composition = initialComposition;
+
auto out = solver.evaluate(in);
+
std::cout << "Final energy: " << out.energy << " erg/g\n";
+
gridfire::solver::CVODESolverStrategy
Stiff ODE integrator backed by SUNDIALS CVODE (BDF) for network + energy.
Definition CVODE_solver_strategy.h:81
+
gridfire::NetIn
Definition types.h:27
+
gridfire::NetIn::density
double density
Density in g/cm^3.
Definition types.h:32
+
gridfire::NetIn::tMax
double tMax
Maximum time.
Definition types.h:29
+
gridfire::NetIn::composition
fourdst::composition::Composition composition
Composition of the network.
Definition types.h:28
+
gridfire::NetIn::temperature
double temperature
Temperature in Kelvin.
Definition types.h:31
+
+

Member Typedef Documentation

+ +

◆ TimestepCallback

+ +
+
+ + + + +
using gridfire::solver::CVODESolverStrategy::TimestepCallback = std::function<void(const TimestepContext& context)>
+
+ +

Type alias for a timestep callback function.

+ +
+
+

Constructor & Destructor Documentation

+ +

◆ CVODESolverStrategy() [1/3]

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::solver::CVODESolverStrategy::CVODESolverStrategy (engine::DynamicEngine & engine)
+ 		+explicit
+
+ +

Construct the CVODE strategy and create a SUNDIALS context.

+
Parameters
+ + +
engineDynamicEngine used for RHS/Jacobian evaluation and network access.
+
+
+
Exceptions
+ + +
std::runtime_errorIf SUNContext_Create fails.
+
+
+ +
+
+ +

◆ ~CVODESolverStrategy()

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::solver::CVODESolverStrategy::~CVODESolverStrategy ()
+ 		+override
+
+ +

Destructor: cleans CVODE/SUNDIALS resources and frees SUNContext.

+ +
+
+ +

◆ CVODESolverStrategy() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::solver::CVODESolverStrategy::CVODESolverStrategy (const CVODESolverStrategy & )
+ 		+delete
+
+ +
+
+ +

◆ CVODESolverStrategy() [3/3]

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::solver::CVODESolverStrategy::CVODESolverStrategy (CVODESolverStrategy && )
+ 		+delete
+
+ +
+
+

Member Function Documentation

+ +

◆ calculate_rhs()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CVODESolverStrategy::CVODERHSOutputData gridfire::solver::CVODESolverStrategy::calculate_rhs (sunrealtype t,
N_Vector y,
N_Vector ydot,
const CVODEUserData * data 
) const
+ 		+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.

+ +
+
+ +

◆ cleanup_cvode_resources()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::solver::CVODESolverStrategy::cleanup_cvode_resources (bool memFree)
+ 		+private
+
+ +

Destroy CVODE vectors/linear algebra and optionally the CVODE memory block.

+
Parameters
+ + +
memFreeIf true, also calls CVodeFree on m_cvode_mem.
+
+
+ +
+
+ +

◆ cvode_jac_wrapper()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int gridfire::solver::CVODESolverStrategy::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 
)
+ 		+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.

+ +
+
+ +

◆ cvode_rhs_wrapper()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int gridfire::solver::CVODESolverStrategy::cvode_rhs_wrapper (sunrealtype t,
N_Vector y,
N_Vector ydot,
void * user_data 
)
+ 		+staticprivate
+
+ +

CVODE RHS C-wrapper that delegates to calculate_rhs and captures exceptions.

+
Returns
0 on success; 1 on recoverable StaleEngineTrigger; -1 on other failures.
+ +
+
+ +

◆ describe_callback_context()

+ +
+
+ + + + + +
+ + + + + + + +
std::vector< std::tuple< std::string, std::string > > gridfire::solver::CVODESolverStrategy::describe_callback_context () const
+ 		+overridevirtual
+
+ +

Schema of fields exposed to the timestep callback context.

+ +

Implements gridfire::solver::NetworkSolverStrategy< EngineT >.

+ +
+
+ +

◆ evaluate() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + +
NetOut gridfire::solver::CVODESolverStrategy::evaluate (const NetIn & netIn)
+ 		+overridevirtual
+
+ +

Integrate from t=0 to netIn.tMax and return final composition and energy.

+

Implementation summary:

    +
  • Converts temperature to T9, initializes CVODE memory and state (size = numSpecies + 1).
    • +
  • Repeatedly calls CVode in single-step or normal mode depending on stdout logging.
    • +
  • Wraps RHS to capture exceptions::StaleEngineTrigger as a recoverable step failure; if present after a step, it is rethrown for upstream handling.
    • +
  • Prints/collects diagnostics per step (step size, energy, solver iterations).
    • +
  • On trigger activation, rebuilds CVODE resources to reflect a changed network and reinitialized the state using the latest engine composition, preserving energy.
    • +
  • At the end, converts molar abundances to mass fractions and assembles NetOut, including derivatives of energy w.r.t. T and rho from the engine.
    • +
+
Parameters
+ + +
netInInputs: temperature [K], density [g cm^-3], tMax [s], composition.
+
+
+
Returns
NetOut containing final Composition, accumulated energy [erg/g], step count, and dEps/dT, dEps/dRho.
+
Exceptions
+ + + +
std::runtime_errorIf any CVODE or SUNDIALS call fails (negative return codes), or if internal consistency checks fail during engine updates.
exceptions::StaleEngineTriggerPropagated if the engine signals a stale state during RHS evaluation (captured in the wrapper then rethrown here).
+
+
+ +

Implements gridfire::solver::NetworkSolverStrategy< EngineT >.

+ +
+
+ +

◆ evaluate() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
NetOut gridfire::solver::CVODESolverStrategy::evaluate (const NetIn & netIn,
bool displayTrigger 
)
+
+ +

Call to evaluate which will let the user control if the trigger reasoning is displayed.

+
Parameters
+ + + +
netInInputs: temperature [K], density [g cm^-3], tMax [s], composition.
displayTriggerBoolean flag to control if trigger reasoning is displayed
+
+
+
Returns
NetOut containing final Composition, accumulated energy [erg/g], step count, and dEps/dT, dEps/dRho.
+
Exceptions
+ + + +
std::runtime_errorIf any CVODE or SUNDIALS call fails (negative return codes), or if internal consistency checks fail during engine updates.
exceptions::StaleEngineTriggerPropagated if the engine signals a stale state during RHS evaluation (captured in the wrapper then rethrown here).
+
+
+ +
+
+ +

◆ get_absTol()

+ +
+
+ + + + + + + +
double gridfire::solver::CVODESolverStrategy::get_absTol () const
+
+ +
+
+ +

◆ get_relTol()

+ +
+
+ + + + + + + +
double gridfire::solver::CVODESolverStrategy::get_relTol () const
+
+ +
+
+ +

◆ get_stdout_logging_enabled()

+ +
+
+ + + + + + + +
bool gridfire::solver::CVODESolverStrategy::get_stdout_logging_enabled () const
+
+ +

Whether per-step logs are printed to stdout and CVode is stepped with CV_ONE_STEP.

+ +
+
+ +

◆ initialize_cvode_integration_resources()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void gridfire::solver::CVODESolverStrategy::initialize_cvode_integration_resources (uint64_t N,
size_t numSpecies,
double current_time,
const fourdst::composition::Composition & composition,
double absTol,
double relTol,
double accumulatedEnergy 
)
+ 		+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.

+ +
+
+ +

◆ log_step_diagnostics()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void gridfire::solver::CVODESolverStrategy::log_step_diagnostics (const CVODEUserData & user_data,
bool displayJacobianStiffness,
bool displaySpeciesBalance,
bool to_file,
std::optional< std::string > filename 
) const
+ 		+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.

+ +
+
+ +

◆ operator=() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + +
CVODESolverStrategy & gridfire::solver::CVODESolverStrategy::operator= (const CVODESolverStrategy & )
+ 		+delete
+
+ +
+
+ +

◆ operator=() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
CVODESolverStrategy & gridfire::solver::CVODESolverStrategy::operator= (CVODESolverStrategy && )
+ 		+delete
+
+ +
+
+ +

◆ set_absTol()

+ +
+
+ + + + + + + + +
void gridfire::solver::CVODESolverStrategy::set_absTol (double absTol)
+
+ +
+
+ +

◆ set_callback()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::solver::CVODESolverStrategy::set_callback (const std::any & callback)
+ 		+overridevirtual
+
+ +

Install a timestep callback.

+
Parameters
+ + +
callbackstd::any containing TimestepCallback (std::function<void(const TimestepContext&)>).
+
+
+
Exceptions
+ + +
std::bad_any_castIf callback is not of the expected type.
+
+
+ +

Implements gridfire::solver::NetworkSolverStrategy< EngineT >.

+ +
+
+ +

◆ set_detailed_step_logging()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::solver::CVODESolverStrategy::set_detailed_step_logging (bool enabled)
+ 		+private
+
+ +
+
+ +

◆ set_relTol()

+ +
+
+ + + + + + + + +
void gridfire::solver::CVODESolverStrategy::set_relTol (double relTol)
+
+ +
+
+ +

◆ set_stdout_logging_enabled()

+ +
+
+ + + + + + + + +
void gridfire::solver::CVODESolverStrategy::set_stdout_logging_enabled (bool logging_enabled)
+
+ +

Enable/disable per-step stdout logging.

+
Parameters
+ + +
logging_enabledFlag to control if a timestep summary is written to standard output or not
+
+
+ +
+
+

Member Data Documentation

+ +

◆ m_absTol

+ +
+
+ + + + + +
+ + + + +
std::optional<double> gridfire::solver::CVODESolverStrategy::m_absTol
+ 		+private
+
+ +

User-specified absolute tolerance.

+ +
+
+ +

◆ m_callback

+ +
+
+ + + + + +
+ + + + +
std::optional<TimestepCallback> gridfire::solver::CVODESolverStrategy::m_callback
+ 		+private
+
+ +

Optional per-step callback.

+ +
+
+ +

◆ m_config

+ +
+
+ + + + + +
+ + + + +
fourdst::config::Config& gridfire::solver::CVODESolverStrategy::m_config = fourdst::config::Config::getInstance()
+ 		+private
+
+ +
+
+ +

◆ m_constraints

+ +
+
+ + + + + +
+ + + + +
N_Vector gridfire::solver::CVODESolverStrategy::m_constraints = nullptr
+ 		+private
+
+ +

CVODE constraints vector (>= 0 for species entries).

+ +
+
+ +

◆ m_cvode_mem

+ +
+
+ + + + + +
+ + + + +
void* gridfire::solver::CVODESolverStrategy::m_cvode_mem = nullptr
+ 		+private
+
+ +

CVODE memory block.

+ +
+
+ +

◆ m_detailed_step_logging

+ +
+
+ + + + + +
+ + + + +
bool gridfire::solver::CVODESolverStrategy::m_detailed_step_logging = false
+ 		+private
+
+ +

If true, log detailed step diagnostics (error ratios, Jacobian, species balance).

+ +
+
+ +

◆ m_J

+ +
+
+ + + + + +
+ + + + +
SUNMatrix gridfire::solver::CVODESolverStrategy::m_J = nullptr
+ 		+private
+
+ +

Dense Jacobian matrix.

+ +
+
+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::solver::CVODESolverStrategy::m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +
+
+ +

◆ m_LS

+ +
+
+ + + + + +
+ + + + +
SUNLinearSolver gridfire::solver::CVODESolverStrategy::m_LS = nullptr
+ 		+private
+
+ +

Dense linear solver.

+ +
+
+ +

◆ m_num_steps

+ +
+
+ + + + + +
+ + + + +
int gridfire::solver::CVODESolverStrategy::m_num_steps = 0
+ 		+private
+
+ +

CVODE step counter (used for diagnostics and triggers).

+ +
+
+ +

◆ m_relTol

+ +
+
+ + + + + +
+ + + + +
std::optional<double> gridfire::solver::CVODESolverStrategy::m_relTol
+ 		+private
+
+ +

User-specified relative tolerance.

+ +
+
+ +

◆ m_stdout_logging_enabled

+ +
+
+ + + + + +
+ + + + +
bool gridfire::solver::CVODESolverStrategy::m_stdout_logging_enabled = true
+ 		+private
+
+ +

If true, print per-step logs and use CV_ONE_STEP.

+ +
+
+ +

◆ m_sun_ctx

+ +
+
+ + + + + +
+ + + + +
SUNContext gridfire::solver::CVODESolverStrategy::m_sun_ctx = nullptr
+ 		+private
+
+ +

SUNDIALS context (lifetime of the solver).

+ +
+
+ +

◆ m_Y

+ +
+
+ + + + + +
+ + + + +
N_Vector gridfire::solver::CVODESolverStrategy::m_Y = nullptr
+ 		+private
+
+ +

CVODE state vector (species + energy accumulator).

+ +
+
+ +

◆ m_YErr

+ +
+
+ + + + + +
+ + + + +
N_Vector gridfire::solver::CVODESolverStrategy::m_YErr = nullptr
+ 		+private
+
+ +

Estimated local errors.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy.js b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy.js new file mode 100644 index 00000000..a172038b --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy.js @@ -0,0 +1,45 @@ +var classgridfire_1_1solver_1_1CVODESolverStrategy = +[ + [ "CVODERHSOutputData", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData.html", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData" ], + [ "CVODEUserData", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData" ], + [ "TimestepContext", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext" ], + [ "TimestepCallback", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a89c537c2f34ba3e202374304b7e5990a", null ], + [ "CVODESolverStrategy", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a8beeb102d8e459cd133cd1bd5fb7e135", null ], + [ "~CVODESolverStrategy", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#aca2d01a907c3bb828f9f99ad05506578", null ], + [ "CVODESolverStrategy", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a2fa56a2e7a63d31d2afa895a5e4fe827", null ], + [ "CVODESolverStrategy", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a1f007d68e808ba61f8425d0487432c0d", null ], + [ "calculate_rhs", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a460c2d19b468769770ec14e52684c0c8", null ], + [ "cleanup_cvode_resources", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a7f6786780137de1a136e081c537a9667", null ], + [ "cvode_jac_wrapper", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#ae13fc9c21f595edbee1c9b7debaa61b3", null ], + [ "cvode_rhs_wrapper", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a14c620ef75749c8ef3dfdb84132e5620", null ], + [ "describe_callback_context", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a5dfb7a2ce0008d41dee4aa596a4e1ce4", null ], + [ "evaluate", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#ab8224d205ea3a28d9c723631c2f00b53", null ], + [ "evaluate", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a167e44c002243314aa58c84715490804", null ], + [ "get_absTol", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#ae98bbc854c88cf4aecf93a9204958a4c", null ], + [ "get_relTol", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a103273e838ea10f71a11705046f1f951", null ], + [ "get_stdout_logging_enabled", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a87b7b39e2a15cc30b118c8e6fda9a1a6", null ], + [ "initialize_cvode_integration_resources", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#afc6c55237df4af240c4c842305085d91", null ], + [ "log_step_diagnostics", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a351744e5fcb06ddaf8507358481cfb1e", null ], + [ "operator=", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#af500df838024c82724eaf7fe1cb9b8e8", null ], + [ "operator=", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#ad26879fafcee9ecb21cc7c5ac0db1692", null ], + [ "set_absTol", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#aed8907852f77c15bb40d5a8e8f8af9b2", null ], + [ "set_callback", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a77638ef3d2279009e5a57bbd3f0eb63b", null ], + [ "set_detailed_step_logging", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a91966d110ca6225af60b633af5521cb4", null ], + [ "set_relTol", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a6444290be523ad9fa91fa57c1dd4b6a2", null ], + [ "set_stdout_logging_enabled", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a9857665a1198e24aac6add02afc6e306", null ], + [ "m_absTol", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a421360b9908ea3e1d7c60a3fb51a2f75", null ], + [ "m_callback", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#aa8fb7a0b39e6bb7b97a4a98422f06482", null ], + [ "m_config", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a202fe9e6499aac5f6813e036ee4ed2d5", null ], + [ "m_constraints", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a50d8f309ca897fa83b16db0a1701b339", null ], + [ "m_cvode_mem", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#ab5a8fa55e36685cac50c1dbdd8dbfa57", null ], + [ "m_detailed_step_logging", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a6aed67c333c914551aee9b88fa0af584", null ], + [ "m_J", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#afd1053d0827512b6831ee15f14488c20", null ], + [ "m_logger", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a5867eb99b00815b8b4f710cb48904dbe", null ], + [ "m_LS", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#af4a2f003a4c4c06b4b72840f2d445f81", null ], + [ "m_num_steps", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#ab7495898e893640670f49308a105658f", null ], + [ "m_relTol", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a4f482b5e68023df9b7522b29dc79c764", null ], + [ "m_stdout_logging_enabled", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#af3e470b5a6f982c107785c64b169a992", null ], + [ "m_sun_ctx", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#ac57a4f62d95d769c379470e680e6882d", null ], + [ "m_Y", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#aae19c1ec467051404a7bf1d4c7066c22", null ], + [ "m_YErr", "classgridfire_1_1solver_1_1CVODESolverStrategy.html#a0717afcde6fdb71b12490bbcadb5fdb4", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__coll__graph.map b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__coll__graph.map new file mode 100644 index 00000000..b47c4c7d --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__coll__graph.md5 b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__coll__graph.md5 new file mode 100644 index 00000000..6e734e5d --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__coll__graph.md5 @@ -0,0 +1 @@ +30b8d222f899385cf91f6034e17f880b \ No newline at end of file diff --git a/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__coll__graph.svg b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__coll__graph.svg new file mode 100644 index 00000000..50ba7554 --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__coll__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +gridfire::solver::CVODESolverStrategy + + +Node1 + + +gridfire::solver::CVODESolver +Strategy + + + + + +Node2 + + +DynamicNetworkSolverStrategy + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__coll__graph_org.svg b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__coll__graph_org.svg new file mode 100644 index 00000000..3570c406 --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__coll__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +gridfire::solver::CVODESolverStrategy + + +Node1 + + +gridfire::solver::CVODESolver +Strategy + + + + + +Node2 + + +DynamicNetworkSolverStrategy + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__inherit__graph.map b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__inherit__graph.map new file mode 100644 index 00000000..b47c4c7d --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__inherit__graph.md5 b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__inherit__graph.md5 new file mode 100644 index 00000000..6e734e5d --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__inherit__graph.md5 @@ -0,0 +1 @@ +30b8d222f899385cf91f6034e17f880b \ No newline at end of file diff --git a/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__inherit__graph.svg b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__inherit__graph.svg new file mode 100644 index 00000000..50ba7554 --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__inherit__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +gridfire::solver::CVODESolverStrategy + + +Node1 + + +gridfire::solver::CVODESolver +Strategy + + + + + +Node2 + + +DynamicNetworkSolverStrategy + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__inherit__graph_org.svg b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__inherit__graph_org.svg new file mode 100644 index 00000000..3570c406 --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1CVODESolverStrategy__inherit__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +gridfire::solver::CVODESolverStrategy + + +Node1 + + +gridfire::solver::CVODESolver +Strategy + + + + + +Node2 + + +DynamicNetworkSolverStrategy + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy-members.html b/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy-members.html new file mode 100644 index 00000000..00e21f73 --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy-members.html @@ -0,0 +1,116 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::solver::NetworkSolverStrategy< EngineT > Member List
+
+
+ +

This is the complete list of members for gridfire::solver::NetworkSolverStrategy< EngineT >, including all inherited members.

+ + + + + + + +
describe_callback_context() const =0gridfire::solver::NetworkSolverStrategy< EngineT >pure virtual
evaluate(const NetIn &netIn)=0gridfire::solver::NetworkSolverStrategy< EngineT >pure virtual
m_enginegridfire::solver::NetworkSolverStrategy< EngineT >protected
NetworkSolverStrategy(EngineT &engine)gridfire::solver::NetworkSolverStrategy< EngineT >inlineexplicit
set_callback(const std::any &callback)=0gridfire::solver::NetworkSolverStrategy< EngineT >pure virtual
~NetworkSolverStrategy()=defaultgridfire::solver::NetworkSolverStrategy< EngineT >virtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy.html b/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy.html new file mode 100644 index 00000000..06533f6a --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy.html @@ -0,0 +1,365 @@ + + + + + + + +GridFire: gridfire::solver::NetworkSolverStrategy< EngineT > Class Template Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Protected Attributes | +List of all members
+
gridfire::solver::NetworkSolverStrategy< EngineT > Class Template Referenceabstract
+
+
+ +

Abstract base class for network solver strategies. + More...

+ +

#include <strategy_abstract.h>

+
+Inheritance diagram for gridfire::solver::NetworkSolverStrategy< EngineT >:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + +

+Public Member Functions

 NetworkSolverStrategy (EngineT &engine)
 Constructor for the NetworkSolverStrategy.
 
virtual ~NetworkSolverStrategy ()=default
 Virtual destructor.
 
virtual NetOut evaluate (const NetIn &netIn)=0
 Evaluates the network for a given timestep.
 
virtual void set_callback (const std::any &callback)=0
 set the callback function to be called at the end of each timestep.
 
virtual std::vector< std::tuple< std::string, std::string > > describe_callback_context () const =0
 Describe the context that will be passed to the callback function.
 
+ + + + +

+Protected Attributes

EngineT & m_engine
 The engine used by this solver strategy.
 
+

Detailed Description

+
template<typename EngineT>
+class gridfire::solver::NetworkSolverStrategy< EngineT >

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.

+
Template Parameters
+ + +
EngineTThe type of engine to use with this solver strategy. Must inherit from Engine.
+
+
+

Constructor & Destructor Documentation

+ +

◆ NetworkSolverStrategy()

+ +
+
+
+template<typename EngineT >
+ + + + + +
+ + + + + + + + +
gridfire::solver::NetworkSolverStrategy< EngineT >::NetworkSolverStrategy (EngineT & engine)
+ 		+inlineexplicit
+
+ +

Constructor for the NetworkSolverStrategy.

+
Parameters
+ + +
engineThe engine to use for evaluating the network.
+
+
+ +
+
+ +

◆ ~NetworkSolverStrategy()

+ +
+
+
+template<typename EngineT >
+ + + + + +
+ + + + + + + +
virtual gridfire::solver::NetworkSolverStrategy< EngineT >::~NetworkSolverStrategy ()
+ 		+virtualdefault
+
+ +

Virtual destructor.

+ +
+
+

Member Function Documentation

+ +

◆ describe_callback_context()

+ +
+
+
+template<typename EngineT >
+ + + + + +
+ + + + + + + +
virtual std::vector< std::tuple< std::string, std::string > > gridfire::solver::NetworkSolverStrategy< EngineT >::describe_callback_context () const
+ 		+pure virtual
+
+ +

Describe the context that will be passed to the callback function.

+
Returns
A vector of tuples, each containing a string for the parameter's name and a string for its type.
+

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::CVODESolverStrategy, and PyDynamicNetworkSolverStrategy.

+ +
+
+ +

◆ evaluate()

+ +
+
+
+template<typename EngineT >
+ + + + + +
+ + + + + + + + +
virtual NetOut gridfire::solver::NetworkSolverStrategy< EngineT >::evaluate (const NetIn & netIn)
+ 		+pure virtual
+
+ +

Evaluates the network for a given timestep.

+
Parameters
+ + +
netInThe input conditions for the network.
+
+
+
Returns
The output conditions after the timestep.
+ +

Implemented in PyDynamicNetworkSolverStrategy, and gridfire::solver::CVODESolverStrategy.

+ +
+
+ +

◆ set_callback()

+ +
+
+
+template<typename EngineT >
+ + + + + +
+ + + + + + + + +
virtual void gridfire::solver::NetworkSolverStrategy< EngineT >::set_callback (const std::any & callback)
+ 		+pure virtual
+
+ +

set the callback function to be called at the end of each timestep.

+

This function allows the user to set a callback function that will be called at the end of each timestep. The callback function will receive a gridfire::solver::<SOMESOLVER>::TimestepContext object. Note that depending on the solver, this context may contain different information. Further, the exact signature of the callback function is left up to each solver. Every solver should provide a type or type alias TimestepCallback that defines the signature of the callback function so that the user can easily get that type information.

+
Parameters
+ + +
callbackThe callback function to be called at the end of each timestep.
+
+
+ +

Implemented in gridfire::solver::CVODESolverStrategy, and PyDynamicNetworkSolverStrategy.

+ +
+
+

Member Data Documentation

+ +

◆ m_engine

+ +
+
+
+template<typename EngineT >
+ + + + + +
+ + + + +
EngineT& gridfire::solver::NetworkSolverStrategy< EngineT >::m_engine
+ 		+protected
+
+ +

The engine used by this solver strategy.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy.js b/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy.js new file mode 100644 index 00000000..a15e205f --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy.js @@ -0,0 +1,9 @@ +var classgridfire_1_1solver_1_1NetworkSolverStrategy = +[ + [ "NetworkSolverStrategy", "classgridfire_1_1solver_1_1NetworkSolverStrategy.html#a01cbbec0eb5c3a60f50da38cdaf66505", null ], + [ "~NetworkSolverStrategy", "classgridfire_1_1solver_1_1NetworkSolverStrategy.html#a1693dc93f63599c89587d729aca8e318", null ], + [ "describe_callback_context", "classgridfire_1_1solver_1_1NetworkSolverStrategy.html#ae09169769774f17df8701c42a64ed656", null ], + [ "evaluate", "classgridfire_1_1solver_1_1NetworkSolverStrategy.html#ace539b0482db171845ff1bd38d76b70f", null ], + [ "set_callback", "classgridfire_1_1solver_1_1NetworkSolverStrategy.html#a4d97ee85933d5e5f90d4194bb021a1dc", null ], + [ "m_engine", "classgridfire_1_1solver_1_1NetworkSolverStrategy.html#a724924d94eaf82b67d9988a55c3261e8", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy__inherit__graph.map b/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy__inherit__graph.map new file mode 100644 index 00000000..ba336f01 --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy__inherit__graph.md5 b/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy__inherit__graph.md5 new file mode 100644 index 00000000..eda22ce3 --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy__inherit__graph.md5 @@ -0,0 +1 @@ +1c63993caee27cdf070f02caa67fa0ac \ No newline at end of file diff --git a/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy__inherit__graph.svg b/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy__inherit__graph.svg new file mode 100644 index 00000000..d27a22ef --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy__inherit__graph.svg @@ -0,0 +1,84 @@ + + + + + + + + + + + +gridfire::solver::NetworkSolverStrategy< EngineT > + + +Node1 + + +gridfire::solver::Network +SolverStrategy< EngineT > + + + + + +Node2 + + +PyDynamicNetworkSolverStrategy + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::solver::CVODESolver +Strategy + + + + + +Node1->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy__inherit__graph_org.svg b/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy__inherit__graph_org.svg new file mode 100644 index 00000000..798cf919 --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy__inherit__graph_org.svg @@ -0,0 +1,59 @@ + + + + + + +gridfire::solver::NetworkSolverStrategy< EngineT > + + +Node1 + + +gridfire::solver::Network +SolverStrategy< EngineT > + + + + + +Node2 + + +PyDynamicNetworkSolverStrategy + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::solver::CVODESolver +Strategy + + + + + +Node1->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1solver_1_1SolverContextBase-members.html b/docs/html/classgridfire_1_1solver_1_1SolverContextBase-members.html new file mode 100644 index 00000000..3a98928a --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1SolverContextBase-members.html @@ -0,0 +1,112 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::solver::SolverContextBase Member List
+
+
+ +

This is the complete list of members for gridfire::solver::SolverContextBase, including all inherited members.

+ + + +
describe() const =0gridfire::solver::SolverContextBasepure virtual
~SolverContextBase()=defaultgridfire::solver::SolverContextBasevirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1solver_1_1SolverContextBase.html b/docs/html/classgridfire_1_1solver_1_1SolverContextBase.html new file mode 100644 index 00000000..0a593342 --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1SolverContextBase.html @@ -0,0 +1,194 @@ + + + + + + + +GridFire: gridfire::solver::SolverContextBase Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::solver::SolverContextBase Struct Referenceabstract
+
+
+ +

Base class for solver callback contexts. + More...

+ +

#include <strategy_abstract.h>

+
+Inheritance diagram for gridfire::solver::SolverContextBase:
+
+
+
[legend]
+ + + + + + + +

+Public Member Functions

virtual ~SolverContextBase ()=default
 
virtual std::vector< std::tuple< std::string, std::string > > describe () const =0
 Describe the context for callback functions.
 
+

Detailed Description

+

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.

+

Constructor & Destructor Documentation

+ +

◆ ~SolverContextBase()

+ +
+
+ + + + + +
+ + + + + + + +
virtual gridfire::solver::SolverContextBase::~SolverContextBase ()
+ 		+virtualdefault
+
+ +
+
+

Member Function Documentation

+ +

◆ describe()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::vector< std::tuple< std::string, std::string > > gridfire::solver::SolverContextBase::describe () const
+ 		+pure virtual
+
+ +

Describe the context for callback functions.

+
Returns
A vector of tuples, each containing a string for the parameters name and a string for its type.
+

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::CVODESolverStrategy::TimestepContext, and PySolverContextBase.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1solver_1_1SolverContextBase.js b/docs/html/classgridfire_1_1solver_1_1SolverContextBase.js new file mode 100644 index 00000000..4b76519e --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1SolverContextBase.js @@ -0,0 +1,5 @@ +var classgridfire_1_1solver_1_1SolverContextBase = +[ + [ "~SolverContextBase", "classgridfire_1_1solver_1_1SolverContextBase.html#ab1abf9e5ff7f53a6cebe5e00ea5fc0c8", null ], + [ "describe", "classgridfire_1_1solver_1_1SolverContextBase.html#a9cbef3cabc8524e542613ee50d8860c6", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1solver_1_1SolverContextBase__inherit__graph.map b/docs/html/classgridfire_1_1solver_1_1SolverContextBase__inherit__graph.map new file mode 100644 index 00000000..2dd2f016 --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1SolverContextBase__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1solver_1_1SolverContextBase__inherit__graph.md5 b/docs/html/classgridfire_1_1solver_1_1SolverContextBase__inherit__graph.md5 new file mode 100644 index 00000000..58310b81 --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1SolverContextBase__inherit__graph.md5 @@ -0,0 +1 @@ +fa87f84bc5f44f33598cab6c579a14e1 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1solver_1_1SolverContextBase__inherit__graph.svg b/docs/html/classgridfire_1_1solver_1_1SolverContextBase__inherit__graph.svg new file mode 100644 index 00000000..e470ca6a --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1SolverContextBase__inherit__graph.svg @@ -0,0 +1,84 @@ + + + + + + + + + + + +gridfire::solver::SolverContextBase + + +Node1 + + +gridfire::solver::Solver +ContextBase + + + + + +Node2 + + +PySolverContextBase + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::solver::CVODESolver +Strategy::TimestepContext + + + + + +Node1->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1solver_1_1SolverContextBase__inherit__graph_org.svg b/docs/html/classgridfire_1_1solver_1_1SolverContextBase__inherit__graph_org.svg new file mode 100644 index 00000000..a362d642 --- /dev/null +++ b/docs/html/classgridfire_1_1solver_1_1SolverContextBase__inherit__graph_org.svg @@ -0,0 +1,59 @@ + + + + + + +gridfire::solver::SolverContextBase + + +Node1 + + +gridfire::solver::Solver +ContextBase + + + + + +Node2 + + +PySolverContextBase + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::solver::CVODESolver +Strategy::TimestepContext + + + + + +Node1->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1AndTrigger-members.html b/docs/html/classgridfire_1_1trigger_1_1AndTrigger-members.html new file mode 100644 index 00000000..72031433 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1AndTrigger-members.html @@ -0,0 +1,129 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::trigger::AndTrigger< TriggerContextStruct > Member List
+
+
+ +

This is the complete list of members for gridfire::trigger::AndTrigger< TriggerContextStruct >, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + +
AndTrigger(std::unique_ptr< Trigger< TriggerContextStruct > > A, std::unique_ptr< Trigger< TriggerContextStruct > > B)gridfire::trigger::AndTrigger< TriggerContextStruct >
check(const TriggerContextStruct &ctx) const overridegridfire::trigger::AndTrigger< TriggerContextStruct >virtual
describe() const overridegridfire::trigger::AndTrigger< TriggerContextStruct >virtual
m_Agridfire::trigger::AndTrigger< TriggerContextStruct >private
m_Bgridfire::trigger::AndTrigger< TriggerContextStruct >private
m_hitsgridfire::trigger::AndTrigger< TriggerContextStruct >mutableprivate
m_missesgridfire::trigger::AndTrigger< TriggerContextStruct >mutableprivate
m_resetsgridfire::trigger::AndTrigger< TriggerContextStruct >mutableprivate
m_stepsgridfire::trigger::AndTrigger< TriggerContextStruct >mutableprivate
m_updatesgridfire::trigger::AndTrigger< TriggerContextStruct >mutableprivate
name() const overridegridfire::trigger::AndTrigger< TriggerContextStruct >virtual
numMisses() const overridegridfire::trigger::AndTrigger< TriggerContextStruct >virtual
numTriggers() const overridegridfire::trigger::AndTrigger< TriggerContextStruct >virtual
reset() overridegridfire::trigger::AndTrigger< TriggerContextStruct >virtual
step(const TriggerContextStruct &ctx) overridegridfire::trigger::AndTrigger< TriggerContextStruct >virtual
update(const TriggerContextStruct &ctx) overridegridfire::trigger::AndTrigger< TriggerContextStruct >virtual
why(const TriggerContextStruct &ctx) const overridegridfire::trigger::AndTrigger< TriggerContextStruct >virtual
~AndTrigger() override=defaultgridfire::trigger::AndTrigger< TriggerContextStruct >
~Trigger()=defaultgridfire::trigger::Trigger< TriggerContextStruct >virtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1AndTrigger.html b/docs/html/classgridfire_1_1trigger_1_1AndTrigger.html new file mode 100644 index 00000000..89080232 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1AndTrigger.html @@ -0,0 +1,715 @@ + + + + + + + +GridFire: gridfire::trigger::AndTrigger< TriggerContextStruct > Class Template Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
gridfire::trigger::AndTrigger< TriggerContextStruct > Class Template Referencefinal
+
+
+ +

Logical conjunction of two triggers with short-circuit evaluation. + More...

+ +

#include <trigger_logical.h>

+
+Inheritance diagram for gridfire::trigger::AndTrigger< TriggerContextStruct >:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::trigger::AndTrigger< TriggerContextStruct >:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 AndTrigger (std::unique_ptr< Trigger< TriggerContextStruct > > A, std::unique_ptr< Trigger< TriggerContextStruct > > B)
 Construct AND from two triggers (ownership transferred).
 
 ~AndTrigger () override=default
 
bool check (const TriggerContextStruct &ctx) const override
 Evaluate A && B; increments hit/miss counters.
 
void update (const TriggerContextStruct &ctx) override
 Update both sub-triggers and increment update counter.
 
void step (const TriggerContextStruct &ctx) override
 similar to update but intended to be run on every step not just those where the trigger triggered
 
void reset () override
 Reset both sub-triggers and local counters.
 
std::string name () const override
 Human-readable name.
 
TriggerResult why (const TriggerContextStruct &ctx) const override
 Structured explanation; short-circuits on A=false.
 
std::string describe () const override
 Description expression e.g. "(A) AND (B)".
 
size_t numTriggers () const override
 Number of true evaluations since last reset.
 
size_t numMisses () const override
 Number of false evaluations since last reset.
 
- Public Member Functions inherited from gridfire::trigger::Trigger< TriggerContextStruct >
virtual ~Trigger ()=default
 Virtual destructor for polymorphic use.
 
+ + + + + + + + + + + + + + + +

+Private Attributes

std::unique_ptr< Trigger< TriggerContextStruct > > m_A
 
std::unique_ptr< Trigger< TriggerContextStruct > > m_B
 
size_t m_hits = 0
 
size_t m_misses = 0
 
size_t m_updates = 0
 
size_t m_resets = 0
 
size_t m_steps = 0
 
+

Detailed Description

+
template<typename TriggerContextStruct>
+class gridfire::trigger::AndTrigger< TriggerContextStruct >

Logical conjunction of two triggers with short-circuit evaluation.

+

check(ctx) returns A.check(ctx) && B.check(ctx). The why(ctx) explanation short-circuits if A is false, avoiding evaluation of B. update(ctx) calls update() on both A and B.

+

Counters (mutable) are incremented inside const check(): m_hits on true; m_misses on false; m_updates on each update(); m_resets on reset().

+
Example
auto t = AndTrigger(ctxA, ctxB);
+
if (t.check(ctx)) { (void)ctx; }
+
gridfire::trigger::AndTrigger
Logical conjunction of two triggers with short-circuit evaluation.
Definition trigger_logical.h:39
+
+

Constructor & Destructor Documentation

+ +

◆ AndTrigger()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + + + + + + + + + + + + + + +
gridfire::trigger::AndTrigger< TriggerContextStruct >::AndTrigger (std::unique_ptr< Trigger< TriggerContextStruct > > A,
std::unique_ptr< Trigger< TriggerContextStruct > > B 
)
+
+ +

Construct AND from two triggers (ownership transferred).

+ +
+
+ +

◆ ~AndTrigger()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
gridfire::trigger::AndTrigger< TriggerContextStruct >::~AndTrigger ()
+ 		+overridedefault
+
+ +
+
+

Member Function Documentation

+ +

◆ check()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
bool gridfire::trigger::AndTrigger< TriggerContextStruct >::check (const TriggerContextStruct & ctx) const
+ 		+overridevirtual
+
+ +

Evaluate A && B; increments hit/miss counters.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ describe()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
std::string gridfire::trigger::AndTrigger< TriggerContextStruct >::describe () const
+ 		+overridevirtual
+
+ +

Description expression e.g. "(A) AND (B)".

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ name()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
std::string gridfire::trigger::AndTrigger< TriggerContextStruct >::name () const
+ 		+overridevirtual
+
+ +

Human-readable name.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ numMisses()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
size_t gridfire::trigger::AndTrigger< TriggerContextStruct >::numMisses () const
+ 		+overridevirtual
+
+ +

Number of false evaluations since last reset.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ numTriggers()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
size_t gridfire::trigger::AndTrigger< TriggerContextStruct >::numTriggers () const
+ 		+overridevirtual
+
+ +

Number of true evaluations since last reset.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ reset()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
void gridfire::trigger::AndTrigger< TriggerContextStruct >::reset ()
+ 		+overridevirtual
+
+ +

Reset both sub-triggers and local counters.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ step()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
void gridfire::trigger::AndTrigger< TriggerContextStruct >::step (const TriggerContextStruct & ctx)
+ 		+overridevirtual
+
+ +

similar to update but intended to be run on every step not just those where the trigger triggered

+
Parameters
+ + +
ctxContext snapshot used to update state.
+
+
+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ update()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
void gridfire::trigger::AndTrigger< TriggerContextStruct >::update (const TriggerContextStruct & ctx)
+ 		+overridevirtual
+
+ +

Update both sub-triggers and increment update counter.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ why()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
TriggerResult gridfire::trigger::AndTrigger< TriggerContextStruct >::why (const TriggerContextStruct & ctx) const
+ 		+overridevirtual
+
+ +

Structured explanation; short-circuits on A=false.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+

Member Data Documentation

+ +

◆ m_A

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
std::unique_ptr<Trigger<TriggerContextStruct> > gridfire::trigger::AndTrigger< TriggerContextStruct >::m_A
+ 		+private
+
+ +
+
+ +

◆ m_B

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
std::unique_ptr<Trigger<TriggerContextStruct> > gridfire::trigger::AndTrigger< TriggerContextStruct >::m_B
+ 		+private
+
+ +
+
+ +

◆ m_hits

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::AndTrigger< TriggerContextStruct >::m_hits = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_misses

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::AndTrigger< TriggerContextStruct >::m_misses = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_resets

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::AndTrigger< TriggerContextStruct >::m_resets = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_steps

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::AndTrigger< TriggerContextStruct >::m_steps = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_updates

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::AndTrigger< TriggerContextStruct >::m_updates = 0
+ 		+mutableprivate
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1AndTrigger.js b/docs/html/classgridfire_1_1trigger_1_1AndTrigger.js new file mode 100644 index 00000000..c919b1a6 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1AndTrigger.js @@ -0,0 +1,21 @@ +var classgridfire_1_1trigger_1_1AndTrigger = +[ + [ "AndTrigger", "classgridfire_1_1trigger_1_1AndTrigger.html#a969738baf0bda97664715937d4bc403e", null ], + [ "~AndTrigger", "classgridfire_1_1trigger_1_1AndTrigger.html#a2ee18348ca65cc1aa56eb41292a39bc5", null ], + [ "check", "classgridfire_1_1trigger_1_1AndTrigger.html#aaefdfa86856f9f7839b6a7fdffa4a579", null ], + [ "describe", "classgridfire_1_1trigger_1_1AndTrigger.html#a2dcd635c6bdbcfe517adca6e2bd5c408", null ], + [ "name", "classgridfire_1_1trigger_1_1AndTrigger.html#ab78539e5cd88194ab9e98434793eae3f", null ], + [ "numMisses", "classgridfire_1_1trigger_1_1AndTrigger.html#addfd61f8cb234881f535fb8f4d618d74", null ], + [ "numTriggers", "classgridfire_1_1trigger_1_1AndTrigger.html#afffb4281569963183d7db3ed1568eb3a", null ], + [ "reset", "classgridfire_1_1trigger_1_1AndTrigger.html#a2436d8643911ade907e03fb29531ceaa", null ], + [ "step", "classgridfire_1_1trigger_1_1AndTrigger.html#a8e743e8ebe71f9ded835177db6fad908", null ], + [ "update", "classgridfire_1_1trigger_1_1AndTrigger.html#a62f7dbbcf0554caa68e3d778580b3c1d", null ], + [ "why", "classgridfire_1_1trigger_1_1AndTrigger.html#a01033721e8f5d90483d65c904399cf96", null ], + [ "m_A", "classgridfire_1_1trigger_1_1AndTrigger.html#a99be74b126d50c15d21c0724d933af87", null ], + [ "m_B", "classgridfire_1_1trigger_1_1AndTrigger.html#af8ee88421d0dfd92de6df96d686ece38", null ], + [ "m_hits", "classgridfire_1_1trigger_1_1AndTrigger.html#a43e6a9c01b163ab92a0b413bfba52ef5", null ], + [ "m_misses", "classgridfire_1_1trigger_1_1AndTrigger.html#a1714656e907edfcba2d354ff5d7c9ceb", null ], + [ "m_resets", "classgridfire_1_1trigger_1_1AndTrigger.html#ae3ff88ddb15d04e798fc03c6c941e312", null ], + [ "m_steps", "classgridfire_1_1trigger_1_1AndTrigger.html#afd8d79e83f83473f0df64e96b63aa1f1", null ], + [ "m_updates", "classgridfire_1_1trigger_1_1AndTrigger.html#a7f88c1139e1b05baed44614104d601b4", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1AndTrigger__coll__graph.map b/docs/html/classgridfire_1_1trigger_1_1AndTrigger__coll__graph.map new file mode 100644 index 00000000..aebdd882 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1AndTrigger__coll__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1AndTrigger__coll__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1AndTrigger__coll__graph.md5 new file mode 100644 index 00000000..b6b68e9b --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1AndTrigger__coll__graph.md5 @@ -0,0 +1 @@ +45cf4113f331a25ea64c65135027fa83 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1AndTrigger__coll__graph.svg b/docs/html/classgridfire_1_1trigger_1_1AndTrigger__coll__graph.svg new file mode 100644 index 00000000..43b61d91 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1AndTrigger__coll__graph.svg @@ -0,0 +1,166 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::trigger::AndTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +AndTrigger< TriggerContext +Struct > + + + + + +Node2 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::unique_ptr< gridfire +::trigger::Trigger< TriggerContext +Struct > > + + + + + +Node4->Node1 + + + + + + m_A +m_B + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1AndTrigger__coll__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1AndTrigger__coll__graph_org.svg new file mode 100644 index 00000000..bafdfdb2 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1AndTrigger__coll__graph_org.svg @@ -0,0 +1,84 @@ + + + + + + +gridfire::trigger::AndTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +AndTrigger< TriggerContext +Struct > + + + + + +Node2 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::unique_ptr< gridfire +::trigger::Trigger< TriggerContext +Struct > > + + + + + +Node4->Node1 + + + + + + m_A +m_B + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1AndTrigger__inherit__graph.map b/docs/html/classgridfire_1_1trigger_1_1AndTrigger__inherit__graph.map new file mode 100644 index 00000000..ccc7a6a0 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1AndTrigger__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1AndTrigger__inherit__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1AndTrigger__inherit__graph.md5 new file mode 100644 index 00000000..eb218d39 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1AndTrigger__inherit__graph.md5 @@ -0,0 +1 @@ +5fad7b18f4657fbb83dd3d15d5720267 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1AndTrigger__inherit__graph.svg b/docs/html/classgridfire_1_1trigger_1_1AndTrigger__inherit__graph.svg new file mode 100644 index 00000000..3d7247a5 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1AndTrigger__inherit__graph.svg @@ -0,0 +1,87 @@ + + + + + + + + + + + +gridfire::trigger::AndTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +AndTrigger< TriggerContext +Struct > + + + + + +Node2 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1AndTrigger__inherit__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1AndTrigger__inherit__graph_org.svg new file mode 100644 index 00000000..6ca22a93 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1AndTrigger__inherit__graph_org.svg @@ -0,0 +1,62 @@ + + + + + + +gridfire::trigger::AndTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +AndTrigger< TriggerContext +Struct > + + + + + +Node2 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger-members.html b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger-members.html new file mode 100644 index 00000000..8492cf2e --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger-members.html @@ -0,0 +1,130 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::trigger::EveryNthTrigger< TriggerContextStruct > Member List
+
+
+ +

This is the complete list of members for gridfire::trigger::EveryNthTrigger< TriggerContextStruct >, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + +
check(const TriggerContextStruct &ctx) const overridegridfire::trigger::EveryNthTrigger< TriggerContextStruct >virtual
describe() const overridegridfire::trigger::EveryNthTrigger< TriggerContextStruct >virtual
EveryNthTrigger(std::unique_ptr< Trigger< TriggerContextStruct > > A, size_t N)gridfire::trigger::EveryNthTrigger< TriggerContextStruct >explicit
m_Agridfire::trigger::EveryNthTrigger< TriggerContextStruct >private
m_countergridfire::trigger::EveryNthTrigger< TriggerContextStruct >mutableprivate
m_hitsgridfire::trigger::EveryNthTrigger< TriggerContextStruct >mutableprivate
m_missesgridfire::trigger::EveryNthTrigger< TriggerContextStruct >mutableprivate
m_Ngridfire::trigger::EveryNthTrigger< TriggerContextStruct >private
m_resetsgridfire::trigger::EveryNthTrigger< TriggerContextStruct >mutableprivate
m_stepsgridfire::trigger::EveryNthTrigger< TriggerContextStruct >mutableprivate
m_updatesgridfire::trigger::EveryNthTrigger< TriggerContextStruct >mutableprivate
name() const overridegridfire::trigger::EveryNthTrigger< TriggerContextStruct >virtual
numMisses() const overridegridfire::trigger::EveryNthTrigger< TriggerContextStruct >virtual
numTriggers() const overridegridfire::trigger::EveryNthTrigger< TriggerContextStruct >virtual
reset() overridegridfire::trigger::EveryNthTrigger< TriggerContextStruct >virtual
step(const TriggerContextStruct &ctx) overridegridfire::trigger::EveryNthTrigger< TriggerContextStruct >virtual
update(const TriggerContextStruct &ctx) overridegridfire::trigger::EveryNthTrigger< TriggerContextStruct >virtual
why(const TriggerContextStruct &ctx) const overridegridfire::trigger::EveryNthTrigger< TriggerContextStruct >virtual
~EveryNthTrigger() override=defaultgridfire::trigger::EveryNthTrigger< TriggerContextStruct >
~Trigger()=defaultgridfire::trigger::Trigger< TriggerContextStruct >virtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger.html b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger.html new file mode 100644 index 00000000..35513d73 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger.html @@ -0,0 +1,767 @@ + + + + + + + +GridFire: gridfire::trigger::EveryNthTrigger< TriggerContextStruct > Class Template Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
gridfire::trigger::EveryNthTrigger< TriggerContextStruct > Class Template Referencefinal
+
+
+ +

Pass-through trigger that fires every Nth time its child trigger is true. + More...

+ +

#include <trigger_logical.h>

+
+Inheritance diagram for gridfire::trigger::EveryNthTrigger< TriggerContextStruct >:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::trigger::EveryNthTrigger< TriggerContextStruct >:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 EveryNthTrigger (std::unique_ptr< Trigger< TriggerContextStruct > > A, size_t N)
 
 ~EveryNthTrigger () override=default
 
bool check (const TriggerContextStruct &ctx) const override
 Evaluate the trigger condition against the provided context.
 
void update (const TriggerContextStruct &ctx) override
 Update any internal state with the given context (e.g., counters, windows).
 
void step (const TriggerContextStruct &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 TriggerContextStruct &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< TriggerContextStruct >
virtual ~Trigger ()=default
 Virtual destructor for polymorphic use.
 
+ + + + + + + + + + + + + + + + + +

+Private Attributes

std::unique_ptr< Trigger< TriggerContextStruct > > m_A
 
size_t m_N
 
size_t m_counter = 0
 
size_t m_hits = 0
 
size_t m_misses = 0
 
size_t m_updates = 0
 
size_t m_resets = 0
 
size_t m_steps = 0
 
+

Detailed Description

+
template<typename TriggerContextStruct>
+class gridfire::trigger::EveryNthTrigger< TriggerContextStruct >

Pass-through trigger that fires every Nth time its child trigger is true.

+

On update(ctx), increments an internal counter when A.check(ctx) is true. check(ctx) returns true only when A.check(ctx) is true and the internal counter is a multiple of N.

+
Exceptions
+ + +
std::invalid_argumentWhen constructed with N==0.
+
+
+

Constructor & Destructor Documentation

+ +

◆ EveryNthTrigger()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::EveryNthTrigger (std::unique_ptr< Trigger< TriggerContextStruct > > A,
size_t N 
)
+ 		+explicit
+
+ +
+
+ +

◆ ~EveryNthTrigger()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::~EveryNthTrigger ()
+ 		+overridedefault
+
+ +
+
+

Member Function Documentation

+ +

◆ check()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
bool gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::check (const TriggerContextStruct & ctx) const
+ 		+overridevirtual
+
+ +

Evaluate the trigger condition against the provided context.

+
Parameters
+ + +
ctxContext snapshot (immutable view) used to evaluate the condition.
+
+
+
Returns
true if the condition is satisfied; false otherwise.
+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ describe()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
std::string gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::describe () const
+ 		+overridevirtual
+
+ +

Human-readable description of this trigger's logic.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ name()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
std::string gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::name () const
+ 		+overridevirtual
+
+ +

Short, stable name for this trigger (suitable for logs/UI).

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ numMisses()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
size_t gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::numMisses () const
+ 		+overridevirtual
+
+ +

Total number of times this trigger evaluated to false since last reset.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ numTriggers()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
size_t gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::numTriggers () const
+ 		+overridevirtual
+
+ +

Total number of times this trigger evaluated to true since last reset.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ reset()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
void gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::reset ()
+ 		+overridevirtual
+
+ +

Reset internal state and diagnostics counters.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ step()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
void gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::step (const TriggerContextStruct & ctx)
+ 		+overridevirtual
+
+ +

similar to update but intended to be run on every step not just those where the trigger triggered

+
Parameters
+ + +
ctxContext snapshot used to update state.
+
+
+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ update()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
void gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::update (const TriggerContextStruct & ctx)
+ 		+overridevirtual
+
+ +

Update any internal state with the given context (e.g., counters, windows).

+
Parameters
+ + +
ctxContext snapshot used to update state.
+
+
+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ why()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
TriggerResult gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::why (const TriggerContextStruct & ctx) const
+ 		+overridevirtual
+
+ +

Explain why the last evaluation would be true/false in a structured way.

+
Parameters
+ + +
ctxContext snapshot for the explanation.
+
+
+
Returns
A TriggerResult tree with a boolean value and per-cause details.
+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+

Member Data Documentation

+ +

◆ m_A

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
std::unique_ptr<Trigger<TriggerContextStruct> > gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::m_A
+ 		+private
+
+ +
+
+ +

◆ m_counter

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::m_counter = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_hits

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::m_hits = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_misses

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::m_misses = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_N

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::m_N
+ 		+private
+
+ +
+
+ +

◆ m_resets

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::m_resets = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_steps

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::m_steps = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_updates

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::EveryNthTrigger< TriggerContextStruct >::m_updates = 0
+ 		+mutableprivate
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger.js b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger.js new file mode 100644 index 00000000..c4fc58cf --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger.js @@ -0,0 +1,22 @@ +var classgridfire_1_1trigger_1_1EveryNthTrigger = +[ + [ "EveryNthTrigger", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#a69e5a3061926e1cd36fbd0a5285fa0a7", null ], + [ "~EveryNthTrigger", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#ae28e54330d575d9d1d3d8ebc6e7a6f75", null ], + [ "check", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#a69fbb099f8d13d39602f58fa8aa8e7f2", null ], + [ "describe", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#aab88715f3c94437ca7f3fcb1698c69de", null ], + [ "name", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#a4a834d24286f9204995bf78fb69f35dc", null ], + [ "numMisses", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#ae7776f4a526db3245e64a74a3b0172d3", null ], + [ "numTriggers", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#a7e5568c9d7799b7f80ad0d3efe2cd143", null ], + [ "reset", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#abf218d255bde157540b51cd6a54f6eb1", null ], + [ "step", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#a26d0aca39087a1f69e96e0701ca83f81", null ], + [ "update", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#a0dd783afab7ef6005f0241f9de7b31f6", null ], + [ "why", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#a3bf0d69122f801deca4b62db47262d9b", null ], + [ "m_A", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#a27f1fd8c8a93576f83a4f3320469c83a", null ], + [ "m_counter", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#a80d6f82095c3b5fdbc46776e183cdb1f", null ], + [ "m_hits", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#a021c30d6db015bb88a70af348a5dd336", null ], + [ "m_misses", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#a0a5c2c5aedc779c1535d3839c6a6596e", null ], + [ "m_N", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#a652ba8d1ac36b9713f426eedf2b1ead0", null ], + [ "m_resets", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#a87b6e54f3a0536d20709d7e746ec575d", null ], + [ "m_steps", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#acefe02899ade9aa595e04f3ec34f251a", null ], + [ "m_updates", "classgridfire_1_1trigger_1_1EveryNthTrigger.html#ab0a33f49be02d34b27f75edf75dbc06d", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__coll__graph.map b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__coll__graph.map new file mode 100644 index 00000000..16c60f75 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__coll__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__coll__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__coll__graph.md5 new file mode 100644 index 00000000..b7bbaa2f --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__coll__graph.md5 @@ -0,0 +1 @@ +c05320ab14e6df1152987904e3a5d67c \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__coll__graph.svg b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__coll__graph.svg new file mode 100644 index 00000000..eaef0dc0 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__coll__graph.svg @@ -0,0 +1,165 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::trigger::EveryNthTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +EveryNthTrigger< TriggerContext +Struct > + + + + + +Node2 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::unique_ptr< gridfire +::trigger::Trigger< TriggerContext +Struct > > + + + + + +Node4->Node1 + + + + + + m_A + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__coll__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__coll__graph_org.svg new file mode 100644 index 00000000..6bcb61f1 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__coll__graph_org.svg @@ -0,0 +1,83 @@ + + + + + + +gridfire::trigger::EveryNthTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +EveryNthTrigger< TriggerContext +Struct > + + + + + +Node2 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::unique_ptr< gridfire +::trigger::Trigger< TriggerContext +Struct > > + + + + + +Node4->Node1 + + + + + + m_A + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__inherit__graph.map b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__inherit__graph.map new file mode 100644 index 00000000..23e0871d --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__inherit__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__inherit__graph.md5 new file mode 100644 index 00000000..652448d5 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__inherit__graph.md5 @@ -0,0 +1 @@ +5874deeee60f704d35381f3890604058 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__inherit__graph.svg b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__inherit__graph.svg new file mode 100644 index 00000000..89a541a1 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__inherit__graph.svg @@ -0,0 +1,87 @@ + + + + + + + + + + + +gridfire::trigger::EveryNthTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +EveryNthTrigger< TriggerContext +Struct > + + + + + +Node2 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__inherit__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__inherit__graph_org.svg new file mode 100644 index 00000000..a0ced3c0 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1EveryNthTrigger__inherit__graph_org.svg @@ -0,0 +1,62 @@ + + + + + + +gridfire::trigger::EveryNthTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +EveryNthTrigger< TriggerContext +Struct > + + + + + +Node2 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger-members.html b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger-members.html new file mode 100644 index 00000000..c6bfd5b6 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger-members.html @@ -0,0 +1,120 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::trigger::LogicalTrigger< TriggerContextStruct > Member List
+
+
+ +

This is the complete list of members for gridfire::trigger::LogicalTrigger< TriggerContextStruct >, including all inherited members.

+ + + + + + + + + + + +
check(const TriggerContextStruct &ctx) const =0gridfire::trigger::Trigger< TriggerContextStruct >pure virtual
describe() const =0gridfire::trigger::Trigger< TriggerContextStruct >pure virtual
name() const =0gridfire::trigger::Trigger< TriggerContextStruct >pure virtual
numMisses() const =0gridfire::trigger::Trigger< TriggerContextStruct >pure virtual
numTriggers() const =0gridfire::trigger::Trigger< TriggerContextStruct >pure virtual
reset()=0gridfire::trigger::Trigger< TriggerContextStruct >pure virtual
step(const TriggerContextStruct &ctx)=0gridfire::trigger::Trigger< TriggerContextStruct >pure virtual
update(const TriggerContextStruct &ctx)=0gridfire::trigger::Trigger< TriggerContextStruct >pure virtual
why(const TriggerContextStruct &ctx) const =0gridfire::trigger::Trigger< TriggerContextStruct >pure virtual
~Trigger()=defaultgridfire::trigger::Trigger< TriggerContextStruct >virtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger.html b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger.html new file mode 100644 index 00000000..74254097 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger.html @@ -0,0 +1,160 @@ + + + + + + + +GridFire: gridfire::trigger::LogicalTrigger< TriggerContextStruct > Class Template Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+List of all members
+
gridfire::trigger::LogicalTrigger< TriggerContextStruct > Class Template Reference
+
+
+ +

#include <trigger_logical.h>

+
+Inheritance diagram for gridfire::trigger::LogicalTrigger< TriggerContextStruct >:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::trigger::LogicalTrigger< TriggerContextStruct >:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Public Member Functions inherited from gridfire::trigger::Trigger< TriggerContextStruct >
virtual ~Trigger ()=default
 Virtual destructor for polymorphic use.
 
virtual bool check (const TriggerContextStruct &ctx) const =0
 Evaluate the trigger condition against the provided context.
 
virtual void update (const TriggerContextStruct &ctx)=0
 Update any internal state with the given context (e.g., counters, windows).
 
virtual void step (const TriggerContextStruct &ctx)=0
 similar to update but intended to be run on every step not just those where the trigger triggered
 
virtual void reset ()=0
 Reset internal state and diagnostics counters.
 
virtual std::string name () const =0
 Short, stable name for this trigger (suitable for logs/UI).
 
virtual std::string describe () const =0
 Human-readable description of this trigger's logic.
 
virtual TriggerResult why (const TriggerContextStruct &ctx) const =0
 Explain why the last evaluation would be true/false in a structured way.
 
virtual size_t numTriggers () const =0
 Total number of times this trigger evaluated to true since last reset.
 
virtual size_t numMisses () const =0
 Total number of times this trigger evaluated to false since last reset.
 
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__coll__graph.map b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__coll__graph.map new file mode 100644 index 00000000..f3fdd765 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__coll__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__coll__graph.md5 new file mode 100644 index 00000000..93b91bf4 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__coll__graph.md5 @@ -0,0 +1 @@ +18741023ca09c6d6df197dd5233aa55a \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__coll__graph.svg b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__coll__graph.svg new file mode 100644 index 00000000..8f70a10f --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__coll__graph.svg @@ -0,0 +1,67 @@ + + + + + + + + + + + +gridfire::trigger::LogicalTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node2 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__coll__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__coll__graph_org.svg new file mode 100644 index 00000000..f68e71bd --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__coll__graph_org.svg @@ -0,0 +1,42 @@ + + + + + + +gridfire::trigger::LogicalTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node2 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__inherit__graph.map b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__inherit__graph.map new file mode 100644 index 00000000..11c34842 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__inherit__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__inherit__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__inherit__graph.md5 new file mode 100644 index 00000000..af52f81a --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__inherit__graph.md5 @@ -0,0 +1 @@ +77b6fedb7d7530ea7940e1daa231a1fc \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__inherit__graph.svg b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__inherit__graph.svg new file mode 100644 index 00000000..c4b16092 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__inherit__graph.svg @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::trigger::LogicalTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node3 + + +gridfire::trigger:: +AndTrigger< TriggerContext +Struct > + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::trigger:: +EveryNthTrigger< TriggerContext +Struct > + + + + + +Node1->Node4 + + + + + + + + +Node5 + + +gridfire::trigger:: +NotTrigger< TriggerContext +Struct > + + + + + +Node1->Node5 + + + + + + + + +Node6 + + +gridfire::trigger:: +OrTrigger< TriggerContextStruct > + + + + + +Node1->Node6 + + + + + + + + +Node2 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node2->Node1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__inherit__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__inherit__graph_org.svg new file mode 100644 index 00000000..96108468 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1LogicalTrigger__inherit__graph_org.svg @@ -0,0 +1,121 @@ + + + + + + +gridfire::trigger::LogicalTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node3 + + +gridfire::trigger:: +AndTrigger< TriggerContext +Struct > + + + + + +Node1->Node3 + + + + + + + + +Node4 + + +gridfire::trigger:: +EveryNthTrigger< TriggerContext +Struct > + + + + + +Node1->Node4 + + + + + + + + +Node5 + + +gridfire::trigger:: +NotTrigger< TriggerContext +Struct > + + + + + +Node1->Node5 + + + + + + + + +Node6 + + +gridfire::trigger:: +OrTrigger< TriggerContextStruct > + + + + + +Node1->Node6 + + + + + + + + +Node2 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1NotTrigger-members.html b/docs/html/classgridfire_1_1trigger_1_1NotTrigger-members.html new file mode 100644 index 00000000..271831bf --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1NotTrigger-members.html @@ -0,0 +1,128 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::trigger::NotTrigger< TriggerContextStruct > Member List
+
+
+ +

This is the complete list of members for gridfire::trigger::NotTrigger< TriggerContextStruct >, including all inherited members.

+ + + + + + + + + + + + + + + + + + + +
check(const TriggerContextStruct &ctx) const overridegridfire::trigger::NotTrigger< TriggerContextStruct >virtual
describe() const overridegridfire::trigger::NotTrigger< TriggerContextStruct >virtual
m_Agridfire::trigger::NotTrigger< TriggerContextStruct >private
m_hitsgridfire::trigger::NotTrigger< TriggerContextStruct >mutableprivate
m_missesgridfire::trigger::NotTrigger< TriggerContextStruct >mutableprivate
m_resetsgridfire::trigger::NotTrigger< TriggerContextStruct >mutableprivate
m_stepsgridfire::trigger::NotTrigger< TriggerContextStruct >mutableprivate
m_updatesgridfire::trigger::NotTrigger< TriggerContextStruct >mutableprivate
name() const overridegridfire::trigger::NotTrigger< TriggerContextStruct >virtual
NotTrigger(std::unique_ptr< Trigger< TriggerContextStruct > > A)gridfire::trigger::NotTrigger< TriggerContextStruct >explicit
numMisses() const overridegridfire::trigger::NotTrigger< TriggerContextStruct >virtual
numTriggers() const overridegridfire::trigger::NotTrigger< TriggerContextStruct >virtual
reset() overridegridfire::trigger::NotTrigger< TriggerContextStruct >virtual
step(const TriggerContextStruct &ctx) overridegridfire::trigger::NotTrigger< TriggerContextStruct >virtual
update(const TriggerContextStruct &ctx) overridegridfire::trigger::NotTrigger< TriggerContextStruct >virtual
why(const TriggerContextStruct &ctx) const overridegridfire::trigger::NotTrigger< TriggerContextStruct >virtual
~NotTrigger() override=defaultgridfire::trigger::NotTrigger< TriggerContextStruct >
~Trigger()=defaultgridfire::trigger::Trigger< TriggerContextStruct >virtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1NotTrigger.html b/docs/html/classgridfire_1_1trigger_1_1NotTrigger.html new file mode 100644 index 00000000..c9c028d3 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1NotTrigger.html @@ -0,0 +1,699 @@ + + + + + + + +GridFire: gridfire::trigger::NotTrigger< TriggerContextStruct > Class Template Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
gridfire::trigger::NotTrigger< TriggerContextStruct > Class Template Referencefinal
+
+
+ +

Logical negation of a trigger. + More...

+ +

#include <trigger_logical.h>

+
+Inheritance diagram for gridfire::trigger::NotTrigger< TriggerContextStruct >:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::trigger::NotTrigger< TriggerContextStruct >:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 NotTrigger (std::unique_ptr< Trigger< TriggerContextStruct > > A)
 
 ~NotTrigger () override=default
 
bool check (const TriggerContextStruct &ctx) const override
 Evaluate the trigger condition against the provided context.
 
void update (const TriggerContextStruct &ctx) override
 Update any internal state with the given context (e.g., counters, windows).
 
void step (const TriggerContextStruct &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 TriggerContextStruct &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< TriggerContextStruct >
virtual ~Trigger ()=default
 Virtual destructor for polymorphic use.
 
+ + + + + + + + + + + + + +

+Private Attributes

std::unique_ptr< Trigger< TriggerContextStruct > > m_A
 
size_t m_hits = 0
 
size_t m_misses = 0
 
size_t m_updates = 0
 
size_t m_resets = 0
 
size_t m_steps = 0
 
+

Detailed Description

+
template<typename TriggerContextStruct>
+class gridfire::trigger::NotTrigger< TriggerContextStruct >

Logical negation of a trigger.

+

check(ctx) returns !A.check(ctx). why(ctx) explains the inverted condition. Counter semantics match the other logical triggers.

+

Constructor & Destructor Documentation

+ +

◆ NotTrigger()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
gridfire::trigger::NotTrigger< TriggerContextStruct >::NotTrigger (std::unique_ptr< Trigger< TriggerContextStruct > > A)
+ 		+explicit
+
+ +
+
+ +

◆ ~NotTrigger()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
gridfire::trigger::NotTrigger< TriggerContextStruct >::~NotTrigger ()
+ 		+overridedefault
+
+ +
+
+

Member Function Documentation

+ +

◆ check()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
bool gridfire::trigger::NotTrigger< TriggerContextStruct >::check (const TriggerContextStruct & ctx) const
+ 		+overridevirtual
+
+ +

Evaluate the trigger condition against the provided context.

+
Parameters
+ + +
ctxContext snapshot (immutable view) used to evaluate the condition.
+
+
+
Returns
true if the condition is satisfied; false otherwise.
+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ describe()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
std::string gridfire::trigger::NotTrigger< TriggerContextStruct >::describe () const
+ 		+overridevirtual
+
+ +

Human-readable description of this trigger's logic.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ name()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
std::string gridfire::trigger::NotTrigger< TriggerContextStruct >::name () const
+ 		+overridevirtual
+
+ +

Short, stable name for this trigger (suitable for logs/UI).

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ numMisses()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
size_t gridfire::trigger::NotTrigger< TriggerContextStruct >::numMisses () const
+ 		+overridevirtual
+
+ +

Total number of times this trigger evaluated to false since last reset.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ numTriggers()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
size_t gridfire::trigger::NotTrigger< TriggerContextStruct >::numTriggers () const
+ 		+overridevirtual
+
+ +

Total number of times this trigger evaluated to true since last reset.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ reset()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
void gridfire::trigger::NotTrigger< TriggerContextStruct >::reset ()
+ 		+overridevirtual
+
+ +

Reset internal state and diagnostics counters.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ step()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
void gridfire::trigger::NotTrigger< TriggerContextStruct >::step (const TriggerContextStruct & ctx)
+ 		+overridevirtual
+
+ +

similar to update but intended to be run on every step not just those where the trigger triggered

+
Parameters
+ + +
ctxContext snapshot used to update state.
+
+
+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ update()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
void gridfire::trigger::NotTrigger< TriggerContextStruct >::update (const TriggerContextStruct & ctx)
+ 		+overridevirtual
+
+ +

Update any internal state with the given context (e.g., counters, windows).

+
Parameters
+ + +
ctxContext snapshot used to update state.
+
+
+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ why()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
TriggerResult gridfire::trigger::NotTrigger< TriggerContextStruct >::why (const TriggerContextStruct & ctx) const
+ 		+overridevirtual
+
+ +

Explain why the last evaluation would be true/false in a structured way.

+
Parameters
+ + +
ctxContext snapshot for the explanation.
+
+
+
Returns
A TriggerResult tree with a boolean value and per-cause details.
+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+

Member Data Documentation

+ +

◆ m_A

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
std::unique_ptr<Trigger<TriggerContextStruct> > gridfire::trigger::NotTrigger< TriggerContextStruct >::m_A
+ 		+private
+
+ +
+
+ +

◆ m_hits

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::NotTrigger< TriggerContextStruct >::m_hits = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_misses

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::NotTrigger< TriggerContextStruct >::m_misses = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_resets

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::NotTrigger< TriggerContextStruct >::m_resets = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_steps

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::NotTrigger< TriggerContextStruct >::m_steps = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_updates

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::NotTrigger< TriggerContextStruct >::m_updates = 0
+ 		+mutableprivate
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1NotTrigger.js b/docs/html/classgridfire_1_1trigger_1_1NotTrigger.js new file mode 100644 index 00000000..9acb4cb8 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1NotTrigger.js @@ -0,0 +1,20 @@ +var classgridfire_1_1trigger_1_1NotTrigger = +[ + [ "NotTrigger", "classgridfire_1_1trigger_1_1NotTrigger.html#a4828599aae5ff37f4c82e51fe192bed3", null ], + [ "~NotTrigger", "classgridfire_1_1trigger_1_1NotTrigger.html#afa4173490171d1251cc1757b92841755", null ], + [ "check", "classgridfire_1_1trigger_1_1NotTrigger.html#ae453a72df20fdd416443ef7867f86b92", null ], + [ "describe", "classgridfire_1_1trigger_1_1NotTrigger.html#ad8166350329db3e1f50954afbb311a35", null ], + [ "name", "classgridfire_1_1trigger_1_1NotTrigger.html#acc3bd2938f7746997fb1d255681d8b20", null ], + [ "numMisses", "classgridfire_1_1trigger_1_1NotTrigger.html#a2f9b0d6a6ac54f6371c5a208c06826ea", null ], + [ "numTriggers", "classgridfire_1_1trigger_1_1NotTrigger.html#ae2d27d72af9e1fbf711a58e4583b43a3", null ], + [ "reset", "classgridfire_1_1trigger_1_1NotTrigger.html#afe337517b77e5433d92ded3a64565141", null ], + [ "step", "classgridfire_1_1trigger_1_1NotTrigger.html#a5096cb7e70ea357f28e1b9fc8301c793", null ], + [ "update", "classgridfire_1_1trigger_1_1NotTrigger.html#a846432abf33c7602af0fbb5475c0ad32", null ], + [ "why", "classgridfire_1_1trigger_1_1NotTrigger.html#abfb3eb7befba646ce9f11f36a63750ae", null ], + [ "m_A", "classgridfire_1_1trigger_1_1NotTrigger.html#a0d7818e59a8d86e86053bcb6d5d7d2b8", null ], + [ "m_hits", "classgridfire_1_1trigger_1_1NotTrigger.html#a86404f57e0e0683fc56e0e49321e5e3b", null ], + [ "m_misses", "classgridfire_1_1trigger_1_1NotTrigger.html#aa1253080cd57cdf0be6780773ce6c73c", null ], + [ "m_resets", "classgridfire_1_1trigger_1_1NotTrigger.html#adb9c36fa46a30c28e68c59a7d3bd825d", null ], + [ "m_steps", "classgridfire_1_1trigger_1_1NotTrigger.html#a2e1e78f3bf9fe0edcb9094c778826629", null ], + [ "m_updates", "classgridfire_1_1trigger_1_1NotTrigger.html#ae4830ed152643770b0888b040475b000", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1NotTrigger__coll__graph.map b/docs/html/classgridfire_1_1trigger_1_1NotTrigger__coll__graph.map new file mode 100644 index 00000000..01ced05b --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1NotTrigger__coll__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1NotTrigger__coll__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1NotTrigger__coll__graph.md5 new file mode 100644 index 00000000..2d1f10c7 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1NotTrigger__coll__graph.md5 @@ -0,0 +1 @@ +2ca328ad881ff29223939d2da5a540bc \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1NotTrigger__coll__graph.svg b/docs/html/classgridfire_1_1trigger_1_1NotTrigger__coll__graph.svg new file mode 100644 index 00000000..ce7d11e0 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1NotTrigger__coll__graph.svg @@ -0,0 +1,165 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::trigger::NotTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +NotTrigger< TriggerContext +Struct > + + + + + +Node2 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::unique_ptr< gridfire +::trigger::Trigger< TriggerContext +Struct > > + + + + + +Node4->Node1 + + + + + + m_A + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1NotTrigger__coll__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1NotTrigger__coll__graph_org.svg new file mode 100644 index 00000000..24db43bd --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1NotTrigger__coll__graph_org.svg @@ -0,0 +1,83 @@ + + + + + + +gridfire::trigger::NotTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +NotTrigger< TriggerContext +Struct > + + + + + +Node2 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::unique_ptr< gridfire +::trigger::Trigger< TriggerContext +Struct > > + + + + + +Node4->Node1 + + + + + + m_A + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1NotTrigger__inherit__graph.map b/docs/html/classgridfire_1_1trigger_1_1NotTrigger__inherit__graph.map new file mode 100644 index 00000000..639cbf5c --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1NotTrigger__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1NotTrigger__inherit__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1NotTrigger__inherit__graph.md5 new file mode 100644 index 00000000..2ba2eb1f --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1NotTrigger__inherit__graph.md5 @@ -0,0 +1 @@ +df78e5935373a65ef694e4022d38ef01 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1NotTrigger__inherit__graph.svg b/docs/html/classgridfire_1_1trigger_1_1NotTrigger__inherit__graph.svg new file mode 100644 index 00000000..2fd20f13 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1NotTrigger__inherit__graph.svg @@ -0,0 +1,87 @@ + + + + + + + + + + + +gridfire::trigger::NotTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +NotTrigger< TriggerContext +Struct > + + + + + +Node2 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1NotTrigger__inherit__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1NotTrigger__inherit__graph_org.svg new file mode 100644 index 00000000..9959a782 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1NotTrigger__inherit__graph_org.svg @@ -0,0 +1,62 @@ + + + + + + +gridfire::trigger::NotTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +NotTrigger< TriggerContext +Struct > + + + + + +Node2 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1OrTrigger-members.html b/docs/html/classgridfire_1_1trigger_1_1OrTrigger-members.html new file mode 100644 index 00000000..7170166f --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1OrTrigger-members.html @@ -0,0 +1,129 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::trigger::OrTrigger< TriggerContextStruct > Member List
+
+
+ +

This is the complete list of members for gridfire::trigger::OrTrigger< TriggerContextStruct >, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + +
check(const TriggerContextStruct &ctx) const overridegridfire::trigger::OrTrigger< TriggerContextStruct >virtual
describe() const overridegridfire::trigger::OrTrigger< TriggerContextStruct >virtual
m_Agridfire::trigger::OrTrigger< TriggerContextStruct >private
m_Bgridfire::trigger::OrTrigger< TriggerContextStruct >private
m_hitsgridfire::trigger::OrTrigger< TriggerContextStruct >mutableprivate
m_missesgridfire::trigger::OrTrigger< TriggerContextStruct >mutableprivate
m_resetsgridfire::trigger::OrTrigger< TriggerContextStruct >mutableprivate
m_stepsgridfire::trigger::OrTrigger< TriggerContextStruct >mutableprivate
m_updatesgridfire::trigger::OrTrigger< TriggerContextStruct >mutableprivate
name() const overridegridfire::trigger::OrTrigger< TriggerContextStruct >virtual
numMisses() const overridegridfire::trigger::OrTrigger< TriggerContextStruct >virtual
numTriggers() const overridegridfire::trigger::OrTrigger< TriggerContextStruct >virtual
OrTrigger(std::unique_ptr< Trigger< TriggerContextStruct > > A, std::unique_ptr< Trigger< TriggerContextStruct > > B)gridfire::trigger::OrTrigger< TriggerContextStruct >
reset() overridegridfire::trigger::OrTrigger< TriggerContextStruct >virtual
step(const TriggerContextStruct &ctx) overridegridfire::trigger::OrTrigger< TriggerContextStruct >virtual
update(const TriggerContextStruct &ctx) overridegridfire::trigger::OrTrigger< TriggerContextStruct >virtual
why(const TriggerContextStruct &ctx) const overridegridfire::trigger::OrTrigger< TriggerContextStruct >virtual
~OrTrigger() override=defaultgridfire::trigger::OrTrigger< TriggerContextStruct >
~Trigger()=defaultgridfire::trigger::Trigger< TriggerContextStruct >virtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1OrTrigger.html b/docs/html/classgridfire_1_1trigger_1_1OrTrigger.html new file mode 100644 index 00000000..dac32c1d --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1OrTrigger.html @@ -0,0 +1,727 @@ + + + + + + + +GridFire: gridfire::trigger::OrTrigger< TriggerContextStruct > Class Template Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
gridfire::trigger::OrTrigger< TriggerContextStruct > Class Template Referencefinal
+
+
+ +

Logical disjunction of two triggers with short-circuit evaluation. + More...

+ +

#include <trigger_logical.h>

+
+Inheritance diagram for gridfire::trigger::OrTrigger< TriggerContextStruct >:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::trigger::OrTrigger< TriggerContextStruct >:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 OrTrigger (std::unique_ptr< Trigger< TriggerContextStruct > > A, std::unique_ptr< Trigger< TriggerContextStruct > > B)
 
 ~OrTrigger () override=default
 
bool check (const TriggerContextStruct &ctx) const override
 Evaluate the trigger condition against the provided context.
 
void update (const TriggerContextStruct &ctx) override
 Update any internal state with the given context (e.g., counters, windows).
 
void step (const TriggerContextStruct &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 TriggerContextStruct &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< TriggerContextStruct >
virtual ~Trigger ()=default
 Virtual destructor for polymorphic use.
 
+ + + + + + + + + + + + + + + +

+Private Attributes

std::unique_ptr< Trigger< TriggerContextStruct > > m_A
 
std::unique_ptr< Trigger< TriggerContextStruct > > m_B
 
size_t m_hits = 0
 
size_t m_misses = 0
 
size_t m_updates = 0
 
size_t m_resets = 0
 
size_t m_steps = 0
 
+

Detailed Description

+
template<typename TriggerContextStruct>
+class gridfire::trigger::OrTrigger< TriggerContextStruct >

Logical disjunction of two triggers with short-circuit evaluation.

+

check(ctx) returns A.check(ctx) || B.check(ctx). why(ctx) returns early when A is true. update(ctx) calls update() on both A and B. Counters behave as in AndTrigger.

+

Constructor & Destructor Documentation

+ +

◆ OrTrigger()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + + + + + + + + + + + + + + +
gridfire::trigger::OrTrigger< TriggerContextStruct >::OrTrigger (std::unique_ptr< Trigger< TriggerContextStruct > > A,
std::unique_ptr< Trigger< TriggerContextStruct > > B 
)
+
+ +
+
+ +

◆ ~OrTrigger()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
gridfire::trigger::OrTrigger< TriggerContextStruct >::~OrTrigger ()
+ 		+overridedefault
+
+ +
+
+

Member Function Documentation

+ +

◆ check()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
bool gridfire::trigger::OrTrigger< TriggerContextStruct >::check (const TriggerContextStruct & ctx) const
+ 		+overridevirtual
+
+ +

Evaluate the trigger condition against the provided context.

+
Parameters
+ + +
ctxContext snapshot (immutable view) used to evaluate the condition.
+
+
+
Returns
true if the condition is satisfied; false otherwise.
+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ describe()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
std::string gridfire::trigger::OrTrigger< TriggerContextStruct >::describe () const
+ 		+overridevirtual
+
+ +

Human-readable description of this trigger's logic.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ name()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
std::string gridfire::trigger::OrTrigger< TriggerContextStruct >::name () const
+ 		+overridevirtual
+
+ +

Short, stable name for this trigger (suitable for logs/UI).

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ numMisses()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
size_t gridfire::trigger::OrTrigger< TriggerContextStruct >::numMisses () const
+ 		+overridevirtual
+
+ +

Total number of times this trigger evaluated to false since last reset.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ numTriggers()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
size_t gridfire::trigger::OrTrigger< TriggerContextStruct >::numTriggers () const
+ 		+overridevirtual
+
+ +

Total number of times this trigger evaluated to true since last reset.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ reset()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
void gridfire::trigger::OrTrigger< TriggerContextStruct >::reset ()
+ 		+overridevirtual
+
+ +

Reset internal state and diagnostics counters.

+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ step()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
void gridfire::trigger::OrTrigger< TriggerContextStruct >::step (const TriggerContextStruct & ctx)
+ 		+overridevirtual
+
+ +

similar to update but intended to be run on every step not just those where the trigger triggered

+
Parameters
+ + +
ctxContext snapshot used to update state.
+
+
+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ update()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
void gridfire::trigger::OrTrigger< TriggerContextStruct >::update (const TriggerContextStruct & ctx)
+ 		+overridevirtual
+
+ +

Update any internal state with the given context (e.g., counters, windows).

+
Parameters
+ + +
ctxContext snapshot used to update state.
+
+
+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+ +

◆ why()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
TriggerResult gridfire::trigger::OrTrigger< TriggerContextStruct >::why (const TriggerContextStruct & ctx) const
+ 		+overridevirtual
+
+ +

Explain why the last evaluation would be true/false in a structured way.

+
Parameters
+ + +
ctxContext snapshot for the explanation.
+
+
+
Returns
A TriggerResult tree with a boolean value and per-cause details.
+ +

Implements gridfire::trigger::Trigger< TriggerContextStruct >.

+ +
+
+

Member Data Documentation

+ +

◆ m_A

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
std::unique_ptr<Trigger<TriggerContextStruct> > gridfire::trigger::OrTrigger< TriggerContextStruct >::m_A
+ 		+private
+
+ +
+
+ +

◆ m_B

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
std::unique_ptr<Trigger<TriggerContextStruct> > gridfire::trigger::OrTrigger< TriggerContextStruct >::m_B
+ 		+private
+
+ +
+
+ +

◆ m_hits

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::OrTrigger< TriggerContextStruct >::m_hits = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_misses

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::OrTrigger< TriggerContextStruct >::m_misses = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_resets

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::OrTrigger< TriggerContextStruct >::m_resets = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_steps

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::OrTrigger< TriggerContextStruct >::m_steps = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_updates

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + +
size_t gridfire::trigger::OrTrigger< TriggerContextStruct >::m_updates = 0
+ 		+mutableprivate
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1OrTrigger.js b/docs/html/classgridfire_1_1trigger_1_1OrTrigger.js new file mode 100644 index 00000000..158cfc88 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1OrTrigger.js @@ -0,0 +1,21 @@ +var classgridfire_1_1trigger_1_1OrTrigger = +[ + [ "OrTrigger", "classgridfire_1_1trigger_1_1OrTrigger.html#aaf4f8a090bdd10eeba0b7849fa8ed888", null ], + [ "~OrTrigger", "classgridfire_1_1trigger_1_1OrTrigger.html#afe30f95de39c1375557d032b8a8111f9", null ], + [ "check", "classgridfire_1_1trigger_1_1OrTrigger.html#ac8be54d91e77ed16ae3cca2417d82e0a", null ], + [ "describe", "classgridfire_1_1trigger_1_1OrTrigger.html#accb56630df2f57400467d315c61dede6", null ], + [ "name", "classgridfire_1_1trigger_1_1OrTrigger.html#a062af4f567dc48c088f1fcfb64cc79ec", null ], + [ "numMisses", "classgridfire_1_1trigger_1_1OrTrigger.html#a0b3a7f45604dbb27e832d9559dd20997", null ], + [ "numTriggers", "classgridfire_1_1trigger_1_1OrTrigger.html#afc7d3eae8306ee383d76997ac3803327", null ], + [ "reset", "classgridfire_1_1trigger_1_1OrTrigger.html#ab42043e55c81bac5d3f981bc139579de", null ], + [ "step", "classgridfire_1_1trigger_1_1OrTrigger.html#a95a801aafb5aaa9a22566ebf722a1150", null ], + [ "update", "classgridfire_1_1trigger_1_1OrTrigger.html#a775dac97d109c5fcd5c0287ca98f308c", null ], + [ "why", "classgridfire_1_1trigger_1_1OrTrigger.html#a7bca0da16353f4b04a2f40fb29c07922", null ], + [ "m_A", "classgridfire_1_1trigger_1_1OrTrigger.html#a6da04b5b15371f7087be03bb337dbdd6", null ], + [ "m_B", "classgridfire_1_1trigger_1_1OrTrigger.html#a30dec370b61a5f0562956394b89e8f89", null ], + [ "m_hits", "classgridfire_1_1trigger_1_1OrTrigger.html#a35d519d5266c68b696b779b275574ebf", null ], + [ "m_misses", "classgridfire_1_1trigger_1_1OrTrigger.html#ae72e6e9f1fbfbd11fbfe9aa6d4ff5a3b", null ], + [ "m_resets", "classgridfire_1_1trigger_1_1OrTrigger.html#adc6f560d9199455ba98d85eadfe02847", null ], + [ "m_steps", "classgridfire_1_1trigger_1_1OrTrigger.html#a596db4a92ebf789cea1c431d3d2220c7", null ], + [ "m_updates", "classgridfire_1_1trigger_1_1OrTrigger.html#af595a5daab0f5b3ffc450c6de6737517", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1OrTrigger__coll__graph.map b/docs/html/classgridfire_1_1trigger_1_1OrTrigger__coll__graph.map new file mode 100644 index 00000000..8386d1db --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1OrTrigger__coll__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1OrTrigger__coll__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1OrTrigger__coll__graph.md5 new file mode 100644 index 00000000..6654e574 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1OrTrigger__coll__graph.md5 @@ -0,0 +1 @@ +315404cb703f4665e0cb3577c5b2509a \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1OrTrigger__coll__graph.svg b/docs/html/classgridfire_1_1trigger_1_1OrTrigger__coll__graph.svg new file mode 100644 index 00000000..5b375303 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1OrTrigger__coll__graph.svg @@ -0,0 +1,165 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::trigger::OrTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +OrTrigger< TriggerContextStruct > + + + + + +Node2 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::unique_ptr< gridfire +::trigger::Trigger< TriggerContext +Struct > > + + + + + +Node4->Node1 + + + + + + m_A +m_B + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1OrTrigger__coll__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1OrTrigger__coll__graph_org.svg new file mode 100644 index 00000000..d768c8c7 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1OrTrigger__coll__graph_org.svg @@ -0,0 +1,83 @@ + + + + + + +gridfire::trigger::OrTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +OrTrigger< TriggerContextStruct > + + + + + +Node2 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::unique_ptr< gridfire +::trigger::Trigger< TriggerContext +Struct > > + + + + + +Node4->Node1 + + + + + + m_A +m_B + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1OrTrigger__inherit__graph.map b/docs/html/classgridfire_1_1trigger_1_1OrTrigger__inherit__graph.map new file mode 100644 index 00000000..4514fc06 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1OrTrigger__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1OrTrigger__inherit__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1OrTrigger__inherit__graph.md5 new file mode 100644 index 00000000..fdeb9768 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1OrTrigger__inherit__graph.md5 @@ -0,0 +1 @@ +f344074736a2904742214eff6ca04795 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1OrTrigger__inherit__graph.svg b/docs/html/classgridfire_1_1trigger_1_1OrTrigger__inherit__graph.svg new file mode 100644 index 00000000..d0ccdcb4 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1OrTrigger__inherit__graph.svg @@ -0,0 +1,86 @@ + + + + + + + + + + + +gridfire::trigger::OrTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +OrTrigger< TriggerContextStruct > + + + + + +Node2 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node3->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1OrTrigger__inherit__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1OrTrigger__inherit__graph_org.svg new file mode 100644 index 00000000..30fcd820 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1OrTrigger__inherit__graph_org.svg @@ -0,0 +1,61 @@ + + + + + + +gridfire::trigger::OrTrigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +OrTrigger< TriggerContextStruct > + + + + + +Node2 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node3->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1Trigger-members.html b/docs/html/classgridfire_1_1trigger_1_1Trigger-members.html new file mode 100644 index 00000000..c1e11cac --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1Trigger-members.html @@ -0,0 +1,120 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::trigger::Trigger< TriggerContextStruct > Member List
+
+
+ +

This is the complete list of members for gridfire::trigger::Trigger< TriggerContextStruct >, including all inherited members.

+ + + + + + + + + + + +
check(const TriggerContextStruct &ctx) const =0gridfire::trigger::Trigger< TriggerContextStruct >pure virtual
describe() const =0gridfire::trigger::Trigger< TriggerContextStruct >pure virtual
name() const =0gridfire::trigger::Trigger< TriggerContextStruct >pure virtual
numMisses() const =0gridfire::trigger::Trigger< TriggerContextStruct >pure virtual
numTriggers() const =0gridfire::trigger::Trigger< TriggerContextStruct >pure virtual
reset()=0gridfire::trigger::Trigger< TriggerContextStruct >pure virtual
step(const TriggerContextStruct &ctx)=0gridfire::trigger::Trigger< TriggerContextStruct >pure virtual
update(const TriggerContextStruct &ctx)=0gridfire::trigger::Trigger< TriggerContextStruct >pure virtual
why(const TriggerContextStruct &ctx) const =0gridfire::trigger::Trigger< TriggerContextStruct >pure virtual
~Trigger()=defaultgridfire::trigger::Trigger< TriggerContextStruct >virtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1Trigger.html b/docs/html/classgridfire_1_1trigger_1_1Trigger.html new file mode 100644 index 00000000..f4a6a270 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1Trigger.html @@ -0,0 +1,516 @@ + + + + + + + +GridFire: gridfire::trigger::Trigger< TriggerContextStruct > Class Template Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::trigger::Trigger< TriggerContextStruct > Class Template Referenceabstract
+
+
+ +

Generic trigger interface for signaling events/conditions during integration. + More...

+ +

#include <trigger_abstract.h>

+
+Inheritance diagram for gridfire::trigger::Trigger< TriggerContextStruct >:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

virtual ~Trigger ()=default
 Virtual destructor for polymorphic use.
 
virtual bool check (const TriggerContextStruct &ctx) const =0
 Evaluate the trigger condition against the provided context.
 
virtual void update (const TriggerContextStruct &ctx)=0
 Update any internal state with the given context (e.g., counters, windows).
 
virtual void step (const TriggerContextStruct &ctx)=0
 similar to update but intended to be run on every step not just those where the trigger triggered
 
virtual void reset ()=0
 Reset internal state and diagnostics counters.
 
virtual std::string name () const =0
 Short, stable name for this trigger (suitable for logs/UI).
 
virtual std::string describe () const =0
 Human-readable description of this trigger's logic.
 
virtual TriggerResult why (const TriggerContextStruct &ctx) const =0
 Explain why the last evaluation would be true/false in a structured way.
 
virtual size_t numTriggers () const =0
 Total number of times this trigger evaluated to true since last reset.
 
virtual size_t numMisses () const =0
 Total number of times this trigger evaluated to false since last reset.
 
+

Detailed Description

+
template<typename TriggerContextStruct>
+class gridfire::trigger::Trigger< TriggerContextStruct >

Generic trigger interface for signaling events/conditions during integration.

+

A Trigger encapsulates a condition evaluated against a user-defined context struct (TriggerContextStruct). The interface supports:

    +
  • check(): evaluate the current condition without mutating external state
    • +
  • update(): feed the context to update internal state (counters, sliding windows, etc.)
    • +
  • reset(): clear internal state and counters
    • +
  • name()/describe(): human-readable identification and textual description
    • +
  • why(): structured explanation (tree of TriggerResult) of the last evaluation
    • +
  • numTriggers()/numMisses(): simple counters for diagnostics
    • +
+

Logical compositions (AND/OR/NOT/EveryNth) are provided in trigger_logical.h and implement this interface for any TriggerContextStruct.

+
Template Parameters
+ + +
TriggerContextStructUser-defined context passed to triggers (e.g., timestep info).
+
+
+

Constructor & Destructor Documentation

+ +

◆ ~Trigger()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
virtual gridfire::trigger::Trigger< TriggerContextStruct >::~Trigger ()
+ 		+virtualdefault
+
+ +

Virtual destructor for polymorphic use.

+ +
+
+

Member Function Documentation

+ +

◆ check()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
virtual bool gridfire::trigger::Trigger< TriggerContextStruct >::check (const TriggerContextStruct & ctx) const
+ 		+pure virtual
+
+ +

Evaluate the trigger condition against the provided context.

+
Parameters
+ + +
ctxContext snapshot (immutable view) used to evaluate the condition.
+
+
+
Returns
true if the condition is satisfied; false otherwise.
+ +

Implemented in gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, and gridfire::trigger::EveryNthTrigger< TriggerContextStruct >.

+ +
+
+ +

◆ describe()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
virtual std::string gridfire::trigger::Trigger< TriggerContextStruct >::describe () const
+ 		+pure virtual
+
+ +

Human-readable description of this trigger's logic.

+ +

Implemented in gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, and gridfire::trigger::EveryNthTrigger< TriggerContextStruct >.

+ +
+
+ +

◆ name()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
virtual std::string gridfire::trigger::Trigger< TriggerContextStruct >::name () const
+ 		+pure virtual
+
+ +

Short, stable name for this trigger (suitable for logs/UI).

+ +

Implemented in gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, and gridfire::trigger::EveryNthTrigger< TriggerContextStruct >.

+ +
+
+ +

◆ numMisses()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
virtual size_t gridfire::trigger::Trigger< TriggerContextStruct >::numMisses () const
+ 		+pure virtual
+
+ +

Total number of times this trigger evaluated to false since last reset.

+ +

Implemented in gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, and gridfire::trigger::EveryNthTrigger< TriggerContextStruct >.

+ +
+
+ +

◆ numTriggers()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
virtual size_t gridfire::trigger::Trigger< TriggerContextStruct >::numTriggers () const
+ 		+pure virtual
+
+ +

Total number of times this trigger evaluated to true since last reset.

+ +

Implemented in gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, and gridfire::trigger::EveryNthTrigger< TriggerContextStruct >.

+ +
+
+ +

◆ reset()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + +
virtual void gridfire::trigger::Trigger< TriggerContextStruct >::reset ()
+ 		+pure virtual
+
+ +

Reset internal state and diagnostics counters.

+ +

Implemented in gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, and gridfire::trigger::EveryNthTrigger< TriggerContextStruct >.

+ +
+
+ +

◆ step()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
virtual void gridfire::trigger::Trigger< TriggerContextStruct >::step (const TriggerContextStruct & ctx)
+ 		+pure virtual
+
+ +

similar to update but intended to be run on every step not just those where the trigger triggered

+
Parameters
+ + +
ctxContext snapshot used to update state.
+
+
+ +

Implemented in gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, and gridfire::trigger::EveryNthTrigger< TriggerContextStruct >.

+ +
+
+ +

◆ update()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
virtual void gridfire::trigger::Trigger< TriggerContextStruct >::update (const TriggerContextStruct & ctx)
+ 		+pure virtual
+
+ +

Update any internal state with the given context (e.g., counters, windows).

+
Parameters
+ + +
ctxContext snapshot used to update state.
+
+
+ +

Implemented in gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, and gridfire::trigger::EveryNthTrigger< TriggerContextStruct >.

+ +
+
+ +

◆ why()

+ +
+
+
+template<typename TriggerContextStruct >
+ + + + + +
+ + + + + + + + +
virtual TriggerResult gridfire::trigger::Trigger< TriggerContextStruct >::why (const TriggerContextStruct & ctx) const
+ 		+pure virtual
+
+ +

Explain why the last evaluation would be true/false in a structured way.

+
Parameters
+ + +
ctxContext snapshot for the explanation.
+
+
+
Returns
A TriggerResult tree with a boolean value and per-cause details.
+ +

Implemented in gridfire::trigger::solver::CVODE::SimulationTimeTrigger, gridfire::trigger::solver::CVODE::OffDiagonalTrigger, gridfire::trigger::solver::CVODE::TimestepCollapseTrigger, gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, gridfire::trigger::AndTrigger< TriggerContextStruct >, gridfire::trigger::OrTrigger< TriggerContextStruct >, gridfire::trigger::NotTrigger< TriggerContextStruct >, and gridfire::trigger::EveryNthTrigger< TriggerContextStruct >.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1Trigger.js b/docs/html/classgridfire_1_1trigger_1_1Trigger.js new file mode 100644 index 00000000..b0fe404a --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1Trigger.js @@ -0,0 +1,13 @@ +var classgridfire_1_1trigger_1_1Trigger = +[ + [ "~Trigger", "classgridfire_1_1trigger_1_1Trigger.html#a2c077ccbaf4de9f7068e50144391edda", null ], + [ "check", "classgridfire_1_1trigger_1_1Trigger.html#a1579ffb1c841cda4e67990b42d400d88", null ], + [ "describe", "classgridfire_1_1trigger_1_1Trigger.html#a402cdd062e9479abbcca02e3d94e528f", null ], + [ "name", "classgridfire_1_1trigger_1_1Trigger.html#a3e5b017147f22ca0733733cd39e334b7", null ], + [ "numMisses", "classgridfire_1_1trigger_1_1Trigger.html#a81848e5af844795d879b6d885a2701d7", null ], + [ "numTriggers", "classgridfire_1_1trigger_1_1Trigger.html#a4ea3abfb76a09c4f55ad05d73a2cf12d", null ], + [ "reset", "classgridfire_1_1trigger_1_1Trigger.html#af652af761675736419b961b6946c728d", null ], + [ "step", "classgridfire_1_1trigger_1_1Trigger.html#a4b7ffa4d8d31e2118a8e86172be51041", null ], + [ "update", "classgridfire_1_1trigger_1_1Trigger.html#a048899795704f68668960454d118a6fc", null ], + [ "why", "classgridfire_1_1trigger_1_1Trigger.html#a9f020d828ca36a601b780566cc3377ea", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1Trigger__inherit__graph.map b/docs/html/classgridfire_1_1trigger_1_1Trigger__inherit__graph.map new file mode 100644 index 00000000..cdb78fd6 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1Trigger__inherit__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1Trigger__inherit__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1Trigger__inherit__graph.md5 new file mode 100644 index 00000000..d04fa318 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1Trigger__inherit__graph.md5 @@ -0,0 +1 @@ +d1452dbe3460127a64d83f0a8981d5ab \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1Trigger__inherit__graph.svg b/docs/html/classgridfire_1_1trigger_1_1Trigger__inherit__graph.svg new file mode 100644 index 00000000..d14b3d5b --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1Trigger__inherit__graph.svg @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::trigger::Trigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node2 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::trigger:: +AndTrigger< TriggerContext +Struct > + + + + + +Node2->Node3 + + + + + + + + +Node4 + + +gridfire::trigger:: +EveryNthTrigger< TriggerContext +Struct > + + + + + +Node2->Node4 + + + + + + + + +Node5 + + +gridfire::trigger:: +NotTrigger< TriggerContext +Struct > + + + + + +Node2->Node5 + + + + + + + + +Node6 + + +gridfire::trigger:: +OrTrigger< TriggerContextStruct > + + + + + +Node2->Node6 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1Trigger__inherit__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1Trigger__inherit__graph_org.svg new file mode 100644 index 00000000..7dcf74f9 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1Trigger__inherit__graph_org.svg @@ -0,0 +1,121 @@ + + + + + + +gridfire::trigger::Trigger< TriggerContextStruct > + + +Node1 + + +gridfire::trigger:: +Trigger< TriggerContextStruct > + + + + + +Node2 + + +gridfire::trigger:: +LogicalTrigger< TriggerContext +Struct > + + + + + +Node1->Node2 + + + + + + + + +Node3 + + +gridfire::trigger:: +AndTrigger< TriggerContext +Struct > + + + + + +Node2->Node3 + + + + + + + + +Node4 + + +gridfire::trigger:: +EveryNthTrigger< TriggerContext +Struct > + + + + + +Node2->Node4 + + + + + + + + +Node5 + + +gridfire::trigger:: +NotTrigger< TriggerContext +Struct > + + + + + +Node2->Node5 + + + + + + + + +Node6 + + +gridfire::trigger:: +OrTrigger< TriggerContextStruct > + + + + + +Node2->Node6 + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger-members.html b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger-members.html new file mode 100644 index 00000000..b65713c5 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger-members.html @@ -0,0 +1,133 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger Member List
+
+
+ +

This is the complete list of members for gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + +
abs_failure(const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) constgridfire::trigger::solver::CVODE::ConvergenceFailureTriggerprivate
check(const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const overridegridfire::trigger::solver::CVODE::ConvergenceFailureTriggervirtual
ConvergenceFailureTrigger(size_t totalFailures, float relativeFailureRate, size_t windowSize)gridfire::trigger::solver::CVODE::ConvergenceFailureTriggerexplicit
current_mean() constgridfire::trigger::solver::CVODE::ConvergenceFailureTriggerprivate
describe() const overridegridfire::trigger::solver::CVODE::ConvergenceFailureTriggervirtual
m_hitsgridfire::trigger::solver::CVODE::ConvergenceFailureTriggermutableprivate
m_loggergridfire::trigger::solver::CVODE::ConvergenceFailureTriggerprivate
m_missesgridfire::trigger::solver::CVODE::ConvergenceFailureTriggermutableprivate
m_relativeFailureRategridfire::trigger::solver::CVODE::ConvergenceFailureTriggerprivate
m_resetsgridfire::trigger::solver::CVODE::ConvergenceFailureTriggermutableprivate
m_totalFailuresgridfire::trigger::solver::CVODE::ConvergenceFailureTriggerprivate
m_updatesgridfire::trigger::solver::CVODE::ConvergenceFailureTriggermutableprivate
m_windowgridfire::trigger::solver::CVODE::ConvergenceFailureTriggerprivate
m_windowSizegridfire::trigger::solver::CVODE::ConvergenceFailureTriggerprivate
name() const overridegridfire::trigger::solver::CVODE::ConvergenceFailureTriggervirtual
numMisses() const overridegridfire::trigger::solver::CVODE::ConvergenceFailureTriggervirtual
numTriggers() const overridegridfire::trigger::solver::CVODE::ConvergenceFailureTriggervirtual
rel_failure(const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) constgridfire::trigger::solver::CVODE::ConvergenceFailureTriggerprivate
reset() overridegridfire::trigger::solver::CVODE::ConvergenceFailureTriggervirtual
step(const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) overridegridfire::trigger::solver::CVODE::ConvergenceFailureTriggervirtual
update(const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) overridegridfire::trigger::solver::CVODE::ConvergenceFailureTriggervirtual
why(const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const overridegridfire::trigger::solver::CVODE::ConvergenceFailureTriggervirtual
~Trigger()=defaultgridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >virtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html new file mode 100644 index 00000000..fdea19ce --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html @@ -0,0 +1,808 @@ + + + + + + + +GridFire: gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger Class Referencefinal
+
+
+ +

#include <engine_partitioning_trigger.h>

+
+Inheritance diagram for gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+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
 
void reset () override
 Reset internal state and diagnostics counters.
 
std::string name () const override
 Short, stable name for this trigger (suitable for logs/UI).
 
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.
 
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 >
virtual ~Trigger ()=default
 Virtual destructor for polymorphic use.
 
+ + + + +

+Private Attributes

quill::Logger * m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
 Logger used for trace/error diagnostics.
 
+ + + + + + + + + + + + + + + + + + + + + + + +

Diagnostics counters

size_t m_hits = 0
 
size_t m_misses = 0
 
size_t m_updates = 0
 
size_t m_resets = 0
 
size_t m_totalFailures
 
float m_relativeFailureRate
 
size_t m_windowSize
 
std::deque< size_t > m_window
 
float current_mean () const
 
bool abs_failure (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const
 
bool rel_failure (const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const
 
+

Constructor & Destructor Documentation

+ +

◆ ConvergenceFailureTrigger()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::ConvergenceFailureTrigger (size_t totalFailures,
float relativeFailureRate,
size_t windowSize 
)
+ 		+explicit
+
+ +
+
+

Member Function Documentation

+ +

◆ abs_failure()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::abs_failure (const gridfire::solver::CVODESolverStrategy::TimestepContext & ctx) const
+ 		+private
+
+ +
+
+ +

◆ check()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::check (const gridfire::solver::CVODESolverStrategy::TimestepContext & ctx) const
+ 		+overridevirtual
+
+ +

Evaluate the trigger condition against the provided context.

+
Parameters
+ + +
ctxContext snapshot (immutable view) used to evaluate the condition.
+
+
+
Returns
true if the condition is satisfied; false otherwise.
+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ current_mean()

+ +
+
+ + + + + +
+ + + + + + + +
float gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::current_mean () const
+ 		+private
+
+ +
+
+ +

◆ describe()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::describe () const
+ 		+overridevirtual
+
+ +

Human-readable description of this trigger's logic.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::name () const
+ 		+overridevirtual
+
+ +

Short, stable name for this trigger (suitable for logs/UI).

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ numMisses()

+ +
+
+ + + + + +
+ + + + + + + +
size_t gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::numMisses () const
+ 		+overridevirtual
+
+ +

Total number of times this trigger evaluated to false since last reset.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ numTriggers()

+ +
+
+ + + + + +
+ + + + + + + +
size_t gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::numTriggers () const
+ 		+overridevirtual
+
+ +

Total number of times this trigger evaluated to true since last reset.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ rel_failure()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::rel_failure (const gridfire::solver::CVODESolverStrategy::TimestepContext & ctx) const
+ 		+private
+
+ +
+
+ +

◆ reset()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::reset ()
+ 		+overridevirtual
+
+ +

Reset internal state and diagnostics counters.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ step()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::step (const gridfire::solver::CVODESolverStrategy::TimestepContext & ctx)
+ 		+overridevirtual
+
+ +

similar to update but intended to be run on every step not just those where the trigger triggered

+
Parameters
+ + +
ctxContext snapshot used to update state.
+
+
+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ update()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::update (const gridfire::solver::CVODESolverStrategy::TimestepContext & ctx)
+ 		+overridevirtual
+
+ +

Update any internal state with the given context (e.g., counters, windows).

+
Parameters
+ + +
ctxContext snapshot used to update state.
+
+
+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ why()

+ +
+
+ + + + + +
+ + + + + + + + +
TriggerResult gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::why (const gridfire::solver::CVODESolverStrategy::TimestepContext & ctx) const
+ 		+overridevirtual
+
+ +

Explain why the last evaluation would be true/false in a structured way.

+
Parameters
+ + +
ctxContext snapshot for the explanation.
+
+
+
Returns
A TriggerResult tree with a boolean value and per-cause details.
+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+

Member Data Documentation

+ +

◆ m_hits

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::m_hits = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +

Logger used for trace/error diagnostics.

+ +
+
+ +

◆ m_misses

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::m_misses = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_relativeFailureRate

+ +
+
+ + + + + +
+ + + + +
float gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::m_relativeFailureRate
+ 		+private
+
+ +
+
+ +

◆ m_resets

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::m_resets = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_totalFailures

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::m_totalFailures
+ 		+private
+
+ +
+
+ +

◆ m_updates

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::m_updates = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_window

+ +
+
+ + + + + +
+ + + + +
std::deque<size_t> gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::m_window
+ 		+private
+
+ +
+
+ +

◆ m_windowSize

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger::m_windowSize
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.js b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.js new file mode 100644 index 00000000..429dc13d --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.js @@ -0,0 +1,25 @@ +var classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger = +[ + [ "ConvergenceFailureTrigger", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#a63010d8ba73689dda0c2228a1462aae2", null ], + [ "abs_failure", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#a5ae9ce66d4bbafd83145f8545a32d33a", null ], + [ "check", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#ae8765656a45319335c2bb90c3fb3d308", null ], + [ "current_mean", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#a3d8d9eafff17ea6a283afbc7e8b450bb", null ], + [ "describe", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#aa2bb19e4a1e24f6fd7f86d0c80ebbec3", null ], + [ "name", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#a92a57cea3b58bd7948c3c3fb4f75619b", null ], + [ "numMisses", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#aa26bf911c73b7f2ec343d473caf13718", null ], + [ "numTriggers", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#aa7cc311316539b2d348422ba907dc64e", null ], + [ "rel_failure", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#a4180dc6761c073acd82583a834ca09fd", null ], + [ "reset", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#a0bcab0247b3db618b76bd6769cf9a2ea", null ], + [ "step", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#aaef2090ed67a7c27967821f75a61e524", null ], + [ "update", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#ae47bbdf6edae798f30866c1ac4104cc1", null ], + [ "why", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#aedd397b71cd5b1ad26a0b21a34cf5631", null ], + [ "m_hits", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#afd5c9867790fc5ef453bc6a5e5494766", null ], + [ "m_logger", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#abb65f2fb74ea74a7f078b4e14f8bc949", null ], + [ "m_misses", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#a1b28f79b7d5d4b6a947bdf75c049739f", null ], + [ "m_relativeFailureRate", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#a19795b0ebf01df3e70fe858cfb527d08", null ], + [ "m_resets", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#a270dae9d1f4e3ee410389e113d7f0857", null ], + [ "m_totalFailures", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#a9e116ac645ba31906dae26234c47c3f4", null ], + [ "m_updates", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#acf63dd6e786231ac6c16e590d01bc6eb", null ], + [ "m_window", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#a8df9f55e0af1a16ee56678a109f08920", null ], + [ "m_windowSize", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html#abf4814a4423cfbe816b07d5eea4efea4", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__coll__graph.map b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__coll__graph.map new file mode 100644 index 00000000..f8f90e58 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__coll__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__coll__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__coll__graph.md5 new file mode 100644 index 00000000..5c662497 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__coll__graph.md5 @@ -0,0 +1 @@ +8e2453d485fcbf45cada605be2c64b45 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__coll__graph.svg b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__coll__graph.svg new file mode 100644 index 00000000..55d4d1d5 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__coll__graph.svg @@ -0,0 +1,88 @@ + + + + + + + + + + + +gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger + + +Node1 + + +gridfire::trigger:: +solver::CVODE::Convergence +FailureTrigger + + + + + +Node2 + + +gridfire::trigger:: +Trigger< gridfire::solver +::CVODESolverStrategy::Timestep +Context > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::deque< size_t > + + + + + +Node3->Node1 + + + + + + m_window + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__coll__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__coll__graph_org.svg new file mode 100644 index 00000000..66b6332b --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__coll__graph_org.svg @@ -0,0 +1,63 @@ + + + + + + +gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger + + +Node1 + + +gridfire::trigger:: +solver::CVODE::Convergence +FailureTrigger + + + + + +Node2 + + +gridfire::trigger:: +Trigger< gridfire::solver +::CVODESolverStrategy::Timestep +Context > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::deque< size_t > + + + + + +Node3->Node1 + + + + + + m_window + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__inherit__graph.map b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__inherit__graph.map new file mode 100644 index 00000000..09c6c949 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__inherit__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__inherit__graph.md5 new file mode 100644 index 00000000..cda617b9 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__inherit__graph.md5 @@ -0,0 +1 @@ +f6d931732004b1744c0ddf96f0207aef \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__inherit__graph.svg b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__inherit__graph.svg new file mode 100644 index 00000000..f62bb565 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__inherit__graph.svg @@ -0,0 +1,69 @@ + + + + + + + + + + + +gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger + + +Node1 + + +gridfire::trigger:: +solver::CVODE::Convergence +FailureTrigger + + + + + +Node2 + + +gridfire::trigger:: +Trigger< gridfire::solver +::CVODESolverStrategy::Timestep +Context > + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__inherit__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__inherit__graph_org.svg new file mode 100644 index 00000000..1f72b0ff --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger__inherit__graph_org.svg @@ -0,0 +1,44 @@ + + + + + + +gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger + + +Node1 + + +gridfire::trigger:: +solver::CVODE::Convergence +FailureTrigger + + + + + +Node2 + + +gridfire::trigger:: +Trigger< gridfire::solver +::CVODESolverStrategy::Timestep +Context > + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger-members.html b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger-members.html new file mode 100644 index 00000000..d54580e3 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger-members.html @@ -0,0 +1,127 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::trigger::solver::CVODE::OffDiagonalTrigger Member List
+
+
+ +

This is the complete list of members for gridfire::trigger::solver::CVODE::OffDiagonalTrigger, including all inherited members.

+ + + + + + + + + + + + + + + + + + +
check(const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const overridegridfire::trigger::solver::CVODE::OffDiagonalTriggervirtual
describe() const overridegridfire::trigger::solver::CVODE::OffDiagonalTriggervirtual
m_hitsgridfire::trigger::solver::CVODE::OffDiagonalTriggermutableprivate
m_loggergridfire::trigger::solver::CVODE::OffDiagonalTriggerprivate
m_missesgridfire::trigger::solver::CVODE::OffDiagonalTriggermutableprivate
m_resetsgridfire::trigger::solver::CVODE::OffDiagonalTriggermutableprivate
m_thresholdgridfire::trigger::solver::CVODE::OffDiagonalTriggerprivate
m_updatesgridfire::trigger::solver::CVODE::OffDiagonalTriggermutableprivate
name() const overridegridfire::trigger::solver::CVODE::OffDiagonalTriggervirtual
numMisses() const overridegridfire::trigger::solver::CVODE::OffDiagonalTriggervirtual
numTriggers() const overridegridfire::trigger::solver::CVODE::OffDiagonalTriggervirtual
OffDiagonalTrigger(double threshold)gridfire::trigger::solver::CVODE::OffDiagonalTriggerexplicit
reset() overridegridfire::trigger::solver::CVODE::OffDiagonalTriggervirtual
step(const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) overridegridfire::trigger::solver::CVODE::OffDiagonalTriggervirtual
update(const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) overridegridfire::trigger::solver::CVODE::OffDiagonalTriggervirtual
why(const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const overridegridfire::trigger::solver::CVODE::OffDiagonalTriggervirtual
~Trigger()=defaultgridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >virtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html new file mode 100644 index 00000000..99446e07 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html @@ -0,0 +1,672 @@ + + + + + + + +GridFire: gridfire::trigger::solver::CVODE::OffDiagonalTrigger Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
gridfire::trigger::solver::CVODE::OffDiagonalTrigger Class Referencefinal
+
+
+ +

Triggers when any off-diagonal Jacobian entry magnitude exceeds a threshold. + More...

+ +

#include <engine_partitioning_trigger.h>

+
+Inheritance diagram for gridfire::trigger::solver::CVODE::OffDiagonalTrigger:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::trigger::solver::CVODE::OffDiagonalTrigger:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+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
 
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.
 
std::string describe () const override
 Textual description including configured threshold.
 
size_t numTriggers () const override
 Number of true evaluations since last reset.
 
size_t numMisses () const override
 Number of false evaluations since last reset.
 
- Public Member Functions inherited from gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >
virtual ~Trigger ()=default
 Virtual destructor for polymorphic use.
 
+ + + + + + + + + + + + + + + + +

+Private Attributes

quill::Logger * m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
 Logger used for trace/error diagnostics.
 
double m_threshold
 Off-diagonal magnitude threshold (>= 0).
 
Diagnostics counters
size_t m_hits = 0
 
size_t m_misses = 0
 
size_t m_updates = 0
 
size_t m_resets = 0
 
+

Detailed Description

+

Triggers when any off-diagonal Jacobian entry magnitude exceeds a threshold.

+

Semantics:

    +
  • Iterates over all species pairs (row != col) and queries the engine's Jacobian via ctx.engine.getJacobianMatrixEntry(row, col). If any |entry| > threshold, check(ctx) returns true (short-circuits on first exceedance).
    • +
  • update(ctx) only records an update counter; it does not cache Jacobian values.
    • +
+
Note
Complexity: O(S^2) per check for S species (due to dense scan).
+
Constraints/Errors:
    +
  • Constructing with threshold < 0 throws std::invalid_argument.
    • +
+
+
See also
+
+

Constructor & Destructor Documentation

+ +

◆ OffDiagonalTrigger()

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::trigger::solver::CVODE::OffDiagonalTrigger::OffDiagonalTrigger (double threshold)
+ 		+explicit
+
+ +

Construct with a non-negative magnitude threshold.

+
Parameters
+ + +
thresholdOff-diagonal Jacobian magnitude threshold (>= 0).
+
+
+
Exceptions
+ + +
std::invalid_argumentif threshold < 0.
+
+
+ +
+
+

Member Function Documentation

+ +

◆ check()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::trigger::solver::CVODE::OffDiagonalTrigger::check (const gridfire::solver::CVODESolverStrategy::TimestepContext & ctx) const
+ 		+overridevirtual
+
+ +

Check if any off-diagonal Jacobian entry exceeds the threshold.

+
Parameters
+ + +
ctxCVODE timestep context providing access to engine species and Jacobian.
+
+
+
Returns
true if max_{i!=j} |J(i,j)| > threshold; false otherwise.
+
Postcondition
increments hit/miss counters and may emit trace logs.
+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ describe()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::trigger::solver::CVODE::OffDiagonalTrigger::describe () const
+ 		+overridevirtual
+
+ +

Textual description including configured threshold.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::trigger::solver::CVODE::OffDiagonalTrigger::name () const
+ 		+overridevirtual
+
+ +

Stable human-readable name.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ numMisses()

+ +
+
+ + + + + +
+ + + + + + + +
size_t gridfire::trigger::solver::CVODE::OffDiagonalTrigger::numMisses () const
+ 		+overridevirtual
+
+ +

Number of false evaluations since last reset.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ numTriggers()

+ +
+
+ + + + + +
+ + + + + + + +
size_t gridfire::trigger::solver::CVODE::OffDiagonalTrigger::numTriggers () const
+ 		+overridevirtual
+
+ +

Number of true evaluations since last reset.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ reset()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::trigger::solver::CVODE::OffDiagonalTrigger::reset ()
+ 		+overridevirtual
+
+ +

Reset counters to zero.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ step()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::trigger::solver::CVODE::OffDiagonalTrigger::step (const gridfire::solver::CVODESolverStrategy::TimestepContext & ctx)
+ 		+overridevirtual
+
+ +

similar to update but intended to be run on every step not just those where the trigger triggered

+
Parameters
+ + +
ctxContext snapshot used to update state.
+
+
+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ update()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::trigger::solver::CVODE::OffDiagonalTrigger::update (const gridfire::solver::CVODESolverStrategy::TimestepContext & ctx)
+ 		+overridevirtual
+
+ +

Record an update; does not mutate any Jacobian-related state.

+
Parameters
+ + +
ctxCVODE timestep context (unused except for symmetry with interface).
+
+
+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ why()

+ +
+
+ + + + + +
+ + + + + + + + +
TriggerResult gridfire::trigger::solver::CVODE::OffDiagonalTrigger::why (const gridfire::solver::CVODESolverStrategy::TimestepContext & ctx) const
+ 		+overridevirtual
+
+ +

Structured explanation of the evaluation outcome.

+
Parameters
+ + +
ctxCVODE timestep context.
+
+
+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+

Member Data Documentation

+ +

◆ m_hits

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::OffDiagonalTrigger::m_hits = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::trigger::solver::CVODE::OffDiagonalTrigger::m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +

Logger used for trace/error diagnostics.

+ +
+
+ +

◆ m_misses

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::OffDiagonalTrigger::m_misses = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_resets

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::OffDiagonalTrigger::m_resets = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_threshold

+ +
+
+ + + + + +
+ + + + +
double gridfire::trigger::solver::CVODE::OffDiagonalTrigger::m_threshold
+ 		+private
+
+ +

Off-diagonal magnitude threshold (>= 0).

+ +
+
+ +

◆ m_updates

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::OffDiagonalTrigger::m_updates = 0
+ 		+mutableprivate
+
+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.js b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.js new file mode 100644 index 00000000..99d2d249 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.js @@ -0,0 +1,19 @@ +var classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger = +[ + [ "OffDiagonalTrigger", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html#a6dc334b85ffb822880c6740dc457ea52", null ], + [ "check", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html#a3855b15459217383647ecdf12bc35775", null ], + [ "describe", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html#ad0dd92f9da6c291c3bd57c0983940035", null ], + [ "name", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html#a594893c029f044be3119118808470f7a", null ], + [ "numMisses", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html#a0e1ad148f9f3232992a4b16e440c249a", null ], + [ "numTriggers", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html#a32980aaf6d9c7632c024b4b74b1d9e70", null ], + [ "reset", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html#a9b782cbf033ed2023da6b2d55dcefc4e", null ], + [ "step", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html#a8b882c6ba6e267d7051031140bbb7ad6", null ], + [ "update", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html#a179cb09a91d5c638d7a347137b208767", null ], + [ "why", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html#a3af973e466ba62ebf1e41c608355e327", null ], + [ "m_hits", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html#a0d3b7c1d1057f442417c2f8c2a7177c5", null ], + [ "m_logger", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html#afbd9258d65370bbc965e799c82f0e1c0", null ], + [ "m_misses", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html#a14b1884a9014df33a1ec90dd3433c0b9", null ], + [ "m_resets", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html#acd55d04da377c8bf4af3ea2fcf2f1918", null ], + [ "m_threshold", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html#aeac341c1e854d561a29aa39ad306d5d7", null ], + [ "m_updates", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html#a4885bdcc719a0f8c8394905893739b96", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__coll__graph.map b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__coll__graph.map new file mode 100644 index 00000000..78e40909 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__coll__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__coll__graph.md5 new file mode 100644 index 00000000..08adb7f3 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__coll__graph.md5 @@ -0,0 +1 @@ +dc7ed0252102523aebe3f22e6574bac3 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__coll__graph.svg b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__coll__graph.svg new file mode 100644 index 00000000..1ccc8b36 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__coll__graph.svg @@ -0,0 +1,69 @@ + + + + + + + + + + + +gridfire::trigger::solver::CVODE::OffDiagonalTrigger + + +Node1 + + +gridfire::trigger:: +solver::CVODE::OffDiagonal +Trigger + + + + + +Node2 + + +gridfire::trigger:: +Trigger< gridfire::solver +::CVODESolverStrategy::Timestep +Context > + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__coll__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__coll__graph_org.svg new file mode 100644 index 00000000..1762f6be --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__coll__graph_org.svg @@ -0,0 +1,44 @@ + + + + + + +gridfire::trigger::solver::CVODE::OffDiagonalTrigger + + +Node1 + + +gridfire::trigger:: +solver::CVODE::OffDiagonal +Trigger + + + + + +Node2 + + +gridfire::trigger:: +Trigger< gridfire::solver +::CVODESolverStrategy::Timestep +Context > + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__inherit__graph.map b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__inherit__graph.map new file mode 100644 index 00000000..78e40909 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__inherit__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__inherit__graph.md5 new file mode 100644 index 00000000..08adb7f3 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__inherit__graph.md5 @@ -0,0 +1 @@ +dc7ed0252102523aebe3f22e6574bac3 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__inherit__graph.svg b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__inherit__graph.svg new file mode 100644 index 00000000..1ccc8b36 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__inherit__graph.svg @@ -0,0 +1,69 @@ + + + + + + + + + + + +gridfire::trigger::solver::CVODE::OffDiagonalTrigger + + +Node1 + + +gridfire::trigger:: +solver::CVODE::OffDiagonal +Trigger + + + + + +Node2 + + +gridfire::trigger:: +Trigger< gridfire::solver +::CVODESolverStrategy::Timestep +Context > + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__inherit__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__inherit__graph_org.svg new file mode 100644 index 00000000..1762f6be --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger__inherit__graph_org.svg @@ -0,0 +1,44 @@ + + + + + + +gridfire::trigger::solver::CVODE::OffDiagonalTrigger + + +Node1 + + +gridfire::trigger:: +solver::CVODE::OffDiagonal +Trigger + + + + + +Node2 + + +gridfire::trigger:: +Trigger< gridfire::solver +::CVODESolverStrategy::Timestep +Context > + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger-members.html b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger-members.html new file mode 100644 index 00000000..737c2a6e --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger-members.html @@ -0,0 +1,129 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::trigger::solver::CVODE::SimulationTimeTrigger Member List
+
+
+ +

This is the complete list of members for gridfire::trigger::solver::CVODE::SimulationTimeTrigger, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + +
check(const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const overridegridfire::trigger::solver::CVODE::SimulationTimeTriggervirtual
describe() const overridegridfire::trigger::solver::CVODE::SimulationTimeTriggervirtual
m_hitsgridfire::trigger::solver::CVODE::SimulationTimeTriggermutableprivate
m_intervalgridfire::trigger::solver::CVODE::SimulationTimeTriggerprivate
m_last_trigger_timegridfire::trigger::solver::CVODE::SimulationTimeTriggermutableprivate
m_last_trigger_time_deltagridfire::trigger::solver::CVODE::SimulationTimeTriggermutableprivate
m_loggergridfire::trigger::solver::CVODE::SimulationTimeTriggerprivate
m_missesgridfire::trigger::solver::CVODE::SimulationTimeTriggermutableprivate
m_resetsgridfire::trigger::solver::CVODE::SimulationTimeTriggermutableprivate
m_updatesgridfire::trigger::solver::CVODE::SimulationTimeTriggermutableprivate
name() const overridegridfire::trigger::solver::CVODE::SimulationTimeTriggervirtual
numMisses() const overridegridfire::trigger::solver::CVODE::SimulationTimeTriggervirtual
numTriggers() const overridegridfire::trigger::solver::CVODE::SimulationTimeTriggervirtual
reset() overridegridfire::trigger::solver::CVODE::SimulationTimeTriggervirtual
SimulationTimeTrigger(double interval)gridfire::trigger::solver::CVODE::SimulationTimeTriggerexplicit
step(const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) overridegridfire::trigger::solver::CVODE::SimulationTimeTriggervirtual
update(const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) overridegridfire::trigger::solver::CVODE::SimulationTimeTriggervirtual
why(const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const overridegridfire::trigger::solver::CVODE::SimulationTimeTriggervirtual
~Trigger()=defaultgridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >virtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html new file mode 100644 index 00000000..fedf19ee --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html @@ -0,0 +1,726 @@ + + + + + + + +GridFire: gridfire::trigger::solver::CVODE::SimulationTimeTrigger Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
gridfire::trigger::solver::CVODE::SimulationTimeTrigger Class Referencefinal
+
+
+ +

Triggers when the current simulation time advances by at least a fixed interval. + More...

+ +

#include <engine_partitioning_trigger.h>

+
+Inheritance diagram for gridfire::trigger::solver::CVODE::SimulationTimeTrigger:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::trigger::solver::CVODE::SimulationTimeTrigger:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+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
 
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.
 
std::string describe () const override
 Textual description including configured interval.
 
size_t numTriggers () const override
 Number of true evaluations since last reset.
 
size_t numMisses () const override
 Number of false evaluations since last reset.
 
- Public Member Functions inherited from gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >
virtual ~Trigger ()=default
 Virtual destructor for polymorphic use.
 
+ + + + + + + + + + + + + + + + + + + + + + +

+Private Attributes

quill::Logger * m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
 Logger used for trace/error diagnostics.
 
double m_interval
 Required time interval between successive triggers.
 
double m_last_trigger_time = 0.0
 Time at which the trigger last fired; initialized to 0.
 
double m_last_trigger_time_delta = 0.0
 Overshoot relative to interval at the last firing; for diagnostics.
 
Diagnostics counters
size_t m_hits = 0
 
size_t m_misses = 0
 
size_t m_updates = 0
 
size_t m_resets = 0
 
+

Detailed Description

+

Triggers when the current simulation time advances by at least a fixed interval.

+
    +
  • check(ctx) returns true when (ctx.t - last_trigger_time) >= interval.
    • +
  • update(ctx) will, if check(ctx) is true, record ctx.t as the new last_trigger_time and store a small delta relative to the configured interval (for diagnostics/logging).
    • +
  • Counters (hits/misses/updates/resets) are maintained for diagnostics; they are mutable to allow updates from const check().
    • +
+
Constraints/Errors:
    +
  • Constructing with a non-positive interval throws std::invalid_argument.
    • +
+
+
Note
Thread-safety: not thread-safe; intended for single-threaded trigger evaluation.
+

See also: engine_partitioning_trigger.cpp for the concrete logic and logging.

+

Constructor & Destructor Documentation

+ +

◆ SimulationTimeTrigger()

+ +
+
+ + + + + +
+ + + + + + + + +
gridfire::trigger::solver::CVODE::SimulationTimeTrigger::SimulationTimeTrigger (double interval)
+ 		+explicit
+
+ +

Construct with a positive time interval between firings.

+
Parameters
+ + +
intervalStrictly positive time interval (simulation units) between triggers.
+
+
+
Exceptions
+ + +
std::invalid_argumentif interval <= 0.
+
+
+ +
+
+

Member Function Documentation

+ +

◆ check()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::trigger::solver::CVODE::SimulationTimeTrigger::check (const gridfire::solver::CVODESolverStrategy::TimestepContext & ctx) const
+ 		+overridevirtual
+
+ +

Evaluate whether enough simulated time has elapsed since the last trigger.

+
Parameters
+ + +
ctxCVODE timestep context providing the current simulation time (ctx.t).
+
+
+
Returns
true if (ctx.t - last_trigger_time) >= interval; false otherwise.
+
Postcondition
increments hit/miss counters and may emit trace logs.
+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ describe()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::trigger::solver::CVODE::SimulationTimeTrigger::describe () const
+ 		+overridevirtual
+
+ +

Textual description including configured interval.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::trigger::solver::CVODE::SimulationTimeTrigger::name () const
+ 		+overridevirtual
+
+ +

Stable human-readable name.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ numMisses()

+ +
+
+ + + + + +
+ + + + + + + +
size_t gridfire::trigger::solver::CVODE::SimulationTimeTrigger::numMisses () const
+ 		+overridevirtual
+
+ +

Number of false evaluations since last reset.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ numTriggers()

+ +
+
+ + + + + +
+ + + + + + + +
size_t gridfire::trigger::solver::CVODE::SimulationTimeTrigger::numTriggers () const
+ 		+overridevirtual
+
+ +

Number of true evaluations since last reset.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ reset()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::trigger::solver::CVODE::SimulationTimeTrigger::reset ()
+ 		+overridevirtual
+
+ +

Reset counters and last trigger bookkeeping (time and delta) to zero.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ step()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::trigger::solver::CVODE::SimulationTimeTrigger::step (const gridfire::solver::CVODESolverStrategy::TimestepContext & ctx)
+ 		+overridevirtual
+
+ +

similar to update but intended to be run on every step not just those where the trigger triggered

+
Parameters
+ + +
ctxContext snapshot used to update state.
+
+
+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ update()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::trigger::solver::CVODE::SimulationTimeTrigger::update (const gridfire::solver::CVODESolverStrategy::TimestepContext & ctx)
+ 		+overridevirtual
+
+ +

Update internal state; if check(ctx) is true, advance last_trigger_time.

+
Parameters
+ + +
ctxCVODE timestep context.
+
+
+
Note
update() calls check(ctx) and, on success, records the overshoot delta (ctx.t - last_trigger_time) - interval for diagnostics.
+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ why()

+ +
+
+ + + + + +
+ + + + + + + + +
TriggerResult gridfire::trigger::solver::CVODE::SimulationTimeTrigger::why (const gridfire::solver::CVODESolverStrategy::TimestepContext & ctx) const
+ 		+overridevirtual
+
+ +

Structured explanation of the evaluation outcome.

+
Parameters
+ + +
ctxCVODE timestep context.
+
+
+
Returns
TriggerResult including name, value, and description.
+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+

Member Data Documentation

+ +

◆ m_hits

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::SimulationTimeTrigger::m_hits = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_interval

+ +
+
+ + + + + +
+ + + + +
double gridfire::trigger::solver::CVODE::SimulationTimeTrigger::m_interval
+ 		+private
+
+ +

Required time interval between successive triggers.

+ +
+
+ +

◆ m_last_trigger_time

+ +
+
+ + + + + +
+ + + + +
double gridfire::trigger::solver::CVODE::SimulationTimeTrigger::m_last_trigger_time = 0.0
+ 		+mutableprivate
+
+ +

Time at which the trigger last fired; initialized to 0.

+ +
+
+ +

◆ m_last_trigger_time_delta

+ +
+
+ + + + + +
+ + + + +
double gridfire::trigger::solver::CVODE::SimulationTimeTrigger::m_last_trigger_time_delta = 0.0
+ 		+mutableprivate
+
+ +

Overshoot relative to interval at the last firing; for diagnostics.

+ +
+
+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::trigger::solver::CVODE::SimulationTimeTrigger::m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +

Logger used for trace/error diagnostics.

+ +
+
+ +

◆ m_misses

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::SimulationTimeTrigger::m_misses = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_resets

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::SimulationTimeTrigger::m_resets = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_updates

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::SimulationTimeTrigger::m_updates = 0
+ 		+mutableprivate
+
+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.js b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.js new file mode 100644 index 00000000..37b0f783 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.js @@ -0,0 +1,21 @@ +var classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger = +[ + [ "SimulationTimeTrigger", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#a235f84a37370a1ca2226fb881b4051c7", null ], + [ "check", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#a50df7fefee167390522aa258fa6ee960", null ], + [ "describe", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#a0f412b8f788ab7990e353d62ab7d9a16", null ], + [ "name", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#a87fc9fe6bd8762f148c858452ec30043", null ], + [ "numMisses", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#a273eb8a3e80d1235d2b3f252e55c5b50", null ], + [ "numTriggers", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#a34d285584ea96f71b99eefad8c738296", null ], + [ "reset", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#af4034fa431e6c88fd05c50cce31b2fa0", null ], + [ "step", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#aafc7f40bde2c78f4d100b6f9da771831", null ], + [ "update", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#a468bf58f66417493501c59d7a8aabc98", null ], + [ "why", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#a9dfab0b765d3a4c362cecd860d59f58a", null ], + [ "m_hits", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#a2b1b4a9ef137e76d39e7a7dcb6cf725d", null ], + [ "m_interval", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#ab6215873390f6bedab5c9f83b990b5e0", null ], + [ "m_last_trigger_time", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#a51ac3899010c2790fc98801ffba9407e", null ], + [ "m_last_trigger_time_delta", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#ab93cb25bbebb159a8608a737bd972abd", null ], + [ "m_logger", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#a16e9b87a8abb05bb6b5410903eb49e91", null ], + [ "m_misses", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#a00ede9fff51a8318913fd2ed504c1007", null ], + [ "m_resets", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#a3004a10bb89ecd7b2ba6103c9f5d4b96", null ], + [ "m_updates", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#ab80799eb7c80b3b20c1a7e7f9e1f5030", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__coll__graph.map b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__coll__graph.map new file mode 100644 index 00000000..9b65426d --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__coll__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__coll__graph.md5 new file mode 100644 index 00000000..d52128ad --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__coll__graph.md5 @@ -0,0 +1 @@ +b1e2c9a7b9605e9ba29d6d115445bef8 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__coll__graph.svg b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__coll__graph.svg new file mode 100644 index 00000000..c31de017 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__coll__graph.svg @@ -0,0 +1,69 @@ + + + + + + + + + + + +gridfire::trigger::solver::CVODE::SimulationTimeTrigger + + +Node1 + + +gridfire::trigger:: +solver::CVODE::SimulationTime +Trigger + + + + + +Node2 + + +gridfire::trigger:: +Trigger< gridfire::solver +::CVODESolverStrategy::Timestep +Context > + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__coll__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__coll__graph_org.svg new file mode 100644 index 00000000..8595f08e --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__coll__graph_org.svg @@ -0,0 +1,44 @@ + + + + + + +gridfire::trigger::solver::CVODE::SimulationTimeTrigger + + +Node1 + + +gridfire::trigger:: +solver::CVODE::SimulationTime +Trigger + + + + + +Node2 + + +gridfire::trigger:: +Trigger< gridfire::solver +::CVODESolverStrategy::Timestep +Context > + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__inherit__graph.map b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__inherit__graph.map new file mode 100644 index 00000000..9b65426d --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__inherit__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__inherit__graph.md5 new file mode 100644 index 00000000..d52128ad --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__inherit__graph.md5 @@ -0,0 +1 @@ +b1e2c9a7b9605e9ba29d6d115445bef8 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__inherit__graph.svg b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__inherit__graph.svg new file mode 100644 index 00000000..c31de017 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__inherit__graph.svg @@ -0,0 +1,69 @@ + + + + + + + + + + + +gridfire::trigger::solver::CVODE::SimulationTimeTrigger + + +Node1 + + +gridfire::trigger:: +solver::CVODE::SimulationTime +Trigger + + + + + +Node2 + + +gridfire::trigger:: +Trigger< gridfire::solver +::CVODESolverStrategy::Timestep +Context > + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__inherit__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__inherit__graph_org.svg new file mode 100644 index 00000000..8595f08e --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger__inherit__graph_org.svg @@ -0,0 +1,44 @@ + + + + + + +gridfire::trigger::solver::CVODE::SimulationTimeTrigger + + +Node1 + + +gridfire::trigger:: +solver::CVODE::SimulationTime +Trigger + + + + + +Node2 + + +gridfire::trigger:: +Trigger< gridfire::solver +::CVODESolverStrategy::Timestep +Context > + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger-members.html b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger-members.html new file mode 100644 index 00000000..872d160e --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger-members.html @@ -0,0 +1,131 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::trigger::solver::CVODE::TimestepCollapseTrigger Member List
+
+
+ +

This is the complete list of members for gridfire::trigger::solver::CVODE::TimestepCollapseTrigger, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + +
check(const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const overridegridfire::trigger::solver::CVODE::TimestepCollapseTriggervirtual
describe() const overridegridfire::trigger::solver::CVODE::TimestepCollapseTriggervirtual
m_hitsgridfire::trigger::solver::CVODE::TimestepCollapseTriggermutableprivate
m_loggergridfire::trigger::solver::CVODE::TimestepCollapseTriggerprivate
m_missesgridfire::trigger::solver::CVODE::TimestepCollapseTriggermutableprivate
m_relativegridfire::trigger::solver::CVODE::TimestepCollapseTriggerprivate
m_resetsgridfire::trigger::solver::CVODE::TimestepCollapseTriggermutableprivate
m_thresholdgridfire::trigger::solver::CVODE::TimestepCollapseTriggerprivate
m_timestep_windowgridfire::trigger::solver::CVODE::TimestepCollapseTriggerprivate
m_updatesgridfire::trigger::solver::CVODE::TimestepCollapseTriggermutableprivate
m_windowSizegridfire::trigger::solver::CVODE::TimestepCollapseTriggerprivate
name() const overridegridfire::trigger::solver::CVODE::TimestepCollapseTriggervirtual
numMisses() const overridegridfire::trigger::solver::CVODE::TimestepCollapseTriggervirtual
numTriggers() const overridegridfire::trigger::solver::CVODE::TimestepCollapseTriggervirtual
reset() overridegridfire::trigger::solver::CVODE::TimestepCollapseTriggervirtual
step(const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) overridegridfire::trigger::solver::CVODE::TimestepCollapseTriggervirtual
TimestepCollapseTrigger(double threshold, bool relative)gridfire::trigger::solver::CVODE::TimestepCollapseTriggerexplicit
TimestepCollapseTrigger(double threshold, bool relative, size_t windowSize)gridfire::trigger::solver::CVODE::TimestepCollapseTriggerexplicit
update(const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) overridegridfire::trigger::solver::CVODE::TimestepCollapseTriggervirtual
why(const gridfire::solver::CVODESolverStrategy::TimestepContext &ctx) const overridegridfire::trigger::solver::CVODE::TimestepCollapseTriggervirtual
~Trigger()=defaultgridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >virtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html new file mode 100644 index 00000000..a6c62c2c --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html @@ -0,0 +1,830 @@ + + + + + + + +GridFire: gridfire::trigger::solver::CVODE::TimestepCollapseTrigger Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
gridfire::trigger::solver::CVODE::TimestepCollapseTrigger Class Referencefinal
+
+
+ +

Triggers when the timestep deviates from its recent average beyond a threshold. + More...

+ +

#include <engine_partitioning_trigger.h>

+
+Inheritance diagram for gridfire::trigger::solver::CVODE::TimestepCollapseTrigger:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::trigger::solver::CVODE::TimestepCollapseTrigger:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 TimestepCollapseTrigger (double threshold, bool relative)
 Construct with threshold and relative/absolute mode; window size defaults to 1.
 
 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
 
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.
 
std::string describe () const override
 Textual description including threshold, mode, and window size.
 
size_t numTriggers () const override
 Number of true evaluations since last reset.
 
size_t numMisses () const override
 Number of false evaluations since last reset.
 
- Public Member Functions inherited from gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >
virtual ~Trigger ()=default
 Virtual destructor for polymorphic use.
 
+ + + + + + + + + + + + + + + + + + + + + + + + + +

+Private Attributes

quill::Logger * m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
 Logger used for trace/error diagnostics.
 
double m_threshold
 Threshold for absolute or relative deviation.
 
bool m_relative
 When true, use relative deviation; otherwise absolute deviation.
 
size_t m_windowSize
 Number of dt samples to maintain in the moving window.
 
std::deque< double > m_timestep_window
 Sliding window of recent timesteps (most recent at back).
 
Diagnostics counters
size_t m_hits = 0
 
size_t m_misses = 0
 
size_t m_updates = 0
 
size_t m_resets = 0
 
+

Detailed Description

+

Triggers when the timestep deviates from its recent average beyond a threshold.

+
    +
  • Maintains a sliding window of recent dt values (size = windowSize).
    • +
  • check(ctx):
      +
    • If the window is empty, returns false.
      • +
    • Computes the arithmetic mean of values in the window and compares either:
        +
      • relative: |dt - mean| / mean >= threshold
        • +
      • absolute: |dt - mean| >= threshold
        • +
      +
      • +
    +
    • +
  • update(ctx): pushes ctx.dt into the fixed-size window (dropping oldest when full).
    • +
+
Constraints/Errors:
    +
  • threshold must be >= 0.
    • +
  • If relative==true, threshold must be in [0, 1]. Violations throw std::invalid_argument.
    • +
+
+
Note
    +
  • With windowSize==1, the mean is the most recent prior dt.
    • +
  • Counter fields are mutable to allow updates during const check().
    • +
+
+

See also: engine_partitioning_trigger.cpp for exact logic and logging.

+

Constructor & Destructor Documentation

+ +

◆ TimestepCollapseTrigger() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::TimestepCollapseTrigger (double threshold,
bool relative 
)
+ 		+explicit
+
+ +

Construct with threshold and relative/absolute mode; window size defaults to 1.

+
Parameters
+ + + +
thresholdNon-negative threshold; if relative, must be in [0, 1].
relativeIf true, use relative deviation; otherwise use absolute deviation.
+
+
+
Exceptions
+ + +
std::invalid_argumenton invalid threshold constraints.
+
+
+ +
+
+ +

◆ TimestepCollapseTrigger() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::TimestepCollapseTrigger (double threshold,
bool relative,
size_t windowSize 
)
+ 		+explicit
+
+ +

Construct with threshold, mode, and window size.

+
Parameters
+ + + + +
thresholdNon-negative threshold; if relative, must be in [0, 1].
relativeIf true, use relative deviation; otherwise use absolute deviation.
windowSizeNumber of dt samples to average over (>= 1 recommended).
+
+
+
Exceptions
+ + +
std::invalid_argumenton invalid threshold constraints.
+
+
+ +
+
+

Member Function Documentation

+ +

◆ check()

+ +
+
+ + + + + +
+ + + + + + + + +
bool gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::check (const gridfire::solver::CVODESolverStrategy::TimestepContext & ctx) const
+ 		+overridevirtual
+
+ +

Evaluate whether the current dt deviates sufficiently from recent average.

+
Parameters
+ + +
ctxCVODE timestep context providing current dt.
+
+
+
Returns
true if deviation exceeds the configured threshold; false otherwise.
+
Postcondition
increments hit/miss counters and may emit trace logs.
+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ describe()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::describe () const
+ 		+overridevirtual
+
+ +

Textual description including threshold, mode, and window size.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ name()

+ +
+
+ + + + + +
+ + + + + + + +
std::string gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::name () const
+ 		+overridevirtual
+
+ +

Stable human-readable name.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ numMisses()

+ +
+
+ + + + + +
+ + + + + + + +
size_t gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::numMisses () const
+ 		+overridevirtual
+
+ +

Number of false evaluations since last reset.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ numTriggers()

+ +
+
+ + + + + +
+ + + + + + + +
size_t gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::numTriggers () const
+ 		+overridevirtual
+
+ +

Number of true evaluations since last reset.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ reset()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::reset ()
+ 		+overridevirtual
+
+ +

Reset counters and clear the dt window.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ step()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::step (const gridfire::solver::CVODESolverStrategy::TimestepContext & ctx)
+ 		+overridevirtual
+
+ +

similar to update but intended to be run on every step not just those where the trigger triggered

+
Parameters
+ + +
ctxContext snapshot used to update state.
+
+
+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ update()

+ +
+
+ + + + + +
+ + + + + + + + +
void gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::update (const gridfire::solver::CVODESolverStrategy::TimestepContext & ctx)
+ 		+overridevirtual
+
+ +

Update sliding window with the most recent dt and increment update counter.

+
Parameters
+ + +
ctxCVODE timestep context.
+
+
+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+ +

◆ why()

+ +
+
+ + + + + +
+ + + + + + + + +
TriggerResult gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::why (const gridfire::solver::CVODESolverStrategy::TimestepContext & ctx) const
+ 		+overridevirtual
+
+ +

Structured explanation of the evaluation outcome.

+ +

Implements gridfire::trigger::Trigger< gridfire::solver::CVODESolverStrategy::TimestepContext >.

+ +
+
+

Member Data Documentation

+ +

◆ m_hits

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::m_hits = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_logger

+ +
+
+ + + + + +
+ + + + +
quill::Logger* gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +

Logger used for trace/error diagnostics.

+ +
+
+ +

◆ m_misses

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::m_misses = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_relative

+ +
+
+ + + + + +
+ + + + +
bool gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::m_relative
+ 		+private
+
+ +

When true, use relative deviation; otherwise absolute deviation.

+ +
+
+ +

◆ m_resets

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::m_resets = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_threshold

+ +
+
+ + + + + +
+ + + + +
double gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::m_threshold
+ 		+private
+
+ +

Threshold for absolute or relative deviation.

+ +
+
+ +

◆ m_timestep_window

+ +
+
+ + + + + +
+ + + + +
std::deque<double> gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::m_timestep_window
+ 		+private
+
+ +

Sliding window of recent timesteps (most recent at back).

+ +
+
+ +

◆ m_updates

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::m_updates = 0
+ 		+mutableprivate
+
+ +
+
+ +

◆ m_windowSize

+ +
+
+ + + + + +
+ + + + +
size_t gridfire::trigger::solver::CVODE::TimestepCollapseTrigger::m_windowSize
+ 		+private
+
+ +

Number of dt samples to maintain in the moving window.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.js b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.js new file mode 100644 index 00000000..096e1b63 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.js @@ -0,0 +1,23 @@ +var classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger = +[ + [ "TimestepCollapseTrigger", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#a171e6dee7f7d8275b3e8875eaeb0850d", null ], + [ "TimestepCollapseTrigger", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#ae47a4f822f92774f6dc780ae74f12066", null ], + [ "check", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#a04598611b0807cad395bdd2fbc41a6c2", null ], + [ "describe", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#a8ba5a942bb61347851030d1eb6bbaa74", null ], + [ "name", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#a290e5643eea08726d2fd44a1cd5617d0", null ], + [ "numMisses", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#a94bb1de08a5ff55e1874f595f8c8965c", null ], + [ "numTriggers", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#ad2a7c2567b100f97a024f65818ecefed", null ], + [ "reset", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#a0fe6af73b11b820561bd4e5552890d4e", null ], + [ "step", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#a9723e389aeba05fdb3d4fd1dcc1ba07d", null ], + [ "update", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#af6bff6a484e8729445c26620b489665d", null ], + [ "why", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#a22d8bc7aacbc388108225c26158e918c", null ], + [ "m_hits", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#aff23db33140aa6a5a2ad36eda77b833d", null ], + [ "m_logger", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#abe902b2a42a6451f64497e075b0e0b25", null ], + [ "m_misses", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#a021c760717efef3fc3b415dee6d4840b", null ], + [ "m_relative", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#aa4162916f562b4d7ea0205d6f3e6f917", null ], + [ "m_resets", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#ad4cc7113574f71905bc93cc40024b4bd", null ], + [ "m_threshold", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#ab7d86e5c89a848cf238141393fe3a8de", null ], + [ "m_timestep_window", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#ae18e08a0bd72b68605d64e4d84355f79", null ], + [ "m_updates", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#a25f6ac369c590a8370270bdc70545171", null ], + [ "m_windowSize", "classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#aa03c13813065f720cf698c240f07d559", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__coll__graph.map b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__coll__graph.map new file mode 100644 index 00000000..658485f7 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__coll__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__coll__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__coll__graph.md5 new file mode 100644 index 00000000..baadbd84 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__coll__graph.md5 @@ -0,0 +1 @@ +1011c5dfd643757b29d0d68583705424 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__coll__graph.svg b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__coll__graph.svg new file mode 100644 index 00000000..c60b9e31 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__coll__graph.svg @@ -0,0 +1,145 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::trigger::solver::CVODE::TimestepCollapseTrigger + + +Node1 + + +gridfire::trigger:: +solver::CVODE::TimestepCollapse +Trigger + + + + + +Node2 + + +gridfire::trigger:: +Trigger< gridfire::solver +::CVODESolverStrategy::Timestep +Context > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::deque< double > + + + + + +Node3->Node1 + + + + + + m_timestep_window + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__coll__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__coll__graph_org.svg new file mode 100644 index 00000000..f28a3736 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__coll__graph_org.svg @@ -0,0 +1,63 @@ + + + + + + +gridfire::trigger::solver::CVODE::TimestepCollapseTrigger + + +Node1 + + +gridfire::trigger:: +solver::CVODE::TimestepCollapse +Trigger + + + + + +Node2 + + +gridfire::trigger:: +Trigger< gridfire::solver +::CVODESolverStrategy::Timestep +Context > + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::deque< double > + + + + + +Node3->Node1 + + + + + + m_timestep_window + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__inherit__graph.map b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__inherit__graph.map new file mode 100644 index 00000000..a60266f5 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__inherit__graph.md5 b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__inherit__graph.md5 new file mode 100644 index 00000000..7484c3f9 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__inherit__graph.md5 @@ -0,0 +1 @@ +a9cd968bf57b14b7ad059c17d6b56c6a \ No newline at end of file diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__inherit__graph.svg b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__inherit__graph.svg new file mode 100644 index 00000000..af7003e0 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__inherit__graph.svg @@ -0,0 +1,69 @@ + + + + + + + + + + + +gridfire::trigger::solver::CVODE::TimestepCollapseTrigger + + +Node1 + + +gridfire::trigger:: +solver::CVODE::TimestepCollapse +Trigger + + + + + +Node2 + + +gridfire::trigger:: +Trigger< gridfire::solver +::CVODESolverStrategy::Timestep +Context > + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__inherit__graph_org.svg b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__inherit__graph_org.svg new file mode 100644 index 00000000..59321fb8 --- /dev/null +++ b/docs/html/classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger__inherit__graph_org.svg @@ -0,0 +1,44 @@ + + + + + + +gridfire::trigger::solver::CVODE::TimestepCollapseTrigger + + +Node1 + + +gridfire::trigger:: +solver::CVODE::TimestepCollapse +Trigger + + + + + +Node2 + + +gridfire::trigger:: +Trigger< gridfire::solver +::CVODESolverStrategy::Timestep +Context > + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1utils_1_1Column-members.html b/docs/html/classgridfire_1_1utils_1_1Column-members.html new file mode 100644 index 00000000..33da528b --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Column-members.html @@ -0,0 +1,117 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::utils::Column< T > Member List
+
+
+ +

This is the complete list of members for gridfire::utils::Column< T >, including all inherited members.

+ + + + + + + + +
Column(std::string header, const std::vector< T > &data)gridfire::utils::Column< T >inline
getCellData(size_t rowIndex) const overridegridfire::utils::Column< T >inlinevirtual
getHeader() const overridegridfire::utils::Column< T >inlinevirtual
getRowCount() const overridegridfire::utils::Column< T >inlinevirtual
m_datagridfire::utils::Column< T >private
m_headergridfire::utils::Column< T >private
~ColumnBase()=defaultgridfire::utils::ColumnBasevirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1utils_1_1Column.html b/docs/html/classgridfire_1_1utils_1_1Column.html new file mode 100644 index 00000000..84df68aa --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Column.html @@ -0,0 +1,326 @@ + + + + + + + +GridFire: gridfire::utils::Column< T > Class Template Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
gridfire::utils::Column< T > Class Template Referencefinal
+
+
+ +

#include <table_format.h>

+
+Inheritance diagram for gridfire::utils::Column< T >:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::utils::Column< T >:
+
+
+
[legend]
+ + + + + + + + + + + + + +

+Public Member Functions

 Column (std::string header, const std::vector< T > &data)
 
std::string getCellData (size_t rowIndex) const override
 
std::string getHeader () const override
 
size_t getRowCount () const override
 
- Public Member Functions inherited from gridfire::utils::ColumnBase
virtual ~ColumnBase ()=default
 
+ + + + + +

+Private Attributes

std::string m_header
 
std::vector< T > m_data
 
+

Constructor & Destructor Documentation

+ +

◆ Column()

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
gridfire::utils::Column< T >::Column (std::string header,
const std::vector< T > & data 
)
+ 		+inline
+
+ +
+
+

Member Function Documentation

+ +

◆ getCellData()

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + + +
std::string gridfire::utils::Column< T >::getCellData (size_t rowIndex) const
+ 		+inlineoverridevirtual
+
+ +

Implements gridfire::utils::ColumnBase.

+ +
+
+ +

◆ getHeader()

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + +
std::string gridfire::utils::Column< T >::getHeader () const
+ 		+inlineoverridevirtual
+
+ +

Implements gridfire::utils::ColumnBase.

+ +
+
+ +

◆ getRowCount()

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + +
size_t gridfire::utils::Column< T >::getRowCount () const
+ 		+inlineoverridevirtual
+
+ +

Implements gridfire::utils::ColumnBase.

+ +
+
+

Member Data Documentation

+ +

◆ m_data

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + +
std::vector<T> gridfire::utils::Column< T >::m_data
+ 		+private
+
+ +
+
+ +

◆ m_header

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + +
std::string gridfire::utils::Column< T >::m_header
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1utils_1_1Column.js b/docs/html/classgridfire_1_1utils_1_1Column.js new file mode 100644 index 00000000..4aa1e910 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Column.js @@ -0,0 +1,9 @@ +var classgridfire_1_1utils_1_1Column = +[ + [ "Column", "classgridfire_1_1utils_1_1Column.html#a7d7e4f4cf6f8e03725afeb9f664321b8", null ], + [ "getCellData", "classgridfire_1_1utils_1_1Column.html#a5bd0ad730a684e1a8b583c5c27cca6e8", null ], + [ "getHeader", "classgridfire_1_1utils_1_1Column.html#ad6a4f9aee1321e90896e5f4583d7311f", null ], + [ "getRowCount", "classgridfire_1_1utils_1_1Column.html#a7ff9084a0486fb8b08edfe866480568b", null ], + [ "m_data", "classgridfire_1_1utils_1_1Column.html#aaa99c4d00c3b79e37f2e73e7c6854758", null ], + [ "m_header", "classgridfire_1_1utils_1_1Column.html#aaddf58469be3e3fd3bee0f4f660fe9e0", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1utils_1_1ColumnBase-members.html b/docs/html/classgridfire_1_1utils_1_1ColumnBase-members.html new file mode 100644 index 00000000..272cdb5d --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1ColumnBase-members.html @@ -0,0 +1,114 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::utils::ColumnBase Member List
+
+
+ +

This is the complete list of members for gridfire::utils::ColumnBase, including all inherited members.

+ + + + + +
getCellData(size_t rowIndex) const =0gridfire::utils::ColumnBasepure virtual
getHeader() const =0gridfire::utils::ColumnBasepure virtual
getRowCount() const =0gridfire::utils::ColumnBasepure virtual
~ColumnBase()=defaultgridfire::utils::ColumnBasevirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1utils_1_1ColumnBase.html b/docs/html/classgridfire_1_1utils_1_1ColumnBase.html new file mode 100644 index 00000000..c3498524 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1ColumnBase.html @@ -0,0 +1,242 @@ + + + + + + + +GridFire: gridfire::utils::ColumnBase Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::utils::ColumnBase Class Referenceabstract
+
+
+ +

#include <table_format.h>

+
+Inheritance diagram for gridfire::utils::ColumnBase:
+
+
+
[legend]
+ + + + + + + + + + +

+Public Member Functions

virtual ~ColumnBase ()=default
 
virtual std::string getCellData (size_t rowIndex) const =0
 
virtual std::string getHeader () const =0
 
virtual size_t getRowCount () const =0
 
+

Constructor & Destructor Documentation

+ +

◆ ~ColumnBase()

+ +
+
+ + + + + +
+ + + + + + + +
virtual gridfire::utils::ColumnBase::~ColumnBase ()
+ 		+virtualdefault
+
+ +
+
+

Member Function Documentation

+ +

◆ getCellData()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual std::string gridfire::utils::ColumnBase::getCellData (size_t rowIndex) const
+ 		+pure virtual
+
+ +

Implemented in gridfire::utils::Column< T >.

+ +
+
+ +

◆ getHeader()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::string gridfire::utils::ColumnBase::getHeader () const
+ 		+pure virtual
+
+ +

Implemented in gridfire::utils::Column< T >.

+ +
+
+ +

◆ getRowCount()

+ +
+
+ + + + + +
+ + + + + + + +
virtual size_t gridfire::utils::ColumnBase::getRowCount () const
+ 		+pure virtual
+
+ +

Implemented in gridfire::utils::Column< T >.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1utils_1_1ColumnBase.js b/docs/html/classgridfire_1_1utils_1_1ColumnBase.js new file mode 100644 index 00000000..4acb8529 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1ColumnBase.js @@ -0,0 +1,7 @@ +var classgridfire_1_1utils_1_1ColumnBase = +[ + [ "~ColumnBase", "classgridfire_1_1utils_1_1ColumnBase.html#a704c1fc03271c14fc9f3da43612a1589", null ], + [ "getCellData", "classgridfire_1_1utils_1_1ColumnBase.html#a5e07c8e33c96ee8095ebefbf9b75cb36", null ], + [ "getHeader", "classgridfire_1_1utils_1_1ColumnBase.html#a4dd5f1409d3190eab9ba07eb6e611248", null ], + [ "getRowCount", "classgridfire_1_1utils_1_1ColumnBase.html#ab6e4cb14c8a0ad7b6b9ad0fbde766cba", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1utils_1_1ColumnBase__inherit__graph.map b/docs/html/classgridfire_1_1utils_1_1ColumnBase__inherit__graph.map new file mode 100644 index 00000000..97460263 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1ColumnBase__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1utils_1_1ColumnBase__inherit__graph.md5 b/docs/html/classgridfire_1_1utils_1_1ColumnBase__inherit__graph.md5 new file mode 100644 index 00000000..4f57acae --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1ColumnBase__inherit__graph.md5 @@ -0,0 +1 @@ +ecbb70499ef8bbcd0b8d3b09dbff421d \ No newline at end of file diff --git a/docs/html/classgridfire_1_1utils_1_1ColumnBase__inherit__graph.svg b/docs/html/classgridfire_1_1utils_1_1ColumnBase__inherit__graph.svg new file mode 100644 index 00000000..7ae693ed --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1ColumnBase__inherit__graph.svg @@ -0,0 +1,64 @@ + + + + + + + + + + + +gridfire::utils::ColumnBase + + +Node1 + + +gridfire::utils::ColumnBase + + + + + +Node2 + + +gridfire::utils::Column< T > + + + + + +Node1->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1utils_1_1ColumnBase__inherit__graph_org.svg b/docs/html/classgridfire_1_1utils_1_1ColumnBase__inherit__graph_org.svg new file mode 100644 index 00000000..42d86ed2 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1ColumnBase__inherit__graph_org.svg @@ -0,0 +1,39 @@ + + + + + + +gridfire::utils::ColumnBase + + +Node1 + + +gridfire::utils::ColumnBase + + + + + +Node2 + + +gridfire::utils::Column< T > + + + + + +Node1->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1utils_1_1Column__coll__graph.map b/docs/html/classgridfire_1_1utils_1_1Column__coll__graph.map new file mode 100644 index 00000000..25c7905a --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Column__coll__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/classgridfire_1_1utils_1_1Column__coll__graph.md5 b/docs/html/classgridfire_1_1utils_1_1Column__coll__graph.md5 new file mode 100644 index 00000000..c0dacfeb --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Column__coll__graph.md5 @@ -0,0 +1 @@ +c3f23375beafd0acfa6eccbd433e0a2a \ No newline at end of file diff --git a/docs/html/classgridfire_1_1utils_1_1Column__coll__graph.svg b/docs/html/classgridfire_1_1utils_1_1Column__coll__graph.svg new file mode 100644 index 00000000..d3f01bf8 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Column__coll__graph.svg @@ -0,0 +1,102 @@ + + + + + + + + + + + +gridfire::utils::Column< T > + + +Node1 + + +gridfire::utils::Column< T > + + + + + +Node2 + + +gridfire::utils::ColumnBase + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::string + + + + + +Node3->Node1 + + + + + + m_header + + + +Node4 + + +std::basic_string< + Char > + + + + + +Node4->Node3 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1utils_1_1Column__coll__graph_org.svg b/docs/html/classgridfire_1_1utils_1_1Column__coll__graph_org.svg new file mode 100644 index 00000000..5e5da7ad --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Column__coll__graph_org.svg @@ -0,0 +1,77 @@ + + + + + + +gridfire::utils::Column< T > + + +Node1 + + +gridfire::utils::Column< T > + + + + + +Node2 + + +gridfire::utils::ColumnBase + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::string + + + + + +Node3->Node1 + + + + + + m_header + + + +Node4 + + +std::basic_string< + Char > + + + + + +Node4->Node3 + + + + + + + + diff --git a/docs/html/classgridfire_1_1utils_1_1Column__inherit__graph.map b/docs/html/classgridfire_1_1utils_1_1Column__inherit__graph.map new file mode 100644 index 00000000..fd187d9a --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Column__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1utils_1_1Column__inherit__graph.md5 b/docs/html/classgridfire_1_1utils_1_1Column__inherit__graph.md5 new file mode 100644 index 00000000..b21095b2 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Column__inherit__graph.md5 @@ -0,0 +1 @@ +3625525efabcbaa1405de01568680c3f \ No newline at end of file diff --git a/docs/html/classgridfire_1_1utils_1_1Column__inherit__graph.svg b/docs/html/classgridfire_1_1utils_1_1Column__inherit__graph.svg new file mode 100644 index 00000000..08aa25fb --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Column__inherit__graph.svg @@ -0,0 +1,64 @@ + + + + + + + + + + + +gridfire::utils::Column< T > + + +Node1 + + +gridfire::utils::Column< T > + + + + + +Node2 + + +gridfire::utils::ColumnBase + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1utils_1_1Column__inherit__graph_org.svg b/docs/html/classgridfire_1_1utils_1_1Column__inherit__graph_org.svg new file mode 100644 index 00000000..97468364 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Column__inherit__graph_org.svg @@ -0,0 +1,39 @@ + + + + + + +gridfire::utils::Column< T > + + +Node1 + + +gridfire::utils::Column< T > + + + + + +Node2 + + +gridfire::utils::ColumnBase + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/classgridfire_1_1utils_1_1Table-members.html b/docs/html/classgridfire_1_1utils_1_1Table-members.html new file mode 100644 index 00000000..8ab41d00 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Table-members.html @@ -0,0 +1,124 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::utils::Table< T > Member List
+
+
+ +

This is the complete list of members for gridfire::utils::Table< T >, including all inherited members.

+ + + + + + + + + + + + + + + +
getColumns() const overridegridfire::utils::Table< T >inlinevirtual
getName() const overridegridfire::utils::Table< T >inlinevirtual
m_columnsgridfire::utils::Table< T >private
m_namegridfire::utils::Table< T >private
ncols() const overridegridfire::utils::Table< T >inlinevirtual
nrows() const overridegridfire::utils::Table< T >inlinevirtual
operator[](size_t i) const overridegridfire::utils::Table< T >inlinevirtual
Table(const std::string &name, const std::vector< Column< T > > &columns)gridfire::utils::Table< T >inline
Table(const std::string &name, const std::unordered_map< std::string, std::vector< T > > &columnData)gridfire::utils::Table< T >inline
Table(const std::string &name, const std::map< std::string, std::vector< T > > &columnData)gridfire::utils::Table< T >inline
Table(const std::string &name, const std::unordered_map< fourdst::atomic::Species, std::vector< T > > &columnData)gridfire::utils::Table< T >inline
Table(const std::string &name, const std::map< fourdst::atomic::Species, std::vector< T > > &columnData)gridfire::utils::Table< T >inline
toCSV(const std::string &filename) const overridegridfire::utils::Table< T >inlinevirtual
~TableBase()=defaultgridfire::utils::TableBasevirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1utils_1_1Table.html b/docs/html/classgridfire_1_1utils_1_1Table.html new file mode 100644 index 00000000..976b4787 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Table.html @@ -0,0 +1,580 @@ + + + + + + + +GridFire: gridfire::utils::Table< T > Class Template Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
gridfire::utils::Table< T > Class Template Referencefinal
+
+
+ +

#include <table_format.h>

+
+Inheritance diagram for gridfire::utils::Table< T >:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::utils::Table< T >:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 Table (const std::string &name, const std::vector< Column< T > > &columns)
 
 Table (const std::string &name, const std::unordered_map< std::string, std::vector< T > > &columnData)
 
 Table (const std::string &name, const std::map< std::string, std::vector< T > > &columnData)
 
 Table (const std::string &name, const std::unordered_map< fourdst::atomic::Species, std::vector< T > > &columnData)
 
 Table (const std::string &name, const std::map< fourdst::atomic::Species, std::vector< T > > &columnData)
 
size_t ncols () const override
 
size_t nrows () const override
 
const ColumnBase & operator[] (size_t i) const override
 
const std::vector< std::unique_ptr< ColumnBase > > getColumns () const override
 
std::string getName () const override
 
void toCSV (const std::string &filename) const override
 
- Public Member Functions inherited from gridfire::utils::TableBase
virtual ~TableBase ()=default
 
+ + + + + +

+Private Attributes

std::string m_name
 
std::vector< std::unique_ptr< Column< T > > > m_columns
 
+

Constructor & Destructor Documentation

+ +

◆ Table() [1/5]

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
gridfire::utils::Table< T >::Table (const std::string & name,
const std::vector< Column< T > > & columns 
)
+ 		+inline
+
+ +
+
+ +

◆ Table() [2/5]

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
gridfire::utils::Table< T >::Table (const std::string & name,
const std::unordered_map< std::string, std::vector< T > > & columnData 
)
+ 		+inline
+
+ +
+
+ +

◆ Table() [3/5]

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
gridfire::utils::Table< T >::Table (const std::string & name,
const std::map< std::string, std::vector< T > > & columnData 
)
+ 		+inline
+
+ +
+
+ +

◆ Table() [4/5]

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
gridfire::utils::Table< T >::Table (const std::string & name,
const std::unordered_map< fourdst::atomic::Species, std::vector< T > > & columnData 
)
+ 		+inline
+
+ +
+
+ +

◆ Table() [5/5]

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
gridfire::utils::Table< T >::Table (const std::string & name,
const std::map< fourdst::atomic::Species, std::vector< T > > & columnData 
)
+ 		+inline
+
+ +
+
+

Member Function Documentation

+ +

◆ getColumns()

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + +
const std::vector< std::unique_ptr< ColumnBase > > gridfire::utils::Table< T >::getColumns () const
+ 		+inlineoverridevirtual
+
+ +

Reimplemented from gridfire::utils::TableBase.

+ +
+
+ +

◆ getName()

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + +
std::string gridfire::utils::Table< T >::getName () const
+ 		+inlineoverridevirtual
+
+ +

Implements gridfire::utils::TableBase.

+ +
+
+ +

◆ ncols()

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + +
size_t gridfire::utils::Table< T >::ncols () const
+ 		+inlineoverridevirtual
+
+ +

Implements gridfire::utils::TableBase.

+ +
+
+ +

◆ nrows()

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + +
size_t gridfire::utils::Table< T >::nrows () const
+ 		+inlineoverridevirtual
+
+ +

Implements gridfire::utils::TableBase.

+ +
+
+ +

◆ operator[]()

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + + +
const ColumnBase & gridfire::utils::Table< T >::operator[] (size_t i) const
+ 		+inlineoverridevirtual
+
+ +

Implements gridfire::utils::TableBase.

+ +
+
+ +

◆ toCSV()

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + + +
void gridfire::utils::Table< T >::toCSV (const std::string & filename) const
+ 		+inlineoverridevirtual
+
+ +

Implements gridfire::utils::TableBase.

+ +
+
+

Member Data Documentation

+ +

◆ m_columns

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + +
std::vector<std::unique_ptr<Column<T> > > gridfire::utils::Table< T >::m_columns
+ 		+private
+
+ +
+
+ +

◆ m_name

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + +
std::string gridfire::utils::Table< T >::m_name
+ 		+private
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1utils_1_1Table.js b/docs/html/classgridfire_1_1utils_1_1Table.js new file mode 100644 index 00000000..405643bd --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Table.js @@ -0,0 +1,16 @@ +var classgridfire_1_1utils_1_1Table = +[ + [ "Table", "classgridfire_1_1utils_1_1Table.html#a7b99d3e53f953afa6bc8eb0233d3c1f3", null ], + [ "Table", "classgridfire_1_1utils_1_1Table.html#af1003bb9d31eb82a13f63e3e2cdad987", null ], + [ "Table", "classgridfire_1_1utils_1_1Table.html#ac69280bf3caa856a1c20bbc3b219e5d3", null ], + [ "Table", "classgridfire_1_1utils_1_1Table.html#a97bbb21dfb837a666765ad3080a79484", null ], + [ "Table", "classgridfire_1_1utils_1_1Table.html#a2b49146cc60b057da1b65d6f3e12fe07", null ], + [ "getColumns", "classgridfire_1_1utils_1_1Table.html#a7977714b9c89a7de7336c6693c198af2", null ], + [ "getName", "classgridfire_1_1utils_1_1Table.html#a2a65467f5fedef81290bd5e64aa5685e", null ], + [ "ncols", "classgridfire_1_1utils_1_1Table.html#afd3ddec237e460916d2245b3f52c68ad", null ], + [ "nrows", "classgridfire_1_1utils_1_1Table.html#adc88ced7876f48aada9bc3cf73163567", null ], + [ "operator[]", "classgridfire_1_1utils_1_1Table.html#a405477a1b9ecf0f1dc84ec102cdec7b3", null ], + [ "toCSV", "classgridfire_1_1utils_1_1Table.html#a75503b09c879108faf597a5c93723e4a", null ], + [ "m_columns", "classgridfire_1_1utils_1_1Table.html#ac31535d25f1c026cbb4cd64bf833a1e6", null ], + [ "m_name", "classgridfire_1_1utils_1_1Table.html#a51fb3691d40941c197f536c86cf9d59a", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1utils_1_1TableBase-members.html b/docs/html/classgridfire_1_1utils_1_1TableBase-members.html new file mode 100644 index 00000000..d0892568 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1TableBase-members.html @@ -0,0 +1,117 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::utils::TableBase Member List
+
+
+ +

This is the complete list of members for gridfire::utils::TableBase, including all inherited members.

+ + + + + + + + +
getColumns() constgridfire::utils::TableBasevirtual
getName() const =0gridfire::utils::TableBasepure virtual
ncols() const =0gridfire::utils::TableBasepure virtual
nrows() const =0gridfire::utils::TableBasepure virtual
operator[](size_t i) const =0gridfire::utils::TableBasepure virtual
toCSV(const std::string &filename) const =0gridfire::utils::TableBasepure virtual
~TableBase()=defaultgridfire::utils::TableBasevirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1utils_1_1TableBase.html b/docs/html/classgridfire_1_1utils_1_1TableBase.html new file mode 100644 index 00000000..d135074e --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1TableBase.html @@ -0,0 +1,330 @@ + + + + + + + +GridFire: gridfire::utils::TableBase Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::utils::TableBase Class Referenceabstract
+
+
+ +

#include <table_format.h>

+
+Inheritance diagram for gridfire::utils::TableBase:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + +

+Public Member Functions

virtual ~TableBase ()=default
 
virtual size_t ncols () const =0
 
virtual size_t nrows () const =0
 
virtual const ColumnBase & operator[] (size_t i) const =0
 
virtual const std::vector< std::unique_ptr< ColumnBase > > getColumns () const
 
virtual std::string getName () const =0
 
virtual void toCSV (const std::string &filename) const =0
 
+

Constructor & Destructor Documentation

+ +

◆ ~TableBase()

+ +
+
+ + + + + +
+ + + + + + + +
virtual gridfire::utils::TableBase::~TableBase ()
+ 		+virtualdefault
+
+ +
+
+

Member Function Documentation

+ +

◆ getColumns()

+ +
+
+ + + + + +
+ + + + + + + +
virtual const std::vector< std::unique_ptr< ColumnBase > > gridfire::utils::TableBase::getColumns () const
+ 		+virtual
+
+ +

Reimplemented in gridfire::utils::Table< T >.

+ +
+
+ +

◆ getName()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::string gridfire::utils::TableBase::getName () const
+ 		+pure virtual
+
+ +

Implemented in gridfire::utils::Table< T >.

+ +
+
+ +

◆ ncols()

+ +
+
+ + + + + +
+ + + + + + + +
virtual size_t gridfire::utils::TableBase::ncols () const
+ 		+pure virtual
+
+ +

Implemented in gridfire::utils::Table< T >.

+ +
+
+ +

◆ nrows()

+ +
+
+ + + + + +
+ + + + + + + +
virtual size_t gridfire::utils::TableBase::nrows () const
+ 		+pure virtual
+
+ +

Implemented in gridfire::utils::Table< T >.

+ +
+
+ +

◆ operator[]()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual const ColumnBase & gridfire::utils::TableBase::operator[] (size_t i) const
+ 		+pure virtual
+
+ +

Implemented in gridfire::utils::Table< T >.

+ +
+
+ +

◆ toCSV()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual void gridfire::utils::TableBase::toCSV (const std::string & filename) const
+ 		+pure virtual
+
+ +

Implemented in gridfire::utils::Table< T >.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1utils_1_1TableBase.js b/docs/html/classgridfire_1_1utils_1_1TableBase.js new file mode 100644 index 00000000..f69df408 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1TableBase.js @@ -0,0 +1,10 @@ +var classgridfire_1_1utils_1_1TableBase = +[ + [ "~TableBase", "classgridfire_1_1utils_1_1TableBase.html#a0529d4130643358562e1c1d1f78c924f", null ], + [ "getColumns", "classgridfire_1_1utils_1_1TableBase.html#a46d43ed8de12755d7a57af57db29cda8", null ], + [ "getName", "classgridfire_1_1utils_1_1TableBase.html#ac99b595b7ccfdcedd13ca48413e3373d", null ], + [ "ncols", "classgridfire_1_1utils_1_1TableBase.html#af1a64a10395240ae527c33de5555e91b", null ], + [ "nrows", "classgridfire_1_1utils_1_1TableBase.html#a271f10ae6349dc5a6e37f27f1d580752", null ], + [ "operator[]", "classgridfire_1_1utils_1_1TableBase.html#a33d1f279cc02a4edb66e846bb7b10077", null ], + [ "toCSV", "classgridfire_1_1utils_1_1TableBase.html#acd7d5ca97586c58a6b54d54370111597", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1utils_1_1TableBase__inherit__graph.map b/docs/html/classgridfire_1_1utils_1_1TableBase__inherit__graph.map new file mode 100644 index 00000000..fec4fc5d --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1TableBase__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1utils_1_1TableBase__inherit__graph.md5 b/docs/html/classgridfire_1_1utils_1_1TableBase__inherit__graph.md5 new file mode 100644 index 00000000..bf9bfa10 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1TableBase__inherit__graph.md5 @@ -0,0 +1 @@ +5dfdfe2711f386c11cd58404a5bdb679 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1utils_1_1TableBase__inherit__graph.svg b/docs/html/classgridfire_1_1utils_1_1TableBase__inherit__graph.svg new file mode 100644 index 00000000..c6c02843 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1TableBase__inherit__graph.svg @@ -0,0 +1,64 @@ + + + + + + + + + + + +gridfire::utils::TableBase + + +Node1 + + +gridfire::utils::TableBase + + + + + +Node2 + + +gridfire::utils::Table< T > + + + + + +Node1->Node2 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1utils_1_1TableBase__inherit__graph_org.svg b/docs/html/classgridfire_1_1utils_1_1TableBase__inherit__graph_org.svg new file mode 100644 index 00000000..410b9a71 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1TableBase__inherit__graph_org.svg @@ -0,0 +1,39 @@ + + + + + + +gridfire::utils::TableBase + + +Node1 + + +gridfire::utils::TableBase + + + + + +Node2 + + +gridfire::utils::Table< T > + + + + + +Node1->Node2 + + + + + + + + diff --git a/docs/html/classgridfire_1_1utils_1_1Table__coll__graph.map b/docs/html/classgridfire_1_1utils_1_1Table__coll__graph.map new file mode 100644 index 00000000..7da03226 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Table__coll__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1utils_1_1Table__coll__graph.md5 b/docs/html/classgridfire_1_1utils_1_1Table__coll__graph.md5 new file mode 100644 index 00000000..e0fc6921 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Table__coll__graph.md5 @@ -0,0 +1 @@ +4f7ae114616366650b220bd6aec3c1d7 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1utils_1_1Table__coll__graph.svg b/docs/html/classgridfire_1_1utils_1_1Table__coll__graph.svg new file mode 100644 index 00000000..e9a5009e --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Table__coll__graph.svg @@ -0,0 +1,200 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::utils::Table< T > + + +Node1 + + +gridfire::utils::Table< T > + + + + + +Node2 + + +gridfire::utils::TableBase + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::string + + + + + +Node3->Node1 + + + + + + m_name + + + +Node4 + + +std::basic_string< + Char > + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::vector< std::unique +_ptr< gridfire::utils:: +Column< T > > > + + + + + +Node5->Node1 + + + + + + m_columns + + + +Node6 + + +std::unique_ptr< gridfire +::utils::Column< T > > + + + + + +Node6->Node5 + + + + + + elements + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1utils_1_1Table__coll__graph_org.svg b/docs/html/classgridfire_1_1utils_1_1Table__coll__graph_org.svg new file mode 100644 index 00000000..5945ddcd --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Table__coll__graph_org.svg @@ -0,0 +1,118 @@ + + + + + + +gridfire::utils::Table< T > + + +Node1 + + +gridfire::utils::Table< T > + + + + + +Node2 + + +gridfire::utils::TableBase + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +std::string + + + + + +Node3->Node1 + + + + + + m_name + + + +Node4 + + +std::basic_string< + Char > + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::vector< std::unique +_ptr< gridfire::utils:: +Column< T > > > + + + + + +Node5->Node1 + + + + + + m_columns + + + +Node6 + + +std::unique_ptr< gridfire +::utils::Column< T > > + + + + + +Node6->Node5 + + + + + + elements + + + diff --git a/docs/html/classgridfire_1_1utils_1_1Table__inherit__graph.map b/docs/html/classgridfire_1_1utils_1_1Table__inherit__graph.map new file mode 100644 index 00000000..89480998 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Table__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/classgridfire_1_1utils_1_1Table__inherit__graph.md5 b/docs/html/classgridfire_1_1utils_1_1Table__inherit__graph.md5 new file mode 100644 index 00000000..2d94093b --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Table__inherit__graph.md5 @@ -0,0 +1 @@ +54104cecf90b67e099b0ad204fe46951 \ No newline at end of file diff --git a/docs/html/classgridfire_1_1utils_1_1Table__inherit__graph.svg b/docs/html/classgridfire_1_1utils_1_1Table__inherit__graph.svg new file mode 100644 index 00000000..00ca1cf5 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Table__inherit__graph.svg @@ -0,0 +1,64 @@ + + + + + + + + + + + +gridfire::utils::Table< T > + + +Node1 + + +gridfire::utils::Table< T > + + + + + +Node2 + + +gridfire::utils::TableBase + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/classgridfire_1_1utils_1_1Table__inherit__graph_org.svg b/docs/html/classgridfire_1_1utils_1_1Table__inherit__graph_org.svg new file mode 100644 index 00000000..eca45390 --- /dev/null +++ b/docs/html/classgridfire_1_1utils_1_1Table__inherit__graph_org.svg @@ -0,0 +1,39 @@ + + + + + + +gridfire::utils::Table< T > + + +Node1 + + +gridfire::utils::Table< T > + + + + + +Node2 + + +gridfire::utils::TableBase + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/concept_0d109_1_1IsDynamicEngine.html b/docs/html/concept_0d109_1_1IsDynamicEngine.html new file mode 100644 index 00000000..8732ad8f --- /dev/null +++ b/docs/html/concept_0d109_1_1IsDynamicEngine.html @@ -0,0 +1,112 @@ + + + + + + + +GridFire: @109::IsDynamicEngine Concept Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
@109::IsDynamicEngine Concept Reference
+
+
+

Concept definition

+
template<typename T>
+
concept @109::IsDynamicEngine = std::is_base_of_v<gridfire::engine::DynamicEngine, T>
+
@109::IsDynamicEngine
Definition bindings.cpp:18
+
+
+ + + + diff --git a/docs/html/concept_0d123_1_1IsNetworkPolicy.html b/docs/html/concept_0d123_1_1IsNetworkPolicy.html new file mode 100644 index 00000000..69b0740a --- /dev/null +++ b/docs/html/concept_0d123_1_1IsNetworkPolicy.html @@ -0,0 +1,112 @@ + + + + + + + +GridFire: @123::IsNetworkPolicy Concept Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
@123::IsNetworkPolicy Concept Reference
+
+
+

Concept definition

+
template<typename T>
+
concept @123::IsNetworkPolicy = std::is_base_of_v<gridfire::policy::NetworkPolicy, T>
+
@123::IsNetworkPolicy
Definition bindings.cpp:21
+
+
+ + + + diff --git a/docs/html/concept_0d123_1_1IsReactionChainPolicy.html b/docs/html/concept_0d123_1_1IsReactionChainPolicy.html new file mode 100644 index 00000000..0b47723b --- /dev/null +++ b/docs/html/concept_0d123_1_1IsReactionChainPolicy.html @@ -0,0 +1,112 @@ + + + + + + + +GridFire: @123::IsReactionChainPolicy Concept Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
@123::IsReactionChainPolicy Concept Reference
+
+
+

Concept definition

+
template<typename T>
+
concept @123::IsReactionChainPolicy = std::is_base_of_v<gridfire::policy::ReactionChainPolicy, T>
+
@123::IsReactionChainPolicy
Definition bindings.cpp:18
+
+
+ + + + diff --git a/docs/html/conceptgridfire_1_1IsArithmeticOrAD.html b/docs/html/conceptgridfire_1_1IsArithmeticOrAD.html new file mode 100644 index 00000000..a3e0fae6 --- /dev/null +++ b/docs/html/conceptgridfire_1_1IsArithmeticOrAD.html @@ -0,0 +1,120 @@ + + + + + + + +GridFire: gridfire::IsArithmeticOrAD Concept Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::IsArithmeticOrAD Concept Reference
+
+
+ +

Concept for types allowed in engine calculations. +More...

+ +

#include <types.h>

+

Concept definition

+
template<typename T>
+
concept gridfire::IsArithmeticOrAD = std::is_same_v<T, double> || std::is_same_v<T, CppAD::AD<double>>
+
gridfire::IsArithmeticOrAD
Concept for types allowed in engine calculations.
Definition types.h:59
+

Detailed Description

+

Concept for types allowed in engine calculations.

+

This concept restricts template parameters to either double or CppAD::AD<double>, enabling both standard and automatic differentiation types.

+
+
+ + + + diff --git a/docs/html/conceptgridfire_1_1engine_1_1EngineType.html b/docs/html/conceptgridfire_1_1engine_1_1EngineType.html new file mode 100644 index 00000000..ea2d65d8 --- /dev/null +++ b/docs/html/conceptgridfire_1_1engine_1_1EngineType.html @@ -0,0 +1,121 @@ + + + + + + + +GridFire: gridfire::engine::EngineType Concept Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::EngineType Concept Reference
+
+
+ +

Concept for types allowed as engine bases in EngineView. +More...

+ +

#include <engine_view_abstract.h>

+

Concept definition

+
template<typename EngineT>
+
concept gridfire::engine::EngineType = std::is_base_of_v<Engine, EngineT> || std::is_base_of_v<DynamicEngine, EngineT>
+
gridfire::engine::EngineType
Concept for types allowed as engine bases in EngineView.
Definition engine_view_abstract.h:42
+

Detailed Description

+

Concept for types allowed as engine bases in EngineView.

+

This concept restricts template parameters to types derived from either gridfire::Engine or gridfire::DynamicEngine, as defined in engine_abstract.h.

+

Example usage:

static_assert(EngineType<MyEngine>);
+
+
+ + + + diff --git a/docs/html/conceptgridfire_1_1utils_1_1Streamable.html b/docs/html/conceptgridfire_1_1utils_1_1Streamable.html new file mode 100644 index 00000000..0a84a509 --- /dev/null +++ b/docs/html/conceptgridfire_1_1utils_1_1Streamable.html @@ -0,0 +1,116 @@ + + + + + + + +GridFire: gridfire::utils::Streamable Concept Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::utils::Streamable Concept Reference
+
+
+ +

#include <logging.h>

+

Concept definition

+
template<typename T>
+
concept gridfire::utils::Streamable = requires(std::ostream& os, const T& value) {
+
{ os << value } -> std::same_as<std::ostream&>;
+
}
+
gridfire::utils::Streamable
Definition logging.h:68
+
+
+ + + + diff --git a/docs/html/concepts.html b/docs/html/concepts.html index cf0a31bd..fdb5952b 100644 --- a/docs/html/concepts.html +++ b/docs/html/concepts.html @@ -3,18 +3,16 @@ - + GridFire: Concepts - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -103,13 +96,13 @@ $(function(){initNavTree('concepts.html',''); initResizable(true); });
Here is a list of all concepts with brief descriptions:
-
[detail level 123]
- - - - - - +
[detail level 123]
 ▼Ngridfire
 ▼Nengine
 REngineTypeConcept for types allowed as engine bases in EngineView
 ▼Nutils
 RStreamable
 RIsArithmeticOrADConcept for types allowed in engine calculations
+ + + + + +
 ▼Ngridfire
 ▼Nengine
 REngineTypeConcept for types allowed as engine bases in EngineView
 ▼Nutils
 RStreamable
 RIsArithmeticOrADConcept for types allowed in engine calculations
@@ -117,7 +110,7 @@ $(function(){initNavTree('concepts.html',''); initResizable(true); }); diff --git a/docs/html/concepts.js b/docs/html/concepts.js index b86c9173..5396ba4b 100644 --- a/docs/html/concepts.js +++ b/docs/html/concepts.js @@ -2,11 +2,11 @@ var concepts = [ [ "gridfire", "namespacegridfire.html", [ [ "engine", "namespacegridfire_1_1engine.html", [ - [ "EngineType", "conceptgridfire_1_1engine_1_1_engine_type.html", null ] + [ "EngineType", "conceptgridfire_1_1engine_1_1EngineType.html", null ] ] ], [ "utils", "namespacegridfire_1_1utils.html", [ - [ "Streamable", "conceptgridfire_1_1utils_1_1_streamable.html", null ] + [ "Streamable", "conceptgridfire_1_1utils_1_1Streamable.html", null ] ] ], - [ "IsArithmeticOrAD", "conceptgridfire_1_1_is_arithmetic_or_a_d.html", null ] + [ "IsArithmeticOrAD", "conceptgridfire_1_1IsArithmeticOrAD.html", null ] ] ] ]; \ No newline at end of file diff --git a/docs/html/construction_8cpp.html b/docs/html/construction_8cpp.html index afefef3b..d8806816 100644 --- a/docs/html/construction_8cpp.html +++ b/docs/html/construction_8cpp.html @@ -3,18 +3,16 @@ - + GridFire: src/lib/engine/procedures/construction.cpp File Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -100,7 +93,6 @@ $(function(){initNavTree('construction_8cpp.html',''); initResizable(true); });
-Classes | Namespaces | Functions
construction.cpp File Reference
@@ -126,24 +118,16 @@ Include dependency graph for construction.cpp:
- - - - - - -

-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.
 
@@ -153,7 +137,7 @@ Functions diff --git a/docs/html/construction_8cpp.js b/docs/html/construction_8cpp.js index 6f457523..a5eed334 100644 --- a/docs/html/construction_8cpp.js +++ b/docs/html/construction_8cpp.js @@ -1,6 +1,4 @@ var construction_8cpp = [ - [ "gridfire::engine::ReactionSet", "classgridfire_1_1engine_1_1_reaction_set.html", "classgridfire_1_1engine_1_1_reaction_set" ], - [ "gridfire::engine::Reaction", "classgridfire_1_1engine_1_1_reaction.html", "classgridfire_1_1engine_1_1_reaction" ], - [ "gridfire::engine::build_nuclear_network", "namespacegridfire_1_1engine.html#a7b64607db49cfc042cbee63be5351549", null ] + [ "build_nuclear_network", "construction_8cpp.html#a7b64607db49cfc042cbee63be5351549", null ] ]; \ No newline at end of file diff --git a/docs/html/construction_8h.html b/docs/html/construction_8h.html index 5860eabf..10cd4ee7 100644 --- a/docs/html/construction_8h.html +++ b/docs/html/construction_8h.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/engine/procedures/construction.h File Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -127,9 +120,9 @@ This graph shows which files directly or indirectly include this file:
- + - +

Namespaces

namespace  gridfire
namespace  gridfire
 
namespace  gridfire::engine
namespace  gridfire::engine
 
- + - + - + - + - + - +

@@ -155,21 +148,21 @@ Enumerations

Functions

constexpr auto gridfire::engine::to_underlying (NetworkConstructionFlags f) noexcept
 Helper function to convert NetworkConstructionFlags to their underlying integer type.
 Helper function to convert NetworkConstructionFlags to their underlying integer type.
 
NetworkConstructionFlags gridfire::engine::operator| (const NetworkConstructionFlags lhs, const NetworkConstructionFlags rhs)
 Bitwise OR operator for NetworkConstructionFlags.
 Bitwise OR operator for NetworkConstructionFlags.
 
NetworkConstructionFlags gridfire::engine::operator& (const NetworkConstructionFlags lhs, const NetworkConstructionFlags rhs)
 Bitwise AND operator for NetworkConstructionFlags.
 Bitwise AND operator for NetworkConstructionFlags.
 
bool gridfire::engine::has_flag (const NetworkConstructionFlags flags, const NetworkConstructionFlags flag_to_check)
 Checks if a specific flag is set within a NetworkConstructionFlags value.
 Checks if a specific flag is set within a NetworkConstructionFlags value.
 
std::string gridfire::engine::NetworkConstructionFlagsToString (NetworkConstructionFlags flags)
 Converts NetworkConstructionFlags to a human-readable string.
 Converts NetworkConstructionFlags to a human-readable string.
 
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.
 
@@ -181,7 +174,7 @@ Functions diff --git a/docs/html/construction_8h.js b/docs/html/construction_8h.js index 13df9617..815e0583 100644 --- a/docs/html/construction_8h.js +++ b/docs/html/construction_8h.js @@ -1,21 +1,21 @@ var construction_8h = [ - [ "gridfire::engine::NetworkConstructionFlags", "namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9", [ - [ "gridfire::engine::NetworkConstructionFlags::NONE", "namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9ab50339a10e1de285ac99d4c3990b8693", null ], - [ "gridfire::engine::NetworkConstructionFlags::REACLIB_STRONG", "namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9a8211eaf8b0f0de1a6b0bf199da5975e1", null ], - [ "gridfire::engine::NetworkConstructionFlags::WRL_BETA_MINUS", "namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9a08b95f789a0c024936e08b95c41865c4", null ], - [ "gridfire::engine::NetworkConstructionFlags::WRL_BETA_PLUS", "namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9a49e3e12f2ea5b0d29df72a8a36f18d4a", null ], - [ "gridfire::engine::NetworkConstructionFlags::WRL_ELECTRON_CAPTURE", "namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9af3d03bd75d332304afee1ab36498223e", null ], - [ "gridfire::engine::NetworkConstructionFlags::WRL_POSITRON_CAPTURE", "namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9a0712c13f98dca85d8d8bb9606283b955", null ], - [ "gridfire::engine::NetworkConstructionFlags::REACLIB_WEAK", "namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9ab736eb13fff62c962f63232ec57f2692", null ], - [ "gridfire::engine::NetworkConstructionFlags::WRL_WEAK", "namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9afc9a7c10ff86192133ca7a280783bfe4", null ], - [ "gridfire::engine::NetworkConstructionFlags::REACLIB", "namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9af9885ed04411bef7b70f78b643c6a220", null ], - [ "gridfire::engine::NetworkConstructionFlags::DEFAULT", "namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9a5b39c8b553c821e7cddc6da64b5bd2ee", null ] + [ "NetworkConstructionFlags", "construction_8h.html#a775506bb881280f73264db27cb8388f9", [ + [ "NONE", "construction_8h.html#a775506bb881280f73264db27cb8388f9ab50339a10e1de285ac99d4c3990b8693", null ], + [ "REACLIB_STRONG", "construction_8h.html#a775506bb881280f73264db27cb8388f9a8211eaf8b0f0de1a6b0bf199da5975e1", null ], + [ "WRL_BETA_MINUS", "construction_8h.html#a775506bb881280f73264db27cb8388f9a08b95f789a0c024936e08b95c41865c4", null ], + [ "WRL_BETA_PLUS", "construction_8h.html#a775506bb881280f73264db27cb8388f9a49e3e12f2ea5b0d29df72a8a36f18d4a", null ], + [ "WRL_ELECTRON_CAPTURE", "construction_8h.html#a775506bb881280f73264db27cb8388f9af3d03bd75d332304afee1ab36498223e", null ], + [ "WRL_POSITRON_CAPTURE", "construction_8h.html#a775506bb881280f73264db27cb8388f9a0712c13f98dca85d8d8bb9606283b955", null ], + [ "REACLIB_WEAK", "construction_8h.html#a775506bb881280f73264db27cb8388f9ab736eb13fff62c962f63232ec57f2692", null ], + [ "WRL_WEAK", "construction_8h.html#a775506bb881280f73264db27cb8388f9afc9a7c10ff86192133ca7a280783bfe4", null ], + [ "REACLIB", "construction_8h.html#a775506bb881280f73264db27cb8388f9af9885ed04411bef7b70f78b643c6a220", null ], + [ "DEFAULT", "construction_8h.html#a775506bb881280f73264db27cb8388f9a5b39c8b553c821e7cddc6da64b5bd2ee", null ] ] ], - [ "gridfire::engine::build_nuclear_network", "namespacegridfire_1_1engine.html#a7b64607db49cfc042cbee63be5351549", null ], - [ "gridfire::engine::has_flag", "namespacegridfire_1_1engine.html#a7377e1152d165cfb9eadc16c5dc2f492", null ], - [ "gridfire::engine::NetworkConstructionFlagsToString", "namespacegridfire_1_1engine.html#aea27cb9ed6d613ae9e4b7fa89767861a", null ], - [ "gridfire::engine::operator&", "namespacegridfire_1_1engine.html#ace3a790fb57920fd12328fa9c5a3a1de", null ], - [ "gridfire::engine::operator|", "namespacegridfire_1_1engine.html#a69216b717d99f53cf2d1419e23b69119", null ], - [ "gridfire::engine::to_underlying", "namespacegridfire_1_1engine.html#a956ff12cef0dda2b9209ceab68199090", null ] + [ "build_nuclear_network", "construction_8h.html#a7b64607db49cfc042cbee63be5351549", null ], + [ "has_flag", "construction_8h.html#a7377e1152d165cfb9eadc16c5dc2f492", null ], + [ "NetworkConstructionFlagsToString", "construction_8h.html#aea27cb9ed6d613ae9e4b7fa89767861a", null ], + [ "operator&", "construction_8h.html#ace3a790fb57920fd12328fa9c5a3a1de", null ], + [ "operator|", "construction_8h.html#a69216b717d99f53cf2d1419e23b69119", null ], + [ "to_underlying", "construction_8h.html#a956ff12cef0dda2b9209ceab68199090", null ] ]; \ No newline at end of file diff --git a/docs/html/construction_8h__dep__incl.map b/docs/html/construction_8h__dep__incl.map index 22d639c2..b4d6b4a1 100644 --- a/docs/html/construction_8h__dep__incl.map +++ b/docs/html/construction_8h__dep__incl.map @@ -1,70 +1,70 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/construction_8h__dep__incl.md5 b/docs/html/construction_8h__dep__incl.md5 index fe23f448..57a52568 100644 --- a/docs/html/construction_8h__dep__incl.md5 +++ b/docs/html/construction_8h__dep__incl.md5 @@ -1 +1 @@ -4e2b92679075267c1b58a1c9f4f43c3a \ No newline at end of file +461c55a7235a8c7b0bed50cb59a4f3a5 \ No newline at end of file diff --git a/docs/html/construction_8h__dep__incl.svg b/docs/html/construction_8h__dep__incl.svg index 6220f598..14a4fe9b 100644 --- a/docs/html/construction_8h__dep__incl.svg +++ b/docs/html/construction_8h__dep__incl.svg @@ -1,13 +1,12 @@ - - + - - + src/include/gridfire/utils clusterdir_3626e0c0e3c5d7812d6b277dfa4ec364 - -gridfire + +gridfire clusterdir_8e34b6fea5a3d13256b367f27bc2135d - + @@ -38,57 +37,44 @@ dir_aff155d61c3b73b9ab7dcdc908c4d49e - -engine - - - - - -dir_f2d7b0c77cb2532170ac94ead6e4ba70 - - -reaction + +engine - + dir_cd87a60aa1dbf4ee960e0533fd7a9743 - - -exceptions + + +exceptions + + + + + +dir_f2d7b0c77cb2532170ac94ead6e4ba70 + + +reaction dir_8e34b6fea5a3d13256b367f27bc2135d -utils +utils dir_8e34b6fea5a3d13256b367f27bc2135d->dir_aff155d61c3b73b9ab7dcdc908c4d49e - - + + -2 - - - - - -dir_8e34b6fea5a3d13256b367f27bc2135d->dir_f2d7b0c77cb2532170ac94ead6e4ba70 - - - - - - -1 +2 @@ -96,12 +82,25 @@ dir_8e34b6fea5a3d13256b367f27bc2135d->dir_cd87a60aa1dbf4ee960e0533fd7a9743 - - + + -2 +2 + + + + + +dir_8e34b6fea5a3d13256b367f27bc2135d->dir_f2d7b0c77cb2532170ac94ead6e4ba70 + + + + + + +1 @@ -109,8 +108,8 @@ dir_d8b7e23cf0e7cbdccc15d25172634c8e - -formatters + +formatters @@ -118,12 +117,12 @@ dir_8e34b6fea5a3d13256b367f27bc2135d->dir_d8b7e23cf0e7cbdccc15d25172634c8e - - + + -1 +1 @@ -131,12 +130,12 @@ dir_d8b7e23cf0e7cbdccc15d25172634c8e->dir_aff155d61c3b73b9ab7dcdc908c4d49e - - + + -1 +1 diff --git a/docs/html/dir_8e34b6fea5a3d13256b367f27bc2135d_dep_org.svg b/docs/html/dir_8e34b6fea5a3d13256b367f27bc2135d_dep_org.svg index 86d6fcb9..b414cbc3 100644 --- a/docs/html/dir_8e34b6fea5a3d13256b367f27bc2135d_dep_org.svg +++ b/docs/html/dir_8e34b6fea5a3d13256b367f27bc2135d_dep_org.svg @@ -1,25 +1,25 @@ - - - + + src/include/gridfire/utils clusterdir_3626e0c0e3c5d7812d6b277dfa4ec364 - -gridfire + +gridfire clusterdir_8e34b6fea5a3d13256b367f27bc2135d - + @@ -27,57 +27,44 @@ dir_aff155d61c3b73b9ab7dcdc908c4d49e - -engine - - - - - -dir_f2d7b0c77cb2532170ac94ead6e4ba70 - - -reaction + +engine - + dir_cd87a60aa1dbf4ee960e0533fd7a9743 - - -exceptions + + +exceptions + + + + + +dir_f2d7b0c77cb2532170ac94ead6e4ba70 + + +reaction dir_8e34b6fea5a3d13256b367f27bc2135d -utils +utils dir_8e34b6fea5a3d13256b367f27bc2135d->dir_aff155d61c3b73b9ab7dcdc908c4d49e - - + + -2 - - - - - -dir_8e34b6fea5a3d13256b367f27bc2135d->dir_f2d7b0c77cb2532170ac94ead6e4ba70 - - - - - - -1 +2 @@ -85,12 +72,25 @@ dir_8e34b6fea5a3d13256b367f27bc2135d->dir_cd87a60aa1dbf4ee960e0533fd7a9743 - - + + -2 +2 + + + + + +dir_8e34b6fea5a3d13256b367f27bc2135d->dir_f2d7b0c77cb2532170ac94ead6e4ba70 + + + + + + +1 @@ -98,8 +98,8 @@ dir_d8b7e23cf0e7cbdccc15d25172634c8e - -formatters + +formatters @@ -107,12 +107,12 @@ dir_8e34b6fea5a3d13256b367f27bc2135d->dir_d8b7e23cf0e7cbdccc15d25172634c8e - - + + -1 +1 @@ -120,12 +120,12 @@ dir_d8b7e23cf0e7cbdccc15d25172634c8e->dir_aff155d61c3b73b9ab7dcdc908c4d49e - - + + -1 +1 diff --git a/docs/html/dir_902e06e9d82d80b06df7be6e417fa9ee.html b/docs/html/dir_902e06e9d82d80b06df7be6e417fa9ee.html index 1058103c..317196f7 100644 --- a/docs/html/dir_902e06e9d82d80b06df7be6e417fa9ee.html +++ b/docs/html/dir_902e06e9d82d80b06df7be6e417fa9ee.html @@ -3,18 +3,16 @@ - + GridFire: src/lib/reaction Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -126,7 +119,7 @@ Files diff --git a/docs/html/dir_92702fa8b7ad81d706ff2de191dc2c50.html b/docs/html/dir_92702fa8b7ad81d706ff2de191dc2c50.html index e91529c4..d2c0721e 100644 --- a/docs/html/dir_92702fa8b7ad81d706ff2de191dc2c50.html +++ b/docs/html/dir_92702fa8b7ad81d706ff2de191dc2c50.html @@ -3,18 +3,16 @@ - + GridFire: src/lib/io/generative Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -119,7 +112,7 @@ Files diff --git a/docs/html/dir_97105ebeaecd797c90bf23079fd9b0e6.html b/docs/html/dir_97105ebeaecd797c90bf23079fd9b0e6.html index f2f2beae..3c2e08f9 100644 --- a/docs/html/dir_97105ebeaecd797c90bf23079fd9b0e6.html +++ b/docs/html/dir_97105ebeaecd797c90bf23079fd9b0e6.html @@ -3,18 +3,16 @@ - + GridFire: src/python/partition/trampoline Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -121,7 +114,7 @@ Files diff --git a/docs/html/dir_9e86cb84d90706cd957af3c853ce5bc2.html b/docs/html/dir_9e86cb84d90706cd957af3c853ce5bc2.html index 1400a213..cfe8ee3e 100644 --- a/docs/html/dir_9e86cb84d90706cd957af3c853ce5bc2.html +++ b/docs/html/dir_9e86cb84d90706cd957af3c853ce5bc2.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/types Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -119,7 +112,7 @@ Files diff --git a/docs/html/dir_a2537f6f0ba382cc4200a69fb7d9b7da.html b/docs/html/dir_a2537f6f0ba382cc4200a69fb7d9b7da.html index 2620ef02..afa03ea6 100644 --- a/docs/html/dir_a2537f6f0ba382cc4200a69fb7d9b7da.html +++ b/docs/html/dir_a2537f6f0ba382cc4200a69fb7d9b7da.html @@ -3,18 +3,16 @@ - + GridFire: src/lib/partition/composite Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -119,7 +112,7 @@ Files diff --git a/docs/html/dir_a655cd5fc66d004f2ba0d90a545dacb3.html b/docs/html/dir_a655cd5fc66d004f2ba0d90a545dacb3.html index e45e3a44..f6e4fca7 100644 --- a/docs/html/dir_a655cd5fc66d004f2ba0d90a545dacb3.html +++ b/docs/html/dir_a655cd5fc66d004f2ba0d90a545dacb3.html @@ -3,18 +3,16 @@ - + GridFire: src/extern/include/gridfire Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -119,7 +112,7 @@ Directories diff --git a/docs/html/dir_ab918a70d5de27403bd1202d71acc71b.html b/docs/html/dir_ab918a70d5de27403bd1202d71acc71b.html index ee43d3e8..2f5cee28 100644 --- a/docs/html/dir_ab918a70d5de27403bd1202d71acc71b.html +++ b/docs/html/dir_ab918a70d5de27403bd1202d71acc71b.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/interfaces/solver Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -119,7 +112,7 @@ Files diff --git a/docs/html/dir_ad59de2d6f32552fa0ecb4acca2fbb0b.html b/docs/html/dir_ad59de2d6f32552fa0ecb4acca2fbb0b.html index 2d85de4e..860232ae 100644 --- a/docs/html/dir_ad59de2d6f32552fa0ecb4acca2fbb0b.html +++ b/docs/html/dir_ad59de2d6f32552fa0ecb4acca2fbb0b.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/screening Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -129,7 +122,7 @@ Files diff --git a/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e.html b/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e.html index c24a70fd..5f5a9b77 100644 --- a/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e.html +++ b/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/engine Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -105,7 +98,7 @@ $(function(){initNavTree('dir_aff155d61c3b73b9ab7dcdc908c4d49e.html',''); initRe
Directory dependency graph for engine:
-
+
diff --git a/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e_dep.map b/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e_dep.map index bc9336ad..47b66fae 100644 --- a/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e_dep.map +++ b/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e_dep.map @@ -1,43 +1,43 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e_dep.md5 b/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e_dep.md5 index 1ae5fa40..585ee049 100644 --- a/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e_dep.md5 +++ b/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e_dep.md5 @@ -1 +1 @@ -888a67d73bd7b8c499451a43ee8c520a \ No newline at end of file +f07961292c413fd6c3931110becc6fb8 \ No newline at end of file diff --git a/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e_dep.svg b/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e_dep.svg index 907ba81d..db1e3b61 100644 --- a/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e_dep.svg +++ b/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e_dep.svg @@ -1,14 +1,13 @@ - - - - + + - + src/include/gridfire/engine clusterdir_3626e0c0e3c5d7812d6b277dfa4ec364 - -gridfire + +gridfire clusterdir_aff155d61c3b73b9ab7dcdc908c4d49e - + @@ -38,62 +37,62 @@ dir_1d1d50ce0d70b163d7d102a960190628 - -partition - - - - - -dir_1c671bae89ad45c4f6571bd7c3fca7f2 - - -io + +partition - + dir_9e86cb84d90706cd957af3c853ce5bc2 - - -types + + +types - + dir_ad59de2d6f32552fa0ecb4acca2fbb0b - - -screening + + +screening - + dir_f2d7b0c77cb2532170ac94ead6e4ba70 - - -reaction + + +reaction + + + + + +dir_1c671bae89ad45c4f6571bd7c3fca7f2 + + +io dir_aff155d61c3b73b9ab7dcdc908c4d49e -engine +engine dir_aff155d61c3b73b9ab7dcdc908c4d49e->dir_1d1d50ce0d70b163d7d102a960190628 - - + + -1 +1 @@ -101,12 +100,12 @@ dir_aff155d61c3b73b9ab7dcdc908c4d49e->dir_9e86cb84d90706cd957af3c853ce5bc2 - - + + -5 +5 @@ -114,12 +113,12 @@ dir_aff155d61c3b73b9ab7dcdc908c4d49e->dir_ad59de2d6f32552fa0ecb4acca2fbb0b - - + + -6 +6 @@ -127,12 +126,12 @@ dir_aff155d61c3b73b9ab7dcdc908c4d49e->dir_f2d7b0c77cb2532170ac94ead6e4ba70 - - + + -6 +6 @@ -140,8 +139,8 @@ dir_b893969db6254951682857c720518fa8 - -diagnostics + +diagnostics @@ -149,12 +148,12 @@ dir_aff155d61c3b73b9ab7dcdc908c4d49e->dir_b893969db6254951682857c720518fa8 - - + + -1 +1 @@ -162,8 +161,8 @@ dir_fedd162cb41c94f7e299c266e75251fd - -procedures + +procedures @@ -171,12 +170,12 @@ dir_aff155d61c3b73b9ab7dcdc908c4d49e->dir_fedd162cb41c94f7e299c266e75251fd - - + + -3 +3 @@ -184,8 +183,8 @@ dir_80d0745b866022f2047f807b3376dff7 - -types + +types @@ -193,12 +192,12 @@ dir_aff155d61c3b73b9ab7dcdc908c4d49e->dir_80d0745b866022f2047f807b3376dff7 - - + + -5 +5 @@ -206,8 +205,8 @@ dir_d5492b42d970deba31f48df1b35a6c47 - -views + +views @@ -215,12 +214,12 @@ dir_aff155d61c3b73b9ab7dcdc908c4d49e->dir_d5492b42d970deba31f48df1b35a6c47 - - + + -1 +1 @@ -228,12 +227,12 @@ dir_fedd162cb41c94f7e299c266e75251fd->dir_9e86cb84d90706cd957af3c853ce5bc2 - - + + -1 +1 @@ -241,12 +240,12 @@ dir_fedd162cb41c94f7e299c266e75251fd->dir_f2d7b0c77cb2532170ac94ead6e4ba70 - - + + -2 +2 @@ -254,25 +253,12 @@ dir_fedd162cb41c94f7e299c266e75251fd->dir_80d0745b866022f2047f807b3376dff7 - - + + -1 - - - - - -dir_d5492b42d970deba31f48df1b35a6c47->dir_1c671bae89ad45c4f6571bd7c3fca7f2 - - - - - - -1 +1 @@ -280,12 +266,12 @@ dir_d5492b42d970deba31f48df1b35a6c47->dir_9e86cb84d90706cd957af3c853ce5bc2 - - + + -2 +2 @@ -293,12 +279,25 @@ dir_d5492b42d970deba31f48df1b35a6c47->dir_ad59de2d6f32552fa0ecb4acca2fbb0b - - + + -2 +2 + + + + + +dir_d5492b42d970deba31f48df1b35a6c47->dir_1c671bae89ad45c4f6571bd7c3fca7f2 + + + + + + +1 @@ -306,12 +305,12 @@ dir_d5492b42d970deba31f48df1b35a6c47->dir_fedd162cb41c94f7e299c266e75251fd - - + + -1 +1 diff --git a/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e_dep_org.svg b/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e_dep_org.svg index 4f5b3ab6..de57183b 100644 --- a/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e_dep_org.svg +++ b/docs/html/dir_aff155d61c3b73b9ab7dcdc908c4d49e_dep_org.svg @@ -1,25 +1,25 @@ - - - + + src/include/gridfire/engine clusterdir_3626e0c0e3c5d7812d6b277dfa4ec364 - -gridfire + +gridfire clusterdir_aff155d61c3b73b9ab7dcdc908c4d49e - + @@ -27,62 +27,62 @@ dir_1d1d50ce0d70b163d7d102a960190628 - -partition - - - - - -dir_1c671bae89ad45c4f6571bd7c3fca7f2 - - -io + +partition - + dir_9e86cb84d90706cd957af3c853ce5bc2 - - -types + + +types - + dir_ad59de2d6f32552fa0ecb4acca2fbb0b - - -screening + + +screening - + dir_f2d7b0c77cb2532170ac94ead6e4ba70 - - -reaction + + +reaction + + + + + +dir_1c671bae89ad45c4f6571bd7c3fca7f2 + + +io dir_aff155d61c3b73b9ab7dcdc908c4d49e -engine +engine dir_aff155d61c3b73b9ab7dcdc908c4d49e->dir_1d1d50ce0d70b163d7d102a960190628 - - + + -1 +1 @@ -90,12 +90,12 @@ dir_aff155d61c3b73b9ab7dcdc908c4d49e->dir_9e86cb84d90706cd957af3c853ce5bc2 - - + + -5 +5 @@ -103,12 +103,12 @@ dir_aff155d61c3b73b9ab7dcdc908c4d49e->dir_ad59de2d6f32552fa0ecb4acca2fbb0b - - + + -6 +6 @@ -116,12 +116,12 @@ dir_aff155d61c3b73b9ab7dcdc908c4d49e->dir_f2d7b0c77cb2532170ac94ead6e4ba70 - - + + -6 +6 @@ -129,8 +129,8 @@ dir_b893969db6254951682857c720518fa8 - -diagnostics + +diagnostics @@ -138,12 +138,12 @@ dir_aff155d61c3b73b9ab7dcdc908c4d49e->dir_b893969db6254951682857c720518fa8 - - + + -1 +1 @@ -151,8 +151,8 @@ dir_fedd162cb41c94f7e299c266e75251fd - -procedures + +procedures @@ -160,12 +160,12 @@ dir_aff155d61c3b73b9ab7dcdc908c4d49e->dir_fedd162cb41c94f7e299c266e75251fd - - + + -3 +3 @@ -173,8 +173,8 @@ dir_80d0745b866022f2047f807b3376dff7 - -types + +types @@ -182,12 +182,12 @@ dir_aff155d61c3b73b9ab7dcdc908c4d49e->dir_80d0745b866022f2047f807b3376dff7 - - + + -5 +5 @@ -195,8 +195,8 @@ dir_d5492b42d970deba31f48df1b35a6c47 - -views + +views @@ -204,12 +204,12 @@ dir_aff155d61c3b73b9ab7dcdc908c4d49e->dir_d5492b42d970deba31f48df1b35a6c47 - - + + -1 +1 @@ -217,12 +217,12 @@ dir_fedd162cb41c94f7e299c266e75251fd->dir_9e86cb84d90706cd957af3c853ce5bc2 - - + + -1 +1 @@ -230,12 +230,12 @@ dir_fedd162cb41c94f7e299c266e75251fd->dir_f2d7b0c77cb2532170ac94ead6e4ba70 - - + + -2 +2 @@ -243,25 +243,12 @@ dir_fedd162cb41c94f7e299c266e75251fd->dir_80d0745b866022f2047f807b3376dff7 - - + + -1 - - - - - -dir_d5492b42d970deba31f48df1b35a6c47->dir_1c671bae89ad45c4f6571bd7c3fca7f2 - - - - - - -1 +1 @@ -269,12 +256,12 @@ dir_d5492b42d970deba31f48df1b35a6c47->dir_9e86cb84d90706cd957af3c853ce5bc2 - - + + -2 +2 @@ -282,12 +269,25 @@ dir_d5492b42d970deba31f48df1b35a6c47->dir_ad59de2d6f32552fa0ecb4acca2fbb0b - - + + -2 +2 + + + + + +dir_d5492b42d970deba31f48df1b35a6c47->dir_1c671bae89ad45c4f6571bd7c3fca7f2 + + + + + + +1 @@ -295,12 +295,12 @@ dir_d5492b42d970deba31f48df1b35a6c47->dir_fedd162cb41c94f7e299c266e75251fd - - + + -1 +1 diff --git a/docs/html/dir_b0553efdd4ad7f265c0580564941af0c.html b/docs/html/dir_b0553efdd4ad7f265c0580564941af0c.html index 8353bffb..6d113327 100644 --- a/docs/html/dir_b0553efdd4ad7f265c0580564941af0c.html +++ b/docs/html/dir_b0553efdd4ad7f265c0580564941af0c.html @@ -3,18 +3,16 @@ - +GridFire: src/lib/solver/strategies Directory Reference - + - - @@ -29,7 +27,7 @@ @@ -38,24 +36,19 @@

@@ -136,7 +129,7 @@ Files
-
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -115,7 +108,7 @@ Directories - +

Files

 CVODE_solver_strategy.cpp
 CVODE_solver_strategy.cpp
 
@@ -124,7 +117,7 @@ Files diff --git a/docs/html/dir_b0553efdd4ad7f265c0580564941af0c.js b/docs/html/dir_b0553efdd4ad7f265c0580564941af0c.js index 980185b9..861f683d 100644 --- a/docs/html/dir_b0553efdd4ad7f265c0580564941af0c.js +++ b/docs/html/dir_b0553efdd4ad7f265c0580564941af0c.js @@ -1,5 +1,5 @@ var dir_b0553efdd4ad7f265c0580564941af0c = [ [ "triggers", "dir_897cfbcdbf2b76d535de4ec754728fa0.html", "dir_897cfbcdbf2b76d535de4ec754728fa0" ], - [ "CVODE_solver_strategy.cpp", "_c_v_o_d_e__solver__strategy_8cpp.html", null ] + [ "CVODE_solver_strategy.cpp", "CVODE__solver__strategy_8cpp.html", null ] ]; \ No newline at end of file diff --git a/docs/html/dir_b0856f6b0d80ccb263b2f415c91f9e17.html b/docs/html/dir_b0856f6b0d80ccb263b2f415c91f9e17.html index 932d245f..528249c8 100644 --- a/docs/html/dir_b0856f6b0d80ccb263b2f415c91f9e17.html +++ b/docs/html/dir_b0856f6b0d80ccb263b2f415c91f9e17.html @@ -3,18 +3,16 @@ - + GridFire: src/include Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -119,7 +112,7 @@ Directories diff --git a/docs/html/dir_b854c27c088682f074a57cfa949846df.html b/docs/html/dir_b854c27c088682f074a57cfa949846df.html index e34b1206..d3c6abc5 100644 --- a/docs/html/dir_b854c27c088682f074a57cfa949846df.html +++ b/docs/html/dir_b854c27c088682f074a57cfa949846df.html @@ -3,18 +3,16 @@ - + GridFire: src/python/reaction Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -121,7 +114,7 @@ Files diff --git a/docs/html/dir_b893969db6254951682857c720518fa8.html b/docs/html/dir_b893969db6254951682857c720518fa8.html index f7834558..8470df45 100644 --- a/docs/html/dir_b893969db6254951682857c720518fa8.html +++ b/docs/html/dir_b893969db6254951682857c720518fa8.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/engine/diagnostics Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -120,7 +113,7 @@ Files diff --git a/docs/html/dir_bf5ef66fceb9aacde9848923f7632729.html b/docs/html/dir_bf5ef66fceb9aacde9848923f7632729.html index 648d7f74..48fb187a 100644 --- a/docs/html/dir_bf5ef66fceb9aacde9848923f7632729.html +++ b/docs/html/dir_bf5ef66fceb9aacde9848923f7632729.html @@ -3,18 +3,16 @@ - + GridFire: src/python/exceptions Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -121,7 +114,7 @@ Files diff --git a/docs/html/dir_bfff093b02c380358955f421b7f67de5.html b/docs/html/dir_bfff093b02c380358955f421b7f67de5.html index 5e4837f1..15379c55 100644 --- a/docs/html/dir_bfff093b02c380358955f421b7f67de5.html +++ b/docs/html/dir_bfff093b02c380358955f421b7f67de5.html @@ -3,18 +3,16 @@ - + GridFire: src/python/solver/trampoline Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -121,7 +114,7 @@ Files diff --git a/docs/html/dir_c34d5e8363cf0aa3fabc4f3fad3412a4.html b/docs/html/dir_c34d5e8363cf0aa3fabc4f3fad3412a4.html index f3014906..0ab7b761 100644 --- a/docs/html/dir_c34d5e8363cf0aa3fabc4f3fad3412a4.html +++ b/docs/html/dir_c34d5e8363cf0aa3fabc4f3fad3412a4.html @@ -3,18 +3,16 @@ - + GridFire: docs/static Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -113,7 +106,7 @@ Directory dependency graph for static:
diff --git a/docs/html/dir_c73541f51459c9e567d01a066f229f1c.html b/docs/html/dir_c73541f51459c9e567d01a066f229f1c.html index 58a6d0c0..28993c38 100644 --- a/docs/html/dir_c73541f51459c9e567d01a066f229f1c.html +++ b/docs/html/dir_c73541f51459c9e567d01a066f229f1c.html @@ -3,18 +3,16 @@ - + GridFire: src/lib/screening Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -123,7 +116,7 @@ Files diff --git a/docs/html/dir_c85d3e3c5052e9ad9ce18c6863244a25.html b/docs/html/dir_c85d3e3c5052e9ad9ce18c6863244a25.html index 029b52c4..9ed120c1 100644 --- a/docs/html/dir_c85d3e3c5052e9ad9ce18c6863244a25.html +++ b/docs/html/dir_c85d3e3c5052e9ad9ce18c6863244a25.html @@ -3,18 +3,16 @@ - + GridFire: src/lib Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -133,7 +126,7 @@ Directories diff --git a/docs/html/dir_c99e86cd0291aa23d2204e664fe571c1.html b/docs/html/dir_c99e86cd0291aa23d2204e664fe571c1.html index aef39f78..670f0e26 100644 --- a/docs/html/dir_c99e86cd0291aa23d2204e664fe571c1.html +++ b/docs/html/dir_c99e86cd0291aa23d2204e664fe571c1.html @@ -3,18 +3,16 @@ - + GridFire: src/lib/engine/diagnostics Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -119,7 +112,7 @@ Files diff --git a/docs/html/dir_ca2c361745bc4f459bed9a105a1955b0.html b/docs/html/dir_ca2c361745bc4f459bed9a105a1955b0.html index 65caf8e2..debecc59 100644 --- a/docs/html/dir_ca2c361745bc4f459bed9a105a1955b0.html +++ b/docs/html/dir_ca2c361745bc4f459bed9a105a1955b0.html @@ -3,18 +3,16 @@ - + GridFire: src/python/gridfire Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -119,7 +112,7 @@ Files diff --git a/docs/html/dir_cd87a60aa1dbf4ee960e0533fd7a9743.html b/docs/html/dir_cd87a60aa1dbf4ee960e0533fd7a9743.html index 458b76e2..d84d5003 100644 --- a/docs/html/dir_cd87a60aa1dbf4ee960e0533fd7a9743.html +++ b/docs/html/dir_cd87a60aa1dbf4ee960e0533fd7a9743.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/exceptions Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -134,7 +127,7 @@ Files diff --git a/docs/html/dir_d0a49494bbb6e91de214e6669adf5efa.html b/docs/html/dir_d0a49494bbb6e91de214e6669adf5efa.html index d12cdfea..ab7e490c 100644 --- a/docs/html/dir_d0a49494bbb6e91de214e6669adf5efa.html +++ b/docs/html/dir_d0a49494bbb6e91de214e6669adf5efa.html @@ -3,18 +3,16 @@ - + GridFire: src/python/engine Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -126,7 +119,7 @@ Files diff --git a/docs/html/dir_d2ba15782ddae84c3d0c5f0e63bda236.html b/docs/html/dir_d2ba15782ddae84c3d0c5f0e63bda236.html index ee763207..4c2a48e4 100644 --- a/docs/html/dir_d2ba15782ddae84c3d0c5f0e63bda236.html +++ b/docs/html/dir_d2ba15782ddae84c3d0c5f0e63bda236.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/trigger/procedures Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -121,7 +114,7 @@ Files diff --git a/docs/html/dir_d5492b42d970deba31f48df1b35a6c47.html b/docs/html/dir_d5492b42d970deba31f48df1b35a6c47.html index f4443943..10058e21 100644 --- a/docs/html/dir_d5492b42d970deba31f48df1b35a6c47.html +++ b/docs/html/dir_d5492b42d970deba31f48df1b35a6c47.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/engine/views Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -130,7 +123,7 @@ Files diff --git a/docs/html/dir_d70391a28a381da2f0629437a1b6db28.html b/docs/html/dir_d70391a28a381da2f0629437a1b6db28.html index 2723eec0..0e103832 100644 --- a/docs/html/dir_d70391a28a381da2f0629437a1b6db28.html +++ b/docs/html/dir_d70391a28a381da2f0629437a1b6db28.html @@ -3,18 +3,16 @@ - + GridFire: src/python/types Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -121,7 +114,7 @@ Files diff --git a/docs/html/dir_d8b7e23cf0e7cbdccc15d25172634c8e.html b/docs/html/dir_d8b7e23cf0e7cbdccc15d25172634c8e.html index 5d2739a0..f3054402 100644 --- a/docs/html/dir_d8b7e23cf0e7cbdccc15d25172634c8e.html +++ b/docs/html/dir_d8b7e23cf0e7cbdccc15d25172634c8e.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/utils/formatters Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -121,7 +114,7 @@ Files diff --git a/docs/html/dir_da65b9a371696ae0281f77edf1c03876.html b/docs/html/dir_da65b9a371696ae0281f77edf1c03876.html index 10485f99..1b396cca 100644 --- a/docs/html/dir_da65b9a371696ae0281f77edf1c03876.html +++ b/docs/html/dir_da65b9a371696ae0281f77edf1c03876.html @@ -3,18 +3,16 @@ - + GridFire: src/lib/reaction/weak Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -121,7 +114,7 @@ Files diff --git a/docs/html/dir_dd8201c056cb17022d2864e6e5aa368d.html b/docs/html/dir_dd8201c056cb17022d2864e6e5aa368d.html index 6afb0df8..24d26309 100644 --- a/docs/html/dir_dd8201c056cb17022d2864e6e5aa368d.html +++ b/docs/html/dir_dd8201c056cb17022d2864e6e5aa368d.html @@ -3,18 +3,16 @@ - + GridFire: src/python/io/trampoline Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -121,7 +114,7 @@ Files diff --git a/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b.html b/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b.html index 094c0dad..912f3e11 100644 --- a/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b.html +++ b/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/solver Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -105,7 +98,7 @@ $(function(){initNavTree('dir_e2a8863ee8e7cd9122c04bdba1c35a3b.html',''); initRe
Directory dependency graph for solver:
-
+
diff --git a/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b_dep.map b/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b_dep.map index 5abafd90..e6f69a0b 100644 --- a/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b_dep.map +++ b/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b_dep.map @@ -1,19 +1,19 @@ - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + diff --git a/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b_dep.md5 b/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b_dep.md5 index 61d30a1b..80ebb66e 100644 --- a/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b_dep.md5 +++ b/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b_dep.md5 @@ -1 +1 @@ -c67af11193049248451e6849367cc681 \ No newline at end of file +8d7b963bd99c64cff89cf4b84d9d73d0 \ No newline at end of file diff --git a/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b_dep.svg b/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b_dep.svg index 8bf42bbf..bc7da8e0 100644 --- a/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b_dep.svg +++ b/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b_dep.svg @@ -1,14 +1,13 @@ - - - - + + - + src/include/gridfire/solver clusterdir_3626e0c0e3c5d7812d6b277dfa4ec364 - -gridfire + +gridfire clusterdir_e2a8863ee8e7cd9122c04bdba1c35a3b - + @@ -38,49 +37,49 @@ dir_aff155d61c3b73b9ab7dcdc908c4d49e - -engine - - - - - -dir_6ccae78e9032a1b4db4873aea5f3b43d - - -trigger + +engine - + dir_9e86cb84d90706cd957af3c853ce5bc2 - - -types + + +types - + dir_cd87a60aa1dbf4ee960e0533fd7a9743 - - -exceptions + + +exceptions + + + + + +dir_6ccae78e9032a1b4db4873aea5f3b43d + + +trigger dir_e2a8863ee8e7cd9122c04bdba1c35a3b -solver +solver dir_230a420a279f78b45ea47b2d650bf1a7 - -strategies + +strategies @@ -88,12 +87,12 @@ dir_e2a8863ee8e7cd9122c04bdba1c35a3b->dir_230a420a279f78b45ea47b2d650bf1a7 - - + + -2 +2 @@ -101,25 +100,12 @@ dir_230a420a279f78b45ea47b2d650bf1a7->dir_aff155d61c3b73b9ab7dcdc908c4d49e - - + + -2 - - - - - -dir_230a420a279f78b45ea47b2d650bf1a7->dir_6ccae78e9032a1b4db4873aea5f3b43d - - - - - - -2 +2 @@ -127,12 +113,12 @@ dir_230a420a279f78b45ea47b2d650bf1a7->dir_9e86cb84d90706cd957af3c853ce5bc2 - - + + -2 +2 @@ -140,12 +126,25 @@ dir_230a420a279f78b45ea47b2d650bf1a7->dir_cd87a60aa1dbf4ee960e0533fd7a9743 - - + + -1 +1 + + + + + +dir_230a420a279f78b45ea47b2d650bf1a7->dir_6ccae78e9032a1b4db4873aea5f3b43d + + + + + + +2 diff --git a/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b_dep_org.svg b/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b_dep_org.svg index f72a4d1f..f8a5e1ad 100644 --- a/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b_dep_org.svg +++ b/docs/html/dir_e2a8863ee8e7cd9122c04bdba1c35a3b_dep_org.svg @@ -1,25 +1,25 @@ - - - + + src/include/gridfire/solver clusterdir_3626e0c0e3c5d7812d6b277dfa4ec364 - -gridfire + +gridfire clusterdir_e2a8863ee8e7cd9122c04bdba1c35a3b - + @@ -27,49 +27,49 @@ dir_aff155d61c3b73b9ab7dcdc908c4d49e - -engine - - - - - -dir_6ccae78e9032a1b4db4873aea5f3b43d - - -trigger + +engine - + dir_9e86cb84d90706cd957af3c853ce5bc2 - - -types + + +types - + dir_cd87a60aa1dbf4ee960e0533fd7a9743 - - -exceptions + + +exceptions + + + + + +dir_6ccae78e9032a1b4db4873aea5f3b43d + + +trigger dir_e2a8863ee8e7cd9122c04bdba1c35a3b -solver +solver dir_230a420a279f78b45ea47b2d650bf1a7 - -strategies + +strategies @@ -77,12 +77,12 @@ dir_e2a8863ee8e7cd9122c04bdba1c35a3b->dir_230a420a279f78b45ea47b2d650bf1a7 - - + + -2 +2 @@ -90,25 +90,12 @@ dir_230a420a279f78b45ea47b2d650bf1a7->dir_aff155d61c3b73b9ab7dcdc908c4d49e - - + + -2 - - - - - -dir_230a420a279f78b45ea47b2d650bf1a7->dir_6ccae78e9032a1b4db4873aea5f3b43d - - - - - - -2 +2 @@ -116,12 +103,12 @@ dir_230a420a279f78b45ea47b2d650bf1a7->dir_9e86cb84d90706cd957af3c853ce5bc2 - - + + -2 +2 @@ -129,12 +116,25 @@ dir_230a420a279f78b45ea47b2d650bf1a7->dir_cd87a60aa1dbf4ee960e0533fd7a9743 - - + + -1 +1 + + + + + +dir_230a420a279f78b45ea47b2d650bf1a7->dir_6ccae78e9032a1b4db4873aea5f3b43d + + + + + + +2 diff --git a/docs/html/dir_e87948a39c0c6c3f66d9f5f967ab86bd.html b/docs/html/dir_e87948a39c0c6c3f66d9f5f967ab86bd.html index 2ba3f0fc..22c556a9 100644 --- a/docs/html/dir_e87948a39c0c6c3f66d9f5f967ab86bd.html +++ b/docs/html/dir_e87948a39c0c6c3f66d9f5f967ab86bd.html @@ -3,18 +3,16 @@ - +GridFire: src/lib/engine/views Directory Reference - + - - @@ -29,7 +27,7 @@ @@ -38,24 +36,19 @@

@@ -124,7 +117,7 @@ Files
-
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -125,7 +118,7 @@ Files diff --git a/docs/html/dir_f2d7b0c77cb2532170ac94ead6e4ba70.html b/docs/html/dir_f2d7b0c77cb2532170ac94ead6e4ba70.html index 275a63d6..7de8fbf5 100644 --- a/docs/html/dir_f2d7b0c77cb2532170ac94ead6e4ba70.html +++ b/docs/html/dir_f2d7b0c77cb2532170ac94ead6e4ba70.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/reaction Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -129,7 +122,7 @@ Files diff --git a/docs/html/dir_f4383b1846ef599868e873d917f1344c.html b/docs/html/dir_f4383b1846ef599868e873d917f1344c.html index 3fa29b87..964e9548 100644 --- a/docs/html/dir_f4383b1846ef599868e873d917f1344c.html +++ b/docs/html/dir_f4383b1846ef599868e873d917f1344c.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/interfaces Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -119,7 +112,7 @@ Directories diff --git a/docs/html/dir_f575fd282ecf3769a887e0c3d3cafd55.html b/docs/html/dir_f575fd282ecf3769a887e0c3d3cafd55.html index 0db2286c..7a3cb0c9 100644 --- a/docs/html/dir_f575fd282ecf3769a887e0c3d3cafd55.html +++ b/docs/html/dir_f575fd282ecf3769a887e0c3d3cafd55.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/partition/composite Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -119,7 +112,7 @@ Files diff --git a/docs/html/dir_f79ba22e4d7153a09a819f6726b2d7e8.html b/docs/html/dir_f79ba22e4d7153a09a819f6726b2d7e8.html index c228c531..c6cbe898 100644 --- a/docs/html/dir_f79ba22e4d7153a09a819f6726b2d7e8.html +++ b/docs/html/dir_f79ba22e4d7153a09a819f6726b2d7e8.html @@ -3,18 +3,16 @@ - + GridFire: src/extern/lib Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -121,7 +114,7 @@ Files diff --git a/docs/html/dir_fe5109f07276e0a4a472af6b22fd99c7.html b/docs/html/dir_fe5109f07276e0a4a472af6b22fd99c7.html index 7bf73f54..9ae5e751 100644 --- a/docs/html/dir_fe5109f07276e0a4a472af6b22fd99c7.html +++ b/docs/html/dir_fe5109f07276e0a4a472af6b22fd99c7.html @@ -3,18 +3,16 @@ - + GridFire: src/lib/partition Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -126,7 +119,7 @@ Files diff --git a/docs/html/dir_fe7d6b610561b6ccbae8c0cd892464cf.html b/docs/html/dir_fe7d6b610561b6ccbae8c0cd892464cf.html index 057b39b6..2e3820ab 100644 --- a/docs/html/dir_fe7d6b610561b6ccbae8c0cd892464cf.html +++ b/docs/html/dir_fe7d6b610561b6ccbae8c0cd892464cf.html @@ -3,18 +3,16 @@ - + GridFire: src/python/screening/trampoline Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -121,7 +114,7 @@ Files diff --git a/docs/html/dir_fedd162cb41c94f7e299c266e75251fd.html b/docs/html/dir_fedd162cb41c94f7e299c266e75251fd.html index 22334619..991f48b3 100644 --- a/docs/html/dir_fedd162cb41c94f7e299c266e75251fd.html +++ b/docs/html/dir_fedd162cb41c94f7e299c266e75251fd.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/engine/procedures Directory Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -124,7 +117,7 @@ Files diff --git a/docs/html/doxygen.css b/docs/html/doxygen.css index 90fba19b..8cff99eb 100644 --- a/docs/html/doxygen.css +++ b/docs/html/doxygen.css @@ -1,4 +1,4 @@ -/* The standard CSS for doxygen 1.13.2*/ +/* The standard CSS for doxygen 1.9.8*/ body { background-color: white; @@ -15,6 +15,8 @@ body, table, div, p, dl { /* @group Heading Levels */ .title { + font-weight: 400; + font-size: 14px; font-family: Roboto,sans-serif; line-height: 28px; font-size: 150%; @@ -212,13 +214,7 @@ a { } a:hover { - text-decoration: none; - background: linear-gradient(to bottom, transparent 0,transparent calc(100% - 1px), currentColor 100%); -} - -a:hover > span.arrow { - text-decoration: none; - background : #F9FAFC; + text-decoration: underline; } a.el { @@ -269,24 +265,7 @@ dl.el { margin-left: -1cm; } -ul.check { - list-style:none; - text-indent: -16px; - padding-left: 38px; -} -li.unchecked:before { - content: "\2610\A0"; -} -li.checked:before { - content: "\2611\A0"; -} - -ol { - text-indent: 0px; -} - ul { - text-indent: 0px; overflow: visible; } @@ -311,62 +290,30 @@ ul.multicol { .fragment { text-align: left; direction: ltr; - overflow-x: auto; + overflow-x: auto; /*Fixed: fragment lines overlap floating elements*/ overflow-y: hidden; - position: relative; - min-height: 12px; - margin: 10px 0px; - padding: 10px 10px; - border: 1px solid #C4CFE5; - border-radius: 4px; - background-color: #FBFCFD; - color: black; } pre.fragment { - word-wrap: break-word; - font-size: 10pt; - line-height: 125%; - font-family: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed; + border: 1px solid #C4CFE5; + background-color: #FBFCFD; + color: black; + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + word-wrap: break-word; + font-size: 9pt; + line-height: 125%; + font-family: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed; + font-size: 105%; } -.clipboard { - width: 24px; - height: 24px; - right: 5px; - top: 5px; - opacity: 0; - position: absolute; - display: inline; - overflow: hidden; - justify-content: center; - align-items: center; - cursor: pointer; -} - -.clipboard.success { - border: 1px solid black; - border-radius: 4px; -} - -.fragment:hover .clipboard, .clipboard.success { - opacity: .4; -} - -.clipboard:hover, .clipboard.success { - opacity: 1 !important; -} - -.clipboard:active:not([class~=success]) svg { - transform: scale(.91); -} - -.clipboard.success svg { - fill: #2EC82E; -} - -.clipboard.success { - border-color: #2EC82E; +div.fragment { + padding: 0 0 1px 0; /*Fixed: last line underline overlap border*/ + margin: 4px 8px 4px 2px; + color: black; + background-color: #FBFCFD; + border: 1px solid #C4CFE5; } div.line { @@ -489,6 +436,10 @@ img.light-mode-visible { display: none; } +img.formulaDsp { + +} + img.formulaInl, img.inline { vertical-align: middle; } @@ -788,25 +739,17 @@ dl.reflist dd { .paramtype { white-space: nowrap; - padding: 0px; - padding-bottom: 1px; } .paramname { - white-space: nowrap; - padding: 0px; - padding-bottom: 1px; - margin-left: 2px; -} - -.paramname em { color: #602020; - font-style: normal; - margin-right: 1px; + white-space: nowrap; } - -.paramname .paramdefval { - font-family: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed; +.paramname em { + font-style: normal; +} +.paramname code { + line-height: 14px; } .params, .retval, .exception, .tparams { @@ -1056,7 +999,7 @@ table.fieldtable { padding: 3px 7px 2px; } -.fieldtable td.fieldtype, .fieldtable td.fieldname, .fieldtable td.fieldinit { +.fieldtable td.fieldtype, .fieldtable td.fieldname { white-space: nowrap; border-right: 1px solid #A8B8D9; border-bottom: 1px solid #A8B8D9; @@ -1067,12 +1010,6 @@ table.fieldtable { padding-top: 3px; } -.fieldtable td.fieldinit { - padding-top: 3px; - text-align: right; -} - - .fieldtable td.fielddoc { border-bottom: 1px solid #A8B8D9; } @@ -1146,6 +1083,7 @@ table.fieldtable { { height:32px; display:block; + text-decoration: none; outline: none; color: #283A5D; font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; @@ -1234,8 +1172,7 @@ dl { padding: 0 0 0 0; } -/* - +/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug, dl.examples */ dl.section { margin-left: 0px; padding-left: 0px; @@ -1248,7 +1185,7 @@ dl.note { border-color: #D0C000; } -dl.warning, dl.attention, dl.important { +dl.warning, dl.attention { margin-left: -7px; padding-left: 3px; border-left: 4px solid; @@ -1290,103 +1227,8 @@ dl.bug { border-color: #C08050; } -*/ - -dl.bug dt a, dl.deprecated dt a, dl.todo dt a, dl.test a { - font-weight: bold !important; -} - -dl.warning, dl.attention, dl.important, dl.note, dl.deprecated, dl.bug, -dl.invariant, dl.pre, dl.post, dl.todo, dl.test, dl.remark { - padding: 10px; - margin: 10px 0px; - overflow: hidden; - margin-left: 0; - border-radius: 4px; -} - dl.section dd { - margin-bottom: 2px; -} - -dl.warning, dl.attention, dl.important { - background: #f8d1cc; - border-left: 8px solid #b61825; - color: #75070f; -} - -dl.warning dt, dl.attention dt, dl.important dt { - color: #b61825; -} - -dl.note, dl.remark { - background: #faf3d8; - border-left: 8px solid #f3a600; - color: #5f4204; -} - -dl.note dt, dl.remark dt { - color: #f3a600; -} - -dl.todo { - background: #e4f3ff; - border-left: 8px solid #1879C4; - color: #274a5c; -} - -dl.todo dt { - color: #1879C4; -} - -dl.test { - background: #e8e8ff; - border-left: 8px solid #3939C4; - color: #1a1a5c; -} - -dl.test dt { - color: #3939C4; -} - -dl.bug dt a { - color: #5b2bdd !important; -} - -dl.bug { - background: #e4dafd; - border-left: 8px solid #5b2bdd; - color: #2a0d72; -} - -dl.bug dt a { - color: #5b2bdd !important; -} - -dl.deprecated { - background: #ecf0f3; - border-left: 8px solid #5b6269; - color: #43454a; -} - -dl.deprecated dt a { - color: #5b6269 !important; -} - -dl.note dd, dl.warning dd, dl.pre dd, dl.post dd, -dl.remark dd, dl.attention dd, dl.important dd, dl.invariant dd, -dl.bug dd, dl.deprecated dd, dl.todo dd, dl.test dd { - margin-inline-start: 0px; -} - -dl.invariant, dl.pre, dl.post { - background: #d8f1e3; - border-left: 8px solid #44b86f; - color: #265532; -} - -dl.invariant dt, dl.pre dt, dl.post dt { - color: #44b86f; + margin-bottom: 6px; } @@ -1401,12 +1243,12 @@ dl.invariant dt, dl.pre dt, dl.post dt { vertical-align: bottom; border-collapse: separate; } - + #projectlogo img -{ +{ border: 0px none; } - + #projectalign { vertical-align: middle; @@ -1421,11 +1263,6 @@ dl.invariant dt, dl.pre dt, dl.post dt { padding: 2px 0px; } -#side-nav #projectname -{ - font-size: 130%; -} - #projectbrief { font-size: 90%; @@ -1532,17 +1369,20 @@ div.toc ul { padding: 0px; } -div.toc li[class^='level'] { - margin-left: 15px; -} - div.toc li.level1 { margin-left: 0px; } -div.toc li.empty { - background-image: none; - margin-top: 0px; +div.toc li.level2 { + margin-left: 15px; +} + +div.toc li.level3 { + margin-left: 15px; +} + +div.toc li.level4 { + margin-left: 15px; } span.emoji { @@ -1813,14 +1653,10 @@ th.markdownTableHeadCenter, td.markdownTableBodyCenter { text-align: center } -tt, code, kbd +tt, code, kbd, samp { display: inline-block; } -tt, code, kbd -{ - vertical-align: top; -} /* @end */ u { diff --git a/docs/html/dynamic__engine__diagnostics_8cpp.html b/docs/html/dynamic__engine__diagnostics_8cpp.html index 0f8b2758..35115bb6 100644 --- a/docs/html/dynamic__engine__diagnostics_8cpp.html +++ b/docs/html/dynamic__engine__diagnostics_8cpp.html @@ -3,18 +3,16 @@ - + GridFire: src/lib/engine/diagnostics/dynamic_engine_diagnostics.cpp File Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -120,22 +113,22 @@ Include dependency graph for dynamic_engine_diagnostics.cpp:
- + - + - +

Namespaces

namespace  gridfire
namespace  gridfire
 
namespace  gridfire::engine
namespace  gridfire::engine
 
namespace  gridfire::engine::diagnostics
namespace  gridfire::engine::diagnostics
 
- + - + - +

Functions

std::optional< nlohmann::json > gridfire::engine::diagnostics::report_limiting_species (const DynamicEngine &engine, const std::vector< double > &Y_full, const std::vector< double > &E_full, double relTol, double absTol, size_t top_n=10, bool json=false)
std::optional< nlohmann::json > gridfire::engine::diagnostics::report_limiting_species (const DynamicEngine &engine, const std::vector< double > &Y_full, const std::vector< double > &E_full, double relTol, double absTol, size_t top_n=10, bool json=false)
 Report the species that are limiting the accuracy of the integration. This is useful for identifying species that may be limiting the timestepping due to their high relative errors compared to the specified tolerances.
 
std::optional< nlohmann::json > gridfire::engine::diagnostics::inspect_species_balance (const DynamicEngine &engine, const std::string &species_name, const fourdst::composition::Composition &comp, double T9, double rho, bool json)
std::optional< nlohmann::json > gridfire::engine::diagnostics::inspect_species_balance (const DynamicEngine &engine, const std::string &species_name, const fourdst::composition::Composition &comp, double T9, double rho, bool json)
 Inspect the production and destruction balance of a specific species in the reaction network. This function analyzes the reactions that create and destroy the specified species, providing insights into potential imbalances that may affect the accuracy of the simulation.
 
std::optional< nlohmann::json > gridfire::engine::diagnostics::inspect_jacobian_stiffness (const DynamicEngine &engine, const fourdst::composition::Composition &comp, double T9, double rho, bool json)
std::optional< nlohmann::json > gridfire::engine::diagnostics::inspect_jacobian_stiffness (const DynamicEngine &engine, const fourdst::composition::Composition &comp, double T9, double rho, bool json)
 Inspect the stiffness of the Jacobian matrix for the reaction network at the given temperature and density. This function evaluates the diagonal and off-diagonal elements of the Jacobian to identify potential numerical issues related to stiffness.
 
@@ -145,7 +138,7 @@ Functions diff --git a/docs/html/dynamic__engine__diagnostics_8cpp.js b/docs/html/dynamic__engine__diagnostics_8cpp.js index e4e7fcec..b6caabe1 100644 --- a/docs/html/dynamic__engine__diagnostics_8cpp.js +++ b/docs/html/dynamic__engine__diagnostics_8cpp.js @@ -1,6 +1,6 @@ var dynamic__engine__diagnostics_8cpp = [ - [ "gridfire::engine::diagnostics::inspect_jacobian_stiffness", "namespacegridfire_1_1engine_1_1diagnostics.html#a8a42702b787f12988ae8fc7e1e6d8186", null ], - [ "gridfire::engine::diagnostics::inspect_species_balance", "namespacegridfire_1_1engine_1_1diagnostics.html#aac2570f6bc58b8825674f60f1634149b", null ], - [ "gridfire::engine::diagnostics::report_limiting_species", "namespacegridfire_1_1engine_1_1diagnostics.html#ad792baf3c6720fce34a5161c0ade3fc4", null ] + [ "inspect_jacobian_stiffness", "dynamic__engine__diagnostics_8cpp.html#a8a42702b787f12988ae8fc7e1e6d8186", null ], + [ "inspect_species_balance", "dynamic__engine__diagnostics_8cpp.html#aac2570f6bc58b8825674f60f1634149b", null ], + [ "report_limiting_species", "dynamic__engine__diagnostics_8cpp.html#ad792baf3c6720fce34a5161c0ade3fc4", null ] ]; \ No newline at end of file diff --git a/docs/html/dynamic__engine__diagnostics_8h.html b/docs/html/dynamic__engine__diagnostics_8h.html index e6552fce..4c953ba4 100644 --- a/docs/html/dynamic__engine__diagnostics_8h.html +++ b/docs/html/dynamic__engine__diagnostics_8h.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/engine/diagnostics/dynamic_engine_diagnostics.h File Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -125,25 +118,25 @@ This graph shows which files directly or indirectly include this file:
- + - + - +

Namespaces

namespace  gridfire
namespace  gridfire
 
namespace  gridfire::engine
namespace  gridfire::engine
 
namespace  gridfire::engine::diagnostics
namespace  gridfire::engine::diagnostics
 
- + - + - + - +

Functions

std::optional< nlohmann::json > gridfire::engine::diagnostics::report_limiting_species (const DynamicEngine &engine, const std::vector< double > &Y_full, const std::vector< double > &E_full, double relTol, double absTol, size_t top_n=10, bool json=false)
std::optional< nlohmann::json > gridfire::engine::diagnostics::report_limiting_species (const DynamicEngine &engine, const std::vector< double > &Y_full, const std::vector< double > &E_full, double relTol, double absTol, size_t top_n=10, bool json=false)
 Report the species that are limiting the accuracy of the integration. This is useful for identifying species that may be limiting the timestepping due to their high relative errors compared to the specified tolerances.
 
std::optional< nlohmann::json > gridfire::engine::diagnostics::inspect_species_balance (const DynamicEngine &engine, const std::string &species_name, const fourdst::composition::Composition &comp, double T9, double rho, bool json)
std::optional< nlohmann::json > gridfire::engine::diagnostics::inspect_species_balance (const DynamicEngine &engine, const std::string &species_name, const fourdst::composition::Composition &comp, double T9, double rho, bool json)
 Inspect the production and destruction balance of a specific species in the reaction network. This function analyzes the reactions that create and destroy the specified species, providing insights into potential imbalances that may affect the accuracy of the simulation.
 
std::optional< nlohmann::json > gridfire::engine::diagnostics::inspect_jacobian_stiffness (const DynamicEngine &engine, const fourdst::composition::Composition &comp, double T9, double rho, bool json)
std::optional< nlohmann::json > gridfire::engine::diagnostics::inspect_jacobian_stiffness (const DynamicEngine &engine, const fourdst::composition::Composition &comp, double T9, double rho, bool json)
 Inspect the stiffness of the Jacobian matrix for the reaction network at the given temperature and density. This function evaluates the diagonal and off-diagonal elements of the Jacobian to identify potential numerical issues related to stiffness.
 
void gridfire::engine::diagnostics::save_jacobian_to_file (const NetworkJacobian &jacobian, const std::string &filename)
void gridfire::engine::diagnostics::save_jacobian_to_file (const NetworkJacobian &jacobian, const std::string &filename)
 Save the Jacobian matrix to a file for external analysis.
 
@@ -165,7 +158,7 @@ Functions diff --git a/docs/html/dynamic__engine__diagnostics_8h.js b/docs/html/dynamic__engine__diagnostics_8h.js index 64cc6935..c5f7e66a 100644 --- a/docs/html/dynamic__engine__diagnostics_8h.js +++ b/docs/html/dynamic__engine__diagnostics_8h.js @@ -1,7 +1,7 @@ var dynamic__engine__diagnostics_8h = [ - [ "gridfire::engine::diagnostics::inspect_jacobian_stiffness", "namespacegridfire_1_1engine_1_1diagnostics.html#a8a42702b787f12988ae8fc7e1e6d8186", null ], - [ "gridfire::engine::diagnostics::inspect_species_balance", "namespacegridfire_1_1engine_1_1diagnostics.html#aac2570f6bc58b8825674f60f1634149b", null ], - [ "gridfire::engine::diagnostics::report_limiting_species", "namespacegridfire_1_1engine_1_1diagnostics.html#ad792baf3c6720fce34a5161c0ade3fc4", null ], - [ "gridfire::engine::diagnostics::save_jacobian_to_file", "namespacegridfire_1_1engine_1_1diagnostics.html#ab247fdf00c23cf857d9131a3462d41ae", null ] + [ "inspect_jacobian_stiffness", "dynamic__engine__diagnostics_8h.html#a8a42702b787f12988ae8fc7e1e6d8186", null ], + [ "inspect_species_balance", "dynamic__engine__diagnostics_8h.html#aac2570f6bc58b8825674f60f1634149b", null ], + [ "report_limiting_species", "dynamic__engine__diagnostics_8h.html#ad792baf3c6720fce34a5161c0ade3fc4", null ], + [ "save_jacobian_to_file", "dynamic__engine__diagnostics_8h.html#ab247fdf00c23cf857d9131a3462d41ae", null ] ]; \ No newline at end of file diff --git a/docs/html/dynamic__engine__diagnostics_8h__dep__incl.map b/docs/html/dynamic__engine__diagnostics_8h__dep__incl.map index c46c4d2f..21adaa1e 100644 --- a/docs/html/dynamic__engine__diagnostics_8h__dep__incl.map +++ b/docs/html/dynamic__engine__diagnostics_8h__dep__incl.map @@ -1,28 +1,28 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/dynamic__engine__diagnostics_8h__dep__incl.md5 b/docs/html/dynamic__engine__diagnostics_8h__dep__incl.md5 index da21ab68..420673d6 100644 --- a/docs/html/dynamic__engine__diagnostics_8h__dep__incl.md5 +++ b/docs/html/dynamic__engine__diagnostics_8h__dep__incl.md5 @@ -1 +1 @@ -8eab2447f296fa2ee28fc6651e001f3c \ No newline at end of file +3398b780f9103dd5eae7745d0228a5cd \ No newline at end of file diff --git a/docs/html/dynamic__engine__diagnostics_8h__dep__incl.svg b/docs/html/dynamic__engine__diagnostics_8h__dep__incl.svg index 0270c361..5b5f1401 100644 --- a/docs/html/dynamic__engine__diagnostics_8h__dep__incl.svg +++ b/docs/html/dynamic__engine__diagnostics_8h__dep__incl.svg @@ -1,13 +1,12 @@ - - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +GridFireContext + + +Node1 + + +GridFireContext + + + + + +Node2 + + +std::unique_ptr< gridfire +::policy::NetworkPolicy > + + + + + +Node2->Node1 + + + + + + policy + + + +Node3 + + +gridfire::policy::Network +Policy + + + + + +Node3->Node2 + + + + + + ptr + + + +Node4 + + +gridfire::engine::Dynamic +Engine + + + + + +Node4->Node1 + + + + + + engine + + + +Node5 + + +gridfire::engine::Engine + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +std::unique_ptr< gridfire +::solver::NetworkSolverStrategy > + + + + + +Node6->Node1 + + + + + + solver + + + +Node7 + + +gridfire::solver::Network +SolverStrategy< EngineT > + + + + + +Node7->Node6 + + + + + + ptr + + + +Node8 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node8->Node1 + + + + + + speciesList + + + +Node9 + + +Species + + + + + +Node9->Node8 + + + + + + elements + + + +Node10 + + +Composition + + + + + +Node10->Node1 + + + + + + working_comp + + + +Node11 + + +std::string + + + + + +Node11->Node1 + + + + + + last_error + + + +Node12 + + +std::basic_string< + Char > + + + + + +Node12->Node11 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/structGridFireContext__coll__graph_org.svg b/docs/html/structGridFireContext__coll__graph_org.svg new file mode 100644 index 00000000..5b3bbd47 --- /dev/null +++ b/docs/html/structGridFireContext__coll__graph_org.svg @@ -0,0 +1,235 @@ + + + + + + +GridFireContext + + +Node1 + + +GridFireContext + + + + + +Node2 + + +std::unique_ptr< gridfire +::policy::NetworkPolicy > + + + + + +Node2->Node1 + + + + + + policy + + + +Node3 + + +gridfire::policy::Network +Policy + + + + + +Node3->Node2 + + + + + + ptr + + + +Node4 + + +gridfire::engine::Dynamic +Engine + + + + + +Node4->Node1 + + + + + + engine + + + +Node5 + + +gridfire::engine::Engine + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +std::unique_ptr< gridfire +::solver::NetworkSolverStrategy > + + + + + +Node6->Node1 + + + + + + solver + + + +Node7 + + +gridfire::solver::Network +SolverStrategy< EngineT > + + + + + +Node7->Node6 + + + + + + ptr + + + +Node8 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node8->Node1 + + + + + + speciesList + + + +Node9 + + +Species + + + + + +Node9->Node8 + + + + + + elements + + + +Node10 + + +Composition + + + + + +Node10->Node1 + + + + + + working_comp + + + +Node11 + + +std::string + + + + + +Node11->Node1 + + + + + + last_error + + + +Node12 + + +std::basic_string< + Char > + + + + + +Node12->Node11 + + + + + + + + diff --git a/docs/html/structgridfire_1_1NetIn-members.html b/docs/html/structgridfire_1_1NetIn-members.html new file mode 100644 index 00000000..3e0414e6 --- /dev/null +++ b/docs/html/structgridfire_1_1NetIn-members.html @@ -0,0 +1,117 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::NetIn Member List
+
+
+ +

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

+ + + + + + + + +
compositiongridfire::NetIn
cullinggridfire::NetIn
densitygridfire::NetIn
dt0gridfire::NetIn
energygridfire::NetIn
temperaturegridfire::NetIn
tMaxgridfire::NetIn
+
+ + + + diff --git a/docs/html/structgridfire_1_1NetIn.html b/docs/html/structgridfire_1_1NetIn.html new file mode 100644 index 00000000..9ecc6cbb --- /dev/null +++ b/docs/html/structgridfire_1_1NetIn.html @@ -0,0 +1,259 @@ + + + + + + + +GridFire: gridfire::NetIn Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::NetIn Struct Reference
+
+
+ +

#include <types.h>

+
+Collaboration diagram for gridfire::NetIn:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

fourdst::composition::Composition composition
 Composition of the network.
 
double tMax
 Maximum time.
 
double dt0
 Initial time step.
 
double temperature
 Temperature in Kelvin.
 
double density
 Density in g/cm^3.
 
double energy
 Energy in ergs.
 
double culling = 0.0
 Culling threshold for reactions (default is 0.0, meaning no culling)
 
+

Member Data Documentation

+ +

◆ composition

+ +
+
+ + + + +
fourdst::composition::Composition gridfire::NetIn::composition
+
+ +

Composition of the network.

+ +
+
+ +

◆ culling

+ +
+
+ + + + +
double gridfire::NetIn::culling = 0.0
+
+ +

Culling threshold for reactions (default is 0.0, meaning no culling)

+ +
+
+ +

◆ density

+ +
+
+ + + + +
double gridfire::NetIn::density
+
+ +

Density in g/cm^3.

+ +
+
+ +

◆ dt0

+ +
+
+ + + + +
double gridfire::NetIn::dt0
+
+ +

Initial time step.

+ +
+
+ +

◆ energy

+ +
+
+ + + + +
double gridfire::NetIn::energy
+
+ +

Energy in ergs.

+ +
+
+ +

◆ temperature

+ +
+
+ + + + +
double gridfire::NetIn::temperature
+
+ +

Temperature in Kelvin.

+ +
+
+ +

◆ tMax

+ +
+
+ + + + +
double gridfire::NetIn::tMax
+
+ +

Maximum time.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1NetIn.js b/docs/html/structgridfire_1_1NetIn.js new file mode 100644 index 00000000..a4dea770 --- /dev/null +++ b/docs/html/structgridfire_1_1NetIn.js @@ -0,0 +1,10 @@ +var structgridfire_1_1NetIn = +[ + [ "composition", "structgridfire_1_1NetIn.html#a13058f4929e72c1187abbebcddb8aed1", null ], + [ "culling", "structgridfire_1_1NetIn.html#a6a5e909b46094ffa20da9a3da906e43f", null ], + [ "density", "structgridfire_1_1NetIn.html#a06f0dff9f8927b7cf2da3004c8fa1577", null ], + [ "dt0", "structgridfire_1_1NetIn.html#a4e556f7bb18f46654b3445476734076a", null ], + [ "energy", "structgridfire_1_1NetIn.html#ae1fbce804bafa6ad2be4ac3470dac93b", null ], + [ "temperature", "structgridfire_1_1NetIn.html#a5be0f5195a5cd1dd177b9fc5ab83a7be", null ], + [ "tMax", "structgridfire_1_1NetIn.html#a0a8d820cfeaa92ee31f253795c57e0d1", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1NetIn__coll__graph.map b/docs/html/structgridfire_1_1NetIn__coll__graph.map new file mode 100644 index 00000000..3dda7b30 --- /dev/null +++ b/docs/html/structgridfire_1_1NetIn__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/structgridfire_1_1NetIn__coll__graph.md5 b/docs/html/structgridfire_1_1NetIn__coll__graph.md5 new file mode 100644 index 00000000..37a0c5e8 --- /dev/null +++ b/docs/html/structgridfire_1_1NetIn__coll__graph.md5 @@ -0,0 +1 @@ +cff00933e7e3bb2226baa60d07e08e11 \ No newline at end of file diff --git a/docs/html/structgridfire_1_1NetIn__coll__graph.svg b/docs/html/structgridfire_1_1NetIn__coll__graph.svg new file mode 100644 index 00000000..f7f64bd7 --- /dev/null +++ b/docs/html/structgridfire_1_1NetIn__coll__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +gridfire::NetIn + + +Node1 + + +gridfire::NetIn + + + + + +Node2 + + +Composition + + + + + +Node2->Node1 + + + + + + composition + + + + + + + + diff --git a/docs/html/structgridfire_1_1NetIn__coll__graph_org.svg b/docs/html/structgridfire_1_1NetIn__coll__graph_org.svg new file mode 100644 index 00000000..207d27ea --- /dev/null +++ b/docs/html/structgridfire_1_1NetIn__coll__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +gridfire::NetIn + + +Node1 + + +gridfire::NetIn + + + + + +Node2 + + +Composition + + + + + +Node2->Node1 + + + + + + composition + + + diff --git a/docs/html/structgridfire_1_1NetOut-members.html b/docs/html/structgridfire_1_1NetOut-members.html new file mode 100644 index 00000000..bed124d1 --- /dev/null +++ b/docs/html/structgridfire_1_1NetOut-members.html @@ -0,0 +1,118 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::NetOut Member List
+
+
+ +

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

+ + + + + + + + + +
compositiongridfire::NetOut
dEps_dRhogridfire::NetOut
dEps_dTgridfire::NetOut
energygridfire::NetOut
num_stepsgridfire::NetOut
operator<<gridfire::NetOutfriend
specific_neutrino_energy_lossgridfire::NetOut
specific_neutrino_fluxgridfire::NetOut
+
+ + + + diff --git a/docs/html/structgridfire_1_1NetOut.html b/docs/html/structgridfire_1_1NetOut.html new file mode 100644 index 00000000..68842e04 --- /dev/null +++ b/docs/html/structgridfire_1_1NetOut.html @@ -0,0 +1,302 @@ + + + + + + + +GridFire: gridfire::NetOut Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +Friends | +List of all members
+
gridfire::NetOut Struct Reference
+
+
+ +

#include <types.h>

+
+Collaboration diagram for gridfire::NetOut:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

fourdst::composition::Composition composition
 Composition of the network after evaluation.
 
int num_steps
 Number of steps taken in the evaluation.
 
double energy
 Energy in ergs after evaluation.
 
double dEps_dT
 Partial derivative of energy generation rate with respect to temperature.
 
double dEps_dRho
 Partial derivative of energy generation rate with respect to density.
 
double specific_neutrino_energy_loss
 Neutrino energy loss rate in ergs/g/s.
 
double specific_neutrino_flux
 Total neutrino flux in neutrinos/g/s.
 
+ + + +

+Friends

std::ostream & operator<< (std::ostream &os, const NetOut &netOut)
 
+

Friends And Related Symbol Documentation

+ +

◆ operator<<

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::ostream & operator<< (std::ostream & os,
const NetOut & netOut 
)
+ 		+friend
+
+ +
+
+

Member Data Documentation

+ +

◆ composition

+ +
+
+ + + + +
fourdst::composition::Composition gridfire::NetOut::composition
+
+ +

Composition of the network after evaluation.

+ +
+
+ +

◆ dEps_dRho

+ +
+
+ + + + +
double gridfire::NetOut::dEps_dRho
+
+ +

Partial derivative of energy generation rate with respect to density.

+ +
+
+ +

◆ dEps_dT

+ +
+
+ + + + +
double gridfire::NetOut::dEps_dT
+
+ +

Partial derivative of energy generation rate with respect to temperature.

+ +
+
+ +

◆ energy

+ +
+
+ + + + +
double gridfire::NetOut::energy
+
+ +

Energy in ergs after evaluation.

+ +
+
+ +

◆ num_steps

+ +
+
+ + + + +
int gridfire::NetOut::num_steps
+
+ +

Number of steps taken in the evaluation.

+ +
+
+ +

◆ specific_neutrino_energy_loss

+ +
+
+ + + + +
double gridfire::NetOut::specific_neutrino_energy_loss
+
+ +

Neutrino energy loss rate in ergs/g/s.

+ +
+
+ +

◆ specific_neutrino_flux

+ +
+
+ + + + +
double gridfire::NetOut::specific_neutrino_flux
+
+ +

Total neutrino flux in neutrinos/g/s.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1NetOut.js b/docs/html/structgridfire_1_1NetOut.js new file mode 100644 index 00000000..dd7c57ea --- /dev/null +++ b/docs/html/structgridfire_1_1NetOut.js @@ -0,0 +1,11 @@ +var structgridfire_1_1NetOut = +[ + [ "operator<<", "structgridfire_1_1NetOut.html#a6996f06951c2a873e5464773ddc7319b", null ], + [ "composition", "structgridfire_1_1NetOut.html#a073529511ae0e52f868b47cce0e8ac0a", null ], + [ "dEps_dRho", "structgridfire_1_1NetOut.html#ad0bde670fb87bcab4de413e8284d624e", null ], + [ "dEps_dT", "structgridfire_1_1NetOut.html#a210c0c395bc012c8ce6bef8cc6b683d6", null ], + [ "energy", "structgridfire_1_1NetOut.html#a43d5a861708992c949f616aa2a035ec6", null ], + [ "num_steps", "structgridfire_1_1NetOut.html#a51c16703132cf739ec2fd89eae7badd6", null ], + [ "specific_neutrino_energy_loss", "structgridfire_1_1NetOut.html#a801b7bf34375fc56cc6e6cdaef77b070", null ], + [ "specific_neutrino_flux", "structgridfire_1_1NetOut.html#a84a4f64f5a6b7ff965c36b4f7f8aa8f6", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1NetOut__coll__graph.map b/docs/html/structgridfire_1_1NetOut__coll__graph.map new file mode 100644 index 00000000..9f1a53b2 --- /dev/null +++ b/docs/html/structgridfire_1_1NetOut__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/structgridfire_1_1NetOut__coll__graph.md5 b/docs/html/structgridfire_1_1NetOut__coll__graph.md5 new file mode 100644 index 00000000..81aa8a1f --- /dev/null +++ b/docs/html/structgridfire_1_1NetOut__coll__graph.md5 @@ -0,0 +1 @@ +5dbf521191eb4f370642f66b9a5193fd \ No newline at end of file diff --git a/docs/html/structgridfire_1_1NetOut__coll__graph.svg b/docs/html/structgridfire_1_1NetOut__coll__graph.svg new file mode 100644 index 00000000..aee1cff0 --- /dev/null +++ b/docs/html/structgridfire_1_1NetOut__coll__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +gridfire::NetOut + + +Node1 + + +gridfire::NetOut + + + + + +Node2 + + +Composition + + + + + +Node2->Node1 + + + + + + composition + + + + + + + + diff --git a/docs/html/structgridfire_1_1NetOut__coll__graph_org.svg b/docs/html/structgridfire_1_1NetOut__coll__graph_org.svg new file mode 100644 index 00000000..94210d2d --- /dev/null +++ b/docs/html/structgridfire_1_1NetOut__coll__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +gridfire::NetOut + + +Node1 + + +gridfire::NetOut + + + + + +Node2 + + +Composition + + + + + +Node2->Node1 + + + + + + composition + + + diff --git a/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow-members.html b/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow-members.html new file mode 100644 index 00000000..270a041d --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow-members.html @@ -0,0 +1,112 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::AdaptiveEngineView::ReactionFlow Member List
+
+
+ +

This is the complete list of members for gridfire::engine::AdaptiveEngineView::ReactionFlow, including all inherited members.

+ + + +
flowRategridfire::engine::AdaptiveEngineView::ReactionFlow
reactionPtrgridfire::engine::AdaptiveEngineView::ReactionFlow
+
+ + + + diff --git a/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow.html b/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow.html new file mode 100644 index 00000000..c7bbb062 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow.html @@ -0,0 +1,161 @@ + + + + + + + +GridFire: gridfire::engine::AdaptiveEngineView::ReactionFlow Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::engine::AdaptiveEngineView::ReactionFlow Struct Reference
+
+
+ +

A struct to hold a reaction and its flow rate. + More...

+
+Collaboration diagram for gridfire::engine::AdaptiveEngineView::ReactionFlow:
+
+
+
[legend]
+ + + + + + +

+Public Attributes

const reaction::Reaction * reactionPtr
 
double flowRate
 
+

Detailed Description

+

A struct to hold a reaction and its flow rate.

+

Member Data Documentation

+ +

◆ flowRate

+ +
+
+ + + + +
double gridfire::engine::AdaptiveEngineView::ReactionFlow::flowRate
+
+ +
+
+ +

◆ reactionPtr

+ +
+
+ + + + +
const reaction::Reaction* gridfire::engine::AdaptiveEngineView::ReactionFlow::reactionPtr
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow.js b/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow.js new file mode 100644 index 00000000..9962b854 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow.js @@ -0,0 +1,5 @@ +var structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow = +[ + [ "flowRate", "structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow.html#a66eed32c2126788d9511dfee2404b9f8", null ], + [ "reactionPtr", "structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow.html#a10984b31880df00b0d78d76f55c0b143", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow__coll__graph.map b/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow__coll__graph.map new file mode 100644 index 00000000..63073c6e --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow__coll__graph.md5 b/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow__coll__graph.md5 new file mode 100644 index 00000000..11ba16d8 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow__coll__graph.md5 @@ -0,0 +1 @@ +199505b950f57c55ac1b2af3a6acab3a \ No newline at end of file diff --git a/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow__coll__graph.svg b/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow__coll__graph.svg new file mode 100644 index 00000000..875da7f0 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow__coll__graph.svg @@ -0,0 +1,67 @@ + + + + + + + + + + + +gridfire::engine::AdaptiveEngineView::ReactionFlow + + +Node1 + + +gridfire::engine::Adaptive +EngineView::ReactionFlow + + + + + +Node2 + + +gridfire::reaction +::Reaction + + + + + +Node2->Node1 + + + + + + reactionPtr + + + + + + + + diff --git a/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow__coll__graph_org.svg b/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow__coll__graph_org.svg new file mode 100644 index 00000000..64861777 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1AdaptiveEngineView_1_1ReactionFlow__coll__graph_org.svg @@ -0,0 +1,42 @@ + + + + + + +gridfire::engine::AdaptiveEngineView::ReactionFlow + + +Node1 + + +gridfire::engine::Adaptive +EngineView::ReactionFlow + + + + + +Node2 + + +gridfire::reaction +::Reaction + + + + + +Node2->Node1 + + + + + + reactionPtr + + + diff --git a/docs/html/structgridfire_1_1engine_1_1EnergyDerivatives-members.html b/docs/html/structgridfire_1_1engine_1_1EnergyDerivatives-members.html new file mode 100644 index 00000000..c5cf2929 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1EnergyDerivatives-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::EnergyDerivatives Member List
+
+
+ +

This is the complete list of members for gridfire::engine::EnergyDerivatives, including all inherited members.

+ + + + +
dEps_dRhogridfire::engine::EnergyDerivatives
dEps_dTgridfire::engine::EnergyDerivatives
operator<<gridfire::engine::EnergyDerivativesfriend
+
+ + + + diff --git a/docs/html/structgridfire_1_1engine_1_1EnergyDerivatives.html b/docs/html/structgridfire_1_1engine_1_1EnergyDerivatives.html new file mode 100644 index 00000000..1312242d --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1EnergyDerivatives.html @@ -0,0 +1,208 @@ + + + + + + + +GridFire: gridfire::engine::EnergyDerivatives Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +Friends | +List of all members
+
gridfire::engine::EnergyDerivatives Struct Reference
+
+
+ +

Structure holding derivatives of energy generation rate with respect to T and rho. + More...

+ +

#include <engine_abstract.h>

+ + + + + + + + +

+Public Attributes

double dEps_dT = 0.0
 Partial derivative of energy generation rate with respect to temperature.
 
double dEps_dRho = 0.0
 Partial derivative of energy generation rate with respect to density.
 
+ + + +

+Friends

std::ostream & operator<< (std::ostream &os, const EnergyDerivatives &ed)
 
+

Detailed Description

+

Structure holding derivatives of energy generation rate with respect to T and rho.

+

This struct encapsulates the partial derivatives of the specific nuclear energy generation rate with respect to temperature and density.

+

Friends And Related Symbol Documentation

+ +

◆ operator<<

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::ostream & operator<< (std::ostream & os,
const EnergyDerivatives & ed 
)
+ 		+friend
+
+ +
+
+

Member Data Documentation

+ +

◆ dEps_dRho

+ +
+
+ + + + +
double gridfire::engine::EnergyDerivatives::dEps_dRho = 0.0
+
+ +

Partial derivative of energy generation rate with respect to density.

+ +
+
+ +

◆ dEps_dT

+ +
+
+ + + + +
double gridfire::engine::EnergyDerivatives::dEps_dT = 0.0
+
+ +

Partial derivative of energy generation rate with respect to temperature.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1engine_1_1EnergyDerivatives.js b/docs/html/structgridfire_1_1engine_1_1EnergyDerivatives.js new file mode 100644 index 00000000..9995c25e --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1EnergyDerivatives.js @@ -0,0 +1,6 @@ +var structgridfire_1_1engine_1_1EnergyDerivatives = +[ + [ "operator<<", "structgridfire_1_1engine_1_1EnergyDerivatives.html#aa974abdff7fe09c9aea3fcf4ae13b652", null ], + [ "dEps_dRho", "structgridfire_1_1engine_1_1EnergyDerivatives.html#a3017720ca1eb0a7567d6a1e30c8bfc5e", null ], + [ "dEps_dT", "structgridfire_1_1engine_1_1EnergyDerivatives.html#a121c9ec02cae31730f81cec9a8774e6e", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction-members.html b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction-members.html new file mode 100644 index 00000000..911a4d57 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction-members.html @@ -0,0 +1,121 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::GraphEngine::PrecomputedReaction Member List
+
+
+ +

This is the complete list of members for gridfire::engine::GraphEngine::PrecomputedReaction, including all inherited members.

+ + + + + + + + + + + + +
affected_species_indicesgridfire::engine::GraphEngine::PrecomputedReaction
product_powersgridfire::engine::GraphEngine::PrecomputedReaction
reactant_powersgridfire::engine::GraphEngine::PrecomputedReaction
reaction_hashgridfire::engine::GraphEngine::PrecomputedReaction
reaction_indexgridfire::engine::GraphEngine::PrecomputedReaction
reaction_typegridfire::engine::GraphEngine::PrecomputedReaction
reverse_symmetry_factorgridfire::engine::GraphEngine::PrecomputedReaction
stoichiometric_coefficientsgridfire::engine::GraphEngine::PrecomputedReaction
symmetry_factorgridfire::engine::GraphEngine::PrecomputedReaction
unique_product_indicesgridfire::engine::GraphEngine::PrecomputedReaction
unique_reactant_indicesgridfire::engine::GraphEngine::PrecomputedReaction
+
+ + + + diff --git a/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction.html b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction.html new file mode 100644 index 00000000..a3bcd8d9 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction.html @@ -0,0 +1,309 @@ + + + + + + + +GridFire: gridfire::engine::GraphEngine::PrecomputedReaction Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::engine::GraphEngine::PrecomputedReaction Struct Reference
+
+
+
+Collaboration diagram for gridfire::engine::GraphEngine::PrecomputedReaction:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

size_t reaction_index {}
 
reaction::ReactionType reaction_type {}
 
uint64_t reaction_hash {}
 
std::vector< size_t > unique_reactant_indices {}
 
std::vector< int > reactant_powers {}
 
double symmetry_factor {}
 
std::vector< size_t > affected_species_indices {}
 
std::vector< int > stoichiometric_coefficients {}
 
std::vector< size_t > unique_product_indices {}
 Unique product indices for reverse reactions.
 
std::vector< int > product_powers {}
 Powers of each unique product in the reverse reaction.
 
double reverse_symmetry_factor {}
 Symmetry factor for reverse reactions.
 
+

Member Data Documentation

+ +

◆ affected_species_indices

+ +
+
+ + + + +
std::vector<size_t> gridfire::engine::GraphEngine::PrecomputedReaction::affected_species_indices {}
+
+ +
+
+ +

◆ product_powers

+ +
+
+ + + + +
std::vector<int> gridfire::engine::GraphEngine::PrecomputedReaction::product_powers {}
+
+ +

Powers of each unique product in the reverse reaction.

+ +
+
+ +

◆ reactant_powers

+ +
+
+ + + + +
std::vector<int> gridfire::engine::GraphEngine::PrecomputedReaction::reactant_powers {}
+
+ +
+
+ +

◆ reaction_hash

+ +
+
+ + + + +
uint64_t gridfire::engine::GraphEngine::PrecomputedReaction::reaction_hash {}
+
+ +
+
+ +

◆ reaction_index

+ +
+
+ + + + +
size_t gridfire::engine::GraphEngine::PrecomputedReaction::reaction_index {}
+
+ +
+
+ +

◆ reaction_type

+ +
+
+ + + + +
reaction::ReactionType gridfire::engine::GraphEngine::PrecomputedReaction::reaction_type {}
+
+ +
+
+ +

◆ reverse_symmetry_factor

+ +
+
+ + + + +
double gridfire::engine::GraphEngine::PrecomputedReaction::reverse_symmetry_factor {}
+
+ +

Symmetry factor for reverse reactions.

+ +
+
+ +

◆ stoichiometric_coefficients

+ +
+
+ + + + +
std::vector<int> gridfire::engine::GraphEngine::PrecomputedReaction::stoichiometric_coefficients {}
+
+ +
+
+ +

◆ symmetry_factor

+ +
+
+ + + + +
double gridfire::engine::GraphEngine::PrecomputedReaction::symmetry_factor {}
+
+ +
+
+ +

◆ unique_product_indices

+ +
+
+ + + + +
std::vector<size_t> gridfire::engine::GraphEngine::PrecomputedReaction::unique_product_indices {}
+
+ +

Unique product indices for reverse reactions.

+ +
+
+ +

◆ unique_reactant_indices

+ +
+
+ + + + +
std::vector<size_t> gridfire::engine::GraphEngine::PrecomputedReaction::unique_reactant_indices {}
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction.js b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction.js new file mode 100644 index 00000000..009cbe23 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction.js @@ -0,0 +1,14 @@ +var structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction = +[ + [ "affected_species_indices", "structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction.html#a8be44cfc0731bb53861e1772027b36a4", null ], + [ "product_powers", "structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction.html#ae0dce375a45959da6c75fec3ede46fea", null ], + [ "reactant_powers", "structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction.html#a4360de7e2c518db798d97dac87bea252", null ], + [ "reaction_hash", "structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction.html#a2a63022b616788e377c804fcf1ccf847", null ], + [ "reaction_index", "structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction.html#ac6acad530a508ccb16ae103191490083", null ], + [ "reaction_type", "structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction.html#aad61f7b0e307ef79e69833a04a857b30", null ], + [ "reverse_symmetry_factor", "structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction.html#ae70bcf64f86170160d837abd5bdce873", null ], + [ "stoichiometric_coefficients", "structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction.html#a333e30364947d83549b20d857641d646", null ], + [ "symmetry_factor", "structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction.html#aa4ae79e03a28fd221759ea93bda389d5", null ], + [ "unique_product_indices", "structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction.html#a8363455ee236b6c8bc09ef189cc4148c", null ], + [ "unique_reactant_indices", "structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction.html#a59b1e8c908962f97c3d813910f7e8e39", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction__coll__graph.map b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction__coll__graph.map new file mode 100644 index 00000000..f43977b9 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction__coll__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction__coll__graph.md5 b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction__coll__graph.md5 new file mode 100644 index 00000000..f8c69e16 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction__coll__graph.md5 @@ -0,0 +1 @@ +8cfd837bf05f03d425ce45047079aca2 \ No newline at end of file diff --git a/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction__coll__graph.svg b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction__coll__graph.svg new file mode 100644 index 00000000..3fc9bcc9 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction__coll__graph.svg @@ -0,0 +1,89 @@ + + + + + + + + + + + +gridfire::engine::GraphEngine::PrecomputedReaction + + +Node1 + + +gridfire::engine::GraphEngine +::PrecomputedReaction + + + + + +Node2 + + +std::vector< size_t > + + + + + +Node2->Node1 + + + + + + affected_species_indices +unique_product_indices +unique_reactant_indices + + + +Node3 + + +std::vector< int > + + + + + +Node3->Node1 + + + + + + product_powers +reactant_powers +stoichiometric_coefficients + + + + + + + + diff --git a/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction__coll__graph_org.svg b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction__coll__graph_org.svg new file mode 100644 index 00000000..c9e916f5 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1PrecomputedReaction__coll__graph_org.svg @@ -0,0 +1,64 @@ + + + + + + +gridfire::engine::GraphEngine::PrecomputedReaction + + +Node1 + + +gridfire::engine::GraphEngine +::PrecomputedReaction + + + + + +Node2 + + +std::vector< size_t > + + + + + +Node2->Node1 + + + + + + affected_species_indices +unique_product_indices +unique_reactant_indices + + + +Node3 + + +std::vector< int > + + + + + +Node3->Node1 + + + + + + product_powers +reactant_powers +stoichiometric_coefficients + + + diff --git a/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1constants-members.html b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1constants-members.html new file mode 100644 index 00000000..a091dde0 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1constants-members.html @@ -0,0 +1,115 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::GraphEngine::constants Member List
+
+
+ +

This is the complete list of members for gridfire::engine::GraphEngine::constants, including all inherited members.

+ + + + + + +
cgridfire::engine::GraphEngine::constants
kBgridfire::engine::GraphEngine::constants
MeV_to_erggridfire::engine::GraphEngine::constants
Nagridfire::engine::GraphEngine::constants
ugridfire::engine::GraphEngine::constants
+
+ + + + diff --git a/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1constants.html b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1constants.html new file mode 100644 index 00000000..837d3d98 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1constants.html @@ -0,0 +1,214 @@ + + + + + + + +GridFire: gridfire::engine::GraphEngine::constants Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::engine::GraphEngine::constants Struct Reference
+
+
+ + + + + + + + + + + + + + + + + +

+Public Attributes

const double u = Constants::getInstance().get("u").value
 Atomic mass unit in g.
 
const double Na = Constants::getInstance().get("N_a").value
 Avogadro's number.
 
const double c = Constants::getInstance().get("c").value
 Speed of light in cm/s.
 
const double kB = Constants::getInstance().get("kB").value
 Boltzmann constant in erg/K.
 
const double MeV_to_erg = Constants::getInstance().get("MeV_to_erg").value
 Conversion factor from MeV to erg.
 
+

Member Data Documentation

+ +

◆ c

+ +
+
+ + + + +
const double gridfire::engine::GraphEngine::constants::c = Constants::getInstance().get("c").value
+
+ +

Speed of light in cm/s.

+ +
+
+ +

◆ kB

+ +
+
+ + + + +
const double gridfire::engine::GraphEngine::constants::kB = Constants::getInstance().get("kB").value
+
+ +

Boltzmann constant in erg/K.

+ +
+
+ +

◆ MeV_to_erg

+ +
+
+ + + + +
const double gridfire::engine::GraphEngine::constants::MeV_to_erg = Constants::getInstance().get("MeV_to_erg").value
+
+ +

Conversion factor from MeV to erg.

+ +
+
+ +

◆ Na

+ +
+
+ + + + +
const double gridfire::engine::GraphEngine::constants::Na = Constants::getInstance().get("N_a").value
+
+ +

Avogadro's number.

+ +
+
+ +

◆ u

+ +
+
+ + + + +
const double gridfire::engine::GraphEngine::constants::u = Constants::getInstance().get("u").value
+
+ +

Atomic mass unit in g.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1constants.js b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1constants.js new file mode 100644 index 00000000..09894dd2 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1GraphEngine_1_1constants.js @@ -0,0 +1,8 @@ +var structgridfire_1_1engine_1_1GraphEngine_1_1constants = +[ + [ "c", "structgridfire_1_1engine_1_1GraphEngine_1_1constants.html#acb2760ecfe67d55b165c45f2bf80e560", null ], + [ "kB", "structgridfire_1_1engine_1_1GraphEngine_1_1constants.html#ad7870fe7ff2c070650d15685c50700c5", null ], + [ "MeV_to_erg", "structgridfire_1_1engine_1_1GraphEngine_1_1constants.html#a6081352e225c991867f8b0bbe0e40afb", null ], + [ "Na", "structgridfire_1_1engine_1_1GraphEngine_1_1constants.html#a2c0d2b6bd300ccd419bf5b9f3757a6a4", null ], + [ "u", "structgridfire_1_1engine_1_1GraphEngine_1_1constants.html#a77852a3d0e636efaf630d12b851b7788", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult-members.html b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult-members.html new file mode 100644 index 00000000..ddb38e1f --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::MultiscalePartitioningEngineView::FluxValidationResult Member List
+
+
+ +

This is the complete list of members for gridfire::engine::MultiscalePartitioningEngineView::FluxValidationResult, including all inherited members.

+ + + + +
invalid_groupsgridfire::engine::MultiscalePartitioningEngineView::FluxValidationResult
valid_groupsgridfire::engine::MultiscalePartitioningEngineView::FluxValidationResult
validatedGroupReactionsgridfire::engine::MultiscalePartitioningEngineView::FluxValidationResult
+
+ + + + diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult.html b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult.html new file mode 100644 index 00000000..91f001b2 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult.html @@ -0,0 +1,172 @@ + + + + + + + +GridFire: gridfire::engine::MultiscalePartitioningEngineView::FluxValidationResult Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::engine::MultiscalePartitioningEngineView::FluxValidationResult Struct Reference
+
+
+
+Collaboration diagram for gridfire::engine::MultiscalePartitioningEngineView::FluxValidationResult:
+
+
+
[legend]
+ + + + + + + + +

+Public Attributes

std::vector< QSEGroup > valid_groups
 
std::vector< QSEGroup > invalid_groups
 
std::vector< reaction::ReactionSet > validatedGroupReactions
 
+

Member Data Documentation

+ +

◆ invalid_groups

+ +
+
+ + + + +
std::vector<QSEGroup> gridfire::engine::MultiscalePartitioningEngineView::FluxValidationResult::invalid_groups
+
+ +
+
+ +

◆ valid_groups

+ +
+
+ + + + +
std::vector<QSEGroup> gridfire::engine::MultiscalePartitioningEngineView::FluxValidationResult::valid_groups
+
+ +
+
+ +

◆ validatedGroupReactions

+ +
+
+ + + + +
std::vector<reaction::ReactionSet> gridfire::engine::MultiscalePartitioningEngineView::FluxValidationResult::validatedGroupReactions
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult.js b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult.js new file mode 100644 index 00000000..fa5fe406 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult.js @@ -0,0 +1,6 @@ +var structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult = +[ + [ "invalid_groups", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult.html#a5dd5fae541dc2157e722263c6a957abd", null ], + [ "valid_groups", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult.html#a0eb57bc4fe8ca0c9b60b769c9e1fadba", null ], + [ "validatedGroupReactions", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult.html#a0e6e189fbd53ec2f47d2cef21b9a1792", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult__coll__graph.map b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult__coll__graph.map new file mode 100644 index 00000000..7899267e --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult__coll__graph.map @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult__coll__graph.md5 b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult__coll__graph.md5 new file mode 100644 index 00000000..427a1a79 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult__coll__graph.md5 @@ -0,0 +1 @@ +e952079f7cd39dbe6417c86b4b5cd44b \ No newline at end of file diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult__coll__graph.svg b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult__coll__graph.svg new file mode 100644 index 00000000..18800769 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult__coll__graph.svg @@ -0,0 +1,377 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::engine::MultiscalePartitioningEngineView::FluxValidationResult + + +Node1 + + +gridfire::engine::Multiscale +PartitioningEngineView:: +FluxValidationResult + + + + + +Node2 + + +std::vector< gridfire +::engine::MultiscalePartitioning +EngineView::QSEGroup > + + + + + +Node2->Node1 + + + + + + invalid_groups +valid_groups + + + +Node3 + + +gridfire::engine::Multiscale +PartitioningEngineView:: +QSEGroup + + + + + +Node3->Node2 + + + + + + elements + + + +Node4 + + +std::set< fourdst:: +atomic::Species > + + + + + +Node4->Node3 + + + + + + algebraic_species +seed_species + + + +Node5 + + +Species + + + + + +Node5->Node4 + + + + + + keys + + + +Node6 + + +std::vector< gridfire +::reaction::ReactionSet > + + + + + +Node6->Node1 + + + + + + validatedGroupReactions + + + +Node7 + + +gridfire::reaction +::ReactionSet + + + + + +Node7->Node6 + + + + + + elements + + + +Node8 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node8->Node7 + + + + + + m_reactions + + + +Node9 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node9->Node8 + + + + + + elements + + + +Node10 + + +gridfire::reaction +::Reaction + + + + + +Node10->Node9 + + + + + + ptr + + + +Node11 + + +std::string + + + + + +Node11->Node7 + + + + + + m_id + + + +Node13 + + +std::unordered_map +< std::string, size_t > + + + + + +Node11->Node13 + + + + + + keys + + + +Node12 + + +std::basic_string< + Char > + + + + + +Node12->Node11 + + + + + + + + +Node13->Node7 + + + + + + m_reactionNameMap + + + +Node14 + + +std::unordered_set +< size_t > + + + + + +Node14->Node7 + + + + + + m_reactionHashes + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult__coll__graph_org.svg b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult__coll__graph_org.svg new file mode 100644 index 00000000..32dfcc8b --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1FluxValidationResult__coll__graph_org.svg @@ -0,0 +1,295 @@ + + + + + + +gridfire::engine::MultiscalePartitioningEngineView::FluxValidationResult + + +Node1 + + +gridfire::engine::Multiscale +PartitioningEngineView:: +FluxValidationResult + + + + + +Node2 + + +std::vector< gridfire +::engine::MultiscalePartitioning +EngineView::QSEGroup > + + + + + +Node2->Node1 + + + + + + invalid_groups +valid_groups + + + +Node3 + + +gridfire::engine::Multiscale +PartitioningEngineView:: +QSEGroup + + + + + +Node3->Node2 + + + + + + elements + + + +Node4 + + +std::set< fourdst:: +atomic::Species > + + + + + +Node4->Node3 + + + + + + algebraic_species +seed_species + + + +Node5 + + +Species + + + + + +Node5->Node4 + + + + + + keys + + + +Node6 + + +std::vector< gridfire +::reaction::ReactionSet > + + + + + +Node6->Node1 + + + + + + validatedGroupReactions + + + +Node7 + + +gridfire::reaction +::ReactionSet + + + + + +Node7->Node6 + + + + + + elements + + + +Node8 + + +std::vector< std::unique +_ptr< gridfire::reaction +::Reaction > > + + + + + +Node8->Node7 + + + + + + m_reactions + + + +Node9 + + +std::unique_ptr< gridfire +::reaction::Reaction > + + + + + +Node9->Node8 + + + + + + elements + + + +Node10 + + +gridfire::reaction +::Reaction + + + + + +Node10->Node9 + + + + + + ptr + + + +Node11 + + +std::string + + + + + +Node11->Node7 + + + + + + m_id + + + +Node13 + + +std::unordered_map +< std::string, size_t > + + + + + +Node11->Node13 + + + + + + keys + + + +Node12 + + +std::basic_string< + Char > + + + + + +Node12->Node11 + + + + + + + + +Node13->Node7 + + + + + + m_reactionNameMap + + + +Node14 + + +std::unordered_set +< size_t > + + + + + +Node14->Node7 + + + + + + m_reactionHashes + + + diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup-members.html b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup-members.html new file mode 100644 index 00000000..aff51c19 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup-members.html @@ -0,0 +1,123 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::MultiscalePartitioningEngineView::QSEGroup Member List
+
+
+ +

This is the complete list of members for gridfire::engine::MultiscalePartitioningEngineView::QSEGroup, including all inherited members.

+ + + + + + + + + + + + + + +
algebraic_speciesgridfire::engine::MultiscalePartitioningEngineView::QSEGroup
contains(const fourdst::atomic::Species &species) constgridfire::engine::MultiscalePartitioningEngineView::QSEGroup
containsAlgebraic(const fourdst::atomic::Species &species) constgridfire::engine::MultiscalePartitioningEngineView::QSEGroup
containsSeed(const fourdst::atomic::Species &species) constgridfire::engine::MultiscalePartitioningEngineView::QSEGroup
is_in_equilibriumgridfire::engine::MultiscalePartitioningEngineView::QSEGroup
mean_timescalegridfire::engine::MultiscalePartitioningEngineView::QSEGroup
operator!=(const QSEGroup &other) constgridfire::engine::MultiscalePartitioningEngineView::QSEGroup
operator<(const QSEGroup &other) constgridfire::engine::MultiscalePartitioningEngineView::QSEGroup
operator<<gridfire::engine::MultiscalePartitioningEngineView::QSEGroupfriend
operator==(const QSEGroup &other) constgridfire::engine::MultiscalePartitioningEngineView::QSEGroup
operator>(const QSEGroup &other) constgridfire::engine::MultiscalePartitioningEngineView::QSEGroup
seed_speciesgridfire::engine::MultiscalePartitioningEngineView::QSEGroup
toString(bool verbose) constgridfire::engine::MultiscalePartitioningEngineView::QSEGroup
+
+ + + + diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html new file mode 100644 index 00000000..04a7986c --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html @@ -0,0 +1,459 @@ + + + + + + + +GridFire: gridfire::engine::MultiscalePartitioningEngineView::QSEGroup Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Public Attributes | +Friends | +List of all members
+
gridfire::engine::MultiscalePartitioningEngineView::QSEGroup Struct Reference
+
+
+ +

Struct representing a QSE group. + More...

+
+Collaboration diagram for gridfire::engine::MultiscalePartitioningEngineView::QSEGroup:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

bool operator< (const QSEGroup &other) const
 Less-than operator for QSEGroup, used for sorting.
 
bool operator> (const QSEGroup &other) const
 Greater-than operator for QSEGroup.
 
bool operator== (const QSEGroup &other) const
 Equality operator for QSEGroup.
 
bool operator!= (const QSEGroup &other) const
 Inequality operator for QSEGroup.
 
std::string toString (bool verbose) const
 
bool contains (const fourdst::atomic::Species &species) const
 QSESolver Member Functions ///.
 
bool containsAlgebraic (const fourdst::atomic::Species &species) const
 
bool containsSeed (const fourdst::atomic::Species &species) const
 
+ + + + + + + + + + + + + +

+Public Attributes

bool is_in_equilibrium = false
 Flag set by flux analysis.
 
std::set< fourdst::atomic::Species > algebraic_species
 Algebraic species in this group.
 
std::set< fourdst::atomic::Species > seed_species
 Dynamic species in this group.
 
double mean_timescale
 Mean timescale of the group.
 
+ + + +

+Friends

std::ostream & operator<< (std::ostream &os, const QSEGroup &group)
 
+

Detailed Description

+

Struct representing a QSE group.

+
Purpose
A container to hold all information about a set of species that are potentially in quasi-steady-state equilibrium with each other.
+

Member Function Documentation

+ +

◆ contains()

+ +
+
+ + + + + + + + +
bool gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::contains (const fourdst::atomic::Species & species) const
+
+ +

QSESolver Member Functions ///.

+ +
+
+ +

◆ containsAlgebraic()

+ +
+
+ + + + + + + + +
bool gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::containsAlgebraic (const fourdst::atomic::Species & species) const
+
+ +
+
+ +

◆ containsSeed()

+ +
+
+ + + + + + + + +
bool gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::containsSeed (const fourdst::atomic::Species & species) const
+
+ +
+
+ +

◆ operator!=()

+ +
+
+ + + + + + + + +
bool gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::operator!= (const QSEGroup & other) const
+
+ +

Inequality operator for QSEGroup.

+
Parameters
+ + +
otherThe other QSEGroup to compare to.
+
+
+
Returns
True if the sets of species indices are not identical.
+ +
+
+ +

◆ operator<()

+ +
+
+ + + + + + + + +
bool gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::operator< (const QSEGroup & other) const
+
+ +

Less-than operator for QSEGroup, used for sorting.

+
Parameters
+ + +
otherThe other QSEGroup to compare to.
+
+
+
Returns
True if this group's mean timescale is less than the other's.
+ +
+
+ +

◆ operator==()

+ +
+
+ + + + + + + + +
bool gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::operator== (const QSEGroup & other) const
+
+ +

Equality operator for QSEGroup.

+

QSEGroup Member Functions ///.

+
Parameters
+ + +
otherThe other QSEGroup to compare to.
+
+
+
Returns
True if the sets of species indices are identical.
+ +
+
+ +

◆ operator>()

+ +
+
+ + + + + + + + +
bool gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::operator> (const QSEGroup & other) const
+
+ +

Greater-than operator for QSEGroup.

+
Parameters
+ + +
otherThe other QSEGroup to compare to.
+
+
+
Returns
True if this group's mean timescale is greater than the other's.
+ +
+
+ +

◆ toString()

+ +
+
+ + + + + + + + +
std::string gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::toString (bool verbose) const
+
+ +
+
+

Friends And Related Symbol Documentation

+ +

◆ operator<<

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::ostream & operator<< (std::ostream & os,
const QSEGroup & group 
)
+ 		+friend
+
+ +
+
+

Member Data Documentation

+ +

◆ algebraic_species

+ +
+
+ + + + +
std::set<fourdst::atomic::Species> gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::algebraic_species
+
+ +

Algebraic species in this group.

+ +
+
+ +

◆ is_in_equilibrium

+ +
+
+ + + + +
bool gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::is_in_equilibrium = false
+
+ +

Flag set by flux analysis.

+ +
+
+ +

◆ mean_timescale

+ +
+
+ + + + +
double gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::mean_timescale
+
+ +

Mean timescale of the group.

+ +
+
+ +

◆ seed_species

+ +
+
+ + + + +
std::set<fourdst::atomic::Species> gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::seed_species
+
+ +

Dynamic species in this group.

+ +
+
+
The documentation for this struct was generated from the following files: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.js b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.js new file mode 100644 index 00000000..44c21639 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.js @@ -0,0 +1,16 @@ +var structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup = +[ + [ "contains", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#a64018f4dd6c225b0790a0fd4065a0972", null ], + [ "containsAlgebraic", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#a553a39a2a8e6cea1d6f849cb7097fee6", null ], + [ "containsSeed", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#aa65229a4974b74ce4fc3f7c0544fbe91", null ], + [ "operator!=", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#a5ec476b65fcedc5e4eb603a18037bf25", null ], + [ "operator<", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#ac9f99ea2754b419d030e92c314fba4ed", null ], + [ "operator==", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#a846d372046454aa0ff97a4c83d85b96d", null ], + [ "operator>", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#adc1710fde415de7a337dbec664b16e45", null ], + [ "toString", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#aa56ff69de9025ce559202c06f95f8b6b", null ], + [ "operator<<", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#a37b41341696a780dbeee850919a56bf2", null ], + [ "algebraic_species", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#a4d706c8d2a49910135d7c599ce645a9e", null ], + [ "is_in_equilibrium", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#a7f4715e3f2f2b6cc35a94f0f4105db30", null ], + [ "mean_timescale", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#abb89ee3a7eaaadba05b6e08a22f2e5d6", null ], + [ "seed_species", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#a9434050b990ecfa0459feebff3047ee2", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup__coll__graph.map b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup__coll__graph.map new file mode 100644 index 00000000..51bc8d83 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup__coll__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup__coll__graph.md5 b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup__coll__graph.md5 new file mode 100644 index 00000000..fcde6ff4 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup__coll__graph.md5 @@ -0,0 +1 @@ +58ad75d6b1d0d7732f414b72a957ad6e \ No newline at end of file diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup__coll__graph.svg b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup__coll__graph.svg new file mode 100644 index 00000000..5d79296b --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup__coll__graph.svg @@ -0,0 +1,88 @@ + + + + + + + + + + + +gridfire::engine::MultiscalePartitioningEngineView::QSEGroup + + +Node1 + + +gridfire::engine::Multiscale +PartitioningEngineView:: +QSEGroup + + + + + +Node2 + + +std::set< fourdst:: +atomic::Species > + + + + + +Node2->Node1 + + + + + + algebraic_species +seed_species + + + +Node3 + + +Species + + + + + +Node3->Node2 + + + + + + keys + + + + + + + + diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup__coll__graph_org.svg b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup__coll__graph_org.svg new file mode 100644 index 00000000..5c9b5772 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup__coll__graph_org.svg @@ -0,0 +1,63 @@ + + + + + + +gridfire::engine::MultiscalePartitioningEngineView::QSEGroup + + +Node1 + + +gridfire::engine::Multiscale +PartitioningEngineView:: +QSEGroup + + + + + +Node2 + + +std::set< fourdst:: +atomic::Species > + + + + + +Node2->Node1 + + + + + + algebraic_species +seed_species + + + +Node3 + + +Species + + + + + +Node3->Node2 + + + + + + keys + + + diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData-members.html b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData-members.html new file mode 100644 index 00000000..e11abbea --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData-members.html @@ -0,0 +1,119 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData Member List
+
+
+ +

This is the complete list of members for gridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData, including all inherited members.

+ + + + + + + + + + +
compgridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData
enginegridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData
initial_group_massgridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData
instancegridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData
qse_solve_speciesgridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData
qse_solve_species_index_mapgridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData
rhogridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData
row_scaling_factorsgridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData
T9gridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData
+
+ + + + diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData.html b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData.html new file mode 100644 index 00000000..f684bbfb --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData.html @@ -0,0 +1,268 @@ + + + + + + + +GridFire: gridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData Struct Reference
+
+
+
+Collaboration diagram for gridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + +

+Public Attributes

const DynamicEngine & engine
 
double T9
 
double rho
 
fourdst::composition::Composition & comp
 
const std::unordered_map< fourdst::atomic::Species, size_t > & qse_solve_species_index_map
 
const std::vector< fourdst::atomic::Species > & qse_solve_species
 
const QSESolver & instance
 
std::vector< double > row_scaling_factors
 
const double initial_group_mass
 
+

Member Data Documentation

+ +

◆ comp

+ +
+
+ + + + +
fourdst::composition::Composition& gridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData::comp
+
+ +
+
+ +

◆ engine

+ +
+
+ + + + +
const DynamicEngine& gridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData::engine
+
+ +
+
+ +

◆ initial_group_mass

+ +
+
+ + + + +
const double gridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData::initial_group_mass
+
+ +
+
+ +

◆ instance

+ +
+
+ + + + +
const QSESolver& gridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData::instance
+
+ +
+
+ +

◆ qse_solve_species

+ +
+
+ + + + +
const std::vector<fourdst::atomic::Species>& gridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData::qse_solve_species
+
+ +
+
+ +

◆ qse_solve_species_index_map

+ +
+
+ + + + +
const std::unordered_map<fourdst::atomic::Species, size_t>& gridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData::qse_solve_species_index_map
+
+ +
+
+ +

◆ rho

+ +
+
+ + + + +
double gridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData::rho
+
+ +
+
+ +

◆ row_scaling_factors

+ +
+
+ + + + +
std::vector<double> gridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData::row_scaling_factors
+
+ +
+
+ +

◆ T9

+ +
+
+ + + + +
double gridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData::T9
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData.js b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData.js new file mode 100644 index 00000000..a79d9587 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData.js @@ -0,0 +1,12 @@ +var structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData = +[ + [ "comp", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData.html#abdf43266a5641c80c25fb2ab3391e40e", null ], + [ "engine", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData.html#a15347dc13bbe872c5d2ed222426750f4", null ], + [ "initial_group_mass", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData.html#a65325a2d0f108c640336fdaa87b3dba7", null ], + [ "instance", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData.html#a58833add64981c21f83ca8fff6884beb", null ], + [ "qse_solve_species", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData.html#aac144e8d23e08c3578b3e36ade594f70", null ], + [ "qse_solve_species_index_map", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData.html#a1aca1d483f9a0ef647238b79db860f23", null ], + [ "rho", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData.html#a7ff42828a485eabd21811a9775eb4d3c", null ], + [ "row_scaling_factors", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData.html#a37234e8eba103fd8b524d8bdacecf701", null ], + [ "T9", "structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData.html#ab7d538b979d4e2bdf2297ee24bcaa31b", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData__coll__graph.map b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData__coll__graph.map new file mode 100644 index 00000000..e4c5b975 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData__coll__graph.map @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData__coll__graph.md5 b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData__coll__graph.md5 new file mode 100644 index 00000000..4b422a20 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData__coll__graph.md5 @@ -0,0 +1 @@ +d9a841dd5b8dd33ea248816d05a80dc6 \ No newline at end of file diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData__coll__graph.svg b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData__coll__graph.svg new file mode 100644 index 00000000..05e36ec0 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData__coll__graph.svg @@ -0,0 +1,283 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData + + +Node1 + + +gridfire::engine::Multiscale +PartitioningEngineView:: +QSESolver::UserData + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + engine + + + +Node7 + + +gridfire::engine::Multiscale +PartitioningEngineView:: +QSESolver + + + + + +Node2->Node7 + + + + + + m_engine + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node4->Node1 + + + + + + qse_solve_species_index_map + + + +Node4->Node7 + + + + + + m_speciesMap + + + +Node5 + + +Species + + + + + +Node5->Node4 + + + + + + keys + + + +Node6 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node5->Node6 + + + + + + elements + + + +Node6->Node1 + + + + + + qse_solve_species + + + +Node6->Node7 + + + + + + m_species + + + +Node7->Node1 + + + + + + instance + + + +Node8 + + +std::vector< double > + + + + + +Node8->Node1 + + + + + + row_scaling_factors + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData__coll__graph_org.svg b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData__coll__graph_org.svg new file mode 100644 index 00000000..4468f0d3 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver_1_1UserData__coll__graph_org.svg @@ -0,0 +1,201 @@ + + + + + + +gridfire::engine::MultiscalePartitioningEngineView::QSESolver::UserData + + +Node1 + + +gridfire::engine::Multiscale +PartitioningEngineView:: +QSESolver::UserData + + + + + +Node2 + + +gridfire::engine::Dynamic +Engine + + + + + +Node2->Node1 + + + + + + engine + + + +Node7 + + +gridfire::engine::Multiscale +PartitioningEngineView:: +QSESolver + + + + + +Node2->Node7 + + + + + + m_engine + + + +Node3 + + +gridfire::engine::Engine + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +std::unordered_map +< fourdst::atomic::Species, + size_t > + + + + + +Node4->Node1 + + + + + + qse_solve_species_index_map + + + +Node4->Node7 + + + + + + m_speciesMap + + + +Node5 + + +Species + + + + + +Node5->Node4 + + + + + + keys + + + +Node6 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node5->Node6 + + + + + + elements + + + +Node6->Node1 + + + + + + qse_solve_species + + + +Node6->Node7 + + + + + + m_species + + + +Node7->Node1 + + + + + + instance + + + +Node8 + + +std::vector< double > + + + + + +Node8->Node1 + + + + + + row_scaling_factors + + + diff --git a/docs/html/structgridfire_1_1engine_1_1PrimingReport-members.html b/docs/html/structgridfire_1_1engine_1_1PrimingReport-members.html new file mode 100644 index 00000000..3a9862df --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1PrimingReport-members.html @@ -0,0 +1,114 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::PrimingReport Member List
+
+
+ +

This is the complete list of members for gridfire::engine::PrimingReport, including all inherited members.

+ + + + + +
operator<<gridfire::engine::PrimingReportfriend
primedCompositiongridfire::engine::PrimingReport
statusgridfire::engine::PrimingReport
successgridfire::engine::PrimingReport
+
+ + + + diff --git a/docs/html/structgridfire_1_1engine_1_1PrimingReport.html b/docs/html/structgridfire_1_1engine_1_1PrimingReport.html new file mode 100644 index 00000000..3c65341d --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1PrimingReport.html @@ -0,0 +1,240 @@ + + + + + + + +GridFire: gridfire::engine::PrimingReport Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +Friends | +List of all members
+
gridfire::engine::PrimingReport Struct Reference
+
+
+ +

Captures the result of a network priming operation. + More...

+ +

#include <reporting.h>

+
+Collaboration diagram for gridfire::engine::PrimingReport:
+
+
+
[legend]
+ + + + + + + + +

+Public Attributes

fourdst::composition::Composition primedComposition
 
bool success
 
PrimingReportStatus status
 
+ + + + +

+Friends

std::ostream & operator<< (std::ostream &os, const PrimingReport &report)
 Serialize the report to a stream.
 
+

Detailed Description

+

Captures the result of a network priming operation.

+

Contains the finalized composition, the changes in mass fractions for species, a success flag, and a detailed status code.

+
Precondition
A priming algorithm must be executed before constructing a valid report.
+
Postcondition
All fields reflect the outcome of the priming run.
+

Friends And Related Symbol Documentation

+ +

◆ operator<<

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::ostream & operator<< (std::ostream & os,
const PrimingReport & report 
)
+ 		+friend
+
+ +

Serialize the report to a stream.

+

Formats the success flag and status string into the output stream.

Parameters
+ + + +
osOutput stream to write to.
reportReport to serialize.
+
+
+
Returns
Reference to the modified output stream.
+
Postcondition
The stream contains a textual representation of the report.
+ +
+
+

Member Data Documentation

+ +

◆ primedComposition

+ +
+
+ + + + +
fourdst::composition::Composition gridfire::engine::PrimingReport::primedComposition
+
+

Finalized composition after priming.

+ +
+
+ +

◆ status

+ +
+
+ + + + +
PrimingReportStatus gridfire::engine::PrimingReport::status
+
+

Detailed status code indicating the result.

+ +
+
+ +

◆ success

+ +
+
+ + + + +
bool gridfire::engine::PrimingReport::success
+
+

True if priming completed without error.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1engine_1_1PrimingReport.js b/docs/html/structgridfire_1_1engine_1_1PrimingReport.js new file mode 100644 index 00000000..4b74af41 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1PrimingReport.js @@ -0,0 +1,7 @@ +var structgridfire_1_1engine_1_1PrimingReport = +[ + [ "operator<<", "structgridfire_1_1engine_1_1PrimingReport.html#ac6c3112c984203fd5a672006be421736", null ], + [ "primedComposition", "structgridfire_1_1engine_1_1PrimingReport.html#a73acbf3cbec59f5516e4c7aa3f6ca150", null ], + [ "status", "structgridfire_1_1engine_1_1PrimingReport.html#ac3e0c141e56c7bc41dd89d5fc873fa41", null ], + [ "success", "structgridfire_1_1engine_1_1PrimingReport.html#a68aa5f346f5d9d598bf921e175c49239", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1engine_1_1PrimingReport__coll__graph.map b/docs/html/structgridfire_1_1engine_1_1PrimingReport__coll__graph.map new file mode 100644 index 00000000..5c5db329 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1PrimingReport__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/structgridfire_1_1engine_1_1PrimingReport__coll__graph.md5 b/docs/html/structgridfire_1_1engine_1_1PrimingReport__coll__graph.md5 new file mode 100644 index 00000000..449c5e1c --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1PrimingReport__coll__graph.md5 @@ -0,0 +1 @@ +91b79145f46022c93d5f36ce4c0a0849 \ No newline at end of file diff --git a/docs/html/structgridfire_1_1engine_1_1PrimingReport__coll__graph.svg b/docs/html/structgridfire_1_1engine_1_1PrimingReport__coll__graph.svg new file mode 100644 index 00000000..30858cc2 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1PrimingReport__coll__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +gridfire::engine::PrimingReport + + +Node1 + + +gridfire::engine::Priming +Report + + + + + +Node2 + + +Composition + + + + + +Node2->Node1 + + + + + + primedComposition + + + + + + + + diff --git a/docs/html/structgridfire_1_1engine_1_1PrimingReport__coll__graph_org.svg b/docs/html/structgridfire_1_1engine_1_1PrimingReport__coll__graph_org.svg new file mode 100644 index 00000000..03be2d70 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1PrimingReport__coll__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +gridfire::engine::PrimingReport + + +Node1 + + +gridfire::engine::Priming +Report + + + + + +Node2 + + +Composition + + + + + +Node2->Node1 + + + + + + primedComposition + + + diff --git a/docs/html/structgridfire_1_1engine_1_1StepDerivatives-members.html b/docs/html/structgridfire_1_1engine_1_1StepDerivatives-members.html new file mode 100644 index 00000000..b638b573 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1StepDerivatives-members.html @@ -0,0 +1,116 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::engine::StepDerivatives< T > Member List
+
+
+ +

This is the complete list of members for gridfire::engine::StepDerivatives< T >, including all inherited members.

+ + + + + + + +
dydtgridfire::engine::StepDerivatives< T >
neutrinoEnergyLossRategridfire::engine::StepDerivatives< T >
nuclearEnergyGenerationRategridfire::engine::StepDerivatives< T >
reactionContributionsgridfire::engine::StepDerivatives< T >
StepDerivatives()gridfire::engine::StepDerivatives< T >inline
totalNeutrinoFluxgridfire::engine::StepDerivatives< T >
+
+ + + + diff --git a/docs/html/structgridfire_1_1engine_1_1StepDerivatives.html b/docs/html/structgridfire_1_1engine_1_1StepDerivatives.html new file mode 100644 index 00000000..e00d76f4 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1StepDerivatives.html @@ -0,0 +1,277 @@ + + + + + + + +GridFire: gridfire::engine::StepDerivatives< T > Struct Template Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Public Attributes | +List of all members
+
gridfire::engine::StepDerivatives< T > Struct Template Reference
+
+
+ +

Structure holding derivatives and energy generation for a network step. + More...

+ +

#include <engine_abstract.h>

+
+Collaboration diagram for gridfire::engine::StepDerivatives< T >:
+
+
+
[legend]
+ + + + +

+Public Member Functions

 StepDerivatives ()
 
+ + + + + + + + + + + + + +

+Public Attributes

std::map< fourdst::atomic::Species, T > dydt {}
 Derivatives of abundances (dY/dt for each species).
 
T nuclearEnergyGenerationRate = T(0.0)
 Specific energy generation rate (e.g., erg/g/s).
 
std::map< fourdst::atomic::Species, std::unordered_map< std::string, T > > reactionContributions {}
 
T neutrinoEnergyLossRate = T(0.0)
 
T totalNeutrinoFlux = T(0.0)
 
+

Detailed Description

+
template<IsArithmeticOrAD T>
+struct gridfire::engine::StepDerivatives< T >

Structure holding derivatives and energy generation for a network step.

+
Template Parameters
+ + +
TNumeric type (double or CppAD::AD<double>).
+
+
+

This struct is used to return both the time derivatives of all species abundances and the specific nuclear energy generation rate for a single network evaluation.

+

Example usage:

StepDerivatives<double> result = engine.calculateRHSAndEnergy(Y, T9, rho);
+
for (double dydt_i : result.dydt) {
+
// Use derivative
+
}
+
double energyRate = result.nuclearEnergyGenerationRate;
+
gridfire::engine::StepDerivatives
Structure holding derivatives and energy generation for a network step.
Definition engine_abstract.h:53
+
gridfire::engine::StepDerivatives::dydt
std::map< fourdst::atomic::Species, T > dydt
Derivatives of abundances (dY/dt for each species).
Definition engine_abstract.h:54
+
gridfire::engine::StepDerivatives::nuclearEnergyGenerationRate
T nuclearEnergyGenerationRate
Specific energy generation rate (e.g., erg/g/s).
Definition engine_abstract.h:55
+

Constructor & Destructor Documentation

+ +

◆ StepDerivatives()

+ +
+
+
+template<IsArithmeticOrAD T>
+ + + + + +
+ + + + + + + +
gridfire::engine::StepDerivatives< T >::StepDerivatives ()
+ 		+inline
+
+ +
+
+

Member Data Documentation

+ +

◆ dydt

+ +
+
+
+template<IsArithmeticOrAD T>
+ + + + +
std::map<fourdst::atomic::Species, T> gridfire::engine::StepDerivatives< T >::dydt {}
+
+ +

Derivatives of abundances (dY/dt for each species).

+ +
+
+ +

◆ neutrinoEnergyLossRate

+ +
+
+
+template<IsArithmeticOrAD T>
+ + + + +
T gridfire::engine::StepDerivatives< T >::neutrinoEnergyLossRate = T(0.0)
+
+ +
+
+ +

◆ nuclearEnergyGenerationRate

+ +
+
+
+template<IsArithmeticOrAD T>
+ + + + +
T gridfire::engine::StepDerivatives< T >::nuclearEnergyGenerationRate = T(0.0)
+
+ +

Specific energy generation rate (e.g., erg/g/s).

+ +
+
+ +

◆ reactionContributions

+ +
+
+
+template<IsArithmeticOrAD T>
+ + + + +
std::map<fourdst::atomic::Species, std::unordered_map<std::string, T> > gridfire::engine::StepDerivatives< T >::reactionContributions {}
+
+ +
+
+ +

◆ totalNeutrinoFlux

+ +
+
+
+template<IsArithmeticOrAD T>
+ + + + +
T gridfire::engine::StepDerivatives< T >::totalNeutrinoFlux = T(0.0)
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1engine_1_1StepDerivatives.js b/docs/html/structgridfire_1_1engine_1_1StepDerivatives.js new file mode 100644 index 00000000..013ff38e --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1StepDerivatives.js @@ -0,0 +1,9 @@ +var structgridfire_1_1engine_1_1StepDerivatives = +[ + [ "StepDerivatives", "structgridfire_1_1engine_1_1StepDerivatives.html#ab6f82eeaf31cdb66fb40267838b19a34", null ], + [ "dydt", "structgridfire_1_1engine_1_1StepDerivatives.html#aad90bec88a31fce600c60c29835410b1", null ], + [ "neutrinoEnergyLossRate", "structgridfire_1_1engine_1_1StepDerivatives.html#a5e1ac820ff9682d74474c31b235b2848", null ], + [ "nuclearEnergyGenerationRate", "structgridfire_1_1engine_1_1StepDerivatives.html#ab00be76673548db59c4097f19dc8be93", null ], + [ "reactionContributions", "structgridfire_1_1engine_1_1StepDerivatives.html#ac269799f25d23045bf60dd27376d4337", null ], + [ "totalNeutrinoFlux", "structgridfire_1_1engine_1_1StepDerivatives.html#a97a3fe3cf9178044bcb57e371063a820", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1engine_1_1StepDerivatives__coll__graph.map b/docs/html/structgridfire_1_1engine_1_1StepDerivatives__coll__graph.map new file mode 100644 index 00000000..fe95398e --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1StepDerivatives__coll__graph.map @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/structgridfire_1_1engine_1_1StepDerivatives__coll__graph.md5 b/docs/html/structgridfire_1_1engine_1_1StepDerivatives__coll__graph.md5 new file mode 100644 index 00000000..eca0c23a --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1StepDerivatives__coll__graph.md5 @@ -0,0 +1 @@ +a4b8dcf1031f591209a37e8b4008e027 \ No newline at end of file diff --git a/docs/html/structgridfire_1_1engine_1_1StepDerivatives__coll__graph.svg b/docs/html/structgridfire_1_1engine_1_1StepDerivatives__coll__graph.svg new file mode 100644 index 00000000..ab91d6eb --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1StepDerivatives__coll__graph.svg @@ -0,0 +1,273 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::engine::StepDerivatives< T > + + +Node1 + + +gridfire::engine::StepDerivatives< T > + + + + + +Node2 + + +std::map< fourdst:: +atomic::Species, T > + + + + + +Node2->Node1 + + + + + + dydt + + + +Node3 + + +Species + + + + + +Node3->Node2 + + + + + + keys + + + +Node5 + + +std::map< fourdst:: +atomic::Species, std +::unordered_map< std +::string, T > > + + + + + +Node3->Node5 + + + + + + keys + + + +Node4 + + +T + + + + + +Node4->Node1 + + + + + + neutrinoEnergyLossRate +nuclearEnergyGenerationRate +totalNeutrinoFlux + + + +Node4->Node2 + + + + + + elements + + + +Node6 + + +std::unordered_map +< std::string, T > + + + + + +Node4->Node6 + + + + + + elements + + + +Node5->Node1 + + + + + + reactionContributions + + + +Node6->Node5 + + + + + + elements + + + +Node7 + + +std::string + + + + + +Node7->Node6 + + + + + + keys + + + +Node8 + + +std::basic_string< + Char > + + + + + +Node8->Node7 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/structgridfire_1_1engine_1_1StepDerivatives__coll__graph_org.svg b/docs/html/structgridfire_1_1engine_1_1StepDerivatives__coll__graph_org.svg new file mode 100644 index 00000000..997e29e5 --- /dev/null +++ b/docs/html/structgridfire_1_1engine_1_1StepDerivatives__coll__graph_org.svg @@ -0,0 +1,191 @@ + + + + + + +gridfire::engine::StepDerivatives< T > + + +Node1 + + +gridfire::engine::StepDerivatives< T > + + + + + +Node2 + + +std::map< fourdst:: +atomic::Species, T > + + + + + +Node2->Node1 + + + + + + dydt + + + +Node3 + + +Species + + + + + +Node3->Node2 + + + + + + keys + + + +Node5 + + +std::map< fourdst:: +atomic::Species, std +::unordered_map< std +::string, T > > + + + + + +Node3->Node5 + + + + + + keys + + + +Node4 + + +T + + + + + +Node4->Node1 + + + + + + neutrinoEnergyLossRate +nuclearEnergyGenerationRate +totalNeutrinoFlux + + + +Node4->Node2 + + + + + + elements + + + +Node6 + + +std::unordered_map +< std::string, T > + + + + + +Node4->Node6 + + + + + + elements + + + +Node5->Node1 + + + + + + reactionContributions + + + +Node6->Node5 + + + + + + elements + + + +Node7 + + +std::string + + + + + +Node7->Node6 + + + + + + keys + + + +Node8 + + +std::basic_string< + Char > + + + + + +Node8->Node7 + + + + + + + + diff --git a/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef-members.html b/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef-members.html new file mode 100644 index 00000000..a4f673cf --- /dev/null +++ b/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::io::gen::PyFunctionDef Member List
+
+
+ +

This is the complete list of members for gridfire::io::gen::PyFunctionDef, including all inherited members.

+ + + + +
func_codegridfire::io::gen::PyFunctionDef
func_namegridfire::io::gen::PyFunctionDef
module_reqgridfire::io::gen::PyFunctionDef
+
+ + + + diff --git a/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef.html b/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef.html new file mode 100644 index 00000000..92bb5fed --- /dev/null +++ b/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef.html @@ -0,0 +1,180 @@ + + + + + + + +GridFire: gridfire::io::gen::PyFunctionDef Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::io::gen::PyFunctionDef Struct Reference
+
+
+ +

Structure representing a Python function definition. + More...

+ +

#include <python.h>

+
+Collaboration diagram for gridfire::io::gen::PyFunctionDef:
+
+
+
[legend]
+ + + + + + + + +

+Public Attributes

std::string func_name
 
std::string func_code
 
std::vector< std::string > module_req
 
+

Detailed Description

+

Structure representing a Python function definition.

+

This structure holds the name, code, and module requirements for a Python function that represents a reaction.

+

Member Data Documentation

+ +

◆ func_code

+ +
+
+ + + + +
std::string gridfire::io::gen::PyFunctionDef::func_code
+
+ +
+
+ +

◆ func_name

+ +
+
+ + + + +
std::string gridfire::io::gen::PyFunctionDef::func_name
+
+ +
+
+ +

◆ module_req

+ +
+
+ + + + +
std::vector<std::string> gridfire::io::gen::PyFunctionDef::module_req
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef.js b/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef.js new file mode 100644 index 00000000..a6dfedc2 --- /dev/null +++ b/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef.js @@ -0,0 +1,6 @@ +var structgridfire_1_1io_1_1gen_1_1PyFunctionDef = +[ + [ "func_code", "structgridfire_1_1io_1_1gen_1_1PyFunctionDef.html#a7f54bd3e068a61b4e90de8d8f4d7207a", null ], + [ "func_name", "structgridfire_1_1io_1_1gen_1_1PyFunctionDef.html#a795d0022f7c645fc443781dc6bf35121", null ], + [ "module_req", "structgridfire_1_1io_1_1gen_1_1PyFunctionDef.html#a990ab36755e48519d132454a5f3f1df1", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef__coll__graph.map b/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef__coll__graph.map new file mode 100644 index 00000000..9347c010 --- /dev/null +++ b/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef__coll__graph.map @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef__coll__graph.md5 b/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef__coll__graph.md5 new file mode 100644 index 00000000..45302647 --- /dev/null +++ b/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef__coll__graph.md5 @@ -0,0 +1 @@ +ed1020e9f69eaa89d702854b4e8e08e2 \ No newline at end of file diff --git a/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef__coll__graph.svg b/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef__coll__graph.svg new file mode 100644 index 00000000..19dc3a04 --- /dev/null +++ b/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef__coll__graph.svg @@ -0,0 +1,115 @@ + + + + + + + + + + + +gridfire::io::gen::PyFunctionDef + + +Node1 + + +gridfire::io::gen:: +PyFunctionDef + + + + + +Node2 + + +std::string + + + + + +Node2->Node1 + + + + + + func_code +func_name + + + +Node4 + + +std::vector< std::string > + + + + + +Node2->Node4 + + + + + + elements + + + +Node3 + + +std::basic_string< + Char > + + + + + +Node3->Node2 + + + + + + + + +Node4->Node1 + + + + + + module_req + + + + + + + + diff --git a/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef__coll__graph_org.svg b/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef__coll__graph_org.svg new file mode 100644 index 00000000..16a12299 --- /dev/null +++ b/docs/html/structgridfire_1_1io_1_1gen_1_1PyFunctionDef__coll__graph_org.svg @@ -0,0 +1,90 @@ + + + + + + +gridfire::io::gen::PyFunctionDef + + +Node1 + + +gridfire::io::gen:: +PyFunctionDef + + + + + +Node2 + + +std::string + + + + + +Node2->Node1 + + + + + + func_code +func_name + + + +Node4 + + +std::vector< std::string > + + + + + +Node2->Node4 + + + + + + elements + + + +Node3 + + +std::basic_string< + Char > + + + + + +Node3->Node2 + + + + + + + + +Node4->Node1 + + + + + + module_req + + + diff --git a/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope-members.html b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope-members.html new file mode 100644 index 00000000..3a6f4803 --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope-members.html @@ -0,0 +1,114 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::partition::RauscherThielemannPartitionFunction::IdentifiedIsotope Member List
+
+
+ +

This is the complete list of members for gridfire::partition::RauscherThielemannPartitionFunction::IdentifiedIsotope, including all inherited members.

+ + + + + +
boundgridfire::partition::RauscherThielemannPartitionFunction::IdentifiedIsotope
datagridfire::partition::RauscherThielemannPartitionFunction::IdentifiedIsotope
lowerIndexgridfire::partition::RauscherThielemannPartitionFunction::IdentifiedIsotope
upperIndexgridfire::partition::RauscherThielemannPartitionFunction::IdentifiedIsotope
+
+ + + + diff --git a/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope.html b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope.html new file mode 100644 index 00000000..95a9dc92 --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope.html @@ -0,0 +1,188 @@ + + + + + + + +GridFire: gridfire::partition::RauscherThielemannPartitionFunction::IdentifiedIsotope Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::partition::RauscherThielemannPartitionFunction::IdentifiedIsotope Struct Reference
+
+
+
+Collaboration diagram for gridfire::partition::RauscherThielemannPartitionFunction::IdentifiedIsotope:
+
+
+
[legend]
+ + + + + + + + + + +

+Public Attributes

Bounds bound
 
const IsotopeData & data
 
size_t upperIndex
 
size_t lowerIndex
 
+

Member Data Documentation

+ +

◆ bound

+ +
+
+ + + + +
Bounds gridfire::partition::RauscherThielemannPartitionFunction::IdentifiedIsotope::bound
+
+ +
+
+ +

◆ data

+ +
+
+ + + + +
const IsotopeData& gridfire::partition::RauscherThielemannPartitionFunction::IdentifiedIsotope::data
+
+ +
+
+ +

◆ lowerIndex

+ +
+
+ + + + +
size_t gridfire::partition::RauscherThielemannPartitionFunction::IdentifiedIsotope::lowerIndex
+
+ +
+
+ +

◆ upperIndex

+ +
+
+ + + + +
size_t gridfire::partition::RauscherThielemannPartitionFunction::IdentifiedIsotope::upperIndex
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope.js b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope.js new file mode 100644 index 00000000..db26be21 --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope.js @@ -0,0 +1,7 @@ +var structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope = +[ + [ "bound", "structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope.html#a5f673ab0425f06f3639cc9b5200ee3af", null ], + [ "data", "structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope.html#a9b8fc949cc2cb1729c719cf20463e070", null ], + [ "lowerIndex", "structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope.html#a2da59e4f6e2ba3eff581bacabbf387de", null ], + [ "upperIndex", "structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope.html#aa99e1fa2fd4937592c066b0df16f377f", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope__coll__graph.map b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope__coll__graph.map new file mode 100644 index 00000000..30b928ec --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope__coll__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope__coll__graph.md5 b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope__coll__graph.md5 new file mode 100644 index 00000000..5beb8b1f --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope__coll__graph.md5 @@ -0,0 +1 @@ +dcba9d2c7505ea909e275bba3e15931f \ No newline at end of file diff --git a/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope__coll__graph.svg b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope__coll__graph.svg new file mode 100644 index 00000000..14bea73f --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope__coll__graph.svg @@ -0,0 +1,89 @@ + + + + + + + + + + + +gridfire::partition::RauscherThielemannPartitionFunction::IdentifiedIsotope + + +Node1 + + +gridfire::partition +::RauscherThielemannPartition +Function::IdentifiedIsotope + + + + + +Node2 + + +gridfire::partition +::RauscherThielemannPartition +Function::IsotopeData + + + + + +Node2->Node1 + + + + + + data + + + +Node3 + + +std::array< double, + 24 > + + + + + +Node3->Node2 + + + + + + normalized_g_values + + + + + + + + diff --git a/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope__coll__graph_org.svg b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope__coll__graph_org.svg new file mode 100644 index 00000000..bfe736bb --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IdentifiedIsotope__coll__graph_org.svg @@ -0,0 +1,64 @@ + + + + + + +gridfire::partition::RauscherThielemannPartitionFunction::IdentifiedIsotope + + +Node1 + + +gridfire::partition +::RauscherThielemannPartition +Function::IdentifiedIsotope + + + + + +Node2 + + +gridfire::partition +::RauscherThielemannPartition +Function::IsotopeData + + + + + +Node2->Node1 + + + + + + data + + + +Node3 + + +std::array< double, + 24 > + + + + + +Node3->Node2 + + + + + + normalized_g_values + + + diff --git a/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1InterpolationPoints-members.html b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1InterpolationPoints-members.html new file mode 100644 index 00000000..735aa6f9 --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1InterpolationPoints-members.html @@ -0,0 +1,114 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::partition::RauscherThielemannPartitionFunction::InterpolationPoints Member List
+
+
+ +

This is the complete list of members for gridfire::partition::RauscherThielemannPartitionFunction::InterpolationPoints, including all inherited members.

+ + + + + +
G_norm_highgridfire::partition::RauscherThielemannPartitionFunction::InterpolationPoints
G_norm_lowgridfire::partition::RauscherThielemannPartitionFunction::InterpolationPoints
T9_highgridfire::partition::RauscherThielemannPartitionFunction::InterpolationPoints
T9_lowgridfire::partition::RauscherThielemannPartitionFunction::InterpolationPoints
+
+ + + + diff --git a/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1InterpolationPoints.html b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1InterpolationPoints.html new file mode 100644 index 00000000..a034e409 --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1InterpolationPoints.html @@ -0,0 +1,195 @@ + + + + + + + +GridFire: gridfire::partition::RauscherThielemannPartitionFunction::InterpolationPoints Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::partition::RauscherThielemannPartitionFunction::InterpolationPoints Struct Reference
+
+
+ + + + + + + + + + + + + + +

+Public Attributes

double T9_high
 Upper temperature bound.
 
double G_norm_high
 Normalized G at upper bound.
 
double T9_low
 Lower temperature bound.
 
double G_norm_low
 Normalized G at lower bound.
 
+

Member Data Documentation

+ +

◆ G_norm_high

+ +
+
+ + + + +
double gridfire::partition::RauscherThielemannPartitionFunction::InterpolationPoints::G_norm_high
+
+ +

Normalized G at upper bound.

+ +
+
+ +

◆ G_norm_low

+ +
+
+ + + + +
double gridfire::partition::RauscherThielemannPartitionFunction::InterpolationPoints::G_norm_low
+
+ +

Normalized G at lower bound.

+ +
+
+ +

◆ T9_high

+ +
+
+ + + + +
double gridfire::partition::RauscherThielemannPartitionFunction::InterpolationPoints::T9_high
+
+ +

Upper temperature bound.

+ +
+
+ +

◆ T9_low

+ +
+
+ + + + +
double gridfire::partition::RauscherThielemannPartitionFunction::InterpolationPoints::T9_low
+
+ +

Lower temperature bound.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1InterpolationPoints.js b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1InterpolationPoints.js new file mode 100644 index 00000000..e68084bc --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1InterpolationPoints.js @@ -0,0 +1,7 @@ +var structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1InterpolationPoints = +[ + [ "G_norm_high", "structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1InterpolationPoints.html#a3cb7ee6f3031997aab99c5502b61d90e", null ], + [ "G_norm_low", "structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1InterpolationPoints.html#a7d291ba80f958fe34ae72b21c6fab380", null ], + [ "T9_high", "structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1InterpolationPoints.html#a750aa8cd8aa8b8da6d1f0db1cc66233d", null ], + [ "T9_low", "structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1InterpolationPoints.html#a48e170f77812fdbc06cff18267b241ca", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData-members.html b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData-members.html new file mode 100644 index 00000000..d287fce6 --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData-members.html @@ -0,0 +1,112 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::partition::RauscherThielemannPartitionFunction::IsotopeData Member List
+
+
+ +

This is the complete list of members for gridfire::partition::RauscherThielemannPartitionFunction::IsotopeData, including all inherited members.

+ + + +
ground_state_spingridfire::partition::RauscherThielemannPartitionFunction::IsotopeData
normalized_g_valuesgridfire::partition::RauscherThielemannPartitionFunction::IsotopeData
+
+ + + + diff --git a/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData.html b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData.html new file mode 100644 index 00000000..85c9623d --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData.html @@ -0,0 +1,162 @@ + + + + + + + +GridFire: gridfire::partition::RauscherThielemannPartitionFunction::IsotopeData Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::partition::RauscherThielemannPartitionFunction::IsotopeData Struct Reference
+
+
+
+Collaboration diagram for gridfire::partition::RauscherThielemannPartitionFunction::IsotopeData:
+
+
+
[legend]
+ + + + + + + + +

+Public Attributes

double ground_state_spin
 Spin of the isotope ground state.
 
std::array< double, 24 > normalized_g_values
 Normalized G values on RT grid.
 
+

Member Data Documentation

+ +

◆ ground_state_spin

+ +
+
+ + + + +
double gridfire::partition::RauscherThielemannPartitionFunction::IsotopeData::ground_state_spin
+
+ +

Spin of the isotope ground state.

+ +
+
+ +

◆ normalized_g_values

+ +
+
+ + + + +
std::array<double, 24> gridfire::partition::RauscherThielemannPartitionFunction::IsotopeData::normalized_g_values
+
+ +

Normalized G values on RT grid.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData.js b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData.js new file mode 100644 index 00000000..8f2bd83b --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData.js @@ -0,0 +1,5 @@ +var structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData = +[ + [ "ground_state_spin", "structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData.html#aec714697f3f5102124561252233fc350", null ], + [ "normalized_g_values", "structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData.html#aea71e9198606e0ba393321178f988fcc", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData__coll__graph.map b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData__coll__graph.map new file mode 100644 index 00000000..e4751d2f --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData__coll__graph.md5 b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData__coll__graph.md5 new file mode 100644 index 00000000..e6e54d7f --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData__coll__graph.md5 @@ -0,0 +1 @@ +9152de89cdf737a69499b5999fb58ba8 \ No newline at end of file diff --git a/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData__coll__graph.svg b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData__coll__graph.svg new file mode 100644 index 00000000..e5d3148a --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData__coll__graph.svg @@ -0,0 +1,68 @@ + + + + + + + + + + + +gridfire::partition::RauscherThielemannPartitionFunction::IsotopeData + + +Node1 + + +gridfire::partition +::RauscherThielemannPartition +Function::IsotopeData + + + + + +Node2 + + +std::array< double, + 24 > + + + + + +Node2->Node1 + + + + + + normalized_g_values + + + + + + + + diff --git a/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData__coll__graph_org.svg b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData__coll__graph_org.svg new file mode 100644 index 00000000..908b162b --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1RauscherThielemannPartitionFunction_1_1IsotopeData__coll__graph_org.svg @@ -0,0 +1,43 @@ + + + + + + +gridfire::partition::RauscherThielemannPartitionFunction::IsotopeData + + +Node1 + + +gridfire::partition +::RauscherThielemannPartition +Function::IsotopeData + + + + + +Node2 + + +std::array< double, + 24 > + + + + + +Node2->Node1 + + + + + + normalized_g_values + + + diff --git a/docs/html/structgridfire_1_1partition_1_1record_1_1RauscherThielemannPartitionDataRecord-members.html b/docs/html/structgridfire_1_1partition_1_1record_1_1RauscherThielemannPartitionDataRecord-members.html new file mode 100644 index 00000000..499d5a88 --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1record_1_1RauscherThielemannPartitionDataRecord-members.html @@ -0,0 +1,114 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::partition::record::RauscherThielemannPartitionDataRecord Member List
+
+
+ +

This is the complete list of members for gridfire::partition::record::RauscherThielemannPartitionDataRecord, including all inherited members.

+ + + + + +
agridfire::partition::record::RauscherThielemannPartitionDataRecord
ground_state_spingridfire::partition::record::RauscherThielemannPartitionDataRecord
normalized_g_valuesgridfire::partition::record::RauscherThielemannPartitionDataRecord
zgridfire::partition::record::RauscherThielemannPartitionDataRecord
+
+ + + + diff --git a/docs/html/structgridfire_1_1partition_1_1record_1_1RauscherThielemannPartitionDataRecord.html b/docs/html/structgridfire_1_1partition_1_1record_1_1RauscherThielemannPartitionDataRecord.html new file mode 100644 index 00000000..2e8a7b4d --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1record_1_1RauscherThielemannPartitionDataRecord.html @@ -0,0 +1,204 @@ + + + + + + + +GridFire: gridfire::partition::record::RauscherThielemannPartitionDataRecord Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::partition::record::RauscherThielemannPartitionDataRecord Struct Reference
+
+
+ +

Packed binary record of Rauscher-Thielemann partition function data for an isotope. + More...

+ +

#include <rauscher_thielemann_partition_data_record.h>

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

+Public Attributes

uint32_t z
 Atomic number.
 
uint32_t a
 Mass number.
 
double ground_state_spin
 Ground state spin.
 
double normalized_g_values [24]
 Normalized g-values for the first 24 energy levels.
 
+

Detailed Description

+

Packed binary record of Rauscher-Thielemann partition function data for an isotope.

+

Each record stores the atomic number (Z), mass number (A), ground state spin J, and an array of 24 normalized G-values corresponding to fixed temperature grid points. This struct is read directly from embedded binary data and must remain tightly packed.

+
Note
Alignment is set to 1 byte to match the binary layout.
+

Member Data Documentation

+ +

◆ a

+ +
+
+ + + + +
uint32_t gridfire::partition::record::RauscherThielemannPartitionDataRecord::a
+
+ +

Mass number.

+ +
+
+ +

◆ ground_state_spin

+ +
+
+ + + + +
double gridfire::partition::record::RauscherThielemannPartitionDataRecord::ground_state_spin
+
+ +

Ground state spin.

+ +
+
+ +

◆ normalized_g_values

+ +
+
+ + + + +
double gridfire::partition::record::RauscherThielemannPartitionDataRecord::normalized_g_values[24]
+
+ +

Normalized g-values for the first 24 energy levels.

+ +
+
+ +

◆ z

+ +
+
+ + + + +
uint32_t gridfire::partition::record::RauscherThielemannPartitionDataRecord::z
+
+ +

Atomic number.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1partition_1_1record_1_1RauscherThielemannPartitionDataRecord.js b/docs/html/structgridfire_1_1partition_1_1record_1_1RauscherThielemannPartitionDataRecord.js new file mode 100644 index 00000000..f2baed6b --- /dev/null +++ b/docs/html/structgridfire_1_1partition_1_1record_1_1RauscherThielemannPartitionDataRecord.js @@ -0,0 +1,7 @@ +var structgridfire_1_1partition_1_1record_1_1RauscherThielemannPartitionDataRecord = +[ + [ "a", "structgridfire_1_1partition_1_1record_1_1RauscherThielemannPartitionDataRecord.html#a677505655a1c6922dfa9b32b70d7e815", null ], + [ "ground_state_spin", "structgridfire_1_1partition_1_1record_1_1RauscherThielemannPartitionDataRecord.html#acf5c38826050594aee98d746d0ba40b2", null ], + [ "normalized_g_values", "structgridfire_1_1partition_1_1record_1_1RauscherThielemannPartitionDataRecord.html#a64c1cef58c1bdeab1fcc7f9a30a71609", null ], + [ "z", "structgridfire_1_1partition_1_1record_1_1RauscherThielemannPartitionDataRecord.html#abb1416e2d8d4d27264c9eece547006b6", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1policy_1_1TemperatureDependentChainPolicy_1_1ActiveTempRange-members.html b/docs/html/structgridfire_1_1policy_1_1TemperatureDependentChainPolicy_1_1ActiveTempRange-members.html new file mode 100644 index 00000000..78dafab4 --- /dev/null +++ b/docs/html/structgridfire_1_1policy_1_1TemperatureDependentChainPolicy_1_1ActiveTempRange-members.html @@ -0,0 +1,112 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::policy::TemperatureDependentChainPolicy::ActiveTempRange Member List
+
+
+ +

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

+ + + +
maxT9gridfire::policy::TemperatureDependentChainPolicy::ActiveTempRange
minT9gridfire::policy::TemperatureDependentChainPolicy::ActiveTempRange
+
+ + + + diff --git a/docs/html/structgridfire_1_1policy_1_1TemperatureDependentChainPolicy_1_1ActiveTempRange.html b/docs/html/structgridfire_1_1policy_1_1TemperatureDependentChainPolicy_1_1ActiveTempRange.html new file mode 100644 index 00000000..9a178015 --- /dev/null +++ b/docs/html/structgridfire_1_1policy_1_1TemperatureDependentChainPolicy_1_1ActiveTempRange.html @@ -0,0 +1,164 @@ + + + + + + + +GridFire: gridfire::policy::TemperatureDependentChainPolicy::ActiveTempRange Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::policy::TemperatureDependentChainPolicy::ActiveTempRange Struct Reference
+
+
+ +

Struct to hold the active temperature range for the reaction chain. + More...

+ +

#include <chains.h>

+ + + + + + + + +

+Public Attributes

std::optional< double > minT9
 Minimum temperature (in T9) for which the chain is active.
 
std::optional< double > maxT9
 Maximum temperature (in T9) for which the chain is active.
 
+

Detailed Description

+

Struct to hold the active temperature range for the reaction chain.

+

Member Data Documentation

+ +

◆ maxT9

+ +
+
+ + + + +
std::optional<double> gridfire::policy::TemperatureDependentChainPolicy::ActiveTempRange::maxT9
+
+ +

Maximum temperature (in T9) for which the chain is active.

+ +
+
+ +

◆ minT9

+ +
+
+ + + + +
std::optional<double> gridfire::policy::TemperatureDependentChainPolicy::ActiveTempRange::minT9
+
+ +

Minimum temperature (in T9) for which the chain is active.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1policy_1_1TemperatureDependentChainPolicy_1_1ActiveTempRange.js b/docs/html/structgridfire_1_1policy_1_1TemperatureDependentChainPolicy_1_1ActiveTempRange.js new file mode 100644 index 00000000..ad5a9745 --- /dev/null +++ b/docs/html/structgridfire_1_1policy_1_1TemperatureDependentChainPolicy_1_1ActiveTempRange.js @@ -0,0 +1,5 @@ +var structgridfire_1_1policy_1_1TemperatureDependentChainPolicy_1_1ActiveTempRange = +[ + [ "maxT9", "structgridfire_1_1policy_1_1TemperatureDependentChainPolicy_1_1ActiveTempRange.html#a886632a475bc41182717ef9fe502a010", null ], + [ "minT9", "structgridfire_1_1policy_1_1TemperatureDependentChainPolicy_1_1ActiveTempRange.html#af7e3aa5b84fc1310fa528a7dac3ae72f", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1BoundsErrorInfo-members.html b/docs/html/structgridfire_1_1rates_1_1weak_1_1BoundsErrorInfo-members.html new file mode 100644 index 00000000..539528e8 --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1BoundsErrorInfo-members.html @@ -0,0 +1,114 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::rates::weak::BoundsErrorInfo Member List
+
+
+ +

This is the complete list of members for gridfire::rates::weak::BoundsErrorInfo, including all inherited members.

+ + + + + +
axisgridfire::rates::weak::BoundsErrorInfo
axisMaxValuegridfire::rates::weak::BoundsErrorInfo
axisMinValuegridfire::rates::weak::BoundsErrorInfo
queryValuegridfire::rates::weak::BoundsErrorInfo
+
+ + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1BoundsErrorInfo.html b/docs/html/structgridfire_1_1rates_1_1weak_1_1BoundsErrorInfo.html new file mode 100644 index 00000000..4ef46bcc --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1BoundsErrorInfo.html @@ -0,0 +1,202 @@ + + + + + + + +GridFire: gridfire::rates::weak::BoundsErrorInfo Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::rates::weak::BoundsErrorInfo Struct Reference
+
+
+ +

Detailed bounds information for a BOUNDS_ERROR. + More...

+ +

#include <weak_types.h>

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

+Public Attributes

TableAxes axis
 Axis on which the error occurred.
 
double axisMinValue
 Minimum tabulated value on the axis.
 
double axisMaxValue
 Maximum tabulated value on the axis.
 
double queryValue
 Requested value.
 
+

Detailed Description

+

Detailed bounds information for a BOUNDS_ERROR.

+

Member Data Documentation

+ +

◆ axis

+ +
+
+ + + + +
TableAxes gridfire::rates::weak::BoundsErrorInfo::axis
+
+ +

Axis on which the error occurred.

+ +
+
+ +

◆ axisMaxValue

+ +
+
+ + + + +
double gridfire::rates::weak::BoundsErrorInfo::axisMaxValue
+
+ +

Maximum tabulated value on the axis.

+ +
+
+ +

◆ axisMinValue

+ +
+
+ + + + +
double gridfire::rates::weak::BoundsErrorInfo::axisMinValue
+
+ +

Minimum tabulated value on the axis.

+ +
+
+ +

◆ queryValue

+ +
+
+ + + + +
double gridfire::rates::weak::BoundsErrorInfo::queryValue
+
+ +

Requested value.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1BoundsErrorInfo.js b/docs/html/structgridfire_1_1rates_1_1weak_1_1BoundsErrorInfo.js new file mode 100644 index 00000000..782ca388 --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1BoundsErrorInfo.js @@ -0,0 +1,7 @@ +var structgridfire_1_1rates_1_1weak_1_1BoundsErrorInfo = +[ + [ "axis", "structgridfire_1_1rates_1_1weak_1_1BoundsErrorInfo.html#afb2af3df6ec5ea439b5ea55571975391", null ], + [ "axisMaxValue", "structgridfire_1_1rates_1_1weak_1_1BoundsErrorInfo.html#a6371b8f8c45a9b069b19dd968ff81b28", null ], + [ "axisMinValue", "structgridfire_1_1rates_1_1weak_1_1BoundsErrorInfo.html#a07dfb669f73b029a71eb59cbbed69f42", null ], + [ "queryValue", "structgridfire_1_1rates_1_1weak_1_1BoundsErrorInfo.html#a3eb0be2063f7333994a026a569ae5568", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1InterpolationError-members.html b/docs/html/structgridfire_1_1rates_1_1weak_1_1InterpolationError-members.html new file mode 100644 index 00000000..bd650dfc --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1InterpolationError-members.html @@ -0,0 +1,112 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::rates::weak::InterpolationError Member List
+
+
+ +

This is the complete list of members for gridfire::rates::weak::InterpolationError, including all inherited members.

+ + + +
boundsErrorInfogridfire::rates::weak::InterpolationError
typegridfire::rates::weak::InterpolationError
+
+ + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1InterpolationError.html b/docs/html/structgridfire_1_1rates_1_1weak_1_1InterpolationError.html new file mode 100644 index 00000000..b157cee1 --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1InterpolationError.html @@ -0,0 +1,162 @@ + + + + + + + +GridFire: gridfire::rates::weak::InterpolationError Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::rates::weak::InterpolationError Struct Reference
+
+
+ +

Interpolation error with optional per-axis bounds details. + More...

+ +

#include <weak_types.h>

+ + + + + + + +

+Public Attributes

InterpolationErrorType type
 Error category.
 
std::optional< std::unordered_map< TableAxes, BoundsErrorInfo > > boundsErrorInfo = std::nullopt
 
+

Detailed Description

+

Interpolation error with optional per-axis bounds details.

+

For BOUNDS_ERROR, boundsErrorInfo may contain an entry per offending axis.

+

Member Data Documentation

+ +

◆ boundsErrorInfo

+ +
+
+ + + + +
std::optional<std::unordered_map<TableAxes, BoundsErrorInfo> > gridfire::rates::weak::InterpolationError::boundsErrorInfo = std::nullopt
+
+ +
+
+ +

◆ type

+ +
+
+ + + + +
InterpolationErrorType gridfire::rates::weak::InterpolationError::type
+
+ +

Error category.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1InterpolationError.js b/docs/html/structgridfire_1_1rates_1_1weak_1_1InterpolationError.js new file mode 100644 index 00000000..d33e2abd --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1InterpolationError.js @@ -0,0 +1,5 @@ +var structgridfire_1_1rates_1_1weak_1_1InterpolationError = +[ + [ "boundsErrorInfo", "structgridfire_1_1rates_1_1weak_1_1InterpolationError.html#a1541a5280bd1b3f90bc62d7c0e1f80a1", null ], + [ "type", "structgridfire_1_1rates_1_1weak_1_1InterpolationError.html#a086720ca534bc4c63d9341995e2f87bd", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid-members.html b/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid-members.html new file mode 100644 index 00000000..d87ad717 --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::rates::weak::IsotopeGrid Member List
+
+
+ +

This is the complete list of members for gridfire::rates::weak::IsotopeGrid, including all inherited members.

+ + + + +
datagridfire::rates::weak::IsotopeGrid
rhoYe_axisgridfire::rates::weak::IsotopeGrid
t9_axisgridfire::rates::weak::IsotopeGrid
+
+ + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid.html b/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid.html new file mode 100644 index 00000000..9dfda10f --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid.html @@ -0,0 +1,190 @@ + + + + + + + +GridFire: gridfire::rates::weak::IsotopeGrid Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::rates::weak::IsotopeGrid Struct Reference
+
+
+ +

Regular 2D grid and payloads for a single isotope (A,Z). + More...

+ +

#include <weak_types.h>

+
+Collaboration diagram for gridfire::rates::weak::IsotopeGrid:
+
+
+
[legend]
+ + + + + + + + + + + +

+Public Attributes

std::vector< double > t9_axis
 Unique sorted T9 grid.
 
std::vector< double > rhoYe_axis
 Unique sorted log10(rho*Ye) grid.
 
std::vector< WeakRatePayload > data
 MuE axis for each (T9, log_rhoYe) pair (the table is ragged in mu_e). This is also where the payloads are stored.
 
+

Detailed Description

+

Regular 2D grid and payloads for a single isotope (A,Z).

+

Axes are monotonically increasing per dimension. Data vector is laid out in row-major order with index computed as:

+

index = i_t9 * N_rhoYe + j_rhoYe

+

Member Data Documentation

+ +

◆ data

+ +
+
+ + + + +
std::vector<WeakRatePayload> gridfire::rates::weak::IsotopeGrid::data
+
+ +

MuE axis for each (T9, log_rhoYe) pair (the table is ragged in mu_e). This is also where the payloads are stored.

+ +
+
+ +

◆ rhoYe_axis

+ +
+
+ + + + +
std::vector<double> gridfire::rates::weak::IsotopeGrid::rhoYe_axis
+
+ +

Unique sorted log10(rho*Ye) grid.

+ +
+
+ +

◆ t9_axis

+ +
+
+ + + + +
std::vector<double> gridfire::rates::weak::IsotopeGrid::t9_axis
+
+ +

Unique sorted T9 grid.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid.js b/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid.js new file mode 100644 index 00000000..1c9a6428 --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid.js @@ -0,0 +1,6 @@ +var structgridfire_1_1rates_1_1weak_1_1IsotopeGrid = +[ + [ "data", "structgridfire_1_1rates_1_1weak_1_1IsotopeGrid.html#ad0df5ef84e3a78d881838a3bb014db83", null ], + [ "rhoYe_axis", "structgridfire_1_1rates_1_1weak_1_1IsotopeGrid.html#a30362f5bb497ae74cf6a10fd701273a0", null ], + [ "t9_axis", "structgridfire_1_1rates_1_1weak_1_1IsotopeGrid.html#a99da523669d85aa0a628d35a077d541c", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid__coll__graph.map b/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid__coll__graph.map new file mode 100644 index 00000000..a4072bdc --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid__coll__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid__coll__graph.md5 b/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid__coll__graph.md5 new file mode 100644 index 00000000..6968b9d7 --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid__coll__graph.md5 @@ -0,0 +1 @@ +a0ad7ac030131d812de737a8df6b5f2b \ No newline at end of file diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid__coll__graph.svg b/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid__coll__graph.svg new file mode 100644 index 00000000..29510a3d --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid__coll__graph.svg @@ -0,0 +1,107 @@ + + + + + + + + + + + +gridfire::rates::weak::IsotopeGrid + + +Node1 + + +gridfire::rates::weak +::IsotopeGrid + + + + + +Node2 + + +std::vector< double > + + + + + +Node2->Node1 + + + + + + rhoYe_axis +t9_axis + + + +Node3 + + +std::vector< gridfire +::rates::weak::WeakRatePayload > + + + + + +Node3->Node1 + + + + + + data + + + +Node4 + + +gridfire::rates::weak +::WeakRatePayload + + + + + +Node4->Node3 + + + + + + elements + + + + + + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid__coll__graph_org.svg b/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid__coll__graph_org.svg new file mode 100644 index 00000000..fa36511e --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1IsotopeGrid__coll__graph_org.svg @@ -0,0 +1,82 @@ + + + + + + +gridfire::rates::weak::IsotopeGrid + + +Node1 + + +gridfire::rates::weak +::IsotopeGrid + + + + + +Node2 + + +std::vector< double > + + + + + +Node2->Node1 + + + + + + rhoYe_axis +t9_axis + + + +Node3 + + +std::vector< gridfire +::rates::weak::WeakRatePayload > + + + + + +Node3->Node1 + + + + + + data + + + +Node4 + + +gridfire::rates::weak +::WeakRatePayload + + + + + +Node4->Node3 + + + + + + elements + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1RateDataRow-members.html b/docs/html/structgridfire_1_1rates_1_1weak_1_1RateDataRow-members.html new file mode 100644 index 00000000..436844d5 --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1RateDataRow-members.html @@ -0,0 +1,121 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::rates::weak::RateDataRow Member List
+
+
+ +

This is the complete list of members for gridfire::rates::weak::RateDataRow, including all inherited members.

+ + + + + + + + + + + + +
Agridfire::rates::weak::RateDataRow
log_antineutrino_loss_bdgridfire::rates::weak::RateDataRow
log_beta_minusgridfire::rates::weak::RateDataRow
log_beta_plusgridfire::rates::weak::RateDataRow
log_electron_capturegridfire::rates::weak::RateDataRow
log_neutrino_loss_ecgridfire::rates::weak::RateDataRow
log_positron_capturegridfire::rates::weak::RateDataRow
log_rhoyegridfire::rates::weak::RateDataRow
mu_egridfire::rates::weak::RateDataRow
t9gridfire::rates::weak::RateDataRow
Zgridfire::rates::weak::RateDataRow
+
+ + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1RateDataRow.html b/docs/html/structgridfire_1_1rates_1_1weak_1_1RateDataRow.html new file mode 100644 index 00000000..7a870e5e --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1RateDataRow.html @@ -0,0 +1,347 @@ + + + + + + + +GridFire: gridfire::rates::weak::RateDataRow Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::rates::weak::RateDataRow Struct Reference
+
+
+ +

One row of the unified weak-rate data table for a specific isotope and state. + More...

+ +

#include <weak_types.h>

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

+Public Attributes

uint16_t A
 Mass number.
 
uint8_t Z
 Proton number.
 
float t9
 Temperature in GK.
 
float log_rhoye
 log10(rho*Ye) (cgs density times electron fraction).
 
float mu_e
 Electron chemical potential (MeV).
 
float log_beta_plus
 log10(β+ decay rate).
 
float log_electron_capture
 log10(e− capture rate).
 
float log_neutrino_loss_ec
 log10(neutrino loss for β+ and e− capture).
 
float log_beta_minus
 log10(β− decay rate).
 
float log_positron_capture
 log10(e+ capture rate).
 
float log_antineutrino_loss_bd
 log10(antineutrino loss for β− and e+ capture).
 
+

Detailed Description

+

One row of the unified weak-rate data table for a specific isotope and state.

+

Units and meanings:

    +
  • t9: temperature in GK (10^9 K).
    • +
  • log_rhoye: base-10 logarithm of rho*Ye where rho is g cm^-3 and Ye is electron fraction.
    • +
  • mu_e: electron chemical potential in MeV.
    • +
  • log_*: base-10 logarithm of the tabulated rate or neutrino-energy loss term.
    • +
+

Channel mappings:

    +
  • beta-plus (β+): log_beta_plus, neutrino-loss column log_neutrino_loss_ec.
    • +
  • electron capture (e− cap): log_electron_capture, neutrino-loss column log_neutrino_loss_ec.
    • +
  • beta-minus (β−): log_beta_minus, neutrino-loss column log_antineutrino_loss_bd.
    • +
  • positron capture (e+ cap): log_positron_capture, neutrino-loss column log_antineutrino_loss_bd.
    • +
+

Member Data Documentation

+ +

◆ A

+ +
+
+ + + + +
uint16_t gridfire::rates::weak::RateDataRow::A
+
+ +

Mass number.

+ +
+
+ +

◆ log_antineutrino_loss_bd

+ +
+
+ + + + +
float gridfire::rates::weak::RateDataRow::log_antineutrino_loss_bd
+
+ +

log10(antineutrino loss for β− and e+ capture).

+ +
+
+ +

◆ log_beta_minus

+ +
+
+ + + + +
float gridfire::rates::weak::RateDataRow::log_beta_minus
+
+ +

log10(β− decay rate).

+ +
+
+ +

◆ log_beta_plus

+ +
+
+ + + + +
float gridfire::rates::weak::RateDataRow::log_beta_plus
+
+ +

log10(β+ decay rate).

+ +
+
+ +

◆ log_electron_capture

+ +
+
+ + + + +
float gridfire::rates::weak::RateDataRow::log_electron_capture
+
+ +

log10(e− capture rate).

+ +
+
+ +

◆ log_neutrino_loss_ec

+ +
+
+ + + + +
float gridfire::rates::weak::RateDataRow::log_neutrino_loss_ec
+
+ +

log10(neutrino loss for β+ and e− capture).

+ +
+
+ +

◆ log_positron_capture

+ +
+
+ + + + +
float gridfire::rates::weak::RateDataRow::log_positron_capture
+
+ +

log10(e+ capture rate).

+ +
+
+ +

◆ log_rhoye

+ +
+
+ + + + +
float gridfire::rates::weak::RateDataRow::log_rhoye
+
+ +

log10(rho*Ye) (cgs density times electron fraction).

+ +
+
+ +

◆ mu_e

+ +
+
+ + + + +
float gridfire::rates::weak::RateDataRow::mu_e
+
+ +

Electron chemical potential (MeV).

+ +
+
+ +

◆ t9

+ +
+
+ + + + +
float gridfire::rates::weak::RateDataRow::t9
+
+ +

Temperature in GK.

+ +
+
+ +

◆ Z

+ +
+
+ + + + +
uint8_t gridfire::rates::weak::RateDataRow::Z
+
+ +

Proton number.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1RateDataRow.js b/docs/html/structgridfire_1_1rates_1_1weak_1_1RateDataRow.js new file mode 100644 index 00000000..64041c79 --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1RateDataRow.js @@ -0,0 +1,14 @@ +var structgridfire_1_1rates_1_1weak_1_1RateDataRow = +[ + [ "A", "structgridfire_1_1rates_1_1weak_1_1RateDataRow.html#aee9ee73218397780a2a7708c29779c73", null ], + [ "log_antineutrino_loss_bd", "structgridfire_1_1rates_1_1weak_1_1RateDataRow.html#a9d4db2970fc7f525824f6666198b3d56", null ], + [ "log_beta_minus", "structgridfire_1_1rates_1_1weak_1_1RateDataRow.html#ab41dace2493e036460736d8124a3475c", null ], + [ "log_beta_plus", "structgridfire_1_1rates_1_1weak_1_1RateDataRow.html#a359555f2b05e4b30bf810e12456df43b", null ], + [ "log_electron_capture", "structgridfire_1_1rates_1_1weak_1_1RateDataRow.html#a075a70baa4ac5859fb01d493e08debdd", null ], + [ "log_neutrino_loss_ec", "structgridfire_1_1rates_1_1weak_1_1RateDataRow.html#abd2d7fc00f582316eae824ccafef9b4b", null ], + [ "log_positron_capture", "structgridfire_1_1rates_1_1weak_1_1RateDataRow.html#afc3f5d3e5c3ec52134619fd462922f85", null ], + [ "log_rhoye", "structgridfire_1_1rates_1_1weak_1_1RateDataRow.html#ad7908a8b8a1db5014f23a7b3855156b0", null ], + [ "mu_e", "structgridfire_1_1rates_1_1weak_1_1RateDataRow.html#ac08d42071950006ccf3c438253ef9ee9", null ], + [ "t9", "structgridfire_1_1rates_1_1weak_1_1RateDataRow.html#a2344c046a615bc6ff07327d6bcfe074b", null ], + [ "Z", "structgridfire_1_1rates_1_1weak_1_1RateDataRow.html#a318b62e183dcb49c04260832454fa721", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives-members.html b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives-members.html new file mode 100644 index 00000000..d4d0850e --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives-members.html @@ -0,0 +1,116 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::rates::weak::WeakRateDerivatives Member List
+
+
+ +

This is the complete list of members for gridfire::rates::weak::WeakRateDerivatives, including all inherited members.

+ + + + + + + +
d_log_antineutrino_loss_bdgridfire::rates::weak::WeakRateDerivatives
d_log_beta_minusgridfire::rates::weak::WeakRateDerivatives
d_log_beta_plusgridfire::rates::weak::WeakRateDerivatives
d_log_electron_capturegridfire::rates::weak::WeakRateDerivatives
d_log_neutrino_loss_ecgridfire::rates::weak::WeakRateDerivatives
d_log_positron_capturegridfire::rates::weak::WeakRateDerivatives
+
+ + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives.html b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives.html new file mode 100644 index 00000000..33fc93ff --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives.html @@ -0,0 +1,228 @@ + + + + + + + +GridFire: gridfire::rates::weak::WeakRateDerivatives Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::rates::weak::WeakRateDerivatives Struct Reference
+
+
+ +

Partial derivatives of the log10() fields w.r.t. (T9, log10(rho*Ye)). + More...

+ +

#include <weak_types.h>

+
+Collaboration diagram for gridfire::rates::weak::WeakRateDerivatives:
+
+
+
[legend]
+ + + + + + + + + + + + + + +

+Public Attributes

std::array< double, 2 > d_log_beta_plus
 
std::array< double, 2 > d_log_electron_capture
 
std::array< double, 2 > d_log_neutrino_loss_ec
 
std::array< double, 2 > d_log_beta_minus
 
std::array< double, 2 > d_log_positron_capture
 
std::array< double, 2 > d_log_antineutrino_loss_bd
 
+

Detailed Description

+

Partial derivatives of the log10() fields w.r.t. (T9, log10(rho*Ye)).

+

Array ordering is [d/dT9, d/dlogRhoYe] for each corresponding field.

+

Member Data Documentation

+ +

◆ d_log_antineutrino_loss_bd

+ +
+
+ + + + +
std::array<double, 2> gridfire::rates::weak::WeakRateDerivatives::d_log_antineutrino_loss_bd
+
+ +
+
+ +

◆ d_log_beta_minus

+ +
+
+ + + + +
std::array<double, 2> gridfire::rates::weak::WeakRateDerivatives::d_log_beta_minus
+
+ +
+
+ +

◆ d_log_beta_plus

+ +
+
+ + + + +
std::array<double, 2> gridfire::rates::weak::WeakRateDerivatives::d_log_beta_plus
+
+ +
+
+ +

◆ d_log_electron_capture

+ +
+
+ + + + +
std::array<double, 2> gridfire::rates::weak::WeakRateDerivatives::d_log_electron_capture
+
+ +
+
+ +

◆ d_log_neutrino_loss_ec

+ +
+
+ + + + +
std::array<double, 2> gridfire::rates::weak::WeakRateDerivatives::d_log_neutrino_loss_ec
+
+ +
+
+ +

◆ d_log_positron_capture

+ +
+
+ + + + +
std::array<double, 2> gridfire::rates::weak::WeakRateDerivatives::d_log_positron_capture
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives.js b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives.js new file mode 100644 index 00000000..07ec7e1a --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives.js @@ -0,0 +1,9 @@ +var structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives = +[ + [ "d_log_antineutrino_loss_bd", "structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives.html#a5f6e7e1c799fbdc9822397a86454cf3f", null ], + [ "d_log_beta_minus", "structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives.html#a4d631203f78251f58ccfe5292c12cd56", null ], + [ "d_log_beta_plus", "structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives.html#af7f41ee20e21693d5a78abdfd93161d4", null ], + [ "d_log_electron_capture", "structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives.html#a38a088b882131fa00bab789eeaca3dc3", null ], + [ "d_log_neutrino_loss_ec", "structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives.html#a8a3167159eeaffbf3052528f5067cbac", null ], + [ "d_log_positron_capture", "structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives.html#a66e72144cc2398e0ff5f8b43ad9d15e8", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives__coll__graph.map b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives__coll__graph.map new file mode 100644 index 00000000..170f7584 --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives__coll__graph.md5 b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives__coll__graph.md5 new file mode 100644 index 00000000..6dbe40da --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives__coll__graph.md5 @@ -0,0 +1 @@ +35469f94d3f4904252bd99df8aa6ebc2 \ No newline at end of file diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives__coll__graph.svg b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives__coll__graph.svg new file mode 100644 index 00000000..8e5998a0 --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives__coll__graph.svg @@ -0,0 +1,73 @@ + + + + + + + + + + + +gridfire::rates::weak::WeakRateDerivatives + + +Node1 + + +gridfire::rates::weak +::WeakRateDerivatives + + + + + +Node2 + + +std::array< double, 2 > + + + + + +Node2->Node1 + + + + + + d_log_antineutrino +_loss_bd +d_log_beta_minus +d_log_beta_plus +d_log_electron_capture +d_log_neutrino_loss +_ec +d_log_positron_capture + + + + + + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives__coll__graph_org.svg b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives__coll__graph_org.svg new file mode 100644 index 00000000..c5480b12 --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRateDerivatives__coll__graph_org.svg @@ -0,0 +1,48 @@ + + + + + + +gridfire::rates::weak::WeakRateDerivatives + + +Node1 + + +gridfire::rates::weak +::WeakRateDerivatives + + + + + +Node2 + + +std::array< double, 2 > + + + + + +Node2->Node1 + + + + + + d_log_antineutrino +_loss_bd +d_log_beta_minus +d_log_beta_plus +d_log_electron_capture +d_log_neutrino_loss +_ec +d_log_positron_capture + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRatePayload-members.html b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRatePayload-members.html new file mode 100644 index 00000000..b00dbca5 --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRatePayload-members.html @@ -0,0 +1,116 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::rates::weak::WeakRatePayload Member List
+
+
+ +

This is the complete list of members for gridfire::rates::weak::WeakRatePayload, including all inherited members.

+ + + + + + + +
log_antineutrino_loss_bdgridfire::rates::weak::WeakRatePayload
log_beta_minusgridfire::rates::weak::WeakRatePayload
log_beta_plusgridfire::rates::weak::WeakRatePayload
log_electron_capturegridfire::rates::weak::WeakRatePayload
log_neutrino_loss_ecgridfire::rates::weak::WeakRatePayload
log_positron_capturegridfire::rates::weak::WeakRatePayload
+
+ + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRatePayload.html b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRatePayload.html new file mode 100644 index 00000000..246b7abe --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRatePayload.html @@ -0,0 +1,241 @@ + + + + + + + +GridFire: gridfire::rates::weak::WeakRatePayload Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::rates::weak::WeakRatePayload Struct Reference
+
+
+ +

Interpolated weak-rate payload at a single state. + More...

+ +

#include <weak_types.h>

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

+Public Attributes

double log_beta_plus
 log10(β+ decay rate).
 
double log_electron_capture
 log10(e− capture rate).
 
double log_neutrino_loss_ec
 log10(neutrino loss for β+ and e− capture).
 
double log_beta_minus
 log10(β− decay rate).
 
double log_positron_capture
 log10(e+ capture rate).
 
double log_antineutrino_loss_bd
 log10(antineutrino loss for β− and e+ capture).
 
+

Detailed Description

+

Interpolated weak-rate payload at a single state.

+

All values are base-10 logarithms of the corresponding rates or neutrino-loss terms. Consumers typically convert with pow(10, log_value) and may apply sentinel thresholds at the usage site.

+

Member Data Documentation

+ +

◆ log_antineutrino_loss_bd

+ +
+
+ + + + +
double gridfire::rates::weak::WeakRatePayload::log_antineutrino_loss_bd
+
+ +

log10(antineutrino loss for β− and e+ capture).

+ +
+
+ +

◆ log_beta_minus

+ +
+
+ + + + +
double gridfire::rates::weak::WeakRatePayload::log_beta_minus
+
+ +

log10(β− decay rate).

+ +
+
+ +

◆ log_beta_plus

+ +
+
+ + + + +
double gridfire::rates::weak::WeakRatePayload::log_beta_plus
+
+ +

log10(β+ decay rate).

+ +
+
+ +

◆ log_electron_capture

+ +
+
+ + + + +
double gridfire::rates::weak::WeakRatePayload::log_electron_capture
+
+ +

log10(e− capture rate).

+ +
+
+ +

◆ log_neutrino_loss_ec

+ +
+
+ + + + +
double gridfire::rates::weak::WeakRatePayload::log_neutrino_loss_ec
+
+ +

log10(neutrino loss for β+ and e− capture).

+ +
+
+ +

◆ log_positron_capture

+ +
+
+ + + + +
double gridfire::rates::weak::WeakRatePayload::log_positron_capture
+
+ +

log10(e+ capture rate).

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRatePayload.js b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRatePayload.js new file mode 100644 index 00000000..8fa303d4 --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakRatePayload.js @@ -0,0 +1,9 @@ +var structgridfire_1_1rates_1_1weak_1_1WeakRatePayload = +[ + [ "log_antineutrino_loss_bd", "structgridfire_1_1rates_1_1weak_1_1WeakRatePayload.html#a9134b85837be88ece72c20df9edce50d", null ], + [ "log_beta_minus", "structgridfire_1_1rates_1_1weak_1_1WeakRatePayload.html#aa2e81d295afba465427e46b36e1438e4", null ], + [ "log_beta_plus", "structgridfire_1_1rates_1_1weak_1_1WeakRatePayload.html#a9d71d093fbb35cd8a451ea12cde28771", null ], + [ "log_electron_capture", "structgridfire_1_1rates_1_1weak_1_1WeakRatePayload.html#aeb0494f46a0c6b9e29ed4cc15f07364b", null ], + [ "log_neutrino_loss_ec", "structgridfire_1_1rates_1_1weak_1_1WeakRatePayload.html#a6bbeb82cc27fd59ceafa320c1515106a", null ], + [ "log_positron_capture", "structgridfire_1_1rates_1_1weak_1_1WeakRatePayload.html#abe1b2dd11ec550311a58555f3a945cbe", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry-members.html b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry-members.html new file mode 100644 index 00000000..5df535ea --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry-members.html @@ -0,0 +1,117 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::rates::weak::WeakReactionEntry Member List
+
+
+ +

This is the complete list of members for gridfire::rates::weak::WeakReactionEntry, including all inherited members.

+ + + + + + + + +
log_neutrino_lossgridfire::rates::weak::WeakReactionEntry
log_rategridfire::rates::weak::WeakReactionEntry
log_rhoYegridfire::rates::weak::WeakReactionEntry
mu_egridfire::rates::weak::WeakReactionEntry
operator<<gridfire::rates::weak::WeakReactionEntryfriend
T9gridfire::rates::weak::WeakReactionEntry
typegridfire::rates::weak::WeakReactionEntry
+
+ + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry.html b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry.html new file mode 100644 index 00000000..d92d7e9b --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry.html @@ -0,0 +1,289 @@ + + + + + + + +GridFire: gridfire::rates::weak::WeakReactionEntry Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +Friends | +List of all members
+
gridfire::rates::weak::WeakReactionEntry Struct Reference
+
+
+ +

A single weak-reaction data point (type, state, and log values). + More...

+ +

#include <weak_types.h>

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

+Public Attributes

WeakReactionType type
 Channel.
 
float T9
 Temperature in GK.
 
float log_rhoYe
 log10(rho*Ye).
 
float mu_e
 Electron chemical potential (MeV).
 
float log_rate
 Channel-specific log10(rate).
 
float log_neutrino_loss
 Corresponding log10(neutrino or antineutrino energy loss).
 
+ + + +

+Friends

std::ostream & operator<< (std::ostream &os, const WeakReactionEntry &reaction)
 
+

Detailed Description

+

A single weak-reaction data point (type, state, and log values).

+

All rates and losses are base-10 logarithms. Useful for listing and filtering weak entries for a Species.

+
Example
WeakReactionEntry e{WeakReactionType::ELECTRON_CAPTURE, 3.0f, 6.0f, 2.0f, -2.3f, -1.7f};
+
std::cout << e << "\n"; // prints a compact summary
+
gridfire::rates::weak::WeakReactionType::ELECTRON_CAPTURE
@ ELECTRON_CAPTURE
e− capture: (Z, e−) -> Z-1 + ν_e
+
gridfire::rates::weak::WeakReactionEntry
A single weak-reaction data point (type, state, and log values).
Definition weak_types.h:213
+
+

Friends And Related Symbol Documentation

+ +

◆ operator<<

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::ostream & operator<< (std::ostream & os,
const WeakReactionEntry & reaction 
)
+ 		+friend
+
+ +
+
+

Member Data Documentation

+ +

◆ log_neutrino_loss

+ +
+
+ + + + +
float gridfire::rates::weak::WeakReactionEntry::log_neutrino_loss
+
+ +

Corresponding log10(neutrino or antineutrino energy loss).

+ +
+
+ +

◆ log_rate

+ +
+
+ + + + +
float gridfire::rates::weak::WeakReactionEntry::log_rate
+
+ +

Channel-specific log10(rate).

+ +
+
+ +

◆ log_rhoYe

+ +
+
+ + + + +
float gridfire::rates::weak::WeakReactionEntry::log_rhoYe
+
+ +

log10(rho*Ye).

+ +
+
+ +

◆ mu_e

+ +
+
+ + + + +
float gridfire::rates::weak::WeakReactionEntry::mu_e
+
+ +

Electron chemical potential (MeV).

+ +
+
+ +

◆ T9

+ +
+
+ + + + +
float gridfire::rates::weak::WeakReactionEntry::T9
+
+ +

Temperature in GK.

+ +
+
+ +

◆ type

+ +
+
+ + + + +
WeakReactionType gridfire::rates::weak::WeakReactionEntry::type
+
+ +

Channel.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry.js b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry.js new file mode 100644 index 00000000..ff1e8fe8 --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry.js @@ -0,0 +1,10 @@ +var structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry = +[ + [ "operator<<", "structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry.html#a5a2525ca7e7b2c812b1f67b3b0114aaf", null ], + [ "log_neutrino_loss", "structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry.html#aa603395b65c8639f8d93f73b7d9bd61e", null ], + [ "log_rate", "structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry.html#a90b6e47918fa750c28917ba6136c7880", null ], + [ "log_rhoYe", "structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry.html#a17dde21438cabec9ae23a0d318c41a7a", null ], + [ "mu_e", "structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry.html#a4a1cbc93d5e197a69a5a29a8cabc6498", null ], + [ "T9", "structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry.html#a549f4c9266722314f61d668d8507145c", null ], + [ "type", "structgridfire_1_1rates_1_1weak_1_1WeakReactionEntry.html#ad0bb77849bda4934472675e196af87c8", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants-members.html b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants-members.html new file mode 100644 index 00000000..74f95d2a --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants-members.html @@ -0,0 +1,124 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::rates::weak::WeakReaction::constants Member List
+
+
+ +

This is the complete list of members for gridfire::rates::weak::WeakReaction::constants, including all inherited members.

+ + + + + + + + + + + + + + + +
amugridfire::rates::weak::WeakReaction::constants
cgridfire::rates::weak::WeakReaction::constants
electronMassGgridfire::rates::weak::WeakReaction::constants
electronMassMeVgridfire::rates::weak::WeakReaction::constants
eVgRelationgridfire::rates::weak::WeakReaction::constants
MeV2Erggridfire::rates::weak::WeakReaction::constants
MeVgRelationgridfire::rates::weak::WeakReaction::constants
MeVPerGraphgridfire::rates::weak::WeakReaction::constants
neutronMassGgridfire::rates::weak::WeakReaction::constants
neutronMassMeVgridfire::rates::weak::WeakReaction::constants
protonMassGgridfire::rates::weak::WeakReaction::constants
protonMassMeVgridfire::rates::weak::WeakReaction::constants
speedOfLightgridfire::rates::weak::WeakReaction::constants
u_to_MeVgridfire::rates::weak::WeakReaction::constants
+
+ + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.html b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.html new file mode 100644 index 00000000..14e21582 --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.html @@ -0,0 +1,343 @@ + + + + + + + +GridFire: gridfire::rates::weak::WeakReaction::constants Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::rates::weak::WeakReaction::constants Struct Reference
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

const fourdst::constant::Constants & c = fourdst::constant::Constants::getInstance()
 
fourdst::constant::Constant neutronMassG = c.get("mN")
 
fourdst::constant::Constant protonMassG = c.get("mP")
 
fourdst::constant::Constant electronMassG = c.get("mE")
 
fourdst::constant::Constant speedOfLight = c.get("c")
 
fourdst::constant::Constant eVgRelation = c.get("eV_kg")
 
fourdst::constant::Constant MeV2Erg = c.get("MeV_to_erg")
 
fourdst::constant::Constant amu = c.get("u")
 
double MeVgRelation = eVgRelation.value * 1.0e6
 
double MeVPerGraph = 1.0/MeVgRelation
 
double neutronMassMeV = neutronMassG.value * MeVgRelation
 
double protonMassMeV = protonMassG.value * MeVgRelation
 
double electronMassMeV = electronMassG.value * MeVgRelation
 
double u_to_MeV = (amu.value * speedOfLight.value * speedOfLight.value)/MeV2Erg.value
 
+

Member Data Documentation

+ +

◆ amu

+ +
+
+ + + + +
fourdst::constant::Constant gridfire::rates::weak::WeakReaction::constants::amu = c.get("u")
+
+ +
+
+ +

◆ c

+ +
+
+ + + + +
const fourdst::constant::Constants& gridfire::rates::weak::WeakReaction::constants::c = fourdst::constant::Constants::getInstance()
+
+ +
+
+ +

◆ electronMassG

+ +
+
+ + + + +
fourdst::constant::Constant gridfire::rates::weak::WeakReaction::constants::electronMassG = c.get("mE")
+
+ +
+
+ +

◆ electronMassMeV

+ +
+
+ + + + +
double gridfire::rates::weak::WeakReaction::constants::electronMassMeV = electronMassG.value * MeVgRelation
+
+ +
+
+ +

◆ eVgRelation

+ +
+
+ + + + +
fourdst::constant::Constant gridfire::rates::weak::WeakReaction::constants::eVgRelation = c.get("eV_kg")
+
+ +
+
+ +

◆ MeV2Erg

+ +
+
+ + + + +
fourdst::constant::Constant gridfire::rates::weak::WeakReaction::constants::MeV2Erg = c.get("MeV_to_erg")
+
+ +
+
+ +

◆ MeVgRelation

+ +
+
+ + + + +
double gridfire::rates::weak::WeakReaction::constants::MeVgRelation = eVgRelation.value * 1.0e6
+
+ +
+
+ +

◆ MeVPerGraph

+ +
+
+ + + + +
double gridfire::rates::weak::WeakReaction::constants::MeVPerGraph = 1.0/MeVgRelation
+
+ +
+
+ +

◆ neutronMassG

+ +
+
+ + + + +
fourdst::constant::Constant gridfire::rates::weak::WeakReaction::constants::neutronMassG = c.get("mN")
+
+ +
+
+ +

◆ neutronMassMeV

+ +
+
+ + + + +
double gridfire::rates::weak::WeakReaction::constants::neutronMassMeV = neutronMassG.value * MeVgRelation
+
+ +
+
+ +

◆ protonMassG

+ +
+
+ + + + +
fourdst::constant::Constant gridfire::rates::weak::WeakReaction::constants::protonMassG = c.get("mP")
+
+ +
+
+ +

◆ protonMassMeV

+ +
+
+ + + + +
double gridfire::rates::weak::WeakReaction::constants::protonMassMeV = protonMassG.value * MeVgRelation
+
+ +
+
+ +

◆ speedOfLight

+ +
+
+ + + + +
fourdst::constant::Constant gridfire::rates::weak::WeakReaction::constants::speedOfLight = c.get("c")
+
+ +
+
+ +

◆ u_to_MeV

+ +
+
+ + + + +
double gridfire::rates::weak::WeakReaction::constants::u_to_MeV = (amu.value * speedOfLight.value * speedOfLight.value)/MeV2Erg.value
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.js b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.js new file mode 100644 index 00000000..1fb09890 --- /dev/null +++ b/docs/html/structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.js @@ -0,0 +1,17 @@ +var structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants = +[ + [ "amu", "structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.html#abe06f72b5b646cb3f1462b56d94a1de4", null ], + [ "c", "structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.html#ab176a60ea64181d84be3bb6496ad0b0e", null ], + [ "electronMassG", "structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.html#a8998f5acb979463eeabb14da50fb6856", null ], + [ "electronMassMeV", "structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.html#a24d6517e15c177fb8ca72f08f8eaf509", null ], + [ "eVgRelation", "structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.html#af834029caff08f9d5f7ff3a817ade469", null ], + [ "MeV2Erg", "structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.html#ae527298ffcdeb0b7b4089eeed4ddb58d", null ], + [ "MeVgRelation", "structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.html#ab60f42677de82f3aab77d2af846c2ffd", null ], + [ "MeVPerGraph", "structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.html#a57273916131b68d1aed6e16d85667427", null ], + [ "neutronMassG", "structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.html#a2d6c6d4eb9b54c050c266298611c1e44", null ], + [ "neutronMassMeV", "structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.html#a0629ea0e5d51166e400696a358b0045e", null ], + [ "protonMassG", "structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.html#abdb3124f6ef5ea294f402d30717fa208", null ], + [ "protonMassMeV", "structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.html#a8a780d3937e60794f007ec65fe866a56", null ], + [ "speedOfLight", "structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.html#a016c3e02f622e21073f9110707177b76", null ], + [ "u_to_MeV", "structgridfire_1_1rates_1_1weak_1_1WeakReaction_1_1constants.html#ab7d46e02bb7264ff3aada6b3997b2ab1", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1reaclib_1_1ReactionRecord-members.html b/docs/html/structgridfire_1_1reaclib_1_1ReactionRecord-members.html new file mode 100644 index 00000000..21050abf --- /dev/null +++ b/docs/html/structgridfire_1_1reaclib_1_1ReactionRecord-members.html @@ -0,0 +1,118 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::reaclib::ReactionRecord Member List
+
+
+ +

This is the complete list of members for gridfire::reaclib::ReactionRecord, including all inherited members.

+ + + + + + + + + +
chaptergridfire::reaclib::ReactionRecord
coeffsgridfire::reaclib::ReactionRecord
labelgridfire::reaclib::ReactionRecord
products_strgridfire::reaclib::ReactionRecord
qValuegridfire::reaclib::ReactionRecord
reactants_strgridfire::reaclib::ReactionRecord
reversegridfire::reaclib::ReactionRecord
rpNamegridfire::reaclib::ReactionRecord
+
+ + + + diff --git a/docs/html/structgridfire_1_1reaclib_1_1ReactionRecord.html b/docs/html/structgridfire_1_1reaclib_1_1ReactionRecord.html new file mode 100644 index 00000000..f0fc47c4 --- /dev/null +++ b/docs/html/structgridfire_1_1reaclib_1_1ReactionRecord.html @@ -0,0 +1,247 @@ + + + + + + + +GridFire: gridfire::reaclib::ReactionRecord Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::reaclib::ReactionRecord Struct Reference
+
+
+ + + + + + + + + + + + + + + + + + +

+Public Attributes

int32_t chapter
 
double qValue
 
double coeffs [7]
 
bool reverse
 
char label [8]
 
char rpName [64]
 
char reactants_str [128]
 
char products_str [128]
 
+

Member Data Documentation

+ +

◆ chapter

+ +
+
+ + + + +
int32_t gridfire::reaclib::ReactionRecord::chapter
+
+ +
+
+ +

◆ coeffs

+ +
+
+ + + + +
double gridfire::reaclib::ReactionRecord::coeffs[7]
+
+ +
+
+ +

◆ label

+ +
+
+ + + + +
char gridfire::reaclib::ReactionRecord::label[8]
+
+ +
+
+ +

◆ products_str

+ +
+
+ + + + +
char gridfire::reaclib::ReactionRecord::products_str[128]
+
+ +
+
+ +

◆ qValue

+ +
+
+ + + + +
double gridfire::reaclib::ReactionRecord::qValue
+
+ +
+
+ +

◆ reactants_str

+ +
+
+ + + + +
char gridfire::reaclib::ReactionRecord::reactants_str[128]
+
+ +
+
+ +

◆ reverse

+ +
+
+ + + + +
bool gridfire::reaclib::ReactionRecord::reverse
+
+ +
+
+ +

◆ rpName

+ +
+
+ + + + +
char gridfire::reaclib::ReactionRecord::rpName[64]
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1reaclib_1_1ReactionRecord.js b/docs/html/structgridfire_1_1reaclib_1_1ReactionRecord.js new file mode 100644 index 00000000..9e377884 --- /dev/null +++ b/docs/html/structgridfire_1_1reaclib_1_1ReactionRecord.js @@ -0,0 +1,11 @@ +var structgridfire_1_1reaclib_1_1ReactionRecord = +[ + [ "chapter", "structgridfire_1_1reaclib_1_1ReactionRecord.html#a5c853b69a23b0a8c39ab4b55ac3fe3cc", null ], + [ "coeffs", "structgridfire_1_1reaclib_1_1ReactionRecord.html#a80803f612e574859fde0a163bca84bc0", null ], + [ "label", "structgridfire_1_1reaclib_1_1ReactionRecord.html#a2165deb1c0a54a5086b496cf34604fa5", null ], + [ "products_str", "structgridfire_1_1reaclib_1_1ReactionRecord.html#af1b1d3b0308d965ef0697b247fcf9082", null ], + [ "qValue", "structgridfire_1_1reaclib_1_1ReactionRecord.html#aeeb8a1e078a27420e398663825cce644", null ], + [ "reactants_str", "structgridfire_1_1reaclib_1_1ReactionRecord.html#a67afc513db8dbcc43d79733e22ca8d39", null ], + [ "reverse", "structgridfire_1_1reaclib_1_1ReactionRecord.html#aa1fd4f510d7c00d2e4197e9b9caf29fd", null ], + [ "rpName", "structgridfire_1_1reaclib_1_1ReactionRecord.html#a523b7cfb0a6d8ddccd785aef2f425ad1", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1reaction_1_1RateCoefficientSet-members.html b/docs/html/structgridfire_1_1reaction_1_1RateCoefficientSet-members.html new file mode 100644 index 00000000..e2b857fe --- /dev/null +++ b/docs/html/structgridfire_1_1reaction_1_1RateCoefficientSet-members.html @@ -0,0 +1,118 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::reaction::RateCoefficientSet Member List
+
+
+ +

This is the complete list of members for gridfire::reaction::RateCoefficientSet, including all inherited members.

+ + + + + + + + + +
a0gridfire::reaction::RateCoefficientSet
a1gridfire::reaction::RateCoefficientSet
a2gridfire::reaction::RateCoefficientSet
a3gridfire::reaction::RateCoefficientSet
a4gridfire::reaction::RateCoefficientSet
a5gridfire::reaction::RateCoefficientSet
a6gridfire::reaction::RateCoefficientSet
operator<<gridfire::reaction::RateCoefficientSetfriend
+
+ + + + diff --git a/docs/html/structgridfire_1_1reaction_1_1RateCoefficientSet.html b/docs/html/structgridfire_1_1reaction_1_1RateCoefficientSet.html new file mode 100644 index 00000000..94b6605c --- /dev/null +++ b/docs/html/structgridfire_1_1reaction_1_1RateCoefficientSet.html @@ -0,0 +1,314 @@ + + + + + + + +GridFire: gridfire::reaction::RateCoefficientSet Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +Friends | +List of all members
+
gridfire::reaction::RateCoefficientSet Struct Reference
+
+
+ +

Holds the seven coefficients for the REACLIB rate equation. + More...

+ +

#include <reaction.h>

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

+Public Attributes

double a0
 Coefficient a0.
 
double a1
 Coefficient a1.
 
double a2
 Coefficient a2.
 
double a3
 Coefficient a3.
 
double a4
 Coefficient a4.
 
double a5
 Coefficient a5.
 
double a6
 Coefficient a6.
 
+ + + + +

+Friends

std::ostream & operator<< (std::ostream &os, const RateCoefficientSet &r)
 Overloads the stream insertion operator for easy printing.
 
+

Detailed Description

+

Holds the seven coefficients for the REACLIB rate equation.

+

This struct stores the parameters (a0-a6) used to calculate reaction rates as a function of temperature.

+

Friends And Related Symbol Documentation

+ +

◆ operator<<

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::ostream & operator<< (std::ostream & os,
const RateCoefficientSet & r 
)
+ 		+friend
+
+ +

Overloads the stream insertion operator for easy printing.

+
Parameters
+ + + +
osThe output stream.
rThe RateCoefficientSet to print.
+
+
+
Returns
The output stream.
+ +
+
+

Member Data Documentation

+ +

◆ a0

+ +
+
+ + + + +
double gridfire::reaction::RateCoefficientSet::a0
+
+ +

Coefficient a0.

+ +
+
+ +

◆ a1

+ +
+
+ + + + +
double gridfire::reaction::RateCoefficientSet::a1
+
+ +

Coefficient a1.

+ +
+
+ +

◆ a2

+ +
+
+ + + + +
double gridfire::reaction::RateCoefficientSet::a2
+
+ +

Coefficient a2.

+ +
+
+ +

◆ a3

+ +
+
+ + + + +
double gridfire::reaction::RateCoefficientSet::a3
+
+ +

Coefficient a3.

+ +
+
+ +

◆ a4

+ +
+
+ + + + +
double gridfire::reaction::RateCoefficientSet::a4
+
+ +

Coefficient a4.

+ +
+
+ +

◆ a5

+ +
+
+ + + + +
double gridfire::reaction::RateCoefficientSet::a5
+
+ +

Coefficient a5.

+ +
+
+ +

◆ a6

+ +
+
+ + + + +
double gridfire::reaction::RateCoefficientSet::a6
+
+ +

Coefficient a6.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1reaction_1_1RateCoefficientSet.js b/docs/html/structgridfire_1_1reaction_1_1RateCoefficientSet.js new file mode 100644 index 00000000..5fba58b1 --- /dev/null +++ b/docs/html/structgridfire_1_1reaction_1_1RateCoefficientSet.js @@ -0,0 +1,11 @@ +var structgridfire_1_1reaction_1_1RateCoefficientSet = +[ + [ "operator<<", "structgridfire_1_1reaction_1_1RateCoefficientSet.html#a31a92f95a27e4430209dfc2bdfa5c40f", null ], + [ "a0", "structgridfire_1_1reaction_1_1RateCoefficientSet.html#a2fa6b65e300dcd181222b743c2b3d6ed", null ], + [ "a1", "structgridfire_1_1reaction_1_1RateCoefficientSet.html#ace9dbd928e179784e47eaa108ce8d721", null ], + [ "a2", "structgridfire_1_1reaction_1_1RateCoefficientSet.html#a2a9316d19bc2e8bf0a7872eb6fe8a53f", null ], + [ "a3", "structgridfire_1_1reaction_1_1RateCoefficientSet.html#a3d047485ebb57d6c763adfe4aae493b1", null ], + [ "a4", "structgridfire_1_1reaction_1_1RateCoefficientSet.html#ae57b2eac71cb4ed9947f40c9cb8fc3ca", null ], + [ "a5", "structgridfire_1_1reaction_1_1RateCoefficientSet.html#a8c79db4e649b4eb1d29c43ebe4e95458", null ], + [ "a6", "structgridfire_1_1reaction_1_1RateCoefficientSet.html#adf8e6ed7f91cb9e15d1469a808b1877a", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData-members.html b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData-members.html new file mode 100644 index 00000000..50e8fa66 --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData-members.html @@ -0,0 +1,113 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::solver::CVODESolverStrategy::CVODERHSOutputData Member List
+
+
+ +

This is the complete list of members for gridfire::solver::CVODESolverStrategy::CVODERHSOutputData, including all inherited members.

+ + + + +
neutrino_energy_loss_rategridfire::solver::CVODESolverStrategy::CVODERHSOutputData
reaction_contribution_mapgridfire::solver::CVODESolverStrategy::CVODERHSOutputData
total_neutrino_fluxgridfire::solver::CVODESolverStrategy::CVODERHSOutputData
+
+ + + + diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData.html b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData.html new file mode 100644 index 00000000..f6c34b84 --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData.html @@ -0,0 +1,172 @@ + + + + + + + +GridFire: gridfire::solver::CVODESolverStrategy::CVODERHSOutputData Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::solver::CVODESolverStrategy::CVODERHSOutputData Struct Reference
+
+
+
+Collaboration diagram for gridfire::solver::CVODESolverStrategy::CVODERHSOutputData:
+
+
+
[legend]
+ + + + + + + + +

+Public Attributes

std::map< fourdst::atomic::Species, std::unordered_map< std::string, double > > reaction_contribution_map
 
double neutrino_energy_loss_rate
 
double total_neutrino_flux
 
+

Member Data Documentation

+ +

◆ neutrino_energy_loss_rate

+ +
+
+ + + + +
double gridfire::solver::CVODESolverStrategy::CVODERHSOutputData::neutrino_energy_loss_rate
+
+ +
+
+ +

◆ reaction_contribution_map

+ +
+
+ + + + +
std::map<fourdst::atomic::Species, std::unordered_map<std::string, double> > gridfire::solver::CVODESolverStrategy::CVODERHSOutputData::reaction_contribution_map
+
+ +
+
+ +

◆ total_neutrino_flux

+ +
+
+ + + + +
double gridfire::solver::CVODESolverStrategy::CVODERHSOutputData::total_neutrino_flux
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData.js b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData.js new file mode 100644 index 00000000..83c02750 --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData.js @@ -0,0 +1,6 @@ +var structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData = +[ + [ "neutrino_energy_loss_rate", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData.html#a449c2a51ffbe6a14f1916afd8a2a20fb", null ], + [ "reaction_contribution_map", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData.html#a4b4f0c0733813d6931eeb3b3c942ada9", null ], + [ "total_neutrino_flux", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData.html#ab36ca1b318b47e72c05f1e162f005e1b", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData__coll__graph.map b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData__coll__graph.map new file mode 100644 index 00000000..78d779f6 --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData__coll__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData__coll__graph.md5 b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData__coll__graph.md5 new file mode 100644 index 00000000..0e07c426 --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData__coll__graph.md5 @@ -0,0 +1 @@ +373995ac0dc464f4b6215ef78cb2e732 \ No newline at end of file diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData__coll__graph.svg b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData__coll__graph.svg new file mode 100644 index 00000000..82afccfe --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData__coll__graph.svg @@ -0,0 +1,146 @@ + + + + + + + + + + + +gridfire::solver::CVODESolverStrategy::CVODERHSOutputData + + +Node1 + + +gridfire::solver::CVODESolver +Strategy::CVODERHSOutputData + + + + + +Node2 + + +std::map< fourdst:: +atomic::Species, std +::unordered_map< std +::string, double > > + + + + + +Node2->Node1 + + + + + + reaction_contribution_map + + + +Node3 + + +Species + + + + + +Node3->Node2 + + + + + + keys + + + +Node4 + + +std::unordered_map +< std::string, double > + + + + + +Node4->Node2 + + + + + + elements + + + +Node5 + + +std::string + + + + + +Node5->Node4 + + + + + + keys + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + + + + + + diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData__coll__graph_org.svg b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData__coll__graph_org.svg new file mode 100644 index 00000000..20b63393 --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODERHSOutputData__coll__graph_org.svg @@ -0,0 +1,121 @@ + + + + + + +gridfire::solver::CVODESolverStrategy::CVODERHSOutputData + + +Node1 + + +gridfire::solver::CVODESolver +Strategy::CVODERHSOutputData + + + + + +Node2 + + +std::map< fourdst:: +atomic::Species, std +::unordered_map< std +::string, double > > + + + + + +Node2->Node1 + + + + + + reaction_contribution_map + + + +Node3 + + +Species + + + + + +Node3->Node2 + + + + + + keys + + + +Node4 + + +std::unordered_map +< std::string, double > + + + + + +Node4->Node2 + + + + + + elements + + + +Node5 + + +std::string + + + + + +Node5->Node4 + + + + + + keys + + + +Node6 + + +std::basic_string< + Char > + + + + + +Node6->Node5 + + + + + + + + diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData-members.html b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData-members.html new file mode 100644 index 00000000..0193a8d6 --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData-members.html @@ -0,0 +1,120 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::solver::CVODESolverStrategy::CVODEUserData Member List
+
+
+ +

This is the complete list of members for gridfire::solver::CVODESolverStrategy::CVODEUserData, including all inherited members.

+ + + + + + + + + + + +
captured_exceptiongridfire::solver::CVODESolverStrategy::CVODEUserData
energygridfire::solver::CVODESolverStrategy::CVODEUserData
enginegridfire::solver::CVODESolverStrategy::CVODEUserData
networkSpeciesgridfire::solver::CVODESolverStrategy::CVODEUserData
neutrino_energy_loss_rategridfire::solver::CVODESolverStrategy::CVODEUserData
reaction_contribution_mapgridfire::solver::CVODESolverStrategy::CVODEUserData
rhogridfire::solver::CVODESolverStrategy::CVODEUserData
solver_instancegridfire::solver::CVODESolverStrategy::CVODEUserData
T9gridfire::solver::CVODESolverStrategy::CVODEUserData
total_neutrino_fluxgridfire::solver::CVODESolverStrategy::CVODEUserData
+
+ + + + diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html new file mode 100644 index 00000000..71f6301b --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html @@ -0,0 +1,290 @@ + + + + + + + +GridFire: gridfire::solver::CVODESolverStrategy::CVODEUserData Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::solver::CVODESolverStrategy::CVODEUserData Struct Reference
+
+
+ +

A helper struct to pass C++ context to C-style CVODE callbacks. + More...

+
+Collaboration diagram for gridfire::solver::CVODESolverStrategy::CVODEUserData:
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

CVODESolverStrategy * solver_instance {}
 
engine::DynamicEngine * engine {}
 
double T9 {}
 
double rho {}
 
double energy {}
 
const std::vector< fourdst::atomic::Species > * networkSpecies {}
 
std::unique_ptr< exceptions::EngineError > captured_exception = nullptr
 
std::optional< std::map< fourdst::atomic::Species, std::unordered_map< std::string, double > > > reaction_contribution_map
 
double neutrino_energy_loss_rate = 0.0
 
double total_neutrino_flux = 0.0
 
+

Detailed Description

+

A helper struct to pass C++ context to C-style CVODE callbacks.

+

Carries pointers back to the solver instance and engine, the current thermodynamic state, energy accumulator, and a slot to capture a copy of exceptions::StaleEngineTrigger from RHS evaluation. The RHS wrapper treats this as a recoverable failure and returns 1 to CVODE, then the driver loop inspects and rethrows.

+

Member Data Documentation

+ +

◆ captured_exception

+ +
+
+ + + + +
std::unique_ptr<exceptions::EngineError> gridfire::solver::CVODESolverStrategy::CVODEUserData::captured_exception = nullptr
+
+ +
+
+ +

◆ energy

+ +
+
+ + + + +
double gridfire::solver::CVODESolverStrategy::CVODEUserData::energy {}
+
+ +
+
+ +

◆ engine

+ +
+
+ + + + +
engine::DynamicEngine* gridfire::solver::CVODESolverStrategy::CVODEUserData::engine {}
+
+ +
+
+ +

◆ networkSpecies

+ +
+
+ + + + +
const std::vector<fourdst::atomic::Species>* gridfire::solver::CVODESolverStrategy::CVODEUserData::networkSpecies {}
+
+ +
+
+ +

◆ neutrino_energy_loss_rate

+ +
+
+ + + + +
double gridfire::solver::CVODESolverStrategy::CVODEUserData::neutrino_energy_loss_rate = 0.0
+
+ +
+
+ +

◆ reaction_contribution_map

+ +
+
+ + + + +
std::optional<std::map<fourdst::atomic::Species, std::unordered_map<std::string, double> > > gridfire::solver::CVODESolverStrategy::CVODEUserData::reaction_contribution_map
+
+ +
+
+ +

◆ rho

+ +
+
+ + + + +
double gridfire::solver::CVODESolverStrategy::CVODEUserData::rho {}
+
+ +
+
+ +

◆ solver_instance

+ +
+
+ + + + +
CVODESolverStrategy* gridfire::solver::CVODESolverStrategy::CVODEUserData::solver_instance {}
+
+ +
+
+ +

◆ T9

+ +
+
+ + + + +
double gridfire::solver::CVODESolverStrategy::CVODEUserData::T9 {}
+
+ +
+
+ +

◆ total_neutrino_flux

+ +
+
+ + + + +
double gridfire::solver::CVODESolverStrategy::CVODEUserData::total_neutrino_flux = 0.0
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.js b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.js new file mode 100644 index 00000000..47a0655e --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.js @@ -0,0 +1,13 @@ +var structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData = +[ + [ "captured_exception", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#a574e03aef08e1d3c9f4914bda1ad78c6", null ], + [ "energy", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#a1fb4ca773aaad8d1d958a3a0e82d8edd", null ], + [ "engine", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#a657f34d754521a6991351e29e0942ed6", null ], + [ "networkSpecies", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#a41a5bc46358cb59373f62c791e1bc29c", null ], + [ "neutrino_energy_loss_rate", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#a309e36605c79136e96f91f89dcde06d6", null ], + [ "reaction_contribution_map", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#a7c0adecacbb007c513d1b6c82e30d165", null ], + [ "rho", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#afdc510f8160693806737c4ab517058b8", null ], + [ "solver_instance", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#ad7f3eb9caae25ef25357c41c23d6b392", null ], + [ "T9", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#a0b27605ac3211a1805d7910c899bbcce", null ], + [ "total_neutrino_flux", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#a7a495c5df9e1da7f2e7182511f6a95c8", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData__coll__graph.map b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData__coll__graph.map new file mode 100644 index 00000000..af7c9802 --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData__coll__graph.map @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData__coll__graph.md5 b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData__coll__graph.md5 new file mode 100644 index 00000000..6e4e2af4 --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData__coll__graph.md5 @@ -0,0 +1 @@ +2b79782a9ca154afdfd947e79bba5e0b \ No newline at end of file diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData__coll__graph.svg b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData__coll__graph.svg new file mode 100644 index 00000000..e0bdd0d9 --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData__coll__graph.svg @@ -0,0 +1,334 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::solver::CVODESolverStrategy::CVODEUserData + + +Node1 + + +gridfire::solver::CVODESolver +Strategy::CVODEUserData + + + + + +Node2 + + +gridfire::solver::CVODESolver +Strategy + + + + + +Node2->Node1 + + + + + + solver_instance + + + +Node3 + + +DynamicNetworkSolverStrategy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::engine::Dynamic +Engine + + + + + +Node4->Node1 + + + + + + engine + + + +Node5 + + +gridfire::engine::Engine + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node6->Node1 + + + + + + networkSpecies + + + +Node7 + + +Species + + + + + +Node7->Node6 + + + + + + elements + + + +Node8 + + +std::unique_ptr< gridfire +::exceptions::EngineError > + + + + + +Node8->Node1 + + + + + + captured_exception + + + +Node9 + + +gridfire::exceptions +::EngineError + + + + + +Node9->Node8 + + + + + + ptr + + + +Node10 + + +gridfire::exceptions +::GridFireError + + + + + +Node10->Node9 + + + + + + + + +Node11 + + +std::exception + + + + + +Node11->Node10 + + + + + + + + +Node12 + + +std::string + + + + + +Node12->Node10 + + + + + + m_msg + + + +Node13 + + +std::basic_string< + Char > + + + + + +Node13->Node12 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData__coll__graph_org.svg b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData__coll__graph_org.svg new file mode 100644 index 00000000..0371502a --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData__coll__graph_org.svg @@ -0,0 +1,252 @@ + + + + + + +gridfire::solver::CVODESolverStrategy::CVODEUserData + + +Node1 + + +gridfire::solver::CVODESolver +Strategy::CVODEUserData + + + + + +Node2 + + +gridfire::solver::CVODESolver +Strategy + + + + + +Node2->Node1 + + + + + + solver_instance + + + +Node3 + + +DynamicNetworkSolverStrategy + + + + + +Node3->Node2 + + + + + + + + +Node4 + + +gridfire::engine::Dynamic +Engine + + + + + +Node4->Node1 + + + + + + engine + + + +Node5 + + +gridfire::engine::Engine + + + + + +Node5->Node4 + + + + + + + + +Node6 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node6->Node1 + + + + + + networkSpecies + + + +Node7 + + +Species + + + + + +Node7->Node6 + + + + + + elements + + + +Node8 + + +std::unique_ptr< gridfire +::exceptions::EngineError > + + + + + +Node8->Node1 + + + + + + captured_exception + + + +Node9 + + +gridfire::exceptions +::EngineError + + + + + +Node9->Node8 + + + + + + ptr + + + +Node10 + + +gridfire::exceptions +::GridFireError + + + + + +Node10->Node9 + + + + + + + + +Node11 + + +std::exception + + + + + +Node11->Node10 + + + + + + + + +Node12 + + +std::string + + + + + +Node12->Node10 + + + + + + m_msg + + + +Node13 + + +std::basic_string< + Char > + + + + + +Node13->Node12 + + + + + + + + diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext-members.html b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext-members.html new file mode 100644 index 00000000..19f79fdf --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext-members.html @@ -0,0 +1,125 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::solver::CVODESolverStrategy::TimestepContext Member List
+
+
+ +

This is the complete list of members for gridfire::solver::CVODESolverStrategy::TimestepContext, including all inherited members.

+ + + + + + + + + + + + + + + + +
currentConvergenceFailuresgridfire::solver::CVODESolverStrategy::TimestepContext
currentNonlinearIterationsgridfire::solver::CVODESolverStrategy::TimestepContext
describe() const overridegridfire::solver::CVODESolverStrategy::TimestepContextvirtual
dtgridfire::solver::CVODESolverStrategy::TimestepContext
enginegridfire::solver::CVODESolverStrategy::TimestepContext
last_step_timegridfire::solver::CVODESolverStrategy::TimestepContext
networkSpeciesgridfire::solver::CVODESolverStrategy::TimestepContext
num_stepsgridfire::solver::CVODESolverStrategy::TimestepContext
reactionContributionMapgridfire::solver::CVODESolverStrategy::TimestepContext
rhogridfire::solver::CVODESolverStrategy::TimestepContext
stategridfire::solver::CVODESolverStrategy::TimestepContext
tgridfire::solver::CVODESolverStrategy::TimestepContext
T9gridfire::solver::CVODESolverStrategy::TimestepContext
TimestepContext(double t, const N_Vector &state, double dt, double last_step_time, double t9, double rho, size_t num_steps, const engine::DynamicEngine &engine, const std::vector< fourdst::atomic::Species > &networkSpecies, size_t currentConvergenceFailure, size_t currentNonlinearIterations, const std::map< fourdst::atomic::Species, std::unordered_map< std::string, double > > &reactionContributionMap)gridfire::solver::CVODESolverStrategy::TimestepContext
~SolverContextBase()=defaultgridfire::solver::SolverContextBasevirtual
+
+ + + + diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html new file mode 100644 index 00000000..f2b91ac5 --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html @@ -0,0 +1,500 @@ + + + + + + + +GridFire: gridfire::solver::CVODESolverStrategy::TimestepContext Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Public Attributes | +List of all members
+
gridfire::solver::CVODESolverStrategy::TimestepContext Struct Referencefinal
+
+
+ +

Immutable view of the current integration state passed to callbacks. + More...

+ +

#include <CVODE_solver_strategy.h>

+
+Inheritance diagram for gridfire::solver::CVODESolverStrategy::TimestepContext:
+
+
+
[legend]
+
+Collaboration diagram for gridfire::solver::CVODESolverStrategy::TimestepContext:
+
+
+
[legend]
+ + + + + + + + + + + +

+Public Member Functions

 TimestepContext (double t, const N_Vector &state, double dt, double last_step_time, double t9, double rho, size_t num_steps, const engine::DynamicEngine &engine, const std::vector< fourdst::atomic::Species > &networkSpecies, size_t currentConvergenceFailure, size_t currentNonlinearIterations, const std::map< fourdst::atomic::Species, std::unordered_map< std::string, double > > &reactionContributionMap)
 Construct a context snapshot.
 
std::vector< std::tuple< std::string, std::string > > describe () const override
 Human-readable description of the context fields.
 
- Public Member Functions inherited from gridfire::solver::SolverContextBase
virtual ~SolverContextBase ()=default
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

const double t
 Current integration time [s].
 
const N_Vector & state
 Current CVODE state vector (N_Vector).
 
const double dt
 Last step size [s].
 
const double last_step_time
 Time at last callback [s].
 
const double T9
 Temperature in GK.
 
const double rho
 Density [g cm^-3].
 
const size_t num_steps
 Number of CVODE steps taken so far.
 
const engine::DynamicEngine & engine
 Reference to the engine.
 
const std::vector< fourdst::atomic::Species > & networkSpecies
 Species layout.
 
const size_t currentConvergenceFailures
 Total number of convergence failures.
 
const size_t currentNonlinearIterations
 Total number of non-linear iterations.
 
const std::map< fourdst::atomic::Species, std::unordered_map< std::string, double > > & reactionContributionMap
 Map of reaction contributions for the current step.
 
+

Detailed Description

+

Immutable view of the current integration state passed to callbacks.

+

Fields capture CVODE time/state, step size, thermodynamic state, the engine reference, and the list of network species used to interpret the state vector layout.

+

Constructor & Destructor Documentation

+ +

◆ TimestepContext()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
gridfire::solver::CVODESolverStrategy::TimestepContext::TimestepContext (double t,
const N_Vector & state,
double dt,
double last_step_time,
double t9,
double rho,
size_t num_steps,
const engine::DynamicEngine & engine,
const std::vector< fourdst::atomic::Species > & networkSpecies,
size_t currentConvergenceFailure,
size_t currentNonlinearIterations,
const std::map< fourdst::atomic::Species, std::unordered_map< std::string, double > > & reactionContributionMap 
)
+
+ +

Construct a context snapshot.

+ +
+
+

Member Function Documentation

+ +

◆ describe()

+ +
+
+ + + + + +
+ + + + + + + +
std::vector< std::tuple< std::string, std::string > > gridfire::solver::CVODESolverStrategy::TimestepContext::describe () const
+ 		+overridevirtual
+
+ +

Human-readable description of the context fields.

+ +

Implements gridfire::solver::SolverContextBase.

+ +
+
+

Member Data Documentation

+ +

◆ currentConvergenceFailures

+ +
+
+ + + + +
const size_t gridfire::solver::CVODESolverStrategy::TimestepContext::currentConvergenceFailures
+
+ +

Total number of convergence failures.

+ +
+
+ +

◆ currentNonlinearIterations

+ +
+
+ + + + +
const size_t gridfire::solver::CVODESolverStrategy::TimestepContext::currentNonlinearIterations
+
+ +

Total number of non-linear iterations.

+ +
+
+ +

◆ dt

+ +
+
+ + + + +
const double gridfire::solver::CVODESolverStrategy::TimestepContext::dt
+
+ +

Last step size [s].

+ +
+
+ +

◆ engine

+ +
+
+ + + + +
const engine::DynamicEngine& gridfire::solver::CVODESolverStrategy::TimestepContext::engine
+
+ +

Reference to the engine.

+ +
+
+ +

◆ last_step_time

+ +
+
+ + + + +
const double gridfire::solver::CVODESolverStrategy::TimestepContext::last_step_time
+
+ +

Time at last callback [s].

+ +
+
+ +

◆ networkSpecies

+ +
+
+ + + + +
const std::vector<fourdst::atomic::Species>& gridfire::solver::CVODESolverStrategy::TimestepContext::networkSpecies
+
+ +

Species layout.

+ +
+
+ +

◆ num_steps

+ +
+
+ + + + +
const size_t gridfire::solver::CVODESolverStrategy::TimestepContext::num_steps
+
+ +

Number of CVODE steps taken so far.

+ +
+
+ +

◆ reactionContributionMap

+ +
+
+ + + + +
const std::map<fourdst::atomic::Species, std::unordered_map<std::string, double> >& gridfire::solver::CVODESolverStrategy::TimestepContext::reactionContributionMap
+
+ +

Map of reaction contributions for the current step.

+ +
+
+ +

◆ rho

+ +
+
+ + + + +
const double gridfire::solver::CVODESolverStrategy::TimestepContext::rho
+
+ +

Density [g cm^-3].

+ +
+
+ +

◆ state

+ +
+
+ + + + +
const N_Vector& gridfire::solver::CVODESolverStrategy::TimestepContext::state
+
+ +

Current CVODE state vector (N_Vector).

+ +
+
+ +

◆ t

+ +
+
+ + + + +
const double gridfire::solver::CVODESolverStrategy::TimestepContext::t
+
+ +

Current integration time [s].

+ +
+
+ +

◆ T9

+ +
+
+ + + + +
const double gridfire::solver::CVODESolverStrategy::TimestepContext::T9
+
+ +

Temperature in GK.

+ +
+
+
The documentation for this struct was generated from the following files: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.js b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.js new file mode 100644 index 00000000..a82ea69c --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.js @@ -0,0 +1,17 @@ +var structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext = +[ + [ "TimestepContext", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a04c4ce00c6a0a62ba6d1e6fb1a0a53be", null ], + [ "describe", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#ae3c6320ce7a8f41c9ae36c42d62b4204", null ], + [ "currentConvergenceFailures", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#adef40af49e162d2429db1030f6341d96", null ], + [ "currentNonlinearIterations", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#aefa6b183bf963f6e01c5157b7c0f158a", null ], + [ "dt", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a6442d15673e6385bb6fdd11e1179c487", null ], + [ "engine", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a5a457651dcb9d4a66ed219ddf7095313", null ], + [ "last_step_time", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a4a92187c15b7bcb90adebecc87e1436a", null ], + [ "networkSpecies", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a75d7e32c9df3d8a047069fe2d64cd089", null ], + [ "num_steps", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a51e86d2721053055d8479662b864e367", null ], + [ "reactionContributionMap", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#aaad8a2e08769b629086133d3b079e3b1", null ], + [ "rho", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a4a25afbc9f8a907304992e144dfa3529", null ], + [ "state", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#aaae3c42b9172be4d501f022e67f5a6f6", null ], + [ "t", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a0b39f0d207181840efacb64417b492ae", null ], + [ "T9", "structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a25743a21ed801ed4288309f35dc9a289", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__coll__graph.map b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__coll__graph.map new file mode 100644 index 00000000..cd62bba1 --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__coll__graph.map @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__coll__graph.md5 b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__coll__graph.md5 new file mode 100644 index 00000000..d7f3f45d --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__coll__graph.md5 @@ -0,0 +1 @@ +03168537777c2576badbf1253be07c5e \ No newline at end of file diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__coll__graph.svg b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__coll__graph.svg new file mode 100644 index 00000000..62727aac --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__coll__graph.svg @@ -0,0 +1,290 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +gridfire::solver::CVODESolverStrategy::TimestepContext + + +Node1 + + +gridfire::solver::CVODESolver +Strategy::TimestepContext + + + + + +Node2 + + +gridfire::solver::Solver +ContextBase + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Dynamic +Engine + + + + + +Node3->Node1 + + + + + + engine + + + +Node4 + + +gridfire::engine::Engine + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node5->Node1 + + + + + + networkSpecies + + + +Node6 + + +Species + + + + + +Node6->Node5 + + + + + + elements + + + +Node7 + + +std::map< fourdst:: +atomic::Species, std +::unordered_map< std +::string, double > > + + + + + +Node6->Node7 + + + + + + keys + + + +Node7->Node1 + + + + + + reactionContributionMap + + + +Node8 + + +std::unordered_map +< std::string, double > + + + + + +Node8->Node7 + + + + + + elements + + + +Node9 + + +std::string + + + + + +Node9->Node8 + + + + + + keys + + + +Node10 + + +std::basic_string< + Char > + + + + + +Node10->Node9 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__coll__graph_org.svg b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__coll__graph_org.svg new file mode 100644 index 00000000..445678c2 --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__coll__graph_org.svg @@ -0,0 +1,208 @@ + + + + + + +gridfire::solver::CVODESolverStrategy::TimestepContext + + +Node1 + + +gridfire::solver::CVODESolver +Strategy::TimestepContext + + + + + +Node2 + + +gridfire::solver::Solver +ContextBase + + + + + +Node2->Node1 + + + + + + + + +Node3 + + +gridfire::engine::Dynamic +Engine + + + + + +Node3->Node1 + + + + + + engine + + + +Node4 + + +gridfire::engine::Engine + + + + + +Node4->Node3 + + + + + + + + +Node5 + + +std::vector< fourdst +::atomic::Species > + + + + + +Node5->Node1 + + + + + + networkSpecies + + + +Node6 + + +Species + + + + + +Node6->Node5 + + + + + + elements + + + +Node7 + + +std::map< fourdst:: +atomic::Species, std +::unordered_map< std +::string, double > > + + + + + +Node6->Node7 + + + + + + keys + + + +Node7->Node1 + + + + + + reactionContributionMap + + + +Node8 + + +std::unordered_map +< std::string, double > + + + + + +Node8->Node7 + + + + + + elements + + + +Node9 + + +std::string + + + + + +Node9->Node8 + + + + + + keys + + + +Node10 + + +std::basic_string< + Char > + + + + + +Node10->Node9 + + + + + + + + diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__inherit__graph.map b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__inherit__graph.map new file mode 100644 index 00000000..5dd28d92 --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__inherit__graph.md5 b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__inherit__graph.md5 new file mode 100644 index 00000000..ade12684 --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__inherit__graph.md5 @@ -0,0 +1 @@ +156c33a19a85fa73834aa9bd2b8a9238 \ No newline at end of file diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__inherit__graph.svg b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__inherit__graph.svg new file mode 100644 index 00000000..be4b8cd1 --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__inherit__graph.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + +gridfire::solver::CVODESolverStrategy::TimestepContext + + +Node1 + + +gridfire::solver::CVODESolver +Strategy::TimestepContext + + + + + +Node2 + + +gridfire::solver::Solver +ContextBase + + + + + +Node2->Node1 + + + + + + + + + + + + + diff --git a/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__inherit__graph_org.svg b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__inherit__graph_org.svg new file mode 100644 index 00000000..0ebbecb3 --- /dev/null +++ b/docs/html/structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__inherit__graph_org.svg @@ -0,0 +1,41 @@ + + + + + + +gridfire::solver::CVODESolverStrategy::TimestepContext + + +Node1 + + +gridfire::solver::CVODESolver +Strategy::TimestepContext + + + + + +Node2 + + +gridfire::solver::Solver +ContextBase + + + + + +Node2->Node1 + + + + + + + + diff --git a/docs/html/structgridfire_1_1trigger_1_1TriggerResult-members.html b/docs/html/structgridfire_1_1trigger_1_1TriggerResult-members.html new file mode 100644 index 00000000..54c80bf1 --- /dev/null +++ b/docs/html/structgridfire_1_1trigger_1_1TriggerResult-members.html @@ -0,0 +1,114 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::trigger::TriggerResult Member List
+
+
+ +

This is the complete list of members for gridfire::trigger::TriggerResult, including all inherited members.

+ + + + + +
causesgridfire::trigger::TriggerResult
descriptiongridfire::trigger::TriggerResult
namegridfire::trigger::TriggerResult
valuegridfire::trigger::TriggerResult
+
+ + + + diff --git a/docs/html/structgridfire_1_1trigger_1_1TriggerResult.html b/docs/html/structgridfire_1_1trigger_1_1TriggerResult.html new file mode 100644 index 00000000..1ef572d4 --- /dev/null +++ b/docs/html/structgridfire_1_1trigger_1_1TriggerResult.html @@ -0,0 +1,202 @@ + + + + + + + +GridFire: gridfire::trigger::TriggerResult Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::trigger::TriggerResult Struct Reference
+
+
+ +

#include <trigger_result.h>

+
+Collaboration diagram for gridfire::trigger::TriggerResult:
+
+
+
[legend]
+ + + + + + + + + + + + + + +

+Public Attributes

std::string name
 Short identifier for the condition (e.g., "Temperature Rise").
 
std::string description
 Human-readable reason summarizing the outcome at this node.
 
bool value
 Evaluation result for this node (true/false).
 
std::vector< TriggerResult > causes
 Sub-reasons for composite triggers.
 
+

Member Data Documentation

+ +

◆ causes

+ +
+
+ + + + +
std::vector<TriggerResult> gridfire::trigger::TriggerResult::causes
+
+ +

Sub-reasons for composite triggers.

+ +
+
+ +

◆ description

+ +
+
+ + + + +
std::string gridfire::trigger::TriggerResult::description
+
+ +

Human-readable reason summarizing the outcome at this node.

+ +
+
+ +

◆ name

+ +
+
+ + + + +
std::string gridfire::trigger::TriggerResult::name
+
+ +

Short identifier for the condition (e.g., "Temperature Rise").

+ +
+
+ +

◆ value

+ +
+
+ + + + +
bool gridfire::trigger::TriggerResult::value
+
+ +

Evaluation result for this node (true/false).

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1trigger_1_1TriggerResult.js b/docs/html/structgridfire_1_1trigger_1_1TriggerResult.js new file mode 100644 index 00000000..1a1890c2 --- /dev/null +++ b/docs/html/structgridfire_1_1trigger_1_1TriggerResult.js @@ -0,0 +1,7 @@ +var structgridfire_1_1trigger_1_1TriggerResult = +[ + [ "causes", "structgridfire_1_1trigger_1_1TriggerResult.html#a7cf4d21d3cd3e53b62736932b44072cd", null ], + [ "description", "structgridfire_1_1trigger_1_1TriggerResult.html#aaf99ffdeb73f5e792e61c4cca68aa157", null ], + [ "name", "structgridfire_1_1trigger_1_1TriggerResult.html#a1f27dd6d5cca43956812ec78cfb7be2d", null ], + [ "value", "structgridfire_1_1trigger_1_1TriggerResult.html#a372af12d705b623075c41872f3ec96e1", null ] +]; \ No newline at end of file diff --git a/docs/html/structgridfire_1_1trigger_1_1TriggerResult__coll__graph.map b/docs/html/structgridfire_1_1trigger_1_1TriggerResult__coll__graph.map new file mode 100644 index 00000000..b5a14986 --- /dev/null +++ b/docs/html/structgridfire_1_1trigger_1_1TriggerResult__coll__graph.map @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/docs/html/structgridfire_1_1trigger_1_1TriggerResult__coll__graph.md5 b/docs/html/structgridfire_1_1trigger_1_1TriggerResult__coll__graph.md5 new file mode 100644 index 00000000..86d2ab14 --- /dev/null +++ b/docs/html/structgridfire_1_1trigger_1_1TriggerResult__coll__graph.md5 @@ -0,0 +1 @@ +58c593b3fbdcc09d3c8a966d213749b5 \ No newline at end of file diff --git a/docs/html/structgridfire_1_1trigger_1_1TriggerResult__coll__graph.svg b/docs/html/structgridfire_1_1trigger_1_1TriggerResult__coll__graph.svg new file mode 100644 index 00000000..63607b52 --- /dev/null +++ b/docs/html/structgridfire_1_1trigger_1_1TriggerResult__coll__graph.svg @@ -0,0 +1,116 @@ + + + + + + + + + + + +gridfire::trigger::TriggerResult + + +Node1 + + +gridfire::trigger:: +TriggerResult + + + + + +Node4 + + +std::vector< gridfire +::trigger::TriggerResult > + + + + + +Node1->Node4 + + + + + + elements + + + +Node2 + + +std::string + + + + + +Node2->Node1 + + + + + + description +name + + + +Node3 + + +std::basic_string< + Char > + + + + + +Node3->Node2 + + + + + + + + +Node4->Node1 + + + + + + causes + + + + + + + + diff --git a/docs/html/structgridfire_1_1trigger_1_1TriggerResult__coll__graph_org.svg b/docs/html/structgridfire_1_1trigger_1_1TriggerResult__coll__graph_org.svg new file mode 100644 index 00000000..e22ba99b --- /dev/null +++ b/docs/html/structgridfire_1_1trigger_1_1TriggerResult__coll__graph_org.svg @@ -0,0 +1,91 @@ + + + + + + +gridfire::trigger::TriggerResult + + +Node1 + + +gridfire::trigger:: +TriggerResult + + + + + +Node4 + + +std::vector< gridfire +::trigger::TriggerResult > + + + + + +Node1->Node4 + + + + + + elements + + + +Node2 + + +std::string + + + + + +Node2->Node1 + + + + + + description +name + + + +Node3 + + +std::basic_string< + Char > + + + + + +Node3->Node2 + + + + + + + + +Node4->Node1 + + + + + + causes + + + diff --git a/docs/html/structgridfire__mod_1_1gridfire-members.html b/docs/html/structgridfire__mod_1_1gridfire-members.html index 2d9d2caf..f001b3c8 100644 --- a/docs/html/structgridfire__mod_1_1gridfire-members.html +++ b/docs/html/structgridfire__mod_1_1gridfire-members.html @@ -3,18 +3,16 @@ - + GridFire: Member List - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -119,7 +112,7 @@ $(function(){initNavTree('structgridfire__mod_1_1gridfire.html',''); initResizab diff --git a/docs/html/structgridfire__mod_1_1gridfire.html b/docs/html/structgridfire__mod_1_1gridfire.html index 82f7a4db..d1271ba4 100644 --- a/docs/html/structgridfire__mod_1_1gridfire.html +++ b/docs/html/structgridfire__mod_1_1gridfire.html @@ -3,18 +3,16 @@ - + GridFire: gridfire_mod::gridfire Type Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -106,29 +99,34 @@ $(function(){initNavTree('structgridfire__mod_1_1gridfire.html',''); initResizab
gridfire_mod::gridfire Type Reference
+
+Collaboration diagram for gridfire_mod::gridfire:
+
+
+
[legend]
- + - + - + - + - + - + - +

Public Member Functions

procedure gff_init (self)
procedure gff_init (self)
 
procedure gff_free (self)
procedure gff_free (self)
 
procedure register_species (self, species_list)
procedure register_species (self, species_list)
 
procedure setup_policy (self, policy_name, abundances)
procedure setup_policy (self, policy_name, abundances)
 
procedure setup_solver (self, solver_name)
procedure setup_solver (self, solver_name)
 
procedure evolve (self, y_in, t, rho, dt, y_out, energy, dedt, dedrho, nu_e_loss, nu_flux, mass_lost, ierr)
procedure evolve (self, y_in, t, rho, dt, y_out, energy, dedt, dedrho, nu_e_loss, nu_flux, mass_lost, ierr)
 
procedure get_last_error (self)
procedure get_last_error (self)
 
- + - +

Public Attributes

type(c_ptr) ctx = c_null_ptr
type(c_ptr) ctx = c_null_ptr
 
integer(c_size_t) num_species = 0
integer(c_size_t) num_species = 0
 

Member Function/Subroutine Documentation

@@ -141,67 +139,85 @@ Public Attributes procedure gridfire_mod::gridfire::evolve ( - class(gridfire), intent(in) self, + class(gridfire), intent(in)  + self, - real(c_double), dimension(:), intent(in) y_in, + real(c_double), dimension(:), intent(in)  + y_in, - real(c_double), value t, + real(c_double), value  + t, - real(c_double), value rho, + real(c_double), value  + rho, - real(c_double), value dt, + real(c_double), value  + dt, - real(c_double), dimension(:), intent(out) y_out, + real(c_double), dimension(:), intent(out)  + y_out, - real(c_double), intent(out) energy, + real(c_double), intent(out)  + energy, - real(c_double), intent(out) dedt, + real(c_double), intent(out)  + dedt, - real(c_double), intent(out) dedrho, + real(c_double), intent(out)  + dedrho, - real(c_double), intent(out) nu_e_loss, + real(c_double), intent(out)  + nu_e_loss, - real(c_double), intent(out) nu_flux, + real(c_double), intent(out)  + nu_flux, - real(c_double), intent(out) mass_lost, + real(c_double), intent(out)  + mass_lost, - integer, intent(out) ierr ) + integer, intent(out)  + ierr  + + + + ) +
@@ -217,7 +233,8 @@ Public Attributes procedure gridfire_mod::gridfire::get_last_error ( - class(gridfire), intent(in) self) + class(gridfire), intent(in)  + self) @@ -234,7 +251,8 @@ Public Attributes procedure gridfire_mod::gridfire::gff_free ( - class(gridfire), intent(inout) self) + class(gridfire), intent(inout)  + self) @@ -251,7 +269,8 @@ Public Attributes procedure gridfire_mod::gridfire::gff_init ( - class(gridfire), intent(out) self) + class(gridfire), intent(out)  + self) @@ -268,12 +287,19 @@ Public Attributes procedure gridfire_mod::gridfire::register_species ( - class(gridfire), intent(inout) self, + class(gridfire), intent(inout)  + self, - character(len=*), dimension(:), intent(in) species_list ) + character(len=*), dimension(:), intent(in)  + species_list  + + + + ) +
@@ -289,17 +315,25 @@ Public Attributes procedure gridfire_mod::gridfire::setup_policy ( - class(gridfire), intent(in) self, + class(gridfire), intent(in)  + self, - character(len=*), intent(in) policy_name, + character(len=*), intent(in)  + policy_name, - real(c_double), dimension(:), intent(in) abundances ) + real(c_double), dimension(:), intent(in)  + abundances  + + + + ) +
@@ -315,12 +349,19 @@ Public Attributes procedure gridfire_mod::gridfire::setup_solver ( - class(gridfire), intent(in) self, + class(gridfire), intent(in)  + self, - character(len=*), intent(in) solver_name ) + character(len=*), intent(in)  + solver_name  + + + + ) +
@@ -365,7 +406,7 @@ Public Attributes diff --git a/docs/html/structgridfire__mod_1_1gridfire__coll__graph.map b/docs/html/structgridfire__mod_1_1gridfire__coll__graph.map new file mode 100644 index 00000000..ba1efe28 --- /dev/null +++ b/docs/html/structgridfire__mod_1_1gridfire__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/html/structgridfire__mod_1_1gridfire__coll__graph.md5 b/docs/html/structgridfire__mod_1_1gridfire__coll__graph.md5 new file mode 100644 index 00000000..8c1ea89a --- /dev/null +++ b/docs/html/structgridfire__mod_1_1gridfire__coll__graph.md5 @@ -0,0 +1 @@ +5cc93da0424a30bbec166cfe36b2d8dc \ No newline at end of file diff --git a/docs/html/structgridfire__mod_1_1gridfire__coll__graph.svg b/docs/html/structgridfire__mod_1_1gridfire__coll__graph.svg new file mode 100644 index 00000000..30030314 --- /dev/null +++ b/docs/html/structgridfire__mod_1_1gridfire__coll__graph.svg @@ -0,0 +1,65 @@ + + + + + + + + + + + +gridfire_mod::gridfire + + +Node1 + + +gridfire_mod::gridfire + + + + + +Node2 + + +type + + + + + +Node2->Node1 + + + + + + ctx + + + + + + + + diff --git a/docs/html/structgridfire__mod_1_1gridfire__coll__graph_org.svg b/docs/html/structgridfire__mod_1_1gridfire__coll__graph_org.svg new file mode 100644 index 00000000..2b8973b8 --- /dev/null +++ b/docs/html/structgridfire__mod_1_1gridfire__coll__graph_org.svg @@ -0,0 +1,40 @@ + + + + + + +gridfire_mod::gridfire + + +Node1 + + +gridfire_mod::gridfire + + + + + +Node2 + + +type + + + + + +Node2->Node1 + + + + + + ctx + + + diff --git a/docs/html/structstd_1_1formatter_3_01gridfire_1_1engine_1_1NetworkJacobian_01_4-members.html b/docs/html/structstd_1_1formatter_3_01gridfire_1_1engine_1_1NetworkJacobian_01_4-members.html new file mode 100644 index 00000000..83963d86 --- /dev/null +++ b/docs/html/structstd_1_1formatter_3_01gridfire_1_1engine_1_1NetworkJacobian_01_4-members.html @@ -0,0 +1,112 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
std::formatter< gridfire::engine::NetworkJacobian > Member List
+
+
+ +

This is the complete list of members for std::formatter< gridfire::engine::NetworkJacobian >, including all inherited members.

+ + + +
format(const gridfire::engine::NetworkJacobian &obj, std::format_context &ctx)std::formatter< gridfire::engine::NetworkJacobian >inlinestatic
parse(const std::format_parse_context &ctx)std::formatter< gridfire::engine::NetworkJacobian >inlinestatic
+
+ + + + diff --git a/docs/html/structstd_1_1formatter_3_01gridfire_1_1engine_1_1NetworkJacobian_01_4.html b/docs/html/structstd_1_1formatter_3_01gridfire_1_1engine_1_1NetworkJacobian_01_4.html new file mode 100644 index 00000000..3a12cbf8 --- /dev/null +++ b/docs/html/structstd_1_1formatter_3_01gridfire_1_1engine_1_1NetworkJacobian_01_4.html @@ -0,0 +1,187 @@ + + + + + + + +GridFire: std::formatter< gridfire::engine::NetworkJacobian > Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Static Public Member Functions | +List of all members
+
std::formatter< gridfire::engine::NetworkJacobian > Struct Reference
+
+
+ +

#include <jacobian_format.h>

+ + + + + + +

+Static Public Member Functions

static constexpr auto parse (const std::format_parse_context &ctx)
 
static auto format (const gridfire::engine::NetworkJacobian &obj, std::format_context &ctx)
 
+

Member Function Documentation

+ +

◆ format()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
static auto std::formatter< gridfire::engine::NetworkJacobian >::format (const gridfire::engine::NetworkJacobian & obj,
std::format_context & ctx 
)
+ 		+inlinestatic
+
+ +
+
+ +

◆ parse()

+ +
+
+ + + + + +
+ + + + + + + + +
static constexpr auto std::formatter< gridfire::engine::NetworkJacobian >::parse (const std::format_parse_context & ctx)
+ 		+inlinestaticconstexpr
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structstd_1_1formatter_3_01gridfire_1_1engine_1_1NetworkJacobian_01_4.js b/docs/html/structstd_1_1formatter_3_01gridfire_1_1engine_1_1NetworkJacobian_01_4.js new file mode 100644 index 00000000..cb9a0d36 --- /dev/null +++ b/docs/html/structstd_1_1formatter_3_01gridfire_1_1engine_1_1NetworkJacobian_01_4.js @@ -0,0 +1,5 @@ +var structstd_1_1formatter_3_01gridfire_1_1engine_1_1NetworkJacobian_01_4 = +[ + [ "format", "structstd_1_1formatter_3_01gridfire_1_1engine_1_1NetworkJacobian_01_4.html#a59d2a4484bd158d2242776b75cded831", null ], + [ "parse", "structstd_1_1formatter_3_01gridfire_1_1engine_1_1NetworkJacobian_01_4.html#a477ce36e65137d3c94d2cf3c1e8752f9", null ] +]; \ No newline at end of file diff --git a/docs/html/structstd_1_1hash_3_01gridfire_1_1rates_1_1weak_1_1TableAxes_01_4-members.html b/docs/html/structstd_1_1hash_3_01gridfire_1_1rates_1_1weak_1_1TableAxes_01_4-members.html new file mode 100644 index 00000000..6623a33c --- /dev/null +++ b/docs/html/structstd_1_1hash_3_01gridfire_1_1rates_1_1weak_1_1TableAxes_01_4-members.html @@ -0,0 +1,111 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
std::hash< gridfire::rates::weak::TableAxes > Member List
+
+
+ +

This is the complete list of members for std::hash< gridfire::rates::weak::TableAxes >, including all inherited members.

+ + +
operator()(gridfire::rates::weak::TableAxes t) const noexceptstd::hash< gridfire::rates::weak::TableAxes >inline
+
+ + + + diff --git a/docs/html/structstd_1_1hash_3_01gridfire_1_1rates_1_1weak_1_1TableAxes_01_4.html b/docs/html/structstd_1_1hash_3_01gridfire_1_1rates_1_1weak_1_1TableAxes_01_4.html new file mode 100644 index 00000000..0c9f3edb --- /dev/null +++ b/docs/html/structstd_1_1hash_3_01gridfire_1_1rates_1_1weak_1_1TableAxes_01_4.html @@ -0,0 +1,149 @@ + + + + + + + +GridFire: std::hash< gridfire::rates::weak::TableAxes > Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
std::hash< gridfire::rates::weak::TableAxes > Struct Reference
+
+
+ +

#include <weak_types.h>

+ + + + +

+Public Member Functions

std::size_t operator() (gridfire::rates::weak::TableAxes t) const noexcept
 
+

Member Function Documentation

+ +

◆ operator()()

+ +
+
+ + + + + +
+ + + + + + + + +
std::size_t std::hash< gridfire::rates::weak::TableAxes >::operator() (gridfire::rates::weak::TableAxes t) const
+ 		+inlinenoexcept
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structstd_1_1hash_3_01gridfire_1_1rates_1_1weak_1_1TableAxes_01_4.js b/docs/html/structstd_1_1hash_3_01gridfire_1_1rates_1_1weak_1_1TableAxes_01_4.js new file mode 100644 index 00000000..ac326b1d --- /dev/null +++ b/docs/html/structstd_1_1hash_3_01gridfire_1_1rates_1_1weak_1_1TableAxes_01_4.js @@ -0,0 +1,4 @@ +var structstd_1_1hash_3_01gridfire_1_1rates_1_1weak_1_1TableAxes_01_4 = +[ + [ "operator()", "structstd_1_1hash_3_01gridfire_1_1rates_1_1weak_1_1TableAxes_01_4.html#abab92065d884b95cdddcc2f8f6fdd490", null ] +]; \ No newline at end of file diff --git a/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1ReactionSet_01_4-members.html b/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1ReactionSet_01_4-members.html new file mode 100644 index 00000000..d4c666d0 --- /dev/null +++ b/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1ReactionSet_01_4-members.html @@ -0,0 +1,111 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
std::hash< gridfire::reaction::ReactionSet > Member List
+
+
+ +

This is the complete list of members for std::hash< gridfire::reaction::ReactionSet >, including all inherited members.

+ + +
operator()(const gridfire::reaction::ReactionSet &s) const noexceptstd::hash< gridfire::reaction::ReactionSet >inline
+
+ + + + diff --git a/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1ReactionSet_01_4.html b/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1ReactionSet_01_4.html new file mode 100644 index 00000000..483a1d8c --- /dev/null +++ b/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1ReactionSet_01_4.html @@ -0,0 +1,147 @@ + + + + + + + +GridFire: std::hash< gridfire::reaction::ReactionSet > Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
std::hash< gridfire::reaction::ReactionSet > Struct Reference
+
+
+ + + + +

+Public Member Functions

size_t operator() (const gridfire::reaction::ReactionSet &s) const noexcept
 
+

Member Function Documentation

+ +

◆ operator()()

+ +
+
+ + + + + +
+ + + + + + + + +
size_t std::hash< gridfire::reaction::ReactionSet >::operator() (const gridfire::reaction::ReactionSet & s) const
+ 		+inlinenoexcept
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1ReactionSet_01_4.js b/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1ReactionSet_01_4.js new file mode 100644 index 00000000..f4d26f30 --- /dev/null +++ b/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1ReactionSet_01_4.js @@ -0,0 +1,4 @@ +var structstd_1_1hash_3_01gridfire_1_1reaction_1_1ReactionSet_01_4 = +[ + [ "operator()", "structstd_1_1hash_3_01gridfire_1_1reaction_1_1ReactionSet_01_4.html#a32b976b3e3e4e0403c1295f9b467e921", null ] +]; \ No newline at end of file diff --git a/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1Reaction_01_4-members.html b/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1Reaction_01_4-members.html new file mode 100644 index 00000000..983a86c3 --- /dev/null +++ b/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1Reaction_01_4-members.html @@ -0,0 +1,111 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
std::hash< gridfire::reaction::Reaction > Member List
+
+
+ +

This is the complete list of members for std::hash< gridfire::reaction::Reaction >, including all inherited members.

+ + +
operator()(const gridfire::reaction::Reaction &r) const noexceptstd::hash< gridfire::reaction::Reaction >inline
+
+ + + + diff --git a/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1Reaction_01_4.html b/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1Reaction_01_4.html new file mode 100644 index 00000000..211d8cce --- /dev/null +++ b/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1Reaction_01_4.html @@ -0,0 +1,147 @@ + + + + + + + +GridFire: std::hash< gridfire::reaction::Reaction > Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire v0.7.1_rc2 +
+
General Purpose Nuclear Network
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
std::hash< gridfire::reaction::Reaction > Struct Reference
+
+
+ + + + +

+Public Member Functions

size_t operator() (const gridfire::reaction::Reaction &r) const noexcept
 
+

Member Function Documentation

+ +

◆ operator()()

+ +
+
+ + + + + +
+ + + + + + + + +
size_t std::hash< gridfire::reaction::Reaction >::operator() (const gridfire::reaction::Reaction & r) const
+ 		+inlinenoexcept
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1Reaction_01_4.js b/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1Reaction_01_4.js new file mode 100644 index 00000000..917e5ff1 --- /dev/null +++ b/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1Reaction_01_4.js @@ -0,0 +1,4 @@ +var structstd_1_1hash_3_01gridfire_1_1reaction_1_1Reaction_01_4 = +[ + [ "operator()", "structstd_1_1hash_3_01gridfire_1_1reaction_1_1Reaction_01_4.html#a48224b63a80690e4f0620f1312be5dd9", null ] +]; \ No newline at end of file diff --git a/docs/html/sundials_8h.html b/docs/html/sundials_8h.html index baaf0dad..c1b8e36a 100644 --- a/docs/html/sundials_8h.html +++ b/docs/html/sundials_8h.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/utils/sundials.h File Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -119,14 +112,14 @@ Include dependency graph for sundials.h:
This graph shows which files directly or indirectly include this file:
-
+
- + - +

Namespaces

namespace  gridfire
namespace  gridfire
 
namespace  gridfire::utils
namespace  gridfire::utils
 
diff --git a/docs/html/sundials_8h.js b/docs/html/sundials_8h.js index 50e3988b..43e11d3c 100644 --- a/docs/html/sundials_8h.js +++ b/docs/html/sundials_8h.js @@ -1,13 +1,13 @@ var sundials_8h = [ - [ "gridfire::utils::SUNDIALS_RET_CODE_TYPES", "namespacegridfire_1_1utils.html#a7cea622c9311bfd0f0b9d7b6298ea04e", [ - [ "gridfire::utils::SUNDIALS_RET_CODE_TYPES::CVODE", "namespacegridfire_1_1utils.html#a7cea622c9311bfd0f0b9d7b6298ea04eadd3b4add4b240136cb05dccdd9f74239", null ], - [ "gridfire::utils::SUNDIALS_RET_CODE_TYPES::KINSOL", "namespacegridfire_1_1utils.html#a7cea622c9311bfd0f0b9d7b6298ea04ea78689531838e490ef6bb41a3b5c43b7d", null ] + [ "SUNDIALS_RET_CODE_TYPES", "sundials_8h.html#a7cea622c9311bfd0f0b9d7b6298ea04e", [ + [ "CVODE", "sundials_8h.html#a7cea622c9311bfd0f0b9d7b6298ea04eadd3b4add4b240136cb05dccdd9f74239", null ], + [ "KINSOL", "sundials_8h.html#a7cea622c9311bfd0f0b9d7b6298ea04ea78689531838e490ef6bb41a3b5c43b7d", null ] ] ], - [ "gridfire::utils::check_cvode_flag", "namespacegridfire_1_1utils.html#ab9d0cfc158090ca9ed09646d407b04f2", null ], - [ "gridfire::utils::check_sundials_flag", "namespacegridfire_1_1utils.html#a71be80c2e36e5436cddcad795d61a0d7", null ], - [ "gridfire::utils::init_sun_vector", "namespacegridfire_1_1utils.html#adfbe36ddda15b6e206d9726236d543ab", null ], - [ "gridfire::utils::sundials_retcode_map", "namespacegridfire_1_1utils.html#ad72bcf145a772cf83cec4fb3841e8dd4", null ], - [ "gridfire::utils::cvode_ret_code_map", "namespacegridfire_1_1utils.html#a06d386929b2274e2593b97868be2ac51", null ], - [ "gridfire::utils::kinsol_ret_code_map", "namespacegridfire_1_1utils.html#a96fc2701cfd6cb8172282e9999fe4b34", null ] + [ "check_cvode_flag", "sundials_8h.html#ab9d0cfc158090ca9ed09646d407b04f2", null ], + [ "check_sundials_flag", "sundials_8h.html#a71be80c2e36e5436cddcad795d61a0d7", null ], + [ "init_sun_vector", "sundials_8h.html#adfbe36ddda15b6e206d9726236d543ab", null ], + [ "sundials_retcode_map", "sundials_8h.html#ad72bcf145a772cf83cec4fb3841e8dd4", null ], + [ "cvode_ret_code_map", "sundials_8h.html#a06d386929b2274e2593b97868be2ac51", null ], + [ "kinsol_ret_code_map", "sundials_8h.html#a96fc2701cfd6cb8172282e9999fe4b34", null ] ]; \ No newline at end of file diff --git a/docs/html/sundials_8h__dep__incl.map b/docs/html/sundials_8h__dep__incl.map index fc64e171..466740f5 100644 --- a/docs/html/sundials_8h__dep__incl.map +++ b/docs/html/sundials_8h__dep__incl.map @@ -1,18 +1,18 @@ - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + diff --git a/docs/html/sundials_8h__dep__incl.md5 b/docs/html/sundials_8h__dep__incl.md5 index f625136f..39e71233 100644 --- a/docs/html/sundials_8h__dep__incl.md5 +++ b/docs/html/sundials_8h__dep__incl.md5 @@ -1 +1 @@ -1e43ce43e81fbacbaeae467b3fbee67f \ No newline at end of file +0802b853e0a75141f3547e3f99e92ff3 \ No newline at end of file diff --git a/docs/html/sundials_8h__dep__incl.svg b/docs/html/sundials_8h__dep__incl.svg index 9dc2ddc6..62ff7d8c 100644 --- a/docs/html/sundials_8h__dep__incl.svg +++ b/docs/html/sundials_8h__dep__incl.svg @@ -1,31 +1,66 @@ - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + src/include/gridfire/utils/sundials.h Node1 - -src/include/gridfire -/utils/sundials.h + +src/include/gridfire +/utils/sundials.h @@ -33,9 +68,9 @@ Node2 - -src/include/gridfire -/utils/utils.h + +src/include/gridfire +/utils/utils.h @@ -43,8 +78,8 @@ Node1->Node2 - - + + @@ -52,9 +87,9 @@ Node7 - -src/lib/engine/views -/engine_multiscale.cpp + +src/lib/engine/views +/engine_multiscale.cpp @@ -62,18 +97,18 @@ Node1->Node7 - - + + Node8 - - -src/lib/solver/strategies -/CVODE_solver_strategy.cpp + + +src/lib/solver/strategies +/CVODE_solver_strategy.cpp @@ -81,8 +116,8 @@ Node1->Node8 - - + + @@ -90,9 +125,9 @@ Node3 - -src/include/gridfire -/gridfire.h + +src/include/gridfire +/gridfire.h @@ -100,8 +135,8 @@ Node2->Node3 - - + + @@ -109,10 +144,10 @@ Node4 - -src/extern/include -/gridfire/extern/gridfire -_context.h + +src/extern/include +/gridfire/extern/gridfire +_context.h @@ -120,8 +155,8 @@ Node3->Node4 - - + + @@ -129,9 +164,9 @@ Node6 - -src/extern/lib/gridfire -_extern.cpp + +src/extern/lib/gridfire +_extern.cpp @@ -139,8 +174,8 @@ Node3->Node6 - - + + @@ -148,9 +183,9 @@ Node5 - -src/extern/lib/gridfire -_context.cpp + +src/extern/lib/gridfire +_context.cpp @@ -158,8 +193,8 @@ Node4->Node5 - - + + @@ -167,13 +202,34 @@ Node4->Node6 - - + + + + + + + + + + + + + + + + + + + + - +GridFire: src/include/gridfire/utils/table_format.h File Reference - + - - @@ -29,7 +27,7 @@ @@ -38,24 +36,19 @@

@@ -160,7 +153,7 @@ Variables
-
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -130,39 +123,39 @@ This graph shows which files directly or indirectly include this file:
- + - + - + - +

Classes

class  gridfire::utils::ColumnBase
class  gridfire::utils::ColumnBase
 
class  gridfire::utils::Column< T >
class  gridfire::utils::Column< T >
 
class  gridfire::utils::TableBase
class  gridfire::utils::TableBase
 
class  gridfire::utils::Table< T >
class  gridfire::utils::Table< T >
 
- + - +

Namespaces

namespace  gridfire
namespace  gridfire
 
namespace  gridfire::utils
namespace  gridfire::utils
 
- + - + - + - + - + - + - +

Functions

size_t gridfire::utils::visual_width (const std::string &s)
 
std::string gridfire::utils::format_table (const std::string &tableName, const std::vector< std::unique_ptr< ColumnBase > > &columns)
std::string gridfire::utils::format_table (const std::string &tableName, const std::vector< std::unique_ptr< ColumnBase > > &columns)
 
std::string gridfire::utils::format_table (const TableBase &table)
std::string gridfire::utils::format_table (const TableBase &table)
 
void gridfire::utils::print_table (const std::string &tableName, const std::vector< std::unique_ptr< ColumnBase > > &columns)
void gridfire::utils::print_table (const std::string &tableName, const std::vector< std::unique_ptr< ColumnBase > > &columns)
 
void gridfire::utils::print_table (const TableBase &table)
void gridfire::utils::print_table (const TableBase &table)
 
void gridfire::utils::to_csv (const std::string &filename, const std::vector< std::unique_ptr< ColumnBase > > &columns)
void gridfire::utils::to_csv (const std::string &filename, const std::vector< std::unique_ptr< ColumnBase > > &columns)
 
nlohmann::json gridfire::utils::to_json (const std::vector< std::unique_ptr< ColumnBase > > &columns)
nlohmann::json gridfire::utils::to_json (const std::vector< std::unique_ptr< ColumnBase > > &columns)
 
void gridfire::utils::to_json_file (const std::string &filename, const std::vector< std::vector< std::unique_ptr< ColumnBase > > > &tables, const std::vector< std::string > &tableNames)
void gridfire::utils::to_json_file (const std::string &filename, const std::vector< std::vector< std::unique_ptr< ColumnBase > > > &tables, const std::vector< std::string > &tableNames)
 
@@ -171,7 +164,7 @@ Functions diff --git a/docs/html/table__format_8h.js b/docs/html/table__format_8h.js index 1c620861..efc1e819 100644 --- a/docs/html/table__format_8h.js +++ b/docs/html/table__format_8h.js @@ -1,15 +1,15 @@ var table__format_8h = [ - [ "gridfire::utils::ColumnBase", "classgridfire_1_1utils_1_1_column_base.html", "classgridfire_1_1utils_1_1_column_base" ], - [ "gridfire::utils::Column< T >", "classgridfire_1_1utils_1_1_column.html", "classgridfire_1_1utils_1_1_column" ], - [ "gridfire::utils::TableBase", "classgridfire_1_1utils_1_1_table_base.html", "classgridfire_1_1utils_1_1_table_base" ], - [ "gridfire::utils::Table< T >", "classgridfire_1_1utils_1_1_table.html", "classgridfire_1_1utils_1_1_table" ], - [ "gridfire::utils::format_table", "namespacegridfire_1_1utils.html#a6451ba6762273b91a8281043cfaa5d2a", null ], - [ "gridfire::utils::format_table", "namespacegridfire_1_1utils.html#a2eed085058abdb9d7fbbdb9647b98323", null ], - [ "gridfire::utils::print_table", "namespacegridfire_1_1utils.html#acbaa76c5f4021940995e274a86c2171a", null ], - [ "gridfire::utils::print_table", "namespacegridfire_1_1utils.html#afd3ba7a23f2affd403d5da4e813874d1", null ], - [ "gridfire::utils::to_csv", "namespacegridfire_1_1utils.html#a6c58048a3127e6b87886971385a7fe06", null ], - [ "gridfire::utils::to_json", "namespacegridfire_1_1utils.html#af9f382b1b40867c1e70f062d7fba90cd", null ], - [ "gridfire::utils::to_json_file", "namespacegridfire_1_1utils.html#adf613180bab406ef2bfbb9b79397148e", null ], - [ "gridfire::utils::visual_width", "namespacegridfire_1_1utils.html#ab9afa50593a895415d9314ad853806f3", null ] + [ "gridfire::utils::ColumnBase", "classgridfire_1_1utils_1_1ColumnBase.html", "classgridfire_1_1utils_1_1ColumnBase" ], + [ "gridfire::utils::Column< T >", "classgridfire_1_1utils_1_1Column.html", "classgridfire_1_1utils_1_1Column" ], + [ "gridfire::utils::TableBase", "classgridfire_1_1utils_1_1TableBase.html", "classgridfire_1_1utils_1_1TableBase" ], + [ "gridfire::utils::Table< T >", "classgridfire_1_1utils_1_1Table.html", "classgridfire_1_1utils_1_1Table" ], + [ "format_table", "table__format_8h.html#a6451ba6762273b91a8281043cfaa5d2a", null ], + [ "format_table", "table__format_8h.html#a2eed085058abdb9d7fbbdb9647b98323", null ], + [ "print_table", "table__format_8h.html#acbaa76c5f4021940995e274a86c2171a", null ], + [ "print_table", "table__format_8h.html#afd3ba7a23f2affd403d5da4e813874d1", null ], + [ "to_csv", "table__format_8h.html#a6c58048a3127e6b87886971385a7fe06", null ], + [ "to_json", "table__format_8h.html#af9f382b1b40867c1e70f062d7fba90cd", null ], + [ "to_json_file", "table__format_8h.html#adf613180bab406ef2bfbb9b79397148e", null ], + [ "visual_width", "table__format_8h.html#ab9afa50593a895415d9314ad853806f3", null ] ]; \ No newline at end of file diff --git a/docs/html/table__format_8h__dep__incl.map b/docs/html/table__format_8h__dep__incl.map index e4e44811..3633c904 100644 --- a/docs/html/table__format_8h__dep__incl.map +++ b/docs/html/table__format_8h__dep__incl.map @@ -1,20 +1,20 @@ - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + diff --git a/docs/html/table__format_8h__dep__incl.md5 b/docs/html/table__format_8h__dep__incl.md5 index c3896044..f6078e07 100644 --- a/docs/html/table__format_8h__dep__incl.md5 +++ b/docs/html/table__format_8h__dep__incl.md5 @@ -1 +1 @@ -152c8d1aecbefea1f68b410d2b16968e \ No newline at end of file +fa46e67e56c9a0c6b53f9b6cdf242e0f \ No newline at end of file diff --git a/docs/html/table__format_8h__dep__incl.svg b/docs/html/table__format_8h__dep__incl.svg index 3b7ee030..af893324 100644 --- a/docs/html/table__format_8h__dep__incl.svg +++ b/docs/html/table__format_8h__dep__incl.svg @@ -1,13 +1,12 @@ - - + - - + src/include/gridfire/trigger/procedures/trigger_pprint.h Node1 - -src/include/gridfire -/trigger/procedures/trigger -_pprint.h + +src/include/gridfire +/trigger/procedures/trigger +_pprint.h @@ -34,10 +33,10 @@ Node2 - -src/include/gridfire -/trigger/procedures/trigger -_procedures.h + +src/include/gridfire +/trigger/procedures/trigger +_procedures.h @@ -45,18 +44,18 @@ Node1->Node2 - - + + Node8 - - -src/lib/solver/strategies -/CVODE_solver_strategy.cpp + + +src/lib/solver/strategies +/CVODE_solver_strategy.cpp @@ -64,8 +63,8 @@ Node1->Node8 - - + + @@ -73,9 +72,9 @@ Node3 - -src/include/gridfire -/trigger/trigger.h + +src/include/gridfire +/trigger/trigger.h @@ -83,8 +82,8 @@ Node2->Node3 - - + + @@ -92,9 +91,9 @@ Node4 - -src/include/gridfire -/gridfire.h + +src/include/gridfire +/gridfire.h @@ -102,8 +101,8 @@ Node3->Node4 - - + + @@ -111,10 +110,10 @@ Node5 - -src/extern/include -/gridfire/extern/gridfire -_context.h + +src/extern/include +/gridfire/extern/gridfire +_context.h @@ -122,8 +121,8 @@ Node4->Node5 - - + + @@ -131,9 +130,9 @@ Node7 - -src/extern/lib/gridfire -_extern.cpp + +src/extern/lib/gridfire +_extern.cpp @@ -141,8 +140,8 @@ Node4->Node7 - - + + @@ -150,9 +149,9 @@ Node6 - -src/extern/lib/gridfire -_context.cpp + +src/extern/lib/gridfire +_context.cpp @@ -160,8 +159,8 @@ Node5->Node6 - - + + @@ -169,8 +168,8 @@ Node5->Node7 - - + + diff --git a/docs/html/trigger__pprint_8h__dep__incl_org.svg b/docs/html/trigger__pprint_8h__dep__incl_org.svg index ec024dfc..86b38f9f 100644 --- a/docs/html/trigger__pprint_8h__dep__incl_org.svg +++ b/docs/html/trigger__pprint_8h__dep__incl_org.svg @@ -1,21 +1,21 @@ - - - + + src/include/gridfire/trigger/procedures/trigger_pprint.h Node1 - -src/include/gridfire -/trigger/procedures/trigger -_pprint.h + +src/include/gridfire +/trigger/procedures/trigger +_pprint.h @@ -23,10 +23,10 @@ Node2 - -src/include/gridfire -/trigger/procedures/trigger -_procedures.h + +src/include/gridfire +/trigger/procedures/trigger +_procedures.h @@ -34,18 +34,18 @@ Node1->Node2 - - + + Node8 - - -src/lib/solver/strategies -/CVODE_solver_strategy.cpp + + +src/lib/solver/strategies +/CVODE_solver_strategy.cpp @@ -53,8 +53,8 @@ Node1->Node8 - - + + @@ -62,9 +62,9 @@ Node3 - -src/include/gridfire -/trigger/trigger.h + +src/include/gridfire +/trigger/trigger.h @@ -72,8 +72,8 @@ Node2->Node3 - - + + @@ -81,9 +81,9 @@ Node4 - -src/include/gridfire -/gridfire.h + +src/include/gridfire +/gridfire.h @@ -91,8 +91,8 @@ Node3->Node4 - - + + @@ -100,10 +100,10 @@ Node5 - -src/extern/include -/gridfire/extern/gridfire -_context.h + +src/extern/include +/gridfire/extern/gridfire +_context.h @@ -111,8 +111,8 @@ Node4->Node5 - - + + @@ -120,9 +120,9 @@ Node7 - -src/extern/lib/gridfire -_extern.cpp + +src/extern/lib/gridfire +_extern.cpp @@ -130,8 +130,8 @@ Node4->Node7 - - + + @@ -139,9 +139,9 @@ Node6 - -src/extern/lib/gridfire -_context.cpp + +src/extern/lib/gridfire +_context.cpp @@ -149,8 +149,8 @@ Node5->Node6 - - + + @@ -158,8 +158,8 @@ Node5->Node7 - - + + diff --git a/docs/html/trigger__procedures_8h.html b/docs/html/trigger__procedures_8h.html index a9506653..244fec17 100644 --- a/docs/html/trigger__procedures_8h.html +++ b/docs/html/trigger__procedures_8h.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/trigger/procedures/trigger_procedures.h File Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -119,7 +112,7 @@ This graph shows which files directly or indirectly include this file:
diff --git a/docs/html/trigger__result_8h.html b/docs/html/trigger__result_8h.html index e289ad51..f9b4160d 100644 --- a/docs/html/trigger__result_8h.html +++ b/docs/html/trigger__result_8h.html @@ -3,18 +3,16 @@ - + GridFire: src/include/gridfire/trigger/trigger_result.h File Reference - + - - @@ -29,7 +27,7 @@ -
GridFire v0.7.0_rc2 +
GridFire v0.7.1_rc2
General Purpose Nuclear Network
@@ -38,24 +36,19 @@
- + - @@ -73,7 +66,7 @@ $(function() {
@@ -123,24 +116,24 @@ This graph shows which files directly or indirectly include this file:
- +

Classes

struct  gridfire::trigger::TriggerResult
struct  gridfire::trigger::TriggerResult
 
- + - +

Namespaces

namespace  gridfire
namespace  gridfire
 
namespace  gridfire::trigger
namespace  gridfire::trigger
 

Detailed Description

Structured explanation node for trigger evaluations.

TriggerResult represents a tree describing why a trigger evaluated to true/false. Each node contains a boolean value, a short name, a human-readable description, and optional nested causes for composite triggers (e.g., AND/OR/NOT).

Example
// Produce a result and pretty-print it
-
gridfire::trigger::TriggerResult r{"A>5", "Threshold passed", true, {}};
+
gridfire::trigger::TriggerResult r{"A>5", "Threshold passed", true, {}};
// See procedures/trigger_pprint.h for printWhy()
// gridfire::trigger::printWhy(r);
-
gridfire::trigger::TriggerResult
Definition trigger_result.h:23
+
gridfire::trigger::TriggerResult
Definition trigger_result.h:23
@@ -148,7 +141,7 @@ Namespaces diff --git a/docs/html/trigger__result_8h.js b/docs/html/trigger__result_8h.js index 683ee7b3..490b506e 100644 --- a/docs/html/trigger__result_8h.js +++ b/docs/html/trigger__result_8h.js @@ -1,4 +1,4 @@ var trigger__result_8h = [ - [ "gridfire::trigger::TriggerResult", "structgridfire_1_1trigger_1_1_trigger_result.html", "structgridfire_1_1trigger_1_1_trigger_result" ] + [ "gridfire::trigger::TriggerResult", "structgridfire_1_1trigger_1_1TriggerResult.html", "structgridfire_1_1trigger_1_1TriggerResult" ] ]; \ No newline at end of file diff --git a/docs/html/trigger__result_8h__dep__incl.map b/docs/html/trigger__result_8h__dep__incl.map index 6ac5cf91..74cc3eef 100644 --- a/docs/html/trigger__result_8h__dep__incl.map +++ b/docs/html/trigger__result_8h__dep__incl.map @@ -1,54 +1,54 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/trigger__result_8h__dep__incl.md5 b/docs/html/trigger__result_8h__dep__incl.md5 index a5184b1e..ad26f140 100644 --- a/docs/html/trigger__result_8h__dep__incl.md5 +++ b/docs/html/trigger__result_8h__dep__incl.md5 @@ -1 +1 @@ -1dc59a1e99ec4cf0dde8079c8fae8a1d \ No newline at end of file +2f2adcc14f1ef47ff2940592e2f7c672 \ No newline at end of file diff --git a/docs/html/trigger__result_8h__dep__incl.svg b/docs/html/trigger__result_8h__dep__incl.svg index 85b23fb2..7cd9c85a 100644 --- a/docs/html/trigger__result_8h__dep__incl.svg +++ b/docs/html/trigger__result_8h__dep__incl.svg @@ -1,13 +1,12 @@ - - + -