Biorbd Release_1.13.0
Loading...
Searching...
No Matches
BIORBD_NAMESPACE::internal_forces::ligaments::LigamentConstant Class Reference

Base class for ligament constant. More...

#include <LigamentConstant.h>

Inheritance diagram for BIORBD_NAMESPACE::internal_forces::ligaments::LigamentConstant:
BIORBD_NAMESPACE::internal_forces::ligaments::Ligament BIORBD_NAMESPACE::internal_forces::Compound

Public Member Functions

 LigamentConstant ()
 Contruct a constant ligament.
 LigamentConstant (const utils::Scalar &force, const utils::String &name, const Geometry &geometry, const LigamentCharacteristics &characteristics)
 Construct a ligament constant.
 LigamentConstant (const utils::Scalar &force, const utils::String &name, const Geometry &geometry, const LigamentCharacteristics &characteristics, const internal_forces::PathModifiers &pathModifiers)
 Construct a ligament constant.
 LigamentConstant (const Ligament &other)
 Construct a ligament constant from another ligament.
 LigamentConstant (const std::shared_ptr< Ligament > other)
 Construct a ligament constant from another ligament.
virtual ~LigamentConstant ()
 Destroy class properly.
LigamentConstant DeepCopy () const
 Deep copy of a ligament constant.
void DeepCopy (const LigamentConstant &other)
 Deep copy of a ligament constant in a new ligament constant.
virtual void computeFl ()
 Compute the Force-length.
Public Member Functions inherited from BIORBD_NAMESPACE::internal_forces::ligaments::Ligament
 Ligament ()
 Construct a ligament.
 Ligament (const utils::String &name, const internal_forces::Geometry &position, const LigamentCharacteristics &characteristics)
 Construct a ligament.
 Ligament (const utils::String &name, const internal_forces::Geometry &position, const LigamentCharacteristics &characteristics, const internal_forces::PathModifiers &pathModifiers)
 Construct a ligament.
 Ligament (const Ligament &other)
 Construct a ligament from another ligament.
 Ligament (const std::shared_ptr< Ligament > other)
 Construct a ligament from another ligament.
virtual ~Ligament ()
 Destroy class properly.
void DeepCopy (const Ligament &other)
 Deep copy of a ligament in new ligament.
const utils::Scalar & length (rigidbody::Joints &updatedModel, const rigidbody::GeneralizedCoordinates &Q, bool updateLigamentKinematics=true)
 Get the length of the ligament.
const utils::Scalar & velocity (rigidbody::Joints &updatedModel, const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, bool updateLigamentKinematics=true)
 Return the velocity of the ligament.
void updateOrientations (rigidbody::Joints &updatedModel, const rigidbody::GeneralizedCoordinates &Q)
 Update the position of the origin and insertion positions of the ligament.
void updateOrientations (rigidbody::Joints &updatedModel, const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot)
 Update the position of the origin and insertion nodes of the ligament.
void updateOrientations (std::vector< utils::Vector3d > &ligamentPointsInGlobal, utils::Matrix &jacoPointsInGlobal)
 Update by hand the position of the origin and insertion nodes of the ligament.
void updateOrientations (std::vector< utils::Vector3d > &ligamentPointsInGlobal, utils::Matrix &jacoPointsInGlobal, const rigidbody::GeneralizedVelocity &Qdot)
 Update by hand the position of the origin and insertion nodes of the ligament.
void setPosition (const internal_forces::Geometry &positions)
 Set the position of all the points attached to the ligament (0 being the origin).
const internal_forces::Geometry & position () const
 Return the position of all the points attached to the ligament (0 being the origin).
void setCharacteristics (const LigamentCharacteristics &characteristics)
 Set the ligament characteristics.
const LigamentCharacteristics & characteristics () const
 Return the ligament characteristics.
const std::vector< utils::Vector3d > & ligamentsPointsInGlobal (rigidbody::Joints &updatedModel, const rigidbody::GeneralizedCoordinates &Q, bool updateLigamentKinematics=true)
 Return the ligament points in global reference frame.
const std::vector< utils::Vector3d > & ligamentsPointsInGlobal () const
 Return the previously computed ligament points in global reference frame.
virtual const utils::Scalar & force (rigidbody::Joints &updatedModel, const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, bool updateLigamentKinematics=true)
 Return the computed force norm.
virtual const utils::Scalar & force (rigidbody::Joints &updatedModel, const rigidbody::GeneralizedCoordinates &Q, bool updateLigamentKinematics=true)
 Return the computed force norm.
virtual const utils::Scalar & force ()
 Return the computed force norm. The ligament orientation had to be computed before calling this function.
LIGAMENT_TYPE type () const
 Return the type of the ligament.
const utils::Scalar & Fl ()
 Return the Force-Length of the passive element.
const utils::Scalar & damping ()
 Return the ligament damping (spring force).
void computeDamping ()
 Compute the ligament damping.
Public Member Functions inherited from BIORBD_NAMESPACE::internal_forces::Compound
 Compound ()
 Construct muscle compound.
 Compound (const utils::String &name)
 Construct compound.
 Compound (const utils::String &name, const internal_forces::PathModifiers &pathModifiers)
 Construct compound.
 Compound (const Compound &other)
 Construct compound from another muscle.
 Compound (const std::shared_ptr< Compound > other)
 Construct compound from another compound.
virtual ~Compound ()
 Destroy class properly.
void DeepCopy (const Compound &other)
 Deep copy of a compound.
void setName (const utils::String &name)
 Set the name of a muscle.
const utils::String & name () const
 Return the name of the muscle.
const internal_forces::PathModifiers & pathModifier ()
 Return the path modifier.
void addPathObject (utils::Vector3d &wrap)
 Add a path modifier object.

Protected Member Functions

virtual void setType ()
 Set type to Hill.
Protected Member Functions inherited from BIORBD_NAMESPACE::internal_forces::ligaments::Ligament
virtual void computeForce ()
 Compute the force of the ligament.
virtual utils::Scalar getForce ()
 Function allowing modification of the way the force is computed in computeForce().

Protected Attributes

std::shared_ptr< utils::Scalar > m_force
 Force of the ligament applied when l>l0.
Protected Attributes inherited from BIORBD_NAMESPACE::internal_forces::ligaments::Ligament
std::shared_ptr< internal_forces::Geometry > m_position
std::shared_ptr< LIGAMENT_TYPE > m_type
 The type of the ligament.
std::shared_ptr< LigamentCharacteristics > m_characteristics
 The ligament characteristics.
std::shared_ptr< utils::Scalar > m_damping
 The ligament damping term.
std::shared_ptr< utils::Scalar > m_Fl
 Force-Length.
Protected Attributes inherited from BIORBD_NAMESPACE::internal_forces::Compound
std::shared_ptr< utils::String > m_name
 The name of the muscle.
std::shared_ptr< internal_forces::PathModifiers > m_pathChanger
 The set of path modifiers.
std::shared_ptr< utils::Scalar > m_force
 The last computed force.

Detailed Description

Base class for ligament constant.

Definition at line 16 of file LigamentConstant.h.

Constructor & Destructor Documentation

◆ LigamentConstant() [1/5]

internal_forces::ligaments::LigamentConstant::LigamentConstant ( )

Contruct a constant ligament.

Definition at line 16 of file LigamentConstant.cpp.

◆ LigamentConstant() [2/5]

internal_forces::ligaments::LigamentConstant::LigamentConstant ( const utils::Scalar & force,
const utils::String & name,
const Geometry & geometry,
const LigamentCharacteristics & characteristics )

Construct a ligament constant.

Parameters
forceThe constant force of the ligament
nameThe ligament name
geometryThe ligament geometry
characteristicsThe ligament characteristics

Definition at line 22 of file LigamentConstant.cpp.

◆ LigamentConstant() [3/5]

internal_forces::ligaments::LigamentConstant::LigamentConstant ( const utils::Scalar & force,
const utils::String & name,
const Geometry & geometry,
const LigamentCharacteristics & characteristics,
const internal_forces::PathModifiers & pathModifiers )

Construct a ligament constant.

Parameters
forceThe constant force of the ligament
nameThe ligament name
geometryThe ligament geometry
characteristicsThe ligament characteristics
pathModifiersThe set of path modifiers

Definition at line 32 of file LigamentConstant.cpp.

◆ LigamentConstant() [4/5]

internal_forces::ligaments::LigamentConstant::LigamentConstant ( const Ligament & other)

Construct a ligament constant from another ligament.

Parameters
otherThe other ligament

Definition at line 59 of file LigamentConstant.cpp.

◆ LigamentConstant() [5/5]

internal_forces::ligaments::LigamentConstant::LigamentConstant ( const std::shared_ptr< Ligament > other)

Construct a ligament constant from another ligament.

Parameters
otherTHe other ligament

Definition at line 47 of file LigamentConstant.cpp.

◆ ~LigamentConstant()

internal_forces::ligaments::LigamentConstant::~LigamentConstant ( )
virtual

Destroy class properly.

Definition at line 81 of file LigamentConstant.cpp.

Member Function Documentation

◆ computeFl()

void internal_forces::ligaments::LigamentConstant::computeFl ( )
virtual

Compute the Force-length.

Implements BIORBD_NAMESPACE::internal_forces::ligaments::Ligament.

Definition at line 87 of file LigamentConstant.cpp.

◆ DeepCopy() [1/2]

internal_forces::ligaments::LigamentConstant internal_forces::ligaments::LigamentConstant::DeepCopy ( ) const

Deep copy of a ligament constant.

Returns
A deep copy of a ligament constant

Definition at line 69 of file LigamentConstant.cpp.

◆ DeepCopy() [2/2]

void internal_forces::ligaments::LigamentConstant::DeepCopy ( const LigamentConstant & other)

Deep copy of a ligament constant in a new ligament constant.

Parameters
otherThe Hill-type to copy

Definition at line 75 of file LigamentConstant.cpp.

◆ setType()

void internal_forces::ligaments::LigamentConstant::setType ( )
protectedvirtual

Set type to Hill.

Reimplemented from BIORBD_NAMESPACE::internal_forces::ligaments::Ligament.

Definition at line 83 of file LigamentConstant.cpp.

Member Data Documentation

◆ m_force

std::shared_ptr<utils::Scalar> BIORBD_NAMESPACE::internal_forces::ligaments::LigamentConstant::m_force
protected

Force of the ligament applied when l>l0.

Definition at line 92 of file LigamentConstant.h.


The documentation for this class was generated from the following files: