openfoam-adapter icon indicating copy to clipboard operation
openfoam-adapter copied to clipboard

Published 20 hours ago • verified publisher icon precice

Insonsistent data naming scheme across modules

Open MakisH opened this issue 3 years ago • 1 comments

Stemming from https://github.com/precice/openfoam-adapter/pull/197#discussion_r724973150. 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 :see_no_evil:)
    • 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?

MakisH avatar Nov 18 '21 18:11 MakisH

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 :+1:

davidscn avatar Nov 19 '21 07:11 davidscn