File size: 5,336 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-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/>.
Class
Foam::functionObjects::timeControl
Description
General time control for functionObjects
SourceFiles
timeControlFunctionObject.C
\*---------------------------------------------------------------------------*/
#ifndef timeControlFunctionObject_H
#define timeControlFunctionObject_H
#include "functionObject.H"
#include "dictionary.H"
#include "timeControl.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class timeControl Declaration
\*---------------------------------------------------------------------------*/
class timeControl
:
public functionObject
{
// Private Data
//- Reference to the time database
const Time& time_;
//- Execute controls
Foam::timeControl executeControl_;
//- Write controls
Foam::timeControl writeControl_;
//- The functionObject to execute
autoPtr<functionObject> foPtr_;
// Private Member Functions
//- Returns true if within time bounds
bool active() const;
public:
//- Runtime type information
TypeName("timeControl");
// Constructors
//- Construct from components
timeControl
(
const word& name,
const Time&,
const dictionary&
);
//- Disallow default bitwise copy construction
timeControl(const timeControl&) = delete;
// Member Functions
// Access
//- Return time database
inline const Time& time() const;
//- Return the execute control object
inline const Foam::timeControl& executeControl() const;
//- Return the write control object
inline const Foam::timeControl& writeControl() const;
//- Return the functionObject filter
inline const functionObject& filter() const;
// Function object control
//- Return the list of fields required
virtual wordList fields() const;
//- Return true if the functionObject should be executed
// at the start
virtual bool executeAtStart() const;
//- Called at each ++ or += of the time-loop.
// foamPostProcess overrides the usual executeControl behaviour and
// forces execution (used in post-processing mode)
virtual bool execute();
//- Called at each ++ or += of the time-loop.
// foamPostProcess overrides the usual writeControl behaviour and
// forces writing (used in post-processing mode)
virtual bool write();
//- Called when Time::run() determines that the time-loop exits
virtual bool end();
//- Return the time to the next execute or write
// if time requires adjustment
virtual scalar timeToNextAction();
//- Read and set the function object if its data have changed
virtual bool read(const dictionary&);
//- Update topology using the given map
virtual void movePoints(const polyMesh& mesh);
//- Update topology using the given map
virtual void topoChange(const polyTopoChangeMap& map);
//- Update from another mesh using the given map
virtual void mapMesh(const polyMeshMap&);
//- Redistribute or update using the given distribution map
virtual void distribute(const polyDistributionMap&);
// Member Operators
//- Disallow default bitwise assignment
void operator=(const timeControl&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "timeControlFunctionObjectI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|