├── .gitmodules ├── COPYING ├── COPYING.LESSER ├── Clover3D_alpha.png ├── Clover3D_alpha_small.png ├── Clover_alpha.png ├── Clover_alpha_small.png ├── Makefile ├── README.md └── documentation.txt /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "CloverLeaf_ref"] 2 | path = CloverLeaf_ref 3 | url = https://github.com/UK-MAC/CloverLeaf_ref.git 4 | [submodule "CloverLeaf_CUDA"] 5 | path = CloverLeaf_CUDA 6 | url = https://github.com/UK-MAC/CloverLeaf_CUDA.git 7 | [submodule "CloverLeaf_Offload"] 8 | path = CloverLeaf_Offload 9 | url = https://github.com/UK-MAC/CloverLeaf_Offload.git 10 | [submodule "CloverLeaf_Serial"] 11 | path = CloverLeaf_Serial 12 | url = https://github.com/UK-MAC/CloverLeaf_Serial.git 13 | [submodule "CloverLeaf_OpenMP"] 14 | path = CloverLeaf_OpenMP 15 | url = https://github.com/UK-MAC/CloverLeaf_OpenMP.git 16 | [submodule "CloverLeaf_MPI"] 17 | path = CloverLeaf_MPI 18 | url = https://github.com/UK-MAC/CloverLeaf_MPI.git 19 | [submodule "CloverLeaf_OpenMP4"] 20 | path = CloverLeaf_OpenMP4 21 | url = https://github.com/UK-MAC/CloverLeaf_OpenMP4.git 22 | [submodule "CloverLeaf_OpenACC"] 23 | path = CloverLeaf_OpenACC 24 | url = https://github.com/UK-MAC/CloverLeaf_OpenACC.git 25 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /COPYING.LESSER: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | 167 | -------------------------------------------------------------------------------- /Clover3D_alpha.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/UK-MAC/CloverLeaf/5ab5ec90a4f0f099115b7054992ace889209a7b3/Clover3D_alpha.png -------------------------------------------------------------------------------- /Clover3D_alpha_small.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/UK-MAC/CloverLeaf/5ab5ec90a4f0f099115b7054992ace889209a7b3/Clover3D_alpha_small.png -------------------------------------------------------------------------------- /Clover_alpha.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/UK-MAC/CloverLeaf/5ab5ec90a4f0f099115b7054992ace889209a7b3/Clover_alpha.png -------------------------------------------------------------------------------- /Clover_alpha_small.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/UK-MAC/CloverLeaf/5ab5ec90a4f0f099115b7054992ace889209a7b3/Clover_alpha_small.png -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | PACKAGE=CloverLeaf 2 | 3 | help: 4 | @echo " CloverLeaf, a Lagrangian-Eulerian hydrodynamics mini-application " 5 | @echo " " 6 | @echo " CloverLeaf comes in the following principal flavours: " 7 | @echo " " 8 | @echo " - Ref " 9 | @echo " This is the reference MPI/OpenMP implementation. " 10 | @echo " - Serial " 11 | @echo " This is the serial implementation. " 12 | @echo " - MPI " 13 | @echo " This is the parallel MPI implementation. " 14 | @echo " - OpenMP " 15 | @echo " This version is threaded using MPI directives. " 16 | @echo " - OpenACC_KERNELS " 17 | @echo " This version uses OpenACC directives to utilise GPU " 18 | @echo " hardware. " 19 | @echo " - OpenACC_LOOPS " 20 | @echo " This version uses OpenACC directives to utilise GPU " 21 | @echo " hardware. " 22 | @echo " - OpenACC_CRAY " 23 | @echo " This version uses OpenACC directives to utilise GPU " 24 | @echo " hardware. " 25 | @echo " - Offload " 26 | @echo " - CUDA " 27 | @echo " - OpenMP 4 " 28 | @echo " " 29 | @echo " Build a particular version by typing: " 30 | @echo " \`make \` " 31 | @echo " where is the name of the version you want to make, all " 32 | @echo " in lowercase. " 33 | @echo " " 34 | @echo " Please use the COMPILER environment variable to specify the " 35 | @echo " compiler you wish to use. Supported compilers are: " 36 | @echo " - GNU " 37 | @echo " - CRAY " 38 | @echo " - INTEL " 39 | @echo " - PATHSCALE " 40 | @echo " - PGI " 41 | @echo " - SUN " 42 | @echo " - XLF " 43 | 44 | all: ref openmp mpi openacc_cray openacc_kernels openacc_loops cuda openmp4 serial offload 45 | 46 | ref: 47 | cd $(PACKAGE)_ref; make 48 | 49 | serial: 50 | cd $(PACKAGE)_Serial; make 51 | 52 | openmp: 53 | cd $(PACKAGE)_OpenMP; make 54 | 55 | mpi: 56 | cd $(PACKAGE)_MPI; make 57 | 58 | openmp4: 59 | cd $(PACKAGE)_OpenMP4; make 60 | 61 | openacc_cray: 62 | cd $(PACKAGE)_OpenACC_CRAY; make 63 | 64 | openacc_kernels: 65 | cd $(PACKAGE)_OpenACC_KERNELS; make 66 | 67 | openacc_loops: 68 | cd $(PACKAGE)_OpenACC_LOOPS; make 69 | 70 | cuda: 71 | cd $(PACKAGE)_CUDA; make 72 | 73 | offload: 74 | cd $(PACKAGE)_Offload; make 75 | 76 | clean: 77 | cd $(PACKAGE)_ref; make clean 78 | cd $(PACKAGE)_Serial; make clean 79 | cd $(PACKAGE)_OpenMP; make clean 80 | cd $(PACKAGE)_MPI; make clean 81 | cd $(PACKAGE)_OpenMP4; make clean 82 | cd $(PACKAGE)_OpenACC_CRAY; make clean 83 | cd $(PACKAGE)_OpenACC_KERNELS; make clean 84 | cd $(PACKAGE)_OpenACC_LOOPS; make clean 85 | cd $(PACKAGE)_CUDA; make clean 86 | cd $(PACKAGE)_Offload; make clean 87 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # CloverLeaf Compilation and Usage ![image](Clover_alpha_small.png "CloverLeaf") 2 | 3 | ## CloverLeaf Directory Structure 4 | 5 | Below the top level Leaf directory there is a directory called CloverLeaf. The 6 | sub directories in this directory contain the various implementation of the 7 | code. 8 | 9 | * Serial - contains a serial version with no MPI or OpenMP 10 | * OpenMP - contains an OpenMP version only with no MPI 11 | * MPI - contains an MPI only implementation 12 | * OpenACC - contains an OpenACC/MPI implementation that works under the Cray compiler 13 | * HMPP- contains another OpenACC/MPI implementation that works with the CAPS and Cray compiler 14 | * Offload - contains an Intel Offload/MPI implementation 15 | * CUDA - contains the CUDA/MPI implementation 16 | * Ref - contains a hybrid OpenMP/MPI implemention. The Serial, OpenMP and MPI 17 | versions are extracted from this version so should not diverge from it apart 18 | from the removal of the relevant software models. 19 | 20 | ## CloverLeaf Build Procedure 21 | 22 | Dependencies in CloverLeaf have been kept to a minimum to ease the build 23 | process across multiple platforms and environments. There is a single makefile 24 | for all compilers and adding a new compiler should be straight forward. 25 | 26 | In many case just typing `make` in the required software directory will work. 27 | This is the case if the mpif90 and mpicc wrappers are available on the system. 28 | This is true even for the Serial and OpenMP versions. 29 | 30 | If the MPI compilers have different names then the build process needs to 31 | notified of this by defining two environment variables, `MPI_COMPILER` and 32 | `C_MPI_COMPILER`. 33 | 34 | For example on some Intel systems: 35 | 36 | `make MPI_COMPILER=mpiifort C_MPI_COMPILER=mpiicc` 37 | 38 | Or on Cray systems: 39 | 40 | `make MPI_COMPILER=ftn C_MPI_COMPILER=cc` 41 | 42 | Bespoke builds for some specific architectures with non-default compiler locations / invocations can be found here. 43 | https://github.com/UK-MAC/CloverLeaf/wiki/Build-Notes 44 | 45 | ### OpenMP Build 46 | 47 | All compilers use different arguments to invoke OpenMP compilation. A simple 48 | call to make will invoke the compiler with -O3. This does not usually include 49 | OpenMP by default. To build for OpenMP for a specific compiler a further 50 | variable must be defined, `COMPILER` that will then select the correct option 51 | for OpenMP compilation. 52 | 53 | For example with the Intel compiler: 54 | 55 | `make COMPILER=INTEL` 56 | 57 | Which then append the -openmp to the build flags. 58 | 59 | Other supported compiler that will be recognised are:- 60 | 61 | * CRAY 62 | * SUN 63 | * GNU 64 | * XL 65 | * PATHSCALE 66 | * PGI 67 | 68 | The default flags for each of these is show below:- 69 | 70 | * INTEL: -O3 -ipo 71 | * SUN: -fast 72 | * GNU: -ipo 73 | * XL: -O5 74 | * PATHSCLE: -O3 75 | * PGI: -O3 -Minline 76 | * CRAY: -em _Note: that by default the Cray compiler with pick the optimum 77 | options for performance._ 78 | 79 | ### Other Flags 80 | 81 | The default compilation with the COMPILER flag set chooses the optimal 82 | performing set of flags for the specified compiler, but with no hardware 83 | specific options or IEEE compatability. 84 | 85 | To produce a version that has IEEE compatiblity a further flag has to be set on 86 | the compiler line. 87 | 88 | `make COMPILER=INTEL IEEE=1` 89 | 90 | This flag has no effect if the compiler flag is not set because IEEE options 91 | are always compiler specific. 92 | 93 | For each compiler the flags associated with IEEE are shown below:- 94 | 95 | * INTEL: -fp-model strict –fp-model source –prec-div –prec-sqrt 96 | * CRAY: -hpflex_mp=intolerant 97 | * SUN: -fsimple=0 –fns=no 98 | * GNU: -ffloat-store 99 | * PGI: -Kieee 100 | * PATHSCALE: -mieee-fp 101 | * XL: -qstrict –qfloat=nomaf 102 | 103 | Note that the MPI communications have been written to ensure bitwise identical 104 | answers independent of core count. However under some compilers this is not 105 | true unless the IEEE flags is set to be true. This is certainly true of the 106 | Intel and Cray compiler. Even with the IEEE options set, this is not guarantee 107 | that different compilers or platforms will produce the same answers. Indeed a 108 | Fortran run can give different answers from a C run with the same compiler, 109 | same options and same hardware. 110 | 111 | Extra options can be added without modifying the makefile by adding two further 112 | flags, `OPTIONS` and `C_OPTIONS`, one for the Fortran and one for the C options. 113 | 114 | `make COMPILER=INTEL OPTIONS=-xavx C_OPTIONS=-xavx` 115 | 116 | A build for a Xeon Phi would just need the -xavx option above replaced by -mmic. 117 | 118 | Finally, a `DEBUG` flag can be set to use debug options for a specific compiler. 119 | 120 | `make COMPILER=PGI DEBUG=1` 121 | 122 | These flags are also compiler specific, and so will depend on the `COMPILER` 123 | environment variable. 124 | 125 | So on a system without the standard MPI wrappers, for a build that requires 126 | OpenMP, IEEE and AVX this would look like so:- 127 | 128 | ``` 129 | make COMPILER=INTEL MPI_COMPILER=mpiifort C_MPI_COMPILER=mpiicc IEEE=1 \ 130 | OPTIONS="-xavx" C_OPTIONS="-xavx" 131 | ``` 132 | 133 | ### Vectorisation 134 | 135 | Fortran tends to vectorise without the use the specific pragmas due to the 136 | higher level definition of data compared to C. C almost always needs pragmas to 137 | ensure that the compiler knows loops are safe to vectorise. Unfortunately there 138 | is no common standard for vector pragmas across compiler vendors, though 139 | \#pragma ivdep works on many. This means that on some systems (e.g. IBM) the 140 | vector pragmas may need to be modified to attain peak performance of the C code. 141 | Care needs to be taken with forcing vectorisation because even loops without 142 | obviously data dependencies can calculate the wrong answers. 143 | 144 | ### OpenACC Build 145 | 146 | The makefile for this build does not differ from the Base version. In this case 147 | it is important to have the correct environment loaded on the system of use. 148 | On the Cray systems this will usually involve loading some NVIDIA and 149 | accelerator modules. Without these the code will still compile and run but the 150 | OpenACC pragmas wil be ignored and the calculation will take place on the CPU. 151 | 152 | ### HMPP Build 153 | 154 | The makefile for this build does not differ from the Base version. 155 | It is also important to have the correct environment loaded on the system of use. 156 | This will usually involve loading some NVIDIA and accelerator modules. Without 157 | these the code will still compile and run but the OpenACC pragmas wil be ignored 158 | and the calculation will take place on the CPU. To use the CAPS HMPP compiler for 159 | the OpenACC pragmas it is neccessary to modify the make line so that the MPI_COMPILER 160 | variable is pree-fixed with "hmpp" plus the addition of any system specific flags, say 161 | for example nvcc flags is the code is targetting a GPU. 162 | 163 | 164 | ### Co-Array Build 165 | 166 | A Co-Array Fortran build of CloverLeaf will be included in a future release, 167 | and is currently under production and testing. 168 | 169 | ### Shmem Build 170 | 171 | A Shmem build of CloverLeaf will be included in a future release, and is 172 | currently under production and testing. 173 | 174 | ### OpenCL Build 175 | 176 | An OpenCL build of CloverLeaf will be included in a future release, and is 177 | currently under production and testing. 178 | 179 | ### CUDA Build 180 | 181 | A CUDA build of CloverLeaf is now included in the repository, and has 182 | been tested on large GPU systems successfully. One extra command is required 183 | to compile to take account on the NVIDIA GPU being used. Set NV_ARCH=FERMI for 184 | M2090 cards and NV_ARCH=KEPLER for K20 cards. 185 | 186 | ## Running the Code 187 | 188 | CloverLeaf takes no command line arguments. It expects to find a file called 189 | `clover.in` in the directory it is running in. 190 | 191 | There are a number of input files that come with the code. To use any of these 192 | they simply need to be copied to `clover.in` in the run directory and 193 | CloverLeaf invoked. The invocation is system dependent. 194 | 195 | For example for a hybrid run: 196 | 197 | ``` 198 | export OMP_NUM_THREADS=4 199 | 200 | mpirun -np 8 clover_leaf 201 | ``` 202 | 203 | ### Weak and Strong Scaling 204 | 205 | Note that with strong scaling, as the task count increases for the same size 206 | global problem, the memory use of each task decreases. Eventually, the mesh 207 | data starts to fit into the various levels of cache. So even though the 208 | communications overhead is increasing, super-scalar leaps in performance can be 209 | seen as task count increases. Eventually all cache benefits are gained and the 210 | communications dominate. 211 | 212 | For weak scaling, memory use stays close to constant and these super-scalar 213 | increases aren't seen but the communications overhead stays constant relative 214 | to the computational overhead, and scaling remains good. 215 | 216 | ### Other Issues to Consider 217 | 218 | System libraries and settings can also have a significant effect on performance. 219 | 220 | The use of the `HugePage` library can make memory access more efficient. The 221 | implementation of this is very system specific and the details will not be 222 | expanded here. 223 | 224 | Variation in clock speed, such as `SpeedStep` or `Turbo Boost`, is also 225 | available on some hardware and care needs to be taken that the settings are 226 | known. 227 | 228 | Many systems also allow some level of hyperthreading at a core level. These 229 | usually share floating point units and for a code like CloverLeaf, which is 230 | floating point intensive and light on integer operations, are unlikely to 231 | produce a benefit and more likely to reduce performance. 232 | 233 | CloverLeaf is considered a memory bound code. Most data does not stay in cache 234 | very long before it is replaced. For this reason, memory speed can have a 235 | significant effect on performance. For the same reason, the same is true of 236 | hardware caches. 237 | 238 | ## Testing the Results 239 | 240 | Even though bitwise answers cannot be expected across systems, answers should be 241 | very close. A summary print of state variables is printed out by default every 242 | ten hydrodynamic steps and then at the end of the run. This print gives average 243 | value of the volume, mass, density, pressure, kinetic energy and internal 244 | energy. 245 | 246 | As all boundaries are reflective the volume, mass, density and total energy 247 | should remain constant, though the scheme is not exactly conservative in energy 248 | due to the nature of the staggered grid. Kinetic energy is usually the most 249 | sensitive state variable and this is most likely to show compiler/system 250 | differences. If mass and volume do not stay constant through a run, then 251 | something is seriously wrong. 252 | 253 | There is a very simple, small self test include in the CloverLeaf. If the code is 254 | invoked with no clover.in input file present, this test will be run and the answer tested 255 | against a "known" solution. Run time is much less than a second. This test is only for validation. 256 | It is far too small for any genuine benchmarking comparisons. 257 | 258 | There are four standard input files that are recommended for testing. 259 | Initially it is suggested than `clover_bm_short.in` is run. This is not a very 260 | sensitive test and the kinetic energy at the end of this run should be 0.1193E+01. 261 | It is quick to run, even on a single core, and should stop after 87 steps. If the 262 | keyword "test_problem 2" is included in the input, then it will self test against a known solution. 263 | Typical run time on a single core is about 20 seconds though this clearly depends on the hardware. 264 | Typical run time on a dual socket node is about 2.5 seconds. 265 | 266 | The second test to try is `clover_bm.in`. This runs for 2955 timesteps and is 267 | more sensitive than the first test. Through this simulation the whole 268 | computational mesh in traversed by a shock and so it is a good test of the 269 | parallel implementation because all internal boundaries will be crossed during 270 | the course of the simulation. The final kinetic energy should be 0.2590E+01. If the 271 | keyword "test_problem 3" is included in the input, then it will self test against a known solution. 272 | Typical run time on a single core is about 950 seconds. 273 | Typical run time on a dual socket node is about 100 seconds. 274 | 275 | The third test to try is `clover_bm16_short.in`. This is the "socket" test and 276 | has a much larger mesh size and therefore, memory footprint. The final kinetic 277 | energy should be 0.3075E+00. If the keyword "test_problem 4" is included in the input, 278 | then it will self test against a known solution. 279 | Typical run time on a single core is about 450 seconds. 280 | Typical run time on a single dual socket node is about 70 seconds. 281 | 282 | The last test to run for validation purposes is `clover_bm16.in`. This is a 283 | fairly long, large mesh run and the kinetic energy at the final time should be 284 | 0.4854E+01. If the keyword "test_problem 5" is included in the input, then it will self test against 285 | a known solution. 286 | Typical run time on a single core is about 14500 seconds. 287 | Typical run time on a single dual socket node is about 1700 seconds. 288 | 289 | A wide ranging set of performance figures can be found in the README for each version. 290 | -------------------------------------------------------------------------------- /documentation.txt: -------------------------------------------------------------------------------- 1 | # CloverLeaf Description 2 | 3 | ## The System of Equations and their Numerical Solution 4 | 5 | CloverLeaf is a mini-app that solves the compressible Euler equations on a 6 | Cartesian grid. Each cell stores three values: energy, density, and pressure. A 7 | velocity vector is stored at each cell corner. This arrangement of data, with 8 | some quantities at cell centres, and others at cell corners is known as a 9 | staggered grid. CloverLeaf currently solves the equations in two dimensions, but 10 | three dimensional support will be added in an upcoming release. 11 | 12 | The compressible Euler equations are a set of three partial differential 13 | equations that describe the conservation of energy, mass and momentum in a 14 | system. CloverLeaf produces a second-order accurate solution using explicit 15 | finite volume methods. It first performs a Lagrangian step, using a 16 | predictor-corrector scheme to advance the solution forward by a calculated time 17 | delta. This step causes the mesh to move with fluid velocity, so an advective 18 | remap is used in order to return the mesh to its original state. A second-order 19 | Van Leer scheme is used, with the advective sweep being performed in the x and y 20 | directions for the energy, mass and momentum. The initial sweep direction 21 | alternates between steps, providing second order accuracy. The flow direction 22 | mush be calculated during the remap to allow data from the "upwind" direction to 23 | be used. Although the deformation of the grid does not actually move cell vertices, the 24 | average velocity on a cell face is used to approximate a flux through each face 25 | for the advection of material. 26 | 27 | The compressible Euler equations form a hyperbolic system and therefore generate 28 | discontinuities in the form of shock waves. The second-order approximation will 29 | fail at these discontinuities (since the ...) and cause "ringing" in the 30 | solution. To avoid this, an artificial viscous pressure is used, which makes the 31 | solution first order in the presence of shock waves. This preserves monotonicity 32 | in the solution, by behaving as a simple addition to the pressure. 33 | 34 | The timestep control uses the maximum sound speed as an upper bound for the time 35 | delta. The timestep is thus limited to the time it would take for the the 36 | highest speed sound wave to cross a cell. The timestep is then multiplied by a 37 | safety factor to preserve the stability of the solution. The timestep control 38 | contains two further tests: one to ensure that a vertex can't overtake another 39 | as the mesh deforms, and one to ensure that a cell cannot deform such that it's 40 | volume becomes negative. 41 | 42 | In order to close the system of equations, we use an equation of state, which 43 | calculates the pressure and sound speed in a cell, given its energy and density. 44 | CloverLeaf uses the ideal gas equation of state with a gamma value of 1.4. 45 | 46 | Currently, CloverLeaf only solves for a single material, although multiple 47 | states (pressures, densities, and velocities) of this material can exist in the 48 | problem domain. Support for multiple materials will be added into a future 49 | release. 50 | 51 | ## The Implementation of the Algorithm 52 | 53 | The algorithm is straightforward to implement if a serial compute architecture 54 | is assumed. However, current and future architectures are not designed to be 55 | programmed is this fashion, and hence, CloverLeaf has been designed to perform 56 | well in a number of areas: memory accesses, data locality, compiler 57 | optimisations, threading, and vectorisation. 58 | 59 | The computation in CloverLeaf has been broken down into "kernels" -- low level 60 | building blocks with minimal complexity. Each kernels looks over the entire grid 61 | and updates one (or some) mesh variables, based on a kernel-dependent 62 | computational stencil. Control logic within each kernel is kept to the minimum 63 | possible level, allowing maximum optimisation by the compiler. Memory is 64 | sacrificed in order to increase performance, and any updates to variables that 65 | would introduce dependencies in the kernel are written into copies of the mesh. 66 | Each kernel is also written so that every cell can be updated independently of 67 | any other, allowing the kernels to be threaded or vectorised easily. 68 | 69 | 70 | ## Boundary Cells and Halo Exchange 71 | 72 | At the edge of the computational domain boundary conditions are used to close 73 | the solution. Extra "halo" cells around the mesh provide data for the 74 | computational stencil when required. These halo cells are not, and do not need 75 | to be, updated by the computational kernels. Data in the halo cells is filled in 76 | one of two ways: (1) at a boundary between processors, data is simply copied from 77 | the cells held by one processor, into the halo cells of the processor holding 78 | the adjoining portion of the mesh, and (2) at the edge of the computational 79 | domain, the cells are filled using a physical boundary condition. CloverLeaf 80 | currently only uses a reflective physical boundary condition. 81 | 82 | ## Implementations 83 | 84 | The underlying strategy behind the development of CloverLeaf was to keep the 85 | code base as simple as realistically possible, with low-level kernels perform 86 | the computational work without using many levels of function calls. The baseline 87 | version of the code has been written in such a way as to facilitate porting to 88 | any arbitrary language or architecture. Language and vendor specific extensions 89 | such as (Fortran BLAH or vector intrinsics) were avoided in case these would 90 | inhibit other implementations. 91 | 92 | 93 | ### Fortran and C 94 | 95 | Each of the compute kernels was initially written in both Fortran and C. The 96 | code is identical in all but syntax and both versions should produce the same 97 | output, although this can be compiler dependent. The C kernels form the 98 | platform for the development of the CUDA and OpenCL versions of the code, and 99 | the Fortran kernels form the basis of the OpenACC implementation. 100 | 101 | ### OpenMP 102 | 103 | The OpenMP implementation uses OpenMP pragmas to add loop-level parallelism at a 104 | kernel level, in both Fortran and C. The outer loop is distributed between 105 | threads, and the inner loop is vectorised where possible. Affinity is essential 106 | to ensure data locality, and this must be dealt with on a system-by-system 107 | basis. Task-based parallelism with OpenMP will be added in a future release. 108 | 109 | ### OpenACC 110 | 111 | The OpenMP implementation was taken as the basis for this version. The main 112 | differences are that the data needs to be transferred to an attached device, 113 | using extra pragmas, and the both the inner and outer loops are threaded. To 114 | achieve a boost in performance over the CPU host the algorithm needed to be 115 | fully resident on the attached accelerator and not used as a "co-processor". 116 | Data exchange only takes please when halo exchanges are required, a global 117 | reduction is needed (e.g. to find the minimum timestep when using multiple 118 | accelerators) or there is user request to output state data, for example for 119 | visualisation. 120 | 121 | Currently only the Fortran version is available as an OpenACC version, using 122 | the Cray Compiler. Other implementations of OpenACC are in an early stage of 123 | investigation and differences in the how the standard is interpreted make a 124 | single source version hard to produce at this moment in time. These are 125 | expected to converge as the standard and compilers mature. 126 | 127 | Without pragmas included, the OpenMP and kernels versions have identical source. 128 | 129 | ### OpenCL 130 | 131 | The OpenCL implmention is close to completion. It uses each loop in the C 132 | kernels as an OpenCL kernel. The mesh data and all computation is resident on 133 | the device as in the OpenACC version. The advantage of OpenCL is that it can be 134 | run equally easily on a CPU. The main difference to the C coding is the "boiler 135 | plate" coding required to transfer data to and from the device and share data 136 | between kernels. 137 | 138 | ### CUDA 139 | 140 | The CUDA uses the C kernels as the base in a similar fashion to the OpenCL. 141 | However the boiler plate code differs significantly. 142 | 143 | ### MPI 144 | 145 | CloverLeaf is distributed by partitioning the computational mesh into 146 | rectangular chunks. This decomposition attempts to minimise the surface area 147 | between computational chunks to minimise the communications overhead. 148 | Neighbouring chunks line up exactly. A halo two cells deep is added around the 149 | mesh to allow data from neighbouring mesh chunks to be made available. This 150 | data is updated during a call to the halo exchange, when requested data is sent 151 | via MPI buffers and inserted into halo cells. This halo exchange is required at 152 | a number of points during the computational cycle. During each exchange only 153 | the required data is communicated to the required depth to further reduce 154 | communications cost. 155 | 156 | Currently no further optimisations of the MPI code has been investigated. 157 | Multipe data fields are sent in separate messages and not packed into one 158 | message. Also, sends are posted before receives even though it is generally 159 | accepted that posting receives first is likely to be more efficient. 160 | 161 | There are alternative implementions to using the halo exchange using MPI. One is 162 | to use co-array Fortran which should allow overlap of computation and 163 | communication. The use of shmem should also allow similar overlap 164 | 165 | ### Heterogeneous Implementations 166 | 167 | With heterogeneous nodes containing a CPU and attached accelerator it is 168 | possible in theory to use all computational elements. Currently the only 169 | functioning heterogeneous method is when the hybrid MPI/OpenMP can be run on all 170 | elements. A tasked based OpenMP implementation should be able to add another 171 | method. OpenCL should also be able to all available devices, though issues such 172 | as load balance will become important when performance of compute elements 173 | differs significantly. 174 | 175 | ### Current Status 176 | 177 | The OpenMP implementation seems well optimised though it usually just lags the 178 | flat MPI version by a small amount on most systems. 179 | 180 | The code seems to vectorise all loops except for the upwind/downwind phase of 181 | the advection routines. A modified advection kernel will now vectorise but this 182 | usually performs worse than the scalar version due to increased floating point 183 | operations and loop logic. 184 | 185 | The OpenACC version fully threads in all kernels and scope for further 186 | optimisations seem limited after a detailed profiling of the code and the 187 | removal of bottle necks. 188 | 189 | Comparisons of the OpenCL and CUDA versions will be possible in the near future. 190 | 191 | Despite the unoptimised MPI coding, CloverLeaf weak scales very well to the 192 | order of 10,000 cores. The major test will be as this increases to 100,000 and 193 | then 1,000,000 cores. 194 | 195 | The ability of flat MPI to outperform hybrid codes still stands for this class 196 | of application. Whether this will change as core counts per node and node 197 | counts increase is one of the purposes of this mini-application. 198 | --------------------------------------------------------------------------------