sixDoFRigidBodyMotionPlaneConstraint.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) 2011-2015 OpenFOAM Foundation
9  Copyright (C) 2020 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 
31 #include "sixDoFRigidBodyMotion.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37 namespace sixDoFRigidBodyMotionConstraints
38 {
39  defineTypeNameAndDebug(plane, 0);
40 
42  (
43  sixDoFRigidBodyMotionConstraint,
44  plane,
45  dictionary
46  );
47 }
48 }
49 
50 
51 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
52 
54 (
55  const word& name,
56  const dictionary& sDoFRBMCDict,
57  const sixDoFRigidBodyMotion& motion
58 )
59 :
60  sixDoFRigidBodyMotionConstraint(name, sDoFRBMCDict, motion)
61 {
62  read(sDoFRBMCDict);
63 }
64 
65 
66 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
67 
69 {}
70 
71 
72 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
73 
75 (
76  point& CofR
77 ) const
78 {
79  CofR = centreOfRotation_;
80 }
81 
82 
84 (
85  pointConstraint& pc
86 ) const
87 {
88  pc.applyConstraint(normal_);
89 }
90 
91 
93 (
94  pointConstraint& pc
95 ) const
96 {}
97 
98 
100 (
101  const dictionary& sDoFRBMCDict
102 )
103 {
105 
106  centreOfRotation_ = sDoFRBMCCoeffs_.getOrDefault
107  (
108  "centreOfRotation",
109  motion_.initialCentreOfMass()
110  );
111 
112  sDoFRBMCCoeffs_.readEntry("normal", normal_);
113 
114  return true;
115 }
116 
117 
119 (
120  Ostream& os
121 ) const
122 {
123  os.writeEntry("centreOfRotation", centreOfRotation_);
124  os.writeEntry("normal", normal_);
125 }
126 
127 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::pointConstraint
Accumulates point constraints through successive applications of the applyConstraint function.
Definition: pointConstraint.H:60
Foam::sixDoFRigidBodyMotionConstraint
Base class for defining constraints for sixDoF motions.
Definition: sixDoFRigidBodyMotionConstraint.H:67
sixDoFRigidBodyMotionPlaneConstraint.H
Foam::sixDoFRigidBodyMotionConstraints::addToRunTimeSelectionTable
addToRunTimeSelectionTable(sixDoFRigidBodyMotionConstraint, axis, dictionary)
sixDoFRigidBodyMotion.H
Foam::blockMeshTools::read
void read(Istream &, label &val, const dictionary &)
In-place read with dictionary lookup.
Definition: blockMeshTools.C:57
Foam::sixDoFRigidBodyMotionConstraints::plane::read
virtual bool read(const dictionary &sDoFRBMCCoeff)
Update properties from given dictionary.
Definition: sixDoFRigidBodyMotionPlaneConstraint.C:100
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::sixDoFRigidBodyMotionConstraints::point
Translation constraint on the centre of rotation: fixed in space.
Definition: sixDoFRigidBodyMotionPointConstraint.H:58
Foam::sixDoFRigidBodyMotionConstraints::plane::constrainRotation
virtual void constrainRotation(pointConstraint &) const
Apply and accumulate rotational constraints.
Definition: sixDoFRigidBodyMotionPlaneConstraint.C:93
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::sixDoFRigidBodyMotionConstraints::plane::setCentreOfRotation
virtual void setCentreOfRotation(point &) const
Set the centre of rotation to the projection of the.
Definition: sixDoFRigidBodyMotionPlaneConstraint.C:75
Foam::pointConstraint::applyConstraint
void applyConstraint(const vector &cd)
Apply and accumulate the effect of the given constraint direction.
Definition: pointConstraintI.H:50
Foam::sixDoFRigidBodyMotionConstraints::plane::~plane
virtual ~plane()
Destructor.
Definition: sixDoFRigidBodyMotionPlaneConstraint.C:68
Foam::sixDoFRigidBodyMotion
Six degree of freedom motion for a rigid body.
Definition: sixDoFRigidBodyMotion.H:69
Foam::sixDoFRigidBodyMotionConstraints::plane::constrainTranslation
virtual void constrainTranslation(pointConstraint &) const
Apply and accumulate translational constraints.
Definition: sixDoFRigidBodyMotionPlaneConstraint.C:84
Foam::sixDoFRigidBodyMotionConstraint::read
virtual bool read(const dictionary &sDoFRBMCDict)
Update properties from given dictionary.
Definition: sixDoFRigidBodyMotionConstraint.C:63
Foam::sixDoFRigidBodyMotionConstraints::defineTypeNameAndDebug
defineTypeNameAndDebug(axis, 0)
Foam::sixDoFRigidBodyMotionConstraints::plane::plane
plane(const word &name, const dictionary &sDoFRBMCDict, const sixDoFRigidBodyMotion &motion)
Construct from components.
Definition: sixDoFRigidBodyMotionPlaneConstraint.C:54
Foam::sixDoFRigidBodyMotionConstraints::plane::write
virtual void write(Ostream &) const
Write.
Definition: sixDoFRigidBodyMotionPlaneConstraint.C:119
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56