SpECTRE  v2024.03.19
PhaseControl::OptionTags::PhaseChangeAndTriggers Struct Reference

Option tag for the collection of triggers that indicate synchronization points at which phase changes should be considered, and the associated PhaseChange objects for making the phase change decisions. More...

#include <PhaseControlTags.hpp>

Public Types

using type = std::vector< TriggerAndPhaseChanges >
 

Static Public Attributes

static constexpr Options::String help
 

Detailed Description

Option tag for the collection of triggers that indicate synchronization points at which phase changes should be considered, and the associated PhaseChange objects for making the phase change decisions.

When the phase control is arbitrated on the main chare, the PhaseChange objects will be queried for their phase request in order of appearance in the nested list (i.e. first all of the PhaseChanges associated with the first trigger, in order, then those associated with the second trigger, etc.). The order therefore determines the order of resolution of simultaneous requests.

Member Data Documentation

◆ help

constexpr Options::String PhaseControl::OptionTags::PhaseChangeAndTriggers::help
staticconstexpr
Initial value:
{
"A collection of pairs of triggers and collections of phase change "
"objects to determine runtime phase control-flow decisions. The order of "
"the phase change objects determines the order of the requests processed "
"by the Main chare during phase change arbitration."}

The documentation for this struct was generated from the following file: