rs3.properties.CustomHydraulicModel module

class rs3.properties.CustomHydraulicModel.CustomHydraulicModel(client: Client, objectId: str, projectId: str)

Bases: _ProxyObject

Examples

See Material Hydraulic Script Examples.

getName() → str

setName(value: str)

setWaterContentInputType(waterContentInputType: WCInputType)

getWaterContentInputType() → WCInputType

setPermeabilityFunction(value: list[float, float])

Set the user-defined permeability function with a list of (suction, permeability) data points for the current material.

Parameters:

value (list[tuple[float, float]]) – A list of tuples, where each tuple contains: - suction (float): The suction value. - permeability (float): The corresponding permeability value.

getPermeabilityFunction() → list[float, float]

Retrieve the permeability function with a list of (suction, permeability) data points for the current material.

Returns:

A list of tuples, where each tuple contains: - suction (float): The suction value. - permeability (float): The corresponding permeability value.

Return type:

list[tuple[float, float]]

setDegreeOfSaturationFunction(value: list[float, float])

Set the user-defined degree of saturation function with a list of (suction, degree of saturation) data points for the current material.

Parameters:

value (list[tuple[float, float]]) – A list of tuples, where each tuple contains: - suction (float): The suction value. - degree of saturation (float): The corresponding degree of saturation value.

getDegreeOfSaturationFunction() → list[float, float]

Retrieve the degree of saturation function with a list of (suction, degree of saturation) data points for the current material.

Returns:

A list of tuples, where each tuple contains: - suction (float): The suction value. - degree of saturation (float): The corresponding degree of saturation value.

Return type:

list[tuple[float, float]]

setWaterContentFunction(value: list[float, float])

Set the user-defined water content function with a list of (suction, water content) data points for the current material.

Parameters:

value (list[tuple[float, float]]) – A list of tuples, where each tuple contains: - suction (float): The suction value. - water content (float): The corresponding water content value.

getWaterContentFunction() → list[float, float]

Retrieve the water content function with a list of (suction, water content) data points for the current material.

Returns:

A list of tuples, where each tuple contains: - suction (float): The suction value. - water content (float): The corresponding water content value.

Return type:

list[tuple[float, float]]