File size: 11,314 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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::fieldValues::volFieldValue
Description
Provides a 'fvCellZone' specialisation of the fieldValue function object.
Given a list of user-specified fields and a 'fvCellZone', a number of
operations can be performed, such as sums, averages and integrations.
Example of function object specification:
\verbatim
volFieldValue1
{
type volFieldValue;
libs ("libfieldFunctionObjects.so");
log true;
writeControl writeTime;
writeFields true;
cellZone c0;
operation volAverage;
weightField alpha1;
fields
(
p
U
);
}
\endverbatim
Usage
\table
Property | Description | Required | Default value
type | Type name: volFieldValue | yes |
log | Write data to standard output | no | no
writeFields | Write the region field values | yes |
writeNumberOfCells | Write the number of cells in the zone | no | no
writeVolume | Write the volume of the zone | no | no
writeLocation| Write the location (if available) | no | no
cellZone | cellZone | yes |
operation | Operation to perform | yes |
weightField | Name of field to apply weighting | no | none
weightFields | Names of fields to apply weighting | no | none
fields | List of fields to operate on | yes |
\endtable
Where \c cellZone options are:
\plaintable
cellZone \<name\> | Looks-up the named cellZone
cellZone {type \<zoneGeneratorType\>;...} | \\
Generates the cellZone locally
cellZone all | Selects all cells
\endplaintable
The \c operation is one of:
\plaintable
none | No operation
sum | Sum
sumMag | Sum of component magnitudes
average | Ensemble average
volAverage | Volume weighted average
volIntegrate | Volume integral
min | Minimum
max | Maximum
minMag | Minimum magnitude
maxMag | Maximum magnitude
CoV | Coefficient of variation: (standard deviation)/mean
UI | Uniformity index: ???
\endplaintable
See also
Foam::functionObjects::fieldValues::fieldValue
Foam::Foam::fvCellZone
Foam::functionObject
SourceFiles
volFieldValue.C
\*---------------------------------------------------------------------------*/
#ifndef volFieldValue_functionObject_H
#define volFieldValue_functionObject_H
#include "fieldValue.H"
#include "fvCellZone.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
namespace fieldValues
{
/*---------------------------------------------------------------------------*\
Class volFieldValue Declaration
\*---------------------------------------------------------------------------*/
class volFieldValue
:
public fieldValue
{
public:
// Public data types
//- Operation type enumeration
enum class operationType
{
none,
sum,
sumMag,
average,
volAverage,
volIntegrate,
min,
max,
minMag,
maxMag,
CoV,
UI
};
//- Operation type names
static const NamedEnum<operationType, 12> operationTypeNames_;
// Public classes
//- Forward declare the result structure
template<class Type>
struct Result;
protected:
// Protected data
//- The cellZone to operate on
fvCellZone zone_;
//- Operation to apply to values
operationType operation_;
//- Weight field names
wordList weightFieldNames_;
//- Scale factor
scalar scaleFactor_;
//- Optionally write the number of faces in the surface
const bool writeNCells_;
//- Optionally write the area of the surface
const bool writeVolume_;
//- Optionally write the location if available for this operation
const bool writeLocation_;
// Protected Member Functions
//- Return true if the field name is valid
template<class Type>
bool validField(const word& fieldName) const;
//- Insert field values into values list
template<class Type>
tmp<Field<Type>> getFieldValues(const word& fieldName) const;
//- Apply a comparison operation to the values, returning the limiting
// value, its index and processor index
template<class Op>
void compareScalars
(
const scalarField& values,
const scalar emptyVal,
Result<scalar>& result,
const Op& op
) const;
//- Apply the operation to the values, and return true if successful.
// Does nothing unless overloaded below.
template<class Type, class ResultType>
bool processValues
(
const Field<Type>& values,
const scalarField& weights,
const scalarField& V,
Result<ResultType>& result
) const;
//- Apply Type -> Type operation to the values. Calls
// processValuesTypeType.
template<class Type>
bool processValues
(
const Field<Type>& values,
const scalarField& weights,
const scalarField& V,
Result<Type>& result
) const;
//- Apply Type -> scalar operation to the values
template<class Type>
bool processValues
(
const Field<Type>& values,
const scalarField& weights,
const scalarField& V,
Result<scalar>& result
) const;
//- Apply scalar -> scalar operation to the values. Calls
// processValuesTypeType.
bool processValues
(
const Field<scalar>& values,
const scalarField& weights,
const scalarField& V,
Result<scalar>& result
) const;
//- Apply a Type -> Type operation to the values
template<class Type>
bool processValuesTypeType
(
const Field<Type>& values,
const scalarField& weights,
const scalarField& V,
Result<Type>& result
) const;
//- Output file header location information for a given type
template<class Type>
void writeFileHeaderLocation();
//- Output file header information
virtual void writeFileHeader(const label i);
public:
//- Run-time type information
TypeName("volFieldValue");
// Constructors
//- Construct from name, Time and dictionary
volFieldValue
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- Construct from name, objectRegistry and dictionary
volFieldValue
(
const word& name,
const objectRegistry& obr,
const dictionary& dict
);
//- Destructor
virtual ~volFieldValue();
// Public Member Functions
//- Templated helper function to output field values
template<class Type>
bool writeValues
(
const word& fieldName,
const scalarField& weights,
const scalarField& V
);
//- Templated helper function to output field values
template<class Type, class ResultType>
bool writeValues
(
const word& fieldName,
const Field<Type>& values,
const scalarField& weights,
const scalarField& V
);
//- Filter a field according to cellIds
template<class Type>
tmp<Field<Type>> filterField(const Field<Type>& field) const;
//- Read from dictionary
virtual bool read(const dictionary&);
//- Calculate and write
virtual bool write();
// Mesh changes
//- Update for mesh motion
virtual void movePoints(const polyMesh&);
//- Update topology using the given map
virtual void topoChange(const polyTopoChangeMap&);
//- Update from another mesh using the given map
virtual void mapMesh(const polyMeshMap&);
//- Redistribute or update using the given distribution map
virtual void distribute(const polyDistributionMap&);
};
template<>
void volFieldValue::writeFileHeaderLocation<scalar>();
/*---------------------------------------------------------------------------*\
Class volFieldValue::Result Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
struct volFieldValue::Result
{
Type value;
label celli;
label proci;
point cc;
};
template<class Type>
inline Istream& operator>>
(
Istream& is,
volFieldValue::Result<Type>& result
)
{
return is >> result.value >> result.celli >> result.proci >> result.cc;
}
template<class Type>
inline Ostream& operator<<
(
Ostream& os,
const volFieldValue::Result<Type>& result
)
{
return os << result.value << result.celli << result.proci << result.cc;
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace fieldValues
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "volFieldValueTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|