src/gromacs/math/gmxcomplex.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2012,2014,2017,2018,2019,2021, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #ifndef GMX_MATH_GMXCOMPLEX_H
  38 #define GMX_MATH_GMXCOMPLEX_H
  39
  40 #include <cmath>
  41
  42 #include "gromacs/math/vectypes.h"
  43 #include "gromacs/utility/real.h"
  44
  45 struct t_complex
  46 {
  47     real re, im;
  48 };
  49
  50 static t_complex rcmul(real r, t_complex c)
  51 {
  52     t_complex d;
  53
  54     d.re = r * c.re;
  55     d.im = r * c.im;
  56
  57     return d;
  58 }
  59
  60 static inline t_complex rcexp(real r)
  61 {
  62     t_complex c;
  63
  64     c.re = cos(r);
  65     c.im = sin(r);
  66
  67     return c;
  68 }
  69
  70
  71 static inline t_complex cadd(t_complex a, t_complex b)
  72 {
  73     t_complex c;
  74
  75     c.re = a.re + b.re;
  76     c.im = a.im + b.im;
  77
  78     return c;
  79 }
  80
  81 static inline t_complex csub(t_complex a, t_complex b)
  82 {
  83     t_complex c;
  84
  85     c.re = a.re - b.re;
  86     c.im = a.im - b.im;
  87
  88     return c;
  89 }
  90
  91 static t_complex cmul(t_complex a, t_complex b)
  92 {
  93     t_complex c;
  94
  95     c.re = a.re * b.re - a.im * b.im;
  96     c.im = a.re * b.im + a.im * b.re;
  97
  98     return c;
  99 }
 100
 101 static t_complex conjugate(t_complex c)
 102 {
 103     t_complex d;
 104
 105     d.re = c.re;
 106     d.im = -c.im;
 107
 108     return d;
 109 }
 110
 111 static inline real cabs2(t_complex c)
 112 {
 113     real abs2;
 114     abs2 = (c.re * c.re) + (c.im * c.im);
 115
 116     return abs2;
 117 }
 118
 119 static inline t_complex cdiv(t_complex teller, t_complex noemer)
 120 {
 121     t_complex res, anoemer;
 122
 123     anoemer = cmul(conjugate(noemer), noemer);
 124     res     = cmul(teller, conjugate(noemer));
 125
 126     return rcmul(1.0 / anoemer.re, res);
 127 }
 128
 129 inline bool operator==(const t_complex& lhs, const t_complex& rhs)
 130 {
 131     return (lhs.re == rhs.re) && (lhs.im == rhs.im);
 132 }
 133 inline bool operator!=(const t_complex& lhs, const t_complex& rhs)
 134 {
 135     return !(lhs == rhs);
 136 }
 137
 138 #endif