Skip to content

Commit 6fcad7d

Browse files
author
Jacob Schroder
committed
Added how to cite instructions for XBraid to the manuals
1 parent 4023764 commit 6fcad7d

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

docs/Introduction.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@
2626
We chose the package name XBraid to stand for _Time-Braid_, where
2727
X is the first letter in the Greek work for time, _Chronos_. The
2828
algorithm _braids_ together time-grids of different granularity in order to
29-
create a multigrid method and achieve parallelism in the time dimension. In
30-
plain text, we say XBraid, or just Braid for short.
29+
create a multigrid method and achieve parallelism in the time dimension.
3130

3231
# Overview of the XBraid Algorithm {#braidoverview}
3332

@@ -616,6 +615,21 @@ Achieving the best speedup can require some tuning, and it is recommended to rea
616615
[Parallel Time Integration with Multigrid](https://computation-rnd.llnl.gov/linear_solvers/pubs/mgritPaper-2013.pdf)
617616
where this 2D heat equation example is explored in much more detail.
618617

618+
619+
# Citing XBraid {#braidcite}
620+
621+
To cite XBraid, please state in your text the version number from the
622+
VERSION file, and please cite the project website in your bibliography as
623+
624+
> [1] XBraid: Parallel multigrid in time. http://llnl.gov/casc/xbraid.
625+
626+
The corresponding BibTex entry is
627+
628+
@misc{xbraid-package,
629+
title = {{XB}raid: Parallel multigrid in time},
630+
howpublished = {\url{http://llnl.gov/casc/xbraid}}
631+
}
632+
619633
# Summary {#summary}
620634

621635
- XBraid applies multigrid to the time dimension.

0 commit comments

Comments
 (0)