src/OpenFOAM/coordinateSystems/coordinateRotation/axisCoordinateRotation.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     axisCoordinateRotation
  27
  28 Description
  29     The 3 rotations are defined in the axis convention
  30     (around X, around Y and around Z).
  31     For reference and illustration, see
  32     http://mathworld.wolfram.com/RotationMatrix.html
  33
  34 AUTHOR
  35     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef axisCoordinateRotation_H
  40 #define axisCoordinateRotation_H
  41
  42 #include "coordinateRotation.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                    Class axisCoordinateRotation Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class axisCoordinateRotation
  54 :
  55     public coordinateRotation
  56 {
  57     // Private member functions
  58
  59         //- Calculate transformation tensor
  60         void calcTransform
  61         (
  62             const scalar phiAngle,
  63             const scalar thetaAngle,
  64             const scalar psiAngle,
  65             const bool inDegrees = true
  66         );
  67
  68
  69 public:
  70
  71     //- Runtime type information
  72     TypeName("axisRotation");
  73
  74
  75     // Constructors
  76
  77         //- Construct null
  78         axisCoordinateRotation();
  79
  80         //- Construct from components of rotation vector
  81         axisCoordinateRotation
  82         (
  83             const scalar phiAngle,
  84             const scalar thetaAngle,
  85             const scalar psiAngle,
  86             const bool inDegrees = true
  87         );
  88
  89         //- Construct from dictionary
  90         axisCoordinateRotation(const dictionary&);
  91 };
  92
  93
  94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  95
  96 } // End namespace Foam
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 #endif
 101
 102 // ************************************************************************* //