src/OpenFOAM/global/constants/dimensionedConstants.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, 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     OpenFOAM, particularly for thermodynamics.
  30
  31     The values are read from the OpenFOAM etc/controlDict and should be
  32     changed to run with a different set of 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 #include "dimensionedScalar.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  51
  52 dictionary& dimensionedConstants();
  53
  54
  55 dimensionedScalar dimensionedConstant(const word& group, const word& varName);
  56
  57
  58 template<class T>
  59 T dimensionedConstant
  60 (
  61     const word& group,
  62     const word& varName,
  63     const T& defaultValue
  64 )
  65 {
  66     dictionary& dict = dimensionedConstants();
  67
  68     const word unitSet(dict.lookup("unitSet"));
  69
  70     dictionary& unitDict(dict.subDict(unitSet + "Coeffs"));
  71
  72     if (unitDict.found(group))
  73     {
  74         dictionary& groupDict = unitDict.subDict(group);
  75         if (groupDict.found(varName))
  76         {
  77             return pTraits<T>(groupDict.lookup(varName));
  78         }
  79         else
  80         {
  81             groupDict.add(varName, defaultValue);
  82             return defaultValue;
  83         }
  84     }
  85     else
  86     {
  87         unitDict.add(group, dictionary::null);
  88         unitDict.subDict(group).add(varName, defaultValue);
  89
  90         return defaultValue;
  91     }
  92 }
  93
  94
  95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  96
  97 } // End namespace Foam
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 #endif
 102
 103 // ************************************************************************* //