File size: 5,440 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-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::histogram
Description
Write the volume-weighted histogram of a volScalarField.
Example:
\verbatim
histogram1
{
type histogram;
libs ("libfieldFunctionObjects.so");
field p;
cellZone all;
nBins 100;
min -5;
max 5;
setFormat gnuplot;
}
\endverbatim
Usage
\table
Property | Description | Required | Default value
type | type name: histogram | yes |
field | Field to analyse | yes |
cellZone | cellZone | yes |
nBins | Number of bins for the histogram | yes|
max | Maximum value sampled | yes |
min | minimum value sampled | no | 0
setFormat | Output format | 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
See also
Foam::functionObject
Foam::functionObjects::fvMeshFunctionObject
Foam::functionObjects::writeFile
SourceFiles
histogram.C
\*---------------------------------------------------------------------------*/
#ifndef histogram_functionObject_H
#define histogram_functionObject_H
#include "fvMeshFunctionObject.H"
#include "generatedCellZone.H"
#include "writeFile.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class setWriter;
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class histogram Declaration
\*---------------------------------------------------------------------------*/
class histogram
:
public fvMeshFunctionObject
{
// Private Data
//- The cellZone to operate on
generatedCellZone zone_;
writeFile file_;
//- Name of field
word fieldName_;
//- Maximum value
scalar max_;
//- Minimum value
scalar min_;
//- Number of bins
label nBins_;
//- Output formatter to write
autoPtr<setWriter> formatterPtr_;
public:
//- Runtime type information
TypeName("histogram");
// Constructors
//- Construct from Time and dictionary
histogram
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- Disallow default bitwise copy construction
histogram(const histogram&) = delete;
// Destructor
virtual ~histogram();
// Member Functions
//- Read the histogram data
virtual bool read(const dictionary&);
//- Return the list of fields required
virtual wordList fields() const;
//- Execute, currently does nothing
virtual bool execute();
//- Calculate the histogram and write.
// foamPostProcess overrides the usual writeControl behaviour and
// forces writing always (used in post-processing mode)
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&);
// Member Operators
//- Disallow default bitwise assignment
void operator=(const histogram&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|