Skip to content

Commit

Permalink
Expose some missing docstrings to devdocs (#964)
Browse files Browse the repository at this point in the history
  • Loading branch information
termi-official committed Jun 5, 2024
1 parent c33a191 commit 51437f4
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
10 changes: 9 additions & 1 deletion docs/src/devdocs/FEValues.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@
* [`CellValues`](@ref)
* `AbstractFacetValues`
* [`FacetValues`](@ref)
* [`BCValues`](@ref)
* [`BCValues`](@ref Ferrite.BCValues)
* [`PointValues`](@ref)
* [`InterfaceValues`](@ref)


## Internal types
Expand All @@ -18,6 +19,13 @@ Ferrite.FunctionValues
Ferrite.BCValues
```

## Internal utilities
```@docs
Ferrite.embedding_det
Ferrite.shape_value_type
Ferrite.shape_gradient_type
```

## Custom FEValues
Custom FEValues, `fe_v::AbstractValues`, should normally implement the [`reinit!`](@ref) method. Subtypes of `AbstractValues` have default implementations for some functions, but require some lower-level access functions, specifically

Expand Down
3 changes: 3 additions & 0 deletions docs/src/devdocs/elements.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,12 @@ Ferrite.get_coordinate_eltype(::Ferrite.AbstractGrid)
Ferrite.get_coordinate_eltype(::Node)
Ferrite.toglobal
Ferrite.sortface
Ferrite.sortface_fast
Ferrite.sortedge
Ferrite.sortedge_fast
Ferrite.element_to_facet_transformation
Ferrite.facet_to_element_transformation
Ferrite.InterfaceOrientationInfo
Ferrite.transform_interface_points!
Ferrite.get_transformation_matrix
```
2 changes: 1 addition & 1 deletion src/FEValues/FacetValues.jl
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ function reinit!(fv::FacetValues, cell::Union{AbstractCell, Nothing}, x::Abstrac
@inbounds for (q_point, w) in pairs(getweights(fv.fqr, face_nr))
mapping = calculate_mapping(geo_mapping, q_point, x)
J = getjacobian(mapping)
# See the `Ferrite.embedded_det` docstring for more background
# See the `Ferrite.embedding_det` docstring for more background
weight_norm = weighted_normal(J, getrefshape(geo_mapping.ip), face_nr)
detJ = norm(weight_norm)
detJ > 0.0 || throw_detJ_not_pos(detJ)
Expand Down

0 comments on commit 51437f4

Please sign in to comment.