BlemkerAxialMuscle (Artisynth API documentation)

java.lang.Object
- artisynth.core.materials.MaterialBase
- - artisynth.core.materials.AxialMaterial
  - - artisynth.core.materials.AxialMuscleMaterialBase
    - - artisynth.core.materials.AxialMuscleMaterial
      - artisynth.core.materials.BlemkerAxialMuscle

All Implemented Interfaces:

HasMaterialState, PostScannable, ScalableUnits, java.lang.Cloneable, CompositeProperty, HasProperties, Clonable, Scannable
```
public class BlemkerAxialMuscle
extends AxialMuscleMaterial
```
A generic muscle material

Field Summary

Fields
Modifier and Type Field and Description

static PropertyList myProps
- Fields inherited from class artisynth.core.materials.AxialMuscleMaterial
  DEFAULT_DAMPING, DEFAULT_PASSIVE_FRACTION, DEFAULT_SCALING, DEFAULT_TENDON_RATIO, maxStretch, minStretch

Fields
Modifier and Type	Field and Description
`static PropertyList`	`myProps`

Constructor Summary

Constructors
Constructor and Description
`BlemkerAxialMuscle()`
`BlemkerAxialMuscle(double lmax, double optLen, double maxForce, double ecoef, double uncrimp)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BlemkerAxialMuscle`	`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 ex)` 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`	`getExpStressCoeff()`
`PropertyMode`	`getExpStressCoeffMode()`
`double`	`getMaxForce()`
`PropertyMode`	`getMaxForceMode()`
`double`	`getMaxLength()`
`PropertyMode`	`getMaxLengthMode()`
`double`	`getOptLength()`
`PropertyMode`	`getOptLengthMode()`
`double`	`getUncrimpingFactor()`
`PropertyMode`	`getUncrimpingFactorMode()`
`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`	`setExpStressCoeff(double ecoef)`
`void`	`setExpStressCoeffMode(PropertyMode mode)`
`void`	`setMaxForce(double maxForce)`
`void`	`setMaxForceMode(PropertyMode mode)`
`void`	`setMaxLength(double lmax)`
`void`	`setMaxLengthMode(PropertyMode mode)`
`void`	`setOptLength(double lopt)`
`void`	`setOptLengthMode(PropertyMode mode)`
`void`	`setUncrimpingFactor(double uncrimp)`
`void`	`setUncrimpingFactorMode(PropertyMode mode)`
`void`	`writeActiveForceLengthCurve(java.lang.String fileName, double x0, double x1, int npnts, java.lang.String fmtStr)`
`void`	`writeCombinedForceLengthCurve(java.lang.String fileName, double x0, double x1, int npnts, java.lang.String fmtStr)`
`void`	`writePassiveForceLengthCurve(java.lang.String fileName, double x0, double x1, int npnts, java.lang.String fmtStr)`

Methods inherited from class artisynth.core.materials.AxialMuscleMaterial
getDamping, getDampingMode, getForceScaling, getForceScalingMode, getPassiveFraction, getPassiveFractionMode, getSubClasses, getTendonRatio, getTendonRatioMode, normalizeForceScaling, setAxialMuscleMaterialProps, setDamping, setDampingMode, setForceScaling, setForceScalingMode, setPassiveFraction, setPassiveFractionMode, setTendonRatio, setTendonRatioMode, toString

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

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
  - BlemkerAxialMuscle
```
public BlemkerAxialMuscle()
```
  - BlemkerAxialMuscle
```
public BlemkerAxialMuscle(double lmax,
                          double optLen,
                          double maxForce,
                          double ecoef,
                          double uncrimp)
```
- 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 AxialMuscleMaterial
    
    Returns:
    
    static information for all exported properties
  - setMaxLength
```
public void setMaxLength(double lmax)
```
    Overrides:
    
    setMaxLength in class AxialMuscleMaterial
  - getMaxLength
```
public double getMaxLength()
```
    Overrides:
    
    getMaxLength in class AxialMuscleMaterial
  - setMaxLengthMode
```
public void setMaxLengthMode(PropertyMode mode)
```
    Overrides:
    
    setMaxLengthMode in class AxialMuscleMaterial
  - getMaxLengthMode
```
public PropertyMode getMaxLengthMode()
```
    Overrides:
    
    getMaxLengthMode in class AxialMuscleMaterial
  - setOptLength
```
public void setOptLength(double lopt)
```
    Overrides:
    
    setOptLength in class AxialMuscleMaterial
  - getOptLength
```
public double getOptLength()
```
    Overrides:
    
    getOptLength in class AxialMuscleMaterial
  - setOptLengthMode
```
public void setOptLengthMode(PropertyMode mode)
```
    Overrides:
    
    setOptLengthMode in class AxialMuscleMaterial
  - getOptLengthMode
```
public PropertyMode getOptLengthMode()
```
    Overrides:
    
    getOptLengthMode in class AxialMuscleMaterial
  - setMaxForce
```
public void setMaxForce(double maxForce)
```
    Overrides:
    
    setMaxForce in class AxialMuscleMaterial
  - getMaxForce
```
public double getMaxForce()
```
    Overrides:
    
    getMaxForce in class AxialMuscleMaterial
  - setMaxForceMode
```
public void setMaxForceMode(PropertyMode mode)
```
    Overrides:
    
    setMaxForceMode in class AxialMuscleMaterial
  - getMaxForceMode
```
public PropertyMode getMaxForceMode()
```
    Overrides:
    
    getMaxForceMode in class AxialMuscleMaterial
  - setExpStressCoeff
```
public void setExpStressCoeff(double ecoef)
```
  - getExpStressCoeff
```
public double getExpStressCoeff()
```
  - setExpStressCoeffMode
```
public void setExpStressCoeffMode(PropertyMode mode)
```
  - getExpStressCoeffMode
```
public PropertyMode getExpStressCoeffMode()
```
  - setUncrimpingFactor
```
public void setUncrimpingFactor(double uncrimp)
```
  - getUncrimpingFactor
```
public double getUncrimpingFactor()
```
  - setUncrimpingFactorMode
```
public void setUncrimpingFactorMode(PropertyMode mode)
```
  - getUncrimpingFactorMode
```
public PropertyMode getUncrimpingFactorMode()
```
  - 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 ex)
```
    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
    
    ex - 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 AxialMuscleMaterial
  - clone
```
public BlemkerAxialMuscle 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 AxialMuscleMaterial
    
    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 AxialMuscleMaterial
    
    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 AxialMuscleMaterial
    
    Parameters:
    
    s - scaling factor
  - writeActiveForceLengthCurve
```
public void writeActiveForceLengthCurve(java.lang.String fileName,
                                        double x0,
                                        double x1,
                                        int npnts,
                                        java.lang.String fmtStr)
                                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writePassiveForceLengthCurve
```
public void writePassiveForceLengthCurve(java.lang.String fileName,
                                         double x0,
                                         double x1,
                                         int npnts,
                                         java.lang.String fmtStr)
                                  throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writeCombinedForceLengthCurve
```
public void writeCombinedForceLengthCurve(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 BlemkerAxialMuscle

Field Summary

Fields inherited from class artisynth.core.materials.AxialMuscleMaterial

Constructor Summary

Method Summary

Methods inherited from class artisynth.core.materials.AxialMuscleMaterial

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

myProps

Constructor Detail

BlemkerAxialMuscle

BlemkerAxialMuscle

Method Detail

getAllPropertyInfo

setMaxLength

getMaxLength

setMaxLengthMode

getMaxLengthMode

setOptLength

getOptLength

setOptLengthMode

getOptLengthMode

setMaxForce

getMaxForce

setMaxForceMode

getMaxForceMode

setExpStressCoeff

getExpStressCoeff

setExpStressCoeffMode

getExpStressCoeffMode

setUncrimpingFactor

getUncrimpingFactor

setUncrimpingFactorMode

getUncrimpingFactorMode

computeF

computeDFdl

computeDFdldot

isDFdldotZero

equals

clone

scaleDistance

scaleMass

writeActiveForceLengthCurve

writePassiveForceLengthCurve

writeCombinedForceLengthCurve

main