src/foam/primitives/VectorN/TensorN.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     TensorN
  26
  27 Description
  28
  29 SourceFiles
  30     TensorNI.H
  31
  32 \*---------------------------------------------------------------------------*/
  33
  34 #ifndef TensorN_H
  35 #define TensorN_H
  36
  37 #include "VectorN.H"
  38 #include "SphericalTensorN.H"
  39 #include "DiagTensorN.H"
  40
  41 // * * * * * * * * * * * * * Forward Declarations  * * * * * * * * * * * * * //
  42
  43 template <class Cmpt, int length>
  44 class DiagTensorN;
  45
  46 template <class Cmpt, int length>
  47 class SphericalTensorN;
  48
  49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  50
  51 namespace Foam
  52 {
  53
  54 /*---------------------------------------------------------------------------*\
  55                            Class TensorN Declaration
  56 \*---------------------------------------------------------------------------*/
  57
  58 template <class Cmpt, int length>
  59 class TensorN
  60 :
  61     public VectorSpace<TensorN<Cmpt, length>, Cmpt, length*length>
  62 {
  63
  64 public:
  65
  66     // Member constants
  67
  68         enum
  69         {
  70             rank = 2,            // Rank of TensorN is 2
  71             rowLength = length   // Number of components in a row
  72         };
  73
  74
  75     // Static data members
  76
  77         static const char* const typeName;
  78
  79         static const TensorN zero;
  80         static const TensorN one;
  81
  82
  83     // Constructors
  84
  85         //- Construct null
  86         inline TensorN();
  87
  88         //- Construct given VectorSpace
  89         inline TensorN
  90         (
  91             const VectorSpace<TensorN<Cmpt, length>, Cmpt, length*length>&
  92         );
  93
  94         //- Construct given component value.  Special use only!
  95         explicit inline TensorN(const Cmpt& tx);
  96
  97         //- Construct from Istream
  98         TensorN(Istream&);
  99
 100
 101     // Member Functions
 102
 103         //- Return direction given (i, j) indices
 104         static inline direction cmpt
 105         (
 106             const direction i,
 107             const direction j
 108         );
 109
 110         //- Return (i, j) component
 111         inline const Cmpt& operator()
 112         (
 113             const direction i,
 114             const direction j
 115         ) const;
 116
 117         //- Return access to (i, j) component
 118         inline Cmpt& operator()
 119         (
 120             const direction i,
 121             const direction j
 122         );
 123
 124         //- Diagonal
 125         inline DiagTensorN<Cmpt, length> diag() const;
 126
 127         //- Transpose
 128         inline TensorN<Cmpt, length> T() const;
 129
 130         //- Negative sum the vertical off-diagonal components
 131         inline TensorN<Cmpt, length> negSumDiag() const;
 132
 133     // Member Operators
 134
 135         //- Assign to a SphericalTensorN
 136         inline void operator=(const SphericalTensorN<Cmpt, length>&);
 137
 138         //- Assign to a DiagTensorN
 139         inline void operator=(const DiagTensorN<Cmpt, length>&);
 140 };
 141
 142
 143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 144
 145 } // End namespace Foam
 146
 147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 148
 149 // Include inline implementations
 150 #include "TensorNI.H"
 151
 152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 153
 154 #endif
 155
 156 // ************************************************************************* //