src/engine/simpleEnginePiston/simpleEnginePiston.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   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     simpleEnginePiston
  26
  27 Description
  28
  29 SourceFiles
  30     simpleEnginePiston.C
  31
  32 \*---------------------------------------------------------------------------*/
  33
  34 #ifndef simpleEnginePiston_H
  35 #define simpleEnginePiston_H
  36
  37 #include "polyPatchID.H"
  38 #include "coordinateSystem.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 // Class forward declarations
  46 class polyMesh;
  47 class engineTime;
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class simpleEnginePiston Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class simpleEnginePiston
  54 {
  55     // Private data
  56
  57         //- Reference to engine mesh
  58         const polyMesh& mesh_;
  59
  60         //- Reference to engine database
  61         const engineTime& engineDB_;
  62
  63         //- Piston patch
  64         polyPatchID patchID_;
  65
  66         //- Coordinate system
  67         autoPtr<coordinateSystem> csPtr_;
  68
  69
  70         // Piston layering data
  71
  72             //- Min layer thickness
  73             const scalar minLayer_;
  74
  75             //- Max layer thickness
  76             const scalar maxLayer_;
  77
  78
  79     // Private Member Functions
  80
  81         //- Disallow default bitwise copy construct
  82         simpleEnginePiston(const simpleEnginePiston&);
  83
  84         //- Disallow default bitwise assignment
  85         void operator=(const simpleEnginePiston&);
  86
  87
  88 public:
  89
  90     // Static data members
  91
  92
  93     // Constructors
  94
  95         //- Construct from components
  96         simpleEnginePiston
  97         (
  98             const polyMesh& mesh,
  99             const word& pistonPatchName,
 100             const autoPtr<coordinateSystem>& pistonCS,
 101             const scalar minLayer,
 102             const scalar maxLayer
 103
 104         );
 105
 106         //- Construct from dictionary
 107         simpleEnginePiston
 108         (
 109             const polyMesh& mesh,
 110             const dictionary& dict
 111         );
 112
 113
 114     // Destructor - default
 115
 116
 117     // Member Functions
 118
 119         //- Return coordinate system
 120         const coordinateSystem& cs() const
 121         {
 122             return csPtr_();
 123         }
 124
 125         //- Return ID of piston patch
 126         const polyPatchID& patchID() const
 127         {
 128             return patchID_;
 129         }
 130
 131         // Piston layering thickness
 132
 133             scalar minLayer() const
 134             {
 135                 return minLayer_;
 136             }
 137
 138             scalar maxLayer() const
 139             {
 140                 return maxLayer_;
 141             }
 142
 143
 144         //- Write dictionary
 145         void writeDict(Ostream&) const;
 146 };
 147
 148
 149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 150
 151 } // End namespace Foam
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 #endif
 156
 157 // ************************************************************************* //