Triggers::SeparationLessThan Class Reference

A standard trigger that monitors the separation between domain::Tags::ObjectCenter<A> and domain::Tags::ObjectCenter<B> in the inertial frame. Once the separation is smaller than (or equal to) the input separation, then the operator() returns true. More...

#include <SeparationLessThan.hpp>

Classes
struct	Value

Public Types
using	options = tmpl::list< Value >
using	argument_tags = tmpl::list< Tags::Time, domain::Tags::Domain< 3 >, domain::Tags::FunctionsOfTime, domain::Tags::ObjectCenter< domain::ObjectLabel::A >, domain::Tags::ObjectCenter< domain::ObjectLabel::B > >

Public Member Functions
	SeparationLessThan (double separation)
bool	operator() (const double time, const ::Domain< 3 > &domain, const std::unordered_map< std::string, std::unique_ptr< domain::FunctionsOfTime::FunctionOfTime > > &functions_of_time, const tnsr::I< double, 3, Frame::Grid > &grid_object_center_a, const tnsr::I< double, 3, Frame::Grid > &grid_object_center_b) const
void	pup (PUP::er &p) override
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

A standard trigger that monitors the separation between domain::Tags::ObjectCenter<A> and domain::Tags::ObjectCenter<B> in the inertial frame. Once the separation is smaller than (or equal to) the input separation, then the operator() returns true.

Note

This trigger requires that domain::Tags::ObjectCenter<domain::ObjectLabel::A> and domain::Tags::ObjectCenter<domain::ObjectLabel::B> are in the DataBox. It also requires that there are two ExcisionSpheres in the Domain named ExcisionSphereA/B and that these ExcisionSpheres have had time dependent maps injected into them. The coordinate maps from these ExcisionSpheres will be used to calculate the separation in the inertial frame.

Member Data Documentation

help

constexpr Options::String Triggers::SeparationLessThan::help

staticconstexpr

Initial value:

{
      "Trigger when the separation between the two horizons is less than a "
      "certain distance."}

---

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

• src/Evolution/Triggers/SeparationLessThan.hpp