FEniCS/dolfinx

Restructure demos into more functions where appropriate

Aperta

#3076 aperta il 27 feb 2024

Vedi su GitHubGuida contributor
 (3 commenti) (0 reazioni) (0 assegnatari)C++ (255 fork)auto 404
demogood first issue

Metriche repository

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

Descrizione

Most demos (C++ and Python) have a flat structure. This is fine for simple problems, but I see time and time again that users model their more extensive solvers on the demos and create single function (C++) / flat script (Python) demos that can be many hundreds or thousands of lines.

It would be good to review the structure of demos and refactor with more functions where appropriate. Hopefully users will then model their own codes on the more structured demos.

Guida contributor

Direzione di ricerca
Esamina gli esempi C++ e Python e identifica quelli eccessivamente lunghi. Refactoring suddividendoli in funzioni più piccole, assicurando che gli esempi rimangano eseguibili e comprensibili.
Tech stack
cpppython
Dominio
documentation
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
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++PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80