Merge pull request #59 from boschresearch/56-fix-docs-issues

Fix issues related to docs after changes from fkm_nonlinear
boschresearch · Jan 8, 2024 · 07abdbb · 07abdbb
2 parents 12d4480 + ab48c39
commit 07abdbb
Show file tree

Hide file tree

Showing 15 changed files with 4,225 additions and 54 deletions.
diff --git a/demos/fkm_nonlinear/fkm_nonlinear.ipynb b/demos/fkm_nonlinear/fkm_nonlinear.ipynb
@@ -397,7 +397,7 @@
     "\n",
     "# plot resulting stress-strain curve\n",
     "sampling_parameter = 50    # choose larger for smoother plot\n",
-    "plotting_data = detector.interpolated_stress_strain_data(sampling_parameter)\n",
+    "plotting_data = detector.interpolated_stress_strain_data(n_points_per_branch=sampling_parameter)\n",
     "\n",
     "strain_values_primary = plotting_data[\"strain_values_primary\"]\n",
     "stress_values_primary = plotting_data[\"stress_values_primary\"]\n",
@@ -407,7 +407,7 @@
     "hysteresis_index_secondary = plotting_data[\"hysteresis_index_secondary\"]\n",
     "\n",
     "sampling_parameter = 50    # choose larger for smoother plot\n",
-    "plotting_data_1st = detector_1st.interpolated_stress_strain_data(sampling_parameter)\n",
+    "plotting_data_1st = detector_1st.interpolated_stress_strain_data(n_points_per_branch=sampling_parameter)\n",
     "\n",
     "strain_values_primary_1st = plotting_data_1st[\"strain_values_primary\"]\n",
     "stress_values_primary_1st = plotting_data_1st[\"stress_values_primary\"]\n",
@@ -441,7 +441,7 @@
     "\n",
     "# plot resulting stress-strain curve\n",
     "sampling_parameter = 50    # choose larger for smoother plot\n",
-    "plotting_data = detector.interpolated_stress_strain_data(sampling_parameter)\n",
+    "plotting_data = detector.interpolated_stress_strain_data(n_points_per_branch=sampling_parameter)\n",
     "\n",
     "strain_values_primary = plotting_data[\"strain_values_primary\"]\n",
     "stress_values_primary = plotting_data[\"stress_values_primary\"]\n",
@@ -451,7 +451,7 @@
     "hysteresis_index_secondary = plotting_data[\"hysteresis_index_secondary\"]\n",
     "\n",
     "sampling_parameter = 50    # choose larger for smoother plot\n",
-    "plotting_data_1st = detector_1st.interpolated_stress_strain_data(sampling_parameter)\n",
+    "plotting_data_1st = detector_1st.interpolated_stress_strain_data(n_points_per_branch=sampling_parameter)\n",
     "\n",
     "strain_values_primary_1st = plotting_data_1st[\"strain_values_primary\"]\n",
     "stress_values_primary_1st = plotting_data_1st[\"stress_values_primary\"]\n",

diff --git a/demos/fkm_nonlinear/fkm_nonlinear_full.ipynb b/demos/fkm_nonlinear/fkm_nonlinear_full.ipynb
@@ -589,7 +589,7 @@
    "source": [
     "# plot resulting stress-strain curve\n",
     "sampling_parameter = 50    # choose larger for smoother plot\n",
-    "plotting_data = detector_1st.interpolated_stress_strain_data(sampling_parameter)\n",
+    "plotting_data = detector_1st.interpolated_stress_strain_data(n_points_per_branch=sampling_parameter)\n",
     "\n",
     "strain_values_primary = plotting_data[\"strain_values_primary\"]\n",
     "stress_values_primary = plotting_data[\"stress_values_primary\"]\n",
@@ -842,7 +842,7 @@
    "source": [
     "# plot resulting stress-strain curve\n",
     "sampling_parameter = 50    # choose larger for smoother plot\n",
-    "plotting_data = detector.interpolated_stress_strain_data(sampling_parameter)\n",
+    "plotting_data = detector.interpolated_stress_strain_data(n_points_per_branch=sampling_parameter)\n",
     "\n",
     "strain_values_primary = plotting_data[\"strain_values_primary\"]\n",
     "stress_values_primary = plotting_data[\"stress_values_primary\"]\n",
@@ -912,7 +912,7 @@
     "# plot all hystereses\n",
     "# get all graph data\n",
     "sampling_parameter = 50    # choose larger for smoother plot\n",
-    "plotting_data = detector.interpolated_stress_strain_data(sampling_parameter, only_hystereses=False)\n",
+    "plotting_data = detector.interpolated_stress_strain_data(n_points_per_branch=sampling_parameter, only_hystereses=False)\n",
     "\n",
     "strain_values_primary = plotting_data[\"strain_values_primary\"]\n",
     "stress_values_primary = plotting_data[\"stress_values_primary\"]\n",
@@ -934,7 +934,7 @@
     "\n",
     "# get graph data of only hystereses\n",
     "sampling_parameter = 50    # choose larger for smoother plot\n",
-    "plotting_data = detector.interpolated_stress_strain_data(sampling_parameter, only_hystereses=True)\n",
+    "plotting_data = detector.interpolated_stress_strain_data(n_points_per_branch=sampling_parameter, only_hystereses=True)\n",
     "\n",
     "strain_values_primary = plotting_data[\"strain_values_primary\"]\n",
     "stress_values_primary = plotting_data[\"stress_values_primary\"]\n",

diff --git a/docs/cookbook.rst b/docs/cookbook.rst
@@ -19,8 +19,6 @@ computer, you can use `MyBinder
    demos/fkm_nonlinear.nblink
    demos/fkm_nonlinear_full.nblink
 
-See also the tutorials about :doc:`FKM nonlinear <tutorials/fkm_nonlinear>`.
-
 .. toctree::
    :maxdepth: 1
    :caption: Material Laws
@@ -48,3 +46,10 @@ See also the tutorials about :doc:`FKM nonlinear <tutorials/fkm_nonlinear>`.
 
    demos/psd_optimizer.nblink
    demos/time_series_handling.nblink
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Load FEM meshes
+
+   demos/import_mesh_vmap.nblink
+   demos/import_mesh_ansys.nblink
diff --git a/docs/strength/fkm_nonlinear.rst b/docs/strength/fkm_nonlinear.rst
@@ -1,6 +1,6 @@
 The ``fkm_nonlinear`` functions
 ###############################
 
-.. autofunction:: pylife.strength.fkm_nonlinear.perform_fkm_nonlinear_assessment
+.. autofunction:: pylife.strength.fkm_nonlinear.assessment_nonlinear_standard.perform_fkm_nonlinear_assessment
 
-.. autofunction:: pylife.strength.fkm_nonlinear.for_material_group
+.. autofunction:: pylife.strength.fkm_nonlinear.constants.for_material_group