OgdenMaterial (Artisynth API documentation)

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

All Implemented Interfaces:

HasMaterialState, PostScannable, PropertyChangeListener, ScalableUnits, java.lang.Cloneable, CompositeProperty, HasProperties, Clonable, Scannable
```
public class OgdenMaterial
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

OgdenMaterial()

OgdenMaterial(double[] mu, double[] alpha, double kappa)

Constructors
Constructor and Description
`OgdenMaterial()`
`OgdenMaterial(double[] mu, double[] alpha, double kappa)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OgdenMaterial`	`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)`
`boolean`	`equals(FemMaterial mat)`
`FieldPropertyList`	`getAllPropertyInfo()` Returns a list giving static information about all properties exported by this object.
`double`	`getAlpha1()`
`double`	`getAlpha1(FemFieldPoint dp)`
`ScalarFieldComponent`	`getAlpha1Field()`
`PropertyMode`	`getAlpha1Mode()`
`double`	`getAlpha2()`
`double`	`getAlpha2(FemFieldPoint dp)`
`ScalarFieldComponent`	`getAlpha2Field()`
`PropertyMode`	`getAlpha2Mode()`
`double`	`getAlpha3()`
`double`	`getAlpha3(FemFieldPoint dp)`
`ScalarFieldComponent`	`getAlpha3Field()`
`PropertyMode`	`getAlpha3Mode()`
`double`	`getAlpha4()`
`double`	`getAlpha4(FemFieldPoint dp)`
`ScalarFieldComponent`	`getAlpha4Field()`
`PropertyMode`	`getAlpha4Mode()`
`double`	`getAlpha5()`
`double`	`getAlpha5(FemFieldPoint dp)`
`ScalarFieldComponent`	`getAlpha5Field()`
`PropertyMode`	`getAlpha5Mode()`
`double`	`getAlpha6()`
`double`	`getAlpha6(FemFieldPoint dp)`
`ScalarFieldComponent`	`getAlpha6Field()`
`PropertyMode`	`getAlpha6Mode()`
`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()`
`double`	`getMu4()`
`double`	`getMu4(FemFieldPoint dp)`
`ScalarFieldComponent`	`getMu4Field()`
`PropertyMode`	`getMu4Mode()`
`double`	`getMu5()`
`double`	`getMu5(FemFieldPoint dp)`
`ScalarFieldComponent`	`getMu5Field()`
`PropertyMode`	`getMu5Mode()`
`double`	`getMu6()`
`double`	`getMu6(FemFieldPoint dp)`
`ScalarFieldComponent`	`getMu6Field()`
`PropertyMode`	`getMu6Mode()`
`static void`	`main(java.lang.String[] args)`
`void`	`scaleDistance(double s)` Scales all distance coordinates.
`void`	`scaleMass(double s)` Scales all mass units.
`void`	`setAlpha1(double alpha)`
`void`	`setAlpha1Field(ScalarFieldComponent func)`
`void`	`setAlpha1Mode(PropertyMode mode)`
`void`	`setAlpha2(double alpha)`
`void`	`setAlpha2Field(ScalarFieldComponent func)`
`void`	`setAlpha2Mode(PropertyMode mode)`
`void`	`setAlpha3(double alpha)`
`void`	`setAlpha3Field(ScalarFieldComponent func)`
`void`	`setAlpha3Mode(PropertyMode mode)`
`void`	`setAlpha4(double alpha)`
`void`	`setAlpha4Field(ScalarFieldComponent func)`
`void`	`setAlpha4Mode(PropertyMode mode)`
`void`	`setAlpha5(double alpha)`
`void`	`setAlpha5Field(ScalarFieldComponent func)`
`void`	`setAlpha5Mode(PropertyMode mode)`
`void`	`setAlpha6(double alpha)`
`void`	`setAlpha6Field(ScalarFieldComponent func)`
`void`	`setAlpha6Mode(PropertyMode mode)`
`void`	`setMu1(double mu)`
`void`	`setMu1Field(ScalarFieldComponent func)`
`void`	`setMu1Mode(PropertyMode mode)`
`void`	`setMu2(double mu)`
`void`	`setMu2Field(ScalarFieldComponent func)`
`void`	`setMu2Mode(PropertyMode mode)`
`void`	`setMu3(double mu)`
`void`	`setMu3Field(ScalarFieldComponent func)`
`void`	`setMu3Mode(PropertyMode mode)`
`void`	`setMu4(double mu)`
`void`	`setMu4Field(ScalarFieldComponent func)`
`void`	`setMu4Mode(PropertyMode mode)`
`void`	`setMu5(double mu)`
`void`	`setMu5Field(ScalarFieldComponent func)`
`void`	`setMu5Mode(PropertyMode mode)`
`void`	`setMu6(double mu)`
`void`	`setMu6Field(ScalarFieldComponent func)`
`void`	`setMu6Mode(PropertyMode mode)`
`double`	`sqr(double x)`

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

OgdenMaterial
```
public OgdenMaterial()
```

OgdenMaterial

public OgdenMaterial(double[] mu,
                     double[] alpha,
                     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 mu)
```

setMu2
```
public void setMu2(double mu)
```

setMu3
```
public void setMu3(double mu)
```

setMu4
```
public void setMu4(double mu)
```

setMu5
```
public void setMu5(double mu)
```

setMu6
```
public void setMu6(double mu)
```

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

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

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

getMu4
```
public double getMu4()
```

getMu5
```
public double getMu5()
```

getMu6
```
public double getMu6()
```

setMu1Mode

public void setMu1Mode(PropertyMode mode)

setMu2Mode

public void setMu2Mode(PropertyMode mode)

setMu3Mode

public void setMu3Mode(PropertyMode mode)

setMu4Mode

public void setMu4Mode(PropertyMode mode)

setMu5Mode

public void setMu5Mode(PropertyMode mode)

setMu6Mode

public void setMu6Mode(PropertyMode mode)

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

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

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

getMu4Mode
```
public PropertyMode getMu4Mode()
```

getMu5Mode
```
public PropertyMode getMu5Mode()
```

getMu6Mode
```
public PropertyMode getMu6Mode()
```

getMu1

public double getMu1(FemFieldPoint dp)

getMu2

public double getMu2(FemFieldPoint dp)

getMu3

public double getMu3(FemFieldPoint dp)

getMu4

public double getMu4(FemFieldPoint dp)

getMu5

public double getMu5(FemFieldPoint dp)

getMu6

public double getMu6(FemFieldPoint dp)

getMu1Field

public ScalarFieldComponent getMu1Field()

getMu2Field

public ScalarFieldComponent getMu2Field()

getMu3Field

public ScalarFieldComponent getMu3Field()

getMu4Field

public ScalarFieldComponent getMu4Field()

getMu5Field

public ScalarFieldComponent getMu5Field()

getMu6Field

public ScalarFieldComponent getMu6Field()

setMu1Field

public void setMu1Field(ScalarFieldComponent func)

setMu2Field

public void setMu2Field(ScalarFieldComponent func)

setMu3Field

public void setMu3Field(ScalarFieldComponent func)

setMu4Field

public void setMu4Field(ScalarFieldComponent func)

setMu5Field

public void setMu5Field(ScalarFieldComponent func)

setMu6Field

public void setMu6Field(ScalarFieldComponent func)

setAlpha1
```
public void setAlpha1(double alpha)
```

setAlpha2
```
public void setAlpha2(double alpha)
```

setAlpha3
```
public void setAlpha3(double alpha)
```

setAlpha4
```
public void setAlpha4(double alpha)
```

setAlpha5
```
public void setAlpha5(double alpha)
```

setAlpha6
```
public void setAlpha6(double alpha)
```

getAlpha1
```
public double getAlpha1()
```

getAlpha2
```
public double getAlpha2()
```

getAlpha3
```
public double getAlpha3()
```

getAlpha4
```
public double getAlpha4()
```

getAlpha5
```
public double getAlpha5()
```

getAlpha6
```
public double getAlpha6()
```

setAlpha1Mode

public void setAlpha1Mode(PropertyMode mode)

setAlpha2Mode

public void setAlpha2Mode(PropertyMode mode)

setAlpha3Mode

public void setAlpha3Mode(PropertyMode mode)

setAlpha4Mode

public void setAlpha4Mode(PropertyMode mode)

setAlpha5Mode

public void setAlpha5Mode(PropertyMode mode)

setAlpha6Mode

public void setAlpha6Mode(PropertyMode mode)

getAlpha1Mode
```
public PropertyMode getAlpha1Mode()
```

getAlpha2Mode
```
public PropertyMode getAlpha2Mode()
```

getAlpha3Mode
```
public PropertyMode getAlpha3Mode()
```

getAlpha4Mode
```
public PropertyMode getAlpha4Mode()
```

getAlpha5Mode
```
public PropertyMode getAlpha5Mode()
```

getAlpha6Mode
```
public PropertyMode getAlpha6Mode()
```

getAlpha1

public double getAlpha1(FemFieldPoint dp)

getAlpha2

public double getAlpha2(FemFieldPoint dp)

getAlpha3

public double getAlpha3(FemFieldPoint dp)

getAlpha4

public double getAlpha4(FemFieldPoint dp)

getAlpha5

public double getAlpha5(FemFieldPoint dp)

getAlpha6

public double getAlpha6(FemFieldPoint dp)

getAlpha1Field

public ScalarFieldComponent getAlpha1Field()

getAlpha2Field

public ScalarFieldComponent getAlpha2Field()

getAlpha3Field

public ScalarFieldComponent getAlpha3Field()

getAlpha4Field

public ScalarFieldComponent getAlpha4Field()

getAlpha5Field

public ScalarFieldComponent getAlpha5Field()

getAlpha6Field

public ScalarFieldComponent getAlpha6Field()

setAlpha1Field

public void setAlpha1Field(ScalarFieldComponent func)

setAlpha2Field

public void setAlpha2Field(ScalarFieldComponent func)

setAlpha3Field

public void setAlpha3Field(ScalarFieldComponent func)

setAlpha4Field

public void setAlpha4Field(ScalarFieldComponent func)

setAlpha5Field

public void setAlpha5Field(ScalarFieldComponent func)

setAlpha6Field

public void setAlpha6Field(ScalarFieldComponent func)

sqr
```
public final double sqr(double x)
```

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 OgdenMaterial 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

Class OgdenMaterial

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

OgdenMaterial

OgdenMaterial

Method Detail

getAllPropertyInfo

setMu1

setMu2

setMu3

setMu4

setMu5

setMu6

getMu1

getMu2

getMu3

getMu4

getMu5

getMu6

setMu1Mode

setMu2Mode

setMu3Mode

setMu4Mode

setMu5Mode

setMu6Mode

getMu1Mode

getMu2Mode

getMu3Mode

getMu4Mode

getMu5Mode

getMu6Mode

getMu1

getMu2

getMu3

getMu4

getMu5

getMu6

getMu1Field

getMu2Field

getMu3Field

getMu4Field

getMu5Field

getMu6Field

setMu1Field

setMu2Field

setMu3Field

setMu4Field

setMu5Field

setMu6Field

setAlpha1

setAlpha2

setAlpha3

setAlpha4

setAlpha5

setAlpha6

getAlpha1

getAlpha2

getAlpha3

getAlpha4

getAlpha5

getAlpha6

setAlpha1Mode

setAlpha2Mode

setAlpha3Mode

setAlpha4Mode

setAlpha5Mode

setAlpha6Mode

getAlpha1Mode

getAlpha2Mode