gridfire::engine::FileDefinedEngineView Class Reference

#include <engine_defined.h>

Inheritance diagram for gridfire::engine::FileDefinedEngineView:

Collaboration diagram for gridfire::engine::FileDefinedEngineView:

Public Member Functions
	FileDefinedEngineView (GraphEngine &baseEngine, const std::string &fileName, const io::NetworkFileParser &parser)
	FileDefinedEngineView Implementation ///.
std::string	getNetworkFile () const
const io::NetworkFileParser &	getParser () const
Public Member Functions inherited from gridfire::engine::DefinedEngineView
	DefinedEngineView (const std::vector< std::string > &peNames, GraphEngine &baseEngine)
const DynamicEngine &	getBaseEngine () const override
	Get the base engine associated with this defined engine view.
const std::vector< fourdst::atomic::Species > &	getNetworkSpecies () const override
	Gets the list of active species in the network defined by the file.
std::expected< StepDerivatives< double >, engine::EngineStatus >	calculateRHSAndEnergy (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
	Calculates the right-hand side (dY/dt) and energy generation for the active species.
EnergyDerivatives	calculateEpsDerivatives (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
	Calculate the derivatives of the energy generation rate with respect to T and rho.
NetworkJacobian	generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
	Generates the Jacobian matrix for the active species.
NetworkJacobian	generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies) const override
	Generates the Jacobian matrix for the active species.
NetworkJacobian	generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const override
	Generates the Jacobian matrix for a given sparsity pattern.
void	generateStoichiometryMatrix () override
	Generates the stoichiometry matrix for the active reactions and species.
int	getStoichiometryMatrixEntry (const fourdst::atomic::Species &species, const reaction::Reaction &reaction) const override
	Gets an entry from the stoichiometry matrix for the active species and reactions.
double	calculateMolarReactionFlow (const reaction::Reaction &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
	Calculates the molar reaction flow for a given reaction in the active network.
const reaction::ReactionSet &	getNetworkReactions () const override
	Gets the set of active logical reactions in the network.
void	setNetworkReactions (const reaction::ReactionSet &reactions) override
	Sets the active reactions in the network.
std::expected< std::unordered_map< fourdst::atomic::Species, double >, engine::EngineStatus >	getSpeciesTimescales (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
	Computes timescales for all active species in the network.
std::expected< std::unordered_map< fourdst::atomic::Species, double >, engine::EngineStatus >	getSpeciesDestructionTimescales (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
	Computes destruction timescales for all active species in the network.
fourdst::composition::Composition	update (const NetIn &netIn) override
	Updates the engine view if it is marked as stale.
bool	isStale (const NetIn &netIn) override
	Checks if the engine view is stale.
void	setScreeningModel (screening::ScreeningType model) override
	Sets the screening model for the base engine.
screening::ScreeningType	getScreeningModel () const override
	Gets the screening model from the base engine.
size_t	getSpeciesIndex (const fourdst::atomic::Species &species) const override
	Maps a species from the full network to its index in the defined active network.
std::vector< double >	mapNetInToMolarAbundanceVector (const NetIn &netIn) const override
	Map from a NetIn object to a vector of molar abundances for the active species.
PrimingReport	primeEngine (const NetIn &netIn) override
	Prime the engine view for calculations. This will delegate to the base engine.
fourdst::composition::Composition	collectComposition (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
	Collects a Composition object from the base engine.
SpeciesStatus	getSpeciesStatus (const fourdst::atomic::Species &species) const override
	Gets the status of a species in the active network.
Public Member Functions inherited from gridfire::engine::DynamicEngine
virtual BuildDepthType	getDepth () const
	Get the depth of the network.
virtual void	rebuild (const fourdst::composition::CompositionAbstract &comp, BuildDepthType depth)
	Rebuild the network with a specified depth.
Public Member Functions inherited from gridfire::engine::Engine
virtual	~Engine ()=default
	Virtual destructor.
Public Member Functions inherited from gridfire::engine::EngineView< DynamicEngine >
virtual	~EngineView ()=default
	Virtual destructor.

Private Types
using	Config = fourdst::config::Config
using	LogManager = fourdst::logging::LogManager

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

Additional Inherited Members
Protected Attributes inherited from gridfire::engine::DefinedEngineView
bool	m_isStale = true
GraphEngine &	m_baseEngine

Member Typedef Documentation

Config

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

private

LogManager

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

private

Constructor & Destructor Documentation

FileDefinedEngineView()

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

explicit

FileDefinedEngineView Implementation ///.

Member Function Documentation

getNetworkFile()

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

inline

getParser()

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

inline

Member Data Documentation

m_config

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

private

m_fileName

std::string gridfire::engine::FileDefinedEngineView::m_fileName

private

Parser for the network file.

m_logger

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

private

m_parser

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

private

---

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

• src/include/gridfire/engine/views/engine_defined.h
• src/lib/engine/views/engine_defined.cpp