METHOD
CheckpointRestart Class Reference

#include <initFuncFromCheckpoint.h>

Inheritance diagram for CheckpointRestart:
Collaboration diagram for CheckpointRestart:

Public Member Functions

 CheckpointRestart (Data *data, const char *name)
 
virtual ~CheckpointRestart ()
 
virtual void readDataSetDouble (const hid_t *group, const char *name, const int *var, double *varData)
 
- Public Member Functions inherited from InitialFunc
 InitialFunc (Data *data)
 
virtual ~InitialFunc ()
 

Additional Inherited Members

- Public Attributes inherited from InitialFunc
Datadata
 

Detailed Description

Initialise from checkpoint restart file in serial

Initialises all cons and prims from a checkpoint restart file. Requires that the Data object has been correctly initialised with the same parameters as in the checkpoint restart file, which is most easily done by initialising Data using the CheckpointArgs object. For distributed (MPI) execution use ParallelCheckpointRestart instead.

Definition at line 17 of file initFuncFromCheckpoint.h.

Constructor & Destructor Documentation

◆ CheckpointRestart()

CheckpointRestart::CheckpointRestart ( Data data,
const char *  name 
)

Initialise from checkpoint restart file.

Stores a pointer to the Data class for reference in its methods

Parameters
[in]*datapointer to Data class containing global simulation data
[in]nameString, name of the checkpoint restart file including path (if not in execution folder) and extension
See also
InitialFunc

◆ ~CheckpointRestart()

virtual CheckpointRestart::~CheckpointRestart ( )
inlinevirtual

Destructor.

Definition at line 29 of file initFuncFromCheckpoint.h.

Member Function Documentation

◆ readDataSetDouble()

virtual void CheckpointRestart::readDataSetDouble ( const hid_t *  group,
const char *  name,
const int *  var,
double *  varData 
)
virtual

/brief reads an HDF5 dataset for initialisation from checkpoint restart

Prepares the buffer for reading from file, and reads a dataset.

Parameters
groupThe group within the file (or the file itself for root datasets)
nameThe name of the dataset
varData is stored in 4-d arrays for each class of data (conserved/primitive/auxiliary), with the 1st dimension being the variable. This argument indicates which variable is being output.
dataThe pointer to the data array.

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