Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hughcars committed Oct 26, 2023
1 parent 9f2980f commit 37f28a0
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 7 deletions.
10 changes: 4 additions & 6 deletions docs/src/config/model.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,16 +75,15 @@ scheme.

`"AdaptMaxIts" [0]` : Maximum number of iterations to perform of adaptive mesh refinement.

`"UpdateFraction" [0.4]` : Dörfler marking fraction used to specify which elements to
`"UpdateFraction" [0.7]` : Dörfler marking fraction used to specify which elements to
refine. This marking strategy will mark the smallest number of elements that make up
`"UpdateFraction"` of the total error in the mesh. A larger value will refine more elements
per iteration, at the cost of the final mesh being less efficient.

`"DOFLimit" [0]` : The maximum allowable number of DOF within an AMR loop, if an adapted
mesh exceeds this value no further adaptation will occur.

`"Nonconformal" [false]` : Whether the adaptation should use nonconformal refinement.
`"Nonconformal"` is necessary to enable `"UseCoarsening"`.
`"Nonconformal" [true]` : Whether the adaptation should use nonconformal refinement.

`"Boxes"` : Array of box region refinement objects. All elements with a node inside the box
region will be marked for refinement.
Expand Down Expand Up @@ -116,10 +115,9 @@ mesh length units.
### Advanced model options

- `"MaximumImbalance" [1.0]`
- `"MaxNCLevels" [0]`
- `"MaxNCLevels" [1]`
- `"Partition" [""]`
- `"RemoveCurvature" [false]`
- `"ReorientTetMesh" [false]`
- `"SaveStep" [1]`
- `"UseCoarsening" [false]`
- `"SaveAdaptIterations" [true]`
- `"WriteSerialMesh" [true]`
1 change: 0 additions & 1 deletion scripts/schema/config/model.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
"Nonconformal": {"type": "boolean"},
"SaveAdaptIterations": {"type": "boolean"},
"UpdateFraction": {"type": "number", "exclusiveMinimum": 0.0, "exclusiveMaximum": 1.0},
"UseCoarsening": {"type": "boolean"},
"WriteSerialMesh": {"type": "boolean"},
"Boxes":
{
Expand Down

0 comments on commit 37f28a0

Please sign in to comment.