Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation and output listing for FirstTimestepPrecious #1363

Merged
merged 2 commits into from
Apr 8, 2019
Merged

Add documentation and output listing for FirstTimestepPrecious #1363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
203e3c0
Add documentation and output listing for FirstTimestepPrecious
eisenhauer Apr 8, 2019
315b4ff
Fix bad order
eisenhauer Apr 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/user_guide/source/engines/sst.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,23 @@ will result in SST generating contact information that uses the
network address associated with the loopback interface (127.0.0.1).
This value is interpreted by only by the SST Writer engine.

8. ``FirstTimestepPrecious``: Default **FALSE**.
FirstTimestepPrecious is a boolean parameter that affects the queueing
of the first timestep presented to the SST Writer engine. If
FirstTimestepPrecious is **TRUE***, then the first timestep is
effectively never removed from the output queue and will be presented
as a first timestep to any reader that joins at a later time. This
can be used to convey run parameters or other information that every
reader may need despite joining later in a data stream. Note that
this queued first timestep does count against the QueueLimit parameter
above, so if a QueueLimit is specified, it should be a value larger
than 1. Further note while specifing this parameter guarantees that
the preserved first timestep will be made available to new readers,
other reader-side operations (like requesting the LatestAvailable
timestep in BeginStep) might still cause the timestep to be skipped.
This value is interpreted by only by the SST Writer engine.


======================= ===================== =========================================================
**Key** **Value Format** **Default** and Examples
======================= ===================== =========================================================
Expand All @@ -187,4 +204,5 @@ This value is interpreted by only by the SST Writer engine.
DataTransport string **default varies by platform**, RDMA, WAN
ControlTransport string **TCP**, Scalable
NetworkInterface string **NULL**
FirstTimestepPrecious boolean **FALSE**, true, no, yes
======================= ===================== =========================================================
2 changes: 2 additions & 0 deletions source/adios2/toolkit/sst/cp/cp_common.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,8 @@ extern void CP_dumpParams(SstStream Stream, struct _SstParams *Params)
SstCommPatternStr[Params->CPCommPattern]);
fprintf(stderr, "Param - MarshalMethod:%s\n",
SstMarshalStr[Params->MarshalMethod]);
fprintf(stderr, "Param - FirstTimestepPrecious:%s\n",
Params->FirstTimestepPrecious ? "True" : "False");
fprintf(stderr, "Param - IsRowMajor:%d (not user settable) \n",
Params->IsRowMajor);
}
Expand Down