Refactor Density Profiles #1762

ax3l · 2017-01-11T17:23:39Z

Needs rebase. Follow-up to ManipulateDeriveSpecies: Refactor Functors & Tests #1761

Refactor "gas density" to general "density profiles", which stays as before a general element density.
The naming is super-outdated.

API Changes:

file renames: gasDensity -> densityConfig
namespaces gasProfiles -> densityProfiles
CreateGas -> CreateDensity
initGas -> initDensityProfile
to do: GAS_ENABLED, ...
to do: in each density profile, rename parameters -> follow up PR with sed replacements
GAS_DENSITY -> BASE_DENSITY (like BASE_CHARGE & BASE_MASS)

n01r · 2017-01-12T09:19:19Z

Oh I can feel it! Solid densities we are coming!

Rename param and unitless file

change to density profile naming

ax3l · 2017-01-16T08:14:12Z

@PrometheusPi @psychocoderHPC let us merge this part already so we can build on the unit system with it.

the left-over parts are just renamings for a follow up with sed scripts.

PrometheusPi

Some minor (required) changes and several (optional) improvements (which I would not see as required due to the time limitation with the upcoming hackathon).

Please also review DensityWeighting.hpp line 60 where the comment would now be outdated.

And as mentioned in the description GAS_ENABLE and variable names and comments in densityConfig.param are outdated.

PrometheusPi · 2017-01-16T08:19:06Z

examples/Bunch/include/simulation_defines/param/densityConfig.param

+     * Individual particle species can define a `densityRatio` flag relative
+     * to this value.
+     *
+     * unit: ELEMENTS/m^3


OPTIONAL:
could you rename ELEMENTS to real particles because electrons are no elements and elements can be mistaken as macro-particles.

(and other places)

I will keep it for now, since I am talking unit here.
real particles is not a unit, maybe number count instead of elements. an other time.

agreed 👍

PrometheusPi · 2017-01-16T08:23:37Z

src/picongpu/include/particles/densityProfiles/FreeFormulaImpl.def

+{
+    template<typename T_ParamClass>
+    struct FreeFormulaImpl;
+}


OPTIONAL:
add a closing comment to the name space

(and other code lines)

we don't do these any more.
https://github.com/ComputationalRadiationPhysics/contributing

😱 why? - I liked them - Okay 👍

Benjamin evangelized us and it's for the better :)
IDEs and all kinds of editors are great enough collapsing those blocks.

https://github.com/ComputationalRadiationPhysics/contributing/blob/master/codingGuideLines/cpp.md#6-namespaces
But I can still see it ^^;

PrometheusPi · 2017-01-16T08:24:35Z

src/picongpu/include/particles/densityProfiles/LinearExponentialImpl.def

+    template<typename T_ParamClass>
+    struct LinearExponentialImpl;
+}
+}


REQUIRED:
please add new line

thanks! added

PrometheusPi · 2017-01-16T08:30:45Z

examples/Bunch/include/simulation_defines/param/densityConfig.param

+    PMACC_STRUCT(GaussianCloudParam,
+        /** Profile Formula:
+         *     exponent = |globalCellPos - center| / sigma
+         *     density = e^[ gasFactor * exponent^gasPower ]


OPTIONAL:
comment still contains gasFactor and gasPower more suitable would be density...

also lines 51, 52, 62 and 67 of this file

yes, those are in-gas-profile parameters that are still used. I mentioned to rather do those via an sed PR later on. Fleißarbeit.

PrometheusPi · 2017-01-16T08:32:20Z

examples/Bunch/include/simulation_defines/param/densityConfig.param

+        (PMACC_C_VECTOR_DIM(float_64, simDim, sigma_SI, 6.0e-6, 6.0e-6, 6.0e-6))
+    ); /* struct GaussianCloudParam */
+
+    /* definition of gas cloud profile*/


REQUIRED:
gas is outdated - please remove or replace by density

PrometheusPi · 2017-01-16T08:33:49Z

examples/LaserWakefield/include/simulation_defines/param/densityConfig.param

+{
+    PMACC_STRUCT(GaussianParameter,
+        /** Profile Formula:
+         *   constexpr float_X exponent = abs((y - gasCenter_SI) / gasSigma_SI);


OPTIONAL:
Comment still contains gas (here it is OK, since it is really a gas) - however @ax3l do you want to adjust this for consistency?

also lines: 49, 51, 52, 53, 55, 56, 67, 70, 71, 73, 76, 77

as above: parameters of the specific profiles via sed in a follow-up.

PrometheusPi · 2017-01-16T08:36:44Z

src/picongpu/include/particles/densityProfiles/LinearExponentialImpl.hpp

 namespace picongpu
 {
-
-namespace gasProfiles
+namespace densityProfiles


OPTIONAL:
In this file several variables are still names gas... - might be good to change naming as well

see above: specific profile -> sed -> an other PR

PrometheusPi · 2017-01-16T08:37:55Z

src/picongpu/include/simulation_defines/param/densityConfig.param

+{
+    PMACC_STRUCT(GaussianParam,
+        /** Profile Formula:
+         *   const float_X exponent = abs((y - gasCenter_SI) / gasSigma_SI);


OPTIONAL:
several variables are still names gas... in this file.

see above: specific profile -> sed -> an other PR

psychocoderHPC · 2017-01-16T09:58:40Z

src/picongpu/include/simulation_defines/unitless/visualization.unitless

@@ -40,18 +40,18 @@ namespace picongpu

    // setting 3: Plasma Wave
 #if( EM_FIELD_SCALE_CHANNEL1 == 3 || EM_FIELD_SCALE_CHANNEL2 == 3 || EM_FIELD_SCALE_CHANNEL3 == 3 )
-    PMACC_CASSERT_MSG( You_can_not_scale_your_preview_to_a_zero_plasma_density___change_visualization_param, ((GAS_DENSITY)>0.0 && gasProfile::GAS_ENABLED) );
+    PMACC_CASSERT_MSG( You_can_not_scale_your_preview_to_a_zero_plasma_density___change_visualization_param, ((BASE_DENSITY)>0.0 && densityProfile::GAS_ENABLED) );


I can't find the definition of GAS_ENABLED, this looks like a BUG.

Please remove GAS_ENABLED.

So outdated, not even defined any more o.0

ax3l · 2017-01-16T10:11:47Z

@PrometheusPi @psychocoderHPC all comments addressed, thanks!

as said above, specific profile's parameters can be renamed with an sed script in a later PR.

PrometheusPi · 2017-01-16T12:15:51Z

@psychocoderHPC do you approve @ax3l's changes?

ax3l added component: examples PIConGPU or PMacc examples refactoring code change to improve performance or to unify a concept but does not change public API labels Jan 11, 2017

ax3l added this to the Next Stable: 0.3.0 / 1.0.0 milestone Jan 11, 2017

ax3l force-pushed the topic-refactorDensity branch from 151c23b to afce1d9 Compare January 11, 2017 23:19

ax3l added 9 commits January 16, 2017 09:12

gasConfig -> densityConfig

25ab1df

Rename param and unitless file

Density Profiles: Rename Dir & Namespaces

18b6b68

densityConfig: rename namespaces & style

c6168f1

speciesInitialization: namespace & comment

aebf3e5

change to density profile naming

speciesAttributes: density profile naming

f81e5f5

Loader: density naming

c42ab5e

CreateGas -> CreateDensity

c0ec614

BASE_DENSITY as in Mass & Charge

03eb582

Particles: initGas -> initDensityProfile

7dd9d22

ax3l changed the title ~~[WIP] Refactor Density Profiles~~ Refactor Density Profiles Jan 16, 2017

ax3l force-pushed the topic-refactorDensity branch from afce1d9 to 7dd9d22 Compare January 16, 2017 08:12

PrometheusPi self-assigned this Jan 16, 2017

PrometheusPi requested changes Jan 16, 2017

View reviewed changes

psychocoderHPC requested changes Jan 16, 2017

View reviewed changes

ax3l added 4 commits January 16, 2017 11:02

Remove GAS_ENABLED

2d32862

So outdated, not even defined any more o.0

Remove Outdated Comment: CreateDensity

0d2fc76

Add missing EOF Newline

15bdabc

Bunch: Minor Comment Updates

02b1eb2

PrometheusPi approved these changes Jan 16, 2017

View reviewed changes

psychocoderHPC approved these changes Jan 16, 2017

View reviewed changes

psychocoderHPC merged commit 81082d1 into ComputationalRadiationPhysics:dev Jan 16, 2017

ax3l deleted the topic-refactorDensity branch January 16, 2017 12:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor Density Profiles #1762

Refactor Density Profiles #1762

ax3l commented Jan 11, 2017 •

edited

Loading

n01r commented Jan 12, 2017

ax3l commented Jan 16, 2017

PrometheusPi left a comment •

edited

Loading

PrometheusPi Jan 16, 2017

ax3l Jan 16, 2017

PrometheusPi Jan 16, 2017

PrometheusPi Jan 16, 2017

ax3l Jan 16, 2017

PrometheusPi Jan 16, 2017 •

edited

Loading

ax3l Jan 16, 2017 •

edited

Loading

n01r Jan 23, 2017

PrometheusPi Jan 16, 2017

ax3l Jan 16, 2017

PrometheusPi Jan 16, 2017

ax3l Jan 16, 2017

PrometheusPi Jan 16, 2017

ax3l Jan 16, 2017

PrometheusPi Jan 16, 2017

PrometheusPi Jan 16, 2017

ax3l Jan 16, 2017 •

edited

Loading

PrometheusPi Jan 16, 2017

ax3l Jan 16, 2017

PrometheusPi Jan 16, 2017

ax3l Jan 16, 2017

psychocoderHPC Jan 16, 2017

ax3l Jan 16, 2017

ax3l commented Jan 16, 2017

PrometheusPi commented Jan 16, 2017

Refactor Density Profiles #1762

Refactor Density Profiles #1762

Conversation

ax3l commented Jan 11, 2017 • edited Loading

n01r commented Jan 12, 2017

ax3l commented Jan 16, 2017

PrometheusPi left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PrometheusPi Jan 16, 2017 • edited Loading

Choose a reason for hiding this comment

ax3l Jan 16, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ax3l Jan 16, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ax3l commented Jan 16, 2017

PrometheusPi commented Jan 16, 2017

ax3l commented Jan 11, 2017 •

edited

Loading

PrometheusPi left a comment •

edited

Loading

PrometheusPi Jan 16, 2017 •

edited

Loading

ax3l Jan 16, 2017 •

edited

Loading

ax3l Jan 16, 2017 •

edited

Loading