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

#include <SpringForceField.h>

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

[legend]

Public Member Functions
	Spring (int m1=0, int m2=0, SReal ks=0.0, SReal kd=0.0, SReal initpos=0.0)
Data Fields
int	m1
int	m2
	the two extremities of the spring: masses m1 and m2
SReal	ks
	spring stiffness
SReal	kd
	damping factor
SReal	initpos
	rest length of the spring
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::SpringForceField< DataTypes >::Spring

Definition at line 68 of file SpringForceField.h.

---

Constructor & Destructor Documentation

template<class DataTypes >

sofa::component::forcefield::SpringForceField< DataTypes >::Spring::Spring	(	int	m1 = 0,
		int	m2 = 0,
		SReal	ks = 0.0,
		SReal	kd = 0.0,
		SReal	initpos = 0.0
	)			[inline]

Definition at line 76 of file SpringForceField.h.

---

Friends And Related Function Documentation

template<class DataTypes >

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

Definition at line 86 of file SpringForceField.h.

template<class DataTypes >

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

Definition at line 81 of file SpringForceField.h.

---

Field Documentation

template<class DataTypes >

SReal sofa::component::forcefield::SpringForceField< DataTypes >::Spring::initpos

rest length of the spring

Definition at line 74 of file SpringForceField.h.

Referenced by sofa::component::forcefield::SparseGridSpringForceField< DataTypes >::addDForce(), sofa::component::forcefield::RegularGridSpringForceField< DataTypes >::addDForce(), sofa::component::forcefield::SparseGridSpringForceField< DataTypes >::addForce(), sofa::component::forcefield::RegularGridSpringForceField< DataTypes >::addForce(), sofa::component::forcefield::StiffSpringForceField< DataTypes >::addSpringForce(), sofa::component::forcefield::SpringForceField< DataTypes >::addSpringForce(), sofa::component::forcefield::SparseGridSpringForceField< DataTypes >::draw(), and sofa::component::forcefield::RegularGridSpringForceField< DataTypes >::draw().

template<class DataTypes >

SReal sofa::component::forcefield::SpringForceField< DataTypes >::Spring::kd

damping factor

Definition at line 73 of file SpringForceField.h.

Referenced by sofa::component::forcefield::SparseGridSpringForceField< DataTypes >::addDForce(), sofa::component::forcefield::RegularGridSpringForceField< DataTypes >::addDForce(), sofa::component::forcefield::SparseGridSpringForceField< DataTypes >::addForce(), sofa::component::forcefield::RegularGridSpringForceField< DataTypes >::addForce(), sofa::component::forcefield::StiffSpringForceField< DataTypes >::addSpringForce(), sofa::component::forcefield::SpringForceField< DataTypes >::addSpringForce(), sofa::component::forcefield::SparseGridSpringForceField< DataTypes >::draw(), and sofa::component::forcefield::RegularGridSpringForceField< DataTypes >::draw().

template<class DataTypes >

SReal sofa::component::forcefield::SpringForceField< DataTypes >::Spring::ks

spring stiffness

Definition at line 72 of file SpringForceField.h.

Referenced by sofa::component::forcefield::SparseGridSpringForceField< DataTypes >::addDForce(), sofa::component::forcefield::RegularGridSpringForceField< DataTypes >::addDForce(), sofa::component::forcefield::SparseGridSpringForceField< DataTypes >::addForce(), sofa::component::forcefield::RegularGridSpringForceField< DataTypes >::addForce(), sofa::component::forcefield::StiffSpringForceField< DataTypes >::addSpringForce(), sofa::component::forcefield::SpringForceField< DataTypes >::addSpringForce(), sofa::component::forcefield::SparseGridSpringForceField< DataTypes >::draw(), and sofa::component::forcefield::RegularGridSpringForceField< DataTypes >::draw().

template<class DataTypes >

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

Definition at line 71 of file SpringForceField.h.

Referenced by sofa::component::forcefield::SparseGridSpringForceField< DataTypes >::addDForce(), sofa::component::forcefield::RegularGridSpringForceField< DataTypes >::addDForce(), sofa::component::forcefield::SparseGridSpringForceField< DataTypes >::addForce(), sofa::component::forcefield::RegularGridSpringForceField< DataTypes >::addForce(), sofa::component::forcefield::StiffSpringForceField< DataTypes >::addSpringDForce(), sofa::component::forcefield::StiffSpringForceField< DataTypes >::addSpringForce(), sofa::component::forcefield::SpringForceField< DataTypes >::addSpringForce(), sofa::component::forcefield::SparseGridSpringForceField< DataTypes >::draw(), and sofa::component::forcefield::RegularGridSpringForceField< DataTypes >::draw().

template<class DataTypes >

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

the two extremities of the spring: masses m1 and m2

Definition at line 71 of file SpringForceField.h.

Referenced by sofa::component::forcefield::SparseGridSpringForceField< DataTypes >::addDForce(), sofa::component::forcefield::RegularGridSpringForceField< DataTypes >::addDForce(), sofa::component::forcefield::SparseGridSpringForceField< DataTypes >::addForce(), sofa::component::forcefield::RegularGridSpringForceField< DataTypes >::addForce(), sofa::component::forcefield::StiffSpringForceField< DataTypes >::addSpringDForce(), sofa::component::forcefield::StiffSpringForceField< DataTypes >::addSpringForce(), sofa::component::forcefield::SpringForceField< DataTypes >::addSpringForce(), sofa::component::forcefield::SparseGridSpringForceField< DataTypes >::draw(), and sofa::component::forcefield::RegularGridSpringForceField< DataTypes >::draw().

---

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

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