Change return type of other _init_ of the BlackOilSimulator class

This commit is contained in:
Lisa Julia Nebel 2025-01-14 10:58:12 +01:00
parent 9b3ea1936f
commit 6958abdbc2

View File

@ -9,8 +9,8 @@
"doc": "Constructor using a deck file name.\n\n:param deck_filename: The file name of the deck to be used for the simulation.\n:type deck_filename: str\n:return: The BlackOilSimulator.\n:type return: BlackOilSimulator" "doc": "Constructor using a deck file name.\n\n:param deck_filename: The file name of the deck to be used for the simulation.\n:type deck_filename: str\n:return: The BlackOilSimulator.\n:type return: BlackOilSimulator"
}, },
"PyBlackOilSimulator_objects_constructor": { "PyBlackOilSimulator_objects_constructor": {
"signature": "opm.simulators.BlackOilSimulator.__init__(deck: Deck, state: EclipseState, schedule: Schedule, summary_config: SummaryConfig) -> None", "signature": "opm.simulators.BlackOilSimulator.__init__(deck: Deck, state: EclipseState, schedule: Schedule, summary_config: SummaryConfig) -> BlackOilSimulator",
"doc": "Constructor using Deck, EclipseState, Schedule, and SummaryConfig objects.\n\n:param deck: Deck object.\n:type deck: Deck\n:param state: EclipseState object.\n:type state: EclipseState\n:param schedule: Schedule object.\n:type schedule: Schedule\n:param summary_config: SummaryConfig object.\n:type summary_config: SummaryConfig" "doc": "Constructor using Deck, EclipseState, Schedule, and SummaryConfig objects.\n\n:param deck: Deck object.\n:type deck: Deck\n:param state: EclipseState object.\n:type state: EclipseState\n:param schedule: Schedule object.\n:type schedule: Schedule\n:param summary_config: SummaryConfig object.\n:type summary_config: SummaryConfig\n:return: The BlackOilSimulator.\n:type return: BlackOilSimulator"
}, },
"advance": { "advance": {
"signature": "opm.simulators.BlackOilSimulator.advance(report_step: int) -> None", "signature": "opm.simulators.BlackOilSimulator.advance(report_step: int) -> None",