diff --git a/docs/html/classgridfire_1_1_file_defined_engine_view-members.html b/docs/html/classgridfire_1_1_file_defined_engine_view-members.html new file mode 100644 index 00000000..4ccde99e --- /dev/null +++ b/docs/html/classgridfire_1_1_file_defined_engine_view-members.html @@ -0,0 +1,154 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::FileDefinedEngineView Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
buildFromFile(const std::string &fileName)gridfire::FileDefinedEngineViewprivate
calculateMolarReactionFlow(const reaction::Reaction &reaction, const std::vector< double > &Y_defined, const double T9, const double rho) const overridegridfire::FileDefinedEngineViewvirtual
calculateRHSAndEnergy(const std::vector< double > &Y_defined, const double T9, const double rho) const overridegridfire::FileDefinedEngineViewvirtual
Config typedefgridfire::FileDefinedEngineViewprivate
constructReactionIndexMap() constgridfire::FileDefinedEngineViewprivate
constructSpeciesIndexMap() constgridfire::FileDefinedEngineViewprivate
FileDefinedEngineView(DynamicEngine &baseEngine, const std::string &fileName, const io::NetworkFileParser &parser)gridfire::FileDefinedEngineViewexplicit
generateJacobianMatrix(const std::vector< double > &Y_defined, const double T9, const double rho) overridegridfire::FileDefinedEngineViewvirtual
generateStoichiometryMatrix() overridegridfire::FileDefinedEngineViewvirtual
getBaseEngine() const overridegridfire::FileDefinedEngineViewvirtual
getJacobianMatrixEntry(const int i_defined, const int j_defined) const overridegridfire::FileDefinedEngineViewvirtual
getNetworkReactions() const overridegridfire::FileDefinedEngineViewvirtual
getNetworkSpecies() const overridegridfire::FileDefinedEngineViewvirtual
getScreeningModel() const overridegridfire::FileDefinedEngineViewvirtual
getSpeciesTimescales(const std::vector< double > &Y_defined, const double T9, const double rho) const overridegridfire::FileDefinedEngineViewvirtual
getStoichiometryMatrixEntry(const int speciesIndex_defined, const int reactionIndex_defined) const overridegridfire::FileDefinedEngineViewvirtual
LogManager typedefgridfire::FileDefinedEngineViewprivate
m_activeReactionsgridfire::FileDefinedEngineViewprivate
m_activeSpeciesgridfire::FileDefinedEngineViewprivate
m_baseEnginegridfire::FileDefinedEngineViewprivate
m_configgridfire::FileDefinedEngineViewprivate
m_fileNamegridfire::FileDefinedEngineViewprivate
m_isStalegridfire::FileDefinedEngineViewprivate
m_loggergridfire::FileDefinedEngineViewprivate
m_parsergridfire::FileDefinedEngineViewprivate
m_reactionIndexMapgridfire::FileDefinedEngineViewprivate
m_speciesIndexMapgridfire::FileDefinedEngineViewprivate
mapFullToView(const std::vector< double > &full) constgridfire::FileDefinedEngineViewprivate
mapViewToFull(const std::vector< double > &culled) constgridfire::FileDefinedEngineViewprivate
mapViewToFullReactionIndex(size_t culledReactionIndex) constgridfire::FileDefinedEngineViewprivate
mapViewToFullSpeciesIndex(size_t culledSpeciesIndex) constgridfire::FileDefinedEngineViewprivate
setNetworkFile(const std::string &fileName)gridfire::FileDefinedEngineView
setScreeningModel(screening::ScreeningType model) overridegridfire::FileDefinedEngineViewvirtual
update(const NetIn &netIn) overridegridfire::FileDefinedEngineViewvirtual
validateNetworkState() constgridfire::FileDefinedEngineViewprivate
~Engine()=defaultgridfire::Enginevirtual
~EngineView()=defaultgridfire::EngineView< DynamicEngine >virtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1_file_defined_engine_view.html b/docs/html/classgridfire_1_1_file_defined_engine_view.html new file mode 100644 index 00000000..35420302 --- /dev/null +++ b/docs/html/classgridfire_1_1_file_defined_engine_view.html @@ -0,0 +1,1398 @@ + + + + + + + +GridFire: gridfire::FileDefinedEngineView Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Types | +Private Member Functions | +Private Attributes | +List of all members
+
gridfire::FileDefinedEngineView Class Referencefinal
+
+
+ +

#include <engine_defined.h>

+
+Inheritance diagram for gridfire::FileDefinedEngineView:
+
+
+ + +gridfire::DynamicEngine +gridfire::EngineView< DynamicEngine > +gridfire::Engine + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 FileDefinedEngineView (DynamicEngine &baseEngine, const std::string &fileName, const io::NetworkFileParser &parser)
 
const DynamicEngine & getBaseEngine () const override
 Access the underlying engine instance.
 
const std::vector< fourdst::atomic::Species > & getNetworkSpecies () const override
 Get the list of species in the network.
 
StepDerivatives< double > calculateRHSAndEnergy (const std::vector< double > &Y_defined, const double T9, const double rho) const override
 Calculate the right-hand side (dY/dt) and energy generation.
 
void generateJacobianMatrix (const std::vector< double > &Y_defined, const double T9, const double rho) override
 Generate the Jacobian matrix for the current state.
 
double getJacobianMatrixEntry (const int i_defined, const int j_defined) const override
 Get an entry from the previously generated Jacobian matrix.
 
void generateStoichiometryMatrix () override
 Generate the stoichiometry matrix for the network.
 
int getStoichiometryMatrixEntry (const int speciesIndex_defined, const int reactionIndex_defined) const override
 Get an entry from the stoichiometry matrix.
 
double calculateMolarReactionFlow (const reaction::Reaction &reaction, const std::vector< double > &Y_defined, const double T9, const double rho) const override
 Calculate the molar reaction flow for a given reaction.
 
const reaction::LogicalReactionSet & getNetworkReactions () const override
 Get the set of logical reactions in the network.
 
std::unordered_map< fourdst::atomic::Species, double > getSpeciesTimescales (const std::vector< double > &Y_defined, const double T9, const double rho) const override
 Compute timescales for all species in the network.
 
void update (const NetIn &netIn) override
 
void setNetworkFile (const std::string &fileName)
 
void setScreeningModel (screening::ScreeningType model) override
 
screening::ScreeningType getScreeningModel () const override
 
- Public Member Functions inherited from gridfire::Engine
virtual ~Engine ()=default
 Virtual destructor.
 
- Public Member Functions inherited from gridfire::EngineView< DynamicEngine >
virtual ~EngineView ()=default
 Virtual destructor.
 
+ + + + + +

+Private Types

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

+Private Member Functions

void buildFromFile (const std::string &fileName)
 
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 > &culled) 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 culledSpeciesIndex) const
 Maps a culled species index to a full species index.
 
size_t mapViewToFullReactionIndex (size_t culledReactionIndex) const
 Maps a culled reaction index to a full reaction index.
 
void validateNetworkState () const
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Private Attributes

Config & m_config = Config::getInstance()
 
quill::Logger * m_logger = LogManager::getInstance().getLogger("log")
 
DynamicEngine & m_baseEngine
 
std::string m_fileName
 Name of the file defining the reaction set considered by the engine view.
 
const io::NetworkFileParser & m_parser
 Parser for the network file.
 
std::vector< fourdst::atomic::Species > m_activeSpecies
 Active species in the defined engine.
 
reaction::LogicalReactionSet m_activeReactions
 Active reactions in the defined engine.
 
std::vector< size_t > m_speciesIndexMap
 Maps indices of active species to indices in the full network.
 
std::vector< size_t > m_reactionIndexMap
 Maps indices of active reactions to indices in the full network.
 
bool m_isStale = true
 
+

Detailed Description

+
+

Definition at line 16 of file engine_defined.h.

+

Member Typedef Documentation

+ +

◆ Config

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

Definition at line 71 of file engine_defined.h.

+ +
+
+ +

◆ LogManager

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

Definition at line 72 of file engine_defined.h.

+ +
+
+

Constructor & Destructor Documentation

+ +

◆ FileDefinedEngineView()

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

Definition at line 8 of file engine_defined.cpp.

+ +
+
+

Member Function Documentation

+ +

◆ buildFromFile()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::FileDefinedEngineView::buildFromFile (const std::string & fileName)
+ 		+private
+
+ +

Definition at line 208 of file engine_defined.cpp.

+ +
+
+ +

◆ calculateMolarReactionFlow()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
double gridfire::FileDefinedEngineView::calculateMolarReactionFlow (const reaction::Reaction & reaction,
const std::vector< double > & Y,
const double T9,
const double rho ) const
+ 		+overridevirtual
+
+ +

Calculate the molar reaction flow for a given reaction.

+
Parameters
+ + + + + +
reactionThe reaction for which to calculate the flow.
YVector of 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::DynamicEngine.

+ +

Definition at line 85 of file engine_defined.cpp.

+ +
+
+ +

◆ calculateRHSAndEnergy()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + +
StepDerivatives< double > gridfire::FileDefinedEngineView::calculateRHSAndEnergy (const std::vector< double > & Y,
const double T9,
const double rho ) const
+ 		+overridevirtual
+
+ +

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

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

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.

+ +

Definition at line 29 of file engine_defined.cpp.

+ +
+
+ +

◆ constructReactionIndexMap()

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

Constructs the reaction index map.

+
Returns
A vector mapping culled 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.

+
See also
AdaptiveEngineView::update()
+ +

Definition at line 176 of file engine_defined.cpp.

+ +
+
+ +

◆ constructSpeciesIndexMap()

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

Constructs the species index map.

+
Returns
A vector mapping culled 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.

+
See also
AdaptiveEngineView::update()
+ +

Definition at line 147 of file engine_defined.cpp.

+ +
+
+ +

◆ generateJacobianMatrix()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + +
void gridfire::FileDefinedEngineView::generateJacobianMatrix (const std::vector< double > & Y,
const double T9,
const double rho )
+ 		+overridevirtual
+
+ +

Generate the Jacobian matrix for the current state.

+
Parameters
+ + + + +
YVector of 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().

+ +

Implements gridfire::DynamicEngine.

+ +

Definition at line 45 of file engine_defined.cpp.

+ +
+
+ +

◆ generateStoichiometryMatrix()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::FileDefinedEngineView::generateStoichiometryMatrix ()
+ 		+overridevirtual
+
+ +

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.

+ +

Implements gridfire::DynamicEngine.

+ +

Definition at line 68 of file engine_defined.cpp.

+ +
+
+ +

◆ getBaseEngine()

+ +
+
+ + + + + +
+ + + + + + + +
const DynamicEngine & gridfire::FileDefinedEngineView::getBaseEngine () const
+ 		+overridevirtual
+
+ +

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();
+
gridfire::DynamicEngine
Abstract class for engines supporting Jacobian and stoichiometry operations.
Definition engine_abstract.h:121
+
+

Implements gridfire::EngineView< DynamicEngine >.

+ +

Definition at line 21 of file engine_defined.cpp.

+ +
+
+ +

◆ getJacobianMatrixEntry()

+ +
+
+ + + + + +
+ + + + + + + + + + + +
double gridfire::FileDefinedEngineView::getJacobianMatrixEntry (const int i,
const int j ) const
+ 		+overridevirtual
+
+ +

Get an entry from the previously generated Jacobian matrix.

+
Parameters
+ + + +
iRow index (species index).
jColumn index (species index).
+
+
+
Returns
Value of the Jacobian matrix at (i, j).
+

The Jacobian must have been generated by generateJacobianMatrix() before calling this.

+ +

Implements gridfire::DynamicEngine.

+ +

Definition at line 56 of file engine_defined.cpp.

+ +
+
+ +

◆ getNetworkReactions()

+ +
+
+ + + + + +
+ + + + + + + +
const reaction::LogicalReactionSet & gridfire::FileDefinedEngineView::getNetworkReactions () const
+ 		+overridevirtual
+
+ +

Get the set of logical reactions in the network.

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

Implements gridfire::DynamicEngine.

+ +

Definition at line 102 of file engine_defined.cpp.

+ +
+
+ +

◆ getNetworkSpecies()

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

Get the list of species in the network.

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

Implements gridfire::Engine.

+ +

Definition at line 25 of file engine_defined.cpp.

+ +
+
+ +

◆ getScreeningModel()

+ +
+
+ + + + + +
+ + + + + + + +
screening::ScreeningType gridfire::FileDefinedEngineView::getScreeningModel () const
+ 		+nodiscardoverridevirtual
+
+ +

Implements gridfire::DynamicEngine.

+ +

Definition at line 143 of file engine_defined.cpp.

+ +
+
+ +

◆ getSpeciesTimescales()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + +
std::unordered_map< Species, double > gridfire::FileDefinedEngineView::getSpeciesTimescales (const std::vector< double > & Y,
const double T9,
const double rho ) const
+ 		+overridevirtual
+
+ +

Compute timescales for all species in the network.

+
Parameters
+ + + + +
YVector of 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.

+ +

Implements gridfire::DynamicEngine.

+ +

Definition at line 108 of file engine_defined.cpp.

+ +
+
+ +

◆ getStoichiometryMatrixEntry()

+ +
+
+ + + + + +
+ + + + + + + + + + + +
int gridfire::FileDefinedEngineView::getStoichiometryMatrixEntry (const int speciesIndex,
const int reactionIndex ) const
+ 		+overridevirtual
+
+ +

Get an entry from the stoichiometry matrix.

+
Parameters
+ + + +
speciesIndexIndex of the species.
reactionIndexIndex of the reaction.
+
+
+
Returns
Stoichiometric coefficient for the species in the reaction.
+

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

+ +

Implements gridfire::DynamicEngine.

+ +

Definition at line 74 of file engine_defined.cpp.

+ +
+
+ +

◆ mapFullToView()

+ +
+
+ + + + + +
+ + + + + + + +
std::vector< double > gridfire::FileDefinedEngineView::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.
+ +

Definition at line 276 of file engine_defined.cpp.

+ +
+
+ +

◆ mapViewToFull()

+ +
+
+ + + + + +
+ + + + + + + +
std::vector< double > gridfire::FileDefinedEngineView::mapViewToFull (const std::vector< double > & culled) const
+ 		+private
+
+ +

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

+
Parameters
+ + +
culledA 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 culled vector.
+ +

Definition at line 267 of file engine_defined.cpp.

+ +
+
+ +

◆ mapViewToFullReactionIndex()

+ +
+
+ + + + + +
+ + + + + + + +
size_t gridfire::FileDefinedEngineView::mapViewToFullReactionIndex (size_t culledReactionIndex) const
+ 		+private
+
+ +

Maps a culled reaction index to a full reaction index.

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

Definition at line 294 of file engine_defined.cpp.

+ +
+
+ +

◆ mapViewToFullSpeciesIndex()

+ +
+
+ + + + + +
+ + + + + + + +
size_t gridfire::FileDefinedEngineView::mapViewToFullSpeciesIndex (size_t culledSpeciesIndex) const
+ 		+private
+
+ +

Maps a culled species index to a full species index.

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

Definition at line 285 of file engine_defined.cpp.

+ +
+
+ +

◆ setNetworkFile()

+ +
+
+ + + + + + + +
void gridfire::FileDefinedEngineView::setNetworkFile (const std::string & fileName)
+
+ +

Definition at line 133 of file engine_defined.cpp.

+ +
+
+ +

◆ setScreeningModel()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::FileDefinedEngineView::setScreeningModel (screening::ScreeningType model)
+ 		+overridevirtual
+
+ +

Implements gridfire::DynamicEngine.

+ +

Definition at line 139 of file engine_defined.cpp.

+ +
+
+ +

◆ update()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::FileDefinedEngineView::update (const NetIn & netIn)
+ 		+overridevirtual
+
+ +

Implements gridfire::DynamicEngine.

+ +

Definition at line 127 of file engine_defined.cpp.

+ +
+
+ +

◆ validateNetworkState()

+ +
+
+ + + + + +
+ + + + + + + +
void gridfire::FileDefinedEngineView::validateNetworkState () const
+ 		+private
+
+ +

Definition at line 303 of file engine_defined.cpp.

+ +
+
+

Member Data Documentation

+ +

◆ m_activeReactions

+ +
+
+ + + + + +
+ + + + +
reaction::LogicalReactionSet gridfire::FileDefinedEngineView::m_activeReactions
+ 		+private
+
+ +

Active reactions in the defined engine.

+ +

Definition at line 81 of file engine_defined.h.

+ +
+
+ +

◆ m_activeSpecies

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

Active species in the defined engine.

+ +

Definition at line 80 of file engine_defined.h.

+ +
+
+ +

◆ m_baseEngine

+ +
+
+ + + + + +
+ + + + +
DynamicEngine& gridfire::FileDefinedEngineView::m_baseEngine
+ 		+private
+
+ +

Definition at line 76 of file engine_defined.h.

+ +
+
+ +

◆ m_config

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

Definition at line 73 of file engine_defined.h.

+ +
+
+ +

◆ m_fileName

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

Name of the file defining the reaction set considered by the engine view.

+ +

Definition at line 77 of file engine_defined.h.

+ +
+
+ +

◆ m_isStale

+ +
+
+ + + + + +
+ + + + +
bool gridfire::FileDefinedEngineView::m_isStale = true
+ 		+private
+
+ +

Definition at line 86 of file engine_defined.h.

+ +
+
+ +

◆ m_logger

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

Definition at line 74 of file engine_defined.h.

+ +
+
+ +

◆ m_parser

+ +
+
+ + + + + +
+ + + + +
const io::NetworkFileParser& gridfire::FileDefinedEngineView::m_parser
+ 		+private
+
+ +

Parser for the network file.

+ +

Definition at line 78 of file engine_defined.h.

+ +
+
+ +

◆ m_reactionIndexMap

+ +
+
+ + + + + +
+ + + + +
std::vector<size_t> gridfire::FileDefinedEngineView::m_reactionIndexMap
+ 		+private
+
+ +

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

+ +

Definition at line 84 of file engine_defined.h.

+ +
+
+ +

◆ m_speciesIndexMap

+ +
+
+ + + + + +
+ + + + +
std::vector<size_t> gridfire::FileDefinedEngineView::m_speciesIndexMap
+ 		+private
+
+ +

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

+ +

Definition at line 83 of file engine_defined.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1_file_defined_engine_view.js b/docs/html/classgridfire_1_1_file_defined_engine_view.js new file mode 100644 index 00000000..1717df4a --- /dev/null +++ b/docs/html/classgridfire_1_1_file_defined_engine_view.js @@ -0,0 +1,38 @@ +var classgridfire_1_1_file_defined_engine_view = +[ + [ "Config", "classgridfire_1_1_file_defined_engine_view.html#a63f8f85e75ecaab6fa39d48d7a846187", null ], + [ "LogManager", "classgridfire_1_1_file_defined_engine_view.html#acbb1a9bcb775e6d50de512a333afed08", null ], + [ "FileDefinedEngineView", "classgridfire_1_1_file_defined_engine_view.html#a8f2f64bab0f516ed2a6fd529912e0acd", null ], + [ "buildFromFile", "classgridfire_1_1_file_defined_engine_view.html#a3b5162b7be35405285ef9f825ec2663b", null ], + [ "calculateMolarReactionFlow", "classgridfire_1_1_file_defined_engine_view.html#ac371fb66fd0a76a04df204c9dd9a05ef", null ], + [ "calculateRHSAndEnergy", "classgridfire_1_1_file_defined_engine_view.html#a2c1d88b06568f9ea4c65e794d012ebfb", null ], + [ "constructReactionIndexMap", "classgridfire_1_1_file_defined_engine_view.html#aebb3f3548f8781506f31580706810a4e", null ], + [ "constructSpeciesIndexMap", "classgridfire_1_1_file_defined_engine_view.html#a51ba09ff01fdcac1125d42f276c9a0a7", null ], + [ "generateJacobianMatrix", "classgridfire_1_1_file_defined_engine_view.html#a48b2451f96b8f5511ffc4071519c0810", null ], + [ "generateStoichiometryMatrix", "classgridfire_1_1_file_defined_engine_view.html#a27a5163157cc15c4cb3b99a5d3564dbd", null ], + [ "getBaseEngine", "classgridfire_1_1_file_defined_engine_view.html#a4c8b273c5cb3d470567c5691b68493a3", null ], + [ "getJacobianMatrixEntry", "classgridfire_1_1_file_defined_engine_view.html#a0ef8804780d13bbfce0856237bb00470", null ], + [ "getNetworkReactions", "classgridfire_1_1_file_defined_engine_view.html#a5bbea17b69cc8f81bc251a04f4435a0c", null ], + [ "getNetworkSpecies", "classgridfire_1_1_file_defined_engine_view.html#a8bb583e039b49608272997ed2d3387fa", null ], + [ "getScreeningModel", "classgridfire_1_1_file_defined_engine_view.html#adbc50f397445f92b810d80cf329b8626", null ], + [ "getSpeciesTimescales", "classgridfire_1_1_file_defined_engine_view.html#ace3c6ea4841318c08695973ab3dcddc6", null ], + [ "getStoichiometryMatrixEntry", "classgridfire_1_1_file_defined_engine_view.html#a9da9224f5c99a5068f3d8cbf066e4693", null ], + [ "mapFullToView", "classgridfire_1_1_file_defined_engine_view.html#a97e5ee4651dbe6754678fe96e4702fee", null ], + [ "mapViewToFull", "classgridfire_1_1_file_defined_engine_view.html#ac231044e37e0962f664f8465e1ccb022", null ], + [ "mapViewToFullReactionIndex", "classgridfire_1_1_file_defined_engine_view.html#ae7d6f0ff9076d59d1245c047bbd1bdb9", null ], + [ "mapViewToFullSpeciesIndex", "classgridfire_1_1_file_defined_engine_view.html#a8d2c6b9a33b9c8c172bbd2c2e2e9ffaf", null ], + [ "setNetworkFile", "classgridfire_1_1_file_defined_engine_view.html#a92f14da849e99d07c1ff1347addb9263", null ], + [ "setScreeningModel", "classgridfire_1_1_file_defined_engine_view.html#ad96bbee6d3d37b50d9236a975ef704c0", null ], + [ "update", "classgridfire_1_1_file_defined_engine_view.html#ace3568eadaba69e7357b4386c5ca3eb0", null ], + [ "validateNetworkState", "classgridfire_1_1_file_defined_engine_view.html#ae3f99002ab2c56a5bcdec00839f8628f", null ], + [ "m_activeReactions", "classgridfire_1_1_file_defined_engine_view.html#ae012da2b1f6169cb13e6075a73353ab2", null ], + [ "m_activeSpecies", "classgridfire_1_1_file_defined_engine_view.html#a299a0c61aa4f26029c770013c9feff5e", null ], + [ "m_baseEngine", "classgridfire_1_1_file_defined_engine_view.html#ad8454c98fa9a4bb45dc81059bc51fc81", null ], + [ "m_config", "classgridfire_1_1_file_defined_engine_view.html#a7a80966c023ae722239491af58609362", null ], + [ "m_fileName", "classgridfire_1_1_file_defined_engine_view.html#a1b343998b93955025a589b2b4541e33b", null ], + [ "m_isStale", "classgridfire_1_1_file_defined_engine_view.html#a6e421bc748933be31bed9ff53f12b595", null ], + [ "m_logger", "classgridfire_1_1_file_defined_engine_view.html#a9d93633ed4ab68de94b7274f879a0432", null ], + [ "m_parser", "classgridfire_1_1_file_defined_engine_view.html#a0a9b07176cb93b54c677b6ce71fda500", null ], + [ "m_reactionIndexMap", "classgridfire_1_1_file_defined_engine_view.html#af0a77a4749a15aae87bdecfccbd1736e", null ], + [ "m_speciesIndexMap", "classgridfire_1_1_file_defined_engine_view.html#aebd4a1a584f2784f1df3d503645be03b", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1_file_defined_engine_view.png b/docs/html/classgridfire_1_1_file_defined_engine_view.png new file mode 100644 index 00000000..81c483e7 Binary files /dev/null and b/docs/html/classgridfire_1_1_file_defined_engine_view.png differ diff --git a/docs/html/classgridfire_1_1io_1_1_m_e_s_a_network_file_parser-members.html b/docs/html/classgridfire_1_1io_1_1_m_e_s_a_network_file_parser-members.html new file mode 100644 index 00000000..b0532f60 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1_m_e_s_a_network_file_parser-members.html @@ -0,0 +1,125 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
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_1_m_e_s_a_network_file_parser.html b/docs/html/classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.html new file mode 100644 index 00000000..bbb97ce5 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.html @@ -0,0 +1,340 @@ + + + + + + + +GridFire: gridfire::io::MESANetworkFileParser Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Types | +Private Attributes | +List of all members
+
gridfire::io::MESANetworkFileParser Class Referencefinal
+
+
+ +

#include <network_file.h>

+
+Inheritance diagram for gridfire::io::MESANetworkFileParser:
+
+
+ + +gridfire::io::NetworkFileParser + +
+ + + + + + + + + +

+Public Member Functions

 MESANetworkFileParser (const std::string &filename)
 
ParsedNetworkData parse (const std::string &filename) const override
 
- Public Member Functions inherited from gridfire::io::NetworkFileParser
virtual ~NetworkFileParser ()=default
 
+ + + + + +

+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

+
+

Definition at line 36 of file network_file.h.

+

Member Typedef Documentation

+ +

◆ Config

+ +
+
+ + + + + +
+ + + + +
using gridfire::io::MESANetworkFileParser::Config = fourdst::config::Config
+ 		+private
+
+ +

Definition at line 41 of file network_file.h.

+ +
+
+ +

◆ LogManager

+ +
+
+ + + + + +
+ + + + +
using gridfire::io::MESANetworkFileParser::LogManager = fourdst::logging::LogManager
+ 		+private
+
+ +

Definition at line 42 of file network_file.h.

+ +
+
+

Constructor & Destructor Documentation

+ +

◆ MESANetworkFileParser()

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::io::MESANetworkFileParser::MESANetworkFileParser (const std::string & filename)
+ 		+explicit
+
+ +
+
+

Member Function Documentation

+ +

◆ parse()

+ +
+
+ + + + + +
+ + + + + + + +
ParsedNetworkData gridfire::io::MESANetworkFileParser::parse (const std::string & filename) const
+ 		+overridevirtual
+
+ +

Implements gridfire::io::NetworkFileParser.

+ +
+
+

Member Data Documentation

+ +

◆ m_config

+ +
+
+ + + + + +
+ + + + +
Config& gridfire::io::MESANetworkFileParser::m_config = Config::getInstance()
+ 		+private
+
+ +

Definition at line 43 of file network_file.h.

+ +
+
+ +

◆ m_filename

+ +
+
+ + + + + +
+ + + + +
std::string gridfire::io::MESANetworkFileParser::m_filename
+ 		+private
+
+ +

Definition at line 46 of file network_file.h.

+ +
+
+ +

◆ m_logger

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

Definition at line 44 of file network_file.h.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.js b/docs/html/classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.js new file mode 100644 index 00000000..100cc2d6 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.js @@ -0,0 +1,10 @@ +var classgridfire_1_1io_1_1_m_e_s_a_network_file_parser = +[ + [ "Config", "classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.html#af43ad8375abf1cedfdccc296b9958c2b", null ], + [ "LogManager", "classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.html#a84aa6894a331ad57bdab1e1ab85d4055", null ], + [ "MESANetworkFileParser", "classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.html#ac5963d0da6780de753df996b490f8d2c", null ], + [ "parse", "classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.html#a568194277733b5c537901f8af32ee329", null ], + [ "m_config", "classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.html#aea206c3a7600db8d657666fef88fa20d", null ], + [ "m_filename", "classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.html#ab7f82597abf17f16c401bcdf528bd099", null ], + [ "m_logger", "classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.html#ab9c683289d48e58edf06bf59215b4937", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.png b/docs/html/classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.png new file mode 100644 index 00000000..7087abd0 Binary files /dev/null and b/docs/html/classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.png differ diff --git a/docs/html/classgridfire_1_1io_1_1_network_file_parser-members.html b/docs/html/classgridfire_1_1io_1_1_network_file_parser-members.html new file mode 100644 index 00000000..90d6fe84 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1_network_file_parser-members.html @@ -0,0 +1,119 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
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_1_network_file_parser.html b/docs/html/classgridfire_1_1io_1_1_network_file_parser.html new file mode 100644 index 00000000..3bab0c7d --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1_network_file_parser.html @@ -0,0 +1,198 @@ + + + + + + + +GridFire: gridfire::io::NetworkFileParser Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
gridfire::io::NetworkFileParser Class Referenceabstract
+
+
+ +

#include <network_file.h>

+
+Inheritance diagram for gridfire::io::NetworkFileParser:
+
+
+ + +gridfire::io::MESANetworkFileParser +gridfire::io::SimpleReactionListFileParser + +
+ + + + + + +

+Public Member Functions

virtual ~NetworkFileParser ()=default
 
virtual ParsedNetworkData parse (const std::string &filename) const =0
 
+

Detailed Description

+
+

Definition at line 17 of file network_file.h.

+

Constructor & Destructor Documentation

+ +

◆ ~NetworkFileParser()

+ +
+
+ + + + + +
+ + + + + + + +
virtual gridfire::io::NetworkFileParser::~NetworkFileParser ()
+ 		+virtualdefault
+
+ +
+
+

Member Function Documentation

+ +

◆ parse()

+ +
+
+ + + + + +
+ + + + + + + +
virtual ParsedNetworkData gridfire::io::NetworkFileParser::parse (const std::string & filename) const
+ 		+nodiscardpure virtual
+
+ +

Implemented in gridfire::io::MESANetworkFileParser, and gridfire::io::SimpleReactionListFileParser.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1io_1_1_network_file_parser.js b/docs/html/classgridfire_1_1io_1_1_network_file_parser.js new file mode 100644 index 00000000..009677e9 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1_network_file_parser.js @@ -0,0 +1,5 @@ +var classgridfire_1_1io_1_1_network_file_parser = +[ + [ "~NetworkFileParser", "classgridfire_1_1io_1_1_network_file_parser.html#a9b4095d06fad5df3805c92ae97b3eab3", null ], + [ "parse", "classgridfire_1_1io_1_1_network_file_parser.html#a66e8e724c903d6ef4dd1c8103276bdbf", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1io_1_1_network_file_parser.png b/docs/html/classgridfire_1_1io_1_1_network_file_parser.png new file mode 100644 index 00000000..5c7b1032 Binary files /dev/null and b/docs/html/classgridfire_1_1io_1_1_network_file_parser.png differ diff --git a/docs/html/classgridfire_1_1io_1_1_simple_reaction_list_file_parser-members.html b/docs/html/classgridfire_1_1io_1_1_simple_reaction_list_file_parser-members.html new file mode 100644 index 00000000..427affe1 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1_simple_reaction_list_file_parser-members.html @@ -0,0 +1,124 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
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_1_simple_reaction_list_file_parser.html b/docs/html/classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html new file mode 100644 index 00000000..2bc57380 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html @@ -0,0 +1,319 @@ + + + + + + + +GridFire: gridfire::io::SimpleReactionListFileParser Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Types | +Private Attributes | +List of all members
+
gridfire::io::SimpleReactionListFileParser Class Referencefinal
+
+
+ +

#include <network_file.h>

+
+Inheritance diagram for gridfire::io::SimpleReactionListFileParser:
+
+
+ + +gridfire::io::NetworkFileParser + +
+ + + + + + + + + +

+Public Member Functions

 SimpleReactionListFileParser ()
 
ParsedNetworkData parse (const std::string &filename) const override
 
- Public Member Functions inherited from gridfire::io::NetworkFileParser
virtual ~NetworkFileParser ()=default
 
+ + + + + +

+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

+
+

Definition at line 25 of file network_file.h.

+

Member Typedef Documentation

+ +

◆ Config

+ +
+
+ + + + + +
+ + + + +
using gridfire::io::SimpleReactionListFileParser::Config = fourdst::config::Config
+ 		+private
+
+ +

Definition at line 30 of file network_file.h.

+ +
+
+ +

◆ LogManager

+ +
+
+ + + + + +
+ + + + +
using gridfire::io::SimpleReactionListFileParser::LogManager = fourdst::logging::LogManager
+ 		+private
+
+ +

Definition at line 31 of file network_file.h.

+ +
+
+

Constructor & Destructor Documentation

+ +

◆ SimpleReactionListFileParser()

+ +
+
+ + + + + +
+ + + + + + + +
gridfire::io::SimpleReactionListFileParser::SimpleReactionListFileParser ()
+ 		+explicit
+
+ +

Definition at line 42 of file network_file.cpp.

+ +
+
+

Member Function Documentation

+ +

◆ parse()

+ +
+
+ + + + + +
+ + + + + + + +
ParsedNetworkData gridfire::io::SimpleReactionListFileParser::parse (const std::string & filename) const
+ 		+overridevirtual
+
+ +

Implements gridfire::io::NetworkFileParser.

+ +

Definition at line 44 of file network_file.cpp.

+ +
+
+

Member Data Documentation

+ +

◆ m_config

+ +
+
+ + + + + +
+ + + + +
Config& gridfire::io::SimpleReactionListFileParser::m_config = Config::getInstance()
+ 		+private
+
+ +

Definition at line 32 of file network_file.h.

+ +
+
+ +

◆ m_logger

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

Definition at line 33 of file network_file.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1io_1_1_simple_reaction_list_file_parser.js b/docs/html/classgridfire_1_1io_1_1_simple_reaction_list_file_parser.js new file mode 100644 index 00000000..1c4731a3 --- /dev/null +++ b/docs/html/classgridfire_1_1io_1_1_simple_reaction_list_file_parser.js @@ -0,0 +1,9 @@ +var classgridfire_1_1io_1_1_simple_reaction_list_file_parser = +[ + [ "Config", "classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html#ad913155a5a2a36b29e4ce4ca8d71c036", null ], + [ "LogManager", "classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html#a6f8f9a1f54cd2be5ec66c3181be892de", null ], + [ "SimpleReactionListFileParser", "classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html#afc8ed91e8c98205c505e3d9f0cff1993", null ], + [ "parse", "classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html#a4df01e3a93e1291d2cde0458545325f8", null ], + [ "m_config", "classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html#a4061e99bd77a3de0d6d9e317bfc74874", null ], + [ "m_logger", "classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html#acef7eafe3cbea159259f69c88d309b66", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1io_1_1_simple_reaction_list_file_parser.png b/docs/html/classgridfire_1_1io_1_1_simple_reaction_list_file_parser.png new file mode 100644 index 00000000..ce055e94 Binary files /dev/null and b/docs/html/classgridfire_1_1io_1_1_simple_reaction_list_file_parser.png differ diff --git a/docs/html/classgridfire_1_1reaction_1_1_templated_reaction_set-members.html b/docs/html/classgridfire_1_1reaction_1_1_templated_reaction_set-members.html new file mode 100644 index 00000000..bc52d9cd --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1_templated_reaction_set-members.html @@ -0,0 +1,144 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::reaction::TemplatedReactionSet< ReactionT > Member List
+
+
+ +

This is the complete list of members for gridfire::reaction::TemplatedReactionSet< ReactionT >, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
add_reaction(ReactionT reaction)gridfire::reaction::TemplatedReactionSet< ReactionT >
begin()gridfire::reaction::TemplatedReactionSet< ReactionT >inline
begin() constgridfire::reaction::TemplatedReactionSet< ReactionT >inline
clear()gridfire::reaction::TemplatedReactionSet< ReactionT >
contains(const std::string_view &id) constgridfire::reaction::TemplatedReactionSet< ReactionT >
contains(const Reaction &reaction) constgridfire::reaction::TemplatedReactionSet< ReactionT >
contains_product(const fourdst::atomic::Species &species) constgridfire::reaction::TemplatedReactionSet< ReactionT >
contains_reactant(const fourdst::atomic::Species &species) constgridfire::reaction::TemplatedReactionSet< ReactionT >
contains_species(const fourdst::atomic::Species &species) constgridfire::reaction::TemplatedReactionSet< ReactionT >
end()gridfire::reaction::TemplatedReactionSet< ReactionT >inline
end() constgridfire::reaction::TemplatedReactionSet< ReactionT >inline
getReactionSetSpecies() constgridfire::reaction::TemplatedReactionSet< ReactionT >
hash(uint64_t seed=0) constgridfire::reaction::TemplatedReactionSet< ReactionT >
m_idgridfire::reaction::TemplatedReactionSet< ReactionT >private
m_loggergridfire::reaction::TemplatedReactionSet< ReactionT >private
m_reactionNameMapgridfire::reaction::TemplatedReactionSet< ReactionT >private
m_reactionsgridfire::reaction::TemplatedReactionSet< ReactionT >private
operator!=(const TemplatedReactionSet &other) constgridfire::reaction::TemplatedReactionSet< ReactionT >
operator<<(std::ostream &os, const TemplatedReactionSet< ReactionT > &r)gridfire::reaction::TemplatedReactionSet< ReactionT >friend
operator=(const TemplatedReactionSet< ReactionT > &other)gridfire::reaction::TemplatedReactionSet< ReactionT >
operator==(const TemplatedReactionSet &other) constgridfire::reaction::TemplatedReactionSet< ReactionT >
operator[](size_t index) constgridfire::reaction::TemplatedReactionSet< ReactionT >
operator[](const std::string_view &id) constgridfire::reaction::TemplatedReactionSet< ReactionT >
remove_reaction(const ReactionT &reaction)gridfire::reaction::TemplatedReactionSet< ReactionT >
size() constgridfire::reaction::TemplatedReactionSet< ReactionT >inline
TemplatedReactionSet(std::vector< ReactionT > reactions)gridfire::reaction::TemplatedReactionSet< ReactionT >explicit
TemplatedReactionSet(const TemplatedReactionSet< ReactionT > &other)gridfire::reaction::TemplatedReactionSet< ReactionT >
+
+ + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1_templated_reaction_set.html b/docs/html/classgridfire_1_1reaction_1_1_templated_reaction_set.html new file mode 100644 index 00000000..5e30f28d --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1_templated_reaction_set.html @@ -0,0 +1,1088 @@ + + + + + + + +GridFire: gridfire::reaction::TemplatedReactionSet< ReactionT > Class Template Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +Private Attributes | +Friends | +List of all members
+
gridfire::reaction::TemplatedReactionSet< ReactionT > Class Template Referencefinal
+
+
+ +

#include <reaction.h>

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

+Public Member Functions

 TemplatedReactionSet (std::vector< ReactionT > reactions)
 Constructs a ReactionSet from a vector of reactions.
 
 TemplatedReactionSet (const TemplatedReactionSet< ReactionT > &other)
 Copy constructor.
 
TemplatedReactionSet< ReactionT > & operator= (const TemplatedReactionSet< ReactionT > &other)
 Copy assignment operator.
 
void add_reaction (ReactionT reaction)
 Adds a reaction to the set.
 
void remove_reaction (const ReactionT &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.
 
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 ReactionT & operator[] (size_t index) const
 Accesses a reaction by its index.
 
const ReactionT & operator[] (const std::string_view &id) const
 Accesses a reaction by its ID.
 
bool operator== (const TemplatedReactionSet &other) const
 Compares this set with another for equality.
 
bool operator!= (const TemplatedReactionSet &other) const
 Compares this set with another for inequality.
 
uint64_t hash (uint64_t seed=0) 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< ReactionT > m_reactions
 
std::string m_id
 
std::unordered_map< std::string, ReactionT > m_reactionNameMap
 Maps reaction IDs to Reaction objects for quick lookup.
 
+ + + +

+Friends

std::ostream & operator<< (std::ostream &os, const TemplatedReactionSet< ReactionT > &r)
 
+

Detailed Description

+
template<typename ReactionT>
+class gridfire::reaction::TemplatedReactionSet< ReactionT >
+

Definition at line 402 of file reaction.h.

+

Constructor & Destructor Documentation

+ +

◆ TemplatedReactionSet() [1/2]

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + + + + +
gridfire::reaction::TemplatedReactionSet< ReactionT >::TemplatedReactionSet (std::vector< ReactionT > reactions)
+ 		+explicit
+
+ +

Constructs a ReactionSet from a vector of reactions.

+
Parameters
+ + +
reactionsThe initial vector of Reaction objects.
+
+
+ +

Definition at line 562 of file reaction.h.

+ +
+
+ +

◆ TemplatedReactionSet() [2/2]

+ +
+
+
+template<typename ReactionT>
+ + + + + + + +
gridfire::reaction::TemplatedReactionSet< ReactionT >::TemplatedReactionSet (const TemplatedReactionSet< ReactionT > & other)
+
+ +

Copy constructor.

+
Parameters
+ + +
otherThe ReactionSet to copy.
+
+
+ +

Definition at line 577 of file reaction.h.

+ +
+
+

Member Function Documentation

+ +

◆ add_reaction()

+ +
+
+
+template<typename ReactionT>
+ + + + + + + +
void gridfire::reaction::TemplatedReactionSet< ReactionT >::add_reaction (ReactionT reaction)
+
+ +

Adds a reaction to the set.

+
Parameters
+ + +
reactionThe Reaction to add.
+
+
+ +

Definition at line 600 of file reaction.h.

+ +
+
+ +

◆ begin() [1/2]

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + + + + +
auto gridfire::reaction::TemplatedReactionSet< ReactionT >::begin ()
+ 		+inline
+
+ +

Definition at line 525 of file reaction.h.

+ +
+
+ +

◆ begin() [2/2]

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + + + + +
auto gridfire::reaction::TemplatedReactionSet< ReactionT >::begin () const
+ 		+inlinenodiscard
+
+ +

Definition at line 526 of file reaction.h.

+ +
+
+ +

◆ clear()

+ +
+
+
+template<typename ReactionT>
+ + + + + + + +
void gridfire::reaction::TemplatedReactionSet< ReactionT >::clear ()
+
+ +

Removes all reactions from the set.

+ +

Definition at line 640 of file reaction.h.

+ +
+
+ +

◆ contains() [1/2]

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + + + + +
bool gridfire::reaction::TemplatedReactionSet< ReactionT >::contains (const Reaction & reaction) const
+ 		+nodiscard
+
+ +

Checks if the set contains the given reaction.

+
Parameters
+ + +
reactionThe Reaction to find.
+
+
+
Returns
True if the reaction is in the set, false otherwise.
+ +

Definition at line 630 of file reaction.h.

+ +
+
+ +

◆ contains() [2/2]

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + + + + +
bool gridfire::reaction::TemplatedReactionSet< ReactionT >::contains (const std::string_view & id) const
+ 		+nodiscard
+
+ +

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

Definition at line 620 of file reaction.h.

+ +
+
+ +

◆ contains_product()

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + + + + +
bool gridfire::reaction::TemplatedReactionSet< ReactionT >::contains_product (const fourdst::atomic::Species & species) const
+ 		+nodiscard
+
+ +

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

Definition at line 666 of file reaction.h.

+ +
+
+ +

◆ contains_reactant()

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + + + + +
bool gridfire::reaction::TemplatedReactionSet< ReactionT >::contains_reactant (const fourdst::atomic::Species & species) const
+ 		+nodiscard
+
+ +

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

Definition at line 656 of file reaction.h.

+ +
+
+ +

◆ contains_species()

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + + + + +
bool gridfire::reaction::TemplatedReactionSet< ReactionT >::contains_species (const fourdst::atomic::Species & species) const
+ 		+nodiscard
+
+ +

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

Definition at line 646 of file reaction.h.

+ +
+
+ +

◆ end() [1/2]

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + + + + +
auto gridfire::reaction::TemplatedReactionSet< ReactionT >::end ()
+ 		+inline
+
+ +

Definition at line 527 of file reaction.h.

+ +
+
+ +

◆ end() [2/2]

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + + + + +
auto gridfire::reaction::TemplatedReactionSet< ReactionT >::end () const
+ 		+inlinenodiscard
+
+ +

Definition at line 528 of file reaction.h.

+ +
+
+ +

◆ getReactionSetSpecies()

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + + + + +
std::unordered_set< fourdst::atomic::Species > gridfire::reaction::TemplatedReactionSet< ReactionT >::getReactionSetSpecies () const
+ 		+nodiscard
+
+ +

Definition at line 725 of file reaction.h.

+ +
+
+ +

◆ hash()

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + + + + +
uint64_t gridfire::reaction::TemplatedReactionSet< ReactionT >::hash (uint64_t seed = 0) const
+ 		+nodiscard
+
+ +

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.

+ +

Definition at line 707 of file reaction.h.

+ +
+
+ +

◆ operator!=()

+ +
+
+
+template<typename ReactionT>
+ + + + + + + +
bool gridfire::reaction::TemplatedReactionSet< ReactionT >::operator!= (const TemplatedReactionSet< ReactionT > & other) const
+
+ +

Compares this set with another for inequality.

+
Parameters
+ + +
otherThe other ReactionSet to compare with.
+
+
+
Returns
True if the sets are not equal.
+ +

Definition at line 702 of file reaction.h.

+ +
+
+ +

◆ operator=()

+ +
+
+
+template<typename ReactionT>
+ + + + + + + +
TemplatedReactionSet< ReactionT > & gridfire::reaction::TemplatedReactionSet< ReactionT >::operator= (const TemplatedReactionSet< ReactionT > & other)
+
+ +

Copy assignment operator.

+
Parameters
+ + +
otherThe ReactionSet to assign from.
+
+
+
Returns
A reference to this ReactionSet.
+ +

Definition at line 590 of file reaction.h.

+ +
+
+ +

◆ operator==()

+ +
+
+
+template<typename ReactionT>
+ + + + + + + +
bool gridfire::reaction::TemplatedReactionSet< ReactionT >::operator== (const TemplatedReactionSet< ReactionT > & 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).
+ +

Definition at line 694 of file reaction.h.

+ +
+
+ +

◆ operator[]() [1/2]

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + + + + +
const ReactionT & gridfire::reaction::TemplatedReactionSet< ReactionT >::operator[] (const std::string_view & id) const
+ 		+nodiscard
+
+ +

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

Definition at line 685 of file reaction.h.

+ +
+
+ +

◆ operator[]() [2/2]

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + + + + +
const ReactionT & gridfire::reaction::TemplatedReactionSet< ReactionT >::operator[] (size_t index) const
+ 		+nodiscard
+
+ +

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

Definition at line 676 of file reaction.h.

+ +
+
+ +

◆ remove_reaction()

+ +
+
+
+template<typename ReactionT>
+ + + + + + + +
void gridfire::reaction::TemplatedReactionSet< ReactionT >::remove_reaction (const ReactionT & reaction)
+
+ +

Removes a reaction from the set.

+
Parameters
+ + +
reactionThe Reaction to remove.
+
+
+ +

Definition at line 607 of file reaction.h.

+ +
+
+ +

◆ size()

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + + + + +
size_t gridfire::reaction::TemplatedReactionSet< ReactionT >::size () const
+ 		+inlinenodiscard
+
+ +

Gets the number of reactions in the set.

+
Returns
The size of the set.
+ +

Definition at line 453 of file reaction.h.

+ +
+
+

Friends And Related Symbol Documentation

+ +

◆ operator<<

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + + + + + + + + +
std::ostream & operator<< (std::ostream & os,
const TemplatedReactionSet< ReactionT > & r )
+ 		+friend
+
+ +

Definition at line 531 of file reaction.h.

+ +
+
+

Member Data Documentation

+ +

◆ m_id

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + +
std::string gridfire::reaction::TemplatedReactionSet< ReactionT >::m_id
+ 		+private
+
+ +

Definition at line 551 of file reaction.h.

+ +
+
+ +

◆ m_logger

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + +
quill::Logger* gridfire::reaction::TemplatedReactionSet< ReactionT >::m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
+ 		+private
+
+ +

Definition at line 549 of file reaction.h.

+ +
+
+ +

◆ m_reactionNameMap

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + +
std::unordered_map<std::string, ReactionT> gridfire::reaction::TemplatedReactionSet< ReactionT >::m_reactionNameMap
+ 		+private
+
+ +

Maps reaction IDs to Reaction objects for quick lookup.

+ +

Definition at line 552 of file reaction.h.

+ +
+
+ +

◆ m_reactions

+ +
+
+
+template<typename ReactionT>
+ + + + + +
+ + + + +
std::vector<ReactionT> gridfire::reaction::TemplatedReactionSet< ReactionT >::m_reactions
+ 		+private
+
+ +

Definition at line 550 of file reaction.h.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1reaction_1_1_templated_reaction_set.js b/docs/html/classgridfire_1_1reaction_1_1_templated_reaction_set.js new file mode 100644 index 00000000..ec45d04e --- /dev/null +++ b/docs/html/classgridfire_1_1reaction_1_1_templated_reaction_set.js @@ -0,0 +1,30 @@ +var classgridfire_1_1reaction_1_1_templated_reaction_set = +[ + [ "TemplatedReactionSet", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#a54c8cd7c34564277fe28eefc623f666e", null ], + [ "TemplatedReactionSet", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#ada1d1880be53b81a9ed7b966fd6ade5a", null ], + [ "add_reaction", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#a339dbbf883b6ae20e33d9782d8376bcf", null ], + [ "begin", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#a87257704009fcd57b553f86cdaacb597", null ], + [ "begin", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#aee42bb25973dadc6629bdb5cb1db6369", null ], + [ "clear", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#a05f71d318564d880079fd6c96d59ae21", null ], + [ "contains", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#ab8cb5fbce6b819b9e4e44b0c2db54c6f", null ], + [ "contains", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#a7777ecd0f594fdf66ce57d22610fad3c", null ], + [ "contains_product", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#a443ec5d7138764b32975232e13071ccf", null ], + [ "contains_reactant", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#ac42606350d7557106f7954b1f114c128", null ], + [ "contains_species", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#ad870856d206d93f27125c88d44ff9e34", null ], + [ "end", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#ad19adbee44a71559a53785e3b1fc7e92", null ], + [ "end", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#ac128da7417955ef8c5cb2bde5a1293c9", null ], + [ "getReactionSetSpecies", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#a1596de3439735a45ac344fa85ace6c82", null ], + [ "hash", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#a272800016c83f259f5c6a92dc797353c", null ], + [ "operator!=", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#aac76ec883b4ecebb2a94b2485dae7105", null ], + [ "operator=", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#ac510dce14a6033551318c0c7b241f3c8", null ], + [ "operator==", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#a128660f5fbc67054f73811ed2982d24d", null ], + [ "operator[]", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#a13e003529a17fa61aafdce3abd2dc773", null ], + [ "operator[]", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#a638067a3e55ec2a422206055881aaaad", null ], + [ "remove_reaction", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#a89c4c5af12aef7fbfc24316c88237e22", null ], + [ "size", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#a6a1dc3c56690386ae9f6aa5c2aa37ba2", null ], + [ "operator<<", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#a47265467dbf2c324ce3e4c85ebbaa6a7", null ], + [ "m_id", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#a5fda3af5ea9ae0ecfb60a61a9e07f5b4", null ], + [ "m_logger", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#ac6fcc5b08938b73ff6dac680e5bf28d9", null ], + [ "m_reactionNameMap", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#a3a4c2448865580001fd3c797b9f56979", null ], + [ "m_reactions", "classgridfire_1_1reaction_1_1_templated_reaction_set.html#a5962968fe478c79250e9d88d80a87600", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1screening_1_1_bare_screening_model-members.html b/docs/html/classgridfire_1_1screening_1_1_bare_screening_model-members.html new file mode 100644 index 00000000..04fb6dcf --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1_bare_screening_model-members.html @@ -0,0 +1,122 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
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::LogicalReactionSet &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::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, const double T9, const double rho) const overridegridfire::screening::BareScreeningModelvirtual
calculateScreeningFactors(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< ADDouble > &Y, const ADDouble T9, const ADDouble rho) const overridegridfire::screening::BareScreeningModelvirtual
~ScreeningModel()=defaultgridfire::screening::ScreeningModelvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1screening_1_1_bare_screening_model.html b/docs/html/classgridfire_1_1screening_1_1_bare_screening_model.html new file mode 100644 index 00000000..46036586 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1_bare_screening_model.html @@ -0,0 +1,336 @@ + + + + + + + +GridFire: gridfire::screening::BareScreeningModel Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
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
+
+
+ +

#include <screening_bare.h>

+
+Inheritance diagram for gridfire::screening::BareScreeningModel:
+
+
+ + +gridfire::screening::ScreeningModel + +
+ + + + + + + + + +

+Public Member Functions

std::vector< double > calculateScreeningFactors (const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, const double T9, const double rho) const override
 
std::vector< ADDouble > calculateScreeningFactors (const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< ADDouble > &Y, const ADDouble T9, const ADDouble rho) const override
 
- Public Member Functions inherited from gridfire::screening::ScreeningModel
virtual ~ScreeningModel ()=default
 
+ + + +

+Private Types

using ADDouble = CppAD::AD<double>
 
+ + + + +

+Private Member Functions

template<typename T>
std::vector< T > calculateFactors_impl (const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< T > &Y, const T T9, const T rho) const
 
+ + + + +

+Additional Inherited Members

- Public Types inherited from gridfire::screening::ScreeningModel
using ADDouble = CppAD::AD<double>
 
+

Detailed Description

+
+

Definition at line 9 of file screening_bare.h.

+

Member Typedef Documentation

+ +

◆ ADDouble

+ +
+
+ + + + + +
+ + + + +
using gridfire::screening::BareScreeningModel::ADDouble = CppAD::AD<double>
+ 		+private
+
+ +

Definition at line 10 of file screening_bare.h.

+ +
+
+

Member Function Documentation

+ +

◆ calculateFactors_impl()

+ +
+
+
+template<typename T>
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< T > gridfire::screening::BareScreeningModel::calculateFactors_impl (const reaction::LogicalReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< T > & Y,
const T T9,
const T rho ) const
+ 		+nodiscardprivate
+
+ +

Definition at line 39 of file screening_bare.h.

+ +
+
+ +

◆ calculateScreeningFactors() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< ADDouble > gridfire::screening::BareScreeningModel::calculateScreeningFactors (const reaction::LogicalReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< ADDouble > & Y,
const ADDouble T9,
const ADDouble rho ) const
+ 		+nodiscardoverridevirtual
+
+ +

Implements gridfire::screening::ScreeningModel.

+ +

Definition at line 12 of file screening_bare.cpp.

+ +
+
+ +

◆ calculateScreeningFactors() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< double > gridfire::screening::BareScreeningModel::calculateScreeningFactors (const reaction::LogicalReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< double > & Y,
const double T9,
const double rho ) const
+ 		+nodiscardoverridevirtual
+
+ +

Implements gridfire::screening::ScreeningModel.

+ +

Definition at line 22 of file screening_bare.cpp.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1screening_1_1_bare_screening_model.js b/docs/html/classgridfire_1_1screening_1_1_bare_screening_model.js new file mode 100644 index 00000000..bfbf4a65 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1_bare_screening_model.js @@ -0,0 +1,7 @@ +var classgridfire_1_1screening_1_1_bare_screening_model = +[ + [ "ADDouble", "classgridfire_1_1screening_1_1_bare_screening_model.html#a51119d705267e0b415aae8b4881d8c96", null ], + [ "calculateFactors_impl", "classgridfire_1_1screening_1_1_bare_screening_model.html#a6c93b72c8ca34623127f0846d8dee50a", null ], + [ "calculateScreeningFactors", "classgridfire_1_1screening_1_1_bare_screening_model.html#ac5647d633cd5bbd7cb5136b7fa4cad99", null ], + [ "calculateScreeningFactors", "classgridfire_1_1screening_1_1_bare_screening_model.html#ac35ad34c5da7e1b5087552aa5c83fe60", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1screening_1_1_bare_screening_model.png b/docs/html/classgridfire_1_1screening_1_1_bare_screening_model.png new file mode 100644 index 00000000..08ac1ec9 Binary files /dev/null and b/docs/html/classgridfire_1_1screening_1_1_bare_screening_model.png differ diff --git a/docs/html/classgridfire_1_1screening_1_1_screening_model-members.html b/docs/html/classgridfire_1_1screening_1_1_screening_model-members.html new file mode 100644 index 00000000..c80f9fd8 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1_screening_model-members.html @@ -0,0 +1,121 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
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::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, const double T9, const double rho) const =0gridfire::screening::ScreeningModelpure virtual
calculateScreeningFactors(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< ADDouble > &Y, const ADDouble T9, const ADDouble rho) const =0gridfire::screening::ScreeningModelpure virtual
~ScreeningModel()=defaultgridfire::screening::ScreeningModelvirtual
+
+ + + + diff --git a/docs/html/classgridfire_1_1screening_1_1_screening_model.html b/docs/html/classgridfire_1_1screening_1_1_screening_model.html new file mode 100644 index 00000000..c6e84cc4 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1_screening_model.html @@ -0,0 +1,288 @@ + + + + + + + +GridFire: gridfire::screening::ScreeningModel Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Types | +Public Member Functions | +List of all members
+
gridfire::screening::ScreeningModel Class Referenceabstract
+
+
+ +

#include <screening_abstract.h>

+
+Inheritance diagram for gridfire::screening::ScreeningModel:
+
+
+ + +gridfire::screening::BareScreeningModel +gridfire::screening::WeakScreeningModel + +
+ + + + +

+Public Types

using ADDouble = CppAD::AD<double>
 
+ + + + + + + +

+Public Member Functions

virtual ~ScreeningModel ()=default
 
virtual std::vector< double > calculateScreeningFactors (const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, const double T9, const double rho) const =0
 
virtual std::vector< ADDouble > calculateScreeningFactors (const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< ADDouble > &Y, const ADDouble T9, const ADDouble rho) const =0
 
+

Detailed Description

+
+

Definition at line 12 of file screening_abstract.h.

+

Member Typedef Documentation

+ +

◆ ADDouble

+ +
+
+ + + + +
using gridfire::screening::ScreeningModel::ADDouble = CppAD::AD<double>
+
+ +

Definition at line 14 of file screening_abstract.h.

+ +
+
+

Constructor & Destructor Documentation

+ +

◆ ~ScreeningModel()

+ +
+
+ + + + + +
+ + + + + + + +
virtual gridfire::screening::ScreeningModel::~ScreeningModel ()
+ 		+virtualdefault
+
+ +
+
+

Member Function Documentation

+ +

◆ calculateScreeningFactors() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual std::vector< ADDouble > gridfire::screening::ScreeningModel::calculateScreeningFactors (const reaction::LogicalReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< ADDouble > & Y,
const ADDouble T9,
const ADDouble rho ) const
+ 		+pure virtual
+
+ +

Implemented in gridfire::screening::BareScreeningModel, and gridfire::screening::WeakScreeningModel.

+ +
+
+ +

◆ calculateScreeningFactors() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual std::vector< double > gridfire::screening::ScreeningModel::calculateScreeningFactors (const reaction::LogicalReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< double > & Y,
const double T9,
const double rho ) const
+ 		+pure virtual
+
+ +

Implemented in gridfire::screening::BareScreeningModel, and gridfire::screening::WeakScreeningModel.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1screening_1_1_screening_model.js b/docs/html/classgridfire_1_1screening_1_1_screening_model.js new file mode 100644 index 00000000..302ffe74 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1_screening_model.js @@ -0,0 +1,7 @@ +var classgridfire_1_1screening_1_1_screening_model = +[ + [ "ADDouble", "classgridfire_1_1screening_1_1_screening_model.html#a107ff2897f040d6f27f69d56a0bdd28d", null ], + [ "~ScreeningModel", "classgridfire_1_1screening_1_1_screening_model.html#adef175acdbd911527f56a1f1592579a7", null ], + [ "calculateScreeningFactors", "classgridfire_1_1screening_1_1_screening_model.html#a6c381a823cb9c1680d3e9c846da4ae22", null ], + [ "calculateScreeningFactors", "classgridfire_1_1screening_1_1_screening_model.html#aaec9184d80c86a2d8674e395dad81bde", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1screening_1_1_screening_model.png b/docs/html/classgridfire_1_1screening_1_1_screening_model.png new file mode 100644 index 00000000..d01d3b69 Binary files /dev/null and b/docs/html/classgridfire_1_1screening_1_1_screening_model.png differ diff --git a/docs/html/classgridfire_1_1screening_1_1_weak_screening_model-members.html b/docs/html/classgridfire_1_1screening_1_1_weak_screening_model-members.html new file mode 100644 index 00000000..77fffb61 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1_weak_screening_model-members.html @@ -0,0 +1,123 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
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::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< T > &Y, const T T9, const T rho) constgridfire::screening::WeakScreeningModelprivate
calculateScreeningFactors(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, const double T9, const double rho) const overridegridfire::screening::WeakScreeningModelvirtual
calculateScreeningFactors(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< CppAD::AD< double > > &Y, const CppAD::AD< double > T9, const 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_1_weak_screening_model.html b/docs/html/classgridfire_1_1screening_1_1_weak_screening_model.html new file mode 100644 index 00000000..248e16e8 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1_weak_screening_model.html @@ -0,0 +1,336 @@ + + + + + + + +GridFire: gridfire::screening::WeakScreeningModel Class Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
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
+
+
+ +

#include <screening_weak.h>

+
+Inheritance diagram for gridfire::screening::WeakScreeningModel:
+
+
+ + +gridfire::screening::ScreeningModel + +
+ + + + + + + + + +

+Public Member Functions

std::vector< double > calculateScreeningFactors (const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, const double T9, const double rho) const override
 
std::vector< CppAD::AD< double > > calculateScreeningFactors (const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< CppAD::AD< double > > &Y, const CppAD::AD< double > T9, const CppAD::AD< double > rho) const override
 
- Public Member Functions inherited from gridfire::screening::ScreeningModel
virtual ~ScreeningModel ()=default
 
+ + + + +

+Private Member Functions

template<typename T>
std::vector< T > calculateFactors_impl (const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< T > &Y, const T T9, const T rho) const
 
+ + + +

+Private Attributes

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

+Additional Inherited Members

- Public Types inherited from gridfire::screening::ScreeningModel
using ADDouble = CppAD::AD<double>
 
+

Detailed Description

+
+

Definition at line 13 of file screening_weak.h.

+

Member Function Documentation

+ +

◆ calculateFactors_impl()

+ +
+
+
+template<typename T>
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< T > gridfire::screening::WeakScreeningModel::calculateFactors_impl (const reaction::LogicalReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< T > & Y,
const T T9,
const T rho ) const
+ 		+nodiscardprivate
+
+ +

Definition at line 45 of file screening_weak.h.

+ +
+
+ +

◆ calculateScreeningFactors() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< ADDouble > gridfire::screening::WeakScreeningModel::calculateScreeningFactors (const reaction::LogicalReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< CppAD::AD< double > > & Y,
const CppAD::AD< double > T9,
const CppAD::AD< double > rho ) const
+ 		+nodiscardoverridevirtual
+
+ +

Implements gridfire::screening::ScreeningModel.

+ +

Definition at line 12 of file screening_weak.cpp.

+ +
+
+ +

◆ calculateScreeningFactors() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
std::vector< double > gridfire::screening::WeakScreeningModel::calculateScreeningFactors (const reaction::LogicalReactionSet & reactions,
const std::vector< fourdst::atomic::Species > & species,
const std::vector< double > & Y,
const double T9,
const double rho ) const
+ 		+nodiscardoverridevirtual
+
+ +

Implements gridfire::screening::ScreeningModel.

+ +

Definition at line 22 of file screening_weak.cpp.

+ +
+
+

Member Data Documentation

+ +

◆ m_logger

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

Definition at line 31 of file screening_weak.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/html/classgridfire_1_1screening_1_1_weak_screening_model.js b/docs/html/classgridfire_1_1screening_1_1_weak_screening_model.js new file mode 100644 index 00000000..35f16253 --- /dev/null +++ b/docs/html/classgridfire_1_1screening_1_1_weak_screening_model.js @@ -0,0 +1,7 @@ +var classgridfire_1_1screening_1_1_weak_screening_model = +[ + [ "calculateFactors_impl", "classgridfire_1_1screening_1_1_weak_screening_model.html#a2695206d46b9d2c2503f8e58c44df88f", null ], + [ "calculateScreeningFactors", "classgridfire_1_1screening_1_1_weak_screening_model.html#ac6bc78769670a460af1ff88284cb8ad4", null ], + [ "calculateScreeningFactors", "classgridfire_1_1screening_1_1_weak_screening_model.html#afbaeaefe6b3ab3ecf81889ddc1cff76c", null ], + [ "m_logger", "classgridfire_1_1screening_1_1_weak_screening_model.html#a0a4d7d6d36dbe7b764b613d34f18386f", null ] +]; \ No newline at end of file diff --git a/docs/html/classgridfire_1_1screening_1_1_weak_screening_model.png b/docs/html/classgridfire_1_1screening_1_1_weak_screening_model.png new file mode 100644 index 00000000..0f3c7047 Binary files /dev/null and b/docs/html/classgridfire_1_1screening_1_1_weak_screening_model.png differ diff --git a/docs/html/dir_0cbec3bc536a3e05d15a7545c8625ac1.html b/docs/html/dir_0cbec3bc536a3e05d15a7545c8625ac1.html new file mode 100644 index 00000000..6880854d --- /dev/null +++ b/docs/html/dir_0cbec3bc536a3e05d15a7545c8625ac1.html @@ -0,0 +1,121 @@ + + + + + + + +GridFire: src/network/include/gridfire/utils Directory Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
utils Directory Reference
+
+
+ + + + +

+Files

 logging.h
 
+
+
+ + + + diff --git a/docs/html/dir_0cbec3bc536a3e05d15a7545c8625ac1.js b/docs/html/dir_0cbec3bc536a3e05d15a7545c8625ac1.js new file mode 100644 index 00000000..314924ac --- /dev/null +++ b/docs/html/dir_0cbec3bc536a3e05d15a7545c8625ac1.js @@ -0,0 +1,4 @@ +var dir_0cbec3bc536a3e05d15a7545c8625ac1 = +[ + [ "logging.h", "logging_8h.html", "logging_8h" ] +]; \ No newline at end of file diff --git a/docs/html/dir_2d53942b5372593aa67f4b74882cd581.html b/docs/html/dir_2d53942b5372593aa67f4b74882cd581.html new file mode 100644 index 00000000..ebd40772 --- /dev/null +++ b/docs/html/dir_2d53942b5372593aa67f4b74882cd581.html @@ -0,0 +1,121 @@ + + + + + + + +GridFire: src/network/lib/io Directory Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
io Directory Reference
+
+
+ + + + +

+Files

 network_file.cpp
 
+
+
+ + + + diff --git a/docs/html/dir_2d53942b5372593aa67f4b74882cd581.js b/docs/html/dir_2d53942b5372593aa67f4b74882cd581.js new file mode 100644 index 00000000..de661cbd --- /dev/null +++ b/docs/html/dir_2d53942b5372593aa67f4b74882cd581.js @@ -0,0 +1,4 @@ +var dir_2d53942b5372593aa67f4b74882cd581 = +[ + [ "network_file.cpp", "network__file_8cpp.html", null ] +]; \ No newline at end of file diff --git a/docs/html/dir_41ae00bf8f9a98ba9c6aece2e6262882.html b/docs/html/dir_41ae00bf8f9a98ba9c6aece2e6262882.html new file mode 100644 index 00000000..ff097e26 --- /dev/null +++ b/docs/html/dir_41ae00bf8f9a98ba9c6aece2e6262882.html @@ -0,0 +1,121 @@ + + + + + + + +GridFire: src/network/include/gridfire/io Directory Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
io Directory Reference
+
+
+ + + + +

+Files

 network_file.h
 
+
+
+ + + + diff --git a/docs/html/dir_41ae00bf8f9a98ba9c6aece2e6262882.js b/docs/html/dir_41ae00bf8f9a98ba9c6aece2e6262882.js new file mode 100644 index 00000000..46387c39 --- /dev/null +++ b/docs/html/dir_41ae00bf8f9a98ba9c6aece2e6262882.js @@ -0,0 +1,4 @@ +var dir_41ae00bf8f9a98ba9c6aece2e6262882 = +[ + [ "network_file.h", "network__file_8h.html", "network__file_8h" ] +]; \ No newline at end of file diff --git a/docs/html/dir_52d70f305d86d4a2338c5425f7bc4d9c.html b/docs/html/dir_52d70f305d86d4a2338c5425f7bc4d9c.html new file mode 100644 index 00000000..a2cbea77 --- /dev/null +++ b/docs/html/dir_52d70f305d86d4a2338c5425f7bc4d9c.html @@ -0,0 +1,125 @@ + + + + + + + +GridFire: src/network/lib/screening Directory Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
screening Directory Reference
+
+
+ + + + + + + + +

+Files

 screening_bare.cpp
 
 screening_types.cpp
 
 screening_weak.cpp
 
+
+
+ + + + diff --git a/docs/html/dir_52d70f305d86d4a2338c5425f7bc4d9c.js b/docs/html/dir_52d70f305d86d4a2338c5425f7bc4d9c.js new file mode 100644 index 00000000..58f44373 --- /dev/null +++ b/docs/html/dir_52d70f305d86d4a2338c5425f7bc4d9c.js @@ -0,0 +1,6 @@ +var dir_52d70f305d86d4a2338c5425f7bc4d9c = +[ + [ "screening_bare.cpp", "screening__bare_8cpp.html", "screening__bare_8cpp" ], + [ "screening_types.cpp", "screening__types_8cpp.html", "screening__types_8cpp" ], + [ "screening_weak.cpp", "screening__weak_8cpp.html", null ] +]; \ No newline at end of file diff --git a/docs/html/dir_a1a1065684fbb5b386566d81dc65d72d.html b/docs/html/dir_a1a1065684fbb5b386566d81dc65d72d.html new file mode 100644 index 00000000..a551b6c3 --- /dev/null +++ b/docs/html/dir_a1a1065684fbb5b386566d81dc65d72d.html @@ -0,0 +1,127 @@ + + + + + + + +GridFire: src/network/include/gridfire/screening Directory Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
screening Directory Reference
+
+
+ + + + + + + + + + +

+Files

 screening_abstract.h
 
 screening_bare.h
 
 screening_types.h
 
 screening_weak.h
 
+
+
+ + + + diff --git a/docs/html/dir_a1a1065684fbb5b386566d81dc65d72d.js b/docs/html/dir_a1a1065684fbb5b386566d81dc65d72d.js new file mode 100644 index 00000000..35ccae62 --- /dev/null +++ b/docs/html/dir_a1a1065684fbb5b386566d81dc65d72d.js @@ -0,0 +1,7 @@ +var dir_a1a1065684fbb5b386566d81dc65d72d = +[ + [ "screening_abstract.h", "screening__abstract_8h.html", "screening__abstract_8h" ], + [ "screening_bare.h", "screening__bare_8h.html", "screening__bare_8h" ], + [ "screening_types.h", "screening__types_8h.html", "screening__types_8h" ], + [ "screening_weak.h", "screening__weak_8h.html", "screening__weak_8h" ] +]; \ No newline at end of file diff --git a/docs/html/dir_ae72e87b2c96ef2ff3f9c3faf556f8b7.html b/docs/html/dir_ae72e87b2c96ef2ff3f9c3faf556f8b7.html new file mode 100644 index 00000000..83fefc80 --- /dev/null +++ b/docs/html/dir_ae72e87b2c96ef2ff3f9c3faf556f8b7.html @@ -0,0 +1,123 @@ + + + + + + + +GridFire: src/network/lib/engine/views Directory Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
views Directory Reference
+
+
+ + + + + + +

+Files

 engine_adaptive.cpp
 
 engine_defined.cpp
 
+
+
+ + + + diff --git a/docs/html/dir_ae72e87b2c96ef2ff3f9c3faf556f8b7.js b/docs/html/dir_ae72e87b2c96ef2ff3f9c3faf556f8b7.js new file mode 100644 index 00000000..f6a4f026 --- /dev/null +++ b/docs/html/dir_ae72e87b2c96ef2ff3f9c3faf556f8b7.js @@ -0,0 +1,5 @@ +var dir_ae72e87b2c96ef2ff3f9c3faf556f8b7 = +[ + [ "engine_adaptive.cpp", "engine__adaptive_8cpp.html", null ], + [ "engine_defined.cpp", "engine__defined_8cpp.html", null ] +]; \ No newline at end of file diff --git a/docs/html/dir_d95b5b8e5cbbc1b508cb3c0cf16f7ce7.html b/docs/html/dir_d95b5b8e5cbbc1b508cb3c0cf16f7ce7.html new file mode 100644 index 00000000..dc808bf6 --- /dev/null +++ b/docs/html/dir_d95b5b8e5cbbc1b508cb3c0cf16f7ce7.html @@ -0,0 +1,121 @@ + + + + + + + +GridFire: src/network/lib/utils Directory Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
utils Directory Reference
+
+
+ + + + +

+Files

 logging.cpp
 
+
+
+ + + + diff --git a/docs/html/dir_d95b5b8e5cbbc1b508cb3c0cf16f7ce7.js b/docs/html/dir_d95b5b8e5cbbc1b508cb3c0cf16f7ce7.js new file mode 100644 index 00000000..79d453ca --- /dev/null +++ b/docs/html/dir_d95b5b8e5cbbc1b508cb3c0cf16f7ce7.js @@ -0,0 +1,4 @@ +var dir_d95b5b8e5cbbc1b508cb3c0cf16f7ce7 = +[ + [ "logging.cpp", "logging_8cpp.html", null ] +]; \ No newline at end of file diff --git a/docs/html/dir_fb341b7e674a7e4701415d4572cba12f.html b/docs/html/dir_fb341b7e674a7e4701415d4572cba12f.html new file mode 100644 index 00000000..111b9fea --- /dev/null +++ b/docs/html/dir_fb341b7e674a7e4701415d4572cba12f.html @@ -0,0 +1,126 @@ + + + + + + + +GridFire: src/network/include/gridfire/engine/views Directory Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
views Directory Reference
+
+
+ + + + + + + + + +

+Files

 engine_adaptive.h
 
 engine_defined.h
 
 engine_view_abstract.h
 Abstract interfaces for engine "views" in GridFire.
 
+
+
+ + + + diff --git a/docs/html/dir_fb341b7e674a7e4701415d4572cba12f.js b/docs/html/dir_fb341b7e674a7e4701415d4572cba12f.js new file mode 100644 index 00000000..d2d263ae --- /dev/null +++ b/docs/html/dir_fb341b7e674a7e4701415d4572cba12f.js @@ -0,0 +1,6 @@ +var dir_fb341b7e674a7e4701415d4572cba12f = +[ + [ "engine_adaptive.h", "engine__adaptive_8h.html", "engine__adaptive_8h" ], + [ "engine_defined.h", "engine__defined_8h.html", "engine__defined_8h" ], + [ "engine_view_abstract.h", "engine__view__abstract_8h.html", "engine__view__abstract_8h" ] +]; \ No newline at end of file diff --git a/docs/html/engine__defined_8cpp.html b/docs/html/engine__defined_8cpp.html new file mode 100644 index 00000000..36fd850c --- /dev/null +++ b/docs/html/engine__defined_8cpp.html @@ -0,0 +1,127 @@ + + + + + + + +GridFire: src/network/lib/engine/views/engine_defined.cpp File Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Namespaces
+
engine_defined.cpp File Reference
+
+
+
#include "gridfire/engine/views/engine_defined.h"
+#include "quill/LogMacros.h"
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

namespace  gridfire
 
+
+
+ + + + diff --git a/docs/html/engine__defined_8cpp_source.html b/docs/html/engine__defined_8cpp_source.html new file mode 100644 index 00000000..5ac0b1fd --- /dev/null +++ b/docs/html/engine__defined_8cpp_source.html @@ -0,0 +1,515 @@ + + + + + + + +GridFire: src/network/lib/engine/views/engine_defined.cpp Source File + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
engine_defined.cpp
+
+
+Go to the documentation of this file.
1#include "gridfire/engine/views/engine_defined.h"
+
2
+
3#include "quill/LogMacros.h"
+
4
+
5namespace gridfire {
+
6 using fourdst::atomic::Species;
+
7
+
+
8 FileDefinedEngineView::FileDefinedEngineView(
+
9 DynamicEngine &baseEngine,
+
10 const std::string &fileName,
+
11 const io::NetworkFileParser &parser
+
12 ):
+
13 m_baseEngine(baseEngine),
+
14 m_fileName(fileName),
+
15 m_parser(parser),
+
16 m_activeSpecies(baseEngine.getNetworkSpecies()),
+
17 m_activeReactions(baseEngine.getNetworkReactions()) {
+
18 buildFromFile(fileName);
+
19 }
+
+
20
+
+
21 const DynamicEngine & FileDefinedEngineView::getBaseEngine() const {
+
22 return m_baseEngine;
+
23 }
+
+
24
+
+
25 const std::vector<Species> & FileDefinedEngineView::getNetworkSpecies() const {
+
26 return m_activeSpecies;
+
27 }
+
+
28
+
+
29 StepDerivatives<double> FileDefinedEngineView::calculateRHSAndEnergy(
+
30 const std::vector<double> &Y_defined,
+
31 const double T9,
+
32 const double rho
+
33 ) const {
+
34 validateNetworkState();
+
35
+
36 const auto Y_full = mapViewToFull(Y_defined);
+
37 const auto [dydt, nuclearEnergyGenerationRate] = m_baseEngine.calculateRHSAndEnergy(Y_full, T9, rho);
+
38
+
39 StepDerivatives<double> definedResults;
+
40 definedResults.nuclearEnergyGenerationRate = nuclearEnergyGenerationRate;
+
41 definedResults.dydt = mapFullToView(dydt);
+
42 return definedResults;
+
43 }
+
+
44
+
+
45 void FileDefinedEngineView::generateJacobianMatrix(
+
46 const std::vector<double> &Y_defined,
+
47 const double T9,
+
48 const double rho
+
49 ) {
+
50 validateNetworkState();
+
51
+
52 const auto Y_full = mapViewToFull(Y_defined);
+
53 m_baseEngine.generateJacobianMatrix(Y_full, T9, rho);
+
54 }
+
+
55
+
+
56 double FileDefinedEngineView::getJacobianMatrixEntry(
+
57 const int i_defined,
+
58 const int j_defined
+
59 ) const {
+
60 validateNetworkState();
+
61
+
62 const size_t i_full = mapViewToFullSpeciesIndex(i_defined);
+
63 const size_t j_full = mapViewToFullSpeciesIndex(j_defined);
+
64
+
65 return m_baseEngine.getJacobianMatrixEntry(i_full, j_full);
+
66 }
+
+
67
+
+
68 void FileDefinedEngineView::generateStoichiometryMatrix() {
+
69 validateNetworkState();
+
70
+
71 m_baseEngine.generateStoichiometryMatrix();
+
72 }
+
+
73
+
+
74 int FileDefinedEngineView::getStoichiometryMatrixEntry(
+
75 const int speciesIndex_defined,
+
76 const int reactionIndex_defined
+
77 ) const {
+
78 validateNetworkState();
+
79
+
80 const size_t i_full = mapViewToFullSpeciesIndex(speciesIndex_defined);
+
81 const size_t j_full = mapViewToFullReactionIndex(reactionIndex_defined);
+
82 return m_baseEngine.getStoichiometryMatrixEntry(i_full, j_full);
+
83 }
+
+
84
+
+
85 double FileDefinedEngineView::calculateMolarReactionFlow(
+
86 const reaction::Reaction &reaction,
+
87 const std::vector<double> &Y_defined,
+
88 const double T9,
+
89 const double rho
+
90 ) const {
+
91 validateNetworkState();
+
92
+
93 if (!m_activeReactions.contains(reaction)) {
+
94 LOG_ERROR(m_logger, "Reaction '{}' is not part of the active reactions in the file defined engine view.", reaction.id());
+
95 m_logger -> flush_log();
+
96 throw std::runtime_error("Reaction not found in active reactions: " + std::string(reaction.id()));
+
97 }
+
98 const auto Y_full = mapViewToFull(Y_defined);
+
99 return m_baseEngine.calculateMolarReactionFlow(reaction, Y_full, T9, rho);
+
100 }
+
+
101
+ +
107
+
+
108 std::unordered_map<Species, double> FileDefinedEngineView::getSpeciesTimescales(
+
109 const std::vector<double> &Y_defined,
+
110 const double T9,
+
111 const double rho
+
112 ) const {
+
113 validateNetworkState();
+
114
+
115 const auto Y_full = mapViewToFull(Y_defined);
+
116 const auto fullTimescales = m_baseEngine.getSpeciesTimescales(Y_full, T9, rho);
+
117
+
118 std::unordered_map<Species, double> definedTimescales;
+
119 for (const auto& active_species : m_activeSpecies) {
+
120 if (fullTimescales.contains(active_species)) {
+
121 definedTimescales[active_species] = fullTimescales.at(active_species);
+
122 }
+
123 }
+
124 return definedTimescales;
+
125 }
+
+
126
+
+
127 void FileDefinedEngineView::update(const NetIn &netIn) {
+
128 if (m_isStale) {
+
129 buildFromFile(m_fileName);
+
130 }
+
131 }
+
+
132
+
+
133 void FileDefinedEngineView::setNetworkFile(const std::string &fileName) {
+
134 m_isStale = true;
+
135 m_fileName = fileName;
+
136 LOG_DEBUG(m_logger, "File '{}' set to '{}'. FileDefinedNetworkView is now stale! You MUST call update() before you use it!", m_fileName, fileName);
+
137 }
+
+
138
+
+
139 void FileDefinedEngineView::setScreeningModel(const screening::ScreeningType model) {
+
140 m_baseEngine.setScreeningModel(model);
+
141 }
+
+
142
+
+
143 screening::ScreeningType FileDefinedEngineView::getScreeningModel() const {
+
144 return m_baseEngine.getScreeningModel();
+
145 }
+
+
146
+
+
147 std::vector<size_t> FileDefinedEngineView::constructSpeciesIndexMap() const {
+
148 LOG_TRACE_L1(m_logger, "Constructing species index map for file defined engine view...");
+
149 std::unordered_map<Species, size_t> fullSpeciesReverseMap;
+
150 const auto& fullSpeciesList = m_baseEngine.getNetworkSpecies();
+
151
+
152 fullSpeciesReverseMap.reserve(fullSpeciesList.size());
+
153
+
154 for (size_t i = 0; i < fullSpeciesList.size(); ++i) {
+
155 fullSpeciesReverseMap[fullSpeciesList[i]] = i;
+
156 }
+
157
+
158 std::vector<size_t> speciesIndexMap;
+
159 speciesIndexMap.reserve(m_activeSpecies.size());
+
160
+
161 for (const auto& active_species : m_activeSpecies) {
+
162 auto it = fullSpeciesReverseMap.find(active_species);
+
163 if (it != fullSpeciesReverseMap.end()) {
+
164 speciesIndexMap.push_back(it->second);
+
165 } else {
+
166 LOG_ERROR(m_logger, "Species '{}' not found in full species map.", active_species.name());
+
167 m_logger -> flush_log();
+
168 throw std::runtime_error("Species not found in full species map: " + std::string(active_species.name()));
+
169 }
+
170 }
+
171 LOG_TRACE_L1(m_logger, "Species index map constructed with {} entries.", speciesIndexMap.size());
+
172 return speciesIndexMap;
+
173
+
174 }
+
+
175
+
+
176 std::vector<size_t> FileDefinedEngineView::constructReactionIndexMap() const {
+
177 LOG_TRACE_L1(m_logger, "Constructing reaction index map for file defined engine view...");
+
178
+
179 // --- Step 1: Create a reverse map using the reaction's unique ID as the key. ---
+
180 std::unordered_map<std::string_view, size_t> fullReactionReverseMap;
+
181 const auto& fullReactionSet = m_baseEngine.getNetworkReactions();
+
182 fullReactionReverseMap.reserve(fullReactionSet.size());
+
183
+
184 for (size_t i_full = 0; i_full < fullReactionSet.size(); ++i_full) {
+
185 fullReactionReverseMap[fullReactionSet[i_full].id()] = i_full;
+
186 }
+
187
+
188 // --- Step 2: Build the final index map using the active reaction set. ---
+
189 std::vector<size_t> reactionIndexMap;
+
190 reactionIndexMap.reserve(m_activeReactions.size());
+
191
+
192 for (const auto& active_reaction_ptr : m_activeReactions) {
+
193 auto it = fullReactionReverseMap.find(active_reaction_ptr.id());
+
194
+
195 if (it != fullReactionReverseMap.end()) {
+
196 reactionIndexMap.push_back(it->second);
+
197 } else {
+
198 LOG_ERROR(m_logger, "Active reaction '{}' not found in base engine during reaction index map construction.", active_reaction_ptr.id());
+
199 m_logger->flush_log();
+
200 throw std::runtime_error("Mismatch between active reactions and base engine.");
+
201 }
+
202 }
+
203
+
204 LOG_TRACE_L1(m_logger, "Reaction index map constructed with {} entries.", reactionIndexMap.size());
+
205 return reactionIndexMap;
+
206 }
+
+
207
+
+
208 void FileDefinedEngineView::buildFromFile(const std::string &fileName) {
+
209 LOG_TRACE_L1(m_logger, "Building file defined engine view from {}...", fileName);
+
210 auto [reactionPENames] = m_parser.parse(fileName);
+
211
+
212 m_activeReactions.clear();
+
213 m_activeSpecies.clear();
+
214
+
215 std::unordered_set<Species> seenSpecies;
+
216
+
217 const auto& fullNetworkReactionSet = m_baseEngine.getNetworkReactions();
+
218 for (const auto& peName : reactionPENames) {
+
219 if (!fullNetworkReactionSet.contains(peName)) {
+
220 LOG_ERROR(m_logger, "Reaction with name '{}' not found in the base engine's network reactions. Aborting...", peName);
+
221 m_logger->flush_log();
+
222 throw std::runtime_error("Reaction with name '" + std::string(peName) + "' not found in the base engine's network reactions.");
+
223 }
+
224 auto reaction = fullNetworkReactionSet[peName];
+
225 for (const auto& reactant : reaction.reactants()) {
+
226 if (!seenSpecies.contains(reactant)) {
+
227 seenSpecies.insert(reactant);
+
228 m_activeSpecies.push_back(reactant);
+
229 }
+
230 }
+
231 for (const auto& product : reaction.products()) {
+
232 if (!seenSpecies.contains(product)) {
+
233 seenSpecies.insert(product);
+
234 m_activeSpecies.push_back(product);
+
235 }
+
236 }
+
237 m_activeReactions.add_reaction(reaction);
+
238 }
+
239 LOG_TRACE_L1(m_logger, "File defined engine view built with {} active species and {} active reactions.", m_activeSpecies.size(), m_activeReactions.size());
+
240 LOG_DEBUG(m_logger, "Active species: {}", [this]() -> std::string {
+
241 std::string result;
+
242 for (const auto& species : m_activeSpecies) {
+
243 result += std::string(species.name()) + ", ";
+
244 }
+
245 if (!result.empty()) {
+
246 result.pop_back(); // Remove last space
+
247 result.pop_back(); // Remove last comma
+
248 }
+
249 return result;
+
250 }());
+
251 LOG_DEBUG(m_logger, "Active reactions: {}", [this]() -> std::string {
+
252 std::string result;
+
253 for (const auto& reaction : m_activeReactions) {
+
254 result += std::string(reaction.id()) + ", ";
+
255 }
+
256 if (!result.empty()) {
+
257 result.pop_back(); // Remove last space
+
258 result.pop_back(); // Remove last comma
+
259 }
+
260 return result;
+
261 }());
+
262 m_speciesIndexMap = constructSpeciesIndexMap();
+
263 m_reactionIndexMap = constructReactionIndexMap();
+
264 m_isStale = false;
+
265 }
+
+
266
+
+
267 std::vector<double> FileDefinedEngineView::mapViewToFull(const std::vector<double>& culled) const {
+
268 std::vector<double> full(m_baseEngine.getNetworkSpecies().size(), 0.0);
+
269 for (size_t i_culled = 0; i_culled < culled.size(); ++i_culled) {
+
270 const size_t i_full = m_speciesIndexMap[i_culled];
+
271 full[i_full] += culled[i_culled];
+
272 }
+
273 return full;
+
274 }
+
+
275
+
+
276 std::vector<double> FileDefinedEngineView::mapFullToView(const std::vector<double>& full) const {
+
277 std::vector<double> culled(m_activeSpecies.size(), 0.0);
+
278 for (size_t i_culled = 0; i_culled < m_activeSpecies.size(); ++i_culled) {
+
279 const size_t i_full = m_speciesIndexMap[i_culled];
+
280 culled[i_culled] = full[i_full];
+
281 }
+
282 return culled;
+
283 }
+
+
284
+
+
285 size_t FileDefinedEngineView::mapViewToFullSpeciesIndex(size_t culledSpeciesIndex) const {
+
286 if (culledSpeciesIndex < 0 || culledSpeciesIndex >= static_cast<int>(m_speciesIndexMap.size())) {
+
287 LOG_ERROR(m_logger, "Defined index {} is out of bounds for species index map of size {}.", culledSpeciesIndex, m_speciesIndexMap.size());
+
288 m_logger->flush_log();
+
289 throw std::out_of_range("Defined index " + std::to_string(culledSpeciesIndex) + " is out of bounds for species index map of size " + std::to_string(m_speciesIndexMap.size()) + ".");
+
290 }
+
291 return m_speciesIndexMap[culledSpeciesIndex];
+
292 }
+
+
293
+
+
294 size_t FileDefinedEngineView::mapViewToFullReactionIndex(size_t culledReactionIndex) const {
+
295 if (culledReactionIndex < 0 || culledReactionIndex >= static_cast<int>(m_reactionIndexMap.size())) {
+
296 LOG_ERROR(m_logger, "Defined index {} is out of bounds for reaction index map of size {}.", culledReactionIndex, m_reactionIndexMap.size());
+
297 m_logger->flush_log();
+
298 throw std::out_of_range("Defined index " + std::to_string(culledReactionIndex) + " is out of bounds for reaction index map of size " + std::to_string(m_reactionIndexMap.size()) + ".");
+
299 }
+
300 return m_reactionIndexMap[culledReactionIndex];
+
301 }
+
+
302
+
+
303 void FileDefinedEngineView::validateNetworkState() const {
+
304 if (m_isStale) {
+
305 LOG_ERROR(m_logger, "File defined engine view is stale. Please call update() with a valid NetIn object.");
+
306 m_logger->flush_log();
+
307 throw std::runtime_error("File defined engine view is stale. Please call update() with a valid NetIn object.");
+
308 }
+
309 }
+
+
310}
+
gridfire::DynamicEngine
Abstract class for engines supporting Jacobian and stoichiometry operations.
Definition engine_abstract.h:121
+
gridfire::FileDefinedEngineView::m_parser
const io::NetworkFileParser & m_parser
Parser for the network file.
Definition engine_defined.h:78
+
gridfire::FileDefinedEngineView::getJacobianMatrixEntry
double getJacobianMatrixEntry(const int i_defined, const int j_defined) const override
Get an entry from the previously generated Jacobian matrix.
Definition engine_defined.cpp:56
+
gridfire::FileDefinedEngineView::m_fileName
std::string m_fileName
Name of the file defining the reaction set considered by the engine view.
Definition engine_defined.h:77
+
gridfire::FileDefinedEngineView::generateStoichiometryMatrix
void generateStoichiometryMatrix() override
Generate the stoichiometry matrix for the network.
Definition engine_defined.cpp:68
+
gridfire::FileDefinedEngineView::m_activeSpecies
std::vector< fourdst::atomic::Species > m_activeSpecies
Active species in the defined engine.
Definition engine_defined.h:80
+
gridfire::FileDefinedEngineView::calculateRHSAndEnergy
StepDerivatives< double > calculateRHSAndEnergy(const std::vector< double > &Y_defined, const double T9, const double rho) const override
Calculate the right-hand side (dY/dt) and energy generation.
Definition engine_defined.cpp:29
+
gridfire::FileDefinedEngineView::buildFromFile
void buildFromFile(const std::string &fileName)
Definition engine_defined.cpp:208
+
gridfire::FileDefinedEngineView::generateJacobianMatrix
void generateJacobianMatrix(const std::vector< double > &Y_defined, const double T9, const double rho) override
Generate the Jacobian matrix for the current state.
Definition engine_defined.cpp:45
+
gridfire::FileDefinedEngineView::getBaseEngine
const DynamicEngine & getBaseEngine() const override
Access the underlying engine instance.
Definition engine_defined.cpp:21
+
gridfire::FileDefinedEngineView::constructSpeciesIndexMap
std::vector< size_t > constructSpeciesIndexMap() const
Constructs the species index map.
Definition engine_defined.cpp:147
+
gridfire::FileDefinedEngineView::getNetworkReactions
const reaction::LogicalReactionSet & getNetworkReactions() const override
Get the set of logical reactions in the network.
Definition engine_defined.cpp:102
+ +
gridfire::FileDefinedEngineView::getNetworkSpecies
const std::vector< fourdst::atomic::Species > & getNetworkSpecies() const override
Get the list of species in the network.
Definition engine_defined.cpp:25
+
gridfire::FileDefinedEngineView::mapViewToFullSpeciesIndex
size_t mapViewToFullSpeciesIndex(size_t culledSpeciesIndex) const
Maps a culled species index to a full species index.
Definition engine_defined.cpp:285
+
gridfire::FileDefinedEngineView::FileDefinedEngineView
FileDefinedEngineView(DynamicEngine &baseEngine, const std::string &fileName, const io::NetworkFileParser &parser)
Definition engine_defined.cpp:8
+
gridfire::FileDefinedEngineView::setNetworkFile
void setNetworkFile(const std::string &fileName)
Definition engine_defined.cpp:133
+
gridfire::FileDefinedEngineView::mapFullToView
std::vector< double > mapFullToView(const std::vector< double > &full) const
Maps a vector of full abundances to a vector of culled abundances.
Definition engine_defined.cpp:276
+ +
gridfire::FileDefinedEngineView::getStoichiometryMatrixEntry
int getStoichiometryMatrixEntry(const int speciesIndex_defined, const int reactionIndex_defined) const override
Get an entry from the stoichiometry matrix.
Definition engine_defined.cpp:74
+
gridfire::FileDefinedEngineView::mapViewToFull
std::vector< double > mapViewToFull(const std::vector< double > &culled) const
Maps a vector of culled abundances to a vector of full abundances.
Definition engine_defined.cpp:267
+
gridfire::FileDefinedEngineView::calculateMolarReactionFlow
double calculateMolarReactionFlow(const reaction::Reaction &reaction, const std::vector< double > &Y_defined, const double T9, const double rho) const override
Calculate the molar reaction flow for a given reaction.
Definition engine_defined.cpp:85
+
gridfire::FileDefinedEngineView::update
void update(const NetIn &netIn) override
Definition engine_defined.cpp:127
+
gridfire::FileDefinedEngineView::getSpeciesTimescales
std::unordered_map< fourdst::atomic::Species, double > getSpeciesTimescales(const std::vector< double > &Y_defined, const double T9, const double rho) const override
Compute timescales for all species in the network.
Definition engine_defined.cpp:108
+ +
gridfire::FileDefinedEngineView::setScreeningModel
void setScreeningModel(screening::ScreeningType model) override
Definition engine_defined.cpp:139
+
gridfire::FileDefinedEngineView::getScreeningModel
screening::ScreeningType getScreeningModel() const override
Definition engine_defined.cpp:143
+
gridfire::FileDefinedEngineView::m_activeReactions
reaction::LogicalReactionSet m_activeReactions
Active reactions in the defined engine.
Definition engine_defined.h:81
+ +
gridfire::FileDefinedEngineView::mapViewToFullReactionIndex
size_t mapViewToFullReactionIndex(size_t culledReactionIndex) const
Maps a culled reaction index to a full reaction index.
Definition engine_defined.cpp:294
+
gridfire::FileDefinedEngineView::constructReactionIndexMap
std::vector< size_t > constructReactionIndexMap() const
Constructs the reaction index map.
Definition engine_defined.cpp:176
+
gridfire::FileDefinedEngineView::m_speciesIndexMap
std::vector< size_t > m_speciesIndexMap
Maps indices of active species to indices in the full network.
Definition engine_defined.h:83
+
gridfire::FileDefinedEngineView::m_reactionIndexMap
std::vector< size_t > m_reactionIndexMap
Maps indices of active reactions to indices in the full network.
Definition engine_defined.h:84
+ +
gridfire::reaction::Reaction
Represents a single nuclear reaction from a specific data source.
Definition reaction.h:72
+
engine_defined.h
+ +
gridfire::reaction::LogicalReactionSet
TemplatedReactionSet< LogicalReaction > LogicalReactionSet
A set of logical reactions.
Definition reaction.h:557
+ + + +
gridfire::StepDerivatives
Structure holding derivatives and energy generation for a network step.
Definition engine_abstract.h:53
+
gridfire::StepDerivatives::nuclearEnergyGenerationRate
T nuclearEnergyGenerationRate
Specific energy generation rate (e.g., erg/g/s).
Definition engine_abstract.h:55
+
gridfire::StepDerivatives::dydt
std::vector< T > dydt
Derivatives of abundances (dY/dt for each species).
Definition engine_abstract.h:54
+
+
+ + + + diff --git a/docs/html/engine__defined_8h.html b/docs/html/engine__defined_8h.html new file mode 100644 index 00000000..255a10fc --- /dev/null +++ b/docs/html/engine__defined_8h.html @@ -0,0 +1,139 @@ + + + + + + + +GridFire: src/network/include/gridfire/engine/views/engine_defined.h File Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Classes | +Namespaces
+
engine_defined.h File Reference
+
+
+
#include "gridfire/engine/views/engine_view_abstract.h"
+#include "gridfire/engine/engine_abstract.h"
+#include "gridfire/io/network_file.h"
+#include "gridfire/network.h"
+#include "fourdst/config/config.h"
+#include "fourdst/logging/logging.h"
+#include "quill/Logger.h"
+#include <string>
+
+

Go to the source code of this file.

+ + + + +

+Classes

class  gridfire::FileDefinedEngineView
 
+ + + +

+Namespaces

namespace  gridfire
 
+
+
+ + + + diff --git a/docs/html/engine__defined_8h.js b/docs/html/engine__defined_8h.js new file mode 100644 index 00000000..6ca77a86 --- /dev/null +++ b/docs/html/engine__defined_8h.js @@ -0,0 +1,4 @@ +var engine__defined_8h = +[ + [ "gridfire::FileDefinedEngineView", "classgridfire_1_1_file_defined_engine_view.html", "classgridfire_1_1_file_defined_engine_view" ] +]; \ No newline at end of file diff --git a/docs/html/engine__defined_8h_source.html b/docs/html/engine__defined_8h_source.html new file mode 100644 index 00000000..3595c4d2 --- /dev/null +++ b/docs/html/engine__defined_8h_source.html @@ -0,0 +1,271 @@ + + + + + + + +GridFire: src/network/include/gridfire/engine/views/engine_defined.h Source File + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
engine_defined.h
+
+
+Go to the documentation of this file.
1#pragma once
+
2
+
3#include "gridfire/engine/views/engine_view_abstract.h"
+
4#include "gridfire/engine/engine_abstract.h"
+
5#include "gridfire/io/network_file.h"
+
6#include "gridfire/network.h"
+
7
+
8#include "fourdst/config/config.h"
+
9#include "fourdst/logging/logging.h"
+
10
+
11#include "quill/Logger.h"
+
12
+
13#include <string>
+
14
+
15namespace gridfire{
+
+
16 class FileDefinedEngineView final: public DynamicEngine, public EngineView<DynamicEngine> {
+
17 public:
+
18 explicit FileDefinedEngineView(
+
19 DynamicEngine& baseEngine,
+
20 const std::string& fileName,
+
21 const io::NetworkFileParser& parser
+
22 );
+
23
+
24 // --- EngineView Interface ---
+
25 const DynamicEngine& getBaseEngine() const override;
+
26
+
27 // --- Engine Interface ---
+
28 const std::vector<fourdst::atomic::Species>& getNetworkSpecies() const override;
+
29
+
30 // --- DynamicEngine Interface ---
+
31 StepDerivatives<double> calculateRHSAndEnergy(
+
32 const std::vector<double>& Y_defined,
+
33 const double T9,
+
34 const double rho
+
35 ) const override;
+
36 void generateJacobianMatrix(
+
37 const std::vector<double>& Y_defined,
+
38 const double T9,
+
39 const double rho
+
40 ) override;
+
41 double getJacobianMatrixEntry(
+
42 const int i_defined,
+
43 const int j_defined
+
44 ) const override;
+
45 void generateStoichiometryMatrix() override;
+
46 int getStoichiometryMatrixEntry(
+
47 const int speciesIndex_defined,
+
48 const int reactionIndex_defined
+
49 ) const override;
+
50 double calculateMolarReactionFlow(
+
51 const reaction::Reaction& reaction,
+
52 const std::vector<double>& Y_defined,
+
53 const double T9,
+
54 const double rho
+
55 ) const override;
+
56 const reaction::LogicalReactionSet& getNetworkReactions() const override;
+
57 std::unordered_map<fourdst::atomic::Species, double> getSpeciesTimescales(
+
58 const std::vector<double>& Y_defined,
+
59 const double T9,
+
60 const double rho
+
61 ) const override;
+
62
+
63 void update(const NetIn &netIn) override;
+
64
+
65 void setNetworkFile(const std::string& fileName);
+
66
+
67 void setScreeningModel(screening::ScreeningType model) override;
+
68
+
69 [[nodiscard]] screening::ScreeningType getScreeningModel() const override;
+
70 private:
+
71 using Config = fourdst::config::Config;
+
72 using LogManager = fourdst::logging::LogManager;
+
73 Config& m_config = Config::getInstance();
+
74 quill::Logger* m_logger = LogManager::getInstance().getLogger("log");
+
75
+
76 DynamicEngine& m_baseEngine;
+
77 std::string m_fileName;
+
78 const io::NetworkFileParser& m_parser;
+
79
+
80 std::vector<fourdst::atomic::Species> m_activeSpecies;
+
81 reaction::LogicalReactionSet m_activeReactions;
+
82
+
83 std::vector<size_t> m_speciesIndexMap;
+
84 std::vector<size_t> m_reactionIndexMap;
+
85
+
86 bool m_isStale = true;
+
87
+
88 private:
+
89 void buildFromFile(const std::string& fileName);
+
90
+
101 std::vector<size_t> constructSpeciesIndexMap() const;
+
102
+
113 std::vector<size_t> constructReactionIndexMap() const;
+
114
+
122 std::vector<double> mapViewToFull(const std::vector<double>& culled) const;
+
123
+
131 std::vector<double> mapFullToView(const std::vector<double>& full) const;
+
132
+
141 size_t mapViewToFullSpeciesIndex(size_t culledSpeciesIndex) const;
+
142
+
151 size_t mapViewToFullReactionIndex(size_t culledReactionIndex) const;
+
152
+
153 void validateNetworkState() const;
+
154 };
+
+
155}
+
gridfire::DynamicEngine
Abstract class for engines supporting Jacobian and stoichiometry operations.
Definition engine_abstract.h:121
+
gridfire::EngineView
Abstract base class for a "view" of a reaction network engine.
Definition engine_view_abstract.h:74
+
gridfire::FileDefinedEngineView::m_parser
const io::NetworkFileParser & m_parser
Parser for the network file.
Definition engine_defined.h:78
+
gridfire::FileDefinedEngineView::getJacobianMatrixEntry
double getJacobianMatrixEntry(const int i_defined, const int j_defined) const override
Get an entry from the previously generated Jacobian matrix.
Definition engine_defined.cpp:56
+
gridfire::FileDefinedEngineView::m_fileName
std::string m_fileName
Name of the file defining the reaction set considered by the engine view.
Definition engine_defined.h:77
+
gridfire::FileDefinedEngineView::generateStoichiometryMatrix
void generateStoichiometryMatrix() override
Generate the stoichiometry matrix for the network.
Definition engine_defined.cpp:68
+
gridfire::FileDefinedEngineView::m_activeSpecies
std::vector< fourdst::atomic::Species > m_activeSpecies
Active species in the defined engine.
Definition engine_defined.h:80
+
gridfire::FileDefinedEngineView::calculateRHSAndEnergy
StepDerivatives< double > calculateRHSAndEnergy(const std::vector< double > &Y_defined, const double T9, const double rho) const override
Calculate the right-hand side (dY/dt) and energy generation.
Definition engine_defined.cpp:29
+
gridfire::FileDefinedEngineView::buildFromFile
void buildFromFile(const std::string &fileName)
Definition engine_defined.cpp:208
+
gridfire::FileDefinedEngineView::generateJacobianMatrix
void generateJacobianMatrix(const std::vector< double > &Y_defined, const double T9, const double rho) override
Generate the Jacobian matrix for the current state.
Definition engine_defined.cpp:45
+
gridfire::FileDefinedEngineView::getBaseEngine
const DynamicEngine & getBaseEngine() const override
Access the underlying engine instance.
Definition engine_defined.cpp:21
+
gridfire::FileDefinedEngineView::constructSpeciesIndexMap
std::vector< size_t > constructSpeciesIndexMap() const
Constructs the species index map.
Definition engine_defined.cpp:147
+
gridfire::FileDefinedEngineView::getNetworkReactions
const reaction::LogicalReactionSet & getNetworkReactions() const override
Get the set of logical reactions in the network.
Definition engine_defined.cpp:102
+
gridfire::FileDefinedEngineView::Config
fourdst::config::Config Config
Definition engine_defined.h:71
+ + +
gridfire::FileDefinedEngineView::getNetworkSpecies
const std::vector< fourdst::atomic::Species > & getNetworkSpecies() const override
Get the list of species in the network.
Definition engine_defined.cpp:25
+
gridfire::FileDefinedEngineView::mapViewToFullSpeciesIndex
size_t mapViewToFullSpeciesIndex(size_t culledSpeciesIndex) const
Maps a culled species index to a full species index.
Definition engine_defined.cpp:285
+
gridfire::FileDefinedEngineView::FileDefinedEngineView
FileDefinedEngineView(DynamicEngine &baseEngine, const std::string &fileName, const io::NetworkFileParser &parser)
Definition engine_defined.cpp:8
+
gridfire::FileDefinedEngineView::setNetworkFile
void setNetworkFile(const std::string &fileName)
Definition engine_defined.cpp:133
+
gridfire::FileDefinedEngineView::mapFullToView
std::vector< double > mapFullToView(const std::vector< double > &full) const
Maps a vector of full abundances to a vector of culled abundances.
Definition engine_defined.cpp:276
+ +
gridfire::FileDefinedEngineView::getStoichiometryMatrixEntry
int getStoichiometryMatrixEntry(const int speciesIndex_defined, const int reactionIndex_defined) const override
Get an entry from the stoichiometry matrix.
Definition engine_defined.cpp:74
+
gridfire::FileDefinedEngineView::mapViewToFull
std::vector< double > mapViewToFull(const std::vector< double > &culled) const
Maps a vector of culled abundances to a vector of full abundances.
Definition engine_defined.cpp:267
+
gridfire::FileDefinedEngineView::calculateMolarReactionFlow
double calculateMolarReactionFlow(const reaction::Reaction &reaction, const std::vector< double > &Y_defined, const double T9, const double rho) const override
Calculate the molar reaction flow for a given reaction.
Definition engine_defined.cpp:85
+
gridfire::FileDefinedEngineView::LogManager
fourdst::logging::LogManager LogManager
Definition engine_defined.h:72
+
gridfire::FileDefinedEngineView::update
void update(const NetIn &netIn) override
Definition engine_defined.cpp:127
+
gridfire::FileDefinedEngineView::getSpeciesTimescales
std::unordered_map< fourdst::atomic::Species, double > getSpeciesTimescales(const std::vector< double > &Y_defined, const double T9, const double rho) const override
Compute timescales for all species in the network.
Definition engine_defined.cpp:108
+ +
gridfire::FileDefinedEngineView::setScreeningModel
void setScreeningModel(screening::ScreeningType model) override
Definition engine_defined.cpp:139
+
gridfire::FileDefinedEngineView::getScreeningModel
screening::ScreeningType getScreeningModel() const override
Definition engine_defined.cpp:143
+
gridfire::FileDefinedEngineView::m_activeReactions
reaction::LogicalReactionSet m_activeReactions
Active reactions in the defined engine.
Definition engine_defined.h:81
+ +
gridfire::FileDefinedEngineView::mapViewToFullReactionIndex
size_t mapViewToFullReactionIndex(size_t culledReactionIndex) const
Maps a culled reaction index to a full reaction index.
Definition engine_defined.cpp:294
+
gridfire::FileDefinedEngineView::constructReactionIndexMap
std::vector< size_t > constructReactionIndexMap() const
Constructs the reaction index map.
Definition engine_defined.cpp:176
+
gridfire::FileDefinedEngineView::m_speciesIndexMap
std::vector< size_t > m_speciesIndexMap
Maps indices of active species to indices in the full network.
Definition engine_defined.h:83
+
gridfire::FileDefinedEngineView::m_reactionIndexMap
std::vector< size_t > m_reactionIndexMap
Maps indices of active reactions to indices in the full network.
Definition engine_defined.h:84
+ +
gridfire::reaction::Reaction
Represents a single nuclear reaction from a specific data source.
Definition reaction.h:72
+
engine_abstract.h
Abstract interfaces for reaction network engines in GridFire.
+
engine_view_abstract.h
Abstract interfaces for engine "views" in GridFire.
+ +
gridfire::reaction::LogicalReactionSet
TemplatedReactionSet< LogicalReaction > LogicalReactionSet
A set of logical reactions.
Definition reaction.h:557
+ + + +
network_file.h
+ +
gridfire::StepDerivatives
Structure holding derivatives and energy generation for a network step.
Definition engine_abstract.h:53
+
+
+ + + + diff --git a/docs/html/functions_eval.html b/docs/html/functions_eval.html new file mode 100644 index 00000000..d6c399e0 --- /dev/null +++ b/docs/html/functions_eval.html @@ -0,0 +1,115 @@ + + + + + + + +GridFire: Class Members - Enumerator + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all enum values with links to the classes they belong to:
+
+
+ + + + diff --git a/docs/html/functions_func.js b/docs/html/functions_func.js new file mode 100644 index 00000000..d89bd6e0 --- /dev/null +++ b/docs/html/functions_func.js @@ -0,0 +1,25 @@ +var functions_func = +[ + [ "a", "functions_func.html", null ], + [ "b", "functions_func_b.html", null ], + [ "c", "functions_func_c.html", null ], + [ "d", "functions_func_d.html", null ], + [ "e", "functions_func_e.html", null ], + [ "f", "functions_func_f.html", null ], + [ "g", "functions_func_g.html", null ], + [ "h", "functions_func_h.html", null ], + [ "i", "functions_func_i.html", null ], + [ "j", "functions_func_j.html", null ], + [ "l", "functions_func_l.html", null ], + [ "m", "functions_func_m.html", null ], + [ "n", "functions_func_n.html", null ], + [ "o", "functions_func_o.html", null ], + [ "p", "functions_func_p.html", null ], + [ "q", "functions_func_q.html", null ], + [ "r", "functions_func_r.html", null ], + [ "s", "functions_func_s.html", null ], + [ "t", "functions_func_t.html", null ], + [ "u", "functions_func_u.html", null ], + [ "v", "functions_func_v.html", null ], + [ "~", "functions_func_~.html", null ] +]; \ No newline at end of file diff --git a/docs/html/functions_func_b.html b/docs/html/functions_func_b.html new file mode 100644 index 00000000..7f438810 --- /dev/null +++ b/docs/html/functions_func_b.html @@ -0,0 +1,117 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- b -

+
+
+ + + + diff --git a/docs/html/functions_func_c.html b/docs/html/functions_func_c.html new file mode 100644 index 00000000..2f96298b --- /dev/null +++ b/docs/html/functions_func_c.html @@ -0,0 +1,134 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- c -

+
+
+ + + + diff --git a/docs/html/functions_func_d.html b/docs/html/functions_func_d.html new file mode 100644 index 00000000..1f437bcb --- /dev/null +++ b/docs/html/functions_func_d.html @@ -0,0 +1,116 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- d -

+
+
+ + + + diff --git a/docs/html/functions_func_e.html b/docs/html/functions_func_e.html new file mode 100644 index 00000000..e03036b0 --- /dev/null +++ b/docs/html/functions_func_e.html @@ -0,0 +1,121 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- e -

+
+
+ + + + diff --git a/docs/html/functions_func_f.html b/docs/html/functions_func_f.html new file mode 100644 index 00000000..85adf1b2 --- /dev/null +++ b/docs/html/functions_func_f.html @@ -0,0 +1,118 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- f -

+
+
+ + + + diff --git a/docs/html/functions_func_g.html b/docs/html/functions_func_g.html new file mode 100644 index 00000000..48afb1e0 --- /dev/null +++ b/docs/html/functions_func_g.html @@ -0,0 +1,128 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- g -

+
+
+ + + + diff --git a/docs/html/functions_func_h.html b/docs/html/functions_func_h.html new file mode 100644 index 00000000..842e34f2 --- /dev/null +++ b/docs/html/functions_func_h.html @@ -0,0 +1,116 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- h -

+
+
+ + + + diff --git a/docs/html/functions_func_i.html b/docs/html/functions_func_i.html new file mode 100644 index 00000000..9ce66b76 --- /dev/null +++ b/docs/html/functions_func_i.html @@ -0,0 +1,121 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- i -

+
+
+ + + + diff --git a/docs/html/functions_func_j.html b/docs/html/functions_func_j.html new file mode 100644 index 00000000..e8084ddb --- /dev/null +++ b/docs/html/functions_func_j.html @@ -0,0 +1,116 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- j -

+
+
+ + + + diff --git a/docs/html/functions_func_l.html b/docs/html/functions_func_l.html new file mode 100644 index 00000000..389a4e3b --- /dev/null +++ b/docs/html/functions_func_l.html @@ -0,0 +1,116 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- l -

+
+
+ + + + diff --git a/docs/html/functions_func_m.html b/docs/html/functions_func_m.html new file mode 100644 index 00000000..3bc94288 --- /dev/null +++ b/docs/html/functions_func_m.html @@ -0,0 +1,125 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- m -

+
+
+ + + + diff --git a/docs/html/functions_func_n.html b/docs/html/functions_func_n.html new file mode 100644 index 00000000..4bb17ffb --- /dev/null +++ b/docs/html/functions_func_n.html @@ -0,0 +1,118 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- n -

+
+
+ + + + diff --git a/docs/html/functions_func_o.html b/docs/html/functions_func_o.html new file mode 100644 index 00000000..a40bcb4a --- /dev/null +++ b/docs/html/functions_func_o.html @@ -0,0 +1,120 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- o -

+
+
+ + + + diff --git a/docs/html/functions_func_p.html b/docs/html/functions_func_p.html new file mode 100644 index 00000000..e37ece48 --- /dev/null +++ b/docs/html/functions_func_p.html @@ -0,0 +1,122 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- p -

+
+
+ + + + diff --git a/docs/html/functions_func_q.html b/docs/html/functions_func_q.html new file mode 100644 index 00000000..ce7c605d --- /dev/null +++ b/docs/html/functions_func_q.html @@ -0,0 +1,116 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- q -

+
+
+ + + + diff --git a/docs/html/functions_func_r.html b/docs/html/functions_func_r.html new file mode 100644 index 00000000..78a649a6 --- /dev/null +++ b/docs/html/functions_func_r.html @@ -0,0 +1,123 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- r -

+
+
+ + + + diff --git a/docs/html/functions_func_s.html b/docs/html/functions_func_s.html new file mode 100644 index 00000000..70682c13 --- /dev/null +++ b/docs/html/functions_func_s.html @@ -0,0 +1,126 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- s -

+
+
+ + + + diff --git a/docs/html/functions_func_t.html b/docs/html/functions_func_t.html new file mode 100644 index 00000000..58f59691 --- /dev/null +++ b/docs/html/functions_func_t.html @@ -0,0 +1,116 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- t -

+
+
+ + + + diff --git a/docs/html/functions_func_u.html b/docs/html/functions_func_u.html new file mode 100644 index 00000000..2ce13ee0 --- /dev/null +++ b/docs/html/functions_func_u.html @@ -0,0 +1,116 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- u -

+
+
+ + + + diff --git a/docs/html/functions_func_v.html b/docs/html/functions_func_v.html new file mode 100644 index 00000000..ff51dd8e --- /dev/null +++ b/docs/html/functions_func_v.html @@ -0,0 +1,120 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- v -

+
+
+ + + + diff --git a/docs/html/functions_func_~.html b/docs/html/functions_func_~.html new file mode 100644 index 00000000..936352c5 --- /dev/null +++ b/docs/html/functions_func_~.html @@ -0,0 +1,122 @@ + + + + + + + +GridFire: Class Members - Functions + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the classes they belong to:
+ +

- ~ -

+
+
+ + + + diff --git a/docs/html/logging_8cpp.html b/docs/html/logging_8cpp.html new file mode 100644 index 00000000..8884fe5e --- /dev/null +++ b/docs/html/logging_8cpp.html @@ -0,0 +1,127 @@ + + + + + + + +GridFire: src/network/lib/utils/logging.cpp File Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
logging.cpp File Reference
+
+
+
#include "gridfire/utils/logging.h"
+#include "gridfire/engine/engine_abstract.h"
+#include <sstream>
+#include <iomanip>
+#include <algorithm>
+#include <ranges>
+#include <string_view>
+#include <string>
+#include <iostream>
+#include <vector>
+
+

Go to the source code of this file.

+
+
+ + + + diff --git a/docs/html/logging_8cpp_source.html b/docs/html/logging_8cpp_source.html new file mode 100644 index 00000000..a9385375 --- /dev/null +++ b/docs/html/logging_8cpp_source.html @@ -0,0 +1,182 @@ + + + + + + + +GridFire: src/network/lib/utils/logging.cpp Source File + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
logging.cpp
+
+
+Go to the documentation of this file.
1#include "gridfire/utils/logging.h"
+
2#include "gridfire/engine/engine_abstract.h"
+
3
+
4#include <sstream>
+
5#include <iomanip>
+
6#include <algorithm>
+
7#include <ranges>
+
8#include <string_view>
+
9#include <string>
+
10#include <iostream>
+
11#include <vector>
+
12
+
+
13std::string gridfire::utils::formatNuclearTimescaleLogString(
+
14 const DynamicEngine& engine,
+
15 std::vector<double> const& Y,
+
16 const double T9,
+
17 const double rho
+
18) {
+
19 auto const& timescales = engine.getSpeciesTimescales(Y, T9, rho);
+
20
+
21 // Figure out how wide the "Species" column needs to be:
+
22 std::size_t maxNameLen = std::string_view("Species").size();
+
23 for (const auto &key: timescales | std::views::keys) {
+
24 std::string_view name = key.name();
+
25 maxNameLen = std::max(maxNameLen, name.size());
+
26 }
+
27
+
28 // Pick a fixed width for the timescale column:
+
29 constexpr int timescaleWidth = 12;
+
30
+
31 std::ostringstream ss;
+
32 ss << "== Timescales (s) ==\n";
+
33
+
34 // Header row
+
35 ss << std::left << std::setw(static_cast<int>(maxNameLen) + 2) << "Species"
+
36 << std::right << std::setw(timescaleWidth) << "Timescale (s)" << "\n";
+
37
+
38 // Underline
+
39 ss << std::string(static_cast<int>(maxNameLen) + 2 + timescaleWidth, '=') << "\n";
+
40
+
41 ss << std::scientific;
+
42
+
43 // Data rows
+
44 for (auto const& [species, timescale] : timescales) {
+
45 const std::string_view name = species.name();
+
46 ss << std::left << std::setw(static_cast<int>(maxNameLen) + 2) << name;
+
47
+
48 if (std::isinf(timescale)) {
+
49 ss << std::right << std::setw(timescaleWidth) << "inf" << "\n";
+
50 } else {
+
51 ss << std::right << std::setw(timescaleWidth)
+
52 << std::scientific << std::setprecision(3) << timescale << "\n";
+
53 }
+
54 }
+
55
+
56 // Footer underline
+
57 ss << std::string(static_cast<int>(maxNameLen) + 2 + timescaleWidth, '=') << "\n";
+
58
+
59 return ss.str();
+
60}
+
+
gridfire::DynamicEngine
Abstract class for engines supporting Jacobian and stoichiometry operations.
Definition engine_abstract.h:121
+
gridfire::DynamicEngine::getSpeciesTimescales
virtual std::unordered_map< fourdst::atomic::Species, double > getSpeciesTimescales(const std::vector< double > &Y, double T9, double rho) const =0
Compute timescales for all species in the network.
+
engine_abstract.h
Abstract interfaces for reaction network engines in GridFire.
+ +
gridfire::utils::formatNuclearTimescaleLogString
std::string formatNuclearTimescaleLogString(const DynamicEngine &engine, const std::vector< double > &Y, const double T9, const double rho)
Definition logging.cpp:13
+
+
+ + + + diff --git a/docs/html/logging_8h.html b/docs/html/logging_8h.html new file mode 100644 index 00000000..5364c8bd --- /dev/null +++ b/docs/html/logging_8h.html @@ -0,0 +1,136 @@ + + + + + + + +GridFire: src/network/include/gridfire/utils/logging.h File Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Namespaces | +Functions
+
logging.h File Reference
+
+
+
#include "gridfire/engine/engine_abstract.h"
+#include <string>
+#include <vector>
+
+

Go to the source code of this file.

+ + + + + + +

+Namespaces

namespace  gridfire
 
namespace  gridfire::utils
 
+ + + +

+Functions

std::string gridfire::utils::formatNuclearTimescaleLogString (const DynamicEngine &engine, const std::vector< double > &Y, const double T9, const double rho)
 
+
+
+ + + + diff --git a/docs/html/logging_8h.js b/docs/html/logging_8h.js new file mode 100644 index 00000000..c16182d6 --- /dev/null +++ b/docs/html/logging_8h.js @@ -0,0 +1,4 @@ +var logging_8h = +[ + [ "gridfire::utils::formatNuclearTimescaleLogString", "namespacegridfire_1_1utils.html#af56693a70d9e2b40c8ae2c3bcd4b26c8", null ] +]; \ No newline at end of file diff --git a/docs/html/logging_8h_source.html b/docs/html/logging_8h_source.html new file mode 100644 index 00000000..f966ff83 --- /dev/null +++ b/docs/html/logging_8h_source.html @@ -0,0 +1,136 @@ + + + + + + + +GridFire: src/network/include/gridfire/utils/logging.h Source File + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
logging.h
+
+
+Go to the documentation of this file.
1#pragma once
+
2
+
3#include "gridfire/engine/engine_abstract.h"
+
4
+
5#include <string>
+
6#include <vector>
+
7
+
+
8namespace gridfire::utils {
+
9 std::string formatNuclearTimescaleLogString(
+
10 const DynamicEngine& engine,
+
11 const std::vector<double>& Y,
+
12 const double T9,
+
13 const double rho
+
14 );
+
15}
+
+
gridfire::DynamicEngine
Abstract class for engines supporting Jacobian and stoichiometry operations.
Definition engine_abstract.h:121
+
engine_abstract.h
Abstract interfaces for reaction network engines in GridFire.
+ +
gridfire::utils::formatNuclearTimescaleLogString
std::string formatNuclearTimescaleLogString(const DynamicEngine &engine, const std::vector< double > &Y, const double T9, const double rho)
Definition logging.cpp:13
+
+
+ + + + diff --git a/docs/html/namespacegridfire_1_1io.html b/docs/html/namespacegridfire_1_1io.html new file mode 100644 index 00000000..216f76e5 --- /dev/null +++ b/docs/html/namespacegridfire_1_1io.html @@ -0,0 +1,129 @@ + + + + + + + +GridFire: gridfire::io Namespace Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Classes
+
gridfire::io Namespace Reference
+
+
+ + + + + + + + + + +

+Classes

class  MESANetworkFileParser
 
class  NetworkFileParser
 
struct  ParsedNetworkData
 
class  SimpleReactionListFileParser
 
+
+
+ + + + diff --git a/docs/html/namespacegridfire_1_1io.js b/docs/html/namespacegridfire_1_1io.js new file mode 100644 index 00000000..45611c5b --- /dev/null +++ b/docs/html/namespacegridfire_1_1io.js @@ -0,0 +1,7 @@ +var namespacegridfire_1_1io = +[ + [ "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" ], + [ "ParsedNetworkData", "structgridfire_1_1io_1_1_parsed_network_data.html", "structgridfire_1_1io_1_1_parsed_network_data" ], + [ "SimpleReactionListFileParser", "classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html", "classgridfire_1_1io_1_1_simple_reaction_list_file_parser" ] +]; \ No newline at end of file diff --git a/docs/html/namespacegridfire_1_1screening.html b/docs/html/namespacegridfire_1_1screening.html new file mode 100644 index 00000000..fba897a6 --- /dev/null +++ b/docs/html/namespacegridfire_1_1screening.html @@ -0,0 +1,215 @@ + + + + + + + +GridFire: gridfire::screening Namespace Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Classes | +Typedefs | +Enumerations | +Functions
+
gridfire::screening Namespace Reference
+
+
+ + + + + + + + +

+Classes

class  BareScreeningModel
 
class  ScreeningModel
 
class  WeakScreeningModel
 
+ + + +

+Typedefs

using ADDouble = CppAD::AD<double>
 
+ + + +

+Enumerations

enum class  ScreeningType { BARE +, WEAK + }
 
+ + + +

+Functions

std::unique_ptr< ScreeningModel > selectScreeningModel (ScreeningType type)
 
+

Typedef Documentation

+ +

◆ ADDouble

+ +
+
+ + + + +
typedef CppAD::AD< double > gridfire::screening::ADDouble = CppAD::AD<double>
+
+ +

Definition at line 11 of file screening_bare.cpp.

+ +
+
+

Enumeration Type Documentation

+ +

◆ ScreeningType

+ +
+
+ + + + + +
+ + + + +
enum class gridfire::screening::ScreeningType
+ 		+strong
+
+ + + +
Enumerator
BARE 

No screening applied.

+
WEAK 

Weak screening model.

+
+ +

Definition at line 8 of file screening_types.h.

+ +
+
+

Function Documentation

+ +

◆ selectScreeningModel()

+ +
+
+ + + + + + + +
std::unique_ptr< ScreeningModel > gridfire::screening::selectScreeningModel (ScreeningType type)
+
+ +

Definition at line 9 of file screening_types.cpp.

+ +
+
+
+
+ + + + diff --git a/docs/html/namespacegridfire_1_1screening.js b/docs/html/namespacegridfire_1_1screening.js new file mode 100644 index 00000000..1664267f --- /dev/null +++ b/docs/html/namespacegridfire_1_1screening.js @@ -0,0 +1,12 @@ +var namespacegridfire_1_1screening = +[ + [ "BareScreeningModel", "classgridfire_1_1screening_1_1_bare_screening_model.html", "classgridfire_1_1screening_1_1_bare_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" ], + [ "ADDouble", "namespacegridfire_1_1screening.html#ae7dd1a7ccb7bf3c05084094ab008d8a3", null ], + [ "ScreeningType", "namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25", [ + [ "BARE", "namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25ad80b95b1abb9c8659fa4cc9d3d29bb71", null ], + [ "WEAK", "namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25a32c7d8943bec86a6d7d5e03598670ca8", null ] + ] ], + [ "selectScreeningModel", "namespacegridfire_1_1screening.html#a6ca8556d27ac373e176f5b23437c416e", null ] +]; \ No newline at end of file diff --git a/docs/html/namespacegridfire_1_1utils.html b/docs/html/namespacegridfire_1_1utils.html new file mode 100644 index 00000000..eca11ff1 --- /dev/null +++ b/docs/html/namespacegridfire_1_1utils.html @@ -0,0 +1,157 @@ + + + + + + + +GridFire: gridfire::utils Namespace Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Functions
+
gridfire::utils Namespace Reference
+
+
+ + + + +

+Functions

std::string formatNuclearTimescaleLogString (const DynamicEngine &engine, const std::vector< double > &Y, const double T9, const double rho)
 
+

Function Documentation

+ +

◆ formatNuclearTimescaleLogString()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + +
std::string gridfire::utils::formatNuclearTimescaleLogString (const DynamicEngine & engine,
const std::vector< double > & Y,
const double T9,
const double rho )
+
+ +

Definition at line 13 of file logging.cpp.

+ +
+
+
+
+ + + + diff --git a/docs/html/navtreeindex4.js b/docs/html/navtreeindex4.js new file mode 100644 index 00000000..0bd9b0d3 --- /dev/null +++ b/docs/html/navtreeindex4.js @@ -0,0 +1,51 @@ +var NAVTREEINDEX4 = +{ +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_jacobian_functor.html#a2071ce797f94ae1a3ea6d934748672ce":[4,0,0,5,3,1,2], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_jacobian_functor.html#a3668fae1e0f8e69ff3fd87275bf4a79d":[2,0,0,5,3,1,1], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_jacobian_functor.html#a3668fae1e0f8e69ff3fd87275bf4a79d":[4,0,0,5,3,1,1], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_jacobian_functor.html#a85f88639447a9a706008efece82ff289":[2,0,0,5,3,1,6], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_jacobian_functor.html#a85f88639447a9a706008efece82ff289":[4,0,0,5,3,1,6], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_jacobian_functor.html#aaaa82eff96e6127a6de05444f730e43a":[2,0,0,5,3,1,3], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_jacobian_functor.html#aaaa82eff96e6127a6de05444f730e43a":[4,0,0,5,3,1,3], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_jacobian_functor.html#ab8222646cd32670a046b6c74909bd83a":[2,0,0,5,3,1,0], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_jacobian_functor.html#ab8222646cd32670a046b6c74909bd83a":[4,0,0,5,3,1,0], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html":[2,0,0,5,3,2], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html":[4,0,0,5,3,2], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a02c23ef20d616bf5a591a274b66cd75a":[2,0,0,5,3,2,8], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a02c23ef20d616bf5a591a274b66cd75a":[4,0,0,5,3,2,8], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a0d8d28a6559cfed5e7cd683523d49b2c":[2,0,0,5,3,2,3], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a0d8d28a6559cfed5e7cd683523d49b2c":[4,0,0,5,3,2,3], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a35026100163c7cc6fdb4c2e4d988b8cb":[2,0,0,5,3,2,7], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a35026100163c7cc6fdb4c2e4d988b8cb":[4,0,0,5,3,2,7], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a3ac1ef529627d21f7d1ad718dc87f7f9":[2,0,0,5,3,2,2], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a3ac1ef529627d21f7d1ad718dc87f7f9":[4,0,0,5,3,2,2], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a5353d8e6f27b6c435084a167bc009e46":[2,0,0,5,3,2,0], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a5353d8e6f27b6c435084a167bc009e46":[4,0,0,5,3,2,0], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a6be7259897a47ce480b289144b06e269":[2,0,0,5,3,2,5], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a6be7259897a47ce480b289144b06e269":[4,0,0,5,3,2,5], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a81f964b87457847d7de13fed18499283":[2,0,0,5,3,2,4], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a81f964b87457847d7de13fed18499283":[4,0,0,5,3,2,4], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#adc0f8e655af42f414dcb220a7224f261":[2,0,0,5,3,2,6], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#adc0f8e655af42f414dcb220a7224f261":[4,0,0,5,3,2,6], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#ae0b6362d9c0a14e69c7a47233db6a86a":[2,0,0,5,3,2,1], +"structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#ae0b6362d9c0a14e69c7a47233db6a86a":[4,0,0,5,3,2,1], +"structgridfire_1_1solver_1_1dynamic_q_s_e_species_indices.html":[2,0,0,5,1], +"structgridfire_1_1solver_1_1dynamic_q_s_e_species_indices.html":[4,0,0,5,1], +"structgridfire_1_1solver_1_1dynamic_q_s_e_species_indices.html#a7d4ba82d9e60a4914938ebebecaab4a2":[2,0,0,5,1,1], +"structgridfire_1_1solver_1_1dynamic_q_s_e_species_indices.html#a7d4ba82d9e60a4914938ebebecaab4a2":[4,0,0,5,1,1], +"structgridfire_1_1solver_1_1dynamic_q_s_e_species_indices.html#ac6e0419abdd3c78b32e34c16c0543157":[2,0,0,5,1,0], +"structgridfire_1_1solver_1_1dynamic_q_s_e_species_indices.html#ac6e0419abdd3c78b32e34c16c0543157":[4,0,0,5,1,0], +"structstd_1_1hash_3_01gridfire_1_1reaction_1_1_logical_reaction_set_01_4.html":[2,0,1,0], +"structstd_1_1hash_3_01gridfire_1_1reaction_1_1_logical_reaction_set_01_4.html":[4,0,1,0], +"structstd_1_1hash_3_01gridfire_1_1reaction_1_1_logical_reaction_set_01_4.html#a4b76e7119050266952ded94d6f0544cb":[2,0,1,0,0], +"structstd_1_1hash_3_01gridfire_1_1reaction_1_1_logical_reaction_set_01_4.html#a4b76e7119050266952ded94d6f0544cb":[4,0,1,0,0], +"structstd_1_1hash_3_01gridfire_1_1reaction_1_1_reaction_01_4.html":[2,0,1,1], +"structstd_1_1hash_3_01gridfire_1_1reaction_1_1_reaction_01_4.html":[4,0,1,1], +"structstd_1_1hash_3_01gridfire_1_1reaction_1_1_reaction_01_4.html#a48224b63a80690e4f0620f1312be5dd9":[2,0,1,1,0], +"structstd_1_1hash_3_01gridfire_1_1reaction_1_1_reaction_01_4.html#a48224b63a80690e4f0620f1312be5dd9":[4,0,1,1,0], +"structstd_1_1hash_3_01gridfire_1_1reaction_1_1_reaction_set_01_4.html":[2,0,1,2], +"structstd_1_1hash_3_01gridfire_1_1reaction_1_1_reaction_set_01_4.html":[4,0,1,2], +"structstd_1_1hash_3_01gridfire_1_1reaction_1_1_reaction_set_01_4.html#a32b976b3e3e4e0403c1295f9b467e921":[2,0,1,2,0], +"structstd_1_1hash_3_01gridfire_1_1reaction_1_1_reaction_set_01_4.html#a32b976b3e3e4e0403c1295f9b467e921":[4,0,1,2,0], +"todo.html":[1] +}; diff --git a/docs/html/network__file_8cpp.html b/docs/html/network__file_8cpp.html new file mode 100644 index 00000000..4314e644 --- /dev/null +++ b/docs/html/network__file_8cpp.html @@ -0,0 +1,134 @@ + + + + + + + +GridFire: src/network/lib/io/network_file.cpp File Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Namespaces
+
network_file.cpp File Reference
+
+
+
#include "gridfire/io/network_file.h"
+#include <string>
+#include <vector>
+#include <algorithm>
+#include <fstream>
+#include <stdexcept>
+#include "quill/LogMacros.h"
+
+

Go to the source code of this file.

+ + + + + + +

+Namespaces

namespace  gridfire
 
namespace  gridfire::io
 
+
+
+ + + + diff --git a/docs/html/network__file_8cpp_source.html b/docs/html/network__file_8cpp_source.html new file mode 100644 index 00000000..0f9f14bd --- /dev/null +++ b/docs/html/network__file_8cpp_source.html @@ -0,0 +1,201 @@ + + + + + + + +GridFire: src/network/lib/io/network_file.cpp Source File + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
network_file.cpp
+
+
+Go to the documentation of this file.
1#include "gridfire/io/network_file.h"
+
2
+
3#include <string>
+
4#include <vector>
+
5#include <algorithm>
+
6#include <fstream>
+
7#include <stdexcept>
+
8
+
9#include "quill/LogMacros.h"
+
10
+
11namespace gridfire::io {
+
12 namespace {
+
13 inline void ltrim(std::string &s) {
+
14 s.erase(
+
15 s.begin(),
+
16 std::ranges::find_if(s,
+
17 [](const unsigned char ch) {
+
18 return !std::isspace(ch);
+
19 })
+
20 );
+
21 }
+
22
+
23 inline void rtrim(std::string &s) {
+
24 s.erase(
+
25 std::find_if(
+
26 s.rbegin(),
+
27 s.rend(),
+
28 [](const unsigned char ch) {
+
29 return !std::isspace(ch);
+
30 }).base(),
+
31 s.end()
+
32 );
+
33 }
+
34
+
35 inline void trim(std::string &s) {
+
36 ltrim(s);
+
37 rtrim(s);
+
38 }
+
39
+
40
+
41 }
+
42 SimpleReactionListFileParser::SimpleReactionListFileParser() {}
+
43
+
+
44 ParsedNetworkData SimpleReactionListFileParser::parse(const std::string& filename) const {
+
45 LOG_TRACE_L1(m_logger, "Parsing simple reaction list file: {}", filename);
+
46
+
47 std::ifstream file(filename);
+
48 if (!file.is_open()) {
+
49 LOG_ERROR(m_logger, "Failed to open file: {}", filename);
+
50 m_logger -> flush_log();
+
51 throw std::runtime_error("Could not open file: " + filename);
+
52 }
+
53
+
54 ParsedNetworkData parsed;
+
55 std::string line;
+
56 int line_number = 0;
+
57 while (std::getline(file, line)) {
+
58 line_number++;
+
59 LOG_TRACE_L3(m_logger, "Parsing reaction list file {}, line {}: {}", filename, line_number, line);
+
60
+
61 const size_t comment_pos = line.find('#');
+
62 if (comment_pos != std::string::npos) {
+
63 line = line.substr(0, comment_pos);
+
64 }
+
65
+
66 trim(line);
+
67
+
68 if (line.empty()) {
+
69 continue; // Skip empty lines
+
70 }
+
71 parsed.reactionPENames.push_back(line);
+
72 }
+
73 LOG_TRACE_L1(m_logger, "Parsed {} reactions from file: {}", parsed.reactionPENames.size(), filename);
+
74 return parsed;
+
75 }
+
+
76
+
77}
+
gridfire::io::SimpleReactionListFileParser::parse
ParsedNetworkData parse(const std::string &filename) const override
Definition network_file.cpp:44
+ + + +
network_file.h
+ +
gridfire::io::ParsedNetworkData::reactionPENames
std::vector< std::string > reactionPENames
Definition network_file.h:14
+
+
+ + + + diff --git a/docs/html/network__file_8h.html b/docs/html/network__file_8h.html new file mode 100644 index 00000000..00e5c921 --- /dev/null +++ b/docs/html/network__file_8h.html @@ -0,0 +1,144 @@ + + + + + + + +GridFire: src/network/include/gridfire/io/network_file.h File Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Classes | +Namespaces
+
network_file.h File Reference
+
+
+
#include "fourdst/config/config.h"
+#include "fourdst/logging/logging.h"
+#include "quill/Logger.h"
+#include <string>
+#include <vector>
+
+

Go to the source code of this file.

+ + + + + + + + + + +

+Classes

struct  gridfire::io::ParsedNetworkData
 
class  gridfire::io::NetworkFileParser
 
class  gridfire::io::SimpleReactionListFileParser
 
class  gridfire::io::MESANetworkFileParser
 
+ + + + + +

+Namespaces

namespace  gridfire
 
namespace  gridfire::io
 
+
+
+ + + + diff --git a/docs/html/network__file_8h.js b/docs/html/network__file_8h.js new file mode 100644 index 00000000..94a5779d --- /dev/null +++ b/docs/html/network__file_8h.js @@ -0,0 +1,7 @@ +var network__file_8h = +[ + [ "gridfire::io::ParsedNetworkData", "structgridfire_1_1io_1_1_parsed_network_data.html", "structgridfire_1_1io_1_1_parsed_network_data" ], + [ "gridfire::io::NetworkFileParser", "classgridfire_1_1io_1_1_network_file_parser.html", "classgridfire_1_1io_1_1_network_file_parser" ], + [ "gridfire::io::SimpleReactionListFileParser", "classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html", "classgridfire_1_1io_1_1_simple_reaction_list_file_parser" ], + [ "gridfire::io::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" ] +]; \ No newline at end of file diff --git a/docs/html/network__file_8h_source.html b/docs/html/network__file_8h_source.html new file mode 100644 index 00000000..4c147fac --- /dev/null +++ b/docs/html/network__file_8h_source.html @@ -0,0 +1,192 @@ + + + + + + + +GridFire: src/network/include/gridfire/io/network_file.h Source File + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
network_file.h
+
+
+Go to the documentation of this file.
1#pragma once
+
2
+
3#include "fourdst/config/config.h"
+
4#include "fourdst/logging/logging.h"
+
5
+
6#include "quill/Logger.h"
+
7
+
8#include <string>
+
9#include <vector>
+
10
+
+
11namespace gridfire::io {
+
12
+
+
13 struct ParsedNetworkData {
+
14 std::vector<std::string> reactionPENames;
+
15 };
+
+
16
+
+
17 class NetworkFileParser {
+
18 public:
+
19 virtual ~NetworkFileParser() = default;
+
20
+
21 [[nodiscard]] virtual ParsedNetworkData parse(const std::string& filename) const = 0;
+
22
+
23 };
+
+
24
+
+
25 class SimpleReactionListFileParser final : public NetworkFileParser {
+
26 public:
+
27 explicit SimpleReactionListFileParser();
+
28 ParsedNetworkData parse(const std::string& filename) const override;
+
29 private:
+
30 using Config = fourdst::config::Config;
+
31 using LogManager = fourdst::logging::LogManager;
+
32 Config& m_config = Config::getInstance();
+
33 quill::Logger* m_logger = LogManager::getInstance().getLogger("log");
+
34 };
+
+
35
+
+
36 class MESANetworkFileParser final : public NetworkFileParser {
+
37 public:
+
38 explicit MESANetworkFileParser(const std::string& filename);
+
39 ParsedNetworkData parse(const std::string& filename) const override;
+
40 private:
+
41 using Config = fourdst::config::Config;
+
42 using LogManager = fourdst::logging::LogManager;
+
43 Config& m_config = Config::getInstance();
+
44 quill::Logger* m_logger = LogManager::getInstance().getLogger("log");
+
45
+
46 std::string m_filename;
+
47 };
+
+
48}
+
+
gridfire::io::MESANetworkFileParser::parse
ParsedNetworkData parse(const std::string &filename) const override
+
gridfire::io::MESANetworkFileParser::LogManager
fourdst::logging::LogManager LogManager
Definition network_file.h:42
+ + +
gridfire::io::MESANetworkFileParser::MESANetworkFileParser
MESANetworkFileParser(const std::string &filename)
+ +
gridfire::io::MESANetworkFileParser::Config
fourdst::config::Config Config
Definition network_file.h:41
+ +
gridfire::io::NetworkFileParser::parse
virtual ParsedNetworkData parse(const std::string &filename) const =0
+
gridfire::io::NetworkFileParser::~NetworkFileParser
virtual ~NetworkFileParser()=default
+ +
gridfire::io::SimpleReactionListFileParser::parse
ParsedNetworkData parse(const std::string &filename) const override
Definition network_file.cpp:44
+
gridfire::io::SimpleReactionListFileParser::LogManager
fourdst::logging::LogManager LogManager
Definition network_file.h:31
+ + + + + +
gridfire::io::ParsedNetworkData::reactionPENames
std::vector< std::string > reactionPENames
Definition network_file.h:14
+
+
+ + + + diff --git a/docs/html/screening__abstract_8h.html b/docs/html/screening__abstract_8h.html new file mode 100644 index 00000000..82655e56 --- /dev/null +++ b/docs/html/screening__abstract_8h.html @@ -0,0 +1,137 @@ + + + + + + + +GridFire: src/network/include/gridfire/screening/screening_abstract.h File Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Classes | +Namespaces
+
screening_abstract.h File Reference
+
+
+
#include "gridfire/reaction/reaction.h"
+#include "fourdst/composition/atomicSpecies.h"
+#include "cppad/cppad.hpp"
+#include <vector>
+
+

Go to the source code of this file.

+ + + + +

+Classes

class  gridfire::screening::ScreeningModel
 
+ + + + + +

+Namespaces

namespace  gridfire
 
namespace  gridfire::screening
 
+
+
+ + + + diff --git a/docs/html/screening__abstract_8h.js b/docs/html/screening__abstract_8h.js new file mode 100644 index 00000000..8514e8e3 --- /dev/null +++ b/docs/html/screening__abstract_8h.js @@ -0,0 +1,4 @@ +var screening__abstract_8h = +[ + [ "gridfire::screening::ScreeningModel", "classgridfire_1_1screening_1_1_screening_model.html", "classgridfire_1_1screening_1_1_screening_model" ] +]; \ No newline at end of file diff --git a/docs/html/screening__abstract_8h_source.html b/docs/html/screening__abstract_8h_source.html new file mode 100644 index 00000000..b6681763 --- /dev/null +++ b/docs/html/screening__abstract_8h_source.html @@ -0,0 +1,160 @@ + + + + + + + +GridFire: src/network/include/gridfire/screening/screening_abstract.h Source File + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
screening_abstract.h
+
+
+Go to the documentation of this file.
1#pragma once
+
2
+
3#include "gridfire/reaction/reaction.h"
+
4
+
5#include "fourdst/composition/atomicSpecies.h"
+
6
+
7#include "cppad/cppad.hpp"
+
8
+
9#include <vector>
+
10
+
+
11namespace gridfire::screening {
+
+
12 class ScreeningModel {
+
13 public:
+
14 using ADDouble = CppAD::AD<double>;
+
15 virtual ~ScreeningModel() = default;
+
16
+
17 virtual std::vector<double> calculateScreeningFactors(
+
18 const reaction::LogicalReactionSet& reactions,
+
19 const std::vector<fourdst::atomic::Species>& species,
+
20 const std::vector<double>& Y,
+
21 const double T9,
+
22 const double rho
+
23 ) const = 0;
+
24
+
25 virtual std::vector<ADDouble> calculateScreeningFactors(
+
26 const reaction::LogicalReactionSet& reactions,
+
27 const std::vector<fourdst::atomic::Species>& species,
+
28 const std::vector<ADDouble>& Y,
+
29 const ADDouble T9,
+
30 const ADDouble rho
+
31 ) const = 0;
+
32 };
+
+
33}
+
+ + +
gridfire::screening::ScreeningModel::calculateScreeningFactors
virtual std::vector< ADDouble > calculateScreeningFactors(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< ADDouble > &Y, const ADDouble T9, const ADDouble rho) const =0
+
gridfire::screening::ScreeningModel::calculateScreeningFactors
virtual std::vector< double > calculateScreeningFactors(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, const double T9, const double rho) const =0
+ +
gridfire::reaction::LogicalReactionSet
TemplatedReactionSet< LogicalReaction > LogicalReactionSet
A set of logical reactions.
Definition reaction.h:557
+ +
reaction.h
Defines classes for representing and managing nuclear reactions.
+
+
+ + + + diff --git a/docs/html/screening__bare_8cpp.html b/docs/html/screening__bare_8cpp.html new file mode 100644 index 00000000..c2973961 --- /dev/null +++ b/docs/html/screening__bare_8cpp.html @@ -0,0 +1,137 @@ + + + + + + + +GridFire: src/network/lib/screening/screening_bare.cpp File Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Namespaces | +Typedefs
+
screening_bare.cpp File Reference
+
+
+
#include "gridfire/screening/screening_bare.h"
+#include "fourdst/composition/atomicSpecies.h"
+#include "cppad/cppad.hpp"
+#include <vector>
+
+

Go to the source code of this file.

+ + + + + + +

+Namespaces

namespace  gridfire
 
namespace  gridfire::screening
 
+ + + +

+Typedefs

using gridfire::screening::ADDouble = CppAD::AD<double>
 
+
+
+ + + + diff --git a/docs/html/screening__bare_8cpp.js b/docs/html/screening__bare_8cpp.js new file mode 100644 index 00000000..1c2cd027 --- /dev/null +++ b/docs/html/screening__bare_8cpp.js @@ -0,0 +1,4 @@ +var screening__bare_8cpp = +[ + [ "gridfire::screening::ADDouble", "namespacegridfire_1_1screening.html#ae7dd1a7ccb7bf3c05084094ab008d8a3", null ] +]; \ No newline at end of file diff --git a/docs/html/screening__bare_8cpp_source.html b/docs/html/screening__bare_8cpp_source.html new file mode 100644 index 00000000..617cfcb6 --- /dev/null +++ b/docs/html/screening__bare_8cpp_source.html @@ -0,0 +1,157 @@ + + + + + + + +GridFire: src/network/lib/screening/screening_bare.cpp Source File + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
screening_bare.cpp
+
+
+Go to the documentation of this file.
1#include "gridfire/screening/screening_bare.h"
+
2
+
3#include "fourdst/composition/atomicSpecies.h"
+
4
+
5#include "cppad/cppad.hpp"
+
6
+
7#include <vector>
+
8
+
9
+
10namespace gridfire::screening {
+
11 using ADDouble = CppAD::AD<double>;
+
+
12 std::vector<ADDouble> BareScreeningModel::calculateScreeningFactors(
+
13 const reaction::LogicalReactionSet &reactions,
+
14 const std::vector<fourdst::atomic::Species>& species,
+
15 const std::vector<ADDouble> &Y,
+
16 const ADDouble T9,
+
17 const ADDouble rho
+
18 ) const {
+
19 return calculateFactors_impl<ADDouble>(reactions, species, Y, T9, rho);
+
20 }
+
+
21
+
+
22 std::vector<double> BareScreeningModel::calculateScreeningFactors(
+
23 const reaction::LogicalReactionSet &reactions,
+
24 const std::vector<fourdst::atomic::Species>& species,
+
25 const std::vector<double> &Y,
+
26 const double T9,
+
27 const double rho
+
28 ) const {
+
29 return calculateFactors_impl<double>(reactions, species, Y, T9, rho);
+
30 }
+
+
31}
+ +
gridfire::screening::BareScreeningModel::calculateFactors_impl
std::vector< T > calculateFactors_impl(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< T > &Y, const T T9, const T rho) const
Definition screening_bare.h:39
+
gridfire::screening::BareScreeningModel::calculateScreeningFactors
std::vector< double > calculateScreeningFactors(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, const double T9, const double rho) const override
Definition screening_bare.cpp:22
+
gridfire::reaction::LogicalReactionSet
TemplatedReactionSet< LogicalReaction > LogicalReactionSet
A set of logical reactions.
Definition reaction.h:557
+ +
gridfire::screening::ADDouble
CppAD::AD< double > ADDouble
Definition screening_bare.cpp:11
+
screening_bare.h
+
+
+ + + + diff --git a/docs/html/screening__bare_8h.html b/docs/html/screening__bare_8h.html new file mode 100644 index 00000000..c761d881 --- /dev/null +++ b/docs/html/screening__bare_8h.html @@ -0,0 +1,136 @@ + + + + + + + +GridFire: src/network/include/gridfire/screening/screening_bare.h File Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Classes | +Namespaces
+
screening_bare.h File Reference
+
+
+
#include "gridfire/screening/screening_abstract.h"
+#include "gridfire/reaction/reaction.h"
+#include "cppad/cppad.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Classes

class  gridfire::screening::BareScreeningModel
 
+ + + + + +

+Namespaces

namespace  gridfire
 
namespace  gridfire::screening
 
+
+
+ + + + diff --git a/docs/html/screening__bare_8h.js b/docs/html/screening__bare_8h.js new file mode 100644 index 00000000..1071e911 --- /dev/null +++ b/docs/html/screening__bare_8h.js @@ -0,0 +1,4 @@ +var screening__bare_8h = +[ + [ "gridfire::screening::BareScreeningModel", "classgridfire_1_1screening_1_1_bare_screening_model.html", "classgridfire_1_1screening_1_1_bare_screening_model" ] +]; \ No newline at end of file diff --git a/docs/html/screening__bare_8h_source.html b/docs/html/screening__bare_8h_source.html new file mode 100644 index 00000000..b0d4ecfd --- /dev/null +++ b/docs/html/screening__bare_8h_source.html @@ -0,0 +1,177 @@ + + + + + + + +GridFire: src/network/include/gridfire/screening/screening_bare.h Source File + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
screening_bare.h
+
+
+Go to the documentation of this file.
1#pragma once
+
2
+
3#include "gridfire/screening/screening_abstract.h"
+
4#include "gridfire/reaction/reaction.h"
+
5
+
6#include "cppad/cppad.hpp"
+
7
+
8namespace gridfire::screening {
+
+
9 class BareScreeningModel final : public ScreeningModel {
+
10 using ADDouble = CppAD::AD<double>;
+
11 public:
+
12 [[nodiscard]] std::vector<double> calculateScreeningFactors(
+
13 const reaction::LogicalReactionSet& reactions,
+
14 const std::vector<fourdst::atomic::Species>& species,
+
15 const std::vector<double>& Y,
+
16 const double T9,
+
17 const double rho
+
18 ) const override;
+
19
+
20 [[nodiscard]] std::vector<ADDouble> calculateScreeningFactors(
+
21 const reaction::LogicalReactionSet& reactions,
+
22 const std::vector<fourdst::atomic::Species>& species,
+
23 const std::vector<ADDouble>& Y,
+
24 const ADDouble T9,
+
25 const ADDouble rho
+
26 ) const override;
+
27 private:
+
28 template <typename T>
+
29 [[nodiscard]] std::vector<T> calculateFactors_impl(
+
30 const reaction::LogicalReactionSet& reactions,
+
31 const std::vector<fourdst::atomic::Species>& species,
+
32 const std::vector<T>& Y,
+
33 const T T9,
+
34 const T rho
+
35 ) const;
+
36 };
+
+
37
+
38 template<typename T>
+
+
39 std::vector<T> BareScreeningModel::calculateFactors_impl(
+
40 const reaction::LogicalReactionSet &reactions,
+
41 const std::vector<fourdst::atomic::Species> &species,
+
42 const std::vector<T> &Y,
+
43 const T T9,
+
44 const T rho
+
45 ) const {
+
46 return std::vector<T>(reactions.size(), T(1.0)); // Bare screening returns 1.0 for all reactions
+
47 }
+
+
48}
+
gridfire::reaction::TemplatedReactionSet::size
size_t size() const
Gets the number of reactions in the set.
Definition reaction.h:453
+ + +
gridfire::screening::BareScreeningModel::calculateFactors_impl
std::vector< T > calculateFactors_impl(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< T > &Y, const T T9, const T rho) const
Definition screening_bare.h:39
+
gridfire::screening::BareScreeningModel::calculateScreeningFactors
std::vector< double > calculateScreeningFactors(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, const double T9, const double rho) const override
Definition screening_bare.cpp:22
+ +
gridfire::reaction::LogicalReactionSet
TemplatedReactionSet< LogicalReaction > LogicalReactionSet
A set of logical reactions.
Definition reaction.h:557
+ +
reaction.h
Defines classes for representing and managing nuclear reactions.
+
screening_abstract.h
+
+
+ + + + diff --git a/docs/html/screening__types_8cpp.html b/docs/html/screening__types_8cpp.html new file mode 100644 index 00000000..dfd3ed88 --- /dev/null +++ b/docs/html/screening__types_8cpp.html @@ -0,0 +1,138 @@ + + + + + + + +GridFire: src/network/lib/screening/screening_types.cpp File Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Namespaces | +Functions
+
screening_types.cpp File Reference
+
+
+
#include "gridfire/screening/screening_abstract.h"
+#include "gridfire/screening/screening_types.h"
+#include "gridfire/screening/screening_weak.h"
+#include "gridfire/screening/screening_bare.h"
+#include <memory>
+
+

Go to the source code of this file.

+ + + + + + +

+Namespaces

namespace  gridfire
 
namespace  gridfire::screening
 
+ + + +

+Functions

std::unique_ptr< ScreeningModel > gridfire::screening::selectScreeningModel (ScreeningType type)
 
+
+
+ + + + diff --git a/docs/html/screening__types_8cpp.js b/docs/html/screening__types_8cpp.js new file mode 100644 index 00000000..4b965d58 --- /dev/null +++ b/docs/html/screening__types_8cpp.js @@ -0,0 +1,4 @@ +var screening__types_8cpp = +[ + [ "gridfire::screening::selectScreeningModel", "namespacegridfire_1_1screening.html#a6ca8556d27ac373e176f5b23437c416e", null ] +]; \ No newline at end of file diff --git a/docs/html/screening__types_8cpp_source.html b/docs/html/screening__types_8cpp_source.html new file mode 100644 index 00000000..2d43c7db --- /dev/null +++ b/docs/html/screening__types_8cpp_source.html @@ -0,0 +1,145 @@ + + + + + + + +GridFire: src/network/lib/screening/screening_types.cpp Source File + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
screening_types.cpp
+
+
+Go to the documentation of this file.
1#include "gridfire/screening/screening_abstract.h"
+
2#include "gridfire/screening/screening_types.h"
+
3#include "gridfire/screening/screening_weak.h"
+
4#include "gridfire/screening/screening_bare.h"
+
5
+
6#include <memory>
+
7
+
8namespace gridfire::screening {
+
+
9 std::unique_ptr<ScreeningModel> selectScreeningModel(const ScreeningType type) {
+
10 switch (type) {
+
11 case ScreeningType::WEAK:
+
12 return std::make_unique<WeakScreeningModel>();
+
13 case ScreeningType::BARE:
+
14 return std::make_unique<BareScreeningModel>();
+
15 default:
+
16 return std::make_unique<BareScreeningModel>();
+
17 }
+
18 }
+
+
19}
+ +
gridfire::screening::selectScreeningModel
std::unique_ptr< ScreeningModel > selectScreeningModel(ScreeningType type)
Definition screening_types.cpp:9
+ + + +
screening_abstract.h
+
screening_bare.h
+
screening_types.h
+
screening_weak.h
+
+
+ + + + diff --git a/docs/html/screening__types_8h.html b/docs/html/screening__types_8h.html new file mode 100644 index 00000000..f10c9153 --- /dev/null +++ b/docs/html/screening__types_8h.html @@ -0,0 +1,143 @@ + + + + + + + +GridFire: src/network/include/gridfire/screening/screening_types.h File Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Namespaces | +Enumerations | +Functions
+
screening_types.h File Reference
+
+
+
#include "gridfire/screening/screening_abstract.h"
+#include <memory>
+
+

Go to the source code of this file.

+ + + + + + +

+Namespaces

namespace  gridfire
 
namespace  gridfire::screening
 
+ + + +

+Enumerations

enum class  gridfire::screening::ScreeningType { gridfire::screening::BARE +, gridfire::screening::WEAK + }
 
+ + + +

+Functions

std::unique_ptr< ScreeningModel > gridfire::screening::selectScreeningModel (ScreeningType type)
 
+
+
+ + + + diff --git a/docs/html/screening__types_8h.js b/docs/html/screening__types_8h.js new file mode 100644 index 00000000..4ed95529 --- /dev/null +++ b/docs/html/screening__types_8h.js @@ -0,0 +1,8 @@ +var screening__types_8h = +[ + [ "gridfire::screening::ScreeningType", "namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25", [ + [ "gridfire::screening::ScreeningType::BARE", "namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25ad80b95b1abb9c8659fa4cc9d3d29bb71", null ], + [ "gridfire::screening::ScreeningType::WEAK", "namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25a32c7d8943bec86a6d7d5e03598670ca8", null ] + ] ], + [ "gridfire::screening::selectScreeningModel", "namespacegridfire_1_1screening.html#a6ca8556d27ac373e176f5b23437c416e", null ] +]; \ No newline at end of file diff --git a/docs/html/screening__types_8h_source.html b/docs/html/screening__types_8h_source.html new file mode 100644 index 00000000..80d74a93 --- /dev/null +++ b/docs/html/screening__types_8h_source.html @@ -0,0 +1,137 @@ + + + + + + + +GridFire: src/network/include/gridfire/screening/screening_types.h Source File + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
screening_types.h
+
+
+Go to the documentation of this file.
1#pragma once
+
2
+
3#include "gridfire/screening/screening_abstract.h"
+
4
+
5#include <memory>
+
6
+
7namespace gridfire::screening {
+
+
8 enum class ScreeningType {
+
9 BARE,
+
10 WEAK,
+
11 };
+
+
12
+
13 std::unique_ptr<ScreeningModel> selectScreeningModel(ScreeningType type);
+
14}
+ +
gridfire::screening::selectScreeningModel
std::unique_ptr< ScreeningModel > selectScreeningModel(ScreeningType type)
Definition screening_types.cpp:9
+ + + +
screening_abstract.h
+
+
+ + + + diff --git a/docs/html/screening__weak_8cpp.html b/docs/html/screening__weak_8cpp.html new file mode 100644 index 00000000..a6be5c6b --- /dev/null +++ b/docs/html/screening__weak_8cpp.html @@ -0,0 +1,131 @@ + + + + + + + +GridFire: src/network/lib/screening/screening_weak.cpp File Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Namespaces
+
screening_weak.cpp File Reference
+
+
+
#include "gridfire/screening/screening_weak.h"
+#include "fourdst/composition/atomicSpecies.h"
+#include "cppad/cppad.hpp"
+#include <vector>
+
+

Go to the source code of this file.

+ + + + + + +

+Namespaces

namespace  gridfire
 
namespace  gridfire::screening
 
+
+
+ + + + diff --git a/docs/html/screening__weak_8cpp_source.html b/docs/html/screening__weak_8cpp_source.html new file mode 100644 index 00000000..06488395 --- /dev/null +++ b/docs/html/screening__weak_8cpp_source.html @@ -0,0 +1,157 @@ + + + + + + + +GridFire: src/network/lib/screening/screening_weak.cpp Source File + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
screening_weak.cpp
+
+
+Go to the documentation of this file.
1#include "gridfire/screening/screening_weak.h"
+
2
+
3#include "fourdst/composition/atomicSpecies.h"
+
4
+
5#include "cppad/cppad.hpp"
+
6
+
7#include <vector>
+
8
+
9
+
10namespace gridfire::screening {
+
11 using ADDouble = CppAD::AD<double>;
+
+
12 std::vector<ADDouble> WeakScreeningModel::calculateScreeningFactors(
+
13 const reaction::LogicalReactionSet &reactions,
+
14 const std::vector<fourdst::atomic::Species>& species,
+
15 const std::vector<ADDouble> &Y,
+
16 const ADDouble T9,
+
17 const ADDouble rho
+
18 ) const {
+
19 return calculateFactors_impl<ADDouble>(reactions, species, Y, T9, rho);
+
20 }
+
+
21
+
+
22 std::vector<double> WeakScreeningModel::calculateScreeningFactors(
+
23 const reaction::LogicalReactionSet &reactions,
+
24 const std::vector<fourdst::atomic::Species>& species,
+
25 const std::vector<double> &Y,
+
26 const double T9,
+
27 const double rho
+
28 ) const {
+
29 return calculateFactors_impl<double>(reactions, species, Y, T9, rho);
+
30 }
+
+
31}
+ +
gridfire::screening::WeakScreeningModel::calculateFactors_impl
std::vector< T > calculateFactors_impl(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< T > &Y, const T T9, const T rho) const
Definition screening_weak.h:45
+
gridfire::screening::WeakScreeningModel::calculateScreeningFactors
std::vector< double > calculateScreeningFactors(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, const double T9, const double rho) const override
Definition screening_weak.cpp:22
+
gridfire::reaction::LogicalReactionSet
TemplatedReactionSet< LogicalReaction > LogicalReactionSet
A set of logical reactions.
Definition reaction.h:557
+ +
gridfire::screening::ADDouble
CppAD::AD< double > ADDouble
Definition screening_bare.cpp:11
+
screening_weak.h
+
+
+ + + + diff --git a/docs/html/screening__weak_8h.html b/docs/html/screening__weak_8h.html new file mode 100644 index 00000000..3edced81 --- /dev/null +++ b/docs/html/screening__weak_8h.html @@ -0,0 +1,139 @@ + + + + + + + +GridFire: src/network/include/gridfire/screening/screening_weak.h File Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Classes | +Namespaces
+
screening_weak.h File Reference
+
+
+
#include "gridfire/screening/screening_abstract.h"
+#include "gridfire/reaction/reaction.h"
+#include "fourdst/logging/logging.h"
+#include "quill/Logger.h"
+#include "quill/LogMacros.h"
+#include "cppad/cppad.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Classes

class  gridfire::screening::WeakScreeningModel
 
+ + + + + +

+Namespaces

namespace  gridfire
 
namespace  gridfire::screening
 
+
+
+ + + + diff --git a/docs/html/screening__weak_8h.js b/docs/html/screening__weak_8h.js new file mode 100644 index 00000000..957f3964 --- /dev/null +++ b/docs/html/screening__weak_8h.js @@ -0,0 +1,4 @@ +var screening__weak_8h = +[ + [ "gridfire::screening::WeakScreeningModel", "classgridfire_1_1screening_1_1_weak_screening_model.html", "classgridfire_1_1screening_1_1_weak_screening_model" ] +]; \ No newline at end of file diff --git a/docs/html/screening__weak_8h_source.html b/docs/html/screening__weak_8h_source.html new file mode 100644 index 00000000..09102027 --- /dev/null +++ b/docs/html/screening__weak_8h_source.html @@ -0,0 +1,247 @@ + + + + + + + +GridFire: src/network/include/gridfire/screening/screening_weak.h Source File + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
screening_weak.h
+
+
+Go to the documentation of this file.
1#pragma once
+
2
+
3#include "gridfire/screening/screening_abstract.h"
+
4#include "gridfire/reaction/reaction.h"
+
5
+
6#include "fourdst/logging/logging.h"
+
7#include "quill/Logger.h"
+
8#include "quill/LogMacros.h"
+
9
+
10#include "cppad/cppad.hpp"
+
11
+
12namespace gridfire::screening {
+
+
13 class WeakScreeningModel final : public ScreeningModel {
+
14 public:
+
15 [[nodiscard]] std::vector<double> calculateScreeningFactors(
+
16 const reaction::LogicalReactionSet& reactions,
+
17 const std::vector<fourdst::atomic::Species>& species,
+
18 const std::vector<double>& Y,
+
19 const double T9,
+
20 const double rho
+
21 ) const override;
+
22
+
23 [[nodiscard]] std::vector<CppAD::AD<double>> calculateScreeningFactors(
+
24 const reaction::LogicalReactionSet& reactions,
+
25 const std::vector<fourdst::atomic::Species>& species,
+
26 const std::vector<CppAD::AD<double>>& Y,
+
27 const CppAD::AD<double> T9,
+
28 const CppAD::AD<double> rho
+
29 ) const override;
+
30 private:
+
31 quill::Logger* m_logger = fourdst::logging::LogManager::getInstance().getLogger("log");
+
32
+
33 private:
+
34 template <typename T>
+
35 [[nodiscard]] std::vector<T> calculateFactors_impl(
+
36 const reaction::LogicalReactionSet& reactions,
+
37 const std::vector<fourdst::atomic::Species>& species,
+
38 const std::vector<T>& Y,
+
39 const T T9,
+
40 const T rho
+
41 ) const;
+
42 };
+
+
43
+
44 template <typename T>
+
+
45 std::vector<T> WeakScreeningModel::calculateFactors_impl(
+
46 const reaction::LogicalReactionSet& reactions,
+
47 const std::vector<fourdst::atomic::Species>& species,
+
48 const std::vector<T>& Y,
+
49 const T T9,
+
50 const T rho
+
51 ) const {
+
52 LOG_TRACE_L1(
+
53 m_logger,
+
54 "Calculating weak screening factors for {} reactions...",
+
55 reactions.size()
+
56 );
+
57 // --- CppAD Safe low temp checking ---
+
58 const T zero(0.0);
+
59 const T one(1.0);
+
60 const T low_temp_threshold(1e-9);
+
61
+
62 const T low_T_flag = CppAD::CondExpLt(T9, low_temp_threshold, zero, one);
+
63
+
64 // --- Calculate composition-dependent terms ---
+
65 // ζ = ∑(Z_i^2 + Z_i) * X_i / A_i
+
66 // This simplifies somewhat to ζ = ∑ (Z_i^2 + Z_i) * Y_i
+
67 // Where Y_i is the molar abundance (mol/g)
+
68 T zeta(0.0);
+
69 for (size_t i = 0; i < species.size(); ++i) {
+
70 const T Z = species[i].m_z;
+
71 zeta += (Z * Z + Z) * Y[i];
+
72 }
+
73
+
74 // --- Constant prefactors ---
+
75 const T T7 = T9 * static_cast<T>(100.00);
+
76 const T T7_safe = CppAD::CondExpLe(T7, low_temp_threshold, low_temp_threshold, T7);
+
77 const T prefactor = static_cast<T>(0.188) * CppAD::sqrt(rho / (T7_safe * T7_safe * T7_safe)) * CppAD::sqrt(zeta);
+
78
+
79 // --- Loop through reactions and calculate screening factors for each ---
+
80 std::vector<T> factors;
+
81 factors.reserve(reactions.size());
+
82 for (const auto& reaction : reactions) {
+
83 T H_12(0.0); // screening abundance term
+
84 const auto& reactants = reaction.reactants();
+
85 const bool isTripleAlpha = (
+
86 reactants.size() == 3 &&
+
87 reactants[0].m_z == 2 &&
+
88 reactants[1].m_z == 2 &&
+
89 reactants[2].m_z == 2 &&
+
90 reactants[0] == reactants[1] &&
+
91 reactants[1] == reactants[2]
+
92 );
+
93 if (reactants.size() == 2) {
+
94 LOG_TRACE_L3(m_logger, "Calculating screening factor for reaction: {}", reaction.peName());
+
95 const T Z1 = static_cast<T>(reactants[0].m_z);
+
96 const T Z2 = static_cast<T>(reactants[1].m_z);
+
97 H_12 = prefactor * Z1 * Z2;
+
98 }
+
99 else if (isTripleAlpha) {
+
100 LOG_TRACE_L3(m_logger, "Special case for triple alpha process in reaction: {}", reaction.peName());
+
101 // Special case for triple alpha process
+
102 const T Z_alpha = static_cast<T>(2.0);
+
103 const T H_alpha_alpha = prefactor * Z_alpha * Z_alpha;
+
104 H_12 = static_cast<T>(3.0) * H_alpha_alpha; // Triple alpha process
+
105 }
+
106 // For 1 body reactions H_12 remains 0 so e^H_12 will be 1.0 (screening does not apply)
+
107 // Aside from triple alpha, all other astrophysically relevant reactions are 2-body in the weak screening regime
+
108
+
109 H_12 *= low_T_flag; // Apply low temperature flag to screening factor
+
110 H_12 = CppAD::CondExpGe(H_12, static_cast<T>(2.0), static_cast<T>(2.0), H_12); // Caps the screening factor at 10 to avoid numerical issues
+
111 factors.push_back(CppAD::exp(H_12));
+
112 // std::cout << "Screening factor: " << reaction.peName() << " : " << factors.back() << "(" << H_12 << ")" << std::endl;
+
113 }
+
114 return factors;
+
115 }
+
+
116
+
117}
+
gridfire::reaction::TemplatedReactionSet::size
size_t size() const
Gets the number of reactions in the set.
Definition reaction.h:453
+ + + +
gridfire::screening::WeakScreeningModel::calculateFactors_impl
std::vector< T > calculateFactors_impl(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< T > &Y, const T T9, const T rho) const
Definition screening_weak.h:45
+
gridfire::screening::WeakScreeningModel::calculateScreeningFactors
std::vector< double > calculateScreeningFactors(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, const double T9, const double rho) const override
Definition screening_weak.cpp:22
+ +
gridfire::reaction::LogicalReactionSet
TemplatedReactionSet< LogicalReaction > LogicalReactionSet
A set of logical reactions.
Definition reaction.h:557
+ +
reaction.h
Defines classes for representing and managing nuclear reactions.
+
screening_abstract.h
+
+
+ + + + diff --git a/docs/html/search/all_16.js b/docs/html/search/all_16.js new file mode 100644 index 00000000..25f1c01d --- /dev/null +++ b/docs/html/search/all_16.js @@ -0,0 +1,10 @@ +var searchData= +[ + ['_7eengine_0',['~Engine',['../classgridfire_1_1_engine.html#a2e7970bed2100699f226f4141d5db037',1,'gridfire::Engine']]], + ['_7eengineview_1',['~EngineView',['../classgridfire_1_1_engine_view.html#a994660f2d553f3a123512dc5eb421e74',1,'gridfire::EngineView']]], + ['_7enetwork_2',['~Network',['../classgridfire_1_1_network.html#ab8d83289b62dda9b4e02f25311f85b79',1,'gridfire::Network']]], + ['_7enetworkfileparser_3',['~NetworkFileParser',['../classgridfire_1_1io_1_1_network_file_parser.html#a9b4095d06fad5df3805c92ae97b3eab3',1,'gridfire::io::NetworkFileParser']]], + ['_7enetworksolverstrategy_4',['~NetworkSolverStrategy',['../classgridfire_1_1solver_1_1_network_solver_strategy.html#a1693dc93f63599c89587d729aca8e318',1,'gridfire::solver::NetworkSolverStrategy']]], + ['_7ereaction_5',['~Reaction',['../classgridfire_1_1reaction_1_1_reaction.html#ab1860df84843be70f97469761e11ab6a',1,'gridfire::reaction::Reaction']]], + ['_7escreeningmodel_6',['~ScreeningModel',['../classgridfire_1_1screening_1_1_screening_model.html#adef175acdbd911527f56a1f1592579a7',1,'gridfire::screening::ScreeningModel']]] +]; diff --git a/docs/html/search/classes_10.js b/docs/html/search/classes_10.js new file mode 100644 index 00000000..7d857f9a --- /dev/null +++ b/docs/html/search/classes_10.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['templatedreactionset_0',['TemplatedReactionSet',['../classgridfire_1_1reaction_1_1_templated_reaction_set.html',1,'gridfire::reaction']]], + ['templatedreactionset_3c_20logicalreaction_20_3e_1',['TemplatedReactionSet< LogicalReaction >',['../classgridfire_1_1reaction_1_1_templated_reaction_set.html',1,'gridfire::reaction']]], + ['templatedreactionset_3c_20reaction_20_3e_2',['TemplatedReactionSet< Reaction >',['../classgridfire_1_1reaction_1_1_templated_reaction_set.html',1,'gridfire::reaction']]] +]; diff --git a/docs/html/search/classes_11.js b/docs/html/search/classes_11.js new file mode 100644 index 00000000..1dd77162 --- /dev/null +++ b/docs/html/search/classes_11.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['weakscreeningmodel_0',['WeakScreeningModel',['../classgridfire_1_1screening_1_1_weak_screening_model.html',1,'gridfire::screening']]] +]; diff --git a/docs/html/search/classes_c.js b/docs/html/search/classes_c.js new file mode 100644 index 00000000..8cf5d300 --- /dev/null +++ b/docs/html/search/classes_c.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['parsednetworkdata_0',['ParsedNetworkData',['../structgridfire_1_1io_1_1_parsed_network_data.html',1,'gridfire::io']]] +]; diff --git a/docs/html/search/classes_d.js b/docs/html/search/classes_d.js new file mode 100644 index 00000000..15405506 --- /dev/null +++ b/docs/html/search/classes_d.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['qsenetworksolver_0',['QSENetworkSolver',['../classgridfire_1_1solver_1_1_q_s_e_network_solver.html',1,'gridfire::solver']]] +]; diff --git a/docs/html/search/classes_e.js b/docs/html/search/classes_e.js new file mode 100644 index 00000000..8d4f1cca --- /dev/null +++ b/docs/html/search/classes_e.js @@ -0,0 +1,8 @@ +var searchData= +[ + ['ratecoefficientset_0',['RateCoefficientSet',['../structgridfire_1_1reaction_1_1_rate_coefficient_set.html',1,'gridfire::reaction']]], + ['reaction_1',['Reaction',['../classgridfire_1_1reaction_1_1_reaction.html',1,'gridfire::reaction']]], + ['reactionflow_2',['ReactionFlow',['../structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html',1,'gridfire::AdaptiveEngineView']]], + ['reactionrecord_3',['ReactionRecord',['../structgridfire_1_1reaclib_1_1_reaction_record.html',1,'gridfire::reaclib']]], + ['rhsfunctor_4',['RHSFunctor',['../structgridfire_1_1solver_1_1_direct_network_solver_1_1_r_h_s_functor.html',1,'gridfire::solver::DirectNetworkSolver::RHSFunctor'],['../structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html',1,'gridfire::solver::QSENetworkSolver::RHSFunctor']]] +]; diff --git a/docs/html/search/classes_f.js b/docs/html/search/classes_f.js new file mode 100644 index 00000000..491485fa --- /dev/null +++ b/docs/html/search/classes_f.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['screeningmodel_0',['ScreeningModel',['../classgridfire_1_1screening_1_1_screening_model.html',1,'gridfire::screening']]], + ['simplereactionlistfileparser_1',['SimpleReactionListFileParser',['../classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html',1,'gridfire::io']]], + ['stepderivatives_2',['StepDerivatives',['../structgridfire_1_1_step_derivatives.html',1,'gridfire']]] +]; diff --git a/docs/html/search/enums_1.js b/docs/html/search/enums_1.js new file mode 100644 index 00000000..8414b3cb --- /dev/null +++ b/docs/html/search/enums_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['screeningtype_0',['ScreeningType',['../namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25',1,'gridfire::screening']]] +]; diff --git a/docs/html/search/enumvalues_3.js b/docs/html/search/enumvalues_3.js new file mode 100644 index 00000000..d2dca6c8 --- /dev/null +++ b/docs/html/search/enumvalues_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['reaclib_0',['REACLIB',['../namespacegridfire.html#a3f3d6b3f9742b70e62049ccefbb60f37a9b8db7b445ae4f1bd114caa42a583182',1,'gridfire']]] +]; diff --git a/docs/html/search/enumvalues_4.js b/docs/html/search/enumvalues_4.js new file mode 100644 index 00000000..37f42e24 --- /dev/null +++ b/docs/html/search/enumvalues_4.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['unknown_0',['UNKNOWN',['../namespacegridfire.html#a3f3d6b3f9742b70e62049ccefbb60f37aac700abde5f6ff8b7328193eb19697b2',1,'gridfire']]] +]; diff --git a/docs/html/search/enumvalues_5.js b/docs/html/search/enumvalues_5.js new file mode 100644 index 00000000..1bf67417 --- /dev/null +++ b/docs/html/search/enumvalues_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['valuesatcompiletime_0',['ValuesAtCompileTime',['../structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_eigen_functor.html#a1bff36d14c3e1f7a276d9fe6b564abdfac9e03a0ebbba30da72c7591639a69a09',1,'gridfire::solver::QSENetworkSolver::EigenFunctor']]] +]; diff --git a/docs/html/search/enumvalues_6.js b/docs/html/search/enumvalues_6.js new file mode 100644 index 00000000..720075f0 --- /dev/null +++ b/docs/html/search/enumvalues_6.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['weak_0',['WEAK',['../namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25a32c7d8943bec86a6d7d5e03598670ca8',1,'gridfire::screening']]] +]; diff --git a/docs/html/search/files_5.js b/docs/html/search/files_5.js new file mode 100644 index 00000000..04e8201a --- /dev/null +++ b/docs/html/search/files_5.js @@ -0,0 +1,12 @@ +var searchData= +[ + ['screening_5fabstract_2eh_0',['screening_abstract.h',['../screening__abstract_8h.html',1,'']]], + ['screening_5fbare_2ecpp_1',['screening_bare.cpp',['../screening__bare_8cpp.html',1,'']]], + ['screening_5fbare_2eh_2',['screening_bare.h',['../screening__bare_8h.html',1,'']]], + ['screening_5ftypes_2ecpp_3',['screening_types.cpp',['../screening__types_8cpp.html',1,'']]], + ['screening_5ftypes_2eh_4',['screening_types.h',['../screening__types_8h.html',1,'']]], + ['screening_5fweak_2ecpp_5',['screening_weak.cpp',['../screening__weak_8cpp.html',1,'']]], + ['screening_5fweak_2eh_6',['screening_weak.h',['../screening__weak_8h.html',1,'']]], + ['solver_2ecpp_7',['solver.cpp',['../solver_8cpp.html',1,'']]], + ['solver_2eh_8',['solver.h',['../solver_8h.html',1,'']]] +]; diff --git a/docs/html/search/functions_15.js b/docs/html/search/functions_15.js new file mode 100644 index 00000000..25f1c01d --- /dev/null +++ b/docs/html/search/functions_15.js @@ -0,0 +1,10 @@ +var searchData= +[ + ['_7eengine_0',['~Engine',['../classgridfire_1_1_engine.html#a2e7970bed2100699f226f4141d5db037',1,'gridfire::Engine']]], + ['_7eengineview_1',['~EngineView',['../classgridfire_1_1_engine_view.html#a994660f2d553f3a123512dc5eb421e74',1,'gridfire::EngineView']]], + ['_7enetwork_2',['~Network',['../classgridfire_1_1_network.html#ab8d83289b62dda9b4e02f25311f85b79',1,'gridfire::Network']]], + ['_7enetworkfileparser_3',['~NetworkFileParser',['../classgridfire_1_1io_1_1_network_file_parser.html#a9b4095d06fad5df3805c92ae97b3eab3',1,'gridfire::io::NetworkFileParser']]], + ['_7enetworksolverstrategy_4',['~NetworkSolverStrategy',['../classgridfire_1_1solver_1_1_network_solver_strategy.html#a1693dc93f63599c89587d729aca8e318',1,'gridfire::solver::NetworkSolverStrategy']]], + ['_7ereaction_5',['~Reaction',['../classgridfire_1_1reaction_1_1_reaction.html#ab1860df84843be70f97469761e11ab6a',1,'gridfire::reaction::Reaction']]], + ['_7escreeningmodel_6',['~ScreeningModel',['../classgridfire_1_1screening_1_1_screening_model.html#adef175acdbd911527f56a1f1592579a7',1,'gridfire::screening::ScreeningModel']]] +]; diff --git a/docs/html/search/typedefs_a.js b/docs/html/search/typedefs_a.js new file mode 100644 index 00000000..4c09a1c9 --- /dev/null +++ b/docs/html/search/typedefs_a.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['vec7_0',['vec7',['../namespacegridfire_1_1approx8.html#aaa49cb0c9ad4b0b9dd0f9b5e192ca12a',1,'gridfire::approx8']]], + ['vector_5ftype_1',['vector_type',['../namespacegridfire_1_1approx8.html#aa04f907d4ef6a1b6b2a9a28d4bb53882',1,'gridfire::approx8']]] +]; diff --git a/docs/html/structgridfire_1_1io_1_1_parsed_network_data-members.html b/docs/html/structgridfire_1_1io_1_1_parsed_network_data-members.html new file mode 100644 index 00000000..12cc2010 --- /dev/null +++ b/docs/html/structgridfire_1_1io_1_1_parsed_network_data-members.html @@ -0,0 +1,118 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
gridfire::io::ParsedNetworkData Member List
+
+
+ +

This is the complete list of members for gridfire::io::ParsedNetworkData, including all inherited members.

+ + +
reactionPENamesgridfire::io::ParsedNetworkData
+
+ + + + diff --git a/docs/html/structgridfire_1_1io_1_1_parsed_network_data.html b/docs/html/structgridfire_1_1io_1_1_parsed_network_data.html new file mode 100644 index 00000000..4d7c6f65 --- /dev/null +++ b/docs/html/structgridfire_1_1io_1_1_parsed_network_data.html @@ -0,0 +1,149 @@ + + + + + + + +GridFire: gridfire::io::ParsedNetworkData Struct Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Attributes | +List of all members
+
gridfire::io::ParsedNetworkData Struct Reference
+
+
+ +

#include <network_file.h>

+ + + + +

+Public Attributes

std::vector< std::string > reactionPENames
 
+

Detailed Description

+
+

Definition at line 13 of file network_file.h.

+

Member Data Documentation

+ +

◆ reactionPENames

+ +
+
+ + + + +
std::vector<std::string> gridfire::io::ParsedNetworkData::reactionPENames
+
+ +

Definition at line 14 of file network_file.h.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structgridfire_1_1io_1_1_parsed_network_data.js b/docs/html/structgridfire_1_1io_1_1_parsed_network_data.js new file mode 100644 index 00000000..3bd448b5 --- /dev/null +++ b/docs/html/structgridfire_1_1io_1_1_parsed_network_data.js @@ -0,0 +1,4 @@ +var structgridfire_1_1io_1_1_parsed_network_data = +[ + [ "reactionPENames", "structgridfire_1_1io_1_1_parsed_network_data.html#a5145c672877638e6113abf1f719b246d", null ] +]; \ No newline at end of file diff --git a/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1_logical_reaction_set_01_4-members.html b/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1_logical_reaction_set_01_4-members.html new file mode 100644 index 00000000..bdc4a5b2 --- /dev/null +++ b/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1_logical_reaction_set_01_4-members.html @@ -0,0 +1,118 @@ + + + + + + + +GridFire: Member List + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
std::hash< gridfire::reaction::LogicalReactionSet > Member List
+
+
+ +

This is the complete list of members for std::hash< gridfire::reaction::LogicalReactionSet >, including all inherited members.

+ + +
operator()(const gridfire::reaction::LogicalReactionSet &s) const noexceptstd::hash< gridfire::reaction::LogicalReactionSet >inline
+
+ + + + diff --git a/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1_logical_reaction_set_01_4.html b/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1_logical_reaction_set_01_4.html new file mode 100644 index 00000000..e2405753 --- /dev/null +++ b/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1_logical_reaction_set_01_4.html @@ -0,0 +1,158 @@ + + + + + + + +GridFire: std::hash< gridfire::reaction::LogicalReactionSet > Struct Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
GridFire 0.0.1a +
+
General Purpose Nuclear Network
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Public Member Functions | +List of all members
+
std::hash< gridfire::reaction::LogicalReactionSet > Struct Reference
+
+
+ + + + +

+Public Member Functions

size_t operator() (const gridfire::reaction::LogicalReactionSet &s) const noexcept
 
+

Detailed Description

+
+

Definition at line 235 of file reaction.cpp.

+

Member Function Documentation

+ +

◆ operator()()

+ +
+
+ + + + + +
+ + + + + + + +
size_t std::hash< gridfire::reaction::LogicalReactionSet >::operator() (const gridfire::reaction::LogicalReactionSet & s) const
+ 		+inlinenoexcept
+
+ +

Definition at line 236 of file reaction.cpp.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1_logical_reaction_set_01_4.js b/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1_logical_reaction_set_01_4.js new file mode 100644 index 00000000..43228a4e --- /dev/null +++ b/docs/html/structstd_1_1hash_3_01gridfire_1_1reaction_1_1_logical_reaction_set_01_4.js @@ -0,0 +1,4 @@ +var structstd_1_1hash_3_01gridfire_1_1reaction_1_1_logical_reaction_set_01_4 = +[ + [ "operator()", "structstd_1_1hash_3_01gridfire_1_1reaction_1_1_logical_reaction_set_01_4.html#a4b76e7119050266952ded94d6f0544cb", null ] +]; \ No newline at end of file