Extend FEM Module

The FEM workbench already supports a lot of different constraints and a handful of solver. Despite that people often need constraints not jet supported by FreeCAD. This page is the starting point to a series of tutorials and other resources describing how to extend the FEM workbench using the existing framework. While this series can prove helpful to software developers too the idea is to allow FEM users with a bit of interest into python coding to add the stuff they need themselves.

Adding new constraints, equations or solver is mostly routine work. But doing it for the first time will not be as easy as it might seem. An understanding of the following topics will prove helpful:


 * Python scripting in FreeCAD.
 * FreeCAD Scripting Tutorial
 * FreeCAD Scripting Basics
 * Extending FreeCAD with Python.
 * Scripted Objects
 * A solid understanding of the solver for which new objects shall be added (e.g. CalculiX or Elmer) is important.
 * A little knowledge about build systems, especially cmake (build system used by FreeCAD).

Build System (cmake)
The build system must be modified regardless of which objects shall be added o the FEM workbench. Every python module (file) must be registered. The FEM workbench even requires every new python module to be registered twice. Once in and a second time in. This is true regardless of the type of the python module (GUI or non-GUI). Where exactly the module must be inserted depends on the role of the module. Solver, equations and constraints all use different lists. Searching for similar files and inserting the new file in the same list works most of the time.

As an example lets add a new constraint called 'pressure which is related to the flow equation. So, FlowPressure will widely used as for this constraint. A new constraint requires at least the following new modules: These three files must be added to as well as. All inserted lines of code are indicated by a starting +.
 * and
 * and

Mod/Fem/CMakeLists.txt

SET(FemObjects_SRCS   femobjects/__init__.py    femobjects/base_fempythonobject.py    femobjects/constraint_bodyheatsource.py    femobjects/constraint_electrostaticpotential.py    femobjects/constraint_flowvelocity.py    femobjects/constraint_initialflowvelocity.py +   femobjects/constraint_initialflowpressure.py    femobjects/constraint_selfweight.py ...    femobjects/solver_ccxtools.py ) ... SET(FemGuiViewProvider_SRCS   femviewprovider/__init__.py    femviewprovider/view_base_femconstraint.py    femviewprovider/view_base_femobject.py    femviewprovider/view_constraint_bodyheatsource.py    femviewprovider/view_constraint_electrostaticpotential.py    femviewprovider/view_constraint_flowvelocity.py +   femviewprovider/view_constraint_flowpressure.py    femviewprovider/view_constraint_initialflowvelocity.py    femviewprovider/view_constraint_selfweight.py ...    femviewprovider/view_solver_ccxtools.py )

Mod/Fem/App/CMakeLists.txt

SET(FemObjectsScripts_SRCS   PyObjects/__init__.py    PyObjects/_FemConstraintSelfWeight.py    PyObjects/_FemConstraintBodyHeatFlux.py    PyObjects/_FemConstraintFlowVelocity.py +   PyObjects/_FemConstraintFlowPressure.py    PyObjects/_FemElementFluid1D.py    PyObjects/_FemElementGeometry1D.py    PyObjects/_FemElementGeometry2D.py    PyObjects/_FemMaterialMechanicalNonlinear.py    PyObjects/_FemMeshBoundaryLayer.py    PyObjects/_FemMeshGmsh.py    PyObjects/_FemMeshGroup.py    PyObjects/_FemMeshResult.py    PyObjects/_FemMeshRegion.py    PyObjects/_FemResultMechanical.py    PyObjects/_FemSolverCalculix.py    PyObjects/_FemMaterial.py )

SET(FemGuiScripts_SRCS   PyGui/FemCommands.py    PyGui/__init__.py    PyGui/_CommandFemAnalysis.py    PyGui/_CommandFemConstraintSelfWeight.py    PyGui/_CommandFemConstraintBodyHeatFlux.py    PyGui/_CommandFemConstraintFlowVelocity.py +   PyGui/_CommandFemConstraintFlowPressure.py    PyGui/_CommandFemElementFluid1D.py    PyGui/_CommandFemElementGeometry1D.py    ...    PyGui/_ViewProviderFemConstraintBodyHeatFlux.py    PyGui/_ViewProviderFemConstraintFlowVelocity.py +   PyGui/_ViewProviderFemConstraintFlowPressure.py    PyGui/_ViewProviderFemElementFluid1D.py    PyGui/_ViewProviderFemElementGeometry1D.py    PyGui/_ViewProviderFemElementGeometry2D.py    ... )

Source Organization
For organizing the python code the FEM module uses the following approach. The module is split into the following packages:
 * , which contains all non-GUI like python proxies for document objects and
 * containing everything GUI related like python proxies for view provider
 * C++ based task panels are stored in '',
 * icons can be found in '',
 * .ui files are stored in '' commands.

One package doesn't follow this pattern:. It has its place on the same level as and. The package contains solver and equation related packages and modules and it is organized the following way: .femsolver .femsolver.elmer .femsolver.elmer.equations .femsolver.calculix .femsolver.calculix.equations .femsolver.z88 .femsolver.z88.equations

Solver
In FreeCAD a solver can be split into two parts:
 * One is the document object used by the user to interact with the solver. Though it solver parameter can be set and it is also used to control the solving process.
 * The other one are the so called tasks of a solver. The solving process is split into those tasks, namely: check, prepare, solve and results. Those do the actual work of exporting the analysis into a format understood by the solver executable, starting the executable and loading the results back into FreeCAD.

Most files related to a solver reside in a sub-package of the package (e.g. for Elmer its in ). The following list enumerates all files related to the implementation of a solver. Those are the files that need to be copied and modified to add support for a new solver to FreeCAD. The given example is taken from the solver implementation of Elmer.


 * femsolver/elmer/Object.py: Document object visible in the tree-view. Implemented in python via a document proxy and view proxy.
 * femsolver/elmer/Tasks.py: Module containing one task class per task required for a solver implementation. Those tasks divide the process of solving a analysis into the following steps: check, prepare, solve, results.
 * femcommands/commands.py: Adds the solver document object to the active document. Required to access the solver object from the GUI.

Equations
An equation represents a particular physics that shall be considered when solving the analysis (e.g. Flow, Heat). Not all solver in FreeCAD support (all) equations. Equations are represented by child objects of the corresponding solver object. In the tree-view this looks like this:


 * elmer-solver
 * elasticity
 * heat
 * flow
 * electrostatics

Most solver specific options (e.g. max. iterations, method of solving, etc) are set via the equation objects. One consequence of this is that each solver must have it's own implementation of &quot;the same&quot; equation. CalculiX would have a different Heat-object that Elmer. To avoid having multiple buttons for the same physics in the GUI each solver object adds it's equations itself.

The actual implementation can be split into the generic and the solver specific part. The generic part can be found in the module. The solver specific part resides inside individual Equations sub-packages of the solver packages (e.g. ).

Adding a new equations to Elmer should be very easy. For newcomers there exists a tutorial which shows how to add a new equation to Elmer by adding the existing elasticity solver to FreeCAD: Add FEM Equation Tutorial.

Constraints
Constraints define boundary conditions for the problem that shall be solved. In FreeCAD constraints aren't specific to a particular solver. A problem setup can be solved by all solver that support all conditions in the analysis.

Adding new constraints is quite straight forward. For newcomers there is a tutorial: Add FEM Constraint Tutorial.