initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / dynamicFvMesh / solidBodyMotionFvMesh / solidBodyMotionFvMesh.H
bloba8e251c8ddce1876e3597fecec996a9c988a057b
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::solidBodyMotionFvMesh
28 Description
29     Solid-body motion of the mesh specified by a run-time selectable
30     motion function.
32 SourceFiles
33     solidBodyMotionFvMesh.C
35 \*---------------------------------------------------------------------------*/
37 #ifndef solidBodyMotionFvMesh_H
38 #define solidBodyMotionFvMesh_H
40 #include "dynamicFvMesh.H"
41 #include "dictionary.H"
42 #include "pointIOField.H"
43 #include "solidBodyMotionFunction.H"
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 namespace Foam
50 /*---------------------------------------------------------------------------*\
51                            Class solidBodyMotionFvMesh Declaration
52 \*---------------------------------------------------------------------------*/
54 class solidBodyMotionFvMesh
56     public dynamicFvMesh
58     // Private data
60         //- Dictionary of motion control parameters
61         dictionary dynamicMeshCoeffs_;
63         //- The motion control function
64         autoPtr<solidBodyMotionFunction> SBMFPtr_;
66         //- The reference points which are transformed
67         pointIOField undisplacedPoints_;
70     // Private Member Functions
72         //- Disallow default bitwise copy construct
73         solidBodyMotionFvMesh(const solidBodyMotionFvMesh&);
75         //- Disallow default bitwise assignment
76         void operator=(const solidBodyMotionFvMesh&);
79 public:
81     //- Runtime type information
82     TypeName("solidBodyMotionFvMesh");
85     // Constructors
87         //- Construct from IOobject
88         solidBodyMotionFvMesh(const IOobject& io);
91     // Destructor
93         ~solidBodyMotionFvMesh();
96     // Member Functions
98         //- Update the mesh for both mesh motion and topology change
99         virtual bool update();
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 } // End namespace Foam
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 #endif
111 // ************************************************************************* //