SOFA API  3ea83cbd
Open source framework for multi-physics simuation
sofa::component::solidmechanics::spring Namespace Reference

Classes

class  AngularSpringForceField
 This class describes a simple elastic springs ForceField between DOFs positions and rest positions. More...
 
class  FastTriangularBendingSprings
 
class  FrameSpringForceFieldInternalData
 
class  FrameSpringForceField
 
class  GearSpring
 
class  GearSpringForceFieldInternalData
 
class  GearSpringForceField
 
class  JointSpring
 JOINTSPRING. More...
 
class  JointSpringForceFieldInternalData
 
class  JointSpringForceField
 
class  LinearSpring
 This class contains the description of one linear spring. More...
 
class  MeshSpringForceField
 
class  PolynomialRestShapeSpringsForceField
 This class describes a polynomial elastic springs ForceField between DOFs positions and rest positions. More...
 
class  PolynomialSpringsForceField
 This class describes a polynomial elastic springs ForceField. More...
 
class  QuadBendingSprings
 
class  QuadularBendingSprings
 
class  RegularGridSpringForceField
 
class  RepulsiveSpringForceField
 
class  RestShapeSpringsForceField
 This class describes a simple elastic springs ForceField between DOFs positions and rest positions. More...
 
class  SpringForceFieldInternalData
 This class can be overridden if needed for additionnal storage within template specializations. More...
 
class  SpringForceField
 Set of simple springs between particles. More...
 
class  StiffSpringForceField
 
class  TriangleBendingSprings
 
class  TriangularBendingSprings
 
class  TriangularBiquadraticSpringsForceField
 
class  TriangularQuadraticSpringsForceField
 
class  VectorSpringForceField
 

Typedefs

typedef core::topology::BaseMeshTopology::EdgesInTriangle EdgesInTriangle
 
typedef core::topology::BaseMeshTopology::Quad Quad
 
typedef core::topology::BaseMeshTopology::EdgesInQuad EdgesInQuad
 
typedef core::topology::BaseMeshTopology::Triangle Triangle
 

Functions

SOFA_EXPORT_DYNAMIC_LIBRARY void initExternalModule ()
 
SOFA_EXPORT_DYNAMIC_LIBRARY const chargetModuleName ()
 
SOFA_EXPORT_DYNAMIC_LIBRARY const chargetModuleVersion ()
 
SOFA_EXPORT_DYNAMIC_LIBRARY const chargetModuleComponentList ()
 
void init ()
 

Variables

int AngularSpringForceFieldClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API AngularSpringForceField< Rigid3Types >
 
int FastTriangularBendingSpringsClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API FastTriangularBendingSprings< Vec3Types >
 
int FrameSpringForceFieldClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API FrameSpringForceField< Rigid3Types >
 
int GearSpringForceFieldClass
 
int JointSpringForceFieldClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API LinearSpring< SReal >
 
int MeshSpringForceFieldClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API MeshSpringForceField< Vec3Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API MeshSpringForceField< Vec2Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API MeshSpringForceField< Vec1Types >
 
int PolynomialRestShapeSpringsForceFieldClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API PolynomialRestShapeSpringsForceField< Vec3Types >
 
int PolynomialSpringsForceFieldClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API PolynomialSpringsForceField< Vec3Types >
 
int QuadBendingSpringsClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API QuadBendingSprings< Vec3Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API QuadBendingSprings< Vec2Types >
 
int QuadularBendingSpringsClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API QuadularBendingSprings< Vec3Types >
 
int RegularGridSpringForceFieldClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API RegularGridSpringForceField< Vec3Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API RegularGridSpringForceField< Vec2Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API RegularGridSpringForceField< Vec1Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API RegularGridSpringForceField< Vec6Types >
 
int RepulsiveSpringForceFieldClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API RepulsiveSpringForceField< Vec3Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API RepulsiveSpringForceField< Vec2Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API RepulsiveSpringForceField< Vec1Types >
 
int RestShapeSpringsForceFieldClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API RestShapeSpringsForceField< Vec3Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API RestShapeSpringsForceField< Vec1Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API RestShapeSpringsForceField< Rigid3Types >
 
int SpringForceFieldClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API SpringForceField< Vec3Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API SpringForceField< Vec2Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API SpringForceField< Vec1Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API SpringForceField< Vec6Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API SpringForceField< Rigid3Types >
 
int StiffSpringForceFieldClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API StiffSpringForceField< Vec3Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API StiffSpringForceField< Vec2Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API StiffSpringForceField< Vec1Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API StiffSpringForceField< Vec6Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API StiffSpringForceField< Rigid3Types >
 
int TriangleBendingSpringsClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API TriangleBendingSprings< Vec3Types >
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API TriangleBendingSprings< Vec2Types >
 
int TriangularBendingSpringsClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API TriangularBendingSprings< Vec3Types >
 
int TriangularBiquadraticSpringsForceFieldClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API TriangularBiquadraticSpringsForceField< Vec3Types >
 
int TriangularQuadraticSpringsForceFieldClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API TriangularQuadraticSpringsForceField< Vec3Types >
 
int VectorSpringForceFieldClass
 
template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API VectorSpringForceField< Vec3Types >
 

Typedef Documentation

◆ EdgesInQuad

◆ EdgesInTriangle

◆ Quad

◆ Triangle

Function Documentation

◆ getModuleComponentList()

const char * sofa::component::solidmechanics::spring::getModuleComponentList ( )

◆ getModuleName()

const char * sofa::component::solidmechanics::spring::getModuleName ( )

◆ getModuleVersion()

const char * sofa::component::solidmechanics::spring::getModuleVersion ( )

◆ init()

SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API void sofa::component::solidmechanics::spring::init ( )

◆ initExternalModule()

void sofa::component::solidmechanics::spring::initExternalModule ( )

Variable Documentation

◆ AngularSpringForceField< Rigid3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::AngularSpringForceField< Rigid3Types >

◆ AngularSpringForceFieldClass

int sofa::component::solidmechanics::spring::AngularSpringForceFieldClass
Initial value:
= core::RegisterObject("Angular springs applied to rotational degrees of freedom of a rigid body or frame")
.add< AngularSpringForceField<Rigid3Types> >()

◆ FastTriangularBendingSprings< Vec3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::FastTriangularBendingSprings< Vec3Types >

◆ FastTriangularBendingSpringsClass

int sofa::component::solidmechanics::spring::FastTriangularBendingSpringsClass
Initial value:
= core::RegisterObject("Springs added to a triangular mesh to prevent bending")
.add< FastTriangularBendingSprings<Vec3Types> >()

◆ FrameSpringForceField< Rigid3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::FrameSpringForceField< Rigid3Types >

◆ FrameSpringForceFieldClass

int sofa::component::solidmechanics::spring::FrameSpringForceFieldClass
Initial value:
= core::RegisterObject ( "Springs for Flexibles" )
.add< FrameSpringForceField<Rigid3Types> >()

◆ GearSpringForceFieldClass

int sofa::component::solidmechanics::spring::GearSpringForceFieldClass
Initial value:
= core::RegisterObject("Gear springs for Rigids")
.add< GearSpringForceField<Rigid3Types> >()

◆ JointSpringForceFieldClass

int sofa::component::solidmechanics::spring::JointSpringForceFieldClass
Initial value:
= core::RegisterObject("Springs for Rigids")
.add< JointSpringForceField<Rigid3Types> >()

◆ LinearSpring< SReal >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::LinearSpring< SReal >
extern

◆ MeshSpringForceField< Vec1Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::MeshSpringForceField< Vec1Types >

◆ MeshSpringForceField< Vec2Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::MeshSpringForceField< Vec2Types >

◆ MeshSpringForceField< Vec3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::MeshSpringForceField< Vec3Types >

◆ MeshSpringForceFieldClass

int sofa::component::solidmechanics::spring::MeshSpringForceFieldClass
Initial value:
= core::RegisterObject("Spring force field acting along the edges of a mesh")
.add< MeshSpringForceField<Vec3Types> >()
.add< MeshSpringForceField<Vec2Types> >()
.add< MeshSpringForceField<Vec1Types> >()

◆ PolynomialRestShapeSpringsForceField< Vec3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::PolynomialRestShapeSpringsForceField< Vec3Types >

◆ PolynomialRestShapeSpringsForceFieldClass

int sofa::component::solidmechanics::spring::PolynomialRestShapeSpringsForceFieldClass
Initial value:
= core::RegisterObject("Simple elastic springs applied to given degrees of freedom between their current and rest shape position")
.add< PolynomialRestShapeSpringsForceField<Vec3Types> >()

◆ PolynomialSpringsForceField< Vec3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::PolynomialSpringsForceField< Vec3Types >

◆ PolynomialSpringsForceFieldClass

int sofa::component::solidmechanics::spring::PolynomialSpringsForceFieldClass
Initial value:
= core::RegisterObject("Simple elastic springs applied to given degrees of freedom between their current and rest shape position")
.add< PolynomialSpringsForceField<Vec3Types> >()

◆ QuadBendingSprings< Vec2Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::QuadBendingSprings< Vec2Types >

◆ QuadBendingSprings< Vec3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::QuadBendingSprings< Vec3Types >

◆ QuadBendingSpringsClass

int sofa::component::solidmechanics::spring::QuadBendingSpringsClass
Initial value:
= core::RegisterObject("Springs added to a quad mesh to prevent bending")
.add< QuadBendingSprings<Vec3Types> >()
.add< QuadBendingSprings<Vec2Types> >()

◆ QuadularBendingSprings< Vec3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::QuadularBendingSprings< Vec3Types >

◆ QuadularBendingSpringsClass

int sofa::component::solidmechanics::spring::QuadularBendingSpringsClass
Initial value:
= core::RegisterObject("Springs added to a quad mesh to prevent bending")
.add< QuadularBendingSprings<Vec3Types> >()

◆ RegularGridSpringForceField< Vec1Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::RegularGridSpringForceField< Vec1Types >

◆ RegularGridSpringForceField< Vec2Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::RegularGridSpringForceField< Vec2Types >

◆ RegularGridSpringForceField< Vec3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::RegularGridSpringForceField< Vec3Types >

◆ RegularGridSpringForceField< Vec6Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::RegularGridSpringForceField< Vec6Types >

◆ RegularGridSpringForceFieldClass

int sofa::component::solidmechanics::spring::RegularGridSpringForceFieldClass
Initial value:
= core::RegisterObject("Spring acting on the edges and faces of a regular grid")
.add< RegularGridSpringForceField<Vec3Types> >(true)
.add< RegularGridSpringForceField<Vec2Types> >()
.add< RegularGridSpringForceField<Vec1Types> >()
.add< RegularGridSpringForceField<Vec6Types> >()

◆ RepulsiveSpringForceField< Vec1Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::RepulsiveSpringForceField< Vec1Types >

◆ RepulsiveSpringForceField< Vec2Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::RepulsiveSpringForceField< Vec2Types >

◆ RepulsiveSpringForceField< Vec3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::RepulsiveSpringForceField< Vec3Types >

◆ RepulsiveSpringForceFieldClass

int sofa::component::solidmechanics::spring::RepulsiveSpringForceFieldClass
Initial value:
= core::RegisterObject("Springs which only repell")
.add< RepulsiveSpringForceField<Vec3Types> >()
.add< RepulsiveSpringForceField<Vec2Types> >()
.add< RepulsiveSpringForceField<Vec1Types> >()

◆ RestShapeSpringsForceField< Rigid3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::RestShapeSpringsForceField< Rigid3Types >

◆ RestShapeSpringsForceField< Vec1Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::RestShapeSpringsForceField< Vec1Types >

◆ RestShapeSpringsForceField< Vec3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::RestShapeSpringsForceField< Vec3Types >

◆ RestShapeSpringsForceFieldClass

int sofa::component::solidmechanics::spring::RestShapeSpringsForceFieldClass
Initial value:
= core::RegisterObject("Elastic springs generating forces on degrees of freedom between their current and rest shape position")
.add< RestShapeSpringsForceField<Vec3Types> >()
.add< RestShapeSpringsForceField<Vec1Types> >()
.add< RestShapeSpringsForceField<Rigid3Types> >()

◆ SpringForceField< Rigid3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::SpringForceField< Rigid3Types >

◆ SpringForceField< Vec1Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::SpringForceField< Vec1Types >

◆ SpringForceField< Vec2Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::SpringForceField< Vec2Types >

◆ SpringForceField< Vec3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::SpringForceField< Vec3Types >

◆ SpringForceField< Vec6Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::SpringForceField< Vec6Types >

◆ SpringForceFieldClass

int sofa::component::solidmechanics::spring::SpringForceFieldClass
Initial value:
= core::RegisterObject("Springs")
.add< SpringForceField<Vec3Types> >()
.add< SpringForceField<Vec2Types> >()
.add< SpringForceField<Vec1Types> >()
.add< SpringForceField<Vec6Types> >()
.add< SpringForceField<Rigid3Types> >()

◆ StiffSpringForceField< Rigid3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::StiffSpringForceField< Rigid3Types >

◆ StiffSpringForceField< Vec1Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::StiffSpringForceField< Vec1Types >

◆ StiffSpringForceField< Vec2Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::StiffSpringForceField< Vec2Types >

◆ StiffSpringForceField< Vec3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::StiffSpringForceField< Vec3Types >

◆ StiffSpringForceField< Vec6Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::StiffSpringForceField< Vec6Types >

◆ StiffSpringForceFieldClass

int sofa::component::solidmechanics::spring::StiffSpringForceFieldClass
Initial value:
= core::RegisterObject("Stiff springs for implicit integration")
.add< StiffSpringForceField<Vec3Types> >()
.add< StiffSpringForceField<Vec2Types> >()
.add< StiffSpringForceField<Vec1Types> >()
.add< StiffSpringForceField<Vec6Types> >()
.add< StiffSpringForceField<Rigid3Types> >()

◆ TriangleBendingSprings< Vec2Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::TriangleBendingSprings< Vec2Types >

◆ TriangleBendingSprings< Vec3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::TriangleBendingSprings< Vec3Types >

◆ TriangleBendingSpringsClass

int sofa::component::solidmechanics::spring::TriangleBendingSpringsClass
Initial value:
= core::RegisterObject("Springs added to a traingular mesh to prevent bending")
.add< TriangleBendingSprings<Vec3Types> >()
.add< TriangleBendingSprings<Vec2Types> >()

◆ TriangularBendingSprings< Vec3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::TriangularBendingSprings< Vec3Types >

◆ TriangularBendingSpringsClass

int sofa::component::solidmechanics::spring::TriangularBendingSpringsClass
Initial value:
= core::RegisterObject("Springs added to a triangular mesh to prevent bending")
.add< TriangularBendingSprings<Vec3Types> >()

◆ TriangularBiquadraticSpringsForceField< Vec3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::TriangularBiquadraticSpringsForceField< Vec3Types >

◆ TriangularBiquadraticSpringsForceFieldClass

int sofa::component::solidmechanics::spring::TriangularBiquadraticSpringsForceFieldClass
Initial value:
= core::RegisterObject("Biquadratic Springs on a Triangular Mesh")
.add< TriangularBiquadraticSpringsForceField<Vec3Types> >()

◆ TriangularQuadraticSpringsForceField< Vec3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::TriangularQuadraticSpringsForceField< Vec3Types >

◆ TriangularQuadraticSpringsForceFieldClass

int sofa::component::solidmechanics::spring::TriangularQuadraticSpringsForceFieldClass
Initial value:
= core::RegisterObject("Quadratic Springs on a Triangular Mesh")
.add< TriangularQuadraticSpringsForceField<Vec3Types> >()

◆ VectorSpringForceField< Vec3Types >

template class SOFA_COMPONENT_SOLIDMECHANICS_SPRING_API sofa::component::solidmechanics::spring::VectorSpringForceField< Vec3Types >

◆ VectorSpringForceFieldClass

int sofa::component::solidmechanics::spring::VectorSpringForceFieldClass
Initial value:
= core::RegisterObject("Spring force field acting along the edges of a mesh")
.add< VectorSpringForceField<Vec3Types> >()