Skip to content

Add updated function names in devdocs #1036

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Aug 2, 2024
Merged

Add updated function names in devdocs #1036

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5468e7e
Add updated function names in devdocs
KnutAM Aug 2, 2024
a3252db
Fix missed entry
KnutAM Aug 2, 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
12 changes: 7 additions & 5 deletions docs/src/devdocs/interpolations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,23 @@ parametrized by the reference element and its characteristic order.
Ferrite.getrefdim(::Interpolation)
Ferrite.getrefshape(::Interpolation)
Ferrite.getorder(::Interpolation)
Ferrite.shape_gradient(::Interpolation, ::Vec, ::Int)
Ferrite.shape_gradient_and_value
Ferrite.reference_shape_gradient(::Interpolation, ::Vec, ::Int)
Ferrite.reference_shape_gradient_and_value(::Interpolation, ::Vec, ::Int)
Ferrite.reference_shape_hessian_gradient_and_value(::Interpolation, ::Vec, ::Int)
Ferrite.boundarydof_indices
Ferrite.dirichlet_boundarydof_indices
Ferrite.reference_shape_values!
Ferrite.shape_gradients!
Ferrite.shape_gradients_and_values!
Ferrite.reference_shape_gradients!
Ferrite.reference_shape_gradients_and_values!
Ferrite.reference_shape_hessians_gradients_and_values!
```

### Required methods to implement for all subtypes of `Interpolation` to define a new finite element

Depending on the dimension of the reference element the following functions have to be implemented

```@docs
Ferrite.shape_value(::Interpolation, ::Vec, ::Int)
Ferrite.reference_shape_value(::Interpolation, ::Vec, ::Int)
Ferrite.vertexdof_indices(::Interpolation)
Ferrite.dirichlet_vertexdof_indices(::Interpolation)
Ferrite.facedof_indices(::Interpolation)
Expand Down