src/OpenFOAM/primitives/Scalar/scalar/scalar.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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 Typedef
  26     Foam::scalar
  27
  28 Description
  29     Single floating point number identical to float or double depending on
  30     whether WM_SP or WM_DP is defined.
  31
  32 SourceFiles
  33     scalar.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef scalar_H
  38 #define scalar_H
  39
  40 #include "floatScalar.H"
  41 #include "doubleScalar.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 #if defined(WM_SP)
  46
  47 // Define scalar as a float
  48
  49 namespace Foam
  50 {
  51     typedef floatScalar scalar;
  52
  53     static const scalar GREAT = floatScalarGREAT;
  54     static const scalar VGREAT = floatScalarVGREAT;
  55     static const scalar ROOTVGREAT = floatScalarROOTVGREAT;
  56     static const scalar SMALL = floatScalarSMALL;
  57     static const scalar VSMALL = floatScalarVSMALL;
  58     static const scalar ROOTVSMALL = floatScalarROOTVSMALL;
  59
  60     scalar readScalar(Istream& is);
  61 }
  62
  63 #elif defined(WM_DP)
  64
  65 // Define scalar as a double
  66
  67 namespace Foam
  68 {
  69     typedef doubleScalar scalar;
  70
  71     static const scalar GREAT = doubleScalarGREAT;
  72     static const scalar VGREAT = doubleScalarVGREAT;
  73     static const scalar ROOTVGREAT = doubleScalarROOTVGREAT;
  74     static const scalar SMALL = doubleScalarSMALL;
  75     static const scalar VSMALL = doubleScalarVSMALL;
  76     static const scalar ROOTVSMALL = doubleScalarROOTVSMALL;
  77
  78     scalar readScalar(Istream& is);
  79 }
  80
  81 #endif
  82
  83
  84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  85
  86 #endif
  87
  88 // ************************************************************************* //