From 13ff5521f7ae4cd91b61e6ece220ecc39db3d34c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dennis=20Gl=C3=A4ser?= <dennis.glaeser@iws.uni-stuttgart.de>
Date: Thu, 19 Oct 2023 09:32:55 +0200
Subject: [PATCH] [examples][cahn-hilliard] minor language issues
---
examples/cahn_hilliard/doc/_intro.md | 2 +-
examples/cahn_hilliard/main.cc | 4 ++--
examples/cahn_hilliard/model.hh | 7 ++++---
3 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/examples/cahn_hilliard/doc/_intro.md b/examples/cahn_hilliard/doc/_intro.md
index 42f94f6c00..ad6b4bcce7 100644
--- a/examples/cahn_hilliard/doc/_intro.md
+++ b/examples/cahn_hilliard/doc/_intro.md
@@ -43,7 +43,7 @@ with the concentration $c(x,t)$, the mobility coefficient $M$, and surface tensi
The domain $\Omega \subset \mathbb{R}^2$ is initialized with a concentration field
$c(x,t=0) = 0.42 + \zeta$, randomly perturbed by
noise $\zeta$ following a uniform distribution $\zeta \sim U(-0.02, 0.02)$.
-With time the concentration field evolves towards attaining mostly values near to $0$ or $1$ while
+Over time, the concentration field evolves towards attaining mostly values near to $0$ or $1$ while
conserving the total concentration. The model describes the separation of two immiscible fluids.
The fourth order PDE cannot be solved by a standard finite volume scheme. We therefore
diff --git a/examples/cahn_hilliard/main.cc b/examples/cahn_hilliard/main.cc
index 4cf109f366..3357cd4d65 100644
--- a/examples/cahn_hilliard/main.cc
+++ b/examples/cahn_hilliard/main.cc
@@ -98,8 +98,8 @@ public:
return values;
}
- // For the boundary we choose boundary flux (or Neumann) conditions for all equations and on
- // every part of the boundary, specifying zero flux everywhere for both equations.
+ // We choose boundary flux (or Neumann) conditions for all equations on the entire boundary,
+ // while specifying zero flux for both equations.
// [[codeblock]]
BoundaryTypes boundaryTypesAtPos(const GlobalPosition& globalPos) const
{
diff --git a/examples/cahn_hilliard/model.hh b/examples/cahn_hilliard/model.hh
index 2b765ce3c0..e8e62cf606 100644
--- a/examples/cahn_hilliard/model.hh
+++ b/examples/cahn_hilliard/model.hh
@@ -233,7 +233,7 @@ public:
}
// [[/codeblock]]
- // **Source term:** The function `computeSource` computes the sources terms for a sub control volume.
+ // **Source term:** The function `computeSource` computes the source terms for a sub control volume.
// We implement a model-specific source term for the chemical potential equation before
// deferring further implementation to the problem where we add the derivative of the free
// energy.
@@ -278,7 +278,7 @@ struct Scalar<TypeTag, TTag::CahnHilliardModel>
// The model traits specify some information about our equation system.
// Here we have two equations. The indices allow to access primary variables
-// and equations with a named indices.
+// and equations with named indices.
template<class TypeTag>
struct ModelTraits<TypeTag, TTag::CahnHilliardModel>
{
@@ -298,7 +298,8 @@ struct ModelTraits<TypeTag, TTag::CahnHilliardModel>
};
// The primary variable vector has entries of type `Scalar` and is
-// as large as the number of equations (here 2) but we keep it general.
+// as large as the number of equations (here 2) but we keep it general
+// here by obtaining the number of equations from the `ModelTraits`.
template<class TypeTag>
struct PrimaryVariables<TypeTag, TTag::CahnHilliardModel>
{
--
GitLab