Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation / add option to output parameter names #18

Open
rcarson3 opened this issue Nov 2, 2021 · 2 comments
Open

Improve documentation / add option to output parameter names #18

rcarson3 opened this issue Nov 2, 2021 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@rcarson3
Copy link
Member

rcarson3 commented Nov 2, 2021

@nrbertin brought up a good point while he was using the python bindings that it would be nice to see what the property names are for each model. We are definitely lacking in this area, and the only place that I believe has all the parameters labelled is my script for ExaConstit: https://github.com/LLNL/ExaConstit/blob/exaconstit-dev/scripts/ecmech_prop_file.py

So, my suggestions would be to add a new function that outputs the model parameter names in a human readable format rather than the blob of numbers that getParams would return. This call should also be able return the names and values if they've already been provided.

I'll see if I can't get to this at the start of the new years as part of improving documentation through-out the code.

@rcarson3 rcarson3 added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 2, 2021
@rcarson3 rcarson3 self-assigned this Nov 2, 2021
@nrbarton
Copy link
Collaborator

nrbarton commented Nov 2, 2021

The logParameters function could be made to output that information, rather than just dumping a blob of numbers. For other material model libraries with a similar interface, logParameters is more human-readable. But that is still just a big string that is not useful for a host code doing things like trying to set parameters by name. So you could add getParamNames or the like that would return a std::vector. Building up the machinery to do that would probably take some work, with each sub-model in an overall model perhaps being required to offer up its parameter names.

@rcarson3
Copy link
Member Author

rcarson3 commented Nov 3, 2021

I think the getParamNames type function could work here. I do expect it to take a little bit of work to put it together, but we luckily only have a few models currently in ExaCMech, and I believe I have all the names already mapped out which helps.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants