correction to d4edb38234db8268907f04836d49bb93461b8a88
[OpenFOAM-1.5.x.git] / src / topoChangerFvMesh / mixerFvMesh / mixerFvMesh.H
blob4c12e1edb43cec5abee36154923f5ffa6f64aa7b
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     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, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::mixerFvMesh
28 Description
29     A rotating slider mesh
31 SourceFiles
32     mixerFvMesh.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef mixerFvMesh_H
37 #define mixerFvMesh_H
39 #include "topoChangerFvMesh.H"
40 #include "cylindricalCS.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
47 // Forward declaration of classes
49 /*---------------------------------------------------------------------------*\
50                            Class mixerFvMesh Declaration
51 \*---------------------------------------------------------------------------*/
53 class mixerFvMesh
55     public topoChangerFvMesh
57     // Private data
59         //- Motion dictionary
60         dictionary motionDict_;
62         //- Coordinate system
63         autoPtr<coordinateSystem> csPtr_;
65         // - Rotational speed in rotations per minute (rpm)
66         scalar rpm_;
68         //- Markup field for points.  Moving points marked with 1
69         mutable scalarField* movingPointsMaskPtr_;
72     // Private Member Functions
74         //- Disallow default bitwise copy construct
75         mixerFvMesh(const mixerFvMesh&);
77         //- Disallow default bitwise assignment
78         void operator=(const mixerFvMesh&);
81         //- Add mixer zones and modifiers
82         void addZonesAndModifiers();
84         //- Calculate moving masks
85         void calcMovingMasks() const;
87         //- Return moving points mask
88         const scalarField& movingPointsMask() const;
91 public:
93     //- Runtime type information
94     TypeName("mixerFvMesh");
97     // Constructors
99         //- Construct from IOobject
100         explicit mixerFvMesh(const IOobject& io);
103     // Destructor
105         virtual ~mixerFvMesh();
108     // Member Functions
110         //- Return coordinate system
111         const coordinateSystem& cs() const
112         {
113             return csPtr_();
114         }
116         //- Update the mesh for both mesh motion and topology change
117         virtual bool update();
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 } // End namespace Foam
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 #endif
129 // ************************************************************************* //