Use proper doxygen tags in modular simulator
[gromacs.git] / src / gromacs / topology / forcefieldparameters.cpp
blob036960895d0bd45b626a03411963d8cbb0105535
1 /*
2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2004, The GROMACS development team.
6 * Copyright (c) 2013,2014,2015,2016,2018 by the GROMACS development team.
7 * Copyright (c) 2019,2020, by the GROMACS development team, led by
8 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
9 * and including many others, as listed in the AUTHORS file in the
10 * top-level source directory and at http://www.gromacs.org.
12 * GROMACS is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU Lesser General Public License
14 * as published by the Free Software Foundation; either version 2.1
15 * of the License, or (at your option) any later version.
17 * GROMACS is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * Lesser General Public License for more details.
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with GROMACS; if not, see
24 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
25 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 * If you want to redistribute modifications to GROMACS, please
28 * consider that scientific software is very special. Version
29 * control is crucial - bugs must be traceable. We will be happy to
30 * consider code for inclusion in the official distribution, but
31 * derived work must not be called official GROMACS. Details are found
32 * in the README & COPYING files - if they are missing, get the
33 * official version at http://www.gromacs.org.
35 * To help us fund GROMACS development, we humbly ask that you cite
36 * the research papers on the package. Check out http://www.gromacs.org.
38 #include "gmxpre.h"
40 #include "forcefieldparameters.h"
42 #include "gromacs/utility/basedefinitions.h"
43 #include "gromacs/utility/txtdump.h"
45 static void pr_cmap(FILE* fp, int indent, const char* title, const gmx_cmap_t* cmap_grid, gmx_bool bShowNumbers)
47 int j, nelem;
48 real dx, idx;
50 if (cmap_grid->grid_spacing != 0)
52 dx = 360.0 / cmap_grid->grid_spacing;
54 else
56 dx = 0;
58 nelem = cmap_grid->grid_spacing * cmap_grid->grid_spacing;
60 if (available(fp, cmap_grid, indent, title))
62 fprintf(fp, "%s\n", title);
64 for (gmx::index i = 0; i < gmx::ssize(cmap_grid->cmapdata); i++)
66 idx = -180.0;
67 fprintf(fp, "%8s %8s %8s %8s\n", "V", "dVdx", "dVdy", "d2dV");
69 fprintf(fp, "grid[%3zd]={\n", bShowNumbers ? i : -1);
71 for (j = 0; j < nelem; j++)
73 if ((j % cmap_grid->grid_spacing) == 0)
75 fprintf(fp, "%8.1f\n", idx);
76 idx += dx;
79 fprintf(fp, "%8.3f ", cmap_grid->cmapdata[i].cmap[j * 4]);
80 fprintf(fp, "%8.3f ", cmap_grid->cmapdata[i].cmap[j * 4 + 1]);
81 fprintf(fp, "%8.3f ", cmap_grid->cmapdata[i].cmap[j * 4 + 2]);
82 fprintf(fp, "%8.3f\n", cmap_grid->cmapdata[i].cmap[j * 4 + 3]);
84 fprintf(fp, "\n");
89 void pr_ffparams(FILE* fp, int indent, const char* title, const gmx_ffparams_t* ffparams, gmx_bool bShowNumbers)
91 int i;
93 indent = pr_title(fp, indent, title);
94 pr_indent(fp, indent);
95 fprintf(fp, "atnr=%d\n", ffparams->atnr);
96 pr_indent(fp, indent);
97 fprintf(fp, "ntypes=%d\n", ffparams->numTypes());
98 for (i = 0; i < ffparams->numTypes(); i++)
100 pr_indent(fp, indent + INDENT);
101 fprintf(fp, "functype[%d]=%s, ", bShowNumbers ? i : -1,
102 interaction_function[ffparams->functype[i]].name);
103 pr_iparams(fp, ffparams->functype[i], ffparams->iparams[i]);
105 pr_double(fp, indent, "reppow", ffparams->reppow);
106 pr_real(fp, indent, "fudgeQQ", ffparams->fudgeQQ);
107 pr_cmap(fp, indent, "cmap", &ffparams->cmap_grid, bShowNumbers);