SOFA API  1a4bb3e7
Open source framework for multi-physics simuation
sofa::component::solidmechanics::spring::FrameSpringForceField< DataTypes >::Spring Class Reference

#include <FrameSpringForceField.h>

Public Attributes

int m1
 
int m2
 
VecN vec1
 the two extremities of the spring: masses m1 and m2 ( indexes of the DOFs) More...
 
VecN vec2
 
Real kd
 
Real stiffnessTrans
 damping factor More...
 
Real stiffnessRot
 stiffness to apply on axis where the translations are free (default 0.0) More...
 

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) More...
 
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)
 

Friends

std::istream & operator>> (std::istream &in, Spring &s)
 
std::ostream & operator<< (std::ostream &out, const Spring &s)
 

Attribute details

◆ kd

◆ m1

template<class DataTypes >
int sofa::component::solidmechanics::spring::FrameSpringForceField< DataTypes >::Spring::m1

◆ m2

template<class DataTypes >
int sofa::component::solidmechanics::spring::FrameSpringForceField< DataTypes >::Spring::m2

◆ stiffnessRot

template<class DataTypes >
Real sofa::component::solidmechanics::spring::FrameSpringForceField< DataTypes >::Spring::stiffnessRot

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

◆ stiffnessTrans

template<class DataTypes >
Real sofa::component::solidmechanics::spring::FrameSpringForceField< DataTypes >::Spring::stiffnessTrans

damping factor

◆ vec1

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

◆ vec2

Constructor details

◆ Spring()

template<class DataTypes >
sofa::component::solidmechanics::spring::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

Function details

◆ getInitVec1()

template<class DataTypes >
VecN sofa::component::solidmechanics::spring::FrameSpringForceField< DataTypes >::Spring::getInitVec1 ( )
inline

◆ getStiffnessRotation()

template<class DataTypes >
Real sofa::component::solidmechanics::spring::FrameSpringForceField< DataTypes >::Spring::getStiffnessRotation ( )
inline

◆ getStiffnessTranslation()

template<class DataTypes >
Real sofa::component::solidmechanics::spring::FrameSpringForceField< DataTypes >::Spring::getStiffnessTranslation ( )
inline

◆ setDamping()

template<class DataTypes >
void sofa::component::solidmechanics::spring::FrameSpringForceField< DataTypes >::Spring::setDamping ( Real  _kd)
inline

◆ setInitVec1()

template<class DataTypes >
void sofa::component::solidmechanics::spring::FrameSpringForceField< DataTypes >::Spring::setInitVec1 ( const VecN l)
inline

◆ setInitVec2()

template<class DataTypes >
void sofa::component::solidmechanics::spring::FrameSpringForceField< DataTypes >::Spring::setInitVec2 ( const VecN l)
inline

◆ setStiffnessRotation()

template<class DataTypes >
void sofa::component::solidmechanics::spring::FrameSpringForceField< DataTypes >::Spring::setStiffnessRotation ( Real  ksr)
inline

◆ setStiffnessTranslation()

template<class DataTypes >
void sofa::component::solidmechanics::spring::FrameSpringForceField< DataTypes >::Spring::setStiffnessTranslation ( Real  kst)
inline

Related details

◆ operator<<

template<class DataTypes >
std::ostream& operator<< ( std::ostream &  out,
const Spring s 
)
friend

◆ operator>>

template<class DataTypes >
std::istream& operator>> ( std::istream &  in,
Spring s 
)
friend