src/engine/engineTopoChangerMesh/twoStrokeEngine/twoStrokeEngine.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 \*---------------------------------------------------------------------------*/
  26
  27 #ifndef twoStrokeEngine_H
  28 #define twoStrokeEngine_H
  29
  30 #include "engineTopoChangerMesh.H"
  31 #include "enginePiston.H"
  32 #include "motionSolver.H"
  33 #include "polyPatchID.H"
  34
  35 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  36
  37 namespace Foam
  38 {
  39
  40 // Class forward declarations
  41
  42 /*---------------------------------------------------------------------------*\
  43                       Class twoStrokeEngine Declaration
  44 \*---------------------------------------------------------------------------*/
  45
  46 class twoStrokeEngine
  47 :
  48     public engineTopoChangerMesh
  49 {
  50     // Private data
  51
  52         //- Piston patch
  53         enginePiston piston_;
  54
  55         //- Scavenging ports patches
  56         wordList scavInPortPatches_;
  57
  58         //- Scavenging cylinder patches
  59         wordList scavInCylPatches_;
  60
  61         //- Name of the head pointSet
  62         word headPointsSetName_;
  63
  64         //- Name of the head pointSet
  65         word headCellsSetName_;
  66
  67         //- Name of the moving cell set
  68         word movingCellSetName_;
  69
  70
  71         //- Markup field for points.  Moving points marked with 1
  72         mutable scalarField* movingPointsMaskPtr_;
  73
  74         //- Layering-to-deformation switch in crank-angle degrees
  75         scalar deformSwitch_;
  76
  77         //- Piston Position
  78         scalar pistonPosition_;
  79
  80         //- Virtual piston position (pistonPosition + offSet)
  81         scalar virtualPistonPosition_;
  82
  83         //- deckHeight
  84         scalar deckHeight_;
  85
  86         //- Coordinate system
  87         autoPtr<coordinateSystem> csPtr_;
  88
  89
  90     // Private Member Functions
  91
  92         //- Disallow default bitwise copy construct
  93         twoStrokeEngine(const twoStrokeEngine&);
  94
  95         //- Disallow default bitwise assignment
  96         void operator=(const twoStrokeEngine&);
  97
  98         //- Make layering modifiers live
  99         void makeLayersLive();
 100
 101         //- Make Sliding interface modifiers live
 102         void makeSlidersLive();
 103
 104         //- Is the sliding interface attached?
 105         bool attached() const;
 106
 107         //- Check if all patches exist, then calculate virtualPistonPosition,
 108         //- pistonPosition and deckHeight for the first time
 109         void checkAndCalculate();
 110
 111         //- Calculate the virtualPistonPosition,
 112         void setVirtualPistonPosition();
 113
 114         //- Correct the vertical motion for the points below the
 115         //  "virtual piston",
 116         void correctVerticalMotion();
 117
 118         //- Apply the moving mask, the points of the ports do not move.
 119         void applyMovingMask();
 120
 121         //- Calculate moving masks
 122         void calcMovingMasks() const;
 123
 124         //- Return moving points mask
 125         const scalarField& movingPointsMask() const;
 126
 127         bool realDeformation() const;
 128
 129         void checkMotionFluxes();
 130
 131
 132 public:
 133
 134     //- Runtime type information
 135     TypeName("twoStrokeEngine");
 136
 137
 138     // Constructors
 139
 140         //- Construct from database
 141         explicit twoStrokeEngine(const IOobject& io);
 142
 143
 144     // Destructor - default
 145
 146
 147     // Member Functions
 148
 149         //- Return coordinate system
 150         const coordinateSystem& cs() const
 151         {
 152             return csPtr_();
 153         }
 154
 155         const scalar& pistonPosition() const
 156         {
 157             return pistonPosition_;
 158         }
 159
 160         scalar& pistonPosition()
 161         {
 162             return pistonPosition_;
 163         }
 164
 165         const scalar& virtualPistonPosition() const
 166         {
 167             return virtualPistonPosition_;
 168         }
 169
 170         scalar& virtualPistonPosition()
 171         {
 172             return virtualPistonPosition_;
 173         }
 174
 175         const scalar& deckHeight() const
 176         {
 177             return deckHeight_;
 178         }
 179
 180         scalar& deckHeight()
 181         {
 182             return deckHeight_;
 183         }
 184
 185         const enginePiston& piston() const
 186         {
 187             return piston_;
 188         }
 189
 190         //- Return true for mesh deformation mode
 191         bool deformation() const
 192         {
 193             return
 194                 engTime().thetaRevolution() > -deformSwitch_
 195              && engTime().thetaRevolution() < deformSwitch_;
 196         }
 197
 198
 199         //- Add valve and piston zones and modifiers
 200         void addZonesAndModifiers();
 201
 202         //- Move and morph
 203         virtual bool update();
 204
 205         //- Set boundary velocities
 206         void setBoundaryVelocity(volVectorField& U);
 207 };
 208
 209
 210 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 211
 212 } // End namespace Foam
 213
 214 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 215
 216 #endif
 217
 218 // ************************************************************************* //