createFundamentalSheets.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | cfMesh: A library for mesh generation
4  \\ / O peration |
5  \\ / A nd | Author: Franjo Juretic (franjo.juretic@c-fields.com)
6  \\/ M anipulation | Copyright (C) Creative Fields, Ltd.
7 -------------------------------------------------------------------------------
8 License
9  This file is part of cfMesh.
10 
11  cfMesh 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 3 of the License, or (at your
14  option) any later version.
15 
16  cfMesh 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 cfMesh. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  createFundamentalSheets
26 
27 Description
28  A base class for various method to generate fundamental sheets
29  necessary to capture feature edges
30 
31 SourceFiles
32  createFundamentalSheets.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef createFundamentalSheets_H
37 #define createFundamentalSheets_H
38 
39 #include "polyMeshGenModifier.H"
40 #include "labelLongList.H"
41 #include "boolList.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 // Forward declarations
49 class meshOctree;
50 class meshSurfaceEngine;
51 
52 /*---------------------------------------------------------------------------*\
53  Class createFundamentalSheets Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 {
58 protected:
59  // Protected data
60 
61  //- type of sheet creation
62  word name_;
63 
64  //- reference to mesh
66 
67  //- shall the procedure create the intial wrapper sheet
68  const bool createWrapperSheet_;
69 
70  // Protected member functions
71 
72  //- Disallow default bitwise copy construct
74 
75  //- Disallow default bitwise assignment
77 
78 public:
79 
80  // Runtime type information
81  TypeName("createFundamentalSheets");
82 
83  // Constructors
84 
85  //- Construct from mesh data
87  (
89  const bool createWrapperSheet = true
90  );
91 
92  // Declare run-time constructor selection table
93 
95  (
96  autoPtr,
99  (
100  polyMeshGen& mesh,
101  const bool createWrapperSheet
102  ),
103  (mesh, createWrapperSheet)
104  );
105 
106 
107  // Selectors
108 
109  //- Select constructed from dictionary
111  (
112  polyMeshGen& mesh, const bool createWrapperSheet = true
113  );
114 
115  // Destructor
116 
117  virtual ~createFundamentalSheets();
118 
119  // Member Functions
120  //- return the method name
121  const word& name() const
122  {
123  return name_;
124  }
125 };
126 
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 } // End namespace Foam
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 #endif
135 
136 // ************************************************************************* //
Foam::createFundamentalSheets::mesh_
polyMeshGen & mesh_
reference to mesh
Definition: createFundamentalSheets.H:64
Foam::createFundamentalSheets::createFundamentalSheets
createFundamentalSheets(const createFundamentalSheets &)
Disallow default bitwise copy construct.
Foam::createFundamentalSheets::declareRunTimeSelectionTable
declareRunTimeSelectionTable(autoPtr, createFundamentalSheets, polyMeshGen,(polyMeshGen &mesh, const bool createWrapperSheet),(mesh, createWrapperSheet))
boolList.H
Foam::word
A class for handling words, derived from string.
Definition: word.H:59
Foam::createFundamentalSheets::name
const word & name() const
return the method name
Definition: createFundamentalSheets.H:120
Foam::createFundamentalSheets::New
static autoPtr< createFundamentalSheets > New(polyMeshGen &mesh, const bool createWrapperSheet=true)
Select constructed from dictionary.
meshSurfaceEngine
Calculates surface of the mesh.
polyMeshGenModifier.H
Foam::polyMeshGen
Definition: polyMeshGen.H:46
Foam::createFundamentalSheets::~createFundamentalSheets
virtual ~createFundamentalSheets()
Definition: createFundamentalSheets.C:58
Foam::createFundamentalSheets::name_
word name_
type of sheet creation
Definition: createFundamentalSheets.H:61
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:18
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::createFundamentalSheets::operator=
void operator=(const createFundamentalSheets &)
Disallow default bitwise assignment.
Foam::autoPtr
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
labelLongList.H
meshOctree
Octree for mesh generation.
Foam::createFundamentalSheets::TypeName
TypeName("createFundamentalSheets")
Foam::createFundamentalSheets
Definition: createFundamentalSheets.H:55
Foam::createFundamentalSheets::createWrapperSheet_
const bool createWrapperSheet_
shall the procedure create the intial wrapper sheet
Definition: createFundamentalSheets.H:67