/usr/include/HYPRE_sstruct_ls.h is in libhypre-dev 2.8.0b-3.
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 1292 | /*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.26 $
***********************************************************************EHEADER*/
#ifndef HYPRE_SSTRUCT_LS_HEADER
#define HYPRE_SSTRUCT_LS_HEADER
#include "HYPRE_config.h"
#include "HYPRE_utilities.h"
#include "HYPRE.h"
#include "HYPRE_sstruct_mv.h"
#include "HYPRE_struct_ls.h"
#include "HYPRE_parcsr_ls.h"
#ifdef __cplusplus
extern "C" {
#endif
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name SStruct Solvers
*
* These solvers use matrix/vector storage schemes that are taylored
* to semi-structured grid problems.
*
* @memo Linear solvers for semi-structured grids
**/
/*@{*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name SStruct Solvers
**/
/*@{*/
struct hypre_SStructSolver_struct;
/**
* The solver object.
**/
typedef struct hypre_SStructSolver_struct *HYPRE_SStructSolver;
typedef HYPRE_Int (*HYPRE_PtrToSStructSolverFcn)(HYPRE_SStructSolver,
HYPRE_SStructMatrix,
HYPRE_SStructVector,
HYPRE_SStructVector);
#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 HYPRE_Int (*HYPRE_PtrToModifyPCFcn)(HYPRE_Solver,
HYPRE_Int,
double);
#endif
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name SStruct SysPFMG Solver
*
* SysPFMG is a semicoarsening multigrid solver similar to PFMG, but for systems
* of PDEs. For periodic problems, users should try to set the grid size in
* periodic dimensions to be as close to a power-of-two as possible (for more
* details, see \Ref{Struct PFMG Solver}).
**/
/*@{*/
/**
* Create a solver object.
**/
HYPRE_Int
HYPRE_SStructSysPFMGCreate(MPI_Comm comm,
HYPRE_SStructSolver *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.
**/
HYPRE_Int
HYPRE_SStructSysPFMGDestroy(HYPRE_SStructSolver 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.
**/
HYPRE_Int
HYPRE_SStructSysPFMGSetup(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
/**
* Solve the system.
**/
HYPRE_Int
HYPRE_SStructSysPFMGSolve(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
/**
* (Optional) Set the convergence tolerance.
**/
HYPRE_Int
HYPRE_SStructSysPFMGSetTol(HYPRE_SStructSolver solver,
double tol);
/**
* (Optional) Set maximum number of iterations.
**/
HYPRE_Int
HYPRE_SStructSysPFMGSetMaxIter(HYPRE_SStructSolver solver,
HYPRE_Int max_iter);
/**
* (Optional) Additionally require that the relative difference in
* successive iterates be small.
**/
HYPRE_Int
HYPRE_SStructSysPFMGSetRelChange(HYPRE_SStructSolver solver,
HYPRE_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.
**/
HYPRE_Int
HYPRE_SStructSysPFMGSetZeroGuess(HYPRE_SStructSolver 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}.
**/
HYPRE_Int
HYPRE_SStructSysPFMGSetNonZeroGuess(HYPRE_SStructSolver 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) \\
* \end{tabular}
**/
HYPRE_Int
HYPRE_SStructSysPFMGSetRelaxType(HYPRE_SStructSolver solver,
HYPRE_Int relax_type);
/**
* (Optional) Set Jacobi Weight.
**/
HYPRE_Int
HYPRE_SStructSysPFMGSetJacobiWeight(HYPRE_SStructSolver solver,
double weight);
/**
* (Optional) Set number of relaxation sweeps before coarse-grid correction.
**/
HYPRE_Int
HYPRE_SStructSysPFMGSetNumPreRelax(HYPRE_SStructSolver solver,
HYPRE_Int num_pre_relax);
/**
* (Optional) Set number of relaxation sweeps after coarse-grid correction.
**/
HYPRE_Int
HYPRE_SStructSysPFMGSetNumPostRelax(HYPRE_SStructSolver solver,
HYPRE_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.
**/
HYPRE_Int
HYPRE_SStructSysPFMGSetSkipRelax(HYPRE_SStructSolver solver,
HYPRE_Int skip_relax);
/*
* RE-VISIT
**/
HYPRE_Int
HYPRE_SStructSysPFMGSetDxyz(HYPRE_SStructSolver solver,
double *dxyz);
/**
* (Optional) Set the amount of logging to do.
**/
HYPRE_Int
HYPRE_SStructSysPFMGSetLogging(HYPRE_SStructSolver solver,
HYPRE_Int logging);
/**
* (Optional) Set the amount of printing to do to the screen.
**/
HYPRE_Int
HYPRE_SStructSysPFMGSetPrintLevel(HYPRE_SStructSolver solver,
HYPRE_Int print_level);
/**
* Return the number of iterations taken.
**/
HYPRE_Int
HYPRE_SStructSysPFMGGetNumIterations(HYPRE_SStructSolver solver,
HYPRE_Int *num_iterations);
/**
* Return the norm of the final relative residual.
**/
HYPRE_Int
HYPRE_SStructSysPFMGGetFinalRelativeResidualNorm(HYPRE_SStructSolver solver,
double *norm);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name SStruct Split Solver
**/
/*@{*/
#define HYPRE_PFMG 10
#define HYPRE_SMG 11
#define HYPRE_Jacobi 17
/**
* Create a solver object.
**/
HYPRE_Int
HYPRE_SStructSplitCreate(MPI_Comm comm,
HYPRE_SStructSolver *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.
**/
HYPRE_Int
HYPRE_SStructSplitDestroy(HYPRE_SStructSolver 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.
**/
HYPRE_Int
HYPRE_SStructSplitSetup(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
/**
* Solve the system.
**/
HYPRE_Int
HYPRE_SStructSplitSolve(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
/**
* (Optional) Set the convergence tolerance.
**/
HYPRE_Int
HYPRE_SStructSplitSetTol(HYPRE_SStructSolver solver,
double tol);
/**
* (Optional) Set maximum number of iterations.
**/
HYPRE_Int
HYPRE_SStructSplitSetMaxIter(HYPRE_SStructSolver solver,
HYPRE_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.
**/
HYPRE_Int
HYPRE_SStructSplitSetZeroGuess(HYPRE_SStructSolver 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}.
**/
HYPRE_Int
HYPRE_SStructSplitSetNonZeroGuess(HYPRE_SStructSolver solver);
/**
* (Optional) Set up the type of diagonal struct solver. Either {\tt ssolver} is
* set to {\tt HYPRE\_SMG} or {\tt HYPRE\_PFMG}.
**/
HYPRE_Int
HYPRE_SStructSplitSetStructSolver(HYPRE_SStructSolver solver,
HYPRE_Int ssolver );
/**
* Return the number of iterations taken.
**/
HYPRE_Int
HYPRE_SStructSplitGetNumIterations(HYPRE_SStructSolver solver,
HYPRE_Int *num_iterations);
/**
* Return the norm of the final relative residual.
**/
HYPRE_Int
HYPRE_SStructSplitGetFinalRelativeResidualNorm(HYPRE_SStructSolver solver,
double *norm);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name SStruct FAC Solver
**/
/*@{*/
/**
* Create a solver object.
**/
HYPRE_Int
HYPRE_SStructFACCreate(MPI_Comm comm,
HYPRE_SStructSolver *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.
**/
HYPRE_Int
HYPRE_SStructFACDestroy2(HYPRE_SStructSolver solver);
/**
* Re-distribute the composite matrix so that the amr hierachy is approximately
* nested. Coarse underlying operators are also formed.
**/
HYPRE_Int
HYPRE_SStructFACAMR_RAP(HYPRE_SStructMatrix A,
HYPRE_Int (*rfactors)[3],
HYPRE_SStructMatrix *fac_A);
/**
* Set up the FAC solver structure .
**/
HYPRE_Int
HYPRE_SStructFACSetup2(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
/**
* Solve the system.
**/
HYPRE_Int
HYPRE_SStructFACSolve3(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
/**
* Set up amr structure
**/
HYPRE_Int
HYPRE_SStructFACSetPLevels(HYPRE_SStructSolver solver,
HYPRE_Int nparts,
HYPRE_Int *plevels);
/**
* Set up amr refinement factors
**/
HYPRE_Int
HYPRE_SStructFACSetPRefinements(HYPRE_SStructSolver solver,
HYPRE_Int nparts,
HYPRE_Int (*rfactors)[3] );
/**
* (Optional, but user must make sure that they do this function otherwise.)
* Zero off the coarse level stencils reaching into a fine level grid.
**/
HYPRE_Int
HYPRE_SStructFACZeroCFSten(HYPRE_SStructMatrix A,
HYPRE_SStructGrid grid,
HYPRE_Int part,
HYPRE_Int rfactors[3]);
/**
* (Optional, but user must make sure that they do this function otherwise.)
* Zero off the fine level stencils reaching into a coarse level grid.
**/
HYPRE_Int
HYPRE_SStructFACZeroFCSten(HYPRE_SStructMatrix A,
HYPRE_SStructGrid grid,
HYPRE_Int part);
/**
* (Optional, but user must make sure that they do this function otherwise.)
* Places the identity in the coarse grid matrix underlying the fine patches.
* Required between each pair of amr levels.
**/
HYPRE_Int
HYPRE_SStructFACZeroAMRMatrixData(HYPRE_SStructMatrix A,
HYPRE_Int part_crse,
HYPRE_Int rfactors[3]);
/**
* (Optional, but user must make sure that they do this function otherwise.)
* Places zeros in the coarse grid vector underlying the fine patches.
* Required between each pair of amr levels.
**/
HYPRE_Int
HYPRE_SStructFACZeroAMRVectorData(HYPRE_SStructVector b,
HYPRE_Int *plevels,
HYPRE_Int (*rfactors)[3] );
/**
* (Optional) Set maximum number of FAC levels.
**/
HYPRE_Int
HYPRE_SStructFACSetMaxLevels( HYPRE_SStructSolver solver ,
HYPRE_Int max_levels );
/**
* (Optional) Set the convergence tolerance.
**/
HYPRE_Int
HYPRE_SStructFACSetTol(HYPRE_SStructSolver solver,
double tol);
/**
* (Optional) Set maximum number of iterations.
**/
HYPRE_Int
HYPRE_SStructFACSetMaxIter(HYPRE_SStructSolver solver,
HYPRE_Int max_iter);
/**
* (Optional) Additionally require that the relative difference in
* successive iterates be small.
**/
HYPRE_Int
HYPRE_SStructFACSetRelChange(HYPRE_SStructSolver solver,
HYPRE_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.
**/
HYPRE_Int
HYPRE_SStructFACSetZeroGuess(HYPRE_SStructSolver 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}.
**/
HYPRE_Int
HYPRE_SStructFACSetNonZeroGuess(HYPRE_SStructSolver solver);
/**
* (Optional) Set relaxation type. See \Ref{HYPRE_SStructSysPFMGSetRelaxType}
* for appropriate values of {\tt relax\_type}.
**/
HYPRE_Int
HYPRE_SStructFACSetRelaxType(HYPRE_SStructSolver solver,
HYPRE_Int relax_type);
/**
* (Optional) Set Jacobi weight if weighted Jacobi is used.
**/
HYPRE_Int
HYPRE_SStructFACSetJacobiWeight(HYPRE_SStructSolver solver,
double weight);
/**
* (Optional) Set number of relaxation sweeps before coarse-grid correction.
**/
HYPRE_Int
HYPRE_SStructFACSetNumPreRelax(HYPRE_SStructSolver solver,
HYPRE_Int num_pre_relax);
/**
* (Optional) Set number of relaxation sweeps after coarse-grid correction.
**/
HYPRE_Int
HYPRE_SStructFACSetNumPostRelax(HYPRE_SStructSolver solver,
HYPRE_Int num_post_relax);
/**
* (Optional) Set coarsest solver type.
*
* Current solver types set by {\tt csolver\_type} are:
*
* \begin{tabular}{l@{ -- }l}
* 1 & SysPFMG-PCG (default) \\
* 2 & SysPFMG \\
* \end{tabular}
**/
HYPRE_Int
HYPRE_SStructFACSetCoarseSolverType(HYPRE_SStructSolver solver,
HYPRE_Int csolver_type);
/**
* (Optional) Set the amount of logging to do.
**/
HYPRE_Int
HYPRE_SStructFACSetLogging(HYPRE_SStructSolver solver,
HYPRE_Int logging);
/**
* Return the number of iterations taken.
**/
HYPRE_Int
HYPRE_SStructFACGetNumIterations(HYPRE_SStructSolver solver,
HYPRE_Int *num_iterations);
/**
* Return the norm of the final relative residual.
**/
HYPRE_Int
HYPRE_SStructFACGetFinalRelativeResidualNorm(HYPRE_SStructSolver solver,
double *norm);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name SStruct Maxwell Solver
**/
/*@{*/
/**
* Create a solver object.
**/
HYPRE_Int
HYPRE_SStructMaxwellCreate( MPI_Comm comm,
HYPRE_SStructSolver *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.
**/
HYPRE_Int
HYPRE_SStructMaxwellDestroy( HYPRE_SStructSolver 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.
**/
HYPRE_Int
HYPRE_SStructMaxwellSetup(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
/**
* Solve the system. Full coupling of the augmented system used
* throughout the multigrid hierarchy.
**/
HYPRE_Int
HYPRE_SStructMaxwellSolve(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
/**
* Solve the system. Full coupling of the augmented system used
* only on the finest level, i.e., the node and edge multigrid
* cycles are coupled only on the finest level.
**/
HYPRE_Int
HYPRE_SStructMaxwellSolve2(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
/**
* Sets the gradient operator in the Maxwell solver.
**/
HYPRE_Int
HYPRE_SStructMaxwellSetGrad(HYPRE_SStructSolver solver,
HYPRE_ParCSRMatrix T);
/**
* Sets the coarsening factor.
**/
HYPRE_Int
HYPRE_SStructMaxwellSetRfactors(HYPRE_SStructSolver solver,
HYPRE_Int rfactors[3]);
/**
* Finds the physical boundary row ranks on all levels.
**/
HYPRE_Int
HYPRE_SStructMaxwellPhysBdy(HYPRE_SStructGrid *grid_l,
HYPRE_Int num_levels,
HYPRE_Int rfactors[3],
HYPRE_Int ***BdryRanks_ptr,
HYPRE_Int **BdryRanksCnt_ptr );
/**
* Eliminates the rows and cols corresponding to the physical boundary in
* a parcsr matrix.
**/
HYPRE_Int
HYPRE_SStructMaxwellEliminateRowsCols(HYPRE_ParCSRMatrix parA,
HYPRE_Int nrows,
HYPRE_Int *rows );
/**
* Zeros the rows corresponding to the physical boundary in
* a par vector.
**/
HYPRE_Int
HYPRE_SStructMaxwellZeroVector(HYPRE_ParVector b,
HYPRE_Int *rows,
HYPRE_Int nrows );
/**
* (Optional) Set the constant coefficient flag- Nedelec interpolation
* used.
**/
HYPRE_Int
HYPRE_SStructMaxwellSetSetConstantCoef(HYPRE_SStructSolver solver,
HYPRE_Int flag);
/**
* (Optional) Creates a gradient matrix from the grid. This presupposes
* a particular orientation of the edge elements.
**/
HYPRE_Int
HYPRE_SStructMaxwellGrad(HYPRE_SStructGrid grid,
HYPRE_ParCSRMatrix *T);
/**
* (Optional) Set the convergence tolerance.
**/
HYPRE_Int
HYPRE_SStructMaxwellSetTol(HYPRE_SStructSolver solver,
double tol);
/**
* (Optional) Set maximum number of iterations.
**/
HYPRE_Int
HYPRE_SStructMaxwellSetMaxIter(HYPRE_SStructSolver solver,
HYPRE_Int max_iter);
/**
* (Optional) Additionally require that the relative difference in
* successive iterates be small.
**/
HYPRE_Int
HYPRE_SStructMaxwellSetRelChange(HYPRE_SStructSolver solver,
HYPRE_Int rel_change);
/**
* (Optional) Set number of relaxation sweeps before coarse-grid correction.
**/
HYPRE_Int
HYPRE_SStructMaxwellSetNumPreRelax(HYPRE_SStructSolver solver,
HYPRE_Int num_pre_relax);
/**
* (Optional) Set number of relaxation sweeps after coarse-grid correction.
**/
HYPRE_Int
HYPRE_SStructMaxwellSetNumPostRelax(HYPRE_SStructSolver solver,
HYPRE_Int num_post_relax);
/**
* (Optional) Set the amount of logging to do.
**/
HYPRE_Int
HYPRE_SStructMaxwellSetLogging(HYPRE_SStructSolver solver,
HYPRE_Int logging);
/**
* Return the number of iterations taken.
**/
HYPRE_Int
HYPRE_SStructMaxwellGetNumIterations(HYPRE_SStructSolver solver,
HYPRE_Int *num_iterations);
/**
* Return the norm of the final relative residual.
**/
HYPRE_Int
HYPRE_SStructMaxwellGetFinalRelativeResidualNorm(HYPRE_SStructSolver solver,
double *norm);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name SStruct PCG Solver
*
* These routines should be used in conjunction with the generic interface in
* \Ref{PCG Solver}.
**/
/*@{*/
/**
* Create a solver object.
**/
HYPRE_Int
HYPRE_SStructPCGCreate(MPI_Comm comm,
HYPRE_SStructSolver *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.
**/
HYPRE_Int
HYPRE_SStructPCGDestroy(HYPRE_SStructSolver solver);
HYPRE_Int
HYPRE_SStructPCGSetup(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
HYPRE_Int
HYPRE_SStructPCGSolve(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
HYPRE_Int
HYPRE_SStructPCGSetTol(HYPRE_SStructSolver solver,
double tol);
HYPRE_Int
HYPRE_SStructPCGSetAbsoluteTol(HYPRE_SStructSolver solver,
double tol);
HYPRE_Int
HYPRE_SStructPCGSetMaxIter(HYPRE_SStructSolver solver,
HYPRE_Int max_iter);
HYPRE_Int
HYPRE_SStructPCGSetTwoNorm(HYPRE_SStructSolver solver,
HYPRE_Int two_norm);
HYPRE_Int
HYPRE_SStructPCGSetRelChange(HYPRE_SStructSolver solver,
HYPRE_Int rel_change);
HYPRE_Int
HYPRE_SStructPCGSetPrecond(HYPRE_SStructSolver solver,
HYPRE_PtrToSStructSolverFcn precond,
HYPRE_PtrToSStructSolverFcn precond_setup,
void *precond_solver);
HYPRE_Int
HYPRE_SStructPCGSetLogging(HYPRE_SStructSolver solver,
HYPRE_Int logging);
HYPRE_Int
HYPRE_SStructPCGSetPrintLevel(HYPRE_SStructSolver solver,
HYPRE_Int level);
HYPRE_Int
HYPRE_SStructPCGGetNumIterations(HYPRE_SStructSolver solver,
HYPRE_Int *num_iterations);
HYPRE_Int
HYPRE_SStructPCGGetFinalRelativeResidualNorm(HYPRE_SStructSolver solver,
double *norm);
HYPRE_Int
HYPRE_SStructPCGGetResidual(HYPRE_SStructSolver solver,
void **residual);
/**
* Setup routine for diagonal preconditioning.
**/
HYPRE_Int
HYPRE_SStructDiagScaleSetup(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector y,
HYPRE_SStructVector x);
/**
* Solve routine for diagonal preconditioning.
**/
HYPRE_Int
HYPRE_SStructDiagScale(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector y,
HYPRE_SStructVector x);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name SStruct GMRES Solver
*
* These routines should be used in conjunction with the generic interface in
* \Ref{GMRES Solver}.
**/
/*@{*/
/**
* Create a solver object.
**/
HYPRE_Int
HYPRE_SStructGMRESCreate(MPI_Comm comm,
HYPRE_SStructSolver *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.
**/
HYPRE_Int
HYPRE_SStructGMRESDestroy(HYPRE_SStructSolver solver);
HYPRE_Int
HYPRE_SStructGMRESSetup(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
HYPRE_Int
HYPRE_SStructGMRESSolve(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
HYPRE_Int
HYPRE_SStructGMRESSetTol(HYPRE_SStructSolver solver,
double tol);
HYPRE_Int
HYPRE_SStructGMRESSetAbsoluteTol(HYPRE_SStructSolver solver,
double tol);
/*
* RE-VISIT
**/
HYPRE_Int
HYPRE_SStructGMRESSetMinIter(HYPRE_SStructSolver solver,
HYPRE_Int min_iter);
HYPRE_Int
HYPRE_SStructGMRESSetMaxIter(HYPRE_SStructSolver solver,
HYPRE_Int max_iter);
HYPRE_Int
HYPRE_SStructGMRESSetKDim(HYPRE_SStructSolver solver,
HYPRE_Int k_dim);
/*
* RE-VISIT
**/
HYPRE_Int
HYPRE_SStructGMRESSetStopCrit(HYPRE_SStructSolver solver,
HYPRE_Int stop_crit);
HYPRE_Int
HYPRE_SStructGMRESSetPrecond(HYPRE_SStructSolver solver,
HYPRE_PtrToSStructSolverFcn precond,
HYPRE_PtrToSStructSolverFcn precond_setup,
void *precond_solver);
HYPRE_Int
HYPRE_SStructGMRESSetLogging(HYPRE_SStructSolver solver,
HYPRE_Int logging);
HYPRE_Int
HYPRE_SStructGMRESSetPrintLevel(HYPRE_SStructSolver solver,
HYPRE_Int print_level);
HYPRE_Int
HYPRE_SStructGMRESGetNumIterations(HYPRE_SStructSolver solver,
HYPRE_Int *num_iterations);
HYPRE_Int
HYPRE_SStructGMRESGetFinalRelativeResidualNorm(HYPRE_SStructSolver solver,
double *norm);
HYPRE_Int
HYPRE_SStructGMRESGetResidual(HYPRE_SStructSolver solver,
void **residual);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name SStruct FlexGMRES Solver
*
* These routines should be used in conjunction with the generic interface in
* \Ref{FlexGMRES Solver}.
**/
/*@{*/
/**
* Create a solver object.
**/
HYPRE_Int
HYPRE_SStructFlexGMRESCreate(MPI_Comm comm,
HYPRE_SStructSolver *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.
**/
HYPRE_Int
HYPRE_SStructFlexGMRESDestroy(HYPRE_SStructSolver solver);
HYPRE_Int
HYPRE_SStructFlexGMRESSetup(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
HYPRE_Int
HYPRE_SStructFlexGMRESSolve(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
HYPRE_Int
HYPRE_SStructFlexGMRESSetTol(HYPRE_SStructSolver solver,
double tol);
HYPRE_Int
HYPRE_SStructFlexGMRESSetAbsoluteTol(HYPRE_SStructSolver solver,
double tol);
/*
* RE-VISIT
**/
HYPRE_Int
HYPRE_SStructFlexGMRESSetMinIter(HYPRE_SStructSolver solver,
HYPRE_Int min_iter);
HYPRE_Int
HYPRE_SStructFlexGMRESSetMaxIter(HYPRE_SStructSolver solver,
HYPRE_Int max_iter);
HYPRE_Int
HYPRE_SStructFlexGMRESSetKDim(HYPRE_SStructSolver solver,
HYPRE_Int k_dim);
HYPRE_Int
HYPRE_SStructFlexGMRESSetPrecond(HYPRE_SStructSolver solver,
HYPRE_PtrToSStructSolverFcn precond,
HYPRE_PtrToSStructSolverFcn precond_setup,
void *precond_solver);
HYPRE_Int
HYPRE_SStructFlexGMRESSetLogging(HYPRE_SStructSolver solver,
HYPRE_Int logging);
HYPRE_Int
HYPRE_SStructFlexGMRESSetPrintLevel(HYPRE_SStructSolver solver,
HYPRE_Int print_level);
HYPRE_Int
HYPRE_SStructFlexGMRESGetNumIterations(HYPRE_SStructSolver solver,
HYPRE_Int *num_iterations);
HYPRE_Int
HYPRE_SStructFlexGMRESGetFinalRelativeResidualNorm(HYPRE_SStructSolver solver,
double *norm);
HYPRE_Int
HYPRE_SStructFlexGMRESGetResidual(HYPRE_SStructSolver solver,
void **residual);
HYPRE_Int
HYPRE_SStructFlexGMRESSetModifyPC(HYPRE_SStructSolver solver,
HYPRE_PtrToModifyPCFcn modify_pc);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name SStruct LGMRES Solver
*
* These routines should be used in conjunction with the generic interface in
* \Ref{LGMRES Solver}.
**/
/*@{*/
/**
* Create a solver object.
**/
HYPRE_Int
HYPRE_SStructLGMRESCreate(MPI_Comm comm,
HYPRE_SStructSolver *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.
**/
HYPRE_Int
HYPRE_SStructLGMRESDestroy(HYPRE_SStructSolver solver);
HYPRE_Int
HYPRE_SStructLGMRESSetup(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
HYPRE_Int
HYPRE_SStructLGMRESSolve(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
HYPRE_Int
HYPRE_SStructLGMRESSetTol(HYPRE_SStructSolver solver,
double tol);
HYPRE_Int
HYPRE_SStructLGMRESSetAbsoluteTol(HYPRE_SStructSolver solver,
double tol);
/*
* RE-VISIT
**/
HYPRE_Int
HYPRE_SStructLGMRESSetMinIter(HYPRE_SStructSolver solver,
HYPRE_Int min_iter);
HYPRE_Int
HYPRE_SStructLGMRESSetMaxIter(HYPRE_SStructSolver solver,
HYPRE_Int max_iter);
HYPRE_Int
HYPRE_SStructLGMRESSetKDim(HYPRE_SStructSolver solver,
HYPRE_Int k_dim);
HYPRE_Int
HYPRE_SStructLGMRESSetAugDim(HYPRE_SStructSolver solver,
HYPRE_Int aug_dim);
HYPRE_Int
HYPRE_SStructLGMRESSetPrecond(HYPRE_SStructSolver solver,
HYPRE_PtrToSStructSolverFcn precond,
HYPRE_PtrToSStructSolverFcn precond_setup,
void *precond_solver);
HYPRE_Int
HYPRE_SStructLGMRESSetLogging(HYPRE_SStructSolver solver,
HYPRE_Int logging);
HYPRE_Int
HYPRE_SStructLGMRESSetPrintLevel(HYPRE_SStructSolver solver,
HYPRE_Int print_level);
HYPRE_Int
HYPRE_SStructLGMRESGetNumIterations(HYPRE_SStructSolver solver,
HYPRE_Int *num_iterations);
HYPRE_Int
HYPRE_SStructLGMRESGetFinalRelativeResidualNorm(HYPRE_SStructSolver solver,
double *norm);
HYPRE_Int
HYPRE_SStructLGMRESGetResidual(HYPRE_SStructSolver solver,
void **residual);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name SStruct BiCGSTAB Solver
*
* These routines should be used in conjunction with the generic interface in
* \Ref{BiCGSTAB Solver}.
**/
/*@{*/
/**
* Create a solver object.
**/
HYPRE_Int
HYPRE_SStructBiCGSTABCreate(MPI_Comm comm,
HYPRE_SStructSolver *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.
**/
HYPRE_Int
HYPRE_SStructBiCGSTABDestroy(HYPRE_SStructSolver solver);
HYPRE_Int
HYPRE_SStructBiCGSTABSetup(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
HYPRE_Int
HYPRE_SStructBiCGSTABSolve(HYPRE_SStructSolver solver,
HYPRE_SStructMatrix A,
HYPRE_SStructVector b,
HYPRE_SStructVector x);
HYPRE_Int
HYPRE_SStructBiCGSTABSetTol(HYPRE_SStructSolver solver,
double tol);
HYPRE_Int
HYPRE_SStructBiCGSTABSetAbsoluteTol(HYPRE_SStructSolver solver,
double tol);
/*
* RE-VISIT
**/
HYPRE_Int
HYPRE_SStructBiCGSTABSetMinIter(HYPRE_SStructSolver solver,
HYPRE_Int min_iter);
HYPRE_Int
HYPRE_SStructBiCGSTABSetMaxIter(HYPRE_SStructSolver solver,
HYPRE_Int max_iter);
/*
* RE-VISIT
**/
HYPRE_Int
HYPRE_SStructBiCGSTABSetStopCrit(HYPRE_SStructSolver solver,
HYPRE_Int stop_crit);
HYPRE_Int
HYPRE_SStructBiCGSTABSetPrecond(HYPRE_SStructSolver solver,
HYPRE_PtrToSStructSolverFcn precond,
HYPRE_PtrToSStructSolverFcn precond_setup,
void *precond_solver);
HYPRE_Int
HYPRE_SStructBiCGSTABSetLogging(HYPRE_SStructSolver solver,
HYPRE_Int logging);
HYPRE_Int
HYPRE_SStructBiCGSTABSetPrintLevel(HYPRE_SStructSolver solver,
HYPRE_Int level);
HYPRE_Int
HYPRE_SStructBiCGSTABGetNumIterations(HYPRE_SStructSolver solver,
HYPRE_Int *num_iterations);
HYPRE_Int
HYPRE_SStructBiCGSTABGetFinalRelativeResidualNorm(HYPRE_SStructSolver solver,
double *norm);
HYPRE_Int
HYPRE_SStructBiCGSTABGetResidual(HYPRE_SStructSolver solver,
void **residual);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/* These includes shouldn't be here. (RDF) */
#include "interpreter.h"
#include "HYPRE_MatvecFunctions.h"
#include "_hypre_sstruct_mv.h"
/**
* @name SStruct LOBPCG Eigensolver
*
* These routines should be used in conjunction with the generic interface in
* \Ref{LOBPCG Eigensolver}.
**/
/*@{*/
/**
* Load interface interpreter. Vector part loaded with hypre_SStructKrylov
* functions and multivector part loaded with mv_TempMultiVector functions.
**/
HYPRE_Int
HYPRE_SStructSetupInterpreter(mv_InterfaceInterpreter *i);
/**
* Load Matvec interpreter with hypre_SStructKrylov functions.
**/
HYPRE_Int
HYPRE_SStructSetupMatvec(HYPRE_MatvecFunctions *mv);
/* The next routines should not be here (lower-case prefix). (RDF) */
/*
* Set hypre_SStructPVector to random values.
**/
HYPRE_Int
hypre_SStructPVectorSetRandomValues(hypre_SStructPVector *pvector, HYPRE_Int seed);
/*
* Set hypre_SStructVector to random values.
**/
HYPRE_Int
hypre_SStructVectorSetRandomValues(hypre_SStructVector *vector, HYPRE_Int seed);
/*
* Same as hypre_SStructVectorSetRandomValues except uses void pointer.
**/
HYPRE_Int
hypre_SStructSetRandomValues(void *v, HYPRE_Int seed);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/*@}*/
#ifdef __cplusplus
}
#endif
#endif
|