src/blockMatrix/expandContract/expandTensor.H

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