Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New tutorial #57

Merged
merged 27 commits into from
Jun 25, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
2e58cd1
add new tutorial with syemmtry lines
andrewwinters5000 Jun 14, 2024
02eefde
add proper figure links
andrewwinters5000 Jun 14, 2024
43d7dce
fix weird spacing
andrewwinters5000 Jun 14, 2024
3069efe
add missing keyword to docstring
andrewwinters5000 Jun 18, 2024
16345de
add new helper function to rename inner or outer boundary curves
andrewwinters5000 Jun 19, 2024
a8b03c1
rewrite and simplify the symmetric mesh tutorial
andrewwinters5000 Jun 19, 2024
6378fe5
adjust boundary names in tutorital to make it easier to follow
andrewwinters5000 Jun 19, 2024
afe1b96
update text in final script at the end of the tutorial
andrewwinters5000 Jun 19, 2024
23b3ed3
add test for new renaming helper function
andrewwinters5000 Jun 19, 2024
121d7a2
fix typo
andrewwinters5000 Jun 19, 2024
a70681c
Update symmetric_mesh.md
DavidAKopriva Jun 20, 2024
f62440e
remove colon to render tip box in docs
andrewwinters5000 Jun 20, 2024
37b27fd
add line breaks for readibility of the markdown source
andrewwinters5000 Jun 20, 2024
8582410
update remove_mesh command to remove control, plot and stats files
andrewwinters5000 Jun 20, 2024
15bdb77
add new helper function renameCruve to the API docs
andrewwinters5000 Jun 20, 2024
ae33ce4
adjust wording to be less awkward
andrewwinters5000 Jun 20, 2024
5b80b72
update tutorial with new boundary names and other review comments
andrewwinters5000 Jun 21, 2024
821997f
Edits on renameCurve
DavidAKopriva Jun 21, 2024
c22d2ea
Update symmetric_mesh.md
DavidAKopriva Jun 21, 2024
0e3fd65
add sleep commands to idle tests for a brief time to avoid file acces…
andrewwinters5000 Jun 24, 2024
aa3c03b
Merge branch 'symmetric_tutorial' of github.com:trixi-framework/HOHQM…
andrewwinters5000 Jun 24, 2024
2d8594f
remove sleep commands, did not fix anything
andrewwinters5000 Jun 24, 2024
27158f3
see if only the control file removal causes Windows issue
andrewwinters5000 Jun 24, 2024
56d74d7
add an additional close statement to see if Windows works
andrewwinters5000 Jun 24, 2024
8b553b3
move close statement to the proper place
andrewwinters5000 Jun 24, 2024
f37eff9
remove unnecessary close statments. Try to force file removal
andrewwinters5000 Jun 24, 2024
526a29c
try again with the sleep command
andrewwinters5000 Jun 24, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ makedocs(
joinpath("tutorials", "curved_outer_boundary.md"),
joinpath("tutorials", "spline_curves.md"),
joinpath("tutorials", "create_edit_curves.md"),
joinpath("tutorials", "symmetric_mesh.md"),
],
"Advanced topics & developers" => [
"Development" => "development.md",
Expand Down
17 changes: 16 additions & 1 deletion docs/src/tutorials/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,19 @@ Demonstrates how to:
* Construct and add parametric spline curves.
* Construct and add a curve from parametric equations.
* Construct and add straight line segments.
* Construct and add circular arc segments.
* Construct and add circular arc segments.

## [Symmetric mesh](@ref)

This tutorial constructs a mesh given a closed chain of outer boundary curves
that is then reflected over a straight line indicated by the user.
The result is a mesh that is symmetric with respect to the prescribed
straight line.

### Synopsis

Demonstrates how to:
* Indicate a symmetry boundary line.
* Construct an outer boundary with several connected curves.
* Add the background grid when an outer boundary curve is present.
* Visualize an interactive mesh project.
Loading
Loading