User Guide

This guide describes how to set up and run GEOS simulations. If you are new to GEOS, start with the Tutorials, then read Capabilities Overview, Anatomy of an Input File and Running GEOS. The remaining chapters follow the order in which an input file is usually written: mesh, materials, physics and numerics, boundary conditions, then time stepping and outputs. The complete list of XML elements and attributes is in the Datastructure Index.

• Capabilities Overview
• Anatomy of an Input File
  • Top-level blocks
  • How blocks refer to each other
  • Splitting a deck: <Included>
  • Parameters and units: <Parameters>
  • Looking up any element or attribute
• Running GEOS
  • Serial run
  • Parallel run
  • Command-line options
  • Checking an input file
  • Restarting a simulation
  • Reading the log
  • Common first-run problems
• Input Files
  • XML
  • Input Validation
  • XML Schema
  • Units
  • Advanced XML Features
• Meshes
  • Internal Mesh Generation
  • Using an External Mesh
• Constitutive Models
  • Solid Models
  • Fluid Models
  • Relative Permeability Models
  • Capillary Pressure Models
  • Porosity models
  • Permeability models
  • Porous Solids
  • Temperature-dependent Solid Volumetric Heat Capacity Model
  • Temperature-dependent Thermal Conductivity Model
• Physics Solvers
  • Solution Strategy
  • Solid Mechanics Solver
  • Contact Mechanics Solver
  • Singlephase Flow Solver
  • Immiscible Multiphase Flow Solver
  • Compositional Multiphase Flow Solver
  • Compositional Multiphase Well Solver
  • Poromechanics Solver
  • Proppant Transport Solver
• Numerical Methods
• XML Element: NumericalMethods
  • Finite Element Discretization
  • Finite Volume Discretization
• Linear Solvers
  • Introduction
  • Direct methods
  • Iterative methods
  • Summary
  • HYPRE through hypredrive
  • Preconditioner descriptions
  • HYPRE MGR Preconditioner
  • Block preconditioner
  • Adaptive tolerance
• Initial and Boundary Conditions
  • Generic field specification
  • Specialized conditions
  • Sets
  • Units and sign conventions
• Functions
  • Function Inputs and Application
  • Function Types
• Event Management
  • Event Execution Rules
  • Event Manager Configuration
  • Other Event Features
• Tasks Manager
  • Tasks Manager Configuration
• Poromechanical Models Initialization
  • Model Initialization: Hydrostatic and Mechanical Equilibrium
  • Model Initialization: User Defined Tables
• Outputs
  • Outputs
  • Log and CSV outputs
• Parallel Partitioning
  • Partition and ghosting : simple examples
  • Specifying partitioning pattern
  • Ghost ranks
  • Considerations for visualization
• Constitutive Drivers
  • PVT Driver
  • XML Element: PVTDriver
  • Triaxial Driver
  • XML Element: TriaxialDriver
  • Relperm Driver
  • XML Element: RelpermDriver
• pygeosx — GEOS in Python
  • Building pygeosx
  • Minimal example
  • Module Functions
  • GEOS State
  • Module Classes
  • Segmentation Faults