OpenFOAM: API Guide
v2112
The open source CFD toolbox
symplectic.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) 2015-2016 OpenFOAM Foundation
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
Class
27
Foam::sixDoFSolvers::symplectic
28
29
Group
30
grpSixDoFRigidBodySolvers
31
32
Description
33
Symplectic 2nd-order explicit time-integrator for 6DoF solid-body motion.
34
35
Reference:
36
\verbatim
37
Dullweber, A., Leimkuhler, B., & McLachlan, R. (1997).
38
Symplectic splitting methods for rigid body molecular dynamics.
39
The Journal of chemical physics, 107(15), 5840-5851.
40
\endverbatim
41
42
Can only be used for explicit integration of the motion of the body,
43
i.e. may only be called once per time-step, no outer-correctors may be
44
applied. For implicit integration with outer-correctors choose either
45
CrankNicolson or Newmark schemes.
46
47
Example specification in dynamicMeshDict:
48
\verbatim
49
solver
50
{
51
type symplectic;
52
}
53
\endverbatim
54
55
See also
56
Foam::sixDoFSolvers::CrankNicolson
57
Foam::sixDoFSolvers::Newmark
58
59
SourceFiles
60
symplectic.C
61
62
\*---------------------------------------------------------------------------*/
63
64
#ifndef symplectic_H
65
#define symplectic_H
66
67
#include "
sixDoFSolver.H
"
68
69
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
70
71
namespace
Foam
72
{
73
namespace
sixDoFSolvers
74
{
75
76
/*---------------------------------------------------------------------------*\
77
Class symplectic Declaration
78
\*---------------------------------------------------------------------------*/
79
80
class
symplectic
81
:
82
public
sixDoFSolver
83
{
84
85
public
:
86
87
//- Runtime type information
88
TypeName
(
"symplectic"
);
89
90
91
// Constructors
92
93
//- Construct from a dictionary and the body
94
symplectic
95
(
96
const
dictionary
&
dict
,
97
sixDoFRigidBodyMotion
& body
98
);
99
100
//- Construct and return a clone
101
virtual
autoPtr<sixDoFSolver>
clone
()
const
102
{
103
return
autoPtr<sixDoFSolver>::NewFrom<symplectic>
(
dict_
,
body_
);
104
}
105
106
107
//- Destructor
108
virtual
~symplectic
();
109
110
111
// Member Functions
112
113
//- Drag coefficient
114
virtual
void
solve
115
(
116
bool
firstIter,
117
const
vector
& fGlobal,
118
const
vector
& tauGlobal,
119
scalar deltaT,
120
scalar deltaT0
121
);
122
};
123
124
125
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126
127
}
// End namespace sixDoFSolvers
128
}
// End namespace Foam
129
130
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131
132
#endif
133
134
// ************************************************************************* //
Foam::Vector< scalar >
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition:
autoPtr.H:66
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition:
dictionary.H:126
Foam::sixDoFRigidBodyMotion
Six degree of freedom motion for a rigid body.
Definition:
sixDoFRigidBodyMotion.H:70
Foam::sixDoFSolver
Definition:
sixDoFSolver.H:55
Foam::sixDoFSolver::dict_
dictionary dict_
Model dictionary.
Definition:
sixDoFSolver.H:64
Foam::sixDoFSolver::body_
sixDoFRigidBodyMotion & body_
The rigid body.
Definition:
sixDoFSolver.H:61
Foam::sixDoFSolvers::symplectic
Symplectic 2nd-order explicit time-integrator for 6DoF solid-body motion.
Definition:
symplectic.H:82
Foam::sixDoFSolvers::symplectic::TypeName
TypeName("symplectic")
Runtime type information.
Foam::sixDoFSolvers::symplectic::clone
virtual autoPtr< sixDoFSolver > clone() const
Construct and return a clone.
Definition:
symplectic.H:100
Foam::sixDoFSolvers::symplectic::~symplectic
virtual ~symplectic()
Destructor.
Definition:
symplectic.C:57
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:34
dict
dictionary dict
Definition:
searchingEngine.H:14
sixDoFSolver.H
solve
CEqn solve()
TypeName
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition:
typeInfo.H:73
src
sixDoFRigidBodyMotion
sixDoFSolvers
symplectic
symplectic.H
Generated by
1.9.5
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.