[alexxy/gromacs.git] / src / gromacs / domdec / domdec_internal.h

/*
 * This file is part of the GROMACS molecular simulation package.
 *
 * Copyright (c) 2014,2015,2016,2017,2018,2019, by the GROMACS development team, led by
 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
 * and including many others, as listed in the AUTHORS file in the
 * top-level source directory and at http://www.gromacs.org.
 *
 * GROMACS is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * GROMACS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with GROMACS; if not, see
 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
 *
 * If you want to redistribute modifications to GROMACS, please
 * consider that scientific software is very special. Version
 * control is crucial - bugs must be traceable. We will be happy to
 * consider code for inclusion in the official distribution, but
 * derived work must not be called official GROMACS. Details are found
 * in the README & COPYING files - if they are missing, get the
 * official version at http://www.gromacs.org.
 *
 * To help us fund GROMACS development, we humbly ask that you cite
 * the research papers on the package. Check out http://www.gromacs.org.
 */
/*! \internal \file
 *
 * \brief Declares implementation functions and types for the domain
 * decomposition module.
 *
 * \author Berk Hess <hess@kth.se>
 * \ingroup module_domdec
 */
#ifndef GMX_DOMDEC_DOMDEC_INTERNAL_H
#define GMX_DOMDEC_DOMDEC_INTERNAL_H

#include "config.h"

#include "gromacs/domdec/domdec.h"
#include "gromacs/domdec/domdec_struct.h"
#include "gromacs/mdlib/updategroupscog.h"
#include "gromacs/timing/cyclecounter.h"
#include "gromacs/topology/block.h"

struct t_commrec;

/*! \cond INTERNAL */

#define DD_NLOAD_MAX 9

struct BalanceRegion;

//! Indices to communicate in a dimension
struct gmx_domdec_ind_t
{
    //! @{
    /*! \brief The numbers of charge groups to send and receive for each
     * cell that requires communication, the last entry contains the total
     * number of atoms that needs to be communicated.
     */
    int              nsend[DD_MAXIZONE+2] = {};
    int              nrecv[DD_MAXIZONE+2] = {};
    //! @}
    //! The charge groups to send
    std::vector<int> index;
    //! @{
    /* The atom range for non-in-place communication */
    int              cell2at0[DD_MAXIZONE] = {};
    int              cell2at1[DD_MAXIZONE] = {};
    //! @}
};

//! Things relating to index communication
struct gmx_domdec_comm_dim_t
{
    /* Returns the number of grid pulses (the number of domains in the halo along this dimension) */
    int numPulses() const
    {
        return ind.size();
    }

    /**< For dlb, for use with edlbAUTO          */
    int                           np_dlb = 0;
    /**< The indices to communicate, size np     */
    std::vector<gmx_domdec_ind_t> ind;
    /**< Can we receive data in place?            */
    bool                          receiveInPlace = false;
};

/*! \brief Load balancing data along a dim used on the master rank of that dim */
struct RowMaster
{
    struct Bounds
    {
        /**< State var.: max lower bound., incl. neighbors */
        real cellFracLowerMax = 0;
        /**< State var.: min upper bound., incl. neighbors */
        real cellFracUpperMin = 0;
        /**< Temp. var.: lower limit for cell boundary */
        real boundMin = 0;
        /**< Temp. var.: upper limit for cell boundary */
        real boundMax = 0;
    };

    /**< Temp. var.: is this cell size at the limit */
    std::vector<bool>   isCellMin;
    /**< State var.: cell boundaries, box relative */
    std::vector<real>   cellFrac;
    /**< Temp. var.: old cell size */
    std::vector<real>   oldCellFrac;
    /**< Cell bounds */
    std::vector<Bounds> bounds;
    /**< State var.: is DLB limited in this row */
    bool                dlbIsLimited = false;
    /**< Temp. var.  */
    std::vector<real>   buf_ncd;
};

/*! \brief Struct for managing cell sizes with DLB along a dimension */
struct DDCellsizesWithDlb
{
    /**< Cell row root struct, only available on the first rank in a row */
    std::unique_ptr<RowMaster> rowMaster;
    /**< The cell sizes, in fractions, along a row, not available on the first rank in a row */
    std::vector<real>          fracRow;
    /**< The lower corner, in fractions, in triclinic space */
    real                       fracLower = 0;
    /**< The upper corner, in fractions, in triclinic space */
    real                       fracUpper = 0;
    /**< The maximum lower corner among all our neighbors */
    real                       fracLowerMax = 0;
    /**< The minimum upper corner among all our neighbors */
    real                       fracUpperMin = 0;
};

/*! \brief Struct for compute load commuication
 *
 * Here floats are accurate enough, since these variables
 * only influence the load balancing, not the actual MD results.
 */
typedef struct
{
    /**< The number of load recordings */
    int    nload = 0;
    /**< Scan of the sum of load over dimensions */
    float *load = nullptr;
    /**< The sum of the load over the ranks up to our current dimension */
    float  sum = 0;
    /**< The maximum over the ranks contributing to \p sum */
    float  max = 0;
    /**< Like \p sum, but takes the maximum when the load balancing is limited */
    float  sum_m = 0;
    /**< Minimum cell volume, relative to the box */
    float  cvol_min = 0;
    /**< The PP time during which PME can overlap */
    float  mdf = 0;
    /**< The PME-only rank load */
    float  pme = 0;
    /**< Bit flags that tell if DLB was limited, per dimension */
    int    flags = 0;
} domdec_load_t;

/*! \brief Data needed to sort an atom to the desired location in the local state */
typedef struct
{
    /**< Neighborsearch grid cell index */
    int  nsc = 0;
    /**< Global atom/charge group index */
    int  ind_gl = 0;
    /**< Local atom/charge group index */
    int  ind = 0;
} gmx_cgsort_t;

/*! \brief Temporary buffers for sorting atoms */
typedef struct
{
    /**< Sorted array of indices */
    std::vector<gmx_cgsort_t> sorted;
    /**< Array of stationary atom/charge group indices */
    std::vector<gmx_cgsort_t> stationary;
    /**< Array of moved atom/charge group indices */
    std::vector<gmx_cgsort_t> moved;
    /**< Integer buffer for sorting */
    std::vector<int>          intBuffer;
} gmx_domdec_sort_t;

/*! \brief Manages atom ranges and order for the local state atom vectors */
class DDAtomRanges
{
    public:
        /*! \brief The local state atom order
         *
         * This enum determines the order of the atoms in the local state.
         * ddnatHOME and ddnatZONE should be first and second,
         * the others can be ordered as wanted.
         */
        enum class Type : int
        {
            Home,        /**< The home atoms */
            Zones,       /**< All zones in the eighth shell */
            Vsites,      /**< Atoms communicated for virtual sites */
            Constraints, /**< Atoms communicated for constraints */
            Number       /**< Not a count, only present for convenience */
        };

        /*! \brief Returns the start atom index for range \p rangeType */
        int start(Type rangeType) const
        {
            if (rangeType == Type::Home)
            {
                return 0;
            }
            else
            {
                return end_[static_cast<int>(rangeType) - 1];
            }
        }

        /*! \brief Returns the end atom index for range \p rangeType */
        int end(Type rangeType) const
        {
            return end_[static_cast<int>(rangeType)];
        }

        /*! \brief Returns the number of home atoms */
        int numHomeAtoms() const
        {
            return end_[static_cast<int>(Type::Home)];
        }

        /*! \brief Returns the total number of atoms */
        int numAtomsTotal() const
        {
            return end_[static_cast<int>(Type::Number) - 1];
        }

        /*! \brief Sets the end index of range \p rangeType to \p end
         *
         * This should be called either with Type::Home or with a type
         * that is larger than that passed in the previous call to setEnd.
         * A release assertion for these conditions are present.
         */
        void setEnd(Type rangeType,
                    int  end)
        {
            GMX_RELEASE_ASSERT(rangeType == Type::Home || rangeType > lastTypeSet_, "Can only set either home or a larger type than the last one");

            for (int i = static_cast<int>(rangeType); i < static_cast<int>(Type::Number); i++)
            {
                end_[i] = end;
            }

            lastTypeSet_ = rangeType;
        }

    private:
        /*! \brief The list of end atom indices */
        std::array<int, static_cast<int>(Type::Number)> end_;
        Type                                            lastTypeSet_ = Type::Number;
};

/*! \brief Enum of dynamic load balancing states
 *
 * Allowed DLB states and transitions
 * - intialization at startup:
 *                             -> offUser ("-dlb no")
 *                             -> onUser  ("-dlb yes")
 *                             -> offCanTurnOn ("-dlb auto")
 *
 * - in automatic mode (i.e. initial state offCanTurnOn):
 *   offCanTurnOn         -> onCanTurnOff
 *   offCanTurnOn         -> offForever
 *   offCanTurnOn         -> offTemporarilyLocked
 *   offTemporarilyLocked -> offCanTurnOn
 *   onCanTurnOff         -> offCanTurnOn
 */
enum class DlbState
{
    offUser,              /**< DLB is permanently off per user request */
    offForever,           /**< DLB is off due to a runtime condition (not supported or causes performance loss) and will never be turned on */
    offCanTurnOn,         /**< DLB is off and will turn on on imbalance */
    offTemporarilyLocked, /**< DLB is off and temporarily can't turn on */
    onCanTurnOff,         /**< DLB is on and can turn off when slow */
    onUser,               /**< DLB is permanently on per user request */
    nr                    /**< The number of DLB states */
};

/*! \brief The PME domain decomposition for one dimension */
typedef struct
{
    /**< The dimension */
    int      dim = 0;
    /**< Tells if DD and PME dims match */
    gmx_bool dim_match = false;
    /**< The number of PME ranks/domains in this dimension */
    int      nslab = 0;
    /**< Cell sizes for determining the PME comm. with SLB */
    real    *slb_dim_f = nullptr;
    /**< The minimum pp node location, size nslab */
    int     *pp_min = nullptr;
    /**< The maximum pp node location, size nslab */
    int     *pp_max = nullptr;
    /**< The maximum shift for coordinate redistribution in PME */
    int      maxshift = 0;
} gmx_ddpme_t;

struct gmx_ddzone_t
{
    /**< The minimum bottom of this zone                        */
    real min0 = 0;
    /**< The maximum top of this zone                           */
    real max1 = 0;
    /**< The minimum top of this zone                           */
    real min1 = 0;
    /**< The maximum bottom communicaton height for this zone   */
    real mch0 = 0;
    /**< The maximum top communicaton height for this zone      */
    real mch1 = 0;
    /**< The bottom value of the first cell in this zone        */
    real p1_0 = 0;
    /**< The top value of the first cell in this zone           */
    real p1_1 = 0;
    /**< Bool disguised as a real, 1 when the above data has been set. 0 otherwise */
    real dataSet = 0;
};

/*! \brief The number of reals in gmx_ddzone_t */
constexpr int c_ddzoneNumReals = 8;

template<typename T> class DDBufferAccess;

/*! \brief Temporary storage container that minimizes (re)allocation and clearing
 *
 * This is only the storage, actual access happens through DDBufferAccess.
 * All methods check if the buffer is (not) in use.
 */
template<typename T>
class DDBuffer
{
    private:
        /*! \brief Returns a buffer of size \p numElements, the elements are undefined */
        gmx::ArrayRef<T> resize(size_t numElements)
        {
            GMX_ASSERT(isInUse_, "Should only operate on acquired buffers");

            if (numElements > buffer_.size())
            {
                buffer_.resize(numElements);
            }

            return gmx::arrayRefFromArray(buffer_.data(), numElements);
        }

        /*! \brief Acquire the buffer for use with size set to \p numElements, the elements are undefined */
        gmx::ArrayRef<T> acquire(size_t numElements)
        {
            GMX_RELEASE_ASSERT(!isInUse_, "Should only request free buffers");
            isInUse_ = true;

            return resize(numElements);
        }

        /*! \brief Releases the buffer, buffer_ should not be used after this */
        void release()
        {
            GMX_RELEASE_ASSERT(isInUse_, "Should only release buffers in use");
            isInUse_ = false;
        }

        std::vector<T> buffer_;          /**< The actual memory buffer */
        bool           isInUse_ = false; /**< Flag that tells whether the buffer is in use */

        friend class DDBufferAccess<T>;
};

/*! \brief Class that manages access to a temporary memory buffer */
template<typename T>
class DDBufferAccess
{
    public:
        /*! \brief Constructor, returns a buffer of size \p numElements, element values are undefined
         *
         * \note The actual memory buffer \p ddBuffer can not be used to
         *       create other DDBufferAccess objects until the one created
         *       here is destroyed.
         */
        DDBufferAccess(DDBuffer<T> &ddBuffer,
                       size_t       numElements) :
            ddBuffer_(ddBuffer)
        {
            buffer = ddBuffer_.acquire(numElements);
        }

        ~DDBufferAccess()
        {
            ddBuffer_.release();
        }

        /*! \brief Resizes the buffer to \p numElements, new elements are undefined
         *
         * \note The buffer arrayref is updated after this call.
         */
        void resize(size_t numElements)
        {
            buffer = ddBuffer_.resize(numElements);
        }

    private:
        DDBuffer<T>      &ddBuffer_; /**< Reference to the storage class */
    public:
        gmx::ArrayRef<T>  buffer;    /**< The access to the memory buffer */
};

/*! \brief Temporary buffer for setting up communiation over one pulse and all zones in the halo */
struct dd_comm_setup_work_t
{
    /**< The local atom group indices to send */
    std::vector<int>       localAtomGroupBuffer;
    /**< Buffer for collecting the global atom group indices to send */
    std::vector<int>       atomGroupBuffer;
    /**< Buffer for collecting the atom group positions to send */
    std::vector<gmx::RVec> positionBuffer;
    /**< The number of atoms contained in the atom groups to send */
    int                    nat = 0;
    /**< The number of atom groups to send for the last zone */
    int                    nsend_zone = 0;
};

/*! \brief Struct for domain decomposition communication
 *
 * This struct contains most information about domain decomposition
 * communication setup, some communication buffers, some statistics
 * and also the setup for the communication between particle-particle
 * and PME only ranks.
 *
 * All arrays are indexed with 0 to dd->ndim (not Cartesian indexing),
 * unless stated otherwise.
 */
struct gmx_domdec_comm_t // NOLINT (clang-analyzer-optin.performance.Padding)
{
    /* PME and Cartesian communicator stuff */
    /**< The number of decomposition dimensions for PME, 0: no PME */
    int         npmedecompdim = 0;
    /**< The number of ranks doing PME (PP/PME or only PME) */
    int         npmenodes = 0;
    /**< The number of PME ranks/domains along x */
    int         npmenodes_x = 0;
    /**< The number of PME ranks/domains along y */
    int         npmenodes_y = 0;
    /**< Use Cartesian communication between PP and PME ranks */
    gmx_bool    bCartesianPP_PME = false;
    /**< Cartesian grid for combinted PP+PME ranks */
    ivec        ntot = { };
    /**< The number of dimensions for the PME setup that are Cartesian */
    int         cartpmedim = 0;
    /**< The PME ranks, size npmenodes */
    int        *pmenodes = nullptr;
    /**< The Cartesian index to sim rank conversion, used with bCartesianPP_PME */
    int        *ddindex2simnodeid = nullptr;
    /**< The 1D or 2D PME domain decomposition setup */
    gmx_ddpme_t ddpme[2];

    /* The DD particle-particle nodes only */
    /**< Use a Cartesian communicator for PP */
    gmx_bool bCartesianPP = false;
    /**< The Cartesian index to DD rank conversion, used with bCartesianPP */
    int     *ddindex2ddnodeid = nullptr;

    /* The DLB state, used for reloading old states, during e.g. EM */
    /**< The global charge groups, this defined the DD state (except for the DLB state) */
    t_block cgs_gl = { };

    /* Charge group / atom sorting */
    /**< Data structure for cg/atom sorting */
    std::unique_ptr<gmx_domdec_sort_t> sort;

    //! True when update groups are used
    bool                                  useUpdateGroups = false;
    //!  Update atom grouping for each molecule type
    std::vector<gmx::RangePartitioning>   updateGroupingPerMoleculetype;
    //! Centers of mass of local update groups
    std::unique_ptr<gmx::UpdateGroupsCog> updateGroupsCog;

    /* Are there charge groups? */
    bool haveInterDomainBondeds          = false; /**< Are there inter-domain bonded interactions? */
    bool haveInterDomainMultiBodyBondeds = false; /**< Are there inter-domain multi-body interactions? */

    /* Data for the optional bonded interaction atom communication range */
    /**< Only communicate atoms beyond the non-bonded cut-off when they are involved in bonded interactions with non-local atoms */
    gmx_bool  bBondComm = false;
    /**< Links between cg's through bonded interactions */
    t_blocka *cglink = nullptr;
    /**< Local cg availability, TODO: remove when group scheme is removed */
    char     *bLocalCG = nullptr;

    /* The DLB state, possible values are defined above */
    DlbState dlbState;
    /* With dlbState=DlbState::offCanTurnOn, should we check if to DLB on at the next DD? */
    gmx_bool bCheckWhetherToTurnDlbOn = false;
    /* The first DD count since we are running without DLB */
    int      ddPartioningCountFirstDlbOff = 0;

    /* Cell sizes for static load balancing, first index cartesian */
    real **slb_frac = nullptr;

    /* The width of the communicated boundaries */
    /**< Cut-off for multi-body interactions, also 2-body bonded when \p cutoff_mody > \p cutoff */
    real     cutoff_mbody = 0;
    /**< Cut-off for non-bonded/2-body interactions */
    real     cutoff = 0;
    /**< The minimum guaranteed cell-size, Cartesian indexing */
    rvec     cellsize_min = { };
    /**< The minimum guaranteed cell-size with dlb=auto */
    rvec     cellsize_min_dlb = { };
    /**< The lower limit for the DD cell size with DLB */
    real     cellsize_limit = 0;
    /**< Effectively no NB cut-off limit with DLB for systems without PBC? */
    gmx_bool bVacDLBNoLimit = false;

    /** With PME load balancing we set limits on DLB */
    gmx_bool bPMELoadBalDLBLimits = false;
    /** DLB needs to take into account that we want to allow this maximum
     *  cut-off (for PME load balancing), this could limit cell boundaries.
     */
    real PMELoadBal_max_cutoff = 0;

    /**< tric_dir from \p gmx_ddbox_t is only stored here because dd_get_ns_ranges needs it */
    ivec tric_dir = { };
    /**< box lower corner, required with dim's without pbc and -gcom */
    rvec box0 = { };
    /**< box size, required with dim's without pbc and -gcom */
    rvec box_size = { };

    /**< The DD cell lower corner, in triclinic space */
    rvec cell_x0 = { };
    /**< The DD cell upper corner, in triclinic space */
    rvec cell_x1 = { };

    /**< The old \p cell_x0, to check cg displacements */
    rvec old_cell_x0 = { };
    /**< The old \p cell_x1, to check cg displacements */
    rvec old_cell_x1 = { };

    /** The communication setup and charge group boundaries for the zones */
    gmx_domdec_zones_t zones;

    /* The zone limits for DD dimensions 1 and 2 (not 0), determined from
     * cell boundaries of neighboring cells for staggered grids when using
     * dynamic load balancing.
     */
    /**< Zone limits for dim 1 with staggered grids */
    gmx_ddzone_t zone_d1[2];
    /**< Zone limits for dim 2 with staggered grids */
    gmx_ddzone_t zone_d2[2][2];

    /** The coordinate/force communication setup and indices */
    gmx_domdec_comm_dim_t cd[DIM];
    /** The maximum number of cells to communicate with in one dimension */
    int                   maxpulse = 0;

    /** Which cg distribution is stored on the master node,
     *  stored as DD partitioning call count.
     */
    int64_t master_cg_ddp_count = 0;

    /** The number of cg's received from the direct neighbors */
    int  zone_ncg1[DD_MAXZONE] = {0};

    /** The atom ranges in the local state */
    DDAtomRanges atomRanges;

    /** Array for signalling if atoms have moved to another domain */
    std::vector<int> movedBuffer;

    /** Communication int buffer for general use */
    DDBuffer<int> intBuffer;

    /** Communication rvec buffer for general use */
    DDBuffer<gmx::RVec> rvecBuffer;

    /* Temporary storage for thread parallel communication setup */
    /**< Thread-local work data */
    std::vector<dd_comm_setup_work_t> dth;

    /* Communication buffer only used with multiple grid pulses */
    /**< Another rvec comm. buffer */
    DDBuffer<gmx::RVec> rvecBuffer2;

    /* Communication buffers for local redistribution */
    /**< Charge group flag comm. buffers */
    std::array<std::vector<int>, DIM*2>       cggl_flag;
    /**< Charge group center comm. buffers */
    std::array<std::vector<gmx::RVec>, DIM*2> cgcm_state;

    /* Cell sizes for dynamic load balancing */
    std::vector<DDCellsizesWithDlb> cellsizesWithDlb;

    /* Stuff for load communication */
    /**< Should we record the load */
    gmx_bool        bRecordLoad = false;
    /**< The recorded load data */
    domdec_load_t  *load = nullptr;
    /**< The number of MPI ranks sharing the GPU our rank is using */
    int             nrank_gpu_shared = 0;
#if GMX_MPI
    /**< The MPI load communicator */
    MPI_Comm       *mpi_comm_load = nullptr;
    /**< The MPI load communicator for ranks sharing a GPU */
    MPI_Comm        mpi_comm_gpu_shared;
#endif

    /* Information for managing the dynamic load balancing */
    /**< Maximum DLB scaling per load balancing step in percent */
    int            dlb_scale_lim = 0;

    /**< Struct for timing the force load balancing region */
    BalanceRegion *balanceRegion = nullptr;

    /* Cycle counters over nstlist steps */
    /**< Total cycles counted */
    float  cycl[ddCyclNr] = { };
    /**< The number of cycle recordings */
    int    cycl_n[ddCyclNr] = { };
    /**< The maximum cycle count */
    float  cycl_max[ddCyclNr] = { };
    /** Flop counter (0=no,1=yes,2=with (eFlop-1)*5% noise */
    int    eFlop = 0;
    /**< Total flops counted */
    double flop = 0.0;
    /**< The number of flop recordings */
    int    flop_n = 0;
    /** How many times did we have load measurements */
    int    n_load_have = 0;
    /** How many times have we collected the load measurements */
    int    n_load_collect = 0;

    /* Cycle count history for DLB checks */
    /**< The averaged cycles per step over the last nstlist step before turning on DLB */
    float       cyclesPerStepBeforeDLB = 0;
    /**< The running average of the cycles per step during DLB */
    float       cyclesPerStepDlbExpAverage = 0;
    /**< Have we turned off DLB (after turning DLB on)? */
    bool        haveTurnedOffDlb = false;
    /**< The DD step at which we last measured that DLB off was faster than DLB on, 0 if there was no such step */
    int64_t     dlbSlowerPartitioningCount = 0;

    /* Statistics for atoms */
    /**< The atoms per range, summed over the steps */
    double sum_nat[static_cast<int>(DDAtomRanges::Type::Number)] = { };

    /* Statistics for calls and times */
    /**< The number of partioning calls */
    int    ndecomp = 0;
    /**< The number of load recordings */
    int    nload = 0;
    /**< Total MD step time */
    double load_step = 0.0;
    /**< Total PP force time */
    double load_sum = 0.0;
    /**< Max \p load_sum over the ranks */
    double load_max = 0.0;
    /**< Was load balancing limited, per DD dim */
    ivec   load_lim = { };
    /**< Total time on PP done during PME overlap time */
    double load_mdf = 0.0;
    /**< Total time on our PME-only rank */
    double load_pme = 0.0;

    /** The last partition step */
    int64_t partition_step = 0;

    /* Debugging */
    /**< Step interval for dumping the local+non-local atoms to pdb */
    int  nstDDDump = 0;
    /**< Step interval for duming the DD grid to pdb */
    int  nstDDDumpGrid = 0;
    /**< DD debug print level: 0, 1, 2 */
    int  DD_debug = 0;
};

/*! \brief DD zone permutation
 *
 * Zone permutation from the Cartesian x-major/z-minor order to an order
 * that leads to consecutive charge groups for neighbor searching.
 * TODO: remove when the group scheme is removed
 */
static const int zone_perm[3][4] = { {0, 0, 0, 0}, {1, 0, 0, 0}, {3, 0, 1, 2} };

/*! \brief DD zone reordering to Cartesian order
 *
 * Index to reorder the zone such that the end up in Cartesian order
 * with dimension index 0 major and dimension index 2 minor.
 */
static const int zone_reorder_cartesian[DD_MAXZONE] = { 0, 1, 3, 2, 5, 4, 6, 7 };

/* dd_zo and dd_zp3 is set up such that i zones with non-zero
 * components see only j zones with that component 0.
 */

/*! \brief Returns the DD cut-off distance for multi-body interactions */
real dd_cutoff_multibody(const gmx_domdec_t *dd);

/*! \brief Returns the DD cut-off distance for two-body interactions */
real dd_cutoff_twobody(const gmx_domdec_t *dd);

/*! \brief Returns the domain index given the number of domains and the domain coordinates
 *
 * This order is required to minimize the coordinate communication in PME
 * which uses decomposition in the x direction.
 */
static inline int dd_index(const ivec numDomains,
                           const ivec domainCoordinates)
{
    return ((domainCoordinates[XX]*numDomains[YY] + domainCoordinates[YY])*numDomains[ZZ]) + domainCoordinates[ZZ];
};

/*! Returns the size of the buffer to hold fractional cell boundaries for DD dimension index dimIndex */
static inline int ddCellFractionBufferSize(const gmx_domdec_t *dd,
                                           int                 dimIndex)
{
    return dd->nc[dd->dim[dimIndex ]] + 1 + dimIndex*2 + 1 + dimIndex;
}

/*! \brief Maximum number of ranks for using send/recv for state scattering and gathering
 *
 * Use separate MPI send and receive commands
 * when #ranks <= c_maxNumRanksUseSendRecvForScatterAndGather
 * This saves memory (and some copying for small #ranks).
 * For high parallelization scatter and gather calls are used.
 */
static constexpr int c_maxNumRanksUseSendRecvForScatterAndGather = 4;

/*! \brief Make DD cells larger by this factor than the limit to avoid rounding issues */
static constexpr double DD_CELL_MARGIN       = 1.0001;

/*! \brief Factor for checking DD cell size limitation during DLB, should be in between 1 and DD_CELL_MARGIN */
static constexpr double DD_CELL_MARGIN2      = 1.00005;

/*! \brief With pressure scaling, keep cell sizes 2% above the limit to allow for some scaling */
static constexpr double DD_PRES_SCALE_MARGIN = 1.02;

/*! \endcond */

#endif