src/topoChangerFvMesh/mixerFvMesh/mixerFvMesh.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 Class
  26     Foam::mixerFvMesh
  27
  28 Description
  29     Mixer mesh using a sliding interface.
  30
  31 SourceFiles
  32     mixerFvMesh.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef mixerFvMesh_H
  37 #define mixerFvMesh_H
  38
  39 #include "topoChangerFvMesh.H"
  40 #include "cylindricalCS.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class mixerFvMesh Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class mixerFvMesh
  52 :
  53     public topoChangerFvMesh
  54 {
  55     // Private data
  56
  57         //- Motion dictionary
  58         dictionary dict_;
  59
  60         //- Coordinate system
  61         autoPtr<coordinateSystem> csPtr_;
  62
  63         // - Rotational speed in rotations per minute (rpm)
  64         scalar rpm_;
  65
  66         //- Rotating region marker point
  67         point rotatingRegionMarker_;
  68
  69         //- Attach-detach action
  70         Switch attachDetach_;
  71
  72         //- Markup field for points.  Moving points marked with 1
  73         mutable scalarField* movingPointsMaskPtr_;
  74
  75
  76     // Private Member Functions
  77
  78         //- Disallow default bitwise copy construct
  79         mixerFvMesh(const mixerFvMesh&);
  80
  81         //- Disallow default bitwise assignment
  82         void operator=(const mixerFvMesh&);
  83
  84
  85         //- Add mixer zones and modifiers
  86         void addZonesAndModifiers();
  87
  88         //- Return true if sliding interface is attached
  89         bool attached() const;
  90
  91         //- Calculate moving mask
  92         void calcMovingMask() const;
  93
  94         //- Return moving points mask
  95         const scalarField& movingPointsMask() const;
  96
  97
  98 public:
  99
 100     //- Runtime type information
 101     TypeName("mixerFvMesh");
 102
 103
 104     // Constructors
 105
 106         //- Construct from IOobject
 107         explicit mixerFvMesh(const IOobject& io);
 108
 109
 110     // Destructor
 111
 112         virtual ~mixerFvMesh();
 113
 114
 115     // Member Functions
 116
 117         //- Return coordinate system
 118         const coordinateSystem& cs() const
 119         {
 120             return csPtr_();
 121         }
 122
 123         //- Update the mesh for both mesh motion and topology change
 124         virtual bool update();
 125 };
 126
 127
 128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 129
 130 } // End namespace Foam
 131
 132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 133
 134 #endif
 135
 136 // ************************************************************************* //