From 09aa681b67ff075d500c1893813ce68ae1ff8e27 Mon Sep 17 00:00:00 2001 From: Michael Campbell Date: Wed, 29 Jul 2020 18:16:25 -0500 Subject: [PATCH] Add a doc snippet --- meshmode/discretization/visualization.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/meshmode/discretization/visualization.py b/meshmode/discretization/visualization.py index 473cfe94..013f5e5e 100644 --- a/meshmode/discretization/visualization.py +++ b/meshmode/discretization/visualization.py @@ -443,6 +443,17 @@ class Visualizer(object): def write_vtk_file(self, file_name, names_and_fields, compressor=None, real_only=False, overwrite=False, par_namelist=None): + r""" + Parameters + ---------- + par_namelist + + If par_namelist is given by the caller (and non-empty), + it is expected to be a list of filenames wherein the + PVTU-format filename and the part source filenames are given. + When used by a parallel application, only one rank should + write the PVTU file. + """ self._write_vtk_file(file_name, names_and_fields, par_namelist=par_namelist, connectivity=self._vtk_connectivity, -- GitLab