Underworld Component Codex
This is a list of components available in Underworld.
AlignmentSwarmVariable
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
This is a measure of how closely a Director is aligned with the Velocity Field. See Muhlhaus, H. B. and Cada, M. and Moresi, L., Anisotropic convection model for the earth's mantle, Computational Science - Iccs 2003, Pt Iii, Proceedings, 2003, pp 788-797, Volume 2659
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | The VelocityField that you are comparing the alignment of the directors with. | VelocityField | |
| Director | True | The class that defines the directors for each particle. | Director |
Anisotropic
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
A rheology to set a viscosity in a slip direction to be different to the normal viscosity. See Muhlhaus, H. B. and Cada, M. and Moresi, L., Anisotropic convection model for the earth's mantle, Computational Science - Iccs 2003, Pt Iii, Proceedings, 2003, pp 788-797, Volume 2659
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| viscosityRatio | Double | 1.0 | The ratio of the normal viscosity to the shear viscosity. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| Director | True | The class that defines the directors for each particle. | Director |
Arrhenius
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
A temperature dependent rheology.
Example:
Equation:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| eta0 | Double | 1.0 | This is the  in the equation above. |
| activationEnergy | Double | 0.0 | This is the  in the equation above. |
| activationVolume | Double | 0.0 | This is the  in the equation above. |
| referenceTemperature | Double | 1.0 | This is the  in the equation above. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | The TemperatureField that provides the  in the equation above. | TemperatureField |
Byerlee
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
This component adds a depth dependent term to the yielding criterion of VonMises. See L. N. Moresi and V. S. Solomatov. Mantle convection with a brittle lithosphere: thoughts on the global tectonic styles of the Earth and Venus. Geophysicical Journal International, 133:669-682, 1998.
Example:
Equation:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| depthCoefficient | Double | 0.0 | Gives the  in the equation above. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| BlockGeometry | True | The geometry given so that this component can find the height of the box. | BlockGeometry | |
| FeMesh | True | The mesh given so that this component can find the global coordinate of the particle. | FeMesh |
Compressible
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
A term to add to a StiffnessMatrix so that materials can be compressible. A material must have it's 'compressible' Bool to be True for this term to make a contribution to the StiffnessMatrix for that material.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| oneOnLambda | Double | 10.0 | A factor which describes how compressible the material is. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeMesh | True | This is a mesh to give the geometry of the elements. It is used for Jacobian Determinant. | GeometryMesh |
ConstitutiveMatrix
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Description:
An abstract class which sets up an interface between materials with rheologies and the StiffnessMatrix
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
ConstitutiveMatrixCartesian
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
An implementation on the ConstitutiveMatrix class for a Cartesian geometry.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
DensityField
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Utils/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (C) 2006 Monash Cluster Computing.
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
A continuous field that represents the density at every point.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| BuoyancyForceTerm | True | The component required to get the density for each material. | BuoyancyForceTerm |
DepthDependentViscosity
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
A rheology that varies exponentially in one direction.
Example:
Equation:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| variationAxis | String | Y | This is the direction in which the exponentially varying viscosity goes. By default it is in the Y direction (vertical), but it can work in the X and Z directions as well. |
| eta0 | Double | 1.0 | This is the in the equation above. |
| gamma | Double | 0.0 | This is the  in the equation above. |
| referencePoint | Double | 0.0 | This is the  in the equation above. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeMesh | True | The mesh given so that this component can find the global coordinate of the particle. | Mesh |
Director
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
This component allows to add a vector to a material points and to update it with respect to the deformation.
Example:
Equation:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| initialDirectionX | Double | 0.0 | Initial value of the x coordinate of the vector |
| initialDirectionY | Double | 1.0 | Initial value of the y coordinate of the vector |
| initialDirectionZ | Double | 0.0 | Initial value of the z coordinate of the vector |
| dontUpdate | Bool | False | If set to True, then the vector is still created but its update is inactive |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| TimeIntegrator | True | This is the main component that supplies the functions to integrate the director evolution equation. | TimeIntegrator | |
| VelocityGradientsField | True | This supplies the  in the director evolution equation | VelocityGradientsField | |
| MaterialPointsSwarm | True | This is the swarm that you want to add the director to. | MaterialPointsSwarm |
DruckerPrager
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Implements a Drucker-Prager yield Rheology. The parameters of this criterion are calibrated so that the yield surface coincides with the Mohr Coulomb one for the condition of a compression test.
Example:
Equation:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| minimumYieldStress | Double | 0.0 | This sets an absolute minimum for the value for the calculated yield stress. |
| frictionCoefficient | Double | 0.0 | Defines the dependance of the criterion to the pressure. |
| frictionCoefficientAfterSoftening | Double | 0.0 | This is the value of the frictionCoefficient after the material has weakened |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | Essential component since the DruckerPrager criterion is pressure dependant | PressureField | |
| IntegrationPointsSwarm | True | Defines the set of material points. It is needed because infos stored by each material point are added for viz purpose. | MaterialPoints | |
| FiniteElementContext | True | The context is essential because the DruckerPrager_UpdateDrawParameters function is prepended to an existing Entry Point. | Context |
FaultingMoresiMuhlhaus2006
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Implements faulting behaviour based on Mohr-Coulomb failure criterion. See following reference for details : Anisotropic viscous models of large-deformation Mohr–Coulomb failure, Moresi, L.; Mühlhaus, H.-B., Philosophical Magazine, Volume 86, Numbers 21-22, -22/21 July–1 August 2006, pp. 3287-3305
Example:
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| cohesion | Double | 0.0 | Cohesion for a pristine material |
| cohesionAfterSoftening | Double | 0.0 | Value of the cohesion after the material has weakened |
| frictionCoefficient | Double | 0.0 | Defines the dependance of the criterion to the normal stress |
| frictionCoefficientAfterSoftening | Double | 0.0 | This is the value of the frictionCoefficient after the material has weakened |
| minimumYieldStress | Double | 0.0 | The value of the failure criterion (defining the yield surface) can not be smaller than this parameter |
| ignoreOldOrientation | Bool | False | Boolean to indicate if we want to take into account the oldOrientation |
| updateOrientationAtMaxSoftness | Bool | True | Boolean to indicate if we want to update the particle fault orientation when maximum softness is reached. The new orientation is chosen to coincide with the direction of maximum shear strain rate. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | Essential since the MohrCoulomb failure criterion is pressure dependant | PressureField | |
| IntegrationPointsSwarm | True | Defines the set of material points | ||
| FeVariable | True | The resolved component of this tensor wrt the failure plane are mainly used to determine the most favourable oriented plane for failure to occur | VelocityGradientsFieldField | |
| FiniteElementContext | True | The context is essential because the FaultingMoresiMuhlhaus2006_ UpdateDrawParameters function is prepended to an existing Entry Point. | Context | |
| Director | True | This component allows to update the normal associated with a failure plane wrt the deformation. At the moment, it is only possible to update all normal at the same time, no matter if they correspond to active failure planes or not | ||
| StrainWeakening | True | Define the weakening behaviour of material parameters. This component dependency is first defined in YieldRheology class, but as non essential. Since we want it for MC criterion, we make it essential here. |
FrankKamenetskii
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
An approximation to the Arrhenius temperature dependent rheology.
Example:
Equation:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| eta0 | Double | 1.0 | This is the in the equation in the description. |
| theta | Double | 0.0 | This is the  in the equation in the description. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | The TemperatureField that provides the in the equation in the description. | TemperatureField |
LinearViscosity
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
A rheology that can vary linearly in any direction
Example:
Equation:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| X | Double | 1.0 | This is the  in the equation above. |
| Y | Double | 1.0 | This is the  in the equation above. |
| Z | Double | 1.0 | This is the  in the equation above. |
| XY | Double | 1.0 | This is the  in the equation above. |
| XZ | Double | 1.0 | This is the  in the equation above. |
| YZ | Double | 1.0 | This is the  in the equation above. |
| XYZ | Double | 1.0 | This is the  in the equation above. |
| C | Double | 1.0 | This is the  in the equation above. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
MaterialViscosity
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
This sets the viscosity to be a constant value throughtout a material.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| eta0 | Double | 1.0 | The value of the viscosty throughout a material. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
MohrCoulomb
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Implements faulting behaviour based on Mohr-Coulomb failure criterion. See following reference for details : Anisotropic viscous models of large-deformation Mohr–Coulomb failure, Moresi, L.; Mühlhaus, H.-B., Philosophical Magazine, Volume 86, Numbers 21-22, -22/21 July–1 August 2006, pp. 3287-3305
Example:
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| cohesion | Double | 0.0 | Cohesion for a pristine material |
| cohesionAfterSoftening | Double | 0.0 | Value of the cohesion after the material has weakened |
| frictionCoefficient | Double | 0.0 | Defines the dependance of the criterion to the normal stress |
| frictionCoefficientAfterSoftening | Double | 0.0 | This is the value of the frictionCoefficient after the material has weakened |
| minimumYieldStress | Double | 0.0 | The value of the failure criterion (defining the yield surface) can not be smaller than this parameter |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | Essential since the MohrCoulomb failure criterion is pressure dependant | PressureField | |
| IntegrationPointsSwarm | True | Defines the set of material points | ||
| FeVariable | True | The resolved component of this tensor wrt the failure plane are mainly used to determine the most favourable oriented plane for failure to occur | StrainRateFieldField | |
| StrainWeakening | True | Define the weakening behaviour of material parameters. This component dependency is first defined in YieldRheology class, but as non essential. Since we want it for MC criterion, we make it essential here. | ||
| FeVariable | True | The field that provides the  in the equation above. | StrainRateField |
MultiRheologyMaterial
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
This allows for multiple rheologies to be applied to a material. The resultant isotropic material will have a effective viscosity defined as $\frac{1}{n_{eff}} = \sum_{i=0}^n \frac{1}{n_{i}}$, where $n_i is the isotropic vicosities of the input rheologies.
The input rheologies must be defined in a rheology list, see example
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
NodalPressureField
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Utils/src/
Project Web:
http://mcc.monash.edu.au/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | ... | PressureField |
NonNewtonian
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Models rheology with dislocation creep (non-Newtonian Stress Dependent viscosity)
Example:
Equation:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| stressExponent | Double | 1.0 | This is the  in the equation above. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | The field that provides the in the equation above. | StrainRateInvariantField |
Orthotropic
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Orthotropic (Anisotropic) model with rotated matrix
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| C11 | Double | 2.0 | Constitutive Matrix Value. |
| C22 | Double | 2.0 | Constitutive Matrix Value. |
| C3311 | Double | 2.0 | Constitutive Matrix Value. |
| C44 | Double | 1.0 | Constitutive Matrix Value. |
| C55 | Double | 1.0 | Constitutive Matrix Value. |
| C66 | Double | 1.0 | Constitutive Matrix Value. |
| C12 | Double | 0.0 | Constitutive Matrix Value. |
| C13 | Double | 0.0 | Constitutive Matrix Value. |
| C23 | Double | 0.0 | Constitutive Matrix Value. |
| n1 | Double | 1.0 | Director Value. |
| n2 | Double | 0.0 | Director Value. |
| n3 | Double | 0.0 | Director Value. |
| m1 | Double | 0.0 | Director Value. |
| m2 | Double | 1.0 | Director Value. |
| m3 | Double | 0.0 | Director Value. |
| q1 | Double | 0.0 | Director Value. |
| q2 | Double | 0.0 | Director Value. |
| q3 | Double | 1.0 | Director Value. |
OrthotropicAligned
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Simple Orthotropic (Anisotropic) model with non-rotated matrix
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| viscosity1 | Double | 2.0 | Value of first viscosity. |
| viscosity2 | Double | 2.0 | Value of 2nd viscosity. |
| viscosity3 | Double | 2.0 | Value of 3rd viscosity. |
| viscosity4 | Double | 1.0 | Value of 4th viscosity. |
| viscosity5 | Double | 1.0 | Value of 5th viscosity. |
| viscosity6 | Double | 1.0 | Value of 6th viscosity. |
PressureTemperatureOutput
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Utils/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
This component prints out the temperature and pressure values on a swarm
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | The pressure field whose value will be evaluated at swarm points | PressureField | |
| FeVariable | True | The temperature field whose value will be evaluated at swarm points | TemperatureField |
RadiogenicHeatingTerm
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Utils/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
This adds a radiogenic heating term on to the energy equation. To turn on this force term must be define it as well as extending the definitions of materials, by adding a heating element list to a material definition. One or more heating elements can be defined in this list. Each heating element adds the following term to the energy equation: Q * exp( -lambda * time ), where 'Q' and 'lambda' are specified in the heating element list for each material.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
Rheology
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Stg_Component
Children:
Description:
An abstract class which creates an interface function between the Material and the ConstitutiveMatrix. This is the Rheology_ModifyConstitutiveMatrix method.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
RheologyMaterial
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Description:
For each material with a different constitutive relationship, or material properties that the user wants to have in their model, they must create a RheologyMaterial. This will be laid out in a 'Shape' within the model.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| Rheology | True | A list of 'Rheology' components must be given here. When a particle of this material is used to assemble the Constitutive Matrix, each rheology in this list will have it's ModifyConstitutiveMatrix function run, in the order that the rheologies are specified in this list. | Rheology | |
| Compressible | No | If this material will be compressible, you must give it a reference to a Compressible component in this line. This material then will use the parameters for compressibility given in this component. | Compressible |
SmoothVelGradField
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Utils/src/
Project Web:
http://mcc.monash.edu.au/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | ... | PressureField |
StoreStress
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
This component stores the stress tensor calculated on each material point (see equation below). It can also be used to visualise a component of the stress tensor with gLucifer. The parameter to be plotted is called by the following generic name: name of the swarm dash the name of the parameter being one of the following:
tau_xx, tau_yy, tau_xy in 2D
tau_xx, tau_yy, tau_zz, tau_xy, tau_xz, tau_yz in 3D
Example:
Equation:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| MaterialPointsSwarm | True | This is the swarm defining the material points | MaterialPointsSwarm | |
| FeVariable | True | This is the necessary to get the values of the strain rate field | StrainRateField | StrainRateField |
StoreVisc
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
This component stores the isotropic viscosity obtained from the constitutive matrix. It can also be used to visualise the viscosity with gLucifer. To plot it, use the following generic name: name of the swarm dash Viscosity
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| IntegrationPointsSwarm | True | This is the swarm defining the material points | materialPoints | IntegrationPointsSwarm |
StrainWeakening
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
This component is used in problems where the material parameters can soften (usually used with a yield rheology component). The name StrainWeakening is probably not appropriate. This component is mainly used in the following cases: to define an initial distribution of strain in a material; to calculate the accumulated strain on each particles. Since the material parameters are not softened inside that component, 'Strain' or 'AccumulatedStrain' or 'EquivalentAccumulatedPlasticStrain' may be more appropriate names.
Example:
Example:
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| healingRate | Double | 0.0 | this value defines how the material is allowed to heal (should be between 0 and 1) |
| softeningStrain | Double | HUGE_VAL | this parameter is used in the following cases: If an initial random strain is defined, then the maximum value of initial strain is equal to softeningStrain*initialDamageFactor It is considered as a reference strain in a ratio used to soften the material parameters. This ratio is always between 0 and 1, and is set to 1 if the calculated strain is greater than softeningStrain (maximum softening allowed) |
| initialDamageFraction | Double | 0.0 | Defines the fraction of material whith an initial non zero random strain |
| initialDamageWavenumber | Double | -1.0 | This parameter is used to set the way the initial randomly oriented damage is distributed in space $\phi = \cos^2 k_I x_I$. The way the damage evolves often makes it a good idea to keep shear bands away from boundaries, especially where the mesh-stretching boundary condition is applied. In this case, make sure $k_I = n / L_I$ where $n$ is an integer, and $L_I$ is the length of the box in the $I$ direction. |
| initialDamageWavenumberSinI | Double | -1.0 | This parameter is used to set the way the initial randomly oriented damage is distributed in space $\phi = \sin^2 k_I x_I$. The way the damage evolves often makes it a good idea to keep shear bands away from boundaries, especially where the mesh-stretching boundary condition is applied. In this case, make sure $k_I = n / L_I$ where $n$ is an integer, and $L_I$ is the length of the box in the $I$ direction. |
| initialDamageWavenumberCosI | Double | -1.0 | This parameter is used to set the way the initial randomly oriented damage is distributed in space $\phi = \cos^2 k_I x_I$. The way the damage evolves often makes it a good idea to keep shear bands away from boundaries, especially where the mesh-stretching boundary condition is applied. In this case, make sure $k_I = n / L_I$ where $n$ is an integer, and $L_I$ is the length of the box in the $I$ direction. |
| initialDamageWavenumberSinJ | Double | -1.0 | This parameter is used to set the way the initial randomly oriented damage is distributed in space $\phi = \sin^2 k_I x_I$. The way the damage evolves often makes it a good idea to keep shear bands away from boundaries, especially where the mesh-stretching boundary condition is applied. In this case, make sure $k_J = n / L_J$ where $n$ is an integer, and $L_J$ is the length of the box in the $J$ direction. |
| initialDamageWavenumberCosJ | Double | -1.0 | This parameter is used to set the way the initial randomly oriented damage is distributed in space $\phi = \cos^2 k_I x_I$. The way the damage evolves often makes it a good idea to keep shear bands away from boundaries, especially where the mesh-stretching boundary condition is applied. In this case, make sure $k_J = n / L_J$ where $n$ is an integer, and $L_J$ is the length of the box in the $J$ direction. |
| initialDamageFactor | Double | 1.0 | The magnitude of the initial damage value applied to individual particles whose strain-weakening is controlled by this component. Note that the randomness of the damage is not in the magnitude of the value applied to each point but rather is a probability of the damage being applied at that point. (see softeningStrain parameter - it makes sense to set the initial damage normalized by the saturation strain) |
| randomSeed | Int | 0 | This parameter is used to initialise the random function used to define the initial random strain |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| MaterialPointsSwarm | Yes | This defines the set of material points. | ||
| Stg_Shape | No | If defined, the initial random strain will be prescibed inside this shape only (the initial strain will be zero outside the shape). | initialStrainShape |
StressField
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Utils/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | ... | StrainRateField | |
| ConstitutiveMatrix | True | ... | ConstitutiveMatrix |
UnderworldContext
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Utils/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
Underworld_SwarmOutput
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Utils/src
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
This component allows for a given list of FeVariables to be calculated on the MaterialPointsSwarm. The output of these calculations is sent to a file called, "nameOfField".materialPointsSwarm."timeStep".dat, that is found in the output directory.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| list | True | This is a list of FeVariables whose values will be evaluated on the material pointts and then printed to a file. | FeVariables | |
| MaterialPointsSwarm | True | This is the materialPointsSwarm, which by default is called materialSwarm in the xml. | Swarm |
ViscosityField
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Utils/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| ConstitutiveMatrix | True | ... | ConstitutiveMatrix |
ViscosityFieldRheology
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
A rheology that means that this material's viscosity comes from a FeVariable field. This field is created separately and can contain any values for the viscosity - so long as it is isotropic.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | The Field defining the viscosity. | ViscosityField |
VonMises
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Description:
A basic yielding model.
Example:
Equation:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| cohesion | Double | 0.0 | This is the cohesion of the pristine material, without any strain softening. The effective cohesion is a linear interpolation between this value and the 'cohesionAfterSoftening' value. |
| cohesionAfterSoftening | Double | 0.0 | This is the cohesion of the material at maximum strain. The effective cohesion is a linear interpolation between this value and the 'cohesion' value. |
| strainRateSoftening | Bool | False | This is a flag for the users to set whether they want to use a stress-strain rate relationship where the material weakens according to the strain-rate if it has yielded. (This functionality will be moved to another component. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | The field that provides the in the equation above. | StrainRateField |
YieldRheology
Organisation:
MCC
Project:
Underworld
Location:
./Underworld/Rheology/src/
Project Web:
http://www.mcc.monash.edu.au/Software/Underworld
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Description:
This is the abstract class of the yield rheology components
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| StrainWeakening | No | Define the weakening behaviour of material parameters | StrainWeakening | |
| MaterialPointsSwarm | No | Define set of material points if it exists | MaterialPointsSwarm |