sofa::component::forcefield::BoxStiffSpringForceField< DataTypes > Class Template Reference

Set springs between the particles located inside a given box. More...

#include <BoxStiffSpringForceField.h>

Inheritance diagram for sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >:

[legend]

Collaboration diagram for sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >:

[legend]

Public Types
enum	{ N = Coord::static_size }
typedef StiffSpringForceField < DataTypes >	Inherit
typedef DataTypes::VecCoord	VecCoord
typedef DataTypes::VecDeriv	VecDeriv
typedef DataTypes::Coord	Coord
typedef DataTypes::Deriv	Deriv
typedef Coord::value_type	Real
typedef Inherit::Spring	Spring
typedef core::componentmodel::behavior::MechanicalState < DataTypes >	MechanicalState
typedef defaulttype::Vec< 6, Real >	Vec6
Public Member Functions
	BoxStiffSpringForceField (MechanicalState *object1, MechanicalState *object2, double ks=100.0, double kd=5.0)
	BoxStiffSpringForceField (double ks=100.0, double kd=5.0)
void	bwdInit ()
	Initialization method called at graph modification, during top-down traversal.
void	draw ()
	Render internal data of this object, for debugging purposes.
Data Fields
Data< Vec6 >	box_object1
Data< Vec6 >	box_object2

---

Detailed Description

template<class DataTypes>
class sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >

Set springs between the particles located inside a given box.

Definition at line 47 of file BoxStiffSpringForceField.h.

---

Member Typedef Documentation

template<class DataTypes >

typedef DataTypes::Coord sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::Coord

Reimplemented from sofa::component::forcefield::StiffSpringForceField< DataTypes >.

Definition at line 53 of file BoxStiffSpringForceField.h.

template<class DataTypes >

typedef DataTypes::Deriv sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::Deriv

Reimplemented from sofa::component::forcefield::StiffSpringForceField< DataTypes >.

Definition at line 54 of file BoxStiffSpringForceField.h.

template<class DataTypes >

typedef StiffSpringForceField<DataTypes> sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::Inherit

Reimplemented from sofa::component::forcefield::StiffSpringForceField< DataTypes >.

Definition at line 50 of file BoxStiffSpringForceField.h.

template<class DataTypes >

typedef core::componentmodel::behavior::MechanicalState<DataTypes> sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::MechanicalState

Reimplemented from sofa::component::forcefield::StiffSpringForceField< DataTypes >.

Definition at line 57 of file BoxStiffSpringForceField.h.

template<class DataTypes >

typedef Coord::value_type sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::Real

Reimplemented from sofa::component::forcefield::StiffSpringForceField< DataTypes >.

Definition at line 55 of file BoxStiffSpringForceField.h.

template<class DataTypes >

typedef Inherit::Spring sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::Spring

Reimplemented from sofa::component::forcefield::StiffSpringForceField< DataTypes >.

Definition at line 56 of file BoxStiffSpringForceField.h.

template<class DataTypes >

typedef defaulttype::Vec<6,Real> sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::Vec6

Definition at line 60 of file BoxStiffSpringForceField.h.

template<class DataTypes >

typedef DataTypes::VecCoord sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::VecCoord

Reimplemented from sofa::component::forcefield::StiffSpringForceField< DataTypes >.

Definition at line 51 of file BoxStiffSpringForceField.h.

template<class DataTypes >

typedef DataTypes::VecDeriv sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::VecDeriv

Reimplemented from sofa::component::forcefield::StiffSpringForceField< DataTypes >.

Definition at line 52 of file BoxStiffSpringForceField.h.

---

Member Enumeration Documentation

template<class DataTypes >

anonymous enum

Enumerator:

N

Definition at line 58 of file BoxStiffSpringForceField.h.

---

Constructor & Destructor Documentation

template<class DataTypes >

sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::BoxStiffSpringForceField	(	MechanicalState *	object1,
		MechanicalState *	object2,
		double	ks = 100.0,
		double	kd = 5.0
	)			[inline]

Definition at line 49 of file BoxStiffSpringForceField.inl.

template<class DataTypes >

sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::BoxStiffSpringForceField	(	double	ks = 100.0,
		double	kd = 5.0
	)			[inline]

Definition at line 58 of file BoxStiffSpringForceField.inl.

---

Member Function Documentation

template<class DataTypes >

void sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::bwdInit

(

)

[inline, virtual]

Initialization method called at graph modification, during top-down traversal.

Reimplemented from sofa::core::objectmodel::BaseObject.

Definition at line 66 of file BoxStiffSpringForceField.inl.

References sofa::component::forcefield::SpringForceField< DataTypes >::addSpring(), sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::box_object1, sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::box_object2, sofa::core::objectmodel::BaseObject::bwdInit(), sofa::component::forcefield::SpringForceField< DataTypes >::getDamping(), sofa::core::componentmodel::behavior::MechanicalState< TDataTypes >::getIndicesInSpace(), sofa::core::componentmodel::behavior::MechanicalState< TDataTypes >::getX(), sofa::core::componentmodel::behavior::PairInteractionForceField< DataTypes >::mstate1, and sofa::core::componentmodel::behavior::PairInteractionForceField< DataTypes >::mstate2.

template<class DataTypes >

void sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::draw

(

)

[inline, virtual]

Render internal data of this object, for debugging purposes.

Reimplemented from sofa::component::forcefield::SpringForceField< DataTypes >.

Definition at line 144 of file BoxStiffSpringForceField.inl.

References sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::box_object1, sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::box_object2, sofa::component::forcefield::SpringForceField< DataTypes >::draw(), and sofa::core::objectmodel::BaseObject::getContext().

---

Field Documentation

template<class DataTypes >

Data<Vec6> sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::box_object1

Definition at line 74 of file BoxStiffSpringForceField.h.

Referenced by sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::bwdInit(), and sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::draw().

template<class DataTypes >

Data<Vec6> sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::box_object2

Definition at line 75 of file BoxStiffSpringForceField.h.

Referenced by sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::bwdInit(), and sofa::component::forcefield::BoxStiffSpringForceField< DataTypes >::draw().

---

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

• modules/sofa/component/forcefield/BoxStiffSpringForceField.h
• modules/sofa/component/forcefield/BoxStiffSpringForceField.inl