•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
regionProperties.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 | Copyright (C) 2011-2015 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::regionProperties
26 
27 Description
28  Simple class to hold region information for coupled region simulations.
29 
30  Gives per physics ('fluid', 'solid') the names of the regions. There
31  is no assumption on this level that one region should only have one
32  set of physics.
33 
34 SourceFiles
35  regionProperties.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef regionProperties_H
40 #define regionProperties_H
41 
42 #include "Time.H"
43 #include "HashTable.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class regionProperties Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class regionProperties
55 :
56  public HashTable<wordList>
57 {
58 
59  //- Disallow default bitwise copy construct
60  regionProperties(const regionProperties&);
61 
62  //- Disallow default bitwise assignment
63  void operator=(const regionProperties&);
64 
65 public:
66 
67  // Constructors
68 
69  //- Construct from components
70  regionProperties(const Time& runTime);
71 
72 
73  //- Destructor
74  ~regionProperties();
75 
76 };
77 
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 } // End namespace Foam
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 #endif
86 
87 // ************************************************************************* //
Foam::regionProperties
Simple class to hold region information for coupled region simulations.
Definition: regionProperties.H:53
Foam::Time
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
Foam::HashTable
An STL-conforming hash table.
Definition: HashTable.H:62
Foam::regionProperties::~regionProperties
~regionProperties()
Destructor.
Definition: regionProperties.C:52
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Generated by   doxygen 1.8.13