Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Underworld3
Logo
Underworld3
  • Getting Started
    • Quick Install (Recommended)
    • Alternative: Docker Container
    • HPC Builds
    • Verification
    • Uninstalling
    • Underworld Documentation and Examples
    • Benchmarks
    • The Underworld Community
    • Parallel Execution
    • Advanced capabilities
    • Overview
    • Basic Usage
    • Unit-Aware Parameters
    • Parameter Options
    • Inspecting Parameters
    • Complete Example
    • Angle Units
    • Create XDMF from PETSc HDF5 Output
    • Tutorials
    • Notebook 1: Meshes
    • Notebook 2: Variables
    • Notebook 3: Symbolic forms
    • Notebook 4: Poisson Equation
    • Exercise 4.1
    • Notebook 4a: Poisson Equation - Analytical Validation
    • Notebook 5: Stokes Equation
    • Notebook 6a: Time-Dependent Advection-Diffusion
    • Notebook 6: Rayleigh-Bénard Convection (time-stepping example)
    • Notebook 7: Unsteady Flow
    • The Navier-Stokes Solver
    • Notebook 8: Particle Swarms
    • Notebook 9: Multi-Material Constitutive Models
    • Notebook 12: Working with Physical Units
    • Notebook 13: Non-Dimensional Scaling
    • Notebook 14: Time-Dependent Advection-Diffusion with units
    • Analytical Solution in Physical Units
    • Notebook 15: Rayleigh-Bénard Convection (with physical units)
  • Advanced Usage
    • Parallel-Safe Scripting in Underworld3
    • Performance Optimization
    • complex rheologies
    • Custom Mesh Creation
    • Boundary Conditions on Curved Surfaces
    • Adaptive Mesh Refinement
    • trouuleshooting
    • api patterns
    • Swarm Integration Statistics: Accurate Spatial Statistics for Non-Uniform Particle Distributions
  • Developer Documentation
    • Setting Up Underworld3 Development Environment
    • Contributing Guidelines
    • Code Organization
    • Property Patterns
    • Documentation Style
    • Array and Data Management
    • Context Managers
    • MPI and Parallel Patterns
    • Callback and Event Systems
    • Testing Patterns
    • File and Directory Conventions
    • Performance Considerations
    • Common Patterns Summary
    • How to Write Underworld3 Scripts
    • Underworld3 Notebook Style Guide
    • Gmsh Integration Developer Guide
    • Underworld3 Code Review Process
    • Spelling Convention for Underworld3
    • Version Management with Git Tags
    • Branching and Release Strategy
    • Binder Container Setup for Underworld3
    • What is a uw.workflow?
    • Building Workflow Packages on Underworld3
    • Simplified Units Architecture (November 2025)
    • Why “Units” Not “Dimensionality” - User-Facing Terminology
    • Symbol Disambiguation in Underworld3
    • Adaptive Mesh Refinement Design Document
    • MeshVariable Architecture Analysis
    • MathematicalMixin Symbolic Behavior Design Document
    • Coordinate Access Migration Guide
    • Geographic Coordinate System Design for Underworld3
    • Mesh Geometry System Audit
    • Projected Surface Normals API Design
    • Turbulence Modelling for Underworld3 Navier-Stokes Solver
    • Overview and Philosophy
    • Core Design Principles
    • Mathematical Object Hierarchy
    • Natural Syntax Implementation
    • Derivative System Architecture
    • Usage Patterns and Examples
    • JIT Compilation Integration
    • Migration from Legacy Patterns
    • Developer Guidelines
    • Future Extensions
    • Conclusion
    • Executive Summary
    • Architecture Deep Dive
    • Implementation Details
    • Migration Patterns
    • Developer Guidelines
    • User Communication Strategy
    • Performance Impact
    • Technical Deep Dives
    • Global Reduction Operations
    • Template Expression Pattern in Underworld3 Solvers
    • Test Reliability Classification System
    • Underworld3 Development Changelog
    • Meshing System Documentation
    • Discretisation System Documentation
    • Solvers System Documentation
    • Constitutive Models Documentation
    • Constitutive tensors
    • Sympy tensorial form, Voigt form
    • Canonical forms
    • Incompressible materials
    • Validation
    • Muhlhaus / Moresi transversely isotropic tensor
    • Han & Wahr, 1997 (full transverse isotropic tensor)
    • Orthotropic medium
    • Swarm System Documentation
    • Purpose
    • Current Implementation (2025+)
    • Architecture Details
    • Performance Considerations
    • Implementation Files
    • Migration Guide (Legacy Patterns)
    • Expressions & Functions Documentation
    • Container Strategy
    • Checkpointing and Restart Architecture
    • Purpose
    • Architecture
    • Model Structure
    • Serialization
    • API Reference
    • Future Enhancements
    • Implementation Notes
    • Solver Development
    • MPI Parallelism in Underworld3
    • PETSc Integration Documentation
  • Underworld3 API Reference
    • Meshing
    • Discretisation
    • Particle Swarms
    • Solvers
    • Constitutive Models
    • Function and Expressions
    • Units and Scaling
    • Coordinate Systems
    • Time Derivatives
    • Mathematical Operations
    • Materials
    • Model Management
    • Utilities
    • Visualisation
    • Adaptive Mesh Refinement
    • Workflows
Back to top

Python Module Index

u
 
u
- underworld3
    underworld3.adaptivity
    underworld3.function.analytic
    underworld3.materials
    underworld3.meshing
    underworld3.model
    underworld3.scaling
    underworld3.utilities
    underworld3.visualisation
    underworld3.workflows
Copyright © 2025, Underworld Team
Made with Sphinx and @pradyunsg's Furo