src/gromacs/applied_forces/densityfittingoutputprovider.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 /*! \internal \file
  36  * \brief
  37  * Declares output to file for density fitting
  38  *
  39  * \author Christian Blau <blau@kth.se>
  40  * \ingroup module_applied_forces
  41  */
  42 #ifndef GMX_APPLIED_FORCES_DENSITYFITTINGOUTPUTPROVIDER_H
  43 #define GMX_APPLIED_FORCES_DENSITYFITTINGOUTPUTPROVIDER_H
  44
  45 #include "gromacs/mdtypes/imdoutputprovider.h"
  46
  47 namespace gmx
  48 {
  49
  50 /*! \internal
  51  * \brief Handle file output for density guided simulations.
  52  */
  53 class DensityFittingOutputProvider final : public IMDOutputProvider
  54 {
  55 public:
  56     //! Initialize output
  57     void initOutput(FILE* /*fplog*/,
  58                     int /*nfile*/,
  59                     const t_filenm /*fnm*/[],
  60                     bool /*bAppendFiles*/,
  61                     const gmx_output_env_t* /*oenv*/) override;
  62     //! Finalizes output from a simulation run.
  63     void finishOutput() override;
  64 };
  65
  66 } // namespace gmx
  67
  68 #endif