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