SpECTRE  v2023.01.13
dg::Events::ObserveFields< VolumeDim, ObservationValueTag, tmpl::list< Tensors... >, tmpl::list< NonTensorComputeTags... >, ArraySectionIdTag >::OverrideObservationValue Struct Reference

Override the observation value in the ObservationBox. More...

#include <ObserveFields.hpp>

Public Types

using type = Options::Auto< typename ObservationValueTag::type, Options::AutoLabel::None >
 

Static Public Attributes

static constexpr Options::String help
 

Detailed Description

template<size_t VolumeDim, typename ObservationValueTag, typename... Tensors, typename... NonTensorComputeTags, typename ArraySectionIdTag>
struct dg::Events::ObserveFields< VolumeDim, ObservationValueTag, tmpl::list< Tensors... >, tmpl::list< NonTensorComputeTags... >, ArraySectionIdTag >::OverrideObservationValue

Override the observation value in the ObservationBox.

Set to 'None' if you want to use the value in the ObservationBox. Overwriting is useful when dumping data on failure so that all elements have the 'same' observation value even though their boxes are in different states.

Member Data Documentation

◆ help

template<size_t VolumeDim, typename ObservationValueTag , typename... Tensors, typename... NonTensorComputeTags, typename ArraySectionIdTag >
constexpr Options::String dg::Events::ObserveFields< VolumeDim, ObservationValueTag, tmpl::list< Tensors... >, tmpl::list< NonTensorComputeTags... >, ArraySectionIdTag >::OverrideObservationValue::help
staticconstexpr
Initial value:
=
"Override the observation value in the ObservationBox. Set to 'None' "
"if you want to use the value in the ObservationBox. Overwriting is "
"useful when dumping data on failure so that all elements have the "
"'same' observation value even though their boxes are in different "
"states."

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