Extend FEM Module/it

L'ambiente FEM supporta già un sacco di vincoli diversi e alcuni solutori. Nonostante ciò spesso si ha bisogno di vincoli non ancora supportati da FreeCAD. Questa pagina è il punto di partenza per una serie di esercitazioni e di altre risorse che descrivono come estendere l'ambiente FEM utilizzando la struttura esistente. Anche se questa serie può rivelarsi utile per gli sviluppatori di software, l'idea è di permettere agli utenti di FEM che hanno un po' di interesse per la codifica in Python di aggiungere le cose di cui hanno bisogno.

Aggiungere nuovi vincoli, equazioni o solutori è per lo più un lavoro di routine. Ma farlo per la prima volta non è così facile come potrebbe sembrare. È utile conoscere i seguenti argomenti:


 * Script Python in FreeCAD.
 * Tutorial sugli script di FreeCAD
 * Nozioni di base sugli script di FreeCAD
 * Estensione di FreeCAD con Python.
 * Script di oggetti
 * Una solida conoscenza del risolutore per il quale devono essere aggiunti nuovi oggetti (ad es. Calculix) è importante.
 * Una conoscenza di base dei sistemi di compilazione, in particolare cmake (sistema di compilazione utilizzato da FreeCAD)

Sistema di costruzione (cmake)
The build system must be modified regardless of which objects shall be added o the FEM workbench. Every python module (file) must be registerd. The FEM workbench even requries every new python module to be registerd twice. Once in Mod/Fem/CMakeLists.txt and a secound time in Mod/Fem/App/CMakeLists.txt. This is true regaredless of the type of the python module (gui or non-gui). Where exactely 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.

Ad esempio, proviamo ad aggiungere un nuovo vincolo di pressione. Un nuovo vincolo richiede almeno i seguenti nuovi moduli: FemConstraint .py, ViewProviderFemConstraint .py, CommandFemConstraint .py. Questi tre file devono essere aggiunti a CMakeLists.txt ed anche a App/CMakeLists.txt.

Mod/Fem/CMakeLists.txt

INSTALL(   FILES        PyObjects/__init__.py        PyObjects/_FemConstraintSelfWeight.py        PyObjects/_FemConstraintBodyHeatFlux.py        PyObjects/_FemConstraintFlowVelocity.py +       PyObjects/_FemConstraintFlowPressure.py        PyObjects/_FemElementFluid1D.py        PyObjects/_FemElementGeometry1D.py        PyObjects/_FemElementGeometry2D.py        ...    DESTINATION        Mod/Fem/PyObjects )

INSTALL(   FILES        PyGui/FemCommands.py        PyGui/__init__.py        PyGui/_CommandFemSolverElmer.py        PyGui/_CommandFemEquation.py        PyGui/_CommandFemConstraintBodyHeatFlux.py        PyGui/_CommandFemConstraintFlowVelocity.py +       PyGui/_CommandFemConstraintFlowPressure.py        PyGui/_CommandFemAnalysis.py        PyGui/_CommandFemElementFluid1D.py        PyGui/_CommandFemElementGeometry1D.py        ...        PyGui/_ViewProviderFemConstraintSelfWeight.py        PyGui/_ViewProviderFemConstraintBodyHeatFlux.py        PyGui/_ViewProviderFemConstraintFlowVelocity.py +       PyGui/_ViewProviderFemConstraintFlowPressure.py        PyGui/_ViewProviderFemElementFluid1D.py        PyGui/_ViewProviderFemElementGeometry1D.py        PyGui/_ViewProviderFemElementGeometry2D.py        ...    DESTINATION        Mod/Fem/PyGui ) 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    ... )

Organizzazione del codice sorgente
Per organizzare il codice Python il modulo FEM usa un approccio simile a quello usato per il codice C++ in FreeCAD. Il modulo è diviso in due pacchetti. PyObjects, che contiene tutti i proxy Python non-gui come gli oggetti del documento e PyGui che contiene tutto ciò che è collegato come proxy python per il provider di visualizzazione, i pannelli delle attività, i file ui e i comandi.

Un pacchetto non segue questo modello: FemSolver. È posizionato allo stesso livello di PyObjects e PyGui (src/Mod/Fem/FemSolver). Il pacchetto contiene il solutore con i pacchetti relativi all'equazione ed ai moduli ed è organizzato nel seguente modo: .FemSolver .FemSolver.Elmer .FemSolver.Elmer.Equations .FemSolver.Calculix .FemSolver.Calculix.Equations .FemSolver.Z88 .FemSolver.Z88.Equations

Solutore
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.

La maggior parte dei file relativi a un solver si trovano in un sottopacchetto del pacchetto FemSolver (e.g. FemSolver.Elmer). La seguente lista elenca tutti i file relativi all'implementazione di un risolutore. Questi sono i file che devono essere copiati e modificati per aggiungere il supporto per un nuovo risolutore in FreeCAD.


 * 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.
 * PyGui/_CommandFemElmer.py: Adds the solver document object to the active document. Required to access the solver object from the GUI.

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


 * ElmerSolver
 * Elasticity
 * Heat
 * Flow

Most solver specific options (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 FemSolver.EquationBase module. The solver specific part resides inside individual Equations sub-packages of the solver packages (e.g. FemSolver/Elmer/Equations).

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 staight foreward. For newcomers there is a tutorial: Add FEM Constraint Tutorial.