sixDofRigidBodyMotionDoc.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2016 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
27 
28 \defgroup grpSixDoFRigidBody Six Degree of Freedom (DoF)
29 @{
30  \ingroup grpMeshMotion
31  This group contains six DoF models.
32 @}
33 
34 \defgroup grpSixDoFRigidBodySolvers Solvers
35 @{
36  \ingroup grpSixDoFRigidBody
37  This group contains six DoF solvers.
38 @}
39 
40 \defgroup grpSixDoFRigidBodyConstraints Constraints
41 @{
42  \ingroup grpSixDoFRigidBody
43  This group contains six DoF Constraints.
44 @}
45 
46 \defgroup grpSixDoFRigidBodyRestraints Restraints
47 @{
48  \ingroup grpSixDoFRigidBody
49  This group contains six DoF Restraints.
50 @}
51 
52 \*---------------------------------------------------------------------------*/