All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
enginePiston.H
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) 2011-2019 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 Class
25  Foam::enginePiston
26 
27 Description
28  Foam::enginePiston
29 
30 SourceFiles
31  enginePiston.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef enginePiston_H
36 #define enginePiston_H
37 
38 #include "polyPatchID.H"
39 #include "coordinateSystem.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 // Forward declaration of classes
47 class polyMesh;
48 class engineTime;
49 
50 /*---------------------------------------------------------------------------*\
51  Class enginePiston Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class enginePiston
55 {
56  // Private Data
57 
58  //- Reference to engine mesh
59  const polyMesh& mesh_;
60 
61  //- Reference to engine database
62  const engineTime& engineDB_;
63 
64  //- Piston patch
65  polyPatchID patchID_;
66 
67  //- Coordinate system
69 
70 
71  // Piston layering data
72 
73  //- Min layer thickness
74  const scalar minLayer_;
75 
76  //- Max layer thickness
77  const scalar maxLayer_;
78 
79 
80 public:
81 
82  // Static Data Members
83 
84 
85  // Constructors
86 
87  //- Construct from components
89  (
90  const polyMesh& mesh,
91  const word& pistonPatchName,
92  const autoPtr<coordinateSystem>& pistonCS,
93  const scalar minLayer,
94  const scalar maxLayer
95 
96  );
97 
98  //- Construct from dictionary
100  (
101  const polyMesh& mesh,
102  const dictionary& dict
103  );
104 
105  //- Disallow default bitwise copy construction
106  enginePiston(const enginePiston&) = delete;
107 
108 
109  // Member Functions
110 
111  //- Return coordinate system
112  const coordinateSystem& cs() const
113  {
114  return csPtr_();
115  }
116 
117  //- Return ID of piston patch
118  const polyPatchID& patchID() const
119  {
120  return patchID_;
121  }
122 
123  // Piston layering thickness
125  scalar minLayer() const
126  {
127  return minLayer_;
128  }
130  scalar maxLayer() const
131  {
132  return maxLayer_;
133  }
134 
135 
136  //- Write dictionary
137  void writeDict(Ostream&) const;
138 
139 
140  // Member Operators
141 
142  //- Disallow default bitwise assignment
143  void operator=(const enginePiston&) = delete;
144 };
145 
146 
147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 
149 } // End namespace Foam
150 
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 
153 #endif
154 
155 // ************************************************************************* //
Base class for other coordinate system specifications.
enginePiston(const polyMesh &mesh, const word &pistonPatchName, const autoPtr< coordinateSystem > &pistonCS, const scalar minLayer, const scalar maxLayer)
Construct from components.
Definition: enginePiston.C:35
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
scalar minLayer() const
Definition: enginePiston.H:124
Foam::enginePiston.
Definition: enginePiston.H:53
An abstract class for the time description of the piston motion.
Definition: engineTime.H:51
dynamicFvMesh & mesh
A class for handling words, derived from string.
Definition: word.H:59
const coordinateSystem & cs() const
Return coordinate system.
Definition: enginePiston.H:111
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
void writeDict(Ostream &) const
Write dictionary.
Definition: enginePiston.C:80
void operator=(const enginePiston &)=delete
Disallow default bitwise assignment.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
scalar maxLayer() const
Definition: enginePiston.H:129
const polyPatchID & patchID() const
Return ID of piston patch.
Definition: enginePiston.H:117
Namespace for OpenFOAM.