fieldMinMax.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::functionObjects::fieldMinMax
26 
27 Group
28  grpFieldFunctionObjects
29 
30 Description
31  This function object calculates the value and location of scalar minimim
32  and maximum for a list of user-specified fields. For variables with a rank
33  greater than zero, either the min/max of a component value or the magnitude
34  is reported. When operating in parallel, the processor owning the value
35  is also given.
36 
37  Example of function object specification:
38  \verbatim
39  fieldMinMax1
40  {
41  type fieldMinMax;
42  libs ("libfieldFunctionObjects.so");
43  ...
44  write yes;
45  log yes;
46  location yes;
47  mode magnitude;
48  fields
49  (
50  U
51  p
52  );
53  }
54  \endverbatim
55 
56 Usage
57  \table
58  Property | Description | Required | Default value
59  type | type name: fieldMinMax | yes |
60  write | write min/max data to file | no | yes
61  log | write min/max data to standard output | no | no
62  location | write location of the min/max value | no | yes
63  mode | calculation mode: magnitude or component | no | magnitude
64  \endtable
65 
66  Output data is written to the file <timeDir>/fieldMinMax.dat
67 
68 See also
69  Foam::functionObject
70  Foam::functionObjects::writeFiles
71 
72 SourceFiles
73  fieldMinMax.C
74 
75 \*---------------------------------------------------------------------------*/
76 
77 #ifndef functionObjects_fieldMinMax_H
78 #define functionObjects_fieldMinMax_H
79 
80 #include "writeFiles.H"
81 #include "vector.H"
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 namespace Foam
86 {
87 namespace functionObjects
88 {
89 
90 /*---------------------------------------------------------------------------*\
91  Class fieldMinMax Declaration
92 \*---------------------------------------------------------------------------*/
93 
94 class fieldMinMax
95 :
96  public writeFiles
97 {
98 public:
99 
100  enum modeType
101  {
102  mdMag,
103  mdCmpt
104  };
105 
106 protected:
107 
108  // Protected data
109 
110  //- Mode type names
111  static const NamedEnum<modeType, 2> modeTypeNames_;
112 
113  //- Switch to write location of min/max values
114  Switch location_;
115 
116  //- Mode for min/max - only applicable for ranks > 0
117  modeType mode_;
118 
119  //- Fields to assess min/max
121 
122 
123  // Private Member Functions
124 
125  //- Helper function to write the output
126  template<class Type>
127  void output
128  (
129  const word& fieldName,
130  const word& outputName,
131  const vector& minC,
132  const vector& maxC,
133  const label minProci,
134  const label maxProci,
135  const Type& minValue,
136  const Type& maxValue
137  );
138 
139  //- Disallow default bitwise copy construct
141 
142  //- Disallow default bitwise assignment
143  void operator=(const fieldMinMax&);
144 
145  //- Calculate the field min/max
146  template<class Type>
147  void calcMinMaxFields
148  (
149  const word& fieldName,
150  const modeType& mode
151  );
152 
153  //- Output file header information
154  virtual void writeFileHeader(const label i);
155 
156 
157 public:
158 
159  //- Runtime type information
160  TypeName("fieldMinMax");
161 
162 
163  // Constructors
164 
165  //- Construct from Time and dictionary
167  (
168  const word& name,
169  const Time& runTime,
170  const dictionary& dict
171  );
172 
173 
174  //- Destructor
175  virtual ~fieldMinMax();
176 
177 
178  // Member Functions
179 
180  //- Read the field min/max data
181  virtual bool read(const dictionary&);
182 
183  //- Execute, currently does nothing
184  virtual bool execute();
185 
186  //- Write the fieldMinMax
187  virtual bool write();
188 };
189 
190 
191 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
192 
193 } // End namespace functionObjects
194 } // End namespace Foam
195 
196 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
197 
198 #ifdef NoRepository
199  #include "fieldMinMaxTemplates.C"
200 #endif
201 
202 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
203 
204 #endif
205 
206 // ************************************************************************* //
virtual bool write()
Write the fieldMinMax.
Definition: fieldMinMax.C:149
dictionary dict
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
virtual bool execute()
Execute, currently does nothing.
Definition: fieldMinMax.C:143
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
fieldMinMax(const fieldMinMax &)
Disallow default bitwise copy construct.
scalar minValue
wordList fieldSet_
Fields to assess min/max.
Definition: fieldMinMax.H:149
virtual void writeFileHeader(const label i)
Output file header information.
Definition: fieldMinMax.C:57
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
void operator=(const fieldMinMax &)
Disallow default bitwise assignment.
void calcMinMaxFields(const word &fieldName, const modeType &mode)
Calculate the field min/max.
scalar maxValue
virtual bool read(const dictionary &)
Read the field min/max data.
Definition: fieldMinMax.C:130
const word & name() const
Return the name of this functionObject.
A class for handling words, derived from string.
Definition: word.H:59
virtual ~fieldMinMax()
Destructor.
Definition: fieldMinMax.C:124
Switch location_
Switch to write location of min/max values.
Definition: fieldMinMax.H:143
static const NamedEnum< modeType, 2 > modeTypeNames_
Mode type names.
Definition: fieldMinMax.H:140
List< word > wordList
A List of words.
Definition: fileName.H:54
modeType mode_
Mode for min/max - only applicable for ranks > 0.
Definition: fieldMinMax.H:146
This function object calculates the value and location of scalar minimim and maximum for a list of us...
Definition: fieldMinMax.H:123
void output(const word &fieldName, const word &outputName, const vector &minC, const vector &maxC, const label minProci, const label maxProci, const Type &minValue, const Type &maxValue)
Helper function to write the output.
mode_t mode(const fileName &)
Return the file mode.
Definition: POSIX.C:447
TypeName("fieldMinMax")
Runtime type information.
Namespace for OpenFOAM.