src/foam/primitives/expandContract/expandTensor.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     |
   5     \\  /    A nd           | For copyright notice see file Copyright
   6      \\/     M anipulation  |
   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 Description
  25     Global functions for expansion and contraction of tensor coefficient
  26     to diagonal type
  27
  28 Author
  29     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef expandTensor_H
  34 #define expandTensor_H
  35
  36 #include "Tensor.H"
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42
  43 //- Return the diagonal of a tensor as a scalar
  44 template <class Cmpt>
  45 inline void contractScalar(Cmpt& result, const Tensor<Cmpt>& t)
  46 {
  47     result = 1.0/3.0*(t.xx() + t.yy() + t.zz());
  48 }
  49
  50
  51 //- Return the diagonal of a tensor as a scalar
  52 template <class Cmpt>
  53 inline Cmpt contractScalar(const Tensor<Cmpt>& t)
  54 {
  55     Cmpt result;
  56     contractScalar(result, t);
  57     return result;
  58 }
  59
  60
  61 //- Return the diagonal of a tensor as a vector
  62 template <class Cmpt>
  63 inline void contractLinear(Vector<Cmpt>& result, const Tensor<Cmpt>& t)
  64 {
  65     result = Vector<Cmpt>(t.xx(), t.yy(), t.zz());
  66 }
  67
  68
  69 //- Return the diagonal of a tensor as a vector
  70 template <class Cmpt>
  71 inline Vector<Cmpt> contractLinear(const Tensor<Cmpt>& t)
  72 {
  73     Vector<Cmpt> result;
  74     contractLinear(result, t);
  75     return result;
  76 }
  77
  78
  79 //- Return the vector given a scalar
  80 template <class Cmpt>
  81 inline void expandScalar(Vector<Cmpt>& result, const Cmpt& v)
  82 {
  83     result = Vector<Cmpt>(v, v, v);
  84 }
  85
  86
  87 //- Return the tensor given a scalar
  88 template <class Cmpt>
  89 inline void expandScalar(Tensor<Cmpt>& result, const Cmpt& v)
  90 {
  91     result = Tensor<Cmpt>
  92     (
  93         v,                    pTraits<Cmpt>::zero,     pTraits<Cmpt>::zero,
  94         pTraits<Cmpt>::zero,  v,                       pTraits<Cmpt>::zero,
  95         pTraits<Cmpt>::zero,  pTraits<Cmpt>::zero,     v
  96     );
  97 }
  98
  99
 100 //- Return the tensor given a diagonal vector
 101 template <class Cmpt>
 102 inline void expandLinear(Tensor<Cmpt>& result, const Vector<Cmpt>& v)
 103 {
 104     result = Tensor<Cmpt>
 105     (
 106         v.x(),                pTraits<Cmpt>::zero,     pTraits<Cmpt>::zero,
 107         pTraits<Cmpt>::zero,  v.y(),                   pTraits<Cmpt>::zero,
 108         pTraits<Cmpt>::zero,  pTraits<Cmpt>::zero,     v.z()
 109     );
 110 }
 111
 112
 113 } // End namespace Foam
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 #endif
 118
 119 // ************************************************************************* //