/usr/include/XdmfHDF5WriterDSM.hpp is in libxdmf-dev 3.0+git20160803-4.
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 | /*****************************************************************************/
/* XDMF */
/* eXtensible Data Model and Format */
/* */
/* Id : XdmfHDF5WriterDSM.hpp */
/* */
/* Author: */
/* Kenneth Leiter */
/* kenneth.leiter@arl.army.mil */
/* US Army Research Laboratory */
/* Aberdeen Proving Ground, MD */
/* */
/* Copyright @ 2011 US Army Research Laboratory */
/* All Rights Reserved */
/* See Copyright.txt for details */
/* */
/* This software is distributed WITHOUT ANY WARRANTY; without */
/* even the implied warranty of MERCHANTABILITY or FITNESS */
/* FOR A PARTICULAR PURPOSE. See the above copyright notice */
/* for more information. */
/* */
/*****************************************************************************/
#ifndef XDMFHDF5WRITERDSM_HPP_
#define XDMFHDF5WRITERDSM_HPP_
// C Compatible Includes
#include <XdmfHDF5Writer.hpp>
#include <XdmfDSMBuffer.hpp>
#include <XdmfDSMCommMPI.hpp>
#ifdef __cplusplus
// Forward Declarations
class XdmfDSMBuffer;
// Includes
/**
* @brief Traverse the Xdmf graph and write heavy data stored in
* XdmfArrays to a DSM buffer.
*
* XdmfHDF5WriterDSM traverses an Xdmf graph structure and writes data
* stored in XdmfArrays to a DSM buffer. Writing begins by calling the
* accept() operation on any XdmfItem and supplying this writer as the
* parameter. The writer will write all XdmfArrays under the XdmfItem
* to a DSM Buffer. It will also attach an XdmfHDF5ControllerDSM to
* all XdmfArrays.
*
* This writer supports all heavy data writing modes listed in
* XdmfHeavyDataWriter.
*/
class XDMFDSM_EXPORT XdmfHDF5WriterDSM : public XdmfHDF5Writer {
public:
friend class XdmfDSMBuffer;
/**
* Contruct XdmfHDF5WriterDSM, nonthreaded version
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfDSMNoThread.cpp
* @skipline //#initMPI
* @until //#initMPI
* @skipline //#initwritevector
* @until //#initwritevector
* @skipline //#initwritergenerate
* @until //#initwritergenerate
* @skipline //#startworksection
* @until //#startworksection
* @skipline //#initwriterwithbuffer
* @until //#initwriterwithbuffer
* @skipline //#endworksection
* @until //#endworksection
* @skipline //#stopDSMwriter
* @until //#stopDSMwriter
* @skipline //#finalizeMPI
* @until //#finalizeMPI
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline #//initMPI
* @until #//initMPI
* @skipline #//initwritevector
* @until #//initwritevector
* @skipline #//initwritergenerate
* @until #//initwritergenerate
* @skipline #//startworksection
* @until #//startworksection
* @skipline #//initwriterwithbuffer
* @until #//initwriterwithbuffer
* @skipline #//stopDSMwriter
* @until #//stopDSMwriter
* @skipline #//finalizeMPI
* @until #//finalizeMPI
*
* @param filePath The location of the hdf5 file to output to on disk.
* @param dsmBuffer The Buffer to write to.
* @return A New XdmfHDF5WriterDSM
*/
static shared_ptr<XdmfHDF5WriterDSM>
New(const std::string & filePath,
XdmfDSMBuffer * const dsmBuffer);
/**
* Contruct XdmfHDF5WriterDSM, nonthreaded version
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfDSMNoThread.cpp
* @skipline //#initMPI
* @until //#initMPI
* @skipline //#initwritevector
* @until //#initwritevector
* @skipline //#initwritergenerate
* @until //#initwritergenerate
* @skipline //#stopDSMwriter
* @until //#stopDSMwriter
* @skipline //#finalizeMPI
* @until //#finalizeMPI
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline #//initMPI
* @until #//initMPI
* @skipline #//initwritevector
* @until #//initwritevector
* @skipline #//initwritergenerate
* @until #//initwritergenerate
* @skipline #//stopDSMwriter
* @until #//stopDSMwriter
* @skipline #//finalizeMPI
* @until #//finalizeMPI
*
* @param filePath The location of the hdf5 file to output to on disk.
* @param comm The communicator that the buffer will be created in.
* @param bufferSize The size of the created buffer.
* @param startCoreIndex The index of the first core in the server block
* @param endCoreIndex The index of the last core in the server block
* @param applicationName The name in the process description for this process
* @return A New XdmfHDF5WriterDSM
*/
static shared_ptr<XdmfHDF5WriterDSM>
New(const std::string & filePath,
MPI_Comm comm,
unsigned int bufferSize,
int startCoreIndex,
int endCoreIndex,
std::string applicationName = "Application");
/**
* Contruct XdmfHDF5WriterDSM, nonthreaded version
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfDSMNoThread.cpp
* @skipline //#initMPI
* @until //#initMPI
* @skipline //#initwritevector
* @until //#initwritevector
* @skipline //#initwriterpagedgenerate
* @until //#initwriterpagedgenerate
* @skipline //#stopDSMwriter
* @until //#stopDSMwriter
* @skipline //#finalizeMPI
* @until //#finalizeMPI
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline #//initMPI
* @until #//initMPI
* @skipline #//initwritevector
* @until #//initwritevector
* @skipline #//initwriterpagedgenerate
* @until #//initwriterpagedgenerate
* @skipline #//stopDSMwriter
* @until #//stopDSMwriter
* @skipline #//finalizeMPI
* @until #//finalizeMPI
*
* @param filePath The location of the hdf5 file to output to on disk.
* @param comm The communicator that the buffer will be created in.
* @param bufferSize The size of the created buffer.
* @param blockSize The size of the pages in the buffer.
* @param resizeFactor The size of by which the buffer gets resized when
* requesting beyond the size.
* @param startCoreIndex The index of the first core in the server block
* @param endCoreIndex The index of the last core in the server block
* @param applicationName The name in the process description for this process
* @return A New XdmfHDF5WriterDSM
*/
static shared_ptr<XdmfHDF5WriterDSM>
New(const std::string & filePath,
MPI_Comm comm,
unsigned int bufferSize,
unsigned int blockSize,
double resizeFactor,
int startCoreIndex,
int endCoreIndex,
std::string applicationName = "Application");
/**
* Contruct XdmfHDF5WriterDSM, nonthreaded version. Does not start up a buffer
* and must be connected to a DSMBuffer to function.
*
* Example of use:
*
* C++
*
* @dontinclude XdmfConnectTest2.cpp
* @skipline //#initDSMWriterConnectRequired
* @until //#initDSMWriterConnectRequired
*
* Python
*
* @dontinclude XdmfExampleConnectTest2.py
* @skipline #//initDSMWriterConnectRequired
* @until #//initDSMWriterConnectRequired
*
* @param filePath The location of the hdf5 file to output to on disk.
* @param comm The local communicator.
*/
static shared_ptr<XdmfHDF5WriterDSM>
New(const std::string & filePath,
MPI_Comm comm,
std::string applicationName = "Application");
virtual ~XdmfHDF5WriterDSM();
void closeFile();
/**
* Gets the number of values contained in the specified dataset.
*
* @param fileName The filename of the dataset to get the size of.
* @param dataSetName The dataset name of the dataset to get the size of.
* @return The size of the dataset queried.
*/
virtual int getDataSetSize(const std::string & fileName, const std::string & dataSetName);
/**
* Get if each write to dsm will send a notification to the accociated file name.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfDSMNoThread.cpp
* @skipline //#initMPI
* @until //#initMPI
* @skipline //#initwritevector
* @until //#initwritevector
* @skipline //#initwritergenerate
* @until //#initwritergenerate
* @skipline //#startworksection
* @until //#startworksection
* @skipline //#getNotifyOnWrite
* @until //#getNotifyOnWrite
* @skipline //#endworksection
* @until //#endworksection
* @skipline //#stopDSMwriter
* @until //#stopDSMwriter
* @skipline //#finalizeMPI
* @until //#finalizeMPI
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline #//initMPI
* @until #//initMPI
* @skipline #//initwritevector
* @until #//initwritevector
* @skipline #//initwritergenerate
* @until #//initwritergenerate
* @skipline #//startworksection
* @until #//startworksection
* @skipline #//getNotifyOnWrite
* @until #//getNotifyOnWrite
* @skipline #//stopDSMwriter
* @until #//stopDSMwriter
* @skipline #//finalizeMPI
* @until #//finalizeMPI
*
* @return Whether a notification will be sent
*/
bool getNotifyOnWrite();
/**
* Gets the buffer for the non-threaded version of DSM
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfDSMNoThread.cpp
* @skipline //#initMPI
* @until //#initMPI
* @skipline //#initwritevector
* @until //#initwritevector
* @skipline //#initwritergenerate
* @until //#initwritergenerate
* @skipline //#startworksection
* @until //#startworksection
* @skipline //#declarebuffer
* @until //#declarebuffer
* @skipline //#getServerBufferwriter
* @until //#getServerBufferwriter
* @skipline //#endworksection
* @until //#endworksection
* @skipline //#stopDSMwriter
* @until //#stopDSMwriter
* @skipline //#finalizeMPI
* @until //#finalizeMPI
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline #//initMPI
* @until #//initMPI
* @skipline #//initwritevector
* @until #//initwritevector
* @skipline #//initwritergenerate
* @until #//initwritergenerate
* @skipline #//startworksection
* @until #//startworksection
* @skipline #//getServerBufferwriter
* @until #//getServerBufferwriter
* @skipline #//stopDSMwriter
* @until #//stopDSMwriter
* @skipline #//finalizeMPI
* @until #//finalizeMPI
*
* @return The XdmfDSMBuffer that is controlling the data for the DSM
*/
XdmfDSMBuffer * getServerBuffer();
/**
* Checks if the DSM is in server mode or not.
* True is server mode, false is threaded
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfDSMNoThread.cpp
* @skipline //#initMPI
* @until //#initMPI
* @skipline //#initwritevector
* @until //#initwritevector
* @skipline //#initwritergenerate
* @until //#initwritergenerate
* @skipline //#startworksection
* @until //#startworksection
* @skipline //#getServerModewriter
* @until //#getServerModewriter
* @skipline //#endworksection
* @until //#endworksection
* @skipline //#stopDSMwriter
* @until //#stopDSMwriter
* @skipline //#finalizeMPI
* @until //#finalizeMPI
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline #//initMPI
* @until #//initMPI
* @skipline #//initwritevector
* @until #//initwritevector
* @skipline #//initwritergenerate
* @until #//initwritergenerate
* @skipline #//startworksection
* @until #//startworksection
* @skipline #//getServerModewriter
* @until #//getServerModewriter
* @skipline #//stopDSMwriter
* @until #//stopDSMwriter
* @skipline #//finalizeMPI
* @until #//finalizeMPI
*
* @return If the DSM is in server mode or not
*/
bool getServerMode();
/**
* Gets the Communicator that the workers are using to communicate between themselves
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfDSMNoThread.cpp
* @skipline //#initMPI
* @until //#initMPI
* @skipline //#initwritevector
* @until //#initwritevector
* @skipline //#initwritergenerate
* @until //#initwritergenerate
* @skipline //#startworksection
* @until //#startworksection
* @skipline //#getWorkerCommwriter
* @until //#getWorkerCommwriter
* @skipline //#endworksection
* @until //#endworksection
* @skipline //#stopDSMwriter
* @until //#stopDSMwriter
* @skipline //#finalizeMPI
* @until //#finalizeMPI
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline #//initMPI
* @until #//initMPI
* @skipline #//initwritevector
* @until #//initwritevector
* @skipline #//initwritergenerate
* @until #//initwritergenerate
* @skipline #//startworksection
* @until #//startworksection
* @skipline #//getWorkerCommwriter
* @until #//getWorkerCommwriter
* @skipline #//stopDSMwriter
* @until #//stopDSMwriter
* @skipline #//finalizeMPI
* @until #//finalizeMPI
*
* @return The comm that the workers are using.
*/
MPI_Comm getWorkerComm();
/**
* Sets whether to allow the HDF5 writer to split data sets when writing to hdf5.
* Splitting should only occur for massive data sets.
* Setting to false assures compatibility with previous editions.
* Default setting is false
* In DSM this function has no effect because splitting would prevent the algorithm from working
*
* @param newAllow Whether to allow data sets to be split across hdf5 files.
*/
void setAllowSetSplitting(bool newAllow);
/**
* Sets the Writer's dsmBuffer to the provided buffer
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfDSMNoThread.cpp
* @skipline //#initMPI
* @until //#initMPI
* @skipline //#initwritevector
* @until //#initwritevector
* @skipline //#initwritergenerate
* @until //#initwritergenerate
* @skipline //#startworksection
* @until //#startworksection
* @skipline //#declarebuffer
* @until //#declarebuffer
* @skipline //#getServerBufferwriter
* @until //#getServerBufferwriter
* @skipline //#setBufferwriter
* @until //#setBufferwriter
* @skipline //#endworksection
* @until //#endworksection
* @skipline //#stopDSMwriter
* @until //#stopDSMwriter
* @skipline //#finalizeMPI
* @until //#finalizeMPI
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline #//initMPI
* @until #//initMPI
* @skipline #//initwritevector
* @until #//initwritevector
* @skipline #//initwritergenerate
* @until #//initwritergenerate
* @skipline #//startworksection
* @until #//startworksection
* @skipline #//getServerBufferwriter
* @until #//getServerBufferwriter
* @skipline #//setBufferwriter
* @until #//setBufferwriter
* @skipline #//stopDSMwriter
* @until #//stopDSMwriter
* @skipline #//finalizeMPI
* @until #//finalizeMPI
*
* @param newBuffer A pointer to the buffer to be set
*/
void setBuffer(XdmfDSMBuffer * newBuffer);
/**
* Used to switch between server and threaded mode.
* True is server mode, false is threaded mode.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfDSMNoThread.cpp
* @skipline //#initMPI
* @until //#initMPI
* @skipline //#initwritevector
* @until //#initwritevector
* @skipline //#initwritergenerate
* @until //#initwritergenerate
* @skipline //#startworksection
* @until //#startworksection
* @skipline //#setServerModewriter
* @until //#setServerModewriter
* @skipline //#endworksection
* @until //#endworksection
* @skipline //#stopDSMwriter
* @until //#stopDSMwriter
* @skipline //#finalizeMPI
* @until //#finalizeMPI
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline #//initMPI
* @until #//initMPI
* @skipline #//initwritevector
* @until #//initwritevector
* @skipline #//initwritergenerate
* @until #//initwritergenerate
* @skipline #//startworksection
* @until #//startworksection
* @skipline #//setServerModewriter
* @until #//setServerModewriter
* @skipline #//stopDSMwriter
* @until #//stopDSMwriter
* @skipline #//finalizeMPI
* @until #//finalizeMPI
*
* @param newMode The mode that the writer is to be set to.
*/
void setServerMode(bool newMode);
/**
* If true each write to dsm will send a notification to the accociated file name.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfDSMNoThread.cpp
* @skipline //#initMPI
* @until //#initMPI
* @skipline //#initwritevector
* @until //#initwritevector
* @skipline //#initwritergenerate
* @until //#initwritergenerate
* @skipline //#startworksection
* @until //#startworksection
* @skipline //#setNotifyOnWrite
* @until //#setNotifyOnWrite
* @skipline //#endworksection
* @until //#endworksection
* @skipline //#stopDSMwriter
* @until //#stopDSMwriter
* @skipline //#finalizeMPI
* @until //#finalizeMPI
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline #//initMPI
* @until #//initMPI
* @skipline #//initwritevector
* @until #//initwritevector
* @skipline #//initwritergenerate
* @until #//initwritergenerate
* @skipline #//startworksection
* @until #//startworksection
* @skipline #//setNotifyOnWrite
* @until #//setNotifyOnWrite
* @skipline #//stopDSMwriter
* @until #//stopDSMwriter
* @skipline #//finalizeMPI
* @until #//finalizeMPI
*
* @param status Whether to send a notification
*/
void setNotifyOnWrite(bool status);
/**
* Sets the comm that the workers will use to communicate with other worker cores
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfDSMNoThread.cpp
* @skipline //#initMPI
* @until //#initMPI
* @skipline //#initwritevector
* @until //#initwritevector
* @skipline //#initwritergenerate
* @until //#initwritergenerate
* @skipline //#startworksection
* @until //#startworksection
* @skipline //#getWorkerCommwriter
* @until //#getWorkerCommwriter
* @skipline //#setWorkerCommwriter
* @until //#setWorkerCommwriter
* @skipline //#endworksection
* @until //#endworksection
* @skipline //#stopDSMwriter
* @until //#stopDSMwriter
* @skipline //#finalizeMPI
* @until //#finalizeMPI
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline #//initMPI
* @until #//initMPI
* @skipline #//initwritevector
* @until #//initwritevector
* @skipline #//initwritergenerate
* @until #//initwritergenerate
* @skipline #//startworksection
* @until #//startworksection
* @skipline #//getWorkerCommwriter
* @until #//getWorkerCommwriter
* @skipline #//setWorkerCommwriter
* @until #//setWorkerCommwriter
* @skipline #//stopDSMwriter
* @until #//stopDSMwriter
* @skipline #//finalizeMPI
* @until #//finalizeMPI
*
* @param comm The communicator that the worker will be using to communicate with the other worker cores.
*/
void setWorkerComm(MPI_Comm comm);
/**
* Sends a stop command to all the server cores that the writer is connected to, ending the DSM.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfDSMNoThread.cpp
* @skipline //#initMPI
* @until //#initMPI
* @skipline //#initwritevector
* @until //#initwritevector
* @skipline //#initwritergenerate
* @until //#initwritergenerate
* @skipline //#stopDSMwriter
* @until //#stopDSMwriter
* @skipline //#finalizeMPI
* @until //#finalizeMPI
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline #//initMPI
* @until #//initMPI
* @skipline #//initwritevector
* @until #//initwritevector
* @skipline #//initwritergenerate
* @until #//initwritergenerate
* @skipline #//stopDSMwriter
* @until #//stopDSMwriter
* @skipline #//finalizeMPI
* @until #//finalizeMPI
*/
void stopDSM();
/**
* Restarts the DSM when called on server cores.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfDSMNoThread.cpp
* @skipline //#initMPI
* @until //#initMPI
* @skipline //#initwritevector
* @until //#initwritevector
* @skipline //#initwritergenerate
* @until //#initwritergenerate
* @skipline //#stopDSMwriter
* @until //#stopDSMwriter
* @skipline //#finalizeMPI
* @until //#finalizeMPI
* @skipline //#restartDSMwriter
* @until //#restartDSMwriter
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline #//initMPI
* @until #//initMPI
* @skipline #//initwritevector
* @until #//initwritevector
* @skipline #//initwritergenerate
* @until #//initwritergenerate
* @skipline #//stopDSMwriter
* @until #//stopDSMwriter
* @skipline #//restartDSMwriter
* @until #//restartDSMwriter
* @skipline #//finalizeMPI
* @until #//finalizeMPI
*/
void restartDSM();
void openFile();
using XdmfHeavyDataWriter::visit;
void visit(XdmfArray & array,
const shared_ptr<XdmfBaseVisitor> visitor);
/**
* Releases all processes waiting on a specified dataset. Sends those processes a specified code.
*
* Example of use:
*
* C++
*
* @dontinclude XdmfConnectTest2.cpp
* @skipline //#initDSMWriterConnectRequired
* @until //#initDSMWriterConnectRequired
* @skipline //#notify
* @until //#notify
*
* Python
*
* @dontinclude XdmfExampleConnectTest2.py
* @skipline #//initDSMWriterConnectRequired
* @until #//initDSMWriterConnectRequired
* @skipline #//notify
* @until #//notify
*
* @param fileName The filename of the dataset to wait on.
* @param datasetName The dataset name of the dataset to wait on.
* @param code The code to be transmitted to waiting processes.
*/
void waitRelease(std::string fileName, std::string datasetName, int code = 0);
/**
* Blocks until released by the a waitRelease on the corresponding dataset.
*
* Example of use:
*
* C++
*
* @dontinclude XdmfConnectTest2.cpp
* @skipline //#initDSMWriterConnectRequired
* @until //#initDSMWriterConnectRequired
* @skipline //#notify
* @until //#notify
*
* Python
*
* @dontinclude XdmfExampleConnectTest2.py
* @skipline #//initDSMWriterConnectRequired
* @until #//initDSMWriterConnectRequired
* @skipline #//notify
* @until #//notify
*
* @param fileName The filename of the dataset to wait on.
* @param datasetName The dataset name of the dataset to wait on.
* @return The code send from the release.
*/
int waitOn(std::string fileName, std::string datasetName);
XdmfHDF5WriterDSM(XdmfHDF5WriterDSM &);
protected:
XdmfHDF5WriterDSM(const std::string & filePath,
XdmfDSMBuffer * const dsmBuffer);
XdmfHDF5WriterDSM(const std::string & filePath,
MPI_Comm comm,
unsigned int bufferSize,
int startCoreIndex,
int endCoreIndex,
std::string applicationName);
XdmfHDF5WriterDSM(const std::string & filePath,
MPI_Comm comm,
unsigned int bufferSize,
unsigned int blockSize,
double resizeFactor,
int startCoreIndex,
int endCoreIndex,
std::string applicationName);
XdmfHDF5WriterDSM(const std::string & filePath,
MPI_Comm comm,
std::string applicationName);
virtual shared_ptr<XdmfHeavyDataController>
createController(const std::string & hdf5FilePath,
const std::string & descriptor,
const shared_ptr<const XdmfArrayType> type,
const std::vector<unsigned int> & start,
const std::vector<unsigned int> & stride,
const std::vector<unsigned int> & dimensions,
const std::vector<unsigned int> & dataspaceDimensions);
/**
* PIMPL
*/
class XdmfHDF5WriterDSMImpl : public XdmfHDF5WriterImpl
{
public:
XdmfHDF5WriterDSMImpl();
virtual ~XdmfHDF5WriterDSMImpl();
virtual int
openFile(const std::string & filePath,
const int mDataSetId);
void
closeFile();
bool mDSMIsInit;
bool mDSMLocked;
};
private:
XdmfHDF5WriterDSM(const XdmfHDF5WriterDSM &); // Not implemented.
void operator=(const XdmfHDF5WriterDSM &); // Not implemented.
XdmfDSMBuffer * mDSMServerBuffer;
MPI_Comm mWorkerComm;
bool mServerMode;
bool mNotifyOnWrite;
};
#endif
#ifdef __cplusplus
extern "C" {
#endif
// C wrappers go here
struct XDMFHDF5WRITERDSM; // Simply as a typedef to ensure correct typing
typedef struct XDMFHDF5WRITERDSM XDMFHDF5WRITERDSM;
XDMFDSM_EXPORT XDMFHDF5WRITERDSM * XdmfHDF5WriterDSMNewFromServerBuffer(char * filePath,
void * dsmBuffer,
int * status);
XDMFDSM_EXPORT XDMFHDF5WRITERDSM * XdmfHDF5WriterDSMNew(char * filePath,
MPI_Comm comm,
unsigned int bufferSize,
int startCoreIndex,
int endCoreIndex,
char * applicationName,
int * status);
XDMFDSM_EXPORT XDMFHDF5WRITERDSM * XdmfHDF5WriterDSMNewPaged(char * filePath,
MPI_Comm comm,
unsigned int bufferSize,
unsigned int blockSize,
double resizeFactor,
int startCoreIndex,
int endCoreIndex,
char * applicationName,
int * status);
XDMFDSM_EXPORT XDMFHDF5WRITERDSM * XdmfHDF5WriterDSMNewConnectRequired(char * filePath,
MPI_Comm comm,
char * applicationName,
int * status);
XDMFDSM_EXPORT int XdmfHDF5WriterDSMGetDataSetSize(XDMFHDF5WRITERDSM * writer, char * fileName, char * dataSetName);
XDMFDSM_EXPORT XDMFDSMBUFFER * XdmfHDF5WriterDSMGetServerBuffer(XDMFHDF5WRITERDSM * writer);
XDMFDSM_EXPORT int XdmfHDF5WriterDSMGetServerMode(XDMFHDF5WRITERDSM * writer);
XDMFDSM_EXPORT MPI_Comm XdmfHDF5WriterDSMGetWorkerComm(XDMFHDF5WRITERDSM * writer);
XDMFDSM_EXPORT void XdmfHDF5WriterDSMSetServerBuffer(XDMFHDF5WRITERDSM * writer, XDMFDSMBUFFER * newBuffer);
XDMFDSM_EXPORT void XdmfHDF5WriterDSMSetServerMode(XDMFHDF5WRITERDSM * writer, int newMode);
XDMFDSM_EXPORT void XdmfHDF5WriterDSMSetWorkerComm(XDMFHDF5WRITERDSM * writer, MPI_Comm comm, int * status);
XDMFDSM_EXPORT void XdmfHDF5WriterDSMStopDSM(XDMFHDF5WRITERDSM * writer, int * status);
XDMFDSM_EXPORT void XdmfHDF5WriterDSMRestartDSM(XDMFHDF5WRITERDSM * writer, int * status);
XDMFDSM_EXPORT void XdmfHDF5WriterDSMWaitRelease(XDMFHDF5WRITERDSM * writer, char * fileName, char * datasetName, int code);
XDMFDSM_EXPORT int XdmfHDF5WriterDSMWaitOn(XDMFHDF5WRITERDSM * writer, char * fileName, char * datasetName);
XDMF_HDF5WRITER_C_CHILD_DECLARE(XdmfHDF5WriterDSM, XDMFHDF5WRITERDSM, XDMFDSM)
XDMF_HEAVYWRITER_C_CHILD_DECLARE(XdmfHDF5WriterDSM, XDMFHDF5WRITERDSM, XDMFDSM)
#ifdef __cplusplus
}
#endif
#endif /* XDMFHDF5WRITERDSM_HPP_ */
|