linearSpring.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) 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 \*---------------------------------------------------------------------------*/
27 
28 #include "linearSpring.H"
29 #include "rigidBodyModel.H"
31 
32 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36 namespace RBD
37 {
38 namespace restraints
39 {
40  defineTypeNameAndDebug(linearSpring, 0);
41 
43  (
44  restraint,
45  linearSpring,
46  dictionary
47  );
48 }
49 }
50 }
51 
52 
53 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
54 
56 (
57  const word& name,
58  const dictionary& dict,
59  const rigidBodyModel& model
60 )
61 :
62  restraint(name, dict, model)
63 {
64  read(dict);
65 }
66 
67 
68 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
69 
71 {}
72 
73 
74 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
75 
77 (
78  scalarField& tau,
80  const rigidBodyModelState& state
81 ) const
82 {
83  point attachmentPt = bodyPoint(refAttachmentPt_);
84 
85  // Current axis of the spring
86  vector r = attachmentPt - anchor_;
87  scalar magR = mag(r);
88  r /= (magR + VSMALL);
89 
90  // Velocity of the attached end of the spring
91  vector v = bodyPointVelocity(refAttachmentPt_).l();
92 
93  // Force and moment on the master body including optional damping
94  vector force
95  (
96  (-stiffness_*(magR - restLength_) - damping_*(r & v))*r
97  );
98 
99  vector moment(attachmentPt ^ force);
100 
101  if (model_.debug)
102  {
103  Info<< " attachmentPt " << attachmentPt
104  << " attachmentPt - anchor " << r*magR
105  << " spring length " << magR
106  << " force " << force
107  << " moment " << moment
108  << endl;
109  }
110 
111  // Accumulate the force for the restrained body
112  fx[bodyIndex_] += spatialVector(moment, force);
113 }
114 
115 
117 (
118  const dictionary& dict
119 )
120 {
122 
123  coeffs_.readEntry("anchor", anchor_);
124  coeffs_.readEntry("refAttachmentPt", refAttachmentPt_);
125  coeffs_.readEntry("stiffness", stiffness_);
126  coeffs_.readEntry("damping", damping_);
127  coeffs_.readEntry("restLength", restLength_);
128 
129  return true;
130 }
131 
132 
134 (
135  Ostream& os
136 ) const
137 {
139 
140  os.writeEntry("anchor", anchor_);
141  os.writeEntry("refAttachmentPt", refAttachmentPt_);
142  os.writeEntry("stiffness", stiffness_);
143  os.writeEntry("damping", damping_);
144  os.writeEntry("restLength", restLength_);
145 }
146 
147 
148 // ************************************************************************* //
Foam::RBD::restraints::linearSpring::write
virtual void write(Ostream &) const
Write.
Definition: linearSpring.C:134
Foam::RBD::restraints::addToRunTimeSelectionTable
addToRunTimeSelectionTable(restraint, externalForce, dictionary)
Foam::RBD::restraints::defineTypeNameAndDebug
defineTypeNameAndDebug(externalForce, 0)
Foam::RBD::rigidBodyModelState
Holds the motion state of rigid-body model.
Definition: rigidBodyModelState.H:67
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
rigidBodyModel.H
Foam::RBD::restraints::linearSpring::linearSpring
linearSpring(const word &name, const dictionary &dict, const rigidBodyModel &model)
Construct from components.
Definition: linearSpring.C:56
Foam::blockMeshTools::read
void read(Istream &, label &val, const dictionary &)
In-place read with dictionary lookup.
Definition: blockMeshTools.C:57
linearSpring.H
Foam::Field< scalar >
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
Foam::RBD::restraint::read
virtual bool read(const dictionary &dict)
Update properties from given dictionary.
Definition: rigidBodyRestraint.C:74
Foam::RBD::restraints::linearSpring::restrain
virtual void restrain(scalarField &tau, Field< spatialVector > &fx, const rigidBodyModelState &state) const
Accumulate the restraint internal joint forces into the tau field and.
Definition: linearSpring.C:77
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::RBD::rigidBodyModel
Basic rigid-body model representing a system of rigid-bodies connected by 1-6 DoF joints.
Definition: rigidBodyModel.H:83
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
os
OBJstream os(runTime.globalPath()/outputName)
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::RBD::restraints::linearSpring::~linearSpring
virtual ~linearSpring()
Destructor.
Definition: linearSpring.C:70
Foam::Vector< scalar >
Foam::mag
dimensioned< typename typeOfMag< Type >::type > mag(const dimensioned< Type > &dt)
Foam::RBD::restraint::write
virtual void write(Ostream &) const =0
Write.
Definition: rigidBodyRestraint.C:81
Foam::RBD::restraint
Base class for defining restraints for rigid-body dynamics.
Definition: rigidBodyRestraint.H:68
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
Foam::spatialVector
SpatialVector< scalar > spatialVector
SpatialVector of scalars.
Definition: spatialVector.H:50
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::RBD::restraints::linearSpring::read
virtual bool read(const dictionary &dict)
Update properties from given dictionary.
Definition: linearSpring.C:117