sixDoFRigidBodyMotionAxisConstraint.H
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-2014 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
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
26Class
27 Foam::sixDoFRigidBodyMotionConstraints::axis
28
29Description
30 Orientation constraint:
31 may only rotate around a fixed axis.
32
33SourceFiles
34 sixDoFRigidBodyMotionAxisConstraint.C
35
36\*---------------------------------------------------------------------------*/
37
38#ifndef sixDoFRigidBodyMotionAxisConstraint_H
39#define sixDoFRigidBodyMotionAxisConstraint_H
40
42
43// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45namespace Foam
46{
47
48namespace sixDoFRigidBodyMotionConstraints
49{
50
51/*---------------------------------------------------------------------------*\
52 Class axis Declaration
53\*---------------------------------------------------------------------------*/
55class axis
56:
58{
59
60 // Private data
61
62 //- Reference axis in global space
63 vector axis_;
64
65
66public:
67
68 //- Runtime type information
69 TypeName("axis");
70
71
72 // Constructors
73
74 //- Construct from components
75 axis
76 (
77 const word& name,
78 const dictionary& sDoFRBMCDict,
79 const sixDoFRigidBodyMotion& motion
80 );
81
82 //- Construct and return a clone
84 {
86 (
87 new axis(*this)
88 );
89 }
90
91
92 //- Destructor
93 virtual ~axis();
94
95
96 // Member Functions
97
98 //- Apply and accumulate translational constraints
99 virtual void constrainTranslation(pointConstraint&) const;
100
101 //- Apply and accumulate rotational constraints
102 virtual void constrainRotation(pointConstraint&) const;
103
104 //- Update properties from given dictionary
105 virtual bool read(const dictionary& sDoFRBMCCoeff);
106
107 //- Write
108 virtual void write(Ostream&) const;
109};
110
111
112// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113
114} // End namespace solidBodyMotionFunctions
115} // End namespace Foam
116
117// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118
119#endif
120
121// ************************************************************************* //
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Accumulates point constraints through successive applications of the applyConstraint function.
Base class for defining constraints for sixDoF motions.
Orientation constraint: may only rotate around a fixed axis.
TypeName("axis")
Runtime type information.
virtual void constrainRotation(pointConstraint &) const
Apply and accumulate rotational constraints.
virtual bool read(const dictionary &sDoFRBMCCoeff)
Update properties from given dictionary.
virtual autoPtr< sixDoFRigidBodyMotionConstraint > clone() const
Construct and return a clone.
virtual void constrainTranslation(pointConstraint &) const
Apply and accumulate translational constraints.
Six degree of freedom motion for a rigid body.
A class for handling words, derived from Foam::string.
Definition: word.H:68
Namespace for OpenFOAM.
runTime write()
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73