SerialSaveData Class Reference

#include <serialSaveData.h>

Inheritance diagram for SerialSaveData:

Collaboration diagram for SerialSaveData:

Public Member Functions
void	saveCons ()
void	savePrims ()
void	saveAux ()
void	saveDomain ()
void	saveConsts ()
	SerialSaveData (Data *data, SerialEnv *env, int test=0)
virtual	~SerialSaveData ()
void	saveAll (bool timeSeries=false)
void	saveVar (string variable, int num=1)
Public Member Functions inherited from SaveData
	SaveData (Data *data, int test=0)
virtual	~SaveData ()

Public Attributes
SerialEnv *	env
Public Attributes inherited from SaveData
Data *	d
int	Nouts
int	Ncount
int	test
char	dir [50]
char	app [50]

Detailed Description

Class used to save simulation data to a text format using a single process

Class is initialized with the data that is to be saved. Saves the simulation data in the Data directory, located within the Project folder. All data is saved automatically, including all constant data (xmin, ymax, endTime etc) and and the values of all prims, aux and cons variables.

Definition at line 23 of file serialSaveData.h.

Constructor & Destructor Documentation

SerialSaveData()

SerialSaveData::SerialSaveData ( Data *  data, SerialEnv *  env, int  test = 0  )

inline

Constructor.

The constructor take a pointer to the data class which the user wants to save. All this data is automatically saved in the Data directory, located in the Project folder.

Parameters

*data	pointer to the Data class
test	integar flagging if we are in the 'Examples' directory or not, Only used for running the given examples, can ignore otherwise.

Definition at line 56 of file serialSaveData.h.

~SerialSaveData()

virtual SerialSaveData::~SerialSaveData ( )

inlinevirtual

Destructor.

Definition at line 58 of file serialSaveData.h.

Member Function Documentation

saveAll()

void SerialSaveData::saveAll ( bool  timeSeries = false )

virtual

Saves all cons, prims, aux and constant data.

This calls the other member functions to save their respective simulation data.

Parameters

[in]

timeSeries

flags whether the saved data is final or transient

Implements SaveData.

saveAux()

void SerialSaveData::saveAux ( )

virtual

Saves the auxiliary vector state.

Implements SaveData.

saveCons()

void SerialSaveData::saveCons ( )

virtual

Saves the conserved vector state.

Implements SaveData.

saveConsts()

void SerialSaveData::saveConsts ( )

virtual

Saves the constant data.

Implements SaveData.

saveDomain()

void SerialSaveData::saveDomain ( )

virtual

Saves the domain coordinates.

Implements SaveData.

savePrims()

void SerialSaveData::savePrims ( )

virtual

Saves the primitive vector state.

Implements SaveData.

saveVar()

void SerialSaveData::saveVar ( string  variable, int  num = 1  )

virtual

Saves user specified variable.

Function saves the data for the variable specified by the string var

Parameters

[in]	variable	Defines the variable the user wants to save. Should match a variable label
[in]	num	number of user-specified variables to save in total (required for consistent numbering of files)

Implements SaveData.

Member Data Documentation

env

SerialEnv* SerialSaveData::env

Pointer to PlatformEnv class containing platform specific info such as MPI details.

Definition at line 28 of file serialSaveData.h.

---

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

• serialSaveData.h