src/api/cpp/include/gmxapi/gromacsfwd.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,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
  36 #ifndef GMXAPI_GROMACSFWD_H
  37 #define GMXAPI_GROMACSFWD_H
  38
  39 /*! \ingroup gmxapi
  40  * \file
  41  * \brief Provide forward declarations for symbols in the GROMACS public headers.
  42  *
  43  * Basic API clients only need to compile
  44  * and link against the gmxapi target, but some gmxapi classes use opaque pointers to
  45  * library classes that are forward-declared here.
  46  * Client code should not need to include this header directly.
  47  *
  48  * For maximal compatibility with other libgmxapi clients (such as third-party
  49  * Python modules), client code should use the wrappers and protocols in the
  50  * gmxapi.h header.
  51  *
  52  * Note that there is a separate CMake target to build the full
  53  * developer documentation for gmxapi.
  54  * Refer to GMXAPI developer docs for the protocols that map gmxapi interfaces to
  55  * GROMACS library interfaces.
  56  * Refer to the GROMACS developer
  57  * documentation for details on library interfaces forward-declared in this header.
  58  *
  59  * \todo Improve documentation cross-linking.
  60  */
  61
  62 // Forward declaration for src/gromacs/mdtypes/inputrec.h
  63 struct t_inputrec;
  64
  65 namespace gmx
  66 {
  67
  68 // Forward declaration for libgromacs header gromacs/restraint/restraintpotential.h
  69 class IRestraintPotential;
  70
  71 } // end namespace gmx
  72
  73 #endif // GMXAPI_GROMACSFWD_H