# {py:mod}`zoomy_foam.vof`

```{py:module} zoomy_foam.vof
```

```{autodoc2-docstring} zoomy_foam.vof
:parser: zoomy_docstrings
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Arm <zoomy_foam.vof.Arm>`
  - ```{autodoc2-docstring} zoomy_foam.vof.Arm
    :parser: zoomy_docstrings
    :summary:
    ```
* - {py:obj}`Tank <zoomy_foam.vof.Tank>`
  - ```{autodoc2-docstring} zoomy_foam.vof.Tank
    :parser: zoomy_docstrings
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`write_config <zoomy_foam.vof.write_config>`
  - ```{autodoc2-docstring} zoomy_foam.vof.write_config
    :parser: zoomy_docstrings
    :summary:
    ```
* - {py:obj}`write_case <zoomy_foam.vof.write_case>`
  - ```{autodoc2-docstring} zoomy_foam.vof.write_case
    :parser: zoomy_docstrings
    :summary:
    ```
* - {py:obj}`coupling_library <zoomy_foam.vof.coupling_library>`
  - ```{autodoc2-docstring} zoomy_foam.vof.coupling_library
    :parser: zoomy_docstrings
    :summary:
    ```
* - {py:obj}`start <zoomy_foam.vof.start>`
  - ```{autodoc2-docstring} zoomy_foam.vof.start
    :parser: zoomy_docstrings
    :summary:
    ```
* - {py:obj}`to_hdf5 <zoomy_foam.vof.to_hdf5>`
  - ```{autodoc2-docstring} zoomy_foam.vof.to_hdf5
    :parser: zoomy_docstrings
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`FIELDS <zoomy_foam.vof.FIELDS>`
  - ```{autodoc2-docstring} zoomy_foam.vof.FIELDS
    :parser: zoomy_docstrings
    :summary:
    ```
* - {py:obj}`FO_STARSTATE <zoomy_foam.vof.FO_STARSTATE>`
  - ```{autodoc2-docstring} zoomy_foam.vof.FO_STARSTATE
    :parser: zoomy_docstrings
    :summary:
    ```
````

### API

````{py:data} FIELDS
:canonical: zoomy_foam.vof.FIELDS
:value: >
   ('b', 'h', 'u', 'v', 'w', 'p')

```{autodoc2-docstring} zoomy_foam.vof.FIELDS
:parser: zoomy_docstrings
```

````

````{py:data} FO_STARSTATE
:canonical: zoomy_foam.vof.FO_STARSTATE
:value: >
   None

```{autodoc2-docstring} zoomy_foam.vof.FO_STARSTATE
:parser: zoomy_docstrings
```

````

`````{py:class} Arm
:canonical: zoomy_foam.vof.Arm

```{autodoc2-docstring} zoomy_foam.vof.Arm
:parser: zoomy_docstrings
```

````{py:attribute} participant
:canonical: zoomy_foam.vof.Arm.participant
:type: str
:value: >
   None

```{autodoc2-docstring} zoomy_foam.vof.Arm.participant
:parser: zoomy_docstrings
```

````

````{py:attribute} mesh
:canonical: zoomy_foam.vof.Arm.mesh
:type: str
:value: >
   None

```{autodoc2-docstring} zoomy_foam.vof.Arm.mesh
:parser: zoomy_docstrings
```

````

````{py:attribute} vof_mesh
:canonical: zoomy_foam.vof.Arm.vof_mesh
:type: str
:value: >
   None

```{autodoc2-docstring} zoomy_foam.vof.Arm.vof_mesh
:parser: zoomy_docstrings
```

````

````{py:attribute} side
:canonical: zoomy_foam.vof.Arm.side
:type: str
:value: >
   'left'

```{autodoc2-docstring} zoomy_foam.vof.Arm.side
:parser: zoomy_docstrings
```

````

`````

`````{py:class} Tank
:canonical: zoomy_foam.vof.Tank

```{autodoc2-docstring} zoomy_foam.vof.Tank
:parser: zoomy_docstrings
```

````{py:attribute} lx
:canonical: zoomy_foam.vof.Tank.lx
:type: float
:value: >
   1.5

```{autodoc2-docstring} zoomy_foam.vof.Tank.lx
:parser: zoomy_docstrings
```

````

````{py:attribute} ly
:canonical: zoomy_foam.vof.Tank.ly
:type: float
:value: >
   0.4

```{autodoc2-docstring} zoomy_foam.vof.Tank.ly
:parser: zoomy_docstrings
```

````

````{py:attribute} nx
:canonical: zoomy_foam.vof.Tank.nx
:type: int
:value: >
   120

```{autodoc2-docstring} zoomy_foam.vof.Tank.nx
:parser: zoomy_docstrings
```

````

````{py:attribute} ny
:canonical: zoomy_foam.vof.Tank.ny
:type: int
:value: >
   40

```{autodoc2-docstring} zoomy_foam.vof.Tank.ny
:parser: zoomy_docstrings
```

````

````{py:attribute} lz
:canonical: zoomy_foam.vof.Tank.lz
:type: float
:value: >
   0.02

```{autodoc2-docstring} zoomy_foam.vof.Tank.lz
:parser: zoomy_docstrings
```

````

````{py:attribute} h0
:canonical: zoomy_foam.vof.Tank.h0
:type: float
:value: >
   0.04

```{autodoc2-docstring} zoomy_foam.vof.Tank.h0
:parser: zoomy_docstrings
```

````

````{py:attribute} fo
:canonical: zoomy_foam.vof.Tank.fo
:type: dict
:value: >
   'field(...)'

```{autodoc2-docstring} zoomy_foam.vof.Tank.fo
:parser: zoomy_docstrings
```

````

`````

````{py:function} write_config(path, *, arms, t_end, window, exchange)
:canonical: zoomy_foam.vof.write_config

```{autodoc2-docstring} zoomy_foam.vof.write_config
:parser: zoomy_docstrings
```
````

````{py:function} write_case(dest, tank, *, arms, config, t_end, window, write_interval=0.05)
:canonical: zoomy_foam.vof.write_case

```{autodoc2-docstring} zoomy_foam.vof.write_case
:parser: zoomy_docstrings
```
````

````{py:function} coupling_library(sm, *, cache=None)
:canonical: zoomy_foam.vof.coupling_library

```{autodoc2-docstring} zoomy_foam.vof.coupling_library
:parser: zoomy_docstrings
```
````

````{py:function} start(case, lib, *, log=None)
:canonical: zoomy_foam.vof.start

```{autodoc2-docstring} zoomy_foam.vof.start
:parser: zoomy_docstrings
```
````

````{py:function} to_hdf5(case, out)
:canonical: zoomy_foam.vof.to_hdf5

```{autodoc2-docstring} zoomy_foam.vof.to_hdf5
:parser: zoomy_docstrings
```
````