faceZoneSelection.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) 2012-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::faceSelections::faceZoneSelection
26 
27 Description
28  Select faces from faceZone
29 
30 SourceFiles
31  faceZoneSelection.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef faceZoneSelection_H
36 #define faceZoneSelection_H
37 
38 #include "faceSelection.H"
39 #include "pointField.H"
40 #include "boolList.H"
41 #include "volFields.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 class regionSplit;
49 
50 namespace faceSelections
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class faceZoneSelection Declaration
55 \*---------------------------------------------------------------------------*/
56 
58 :
59  public faceSelection
60 {
61  // Private data
62 
63  //- Name of faceZone
64  const word zoneName_;
65 
66 
67  // Private Member Functions
68 
69 public:
70 
71  //- Runtime type information
72  TypeName("faceZone");
73 
74 
75  // Constructors
76 
77  //- Construct from dictionary
79  (
80  const word& name,
81  const fvMesh& mesh,
82  const dictionary& dict
83  );
84 
85  //- Clone
87  {
89  return autoPtr<faceSelection>(NULL);
90  }
91 
92 
93  //- Destructor
94  virtual ~faceZoneSelection();
95 
96 
97  // Member Functions
98 
99  //- Apply this selector
100  virtual void select(const label zoneID, labelList&, boolList&) const;
101 
102 };
103 
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 } // End namespace faceSelections
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #endif
113 
114 // ************************************************************************* //
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:137
virtual void select(const label zoneID, labelList &, boolList &) const
Apply this selector.
const dictionary & dict() const
const word & name() const
dynamicFvMesh & mesh
A class for handling words, derived from string.
Definition: word.H:59
Face selection method for createBaffles.
Definition: faceSelection.H:57
faceZoneSelection(const word &name, const fvMesh &mesh, const dictionary &dict)
Construct from dictionary.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
virtual ~faceZoneSelection()
Destructor.
TypeName("faceZone")
Runtime type information.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:366
autoPtr< faceSelection > clone() const
Clone.
Namespace for OpenFOAM.