Underworld3 API Reference

Underworld3 is a Python package for geodynamic modelling using PETSc finite elements.

Core Modules

• Meshing
  • Cartesian Meshes
  • Annulus Meshes
  • Spherical Meshes
  • Geographic Meshes
  • Segmented Meshes
  • Faults and Internal Boundaries
  • Surfaces
• Discretisation
  • Mesh
  • MeshVariable
  • Checkpointing
• Particle Swarms
  • Swarm
  • SwarmVariable
  • Index Swarm Variable
  • Nodal Point Swarm
• Solvers
  • Stokes Flow
  • Scalar Equations
  • Projection Solvers
  • Navier-Stokes
• Constitutive Models
  • Viscous Flow Models
  • Diffusion Models
  • Viscoelastic Models
  • Darcy Flow
• Function and Expressions
  • Expressions
  • Mesh Variable Functions
  • Quantities and Units
  • Evaluation
  • Analytic Functions
• Units and Scaling
  • Creating Quantities
  • Unit Conversion
  • Non-dimensionalisation
  • Dimensional Analysis

Supporting Modules

• Coordinate Systems
  • CoordinateSystem
  • CoordinateSystemType
• Time Derivatives
  • Base Class
  • Eulerian Derivatives
  • Lagrangian Derivatives
  • Convenience Aliases
• Mathematical Operations
  • Integral Operations
  • Vector Calculus
• Materials
  • Material Property
  • Material Registry
  • Multi-Material Models
• Model Management
  • Model Class
  • Model Functions
  • Thermal Convection Configuration
• Utilities
  • I/O Utilities
  • Geometry Tools
  • Development Utilities
  • I/O Utilities
  • Mesh Import
  • Development Utilities
  • Geometry Utilities
  • Array Utilities
• Visualisation
  • Mesh Conversion
  • Function Sampling
  • Plotting Utilities
• Adaptive Mesh Refinement
  • Key Functions
  • Mesh Adaptation
  • Metric Functions

Quick Links

Mesh and Variables

• Meshing - Create computational meshes (structured, unstructured, spherical)

• Discretisation - Mesh variables and field data

• Particle Swarms - Particle swarms and Lagrangian tracking

• Coordinate Systems - Coordinate systems and transformations

Solvers and Physics

• Solvers - PDE solvers (Stokes, Poisson, advection-diffusion)

• Constitutive Models - Material behaviour models (viscosity, diffusivity)

• Time Derivatives - Time derivative discretisation

• Materials - Multi-material systems

Functions and Units

• Function and Expressions - Expressions, evaluation, and symbolic functions

• Units and Scaling - Units, quantities, and non-dimensionalisation

• Mathematical Operations - Mathematical operations and integrals

Infrastructure

• Model Management - Model management and configuration

• Utilities - I/O, mesh import, and helper functions

• Visualisation - Plotting and visualisation tools

• Adaptive Mesh Refinement - Adaptive mesh refinement (AMR)

Indices

• Index

• Module Index