triSurfaceMeshPointSet.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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2012 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::triSurfaceMeshPointSet
28
29Description
30 A sampleSet from all points of a triSurfaceMesh.
31
32 For a dictionary specification:
33 \table
34 Property | Description | Required | Default
35 type | triSurfaceMeshPointSet | yes |
36 axis | x, y, z, xyz, distance | yes |
37 surface | The surface name | yes |
38 \endtable
39
40SourceFiles
41 triSurfaceMeshPointSet.C
42
43\*---------------------------------------------------------------------------*/
44
45#ifndef triSurfaceMeshPointSet_H
46#define triSurfaceMeshPointSet_H
47
48#include "sampledSet.H"
49
50// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
51
52namespace Foam
53{
54
55/*---------------------------------------------------------------------------*\
56 Class triSurfaceMeshPointSet Declaration
57\*---------------------------------------------------------------------------*/
58
59class triSurfaceMeshPointSet
60:
61 public sampledSet
62{
63 // Private Data
64
65 //- The surface name
66 const word surfaceName_;
67
68 //- Sampling points
69 List<point> sampleCoords_;
70
71
72 // Private Member Functions
73
74 //- Samples all points in sampleCoords.
75 void calcSamples
76 (
77 DynamicList<point>& samplingPts,
78 DynamicList<label>& samplingCells,
79 DynamicList<label>& samplingFaces,
80 DynamicList<label>& samplingSegments,
81 DynamicList<scalar>& samplingCurveDist
82 ) const;
83
84 //- Uses calcSamples to obtain samples. Copies them into *this.
85 void genSamples();
86
87
88public:
89
90 //- Runtime type information
91 TypeName("triSurfaceMeshPointSet");
92
93
94 // Constructors
95
96 //- Construct from dictionary
98 (
99 const word& name,
100 const polyMesh& mesh,
102 const dictionary& dict
103 );
104
105
106 //- Destructor
107 virtual ~triSurfaceMeshPointSet() = default;
108
109
110 // Member Functions
111
112 //- Get reference point
113 virtual point getRefPoint(const List<point>& pts) const;
114};
115
116
117// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118
119} // End namespace Foam
120
121// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122
123#endif
124
125// ************************************************************************* //
A 1D vector of objects of type <T> that resizes itself as necessary to accept the new objects.
Definition: DynamicList.H:72
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: List.H:77
const word & name() const noexcept
The coord-set name.
Definition: coordSet.H:134
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Various (local, not parallel) searches on polyMesh; uses (demand driven) octree to search.
Definition: meshSearch.H:61
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:81
Holds list of sampling points which is filled at construction time. Various implementations of this b...
Definition: sampledSet.H:86
const meshSearch & searchEngine() const noexcept
Definition: sampledSet.H:324
const polyMesh & mesh() const noexcept
Definition: sampledSet.H:319
A sampleSet from all points of a triSurfaceMesh.
virtual point getRefPoint(const List< point > &pts) const
Get reference point.
TypeName("triSurfaceMeshPointSet")
Runtime type information.
virtual ~triSurfaceMeshPointSet()=default
Destructor.
A class for handling words, derived from Foam::string.
Definition: word.H:68
Namespace for OpenFOAM.
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73