src/OpenFOAM/meshes/meshShapes/cellModeller/cellModeller.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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     Foam::cellModeller
  27
  28 Description
  29     A static collection of cell models, and a means of looking them up.
  30
  31 SourceFiles
  32     cellModeller.C
  33     cellModellerIO.C
  34     globalCellModeller.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef cellModeller_H
  39 #define cellModeller_H
  40
  41 #include "cellModel.H"
  42 #include "PtrList.H"
  43 #include "HashTable.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                         Class cellModeller Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class cellModeller
  55 {
  56     // Private data
  57
  58         //- PtrList of models
  59         static PtrList<cellModel> models_;
  60
  61         //- List of model pointers
  62         static List<cellModel*> modelPtrs_;
  63
  64         //- HashTable of model pointers
  65         static HashTable<const cellModel*> modelDictionary_;
  66
  67
  68 public:
  69
  70     // Constructors
  71
  72         //- Construct from central "cellModels" file
  73         cellModeller();
  74
  75     // Destructor
  76
  77         ~cellModeller();
  78
  79
  80     // Member functions
  81
  82         //- Look up a model by name and return a pointer to the model or NULL
  83         static const cellModel* lookup(const word&);
  84
  85         //- Look up a model by index and return a pointer to the model or NULL
  86         static const cellModel* lookup(const label i)
  87         {
  88             return modelPtrs_[i];
  89         }
  90 };
  91
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 } // End namespace Foam
  96
  97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  98
  99 #endif
 100
 101 // ************************************************************************* //