sofa::component::forcefield::PenalityContactForceField< DataTypes >::Contact Class Reference

#include <PenalityContactForceField.h>

Collaboration diagram for sofa::component::forcefield::PenalityContactForceField< DataTypes >::Contact:

[legend]

Public Member Functions
	Contact (int _m1=0, int _m2=0, int _index1=0, int _index2=0, Deriv _norm=Deriv(), Real _dist=Real(), Real _ks=Real(), Real _mu_s=Real(), Real _mu_v=Real(), Real _pen=Real(), int _age=0)
Data Fields
int	m1
int	m2
	the two extremities of the spring: masses m1 and m2
int	index1
int	index2
	the index of the two collision elements
Deriv	norm
	contact normal, from m1 to m2
Real	dist
	minimum distance between the points
Real	ks
	spring stiffness
Real	mu_s
	coulomb friction coefficient (currently unused)
Real	mu_v
	viscous friction coefficient
Real	pen
	current penetration
int	age
	how old is this contact
Friends
std::istream &	operator>> (std::istream &in, Contact &c)
std::ostream &	operator<< (std::ostream &out, const Contact &c)

---

Detailed Description

template<class DataTypes>
class sofa::component::forcefield::PenalityContactForceField< DataTypes >::Contact

Definition at line 59 of file PenalityContactForceField.h.

---

Constructor & Destructor Documentation

template<class DataTypes >

sofa::component::forcefield::PenalityContactForceField< DataTypes >::Contact::Contact	(	int	_m1 = 0,
		int	_m2 = 0,
		int	_index1 = 0,
		int	_index2 = 0,
		Deriv	_norm = Deriv(),
		Real	_dist = Real(),
		Real	_ks = Real(),
		Real	_mu_s = Real(),
		Real	_mu_v = Real(),
		Real	_pen = Real(),
		int	_age = 0
	)			[inline]

Definition at line 74 of file PenalityContactForceField.h.

---

Friends And Related Function Documentation

template<class DataTypes >

std::ostream& operator<<	(	std::ostream &	out,
		const Contact &	c
	)			[friend]

Definition at line 85 of file PenalityContactForceField.h.

template<class DataTypes >

std::istream& operator>>	(	std::istream &	in,
		Contact &	c
	)			[friend]

Definition at line 80 of file PenalityContactForceField.h.

---

Field Documentation

template<class DataTypes >

int sofa::component::forcefield::PenalityContactForceField< DataTypes >::Contact::age

how old is this contact

Definition at line 71 of file PenalityContactForceField.h.

Referenced by sofa::component::forcefield::PenalityContactForceField< DataTypes >::addContact(), and sofa::component::forcefield::PenalityContactForceField< DataTypes >::draw().

template<class DataTypes >

Real sofa::component::forcefield::PenalityContactForceField< DataTypes >::Contact::dist

minimum distance between the points

Definition at line 66 of file PenalityContactForceField.h.

Referenced by sofa::component::forcefield::PenalityContactForceField< DataTypes >::addContact(), sofa::component::forcefield::PenalityContactForceField< DataTypes >::addForce(), and sofa::component::forcefield::PenalityContactForceField< DataTypes >::draw().

template<class DataTypes >

int sofa::component::forcefield::PenalityContactForceField< DataTypes >::Contact::index1

Definition at line 64 of file PenalityContactForceField.h.

Referenced by sofa::component::forcefield::PenalityContactForceField< DataTypes >::addContact().

template<class DataTypes >

int sofa::component::forcefield::PenalityContactForceField< DataTypes >::Contact::index2

the index of the two collision elements

Definition at line 64 of file PenalityContactForceField.h.

Referenced by sofa::component::forcefield::PenalityContactForceField< DataTypes >::addContact().

template<class DataTypes >

Real sofa::component::forcefield::PenalityContactForceField< DataTypes >::Contact::ks

spring stiffness

Definition at line 67 of file PenalityContactForceField.h.

Referenced by sofa::component::forcefield::PenalityContactForceField< DataTypes >::addContact(), sofa::component::forcefield::PenalityContactForceField< DataTypes >::addDForce(), and sofa::component::forcefield::PenalityContactForceField< DataTypes >::addForce().

template<class DataTypes >

int sofa::component::forcefield::PenalityContactForceField< DataTypes >::Contact::m1

Definition at line 63 of file PenalityContactForceField.h.

Referenced by sofa::component::forcefield::PenalityContactForceField< DataTypes >::addContact(), sofa::component::forcefield::PenalityContactForceField< DataTypes >::addDForce(), sofa::component::forcefield::PenalityContactForceField< DataTypes >::addForce(), and sofa::component::forcefield::PenalityContactForceField< DataTypes >::draw().

template<class DataTypes >

int sofa::component::forcefield::PenalityContactForceField< DataTypes >::Contact::m2

the two extremities of the spring: masses m1 and m2

Definition at line 63 of file PenalityContactForceField.h.

Referenced by sofa::component::forcefield::PenalityContactForceField< DataTypes >::addContact(), sofa::component::forcefield::PenalityContactForceField< DataTypes >::addDForce(), sofa::component::forcefield::PenalityContactForceField< DataTypes >::addForce(), and sofa::component::forcefield::PenalityContactForceField< DataTypes >::draw().

template<class DataTypes >

Real sofa::component::forcefield::PenalityContactForceField< DataTypes >::Contact::mu_s

coulomb friction coefficient (currently unused)

Definition at line 68 of file PenalityContactForceField.h.

Referenced by sofa::component::forcefield::PenalityContactForceField< DataTypes >::addContact().

template<class DataTypes >

Real sofa::component::forcefield::PenalityContactForceField< DataTypes >::Contact::mu_v

viscous friction coefficient

Definition at line 69 of file PenalityContactForceField.h.

Referenced by sofa::component::forcefield::PenalityContactForceField< DataTypes >::addContact().

template<class DataTypes >

Deriv sofa::component::forcefield::PenalityContactForceField< DataTypes >::Contact::norm

contact normal, from m1 to m2

Definition at line 65 of file PenalityContactForceField.h.

Referenced by sofa::component::forcefield::PenalityContactForceField< DataTypes >::addContact(), sofa::component::forcefield::PenalityContactForceField< DataTypes >::addDForce(), sofa::component::forcefield::PenalityContactForceField< DataTypes >::addForce(), and sofa::component::forcefield::PenalityContactForceField< DataTypes >::draw().

template<class DataTypes >

Real sofa::component::forcefield::PenalityContactForceField< DataTypes >::Contact::pen

current penetration

Definition at line 70 of file PenalityContactForceField.h.

Referenced by sofa::component::forcefield::PenalityContactForceField< DataTypes >::addContact(), sofa::component::forcefield::PenalityContactForceField< DataTypes >::addDForce(), and sofa::component::forcefield::PenalityContactForceField< DataTypes >::addForce().

---

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

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