Styleguide: How to include
We haven't agreed on a consistent procedure of including header files.
In the cpu-part most header files are incuded just by the name:
#include "LBMkernel.h"
This is realized with an include-path, which is set in the CMakeLists file.
In our other libraries, we are including with the corresponding subfolder:
#include "constant/NumericConstant.h"
Actually, I would like to have that we also make use of the underlying library folder:
#include "lbm/constant/NumericConstant.h"
Doing this I see two big advantages:
- a reader can see directly where a header files comes from
- we avoid naming conflicts, if there are several times the same header name in different libraries
The disadvantage is of course that the include path size increases.