ENH: autoLayerDriver: better layering information message
[OpenFOAM-2.0.x.git] / src / topoChangerFvMesh / linearValveLayersFvMesh / linearValveLayersFvMesh.H
blob5a9dd3d15cb12df005a55aa486303600ab4d6fcc
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::linearValveLayersFvMesh
27 Description
28     A sliding linear valve with layers
30 SourceFiles
31     linearValveFvMesh.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef linearValveLayersFvMesh_H
36 #define linearValveLayersFvMesh_H
38 #include "topoChangerFvMesh.H"
39 #include "motionSolver.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
46 /*---------------------------------------------------------------------------*\
47                        Class linearValveLayersFvMesh Declaration
48 \*---------------------------------------------------------------------------*/
50 class linearValveLayersFvMesh
52     public topoChangerFvMesh
54     // Private data
56         //- Motion dictionary
57         dictionary motionDict_;
60     // Private Member Functions
62         //- Disallow default bitwise copy construct
63         linearValveLayersFvMesh(const linearValveLayersFvMesh&);
65         //- Disallow default bitwise assignment
66         void operator=(const linearValveLayersFvMesh&);
69         //- Add linearValveLayers zones and modifiers
70         void addZonesAndModifiers();
72         //- Make layering modifiers live
73         void makeLayersLive();
75         //- Make sliding modifiers live
76         void makeSlidersLive();
78         //- Return true if sliders are attached
79         bool attached() const;
81         //- Return new point field
82         tmp<pointField> newPoints() const;
85 public:
87     //- Runtime type information
88     TypeName("linearValveLayersFvMesh");
91     // Constructors
93         //- Construct from database
94         explicit linearValveLayersFvMesh(const IOobject& io);
97     //- Destructor
98     virtual ~linearValveLayersFvMesh();
101     // Member Functions
103         //- Update the mesh for both mesh motion and topology change
104         virtual bool update();
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 } // End namespace Foam
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 #endif
116 // ************************************************************************* //