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

Enhance immersed boundary grid docs #3505

Merged
merged 5 commits into from
Mar 14, 2024
Merged
Changes from 1 commit
Commits
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
14 changes: 13 additions & 1 deletion src/ImmersedBoundaries/grid_fitted_bottom.jl
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,19 @@ const GFBIBG = ImmersedBoundaryGrid{<:Any, <:Any, <:Any, <:Any, <:Any, <:GridFit
"""
GridFittedBottom(bottom_height, [immersed_condition=CenterImmersedCondition()])

Return an immersed boundary with an irregular bottom fit to the underlying grid.
Return a bottom immersed boundary.

Keyword Arguments
=================

* `bottom_height`: an array or function that gives the height of the
bottom in absolute ``z`` coordinates.

* `immersed_condition`: determine whether the part of the domain that is
immersed are all the cell centers that lie below
`bottom_height` (`CenterImmersedCondition()`; default)
or all the cell faces that lie below `bottom_height`
(`InterfaceImmersedCondition()`).
navidcy marked this conversation as resolved.
Show resolved Hide resolved
"""
GridFittedBottom(bottom_height) = GridFittedBottom(bottom_height, CenterImmersedCondition())

Expand Down