SpECTRE  v2024.03.19
importers::Tags::Selected< FieldTag > Struct Template Reference

Indicates an available tensor field is selected for importing, along with the name of the dataset in the volume data file. More...

#include <ReadVolumeData.hpp>

Public Types

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

Detailed Description

template<typename FieldTag>
struct importers::Tags::Selected< FieldTag >

Indicates an available tensor field is selected for importing, along with the name of the dataset in the volume data file.

Set the value to a dataset name to import the FieldTag from that dataset, or to std::nullopt to skip importing the FieldTag. The dataset name excludes tensor component suffixes like "_x" or "_xy". These suffixes will be added automatically. A sensible value for the dataset name is often db::tag_name<FieldTag>(), but the user should generally be given the opportunity to set the dataset name in the input file.


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