File size: 6,821 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2025-2026 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::cutLayerAverage
Description
This function object writes graphs of cell values, volume-averaged in
planes perpendicular to a given direction or in contours of a given
distance field. It adaptively grades the distribution of graph points to
match the resolution of the mesh.
Unlike the \c layerAverage function, this function does not require the
mesh to be of any specific structure. This function will cut cells that
span multiple layers in order to distribute their contributions between the
layers. The cutting process has an expense associated with it and the point
grading is calculated iteratively and is somewhat approximate.
Example of function object specification:
\verbatim
cutLayerAverage1
{
type cutLayerAverage;
libs ("libfieldFunctionObjects.so");
writeControl writeTime;
writeInterval 1;
direction (1 0 0);
nPoints 100;
interpolate no;
fields (p U);
axis x;
setFormat raw;
}
\endverbatim
Usage
\table
Property | Description | Required | Default value
type | type name: cutLayerAverage | yes |
cellZone | The name of the cell zone | yes |
direction | Axis along which to plot | if distance not specified |
distance | Distance field along which to plot \\
| if direction not specified |
nPoints | Number of points in the plot | yes |
interpolate | Do linear interpolation | no | false
fields | Fields to plot values of | yes |
axis | Component of the position to plot against | yes |
setFormat | Format of the output file | yes |
\endtable
See also
Foam::functionObjects::layerAverage
SourceFiles
cutLayerAverage.C
\*---------------------------------------------------------------------------*/
#ifndef cutLayerAverage_H
#define cutLayerAverage_H
#include "fvMeshFunctionObject.H"
#include "generatedCellZone.H"
#include "cutPlot.H"
#include "setWriter.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class polyPatch;
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class cutLayerAverage Declaration
\*---------------------------------------------------------------------------*/
class cutLayerAverage
:
public fvMeshFunctionObject
{
// Private Data
//- The set of cells to average
generatedCellZone zone_;
//- Direction along which to plot
vector direction_;
//- Name of the distance field along which to plot
word distanceName_;
//- Number of layers
label nLayers_;
//- Whether or not to interpolate
bool interpolate_;
//- Fields to plot
wordList fields_;
//- The direction over which to plot the results
coordSet::axisType axis_;
//- File writer
autoPtr<setWriter> formatter_;
//- Number of optimisation iterations. Default is 2.
label nOptimiseIter_;
//- Weights
autoPtr<List<cutPlot::weight>> weights_;
//- Layer distances. The distance of the layers' cut-planes to the
// origin, in the direction of the given vector. If interpolate is
// false, then the distance is taken to the middle of the layer.
autoPtr<scalarField> layerDistances_;
//- Layer thicknesses. If interpolate is false, then this is the
// thickness of the layer that the plot point represents.
autoPtr<scalarField> layerThicknesses_;
//- Layer positions. The average position of the layer.
autoPtr<pointField> layerPositions_;
// Private Member functions
//- Return the output path
fileName outputPath() const;
//- Calculate and set the weights member data
void calcWeights();
//- Clear the cached weights
void clear();
public:
//- Runtime type information
TypeName("cutLayerAverage");
// Constructors
//- Construct from Time and dictionary
cutLayerAverage
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- Destructor
virtual ~cutLayerAverage();
// Member Functions
//- Read the cutLayerAverage data
virtual bool read(const dictionary&);
//- Return the list of fields required
virtual wordList fields() const;
//- Execute, currently does nothing
virtual bool execute();
//- Write the cutLayerAverage
virtual bool write();
//- Update for mesh point-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&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|