ENH: autoLayerDriver: better layering information message
[OpenFOAM-2.0.x.git] / src / topoChangerFvMesh / mixerFvMesh / mixerFvMesh.H
blobf1552e29051457625ac7b31ef59f4c557c3ab32e
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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
13     the Free Software Foundation, either version 3 of the License, or
14     (at your option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::mixerFvMesh
27 Description
28     A rotating slider mesh
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 // Forward declaration of classes
48 /*---------------------------------------------------------------------------*\
49                            Class mixerFvMesh Declaration
50 \*---------------------------------------------------------------------------*/
52 class mixerFvMesh
54     public topoChangerFvMesh
56     // Private data
58         //- Motion dictionary
59         dictionary motionDict_;
61         //- Coordinate system
62         autoPtr<coordinateSystem> csPtr_;
64         // - Rotational speed in rotations per minute (rpm)
65         scalar rpm_;
67         //- Markup field for points.  Moving points marked with 1
68         mutable scalarField* movingPointsMaskPtr_;
71     // Private Member Functions
73         //- Disallow default bitwise copy construct
74         mixerFvMesh(const mixerFvMesh&);
76         //- Disallow default bitwise assignment
77         void operator=(const mixerFvMesh&);
80         //- Add mixer zones and modifiers
81         void addZonesAndModifiers();
83         //- Calculate moving masks
84         void calcMovingMasks() const;
86         //- Return moving points mask
87         const scalarField& movingPointsMask() const;
90 public:
92     //- Runtime type information
93     TypeName("mixerFvMesh");
96     // Constructors
98         //- Construct from IOobject
99         explicit mixerFvMesh(const IOobject& io);
102     //- Destructor
103     virtual ~mixerFvMesh();
106     // Member Functions
108         //- Return coordinate system
109         const coordinateSystem& cs() const
110         {
111             return csPtr_();
112         }
114         //- Update the mesh for both mesh motion and topology change
115         virtual bool update();
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 } // End namespace Foam
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 #endif
127 // ************************************************************************* //