Forward compatibility: flex
[foam-extend-3.2.git] / src / dynamicMesh / topoChangerFvMesh / mixerFvMesh / mixerFvMesh.H
blob59b21c099b1d2f383e51d41876712da6c83ad4c6
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.
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.
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.
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/>.
24 Class
25     Foam::mixerFvMesh
27 Description
28     Mixer mesh using a sliding interface.
30 SourceFiles
31     mixerFvMesh.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef mixerFvMesh_H
36 #define mixerFvMesh_H
38 #include "topoChangerFvMesh.H"
39 #include "cylindricalCS.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
46 /*---------------------------------------------------------------------------*\
47                            Class mixerFvMesh Declaration
48 \*---------------------------------------------------------------------------*/
50 class mixerFvMesh
52     public topoChangerFvMesh
54     // Private data
56         //- Motion dictionary
57         dictionary dict_;
59         //- Coordinate system
60         cylindricalCS cs_;
62         // - Rotational speed in rotations per minute (rpm)
63         scalar rpm_;
65         //- Rotating region marker point
66         point rotatingRegionMarker_;
68         //- Attach-detach action
69         Switch attachDetach_;
71         //- Markup field for points.  Moving points marked with 1
72         mutable scalarField* movingPointsMaskPtr_;
75     // Private Member Functions
77         //- Disallow default bitwise copy construct
78         mixerFvMesh(const mixerFvMesh&);
80         //- Disallow default bitwise assignment
81         void operator=(const mixerFvMesh&);
84         //- Add mixer zones and modifiers
85         void addZonesAndModifiers();
87         //- Return true if sliding interface is attached
88         bool attached() const;
90         //- Calculate moving mask
91         void calcMovingMask() const;
93         //- Return moving points mask
94         const scalarField& movingPointsMask() const;
97 public:
99     //- Runtime type information
100     TypeName("mixerFvMesh");
103     // Constructors
105         //- Construct from IOobject
106         explicit mixerFvMesh(const IOobject& io);
109     // Destructor
111         virtual ~mixerFvMesh();
114     // Member Functions
116         //- Return coordinate system
117         const cylindricalCS& cs() const
118         {
119             return cs_;
120         }
122         //- Update the mesh for both mesh motion and topology change
123         virtual bool update();
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 } // End namespace Foam
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 #endif
135 // ************************************************************************* //