rs2.modeler.properties package
rs2.modeler.properties.AbsoluteStageFactorGettersInterface module
- class rs2.modeler.properties.AbsoluteStageFactorGettersInterface.AbsoluteStageFactorGettersInterface(client, proxyId, propertyID, definedFactorClass, factorClass)
Bases:
ProxyObject
,Generic
[DefinedStageFactor
,StageFactor
]Examples
Code Snippet: Manipulation of Stage Factors for various properties
- getDefinedStageFactors() dict[int, DefinedStageFactor]
Returns a map of stage factors. The key is the stage at which the stage factor is applied. The value is the stage factor object
- getStageFactor(stage: int) StageFactor
Returns the stage factor for the given stage.
rs2.modeler.properties.AbsoluteStageFactorInterface module
- class rs2.modeler.properties.AbsoluteStageFactorInterface.AbsoluteStageFactorInterface(client, proxyId, propertyID, definedFactorClass, factorClass)
Bases:
ProxyObject
,Generic
[DefinedStageFactor
,StageFactor
]Examples
Code Snippet: Manipulation of Stage Factors for various properties
- getDefinedStageFactors() dict[int, DefinedStageFactor]
Returns a map of stage factors. The key is the stage at which the stage factor is applied. The value is the stage factor object
- getStageFactor(stage: int) StageFactor
Returns the stage factor for the given stage.
- createStageFactor(stage: int) DefinedStageFactor
Creates a stage factor for the given stage.
NOTE: Invalidates any existing stage factor proxies. Get them again using getDefinedStageFactors or getStageFactor.
- setDefinedStageFactors(stageFactors: dict[int, StageFactor])
Sets the defined stage factors to those given.
NOTE: Invalidates any existing stage factor proxies. Get them again using getDefinedStageFactors or getStageFactor.
rs2.modeler.properties.CompositeProperty module
- class rs2.modeler.properties.CompositeProperty.CompositeProperty(server: Client, ID, documentProxyID)
Bases:
PropertyProxy
Examples
Code Snippet: Manipulation of Composite Liner Properties
- getCompositeName() str
- setCompositeName(value: str)
- getCompositeColor() int
- setCompositeColor(value: int)
- getJointPlacement() CompositeJointPlacementTypes
- setJointPlacement(value: CompositeJointPlacementTypes)
- getCompositeJointPropertyName() str
Returns the applied joint name
- setCompositeJointPropertyByName(jointName: str)
Set joint by name
- getCompositeLinerPropertyName(layerNumber: int) str
Returns the liner name for specified layer number
- setCompositeLinerPropertyByName(layerNumber: int, linerName: str)
Set liner by name for specified layer number
- getNumberOfLayers() int
Returns number of layers
- setNumberOfLayers(num_layers: int)
Set number of layers
- getJointApplied() bool
Returns boolean indicating whether joint interface is applied or not
- setJointApplied(joint_applied: bool)
Set joint interface as boolean
- getInstallDelay(layerNumber: int) int
Returns install delay as integer for specified layer number
- setInstallDelay(layerNumber: int, stagesBelow: int)
Set install delay for specified layer number. Please note that install delay cannot be set for first layer.
- getRemovedStage(layerNumber: int) int
Returns removed stages as integer for specified layer number
- setRemovedStage(layerNumber: int, stagesBelow: int)
Set removed stages for specified layer number. To set the removed stages to “Never”, please set stagesBelow to -1
rs2.modeler.properties.DiscreteFunction module
- class rs2.modeler.properties.DiscreteFunction.DiscreteFunction(client: Client, ID)
Bases:
ProxyObject
- setFunctionParameters(functionType: DiscreteDrainedMode, useModulus: bool, residualStrengthFactor: float, peakTensileStrength: float, residualTensileStrength: float, useModulusResidual: bool = False)
- getFunctionParameters()
Returns a tuple of (DiscreteDrainedMode, useModulus, residualStrengthFactor, peakTensileStrength, residualTensileStrength, useModulusResidual)
- setInterpolationMethod(interpolationMethod: InterpolationMethod)
- getInterpolationMethod()
- setSymbolDrawing(symbol: SymbolTypes, exteriorColor: int, fillInterior: bool, interiorColor: int = 0)
- getSymbolDrawing()
Returns a tuple of (SymbolTypes, exteriorColor, fillInterior, interiorColor)
- setPointLocations(locations: list[tuple[float, float]])
- getPointLocations()
- setPointsC(c: list[float])
- getPointsC()
- setPointsPhi(phi: list[float])
- getPointsPhi()
- setPointsModulus(modulus: list[float])
- getPointsModulus()
- setPointsModulusResidual(modulusResidual: list[float])
- getPointsModulusResidual()
rs2.modeler.properties.MaterialJoint module
- class rs2.modeler.properties.MaterialJoint.MaterialJoint(client: Client, ID, documentProxyID)
Bases:
PropertyProxy
Examples
Code Snippet: Manipulation of Material Joint Properties
- MohrCoulombMaterial
Reference object for modifying property.
- Type:
- BartonBandisMaterial
Reference object for modifying property.
- Type:
- GeosyntheticHyperbolicMaterial
Reference object for modifying property.
- getSlipCriterion() JointTypes
- setSlipCriterion(value: JointTypes)
- SetApplySSR(applySSR: bool)
- GetApplySSR() bool
rs2.modeler.properties.MaterialJointOptions module
- class rs2.modeler.properties.MaterialJointOptions.MaterialJointOptions(client, ID, documentProxyID)
Bases:
ProxyObject
- setNumberOfJoints(value: int)
- getNumberOfJoints() int
- setUseTracePlane(jointIndex: int, value: bool)
- getUseTracePlane(jointIndex: int) bool
- setTracePlaneProperties(jointIndex: int, tracePlaneDipDirection: float, dip: float, dipDirection: float)
- getTracePlaneProperties(jointIndex: int) tuple[float, float, float]
returns a tuple (traceplanedipdirection, dip, dipdirection) for the joint at the given index
- setInclination(jointIndex: int, value: float)
- getInclination(jointIndex: int) float
- getJoint(jointIndex: int) MaterialJoint
rs2.modeler.properties.PropertyEnums module
- class rs2.modeler.properties.PropertyEnums.BoltTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- END_ANCHORED = 'END_ANCHORED'
- FULLY_BONDED = 'FULLY_BONDED'
- PLAIN_STRAND_CABLE = 'QUEENS_CABLE'
- SWELLEX = 'SHEAR_BOLT'
- TIEBACK = 'TIEBACK_BOLT'
- class rs2.modeler.properties.PropertyEnums.BulgeTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- GARFORD_BULB_25MM = 'PHASE2_BULGE_GARFORD_25'
- NUT_CASE_21MM = 'PHASE2_BULGE_NUTCASE_21'
- class rs2.modeler.properties.PropertyEnums.SecondaryBondLengthType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- PERCENTAGE_OF_LENGTH = 'P2_BOLT_TIEBACK_SECONDARY_PERCENT'
- LENGTH = 'P2_BOLT_TIEBACK_SECONDARY_PHYSICAL'
- FULLY_BONDED = 'P2_BOLT_TIEBACK_SECONDARY_FULLY'
- class rs2.modeler.properties.PropertyEnums.BoltModels(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- PLASTIC = 'P2_BOLT_PLASTIC'
- ELASTIC = 'P2_BOLT_ELASTIC'
- class rs2.modeler.properties.PropertyEnums.LinerTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- STANDARD_BEAM = 'P2_LINER_STANDARD_BEAM'
- GEOSYNTHETIC = 'P2_LINER_GEOSYNTHETIC'
- REINFORCED_CONCRETE = 'P2_LINER_REINFORCED_CONCRETE'
- CABLE_TRUSS = 'P2_LINER_CABLE_TRUSS'
- class rs2.modeler.properties.PropertyEnums.LinerFormulation(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- BERNOULLI = 'P2_LINER_FORMULATION_BERNOULLI'
- TIMOSHENKO = 'P2_LINER_FORMULATION_TIMOSHENKO'
- class rs2.modeler.properties.PropertyEnums.MaterialType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- ELASTIC = 'ELASTIC'
- PLASTIC = 'PLASTIC'
- class rs2.modeler.properties.PropertyEnums.GeometryChoice(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- AREA = 'LNP_USE_AREA'
- THICKNESS = 'LNP_USE_THICKNESS'
- class rs2.modeler.properties.PropertyEnums.StaticWaterModes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- DRY = 'SWM_DRY'
- PORE_WATER_PRESSURE = 'SWM_PWP'
- RU = 'SWM_RU'
- PIEZO = 'SWM_PIEZO'
- GRID = 'SWM_GRID'
- INTERPOLATED = 'SWM_INTERPOLATED'
- class rs2.modeler.properties.PropertyEnums.StageFactorDefinitionMethod(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- ABSOLUTE_STAGE_FACTOR = 0
- RELATIVE_STAGE_FACTOR = 1
- class rs2.modeler.properties.PropertyEnums.JointTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- NONE = 'JOINT_NONE'
- MOHR_COULOMB = 'JOINT_MOHR_COULOMB'
- BARTON_BANDIS = 'JOINT_BARTON_BANDIS'
- GEOSYNTHETIC_HYPERBOLIC = 'JOINT_HYPERBOLIC_SIMPLE'
- MATERIAL_DEPENDENT = 'JOINT_MATERIAL_DEPENDENT'
- HYPERBOLIC_SOFTENING = 'JOINT_HYPERBOLIC_SOFTENING'
- DISPLACEMENT_DEPENDENT = 'JOINT_DISPLACEMENT_DEPENDENT'
- class rs2.modeler.properties.PropertyEnums.AdditionalPressureType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- PRESSURE = 'JOINT_ADDITIONAL_PRESSURE_BY_VALUE'
- PIEZOMETRIC_LINE = 'JOINT_ADDITIONAL_PRESSURE_BY_PIEZO'
- class rs2.modeler.properties.PropertyEnums.DefineStiffness(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- DEFINE_PARAMETER = 'DEFINE_PARAMETER'
- MATERIAL_DEPENDENT = 'MATERIAL_DEPENDENT'
- class rs2.modeler.properties.PropertyEnums.PileApplicationType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- CONSTANT = 'APPLICATION_CONSTANT'
- DEFINE_BEAM_SEGMENT_BY_LENGTH = 'APPLICATION_BY_LENGTH'
- class rs2.modeler.properties.PropertyEnums.PileEndCondition(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- NONE = 'FP_NONE'
- FORCE = 'FP_FORCE'
- DISPLACEMENT = 'FP_DISPLACEMENT'
- class rs2.modeler.properties.PropertyEnums.PileForceApplicationPoint(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- TOP = 'FP_TOP'
- BOTTOM = 'FP_BOTTOM'
- class rs2.modeler.properties.PropertyEnums.PileSkinResistanceType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- ELASTIC = 'SKIN_RESISTANCE_ELASTIC'
- MOHR_COULOMB = 'SKIN_RESISTANCE_C_PHI'
- LINEAR = 'SKIN_RESISTANCE_LINEAR'
- MULTI_LINEAR = 'SKIN_RESISTANCE_MULTI_LINEAR'
- MATERIAL_DEPENDENT = 'SKIN_RESISTANCE_MATERIAL_DEPENDENT'
- class rs2.modeler.properties.PropertyEnums.PileDefinitionMethod(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- DISTANCE_FROM_TOP = 'DISTANCE_FROM_TOP'
- ELEVATION = 'ELEVATION'
- class rs2.modeler.properties.PropertyEnums.PileConnectionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- FREE = 'CONNECT_FREE'
- HINGED = 'CONNECT_HINGED'
- RIGID = 'CONNECT_RIGID'
- SEMI_RIGID = 'CONNECT_SEMIRIGID'
- class rs2.modeler.properties.PropertyEnums.CompositeJointPlacementTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- BETWEEN_SOIL_ROCK_AND_FIRST_LINER = 'BETWEEN_SOIL_ROCK_AND_FIRST_LINER'
- BETWEEN_FIRST_AND_SECOND_LINER = 'BETWEEN_FIRST_AND_SECOND_LINER'
- BETWEEN_SECOND_AND_THIRD_LINER = 'BETWEEN_SECOND_AND_THIRD_LINER'
- BETWEEN_THIRD_AND_FOURTH_LINER = 'BETWEEN_THIRD_AND_FOURTH_LINER'
- class rs2.modeler.properties.PropertyEnums.ThermalType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- CONSTANT = 'THERMAL_CONSTANT'
- JOHANSEN = 'THERMAL_JOHANSEN'
- JOHANSEN_LU = 'THERMAL_JOHANSEN_LU'
- DE_VRIES = 'THERMAL_DEVRIES'
- COTE_AND_KONRAD = 'THERMAL_COTE_AND_KONRAD'
- CUSTOM = 'THERMAL_TABULAR'
- class rs2.modeler.properties.PropertyEnums.ThermalWaterContentMethodType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- USE_FROM_GROUNDWATER = 'THERMAL_WATER_CONTENT_FROM_GROUNDWATER'
- DEFINE = 'THERMAL_WATER_CONTENT_DEFINE'
- class rs2.modeler.properties.PropertyEnums.ThermalHeatCapacityType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- CONSTANT = 'THERMAL_HEAT_CAPACITY_CONSTANT'
- JAME_NEWMAN = 'THERMAL_HEAT_CAPACITY_JAMENEWMAN'
- CUSTOM = 'THERMAL_HEAT_CAPACITY_CUSTOM'
- class rs2.modeler.properties.PropertyEnums.ThermalWaterContentType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- KONRAD = 'THERMAL_WATER_CONTENT_KONRAD'
- TICE_AND_ANDERSON = 'THERMAL_WATER_CONTENT_TICE_ANDERSON'
- SOIL_WATER_CONTENT_IN_HYDRAULIC_PROPERTIES = 'THERMAL_WATER_CONTENT_HYDRO_MODEL'
- CUSTOM = 'THERMAL_WATER_CONTENT_CUSTOM'
- SIMPLE = 'THERMAL_WATER_CONTENT_DEFAULT'
- class rs2.modeler.properties.PropertyEnums.ThermalVolumetricDepencenceType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- TEMPERATURE = 'THERMAL_VOLUMETRIC_DEPENDENCE_TEMPERATURE'
- WATER_CONTENT = 'THERMAL_VOLUMETRIC_DEPENDENCE_WATER_CONTENT'
- class rs2.modeler.properties.PropertyEnums.GroundWaterModes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- SIMPLE = 'SL_WATER_MODE_SIMPLE'
- FREDLUND_AND_XING = 'SL_WATER_MODE_FREDLUND'
- VAN_GENUCHTEN = 'SL_WATER_MODE_VAN_GENUCHTEN'
- BROOKS_AND_COREY = 'SL_WATER_MODE_BROOK'
- USER_DEFINED = 'SL_WATER_MODE_USER_DEFINED'
- GARDNER = 'SL_WATER_MODE_GARDNER'
- CUSTOM = 'SL_WATER_MODE_CONSTANT'
- class rs2.modeler.properties.PropertyEnums.ThermalSoilType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- FINE = 'THERMAL_SOIL_FINE'
- COARSE = 'THERMAL_SOIL_COARSE'
- CRUSHED_ROCK = 'THERMAL_SOIL_CRUSHED_ROCK'
- PEAT = 'THERMAL_SOIL_PEAT'
- class rs2.modeler.properties.PropertyEnums.MVModel(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- NONE = 'MV_NONE'
- CONSTANT = 'MV_CONSTANT'
- FLUID = 'MV_FLUID'
- ELASTIC_CONSOLIDATION_1D = 'MV_1D_ELASTIC'
- ELASTIC_CONSOLIDATION_2D = 'MV_2D_ELASTIC'
- class rs2.modeler.properties.PropertyEnums.WCInputType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- BY_WATER_CONTENT = 'WC_INPUT_WC'
- BY_DEGREE_OF_SATURATION = 'WC_INPUT_DOS'
- class rs2.modeler.properties.PropertyEnums.UnsaturatedParameterType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- NONE = 'UNSATURATED_NOT_APPLIED'
- UNSATURATED_SHEAR_STRENGTH = 'UNSATURATED_SHEAR_STRESS'
- SINGLE_EFFECTIVE_STRESS = 'UNSATURATED_SINGLE_EFFECTIVE_STRESS'
- class rs2.modeler.properties.PropertyEnums.UnsaturatedShearStrengthType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- FREDLUND = 'UNSATURATED_FREDLUND'
- VANAPALLI = 'UNSATURATED_VANAPALLI'
- class rs2.modeler.properties.PropertyEnums.UnsaturatedSingleEffectiveStressMethod(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- BISHOP = 'UNSATURATED_BISHOP'
- TABULAR_VALUE = 'UNSATURATED_TABULAR_VALUE'
- GUDEHUS_1995 = 'UNSATURATED_GUDEHUS_1995'
- KHALILI_2004 = 'UNSATURATED_KHALILI_2004'
- BOLZON_1996 = 'UNSATURATED_BOLZON_1996'
- AITCHISON_1960 = 'UNSATURATED_AITCHISON_1960'
- KOHGO_1993 = 'UNSATURATED_KOHGO_1993'
- class rs2.modeler.properties.PropertyEnums.UnsaturatedTabularValueMethod(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- WITH_RESPECT_TO_SUCTION = 'UNSATURATED_RESPECT_SUCTION'
- WITH_RESPECT_TO_DEGREE_OF_SATURATION = 'UNSATURATED_RESPECT_DEGREE_SATURATION'
- WITH_RESPECT_TO_EFFECTIVE_DEGREE_OF_SATURATION = 'UNSATURATED_RESPECT_EFFECTIVE_DEGREE_SATURATION'
- class rs2.modeler.properties.PropertyEnums.InitialElementLoadingType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- FIELD_STRESS_ONLY = 'INITIAL_MAT_LOADING__FIELD_STRESS_ONLY'
- FIELD_STRESS_AND_BODY_FORCE = 'INITIAL_MAT_LOADING__BOTH_FIELD_AND_BODY'
- BODY_FORCE_ONLY = 'INITIAL_MAT_LOADING__BODY_FORCE_ONLY'
- NONE = 'INITIAL_MAT_LOADING__NONE'
- class rs2.modeler.properties.PropertyEnums.MaterialElasticityTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- ISOTROPIC = 'ISOTROPIC'
- TRANSVERSELY_ISOTROPIC = 'TRANSVERSELY_ISOTROPIC'
- ORTHOTROPIC = 'ORTHOTROPIC'
- DUNCAN_CHANG_HYPERBOLIC = 'NON_LINEAR_HYPERBOLIC'
- NON_LINEAR_ISOTROPIC = 'NON_LINEAR_ISOTROPIC'
- VISCO_ELASTIC = 'VISCO_ELASTIC'
- CUSTOM = 'CUSTOM_STIFFNESS'
- class rs2.modeler.properties.PropertyEnums.ElasticParameters(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- CONSTANT_SHEAR_MODULUS = 'CONSTANT_SHEAR_MODULUS'
- CONSTANT_POISSON_RATIO = 'CONSTANT_POISSON_RATIO'
- class rs2.modeler.properties.PropertyEnums.SpecificVolumeAtUnitPressure(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- CRITICAL_STATE_LINE_GAMMA = 'CRITICAL_STATE_LINE'
- NORMAL_COMPRESSION_LINE = 'NORMAL_COMPRESSION_LINE'
- class rs2.modeler.properties.PropertyEnums.InitialStateOfConsolidation(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- PRECONSOLIDATION_PRESSURE = 'PRECONSOLIDATION_PRESSURE'
- OVERCONSOLIDATION_RATIO = 'OVERCONSOLIDATION_RATIO'
- class rs2.modeler.properties.PropertyEnums.TensileCutoffOptions(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- NONE = 'TENSILE_CUTOFF_NONE'
- HOEK_MARTIN_2004 = 'TENSILE_CUTOFF_HOEK_MARTIN'
- USER_DEFINED = 'TENSILE_CUTOFF_USER_DEFINED'
- class rs2.modeler.properties.PropertyEnums.NLIFormulaTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- NLI_TYPE_FORMULA1 = 'NLI_TYPE_FORMULA1'
- NLI_TYPE_FORMULA2 = 'NLI_TYPE_FORMULA2'
- NLI_TYPE_FORMULA3 = 'NLI_TYPE_FORMULA3'
- NLI_TYPE_FORMULA4 = 'NLI_TYPE_FORMULA4'
- class rs2.modeler.properties.PropertyEnums.PoissonRatioType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- CONSTANT = 'POISSON_RATIO_CONSTANT'
- STRESS_DEPENDENT = 'POISSON_RATIO_STRESS_DEPENDENT'
- class rs2.modeler.properties.PropertyEnums.AnisotropyDefinitions(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- ANGLE = 'ANISOTROPY_DEFINITION_ANGLE'
- SURFACE = 'ANISOTROPY_DEFINITION_SURFACE'
- class rs2.modeler.properties.PropertyEnums.MCCapType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- VERTICAL = 'MC_CAP_VERTICAL'
- ELLIPTICAL = 'MC_CAP_ELLIPTICAL'
- class rs2.modeler.properties.PropertyEnums.CapHardeningTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- EXPONENTIAL = 'MC_CAP_HARDENING_EXPONENTIAL'
- TABULAR = 'MC_CAP_HARDENING_TABULAR'
- class rs2.modeler.properties.PropertyEnums.CapTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- NONE = 'MC_CAP_TYPE_NOT_ACTIVE'
- VERTICAL = 'MC_CAP_TYPE_VERTICAL'
- ELLIPTICAL = 'MC_CAP_TYPE_ELLIPTICAL'
- class rs2.modeler.properties.PropertyEnums.ConeHardeningTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- HARDENING_PROPERTY = 'CONE_HARDENING_EXPONENTIAL'
- TABULAR = 'CONE_HARDENING_TABULAR'
- class rs2.modeler.properties.PropertyEnums.DilationTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- COMPACTION_DILATION = 'DILATION_COMPACTION'
- DILATION_ONLY = 'DILATION_ANGLE'
- class rs2.modeler.properties.PropertyEnums.HatchStyle(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- HatchStyleVertical = 'HatchStyleVertical'
- HatchStyleForwardDiagonal = 'HatchStyleForwardDiagonal'
- HatchStyleBackwardDiagonal = 'HatchStyleBackwardDiagonal'
- HatchStyleCross = 'HatchStyleCross'
- HatchStyleDiagonalCross = 'HatchStyleDiagonalCross'
- HatchStyle05Percent = 'HatchStyle05Percent'
- HatchStyle10Percent = 'HatchStyle10Percent'
- HatchStyle20Percent = 'HatchStyle20Percent'
- HatchStyle25Percent = 'HatchStyle25Percent'
- HatchStyle30Percent = 'HatchStyle30Percent'
- HatchStyle40Percent = 'HatchStyle40Percent'
- HatchStyle50Percent = 'HatchStyle50Percent'
- HatchStyle60Percent = 'HatchStyle60Percent'
- HatchStyle70Percent = 'HatchStyle70Percent'
- HatchStyle75Percent = 'HatchStyle75Percent'
- HatchStyle80Percent = 'HatchStyle80Percent'
- HatchStyle90Percent = 'HatchStyle90Percent'
- HatchStyleLightDownwardDiagonal = 'HatchStyleLightDownwardDiagonal'
- HatchStyleLightUpwardDiagonal = 'HatchStyleLightUpwardDiagonal'
- HatchStyleDarkDownwardDiagonal = 'HatchStyleDarkDownwardDiagonal'
- HatchStyleDarkUpwardDiagonal = 'HatchStyleDarkUpwardDiagonal'
- HatchStyleWideDownwardDiagonal = 'HatchStyleWideDownwardDiagonal'
- HatchStyleWideUpwardDiagonal = 'HatchStyleWideUpwardDiagonal'
- HatchStyleLightVertical = 'HatchStyleLightVertical'
- HatchStyleLightHorizontal = 'HatchStyleLightHorizontal'
- HatchStyleNarrowVertical = 'HatchStyleNarrowVertical'
- HatchStyleNarrowHorizontal = 'HatchStyleNarrowHorizontal'
- HatchStyleDarkVertical = 'HatchStyleDarkVertical'
- HatchStyleDarkHorizontal = 'HatchStyleDarkHorizontal'
- HatchStyleDashedDownwardDiagonal = 'HatchStyleDashedDownwardDiagonal'
- HatchStyleDashedUpwardDiagonal = 'HatchStyleDashedUpwardDiagonal'
- HatchStyleDashedHorizontal = 'HatchStyleDashedHorizontal'
- HatchStyleDashedVertical = 'HatchStyleDashedVertical'
- HatchStyleSmallConfetti = 'HatchStyleSmallConfetti'
- HatchStyleLargeConfetti = 'HatchStyleLargeConfetti'
- HatchStyleZigZag = 'HatchStyleZigZag'
- HatchStyleWave = 'HatchStyleWave'
- HatchStyleDiagonalBrick = 'HatchStyleDiagonalBrick'
- HatchStyleHorizontalBrick = 'HatchStyleHorizontalBrick'
- HatchStyleWeave = 'HatchStyleWeave'
- HatchStylePlaid = 'HatchStylePlaid'
- HatchStyleDivot = 'HatchStyleDivot'
- HatchStyleDottedGrid = 'HatchStyleDottedGrid'
- HatchStyleDottedDiamond = 'HatchStyleDottedDiamond'
- HatchStyleShingle = 'HatchStyleShingle'
- HatchStyleTrellis = 'HatchStyleTrellis'
- HatchStyleSphere = 'HatchStyleSphere'
- HatchStyleSmallGrid = 'HatchStyleSmallGrid'
- HatchStyleSmallCheckerBoard = 'HatchStyleSmallCheckerBoard'
- HatchStyleLargeCheckerBoard = 'HatchStyleLargeCheckerBoard'
- HatchStyleOutlinedDiamond = 'HatchStyleOutlinedDiamond'
- class rs2.modeler.properties.PropertyEnums.UnloadingConditions(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- MEAN_STRESS = 'UC_MEAN_STRESS'
- DEVIATORIC_STRESS = 'UC_DEVIATORIC_STRESS'
- VOLUMETRIC_STRAIN = 'UC_VOLUMETRIC_STRAIN'
- DEVIATORIC_STRAIN = 'UC_DEVIATORIC_STRAIN'
- class rs2.modeler.properties.PropertyEnums.CustomMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- CUSTOM_Q = 'CUSTOM_Q'
- CUSTOM_P = 'CUSTOM_P'
- CUSTOM_S3 = 'CUSTOM_S3'
- CUSTOM_U = 'CUSTOM_U'
- CUSTOM_EPSV = 'CUSTOM_EPSV'
- CUSTOM_GAMMA = 'CUSTOM_GAMMA'
- class rs2.modeler.properties.PropertyEnums.StressHistoryTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- OVER_CONSOLIDATION_OCR = 'SHT_OCR'
- PRECONSOLIDATION_PRESSURE_PC = 'SHT_PC'
- class rs2.modeler.properties.PropertyEnums.StressHistoryDefinitionMethods(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- STRESS_HISTORY_CONSTANT = 'STRESS_HISTORY_CONSTANT'
- STRESS_HISTORY_DEPTH = 'STRESS_HISTORY_DEPTH'
- STRESS_HISTORY_ELEVATION = 'STRESS_HISTORY_ELEVATION'
- class rs2.modeler.properties.PropertyEnums.MaterialBehaviours(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- DRAINED = 'DRAINED'
- UNDRAINED = 'UNDRAINED'
- class rs2.modeler.properties.PropertyEnums.StrengthCriteriaTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- MOHR_COULOMB = 'MOHR_COULOMB'
- HOEK_BROWN = 'HOEK_BROWN'
- DRUCKER_PRAGER = 'DRUCKER_PRAGER'
- GENERALIZED_HOEK_BROWN = 'GENERALIZED_HOEK_BROWN'
- CAM_CLAY = 'CAM_CLAY'
- MODIFIED_CAM_CLAY = 'MODIFIED_CAM_CLAY'
- DISCRETE_FUNCTION = 'DISCRETE_FUNCTION'
- MOHR_COULOMB_CAP = 'MOHR_COULOMB_CAP'
- SOFTENING_HARDENING = 'SOFTENING_HARDENING'
- BARTON_BANDIS = 'BARTON_BANDIS'
- HYPERBOLIC = 'HYPERBOLIC'
- POWER_CURVE = 'POWER_CURVE'
- SHEAR_NORMAL_FUNCTION = 'SHEAR_NORMAL_FUNCTION'
- BOUNDING_SURFACE_PLASTICITY = 'BOUNDING_SURFACE_PLASTICITY'
- MANZARI_AND_DAFALIAS = 'MANZARI_AND_DAFALIAS'
- SNOWDEN_MODIFIED_ANISOTROPIC_LINEAR = 'SNOWDEN_MODIFIED_ANISOTROPIC_LINEAR'
- ANISOTROPIC_LINEAR = 'ANISOTROPIC_LINEAR'
- GENERALIZED_ANISOTROPIC = 'GENERALIZED_ANISOTROPIC'
- SHANSEP = 'SHANSEP'
- VERTICAL_STRESS_RATIO = 'VERTICAL_STRESS_RATIO'
- BARCELONA_BASIC = 'BARCELONA_BASIC'
- CHSOIL = 'CHSOIL'
- CYSOIL = 'CYSOIL'
- DOUBLE_YIELD = 'DOUBLE_YIELD'
- HARDENING_SOIL = 'HARDENING_SOIL'
- HARDENING_SOIL_SMALL_STRAIN_STIFFNESS = 'HARDENING_SOIL_SMALL_STRAIN_STIFFNESS'
- SOFT_SOIL = 'SOFT_SOIL'
- SOFT_SOIL_CREEP = 'SOFT_SOIL_CREEP'
- SWELLING_ROCK = 'SWELLING_ROCK'
- JOINTED_MOHR_COULOMB = 'JOINTED_MOHR_COULOMB'
- JOINTED_GENERALIZED_HOEK_BROWN = 'JOINTED_GENERALIZED_HOEK_BROWN'
- NORSAND = 'NORSAND'
- FINN = 'FINN'
- PM4_SAND = 'PM4_SAND'
- PM4_SILT = 'PM4_SILT'
- class rs2.modeler.properties.PropertyEnums.HuTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- CUSTOM = 'HT_CUSTOM'
- AUTO = 'HT_AUTO'
- class rs2.modeler.properties.PropertyEnums.EnhancedSimpleSoilTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- GENERAL = 'SL_ES_SOIL_TYPE_GENERAL'
- SAND = 'SL_ES_SOIL_TYPE_SAND'
- SILT = 'SL_ES_SOIL_TYPE_SILT'
- CLAY = 'SL_ES_SOIL_TYPE_CLAY'
- LOAM = 'SL_ES_SOIL_TYPE_LOAM'
- class rs2.modeler.properties.PropertyEnums.DilationOption(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- DILATION_ONLY = 'DILATION_ONLY'
- DILATION_ROWES = 'DILATION_ROWES'
- class rs2.modeler.properties.PropertyEnums.CySoilCapOption(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- NON = 'CYS_CAP_NON'
- ELLIPTICAL = 'CYS_CAP_ELLIPTICAL'
- class rs2.modeler.properties.PropertyEnums.Dilatancy(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- DILATANCY_DEACTIVATED = 'DILATANCY_DEACTIVATED'
- DILATANCY_ACTIVATED = 'DILATANCY_ACTIVATED'
- class rs2.modeler.properties.PropertyEnums.InitialConsolidation(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- OVER_CONSOLIDATION_RATIO = 'OVER_CONSOLIDATION_RATIO'
- INITIAL_MEAN_STRESS = 'CONSOL_INITIAL_MEAN_STRESS'
- class rs2.modeler.properties.PropertyEnums.SwellingForm(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- WITTKE = 'WITTKE'
- ANAGNOSTOU = 'ANAGNOSTOU'
- class rs2.modeler.properties.PropertyEnums.WaterCondition(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- SWELLING = 'SWELLING'
- SWELLING_WITH_WATER = 'SWELLING_WITH_WATER'
- class rs2.modeler.properties.PropertyEnums.ViscoElasticTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- MAXWELL = 'VET_MAXWELL'
- BURGERS = 'VET_BURGERS'
- STANDARD = 'VET_STANDARD'
- class rs2.modeler.properties.PropertyEnums.NorSandInitialConsolidationCondition(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- OCR = 'NORSAND_OCR'
- INITIAL_MEAN_STRESS = 'NORSAND_INITIAL_MEAN_STRESS'
- class rs2.modeler.properties.PropertyEnums.FinnFormula(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- FINN_MARTIN = 'FINN_MARTIN'
- FINN_BYRNE = 'FINN_BYRNE'
- class rs2.modeler.properties.PropertyEnums.FinnByrneDefinition(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- FINN_BYRNE_C1_C2 = 'FINN_BYRNE_C1_C2'
- FINN_BYRNE_N1 = 'FINN_BYRNE_N1'
- class rs2.modeler.properties.PropertyEnums.DatumType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- DATUM_TYPE_DEPTH = 'DATUM_TYPE_DEPTH'
- DATUM_TYPE_RADIAL = 'DATUM_TYPE_RADIAL'
- class rs2.modeler.properties.PropertyEnums.SnowdenAnisotropicFunctionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- FUNCTION_TYPE_SHEAR_NORMAL = 'FUNCTION_TYPE_SHEAR_NORMAL'
- FUNCTION_TYPE_COHESION_PHI = 'FUNCTION_TYPE_COHESION_PHI'
- class rs2.modeler.properties.PropertyEnums.InterpolationMethod(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- THIN_PLATE_SPLINE = 'BCINTERPOLATE_THINPLATESPLINE'
- MODIFIED_CHUGH = 'BCINTERPOLATE_CHUGH'
- LOCAL_THIN_PLATE_SPLINE = 'BCINTERPOLATE_LOCALTHINPLATESPLINE'
- TIN_TRIANGULATION = 'BCINTERPOLATE_TINTRIANGULATION'
- INVERSE_DISTANCE = 'BCINTERPOLATE_INVERSEDISTANCE'
- LINEAR_BY_ELEVATION = 'BCINTERPOLATE_LINEARBYELEVATION'
- CHUGH = 'BCINTERPOLATE_ORIGINALCHUGH'
- class rs2.modeler.properties.PropertyEnums.SymbolTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- SQUARE = 'SL_SYMBOL_TYPE_SQUARE'
- TRIANGLE = 'SL_SYMBOL_TYPE_TRI'
- RHOMB = 'SL_SYMBOL_TYPE_RHOMB'
- CIRCLE = 'SL_SYMBOL_TYPE_CIRCLE'
- VERT_CROSS = 'SL_SYMBOL_TYPE_CROSS'
- DIAG_CROSS = 'SL_SYMBOL_TYPE_X'
- DOT = 'SL_SYMBOL_TYPE_DOT'
rs2.modeler.properties.RelativeStageFactorInterface module
- class rs2.modeler.properties.RelativeStageFactorInterface.RelativeStageFactorInterface(client, proxyId, propertyID, definedFactorClass, factorClass)
Bases:
ProxyObject
,Generic
[DefinedStageFactor
,StageFactor
]Examples
Code Snippet: Manipulation of Stage Factors for various properties
- getDefinedStageFactors() dict[int, DefinedStageFactor]
Returns a map of stage factors. The key is the absolute or relative stage at which the stage factor is applied. The value is the stage factor object
- getStageFactor(stage: int) StageFactor
Returns the stage factor for the given stage.
- createStageFactor(stage: int) DefinedStageFactor
Creates a stage factor for the given stage.
NOTE: Invalidates any existing stage factor proxies. Get them again using getDefinedStageFactors or getStageFactor.
- setDefinedStageFactors(method: StageFactorDefinitionMethod, stageFactors: dict[int, StageFactor])
Sets the defined stage factors to those given. The method indicates if the stages in the keys of the map are absolute or relative.
NOTE: Invalidates any existing stage factor proxies. Get them again using getDefinedStageFactors or getStageFactor.
- getStageFactorMethod() StageFactorDefinitionMethod
rs2.modeler.properties.ShearNormalFunction module
- class rs2.modeler.properties.ShearNormalFunction.ShearNormalFunction(client: Client, ID)
Bases:
ProxyObject
- getName() str
- setMaterialType(materialType: MaterialType)
- getMaterialType() str
- setPeakTensileStrength(peakTensileStrength: float)
- getPeakTensileStrength() float
- setResidualTensileStrength(residualTensileStrength: float)
- getResidualTensileStrength() float
- setDilationRatio(dilationRatio: float)
- getDilationRatio() float
- setUseCalculatedTensileStrength(useCalculatedTensileStrength: bool)
- getUseCalculatedTensileStrength() bool
- setFunctionPoints(functionPoints: list[tuple[float, float, float]])
set the function points. Each point has (normal, shear, residual shear). Residual shear is ignored if the material type is not plastic. Function must not be concave. If a concave function is provided, it will transform the function into a convex function.
- Parameters:
functionPoints – list of tuples of (normal, shear, residual shear)
- Returns:
None
- getFunctionPoints() list[tuple[float, float, float]]
returns the function points as a list of tuples of (normal, shear, residual shear). Residual shear is ignored if the material type is not plastic.
- Returns:
list of tuples of (normal, shear, residual shear)
- Return type:
list[tuple(float,float,float)]
rs2.modeler.properties.SnowdenAnisotropicFunction module
- class rs2.modeler.properties.SnowdenAnisotropicFunction.SnowdenAnisotropicFunction(client: Client, ID)
Bases:
ProxyObject
- setFunctionType(functionType: SnowdenAnisotropicFunctionType)
- getFunctionType() SnowdenAnisotropicFunctionType
- setPeakTensileStrength(peakTensileStrength: float)
- getPeakTensileStrength() float
- setResidualTensileStrength(residualTensileStrength: float)
- getResidualTensileStrength() float
- setDilationRatio(dilationRatio: float)
- getDilationRatio() float
- setShearNormalFunction(normalStress: list[float], shearStress: list[float])
- setShearNormalFunctionWithResidual(normalStress: list[float], shearStress: list[float], residualShearStress: list[float])
- setCohesionFrictionFunction(normalStress: list[float], cohesion: list[float], frictionAngle: list[float])
- setCohesionFrictionFunctionWithResidual(normalStress: list[float], cohesion: list[float], frictionAngle: list[float], residualCohesion: list[float], residualFrictionAngle: list[float])
- getNormalStress() list[float]
- getShearStress() list[float]
- getResidualShearStress() list[float]
- getCohesion() list[float]
- getFrictionAngle() list[float]
- getResidualCohesion() list[float]
- getResidualFrictionAngle() list[float]
rs2.modeler.properties.StructuralInterface module
- class rs2.modeler.properties.StructuralInterface.StructuralInterfaceProperty(server: Client, ID, documentProxyID)
Bases:
PropertyProxy
Examples
Code Snippet: Manipulation of Structural Interface Properties
- getStructuralInterfaceName() str
Returns the structural interface name
- setStructuralInterfaceName(name: str)
Sets structural interface name
- getColor() int
Returns the structural interface color
- setColor(color: int)
Sets structural interface color
- getPositiveJointPropertyName() str
Returns the positive side joint property name
- setPositiveJointPropertyByName(jointName: str)
Set positive side joint property by name
- getNegativeJointPropertyName() str
Returns the negative side joint property name
- setNegativeJointPropertyByName(jointName: str)
Set negative side joint property by name
- getLinerPropertyName() str
Returns the liner property name
- setLinerPropertyByName(linerName: str)
Set liner property by name
rs2.modeler.properties.UserDefinedWaterMode module
- class rs2.modeler.properties.UserDefinedWaterMode.UserDefinedWaterMode(client: Client, ID)
Bases:
ProxyObject
- setWaterContentInputType(inputType: WCInputType)
- getWaterContentInputType() WCInputType
- getWaterContentFunction() list[tuple[float, float]]
- setWaterContentFunction(wcFunction: list[tuple[float, float]])
- getDegreeOfSaturationFunction() list[tuple[float, float]]
- setDegreeOfSaturationFunction(dosFunction: list[tuple[float, float]])
- getPermeabilityFunction() list[tuple[float, float]]
- setPermeabilityFunction(strengthFunction: list[tuple[float, float]])