FungOrthotropicMaterial (Artisynth API documentation)

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

All Implemented Interfaces:

HasMaterialState, PostScannable, PropertyChangeListener, ScalableUnits, java.lang.Cloneable, CompositeProperty, HasProperties, Clonable, Scannable
```
public class FungOrthotropicMaterial
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
`FungOrthotropicMaterial()` Creates a new FungOrthotropicMaterial with default parameter values.
`FungOrthotropicMaterial(double mu1, double mu2, double mu3, double l11, double l22, double l33, double l12, double l23, double l31, double C, double kappa)` Creates a new FungOrthotropicMaterial with the specified shear moduli, coupling coefficients, exponential coefficient, and bulk modulus.

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)`
`FungOrthotropicMaterial`	`clone()` Returns a clone of this composite property.
`double`	`computeDevStrainEnergy(DeformedPoint def, Matrix3d Q, double excitation, MaterialStateObject state)`
`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`	`getC()`
`double`	`getC(FemFieldPoint dp)`
`ScalarFieldComponent`	`getCField()`
`PropertyMode`	`getCMode()`
`double`	`getLam11()`
`double`	`getLam11(FemFieldPoint dp)`
`ScalarFieldComponent`	`getLam11Field()`
`PropertyMode`	`getLam11Mode()`
`double`	`getLam12()`
`double`	`getLam12(FemFieldPoint dp)`
`ScalarFieldComponent`	`getLam12Field()`
`PropertyMode`	`getLam12Mode()`
`double`	`getLam22()`
`double`	`getLam22(FemFieldPoint dp)`
`ScalarFieldComponent`	`getLam22Field()`
`PropertyMode`	`getLam22Mode()`
`double`	`getLam23()`
`double`	`getLam23(FemFieldPoint dp)`
`ScalarFieldComponent`	`getLam23Field()`
`PropertyMode`	`getLam23Mode()`
`double`	`getLam31()`
`double`	`getLam31(FemFieldPoint dp)`
`ScalarFieldComponent`	`getLam31Field()`
`PropertyMode`	`getLam31Mode()`
`double`	`getLam33()`
`double`	`getLam33(FemFieldPoint dp)`
`ScalarFieldComponent`	`getLam33Field()`
`PropertyMode`	`getLam33Mode()`
`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`	`setC(double C)`
`void`	`setCField(ScalarFieldComponent func)`
`void`	`setCMode(PropertyMode mode)`
`void`	`setLam11(double L11)`
`void`	`setLam11Field(ScalarFieldComponent func)`
`void`	`setLam11Mode(PropertyMode mode)`
`void`	`setLam12(double L12)`
`void`	`setLam12Field(ScalarFieldComponent func)`
`void`	`setLam12Mode(PropertyMode mode)`
`void`	`setLam22(double L22)`
`void`	`setLam22Field(ScalarFieldComponent func)`
`void`	`setLam22Mode(PropertyMode mode)`
`void`	`setLam23(double L23)`
`void`	`setLam23Field(ScalarFieldComponent func)`
`void`	`setLam23Mode(PropertyMode mode)`
`void`	`setLam31(double L31)`
`void`	`setLam31Field(ScalarFieldComponent func)`
`void`	`setLam31Mode(PropertyMode mode)`
`void`	`setLam33(double L33)`
`void`	`setLam33Field(ScalarFieldComponent func)`
`void`	`setLam33Mode(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
- FungOrthotropicMaterial
```
public FungOrthotropicMaterial()
```
  Creates a new FungOrthotropicMaterial with default parameter values.
- FungOrthotropicMaterial
```
public FungOrthotropicMaterial(double mu1,
                               double mu2,
                               double mu3,
                               double l11,
                               double l22,
                               double l33,
                               double l12,
                               double l23,
                               double l31,
                               double C,
                               double kappa)
```
  Creates a new FungOrthotropicMaterial with the specified shear moduli, coupling coefficients, exponential coefficient, and bulk modulus.
  
  Parameters:
  
  mu1 - shear modulus mu1
  
  mu2 - shear modulus mu2
  
  mu3 - shear modulus mu3
  
  l11 - coupling coefficient lambda11
  
  l22 - coupling coefficient lambda22
  
  l33 - coupling coefficient lambda33
  
  l12 - coupling coefficient lambda12
  
  l23 - coupling coefficient lambda23
  
  l31 - coupling coefficient lambda31
  
  C - exponential stress coefficient
  
  kappa - bulk modulus

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

setLam11
```
public void setLam11(double L11)
```

setLam22
```
public void setLam22(double L22)
```

setLam33
```
public void setLam33(double L33)
```

setLam12
```
public void setLam12(double L12)
```

setLam23
```
public void setLam23(double L23)
```

setLam31
```
public void setLam31(double L31)
```

setC
```
public void setC(double C)
```

getMu1
```
public double getMu1()
```

getMu2
```
public double getMu2()
```

getMu3
```
public double getMu3()
```

getLam11
```
public double getLam11()
```

getLam22
```
public double getLam22()
```

getLam33
```
public double getLam33()
```

getLam12
```
public double getLam12()
```

getLam23
```
public double getLam23()
```

getLam31
```
public double getLam31()
```

getC
```
public double getC()
```

setMu1Mode

public void setMu1Mode(PropertyMode mode)

setMu2Mode

public void setMu2Mode(PropertyMode mode)

setMu3Mode

public void setMu3Mode(PropertyMode mode)

setLam11Mode

public void setLam11Mode(PropertyMode mode)

setLam22Mode

public void setLam22Mode(PropertyMode mode)

setLam33Mode

public void setLam33Mode(PropertyMode mode)

setLam12Mode

public void setLam12Mode(PropertyMode mode)

setLam23Mode

public void setLam23Mode(PropertyMode mode)

setLam31Mode

public void setLam31Mode(PropertyMode mode)

setCMode

public void setCMode(PropertyMode mode)

getMu1Mode
```
public PropertyMode getMu1Mode()
```

getMu2Mode
```
public PropertyMode getMu2Mode()
```

getMu3Mode
```
public PropertyMode getMu3Mode()
```

getLam11Mode
```
public PropertyMode getLam11Mode()
```

getLam22Mode
```
public PropertyMode getLam22Mode()
```

getLam33Mode
```
public PropertyMode getLam33Mode()
```

getLam12Mode
```
public PropertyMode getLam12Mode()
```

getLam23Mode
```
public PropertyMode getLam23Mode()
```

getLam31Mode
```
public PropertyMode getLam31Mode()
```

getCMode
```
public PropertyMode getCMode()
```

getMu1

public double getMu1(FemFieldPoint dp)

getMu2

public double getMu2(FemFieldPoint dp)

getMu3

public double getMu3(FemFieldPoint dp)

getLam11

public double getLam11(FemFieldPoint dp)

getLam22

public double getLam22(FemFieldPoint dp)

getLam33

public double getLam33(FemFieldPoint dp)

getLam12

public double getLam12(FemFieldPoint dp)

getLam23

public double getLam23(FemFieldPoint dp)

getLam31

public double getLam31(FemFieldPoint dp)

getC
```
public double getC(FemFieldPoint dp)
```

getMu1Field

public ScalarFieldComponent getMu1Field()

getMu2Field

public ScalarFieldComponent getMu2Field()

getMu3Field

public ScalarFieldComponent getMu3Field()

getLam11Field

public ScalarFieldComponent getLam11Field()

getLam22Field

public ScalarFieldComponent getLam22Field()

getLam33Field

public ScalarFieldComponent getLam33Field()

getLam12Field

public ScalarFieldComponent getLam12Field()

getLam23Field

public ScalarFieldComponent getLam23Field()

getLam31Field

public ScalarFieldComponent getLam31Field()

getCField

public ScalarFieldComponent getCField()

setMu1Field

public void setMu1Field(ScalarFieldComponent func)

setMu2Field

public void setMu2Field(ScalarFieldComponent func)

setMu3Field

public void setMu3Field(ScalarFieldComponent func)

setLam11Field

public void setLam11Field(ScalarFieldComponent func)

setLam22Field

public void setLam22Field(ScalarFieldComponent func)

setLam33Field

public void setLam33Field(ScalarFieldComponent func)

setLam12Field

public void setLam12Field(ScalarFieldComponent func)

setLam23Field

public void setLam23Field(ScalarFieldComponent func)

setLam31Field

public void setLam31Field(ScalarFieldComponent func)

setCField

public void setCField(ScalarFieldComponent func)

computeDevStressAndTangent

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

Specified by:: computeDevStressAndTangent in class IncompressibleMaterialBase

computeDevStrainEnergy

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

Specified by:: computeDevStrainEnergy in class IncompressibleMaterialBase

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

equals in class IncompressibleMaterialBase

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

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

FungOrthotropicMaterial

FungOrthotropicMaterial

Method Detail

getAllPropertyInfo

setMu1

setMu2

setMu3

setLam11

setLam22

setLam33

setLam12

setLam23

setLam31

setC

getMu1

getMu2

getMu3

getLam11

getLam22

getLam33

getLam12

getLam23

getLam31

getC

setMu1Mode

setMu2Mode

setMu3Mode

setLam11Mode

setLam22Mode

setLam33Mode

setLam12Mode

setLam23Mode

setLam31Mode

setCMode

getMu1Mode

getMu2Mode

getMu3Mode

getLam11Mode

getLam22Mode

getLam33Mode

getLam12Mode

getLam23Mode

getLam31Mode

getCMode

getMu1

getMu2

getMu3

getLam11

getLam22

getLam33

getLam12

getLam23

getLam31

getC

getMu1Field

getMu2Field

getMu3Field

getLam11Field

getLam22Field

getLam33Field

getLam12Field

getLam23Field

getLam31Field

getCField

setMu1Field

setMu2Field