rs2.modeler.properties.pile package

rs2.modeler.properties.pile.Beam module

class rs2.modeler.properties.pile.Beam.Beam(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getLinerProperty() → str

setLinerProperty(linerName: str)

Resets the mesh if it exists.

getBeamSegment() → tuple[list[float], list[str]]

defineBeamSegment(Locations: list[float], Liners: list[str])

Resets the mesh if it exists.

setApplication(method: PileApplicationType)

Resets the mesh if it exists.

getApplication() → PileApplicationType

rs2.modeler.properties.pile.Elastic module

class rs2.modeler.properties.pile.Elastic.Elastic(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getShearStiffness() → float

setShearStiffness(value: float)

getNormalStiffness() → float

setNormalStiffness(value: float)

getUseBaseResistance() → bool

setUseBaseResistance(value: bool)

getBaseNormalStiffness() → float

setBaseNormalStiffness(value: float)

getBaseForceResistance() → float

setBaseForceResistance(value: float)

setProperties(ShearStiffness: float = None, NormalStiffness: float = None, UseBaseResistance: bool = None, BaseNormalStiffness: float = None, BaseForceResistance: float = None)

getProperties()

rs2.modeler.properties.pile.ForceDisplacement module

class rs2.modeler.properties.pile.ForceDisplacement.ForceDisplacementStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getXFactor() → float

getYFactor() → float

class rs2.modeler.properties.pile.ForceDisplacement.ForceDisplacementDefinedStageFactor(client: Client, ID, propertyID)

Bases: ForceDisplacementStageFactor

setXFactor(value: float)

setYFactor(value: float)

class rs2.modeler.properties.pile.ForceDisplacement.ForceDisplacement(client: Client, ID, documentProxyID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Pile Stage Factor Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorInterface[ForceDisplacementDefinedStageFactor, ForceDisplacementStageFactor]

getApply() → PileEndCondition

setApply(value: PileEndCondition)

getApplyOn() → PileForceApplicationPoint

setApplyOn(value: PileForceApplicationPoint)

getX() → float

setX(value: float)

getY() → float

setY(value: float)

setProperties(Apply: PileEndCondition = None, ApplyOn: PileForceApplicationPoint = None, X: float = None, Y: float = None)

getProperties()

rs2.modeler.properties.pile.Linear module

class rs2.modeler.properties.pile.Linear.Linear(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getShearStiffness() → float

setShearStiffness(value: float)

getNormalStiffness() → float

setNormalStiffness(value: float)

getMaxTractionAtTheTop() → float

setMaxTractionAtTheTop(value: float)

getMaxTractionAtTheBottom() → float

setMaxTractionAtTheBottom(value: float)

getUseBaseResistance() → bool

setUseBaseResistance(value: bool)

getBaseNormalStiffness() → float

setBaseNormalStiffness(value: float)

getBaseForceResistance() → float

setBaseForceResistance(value: float)

setProperties(ShearStiffness: float = None, NormalStiffness: float = None, MaxTractionAtTheTop: float = None, MaxTractionAtTheBottom: float = None, UseBaseResistance: bool = None, BaseNormalStiffness: float = None, BaseForceResistance: float = None)

getProperties()

rs2.modeler.properties.pile.MaterialDependentPile module

class rs2.modeler.properties.pile.MaterialDependentPile.MaterialDependentPile(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getInterfaceCoefficient() → float

setInterfaceCoefficient(value: float)

getUseStiffnessMaterialDependent() → bool

setUseStiffnessMaterialDependent(value: bool)

getStiffnessCoefficient() → float

setStiffnessCoefficient(value: float)

getShearStiffness() → float

setShearStiffness(value: float)

getNormalStiffness() → float

setNormalStiffness(value: float)

getUseShearResistanceCutoff() → bool

setUseShearResistanceCutoff(value: bool)

getShearResistanceCutoff() → float

setShearResistanceCutoff(value: float)

getPerimeter() → float

setPerimeter(value: float)

getUseBaseResistance() → bool

setUseBaseResistance(value: bool)

getBaseNormalStiffness() → float

setBaseNormalStiffness(value: float)

getBaseForceResistance() → float

setBaseForceResistance(value: float)

setProperties(InterfaceCoefficient: float = None, UseStiffnessMaterialDependent: bool = None, StiffnessCoefficient: float = None, ShearStiffness: float = None, NormalStiffness: float = None, UseShearResistanceCutoff: bool = None, ShearResistanceCutoff: float = None, Perimeter: float = None, UseBaseResistance: bool = None, BaseNormalStiffness: float = None, BaseForceResistance: float = None)

getProperties()

rs2.modeler.properties.pile.MohrCoulombPile module

class rs2.modeler.properties.pile.MohrCoulombPile.MohrCoulombPile(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getShearStiffness() → float

setShearStiffness(value: float)

getNormalStiffness() → float

setNormalStiffness(value: float)

getFrictionAngle() → float

setFrictionAngle(value: float)

getResidualFrictionAngle() → float

setResidualFrictionAngle(value: float)

getCohesion() → float

setCohesion(value: float)

getResidualCohesion() → float

setResidualCohesion(value: float)

getUseShearResistanceCutoff() → bool

setUseShearResistanceCutoff(value: bool)

getShearResistanceCutoff() → float

setShearResistanceCutoff(value: float)

getPerimeter() → float

setPerimeter(value: float)

getUseBaseResistance() → bool

setUseBaseResistance(value: bool)

getBaseNormalStiffness() → float

setBaseNormalStiffness(value: float)

getBaseForceResistance() → float

setBaseForceResistance(value: float)

setProperties(ShearStiffness: float = None, NormalStiffness: float = None, FrictionAngle: float = None, ResidualFrictionAngle: float = None, Cohesion: float = None, ResidualCohesion: float = None, UseShearResistanceCutoff: bool = None, ShearResistanceCutoff: float = None, Perimeter: float = None, UseBaseResistance: bool = None, BaseNormalStiffness: float = None, BaseForceResistance: float = None)

getProperties()

rs2.modeler.properties.pile.MultiLinear module

class rs2.modeler.properties.pile.MultiLinear.MultiLinear(server: Client, ID, documentProxyID)

Bases: PropertyProxy

getShearStiffness() → float

setShearStiffness(value: float)

getNormalStiffness() → float

setNormalStiffness(value: float)

getDefinitionMethod() → PileDefinitionMethod

setDefinitionMethod(value: PileDefinitionMethod)

getUseBaseResistance() → bool

setUseBaseResistance(value: bool)

getBaseNormalStiffness() → float

setBaseNormalStiffness(value: float)

getBaseForceResistance() → float

setBaseForceResistance(value: float)

getCoordinates() → tuple[list[float], list[float]]

setCoordinates(Location: list[float], Value: list[float])

setProperties(ShearStiffness: float = None, NormalStiffness: float = None, DefinitionMethod: PileDefinitionMethod = None, UseBaseResistance: bool = None, BaseNormalStiffness: float = None, BaseForceResistance: float = None)

getProperties()

rs2.modeler.properties.pile.Pile module

class rs2.modeler.properties.pile.Pile.PileProperty(client: Client, ID, documentProxyID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Pile Properties

Elastic

Reference object for modifying property.

Type:

Elastic

MohrCoulombPile

Reference object for modifying property.

Type:

MohrCoulombPile

Linear

Reference object for modifying property.

Type:

Linear

MultiLinear

Reference object for modifying property.

Type:

MultiLinear

MaterialDependentPile

Reference object for modifying property.

Type:

MaterialDependentPile

Beam

Reference object for modifying property.

Type:

Beam

ForceDisplacement

Reference object for modifying property.

Type:

ForceDisplacement

getPileName() → str

setPileName(value: str)

getPileColor() → int

setPileColor(value: int)

getConnectionType() → PileConnectionType

setConnectionType(value: PileConnectionType)

getSkinResistance() → PileSkinResistanceType

setSkinResistance(value: PileSkinResistanceType)

getMMax() → float

setMMax(MMax: float)

getOutOfPlaneSpacing() → float

setOutOfPlaneSpacing(outOfPlaneSpacing: float)

getLength() → float

setLength(Length: float)

Resets the mesh if it exists.

getStageForceDisplacement() → bool

setStageForceDisplacement(stageForceDisplacement: bool)