FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

cellModeller.H

Go to the documentation of this file.
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     Foam::cellModeller
00026 
00027 Description
00028     A static collection of cell models, and a means of looking them up.
00029 
00030 SourceFiles
00031     cellModeller.C
00032     cellModellerIO.C
00033     globalCellModeller.C
00034 
00035 \*---------------------------------------------------------------------------*/
00036 
00037 #ifndef cellModeller_H
00038 #define cellModeller_H
00039 
00040 #include <OpenFOAM/cellModel.H>
00041 #include <OpenFOAM/PtrList.H>
00042 #include <OpenFOAM/HashTable.H>
00043 
00044 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00045 
00046 namespace Foam
00047 {
00048 
00049 /*---------------------------------------------------------------------------*\
00050                         Class cellModeller Declaration
00051 \*---------------------------------------------------------------------------*/
00052 
00053 class cellModeller
00054 {
00055     // Private data
00056 
00057         //- PtrList of models
00058         static PtrList<cellModel> models_;
00059 
00060         //- List of model pointers
00061         static List<cellModel*> modelPtrs_;
00062 
00063         //- HashTable of model pointers
00064         static HashTable<const cellModel*> modelDictionary_;
00065 
00066 
00067 public:
00068 
00069     // Constructors
00070 
00071         //- Construct from central "cellModels" file
00072         cellModeller();
00073 
00074     // Destructor
00075 
00076         ~cellModeller();
00077 
00078 
00079     // Member functions
00080 
00081         //- Look up a model by name and return a pointer to the model or NULL
00082         static const cellModel* lookup(const word&);
00083 
00084         //- Look up a model by index and return a pointer to the model or NULL
00085         static const cellModel* lookup(const label i)
00086         {
00087             return modelPtrs_[i];
00088         }
00089 };
00090 
00091 
00092 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00093 
00094 } // End namespace Foam
00095 
00096 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00097 
00098 #endif
00099 
00100 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines