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) 2011 OpenFOAM Foundation
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 "cellModel.H"
41 #include "PtrList.H"
42 #include "HashTable.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class cellModeller Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class cellModeller
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  ~cellModeller();
76 
77 
78  // Member functions
79 
80  //- Look up a model by name and return a pointer to the model or NULL
81  static const cellModel* lookup(const word&);
82 
83  //- Look up a model by index and return a pointer to the model or NULL
84  static const cellModel* lookup(const label i)
85  {
86  return modelPtrs_[i];
87  }
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace Foam
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 #endif
98 
99 // ************************************************************************* //
~cellModeller()
Destructor.
Definition: cellModeller.C:82
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:61
An STL-conforming hash table.
Definition: HashTable.H:61
A class for handling words, derived from string.
Definition: word.H:59
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
A static collection of cell models, and a means of looking them up.
Definition: cellModeller.H:52
Namespace for OpenFOAM.
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
Maps a geometry to a set of cell primitives, which enables geometric cell data to be calculated witho...
Definition: cellModel.H:64
static const cellModel * lookup(const word &)
Look up a model by name and return a pointer to the model or NULL.
Definition: cellModeller.C:91
cellModeller()
Construct from central "cellModels" file.
Definition: cellModeller.C:33