artisynth.core.materials

Class GenericMuscle

java.lang.Object

artisynth.core.materials.MaterialBase

artisynth.core.materials.FemMaterial

artisynth.core.materials.MuscleMaterial

artisynth.core.materials.GenericMuscle

All Implemented Interfaces:

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

public class GenericMuscle
extends MuscleMaterial

A generic muscle material

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
GenericMuscle()
GenericMuscle(double maxLambda, double maxStress, double expStressCoeff, double uncrimpingFactor)

Method Summary

Modifier and Type	Method and Description
GenericMuscle	clone() Returns a clone of this composite property.
void	computeStressAndTangent(SymmetricMatrix3d sigma, Matrix6d D, DeformedPoint def, Vector3d dir0, double excitation, MaterialStateObject state)
boolean	equals(MuscleMaterial mat)
FieldPropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
double	getExpStressCoeff()
double	getExpStressCoeff(FemFieldPoint dp)
ScalarFieldComponent	getExpStressCoeffField()
PropertyMode	getExpStressCoeffMode()
double	getFibreModulus()
double	getMaxLambda()
double	getMaxLambda(FemFieldPoint dp)
ScalarFieldComponent	getMaxLambdaField()
PropertyMode	getMaxLambdaMode()
double	getMaxStress()
double	getMaxStress(FemFieldPoint dp)
ScalarFieldComponent	getMaxStressField()
PropertyMode	getMaxStressMode()
double	getUncrimpingFactor()
double	getUncrimpingFactor(FemFieldPoint dp)
ScalarFieldComponent	getUncrimpingFactorField()
PropertyMode	getUncrimpingFactorMode()
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	setExpStressCoeff(double coeff)
void	setExpStressCoeffField(ScalarFieldComponent func)
void	setExpStressCoeffMode(PropertyMode mode)
void	setMaxLambda(double maxLambda)
void	setMaxLambdaField(ScalarFieldComponent func)
void	setMaxLambdaMode(PropertyMode mode)
void	setMaxStress(double maxStress)
void	setMaxStressField(ScalarFieldComponent func)
void	setMaxStressMode(PropertyMode mode)
void	setUncrimpingFactor(double factor)
void	setUncrimpingFactorField(ScalarFieldComponent func)
void	setUncrimpingFactorMode(PropertyMode mode)

Methods inherited from class artisynth.core.materials.MuscleMaterial

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

Methods inherited from class artisynth.core.materials.FemMaterial

cauchyToSecondPKStress, computeDevLeftCauchyGreen, computeDevRightCauchyGreen, computeLeftCauchyGreen, computeRightCauchyGreen, createStateObject, equals, 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

GenericMuscle

public GenericMuscle()

GenericMuscle

public GenericMuscle(double maxLambda,
                     double maxStress,
                     double expStressCoeff,
                     double uncrimpingFactor)

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

getFibreModulus

public double getFibreModulus()

setMaxLambda

public void setMaxLambda(double maxLambda)

getMaxLambda

public double getMaxLambda()

setMaxLambdaMode

public void setMaxLambdaMode(PropertyMode mode)

getMaxLambdaMode

public PropertyMode getMaxLambdaMode()

getMaxLambda

public double getMaxLambda(FemFieldPoint dp)

getMaxLambdaField

public ScalarFieldComponent getMaxLambdaField()

setMaxLambdaField

public void setMaxLambdaField(ScalarFieldComponent func)

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)

setExpStressCoeff

public void setExpStressCoeff(double coeff)

getExpStressCoeff

public double getExpStressCoeff()

setExpStressCoeffMode

public void setExpStressCoeffMode(PropertyMode mode)

getExpStressCoeffMode

public PropertyMode getExpStressCoeffMode()

getExpStressCoeff

public double getExpStressCoeff(FemFieldPoint dp)

getExpStressCoeffField

public ScalarFieldComponent getExpStressCoeffField()

setExpStressCoeffField

public void setExpStressCoeffField(ScalarFieldComponent func)

setUncrimpingFactor

public void setUncrimpingFactor(double factor)

getUncrimpingFactor

public double getUncrimpingFactor()

setUncrimpingFactorMode

public void setUncrimpingFactorMode(PropertyMode mode)

getUncrimpingFactorMode

public PropertyMode getUncrimpingFactorMode()

getUncrimpingFactor

public double getUncrimpingFactor(FemFieldPoint dp)

getUncrimpingFactorField

public ScalarFieldComponent getUncrimpingFactorField()

setUncrimpingFactorField

public void setUncrimpingFactorField(ScalarFieldComponent func)

computeStressAndTangent

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

Specified by:

computeStressAndTangent 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(MuscleMaterial mat)

Overrides:

equals in class MuscleMaterial

clone

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