initial commit for version 1.5.x patch release
[OpenFOAM-1.5.x.git] / src / meshTools / sets / cellSources / shapeToCell / shapeToCell.H
bloba30a40eafd52f512b17c10040243e41e66142245
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::shapeToCell
28 Description
29     A topoSetSource to select cells based on cell shape.
31     Handles all ones from cellModeller and splitHex with 10 degrees
32     feature angle.
34 SourceFiles
35     shapeToCell.C
37 \*---------------------------------------------------------------------------*/
39 #ifndef shapeToCell_H
40 #define shapeToCell_H
42 #include "topoSetSource.H"
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 namespace Foam
49 /*---------------------------------------------------------------------------*\
50                            Class shapeToCell Declaration
51 \*---------------------------------------------------------------------------*/
53 class shapeToCell
55     public topoSetSource
58     // Private data
60         //- Add usage string
61         static addToUsageTable usage_;
63         //- Name of cell type
64         word type_;
66     // Private Member Functions
68         //- Depending on cell type add to or delete from cellSet.
69         void combine(topoSet& set, const bool add) const;
72 public:
74     //- Runtime type information
75     TypeName("shapeToCell");
78     // Static data
80         //- cos of feature angle for polyHedral to be splitHex
81         static scalar featureCos;
83     // Constructors
85         //- Construct from components
86         shapeToCell
87         (
88             const polyMesh& mesh,
89             const word& type
90         );
92         //- Construct from dictionary
93         shapeToCell
94         (
95             const polyMesh& mesh,
96             const dictionary& dict
97         );
99         //- Construct from Istream
100         shapeToCell
101         (
102             const polyMesh& mesh,
103             Istream&
104         );
107     // Destructor
109         virtual ~shapeToCell();
112     // Member Functions
114         virtual void applyToSet
115         (
116             const topoSetSource::setAction action,
117             topoSet&
118         ) const;
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 } // End namespace Foam
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 #endif
131 // ************************************************************************* //