surfaceToPoint.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) 2011-2015 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::surfaceToPoint
26 
27 Description
28  A topoSetSource to selects points based on relation to surface.
29 
30  Select based on:
31  - distance to surface
32  - inside/outside status to surface
33  (Uses normal of nearest surface triangle so requires valid surface
34  topology!)
35 
36 SourceFiles
37  surfaceToPoint.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef surfaceToPoint_H
42 #define surfaceToPoint_H
43 
44 #include "topoSetSource.H"
45 #include "Map.H"
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 class triSurfaceSearch;
52 
53 /*---------------------------------------------------------------------------*\
54  Class surfaceToPoint Declaration
55 \*---------------------------------------------------------------------------*/
56 
57 class surfaceToPoint
58 :
59  public topoSetSource
60 {
61 
62  // Private data
63 
64  //- Add usage string
65  static addToUsageTable usage_;
66 
67  //- Name of surface file
68  fileName surfName_;
69 
70  //- If > 0 : include points with distance to surface less than nearDist.
71  scalar nearDist_;
72 
73  //- Include all points on opposite sign of normal on nearest surface.
74  bool includeInside_;
75 
76  //- Include all points on this sign of normal on nearest surface.
77  bool includeOutside_;
78 
79 
80  // Private Member Functions
81 
82  //- Depending on surface add to or delete from pointSet.
83  void combine(topoSet& set, const bool add) const;
84 
85  //- Check settings at construction time.
86  void checkSettings() const;
87 
88 public:
89 
90  //- Runtime type information
91  TypeName("surfaceToPoint");
92 
93  // Constructors
94 
95  //- Construct from components
97  (
98  const polyMesh& mesh,
99  const fileName& surfName,
100  const scalar nearDist,
101  const bool includeInside,
102  const bool includeOutside
103  );
104 
105  //- Construct from dictionary
107  (
108  const polyMesh& mesh,
109  const dictionary& dict
110  );
111 
112  //- Construct from Istream
114  (
115  const polyMesh& mesh,
116  Istream&
117  );
118 
119 
120  //- Destructor
121  virtual ~surfaceToPoint();
122 
123 
124  // Member Functions
126  virtual sourceType setType() const
127  {
128  return POINTSETSOURCE;
129  }
130 
131  virtual void applyToSet
132  (
133  const topoSetSource::setAction action,
134  topoSet&
135  ) const;
136 
137 };
138 
139 
140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
141 
142 } // End namespace Foam
143 
144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
145 
146 #endif
147 
148 // ************************************************************************* //
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
surfaceToPoint(const polyMesh &mesh, const fileName &surfName, const scalar nearDist, const bool includeInside, const bool includeOutside)
Construct from components.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
virtual ~surfaceToPoint()
Destructor.
Namespace for OpenFOAM.
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:70
virtual sourceType setType() const
dictionary dict
Combine operator for AMIInterpolation.
Definition: FaceCellWave.C:54
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:82
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
const polyMesh & mesh() const
A class for handling file names.
Definition: fileName.H:69
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
Class with constructor to add usage string to table.
A topoSetSource to selects points based on relation to surface.
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
TypeName("surfaceToPoint")
Runtime type information.