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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2012-2016 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::faceSelections::faceZoneSelection
28
29Description
30 Select faces from faceZone
31
32SourceFiles
33 faceZoneSelection.C
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef faceZoneSelection_H
38#define faceZoneSelection_H
39
40#include "faceSelection.H"
41#include "pointField.H"
42#include "boolList.H"
43#include "volFields.H"
44
45// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46
47namespace Foam
48{
49
50class regionSplit;
52namespace faceSelections
53{
54
55/*---------------------------------------------------------------------------*\
56 Class faceZoneSelection Declaration
57\*---------------------------------------------------------------------------*/
60:
61 public faceSelection
62{
63 // Private data
64
65 //- Name of faceZone
66 const word zoneName_;
67
68
69 // Private Member Functions
70
71public:
72
73 //- Runtime type information
74 TypeName("faceZone");
75
76
77 // Constructors
78
79 //- Construct from dictionary
81 (
82 const word& name,
83 const fvMesh& mesh,
84 const dictionary& dict
85 );
86
87 //- Clone
89 {
91 return nullptr;
92 }
93
94
95 //- Destructor
96 virtual ~faceZoneSelection();
97
98
99 // Member Functions
100
101 //- Apply this selector
102 virtual void select(const label zoneID, labelList&, boolList&) const;
103
104};
105
106
107// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108
109} // End namespace faceSelections
110} // End namespace Foam
111
112// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113
114#endif
115
116// ************************************************************************* //
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Face selection method for createBaffles.
Definition: faceSelection.H:59
const word & name() const
const dictionary & dict() const
autoPtr< faceSelection > clone() const
Clone.
virtual void select(const label zoneID, labelList &, boolList &) const
Apply this selector.
faceZoneSelection(const word &name, const fvMesh &mesh, const dictionary &dict)
Construct from dictionary.
TypeName("faceZone")
Runtime type information.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
A class for handling words, derived from Foam::string.
Definition: word.H:68
dynamicFvMesh & mesh
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:517
const labelIOList & zoneID
Namespace for OpenFOAM.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73