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