remotebmi.server.api

Module Contents

remotebmi.server.api.model() → bmipy.Bmi

remotebmi.server.api.initialize(body: dict[Literal['config_file'], str]) → None

remotebmi.server.api.update() → None

remotebmi.server.api.update_until(until: float) → None

remotebmi.server.api.finalize() → None

remotebmi.server.api.get_component_name() → dict[str, str]

remotebmi.server.api.get_input_var_names() → list[str]

remotebmi.server.api.get_output_var_names() → list[str]

remotebmi.server.api.get_input_item_count() → int

remotebmi.server.api.get_output_item_count() → int

remotebmi.server.api.get_var_grid(name: str) → int

remotebmi.server.api.get_var_type(name: str) → dict[str, str]

remotebmi.server.api.get_var_units(name: str) → dict[str, str]

remotebmi.server.api.get_var_nbytes(name: str) → int

remotebmi.server.api.get_var_location(name: str) → dict[str, str]

remotebmi.server.api.get_var_itemsize(name: str) → int

remotebmi.server.api.get_value(name: str) → list[int | float]

remotebmi.server.api.get_value_at_indices(name: str, indices: numpy.ndarray) → list[int | float]

remotebmi.server.api.set_value(name: str, src: list) → None

remotebmi.server.api.set_value_at_indices(name: str, indices: list, values: list) → None

remotebmi.server.api.get_grid_rank(grid: int) → int

remotebmi.server.api.get_grid_type(grid: int) → dict[str, str]

remotebmi.server.api.get_grid_shape(grid: int) → list[int]

remotebmi.server.api.get_grid_size(grid: int) → int

remotebmi.server.api.get_grid_spacing(grid: int) → list[float]

remotebmi.server.api.get_grid_origin(grid: int) → list[float]

remotebmi.server.api.get_grid_x(grid: int) → list[float]

remotebmi.server.api.get_grid_y(grid: int) → list[float]

remotebmi.server.api.get_grid_z(grid: int) → list[float]

remotebmi.server.api.get_start_time() → float

remotebmi.server.api.get_end_time() → float

remotebmi.server.api.get_current_time() → float

remotebmi.server.api.get_time_step() → float

remotebmi.server.api.get_time_units() → dict[str, str]

remotebmi.server.api.get_grid_edge_count(grid: int) → int

remotebmi.server.api.get_grid_face_count(grid: int) → int

remotebmi.server.api.get_grid_edge_nodes(grid: int) → list[int]

remotebmi.server.api.get_grid_face_edges(grid: int) → list[int]

remotebmi.server.api.get_grid_face_nodes(grid: int) → list[int]

remotebmi.server.api.get_grid_nodes_per_face(grid: int) → list[int]

remotebmi.server.api.get_grid_node_count(grid: int) → int