Port two-scale-heat-conduction case from DuMuX-Adapter

.gitattributes

@@ -0,0 +1 @@
+*.tar.gz filter=lfs diff=lfs merge=lfs -text

.github/workflows/run_testsuite.yml

@@ -0,0 +1,88 @@
+name: Run Testsuite (manual) # Unfortunately, we cannot modify the name: https://github.community/t/github-actions-dynamic-name-of-the-workflow-with-workflow-dispatch/150327
+on:
+  workflow_dispatch:
+    inputs:
+      testsuites:
+        description: 'Virtual Environment'
+        default: 'openfoam-adapter-release'
+        required: true
+        type: choice
+        options:
+          - openfoam-adapter-release
+          - openfoam-adapter-pr
+          - fenics-test
+      build_args:
+        description: 'Build arguments'
+        default: 'OPENFOAM_EXECUTABLE:openfoam2212,PRECICE_TAG:latest,OPENFOAM_ADAPTER_REF:master'
+        required: true
+        type: choice
+        options:
+          - 'OPENFOAM_EXECUTABLE:openfoam2212,PRECICE_TAG:latest,OPENFOAM_ADAPTER_REF:master'
+          - 'OPENFOAM_EXECUTABLE:openfoam2112,PRECICE_TAG:latest,OPENFOAM_ADAPTER_REF:master'
+          - 'OPENFOAM_EXECUTABLE:openfoam2212,PRECICE_TAG:develop,OPENFOAM_ADAPTER_REF:develop'
+      tutorial_branch:
+        description: 'Branch to take the tutorials from'
+        default: 'master'
+        required: true
+        type: choice
+        options:
+          - 'develop'
+          - 'master'
+      systests_branch:
+        description: 'Branch to take the systest from'
+        default: 'add-systemtests'
+        required: true
+        type: choice
+        options:
+            - 'develop'
+            - 'master'
+            - 'add-systemtests'
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Report log
+      run: |
+        echo "Initiated by: ${{ github.actor }}"
+        echo "Running systemtests --build_args=${{github.event.inputs.build_args}} --suites=${{github.event.inputs.testsuites}}"
+        echo "Tutorials branch: ${{ github.event.inputs.tutorial_branch }}"
+        echo "Systemtests branch: ${{ github.event.inputs.systests_branch }}"
+    - name: Check out Tutorials
+      uses: actions/checkout@v2
+      with:
+        ref: ${{ github.event.inputs.tutorial_branch }}
+        path: 'tutorials'
+    - name: Check out Tutorials for systest
+      uses: actions/checkout@v2
+      with:
+        ref: ${{ github.event.inputs.systests_branch }}
+        path: 'systest'
+    - name: Log directory
+      run: |
+        ls -al
+        pwd
+    - name: Copy folders and files from systest into tutorials
+      run: |
+        cp -R systest/tools/* tutorials/tools
+        cd systest
+        find . -type f -name "metadata.yaml" -exec cp --parents {} ../tutorials \; 
+        cd ..
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v2
+    - name: install python depencies
+      run: |
+        python -m pip install -r tutorials/tools/tests/requirements.txt
+    - name: Run tests
+      run: |
+        cd tutorials/tools/tests
+        python systemtests.py --build_args=${{github.event.inputs.build_args}} --suites=${{github.event.inputs.testsuites}}
+        cd ../../
+    - name: Archive run files
+      uses: actions/upload-artifact@v2
+      with:
+        name: runs
+        path: |
+          tutorials/runs/*

.markdownlint.json

@@ -1,4 +1,5 @@
 {
     "MD013": false,
-    "MD033": false
+    "MD033": false,
+    "MD034": false
 }

aste-turbine/README.md

@@ -13,7 +13,7 @@ If you are completely new to ASTE have a look at our [ASTE documentation](https:
 
 Our example consists of a wind turbine blade geometry, which was triangulated using different refinement levels. The mesh files are stored in [this GitLab repository](https://gitlab.lrz.de/precice/precice2-ref-paper-setup) and correspond to the mesh files used for the mapping tests of our [version 2 reference paper](https://doi.org/10.12688/openreseurope.14445.1). The mesh files are automatically downloaded when the `run.sh` script is executed. In this example setup, we map the mesh `0.01.vtk` (left side of the figure) to the mesh `0.006.vtk` (right side of the figure).
 
-![Turbine setup](images/tutorials-aste-setup.png)
+![Turbine setup](images/tutorials-aste-turbine-setup.png)
 
 ## Running the tutorial
 

aste-turbine/precice-config.xml

@@ -8,44 +8,44 @@
       format="---[precice] %ColorizedSeverity% %Message%"
       enabled="true" />
   </log>
-
-  <solver-interface dimensions="3">
 
-    <data:scalar name="Data" />
+  <data:scalar name="Data" />
 
-    <mesh name="A-Mesh">
-      <use-data name="Data" />
-    </mesh>
+  <mesh name="A-Mesh" dimensions="3">
+    <use-data name="Data" />
+  </mesh>
 
-    <mesh name="B-Mesh">
-      <use-data name="Data" />
-    </mesh>
-    
-    <m2n:sockets from="A" to="B" exchange-directory="." />
+  <mesh name="B-Mesh" dimensions="3">
+    <use-data name="Data" />
+  </mesh>
+
+  <m2n:sockets acceptor="A" connector="B" exchange-directory="." />
 
-    <participant name="A">
-      <use-mesh name="A-Mesh" provide="yes" />
-      <write-data name="Data" mesh="A-Mesh" />
-    </participant>
-    
-    <participant name="B">
-      <use-mesh name="A-Mesh" provide="no" from="A" />
-      <use-mesh name="B-Mesh" provide="yes" />
-      <read-data name="Data" mesh="B-Mesh" />
+  <participant name="A">
+    <provide-mesh name="A-Mesh" />
+    <write-data name="Data" mesh="A-Mesh" />
+  </participant>
+
+  <participant name="B">
+    <receive-mesh name="A-Mesh" from="A" />
+    <provide-mesh name="B-Mesh" />
+    <read-data name="Data" mesh="B-Mesh" />
 
-      <mapping:nearest-neighbor constraint="consistent" direction="read" from="A-Mesh" to="B-Mesh" />
-      <!-- <mapping:nearest-projection constraint="consistent" direction="read" from="A-Mesh" to="B-Mesh" /> -->
-      <!-- <mapping:rbf-compact-polynomial-c6 support-radius="0.1" use-qr-decomposition="false" constraint="consistent" direction="read" from="A-Mesh" to="B-Mesh" /> -->
-      <!-- <mapping:rbf-compact-polynomial-c6 support-radius="0.1" use-qr-decomposition="true" constraint="consistent" direction="read" from="A-Mesh" to="B-Mesh" /> -->
-    </participant>
-
-    <coupling-scheme:parallel-explicit>
-      <participants first="A" second="B" />
-      <max-time value="1.0" />
-      <time-window-size value="1" />
-      <exchange data="Data" mesh="A-Mesh" from="A" to="B" />
-    </coupling-scheme:parallel-explicit>
-
-  </solver-interface>
+    <mapping:nearest-neighbor constraint="consistent" direction="read" from="A-Mesh" to="B-Mesh" />
+    <!-- <mapping:nearest-projection constraint="consistent" direction="read" from="A-Mesh" to="B-Mesh" /> -->
+    <!-- <mapping:rbf-pum-direct constraint="consistent" direction="read" from="A-Mesh" to="B-Mesh" />
+          <basis-function:compact-polynomial-c6 support-radius="0.1" />
+          </mapping:rbf-pum-direct> -->
+    <!-- <mapping:rbf-global-direct constraint="consistent" direction="read" from="A-Mesh" to="B-Mesh" />
+          <basis-function:compact-polynomial-c6 support-radius="0.1" />
+          </mapping:rbf-global-direct> -->
+  </participant>
+
+  <coupling-scheme:parallel-explicit>
+    <participants first="A" second="B" />
+    <max-time value="1.0" />
+    <time-window-size value="1" />
+    <exchange data="Data" mesh="A-Mesh" from="A" to="B" />
+  </coupling-scheme:parallel-explicit>
 
 </precice-configuration>

changelog-entries/318.md

@@ -0,0 +1 @@
+- Replaced all `<use-mesh>` tags in every `precice-config.xml` file to `<provide-mesh>` and `<receive-mesh>` respectively.

changelog-entries/321.md

@@ -0,0 +1 @@
+- Removed deprecated mapping timings from relevant preCICE configuration files

changelog-entries/331.md

@@ -0,0 +1 @@
+- Updated the RBF mapping configuration according to recent breaking changes.

channel-transport-reaction/precice-config.xml

@@ -7,42 +7,40 @@
       enabled="true" />
   </log>
 
-  <solver-interface dimensions="2">
-    <data:vector name="Velocity" />
-
-    <mesh name="Flow-Mesh">
-      <use-data name="Velocity" />
-    </mesh>
-
-    <mesh name="Chemical-Mesh">
-      <use-data name="Velocity" />
-    </mesh>
-
-    <participant name="Flow">
-      <use-mesh name="Flow-Mesh" provide="yes" />
-      <use-mesh name="Chemical-Mesh" from="Chemical" />
-      <write-data name="Velocity" mesh="Flow-Mesh" />
-    </participant>
-
-    <participant name="Chemical">
-      <use-mesh name="Chemical-Mesh" provide="yes" />
-      <use-mesh name="Flow-Mesh" from="Flow" />
-      <read-data name="Velocity" mesh="Chemical-Mesh" />
-      <mapping:linear-cell-interpolation
-        direction="read"
-        from="Flow-Mesh"
-        to="Chemical-Mesh"
-        constraint="consistent" />
-    </participant>
-
-    <m2n:sockets from="Flow" to="Chemical" exchange-directory=".." />
-
-    <coupling-scheme:serial-explicit>
-      <participants first="Flow" second="Chemical" />
-      <max-time value="5.0" />
-      <time-window-size value="0.05" />
-      <exchange data="Velocity" mesh="Flow-Mesh" from="Flow" to="Chemical" />
-
-    </coupling-scheme:serial-explicit>
-  </solver-interface>
+  <data:vector name="Velocity" />
+
+  <mesh name="Flow-Mesh" dimensions="2">
+    <use-data name="Velocity" />
+  </mesh>
+
+  <mesh name="Chemical-Mesh" dimensions="2">
+    <use-data name="Velocity" />
+  </mesh>
+
+  <participant name="Flow">
+    <provide-mesh name="Flow-Mesh" />
+    <receive-mesh name="Chemical-Mesh" from="Chemical" />
+    <write-data name="Velocity" mesh="Flow-Mesh" />
+  </participant>
+
+  <participant name="Chemical">
+    <provide-mesh name="Chemical-Mesh" />
+    <receive-mesh name="Flow-Mesh" from="Flow" />
+    <read-data name="Velocity" mesh="Chemical-Mesh" />
+    <mapping:linear-cell-interpolation
+      direction="read"
+      from="Flow-Mesh"
+      to="Chemical-Mesh"
+      constraint="consistent" />
+  </participant>
+
+  <m2n:sockets acceptor="Flow" connector="Chemical" exchange-directory=".." />
+
+  <coupling-scheme:serial-explicit>
+    <participants first="Flow" second="Chemical" />
+    <max-time value="5.0" />
+    <time-window-size value="0.05" />
+    <exchange data="Velocity" mesh="Flow-Mesh" from="Flow" to="Chemical" />
+
+  </coupling-scheme:serial-explicit>
 </precice-configuration>

channel-transport/README.md

@@ -28,6 +28,8 @@ Fluid participant:
 
 * Nutils. For more information, have a look at the [Nutils adapter documentation](https://www.precice.org/adapter-nutils.html). This Nutils solver requires at least Nutils v7.0.
 
+* OpenFOAM (pimpleFoam). For more information, have a look at the [OpenFOAM adapter documentation](https://precice.org/adapter-openfoam-overview.html).
+
 Transport participant:
 
 * Nutils. For more information, have a look at the [Nutils adapter documentation](https://www.precice.org/adapter-nutils.html). This Nutils solver requires at least Nutils v7.0.

channel-transport/fluid-nutils/fluid.py

@@ -13,7 +13,7 @@
 
 def main():
 
-    print("Running utils")
+    print("Running Nutils")
 
     # define the Nutils mesh
     nx = 48
@@ -55,18 +55,18 @@ def main():
     cons = solver.optimize(["u"], sqr, droptol=1e-15)
 
     # preCICE setup
-    interface = precice.Interface("Fluid", "../precice-config.xml", 0, 1)
+    participant = precice.Participant("Fluid", "../precice-config.xml", 0, 1)
 
     # define coupling mesh
     mesh_name = "Fluid-Mesh"
-    mesh_id = interface.get_mesh_id(mesh_name)
     vertices = gauss.eval(ns.x)
-    vertex_ids = interface.set_mesh_vertices(mesh_id, vertices)
+    vertex_ids = participant.set_mesh_vertices(mesh_name, vertices)
 
     # coupling data
-    velocity_id = interface.get_data_id("Velocity", mesh_id)
+    data_name = "Velocity"
 
-    precice_dt = interface.initialize()
+    participant.initialize()
+    precice_dt = participant.get_max_time_step_size()
 
     timestep = 0
     dt = 0.005
@@ -76,14 +76,16 @@ def main():
     # add convective term and time derivative for Navier-Stokes
     ures += gauss.integral("ubasis_ni (dudt_i + μ (u_i u_j)_,j) d:x" @ ns)
 
-    while interface.is_coupling_ongoing():
+    while participant.is_coupling_ongoing():
 
         if timestep % 1 == 0:  # visualize
             bezier = domain.sample("bezier", 2)
             x, u, p = bezier.eval(["x_i", "u_i", "p"] @ ns, **state)
             with log.add(log.DataLog()):
                 export.vtk("Fluid_" + str(timestep), bezier.tri, x, u=u, p=p)
 
+        precice_dt = participant.get_max_time_step_size()
+
         # potentially adjust non-matching timestep sizes
         dt = min(dt, precice_dt)
 
@@ -92,17 +94,16 @@ def main():
         state["dt"] = dt
         state = solver.newton(("u", "p"), (ures, pres), constrain=cons, arguments=state).solve(1e-10)
 
-        if interface.is_write_data_required(dt):
-            velocity_values = gauss.eval(ns.u, **state)
-            interface.write_block_vector_data(velocity_id, vertex_ids, velocity_values)
+        velocity_values = gauss.eval(ns.u, **state)
+        participant.write_data(mesh_name, data_name, vertex_ids, velocity_values)
 
         # do the coupling
-        precice_dt = interface.advance(dt)
+        participant.advance(dt)
 
         # advance variables
         timestep += 1
 
-    interface.finalize()
+    participant.finalize()
 
 
 if __name__ == "__main__":

channel-transport/fluid-openfoam/0/U

@@ -0,0 +1,39 @@
+FoamFile
+{
+    version     2.0;
+    format      ascii;
+    class       volVectorField;
+    object      U;
+}
+
+dimensions      [0 1 -1 0 0 0 0];
+internalField   uniform (10 0 0);
+
+boundaryField
+{
+    inlet
+    {
+        type            fixedValue;
+        value           $internalField;
+    }
+    outlet
+    {
+        type            zeroGradient;
+    }
+    obstacle
+    {
+        type            noSlip;
+    }
+    upperWall
+    {
+        type            noSlip;
+    }
+    lowerWall
+    {
+        type            noSlip;
+    }
+    frontAndBack
+    {
+        type            empty;
+    }
+}