Remove deprecated env. vars GMX_OCL_NB_ANA_EWALD etc

The following environment variables were deprecated in 2021, and are
being removed:

GMX_CUDA_NB_ANA_EWALD
GMX_OCL_NB_ANA_EWALD
GMX_CUDA_NB_TAB_EWALD
GMX_OCL_NB_TAB_EWALD
GMX_CUDA_NB_EWALD_TWINCUT
GMX_OCL_NB_EWALD_TWINCUT

Closes #3803

Use make_unique instead of reset when private implementations are constructed

Using std::unique_ptr instead of our own implementation in PImpl classes made
compiler more aware of the code and clang-tidy started to complain about
using reset function(...) for PImpl construction.

Remove support for Fujitsu Sparc64 HPC-ACE

The K computer is turned off, so this architecture is effectively
dead. Note that the NBNXM scheme never supported its SIMD, so even the
SIMD support in other modules was only of modest value.

Part of #3891

Remove x86 MIC support

This platform is basically dead, so code and SIMD layer that supports
it should be removed.

There is no need to preserve a stub in the SIMD support enumeration,
because we never need to be consistent with old code. That's different
for other enums that affect e.g. reading old tpr files.

Note that this does not affect KNL support or
SIMD.

Part of #3891

Replace gmx::Mutex with std::mutex

We use no mutexes during the MD loop, so performance is not a serious
consideration and we should simplify by using std components.
Eliminated components of thread-MPI that are now unused.

In particular, this reduces the cross-dependencies between the
libgromacs and threadMPI libraries.

Minor style improvements around set_over_alloc_dd.

Part of #3892

Fix clang-tidy

Code used old unique_ptr handling that needed fixing.

Require MPI 2.0

Remove MPI_IN_PLACE_EXISTS, since that can now be assumed. We weren't
testing the fallback path in CI, either.

Simplified MPI install guide. We don't need to maintain
recommendations about MPI library versions.

Fixes #3591

Rmove dependency on Constraints object from compute_globals(...)

Compute globals only uses RMSD data from constraints. This replaces
the Constraints object by the optional argument with RMSD data in
compute_globals(...) function signature.

Refs. #3754

Allow MdModules to access the topology during simulation setup.

Use cxx mpi

Remove PrivateImplPointer in favour of std::unique_ptr

The single remaining advantage (help with const correctness in an
unlikely corner case) is outweighed by the disadvantages of
using a custom solution where a generic one would do.

Fixes #3684

Added functionality that allows MdModules to disable PME-only ranks during simulation setup

Merge branch release-2021

Resolved conflicts:

        admin/gitlab-ci/gromacs.gitlab-ci.yml
        admin/gitlab-ci/python-gmxapi01.gitlab-ci.yml
        api/nblib/gmxsetup.cpp
        api/nblib/listed_forces/gmxcalculator.cpp
        api/nblib/listed_forces/tests/calculator.cpp
        api/nblib/molecules.cpp
        api/nblib/molecules.h
        api/nblib/ppmap.h
        api/nblib/tests/integrator.cpp
        api/nblib/topologyhelpers.cpp
        docs/install-guide/index.rst
        python_packaging/src/setup.py
        src/gromacs/gmxpreprocess/pdb2gmx.cpp
        src/gromacs/gmxpreprocess/readir.cpp
        src/gromacs/gmxpreprocess/topdirs.cpp
        src/gromacs/math/densityfit.cpp
        src/gromacs/mdrun/md.cpp
        src/gromacs/mdrunutility/handlerestart.cpp
        src/gromacs/modularsimulator/simulatoralgorithm.cpp
        src/gromacs/nbnxm/cuda/nbnxm_cuda_data_mgmt.cu
        src/gromacs/nbnxm/nbnxm_gpu_data_mgmt.cpp
        src/gromacs/nbnxm/nbnxm_gpu_data_mgmt.h
        src/gromacs/nbnxm/opencl/nbnxm_ocl_data_mgmt.cpp
        src/gromacs/pulling/pull.cpp

Mostly from refactoring in master that clashed with fixes in
release-2021. Preserved the functionality from the latter in the form
of the former.

Some changes are simply due to the change to clang-format
configuration.

One CI configuration change for mdrun-only build is adapted, since
mdrun-only build has been removed.

Prepare for first 2021 patch release

Reset DOI strings

Move initiation of local CPU force H2D transfer to producer

For GPU DD cases that include CPU force calculations, a host to device
transfer of local force data is required before the GPU halo
exchange. The initiation of the transfer was previously immediately
before the consumer (GPU halo exchange). This change moves the
initiation to immediately after the last possible producer (the
special force calculation, noting that the CPU force contributions can
also come from preceeding bonded or PME calculations).

Addresses #3082

GROMACS 2021 release

Updated regressiontest hash.
Set doi strings.
Set correct release date.

Fix NB-LIB copyright

Was missing some updates and had a wrongly formatted header.

Fix formatting in random/seed.cpp

This was left over after merging release-2020 into 2021.

Fix failing listed-forces test

Reintroduce CI job descriptions

GitLab does not allow adding custom fields to YAML files, so comments
were used. I tried to make the descriptions grep'able (not for the
wqhole matrix, but at least for individual settings), human-readable,
and possibly machine-parseable at the same time.

Remove constant acceleration groups

Per Redmine discussion, this has been broken for about 10
years. Simplifying the update and global energy code is nice, and some
integrators will now be a trifle faster.

The value of SimulationAtomGroupType::Count can't change because reading old .tpr files relies
on it, but the enumeration value has a new name so that any relevant
code rebasing over this change can't silently still compile. This does
mean that loops over egcNR are now slightly less efficient than they
could be, and some of those are in the per-step update code. But that
is likely not worth changing in the current form of the code.

Originally authored by Mark Abraham at
https://gerrit.gromacs.org/c/gromacs/+/8944.

Fixes #1354

SYCL: fix typo in a test and clean-up non-standard-compliant code

Discovered when trying to compile with hipSYCL. Although not an issue
for Intel compiler, better keep things clean.

The change of `write` to `read` in the test code is intended. Not sure
how it worked before, but it should be `read` there.

Also fixed namespace qualifiers, implicit ctors.

Test python 3.9.1

Extends the image-building infrastructure to also include
python 3.9.1 into images.

Fixes #3479

Clarify lambda vector usage with figure in manual

Add a figure that clarifies the effect of different lambda values.

Add new sample script for listed forces

Adds a sample script that demonstrated the use of
listed forces calculator.

Change default Ewald kernel to tabulated on NVIDIA CC 7.0

Partially addressed #3845

Fix default for xpm2gmx tick-mark spacings

Inadvertently broken ages ago in 027ae34187f8

Fixes #3881

Enable grompp to read virtual_site1

In !306, a virtual site with one constructing atom was introduced.
grompp was, however, not updated to understand the new topology entry.
This updates the topology format in grompp and the manual. It also adds
a missing example for virtual site type 2fd to the manual.

Found while investigating #3866, but not directly connected.

Add necessary dependence of sample test on check-nblib

This change adds the argon-forces-integration sample script
as a dependency for check-nblib. Without this, the sample script
is not correctly tested.

Stop installing NB-LIB argon-forces-integration binary

This binary should not be installed alongside gmx. For example, the
GROMACS analysis-tool template in share folder is not installed by
default.

There's value to testing that the sample code compiles, but not
everybody needs to install it.

Use ctest better to run NB-LIB sample code as a test

The return code of the sample binary does what a test needs to do.
There's no need to create issues by shoehorning it into a GoogleTest.

Refs #3821

Update self-documentation in admin/git-pre-commit

Log progress from gmx msd better

Refs #3284

Check availability of compile flags at cmake time

Fixes #3821

Ensures that compile flag can be used before using it. Gives a
message if flag cannot be used.

Rename DefaultAngle to HarmonicAngleType in nblib listed forces

This change renames the type corresponding to harmonic angles
in nblib from DefaultAngle to HarmonicAngleType. This is both
more descriptive, and more similar to other listed forces
types in nblib.

Additionaly, one failing test is disabled. This disabling
is needed so that all tests can pass to allow this MR to
be merged. A subsequent MR fixes the test issues.

MTS release note

Update Dockerfiles for Python subpackages.

Some appropriate adjustments were discovered while
investigating computing environments for an upcoming workshop.

* Bump the base Linux distribution.
* Refine the inline documentation.
* Adjust the package list and build options.

Finalize gmxapi Python package version 0.2.

Disable CUDA textures also on NVIDIA Ampere A100

The same benefits have been shown as those observed with V100.

Partially addresses #3845

Ensure residue name used by pdb2gmx matches rtp name

The default for GLU/GLUH and ASP/ASPH is the unprotonated form. The
help text pdb2gmx specifically states this, and there is no attempt to
use the residue name to infer the protonation.

The old code set the rtp name to the unprotonated form without
changing the residue name read from the configuration file. The
original residue name was then used in the output configuration and
topology file. That name indicated the wrong protonation if the user
input tried to specify the protonated form via the residue name. Now
it changes the residue name to match the rtp name.

This has been surprising, so whenever pdb2gmx implements its default by
changing the residue name, it now reports that.

The same problem occurs when using pdb2gmx -asp if the input
configuration had the name of the protonated form and the interactive
choice was for the unprotonated form. However, in that case there is
no need to inform the user that the input residue naming is being
overridden. Tested manually.

Updated the tests to handle this case.

Added some release notes, Doxygen, added some comments, and updated some code style
so the review is easier.

Fixes #2480

Keep the number of tMPI ranks consistent with the number of GPUs

When the number of atoms in a system is small, and the automatic resource
assignment is used (i.e., a user just runs gmx mdrun), the number of ranks
chosen by get_nthreads_mpi might be incompatible with the expectations of
GpuTaskAssignmentsBuilder, namely that the number of ranks must be
divisible by the number of threads.

If the user did not supply the -ntmpi value, and we have to limit the
number of ranks due to small system size, we round it down down to the
nearest value divisible by the number of GPUs to use (or 1, whichever is
greater).

Fixes #3874

Minor naming fix in OpenCL nbnxm kernels

OpenCL images are not used and when cleaning up host code the kernel
variables were left with the outdated/wrong naming. This change removes
the suffix to eliminate crust and potential for confusion.

Suggest a workaround for pulling with -deffnm

Also fixed use of settings, use settings to do the line wrapping,
and wrote some newlines to make the output more readable.

Refs #3875
Fixes #3442

Use correct python interpreter cmake check

Still needed to complete address checksumming issue.

Fixes #3862

Describe the configured precision correctly for mdrun

We adopted the build configuration naming scheme for GMX_DOUBLE
"mixed" vs "double" some years ago so that people knew we don't reduce
forces in mdrun solely in single. This change improves consistency in
this regard in the cases that are important to users, ie. log files
and messages about checkpoint restarts.

Various file-reading tools still refer to "single" in contexts where
they are reading floats, which is fine.

NBLIB: Remove preprocessor macros

Macros used to implement part of the listed forces calculation have been
removed and replaced with a pure C++ template implementation.

Also addresses review comments not fully resolved from previous merge
requests.

Fix TPR handling for older versions.

Reading in a newer TPR file in a pre-2021 version would fail hard with
symtab errors due to us forgetting to increment the tpr generation when
adding the VSite1 type to ftupd.

This fixes the omission an makes the tpr generation an enum similar to
the tpr version.

Fixes #3867

Fix checksumming code

Recent additions to the code to avoid errors with certain IDEs
caused issues by never trying to validate the checksums.

Fixed by properly passing the necessary variables to the script.

Fixes #3862

Fix PaddedVector move constructor

This could leave the moved-from vector in a state unfit to destruct.

Expanded test coverage, including improving the tests and their
infrastructure, so I could understand my own code.

Fixes #2832

Report hwloc 1.x deprecation only when found

Refs #3818

Change default MTS force group selection

Because of instabilities of aliphatic protons with the Amber
force fields, the default force group selection for multiple
time stepping has been changed to include longrange-nonbonded only.

Refs #3804

Disable CUDA textures on NVIDIA Volta

This has significant performance benefit for the nbnxm kernels with
tabulated Ewald correction and it has negligible impact on the PME kernels.

Partially addresses #3845

Deprecate mdrun -deffnm

This functionality is more trouble to implement and test well than
we expected. Even though it is convenient in some cases, on balance
we should remove it and encourage users to use standard approaches
for grouping their files.

Refs #3442, #942, #2205, #2154.
Fixes #3818

Fix modular simulator log writing in fresh simulation starts with nstlog == 0

With nstlog = 0, legacy simulator writes log on the initial step, while
modular simulator wasn't. This adapts modular simulator to the legacy
approach.

Add G. Gouaillardet to the list of contributors

Make inputrec const at simulator level (leaves some TODOs)

This does not resolve the last few instances that change inputrec, but it
makes sure that the intent of inputrec being const is clear, and that future
code changes don't easily introduce additional non-const uses of inputrec.
See !46 for a similar change targetting the global topology.

Refs #3854.

Avoid NMR restraints calls for MTS levels > 0

Distance and orientation restraint code was called for MTS levels > 0
whereas this should not happen.

Fixes #3863

Remove mdrun-only build configuration

The existence of this configuration is unnecessary, provides no real
advantages, and was only tested by compiling it (ie not by running
it). Its existence complicates installation, maintenance, testing,
documentation, teaching, and usage. It was deprecated in GROMACS 2021,
and is now removed.

Added a new regressiontests gitlab job now that the build
configuration that used to build with GMX_BUILD_MDRUN_ONLY can run
those tests.

Refs #3808

Fix copyright year

!972 failed to update the copyright year.

densityfit: Fix typo in use of iterators

... and some typos in comments.

While both referenceDensity_ and referenceDensity are views into the same data,
it's clearer to use the same variable for both begin() and end().

This is a remake of MR !740. That MR was reverted (in !748) due to
failed tests. The test failures, however, were caused by an unrelated bug
(issue #3791, fix !827). So, this change is brought back.

Make inputrec const everywhere in modular simulator

3cbf1ecb9a7afa9c4e285bcfd26cab3e52bbc1a5 allows us to make inputrec
const everywhere in the modular simulator.

Refs #3854.

ARM_SVE: misc fixes

 - fix a typo
 - remove debug assert()

Fix periodic actions test

The periodic actions test was using `insert` to add options to the
mdp map, but intended to overwrite already present values. This change
replaces the non-overwriting `insert` by a lambda actually overwriting
the default options.

Add new GROMACS logo

Replaces previous logo with new vector graphics one.
Logo (C) by Cathrine Bergh.

arm_sve: fix GMX_SIMD_HAVE_4NSIMD_UTIL_{FLOAT,DOUBLE} macro definitions

only define these macros in impl_arm_sve_definitions.h when the number of
elements per vector greater than 4

Merge branch release-2020 into merge-2020-into-2021

Resolved Conflicts:
cmake/gmxVersionInfo.cmake
docs/CMakeLists.txt
docs/conf.cmakein.py
src/gromacs/gmxpreprocess/readir.cpp
src/gromacs/mdlib/expanded.cpp
src/gromacs/mdlib/tests/CMakeLists.txt

Write copyright output files as utf8

The script could fail otherwise when encodings didn't match.

Add trivial const qualifiers for inputrec

Refs #3854

Fix nightly webpage upload

When the server got changed this wasn't changed, so the nightly build
docs have been stale for a while.

Simplify test mdp handling

In the current implementation, mdp options are handled in 3 places:
* Defaults for a system are stored in the system database
* General defaults are added to that (using `insert` to avoid overwriting)
  in `prepareDefaultMdpFieldValues`.
* Some more defaults are hardcoded in `prepareMdpFileContents`

`prepareDefaultMdpFieldValues` returns a map of options and option
values.  This allows specific tests to change default options as
needed, but not to add any new options, because
`prepareDefaultMdpFieldValues` only reads a predetermined set of
options. Newly added options are dropped without warning or error. A
specific "other" field in the map allows for additional options - but
users must be careful not to add any option that is already in the map
or that are hardcoded in `prepareMdpFileContents`, which would result
in a grompp error due to having multiple values for the same option.

This makes the functionality hard to use and is prone to errors (case
in point: the periodic actions test is trying to set nstlog, which is
silently ignored, so the test coverage is not what was intended).
Changes to this functionality have previously been stalled in favor of
transition to IMdpOptions, but given that the current road map doesn't
make a full transition in the near future likely, it's likely worth a
small investment to make the current functionality more usable.

This moves all hardcoded values from `prepareMdpFileContents` into the
map returned by `prepareDefaultMdpFieldValues`, and prints all options
present in the map to the mdp string. This allows tests to change or
add any value. The users of the functionality are responsible to fill
the map with valid mdp options - and will get grompp errors if they
fail. This also removes all uses of the "other" keyword (which would
now generate a grompp error, so we're sure we didn't forget any uses).

Reduce code duplication between Berendsen and c-rescale pressure coupling

The Berendsen and C-Rescale pressure coupling algorithms are very similar,
yet duplicate a lot of functionality. This unifies the functions using
template parameters to reduce code duplication. This is pure refactoring.

Respect user input for nstcomm

This replaces do_md overwriting ir->nstcomm by a warning at grompp
time. Until now, nstcomm was set to the computed global communication
frequency if nstcomm was smaller. The user is now informed at grompp
time that their choice is not optimal, but the set value is respected.
The criterion for the warning now also encompasses any value for
nstcomm that is not a multiple of the global communication frequency.

Resolves a TODO, and refs #3854.

Prepare for GROMACS 2020.6

Reset DOI strings.
Prepare release note stubs.
Set patch number in build infrastructure.

Remove misleading const qualifier for inputrec in expanded ensemble

The expanded ensemble functionality took a const pointer to the
inputrec, but might change its references temperature. This is (at the
very least) misleading, so removed the const qualifier.

Refs #3854

GROMACS version 2020.5

Set DOI strings.

Fix lambda printing const qualifier

Use ArrayRef<const real> instead of const ArrayRef<real>.

Update src/regressiontests URLs to https

With the recent server migration we support https downloads and we
should offer those over http.
Also updated the regressiontests URL to point to the ftp server.

Fix broken random seed generation.

On Ryzen 3k CPUs with the RDRAND microcode bug, the
std::mt19937_64 alternate path yields the same seed
on multiple calls that fall within the same second. Changed
the "seed" of the random seed to rescramble each time the
makeRandomSeed() function is called.

Fixes #3859

Fix broken random seed generation.

On Ryzen 3k CPUs with the RDRAND microcode bug, the
std::mt19937_64 alternate path yields the same seed
on multiple calls that fall within the same second. Changed
the "seed" of the random seed to rescramble each time the
makeRandomSeed() function is called.

Fixes #3859

Fix copyright year

Merging !423 on January 1st 2021 causes the pipeline to fail
due to a missed copyright year update.

The copyright year is updated with this patch.

Expanded ensemble changes.

Fix the numerical stability issues encountered with simulated tempering (also, would have occurred with any alchemical problem with large energy differences between states). In most cases, we simply flip the form around and compute an alternate form that always gives a 0 instead of infinity when the energy difference between states is too far in any direction. Also added a citation. Fixes https://gitlab.com/gromacs/gromacs/-/issues/3304

Note that there is no way to get good estimates for free energy differences between states with the very large differences between examples. One of the numerical stability fixes is not expected to be great, but it's not really relevant since nothing would work in this case; using Wang-Landau (i.e. visitation based approaches) rather than metropolis style methods (energy difference analysis methods) is the only thing that works.

Bump version post-release to rc2

GROMACS 2021-rc1 release candidate

First release candidate.

Deprecate .pdo file reading

Analysing such files is likely not relevant a decade later, and such
needs can be met by using an older version of GROMACS that did still
support reading these formats.

Fixes #3818

Stage bonded kernel atomics through shared memory

Fixes performance bug introduced in 01b2f20bd5 by staging energy step
atomics through shared memory rather than have all threads write
atomically directly to global memory.

Fixes #3443

Merge branch release-2021

Some reformatting changes needed for the difference in
.clang-format in the two branches

Update CI image to OneAPI 2021.1.1, add ICC tests.

Also, backport a change from MR !796 that silences the false-positive ICC
compiler warning.

Apply re-formatting to C++ in src/ tree.

Apply formatting changes in bulk to reduce noise in subsequent
functional changes.

Will likely need to be repeated if clang-format version is updated
per #3708.

The formatting is sensitive to differences even between llvm tools
versions 7.1.0.2 and 8.0.1.3. Here, I used 7.1.

Refs #3833

Update deprecation statuses

Various functionality has been agreed as deprecated at #3818 and
elsewhere. Those are now noted in the release notes, documentation,
and CMake status messages. The changes are all minor so there is
little need to make mdrun report when such configurations are used.

The deprecation content for release  2020 (and 2021) series is updated
to include  the relevant  content from  release 2019  series. Comments
have been added to help us to this better in future.

Fixes #3818

Fix pull group index handling

The pull code never validated its own index groups, leading to the
possibility of an invalid group either hanging the process or triggering
an assertion, depending on the build type.

Fixed by introducing the check for other index groups also to pull
groups.

Fixes #3810

Fix incorrect AWH free-energy output with multiple walkers

The free-energy was averaged exponentially over walkers using the wrong
sign for the exponent. The meant that the free-energy output was off
for large update sizes. This error was quadratic in the update interval
and the number of walkers. This likely has no measurable effects with
the default AWH free-energy update interval. But the effect is noticeable
with the not uncommon update interval of 1000 steps.

Fixes: #3828

Correct signs of lj and coulomb forces

Update instructions in containers.rst

Restrict force frame comparison for FEP tests

Closes #3741.

Fix trx frame reading from modular simulator checkpoint files

trx frames from checkpoints written by modular simulator could be
slightly off depending on the algorithms used (always up-to-date with
domain decomposition only). The global state is still written to
modular checkpoints (as there is a significant amount of setup work at
runner time that needs to be refactored before modular simulator can
get spawned completely without a global state). It is, however, not
guaranteed to be absolutely up to date, as it's not used in the
simulation continuation.

The trx frame reading is now handled by modular simulator if the
checkpoint was written by modular simulator. A test was added to
ensure that the final frame of the simulation is equivalent to the
checkpointed configuration.

Note that this was not affecting simulation restart (exact
continuation is tested also for modular simulator). It would, however,
affect other tools accessing the configuration from the checkpoint
file. The error was only present in master and 2021 beta, so it was
never in a released version.

trx frame reading by modular simulator required some refactoring of
the StatePropagatorData and FreeEnergyPerturbationData
checkpointing. The main read and write function was moved to the data
object itself rather than being owned by its element. This is likely a
better design decision anyway: The element orchestrates the
checkpointing during the simulations, but the data object is handling
the actual data reading / writing. This allows to create a dummy data
object, restore it from checkpoint, and read out the quantities
relevant for the trx frame.

Closes #3838

A check for perturbed listed pairs beyond rlist

Excluded atoms pairs should be within the pairlist cut-off, as
otherwise long-range corrections are not applied. This is problematic
for free-energy calculations where intra-molecular interactions are
not coupled and replaced by pair interactions. Now a fatal error
is generated when perturbed pair interactions are beyond rlist.

Also added PME grid correction for LJ excluded pairs beyond rvdw,
which was missing from #3403.

Added missing release note for the fix of #3403.

Fixes #3403
Fixes #3809

Improved variable names in FEP nonbonded kernel

This is mainly to improve the readability of the FEP SIMD patch.
There are more variables to rename, but preferably as a follow-up
to the SIMD patch.

Fix indexing bug in electric field module

Improper refactoring in c8eca5d1f27cc34903718ade7d44527c22ec3d93 lead to
the module using the wrong maximum atom index for applying the electric
field forces to atoms.

Fixes #3800

Fix defining of EXCLUSION_FORCES in CUDA/OpenCL kernels

For the case of cut-off electrostatics + Ewald LJ + no energy calculation,
the EXCLUSION_FORCES macro should be active.
However, LJ_EWALD macro is (conditionally) set only later, and so is
always undefined when it is being checked for EXCLUSION_FORCES.

Fix compilation and tests with icc 19.1.2

Closes #3822