FAQ

This section lists frequently asked developer questions.

What is 0.0_rt?

It’s a C++ floating-point literal for zero of type amrex::Real.

We use literals to define constants with a specific type, in that case the zero-value. There is also 0.0_prt, which is a literal zero of type amrex::ParticleReal. In std C++, you know: 0.0 (literal double), 0.0f (literal float) and 0.0L (literal long double). We do not use use those, so that we can configure floating point precision at compile time and use different precision for fields (amrex::Real) and particles (amrex::ParticleReal).

You can also write things like 42.0_prt if you like to have another value than zero.

We use these C++ user literals ([1], [2], [3]), because we want to avoid that double operations, i.e., 3. / 4., implicit casts, or even worse integer operations, i.e., 3 / 4, sneak into the code base and make results wrong or slower.

Do you worry about using size_t vs. uint vs. int for indexing things?

std::size_t is the C++ unsigned int type for all container sizes.

Close to but not necessarily uint, depends on the platform. For “hot” inner loops, you want to use int instead of an unsigned integer type. Why? Because int has no handling for overflows (it is intentional, undefined behavior in C++), which allows compilers to vectorize easier, because they don’t need to check for an overflow every time one reaches the control/condition section of the loop.

C++20 will also add support for ssize (signed size), but we currently require C++17 for builds. Thus, sometimes you need to static_cast<int>(...).

What does std::make_unique do?

make_unique is a C++ factory method that creates a std::unique_ptr<T>.

Follow-up: Why use this over just *my_ptr = new <class>?

Because so-called smart-pointers, such as std::unique_ptr<T>, do delete themselves automatically when they run out of scope. That means: no memory leaks, because you cannot forget to delete them again.

Why name header files .H instead of .h?

This is just a convention that we follow through the code base, which slightly simplifies what we need to parse in our various build systems. We inherited that from AMReX. Generally speaking, C++ file endings can be arbitrary, we just keep them consistent to avoid confusion in the code base.

To be explicit and avoid confusion (with C/ObjC), we might change them all to .hpp and .cpp/.cxx at some point, but for now .H and .cpp is what we do (as in AMReX).

What are #include "..._fwd.H" and #include <...Fwd.H> files?

These are C++ forward declarations. In C++, #include statements copy the referenced header file literally into place, which can increase the compile time of a .cpp file to an object file significantly, especially with transitive header files including each other.

In order to reduce compile time, we define forward declarations in WarpX and AMReX for commonly used, large classes. The C++ standard library also uses that concept, e.g., in iosfwd.

What does const int /*i_buffer*/ mean in argument list?

This is often seen in a derived class, overwriting an interface method. It means we do not name the parameter because we do not use it when we overwrite the interface. But we add the name as a comment /* ... */ so that we know what we ignored when looking at the definition of the overwritten method.