Extend FEM Module/pl: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Created page with "Dodawanie nowych wiązań jest dość proste. Dla początkujących dostępny jest poradnik: Poradnik: Dodawanie wiązań w środowisku MES")
 
(23 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>


{{TutorialInfo
{{TutorialInfo/pl
|Topic=FEM
|Topic=MES
|Level=Intermediate
|Level=Średnio zaawansowany
|Time=1 hour
|Time=1 godzina
|Author=[[User:M42kus|M42kus]]
|Author=[[User:M42kus|M42kus]]
|FCVersion=0.17
|FCVersion=0.17
}}
}}


Środowisko pracy MES obsługuje już wiele różnych wiązań i kilka solwerów. Mimo to użytkownicy często potrzebują więzów, które nie są jeszcze obsługiwane przez FreeCAD. Ta strona jest punktem wyjścia do serii samouczków i innych zasobów opisujących, jak rozszerzyć środowisko pracy MES przy użyciu istniejącej struktury. Chociaż ta seria może okazać się pomocna również dla programistów, ideą jest umożliwienie użytkownikom MES, którzy interesują się kodowaniem w Pythonie, możliwości samodzielnego dodawania potrzebnych rzeczy.
The FEM workbench already supports a lot of different constraints and several solvers. Despite that users often need constraints not yet 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.


Dodawanie nowych wiązań, równań lub solwerów to w większości rutynowa praca. Ale zrobienie tego po raz pierwszy nie będzie tak łatwe, jak mogłoby się wydawać. Zrozumienie poniższych tematów okaże się pomocne:
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.
* Tworzenie skryptów w języku Python we FreeCAD.
** [[Python_scripting_tutorial|FreeCAD Scripting Tutorial]]
** [[Python_scripting_tutorial/pl|Poradnik: Tworzenie skryptów Python]]
** [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]]
** [[FreeCAD_Scripting_Basics/pl|Podstawy tworzenia skryptów FreeCAD]]
* Extending FreeCAD with Python.
* Rozszerzanie FreeCAD za pomocą Python.
** [[Scripted_objects|Scripted Objects]]
** [[Scripted_objects/pl|Obiekty tworzone skryptami]]
* A solid understanding of the solver for which new objects shall be added (e.g. CalculiX or Elmer) is important.
* Ważne jest gruntowne zrozumienie solwera, dla którego będą dodawane nowe obiekty ''(np. CalculiX lub Elmer)''.
* A little knowledge about build systems, especially cmake (build system used by FreeCAD).
* Niewielka wiedza na temat systemów kompilacji, zwłaszcza {{incode|cmake}} ''(system kompilacji używany przez FreeCAD)''.


<span id="Build_System_(cmake)"></span>
== Build System (cmake) ==
==System kompilacji ''(cmake)''==


System kompilacji musi zostać zmodyfikowany niezależnie od tego, które obiekty zostaną dodane do środowiska pracy MES. Każdy moduł (plik) Python musi zostać zarejestrowany. Środowisko pracy FEM wymaga zarejestrowania każdego nowego modułu Python w {{incode|Mod/Fem/CMakeLists.txt}}. Jest to niezależne od typu modułu Python ''(GUI lub non-GUI)''. To, gdzie dokładnie moduł musi zostać wstawiony, zależy od jego roli. Solwer, równania i ograniczenia używają różnych list. Wyszukiwanie podobnych plików i wstawianie nowego pliku do tej samej listy działa przez większość czasu.
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 requires every new python module to be registered in {{incode|Mod/Fem/CMakeLists.txt}}. 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 {{incode|pressure}} which is related to the '''flow equation'''. So, '''FlowPressure''' will widely used as <name> for this constraint. A new constraint requires at least the following new modules:
Jako ''przykład'' dodajmy nowe wiązanie o nazwie {{incode|pressure}}, które jest związane z ''równaniem przepływu''. Tak więc, '''FlowPressure''' będzie powszechnie używane jako <nazwa> dla tego wiązania. Nowe ograniczenie wymaga co najmniej następujących nowych modułów:
* {{incode|constraint_<name>.py}}
* {{incode|constraint_<name>.py}}
* {{incode|view_constraint_<name>.py}}
* {{incode|view_constraint_<name>.py}}
* {{incode|CommandFemConstraint<name>.py}} (may be unnecessary)
* {{incode|CommandFemConstraint<name>.py}} (może być niepotrzebny)
These three files must be added to {{incode|Mod/Fem/CMakeLists.txt}} as well as {{incode|Mod/Fem/App/CMakeLists.txt}}. All inserted lines of code are indicated by a starting '''+'''.
Te trzy pliki muszą zostać dodane do {{incode|Mod/Fem/CMakeLists.txt}}, a także {{incode|Mod/Fem/App/CMakeLists.txt}}. Wszystkie dodane linie kodu oznaczone znakiem ''+'' na początku.


{{FileName|Mod/Fem/CMakeLists.txt}}
{{FileName|Mod/Fem/CMakeLists.txt}}
Line 62: Line 63:
}}
}}


<span id="Source_Organization"></span>
== Source Organization ==
==Organizacja źródła==


Do organizacji kodu Python moduł MES wykorzystuje następujące podejście. Moduł jest podzielony na następujące pakiety:
For organizing the python code the FEM module uses the following approach. The module is split into the following packages:
* {{incode|femobjects}}, który zawiera wszystkie obiekty niezwiązane z GUI, takie jak proxy Python dla obiektów dokumentów, * {{incode|femviewproviders}}, który zawiera wszystkie obiekty związane z GUI, takie jak proxy Python dla obiektów dokumentów.
* {{incode|femobjects}}, which contains all non-GUI like python proxies for document objects and
* {{incode|femviewproviders}} containing everything GUI related like python proxies for view provider
* {{incode|femviewproviders}} zawierający wszystko, co związane z GUI, takie jak pythonowe proxy dla dostawców widoków.
* C++ based task panels are stored in '{{incode|Gui}}',
* Panele zadań oparte na C++ przechowywane w '{{incode|Gui}}',
* icons can be found in '{{incode|Gui/Resources/icons/}}',
* ikony można znaleźć w '{{incode|Gui/Resources/icons/}}',
* .ui files are stored in '{{incode|Gui/Resources/ui/}}' commands.
* pliki .ui przechowywane w poleceniach '{{incode|Gui/Resources/ui/}}'.


One package doesn't follow this pattern: {{incode|femsolver}}. It has its place on the same level as {{incode|femobjects}} and {{incode|femguiobjects}} ({{incode|src/Mod/Fem/femsolver}}). The package contains solver and equation related packages and modules and it is organized the following way:
Jeden pakiet nie jest zgodny z tym wzorcem: {{incode|femsolver}}. Ma on swoje miejsce na tym samym poziomie co {{incode|femobjects}} i {{incode|femguiobjects}} ({{incode|src/Mod/Fem/femsolver}}). Pakiet zawiera pakiety i moduły związane z solwerem i równaniami i jest zorganizowany w następujący sposób:


<pre>
<pre>
Line 83: Line 85:
</pre>
</pre>


== Solver ==
<span id="Solver"></span>
==Solwer==


In FreeCAD a solver can be split into two parts:
W FreeCAD solwer można podzielić na dwie części:
* Jedna to obiekt dokumentu używany przez użytkownika do interakcji z solwerem. Chociaż można ustawić parametr solwera i jest on również używany do kontrolowania procesu rozwiązywania.
* 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.
* Druga część to tak zwane zadania solwera. Proces rozwiązywania jest podzielony na te zadania, a mianowicie: ''sprawdź, przygotuj, rozwiąż i wyniki''. Zadania te wykonują rzeczywistą pracę polegającą na wyeksportowaniu analizy do formatu rozumianego przez plik wykonywalny solwera, uruchomieniu pliku wykonywalnego i załadowaniu wyników z powrotem do FreeCAD.
* 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 {{incode|femsolver}} package (e.g. for Elmer its in {{incode|femsolver/elmer}}). 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.
Większość plików związanych z solwerem znajduje się w pakiecie podrzędnym pakietu {{incode|femsolver}} ''(np. dla Elmera w {{incode|femsolver/elmer}})''. Poniższa lista wylicza wszystkie pliki związane z implementacją solwera. to pliki, które należy skopiować i zmodyfikować, aby dodać obsługę nowego solwera do FreeCAD. Podany przykład pochodzi z implementacji solwera Elmer.


* '''femsolver/elmer/solver.py:''' Document object visible in the tree-view. Implemented in python via a document proxy and view proxy.
* '''femsolver/elmer/solver.py:''' Obiekt dokumentu widoczny w widoku drzewa. Zaimplementowane w Pythonie poprzez proxy dokumentu i proxy widoku.
* '''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.
* '''femsolver/elmer/tasks.py:''' Moduł zawierający jedną klasę zadań dla każdego zadania wymaganego dla implementacji solwera. Zadania te dzielą proces rozwiązywania analizy na następujące kroki: sprawdzenie, przygotowanie, rozwiązanie, wyniki.
* '''femcommands/commands.py:''' Adds the solver document object to the active document. Required to access the solver object from the GUI.
* '''femcommands/commands.py:''' Dodaje obiekt dokumentu solwera do aktywnego dokumentu. Wymagane, aby uzyskać dostęp do obiektu solwera z GUI.


<span id="Equations"></span>
There is a tutorial of adding a new solver: [[Sandbox:Add_FEM_Solver_Tutorial|Add FEM Solver Tutorial]]
==Równania==


Równanie reprezentuje określoną fizykę, która powinna być brana pod uwagę podczas rozwiązywania analizy ''(np. Przepływ, Ciepło)''. Nie wszystkie solwery w FreeCAD obsługują ''(wszystkie)'' równania. Równania są reprezentowane przez obiekty podrzędne odpowiedniego obiektu solwera. W widoku drzewa wygląda to następująco:
== 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
* elmer-solver
** elastyczność
** elasticity
** heat
** ciepło
** flow
** przepływ
** elektrostatyka
** electrostatics


Większość opcji specyficznych dla solwera ''(np. maksymalna liczba iteracji, metoda rozwiązywania itp.)'' jest ustawiana za pomocą obiektów równań. Jedną z konsekwencji tego jest to, że każdy solwer musi mieć własną implementację &quot;tego samego&quot; równania. CalculiX miałby inny obiekt Heat niż Elmer. Aby uniknąć posiadania wielu przycisków dla tej samej fizyki w GUI, każdy obiekt solwera sam dodaje swoje równania.
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 {{incode|femsolver.equationbase}} module. The solver specific part resides inside individual Equations sub-packages of the solver packages (e.g. {{incode|femsolver/elmer/equations}}).
Rzeczywistą implementację można podzielić na część ogólną i część specyficzną dla solwera. Część ogólna znajduje się w module {{incode|femsolver.equationbase}}. Część specyficzna dla solwera znajduje się w poszczególnych pakietach Equations pakietów solwera ''(np. {{incode|femsolver/elmer/equations}})''.


Dodanie nowych równań do Elmera powinno być bardzo proste. Dla początkujących istnieje poradnik, który pokazuje, jak dodać nowe równanie do Elmera poprzez dodanie istniejącego solwera sprężystości do FreeCAD: [[Add_FEM_Equation_Tutorial/pl|Poradnik: Dodawanie równań w środowisku MES]].
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|Add FEM Equation Tutorial]].


== Constraints ==
<span id="Constraints"></span>
==Wiązania==


Wiązania definiują warunki brzegowe dla problemu, który ma zostać rozwiązany. W FreeCAD wiązania nie są specyficzne dla konkretnego solwera. Konfiguracja problemu może być rozwiązana przez wszystkie solwery, które obsługują wszystkie warunki w analizie.
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|Add FEM Constraint Tutorial]].
Dodawanie nowych wiązań jest dość proste. Dla początkujących dostępny jest poradnik: [[Add_FEM_Constraint_Tutorial/pl|Poradnik: Dodawanie wiązań w środowisku MES]]





Latest revision as of 09:28, 5 November 2023

Ćwiczenie
Temat
MES
Poziom trudności
Średnio zaawansowany
Czas wykonania
1 godzina
Autorzy
M42kus
Wersja FreeCAD
0.17
Pliki z przykładami
Nie dołączono
Zobacz również
-

Środowisko pracy MES obsługuje już wiele różnych wiązań i kilka solwerów. Mimo to użytkownicy często potrzebują więzów, które nie są jeszcze obsługiwane przez FreeCAD. Ta strona jest punktem wyjścia do serii samouczków i innych zasobów opisujących, jak rozszerzyć środowisko pracy MES przy użyciu istniejącej struktury. Chociaż ta seria może okazać się pomocna również dla programistów, ideą jest umożliwienie użytkownikom MES, którzy interesują się kodowaniem w Pythonie, możliwości samodzielnego dodawania potrzebnych rzeczy.

Dodawanie nowych wiązań, równań lub solwerów to w większości rutynowa praca. Ale zrobienie tego po raz pierwszy nie będzie tak łatwe, jak mogłoby się wydawać. Zrozumienie poniższych tematów okaże się pomocne:

System kompilacji (cmake)

System kompilacji musi zostać zmodyfikowany niezależnie od tego, które obiekty zostaną dodane do środowiska pracy MES. Każdy moduł (plik) Python musi zostać zarejestrowany. Środowisko pracy FEM wymaga zarejestrowania każdego nowego modułu Python w Mod/Fem/CMakeLists.txt. Jest to niezależne od typu modułu Python (GUI lub non-GUI). To, gdzie dokładnie moduł musi zostać wstawiony, zależy od jego roli. Solwer, równania i ograniczenia używają różnych list. Wyszukiwanie podobnych plików i wstawianie nowego pliku do tej samej listy działa przez większość czasu.

Jako przykład dodajmy nowe wiązanie o nazwie pressure, które jest związane z równaniem przepływu. Tak więc, FlowPressure będzie powszechnie używane jako <nazwa> dla tego wiązania. Nowe ograniczenie wymaga co najmniej następujących nowych modułów:

  • constraint_<name>.py
  • view_constraint_<name>.py
  • CommandFemConstraint<name>.py (może być niepotrzebny)

Te trzy pliki muszą zostać dodane do Mod/Fem/CMakeLists.txt, a także Mod/Fem/App/CMakeLists.txt. Wszystkie dodane linie kodu są oznaczone znakiem + na początku.

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
)

Organizacja źródła

Do organizacji kodu Python moduł MES wykorzystuje następujące podejście. Moduł jest podzielony na następujące pakiety:

  • femobjects, który zawiera wszystkie obiekty niezwiązane z GUI, takie jak proxy Python dla obiektów dokumentów, * femviewproviders, który zawiera wszystkie obiekty związane z GUI, takie jak proxy Python dla obiektów dokumentów.
  • femviewproviders zawierający wszystko, co związane z GUI, takie jak pythonowe proxy dla dostawców widoków.
  • Panele zadań oparte na C++ są przechowywane w 'Gui',
  • ikony można znaleźć w 'Gui/Resources/icons/',
  • pliki .ui są przechowywane w poleceniach 'Gui/Resources/ui/'.

Jeden pakiet nie jest zgodny z tym wzorcem: femsolver. Ma on swoje miejsce na tym samym poziomie co femobjects i femguiobjects (src/Mod/Fem/femsolver). Pakiet zawiera pakiety i moduły związane z solwerem i równaniami i jest zorganizowany w następujący sposób:

.femsolver
.femsolver.elmer
.femsolver.elmer.equations
.femsolver.calculix
.femsolver.calculix.equations
.femsolver.z88
.femsolver.z88.equations

Solwer

W FreeCAD solwer można podzielić na dwie części:

  • Jedna to obiekt dokumentu używany przez użytkownika do interakcji z solwerem. Chociaż można ustawić parametr solwera i jest on również używany do kontrolowania procesu rozwiązywania.
  • Druga część to tak zwane zadania solwera. Proces rozwiązywania jest podzielony na te zadania, a mianowicie: sprawdź, przygotuj, rozwiąż i wyniki. Zadania te wykonują rzeczywistą pracę polegającą na wyeksportowaniu analizy do formatu rozumianego przez plik wykonywalny solwera, uruchomieniu pliku wykonywalnego i załadowaniu wyników z powrotem do FreeCAD.

Większość plików związanych z solwerem znajduje się w pakiecie podrzędnym pakietu femsolver (np. dla Elmera w femsolver/elmer). Poniższa lista wylicza wszystkie pliki związane z implementacją solwera. Są to pliki, które należy skopiować i zmodyfikować, aby dodać obsługę nowego solwera do FreeCAD. Podany przykład pochodzi z implementacji solwera Elmer.

  • femsolver/elmer/solver.py: Obiekt dokumentu widoczny w widoku drzewa. Zaimplementowane w Pythonie poprzez proxy dokumentu i proxy widoku.
  • femsolver/elmer/tasks.py: Moduł zawierający jedną klasę zadań dla każdego zadania wymaganego dla implementacji solwera. Zadania te dzielą proces rozwiązywania analizy na następujące kroki: sprawdzenie, przygotowanie, rozwiązanie, wyniki.
  • femcommands/commands.py: Dodaje obiekt dokumentu solwera do aktywnego dokumentu. Wymagane, aby uzyskać dostęp do obiektu solwera z GUI.

Równania

Równanie reprezentuje określoną fizykę, która powinna być brana pod uwagę podczas rozwiązywania analizy (np. Przepływ, Ciepło). Nie wszystkie solwery w FreeCAD obsługują (wszystkie) równania. Równania są reprezentowane przez obiekty podrzędne odpowiedniego obiektu solwera. W widoku drzewa wygląda to następująco:

  • elmer-solver
    • elastyczność
    • ciepło
    • przepływ
    • elektrostatyka

Większość opcji specyficznych dla solwera (np. maksymalna liczba iteracji, metoda rozwiązywania itp.) jest ustawiana za pomocą obiektów równań. Jedną z konsekwencji tego jest to, że każdy solwer musi mieć własną implementację "tego samego" równania. CalculiX miałby inny obiekt Heat niż Elmer. Aby uniknąć posiadania wielu przycisków dla tej samej fizyki w GUI, każdy obiekt solwera sam dodaje swoje równania.

Rzeczywistą implementację można podzielić na część ogólną i część specyficzną dla solwera. Część ogólna znajduje się w module femsolver.equationbase. Część specyficzna dla solwera znajduje się w poszczególnych pakietach Equations pakietów solwera (np. femsolver/elmer/equations).

Dodanie nowych równań do Elmera powinno być bardzo proste. Dla początkujących istnieje poradnik, który pokazuje, jak dodać nowe równanie do Elmera poprzez dodanie istniejącego solwera sprężystości do FreeCAD: Poradnik: Dodawanie równań w środowisku MES.

Wiązania

Wiązania definiują warunki brzegowe dla problemu, który ma zostać rozwiązany. W FreeCAD wiązania nie są specyficzne dla konkretnego solwera. Konfiguracja problemu może być rozwiązana przez wszystkie solwery, które obsługują wszystkie warunki w analizie.

Dodawanie nowych wiązań jest dość proste. Dla początkujących dostępny jest poradnik: Poradnik: Dodawanie wiązań w środowisku MES