Skip to content

Commit 0466567

Browse files
mention that model are one-dimensional (#244)
1 parent 3c0b457 commit 0466567

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
<img height="200px" alt="logo" src="https://github.com/user-attachments/assets/d2bccfbd-19c9-4448-a5d9-6ac927c32cc5">
1414
</p>
1515

16-
**DispersiveShallowWater.jl** is a [Julia](https://julialang.org/) package that implements structure-preserving numerical methods for dispersive shallow water models.
17-
To date, it provides provably conservative, entropy-conserving and well-balanced numerical schemes for some dispersive shallow water models:
16+
**DispersiveShallowWater.jl** is a [Julia](https://julialang.org/) package that implements structure-preserving numerical methods for one-dimensional dispersive shallow water models.
17+
To date, it provides provably conservative, entropy-conserving, and well-balanced numerical schemes for the following dispersive shallow water models:
1818

1919
* the [Korteweg–De Vries (KdV) equation as the prototypical example of an integrable PDE](https://doi.org/10.1007/s10915-025-02898-x),
2020
* the [Benjamin-Bona-Mahony (BBM) equation, also known as regularized long-wave equation](https://doi.org/10.4208/cicp.OA-2020-0119),
@@ -97,7 +97,7 @@ with contributions from Hendrik Ranocha (Johannes Gutenberg University Mainz)
9797
and Collin Wittenstein (Johannes Gutenberg University Mainz).
9898
Some parts of this repository are based on parts of
9999
[Dispersive-wave-schemes-notebooks. A Broad Class of Conservative Numerical Methods for Dispersive Wave Equations](https://github.com/ranocha/Dispersive-wave-schemes-notebooks)
100-
by Hendrik Ranocha, Dimitrios Mitsotakis and David Ketcheson.
100+
by Hendrik Ranocha, Dimitrios Mitsotakis, and David Ketcheson.
101101
The code structure is inspired by [Trixi.jl](https://github.com/trixi-framework/Trixi.jl/).
102102

103103
## License and contributing

docs/src/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
</p>
1616
```
1717

18-
[**DispersiveShallowWater.jl**](https://github.com/NumericalMathematics/DispersiveShallowWater.jl) is a [Julia](https://julialang.org/) package that implements structure-preserving numerical methods for dispersive shallow water models.
19-
To date, it provides provably conservative, entropy-conserving and well-balanced numerical schemes for some dispersive shallow water models:
18+
[**DispersiveShallowWater.jl**](https://github.com/NumericalMathematics/DispersiveShallowWater.jl) is a [Julia](https://julialang.org/) package that implements structure-preserving numerical methods for one-dimensional dispersive shallow water models.
19+
To date, it provides provably conservative, entropy-conserving, and well-balanced numerical schemes for the following dispersive shallow water models:
2020

2121
* the [Korteweg–De Vries (KdV) equation as the prototypical example of an integrable PDE](https://doi.org/10.1007/s10915-025-02898-x),
2222
* the [Benjamin-Bona-Mahony (BBM) equation, also known as regularized long-wave equation](https://doi.org/10.4208/cicp.OA-2020-0119),
@@ -98,7 +98,7 @@ with contributions from Hendrik Ranocha (Johannes Gutenberg University Mainz)
9898
and Collin Wittenstein (Johannes Gutenberg University Mainz).
9999
Some parts of this repository are based on parts of
100100
[Dispersive-wave-schemes-notebooks. A Broad Class of Conservative Numerical Methods for Dispersive Wave Equations](https://github.com/ranocha/Dispersive-wave-schemes-notebooks)
101-
by Hendrik Ranocha, Dimitrios Mitsotakis and David Ketcheson.
101+
by Hendrik Ranocha, Dimitrios Mitsotakis, and David Ketcheson.
102102
The code structure is inspired by [Trixi.jl](https://github.com/trixi-framework/Trixi.jl/).
103103

104104
## License and contributing

0 commit comments

Comments
 (0)