src/engine/enginePiston/enginePiston.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     |
   5     \\  /    A nd           | For copyright notice see file Copyright
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  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 #include "simpleEnginePiston.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward declaration of classes
  48 class polyMesh;
  49 class engineTime;
  50
  51 /*---------------------------------------------------------------------------*\
  52                            Class enginePiston Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class enginePiston
  56 :
  57     public simpleEnginePiston
  58 {
  59     // Private data
  60
  61         //- Name of piston point set
  62         word pistonPointSetName_;
  63
  64         //- Name of piston face set
  65         word pistonFaceSetName_;
  66
  67         //- Name of piston cell set
  68         word pistonCellSetName_;
  69
  70
  71         //- Bowl in piston patch
  72         polyPatchID bowlInPistonPatchID_;
  73
  74         //- Bowl in cylinder patch
  75         polyPatchID bowlInCylinderPatchID_;
  76
  77     // Private Member Functions
  78
  79         //- Disallow default bitwise copy construct
  80         enginePiston(const enginePiston&);
  81
  82         //- Disallow default bitwise assignment
  83         void operator=(const enginePiston&);
  84
  85
  86 public:
  87
  88     // Static data members
  89
  90
  91     // Constructors
  92
  93         //- Construct from components
  94         enginePiston
  95         (
  96             const polyMesh& mesh,
  97             const word& pistonPatchName,
  98             const autoPtr<coordinateSystem>& pistonCS,
  99             const scalar minLayer,
 100             const scalar maxLayer,
 101             const word& pistonPointSetName,
 102             const word& pistonFaceSetName,
 103             const word& pistonCellSetName,
 104             const word& bowlInPistonPatchName,
 105             const word& bowlInCylinderPatchName
 106         );
 107
 108         //- Construct from dictionary
 109         enginePiston
 110         (
 111             const polyMesh& mesh,
 112             const dictionary& dict
 113         );
 114
 115
 116     // Destructor - default
 117
 118
 119     // Member Functions
 120
 121         const word& pistonPointSetName() const
 122         {
 123             return pistonPointSetName_;
 124         }
 125
 126         const word& pistonFaceSetName() const
 127         {
 128             return pistonFaceSetName_;
 129         }
 130
 131         const word& pistonCellSetName() const
 132         {
 133             return pistonCellSetName_;
 134         }
 135
 136
 137         const polyPatchID& bowlInPistonPatchID() const
 138         {
 139                 return bowlInPistonPatchID_;
 140         }
 141
 142         const polyPatchID& bowlInCylinderPatchID() const
 143         {
 144             return bowlInCylinderPatchID_;
 145         }
 146
 147
 148         //- Write dictionary
 149         void writeDict(Ostream&) const;
 150 };
 151
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 } // End namespace Foam
 156
 157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 158
 159 #endif
 160
 161 // ************************************************************************* //