src/foam/global/dimensionedConstants/dimensionedConstants.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Global
  25     dimensionedConstants
  26
  27 Description
  28     Dictionary reading and supplying the dimensioned constants used within
  29     FOAM particularly for thermodynamics.  The values are read from the
  30     FOAM controlDict and should be changed to run with a different set of
  31     units from the default SI units.
  32
  33 SourceFiles
  34     dimensionedConstants.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef dimensionedConstants_H
  39 #define dimensionedConstants_H
  40
  41 #include "dictionary.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 dictionary& dimensionedConstants();
  51
  52 template<class T>
  53 T dimensionedConstant
  54 (
  55     const char* switchName,
  56     const T defaultValue
  57 )
  58 {
  59     if (dimensionedConstants().found(switchName))
  60     {
  61         return pTraits<T>(dimensionedConstants().lookup(switchName));
  62     }
  63     else
  64     {
  65         dimensionedConstants().add(switchName, defaultValue);
  66
  67         return defaultValue;
  68     }
  69 }
  70
  71
  72 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  73
  74 } // End namespace Foam
  75
  76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  77
  78 #endif
  79
  80 // ************************************************************************* //