]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fixed typos and wording in step-20
authorNicole Hayes <hayesni4@msu.edu>
Wed, 7 Aug 2019 00:34:24 +0000 (20:34 -0400)
committerNicole Hayes <hayesni4@msu.edu>
Thu, 8 Aug 2019 01:45:27 +0000 (21:45 -0400)
doc/news/changes/minor/20190807NicoleHayes [new file with mode: 0644]
examples/step-20/step-20.cc

diff --git a/doc/news/changes/minor/20190807NicoleHayes b/doc/news/changes/minor/20190807NicoleHayes
new file mode 100644 (file)
index 0000000..6d9ce3e
--- /dev/null
@@ -0,0 +1,3 @@
+Changed: Fixed some wording and minor typos in step-20 documentation.
+<br>
+(Nicole Hayes, 2019/08/07)
\ No newline at end of file
index e304fadb003c8c6e5703f7b63a4a624133c1c9e5..c898d57861fddc04f48e78464e7947258d012afc 100644 (file)
@@ -116,7 +116,7 @@ namespace Step20
 
   // Our next task is to define the right hand side of our problem (i.e., the
   // scalar right hand side for the pressure in the original Laplace
-  // equation), boundary values for the pressure, as well as a function that
+  // equation), boundary values for the pressure, and a function that
   // describes both the pressure and the velocity of the exact solution for
   // later computations of the error. Note that these functions have one, one,
   // and <code>dim+1</code> components, respectively, and that we pass the
@@ -166,7 +166,7 @@ namespace Step20
 
   // And then we also have to define these respective functions, of
   // course. Given our discussion in the introduction of how the solution
-  // should look like, the following computations should be straightforward:
+  // should look, the following computations should be straightforward:
   template <int dim>
   double RightHandSide<dim>::value(const Point<dim> & /*p*/,
                                    const unsigned int /*component*/) const
@@ -220,7 +220,7 @@ namespace Step20
   // real-life porous media flow simulations, and we would like to use the
   // opportunity to demonstrate the technique to use tensor valued functions.
   //
-  // Possibly unsurprising, deal.II also has a base class not only for scalar
+  // Possibly unsurprisingly, deal.II also has a base class not only for scalar
   // and generally vector-valued functions (the <code>Function</code> base
   // class) but also for functions that return tensors of fixed dimension and
   // rank, the <code>TensorFunction</code> template. Here, the function under
@@ -257,9 +257,9 @@ namespace Step20
                                  std::vector<Tensor<2, dim>> &  values) const
   {
     // The value we are going to store for a given point does not depend on its
-    // coordinates and we use the `points` object only for checking that the
+    // coordinates, and we use the `points` object only for checking that the
     // `values` object has the correct size. In release mode, `AssertDimension`
-    // is defined empty and the compiler will complain that the `points` object
+    // is defined empty, and the compiler will complain that the `points` object
     // is unused. The following line silences this warning.
     (void)points;
     AssertDimension(points.size(), values.size());
@@ -334,7 +334,7 @@ namespace Step20
     // velocities and pressures are not intermingled: First all velocity
     // degrees of freedom, then all pressure DoFs. This way, the global matrix
     // separates nicely into a $2 \times 2$ system. To achieve this, we have to
-    // renumber degrees of freedom base on their vector component, an
+    // renumber degrees of freedom based on their vector component, an
     // operation that conveniently is already implemented:
     DoFRenumbering::component_wise(dof_handler);
 

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.