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-2018 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  // Private Member Functions
81 
82  //- Disallow default bitwise copy construct
83  enginePiston(const enginePiston&);
84 
85  //- Disallow default bitwise assignment
86  void operator=(const enginePiston&);
87 
88 
89 public:
90 
91  // Static data members
92 
93 
94  // Constructors
95 
96  //- Construct from components
98  (
99  const polyMesh& mesh,
100  const word& pistonPatchName,
101  const autoPtr<coordinateSystem>& pistonCS,
102  const scalar minLayer,
103  const scalar maxLayer
104 
105  );
106 
107  //- Construct from dictionary
109  (
110  const polyMesh& mesh,
111  const dictionary& dict
112  );
113 
114 
115  // Destructor - default
116 
117 
118  // Member Functions
119 
120  //- Return coordinate system
121  const coordinateSystem& cs() const
122  {
123  return csPtr_();
124  }
125 
126  //- Return ID of piston patch
127  const polyPatchID& patchID() const
128  {
129  return patchID_;
130  }
131 
132  // Piston layering thickness
134  scalar minLayer() const
135  {
136  return minLayer_;
137  }
139  scalar maxLayer() const
140  {
141  return maxLayer_;
142  }
143 
144 
145  //- Write dictionary
146  void writeDict(Ostream&) const;
147 };
148 
149 
150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
151 
152 } // End namespace Foam
153 
154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
155 
156 #endif
157 
158 // ************************************************************************* //
Base class for other coordinate system specifications.
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
scalar minLayer() const
Definition: enginePiston.H:133
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:120
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
void writeDict(Ostream &) const
Write dictionary.
Definition: enginePiston.C:80
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:138
const polyPatchID & patchID() const
Return ID of piston patch.
Definition: enginePiston.H:126
Namespace for OpenFOAM.