ah::Events::FindApparentHorizon< HorizonMetavars > Class Template Reference

Starts a horizon find by sending volume data (ah::source_vars) to the horizon finder component (ah::Component) using the ah::FindApparentHorizon simple action. More...

#include <FindApparentHorizon.hpp>

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

Public Member Functions
	FindApparentHorizon (std::optional< std::string > dependency)
	This constructor is not available through options.
template<typename Metavariables, typename ParallelComponent>
void	operator() (const LinkedMessageId< double > &time, const Mesh< 3 > &mesh, const Element< 3 > &element, const tnsr::aa< DataVector, 3 > &spacetime_metric, const tnsr::aa< DataVector, 3 > &pi, const tnsr::iaa< DataVector, 3 > &phi, const tnsr::ijaa< DataVector, 3 > &deriv_phi, Parallel::GlobalCache< Metavariables > &cache, const ElementId< 3 > &element_id, const ParallelComponent *const, const ObservationValue &) const
template<typename Metavariables, typename ArrayIndex, typename Component>
bool	is_ready (Parallel::GlobalCache< Metavariables > &, const ArrayIndex &, 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 = "Start a horizon find."

Detailed Description

template<typename HorizonMetavars>
class ah::Events::FindApparentHorizon< HorizonMetavars >

Starts a horizon find by sending volume data (ah::source_vars) to the horizon finder component (ah::Component) using the ah::FindApparentHorizon simple action.

Details

Only sends data if this Element is in the ah::Tags::BlocksForHorizonFind tag.

Member Typedef Documentation

argument_tags

template<typename HorizonMetavars>

using ah::Events::FindApparentHorizon< HorizonMetavars >::argument_tags

Initial value:

 tmpl::append<
      tmpl::list<typename HorizonMetavars::time_tag,
                 ::Events::Tags::ObserverMesh<3>, domain::Tags::Element<3>>,
      ah::source_vars<3>>

compute_tags_for_observation_box

template<typename HorizonMetavars>

using ah::Events::FindApparentHorizon< HorizonMetavars >::compute_tags_for_observation_box

Initial value:

 
      typename HorizonMetavars::compute_tags_on_element

Member Function Documentation

needs_evolved_variables()

template<typename HorizonMetavars>

bool ah::Events::FindApparentHorizon< HorizonMetavars >::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.

---

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

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