TimeCompares.hpp

// Distributed under the MIT License.
// See LICENSE.txt for details.
 
#pragma once
 
#include <limits>
#include <pup.h>
 
#include "Options/Comparator.hpp"
#include "Options/Options.hpp"
#include "Parallel/CharmPupable.hpp"
#include "ParallelAlgorithms/EventsAndTriggers/Trigger.hpp"
#include "Utilities/Registration.hpp"
#include "Utilities/TMPL.hpp"
 
/// \cond
namespace Tags {
struct Time;
}  // namespace Tags
/// \endcond
 
namespace Triggers {
template <typename TriggerRegistrars>
class TimeCompares;
 
namespace Registrars {
using TimeCompares = Registration::Registrar<Triggers::TimeCompares>;
}  // namespace Registrars
 
/// \ingroup EventsAndTriggersGroup
/// \ingroup TimeGroup
/// Trigger based on a comparison with the time.
template <typename TriggerRegistrars = tmpl::list<Registrars::TimeCompares>>
class TimeCompares : public Trigger<TriggerRegistrars> {
 public:
  /// \cond
  TimeCompares() = default;
  explicit TimeCompares(CkMigrateMessage* /*unused*/) noexcept {}
  using PUP::able::register_constructor;
  WRAPPED_PUPable_decl_template(TimeCompares);  // NOLINT
  /// \endcond
 
  struct Comparison {
    using type = Options::Comparator;
    constexpr static Options::String help = "Comparison type";
  };
 
  struct Value {
    using type = double;
    constexpr static Options::String help = "Value to compare to";
  };
 
  using options = tmpl::list<Comparison, Value>;
  static constexpr Options::String help{
      "Trigger based on a comparison with the time."};
 
  explicit TimeCompares(const Options::Comparator comparator,
                        const double time) noexcept
      : comparator_(comparator), time_(time) {}
 
  using argument_tags = tmpl::list<Tags::Time>;
 
  bool operator()(const double& time) const noexcept {
    return comparator_(time, time_);
  }
 
  // NOLINTNEXTLINE(google-runtime-references)
  void pup(PUP::er& p) noexcept {
    p | comparator_;
    p | time_;
  }
 
 private:
  Options::Comparator comparator_{};
  double time_{};
};
 
/// \cond
template <typename TriggerRegistrars>
PUP::able::PUP_ID TimeCompares<TriggerRegistrars>::my_PUP_ID = 0;  // NOLINT
/// \endcond
}  // namespace Triggers