src/gromacs/math/matrix.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \libinternal
  36  * \file
  37  * \brief Declares special case of 3x3 matrix frequently used, and associated functions.
  38  *
  39  * \author Christian Blau <cblau@gwdg.de>
  40  * \ingroup module_math
  41  */
  42
  43 #ifndef GMX_MATH_MATRIX_H_
  44 #define GMX_MATH_MATRIX_H_
  45
  46 #include <array>
  47
  48 #include "gromacs/math/multidimarray.h"
  49 #include "gromacs/math/vec.h"
  50 #include "gromacs/utility/real.h"
  51
  52 namespace gmx
  53 {
  54
  55 /*! \brief Three-by-three matrix of ElementType.
  56  * \tparam ElementType type of element to be stored in matrix
  57  */
  58 template<class ElementType>
  59 using BasicMatrix3x3 = MultiDimArray<std::array<ElementType, 3 * 3>, extents<3, 3>>;
  60
  61 /*! \brief Three-by-three real number matrix.
  62  * \note will replace the C-style real[3][3] "matrix"
  63  */
  64 using Matrix3x3 = BasicMatrix3x3<real>;
  65 //! Convenience alias for a matrix view
  66 using Matrix3x3Span = Matrix3x3::view_type;
  67 //! Convenience alias for a const matrix view
  68 using Matrix3x3ConstSpan = Matrix3x3::const_view_type;
  69
  70 //! Determinant of a 3x3 matrix
  71 constexpr real determinant(Matrix3x3ConstSpan matrix)
  72 {
  73     return (matrix(0, 0) * (matrix(1, 1) * matrix(2, 2) - matrix(2, 1) * matrix(1, 2))
  74             - matrix(1, 0) * (matrix(0, 1) * matrix(2, 2) - matrix(2, 1) * matrix(0, 2))
  75             + matrix(2, 0) * (matrix(0, 1) * matrix(1, 2) - matrix(1, 1) * matrix(0, 2)));
  76 }
  77
  78 //! Calculates the trace of a 3x3 matrix view
  79 constexpr real trace(Matrix3x3ConstSpan matrixView)
  80 {
  81     return matrixView(0, 0) + matrixView(1, 1) + matrixView(2, 2);
  82 }
  83
  84 //! Calculate the transpose of a 3x3 matrix, from its view
  85 static Matrix3x3 transpose(Matrix3x3ConstSpan matrixView)
  86 {
  87
  88     return Matrix3x3({ matrixView(0, 0), matrixView(1, 0), matrixView(2, 0), matrixView(0, 1),
  89                        matrixView(1, 1), matrixView(2, 1), matrixView(0, 2), matrixView(1, 2),
  90                        matrixView(2, 2) });
  91 }
  92
  93 //! Create new matrix type from legacy type.
  94 static inline Matrix3x3 createMatrix3x3FromLegacyMatrix(const matrix legacyMatrix)
  95 {
  96     GMX_RELEASE_ASSERT(legacyMatrix, "Need valid legacy matrix");
  97     Matrix3x3 newMatrix;
  98     for (int i = 0; i < DIM; i++)
  99     {
 100         for (int j = 0; j < DIM; j++)
 101         {
 102             newMatrix(i, j) = legacyMatrix[i][j];
 103         }
 104     }
 105     return newMatrix;
 106 }
 107
 108 //! Fill legacy matrix from new matrix type.
 109 static inline void fillLegacyMatrix(Matrix3x3ConstSpan newMatrix, matrix legacyMatrix)
 110 {
 111     GMX_RELEASE_ASSERT(legacyMatrix, "Need valid legacy matrix");
 112     for (int i = 0; i < DIM; i++)
 113     {
 114         for (int j = 0; j < DIM; j++)
 115         {
 116             legacyMatrix[i][j] = newMatrix(i, j);
 117         }
 118     }
 119 }
 120
 121 } // namespace gmx
 122
 123 #endif