src/OpenFOAM/global/dimensionedConstants/dimensionedConstants.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Global
  26     dimensionedConstants
  27
  28 Description
  29     Dictionary reading and supplying the dimensioned constants used within
  30     OpenFOAM particularly for thermodynamics.  The values are read from the
  31     OpenFOAM controlDict and should be changed to run with a different set of
  32     units from the default SI units.
  33
  34 SourceFiles
  35     dimensionedConstants.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef dimensionedConstants_H
  40 #define dimensionedConstants_H
  41
  42 #include "dictionary.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  50
  51 dictionary& dimensionedConstants();
  52
  53 template<class T>
  54 T dimensionedConstant
  55 (
  56     const char* switchName,
  57     const T defaultValue
  58 )
  59 {
  60     if (dimensionedConstants().found(switchName))
  61     {
  62         return pTraits<T>(dimensionedConstants().lookup(switchName));
  63     }
  64     else
  65     {
  66         dimensionedConstants().add(switchName, defaultValue);
  67         return defaultValue;
  68     }
  69 }
  70
  71
  72 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  73
  74 } // End namespace Foam
  75
  76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  77
  78 #endif
  79
  80 // ************************************************************************* //