FungMaterial (Artisynth API documentation)

java.lang.Object
- artisynth.core.materials.MaterialBase
- - artisynth.core.materials.FemMaterial
  - - artisynth.core.materials.IncompressibleMaterialBase
    - - artisynth.core.materials.FungMaterial

All Implemented Interfaces:

HasMaterialState, PostScannable, PropertyChangeListener, ScalableUnits, java.lang.Cloneable, CompositeProperty, HasProperties, Clonable, Scannable
```
public class FungMaterial
extends IncompressibleMaterialBase
```

Nested Class Summary
- Nested classes/interfaces inherited from class artisynth.core.materials.IncompressibleMaterialBase
  IncompressibleMaterialBase.BulkPotential

Field Summary

Fields
Modifier and Type Field and Description

static FieldPropertyList myProps
- Fields inherited from class artisynth.core.materials.IncompressibleMaterialBase
  DEFAULT_BULK_MODULUS, DEFAULT_BULK_POTENTIAL

Fields
Modifier and Type	Field and Description
`static FieldPropertyList`	`myProps`

Constructor Summary

Constructors
Constructor and Description
`FungMaterial()`
`FungMaterial(double MU1, double MU2, double MU3, double L11, double L22, double L33, double L12, double L23, double L31, double CC, double kappa)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addTensorProduct4(Matrix6d c, double s, Matrix3dBase A, Matrix3dBase B)`
`FungMaterial`	`clone()` Returns a clone of this composite property.
`void`	`computeDevStressAndTangent(SymmetricMatrix3d sigma, Matrix6d D, DeformedPoint def, Matrix3d Q, double excitation, MaterialStateObject state)`
`static Matrix6d`	`ddots(Matrix6d a, Matrix6d b)`
`boolean`	`equals(FemMaterial mat)`
`FieldPropertyList`	`getAllPropertyInfo()` Returns a list giving static information about all properties exported by this object.
`double`	`getCC()`
`double`	`getCC(FemFieldPoint dp)`
`ScalarFieldComponent`	`getCCField()`
`PropertyMode`	`getCCMode()`
`double`	`getL11()`
`double`	`getL11(FemFieldPoint dp)`
`ScalarFieldComponent`	`getL11Field()`
`PropertyMode`	`getL11Mode()`
`double`	`getL12()`
`double`	`getL12(FemFieldPoint dp)`
`ScalarFieldComponent`	`getL12Field()`
`PropertyMode`	`getL12Mode()`
`double`	`getL22()`
`double`	`getL22(FemFieldPoint dp)`
`ScalarFieldComponent`	`getL22Field()`
`PropertyMode`	`getL22Mode()`
`double`	`getL23()`
`double`	`getL23(FemFieldPoint dp)`
`ScalarFieldComponent`	`getL23Field()`
`PropertyMode`	`getL23Mode()`
`double`	`getL31()`
`double`	`getL31(FemFieldPoint dp)`
`ScalarFieldComponent`	`getL31Field()`
`PropertyMode`	`getL31Mode()`
`double`	`getL33()`
`double`	`getL33(FemFieldPoint dp)`
`ScalarFieldComponent`	`getL33Field()`
`PropertyMode`	`getL33Mode()`
`double`	`getMU1()`
`double`	`getMU1(FemFieldPoint dp)`
`ScalarFieldComponent`	`getMU1Field()`
`PropertyMode`	`getMU1Mode()`
`double`	`getMU2()`
`double`	`getMU2(FemFieldPoint dp)`
`ScalarFieldComponent`	`getMU2Field()`
`PropertyMode`	`getMU2Mode()`
`double`	`getMU3()`
`double`	`getMU3(FemFieldPoint dp)`
`ScalarFieldComponent`	`getMU3Field()`
`PropertyMode`	`getMU3Mode()`
`static void`	`main(java.lang.String[] args)`
`void`	`scaleDistance(double s)` Scales all distance coordinates.
`void`	`scaleMass(double s)` Scales all mass units.
`void`	`setCC(double CC)`
`void`	`setCCField(ScalarFieldComponent func)`
`void`	`setCCMode(PropertyMode mode)`
`void`	`setL11(double L11)`
`void`	`setL11Field(ScalarFieldComponent func)`
`void`	`setL11Mode(PropertyMode mode)`
`void`	`setL12(double L12)`
`void`	`setL12Field(ScalarFieldComponent func)`
`void`	`setL12Mode(PropertyMode mode)`
`void`	`setL22(double L22)`
`void`	`setL22Field(ScalarFieldComponent func)`
`void`	`setL22Mode(PropertyMode mode)`
`void`	`setL23(double L23)`
`void`	`setL23Field(ScalarFieldComponent func)`
`void`	`setL23Mode(PropertyMode mode)`
`void`	`setL31(double L31)`
`void`	`setL31Field(ScalarFieldComponent func)`
`void`	`setL31Mode(PropertyMode mode)`
`void`	`setL33(double L33)`
`void`	`setL33Field(ScalarFieldComponent func)`
`void`	`setL33Mode(PropertyMode mode)`
`void`	`setMU1(double MU1)`
`void`	`setMU1Field(ScalarFieldComponent func)`
`void`	`setMU1Mode(PropertyMode mode)`
`void`	`setMU2(double MU2)`
`void`	`setMU2Field(ScalarFieldComponent func)`
`void`	`setMU2Mode(PropertyMode mode)`
`void`	`setMU3(double MU3)`
`void`	`setMU3Field(ScalarFieldComponent func)`
`void`	`setMU3Mode(PropertyMode mode)`

Methods inherited from class artisynth.core.materials.FemMaterial
cauchyToSecondPKStress, computeDevLeftCauchyGreen, computeDevRightCauchyGreen, computeLeftCauchyGreen, computeRightCauchyGreen, createStateObject, getSubClasses, hasState, isCorotated, isInvertible, 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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

myProps

public static FieldPropertyList myProps

Constructor Detail

FungMaterial
```
public FungMaterial()
```

FungMaterial

public FungMaterial(double MU1,
                    double MU2,
                    double MU3,
                    double L11,
                    double L22,
                    double L33,
                    double L12,
                    double L23,
                    double L31,
                    double CC,
                    double kappa)

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 IncompressibleMaterialBase

Returns:

static information for all exported properties

setMU1
```
public void setMU1(double MU1)
```

setMU2
```
public void setMU2(double MU2)
```

setMU3
```
public void setMU3(double MU3)
```

setL11
```
public void setL11(double L11)
```

setL22
```
public void setL22(double L22)
```

setL33
```
public void setL33(double L33)
```

setL12
```
public void setL12(double L12)
```

setL23
```
public void setL23(double L23)
```

setL31
```
public void setL31(double L31)
```

setCC
```
public void setCC(double CC)
```

getMU1
```
public double getMU1()
```

getMU2
```
public double getMU2()
```

getMU3
```
public double getMU3()
```

getL11
```
public double getL11()
```

getL22
```
public double getL22()
```

getL33
```
public double getL33()
```

getL12
```
public double getL12()
```

getL23
```
public double getL23()
```

getL31
```
public double getL31()
```

getCC
```
public double getCC()
```

setMU1Mode

public void setMU1Mode(PropertyMode mode)

setMU2Mode

public void setMU2Mode(PropertyMode mode)

setMU3Mode

public void setMU3Mode(PropertyMode mode)

setL11Mode

public void setL11Mode(PropertyMode mode)

setL22Mode

public void setL22Mode(PropertyMode mode)

setL33Mode

public void setL33Mode(PropertyMode mode)

setL12Mode

public void setL12Mode(PropertyMode mode)

setL23Mode

public void setL23Mode(PropertyMode mode)

setL31Mode

public void setL31Mode(PropertyMode mode)

setCCMode

public void setCCMode(PropertyMode mode)

getMU1Mode
```
public PropertyMode getMU1Mode()
```

getMU2Mode
```
public PropertyMode getMU2Mode()
```

getMU3Mode
```
public PropertyMode getMU3Mode()
```

getL11Mode
```
public PropertyMode getL11Mode()
```

getL22Mode
```
public PropertyMode getL22Mode()
```

getL33Mode
```
public PropertyMode getL33Mode()
```

getL12Mode
```
public PropertyMode getL12Mode()
```

getL23Mode
```
public PropertyMode getL23Mode()
```

getL31Mode
```
public PropertyMode getL31Mode()
```

getCCMode
```
public PropertyMode getCCMode()
```

getMU1

public double getMU1(FemFieldPoint dp)

getMU2

public double getMU2(FemFieldPoint dp)

getMU3

public double getMU3(FemFieldPoint dp)

getL11

public double getL11(FemFieldPoint dp)

getL22

public double getL22(FemFieldPoint dp)

getL33

public double getL33(FemFieldPoint dp)

getL12

public double getL12(FemFieldPoint dp)

getL23

public double getL23(FemFieldPoint dp)

getL31

public double getL31(FemFieldPoint dp)

getCC

public double getCC(FemFieldPoint dp)

getMU1Field

public ScalarFieldComponent getMU1Field()

getMU2Field

public ScalarFieldComponent getMU2Field()

getMU3Field

public ScalarFieldComponent getMU3Field()

getL11Field

public ScalarFieldComponent getL11Field()

getL22Field

public ScalarFieldComponent getL22Field()

getL33Field

public ScalarFieldComponent getL33Field()

getL12Field

public ScalarFieldComponent getL12Field()

getL23Field

public ScalarFieldComponent getL23Field()

getL31Field

public ScalarFieldComponent getL31Field()

getCCField

public ScalarFieldComponent getCCField()

setMU1Field

public void setMU1Field(ScalarFieldComponent func)

setMU2Field

public void setMU2Field(ScalarFieldComponent func)

setMU3Field

public void setMU3Field(ScalarFieldComponent func)

setL11Field

public void setL11Field(ScalarFieldComponent func)

setL22Field

public void setL22Field(ScalarFieldComponent func)

setL33Field

public void setL33Field(ScalarFieldComponent func)

setL12Field

public void setL12Field(ScalarFieldComponent func)

setL23Field

public void setL23Field(ScalarFieldComponent func)

setL31Field

public void setL31Field(ScalarFieldComponent func)

setCCField

public void setCCField(ScalarFieldComponent func)

computeDevStressAndTangent

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

Specified by:: computeDevStressAndTangent in class IncompressibleMaterialBase

equals
```
public boolean equals(FemMaterial mat)
```
Overrides:

equals in class IncompressibleMaterialBase

clone
```
public FungMaterial 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

main

public static void main(java.lang.String[] args)

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 IncompressibleMaterialBase

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 IncompressibleMaterialBase

Parameters:

s - scaling factor

ddots

public static Matrix6d ddots(Matrix6d a,
                             Matrix6d b)

addTensorProduct4

public static void addTensorProduct4(Matrix6d c,
                                     double s,
                                     Matrix3dBase A,
                                     Matrix3dBase B)

Class FungMaterial

Nested Class Summary

Nested classes/interfaces inherited from class artisynth.core.materials.IncompressibleMaterialBase

Field Summary

Fields inherited from class artisynth.core.materials.IncompressibleMaterialBase

Constructor Summary

Method Summary

Methods inherited from class artisynth.core.materials.IncompressibleMaterialBase

Methods inherited from class artisynth.core.materials.FemMaterial

Methods inherited from class artisynth.core.materials.MaterialBase

Methods inherited from class java.lang.Object

Field Detail

myProps

Constructor Detail

FungMaterial

FungMaterial

Method Detail

getAllPropertyInfo

setMU1

setMU2

setMU3

setL11

setL22

setL33

setL12

setL23

setL31

setCC

getMU1

getMU2

getMU3

getL11

getL22

getL33

getL12

getL23

getL31

getCC

setMU1Mode

setMU2Mode

setMU3Mode

setL11Mode

setL22Mode

setL33Mode

setL12Mode

setL23Mode

setL31Mode

setCCMode

getMU1Mode

getMU2Mode

getMU3Mode

getL11Mode

getL22Mode

getL33Mode

getL12Mode

getL23Mode

getL31Mode

getCCMode

getMU1

getMU2

getMU3

getL11

getL22

getL33

getL12

getL23

getL31

getCC

getMU1Field

getMU2Field

getMU3Field

getL11Field

getL22Field

getL33Field

getL12Field

getL23Field

getL31Field

getCCField

setMU1Field

setMU2Field