diff --git a/python/docstrings_common.json b/python/docstrings_common.json new file mode 100644 index 00000000000..f3ba86f8979 --- /dev/null +++ b/python/docstrings_common.json @@ -0,0 +1,155 @@ +{ + "EclipseStateClass": { + "type": "class", + "signature": "opm.io.ecl_state.EclipseState", + "doc": "The EclipseState class - this is a representation of all static properties in the model,ranging from porosity to relperm tables.\nThe content of the EclipseState is immutable and may not be changed at runtime." + }, + "EclipseState_input_nnc": { + "signature": "opm.io.ecl_state.EclipseState.input_nnc() -> list", + "doc": "Returns a list of non-neighboring connections.\n\nOne non-neighboring connection is a tuple containing the following elements:\n- index1 (int): Index of the first cell.\n- index2 (int): Index of the second cell.\n- transmissibility (double): Transmissibility between the two cells.\n\nReturns:\nlist: A list of non-neighboring connections." + }, + "EclipseState_faultNames": { + "signature": "opm.io.ecl_state.EclipseState.faultNames() -> list", + "doc": "Returns a list of fault names.\n\nReturns:\nlist: A list containing the names of faults." + }, + "EclipseState_faultFaces": { + "signature": "opm.io.ecl_state.EclipseState.faultFaces(fault_name: str) -> list", + "doc": "Returns a list of faces of a fault with the given name.\n\n:param fault_name: The name of the fault.\n:type fault_name: str\n\nReturns:\nlist: A list containing the faces of the specified fault." + }, + "EclipseState_jfunc": { + "signature": "opm.io.ecl_state.EclipseState.jfunc() -> dict", + "doc": "Function returning a dictionary with the following entries: ['FLAG', 'DIRECTION', 'ALPHA_FACTOR', 'BETA_FACTOR', 'OIL_WATER', 'GAS_OIL']\n\nReturns:\ndict: A dictionary containing the specified entries." + }, + "EclipseState_simulation": { + "signature": "opm.io.ecl_state.EclipseState.simulation() -> SimulationConfiguration", + "doc": "Returns the simulation configuration.\n\nReturns:\nSimulationConfiguration: The simulation configuration." + }, + "ScheduleClass": { + "type": "class", + "signature": "opm.io.schedule.Schedule", + "doc": "The Schedule class - this is a representation of all the content from the SCHEDULE section, notably all well and group information and the timestepping." + }, + "Schedule_getitem": { + "signature": "opm.io.schedule.Schedule.__getitem__(report_step: int) -> ScheduleState", + "doc": "Return the ScheduleState at the given report step.\n\n:param report_step: The report step.\n:type report_step: int\n\n:return: The ScheduleState at the given report step.\n:type return: ScheduleState" + }, + "Schedule_shut_well_well_name_step": { + "signature": "opm.io.schedule.Schedule.shut_well(well_name: str, step: int) -> None", + "doc": "Shut down a well at a given report step.\n\n:param well_name: The name of the well to shut down.\n:type well_name: str\n:param step: The report step at which to shut down the well.\n:type step: int" + }, + "Schedule_shut_well_well_name": { + "signature": "opm.io.schedule.Schedule.shut_well(well_name: str) -> None", + "doc": "Shut down a well at the current report step.\n\n:param well_name: The name of the well to shut down.\n:type well_name: str" + }, + "Schedule_open_well_well_name_step": { + "signature": "opm.io.schedule.Schedule.open_well(well_name: str, step: int) -> None", + "doc": "Open a well at a given report step.\n\n:param well_name: The name of the well to open.\n:type well_name: str\n:param step: The report step at which to open the well.\n:type step: int\n:raises ValueError: If the report step is in the past or exceeds the duration of the simulation." + }, + "Schedule_open_well_well_name": { + "signature": "opm.io.schedule.Schedule.open_well(well_name: str) -> None", + "doc": "Open a well at the current report step.\n\n:param well_name: The name of the well to open.\n:type well_name: str" + }, + "Schedule_stop_well_well_name_step":{ + "signature": "opm.io.schedule.Schedule.stop_well(well_name: str, step: int) -> None", + "doc": "Stop a well at a given report step.\n\n:param well_name: The name of the well to stop.\n:type well_name: str\n:param step: The report step at which to stop the well.\n:type step: int\n:raises ValueError: If the report step is in the past or exceeds the duration of the simulation." + }, + "Schedule_stop_well_well_name": { + "signature": "opm.io.schedule.Schedule.stop_well(well_name: str) -> None", + "doc": "Stop a well at the current report step.\n\n:param well_name: The name of the well to stop.\n:type well_name: str" + }, + "Schedule_get_injection_properties": { + "signature": "opm.io.schedule.Schedule.get_injection_properties(well_name: str, report_step: int) -> dict", + "doc": "Get injection properties for a well at a specific report step.\n\n:param well_name: The name of the well.\n:type well_name: str\n:param report_step: The report step to retrieve properties for.\n:type report_step: int\n\nReturns:\ndict: A dict containing the properties surf_inj_rate, resv_inj_rate, bhp_target, thp_target." + }, + "Schedule_get_production_properties": { + "signature": "opm.io.schedule.Schedule.get_production_properties(well_name: str, report_step: int) -> dict", + "doc": "Get production properties for a well at a specific report step.\n\n:param well_name: The name of the well.\n:type well_name: str\n:param report_step: The report step to retrieve properties for.\n:type report_step: int\n\nReturns:\ndict: A dict containing the properties oil_rate, gas_rate, water_rate, liquid_rate, resv_rate, bhp_target, thp_target, alq_value." + }, + "Schedule_groups": { + "signature": "opm.io.schedule.Schedule._groups(report_step: int) -> list", + "doc": "Get a list of all groups at a specified report step.\n\n:param report_step: The report step to retrieve groups for.\n:type report_step: int\n\nReturns:\nlist: A list containing all groups at the specified report step." + }, + "Schedule_get_well": { + "signature": "opm.io.schedule.Schedule.get_well(well_name: str, report_step: int) -> Well", + "doc": "Retrieve a well at a given report step.\n\n:param well_name: The name of the well.\n:type well_name: str\n:param report_step: The report step.\n:type report_step: int\n\nReturns:\nwell: Well object at the given report step." + }, + "Schedule_get_wells": { + "signature": "opm.io.schedule.Schedule.get_wells(well_name_pattern: str) -> list", + "doc": "Get the names of wells matching a specified pattern.\n\n:param well_name_pattern: The pattern for well names, where '*' acts as a wildcard.\n:type well_name_pattern: str\n\nReturns:\nlist: A list containing the names of wells that match the specified pattern." + }, + "ScheduleStateClass": { + "signature": "ScheduleState", + "type": "class", + "doc": "The ScheduleState class." + }, + "ScheduleState_nupcol": { + "signature": "ScheduleState.nupcol", + "doc": "The NUPCOL value at this Schedule State. This is a positive integer that defines the maximum number of Newton iterations used to update well targets within a time step." + }, + "ScheduleState_get_group": { + "signature": "ScheduleState.get_group(group_name: str) -> group", + "doc": "Get the group with the specified name from the schedule state.\n\n:param group_name: The name of the group to retrieve from the schedule state.\n:type group_name: str\n\nReturns:\ngroup: The group with the specified name from the schedule state." + }, + "SummaryStateClass":{ + "type": "class", + "signature": "opm.io.SummaryState", + "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." + }, + "SummaryState_update_well_var": { + "signature": "opm.io.SummaryState.update_well_var(well_name: str, variable_name: str, new_value: double) -> None", + "doc": "Update the variable of a well.\n\n:param well_name: The name of the well.\n:type well_name: str\n:param variable_name: The name of the variable to update.\n:type variable_name: str\n:param new_value: The new value of the variable.\n:type new_value: double\n\nReturns:\nNone" + }, + "SummaryState_update_group_var": { + "signature": "opm.io.SummaryState.update_group_var(group_name: str, variable_name: str, new_value: double) -> None", + "doc": "Update the variable of a group.\n\n:param group_name: The name of the group.\n:type group_name: str\n:param variable_name: The name of the variable to update.\n:type variable_name: str\n:param new_value: The new value of the variable.\n:type new_value: double\n\nReturns:\nNone" + }, + "SummaryState_well_var": { + "signature": "opm.io.SummaryState.well_var(well_name: str, variable_name: str) -> double", + "doc": "Get the value of a variable for a well.\n\n:param well_name: The name of the well.\n:type well_name: str\n:param variable_name: The name of the variable to retrieve.\n:type variable_name: str\n\nReturns:\ndouble: The value of the specified variable for the well." + }, + "SummaryState_group_var": { + "signature": "opm.io.SummaryState.group_var(group_name: str, variable_name: str) -> double", + "doc": "Get the value of a variable for a group.\n\n:param group_name: The name of the group.\n:type group_name: str\n:param variable_name: The name of the variable to retrieve.\n:type variable_name: str\n\nReturns:\ndouble: The value of the specified variable for the group." + }, + "SummaryState_elapsed": { + "signature": "opm.io.SummaryState.elapsed() -> double", + "doc": "Return the elapsed time in seconds of the current simulation.\n\nReturns:\ndouble: The elapsed time in seconds." + }, + "SummaryState_groups": { + "signature": "opm.io.SummaryState.groups -> list", + "doc": "Return a list of strings containing all group names.\n\nReturns:\nlist: A list of strings representing all group names." + }, + "SummaryState_wells": { + "signature": "opm.io.SummaryState.wells -> list", + "doc": "Return a list of strings containing all well names.\n\nReturns:\nlist: A list of strings representing all well names." + }, + "SummaryState_has_well_var": { + "signature": "opm.io.SummaryState.has_well_var(well_name: str, variable_name: str) -> bool", + "doc": "Check if a well variable exists.\n\n:param well_name: The name of the well.\n:type well_name: str\n:param variable_name: The name of the variable to check.\n:type variable_name: str\n\nReturns:\nbool: True if the variable exists for the well, False otherwise." + }, + "SummaryState_has_group_var": { + "signature": "opm.io.SummaryState.has_group_var(group_name: str, variable_name: str) -> bool", + "doc": "Check if a group variable exists.\n\n:param group_name: The name of the group.\n:type group_name: str\n:param variable_name: The name of the variable to check.\n:type variable_name: str\n\nReturns:\nbool: True if the variable exists for the group, False otherwise." + }, + "WellClass": { + "type": "class", + "signature": "Well", + "doc": "The Well class." + }, + "Well_pos": { + "signature": "Well.pos() -> tuple", + "doc": "Retrieve the position of the well.\n\nReturns:\ntuple: A tuple containing the (i, j) coordinates and the reference depth of the well." + }, + "Well_isdefined": { + "signature": "Well.isdefined(report_step: int) -> bool", + "doc": "Check if the well is defined at a specific report step.\n\n:param report_step: The report step to check for the well's definition.\n:type report_step: int\n\nReturns:\nbool: True if the well is defined at the specified report step, False otherwise." + }, + "Well_available_gctrl": { + "signature": "Well.available_gctrl() -> bool", + "doc": "Check if the well is available for group control.\n\nReturns:\nbool: True if the well is available for group control, False otherwise." + }, + "Well_connections": { + "signature": "Well.connections() -> list", + "doc": "Get a list of all connections associated with the well.\n\nReturns:\nlist: A list containing all connections of the well." + } +}