temperature from xdmf

festim-dev · Jan 16, 2024 · 4e127a2 · 4e127a2
1 parent 89aea4c
commit 4e127a2
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/docs/source/userguide/export_post_processing.rst b/docs/source/userguide/export_post_processing.rst
@@ -75,6 +75,7 @@ Setting it to ``last`` will export the solution only at the last timestep.
         )
     ]
 
+In order for the XDMF file to be readable by FESTIM, the ``checkpoint`` attribute must be set to ``True``.
 
 ^^^^^^^^^^^^^^^
 TXT export (1D)

diff --git a/docs/source/userguide/temperature.rst b/docs/source/userguide/temperature.rst
@@ -65,3 +65,18 @@ For a steady-state problem:
     my_temp = HeatTransferProblem(transient=False)
 
 :ref:`Boundary conditions<boundary conditions>` and :ref:`heat sources<sources>` can then be applied to this heat transfer problem.
+
+----------------
+From a XDMF file
+----------------
+
+Temperature can also be read from a XDMF file.
+
+.. code-block:: python
+
+    my_temp = TemperatureFromXDMF('temperature.xdmf', label='temperature')
+
+.. note::
+
+        The XDMF file must contain a scalar field named 'temperature'.
+        Moreover, it has to have been exported in "checkpoint" mode (see :ref:`XDMF export`).
-Original file line number
+Diff line change
@@ Expand Up @@
             )
         ]
+    In order for the XDMF file to be readable by FESTIM, the ``checkpoint`` attribute must be set to ``True``.
     ^^^^^^^^^^^^^^^
     TXT export (1D)
@@ Expand Down @@