SpECTRE  v2024.03.19
observers::Tags::VolumeFileName Struct Reference

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

#include <Tags.hpp>

Public Types

using type = std::string
 
using option_tags = tmpl::list<::observers::OptionTags::VolumeFileName >
 

Static Public Member Functions

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

Static Public Attributes

static constexpr bool pass_metavariables = false
 

Detailed Description

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

By volume data we mean any data that is not 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. Data for a 2d surface in a 3d simulation, such as a horizon, is considered surface data and is written to a file specified by SurfaceFileName.


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