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