Fast Auxiliary Space Preconditioning  1.8.4 Feb/15/2016
fasp_const.h File Reference

Definition of all kinds of messages, including error messages, solver types, etc. More...

Go to the source code of this file.

Macros

#define FASP_SUCCESS   0
 Definition of return status and error messages. More...
 
#define ERROR_OPEN_FILE   -10
 
#define ERROR_WRONG_FILE   -11
 
#define ERROR_INPUT_PAR   -13
 
#define ERROR_REGRESS   -14
 
#define ERROR_MAT_SIZE   -15
 
#define ERROR_NUM_BLOCKS   -18
 
#define ERROR_MISC   -19
 
#define ERROR_ALLOC_MEM   -20
 
#define ERROR_DATA_STRUCTURE   -21
 
#define ERROR_DATA_ZERODIAG   -22
 
#define ERROR_DUMMY_VAR   -23
 
#define ERROR_AMG_INTERP_TYPE   -30
 
#define ERROR_AMG_SMOOTH_TYPE   -31
 
#define ERROR_AMG_COARSE_TYPE   -32
 
#define ERROR_AMG_COARSEING   -33
 
#define ERROR_SOLVER_TYPE   -40
 
#define ERROR_SOLVER_PRECTYPE   -41
 
#define ERROR_SOLVER_STAG   -42
 
#define ERROR_SOLVER_SOLSTAG   -43
 
#define ERROR_SOLVER_TOLSMALL   -44
 
#define ERROR_SOLVER_ILUSETUP   -45
 
#define ERROR_SOLVER_MISC   -46
 
#define ERROR_SOLVER_MAXIT   -48
 
#define ERROR_SOLVER_EXIT   -49
 
#define ERROR_QUAD_TYPE   -60
 
#define ERROR_QUAD_DIM   -61
 
#define ERROR_LIC_TYPE   -80
 
#define ERROR_UNKNOWN   -99
 
#define TRUE   1
 Definition of logic type. More...
 
#define FALSE   0
 
#define ON   1
 Definition of switch. More...
 
#define OFF   0
 
#define PRINT_NONE   0
 Print level for all subroutines – not including DEBUG output. More...
 
#define PRINT_MIN   1
 
#define PRINT_SOME   2
 
#define PRINT_MORE   4
 
#define PRINT_MOST   8
 
#define PRINT_ALL   10
 
#define MAT_FREE   0
 Definition of matrix format. More...
 
#define MAT_CSR   1
 
#define MAT_BSR   2
 
#define MAT_STR   3
 
#define MAT_bCSR   4
 
#define MAT_bBSR   5
 
#define MAT_CSRL   6
 
#define MAT_SymCSR   7
 
#define SOLVER_DEFAULT   0
 Definition of solver types for iterative methods. More...
 
#define SOLVER_CG   1
 
#define SOLVER_BiCGstab   2
 
#define SOLVER_MinRes   3
 
#define SOLVER_GMRES   4
 
#define SOLVER_VGMRES   5
 
#define SOLVER_VFGMRES   6
 
#define SOLVER_GCG   7
 
#define SOLVER_GCR   8
 
#define SOLVER_SCG   11
 
#define SOLVER_SBiCGstab   12
 
#define SOLVER_SMinRes   13
 
#define SOLVER_SGMRES   14
 
#define SOLVER_SVGMRES   15
 
#define SOLVER_SVFGMRES   16
 
#define SOLVER_SGCG   17
 
#define SOLVER_AMG   21
 
#define SOLVER_FMG   22
 
#define SOLVER_SUPERLU   31
 
#define SOLVER_UMFPACK   32
 
#define SOLVER_MUMPS   33
 
#define SOLVER_PARDISO   34
 
#define STOP_REL_RES   1
 Definition of iterative solver stopping criteria types. More...
 
#define STOP_REL_PRECRES   2
 
#define STOP_MOD_REL_RES   3
 
#define PREC_NULL   0
 Definition of preconditioner type for iterative methods. More...
 
#define PREC_DIAG   1
 
#define PREC_AMG   2
 
#define PREC_FMG   3
 
#define PREC_ILU   4
 
#define PREC_SCHWARZ   5
 
#define ILUk   1
 Type of ILU methods. More...
 
#define ILUt   2
 
#define ILUtp   3
 
#define SCHWARZ_FORWARD   1
 Type of Schwarz smoother. More...
 
#define SCHWARZ_BACKWARD   2
 
#define SCHWARZ_SYMMETRIC   3
 
#define CLASSIC_AMG   1
 Definition of AMG types. More...
 
#define SA_AMG   2
 
#define UA_AMG   3
 
#define PAIRWISE   1
 Definition of aggregation types. More...
 
#define VMB   2
 
#define V_CYCLE   1
 Definition of cycle types. More...
 
#define W_CYCLE   2
 
#define AMLI_CYCLE   3
 
#define NL_AMLI_CYCLE   4
 
#define SMOOTHER_JACOBI   1
 Definition of standard smoother types. More...
 
#define SMOOTHER_GS   2
 
#define SMOOTHER_SGS   3
 
#define SMOOTHER_CG   4
 
#define SMOOTHER_SOR   5
 
#define SMOOTHER_SSOR   6
 
#define SMOOTHER_GSOR   7
 
#define SMOOTHER_SGSOR   8
 
#define SMOOTHER_POLY   9
 
#define SMOOTHER_L1DIAG   10
 
#define COARSE_RS   1
 Definition of coarsening types. More...
 
#define COARSE_RSP   2
 
#define COARSE_CR   3
 
#define COARSE_AC   4
 
#define COARSE_MIS   5
 
#define INTERP_DIR   1
 Definition of interpolation types. More...
 
#define INTERP_STD   2
 
#define INTERP_ENG   3
 
#define G0PT   -5
 Type of vertices (DOFs) for coarsening. More...
 
#define UNPT   -1
 
#define FGPT   0
 
#define CGPT   1
 
#define ISPT   2
 
#define NO_ORDER   0
 Definition of smoothing order. More...
 
#define CF_ORDER   1
 
#define USERDEFINED   0
 Type of ordering for smoothers. More...
 
#define CPFIRST   1
 
#define FPFIRST   -1
 
#define ASCEND   12
 
#define DESCEND   21
 
#define BIGREAL   1e+20
 Some global constants. More...
 
#define SMALLREAL   1e-20
 
#define SMALLREAL2   1e-40
 
#define MAX_REFINE_LVL   20
 
#define MAX_AMG_LVL   20
 
#define MIN_CDOF   20
 
#define MIN_CRATE   0.9
 
#define MAX_CRATE   20.0
 
#define MAX_RESTART   20
 
#define MAX_STAG   20
 
#define STAG_RATIO   1e-4
 
#define OPENMP_HOLDS   2000
 

Detailed Description

Definition of all kinds of messages, including error messages, solver types, etc.

Note
This is internal use only. Do NOT change.
Created by Chensong Zhang on 03/20/2010. Modified by Chensong Zhang on 12/06/2011. Modified by Chensong Zhang on 12/25/2011. Modified by Chensong Zhang on 04/22/2012. Modified by Ludmil Zikatanov on 02/15/2013: CG -> SMOOTHER_CG. Modified by Chensong Zhang on 02/16/2013: GS -> SMOOTHER_GS, etc. Modified by Chensong Zhang on 04/09/2013: Add safe Krylov methods. Modified by Chensong Zhang on 09/22/2013: Clean up Doxygen.

Modified by Chensong Zhang on 09/17/2013: Filename changed from message.h.

Definition in file fasp_const.h.

Macro Definition Documentation

#define AMLI_CYCLE   3

AMLI-cycle

Definition at line 177 of file fasp_const.h.

#define ASCEND   12

Ascending order

Definition at line 231 of file fasp_const.h.

#define BIGREAL   1e+20

Some global constants.

A large real number

Definition at line 237 of file fasp_const.h.

#define CF_ORDER   1

C/F order smoothing

Definition at line 223 of file fasp_const.h.

#define CGPT   1

Coarse grid points

Definition at line 216 of file fasp_const.h.

#define CLASSIC_AMG   1

Definition of AMG types.

classic AMG

Definition at line 162 of file fasp_const.h.

#define COARSE_AC   4

Aggressive coarsening

Definition at line 200 of file fasp_const.h.

#define COARSE_CR   3

Compatible relaxation

Definition at line 199 of file fasp_const.h.

#define COARSE_MIS   5

Aggressive coarsening based on MIS

Definition at line 201 of file fasp_const.h.

#define COARSE_RS   1

Definition of coarsening types.

Classical

Definition at line 197 of file fasp_const.h.

#define COARSE_RSP   2

Classical, with positive offdiags

Definition at line 198 of file fasp_const.h.

#define CPFIRST   1

C-points first order

Definition at line 229 of file fasp_const.h.

#define DESCEND   21

Descending order

Definition at line 232 of file fasp_const.h.

#define ERROR_ALLOC_MEM   -20

fail to allocate memory

Definition at line 37 of file fasp_const.h.

#define ERROR_AMG_COARSE_TYPE   -32

unknown coarsening type

Definition at line 44 of file fasp_const.h.

#define ERROR_AMG_COARSEING   -33

coarsening step failed to complete

Definition at line 45 of file fasp_const.h.

#define ERROR_AMG_INTERP_TYPE   -30

unknown interpolation type

Definition at line 42 of file fasp_const.h.

#define ERROR_AMG_SMOOTH_TYPE   -31

unknown smoother type

Definition at line 43 of file fasp_const.h.

#define ERROR_DATA_STRUCTURE   -21

problem with data structures

Definition at line 38 of file fasp_const.h.

#define ERROR_DATA_ZERODIAG   -22

matrix has zero diagonal entries

Definition at line 39 of file fasp_const.h.

#define ERROR_DUMMY_VAR   -23

unexpected input data

Definition at line 40 of file fasp_const.h.

#define ERROR_INPUT_PAR   -13

wrong input argument

Definition at line 31 of file fasp_const.h.

#define ERROR_LIC_TYPE   -80

wrong license type

Definition at line 60 of file fasp_const.h.

#define ERROR_MAT_SIZE   -15

wrong problem size

Definition at line 33 of file fasp_const.h.

#define ERROR_MISC   -19

other error

Definition at line 35 of file fasp_const.h.

#define ERROR_NUM_BLOCKS   -18

wrong number of blocks

Definition at line 34 of file fasp_const.h.

#define ERROR_OPEN_FILE   -10

fail to open a file

Definition at line 29 of file fasp_const.h.

#define ERROR_QUAD_DIM   -61

unsupported quadrature dim

Definition at line 58 of file fasp_const.h.

#define ERROR_QUAD_TYPE   -60

unknown quadrature type

Definition at line 57 of file fasp_const.h.

#define ERROR_REGRESS   -14

regression test fail

Definition at line 32 of file fasp_const.h.

#define ERROR_SOLVER_EXIT   -49

solver does not quit successfully

Definition at line 55 of file fasp_const.h.

#define ERROR_SOLVER_ILUSETUP   -45

ILU setup error

Definition at line 52 of file fasp_const.h.

#define ERROR_SOLVER_MAXIT   -48

maximal iteration number exceeded

Definition at line 54 of file fasp_const.h.

#define ERROR_SOLVER_MISC   -46

misc solver error during run time

Definition at line 53 of file fasp_const.h.

#define ERROR_SOLVER_PRECTYPE   -41

unknown precond type

Definition at line 48 of file fasp_const.h.

#define ERROR_SOLVER_SOLSTAG   -43

solver's solution is too small

Definition at line 50 of file fasp_const.h.

#define ERROR_SOLVER_STAG   -42

solver stagnates

Definition at line 49 of file fasp_const.h.

#define ERROR_SOLVER_TOLSMALL   -44

solver's tolerance is too small

Definition at line 51 of file fasp_const.h.

#define ERROR_SOLVER_TYPE   -40

unknown solver type

Definition at line 47 of file fasp_const.h.

#define ERROR_UNKNOWN   -99

an unknown error type

Definition at line 62 of file fasp_const.h.

#define ERROR_WRONG_FILE   -11

input contains wrong format

Definition at line 30 of file fasp_const.h.

#define FALSE   0

logic FALSE

Definition at line 68 of file fasp_const.h.

#define FASP_SUCCESS   0

Definition of return status and error messages.

return from function successfully

Definition at line 27 of file fasp_const.h.

#define FGPT   0

Fine grid points

Definition at line 215 of file fasp_const.h.

#define FPFIRST   -1

F-points first order

Definition at line 230 of file fasp_const.h.

#define G0PT   -5

Type of vertices (DOFs) for coarsening.

Cannot fit in aggregates

Definition at line 213 of file fasp_const.h.

#define ILUk   1

Type of ILU methods.

ILUk

Definition at line 148 of file fasp_const.h.

#define ILUt   2

ILUt

Definition at line 149 of file fasp_const.h.

#define ILUtp   3

ILUtp

Definition at line 150 of file fasp_const.h.

#define INTERP_DIR   1

Definition of interpolation types.

Direct interpolation

Definition at line 206 of file fasp_const.h.

#define INTERP_ENG   3

energy minimization interpolation

Definition at line 208 of file fasp_const.h.

#define INTERP_STD   2

Standard interpolation

Definition at line 207 of file fasp_const.h.

#define ISPT   2

Isolated points

Definition at line 217 of file fasp_const.h.

#define MAT_bBSR   5

block matrix of BSR for bordered systems

Definition at line 94 of file fasp_const.h.

#define MAT_bCSR   4

block matrix of CSR

Definition at line 93 of file fasp_const.h.

#define MAT_BSR   2

block-wise compressed sparse row

Definition at line 91 of file fasp_const.h.

#define MAT_CSR   1

compressed sparse row

Definition at line 90 of file fasp_const.h.

#define MAT_CSRL   6

modified CSR to reduce cache missing

Definition at line 95 of file fasp_const.h.

#define MAT_FREE   0

Definition of matrix format.

matrix-free format: only mxv action

Definition at line 89 of file fasp_const.h.

#define MAT_STR   3

structured sparse matrix

Definition at line 92 of file fasp_const.h.

#define MAT_SymCSR   7

symmetric CSR format

Definition at line 96 of file fasp_const.h.

#define MAX_AMG_LVL   20

Maximal AMG coarsening level

Definition at line 241 of file fasp_const.h.

#define MAX_CRATE   20.0

Maximal coarsening ratio

Definition at line 244 of file fasp_const.h.

#define MAX_REFINE_LVL   20

Maximal refinement level

Definition at line 240 of file fasp_const.h.

#define MAX_RESTART   20

Maximal restarting number

Definition at line 245 of file fasp_const.h.

#define MAX_STAG   20

Maximal number of stagnation times

Definition at line 246 of file fasp_const.h.

#define MIN_CDOF   20

Minimal number of coarsest variables

Definition at line 242 of file fasp_const.h.

#define MIN_CRATE   0.9

Minimal coarsening ratio

Definition at line 243 of file fasp_const.h.

#define NL_AMLI_CYCLE   4

Nonlinear AMLI-cycle

Definition at line 178 of file fasp_const.h.

#define NO_ORDER   0

Definition of smoothing order.

Natural order smoothing

Definition at line 222 of file fasp_const.h.

#define OFF   0

turn off certain parameter

Definition at line 74 of file fasp_const.h.

#define ON   1

Definition of switch.

turn on certain parameter

Definition at line 73 of file fasp_const.h.

#define OPENMP_HOLDS   2000

Smallest size for OpenMP version

Definition at line 248 of file fasp_const.h.

#define PAIRWISE   1

Definition of aggregation types.

pairwise aggregation

Definition at line 169 of file fasp_const.h.

#define PREC_AMG   2

with AMG precond

Definition at line 140 of file fasp_const.h.

#define PREC_DIAG   1

with diagonal precond

Definition at line 139 of file fasp_const.h.

#define PREC_FMG   3

with full AMG precond

Definition at line 141 of file fasp_const.h.

#define PREC_ILU   4

with ILU precond

Definition at line 142 of file fasp_const.h.

#define PREC_NULL   0

Definition of preconditioner type for iterative methods.

with no precond

Definition at line 138 of file fasp_const.h.

#define PREC_SCHWARZ   5

with Schwarz preconditioner

Definition at line 143 of file fasp_const.h.

#define PRINT_ALL   10

all: all printouts, including files

Definition at line 84 of file fasp_const.h.

#define PRINT_MIN   1

quiet: print error, important warnings

Definition at line 80 of file fasp_const.h.

#define PRINT_MORE   4

more: print some useful debug info

Definition at line 82 of file fasp_const.h.

#define PRINT_MOST   8

most: maximal printouts, no files

Definition at line 83 of file fasp_const.h.

#define PRINT_NONE   0

Print level for all subroutines – not including DEBUG output.

silent: no printout at all

Definition at line 79 of file fasp_const.h.

#define PRINT_SOME   2

some: print less important warnings

Definition at line 81 of file fasp_const.h.

#define SA_AMG   2

smoothed aggregation AMG

Definition at line 163 of file fasp_const.h.

#define SCHWARZ_BACKWARD   2

Backward ordering

Definition at line 156 of file fasp_const.h.

#define SCHWARZ_FORWARD   1

Type of Schwarz smoother.

Forward ordering

Definition at line 155 of file fasp_const.h.

#define SCHWARZ_SYMMETRIC   3

Symmetric smoother

Definition at line 157 of file fasp_const.h.

#define SMALLREAL   1e-20

A small real number

Definition at line 238 of file fasp_const.h.

#define SMALLREAL2   1e-40

An extremely small real number

Definition at line 239 of file fasp_const.h.

#define SMOOTHER_CG   4

CG as a smoother

Definition at line 186 of file fasp_const.h.

#define SMOOTHER_GS   2

Gauss-Seidel smoother

Definition at line 184 of file fasp_const.h.

#define SMOOTHER_GSOR   7

GS + SOR smoother

Definition at line 189 of file fasp_const.h.

#define SMOOTHER_JACOBI   1

Definition of standard smoother types.

Jacobi smoother

Definition at line 183 of file fasp_const.h.

#define SMOOTHER_L1DIAG   10

L1 norm diagonal scaling smoother

Definition at line 192 of file fasp_const.h.

#define SMOOTHER_POLY   9

Polynomial smoother

Definition at line 191 of file fasp_const.h.

#define SMOOTHER_SGS   3

Symmetric Gauss-Seidel smoother

Definition at line 185 of file fasp_const.h.

#define SMOOTHER_SGSOR   8

SGS + SSOR smoother

Definition at line 190 of file fasp_const.h.

#define SMOOTHER_SOR   5

SOR smoother

Definition at line 187 of file fasp_const.h.

#define SMOOTHER_SSOR   6

SSOR smoother

Definition at line 188 of file fasp_const.h.

#define SOLVER_AMG   21

AMG as an iterative solver

Definition at line 120 of file fasp_const.h.

#define SOLVER_BiCGstab   2

Bi-Conjugate Gradient Stabilized

Definition at line 104 of file fasp_const.h.

#define SOLVER_CG   1

Conjugate Gradient

Definition at line 103 of file fasp_const.h.

#define SOLVER_DEFAULT   0

Definition of solver types for iterative methods.

Use default solver in FASP

Definition at line 101 of file fasp_const.h.

#define SOLVER_FMG   22

Full AMG as an solver

Definition at line 121 of file fasp_const.h.

#define SOLVER_GCG   7

Generalized Conjugate Gradient

Definition at line 109 of file fasp_const.h.

#define SOLVER_GCR   8

Generalized Conjugate Residual

Definition at line 110 of file fasp_const.h.

#define SOLVER_GMRES   4

Generalized Minimal Residual

Definition at line 106 of file fasp_const.h.

#define SOLVER_MinRes   3

Minimal Residual

Definition at line 105 of file fasp_const.h.

#define SOLVER_MUMPS   33

Direct Solver: MUMPS

Definition at line 125 of file fasp_const.h.

#define SOLVER_PARDISO   34

Direct Solver: PARDISO

Definition at line 126 of file fasp_const.h.

#define SOLVER_SBiCGstab   12

BiCGstab with safety net

Definition at line 113 of file fasp_const.h.

#define SOLVER_SCG   11

Conjugate Gradient with safety net

Definition at line 112 of file fasp_const.h.

#define SOLVER_SGCG   17

GCG with safety net

Definition at line 118 of file fasp_const.h.

#define SOLVER_SGMRES   14

GMRes with safety net

Definition at line 115 of file fasp_const.h.

#define SOLVER_SMinRes   13

MinRes with safety net

Definition at line 114 of file fasp_const.h.

#define SOLVER_SUPERLU   31

Direct Solver: SuperLU

Definition at line 123 of file fasp_const.h.

#define SOLVER_SVFGMRES   16

Variable-restart FGMRES with safety net

Definition at line 117 of file fasp_const.h.

#define SOLVER_SVGMRES   15

Variable-restart GMRES with safety net

Definition at line 116 of file fasp_const.h.

#define SOLVER_UMFPACK   32

Direct Solver: UMFPack

Definition at line 124 of file fasp_const.h.

#define SOLVER_VFGMRES   6

Variable Restarting Flexible GMRES

Definition at line 108 of file fasp_const.h.

#define SOLVER_VGMRES   5

Variable Restarting GMRES

Definition at line 107 of file fasp_const.h.

#define STAG_RATIO   1e-4

Stagnation tolerance = tol*STAGRATIO

Definition at line 247 of file fasp_const.h.

#define STOP_MOD_REL_RES   3

modified relative residual ||r||/||x||

Definition at line 133 of file fasp_const.h.

#define STOP_REL_PRECRES   2

relative B-residual ||r||_B/||b||_B

Definition at line 132 of file fasp_const.h.

#define STOP_REL_RES   1

Definition of iterative solver stopping criteria types.

relative residual ||r||/||b||

Definition at line 131 of file fasp_const.h.

#define TRUE   1

Definition of logic type.

logic TRUE

Definition at line 67 of file fasp_const.h.

#define UA_AMG   3

unsmoothed aggregation AMG

Definition at line 164 of file fasp_const.h.

#define UNPT   -1

Undetermined points

Definition at line 214 of file fasp_const.h.

#define USERDEFINED   0

Type of ordering for smoothers.

User defined order

Definition at line 228 of file fasp_const.h.

#define V_CYCLE   1

Definition of cycle types.

V-cycle

Definition at line 175 of file fasp_const.h.

#define VMB   2

VMB aggregation

Definition at line 170 of file fasp_const.h.

#define W_CYCLE   2

W-cycle

Definition at line 176 of file fasp_const.h.