Skip to content

Suggestion: Adding a Note for Units in Documentation and Source code #19

@vikramroybarc

Description

@vikramroybarc

Hi Erlap,

I wanted to share a suggestion regarding the documentation and source code. I believe it will significantly enhance the user-friendliness of the source code.

In the current implementation, certain variables like "KB" and "tolerance" depend on the unit system used for analysis. These variables are stored in different modules, mainly as global variables and user inputs. For a new user, it would be very helpful to include a note in both the documentation and the source code, explaining which variables need to be adjusted when changing units and what preferred units to use with this umat.

For instance, if a user is utilizing stress in MPa units, the present value of tolerance (1.d-8) implemented in user inputs is valid. However, if the user is employing stress in Pa units, adjusting the tolerance values to (1.d-2 or 1.d-1) may be more appropriate.

I became aware of these details while debugging the subroutine in VSCode. By incorporating these clarifications in the documentation and source code, we can minimize sources of error and significantly improve the code's user-friendliness.

Thank you for your attention to this matter.

Best regards,
Vikram Roy

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions