Trigger at specified times. More...

#include <Times.hpp>

Public Types
using	is_triggered_return_tags = tmpl::list<>

using	is_triggered_argument_tags = tmpl::list< Tags::Time >

using	next_check_time_return_tags = tmpl::list<>

using	next_check_time_argument_tags = tmpl::list< Tags::TimeStepId, Tags::Time >

Public Member Functions
	Times (std::unique_ptr< TimeSequence< double > > times)

template<typename Metavariables , typename ArrayIndex , typename Component >
std::optional< bool >	is_triggered (Parallel::GlobalCache< Metavariables > &, const ArrayIndex &, const Component *, const double time) const

template<typename Metavariables , typename ArrayIndex , typename Component >
std::optional< double >	next_check_time (Parallel::GlobalCache< Metavariables > &, const ArrayIndex &, const Component *, const TimeStepId &time_step_id, const double time) 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 {"Trigger at specified times."}

Detailed Description

Trigger at specified times.

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

src/ParallelAlgorithms/EventsAndDenseTriggers/DenseTriggers/Times.hpp

Public Types

Public Member Functions

Static Public Attributes

Detailed Description