patchPatchDist.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) 2011-2023 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 Class
25  Foam::patchPatchDist
26 
27 Description
28  Like wallDist but calculates on a patch the distance to nearest neighbouring
29  patches. Uses PatchEdgeFaceWave to do actual calculation.
30 
31 SourceFiles
32  patchPatchDist.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef patchPatchDist_H
37 #define patchPatchDist_H
38 
39 #include "scalarField.H"
40 #include "HashSet.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 //class polyMesh;
48 class polyPatch;
49 
50 /*---------------------------------------------------------------------------*\
51  Class patchPatchDist Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class patchPatchDist
55 :
56  public scalarField
57 {
58  // Private Member Data
59 
60  //- Patch to operate on
61  const polyPatch& patch_;
62 
63  //- Patches to determine the distance to
64  const labelHashSet nbrPatchIndices_;
65 
66  //- Number of unset faces.
67  label nUnset_;
68 
69 public:
70 
71  // Constructors
72 
73  //- Construct from patch and neighbour patches.
75  (
76  const polyPatch& pp,
77  const labelHashSet& nbrPatchIDs
78  );
79 
80 
81  //- Destructor
82  virtual ~patchPatchDist();
83 
84 
85  // Member Functions
86 
87  const scalarField& y() const
88  {
89  return *this;
90  }
91 
92  label nUnset() const
93  {
94  return nUnset_;
95  }
96 
97  //- Correct for mesh geom/topo changes
98  virtual void correct();
99 };
100 
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 } // End namespace Foam
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #endif
109 
110 // ************************************************************************* //
Like wallDist but calculates on a patch the distance to nearest neighbouring patches....
const scalarField & y() const
virtual void correct()
Correct for mesh geom/topo changes.
label nUnset() const
virtual ~patchPatchDist()
Destructor.
patchPatchDist(const polyPatch &pp, const labelHashSet &nbrPatchIDs)
Construct from patch and neighbour patches.
A patch is a list of labels that address the faces in the global face list.
Definition: polyPatch.H:70
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