src/VectorN/OpenFOAM/primitives/SphericalTensorN.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     SphericalTensorN
  27
  28 Description
  29     Templated NXN SphericalTensor derived from VectorSpace adding construction from
  30     N components, and the inner-product (dot-product) and outer-product operators.
  31
  32 SourceFiles
  33     SphericalTensorNI.H
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef SphericalTensorN_H
  38 #define SphericalTensorN_H
  39
  40 #include "VectorN.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class DiagTensor Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template <class Cmpt, int length>
  52 class SphericalTensorN
  53 :
  54     public VectorSpace<SphericalTensorN<Cmpt, length>, Cmpt, 1>
  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 SphericalTensorN zero;
  73         static const SphericalTensorN one;
  74         static const SphericalTensorN I;
  75
  76
  77     // Constructors
  78
  79         //- Construct null
  80         inline SphericalTensorN();
  81
  82         //- Construct given VectorSpace
  83         inline SphericalTensorN(const VectorSpace<SphericalTensorN<Cmpt, length>, Cmpt, 1>&);
  84
  85         //- Construct from Istream
  86         inline SphericalTensorN(Istream&);
  87
  88         //- Construct given component value.  Special use only!
  89         explicit inline SphericalTensorN(const Cmpt& tx);
  90
  91
  92     // Member Functions
  93
  94         //- Diagonal
  95         inline SphericalTensorN<Cmpt, length> diag() const;
  96
  97         //- Transpose
  98         inline SphericalTensorN<Cmpt, length> T() const;
  99 };
 100
 101
 102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 103
 104 } // End namespace Foam
 105
 106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 107
 108 // Include inline implementations
 109 #include "SphericalTensorNI.H"
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 #endif
 114
 115 // ************************************************************************* //