artisynth.core.materials

Class SimpleMuscle

java.lang.Object

artisynth.core.materials.MaterialBase

artisynth.core.materials.FemMaterial

artisynth.core.materials.MuscleMaterial

artisynth.core.materials.SimpleMuscle

All Implemented Interfaces:

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

public class SimpleMuscle
extends MuscleMaterial

A muscle material with no passive force that simply adds a constant force proportional to the excitation signal. Used mostly for debugging. Note that a constant force does *not* mean constant stress - as the cross sectional area in the force direction changes, the stress needs to vary as well in order to keep the force constant.

Field Summary

Fields

Modifier and Type	Field and Description
static FieldPropertyList	myProps

Fields inherited from class artisynth.core.materials.MuscleMaterial

DEFAULT_EXCITATION, DEFAULT_REST_DIR

Constructor Summary

Constructors

Constructor and Description
SimpleMuscle()
SimpleMuscle(double maxStress)

Method Summary

Modifier and Type	Method and Description
SimpleMuscle	clone() Returns a clone of this composite property.
double	computeStrainEnergyDensity(DeformedPoint def, Vector3d dir0, double excitation, MaterialStateObject state)
void	computeStressAndTangent(SymmetricMatrix3d sigma, Matrix6d D, DeformedPoint def, Vector3d dir0, double excitation, MaterialStateObject state)
boolean	equals(FemMaterial mat)
FieldPropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
double	getMaxStress()
double	getMaxStress(FemFieldPoint dp)
ScalarFieldComponent	getMaxStressField()
PropertyMode	getMaxStressMode()
boolean	hasSymmetricTangent() Returns true if the tangent matrix for this material is symmetric.
void	scaleDistance(double s) Scales all distance coordinates.
void	scaleMass(double s) Scales all mass units.
void	setMaxStress(double maxStress)
void	setMaxStressField(ScalarFieldComponent func)
void	setMaxStressMode(PropertyMode mode)

Methods inherited from class artisynth.core.materials.MuscleMaterial

computeStrainEnergyDensity, computeStressAndTangent, equals, equals, getExcitation, getRestDir, getRestDir, getRestDirField, getSubClasses, isInvertible, setExcitation, setRestDir, setRestDirField

Methods inherited from class artisynth.core.materials.FemMaterial

cauchyToSecondPKStress, computeDevLeftCauchyGreen, computeDevRightCauchyGreen, computeLeftCauchyGreen, computeRightCauchyGreen, createStateObject, getIncompressibleComponent, hasState, isCorotated, isIncompressible, isLinear, propertyChanged, registerSubclass, secondPKToCauchyStress, writeItems

Methods inherited from class artisynth.core.materials.MaterialBase

advanceState, getProperty, getPropertyHost, getPropertyInfo, hasProperty, isWritable, postscan, scan, setPropertyHost, setPropertyInfo, symmetryOrStateChanged, updateMaterial, write

Methods inherited from class java.lang.Object

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

Field Detail

myProps

public static FieldPropertyList myProps

Constructor Detail

SimpleMuscle

public SimpleMuscle()

SimpleMuscle

public SimpleMuscle(double maxStress)

Method Detail

getAllPropertyInfo

public FieldPropertyList 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 MuscleMaterial

Returns:

static information for all exported properties

setMaxStress

public void setMaxStress(double maxStress)

getMaxStress

public double getMaxStress()

setMaxStressMode

public void setMaxStressMode(PropertyMode mode)

getMaxStressMode

public PropertyMode getMaxStressMode()

getMaxStress

public double getMaxStress(FemFieldPoint dp)

getMaxStressField

public ScalarFieldComponent getMaxStressField()

setMaxStressField

public void setMaxStressField(ScalarFieldComponent func)

computeStressAndTangent

public void computeStressAndTangent(SymmetricMatrix3d sigma,
                                    Matrix6d D,
                                    DeformedPoint def,
                                    Vector3d dir0,
                                    double excitation,
                                    MaterialStateObject state)

Specified by:

computeStressAndTangent in class MuscleMaterial

computeStrainEnergyDensity

public double computeStrainEnergyDensity(DeformedPoint def,
                                         Vector3d dir0,
                                         double excitation,
                                         MaterialStateObject state)

Specified by:

computeStrainEnergyDensity in class MuscleMaterial

hasSymmetricTangent

public boolean hasSymmetricTangent()

Description copied from class: MaterialBase

Returns true if the tangent matrix for this material is symmetric. While this is normally true, some special materials (such as those whose stress is not derived from a conservative energy funtion) may have a non-symmetric tangent, in which case this function should be overridden to return false.

Overrides:

hasSymmetricTangent in class MaterialBase

Returns:

true if the tangent matrix for this material is symmetric.

equals

public boolean equals(FemMaterial mat)

Overrides:

equals in class FemMaterial

clone

public SimpleMuscle 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 MuscleMaterial

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