FEM Preferences: Difference between revisions

From FreeCAD Documentation
(document new options)
(V1.0 -> V0.21)
 
(13 intermediate revisions by 2 users not shown)
Line 12: Line 12:
* [[Image:FEM_SolverCalculixCxxtools.svg|32px]] [[FEM_SolverCalculixCxxtools|CalculiX]]
* [[Image:FEM_SolverCalculixCxxtools.svg|32px]] [[FEM_SolverCalculixCxxtools|CalculiX]]
* [[Image:FEM_SolverElmer.svg|32px]] [[FEM_SolverElmer|Elmer]]
* [[Image:FEM_SolverElmer.svg|32px]] [[FEM_SolverElmer|Elmer]]
* [[Image:FEM_SolverMystran.svg|32px]] [[FEM_SolverMystran|Mystran]] {{Version|0.20}}
* [[Image:FEM_SolverMystran.svg|32px]] [[FEM_SolverMystran|Mystran]] ({{Version|0.20}})
* [[Image:FEM_SolverZ88.svg|32px]] [[FEM_SolverZ88|Z88]]
* [[Image:FEM_SolverZ88.svg|32px]] [[FEM_SolverZ88|Z88]]


Line 19: Line 19:
<!--T:16-->
<!--T:16-->
On the ''General'' tab you can specify the following:
On the ''General'' tab you can specify the following:

<!--T:33-->
{| class="wikitable float-right mw-collapsible mw-uncollapsed"
!style="width: 33%;"|Name
!style="width: 66%;"|Description
|-
| {{MenuCommand|Working directory}}
| In what directory the mesh and solver files should be stored
|-
| {{MenuCommand|Create mesh groups}}
| If there are several meshes they will be grouped
|-
| {{MenuCommand|Keep results on calculation re-run}}
| Existing [[FEM_ResultShow|Result objects]] will be kept, otherwise overwritten by a new solver run
|-
| {{MenuCommand|Restore result dialog settings}}
| If checked, the [[FEM_ResultShow|Show result]] dialog is opened with the last used dialog settings
|-
| {{MenuCommand|Hide constraints when open result dialog}}
| The constraints will be hidden in the model view when the [[FEM_ResultShow|Show result]] dialog is opened
|-
| {{MenuCommand|Default solver}}
| Default solver to be added when adding an [[FEM_Analysis|Analysis container]]. ({{Version|0.21}})
|}


</translate>
</translate>
Line 35: Line 59:
|-
|-
| {{MenuCommand|Search in known binary directories}}
| {{MenuCommand|Search in known binary directories}}
| If checked, FreeCAD will look for the binary of [[FEM_MeshGmshFromShape|Gmsh]] in known (usual) directories
| If checked, FreeCAD will look for the binary of [[FEM_MeshGmshFromShape|Gmsh]] in known (usual) directories
|-
|-
| {{MenuCommand|Gmsh binary path}}
| {{MenuCommand|Gmsh binary path}}
| The path to the the binary of [[FEM_MeshGmshFromShape|Gmsh]]
| The path to the the binary of [[FEM_MeshGmshFromShape|Gmsh]]
|}
|}


Line 65: Line 89:
|-
|-
| {{MenuCommand|ElmerGrid: Search in known binary directories}}
| {{MenuCommand|ElmerGrid: Search in known binary directories}}
| If checked, FreeCAD will look for the binary of the grid writer utility of the [[FEM_SolverElmer|Elmer]] in known (usual) directories
| If checked, FreeCAD will look for the binary of the grid writer utility of the [[FEM_SolverElmer|Elmer]] in known (usual) directories
|-
|-
| {{MenuCommand|ElmerGrid binary path}}
| {{MenuCommand|ElmerGrid binary path}}
| The path to the the binary of the grid writer utility of the [[FEM_SolverElmer|Elmer]]
| The path to the the binary of the grid writer utility of the [[FEM_SolverElmer|Elmer]]
|-
|-
| {{MenuCommand|ElmerSolver: Search in known binary directories}}
| {{MenuCommand|ElmerSolver: Search in known binary directories}}
Line 74: Line 98:
|-
|-
| {{MenuCommand|ElmerSolver binary path}}
| {{MenuCommand|ElmerSolver binary path}}
| The path to the the solver binary of [[FEM_SolverElmer|Elmer]]
| The path to the the solver binary of [[FEM_SolverElmer|Elmer]]
|-
|-
| {{MenuCommand|CPU cores to be used}}
| {{MenuCommand|CPU cores to be used}}
| The number of CPU cores that will be used to perform the solving.
| The number of CPU cores that will be used to perform the solving.
'''Important:''' Elmer divides the mesh to portions equal to the number of used CPU cores. This can result in side-effects:
'''Important:''' Elmer divides the mesh into portions. The number of portions is equal to the number of CPU cores used. This can result in side-effects:
* depending on your mesh a smaller number of CPU cores can run faster than using more cores
* Depending on your mesh a smaller number of CPU cores can run faster than using more cores.
* in some cases using e.g 12 cored does not converge while 8 cores will work fine. The reason is that at some point the mesh portions become too small.
* In some cases using e.g. 12 cores does not converge while 8 cores will work fine. The reason is that at some point the mesh portions become too small.
So in the end it is often necessary to adjust the number of cores, depending on the mesh.
So it is often necessary to adjust the number of cores, depending on the mesh.


<!--T:32-->
'''Known limitation:''' For some simulation types you first need to install modules to Elmer to enable multi-threading. Check the Elmer report for info about this. A typical case is that for direct solving one has to install the MUMPS module.
'''Known limitation:''' For some simulation types you first need to install Elmer modules to enable multi-threading. Check the Elmer report for info about this. A typical case is that for direct solving one has to install the MUMPS module.
|-
|-
| {{MenuCommand|Filter results}}
| {{MenuCommand|Filter results}}
| The mesh volume regions processed by each CPU core will be merged to make the volume boundaries invisible.
| The mesh volume regions processed by each CPU core will be merged to make the volume boundaries invisible.
|}
|}


Line 107: Line 132:
|-
|-
| {{MenuCommand|Mystran binary path}}
| {{MenuCommand|Mystran binary path}}
| The path to the the binary of the [[FEM_SolverMystran|Mystran]]
| The path to the the binary of the [[FEM_SolverMystran|Mystran]]
|}
|}


Line 125: Line 150:
|-
|-
| {{MenuCommand|Search in known binary directories}}
| {{MenuCommand|Search in known binary directories}}
| If checked, FreeCAD will look for the binary named ''z88r'' of the [[FEM_SolverZ88|Z88 solver]] in known (usual) directories
| If checked, FreeCAD will look for the binary named ''z88r'' of the [[FEM_SolverZ88|Z88 solver]] in known (usual) directories
|-
|-
| {{MenuCommand|z88r binary path}}
| {{MenuCommand|z88r binary path}}
| The path to the the binary named ''z88r'' of the [[FEM_SolverZ88|Z88 solver]]
| The path to the the binary named ''z88r'' of the [[FEM_SolverZ88|Z88 solver]]
|-
|-
| {{MenuCommand|Solver method}}
| {{MenuCommand|Solver method}}
| The solver method used by the [[FEM_SolverZ88|Z88 solver]] for new simulations.
| The solver method used by the [[FEM_SolverZ88|Z88 solver]] for new simulations.
|-
|-
| {{MenuCommand|Max places in stiffness matrix}}
| {{MenuCommand|Max places in stiffness matrix}}
| This is relevant when the solver method ''Simple Cholesky'' is used. After starting the solver, it might tell you that you need to increase the ''MAXGS'' value. In this case increase the max places and re-run the solver.
| This is relevant when the solver method ''Simple Cholesky'' is used. After starting the solver, it might tell you that you need to increase the ''MAXGS'' value. In this case increase the max places and re-run the solver.
|-
|-
| {{MenuCommand|Max places in coincidence vector}}
| {{MenuCommand|Max places in coincidence vector}}
| This is relevant when one of the iterative solver methods is used. After starting the solver, it might tell you that you need to increase the ''MAXKOI'' value. In this case increase the max places and re-run the solver.
| This is relevant when one of the iterative solver methods is used. After starting the solver, it might tell you that you need to increase the ''MAXKOI'' value. In this case increase the max places and re-run the solver.
|}
|}


Line 158: Line 183:
|-
|-
| {{MenuCommand|Use materials from Materials directory in user's FreeCAD preference directory}}
| {{MenuCommand|Use materials from Materials directory in user's FreeCAD preference directory}}
| The cards from FreeCAD's preferences directory will be listed as available. On Windows, that would for example be this folder:
| The cards from FreeCAD's preferences directory will be listed as available. On Windows, that would for example be this folder:
''C:\Users\<username>\AppData\Roaming\FreeCAD\Material''
''C:\Users\<username>\AppData\Roaming\FreeCAD\Material''
|-
|-
| {{MenuCommand|Use materials from user defined directory}}
| {{MenuCommand|Use materials from user defined directory}}
| Also material cards also from the specified directory will be listed as available.
| Also material cards also from the specified directory will be listed as available.
|-
|-
| {{MenuCommand|Delete card duplicates}}
| {{MenuCommand|Delete card duplicates}}
| Duplicate cards will be deleted from the displayed material card list.
| Duplicate cards will be deleted from the displayed material card list.
|-
|-
| {{MenuCommand|Sort by resources}}
| {{MenuCommand|Sort by resources}}
| Material cards will appear sorted by their resources (locations). If unchecked, they will be sorted by their name.
| Material cards will appear sorted by their resources (locations). If unchecked, they will be sorted by their name.
|}
|}



Latest revision as of 20:18, 29 April 2023

The preferences screen of the FEM Workbench are found in the Preferences Editor, Edit → Preferences → FEM.

There are several tabs in the FEM workbench preferences, starting with the General configuration of the workbench. The rest of the tabs control how FEM interacts with supported external solvers.

The current supported external solvers are:

General

On the General tab you can specify the following:

Name Description
Working directory In what directory the mesh and solver files should be stored
Create mesh groups If there are several meshes they will be grouped
Keep results on calculation re-run Existing Result objects will be kept, otherwise overwritten by a new solver run
Restore result dialog settings If checked, the Show result dialog is opened with the last used dialog settings
Hide constraints when open result dialog The constraints will be hidden in the model view when the Show result dialog is opened
Default solver Default solver to be added when adding an Analysis container. (introduced in version 0.21)

Gmsh

On the Gmsh tab you can specify the following:

Name Description
Search in known binary directories If checked, FreeCAD will look for the binary of Gmsh in known (usual) directories
Gmsh binary path The path to the the binary of Gmsh

CalculiX

On the CalculiX tab you can specify the following:

Elmer

On the Elmer tab you can specify the following:

Name Description
ElmerGrid: Search in known binary directories If checked, FreeCAD will look for the binary of the grid writer utility of the Elmer in known (usual) directories
ElmerGrid binary path The path to the the binary of the grid writer utility of the Elmer
ElmerSolver: Search in known binary directories If checked, FreeCAD will look for the solver binary of Elmer in known (usual) directories
ElmerSolver binary path The path to the the solver binary of Elmer
CPU cores to be used The number of CPU cores that will be used to perform the solving.

Important: Elmer divides the mesh into portions. The number of portions is equal to the number of CPU cores used. This can result in side-effects:

  • Depending on your mesh a smaller number of CPU cores can run faster than using more cores.
  • In some cases using e.g. 12 cores does not converge while 8 cores will work fine. The reason is that at some point the mesh portions become too small.

So it is often necessary to adjust the number of cores, depending on the mesh.

Known limitation: For some simulation types you first need to install Elmer modules to enable multi-threading. Check the Elmer report for info about this. A typical case is that for direct solving one has to install the MUMPS module.

Filter results The mesh volume regions processed by each CPU core will be merged to make the volume boundaries invisible.

Mystran

On the Mystran tab you can specify the following:

Name Description
Search in known binary directories If checked, FreeCAD will look for the binary of the Mystran in known (usual) directories
Mystran binary path The path to the the binary of the Mystran

Z88

On the Z88 tab you can specify the following:

Name Description
Search in known binary directories If checked, FreeCAD will look for the binary named z88r of the Z88 solver in known (usual) directories
z88r binary path The path to the the binary named z88r of the Z88 solver
Solver method The solver method used by the Z88 solver for new simulations.
Max places in stiffness matrix This is relevant when the solver method Simple Cholesky is used. After starting the solver, it might tell you that you need to increase the MAXGS value. In this case increase the max places and re-run the solver.
Max places in coincidence vector This is relevant when one of the iterative solver methods is used. After starting the solver, it might tell you that you need to increase the MAXKOI value. In this case increase the max places and re-run the solver.

Material

On the Material tab you can specify the following:

Name Description
Use built-in materials The cards built-in to FreeCAD will be listed as available.
Use materials from Materials directory in user's FreeCAD preference directory The cards from FreeCAD's preferences directory will be listed as available. On Windows, that would for example be this folder:

C:\Users\<username>\AppData\Roaming\FreeCAD\Material

Use materials from user defined directory Also material cards also from the specified directory will be listed as available.
Delete card duplicates Duplicate cards will be deleted from the displayed material card list.
Sort by resources Material cards will appear sorted by their resources (locations). If unchecked, they will be sorted by their name.