GridFire 0.0.1a
General Purpose Nuclear Network
Loading...
Searching...
No Matches
Public Member Functions | Private Types | Private Attributes | List of all members
gridfire::FileDefinedEngineView Class Referencefinal

#include <engine_defined.h>

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

Public Member Functions

 FileDefinedEngineView (DynamicEngine &baseEngine, const std::string &fileName, const io::NetworkFileParser &parser)
 FileDefinedEngineView Implementation ///.
 
std::string getNetworkFile () const
 
const io::NetworkFileParser & getParser () const
 
- Public Member Functions inherited from gridfire::DefinedEngineView
 DefinedEngineView (const std::vector< std::string > &peNames, DynamicEngine &baseEngine)
 
const DynamicEngine & getBaseEngine () const override
 Access the underlying engine instance.
 
const std::vector< fourdst::atomic::Species > & getNetworkSpecies () const override
 Gets the list of active species in the network defined by the file.
 
std::expected< StepDerivatives< double >, expectations::StaleEngineError > calculateRHSAndEnergy (const std::vector< double > &Y_defined, const double T9, const double rho) const override
 Calculates the right-hand side (dY/dt) and energy generation for the active species.
 
void generateJacobianMatrix (const std::vector< double > &Y_dynamic, const double T9, const double rho) const override
 Generates the Jacobian matrix for the active species.
 
double getJacobianMatrixEntry (const int i_defined, const int j_defined) const override
 Gets an entry from the Jacobian matrix for the active species.
 
void generateStoichiometryMatrix () override
 Generates the stoichiometry matrix for the active reactions and species.
 
int getStoichiometryMatrixEntry (const int speciesIndex_defined, const int reactionIndex_defined) const override
 Gets an entry from the stoichiometry matrix for the active species and reactions.
 
double calculateMolarReactionFlow (const reaction::Reaction &reaction, const std::vector< double > &Y_defined, const double T9, const double rho) const override
 Calculates the molar reaction flow for a given reaction in the active network.
 
const reaction::LogicalReactionSet & getNetworkReactions () const override
 Gets the set of active logical reactions in the network.
 
void setNetworkReactions (const reaction::LogicalReactionSet &reactions) override
 
std::expected< std::unordered_map< fourdst::atomic::Species, double >, expectations::StaleEngineError > getSpeciesTimescales (const std::vector< double > &Y_defined, const double T9, const double rho) const override
 Computes timescales for all active species in the network.
 
std::expected< std::unordered_map< fourdst::atomic::Species, double >, expectations::StaleEngineError > getSpeciesDestructionTimescales (const std::vector< double > &Y_defined, const double T9, const double rho) const override
 
fourdst::composition::Composition update (const NetIn &netIn) override
 Updates the engine view if it is marked as stale.
 
bool isStale (const NetIn &netIn) override
 
void setScreeningModel (screening::ScreeningType model) override
 Sets the screening model for the base engine.
 
screening::ScreeningType getScreeningModel () const override
 Gets the screening model from the base engine.
 
int getSpeciesIndex (const fourdst::atomic::Species &species) const override
 
std::vector< double > mapNetInToMolarAbundanceVector (const NetIn &netIn) const override
 
PrimingReport primeEngine (const NetIn &netIn) override
 
- Public Member Functions inherited from gridfire::DynamicEngine
virtual void generateJacobianMatrix (const std::vector< double > &Y_dynamic, double T9, double rho, const SparsityPattern &sparsityPattern) const
 
virtual BuildDepthType getDepth () const
 
virtual void rebuild (const fourdst::composition::Composition &comp, BuildDepthType depth)
 
- 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 Attributes

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

Additional Inherited Members

- Protected Attributes inherited from gridfire::DefinedEngineView
bool m_isStale = true
 
DynamicEngine & m_baseEngine
 

Detailed Description

Definition at line 259 of file engine_defined.h.

Member Typedef Documentation

◆ Config

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

Definition at line 269 of file engine_defined.h.

◆ LogManager

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

Definition at line 270 of file engine_defined.h.

Constructor & Destructor Documentation

◆ FileDefinedEngineView()

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

FileDefinedEngineView Implementation ///.

Definition at line 379 of file engine_defined.cpp.

Member Function Documentation

◆ getNetworkFile()

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

Definition at line 266 of file engine_defined.h.

◆ getParser()

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

Definition at line 267 of file engine_defined.h.

Member Data Documentation

◆ m_config

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

Definition at line 271 of file engine_defined.h.

◆ m_fileName

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

Parser for the network file.

Definition at line 273 of file engine_defined.h.

◆ m_logger

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

Definition at line 272 of file engine_defined.h.

◆ m_parser

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

Definition at line 275 of file engine_defined.h.

The documentation for this class was generated from the following files: