SpECTRE  v2024.04.12
intrp::Events::Interpolate< VolumeDim, InterpolationTargetTag, tmpl::list< InterpolatorSourceVarTags... > > Class Template Reference

Public Types

using options = tmpl::list<>
 
using compute_tags_for_observation_box = detail::get_compute_items_on_source_or_default_t< InterpolationTargetTag, tmpl::list<> >
 
using return_tags = tmpl::list<>
 
using argument_tags = tmpl::list< typename InterpolationTargetTag::temporal_id, ::Events::Tags::ObserverMesh< VolumeDim >, InterpolatorSourceVarTags... >
 
using is_ready_argument_tags = tmpl::list<::Tags::Time >
 

Public Member Functions

template<typename Metavariables , typename ParallelComponent >
void operator() (const typename InterpolationTargetTag::temporal_id::type &temporal_id, const Mesh< VolumeDim > &mesh, const typename InterpolatorSourceVarTags::type &... interpolator_source_vars, Parallel::GlobalCache< Metavariables > &cache, const ElementId< VolumeDim > &array_index, const ParallelComponent *const, const ObservationValue &) const
 
template<typename Metavariables , typename ArrayIndex , typename Component >
bool is_ready (const double time, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const Component *const component) 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. More...
 
- 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
 
virtual bool needs_evolved_variables () const =0
 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. More...
 

Static Public Member Functions

static std::string name ()
 

Static Public Attributes

static constexpr Options::String help
 

Member Function Documentation

◆ needs_evolved_variables()

template<size_t VolumeDim, typename InterpolationTargetTag , typename... InterpolatorSourceVarTags>
bool intrp::Events::Interpolate< VolumeDim, InterpolationTargetTag, tmpl::list< InterpolatorSourceVarTags... > >::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<size_t VolumeDim, typename InterpolationTargetTag , typename... InterpolatorSourceVarTags>
constexpr Options::String intrp::Events::Interpolate< VolumeDim, InterpolationTargetTag, tmpl::list< InterpolatorSourceVarTags... > >::help
staticconstexpr
Initial value:
=
"Starts interpolation onto the given InterpolationTargetTag."

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