OpenFOAM logo
The Open Source CFD Toolbox
  Source Guide OpenCFD Solutions Contact OpenFOAM

scalar.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-2009 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 the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     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, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Typedef
00026     Foam::scalar
00027 
00028 Description
00029     Single floating point number identical to float or double depending on
00030     whether WM_SP or WM_DP is defined.
00031 
00032 SourceFiles
00033     scalar.C
00034 
00035 \*---------------------------------------------------------------------------*/
00036 
00037 #ifndef scalar_H
00038 #define scalar_H
00039 
00040 #include "floatScalar.H"
00041 #include "doubleScalar.H"
00042 
00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00044 
00045 #if defined(WM_SP)
00046 
00047 // Define scalar as a float
00048 
00049 namespace Foam
00050 {
00051     typedef floatScalar scalar;
00052 
00053     static const scalar GREAT = floatScalarGREAT;
00054     static const scalar VGREAT = floatScalarVGREAT;
00055     static const scalar ROOTVGREAT = floatScalarROOTVGREAT;
00056     static const scalar SMALL = floatScalarSMALL;
00057     static const scalar VSMALL = floatScalarVSMALL;
00058     static const scalar ROOTVSMALL = floatScalarROOTVSMALL;
00059 
00060     scalar readScalar(Istream& is);
00061 }
00062 
00063 #elif defined(WM_DP)
00064 
00065 // Define scalar as a double
00066 
00067 namespace Foam
00068 {
00069     typedef doubleScalar scalar;
00070 
00071     static const scalar GREAT = doubleScalarGREAT;
00072     static const scalar VGREAT = doubleScalarVGREAT;
00073     static const scalar ROOTVGREAT = doubleScalarROOTVGREAT;
00074     static const scalar SMALL = doubleScalarSMALL;
00075     static const scalar VSMALL = doubleScalarVSMALL;
00076     static const scalar ROOTVSMALL = doubleScalarROOTVSMALL;
00077 
00078     scalar readScalar(Istream& is);
00079 }
00080 
00081 #endif
00082 
00083 
00084 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00085 
00086 #endif
00087 
00088 // ************************************************************************* //
Copyright © 2000-2009 OpenCFD Ltd