OgdenMaterial (Artisynth API documentation)

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

All Implemented Interfaces:

ScalableUnits, java.lang.Cloneable, CompositeProperty, HasProperties, Clonable, Scannable
```
public class OgdenMaterial
extends IncompressibleMaterial
```

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

Field Summary

Fields
Modifier and Type Field and Description

static PropertyList myProps
- Fields inherited from class artisynth.core.materials.IncompressibleMaterial
  DEFAULT_BULK_POTENTIAL, DEFAULT_KAPPA

Fields
Modifier and Type	Field and Description
`static PropertyList`	`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.
`void`	`computeStress(SymmetricMatrix3d sigma, SolidDeformation def, Matrix3d Q, FemMaterial baseMat)` Computes the strain tensor given the supplied deformation
`void`	`computeTangent(Matrix6d c, SymmetricMatrix3d stress, SolidDeformation def, Matrix3d Q, FemMaterial baseMat)` Computes the tangent stiffness matrix
`boolean`	`equals(FemMaterial mat)`
`PropertyList`	`getAllPropertyInfo()` Returns a list giving static information about all properties exported by this object.
`double`	`getAlpha1()`
`PropertyMode`	`getAlpha1Mode()`
`double`	`getAlpha2()`
`PropertyMode`	`getAlpha2Mode()`
`double`	`getAlpha3()`
`PropertyMode`	`getAlpha3Mode()`
`double`	`getAlpha4()`
`PropertyMode`	`getAlpha4Mode()`
`double`	`getAlpha5()`
`PropertyMode`	`getAlpha5Mode()`
`double`	`getAlpha6()`
`PropertyMode`	`getAlpha6Mode()`
`double`	`getMu1()`
`PropertyMode`	`getMu1Mode()`
`double`	`getMu2()`
`PropertyMode`	`getMu2Mode()`
`double`	`getMu3()`
`PropertyMode`	`getMu3Mode()`
`double`	`getMu4()`
`PropertyMode`	`getMu4Mode()`
`double`	`getMu5()`
`PropertyMode`	`getMu5Mode()`
`double`	`getMu6()`
`PropertyMode`	`getMu6Mode()`
`boolean`	`isIncompressible()`
`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`	`setAlpha1Mode(PropertyMode mode)`
`void`	`setAlpha2(double alpha)`
`void`	`setAlpha2Mode(PropertyMode mode)`
`void`	`setAlpha3(double alpha)`
`void`	`setAlpha3Mode(PropertyMode mode)`
`void`	`setAlpha4(double alpha)`
`void`	`setAlpha4Mode(PropertyMode mode)`
`void`	`setAlpha5(double alpha)`
`void`	`setAlpha5Mode(PropertyMode mode)`
`void`	`setAlpha6(double alpha)`
`void`	`setAlpha6Mode(PropertyMode mode)`
`void`	`setMu1(double mu)`
`void`	`setMu1Mode(PropertyMode mode)`
`void`	`setMu2(double mu)`
`void`	`setMu2Mode(PropertyMode mode)`
`void`	`setMu3(double mu)`
`void`	`setMu3Mode(PropertyMode mode)`
`void`	`setMu4(double mu)`
`void`	`setMu4Mode(PropertyMode mode)`
`void`	`setMu5(double mu)`
`void`	`setMu5Mode(PropertyMode mode)`
`void`	`setMu6(double mu)`
`void`	`setMu6Mode(PropertyMode mode)`

Methods inherited from class artisynth.core.materials.IncompressibleMaterial
addPressureStress, addPressureTangent, computePressureStress, computePressureTangent, getBulkModulus, getBulkModulusMode, getBulkPotential, getBulkPotentialMode, getEffectiveModulus, getEffectivePressure, isInvertible, setBulkModulus, setBulkModulusMode, setBulkPotential, setBulkPotentialMode

Methods inherited from class artisynth.core.materials.FemMaterial
equals, getSubClasses, getViscoBehavior, isCorotated, isLinear, isViscoelastic, registerSubclass, setViscoBehavior

Methods inherited from class artisynth.core.materials.MaterialBase
getProperty, getPropertyHost, getPropertyInfo, hasProperty, hasSymmetricTangent, isWritable, scan, setPropertyHost, setPropertyInfo, tangentSymmetryChanged, updateMaterial, write

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- myProps
```
public static PropertyList myProps
```

Constructor Detail

OgdenMaterial
```
public OgdenMaterial()
```

OgdenMaterial

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

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 IncompressibleMaterial

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

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

computeStress
```
public void computeStress(SymmetricMatrix3d sigma,
                          SolidDeformation def,
                          Matrix3d Q,
                          FemMaterial baseMat)
```
Description copied from class: FemMaterial

Computes the strain tensor given the supplied deformation

Overrides:

computeStress in class IncompressibleMaterial

Parameters:

sigma - strain tensor, populated

def - deformation information, includes deformation gradient and pressure

Q - coordinate frame specifying directions of anisotropy

baseMat - underlying base material (if any)

computeTangent
```
public void computeTangent(Matrix6d c,
                           SymmetricMatrix3d stress,
                           SolidDeformation def,
                           Matrix3d Q,
                           FemMaterial baseMat)
```
Description copied from class: FemMaterial

Computes the tangent stiffness matrix

Overrides:

computeTangent in class IncompressibleMaterial

Parameters:

c - tangent stiffness, populated

stress - the current stress tensor

def - deformation information, includes deformation gradient and pressure

Q - coordinate frame specifying directions of anisotropy

baseMat - underlying base material (if any)

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

equals in class IncompressibleMaterial

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 IncompressibleMaterial

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 IncompressibleMaterial

Parameters:

s - scaling factor

isIncompressible
```
public boolean isIncompressible()
```
Overrides:

isIncompressible in class IncompressibleMaterial

Class OgdenMaterial

Nested Class Summary

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

Field Summary

Fields inherited from class artisynth.core.materials.IncompressibleMaterial

Constructor Summary

Method Summary

Methods inherited from class artisynth.core.materials.IncompressibleMaterial

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

setAlpha1

setAlpha2

setAlpha3

setAlpha4

setAlpha5

setAlpha6

getAlpha1

getAlpha2

getAlpha3

getAlpha4

getAlpha5

getAlpha6

setAlpha1Mode

setAlpha2Mode

setAlpha3Mode

setAlpha4Mode

setAlpha5Mode

setAlpha6Mode

getAlpha1Mode

getAlpha2Mode

getAlpha3Mode

getAlpha4Mode

getAlpha5Mode

getAlpha6Mode

computeStress

computeTangent

equals

clone

main

scaleDistance

scaleMass

isIncompressible