ValveTemplateCollection

class rips.ValveTemplateCollection(pb2_object: PdmObject | None = None, channel: Channel | None = None)

Bases: PdmObjectBase

valve_units

One of [UNITS_METRIC, UNITS_FIELD, UNITS_UNKNOWN]

Type:

ValveUnits

Methods Summary

add_template([completion_type, ...])

Add a new valve template

valve_definitions()

Methods Documentation

add_template(completion_type: CompletionType = CompletionType.UNDEFINED, orifice_diameter: float = 8.0, flow_coefficient: float = 0.7, user_label: str = '') → ValveTemplate

Add a new valve template

Parameters:

  • completion_type (CompletionType) -- One of [ICD, ICV, AICD, SICD, UNDEFINED]

  • orifice_diameter (float) -- Orifice diameter

  • flow_coefficient (float) -- Flow coefficient

  • user_label (str) -- User-defined label for the template

Returns:

ValveTemplate

valve_definitions() → List[ValveTemplate]
Returns:

List[ValveTemplate]