/usr/share/doc/libsundials-serial-dev/examples/idas/parallel/idasHeat2D_FSA_kry_bbd_p.c is in libsundials-serial-dev 2.5.0-3+b3.
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 | /*
* -----------------------------------------------------------------
* $Revision: 1.2 $
* $Date: 2010/12/01 23:06:38 $
* -----------------------------------------------------------------
* Programmer(s): Radu Serban @ LLNL
* -----------------------------------------------------------------
* Example problem for IDAS: FSA for 2D heat equation, parallel,
* GMRES, IDABBDPRE.
*
* This example solves a discretized 2D heat equation problem and
* performs forward sensitivity analysis with respect to the
* diffusion coefficients. This version uses the Krylov solver
* IDASpgmr and BBD preconditioning.
*
* The DAE system solved is a spatial discretization of the PDE
* du/dt = p1 * d^2u/dx^2 + p2 * d^2u/dy^2
* on the unit square. The nominal values of the parameters are
* p1 = p2 = 1.0. The boundary condition is u = 0 on all edges.
* Initial conditions are given by u = 16 x (1 - x) y (1 - y).
* The PDE is treated with central differences on a uniform
* MX x MY grid. The values of u at the interior points satisfy
* ODEs, and equations u = 0 at the boundaries are appended,\
* to form a DAE system of size N = MX * MY. Here MX = MY = 10.
*
* The system is actually implemented on submeshes, processor by
* processor, with an MXSUB by MYSUB mesh on each of NPEX * NPEY
* processors.
*
* The system is solved with IDA using the Krylov linear solver
* IDASPGMR in conjunction with the preconditioner module IDABBDPRE.
* The preconditioner uses a tridiagonal approximation
* (half-bandwidths = 1). The constraints u >= 0 are posed for all
* components. Local error testing on the boundary values is
* suppressed. Output is taken at t = 0, .01, .02, .04, ..., 10.24.
* -----------------------------------------------------------------
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <math.h>
#include <idas/idas.h>
#include <idas/idas_spgmr.h>
#include <idas/idas_bbdpre.h>
#include <nvector/nvector_parallel.h>
#include <sundials/sundials_math.h>
#include <mpi.h>
#define ZERO RCONST(0.0)
#define ONE RCONST(1.0)
#define TWO RCONST(2.0)
#define NOUT 11 /* Number of output times */
#define NPEX 2 /* No. PEs in x direction of PE array */
#define NPEY 2 /* No. PEs in y direction of PE array */
/* Total no. PEs = NPEX*NPEY */
#define MXSUB 5 /* No. x points per subgrid */
#define MYSUB 5 /* No. y points per subgrid */
#define MX (NPEX*MXSUB) /* MX = number of x mesh points */
#define MY (NPEY*MYSUB) /* MY = number of y mesh points */
/* Spatial mesh is MX by MY */
#define NS 2 /* Number of sensitivities (NS<=2) */
typedef struct {
realtype p[2];
int thispe, mx, my, ixsub, jysub, npex, npey, mxsub, mysub;
long int n_local;
realtype dx, dy, coeffx, coeffy, coeffxy;
realtype uext[(MXSUB+2)*(MYSUB+2)];
MPI_Comm comm;
} *UserData;
/* Prototypes of user-supplied and supporting functions */
static int heatres(realtype tres,
N_Vector uu, N_Vector up, N_Vector res,
void *user_data);
static int rescomm(long int Nlocal, realtype tt,
N_Vector uu, N_Vector up,
void *user_data);
static int reslocal(long int Nlocal, realtype tres,
N_Vector uu, N_Vector up, N_Vector res,
void *user_data);
static int BSend(MPI_Comm comm, int thispe, int ixsub,
int jysub, int dsizex, int dsizey,
realtype uarray[]);
static int BRecvPost(MPI_Comm comm, MPI_Request request[], int thispe,
int ixsub, int jysub,
int dsizex, int dsizey,
realtype uext[], realtype buffer[]);
static int BRecvWait(MPI_Request request[], int ixsub, int jysub,
int dsizex, realtype uext[], realtype buffer[]);
/* Prototypes of private functions */
static int InitUserData(int thispe, MPI_Comm comm, UserData data);
static int SetInitialProfile(N_Vector uu, N_Vector up, N_Vector id,
N_Vector res, UserData data);
static void PrintHeader(int Neq, realtype rtol, realtype atol,
int mudq, int mukeep,
booleantype sensi, int sensi_meth, int err_con);
static void PrintOutput(int id, void *mem, realtype t, N_Vector uu,
booleantype sensi, N_Vector *uuS);
static void PrintFinalStats(void *mem);
static void ProcessArgs(int argc, char *argv[], int my_pe,
booleantype *sensi, int *sensi_meth, booleantype *err_con);
static void WrongArgs(int my_pe, char *name);
static int check_flag(void *flagvalue, char *funcname, int opt, int id);
/*
*--------------------------------------------------------------------
* MAIN PROGRAM
*--------------------------------------------------------------------
*/
int main(int argc, char *argv[])
{
MPI_Comm comm;
void *mem;
UserData data;
int thispe, iout, ier, npes;
long int Neq, local_N, mudq, mldq, mukeep, mlkeep;
realtype rtol, atol, t0, t1, tout, tret;
N_Vector uu, up, constraints, id, res;
realtype *pbar;
int is;
N_Vector *uuS, *upS;
booleantype sensi, err_con;
int sensi_meth;
mem = NULL;
data = NULL;
uu = up = constraints = id = res = NULL;
uuS = upS = NULL;
/* Get processor number and total number of pe's. */
MPI_Init(&argc, &argv);
comm = MPI_COMM_WORLD;
MPI_Comm_size(comm, &npes);
MPI_Comm_rank(comm, &thispe);
if (npes != NPEX*NPEY) {
if (thispe == 0)
fprintf(stderr,
"\nMPI_ERROR(0): npes = %d is not equal to NPEX*NPEY = %d\n",
npes,NPEX*NPEY);
MPI_Finalize();
return(1);
}
/* Process arguments */
ProcessArgs(argc, argv, thispe, &sensi, &sensi_meth, &err_con);
/* Set local length local_N and global length Neq. */
local_N = MXSUB*MYSUB;
Neq = MX * MY;
/* Allocate N-vectors. */
uu = N_VNew_Parallel(comm, local_N, Neq);
if(check_flag((void *)uu, "N_VNew_Parallel", 0, thispe)) MPI_Abort(comm, 1);
up = N_VNew_Parallel(comm, local_N, Neq);
if(check_flag((void *)up, "N_VNew_Parallel", 0, thispe)) MPI_Abort(comm, 1);
res = N_VNew_Parallel(comm, local_N, Neq);
if(check_flag((void *)res, "N_VNew_Parallel", 0, thispe)) MPI_Abort(comm, 1);
constraints = N_VNew_Parallel(comm, local_N, Neq);
if(check_flag((void *)constraints, "N_VNew_Parallel", 0, thispe)) MPI_Abort(comm, 1);
id = N_VNew_Parallel(comm, local_N, Neq);
if(check_flag((void *)id, "N_VNew_Parallel", 0, thispe)) MPI_Abort(comm, 1);
/* Allocate and initialize the data structure. */
data = (UserData) malloc(sizeof *data);
if(check_flag((void *)data, "malloc", 2, thispe)) MPI_Abort(comm, 1);
InitUserData(thispe, comm, data);
/* Initialize the uu, up, id, and constraints profiles. */
SetInitialProfile(uu, up, id, res, data);
N_VConst(ONE, constraints);
t0 = ZERO; t1 = RCONST(0.01);
/* Scalar relative and absolute tolerance. */
rtol = ZERO;
atol = RCONST(1.0e-3);
/* Call IDACreate and IDAInit to initialize solution and various
IDASet*** functions to specify optional inputs:
- indicate which variables are differential and which are algebraic
- exclude algebraic variables from error test
- specify additional constraints on solution components */
mem = IDACreate();
if(check_flag((void *)mem, "IDACreate", 0, thispe)) MPI_Abort(comm, 1);
ier = IDASetUserData(mem, data);
if(check_flag(&ier, "IDASetUserData", 1, thispe)) MPI_Abort(comm, 1);
ier = IDASetSuppressAlg(mem, TRUE);
if(check_flag(&ier, "IDASetSuppressAlg", 1, thispe)) MPI_Abort(comm, 1);
ier = IDASetId(mem, id);
if(check_flag(&ier, "IDASetId", 1, thispe)) MPI_Abort(comm, 1);
ier = IDASetConstraints(mem, constraints);
if(check_flag(&ier, "IDASetConstraints", 1, thispe)) MPI_Abort(comm, 1);
N_VDestroy_Parallel(constraints);
ier = IDAInit(mem, heatres, t0, uu, up);
if(check_flag(&ier, "IDAInit", 1, thispe)) MPI_Abort(comm, 1);
/* Specify state tolerances (scalar relative and absolute tolerances) */
ier = IDASStolerances(mem, rtol, atol);
if(check_flag(&ier, "IDASStolerances", 1, thispe)) MPI_Abort(comm, 1);
/* Call IDASpgmr to specify the linear solver. */
ier = IDASpgmr(mem, 12);
if(check_flag(&ier, "IDASpgmr", 1, thispe)) MPI_Abort(comm, 1);
/* Call IDABBDPrecInit to initialize BBD preconditioner. */
mudq = MXSUB;
mldq = MXSUB;
mukeep = 1;
mlkeep = 1;
ier = IDABBDPrecInit(mem, local_N, mudq, mldq, mukeep, mlkeep,
ZERO, reslocal, NULL);
if(check_flag(&ier, "IDABBDPrecInit", 1, thispe)) MPI_Abort(comm, 1);
/* Sensitivity-related settings */
if( sensi) {
/* Allocate and set pbar, the vector with order of magnitude
information for the problem parameters. (Note: this is
done here as an illustration only, as the default values
for pbar, if pbar is not supplied, are anyway 1.0) */
pbar = (realtype *) malloc(NS*sizeof(realtype));
if (check_flag((void *)pbar, "malloc", 2, thispe)) MPI_Abort(comm, 1);
for (is=0; is<NS; is++) pbar[is] = data->p[is];
/* Allocate sensitivity solution vectors uuS and upS and set them
to an initial guess for the sensitivity ICs (the IC for uuS are
0.0 since the state IC do not depend on the porblem parameters;
however, the derivatives upS may not and therefore we will have
to call IDACalcIC to find them) */
uuS = N_VCloneVectorArray_Parallel(NS, uu);
if (check_flag((void *)uuS, "N_VCloneVectorArray_Parallel", 0, thispe)) MPI_Abort(comm, 1);
for (is = 0; is < NS; is++) N_VConst(ZERO,uuS[is]);
upS = N_VCloneVectorArray_Parallel(NS, uu);
if (check_flag((void *)upS, "N_VCloneVectorArray_Parallel", 0, thispe)) MPI_Abort(comm, 1);
for (is = 0; is < NS; is++) N_VConst(ZERO,upS[is]);
/* Initialize FSA using the default internal sensitivity residual function
(Note that this requires specifying the problem parameters -- see below) */
ier = IDASensInit(mem, NS, sensi_meth, NULL, uuS, upS);
if(check_flag(&ier, "IDASensInit", 1, thispe)) MPI_Abort(comm, 1);
/* Indicate the use of internally estimated tolerances for the sensitivity
variables (based on the tolerances provided for the states and the
pbar values) */
ier = IDASensEEtolerances(mem);
if(check_flag(&ier, "IDASensEEtolerances", 1, thispe)) MPI_Abort(comm, 1);
/* Specify whether the sensitivity variables are included in the error
test or not */
ier = IDASetSensErrCon(mem, err_con);
if(check_flag(&ier, "IDASetSensErrCon", 1, thispe)) MPI_Abort(comm, 1);
/* Specify the problem parameters and their order of magnitude
(Note that we do not specify the index array plist and therefore
IDAS will compute sensitivities w.r.t. the first NS parameters) */
ier = IDASetSensParams(mem, data->p, pbar, NULL);
if(check_flag(&ier, "IDASetSensParams", 1, thispe)) MPI_Abort(comm, 1);
/* Compute consistent initial conditions (Note that this is required
only if performing SA since uu and up already contain consistent
initial conditions for the states) */
ier = IDACalcIC(mem, IDA_YA_YDP_INIT, t1);
if(check_flag(&ier, "IDACalcIC", 1, thispe)) MPI_Abort(comm, 1);
}
/* Print problem description */
if (thispe == 0 ) PrintHeader(Neq, rtol, atol, mudq, mukeep,
sensi, sensi_meth, err_con);
/* Loop over tout, call IDASolve, print output. */
for (tout = t1, iout = 1; iout <= NOUT; iout++, tout *= TWO) {
ier = IDASolve(mem, tout, &tret, uu, up, IDA_NORMAL);
if(check_flag(&ier, "IDASolve", 1, thispe)) MPI_Abort(comm, 1);
if (sensi) {
ier = IDAGetSens(mem, &tret, uuS);
if(check_flag(&ier, "IDAGetSens", 1, thispe)) MPI_Abort(comm, 1);
}
PrintOutput(thispe, mem, tret, uu, sensi, uuS);
}
/* Print final statistics */
if (thispe == 0) PrintFinalStats(mem);
/* Free Memory */
IDAFree(&mem);
free(data);
N_VDestroy_Parallel(id);
N_VDestroy_Parallel(res);
N_VDestroy_Parallel(up);
N_VDestroy_Parallel(uu);
MPI_Finalize();
return(0);
}
/*
*--------------------------------------------------------------------
* FUNCTIONS CALLED BY IDA
*--------------------------------------------------------------------
*/
/*
* heatres: heat equation system residual function
* This uses 5-point central differencing on the interior points, and
* includes algebraic equations for the boundary values.
* So for each interior point, the residual component has the form
* res_i = u'_i - (central difference)_i
* while for each boundary point, it is res_i = u_i.
*
* This parallel implementation uses several supporting routines.
* First a call is made to rescomm to do communication of subgrid boundary
* data into array uext. Then reslocal is called to compute the residual
* on individual processors and their corresponding domains. The routines
* BSend, BRecvPost, and BREcvWait handle interprocessor communication
* of uu required to calculate the residual.
*/
static int heatres(realtype tres, N_Vector uu, N_Vector up,
N_Vector res, void *user_data)
{
int retval;
UserData data;
long int Nlocal;
data = (UserData) user_data;
Nlocal = data->n_local;
/* Call rescomm to do inter-processor communication. */
retval = rescomm(Nlocal, tres, uu, up, data);
/* Call reslocal to calculate res. */
retval = reslocal(Nlocal, tres, uu, up, res, data);
return(0);
}
/*
* rescomm routine. This routine performs all inter-processor
* communication of data in u needed to calculate G.
*/
static int rescomm(long int Nlocal, realtype tt,
N_Vector uu, N_Vector up, void *user_data)
{
UserData data;
realtype *uarray, *uext, buffer[2*MYSUB];
MPI_Comm comm;
int thispe, ixsub, jysub, mxsub, mysub;
MPI_Request request[4];
data = (UserData) user_data;
uarray = NV_DATA_P(uu);
/* Get comm, thispe, subgrid indices, data sizes, extended array uext. */
comm = data->comm; thispe = data->thispe;
ixsub = data->ixsub; jysub = data->jysub;
mxsub = data->mxsub; mysub = data->mysub;
uext = data->uext;
/* Start receiving boundary data from neighboring PEs. */
BRecvPost(comm, request, thispe, ixsub, jysub, mxsub, mysub, uext, buffer);
/* Send data from boundary of local grid to neighboring PEs. */
BSend(comm, thispe, ixsub, jysub, mxsub, mysub, uarray);
/* Finish receiving boundary data from neighboring PEs. */
BRecvWait(request, ixsub, jysub, mxsub, uext, buffer);
return(0);
}
/*
* reslocal routine. Compute res = F(t, uu, up). This routine assumes
* that all inter-processor communication of data needed to calculate F
* has already been done, and that this data is in the work array uext.
*/
static int reslocal(long int Nlocal, realtype tres,
N_Vector uu, N_Vector up, N_Vector res,
void *user_data)
{
realtype *uext, *uuv, *upv, *resv;
realtype termx, termy;
int lx, ly, offsetu, offsetue, locu, locue;
int ixsub, jysub, mxsub, mxsub2, mysub, npex, npey;
int ixbegin, ixend, jybegin, jyend;
UserData data;
realtype p1, p2;
/* Get subgrid indices, array sizes, extended work array uext. */
data = (UserData) user_data;
uext = data->uext;
uuv = NV_DATA_P(uu);
upv = NV_DATA_P(up);
resv = NV_DATA_P(res);
ixsub = data->ixsub; jysub = data->jysub;
mxsub = data->mxsub; mxsub2 = data->mxsub + 2;
mysub = data->mysub; npex = data->npex; npey = data->npey;
p1 = data->p[0];
p2 = data->p[1];
/* Initialize all elements of res to uu. This sets the boundary
elements simply without indexing hassles. */
N_VScale(ONE, uu, res);
/* Copy local segment of u vector into the working extended array uext.
This completes uext prior to the computation of the res vector. */
offsetu = 0;
offsetue = mxsub2 + 1;
for (ly = 0; ly < mysub; ly++) {
for (lx = 0; lx < mxsub; lx++) uext[offsetue+lx] = uuv[offsetu+lx];
offsetu = offsetu + mxsub;
offsetue = offsetue + mxsub2;
}
/* Set loop limits for the interior of the local subgrid. */
ixbegin = 0;
ixend = mxsub-1;
jybegin = 0;
jyend = mysub-1;
if (ixsub == 0) ixbegin++; if (ixsub == npex-1) ixend--;
if (jysub == 0) jybegin++; if (jysub == npey-1) jyend--;
/* Loop over all grid points in local subgrid. */
for (ly = jybegin; ly <=jyend; ly++) {
for (lx = ixbegin; lx <= ixend; lx++) {
locu = lx + ly*mxsub;
locue = (lx+1) + (ly+1)*mxsub2;
termx = p1 * data->coeffx *(uext[locue-1] - TWO*uext[locue] + uext[locue+1]);
termy = p2 * data->coeffy *(uext[locue-mxsub2] - TWO*uext[locue] + uext[locue+mxsub2]);
resv[locu] = upv[locu] - (termx + termy);
}
}
return(0);
}
/*
* Routine to send boundary data to neighboring PEs.
*/
static int BSend(MPI_Comm comm, int thispe, int ixsub,
int jysub, int dsizex, int dsizey,
realtype uarray[])
{
int ly, offsetu;
realtype bufleft[MYSUB], bufright[MYSUB];
/* If jysub > 0, send data from bottom x-line of u. */
if (jysub != 0)
MPI_Send(&uarray[0], dsizex, PVEC_REAL_MPI_TYPE, thispe-NPEX, 0, comm);
/* If jysub < NPEY-1, send data from top x-line of u. */
if (jysub != NPEY-1) {
offsetu = (MYSUB-1)*dsizex;
MPI_Send(&uarray[offsetu], dsizex, PVEC_REAL_MPI_TYPE,
thispe+NPEX, 0, comm);
}
/* If ixsub > 0, send data from left y-line of u (via bufleft). */
if (ixsub != 0) {
for (ly = 0; ly < MYSUB; ly++) {
offsetu = ly*dsizex;
bufleft[ly] = uarray[offsetu];
}
MPI_Send(&bufleft[0], dsizey, PVEC_REAL_MPI_TYPE, thispe-1, 0, comm);
}
/* If ixsub < NPEX-1, send data from right y-line of u (via bufright). */
if (ixsub != NPEX-1) {
for (ly = 0; ly < MYSUB; ly++) {
offsetu = ly*MXSUB + (MXSUB-1);
bufright[ly] = uarray[offsetu];
}
MPI_Send(&bufright[0], dsizey, PVEC_REAL_MPI_TYPE, thispe+1, 0, comm);
}
return(0);
}
/*
* Routine to start receiving boundary data from neighboring PEs.
* Notes:
* 1) buffer should be able to hold 2*MYSUB realtype entries, should be
* passed to both the BRecvPost and BRecvWait functions, and should not
* be manipulated between the two calls.
* 2) request should have 4 entries, and should be passed in
* both calls also.
*/
static int BRecvPost(MPI_Comm comm, MPI_Request request[], int thispe,
int ixsub, int jysub,
int dsizex, int dsizey,
realtype uext[], realtype buffer[])
{
int offsetue;
/* Have bufleft and bufright use the same buffer. */
realtype *bufleft = buffer, *bufright = buffer+MYSUB;
/* If jysub > 0, receive data for bottom x-line of uext. */
if (jysub != 0)
MPI_Irecv(&uext[1], dsizex, PVEC_REAL_MPI_TYPE,
thispe-NPEX, 0, comm, &request[0]);
/* If jysub < NPEY-1, receive data for top x-line of uext. */
if (jysub != NPEY-1) {
offsetue = (1 + (MYSUB+1)*(MXSUB+2));
MPI_Irecv(&uext[offsetue], dsizex, PVEC_REAL_MPI_TYPE,
thispe+NPEX, 0, comm, &request[1]);
}
/* If ixsub > 0, receive data for left y-line of uext (via bufleft). */
if (ixsub != 0) {
MPI_Irecv(&bufleft[0], dsizey, PVEC_REAL_MPI_TYPE,
thispe-1, 0, comm, &request[2]);
}
/* If ixsub < NPEX-1, receive data for right y-line of uext (via bufright). */
if (ixsub != NPEX-1) {
MPI_Irecv(&bufright[0], dsizey, PVEC_REAL_MPI_TYPE,
thispe+1, 0, comm, &request[3]);
}
return(0);
}
/*
* Routine to finish receiving boundary data from neighboring PEs.
* Notes:
* 1) buffer should be able to hold 2*MYSUB realtype entries, should be
* passed to both the BRecvPost and BRecvWait functions, and should not
* be manipulated between the two calls.
* 2) request should have four entries, and should be passed in both
* calls also.
*/
static int BRecvWait(MPI_Request request[], int ixsub,
int jysub, int dsizex, realtype uext[],
realtype buffer[])
{
int ly, dsizex2, offsetue;
realtype *bufleft = buffer, *bufright = buffer+MYSUB;
MPI_Status status;
dsizex2 = dsizex + 2;
/* If jysub > 0, receive data for bottom x-line of uext. */
if (jysub != 0)
MPI_Wait(&request[0],&status);
/* If jysub < NPEY-1, receive data for top x-line of uext. */
if (jysub != NPEY-1)
MPI_Wait(&request[1],&status);
/* If ixsub > 0, receive data for left y-line of uext (via bufleft). */
if (ixsub != 0) {
MPI_Wait(&request[2],&status);
/* Copy the buffer to uext. */
for (ly = 0; ly < MYSUB; ly++) {
offsetue = (ly+1)*dsizex2;
uext[offsetue] = bufleft[ly];
}
}
/* If ixsub < NPEX-1, receive data for right y-line of uext (via bufright). */
if (ixsub != NPEX-1) {
MPI_Wait(&request[3],&status);
/* Copy the buffer to uext */
for (ly = 0; ly < MYSUB; ly++) {
offsetue = (ly+2)*dsizex2 - 1;
uext[offsetue] = bufright[ly];
}
}
return(0);
}
/*
*--------------------------------------------------------------------
* PRIVATE FUNCTIONS
*--------------------------------------------------------------------
*/
/*
* InitUserData initializes the user's data block data.
*/
static int InitUserData(int thispe, MPI_Comm comm, UserData data)
{
data->thispe = thispe;
data->dx = ONE/(MX-ONE); /* Assumes a [0,1] interval in x. */
data->dy = ONE/(MY-ONE); /* Assumes a [0,1] interval in y. */
data->coeffx = ONE/(data->dx * data->dx);
data->coeffy = ONE/(data->dy * data->dy);
data->coeffxy = TWO/(data->dx * data->dx) + TWO/(data->dy * data->dy) ;
data->jysub = thispe/NPEX;
data->ixsub = thispe - data->jysub * NPEX;
data->npex = NPEX;
data->npey = NPEY;
data->mx = MX;
data->my = MY;
data->mxsub = MXSUB;
data->mysub = MYSUB;
data->comm = comm;
data->n_local = MXSUB*MYSUB;
data->p[0] = ONE;
data->p[1] = ONE;
return(0);
}
/*
* SetInitialProfile sets the initial values for the problem.
*/
static int SetInitialProfile(N_Vector uu, N_Vector up, N_Vector id,
N_Vector res, UserData data)
{
int i, iloc, j, jloc, offset, loc, ixsub, jysub;
int ixbegin, ixend, jybegin, jyend;
realtype xfact, yfact, *udata, *iddata, dx, dy;
/* Initialize uu. */
udata = NV_DATA_P(uu);
iddata = NV_DATA_P(id);
/* Set mesh spacings and subgrid indices for this PE. */
dx = data->dx;
dy = data->dy;
ixsub = data->ixsub;
jysub = data->jysub;
/* Set beginning and ending locations in the global array corresponding
to the portion of that array assigned to this processor. */
ixbegin = MXSUB*ixsub;
ixend = MXSUB*(ixsub+1) - 1;
jybegin = MYSUB*jysub;
jyend = MYSUB*(jysub+1) - 1;
/* Loop over the local array, computing the initial profile value.
The global indices are (i,j) and the local indices are (iloc,jloc).
Also set the id vector to zero for boundary points, one otherwise. */
N_VConst(ONE,id);
for (j = jybegin, jloc = 0; j <= jyend; j++, jloc++) {
yfact = data->dy*j;
offset= jloc*MXSUB;
for (i = ixbegin, iloc = 0; i <= ixend; i++, iloc++) {
xfact = data->dx * i;
loc = offset + iloc;
udata[loc] = RCONST(16.0) * xfact * (ONE - xfact) * yfact * (ONE - yfact);
if (i == 0 || i == MX-1 || j == 0 || j == MY-1) iddata[loc] = ZERO;
}
}
/* Initialize up. */
N_VConst(ZERO, up); /* Initially set up = 0. */
/* heatres sets res to negative of ODE RHS values at interior points. */
heatres(ZERO, uu, up, res, data);
/* Copy -res into up to get correct initial up values. */
N_VScale(-ONE, res, up);
return(0);
}
/*
* Print first lines of output (problem description)
* and table heading
*/
static void PrintHeader(int Neq, realtype rtol, realtype atol,
int mudq, int mukeep,
booleantype sensi, int sensi_meth, int err_con)
{
printf("\nidasHeat2D_FSA_kry_bbd_p: Heat equation, parallel example problem for IDA\n");
printf(" Discretized heat equation on 2D unit square.\n");
printf(" Zero boundary conditions, polynomial initial conditions.\n");
printf(" Mesh dimensions: %d x %d ; ", MX, MY);
printf(" Total system size: %d\n\n", Neq);
printf("Subgrid dimensions: %d x %d", MXSUB, MYSUB);
printf(" Processor array: %d x %d\n", NPEX, NPEY);
#if defined(SUNDIALS_EXTENDED_PRECISION)
printf("Tolerance parameters: rtol = %Lg atol = %Lg\n", rtol, atol);
#elif defined(SUNDIALS_DOUBLE_PRECISION)
printf("Tolerance parameters: rtol = %lg atol = %lg\n", rtol, atol);
#else
printf("Tolerance parameters: rtol = %g atol = %g\n", rtol, atol);
#endif
printf("Constraints set to force all solution components >= 0. \n");
printf("SUPPRESSALG = TRUE to suppress local error testing on");
printf(" all boundary components. \n");
printf("Linear solver: IDASPGMR. ");
printf("Preconditioner: IDABBDPRE - Banded-block-diagonal.\n");
printf("Difference quotient half-bandwidths = %d",mudq);
printf("Retained matrix half-bandwidths = %d \n\n",mukeep);
if (sensi) {
printf("Sensitivity: YES ");
if(sensi_meth == IDA_SIMULTANEOUS)
printf("( SIMULTANEOUS +");
else
printf("( STAGGERED +");
if(err_con) printf(" FULL ERROR CONTROL )");
else printf(" PARTIAL ERROR CONTROL )");
} else {
printf("Sensitivity: NO ");
}
printf("\n\nOutput Summary: umax = max-norm of solution\n");
printf(" max-norm of sensitivity 1\n");
printf(" max-norm of sensitivity 2\n\n");
printf(" time umax k nst nni nli nre nreLS nge h npe nps\n");
printf(" . . . . . . . . . . . . . . . . . . . . . . . .\n");
}
/*
* Print integrator statistics and max-norm of solution
*/
static void PrintOutput(int id, void *mem, realtype t, N_Vector uu,
booleantype sensi, N_Vector *uuS)
{
realtype umax, hused;
int kused, ier, is;
long int nst, nni, nre, nli, npe, nps, nreLS, nge;
umax = N_VMaxNorm(uu);
if (id == 0) {
ier = IDAGetLastOrder(mem, &kused);
check_flag(&ier, "IDAGetLastOrder", 1, id);
ier = IDAGetNumSteps(mem, &nst);
check_flag(&ier, "IDAGetNumSteps", 1, id);
ier = IDAGetNumNonlinSolvIters(mem, &nni);
check_flag(&ier, "IDAGetNumNonlinSolvIters", 1, id);
ier = IDAGetNumResEvals(mem, &nre);
check_flag(&ier, "IDAGetNumResEvals", 1, id);
ier = IDAGetLastStep(mem, &hused);
check_flag(&ier, "IDAGetLastStep", 1, id);
ier = IDASpilsGetNumLinIters(mem, &nli);
check_flag(&ier, "IDASpilsGetNumLinIters", 1, id);
ier = IDASpilsGetNumResEvals(mem, &nreLS);
check_flag(&ier, "IDASpilsGetNumResEvals", 1, id);
ier = IDABBDPrecGetNumGfnEvals(mem, &nge);
check_flag(&ier, "IDABBDPrecGetNumGfnEvals", 1, id);
ier = IDASpilsGetNumPrecEvals(mem, &npe);
check_flag(&ier, "IDASpilsGetPrecEvals", 1, id);
ier = IDASpilsGetNumPrecSolves(mem, &nps);
check_flag(&ier, "IDASpilsGetNumPrecSolves", 1, id);
#if defined(SUNDIALS_EXTENDED_PRECISION)
printf(" %5.2Lf %13.5Le %d %3ld %3ld %3ld %4ld %4ld %4ld %9.2Le %3ld %3ld\n",
t, umax, kused, nst, nni, nli, nre, nreLS, nge, hused, npe, nps);
#elif defined(SUNDIALS_DOUBLE_PRECISION)
printf(" %5.2f %13.5le %d %3ld %3ld %3ld %4ld %4ld %4ld %9.2le %3ld %3ld\n",
t, umax, kused, nst, nni, nli, nre, nreLS, nge, hused, npe, nps);
#else
printf(" %5.2f %13.5e %d %3ld %3ld %3ld %4ld %4ld %4ld %9.2e %3ld %3ld\n",
t, umax, kused, nst, nni, nli, nre, nreLS, nge, hused, npe, nps);
#endif
}
if (sensi) {
for (is=0; is<NS; is++) {
umax = N_VMaxNorm(uuS[is]);
if (id == 0) {
#if defined(SUNDIALS_EXTENDED_PRECISION)
printf(" %13.5Le\n", umax);
#elif defined(SUNDIALS_DOUBLE_PRECISION)
printf(" %13.5le\n", umax);
#else
printf(" %13.5e\n", umax);
#endif
}
}
}
}
/*
* Print some final integrator statistics
*/
static void PrintFinalStats(void *mem)
{
long int netf, ncfn, ncfl;
IDAGetNumErrTestFails(mem, &netf);
IDAGetNumNonlinSolvConvFails(mem, &ncfn);
IDASpilsGetNumConvFails(mem, &ncfl);
printf("\nError test failures = %ld\n", netf);
printf("Nonlinear convergence failures = %ld\n", ncfn);
printf("Linear convergence failures = %ld\n", ncfl);
}
/*
* Process and verify command line arguments
*/
static void ProcessArgs(int argc, char *argv[], int my_pe,
booleantype *sensi, int *sensi_meth, booleantype *err_con)
{
*sensi = FALSE;
*sensi_meth = -1;
*err_con = FALSE;
if (argc < 2) WrongArgs(my_pe, argv[0]);
if (strcmp(argv[1],"-nosensi") == 0)
*sensi = FALSE;
else if (strcmp(argv[1],"-sensi") == 0)
*sensi = TRUE;
else
WrongArgs(my_pe, argv[0]);
if (*sensi) {
if (argc != 4)
WrongArgs(my_pe, argv[0]);
if (strcmp(argv[2],"sim") == 0)
*sensi_meth = IDA_SIMULTANEOUS;
else if (strcmp(argv[2],"stg") == 0)
*sensi_meth = IDA_STAGGERED;
else
WrongArgs(my_pe, argv[0]);
if (strcmp(argv[3],"t") == 0)
*err_con = TRUE;
else if (strcmp(argv[3],"f") == 0)
*err_con = FALSE;
else
WrongArgs(my_pe, argv[0]);
}
}
static void WrongArgs(int my_pe, char *name)
{
if (my_pe == 0) {
printf("\nUsage: %s [-nosensi] [-sensi sensi_meth err_con]\n",name);
printf(" sensi_meth = sim, stg, or stg1\n");
printf(" err_con = t or f\n");
}
MPI_Finalize();
exit(0);
}
/*
* Check function return value...
* opt == 0 means SUNDIALS function allocates memory so check if
* returned NULL pointer
* opt == 1 means SUNDIALS function returns a flag so check if
* flag >= 0
* opt == 2 means function allocates memory so check if returned
* NULL pointer
*/
static int check_flag(void *flagvalue, char *funcname, int opt, int id)
{
int *errflag;
/* Check if SUNDIALS function returned NULL pointer - no memory allocated */
if (opt == 0 && flagvalue == NULL) {
fprintf(stderr, "\nSUNDIALS_ERROR(%d): %s() failed - returned NULL pointer\n\n", id, funcname);
return(1); }
/* Check if flag < 0 */
else if (opt == 1) {
errflag = (int *) flagvalue;
if (*errflag < 0) {
fprintf(stderr, "\nSUNDIALS_ERROR(%d): %s() failed with flag = %d\n\n", id, funcname, *errflag);
return(1); }}
/* Check if function returned NULL pointer - no memory allocated */
else if (opt == 2 && flagvalue == NULL) {
fprintf(stderr, "\nMEMORY_ERROR(%d): %s() failed - returned NULL pointer\n\n", id, funcname);
return(1); }
return(0);
}
|