precice/openfoam-adapter

Insonsistent data naming scheme across modules

Aperta

#207 aperta il 18 nov 2021

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)C++ (115 fork)auto 404
breaking-changegood first issue

Metriche repository

Star
 (171 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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?

Guida contributor

Direzione di ricerca
Identifica tutti i nomi di dati nei moduli CHT, FSI e FF che usano CamelCase o nomenclature incoerenti. Crea un piano per rinominarli in snake case mantenendo la retrocompatibilità fino alla v2. Aggiorna la documentazione e i tutorial di conseguenza.
Tech stack
cpp
Dominio
backend
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
C++Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
45