Skip to content

Commit

Permalink
fix docs for real this time
Browse files Browse the repository at this point in the history
  • Loading branch information
lijas committed Nov 4, 2024
1 parent 07677db commit 1928658
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
1 change: 0 additions & 1 deletion docs/src/devdocs/FEValues.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ Ferrite.BCValues
```@docs
Ferrite.embedding_det
Ferrite.shape_value_type(::Ferrite.AbstractValues)
Ferrite.shape_value_type(::Ferrite.FunctionValues)
Ferrite.shape_gradient_type
Ferrite.ValuesUpdateFlags
```
Expand Down
2 changes: 1 addition & 1 deletion docs/src/devdocs/interpolations.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Ferrite.reference_shape_values!
Ferrite.reference_shape_gradients!
Ferrite.reference_shape_gradients_and_values!
Ferrite.reference_shape_hessians_gradients_and_values!
Ferrite.shape_value_type(::Ferrite.Interpolation)
Ferrite.shape_value_type(ip::Interpolation, ::Type{T}) where T<:Number
```

### Required methods to implement for all subtypes of `Interpolation` to define a new finite element
Expand Down
6 changes: 4 additions & 2 deletions src/interpolations.jl
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,12 @@ n_components(::VectorInterpolation{vdim}) where {vdim} = vdim
n_dbc_components(ip::Interpolation) = n_components(ip)

"""
shape_value_type(ip::Iterpolation, ::Type{T}) where T<:Number
shape_value_type(ip::Interpolation, ::Type{T}) where T<:Number
Return the type of `shape_value(ip::Interpolation, ξ::Vec, ib::Int)`
Return the type of `shape_value(ip::Interpolation, ξ::Vec, ib::Int)`.
"""
shape_value_type(::Interpolation, ::Type{T}) where {T <: Number}

shape_value_type(::ScalarInterpolation, ::Type{T}) where {T <: Number} = T
shape_value_type(::VectorInterpolation{vdim}, ::Type{T}) where {vdim, T <: Number} = Vec{vdim, T}

Check warning on line 68 in src/interpolations.jl

View check run for this annotation

Codecov / codecov/patch

src/interpolations.jl#L67-L68

Added lines #L67 - L68 were not covered by tests
#shape_value_type(::MatrixInterpolation, T::Type) = Tensor #958
Expand Down

0 comments on commit 1928658

Please sign in to comment.