fieldMinMax.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 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 Description
28  Calculates the value and location of scalar minimum and maximum for a list
29  of user-specified fields.
30 
31  For variables with a rank greater than zero, either the min/max of a
32  component value or the magnitude is reported. When operating in parallel,
33  the processor owning the value is also given.
34 
35  Example of function object specification:
36  \verbatim
37  fieldMinMax1
38  {
39  type fieldMinMax;
40  libs ("libfieldFunctionObjects.so");
41  ...
42  write yes;
43  log yes;
44  location yes;
45  mode magnitude;
46  fields
47  (
48  U
49  p
50  );
51  }
52  \endverbatim
53 
54 Usage
55  \table
56  Property | Description | Required | Default value
57  type | type name: fieldMinMax | yes |
58  write | write min/max data to file | no | yes
59  log | write min/max data to standard output | no | no
60  location | write location of the min/max value | no | yes
61  mode | calculation mode: magnitude or component | no | magnitude
62  \endtable
63 
64  Output data is written to the file <timeDir>/fieldMinMax.dat
65 
66 See also
67  Foam::functionObjects::fvMeshFunctionObject
68  Foam::functionObjects::logFiles
69 
70 SourceFiles
71  fieldMinMax.C
72 
73 \*---------------------------------------------------------------------------*/
74 
75 #ifndef functionObjects_fieldMinMax_H
76 #define functionObjects_fieldMinMax_H
77 
78 #include "fvMeshFunctionObject.H"
79 #include "logFiles.H"
80 #include "vector.H"
81 
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83 
84 namespace Foam
85 {
86 namespace functionObjects
87 {
88 
89 /*---------------------------------------------------------------------------*\
90  Class fieldMinMax Declaration
91 \*---------------------------------------------------------------------------*/
92 
93 class fieldMinMax
94 :
95  public fvMeshFunctionObject,
96  public logFiles
97 {
98 public:
99 
100  enum class modeType
101  {
102  mag,
103  cmpt
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 
123  // Protected 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 label minCell,
132  const label maxCell,
133  const vector& minC,
134  const vector& maxC,
135  const label minProci,
136  const label maxProci,
137  const Type& minValue,
138  const Type& maxValue
139  );
141  //- Calculate the field min/max
142  template<class Type>
144  (
145  const word& fieldName,
146  const modeType& mode
147  );
148 
149  //- Output file header information
150  virtual void writeFileHeader(const label i);
151 
152 
153 public:
154 
155  //- Runtime type information
156  TypeName("fieldMinMax");
157 
158 
159  // Constructors
160 
161  //- Construct from Time and dictionary
163  (
164  const word& name,
165  const Time& runTime,
166  const dictionary& dict
167  );
168 
169  //- Disallow default bitwise copy construction
170  fieldMinMax(const fieldMinMax&) = delete;
171 
172 
173  //- Destructor
174  virtual ~fieldMinMax();
175 
176 
177  // Member Functions
178 
179  //- Read the field min/max data
180  virtual bool read(const dictionary&);
181 
182  //- Execute, currently does nothing
183  virtual bool execute();
184 
185  //- Write the fieldMinMax
186  virtual bool write();
187 
188 
189  // Member Operators
190 
191  //- Disallow default bitwise assignment
192  void operator=(const fieldMinMax&) = delete;
193 };
194 
195 
196 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
197 
198 } // End namespace functionObjects
199 } // End namespace Foam
200 
201 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
202 
203 #ifdef NoRepository
204  #include "fieldMinMaxTemplates.C"
205 #endif
206 
207 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
208 
209 #endif
210 
211 // ************************************************************************* //
virtual bool write()
Write the fieldMinMax.
Definition: fieldMinMax.C:144
dictionary dict
mode_t mode(const fileName &, const bool checkVariants=true, const bool followLink=true)
Return the file mode.
Definition: POSIX.C:461
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:138
const word & name() const
Return the name of this functionObject.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
scalar minValue
engineTime & runTime
fieldMinMax(const word &name, const Time &runTime, const dictionary &dict)
Construct from Time and dictionary.
Definition: fieldMinMax.C:100
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 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:125
A class for handling words, derived from string.
Definition: word.H:59
void operator=(const fieldMinMax &)=delete
Disallow default bitwise assignment.
virtual ~fieldMinMax()
Destructor.
Definition: fieldMinMax.C:119
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
void output(const word &fieldName, const word &outputName, const label minCell, const label maxCell, const vector &minC, const vector &maxC, const label minProci, const label maxProci, const Type &minValue, const Type &maxValue)
Helper function to write the output.
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
Calculates the value and location of scalar minimum and maximum for a list of user-specified fields...
Definition: fieldMinMax.H:122
TypeName("fieldMinMax")
Runtime type information.
Namespace for OpenFOAM.