llnl / llnl/smith

Disambiguate various `state` type names

Open
#1,008 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I like the clearer function name here-- in a future PR could we consider renaming `FiniteElementState` and `material_model::State` to avoid having so many unrelated abstractions go by the name `State`?

e.g. `FiniteElementState`->`Field`, `material_model::State`->`material_model::internal_variables`

_Originally posted by @samuelpmishLLNL in https://github.com/LLNL/serac/pull/977#discussion_r1350715710_

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

Start by locating references to FiniteElementState and material_model::State throughout the C++ codebase and review the surrounding abstractions. Apply the agreed replacement names consistently, then verify that no unrelated State names are conflated and that the project still builds.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.