SpECTRE  v2021.12.06
elliptic::Triggers::EveryNIterations< Label > Class Template Reference

Trigger every N iterations of the solver identifid by the Label, after a given offset. More...

#include <EveryNIterations.hpp>

Classes

struct  N
 
struct  Offset
 

Public Types

using options = tmpl::list< N, Offset >
 
using argument_tags = tmpl::list< Convergence::Tags::IterationId< Label > >
 

Public Member Functions

 EveryNIterations (const uint64_t interval, const uint64_t offset)
 
bool operator() (const size_t iteration_id) const
 
void pup (PUP::er &p)
 
- Public Member Functions inherited from Trigger
 WRAPPED_PUPable_abstract (Trigger)
 
template<typename DbTags >
bool is_triggered (const db::DataBox< DbTags > &box) const
 

Static Public Attributes

static constexpr Options::String help
 

Detailed Description

template<typename Label>
class elliptic::Triggers::EveryNIterations< Label >

Trigger every N iterations of the solver identifid by the Label, after a given offset.

Member Data Documentation

◆ help

template<typename Label >
constexpr Options::String elliptic::Triggers::EveryNIterations< Label >::help
staticconstexpr
Initial value:
{
"Trigger every N iterations after a given offset."}

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