mirror of
https://github.com/OPM/ResInsight.git
synced 2025-02-25 18:55:39 -06:00
d675db98f6
Several improvement and adjustments to the Python documentation - applied autopep8 - add summary example - use references to reference other classes and methods
84 lines
2.2 KiB
Python
84 lines
2.2 KiB
Python
"""
|
|
Grid Case Group statistics module
|
|
"""
|
|
|
|
from rips.pdmobject import PdmObject, add_method
|
|
from rips.view import View
|
|
from rips.case import Case
|
|
|
|
import rips.generated.Commands_pb2 as Cmd
|
|
from rips.generated.pdm_objects import GridCaseGroup
|
|
|
|
|
|
@add_method(GridCaseGroup)
|
|
def create_statistics_case(self):
|
|
"""Create a Statistics case in the Grid Case Group
|
|
|
|
Returns:
|
|
:class:`rips.generated.pdm_objects.EclipseCase`
|
|
"""
|
|
command_reply = self._execute_command(
|
|
createStatisticsCase=Cmd.CreateStatisticsCaseRequest(
|
|
caseGroupId=self.group_id))
|
|
return Case(self.channel,
|
|
command_reply.createStatisticsCaseResult.caseId)
|
|
|
|
|
|
@add_method(GridCaseGroup)
|
|
def statistics_cases(self):
|
|
"""Get a list of all statistics cases in the Grid Case Group
|
|
|
|
Returns:
|
|
List of :class:`rips.generated.pdm_objects.EclipseCase`
|
|
|
|
"""
|
|
stat_case_collection = self.children("StatisticsCaseCollection")[0]
|
|
return stat_case_collection.children("Reservoirs")
|
|
|
|
|
|
@add_method(GridCaseGroup)
|
|
def views(self):
|
|
"""Get a list of views belonging to a grid case group
|
|
|
|
Returns:
|
|
List of :class:`rips.generated.pdm_objects.EclipseView`
|
|
|
|
"""
|
|
pdm_objects = self.descendants(EclipseView)
|
|
view_list = []
|
|
for pdm_object in pdm_objects:
|
|
view_list.append(pdm_object)
|
|
return view_list
|
|
|
|
|
|
@add_method(GridCaseGroup)
|
|
def view(self, view_id):
|
|
"""Get a particular view belonging to a case group by providing view id
|
|
Arguments:
|
|
id(int): view id
|
|
|
|
Returns:
|
|
List of :class:`rips.generated.pdm_objects.EclipseView`
|
|
|
|
"""
|
|
views = self.views()
|
|
for view_object in views:
|
|
if view_object.id == view_id:
|
|
return view_object
|
|
return None
|
|
|
|
|
|
@add_method(GridCaseGroup)
|
|
def compute_statistics(self, case_ids=None):
|
|
""" Compute statistics for the given case ids
|
|
|
|
Arguments:
|
|
case_ids(list of integers): List of case ids. If this is None all cases in group are included
|
|
|
|
"""
|
|
if case_ids is None:
|
|
case_ids = []
|
|
return self._execute_command(
|
|
computeCaseGroupStatistics=Cmd.ComputeCaseGroupStatRequest(
|
|
caseIds=case_ids, caseGroupId=self.group_id))
|