SuperLU_DIST  4.0
superlu_dist on CPU and GPU clusters
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Functions
pdgstrf_sherry.c File Reference
#include <math.h>
#include "superlu_ddefs.h"

Functions

int_t pdgstrf (superlu_options_t *options, int m, int n, double anorm, LUstruct_t *LUstruct, gridinfo_t *grid, SuperLUStat_t *stat, int *info)
 

Function Documentation

int_t pdgstrf ( superlu_options_t options,
int  m,
int  n,
double  anorm,
LUstruct_t LUstruct,
gridinfo_t grid,
SuperLUStat_t stat,
int *  info 
)

Purpose

 PDGSTRF performs the LU factorization in parallel.

Arguments

options (input) superlu_options_t*
        The structure defines the input parameters to control
        how the LU decomposition will be performed.
        The following field should be defined:
        o ReplaceTinyPivot (yes_no_t)
          Specifies whether to replace the tiny diagonals by
          sqrt(epsilon)*norm(A) during LU factorization.
m      (input) int
       Number of rows in the matrix.
n      (input) int
       Number of columns in the matrix.
anorm  (input) double
       The norm of the original matrix A, or the scaled A if
       equilibration was done.
LUstruct (input/output) LUstruct_t*
        The data structures to store the distributed L and U factors.
        The following fields should be defined:
        o Glu_persist (input) Glu_persist_t*
          Global data structure (xsup, supno) replicated on all processes,
          describing the supernode partition in the factored matrices
          L and U:
        xsup[s] is the leading column of the s-th supernode,
            supno[i] is the supernode number to which column i belongs.
        o Llu (input/output) LocalLU_t*
          The distributed data structures to store L and U factors.
          See superlu_ddefs.h for the definition of 'LocalLU_t'.
grid   (input) gridinfo_t*
       The 2D process mesh. It contains the MPI communicator, the number
       of process rows (NPROW), the number of process columns (NPCOL),
       and my process rank. It is an input argument to all the
       parallel routines.
       Grid can be initialized by subroutine SUPERLU_GRIDINIT.
       See superlu_ddefs.h for the definition of 'gridinfo_t'.
stat   (output) SuperLUStat_t*
       Record the statistics on runtime and floating-point operation count.
       See util.h for the definition of 'SuperLUStat_t'.
info   (output) int*
       = 0: successful exit
       < 0: if info = -i, the i-th argument had an illegal value
       > 0: if info = i, U(i,i) is exactly zero. The factorization has
            been completed, but the factor U is exactly singular,
            and division by zero will occur if it is used to solve a
            system of equations.