polyMeshGen.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  polyMeshGen
26 
27 Description
28  Mesh with selections
29 
30 SourceFiles
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef polyMeshGen_H
35 #define polyMeshGen_H
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 #include "polyMeshGenCells.H"
40 #include "dictionary.H"
41 
42 namespace Foam
43 {
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 class polyMeshGen
48 : public polyMeshGenCells
49 {
50  // Private data
51  //- meta data about the meshing process
53 
54 public:
55 
56  // Constructors
57  //- Null constructor
58  polyMeshGen(const Time& t);
59 
60  //- Construct from components without the boundary
62  (
63  const Time& t,
64  const pointField& points,
65  const faceList& faces,
66  const cellList& cells
67  );
68 
69  //- Construct from components with the boundary
71  (
72  const Time& t,
73  const pointField& points,
74  const faceList& faces,
75  const cellList& cells,
76  const wordList& patchNames,
77  const labelList& patchStart,
78  const labelList& nFacesInPatch
79  );
80 
81  // Destructor
82 
83  ~polyMeshGen();
84 
85  // Public member functions
86  //- return a constant reference to metaDict
87  inline const dictionary& metaData() const
88  {
89  return metaDict_;
90  }
91 
92  //- return a reference to metaDict
93  inline dictionary& metaData()
94  {
95  return metaDict_;
96  }
97 
98  // Read mesh
99  void read();
100 
101  // Write mesh
102  void write() const;
103 };
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 } // End namespace Foam
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 #endif
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
Foam::IOdictionary
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:53
Foam::Time
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
Foam::polyMeshGenFaces::patchNames
wordList patchNames() const
return list of patches in the boundary
Definition: polyMeshGenFaces.C:203
Foam::polyMeshGen::~polyMeshGen
~polyMeshGen()
Definition: polyMeshGen.C:116
Foam::polyMeshGen::metaData
dictionary & metaData()
return a reference to metaDict
Definition: polyMeshGen.H:92
Foam::polyMeshGen::polyMeshGen
polyMeshGen(const Time &t)
Null constructor.
Definition: polyMeshGen.C:37
Foam::polyMeshGen
Definition: polyMeshGen.H:46
Foam::polyMeshGenPoints::points
const pointFieldPMG & points() const
access to points
Definition: polyMeshGenPointsI.H:44
Foam::polyMeshGen::read
void read()
Definition: polyMeshGen.C:121
Foam::polyMeshGenFaces::faces
const faceListPMG & faces() const
access to faces
Definition: polyMeshGenFacesI.H:43
Foam::polyMeshGenCells
Definition: polyMeshGenCells.H:49
Foam::Field
Pre-declare SubField and related Field type.
Definition: Field.H:57
Foam::polyMeshGenCells::cells
const cellListPMG & cells() const
access to cells
Definition: polyMeshGenCellsI.H:39
polyMeshGenCells.H
Foam::polyMeshGen::metaData
const dictionary & metaData() const
return a constant reference to metaDict
Definition: polyMeshGen.H:86
Foam::dictionary
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:137
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::List
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
Foam::polyMeshGen::write
void write() const
Definition: polyMeshGen.C:126
dictionary.H
Foam::polyMeshGen::metaDict_
IOdictionary metaDict_
meta data about the meshing process
Definition: polyMeshGen.H:51