Class Holds that muscle characteristics. More...

#include <Characteristics.h>

Public Member Functions
	Characteristics ()
	Construct characteristics.
	Characteristics (const Characteristics &other)
	Construct characteristics from other characteristics.
	Characteristics (const utils::Scalar &optLength, const utils::Scalar &fmax, const utils::Scalar &PCSA, const utils::Scalar &tendonSlackLength, const utils::Scalar &pennAngle, const State &emgMax, const FatigueParameters &fatigueParameters, bool useDamping=false, const utils::Scalar &maxShorteningSpeed=10.0, const utils::Scalar &torqueAct=0.01, const utils::Scalar &torqueDeact=0.04, const utils::Scalar &minAct=0.01)
	Construct characteristics.
virtual	~Characteristics ()
	Destroy the class properly.
Characteristics	DeepCopy () const
	Deep copy of characteristics.
void	DeepCopy (const Characteristics &other)
	Deep copy of characteristics from another characteristics.
void	setOptimalLength (const utils::Scalar &val)
	Set the length without tension.
virtual const utils::Scalar &	optimalLength () const
	Return the optimal length at which maximal force occurs.
virtual void	setForceIsoMax (const utils::Scalar &val)
	Set the maximal isometric force.
const utils::Scalar &	forceIsoMax () const
	Return the maximal isometric force at optimal length.
void	setTendonSlackLength (const utils::Scalar &val)
	Set the tendon slack length.
const utils::Scalar &	tendonSlackLength () const
	Return the tendon slack length.
void	setPennationAngle (const utils::Scalar &val)
	Set the angle of pennation.
const utils::Scalar &	pennationAngle () const
	Return the angle of pennation.
void	setPCSA (const utils::Scalar &val)
	Set the physiological cross-sectional area of the muscle.
const utils::Scalar &	PCSA () const
	Return the physiological cross-sectional area of the muscle.
void	setMinActivation (const utils::Scalar &val)
	Set the minimal activation of the muscle.
const utils::Scalar &	minActivation () const
	Return the minimal activation of the muscle.
void	setMaxShorteningSpeed (const utils::Scalar &val)
	Set the maximal velocity of shortening.
const utils::Scalar &	maxShorteningSpeed () const
	Return the maximal velocity of shortening.
void	setTorqueActivation (const utils::Scalar &val)
	Set the time activation constant.
const utils::Scalar &	torqueActivation () const
	Return the time activation constant.
void	setTorqueDeactivation (const utils::Scalar &val)
	Set the time deactivation constant.
const utils::Scalar &	torqueDeactivation () const
	Return the time deactivation constant.
void	setStateMax (const State &emgMax)
	Set the maximal excitation and activation of the muscle.
const State &	stateMax () const
	Return the maximal excitation and activation of the muscle.
void	setFatigueParameters (const FatigueParameters &fatigueParameters)
	Set the fatigue parameters.
const FatigueParameters &	fatigueParameters () const
	Return the fatigue parameters.
void	setUseDamping (bool val)
	Choose if use damping for muscle force computation.
bool	useDamping () const
	Return 1 if use damping for muscle computation.

Protected Attributes
std::shared_ptr< utils::Scalar >	m_optimalLength
	Length without tension.
std::shared_ptr< utils::Scalar >	m_fIsoMax
	Maximal isometric force.
std::shared_ptr< utils::Scalar >	m_PCSA
	Physiological cross-sectional area of the muscle.
std::shared_ptr< utils::Scalar >	m_tendonSlackLength
	Tendon slack length.
std::shared_ptr< utils::Scalar >	m_pennationAngle
	Angle of pennation.
std::shared_ptr< bool >	m_useDamping
	Use damping for muscle force from activation.
std::shared_ptr< State >	m_stateMax
	Maximal excitation et activation of the muscle.
std::shared_ptr< utils::Scalar >	m_maxShorteningSpeed
	Maximal velocity of shortening.
std::shared_ptr< utils::Scalar >	m_minActivation
	Minimal activation.
std::shared_ptr< utils::Scalar >	m_torqueActivation
	Time activation constant.
std::shared_ptr< utils::Scalar >	m_torqueDeactivation
	Time deactivation constant.
std::shared_ptr< FatigueParameters >	m_fatigueParameters
	Fatigue parameters.

Detailed Description

Class Holds that muscle characteristics.

Definition at line 19 of file Characteristics.h.

Constructor & Destructor Documentation

◆ Characteristics() [1/3]

internal_forces::muscles::Characteristics::Characteristics ( )

Construct characteristics.

Definition at line 9 of file Characteristics.cpp.

◆ Characteristics() [2/3]

internal_forces::muscles::Characteristics::Characteristics ( const Characteristics & other )

Construct characteristics from other characteristics.

Parameters

other The other characteristics

Definition at line 27 of file Characteristics.cpp.

◆ Characteristics() [3/3]

internal_forces::muscles::Characteristics::Characteristics	(	const utils::Scalar &	optLength,
		const utils::Scalar &	fmax,
		const utils::Scalar &	PCSA,
		const utils::Scalar &	tendonSlackLength,
		const utils::Scalar &	pennAngle,
		const State &	emgMax,
		const FatigueParameters &	fatigueParameters,
		bool	useDamping = false,
		const utils::Scalar &	maxShorteningSpeed = 10.0,
		const utils::Scalar &	torqueAct = 0.01,
		const utils::Scalar &	torqueDeact = 0.04,
		const utils::Scalar &	minAct = 0.01 )

Construct characteristics.

Parameters

optLength	Optimal length (where maximal force occurs)
fmax	The maximal isometric force at optimal length
PCSA	Physiological cross-sectional area of the muscle
tendonSlackLength	The tendon slack length
pennAngle	The angle of pennation
emgMax	Maximal excitation and activation of the muscle
fatigueParameters	The fatigue model
torqueAct	Time activation constant (default: 0.01)
torqueDeact	Time deactivation constant (default: 0.04)
minAct	Minimal activation (default: 0.01)
useDamping	Use damping (default: false)
maxShorteningSpeed	Maximal velocity of shortening (default: 10.0)

Definition at line 42 of file Characteristics.cpp.

◆ ~Characteristics()

internal_forces::muscles::Characteristics::~Characteristics ( )

virtual

Destroy the class properly.

Definition at line 71 of file Characteristics.cpp.

Member Function Documentation

◆ DeepCopy() [1/2]

internal_forces::muscles::Characteristics internal_forces::muscles::Characteristics::DeepCopy ( ) const

Deep copy of characteristics.

Returns: A depp copy of characteristics

Definition at line 74 of file Characteristics.cpp.

◆ DeepCopy() [2/2]

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

Deep copy of characteristics from another characteristics.

Parameters

other The characteristics to copy from

Definition at line 80 of file Characteristics.cpp.

◆ fatigueParameters()

const internal_forces::muscles::FatigueParameters & internal_forces::muscles::Characteristics::fatigueParameters ( ) const

Return the fatigue parameters.

Returns: The fatigue parameters

Definition at line 192 of file Characteristics.cpp.

◆ forceIsoMax()

const utils::Scalar & internal_forces::muscles::Characteristics::forceIsoMax ( ) const

Return the maximal isometric force at optimal length.

Returns: The maximal isometric force

Definition at line 110 of file Characteristics.cpp.

◆ maxShorteningSpeed()

const utils::Scalar & internal_forces::muscles::Characteristics::maxShorteningSpeed ( ) const

Return the maximal velocity of shortening.

Returns: The maximal velocity of shortening

Definition at line 156 of file Characteristics.cpp.

◆ minActivation()

const utils::Scalar & internal_forces::muscles::Characteristics::minActivation ( ) const

Return the minimal activation of the muscle.

Returns: The minimal activation of the muscle

Definition at line 145 of file Characteristics.cpp.

◆ optimalLength()

const utils::Scalar & internal_forces::muscles::Characteristics::optimalLength ( ) const

virtual

Return the optimal length at which maximal force occurs.

Returns: The length without tension

Definition at line 101 of file Characteristics.cpp.

◆ PCSA()

const utils::Scalar & internal_forces::muscles::Characteristics::PCSA ( ) const

Return the physiological cross-sectional area of the muscle.

Returns: The physiological cross-sectional area of the muscle

Definition at line 137 of file Characteristics.cpp.

◆ pennationAngle()

const utils::Scalar & internal_forces::muscles::Characteristics::pennationAngle ( ) const

Return the angle of pennation.

Returns: The angle of pennation

Definition at line 128 of file Characteristics.cpp.

◆ setFatigueParameters()

void internal_forces::muscles::Characteristics::setFatigueParameters ( const FatigueParameters & fatigueParameters )

Set the fatigue parameters.

Parameters

fatigueParameters The values of the fatigue parameters

Definition at line 187 of file Characteristics.cpp.

◆ setForceIsoMax()

void internal_forces::muscles::Characteristics::setForceIsoMax ( const utils::Scalar & val )

virtual

Set the maximal isometric force.

Parameters

val	Value of the maximal isometric force

Definition at line 106 of file Characteristics.cpp.

◆ setMaxShorteningSpeed()

void internal_forces::muscles::Characteristics::setMaxShorteningSpeed ( const utils::Scalar & val )

Set the maximal velocity of shortening.

Parameters

val	The value of the maximal velocity of shortening

Definition at line 150 of file Characteristics.cpp.

◆ setMinActivation()

void internal_forces::muscles::Characteristics::setMinActivation ( const utils::Scalar & val )

Set the minimal activation of the muscle.

Parameters

val	The value of the minimal activation of the muscle

Definition at line 141 of file Characteristics.cpp.

◆ setOptimalLength()

void internal_forces::muscles::Characteristics::setOptimalLength ( const utils::Scalar & val )

Set the length without tension.

Parameters

val	Value of the length without tension

Definition at line 97 of file Characteristics.cpp.

◆ setPCSA()

void internal_forces::muscles::Characteristics::setPCSA ( const utils::Scalar & val )

Set the physiological cross-sectional area of the muscle.

Parameters

val	Value of the physiological cross-sectional area of the muscle

Definition at line 133 of file Characteristics.cpp.

◆ setPennationAngle()

void internal_forces::muscles::Characteristics::setPennationAngle ( const utils::Scalar & val )

Set the angle of pennation.

Parameters

val	Value of the angle of pennation

Definition at line 124 of file Characteristics.cpp.

◆ setStateMax()

void internal_forces::muscles::Characteristics::setStateMax ( const State & emgMax )

Set the maximal excitation and activation of the muscle.

Parameters

emgMax Value of the maximal excitation and activation of the muscle

Definition at line 178 of file Characteristics.cpp.

◆ setTendonSlackLength()

void internal_forces::muscles::Characteristics::setTendonSlackLength ( const utils::Scalar & val )

Set the tendon slack length.

Parameters

val	Value of the tendon slack length

Definition at line 115 of file Characteristics.cpp.

◆ setTorqueActivation()

void internal_forces::muscles::Characteristics::setTorqueActivation ( const utils::Scalar & val )

Set the time activation constant.

Parameters

val	The value of the time activation constant

Definition at line 160 of file Characteristics.cpp.

◆ setTorqueDeactivation()

void internal_forces::muscles::Characteristics::setTorqueDeactivation ( const utils::Scalar & val )

Set the time deactivation constant.

Parameters

val	The value of the time deactivation constant

Definition at line 169 of file Characteristics.cpp.

◆ setUseDamping()

void internal_forces::muscles::Characteristics::setUseDamping ( bool val )

Choose if use damping for muscle force computation.

Parameters

val	0 to not use damping

Definition at line 196 of file Characteristics.cpp.

◆ stateMax()

const internal_forces::muscles::State & internal_forces::muscles::Characteristics::stateMax ( ) const

Return the maximal excitation and activation of the muscle.

Returns: The maximal excitation and activation of the muscle

Definition at line 183 of file Characteristics.cpp.

◆ tendonSlackLength()

const utils::Scalar & internal_forces::muscles::Characteristics::tendonSlackLength ( ) const

Return the tendon slack length.

Returns: The tendon slack length

Definition at line 120 of file Characteristics.cpp.

◆ torqueActivation()

const utils::Scalar & internal_forces::muscles::Characteristics::torqueActivation ( ) const

Return the time activation constant.

Returns: The time activation constant

Definition at line 165 of file Characteristics.cpp.

◆ torqueDeactivation()

const utils::Scalar & internal_forces::muscles::Characteristics::torqueDeactivation ( ) const

Return the time deactivation constant.

Returns: The time deactivation constant

Definition at line 174 of file Characteristics.cpp.

◆ useDamping()

bool internal_forces::muscles::Characteristics::useDamping ( ) const

Return 1 if use damping for muscle computation.

Returns: 0 if not use damping 1 overall

Definition at line 199 of file Characteristics.cpp.

Member Data Documentation

◆ m_fatigueParameters

std::shared_ptr<FatigueParameters> BIORBD_NAMESPACE::internal_forces::muscles::Characteristics::m_fatigueParameters

protected

Fatigue parameters.

Definition at line 243 of file Characteristics.h.

◆ m_fIsoMax

std::shared_ptr<utils::Scalar> BIORBD_NAMESPACE::internal_forces::muscles::Characteristics::m_fIsoMax

protected

Maximal isometric force.

Definition at line 221 of file Characteristics.h.

◆ m_maxShorteningSpeed

std::shared_ptr<utils::Scalar> BIORBD_NAMESPACE::internal_forces::muscles::Characteristics::m_maxShorteningSpeed

protected

Maximal velocity of shortening.

Definition at line 232 of file Characteristics.h.

◆ m_minActivation

std::shared_ptr<utils::Scalar> BIORBD_NAMESPACE::internal_forces::muscles::Characteristics::m_minActivation

protected

Minimal activation.

Definition at line 235 of file Characteristics.h.

◆ m_optimalLength

std::shared_ptr<utils::Scalar> BIORBD_NAMESPACE::internal_forces::muscles::Characteristics::m_optimalLength

protected

Length without tension.

Definition at line 220 of file Characteristics.h.

◆ m_PCSA

std::shared_ptr<utils::Scalar> BIORBD_NAMESPACE::internal_forces::muscles::Characteristics::m_PCSA

protected

Physiological cross-sectional area of the muscle.

Definition at line 223 of file Characteristics.h.

◆ m_pennationAngle

std::shared_ptr<utils::Scalar> BIORBD_NAMESPACE::internal_forces::muscles::Characteristics::m_pennationAngle

protected

Angle of pennation.

Definition at line 225 of file Characteristics.h.

◆ m_stateMax

std::shared_ptr<State> BIORBD_NAMESPACE::internal_forces::muscles::Characteristics::m_stateMax

protected

Maximal excitation et activation of the muscle.

Definition at line 229 of file Characteristics.h.

◆ m_tendonSlackLength

std::shared_ptr<utils::Scalar> BIORBD_NAMESPACE::internal_forces::muscles::Characteristics::m_tendonSlackLength

protected

Tendon slack length.

Definition at line 224 of file Characteristics.h.

◆ m_torqueActivation

std::shared_ptr<utils::Scalar> BIORBD_NAMESPACE::internal_forces::muscles::Characteristics::m_torqueActivation

protected

Time activation constant.

Definition at line 237 of file Characteristics.h.

◆ m_torqueDeactivation

std::shared_ptr<utils::Scalar> BIORBD_NAMESPACE::internal_forces::muscles::Characteristics::m_torqueDeactivation

protected

Time deactivation constant.

Definition at line 239 of file Characteristics.h.

◆ m_useDamping

std::shared_ptr<bool> BIORBD_NAMESPACE::internal_forces::muscles::Characteristics::m_useDamping

protected

Use damping for muscle force from activation.

Definition at line 227 of file Characteristics.h.

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Characteristics() [1/3]

◆ Characteristics() [2/3]

◆ Characteristics() [3/3]

◆ ~Characteristics()

Member Function Documentation

◆ DeepCopy() [1/2]

◆ DeepCopy() [2/2]

◆ fatigueParameters()

◆ forceIsoMax()

◆ maxShorteningSpeed()

◆ minActivation()

◆ optimalLength()

◆ PCSA()

◆ pennationAngle()

◆ setFatigueParameters()

◆ setForceIsoMax()

◆ setMaxShorteningSpeed()

◆ setMinActivation()

◆ setOptimalLength()

◆ setPCSA()

◆ setPennationAngle()

◆ setStateMax()

◆ setTendonSlackLength()

◆ setTorqueActivation()

◆ setTorqueDeactivation()

◆ setUseDamping()

◆ stateMax()

◆ tendonSlackLength()

◆ torqueActivation()

◆ torqueDeactivation()

◆ useDamping()

Member Data Documentation

◆ m_fatigueParameters

◆ m_fIsoMax

◆ m_maxShorteningSpeed

◆ m_minActivation

◆ m_optimalLength

◆ m_PCSA

◆ m_pennationAngle

◆ m_stateMax

◆ m_tendonSlackLength

◆ m_torqueActivation

◆ m_torqueDeactivation

◆ m_useDamping