cylindricalRotation.C
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2018-2021 OpenCFD Ltd.
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26\*---------------------------------------------------------------------------*/
27
28#include "cylindricalRotation.H"
30
31// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32
33namespace Foam
34{
35namespace coordinateRotations
36{
37
40 (
44 );
45
46} // End namespace coordinateRotations
47} // End namespace Foam
48
49
50// * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * //
51
53(
54 const vector& axis
55)
56{
57 // Guess second axis
58 return axes::rotation(axis, Zero, E3_E1);
59}
60
61
62// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
63
65:
66 coordinateRotations::axes(crot)
67{}
68
69
71:
72 coordinateRotations::axes(axis) // Guess second axis
73{}
74
75
77:
78 cylindrical(dict.getCompat<vector>("axis", {{"e3", -1806}}))
79{}
80
81
82// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
83
85{
86 os << type() << " axis: " << axis1_; // primary axis
87}
88
89
91(
92 const word& keyword,
93 Ostream& os
94) const
95{
96 os.beginBlock(keyword);
97
98 os.writeEntry("type", type());
99 os.writeEntry("axis", axis1_); // primary axis
100
101 os.endBlock();
102}
103
104
105// ************************************************************************* //
Macros for easy insertion into run-time selection tables.
#define addToRunTimeSelectionTable(baseType, thisType, argNames)
Add to construction table with typeName as the key.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
User specification of a coordinate rotation.
A coordinateRotation specified using global axes.
Definition: axesRotation.H:108
@ E3_E1
The axis1 (dominant) is local Z, axis2 is local X.
Definition: axesRotation.H:117
A special purpose coordinateRotation that is generally for use in combination with a cylindricalCS wh...
virtual void writeEntry(const word &keyword, Ostream &os) const
Write dictionary entry.
cylindrical()=default
Default construct - an identity transform.
virtual const coordinateRotation & rotation() const
The rotation specification.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
virtual bool write()
Write the output fields.
A class for handling words, derived from Foam::string.
Definition: word.H:68
#define defineTypeName(Type)
Define the typeName.
Definition: className.H:96
OBJstream os(runTime.globalPath()/outputName)
Namespace for OpenFOAM.
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: MSwindows.C:598
static constexpr const zero Zero
Global zero (0)
Definition: zero.H:131
dictionary dict