ASTE Turbine Tutorial

aste-turbine/README.md

@@ -0,0 +1,29 @@
+---
+title: ASTE (Artificial Solver Testing Environment) Turbine Tutorial
+permalink: tutorials-aste-turbine.html
+keywords: ASTE, Testing, Turbine
+summary: This tutorial is an example case for ASTE, showcasing basic features and usage of ASTE.
+---
+
+{% include note.html content="Get the [case files of this tutorial](https://github.com/precice/tutorials/tree/master/aste-turbine). Read how in the [tutorials introduction](https://precice.org/tutorials.html)." %}
+
+## Setup
+
+This case is a simple usage scenario for ASTE. Some features demonstrated by this tutorial:
+
+* Mapping from a fine grid (`0.009.vtk`) to a coarse grid (`0.01.vtk`).
+* Usage of ASTE partitioner.
+* Usage of ASTE mesh joiner.
+* Usage of ASTE calculator for calculating a function on a given mesh.
+* Usage of ASTE.
+
+## Running ASTE
+
+Run the `run.sh` script. It performs the following steps:
+
+* Downloads the meshes from preCICE repository.
+* Using `vtk_calculator.py` script, calculates function `eggholder` on a finer grid.
+* Using `partition_mesh.py` script, partitions the coarse and fine mesh into 2 domains.
+* Using `preciceMap` executable, maps the data from the fine grid to the coarse grid.
+* Using `join_mesh.py`script, joins the result meshes into a final mesh.
+* Using ``vtk_calculator.py` script, calculates difference between mapped and original function on coarse grid.

aste-turbine/clean-tutorial.sh

@@ -0,0 +1 @@
+../tools/clean-tutorial-base.sh

aste-turbine/precice-config.xml

@@ -0,0 +1,53 @@
+<?xml version="1.0"?>
+
+<precice-configuration>
+
+  <log>
+    <sink
+      filter="%Severity% > debug and %Rank% = 0"
+      format="---[precice] %ColorizedSeverity% %Message%"
+      enabled="true" />
+  </log>
+
+  <solver-interface dimensions="3">
+
+    <data:scalar name="Data" />
+
+    <mesh name="A-Mesh">
+      <use-data name="Data" />
+    </mesh>
+
+    <mesh name="B-Mesh">
+      <use-data name="Data" />
+    </mesh>
+
+    <m2n:sockets from="A" to="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" />
+
+      <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-gaussian shape-parameter="4" constraint="consistent" direction="read" from="A-Mesh" to="B-Mesh" x-dead="false" y-dead="false" z-dead="false" /> -->
+      <!-- <mapping:rbf-gaussian shape-parameter="5600" solver-rtol="1e-9" constraint="consistent" direction="read" from="A-Mesh" to="B-Mesh" x-dead="true" y-dead="false" z-dead="false" polynomial="separate" preallocation="tree"/> -->
+      <!-- <mapping:rbf-volume-splines solver-rtol="1e-9" constraint="consistent" direction="read" from="A-Mesh" to="B-Mesh" x-dead="false" y-dead="false" z-dead="false" /> -->
+      <!-- <export:vtk every-n-time-windows="1" directory="vtkB/" normals="0"/> -->
+    </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>
+
+</precice-configuration>

aste-turbine/run.sh

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+set -e -x
+
+# This script assumes the ASTE binaries and python scripts are in $PATH or ASTE installed on your system
+
+# Download the meshes
+test -f meshes.tar.gz  || wget https://gitlab.lrz.de/precice/precice2-ref-paper-setup/-/raw/main/meshes/meshes.tar.gz
+
+# Extract the meshes
+test -f 0.009.vtk -a 0.01.vtk ||tar -xf meshes.tar.gz
+
+# Calculate on fine mesh
+vtk_calculator.py -m 0.009.vtk -f "eggholder3d" -d "EggHolder"
+
+# Decompose both meshes to two procesors
+# Choose resolution 0.009 mesh as fine mesh
+partition_mesh.py -m 0.009.vtk -n 2 -o fine_mesh --dir fine_mesh --algorithm topology
+# Choose resolution 0.01 mesh as coarse mesh
+partition_mesh.py -m 0.01.vtk -n 2 -o coarse_mesh --dir coarse_mesh --algorithm topology
+
+# The result directory of preciceMap needs to exist beforehand
+mkdir -p mapped
+
+# Map from the finer mesh to coarser mesh
+mpirun -n 2 preciceMap -v -p A --mesh fine_mesh/fine_mesh --data "EggHolder" &
+mpirun -n 2 preciceMap -v -p B --mesh coarse_mesh/coarse_mesh --output mapped/mapped --data "InterpolatedData"
+
+# Join the output files together to result.vtk,
+# Recovery cannot be used since GlobalID's are not exist in mapped mesh
+join_mesh.py -m mapped/mapped -o result.vtk --recovery coarse_mesh/coarse_mesh_recovery.json
+
+# Measure the difference between the original function and the mapped values
+# Save into data array called difference
+vtk_calculator.py -m result.vtk -f "eggholder3d" -d difference --diffdata "InterpolatedData" --diff --stats

tools/clean-tutorial-base.sh

@@ -5,3 +5,7 @@ set -e -u
 . ../tools/cleaning-tools.sh
 
 clean_tutorial .
+clean_aste 
+clean_precice_logs .
+rm -fv *.log
+

tools/cleaning-tools.sh

@@ -117,6 +117,15 @@ clean_su2() {
     )
 }
 
+clean_aste() {
+    (
+        set -e -u
+        echo "--- Cleaning up ASTE results"
+        rm -fv result.vtk result.stats.json
+        rm -fvr fine_mesh coarse_mesh mapped
+    )
+}
+
 clean_dune() {
     (
         set -e -u