File: CheckPointParamsPy.cpp

package info (click to toggle)
esys-particle 2.1-4
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 7,284 kB
  • sloc: cpp: 77,304; python: 5,647; makefile: 1,176; sh: 10
file content (118 lines) | stat: -rw-r--r-- 3,933 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
/////////////////////////////////////////////////////////////
//                                                         //
// Copyright (c) 2003-2011 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          //
//                                                         //
/////////////////////////////////////////////////////////////


#include <boost/version.hpp>
#include <boost/python.hpp>
#include "Foundation/StringUtil.h"
#include "Python/esys/lsm/CheckPointParamsPy.h"

namespace esys
{
  namespace lsm
  {
    CheckPointPrmsPy::CheckPointPrmsPy(
      const std::string &fileNamePrefix,
      int beginTimeStep,
      int endTimeStep,
      int timeStepIncr
    )
      : m_fileNamePrefix(fileNamePrefix),
        m_beginTimeStep(beginTimeStep),
        m_endTimeStep(endTimeStep),
        m_timeStepIncr(timeStepIncr)
    {
    }

    boost::python::list CheckPointPrmsPy::getFileNameList() const
    {
      boost::python::list fileNameList;
      for (int i = getBeginTimeStep(); i < getEndTimeStep(); i += getTimeStepIncr())
        {
          fileNameList.append(getFileName(i));
        }
      fileNameList.append(getFileName(getEndTimeStep()));
      return fileNameList;
    }

    std::string CheckPointPrmsPy::getFileName(int timeStep, int rank) const
    {
      return (getFileNamePrefix()+ "_t=" +
              StringUtil::toString(timeStep) + "_" +
              StringUtil::toString(rank) + ".txt");
    }

    using boost::python::arg;
    void exportCheckPointPrms()
    {
      // Check that Boost 1.34.0 or higher is being used.
      // If so, disable auto-generation of C++ signatures for Epydoc
      // (which stumbles over indentation in the auto-generated strings).
      #if ((BOOST_VERSION / 100000 >= 1) \
          && (BOOST_VERSION / 100 % 1000 >= 34)) \
          || (BOOST_VERSION / 100000 >= 2)
        boost::python::docstring_options no_autogen(true,false);
      #endif

      boost::python::class_<CheckPointPrmsPy>(
        "CheckPointPrms",
        "Parameters for specifying check-pointing intervals.",
        boost::python::init<const std::string &, int, int, int>(
          (
            arg("fileNamePrefix"),
            arg("beginTimeStep"),
            arg("endTimeStep"),
            arg("timeStepIncr")
          ),
          "@type fileNamePrefix: string\n"
          "@kwarg fileNamePrefix: prefix of files where checkpoint data"
          " is saved.\n"
          "@type beginTimeStep: int\n"
          "@kwarg beginTimeStep: time step when checkpoint saving begins.\n"
          "@type endTimeStep: int\n"
          "@kwarg endTimeStep: time step when checkpoint saving stops.\n"
          "@type timeStepIncr: int\n"
          "@kwarg timeStepIncr: a checkpoint is made every"
          "C{timeStepIncr} time-steps.\n"
        )
      )
        .def(
          "getFileNamePrefix",
          &CheckPointPrmsPy::getFileNamePrefix,
          "@rtype: string\n"
          "@return: prefix of files where checkpoint data is saved.\n"
        )
        .def(
          "getBeginTimeStep",
          &CheckPointPrmsPy::getBeginTimeStep,
          "@rtype: int"
        )
        .def(
          "getEndTimeStep",
          &CheckPointPrmsPy::getEndTimeStep,
          "@rtype: int"
        )
        .def(
          "getTimeStepIncr",
          &CheckPointPrmsPy::getTimeStepIncr,
          "@rtype: int"
        )
        .def(
          "getFileNameList",
          &CheckPointPrmsPy::getFileNameList,
          "@rtype: list\n"
          "@return: List of 'master' check-point file names."
        )
        ;
    }
  }
}