src/OpenFOAM/primitives/quaternion/quaternion.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 Class
  26     Foam::quaternion
  27
  28 Description
  29     Quaternion class used to perform rotations in 3D space.
  30
  31 SourceFiles
  32     quaternionI.H
  33     quaternion.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef quaternion_H
  38 #define quaternion_H
  39
  40 #include "scalar.H"
  41 #include "vector.H"
  42 #include "tensor.H"
  43 #include "word.H"
  44 #include "contiguous.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 // Forward declaration of friend functions and operators
  52
  53 class quaternion;
  54 Istream& operator>>(Istream& is, quaternion&);
  55 Ostream& operator<<(Ostream& os, const quaternion& C);
  56
  57
  58 /*---------------------------------------------------------------------------*\
  59                            Class quaternion Declaration
  60 \*---------------------------------------------------------------------------*/
  61
  62 class quaternion
  63 {
  64     // private data
  65
  66         //- Scalar part of the quaternion ( = cos(theta/2) for rotation)
  67         scalar w_;
  68
  69         //- Vector part of the quaternion ( = axis of rotation)
  70         vector v_;
  71
  72
  73         //- Multiply vector v by quaternion as if v is a pure quaternion
  74         inline quaternion mulq0v(const vector& v) const;
  75
  76
  77 public:
  78
  79     // Static data members
  80
  81         static const char* const typeName;
  82
  83         static const quaternion zero;
  84         static const quaternion I;
  85
  86
  87     // Constructors
  88
  89         //- Construct null
  90         inline quaternion();
  91
  92         //- Construct given scalar and vector parts
  93         inline quaternion(const scalar w, const vector& v);
  94
  95         //- Construct a rotation quaternion given the direction d
  96         //  and angle theta
  97         inline quaternion(const vector& d, const scalar theta);
  98
  99         //- Construct given scalar part, the vector part = vector::zero
 100         inline explicit quaternion(const scalar w);
 101
 102         //- Construct a pure quaternion given the vector part, scalar part = 0
 103         inline explicit quaternion(const vector& v);
 104
 105         //- Construct a quaternion given the three Euler angles
 106         inline quaternion
 107         (
 108             const scalar angleX,
 109             const scalar angleY,
 110             const scalar angleZ
 111         );
 112
 113         //- Construct from Istream
 114         quaternion(Istream&);
 115
 116
 117     // Member functions
 118
 119            // Access
 120
 121                //- Scalar part of the quaternion ( = cos(theta/2) for rotation)
 122                inline scalar w() const;
 123
 124                //- Vector part of the quaternion ( = axis of rotation)
 125                inline const vector& v() const;
 126
 127                //- The rotation tensor corresponding the quaternion
 128                inline tensor R() const;
 129
 130
 131            // Edit
 132
 133                //- Scalar part of the quaternion ( = cos(theta/2) for rotation)
 134                inline scalar& w();
 135
 136                //- Vector part of the quaternion ( = axis of rotation)
 137                inline vector& v();
 138
 139                inline void normalize();
 140
 141
 142            // Transform
 143
 144                //- Rotate the given vector
 145                inline vector transform(const vector& v) const;
 146
 147                //- Rotate the given vector anti-clockwise
 148                inline vector invTransform(const vector& v) const;
 149
 150                //- Rotate the given quaternion (and normalize)
 151                inline quaternion transform(const quaternion& q) const;
 152
 153                //- Rotate the given quaternion anti-clockwise (and normalize)
 154                inline quaternion invTransform(const quaternion& q) const;
 155
 156
 157     // Member operators
 158
 159         inline void operator=(const quaternion&);
 160         inline void operator+=(const quaternion&);
 161         inline void operator-=(const quaternion&);
 162         inline void operator*=(const quaternion&);
 163         inline void operator/=(const quaternion&);
 164
 165         inline void operator=(const scalar);
 166
 167         inline void operator=(const vector&);
 168
 169         inline void operator*=(const scalar);
 170         inline void operator/=(const scalar);
 171
 172
 173     // IOstream operators
 174
 175         friend Istream& operator>>(Istream& is, quaternion&);
 176         friend Ostream& operator<<(Ostream& os, const quaternion& C);
 177 };
 178
 179
 180 // * * * * * * * * * * * * * * * Global Functions  * * * * * * * * * * * * * //
 181
 182 inline scalar magSqr(const quaternion& q);
 183 inline scalar mag(const quaternion& q);
 184
 185 //- Return the conjugate of the given quaternion
 186 inline quaternion conjugate(const quaternion& q);
 187
 188 //- Return the normailzed (unit) quaternion of the given quaternion
 189 inline quaternion normalize(const quaternion& q);
 190
 191 //- Return the inverse of the given quaternion
 192 inline quaternion inv(const quaternion& q);
 193
 194 //- Return a string representation of a quaternion
 195 word name(const quaternion&);
 196
 197 //- Data associated with quaternion type are contiguous
 198 template<>
 199 inline bool contiguous<quaternion>() {return true;}
 200
 201
 202 // * * * * * * * * * * * * * * * Global Operators  * * * * * * * * * * * * * //
 203
 204 inline bool operator==(const quaternion& q1, const quaternion& q2);
 205 inline bool operator!=(const quaternion& q1, const quaternion& q2);
 206 inline quaternion operator+(const quaternion& q1, const quaternion& q2);
 207 inline quaternion operator-(const quaternion& q);
 208 inline quaternion operator-(const quaternion& q1, const quaternion& q2);
 209 inline scalar operator&(const quaternion& q1, const quaternion& q2);
 210 inline quaternion operator*(const quaternion& q1, const quaternion& q2);
 211 inline quaternion operator/(const quaternion& q1, const quaternion& q2);
 212 inline quaternion operator*(const scalar s, const quaternion& q);
 213 inline quaternion operator*(const quaternion& q, const scalar s);
 214 inline quaternion operator/(const quaternion& q, const scalar s);
 215
 216
 217 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 218
 219 } // End namespace Foam
 220
 221 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 222
 223 #include "quaternionI.H"
 224
 225 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 226
 227 #endif
 228
 229 // ************************************************************************* //