precice/openfoam-adapter

Insonsistent data naming scheme across modules

开放

#207 创建于 2021年11月18日

 (1 条评论) (0 个反应) (0 位负责人)C++ (115 个派生)auto 404
breaking-changegood first issue

仓库指标

星标
 (171 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

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?

贡献者指南