ESyS-Particle  2.3.4
CheckPointInfo.h
Go to the documentation of this file.
1 // //
3 // Copyright (c) 2003-2017 by The University of Queensland //
4 // Centre for Geoscience Computing //
5 // http://earth.uq.edu.au/centre-geoscience-computing //
6 // //
7 // Primary Business: Brisbane, Queensland, Australia //
8 // Licensed under the Open Software License version 3.0 //
9 // http://www.apache.org/licenses/LICENSE-2.0 //
10 // //
12 
13 
14 #ifndef ESYS_LSMCHECKPOINTINFO_H
15 #define ESYS_LSMCHECKPOINTINFO_H
16 
17 #include <vector>
18 #include <iostream>
19 
20 namespace esys
21 {
22  namespace lsm
23  {
24  class GeometryInfo;
25  typedef std::vector<std::string> StringVector;
30  {
31  public:
33 
35 
36  bool operator==(const CheckPointInfo &cpInfo) const;
37 
38  const GeometryInfo &getGeometryInfo() const;
39  void setGeometryInfo(const GeometryInfo &geoInfo);
40 
41  const StringVector &getLatticeDataFiles() const;
42  void setLatticeDataFiles(const StringVector &fileNames);
43 
44  int getNumTimeSteps() const;
45  void setNumTimeSteps(int numTimeSteps);
46 
47  int getTimeStep() const;
48  void setTimeStep(int timeStep);
49 
50  double getTimeStepSize() const;
51  void setTimeStepSize(double timeStepSize);
52 
53  void read(std::istream &iStream);
54  void write(std::ostream &oStream) const;
55 
56  protected:
59 
60  private:
61  class Impl;
63  };
64  }
65 }
66 
67 #endif
esys::lsm::StringUtil::splitStrings
StringVector splitStrings(const std::string &str, const std::string &delim)
Definition: StringUtil.h:169
esys::lsm::CheckPointInfo::Impl::read
void read(std::istream &iStream)
Definition: CheckPointInfo.cpp:55
esys::lsm::CheckPointInfo::Impl::m_numTimeSteps
int m_numTimeSteps
Definition: CheckPointInfo.cpp:103
esys::lsm::CheckPointInfo::Impl::m_timeStepSize
double m_timeStepSize
Definition: CheckPointInfo.cpp:104
esys::lsm::CheckPointInfo::CheckPointInfo
CheckPointInfo()
Definition: CheckPointInfo.cpp:110
esys::lsm::CheckPointInfo::Impl::m_timeStep
int m_timeStep
Definition: CheckPointInfo.cpp:105
esys::lsm::CheckPointInfo::Impl::~Impl
~Impl()
Definition: CheckPointInfo.cpp:35
esys::lsm::StringVector
std::vector< std::string > StringVector
Definition: CheckPointInfo.h:24
esys::lsm::CheckPointInfo::getTimeStepSize
double getTimeStepSize() const
esys::lsm::CheckPointInfo::operator=
CheckPointInfo & operator=(const CheckPointInfo &cpInfo)
esys::lsm::CheckPointInfo::setNumTimeSteps
void setNumTimeSteps(int numTimeSteps)
Definition: CheckPointInfo.cpp:144
esys::lsm::CheckPointInfo::getGeometryInfo
const GeometryInfo & getGeometryInfo() const
Definition: CheckPointInfo.cpp:124
esys::lsm::CheckPointInfo::write
void write(std::ostream &oStream) const
Definition: CheckPointInfo.cpp:169
version.h
StringUtil.h
esys::lsm::CheckPointInfo::Impl::write
void write(std::ostream &oStream) const
Definition: CheckPointInfo.cpp:82
esys::lsm::CheckPointInfo::Impl::Impl
Impl()
Definition: CheckPointInfo.cpp:26
esys
Definition: CheckPointable.cpp:17
esys::lsm::CheckPointInfo::Impl
Definition: CheckPointInfo.cpp:24
esys::lsm::CheckPointInfo::Impl::m_geoInfo
GeometryInfo m_geoInfo
Definition: CheckPointInfo.cpp:106
esys::lsm::CheckPointInfo::setTimeStep
void setTimeStep(int timeStep)
Definition: CheckPointInfo.cpp:149
esys::lsm::CheckPointInfo
Definition: CheckPointInfo.h:30
esys::lsm::StringUtil::trim
std::string trim(const std::string &str)
Definition: StringUtil.h:175
esys::lsm::CheckPointInfo::setLatticeDataFiles
void setLatticeDataFiles(const StringVector &fileNames)
Definition: CheckPointInfo.cpp:139
esys::lsm::CheckPointInfo::setGeometryInfo
void setGeometryInfo(const GeometryInfo &geoInfo)
Definition: CheckPointInfo.cpp:129
esys::lsm::GeometryInfo
Definition: GeometryInfo.h:34
esys::lsm::CheckPointInfo::~CheckPointInfo
~CheckPointInfo()
Definition: CheckPointInfo.cpp:114
esys::lsm::StringUtil::join
std::string join(TmplIterator begin, TmplIterator end, const std::string &delim, TmplStringOperator toStringOp=StdOStreamOp< TmplIterator >())
Definition: StringUtil.h:47
CheckPointInfo.h
esys::lsm::CheckPointInfo::m_pImpl
Impl * m_pImpl
Definition: CheckPointInfo.h:61
esys::lsm::CheckPointInfo::read
void read(std::istream &iStream)
Definition: CheckPointInfo.cpp:164
lsm_version_info::ESySParticleVersion
static const std::string ESySParticleVersion
Definition: version.h:20
esys::lsm::CheckPointInfo::Impl::operator==
bool operator==(const Impl &impl) const
Definition: CheckPointInfo.cpp:39
esys::lsm::CheckPointInfo::getLatticeDataFiles
const StringVector & getLatticeDataFiles() const
Definition: CheckPointInfo.cpp:134
esys::lsm::CheckPointInfo::CheckPointInfo
CheckPointInfo(const CheckPointInfo &cpInfo)
esys::lsm::CheckPointInfo::operator==
bool operator==(const CheckPointInfo &cpInfo) const
Definition: CheckPointInfo.cpp:119
esys::lsm::CheckPointInfo::getTimeStep
int getTimeStep() const
Definition: CheckPointInfo.cpp:154
esys::lsm::CheckPointInfo::setTimeStepSize
void setTimeStepSize(double timeStepSize)
Definition: CheckPointInfo.cpp:159
esys::lsm::CheckPointInfo::Impl::m_fileNames
StringVector m_fileNames
Definition: CheckPointInfo.cpp:107
GeometryInfo.h
esys::lsm::GeometryInfo::writeWithoutVersion
void writeWithoutVersion(std::ostream &oStream) const
Definition: GeometryInfo.cpp:343
esys::lsm::StringUtil::StdOStreamOp
Definition: StringUtil.h:34
lsm_version_info::CheckPointVersion
static const int CheckPointVersion
Definition: version.h:19
esys::lsm::CheckPointInfo::getNumTimeSteps
int getNumTimeSteps() const
esys::lsm::GeometryInfo::read
void read(std::istream &iStream)
Definition: GeometryInfo.cpp:333