OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5853 from lisajulia/python-documentation

Browse Source 
Fix errors in documentation.
This commit is contained in:
Markus Blatt 2025-01-08 14:54:38 +01:00 committed by GitHub
commit 02bd7b43cb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
python/docstrings_simulators.json
View File

@ -2,7 +2,7 @@
"PyBlackOilSimulator":{ "PyBlackOilSimulator":{
"type": "class", "type": "class",
"signature": "opm.simulators.BlackOilSimulator", "signature": "opm.simulators.BlackOilSimulator",
"doc": "The SummaryState class - this is where the current summary results of the simulator are stored.\nThe SummaryState class has methods to get hold of well, group and general variables." "doc": "The BlackOilSimulator class to run simulations using a given Deck."
}, },
"PyBlackOilSimulator_filename_constructor": { "PyBlackOilSimulator_filename_constructor": {
"signature": "opm.simulators.BlackOilSimulator.__init__(deck_filename: str) -> None", "signature": "opm.simulators.BlackOilSimulator.__init__(deck_filename: str) -> None",
@ -66,7 +66,7 @@
}, },
"setupMpi": { "setupMpi": {
"signature": "opm.simulators.BlackOilSimulator.mpi_init(init: bool, finalize: bool) -> None", "signature": "opm.simulators.BlackOilSimulator.mpi_init(init: bool, finalize: bool) -> None",
"doc": "Sets MPI up for parallel simulation. This method should be called before any other method.\n:param init: Whether to call ``MPI_Init()`` or not.\n:param finalize:Whether to call ``MPI_Finalize()```when the simulator object goes out of scope.\n\n:return: None" "doc": "Sets MPI up for parallel simulation. This method should be called before any other method.\n\n:param init: Whether to call ``MPI_Init()`` or not.\n:param finalize: Whether to call ``MPI_Finalize()```when the simulator object goes out of scope.\n\n:return: None"
}, },
"step": { "step": {
"signature": "opm.simulators.BlackOilSimulator.step() -> int", "signature": "opm.simulators.BlackOilSimulator.step() -> int",