src/multiSolver/multiTime/multiTime.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::multiTime
  27
  28 Description
  29     Gives read access to time directory format and precision.
  30
  31 SourceFiles
  32     multiTime.C
  33
  34 Author
  35     David L. F. Gaden
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef multiTime_H
  40 #define multiTime_H
  41
  42 #include "objectRegistry.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class multiTime Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class multiTime
  54 :
  55     public Time
  56 {
  57
  58 public:
  59
  60     TypeName("multiTime");
  61
  62
  63     // Constructors
  64
  65         //- Construct given name, rootPath and casePath
  66         multiTime
  67         (
  68             const word& name,
  69             const fileName& rootPath,
  70             const fileName& caseName,
  71             const word& systemName = "system",
  72             const word& constantName = "constant"
  73         );
  74
  75         //- Construct given dictionary, rootPath and casePath
  76         multiTime
  77         (
  78             const dictionary& dict,
  79             const fileName& rootPath,
  80             const fileName& caseName,
  81             const word& systemName = "system",
  82             const word& constantName = "constant"
  83         );
  84
  85         //- Construct given endTime, rootPath and casePath
  86         multiTime
  87         (
  88             const fileName& rootPath,
  89             const fileName& caseName,
  90             const word& systemName = "system",
  91             const word& constantName = "constant"
  92         );
  93
  94
  95     // Destructor
  96     virtual ~multiTime();
  97
  98
  99     // Member functions
 100
 101         // Access
 102
 103             //- Time directory precision
 104             inline const int& precision() const
 105             {
 106                 return Time::precision_;
 107             }
 108
 109             //- Time directory format
 110             inline const Time::fmtflags& format() const
 111             {
 112                 return Time::format_;
 113             }
 114
 115 };
 116
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 } // End namespace Foam
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 #endif
 125
 126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //