artisynth.core.materials

Class LigamentAxialMaterial

java.lang.Object

artisynth.core.materials.MaterialBase

artisynth.core.materials.AxialMaterial

artisynth.core.materials.LigamentAxialMaterial

All Implemented Interfaces:

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

public class LigamentAxialMaterial
extends AxialMaterial

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyList	myProps

Constructor Summary

Constructors

Constructor and Description
LigamentAxialMaterial()
LigamentAxialMaterial(double kElong, double kComp, double d)

Method Summary

Modifier and Type	Method and Description
LigamentAxialMaterial	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	getCompStiffness()
PropertyMode	getCompStiffnessMode()
double	getDamping()
PropertyMode	getDampingMode()
double	getElongStiffness()
PropertyMode	getElongStiffnessMode()
double	getL0variationPerc()
boolean	isDFdldotZero() Returns true if computeDFdldot() always returns zero.
void	scaleDistance(double s) Scales all distance coordinates.
void	scaleMass(double s) Scales all mass units.
void	setCompStiffness(double E)
void	setCompStiffnessMode(PropertyMode mode)
void	setDamping(double d)
void	setDampingMode(PropertyMode mode)
void	setElongStiffness(double E)
void	setElongStiffnessMode(PropertyMode mode)
void	setL0variationPerc(double wPerc)

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, writeItems

Methods inherited from class java.lang.Object

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

Field Detail

myProps

public static PropertyList myProps

Constructor Detail

LigamentAxialMaterial

public LigamentAxialMaterial()

LigamentAxialMaterial

public LigamentAxialMaterial(double kElong,
                             double kComp,
                             double d)

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

getElongStiffness

public double getElongStiffness()

setElongStiffness

public void setElongStiffness(double E)

getElongStiffnessMode

public PropertyMode getElongStiffnessMode()

setElongStiffnessMode

public void setElongStiffnessMode(PropertyMode mode)

getCompStiffness

public double getCompStiffness()

setCompStiffness

public void setCompStiffness(double E)

getCompStiffnessMode

public PropertyMode getCompStiffnessMode()

setCompStiffnessMode

public void setCompStiffnessMode(PropertyMode mode)

getL0variationPerc

public double getL0variationPerc()

setL0variationPerc

public void setL0variationPerc(double wPerc)

getDamping

public double getDamping()

setDamping

public void setDamping(double d)

getDampingMode

public PropertyMode getDampingMode()

setDampingMode

public void setDampingMode(PropertyMode mode)

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

equals

public boolean equals(AxialMaterial mat)

Overrides:

equals in class AxialMaterial

clone

public LigamentAxialMaterial 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