src/engine/dieselEngineValve/dieselEngineValve.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     dieselEngineValve
  26
  27 Description
  28
  29 SourceFiles
  30     dieselEngineValve.C
  31
  32 \*---------------------------------------------------------------------------*/
  33
  34 #ifndef dieselEngineValve_H
  35 #define dieselEngineValve_H
  36
  37 #include "word.H"
  38 #include "coordinateSystem.H"
  39 #include "polyPatchID.H"
  40 #include "graph.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Class forward declarations
  48 class polyMesh;
  49 class engineTime;
  50
  51 /*---------------------------------------------------------------------------*\
  52                           Class dieselEngineValve Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class dieselEngineValve
  56 {
  57     // Private data
  58
  59         //- Name of valve
  60         word name_;
  61
  62         //- Reference to engine mesh
  63         const polyMesh& mesh_;
  64
  65         //- Reference to engine database
  66         const engineTime& engineDB_;
  67
  68         //- Coordinate system
  69         autoPtr<coordinateSystem> csPtr_;
  70
  71
  72         // Patch and zone names
  73
  74             //- Valve bottom patch
  75             polyPatchID bottomPatch_;
  76
  77             //- Valve poppet patch
  78             polyPatchID poppetPatch_;
  79
  80             //- Valve poppet patch
  81             polyPatchID sidePatch_;
  82
  83             //- Valve stem patch
  84             polyPatchID stemPatch_;
  85
  86             //- Valve curtain manifold patch
  87             polyPatchID downInPortPatch_;
  88
  89             //- Valve curtain cylinder patch
  90             polyPatchID downInCylinderPatch_;
  91
  92             //- Valve curtain manifold patch
  93             polyPatchID upInPortPatch_;
  94
  95             //- Valve curtain cylinder patch
  96             polyPatchID upInCylinderPatch_;
  97
  98             //- Valve detach in cylinder patch
  99             polyPatchID detachInCylinderPatch_;
 100
 101             //- Valve detach in port patch
 102             polyPatchID detachInPortPatch_;
 103
 104             //- Faces to detach
 105             labelList detachFaces_;
 106
 107             //- detach tolerance
 108             scalar detachTol_;
 109
 110         // Valve lift data
 111
 112             //- Valve lift profile
 113             graph liftProfile_;
 114
 115             //- Lift curve start angle
 116             scalar liftProfileStart_;
 117
 118             //- Lift curve end angle
 119             scalar liftProfileEnd_;
 120
 121             //- Minimum valve lift.  On this lift the valve is considered closed
 122             const scalar minLift_;
 123
 124
 125             //- Valve diameter
 126             const scalar diameter_;
 127
 128
 129
 130     // Private Member Functions
 131
 132         //- Disallow default bitwise copy construct
 133         dieselEngineValve(const dieselEngineValve&);
 134
 135         //- Disallow default bitwise assignment
 136         void operator=(const dieselEngineValve&);
 137
 138
 139         //- Adjust crank angle to drop within the limits of the lift profile
 140         scalar adjustCrankAngle(const scalar theta) const;
 141
 142 public:
 143
 144     // Static data members
 145
 146
 147     // Constructors
 148
 149         //- Construct from components
 150         dieselEngineValve
 151         (
 152             const word& name,
 153             const polyMesh& mesh,
 154             const autoPtr<coordinateSystem>& valveCS,
 155             const word& bottomPatchName,
 156             const word& poppetPatchName,
 157             const word& sidePatchName,
 158             const word& stemPatchName,
 159             const word& downInPortPatchName,
 160             const word& downInCylinderPatchName,
 161             const word& upInPortPatchName,
 162             const word& upInCylinderPatchName,
 163             const word& detachInCylinderPatchName,
 164             const word& detachInPortPatchName,
 165             const labelList& detachFaces,
 166             const scalar& detachTol,
 167             const graph& liftProfile,
 168             const scalar minLift,
 169             const scalar diameter
 170
 171         );
 172
 173         //- Construct from dictionary
 174         dieselEngineValve
 175         (
 176             const word& name,
 177             const polyMesh& mesh,
 178             const dictionary& dict
 179         );
 180
 181
 182     // Destructor - default
 183
 184
 185     // Member Functions
 186
 187         //- Return name
 188         const word& name() const
 189         {
 190             return name_;
 191         }
 192
 193         //- Return coordinate system
 194         const coordinateSystem& cs() const
 195         {
 196             return csPtr_();
 197         }
 198
 199         //- Return lift profile
 200         const graph& liftProfile() const
 201         {
 202             return liftProfile_;
 203         }
 204
 205         //- Return valve diameter
 206         scalar diameter() const
 207         {
 208             return diameter_;
 209         }
 210
 211
 212         // Valve patches
 213
 214             //- Return ID of bottom patch
 215             const polyPatchID& bottomPatchID() const
 216             {
 217                 return bottomPatch_;
 218             }
 219
 220             //- Return ID of poppet patch
 221             const polyPatchID& poppetPatchID() const
 222             {
 223                 return poppetPatch_;
 224             }
 225
 226             //- Return ID of side patch
 227             const polyPatchID& sidePatchID() const
 228             {
 229                 return sidePatch_;
 230             }
 231
 232             //- Return ID of stem patch
 233             const polyPatchID& stemPatchID() const
 234             {
 235                 return stemPatch_;
 236             }
 237
 238             //- Return ID of down surface in cylinder patch
 239             const polyPatchID& downInCylinderPatchID() const
 240             {
 241                 return downInCylinderPatch_;
 242             }
 243
 244             //- Return ID of down surface  in port patch
 245             const polyPatchID& downInPortPatchID() const
 246             {
 247                 return downInPortPatch_;
 248             }
 249
 250             //- Return ID of up surface  in cylinder patch
 251             const polyPatchID& upInCylinderPatchID() const
 252             {
 253                 return upInCylinderPatch_;
 254             }
 255
 256             //- Return ID of up surface  in port patch
 257             const polyPatchID& upInPortPatchID() const
 258             {
 259                 return upInPortPatch_;
 260             }
 261
 262             //- Return ID of detach in cylinder patch
 263             const polyPatchID& detachInCylinderPatchID() const
 264             {
 265                 return detachInCylinderPatch_;
 266             }
 267
 268             //- Return ID of detach in port patch
 269             const polyPatchID& detachInPortPatchID() const
 270             {
 271                 return detachInPortPatch_;
 272             }
 273
 274             //- Return face labels of detach curtain
 275             const labelList& detachFaces() const
 276             {
 277                 return detachFaces_;
 278             }
 279
 280             //- Return face labels of detach curtain
 281             const scalar& detachTol() const
 282             {
 283                 return detachTol_;
 284             }
 285
 286         // Valve position and velocity
 287
 288             //- Return valve lift given crank angle in degrees
 289             scalar lift(const scalar theta) const;
 290
 291             //- Is the valve open?
 292             bool isOpen() const;
 293
 294             //- Return current lift
 295             scalar curLift() const;
 296
 297             //- Return valve velocity for current time-step
 298             scalar curVelocity() const;
 299
 300             //- Return list of active patch labels for the valve head
 301             //  (stem is excluded)
 302             labelList movingPatchIDs() const;
 303
 304
 305         //- Write dictionary
 306         void writeDict(Ostream&) const;
 307 };
 308
 309
 310 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 311
 312 } // End namespace Foam
 313
 314 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 315
 316 #endif
 317
 318 // ************************************************************************* //