vtk-m/docs
Kenneth Moreland 54f0ef2a88 Support providing a Token to ReadPortal and WritePortal
When managing portals in the execution environment, `ArrayHandle` uses the
`Token` object to ensure that the memory associated with a portal exists
for the length of time that it is needed. This is done by creating the
portal with a `Token` object, and the associated portal objects are
guaranteed to be valid while that `Token` object exists. This is supported
by essentially locking the array from further changes.

`Token` objects are typically used when creating a control-side portal with
the `ReadPortal` or `WritePortal`. This is not to say that a `Token` would
not be useful; a control-side portal going out of scope is definitely a
problem. But the creation and distruction of portals in the control
environment is generally too much work for the possible benefits.

However, under certain circumstances it could be useful to use a `Token` to
get a control-side portal. For example, if the `PrepareForExecution` method
of an `ExecutionObjectBase` needs to fill a small `ArrayHandle` on the
control side to pass to the execution side, it would be better to use the
provided `Token` object when doing so. This change allows you to optionally
provide that `Token` when creating these control-side portals.
2022-11-01 09:29:17 -06:00
..
changelog Support providing a Token to ReadPortal and WritePortal 2022-11-01 09:29:17 -06:00
batch_lsf.png ci: Add OLCF GitLab-CI 2021-12-15 13:00:47 -05:00
build_stage.png Update CONTRIBUTING.md to cover gitlab piplines 2020-03-26 13:40:47 -04:00
CI-README.md perftest: add perf regression test 2022-10-07 17:42:12 -04:00
CODEOWNERS Add CODEOWNERS to vtk-m to improve merge request reviewer suggestions 2020-02-11 12:53:07 -05:00
CodingConventions.md Fix formatting of CodingConventions.md. 2019-09-12 15:16:30 -04:00
external_stage.png Update CONTRIBUTING.md to cover gitlab piplines 2020-03-26 13:40:47 -04:00
HotFixGuide.md Update HotFixGuide.md 2022-05-30 14:13:58 -04:00
HPCBuilds.md Remove deprecated virtual methods 2022-10-28 10:56:52 -06:00
Modules.md Add module mechanism 2022-10-26 12:51:05 -06:00
NewRelease.md.tmpl NewRelease: update to reflect latest release workflow 2022-10-11 15:41:24 -04:00
perftest_arch.png perftest: add perf regression test 2022-10-07 17:42:12 -04:00
ReleaseProcess.md newrelease.md: templatize newrelease.md 2022-09-28 18:02:37 -04:00
ReleaseRoadmap.md doc: add release roadmap 2022-06-13 11:42:25 -04:00