This folder contains tutorials to demonstrate how PorePy can be utilized. To follow the tutorials, you can clone the repository and run the files as Jupyter notebooks.
The tutorials are divided into two sections, where the first section is oriented towards usage of PorePy as it is. In practice, this means running the existing simulation models and making only minor adjustments, such as modifying boundary conditions, sources, initial conditions, material parameters, etc. We recommend new users to familiarize themselves with this section.
The second section includes more specific tutorials and is recommended to those who aim to use PorePy in a more advanced way or contribute to it. New users may skip this section.
The PorePy tutorials are designed as stand-alone documentation of different components and capabilities. Below we suggest an order in which to read the tutorials. It should however be noted that the appropriate order of reading may depend on the reader's background and ambitions.
- Introduction describes the overarching conceptual framework and its high-level implementation. It also lists some problems which may be solved using PorePy.
- Grids describes the structure of individual grids and demonstrates construction of different types of grids. It also shows how to access and manipulate grid quantities.
- Grid topology covers how to access various topological properties of grids in PorePy. This includes the relation between cells, faces and nodes, as well as the direction of the face normal vectors.
- Mixed-dimensional grids describes the construction of mixed-dimensional grids. These grids represent a fracture network and the surrounding porous medium.
- Conventions defines some conventions used in PorePy. Specifically this is related to signs, boundary conditions etc.
- Single phase flow is where we introduce PorePy model classes and show how to run a simulation. It also covers how to do minor adjustments in a model.
- Poromechanics covers the concept of setting up a multiphysics simulation by reusing single-physics model classes.
For the more experienced user, some more specific tutorials are also available:
- Exporter documents how to export data from PorePy for external visualization (e.g. ParaView). Several examples of exporting is demonstrated.
- Exporting in models shows how one can export data for visualization in PorePy model-based simulations.
- Diagnostics provides a description of how to use the diagnostics tool in PorePy. The tool allows for visualizing properties of the discretized system of equations in PorePy.
- Equations briefly covers some general basics about automatic differentiation (AD). It mainly covers how AD is extensively used in PorePy equations, which means that it is most useful for the users that want to define their own equations.
- Mandel's problem shows how to set up and run the Mandel's consolidation problem based on the Biot equations of poroelasticity.
- Flux discretizations shows different discretization methods available for diffusive fluxes. These are used for Darcy's law for fluid fluxes in a mass balance equation.
- Stress discretization describes the discretization method used for the vector version of 13. that arises in the stress-strain relationship of Hooke's law.