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