Integer, Intent (In)	::	n, m, lda, ldb
Integer, Intent (Inout)	::	ifail
Complex (Kind=nag_wp), Intent (In)	::	t
Complex (Kind=nag_wp), Intent (Inout)	::	a(lda,), b(ldb,)

C Header Interface

#include <nag.h>

void	f01haf_ (const Integer n, const Integer m, Complex a[], const Integer lda, Complex b[], const Integer ldb, const Complex t, Integer ifail)

The routine may be called by the names f01haf or nagf_matop_complex_gen_matrix_actexp.

3 Description

e^{t A} B

is computed using the algorithm described in Al–Mohy and Higham (2011) which uses a truncated Taylor series to compute the product

e^{t A} B

without explicitly forming

e^{t A}

4 References

Al–Mohy A H and Higham N J (2011) Computing the action of the matrix exponential, with an application to exponential integrators SIAM J. Sci. Statist. Comput. 33(2) 488-511

Higham N J (2008) Functions of Matrices: Theory and Computation SIAM, Philadelphia, PA, USA

5 Arguments

1: $n$ – Integer Input: On entry: $n$ , the order of the matrix $A$ .

Constraint: $n \geq 0$ .
2: $m$ – Integer Input: On entry: $m$ , the number of columns of the matrix $B$ .

Constraint: $m \geq 0$ .
3: $a (lda *)$ – Complex (Kind=nag_wp) array Input/Output: Note: the second dimension of the array a must be at least $n$ .

On entry: the $n$ by $n$ matrix $A$ .

On exit: $A$ is overwritten during the computation.
4: $lda$ – Integer Input: On entry: the first dimension of the array a as declared in the (sub)program from which f01haf is called.

Constraint: $lda \geq n$ .
5: $b (ldb *)$ – Complex (Kind=nag_wp) array Input/Output: Note: the second dimension of the array b must be at least $m$ .

On entry: the $n$ by $m$ matrix $B$ .

On exit: the $n$ by $m$ matrix $e^{t A} B$ .
6: $ldb$ – Integer Input: On entry: the first dimension of the array b as declared in the (sub)program from which f01haf is called.

Constraint: $ldb \geq n$ .
7: $t$ – Complex (Kind=nag_wp) Input: On entry: the scalar $t$ .
8: $ifail$ – Integer Input/Output: On entry: ifail must be set to $0$ , $- 1 or 1$ . If you are unfamiliar with this argument you should refer to Section 4 in the Introduction to the NAG Library FL Interface for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value $- 1 or 1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this argument, the recommended value is $0$ . When the value $- 1 or 1$ is used it is essential to test the value of ifail on exit.

On exit: $ifail = 0$ unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry

ifail = 0

- 1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 2$: $e^{t A} B$ has been computed using an IEEE double precision Taylor series, although the arithmetic precision is higher than IEEE double precision.

$ifail = - 1$: On entry, $n = 〈value〉$ .
Constraint: $n \geq 0$ .

$ifail = - 2$: On entry, $m = 〈value〉$ .
Constraint: $m \geq 0$ .

$ifail = - 4$: On entry, $lda = 〈value〉$ and $n = 〈value〉$ .
Constraint: $lda \geq n$ .

$ifail = - 6$: On entry, $ldb = 〈value〉$ and $n = 〈value〉$ .
Constraint: $ldb \geq n$ .

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

For a Hermitian matrix

A

(for which

A^{H} = A

) the computed matrix

e^{t A} B

is guaranteed to be close to the exact matrix, that is, the method is forward stable. No such guarantee can be given for non-Hermitian matrices. See Section 4 of Al–Mohy and Higham (2011) for details and further discussion.

8 Parallelism and Performance

f01haf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

f01haf makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.

Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9 Further Comments

The matrix

e^{t A} B

could be computed by explicitly forming

e^{t A}

using f01fcf and multiplying

B

by the result. However, experiments show that it is usually both more accurate and quicker to use f01haf.

The cost of the algorithm is

O (n^{2} m)

. The precise cost depends on

A

since a combination of balancing, shifting and scaling is used prior to the Taylor series evaluation.

Approximately

n^{2} + (2 m + 8) n

of complex allocatable memory is required by f01haf.

f01gaf can be used to compute

e^{t A} B

for real

A

B

, and

t

. f01hbf provides an implementation of the algorithm with a reverse communication interface, which returns control to the calling program when matrix multiplications are required. This should be used if

A

is large and sparse.

10 Example

This example computes

e^{t A} B

, where

A = (\begin{array}{r} 0.5 + 0.0 i & - 0.2 + 0.0 i & 1.0 + 0.1 i & 0.0 + 0.4 i \\ 0.3 + 0.0 i & 0.5 + 1.2 i & 3.1 + 0.0 i & 1.0 + 0.2 i \\ 0.0 + 2.0 i & 0.1 + 0.0 i & 1.2 + 0.2 i & 0.5 + 0.0 i \\ 1.0 + 0.3 i & 0.0 + 0.2 i & 0.0 + 0.9 i & 0.5 + 0.0 i \end{array}),

B = (\begin{array}{r} 0.4 + 0.0 i & 1.2 + 0.0 i \\ 1.3 + 0.0 i & - 0.2 + 0.1 i \\ 0.0 + 0.3 i & 2.1 + 0.0 i \\ 0.4 + 0.0 i & - 0.9 + 0.0 i \end{array})

and

t = - 0.5 + 0.0 i .

Interfaces: FL CL AD

NAG FL Interface Introduction

F01 (Matop) Chapter Contents

F01 (Matop) Chapter Introduction

f01ha: FL CL AD

NAG FL Interfacef01haf (complex_​gen_​matrix_​actexp)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG FL Interface
f01haf (complex_gen_matrix_actexp)