src/VectorN/OpenFOAM/primitives/DiagTensorN.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     DiagTensorN
  27
  28 Description
  29     Templated NXN DiagTensor derived from VectorSpace adding construction from
  30     N components, and the inner-product (dot-product) and outer-product operators.
  31
  32 SourceFiles
  33     DiagTensorNI.H
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef DiagTensorN_H
  38 #define DiagTensorN_H
  39
  40 #include "VectorN.H"
  41 #include "SphericalTensorN.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class DiagTensor Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 template <class Cmpt, int length>
  53 class DiagTensorN
  54 :
  55     public VectorSpace<DiagTensorN<Cmpt, length>, Cmpt, length>
  56 {
  57
  58 public:
  59
  60     // Member constants
  61
  62         enum
  63         {
  64             rank = 2, // Rank of DiagTensor is 2
  65             rowLength = length
  66         };
  67
  68
  69     // Static data members
  70
  71         static const char* const typeName;
  72         static const char* componentNames[];
  73         static const DiagTensorN zero;
  74         static const DiagTensorN one;
  75         static const DiagTensorN I;
  76
  77
  78     // Constructors
  79
  80         //- Construct null
  81         inline DiagTensorN();
  82
  83         //- Construct given VectorSpace
  84         inline DiagTensorN(const VectorSpace<DiagTensorN<Cmpt, length>, Cmpt, length>&);
  85
  86         //- Construct from Istream
  87         inline DiagTensorN(Istream&);
  88
  89         //- Construct given component value.  Special use only!
  90         explicit inline DiagTensorN(const Cmpt& tx);
  91
  92
  93     // Member Functions
  94
  95         //- Diagonal
  96         inline DiagTensorN<Cmpt, length> diag() const;
  97
  98         //- Transpose
  99         inline DiagTensorN<Cmpt, length> T() const;
 100
 101     // Member Operators
 102
 103         //- Assign to a SphericalTensorN
 104         inline void operator=(const SphericalTensorN<Cmpt, length>&);
 105
 106 };
 107
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 } // End namespace Foam
 112
 113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 114
 115 // Include inline implementations
 116 #include "DiagTensorNI.H"
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 #endif
 121
 122 // ************************************************************************* //