729 allow unequal identifiers for inplace volumetrics (#872)

Author: jorgenherje

backend_py/primary/primary/services/inplace_volumetrics_assembler/inplace_volumetrics_assembler.py

@@ -257,7 +257,7 @@ async def _get_volume_df_per_fluid_selection_and_categorized_result_names_async(
 
         Calculation of volume names and properties, and creation of the results is handled outside this function.
         """
-        # Check for empty identifier selections
+        # Check for empty identifier selection lists
         has_empty_identifier_selection = any(
             not identifier_with_values.values for identifier_with_values in identifiers_with_values
         )

backend_py/primary/primary/services/sumo_access/inplace_volumetrics_types.py

@@ -1,6 +1,5 @@
 from enum import StrEnum
 from dataclasses import dataclass
-from typing import Dict, List, Union
 
 
 # NOTE:
@@ -88,57 +87,57 @@ class CategorizedResultNames:
     Class to hold categorized result names
 
     Attributes:
-    - volume_names: List[str] - Basic volume names among result names
-    - calculated_volume_names: List[str] - Calculated volume names among result names (STOIIP_TOTAL, GIIP_TOTAL)
-    - property_names: List[str] - Property names among result names
+    - volume_names: list[str] - Basic volume names among result names
+    - calculated_volume_names: list[str] - Calculated volume names among result names (STOIIP_TOTAL, GIIP_TOTAL)
+    - property_names: list[str] - Property names among result names
     """
 
-    volume_names: List[str]
-    calculated_volume_names: List[str]
-    property_names: List[str]
+    volume_names: list[str]
+    calculated_volume_names: list[str]
+    property_names: list[str]
 
 
 @dataclass
 class InplaceVolumetricsIdentifierWithValues:
     """
-    Unique values for an identifier column in an inplace volumetrics table
+    Unique values for an identifier column in an inplace volumetric table
 
     NOTE: Ideally all values should be strings, but it is possible that some values are integers - especially for REGION
     """
 
     identifier: InplaceVolumetricsIdentifier
-    values: List[Union[str, int]]  # List of values: str or int
+    values: list[str | int]  # list of values: str or int
 
 
 @dataclass
 class InplaceVolumetricsTableDefinition:
     """Definition of a volumetric table"""
 
     table_name: str
-    identifiers_with_values: List[InplaceVolumetricsIdentifierWithValues]
-    result_names: List[str]
-    fluid_zones: List[FluidZone]
+    identifiers_with_values: list[InplaceVolumetricsIdentifierWithValues]
+    result_names: list[str]
+    fluid_zones: list[FluidZone]
 
 
 @dataclass
 class RepeatedTableColumnData:
     """Definition of a column with repeated column data"""
 
     column_name: str
-    unique_values: List[str | int]  # ["Valysar", "Therys", "Volon"]
-    indices: List[int]  # [0, 1, 1, 1, 2, 2, 2]. Length = number of rows in the table
+    unique_values: list[str | int]  # ["Valysar", "Therys", "Volon"]
+    indices: list[int]  # [0, 1, 1, 1, 2, 2, 2]. Length = number of rows in the table
 
 
 @dataclass
 class TableColumnData:
     column_name: str
-    values: List[float]  # Column values Length = number of rows in the table
+    values: list[float]  # Column values Length = number of rows in the table
 
 
 @dataclass
 class TableColumnStatisticalData:
     column_name: str
-    statistic_values: Dict[Statistic, List[float]]  # Statistics values Length = number of rows in the table
+    statistic_values: dict[Statistic, list[float]]  # Statistics values Length = number of rows in the table
 
 
 @dataclass
@@ -148,10 +147,10 @@ class InplaceVolumetricTableData:
     Contains data for a single fluid zone, e.g. Oil, Gas, Water, or sum of fluid zones
     """
 
-    # fluid_zones: List[FluidZone]  # Oil, Gas, Water or "Oil + Gas", etc.
+    # fluid_zones: list[FluidZone]  # Oil, Gas, Water or "Oil + Gas", etc.
     fluid_selection_name: str  # Oil, Gas, Water or "Oil + Gas", etc.
-    selector_columns: List[RepeatedTableColumnData]  # Index columns and realizations
-    result_columns: List[TableColumnData]
+    selector_columns: list[RepeatedTableColumnData]  # Index columns and realizations
+    result_columns: list[TableColumnData]
 
 
 @dataclass
@@ -163,8 +162,8 @@ class InplaceStatisticalVolumetricTableData:
     """
 
     fluid_selection_name: str  # Oil, Gas, Water or "Oil + Gas", etc.
-    selector_columns: List[RepeatedTableColumnData]  # Index columns and realizations
-    result_column_statistics: List[TableColumnStatisticalData]
+    selector_columns: list[RepeatedTableColumnData]  # Index columns and realizations
+    result_column_statistics: list[TableColumnStatisticalData]
 
 
 @dataclass
@@ -175,7 +174,7 @@ class InplaceVolumetricTableDataPerFluidSelection:
     Fluid selection can be single fluid zones, e.g. Oil, Gas, Water, or sum of fluid zones - Oil + Gas + Water
     """
 
-    table_data_per_fluid_selection: List[InplaceVolumetricTableData]
+    table_data_per_fluid_selection: list[InplaceVolumetricTableData]
 
 
 @dataclass
@@ -186,4 +185,4 @@ class InplaceStatisticalVolumetricTableDataPerFluidSelection:
     Fluid selection can be single fluid zones, e.g. Oil, Gas, Water, or sum of fluid zones - Oil + Gas + Water
     """
 
-    table_data_per_fluid_selection: List[InplaceStatisticalVolumetricTableData]
+    table_data_per_fluid_selection: list[InplaceStatisticalVolumetricTableData]

frontend/src/framework/WorkbenchServices.ts

@@ -6,7 +6,7 @@ import { isEqual } from "lodash";
 
 import { RegularEnsembleIdent } from "./RegularEnsembleIdent";
 import { Workbench } from "./Workbench";
-import { InplaceVolumetricsFilter } from "./types/inplaceVolumetricsFilter";
+import { InplaceVolumetricsFilterSettings } from "./types/inplaceVolumetricsFilterSettings";
 import { Intersection } from "./types/intersection";
 import { Viewport } from "./types/viewport";
 import { Wellbore } from "./types/wellbore";
@@ -38,7 +38,7 @@ export type GlobalTopicDefinitions = {
     "global.syncValue.intersection": Intersection;
     "global.syncValue.cameraPositionIntersection": Viewport;
     "global.syncValue.verticalScale": number;
-    "global.syncValue.inplaceVolumetricsFilter": InplaceVolumetricsFilter;
+    "global.syncValue.inplaceVolumetricsFilterSettings": InplaceVolumetricsFilterSettings;
     "global.syncValue.inplaceVolumetricsResultName": string;
 };
 

frontend/src/framework/types/inplaceVolumetricsFilter.ts renamed to frontend/src/framework/types/inplaceVolumetricsFilterSettings.ts

@@ -1,9 +1,10 @@
 import { FluidZone_api, InplaceVolumetricsIdentifierWithValues_api } from "@api";
 import { RegularEnsembleIdent } from "@framework/RegularEnsembleIdent";
 
-export type InplaceVolumetricsFilter = {
+export type InplaceVolumetricsFilterSettings = {
     ensembleIdents: RegularEnsembleIdent[];
     tableNames: string[];
     fluidZones: FluidZone_api[];
     identifiersValues: InplaceVolumetricsIdentifierWithValues_api[];
+    allowIdentifierValuesIntersection: boolean;
 };

frontend/src/lib/components/ErrorWrapper/errorWrapper.tsx

@@ -0,0 +1,26 @@
+import React from "react";
+
+import { resolveClassNames } from "@lib/utils/resolveClassNames";
+
+export type ErrorWrapperProps = {
+    isError?: boolean;
+    message?: string;
+    children: React.ReactNode;
+};
+
+export const ErrorWrapper: React.FC<ErrorWrapperProps> = (props) => {
+    return (
+        <div
+            className={resolveClassNames("relative rounded", {
+                "outline outline-red-100 outline-offset-2": props.isError ?? false,
+            })}
+        >
+            {props.isError && props.message && (
+                <div className="absolute left-0 right-0 w-full h-full bg-white bg-opacity-80 flex items-center justify-center z-10 p-4 text-center backdrop-blur-sm">
+                    {props.message}
+                </div>
+            )}
+            {props.children}
+        </div>
+    );
+};

frontend/src/lib/components/ErrorWrapper/index.ts

@@ -0,0 +1 @@
+export { ErrorWrapper } from "./errorWrapper";

frontend/src/lib/utils/fixupUserSelection.ts

@@ -1,13 +1,24 @@
+export enum FixupSelection {
+    SELECT_NONE = "SELECT_NONE",
+    SELECT_ALL = "SELECT_ALL",
+    SELECT_FIRST = "SELECT_FIRST",
+}
+
 export function fixupUserSelection<TSelection>(
     userSelection: TSelection[],
     validOptions: TSelection[],
-    selectAll: boolean = false
+    fixupSelection: FixupSelection = FixupSelection.SELECT_FIRST
 ): TSelection[] {
     const newSelections = userSelection.filter((selection) => validOptions.includes(selection));
     if (newSelections.length === 0 && validOptions.length > 0) {
-        if (selectAll) {
+        if (fixupSelection === FixupSelection.SELECT_ALL) {
             return validOptions;
         }
+        if (fixupSelection === FixupSelection.SELECT_NONE) {
+            return [];
+        }
+
+        // Fall back to selecting the first valid option
         newSelections.push(validOptions[0]);
     }
 

frontend/src/modules/InplaceVolumetricsPlot/interfaces.ts

@@ -1,6 +1,5 @@
 import { InplaceVolumetricResultName_api } from "@api";
 import { InterfaceInitialization } from "@framework/UniDirectionalModuleComponentsInterface";
-import { InplaceVolumetricsFilter } from "@framework/types/inplaceVolumetricsFilter";
 import { SelectorColumn, SourceAndTableIdentifierUnion } from "@modules/_shared/InplaceVolumetrics/types";
 
 import { userSelectedPlotTypeAtom } from "./settings/atoms/baseAtoms";
@@ -17,17 +16,16 @@ import {
     selectedSubplotByAtom,
     selectedTableNamesAtom,
 } from "./settings/atoms/derivedAtoms";
-import { PlotType } from "./typesAndEnums";
+import { InplaceVolumetricsFilterSelections, PlotType } from "./typesAndEnums";
 
 export type SettingsToViewInterface = {
-    filter: InplaceVolumetricsFilter;
+    filter: InplaceVolumetricsFilterSelections;
     resultName: InplaceVolumetricResultName_api | null;
     resultName2: InplaceVolumetricResultName_api | null;
     selectorColumn: SelectorColumn | null;
     subplotBy: SourceAndTableIdentifierUnion;
     colorBy: SourceAndTableIdentifierUnion;
     plotType: PlotType;
-    areSelectedTablesComparable: boolean;
     areTableDefinitionSelectionsValid: boolean;
 };
 
@@ -42,6 +40,7 @@ export const settingsToViewInterfaceInitialization: InterfaceInitialization<Sett
             tableNames: get(selectedTableNamesAtom),
             fluidZones: get(selectedFluidZonesAtom),
             identifiersValues: get(selectedIdentifiersValuesAtom),
+            areSelectedTablesComparable: get(areSelectedTablesComparableAtom),
         };
     },
     resultName: (get) => get(selectedResultNameAtom),
@@ -50,6 +49,5 @@ export const settingsToViewInterfaceInitialization: InterfaceInitialization<Sett
     subplotBy: (get) => get(selectedSubplotByAtom),
     colorBy: (get) => get(selectedColorByAtom),
     plotType: (get) => get(userSelectedPlotTypeAtom),
-    areSelectedTablesComparable: (get) => get(areSelectedTablesComparableAtom),
     areTableDefinitionSelectionsValid: (get) => get(areTableDefinitionSelectionsValidAtom),
 };

frontend/src/modules/InplaceVolumetricsPlot/settings/atoms/baseAtoms.ts

@@ -1,6 +1,7 @@
 import { FluidZone_api, InplaceVolumetricResultName_api, InplaceVolumetricsIdentifierWithValues_api } from "@api";
 import { RegularEnsembleIdent } from "@framework/RegularEnsembleIdent";
 import { PlotType } from "@modules/InplaceVolumetricsPlot/typesAndEnums";
+import { IdentifierValueCriteria } from "@modules/_shared/InplaceVolumetrics/TableDefinitionsAccessor";
 import {
     SelectorColumn,
     SourceAndTableIdentifierUnion,
@@ -19,3 +20,7 @@ export const userSelectedSelectorColumnAtom = atom<SelectorColumn | null>(null);
 export const userSelectedSubplotByAtom = atom<SourceAndTableIdentifierUnion>(SourceIdentifier.ENSEMBLE);
 export const userSelectedPlotTypeAtom = atom<PlotType>(PlotType.HISTOGRAM);
 export const userSelectedColorByAtom = atom<SourceAndTableIdentifierUnion>(SourceIdentifier.TABLE_NAME);
+
+export const selectedIdentifierValueCriteriaAtom = atom<IdentifierValueCriteria>(
+    IdentifierValueCriteria.REQUIRE_EQUALITY
+);

frontend/src/modules/InplaceVolumetricsPlot/settings/atoms/derivedAtoms.ts

@@ -1,7 +1,7 @@
 import { FluidZone_api, InplaceVolumetricResultName_api, InplaceVolumetricsIdentifierWithValues_api } from "@api";
 import { EnsembleSetAtom } from "@framework/GlobalAtoms";
 import { fixupRegularEnsembleIdents } from "@framework/utils/ensembleUiHelpers";
-import { fixupUserSelection } from "@lib/utils/fixupUserSelection";
+import { FixupSelection, fixupUserSelection } from "@lib/utils/fixupUserSelection";
 import { fixupUserSelectedIdentifierValues } from "@modules/_shared/InplaceVolumetrics/fixupUserSelectedIdentifierValues";
 import { RealSelector, SelectorColumn, SourceAndTableIdentifierUnion } from "@modules/_shared/InplaceVolumetrics/types";
 import {
@@ -12,6 +12,7 @@ import {
 import { atom } from "jotai";
 
 import {
+    selectedIdentifierValueCriteriaAtom,
     userSelectedColorByAtom,
     userSelectedEnsembleIdentsAtom,
     userSelectedFluidZonesAtom,
@@ -49,8 +50,13 @@ export const selectedEnsembleIdentsAtom = atom((get) => {
 export const tableDefinitionsAccessorAtom = atom<TableDefinitionsAccessor>((get) => {
     const selectedTableNames = get(selectedTableNamesAtom);
     const tableDefinitions = get(tableDefinitionsQueryAtom);
+    const selectedIdentifierValueCriteria = get(selectedIdentifierValueCriteriaAtom);
 
-    return new TableDefinitionsAccessor(tableDefinitions.isLoading ? [] : tableDefinitions.data, selectedTableNames);
+    return new TableDefinitionsAccessor(
+        tableDefinitions.isLoading ? [] : tableDefinitions.data,
+        selectedTableNames,
+        selectedIdentifierValueCriteria
+    );
 });
 
 export const areTableDefinitionSelectionsValidAtom = atom<boolean>((get) => {
@@ -121,7 +127,11 @@ export const selectedFluidZonesAtom = atom<FluidZone_api[]>((get) => {
         return tableDefinitionsAccessor.getFluidZonesIntersection();
     }
 
-    return fixupUserSelection(userSelectedFluidZones, tableDefinitionsAccessor.getFluidZonesIntersection(), true);
+    return fixupUserSelection(
+        userSelectedFluidZones,
+        tableDefinitionsAccessor.getFluidZonesIntersection(),
+        FixupSelection.SELECT_ALL
+    );
 });
 
 export const selectedResultNameAtom = atom<InplaceVolumetricResultName_api | null>((get) => {
@@ -174,7 +184,7 @@ export const selectedSelectorColumnAtom = atom<SelectorColumn | null>((get) => {
 
     const possibleSelectorColumns = [
         RealSelector.REAL,
-        ...tableDefinitionsAccessor.getIdentifiersWithIntersectionValues().map((ident) => ident.identifier),
+        ...tableDefinitionsAccessor.getCommonIdentifiersWithValues().map((ident) => ident.identifier),
     ];
     if (!userSelectedSelectorColumn) {
         return possibleSelectorColumns[0];
@@ -192,13 +202,12 @@ export const selectedIdentifiersValuesAtom = atom<InplaceVolumetricsIdentifierWi
     const userSelectedIdentifierValues = get(userSelectedIdentifiersValuesAtom);
     const tableDefinitionsAccessor = get(tableDefinitionsAccessorAtom);
 
-    const uniqueIdentifierValues = tableDefinitionsAccessor.getIdentifiersWithIntersectionValues();
-    const selectAllOnFixup = true;
+    const uniqueIdentifierValues = tableDefinitionsAccessor.getCommonIdentifiersWithValues();
 
     const fixedUpIdentifierValues: InplaceVolumetricsIdentifierWithValues_api[] = fixupUserSelectedIdentifierValues(
         userSelectedIdentifierValues,
         uniqueIdentifierValues,
-        selectAllOnFixup
+        FixupSelection.SELECT_ALL
     );
 
     return fixedUpIdentifierValues;