FieldTmp Operations: Doxygen Strings #1789
Merged
+147
−17
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
ax3l
force-pushed
the
doc-doxyFileOutput
branch
from
8985c1c to
5545287
Compare
PrometheusPi
requested changes
Jan 24, 2017
| */ | ||
|
|
||
| /* Density */ |
There was a problem hiding this comment.
QUESTION:
Why did you remove this comment?
There was a problem hiding this comment.
it's not removed, there is a whole new block now with a real doxygen comment for this class.
| * Each value is mapped per cell according to the species' spatial shape. | ||
| * | ||
| * @note for species that do not change their charge state, this is identical | ||
| * to the density times a constant for the charge, |
There was a problem hiding this comment.
OPTIONAL:
better: a constant for the charge -> the (constant) particle's charge
There was a problem hiding this comment.
thanks, but better plural: the (constant) particles' charge
| * Derives a scalar field with real particle numbers per cell from a particle | ||
| * species at runtime. | ||
| * Each macro particles weighting is assigned straight to the cell it belongs | ||
| * to, which is in most cases as floor operation in space (and not necessarily |
| /** Energy Density Operation for Particle to Grid Projections | ||
| * | ||
| * Derives a scalar field for average kinetic particle energy per cell times the | ||
| * particle density from a particle species at runtime. |
There was a problem hiding this comment.
QUESTION:
Would kinetic particle energy density be not more straight forward?
There was a problem hiding this comment.
nope, the term energy density is quite well defined to be kinetic. If someones does not get that in the title the brief directly explains it in detail.
ax3l
force-pushed
the
doc-doxyFileOutput
branch
2 times, most recently
from
75f9db1 to
842c03b
Compare
n01r
approved these changes
Jan 25, 2017
| * | ||
| * Derives a scalar field with real particle numbers per cell from a particle | ||
| * species at runtime. | ||
| * Each macro particles weighting is assigned straight to the cell it belongs |
| * | ||
| * Derives a scalar field with number of macro particles per cell from a particle | ||
| * species at runtime. | ||
| * Each macro particles is counted straight to the cell it belongs |
ax3l
force-pushed
the
doc-doxyFileOutput
branch
from
842c03b to
0f3bacb
Compare
Adds doxygen strings to the classes that users need to define `FieldTmp` operations in `fileOutput.param` or algorithms such as Thomas Fermi. This can help to understand how to use those and can be more detailed then the small examples we give in `fileOutput.param`.
ax3l
force-pushed
the
doc-doxyFileOutput
branch
from
0f3bacb to
71aab9e
Compare
PrometheusPi
approved these changes
Jan 25, 2017
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.
Adds doxygen strings to the classes that users need to define
FieldTmpoperations infileOutput.paramor algorithms such as Thomas Fermi. This can help to understand how to use those and can be more detailed then the small examples we give infileOutput.param.