diff --git a/docs/src/index.md b/docs/src/index.md index b725c06..5448da5 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -6,11 +6,24 @@ CurrentModule = GeoEnergyIO Documentation for [GeoEnergyIO](https://github.com/sintefmath/GeoEnergyIO.jl). +## Parsing of simulation cases + ```@docs parse_data_file +``` + +## Parsing and processing of corner-point grids + +```@docs parse_grdecl_file mesh_from_grid_section +``` + +## Utilities + +```@docs get_data_file_cell_region +number_of_tables ``` ```@index diff --git a/src/GeoEnergyIO.jl b/src/GeoEnergyIO.jl index 032b01d..1aced82 100644 --- a/src/GeoEnergyIO.jl +++ b/src/GeoEnergyIO.jl @@ -3,9 +3,10 @@ module GeoEnergyIO export parse_grdecl_file export mesh_from_grid_section export get_data_file_cell_region + export number_of_tables include("InputParser/InputParser.jl") - import .InputParser: parse_data_file, parse_grdecl_file, get_data_file_cell_region + import .InputParser: parse_data_file, parse_grdecl_file, get_data_file_cell_region, number_of_tables include("CornerPointGrid/CornerPointGrid.jl") import .CornerPointGrid: mesh_from_grid_section diff --git a/src/InputParser/utils.jl b/src/InputParser/utils.jl index 39895fc..56c6dab 100644 --- a/src/InputParser/utils.jl +++ b/src/InputParser/utils.jl @@ -484,6 +484,11 @@ function next_keyword!(f) return m end +""" + number_of_tables(outer_data, t::Symbol) + +Number of tables for given type `t`: one of `:satnum`, `:pvtnum` or `:eqlnum`. +""" function number_of_tables(outer_data, t::Symbol) rs = outer_data["RUNSPEC"] if haskey(rs, "TABDIMS")