artisynth.core.materials

Class MuscleMaterial

java.lang.Object

artisynth.core.materials.MaterialBase

artisynth.core.materials.FemMaterial

artisynth.core.materials.MuscleMaterial

All Implemented Interfaces:

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

Direct Known Subclasses:

BlemkerMuscle, FullBlemkerMuscle, GenericMuscle, InactiveMuscle, SimpleForceMuscle, SimpleMuscle

public abstract class MuscleMaterial
extends FemMaterial

Base class for Muscle materials. These are similiar to regular materials, except that they add to the stress and tangent term, and the associated methods also accept an excitation and a direction.

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_EXCITATION
static Vector3d	DEFAULT_REST_DIR
static FieldPropertyList	myProps

Constructor Summary

Constructors

Constructor and Description
MuscleMaterial()

Method Summary

Modifier and Type	Method and Description
MuscleMaterial	clone() Returns a clone of this composite property.
double	computeStrainEnergyDensity(DeformedPoint def, Matrix3d Q, double excitation, MaterialStateObject state) Computes the current strain energy density.
abstract double	computeStrainEnergyDensity(DeformedPoint def, Vector3d dir0, double excitation, MaterialStateObject state)
void	computeStressAndTangent(SymmetricMatrix3d sigma, Matrix6d D, DeformedPoint def, Matrix3d Q, double excitation, MaterialStateObject state) Computes the current Cauchy stress and tangent stiffness matrix.
abstract void	computeStressAndTangent(SymmetricMatrix3d sigma, Matrix6d D, DeformedPoint def, Vector3d dir, double excitation, MaterialStateObject state)
boolean	equals(MuscleMaterial mat)
boolean	equals(java.lang.Object obj)
FieldPropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
double	getExcitation()
Vector3d	getRestDir()
Vector3d	getRestDir(FemFieldPoint dp)
VectorFieldComponent<Vector3d>	getRestDirField()
static java.lang.Class<?>[]	getSubClasses()
boolean	isInvertible() Returns true if this material is defined for a deformation gradient with a non-positive determinant.
void	setExcitation(double ex)
void	setRestDir(Vector3d dir)
void	setRestDirField(VectorFieldComponent<Vector3d> field)

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, hasSymmetricTangent, isWritable, postscan, scaleDistance, scaleMass, scan, setPropertyHost, setPropertyInfo, symmetryOrStateChanged, updateMaterial, write

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXCITATION

public static double DEFAULT_EXCITATION

DEFAULT_REST_DIR

public static Vector3d DEFAULT_REST_DIR

myProps

public static FieldPropertyList myProps

Constructor Detail

MuscleMaterial

public MuscleMaterial()

Method Detail

getSubClasses

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

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 FemMaterial

Returns:

static information for all exported properties

getExcitation

public double getExcitation()

setExcitation

public void setExcitation(double ex)

getRestDir

public Vector3d getRestDir()

setRestDir

public void setRestDir(Vector3d dir)

getRestDir

public Vector3d getRestDir(FemFieldPoint dp)

getRestDirField

public VectorFieldComponent<Vector3d> getRestDirField()

setRestDirField

public void setRestDirField(VectorFieldComponent<Vector3d> field)

computeStressAndTangent

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

Description copied from class: FemMaterial

Computes the current Cauchy stress and tangent stiffness matrix.

Specified by:

computeStressAndTangent in class FemMaterial

Parameters:

sigma - returns the Cauchy stress

D - optional; if non-null, returns the tangent matrix

def - deformation information, including deformation gradient and pressure

Q - coordinate frame specifying directions of anisotropy

excitation - current excitation value

state - material state information, or null if the material does not have state.

computeStrainEnergyDensity

public double computeStrainEnergyDensity(DeformedPoint def,
                                         Matrix3d Q,
                                         double excitation,
                                         MaterialStateObject state)

Description copied from class: FemMaterial

Computes the current strain energy density.

Specified by:

computeStrainEnergyDensity in class FemMaterial

Parameters:

def - deformation information, including deformation gradient and pressure

Q - coordinate frame specifying directions of anisotropy

excitation - current excitation value

state - material state information, or null if the material does not have state.

Returns:

strain energy density

computeStressAndTangent

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

computeStrainEnergyDensity

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

equals

public boolean equals(MuscleMaterial mat)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

clone

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

Returns:

clone of this property

isInvertible

public boolean isInvertible()

Returns true if this material is defined for a deformation gradient with a non-positive determinant.

Overrides:

isInvertible in class FemMaterial