GEOS
  • Quick Start Guide
    • Frequently Asked Questions
      • Does GEOS have a graphical user interface?:
      • Do I need to be a code developer to use GEOS?:
      • What are the system requirements?:
      • Help, I get errors while trying to download/compile/run!:
    • Repository Organization
    • Username and Authentication
    • Download
    • Configuration
      • Defining a Host-Config File
    • Compilation
      • Compiling the TPLs
      • Compiling GEOS
    • Running
    • Testing
  • Tutorials
    • Tutorial 1: First Steps
      • Single-phase solver
      • Mesh
      • Geometry
      • Events
      • Numerical methods
      • Regions
      • Constitutive models
      • Defining properties
      • Output
      • Running GEOS
      • Visualization
      • To go further
    • Tutorial 2: External Meshes
      • Hexahedral elements
        • Brief discussion about hexahedral meshes in GEOS
        • Importing an external mesh with VTK
        • Running GEOS
        • Visualization of results in VisIt
      • Externally Generated Tetrahedral Elements
        • Running GEOS
        • Visualization of results in VisIt
      • To go further
    • Tutorial 3: Regions and Property Specifications
      • Single-phase solver
      • Mesh
      • Geometry
      • Events
      • Numerical methods
      • Regions
      • Constitutive models
      • Defining properties
      • Output
      • Using functions to specify properties
      • Running GEOS
      • Visualization of results
      • To go further
    • Tutorial 4: Boundary Conditions and Time-Dependent Functions
      • Discretized computational domain
      • Gravity
      • Solid mechanics solver
      • Finite element discretization
      • Constitutive model
      • Boundary conditions
      • Table function
      • Execution
      • Result
      • To go further
  • Basic Examples
    • Multiphase Flow
      • Multiphase flow solver
      • Mesh
      • Geometry
      • Events
      • Numerical methods
      • Reservoir region
      • Constitutive models
      • Initial and boundary conditions
      • Output
      • Running GEOS
      • Visualization
      • To go further
    • Multiphase Flow with Wells
      • Coupling the flow solver with wells
      • Mesh definition and well geometry
        • InternalWell sub-blocks
        • VTKWell sub-blocks
      • Events
      • Numerical methods
      • Reservoir and well regions
      • Constitutive models
      • Initial conditions
      • Outputs
      • Tasks
      • Running GEOS
      • Visualization
      • To go further
    • CO 2 Injection
      • Multiphase flow and well solvers
      • Mesh and well geometry
      • Events
      • Numerical methods
      • Element regions
      • Constitutive laws
      • Property specification
      • Output
      • Tasks
      • Running GEOS
      • Visualization
      • To go further
    • Poromechanics
      • Description of the case
      • Coupled solvers
      • Multiphysics numerical methods
      • Mesh, material properties, and boundary conditions
      • Running GEOS
      • Inspecting results
      • To go further
    • Hydraulic Fracturing
      • Description of the case
      • Included: including external xml files
      • Parameters: defining variables to be used throughout the file
      • Mesh with biased boundaries
      • Defining a fracture nodeset
      • Boundary conditions
      • Coupled hydraulic fracturing solver
      • Events
      • Functions to set in-situ properties
      • Running GEOS
      • Inspecting results
      • Modifying Parameters Via the Command-Line
      • To go further
    • Triaxial Driver: Extended Drucker-Prager Elasto-Plastic Model
      • Description of the case
      • Task
      • Constitutive laws
      • Functions
      • Mesh
      • Running TriaxialDriver
      • Inspecting results
      • To go further
  • Advanced Examples
    • Validation and Verification Studies
      • Carbon Storage
        • Verification of CO2 Core Flood Experiment with Buckley-Leverett Solution
          • Description of the case
          • Mesh
          • Flow solver
          • Constitutive laws
          • Time history function
          • Initial and boundary conditions
          • Inspecting results
          • To go further
        • CO2 Plume Evolution and Leakage Through an Abandoned Well
          • Problem description
          • Mesh and element regions
          • Flow solver
          • Constitutive laws
          • Initial and boundary conditions
          • Inspecting results
          • To go further
        • Non-isothermal CO2 Plume Evolution and Leakage Through an Abandoned Well
          • Problem description
          • Mesh and element regions
          • Flow solver
          • Constitutive models
            • CO2 density and viscosity
            • Brine density and viscosity
            • CO2 solubility in brine
          • Initial and boundary conditions
          • Inspecting results
          • To go further
        • CO2 Plume Evolution With Hysteresis Effect on Relative Permeability
          • Problem description
          • Mesh and element regions
          • Coupled solver
            • Flow solver
            • Well solver
          • Constitutive laws
          • Initial and boundary conditions
          • Outputing reservoir statistics
          • Inspecting results
          • To go further
      • Faults & fractures
        • Sneddon’s Problem
          • Description of the case
          • Mechanics solver
          • Events
          • Mesh, material properties, and boundary conditions
          • Adding a fracture
          • Time history function
          • Running GEOS
          • Inspecting results
          • To go further
        • Single Fracture Under Shear Compression
          • Description of the case
          • Mesh
          • Solid mechanics solver
          • Constitutive laws
          • Time history function
          • Initial and boundary conditions
          • Inspecting results
          • To go further
        • Fracture Intersection Problem
          • Description of the case
          • Mesh
          • Solid mechanics solver
          • Constitutive laws
          • Time history function
          • Initial and boundary conditions
          • Inspecting results
          • To go further
        • Verification of Induced Stresses Along a Fault
          • Description of the case
          • Mesh
          • Solid mechanics solver
          • Discretization methods for multiphysics solvers
          • Constitutive laws
          • Initial and boundary conditions
          • Inspecting results
          • To go further
      • Hydraulic Fracture
        • Toughness dominated KGD hydraulic fracture
          • Description of the case
          • Mechanics solvers
          • The constitutive laws
          • Mesh
          • Defining the initial fracture
          • Defining the fracture plane
          • Defining the injection rate
          • Time history function
          • Inspecting results
          • To go further
        • Viscosity dominated KGD hydraulic fracture
          • Description of the case
          • To go further
        • Validating KGD Hydraulic Fracture with Experiment
          • Description of the case
          • Mesh
          • Solid mechanics solver
          • Constitutive laws
          • Time history function
          • Initial and boundary conditions
          • Inspecting results
          • To go further
        • Toughness-Storage-Dominated Penny Shaped Hydraulic Fracture
          • Description of the case
          • Mesh
          • Solid mechanics solver
          • Constitutive laws
          • Time history function
          • Initial and boundary conditions
          • Inspecting results
          • To go further
        • Viscosity-Storage-Dominated Penny Shaped Hydraulic Fracture
          • Description of the case
          • Mesh
          • Solid mechanics solver
          • Constitutive laws
          • Time history function
          • Initial and boundary conditions
          • Inspecting results
          • To go further
        • Viscosity-Storage-Dominated PKN Hydraulic Fracture
          • Description of the case
          • Mesh
          • Solid mechanics solver
          • Constitutive laws
          • Time history function
          • Initial and boundary conditions
          • Inspecting results
          • To go further
        • Proppant Slot Test
          • Description of the case
          • Mesh
          • Proppant transport solver
          • Constitutive laws
          • Initial and boundary conditions
          • Inspecting results
          • To go further
      • Wellbore Problems
        • Kirsch Wellbore Problem
          • Description of the case
          • Mesh
          • Solid mechanics solver
          • Constitutive laws
          • Time history function
          • Initial and boundary conditions
          • Inspecting results
          • To go further
        • Cased Elastic Wellbore Problem
          • Problem description
          • Solid mechanics solver
          • Cased wellbore mesh
          • Steel, cement, and rock constitutive laws
          • Boundary conditions
          • Results and benchmark
          • To go further
        • Deviated Elastic Wellbore Problem
          • Problem description
          • Solid mechanics solver
          • Deviated wellbore mesh
          • Constitutive law
          • Boundary conditions
          • Results and benchmark
          • To go further
        • Extended Drucker-Prager Model for Wellbore Problems
          • Description of the case
          • Mesh
          • Solid mechanics solver
          • Constitutive laws
          • Initial and boundary conditions
          • Inspecting results
          • To go further
        • Drucker-Prager Model with Hardening for Wellbore Problems
          • To go further
        • Modified Cam-Clay Model for Wellbore Problems
          • Description of the case
          • Mesh
          • Solid mechanics solver
          • Constitutive laws
            • XML Element: ModifiedCamClay
          • Initial and boundary conditions
          • Inspecting results
          • To go further
        • Deviated Poro-Elastic Wellbore Subjected to Fluid Injection
          • Problem description
          • Poroelastic solver
          • Deviated wellbore mesh
          • Constitutive law
          • Boundary conditions
          • Results and benchmark
          • To go further
        • Deviated Poro-Elastic Wellbore Subjected to In-situ Stresses and Pore Pressure
          • Problem description
          • Results and benchmark
          • To go further
        • Vertical PoroElasto-Plastic Wellbore Problem
          • Description of the case
          • Mesh
          • Solid mechanics solver
          • Discretization methods for multiphysics solvers
          • Constitutive laws
          • Initial and boundary conditions
          • Inspecting results
          • To go further
        • Pure Thermal Diffusion Around a Wellbore
          • Problem description
          • Constitutive
          • FieldSpecifications
          • Results and benchmark
          • To go further
        • Non-Linear Thermal Diffusion Around a Wellbore: The Case with Temperature Dependent Volumetric Heat Capacity
          • Problem description
          • Constitutive
          • Results and benchmark
          • To go further
        • Non-Linear Thermal Diffusion Around a Wellbore: The Case with Temperature Dependent Single Phase Thermal Conductivity
          • Problem description
          • Constitutive
          • Results and benchmark
          • To go further
        • Cased ThermoElastic Wellbore Problem
          • Problem description
          • Geometry and mesh
          • Material properties
          • Boundary conditions
          • Collecting output data
          • Results and benchmark
          • To go further
        • ThermoPoroElastic Wellbore Problem
          • Problem description
          • Geometry and mesh
          • Material properties
          • Boundary conditions
          • Collecting output data
          • Results and benchmark
          • To go further
        • Cased Elastic Wellbore with Imperfect Interfaces
          • Problem description
          • Cylinder geometry
          • Events
          • Numerical Methods
          • Contact region and material
          • Results and benchmark
          • To go further
        • Cased ThermoElastic Wellbore Problem with Imperfect Contact Interfaces
          • Problem description
          • Geometry and mesh
          • Material properties
          • Boundary and initial conditions
          • Solvers
          • Results and benchmark
          • To go further
      • Viscoplasticity
        • Drucker-Prager Model: Triaxial Driver versus Semi-Analytical Solution
          • Problem description
          • Task
          • Constitutive laws
          • A comparison between GEOS results and semi-analytical results
          • To go further
        • Visco Drucker-Prager Model: Triaxial Driver versus Semi-Analytical Solution
          • Problem description
          • Task
          • Constitutive laws
          • A comparison between GEOS results and semi-analytical results
          • To go further
        • Extended Drucker-Prager Model: Triaxial Driver versus Semi-Analytical Solution
          • Problem description
          • Task
          • Constitutive laws
          • A comparison between GEOS results and semi-analytical results
          • To go further
        • Visco Extended Drucker-Prager Model: Triaxial Driver versus Semi-Analytical Solution
          • Problem description
          • Task
          • Constitutive laws
          • A comparison between GEOS results and semi-analytical results
          • To go further
        • Modified CamClay Model: Triaxial Driver versus Semi-Analytical Solution
          • Problem description
          • Task
          • Constitutive laws
          • A comparison between GEOS results and semi-analytical results
          • To go further
        • Visco Modified CamClay model: Triaxial Driver versus Semi-Analytical Solution
          • Problem description
          • Task
          • Constitutive laws
          • A comparison between GEOS results and semi-analytical results
          • To go further
        • Verification of a Relaxation Test with Visco Extended Drucker-Prager Model
          • Description of the case
          • Mesh
          • Solid mechanics solver
          • Constitutive laws
          • Time history function
          • Initial and boundary conditions
          • Inspecting results
          • To go further
      • Poromechanics
        • Mandel’s Problem
          • Description of the case
          • Mesh
          • Solid mechanics solver
          • Constitutive laws
          • Time history function
          • Initial and boundary conditions
          • Inspecting results
          • To go further
      • Thermoporomechanics
        • Thermoporoelastic Consolidation
          • Description of the case
          • Solvers
          • Constitutive laws
          • Initial and boundary conditions
          • Inspecting results
          • To go further
    • Performance Benchmarks
      • Wellbore problem scaling on Frontier
        • Mechanics
        • Single Phase Flow
        • Compositional Multiphase Flow
        • Running the Performance Study
          • Prerequisites
          • Directory Structure
          • Dispatching Jobs
          • Analyzing Output
          • Note
    • Application Studies
    • pygeosx Examples
      • In Situ Data Monitor
        • Description of the case
        • XML Configuration
        • Python Script
        • Manual Query
        • Running the Problem
        • To go further
      • Initial Condition Modification
        • Description of the case
        • XML Configuration
        • Python Script
        • Running the Problem
        • To go further
  • User Guide
    • Input Files
      • XML
        • XML Components
      • Input Validation
        • xmllint
        • Sublime Text
        • VS Code
        • Eclipse
        • GEOS XML Tools
      • XML Schema
        • Schema Components
        • Automatic Schema Generation
      • Advanced XML Features
        • Usage
        • Included Files
          • XML preprocessor
          • GEOS
        • Parameters
        • Units
        • Symbolic Expressions
        • Validation
    • Meshes
      • Internal Mesh Generation
        • Basic Example
        • XML Element: InternalMesh
        • Mesh Bias
        • Advanced Cell Block Specification
      • Using an External Mesh
        • Supported Formats
        • Importing the Mesh
          • Importing regions
          • Importing surfaces
    • Physics Solvers
      • Solution Strategy
        • Nonlinear Solver
          • Line Search
        • Timestepping Strategy
        • Parameters
        • XML Element: NonlinearSolverParameters
      • Solid Mechanics Solver
        • List of Symbols
        • Introduction
        • Theory
          • Governing Equations
          • Quasi-Static Time Integration
          • Implicit Dynamics Time Integration (Newmark Method)
          • Explicit Dynamics Time Integration (Special Implementation of Newmark Method with gamma=0.5, beta=0)
        • Parameters
        • XML Element: SolidMechanicsLagrangianFEM
        • Datastructure: SolidMechanicsLagrangianFEM
        • Example
      • Contact Mechanics Solver
        • Governing Equations
        • Solvers
          • Solid mechanics conforming fractures solver
            • Introduction
            • Theory
              • Governing Equations
            • Parameters
            • XML Element: SolidMechanicsLagrangeContact
            • Datastructure: SolidMechanicsLagrangeContact
          • Solid mechanics embedded fractures solver
            • Introduction
            • Discretization & soltuion strategy
            • Example
            • Parameters
            • XML Element: SolidMechanicsEmbeddedFractures
            • Datastructure: SolidMechanicsEmbeddedFractures
            • References
      • Singlephase Flow Solver
        • Introduction
        • Theory
          • Governing Equations
          • Discretization
            • Space Discretization
            • Time Discretization
        • Parameters
        • XML Element: SinglePhaseFVM
        • Example
      • Immiscible Multiphase Flow Solver
        • Introduction
        • Theory
          • Governing Equations
            • Mass Conservation Equations
          • Primary Variables
            • Flow and Transport Equations
          • Discretization
            • Spatial Discretization
            • Temporal Discretization
          • Solution Strategy
        • Parameters
        • XML Element: ImmiscibleMultiphaseFlow
        • Example
      • Compositional Multiphase Flow Solver
        • Introduction
        • Theory
          • Governing Equations
            • Mass Conservation Equations
            • Darcy’s Law
            • Constraints and Thermodynamic Equilibrium
          • Primary Variables
          • Discretization
            • Spatial Discretization
            • Temporal Discretization
          • Solution Strategy
        • Parameters
        • XML Element: CompositionalMultiphaseFVM
        • Example
      • Compositional Multiphase Well Solver
        • Introduction
        • Theory
          • Discrete Equations
            • Mass Conservation
            • Volume Constraint Equation
            • Pressure Relations
            • Pressure and Rate Controls
          • Primary variables
        • Parameters
        • XML Element: CompositionalMultiphaseWell
        • Example
      • Poromechanics Solver
        • Introduction
        • Theory
          • Governing Equations
        • Parameters
        • XML Element: SinglePhasePoromechanics
        • Example
      • Proppant Transport Solver
        • Introduction
        • Theory
          • Proppant-fluid Slurry Flow
          • Proppant Transport
          • Multi-component Fluid Transport
          • Proppant Slip Velocity
          • Proppant Bed Build-up and Load Transport
          • Proppant Bridging and Screenout
          • Slurry Fluid Viscosity
        • Spatial Discretization
        • Solution Strategy
        • Parameters
        • XML Element: ProppantTransport
        • Example
        • References
    • Constitutive Models
      • Solid Models
        • Deformation Theories
          • Introduction
          • Small Strain Models
          • Finite Deformation Models with Hypo-Materials
          • Finite Deformation Models with Hyper-Materials
        • Voigt Notation
        • Plasticity Notation
          • Overview
          • Two-Invariant Models
          • Three-Invariant Models
        • Model: Elastic Isotropic
          • Overview
          • Variations
          • Parameters
          • XML Element: ElasticIsotropic
          • Example
        • Model: Elastic Isotropic Pressure Dependent
          • Overview
          • Parameters
          • Example
        • Model: Elastic Transverse-Isotropic
          • Overview
          • Parameters
          • XML Element: ElasticTransverseIsotropic
          • Example
        • Model: Elastic Orthotropic
          • Overview
          • Parameters
          • XML Element: ElasticOrthotropic
          • Example
        • Model: Drucker-Prager
          • Overview
            • Parameters
              • XML Element: DruckerPrager
            • Example
            • Variant: J2 plasticity
        • Model: Extended Drucker-Prager
          • Overview
            • Parameters
            • Example
        • Model: Modified Cam-Clay
          • Parameters
          • Example
        • Model: Delft Egg
          • Parameters
          • Example
        • Damage Models
        • Model: Viscoplasticity
      • Fluid Models
        • Compressible single phase fluid model
          • Overview
          • Parameters
          • XML Element: CompressibleSinglePhaseFluid
          • Example
        • Two-phase immiscible fluid model
          • Overview
          • Parameters
          • XML Element: TwoPhaseImmiscibleFluid
          • Example using TableFunctions
          • Example using text files
        • Black-oil fluid model
          • Overview
            • Dead oil
            • Live oil
          • Parameters
          • XML Element: BlackOilFluid
          • Example
        • Compositional multiphase fluid model
          • Overview
          • Step 1: Computation of the phase fractions and phase component fractions (flash)
            • Stability test
            • Phase labeling
            • Negative two-phase flash
          • Parameters
          • XML Element: CompositionalMultiphaseFluid
          • Example
          • References
        • CO2-brine model
          • Summary
          • Step 1: Computation of the phase fractions and phase component fractions (flash)
          • Step 2: Computation of the phase densities and phase viscosities
            • CO2 phase density and viscosity
            • Brine density and viscosity using Phillips correlation
            • Brine density and viscosity using Ezrokhi correlation
          • Parameters
          • XML Element: CO2BrinePhillipsFluid
          • Example
          • References
      • Relative Permeability Models
        • Brooks-Corey relative permeability model
          • Overview
          • Parameters
          • XML Element: BrooksCoreyRelativePermeability
          • Examples
        • Three-phase relative permeability model
          • Overview
          • Parameters
          • XML Element: BrooksCoreyBakerRelativePermeability
          • Example
        • Table relative permeability
          • Overview
          • Parameters
          • XML Element: TableRelativePermeability
          • Examples
      • Capillary Pressure Models
        • Brooks-Corey capillary pressure model
          • Overview
          • Parameters
          • XML Element: BrooksCoreyCapillaryPressure
          • Example
        • Van Genuchten capillary pressure model
          • Overview
          • Parameters
          • XML Element: VanGenuchtenCapillaryPressure
          • Example
        • Table capillary pressure
          • Overview
          • Parameters
          • XML Element: TableCapillaryPressure
          • Examples
      • Porosity models
        • Pressure dependent porosity
          • Overview
          • Parameters
          • XML Element: PressurePorosity
          • Example
        • Biot Porosity Model
          • Overview
          • Parameters
          • XML Element: BiotPorosity
          • Example
      • Permeability models
        • Constant Permeability Model
          • Overview
          • Parameters
          • XML Element: ConstantPermeability
          • Example
        • Exponential Decay Permeability Model
          • Overview
          • Parameters
          • XML Element: ExponentialDecayPermeability
          • Example
        • Kozeny-Carman Permeability Model
          • Overview
          • Parameters
          • XML Element: CarmanKozenyPermeability
          • Example
        • Parallel Plates Permeability Model
          • Overview
          • Parameters
          • XML Element: ParallelPlatesPermeability
        • Slip Dependent Permeability Model
          • Overview
          • Parameters
          • XML Element: SlipDependentPermeability
          • Example
        • Willis-Richards Permeability Model
          • Overview
          • Parameters
          • XML Element: WillisRichardsPermeability
          • Example
      • Porous Solids
        • Overview
        • CompressibleSolid
        • PorousSolid
      • Temperature-dependent Solid Volumetric Heat Capacity Model
        • Overview
        • Parameters
        • XML Element: SolidInternalEnergy
        • Example
      • Temperature-dependent Thermal Conductivity Model
        • Overview
        • Parameters
        • XML Element: SinglePhaseThermalConductivity
        • Example
    • Constitutive Drivers
      • PVT Driver
        • Introduction
        • XML Structure
        • Parameters
      • XML Element: PVTDriver
        • Output Format
        • Unit Testing
      • Triaxial Driver
        • Introduction
        • XML Structure
      • XML Element: TriaxialDriver
        • Test Modes
        • Output Format
        • Model Convergence
        • Unit Testing
    • Initial and Boundary Conditions
      • Hydrostatic Equilibrium Initial Condition
        • Overview
        • Single-phase flow parameters
        • Compositional multiphase flow parameters
        • XML Element: HydrostaticEquilibrium
        • Examples
        • Expected behavior and comparison with another initialization method
          • Initialization using HydrostaticEquilibrium
          • Initialization using FieldSpecification tags
      • Aquifer Boundary Condition
        • Overview
        • Aquifer model
        • Carter-Tracy analytical aquifer
          • Time constant
          • Influx constant
          • Aquifer volumetric flow rate
        • Parameters
        • XML Element: Aquifer
        • Examples
    • Event Management
      • Event Execution Rules
      • Event Manager Configuration
        • Event
        • PeriodicEvent
        • SoloEvent
        • HaltEvent
      • Other Event Features
        • Event Progress Indicator
        • Nested Events
    • Tasks Manager
      • Tasks Manager Configuration
        • Task
        • PackCollection
          • Triggering the Tasks
    • Functions
      • Function Inputs and Application
      • Function Types
        • TableFunction
          • 1D Table
          • ND Table
          • Interpolation Methods
          • Table Generation Example
        • SymbolicFunction
        • CompositeFunction
    • Poromechanical Models Intialization
      • Model Initialization: Hydrostatic and Mechanical Equilibrium
        • Description of the Case
        • Mesh
        • Poro-Mechanics Solver
        • Constitutive Laws
        • Stress Initialization Function
        • Initial and Boundary Conditions
        • Inspecting Results
        • To go further
      • Model Initialization: User Defined Tables
        • Stress Initialization Table Functions
        • Inspecting Results
        • To go further
    • Linear Solvers
      • Introduction
      • Direct methods
      • Iterative methods
      • Summary
        • XML Element: LinearSolverParameters
      • Preconditioner descriptions
      • HYPRE MGR Preconditioner
      • Block preconditioner
      • Adaptive tolerance
    • Numerical Methods
    • XML Element: NumericalMethods
      • Finite Element Discretization
      • Finite Volume Discretization
        • Standard cell-centered TPFA FVM
        • Hybrid FVM
    • Parallel Partitioning
      • Partition and ghosting : simple examples
      • Specifying partitioning pattern
        • Cartesian partitioning
        • Graph-based partitioning
      • Ghost ranks
      • Considerations for visualization
    • Outputs
      • Defining an output
        • SILO Output
        • XML Element: Silo
        • VTK Output
        • XML Element: VTK
        • TimeHistory Output
        • XML Element: TimeHistory
      • Triggering the outputs
      • Visualisation of the outputs
        • Visualizing Silo outputs with VisIT
        • Visualizing VTK outputs with VisIT
        • Visualizing VTK outputs with Paraview
        • Visualizing TimeHistory outputs with MatPlotLib
    • pygeosx — GEOS in Python
      • Module Functions
        • pygeosx.initialize()
        • pygeosx.reinit()
        • pygeosx.apply_initial_conditions()
        • pygeosx.finalize()
        • pygeosx.run()
      • GEOS State
        • pygeosx.UNINITIALIZED
        • pygeosx.INITIALIZED
        • pygeosx.READY_TO_RUN
        • pygeosx.COMPLETED
      • Module Classes
        • pygeosx.Group
          • pygeosx.Group.groups()
          • pygeosx.Group.wrappers()
          • pygeosx.Group.get_group()
          • pygeosx.Group.get_wrapper()
          • pygeosx.Group.register()
        • pygeosx.Wrapper
          • pygeosx.Wrapper.value()
      • Segmentation Faults
        • Stale Numpy Views
        • Destroyed LvArray C++ objects
    • Indices and tables
  • Developer Guide
    • Contributing
      • Code style
        • Introduction
        • Naming Conventions
          • File Names
          • Function Names
          • Variable Names
          • Member Names
          • Class/Struct Names
          • Alias/Typedef Names
          • Namespace Names
          • Example
        • Const Keyword
        • Code Format
        • Header Guards
      • Git Workflow
        • Git Credentials
        • Downloading the Code
        • Branching Model
          • Feature Branches
          • Bugfix Branches
          • Release Candidate Branches
          • Hotfix Branches
          • Documentation Branches
        • Keeping Your Branch Current
        • Branching off of a Branch
        • Submitting a Pull Request
        • Keeping Submodules Current
        • Working on the Submodules
        • Resolving Submodule Changes in Primary Branch PRs
      • Sphinx Documentation
        • Generating the documentation
        • Documenting the code
        • Fixing errors the documentation
      • Doxygen Documentation
        • Accessing
          • Build locally
          • On readthedocs
        • Guidelines
          • What to document
          • How to document
        • Example
        • Current Doxygen
      • Unit Testing
        • GEOS Specific Recommendations
        • MPI
      • Contributing Input Files
      • Integrated Tests
        • About
        • Structure
        • How to Run the Tests
          • GEOS CI Pipeline
          • Manual Test Runs
          • Override Test Behavior
          • Machine Definitions
          • Test Filtering
        • Inspecting Test Results
          • Test Output
        • Restart Check
          • Scalar Error Example
          • Array Error Example
          • The .diff.hdf5 File
        • Curve Check
          • Item Not Found Errors
        • Adding and Modifying Tests
          • ATS Configuration File
          • Creating a New Test Directory
        • Rebaselining Tests
        • Tips
      • Benchmarks
        • Running the benchmarks
        • Specifying a benchmark
          • The Run block
        • Adding a benchmark problem
        • Viewing the results
      • Basic profiling with CALIPER
        • GEOS/Caliper Annotation Macros
        • Configuring Caliper
        • Using Adiak
        • Using Spot
        • Opening Spot caliper files in Python
      • [Best effort] Developing inside Docker with precompiled TPL binaries
      • [Best effort] Installing GEOS on Windows machines using Docker
        • 1. Install Docker Desktop
        • 2. Start Docker Desktop
        • 3. Preparing DockerFile
        • 4. Build the image and run the container
        • 5. Running a case
      • How to work interactively on the CI Machines
        • Step 1: Adding a GHA to establish a connection
        • Step 2: Inspect the CI and grab server address
        • Step 3: Connect to the machine via ssh
        • Step 4: Run the docker container interactively
        • Step 5: Cancel the workflow
    • Code Components
      • Data Repository
        • Group
          • Implementation Details
          • Interface Functions
            • Adding New Groups
            • Getting Groups
            • Register Wrappers
            • Getting Wrappers/Wrapped Objects
            • Looping Interface
          • Doxygen API documentation
        • Wrapper
          • Description
          • Attributes
          • Default Values
          • Doxygen API documentation
        • ObjectCatalog
          • Implementation Details
            • CatalogInterface
            • CatalogEntry
            • CatalogEntryConstructor
          • Usage
            • Creating A New Catalog
            • Adding A New Type To The Catalog
            • Allocating A New Object From The Catalog
        • Mapped Vector
          • Description
          • Element access
          • Doxygen API documentation
        • Log levels documentation
          • Add a log level
          • Example of usage
      • XML Input
        • GEOS data structure overview
          • Group : the base class of GEOS
          • A few words about the ObjectCatalog
          • Registration: parsing XML input files to instantiate GEOS objects
            • Creating a new object and giving it a Catalog name
            • Parsing XML and searching the ObjectCatalog in scope
            • Instantiating the new solver
            • Filling the objects with data (wrappers)
          • To summarize:
        • Example: adding a new relative permeability model
          • Implement a CatalogName function (.hpp):
          • Declare the Wrapper s keys (.hpp):
          • Declare data members (.hpp):
          • Implement the data registration process (registerWrapper):
          • The XML block
        • Input Schema Generation
      • Working with data in GEOS
        • Working with data on the Mesh objects
          • Registering Intrinsic data on a Mesh Object
          • Registering Field data on a Mesh Object
      • Mesh Hierarchy
        • DomainPartition
        • MeshBody
        • MeshLevel
        • Topological Mesh Objects
          • ElementRegionManager
            • ElementRegion
      • DoF Manager
        • Brief description
        • Methods
        • Example
        • Real mesh and patterns
      • LvArray
        • Use in GEOS
        • LvArray documentation
      • Kernel interface
        • Finite Element Method Kernel Interface
          • A Generic Element Looping Pattern
          • The KernelBase::kernelLaunch Interface
      • Constitutive models
        • Standalone models
          • Storage, allocation, and update of properties
        • Compound models
          • Coupled Solids
      • PVT Package Hierarchy
      • Adding a new Physics Solver
        • LaplaceFEM overview
          • Declaration file (reference)
            • class enums and variables (reference)
            • viewKeyStruct structure (reference)
          • Implementation File (reference)
        • Start doing your own Physic solver
          • Declaration File
          • Implementation File
        • Last steps
  • Doxygen
  • Build Guide
    • System prerequisites
      • List of prerequisites
      • Installing prerequisites
    • Third-party dependencies
      • List of third-party libraries and tools
        • Libraries
        • Tools
      • Building bundled dependencies
      • Installing dependencies individually
    • Building GEOS
      • Build steps
      • Configuration options
    • Spack and Uberenv
      • spack.yaml
        • spack.yaml from scratch
        • Required package versions in spack.yaml
      • Uberenv configuration file
      • pygeosx
      • Build Configuration
      • Host-Config Generation
      • LC TPL Build Script
      • Adding a Dependency (Advanced)
    • Continuous Integration process
      • Building docker images
      • Docker images contract
    • Building Apple MacOS
      • Install homebrew
      • Install packages using homebrew
      • Clone GEOS
      • Clone thirdPartyLibs
      • Configure and build thirdPartyLibs
      • Build GEOS
  • Datastructure Index
    • Input Schema Definitions
      • XML Element: AcousticElasticSEM
      • XML Element: AcousticFirstOrderSEM
      • XML Element: AcousticSEM
      • XML Element: AcousticVTISEM
      • XML Element: Aquifer
      • XML Element: Benchmarks
      • XML Element: BiotPorosity
      • XML Element: BlackOilFluid
      • XML Element: Blueprint
      • XML Element: Box
      • XML Element: BrooksCoreyBakerRelativePermeability
      • XML Element: BrooksCoreyCapillaryPressure
      • XML Element: BrooksCoreyRelativePermeability
      • XML Element: BrooksCoreyStone2RelativePermeability
      • XML Element: CO2BrineEzrokhiFluid
      • XML Element: CO2BrineEzrokhiThermalFluid
      • XML Element: CO2BrinePhillipsFluid
      • XML Element: CO2BrinePhillipsThermalFluid
      • XML Element: CarmanKozenyPermeability
      • XML Element: CellElementRegion
      • XML Element: CellToCellDataCollection
      • XML Element: CeramicDamage
      • XML Element: ChomboIO
      • XML Element: CompositeFunction
      • XML Element: CompositionalMultiphaseFVM
      • XML Element: CompositionalMultiphaseFluid
      • XML Element: CompositionalMultiphaseHybridFVM
      • XML Element: CompositionalMultiphaseReservoir
      • XML Element: CompositionalMultiphaseReservoirPoromechanics
      • XML Element: CompositionalMultiphaseReservoirPoromechanicsInitialization
      • XML Element: CompositionalMultiphaseStatistics
      • XML Element: CompositionalMultiphaseWell
      • XML Element: CompositionalThreePhaseFluidLohrenzBrayClark
      • XML Element: CompositionalTwoPhaseFluid
      • XML Element: CompositionalTwoPhaseFluidLohrenzBrayClark
      • XML Element: CompressibleSinglePhaseFluid
      • XML Element: CompressibleSolidCarmanKozenyPermeability
      • XML Element: CompressibleSolidConstantPermeability
      • XML Element: CompressibleSolidExponentialDecayPermeability
      • XML Element: CompressibleSolidParallelPlatesPermeability
      • XML Element: CompressibleSolidPressurePermeability
      • XML Element: CompressibleSolidSlipDependentPermeability
      • XML Element: CompressibleSolidWillisRichardsPermeability
      • XML Element: ConstantDiffusion
      • XML Element: ConstantPermeability
      • XML Element: Constitutive
      • XML Element: Coulomb
      • XML Element: CustomPolarObject
      • XML Element: Cylinder
      • XML Element: DamageElasticIsotropic
      • XML Element: DamagePermeability
      • XML Element: DamageSpectralElasticIsotropic
      • XML Element: DamageVolDevElasticIsotropic
      • XML Element: DeadOilFluid
      • XML Element: DelftEgg
      • XML Element: Dirichlet
      • XML Element: Disc
      • XML Element: DruckerPrager
      • XML Element: ElasticFirstOrderSEM
      • XML Element: ElasticIsotropic
      • XML Element: ElasticIsotropicPressureDependent
      • XML Element: ElasticOrthotropic
      • XML Element: ElasticSEM
      • XML Element: ElasticTransverseIsotropic
      • XML Element: ElementRegions
      • XML Element: EmbeddedSurfaceGenerator
      • XML Element: Events
      • XML Element: ExplicitQuasiDynamicEQ
      • XML Element: ExplicitSpringSlider
      • XML Element: ExponentialDecayPermeability
      • XML Element: ExtendedDruckerPrager
      • XML Element: ExternalDataSource
      • XML Element: FieldSpecification
      • XML Element: FieldSpecifications
      • XML Element: File
      • XML Element: FiniteElementSpace
      • XML Element: FiniteElements
      • XML Element: FiniteVolume
      • XML Element: FlowProppantTransport
      • XML Element: FrictionlessContact
      • XML Element: Functions
      • XML Element: Geometry
      • XML Element: HaltEvent
      • XML Element: HybridMimeticDiscretization
      • XML Element: HydraulicApertureTable
      • XML Element: Hydrofracture
      • XML Element: HydrofractureInitialization
      • XML Element: HydrostaticEquilibrium
      • XML Element: ImmiscibleMultiphaseFlow
      • XML Element: ImplicitQuasiDynamicEQ
      • XML Element: ImplicitSpringSlider
      • XML Element: Included
      • XML Element: InternalMesh
      • XML Element: InternalWell
      • XML Element: InternalWellbore
      • XML Element: JFunctionCapillaryPressure
      • XML Element: LaplaceFEM
      • XML Element: LinearIsotropicDispersion
      • XML Element: LinearSolverParameters
      • XML Element: Mesh
      • XML Element: ModifiedCamClay
      • XML Element: MultiPhaseConstantThermalConductivity
      • XML Element: MultiPhaseVolumeWeightedThermalConductivity
      • XML Element: MultiphasePoromechanics
      • XML Element: MultiphasePoromechanicsConformingFractures
      • XML Element: MultiphasePoromechanicsConformingFracturesInitialization
      • XML Element: MultiphasePoromechanicsInitialization
      • XML Element: MultiphasePoromechanicsReservoir
      • XML Element: MultivariableTableFunction
      • XML Element: NonlinearSolverParameters
      • XML Element: NullModel
      • XML Element: NumericalMethods
      • XML Element: OneWayCoupledFractureFlowContactMechanics
      • XML Element: Outputs
      • XML Element: PML
      • XML Element: PVTDriver
      • XML Element: PackCollection
      • XML Element: ParallelPlatesPermeability
      • XML Element: Parameter
      • XML Element: Parameters
      • XML Element: ParticleFluid
      • XML Element: ParticleMesh
      • XML Element: ParticleRegion
      • XML Element: ParticleRegions
      • XML Element: PerfectlyPlastic
      • XML Element: Perforation
      • XML Element: PeriodicEvent
      • XML Element: PhaseFieldDamageFEM
      • XML Element: PhaseFieldFracture
      • XML Element: PhaseFieldPoromechanics
      • XML Element: PorousDamageElasticIsotropic
      • XML Element: PorousDamageSpectralElasticIsotropic
      • XML Element: PorousDamageVolDevElasticIsotropic
      • XML Element: PorousDelftEgg
      • XML Element: PorousDruckerPrager
      • XML Element: PorousElasticIsotropic
      • XML Element: PorousElasticOrthotropic
      • XML Element: PorousElasticTransverseIsotropic
      • XML Element: PorousExtendedDruckerPrager
      • XML Element: PorousModifiedCamClay
      • XML Element: PorousViscoDruckerPrager
      • XML Element: PorousViscoExtendedDruckerPrager
      • XML Element: PorousViscoModifiedCamClay
      • XML Element: PressurePermeability
      • XML Element: PressurePorosity
      • XML Element: Problem
      • XML Element: ProppantPermeability
      • XML Element: ProppantPorosity
      • XML Element: ProppantSlurryFluid
      • XML Element: ProppantSolidProppantPermeability
      • XML Element: ProppantTransport
      • XML Element: Python
      • XML Element: RateAndStateFrictionAgingLaw
      • XML Element: RateAndStateFrictionSlipLaw
      • XML Element: ReactiveBrine
      • XML Element: ReactiveBrineThermal
      • XML Element: ReactiveCompositionalMultiphaseOBL
      • XML Element: ReactiveFluidDriver
      • XML Element: Rectangle
      • XML Element: Region
      • XML Element: RelpermDriver
      • XML Element: Restart
      • XML Element: Run
      • XML Element: SeismicityRate
      • XML Element: Silo
      • XML Element: SinglePhaseFVM
      • XML Element: SinglePhaseHybridFVM
      • XML Element: SinglePhasePoromechanics
      • XML Element: SinglePhasePoromechanicsConformingFractures
      • XML Element: SinglePhasePoromechanicsConformingFracturesInitialization
      • XML Element: SinglePhasePoromechanicsConformingFracturesReservoir
      • XML Element: SinglePhasePoromechanicsEmbeddedFractures
      • XML Element: SinglePhasePoromechanicsEmbeddedFracturesInitialization
      • XML Element: SinglePhasePoromechanicsInitialization
      • XML Element: SinglePhasePoromechanicsReservoir
      • XML Element: SinglePhaseProppantFVM
      • XML Element: SinglePhaseReservoir
      • XML Element: SinglePhaseReservoirPoromechanics
      • XML Element: SinglePhaseReservoirPoromechanicsConformingFractures
      • XML Element: SinglePhaseReservoirPoromechanicsConformingFracturesInitialization
      • XML Element: SinglePhaseReservoirPoromechanicsInitialization
      • XML Element: SinglePhaseStatistics
      • XML Element: SinglePhaseThermalConductivity
      • XML Element: SinglePhaseWell
      • XML Element: SlipDependentPermeability
      • XML Element: SolidInternalEnergy
      • XML Element: SolidMechanicsAugmentedLagrangianContact
      • XML Element: SolidMechanicsEmbeddedFractures
      • XML Element: SolidMechanicsLagrangeContact
      • XML Element: SolidMechanicsLagrangeContactBubbleStab
      • XML Element: SolidMechanicsLagrangianFEM
      • XML Element: SolidMechanicsStateReset
      • XML Element: SolidMechanicsStatistics
      • XML Element: SolidMechanics_MPM
      • XML Element: SoloEvent
      • XML Element: Solvers
      • XML Element: SourceFlux
      • XML Element: SourceFluxStatistics
      • XML Element: SurfaceElementRegion
      • XML Element: SurfaceGenerator
      • XML Element: SymbolicFunction
      • XML Element: TableCapillaryPressure
      • XML Element: TableFunction
      • XML Element: TableRelativePermeability
      • XML Element: TableRelativePermeabilityHysteresis
      • XML Element: Tasks
      • XML Element: ThermalCompressibleSinglePhaseFluid
      • XML Element: ThickPlane
      • XML Element: TimeHistory
      • XML Element: Traction
      • XML Element: TriaxialDriver
      • XML Element: TwoPhaseImmiscibleFluid
      • XML Element: TwoPointFluxApproximation
      • XML Element: VTK
      • XML Element: VTKHierarchicalDataSource
      • XML Element: VTKMesh
      • XML Element: VTKWell
      • XML Element: VanGenuchtenBakerRelativePermeability
      • XML Element: VanGenuchtenCapillaryPressure
      • XML Element: VanGenuchtenStone2RelativePermeability
      • XML Element: ViscoDruckerPrager
      • XML Element: ViscoExtendedDruckerPrager
      • XML Element: ViscoModifiedCamClay
      • XML Element: WellControls
      • XML Element: WellElementRegion
      • XML Element: WillisRichardsPermeability
      • XML Element: crusher
      • XML Element: lassen
      • XML Element: quartz
    • Datastructure Definitions
      • Datastructure: AcousticElasticSEM
      • Datastructure: AcousticFirstOrderSEM
      • Datastructure: AcousticSEM
      • Datastructure: AcousticVTISEM
      • Datastructure: Aquifer
      • Datastructure: Benchmarks
      • Datastructure: BiotPorosity
      • Datastructure: BlackOilFluid
      • Datastructure: Blueprint
      • Datastructure: Box
      • Datastructure: BrooksCoreyBakerRelativePermeability
      • Datastructure: BrooksCoreyCapillaryPressure
      • Datastructure: BrooksCoreyRelativePermeability
      • Datastructure: BrooksCoreyStone2RelativePermeability
      • Datastructure: CO2BrineEzrokhiFluid
      • Datastructure: CO2BrineEzrokhiThermalFluid
      • Datastructure: CO2BrinePhillipsFluid
      • Datastructure: CO2BrinePhillipsThermalFluid
      • Datastructure: CarmanKozenyPermeability
      • Datastructure: CellElementRegion
      • Datastructure: CellToCellDataCollection
      • Datastructure: CeramicDamage
      • Datastructure: ChomboIO
      • Datastructure: CompositeFunction
      • Datastructure: CompositionalMultiphaseFVM
      • Datastructure: CompositionalMultiphaseFluid
      • Datastructure: CompositionalMultiphaseHybridFVM
      • Datastructure: CompositionalMultiphaseReservoir
      • Datastructure: CompositionalMultiphaseReservoirPoromechanics
      • Datastructure: CompositionalMultiphaseReservoirPoromechanicsInitialization
      • Datastructure: CompositionalMultiphaseStatistics
      • Datastructure: CompositionalMultiphaseWell
      • Datastructure: CompositionalThreePhaseFluidLohrenzBrayClark
      • Datastructure: CompositionalTwoPhaseFluid
      • Datastructure: CompositionalTwoPhaseFluidLohrenzBrayClark
      • Datastructure: CompressibleSinglePhaseFluid
      • Datastructure: CompressibleSolidCarmanKozenyPermeability
      • Datastructure: CompressibleSolidConstantPermeability
      • Datastructure: CompressibleSolidExponentialDecayPermeability
      • Datastructure: CompressibleSolidParallelPlatesPermeability
      • Datastructure: CompressibleSolidPressurePermeability
      • Datastructure: CompressibleSolidSlipDependentPermeability
      • Datastructure: CompressibleSolidWillisRichardsPermeability
      • Datastructure: ConstantDiffusion
      • Datastructure: ConstantPermeability
      • Datastructure: Constitutive
      • Datastructure: ConstitutiveModels
      • Datastructure: Coulomb
      • Datastructure: CustomPolarObject
      • Datastructure: Cylinder
      • Datastructure: DamageElasticIsotropic
      • Datastructure: DamagePermeability
      • Datastructure: DamageSpectralElasticIsotropic
      • Datastructure: DamageVolDevElasticIsotropic
      • Datastructure: DeadOilFluid
      • Datastructure: DelftEgg
      • Datastructure: Dirichlet
      • Datastructure: Disc
      • Datastructure: DruckerPrager
      • Datastructure: ElasticFirstOrderSEM
      • Datastructure: ElasticIsotropic
      • Datastructure: ElasticIsotropicPressureDependent
      • Datastructure: ElasticOrthotropic
      • Datastructure: ElasticSEM
      • Datastructure: ElasticTransverseIsotropic
      • Datastructure: ElementRegions
      • Datastructure: EmbeddedSurfaceGenerator
      • Datastructure: Events
      • Datastructure: ExplicitQuasiDynamicEQ
      • Datastructure: ExplicitSpringSlider
      • Datastructure: ExponentialDecayPermeability
      • Datastructure: ExtendedDruckerPrager
      • Datastructure: ExternalDataSource
      • Datastructure: FieldSpecification
      • Datastructure: FieldSpecifications
      • Datastructure: File
      • Datastructure: FiniteElementSpace
      • Datastructure: FiniteElements
      • Datastructure: FiniteVolume
      • Datastructure: FlowProppantTransport
      • Datastructure: FrictionlessContact
      • Datastructure: Functions
      • Datastructure: Geometry
      • Datastructure: HaltEvent
      • Datastructure: HybridMimeticDiscretization
      • Datastructure: HydraulicApertureTable
      • Datastructure: Hydrofracture
      • Datastructure: HydrofractureInitialization
      • Datastructure: HydrostaticEquilibrium
      • Datastructure: ImmiscibleMultiphaseFlow
      • Datastructure: ImplicitQuasiDynamicEQ
      • Datastructure: ImplicitSpringSlider
      • Datastructure: Included
      • Datastructure: InternalMesh
      • Datastructure: InternalWell
      • Datastructure: InternalWellbore
      • Datastructure: JFunctionCapillaryPressure
      • Datastructure: LaplaceFEM
      • Datastructure: Level0
      • Datastructure: LinearIsotropicDispersion
      • Datastructure: LinearSolverParameters
      • Datastructure: Mesh
      • Datastructure: MeshBodies
      • Datastructure: ModifiedCamClay
      • Datastructure: MultiPhaseConstantThermalConductivity
      • Datastructure: MultiPhaseVolumeWeightedThermalConductivity
      • Datastructure: MultiphasePoromechanics
      • Datastructure: MultiphasePoromechanicsConformingFractures
      • Datastructure: MultiphasePoromechanicsConformingFracturesInitialization
      • Datastructure: MultiphasePoromechanicsInitialization
      • Datastructure: MultiphasePoromechanicsReservoir
      • Datastructure: MultivariableTableFunction
      • Datastructure: NonlinearSolverParameters
      • Datastructure: NullModel
      • Datastructure: NumericalMethods
      • Datastructure: OneWayCoupledFractureFlowContactMechanics
      • Datastructure: Outputs
      • Datastructure: PML
      • Datastructure: PVTDriver
      • Datastructure: PackCollection
      • Datastructure: ParallelPlatesPermeability
      • Datastructure: Parameter
      • Datastructure: Parameters
      • Datastructure: ParticleFluid
      • Datastructure: ParticleMesh
      • Datastructure: ParticleRegion
      • Datastructure: ParticleRegions
      • Datastructure: PerfectlyPlastic
      • Datastructure: Perforation
      • Datastructure: PeriodicEvent
      • Datastructure: PhaseFieldDamageFEM
      • Datastructure: PhaseFieldFracture
      • Datastructure: PhaseFieldPoromechanics
      • Datastructure: PorousDamageElasticIsotropic
      • Datastructure: PorousDamageSpectralElasticIsotropic
      • Datastructure: PorousDamageVolDevElasticIsotropic
      • Datastructure: PorousDelftEgg
      • Datastructure: PorousDruckerPrager
      • Datastructure: PorousElasticIsotropic
      • Datastructure: PorousElasticOrthotropic
      • Datastructure: PorousElasticTransverseIsotropic
      • Datastructure: PorousExtendedDruckerPrager
      • Datastructure: PorousModifiedCamClay
      • Datastructure: PorousViscoDruckerPrager
      • Datastructure: PorousViscoExtendedDruckerPrager
      • Datastructure: PorousViscoModifiedCamClay
      • Datastructure: PressurePermeability
      • Datastructure: PressurePorosity
      • Datastructure: Problem
      • Datastructure: ProppantPermeability
      • Datastructure: ProppantPorosity
      • Datastructure: ProppantSlurryFluid
      • Datastructure: ProppantSolidProppantPermeability
      • Datastructure: ProppantTransport
      • Datastructure: Python
      • Datastructure: RateAndStateFrictionAgingLaw
      • Datastructure: RateAndStateFrictionSlipLaw
      • Datastructure: ReactiveBrine
      • Datastructure: ReactiveBrineThermal
      • Datastructure: ReactiveCompositionalMultiphaseOBL
      • Datastructure: ReactiveFluidDriver
      • Datastructure: Rectangle
      • Datastructure: Region
      • Datastructure: RelpermDriver
      • Datastructure: Restart
      • Datastructure: Run
      • Datastructure: SeismicityRate
      • Datastructure: Silo
      • Datastructure: SinglePhaseFVM
      • Datastructure: SinglePhaseHybridFVM
      • Datastructure: SinglePhasePoromechanics
      • Datastructure: SinglePhasePoromechanicsConformingFractures
      • Datastructure: SinglePhasePoromechanicsConformingFracturesInitialization
      • Datastructure: SinglePhasePoromechanicsConformingFracturesReservoir
      • Datastructure: SinglePhasePoromechanicsEmbeddedFractures
      • Datastructure: SinglePhasePoromechanicsEmbeddedFracturesInitialization
      • Datastructure: SinglePhasePoromechanicsInitialization
      • Datastructure: SinglePhasePoromechanicsReservoir
      • Datastructure: SinglePhaseProppantFVM
      • Datastructure: SinglePhaseReservoir
      • Datastructure: SinglePhaseReservoirPoromechanics
      • Datastructure: SinglePhaseReservoirPoromechanicsConformingFractures
      • Datastructure: SinglePhaseReservoirPoromechanicsConformingFracturesInitialization
      • Datastructure: SinglePhaseReservoirPoromechanicsInitialization
      • Datastructure: SinglePhaseStatistics
      • Datastructure: SinglePhaseThermalConductivity
      • Datastructure: SinglePhaseWell
      • Datastructure: SlipDependentPermeability
      • Datastructure: SolidInternalEnergy
      • Datastructure: SolidMechanicsAugmentedLagrangianContact
      • Datastructure: SolidMechanicsEmbeddedFractures
      • Datastructure: SolidMechanicsLagrangeContact
      • Datastructure: SolidMechanicsLagrangeContactBubbleStab
      • Datastructure: SolidMechanicsLagrangianFEM
      • Datastructure: SolidMechanicsStateReset
      • Datastructure: SolidMechanicsStatistics
      • Datastructure: SolidMechanics_MPM
      • Datastructure: SoloEvent
      • Datastructure: SolverStatistics
      • Datastructure: Solvers
      • Datastructure: SourceFlux
      • Datastructure: SourceFluxStatistics
      • Datastructure: SurfaceElementRegion
      • Datastructure: SurfaceGenerator
      • Datastructure: SymbolicFunction
      • Datastructure: TableCapillaryPressure
      • Datastructure: TableFunction
      • Datastructure: TableRelativePermeability
      • Datastructure: TableRelativePermeabilityHysteresis
      • Datastructure: Tasks
      • Datastructure: ThermalCompressibleSinglePhaseFluid
      • Datastructure: ThickPlane
      • Datastructure: TimeHistory
      • Datastructure: Traction
      • Datastructure: TriaxialDriver
      • Datastructure: TwoPhaseImmiscibleFluid
      • Datastructure: TwoPointFluxApproximation
      • Datastructure: VTK
      • Datastructure: VTKHierarchicalDataSource
      • Datastructure: VTKMesh
      • Datastructure: VTKWell
      • Datastructure: VanGenuchtenBakerRelativePermeability
      • Datastructure: VanGenuchtenCapillaryPressure
      • Datastructure: VanGenuchtenStone2RelativePermeability
      • Datastructure: ViscoDruckerPrager
      • Datastructure: ViscoExtendedDruckerPrager
      • Datastructure: ViscoModifiedCamClay
      • Datastructure: WellControls
      • Datastructure: WellElementRegion
      • Datastructure: WellElementRegionUniqueSubRegion
      • Datastructure: WillisRichardsPermeability
      • Datastructure: commandLine
      • Datastructure: crusher
      • Datastructure: domain
      • Datastructure: edgeManager
      • Datastructure: elementRegionsGroup
      • Datastructure: elementSubRegions
      • Datastructure: embeddedSurfacesEdgeManager
      • Datastructure: embeddedSurfacesNodeManager
      • Datastructure: faceManager
      • Datastructure: lassen
      • Datastructure: meshLevels
      • Datastructure: neighborData
      • Datastructure: nodeManager
      • Datastructure: particleRegionsGroup
      • Datastructure: particleSubRegions
      • Datastructure: quartz
      • Datastructure: sets
      • Datastructure: wellElementSubRegion
  • Contributors
  • Publications
    • Preprints and Early-Views
    • 2024
    • 2023
    • 2022
    • 2021
    • 2020
    • 2019
  • Acknowledgements
GEOS
  • Developer Guide
  • Code Components
  • View page source

Code Components

The main code components are described here.

  • Data Repository
    • Group
    • Wrapper
    • ObjectCatalog
    • Mapped Vector
    • Log levels documentation
  • XML Input
    • GEOS data structure overview
    • Example: adding a new relative permeability model
    • Input Schema Generation
  • Working with data in GEOS
    • Working with data on the Mesh objects
  • Mesh Hierarchy
    • DomainPartition
    • MeshBody
    • MeshLevel
    • Topological Mesh Objects
  • DoF Manager
    • Brief description
    • Methods
    • Example
    • Real mesh and patterns
  • LvArray
    • Use in GEOS
    • LvArray documentation
  • Kernel interface
    • Finite Element Method Kernel Interface
  • Constitutive models
    • Standalone models
    • Compound models
  • PVT Package Hierarchy
  • Adding a new Physics Solver
    • LaplaceFEM overview
    • Start doing your own Physic solver
    • Last steps
Previous Next

© Copyright 2016-2024 Lawrence Livermore National Security LLC, 2018-2024 Total Energies, The Board of Trustees of the Leland Stanford Junior University, 2023-2024 Chevron, 2019- GEOS/GEOSX Contributors.

Built with Sphinx using a theme provided by Read the Docs.