ENH: autoLayerDriver: better layering information message
[OpenFOAM-2.0.x.git] / src / dynamicFvMesh / solidBodyMotionFvMesh / solidBodyMotionFvMesh.H
blob4930a21cf6b8672ad267502d876b12ea440259d1
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::solidBodyMotionFvMesh
27 Description
28     Solid-body motion of the mesh specified by a run-time selectable
29     motion function.
31 SourceFiles
32     solidBodyMotionFvMesh.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef solidBodyMotionFvMesh_H
37 #define solidBodyMotionFvMesh_H
39 #include "dynamicFvMesh.H"
40 #include "dictionary.H"
41 #include "pointIOField.H"
42 #include "solidBodyMotionFunction.H"
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 namespace Foam
49 /*---------------------------------------------------------------------------*\
50                            Class solidBodyMotionFvMesh Declaration
51 \*---------------------------------------------------------------------------*/
53 class solidBodyMotionFvMesh
55     public dynamicFvMesh
57     // Private data
59         //- Dictionary of motion control parameters
60         dictionary dynamicMeshCoeffs_;
62         //- The motion control function
63         autoPtr<solidBodyMotionFunction> SBMFPtr_;
65         //- The reference points which are transformed
66         pointIOField undisplacedPoints_;
69     // Private Member Functions
71         //- Disallow default bitwise copy construct
72         solidBodyMotionFvMesh(const solidBodyMotionFvMesh&);
74         //- Disallow default bitwise assignment
75         void operator=(const solidBodyMotionFvMesh&);
78 public:
80     //- Runtime type information
81     TypeName("solidBodyMotionFvMesh");
84     // Constructors
86         //- Construct from IOobject
87         solidBodyMotionFvMesh(const IOobject& io);
90     //- Destructor
91     ~solidBodyMotionFvMesh();
94     // Member Functions
96         //- Update the mesh for both mesh motion and topology change
97         virtual bool update();
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 } // End namespace Foam
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 #endif
109 // ************************************************************************* //