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