rs3.Compute module#
- class rs3.Compute.StageSRFValueConvergenceStatus(isRecovery: bool, stagesConvergence: list[rs3.generatedFiles.ComputeService_pb2.convergenceStatus], srfValuesConvergence: list[rs3.generatedFiles.ComputeService_pb2.convergenceStatus])#
Bases:
object- property IsRecovery#
- property StagesConvergence#
- property SrfValuesConvergence#
- property Printable#
- Print()#
- class rs3.Compute.Compute(client: Client, projectId: str)#
Bases:
_ProxyObjectExample
- compute(computeType: ComputeType = ComputeType.ALL, computeStart: ComputeStart = ComputeStart.AFTER_LAST_COMPUTED_STAGE) tuple[bool, str]#
Compute stress results (automatically compute groundwater too, if required). Mesh is required before compute.
- computeGroundWater() tuple[bool, str]#
Compute groundwater only (stress analysis will not be computed). Mesh is required before compute.
- printConvergenceStatus()#
- readConvergenceStatus() tuple[bool, str, StageSRFValueConvergenceStatus]#
This function returns the availability of convergence status, error message if there is any, and convergence status. To check the convergence of each stage, users may check StagesConvergence and SrfValuesConvergence of StageSRFValueConvergenceStatus.