File size: 5,447 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2025 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::writeObjects
Description
Allows specification of different writing frequency of objects registered
to the database.
It has similar functionality as the main time database through the
\c writeControl setting:
- timeStep
- writeTime
- adjustableRunTime
- runTime
- clockTime
- cpuTime
It also has the ability to write the selected objects that were defined
with the respective write mode for the requested \c writeOption, namely:
\vartable
autoWrite | objects set to write at output time
noWrite | objects set to not write by default
anyWrite | any option of the previous two
\endvartable
Example of function object specification:
\verbatim
writeObjects1
{
type writeObjects;
libs ("libutilityFunctionObjects.so");
objects (obj1 obj2);
writeOption anyWrite;
}
\endverbatim
Usage
\table
Property | Description | Required | Default value
type | type name: writeObjects | yes |
objects, fields or field | objects to write | yes |
writeOption | only those with this write option | no | anyWrite
\endtable
The objects to be written can either be specified by the \c objects,
\c fields or \c field entry, the latter two for backwards compatibility
and to provide a more logical, obvious and readable interface when
writing fields. Regular expressions can also be used when specifying
multiple \c objects or \c fields.
See also
Foam::functionObject
Foam::functionObjects::writeObjectsBase
Foam::functionObjects::timeControl
SourceFiles
writeObjects.C
\*---------------------------------------------------------------------------*/
#ifndef writeObjects_functionObject_H
#define writeObjects_functionObject_H
#include "functionObject.H"
#include "writeObjectsBase.H"
#include "NamedEnum.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class writeObjects Declaration
\*---------------------------------------------------------------------------*/
class writeObjects
:
public functionObject,
public writeObjectsBase
{
public:
// Public data types
//- Re-enumeration defining the write options, based on the original
// ones at IOobject::writeOption
enum class writeOption
{
AUTO_WRITE,
NO_WRITE,
ANY_WRITE
};
static const NamedEnum<writeOption, 3> writeOptionNames_;
private:
// Private Data
//- To only write objects of defined writeOption
writeOption writeOption_;
// Private Member Functions
//- Write the requested registered IO object
virtual void writeObject(const regIOobject& obj);
public:
//- Runtime type information
TypeName("writeObjects");
// Constructors
//- Construct from Time and dictionary
writeObjects
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- Disallow default bitwise copy construction
writeObjects(const writeObjects&) = delete;
//- Destructor
virtual ~writeObjects();
// Member Functions
//- Read the writeObjects data
virtual bool read(const dictionary&);
//- Return the list of fields required
virtual wordList fields() const
{
return wordList::null();
}
//- Do nothing
virtual bool execute();
//- Write the registered objects
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const writeObjects&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|