rs2.modeler.properties.material.hydraulic.HydroDistribution module

class rs2.modeler.properties.material.hydraulic.HydroDistribution.HydroDistributionResult(distribution_type: rs2.modeler.properties.PropertyEnums.HydraulicDistributionTypes, function_name: str | None = None)

Bases: object

distribution_type: HydraulicDistributionTypes

function_name: str | None = None

class rs2.modeler.properties.material.hydraulic.HydroDistribution.HydroDistributionFunctionStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

Set stage hydraulic distribution functions.

getHydroDistributionStagedFunction(variable: HydraulicVariableTypes) → HydroDistributionResult

Return a list with HydraulicDistributionType and the assigned function name.

class rs2.modeler.properties.material.hydraulic.HydroDistribution.HydroDistributionFunctionDefinedStageFactor(client: Client, ID, propertyID)

Bases: HydroDistributionFunctionStageFactor

Get stage hydraulic distribution functions.

setHydroDistributionStagedFunction(variable: HydraulicVariableTypes, dist: HydraulicDistributionTypes, value: str = None)

Set the hydraulic distribution function for a specific stage.

class rs2.modeler.properties.material.hydraulic.HydroDistribution.HydroDistribution(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Variables:

stageFactorInterface (AbsoluteStageFactorGettersInterface[HydroDistributionFunctionDefinedStageFactor, HydroDistributionFunctionStageFactor]) – Reference object for modifying stage factor property.

Examples

Code Snippet: Manipulation of Hydraulic Distribution Functions

setHydroDistribution(variable: HydraulicVariableTypes, dist: HydraulicDistributionTypes, value)

Set the given variable with selected non-constant hydraulic distribution with a defined hydraulic distribution function or with a constant hydraulic distribution with a constant value.

getHydroDistributionFunctionName(variable: HydraulicVariableTypes) → str

Get the hydraulic distribution function name. See getHydroDistributionConstantVal to access constant value of constant distribution.

getHydroDistributionConstantVal(variable: HydraulicVariableTypes) → float

Get the hydraulic distribution constant value. See getHydroDistributionFunctionName to access the function name of a non-constant distribution.

getHydroDistribution(variable: HydraulicVariableTypes) → HydraulicDistributionTypes

Get the distribution function of the selected variable

getApplicableHydroDistributionVariables() → list[HydraulicVariableTypes]

setProperties(KsDistribution: HydraulicDistributionTypes = None, Ks: float = None, KsFunction: str = None, K2K1Distribution: HydraulicDistributionTypes = None, K2K1: float = None, K2K1Function: str = None, K1AngleDistribution: HydraulicDistributionTypes = None, K1Angle: float = None, K1AngleFunction: str = None, WcSatDistribution: HydraulicDistributionTypes = None, WcSat: float = None, WcSatFunction: str = None, WcResDistribution: HydraulicDistributionTypes = None, WcRes: float = None, WcResFunction: str = None, DosSatDistribution: HydraulicDistributionTypes = None, DosSat: float = None, DosSatFunction: str = None, DosResDistribution: HydraulicDistributionTypes = None, DosRes: float = None, DosResFunction: str = None, RelativeKsDistribution: HydraulicDistributionTypes = None, RelativeKs: float = None, RelativeKsFunction: str = None, RelativeWCDOSDistribution: HydraulicDistributionTypes = None, RelativeWCDOS: float = None, RelativeWCDOSFunction: str = None)

getProperties()