foamlib 0.9.7__tar.gz → 1.1.0__tar.gz

{foamlib-0.9.7 → foamlib-1.1.0}/.github/workflows/ci.yml

@@ -35,6 +35,8 @@ jobs:
         python-version-file: pyproject.toml
     - name: Check types with mypy
       run: |
+        uv add pip
+        uv run mypy --install-types --non-interactive
         uv run mypy
 
   test:
@@ -49,11 +51,11 @@ jobs:
         options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
     strategy:
       matrix:
-        openfoam-version: [2412, 2006, 12, 9]
+        openfoam-version: [2506, 2006, 12, 9]
         python-version: ['3.7', '3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
         slurm: [false]
         include:
-          - openfoam-version: 2412
+          - openfoam-version: 2506
             python-version: '3.13'
             slurm: true
           - openfoam-version: 12

{foamlib-0.9.7 → foamlib-1.1.0}/.github/workflows/docker.yml

@@ -80,7 +80,7 @@ jobs:
       packages: write
     strategy:
       matrix:
-        openfoam-version: [2412, 2406, 12, 11]
+        openfoam-version: [2506, 2412, 12, 11]
       fail-fast: false
     steps:
       - name: Set up QEMU

{foamlib-0.9.7 → foamlib-1.1.0}/.gitignore

@@ -145,3 +145,7 @@ uv.lock
 
 # VS Code
 .vscode
+
+
+# create folders in example 
+example/parametricStudy/Cases

foamlib-1.1.0/CITATION.cff

@@ -0,0 +1,36 @@
+cff-version: "1.2.0"
+authors:
+- family-names: Gerlero
+  given-names: Gabriel S.
+  orcid: "https://orcid.org/0000-0002-5138-0328"
+- family-names: Kler
+  given-names: Pablo A.
+  orcid: "https://orcid.org/0000-0003-4217-698X"
+contact:
+- family-names: Gerlero
+  given-names: Gabriel S.
+  orcid: "https://orcid.org/0000-0002-5138-0328"
+doi: 10.5281/zenodo.15442960
+message: If you use this software, please cite our article in the
+  Journal of Open Source Software.
+preferred-citation:
+  authors:
+  - family-names: Gerlero
+    given-names: Gabriel S.
+    orcid: "https://orcid.org/0000-0002-5138-0328"
+  - family-names: Kler
+    given-names: Pablo A.
+    orcid: "https://orcid.org/0000-0003-4217-698X"
+  date-published: 2025-05-23
+  doi: 10.21105/joss.07633
+  issn: 2475-9066
+  issue: 109
+  journal: Journal of Open Source Software
+  publisher:
+    name: Open Journals
+  start: 7633
+  title: "foamlib: A modern Python package for working with OpenFOAM"
+  type: article
+  url: "https://joss.theoj.org/papers/10.21105/joss.07633"
+  volume: 10
+title: "foamlib: A modern Python package for working with OpenFOAM"

{foamlib-0.9.7 → foamlib-1.1.0}/Dockerfile

@@ -1,7 +1,7 @@
 
 ARG BASE=python:3.12-slim
 
-ARG OPENFOAM_VERSION=2412
+ARG OPENFOAM_VERSION=2506
 FROM microfluidica/openfoam:${OPENFOAM_VERSION} AS openfoam
 
 ARG VIRTUAL_ENV=/opt/venv

{foamlib-0.9.7 → foamlib-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: foamlib
-Version: 0.9.7
+Version: 1.1.0
 Summary: A Python interface for interacting with OpenFOAM
 Project-URL: Homepage, https://github.com/gerlero/foamlib
 Project-URL: Repository, https://github.com/gerlero/foamlib
@@ -34,6 +34,7 @@ Provides-Extra: docs
 Requires-Dist: ruff; extra == 'docs'
 Requires-Dist: sphinx-rtd-theme; extra == 'docs'
 Requires-Dist: sphinx<9,>=5; extra == 'docs'
+Requires-Dist: sphinxcontrib-mermaid; extra == 'docs'
 Description-Content-Type: text/markdown
 
 [<img alt="foamlib" src="https://github.com/gerlero/foamlib/raw/main/logo.png" height="65">](https://github.com/gerlero/foamlib)
@@ -51,6 +52,8 @@ Description-Content-Type: text/markdown
 ![OpenFOAM](https://img.shields.io/badge/openfoam-.com%20|%20.org-informational)
 [![Docker](https://github.com/gerlero/foamlib/actions/workflows/docker.yml/badge.svg)](https://github.com/gerlero/foamlib/actions/workflows/docker.yml)
 [![Docker image](https://img.shields.io/badge/docker%20image-microfluidica%2Ffoamlib-0085a0)](https://hub.docker.com/r/microfluidica/foamlib/)
+[![DOI](https://joss.theoj.org/papers/10.21105/joss.07633/status.svg)](https://doi.org/10.21105/joss.07633)
+
 
 **foamlib** provides a simple, modern, ergonomic and fast Python interface for interacting with [OpenFOAM](https://www.openfoam.com).
 
@@ -92,6 +95,12 @@ Compared to [PyFoam](https://openfoamwiki.net/index.php/Contrib/PyFoam) and othe
     conda install -c conda-forge foamlib
     ```
 
+* With [Homebrew](https://brew.sh):
+
+    ```bash
+    brew install gerlero/openfoam/foamlib
+    ```
+
 ### 🐑 Clone a case
 
 ```python
@@ -210,6 +219,39 @@ If you believe you have found a bug in **foamlib**, please open an [issue](https
 
 You're welcome to contribute to **foamlib**! Check out the [contributing guidelines](CONTRIBUTING.md) for more information.
 
-## Footnotes
+## 🖋️Citation
+
+If you find **foamlib** useful for your work, don't forget to cite it!
+
+Citations help us a lot. You may find the following snippets useful:
+
+<details>
+<summary>BibTeX</summary>
+
+```bibtex
+@article{foamlib,
+    author = {Gerlero, Gabriel S. and Kler, Pablo A.},
+    doi = {10.21105/joss.07633},
+    journal = {Journal of Open Source Software},
+    month = may,
+    number = {109},
+    pages = {7633},
+    title = {{foamlib: A modern Python package for working with OpenFOAM}},
+    url = {https://joss.theoj.org/papers/10.21105/joss.07633},
+    volume = {10},
+    year = {2025}
+}
+```
+
+</details>
+
+<details>
+<summary>APA</summary>
+
+Gerlero, G. S., & Kler, P. A. (2025). foamlib: A modern Python package for working with OpenFOAM. Journal of Open Source Software, 10(109), 7633. https://doi.org/10.21105/joss.07633
+
+</details>
+
+## 👟 Footnotes
 
 <a id="benchmark">[1]</a> foamlib 0.8.1 vs PyFoam 2023.7 on a MacBook Air (2020, M1) with 8 GB of RAM. [Benchmark script](benchmark/benchmark.py).

{foamlib-0.9.7 → foamlib-1.1.0}/README.md

@@ -13,6 +13,8 @@
 ![OpenFOAM](https://img.shields.io/badge/openfoam-.com%20|%20.org-informational)
 [![Docker](https://github.com/gerlero/foamlib/actions/workflows/docker.yml/badge.svg)](https://github.com/gerlero/foamlib/actions/workflows/docker.yml)
 [![Docker image](https://img.shields.io/badge/docker%20image-microfluidica%2Ffoamlib-0085a0)](https://hub.docker.com/r/microfluidica/foamlib/)
+[![DOI](https://joss.theoj.org/papers/10.21105/joss.07633/status.svg)](https://doi.org/10.21105/joss.07633)
+
 
 **foamlib** provides a simple, modern, ergonomic and fast Python interface for interacting with [OpenFOAM](https://www.openfoam.com).
 
@@ -54,6 +56,12 @@ Compared to [PyFoam](https://openfoamwiki.net/index.php/Contrib/PyFoam) and othe
     conda install -c conda-forge foamlib
     ```
 
+* With [Homebrew](https://brew.sh):
+
+    ```bash
+    brew install gerlero/openfoam/foamlib
+    ```
+
 ### 🐑 Clone a case
 
 ```python
@@ -172,6 +180,39 @@ If you believe you have found a bug in **foamlib**, please open an [issue](https
 
 You're welcome to contribute to **foamlib**! Check out the [contributing guidelines](CONTRIBUTING.md) for more information.
 
-## Footnotes
+## 🖋️Citation
+
+If you find **foamlib** useful for your work, don't forget to cite it!
+
+Citations help us a lot. You may find the following snippets useful:
+
+<details>
+<summary>BibTeX</summary>
+
+```bibtex
+@article{foamlib,
+    author = {Gerlero, Gabriel S. and Kler, Pablo A.},
+    doi = {10.21105/joss.07633},
+    journal = {Journal of Open Source Software},
+    month = may,
+    number = {109},
+    pages = {7633},
+    title = {{foamlib: A modern Python package for working with OpenFOAM}},
+    url = {https://joss.theoj.org/papers/10.21105/joss.07633},
+    volume = {10},
+    year = {2025}
+}
+```
+
+</details>
+
+<details>
+<summary>APA</summary>
+
+Gerlero, G. S., & Kler, P. A. (2025). foamlib: A modern Python package for working with OpenFOAM. Journal of Open Source Software, 10(109), 7633. https://doi.org/10.21105/joss.07633
+
+</details>
+
+## 👟 Footnotes
 
 <a id="benchmark">[1]</a> foamlib 0.8.1 vs PyFoam 2023.7 on a MacBook Air (2020, M1) with 8 GB of RAM. [Benchmark script](benchmark/benchmark.py).

{foamlib-0.9.7 → foamlib-1.1.0}/docs/conf.py

@@ -13,7 +13,7 @@ author = "Gabriel S. Gerlero"
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["sphinx.ext.autodoc"]
+extensions = ["sphinx.ext.autodoc", "sphinxcontrib.mermaid"]
 
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

{foamlib-0.9.7 → foamlib-1.1.0}/docs/index.rst

@@ -13,6 +13,8 @@ Documentation
    :maxdepth: 2
 
    example
+   parametricstudy
+   postprocessing
    cases
    files
 

foamlib-1.1.0/docs/parametricstudy.rst

@@ -0,0 +1,195 @@
+Parametric Study
+================
+
+This functionality allows users to set up and run a parametric study in OpenFOAM, where multiple simulations are executed with varying parameters to analyze their effects on the results. The study can be configured to modify specific fields or solver settings across different runs.
+
+Overview
+--------
+
+The general workflow for a parametric study in OpenFOAM using foamlib is as follows:
+
+.. mermaid::
+
+   graph LR
+     A[Template Case] --> B[Generate Case Variants]
+     C[Modify Parameters] --> B
+     B --> D[Run Simulation]
+     D --> E[Post-process and Analyze]
+
+A template case is created with the necessary configuration files. The user can then generate multiple case variants by modifying specific parameters, such as initial conditions, boundary conditions, or solver settings. Each variant is run independently, and the results are collected for post-processing and analysis.
+
+
+
+The general concept of the parametric study is that template cases are copied to a new folder, and the parameters are modified in the copied case. This requires the definition of the following parameters:
+
+- template_case: The path to the template case that will be copied and modified.
+- output_folder: The folder where the modified cases will be stored.
+- case_name: The name of the case that will be created.
+- instructions: A list of the file and the key entry that needs to be modified in the template case.
+- value: the value for each instruction
+- case category: A category for the case, which can be used to group cases together for easier post-processing.
+
+
+Multiple parammetric study generators are avaible and describe below in detail.
+
+CSV Generator
+-------------
+
+The csv generator create the parametric study based on a CSV file that contains the parameters to be varied. This generator reads the CSV file, extracts the parameters, and generates multiple case variants by modifying the specified fields in the template case.
+
+.. code-block:: python
+
+    from foamlib.preprocessing.parameter_study import csv_generator
+
+    # Example usage
+    csv_generator(
+        csv_file="path/to/your/parameters.csv",
+        template_case="path/to/template/case",
+        output_folder="path/to/output/folder"
+    ).create_study()
+
+This simple generator specifies the above requirements in the csv file, where the instruction (file and key name (here: NX,NY and someModel)) is defined in the `system/simulationParameters` file. The case_name  and the category will be defined as additional columns in the CSV file.
+
+
+.. code-block:: c++
+
+    /*--------------------------------*- C++ -*----------------------------------*\
+    | =========                 |                                                 |
+    | \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
+    |  \\    /   O peration     | Version:  plus                                  |
+    |   \\  /    A nd           | Web:      www.OpenFOAM.com                      |
+    |    \\/     M anipulation  |                                                 |
+    \*---------------------------------------------------------------------------*/
+    FoamFile
+    {
+        version     2.0;
+        format      ascii;
+        class       dictionary;
+        location    "system";
+        object      simulationParameters;
+    }
+    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+    NX 23;
+    NY 8;
+
+    someModel SomeModelName;
+
+
+    // ************************************************************************* //
+
+The file can be included in every openfoam dictionary by adding the following line and can be referenced with a dollar sign in the dictionary:
+
+.. code-block:: c++
+
+    #include "system/simulationParameters"
+
+    blocks
+    (
+        hex (0 1 2 3 4 5 6 7) ($NX $NY 1) simpleGrading (1 1 1)
+    );
+
+    
+The csv file needs to be contain a case_name column and the parameters to be varied. Additionally, columns can be specified to categorize the cases: `Resolution`, and `Model`. The generator will create a case for each row in the CSV file. This is necessary to simplify the post-processing. The csv file should look like this:
+
+
+==========  ====  ====  ==========  ============  ===================
+case_name   NX    NY    someModel   Resolution    Model
+==========  ====  ====  ==========  ============  ===================
+case_001    100   200   modelA      coarse        k-epsilon
+case_002    150   300   modelB      fine          Spalart-Allmaras
+==========  ====  ====  ==========  ============  ===================
+
+
+Grid Parameter sweep
+--------------------
+
+The grid parameter sweep generator allows users to define a set of parameters and creates all combinations of these parameters to generate multiple cases. 
+In the example below, the grid resolution and initial height are varied across multiple cases. 
+
+The most important class for the grid generator is the `GridParameter`. This class encapsulates both the `FoamDictInstruction` and the `CaseParameter`. The `FoamDictInstruction` class is used to specify which files and keys in the OpenFOAM case should be modified.
+
+
+.. code-block:: python
+
+    from foamlib.preprocessing.grid_parameter_sweep import CaseParameter, GridParameter
+    from foamlib.preprocessing.of_dict import FoamDictInstruction
+
+    # helper function
+    def grid_parameters(scale) -> list[int]:
+        return [
+            int(23 * scale),
+            int(8 * scale),
+            int(19 * scale),
+            int(42 * scale),
+            int(4 * scale),
+        ]
+
+
+    grid = GridParameter(
+        parameter_name="grid",
+        # generate 5 instructions in system/simulationParameters with the key1..5
+        modify_dict=[
+            FoamDictInstruction(
+                file_name=Path("system/simulationParameters"),
+                keys=[f"res{i}"],
+            )
+            for i in range(1, 6)
+        ],
+        parameters=[
+            CaseParameter(
+                name="coarse", values=grid_parameters(1) # return [23, 8, 19, 42, 4]
+            ),
+            CaseParameter(
+                name="mid", values=grid_parameters(2) # return [46, 16, 38, 84, 8]
+            ),
+            CaseParameter(
+                name="fine", values=grid_parameters(4) # return [92, 32, 76, 168, 16]
+            )]
+    )
+
+The modify_dict varaible stores the instructions for the OpenFOAM dictionary that will be modified. The `keys` parameter specifies the keys in the dictionary that will be modified. The `parameters` variable stores the parameters that will be used to modify the keys in the dictionary. Each `CaseParameter` contains a name and a list of values that will be used to modify the keys in the dictionary.
+
+.. code-block:: python
+
+    from foamlib.preprocessing.grid_parameter_sweep import grid_generator
+
+    init_height = GridParameter(
+        parameter_name="initHeight",
+        modify_dict=[
+            FoamDictInstruction(
+                file_name=Path("system/simulationParameters"),
+                keys=["initHeight"],
+            )
+        ],
+        parameters=[
+            CaseParameter(
+                name="height_02", values=[0.2]
+            ),
+            CaseParameter(
+                name="height_03", values=[0.3]
+            ),
+            CaseParameter(
+                name="height_04", values=[0.4]
+            )
+        ],
+    )
+
+    study = grid_generator(
+        parameters=[grid, init_height],
+        template_case=template_case,
+        output_folder=root / "Cases",
+    )
+
+    study.create_study(study_base_folder=root)
+
+This code creates a parametric study that varies the grid resolution and initial height across multiple cases. The `grid_generator` function takes a list of `GridParameter` objects, which define the parameters to be varied, and generates all combinations of these parameters to create multiple cases. So, 3 times 3 cases will be generated, resulting in 9 cases in total. Each case will have a unique name based on the parameters used.
+
+Convenience Functions for FoamDictInstruction
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This section provides a reference to all functions available in the `foamlib.preprocessing.system` module.
+
+.. automodule:: foamlib.preprocessing.system
+    :members:
+

foamlib-1.1.0/docs/postprocessing.rst

@@ -0,0 +1,96 @@
+Post Processing
+===============
+
+Analyzing large parametric studies can be cumbersome, especially when dealing with numerous cases and parameters. To facilitate this process, FoamLib provides a post-processing module that allows users to analyze and visualize the results of their parametric studies efficiently.
+
+The general concept is that the post processing case are all located in the same folder and with the following structure:
+
+- cases
+   * case1
+      + postProcessing
+         - function object 1
+         - function object 2
+   * case2
+      + postProcessing
+         - function object 1
+         - function object 2
+
+The post-processing module can be used to extract data from the post-processing files and visualize it in a user-friendly manner. 
+
+The main idea is to gather all the post-processing files from different cases into a single dataframe that stores the data in a long format. This allows for easy manipulation and visualization of the data using libraries like seaborn, ploty.express or altair or numerous other plotting libraries.
+
+time series data
+----------------
+
+
+.. code-block:: python
+
+    from foamlib.postprocessing.load_tables import OutputFile, list_outputfiles, load_tables
+
+    forces = load_tables(
+        source=OutputFile(file_name="force.dat", folder="forces"), dir_name="Cases"
+    )
+    forces.to_csv(
+        results / "forces.csv",
+        index=False,
+    )
+
+The following example would load all the force.dat files from the post-processing folder of each case in the Cases directory and save the results in a CSV file. The resulting dataframe will have columns for the case name, time, and force components (fx, fy, fz, ..) and the case category specified in the case.json file that gets automatically generated when creating a case with FoamLib pre-processing module.
+
+The OutputFile class is used to specify the file name and folder where the post-processing files are located, where the general syntax in OpenFOAM is as followed:
+
+.. code-block:: 
+
+    postProcessing / folder1 / folder2 / timeName / file_name
+
+Only the folder and file_name are required, the timeName is optional and can be used to specify a specific time folder. If not specified, the post-processing module will look for the file in all time folders.
+
+list outputfiles
+----------------
+
+The `list_outputfiles` function can be used to list all the output files in a given directory, and the `load_tables` function can be used to load the data from the output files into a dataframe. The resulting dataframe will have columns for the case name, time, and force components (fx, fy, fz, ..) and the case category specified in the case.json file that gets automatically generated when creating a case with FoamLib pre-processing module.
+
+
+.. code-block:: python
+
+    out_files = list_outputfiles(root / "Cases")
+
+    forces = load_tables(
+        source=out_files["forces--force.dat"], dir_name=root / "Cases"
+    )
+
+spatial data (surfaces, sets, ...)
+----------------------------------
+
+
+The post-processing module also supports loading spatial data from OpenFOAM cases, such as surface data or sets. OpenFOAM stores for each time name a new file with the same name that contains the spatial data. These data can be loaded into a dataframe using the `load_tables` function, which will automatically handle the parsing of the data and return it in a long format.
+
+However, the resulting dataframe may contain a lot of data, so these dataframe can be filtererd with a custum function that return a filtered dataframe. 
+
+.. code-block:: python
+
+    from foamlib.postprocessing.load_tables import OutputFile, load_tables
+
+    def max_height_filter(table: pd.DataFrame, parameters: dict[str, str]) -> pd.DataFrame:
+        """Filter the table to get the maximum height."""
+        d = {
+            "x": [table["x"].max()],
+            "y": [table["y"].max()],
+            "z": [table["z"].max()],
+        }
+        d.update(parameters)
+        return pd.DataFrame(d)
+
+
+    file = OutputFile(file_name="U_freeSurface.raw", folder="freeSurface")
+    surface_heights = load_tables(
+        source=file, dir_name=root / "Cases", filter_table=max_height_filter
+    )
+    surface_heights.to_csv(
+        results / "surface_heights.csv",
+        index=False,
+    )
+
+generally,the `load_tables` functions should be stored in a seperate file and the resulting tables should be written to disc as e.g csv feater or formats. The post-processing module can then be used to load the data from the files and visualize it in a user-friendly manner.
+
+This allows the implementation of dashboards to quickly explore the data. Additionally, the table gathering process can be easily outgenerate from the CLI.

foamlib-1.1.0/example/parametricStudy/createStudyFromCSV.py

@@ -0,0 +1,15 @@
+# %%
+
+from pathlib import Path
+
+from foamlib.preprocessing.parameter_study import csv_generator
+
+# damBreak
+root = Path(__file__).parent
+template_case = root / "damBreak"
+
+study = csv_generator(
+    csv_file=root / "parastudy.csv", template_case=template_case, output_folder=root / "Cases"
+)
+
+study.create_study(study_base_folder=root)

foamlib-1.1.0/example/parametricStudy/createStudyGrid.py

@@ -0,0 +1,55 @@
+from pathlib import Path
+
+from foamlib.preprocessing.grid_parameter_sweep import CaseParameter, GridParameter
+from foamlib.preprocessing.of_dict import FoamDictInstruction
+from foamlib.preprocessing.parameter_study import grid_generator
+from foamlib.preprocessing.system import simulationParameters
+
+# damBreak
+root = Path(__file__).parent
+template_case = root / "damBreak"
+
+
+def grid_parameters(scale) -> list[int]:
+    return [
+        int(23 * scale),
+        int(8 * scale),
+        int(19 * scale),
+        int(42 * scale),
+        int(4 * scale),
+    ]
+
+
+grid = GridParameter(
+    parameter_name="grid",
+    # generate 5 instructions in system/simulationParameters with the key1..5
+    # This is simulationParameters is identical to the following:
+    # FoamDictInstruction(
+    #     file_name=Path("system/simulationParameters"),
+    #     keys=[f"res{i}"],
+    # )
+    modify_dict=[simulationParameters(keys=[f"res{i}"]) for i in range(1, 6)],
+    parameters=[
+        CaseParameter(name="coarse", values=grid_parameters(1)),
+        CaseParameter(name="mid", values=grid_parameters(2)),
+        CaseParameter(name="fine", values=grid_parameters(4)),
+    ],
+)
+
+init_height = GridParameter(
+    parameter_name="initHeight",
+    modify_dict=[simulationParameters(keys=["initHeight"])],
+    parameters=[
+        CaseParameter(name="height_02", values=[0.2]),
+        CaseParameter(name="height_03", values=[0.3]),
+        CaseParameter(name="height_04", values=[0.4]),
+    ],
+)
+
+study = grid_generator(
+    parameters=[grid, init_height],
+    template_case=template_case,
+    output_folder=root / "Cases",
+)
+
+study.create_study(study_base_folder=root)

foamlib-1.1.0/example/parametricStudy/damBreak/0/T

@@ -0,0 +1,49 @@
+/*--------------------------------*- C++ -*----------------------------------*\
+| =========                 |                                                 |
+| \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
+|  \\    /   O peration     | Version:  plus                                  |
+|   \\  /    A nd           | Web:      www.OpenFOAM.com                      |
+|    \\/     M anipulation  |                                                 |
+\*---------------------------------------------------------------------------*/
+FoamFile
+{
+    version     2.0;
+    format      ascii;
+    class       volScalarField;
+    object      T;
+}
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+dimensions      [0 0 0 1 0 0 0];
+
+internalField   uniform 300;
+
+boundaryField
+{
+    leftWall
+    {
+        type            zeroGradient;
+    }
+
+    rightWall
+    {
+        type            zeroGradient;
+    }
+
+    lowerWall
+    {
+        type            zeroGradient;
+    }
+
+    atmosphere
+    {
+        type            zeroGradient;
+    }
+
+    defaultFaces
+    {
+        type            empty;
+    }
+}
+
+// ************************************************************************* //