#include <parallelInitFuncFromCheckpoint.h>

Inheritance diagram for ParallelCheckpointRestart:

Collaboration diagram for ParallelCheckpointRestart:

Public Member Functions
	ParallelCheckpointRestart (Data data, const char name, ParallelEnv *env)

virtual	~ParallelCheckpointRestart ()

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

Public Member Functions inherited from InitialFunc
	InitialFunc (Data *data)

virtual	~InitialFunc ()

Additional Inherited Members
Public Attributes inherited from InitialFunc
Data *	data

Detailed Description

Initialise from checkpoint restart file for a data structure that has been distributed across ranks

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 ParallelCheckpointArgs object.

Definition at line 17 of file parallelInitFuncFromCheckpoint.h.

Constructor & Destructor Documentation

◆ ParallelCheckpointRestart()

ParallelCheckpointRestart::ParallelCheckpointRestart	(	Data *	data,
		const char *	name,
		ParallelEnv *	env
	)

Initialise from checkpoint restart file.

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

Parameters

[in]	*data	pointer to Data class containing global simulation data
[in]	name	String, name of the checkpoint restart file including path (if not in execution folder) and extension
[in]	*env	pointer to ParallelEnv class

See also: InitialFunc

◆ ~ParallelCheckpointRestart()

virtual ParallelCheckpointRestart::~ParallelCheckpointRestart ( )

inlinevirtual

Destructor.

Definition at line 30 of file parallelInitFuncFromCheckpoint.h.

Member Function Documentation

◆ readDataSetDouble()

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

virtual

/brief reads an HDF5 dataset for initialisation from checkpoint restart

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