GroundwaterData

• GroundwaterData
• export_util
• types

class GroundwaterData(model_id: str, client: Client)

Bases: object

Examples: Code Snippet: Groundwater Data

Interpret groundwater data: types, point probes, nodal export, discharge, iteration history.

listGroundwaterDataTypes(context: GroundwaterContext | None = None) → list[GroundwaterDataTypeInfo]

getActiveGroundwaterDataType(context: GroundwaterContext | None = None) → GroundwaterDataTypeInfo

setActiveGroundwaterDataType(data_type: GroundwaterDataType, context: GroundwaterContext | None = None) → None

getValuesAtPoints(points: list[Point2D], data_type: GroundwaterDataType | None = None, context: GroundwaterContext | None = None) → list[PointValue]

getNodalDataInfo(data_type: GroundwaterDataType | None = None, context: GroundwaterContext | None = None) → tuple[int, GroundwaterDataTypeInfo]

getNodalData(offset: int = 0, limit: int = 0, data_type: GroundwaterDataType | None = None, options: NodalDataOptions | None = None, context: GroundwaterContext | None = None) → tuple[list[NodalValue], int]

getAllNodalData(data_type: GroundwaterDataType | None = None, options: NodalDataOptions | None = None, context: GroundwaterContext | None = None, page_size: int = 5000) → list[NodalValue]

getDischargeExportData(context: GroundwaterContext | None = None) → DischargeExportData

getIterationHistory(context: GroundwaterContext | None = None) → list[IterationHistorySeries]

class GroundwaterContext(stage: int = 0)

Bases: object

stage=0 uses the active interpret view stage.

stage: int = 0

getStage() → int

setStage(value: int) → None

class GroundwaterDataType(*values)

Bases: Enum

HORIZONTAL_HYDRAULIC_GRADIENT = 2

VERTICAL_HYDRAULIC_GRADIENT = 3

TOTAL_HYDRAULIC_GRADIENT = 4

HORIZONTAL_PERMEABILITY = 5

VERTICAL_PERMEABILITY = 6

TOTAL_PERMEABILITY = 7

SATURATED_PERMEABILITY = 8

VOLUMETRIC_WATER_CONTENT = 9

NORMALIZED_VOLUMETRIC_WATER_CONTENT = 10

HORIZONTAL_DISCHARGE_VELOCITY = 11

VERTICAL_DISCHARGE_VELOCITY = 12

TOTAL_DISCHARGE_VELOCITY = 13

TOTAL_HEAD = 14

PORE_PRESSURE = 15

PRESSURE_HEAD = 16

DEGREE_OF_SATURATION = 17

class GroundwaterDataTypeInfo(type_id: 'GroundwaterDataType', display_name: 'str')

Bases: object

type_id: GroundwaterDataType

display_name: str

getTypeId() → GroundwaterDataType

getDisplayName() → str

class Point2D(x: 'float', y: 'float')

Bases: object

x: float

y: float

getX() → float

getY() → float

class PointValue(point: 'Point2D', value: 'float', valid: 'bool')

Bases: object

point: Point2D

value: float

valid: bool

getPoint() → Point2D

getValue() → float

getValid() → bool

class NodalDataOptions(allow_negative_pore_pressure: 'bool' = True, convert_pressure_to_mpa: 'bool' = False)

Bases: object

allow_negative_pore_pressure: bool = True

convert_pressure_to_mpa: bool = False

getAllowNegativePorePressure() → bool

getConvertPressureToMpa() → bool

class NodalValue(x: 'float', y: 'float', value: 'float')

Bases: object

x: float

y: float

value: float

getX() → float

getY() → float

getValue() → float

class DischargeExportData(available: 'bool', sections: 'list[DischargeSectionExport]')

Bases: object

available: bool

sections: list[DischargeSectionExport]

getAvailable() → bool

getSections() → list[DischargeSectionExport]

class DischargeSectionExport(section_index: 'int', segment_values: 'list[DischargeSegmentStageValue]', stage_totals: 'list[DischargeStageTotal]')

Bases: object

section_index: int

segment_values: list[DischargeSegmentStageValue]

stage_totals: list[DischargeStageTotal]

getSectionIndex() → int

getSegmentValues() → list[DischargeSegmentStageValue]

getStageTotals() → list[DischargeStageTotal]

class DischargeSegmentStageValue(segment_index: 'int', start: 'Point2D', end: 'Point2D', stage: 'int', stage_label: 'str', flow_rate: 'float')

Bases: object

segment_index: int

start: Point2D

end: Point2D

stage: int

stage_label: str

flow_rate: float

getSegmentIndex() → int

getStart() → Point2D

getEnd() → Point2D

getStage() → int

getStageLabel() → str

getFlowRate() → float

class DischargeStageTotal(stage: 'int', stage_label: 'str', total_flow_rate: 'float')

Bases: object

stage: int

stage_label: str

total_flow_rate: float

getStage() → int

getStageLabel() → str

getTotalFlowRate() → float

class IterationHistoryPoint(iteration: 'int', convergence: 'float')

Bases: object

iteration: int

convergence: float

getIteration() → int

getConvergence() → float

class IterationHistorySeries(series_name: 'str', points: 'list[IterationHistoryPoint]')

Bases: object

series_name: str

points: list[IterationHistoryPoint]

getSeriesName() → str

getPoints() → list[IterationHistoryPoint]