symplectic.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2015-2024 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
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.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::sixDoFSolvers::symplectic
26 
27 Description
28  Symplectic 2nd-order explicit time-integrator for 6DoF solid-body motion.
29 
30  Reference:
31  \verbatim
32  Dullweber, A., Leimkuhler, B., & McLachlan, R. (1997).
33  Symplectic splitting methods for rigid body molecular dynamics.
34  The Journal of chemical physics, 107(15), 5840-5851.
35  \endverbatim
36 
37  Can only be used for explicit integration of the motion of the body,
38  i.e. may only be called once per time-step, no outer-correctors may be
39  applied. For implicit integration with outer-correctors choose either
40  CrankNicolson or Newmark schemes.
41 
42  Example specification in dynamicMeshDict:
43  \verbatim
44  solver
45  {
46  type symplectic;
47  }
48  \endverbatim
49 
50 See also
51  Foam::sixDoFSolvers::CrankNicolson
52  Foam::sixDoFSolvers::Newmark
53 
54 SourceFiles
55  symplectic.C
56 
57 \*---------------------------------------------------------------------------*/
58 
59 #ifndef symplectic_H
60 #define symplectic_H
61 
62 #include "sixDoFSolver.H"
63 
64 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
65 
66 namespace Foam
67 {
68 namespace sixDoFSolvers
69 {
70 
71 /*---------------------------------------------------------------------------*\
72  Class symplectic Declaration
73 \*---------------------------------------------------------------------------*/
74 
75 class symplectic
76 :
77  public sixDoFSolver
78 {
79 
80 public:
81 
82  //- Runtime type information
83  TypeName("symplectic");
84 
85 
86  // Constructors
87 
88  //- Construct from a dictionary and the body
90  (
91  const dictionary& dict,
93  );
94 
95 
96  //- Destructor
97  virtual ~symplectic();
98 
99 
100  // Member Functions
101 
102  //- Drag coefficient
103  virtual void solve
104  (
105  bool firstIter,
106  const vector& fGlobal,
107  const vector& tauGlobal,
108  scalar deltaT,
109  scalar deltaT0
110  );
111 };
112 
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 } // End namespace sixDoFSolvers
117 } // End namespace Foam
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 #endif
122 
123 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Six degree of freedom motion for a rigid body.
Symplectic 2nd-order explicit time-integrator for 6DoF solid-body motion.
Definition: symplectic.H:77
TypeName("symplectic")
Runtime type information.
virtual ~symplectic()
Destructor.
Definition: symplectic.C:55
symplectic(const dictionary &dict, sixDoFRigidBodyMotion &body)
Construct from a dictionary and the body.
Definition: symplectic.C:44
virtual void solve(bool firstIter, const vector &fGlobal, const vector &tauGlobal, scalar deltaT, scalar deltaT0)
Drag coefficient.
Definition: symplectic.C:62
Namespace for OpenFOAM.
dictionary dict