src/engine/accordionValve/accordionValve.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     accordionValve
  26
  27 Description
  28
  29 SourceFiles
  30     accordionValve.C
  31
  32 \*---------------------------------------------------------------------------*/
  33
  34 #ifndef accordionValve_H
  35 #define accordionValve_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 accordionValve Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class accordionValve
  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 cellSet for the static cells
 118             word staticCellsName_;
 119
 120             //- Name of the cellSet for the moving cells
 121             word movingCellsName_;
 122
 123     // Private Member Functions
 124
 125         //- Disallow default bitwise copy construct
 126         accordionValve(const accordionValve&);
 127
 128         //- Disallow default bitwise assignment
 129         void operator=(const accordionValve&);
 130
 131
 132         //- Adjust crank angle to drop within the limits of the lift profile
 133         scalar adjustCrankAngle(const scalar theta) const;
 134
 135 public:
 136
 137     // Static data members
 138
 139     // Constructors
 140
 141         //- Construct from components
 142         accordionValve
 143         (
 144             const word& name,
 145             const polyMesh& mesh,
 146             const autoPtr<coordinateSystem>& valveCS,
 147             const word& bottomPatchName,
 148             const word& poppetPatchName,
 149             const word& sidePatchName,
 150             const word& stemPatchName,
 151             const word& detachInCylinderPatchName,
 152             const word& detachInPortPatchName,
 153             const word& detachFacesName,
 154             const graph& liftProfile,
 155             const scalar minLift,
 156             const scalar diameter,
 157             const word& staticCellsName,
 158             const word& movingCellsName
 159         );
 160
 161         //- Construct from dictionary
 162         accordionValve
 163         (
 164             const word& name,
 165             const polyMesh& mesh,
 166             const dictionary& dict
 167         );
 168
 169     // Destructor - default
 170
 171
 172     // Member Functions
 173
 174         //- Return name
 175         const word& name() const
 176         {
 177             return name_;
 178         }
 179
 180         //- Return coordinate system
 181         const coordinateSystem& cs() const
 182         {
 183             return csPtr_();
 184         }
 185
 186         //- Return lift profile
 187         const graph& liftProfile() const
 188         {
 189             return liftProfile_;
 190         }
 191
 192         //- Return valve diameter
 193         scalar diameter() const
 194         {
 195             return diameter_;
 196         }
 197
 198         // Valve patches
 199
 200             //- Return ID of bottom patch
 201             const polyPatchID& bottomPatchID() const
 202             {
 203                 return bottomPatch_;
 204             }
 205
 206             //- Return ID of poppet patch
 207             const polyPatchID& poppetPatchID() const
 208             {
 209                 return poppetPatch_;
 210             }
 211
 212             //- Return ID of side patch
 213             const polyPatchID& sidePatchID() const
 214             {
 215                 return sidePatch_;
 216             }
 217
 218             //- Return ID of stem patch
 219             const polyPatchID& stemPatchID() const
 220             {
 221                 return stemPatch_;
 222             }
 223
 224             //- Return ID of detach in cylinder patch
 225             const polyPatchID& detachInCylinderPatchID() const
 226             {
 227                 return detachInCylinderPatch_;
 228             }
 229
 230             //- Return ID of detach in port patch
 231             const polyPatchID& detachInPortPatchID() const
 232             {
 233                 return detachInPortPatch_;
 234             }
 235
 236             //- Return face labels of detach curtain
 237             const word& detachFacesName() const
 238             {
 239                 return detachFacesName_;
 240             }
 241
 242             const word& staticCellsName() const
 243             {
 244                 return staticCellsName_;
 245             }
 246
 247             const word& movingCellsName() const
 248             {
 249                 return movingCellsName_;
 250             }
 251
 252         // Valve position and velocity
 253
 254             //- Return valve lift given crank angle in degrees
 255             scalar lift(const scalar theta) const;
 256
 257             //- Is the valve open?
 258             bool isOpen() const;
 259
 260             //- Return current lift
 261             scalar curLift() const;
 262
 263             //- Return valve velocity for current time-step
 264             scalar curVelocity() const;
 265
 266             //- Return list of active patch labels for the valve head
 267             //  (stem is excluded)
 268             labelList movingPatchIDs() const;
 269
 270         //- Write dictionary
 271         void writeDict(Ostream&) const;
 272 };
 273
 274
 275 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 276
 277 } // End namespace Foam
 278
 279 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 280
 281 #endif
 282
 283 // ************************************************************************* //