get_surface_diagnostic_summary

SurfaceSearch.get_surface_diagnostic_summary(params)

Gets the surface diagnostic summary.

Diagnose surface connectivity for the given scope and controls provided by the surface diagnostic summary parameters.

Parameters:

paramsSurfaceDiagnosticSummaryParams

Surface diagnostic summary parameters.

Returns:

SurfaceDiagnosticSummaryResults

Returns the SurfaceDiagnosticSummaryResults.

Return type:

SurfaceDiagnosticSummaryResults

Examples

>>> surf_search = SurfaceSearch(model=model)
>>> results = surf_search.get_surface_diagnostics_summary(SurfaceDiagnosticSummaryParams(model=model))