Clean up
[ShipHydroSIG.git] / src / vofDynamicMesh / lnInclude / sixDofMotion.H
blobb98506bcdf38fb7c640cba5ea4500f13f0cfdd3e
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     sixDofMotion
28 Description
30 SourceFiles
31     sixDofMotion.C
33 Author
34     Hrvoje Jasak, Wikki Ltd.  All rights reserved
36 \*---------------------------------------------------------------------------*/
38 #ifndef sixDofMotion_H
39 #define sixDofMotion_H
41 #include "dynamicFvMesh.H"
42 #include "floatingBodies.H"
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 namespace Foam
49 class motionSolver;
51 /*---------------------------------------------------------------------------*\
52                         Class sixDofMotion Declaration
53 \*---------------------------------------------------------------------------*/
55 class sixDofMotion
57     public dynamicFvMesh
59     // Private data
61         //- Motion dictionary
62         dictionary dict_;
64         //- Floating bodies
65         floatingBodies bodies_;
67         //- Mesh motion solver
68         autoPtr<motionSolver> motionPtr_;
71     // Private Member Functions
73         //- Disallow default bitwise copy construct
74         sixDofMotion(const sixDofMotion&);
76         //- Disallow default bitwise assignment
77         void operator=(const sixDofMotion&);
80 public:
82     //- Runtime type information
83     TypeName("sixDofMotion");
86     // Constructors
88         //- Construct from IOobject
89         sixDofMotion(const IOobject& io);
92     // Destructor
94         ~sixDofMotion();
97     // Member Functions
99         //- Update the mesh for both mesh motion and topology change
100         virtual bool update();
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 } // End namespace Foam
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 #endif
112 // ************************************************************************* //