Add FEM Equation Tutorial/de: Difference between revisions
(Created page with "In diesem Schritt werden wir die folgende Datei modifizieren:") |
No edit summary |
||
(45 intermediate revisions by 4 users not shown) | |||
Line 2: | Line 2: | ||
{{TutorialInfo/de |
{{TutorialInfo/de |
||
|Topic= |
|Topic=FEM Gleichung hinzufügen |
||
|Level= |
|Level=Fortgeschritten |
||
|Time= |
|Time=1 Tag |
||
|Author=[[User: |
|Author=[[User:JohnWang|JohnWang]] |
||
|FCVersion= |
|FCVersion=0.19 |
||
|Files= |
|||
}} |
}} |
||
<span id="Introduction"></span> |
|||
== Einführung == |
|||
==Einleitung== |
|||
In |
In dieser Anleitung werden wir FreeCAD die Gleichung '''Strömung''' (Flow) hinzufügen und die Unterstützung für den Löser Elmer implementieren. Bitte stelle sicher, dass du [[Extend_FEM_Module/de|FEM-Modul erweitern]] gelesen und verstanden hast, bevor du diese Anleitung liest. |
||
Die Aufgabe kann in fünf Teile aufgeteilt werden. |
|||
Die Aufgabe kann in vier Teile aufgeteilt werden. Der erste Schritt besteht darin, den FEM Arbeitsbereich auf einen neuen Gleichungstyp aufmerksam zu machen. Dieser Schritt muss nur durchgeführt werden, wenn die Gleichung in FreeCAD jetzt nicht existiert (im Gegensatz zu einer Gleichung, die bereits in FreeCAD existiert, aber vom Ziellöser nicht unterstützt wird). Der zweite Schritt besteht darin, ein konkretes Dokumentobjekt hinzuzufügen, das die Elmer spezifische Gleichung repräsentiert. Der dritte Schritt besteht darin, dem Löserobjekt von elmer Unterstützung für die neue Gleichung hinzuzufügen. Danach muss der Analyseexport von elmer erweitert werden, um den neuen Gleichungstyp zu unterstützen. |
|||
* '''Neuer Gleichungstyp'''. Dieser Schritt muss nur durchgeführt werden, wenn die Gleichung in FreeCAD bisher nicht existiert (im Gegensatz zu einer Gleichung, die bereits in FreeCAD existiert, aber vom Ziellöser nicht unterstützt wird). |
|||
* '''Neues Gleichungsobjekt'''. Hinzufügen eines konkreten Dokumentobjekts, das die Elmer-spezifische Gleichung repräsentiert. |
|||
* '''Löserobjekt erweitern'''. Dem Elmer-Löserobjekt Unterstützung für die neue Gleichung hinzufügen. |
|||
* '''Writer-Objekt erweitern'''. Erweitern des Elmer-Analyseexports zur Unterstützung des neuen Gleichungstyps. |
|||
* '''GUI-Werkzeug zum Erstellen einer Gleichung'''. Zugriff auf die neue Gleichungsfunktion über den GUI-Arbeitsbereich. |
|||
<span id="New_equation_type"></span> |
|||
== Neuer Gleichungstyp == |
== Neuer Gleichungstyp == |
||
Line 22: | Line 28: | ||
* {{FileName|src/Mod/Fem/femsolver/equationbase.py}} |
* {{FileName|src/Mod/Fem/femsolver/equationbase.py}} |
||
Der Gleichungstyp wird von allen Gleichungsobjekten der verschiedenen Löser gemeinsam verwendet. Jeder Typ hat einen Zeichenfolgenspezifizierer (z.B. "Heat") und einen zugeordneten Befehl, der die Gleichung dem ausgewählten Gleichungslöser hinzufügt. Dies ermöglicht eine einfachere GUI, bei der wir nur eine Schaltfläche für die Wärmegleichung haben, die für alle unterstützten Löser verwendet wird. |
|||
The equation type is shared among all equation objects of the different solver. Each type has a string specifier (e.g. "Heat") and a dedicated command that adds the equation to the selected solver. This allows for a simpler GUI where we have only one button for the heat equation which is used for all supported solver. |
|||
Füge zuerst die neue Gleichung zum {{incode|equationbase.py}}-Modul hinzu. Jede Gleichung erfordert zwei Klassen, ein Dokument-Proxy und ein Ansicht-Proxy. Diese zwei Klassen werden später als Basisklassen für die Elmer-spezifischen Gleichungsklassen benutzt. Kopiere sie einfach von einem existierenden Gleichungstyp und passe den Icon-Pfad in {{Incode|getIcon(self)}} des Ansicht-Proxy an. |
|||
{{Code|code= |
{{Code|code= |
||
Line 35: | Line 41: | ||
}} |
}} |
||
<span id="New_Elmer's_equation_object"></span> |
|||
== Elmers Gleichungs Objekt == |
== Neues Elmers Gleichungs Objekt == |
||
In diesem Schritt werden wir |
In diesem Schritt werden wir das Dokumentobjekt implementieren. Wir müssen eine neue Datei {{Incode|flow.py}} hinzufügen unter: |
||
* {{FileName|src/Mod/Fem/femsolver/elmer/equations/flow.py}} |
* {{FileName|src/Mod/Fem/femsolver/elmer/equations/flow.py}} |
||
und die |
und die folgenden Dateien ändern: |
||
* {{FileName|src/Mod/Fem/ObjectsFem.py}} |
* {{FileName|src/Mod/Fem/ObjectsFem.py}} |
||
* {{FileName|src/Mod/Fem/CMakeLists.txt}} |
* {{FileName|src/Mod/Fem/CMakeLists.txt}} |
||
Beginnen wir dem Hinzufügen der neuen Datei {{Incode|flow.py}}. Diese Datei kann aus einer bestehenden Gleichung kopiert werden. |
|||
Beginnen wir mit dem Modul, das das Dokumentobjekt implementiert. In kann aus einer bestehenden Gleichung kopiert werden. Wenn die neue Gleichung nur Schlüsselwörter für '''lineare''' Systeme unterstützt, kopiere das Modul {{incode|femsolver/elmer/equations/elasticity.py}}. Wenn es '''nicht-lineare''' Schlüsselwörter unterstützt, kopiere auch {{incode|femsolver/elmer/equations/heat.py}}. Die Strömungsgleichung in Elmer ist eine potenziell nichtlineare Gleichung. Das bedeutet, dass wir unsere Arbeit auf {{incode|heat.py}} stützen werden. |
|||
= |
<span id="Keywords"></span> |
||
=== Schlüsselwörter === |
|||
* |
* Falls die neue Gleichung nur Schlüsselworte für '''lineare''' Systeme unterstützt, kopiere das {{Incode|femsolver/elmer/equations/elasticity.py}}-Modul. |
||
* |
* Falls die neue Gleichung Schlüsselworte für '''lineare''' und '''nicht-lineare''' Systeme unterstützt, kopiere das {{Incode|femsolver/elmer/equations/heat.py}}-Modul. |
||
Die Strömungsgleichung ist eine potenziell nicht-lineare Gleichung. Das bedeutet, dass unsere Arbeit auf {{incode|heat.py}} basieren wird. |
|||
The flow equation in Elmer is a potentially non-linear equation. This means that we are going to base our work on {{Incode|heat.py}}. |
|||
<span id="Editing_files"></span> |
|||
=== Editing files === |
|||
=== Dateien bearbeiten === |
|||
Nach dem Kopieren von {{incode|heat.py}} nach {{incode|flow.py}} passe |
Nach dem Kopieren von {{incode|heat.py}} nach {{incode|flow.py}} passe letztere Datei an folgenden Stellen an: |
||
* das Namensargument der {{Incode|create}}-Modulfunktion, |
|||
* die Basisklassen der {{Incode|Proxy}}-Klasse, |
|||
* das {{Incode|Type}}-Attribut der {{Incode|Proxy}}-Klasse, |
|||
* die {{incode|ViewProxy}}-Klassen. |
|||
{{Code|code= |
{{Code|code= |
||
Line 76: | Line 89: | ||
}} |
}} |
||
Dann musst du die über die {{incode|obj.addProperty(..)}}-Funktion hinzugefügten Eigenschaften auf die von der Gleichung benötigten anpassen. |
|||
Zum Zeitpunkt des Schreibens dieses Tutoriums hat die Elmer |
Zum Zeitpunkt des Schreibens dieses Tutoriums hat die Elmer-Strömungsgleichung keine besonderen Eigenschaften. Siehe Elmer-Elastizitätsgleichung für ein Beispiel mit Eigenschaften. |
||
Schließlich muss man eine ''' |
Schließlich muss man eine '''makeEquationFlow'''-Definition in {{Incode|src/Mod/Fem/ObjectsFem.py}} durch Duplizieren eines verfügbaren Eintrags registrieren. |
||
FreeCAD benutzt '''make''' zur Erstellung des Programms. Deshalb müssen wir die neue Moduldatei ({{Incode|flow.py}}) in {{incode|src/Mod/Fem/CMakeLists.txt}} registrieren, wie in [https://www.freecadweb.org/wiki/Extend_FEM_Module FEM Modul erweitern] beschriebenen. Die passenden Listen lassen sich leicht finden, indem man nach vorhandenen Gleichungsmoduldateien von Elmer sucht. |
|||
<span id="Extend_Solver_Object"></span> |
|||
== Löser Objekt erweitern == |
== Löser Objekt erweitern == |
||
Line 90: | Line 104: | ||
* {{FileName|src/Mod/Fem/femsolver/elmer/solver.py}} |
* {{FileName|src/Mod/Fem/femsolver/elmer/solver.py}} |
||
Gerade jetzt haben wir FreeCAD darauf aufmerksam gemacht, dass es einen neuen Gleichungstyp gibt, und sogar einen Befehl hinzugefügt, der diese Gleichung dem ausgewählten Löserobjekt hinzufügt. Wir haben auch ein konkretes Gleichungsobjekt für Elmer implementiert. Was jetzt noch zu tun bleibt, ist die Verbindung zwischen Elmer und der Strömungsgleichung herzustellen. Dies muss direkt im Elmer |
Gerade jetzt haben wir FreeCAD darauf aufmerksam gemacht, dass es einen neuen Gleichungstyp gibt, und sogar einen Befehl hinzugefügt, der diese Gleichung dem ausgewählten Löserobjekt hinzufügt. Wir haben auch ein konkretes Gleichungsobjekt für Elmer implementiert. Was jetzt noch zu tun bleibt, ist die Verbindung zwischen Elmer und der Strömungsgleichung herzustellen. Dies muss direkt im Elmer-Lösungsobjekt erfolgen. |
||
Registriere das Modul, in dem wir gerade unser neues Gleichungsobjekt ({{ |
Registriere das Modul, in dem wir gerade unser neues Gleichungsobjekt ({{Incode|flow.py}}) implementiert haben, mit dem Gleichungsspezifizierer aus Schritt 1 ("Flow") in der {{Incode|_EQUATIONS}} Liste in {{Incode|elmer/solver.py}}. |
||
{{Code|code= |
{{Code|code= |
||
Line 107: | Line 121: | ||
}} |
}} |
||
<span id="Extend_writer_object"></span> |
|||
== |
== Schreiber Objekt erweitern == |
||
In diesem Schritt werden wir die |
In diesem Schritt werden wir die folgende Datei modifizieren: |
||
* {{FileName|src/Mod/Fem/femsolver/elmer/writer.py}} |
* {{FileName|src/Mod/Fem/femsolver/elmer/writer.py}} |
||
Diese Datei enthält die Klasse {{Incode|Writer}}, die die Analyse in das Elmer-SIF Format exportiert. |
|||
Für jede unterstützte Gleichung gibt es |
Für jede unterstützte Gleichung gibt es zwei Methoden für den Export der jeweiligen Gleichung. Kopiere einfach alle von einer bestehenden Gleichung und passe sie an deine Bedürfnisse an. |
||
* {{Incode|_getFlowSolver}} |
* {{Incode|_getFlowSolver}} |
||
* {{Incode|_handleFlow}} |
* {{Incode|_handleFlow}} |
||
Du musst die {{incode|_handleFlow}}-Methode in der {{incode|Writer}}-Klasse registrieren: |
|||
{{Code|code= |
{{Code|code= |
||
Line 133: | Line 148: | ||
}} |
}} |
||
{{Incode|_handleFlow}} |
{{Incode|_handleFlow}} kann eine Reihe weiterer detaillierter Methoden kontrollieren. Unsere Fließ-Gleichung benutzt die folgenden detaillierten Methoden: |
||
* {{Incode|_handleFlowConstants}} |
* {{Incode|_handleFlowConstants}} |
||
Line 141: | Line 156: | ||
* {{Incode|_handleFlowEquation}} |
* {{Incode|_handleFlowEquation}} |
||
Nun haben wir den Funktionsteil der neuen Gleichung beendet. Nun werden wir die neue Gleichung an die GUI anbinden. |
|||
We now finished the function part of the new equation. Next we'll connect the new equation through the GUI. |
|||
<span id="Gui_tool_to_create_an_equation"></span> |
|||
== Gui tool to create an equation == |
|||
== GUI Werkzeug zum Erstellen einer Gleichung == |
|||
Wir haben gerade eine neue Gleichungsklasse erstellt. Um sie über die FEM-GUI anzusprechen, müssen wir eine Schaltfläche erstellen und sie mit der neuen Gleichungsklasse verbinden. Hier ist ein Tutorium: |
|||
We have just created a new equation class. To access it from the FEM GUI, we need to create a button and link it to the new equation class. Here is a tutorial: [[Add_button_to_FEM_toolbar_tutorial|Add button to FEM toolbar tutorial]]. |
|||
[[Add_Button_to_FEM_Toolbar_Tutorial/de|Tutorium Schaltfläche zur FEM Werkzeugleiste hinzufügen]]. |
|||
[[Category:FEM{{#translation:}}]] |
[[Category:FEM{{#translation:}}]] |
Latest revision as of 14:53, 7 May 2023
Tutorium |
Thema |
---|
FEM Gleichung hinzufügen |
Niveau |
Fortgeschritten |
Zeit zum Abschluss |
1 Tag |
Autoren |
JohnWang |
FreeCAD-Version |
0.19 |
Beispieldateien |
None |
Siehe auch |
None |
Einleitung
In dieser Anleitung werden wir FreeCAD die Gleichung Strömung (Flow) hinzufügen und die Unterstützung für den Löser Elmer implementieren. Bitte stelle sicher, dass du FEM-Modul erweitern gelesen und verstanden hast, bevor du diese Anleitung liest.
Die Aufgabe kann in fünf Teile aufgeteilt werden.
- Neuer Gleichungstyp. Dieser Schritt muss nur durchgeführt werden, wenn die Gleichung in FreeCAD bisher nicht existiert (im Gegensatz zu einer Gleichung, die bereits in FreeCAD existiert, aber vom Ziellöser nicht unterstützt wird).
- Neues Gleichungsobjekt. Hinzufügen eines konkreten Dokumentobjekts, das die Elmer-spezifische Gleichung repräsentiert.
- Löserobjekt erweitern. Dem Elmer-Löserobjekt Unterstützung für die neue Gleichung hinzufügen.
- Writer-Objekt erweitern. Erweitern des Elmer-Analyseexports zur Unterstützung des neuen Gleichungstyps.
- GUI-Werkzeug zum Erstellen einer Gleichung. Zugriff auf die neue Gleichungsfunktion über den GUI-Arbeitsbereich.
Neuer Gleichungstyp
In diesem Schritt werden wir die folgende Datei modifizieren:
- src/Mod/Fem/femsolver/equationbase.py
Der Gleichungstyp wird von allen Gleichungsobjekten der verschiedenen Löser gemeinsam verwendet. Jeder Typ hat einen Zeichenfolgenspezifizierer (z.B. "Heat") und einen zugeordneten Befehl, der die Gleichung dem ausgewählten Gleichungslöser hinzufügt. Dies ermöglicht eine einfachere GUI, bei der wir nur eine Schaltfläche für die Wärmegleichung haben, die für alle unterstützten Löser verwendet wird.
Füge zuerst die neue Gleichung zum equationbase.py
-Modul hinzu. Jede Gleichung erfordert zwei Klassen, ein Dokument-Proxy und ein Ansicht-Proxy. Diese zwei Klassen werden später als Basisklassen für die Elmer-spezifischen Gleichungsklassen benutzt. Kopiere sie einfach von einem existierenden Gleichungstyp und passe den Icon-Pfad in getIcon(self)
des Ansicht-Proxy an.
class FlowProxy(BaseProxy):
pass
class FlowViewProxy(BaseViewProxy):
def getIcon(self):
return ":/icons/FEM_EquationFlow.svg"
Neues Elmers Gleichungs Objekt
In diesem Schritt werden wir das Dokumentobjekt implementieren. Wir müssen eine neue Datei flow.py
hinzufügen unter:
- src/Mod/Fem/femsolver/elmer/equations/flow.py
und die folgenden Dateien ändern:
- src/Mod/Fem/ObjectsFem.py
- src/Mod/Fem/CMakeLists.txt
Beginnen wir dem Hinzufügen der neuen Datei flow.py
. Diese Datei kann aus einer bestehenden Gleichung kopiert werden.
Schlüsselwörter
- Falls die neue Gleichung nur Schlüsselworte für lineare Systeme unterstützt, kopiere das
femsolver/elmer/equations/elasticity.py
-Modul. - Falls die neue Gleichung Schlüsselworte für lineare und nicht-lineare Systeme unterstützt, kopiere das
femsolver/elmer/equations/heat.py
-Modul.
Die Strömungsgleichung ist eine potenziell nicht-lineare Gleichung. Das bedeutet, dass unsere Arbeit auf heat.py
basieren wird.
Dateien bearbeiten
Nach dem Kopieren von heat.py
nach flow.py
passe letztere Datei an folgenden Stellen an:
- das Namensargument der
create
-Modulfunktion, - die Basisklassen der
Proxy
-Klasse, - das
Type
-Attribut derProxy
-Klasse, - die
ViewProxy
-Klassen.
def create(doc, name="'''Flow'''"):
return femutils.createObject(
doc, name, Proxy, ViewProxy)
class Proxy(nonlinear.Proxy, equationbase.'''Flow'''Proxy):
Type = "Fem::EquationElmer'''Flow'''"
def __init__(self, obj):
super(Proxy, self).__init__(obj)
obj.Priority = 10
class ViewProxy(nonlinear.ViewProxy, equationbase.'''Flow'''ViewProxy):
pass
Dann musst du die über die obj.addProperty(..)
-Funktion hinzugefügten Eigenschaften auf die von der Gleichung benötigten anpassen.
Zum Zeitpunkt des Schreibens dieses Tutoriums hat die Elmer-Strömungsgleichung keine besonderen Eigenschaften. Siehe Elmer-Elastizitätsgleichung für ein Beispiel mit Eigenschaften.
Schließlich muss man eine makeEquationFlow-Definition in src/Mod/Fem/ObjectsFem.py
durch Duplizieren eines verfügbaren Eintrags registrieren.
FreeCAD benutzt make zur Erstellung des Programms. Deshalb müssen wir die neue Moduldatei (flow.py
) in src/Mod/Fem/CMakeLists.txt
registrieren, wie in FEM Modul erweitern beschriebenen. Die passenden Listen lassen sich leicht finden, indem man nach vorhandenen Gleichungsmoduldateien von Elmer sucht.
Löser Objekt erweitern
In diesem Schritt werden wir die folgenden Dateien modifizieren:
- src/Mod/Fem/femsolver/elmer/solver.py
Gerade jetzt haben wir FreeCAD darauf aufmerksam gemacht, dass es einen neuen Gleichungstyp gibt, und sogar einen Befehl hinzugefügt, der diese Gleichung dem ausgewählten Löserobjekt hinzufügt. Wir haben auch ein konkretes Gleichungsobjekt für Elmer implementiert. Was jetzt noch zu tun bleibt, ist die Verbindung zwischen Elmer und der Strömungsgleichung herzustellen. Dies muss direkt im Elmer-Lösungsobjekt erfolgen.
Registriere das Modul, in dem wir gerade unser neues Gleichungsobjekt (flow.py
) implementiert haben, mit dem Gleichungsspezifizierer aus Schritt 1 ("Flow") in der _EQUATIONS
Liste in elmer/solver.py
.
from .equations import electrostatic
+from .equations import flow
...
_EQUATIONS = {
"Heat": heat,
"Elasticity": elasticity,
+ "Flow": flow,
}
Schreiber Objekt erweitern
In diesem Schritt werden wir die folgende Datei modifizieren:
- src/Mod/Fem/femsolver/elmer/writer.py
Diese Datei enthält die Klasse Writer
, die die Analyse in das Elmer-SIF Format exportiert.
Für jede unterstützte Gleichung gibt es zwei Methoden für den Export der jeweiligen Gleichung. Kopiere einfach alle von einer bestehenden Gleichung und passe sie an deine Bedürfnisse an.
_getFlowSolver
_handleFlow
Du musst die _handleFlow
-Methode in der Writer
-Klasse registrieren:
class Writer(object):
...
def write(self):
...
self._handleFlow()
...
_handleFlow
kann eine Reihe weiterer detaillierter Methoden kontrollieren. Unsere Fließ-Gleichung benutzt die folgenden detaillierten Methoden:
_handleFlowConstants
_handleFlowMaterial
_handleFlowInitialVelocity
_handleFlowBndConditions
_handleFlowEquation
Nun haben wir den Funktionsteil der neuen Gleichung beendet. Nun werden wir die neue Gleichung an die GUI anbinden.
GUI Werkzeug zum Erstellen einer Gleichung
Wir haben gerade eine neue Gleichungsklasse erstellt. Um sie über die FEM-GUI anzusprechen, müssen wir eine Schaltfläche erstellen und sie mit der neuen Gleichungsklasse verbinden. Hier ist ein Tutorium: Tutorium Schaltfläche zur FEM Werkzeugleiste hinzufügen.