OpenFOAM logo
Open Source CFD Toolkit

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-2005 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 the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     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, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     cellModeller
00027 
00028 Description
00029     A cellModeller is a static collection of cell models, and a means
00030     of looking them up.
00031 
00032 SourceFiles
00033     cellModeller.C
00034     cellModellerIO.C
00035     globalCellModeller.C
00036 
00037 \*---------------------------------------------------------------------------*/
00038 
00039 #ifndef cellModeller_H
00040 #define cellModeller_H
00041 
00042 #include "cellModel.H"
00043 #include "PtrList.H"
00044 #include "HashTable.H"
00045 
00046 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00047 
00048 namespace Foam
00049 {
00050 
00051 /*---------------------------------------------------------------------------*\
00052                            Class cellModeller Declaration
00053 \*---------------------------------------------------------------------------*/
00054 
00055 class cellModeller
00056 {
00057     // Private data
00058 
00059         //- PtrList of models
00060         static PtrList<cellModel> models_;
00061 
00062         //- List of model pointers
00063         static List<cellModel*> modelPtrs_;
00064 
00065         //- HashTable of model pointers
00066         static HashTable<const cellModel*> modelDictionary_;
00067 
00068 
00069 public:
00070 
00071     // Constructors
00072 
00073         //- Construct given file name
00074         cellModeller();
00075 
00076 
00077     // Destructor
00078 
00079         ~cellModeller();
00080 
00081 
00082     // Member functions
00083 
00084         //- Look up a model given name and return ptr to model if good
00085         //  else zero
00086         static const cellModel* lookup(const word&);
00087 
00088         //- Look up a model given label and return ptr to model if good
00089         //  else zero
00090         static const cellModel* lookup(const label i)
00091         {
00092             return modelPtrs_[i];
00093         }
00094 };
00095 
00096 
00097 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00098 
00099 } // End namespace Foam
00100 
00101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00102 
00103 #endif
00104 
00105 // ************************************************************************* //
For further information go to www.openfoam.org