ICODE-ADC/lammps
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

clarify docs

Browse Source
This commit is contained in:
Axel Kohlmeyer
2024-09-18 23:14:27 -04:00
parent 42bcc43ece
commit 4eb1b1f606
1 changed files with 14 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
doc/src/Build_extras.rst
View File

@ -2261,27 +2261,28 @@ This package depends on the BPM package.
-D PKG_RHEO=yes # enable the package itself
-D PKG_BPM=yes # the RHEO package requires BPM
-D USE_INTERNAL_LINALG=value #
-D USE_INTERNAL_LINALG=value # prefer internal LAPACK if true
Features in the RHEO package are dependent on code in the BPM
package so the latter one *must* be enabled.
Some features in the RHEO package are dependent on code in the BPM
package so the latter one *must* be enabled as well.
The RHEO package also requires LAPACK (and BLAS) and CMake
can identify their locations and pass that info to the RHEO
build script. But on some systems this may cause problems when
linking or the dependency is not desired. Try enabling
``USE_INTERNAL_LINALG`` in those cases to use the bundled linear
algebra library and work around the limitations.
linking or the dependency is not desired. By using the setting
``-D USE_INTERNAL_LINALG=yes`` when running the CMake
configuration, you will select compiling and linking the bundled
linear algebra library and work around the limitations.
.. tab:: Traditional make
The RHEO package also requires LAPACK (and BLAS) which can be
either a system provided library or the bundled "linalg" library
which is a subset of LAPACK. For that, one of the provided
``Makefile.lammps.<config>`` files needs to be copied to
``Makefile.lammps`` and edited as needed. The default file
uses the bundled "linalg" library, which can be built with
``make lib-linalg args='-m serial'``.
The RHEO package requires LAPACK (and BLAS) which can be either
a system provided library or the bundled "linalg" library. This
is a subset of LAPACK translated to C++. For that, one of the
provided ``Makefile.lammps.<config>`` files needs to be copied
to ``Makefile.lammps`` and edited as needed. The default file
uses the bundled "linalg" library, which can be built by
``make lib-linalg args='-m serial'`` in the ``src`` folder.
----------