precice/openfoam-adapter

Insonsistent data naming scheme across modules

Open

#207 opened on Nov 18, 2021

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)C++ (115 forks)auto 404
breaking-changegood first issue

Repository metrics

Stars
 (171 stars)
PR merge metrics
 (PR metrics pending)

Description

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?

Contributor guide

Research direction
Identify all data names in CHT, FSI, and FF modules that use CamelCase or inconsistent naming. Create a plan to rename them to snake case while maintaining backward compatibility until v2. Update documentation and tutorials accordingly.
Tech stack
cpp
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45