defs.h

Go to the documentation of this file.

#ifndef DEFS_H_
#define DEFS_H_
/**
 * @file defs.h
 * @brief This file defines all includes for HILA
 *
 */
// This gives us math constants, e.g. M_PI etc.
#define _USE_MATH_DEFINES
 
// Useful global definitions here -- this file should be included by (almost) all others
 
#include <cstdint>
#include <iostream>
#include <array>
#include <vector>
#include <sstream>
// #include <math.h>
#include <type_traits>
#include <cmath>
#include <iomanip>
 
 
#ifdef HILAPP
#include "hilapp_mpi.h"
#else
#include <mpi.h>
#endif
 
// Read in Makefile tunable parameters first
// NDEBUG is defined (or not) in params, so assert.h comes after
#include "params.h"
 
#include <assert.h>
 
 
#ifdef HILAPP
// The compiler is hilapp
#define __device__
#define __host__
#define __global__
#endif
 
// #include "plumbing/mersenne.h"
#include "plumbing/memalloc.h" // memory allocator
#include "plumbing/timing.h"
 
 
/// Define __restrict__?  It is non-standard but supported by most (all?) compilers.
/// ADD HERE GUARD FOR THOSE WHICH DO not HAVE IT
#define RESTRICT __restrict__
// #ifndef CUDA
// #define RESTRICT __restrict__
// #else
// #define RESTRICT // disabled here
// #endif
 
 
// This below declares "out_only" -qualifier.  It is empty on purpose. Do not remove!
#define out_only
// out_only indicates that the function does not use the original value of the argument:
//    double func( out_only double & p, ..) { ... }
//    func(a);
// This helps hilapp to optimize memory access.  It is not a bug to leave out out_only,
// but it is a bug to "lie", i.e. use the original value of the variable if out_only is
// used.
//
// out_only for class methods tells hilapp that the base variable original value is not
// needed:
// class C {
//    int set() out_only { .. }
// };
// indicates that a.set(); does not need original value of a. e qualifier.
 
// Defined empty on purpose, same as above!
#define const_function
// const_function does not change the base variable, but can return a (non-const)
// reference. Needed typically for access operators for loop extern variables:
//     class v {
//         double c[N];
//         double & e(const int i) const_function { return c[i]; }
//     };
//
//     v vv;
//     Field<v>  f;
//     onsites(ALL) { f[X].e(0) += vv.e(0); }
// This would not work without const_function, because vv.e(0) might modify loop
// extern variable vv, which is not allowed.  If method is marked "const",
// then the assignment would not work.
//
// const_function is weaker than const.
 
 
// text output section -- defines also hila::out0, which writes from node 0 only
 
namespace hila {
 
/// this is our default output file stream
extern std::ostream out;
 
/// This writes output only from main process (node 0)
extern std::ostream out0;
 
/// this is just a hook to store output file, if it is in use
extern std::ofstream output_file;
 
// about_to_finish becomes true at the end.  Signals that
// better not rely on MPI or existence of objects any more.
extern bool about_to_finish;
 
// is the machine initialized?  This is set in hila::setup
// does not tell if lattice is initialized
extern bool is_initialized;
 
// check_input is used to notify that we're just checking the
// input values and will exit before fields are allocated.
extern bool check_input;
extern int check_with_nodes;
 
// optional input filename
extern const char *input_file;
 
enum sort { unsorted, ascending, descending };
 
void initialize(int argc, char **argv);
void finishrun();
void terminate(int status);
void error(const std::string &msg);
void error(const char *msg);
 
 
/// rank of this node
int myrank();
/// how many nodes there are
int number_of_nodes();
/// synchronize mpi
void synchronize();
 
 
} // namespace hila
 
// The logger uses hila::myrank, so it cannot be included on top
#include "plumbing/logger.h"
namespace hila {
/// Now declare the logger
extern logger_class log;
} // namespace hila
 
/// define a class for FFT direction
enum class fft_direction { forward, back };
 
/// Define convenience function sqr(), returning square of argument
template <typename T>
constexpr inline T sqr(const T &arg) {
    return arg * arg;
}
 
namespace hila {
 
// define hila::swap(), because std::swap cannot be used in gpu code
template <typename T>
constexpr inline void swap(T &a, T &b) {
    T c = a;
    a = b;
    b = c;
}
} // namespace hila
 
 
// Backend defs-headers
 
#if defined(CUDA) || defined(HIP)
#include "plumbing/backend_gpu/defs.h"
#elif defined(AVX)
#include "plumbing/backend_vector/defs.h"
#else
#include "plumbing/backend_cpu/defs.h"
#endif
 
// this include has to be after the backend defs, because those define hila::random()
#include "plumbing/random.h"
 
// This contains useful template tools
#include "plumbing/type_tools.h"
 
#include "plumbing/has_unary_minus.h"
 
#if defined(CUDA) || defined(HIP)
#include "plumbing/backend_gpu/gpu_templated_ops.h"
#endif
 
// Include some basic functions for real (non-class) vars,
// to help with generic code
#include "plumbing/real_var_ops.h"
 
// MPI Related functions and definitions
#define MAX_GATHERS 1000
 
 
void initialize_communications(int &argc, char ***argv);
void split_into_partitions(int rank);
bool is_comm_initialized(void);
void finish_communications();
void abort_communications(int status);
 
// and print a dashed line
void print_dashed_line(const std::string &txt = {});
 
 
#endif