Clean up
[ShipHydroSIG.git] / src / vofDynamicMesh / lnInclude / graphSolidMotion.H
blob48875670aa206a23b052a13a86bfbd61311b76bd
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     graphSolidMotion
28 Description
29     Automatic motion of the mesh given graphs for
30     6-DOF translation and 3-axis rotation
32 SourceFiles
33     graphSolidMotion.C
35 Author
36     Hrvoje Jasak, Wikki Ltd.  All rights reserved.
38 \*---------------------------------------------------------------------------*/
40 #ifndef graphSolidMotion_H
41 #define graphSolidMotion_H
43 #include "dynamicFvMesh.H"
44 #include "dimensionedTypes.H"
45 #include "Switch.H"
46 #include "graph.H"
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 namespace Foam
53 class motionSolver;
55 /*---------------------------------------------------------------------------*\
56                    Class graphSolidMotion Declaration
57 \*---------------------------------------------------------------------------*/
59 class graphSolidMotion
61     public dynamicFvMesh
63     // Private data
65         //- Moving mesh dictionary
66         dictionary dict_;
68         //- Reference points from constant directory
69         pointIOField refPoints_;
71         //- Centre of motion
72         vector motionCentre_;
75         // Translation
77             //- x-translation
78             graph x_;
80             //- y-translation
81             graph y_;
83             //- x-translation
84             graph z_;
87         // Rotation
88     
89             //- x-rotation
90             graph xRot_;
92             //- y-rotation
93             graph yRot_;
95             //- z-rotation
96             graph zRot_;
98             //- Is rotation given in degrees?
99             Switch inDegrees_;
102     // Private Member Functions
104         //- Disallow default bitwise copy construct
105         graphSolidMotion(const graphSolidMotion&);
107         //- Disallow default bitwise assignment
108         void operator=(const graphSolidMotion&);
111         // Return current position of centroid
112         vector centre() const;
114         //- Return current local-to-global transform
115         vector rotation() const;
118 public:
120     //- Runtime type information
121     TypeName("graphSolidMotion");
124     // Constructors
126         //- Construct from IOobject
127         graphSolidMotion(const IOobject& io);
130     // Destructor
132         ~graphSolidMotion();
135     // Member Functions
137         //- Update the mesh for both mesh motion and topology change
138         virtual bool update();
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 } // End namespace Foam
146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 #endif
150 // ************************************************************************* //