From 3685b3dad7dd2fca1c0c6d536b356919e48cbc0d Mon Sep 17 00:00:00 2001
From: Sudhanshu Dubey <sudhanshu.thethunder@gmail.com>
Date: Fri, 3 Jul 2020 18:01:56 +0200
Subject: [PATCH] FEM: examples, add method for retrieving informations

---
 src/Mod/Fem/femexamples/boxanalysis_frequency.py    | 12 ++++++++++++
 src/Mod/Fem/femexamples/boxanalysis_static.py       | 13 +++++++++++++
 src/Mod/Fem/femexamples/ccx_cantilever_faceload.py  | 13 +++++++++++++
 .../femexamples/ccx_cantilever_hexa20faceload.py    | 12 ++++++++++++
 src/Mod/Fem/femexamples/ccx_cantilever_nodeload.py  | 12 ++++++++++++
 .../ccx_cantilever_prescribeddisplacement.py        | 12 ++++++++++++
 .../femexamples/constraint_contact_shell_shell.py   | 13 +++++++++++++
 .../femexamples/constraint_contact_solid_solid.py   | 13 +++++++++++++
 src/Mod/Fem/femexamples/constraint_section_print.py | 12 ++++++++++++
 src/Mod/Fem/femexamples/constraint_tie.py           | 13 +++++++++++++
 .../Fem/femexamples/material_multiple_twoboxes.py   | 13 +++++++++++++
 .../Fem/femexamples/material_nl_platewithhole.py    | 13 +++++++++++++
 src/Mod/Fem/femexamples/rc_wall_2d.py               | 13 +++++++++++++
 src/Mod/Fem/femexamples/thermomech_bimetall.py      | 13 +++++++++++++
 src/Mod/Fem/femexamples/thermomech_flow1d.py        | 13 +++++++++++++
 src/Mod/Fem/femexamples/thermomech_spine.py         | 13 +++++++++++++
 16 files changed, 203 insertions(+)

diff --git a/src/Mod/Fem/femexamples/boxanalysis_frequency.py b/src/Mod/Fem/femexamples/boxanalysis_frequency.py
index ab3f977436..6e7eab8e05 100644
--- a/src/Mod/Fem/femexamples/boxanalysis_frequency.py
+++ b/src/Mod/Fem/femexamples/boxanalysis_frequency.py
@@ -44,6 +44,18 @@ def init_doc(doc=None):
     return doc
 
 
+def get_information():
+    info = {"name": "Box Analysis Frequency",
+            "meshtype": "solid",
+            "meshelement": "Tet10",
+            "constraints": [],
+            "solvers": ["ccx"],
+            "material": "solid",
+            "equation": "frequency"
+            }
+    return info
+
+
 def setup(doc=None, solvertype="ccxtools"):
     # setup box frequency, change solver attributes
 
diff --git a/src/Mod/Fem/femexamples/boxanalysis_static.py b/src/Mod/Fem/femexamples/boxanalysis_static.py
index a8246d8b09..2fef33ab73 100644
--- a/src/Mod/Fem/femexamples/boxanalysis_static.py
+++ b/src/Mod/Fem/femexamples/boxanalysis_static.py
@@ -1,5 +1,6 @@
 # ***************************************************************************
 # *   Copyright (c) 2019 Bernd Hahnebach <bernd@bimstatik.org>              *
+# *   Copyright (c) 2020 Sudhanshu Dubey <sudhanshu.thethunder@gmail.com    *
 # *                                                                         *
 # *   This file is part of the FreeCAD CAx development system.              *
 # *                                                                         *
@@ -42,6 +43,18 @@ def init_doc(doc=None):
     return doc
 
 
+def get_information():
+    info = {"name": "Box Analysis Static",
+            "meshtype": "solid",
+            "meshelement": "Tet10",
+            "constraints": ["fixed", "force", "pressure"],
+            "solvers": ["ccx", "z88", "elmer"],
+            "material": "solid",
+            "equation": "mechanical"
+            }
+    return info
+
+
 def setup_base(doc=None, solvertype="ccxtools"):
     # setup box base model
 
diff --git a/src/Mod/Fem/femexamples/ccx_cantilever_faceload.py b/src/Mod/Fem/femexamples/ccx_cantilever_faceload.py
index adb04b0e24..634570d477 100644
--- a/src/Mod/Fem/femexamples/ccx_cantilever_faceload.py
+++ b/src/Mod/Fem/femexamples/ccx_cantilever_faceload.py
@@ -1,5 +1,6 @@
 # ***************************************************************************
 # *   Copyright (c) 2019 Bernd Hahnebach <bernd@bimstatik.org>              *
+# *   Copyright (c) 2020 Sudhanshu Dubey <sudhanshu.thethunder@gmail.com    *
 # *                                                                         *
 # *   This file is part of the FreeCAD CAx development system.              *
 # *                                                                         *
@@ -42,6 +43,18 @@ def init_doc(doc=None):
     return doc
 
 
+def get_information():
+    info = {"name": "CCX cantilever face load",
+            "meshtype": "solid",
+            "meshelement": "Tet10",
+            "constraints": ["fixed", "force"],
+            "solvers": ["ccx", "z88", "elmer"],
+            "material": "solid",
+            "equation": "mechanical"
+            }
+    return info
+
+
 def setup_cantileverbase(doc=None, solvertype="ccxtools"):
     # setup CalculiX cantilever base model
 
diff --git a/src/Mod/Fem/femexamples/ccx_cantilever_hexa20faceload.py b/src/Mod/Fem/femexamples/ccx_cantilever_hexa20faceload.py
index 3032263074..e4644a64bf 100644
--- a/src/Mod/Fem/femexamples/ccx_cantilever_hexa20faceload.py
+++ b/src/Mod/Fem/femexamples/ccx_cantilever_hexa20faceload.py
@@ -44,6 +44,18 @@ def init_doc(doc=None):
     return doc
 
 
+def get_information():
+    info = {"name": "CCX cantilever face load",
+            "meshtype": "solid",
+            "meshelement": "Hexa20",
+            "constraints": ["fixed", "force"],
+            "solvers": ["ccx", "z88", "elmer"],
+            "material": "solid",
+            "equation": "mechanical"
+            }
+    return info
+
+
 def setup(doc=None, solvertype="ccxtools"):
     doc = faceload.setup(doc, solvertype)
 
diff --git a/src/Mod/Fem/femexamples/ccx_cantilever_nodeload.py b/src/Mod/Fem/femexamples/ccx_cantilever_nodeload.py
index 687b5f2c07..de6e336e3b 100644
--- a/src/Mod/Fem/femexamples/ccx_cantilever_nodeload.py
+++ b/src/Mod/Fem/femexamples/ccx_cantilever_nodeload.py
@@ -44,6 +44,18 @@ def init_doc(doc=None):
     return doc
 
 
+def get_information():
+    info = {"name": "CCX cantilever node load",
+            "meshtype": "solid",
+            "meshelement": "Tet10",
+            "constraints": ["fixed", "force"],
+            "solvers": ["ccx", "z88", "elmer"],
+            "material": "solid",
+            "equation": "mechanical"
+            }
+    return info
+
+
 def setup(doc=None, solvertype="ccxtools"):
     # setup CalculiX cantilever, apply 9 MN on the 4 nodes of the front end face
 
diff --git a/src/Mod/Fem/femexamples/ccx_cantilever_prescribeddisplacement.py b/src/Mod/Fem/femexamples/ccx_cantilever_prescribeddisplacement.py
index 02cd58e990..b60e0ff054 100644
--- a/src/Mod/Fem/femexamples/ccx_cantilever_prescribeddisplacement.py
+++ b/src/Mod/Fem/femexamples/ccx_cantilever_prescribeddisplacement.py
@@ -44,6 +44,18 @@ def init_doc(doc=None):
     return doc
 
 
+def get_information():
+    info = {"name": "CCX cantilever prescibed displacement",
+            "meshtype": "solid",
+            "meshelement": "Tet10",
+            "constraints": ["fixed", "displacement"],
+            "solvers": ["ccx", "z88", "elmer"],
+            "material": "solid",
+            "equation": "mechanical"
+            }
+    return info
+
+
 def setup(doc=None, solvertype="ccxtools"):
     # setup CalculiX cantilever
     # apply a prescribed displacement of 250 mm in -z on the front end face
diff --git a/src/Mod/Fem/femexamples/constraint_contact_shell_shell.py b/src/Mod/Fem/femexamples/constraint_contact_shell_shell.py
index de8a518080..b71bda82a1 100644
--- a/src/Mod/Fem/femexamples/constraint_contact_shell_shell.py
+++ b/src/Mod/Fem/femexamples/constraint_contact_shell_shell.py
@@ -1,5 +1,6 @@
 # ***************************************************************************
 # *   Copyright (c) 2020 Bernd Hahnebach <bernd@bimstatik.org>              *
+# *   Copyright (c) 2020 Sudhanshu Dubey <sudhanshu.thethunder@gmail.com    *
 # *                                                                         *
 # *   This file is part of the FreeCAD CAx development system.              *
 # *                                                                         *
@@ -48,6 +49,18 @@ def init_doc(doc=None):
     return doc
 
 
+def get_information():
+    info = {"name": "Constraint Constact Shell Shell",
+            "meshtype": "solid",
+            "meshelement": "Tria3",
+            "constraints": ["fixed", "force", "contact"],
+            "solvers": ["ccx"],
+            "material": "solid",
+            "equation": "mechanical"
+            }
+    return info
+
+
 def setup(doc=None, solvertype="ccxtools"):
     # setup model
 
diff --git a/src/Mod/Fem/femexamples/constraint_contact_solid_solid.py b/src/Mod/Fem/femexamples/constraint_contact_solid_solid.py
index 6c62f8b1c2..7ab1a5e591 100644
--- a/src/Mod/Fem/femexamples/constraint_contact_solid_solid.py
+++ b/src/Mod/Fem/femexamples/constraint_contact_solid_solid.py
@@ -1,5 +1,6 @@
 # ***************************************************************************
 # *   Copyright (c) 2020 Bernd Hahnebach <bernd@bimstatik.org>              *
+# *   Copyright (c) 2020 Sudhanshu Dubey <sudhanshu.thethunder@gmail.com    *
 # *                                                                         *
 # *   This file is part of the FreeCAD CAx development system.              *
 # *                                                                         *
@@ -48,6 +49,18 @@ def init_doc(doc=None):
     return doc
 
 
+def get_information():
+    info = {"name": "Constraint Contact Solid Solid",
+            "meshtype": "solid",
+            "meshelement": "Tet10",
+            "constraints": ["fixed", "pressure", "contact"],
+            "solvers": ["ccx"],
+            "material": "solid",
+            "equation": "mechanical"
+            }
+    return info
+
+
 def setup(doc=None, solvertype="ccxtools"):
     # setup model
 
diff --git a/src/Mod/Fem/femexamples/constraint_section_print.py b/src/Mod/Fem/femexamples/constraint_section_print.py
index c4de325e64..3c9cdc09c4 100644
--- a/src/Mod/Fem/femexamples/constraint_section_print.py
+++ b/src/Mod/Fem/femexamples/constraint_section_print.py
@@ -55,6 +55,18 @@ def init_doc(doc=None):
     return doc
 
 
+def get_information():
+    info = {"name": "Constraint Section Print",
+            "meshtype": "solid",
+            "meshelement": "Tet10",
+            "constraints": ["section_print", "fixed", "pressure"],
+            "solvers": ["ccx"],
+            "material": "solid",
+            "equation": "mechanical"
+            }
+    return info
+
+
 def setup(doc=None, solvertype="ccxtools"):
 
     if doc is None:
diff --git a/src/Mod/Fem/femexamples/constraint_tie.py b/src/Mod/Fem/femexamples/constraint_tie.py
index 013e6a3e19..5d3efa22ef 100644
--- a/src/Mod/Fem/femexamples/constraint_tie.py
+++ b/src/Mod/Fem/femexamples/constraint_tie.py
@@ -1,5 +1,6 @@
 # ***************************************************************************
 # *   Copyright (c) 2020 Bernd Hahnebach <bernd@bimstatik.org>              *
+# *   Copyright (c) 2020 Sudhanshu Dubey <sudhanshu.thethunder@gmail.com    *
 # *                                                                         *
 # *   This file is part of the FreeCAD CAx development system.              *
 # *                                                                         *
@@ -48,6 +49,18 @@ def init_doc(doc=None):
     return doc
 
 
+def get_information():
+    info = {"name": "Constraint Tie",
+            "meshtype": "solid",
+            "meshelement": "Tet10",
+            "constraints": ["fixed", "force", "tie"],
+            "solvers": ["ccx"],
+            "material": "solid",
+            "equation": "mechanical"
+            }
+    return info
+
+
 def setup(doc=None, solvertype="ccxtools"):
     # setup model
 
diff --git a/src/Mod/Fem/femexamples/material_multiple_twoboxes.py b/src/Mod/Fem/femexamples/material_multiple_twoboxes.py
index 0ce2b5b33a..1b16e99861 100644
--- a/src/Mod/Fem/femexamples/material_multiple_twoboxes.py
+++ b/src/Mod/Fem/femexamples/material_multiple_twoboxes.py
@@ -1,5 +1,6 @@
 # ***************************************************************************
 # *   Copyright (c) 2019 Bernd Hahnebach <bernd@bimstatik.org>              *
+# *   Copyright (c) 2020 Sudhanshu Dubey <sudhanshu.thethunder@gmail.com    *
 # *                                                                         *
 # *   This file is part of the FreeCAD CAx development system.              *
 # *                                                                         *
@@ -44,6 +45,18 @@ def init_doc(doc=None):
     return doc
 
 
+def get_information():
+    info = {"name": "Material Multiple Two Boxes",
+            "meshtype": "solid",
+            "meshelement": "Tet10",
+            "constraints": ["fixed", "pressure"],
+            "solvers": ["ccx"],
+            "material": "multimaterial",
+            "equation": "mechanical"
+            }
+    return info
+
+
 def setup(doc=None, solvertype="ccxtools"):
     # setup model
 
diff --git a/src/Mod/Fem/femexamples/material_nl_platewithhole.py b/src/Mod/Fem/femexamples/material_nl_platewithhole.py
index ab6d5773fd..a72a318fe2 100644
--- a/src/Mod/Fem/femexamples/material_nl_platewithhole.py
+++ b/src/Mod/Fem/femexamples/material_nl_platewithhole.py
@@ -1,5 +1,6 @@
 # ***************************************************************************
 # *   Copyright (c) 2019 Bernd Hahnebach <bernd@bimstatik.org>              *
+# *   Copyright (c) 2020 Sudhanshu Dubey <sudhanshu.thethunder@gmail.com    *
 # *                                                                         *
 # *   This file is part of the FreeCAD CAx development system.              *
 # *                                                                         *
@@ -61,6 +62,18 @@ def init_doc(doc=None):
     return doc
 
 
+def get_information():
+    info = {"name": "Material NL Plate with Hole",
+            "meshtype": "solid",
+            "meshelement": "Tet10",
+            "constraints": ["fixed", "force"],
+            "solvers": ["ccx"],
+            "material": "multimaterial",
+            "equation": "mechanical"
+            }
+    return info
+
+
 def setup(doc=None, solvertype="ccxtools"):
     # setup model
 
diff --git a/src/Mod/Fem/femexamples/rc_wall_2d.py b/src/Mod/Fem/femexamples/rc_wall_2d.py
index 387a27a4c8..4dae360280 100644
--- a/src/Mod/Fem/femexamples/rc_wall_2d.py
+++ b/src/Mod/Fem/femexamples/rc_wall_2d.py
@@ -1,5 +1,6 @@
 # ***************************************************************************
 # *   Copyright (c) 2019 Bernd Hahnebach <bernd@bimstatik.org>              *
+# *   Copyright (c) 2020 Sudhanshu Dubey <sudhanshu.thethunder@gmail.com    *
 # *                                                                         *
 # *   This file is part of the FreeCAD CAx development system.              *
 # *                                                                         *
@@ -48,6 +49,18 @@ def init_doc(doc=None):
     return doc
 
 
+def get_information():
+    info = {"name": "RC Wall 2D",
+            "meshtype": "solid",
+            "meshelement": "Tria6",
+            "constraints": ["fixed", "force", "displacement"],
+            "solvers": ["ccx"],
+            "material": "reinforced",
+            "equation": "mechanical"
+            }
+    return info
+
+
 def setup(doc=None, solvertype="ccxtools"):
     # setup reinfoced wall in 2D
 
diff --git a/src/Mod/Fem/femexamples/thermomech_bimetall.py b/src/Mod/Fem/femexamples/thermomech_bimetall.py
index 2388a43e47..62a0558819 100644
--- a/src/Mod/Fem/femexamples/thermomech_bimetall.py
+++ b/src/Mod/Fem/femexamples/thermomech_bimetall.py
@@ -1,5 +1,6 @@
 # ***************************************************************************
 # *   Copyright (c) 2020 Bernd Hahnebach <bernd@bimstatik.org>              *
+# *   Copyright (c) 2020 Sudhanshu Dubey <sudhanshu.thethunder@gmail.com    *
 # *                                                                         *
 # *   This file is part of the FreeCAD CAx development system.              *
 # *                                                                         *
@@ -50,6 +51,18 @@ def init_doc(doc=None):
     return doc
 
 
+def get_information():
+    info = {"name": "Thermomech Bimetall",
+            "meshtype": "solid",
+            "meshelement": "Tet10",
+            "constraints": ["fixed", "initial temperature", "temperature"],
+            "solvers": ["ccx", "elmer"],
+            "material": "multimaterial",
+            "equation": "thermomechanical"
+            }
+    return info
+
+
 def setup(doc=None, solvertype="ccxtools"):
     # setup model
 
diff --git a/src/Mod/Fem/femexamples/thermomech_flow1d.py b/src/Mod/Fem/femexamples/thermomech_flow1d.py
index f82eae1877..6390e56a7b 100644
--- a/src/Mod/Fem/femexamples/thermomech_flow1d.py
+++ b/src/Mod/Fem/femexamples/thermomech_flow1d.py
@@ -1,5 +1,6 @@
 # ***************************************************************************
 # *   Copyright (c) 2019 Bernd Hahnebach <bernd@bimstatik.org>              *
+# *   Copyright (c) 2020 Sudhanshu Dubey <sudhanshu.thethunder@gmail.com    *
 # *                                                                         *
 # *   This file is part of the FreeCAD CAx development system.              *
 # *                                                                         *
@@ -47,6 +48,18 @@ def init_doc(doc=None):
     return doc
 
 
+def get_information():
+    info = {"name": "Thermomech Flow 1D",
+            "meshtype": "solid",
+            "meshelement": "Seg3",
+            "constraints": ["self weight"],
+            "solvers": ["ccx"],
+            "material": "fluid",
+            "equation": "thermomechanical"
+            }
+    return info
+
+
 def setup(doc=None, solvertype="ccxtools"):
     # setup model
 
diff --git a/src/Mod/Fem/femexamples/thermomech_spine.py b/src/Mod/Fem/femexamples/thermomech_spine.py
index d2cdf6f1ec..5c2d6f88ca 100644
--- a/src/Mod/Fem/femexamples/thermomech_spine.py
+++ b/src/Mod/Fem/femexamples/thermomech_spine.py
@@ -1,5 +1,6 @@
 # ***************************************************************************
 # *   Copyright (c) 2019 Bernd Hahnebach <bernd@bimstatik.org>              *
+# *   Copyright (c) 2020 Sudhanshu Dubey <sudhanshu.thethunder@gmail.com    *
 # *                                                                         *
 # *   This file is part of the FreeCAD CAx development system.              *
 # *                                                                         *
@@ -42,6 +43,18 @@ def init_doc(doc=None):
     return doc
 
 
+def get_information():
+    info = {"name": "Thermomech Spine",
+            "meshtype": "solid",
+            "meshelement": "Tet10",
+            "constraints": ["fixed", "initial temperature", "temperature", "heatflux"],
+            "solvers": ["ccx"],
+            "material": "solid",
+            "equation": "thermomechanical"
+            }
+    return info
+
+
 def setup(doc=None, solvertype="ccxtools"):
     # setup model