src/OpenFOAM/coordinateSystems/coordinateRotation/STARCDCoordinateRotation.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::STARCDCoordinateRotation
  27
  28 Description
  29     A coordinateRotation defined by the STAR-CD convention.
  30
  31     The 3 rotations are defined in the STAR-CD convention
  32     (around Z, around X' and around Y'').
  33     The order of the parameter arguments matches this rotation order.
  34
  35     - the rotation angles are in degrees, unless otherwise explictly specified:
  36
  37     @verbatim
  38         coordinateRotation
  39         {
  40             type        STARCDRotation;
  41             degrees     false;
  42             rotation    (0 0 3.141592654);
  43         }
  44     @endverbatim
  45
  46 \*---------------------------------------------------------------------------*/
  47
  48 #ifndef STARCDCoordinateRotation_H
  49 #define STARCDCoordinateRotation_H
  50
  51 #include "coordinateRotation.H"
  52
  53 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  54
  55 namespace Foam
  56 {
  57
  58 /*---------------------------------------------------------------------------*\
  59                   Class STARCDCoordinateRotation Declaration
  60 \*---------------------------------------------------------------------------*/
  61
  62 class STARCDCoordinateRotation
  63 :
  64     public coordinateRotation
  65 {
  66     // Private member functions
  67
  68         //- Calculate transformation tensor
  69         void calcTransform
  70         (
  71             const scalar rotZ,
  72             const scalar rotX,
  73             const scalar rotY,
  74             const bool inDegrees = true
  75         );
  76
  77
  78 public:
  79
  80     //- Runtime type information
  81     TypeName("STARCDRotation");
  82
  83
  84     // Constructors
  85
  86         //- Construct null
  87         STARCDCoordinateRotation();
  88
  89         //- Construct from rotation vector
  90         STARCDCoordinateRotation
  91         (
  92             const vector& rotZrotXrotY,
  93             const bool inDegrees = true
  94         );
  95
  96         //- Construct from components of rotation vector
  97         STARCDCoordinateRotation
  98         (
  99             const scalar rotZ,
 100             const scalar rotX,
 101             const scalar rotY,
 102             const bool inDegrees = true
 103         );
 104
 105         //- Construct from dictionary
 106         STARCDCoordinateRotation(const dictionary&);
 107
 108 };
 109
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 } // End namespace Foam
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 #endif
 118
 119 // ************************************************************************* //