pointPatchDist.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2013 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::pointPatchDist
26 
27 Description
28  Calculation of distance to nearest patch for all points
29 
30 SourceFiles
31  pointPatchDist.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef pointPatchDist_H
36 #define pointPatchDist_H
37 
38 #include "pointFields.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 class pointMesh;
46 
47 /*---------------------------------------------------------------------------*\
48  Class pointPatchDist Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class pointPatchDist
52 :
53  public pointScalarField
54 {
55 
56 private:
57 
58  // Private Member Data
59 
60  //- Reference to pointField
61  const pointField& points_;
62 
63  //- Set of patch IDs
64  const labelHashSet patchIDs_;
65 
66  //- Number of unset points
67  label nUnset_;
68 
69 
70  // Private Member Functions
71 
72  //- Disallow default bitwise copy construct
74 
75  //- Disallow default bitwise assignment
76  void operator=(const pointPatchDist&);
77 
78 
79 public:
80 
81  // Constructors
82 
83  //- Construct from mesh and set of patches
85  (
86  const pointMesh& pMesh,
87  const labelHashSet& patchIDs,
88  const pointField& points
89  );
90 
91 
92  //- Destructor
93  virtual ~pointPatchDist();
94 
95 
96  // Member Functions
97 
98  const pointScalarField& y() const
99  {
100  return *this;
101  }
102 
103  label nUnset() const
104  {
105  return nUnset_;
106  }
107 
108  //- Correct for mesh geom/topo changes
109  void correct();
110 };
111 
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 } // End namespace Foam
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #endif
120 
121 // ************************************************************************* //
Foam::pointPatchDist::y
const pointScalarField & y() const
Definition: pointPatchDist.H:97
Foam::pointPatchDist::correct
void correct()
Correct for mesh geom/topo changes.
Definition: pointPatchDist.C:67
Foam::pointPatchDist::nUnset_
label nUnset_
Number of unset points.
Definition: pointPatchDist.H:66
Foam::HashSet< label, Hash< label > >
Foam::pointPatchDist::nUnset
label nUnset() const
Definition: pointPatchDist.H:102
Foam::label
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
Foam::Field
Pre-declare SubField and related Field type.
Definition: Field.H:57
Foam::pointPatchDist::operator=
void operator=(const pointPatchDist &)
Disallow default bitwise assignment.
Foam::pointPatchDist::pointPatchDist
pointPatchDist(const pointPatchDist &)
Disallow default bitwise copy construct.
Foam::pointPatchDist::~pointPatchDist
virtual ~pointPatchDist()
Destructor.
Definition: pointPatchDist.C:61
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::pointMesh
Mesh representing a set of points created from polyMesh.
Definition: pointMesh.H:48
Foam::pointPatchDist::points_
const pointField & points_
Reference to pointField.
Definition: pointPatchDist.H:60
Foam::pointPatchDist
Calculation of distance to nearest patch for all points.
Definition: pointPatchDist.H:50
Foam::pointPatchDist::patchIDs_
const labelHashSet patchIDs_
Set of patch IDs.
Definition: pointPatchDist.H:63
points
const pointField & points
Definition: gmvOutputHeader.H:1
Foam::GeometricField
Generic GeometricField class.
Definition: surfaceFieldsFwd.H:52
pointFields.H