OpenFOAM-5.x/src/rigidBodyDynamics/joints/Px/Px.H

111 lines
2.7 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::RBD::joints::Px
Description
Prismatic joint for translation along the x-axis.
Reference:
\verbatim
Featherstone, R. (2008).
Rigid body dynamics algorithms.
Springer.
Chapter 4.
\endverbatim
SourceFiles
Px.C
\*---------------------------------------------------------------------------*/
#ifndef RBD_joints_Px_H
#define RBD_joints_Px_H
#include "joint.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace RBD
{
namespace joints
{
/*---------------------------------------------------------------------------*\
Class Px Declaration
\*---------------------------------------------------------------------------*/
class Px
:
public joint
{
public:
//- Runtime type information
TypeName("Px");
// Constructors
//- Construct for given model
Px();
//- Construct for given model from dictionary
Px(const dictionary& dict);
//- Clone this joint
virtual autoPtr<joint> clone() const;
//- Destructor
virtual ~Px();
// Member Functions
//- Update the model state for this joint
virtual void jcalc
(
joint::XSvc& J,
const scalarField& q,
const scalarField& w,
const scalarField& qDot
) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace joints
} // End namespace RBD
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //