initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / topoChangerFvMesh / linearValveFvMesh / linearValveFvMesh.H
blob42c510605f331c31a9cf77bfdf73f686446bf28a
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2009 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::linearValveFvMesh
28 Description
29     A sliding linear valve
31 SourceFiles
32     linearValveFvMesh.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef linearValveFvMesh_H
37 #define linearValveFvMesh_H
39 #include "topoChangerFvMesh.H"
40 #include "motionSolver.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
47 /*---------------------------------------------------------------------------*\
48                        Class linearValveFvMesh Declaration
49 \*---------------------------------------------------------------------------*/
51 class linearValveFvMesh
53     public topoChangerFvMesh
55     // Private data
57         //- Motion dictionary
58         dictionary motionDict_;
60         //- Motion solver
61         autoPtr<motionSolver> msPtr_;
64     // Private Member Functions
66         //- Disallow default bitwise copy construct
67         linearValveFvMesh(const linearValveFvMesh&);
69         //- Disallow default bitwise assignment
70         void operator=(const linearValveFvMesh&);
73         //- Add linearValve zones and modifiers
74         void addZonesAndModifiers();
76         //- Make sliding modifiers live
77         void makeSlidersDead();
79         //- Make sliding modifiers live
80         void makeSlidersLive();
82         //- Return true if sliders are attached
83         bool attached() const;
86 public:
88     //- Runtime type information
89     TypeName("linearValveFvMesh");
92     // Constructors
94         //- Construct from database
95         explicit linearValveFvMesh(const IOobject& io);
98     // Destructor
100         virtual ~linearValveFvMesh();
103     // Member Functions
105         //- Update the mesh for both mesh motion and topology change
106         virtual bool update();
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 } // End namespace Foam
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 #endif
118 // ************************************************************************* //