softWall.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) 2022 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 #include "softWall.H"
30 #include "sixDoFRigidBodyMotion.H"
31 
32 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36 namespace sixDoFRigidBodyMotionRestraints
37 {
38  defineTypeNameAndDebug(softWall, 0);
39 
41  (
42  sixDoFRigidBodyMotionRestraint,
43  softWall,
44  dictionary
45  );
46 }
47 }
48 
49 
50 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
51 
53 (
54  const word& name,
55  const dictionary& sDoFRBMRDict
56 )
57 :
58  sixDoFRigidBodyMotionRestraint(name, sDoFRBMRDict),
59  anchor_(Zero),
60  refAttachmentPt_(Zero),
61  wallNormal_(Zero),
62  psi_(0),
63  C_(0)
64 {
65  read(sDoFRBMRDict);
66 }
67 
68 
69 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
70 
72 (
73  const sixDoFRigidBodyMotion& motion,
74  vector& restraintPosition,
75  vector& restraintForce,
76  vector& restraintMoment
77 ) const
78 {
79  restraintPosition = motion.transform(refAttachmentPt_);
80  restraintForce = Zero;
81  restraintMoment = Zero;
82 
83  const vector r(restraintPosition - anchor_);
84 
85  const vector v(motion.velocity(restraintPosition));
86 
87  const scalar d = (wallNormal_/mag(wallNormal_)) & r;
88 
89  const vector rDir(r/(mag(r) + VSMALL));
90 
91  const scalar m = motion.mass();
92  const scalar wn = 3.14/C_;
93  const scalar damping = psi_*2*wn*m;
94  const scalar stiffness = sqr(wn)*m;
95 
96  if (d < 0)
97  {
98  restraintForce = (-damping*(rDir & v) + stiffness*d)*rDir;
99  restraintMoment = restraintPosition^restraintForce;
100  }
101 
102  if (motion.report())
103  {
104  Info<< " restraintPosition: " << restraintPosition
105  << " restraintForce: " << restraintForce
106  << " restraintMoment: " << restraintMoment
107  << endl;
108  }
109 }
110 
111 
113 (
114  const dictionary& sDoFRBMRDict
115 )
116 {
117  if (!sixDoFRigidBodyMotionRestraint::read(sDoFRBMRDict))
118  {
119  return false;
120  }
121 
122  sDoFRBMRCoeffs_.readEntry("anchor", anchor_);
123  sDoFRBMRCoeffs_.readEntry("refAttachmentPt", refAttachmentPt_);
124  sDoFRBMRCoeffs_.readEntry("wallNormal", wallNormal_);
125  sDoFRBMRCoeffs_.readEntry("psi", psi_);
126  sDoFRBMRCoeffs_.readEntry("C", C_);
127 
128  return true;
129 }
130 
131 
133 (
134  Ostream& os
135 ) const
136 {
137  os.writeEntry("anchor", anchor_);
138  os.writeEntry("refAttachmentPt", refAttachmentPt_);
139  os.writeEntry("wallNormal", wallNormal_);
140  os.writeEntry("psi", psi_);
141  os.writeEntry("C", C_);
142 }
143 
144 
145 // ************************************************************************* //
Six degree of freedom motion for a rigid body.
bool report() const
Return the report Switch.
dimensioned< typename typeOfMag< Type >::type > mag(const dimensioned< Type > &dt)
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
dimensionedSymmTensor sqr(const dimensionedVector &dv)
Base class for defining restraints for sixDoF motions.
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:531
point transform(const point &initialPoints) const
Transform the given initial state point by the current motion.
softWall(const word &name, const dictionary &sDoFRBMRDict)
Construct from components.
Definition: softWall.C:46
virtual void restrain(const sixDoFRigidBodyMotion &motion, vector &restraintPosition, vector &restraintForce, vector &restraintMoment) const
Calculate the restraint position, force and moment.
Definition: softWall.C:65
Macros for easy insertion into run-time selection tables.
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for expressions::valueTypeCode::INVALID.
Definition: exprTraits.C:127
A class for handling words, derived from Foam::string.
Definition: word.H:63
virtual bool read(const dictionary &sDoFRBMRDict)
Update properties from given dictionary.
defineTypeNameAndDebug(linearAxialAngularSpring, 0)
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:56
A Vector of values with scalar precision, where scalar is float/double depending on the compilation f...
OBJstream os(runTime.globalPath()/outputName)
addToRunTimeSelectionTable(sixDoFRigidBodyMotionRestraint, linearAxialAngularSpring, dictionary)
point velocity(const point &pt) const
Return the velocity of a position.
virtual void write(Ostream &) const
Write.
Definition: softWall.C:126
scalar mass() const
Return the mass.
messageStream Info
Information stream (stdout output on master, null elsewhere)
virtual bool read(const dictionary &sDoFRBMRCoeff)
Update properties from given dictionary.
Definition: softWall.C:106
Namespace for OpenFOAM.
static constexpr const zero Zero
Global zero (0)
Definition: zero.H:127