FEM SolverElmer: Difference between revisions

From FreeCAD Documentation
No edit summary
mNo edit summary
 
(95 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{UnfinishedDocu{{#translation:}}}}
<translate>
<translate>

<!--T:4-->
<!--T:4-->
{{Docnav
{{Docnav|[[FEM_SolverCalculiX|Solver CalculiX]]|[[FEM_SolverZ88|Solver Z88]]|[[FEM_Module|FEM]]|IconL=Fem_Solver.svg|IconC=Workbench_FEM.svg|IconR=FEM_SolverZ88.png}}
|[[FEM_SolverCalculixCxxtools|Solver CalculiX Standard]]
|[[FEM_SolverMystran|Solver Mystran]]
|[[FEM_Workbench|FEM]]
|IconL=FEM_SolverCalculixCxxtools.svg
|IconR=FEM_SolverMystran.svg
|IconC=Workbench_FEM.svg
}}


<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand|Name=FEM SolverElmer|Icon=Fem-elmer.svg|MenuLocation= Solve → solver Elmer||Workbenches=[[Fem Workbench|FEM]]|Shortcut=|SeeAlso=[[FEM_tutorial|FEM tutorial]]}}
|Name=FEM SolverElmer
|MenuLocation=Solver → Solver Elmer
|Workbenches=[[FEM_Workbench|FEM]]
|Shortcut={{KEY|S}} {{KEY|E}}
|SeeAlso=[[FEM_SolverElmer_SolverSettings|FEM SolverElmer SolverSettings]], [[FEM_SolverCalculixCxxtools|FEM Solver CalculixCxxtools]], [[FEM_SolverZ88|FEM Solver Z88]], [[FEM_tutorial|FEM tutorial]]
}}


==Description== <!--T:8-->


<!--T:10-->
[https://www.elmerfem.org Elmer] is an open source multiphysical simulation software mainly developed by CSC - IT Center for Science (CSC). Elmer development was started 1995 in collaboration with Finnish Universities, research institutes and industry. After it's open source publication in 2005, the use and development of Elmer has become international.

<!--T:11-->
Elmer includes physical models of fluid dynamics, structural mechanics, electromagnetics, heat transfer and acoustics, for example. These are described by partial differential equations which [https://www.csc.fi/web/elmer Elmer] solves by the Finite Element Method (FEM).

<!--T:12-->
Creating the SolverElmer object in the Analysis container in FreeCAD, gives access to the Elmer Equations for simple or multiphysical analysis.


<!--T:2-->
<!--T:2-->
Since FreeCAD already has an extensive integration of [[Image:FEM_SolverCalculiX.svg|24px|link=FEM_SolverCalculixCxxtools]] [[FEM_SolverCalculixCxxtools|Calculix]] and [[Image:FEM_SolverZ88.svg|24px|link=FEM_SolverZ88]] [[FEM_SolverZ88|Z88]] as solvers for mechanical and thermo-mechanical analysis, Elmer will be preferred for computational fluid dynamics (CFD), heat, electrostatics and electrodynamics. It can also be used for mechanical FEA through the Elasticity equation or any combination of the aforementioned equations. This combination makes Elmer the preferred choice for multi-physics analyses.
ToDo


==Installation== <!--T:13-->


<!--T:3-->
<!--T:14-->
Elmer requires two components to be interfaced with FreeCAD:
<br />
* ElmerGrid is the interface handling meshes
* ElmerSolver is handling the computation.
There are standalone programs for both of these applications but their installation and usage are beyond the scope of the FreeCAD integration.


<!--T:5-->
<!--T:15-->
# Download and install the version best suited to your Operating System ([https://www.nic.funet.fi/pub/sci/physics/elmer/bin/windows/ Windows] or [https://www.nic.funet.fi/pub/sci/physics/elmer/bin/linux/Readme1st.txt Linux]). It is recommended to install the {{incode|mpi}} version to get multi-core support ({{Version|0.21}}).
{{Docnav|[[FEM_SolverCalculiX|Solver CalculiX]]|[[FEM_SolverZ88|Solver Z88]]|[[FEM_Module|FEM]]|IconL=Fem_Solver.svg|IconC=Workbench_FEM.svg|IconR=FEM_SolverZ88.png}}
# In FreeCAD go to {{MenuCommand|Edit → Preferences → FEM → Elmer}}
# In the [[FEM_Preferences#Elmer|FEM preferences]] set the correct path for both {{incode|ElmerGrid}} and {{incode|ElmerSolver}}, or {{VersionPlus|0.21}}: set the path for {{incode|ElmerSolver_mpi}} instead of {{incode|ElmerSolver}} to make Elmer use all available CPU cores.
#: [[Image:Preferences-ElmerPath.png|Elmer Tab in FEM Preferences]]
#: {{Caption|Elmer preferences dialog menu showing fields to locate important Elmer binaries on Windows OS}}


<!--T:6-->
<!--T:16-->
You are ready to use Elmer in FreeCAD.
{{FEM Tools navi}}

<!--T:23-->
{{VersionMinus|0.19}}: Now start FreeCAD and change the units scheme to ''MKS'' in the [[Preferences_Editor#Units|preferences]]. See [[#Notes|Notes]].

==Usage== <!--T:9-->

<!--T:17-->
# Switch to the [[Image:Workbench_FEM.svg|24px]] [[FEM_Workbench|FEM Workbench]]
# Create an [[FEM_Analysis|Analysis]] container by pressing the [[Image:FEM_Analysis.svg|22px]] icon.
# Create a FEM Solver for Elmer, by pressing the [[Image:FEM_SolverElmer.svg|22px]] icon.
#* Note: A successful analysis will require at least a Model (2D or 3D), a Material ([[FEM_MaterialFluid|Fluid]] or [[FEM_MaterialSolid|Solid]]), a [[FEM_MeshGmshFromShape|Mesh]], Equations and Boundary conditions
#: [[Image:Elmer typical file tree.png]]
#: {{Caption|Example of a [[Tree_view|tree view]] once a Solver for Elmer is activated}}
# Edit the parameters for the solver in the [[Property_editor|Property editor]] {{Button|Data}} tab of the SolverElmer object in the model [[Tree_view|tree view]]
# Double-click on the {{KEY|[[Image:FEM_SolverElmer.svg|22px]] SolverElmer}} object to prepare an analysis run
#: [[Image:ElmerSolver TaskPanel.png|300px]]
#: {{Caption|Dialog box to run an Elmer analysis}}
# Select the path to write the analysis in by clicking {{Button|...}}
# Click {{Button|Write}} to write the case files in the directory selected previously
# Click {{Button|Run}} to start the analysis

===Equations=== <!--T:24-->

<!--T:18-->
* To perform the analysis of a particular physical behavior, an Equation must be used (Flow, Heat, Electrostatics...)
* Disambiguation: The term ''Equation'' is used in FreeCAD to describe the different physical mechanisms, the term ''Solver'' is used in all Elmer documents. Thus when using in FreeCAD the "Flow Equation", in reality Elmer uses the "Flow Solver" to find a solution to the Navier-Stokes equation.
* One or several equations can be used at once with Elmer by simply adding the equation object under the SolverElmer object, thus performing multi-physics analyses:

<!--T:19-->
# Click on the {{KEY|[[Image:FEM_SolverElmer.svg|22px]] SolverElmer}} object in the model [[Tree_view|tree view]]
# Select one or several of the available equations:
#* [[Image:FEM_EquationDeformation.svg|32px]] [[FEM_EquationDeformation|Deformation equation]]
#* [[Image:FEM_EquationElasticity.svg|32px]] [[FEM_EquationElasticity|Elasticity equation]]
#* [[Image:FEM_EquationElectricforce.svg|32px]] [[FEM_EquationElectricforce|Electricforce equation]]
#* [[Image:FEM_EquationElectrostatic.svg|32px]] [[FEM_EquationElectrostatic|Electrostatic equation]]
#* [[Image:FEM_EquationFlow.svg|32px]] [[FEM_EquationFlow|Flow equation]]
#* [[Image:FEM_EquationFlux.svg|32px]] [[FEM_EquationFlux|Flux equation]]
#* [[Image:FEM_EquationHeat.svg|32px]] [[FEM_EquationHeat|Heat equation]]
#* [[Image:FEM_EquationMagnetodynamic.svg|32px]] [[FEM_EquationMagnetodynamic|Magnetodynamic equation]]
#* [[Image:FEM_EquationMagnetodynamic2D.svg|32px]] [[FEM_EquationMagnetodynamic2D|Magnetodynamic 2D equation]]

===Solver Settings=== <!--T:26-->

<!--T:27-->
* Depending on the used equations, you must change the default solver settings. They are explained in the [[FEM_SolverElmer_SolverSettings|Elmer solver settings]].
* The solver will by default perform a steady-state simulation. To perform a transient simulation (how the model behaves/develops over time) see the section ''Timestepping (transient analyses)'' in the [[FEM_SolverElmer_SolverSettings#Timestepping_(transient_analyses)|Elmer solver settings]].

===Visualization=== <!--T:29-->

<!--T:30-->
The Elmer solver results are output in [[FEM_PostPipelineFromResult|result pipeline]] objects. ([[FEM_ResultShow|Result objects]] are not possible.)

<!--T:31-->
{{Version|0.21}}:

<!--T:32-->
For transient analyses you get a result pipeline for every output time step. To edit all of them at once, select them in the [[Tree_view|tree view]] and set the parameters in the [[property editor]].
To make animations of the temporal progression, the best method is currently to:
* Hide the view of the first time result.
* Select an object of your choice in the tree view, but not a pipeline object.
* Hover with the mouse over the pipelines.

<!--T:33-->
The result is an animation like this:

<!--T:34-->
[[Image:ElmerSolver_TransientAnalysis.gif]]

==Notes== <!--T:25-->

<!--T:20-->
* '''Important''': in order to get sensible results and to be able to exchange the Elmer input files (named ''case.sif'') with others, all values in the input files must be in SI units. In FreeCAD version 0.19 and earlier this is only the case if you use the unit scheme MKS in the [[Preferences_Editor#Units|preferences]].
* Parameters for the Solver and for the Equations are independently set through the [[Property_editor|Property editor]] {{KEY|Data}} tab of their respective objects in the [[Tree_view|tree view]].
* Each equation will have a priority, for example, if trying see the effect of a convective flow of hot air, the equation for Flow should be solved with higher priority than Heat, otherwise the solver will first solve Heat through conduction and then Flow.
* 2D vs 3D cases: Elmer can be used to solve both 2D and 3D cases. However, when defining a 2D case, the faces need to be mapped in the XY plane of FreeCAD, otherwise the solver will try to compute a 3D case on a face, and normal vectors will be under-defined. Further information can be found in the FreeCAD forums: https://forum.freecadweb.org/viewtopic.php?f=18&t=48175

==Documentation== <!--T:21-->

<!--T:22-->
The following link gives access to the full [https://www.nic.funet.fi/pub/sci/physics/elmer/doc/ documentation for Elmer]. This includes the manuals as well as tutorials. Note that documentation and files appended with "gui" generally concern the usage of the Elmer GUI and not the FreeCAD implementation of Elmer.


<!--T:5-->
{{Docnav
|[[FEM_SolverCalculixCxxtools|Solver CalculiX Standard]]
|[[FEM_SolverMystran|Solver Mystran]]
|[[FEM_Workbench|FEM]]
|IconL=FEM_SolverCalculixCxxtools.svg
|IconR=FEM_SolverMystran.svg
|IconC=Workbench_FEM.svg
}}


<!--T:7-->
{{Userdocnavi}}
</translate>
</translate>
{{FEM Tools navi{{#translation:}}}}
{{clear}}
{{Userdocnavi{{#translation:}}}}

Latest revision as of 22:21, 20 November 2023

FEM SolverElmer

Menu location
Solver → Solver Elmer
Workbenches
FEM
Default shortcut
S E
Introduced in version
-
See also
FEM SolverElmer SolverSettings, FEM Solver CalculixCxxtools, FEM Solver Z88, FEM tutorial

Description

Elmer is an open source multiphysical simulation software mainly developed by CSC - IT Center for Science (CSC). Elmer development was started 1995 in collaboration with Finnish Universities, research institutes and industry. After it's open source publication in 2005, the use and development of Elmer has become international.

Elmer includes physical models of fluid dynamics, structural mechanics, electromagnetics, heat transfer and acoustics, for example. These are described by partial differential equations which Elmer solves by the Finite Element Method (FEM).

Creating the SolverElmer object in the Analysis container in FreeCAD, gives access to the Elmer Equations for simple or multiphysical analysis.

Since FreeCAD already has an extensive integration of Calculix and Z88 as solvers for mechanical and thermo-mechanical analysis, Elmer will be preferred for computational fluid dynamics (CFD), heat, electrostatics and electrodynamics. It can also be used for mechanical FEA through the Elasticity equation or any combination of the aforementioned equations. This combination makes Elmer the preferred choice for multi-physics analyses.

Installation

Elmer requires two components to be interfaced with FreeCAD:

  • ElmerGrid is the interface handling meshes
  • ElmerSolver is handling the computation.

There are standalone programs for both of these applications but their installation and usage are beyond the scope of the FreeCAD integration.

  1. Download and install the version best suited to your Operating System (Windows or Linux). It is recommended to install the mpi version to get multi-core support (introduced in version 0.21).
  2. In FreeCAD go to Edit → Preferences → FEM → Elmer
  3. In the FEM preferences set the correct path for both ElmerGrid and ElmerSolver, or version 0.21 and above: set the path for ElmerSolver_mpi instead of ElmerSolver to make Elmer use all available CPU cores.
    Elmer Tab in FEM Preferences

    Elmer preferences dialog menu showing fields to locate important Elmer binaries on Windows OS

You are ready to use Elmer in FreeCAD.

version 0.19 and below: Now start FreeCAD and change the units scheme to MKS in the preferences. See Notes.

Usage

  1. Switch to the FEM Workbench
  2. Create an Analysis container by pressing the icon.
  3. Create a FEM Solver for Elmer, by pressing the icon.
    • Note: A successful analysis will require at least a Model (2D or 3D), a Material (Fluid or Solid), a Mesh, Equations and Boundary conditions

    Example of a tree view once a Solver for Elmer is activated

  4. Edit the parameters for the solver in the Property editor Data tab of the SolverElmer object in the model tree view
  5. Double-click on the SolverElmer object to prepare an analysis run

    Dialog box to run an Elmer analysis

  6. Select the path to write the analysis in by clicking ...
  7. Click Write to write the case files in the directory selected previously
  8. Click Run to start the analysis

Equations

  • To perform the analysis of a particular physical behavior, an Equation must be used (Flow, Heat, Electrostatics...)
  • Disambiguation: The term Equation is used in FreeCAD to describe the different physical mechanisms, the term Solver is used in all Elmer documents. Thus when using in FreeCAD the "Flow Equation", in reality Elmer uses the "Flow Solver" to find a solution to the Navier-Stokes equation.
  • One or several equations can be used at once with Elmer by simply adding the equation object under the SolverElmer object, thus performing multi-physics analyses:
  1. Click on the SolverElmer object in the model tree view
  2. Select one or several of the available equations:

Solver Settings

  • Depending on the used equations, you must change the default solver settings. They are explained in the Elmer solver settings.
  • The solver will by default perform a steady-state simulation. To perform a transient simulation (how the model behaves/develops over time) see the section Timestepping (transient analyses) in the Elmer solver settings.

Visualization

The Elmer solver results are output in result pipeline objects. (Result objects are not possible.)

introduced in version 0.21:

For transient analyses you get a result pipeline for every output time step. To edit all of them at once, select them in the tree view and set the parameters in the property editor. To make animations of the temporal progression, the best method is currently to:

  • Hide the view of the first time result.
  • Select an object of your choice in the tree view, but not a pipeline object.
  • Hover with the mouse over the pipelines.

The result is an animation like this:

Notes

  • Important: in order to get sensible results and to be able to exchange the Elmer input files (named case.sif) with others, all values in the input files must be in SI units. In FreeCAD version 0.19 and earlier this is only the case if you use the unit scheme MKS in the preferences.
  • Parameters for the Solver and for the Equations are independently set through the Property editor Data tab of their respective objects in the tree view.
  • Each equation will have a priority, for example, if trying see the effect of a convective flow of hot air, the equation for Flow should be solved with higher priority than Heat, otherwise the solver will first solve Heat through conduction and then Flow.
  • 2D vs 3D cases: Elmer can be used to solve both 2D and 3D cases. However, when defining a 2D case, the faces need to be mapped in the XY plane of FreeCAD, otherwise the solver will try to compute a 3D case on a face, and normal vectors will be under-defined. Further information can be found in the FreeCAD forums: https://forum.freecadweb.org/viewtopic.php?f=18&t=48175

Documentation

The following link gives access to the full documentation for Elmer. This includes the manuals as well as tutorials. Note that documentation and files appended with "gui" generally concern the usage of the Elmer GUI and not the FreeCAD implementation of Elmer.