Clean up
[ShipHydroSIG.git] / src / vofDynamicMesh / lnInclude / harmonicSolidMotion.H
blob95fe9d7e5b3b57c879a369e27a186cae8dab9ee6
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     harmonicSolidMotion
28 Description
29     Harmonic mesh motion: 6-DOF translation and rotation
30     with independent amplitudes, periods and phase lags
32 SourceFiles
33     harmonicSolidMotion.C
35 Author
36     Hrvoje Jasak, Wikki Ltd.  All rights reserved.
38 \*---------------------------------------------------------------------------*/
40 #ifndef harmonicSolidMotion_H
41 #define harmonicSolidMotion_H
43 #include "dynamicFvMesh.H"
44 #include "dimensionedTypes.H"
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 namespace Foam
51 class motionSolver;
53 /*---------------------------------------------------------------------------*\
54                    Class harmonicSolidMotion Declaration
55 \*---------------------------------------------------------------------------*/
57 class harmonicSolidMotion
59     public dynamicFvMesh
61     // Private data
63         //- Moving mesh dictionary
64         dictionary dict_;
66         //- Reference points from constant directory
67         pointIOField refPoints_;
69         //- Centre of motion
70         vector motionCentre_;
73         // Translation
75             //- Translation amplitude
76             vector transL_;
78             //- Translation period
79             vector transOmega_;
81             //- Translation phase
82             vector transPsi_;
85         // Rotation
87             //- Rotation amplitude
88             vector rotL_;
90             //- Rotation period
91             vector rotOmega_;
93             //- Rotation phase
94             vector rotPsi_;
97     // Private Member Functions
99         //- Disallow default bitwise copy construct
100         harmonicSolidMotion(const harmonicSolidMotion&);
102         //- Disallow default bitwise assignment
103         void operator=(const harmonicSolidMotion&);
106         // Return current position of centroid
107         vector centre() const;
109         //- Return current local-to-global transform
110         vector rotation() const;
112         //- Convert period to frequency
113         static vector periodToFreq(const vector deg);
116 public:
118     //- Runtime type information
119     TypeName("harmonicSolidMotion");
122     // Constructors
124         //- Construct from IOobject
125         harmonicSolidMotion(const IOobject& io);
128     // Destructor
130         ~harmonicSolidMotion();
133     // Member Functions
135         //- Update the mesh for both mesh motion and topology change
136         virtual bool update();
140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
142 } // End namespace Foam
144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
146 #endif
148 // ************************************************************************* //