Newer
Older
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
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | www.openfoam.com
\\/ M anipulation |
-------------------------------------------------------------------------------
Copyright (C) 2021 OpenCFD Ltd.
-------------------------------------------------------------------------------
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::multiRegion
Group
grpUtilitiesFunctionObjects
Description
Wrapper that clones the supplied function object for each region.
Simplifies the setup of identical post-processing requirements for
multi-region cases.
Applies the supplied function to all regions by default.
Usage
Minimal example by using \c system/controlDict.functions:
\verbatim
multiRegion
{
// Mandatory entries
type multiRegion;
libs (utilityFunctionObjects);
function
{
// Actual object specification
type fieldMinMax;
libs (fieldFunctionObjects);
fields (<field1> ... <fieldN>);
}
// Optional entries
regions (region1 region2);
}
\endverbatim
where the entries mean:
\table
Property | Description | Type | Reqd | Deflt
type | Type name: multiRegion | word | yes | -
libs | Library name: utilityFunctionObjects | word | yes | -
function | Function object sub-dictionary | dict | yes | -
regions | List of region names | wordList | no | all
\endtable
See also
- Foam::functionObject
SourceFiles
multiRegion.C
\*---------------------------------------------------------------------------*/
#ifndef functionObjects_multiRegion_H
#define functionObjects_multiRegion_H
#include "timeFunctionObject.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class multiRegion Declaration
\*---------------------------------------------------------------------------*/
class multiRegion
:
public functionObjects::timeFunctionObject
{
protected:
// Protected Data
//- List of cloned objects (1 per region)
PtrList<functionObject> functions_;
// Protected Member Functions
//- No copy construct
multiRegion(const multiRegion&) = delete;
//- No copy assignment
void operator=(const multiRegion&) = delete;
public:
//- Runtime type information
TypeName("multiRegion");
// Constructors
//- Construct from Time and dictionary
multiRegion
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- Destructor
virtual ~multiRegion() = default;
// Member Functions
//- Read the controls
virtual bool read(const dictionary& dict);
//- Execute, currently does nothing
virtual bool execute();
//- Write the multiRegion
virtual bool write();
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //