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

#include <engine_adaptive.h>

Inheritance diagram for gridfire::engine::AdaptiveEngineView:

Collaboration diagram for gridfire::engine::AdaptiveEngineView:

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

Public Member Functions
	AdaptiveEngineView (DynamicEngine &baseEngine)
	Constructs an AdaptiveEngineView.

fourdst::composition::Composition	update (const NetIn &netIn) override
	Updates the active species and reactions based on the current conditions.

bool	isStale (const NetIn &netIn) override
	Check if the engine's internal state is stale.

const std::vector< fourdst::atomic::Species > &	getNetworkSpecies () const override
	Gets the list of active species in the network.

std::expected< StepDerivatives< double >, engine::EngineStatus >	calculateRHSAndEnergy (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
	Calculates the right-hand side (dY/dt) and energy generation for the active species.

EnergyDerivatives	calculateEpsDerivatives (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override

NetworkJacobian	generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
	Generates the Jacobian matrix for the active species.

NetworkJacobian	generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies) const override
	Generates the Jacobian matrix for some set of active species such that that set is a subset of the active species in the view.

NetworkJacobian	generateJacobianMatrix (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const SparsityPattern &sparsityPattern) const override
	Generates the Jacobian matrix for the active species with a given sparsity pattern.

void	generateStoichiometryMatrix () override
	Generates the stoichiometry matrix for the active reactions and species.

int	getStoichiometryMatrixEntry (const fourdst::atomic::Species &species, const reaction::Reaction &reaction) const override
	Gets an entry from the stoichiometry matrix for the active species and reactions.

double	calculateMolarReactionFlow (const reaction::Reaction &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
	Calculates the molar reaction flow for a given reaction in the active network.

const reaction::ReactionSet &	getNetworkReactions () const override
	Gets the set of active logical reactions in the network.

void	setNetworkReactions (const reaction::ReactionSet &reactions) override
	Sets the reaction set for the base engine.

std::expected< std::unordered_map< fourdst::atomic::Species, double >, EngineStatus >	getSpeciesTimescales (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
	Computes timescales for all active species in the network.

std::expected< std::unordered_map< fourdst::atomic::Species, double >, EngineStatus >	getSpeciesDestructionTimescales (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
	Computes destruction timescales for all active species in the network.

const DynamicEngine &	getBaseEngine () const override
	Gets the base engine.

void	setScreeningModel (screening::ScreeningType model) override
	Sets the screening model for the base engine.

screening::ScreeningType	getScreeningModel () const override
	Gets the screening model from the base engine.

size_t	getSpeciesIndex (const fourdst::atomic::Species &species) const override
	Gets the index of a species in the active species list.

std::vector< double >	mapNetInToMolarAbundanceVector (const NetIn &netIn) const override
	Maps the molar abundance vector from the active species to the full network species.

PrimingReport	primeEngine (const NetIn &netIn) override
	Primes the engine with the given network input.

fourdst::composition::Composition	collectComposition (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override
	Collect the composition of the base engine, ensure all active species are registered, and pass the composition back to the caller.

SpeciesStatus	getSpeciesStatus (const fourdst::atomic::Species &species) const override
	Gets the status of a species in the network.

Public Member Functions inherited from gridfire::engine::DynamicEngine
virtual BuildDepthType	getDepth () const
	Get the depth of the network.

virtual void	rebuild (const fourdst::composition::CompositionAbstract &comp, BuildDepthType depth)
	Rebuild the network with a specified depth.

Public Member Functions inherited from gridfire::engine::Engine
virtual	~Engine ()=default
	Virtual destructor.

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

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

using	LogManager = fourdst::logging::LogManager

typedef std::pair< std::unordered_set< const reaction::Reaction * >, std::unordered_set< fourdst::atomic::Species > >	RescueSet

Private Member Functions
void	validateState () const
	Validates that the AdaptiveEngineView is not stale.

std::pair< std::vector< ReactionFlow >, fourdst::composition::Composition >	calculateAllReactionFlows (const NetIn &netIn) const
	Calculates the molar reaction flow rate for all reactions in the full network.

std::unordered_set< fourdst::atomic::Species >	findReachableSpecies (const NetIn &netIn) const
	Finds all species that are reachable from the initial fuel through the reaction network.

std::vector< const reaction::Reaction * >	cullReactionsByFlow (const std::vector< ReactionFlow > &allFlows, const std::unordered_set< fourdst::atomic::Species > &reachableSpecies, const fourdst::composition::Composition &comp, double maxFlow) const
	Culls reactions from the network based on their flow rates.

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

void	finalizeActiveSet (const std::vector< const reaction::Reaction * > &finalReactions)
	Finalizes the set of active species and reactions.

Private Attributes
Config &	m_config = Config::getInstance()
	A reference to the singleton Config instance, used for retrieving configuration parameters.

quill::Logger *	m_logger = LogManager::getInstance().getLogger("log")
	A pointer to the logger instance, used for logging messages.

DynamicEngine &	m_baseEngine
	The underlying engine to which this view delegates calculations.

std::vector< fourdst::atomic::Species >	m_activeSpecies
	The set of species that are currently active in the network.

reaction::ReactionSet	m_activeReactions
	The set of reactions that are currently active in the network.

bool	m_isStale = true
	A flag indicating whether the view is stale and needs to be updated.

Detailed Description

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

This class implements an EngineView that dynamically culls species and reactions from the full reaction network based on their reaction flow rates and connectivity. This allows for efficient simulation of reaction networks by focusing computational effort on the most important species and reactions.

The AdaptiveEngineView maintains a subset of "active" species and reactions, and maps between the full network indices and the active subset indices. This allows the base engine to operate on the full network data, while the AdaptiveEngineView provides a reduced view for external clients.

The adaptation process is driven by the update() method, which performs the following steps:

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

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

Member Typedef Documentation

◆ Config

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

private

◆ LogManager

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

private

◆ RescueSet

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

private

Constructor & Destructor Documentation

◆ AdaptiveEngineView()

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

explicit

Constructs an AdaptiveEngineView.

Parameters

baseEngine The underlying DynamicEngine to which this view delegates calculations.

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

Member Function Documentation

◆ calculateAllReactionFlows()

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

private

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

This method iterates through all reactions in the base engine's network and calculates their molar flow rates based on the provided network input conditions (temperature, density, and composition). It also constructs a vector of molar abundances for all species in the full network.

Parameters

netIn The current network input, containing temperature, density, and composition.

Returns: A pair with the first element a vector of ReactionFlow structs, each containing a pointer to a reaction and its calculated flow rate and the second being a composition object where species which were not present in netIn but are present in the definition of the base engine are registered but have 0 mass fraction.

Algorithm:

Iterates through all species in the base engine's network.
For each species, it retrieves the molar abundance from netIn.composition. If the species is not found, its abundance is set to 0.0.
Converts the temperature from Kelvin to T9.
Iterates through all reactions in the base engine's network.
For each reaction, it calls the base engine's calculateMolarReactionFlow to get the flow rate.
Stores the reaction pointer and its flow rate in a ReactionFlow struct and adds it to the returned vector.

◆ calculateEpsDerivatives()

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

overridevirtual

Parameters

comp	The current composition of the system.
T9	The temperature in units of 10^9 K.
rho	The density in g/cm^3.

Returns: A struct containing the derivatives of the energy generation rate with respect to temperature and density.

Implements gridfire::engine::DynamicEngine.

◆ calculateMolarReactionFlow()

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

overridevirtual

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

Parameters

reaction	The reaction for which to calculate the flow.
comp	Composition object containing current abundances.
T9	Temperature in units of 10^9 K.
rho	Density in g/cm^3.

Returns: Molar flow rate for the reaction (e.g., mol/g/s).

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

Exceptions

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

Implements gridfire::engine::DynamicEngine.

◆ calculateRHSAndEnergy()

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

overridevirtual

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

Parameters

comp	The current composition of the system.
T9	The temperature in units of 10^9 K.
rho	The density in g/cm^3.

Returns: A StepDerivatives struct containing the derivatives of the active species and the nuclear energy generation rate.

This method maps the culled abundances to the full network abundances, calls the base engine to calculate the RHS and energy generation, and then maps the full network derivatives back to the culled derivatives.

Exceptions

std::runtime_error If the AdaptiveEngineView is stale (i.e., update() has not been called).

See also: AdaptiveEngineView::update()

Implements gridfire::engine::Engine.

◆ collectComposition()

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

overridevirtual

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

Parameters

comp	The current composition of the system.
T9	The temperature in units of 10^9 K.
rho	The density in g/cm^3.

Note: This function ensures that the state of both the base engine and the adaptive view are synchronized in the result back to the caller

Implements gridfire::engine::DynamicEngine.

◆ cullReactionsByFlow()

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

private

Culls reactions from the network based on their flow rates.

This method filters the list of all reactions, keeping only those with a flow rate above an absolute culling threshold. The threshold is calculated by multiplying the maximum flow rate by a relative culling threshold read from the configuration.

Parameters

allFlows	A vector of all reactions and their flow rates.
reachableSpecies	A set of all species reachable from the initial fuel.
comp	The current composition of the system.
maxFlow	The maximum reaction flow rate in the network.

Returns: A vector of pointers to the reactions that have been kept after culling.

Algorithm:

Retrieves the RelativeCullingThreshold from the configuration.
Calculates the absoluteCullingThreshold by multiplying maxFlow with the relative threshold.
Iterates through allFlows.
A reaction is kept if its flowRate is greater than the absoluteCullingThreshold.
The pointers to the kept reactions are stored in a vector and returned.

◆ finalizeActiveSet()

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

private

Finalizes the set of active species and reactions.

This method takes the final list of culled reactions and populates the m_activeReactions and m_activeSpecies members. The active species are determined by collecting all reactants and products from the final reactions. The active species list is then sorted by mass.

Parameters

finalReactions A vector of pointers to the reactions to be included in the active set.

Postcondition

m_activeReactions is cleared and populated with the reactions from finalReactions.
m_activeSpecies is cleared and populated with all unique species present in finalReactions.
m_activeSpecies is sorted by atomic mass.

◆ findReachableSpecies()

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

private

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

This method performs a connectivity analysis to identify all species that can be produced starting from the initial fuel species. A species is considered part of the initial fuel if its mass fraction is above a certain threshold (ABUNDANCE_FLOOR).

Parameters

netIn The current network input, containing the initial composition.

Returns: An unordered set of all reachable species.

Algorithm:

Initializes a set reachable and a queue to_visit with the initial fuel species.
Iteratively processes the reaction network until no new species can be reached.
In each pass, it iterates through all reactions in the base engine's network.
If all reactants of a reaction are in the reachable set, all products of that reaction are added to the reachable set.
The process continues until a full pass over all reactions does not add any new species to the reachable set.

◆ generateJacobianMatrix() [1/3]

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

overridevirtual

Generates the Jacobian matrix for the active species.

Parameters

comp	The current composition of the system.
T9	The temperature in units of 10^9 K.
rho	The density in g/cm^3.

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

Exceptions

std::runtime_error If the AdaptiveEngineView is stale (i.e., update() has not been called).

See also: AdaptiveEngineView::update()

Implements gridfire::engine::DynamicEngine.

◆ generateJacobianMatrix() [2/3]

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

overridevirtual

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

Parameters

comp	The current composition of the system.
T9	The temperature in units of 10^9 K.
rho	The density in g/cm^3.
sparsityPattern	The sparsity pattern to use for the Jacobian matrix.

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

Exceptions

std::runtime_error If the AdaptiveEngineView is stale (i.e., update() has not been called).

See also: AdaptiveEngineView::update()

Implements gridfire::engine::DynamicEngine.

◆ generateJacobianMatrix() [3/3]

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

overridevirtual

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

Parameters

comp	The current composition of the system.
T9	The temperature in units of 10^9 K.
rho	The density in g/cm^3.
activeSpecies	The list of active species for which to generate the Jacobian.

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

Exceptions

std::runtime_error If the AdaptiveEngineView is stale (i.e., update() has not been called).

See also: AdaptiveEngineView::update()

Implements gridfire::engine::DynamicEngine.

◆ generateStoichiometryMatrix()

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

overridevirtual

Generates the stoichiometry matrix for the active reactions and species.

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

Exceptions

std::runtime_error If the AdaptiveEngineView is stale (i.e., update() has not been called).

Note: The stoichiometry matrix generated by the base engine is assumed to be consistent with the active species and reactions in this view.

Implements gridfire::engine::DynamicEngine.

◆ getBaseEngine()

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

inlineoverridevirtual

Gets the base engine.

Returns: A const reference to the base engine.

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

◆ getNetworkReactions()

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

overridevirtual

Gets the set of active logical reactions in the network.

Returns: Reference to the LogicalReactionSet containing all active reactions.

Implements gridfire::engine::DynamicEngine.

◆ getNetworkSpecies()

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

overridevirtual

Gets the list of active species in the network.

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

Implements gridfire::engine::Engine.

◆ getScreeningModel()

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

overridevirtual

Gets the screening model from the base engine.

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

Returns: The current screening model type.

Usage Example:: AdaptiveEngineView engineView(...);

screening::ScreeningType model = engineView.getScreeningModel();

gridfire::engine::AdaptiveEngineView
An engine view that dynamically adapts the reaction network based on runtime conditions.
Definition engine_adaptive.h:49

gridfire::screening::ScreeningType
ScreeningType
Enumerates the available plasma screening models.
Definition screening_types.h:15

Implements gridfire::engine::DynamicEngine.

◆ getSpeciesDestructionTimescales()

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

overridevirtual

Computes destruction timescales for all active species in the network.

Parameters

comp	Composition object containing current abundances.
T9	Temperature in units of 10^9 K.
rho	Density in g/cm^3.

Returns: Map from Species to their destruction timescales (s).

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

Exceptions

std::runtime_error If the AdaptiveEngineView is stale (i.e., update() has not been called).

Implements gridfire::engine::DynamicEngine.

◆ getSpeciesIndex()

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

overridevirtual

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

Parameters

species The species for which to get the index.

Returns: The index of the species in the active species list.

Exceptions

std::runtime_error	If the AdaptiveEngineView is stale (i.e., `update()` has not been called).
std::out_of_range	If the species is not part of the active species in the adaptive engine view.

Implements gridfire::engine::DynamicEngine.

◆ getSpeciesStatus()

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

overridevirtual

Gets the status of a species in the network.

Parameters

species The species for which to get the status.

Returns: The SpeciesStatus indicating the status of the species.

This method delegates the call to the base engine to get the species status. If the base engine says that the species is active but it is not in the active species list of this view, the status is returned as INACTIVE_FLOW.

Implements gridfire::engine::DynamicEngine.

◆ getSpeciesTimescales()

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

overridevirtual

Computes timescales for all active species in the network.

Parameters

comp	Composition object containing current abundances.
T9	Temperature in units of 10^9 K.
rho	Density in g/cm^3.

Returns: Map from Species to their characteristic timescales (s).

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

Exceptions

std::runtime_error If the AdaptiveEngineView is stale (i.e., update() has not been called).

Implements gridfire::engine::DynamicEngine.

◆ getStoichiometryMatrixEntry()

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

overridevirtual

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

Parameters

species	The species for which to get the stoichiometric coefficient.
reaction	The reaction for which to get the stoichiometric coefficient.

Returns: The stoichiometric coefficient for the given species and reaction.

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

Exceptions

std::runtime_error	If the AdaptiveEngineView is stale (i.e., `update()` has not been called).
std::out_of_range	If the culled index is out of bounds for the species or reaction index map.

See also: AdaptiveEngineView::update()

Implements gridfire::engine::DynamicEngine.

◆ isStale()

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

overridevirtual

Check if the engine's internal state is stale.

Parameters

netIn A struct containing the current network input, such as temperature, density, and composition.

Returns: True if the engine's state is stale and needs to be updated; false otherwise.

This method allows derived classes to determine if their internal state is out-of-date with respect to the provided network conditions. If the engine is stale, it may require a call to update() before performing calculations.

Usage Example:: NetIn input = { ... };

if (myEngine.isStale(input)) {

// Update the engine before proceeding

}

gridfire::NetIn
Definition types.h:27

Implements gridfire::engine::DynamicEngine.

◆ mapNetInToMolarAbundanceVector()

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

overridevirtual

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

Parameters

netIn The current network input, containing temperature, density, and composition.

Returns: A vector of molar abundances for all species in the full network.

This method constructs a molar abundance vector for the full network by mapping the abundances from the active species in netIn to their corresponding indices in the full network. Species not present in netIn are assigned an abundance of zero.

Exceptions

std::runtime_error If the AdaptiveEngineView is stale (i.e., update() has not been called).

Implements gridfire::engine::DynamicEngine.

◆ primeEngine()

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

overridevirtual

Primes the engine with the given network input.

Parameters

netIn The current network input, containing temperature, density, and composition.

Returns: A PrimingReport indicating the result of the priming operation.

This method delegates the priming operation to the base engine.

Implements gridfire::engine::DynamicEngine.

◆ rescueEdgeSpeciesDestructionChannel()

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

private

◆ setNetworkReactions()

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

overridevirtual

Sets the reaction set for the base engine.

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

Parameters

reactions The ReactionSet to set in the base engine.

Postcondition: The reaction set of the base engine is updated.

Implements gridfire::engine::DynamicEngine.

◆ setScreeningModel()

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

overridevirtual

Sets the screening model for the base engine.

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

Parameters

model The electron screening model to set.

Usage Example:: AdaptiveEngineView engineView(...);

engineView.setScreeningModel(screening::ScreeningType::WEAK);

gridfire::screening::ScreeningType::WEAK
@ WEAK
Weak screening model (Salpeter, 1954).

Postcondition: The screening model of the base engine is updated.

Implements gridfire::engine::DynamicEngine.

◆ update()

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

overridevirtual

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

Parameters

netIn The current network input, containing temperature, density, and composition.

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

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

gridfire:AdaptiveEngineView:RelativeCullingThreshold (default: 1e-75)

Exceptions

std::runtime_error If there is a mismatch between the active reactions and the base engine.

Postcondition: The active species and reactions are updated, and the index maps are reconstructed.

See also: AdaptiveEngineView; AdaptiveEngineView::constructSpeciesIndexMap(); AdaptiveEngineView::constructReactionIndexMap()

Implements gridfire::engine::DynamicEngine.

◆ validateState()

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

private

Validates that the AdaptiveEngineView is not stale.

Exceptions

std::runtime_error If the AdaptiveEngineView is stale (i.e., update() has not been called).

Member Data Documentation

◆ m_activeReactions

reaction::ReactionSet gridfire::engine::AdaptiveEngineView::m_activeReactions

private

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

◆ m_activeSpecies

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

private

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

◆ m_baseEngine

DynamicEngine& gridfire::engine::AdaptiveEngineView::m_baseEngine

private

The underlying engine to which this view delegates calculations.

◆ m_config

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

private

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

◆ m_isStale

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

private

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

◆ m_logger

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

private

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

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

src/include/gridfire/engine/views/engine_adaptive.h
src/lib/engine/views/engine_adaptive.cpp

Classes

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Config

◆ LogManager

◆ RescueSet

Constructor & Destructor Documentation

◆ AdaptiveEngineView()

Member Function Documentation

◆ calculateAllReactionFlows()

◆ calculateEpsDerivatives()

◆ calculateMolarReactionFlow()

◆ calculateRHSAndEnergy()

◆ collectComposition()

◆ cullReactionsByFlow()

◆ finalizeActiveSet()

◆ findReachableSpecies()

◆ generateJacobianMatrix() [1/3]

◆ generateJacobianMatrix() [2/3]

◆ generateJacobianMatrix() [3/3]

◆ generateStoichiometryMatrix()

◆ getBaseEngine()

◆ getNetworkReactions()

◆ getNetworkSpecies()

◆ getScreeningModel()

◆ getSpeciesDestructionTimescales()

◆ getSpeciesIndex()

◆ getSpeciesStatus()

◆ getSpeciesTimescales()

◆ getStoichiometryMatrixEntry()

◆ isStale()

◆ mapNetInToMolarAbundanceVector()

◆ primeEngine()

◆ rescueEdgeSpeciesDestructionChannel()

◆ setNetworkReactions()

◆ setScreeningModel()

◆ update()

◆ validateState()

Member Data Documentation

◆ m_activeReactions

◆ m_activeSpecies

◆ m_baseEngine

◆ m_config

◆ m_isStale

◆ m_logger