freePiston.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) 2017 OpenFOAM Foundation
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 "freePiston.H"
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35  defineTypeNameAndDebug(freePiston, 0);
36  addToRunTimeSelectionTable(engineTime, freePiston, dictionary);
37 }
38 
39 
40 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
41 
42 Foam::freePiston::freePiston
43 (
44  const word& name,
45  const fileName& rootPath,
46  const fileName& caseName,
47  const fileName& systemName,
48  const fileName& constantName,
49  const fileName& dictName
50 )
51 :
53  (
54  name,
55  rootPath,
56  caseName,
57  systemName,
58  constantName
59  ),
60  pistonPositionTime_
61  (
62  Function1<scalar>::New("pistonPositionTime", dict_)
63  )
64 {}
65 
66 
67 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
68 
69 Foam::scalar Foam::freePiston::theta() const
70 {
71  return value();
72 }
73 
74 
76 {
77  return " s";
78 }
79 
80 
81 Foam::scalar Foam::freePiston::deltaTheta() const
82 {
83  return deltaTValue();
84 }
85 
86 
87 Foam::scalar Foam::freePiston::pistonPosition(const scalar theta) const
88 {
89  return pistonPositionTime_->value(theta);
90 }
91 
92 
93 // ************************************************************************* //
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(decompositionMethod, kahipDecomp, dictionary)
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::fileName
A class for handling file names.
Definition: fileName.H:73
dictName
const word dictName("faMeshDefinition")
Foam::freePiston::theta
virtual scalar theta() const
Return current engine time.
Definition: freePiston.C:69
Foam::dimensioned::value
const Type & value() const
Return const reference to value.
Definition: dimensionedType.C:434
Foam::Function1
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: propellerInfo.H:291
Foam::freePiston::unit
virtual word unit() const
Return time unit.
Definition: freePiston.C:75
Foam::engineTime
An abstract class for the time description of the piston motion.
Definition: engineTime.H:54
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::freePiston::deltaTheta
virtual scalar deltaTheta() const
Return engine time increment.
Definition: freePiston.C:81
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
Foam::engineTime::pistonPosition
dimensionedScalar pistonPosition() const
Return current piston position.
Definition: engineTime.C:94
freePiston.H