FreeFOAM The Cross-Platform CFD Toolkit
cylindricalCS.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::cylindricalCS
26 
27 Description
28  Cylindrical coordinate system
29 
30 SourceFiles
31  cylindricalCS.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef cylindricalCS_H
36 #define cylindricalCS_H
37 
38 #include "coordinateSystem.H"
39 #include <OpenFOAM/typeInfo.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class cylindricalCS Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public coordinateSystem
53 {
54  // Private data members
55 
56  //- Are angles in degrees? (default = true)
57  bool inDegrees_;
58 
59 
60 protected:
61 
62  // Protected Member Functions
63 
64  //- Convert from local coordinate system to the global Cartesian system
65  // with optional translation for the origin
66  virtual vector localToGlobal(const vector&, bool translate) const;
67 
68  //- Convert from local coordinate system to the global Cartesian system
69  // with optional translation for the origin
71  (
72  const vectorField&,
73  bool translate
74  ) const;
75 
76  //- Convert from global Cartesian system to the local coordinate system
77  // with optional translation for the origin
78  virtual vector globalToLocal(const vector&, bool translate) const;
79 
80  //- Convert from global Cartesian system to the local coordinate system
81  // with optional translation for the origin
83  (
84  const vectorField&,
85  bool translate
86  ) const;
87 
88 public:
89 
90  //- Runtime type information
91  TypeName("cylindrical");
92 
93 
94  // Constructors
95 
96  //- Construct null
97  cylindricalCS(const bool inDegrees=true);
98 
99  //- Construct copy
101  (
102  const coordinateSystem&,
103  const bool inDegrees=true
104  );
105 
106  //- Construct copy with a different name
108  (
109  const word& name,
110  const coordinateSystem&,
111  const bool inDegrees=true
112  );
113 
114  //- Construct from origin and rotation
116  (
117  const word& name,
118  const point& origin,
119  const coordinateRotation&,
120  const bool inDegrees=true
121  );
122 
123  //- Construct from origin and 2 axes
125  (
126  const word& name,
127  const point& origin,
128  const vector& axis,
129  const vector& dirn,
130  const bool inDegrees=true
131  );
132 
133  //- Construct from dictionary
134  cylindricalCS(const word& name, const dictionary&);
135 
136 
137  // Member Functions
138 
139  //- Are angles in degrees?
140  bool inDegrees() const;
141 
142  //- Non-const access to inDegrees
143  bool& inDegrees();
144 
145 };
146 
147 
148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
149 
150 } // End namespace Foam
151 
152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
153 
154 #endif
155 
156 // ************************ vim: set sw=4 sts=4 et: ************************ //