Add sparse seed nans flag to output #902
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Yurlungur
requested review from
BenWibking,
bprather,
forrestglines,
lroberts36,
pgrete and
pdmullen
pdmullen
approved these changes
Jul 6, 2023
src/outputs/parthenon_hdf5.cpp
Outdated
| @@ -538,7 +538,10 @@ void PHDF5Output::WriteOutputFileImpl(Mesh *pm, ParameterInput *pin, SimTime *tm | |||
| varSize = | |||
| vinfo.nx6 * vinfo.nx5 * vinfo.nx4 * vinfo.nx3 * vinfo.nx2 * vinfo.nx1; | |||
| } | |||
| memset(tmpData.data() + index, 0, varSize * sizeof(OutT)); | |||
| auto fill_val = output_params.sparse_seed_nans | |||
| ? std::numeric_limits<OutT>::signaling_NaN() | |||
There was a problem hiding this comment.
here we use signaling_NaN() rather than quiet_NaN() because if we are doing any operations on output data then we should signal?
There was a problem hiding this comment.
You know to be honest I didn't think that through carefully. I just reflexively use signalling NaN for this kind of thing basically for that reason. But I'm not married to it, if you'd prefer a quiet NaN.
There was a problem hiding this comment.
Changed to quiet_NaN() since that should be a bit more performant and no ops are happening here anyway.
lroberts36
approved these changes
Jul 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
When debugging sparse variables, it's useful to be able to output where sparse variables are specifically de-allocated, as opposed to just exactly zero. This small PR adds a tiny tweak to parthenon_hdf5 output which allows the user to output NaNs for sparse variables which are de-allocated, making them easy to find in output.
This is essentially a debugging tool and it's opt-in. However, it does have the advantage that by replacing
memsetwithstd::fillwe could change what that fill value is at a later date to, for example, set it to whatever value the sparse field would be initialized to, if that value is not zero.PR Checklist