artisynth.core.materials

Class FullBlemkerMuscle

java.lang.Object

artisynth.core.materials.MaterialBase

artisynth.core.materials.FemMaterial

artisynth.core.materials.MuscleMaterial

artisynth.core.materials.FullBlemkerMuscle

All Implemented Interfaces:

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

public class FullBlemkerMuscle
extends MuscleMaterial

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
FullBlemkerMuscle() Creates a new FullBlemkerMuscle with default parameter values.
FullBlemkerMuscle(double maxLam, double optLam, double maxStress, double expStress, double uncrimp, double g1, double g2) Creates a new FullBlemkerMuscle with the specified material parameters.

Method Summary

Modifier and Type	Method and Description
FullBlemkerMuscle	clone() Returns a clone of this composite property.
void	computeDevLeftCauchyGreen(SymmetricMatrix3d BD, DeformedPoint def) Computes the left deviatoric Cauchy-Green tensor from the deformation gradient.
double	computeStrainEnergyDensity(DeformedPoint def, Vector3d dir0, double excitation, MaterialStateObject state)
void	computeStressAndTangent(SymmetricMatrix3d sigma, Matrix6d D, DeformedPoint def, Vector3d dir0, double excitation, MaterialStateObject state)
double	computeStretch(Vector3d dir0, DeformedPoint def)
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	getG1()
double	getG1(FemFieldPoint dp)
ScalarFieldComponent	getG1Field()
PropertyMode	getG1Mode()
double	getG2()
double	getG2(FemFieldPoint dp)
ScalarFieldComponent	getG2Field()
PropertyMode	getG2Mode()
double	getMaxLambda()
double	getMaxLambda(FemFieldPoint dp)
ScalarFieldComponent	getMaxLambdaField()
PropertyMode	getMaxLambdaMode()
double	getMaxStress()
double	getMaxStress(FemFieldPoint dp)
ScalarFieldComponent	getMaxStressField()
PropertyMode	getMaxStressMode()
double	getOptLambda()
double	getOptLambda(FemFieldPoint dp)
ScalarFieldComponent	getOptLambdaField()
PropertyMode	getOptLambdaMode()
double	getUncrimpingFactor()
double	getUncrimpingFactor(FemFieldPoint dp)
ScalarFieldComponent	getUncrimpingFactorField()
PropertyMode	getUncrimpingFactorMode()
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	setG1(double G1)
void	setG1Field(ScalarFieldComponent func)
void	setG1Mode(PropertyMode mode)
void	setG2(double G2)
void	setG2Field(ScalarFieldComponent func)
void	setG2Mode(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	setOptLambda(double optLambda)
void	setOptLambdaField(ScalarFieldComponent func)
void	setOptLambdaMode(PropertyMode mode)
void	setUncrimpingFactor(double factor)
void	setUncrimpingFactorField(ScalarFieldComponent func)
void	setUncrimpingFactorMode(PropertyMode mode)

Methods inherited from class artisynth.core.materials.MuscleMaterial

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

Methods inherited from class artisynth.core.materials.FemMaterial

cauchyToSecondPKStress, 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, hasSymmetricTangent, 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

FullBlemkerMuscle

public FullBlemkerMuscle()

Creates a new FullBlemkerMuscle with default parameter values.

FullBlemkerMuscle

public FullBlemkerMuscle(double maxLam,
                         double optLam,
                         double maxStress,
                         double expStress,
                         double uncrimp,
                         double g1,
                         double g2)

Creates a new FullBlemkerMuscle with the specified material parameters.

Parameters:

maxLam - maximum stretch ratio at which active force is generated

optLam - optimal fibre stretch ratio

maxStress - maximum isometric stress

expStress - exponential stress coefficient (P1)

uncrimp - uncrimping factor (P2)

g1 - passive along-fibre shear modulus G1

g2 - passive cross-fibre shear modulus G2

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

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)

setOptLambda

public void setOptLambda(double optLambda)

getOptLambda

public double getOptLambda()

setOptLambdaMode

public void setOptLambdaMode(PropertyMode mode)

getOptLambdaMode

public PropertyMode getOptLambdaMode()

getOptLambda

public double getOptLambda(FemFieldPoint dp)

getOptLambdaField

public ScalarFieldComponent getOptLambdaField()

setOptLambdaField

public void setOptLambdaField(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)

getExpStressCoeff

public double getExpStressCoeff(FemFieldPoint dp)

getExpStressCoeffField

public ScalarFieldComponent getExpStressCoeffField()

setExpStressCoeffField

public void setExpStressCoeffField(ScalarFieldComponent func)

getExpStressCoeffMode

public PropertyMode getExpStressCoeffMode()

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)

setG1

public void setG1(double G1)

getG1

public double getG1()

setG1Mode

public void setG1Mode(PropertyMode mode)

getG1Mode

public PropertyMode getG1Mode()

getG1

public double getG1(FemFieldPoint dp)

getG1Field

public ScalarFieldComponent getG1Field()

setG1Field

public void setG1Field(ScalarFieldComponent func)

setG2

public void setG2(double G2)

getG2

public double getG2()

setG2Mode

public void setG2Mode(PropertyMode mode)

getG2Mode

public PropertyMode getG2Mode()

getG2

public double getG2(FemFieldPoint dp)

getG2Field

public ScalarFieldComponent getG2Field()

setG2Field

public void setG2Field(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

computeStretch

public double computeStretch(Vector3d dir0,
                             DeformedPoint def)

equals

public boolean equals(MuscleMaterial mat)

Overrides:

equals in class MuscleMaterial

clone

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

computeDevLeftCauchyGreen

public void computeDevLeftCauchyGreen(SymmetricMatrix3d BD,
                                      DeformedPoint def)

Computes the left deviatoric Cauchy-Green tensor from the deformation gradient.

Overrides:

computeDevLeftCauchyGreen in class FemMaterial