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

standardize output fields for property types #59

Open
chrishavlin opened this issue Aug 2, 2023 · 2 comments
Open

standardize output fields for property types #59

chrishavlin opened this issue Aug 2, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation new contributor friendly: medium-sized fixes these issues are relatively simply to tackle but will require digging in to some of the VBRc guts.

Comments

@chrishavlin
Copy link
Member

The docs should include a description of the standard output fields for elastic, viscous and anelastic methods.

@chrishavlin chrishavlin added the documentation Improvements or additions to documentation label Aug 2, 2023
@chrishavlin
Copy link
Member Author

for anelastic methods:

frequency dependent variables:

  • J1, J2 : frequency dependent storage and loss modulus in 1/Pa
  • Q : quality factor
  • Qinv: attenutation (1/Q)
  • M: (shear) modulus in Pa
  • V: shear wave velocity in m/s

frequency independent variables

  • tau_M: maxwell time in s
  • Vave: average shear wave velocity across frequencies

other expected variables

  • units: a structure containing the units of the output field.

Note: for units for anelastic methods, can populate standard units entries with Q_method_units(). any non-standard fields should have corresponding units entries.

@chrishavlin chrishavlin added the new contributor friendly: quick fixes these issues are easy, quick fixes (think typo fixes, 1-2 line code changes). label May 28, 2024
@chrishavlin
Copy link
Member Author

Note: the individual methods pages linked from https://vbr-calc.github.io/vbr/vbrmethods/anelastic/ do include output field descriptions. but it'd be nice if https://vbr-calc.github.io/vbr/vbrmethods/anelastic/ itself had a list of the output fields that are common to all methods.

@chrishavlin chrishavlin added new contributor friendly: medium-sized fixes these issues are relatively simply to tackle but will require digging in to some of the VBRc guts. and removed new contributor friendly: quick fixes these issues are easy, quick fixes (think typo fixes, 1-2 line code changes). labels Jul 19, 2024
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 new contributor friendly: medium-sized fixes these issues are relatively simply to tackle but will require digging in to some of the VBRc guts.
Projects
None yet
Development

No branches or pull requests

1 participant