Deal with ESMF_NUMA==OFF correctly, and add NUMA section to ESMF User

Doc.

Author: theurich

build/common.mk

@@ -1808,6 +1808,10 @@ endif
 #-------------------------------------------------------------------------------
 # NUMA
 #-------------------------------------------------------------------------------
+ifeq ($(ESMF_NUMA),OFF)
+ESMF_NUMA=
+endif
+
 ifeq ($(ESMF_NUMA),ON)
 ESMF_NUMA = standard
 endif

src/doc/ESMF_install.tex

@@ -606,6 +606,41 @@ \subsubsection{MOAB}
 
 \end{description}
 
+\subsubsection{NUMA}
+\label{sec:NUMA}
+
+The LibNUMA API for Non Uniform Memory Access
+(\htmladdnormallink{NUMA}{https://halobates.de/numaapi3.pdf})
+can be used to discover the NUMA architecture at run-time.
+
+\begin{description}
+
+\item[ESMF\_NUMA] Possible values: {\tt "ON"}, {\tt "standard"}, {\tt "OFF"} (default).
+
+\begin{description}
+\item[{\tt "ON"}/{\tt "standard"}] The NUMA dependent code inside of ESMF will
+be enabled.
+The {\tt ESMF\_NUMA\_LIBS} environment variable will be set to
+{\tt "-lnuma"}.
+
+\item[{\tt "OFF"} (default)] Disables NUMA dependent code.
+\end{description}
+
+\item[ESMF\_NUMA\_INCLUDE] Typically not needed. (no default).
+
+Specifies the path where the NUMA header files are located.
+
+\item[ESMF\_NUMA\_LIBPATH] Typically not needed. (no default).
+
+Specifies the path where the NUMA library file is located.
+
+\item[ESMF\_NUMA\_LIBS] Typical value: {\tt "-lnuma"}.
+
+Specifies the linker directives needed to link the NUMA library to
+the application.
+
+\end{description}
+
 \subsubsection{NVML}
 \label{sec:NVML}
 
@@ -634,7 +669,7 @@ \subsubsection{NVML}
 
 Specifies the path where the NVML library file is located.
 
-\item[ESMF\_NVML\_LIBS] Typical value: {\tt "-lnvidia-ml"} (no default).
+\item[ESMF\_NVML\_LIBS] Typical value: {\tt "-lnvidia-ml"}.
 
 Specifies the linker directives needed to link the NVML library to
 the application.