Add FEM Equation Tutorial/pl: Difference between revisions

From FreeCAD Documentation
(Created page with "=== Słowa kluczowe ===")
(Created page with "Właśnie utworzyliśmy klasę nowego równania. Aby mieć do niej dostęp z GUI środowiska pracy MES, musimy utworzyć przycisk i podłączyć go do klasy nowego równania. Tu znajduje się poradnik: Poradnik: Dodaj przycisk do paska narzędzi MES.")
 
(19 intermediate revisions by the same user not shown)
Line 58: Line 58:
=== Słowa kluczowe ===
=== Słowa kluczowe ===


* If the new equation only supports keywords for '''linear''' systems copy the {{Incode|femsolver/elmer/equations/elasticity.py}} module.
* Jeśli nowe równanie wspiera tylko słowa kluczowe dla układów liniowych ('''linear''') to skopiuj moduł {{Incode|femsolver/elmer/equations/elasticity.py}}.
* If the new equation supports keywords for both '''linear''' and '''non-linear''' systems, copy {{Incode|femsolver/elmer/equations/heat.py}}.
* Jeśli nowe równanie wspiera słowa kluczowe dla układów liniowych ('''linear''') i nieliniowych ('''non-linear''') to skopiuj {{Incode|femsolver/elmer/equations/heat.py}}.


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}}.
Równanie przepływu w Elmer jest potencjalnie nieliniowym równanie. Oznacza to, że oprzemy naszą pracę na {{Incode|heat.py}}.


<span id="Editing_files"></span>
=== Editing files ===
=== Edycja plików ===


After copying {{Incode|heat.py}} to {{Incode|flow.py}}, adjust {{Incode|flow.py}} in these locations:
Po skopiowaniu {{Incode|heat.py}} do {{Incode|flow.py}}, dostosuj {{Incode|flow.py}} w tych lokalizacjach:
* the name argument of the {{Incode|create}} module function,
* argument name (nazwa) funkcji modułu {{Incode|create}},
* the base classes of the {{Incode|Proxy}} class,
* klasy bazowe klasy {{Incode|Proxy}},
* the {{Incode|Type}} attribute of the {{Incode|Proxy}} class,
* cechę {{Incode|Type}} klasy {{Incode|Proxy}},
* the {{Incode|ViewProxy}} classes.
* klasy {{Incode|ViewProxy}}.


{{Code|code=
{{Code|code=
Line 88: Line 89:
}}
}}


Then you need to change the properties added via the {{Incode|obj.addProperty(..)}} function to those needed by the equation.
Następnie musisz zmienić właściwości dodane przez funkcję {{Incode|obj.addProperty(..)}} na te wymagane przez równanie.


W momencie pisania tego poradnika równanie przepływu solvera Elmer nie miało żadnych specjalnych właściwości. Zobacz równanie elastyczności solvera Elmer jeśli potrzebujesz przykładu z właściwościami.
At the moment of writing this tutorial Elmer flow equation doesn't have any special properties. See Elmer elasticity equation for an example with properties.


Finally one has to register a '''makeEquationFlow''' definition in {{Incode|src/Mod/Fem/ObjectsFem.py}} by duplicating an available entry.
Wreszcie, należy zarejestrować definicję '''makeEquationFlow''' w {{Incode|src/Mod/Fem/ObjectsFem.py}} poprzez zduplikowanie dostępnego wpisu.


FreeCAD uses '''make''' to build the program. So we need to register the new module file ({{Incode|flow.py}}) in {{Incode|src/Mod/Fem/CMakeLists.txt}} the way described in [https://www.freecadweb.org/wiki/Extend_FEM_Module Extend FEM Module]. The suitable lists can be easily found by searching for existing equation modules files of Elmer.
FreeCAD korzysta z '''make''' do budowania programu. Więc musimy zarejestrować plik nowego modułu ({{Incode|flow.py}}) w {{Incode|src/Mod/Fem/CMakeLists.txt}} w sposób opisany na stronie [https://www.freecadweb.org/wiki/Extend_FEM_Module/pl Rozszerzenie modułu MES]. Odpowiednie listy można łatwo znaleźć szukając plików modułów istniejących równań solvera Elmer.


<span id="Extend_Solver_Object"></span>
== Extend Solver Object ==
== Rozszerz obiekt solvera ==


W tym kroku zmodyfikujemy następujący plik:
In this step we are going to modify the following file:


* {{FileName|src/Mod/Fem/femsolver/elmer/solver.py}}
* {{FileName|src/Mod/Fem/femsolver/elmer/solver.py}}


Teraz sprawiliśmy, że FreeCAD rozpoznaje nowy typ równania a nawet dodaliśmy polecenie, które wstawia to równanie do obiektu wybranego solvera. Zaimplementowaliśmy też konkretny obiekt równania dla solvera Elmer. Pozostało utworzenie połączenia między solverem Elmer i równaniem przepływu. Należy to zrobić bezpośrednio w obiekcie solvera Elmer.
Right now we made FreeCAD aware that there is a new type of equation and even added a command that adds this equation to the selected solver object. We also implemented a concrete equation object for Elmer. Whats left to do now is to make the connection between Elmer and the flow equation. This must be done directly in Elmer solver object.


Register the module in which we just implemented our new equation object ({{Incode|flow.py}}) with the equation specifier from step 1 ("Flow") in the {{Incode|_EQUATIONS}} list in {{Incode|elmer/solver.py}}.
Zarejestruj moduł, w którym właśnie zaimplementowaliśmy obiekt naszego nowego równania ({{Incode|flow.py}}) z określnikiem równania z kroku 1 ("Flow") na liście {{Incode|_EQUATIONS}} w {{Incode|elmer/solver.py}}.


{{Code|code=
{{Code|code=
Line 119: Line 121:
}}
}}


<span id="Extend_writer_object"></span>
== Extend writer object ==
== Rozszerz obiekt zapisujący równania ==


W tym kroku zmodyfikujemy następujący plik:
In this step we are going to modify the following file:


* {{FileName|src/Mod/Fem/femsolver/elmer/writer.py}}
* {{FileName|src/Mod/Fem/femsolver/elmer/writer.py}}


This file contains the {{Incode|Writer}} class which exports the analysis into Elmer SIF format.
Ten plik zawiera klasę {{Incode|Writer}}, która eksportuje analizę do formatu SIF solvera Elmer.


Dla każdego wspieranego równania są dwie główne metody eksportu. Po prostu skopiuj je wszystkie z istniejącego równania i dostosuj je do swoich potrzeb.
For every supported equation there are two main methods handling the export of the respective equation. Just copy all of them from an existing equation and adjust them to your needs.


* {{Incode|_getFlowSolver}}
* {{Incode|_getFlowSolver}}
* {{Incode|_handleFlow}}
* {{Incode|_handleFlow}}


You need to register the {{Incode|_handleFlow}} method inside the {{Incode|Writer}} class:
Musisz zarejestrować metodę {{Incode|_handleFlow}} w klasie {{Incode|Writer}}:


{{Code|code=
{{Code|code=
Line 145: Line 148:
}}
}}


{{Incode|_handleFlow}} can control a series of other detailed methods. Our flow equation uses the following detailed methods:
{{Incode|_handleFlow}} może kontrolować serię innych złożonych metod. Nasze równanie przepływu korzysta z następujących złożonych metod:


* {{Incode|_handleFlowConstants}}
* {{Incode|_handleFlowConstants}}
Line 153: Line 156:
* {{Incode|_handleFlowEquation}}
* {{Incode|_handleFlowEquation}}


Zakończyliśmy teraz część funkcji nowego równania. Następnie połączymy nowe równanie poprzez GUI.
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 ==
== Narzędzie w GUI do tworzenia równania ==


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]].
Właśnie utworzyliśmy klasę nowego równania. Aby mieć do niej dostęp z GUI środowiska pracy MES, musimy utworzyć przycisk i podłączyć go do klasy nowego równania. Tu znajduje się poradnik: [[Add_Button_to_FEM_Toolbar_Tutorial/pl|Poradnik: Dodaj przycisk do paska narzędzi MES]].


[[Category:FEM{{#translation:}}]]
[[Category:FEM{{#translation:}}]]

Latest revision as of 16:59, 12 January 2024

Ćwiczenie
Temat
Dodawanie równań MES
Poziom trudności
Zaawansowany
Czas wykonania
1 dzień
Autorzy
JohnWang
Wersja FreeCAD
0.19
Pliki z przykładami
Nie dołączono
Zobacz również
-

Wprowadzenie

W tym poradniku dodamy równanie Flow (przepływu) do FreeCAD i zaimplementujemy wsparcie dla solvera Elmer. Upewnij się, że przeczytałeś i zrozumiałeś stronę Rozszerzenie modułu MES przed przejściem do tego poradnika.

Zadanie można podzielić na pięć części:

  • Nowy typ równania. Ten krok musi być wykonany tylko jeśli równanie nie istnieje jeszcze we FreeCAD (w przeciwieństwie do równania, które jest już we FreeCAD, ale nie jest wspierane przez docelowy solver).
  • Nowy obiekt równania. Dodawanie konkretnego obiektu dokumentu reprezentującego konkretne równanie solvera Elmer.
  • Rozszerz obiekt solvera. Dodawanie wsparcia dla nowego równania do obiektu solvera Elmer.
  • Rozszerz obiekt zapisujący równania. Rozszerzenie eksportu do solvera Elmer o wsparcie dla nowego typu równania.
  • Narzędzie w GUI do tworzenia równania. Dostęp do funkcji nowego równania z poziomu GUI środowiska pracy MES.

Nowy typ równania

W tym kroku zmodyfikujemy następujący plik:

  • src/Mod/Fem/femsolver/equationbase.py

Typ równania jest dzielony przez wszystkie obiekty równań różnych solverów. Każdy typ ma ciąg określający (np. "Heat" - ciepło) i dedykowane polecenie dodające równanie do wybranego solvera. To upraszcza GUI, ponieważ mamy tylko jeden przycisk dla równania ciepła, z którego korzystają wszystkie wspierane solvery.

Najpierw dodaj nowe równanie do modułu equationbase.py. Każde równanie wymaga dwóch klas. Proxy dokumentu i proxy widoku. Te dwie klasy będą później używane jako klasy bazowe dla konkretnych klas równania Elmer. Po prostu skopiuj i wklej je z istniejącego typu równania i dostosuj ścieżkę ikony w getIcon(self) proxy widoku.

class FlowProxy(BaseProxy):
    pass

class FlowViewProxy(BaseViewProxy):
    def getIcon(self):
        return ":/icons/FEM_EquationFlow.svg"

Nowy obiekt równania solvera Elmer

W tym kroku zaimplementujemy obiekt dokumentu. Musimy dodać nowy plik flow.py w:

  • src/Mod/Fem/femsolver/elmer/equations/flow.py

i zmodyfikować następujące pliki:

  • src/Mod/Fem/ObjectsFem.py
  • src/Mod/Fem/CMakeLists.txt

Zacznijmy od dodania nowego pliku flow.py. Ten plik można skopiować z istniejącego równania.

Słowa kluczowe

  • Jeśli nowe równanie wspiera tylko słowa kluczowe dla układów liniowych (linear) to skopiuj moduł femsolver/elmer/equations/elasticity.py.
  • Jeśli nowe równanie wspiera słowa kluczowe dla układów liniowych (linear) i nieliniowych (non-linear) to skopiuj femsolver/elmer/equations/heat.py.

Równanie przepływu w Elmer jest potencjalnie nieliniowym równanie. Oznacza to, że oprzemy naszą pracę na heat.py.

Edycja plików

Po skopiowaniu heat.py do flow.py, dostosuj flow.py w tych lokalizacjach:

  • argument name (nazwa) funkcji modułu create,
  • klasy bazowe klasy Proxy,
  • cechę Type klasy Proxy,
  • klasy ViewProxy.
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

Następnie musisz zmienić właściwości dodane przez funkcję obj.addProperty(..) na te wymagane przez równanie.

W momencie pisania tego poradnika równanie przepływu solvera Elmer nie miało żadnych specjalnych właściwości. Zobacz równanie elastyczności solvera Elmer jeśli potrzebujesz przykładu z właściwościami.

Wreszcie, należy zarejestrować definicję makeEquationFlow w src/Mod/Fem/ObjectsFem.py poprzez zduplikowanie dostępnego wpisu.

FreeCAD korzysta z make do budowania programu. Więc musimy zarejestrować plik nowego modułu (flow.py) w src/Mod/Fem/CMakeLists.txt w sposób opisany na stronie Rozszerzenie modułu MES. Odpowiednie listy można łatwo znaleźć szukając plików modułów istniejących równań solvera Elmer.

Rozszerz obiekt solvera

W tym kroku zmodyfikujemy następujący plik:

  • src/Mod/Fem/femsolver/elmer/solver.py

Teraz sprawiliśmy, że FreeCAD rozpoznaje nowy typ równania a nawet dodaliśmy polecenie, które wstawia to równanie do obiektu wybranego solvera. Zaimplementowaliśmy też konkretny obiekt równania dla solvera Elmer. Pozostało utworzenie połączenia między solverem Elmer i równaniem przepływu. Należy to zrobić bezpośrednio w obiekcie solvera Elmer.

Zarejestruj moduł, w którym właśnie zaimplementowaliśmy obiekt naszego nowego równania (flow.py) z określnikiem równania z kroku 1 ("Flow") na liście _EQUATIONS w elmer/solver.py.

from .equations import electrostatic
+from .equations import flow

...

_EQUATIONS = {
    "Heat": heat,
    "Elasticity": elasticity,
+    "Flow": flow,
}

Rozszerz obiekt zapisujący równania

W tym kroku zmodyfikujemy następujący plik:

  • src/Mod/Fem/femsolver/elmer/writer.py

Ten plik zawiera klasę Writer, która eksportuje analizę do formatu SIF solvera Elmer.

Dla każdego wspieranego równania są dwie główne metody eksportu. Po prostu skopiuj je wszystkie z istniejącego równania i dostosuj je do swoich potrzeb.

  • _getFlowSolver
  • _handleFlow

Musisz zarejestrować metodę _handleFlow w klasie Writer:

class Writer(object):
...
    def write(self):
...
        self._handleFlow()

...

_handleFlow może kontrolować serię innych złożonych metod. Nasze równanie przepływu korzysta z następujących złożonych metod:

  • _handleFlowConstants
  • _handleFlowMaterial
  • _handleFlowInitialVelocity
  • _handleFlowBndConditions
  • _handleFlowEquation

Zakończyliśmy teraz część funkcji nowego równania. Następnie połączymy nowe równanie poprzez GUI.

Narzędzie w GUI do tworzenia równania

Właśnie utworzyliśmy klasę nowego równania. Aby mieć do niej dostęp z GUI środowiska pracy MES, musimy utworzyć przycisk i podłączyć go do klasy nowego równania. Tu znajduje się poradnik: Poradnik: Dodaj przycisk do paska narzędzi MES.