/usr/include/HYPRE_struct_ls.h is in libhypre-dev 2.4.0b-7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 | /*BHEADER**********************************************************************
* Copyright (c) 2008, Lawrence Livermore National Security, LLC.
* Produced at the Lawrence Livermore National Laboratory.
* This file is part of HYPRE. See file COPYRIGHT for details.
*
* HYPRE is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License (as published by the Free
* Software Foundation) version 2.1 dated February 1999.
*
* $Revision: 2.17 $
***********************************************************************EHEADER*/
/******************************************************************************
*
* Header file for HYPRE_ls library
*
*****************************************************************************/
#ifndef HYPRE_STRUCT_LS_HEADER
#define HYPRE_STRUCT_LS_HEADER
#include "HYPRE_utilities.h"
#include "HYPRE_struct_mv.h"
#ifdef __cplusplus
extern "C" {
#endif
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name Struct Solvers
*
* These solvers use matrix/vector storage schemes that are tailored
* to structured grid problems.
*
* @memo Linear solvers for structured grids
**/
/*@{*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name Struct Solvers
**/
/*@{*/
struct hypre_StructSolver_struct;
/**
* The solver object.
**/
typedef struct hypre_StructSolver_struct *HYPRE_StructSolver;
typedef int (*HYPRE_PtrToStructSolverFcn)(HYPRE_StructSolver,
HYPRE_StructMatrix,
HYPRE_StructVector,
HYPRE_StructVector);
#ifndef HYPRE_MODIFYPC
#define HYPRE_MODIFYPC
/* if pc not defined, then may need HYPRE_SOLVER also */
#ifndef HYPRE_SOLVER_STRUCT
#define HYPRE_SOLVER_STRUCT
struct hypre_Solver_struct;
typedef struct hypre_Solver_struct *HYPRE_Solver;
#endif
typedef int (*HYPRE_PtrToModifyPCFcn)(HYPRE_Solver,
int,
double);
#endif
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name Struct Jacobi Solver
**/
/*@{*/
/**
* Create a solver object.
**/
int HYPRE_StructJacobiCreate(MPI_Comm comm,
HYPRE_StructSolver *solver);
/**
* Destroy a solver object. An object should be explicitly destroyed
* using this destructor when the user's code no longer needs direct
* access to it. Once destroyed, the object must not be referenced
* again. Note that the object may not be deallocated at the
* completion of this call, since there may be internal package
* references to the object. The object will then be destroyed when
* all internal reference counts go to zero.
**/
int HYPRE_StructJacobiDestroy(HYPRE_StructSolver solver);
/**
* Prepare to solve the system. The coefficient data in {\tt b} and {\tt x} is
* ignored here, but information about the layout of the data may be used.
**/
int HYPRE_StructJacobiSetup(HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x);
/**
* Solve the system.
**/
int HYPRE_StructJacobiSolve(HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x);
/**
* (Optional) Set the convergence tolerance.
**/
int HYPRE_StructJacobiSetTol(HYPRE_StructSolver solver,
double tol);
/**
* (Optional) Set maximum number of iterations.
**/
int HYPRE_StructJacobiSetMaxIter(HYPRE_StructSolver solver,
int max_iter);
/**
* (Optional) Use a zero initial guess. This allows the solver to cut corners
* in the case where a zero initial guess is needed (e.g., for preconditioning)
* to reduce compuational cost.
**/
int HYPRE_StructJacobiSetZeroGuess(HYPRE_StructSolver solver);
/**
* (Optional) Use a nonzero initial guess. This is the default behavior, but
* this routine allows the user to switch back after using {\tt SetZeroGuess}.
**/
int HYPRE_StructJacobiSetNonZeroGuess(HYPRE_StructSolver solver);
/**
* Return the number of iterations taken.
**/
int HYPRE_StructJacobiGetNumIterations(HYPRE_StructSolver solver,
int *num_iterations);
/**
* Return the norm of the final relative residual.
**/
int HYPRE_StructJacobiGetFinalRelativeResidualNorm(HYPRE_StructSolver solver,
double *norm);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name Struct PFMG Solver
**/
/*@{*/
/**
* Create a solver object.
**/
int HYPRE_StructPFMGCreate(MPI_Comm comm,
HYPRE_StructSolver *solver);
/**
* Destroy a solver object.
**/
int HYPRE_StructPFMGDestroy(HYPRE_StructSolver solver);
/**
* Prepare to solve the system. The coefficient data in {\tt b} and {\tt x} is
* ignored here, but information about the layout of the data may be used.
**/
int HYPRE_StructPFMGSetup(HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x);
/**
* Solve the system.
**/
int HYPRE_StructPFMGSolve(HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x);
/**
* (Optional) Set the convergence tolerance.
**/
int HYPRE_StructPFMGSetTol(HYPRE_StructSolver solver,
double tol);
/**
* (Optional) Set maximum number of iterations.
**/
int HYPRE_StructPFMGSetMaxIter(HYPRE_StructSolver solver,
int max_iter);
/**
* (Optional) Set maximum number of multigrid grid levels.
**/
int HYPRE_StructPFMGSetMaxLevels(HYPRE_StructSolver solver,
int max_levels);
/**
* (Optional) Additionally require that the relative difference in
* successive iterates be small.
**/
int HYPRE_StructPFMGSetRelChange(HYPRE_StructSolver solver,
int rel_change);
/**
* (Optional) Use a zero initial guess. This allows the solver to cut corners
* in the case where a zero initial guess is needed (e.g., for preconditioning)
* to reduce compuational cost.
**/
int HYPRE_StructPFMGSetZeroGuess(HYPRE_StructSolver solver);
/**
* (Optional) Use a nonzero initial guess. This is the default behavior, but
* this routine allows the user to switch back after using {\tt SetZeroGuess}.
**/
int HYPRE_StructPFMGSetNonZeroGuess(HYPRE_StructSolver solver);
/**
* (Optional) Set relaxation type.
*
* Current relaxation methods set by {\tt relax\_type} are:
*
* \begin{tabular}{l@{ -- }l}
* 0 & Jacobi \\
* 1 & Weighted Jacobi (default) \\
* 2 & Red/Black Gauss-Seidel (symmetric: RB pre-relaxation, BR post-relaxation) \\
* 3 & Red/Black Gauss-Seidel (nonsymmetric: RB pre- and post-relaxation) \\
* \end{tabular}
**/
int HYPRE_StructPFMGSetRelaxType(HYPRE_StructSolver solver,
int relax_type);
/*
* (Optional) Set Jacobi weight (this is purposely not documented)
*/
int HYPRE_StructPFMGSetJacobiWeight(HYPRE_StructSolver solver,
double weight);
int HYPRE_StructPFMGGetJacobiWeight(HYPRE_StructSolver solver,
double *weight);
/**
* (Optional) Set type of coarse-grid operator to use.
*
* Current operators set by {\tt rap\_type} are:
*
* \begin{tabular}{l@{ -- }l}
* 0 & Galerkin (default) \\
* 1 & non-Galerkin 5-pt or 7-pt stencils \\
* \end{tabular}
*
* Both operators are constructed algebraically. The non-Galerkin option
* maintains a 5-pt stencil in 2D and a 7-pt stencil in 3D on all grid levels.
* The stencil coefficients are computed by averaging techniques.
**/
int HYPRE_StructPFMGSetRAPType(HYPRE_StructSolver solver,
int rap_type);
/**
* (Optional) Set number of relaxation sweeps before coarse-grid correction.
**/
int HYPRE_StructPFMGSetNumPreRelax(HYPRE_StructSolver solver,
int num_pre_relax);
/**
* (Optional) Set number of relaxation sweeps after coarse-grid correction.
**/
int HYPRE_StructPFMGSetNumPostRelax(HYPRE_StructSolver solver,
int num_post_relax);
/**
* (Optional) Skip relaxation on certain grids for isotropic problems. This can
* greatly improve efficiency by eliminating unnecessary relaxations when the
* underlying problem is isotropic.
**/
int HYPRE_StructPFMGSetSkipRelax(HYPRE_StructSolver solver,
int skip_relax);
/*
* RE-VISIT
**/
int HYPRE_StructPFMGSetDxyz(HYPRE_StructSolver solver,
double *dxyz);
/**
* (Optional) Set the amount of logging to do.
**/
int HYPRE_StructPFMGSetLogging(HYPRE_StructSolver solver,
int logging);
/**
* (Optional) Set the amount of printing to do to the screen.
**/
int HYPRE_StructPFMGSetPrintLevel(HYPRE_StructSolver solver,
int print_level);
/**
* Return the number of iterations taken.
**/
int HYPRE_StructPFMGGetNumIterations(HYPRE_StructSolver solver,
int *num_iterations);
/**
* Return the norm of the final relative residual.
**/
int HYPRE_StructPFMGGetFinalRelativeResidualNorm(HYPRE_StructSolver solver,
double *norm);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name Struct SMG Solver
**/
/*@{*/
/**
* Create a solver object.
**/
int HYPRE_StructSMGCreate(MPI_Comm comm,
HYPRE_StructSolver *solver);
/**
* Destroy a solver object.
**/
int HYPRE_StructSMGDestroy(HYPRE_StructSolver solver);
/**
* Prepare to solve the system. The coefficient data in {\tt b} and {\tt x} is
* ignored here, but information about the layout of the data may be used.
**/
int HYPRE_StructSMGSetup(HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x);
/**
* Solve the system.
**/
int HYPRE_StructSMGSolve(HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x);
/*
* RE-VISIT
**/
int HYPRE_StructSMGSetMemoryUse(HYPRE_StructSolver solver,
int memory_use);
/**
* (Optional) Set the convergence tolerance.
**/
int HYPRE_StructSMGSetTol(HYPRE_StructSolver solver,
double tol);
/**
* (Optional) Set maximum number of iterations.
**/
int HYPRE_StructSMGSetMaxIter(HYPRE_StructSolver solver,
int max_iter);
/**
* (Optional) Additionally require that the relative difference in
* successive iterates be small.
**/
int HYPRE_StructSMGSetRelChange(HYPRE_StructSolver solver,
int rel_change);
/**
* (Optional) Use a zero initial guess. This allows the solver to cut corners
* in the case where a zero initial guess is needed (e.g., for preconditioning)
* to reduce compuational cost.
**/
int HYPRE_StructSMGSetZeroGuess(HYPRE_StructSolver solver);
/**
* (Optional) Use a nonzero initial guess. This is the default behavior, but
* this routine allows the user to switch back after using {\tt SetZeroGuess}.
**/
int HYPRE_StructSMGSetNonZeroGuess(HYPRE_StructSolver solver);
/**
* (Optional) Set number of relaxation sweeps before coarse-grid correction.
**/
int HYPRE_StructSMGSetNumPreRelax(HYPRE_StructSolver solver,
int num_pre_relax);
/**
* (Optional) Set number of relaxation sweeps after coarse-grid correction.
**/
int HYPRE_StructSMGSetNumPostRelax(HYPRE_StructSolver solver,
int num_post_relax);
/**
* (Optional) Set the amount of logging to do.
**/
int HYPRE_StructSMGSetLogging(HYPRE_StructSolver solver,
int logging);
/**
* (Optional) Set the amount of printing to do to the screen.
**/
int HYPRE_StructSMGSetPrintLevel(HYPRE_StructSolver solver,
int print_level);
/**
* Return the number of iterations taken.
**/
int HYPRE_StructSMGGetNumIterations(HYPRE_StructSolver solver,
int *num_iterations);
/**
* Return the norm of the final relative residual.
**/
int HYPRE_StructSMGGetFinalRelativeResidualNorm(HYPRE_StructSolver solver,
double *norm);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name Struct PCG Solver
**/
/*@{*/
/**
* Create a solver object.
**/
int HYPRE_StructPCGCreate(MPI_Comm comm,
HYPRE_StructSolver *solver);
/**
* Destroy a solver object.
**/
int HYPRE_StructPCGDestroy(HYPRE_StructSolver solver);
/**
* Prepare to solve the system. The coefficient data in {\tt b} and {\tt x} is
* ignored here, but information about the layout of the data may be used.
**/
int HYPRE_StructPCGSetup(HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x);
/**
* Solve the system.
**/
int HYPRE_StructPCGSolve(HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x);
/**
* (Optional) Set the convergence tolerance.
**/
int HYPRE_StructPCGSetTol(HYPRE_StructSolver solver,
double tol);
/**
* (Optional) Set the absolute convergence tolerance (default is
* 0). If one desires the convergence test to check the absolute
* convergence tolerance {\it only}, then set the relative convergence
* tolerance to 0.0. (The default convergence test is $ <C*r,r> \leq$
* max(relative$\_$tolerance$^{2} \ast <C*b, b>$, absolute$\_$tolerance$^2$).)
**/
int HYPRE_StructPCGSetAbsoluteTol(HYPRE_StructSolver solver,
double tol);
/**
* (Optional) Set maximum number of iterations.
**/
int HYPRE_StructPCGSetMaxIter(HYPRE_StructSolver solver,
int max_iter);
/**
* (Optional) Use the two-norm in stopping criteria.
**/
int HYPRE_StructPCGSetTwoNorm(HYPRE_StructSolver solver,
int two_norm);
/**
* (Optional) Additionally require that the relative difference in
* successive iterates be small.
**/
int HYPRE_StructPCGSetRelChange(HYPRE_StructSolver solver,
int rel_change);
/**
* (Optional) Set the preconditioner to use.
**/
int HYPRE_StructPCGSetPrecond(HYPRE_StructSolver solver,
HYPRE_PtrToStructSolverFcn precond,
HYPRE_PtrToStructSolverFcn precond_setup,
HYPRE_StructSolver precond_solver);
/**
* (Optional) Set the amount of logging to do.
**/
int HYPRE_StructPCGSetLogging(HYPRE_StructSolver solver,
int logging);
/**
* (Optional) Set the amount of printing to do to the screen.
**/
int HYPRE_StructPCGSetPrintLevel(HYPRE_StructSolver solver,
int level);
/**
* Return the number of iterations taken.
**/
int HYPRE_StructPCGGetNumIterations(HYPRE_StructSolver solver,
int *num_iterations);
/**
* Return the norm of the final relative residual.
**/
int HYPRE_StructPCGGetFinalRelativeResidualNorm(HYPRE_StructSolver solver,
double *norm);
/**
* Return the residual.
**/
int HYPRE_StructPCGGetResidual(HYPRE_StructSolver solver,
void **residual);
/**
* Setup routine for diagonal preconditioning.
**/
int HYPRE_StructDiagScaleSetup(HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector y,
HYPRE_StructVector x);
/**
* Solve routine for diagonal preconditioning.
**/
int HYPRE_StructDiagScale(HYPRE_StructSolver solver,
HYPRE_StructMatrix HA,
HYPRE_StructVector Hy,
HYPRE_StructVector Hx);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name Struct GMRES Solver
**/
/*@{*/
/**
* Create a solver object.
**/
int
HYPRE_StructGMRESCreate( MPI_Comm comm, HYPRE_StructSolver *solver );
/**
* Destroy a solver object.
**/
int
HYPRE_StructGMRESDestroy( HYPRE_StructSolver solver );
/**
* Prepare to solve the system. The coefficient data in {\tt b} and {\tt x} is
* ignored here, but information about the layout of the data may be used.
**/
int
HYPRE_StructGMRESSetup( HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x );
/**
* Solve the system.
**/
int
HYPRE_StructGMRESSolve( HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x );
/**
* (Optional) Set the relative convergence tolerance.
**/
int
HYPRE_StructGMRESSetTol( HYPRE_StructSolver solver,
double tol );
/**
* (Optional) Set the absolute convergence tolerance (default: 0).
* If one desires
* the convergence test to check the absolute convergence tolerance {\it only}, then
* set the relative convergence tolerance to 0.0. (The convergence test is
* $\|r\| \leq$ max(relative$\_$tolerance$\ast \|b\|$, absolute$\_$tolerance).)
**/
int
HYPRE_StructGMRESSetAbsoluteTol( HYPRE_StructSolver solver,
double tol );
/**
* (Optional) Set maximum number of iterations.
**/
int
HYPRE_StructGMRESSetMaxIter( HYPRE_StructSolver solver,
int max_iter );
/**
* (Optional) Set the dimension of the Krylov subspace
**/
int
HYPRE_StructGMRESSetKDim( HYPRE_StructSolver solver,
int k_dim );
/**
* (Optional) Set the preconditioner to use.
**/
int
HYPRE_StructGMRESSetPrecond( HYPRE_StructSolver solver,
HYPRE_PtrToStructSolverFcn precond,
HYPRE_PtrToStructSolverFcn precond_setup,
HYPRE_StructSolver precond_solver );
/**
* (Optional) Set the amount of logging to do.
**/
int
HYPRE_StructGMRESSetLogging( HYPRE_StructSolver solver,
int logging );
/**
* (Optional) Set the amount of printing to do to the screen.
**/
int
HYPRE_StructGMRESSetPrintLevel( HYPRE_StructSolver solver,
int level );
/**
* Return the number of iterations taken.
**/
int
HYPRE_StructGMRESGetNumIterations( HYPRE_StructSolver solver,
int *num_iterations );
/**
* Return the norm of the final relative residual.
**/
int
HYPRE_StructGMRESGetFinalRelativeResidualNorm( HYPRE_StructSolver solver,
double *norm );
/**
* Return the residual.
**/
int
HYPRE_StructGMRESGetResidual( HYPRE_StructSolver solver,
void **residual);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name Struct FlexGMRES Solver
**/
/*@{*/
/**
* Create a solver object.
**/
int
HYPRE_StructFlexGMRESCreate( MPI_Comm comm, HYPRE_StructSolver *solver );
/**
* Destroy a solver object.
**/
int
HYPRE_StructFlexGMRESDestroy( HYPRE_StructSolver solver );
/**
* Prepare to solve the system. The coefficient data in {\tt b} and {\tt x} is
* ignored here, but information about the layout of the data may be used.
**/
int
HYPRE_StructFlexGMRESSetup( HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x );
/**
* Solve the system.
**/
int
HYPRE_StructFlexGMRESSolve( HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x );
/**
* (Optional) Set the convergence tolerance.
**/
int
HYPRE_StructFlexGMRESSetTol( HYPRE_StructSolver solver,
double tol );
/**
* (Optional) Set the absolute convergence tolerance (default: 0).
* If one desires
* the convergence test to check the absolute convergence tolerance {\it only}, then
* set the relative convergence tolerance to 0.0. (The convergence test is
* $\|r\| \leq$ max(relative$\_$tolerance$\ast \|b\|$, absolute$\_$tolerance).)
**/
int
HYPRE_StructFlexGMRESSetAbsoluteTol( HYPRE_StructSolver solver,
double tol );
/**
* (Optional) Set maximum number of iterations.
**/
int
HYPRE_StructFlexGMRESSetMaxIter( HYPRE_StructSolver solver,
int max_iter );
/**
* (Optional) Set the dimension of the Krylov subspace
**/
int
HYPRE_StructFlexGMRESSetKDim( HYPRE_StructSolver solver,
int k_dim );
/**
* (Optional) Set the preconditioner to use.
**/
int
HYPRE_StructFlexGMRESSetPrecond( HYPRE_StructSolver solver,
HYPRE_PtrToStructSolverFcn precond,
HYPRE_PtrToStructSolverFcn precond_setup,
HYPRE_StructSolver precond_solver );
/**
* (Optional) Set the amount of logging to do.
**/
int
HYPRE_StructFlexGMRESSetLogging( HYPRE_StructSolver solver,
int logging );
/**
* (Optional) Set the amount of printing to do to the screen.
**/
int
HYPRE_StructFlexGMRESSetPrintLevel( HYPRE_StructSolver solver,
int level );
/**
* Return the number of iterations taken.
**/
int
HYPRE_StructFlexGMRESGetNumIterations( HYPRE_StructSolver solver,
int *num_iterations );
/**
* Return the norm of the final relative residual.
**/
int
HYPRE_StructFlexGMRESGetFinalRelativeResidualNorm( HYPRE_StructSolver solver,
double *norm );
/**
* Return the residual.
**/
int
HYPRE_StructFlexGMRESGetResidual( HYPRE_StructSolver solver,
void **residual);
/**
* Set a user-defined function to modify solve-time preconditioner attributes.
**/
int HYPRE_StructFlexGMRESSetModifyPC( HYPRE_StructSolver solver,
HYPRE_PtrToModifyPCFcn modify_pc);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name Struct LGMRES Solver
**/
/*@{*/
/**
* Create a solver object.
**/
int
HYPRE_StructLGMRESCreate( MPI_Comm comm, HYPRE_StructSolver *solver );
/**
* Destroy a solver object.
**/
int
HYPRE_StructLGMRESDestroy( HYPRE_StructSolver solver );
/**
* Prepare to solve the system. The coefficient data in {\tt b} and {\tt x} is
* ignored here, but information about the layout of the data may be used.
**/
int
HYPRE_StructLGMRESSetup( HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x );
/**
* Solve the system. Details on LGMRES may be found in A. H. Baker,
* E.R. Jessup, and T.A. Manteuffel. A technique for accelerating the
* convergence of restarted GMRES. SIAM Journal on Matrix Analysis and
* Applications, 26 (2005), pp. 962-984. LGMRES(m,k) in the paper
* corresponds to LGMRES(Kdim+AugDim, AugDim).
**/
int
HYPRE_StructLGMRESSolve( HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x );
/**
* (Optional) Set the convergence tolerance.
**/
int
HYPRE_StructLGMRESSetTol( HYPRE_StructSolver solver,
double tol );
/**
* (Optional) Set the absolute convergence tolerance (default: 0) .
* If one desires
* the convergence test to check the absolute convergence tolerance {\it only}, then
* set the relative convergence tolerance to 0.0. (The convergence test is
* $\|r\| \leq$ max(relative$\_$tolerance$\ast \|b\|$, absolute$\_$tolerance).)
**/
int
HYPRE_StructLGMRESSetAbsoluteTol( HYPRE_StructSolver solver,
double tol );
/**
* (Optional) Set maximum number of iterations.
**/
int
HYPRE_StructLGMRESSetMaxIter( HYPRE_StructSolver solver,
int max_iter );
/**
* (Optional) Set the dimension of the approximation subspace.
**/
int
HYPRE_StructLGMRESSetKDim( HYPRE_StructSolver solver,
int k_dim );
/**
* (Optional) Set the number of augmentation vectors (default: 2).
**/
int
HYPRE_StructLGMRESSetAugDim( HYPRE_StructSolver solver,
int aug_dim );
/**
* (Optional) Set the preconditioner to use.
**/
int
HYPRE_StructLGMRESSetPrecond( HYPRE_StructSolver solver,
HYPRE_PtrToStructSolverFcn precond,
HYPRE_PtrToStructSolverFcn precond_setup,
HYPRE_StructSolver precond_solver );
/**
* (Optional) Set the amount of logging to do.
**/
int
HYPRE_StructLGMRESSetLogging( HYPRE_StructSolver solver,
int logging );
/**
* (Optional) Set the amount of printing to do to the screen.
**/
int
HYPRE_StructLGMRESSetPrintLevel( HYPRE_StructSolver solver,
int level );
/**
* Return the number of iterations taken.
**/
int
HYPRE_StructLGMRESGetNumIterations( HYPRE_StructSolver solver,
int *num_iterations );
/**
* Return the norm of the final relative residual.
**/
int
HYPRE_StructLGMRESGetFinalRelativeResidualNorm( HYPRE_StructSolver solver,
double *norm );
/**
* Return the residual.
**/
int
HYPRE_StructLGMRESGetResidual( HYPRE_StructSolver solver,
void **residual);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name Struct BiCGSTAB Solver
**/
/*@{*/
/**
* Create a solver object.
**/
int
HYPRE_StructBiCGSTABCreate( MPI_Comm comm, HYPRE_StructSolver *solver );
/**
* Destroy a solver object.
**/
int
HYPRE_StructBiCGSTABDestroy( HYPRE_StructSolver solver );
/**
* Prepare to solve the system. The coefficient data in {\tt b} and {\tt x} is
* ignored here, but information about the layout of the data may be used.
**/
int
HYPRE_StructBiCGSTABSetup( HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x );
/**
* Solve the system.
**/
int
HYPRE_StructBiCGSTABSolve( HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x );
/**
* (Optional) Set the convergence tolerance.
**/
int
HYPRE_StructBiCGSTABSetTol( HYPRE_StructSolver solver,
double tol );
/**
* (Optional) Set the absolute convergence tolerance (default is 0).
* If one desires
* the convergence test to check the absolute convergence tolerance {\it only}, then
* set the relative convergence tolerance to 0.0. (The convergence test is
* $\|r\| \leq$ max(relative$\_$tolerance $\ast \|b\|$, absolute$\_$tolerance).)
*
**/
int
HYPRE_StructBiCGSTABSetAbsoluteTol( HYPRE_StructSolver solver,
double tol );
/**
* (Optional) Set maximum number of iterations.
**/
int
HYPRE_StructBiCGSTABSetMaxIter( HYPRE_StructSolver solver,
int max_iter );
/**
* (Optional) Set the preconditioner to use.
**/
int
HYPRE_StructBiCGSTABSetPrecond( HYPRE_StructSolver solver,
HYPRE_PtrToStructSolverFcn precond,
HYPRE_PtrToStructSolverFcn precond_setup,
HYPRE_StructSolver precond_solver );
/**
* (Optional) Set the amount of logging to do.
**/
int
HYPRE_StructBiCGSTABSetLogging( HYPRE_StructSolver solver,
int logging );
/**
* (Optional) Set the amount of printing to do to the screen.
**/
int
HYPRE_StructBiCGSTABSetPrintLevel( HYPRE_StructSolver solver,
int level );
/**
* Return the number of iterations taken.
**/
int
HYPRE_StructBiCGSTABGetNumIterations( HYPRE_StructSolver solver,
int *num_iterations );
/**
* Return the norm of the final relative residual.
**/
int
HYPRE_StructBiCGSTABGetFinalRelativeResidualNorm( HYPRE_StructSolver solver,
double *norm );
/**
* Return the residual.
**/
int
HYPRE_StructBiCGSTABGetResidual( HYPRE_StructSolver solver,
void **residual);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name Struct Hybrid Solver
**/
/*@{*/
/**
* Create a solver object.
**/
int HYPRE_StructHybridCreate(MPI_Comm comm,
HYPRE_StructSolver *solver);
/**
* Destroy a solver object.
**/
int HYPRE_StructHybridDestroy(HYPRE_StructSolver solver);
/**
* Prepare to solve the system. The coefficient data in {\tt b} and {\tt x} is
* ignored here, but information about the layout of the data may be used.
**/
int HYPRE_StructHybridSetup(HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x);
/**
* Solve the system.
**/
int HYPRE_StructHybridSolve(HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x);
/**
* (Optional) Set the convergence tolerance.
**/
int HYPRE_StructHybridSetTol(HYPRE_StructSolver solver,
double tol);
/**
* (Optional) Set an accepted convergence tolerance for diagonal scaling (DS).
* The solver will switch preconditioners if the convergence of DS is slower
* than {\tt cf\_tol}.
**/
int HYPRE_StructHybridSetConvergenceTol(HYPRE_StructSolver solver,
double cf_tol);
/**
* (Optional) Set maximum number of iterations for diagonal scaling (DS). The
* solver will switch preconditioners if DS reaches {\tt ds\_max\_its}.
**/
int HYPRE_StructHybridSetDSCGMaxIter(HYPRE_StructSolver solver,
int ds_max_its);
/**
* (Optional) Set maximum number of iterations for general preconditioner (PRE).
* The solver will stop if PRE reaches {\tt pre\_max\_its}.
**/
int HYPRE_StructHybridSetPCGMaxIter(HYPRE_StructSolver solver,
int pre_max_its);
/**
* (Optional) Use the two-norm in stopping criteria.
**/
int HYPRE_StructHybridSetTwoNorm(HYPRE_StructSolver solver,
int two_norm);
int HYPRE_StructHybridSetStopCrit(HYPRE_StructSolver solver,
int stop_crit);
/**
* (Optional) Additionally require that the relative difference in
* successive iterates be small.
**/
int HYPRE_StructHybridSetRelChange(HYPRE_StructSolver solver,
int rel_change);
/**
* (Optional) Set the type of Krylov solver to use.
*
* Current krylov methods set by {\tt solver\_type} are:
*
* \begin{tabular}{l@{ -- }l}
* 0 & PCG (default) \\
* 1 & GMRES \\
* 2 & BiCGSTAB \\
* \end{tabular}
**/
int HYPRE_StructHybridSetSolverType(HYPRE_StructSolver solver,
int solver_type);
/**
* (Optional) Set the maximum size of the Krylov space when using GMRES.
**/
int HYPRE_StructHybridSetKDim(HYPRE_StructSolver solver,
int k_dim);
/**
* (Optional) Set the preconditioner to use.
**/
int HYPRE_StructHybridSetPrecond(HYPRE_StructSolver solver,
HYPRE_PtrToStructSolverFcn precond,
HYPRE_PtrToStructSolverFcn precond_setup,
HYPRE_StructSolver precond_solver);
/**
* (Optional) Set the amount of logging to do.
**/
int HYPRE_StructHybridSetLogging(HYPRE_StructSolver solver,
int logging);
/**
* (Optional) Set the amount of printing to do to the screen.
**/
int HYPRE_StructHybridSetPrintLevel(HYPRE_StructSolver solver,
int print_level);
/**
* Return the number of iterations taken.
**/
int HYPRE_StructHybridGetNumIterations(HYPRE_StructSolver solver,
int *num_its);
/**
* Return the number of diagonal scaling iterations taken.
**/
int HYPRE_StructHybridGetDSCGNumIterations(HYPRE_StructSolver solver,
int *ds_num_its);
/**
* Return the number of general preconditioning iterations taken.
**/
int HYPRE_StructHybridGetPCGNumIterations(HYPRE_StructSolver solver,
int *pre_num_its);
/**
* Return the norm of the final relative residual.
**/
int HYPRE_StructHybridGetFinalRelativeResidualNorm(HYPRE_StructSolver solver,
double *norm);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/*
* @name Struct SparseMSG Solver
**/
int HYPRE_StructSparseMSGCreate(MPI_Comm comm,
HYPRE_StructSolver *solver);
int HYPRE_StructSparseMSGDestroy(HYPRE_StructSolver solver);
int HYPRE_StructSparseMSGSetup(HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x);
int HYPRE_StructSparseMSGSolve(HYPRE_StructSolver solver,
HYPRE_StructMatrix A,
HYPRE_StructVector b,
HYPRE_StructVector x);
int HYPRE_StructSparseMSGSetTol(HYPRE_StructSolver solver,
double tol);
int HYPRE_StructSparseMSGSetMaxIter(HYPRE_StructSolver solver,
int max_iter);
int HYPRE_StructSparseMSGSetJump(HYPRE_StructSolver solver,
int jump);
int HYPRE_StructSparseMSGSetRelChange(HYPRE_StructSolver solver,
int rel_change);
int HYPRE_StructSparseMSGSetZeroGuess(HYPRE_StructSolver solver);
int HYPRE_StructSparseMSGSetNonZeroGuess(HYPRE_StructSolver solver);
int HYPRE_StructSparseMSGSetRelaxType(HYPRE_StructSolver solver,
int relax_type);
int HYPRE_StructSparseMSGSetJacobiWeight(HYPRE_StructSolver solver,
double weight);
int HYPRE_StructSparseMSGSetNumPreRelax(HYPRE_StructSolver solver,
int num_pre_relax);
int HYPRE_StructSparseMSGSetNumPostRelax(HYPRE_StructSolver solver,
int num_post_relax);
int HYPRE_StructSparseMSGSetNumFineRelax(HYPRE_StructSolver solver,
int num_fine_relax);
int HYPRE_StructSparseMSGSetLogging(HYPRE_StructSolver solver,
int logging);
int HYPRE_StructSparseMSGSetPrintLevel(HYPRE_StructSolver solver,
int print_level);
int HYPRE_StructSparseMSGGetNumIterations(HYPRE_StructSolver solver,
int *num_iterations);
int HYPRE_StructSparseMSGGetFinalRelativeResidualNorm(HYPRE_StructSolver solver,
double *norm);
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/*@}*/
#ifdef __cplusplus
}
#endif
#endif
|