In addition, NAG recommends that before calling any Library routine you should read the following reference material (see Section 5):
(a) Essential Introduction
(b) Chapter Introduction
(c) Routine Document
The libraries supplied with this implementation have been compiled in a manner that facilitates their use within a multithreaded application. If you intend to use the NAG library within a multithreaded application please refer to the document on Thread Safety in the Library Manual (see Section 5).
In this section we assume that the library has been installed in the directory [INSTALL_DIR].
By default [INSTALL_DIR] (see Installer's Note (in.html)) is /opt/NAG/fssol21dcl or /usr/local/NAG/fssol21dcl depending on your system; however it could have been changed by the installer. To identify [INSTALL_DIR] for this installation:
f90 -O3 -dalign -stackvar -openmp -xarch=v8plusb driver.f [INSTALL_DIR]/lib/libnagsmp.a \where driver.f is your application program; or
-xlic_lib=sunperf -lpthread -lsocket -lnsl
f90 -O3 -dalign -stackvar -openmp -xarch=v8plusb driver.f [INSTALL_DIR]/lib/libnagsmp.so \if the shareable library is required.
-xlic_lib=sunperf -lpthread -lsocket -lnsl
If your application uses the NAG shareable library then the environment variable LD_LIBRARY_PATH must be set or extended, as follows, to allow run time linkage.
In the C shell, type:
setenv LD_LIBRARY_PATH [INSTALL_DIR]/libto set LD_LIBRARY_PATH, or
setenv LD_LIBRARY_PATH [INSTALL_DIR]/lib:${LD_LIBRARY_PATH}to extend LD_LIBRARY_PATH if you already have it set.
In the Bourne shell, type:
LD_LIBRARY_PATH=[INSTALL_DIR]/lib export LD_LIBRARY_PATHto set LD_LIBRARY_PATH, or
LD_LIBRARY_PATH=[INSTALL_DIR]/lib:${LD_LIBRARY_PATH} export LD_LIBRARY_PATHto extend LD_LIBRARY_PATH if you already have it set.
In this section we assume that the NAG SMP and the Sunperf libraries are installed in, or are pointed at by symbolic links from, directories in the search path of the linker, such as /usr/lib.
To use the NAG SMP and the Sunperf libraries, you may link in the following manner:
f90 -O3 -dalign -stackvar -openmp -xarch=v8plusb driver.f -lnagsmp \This will usually link to the shareable library in preference to the static library if both the libraries are at the same location.
-xlic_lib=sunperf -lpthread -lsocket -lnsl
To use the static library libnagsmp.a you need the -Bstatic compiler flag:
f90 -O3 -dalign -stackvar -openmp -xarch=v8plusb -Bstatic driver.f -lnagsmp \
-xlic_lib=sunperf -Bdynamic -lpthread -lsocket -lnsl
If your application uses the NAG shareable library then the environment variable LD_LIBRARY_PATH must be set or extended, as follows, to allow run time linkage.
In the C shell, type:
setenv LD_LIBRARY_PATH [INSTALL_DIR]/libto set LD_LIBRARY_PATH, or
setenv LD_LIBRARY_PATH [INSTALL_DIR]/lib:${LD_LIBRARY_PATH}to extend LD_LIBRARY_PATH if you already have it set.
In the Bourne shell, type:
LD_LIBRARY_PATH=[INSTALL_DIR]/lib export LD_LIBRARY_PATHto set LD_LIBRARY_PATH, or
LD_LIBRARY_PATH=[INSTALL_DIR]/lib:${LD_LIBRARY_PATH} export LD_LIBRARY_PATHto extend LD_LIBRARY_PATH if you already have it set.
setenv OMP_NUM_THREADS NIn the Bourne shell, type:
set OMP_NUM_THREADS=N export OMP_NUM_THREADSwhere N is the number of processors required. OMP_NUM_THREADS may be re-set between each execution of the program, as desired.
The example programs are most easily accessed by one of the commands
Each command will provide you with a copy of an example program (and its data, if any), compile the program and link it with the appropriate libraries (showing you the compile command so that you can recompile your own version of the program). Finally, the executable program will be run, presenting its output to stdout.
The example program concerned, and the number of OpenMP threads to use, are specified by the arguments to the command, e.g.
nagsmp_example e04ucf 4will copy the example program and its data into the files e04ucfe.f and e04ucfe.d in the current folder and process them to produce the example program results in the file e04ucfe.r.
The example programs are supplied in machine-readable form. They are suitable for immediate usage. Note that the distributed example programs are those used in this implementation and may not correspond exactly with the programs published in the Library Manual. The distributed example programs should be used in preference wherever possible.
real or double precision - DOUBLE PRECISION (REAL*8) basic precision - double precision complex or complex*16 - COMPLEX*16 additional precision - quadruple precision (REAL*16,COMPLEX*32) machine precision - the machine precision, see the value returned by X02AJF in Section 4
Thus a parameter described as real or double precision should be declared as DOUBLE PRECISION in your program. If a routine accumulates an inner product in additional precision, it is using software to simulate quadruple precision.
All references to routines in Chapter F07 - Linear Equations (LAPACK) and Chapter F08 - Least-squares and Eigenvalue Problems (LAPACK) use the LAPACK name, not the NAG F07/F08 name.
(a) Subroutines are called as such
(b) Functions are declared with the right type
(c) The correct number of arguments are passed
(d) All arguments match in type and structure
These interface blocks have been generated automatically by analysing the source code for the NAG SMP Library. As a consequence, and because these files have been thoroughly tested, their use is recommended in preference to writing your own declarations.
The NAG SMP Library Interface Block files are organised by Library chapter. The module names are:
nag_f77_a_chapter nag_f77_c_chapter nag_f77_d_chapter nag_f77_e_chapter nag_f77_f_chapter nag_f77_g_chapter nag_f77_h_chapter nag_f77_m_chapter nag_f77_p_chapter nag_f77_s_chapter nag_f77_x_chapterThese are supplied in pre-compiled form (.mod files) and they can be accessed by specifying the -Mpathname option on each f90/95 invocation, where pathname ([INSTALL_DIR]/nag_interface_blocks) is the path of the directory containing the compiled interface blocks.
In order to make use of these modules from existing Fortran 77 code, the following changes need to be made:
The above steps need to be done for each unit (main program, function or subroutine) in your code.
These changes are illustrated by showing the conversion of the Fortran 77 version of the example program for NAG SMP Library routine D01DAF. Please note that this is not exactly the same as the example program that is distributed with this implementation. Each change is surrounded by comments boxed with asterisks.
* D01DAF Example Program Text ***************************************************** * Add USE statements for relevant chapters * USE NAG_F77_D_CHAPTER * * ***************************************************** * .. Parameters .. INTEGER NOUT PARAMETER (NOUT=6) * .. Local Scalars .. DOUBLE PRECISION ABSACC, ANS, YA, YB INTEGER IFAIL, NPTS * .. External Functions .. DOUBLE PRECISION FA, FB, P1, P2A, P2B EXTERNAL FA, FB, P1, P2A, P2B * .. External Subroutines .. ****************************************************** * EXTERNAL declarations need to be removed. * C EXTERNAL D01DAF * * ****************************************************** * .. Executable Statements .. WRITE (NOUT,*) 'D01DAF Example Program Results' YA = 0.0D0 YB = 1.0D0 ABSACC = 1.0D-6 WRITE (NOUT,*) WRITE (NOUT,*) 'First formulation' IFAIL = 1 * CALL D01DAF(YA,YB,P1,P2A,FA,ABSACC,ANS,NPTS,IFAIL) * WRITE (NOUT,99999) 'Integral =', ANS WRITE (NOUT,99998) 'Number of function evaluations =', NPTS IF (IFAIL.GT.0) WRITE (NOUT,99997) 'IFAIL = ', IFAIL WRITE (NOUT,*) WRITE (NOUT,*) 'Second formulation' IFAIL = 1 * CALL D01DAF(YA,YB,P1,P2B,FB,ABSACC,ANS,NPTS,IFAIL) * WRITE (NOUT,99999) 'Integral =', ANS WRITE (NOUT,99998) 'Number of function evaluations =', NPTS IF (IFAIL.GT.0) WRITE (NOUT,99997) 'IFAIL = ', IFAIL STOP * 99999 FORMAT (1X,A,F9.4) 99998 FORMAT (1X,A,I5) 99997 FORMAT (1X,A,I2) END * DOUBLE PRECISION FUNCTION P1(Y) * .. Scalar Arguments .. DOUBLE PRECISION Y * .. Executable Statements .. P1 = 0.0D0 RETURN END * DOUBLE PRECISION FUNCTION P2A(Y) * .. Scalar Arguments .. DOUBLE PRECISION Y * .. Intrinsic Functions .. INTRINSIC SQRT * .. Executable Statements .. P2A = SQRT(1.0D0-Y*Y) RETURN END * DOUBLE PRECISION FUNCTION FA(X,Y) * .. Scalar Arguments .. DOUBLE PRECISION X, Y * .. Executable Statements .. FA = X + Y RETURN END * DOUBLE PRECISION FUNCTION P2B(Y) ***************************************************** * Add USE statements for relevant chapters * USE NAG_F77_X_CHAPTER * * ***************************************************** * .. Scalar Arguments .. DOUBLE PRECISION Y * .. External Functions .. ****************************************************** * Function Type declarations need to be removed. * C DOUBLE PRECISION X01AAF * * ****************************************************** ****************************************************** * EXTERNAL declarations need to be removed. * C EXTERNAL X01AAF * * ****************************************************** * .. Executable Statements .. P2B = 0.5D0*X01AAF(0.0D0) RETURN END * DOUBLE PRECISION FUNCTION FB(X,Y) * .. Scalar Arguments .. DOUBLE PRECISION X, Y * .. Intrinsic Functions .. INTRINSIC COS, SIN * .. Executable Statements .. FB = Y*Y*(COS(X)+SIN(X)) RETURN END
In this implementation calls to BLAS and LAPACK routines are implemented by calls to Sun Performance Library (Sunperf),
except for the following routines:
DBDSDC DBDSQR DGBRFS DGBSV DGBSVX DGBTRF DGBTRS DGEBRD DGEES DGEESX DGEEV DGEEVX DGELS DGELSD DGELSS DGELSY DGEQP3 DGEQRF DGERFS DGESDD DGESV DGESVD DGESVX DGETRF DGETRS DGGES DGGESX DGGEV DGGEVX DGGGLM DGGLSE DGGQRF DGGRQF DGTRFS DGTSVX DHSEIN DHSEQR DLALSD DLASDA DLASDQ DOPGTR DORGBR DORGHR DORGQR DORGTR DORMBR DORMHR DORMQR DORMTR DPBRFS DPBSV DPBSVX DPBTRS DPORFS DPOSV DPOSVX DPOTRF DPOTRS DPPRFS DPPSV DPPSVX DPPTRS DPTEQR DPTRFS DPTSVX DSBEV DSBEVD DSBEVX DSBGV DSBGVD DSBGVX DSBTRD DSPEV DSPEVD DSPEVX DSPGV DSPGVD DSPGVX DSPRFS DSPSVX DSTEBZ DSTEDC DSTEGR DSTEIN DSTEQR DSTEV DSTEVD DSTEVR DSTEVX DSYEV DSYEVD DSYEVR DSYEVX DSYGV DSYGVD DSYGVX DSYRFS DSYSVX DSYTRD DTBRFS DTBTRS DTGSYL DTPRFS DTPTRS DTRRFS DTRSEN ZBDSQR ZGBRFS ZGBSV ZGBSVX ZGBTRF ZGBTRS ZGEBRD ZGEES ZGEESX ZGEEV ZGEEVX ZGELS ZGELSD ZGELSS ZGELSY ZGEQP3 ZGEQRF ZGERFS ZGESDD ZGESV ZGESVD ZGESVX ZGETRF ZGETRS ZGGES ZGGESX ZGGEV ZGGEVX ZGGGLM ZGGLSE ZGGQRF ZGGRQF ZGTRFS ZGTSVX ZHBEV ZHBEVD ZHBEVX ZHBGV ZHBGVD ZHBGVX ZHBTRD ZHEEV ZHEEVD ZHEEVR ZHEEVX ZHEGV ZHEGVD ZHEGVX ZHERFS ZHESVX ZHETRD ZHPEV ZHPEVD ZHPEVX ZHPGV ZHPGVD ZHPGVX ZHPRFS ZHPSVX ZHSEIN ZHSEQR ZLALSD ZPBRFS ZPBSV ZPBSVX ZPBTRS ZPORFS ZPOSV ZPOSVX ZPOTRF ZPOTRS ZPPRFS ZPPSV ZPPSVX ZPPTRS ZPTEQR ZPTRFS ZPTSVX ZSPRFS ZSPSVX ZSTEDC ZSTEGR ZSTEIN ZSTEQR ZSYRFS ZSYSVX ZTBRFS ZTBTRS ZTPRFS ZTPTRS ZTRRFS ZUNGBR ZUNGHR ZUNGQR ZUNGTR ZUNMBR ZUNMHR ZUNMQR ZUNMTR ZUPGTR
S07AAF F(1) = 1.0D+13 F(2) = 1.0D-14 S10AAF E(1) = 1.8500D+1 S10ABF E(1) = 7.080D+2 S10ACF E(1) = 7.080D+2 S13AAF x(hi) = 7.083D+2 S13ACF x(hi) = 1.0D+16 S13ADF x(hi) = 1.0D+17 S14AAF IFAIL = 1 if X > 1.70D+2 IFAIL = 2 if X < -1.70D+2 IFAIL = 3 if abs(X) < 2.23D-308 S14ABF IFAIL = 2 if X > 2.55D+305 S15ADF x(hi) = 2.66D+1 x(low) = -6.25D+0 S15AEF x(hi) = 6.25D+0 S17ACF IFAIL = 1 if X > 1.0D+16 S17ADF IFAIL = 1 if X > 1.0D+16 IFAIL = 3 if 0.0D+00 < X <= 2.23D-308 S17AEF IFAIL = 1 if abs(X) > 1.0D+16 S17AFF IFAIL = 1 if abs(X) > 1.0D+16 S17AGF IFAIL = 1 if X > 1.038D+2 IFAIL = 2 if X < -5.6D+10 S17AHF IFAIL = 1 if X > 1.041D+2 IFAIL = 2 if X < -5.6D+10 S17AJF IFAIL = 1 if X > 1.041D+2 IFAIL = 2 if X < -1.8D+9 S17AKF IFAIL = 1 if X > 1.041D+2 IFAIL = 2 if X < -1.8D+9 S17DCF IFAIL = 2 if abs (Z) < 3.93D-305 IFAIL = 4 if abs (Z) or FNU+N-1 > 3.27D+4 IFAIL = 5 if abs (Z) or FNU+N-1 > 1.07D+9 S17DEF IFAIL = 2 if imag (Z) > 7.00D+2 IFAIL = 3 if abs (Z) or FNU+N-1 > 3.27D+4 IFAIL = 4 if abs (Z) or FNU+N-1 > 1.07D+9 S17DGF IFAIL = 3 if abs (Z) > 1.02D+3 IFAIL = 4 if abs (Z) > 1.04D+6 S17DHF IFAIL = 3 if abs (Z) > 1.02D+3 IFAIL = 4 if abs (Z) > 1.04D+6 S17DLF IFAIL = 2 if abs (Z) < 3.93D-305 IFAIL = 4 if abs (Z) or FNU+N-1 > 3.27D+4 IFAIL = 5 if abs (Z) or FNU+N-1 > 1.07D+9 S18ADF IFAIL = 2 if 0.0D+00 < X <= 2.23D-308 S18AEF IFAIL = 1 if abs(X) > 7.116D+2 S18AFF IFAIL = 1 if abs(X) > 7.116D+2 S18CDF IFAIL = 2 if 0.0D+00 < X <= 2.23D-308 S18DCF IFAIL = 2 if abs (Z) < 3.93D-305 IFAIL = 4 if abs (Z) or FNU+N-1 > 3.27D+4 IFAIL = 5 if abs (Z) or FNU+N-1 > 1.07D+9 S18DEF IFAIL = 2 if real (Z) > 7.00D+2 IFAIL = 3 if abs (Z) or FNU+N-1 > 3.27D+4 IFAIL = 4 if abs (Z) or FNU+N-1 > 1.07D+9 S19AAF IFAIL = 1 if abs(x) >= 4.95000D+1 S19ABF IFAIL = 1 if abs(x) >= 4.95000D+1 S19ACF IFAIL = 1 if X > 9.9726D+2 S19ADF IFAIL = 1 if X > 9.9726D+2 S21BCF IFAIL = 3 if an argument < 1.579D-205 IFAIL = 4 if an argument >= 3.774D+202 S21BDF IFAIL = 3 if an argument < 2.820D-103 IFAIL = 4 if an argument >= 1.404D+102
X01AAF (PI) = 3.1415926535897932D+00 X01ABF (GAMMA) = 0.5772156649015329D+00
X02BHF = 2 X02BJF = 53 X02BKF = -1021 X02BLF = 1024 X02DJF = .TRUE.Derived parameters of the floating-point arithmetic
X02AJF = 1.11022302462516D-16 X02AKF = 2.22507385850721D-308 X02ALF = 1.79769313486231D+308 X02AMF = 2.22507385850721D-308 X02ANF = 2.22507385850721D-308Parameters of other aspects of the computing environment
X02AHF = 1.42724769270596D+45 X02BBF = 2147483647 X02BEF = 15 X02DAF = .FALSE.
The Library Manual is supplied in the form of Portable Document Format (PDF) files, with an HTML index, in the nagdoc_mk21 directory. The introductory material is also provided as HTML files in the nagdoc_mk21 directory.
A main index file has been provided (nagdoc_mk21/html/mark21.html) which contains a fully linked contents document pointing to all the available PDF (and where available HTML) files. Use your HTML browser to navigate from here.
In addition the following are provided:
The NAG Response Centres are available for general enquiries from all users and also for technical queries from sites with an annually licensed product or support service.
The Response Centres are open during office hours, but contact is possible by fax, email and phone (answering machine) at all times.
When contacting a Response Centre, it helps us deal with your enquiry quickly if you can quote your NAG site reference and NAG product code (in this case FSSOL21DCL).
The NAG websites provide information about implementation availability, descriptions of products, downloadable software, product documentation and technical reports. The NAG websites can be accessed at the following URLs:
http://www.nag.co.uk/, http://www.nag.com/ or http://www.nag-j.co.jp/
NAG Ltd Wilkinson House Jordan Hill Road OXFORD OX2 8DR NAG Ltd Response Centre United Kingdom email: support@nag.co.uk Tel: +44 (0)1865 511245 Tel: +44 (0)1865 311744 Fax: +44 (0)1865 310139 Fax: +44 (0)1865 310139 NAG Inc 1431 Opus Place, Suite 220 Downers Grove IL 60515-1362 NAG Inc Response Center USA email: support@nag.com Tel: +1 630 971 2337 Tel: +1 630 971 2337 Fax: +1 630 971 2706 Fax: +1 630 971 2706 Nihon NAG KK Hatchobori Frontier Building 2F 4-9-9 Hatchobori Chuo-ku Tokyo 104-0032 Japan email: help@nag-j.co.jp Tel: +81 (0)3 5542 6311 Fax: +81 (0)3 5542 6312