Add missing meta data to checkpoint filter.

Issue/feature addressed

closes #383 (closed)

Currently, the meta data from the checkpoint filter are:

     <Metadata>
        <Provenance>
            <GitBranch>refs/heads/master</GitBranch>
            <GitSHA1>ce46ed6285bae0486c566f1682e88b94d3f1078d</GitSHA1>
            <Hostname>carnotaurus</Hostname>
            <NektarVersion>5.9.0</NektarVersion>
            <Timestamp>15-Dec-2025 11:05:49</Timestamp>
        </Provenance>
    </Metadata>

while the meta data from the IO_CheckSteps checkpoint:

     <Metadata>
        <Provenance>
            <GitBranch>refs/heads/master</GitBranch>
            <GitSHA1>ce46ed6285bae0486c566f1682e88b94d3f1078d</GitSHA1>
            <Hostname>carnotaurus</Hostname>
            <NektarVersion>5.9.0</NektarVersion>
            <Timestamp>15-Dec-2025 11:08:38</Timestamp>
        </Provenance>
        <ChkFileNum>5</ChkFileNum>
        <Kinvis>0.001</Kinvis>
        <SessionName0>mesh.opt</SessionName0>
        <SessionName1>mesh_xml/P0000000.xml</SessionName1>
        <Time>6.2400000000000144</Time>
        <TimeStep>0.0060000000000000001</TimeStep>
    </Metadata>

Proposed solution

The missing meta data have now been added to the filter

     <Metadata>
        <Provenance>
            <GitBranch>refs/heads/master</GitBranch>
            <GitSHA1>ce46ed6285bae0486c566f1682e88b94d3f1078d</GitSHA1>
            <Hostname>carnotaurus</Hostname>
            <NektarVersion>5.9.0</NektarVersion>
            <Timestamp>15-Dec-2025 11:08:38</Timestamp>
        </Provenance>
        <ChkFileNum>0</ChkFileNum>
        <FilterFileNum>5</ChkFileNum>
        <Kinvis>0.001</Kinvis>
        <SessionName0>mesh.opt</SessionName0>
        <SessionName1>mesh_xml/P0000000.xml</SessionName1>
        <Time>6.2400000000000144</Time>
        <TimeStep>0.0060000000000000001</TimeStep>
    </Metadata>

If a checkpoint filter file is used to restart a solution, the FilterFileNum of the former is used as the starting index number of the checkpoint filter.

Additionally, the index number for checkpoints and history points (and other relevant filters) can now be specified using command in line argument:

--set-filter-checkpoint-start-number
--set-filter-historypoints-start-number

Implementation

Tests

Suggested reviewers

@victorballester7

Notes

The ChkFileNum number is still the check point number corresponding to IO_CheckSteps (and not the check number corresponding to the filter). This metadata need to be remove at the same time as IO_CheckSteps will be removed as different filters might use different check pointing frequency.

Checklist

  • Functions and classes, or changes to them, are documented.
  • [ ] User guide/documentation is updated.
  • Changelog is updated.
  • Suitable tests added for new functionality.
  • Contributed code is correctly formatted. (See the contributing guidelines).
  • [ ] License added to any new files.
  • No extraneous files have been added (e.g. compiler output or test data files).
Edited by Jacques Xing

Merge request reports

Loading
Loading