src/OpenFOAM/primitives/tensor/tensor.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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 Typedef
  26     Foam::tensor
  27
  28 Description
  29     Tensor or scalars.
  30
  31 SourceFiles
  32     tensor.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef tensor_H
  37 #define tensor_H
  38
  39 #include "Tensor.H"
  40 #include "vector.H"
  41 #include "sphericalTensor.H"
  42 #include "symmTensor.H"
  43 #include "contiguous.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  51
  52 typedef Tensor<scalar> tensor;
  53
  54 vector eigenValues(const tensor& t);
  55 vector eigenVector(const tensor& t, const scalar lambda);
  56 tensor eigenVectors(const tensor& t);
  57
  58 vector eigenValues(const symmTensor& t);
  59 vector eigenVector(const symmTensor& t, const scalar lambda);
  60 tensor eigenVectors(const symmTensor& t);
  61
  62 //- Specify data associated with tensor type is contiguous
  63 template<>
  64 inline bool contiguous<tensor>() {return true;}
  65
  66
  67 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  68
  69 } // End namespace Foam
  70
  71 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  72
  73 #endif
  74
  75 // ************************************************************************* //