Clean up
[ShipHydroSIG.git] / src / vofDynamicMesh / lnInclude / sixDofTopoMotion.H
bloba5e00370c491f06d2993d6c9e6e683cf33ffe9c6
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     sixDofTopoMotion
28 Description
29     Multi-body motion with sliding interfaces.
31 Author
32     Hrvoje Jasak, Wikki Ltd.  All rights reserved.
34 SourceFiles
35     sixDofTopoMotion.C
37 \*---------------------------------------------------------------------------*/
39 #ifndef sixDofTopoMotion_H
40 #define sixDofTopoMotion_H
42 #include "topoChangerFvMesh.H"
43 #include "floatingBodies.H"
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 namespace Foam
50 class motionSolver;
52 /*---------------------------------------------------------------------------*\
53                         Class sixDofTopoMotion Declaration
54 \*---------------------------------------------------------------------------*/
56 class sixDofTopoMotion
58     public topoChangerFvMesh
60     // Private data
62         //- Motion dictionary
63         dictionary dict_;
65         //- Floating bodies
66         floatingBodies bodies_;
68         //- Use topological sliding.  Other option is GGI
69         const Switch useTopoSliding_;
71         //- Mesh motion solver
72         autoPtr<motionSolver> motionPtr_;
75     // Private Member Functions
77         //- Disallow default bitwise copy construct
78         sixDofTopoMotion(const sixDofTopoMotion&);
80         //- Disallow default bitwise assignment
81         void operator=(const sixDofTopoMotion&);
84         // Topology controls
86             //- Add sliding interface zones and modifiers
87             void addZonesAndModifiers();
89             //- Return true if sliders are attached
90             bool attached() const;
93 public:
95     //- Runtime type information
96     TypeName("sixDofTopoMotion");
99     // Constructors
101         //- Construct from IOobject
102         explicit sixDofTopoMotion(const IOobject& io);
105     // Destructor
107         ~sixDofTopoMotion();
110     // Member Functions
112         //- Update the mesh for both mesh motion and topology change
113         virtual bool update();
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 } // End namespace Foam
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 #endif
125 // ************************************************************************* //