llnl / llnl/smith

Unify finite element notation in theory docs

Open
#424 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug documentation quick
Dominant language
C++
Stars
245
Forks
36
Avg merge
8d 23h
Merged PRs (30d)
4

Description

The notation for shape functions is different between thermal conduction and solid mechanics. We should unify it for clarity.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the theory documentation sections for thermal conduction and solid mechanics, then compare how shape functions are named and described. Agree on a single notation and update both sections; done means the notation is consistent and the explanations remain clear in each context.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.