cutPlot.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) 2022-2026 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 Namespace
25  Foam::cutPlot
26 
27 Description
28  Functions for cut-plotting
29 
30 SourceFiles
31  cutPlot.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef cutPlot_H
36 #define cutPlot_H
37 
38 #include "Field.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace cutPlot
45 {
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 //- Structure containing the weight for a given mesh element and cut index
50 struct weight
51 {
53  scalar value;
54 };
55 
56 //- Construct plot values from cell values given a set of weights
57 template<class Type>
59 (
60  const label n,
61  const List<cutPlot::weight>& weights,
62  const Field<Type>& cellValues
63 );
64 
65 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
66 
67 } // End namespace cutPlot
68 } // End namespace Foam
69 
70 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 
72 #ifdef NoRepository
73  #include "cutPlotTemplates.C"
74 #endif
75 
76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
77 
78 #endif
79 
80 // ************************************************************************* //
label n
Pre-declare SubField and related Field type.
Definition: Field.H:83
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: List.H:91
A class for managing temporary objects.
Definition: tmp.H:55
tmp< Field< Type > > applyWeights(const label n, const List< cutPlot::weight > &weights, const Field< Type > &cellValues)
Construct plot values from cell values given a set of weights.
Namespace for OpenFOAM.
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
Structure containing the weight for a given mesh element and cut index.
Definition: cutPlot.H:51