CheckPointController.h

Go to the documentation of this file.

//                                                         //
// Copyright (c) 2003-2013 by The University of Queensland //
// Earth Systems Science Computational Centre (ESSCC)      //
// http://www.uq.edu.au/esscc                              //
//                                                         //
// Primary Business: Brisbane, Queensland, Australia       //
// Licensed under the Open Software License version 3.0    //
// http://www.opensource.org/licenses/osl-3.0.php          //
//                                                         //


#ifndef CHECKPOINTCONTROLLER_H
#define CHECKPOINTCONTROLLER_H

// --- MPI includes ---
#include <mpi.h>

// --- Project includes ---
#include "Geometry/GeometryInfo.h"
#include "Foundation/StringUtil.h"
#include "Foundation/BoundingBox.h"

// --- STL includes ---
#include <string>

class CheckPointController
{
public:
  CheckPointController();

  CheckPointController(
    const std::string &fileNamePrefix,
    int beginTime,
    int endTime,
    int timeInterval,
    bool writeThroughMaster
  );

  virtual ~CheckPointController();

  virtual void performCheckPoint(int currentTime);
  virtual void performSnapShot(int currentTime);

  virtual void issueCheckPointCmd(int currentTime);
  virtual void issueCheckPointCmdWTM(int currentTime);
  virtual void issueSnapShotCmd(int currentTime);
  virtual void issueCheckPointLoadingCmd(const std::string&);

  bool isCheckPoint(int time);

  void setCheckPointParams(
    const std::string &fileNamePrefix,
    int beginTime,
    int endTime,
    int timeInterval,
    bool writeThroughMaster,
    int precision=12
  );

  std::string getLatticeDataFileName(const std::string &fileNamePrefix, int timeStep, int rank, bool bin=false);

  esys::lsm::StringVector getLatticeDataFiles(int timeStep, int size);

  esys::lsm::StringVector getLatticeDataFiles(int timeStep);

  void set_is2d(bool do2d);

  void setLsmGeoVersion(float version);

  void setPeriodicDimensions(esys::lsm::BoolVector periodicDimensions);

  void setGeometryInfo(const esys::lsm::GeometryInfo &geoInfo);

  void setSpatialDomain(const esys::lsm::BoundingBox &bBox);

  esys::lsm::GeometryInfo getGeometryInfo() const;

  int getNumTimeSteps() const;
  
  void setNumTimeSteps(int numTimeSteps);

  double getTimeStepSize() const;
  
  void setTimeStepSize(double timeStepSize);

  void setPrecision(int precision){m_precision=precision;};

  bool spatialDomainHasBeenSet() const;
 

  MPI_Comm getMpiComm() const;

  void setMpiComm(MPI_Comm mpiComm);
  

protected:
  MPI_Comm m_mpiComm;


  std::string m_fileNamePrefix;

  int m_beginTime;

  int m_endTime;

  int m_timeInterval;

  esys::lsm::GeometryInfo m_geoInfo;

  int m_numTimeSteps;

  double m_timeStepSize;

  bool m_spatialDomainHasBeenSet;
  
  bool m_writeThroughMaster;  
  int m_precision; 
};

#endif