1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
/*!
\internal \file
\brief
Doxygen documentation file for group declarations etc.
\author Teemu Murtola <teemu.murtola@gmail.com>
*/
/*!
\defgroup group_publicapi Public API
\brief
Classes and other symbols that are publicly accessible from user code.
*/
/*!
\defgroup group_libraryapi Library API
\brief
Classes and other symbols that are publicly accessible within the \Gromacs
library.
\see group_publicapi
*/
/*!
\defgroup group_utilitymodules Utility Modules
\brief
Modules with generic utility functions.
*/
/*!
\defgroup group_analysismodules Analysis Modules
\brief
Modules used in analysis tools.
A separate page describes the responsibilities of these modules:
\ref page_trajectoryanalysisframework
\ref page_energyanalysisframework
*/
/*! \libinternal
\defgroup group_mdrun Modules for simulation functionality
\brief
Modules used in running simulations with mdrun
*/
/*!
\namespace gmx
\brief
Generic \Gromacs namespace.
\inpublicapi
*/
/*!
\internal \namespace gmx::internal
\brief
Internal \Gromacs namespace.
This namespace is used to contain some implementation-specific functions and
classes. These are not meant for direct user access, but typically reside
in public headers because of implementation reasons.
*/
/*!
\libinternal
\namespace gmx::compat
\brief Compatibility aliases for standard library features.
Provide consistent naming for standard library features that must be back-ported
on some platforms.
gmx::compat::some_feature may map to back-ported code or to a feature provided by
the STL available on a given build platform, but by including the compatibility
header and using the gmx::compat namespace, forward and backward compatible code
is cleaner and clearer. In the future, when a feature is determined to be provided
by the system on all supported platforms, references to gmx::compat::some_feature
can be replaced, e.g. with std::some_feature, and gmx::compat::some_feature
deprecated.
Since compatibility headers are likely to be included by other
headers, there is a risk of ambiguity if code in the gmx namespace refers to an
unqualified name in the std namespace. To reduce ambiguity, symbol names from
gmx::compat should not be imported into scopes that are shared between multiple
translation units (e.g. via `using` statements in header files).
\ingroup group_compatibility
*/
/*!
\libinternal
\defgroup group_compatibility C++ standard library compatibility helpers.
\brief Provide uniform interface to selected C++ standard library features.
For some features not available on all platforms supported by \Gromacs,
provide back-ports or mappings to available standard library implementations
as appropriate.
*/
/*!
\file share/template/template.cpp
\brief Template code for writing analysis programs.
See \ref page_analysistemplate for more information.
*/
/*!
\example template.cpp
\brief Template code for writing analysis programs.
See \ref page_analysistemplate for more information.
*/
|
