All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
boundaryRandom.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-2020 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::sampledSets::boundaryRandom
26 
27 Description
28  Random samples within patches
29 
30 Usage
31  \table
32  Property | Description | Req'd? | Default
33  patches | The patches on which to sample | yes |
34  nPoints | The number of points | yes |
35  axis | The coordinate axis that is written | yes |
36  \endtable
37 
38  Example specification:
39  \verbatim
40  {
41  type boundaryRandom;
42  patches (inlet1 inlet2);
43  nPoints 1000;
44  axis x;
45  }
46  \endverbatim
47 
48 SourceFiles
49  boundaryRandom.C
50 
51 \*---------------------------------------------------------------------------*/
52 
53 #ifndef boundaryRandom_H
54 #define boundaryRandom_H
55 
56 #include "sampledSet.H"
57 #include "DynamicList.H"
58 #include "HashSet.H"
59 
60 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
61 
62 namespace Foam
63 {
64 namespace sampledSets
65 {
66 
67 /*---------------------------------------------------------------------------*\
68  Class boundaryRandom Declaration
69 \*---------------------------------------------------------------------------*/
70 
71 class boundaryRandom
72 :
73  public sampledSet
74 {
75  // Private Data
76 
77  //- Patches to sample
78  const wordReList patches_;
79 
80  //- Number of points
81  const label nPoints_;
82 
83 
84  // Private Member Functions
85 
86  //- Sample all points
87  void calcSamples
88  (
89  DynamicList<point>& samplingPts,
90  DynamicList<label>& samplingCells,
91  DynamicList<label>& samplingFaces,
92  DynamicList<label>& samplingSegments,
93  DynamicList<scalar>& samplingCurveDist
94  ) const;
95 
96  //- Use calcSamples to obtain samples and copy them into *this
97  void genSamples();
98 
99 
100 public:
101 
102  //- Runtime type information
103  TypeName("boundaryRandom");
104 
105 
106  // Constructors
107 
108  //- Construct from dictionary
110  (
111  const word& name,
112  const polyMesh& mesh,
113  const meshSearch& searchEngine,
114  const dictionary& dict
115  );
116 
117 
118  //- Destructor
119  virtual ~boundaryRandom();
120 };
121 
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 } // End namespace sampledSets
126 } // End namespace Foam
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #endif
131 
132 // ************************************************************************* //
Various (local, not parallel) searches on polyMesh; uses (demand driven) octree to search...
Definition: meshSearch.H:57
dictionary dict
const polyMesh & mesh() const
Definition: sampledSet.H:194
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
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
virtual ~boundaryRandom()
Destructor.
A class for handling words, derived from string.
Definition: word.H:59
const word & name() const
Definition: coordSet.H:111
boundaryRandom(const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict)
Construct from dictionary.
const meshSearch & searchEngine() const
Definition: sampledSet.H:199
TypeName("boundaryRandom")
Runtime type information.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
List< wordRe > wordReList
A List of wordRe (word or regular expression)
Definition: wordReList.H:50
Namespace for OpenFOAM.