Loading...
Searching...
No Matches
gridfire::trigger::solver::CVODE::BoundaryFluxTrigger Class Referencefinal

`#include <engine_partitioning_trigger.h>`

Inheritance diagram for gridfire::trigger::solver::CVODE::BoundaryFluxTrigger:
[legend]
Collaboration diagram for gridfire::trigger::solver::CVODE::BoundaryFluxTrigger:
[legend]

## Public Member Functions

| BoundaryFluxTrigger (double relativeThreshold, double absoluteThreshold)
bool | check (const gridfire::solver::PointSolverTimestepContext &ctx) const override
| Evaluate the trigger condition against the provided context.
void | update (const gridfire::solver::PointSolverTimestepContext &ctx) override
| Update any internal state with the given context (e.g., counters, windows).
void | step (const gridfire::solver::PointSolverTimestepContext &ctx) override
| similar to update but intended to be run on every step not just those where the trigger triggered
void | reset () override
| Reset internal state and diagnostics counters.
std::string | name () const override
| Short, stable name for this trigger (suitable for logs/UI).
TriggerResult | why (const gridfire::solver::PointSolverTimestepContext &ctx) const override
| Explain why the last evaluation would be true/false in a structured way.
std::string | describe () const override
| Human-readable description of this trigger's logic.
size_t | numTriggers () const override
| Total number of times this trigger evaluated to true since last reset.
size_t | numMisses () const override
| Total number of times this trigger evaluated to false since last reset.
Public Member Functions inherited from gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >
virtual | ~Trigger ()=default
| Virtual destructor for polymorphic use.

## Private Types

enum class | ReactionSetType : uint8_t { ACTIVE , INACTIVE }

## Static Private Member Functions

static double | get_reaction_set_flow (const reaction::ReactionSet &reactions, const gridfire::solver::PointSolverTimestepContext &ctx, const fourdst::composition::Composition &comp, double T9, double rho, ReactionSetType type)

## Private Attributes

quill::Logger * | m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")
size_t | m_hits = 0
size_t | m_misses = 0
size_t | m_updates = 0
size_t | m_resets = 0
double | m_relativeThreshold
double | m_absoluteThreshold

## Member Enumeration Documentation

## ReactionSetType

enum class gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::ReactionSetType : uint8_t

strongprivate

Enumerator
ACTIVE |
INACTIVE |

## Constructor & Destructor Documentation

## BoundaryFluxTrigger()

gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::BoundaryFluxTrigger | ( | double | relativeThreshold,
|  | double | absoluteThreshold )

explicit

## Member Function Documentation

## check()

bool gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::check | ( | const gridfire::solver::PointSolverTimestepContext & | ctx | ) | const

overridevirtual

Evaluate the trigger condition against the provided context.

Parameters

  ctx | Context snapshot (immutable view) used to evaluate the condition.

Returns
  true if the condition is satisfied; false otherwise.

Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.

## describe()

std::string gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::describe | ( |  | ) | const

overridevirtual

Human-readable description of this trigger's logic.

Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.

## get_reaction_set_flow()

double gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::get_reaction_set_flow | ( | const reaction::ReactionSet & | reactions,
|  | const gridfire::solver::PointSolverTimestepContext & | ctx,
|  | const fourdst::composition::Composition & | comp,
|  | double | T9,
|  | double | rho,
|  | ReactionSetType | type )

staticprivate

## name()

std::string gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::name | ( |  | ) | const

overridevirtual

Short, stable name for this trigger (suitable for logs/UI).

Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.

## numMisses()

size_t gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::numMisses | ( |  | ) | const

overridevirtual

Total number of times this trigger evaluated to false since last reset.

Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.

## numTriggers()

size_t gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::numTriggers | ( |  | ) | const

overridevirtual

Total number of times this trigger evaluated to true since last reset.

Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.

## reset()

void gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::reset | ( |  | ) |

overridevirtual

Reset internal state and diagnostics counters.

Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.

## step()

void gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::step | ( | const gridfire::solver::PointSolverTimestepContext & | ctx | ) |

overridevirtual

similar to update but intended to be run on every step not just those where the trigger triggered

Parameters

  ctx | Context snapshot used to update state.

Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.

## update()

void gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::update | ( | const gridfire::solver::PointSolverTimestepContext & | ctx | ) |

overridevirtual

Update any internal state with the given context (e.g., counters, windows).

Parameters

  ctx | Context snapshot used to update state.

Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.

## why()

TriggerResult gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::why | ( | const gridfire::solver::PointSolverTimestepContext & | ctx | ) | const

overridevirtual

Explain why the last evaluation would be true/false in a structured way.

Parameters

  ctx | Context snapshot for the explanation.

Returns
  A TriggerResult tree with a boolean value and per-cause details.

Implements gridfire::trigger::Trigger< gridfire::solver::PointSolverTimestepContext >.

## Member Data Documentation

## m_absoluteThreshold

double gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::m_absoluteThreshold

private

## m_hits

size_t gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::m_hits = 0

mutableprivate

## m_logger

quill::Logger* gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")

private

## m_misses

size_t gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::m_misses = 0

mutableprivate

## m_relativeThreshold

double gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::m_relativeThreshold

private

## m_resets

size_t gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::m_resets = 0

mutableprivate

## m_updates

size_t gridfire::trigger::solver::CVODE::BoundaryFluxTrigger::m_updates = 0

mutableprivate

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

- src/include/gridfire/solver/strategies/triggers/engine_partitioning_trigger.h
- src/lib/solver/strategies/triggers/engine_partitioning_trigger.cpp