rs3.properties.material.constitutiveModel.Shansep module#
- class rs3.properties.material.constitutiveModel.Shansep.ShansepBase(client: Client, id: str)#
Bases:
_ProxyObject,IPropertyGroupAccessors- getAParameter() float#
- setAParameter(value: float)#
- getResidualAParameter() float#
- setResidualAParameter(value: float)#
- getSParameter() float#
- setSParameter(value: float)#
- getResidualSParameter() float#
- setResidualSParameter(value: float)#
- getMParameter() float#
- setMParameter(value: float)#
- getResidualMParameter() float#
- setResidualMParameter(value: float)#
- getMaximumShearStrength() float#
- setMaximumShearStrength(value: float)#
- getResidualTensileStrength() float#
- setResidualTensileStrength(value: float)#
- getStressHistoryConstant() float#
- setStressHistoryConstant(value: float)#
- getTensileStrength() float#
- setTensileStrength(value: float)#
- getUseMaximumShearStrength() bool#
- setUseMaximumShearStrength(value: bool)#
- getUseTensileStrength() bool#
- setUseTensileStrength(value: bool)#
- getUseMaterialDependentStress() bool#
- setUseMaterialDependentStress(value: bool)#
- getResidualMaximumShearStrength() float#
- setResidualMaximumShearStrength(value: float)#
- getApplySSRShearStrengthReduction() bool#
- setApplySSRShearStrengthReduction(value: bool)#
- getProperties()#
Retrieve properties as a dictionary.
- setProperties(AParameter: float = None, ResidualAParameter: float = None, SParameter: float = None, ResidualSParameter: float = None, MParameter: float = None, ResidualMParameter: float = None, MaximumShearStrength: float = None, ResidualTensileStrength: float = None, StressHistoryConstant: float = None, TensileStrength: float = None, UseMaximumShearStrength: bool = None, UseTensileStrength: bool = None, UseMaterialDependentStress: bool = None, ResidualMaximumShearStrength: float = None, ApplySSRShearStrengthReduction: bool = None)#
Set properties using keyword arguments.
- class rs3.properties.material.constitutiveModel.Shansep.Shansep(client: Client, id: str)#
Bases:
ShansepBase,BaseConstitutiveModel- getStressHistoryType() StressHistoryTypes#
- setStressHistoryType(StressHistoryType: StressHistoryTypes)#
- getStressHistoryTypeMethod() StressHistoryDefinitionMethods#
- setStressHistoryTypeMethod(StressHistoryTypeMethod: StressHistoryDefinitionMethods)#
- getShansepMaterialDependentVerticalStress() list[tuple[str, float]]#
Retrieve the material dependant stress function points for the current material.
- Returns:
A list of tuples, where each tuple contains: - materialName (str): The material name. - vertucalStressFactor (float): The corresponding vertical stress factor.
- Return type:
list[tuple[str, float]]
- setShansepMaterialDependentVerticalStress(value: list[tuple[str, float]])#
Set the material dependant stress function points for the current material.
- Parameters:
value (list[tuple[str, float]]) – A list of tuples, where each tuple contains: - materialName (str): The material name. - vertucalStressFactor (float): The corresponding vertical stress factor.
- getShansepStressHistory() list[tuple[float, float]]#
Retrieve the stress history points for the current material.
- Returns:
A list of tuples, where each tuple contains: - depth/elevation (float): The depth or elevation value. - OCR/Pc (float): The corresponding overconsolidation ratio (OCR) value or preconsolidation pressure.
- Return type:
list[tuple[float, float]]
- setShansepStressHistory(headerList: tuple[StressHistoryDefinitionMethods, StressHistoryTypes], value: list[tuple[float, float]])#
Set the stress history function points for the current material.
- Parameters:
value (list[tuple[float, float]]) – A list of tuples, where each tuple contains: - depth/elevation (float): The depth or elevation value. - OCR/Pc (float): The corresponding overconsolidation ratio (OCR) value or preconsolidation pressure.