Skip to content

Doc for BoundaryFunction#82

Merged
utkinis merged 2 commits intoPTsolvers:mainfrom
Iddingsite:main
Apr 14, 2025
Merged

Doc for BoundaryFunction#82
utkinis merged 2 commits intoPTsolvers:mainfrom
Iddingsite:main

Conversation

@Iddingsite
Copy link
Contributor

Add doc for BoundaryFunction with a small usage example.

@luraess
Copy link
Member

luraess commented Apr 9, 2025

Thanks @Iddingsite for starting this doc addition. Maybe one could add a docstring for

# Create a continuous or discrete boundary function
# if discrete = true, the function has signature f(grid, loc, dim, inds...)
# if reduce_dims = false, the boundary condition function accepts the same number of coordinates as the number of indices
function BoundaryFunction(fun::Function; discrete=false, parameters=nothing, reduce_dims=true)
RF = reduce_dims ? ReducedDimensions : FullDimensions
discrete ? DiscreteBoundaryFunction{RF}(fun, parameters) : ContinuousBoundaryFunction{RF}(fun, parameters)
end
and possibly briefly discuss the discrete vs continuous and maybe the reduce_dim bit(s). Test should have most of it.

@luraess luraess mentioned this pull request Apr 11, 2025
@luraess
Copy link
Member

luraess commented Apr 11, 2025

Thanks @Iddingsite for starting this doc addition. Maybe one could add a docstring for

Addressed by #83

@luraess luraess requested a review from utkinis April 11, 2025 22:44
@utkinis
Copy link
Member

utkinis commented Apr 14, 2025

Thanks @Iddingsite for the contribution! Looks good to me, merging...

@utkinis utkinis merged commit 1fe244f into PTsolvers:main Apr 14, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants