AxialLigament (Artisynth API documentation)

java.lang.Object
- artisynth.core.materials.MaterialBase
- - artisynth.core.materials.AxialMaterial
  - - artisynth.core.materials.AxialLigament

All Implemented Interfaces:

HasMaterialState, PostScannable, ScalableUnits, java.lang.Cloneable, CompositeProperty, HasProperties, Clonable, Scannable
```
public class AxialLigament
extends AxialMaterial
```
Ligmament material based on : Blankevoort, L., and Huiskes, R. (1991). Ligament-bone interaction in a three-dimensional model of the knee. Journal of Biomechanical Engineering, 113(3), 263-269. implementation adapted from UW SimTk plugin: https://simtk.org/home/uwmodels z * Notes: - the restLength property in the associated spring is used as the referenceLength in the UW formulation, where referenceLength is the length of the ligament when the joint is in the reference position (full extension).

Field Summary

Fields
Modifier and Type Field and Description

static double DEFAULT_DAMPING

static double DEFAULT_MAX_FORCE

static double DEFAULT_SLACK_LENGTH

static PropertyList myProps

Fields
Modifier and Type	Field and Description
`static double`	`DEFAULT_DAMPING`
`static double`	`DEFAULT_MAX_FORCE`
`static double`	`DEFAULT_SLACK_LENGTH`
`static PropertyList`	`myProps`

Constructor Summary

Constructors
Constructor and Description
`AxialLigament()`
`AxialLigament(double fmax, double slackLen, double damping)`
`AxialLigament(double fmax, double slackLen, double damping, Diff1Function1x1Base flc)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AxialLigament`	`clone()` Returns a clone of this composite property.
`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`	`equals(AxialMaterial mat)`
`PropertyList`	`getAllPropertyInfo()` Returns a list giving static information about all properties exported by this object.
`double`	`getDamping()`
`Diff1Function1x1`	`getForceLengthCurve()`
`double`	`getMaxForce()`
`double`	`getSlackLength()`
`boolean`	`isDFdldotZero()` Returns true if computeDFdldot() always returns zero.
`static void`	`main(java.lang.String[] args)`
`void`	`scaleDistance(double s)` Scales all distance coordinates.
`void`	`scaleMass(double s)` Scales all mass units.
`void`	`setDamping(double d)`
`void`	`setForceLengthCurve(Diff1Function1x1Base flc)`
`void`	`setMaxForce(double maxForce)`
`void`	`setSlackLength(double sl)`
`void`	`writeForceLengthCurve(java.lang.String fileName, double x0, double x1, int npnts, java.lang.String fmtStr)`
`void`	`writeItems(java.io.PrintWriter pw, NumberFormat fmt, CompositeComponent ancestor)`

Methods inherited from class artisynth.core.materials.AxialMaterial
equals, getSubClasses

Methods inherited from class artisynth.core.materials.MaterialBase
advanceState, createStateObject, getProperty, getPropertyHost, getPropertyInfo, hasProperty, hasState, hasSymmetricTangent, isWritable, postscan, scan, setPropertyHost, setPropertyInfo, symmetryOrStateChanged, updateMaterial, write

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_MAX_FORCE
```
public static double DEFAULT_MAX_FORCE
```
  - DEFAULT_DAMPING
```
public static double DEFAULT_DAMPING
```
  - DEFAULT_SLACK_LENGTH
```
public static double DEFAULT_SLACK_LENGTH
```
  - myProps
```
public static PropertyList myProps
```
- Constructor Detail
  - AxialLigament
```
public AxialLigament()
```
  - AxialLigament
```
public AxialLigament(double fmax,
                     double slackLen,
                     double damping)
```
  - AxialLigament
```
public AxialLigament(double fmax,
                     double slackLen,
                     double damping,
                     Diff1Function1x1Base flc)
```
- Method Detail
  - getAllPropertyInfo
```
public PropertyList getAllPropertyInfo()
```
    Description copied from interface: HasProperties
    
    Returns a list giving static information about all properties exported by this object.
    
    Specified by:
    
    getAllPropertyInfo in interface HasProperties
    
    Overrides:
    
    getAllPropertyInfo in class MaterialBase
    
    Returns:
    
    static information for all exported properties
  - 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
  - getForceLengthCurve
```
public Diff1Function1x1 getForceLengthCurve()
```
  - setForceLengthCurve
```
public void setForceLengthCurve(Diff1Function1x1Base flc)
```
  - getMaxForce
```
public double getMaxForce()
```
  - setMaxForce
```
public void setMaxForce(double maxForce)
```
  - getDamping
```
public double getDamping()
```
  - setDamping
```
public void setDamping(double d)
```
  - getSlackLength
```
public double getSlackLength()
```
  - setSlackLength
```
public void setSlackLength(double sl)
```
  - equals
```
public boolean equals(AxialMaterial mat)
```
    Overrides:
    
    equals in class AxialMaterial
  - clone
```
public AxialLigament clone()
```
    Description copied from interface: CompositeProperty
    
    Returns a clone of this composite property.
    
    Specified by:
    
    clone in interface CompositeProperty
    
    Specified by:
    
    clone in interface Clonable
    
    Overrides:
    
    clone in class AxialMaterial
    
    Returns:
    
    clone of this property
  - scaleDistance
```
public void scaleDistance(double s)
```
    Description copied from interface: ScalableUnits
    
    Scales all distance coordinates.
    
    Specified by:
    
    scaleDistance in interface ScalableUnits
    
    Overrides:
    
    scaleDistance in class MaterialBase
    
    Parameters:
    
    s - scaling factor
  - scaleMass
```
public void scaleMass(double s)
```
    Description copied from interface: ScalableUnits
    
    Scales all mass units.
    
    Specified by:
    
    scaleMass in interface ScalableUnits
    
    Overrides:
    
    scaleMass in class MaterialBase
    
    Parameters:
    
    s - scaling factor
  - writeItems
```
public void writeItems(java.io.PrintWriter pw,
                       NumberFormat fmt,
                       CompositeComponent ancestor)
                throws java.io.IOException
```
    Overrides:
    
    writeItems in class MaterialBase
    
    Throws:
    
    java.io.IOException
  - writeForceLengthCurve
```
public void writeForceLengthCurve(java.lang.String fileName,
                                  double x0,
                                  double x1,
                                  int npnts,
                                  java.lang.String fmtStr)
                           throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - main
```
public static void main(java.lang.String[] args)
                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException

Class AxialLigament

Field Summary

Constructor Summary

Method Summary

Methods inherited from class artisynth.core.materials.AxialMaterial

Methods inherited from class artisynth.core.materials.MaterialBase

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_FORCE

DEFAULT_DAMPING

DEFAULT_SLACK_LENGTH

myProps

Constructor Detail

AxialLigament

AxialLigament

AxialLigament

Method Detail

getAllPropertyInfo

computeF

computeDFdl

computeDFdldot

isDFdldotZero

getForceLengthCurve

setForceLengthCurve

getMaxForce

setMaxForce

getDamping

setDamping

getSlackLength

setSlackLength

equals

clone

scaleDistance

scaleMass

writeItems

writeForceLengthCurve

main