Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
turbulenceModels
compressible
RAS
derivedFvPatchFields
turbulentTemperatureCoupledBaffle
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) 1991-2010 OpenCFD Ltd.
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
regionProperties
26
27
Description
28
Simple class to hold region information for coupled region simulations
29
30
SourceFiles
31
regionProperties.C
32
33
\*---------------------------------------------------------------------------*/
34
35
#ifndef regionProperties_H
36
#define regionProperties_H
37
38
#include <
OpenFOAM/IOdictionary.H
>
39
#include <
OpenFOAM/Time.H
>
40
41
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42
43
namespace
Foam
44
{
45
46
/*---------------------------------------------------------------------------*\
47
Class regionProperties Declaration
48
\*---------------------------------------------------------------------------*/
49
50
class
regionProperties
51
:
52
public
IOdictionary
53
{
54
// Private data
55
56
//- List of the fluid region names
57
List<word>
fluidRegionNames_;
58
59
//- List of the solid region names
60
List<word>
solidRegionNames_;
61
62
63
// Private Member Functions
64
65
//- Disallow default bitwise copy construct
66
regionProperties
(
const
regionProperties
&);
67
68
//- Disallow default bitwise assignment
69
void
operator=(
const
regionProperties
&);
70
71
72
public
:
73
74
// Constructors
75
76
//- Construct from components
77
regionProperties
(
const
Time
& runTime);
78
79
80
// Destructor
81
82
~regionProperties
();
83
84
85
// Member Functions
86
87
// Access
88
89
//- Return const reference to the list of fluid region names
90
const
List<word>
&
fluidRegionNames
()
const
;
91
92
//- Return const reference to the list of solid region names
93
const
List<word>
&
solidRegionNames
()
const
;
94
};
95
96
97
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98
99
}
// End namespace Foam
100
101
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102
103
#endif
104
105
// ************************************************************************* //