chrono::ChLinkRevoluteTranslational Class Reference

Description

Class for modeling a composite revolute-translational joint between two ChBodyFrame objects.

This joint is defined through a point and direction on the first body (the revolute side), a point and two mutually orthogonal directions on the second body (the translational side), and a distance.

#include <ChLinkRevoluteTranslational.h>

Inheritance diagram for chrono::ChLinkRevoluteTranslational:
Collaboration diagram for chrono::ChLinkRevoluteTranslational:

Public Member Functions

 ChLinkRevoluteTranslational (const ChLinkRevoluteTranslational &other)
 
virtual ChLinkRevoluteTranslationalClone () const override
 "Virtual" copy constructor (covariant return type).
 
virtual int GetDOC_c () override
 Get the number of (bilateral) constraints introduced by this joint.
 
const ChVectorGetPoint1Rel () const
 Get the point on Body1 (revolute side), expressed in Body1 coordinate system.
 
const ChVectorGetDirZ1Rel () const
 Get the direction of the revolute joint, expressed in Body1 coordinate system.
 
const ChVectorGetPoint2Rel () const
 Get the point on Body2 (spherical side), expressed in Body2 coordinate system.
 
const ChVectorGetDirX2Rel () const
 Get the first direction of the translational joint, expressed in Body2 coordinate system. More...
 
const ChVectorGetDirY2Rel () const
 Get the second direction of the translational joint, expressed in Body2 coordinate system. More...
 
double GetImposedDistance () const
 Get the imposed distance (length of massless connector).
 
double GetCurrentDistance () const
 Get the current distance between the two points.
 
ChVector GetPoint1Abs () const
 Get the point on Body1 (revolute side), expressed in absolute coordinate system.
 
ChVector GetDirZ1Abs () const
 Get the direction of the revolute joint, expressed in absolute coordinate system.
 
ChVector GetPoint2Abs () const
 Get the point on Body2 (translational side), expressed in absolute coordinate system.
 
ChVector GetDirX2Abs () const
 Get the first direction of the translational joint, expressed in absolute coordinate system. More...
 
ChVector GetDirY2Abs () const
 Get the second direction of the translational joint, expressed in absolute coordinate system. More...
 
virtual ChCoordsys GetLinkRelativeCoords () override
 Get the link coordinate system, expressed relative to Body2 (translational side). More...
 
const ChVectorN< double, 4 > & GetC () const
 Get the joint violation (residuals of the constraint equations)
 
void Initialize (std::shared_ptr< ChBodyFrame > body1, std::shared_ptr< ChBodyFrame > body2, const ChCoordsys<> &csys, double distance)
 Initialize this joint by specifying the two bodies to be connected, a coordinate system specified in the absolute frame, and the distance of the massless connector. More...
 
void Initialize (std::shared_ptr< ChBodyFrame > body1, std::shared_ptr< ChBodyFrame > body2, bool local, const ChVector<> &p1, const ChVector<> &dirZ1, const ChVector<> &p2, const ChVector<> &dirX2, const ChVector<> &dirY2, bool auto_distance=true, double distance=0)
 Initialize this joint by specifying the two bodies to be connected, a point and a direction on body1 defining the revolute joint, and two directions and a point on the second body defining the translational joint. More...
 
virtual void Update (double time, bool update_assets=true) override
 Perform the update of this joint at the specified time: compute jacobians, constraint violations, etc. More...
 
virtual void IntStateGatherReactions (const unsigned int off_L, ChVectorDynamic<> &L) override
 From item's reaction forces to global reaction vector. More...
 
virtual void IntStateScatterReactions (const unsigned int off_L, const ChVectorDynamic<> &L) override
 From global reaction vector to item's reaction forces. More...
 
virtual void IntLoadResidual_CqL (const unsigned int off_L, ChVectorDynamic<> &R, const ChVectorDynamic<> &L, const double c) override
 Takes the term Cq'*L, scale and adds to R at given offset: R += c*Cq'*L. More...
 
virtual void IntLoadConstraint_C (const unsigned int off, ChVectorDynamic<> &Qc, const double c, bool do_clamp, double recovery_clamp) override
 Takes the term C, scale and adds to Qc at given offset: Qc += c*C. More...
 
virtual void IntToDescriptor (const unsigned int off_v, const ChStateDelta &v, const ChVectorDynamic<> &R, const unsigned int off_L, const ChVectorDynamic<> &L, const ChVectorDynamic<> &Qc) override
 Prepare variables and constraints to accommodate a solution: More...
 
virtual void IntFromDescriptor (const unsigned int off_v, ChStateDelta &v, const unsigned int off_L, ChVectorDynamic<> &L) override
 After a solver solution, fetch values from variables and constraints into vectors: More...
 
virtual void InjectConstraints (ChSystemDescriptor &descriptor) override
 Tell to a system descriptor that there are constraints of type ChConstraint in this object (for further passing it to a solver) Basically does nothing, but maybe that inherited classes may specialize this.
 
virtual void ConstraintsBiReset () override
 Sets to zero the known term (b_i) of encapsulated ChConstraints.
 
virtual void ConstraintsBiLoad_C (double factor=1, double recovery_clamp=0.1, bool do_clamp=false) override
 Adds the current C (constraint violation) to the known term (b_i) of encapsulated ChConstraints.
 
virtual void ConstraintsLoadJacobians () override
 Adds the current jacobians in encapsulated ChConstraints.
 
virtual void ConstraintsFetch_react (double factor=1) override
 Fetches the reactions from the lagrangian multiplier (l_i) of encapsulated ChConstraints. More...
 
ChVector Get_react_force_body1 ()
 
ChVector Get_react_torque_body1 ()
 
ChVector Get_react_force_body2 ()
 
ChVector Get_react_torque_body2 ()
 
virtual void ArchiveOUT (ChArchiveOut &marchive) override
 Method to allow serialization of transient data to archives.
 
virtual void ArchiveIN (ChArchiveIn &marchive) override
 Method to allow deserialization of transient data from archives. More...
 
- Public Member Functions inherited from chrono::ChPhysicsItem
 ChPhysicsItem (const ChPhysicsItem &other)
 
ChSystemGetSystem () const
 Get the pointer to the parent ChSystem()
 
virtual void SetSystem (ChSystem *m_system)
 Set the pointer to the parent ChSystem() and also add to new collision system / remove from old coll.system.
 
void AddAsset (std::shared_ptr< ChAsset > masset)
 Add an optional asset (it can be used to define visualization shapes, es ChSphereShape, or textures, or custom attached properties that the user can define by creating his class inherited from ChAsset)
 
std::vector< std::shared_ptr< ChAsset > > & GetAssets ()
 Access to the list of optional assets.
 
std::shared_ptr< ChAssetGetAssetN (unsigned int num)
 Access the Nth asset in the list of optional assets.
 
virtual unsigned int GetAssetsFrameNclones ()
 Optionally, a ChPhysicsItem can return multiple asset coordinate systems; this can be helpful if, for example, when a ChPhysicsItem contains 'clones' with the same assets (ex. More...
 
virtual bool GetCollide () const
 Tell if the object is subject to collision. More...
 
virtual void SyncCollisionModels ()
 If this physical item contains one or more collision models, synchronize their coordinates and bounding boxes to the state of the item.
 
virtual void AddCollisionModelsToSystem ()
 If this physical item contains one or more collision models, add them to the system's collision engine.
 
virtual void RemoveCollisionModelsFromSystem ()
 If this physical item contains one or more collision models, remove them from the system's collision engine.
 
virtual void GetTotalAABB (ChVector<> &bbmin, ChVector<> &bbmax)
 Get the entire AABB axis-aligned bounding box of the object. More...
 
virtual void GetCenter (ChVector<> &mcenter)
 Get a symbolic 'center' of the object. More...
 
virtual void StreamINstate (ChStreamInBinary &mstream)
 Method to deserialize only the state (position, speed) Must be implemented by child classes.
 
virtual void StreamOUTstate (ChStreamOutBinary &mstream)
 Method to serialize only the state (position, speed) Must be implemented by child classes.
 
virtual void Setup ()
 This might recompute the number of coordinates, DOFs, constraints, in case this might change (ex in ChAssembly), as well as state offsets of contained items (ex in ChMesh)
 
virtual void SetNoSpeedNoAcceleration ()
 Set zero speed (and zero accelerations) in state, without changing the position. More...
 
virtual int GetDOF ()
 Get the number of scalar coordinates (variables), if any, in this item. More...
 
virtual int GetDOF_w ()
 Get the number of scalar coordinates of variables derivatives (usually = DOF, but might be different than DOF, ex. More...
 
virtual int GetDOC ()
 Get the number of scalar constraints, if any, in this item.
 
virtual int GetDOC_d ()
 Get the number of scalar constraints, if any, in this item (only unilateral constr.) Children classes might override this.
 
unsigned int GetOffset_x ()
 Get offset in the state vector (position part)
 
unsigned int GetOffset_w ()
 Get offset in the state vector (speed part)
 
unsigned int GetOffset_L ()
 Get offset in the lagrangian multipliers.
 
void SetOffset_x (const unsigned int moff)
 Set offset in the state vector (position part) Note: only the ChSystem::Setup function should use this.
 
void SetOffset_w (const unsigned int moff)
 Set offset in the state vector (speed part) Note: only the ChSystem::Setup function should use this.
 
void SetOffset_L (const unsigned int moff)
 Set offset in the lagrangian multipliers Note: only the ChSystem::Setup function should use this.
 
virtual void IntStateGather (const unsigned int off_x, ChState &x, const unsigned int off_v, ChStateDelta &v, double &T)
 From item's state to global state vectors y={x,v} pasting the states at the specified offsets. More...
 
virtual void IntStateScatter (const unsigned int off_x, const ChState &x, const unsigned int off_v, const ChStateDelta &v, const double T)
 From global state vectors y={x,v} to item's state (and update) fetching the states at the specified offsets. More...
 
virtual void IntStateGatherAcceleration (const unsigned int off_a, ChStateDelta &a)
 From item's state acceleration to global acceleration vector. More...
 
virtual void IntStateScatterAcceleration (const unsigned int off_a, const ChStateDelta &a)
 From global acceleration vector to item's state acceleration. More...
 
virtual void IntStateIncrement (const unsigned int off_x, ChState &x_new, const ChState &x, const unsigned int off_v, const ChStateDelta &Dv)
 Computes x_new = x + Dt , using vectors at specified offsets. More...
 
virtual void IntLoadResidual_F (const unsigned int off, ChVectorDynamic<> &R, const double c)
 Takes the F force term, scale and adds to R at given offset: R += c*F. More...
 
virtual void IntLoadResidual_Mv (const unsigned int off, ChVectorDynamic<> &R, const ChVectorDynamic<> &w, const double c)
 Takes the M*v term, multiplying mass by a vector, scale and adds to R at given offset: R += c*M*w. More...
 
virtual void IntLoadConstraint_Ct (const unsigned int off, ChVectorDynamic<> &Qc, const double c)
 Takes the term Ct, scale and adds to Qc at given offset: Qc += c*Ct. More...
 
virtual void VariablesFbReset ()
 Sets the 'fb' part (the known term) of the encapsulated ChVariables to zero.
 
virtual void VariablesFbLoadForces (double factor=1)
 Adds the current forces (applied to item) into the encapsulated ChVariables, in the 'fb' part: qf+=forces*factor.
 
virtual void VariablesQbLoadSpeed ()
 Initialize the 'qb' part of the ChVariables with the current value of speeds. More...
 
virtual void VariablesFbIncrementMq ()
 Adds M*q (masses multiplied current 'qb') to Fb, ex. More...
 
virtual void VariablesQbSetSpeed (double step=0)
 Fetches the item speed (ex. More...
 
virtual void VariablesQbIncrementPosition (double step)
 Increment item positions by the 'qb' part of the ChVariables, multiplied by a 'step' factor. More...
 
virtual void InjectVariables (ChSystemDescriptor &mdescriptor)
 Tell to a system descriptor that there are variables of type ChVariables in this object (for further passing it to a solver) Basically does nothing, but maybe that inherited classes may specialize this.
 
virtual void ConstraintsBiLoad_Ct (double factor=1)
 Adds the current Ct (partial t-derivative, as in C_dt=0-> [Cq]*q_dt=-Ct) to the known term (b_i) of encapsulated ChConstraints.
 
virtual void ConstraintsBiLoad_Qc (double factor=1)
 Adds the current Qc (the vector of C_dtdt=0 -> [Cq]*q_dtdt=Qc ) to the known term (b_i) of encapsulated ChConstraints.
 
virtual void ConstraintsFbLoadForces (double factor=1)
 Adds the current link-forces, if any, (caused by springs, etc.) to the 'fb' vectors of the ChVariables referenced by encapsulated ChConstraints.
 
virtual void InjectKRMmatrices (ChSystemDescriptor &mdescriptor)
 Tell to a system descriptor that there are items of type ChKblock in this object (for further passing it to a solver) Basically does nothing, but maybe that inherited classes may specialize this.
 
virtual void KRMmatricesLoad (double Kfactor, double Rfactor, double Mfactor)
 Adds the current stiffness K and damping R and mass M matrices in encapsulated ChKblock item(s), if any. More...
 
- Public Member Functions inherited from chrono::ChObj
 ChObj (const ChObj &other)
 
int GetIdentifier () const
 Gets the numerical identifier of the object.
 
void SetIdentifier (int id)
 Sets the numerical identifier of the object.
 
double GetChTime () const
 Gets the simulation time of this object.
 
void SetChTime (double m_time)
 Sets the simulation time of this object.
 
const char * GetName () const
 Gets the name of the object as C Ascii null-terminated string -for reading only!
 
void SetName (const char myname[])
 Sets the name of this object, as ascii string.
 
std::string GetNameString () const
 Gets the name of the object as C Ascii null-terminated string.
 
void SetNameString (const std::string &myname)
 Sets the name of this object, as std::string.
 
void MFlagsSetAllOFF (int &mflag)
 
void MFlagsSetAllON (int &mflag)
 
void MFlagSetON (int &mflag, int mask)
 
void MFlagSetOFF (int &mflag, int mask)
 
int MFlagGet (int &mflag, int mask)
 
virtual std::string & ArchiveContainerName ()
 

Additional Inherited Members

- Protected Attributes inherited from chrono::ChPhysicsItem
ChSystemsystem
 parent system
 
std::vector< std::shared_ptr< ChAsset > > assets
 set of assets
 
unsigned int offset_x
 offset in vector of state (position part)
 
unsigned int offset_w
 offset in vector of state (speed part)
 
unsigned int offset_L
 offset in vector of lagrangian multipliers
 
- Protected Attributes inherited from chrono::ChObj
double ChTime
 the time of simulation for the object
 

Member Function Documentation

◆ ArchiveIN()

void chrono::ChLinkRevoluteTranslational::ArchiveIN ( ChArchiveIn marchive)
overridevirtual

Method to allow deserialization of transient data from archives.

Method to allow de serialization of transient data from archives.

Reimplemented from chrono::ChLink.

◆ ConstraintsFetch_react()

void chrono::ChLinkRevoluteTranslational::ConstraintsFetch_react ( double  factor = 1)
overridevirtual

Fetches the reactions from the lagrangian multiplier (l_i) of encapsulated ChConstraints.

Mostly used after the solver provided the solution in ChConstraints. Also, should convert the reactions obtained from dynamical simulation, from link space to intuitive react_force and react_torque.

Reimplemented from chrono::ChPhysicsItem.

◆ GetDirX2Abs()

ChVector chrono::ChLinkRevoluteTranslational::GetDirX2Abs ( ) const
inline

Get the first direction of the translational joint, expressed in absolute coordinate system.

The translational axis is orthogonal to the direction.

◆ GetDirX2Rel()

const ChVector& chrono::ChLinkRevoluteTranslational::GetDirX2Rel ( ) const
inline

Get the first direction of the translational joint, expressed in Body2 coordinate system.

The translational axis is orthogonal to the direction.

◆ GetDirY2Abs()

ChVector chrono::ChLinkRevoluteTranslational::GetDirY2Abs ( ) const
inline

Get the second direction of the translational joint, expressed in absolute coordinate system.

The translational axis is orthogonal to the direction.

◆ GetDirY2Rel()

const ChVector& chrono::ChLinkRevoluteTranslational::GetDirY2Rel ( ) const
inline

Get the second direction of the translational joint, expressed in Body2 coordinate system.

The translational axis is orthogonal to the direction.

◆ GetLinkRelativeCoords()

ChCoordsys chrono::ChLinkRevoluteTranslational::GetLinkRelativeCoords ( )
overridevirtual

Get the link coordinate system, expressed relative to Body2 (translational side).

This represents the 'main' reference of the link: reaction forces and reaction torques are reported in this coordinate system.

Reimplemented from chrono::ChLink.

◆ Initialize() [1/2]

void chrono::ChLinkRevoluteTranslational::Initialize ( std::shared_ptr< ChBodyFrame body1,
std::shared_ptr< ChBodyFrame body2,
bool  local,
const ChVector<> &  p1,
const ChVector<> &  dirZ1,
const ChVector<> &  p2,
const ChVector<> &  dirX2,
const ChVector<> &  dirY2,
bool  auto_distance = true,
double  distance = 0 
)

Initialize this joint by specifying the two bodies to be connected, a point and a direction on body1 defining the revolute joint, and two directions and a point on the second body defining the translational joint.

If local = true, it is assumed that these quantities are specified in the local body frames. Otherwise, it is assumed that they are specified in the absolute frame. The imposed distance between the two points can be either inferred from the provided configuration (auto_distance = true) or specified explicitly.

Parameters
body1first frame (revolute side)
body2second frame (spherical side)
localtrue if data given in body local frames
p1point on first frame (revolute side)
dirZ1direction of revolute on first frame
p2point on second frame (translational side)
dirX2first direction of translational joint
dirY2second direction of translational joint
auto_distancetrue if imposed distance equal to distance between axes
distanceimposed distance (used only if auto_distance = false)

◆ Initialize() [2/2]

void chrono::ChLinkRevoluteTranslational::Initialize ( std::shared_ptr< ChBodyFrame body1,
std::shared_ptr< ChBodyFrame body2,
const ChCoordsys<> &  csys,
double  distance 
)

Initialize this joint by specifying the two bodies to be connected, a coordinate system specified in the absolute frame, and the distance of the massless connector.

The composite joint is constructed such that the revolute joint is centered at the origin of the specified coordinate system. The revolute joint rotates about the z axis, the translational joint moves along the y axis, and the translation axis is at the specified distance along the x axis.

Parameters
body1first frame (revolute side)
body2second frame (translational side)
csysjoint coordinate system (in absolute frame)
distanceimposed distance

◆ IntFromDescriptor()

void chrono::ChLinkRevoluteTranslational::IntFromDescriptor ( const unsigned int  off_v,
ChStateDelta v,
const unsigned int  off_L,
ChVectorDynamic<> &  L 
)
overridevirtual

After a solver solution, fetch values from variables and constraints into vectors:

Parameters
off_voffset for v
vvector to where the q 'unknowns' term of the variables will be copied
off_Loffset for L
Lvector to where L 'lagrangian ' term of the constraints will be copied

Reimplemented from chrono::ChPhysicsItem.

◆ IntLoadConstraint_C()

void chrono::ChLinkRevoluteTranslational::IntLoadConstraint_C ( const unsigned int  off,
ChVectorDynamic<> &  Qc,
const double  c,
bool  do_clamp,
double  recovery_clamp 
)
overridevirtual

Takes the term C, scale and adds to Qc at given offset: Qc += c*C.

Parameters
offoffset in Qc residual
Qcresult: the Qc residual, Qc += c*C
ca scaling factor
do_clampapply clamping to c*C?
recovery_clampvalue for min/max clamping of c*C

Reimplemented from chrono::ChPhysicsItem.

◆ IntLoadResidual_CqL()

void chrono::ChLinkRevoluteTranslational::IntLoadResidual_CqL ( const unsigned int  off_L,
ChVectorDynamic<> &  R,
const ChVectorDynamic<> &  L,
const double  c 
)
overridevirtual

Takes the term Cq'*L, scale and adds to R at given offset: R += c*Cq'*L.

Parameters
off_Loffset in L multipliers
Rresult: the R residual, R += c*Cq'*L
Lthe L vector
ca scaling factor

Reimplemented from chrono::ChPhysicsItem.

◆ IntStateGatherReactions()

void chrono::ChLinkRevoluteTranslational::IntStateGatherReactions ( const unsigned int  off_L,
ChVectorDynamic<> &  L 
)
overridevirtual

From item's reaction forces to global reaction vector.

Parameters
off_Loffset in L vector
LL vector of reaction forces

Reimplemented from chrono::ChPhysicsItem.

◆ IntStateScatterReactions()

void chrono::ChLinkRevoluteTranslational::IntStateScatterReactions ( const unsigned int  off_L,
const ChVectorDynamic<> &  L 
)
overridevirtual

From global reaction vector to item's reaction forces.

Parameters
off_Loffset in L vector
LL vector of reaction forces

Reimplemented from chrono::ChPhysicsItem.

◆ IntToDescriptor()

void chrono::ChLinkRevoluteTranslational::IntToDescriptor ( const unsigned int  off_v,
const ChStateDelta v,
const ChVectorDynamic<> &  R,
const unsigned int  off_L,
const ChVectorDynamic<> &  L,
const ChVectorDynamic<> &  Qc 
)
overridevirtual

Prepare variables and constraints to accommodate a solution:

Parameters
off_voffset for v and R
vvector that will be copied into the q 'unknowns' term of the variables (for warm starting)
Rvector that will be copied into the F 'force' term of the variables
off_Loffset for L and Qc
Lvector that will be copied into the L 'lagrangian ' term of the constraints (for warm starting)
Qcvector that will be copied into the Qb 'constraint' term of the constraints

Reimplemented from chrono::ChPhysicsItem.

◆ Update()

void chrono::ChLinkRevoluteTranslational::Update ( double  time,
bool  update_assets = true 
)
overridevirtual

Perform the update of this joint at the specified time: compute jacobians, constraint violations, etc.

and cache in internal structures

Reimplemented from chrono::ChLink.


The documentation for this class was generated from the following files:
  • /builds/uwsbel/chrono/src/chrono/physics/ChLinkRevoluteTranslational.h
  • /builds/uwsbel/chrono/src/chrono/physics/ChLinkRevoluteTranslational.cpp