src/OpenFOAM/primitives/Tensor/Tensor.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 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
  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::Tensor
  26
  27 Description
  28     Templated 3D tensor derived from VectorSpace adding construction from
  29     9 components, element access using xx(), xy() etc. member functions and
  30     the inner-product (dot-product) and outer-product of two Vectors
  31     (tensor-product) operators.
  32
  33 SourceFiles
  34     TensorI.H
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef Tensor_H
  39 #define Tensor_H
  40
  41 #include "Vector.H"
  42 #include "SphericalTensor.H"
  43 #include "SymmTensor.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class Tensor Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 template <class Cmpt>
  55 class Tensor
  56 :
  57     public VectorSpace<Tensor<Cmpt>, Cmpt, 9>
  58 {
  59
  60 public:
  61
  62     //- Equivalent type of labels used for valid component indexing
  63     typedef Tensor<label> labelType;
  64
  65
  66     // Member constants
  67
  68         enum
  69         {
  70             rank = 2 // Rank of Tensor is 2
  71         };
  72
  73
  74     // Static data members
  75
  76         static const char* const typeName;
  77         static const char* componentNames[];
  78
  79         static const Tensor zero;
  80         static const Tensor one;
  81         static const Tensor max;
  82         static const Tensor min;
  83
  84
  85     //- Component labeling enumeration
  86     enum components { XX, XY, XZ, YX, YY, YZ, ZX, ZY, ZZ };
  87
  88
  89     // Constructors
  90
  91         //- Construct null
  92         inline Tensor();
  93
  94         //- Construct given VectorSpace
  95         inline Tensor(const VectorSpace<Tensor<Cmpt>, Cmpt, 9>&);
  96
  97         //- Construct given SphericalTensor
  98         inline Tensor(const SphericalTensor<Cmpt>&);
  99
 100         //- Construct given SymmTensor
 101         inline Tensor(const SymmTensor<Cmpt>&);
 102
 103         //- Construct given the three vector components
 104         inline Tensor
 105         (
 106             const Vector<Cmpt>& x,
 107             const Vector<Cmpt>& y,
 108             const Vector<Cmpt>& z
 109         );
 110
 111         //- Construct given the nine components
 112         inline Tensor
 113         (
 114             const Cmpt txx, const Cmpt txy, const Cmpt txz,
 115             const Cmpt tyx, const Cmpt tyy, const Cmpt tyz,
 116             const Cmpt tzx, const Cmpt tzy, const Cmpt tzz
 117         );
 118
 119         //- Construct from Istream
 120         Tensor(Istream&);
 121
 122
 123     // Member Functions
 124
 125         // Access
 126
 127             inline const Cmpt& xx() const;
 128             inline const Cmpt& xy() const;
 129             inline const Cmpt& xz() const;
 130             inline const Cmpt& yx() const;
 131             inline const Cmpt& yy() const;
 132             inline const Cmpt& yz() const;
 133             inline const Cmpt& zx() const;
 134             inline const Cmpt& zy() const;
 135             inline const Cmpt& zz() const;
 136
 137             inline Cmpt& xx();
 138             inline Cmpt& xy();
 139             inline Cmpt& xz();
 140             inline Cmpt& yx();
 141             inline Cmpt& yy();
 142             inline Cmpt& yz();
 143             inline Cmpt& zx();
 144             inline Cmpt& zy();
 145             inline Cmpt& zz();
 146
 147             // Access vector components.
 148             // Note: returning const only to find out lhs usage
 149
 150             inline const Vector<Cmpt> x() const;
 151             inline const Vector<Cmpt> y() const;
 152             inline const Vector<Cmpt> z() const;
 153
 154         //- Transpose
 155         inline Tensor<Cmpt> T() const;
 156
 157
 158     // Member Operators
 159
 160         //- Assign to a SphericalTensor
 161         inline void operator=(const SphericalTensor<Cmpt>&);
 162
 163         //- Assign to a SymmTensor
 164         inline void operator=(const SymmTensor<Cmpt>&);
 165 };
 166
 167
 168 template<class Cmpt>
 169 class typeOfRank<Cmpt, 2>
 170 {
 171 public:
 172
 173     typedef Tensor<Cmpt> type;
 174 };
 175
 176
 177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 178
 179 } // End namespace Foam
 180
 181 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 182
 183 // Include inline implementations
 184 #include "TensorI.H"
 185
 186 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 187
 188 #endif
 189
 190 // ************************************************************************* //