precice/openfoam-adapter

Insonsistent data naming scheme across modules

Ouverte

#207 ouverte le 18 nov. 2021

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)C++ (115 forks)auto 404
breaking-changegood first issue

Métriques du dépôt

Stars
 (171 étoiles)
Métriques de merge PR
 (Merge moyen 54j 14h) (1 PR mergée en 30 j)

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?

Guide contributeur

Direction de recherche
Identifiez tous les noms de données dans les modules CHT, FSI et FF qui utilisent le CamelCase ou une nomenclature incohérente. Créez un plan pour les renommer en snake case tout en maintenant la rétrocompatibilité jusqu'à la v2. Mettez à jour la documentation et les tutoriels en conséquence.
Stack technique
cpp
Domaine
backend
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C++Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
45