specifiedRotation.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) 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 "specifiedRotation.H"
29 #include "dictionary.H"
31 
32 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36 namespace coordinateRotations
37 {
38 
39 defineTypeName(specified);
40 //FUTURE addToRunTimeSelectionTable(coordinateRotation, specified, dictionary);
41 
42 }
43 }
44 
45 
46 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
47 
49 :
51  Rmatrix_(sphericalTensor::I)
52 {}
53 
54 
56 :
58  Rmatrix_(rot)
59 {}
60 
61 
63 :
64  specified()
65 {
66  // Not yet implemented, pending definition
67 }
68 
69 
70 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
71 
73 {
74  Rmatrix_ = sphericalTensor::I;
75 }
76 
77 
79 {
80  return Rmatrix_;
81 }
82 
83 
85 {
86  os << "specified rotation";
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 
100  os.endBlock();
101 }
102 
103 
104 // ************************************************************************* //
Foam::Tensor< scalar >
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::coordinateRotations::specified::write
virtual void write(Ostream &os) const
Write information.
Definition: specifiedRotation.C:84
specifiedRotation.H
Foam::coordinateRotation
User specification of a coordinate rotation.
Definition: coordinateRotation.H:78
Foam::coordinateRotations::defineTypeName
defineTypeName(axes)
Foam::coordinateRotations::specified::specified
specified()
Default construct - an identity matrix.
Definition: specifiedRotation.C:48
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
Foam::coordinateRotations::specified
An user-specified coordinateRotation, primarily to be used internally within coding when the rotation...
Definition: specifiedRotation.H:61
Foam::SphericalTensor< scalar >
Foam::coordinateRotations::specified::R
virtual tensor R() const
Return the rotation tensor.
Definition: specifiedRotation.C:78
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
dictionary.H
Foam::coordinateRotations::specified::clear
virtual void clear()
Reset specification.
Definition: specifiedRotation.C:72
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::coordinateRotations::specified::writeEntry
virtual void writeEntry(const word &keyword, Ostream &os) const
Write dictionary entry.
Definition: specifiedRotation.C:91
Foam::I
static const Identity< scalar > I
Definition: Identity.H:95
Foam::SphericalTensor< scalar >::I
static const SphericalTensor I
Definition: SphericalTensor.H:77