src/OpenFOAM/dimensionedTypes/dimensionedType/dimensionedType.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 Class
  26     Foam::dimensioned
  27
  28 Description
  29     Generic dimensioned Type class
  30
  31 SourceFiles
  32     dimensionedType.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef dimensionedType_H
  37 #define dimensionedType_H
  38
  39 #include "word.H"
  40 #include "direction.H"
  41 #include "dimensionSet.H"
  42 #include "VectorSpace.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 // Forward declaration of friend functions and operators
  50
  51 template<class Type> class dimensioned;
  52
  53 template<class Type>
  54 Istream& operator>>(Istream&, dimensioned<Type>&);
  55
  56 template<class Type>
  57 Ostream& operator<<(Ostream&, const dimensioned<Type>&);
  58
  59 class dictionary;
  60
  61 /*---------------------------------------------------------------------------*\
  62                            Class dimensioned Declaration
  63 \*---------------------------------------------------------------------------*/
  64
  65 template <class Type>
  66 class dimensioned
  67 {
  68     // private data
  69
  70         //- Variable name
  71         word name_;
  72
  73         //- The dimension set
  74         dimensionSet dimensions_;
  75
  76         //- The data value
  77         Type value_;
  78
  79
  80 public:
  81
  82     //- Component type
  83     typedef typename pTraits<Type>::cmptType cmptType;
  84
  85
  86     // Constructors
  87
  88         //- Construct given a name, a value and its dimensionSet.
  89         dimensioned(const word&, const dimensionSet&, const Type);
  90
  91         //- Construct from a dimensioned<Type> changing the name.
  92         dimensioned(const word&, const dimensioned<Type>&);
  93
  94         //- Construct given a value (creates dimensionless value).
  95         dimensioned(const Type& t)
  96         :
  97             name_(::Foam::name(t)),
  98             dimensions_(dimless),
  99             value_(t)
 100         {}
 101
 102         //- Construct from Istream.
 103         dimensioned(Istream&);
 104
 105         //- Construct from an Istream with a given name
 106         dimensioned(const word&, Istream&);
 107
 108         //- Construct from an Istream with a given name and dimensions
 109         dimensioned(const word&, const dimensionSet&, Istream&);
 110
 111         //- Construct from dictionary, with default value.
 112         static dimensioned<Type> lookupOrDefault
 113         (
 114             const word&,
 115             const dictionary&,
 116             const Type& defaultValue = pTraits<Type>::zero,
 117             const dimensionSet& dims = dimless
 118         );
 119
 120         //- Construct from dictionary, with default value.
 121         //  If the value is not found, it is added into the dictionary.
 122         static dimensioned<Type> lookupOrAddToDict
 123         (
 124             const word&,
 125             dictionary&,
 126             const Type& defaultValue = pTraits<Type>::zero,
 127             const dimensionSet& dims = dimless
 128         );
 129
 130
 131     // Member functions
 132
 133         //- Return const reference to name.
 134         const word& name() const;
 135
 136         //- Return non-const reference to name.
 137         word& name();
 138
 139         //- Return const reference to dimensions.
 140         const dimensionSet& dimensions() const;
 141
 142         //- Return non-const reference to dimensions.
 143         dimensionSet& dimensions();
 144
 145         //- Return const reference to value.
 146         const Type& value() const;
 147
 148         //- Return non-const reference to value.
 149         Type& value();
 150
 151         //- Return a component as a dimensioned<cmptType>
 152         dimensioned<cmptType> component(const direction) const;
 153
 154         //- Return a component with a dimensioned<cmptType>
 155         void replace(const direction, const dimensioned<cmptType>&);
 156
 157         //- Return transpose.
 158         dimensioned<Type> T() const;
 159
 160         //- Update the value of dimensioned<Type> if found in the dictionary.
 161         bool readIfPresent(const dictionary&);
 162
 163
 164     // Member operators
 165
 166         //- Return a component as a dimensioned<cmptType>
 167         dimensioned<cmptType> operator[](const direction) const;
 168
 169         void operator+=(const dimensioned<Type>&);
 170         void operator-=(const dimensioned<Type>&);
 171         void operator*=(const scalar);
 172         void operator/=(const scalar);
 173
 174
 175     // IOstream operators
 176
 177         friend Istream& operator>> <Type>
 178         (Istream&, dimensioned<Type>&);
 179
 180         friend Ostream& operator<< <Type>
 181         (Ostream&, const dimensioned<Type>&);
 182 };
 183
 184
 185 // * * * * * * * * * * * * * * * Global Operators  * * * * * * * * * * * * * //
 186
 187 template<class Type, int r>
 188 dimensioned<typename powProduct<Type, r>::type>
 189 pow
 190 (
 191     const dimensioned<Type>&,
 192     typename powProduct<Type, r>::type
 193   = pTraits<typename powProduct<Type, r>::type>::zero
 194 );
 195
 196 template<class Type>
 197 dimensioned<typename outerProduct<Type, Type>::type>
 198 sqr(const dimensioned<Type>&);
 199
 200 template<class Type>
 201 dimensioned<scalar> magSqr(const dimensioned<Type>&);
 202
 203 template<class Type>
 204 dimensioned<scalar> mag(const dimensioned<Type>&);
 205
 206 template<class Type>
 207 dimensioned<Type> cmptMultiply
 208 (
 209     const dimensioned<Type>&,
 210     const dimensioned<Type>&
 211 );
 212
 213 template<class Type>
 214 dimensioned<Type> cmptDivide
 215 (
 216     const dimensioned<Type>&,
 217     const dimensioned<Type>&
 218 );
 219
 220 template<class Type>
 221 dimensioned<Type> max(const dimensioned<Type>&, const dimensioned<Type>&);
 222
 223 template<class Type>
 224 dimensioned<Type> min(const dimensioned<Type>&, const dimensioned<Type>&);
 225
 226 template<class Type>
 227 bool operator>(const dimensioned<Type>&, const dimensioned<Type>&);
 228
 229 template<class Type>
 230 bool operator<(const dimensioned<Type>&, const dimensioned<Type>&);
 231
 232 template<class Type>
 233 dimensioned<Type> operator+(const dimensioned<Type>&, const dimensioned<Type>&);
 234
 235 template<class Type>
 236 dimensioned<Type> operator-(const dimensioned<Type>&);
 237
 238 template<class Type>
 239 dimensioned<Type> operator-(const dimensioned<Type>&, const dimensioned<Type>&);
 240
 241 template<class Type>
 242 dimensioned<Type> operator*
 243 (
 244     const dimensioned<scalar>&,
 245     const dimensioned<Type>&
 246 );
 247
 248 template<class Type>
 249 dimensioned<Type> operator/
 250 (
 251     const dimensioned<Type>&,
 252     const dimensioned<scalar>&
 253 );
 254
 255
 256 // Products
 257 // ~~~~~~~~
 258
 259 #define PRODUCT_OPERATOR(product, op, opFunc)                                 \
 260                                                                               \
 261 template<class Type1, class Type2>                                            \
 262 dimensioned<typename product<Type1, Type2>::type>                             \
 263 operator op(const dimensioned<Type1>&, const dimensioned<Type2>&);            \
 264                                                                               \
 265 template<class Type, class Form, class Cmpt, int nCmpt>                       \
 266 dimensioned<typename product<Type, Form>::type>                               \
 267 operator op                                                                   \
 268 (                                                                             \
 269     const dimensioned<Type>&,                                                 \
 270     const VectorSpace<Form,Cmpt,nCmpt>&                                       \
 271 );                                                                            \
 272                                                                               \
 273 template<class Type, class Form, class Cmpt, int nCmpt>                       \
 274 dimensioned<typename product<Form, Type>::type>                               \
 275 operator op                                                                   \
 276 (                                                                             \
 277     const VectorSpace<Form,Cmpt,nCmpt>&,                                      \
 278     const dimensioned<Type>&                                                  \
 279 );
 280
 281 PRODUCT_OPERATOR(outerProduct, *, outer)
 282 PRODUCT_OPERATOR(crossProduct, ^, cross)
 283 PRODUCT_OPERATOR(innerProduct, &, dot)
 284 PRODUCT_OPERATOR(scalarProduct, &&, dotdot)
 285
 286 #undef PRODUCT_OPERATOR
 287
 288
 289 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 290
 291 } // End namespace Foam
 292
 293 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 294
 295 #ifdef NoRepository
 296 #   include "dimensionedType.C"
 297 #endif
 298
 299 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 300
 301 #endif
 302
 303 // ************************************************************************* //