Skip to content

Commit

Permalink
add description of the optional input arguments into the Advanced par…
Browse files Browse the repository at this point in the history
…ts of the docs
  • Loading branch information
andrewwinters5000 committed Apr 26, 2024
1 parent f35c0ad commit c87a3ce
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/src/interactive_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,17 @@ To generate a mesh interactively you

## Advanced

All objects and information contained in the variable type `Project` are actually dictionaries of type `Dict{String, Any}`.
The `generate_mesh` function has two optional arguments. The first is the logical `verbose`
argument. One can pass `verbose=true` to output additional messages and information during
the meshing process. The second is the integer `subdivision_maximum` argument.
The default value is `subdivision_maximum=8`, meaning that elements can be up
to a factor of `2^8` smaller than the existing background grid.
Note, think before adjusting the `subdivision_maximum` level! It is often the case that
adjusting the boundary curves, background grid size, adding local refinement regions,
or some combination of these adjustments removes the need to adjust the subdivision depth.

All objects and information contained in the variable type `Project` are actually dictionaries
of type `Dict{String, Any}`.
Since Julia is not an object oriented language, the parameters and other parts of these internal dictionaries
can be accessed and edited directly by key and value.
However, if you do that, then certain features like `undo`/`redo` and automatic plot updating **will not work**.

0 comments on commit c87a3ce

Please sign in to comment.