linearDamper.C
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) 2016-2018 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 \*---------------------------------------------------------------------------*/
25 
26 #include "linearDamper.H"
27 #include "rigidBodyModel.H"
29 
30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
31 
32 namespace Foam
33 {
34 namespace RBD
35 {
36 namespace restraints
37 {
38  defineTypeNameAndDebug(linearDamper, 0);
39 
41  (
42  restraint,
43  linearDamper,
44  dictionary
45  );
46 }
47 }
48 }
49 
50 
51 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
52 
54 (
55  const word& name,
56  const dictionary& dict,
57  const rigidBodyModel& model
58 )
59 :
60  restraint(name, dict, model)
61 {
62  read(dict);
63 }
64 
65 
66 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
67 
69 {}
70 
71 
72 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
73 
75 (
76  scalarField& tau,
78 ) const
79 {
80  vector force = -coeff_*model_.v(model_.master(bodyID_)).l();
81 
82  if (model_.debug)
83  {
84  Info<< " force " << force << endl;
85  }
86 
87  // Accumulate the force for the restrained body
88  fx[bodyIndex_] += model_.X0(bodyID_).T() & spatialVector(Zero, force);
89 }
90 
91 
93 (
94  const dictionary& dict
95 )
96 {
97  restraint::read(dict);
98 
99  coeffs_.lookup("coeff") >> coeff_;
100 
101  return true;
102 }
103 
104 
106 (
107  Ostream& os
108 ) const
109 {
110  restraint::write(os);
111 
112  os.writeKeyword("coeff")
113  << coeff_ << token::END_STATEMENT << nl;
114 }
115 
116 
117 // ************************************************************************* //
virtual void restrain(scalarField &tau, Field< spatialVector > &fx) const
Accumulate the retraint internal joint forces into the tau field and.
Definition: linearDamper.C:75
virtual void write(Ostream &) const
Write.
Definition: linearDamper.C:106
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual ~linearDamper()
Destructor.
Definition: linearDamper.C:68
Base class for defining restraints for rigid-body dynamics.
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:256
Macros for easy insertion into run-time selection tables.
bool read(const char *, int32_t &)
Definition: int32IO.C:85
virtual bool read(const dictionary &dict)
Update properties from given dictionary.
linearDamper(const word &name, const dictionary &dict, const rigidBodyModel &model)
Construct from components.
Definition: linearDamper.C:54
A class for handling words, derived from string.
Definition: word.H:59
SpatialVector< scalar > spatialVector
SpatialVector of scalars.
Definition: spatialVector.H:47
static const zero Zero
Definition: zero.H:97
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
static const char nl
Definition: Ostream.H:265
Ostream & writeKeyword(const keyType &)
Write the keyword followed by an appropriate indentation.
Definition: Ostream.C:54
messageStream Info
tmp< Field< Type > > T() const
Return the field transpose (only defined for second rank tensors)
Definition: Field.C:717
defineTypeNameAndDebug(linearAxialAngularSpring, 0)
addToRunTimeSelectionTable(restraint, linearAxialAngularSpring, dictionary)
Basic rigid-body model representing a system of rigid-bodies connected by 1-6 DoF joints...
virtual void write(Ostream &) const =0
Write.
virtual bool read(const dictionary &dict)
Update properties from given dictionary.
Definition: linearDamper.C:93
Namespace for OpenFOAM.