sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring Class Reference

#include <FrameSpringForceField.h>

Collaboration diagram for sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring:

[legend]

Public Member Functions
	Spring (int m1=0, int m2=0, Real softKst=0, Real softKsr=0, Real kd=0)
	stiffness to apply on axis where the rotations are free (default 0.0)
Real	getStiffnessRotation ()
Real	getStiffnessTranslation ()
VecN	getInitVec1 ()
void	setStiffnessRotation (Real ksr)
void	setStiffnessTranslation (Real kst)
void	setInitVec1 (const VecN &l)
void	setInitVec2 (const VecN &l)
void	setDamping (Real _kd)
Data Fields
int	m1
int	m2
VecN	vec1
	the two extremities of the spring: masses m1 and m2 ( indexes of the DOFs)
VecN	vec2
Real	kd
Real	stiffnessTrans
	damping factor
Real	stiffnessRot
	stiffness to apply on axis where the translations are free (default 0.0)
Friends
std::istream &	operator>> (std::istream &in, Spring &s)
std::ostream &	operator<< (std::ostream &out, const Spring &s)

---

Detailed Description

template<class DataTypes>
class sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring

Definition at line 71 of file FrameSpringForceField.h.

---

Constructor & Destructor Documentation

template<class DataTypes >

sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::Spring	(	int	m1 = 0,
		int	m2 = 0,
		Real	softKst = 0,
		Real	softKsr = 0,
		Real	kd = 0
	)			[inline]

stiffness to apply on axis where the rotations are free (default 0.0)

constructors

Definition at line 82 of file FrameSpringForceField.h.

---

Member Function Documentation

template<class DataTypes >

VecN sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::getInitVec1

(

)

[inline]

Definition at line 90 of file FrameSpringForceField.h.

References sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::vec1.

template<class DataTypes >

Real sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::getStiffnessRotation

(

)

[inline]

Definition at line 88 of file FrameSpringForceField.h.

References sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::stiffnessRot.

template<class DataTypes >

Real sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::getStiffnessTranslation

(

)

[inline]

Definition at line 89 of file FrameSpringForceField.h.

References sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::stiffnessTrans.

template<class DataTypes >

void sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::setDamping

(

Real

_kd

)

[inline]

Definition at line 97 of file FrameSpringForceField.h.

References sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::kd.

template<class DataTypes >

void sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::setInitVec1

(

const VecN &

l

)

[inline]

Definition at line 95 of file FrameSpringForceField.h.

References sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::vec1.

template<class DataTypes >

void sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::setInitVec2

(

const VecN &

l

)

[inline]

Definition at line 96 of file FrameSpringForceField.h.

References sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::vec2.

template<class DataTypes >

void sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::setStiffnessRotation

(

Real

ksr

)

[inline]

Definition at line 93 of file FrameSpringForceField.h.

References sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::stiffnessRot.

template<class DataTypes >

void sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::setStiffnessTranslation

(

Real

kst

)

[inline]

Definition at line 94 of file FrameSpringForceField.h.

References sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::stiffnessTrans.

---

Friends And Related Function Documentation

template<class DataTypes >

std::ostream& operator<<	(	std::ostream &	out,
		const Spring &	s
	)			[friend]

Definition at line 135 of file FrameSpringForceField.h.

template<class DataTypes >

std::istream& operator>>	(	std::istream &	in,
		Spring &	s
	)			[friend]

Definition at line 100 of file FrameSpringForceField.h.

---

Field Documentation

template<class DataTypes >

Real sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::kd

Definition at line 76 of file FrameSpringForceField.h.

Referenced by sofa::component::forcefield::FrameSpringForceField< DataTypes >::addSpringForce(), and sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::setDamping().

template<class DataTypes >

int sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::m1

Definition at line 74 of file FrameSpringForceField.h.

Referenced by sofa::component::forcefield::FrameSpringForceField< DataTypes >::addSpringDForce(), and sofa::component::forcefield::FrameSpringForceField< DataTypes >::addSpringForce().

template<class DataTypes >

int sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::m2

Definition at line 74 of file FrameSpringForceField.h.

Referenced by sofa::component::forcefield::FrameSpringForceField< DataTypes >::addSpringDForce(), and sofa::component::forcefield::FrameSpringForceField< DataTypes >::addSpringForce().

template<class DataTypes >

Real sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::stiffnessRot

stiffness to apply on axis where the translations are free (default 0.0)

Definition at line 79 of file FrameSpringForceField.h.

Referenced by sofa::component::forcefield::FrameSpringForceField< DataTypes >::addSpringDForce(), sofa::component::forcefield::FrameSpringForceField< DataTypes >::addSpringForce(), sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::getStiffnessRotation(), and sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::setStiffnessRotation().

template<class DataTypes >

Real sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::stiffnessTrans

damping factor

Definition at line 78 of file FrameSpringForceField.h.

Referenced by sofa::component::forcefield::FrameSpringForceField< DataTypes >::addSpringDForce(), sofa::component::forcefield::FrameSpringForceField< DataTypes >::addSpringForce(), sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::getStiffnessTranslation(), and sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::setStiffnessTranslation().

template<class DataTypes >

VecN sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::vec1

the two extremities of the spring: masses m1 and m2 ( indexes of the DOFs)

Definition at line 75 of file FrameSpringForceField.h.

Referenced by sofa::component::forcefield::FrameSpringForceField< DataTypes >::addSpringForce(), sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::getInitVec1(), and sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::setInitVec1().

template<class DataTypes >

VecN sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::vec2

Definition at line 75 of file FrameSpringForceField.h.

Referenced by sofa::component::forcefield::FrameSpringForceField< DataTypes >::addSpringForce(), and sofa::component::forcefield::FrameSpringForceField< DataTypes >::Spring::setInitVec2().

---

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

• modules/sofa/component/forcefield/FrameSpringForceField.h