Skip to content

docs: README covers the UMAT layer, plasticity and every registered type (#72) - #82

Merged
petlenz merged 1 commit into
mainfrom
docs/readme-coverage
Sep 20, 2026
Merged

petlenz merged 1 commit into
mainfrom
docs/readme-coverage

Conversation

@petlenz

@petlenz petlenz commented Sep 20, 2026

Copy link
Copy Markdown
Member

Closes #72.

The README had zero mentions of UMAT, CalculiX, Abaqus, plasticity or docs/, and listed 13 of the 29 registered types. Everything a new user would come for -- the return maps, the hardening laws, the solvers, the UMAT layer, the CalculiX hook, both theory documents -- was invisible from the front page.

Adds:

  • a documentation index pointing at docs/plasticity.md and docs/plasticity-theory.md;
  • a plasticity section: the split between return map, yield surface and hardening law, and what each registered type is;
  • a UMAT section with both entry-point macros (NUMSIM_MATERIALS_DEFINE_UMAT and NUMSIM_MATERIALS_DEFINE_CALCULIX_BEHAVIOUR), noting that the CalculiX hook takes PK2 and dS/dE, and that small-strain materials are valid for large rotation with small strain only;
  • the complete type list, all 29, grouped by area;
  • install-and-consume instructions;
  • a note that commit()/revert() belong to the driver.

The opening example is a J2 deck with every parameter name checked against the materials' own schemas (local_newton takes tolerance, not tol; sigma_0 is on j2_plasticity, not on the hardening material). It also flags the K collision -- bulk modulus on one material, hardening modulus on another -- which #73 tracks.

rk_integrator is deliberately absent from the registered-type table: it is not registered, which is #61.

…ype (#72)

The README had no mention of UMAT, CalculiX, Abaqus, plasticity or docs/,
and listed 13 of the 29 registered types -- so the return maps, the
hardening laws, the solvers, the UMAT layer, the CalculiX hook and both
theory documents were invisible from the front page.

Adds a plasticity section, a UMAT/CalculiX section with both entry-point
macros, a documentation index, install-and-consume instructions, and the
complete type list grouped by area. The opening example is a J2 deck with
the parameter names checked against the materials' own schemas, and it
notes the K collision (bulk modulus vs hardening modulus) that #73 tracks.
@petlenz
petlenz merged commit 4b48794 into main Sep 20, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README does not mention UMAT, CalculiX, Abaqus, plasticity or docs/, and lists 13 of 29 registered types

1 participant