ad7f29466a
- simply a functionObject with an additional Time reference, which is a combination frequently used by concrete functionObjects
161 lines
4.4 KiB
C++
161 lines
4.4 KiB
C++
/*---------------------------------------------------------------------------* \
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011-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/>.
|
|
|
|
Class
|
|
Foam::timeControl
|
|
|
|
Description
|
|
General time dependent execution controller.
|
|
The default to execute every time-step.
|
|
|
|
SourceFiles
|
|
timeControl.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef timeControl_H
|
|
#define timeControl_H
|
|
|
|
#include "Time.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class timeControl Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class timeControl
|
|
{
|
|
public:
|
|
|
|
//- The time control options
|
|
enum timeControls
|
|
{
|
|
ocTimeStep, //!< execution is coupled to the time-step
|
|
ocWriteTime, //!< execution is coupled to the write-time
|
|
ocOutputTime, //!< execution is coupled to the output-time
|
|
ocAdjustableRunTime, //!< Adjust time step for execution
|
|
ocRunTime, //!< run time for execution
|
|
ocClockTime, //!< clock time for execution
|
|
ocCpuTime, //!< CPU time for execution
|
|
ocOnEnd, //!< on end of run
|
|
ocNone //!< no execution
|
|
};
|
|
|
|
|
|
private:
|
|
|
|
// Private data
|
|
|
|
//- Time object
|
|
const Time& time_;
|
|
|
|
//- Prefix
|
|
const word prefix_;
|
|
|
|
//- String representation of timeControls enums
|
|
static const Enum<timeControls> timeControlNames_;
|
|
|
|
//- Type of time control
|
|
timeControls timeControl_;
|
|
|
|
//- Execution interval steps for timeStep mode
|
|
// a value <= 1 means execute at every time step
|
|
label intervalSteps_;
|
|
|
|
//- Execution interval
|
|
scalar interval_;
|
|
|
|
//- Index of previous execution
|
|
label executionIndex_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
//- No copy construct
|
|
timeControl(const timeControl&) = delete;
|
|
|
|
//- No copy assignment
|
|
void operator=(const timeControl&) = delete;
|
|
|
|
|
|
public:
|
|
|
|
// Constructors
|
|
|
|
//- Construct from Time object and dictionary
|
|
timeControl
|
|
(
|
|
const Time&,
|
|
const dictionary&,
|
|
const word& prefix
|
|
);
|
|
|
|
|
|
//- Destructor
|
|
~timeControl() = default;
|
|
|
|
|
|
// Member Functions
|
|
|
|
//- Helper function to identify if a timeControl object is present
|
|
// in the dictionary
|
|
static bool entriesPresent(const dictionary& dict, const word& prefix);
|
|
|
|
//- Read from dictionary
|
|
void read(const dictionary&);
|
|
|
|
//- Return Time
|
|
inline const Time& time() const;
|
|
|
|
//- Flag to indicate whether to execute
|
|
bool execute();
|
|
|
|
//- Return control
|
|
inline timeControls control() const;
|
|
|
|
//- Return interval
|
|
inline scalar interval() const;
|
|
|
|
//- Return the index of the previous execution
|
|
inline label executionIndex() const;
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#include "timeControlI.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|