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

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-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 Global
00025     dimensionedConstants
00026 
00027 Description
00028     Dictionary reading and supplying the dimensioned constants used within
00029     OpenFOAM particularly for thermodynamics.  The values are read from the
00030     OpenFOAM controlDict and should be changed to run with a different set of
00031     units from the default SI units.
00032 
00033 SourceFiles
00034     dimensionedConstants.C
00035 
00036 \*---------------------------------------------------------------------------*/
00037 
00038 #ifndef dimensionedConstants_H
00039 #define dimensionedConstants_H
00040 
00041 #include <OpenFOAM/dictionary.H>
00042 
00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00044 
00045 namespace Foam
00046 {
00047 
00048 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00049 
00050 
00051 //- Dictionary with dimensioned constants
00052 // Dictionary reading and supplying the dimensioned constants used within
00053 // OpenFOAM particularly for thermodynamics.  The values are read from the
00054 // OpenFOAM controlDict and should be changed to run with a different set of
00055 // units from the default SI units.
00056 dictionary& dimensionedConstants();
00057 
00058 //- Read a dimensioned constant from the OpenFOAM controlDict
00059 template<class T>
00060 T dimensionedConstant
00061 (
00062     const char* switchName,
00063     const T defaultValue
00064 )
00065 {
00066     if (dimensionedConstants().found(switchName))
00067     {
00068         return pTraits<T>(dimensionedConstants().lookup(switchName));
00069     }
00070     else
00071     {
00072         dimensionedConstants().add(switchName, defaultValue);
00073         return defaultValue;
00074     }
00075 }
00076 
00077 
00078 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00079 
00080 } // End namespace Foam
00081 
00082 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00083 
00084 #endif
00085 
00086 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines