src/OpenFOAM/primitives/DiagTensor/DiagTensor.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     Foam::DiagTensor
  27
  28 Description
  29     Templated 3D DiagTensor derived from VectorSpace.
  30
  31     Adding construction from 3 components, element access using xx(), yy()
  32     and zz() member functions and the inner-product (dot-product) and
  33     outer-product operators.
  34
  35 SourceFiles
  36     DiagTensorI.H
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef DiagTensor_H
  41 #define DiagTensor_H
  42
  43 #include "Tensor.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class DiagTensor Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 template <class Cmpt>
  55 class DiagTensor
  56 :
  57     public VectorSpace<DiagTensor<Cmpt>, Cmpt, 3>
  58 {
  59
  60 public:
  61
  62     // Member constants
  63
  64         enum
  65         {
  66             rank = 2 // Rank of DiagTensor is 2
  67         };
  68
  69
  70     // Static data members
  71
  72         static const char* const typeName;
  73         static const char* componentNames[];
  74         static const DiagTensor zero;
  75         static const DiagTensor one;
  76         static const DiagTensor max;
  77         static const DiagTensor min;
  78
  79
  80     //- Component labeling enumeration
  81     enum components { XX, YY, ZZ };
  82
  83
  84     // Constructors
  85
  86         //- Construct null
  87         inline DiagTensor();
  88
  89         //- Construct given VectorSpace
  90         inline DiagTensor(const VectorSpace<DiagTensor<Cmpt>, Cmpt, 3>&);
  91
  92         //- Construct given three components
  93         inline DiagTensor(const Cmpt& txx, const Cmpt& tyy, const Cmpt& tzz);
  94
  95         //- Construct from Istream
  96         inline DiagTensor(Istream&);
  97
  98
  99     // Member Functions
 100
 101         // Access
 102
 103             inline const Cmpt& xx() const;
 104             inline const Cmpt& yy() const;
 105             inline const Cmpt& zz() const;
 106
 107             inline Cmpt& xx();
 108             inline Cmpt& yy();
 109             inline Cmpt& zz();
 110 };
 111
 112
 113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 114
 115 } // End namespace Foam
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 // Include inline implementations
 120 #include "DiagTensorI.H"
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 #endif
 125
 126 // ************************************************************************* //