Skip to content
Snippets Groups Projects
Commit 3a9ad1fe authored by Martin Schneider's avatar Martin Schneider Committed by Timo Koch
Browse files

[example][diffusion] Fix typos

parent 5164f6f2
No related branches found
No related tags found
1 merge request!3380[example] Add simple diffusion eqution including full model
......@@ -15,8 +15,8 @@ You learn how to
* setup a new simple model equation (diffusion equation)
* read parameters from a configuration file
* create a type tag and specialize properties for it
* generate a randomly distributed intial field (with MPI parallelism)
* solve a time-depedent diffusion problem in parallel
* generate a randomly distributed initial field (with MPI parallelism)
* solve a time-dependent diffusion problem in parallel
__Model equations:__ A diffusion equation model fully developed and contained within the example<br />
__Discretization method:__ Vertex-centered finite volumes / control-volume finite elements (Lagrange, P1) (`BoxModel`)
......
......@@ -19,7 +19,7 @@ __The main points illustrated in this example are__
## Equation and problem description
The scalar diffusion equation on a domain $\Omega \subset \mathbb{R}^2$
with boundary $\partial\Omega = \Gamma_D \cup \Gamma_N$ composed of Dirichlet and Neummann boundaries
with boundary $\partial\Omega = \Gamma_D \cup \Gamma_N$ composed of Dirichlet and Neumann boundaries
reads
```math
......@@ -93,18 +93,18 @@ The simulation result will look something like this.
By default Dumux will try to speed up the assembly by using shared memory parallelism if a suitable
backend has been found on your system (one of TBB, OpenMP, Kokkos, C++ parallel algorithms).
You can limit the number of threads by prepending your executable with `DUMUX_NUM_THREADS=<number>`.
If you also want to use distributed memory parallelsim with MPI (works better for solvers at the moment),
If you also want to use distributed memory parallelism with MPI (works better for solvers at the moment),
run the executable with your MPI environment. Each MPI process will use multi-threading if
`DUMUX_NUM_THREADS` is larger than $1$.
Running the example with four MPI processes (distribution memory parallelsim)
Running the example with four MPI processes (distribution memory parallelism)
each with two threads (shared memory parallelism):
```sh
DUMUX_NUM_THREADS=2 mpirun -np 4 ./example_diffusion
```
You can set the parameter `Grid.Overlap` to some non-zero integer in `param.input`
You can set the parameter `Grid.Overlap` to some non-zero integer in `params.input`
to turn the domain decomposition into an overlapping decomposition where
`Grid.Overlap` specifies the number of grid cells in the overlap between processes.
This can help to increase the convergence speed of the linear solver.
......
......@@ -17,7 +17,7 @@ __The main points illustrated in this example are__
## Equation and problem description
The scalar diffusion equation on a domain $\Omega \subset \mathbb{R}^2$
with boundary $\partial\Omega = \Gamma_D \cup \Gamma_N$ composed of Dirichlet and Neummann boundaries
with boundary $\partial\Omega = \Gamma_D \cup \Gamma_N$ composed of Dirichlet and Neumann boundaries
reads
```math
......@@ -91,18 +91,18 @@ The simulation result will look something like this.
By default Dumux will try to speed up the assembly by using shared memory parallelism if a suitable
backend has been found on your system (one of TBB, OpenMP, Kokkos, C++ parallel algorithms).
You can limit the number of threads by prepending your executable with `DUMUX_NUM_THREADS=<number>`.
If you also want to use distributed memory parallelsim with MPI (works better for solvers at the moment),
If you also want to use distributed memory parallelism with MPI (works better for solvers at the moment),
run the executable with your MPI environment. Each MPI process will use multi-threading if
`DUMUX_NUM_THREADS` is larger than $1$.
Running the example with four MPI processes (distribution memory parallelsim)
Running the example with four MPI processes (distribution memory parallelism)
each with two threads (shared memory parallelism):
```sh
DUMUX_NUM_THREADS=2 mpirun -np 4 ./example_diffusion
```
You can set the parameter `Grid.Overlap` to some non-zero integer in `param.input`
You can set the parameter `Grid.Overlap` to some non-zero integer in `params.input`
to turn the domain decomposition into an overlapping decomposition where
`Grid.Overlap` specifies the number of grid cells in the overlap between processes.
This can help to increase the convergence speed of the linear solver.
......
......@@ -56,7 +56,7 @@ Box method which is based on $P_1$ basis functions (piece-wise linears)
and the degrees of freedom are on the nodes. Each node is associate with
exactly one sub control volume (`scv`) per element and several ($2$ in $\mathbb{R}^2$)
sub control volume faces (`scvf`). In the local residual, we can implement the
constribution for one `scv` (storage and source terms) or one `scvf` (flux terms).
contribution for one `scv` (storage and source terms) or one `scvf` (flux terms).
Let's have a look at the class implementation.
......
......@@ -58,7 +58,7 @@ struct DiffusionModel {};
// and the degrees of freedom are on the nodes. Each node is associate with
// exactly one sub control volume (`scv`) per element and several ($2$ in $\mathbb{R}^2$)
// sub control volume faces (`scvf`). In the local residual, we can implement the
// constribution for one `scv` (storage and source terms) or one `scvf` (flux terms).
// contribution for one `scv` (storage and source terms) or one `scvf` (flux terms).
//
// Let's have a look at the class implementation.
//
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment