File: FieldSaverPrmsPy.h

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 (81 lines) | stat: -rw-r--r-- 2,032 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
/////////////////////////////////////////////////////////////
//                                                         //
// 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          //
//                                                         //
/////////////////////////////////////////////////////////////

#ifndef ESYS_LSMFIELDSAVERPRMSPY_H
#define ESYS_LSMFIELDSAVERPRMSPY_H

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

//--- Boost includes ---
#include <boost/python.hpp>

namespace esys
{
  namespace lsm
  {
    class FieldSaverPrmsPy
    {
    public:
      FieldSaverPrmsPy(
        const std::string &fieldName,
        const std::string &fileName,
        const std::string &fileFormat,
        int beginTimeStep,
        int endTimeStep,
        int timeStepIncr
      );

      const std::string &getFieldName() const
      {
        return m_fieldName;
      }

      const std::string &getFileName() const
      {
        return m_fileName;
      }

      const std::string &getFileFormat() const
      {
        return m_fileFormat;
      }

      int getBeginTimeStep() const
      {
        return m_beginTimeStep;
      }
      
      int getEndTimeStep() const
      {
        return m_endTimeStep;
      }
      
      int getTimeStepIncr() const
      {
        return m_timeStepIncr;
      }

    private:
      std::string m_fieldName;
      std::string m_fileName;
      std::string m_fileFormat;
      int         m_beginTimeStep;
      int         m_endTimeStep;
      int         m_timeStepIncr;
    }; // class
    
    void exportFieldSaverPrms();
  }; // namespace lsm
}; // namespace esys

#endif //ESYS_LSMCHECKPOINTPARAMSPY_H