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-------------------------------------------------------------------------------
10License
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
26Class
27 Foam::simplifiedFvMesh
28
29Description
30 Functions to generate simplified finite volume meshes
31
32SourceFiles
33 simplifiedFvMesh.C
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef simplifiedFvMesh_H
38#define simplifiedFvMesh_H
39
41#include "fvMesh.H"
42#include "Time.H"
43
44// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45
46namespace Foam
47{
48
49/*---------------------------------------------------------------------------*\
50 Class simplifiedFvMesh Declaration
51\*---------------------------------------------------------------------------*/
54:
55 public fvMesh
56{
57public:
58
59 //- Runtime type information
60 TypeName("simplifiedFvMesh");
61
62 // Declare run-time constructor selection table
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,
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// ************************************************************************* //
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:170
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:80
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
const Time & time() const
Return the top-level database.
Definition: fvMesh.H:290
virtual const faceList & faces() const
Return raw faces.
Definition: polyMesh.C:1108
virtual const pointField & points() const
Return raw points.
Definition: polyMesh.C:1083
Functions to generate simplified finite volume meshes.
static bool fvPatchFieldExists(const word &patchType)
static autoPtr< simplifiedFvMesh > New(const word &modelType, const Time &runTime)
Return a reference to the selected simplified mesh.
TypeName("simplifiedFvMesh")
Runtime type information.
declareRunTimeSelectionTable(autoPtr, simplifiedFvMesh, time,(const Time &runTime),(runTime))
A class for handling words, derived from Foam::string.
Definition: word.H:68
engineTime & runTime
IOobject io("surfaceFilmProperties", mesh.time().constant(), mesh, IOobject::READ_IF_PRESENT, IOobject::NO_WRITE, false)
Namespace for OpenFOAM.
Macros to ease declaration of run-time selection tables.
#define declareRunTimeSelectionTable(ptrWrapper, baseType, argNames, argList, parList)
Declare a run-time selection (variables and adder classes)
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73