SpECTRE  v2024.05.11
observers::Tags::ObservationKey< Tag > Struct Template Reference

A string identifying observations related to the Tag. More...

#include <Tags.hpp>

Public Types

using type = std::optional< std::string >

Static Public Member Functions

static std::string name ()

Detailed Description

template<typename Tag>
struct observers::Tags::ObservationKey< Tag >

A string identifying observations related to the Tag.

For example, the Tag could refer to the block in the computational domain and the ObservationKey holds the name of the block, so reduction observations can be registered per-block. A value of std::nullopt means that the element doesn't participate in observations related to the Tag.

This tag only provides a way to store and share the observation key related to the Tag. How it is used to construct composite observation keys or subfile paths is up to the code that performs the observations.

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