simplifiedFvMesh.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2018 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::simplifiedFvMesh
28 
29 Description
30  Functions to generate simplified finite volume meshes
31 
32 SourceFiles
33  simplifiedFvMesh.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef simplifiedFvMesh_H
38 #define simplifiedFvMesh_H
39 
40 #include "runTimeSelectionTables.H"
41 #include "fvMesh.H"
42 #include "Time.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class simplifiedFvMesh Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class simplifiedFvMesh
54 :
55  public fvMesh
56 {
57 public:
58 
59  //- Runtime type information
60  TypeName("simplifiedFvMesh");
61 
62  // Declare run-time constructor selection table
63 
65  (
66  autoPtr,
68  time,
69  (
70  const Time& runTime
71  ),
72  (runTime)
73  );
74 
75 
76  // Selectors
77 
78  //- Return a reference to the selected simplified mesh
80  (
81  const word& modelType,
82  const Time& runTime
83  );
84 
85 
86  //- Constructor
88  (
89  const IOobject& io,
91  faceList&& faces,
92  labelList&& allOwner,
93  labelList&& allNeighbour
94  );
95 
96 
97  // Member Functions
98 
99  //- Helper function to see if the patch type exists in the run-time
100  //- selection tables
101  static bool fvPatchFieldExists(const word& patchType);
102 };
103 
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 } // End namespace Foam
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 #endif
112 
113 // ************************************************************************* //
runTime
engineTime & runTime
Definition: createEngineTime.H:13
Foam::polyMesh::points
virtual const pointField & points() const
Return raw points.
Definition: polyMesh.C:1069
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:169
Foam::Time
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:73
Foam::simplifiedFvMesh::TypeName
TypeName("simplifiedFvMesh")
Runtime type information.
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::simplifiedFvMesh::New
static autoPtr< simplifiedFvMesh > New(const word &modelType, const Time &runTime)
Return a reference to the selected simplified mesh.
Definition: simplifiedFvMesh.C:81
Foam::Field< vector >
Foam::simplifiedFvMesh::fvPatchFieldExists
static bool fvPatchFieldExists(const word &patchType)
Definition: simplifiedFvMesh.C:43
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:85
fvMesh.H
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::simplifiedFvMesh::declareRunTimeSelectionTable
declareRunTimeSelectionTable(autoPtr, simplifiedFvMesh, time,(const Time &runTime),(runTime))
Time.H
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::simplifiedFvMesh
Functions to generate simplified finite volume meshes.
Definition: simplifiedFvMesh.H:52
Foam::polyMesh::faces
virtual const faceList & faces() const
Return raw faces.
Definition: polyMesh.C:1094
runTimeSelectionTables.H
Macros to ease declaration of run-time selection tables.
Foam::List< face >
Foam::simplifiedFvMesh::simplifiedFvMesh
simplifiedFvMesh(const IOobject &io, pointField &&points, faceList &&faces, labelList &&allOwner, labelList &&allNeighbour)
Constructor.
Definition: simplifiedFvMesh.C:61
Foam::fvMesh::time
const Time & time() const
Return the top-level database.
Definition: fvMesh.H:280