data_writer.h File Reference

Data writer class declaration. More...

#include <limits>
#include <memory>
#include <string>
#include <unordered_map>
#include <utility>
#include <vector>
#include <toml.hpp>
#include "data.h"
#include "global_order.h"
#include "mesh.h"

Go to the source code of this file.

Classes
struct	RestartFaces
	Face records of a restart file (version 4): the [p, u_n] of the characteristic boundary faces (docs/design/nscbc.md). A face's key is RESTART_FACES_PER_CELL times the global id of its cell, plus its local face in that cell, so that it does not depend on the rank count. More...
struct	RestartData
	Contents of a restart file. More...
class	DataWriter
	Writes snapshots either every interval steps or every time_interval units of simulation time. Time-based writers also constrain the time step so that snapshots land exactly on output times. More...
struct	DataWriter::Field
	An output array: one scalar, or the N_DIM components of a vector (written as 3 components, zero-padded in 2D). More...

Typedefs
using	RestartAttributes = std::vector< std::pair< std::string, double > >
	Named scalars of a restart file (version 3), e.g. the statistics' weight.

Enumerations
enum class	DataFormat { VTU , RESTART , HDF5 }

Functions
RestartData	read_restart (const std::string &filename, const std::vector< uint64_t > *cells=nullptr)
	Read a restart file written by a DataWriter with format = "restart": every cell, or with cells, only those global cells (fields then hold their values in the order of cells).

Variables
constexpr uint64_t	RESTART_FACES_PER_CELL = 8
	Upper bound on the faces of a cell, for the keys of RestartFaces.

Detailed Description

Data writer class declaration.

Author

Matthew Bonanni (mbona.nosp@m.nni0.nosp@m.01@gm.nosp@m.ail..nosp@m.com)

Version

0.2

Date

2024-01-11

Copyright

Copyright (c) 2024 Matthew Bonanni

Typedef Documentation

RestartAttributes

using RestartAttributes = std::vector<std::pair<std::string, double> >

Named scalars of a restart file (version 3), e.g. the statistics' weight.

Enumeration Type Documentation

DataFormat

enum class DataFormat

strong

Enumerator
VTU
RESTART
HDF5

Function Documentation

read_restart()

RestartData read_restart	(	const std::string &	filename,
		const std::vector< uint64_t > *	cells = nullptr
	)

Read a restart file written by a DataWriter with format = "restart": every cell, or with cells, only those global cells (fields then hold their values in the order of cells).

Version 2 files list their variable names, version 3 files also named scalar attributes, version 4 files also face records; version 1 files hold the flow block CONSERVATIVE_NAMES only. Either must contain the flow block of this build's dimension.

Variable Documentation

RESTART_FACES_PER_CELL

constexpr uint64_t RESTART_FACES_PER_CELL = 8

constexpr

Upper bound on the faces of a cell, for the keys of RestartFaces.