OpenFOAM-5.x/src/OpenFOAM/db/Time/TimeStateI.H
Henry Weller 758dfc2c1f Standardized the naming of functions which control the writing of fields etc.
to have the prefix 'write' rather than 'output'

So outputTime() -> writeTime()

but 'outputTime()' is still supported for backward-compatibility.

Also removed the redundant secondary-writing functionality from Time
which has been superseded by the 'writeRegisteredObject' functionObject.
2016-05-12 17:38:01 +01:00

77 lines
2 KiB
C

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\*---------------------------------------------------------------------------*/
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
inline Foam::scalar Foam::TimeState::timeOutputValue() const
{
return timeToUserTime(value());
}
inline Foam::label Foam::TimeState::timeIndex() const
{
return timeIndex_;
}
inline Foam::scalar Foam::TimeState::deltaTValue() const
{
return deltaT_;
}
inline Foam::scalar Foam::TimeState::deltaT0Value() const
{
return deltaT0_;
}
inline Foam::dimensionedScalar Foam::TimeState::deltaT() const
{
return dimensionedScalar("deltaT", dimTime, deltaT_);
}
inline Foam::dimensionedScalar Foam::TimeState::deltaT0() const
{
return dimensionedScalar("deltaT0", dimTime, deltaT0_);
}
inline bool Foam::TimeState::writeTime() const
{
return writeTime_;
}
inline bool Foam::TimeState::outputTime() const
{
return writeTime_;
}
// ************************************************************************* //