File size: 6,317 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 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 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::functionObjectList
Description
List of function objects with start(), execute() and end() functions
that is called for each object.
See also
Foam::functionObject
Foam::functionObjects::timeControl
SourceFiles
functionObjectList.C
\*---------------------------------------------------------------------------*/
#ifndef functionObjectList_H
#define functionObjectList_H
#include "IOdictionary.H"
#include "PtrList.H"
#include "functionObject.H"
#include "SHA1Digest.H"
#include "includeFuncEntry.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class polyTopoChangeMap;
class polyMeshMap;
class polyDistributionMap;
class argList;
/*---------------------------------------------------------------------------*\
Class functionObjectList Declaration
\*---------------------------------------------------------------------------*/
class functionObjectList
:
public IOdictionary,
private PtrList<functionObject>
{
// Private Data
//- A list of SHA1 digests for the function object dictionaries
List<SHA1Digest> digests_;
//- Quick lookup of the index into functions/digests
HashTable<label> indices_;
const Time& time_;
//- Switch for the execution of the functionObjects
bool execution_;
//- Tracks if read() was called while execution is on
bool updated_;
// Private Member Functions
//- Read the function dictionary if present
// otherwise read the optional functions entry in controlDict
typeIOobject<IOdictionary> readFunctionsDict
(
const Time& t,
const bool execution
);
//- Read the functions dictionary and set construct the functionObjects
virtual bool readDict();
//- Remove and return the function object pointer by name,
// and returns the old index via the parameter.
// Returns a nullptr (and index -1) if it didn't exist
functionObject* remove(const word&, label& oldIndex);
public:
// Constructors
//- Construct from Time and the execution setting.
// The functionObject specifications are read from the controlDict
functionObjectList
(
const Time& runTime,
const bool execution=true
);
//- Disallow default bitwise copy construction
functionObjectList(const functionObjectList&) = delete;
//- Construct and return a functionObjectList for an application.
// If the "dict" argument is specified the functionObjectList is
// constructed from that dictionary which is returned as
// controlDict otherwise the functionObjectList is constructed
// from the "system/functions" dictionary
static autoPtr<functionObjectList> New
(
const argList& args,
const Time& runTime
);
//- Destructor
virtual ~functionObjectList();
// Member Functions
//- Return the number of elements in the List.
using PtrList<functionObject>::size;
//- Return true if the List is empty (ie, size() is zero).
using PtrList<functionObject>::empty;
//- Access to the functionObjects
using PtrList<functionObject>::operator[];
//- Allow addition of functionObjects to list
using PtrList<functionObject>::append;
//- Clear the list of function objects
void clear();
//- Find the ID of a given function object by name
label findObjectID(const word& name) const;
//- Read and set the function objects if their data have changed
virtual bool read();
//- Called at the start of the time-loop
bool start();
//- Called at each ++ or += of the time-loop.
// foamPostProcess overrides the usual executeControl behaviour and
// forces execution (used in post-processing mode)
bool execute();
//- Called when Time::run() determines that the time-loop exits
bool end();
//- Return the time to the next write
scalar timeToNextAction();
//- Return the maximum time-step for stable operation
virtual scalar maxDeltaT() const;
//- 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 functionObjectList&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|