src/OpenFOAM/db/Time/TimeState.C

   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 \*---------------------------------------------------------------------------*/
  26
  27 #include "TimeState.H"
  28 #include "Time.H"
  29
  30 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  31
  32 Foam::TimeState::TimeState()
  33 :
  34     dimensionedScalar(Time::timeName(0), dimTime, 0),
  35     timeIndex_(0),
  36     deltaT_(0),
  37     deltaTSave_(0),
  38     deltaT0_(0),
  39     deltaTchanged_(false),
  40     outputTimeIndex_(0),
  41     outputTime_(false)
  42 {}
  43
  44
  45 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * * //
  46
  47 Foam::TimeState::~TimeState()
  48 {}
  49
  50
  51 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  52
  53 Foam::scalar Foam::TimeState::userTimeToTime(const scalar theta) const
  54 {
  55     return theta;
  56 }
  57
  58
  59 Foam::scalar Foam::TimeState::timeToUserTime(const scalar t) const
  60 {
  61     return t;
  62 }
  63
  64
  65 Foam::scalar Foam::TimeState::timeOutputValue() const
  66 {
  67     return timeToUserTime(value());
  68 }
  69
  70
  71 Foam::label Foam::TimeState::timeIndex() const
  72 {
  73     return timeIndex_;
  74 }
  75
  76
  77 Foam::dimensionedScalar Foam::TimeState::deltaT() const
  78 {
  79     return dimensionedScalar("deltaT", dimTime, deltaT_);
  80 }
  81
  82
  83 Foam::dimensionedScalar Foam::TimeState::deltaT0() const
  84 {
  85     return dimensionedScalar("deltaT0", dimTime, deltaT0_);
  86 }
  87
  88
  89 bool Foam::TimeState::outputTime() const
  90 {
  91     return outputTime_;
  92 }
  93
  94
  95 // ************************************************************************* //