ogs5py API
Purpose
ogs5py is A python-API for the OpenGeoSys 5 scientific modeling package.
The following functionalities are directly provided on module-level.
Subpackages
ogs5py subpackage providing the file classes. |
|
ogs5py subpackage providing reader for the ogs5 output. |
|
ogs5py subpackage providing tools. |
Classes
OGS model Base Class
Class to setup an ogs model
|
Class for an OGS5 model. |
File Classes
Classes for all OGS5 Files. See: ogs5py.fileclasses
|
Class for the ogs ASC file. |
|
Class for the ogs BOUNDARY CONDITION file. |
|
Class for the ogs COMMUNICATION TABLE file. |
|
Class for the ogs MPI DOMAIN DECOMPOSITION file. |
|
Class for the ogs FUNCTION file. |
|
Class for the ogs GEOCHEMICAL THERMODYNAMIC MODELING COUPLING file. |
|
Class for GEMS3K input file. |
|
Class for the ogs GEOMETRY file. |
|
Class for an external definition for the ogs GEOMETRY file. |
|
Class for the ogs INITIAL_CONDITION file. |
|
Class for the ogs RESTART file, if the DIS_TYPE in IC is set to RESTART. |
|
Class for the ogs KINETRIC REACTION file. |
|
Class for the ogs COMPONENT_PROPERTIES file. |
|
Class for the ogs FLUID PROPERTY file. |
|
Class for the ogs MEDIUM_PROPERTIES file. |
|
Class for the ogs MEDIUM_PROPERTIES_DISTRIBUTED file. |
|
Class for a multi layer mesh file that contains multiple '#FEM_MSH' Blocks. |
|
Class for the ogs SOLID_PROPERTIES file. |
|
Class for the ogs NUMERICS file. |
|
Class for the ogs OUTPUT file. |
|
Class for the ogs PROCESS file. |
|
Class for the ogs Particle file, if the PCS TYPE is RANDOM_WALK. |
|
Class for the ogs PHREEQC interface file. |
|
Class for the ogs PHREEQC dat file. |
|
Class for the ogs REACTION_INTERFACE file. |
|
Class for the ogs USER DEFINED TIME CURVES file. |
|
Class for the ogs SOURCE_TERM file. |
|
Class for the ogs TIME_STEPPING file. |
Functions
Geometric
Geometric routines
|
Providing a transformation function to deform a given mesh. |
Searching
Routine to search for a valid ogs id in a directory
|
Search for OGS model names in the given path. |
Formatting
Routines to format/generate data in the right way for the input
|
Return a flattend array side-by-side with the array-element ids. |
|
Calculation of special point ranges. |
|
Return a dictionary for the ".tim" file. |
Downloading
Routine to download OGS5.
|
Download the OGS5 executable. |
|
Add an OGS5 exe to |
Reset all downloads in |
|
Standard config path for ogs5py. |
Plotting
Routine to download OGS5.
|
Display a given mesh colored by its material ID. |
Information
all ogs file extensions |
|
PCS types |
|
primary variables per PCS |