Skip to content

Latest commit

 

History

History
 
 

tutorials

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
data
data
 
 
fig
fig
 
 
Readme.md
Readme.md
 
 
ad_framework.ipynb
ad_framework.ipynb
 
 
automatic_differentiation.ipynb
automatic_differentiation.ipynb
 
 
compressible_flow_with_automatic_differentiation.ipynb
compressible_flow_with_automatic_differentiation.ipynb
 
 
conventions.ipynb
conventions.ipynb
 
 
convert_file.py
convert_file.py
 
 
darcy_and_transport_equations.ipynb
darcy_and_transport_equations.ipynb
 
 
get_started.ipynb
get_started.ipynb
 
 
grid_structure.ipynb
grid_structure.ipynb
 
 
introduction.ipynb
introduction.ipynb
 
 
meshing_of_fractures.ipynb
meshing_of_fractures.ipynb
 
 
mpfa.ipynb
mpfa.ipynb
 
 
mpsa.ipynb
mpsa.ipynb
 
 
network.csv
network.csv
 
 
parameter_assignment_assembler_setup.ipynb
parameter_assignment_assembler_setup.ipynb
 
 
single-phase_flow.ipynb
single-phase_flow.ipynb
 
 
tracer_transport.ipynb
tracer_transport.ipynb
 
 

Readme.md

Tutorials

This folder contains tutorials that show the basic workings of PorePy. To follow the tutorials, you can download the files (either by cloning the repository, or download the individual files), and run them as Jupyter Notebooks.

In addition to the tutorials contained herein, we are working on providing more advanced examples that further illustrate the usage of PorePy.

Overview

The PorePy tutorials are designed as stand-alone documentation of different components and capabilities. The appropriate order of reading may depend on the reader's background and ambitions. However, the following may serve as a general suggestion:

  1. introduction describes the overarching conceptual framework and its high-level implementation and lists some problems which may be solved using PorePy.
  2. grid_structure describes the structure of individual grids. Shows construction of different types of grids. Also dives into the data structure, and shows how to access and manipulate grid quantities.
  3. meshing_of_fractures describes the construction of grid buckets for mixed-dimensional grids.
  4. single_phase_flow shows different discretization methods available for the pressure equation.
  5. ad_framework describes how to solve a problem using the AD framework. The tutorial includes setup of parameters and discretizations.