Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
meshTools
coordinateSystems
sphericalCS.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::sphericalCS
26
27
Description
28
Spherical coordinate system
29
30
SourceFiles
31
sphericalCS.C
32
33
\*---------------------------------------------------------------------------*/
34
35
#ifndef sphericalCS_H
36
#define sphericalCS_H
37
38
#include <
meshTools/coordinateSystem.H
>
39
40
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41
42
namespace
Foam
43
{
44
45
/*---------------------------------------------------------------------------*\
46
Class sphericalCS Declaration
47
\*---------------------------------------------------------------------------*/
48
49
class
sphericalCS
50
:
51
public
coordinateSystem
52
{
53
// Private data members
54
55
//- Are angles in degrees? (default = true)
56
bool
inDegrees_;
57
58
59
protected
:
60
61
// Protected Member Functions
62
63
//- Convert from local coordinate system to the global Cartesian system
64
// with optional translation for the origin
65
virtual
vector
localToGlobal
(
const
vector
&,
bool
translate)
const
;
66
67
//- Convert from local coordinate system to the global Cartesian system
68
// with optional translation for the origin
69
virtual
tmp<vectorField>
localToGlobal
70
(
71
const
vectorField
&,
72
bool
translate
73
)
const
;
74
75
//- Convert from global Cartesian system to the local coordinate system
76
// with optional translation for the origin
77
virtual
vector
globalToLocal
(
const
vector
&,
bool
translate)
const
;
78
79
//- Convert from global Cartesian system to the local coordinate system
80
// with optional translation for the origin
81
virtual
tmp<vectorField>
globalToLocal
82
(
83
const
vectorField
&,
84
bool
translate
85
)
const
;
86
87
public
:
88
89
//- Runtime type information
90
TypeName
(
"spherical"
);
91
92
93
// Constructors
94
95
//- Construct null
96
sphericalCS
(
const
bool
inDegrees
=
true
);
97
98
//- Construct copy
99
sphericalCS
100
(
101
const
coordinateSystem
&,
102
const
bool
inDegrees
=
true
103
);
104
105
//- Construct copy with a different name
106
sphericalCS
107
(
108
const
word
&
name
,
109
const
coordinateSystem
&,
110
const
bool
inDegrees
=
true
111
);
112
113
//- Construct from origin and rotation
114
sphericalCS
115
(
116
const
word
& name,
117
const
point
&
origin
,
118
const
coordinateRotation
&,
119
const
bool
inDegrees
=
true
120
);
121
122
//- Construct from origin and 2 axes
123
sphericalCS
124
(
125
const
word
& name,
126
const
point
& origin,
127
const
vector
&
axis
,
128
const
vector
& dirn,
129
const
bool
inDegrees
=
true
130
);
131
132
//- Construct from dictionary
133
sphericalCS
(
const
word
& name,
const
dictionary
&);
134
135
136
// Member Functions
137
138
//- Are angles in degrees?
139
bool
inDegrees
()
const
;
140
141
//- Non-const access to inDegrees
142
bool
&
inDegrees
();
143
144
};
145
146
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
147
148
}
// End namespace Foam
149
150
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
151
152
#endif
153
154
// ************************ vim: set sw=4 sts=4 et: ************************ //