Replacing PPT-generated illustrations with Graphviz (#1186)

terrapower · Feb 15, 2023 · 387d1ee · 387d1ee
1 parent e7de217
commit 387d1ee
Show file tree

Hide file tree

Showing 5 changed files with 91 additions and 6 deletions.
diff --git a/doc/user/images/looseCouplingIllustration.png b/doc/user/images/looseCouplingIllustration.png
diff --git a/doc/user/images/tightCouplingIllustration.png b/doc/user/images/tightCouplingIllustration.png
diff --git a/doc/user/inputs/looseCouplingIllustration.dot b/doc/user/inputs/looseCouplingIllustration.dot
@@ -0,0 +1,40 @@
+digraph looseCoupling {
+        label="Loose Coupling"
+        layout="dot";
+        rankdir=TB;
+        a [label="Temp.", shape="Rec", style="rounded,filled", color="white"]
+        a1 [label="Temp.", shape="Rec", style="rounded,filled", color="white"]
+        a2 [label="Temp.", shape="Rec", style="rounded,filled", color="white"]
+        b [label="Power", shape="Rec", style="rounded,filled", color="white"]
+        b1 [label="Power", shape="Rec", style="rounded,filled", color="white"]
+        b2 [label="Power", shape="Rec", style="rounded,filled", color="white"]
+        c [label="Cross Sections", shape="Rec", style="rounded,filled", color="white"]
+        c1 [label="Cross Sections", shape="Rec", style="rounded,filled", color="white"]
+        c2 [label="Cross Sections", shape="Rec", style="rounded,filled", color="white"]
+        d [label="...", shape="plaintext"]
+
+        subgraph cluster_c00n00{
+            label="Cycle 0, Node 0";
+            style="rounded,filled";
+            color=lightblue;
+            c -> b
+            b -> a [constraint=false]
+        }
+        a -> c1 //[constraint=false]
+        subgraph cluster_c00n01{
+            label="Cycle 0, Node 1"
+            style="rounded,filled";
+            color=lightblue;
+            c1 -> b1
+            b1 -> a1 [constraint=false]
+        }
+        a1 -> c2 //[constraint=false]
+        subgraph cluster_c00n02{
+            label="Cycle 0, Node 2"
+            style="rounded,filled";
+            color=lightblue;
+            c2 -> b2
+            b2 -> a2 [constraint=false]
+        }
+        a2 -> d //[constraint=false]
+}
diff --git a/doc/user/inputs/tightCouplingIllustration.dot b/doc/user/inputs/tightCouplingIllustration.dot
@@ -0,0 +1,49 @@
+digraph tightCoupling {
+        label="Tight Coupling"
+        layout="dot";
+        rankdir=TB;
+        e [label="Converged?", shape="diamond", style="filled", color="white"]
+        e1 [label="Converged?", shape="diamond", style="filled", color="white"]
+        e2 [label="Converged?", shape="diamond", style="filled", color="white"]
+        a [label="Temp.", shape="Rectangle", style="rounded,filled", color="white"]
+        a1 [label="Temp.", shape="Rectangle", style="rounded,filled", color="white"]
+        a2 [label="Temp.", shape="Rectangle", style="rounded,filled", color="white"]
+        b [label="Power", shape="Rectangle", style="rounded,filled", color="white"]
+        b1 [label="Power", shape="Rectangle", style="rounded,filled", color="white"]
+        b2 [label="Power", shape="Rectangle", style="rounded,filled", color="white"]
+        c [label="Cross Sections", shape="Rectangle", style="rounded,filled", color="white"]
+        c1 [label="Cross Sections", shape="Rectangle", style="rounded,filled", color="white"]
+        c2 [label="Cross Sections", shape="Rectangle", style="rounded,filled", color="white"]
+        d [label="...", shape="plaintext"]
+
+        subgraph cluster_c00n00{
+            label="Cycle 0, Node 0";
+            style="rounded,filled";
+            color=lightblue;
+            c -> b 
+            b -> a 
+            a -> e [constraint=false]
+            e -> c [constraint=false, label="no"]
+        }
+        e -> c1 [label="yes"]
+        subgraph cluster_c00n01{
+            label="Cycle 0, Node 1"
+            style="rounded,filled";
+            color=lightblue;
+            c1 -> b1
+            b1 -> a1
+            a1 -> e1 [constraint=false]
+            e1 -> c1 [constraint=false, label="no"]
+        }
+        e1 -> c2 [label="yes"]
+        subgraph cluster_c00n02{
+            label="Cycle 0, Node 2"
+            style="rounded,filled";
+            color=lightblue;
+            c2 -> b2
+            b2 -> a2
+            a2 -> e2 [constraint=false]
+            e2 -> c2 [constraint=false, label="no"]
+        }
+        e2 -> d [label="yes"]
+}
diff --git a/doc/user/physics_coupling.rst b/doc/user/physics_coupling.rst
@@ -6,19 +6,15 @@ Loose Coupling
 ----------------
 ARMI supports loose and tight coupling. Loose coupling is interpreted as one-way coupling between physics for a single time node. For example, a power distribution in cycle 0 node 0 is used to calculate a temperature distribution in cycle 0 node 0. This temperature is then used in cycle 0 node 1 to compute new cross sections and a new power distribution. This process repeats itself for the lifetime of the simulation. 
 
-.. image:: images/looseCouplingIllustration.png
-    :width: 800
-    :alt: Loose coupling illustration.
+.. graphviz:: inputs/looseCouplingIllustration.dot
 
 Loose coupling is enabled by default in ARMI simulations.
 
 Tight Coupling
 -----------------
 Tight coupling is interpreted as two-way communication between physics within a given time node. Revisiting our previous example, enabling tight coupling results in the temperature distribution being used to generate updated cross sections (new temperatures induce changes such as Doppler broadening feedback) and ultimately an updated power distribution. This process is repeated iteratively until a numerical convergence criteria is met.
 
-.. image:: images/tightCouplingIllustration.png
-    :width: 800
-    :alt: Tight coupling illustration.
+.. graphviz:: inputs/tightCouplingIllustration.dot
 
 The following settings are involved with enabling tight coupling in ARMI: