src/foam/primitives/Tensor2D/Tensor2DTemplate.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     Foam::Tensor2D
  26
  27 Description
  28     Templated 2D tensor derived from VectorSpace adding construction from
  29     4 components, element access using xx(), xy(), yx() and yy() member
  30     functions and the iner-product (dot-product) and outer-product of two
  31     Vector2Ds (tensor-product) operators.
  32
  33 SourceFiles
  34     Tensor2DTemplateI.H
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef Tensor2DTemplate_H
  39 #define Tensor2DTemplate_H
  40
  41 #include "Vector2DTemplate.H"
  42 #include "SphericalTensor2DTemplate.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class Tensor2D Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 template <class Cmpt>
  54 class Tensor2D
  55 :
  56     public VectorSpace<Tensor2D<Cmpt>, Cmpt, 4>
  57 {
  58
  59 public:
  60
  61     // Member constants
  62
  63         enum
  64         {
  65             rank = 2 // Rank of Tensor2D is 2
  66         };
  67
  68
  69     // Static data members
  70
  71         static const char* const typeName;
  72         static const char* componentNames[];
  73
  74         static const Tensor2D zero;
  75         static const Tensor2D one;
  76         static const Tensor2D max;
  77         static const Tensor2D min;
  78
  79
  80     //- Component labeling enumeration
  81     enum components { XX, XY, YX, YY };
  82
  83
  84     // Constructors
  85
  86         //- Construct null
  87         inline Tensor2D();
  88
  89         //- Construct given VectorSpace
  90         inline Tensor2D(const VectorSpace<Tensor2D<Cmpt>, Cmpt, 4>&);
  91
  92         //- Construct given SphericalTensor2D
  93         inline Tensor2D(const SphericalTensor2D<Cmpt>&);
  94
  95         //- Construct given the two vectors
  96         inline Tensor2D
  97         (
  98             const Vector2D<Cmpt>& x,
  99             const Vector2D<Cmpt>& y
 100         );
 101
 102         //- Construct given the four components
 103         inline Tensor2D
 104         (
 105             const Cmpt txx, const Cmpt txy,
 106             const Cmpt tyx, const Cmpt tyy
 107         );
 108
 109         //- Construct from Istream
 110         Tensor2D(Istream&);
 111
 112
 113     // Member Functions
 114
 115         // Access
 116
 117             inline const Cmpt& xx() const;
 118             inline const Cmpt& xy() const;
 119             inline const Cmpt& yx() const;
 120             inline const Cmpt& yy() const;
 121
 122             inline Cmpt& xx();
 123             inline Cmpt& xy();
 124             inline Cmpt& yx();
 125             inline Cmpt& yy();
 126
 127             // Access vector components.
 128
 129             inline Vector2D<Cmpt> x() const;
 130             inline Vector2D<Cmpt> y() const;
 131
 132             //- Return (i, j) component.  Consistency with VectorN
 133             inline const Cmpt& operator()
 134             (
 135                 const direction i,
 136                 const direction j
 137             ) const;
 138
 139             //- Return access to (i, j) component.  Consistency with VectorN
 140             inline Cmpt& operator()
 141             (
 142                 const direction i,
 143                 const direction j
 144             );
 145
 146
 147         //- Transpose
 148         inline Tensor2D<Cmpt> T() const;
 149
 150
 151     // Member Operators
 152
 153         //- Copy SphericalTensor2D
 154         inline void operator=(const SphericalTensor2D<Cmpt>&);
 155 };
 156
 157
 158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 159
 160 } // End namespace Foam
 161
 162 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 163
 164 // Include inline implementations
 165 #include "Tensor2DTemplateI.H"
 166
 167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 168
 169 #endif
 170
 171 // ************************************************************************* //