src/OpenFOAM/dimensionSet/dimensionSet.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 Class
  25     Foam::dimensionSet
  26
  27 Description
  28     Dimension set for the base types.
  29
  30     This type may be used to implement rigorous dimension checking
  31     for algebraic manipulation.
  32
  33 SourceFiles
  34     dimensionSet.C
  35     dimensionSetIO.C
  36     dimensionSets.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef dimensionSet_H
  41 #define dimensionSet_H
  42
  43 #include "scalar.H"
  44 #include "bool.H"
  45 #include "dimensionedScalarFwd.H"
  46 #include "className.H"
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52
  53 // Forward declaration of friend functions and operators
  54
  55 class dimensionSet;
  56
  57 // Friend functions
  58
  59 dimensionSet max(const dimensionSet&, const dimensionSet&);
  60 dimensionSet min(const dimensionSet&, const dimensionSet&);
  61 dimensionSet cmptMultiply(const dimensionSet&, const dimensionSet&);
  62 dimensionSet cmptDivide(const dimensionSet&, const dimensionSet&);
  63
  64 dimensionSet pow(const dimensionSet&, const scalar);
  65 dimensionSet pow(const dimensionSet&, const dimensionedScalar&);
  66 dimensionSet pow(const dimensionedScalar&, const dimensionSet&);
  67
  68 dimensionSet sqr(const dimensionSet&);
  69 dimensionSet pow3(const dimensionSet&);
  70 dimensionSet pow4(const dimensionSet&);
  71 dimensionSet pow5(const dimensionSet&);
  72 dimensionSet pow6(const dimensionSet&);
  73 dimensionSet pow025(const dimensionSet&);
  74
  75 dimensionSet sqrt(const dimensionSet&);
  76 dimensionSet magSqr(const dimensionSet&);
  77 dimensionSet mag(const dimensionSet&);
  78 dimensionSet sign(const dimensionSet&);
  79 dimensionSet pos(const dimensionSet&);
  80 dimensionSet neg(const dimensionSet&);
  81 dimensionSet inv(const dimensionSet&);
  82
  83 // Function to check the argument is dimensionless
  84 //  for transcendental functions
  85 dimensionSet trans(const dimensionSet&);
  86
  87 // Return the argument; transformations do not change the dimensions
  88 dimensionSet transform(const dimensionSet&);
  89
  90 // Friend operators
  91
  92 dimensionSet operator-(const dimensionSet&);
  93 dimensionSet operator+(const dimensionSet&, const dimensionSet&);
  94 dimensionSet operator-(const dimensionSet&, const dimensionSet&);
  95 dimensionSet operator*(const dimensionSet&, const dimensionSet&);
  96 dimensionSet operator/(const dimensionSet&, const dimensionSet&);
  97 dimensionSet operator&(const dimensionSet&, const dimensionSet&);
  98 dimensionSet operator^(const dimensionSet&, const dimensionSet&);
  99 dimensionSet operator&&(const dimensionSet&, const dimensionSet&);
 100
 101 // IOstream operators
 102
 103 Istream& operator>>(Istream&, dimensionSet&);
 104 Ostream& operator<<(Ostream&, const dimensionSet&);
 105
 106
 107 /*---------------------------------------------------------------------------*\
 108                         Class dimensionSet Declaration
 109 \*---------------------------------------------------------------------------*/
 110
 111 class dimensionSet
 112 {
 113
 114 public:
 115
 116     // Member constants
 117
 118         enum
 119         {
 120             nDimensions = 7    // Number of dimensions in SI is 7
 121         };
 122
 123         //- Define an enumeration for the names of the dimension exponents
 124         enum dimensionType
 125         {
 126             MASS,               // kilogram   kg
 127             LENGTH,             // metre      m
 128             TIME,               // second     s
 129             TEMPERATURE,        // Kelvin     K
 130             MOLES,              // mole       mol
 131             CURRENT,            // Ampere     A
 132             LUMINOUS_INTENSITY  // Candela    Cd
 133         };
 134
 135
 136     // Static data members
 137
 138         static const scalar smallExponent;
 139
 140
 141 private:
 142
 143     // private data
 144
 145         // dimensionSet stored as an array of dimension exponents
 146         scalar exponents_[nDimensions];
 147
 148
 149 public:
 150
 151     // Declare name of the class and its debug switch
 152     ClassName("dimensionSet");
 153
 154
 155     // Constructors
 156
 157         //- Construct given individual dimension exponents for all
 158         //  seven dimensions
 159         dimensionSet
 160         (
 161             const scalar mass,
 162             const scalar length,
 163             const scalar time,
 164             const scalar temperature,
 165             const scalar moles,
 166             const scalar current,
 167             const scalar luminousIntensity
 168         );
 169
 170         //- Construct given individual dimension exponents for first
 171         //  five dimensions
 172         dimensionSet
 173         (
 174             const scalar mass,
 175             const scalar length,
 176             const scalar time,
 177             const scalar temperature,
 178             const scalar moles
 179         );
 180
 181         //- Construct from Istream
 182         dimensionSet(Istream&);
 183
 184
 185     // Member functions
 186
 187         //- Return true if it is dimensionless
 188         bool dimensionless() const;
 189
 190         void reset(const dimensionSet&);
 191
 192         //- Return a text representation for added readability
 193         string asText() const;
 194
 195
 196     // Member operators
 197
 198         scalar operator[](const dimensionType) const;
 199         scalar& operator[](const dimensionType);
 200         bool operator==(const dimensionSet&) const;
 201         bool operator!=(const dimensionSet&) const;
 202
 203         bool operator=(const dimensionSet&) const;
 204
 205         bool operator+=(const dimensionSet&) const;
 206         bool operator-=(const dimensionSet&) const;
 207         bool operator*=(const dimensionSet&);
 208         bool operator/=(const dimensionSet&);
 209
 210
 211     // Friend functions
 212
 213         friend dimensionSet max(const dimensionSet&, const dimensionSet&);
 214         friend dimensionSet min(const dimensionSet&, const dimensionSet&);
 215         friend dimensionSet cmptMultiply
 216         (
 217             const dimensionSet&,
 218             const dimensionSet&
 219         );
 220         friend dimensionSet cmptDivide
 221         (
 222             const dimensionSet&,
 223             const dimensionSet&
 224         );
 225
 226         friend dimensionSet pow(const dimensionSet&, const scalar);
 227         friend dimensionSet pow(const dimensionSet&, const dimensionedScalar&);
 228         friend dimensionSet pow(const dimensionedScalar&, const dimensionSet&);
 229
 230         friend dimensionSet sqr(const dimensionSet&);
 231         friend dimensionSet pow3(const dimensionSet&);
 232         friend dimensionSet pow4(const dimensionSet&);
 233         friend dimensionSet pow5(const dimensionSet&);
 234         friend dimensionSet pow6(const dimensionSet&);
 235         friend dimensionSet pow025(const dimensionSet&);
 236
 237         friend dimensionSet sqrt(const dimensionSet&);
 238         friend dimensionSet magSqr(const dimensionSet&);
 239         friend dimensionSet mag(const dimensionSet&);
 240         friend dimensionSet sign(const dimensionSet&);
 241         friend dimensionSet pos(const dimensionSet&);
 242         friend dimensionSet neg(const dimensionSet&);
 243         friend dimensionSet inv(const dimensionSet&);
 244
 245         //- Function to check the argument is dimensionless
 246         //  for transcendental functions
 247         friend dimensionSet trans(const dimensionSet&);
 248
 249         //- Return the argument; transformations do not change the dimensions
 250         friend dimensionSet transform(const dimensionSet&);
 251
 252
 253     // Friend operators
 254
 255         friend dimensionSet operator-(const dimensionSet&);
 256
 257         friend dimensionSet operator+
 258         (
 259             const dimensionSet&,
 260             const dimensionSet&
 261         );
 262
 263         friend dimensionSet operator-
 264         (
 265             const dimensionSet&,
 266             const dimensionSet&
 267         );
 268
 269         friend dimensionSet operator*
 270         (
 271             const dimensionSet&,
 272             const dimensionSet&
 273         );
 274
 275         friend dimensionSet operator/
 276         (
 277             const dimensionSet&,
 278             const dimensionSet&
 279         );
 280
 281         friend dimensionSet operator&
 282         (
 283             const dimensionSet&,
 284             const dimensionSet&
 285         );
 286
 287         friend dimensionSet operator^
 288         (
 289             const dimensionSet&,
 290             const dimensionSet&
 291         );
 292
 293         friend dimensionSet operator&&
 294         (
 295             const dimensionSet&,
 296             const dimensionSet&
 297         );
 298
 299
 300     // IOstream operators
 301
 302         friend Istream& operator>>(Istream&, dimensionSet&);
 303         friend Ostream& operator<<(Ostream&, const dimensionSet&);
 304 };
 305
 306
 307 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 308
 309 } // End namespace Foam
 310
 311 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 312
 313 #include "dimensionSets.H"
 314
 315 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 316
 317 #endif
 318
 319 // ************************************************************************* //