name.m File Reference

Go to the source code of this file.

Functions
function	name (in vendor)
	Return the MPI library name as used in naming the ParaMonte MATLAB shared library directories. More...

Function Documentation

name()

function name

(

in

vendor

)

Return the MPI library name as used in naming the ParaMonte MATLAB shared library directories.

Parameters

[in]

vendor

: The input scalar MATLAB string, containing the MPI library vendor supported by the ParaMonte library. Possible values are: "Intel", representing the Intel MPI library. "MPICH", representing the MPICH MPI library. "OpenMPI", representing the OpenMPI library. Note that all values are case-insensitive.

Returns

str : The output scalar MATLAB string containing the MPI library name corresponding to the input MPI vendor.
If the input vendor is not supported, the default string "mpi" is returned as the value of str.

Possible calling interfaces ⛓

str = pm.lib.mpi.name(vendor)

See also

pm.lib.mpi.name()
pm.lib.mpi.vendor()
pm.sys.path.mpiexec.vendor()

Example usage ⛓

cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.
addpath('../../../../'); % Add the ParaMonte library root directory to the search path.
 
disp('pm.lib.mpi.name("impi")')
disp( pm.lib.mpi.name("impi") )
disp("")
 
disp('pm.lib.mpi.name("INTEL")')
disp( pm.lib.mpi.name("INTEL") )
disp("")
 
disp('pm.lib.mpi.name("intel")')
disp( pm.lib.mpi.name("intel") )
disp("")
 
disp('pm.lib.mpi.name("ompi")')
disp( pm.lib.mpi.name("ompi") )
disp("")
 
disp('pm.lib.mpi.name("openmpi")')
disp( pm.lib.mpi.name("openmpi") )
disp("")
 
disp('pm.lib.mpi.name("open-mpi")')
disp( pm.lib.mpi.name("open-mpi") )
disp("")
 
disp('pm.lib.mpi.name("mpich")')
disp( pm.lib.mpi.name("mpich") )
disp("")
 
disp('pm.lib.mpi.name("unknown")')
disp( pm.lib.mpi.name("unknown") )

Example output ⛓

pm.lib.mpi.name("impi")
impi
pm.lib.mpi.name("INTEL")
impi
pm.lib.mpi.name("intel")
impi
pm.lib.mpi.name("ompi")
openmpi
pm.lib.mpi.name("openmpi")
openmpi
pm.lib.mpi.name("open-mpi")
openmpi
pm.lib.mpi.name("mpich")
mpich
pm.lib.mpi.name("unknown")
mpi

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Joshua Alexander Osborne, May 21 2024, 7:20 PM, University of Texas at Arlington
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.
Amir Shahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin