src/foam/primitives/Tensor/tensor/tensor.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 Typedef
  25     Foam::tensor
  26
  27 Description
  28     Tensor of scalars.
  29
  30 SourceFiles
  31     tensor.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef tensor_H
  36 #define tensor_H
  37
  38 #include "TensorTemplate.H"
  39 #include "vector.H"
  40 #include "sphericalTensor.H"
  41 #include "symmTensor.H"
  42 #include "contiguous.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  50
  51 typedef Tensor<scalar> tensor;
  52
  53 vector eigenValues(const tensor&);
  54 vector eigenVector(const tensor&, const scalar lambda);
  55 tensor eigenVectors(const tensor&);
  56
  57 vector eigenValues(const symmTensor&);
  58 vector eigenVector(const symmTensor&, const scalar lambda);
  59 tensor eigenVectors(const symmTensor&);
  60
  61 // Tensor inverse with singular value decomposition
  62 // (Householder transformations)
  63 // HJ, 24/Oct/2009
  64 tensor hinv(const tensor& t);
  65 symmTensor hinv(const symmTensor& t);
  66
  67
  68 //- Data associated with tensor type are contiguous
  69 template<>
  70 inline bool contiguous<tensor>() {return true;}
  71
  72
  73 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  74
  75 } // End namespace Foam
  76
  77 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  78
  79 #endif
  80
  81 // ************************************************************************* //