SurfaceCollection

class rips.SurfaceCollection(pb2_object: PdmObject | None = None, channel: Channel | None = None)

Bases: PdmObjectBase

surface_user_decription

Name

Type:

str

Methods Summary

add_folder([folder_name])

Add a new surface folder

import_surface([file_name])

Import a new surface from file

new_surface([case, k_index])

Create a new surface

sub_collections()

Surfaces

surfaces_field()

Surfaces

Methods Documentation

add_folder(folder_name: str = 'Surfaces') SurfaceCollection | None

Add a new surface folder

Parameters:

folder_name (str) -- New surface folder name

Returns:

SurfaceCollection

import_surface(file_name: str = '') Surface | None

Import a new surface from file

Parameters:

file_name (str) -- Filename to import surface from

Returns:

Surface

new_surface(case: Case | None = None, k_index: int = 0) GridCaseSurface | None

Create a new surface

Parameters:
  • case (Optional[Case]) --

  • k_index (int) --

Returns:

GridCaseSurface

sub_collections() List[SurfaceCollection]

Surfaces

Returns:

List[SurfaceCollection]

surfaces_field() List[SurfaceInterface]

Surfaces

Returns:

List[SurfaceInterface]