All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
cellSetSampledSet.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) 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::cellSetSampledSet
26 
27 Description
28  Samples at the cell-centres of a given cell set
29 
30 Usage
31  \table
32  Property | Description | Req'd? | Default
33  set | Name of the cell set | yes |
34  \endtable
35 
36  Example specification:
37  \verbatim
38  {
39  type cellSet;
40  set c0;
41  }
42  \endverbatim
43 
44 SourceFiles
45  cellSetSampledSet.C
46 
47 \*---------------------------------------------------------------------------*/
48 
49 #ifndef cellSetSampledSet_H
50 #define cellSetSampledSet_H
51 
52 #include "sampledSet.H"
53 #include "DynamicList.H"
54 
55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
56 
57 namespace Foam
58 {
59 namespace sampledSets
60 {
61 
62 /*---------------------------------------------------------------------------*\
63  Class cellSetSampledSet Declaration
64 \*---------------------------------------------------------------------------*/
65 
66 class cellSetSampledSet
67 :
68  public sampledSet
69 {
70  // Private Data
71 
72  //- Name of the cell set
73  const word setName_;
74 
75 
76  // Private Member Functions
77 
78  //- Generate the samples
79  void genSamples();
80 
81 
82 public:
83 
84  //- Runtime type information
85  TypeName("cellSet");
86 
87 
88  // Constructors
89 
90  //- Construct from dictionary
92  (
93  const word& name,
94  const polyMesh& mesh,
95  const meshSearch& searchEngine,
96  const dictionary& dict
97  );
98 
99 
100  // Destructor
101 
102  virtual ~cellSetSampledSet();
103 };
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace sampledSets
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #endif
114 
115 // ************************************************************************* //
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
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
cellSetSampledSet(const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict)
Construct from dictionary.
A class for handling words, derived from string.
Definition: word.H:59
TypeName("cellSet")
Runtime type information.
const word & name() const
Definition: coordSet.H:111
const meshSearch & searchEngine() const
Definition: sampledSet.H:199
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
Namespace for OpenFOAM.