shapeToCell.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) 2011-2024 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  // Private Data
57 
58  //- Cell shape name
59  word shape_;
60 
61 
62  // Private Member Functions
63 
64  //- Depending on cell shape add to or delete from cellSet.
65  void combine(topoSet& set, const bool add) const;
66 
67 
68 public:
69 
70  //- Runtime type information
71  TypeName("shapeToCell");
72 
73 
74  // Static data
75 
76  //- Cos of feature angle for polyHedral to be splitHex
77  static scalar featureCos;
78 
79 
80  // Constructors
81 
82  //- Construct from components
84  (
85  const polyMesh& mesh,
86  const word& shape
87  );
88 
89  //- Construct from dictionary
91  (
92  const polyMesh& mesh,
93  const dictionary& dict
94  );
95 
96 
97  //- Destructor
98  virtual ~shapeToCell();
99 
100 
101  // Member Functions
102 
103  virtual sourceType setType() const
104  {
105  return CELLSETSOURCE;
106  }
107 
108  virtual void applyToSet
109  (
110  const topoSetSource::setAction action,
111  topoSet&
112  ) const;
113 };
114 
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 } // End namespace Foam
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 #endif
123 
124 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:80
A topoSetSource to select cells based on cell shape.
Definition: shapeToCell.H:54
static scalar featureCos
Cos of feature angle for polyHedral to be splitHex.
Definition: shapeToCell.H:76
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Definition: shapeToCell.C:122
virtual sourceType setType() const
Definition: shapeToCell.H:102
virtual ~shapeToCell()
Destructor.
Definition: shapeToCell.C:115
TypeName("shapeToCell")
Runtime type information.
shapeToCell(const polyMesh &mesh, const word &shape)
Construct from components.
Definition: shapeToCell.C:80
Base class of a source for a topoSet.
Definition: topoSetSource.H:64
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:71
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:83
const polyMesh & mesh() const
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:65
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
dictionary dict