Merge remote-tracking branch 'origin/nr/multiSolverFix' into nextRelease
[foam-extend-3.2.git] / src / dynamicMesh / topoChangerFvMesh / multiMixerFvMesh / multiMixerFvMesh.H
blob1a110ac8c5dfdece7666688ebbc8f72d9feeaa46
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.
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     multiMixerFvMesh
28 Description
29     Mixer mesh with multiple rotors.
31 Author
32     Hrvoje Jasak, Wikki Ltd.  All rights reserved.
34 SourceFiles
35     multiMixerFvMesh.C
37 \*---------------------------------------------------------------------------*/
39 #ifndef multiMixerFvMesh_H
40 #define multiMixerFvMesh_H
42 #include "topoChangerFvMesh.H"
43 #include "mixerRotor.H"
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 namespace Foam
50 /*---------------------------------------------------------------------------*\
51                    Class multiMixerFvMesh Declaration
52 \*---------------------------------------------------------------------------*/
54 class multiMixerFvMesh
56     public topoChangerFvMesh
58     // Private data
60         //- Motion dictionary
61         dictionary dict_;
63         //- Mixer rotors
64         PtrList<mixerRotor> rotors_;
66         //- Attach-detach action
67         Switch attachDetach_;
70     // Private Member Functions
72         //- Disallow default bitwise copy construct
73         multiMixerFvMesh(const multiMixerFvMesh&);
75         //- Disallow default bitwise assignment
76         void operator=(const multiMixerFvMesh&);
79         //- Add mixer rotor zones and modifiers
80         void addZonesAndModifiers();
82         //- Return true if any of the rotors uses a topological change
83         bool useTopoSliding() const;
85         //- Check that rotors using a topological change are in sync
86         void checkRotors() const;
88         //- Return true if sliding interface are attached
89         bool attached() const;
92 public:
94     //- Runtime type information
95     TypeName("multiMixerFvMesh");
98     // Constructors
100         //- Construct from IOobject
101         explicit multiMixerFvMesh(const IOobject& io);
104     // Destructor
106         virtual ~multiMixerFvMesh();
109     // Member Functions
111         //- Update the mesh for both mesh motion and topology change
112         virtual bool update();
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 } // End namespace Foam
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 #endif
124 // ************************************************************************* //