artisynth.core.materials

Class SimpleAxialMuscle

java.lang.Object

artisynth.core.materials.MaterialBase

artisynth.core.materials.AxialMaterial

artisynth.core.materials.LinearAxialMaterial

artisynth.core.materials.SimpleAxialMuscle

All Implemented Interfaces:

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

public class SimpleAxialMuscle
extends LinearAxialMaterial

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyList	myProps

Constructor Summary

Constructors

Constructor and Description
SimpleAxialMuscle()
SimpleAxialMuscle(double stiffness, double damping, double fmax)

Method Summary

Modifier and Type	Method and Description
SimpleAxialMuscle	clone() Returns a clone of this composite property.
double	computeDFdl(double l, double ldot, double l0, double ex) 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 ex) 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	getMaxForce()
PropertyMode	getMaxForceMode()
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	setMaxForce(double max)
void	setMaxForceMode(PropertyMode mode)

Methods inherited from class artisynth.core.materials.LinearAxialMaterial

getDamping, getDampingMode, getStiffness, getStiffnessMode, setDamping, setDampingMode, setStiffness, setStiffnessMode

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

SimpleAxialMuscle

public SimpleAxialMuscle()

SimpleAxialMuscle

public SimpleAxialMuscle(double stiffness,
                         double damping,
                         double fmax)

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 LinearAxialMaterial

Returns:

static information for all exported properties

getMaxForce

public double getMaxForce()

setMaxForce

public void setMaxForce(double max)

getMaxForceMode

public PropertyMode getMaxForceMode()

setMaxForceMode

public void setMaxForceMode(PropertyMode mode)

computeF

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

Description copied from class: AxialMaterial

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

Overrides:

computeF in class LinearAxialMaterial

Parameters:

l - spring length

ldot - spring length time derivative

l0 - spring rest length

ex - excitation value (varying from 0 to 1)

Returns:

spring tension

computeDFdl

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

Description copied from class: AxialMaterial

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

Overrides:

computeDFdl in class LinearAxialMaterial

Parameters:

l - spring length

ldot - spring length time derivative

l0 - spring rest length

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

Overrides:

computeDFdldot in class LinearAxialMaterial

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.

Overrides:

isDFdldotZero in class LinearAxialMaterial

equals

public boolean equals(AxialMaterial mat)

Overrides:

equals in class LinearAxialMaterial

clone

public SimpleAxialMuscle 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 LinearAxialMaterial

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 LinearAxialMaterial

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 LinearAxialMaterial

Parameters:

s - scaling factor