artisynth.core.materials

Class SimmSplineLigamentMaterial

java.lang.Object

artisynth.core.materials.MaterialBase

artisynth.core.materials.AxialMaterial

artisynth.core.materials.SimmSplineLigamentMaterial

All Implemented Interfaces:

HasMaterialState, PostScannable, ScalableUnits, java.lang.Cloneable, CompositeProperty, HasProperties, Clonable, Scannable

public class SimmSplineLigamentMaterial
extends AxialMaterial

Field Summary

Fields inherited from class artisynth.core.materials.MaterialBase

myProps

Constructor Summary

Constructors

Constructor and Description
SimmSplineLigamentMaterial(double[] x, double[] y, double mag) Create a new ligament material.

Method Summary

Modifier and Type	Method and Description
double	computeDFdl(double l, double ldot, double l0, double excitation) Computes and returns the derivative of the axial spring tension with respect to the length.
double	computeDFdldot(double l, double ldot, double l0, double excitation) Computes and returns the derivative of the axial spring tension with respect to the length time derivative.
double	computeF(double l, double ldot, double l0, double excitation) Computes and returns the axial spring tension, as a function of length, length time derivative, rest length, and excitation.
boolean	isDFdldotZero() Returns true if computeDFdldot() always returns zero.

Methods inherited from class artisynth.core.materials.AxialMaterial

clone, equals, equals, getSubClasses

Methods inherited from class artisynth.core.materials.MaterialBase

advanceState, createStateObject, getAllPropertyInfo, getProperty, getPropertyHost, getPropertyInfo, hasProperty, hasState, hasSymmetricTangent, isWritable, postscan, scaleDistance, scaleMass, scan, setPropertyHost, setPropertyInfo, symmetryOrStateChanged, updateMaterial, write, writeItems

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimmSplineLigamentMaterial

public SimmSplineLigamentMaterial(double[] x,
                                  double[] y,
                                  double mag)

Create a new ligament material. x and y must have the same number of elements (no less than 4).

Parameters:

x - array of lengths

y - array of forces

mag - multiplier for the forces

Method Detail

computeF

public double computeF(double l,
                       double ldot,
                       double l0,
                       double excitation)

Description copied from class: AxialMaterial

Computes and returns the axial spring tension, as a function of length, length time derivative, rest length, and excitation.

Specified by:

computeF in class AxialMaterial

Parameters:

l - spring length

ldot - spring length time derivative

l0 - spring rest length

excitation - excitation value (varying from 0 to 1)

Returns:

spring tension

computeDFdl

public double computeDFdl(double l,
                          double ldot,
                          double l0,
                          double excitation)

Description copied from class: AxialMaterial

Computes and returns the derivative of the axial spring tension with respect to the length.

Specified by:

computeDFdl in class AxialMaterial

Parameters:

l - spring length

ldot - spring length time derivative

l0 - spring rest length

excitation - excitation value (varying from 0 to 1)

Returns:

tension derivative with respect to length

computeDFdldot

public double computeDFdldot(double l,
                             double ldot,
                             double l0,
                             double excitation)

Description copied from class: AxialMaterial

Computes and returns the derivative of the axial spring tension with respect to the length time derivative.

Specified by:

computeDFdldot in class AxialMaterial

Parameters:

l - spring length

ldot - spring length time derivative

l0 - spring rest length

excitation - excitation value (varying from 0 to 1)

Returns:

tension derivative with respect to length time derivative

isDFdldotZero

public boolean isDFdldotZero()

Description copied from class: AxialMaterial

Returns true if computeDFdldot() always returns zero. For a linear spring, this simply means the damping is zero. When dFdldot is always 0, then stiffness matrix will be symmetric.

Specified by:

isDFdldotZero in class AxialMaterial