Skip to content

Commit b604ed5

Browse files
author
Jacob Schroder
committed
Updated the documentation to reflect improved wording for introducing MGRIT from the Strand2D XBraid paper
1 parent 6fcad7d commit b604ed5

File tree

8 files changed

+195
-158
lines changed

8 files changed

+195
-158
lines changed

docs/Abstract.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,23 @@
2020
- Temple Place, Suite 330, Boston, MA 02111-1307 USA
2121
-->
2222

23-
This package implements an optimal-scaling multigrid solver for the linear
23+
This package implements an optimal-scaling multigrid solver for the (non)linear
2424
systems that arise from the discretization of problems with evolutionary
2525
behavior. Typically, solution algorithms for evolution equations are based on a
2626
time-marching approach, solving sequentially for one time step after the other.
2727
Parallelism in these traditional time-integration techniques is limited to
2828
spatial parallelism. However, current trends in computer architectures are
29-
leading towards systems with more, but not faster, processors. Therefore,
30-
faster compute speeds must come from greater parallelism. One approach to
31-
achieve parallelism in time is with multigrid, but extending classical
32-
multigrid methods for elliptic operators to this setting is a significant
33-
achievement. In this software, we implement a non-intrusive, optimal-scaling
34-
time-parallel method based on multigrid reduction techniques. The examples in
35-
the package demonstrate optimality of our multigrid-reduction-in-time algorithm
36-
(MGRIT) for solving a variety of equations in two and three spatial
37-
dimensions. These examples can also be used to show that MGRIT can achieve
38-
significant speedup in comparison to sequential time marching on modern
39-
architectures.
29+
leading towards systems with more, but not faster, processors, i.e., clock
30+
speeds are stagnate. Therefore, faster overall runtimes must come from greater
31+
parallelism. One approach to achieve parallelism in time is with multigrid, but
32+
extending classical multigrid methods for elliptic operators to this setting is
33+
a significant achievement. In this software, we implement a non-intrusive,
34+
optimal-scaling time-parallel method based on multigrid reduction techniques.
35+
The examples in the package demonstrate optimality of our
36+
multigrid-reduction-in-time algorithm (MGRIT) for solving a variety of
37+
equations in two and three spatial dimensions. These examples can also be used
38+
to show that MGRIT can achieve significant speedup in comparison to sequential
39+
time marching on modern architectures.
4040

4141
It is **strongly recommended** that you also read [Parallel Time Integration
4242
with Multigrid](https://computation-rnd.llnl.gov/linear_solvers/pubs/mgritPaper-2013.pdf)

docs/Example.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -164,11 +164,11 @@ first argument to every function.
164164

165165
6. **SpatialNorm**: This function tells XBraid how to take the norm
166166
of a braid_Vector and is used for halting. This norm is only over
167-
space. A common norm choice is the standard Eucliden norm, but
167+
space. A common norm choice is the standard Euclidean norm, but
168168
many other choices are possible, such as an L2-norm based on a
169169
finite element space. The norm choice should be based on what
170170
makes sense for you problem. How to accumulate spatial norm values
171-
to obtain a global space-time residual norm for halting decsions is
171+
to obtain a global space-time residual norm for halting decisions is
172172
controlled by [braid_SetTemporalNorm](@ref braid_SetTemporalNorm).
173173

174174
int
@@ -188,14 +188,14 @@ first argument to every function.
188188
at time *t*. This is most commonly used to print solution(s) to screen, file, etc...
189189
The user defines what is appropriate output. Notice how you are told the time value *t* of the
190190
vector *u* and even more information in *astatus*. This lets you tailor the output to only
191-
certain time values at certain XBraid iterations. Querrying *astatus* for such information
191+
certain time values at certain XBraid iterations. Querying *astatus* for such information
192192
is done through _braid_AccessStatusGet**(..)_ routines.
193193
\latexonly \\ \endlatexonly
194194

195195
The frequency of the calls to *access* is controlled through
196196
[braid_SetAccessLevel](@ref braid_SetAccessLevel). For instance, if access_level is
197197
set to 2, then *access* is called every XBraid iteration and on every XBraid level. In
198-
this case, querrying *astatus* to determine the current XBraid level and iteration will
198+
this case, querying *astatus* to determine the current XBraid level and iteration will
199199
be useful. This scenario allows for even more detailed tracking of the simulation.
200200
\latexonly \\ \endlatexonly
201201

docs/Introduction.md

Lines changed: 177 additions & 140 deletions
Large diffs are not rendered by default.

docs/developer_manual_header.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@
176176
~\\~\\~\\~\\~\\~\\~\\
177177
\begin{center}
178178
{ \fontsize{40}{50}\selectfont XBraid }\\
179-
{ \large Time-Braid: Multigrid in Time Solvers}
179+
{ \large Parallel Multigrid in Time}
180180
\end{center}
181181
~\\
182182
\begin{figure}[!ht]

docs/img/CrelaxationDetail.pdf

7.65 KB
Binary file not shown.

docs/img/FrelaxationDetail.pdf

7.77 KB
Binary file not shown.

docs/img/FrelaxationDetail2.pdf

138 KB
Binary file not shown.

docs/user_manual_header.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@
176176
~\\~\\~\\~\\~\\~\\~\\
177177
\begin{center}
178178
{ \fontsize{40}{50}\selectfont XBraid }\\
179-
{ \large Time-Braid: Multigrid in Time Solvers}
179+
{ \large Parallel Multigrid in Time}
180180
\end{center}
181181
~\\
182182
\begin{figure}[!ht]

0 commit comments

Comments
 (0)