Skip to content
Snippets Groups Projects
Unverified Commit 5447e2a8 authored by Brent Huisman's avatar Brent Huisman Committed by GitHub
Browse files

Clarify sample collection in distributed contexts. (#1331)

parent 782658db
No related branches found
No related tags found
No related merge requests found
...@@ -135,6 +135,13 @@ over the local and distributed hardware resources (see :ref:`pydomdec`). Then, t ...@@ -135,6 +135,13 @@ over the local and distributed hardware resources (see :ref:`pydomdec`). Then, t
Retrieve a list of sample data associated with the given ``handle``. Retrieve a list of sample data associated with the given ``handle``.
There will be one entry in the list per probe associated with the probe id used when the sampling was set up. There will be one entry in the list per probe associated with the probe id used when the sampling was set up.
For example, if a probe was placed on a locset describing three positions, the returned list will contain three elements.
An empty list will be returned if no output was recorded for the cell. For simulations
that are distributed using MPI, handles associated with non-local cells will return an
empty list.
It is the responsibility of the caller to gather results over the ranks.
Each entry is a pair ``(samples, meta)`` where ``meta`` is the probe metadata as would be returned by Each entry is a pair ``(samples, meta)`` where ``meta`` is the probe metadata as would be returned by
``probe_metadata(probe_id)``, and ``samples`` contains the recorded values. ``probe_metadata(probe_id)``, and ``samples`` contains the recorded values.
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment