src/engine/engineVerticalValve/engineVerticalValve.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     engineVerticalValve
  26
  27 Description
  28     class for engine meshes with vertical valves
  29
  30 SourceFiles
  31     engineVerticalValve.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef engineVerticalValve_H
  36 #define engineVerticalValve_H
  37
  38 #include "word.H"
  39 #include "coordinateSystem.H"
  40 #include "polyPatchID.H"
  41 #include "graph.H"
  42 #include "engineValve.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 // Class forward declarations
  50 class polyMesh;
  51 class engineTime;
  52
  53 /*---------------------------------------------------------------------------*\
  54                           Class engineVerticalValve Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class engineVerticalValve
  58 :
  59     public engineValve
  60 {
  61     // Private data
  62
  63         //- Valve head patch
  64         polyPatchID valveHeadPatch_;
  65
  66         //- Offset for layer Addition/Removal
  67         scalar topLayerOffset_;
  68
  69         //- Tolerance for adding layer face zone
  70         scalar topLayerTol_;
  71
  72         //- Offset for layer Addition/Removal
  73         scalar bottomLayerOffset_;
  74
  75         //- Tolerance for adding layer face zone
  76         scalar bottomLayerTol_;
  77
  78         //- Distance for attach/detach boundary
  79         scalar detachDistance_;
  80
  81         //- Tolerance for attach/detach boundary faces
  82         scalar detachTol_;
  83
  84         //- Tolerance for deformation/layering
  85         scalar deformationLift_;
  86
  87     // Private Member Functions
  88
  89         //- Disallow default bitwise copy construct
  90         engineVerticalValve(const engineVerticalValve&);
  91
  92         //- Disallow default bitwise assignment
  93         void operator=(const engineVerticalValve&);
  94
  95
  96
  97 public:
  98
  99     // Static data members
 100
 101
 102     // Constructors
 103
 104         //- Construct from components
 105         engineVerticalValve
 106         (
 107             const word& name,
 108             const polyMesh& mesh,
 109             const autoPtr<coordinateSystem>& valveCS,
 110             const word& bottomPatchName,
 111             const word& poppetPatchName,
 112             const word& stemPatchName,
 113             const word& curtainInPortPatchName,
 114             const word& curtainInCylinderPatchName,
 115             const word& detachInCylinderPatchName,
 116             const word& detachInPortPatchName,
 117             const labelList& detachFaces,
 118             const graph& liftProfile,
 119             const scalar minLift,
 120             const scalar minTopLayer,
 121             const scalar maxTopLayer,
 122             const scalar minBottomLayer,
 123             const scalar maxBottomLayer,
 124             const scalar diameter,
 125             const word& valveHeadPatchName,
 126             const scalar topLayerOffset,
 127             const scalar topLayerTol,
 128             const scalar bottomLayerOffset,
 129             const scalar bottomLayerTol,
 130             const scalar detachDistance,
 131             const scalar detachTol,
 132             const scalar deformationLift
 133         );
 134
 135         //- Construct from dictionary
 136         engineVerticalValve
 137         (
 138             const word& name,
 139             const polyMesh& mesh,
 140             const dictionary& dict
 141         );
 142
 143
 144     // Destructor - default
 145
 146
 147     // Member Functions
 148
 149
 150         const scalar& topLayerOffset() const
 151         {
 152             return topLayerOffset_;
 153         }
 154
 155         const scalar& topLayerTol() const
 156         {
 157             return topLayerTol_;
 158         }
 159
 160         const scalar& bottomLayerOffset() const
 161         {
 162             return bottomLayerOffset_;
 163         }
 164
 165         const scalar& bottomLayerTol() const
 166         {
 167             return bottomLayerTol_;
 168         }
 169
 170         const scalar& detachDistance() const
 171         {
 172             return detachDistance_;
 173         }
 174
 175         const scalar& detachTol() const
 176         {
 177             return detachTol_;
 178         }
 179
 180         const scalar& deformationLift() const
 181         {
 182             return deformationLift_;
 183         }
 184
 185    // Valve patches
 186
 187        //- Return ID of bottom patch
 188        const polyPatchID& valveHeadID() const
 189        {
 190            return valveHeadPatch_;
 191        }
 192
 193
 194         //- Write dictionary
 195         void writeDict(Ostream&) const;
 196 };
 197
 198
 199 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 200
 201 } // End namespace Foam
 202
 203 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 204
 205 #endif
 206
 207 // ************************************************************************* //