rs3.properties.material.hydraulic.FEAGroundwater.FEAGroundwater module#

class rs3.properties.material.hydraulic.FEAGroundwater.FEAGroundwater.FEAGroundwater(client: Client, id: str)#

Bases: _ProxyObject

Examples

See Material Hydraulic Script Examples.

setHydraulicModelType(hydraulicModelType: HydraulicModelType, customHydraulicModelName: str = '')#

Set the hydraulic model type for the current material.

If setting a standard hydraulic model, specify the hydraulicModelType as one of the predefined HydraulicModelType enum values.

If setting a custom hydraulic model, set hydraulicModelType to HydraulicModelType.CUSTOM and provide a non-empty customHydraulicModelName. The method will send the custom name to the service instead of using the standard enum property.

Parameters:

  • hydraulicModelType (HydraulicModelType) – The type of hydraulic model to set. - Standard models: use the corresponding HydraulicModelType enum. - Custom model: use HydraulicModelType.CUSTOM.

  • customHydraulicModelName (str, optional) – The name of the custom hydraulic model, required when hydraulicModelType is CUSTOM. Ignored for standard models.

Raises:

ValueError – If hydraulicModelType is CUSTOM and no customHydraulicModelName is provided.

getHydraulicModelType() → HydraulicModelType | str#

Retrieve the current hydraulic model type for the material.

  • If the current model is a standard hydraulic model, this method returns the corresponding HydraulicModelType enum value.

  • If the current model is a custom hydraulic model, this method returns the custom hydraulic model name as a string.

Returns:

  • HydraulicModelType enum for standard models.

  • str for the custom hydraulic model name.

Return type:

HydraulicModelType | str

Raises:

ValueError – If the response does not contain a valid value.