docs: README covers the UMAT layer, plasticity and every registered type (#72) - #82
Merged
Merged
Conversation
…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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
docs/plasticity.mdanddocs/plasticity-theory.md;NUMSIM_MATERIALS_DEFINE_UMATandNUMSIM_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;commit()/revert()belong to the driver.The opening example is a J2 deck with every parameter name checked against the materials' own schemas (
local_newtontakestolerance, nottol;sigma_0is onj2_plasticity, not on the hardening material). It also flags theKcollision -- bulk modulus on one material, hardening modulus on another -- which #73 tracks.rk_integratoris deliberately absent from the registered-type table: it is not registered, which is #61.