Merge pull request #68 from Pressio/develop

#63: follow-up fixes

Author: cwschilly

docs/source/tutorial/hyperreduction.rst

@@ -91,7 +91,11 @@ is defined:
     auto trialBasis /* aka Phi */ = trialSpace.basisOfTranslatedSpace();
     auto hypredMatrix = /* (Phi^T rhsBasis) * pinv(sampledBasis) */;
 
-    // Construct hyperreducer functor
+    /*
+     * Construct hyperreducer functor with operator() that:
+     *   - Samples full RHS at sampleIndices
+     *   - Applies hypredMatrix to get reduced RHS
+     */
     ExplicitGalerkinHyperReducer hyperReducer(hypredMatrix, sampleIndices);
 
 This code is implemented fully in the ``hyperreduction.h`` file
@@ -102,7 +106,8 @@ user-defined functor that implements an ``operator()`` method
 that takes in a sampled FOM RHS vector and outputs the reduced RHS vector.
 
 Like with the other Pressio interfaces, you can define your
-hyperreducer in any way you like, as long as it meets the API requirements.
+hyperreducer in any way you like, as long as it meets the API requirements
+(namely, defining the ``operator()``).
 
 Now that we have defined the hyper-reducer, we can
 build the ROM almost identically to before, but passing

docs/source/tutorial/understand.rst

@@ -1,3 +1,5 @@
+.. _top-of-page:
+
 How do I use Pressio to build and run a ROM?
 ============================================
 
@@ -8,12 +10,13 @@ Pressio.
 We recommend reading this step-by-step explanation alongside
 the source code itself, which is fully commented to provide
 additional context. The source code for this tutorial
-can be found in ``$SRC/full-tutorial/burgers.cpp``
+can be found in ``$SRC/full-tutorial/burgers.cpp``. It is
+also included :ref:`at the bottom of this page <full-source-file>` for reference.
 
-Each step found below corresponds to the same-named
-section of the source code. After Step 0, we recommend
-you jump to the ``main`` function and follow along with
-the steps as they are explained.
+Each step found below (and in the Table of Contents to the right)
+corresponds to the same-named section of the source code.
+After Step 0, we recommend you jump to the ``main`` function
+and follow along with the steps as they are explained.
 
 .. note::
 
@@ -415,3 +418,17 @@ The plot will be saved to your current directory as
    You'll find that the hyper-reduced ROM does not perform quite as well
    as the standard ROM. But the tradeoff is that the hyper-reduced ROM
    is computationally cheaper to run, especially for large-scale systems.
+
+:ref:`Go to top <top-of-page>`
+
+.. _full-source-file:
+
+Full Source File
+----------------
+
+.. literalinclude:: ../../../full-tutorial/burgers.cpp
+   :language: cpp
+   :lines: 113-
+   :linenos:
+
+:ref:`Go to top <top-of-page>`

full-tutorial/burgers.cpp

@@ -110,8 +110,6 @@
  * with minimal error (< 1%) on test cases within training range.
  */
 
-////////////////////////////////////////////////////////////////////////////////
-
 ///////////////////////////////////////////////////////////////////////////////
 // Step 0: Pressio Setup
 //////////////////////////////////////////////////////////////////////////////////