engineTime.C

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2021-2024 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/>.
 
\*---------------------------------------------------------------------------*/
 
#include "engineTime.H"
#include "unitConversion.H"
#include "addToRunTimeSelectionTable.H"
 
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
 
namespace Foam
{
namespace userTimes
{
    defineTypeNameAndDebug(engine, 0);
    addToRunTimeSelectionTable(userTime, engine, dictionary);
}
}
 
 
// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
Foam::userTimes::engine::engine(const dictionary& controlDict)
:
    userTime(controlDict),
    omega_(dict(controlDict))
{
    addUnits(unitName(), unitConversion(dimTime, 0, 0, userTimeToTime(1)));
}
 
 
// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 
Foam::userTimes::engine::~engine()
{}
 
 
// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
Foam::scalar Foam::userTimes::engine::userTimeToTime
(
    const scalar theta
) const
{
    return theta/radToDeg(omega_.value());
}
 
 
Foam::scalar Foam::userTimes::engine::timeToUserTime(const scalar t) const
{
    return t*radToDeg(omega_.value());
}
 
 
Foam::word Foam::userTimes::engine::unitName() const
{
    return "CAD";
}
 
 
const Foam::unitConversion& Foam::userTimes::engine::units() const
{
    return Foam::units()[unitName()];
}
 
 
bool Foam::userTimes::engine::read(const dictionary& controlDict)
{
    omega_ = omega(dict(controlDict));
    addUnits(unitName(), unitConversion(dimTime, 0, 0, userTimeToTime(1)));
    return true;
}
 
 
// ************************************************************************* //