CheckPointParams Class Reference

#include <CheckPointParams.h>

Collaboration diagram for CheckPointParams:

Public Member Functions
	CheckPointParams (const std::string &fileNamePrefix, int time, int rank, int prec)
	~CheckPointParams ()
std::string	getFileName () const
int	getPrecision () const
void	packInto (AMPIBuffer *mpiBuff) const

Static Public Member Functions
static CheckPointParams	unpackFrom (AMPIBuffer *mpiBuff, MPI_Comm mpiComm=MPI_COMM_WORLD)

Protected Member Functions
	CheckPointParams ()

Private Attributes
std::string	m_fileNamePrefix
int	m_time
int	m_rank
int	m_prec

Detailed Description

Parameters associated with check-point file creation.

Constructor & Destructor Documentation

CheckPointParams() [1/2]

CheckPointParams::CheckPointParams	(	const std::string &	fileNamePrefix,
		int	time,
		int	rank,
		int	prec
	)

~CheckPointParams()

CheckPointParams::~CheckPointParams

(

)

CheckPointParams() [2/2]

CheckPointParams::CheckPointParams ( )

protected

Member Function Documentation

getFileName()

std::string CheckPointParams::getFileName

(

)

const

Returns full check-point file (prefix plus time and rank identifier).

References m_fileNamePrefix, m_rank, and m_time.

Referenced by CheckPointController::getLatticeDataFileName(), CheckPointController::issueCheckPointCmd(), CheckPointController::issueCheckPointCmdWTM(), CheckPointController::issueSnapShotCmd(), CheckPointer::loadCheckPoint(), CheckPointer::saveDump(), and CheckPointer::saveRestartable().

Here is the caller graph for this function:

getPrecision()

int CheckPointParams::getPrecision ( ) const

inline

References m_prec.

Referenced by CheckPointer::saveRestartable().

Here is the caller graph for this function:

packInto()

void CheckPointParams::packInto

(

AMPIBuffer *

mpiBuff

)

const

References AMPIBuffer::append(), m_fileNamePrefix, m_prec, and m_time.

Referenced by CheckPointController::issueCheckPointCmd(), CheckPointController::issueCheckPointCmdWTM(), CheckPointController::issueCheckPointLoadingCmd(), and CheckPointController::issueSnapShotCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

unpackFrom()

CheckPointParams CheckPointParams::unpackFrom ( AMPIBuffer *  mpiBuff, MPI_Comm  mpiComm = MPI_COMM_WORLD  )

static

References m_fileNamePrefix, m_prec, m_rank, m_time, AMPIBuffer::pop_int(), AMPIBuffer::pop_string(), and MpiInfo::rank().

Referenced by CheckPointer::loadCheckPoint(), CheckPointer::saveDump(), CheckPointer::saveRestartable(), and CheckPointer::saveThroughMaster().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_fileNamePrefix

std::string CheckPointParams::m_fileNamePrefix

private

Prefix of check-point file names.

Referenced by getFileName(), packInto(), and unpackFrom().

m_prec

int CheckPointParams::m_prec

private

Referenced by getPrecision(), packInto(), and unpackFrom().

m_rank

int CheckPointParams::m_rank

private

Rank of mpi process.

Referenced by getFileName(), and unpackFrom().

m_time

int CheckPointParams::m_time

private

The simulation time at which checkpoint is created.

Referenced by getFileName(), packInto(), and unpackFrom().

---

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

• Parallel/CheckPointParams.h
• Parallel/CheckPointParams.cpp