applications/solvers/heatTransfer/chtMultiRegionFoam/regionProperties/regionProperties.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     regionProperties
  27
  28 Description
  29     Simple class to hold region information for coupled region simulations
  30
  31 SourceFiles
  32     regionProperties.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef regionProperties_H
  37 #define regionProperties_H
  38
  39 #include "IOdictionary.H"
  40 #include "Time.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                        Class regionProperties Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class regionProperties
  52 :
  53     public IOdictionary
  54 {
  55     // Private data
  56
  57         //- List of the fluid region names
  58         List<word> fluidRegionNames_;
  59
  60         //- List of the solid region names
  61         List<word> solidRegionNames_;
  62
  63
  64     // Private Member Functions
  65
  66         //- Disallow default bitwise copy construct
  67         regionProperties(const regionProperties&);
  68
  69         //- Disallow default bitwise assignment
  70         void operator=(const regionProperties&);
  71
  72
  73 public:
  74
  75     // Constructors
  76
  77         //- Construct from components
  78         regionProperties(const Time& runTime);
  79
  80
  81     // Destructor
  82
  83         ~regionProperties();
  84
  85
  86     // Member Functions
  87
  88         // Access
  89
  90             //- Return const reference to the list of fluid region names
  91             const List<word>& fluidRegionNames() const;
  92
  93             //- Return const reference to the list of solid region names
  94             const List<word>& solidRegionNames() const;
  95 };
  96
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 } // End namespace Foam
 101
 102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 103
 104 #endif
 105
 106 // ************************************************************************* //