artisynth.core.materials

Class AxialMuscleMaterial

java.lang.Object

artisynth.core.materials.MaterialBase

artisynth.core.materials.AxialMaterial

artisynth.core.materials.AxialMuscleMaterialBase

artisynth.core.materials.AxialMuscleMaterial

All Implemented Interfaces:

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

Direct Known Subclasses:

BlemkerAxialMuscle, ConstantAxialMuscle, LinearAxialMuscle, MasoudMillardLAM, PaiAxialMuscle, PeckAxialMuscle

public abstract class AxialMuscleMaterial
extends AxialMuscleMaterialBase

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_DAMPING
static double	DEFAULT_MAX_FORCE
static double	DEFAULT_MAX_LENGTH
static double	DEFAULT_OPT_LENGTH
static double	DEFAULT_PASSIVE_FRACTION
static double	DEFAULT_SCALING
static double	DEFAULT_TENDON_RATIO
static double	maxStretch
static double	minStretch
static PropertyList	myProps

Constructor Summary

Constructors

Constructor and Description
AxialMuscleMaterial()

Method Summary

Modifier and Type	Method and Description
AxialMuscleMaterial	clone() Returns a clone of this composite property.
boolean	equals(AxialMaterial mat)
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
double	getDamping()
PropertyMode	getDampingMode()
double	getForceScaling()
PropertyMode	getForceScalingMode()
double	getMaxForce()
PropertyMode	getMaxForceMode()
double	getMaxLength()
PropertyMode	getMaxLengthMode()
double	getOptLength()
PropertyMode	getOptLengthMode()
double	getPassiveFraction()
PropertyMode	getPassiveFractionMode()
static java.lang.Class<?>[]	getSubClasses()
double	getTendonRatio()
PropertyMode	getTendonRatioMode()
boolean	normalizeForceScaling() Folds the forceScaling term into the maxForce and damping terms, and then sets the forceScaling to 1.
void	scaleDistance(double s) Scales all distance coordinates.
void	scaleMass(double s) Scales all mass units.
void	setAxialMuscleMaterialProps(double fmax, double lopt, double lmax, double pfrac, double tratio, double damping, double forceScaling)
void	setDamping(double d)
void	setDampingMode(PropertyMode mode)
void	setForceScaling(double fScaling)
void	setForceScalingMode(PropertyMode mode)
void	setMaxForce(double fmax)
void	setMaxForceMode(PropertyMode mode)
void	setMaxLength(double lmax)
void	setMaxLengthMode(PropertyMode mode)
void	setOptLength(double lopt)
void	setOptLengthMode(PropertyMode mode)
void	setPassiveFraction(double pfrac)
void	setPassiveFractionMode(PropertyMode mode)
void	setTendonRatio(double tratio)
void	setTendonRatioMode(PropertyMode mode)
java.lang.String	toString(java.lang.String fmtStr) Creates a string showing the seven primary properties of this muscle material.

Methods inherited from class artisynth.core.materials.AxialMaterial

computeDFdl, computeDFdldot, computeF, equals, isDFdldotZero

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

DEFAULT_MAX_FORCE

public static double DEFAULT_MAX_FORCE

DEFAULT_OPT_LENGTH

public static double DEFAULT_OPT_LENGTH

DEFAULT_MAX_LENGTH

public static double DEFAULT_MAX_LENGTH

DEFAULT_PASSIVE_FRACTION

public static double DEFAULT_PASSIVE_FRACTION

DEFAULT_TENDON_RATIO

public static double DEFAULT_TENDON_RATIO

DEFAULT_DAMPING

public static double DEFAULT_DAMPING

DEFAULT_SCALING

public static double DEFAULT_SCALING

maxStretch

public static final double maxStretch

See Also:

Constant Field Values

minStretch

public static final double minStretch

See Also:

Constant Field Values

myProps

public static PropertyList myProps

Constructor Detail

AxialMuscleMaterial

public AxialMuscleMaterial()

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

getMaxForce

public double getMaxForce()

setMaxForce

public void setMaxForce(double fmax)

getMaxForceMode

public PropertyMode getMaxForceMode()

setMaxForceMode

public void setMaxForceMode(PropertyMode mode)

getPassiveFraction

public double getPassiveFraction()

setPassiveFraction

public void setPassiveFraction(double pfrac)

getPassiveFractionMode

public PropertyMode getPassiveFractionMode()

setPassiveFractionMode

public void setPassiveFractionMode(PropertyMode mode)

getOptLength

public double getOptLength()

setOptLength

public void setOptLength(double lopt)

getOptLengthMode

public PropertyMode getOptLengthMode()

setOptLengthMode

public void setOptLengthMode(PropertyMode mode)

getMaxLength

public double getMaxLength()

setMaxLength

public void setMaxLength(double lmax)

getMaxLengthMode

public PropertyMode getMaxLengthMode()

setMaxLengthMode

public void setMaxLengthMode(PropertyMode mode)

getTendonRatio

public double getTendonRatio()

setTendonRatio

public void setTendonRatio(double tratio)

getTendonRatioMode

public PropertyMode getTendonRatioMode()

setTendonRatioMode

public void setTendonRatioMode(PropertyMode mode)

getForceScaling

public double getForceScaling()

setForceScaling

public void setForceScaling(double fScaling)

getForceScalingMode

public PropertyMode getForceScalingMode()

setForceScalingMode

public void setForceScalingMode(PropertyMode mode)

getDamping

public double getDamping()

setDamping

public void setDamping(double d)

getDampingMode

public PropertyMode getDampingMode()

setDampingMode

public void setDampingMode(PropertyMode mode)

setAxialMuscleMaterialProps

public void setAxialMuscleMaterialProps(double fmax,
                                        double lopt,
                                        double lmax,
                                        double pfrac,
                                        double tratio,
                                        double damping,
                                        double forceScaling)

equals

public boolean equals(AxialMaterial mat)

Overrides:

equals in class AxialMaterial

clone

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

getSubClasses

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

normalizeForceScaling

public boolean normalizeForceScaling()

Folds the forceScaling term into the maxForce and damping terms, and then sets the forceScaling to 1. For use in removing the use of the forceScaling term.

toString

public java.lang.String toString(java.lang.String fmtStr)

Creates a string showing the seven primary properties of this muscle material. Used for diagnostics and testing.