OpenFOAM logo
Open Source CFD Toolkit

dimensionedConstants.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 Global
00026     dimensionedConstants
00027 
00028 Description
00029     Dictionary reading and supplying the dimensioned constants used within
00030     OpenFOAM particularly for thermodynamics.  The values are read from the
00031     OpenFOAM controlDict and should be changed to run with a different set of
00032     units from the default SI units.
00033 
00034 SourceFiles
00035     dimensionedConstants.C
00036 
00037 \*---------------------------------------------------------------------------*/
00038 
00039 #ifndef dimensionedConstants_H
00040 #define dimensionedConstants_H
00041 
00042 #include "dictionary.H"
00043 
00044 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00045 
00046 namespace Foam
00047 {
00048 
00049 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00050 
00051 dictionary& dimensionedConstants();
00052 
00053 template<class T>
00054 T dimensionedConstant
00055 (
00056     const char* switchName,
00057     const T defaultValue
00058 )
00059 {
00060     if (dimensionedConstants().found(switchName))
00061     {
00062         return pTraits<T>(dimensionedConstants().lookup(switchName));
00063     }
00064     else
00065     {
00066         dimensionedConstants().add(switchName, defaultValue);
00067         return defaultValue;
00068     }
00069 }
00070 
00071 
00072 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00073 
00074 } // End namespace Foam
00075 
00076 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00077 
00078 #endif
00079 
00080 // ************************************************************************* //
For further information go to www.openfoam.org