Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 48 additions & 24 deletions docs/source/bmi.control_funcs.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,28 @@ updating.

:::{tab-item} SIDL
:sync: sidl
```java
int initialize(in string config_file);
```{map-bmi-function} initialize
:language: sidl
```
:::

:::{tab-item} Python
:sync: python
```python
def initialize(self, config_file: str) -> None:
```{map-bmi-function} initialize
:language: python
```
:::

:::{tab-item} c
:sync: c
```c
int initialize(void *self, char *config_file);
```{map-bmi-function} initialize
:language: c
```
:::
:::{tab-item} c++
:sync: c++
```{map-bmi-function} initialize
:language: c++
```
:::
::::
Expand Down Expand Up @@ -68,22 +74,28 @@ formatted.

:::{tab-item} SIDL
:sync: sidl
```java
int update();
```{map-bmi-function} update
:language: sidl
```
:::

:::{tab-item} Python
:sync: python
```python
def update(self) -> None:
```{map-bmi-function} update
:language: python
```
:::

:::{tab-item} c
:sync: c
```c
int update(void *self);
```{map-bmi-function} update
:language: c
```
:::
:::{tab-item} c++
:sync: c++
```{map-bmi-function} update
:language: c++
```
:::
::::
Expand Down Expand Up @@ -113,21 +125,27 @@ function can just return without doing anything.

:::{tab-item} SIDL
:sync: sidl
```java
int update_until(in double time);
```{map-bmi-function} update_until
:language: sidl
```
:::

:::{tab-item} Python
:sync: python
```python
def update_until(self, time: float) -> None:
```{map-bmi-function} update_until
:language: python
```
:::
:::{tab-item} c
:sync: c
```c
int update_until(void *self, double then);
```{map-bmi-function} update_until
:language: c
```
:::
:::{tab-item} c++
:sync: c++
```{map-bmi-function} update_until
:language: c++
```
:::
::::
Expand Down Expand Up @@ -156,22 +174,28 @@ to reflect that the model was updated to the requested time.

:::{tab-item} SIDL
:sync: sidl
```java
int finalize();
```{map-bmi-function} finalize
:language: sidl
```
:::

:::{tab-item} Python
:sync: python
```python
def finalize(self) -> None:
```{map-bmi-function} finalize
:language: python
```
:::

:::{tab-item} c
:sync: c
```c
int finalize(void *self);
```{map-bmi-function} finalize
:language: c
```
:::
:::{tab-item} c++
:sync: c++
```{map-bmi-function} finalize
:language: c++
```
:::
::::
Expand Down
98 changes: 60 additions & 38 deletions docs/source/bmi.getter_setter.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,27 @@ state variable can be changed or check the new data for validity.

:::{tab-item} SIDL
:sync: sidl
```java
int get_value(in string name, in array<> dest);
```{map-bmi-function} get_value
:language: sidl
```
:::

:::{tab-item} Python
:sync: python
```python
def get_value(self, name: str, dest: NDArray[Any]) -> NDArray[Any]:
```{map-bmi-function} get_value
:language: python
```
:::
:::{tab-item} c
:sync: c
```c
int get_value(void *self, const char *name, void *dest);
```{map-bmi-function} get_value
:language: c
```
:::
:::{tab-item} c++
:sync: c++
```{map-bmi-function} get_value
:language: c++
```
:::
::::
Expand Down Expand Up @@ -74,21 +80,27 @@ even if the model uses dimensional variables.

:::{tab-item} SIDL
:sync: sidl
```java
int get_value_ptr(in string name, out array<> dest_ptr);
```{map-bmi-function} get_value_ptr
:language: sidl
```
:::

:::{tab-item} Python
:sync: python
```python
def get_value_ptr(self, name: str) -> NDArray[Any]:
```{map-bmi-function} get_value_ptr
:language: python
```
:::
:::{tab-item} c
:sync: c
```c
int get_value_ptr(void *self, const char *name, void **dest_ptr);
```{map-bmi-function} get_value_ptr
:language: c
```
:::
:::{tab-item} c++
:sync: c++
```{map-bmi-function} get_value_ptr
:language: c++
```
:::
::::
Expand Down Expand Up @@ -118,25 +130,27 @@ even if the model's state has changed.

:::{tab-item} SIDL
:sync: sidl
```java
int get_value_at_indices(in string name, in array<> dest, in array<int, 1> inds);
```{map-bmi-function} get_value_at_indices
:language: sidl
```
:::

:::{tab-item} Python
:sync: python
```python
def get_value_at_indices(
self, name: str, dest: NDArray[Any], inds: NDArray[np.int_]
) -> NDArray[Any]:
```{map-bmi-function} get_value_at_indices
:language: python
```
:::
:::{tab-item} c
:sync: c
```c
int get_value_at_indices(
void *self, const char *name, void *dest, int *inds, int count
);
```{map-bmi-function} get_value_at_indices
:language: c
```
:::
:::{tab-item} c++
:sync: c++
```{map-bmi-function} get_value_at_indices
:language: c++
```
:::
::::
Expand All @@ -163,21 +177,27 @@ Additionally,

:::{tab-item} SIDL
:sync: sidl
```java
int set_value(in string name, in array<> src);
```{map-bmi-function} set_value
:language: sidl
```
:::

:::{tab-item} Python
:sync: python
```python
def set_value(self, name: str, src: NDArray[Any]) -> None:
```{map-bmi-function} set_value
:language: python
```
:::
:::{tab-item} c
:sync: c
```c
int set_value(void *self, const char *name, void *src);
```{map-bmi-function} set_value
:language: c
```
:::
:::{tab-item} c++
:sync: c++
```{map-bmi-function} set_value
:language: c++
```
:::
::::
Expand Down Expand Up @@ -213,25 +233,27 @@ even if the model uses dimensional variables.

:::{tab-item} SIDL
:sync: sidl
```java
int set_value_at_indices(in string name, in array<int, 1> inds, in array<> src);
```{map-bmi-function} set_value_at_indices
:language: sidl
```
:::

:::{tab-item} Python
:sync: python
```python
def set_value_at_indices(
self, name: str, inds: NDArray[np.int_], src: NDArray[Any]
) -> None:
```{map-bmi-function} set_value_at_indices
:language: python
```
:::
:::{tab-item} c
:sync: c
```c
int set_value_at_indices(
void *self, const char *name, int *inds, int count, void *src
);
```{map-bmi-function} set_value_at_indices
:language: c
```
:::
:::{tab-item} c++
:sync: c++
```{map-bmi-function} set_value_at_indices
:language: c++
```
:::
::::
Expand Down
Loading