DenseTriggers::Or Class Reference
Trigger when any of a collection of DenseTriggers triggers. More...
#include <Or.hpp>
Public Types | |
| using | is_triggered_return_tags = tmpl::list< Tags::DataBox > |
| using | is_triggered_argument_tags = tmpl::list<> |
| using | next_check_time_return_tags = tmpl::list< Tags::DataBox > |
| using | next_check_time_argument_tags = tmpl::list< Tags::TimeStepId > |
Public Member Functions | |
| Or (std::vector< std::unique_ptr< DenseTrigger > > triggers) | |
| template<typename Metavariables , typename ArrayIndex , typename Component , typename DbTags > | |
| std::optional< bool > | is_triggered (Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const Component *component, const gsl::not_null< db::DataBox< DbTags > * > box) const |
| template<typename Metavariables , typename ArrayIndex , typename Component , typename DbTags > | |
| std::optional< double > | next_check_time (Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const Component *component, const gsl::not_null< db::DataBox< DbTags > * > &box, const TimeStepId &time_step_id) const |
| void | pup (PUP::er &p) override |
 Public Member Functions inherited from DenseTrigger | |
| template<typename DbTags , typename Metavariables , typename ArrayIndex , typename Component > | |
| std::optional< bool > | is_triggered (const gsl::not_null< db::DataBox< DbTags > * > box, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const Component *const component) |
| Check whether the trigger fires. Returns std::nullopt if insufficient data is available to make the decision. The trigger is not responsible for checking whether dense output of the evolved variables is possible, but may need to check things such as the availability of FunctionOfTime data. | |
| template<typename DbTags , typename Metavariables , typename ArrayIndex , typename Component > | |
| std::optional< double > | next_check_time (const gsl::not_null< db::DataBox< DbTags > * > box, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const Component *component) |
| Obtain the next time to check the trigger, or std::nullopt if the trigger is not ready to report yet. | |
| std::optional< double > | previous_trigger_time () const |
Reports the value of Tags::Time when the trigger most recently fired, except for the most recent call of is_triggered. More... | |
| void | pup (PUP::er &p) override |
Static Public Attributes | |
| static constexpr Options::String | help |
Detailed Description
Trigger when any of a collection of DenseTriggers triggers.
Member Data Documentation
◆ help
|
staticconstexpr |
Initial value:
=
"Trigger when any of a collection of triggers triggers."
The documentation for this class was generated from the following file:
- src/ParallelAlgorithms/EventsAndDenseTriggers/DenseTriggers/Or.hpp