Newer
Older
Henry Weller
committed
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
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 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::functionObjects::writeLocalObjects
Description
FunctionObject base class for managing a list of objects on behalf of the
inheriting function object, on when those should be written to disk.
FunctionObjects that inherit this class will receive the additional
dictionary option \c objects which allows selecting which fields of the
inherited function should be written to disk when \c write() is called.
When \c objects is omitted, it will write all objects and when that list is
empty, it will not write any of the inheriting function object's managed
objects.
Example of function object specification:
\verbatim
<functionObjectName>
{
...
objects (obj1 obj2);
...
}
\endverbatim
Usage
\table
Property | Description | Required | Default value
objects | List of objects to be written | no | ".*"
\endtable
Note: Regular expressions can also be used in \c objects.
See also
Foam::functionObject
Foam::functionObjects::writeObjectsBase
SourceFiles
writeLocalObjects.C
\*---------------------------------------------------------------------------*/
#ifndef functionObjects_writeLocalObjects_H
#define functionObjects_writeLocalObjects_H
#include "wordList.H"
#include "writeObjectsBase.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class objectRegistry;
class regIOobject;
class Switch;
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class writeLocalObjects Declaration
\*---------------------------------------------------------------------------*/
class writeLocalObjects
:
public writeObjectsBase
{
protected:
// Protected data
//- Object names that are handled on behalf of the inheritor
wordList localObjectNames_;
// Protected Member Functions
//- Reset the list of local object names from a single word
void resetLocalObjectName(const word& name);
//- Reset the list of local object names from a wordList
void resetLocalObjectNames(const wordList& names);
//- Get the list of field names to be written
virtual wordList objectNames();
private:
// Private Member Functions
//- Disallow default bitwise copy construct
writeLocalObjects(const writeLocalObjects&);
//- Disallow default bitwise assignment
void operator=(const writeLocalObjects&);
public:
// Constructors
//- Construct from objectRegistry and inheriting function object
writeLocalObjects
(
const objectRegistry& obr,
const Switch& logRef
);
//- Destructor
virtual ~writeLocalObjects();
// Member Functions
//- Return const access to the local object names
const wordList& localObjectNames() const;
//- Read the list of objects to be written
virtual bool read(const dictionary&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //