DenseTriggers::Filter Class Reference

Filter activations of a dense trigger using a non-dense trigger. More...

#include <Filter.hpp>

Classes
struct	FilterOption
struct	TriggerOption

Public Types
using	options = tmpl::list< TriggerOption, FilterOption >
using	is_triggered_argument_tags = tmpl::list< Tags::DataBox >
using	is_ready_argument_tags = tmpl::list< Tags::DataBox >

Public Member Functions
	Filter (std::unique_ptr< DenseTrigger > trigger, std::unique_ptr< Trigger > filter) noexcept
template<typename DbTags >
Result	is_triggered (const db::DataBox< DbTags > &box) const noexcept
template<typename DbTags >
bool	is_ready (const db::DataBox< DbTags > &box) const noexcept
void	pup (PUP::er &p) noexcept override
Public Member Functions inherited from DenseTrigger
template<typename DbTags >
Result	is_triggered (const db::DataBox< DbTags > &box) const noexcept
	Check whether the trigger fires.
template<typename DbTags >
bool	is_ready (const db::DataBox< DbTags > &box) const noexcept
	Check whether all data required to evaluate the trigger is available. 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.

Static Public Attributes
static constexpr Options::String	help

Detailed Description

Filter activations of a dense trigger using a non-dense trigger.

For example, to trigger every 10 starting at 100, one could use

Filter:
  Trigger:
    Times:
      EvenlySpaced:
        Offset: 0
        Interval: 10
  Filter:
    TimeCompares:
      Comparison: GreaterThanOrEqualTo
      Value: 100

Member Data Documentation

help

constexpr Options::String DenseTriggers::Filter::help

staticconstexpr

Initial value:

=
      "Filter activations of a dense trigger using a non-dense trigger."