src/OpenFOAM/primitives/transform/transform.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 InNamespace
  26     Foam
  27
  28 Description
  29     3D tensor transformation operations.
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef transform_H
  34 #define transform_H
  35
  36 #include "tensor.H"
  37 #include "mathematicalConstants.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 inline tensor rotationTensor
  47 (
  48     const vector& n1,
  49     const vector& n2
  50 )
  51 {
  52     return
  53         (n1 & n2)*I
  54       + (1 - (n1 & n2))*sqr(n1 ^ n2)/(magSqr(n1 ^ n2) + VSMALL)
  55       + (n2*n1 - n1*n2);
  56 }
  57
  58
  59 inline label transform(const tensor&, const label i)
  60 {
  61     return i;
  62 }
  63
  64
  65 inline scalar transform(const tensor&, const scalar s)
  66 {
  67     return s;
  68 }
  69
  70
  71 template<class Cmpt>
  72 inline Vector<Cmpt> transform(const tensor& tt, const Vector<Cmpt>& v)
  73 {
  74     return tt & v;
  75 }
  76
  77
  78 template<class Cmpt>
  79 inline Tensor<Cmpt> transform(const tensor& tt, const Tensor<Cmpt>& t)
  80 {
  81     //return tt & t & tt.T();
  82     return Tensor<Cmpt>
  83     (
  84         (tt.xx()*t.xx() + tt.xy()*t.yx() + tt.xz()*t.zx())*tt.xx()
  85       + (tt.xx()*t.xy() + tt.xy()*t.yy() + tt.xz()*t.zy())*tt.xy()
  86       + (tt.xx()*t.xz() + tt.xy()*t.yz() + tt.xz()*t.zz())*tt.xz(),
  87
  88         (tt.xx()*t.xx() + tt.xy()*t.yx() + tt.xz()*t.zx())*tt.yx()
  89       + (tt.xx()*t.xy() + tt.xy()*t.yy() + tt.xz()*t.zy())*tt.yy()
  90       + (tt.xx()*t.xz() + tt.xy()*t.yz() + tt.xz()*t.zz())*tt.yz(),
  91
  92         (tt.xx()*t.xx() + tt.xy()*t.yx() + tt.xz()*t.zx())*tt.zx()
  93       + (tt.xx()*t.xy() + tt.xy()*t.yy() + tt.xz()*t.zy())*tt.zy()
  94       + (tt.xx()*t.xz() + tt.xy()*t.yz() + tt.xz()*t.zz())*tt.zz(),
  95
  96         (tt.yx()*t.xx() + tt.yy()*t.yx() + tt.yz()*t.zx())*tt.xx()
  97       + (tt.yx()*t.xy() + tt.yy()*t.yy() + tt.yz()*t.zy())*tt.xy()
  98       + (tt.yx()*t.xz() + tt.yy()*t.yz() + tt.yz()*t.zz())*tt.xz(),
  99
 100         (tt.yx()*t.xx() + tt.yy()*t.yx() + tt.yz()*t.zx())*tt.yx()
 101       + (tt.yx()*t.xy() + tt.yy()*t.yy() + tt.yz()*t.zy())*tt.yy()
 102       + (tt.yx()*t.xz() + tt.yy()*t.yz() + tt.yz()*t.zz())*tt.yz(),
 103
 104         (tt.yx()*t.xx() + tt.yy()*t.yx() + tt.yz()*t.zx())*tt.zx()
 105       + (tt.yx()*t.xy() + tt.yy()*t.yy() + tt.yz()*t.zy())*tt.zy()
 106       + (tt.yx()*t.xz() + tt.yy()*t.yz() + tt.yz()*t.zz())*tt.zz(),
 107
 108         (tt.zx()*t.xx() + tt.zy()*t.yx() + tt.zz()*t.zx())*tt.xx()
 109       + (tt.zx()*t.xy() + tt.zy()*t.yy() + tt.zz()*t.zy())*tt.xy()
 110       + (tt.zx()*t.xz() + tt.zy()*t.yz() + tt.zz()*t.zz())*tt.xz(),
 111
 112         (tt.zx()*t.xx() + tt.zy()*t.yx() + tt.zz()*t.zx())*tt.yx()
 113       + (tt.zx()*t.xy() + tt.zy()*t.yy() + tt.zz()*t.zy())*tt.yy()
 114       + (tt.zx()*t.xz() + tt.zy()*t.yz() + tt.zz()*t.zz())*tt.yz(),
 115
 116         (tt.zx()*t.xx() + tt.zy()*t.yx() + tt.zz()*t.zx())*tt.zx()
 117       + (tt.zx()*t.xy() + tt.zy()*t.yy() + tt.zz()*t.zy())*tt.zy()
 118       + (tt.zx()*t.xz() + tt.zy()*t.yz() + tt.zz()*t.zz())*tt.zz()
 119     );
 120 }
 121
 122
 123 template<class Cmpt>
 124 inline SphericalTensor<Cmpt> transform
 125 (
 126     const tensor& tt,
 127     const SphericalTensor<Cmpt>& st
 128 )
 129 {
 130     return st;
 131 }
 132
 133
 134 template<class Cmpt>
 135 inline SymmTensor<Cmpt> transform(const tensor& tt, const SymmTensor<Cmpt>& st)
 136 {
 137     return SymmTensor<Cmpt>
 138     (
 139         (tt.xx()*st.xx() + tt.xy()*st.xy() + tt.xz()*st.xz())*tt.xx()
 140       + (tt.xx()*st.xy() + tt.xy()*st.yy() + tt.xz()*st.yz())*tt.xy()
 141       + (tt.xx()*st.xz() + tt.xy()*st.yz() + tt.xz()*st.zz())*tt.xz(),
 142
 143         (tt.xx()*st.xx() + tt.xy()*st.xy() + tt.xz()*st.xz())*tt.yx()
 144       + (tt.xx()*st.xy() + tt.xy()*st.yy() + tt.xz()*st.yz())*tt.yy()
 145       + (tt.xx()*st.xz() + tt.xy()*st.yz() + tt.xz()*st.zz())*tt.yz(),
 146
 147         (tt.xx()*st.xx() + tt.xy()*st.xy() + tt.xz()*st.xz())*tt.zx()
 148       + (tt.xx()*st.xy() + tt.xy()*st.yy() + tt.xz()*st.yz())*tt.zy()
 149       + (tt.xx()*st.xz() + tt.xy()*st.yz() + tt.xz()*st.zz())*tt.zz(),
 150
 151         (tt.yx()*st.xx() + tt.yy()*st.xy() + tt.yz()*st.xz())*tt.yx()
 152       + (tt.yx()*st.xy() + tt.yy()*st.yy() + tt.yz()*st.yz())*tt.yy()
 153       + (tt.yx()*st.xz() + tt.yy()*st.yz() + tt.yz()*st.zz())*tt.yz(),
 154
 155         (tt.yx()*st.xx() + tt.yy()*st.xy() + tt.yz()*st.xz())*tt.zx()
 156       + (tt.yx()*st.xy() + tt.yy()*st.yy() + tt.yz()*st.yz())*tt.zy()
 157       + (tt.yx()*st.xz() + tt.yy()*st.yz() + tt.yz()*st.zz())*tt.zz(),
 158
 159         (tt.zx()*st.xx() + tt.zy()*st.xy() + tt.zz()*st.xz())*tt.zx()
 160       + (tt.zx()*st.xy() + tt.zy()*st.yy() + tt.zz()*st.yz())*tt.zy()
 161       + (tt.zx()*st.xz() + tt.zy()*st.yz() + tt.zz()*st.zz())*tt.zz()
 162     );
 163 }
 164
 165
 166 template<class Type1, class Type2>
 167 inline Type1 transformMask(const Type2& t)
 168 {
 169     return t;
 170 }
 171
 172
 173 template<>
 174 inline sphericalTensor transformMask<sphericalTensor>(const tensor& t)
 175 {
 176     return sph(t);
 177 }
 178
 179
 180 template<>
 181 inline symmTensor transformMask<symmTensor>(const tensor& t)
 182 {
 183     return symm(t);
 184 }
 185
 186 //- Estimate angle of vec in coordinate system (e0, e1, e0^e1).
 187 //  Is guaranteed to return increasing number but is not correct
 188 //  angle. Used for sorting angles.  All input vectors need to be normalized.
 189 //
 190 // Calculates scalar which increases with angle going from e0 to vec in
 191 // the coordinate system e0, e1, e0^e1
 192 //
 193 // Jumps from 2PI -> 0 at -SMALL so parallel vectors with small rounding errors
 194 // should hopefully still get the same quadrant.
 195 //
 196 inline scalar pseudoAngle
 197 (
 198     const vector& e0,
 199     const vector& e1,
 200     const vector& vec
 201 )
 202 {
 203     scalar cos = vec & e0;
 204     scalar sin = vec & e1;
 205
 206     if (sin < -SMALL)
 207     {
 208         return (3.0 + cos)*mathematicalConstant::piByTwo;
 209     }
 210     else
 211     {
 212         return (1.0 - cos)*mathematicalConstant::piByTwo;
 213     }
 214 }
 215
 216
 217 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 218
 219 } // End namespace Foam
 220
 221 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 222
 223 #endif
 224
 225 // ************************************************************************* //