shapeToCell.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) 2011-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::shapeToCell
26 
27 Description
28  A topoSetSource to select cells based on cell shape.
29 
30  Handles all ones from cellModeller and splitHex with 10 degrees
31  feature angle.
32 
33 SourceFiles
34  shapeToCell.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef shapeToCell_H
39 #define shapeToCell_H
40 
41 #include "topoSetSource.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class shapeToCell Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class shapeToCell
53 :
54  public topoSetSource
55 {
56 
57  // Private data
58 
59  //- Add usage string
60  static addToUsageTable usage_;
61 
62  //- Name of cell type
63  word type_;
64 
65  // Private Member Functions
66 
67  //- Depending on cell type add to or delete from cellSet.
68  void combine(topoSet& set, const bool add) const;
69 
70 
71 public:
72 
73  //- Runtime type information
74  TypeName("shapeToCell");
75 
76 
77  // Static data
78 
79  //- Cos of feature angle for polyHedral to be splitHex
80  static scalar featureCos;
81 
82  // Constructors
83 
84  //- Construct from components
86  (
87  const polyMesh& mesh,
88  const word& type
89  );
90 
91  //- Construct from dictionary
93  (
94  const polyMesh& mesh,
95  const dictionary& dict
96  );
97 
98  //- Construct from Istream
100  (
101  const polyMesh& mesh,
102  Istream&
103  );
104 
105 
106  //- Destructor
107  virtual ~shapeToCell();
108 
109 
110  // Member Functions
111 
112  virtual sourceType setType() const
113  {
114  return CELLSETSOURCE;
115  }
116 
117  virtual void applyToSet
118  (
119  const topoSetSource::setAction action,
120  topoSet&
121  ) const;
122 
123 };
124 
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 } // End namespace Foam
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 #endif
133 
134 // ************************************************************************* //
Foam::topoSetSource::sourceType
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:70
Foam::word
A class for handling words, derived from string.
Definition: word.H:59
Foam::shapeToCell::applyToSet
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Definition: shapeToCell.C:158
Foam::shapeToCell::~shapeToCell
virtual ~shapeToCell()
Destructor.
Definition: shapeToCell.C:151
Foam::topoSetSource::addToUsageTable
Class with constructor to add usage string to table.
Definition: topoSetSource.H:100
Foam::shapeToCell::usage_
static addToUsageTable usage_
Add usage string.
Definition: shapeToCell.H:59
Foam::topoSetSource::setAction
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:82
Foam::topoSetSource::mesh
const polyMesh & mesh() const
Definition: topoSetSource.H:274
Foam::shapeToCell
A topoSetSource to select cells based on cell shape.
Definition: shapeToCell.H:51
Foam::polyMesh
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:57
Foam::shapeToCell::combine
void combine(topoSet &set, const bool add) const
Depending on cell type add to or delete from cellSet.
Definition: shapeToCell.C:63
Foam::shapeToCell::TypeName
TypeName("shapeToCell")
Runtime type information.
Foam::topoSet
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:137
Foam::topoSetSource::CELLSETSOURCE
@ CELLSETSOURCE
Definition: topoSetSource.H:72
Foam::add
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
Definition: FieldFieldFunctions.C:870
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::topoSetSource
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
topoSetSource.H
Foam::shapeToCell::shapeToCell
shapeToCell(const polyMesh &mesh, const word &type)
Construct from components.
Definition: shapeToCell.C:98
Foam::shapeToCell::featureCos
static scalar featureCos
Cos of feature angle for polyHedral to be splitHex.
Definition: shapeToCell.H:79
Foam::type
fileName::Type type(const fileName &)
Return the file type: DIRECTORY or FILE.
Definition: POSIX.C:588
Foam::shapeToCell::type_
word type_
Name of cell type.
Definition: shapeToCell.H:62
Foam::shapeToCell::setType
virtual sourceType setType() const
Definition: shapeToCell.H:111