omega.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2022 OpenFOAM Foundation
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 \*---------------------------------------------------------------------------*/
25 
26 #include "omega.H"
27 #include "mathematicalConstants.H"
28 
29 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
30 
32 :
33  rpm_(false),
34  omegaFactor_(1)
35 {}
36 
37 
39 :
40  rpm_(dict.found("rpm")),
41  omegaFactor_(rpm_ ? constant::mathematical::pi/30.0 : 1),
42  omega_
43  (
44  rpm_
45  ? Function1<scalar>::New("rpm", dict)
46  : Function1<scalar>::New("omega", dict)
47  )
48 {}
49 
50 
52 :
53  rpm_(o.rpm_),
54  omegaFactor_(o.omegaFactor_),
55  omega_(o.omega_, false)
56 {}
57 
58 
59 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
60 
62 {
63  rpm_ = dict.found("rpm");
64  omegaFactor_ = rpm_ ? constant::mathematical::pi/30.0 : 1;
65 
66  omega_.reset
67  (
68  rpm_
69  ? Function1<scalar>::New("rpm", dict).ptr()
70  : Function1<scalar>::New("omega", dict).ptr()
71  );
72 
73  return true;
74 }
75 
76 
78 {
79  writeEntry(os, omega_());
80 }
81 
82 
83 // * * * * * * * * * * * * * * * IOstream Functions * * * * * * * * * * * * //
84 
86 {
87  o.write(os);
88 }
89 
90 
91 // ************************************************************************* //
bool found
Run-time selectable general function of one variable.
Definition: Function1.H:64
User convenience class to handle the input of time-varying rotational speed in rad/s if omega is spec...
Definition: omega.H:108
bool read(const dictionary &dict)
Update omega function from given dictionary.
Definition: omega.C:61
void write(Ostream &os) const
Write data to dictionary stream.
Definition: omega.C:77
omega()
Construct null.
Definition: omega.C:31
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
void writeEntry(Ostream &os, const omega &a)
Definition: omega.C:85
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh >> &tdf1, const word &name, const dimensionSet &dimensions)
dictionary dict