@@ -120,7 +120,7 @@ <h2>Documentation<a class="headerlink" href="#documentation" title="Link to this
120120
121121< dl class ="py method ">
122122< dt class ="sig sig-object py " id ="opm.simulators.BlackOilSimulator.__init__ ">
123- < span class ="sig-prename descclassname "> < span class ="pre "> opm.simulators.BlackOilSimulator.</ span > </ span > < span class ="sig-name descname "> < span class ="pre "> __init__</ span > </ span > < span class ="sig-paren "> (</ span > < em class ="sig-param "> < span class ="n "> < span class ="pre "> deck</ span > </ span > < span class ="p "> < span class ="pre "> :</ span > </ span > < span class ="w "> </ span > < span class ="n "> < a class ="reference internal " href ="common.html#Deck " title ="Deck "> < span class ="pre "> Deck</ span > </ a > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> state</ span > </ span > < span class ="p "> < span class ="pre "> :</ span > </ span > < span class ="w "> </ span > < span class ="n "> < a class ="reference internal " href ="common.html#opm.io.ecl_state.EclipseState " title ="opm.io.ecl_state.EclipseState "> < span class ="pre "> EclipseState</ span > </ a > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> schedule</ span > </ span > < span class ="p "> < span class ="pre "> :</ span > </ span > < span class ="w "> </ span > < span class ="n "> < a class ="reference internal " href ="common.html#opm.io.schedule.Schedule " title ="opm.io.schedule.Schedule "> < span class ="pre "> Schedule</ span > </ a > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> summary_config</ span > </ span > < span class ="p "> < span class ="pre "> :</ span > </ span > < span class ="w "> </ span > < span class ="n "> < a class ="reference internal " href ="common.html#opm.io.summary.SummaryConfig " title ="opm.io.summary.SummaryConfig "> < span class ="pre "> SummaryConfig</ span > </ a > </ span > </ em > < span class ="sig-paren "> )</ span > < span class ="sig-return "> < span class ="sig-return-icon "> →</ span > < span class ="sig-return-typehint "> < a class ="reference internal " href ="#opm.simulators.BlackOilSimulator " title ="opm.simulators.BlackOilSimulator "> < span class ="pre "> BlackOilSimulator</ span > </ a > </ span > </ span > < a class ="headerlink " href ="#opm.simulators.BlackOilSimulator.__init__ " title ="Link to this definition "> </ a > </ dt >
123+ < span class ="sig-prename descclassname "> < span class ="pre "> opm.simulators.BlackOilSimulator.</ span > </ span > < span class ="sig-name descname "> < span class ="pre "> __init__</ span > </ span > < span class ="sig-paren "> (</ span > < em class ="sig-param "> < span class ="n "> < span class ="pre "> deck</ span > </ span > < span class ="p "> < span class ="pre "> :</ span > </ span > < span class ="w "> </ span > < span class ="n "> < a class ="reference internal " href ="common.html#Deck " title ="Deck "> < span class ="pre "> Deck</ span > </ a > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> state</ span > </ span > < span class ="p "> < span class ="pre "> :</ span > </ span > < span class ="w "> </ span > < span class ="n "> < a class ="reference internal " href ="common.html#opm.io.ecl_state.EclipseState " title ="opm.io.ecl_state.EclipseState "> < span class ="pre "> EclipseState</ span > </ a > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> schedule</ span > </ span > < span class ="p "> < span class ="pre "> :</ span > </ span > < span class ="w "> </ span > < span class ="n "> < a class ="reference internal " href ="common.html#opm.io.schedule.Schedule " title ="opm.io.schedule.Schedule "> < span class ="pre "> Schedule</ span > </ a > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> summary_config</ span > </ span > < span class ="p "> < span class ="pre "> :</ span > </ span > < span class ="w "> </ span > < span class ="n "> < a class ="reference internal " href ="common.html#opm.io.summary.SummaryConfig " title ="opm.io.summary.SummaryConfig "> < span class ="pre "> SummaryConfig</ span > </ a > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> args</ span > </ span > < span class ="p "> < span class ="pre "> :</ span > </ span > < span class ="w "> </ span > < span class ="n "> < span class ="pre "> list</ span > < span class ="p "> < span class ="pre "> [</ span > </ span > < span class ="pre "> str</ span > < span class ="p "> < span class ="pre "> ]</ span > </ span > </ span > < span class ="w "> </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="w "> </ span > < span class ="default_value "> < span class ="pre "> []</ span > </ span > </ em > < span class ="sig-paren "> )</ span > < span class ="sig-return "> < span class ="sig-return-icon "> →</ span > < span class ="sig-return-typehint "> < a class ="reference internal " href ="#opm.simulators.BlackOilSimulator " title ="opm.simulators.BlackOilSimulator "> < span class ="pre "> BlackOilSimulator</ span > </ a > </ span > </ span > < a class ="headerlink " href ="#opm.simulators.BlackOilSimulator.__init__ " title ="Link to this definition "> </ a > </ dt >
124124< dd > < p > Constructor using Deck, EclipseState, Schedule, and SummaryConfig objects.</ p >
125125< dl class ="field-list simple ">
126126< dt class ="field-odd "> Parameters< span class ="colon "> :</ span > </ dt >
@@ -129,6 +129,7 @@ <h2>Documentation<a class="headerlink" href="#documentation" title="Link to this
129129< li > < p > < strong > state</ strong > (< a class ="reference internal " href ="common.html#opm.io.ecl_state.EclipseState " title ="opm.io.ecl_state.EclipseState "> < em > EclipseState</ em > </ a > ) – EclipseState object.</ p > </ li >
130130< li > < p > < strong > schedule</ strong > (< a class ="reference internal " href ="common.html#opm.io.schedule.Schedule " title ="opm.io.schedule.Schedule "> < em > Schedule</ em > </ a > ) – Schedule object.</ p > </ li >
131131< li > < p > < strong > summary_config</ strong > (< a class ="reference internal " href ="common.html#opm.io.summary.SummaryConfig " title ="opm.io.summary.SummaryConfig "> < em > SummaryConfig</ em > </ a > ) – SummaryConfig object.</ p > </ li >
132+ < li > < p > < strong > args</ strong > (< em > list</ em > < em > [</ em > < em > str</ em > < em > ]</ em > ) – Simulator options.</ p > </ li >
132133</ ul >
133134</ dd >
134135< dt class ="field-even "> Returns< span class ="colon "> :</ span > </ dt >
@@ -139,11 +140,14 @@ <h2>Documentation<a class="headerlink" href="#documentation" title="Link to this
139140
140141< dl class ="py method ">
141142< dt class ="sig sig-object py " id ="id0 ">
142- < span class ="sig-prename descclassname "> < span class ="pre "> opm.simulators.BlackOilSimulator.</ span > </ span > < span class ="sig-name descname "> < span class ="pre "> __init__</ span > </ span > < span class ="sig-paren "> (</ span > < em class ="sig-param "> < span class ="n "> < span class ="pre "> deck_filename</ span > </ span > < span class ="p "> < span class ="pre "> :</ span > </ span > < span class ="w "> </ span > < span class ="n "> < span class ="pre "> str</ span > </ span > </ em > < span class ="sig-paren "> )</ span > < span class ="sig-return "> < span class ="sig-return-icon "> →</ span > < span class ="sig-return-typehint "> < a class ="reference internal " href ="#opm.simulators.BlackOilSimulator " title ="opm.simulators.BlackOilSimulator "> < span class ="pre "> BlackOilSimulator</ span > </ a > </ span > </ span > < a class ="headerlink " href ="#id0 " title ="Link to this definition "> </ a > </ dt >
143+ < span class ="sig-prename descclassname "> < span class ="pre "> opm.simulators.BlackOilSimulator.</ span > </ span > < span class ="sig-name descname "> < span class ="pre "> __init__</ span > </ span > < span class ="sig-paren "> (</ span > < em class ="sig-param "> < span class ="n "> < span class ="pre "> deck_filename</ span > </ span > < span class ="p "> < span class ="pre "> :</ span > </ span > < span class ="w "> </ span > < span class ="n "> < span class ="pre "> str</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> args</ span > </ span > < span class ="p "> < span class ="pre "> :</ span > </ span > < span class ="w "> </ span > < span class ="n "> < span class ="pre "> list</ span > < span class ="p "> < span class ="pre "> [</ span > </ span > < span class ="pre "> str</ span > < span class ="p "> < span class ="pre "> ]</ span > </ span > </ span > < span class ="w "> </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="w "> </ span > < span class ="default_value "> < span class ="pre "> []</ span > </ span > </ em > < span class ="sig-paren "> )</ span > < span class ="sig-return "> < span class ="sig-return-icon "> →</ span > < span class ="sig-return-typehint "> < a class ="reference internal " href ="#opm.simulators.BlackOilSimulator " title ="opm.simulators.BlackOilSimulator "> < span class ="pre "> BlackOilSimulator</ span > </ a > </ span > </ span > < a class ="headerlink " href ="#id0 " title ="Link to this definition "> </ a > </ dt >
143144< dd > < p > Constructor using a deck file name.</ p >
144145< dl class ="field-list simple ">
145146< dt class ="field-odd "> Parameters< span class ="colon "> :</ span > </ dt >
146- < dd class ="field-odd "> < p > < strong > deck_filename</ strong > (< em > str</ em > ) – The file name of the deck to be used for the simulation.</ p >
147+ < dd class ="field-odd "> < ul class ="simple ">
148+ < li > < p > < strong > deck_filename</ strong > (< em > str</ em > ) – The file name of the deck to be used for the simulation.</ p > </ li >
149+ < li > < p > < strong > args</ strong > (< em > list</ em > < em > [</ em > < em > str</ em > < em > ]</ em > ) – Simulator options.</ p > </ li >
150+ </ ul >
147151</ dd >
148152< dt class ="field-even "> Returns< span class ="colon "> :</ span > </ dt >
149153< dd class ="field-even "> < p > The BlackOilSimulator.</ p >
0 commit comments