CrankNicolson.C
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 OpenFOAM Foundation
9  Copyright (C) 2020-2023 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "CrankNicolson.H"
31 
32 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36 namespace sixDoFSolvers
37 {
40 }
41 }
42 
43 
44 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
45 
47 (
48  const dictionary& dict,
50 )
51 :
52  sixDoFSolver(dict, body),
53  aoc_(dict.getOrDefault<scalar>("aoc", 0.5)),
54  voc_(dict.getOrDefault<scalar>("voc", 0.5))
55 {}
56 
57 
58 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
59 
61 {}
62 
63 
64 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
65 
67 (
68  bool firstIter,
69  const vector& fGlobal,
70  const vector& tauGlobal,
71  scalar deltaT,
72  scalar deltaT0
73 )
74 {
75  // Update the linear acceleration and torque
76  updateAcceleration(fGlobal, tauGlobal);
77 
78  // Update the constraints to the object
79  updateConstraints();
80 
81  // Correct linear velocity
82  v() = tConstraints()
83  & (v0() + aDamp()*deltaT*(aoc_*a() + (1 - aoc_)*a0()));
84 
85  // Correct angular momentum
86  pi() = rConstraints()
87  & (pi0() + aDamp()*deltaT*(aoc_*tau() + (1 - aoc_)*tau0()));
88 
89  // Correct position
90  centreOfRotation() =
91  centreOfRotation0() + deltaT*(voc_*v() + (1 - voc_)*v0());
92 
93  // Correct orientation
95  rotate(Q0(), (voc_*pi() + (1 - voc_)*pi0()), deltaT);
96  Q() = Qpi.first();
97 }
98 
99 // ************************************************************************* //
Six degree of freedom motion for a rigid body.
dictionary dict
CrankNicolson(const dictionary &dict, sixDoFRigidBodyMotion &body)
Construct from a dictionary and the body.
Definition: CrankNicolson.C:40
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
A 2-tuple for storing two objects of dissimilar types. The container is similar in purpose to std::pa...
Definition: stringOps.H:54
virtual void solve(bool firstIter, const vector &fGlobal, const vector &tauGlobal, scalar deltaT, scalar deltaT0)
Drag coefficient.
Definition: CrankNicolson.C:60
defineTypeNameAndDebug(CrankNicolson, 0)
Macros for easy insertion into run-time selection tables.
addToRunTimeSelectionTable(sixDoFSolver, CrankNicolson, dictionary)
constexpr scalar pi(M_PI)
Crank-Nicolson 2nd-order time-integrator for 6DoF solid-body motion.
Definition: CrankNicolson.H:70
A Vector of values with scalar precision, where scalar is float/double depending on the compilation f...
virtual ~CrankNicolson()
Destructor.
Definition: CrankNicolson.C:53
const dimensionedScalar a0
Bohr radius: default SI units: [m].
Namespace for OpenFOAM.