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