xref: /libCEED/examples/petsc/README.md (revision 6c5df90db8677641a04ff505ccfa313a57dff4e5)
1288c0443SJeremy L Thompson## libCEED + PETSc Examples
2819eb1b3Sjeremylt
3288c0443SJeremy L Thompson### CEED bakeoff problems - bps
4819eb1b3Sjeremylt
5819eb1b3SjeremyltThis code solves the CEED bakeoff problems on a structured grid generated and
68c91a0c9SJeremy L Thompsonreferenced using only low-level communication primitives.
7819eb1b3Sjeremylt
8819eb1b3SjeremyltTo build, run `make bps`.
9819eb1b3Sjeremylt
10819eb1b3SjeremyltTo run, `./bps -ceed [ceed-resource] -problem bp[1-6] -degree [degree]`.
11819eb1b3Sjeremylt
12819eb1b3SjeremyltIn addition to the common arguments, the following arguments may be set:
13819eb1b3Sjeremylt
14819eb1b3Sjeremylt- `-local`             - Target number of locally owned DoFs per process
15819eb1b3Sjeremylt
16288c0443SJeremy L Thompson### CEED bakeoff problems with DMPlex - bpsdmplex
17819eb1b3Sjeremylt
18819eb1b3SjeremyltThis code solves the CEED bakeoff problems on a unstructured grid using DMPlex.
19819eb1b3SjeremyltThis example requires a PETSc version later than 3.11.3.
20819eb1b3Sjeremylt
21819eb1b3SjeremyltTo build, run `make bpsdmplex`.
22819eb1b3Sjeremylt
23*6c5df90dSjeremyltTo run, `./bpsdmplex -ceed [ceed-resource] -problem bp[1-6] -degree [degree]`.
24819eb1b3Sjeremylt
25819eb1b3SjeremyltIn addition to the common arguments, the following arguments may be set:
26819eb1b3Sjeremylt
27819eb1b3Sjeremylt- `-mesh`              - Read mesh from file
28819eb1b3Sjeremylt- `-cells`             - Number of cells per dimension
29*6c5df90dSjeremylt
30*6c5df90dSjeremylt### CEED bakeoff problems with DMPlex and PCMG - multigrid
31*6c5df90dSjeremylt
32*6c5df90dSjeremyltThis code solves the CEED bakeoff problems on a unstructured grid using DMPlex
33*6c5df90dSjeremyltwith p-multigrid implemented in PCMG. This example requires a PETSc version later than 3.11.3.
34*6c5df90dSjeremylt
35*6c5df90dSjeremyltTo build, run `make multigrid`.
36*6c5df90dSjeremylt
37*6c5df90dSjeremyltTo run, `./multigrid -ceed [ceed-resource] -problem bp[1-6] -degree [degree]`.
38*6c5df90dSjeremylt
39*6c5df90dSjeremyltIn addition to the common arguments, the following arguments may be set:
40*6c5df90dSjeremylt
41*6c5df90dSjeremylt- `-mesh`              - Read mesh from file
42*6c5df90dSjeremylt- `-cells`             - Number of cells per dimension
43819eb1b3Sjeremylt
44288c0443SJeremy L Thompson### Command line arguments
45819eb1b3Sjeremylt
46819eb1b3SjeremyltThe following arguments can be specified for both examples:
47819eb1b3Sjeremylt
48819eb1b3Sjeremylt- `-ceed`              - CEED resource specifier
49819eb1b3Sjeremylt- `-problem`           - CEED benchmark problem to solve
50*6c5df90dSjeremylt- `-degree`            - Polynomial degree of tensor product basis
51819eb1b3Sjeremylt- `-qextra`            - Number of extra quadrature points
52819eb1b3Sjeremylt- `-test`              - Testing mode (do not print unless error is large)
53819eb1b3Sjeremylt- `-benchmark`         - Benchmarking mode (prints benchmark statistics)
54