Skip to content

libPMacc unclear syntax and missing documentation

Jump to bottom Edit New page
n01r edited this page Sep 25, 2014 · 2 revisions

This is a list of unclear or missing documentation in libPMacc.

PMACC_AUTO

#define PMACC_AUTO(var,...) BOOST_AUTO(var,(__VA_ARGS__))

What it does:
It emulates the auto specifier that deduces the type of a variable by its initialization.

Why it looks like that:
The keyword auto is only available since C++11. BOOST_AUTO does exactly that and PMACC_AUTO is the PIConGPU-internal implementation.

Syntax:

  • first argument: variable name that you want to use
  • second argument: initialization

Usage of [...] brackets
What do they do exactly and when are they used?
The box brackets enable access to particle attributes of particles stored in frames. Due to the fact that those attributes are initialized by <attribute>_ instead of <attribute>() the access to them had to be redefined.

All wiki entries describe the dev branch. Features may be different in the current master branch.

Before you start please read our README!

PIConGPU is a scientific project. If you present and/or publish scientific results that used PIConGPU, you should set a reference to show your support. Our according up-to-date publication at the time of your publication should be inquired from:

The documentation in this wiki is still not complete and we need your help keeping it up to date. Feel free to help improving this wiki!

Add a custom sidebar

Clone this wiki locally