# API reference

This section documents the public API of PyFVTool and is generated automatically from the source code docstrings.



## To do: API documentation

- improve docstrings
- re-verify the `automodule` directives (in `docs/api/index.md`) 
- `docs/api/index.md` is just a plain Markdown file, it can be edited freely. Add the missing modules and restructure however makes sense.



## Meshes

```{eval-rst}
.. automodule:: pyfvtool.mesh
   :members:
   :undoc-members: False
```

## Cell and face variables

### Cell variables

```{eval-rst}
.. automodule:: pyfvtool.cell
   :members:
   :undoc-members: False
```

### Face variables

```{eval-rst}
.. automodule:: pyfvtool.face
   :members:
   :undoc-members: False
```


## Boundary conditions

```{eval-rst}
.. automodule:: pyfvtool.boundary
   :members:
   :undoc-members: False
```

## Discretization terms

### Diffusion terms

```{eval-rst}
.. automodule:: pyfvtool.diffusion
   :members:
   :undoc-members: False
```

### Advection terms

```{eval-rst}
.. automodule:: pyfvtool.advection
   :members:
   :undoc-members: False
```

### Source terms

```{eval-rst}
.. automodule:: pyfvtool.source
   :members:
   :undoc-members: False
```





## Solver

```{eval-rst}
.. automodule:: pyfvtool.pdesolver
   :members:
   :undoc-members: False
```

## Averaging utilities

```{eval-rst}
.. automodule:: pyfvtool.averaging
   :members:
   :undoc-members: False
```

## Visualization

```{eval-rst}
.. automodule:: pyfvtool.visualization
   :members:
   :undoc-members: False
```