Skip to content

HDF5 WriteField: Fix Wrong Doc String and Index#690

Merged
psychocoderHPC merged 1 commit into
ComputationalRadiationPhysics:devfrom
ax3l:topic-hdf5VarsWriteField
Feb 12, 2015
Merged

HDF5 WriteField: Fix Wrong Doc String and Index#690
psychocoderHPC merged 1 commit into
ComputationalRadiationPhysics:devfrom
ax3l:topic-hdf5VarsWriteField

Conversation

@ax3l
Copy link
Copy Markdown
Member

@ax3l ax3l commented Feb 10, 2015

the index names in hdf5/writer/Field.hpp are not ideal (even if the implementation is correct): once d is used as an index [0; simDim-1] and once as an index [0; nComponents-1] and same mixed with i.

we now use n consequently for vector components (x, y, z and w) of fields and d for spatial counts from 0 to simDim-1. i is only used if we iterate over linear memory.

@ax3l ax3l added documentation regarding documentation or wiki discussions refactoring code change to improve performance or to unify a concept but does not change public API component: plugin in PIConGPU plugin labels Feb 10, 2015
@ax3l ax3l added this to the Open Beta milestone Feb 10, 2015
@ax3l ax3l mentioned this pull request Feb 10, 2015
1 task
@ax3l
Copy link
Copy Markdown
Member Author

ax3l commented Feb 10, 2015

review note: this pull request does only fix mixed and weird variable namings and a wrong comment and is therefore not related to #689 (which allows easier backporting of the critical bug therein).

Nevertheless, please take very good care with this pull since it is a bit tricky to read.

@ax3l ax3l force-pushed the topic-hdf5VarsWriteField branch 2 times, most recently from f63b49f to 6044476 Compare February 11, 2015 00:00
the index names in `hdf5/writer/Field.hpp` are not ideal
(even if the implementation is correct): once `d` is used
as an index `[0; simDim]` and once as an index `[0; nComponents]`
and same mixed with `i`.

we now use `n` consequently for vector components (x, y, z and w)
of fields and `d` for *spatial* counts from `0` to `simDim`.
`i` is still used if we iterate over linear memory.
@psychocoderHPC
Copy link
Copy Markdown
Member

Should it be that the ranges in your description are wrong and must be:
[0; simDim-1] and [0; nComponents-1]

@ax3l
Copy link
Copy Markdown
Member Author

ax3l commented Feb 12, 2015

updated, thanks.

psychocoderHPC added a commit that referenced this pull request Feb 12, 2015
HDF5 WriteField: Fix Wrong Doc String and Index
@psychocoderHPC psychocoderHPC merged commit cfa1c65 into ComputationalRadiationPhysics:dev Feb 12, 2015
@ax3l ax3l deleted the topic-hdf5VarsWriteField branch February 12, 2015 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component: plugin in PIConGPU plugin documentation regarding documentation or wiki discussions refactoring code change to improve performance or to unify a concept but does not change public API

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants