src/OpenFOAM/db/Time/TimeState.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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::TimeState
  27
  28 Description
  29     The time value with time-stepping information, user-defined remapping, etc.
  30
  31 SourceFiles
  32     TimeState.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef TimeState_H
  37 #define TimeState_H
  38
  39 #include <OpenFOAM/dimensionedScalar.H>
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class TimeState Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50
  51 class TimeState
  52 :
  53     public dimensionedScalar
  54 {
  55
  56 protected:
  57
  58         label timeIndex_;
  59         scalar deltaT_;
  60         scalar deltaTSave_;
  61         scalar deltaT0_;
  62         bool deltaTchanged_;
  63
  64         label outputTimeIndex_;
  65         bool  outputTime_;
  66
  67
  68 public:
  69
  70     // Constructors
  71
  72         TimeState();
  73
  74
  75     // Destructor
  76
  77         //- Virtual destructor
  78         virtual ~TimeState();
  79
  80
  81     // Member functions
  82
  83         // Access
  84
  85             //- Convert the user-time (e.g. CA deg) to real-time (s).
  86             virtual scalar userTimeToTime(const scalar theta) const;
  87
  88             //- Convert the real-time (s) into user-time (e.g. CA deg)
  89             virtual scalar timeToUserTime(const scalar t) const;
  90
  91             //- Return current time value
  92             virtual scalar timeOutputValue() const;
  93
  94             //- Return current time index
  95             virtual label timeIndex() const;
  96
  97             //- Return time step
  98             virtual dimensionedScalar deltaT() const;
  99
 100             //- Return old time step
 101             virtual dimensionedScalar deltaT0() const;
 102
 103
 104         // Check
 105
 106             //- Return true if this is an output time
 107             virtual bool outputTime() const;
 108 };
 109
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 } // End namespace Foam
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 #endif
 118
 119 // ************************ vim: set sw=4 sts=4 et: ************************ //