grpc4bmi.reserve module

Helpers to reserve numpy arrays for use in some of the Bmi methods as output argument

grpc4bmi.reserve.reserve_grid_edge_nodes(model: Bmi, grid_id: int) → ndarray

Reserve edge_nodes for bmipy.Bmi.get_grid_edge_nodes()

grpc4bmi.reserve.reserve_grid_face_(model: Bmi, grid_id: int) → ndarray

Reserve face_edges or face_node in respectivly bmipy.Bmi.get_grid_face_edges() or bmipy.Bmi.get_grid_face_nodes()

grpc4bmi.reserve.reserve_grid_nodes(model: Bmi, grid_id: int, dim_index: int) → ndarray

Reserve dest for bmipy.Bmi.get_grid_x(), bmipy.Bmi.get_grid_y() and bmipy.Bmi.get_grid_z()

The dim_index goes x,y,z and model.get_grid_shape goes z,y,x or y,x so index is inverted

grpc4bmi.reserve.reserve_grid_nodes_per_face(model: Bmi, grid_id: int) → ndarray

Reserve nodes_per_face for bmipy.Bmi.get_grid_nodes_per_face()

grpc4bmi.reserve.reserve_grid_padding(model: Bmi, grid_id: int) → ndarray

Reserve dest for bmipy.Bmi.get_grid_spacing() and bmipy.Bmi.get_grid_origin()

grpc4bmi.reserve.reserve_grid_shape(model: Bmi, grid_id: int) → ndarray

Reserve shape for bmipy.Bmi.get_grid_shape()

grpc4bmi.reserve.reserve_values(model: Bmi, name: str) → ndarray

Reserve dest for bmipy.Bmi.get_value()

grpc4bmi.reserve.reserve_values_at_indices(model: Bmi, name: str, indices) → ndarray

Reserve dest for bmipy.Bmi.get_value_at_indices()