artisynth.core.materials

Class MaxwellAxialMaterial

java.lang.Object

artisynth.core.materials.MaterialBase

artisynth.core.materials.AxialMaterial

artisynth.core.materials.MaxwellAxialMaterial

All Implemented Interfaces:

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

public class MaxwellAxialMaterial
extends AxialMaterial
implements HasNumericState

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyList	myProps

Constructor Summary

Constructors

Constructor and Description
MaxwellAxialMaterial()
MaxwellAxialMaterial(double k, double d, double sprLen)

Method Summary

Modifier and Type	Method and Description
void	advanceState(double t0, double t1) If HasNumericState.requiresAdvance() and HasNumericState.hasState() both return true, then this method is called each time step by the system integrator to update this component's state.
MaxwellAxialMaterial	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 excitation) 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	getDamping()
PropertyMode	getDampingMode()
double	getSpringLength()
void	getState(DataBuffer data) Saves state information for this component by adding data to the supplied DataBuffer.
double	getStiffness()
PropertyMode	getStiffnessMode()
boolean	hasState() Returns true if this component currently holds state.
boolean	isDFdldotZero() Returns true if computeDFdldot() always returns zero.
boolean	requiresAdvance() Returns true if the state of this component must be updated each time step using HasNumericState.advanceState(double, double).
void	scaleDistance(double s) Scales all distance coordinates.
void	scaleMass(double s) Scales all mass units.
void	setDamping(double d)
void	setDampingMode(PropertyMode mode)
void	setSpringLength(double l)
void	setState(DataBuffer data) Restores the state for this component by reading from the supplied data buffer, starting at the current buffer offsets.
void	setStiffness(double E)
void	setStiffnessMode(PropertyMode mode)

Methods inherited from class artisynth.core.materials.AxialMaterial

equals, getSubClasses

Methods inherited from class artisynth.core.materials.MaterialBase

advanceState, createStateObject, getProperty, getPropertyHost, getPropertyInfo, hasProperty, 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

Methods inherited from interface artisynth.core.modelbase.HasNumericState

getAuxVarDerivative, getAuxVarState, getStateVersion, numAuxVars, setAuxVarState

Field Detail

myProps

public static PropertyList myProps

Constructor Detail

MaxwellAxialMaterial

public MaxwellAxialMaterial()

MaxwellAxialMaterial

public MaxwellAxialMaterial(double k,
                            double d,
                            double sprLen)

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 MaterialBase

Returns:

static information for all exported properties

getStiffness

public double getStiffness()

setStiffness

public void setStiffness(double E)

getStiffnessMode

public PropertyMode getStiffnessMode()

setStiffnessMode

public void setStiffnessMode(PropertyMode mode)

getDamping

public double getDamping()

setDamping

public void setDamping(double d)

getDampingMode

public PropertyMode getDampingMode()

setDampingMode

public void setDampingMode(PropertyMode mode)

getSpringLength

public double getSpringLength()

setSpringLength

public void setSpringLength(double l)

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 excitation)

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

excitation - 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 AxialMaterial

clone

public MaxwellAxialMaterial 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 AxialMaterial

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

hasState

public boolean hasState()

Description copied from interface: HasNumericState

Returns true if this component currently holds state. This allows the presence of state to depend on the component's configuration.

Specified by:

hasState in interface HasMaterialState

Specified by:

hasState in interface HasNumericState

Overrides:

hasState in class MaterialBase

Returns:

true if this component holds state

setState

public void setState(DataBuffer data)

Description copied from interface: HasNumericState

Restores the state for this component by reading from the supplied data buffer, starting at the current buffer offsets.

Specified by:

setState in interface HasNumericState

Parameters:

data - buffer containing the state information

getState

public void getState(DataBuffer data)

Description copied from interface: HasNumericState

Saves state information for this component by adding data to the supplied DataBuffer. Existing data in the buffer should not be disturbed.

Specified by:

getState in interface HasNumericState

Parameters:

data - buffer for storing the state values.

advanceState

public void advanceState(double t0,
                         double t1)

Description copied from interface: HasNumericState

If HasNumericState.requiresAdvance() and HasNumericState.hasState() both return true, then this method is called each time step by the system integrator to update this component's state. For single step integrators, the method is called once at the start of the integration, with t0 and t1 set to the step's start and end times. For multi-step integrators (such as Runge Kutta), the method is called for each sub-step, with t0 and t1 set to the sub-step's time bounds. Multi-step integrators will also use HasNumericState.getState(maspack.util.DataBuffer) and HasNumericState.setState(maspack.util.DataBuffer) to save and restore state as required.

Specified by:

advanceState in interface HasNumericState

Parameters:

t0 - beginning time associated with the time step or sub-step

t1 - end time associated with the time step or sub-step

requiresAdvance

public boolean requiresAdvance()

Returns true if the state of this component must be updated each time step using HasNumericState.advanceState(double, double).

Specified by:

requiresAdvance in interface HasNumericState

Returns:

true if advanceState must be called