src/engine/enginePiston/enginePiston.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::enginePiston
  27
  28 Description
  29     Foam::enginePiston
  30
  31 SourceFiles
  32     enginePiston.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef enginePiston_H
  37 #define enginePiston_H
  38
  39 #include "polyPatchID.H"
  40 #include "coordinateSystem.H"
  41 #include "simpleEnginePiston.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // Forward declaration of classes
  49 class polyMesh;
  50 class engineTime;
  51
  52 /*---------------------------------------------------------------------------*\
  53                            Class enginePiston Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class enginePiston
  57 :
  58     public simpleEnginePiston
  59 {
  60     // Private data
  61
  62         //- Name of piston point set
  63         word pistonPointSetName_;
  64
  65         //- Name of piston face set
  66         word pistonFaceSetName_;
  67
  68         //- Name of piston cell set
  69         word pistonCellSetName_;
  70
  71
  72         //- Bowl in piston patch
  73         polyPatchID bowlInPistonPatchID_;
  74
  75         //- Bowl in cylinder patch
  76         polyPatchID bowlInCylinderPatchID_;
  77
  78     // Private Member Functions
  79
  80         //- Disallow default bitwise copy construct
  81         enginePiston(const enginePiston&);
  82
  83         //- Disallow default bitwise assignment
  84         void operator=(const enginePiston&);
  85
  86
  87 public:
  88
  89     // Static data members
  90
  91
  92     // Constructors
  93
  94         //- Construct from components
  95         enginePiston
  96         (
  97             const polyMesh& mesh,
  98             const word& pistonPatchName,
  99             const autoPtr<coordinateSystem>& pistonCS,
 100             const scalar minLayer,
 101             const scalar maxLayer,
 102             const word& pistonPointSetName,
 103             const word& pistonFaceSetName,
 104             const word& pistonCellSetName,
 105             const word& bowlInPistonPatchName,
 106             const word& bowlInCylinderPatchName
 107         );
 108
 109         //- Construct from dictionary
 110         enginePiston
 111         (
 112             const polyMesh& mesh,
 113             const dictionary& dict
 114         );
 115
 116
 117     // Destructor - default
 118
 119
 120     // Member Functions
 121
 122         const word& pistonPointSetName() const
 123         {
 124             return pistonPointSetName_;
 125         }
 126
 127         const word& pistonFaceSetName() const
 128         {
 129             return pistonFaceSetName_;
 130         }
 131
 132         const word& pistonCellSetName() const
 133         {
 134             return pistonCellSetName_;
 135         }
 136
 137
 138         const polyPatchID& bowlInPistonPatchID() const
 139         {
 140                 return bowlInPistonPatchID_;
 141         }
 142
 143         const polyPatchID& bowlInCylinderPatchID() const
 144         {
 145             return bowlInCylinderPatchID_;
 146         }
 147
 148
 149         //- Write dictionary
 150         void writeDict(Ostream&) const;
 151 };
 152
 153
 154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 155
 156 } // End namespace Foam
 157
 158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 159
 160 #endif
 161
 162 // ************************************************************************* //