Developer Guide

Welcome to the GEOSX developer guide.

• Contributing
  • Code style
    • Introduction
    • Naming Conventions
    • Const Keyword
    • Code Format
    • Header Guards
  • Git Workflow
    • Git Credentials
    • Downloading the Code
    • Branching Model
    • 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
  • Doxygen Documentation
    • Accessing
    • Guidelines
    • Example
    • Current Doxygen
  • Unit Testing
    • GEOSX Specific Recommendations
    • MPI
  • Contributing Input Files
  • Integrated Tests
    • About
    • Structure
    • Arguments
    • How to Run the Tests
    • Output Created By a Test
    • The .ats File
    • Adding a Test
    • Rebaselining Tests
  • Benchmarks
    • Running the benchmarks
    • Specifying a benchmark
    • Adding a benchmark problem
    • Viewing the results
  • Basic profiling with CALIPER
    • GEOSX/Caliper Annotation Macros
    • Configuring Caliper
    • Using Adiak
    • Using Spot
    • Opening Spot caliper files in Python
  • [Unsupported] Developing inside Docker with precompiled TPL binaries
  • [Unsupported] Installing GEOSX 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
• Code Components
  • Data Repository
    • Mapped Vector
    • Group
    • Wrapper
    • ObjectCatalog
  • XML Input
    • GEOSX data structure overview
    • Example: adding a new relative permeability model
    • Input Schema Generation
  • Working with data in GEOSX
    • 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 GEOSX
    • 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