precice/openfoam-adapter

Insonsistent data naming scheme across modules

オープン

#207 opened on 2021/11/18

 (1 件のコメント) (0 件のリアクション) (0 人の担当者)C++ (115 件のフォーク)auto 404
breaking-changegood first issue

Repository metrics

Stars
 (171 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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?

コントリビューターガイド