SpECTRE  v2024.06.18
Public Types | Static Public Member Functions | List of all members
Cce::Actions::WriteScriBondiQuantities Struct Reference

Write a single row of data into an h5::Cce subfile within an H5 file. More...

#include <WriteScriBondiQuantities.hpp>

Public Types

using return_type = void
 

Static Public Member Functions

template<typename ParallelComponent , typename DbTagsList , typename Metavariables , typename ArrayIndex >
static void apply (db::DataBox< DbTagsList > &box, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &, const gsl::not_null< Parallel::NodeLock * > node_lock, const std::string &subfile_name, const size_t l_max, std::unordered_map< std::string, std::vector< double > > data)
 The apply call for the threaded action.
 
template<typename ParallelComponent , typename DbTagList , typename Metavariables >
static return_type apply (db::DataBox< DbTagList > &box, const gsl::not_null< Parallel::NodeLock * >, Parallel::GlobalCache< Metavariables > &cache, const std::string &subfile_name, const size_t l_max, std::unordered_map< std::string, std::vector< double > > data)
 The apply call for the local synchronous action.
 

Detailed Description

Write a single row of data into an h5::Cce subfile within an H5 file.

Details

This action can be called as either a threaded action or a local synchronous action. In both cases, invoke this action on the observers::ObserverWriter component on node 0. You must pass the following arguments when invoking this action

  • subfile_name: the name of the h5::Cce subfile in the HDF5 file.
  • l_max: the number of spherical harmonics of the data
  • data: a std::unordered_map<std::string, std::vector<double>> where the keys are the names of all the bondi quantities to write and the data are the spherical harmonic coefficients. See h5::Cce for exactly what names need to be used and the layout of the data.
Note
If you want to write data into an h5::Dat file, use observers::ThreadedActions::WriteReductionDataRow.
The documentation for this struct was generated from the following file: