Ferrite-FEM/Ferrite.jl

Document custom quadrature rules

Open

#513 opened on Oct 9, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Julia (109 forks)github user discovery
docsgood first issuehelp wanted

Repository metrics

Stars
 (439 stars)
PR merge metrics
 (Avg merge 15d 5h) (17 merged PRs in 30d)

Description

From https://github.com/Ferrite-FEM/Ferrite.jl/pull/482#issuecomment-1272555611 (cc @edljk)

it could perhaps be an easier way to extend quadrature rules in Ferrite.

It is actually pretty easy to do this already -- you can construct your own quadrature rule by:

julia> weights = [2.0, 2.0];

julia> points = [Vec{2}((-0.5, 0.0)), Vec{2}((0.5, 0.0))];

julia> qr = QuadratureRule{2,RefTetrahedron,Float64}(weights, points)
QuadratureRule{2, RefTetrahedron, Float64}([2.0, 2.0], Vec{2, Float64}[[-0.5, 0.0], [0.5, 0.0]])

It would be nice to i) document this and ii) add a constructor QuadratureRule{dim,shape}(weights, points) that doesn't require specifying the element type (Float64 in the example above).

Contributor guide

Research direction
Examine the current documentation and the existing QuadratureRule constructor in the source code to understand what changes are needed for adding a simpler constructor and describing it in the docs.
Tech stack
julia
Domain
tooling
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Julia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80