Biorbd
Release_1.13.0
Toggle main menu visibility
Loading...
Searching...
No Matches
LigamentCharacteristics.h
1
#ifndef BIORBD_LIGAMENTS_LIGAMENT_CHARACTERISTICS_H
2
#define BIORBD_LIGAMENTS_LIGAMENT_CHARACTERISTICS_H
3
4
#include "biorbdConfig.h"
5
6
#include <cstddef>
7
#include <memory>
8
9
#include "Utils/Scalar.h"
10
11
namespace
BIORBD_NAMESPACE {
12
namespace
internal_forces {
13
namespace
ligaments {
14
class
State;
15
class
FatigueParameters;
19
class
BIORBD_API
LigamentCharacteristics
{
20
public
:
24
LigamentCharacteristics
();
25
30
LigamentCharacteristics
(
const
LigamentCharacteristics
& other);
31
38
LigamentCharacteristics
(
39
const
utils::Scalar&
ligamentSlackLength
,
40
const
utils::Scalar& cste_damping = 0,
41
const
utils::Scalar& cste_maxShorteningSpeed = 1);
42
46
virtual
~LigamentCharacteristics
();
47
52
LigamentCharacteristics
DeepCopy
()
const
;
53
58
void
DeepCopy
(
const
LigamentCharacteristics
& other);
59
64
void
setLigamentSlackLength
(
const
utils::Scalar& val);
69
const
utils::Scalar&
ligamentSlackLength
()
const
;
70
75
void
setDampingParam
(
const
utils::Scalar& val);
76
81
const
utils::Scalar&
dampingParam
()
const
;
82
87
void
setMaxShorteningSpeed
(
const
utils::Scalar& val);
88
93
const
utils::Scalar&
maxShorteningSpeed
()
const
;
94
95
protected
:
96
std::shared_ptr<utils::Scalar>
97
m_ligamentSlackLength
;
98
std::shared_ptr<utils::Scalar>
99
m_cste_damping
;
100
std::shared_ptr<utils::Scalar>
101
m_cste_maxShorteningSpeed
;
102
};
103
104
}
// namespace ligaments
105
}
// namespace internal_forces
106
}
// namespace BIORBD_NAMESPACE
107
108
#endif
// BIORBD_LIGAMENTS_LIGAMENT_CHARACTERISTICS_H
BIORBD_NAMESPACE::internal_forces::ligaments::LigamentCharacteristics::DeepCopy
LigamentCharacteristics DeepCopy() const
Deep copy of characteristics.
Definition
LigamentCharacteristics.cpp:33
BIORBD_NAMESPACE::internal_forces::ligaments::LigamentCharacteristics::setMaxShorteningSpeed
void setMaxShorteningSpeed(const utils::Scalar &val)
Choose if use damping for ligament force computation.
Definition
LigamentCharacteristics.cpp:56
BIORBD_NAMESPACE::internal_forces::ligaments::LigamentCharacteristics::m_ligamentSlackLength
std::shared_ptr< utils::Scalar > m_ligamentSlackLength
Ligament slack length.
Definition
LigamentCharacteristics.h:97
BIORBD_NAMESPACE::internal_forces::ligaments::LigamentCharacteristics::m_cste_damping
std::shared_ptr< utils::Scalar > m_cste_damping
Ligament damping parameters (0 no damping).
Definition
LigamentCharacteristics.h:99
BIORBD_NAMESPACE::internal_forces::ligaments::LigamentCharacteristics::m_cste_maxShorteningSpeed
std::shared_ptr< utils::Scalar > m_cste_maxShorteningSpeed
Ligament shorteningSpeed.
Definition
LigamentCharacteristics.h:101
BIORBD_NAMESPACE::internal_forces::ligaments::LigamentCharacteristics::setDampingParam
void setDampingParam(const utils::Scalar &val)
Choose if use damping for ligament force computation.
Definition
LigamentCharacteristics.cpp:66
BIORBD_NAMESPACE::internal_forces::ligaments::LigamentCharacteristics::maxShorteningSpeed
const utils::Scalar & maxShorteningSpeed() const
Return 1 if use damping for ligament computation.
Definition
LigamentCharacteristics.cpp:61
BIORBD_NAMESPACE::internal_forces::ligaments::LigamentCharacteristics::ligamentSlackLength
const utils::Scalar & ligamentSlackLength() const
Return the tendon slack length.
Definition
LigamentCharacteristics.cpp:51
BIORBD_NAMESPACE::internal_forces::ligaments::LigamentCharacteristics::dampingParam
const utils::Scalar & dampingParam() const
Return 1 if use damping for ligament computation.
Definition
LigamentCharacteristics.cpp:71
BIORBD_NAMESPACE::internal_forces::ligaments::LigamentCharacteristics::LigamentCharacteristics
LigamentCharacteristics()
Construct characteristics.
Definition
LigamentCharacteristics.cpp:6
BIORBD_NAMESPACE::internal_forces::ligaments::LigamentCharacteristics::setLigamentSlackLength
void setLigamentSlackLength(const utils::Scalar &val)
Set the tendon slack length.
Definition
LigamentCharacteristics.cpp:47
include
InternalForces
Ligaments
LigamentCharacteristics.h
Generated by
1.18.0