GridFire 0.0.1a General Purpose Nuclear Network

Loading...
Searching...
No Matches
Classes | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
gridfire::AdaptiveEngineView Class Referencefinal

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

`#include <engine_adaptive.h>`

Inheritance diagram for gridfire::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
const std::vector< fourdst::atomic::Species > & | getNetworkSpecies () const override
| Gets the list of active species in the network.
std::expected< StepDerivatives< double >, expectations::StaleEngineError > | calculateRHSAndEnergy (const std::vector< double > &Y_culled, 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_culled, const int j_culled) 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_culled, const int reactionIndex_culled) 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_culled, double T9, 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_culled, double T9, 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, double T9, double rho) const override
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.
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
typedef std::pair< std::unordered_set< const reaction::LogicalReaction * >, std::unordered_set< fourdst::atomic::Species > > | RescueSet

## Private Member Functions
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 > | mapCulledToFull (const std::vector< double > &culled) const
| Maps a vector of culled abundances to a vector of full abundances.
std::vector< double > | mapFullToCulled (const std::vector< double > &full) const
| Maps a vector of full abundances to a vector of culled abundances.
size_t | mapCulledToFullSpeciesIndex (size_t culledSpeciesIndex) const
| Maps a culled species index to a full species index.
size_t | mapCulledToFullReactionIndex (size_t culledReactionIndex) const
| Maps a culled reaction index to a full reaction index.
void | validateState () const
| Validates that the AdaptiveEngineView is not stale.
std::vector< ReactionFlow > | calculateAllReactionFlows (const NetIn &netIn, std::vector< double > &out_Y_Full) 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::LogicalReaction * > | cullReactionsByFlow (const std::vector< ReactionFlow > &allFlows, const std::unordered_set< fourdst::atomic::Species > &reachableSpecies, const std::vector< double > &Y_full, double maxFlow) const
| Culls reactions from the network based on their flow rates.
RescueSet | rescueEdgeSpeciesDestructionChannel (const std::vector< double > &Y_full, const double T9, const double rho, const std::vector< fourdst::atomic::Species > &activeSpecies, const reaction::LogicalReactionSet &activeReactions) const
void | finalizeActiveSet (const std::vector< const reaction::LogicalReaction * > &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::LogicalReactionSet | m_activeReactions
| The set of reactions that are currently active in the network.
std::vector< size_t > | m_speciesIndexMap
| A map from the indices of the active species to the indices of the corresponding species in the full network.
std::vector< size_t > | m_reactionIndexMap
| A map from the indices of the active reactions to the indices of the corresponding reactions in the full 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:

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

<DynamicEngine>

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

Definition at line 50 of file engine_adaptive.h.

## Member Typedef Documentation

## ◆ Config

using gridfire::AdaptiveEngineView::Config = fourdst::config::Config
| private

Definition at line 279 of file engine_adaptive.h.

## ◆ LogManager

using gridfire::AdaptiveEngineView::LogManager = fourdst::logging::LogManager
| private

Definition at line 280 of file engine_adaptive.h.

## ◆ RescueSet

typedef std::pair<std::unordered_set<const reaction::LogicalReaction*>, std::unordered_set<fourdst::atomic::Species> > gridfire::AdaptiveEngineView::RescueSet
| private

Definition at line 452 of file engine_adaptive.h.

## Constructor & Destructor Documentation

## ◆ AdaptiveEngineView()

gridfire::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.

Definition at line 16 of file engine_adaptive.cpp.

## Member Function Documentation

## ◆ calculateAllReactionFlows()

std::vector< AdaptiveEngineView::ReactionFlow > gridfire::AdaptiveEngineView::calculateAllReactionFlows | ( | const NetIn & | netIn,
|  | std::vector< double > & | out_Y_Full ) 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.
  out_Y_Full | A vector that will be populated with the molar abundances of all species in the full network.

Returns
  A vector of ReactionFlow structs, each containing a pointer to a reaction and its calculated flow rate.

Algorithm:
  1. Clears and reserves space in `out_Y_Full`.
  2. Iterates through all species in the base engine's network.
  3. For each species, it retrieves the molar abundance from `netIn.composition`. If the species is not found, its abundance is set to 0.0.
  4. Converts the temperature from Kelvin to T9.
  5. Iterates through all reactions in the base engine's network.
  6. For each reaction, it calls the base engine's `calculateMolarReactionFlow` to get the flow rate.
  7. Stores the reaction pointer and its flow rate in a `ReactionFlow` struct and adds it to the returned vector.

Definition at line 368 of file engine_adaptive.cpp.

## ◆ calculateMolarReactionFlow()

double gridfire::AdaptiveEngineView::calculateMolarReactionFlow | ( | const reaction::Reaction & | reaction,
|  | const std::vector< double > & | Y_culled,
|  | double | T9,
|  | double | rho ) const
| nodiscard override virtual

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

Parameters

  reaction | The reaction for which to calculate the flow.
  Y_culled | Vector of current abundances for the active species.
  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::DynamicEngine.

Definition at line 212 of file engine_adaptive.cpp.

## ◆ calculateRHSAndEnergy()

std::expected< StepDerivatives< double >, expectations::StaleEngineError > gridfire::AdaptiveEngineView::calculateRHSAndEnergy | ( | const std::vector< double > & | Y_culled,
|  | const double | T9,
|  | const double | rho ) const
| nodiscard override virtual

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

Parameters

  Y_culled | A vector of abundances for the active species.
  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.

Definition at line 152 of file engine_adaptive.cpp.

## ◆ constructReactionIndexMap()

std::vector< size_t > gridfire::AdaptiveEngineView::constructReactionIndexMap | ( |  | ) | const
| nodiscard 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 56 of file engine_adaptive.cpp.

## ◆ constructSpeciesIndexMap()

std::vector< size_t > gridfire::AdaptiveEngineView::constructSpeciesIndexMap | ( |  | ) | const
| nodiscard 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 27 of file engine_adaptive.cpp.

## ◆ cullReactionsByFlow()

std::vector< const reaction::LogicalReaction * > gridfire::AdaptiveEngineView::cullReactionsByFlow | ( | const std::vector< ReactionFlow > & | allFlows,
|  | const std::unordered_set< fourdst::atomic::Species > & | reachableSpecies,
|  | const std::vector< double > & | Y_full,
|  | double | maxFlow ) const
| nodiscard 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.
  Y_full | A vector of molar abundances for all species in the full network.
  maxFlow | The maximum reaction flow rate in the network.

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

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

Definition at line 442 of file engine_adaptive.cpp.

## ◆ finalizeActiveSet()

void gridfire::AdaptiveEngineView::finalizeActiveSet | ( | const std::vector< const reaction::LogicalReaction * > & | 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.

Definition at line 641 of file engine_adaptive.cpp.

## ◆ findReachableSpecies()

std::unordered_set< Species > gridfire::AdaptiveEngineView::findReachableSpecies | ( | const NetIn & | netIn | ) | const
| nodiscard 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:
  1. Initializes a set `reachable` and a queue `to_visit` with the initial fuel species.
  2. Iteratively processes the reaction network until no new species can be reached.
  3. In each pass, it iterates through all reactions in the base engine's network.
  4. If all reactants of a reaction are in the `reachable` set, all products of that reaction are added to the `reachable` set.
  5. The process continues until a full pass over all reactions does not add any new species to the `reachable` set.

Definition at line 399 of file engine_adaptive.cpp.

## ◆ generateJacobianMatrix()

void gridfire::AdaptiveEngineView::generateJacobianMatrix | ( | const std::vector< double > & | Y_dynamic,
|  | const double | T9,
|  | const double | rho ) const
| override virtual

Generates the Jacobian matrix for the active species.

Parameters

  Y_dynamic | A vector of abundances for the active species.
  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::DynamicEngine.

Definition at line 175 of file engine_adaptive.cpp.

## ◆ generateStoichiometryMatrix()

void gridfire::AdaptiveEngineView::generateStoichiometryMatrix | ( |  | ) |
| override virtual

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::DynamicEngine.

Definition at line 197 of file engine_adaptive.cpp.

## ◆ getBaseEngine()

const DynamicEngine & gridfire::AdaptiveEngineView::getBaseEngine | ( |  | ) | const
| inline nodiscard override virtual

Gets the base engine.

Returns
  A const reference to the base engine.

Implements gridfire::EngineView< DynamicEngine >.

Definition at line 239 of file engine_adaptive.h.

## ◆ getJacobianMatrixEntry()

double gridfire::AdaptiveEngineView::getJacobianMatrixEntry | ( | const int | i_culled,
|  | const int | j_culled ) const
| nodiscard override virtual

Gets an entry from the Jacobian matrix for the active species.

Parameters

  i_culled | The row index (species index) in the culled matrix.
  j_culled | The column index (species index) in the culled matrix.

Returns
  The value of the Jacobian matrix at (i_culled, j_culled).

This method maps the culled indices to the full network indices and calls the base engine to get the Jacobian 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 index map.

See also
  AdaptiveEngineView::update()

Implements gridfire::DynamicEngine.

Definition at line 186 of file engine_adaptive.cpp.

## ◆ getNetworkReactions()

const reaction::LogicalReactionSet & gridfire::AdaptiveEngineView::getNetworkReactions | ( |  | ) | const
| nodiscard override virtual

Gets the set of active logical reactions in the network.

Returns
  Reference to the LogicalReactionSet containing all active reactions.

Implements gridfire::DynamicEngine.

Definition at line 229 of file engine_adaptive.cpp.

## ◆ getNetworkSpecies()

const std::vector< Species > & gridfire::AdaptiveEngineView::getNetworkSpecies | ( |  | ) | const
| nodiscard override virtual

Gets the list of active species in the network.

Returns
  A const reference to the vector of active species.

Implements gridfire::Engine.

Definition at line 148 of file engine_adaptive.cpp.

## ◆ getScreeningModel()

screening::ScreeningType gridfire::AdaptiveEngineView::getScreeningModel | ( |  | ) | const
| nodiscard override virtual

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::AdaptiveEngineView::AdaptiveEngineView
  AdaptiveEngineView(DynamicEngine &baseEngine)
  Constructs an AdaptiveEngineView.
  Definition engine_adaptive.cpp:16
  gridfire::screening::ScreeningType
  ScreeningType
  Enumerates the available plasma screening models.
  Definition screening_types.h:15

Implements gridfire::DynamicEngine.

Definition at line 296 of file engine_adaptive.cpp.

## ◆ getSpeciesDestructionTimescales()

std::expected< std::unordered_map< fourdst::atomic::Species, double >, expectations::StaleEngineError > gridfire::AdaptiveEngineView::getSpeciesDestructionTimescales | ( | const std::vector< double > & | Y,
|  | double | T9,
|  | double | rho ) const
| nodiscard override virtual

Implements gridfire::DynamicEngine.

Definition at line 266 of file engine_adaptive.cpp.

## ◆ getSpeciesIndex()

int gridfire::AdaptiveEngineView::getSpeciesIndex | ( | const fourdst::atomic::Species & | species | ) | const
| nodiscard override virtual

Implements gridfire::DynamicEngine.

Definition at line 312 of file engine_adaptive.cpp.

## ◆ getSpeciesTimescales()

std::expected< std::unordered_map< Species, double >, expectations::StaleEngineError > gridfire::AdaptiveEngineView::getSpeciesTimescales | ( | const std::vector< double > & | Y_culled,
|  | double | T9,
|  | double | rho ) const
| nodiscard override virtual

Computes timescales for all active species in the network.

Parameters

  Y_culled | Vector of current abundances for the active species.
  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::DynamicEngine.

Definition at line 238 of file engine_adaptive.cpp.

## ◆ getStoichiometryMatrixEntry()

int gridfire::AdaptiveEngineView::getStoichiometryMatrixEntry | ( | const int | speciesIndex_culled,
|  | const int | reactionIndex_culled ) const
| nodiscard override virtual

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

Parameters

  speciesIndex_culled | The index of the species in the culled species list.
  reactionIndex_culled | The index of the reaction in the culled reaction list.

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::DynamicEngine.

Definition at line 202 of file engine_adaptive.cpp.

## ◆ isStale()

bool gridfire::AdaptiveEngineView::isStale | ( | const NetIn & | netIn | ) |
| override virtual

Implements gridfire::DynamicEngine.

Definition at line 144 of file engine_adaptive.cpp.

## ◆ mapCulledToFull()

std::vector< double > gridfire::AdaptiveEngineView::mapCulledToFull | ( | const std::vector< double > & | culled | ) | const
| nodiscard private

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

Parameters

  culled | A 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 323 of file engine_adaptive.cpp.

## ◆ mapCulledToFullReactionIndex()

size_t gridfire::AdaptiveEngineView::mapCulledToFullReactionIndex | ( | size_t | culledReactionIndex | ) | const
| nodiscard private

Maps a culled reaction index to a full reaction index.

Parameters

  culledReactionIndex | The index of the reaction in the culled reaction list.

Returns
  The index of the corresponding reaction in the full network.

Exceptions

  std::out_of_range | If the culled index is out of bounds for the reaction index map.

Definition at line 350 of file engine_adaptive.cpp.

## ◆ mapCulledToFullSpeciesIndex()

size_t gridfire::AdaptiveEngineView::mapCulledToFullSpeciesIndex | ( | size_t | culledSpeciesIndex | ) | const
| nodiscard private

Maps a culled species index to a full species index.

Parameters

  culledSpeciesIndex | The index of the species in the culled species list.

Returns
  The index of the corresponding species in the full network.

Exceptions

  std::out_of_range | If the culled index is out of bounds for the species index map.

Definition at line 341 of file engine_adaptive.cpp.

## ◆ mapFullToCulled()

std::vector< double > gridfire::AdaptiveEngineView::mapFullToCulled | ( | const std::vector< double > & | full | ) | const
| nodiscard private

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

Parameters

  full | A 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 332 of file engine_adaptive.cpp.

## ◆ mapNetInToMolarAbundanceVector()

std::vector< double > gridfire::AdaptiveEngineView::mapNetInToMolarAbundanceVector | ( | const NetIn & | netIn | ) | const
| nodiscard override virtual

Implements gridfire::DynamicEngine.

Definition at line 300 of file engine_adaptive.cpp.

## ◆ primeEngine()

PrimingReport gridfire::AdaptiveEngineView::primeEngine | ( | const NetIn & | netIn | ) |
| nodiscard override virtual

Implements gridfire::DynamicEngine.

Definition at line 308 of file engine_adaptive.cpp.

## ◆ rescueEdgeSpeciesDestructionChannel()

AdaptiveEngineView::RescueSet gridfire::AdaptiveEngineView::rescueEdgeSpeciesDestructionChannel | ( | const std::vector< double > & | Y_full,
|  | const double | T9,
|  | const double | rho,
|  | const std::vector< fourdst::atomic::Species > & | activeSpecies,
|  | const reaction::LogicalReactionSet & | activeReactions ) const
| nodiscard private

Definition at line 485 of file engine_adaptive.cpp.

## ◆ setNetworkReactions()

void gridfire::AdaptiveEngineView::setNetworkReactions | ( | const reaction::LogicalReactionSet & | reactions | ) |
| override virtual

Implements gridfire::DynamicEngine.

Definition at line 233 of file engine_adaptive.cpp.

## ◆ setScreeningModel()

void gridfire::AdaptiveEngineView::setScreeningModel | ( | screening::ScreeningType | model | ) |
| override virtual

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).
  Definition screening_types.h:35

Postcondition
  The screening model of the base engine is updated.

Implements gridfire::DynamicEngine.

Definition at line 292 of file engine_adaptive.cpp.

## ◆ update()

fourdst::composition::Composition gridfire::AdaptiveEngineView::update | ( | const NetIn & | netIn | ) |
| override virtual

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::DynamicEngine.

Definition at line 88 of file engine_adaptive.cpp.

## ◆ validateState()

void gridfire::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).

Definition at line 359 of file engine_adaptive.cpp.

## Member Data Documentation

## ◆ m_activeReactions

reaction::LogicalReactionSet gridfire::AdaptiveEngineView::m_activeReactions
| private

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

Definition at line 292 of file engine_adaptive.h.

## ◆ m_activeSpecies

std::vector<fourdst::atomic::Species> gridfire::AdaptiveEngineView::m_activeSpecies
| private

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

Definition at line 290 of file engine_adaptive.h.

## ◆ m_baseEngine

DynamicEngine& gridfire::AdaptiveEngineView::m_baseEngine
| private

The underlying engine to which this view delegates calculations.

Definition at line 287 of file engine_adaptive.h.

## ◆ m_config

Config& gridfire::AdaptiveEngineView::m_config = Config::getInstance()
| private

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

Definition at line 282 of file engine_adaptive.h.

## ◆ m_isStale

bool gridfire::AdaptiveEngineView::m_isStale = true
| private

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

Definition at line 300 of file engine_adaptive.h.

## ◆ m_logger

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

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

Definition at line 284 of file engine_adaptive.h.

## ◆ m_reactionIndexMap

std::vector<size_t> gridfire::AdaptiveEngineView::m_reactionIndexMap
| private

A map from the indices of the active reactions to the indices of the corresponding reactions in the full network.

Definition at line 297 of file engine_adaptive.h.

## ◆ m_speciesIndexMap

std::vector<size_t> gridfire::AdaptiveEngineView::m_speciesIndexMap
| private

A map from the indices of the active species to the indices of the corresponding species in the full network.

Definition at line 295 of file engine_adaptive.h.

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