| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / 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::layerAverage | |
| Description | |
| This function object writes graphs of cell values, volume-averaged in | |
| the layers of cells in the mesh. | |
| The layers are defined by a set of patches or zones. Between these patches | |
| and/or zones the mesh must be perfectly layered; i.e., every cell must be a | |
| prism for which the base polygon is topologically similar to the | |
| corresponding face on the patch or zone. If the mesh is not layered in this | |
| way, then consider using the \c cutLayerAverage function instead. | |
| Patches can be used to define the start of the layers and hence the | |
| beginning of the graph. E.g.: | |
| \verbatim | |
| Patch | |
| <--|| 1 | 2 | 3 | ... | |
| ||---------+---------+---------+---- | |
| <--|| 1 | 2 | 3 | ... | |
| ||---------+---------+---------+---- | |
| <--|| 1 | 2 | 3 | ... | |
| \endverbatim | |
| Zones can define either the start or the end of the layers, depending on | |
| the zones' orientations. Layers will be enumerated in the same way as for a | |
| patch; i.e., they will number outwards in a direction opposite to the | |
| zone's normal direction. If two zones (or a zone and a patch) overlap then | |
| the one in front (relative to the zones' orientations) defines the start of | |
| the layers and the one behind defines the end of the layers. If two zones | |
| overlap and have opposing orientations then an error will be generated. | |
| \verbatim | |
| Zone A Zone B | |
| ... | <--|| 1 | 2 | 3 <--|| | ... | |
| ----+-------||---------+---------+---------||-------+---- | |
| ... | <--|| 1 | 2 | 3 <--|| | ... | |
| ----+-------||---------+---------+---------||-------+---- | |
| ... | <--|| 1 | 2 | 3 <--|| | ... | |
| \endverbatim | |
| Example of function object specification: | |
| \verbatim | |
| layerAverage1 | |
| { | |
| type layerAverage; | |
| libs ("libfieldFunctionObjects.so"); | |
| writeControl writeTime; | |
| setFormat raw; | |
| patches (bottom); | |
| zones (quarterPlane threeQuartersPlane); | |
| axis y; | |
| symmetric true; | |
| fields (pMean pPrime2Mean UMean UPrime2Mean k); | |
| } | |
| \endverbatim | |
| Usage | |
| \table | |
| Property | Description | Required | Default value | |
| type | Type name: layerAverage | yes | | |
| setFormat | Output plotting format | yes | | |
| patch | Patch that layers extrude from | no | | |
| patches | Patches that layers extrude from | no | () | |
| zones | Face zones that the layers extrude from | no | () | |
| axis | Component of the position to plot against | yes | | |
| symmetric | Is the geometry symmetric around the centre layer? \\ | |
| | no | false | |
| fields | Fields to average and plot | yes | | |
| weightField | Field with which to weight the average | no | none | |
| weightFields | Fields with which to weight the average | no | () | |
| \endtable | |
| See also | |
| Foam::functionObjects::cutLayerAverage | |
| SourceFiles | |
| layerAverage.C | |
| layerAverageTemplates.C | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| namespace functionObjects | |
| { | |
| /*---------------------------------------------------------------------------*\ | |
| Class layerAverage Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| class layerAverage | |
| : | |
| public fvMeshFunctionObject | |
| { | |
| // Private Data | |
| //- Patches which form the start of the layers | |
| labelList patchIndices_; | |
| //- Zones which form the start of the layers | |
| labelList zoneIndices_; | |
| //- Is the case symmetric? | |
| bool symmetric_; | |
| //- The direction over which to plot the results | |
| coordSet::axisType axis_; | |
| //- Per cell the global layer | |
| label nLayers_; | |
| //- Per cell the global layer | |
| labelList cellLayer_; | |
| //- Per global layer the volume | |
| scalarField layerVolume_; | |
| //- The average centre of each layer | |
| pointField layerCentre_; | |
| //- Fields to average | |
| wordList fields_; | |
| //- Fields with which to weight the averages | |
| wordList weightFields_; | |
| //- Set formatter | |
| autoPtr<setWriter> formatter_; | |
| // Private Member Functions | |
| //- Create the layer information, the sort map, and the scalar axis | |
| void calcLayers(); | |
| //- Calculate and return the weight field, or a null pointer if there | |
| // are no weight fields | |
| tmp<VolInternalField<scalar>> weight() const; | |
| //- Return the coefficient to multiply onto symmetric values | |
| template<class T> | |
| T symmetricCoeff() const; | |
| //- Sum field per layer | |
| template<class T> | |
| tmp<Field<T>> sum(const VolInternalField<T>& cellField) const; | |
| //- Average a field per layer | |
| template<class T> | |
| tmp<Field<T>> average | |
| ( | |
| const tmp<VolInternalField<scalar>>& cellWeight, | |
| const tmp<Field<scalar>>& layerWeight, | |
| const VolInternalField<T>& cellField | |
| ) const; | |
| public: | |
| //- Runtime type information | |
| TypeName("layerAverage"); | |
| // Constructors | |
| //- Construct from Time and dictionary | |
| layerAverage | |
| ( | |
| const word& name, | |
| const Time& runTime, | |
| const dictionary& dict | |
| ); | |
| //- Disallow default bitwise copy construction | |
| layerAverage(const layerAverage&) = delete; | |
| //- Destructor | |
| virtual ~layerAverage(); | |
| // Member Functions | |
| //- Read the field average data | |
| virtual bool read(const dictionary&); | |
| //- Return the list of fields required | |
| virtual wordList fields() const; | |
| //- Do nothing | |
| virtual bool execute(); | |
| //- Calculate and write the graphs | |
| 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&); | |
| // Member Operators | |
| //- Disallow default bitwise assignment | |
| void operator=(const layerAverage&) = delete; | |
| }; | |
| template<> | |
| vector layerAverage::symmetricCoeff<vector>() const; | |
| template<> | |
| symmTensor layerAverage::symmetricCoeff<symmTensor>() const; | |
| template<> | |
| tensor layerAverage::symmetricCoeff<tensor>() const; | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace functionObjects | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |