artisynth.core.materials

Class AxialMaterial

java.lang.Object

artisynth.core.materials.MaterialBase

artisynth.core.materials.AxialMaterial

All Implemented Interfaces:

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

Direct Known Subclasses:

AxialLigament, AxialMuscleMaterialBase, AxialTendonBase, Blankevoort1991AxialLigament, ConstantAxialMaterial, Hill3ElemMuscleRigidTendon, LigamentAxialMaterial, LinearAxialMaterial, MaxwellAxialMaterial, SimmSplineLigamentMaterial, UWLigamentMaterial

public abstract class AxialMaterial
extends MaterialBase

Field Summary

Fields inherited from class artisynth.core.materials.MaterialBase

myProps

Constructor Summary

Constructors

Constructor and Description
AxialMaterial()

Method Summary

Modifier and Type	Method and Description
AxialMaterial	clone() Returns a clone of this composite property.
abstract 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.
abstract 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.
abstract 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)
boolean	equals(java.lang.Object obj)
static java.lang.Class<?>[]	getSubClasses()
abstract boolean	isDFdldotZero() Returns true if computeDFdldot() always returns zero.

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

AxialMaterial

public AxialMaterial()

Method Detail

getSubClasses

public static java.lang.Class<?>[] getSubClasses()

computeF

public abstract 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.

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 abstract 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.

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 abstract 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.

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 abstract boolean isDFdldotZero()

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.

equals

public boolean equals(AxialMaterial mat)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

clone

public AxialMaterial 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 MaterialBase

Returns:

clone of this property