1 /*---------------------------------------------------------------------------*\
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
5 \\ / A nd | Copyright (C) 1991-2008 OpenCFD Ltd.
7 -------------------------------------------------------------------------------
9 This file is part of OpenFOAM.
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 the
13 Free Software Foundation; either version 2 of the License, or (at your
14 option) any later version.
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
21 You should have received a copy of the GNU General Public License
22 along with OpenFOAM; if not, write to the Free Software Foundation,
23 Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
34 \*---------------------------------------------------------------------------*/
36 #ifndef enginePiston_H
37 #define enginePiston_H
39 #include "polyPatchID.H"
40 #include "coordinateSystem.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 // Forward declaration of classes
51 /*---------------------------------------------------------------------------*\
52 Class enginePiston Declaration
53 \*---------------------------------------------------------------------------*/
59 //- Reference to engine mesh
60 const polyMesh& mesh_;
62 //- Reference to engine database
63 const engineTime& engineDB_;
69 autoPtr<coordinateSystem> csPtr_;
72 // Piston layering data
74 //- Min layer thickness
75 const scalar minLayer_;
77 //- Max layer thickness
78 const scalar maxLayer_;
81 // Private Member Functions
83 //- Disallow default bitwise copy construct
84 enginePiston(const enginePiston&);
86 //- Disallow default bitwise assignment
87 void operator=(const enginePiston&);
92 // Static data members
97 //- Construct from components
100 const polyMesh& mesh,
101 const word& pistonPatchName,
102 const autoPtr<coordinateSystem>& pistonCS,
103 const scalar minLayer,
104 const scalar maxLayer
108 //- Construct from dictionary
111 const polyMesh& mesh,
112 const dictionary& dict
116 // Destructor - default
121 //- Return coordinate system
122 const coordinateSystem& cs() const
127 //- Return ID of piston patch
128 const polyPatchID& patchID() const
133 // Piston layering thickness
135 scalar minLayer() const
140 scalar maxLayer() const
147 void writeDict(Ostream&) const;
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
153 } // End namespace Foam
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
159 // ************************************************************************* //