91aba2db2e
- Avoids the need for the 'OutputFilterFunctionObject' wrapper
- Time-control for execution and writing is now provided by the
'timeControlFunctionObject' which instantiates the processing
'functionObject' and controls its operation.
- Alternative time-control functionObjects can now be written and
selected at run-time without the need to compile wrapped version of
EVERY existing functionObject which would have been required in the
old structure.
- The separation of 'execute' and 'write' functions is now formalized in the
'functionObject' base-class and all derived classes implement the
two functions.
- Unnecessary implementations of functions with appropriate defaults
in the 'functionObject' base-class have been removed reducing
clutter and simplifying implementation of new functionObjects.
- The 'coded' 'functionObject' has also been updated, simplified and tested.
- Further simplification is now possible by creating some general
intermediate classes derived from 'functionObject'.
135 lines
3.2 KiB
C
135 lines
3.2 KiB
C
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2013-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/>.
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#include "setTimeStepFunctionObject.H"
|
|
#include "addToRunTimeSelectionTable.H"
|
|
|
|
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
namespace functionObjects
|
|
{
|
|
defineTypeNameAndDebug(setTimeStepFunctionObject, 0);
|
|
|
|
addToRunTimeSelectionTable
|
|
(
|
|
functionObject,
|
|
setTimeStepFunctionObject,
|
|
dictionary
|
|
);
|
|
}
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
|
|
|
|
Foam::functionObjects::setTimeStepFunctionObject::setTimeStepFunctionObject
|
|
(
|
|
const word& name,
|
|
const Time& runTime,
|
|
const dictionary& dict
|
|
)
|
|
:
|
|
functionObject(name),
|
|
time_(runTime)
|
|
{
|
|
read(dict);
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
|
|
|
|
Foam::functionObjects::setTimeStepFunctionObject::~setTimeStepFunctionObject()
|
|
{}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
|
|
|
const Foam::Time&
|
|
Foam::functionObjects::setTimeStepFunctionObject::time() const
|
|
{
|
|
return time_;
|
|
}
|
|
|
|
|
|
bool Foam::functionObjects::setTimeStepFunctionObject::adjustTimeStep()
|
|
{
|
|
const_cast<Time&>(time()).setDeltaT
|
|
(
|
|
timeStepPtr_().value(time_.timeOutputValue()),
|
|
false
|
|
);
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool Foam::functionObjects::setTimeStepFunctionObject::read
|
|
(
|
|
const dictionary& dict
|
|
)
|
|
{
|
|
timeStepPtr_ = Function1<scalar>::New("deltaT", dict);
|
|
|
|
// Check that adjustTimeStep is active
|
|
const dictionary& controlDict = time_.controlDict();
|
|
|
|
Switch adjust;
|
|
if
|
|
(
|
|
!controlDict.readIfPresent<Switch>("adjustTimeStep", adjust)
|
|
|| !adjust
|
|
)
|
|
{
|
|
FatalIOErrorInFunction(dict)
|
|
<< "Need to set 'adjustTimeStep' true to allow timestep control"
|
|
<< exit(FatalIOError);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool Foam::functionObjects::setTimeStepFunctionObject::execute
|
|
(
|
|
const bool postProcess
|
|
)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
|
|
bool Foam::functionObjects::setTimeStepFunctionObject::write
|
|
(
|
|
const bool postProcess
|
|
)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
|
|
// ************************************************************************* //
|