nearestToPoint.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::nearestToPoint
26 
27 Description
28  A topoSetSource to select points nearest to points.
29 
30 SourceFiles
31  nearestToPoint.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef nearestToPoint_H
36 #define nearestToPoint_H
37 
38 #include "topoSetSource.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class nearestToPoint Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class nearestToPoint
50 :
51  public topoSetSource
52 {
53 
54  // Private data
55 
56  //- Add usage string
57  static addToUsageTable usage_;
58 
59  //- Points to select nearest to
60  pointField points_;
61 
62 
63  // Private Member Functions
64 
65  void combine(topoSet& set, const bool add) const;
66 
67 
68 public:
69 
70  //- Runtime type information
71  TypeName("nearestToPoint");
72 
73  // Constructors
74 
75  //- Construct from components
77  (
78  const polyMesh& mesh,
79  const pointField& points
80  );
81 
82  //- Construct from dictionary
84  (
85  const polyMesh& mesh,
86  const dictionary& dict
87  );
88 
89  //- Construct from Istream
91  (
92  const polyMesh& mesh,
93  Istream&
94  );
95 
96 
97  //- Destructor
98  virtual ~nearestToPoint();
99 
100 
101  // Member Functions
103  virtual sourceType setType() const
104  {
105  return POINTSETSOURCE;
106  }
107 
108  virtual void applyToSet
109  (
110  const topoSetSource::setAction action,
111  topoSet&
112  ) const;
113 
114 };
115 
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 } // End namespace Foam
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #endif
124 
125 // ************************************************************************* //
TypeName("nearestToPoint")
Runtime type information.
const pointField & points
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
A topoSetSource to select points nearest to points.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:70
dictionary dict
nearestToPoint(const polyMesh &mesh, const pointField &points)
Construct from components.
Combine operator for AMIInterpolation.
Definition: FaceCellWave.C:54
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:82
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
const polyMesh & mesh() const
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
virtual sourceType setType() const
virtual ~nearestToPoint()
Destructor.
Class with constructor to add usage string to table.
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)