00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd. 00006 \\/ M anipulation | 00007 ------------------------------------------------------------------------------- 00008 License 00009 This file is part of OpenFOAM. 00010 00011 OpenFOAM is free software: you can redistribute it and/or modify it 00012 under the terms of the GNU General Public License as published by 00013 the Free Software Foundation, either version 3 of the License, or 00014 (at your option) any later version. 00015 00016 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT 00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00018 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 00019 for more details. 00020 00021 You should have received a copy of the GNU General Public License 00022 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. 00023 00024 Class 00025 regionProperties 00026 00027 Description 00028 Simple class to hold region information for coupled region simulations 00029 00030 SourceFiles 00031 regionProperties.C 00032 00033 \*---------------------------------------------------------------------------*/ 00034 00035 #ifndef regionProperties_H 00036 #define regionProperties_H 00037 00038 #include <OpenFOAM/IOdictionary.H> 00039 #include <OpenFOAM/Time.H> 00040 00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00042 00043 namespace Foam 00044 { 00045 00046 /*---------------------------------------------------------------------------*\ 00047 Class regionProperties Declaration 00048 \*---------------------------------------------------------------------------*/ 00049 00050 class regionProperties 00051 : 00052 public IOdictionary 00053 { 00054 // Private data 00055 00056 //- List of the fluid region names 00057 List<word> fluidRegionNames_; 00058 00059 //- List of the solid region names 00060 List<word> solidRegionNames_; 00061 00062 00063 // Private Member Functions 00064 00065 //- Disallow default bitwise copy construct 00066 regionProperties(const regionProperties&); 00067 00068 //- Disallow default bitwise assignment 00069 void operator=(const regionProperties&); 00070 00071 00072 public: 00073 00074 // Constructors 00075 00076 //- Construct from components 00077 regionProperties(const Time& runTime); 00078 00079 00080 // Destructor 00081 00082 ~regionProperties(); 00083 00084 00085 // Member Functions 00086 00087 // Access 00088 00089 //- Return const reference to the list of fluid region names 00090 const List<word>& fluidRegionNames() const; 00091 00092 //- Return const reference to the list of solid region names 00093 const List<word>& solidRegionNames() const; 00094 }; 00095 00096 00097 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00098 00099 } // End namespace Foam 00100 00101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00102 00103 #endif 00104 00105 // ************************************************************************* //
