PyDynamicEngine Class Reference

#include <py_engine.h>

Inheritance diagram for PyDynamicEngine:

Collaboration diagram for PyDynamicEngine:

Public Member Functions
const std::vector< fourdst::atomic::Species > &	getNetworkSpecies () const override
	PyDynamicEngine Implementation ///.
std::expected< gridfire::StepDerivatives< double >, gridfire::expectations::StaleEngineError >	calculateRHSAndEnergy (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
void	generateJacobianMatrix (const fourdst::composition::Composition &comp, double T9, double rho) const override
void	generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies) const override
void	generateJacobianMatrix (const fourdst::composition::Composition &comp, double T9, double rho, const gridfire::SparsityPattern &sparsityPattern) const override
double	getJacobianMatrixEntry (const fourdst::atomic::Species &rowSpecies, const fourdst::atomic::Species &colSpecies) const override
void	generateStoichiometryMatrix () override
int	getStoichiometryMatrixEntry (const fourdst::atomic::Species &species, const gridfire::reaction::Reaction &reaction) const override
double	calculateMolarReactionFlow (const gridfire::reaction::Reaction &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
const gridfire::reaction::ReactionSet &	getNetworkReactions () const override
void	setNetworkReactions (const gridfire::reaction::ReactionSet &reactions) override
std::expected< std::unordered_map< fourdst::atomic::Species, double >, gridfire::expectations::StaleEngineError >	getSpeciesTimescales (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
std::expected< std::unordered_map< fourdst::atomic::Species, double >, gridfire::expectations::StaleEngineError >	getSpeciesDestructionTimescales (const fourdst::composition::Composition &comp, double T9, double rho) const override
fourdst::composition::Composition	update (const gridfire::NetIn &netIn) override
bool	isStale (const gridfire::NetIn &netIn) override
void	setScreeningModel (gridfire::screening::ScreeningType model) override
gridfire::screening::ScreeningType	getScreeningModel () const override
size_t	getSpeciesIndex (const fourdst::atomic::Species &species) const override
std::vector< double >	mapNetInToMolarAbundanceVector (const gridfire::NetIn &netIn) const override
gridfire::PrimingReport	primeEngine (const gridfire::NetIn &netIn) override
gridfire::BuildDepthType	getDepth () const override
void	rebuild (const fourdst::composition::CompositionAbstract &comp, gridfire::BuildDepthType depth) override
gridfire::EnergyDerivatives	calculateEpsDerivatives (const fourdst::composition::Composition &comp, double T9, double rho) const override
fourdst::composition::Composition	collectComposition (fourdst::composition::Composition &comp) const override

Private Attributes
std::vector< fourdst::atomic::Species >	m_species_cache

Member Function Documentation

calculateEpsDerivatives()

gridfire::EnergyDerivatives PyDynamicEngine::calculateEpsDerivatives ( const fourdst::composition::Composition & comp, double T9, double rho ) const

nodiscardoverride

calculateMolarReactionFlow()

double PyDynamicEngine::calculateMolarReactionFlow ( const gridfire::reaction::Reaction & reaction, const fourdst::composition::CompositionAbstract & comp, double T9, double rho ) const

override

calculateRHSAndEnergy()

std::expected< gridfire::StepDerivatives< double >, gridfire::expectations::StaleEngineError > PyDynamicEngine::calculateRHSAndEnergy ( const fourdst::composition::CompositionAbstract & comp, double T9, double rho ) const

override

collectComposition()

fourdst::composition::Composition PyDynamicEngine::collectComposition ( fourdst::composition::Composition & comp ) const

override

generateJacobianMatrix() [1/3]

void PyDynamicEngine::generateJacobianMatrix ( const fourdst::composition::Composition & comp, double T9, double rho ) const

override

generateJacobianMatrix() [2/3]

void PyDynamicEngine::generateJacobianMatrix ( const fourdst::composition::Composition & comp, double T9, double rho, const gridfire::SparsityPattern & sparsityPattern ) const

override

generateJacobianMatrix() [3/3]

void PyDynamicEngine::generateJacobianMatrix ( const fourdst::composition::CompositionAbstract & comp, double T9, double rho, const std::vector< fourdst::atomic::Species > & activeSpecies ) const

override

generateStoichiometryMatrix()

void PyDynamicEngine::generateStoichiometryMatrix ( )

override

getDepth()

gridfire::BuildDepthType PyDynamicEngine::getDepth ( ) const

inlineoverride

getJacobianMatrixEntry()

double PyDynamicEngine::getJacobianMatrixEntry ( const fourdst::atomic::Species & rowSpecies, const fourdst::atomic::Species & colSpecies ) const

override

getNetworkReactions()

const gridfire::reaction::ReactionSet & PyDynamicEngine::getNetworkReactions ( ) const

override

getNetworkSpecies()

const std::vector< fourdst::atomic::Species > & PyDynamicEngine::getNetworkSpecies ( ) const

override

PyDynamicEngine Implementation ///.

getScreeningModel()

gridfire::screening::ScreeningType PyDynamicEngine::getScreeningModel ( ) const

override

getSpeciesDestructionTimescales()

std::expected< std::unordered_map< fourdst::atomic::Species, double >, gridfire::expectations::StaleEngineError > PyDynamicEngine::getSpeciesDestructionTimescales ( const fourdst::composition::Composition & comp, double T9, double rho ) const

override

getSpeciesIndex()

size_t PyDynamicEngine::getSpeciesIndex ( const fourdst::atomic::Species & species ) const

override

getSpeciesTimescales()

std::expected< std::unordered_map< fourdst::atomic::Species, double >, gridfire::expectations::StaleEngineError > PyDynamicEngine::getSpeciesTimescales ( const fourdst::composition::CompositionAbstract & comp, double T9, double rho ) const

override

getStoichiometryMatrixEntry()

int PyDynamicEngine::getStoichiometryMatrixEntry ( const fourdst::atomic::Species & species, const gridfire::reaction::Reaction & reaction ) const

override

isStale()

bool PyDynamicEngine::isStale ( const gridfire::NetIn & netIn )

override

mapNetInToMolarAbundanceVector()

std::vector< double > PyDynamicEngine::mapNetInToMolarAbundanceVector ( const gridfire::NetIn & netIn ) const

override

primeEngine()

gridfire::PrimingReport PyDynamicEngine::primeEngine ( const gridfire::NetIn & netIn )

override

rebuild()

void PyDynamicEngine::rebuild ( const fourdst::composition::CompositionAbstract & comp, gridfire::BuildDepthType depth )

inlineoverride

setNetworkReactions()

void PyDynamicEngine::setNetworkReactions ( const gridfire::reaction::ReactionSet & reactions )

override

setScreeningModel()

void PyDynamicEngine::setScreeningModel ( gridfire::screening::ScreeningType model )

override

update()

fourdst::composition::Composition PyDynamicEngine::update ( const gridfire::NetIn & netIn )

override

Member Data Documentation

m_species_cache

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

mutableprivate

---

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

• src/python/engine/trampoline/py_engine.h
• src/python/engine/trampoline/py_engine.cpp