Add AWH biasing module + tests
[gromacs.git] / src / gromacs / gmxpreprocess / keyvaluetreemdpwriter.h
blob745e8db211baa02440d6ba39fed8346c22f1934f
1 /*
2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2017, 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.
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.
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.
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.
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.
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.
35 /*! \libinternal \file
36 * \brief
37 * Declares a function to write a flat key-value tree to look like
38 * old-style mdp output.
40 * \author Mark Abraham <mark.j.abraham@gmail.com>
41 * \inlibraryapi
42 * \ingroup module_gmxpreprocess
44 #ifndef GMX_GMXPREPROCESS_KEYVALUETREEMDPWRITER_H
45 #define GMX_GMXPREPROCESS_KEYVALUETREEMDPWRITER_H
47 namespace gmx
50 class KeyValueTreeObject;
51 class TextWriter;
53 /*! \brief Write a flat key-value \c tree to \c writer in mdp style.
55 * Sub-objects will output nothing, so they can be used to
56 * contain a special key-value pair to create a comment, as
57 * well as the normal key and value. The comment pair will
58 * have a key of "comment", and the value will be used as a
59 * comment (if non-empty). */
60 void writeKeyValueTreeAsMdp(TextWriter *writer,
61 const KeyValueTreeObject &tree);
63 } // namespace gmx
65 #endif