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