Onboarding FEM Devs
Appearance
Description[edit | edit source]
This page will orient new developers on how to setup their development environments in order to hack on the FEM workbench.
Setting up a Dev Environment[edit | edit source]
TBD
Prerequisites[edit | edit source]
- Netgen
Recommended[edit | edit source]
- Paraview
Compiling via Source[edit | edit source]
TBD
Compiling via Docker[edit | edit source]
TBD
Source Code Management[edit | edit source]
Keeping FreeCAD up-to-date is documented in Source code management page. Along with useful git tips.
FEM Code Infrastructure[edit | edit source]
The FEM code lives in src/Mod/Fem
App/console-mode application, defines basic structures and base classes for document objects, that are used by modules to build their own.Gui/GUI-mode application, defines the 3D view, tools/functions used by workbench to interact with UI and 3D view, defines base classes for view providers.femcommands/fem.doxfemexamples/femguiobjects/femguiutils/feminout/femmesh/femobjects/femresult/femsolver/femtaskpanels/femtest/femtools/femviewprovider/InitGui.pyInit.pyObjectsFem.pyTestFemApp.pyTestFemGui.py
Coding Conventions[edit | edit source]
Please see coding_conventions.md file on the FreeCAD repository.
Adding New FEM Solvers[edit | edit source]
A new FEM solver requires the following:
- Mesh exporter
- Results importer
- Solver object (needs changes in solver settings, unit tests, ObjectsFem modules as well)
- Task and writer module (here is where the main solver input writing happens)
- GUI tool to create a solver
- GUI preference tab to set the solver binary path
- A solver input writing unit test. Best to take the ccx cantilever. This is available for all mesh element types
- Having one or two beers
See also:
- Extend FEM Module
- The implementation efforts of the oofem solver
- The implementation efforts of the myStran solver
Writing Unit Tests[edit | edit source]
TBD
Informative[edit | edit source]
Related[edit | edit source]
- FEM bugs in the FreeCAD bugtracker
- Open FEM FIXME comments in the FreeCAD source code
- Open FEM TODO comments in the FreeCAD source code
- Original thread discussion for this wiki page
- FEM Workbench