src/multiSolver/multiTime/multiTime.H

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