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

Insonsistent data naming scheme across modules #207

Open
MakisH opened this issue Nov 18, 2021 · 1 comment
Open

Insonsistent data naming scheme across modules #207

MakisH opened this issue Nov 18, 2021 · 1 comment

Comments

@MakisH
Copy link
Member

MakisH commented Nov 18, 2021

Stemming from #197 (comment). Check the adapter documentation.

Currently expected name prefixes:

  • CHT
    • Temperature
    • Heat-Flux (snake-case)
    • Sink-Temperature
    • Heat-Transfer-Coefficient
  • FSI
    • Force
    • Stress
    • Displacement
    • DisplacementDelta (CamelCase)
  • FF (currently not documented 🙈)
    • Pressure
    • PressureGradient (CamelCase)
    • Velocity
    • VelocityGradient

This would be a breaking change (we would need to update the tutorials), so I would suggest that we choose one system and support both styles until v2.

In the contributing guidelines of preCICE we have already chosen the snake-case format. This would also be consistent with our precice-config.xml.

@davidscn what do you think?

@davidscn
Copy link
Member

In the contributing guidelines of preCICE we have already chosen the snake-case format. This would also be consistent with our precice-config.xml.

Sounds good 👍

@MakisH MakisH changed the title Insonsistent data naming across modules Insonsistent data naming scheme across modules Feb 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants