src/VectorN/OpenFOAM/primitives/TensorN.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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     TensorN
  27
  28 Description
  29
  30 SourceFiles
  31     TensorNI.H
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef TensorN_H
  36 #define TensorN_H
  37
  38 #include "VectorN.H"
  39 #include "SphericalTensorN.H"
  40 #include "DiagTensorN.H"
  41
  42 // * * * * * * * * * * * * * Forward Declarations  * * * * * * * * * * * * * //
  43
  44 template <class Cmpt, int length>
  45 class DiagTensorN;
  46
  47 template <class Cmpt, int length>
  48 class SphericalTensorN;
  49
  50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  51
  52 namespace Foam
  53 {
  54
  55 /*---------------------------------------------------------------------------*\
  56                            Class TensorN Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 template <class Cmpt, int length>
  60 class TensorN
  61 :
  62     public VectorSpace<TensorN<Cmpt, length>, Cmpt, length*length>
  63 {
  64
  65 public:
  66
  67     // Member constants
  68
  69         enum
  70         {
  71             rank = 2,            // Rank of TensorN is 2
  72             rowLength = length   // Number of components in a row
  73         };
  74
  75
  76     // Static data members
  77
  78         static const char* const typeName;
  79
  80         static const TensorN zero;
  81         static const TensorN one;
  82
  83
  84     // Constructors
  85
  86         //- Construct null
  87         inline TensorN();
  88
  89         //- Construct given VectorSpace
  90         inline TensorN
  91         (
  92             const VectorSpace<TensorN<Cmpt, length>, Cmpt, length*length>&
  93         );
  94
  95         //- Construct given component value.  Special use only!
  96         explicit inline TensorN(const Cmpt& tx);
  97
  98         //- Construct from Istream
  99         TensorN(Istream&);
 100
 101
 102     // Member Functions
 103
 104         //- Return (i, j) component
 105         inline const Cmpt& operator()
 106         (
 107             const direction i,
 108             const direction j
 109         ) const;
 110
 111         //- Return access to (i, j) component
 112         inline Cmpt& operator()
 113         (
 114             const direction i,
 115             const direction j
 116         );
 117
 118         //- Diagonal
 119         inline DiagTensorN<Cmpt, length> diag() const;
 120
 121         //- Transpose
 122         inline TensorN<Cmpt, length> T() const;
 123
 124         //- Negative sum the vertical off-diagonal components
 125         inline TensorN<Cmpt, length> negSumDiag() const;
 126
 127     // Member Operators
 128
 129         //- Assign to a SphericalTensorN
 130         inline void operator=(const SphericalTensorN<Cmpt, length>&);
 131
 132         //- Assign to a DiagTensorN
 133         inline void operator=(const DiagTensorN<Cmpt, length>&);
 134 };
 135
 136
 137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 138
 139 } // End namespace Foam
 140
 141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 142
 143 // Include inline implementations
 144 #include "TensorNI.H"
 145
 146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 147
 148 #endif
 149
 150 // ************************************************************************* //