ah::Events::FindCommonHorizon< HorizonMetavars, tmpl::list< Tensors... >, tmpl::list< NonTensorComputeTags... > > Class Template Reference

Public Types
using	options
using	compute_tags_for_observation_box
using	return_tags = tmpl::list<>
using	argument_tags
using	observation_registration_tags = tmpl::list<::Tags::DataBox>
using	is_ready_argument_tags = tmpl::list<>

Public Member Functions
	FindCommonHorizon (const std::string &subfile_name, FloatingPointType coordinates_floating_point_type, const std::vector< FloatingPointType > &floating_point_types, const std::vector< std::string > &variables_to_observe, std::optional< std::vector< std::string > > active_block_or_block_groups={}, std::optional< Mesh< 3 > > interpolation_mesh={}, std::optional< Mesh< 3 > > projection_mesh={}, const Options::Context &context={})
template<typename DataBoxType, typename ComputeTagsList, typename Metavariables, typename ParallelComponent>
void	operator() (const ObservationBox< DataBoxType, ComputeTagsList > &box, const Mesh< 3 > &mesh, const Element< 3 > &element, Parallel::GlobalCache< Metavariables > &cache, const ElementId< 3 > &element_id, const ParallelComponent *const component, const ObservationValue &observation_value) const
template<typename DbTagsList>
std::optional< std::pair< observers::TypeOfObservation, observers::ObservationKey > >	get_observation_type_and_key_for_registration (const db::DataBox< DbTagsList > &box) const
template<typename Metavariables, typename Component>
bool	is_ready (Parallel::GlobalCache< Metavariables > &, const ElementId< 3 > &, const Component *const) const
bool	needs_evolved_variables () const override
	Whether the event uses anything depending on the evolved_variables. If this returns false, anything depending on the evolved variables may have an incorrect value when the event is run.
void	pup (PUP::er &p) override
Public Member Functions inherited from Event
	Event (CkMigrateMessage *msg)
	WRAPPED_PUPable_abstract (Event)
template<typename ComputeTagsList, typename DataBoxType, typename Metavariables, typename ArrayIndex, typename ComponentPointer>
void	run (const gsl::not_null< ObservationBox< ComputeTagsList, DataBoxType > * > box, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const ComponentPointer, const ObservationValue &observation_value) const
template<typename DbTags, typename Metavariables, typename ArrayIndex, typename ComponentPointer>
bool	is_ready (const db::DataBox< DbTags > &box, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const ComponentPointer) const

Static Public Member Functions
static std::string	name ()

Static Public Attributes
static constexpr Options::String	help

Member Typedef Documentation

argument_tags

template<typename HorizonMetavars, typename... Tensors, typename... NonTensorComputeTags>

using ah::Events::FindCommonHorizon< HorizonMetavars, tmpl::list< Tensors... >, tmpl::list< NonTensorComputeTags... > >::argument_tags

Initial value:

 
      tmpl::list<::Tags::ObservationBox, ::Events::Tags::ObserverMesh<3>,
                 domain::Tags::Element<3>>

compute_tags_for_observation_box

template<typename HorizonMetavars, typename... Tensors, typename... NonTensorComputeTags>

using ah::Events::FindCommonHorizon< HorizonMetavars, tmpl::list< Tensors... >, tmpl::list< NonTensorComputeTags... > >::compute_tags_for_observation_box

Initial value:

 tmpl::remove_duplicates<tmpl::append<
      typename ObserveFieldsEvent::compute_tags_for_observation_box,
      typename HorizonFindEvent::compute_tags_for_observation_box>>

options

template<typename HorizonMetavars, typename... Tensors, typename... NonTensorComputeTags>

using ah::Events::FindCommonHorizon< HorizonMetavars, tmpl::list< Tensors... >, tmpl::list< NonTensorComputeTags... > >::options

Initial value:

 tmpl::append<typename ObserveFieldsEvent::options,
                               typename HorizonFindEvent::options>

Member Function Documentation

needs_evolved_variables()

template<typename HorizonMetavars, typename... Tensors, typename... NonTensorComputeTags>

bool ah::Events::FindCommonHorizon< HorizonMetavars, tmpl::list< Tensors... >, tmpl::list< NonTensorComputeTags... > >::needs_evolved_variables ( ) const

inlineoverridevirtual

Whether the event uses anything depending on the evolved_variables. If this returns false, anything depending on the evolved variables may have an incorrect value when the event is run.

Implements Event.

Member Data Documentation

help

template<typename HorizonMetavars, typename... Tensors, typename... NonTensorComputeTags>

Options::String ah::Events::FindCommonHorizon< HorizonMetavars, tmpl::list< Tensors... >, tmpl::list< NonTensorComputeTags... > >::help

staticconstexpr

Initial value:

=
      "Starts a common horizon find and sends the evolved variables to be "
      "written to disk."

---

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

• src/ParallelAlgorithms/ApparentHorizonFinder/Events/FindCommonHorizon.hpp