GEOS Documentation
GEOS is a code framework focused on enabling streamlined development of physics simulations on high performance computing platforms. Our documentation is organized into several separate guides, given that different users will have different needs.
We recommend all users begin with the Quick Start guide, which will walk you through downloading and compiling the code. Application focused users may then want to explore our Tutorials, which provide an introduction to the basic capabilities of the code. More detailed descriptions of these capabilities can then be found in the User Guide.
For those interested in developing new capabilities in GEOS, we provide a Developer Guide. The code itself is also documented inline using doxygen. The Build Guide contains more detailed information about third-party dependencies, the build system, and the continuous integration system. Finally, GEOS has a self-documenting data structure. The Datastructure Index is an automatically generated list of all available input parameters and data structures in the code. This is a comprehensive resource, but probably not the place to start.
High quality documentation is a critical component of a successful code. If you have suggestions for improving the guides below, please post an issue on our issue tracker.
Quick Start Guide
New to GEOS? We will walk you through downloading the source, compiling the code, and testing the installation.
Tutorials
Working tutorials that show how to run some common problems. After going through these examples, you should have a good understanding of how to set up and solve your own models.
Basic Examples
Example problems that are organized around physical processes (fluid flow, mechanics, etc.).
Advanced Examples
Example problems that demonstrate additional physical models, constitutive models, advanced features, etc.
User Guide
Detailed instructions on how to construct input files, configure problems, manage outputs, etc.
Python Tools
Documentation for the python packages distributed alongside GEOS used to manage xml files, condition numerical meshes, read outputs, etc.
Feature Requests, Reporting Bugs, and Support
To make feature requests, report bugs, or get support (after reviewing the user guide) please submit an issue on Github.
Table of Contents
- Quick Start Guide
- Tutorials
- Basic Examples
- Advanced Examples
- User Guide
- Input Files
- Meshes
- Physics Solvers
- Constitutive Models
- Constitutive Drivers
- Initial and Boundary Conditions
- Event Management
- Tasks Manager
- Functions
- Poromechanical Models Intialization
- Linear Solvers
- Numerical Methods
- XML Element: NumericalMethods
- Parallel Partitioning
- Outputs
pygeosx— GEOS in Python- Indices and tables
- Developer Guide
- Doxygen
- Build Guide
- Datastructure Index
- Contributors
- Publications
- Acknowledgements