SurfaceCollection

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

Bases: PdmNestedCollectionBase

surface_user_description

Name

Type:

str

Methods Summary

import_surface([file_name])	Import a new surface from file
new_regular_surface([name, origin_x, ...])	Create a new regular surface
new_surface([case, k_index])	Create a new surface
sub_collections()	Surfaces
surfaces_field()	Surfaces

Methods Documentation

import_surface(file_name: str = '') → Surface

Import a new surface from file

Parameters:

file_name (str) -- Filename to import surface from

Returns:

Surface

new_regular_surface(name: str = '', origin_x: float = 0.0, origin_y: float = 0.0, depth: float = 0.0, nx: int = 10, ny: int = 10, increment_x: float = 20.0, increment_y: float = 20.0, rotation: float = 0.0) → RegularSurface

Create a new regular surface

Parameters:

• name (str)

• origin_x (float)

• origin_y (float)

• depth (float)

• nx (int)

• ny (int)

• increment_x (float)

• increment_y (float)

• rotation (float)

Returns:

RegularSurface

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

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]