SpECTRE  v2024.12.16
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
observers::Tags::SurfaceFileName Struct Reference

The name of the HDF5 file on disk into which surface data is written. More...

#include <Tags.hpp>

Public Types

using type = std::string
 
using option_tags = implementation defined
 

Static Public Member Functions

static std::string create_from_options (const std::string &surface_file_name)
 

Static Public Attributes

static constexpr bool pass_metavariables = false
 

Detailed Description

The name of the HDF5 file on disk into which surface data is written.

By surface data we mean data for a 2d surface in a 3d simulation, such as a horizon. Surface data is written once across all nodes. For example, data on a 2d surface written from a 2d simulation is considered volume data, while an integral over the entire (or a subset of the) domain is considered reduction data.


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