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 -------------------------------------------------------------------------------
10 License
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 
33 namespace Foam
34 {
35  namespace coordinateRotations
36  {
37  defineTypeName(cylindrical);
39  (
40  coordinateRotation,
41  cylindrical,
42  dictionary
43  );
44  }
45 }
46 
47 
48 // * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * //
49 
51 (
52  const vector& axis
53 )
54 {
55  // Guess second axis
56  return axes::rotation(axis, Zero, E3_E1);
57 }
58 
59 
60 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
61 
63 :
64  coordinateRotations::axes(crot)
65 {}
66 
67 
69 :
70  coordinateRotations::axes(axis) // Guess second axis
71 {}
72 
73 
75 :
76  cylindrical(dict.getCompat<vector>("axis", {{"e3", -1806}}))
77 {}
78 
79 
80 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
81 
83 {
84  os << type() << " axis: " << axis1_; // primary axis
85 }
86 
87 
89 (
90  const word& keyword,
91  Ostream& os
92 ) const
93 {
94  os.beginBlock(keyword);
95 
96  os.writeEntry("type", type());
97  os.writeEntry("axis", axis1_); // primary axis
98 
99  os.endBlock();
100 }
101 
102 
103 // ************************************************************************* //
Foam::Tensor< scalar >
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::coordinateRotations::cylindrical::write
virtual void write(Ostream &os) const
Write information.
Definition: cylindricalRotation.C:82
Foam::coordinateRotations::cylindrical::writeEntry
virtual void writeEntry(const word &keyword, Ostream &os) const
Write dictionary entry.
Definition: cylindricalRotation.C:89
Foam::Zero
static constexpr const zero Zero
Global zero (0)
Definition: zero.H:131
Foam::coordinateRotations::cylindrical
A special purpose coordinateRotation that is generally for use in combination with a cylindricalCS wh...
Definition: cylindricalRotation.H:83
Foam::coordinateRotations::addToRunTimeSelectionTable
addToRunTimeSelectionTable(coordinateRotation, axisAngle, dictionary)
Foam::coordinateRotations::axes
A coordinateRotation specified using global axes.
Definition: axesRotation.H:104
Foam::coordinateRotations::cylindrical::rotation
static tensor rotation(const vector &axis)
The rotation tensor calculated from axes and order.
Definition: cylindricalRotation.C:51
Foam::coordinateRotations::defineTypeName
defineTypeName(axes)
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
os
OBJstream os(runTime.globalPath()/outputName)
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
cylindricalRotation.H
Foam::Vector< scalar >
Foam::type
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: MSwindows.C:590
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::coordinateRotations::cylindrical::cylindrical
cylindrical()=default
Default construct - an identity transform.