Biorbd Release_1.13.0
Loading...
Searching...
No Matches
BIORBD_NAMESPACE::internal_forces::muscles::FatigueDynamicState Class Referenceabstract

Class A state of fatigue that dynamically evolves over the usage of the muscle. More...

#include <FatigueDynamicState.h>

Inheritance diagram for BIORBD_NAMESPACE::internal_forces::muscles::FatigueDynamicState:
BIORBD_NAMESPACE::internal_forces::muscles::FatigueState BIORBD_NAMESPACE::internal_forces::muscles::FatigueDynamicStateXia

Public Member Functions

 FatigueDynamicState (const utils::Scalar &active=0, const utils::Scalar &fatigued=0, const utils::Scalar &resting=1)
 Construct the fatigue dynamic state.
 FatigueDynamicState (const std::shared_ptr< FatigueState > other)
 Construct the fatigue dynamic state from other state.
void DeepCopy (const FatigueDynamicState &other)
 Deep copy of a fatigue dynamic state.
const utils::Scalar & activeFibersDot () const
 Return the active fibers derivative.
const utils::Scalar & fatiguedFibersDot () const
 Return the fatigued fibers derivative.
const utils::Scalar & restingFibersDot () const
 Return the resting fibers derivative.
virtual void timeDerivativeState (const StateDynamics &emg, const Characteristics &characteristics)=0
 Compute the derivative of the current state.
Public Member Functions inherited from BIORBD_NAMESPACE::internal_forces::muscles::FatigueState
 FatigueState (const utils::Scalar &active=1, const utils::Scalar &fatigued=0, const utils::Scalar &resting=0)
 Construct fatigue state.
 FatigueState (const FatigueState &other)
 Construct fatigue state from another fatigue state.
 FatigueState (const std::shared_ptr< FatigueState > other)
 Construct fatigue state from another fatigue state.
virtual ~FatigueState ()
 Destroy class properly.
FatigueState DeepCopy () const
 Deep copy of the fatigue state.
void DeepCopy (const FatigueState &other)
 Deep copy of fatigue state in another fatigue state.
virtual void setState (utils::Scalar active, utils::Scalar fatigued, utils::Scalar resting, bool turnOffWarnings=false)
 Safe set of the state (ensure that sum of all activation is 1).
const utils::Scalar & activeFibers () const
 Return the propotion of active muscle fibers.
const utils::Scalar & fatiguedFibers () const
 Return the propotion of fatigued muscle fibers.
const utils::Scalar & restingFibers () const
 Return the propotion of resting muscle fibers.
STATE_FATIGUE_TYPE getType () const
 Return the type of muscle fatigue model.

Protected Attributes

std::shared_ptr< utils::Scalar > m_activeFibersDot
 The active fibers derivative.
std::shared_ptr< utils::Scalar > m_fatiguedFibersDot
 The fatigued fibers derivative.
std::shared_ptr< utils::Scalar > m_restingFibersDot
 The resting fibers derivative.
Protected Attributes inherited from BIORBD_NAMESPACE::internal_forces::muscles::FatigueState
std::shared_ptr< utils::Scalar > m_activeFibers
 Proportion of active muscle fibers.
std::shared_ptr< utils::Scalar > m_fatiguedFibers
 Proportion of fatigued muscle fibers.
std::shared_ptr< utils::Scalar > m_restingFibers
 Proportion of resting muscle fibers.
std::shared_ptr< STATE_FATIGUE_TYPE > m_type
 Type of the muscle fatigue model.

Additional Inherited Members

Protected Member Functions inherited from BIORBD_NAMESPACE::internal_forces::muscles::FatigueState
virtual void setType ()
 Set the type.

Detailed Description

Class A state of fatigue that dynamically evolves over the usage of the muscle.

Definition at line 18 of file FatigueDynamicState.h.

Constructor & Destructor Documentation

◆ FatigueDynamicState() [1/2]

internal_forces::muscles::FatigueDynamicState::FatigueDynamicState ( const utils::Scalar & active = 0,
const utils::Scalar & fatigued = 0,
const utils::Scalar & resting = 1 )

Construct the fatigue dynamic state.

Parameters
activeMuscle activation
fatiguedMuscle fatigue
restingMuscle resting

Definition at line 8 of file FatigueDynamicState.cpp.

◆ FatigueDynamicState() [2/2]

internal_forces::muscles::FatigueDynamicState::FatigueDynamicState ( const std::shared_ptr< FatigueState > other)

Construct the fatigue dynamic state from other state.

Parameters
otherThe other fatigue state

Definition at line 19 of file FatigueDynamicState.cpp.

Member Function Documentation

◆ activeFibersDot()

const utils::Scalar & internal_forces::muscles::FatigueDynamicState::activeFibersDot ( ) const

Return the active fibers derivative.

Returns
The active fibers derivative

Definition at line 42 of file FatigueDynamicState.cpp.

◆ DeepCopy()

void internal_forces::muscles::FatigueDynamicState::DeepCopy ( const FatigueDynamicState & other)

Deep copy of a fatigue dynamic state.

Parameters
otherThe other fatigue state

Definition at line 33 of file FatigueDynamicState.cpp.

◆ fatiguedFibersDot()

const utils::Scalar & internal_forces::muscles::FatigueDynamicState::fatiguedFibersDot ( ) const

Return the fatigued fibers derivative.

Returns
The fatigued fibers derivative

Definition at line 47 of file FatigueDynamicState.cpp.

◆ restingFibersDot()

const utils::Scalar & internal_forces::muscles::FatigueDynamicState::restingFibersDot ( ) const

Return the resting fibers derivative.

Returns
The resting fibers derivative

Definition at line 52 of file FatigueDynamicState.cpp.

◆ timeDerivativeState()

virtual void BIORBD_NAMESPACE::internal_forces::muscles::FatigueDynamicState::timeDerivativeState ( const StateDynamics & emg,
const Characteristics & characteristics )
pure virtual

Compute the derivative of the current state.

Parameters
emgEMG data
characteristicsThe muscle characteristics

Implemented in BIORBD_NAMESPACE::internal_forces::muscles::FatigueDynamicStateXia.

Member Data Documentation

◆ m_activeFibersDot

std::shared_ptr<utils::Scalar> BIORBD_NAMESPACE::internal_forces::muscles::FatigueDynamicState::m_activeFibersDot
protected

The active fibers derivative.

Definition at line 72 of file FatigueDynamicState.h.

◆ m_fatiguedFibersDot

std::shared_ptr<utils::Scalar> BIORBD_NAMESPACE::internal_forces::muscles::FatigueDynamicState::m_fatiguedFibersDot
protected

The fatigued fibers derivative.

Definition at line 74 of file FatigueDynamicState.h.

◆ m_restingFibersDot

std::shared_ptr<utils::Scalar> BIORBD_NAMESPACE::internal_forces::muscles::FatigueDynamicState::m_restingFibersDot
protected

The resting fibers derivative.

Definition at line 76 of file FatigueDynamicState.h.


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