src/OpenFOAM/primitives/Tensor2D/Tensor2D.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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::Tensor2D
  27
  28 Description
  29     Templated 2D tensor derived from VectorSpace adding construction from
  30     4 components, element access using xx(), xy(), yx() and yy() member
  31     functions and the iner-product (dot-product) and outer-product of two
  32     Vector2Ds (tensor-product) operators.
  33
  34 SourceFiles
  35     Tensor2DI.H
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef Tensor2D_H
  40 #define Tensor2D_H
  41
  42 #include "Vector2D.H"
  43 #include "SphericalTensor2D.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class Tensor2D Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 template <class Cmpt>
  55 class Tensor2D
  56 :
  57     public VectorSpace<Tensor2D<Cmpt>, Cmpt, 4>
  58 {
  59
  60 public:
  61
  62     // Member constants
  63
  64         enum
  65         {
  66             rank = 2 // Rank of Tensor2D is 2
  67         };
  68
  69
  70     // Static data members
  71
  72         static const char* const typeName;
  73         static const char* componentNames[];
  74
  75         static const Tensor2D zero;
  76         static const Tensor2D one;
  77         static const Tensor2D max;
  78         static const Tensor2D min;
  79
  80
  81     //- Component labeling enumeration
  82     enum components { XX, XY, YX, YY };
  83
  84
  85     // Constructors
  86
  87         //- Construct null
  88         inline Tensor2D();
  89
  90         //- Construct given VectorSpace
  91         inline Tensor2D(const VectorSpace<Tensor2D<Cmpt>, Cmpt, 4>&);
  92
  93         //- Construct given SphericalTensor2D
  94         inline Tensor2D(const SphericalTensor2D<Cmpt>&);
  95
  96         //- Construct given the nine components
  97         inline Tensor2D
  98         (
  99             const Cmpt txx, const Cmpt txy,
 100             const Cmpt tyx, const Cmpt tyy
 101         );
 102
 103         //- Construct from Istream
 104         Tensor2D(Istream&);
 105
 106
 107     // Member Functions
 108
 109         // Access
 110
 111             inline const Vector2D<Cmpt>& x() const;
 112             inline const Vector2D<Cmpt>& y() const;
 113
 114             inline Vector2D<Cmpt>& x();
 115             inline Vector2D<Cmpt>& y();
 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         //- Transpose
 128         inline Tensor2D<Cmpt> T() const;
 129
 130
 131     // Member Operators
 132
 133         //- Construct given SphericalTensor2D
 134         inline void operator=(const SphericalTensor2D<Cmpt>&);
 135 };
 136
 137
 138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 139
 140 } // End namespace Foam
 141
 142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 143
 144 // Include inline implementations
 145 #include "Tensor2DI.H"
 146
 147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 148
 149 #endif
 150
 151 // ************************************************************************* //