externalForce.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) 2019 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 "externalForce.H"
29 #include "rigidBodyModel.H"
30 #include "rigidBodyModelState.H"
31 #include "OneConstant.H"
33 
34 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
35 
36 namespace Foam
37 {
38 namespace RBD
39 {
40 namespace restraints
41 {
43 
45  (
46  restraint,
49  );
50 }
51 }
52 }
53 
54 
55 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
56 
58 (
59  const word& name,
60  const dictionary& dict,
61  const rigidBodyModel& model
62 )
63 :
64  restraint(name, dict, model),
65  externalForce_(nullptr)
66 {
67  read(dict);
68 }
69 
70 
71 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
72 
74 {}
75 
76 
77 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
78 
80 (
81  scalarField& tau,
83  const rigidBodyModelState& state
84 ) const
85 {
86  const vector force = externalForce_().value(state.t());
87  const vector moment(location_ ^ force);
88 
89  if (model_.debug)
90  {
91  Info<< " location " << location_
92  << " force " << force
93  << " moment " << moment
94  << endl;
95  }
96 
97  // Accumulate the force for the restrained body
98  fx[bodyIndex_] += spatialVector(moment, force);
99 }
100 
101 
103 (
104  const dictionary& dict
105 )
106 {
108 
109  coeffs_.lookup("location") >> location_;
110 
111  externalForce_ = Function1<vector>::New("force", coeffs_);
112 
113  return true;
114 }
115 
116 
118 (
119  Ostream& os
120 ) const
121 {
122  restraint::write(os);
123 
124  os.writeEntry("location", location_);
125 
126  externalForce_().writeData(os);
127 }
128 
129 
130 // ************************************************************************* //
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:62
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:337
Foam::RBD::restraints::externalForce::read
virtual bool read(const dictionary &dict)
Update properties from given dictionary.
Definition: externalForce.C:103
rigidBodyModel.H
Foam::RBD::rigidBodyModelState::t
scalar t() const
Return access to the time.
Definition: rigidBodyModelStateI.H:48
Foam::Field< scalar >
Foam::Info
messageStream Info
Information stream (uses stdout - output is on the master only)
Foam::name
word name(const complex &c)
Return string representation of complex.
Definition: complex.C:76
Foam::RBD::restraint::read
virtual bool read(const dictionary &dict)
Update properties from given dictionary.
Definition: rigidBodyRestraint.C:74
Foam::RBD::restraints::externalForce::~externalForce
virtual ~externalForce()
Destructor.
Definition: externalForce.C:73
Foam::blockMeshTools::read
void read(Istream &, label &, const dictionary &)
In-place read with dictionary lookup.
Definition: blockMeshTools.C:33
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:121
Foam::RBD::restraints::externalForce::restrain
virtual void restrain(scalarField &tau, Field< spatialVector > &fx, const rigidBodyModelState &state) const
Accumulate the retraint internal joint forces into the tau field and.
Definition: externalForce.C:80
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
rigidBodyModelState.H
Foam::RBD::restraints::externalForce
Time-dependent external force restraint using Function1.
Definition: externalForce.H:73
Foam::RBD::restraints::externalForce::externalForce
externalForce(const word &name, const dictionary &dict, const rigidBodyModel &model)
Construct from components.
Definition: externalForce.C:58
Foam::Vector< scalar >
OneConstant.H
Foam::RBD::restraint::write
virtual void write(Ostream &) const =0
Write.
Definition: rigidBodyRestraint.C:81
Foam::RBD::restraints::externalForce::write
virtual void write(Ostream &) const
Write.
Definition: externalForce.C:118
Foam::RBD::restraint
Base class for defining restraints for rigid-body dynamics.
Definition: rigidBodyRestraint.H:68
Foam::Ostream::writeEntry
Ostream & writeEntry(const keyType &key, const T &value)
Write a keyword/value entry.
Definition: Ostream.H:219
externalForce.H
Foam::spatialVector
SpatialVector< scalar > spatialVector
SpatialVector of scalars.
Definition: spatialVector.H:50
Foam::Function1::New
static autoPtr< Function1< Type > > New(const word &entryName, const dictionary &dict, const word &redirectType=word::null)
Selector.
Definition: Function1New.C:35
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56