FieldWriter.h File Reference

#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "../global/global.h"
#include "../grid/field_info.h"
#include "../grid/grid3D.h"
#include "../io/FnameTemplate.h"
#include "../io/LazyScratchBuf.h"
#include "../io/ParameterMap.h"
#include "../io/WriterManager.h"
#include "../utils/basic_structs.h"

Include dependency graph for FieldWriter.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	io::DatasetSpecEntry
struct	io::DatasetSpec
class	io::FieldWriter
	A callable type that writes general grid data. More...

Enumerations
enum struct	FileFormat { TEXT , H5_NATIVE_PRECISION , H5_F32 }
enum struct	io::WriteCond { ALWAYS , REQUIRE_COMPLETE_DATA }

Functions
std::optional< std::string >	io::lookup_legacy_short_name_ (std::string_view field_name, bool for_text_file=true)

Detailed Description

Declares the FieldWriter type

Enumeration Type Documentation

WriteCond

enum struct io::WriteCond

strong

Specifies the condition for writing data to disk.

Function Documentation

lookup_legacy_short_name_()

std::optional< std::string > io::lookup_legacy_short_name_ ( std::string_view  field_name, bool  for_text_file = true  )

inline

Lookup the shortened output name

Parameters

field_name	the ordinary field name
for_text_file	When true, we return the legacy column names used in text file outputs. Otherwise, we return the name used for recording slices.

Note

Earlier versions of the text output function were designed to shorten "magnetic_[xyz]" to "mag[XYZ]." But, as far as I can tell, this was never really used. Consequently, we don't shorten these field names.