Repository navigation
Refactor: ldem package with a regression safety net, readable case files and documentation in four languages - #4
Merged
Conversation
…ritance and sweeps
…ne language with translations
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.
What this PR does
Replaces the original MATLAB scripts with the
ldempackage, keeping theresults of the original code (frozen under the tag
legacy-reference) as thereference, and adds a readable input format, new examples and a documentation
site.
The history is in 13 commits, in the order they were built.
What it contains
Safety net
fixtures (
tests/regression,tests/fixtures); the bugs found in the originalare listed with their fixes in
docs/known-issues/KNOWN_ISSUES.md.The
ldempackage (src/+ldem)ldem.Parameters; mesh, material (bilinear law, random field of thecritical strain read from a file or generated in memory), solver with energy
balance,
ldem.runSimulation, and outputs (results.mat, ANSYS macros, VTK/ParaView).bi-clamped beam loaded with a force (Rodrigo's model,
dev_rodrigo).Case files (
.ldem) replaceDATA0.DAT3.87 GPa), comments, scenario and outputs in one file;errors name the file, line and key.
ldem.run,ldem.check(dry run),ldem.io.convertLegacyInput(gives the sameParametersas the legacy reader).linear_elastic,nonebesides thelegacy ones), custom tests with
[[support]]/[[load]]blocks,extendsinheritance and parameter sweeps (
ldem.sweep).ldem.runrecords what was run (hash of the case, resolved case, parents).Documentation
catalogs (
docs/locale), each language is its own site with a language selector.docs/tools/update_translations.pykeeps them in step.four-point bending beam), with figures and numbers from real runs.
Build and CI
buildtooltasks (check, test, testAll, docs, clean) and GitHub workflows.How it was checked
buildtool: Code Analyzer with no warnings and 386 tests passing (unit andregression).
beam through its case file gives the same results as through the script.
Not checked / to know
buildtool testAll(slow tests, full 167,000-node beam) has not been run since thepluggable laws and custom tests were added.
review.
OU2 = 14398in the bi-clamped beam input is kept only as a comment: the originalcode does not use it and it is not confirmed that it is the tracked bar.
.mscript as case file, distributed loads, and laws with their ownparameters in the case file.
For the reviewer
Start with
CHANGELOG.mdand the user guide pages Usage and Examples. The code toread first is
src/+ldem/runSimulation.m,src/+ldem/+io/readCase.mandsrc/+ldem/+schema/caseSchema.m(the single table of keys).