SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
Cce::KleinGordonCharacteristicEvolution< Metavariables > Struct Template Reference

The component for handling the CCE evolution for the Klein-Gordon system coupled with General Relativity. More...

#include <KleinGordonCharacteristicEvolution.hpp>

Public Types

using metavariables = Metavariables
using cce_system = Cce::KleinGordonSystem<evolve_ccm>
using cce_base = CharacteristicEvolution<Metavariables>
using initialize_action_list
template<typename BondiTag>
using hypersurface_computation
using klein_gordon_hypersurface_computation
using simple_tags_from_options
using self_start_extract_action_list
using extract_action_list
using phase_dependent_action_list
using compute_scri_quantities_and_observe
Public Types inherited from Cce::CharacteristicEvolution< Metavariables >
using chare_type = Parallel::Algorithms::Singleton
using metavariables = Metavariables
using cce_system = Cce::System<evolve_ccm>
using initialize_action_list
using simple_tags_from_options
template<typename BondiTag>
using hypersurface_computation
using compute_scri_quantities_and_observe
using self_start_extract_action_list
using extract_action_list
using phase_dependent_action_list

Static Public Member Functions

static void initialize (Parallel::CProxy_GlobalCache< Metavariables > &)
static void execute_next_phase (const Parallel::Phase next_phase, const Parallel::CProxy_GlobalCache< Metavariables > &global_cache)
Static Public Member Functions inherited from Cce::CharacteristicEvolution< Metavariables >
static void initialize (Parallel::CProxy_GlobalCache< Metavariables > &)
static void execute_next_phase (const Parallel::Phase next_phase, const Parallel::CProxy_GlobalCache< Metavariables > &global_cache)

Static Public Attributes

static constexpr bool evolve_ccm = Metavariables::evolve_ccm
Static Public Attributes inherited from Cce::CharacteristicEvolution< Metavariables >
static constexpr bool checkpoint_data = true
static constexpr bool evolve_ccm = Metavariables::evolve_ccm

Detailed Description

template<class Metavariables>
struct Cce::KleinGordonCharacteristicEvolution< Metavariables >

The component for handling the CCE evolution for the Klein-Gordon system coupled with General Relativity.

Details

The DataBox associated with KleinGordonCharacteristicEvolution will contain all the tags of CharacteristicEvolution, with additional tags related to the scalar field.

Metavariables requirements:

  • Phases:
    • Initialization
    • Evolve
  • Modified type aliases in comparison to CharacteristicEvolution:
    • evolved_swsh_tags: The spin-weighted quantities to be evolved ( KleinGordonPsi and BondiJ).
    • evolved_swsh_dt_tags: The spin-weighed quantities associated that are to act as the time derivative to evolve evolved_swsh_tags (KleinGordonPi and BondiH).
  • Additional type aliases related to the scalar field:
    • klein_gordon_boundary_communication_tags: A typelist of tags that will be communicated between the worldtube boundary component and the extraction component (Cce::Tags::klein_gordon_worldtube_boundary_tags).
    • klein_gordon_gauge_boundary_tags: A typelist of tags that will be derived via GaugeAdjustedBoundaryValue and corresponding gauge utilities
    • klein_gordon_scri_tags: the tags of quantities to compute at scri+

Member Typedef Documentation

◆ hypersurface_computation

template<class Metavariables>
template<typename BondiTag>
using Cce::KleinGordonCharacteristicEvolution< Metavariables >::hypersurface_computation
Initial value:
typename cce_base::template hypersurface_computation<BondiTag>

◆ initialize_action_list

template<class Metavariables>
using Cce::KleinGordonCharacteristicEvolution< Metavariables >::initialize_action_list
Initial value:
tmpl::append<
tmpl::list<Actions::InitializeKleinGordonVariables<Metavariables>>,
typename cce_base::initialize_action_list>

◆ klein_gordon_hypersurface_computation

template<class Metavariables>
using Cce::KleinGordonCharacteristicEvolution< Metavariables >::klein_gordon_hypersurface_computation
Initial value:
tmpl::list<
tmpl::transform<
tmpl::bind<ComputeBondiIntegrand, tmpl::_1>>>>
typename detail::integrand_terms_to_compute_for_bondi_variable_impl< BondiVariable >::type integrand_terms_to_compute_for_bondi_variable
A struct for providing a tmpl::list of integrand tags that need to be computed before integration can...
Definition Equations.hpp:104
Apply the function Mutator::apply to the DataBox.
Definition MutateApply.hpp:49
Prepare the input quantities in the DataBox for the evaluation of the hypersurface integral used to c...
Definition CharacteristicEvolutionBondiCalculations.hpp:36

◆ phase_dependent_action_list

template<class Metavariables>
using Cce::KleinGordonCharacteristicEvolution< Metavariables >::phase_dependent_action_list
Initial value:
tmpl::list<
initialize_action_list>,
self_start_extract_action_list, cce_system,
@ Initialization
initial phase of an executable
Definition Phase.hpp:67
@ InitializeTimeStepperHistory
phase in which the time stepper executes a self-start procedure
Definition Phase.hpp:72
tmpl::flatten< tmpl::list< SelfStart::Actions::Initialize< System, CacheTagPrefix >, ::Actions::Label< detail::PhaseStart >, SelfStart::Actions::CheckForCompletion< detail::PhaseEnd, System >, ::Actions::MutateApply< AdvanceTime< CacheTagPrefix > >, SelfStart::Actions::CheckForOrderIncrease, StepActions, ::Actions::Goto< detail::PhaseStart >, ::Actions::Label< detail::PhaseEnd >, SelfStart::Actions::Cleanup, ::Actions::MutateApply< AdvanceTime< CacheTagPrefix > >, Parallel::Actions::TerminatePhase > > self_start_procedure
The list of actions required to self-start an integrator.
Definition SelfStartActions.hpp:458
Tag for duplicating functionality of another tag, but allows creation from options in the Cce::Evolut...
Definition OptionTags.hpp:266
List of all the actions to be executed in the specified phase.
Definition PhaseDependentActionList.hpp:17

◆ simple_tags_from_options

template<class Metavariables>
using Cce::KleinGordonCharacteristicEvolution< Metavariables >::simple_tags_from_options
Initial value:
tmpl::remove_duplicates< tmpl::flatten< tmpl::transform< InitializationActionsList, detail::get_simple_tags_from_options_from_action< tmpl::_1 > > > > get_simple_tags_from_options
Given a list of initialization actions, returns a list of the unique simple_tags_from_options for all...
Definition ParallelComponentHelpers.hpp:295

The documentation for this struct was generated from the following file:
  • src/Evolution/Systems/Cce/Components/KleinGordonCharacteristicEvolution.hpp