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

Add checker ruleset for XOMP-files, update handling of units #357

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

DavidJRitter904
Copy link
Contributor

@DavidJRitter904 DavidJRitter904 commented Feb 4, 2025

Describe your changes

Added checker ruleset for XOMP-files and updated the property units for conformity to documentation.

Issue ticket number and link

Fixes #354 .

Checklist before requesting a review

  • I have performed a self-review of my code/documentation.
  • My changes generate no new warnings during the documentation generation.

@DavidJRitter904 DavidJRitter904 added this to the v1.0.0 milestone Feb 4, 2025
@DavidJRitter904 DavidJRitter904 linked an issue Feb 4, 2025 that may be closed by this pull request
@DavidJRitter904
Copy link
Contributor Author

DavidJRitter904 commented Feb 4, 2025

I have added valid ranges for the following XOMP-properties:

Property Range Comment
1. surface height RMS 0 --> inf (m) upper limit left open as we have not defined any restrictions
2. surface correlation length 0 --> inf (m) no upper limit as no restriction defined
3. emissivity coefficient 0 --> 1 referenced to black body
4. temperature 0 --> inf (K)
5. youngs modulus 0 --> 1,5 x 1012 Pa upper limit defined a bit higher than diamond (1,22 x 1012 Pa)
6. poissons ratio -1 --> 0.5 from extreme auxetic to perfectly inkompressible
7. density 0 --> 25 kg m-3 upper limit defined a bit higher than Osmium
(natural material: 22,59 kg m-3 - diamond: 3,52 kg m-3)
8. coefficient of retroreflectivity 0 --> 5000 cd lx-1 m-2 current road signs 2000 - 3000 cd lx-1 m-2

I think this is a good starting point for these value ranges.
Since we have not clearly defined restrictions to the surface roughness parameters such as differentiation of micro and macro ranges, I left the range open to be defined by the user.

@ClemensLinnhoff maybe you can add Sandro as well. Is not possible for me to assign.

@ClemensLinnhoff
Copy link
Collaborator

@SandroReith could you also review this?

Signed-off-by: ClemensLinnhoff <[email protected]>
@ClemensLinnhoff
Copy link
Collaborator

I added some of the reasoning you gave here in the PR to the rules. Then people who read the documentation also know, why these boundaries were chosen.

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.

Add rules for xomp parameters
2 participants