cashocs.io.export_to_xdmf#

cashocs.io.export_to_xdmf(
filename: str | os.PathLike,
function: fenics.Function,
function_name: str | None = None,
iteration: int = 0,
) → None[source]#

Exports a function to an xdmf file.

This creates a new file, if iteration = 0. Else, it tries to append to an already existing file.

Parameters:

  • filename (str | os.PathLike) – The path to the file to be written.

  • function (fenics.Function) – The fenics function that shall be exported.

  • function_name (str | None) – The name of the function. If this is None, then its current name is used. Defaults to None.

  • iteration (int) – The iteration (of a time series). Defaults to 0.

Return type:

None