[ { "path": ".gitignore", "content": "*.o\n*.dep\nlog_*\nlog.*\n*~\n\n" }, { "path": "COPYING", "content": "-------------------------------------------------------------------------\n\n GNU GENERAL PUBLIC LICENSE\n Version 3, 29 June 2007\n\n Copyright (C) 2007 Free Software Foundation, Inc. \n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n Preamble\n\n The GNU General Public License is a free, copyleft license for\nsoftware and other kinds of works.\n\n The licenses for most software and other practical works are designed\nto take away your freedom to share and change the works. By contrast,\nthe GNU General Public License is intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users. We, the Free Software Foundation, use the\nGNU General Public License for most of our software; it applies also to\nany other work released this way by its authors. You can apply it to\nyour programs, too.\n\n When we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.\n\n To protect your rights, we need to prevent others from denying you\nthese rights or asking you to surrender the rights. Therefore, you have\ncertain responsibilities if you distribute copies of the software, or if\nyou modify it: responsibilities to respect the freedom of others.\n\n For example, if you distribute copies of such a program, whether\ngratis or for a fee, you must pass on to the recipients the same\nfreedoms that you received. You must make sure that they, too, receive\nor can get the source code. And you must show them these terms so they\nknow their rights.\n\n Developers that use the GNU GPL protect your rights with two steps:\n(1) assert copyright on the software, and (2) offer you this License\ngiving you legal permission to copy, distribute and/or modify it.\n\n For the developers' and authors' protection, the GPL clearly explains\nthat there is no warranty for this free software. For both users' and\nauthors' sake, the GPL requires that modified versions be marked as\nchanged, so that their problems will not be attributed erroneously to\nauthors of previous versions.\n\n Some devices are designed to deny users access to install or run\nmodified versions of the software inside them, although the manufacturer\ncan do so. This is fundamentally incompatible with the aim of\nprotecting users' freedom to change the software. The systematic\npattern of such abuse occurs in the area of products for individuals to\nuse, which is precisely where it is most unacceptable. Therefore, we\nhave designed this version of the GPL to prohibit the practice for those\nproducts. If such problems arise substantially in other domains, we\nstand ready to extend this provision to those domains in future versions\nof the GPL, as needed to protect the freedom of users.\n\n Finally, every program is threatened constantly by software patents.\nStates should not allow patents to restrict development and use of\nsoftware on general-purpose computers, but in those that do, we wish to\navoid the special danger that patents applied to a free program could\nmake it effectively proprietary. To prevent this, the GPL assures that\npatents cannot be used to render the program non-free.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n TERMS AND CONDITIONS\n\n 0. Definitions.\n\n \"This License\" refers to version 3 of the GNU General Public License.\n\n \"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.\n\n \"The Program\" refers to any copyrightable work licensed under this\nLicense. Each licensee is addressed as \"you\". \"Licensees\" and\n\"recipients\" may be individuals or organizations.\n\n To \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy. The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.\n\n A \"covered work\" means either the unmodified Program or a work based\non the Program.\n\n To \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy. Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.\n\n To \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies. Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.\n\n An interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License. If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n 1. Source Code.\n\n The \"source code\" for a work means the preferred form of the work\nfor making modifications to it. \"Object code\" means any non-source\nform of a work.\n\n A \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.\n\n The \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form. A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.\n\n The \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities. However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work. For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.\n\n The Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.\n\n The Corresponding Source for a work in source code form is that\nsame work.\n\n 2. Basic Permissions.\n\n All rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met. This License explicitly affirms your unlimited\npermission to run the unmodified Program. The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work. This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.\n\n You may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force. You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright. Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\n Conveying under any other circumstances is permitted solely under\nthe conditions stated below. Sublicensing is not allowed; section 10\nmakes it unnecessary.\n\n 3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\n No covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.\n\n When you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.\n\n 4. Conveying Verbatim Copies.\n\n You may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\n You may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.\n\n 5. Conveying Modified Source Versions.\n\n You may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:\n\n a) The work must carry prominent notices stating that you modified\n it, and giving a relevant date.\n\n b) The work must carry prominent notices stating that it is\n released under this License and any conditions added under section\n 7. This requirement modifies the requirement in section 4 to\n \"keep intact all notices\".\n\n c) You must license the entire work, as a whole, under this\n License to anyone who comes into possession of a copy. This\n License will therefore apply, along with any applicable section 7\n additional terms, to the whole of the work, and all its parts,\n regardless of how they are packaged. This License gives no\n permission to license the work in any other way, but it does not\n invalidate such permission if you have separately received it.\n\n d) If the work has interactive user interfaces, each must display\n Appropriate Legal Notices; however, if the Program has interactive\n interfaces that do not display Appropriate Legal Notices, your\n work need not make them do so.\n\n A compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit. Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n 6. Conveying Non-Source Forms.\n\n You may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:\n\n a) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by the\n Corresponding Source fixed on a durable physical medium\n customarily used for software interchange.\n\n b) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by a\n written offer, valid for at least three years and valid for as\n long as you offer spare parts or customer support for that product\n model, to give anyone who possesses the object code either (1) a\n copy of the Corresponding Source for all the software in the\n product that is covered by this License, on a durable physical\n medium customarily used for software interchange, for a price no\n more than your reasonable cost of physically performing this\n conveying of source, or (2) access to copy the\n Corresponding Source from a network server at no charge.\n\n c) Convey individual copies of the object code with a copy of the\n written offer to provide the Corresponding Source. This\n alternative is allowed only occasionally and noncommercially, and\n only if you received the object code with such an offer, in accord\n with subsection 6b.\n\n d) Convey the object code by offering access from a designated\n place (gratis or for a charge), and offer equivalent access to the\n Corresponding Source in the same way through the same place at no\n further charge. You need not require recipients to copy the\n Corresponding Source along with the object code. If the place to\n copy the object code is a network server, the Corresponding Source\n may be on a different server (operated by you or a third party)\n that supports equivalent copying facilities, provided you maintain\n clear directions next to the object code saying where to find the\n Corresponding Source. Regardless of what server hosts the\n Corresponding Source, you remain obligated to ensure that it is\n available for as long as needed to satisfy these requirements.\n\n e) Convey the object code using peer-to-peer transmission, provided\n you inform other peers where the object code and Corresponding\n Source of the work are being offered to the general public at no\n charge under subsection 6d.\n\n A separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.\n\n A \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling. In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage. For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product. A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.\n\n \"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source. The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.\n\n If you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information. But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).\n\n The requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed. Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.\n\n Corresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.\n\n 7. Additional Terms.\n\n \"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law. If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.\n\n When you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit. (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.) You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.\n\n Notwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:\n\n a) Disclaiming warranty or limiting liability differently from the\n terms of sections 15 and 16 of this License; or\n\n b) Requiring preservation of specified reasonable legal notices or\n author attributions in that material or in the Appropriate Legal\n Notices displayed by works containing it; or\n\n c) Prohibiting misrepresentation of the origin of that material, or\n requiring that modified versions of such material be marked in\n reasonable ways as different from the original version; or\n\n d) Limiting the use for publicity purposes of names of licensors or\n authors of the material; or\n\n e) Declining to grant rights under trademark law for use of some\n trade names, trademarks, or service marks; or\n\n f) Requiring indemnification of licensors and authors of that\n material by anyone who conveys the material (or modified versions of\n it) with contractual assumptions of liability to the recipient, for\n any liability that these contractual assumptions directly impose on\n those licensors and authors.\n\n All other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10. If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term. If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.\n\n If you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.\n\n Additional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.\n\n 8. Termination.\n\n You may not propagate or modify a covered work except as expressly\nprovided under this License. Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).\n\n However, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.\n\n Moreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.\n\n Termination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License. If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.\n\n 9. Acceptance Not Required for Having Copies.\n\n You are not required to accept this License in order to receive or\nrun a copy of the Program. Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance. However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work. These actions infringe copyright if you do\nnot accept this License. Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.\n\n 10. Automatic Licensing of Downstream Recipients.\n\n Each time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License. You are not responsible\nfor enforcing compliance by third parties with this License.\n\n An \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.\n\n You may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License. For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.\n\n 11. Patents.\n\n A \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based. The\nwork thus licensed is called the contributor's \"contributor version\".\n\n A contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version. For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.\n\n Each contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.\n\n In the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement). To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.\n\n If you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.\n\n If, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.\n\n A patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License. You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.\n\n Nothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.\n\n 12. No Surrender of Others' Freedom.\n\n If conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all. For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.\n\n 13. Use with the GNU Affero General Public License.\n\n Notwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU Affero General Public License into a single\ncombined work, and to convey the resulting work. The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the special requirements of the GNU Affero General Public License,\nsection 13, concerning interaction through a network will apply to the\ncombination as such.\n\n 14. Revised Versions of this License.\n\n The Free Software Foundation may publish revised and/or new versions of\nthe GNU General Public License from time to time. Such new versions will\nbe similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\n Each version is given a distinguishing version number. If the\nProgram specifies that a certain numbered version of the GNU General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation. If the Program does not specify a version number of the\nGNU General Public License, you may choose any version ever published\nby the Free Software Foundation.\n\n If the Program specifies that a proxy can decide which future\nversions of the GNU General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.\n\n Later license versions may give you additional or different\npermissions. However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.\n\n 15. Disclaimer of Warranty.\n\n THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n 16. Limitation of Liability.\n\n IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.\n\n 17. Interpretation of Sections 15 and 16.\n\n If the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.\n\n END OF TERMS AND CONDITIONS\n\n How to Apply These Terms to Your New Programs\n\n If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n To do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n \n Copyright (C) \n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU General Public License for more details.\n\n You should have received a copy of the GNU General Public License\n along with this program. If not, see .\n\nAlso add information on how to contact you by electronic and paper mail.\n\n If the program does terminal interaction, make it output a short\nnotice like this when it starts in an interactive mode:\n\n Copyright (C) \n This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.\n This is free software, and you are welcome to redistribute it\n under certain conditions; type `show c' for details.\n\nThe hypothetical commands `show w' and `show c' should show the appropriate\nparts of the General Public License. Of course, your program's commands\nmight be different; for a GUI interface, you would use an \"about box\".\n\n You should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU GPL, see\n.\n\n The GNU General Public License does not permit incorporating your program\ninto proprietary programs. If your program is a subroutine library, you\nmay consider it more useful to permit linking proprietary applications with\nthe library. If this is what you want to do, use the GNU Lesser General\nPublic License instead of this License. But first, please read\n.\n\n-------------------------------------------------------------------------\n" }, { "path": "DISCLAIMER", "content": "Parts of the code uses OpenFOAM® technology. This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks.\n\nDetailed information on the OpenFOAM trademark can be found at\n\n - http://www.openfoam.com/legal/trademark-policy.php\n - http://www.openfoam.com/legal/trademark-guidelines.php\n \nFor further information on OpenCFD and OpenFOAM, please refer to \n\n - http://www.openfoam.com\n" }, { "path": "README.md", "content": "
\n\n

\n \n \n

\n \n
\n\n## The extended version of CFDEM®coupling is constantly developed and maintained by DCS Computing GmbH - you can find more information [here](https://www.aspherix-dem.com/software/cfdemcoupling-functionalities/)\n\nThis repository contains older, publicly available versions of CFDEM®coupling (referred to as \"CFDEM®coupling-PUBLIC\").\nThis repository has last been updated for CFDEMcoupling-PUBLIC to be compatible with OpenFOAM-6 ensuring\nfunctionality on Ubuntu 22.04 and 24.04.\nWhile this update contains some bugfixes and improvements, the main intention of this\nupdate is keeping CFDEMcoupling usable also on newer systems where the compilation of\nolder OpenFOAM versions may prove difficult.\nThis repository will not be updated in the foreseeable future.\n\nCFDEM®coupling-PUBLIC is compatible with [LIGGGHTS-PUBLIC](https://github.com/CFDEMproject/LIGGGHTS-PUBLIC).\n\nThe extended version of CFDEM®coupling is compatible with the DEM software [Aspherix®](https://www.aspherix-dem.com/), the \"successor\" of LIGGGHTS® developed and distributed by DCS Computing GmbH, Linz, Austria.\n\n\n\n## CFDEM®coupling-PUBLIC\n\nCFDEM®coupling-PUBLIC is an Open Source coupled CFD-DEM framework combining the strengths of LIGGGHTS® DEM code and the Open Source CFD package OpenFOAM® [^1]. CFDEM®coupling stands for Computational Fluid Dynamics (CFD) - Discrete Element Method (DEM) coupling.\n\nLIGGGHTS® and CFDEM® are registered trade marks of DCS Computing GmbH, the producer of the LIGGGHTS® software and the CFDEM®coupling software; see http://www.cfdem.com/terms-trademark-policy for details.\n\nCFDEM®coupling-PUBLIC is open-source, distributed under the terms of the GNU Public License, version 3 or later. CFDEM®coupling-PUBLIC is part of CFDEM®project: www.liggghts.com | www.cfdem.com. Core developer and main author: Christoph Goniva, christoph.goniva@dcs-computing.com\n\n[^1]: This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks.\n\n\n\n## Features\n\n* Modular approach that allows users to easily implement new models\n* MPI parallelization that enables to use it for large scale problems\n* The \"forum\" (www.cfdem.com) on CFD-DEM gives the possibility to exchange with other users / developers\n* The use of GIT allows to easily update to the latest version\n* Basic documentation is provided\n\nIn this toolbox the particle representation within the CFD solver is organized by \"cloud\" classes. Key functionalities are organised in sub-models (e.g. force models, data exchange models, etc.), which can easily be selected and combined by dictionary settings.\n\n\n\n## Structure\nThe CFDEM®coupling-PUBLIC distribution includes the following files and directories:\n\n* `README`: this file\n* `COPYING`: the GNU General Public License (GPL) file\n* `DISCLAIMER`\n* `src`: directory including the source files of the coupling toolbox and models\n* `applications`: directory including the solver files for coupled CFD-DEM simulations\n* `doc`: directory including the documentation of CFDEM®coupling\n* `tutorials`: directory including basic tutorial cases showing the functionality\n\nDetails on installation are given on the www.cfdem.com website.\n\n\n\n## License\n\nCFDEM®coupling-PUBLIC is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.\n\nCFDEM®coupling is distributed in the hope that it will be useful, but **without any warranty**; without even the implied warranty of **merchantabiity** or **fitness for a particular purpouse**; see the GNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along with CFDEM®coupling-PUBLIC; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.\n\n\n\n## Copyrights\n* Copyright 2012-now: DCS Computing GmbH, Linz\n* Copyright 2009-2015: JKU Linz\n\nSome parts of CFDEM®coupling are based on OpenFOAM® and Copyright on these parts is held by the OpenFOAM® Foundation (www.openFoam.org) and potentially other parties. Some parts of CFDEMcoupling are contributied by other parties, which are holding the Copyright. This is listed in each file of the distribution.\n\n## How to cite CFDEM®coupling-PUBLIC\nIf you are using PhasicFlow in your research or industrial work, cite the following [article](https://doi.org/10.1016/j.partic.2012.05.002):\n```\n@article{goniva2012influence,\n title={Influence of rolling friction on single spout fluidized bed simulation},\n author={Goniva, Christoph and Kloss, Christoph and Deen, Niels G and Kuipers, Johannes AM and Pirker, Stefan},\n journal={Particuology},\n volume={10},\n number={5},\n pages={582--591},\n year={2012},\n publisher={Elsevier}\n}\n```\n" }, { "path": "applications/solvers/cfdemSolverIB/Make/files", "content": "cfdemSolverIB.C\n\nEXE=$(CFDEM_APP_DIR)/cfdemSolverIB\n" }, { "path": "applications/solvers/cfdemSolverIB/Make/options", "content": "sinclude $(GENERAL_RULES)/mplib$(WM_MPLIB)\ninclude $(CFDEM_ADD_LIBS_DIR)/$(CFDEM_ADD_LIBS_NAME)\n\nPFLAGS+= -DCFDEMWMPROJECTVERSION=\"$(CFDEM_WM_PROJECT_VERSION)\"\ninclude $(CFDEM_ADD_LIBS_DIR)/additionalLibs_solver\n\nEXE_INC = \\\n $(PFLAGS) \\\n $(PINC) \\\n $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \\\n -I$(LIB_SRC)/transportModels \\\n -I$(LIB_SRC)/transportModels/incompressible/singlePhaseTransportModel \\\n -I$(LIB_SRC)/finiteVolume/lnInclude \\\n -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/lnInclude \\\n -I$(LIB_SRC)/meshTools/lnInclude \\\n -I$(LIB_SRC)/sampling/lnInclude \\\n -I$(LIB_SRC)/dynamicFvMesh/lnInclude \\\n -I$(CFDEM_LIGGGHTS_SRC_DIR)\n\nEXE_LIBS = \\\n -L$(CFDEM_LIB_DIR)\\\n $(CFDEM_ADD_INCOMPTURBMOD_LIBS) \\\n -lincompressibleTransportModels \\\n -lfiniteVolume \\\n -ldynamicFvMesh \\\n -ldynamicMesh \\\n -l$(CFDEM_LIB_NAME) \\\n $(CFDEM_ADD_LIB_PATHS) \\\n $(CFDEM_ADD_LIBS)\n\n" }, { "path": "applications/solvers/cfdemSolverIB/cfdemSolverIB.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright (C) 1991-2009 OpenCFD Ltd.\n Copyright (C) 2009-2012 JKU, Linz\n Copyright (C) 2012- DCS Computing GmbH,Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling. If not, see .\n\nApplication\n cfdemSolverIB\n\nDescription\n Transient solver for incompressible flow.\n The code is an evolution of the solver pisoFoam in OpenFOAM(R) 1.6, \n where additional functionality for CFD-DEM coupling using immersed body\n (fictitious domain) method is added.\nContributions\n Alice Hager\n\\*---------------------------------------------------------------------------*/\n\n\n#include \"fvCFD.H\"\n#include \"singlePhaseTransportModel.H\"\n#include \"OFversion.H\"\n\n#if defined(version30)\n #include \"turbulentTransportModel.H\"\n #include \"pisoControl.H\"\n#else\n #include \"turbulenceModel.H\"\n#endif\n#include \"cfdemCloudIB.H\"\n#if defined(superquadrics_IB_flag)\n#include \"cfdemCloudIBSuperquadric.H\"\n#endif\n#include \"implicitCouple.H\"\n\n#include \"averagingModel.H\"\n#include \"voidFractionModel.H\"\n\n#include \"dynamicFvMesh.H\"\n\n#include \"cellSet.H\"\n\n#if defined(version22)\n #include \"meshToMeshNew.H\"\n #include \"fvIOoptionList.H\"\n#endif\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nint main(int argc, char *argv[])\n{\n #include \"setRootCase.H\"\n\n #include \"createTime.H\"\n\n #include \"createDynamicFvMesh.H\"\n\n #if defined(version30)\n pisoControl piso(mesh);\n #include \"createTimeControls.H\"\n #endif\n\n #include \"createFields.H\"\n\n #include \"initContinuityErrs.H\"\n\n #if defined(version22)\n #include \"createFvOptions.H\"\n #endif\n\n // create cfdemCloud\n #include \"readGravitationalAcceleration.H\"\n #if defined(superquadrics_IB_flag)\n cfdemCloudIBSuperquadric particleCloud(mesh);\n #else\n cfdemCloudIB particleCloud(mesh);\n #endif\n\n // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n Info<< \"\\nStarting time loop\\n\" << endl;\n\n while (runTime.loop())\n {\n Info<< \"Time = \" << runTime.timeName() << nl << endl;\n\n //=== dyM ===================\n interFace = mag(mesh.lookupObject(\"voidfractionNext\"));\n particleCloud.setMeshHasUpdatedFlag(mesh.update()); //dyM\n\n #if defined(version30)\n #include \"readTimeControls.H\"\n #include \"CourantNo.H\"\n #include \"setDeltaT.H\"\n #else\n #include \"readPISOControls.H\"\n #include \"CourantNo.H\"\n #endif\n\n // do particle stuff\n Info << \"- evolve()\" << endl;\n particleCloud.evolve(voidfraction, interFace);\n\n // Pressure-velocity PISO corrector\n if(particleCloud.solveFlow())\n {\n // Momentum predictor\n\n fvVectorMatrix UEqn\n (\n fvm::ddt(U) //fvm::ddt(voidfraction,U)\n + fvm::div(phi, U)\n + turbulence->divDevReff(U)\n #if defined(version22)\n ==\n fvOptions(U)\n #endif\n );\n\n UEqn.relax();\n\n #if defined(version22)\n fvOptions.constrain(UEqn);\n #endif\n\n #if defined(version30)\n if (piso.momentumPredictor())\n #else\n if (momentumPredictor)\n #endif\n {\n solve(UEqn == -fvc::grad(p));\n }\n\n // --- PISO loop\n #if defined(version30)\n while (piso.correct())\n #else\n for (int corr=0; corrcorrect();\n\n Info << \"particleCloud.calcVelocityCorrection() \" << endl;\n volScalarField voidfractionNext=mesh.lookupObject(\"voidfractionNext\");\n particleCloud.calcVelocityCorrection(p,U,phiIB,voidfractionNext);\n\n #if defined(version22)\n fvOptions.correct(U);\n #endif\n\n runTime.write();\n\n Info<< \"ExecutionTime = \" << runTime.elapsedCpuTime() << \" s\"\n << \" ClockTime = \" << runTime.elapsedClockTime() << \" s\"\n << nl << endl;\n }\n\n Info<< \"End\\n\" << endl;\n\n return 0;\n}\n\n\n// ************************************************************************* //\n" }, { "path": "applications/solvers/cfdemSolverIB/createFields.H", "content": " Info<< \"Reading field p\\n\" << endl;\n volScalarField p\n (\n IOobject\n (\n \"p\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh\n );\n\n Info<< \"Reading physical velocity field U\" << endl;\n Info<< \"Note: only if voidfraction at boundary is 1, U is superficial velocity!!!\\n\" << endl;\n volVectorField U\n (\n IOobject\n (\n \"U\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh\n );\n //mod by alice\n Info<< \"Reading physical velocity field U\" << endl;\n Info<< \"Note: only if voidfraction at boundary is 1, U is superficial velocity!!!\\n\" << endl;\n volVectorField Us\n (\n IOobject\n (\n \"Us\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh\n );\n\n /*Info<< \"\\nCreating outside field\\n\" << endl;\n volScalarField outside\n (\n IOobject\n (\n \"outside\",\n runTime.timeName(),\n mesh,\n IOobject::NO_READ,\n IOobject::AUTO_WRITE\n ),\n mesh,\n scalar(0)\n );*/\n\n//========================\n// drag law modelling\n//========================\n\n Info<< \"\\nCreating dummy density field rho = 1\\n\" << endl;\n volScalarField rho\n (\n IOobject\n (\n \"rho\",\n runTime.timeName(),\n mesh,\n IOobject::READ_IF_PRESENT,\n IOobject::AUTO_WRITE\n ),\n mesh,\n dimensionedScalar(\"0\", dimensionSet(1, -3, 0, 0, 0), 1.0)\n );\n\n\n Info<< \"Reading field phiIB\\n\" << endl;\n volScalarField phiIB\n (\n IOobject\n (\n \"phiIB\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh\n );\n\n\n //mod by alice\n Info<< \"Reading field phiIB\\n\" << endl;\n volScalarField voidfraction\n (\n IOobject\n (\n \"voidfraction\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh\n );\n//========================\n\n# include \"createPhi.H\"\n\n label pRefCell = 0;\n scalar pRefValue = 0.0;\n setRefCell(p, mesh.solutionDict().subDict(\"PISO\"), pRefCell, pRefValue);\n\n\n singlePhaseTransportModel laminarTransport(U, phi);\n\n autoPtr turbulence\n (\n incompressible::turbulenceModel::New(U, phi, laminarTransport)\n );\n\n//=== dyM ===================\n\n Info<< \"Reading field interFace\\n\" << endl;\n volScalarField interFace\n (\n IOobject\n (\n \"interFace\",\n runTime.timeName(),\n mesh,\n IOobject::READ_IF_PRESENT,\n IOobject::AUTO_WRITE\n ),\n mesh,\n //dimensionedScalar(\"0\", dimensionSet(0, -1, 0, 0, 0), 0.0)\n dimensionedScalar(\"0\", dimensionSet(0, 0, 0, 0, 0), 0.0)\n );\n\n//===========================\n" }, { "path": "applications/solvers/cfdemSolverPiso/Make/files", "content": "cfdemSolverPiso.C\n\nEXE=$(CFDEM_APP_DIR)/cfdemSolverPiso\n" }, { "path": "applications/solvers/cfdemSolverPiso/Make/options", "content": "sinclude $(GENERAL_RULES)/mplib$(WM_MPLIB)\ninclude $(CFDEM_ADD_LIBS_DIR)/$(CFDEM_ADD_LIBS_NAME)\n\nPFLAGS+= -DCFDEMWMPROJECTVERSION=\"$(CFDEM_WM_PROJECT_VERSION)\"\ninclude $(CFDEM_ADD_LIBS_DIR)/additionalLibs_solver\n\nEXE_INC = \\\n $(PFLAGS) \\\n $(PINC) \\\n $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \\\n -I$(LIB_SRC)/transportModels \\\n -I$(LIB_SRC)/transportModels/incompressible/singlePhaseTransportModel \\\n -I$(LIB_SRC)/finiteVolume/lnInclude \\\n -I$(LIB_SRC)/meshTools/lnInclude \\\n -I$(LIB_SRC)/fvOptions/lnInclude \\\n -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/lnInclude \\\n -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/cfdTools \\\n -I$(CFDEM_LIGGGHTS_SRC_DIR)\n\nEXE_LIBS = \\\n -L$(CFDEM_LIB_DIR)\\\n $(CFDEM_ADD_INCOMPTURBMOD_LIBS) \\\n -lincompressibleTransportModels \\\n -lfiniteVolume \\\n -lmeshTools \\\n -lfvOptions \\\n -l$(CFDEM_LIB_NAME) \\\n $(CFDEM_ADD_LIB_PATHS) \\\n $(CFDEM_ADD_LIBS)\n" }, { "path": "applications/solvers/cfdemSolverPiso/cfdemSolverPiso.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright (C) 1991-2009 OpenCFD Ltd.\n Copyright (C) 2009-2012 JKU, Linz\n Copyright (C) 2012- DCS Computing GmbH,Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling. If not, see .\n\nApplication\n cfdemSolverPiso\n\nDescription\n Transient solver for incompressible flow.\n Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.\n The code is an evolution of the solver pisoFoam in OpenFOAM(R) 1.6,\n where additional functionality for CFD-DEM coupling is added.\n\\*---------------------------------------------------------------------------*/\n\n#include \"fvCFD.H\"\n#include \"singlePhaseTransportModel.H\"\n\n#include \"OFversion.H\"\n#if defined(version30)\n #include \"turbulentTransportModel.H\"\n #include \"pisoControl.H\"\n#else\n #include \"turbulenceModel.H\"\n#endif\n#if defined(versionv1606plus) || defined(version40)\n #include \"fvOptions.H\"\n#else\n #include \"fvIOoptionList.H\"\n#endif\n#include \"fixedFluxPressureFvPatchScalarField.H\"\n\n#include \"declareCFDEMcloud.H\"\n#include \"implicitCouple.H\"\n#include \"clockModel.H\"\n#include \"smoothingModel.H\"\n#include \"forceModel.H\"\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nint main(int argc, char *argv[])\n{\n #include \"setRootCase.H\"\n #include \"createTime.H\"\n #include \"createMesh.H\"\n #if defined(version30)\n pisoControl piso(mesh);\n #include \"createTimeControls.H\"\n #endif\n #include \"createFields.H\"\n #include \"createFvOptions.H\"\n #include \"initContinuityErrs.H\"\n\n // create cfdemCloud\n #include \"readGravitationalAcceleration.H\"\n #include \"checkImCoupleM.H\"\n #include \"constructCFDEMcloud.H\"\n #include \"checkModelType.H\"\n\n // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n Info<< \"\\nStarting time loop\\n\" << endl;\n while (runTime.loop())\n {\n Info<< \"Time = \" << runTime.timeName() << nl << endl;\n\n #if defined(version30)\n #include \"readTimeControls.H\"\n #include \"CourantNo.H\"\n #include \"setDeltaT.H\"\n #else\n #include \"readPISOControls.H\"\n #include \"CourantNo.H\"\n #endif\n\n // do particle stuff\n particleCloud.clockM().start(1,\"Global\");\n particleCloud.clockM().start(2,\"Coupling\");\n bool hasEvolved = particleCloud.evolve(voidfraction,Us,U);\n\n if(hasEvolved && particleCloud.solveFlow())\n {\n particleCloud.smoothingM().smoothenAbsolutField(particleCloud.forceM(0).impParticleForces());\n }\n\n Ksl = particleCloud.momCoupleM(particleCloud.registryM().getProperty(\"implicitCouple_index\")).impMomSource();\n Ksl.correctBoundaryConditions();\n\n //Force Checks\n #include \"forceCheckIm.H\"\n\n surfaceScalarField voidfractionf = fvc::interpolate(voidfraction);\n phi = voidfractionf*phiByVoidfraction;\n\n particleCloud.clockM().stop(\"Coupling\");\n\n particleCloud.clockM().start(26,\"Flow\");\n\n if(particleCloud.solveFlow())\n {\n // Pressure-velocity PISO corrector\n {\n // Momentum predictor\n fvVectorMatrix UEqn\n (\n fvm::ddt(voidfraction,U) - fvm::Sp(fvc::ddt(voidfraction),U)\n + fvm::div(phi,U) - fvm::Sp(fvc::div(phi),U)\n// + turbulence->divDevReff(U)\n + particleCloud.divVoidfractionTau(U, voidfraction)\n ==\n - fvm::Sp(Ksl/rho,U)\n + fvOptions(U)\n );\n\n UEqn.relax();\n fvOptions.constrain(UEqn);\n\n #if defined(version30)\n if (piso.momentumPredictor())\n #else\n if (momentumPredictor)\n #endif\n {\n if (modelType==\"B\" || modelType==\"Bfull\")\n solve(UEqn == - fvc::grad(p) + Ksl/rho*Us);\n else\n solve(UEqn == - voidfraction*fvc::grad(p) + Ksl/rho*Us);\n\n fvOptions.correct(U);\n }\n\n // --- PISO loop\n #if defined(version30)\n while (piso.correct())\n #else\n for (int corr=0; corrcorrect();\n }// end solveFlow\n else\n {\n Info << \"skipping flow solution.\" << endl;\n }\n\n runTime.write();\n\n Info<< \"ExecutionTime = \" << runTime.elapsedCpuTime() << \" s\"\n << \" ClockTime = \" << runTime.elapsedClockTime() << \" s\"\n << nl << endl;\n\n particleCloud.clockM().stop(\"Flow\");\n particleCloud.clockM().stop(\"Global\");\n }\n\n Info<< \"End\\n\" << endl;\n\n return 0;\n}\n\n\n// ************************************************************************* //\n" }, { "path": "applications/solvers/cfdemSolverPiso/createFields.H", "content": " Info<< \"Reading field p\\n\" << endl;\n volScalarField p\n (\n IOobject\n (\n \"p\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh\n );\n\n Info<< \"Reading physical velocity field U\" << endl;\n Info<< \"Note: only if voidfraction at boundary is 1, U is superficial velocity!!!\\n\" << endl;\n volVectorField U\n (\n IOobject\n (\n \"U\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh\n );\n\n #include \"createCFDEMFields.H\"\n\n//# include \"createPhi.H\"\n#ifndef createPhi_H\n#define createPhi_H\nInfo<< \"Reading/calculating face flux field phi\\n\" << endl;\nsurfaceScalarField phi\n (\n IOobject\n (\n \"phi\",\n runTime.timeName(),\n mesh,\n IOobject::READ_IF_PRESENT,\n IOobject::AUTO_WRITE\n ),\n linearInterpolate(U*voidfraction) & mesh.Sf()\n );\n#endif\n\nInfo<< \"Generating interstitial face flux field phiByVoidfraction\\n\" << endl;\nsurfaceScalarField phiByVoidfraction\n(\n IOobject\n (\n \"phiByVoidfraction\",\n runTime.timeName(),\n mesh,\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n linearInterpolate(U) & mesh.Sf()\n);\n\n label pRefCell = 0;\n scalar pRefValue = 0.0;\n setRefCell(p, mesh.solutionDict().subDict(\"PISO\"), pRefCell, pRefValue);\n\n\n singlePhaseTransportModel laminarTransport(U, phi);\n\n autoPtr turbulence\n (\n incompressible::turbulenceModel::New(U, phi, laminarTransport)\n );\n" }, { "path": "applications/solvers/cfdemSolverPisoSTM/Make/files", "content": "cfdemSolverPisoSTM.C\n\nEXE=$(CFDEM_APP_DIR)/cfdemSolverPisoSTM\n" }, { "path": "applications/solvers/cfdemSolverPisoSTM/Make/options", "content": "sinclude $(GENERAL_RULES)/mplib$(WM_MPLIB)\ninclude $(CFDEM_ADD_LIBS_DIR)/$(CFDEM_ADD_LIBS_NAME)\n\nPFLAGS+= -DCFDEMWMPROJECTVERSION=\"$(CFDEM_WM_PROJECT_VERSION)\"\ninclude $(CFDEM_ADD_LIBS_DIR)/additionalLibs_solver\n\nEXE_INC = \\\n $(PFLAGS) \\\n $(PINC) \\\n $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \\\n -I$(LIB_SRC)/transportModels \\\n -I$(LIB_SRC)/transportModels/incompressible/singlePhaseTransportModel \\\n -I$(LIB_SRC)/finiteVolume/lnInclude \\\n -I$(LIB_SRC)/meshTools/lnInclude \\\n -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/lnInclude \\\n -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/cfdTools \\\n -I$(CFDEM_SRC_DIR)/eulerian/scalarTransportModelsCFDEM/lnInclude \\\n -I$(CFDEM_LIGGGHTS_SRC_DIR)\n\nEXE_LIBS = \\\n -L$(CFDEM_LIB_DIR)\\\n $(CFDEM_ADD_INCOMPTURBMOD_LIBS) \\\n -lincompressibleTransportModels \\\n -lfiniteVolume \\\n -lmeshTools \\\n -l$(CFDEM_LIB_NAME) \\\n -lscalarTransportModelsCFDEM \\\n $(CFDEM_ADD_LIB_PATHS) \\\n $(CFDEM_ADD_LIBS)\n" }, { "path": "applications/solvers/cfdemSolverPisoSTM/cfdemSolverPisoSTM.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright (C) 1991-2009 OpenCFD Ltd.\n Copyright (C) 2012- DCS Computing GmbH,Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling. If not, see .\n\nApplication\n cfdemSolverPisoSTM\n\nDescription\n Transient solver for incompressible flow.\n Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.\n The code is an evolution of the solver pisoFoam in OpenFOAM(R) 1.6,\n where additional functionality for CFD-DEM coupling is added.\n\\*---------------------------------------------------------------------------*/\n\n#include \"fvCFD.H\"\n#include \"singlePhaseTransportModel.H\"\n\n#include \"OFversion.H\"\n#if defined(version30)\n #include \"turbulentTransportModel.H\"\n #include \"pisoControl.H\"\n#else\n #include \"turbulenceModel.H\"\n#endif\n#if defined(versionv1606plus) || defined(version40)\n #include \"fvOptions.H\"\n#else\n #include \"fvIOoptionList.H\"\n#endif\n#include \"fixedFluxPressureFvPatchScalarField.H\"\n#ifdef MS\n #include \"cfdemCloudMS.H\"\n#else\n #include \"cfdemCloud.H\"\n#endif\n#include \"implicitCouple.H\"\n#include \"clockModel.H\"\n#include \"smoothingModel.H\"\n#include \"forceModel.H\"\n\n#include \"scalarTransportModel.H\"\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nint main(int argc, char *argv[])\n{\n #include \"setRootCase.H\"\n #include \"createTime.H\"\n #include \"createMesh.H\"\n #if defined(version30)\n pisoControl piso(mesh);\n #include \"createTimeControls.H\"\n #endif\n #include \"createFields.H\"\n #include \"createFvOptions.H\"\n #include \"initContinuityErrs.H\"\n\n // create cfdemCloud\n #include \"readGravitationalAcceleration.H\"\n #include \"checkImCoupleM.H\"\n #ifdef MS\n cfdemCloudMS particleCloud(mesh);\n #else\n cfdemCloud particleCloud(mesh);\n #endif\n #include \"checkModelType.H\"\n\n // create a scalarTransportModel\n autoPtr stm\n (\n scalarTransportModel::New(particleCloud.couplingProperties(),particleCloud)\n );\n\n // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n Info<< \"\\nStarting time loop\\n\" << endl;\n while (runTime.loop())\n {\n Info<< \"Time = \" << runTime.timeName() << nl << endl;\n\n #if defined(version30)\n #include \"readTimeControls.H\"\n #include \"CourantNo.H\"\n #include \"setDeltaT.H\"\n #else\n #include \"readPISOControls.H\"\n #include \"CourantNo.H\"\n #endif\n\n // do particle stuff\n particleCloud.clockM().start(1,\"Global\");\n particleCloud.clockM().start(2,\"Coupling\");\n bool hasEvolved = particleCloud.evolve(voidfraction,Us,U);\n\n if(hasEvolved && particleCloud.solveFlow())\n {\n particleCloud.smoothingM().smoothenAbsolutField(particleCloud.forceM(0).impParticleForces());\n }\n\n Ksl = particleCloud.momCoupleM(particleCloud.registryM().getProperty(\"implicitCouple_index\")).impMomSource();\n Ksl.correctBoundaryConditions();\n\n surfaceScalarField voidfractionf = fvc::interpolate(voidfraction);\n phi = voidfractionf*phiByVoidfraction;\n\n //Force Checks\n #include \"forceCheckIm.H\"\n\n particleCloud.clockM().stop(\"Coupling\");\n\n particleCloud.clockM().start(26,\"Flow\");\n\n //Scalar transport if desired. Use \"none\" (noTransport) if no scalar transport is desired\n stm().update();\n\n if(particleCloud.solveFlow())\n {\n // Pressure-velocity PISO corrector\n {\n // Momentum predictor\n fvVectorMatrix UEqn\n (\n fvm::ddt(voidfraction,U) - fvm::Sp(fvc::ddt(voidfraction),U)\n + fvm::div(phi,U) - fvm::Sp(fvc::div(phi),U)\n// + turbulence->divDevReff(U)\n + particleCloud.divVoidfractionTau(U, voidfraction)\n ==\n - fvm::Sp(Ksl/rho,U)\n + fvOptions(U)\n );\n\n UEqn.relax();\n fvOptions.constrain(UEqn);\n\n #if defined(version30)\n if (piso.momentumPredictor())\n #else\n if (momentumPredictor)\n #endif\n {\n if (modelType==\"B\" || modelType==\"Bfull\")\n solve(UEqn == - fvc::grad(p) + Ksl/rho*Us);\n else\n solve(UEqn == - voidfraction*fvc::grad(p) + Ksl/rho*Us);\n\n fvOptions.correct(U);\n }\n\n // --- PISO loop\n #if defined(version30)\n while (piso.correct())\n #else\n for (int corr=0; corrcorrect();\n }// end solveFlow\n else\n {\n Info << \"skipping flow solution.\" << endl;\n }\n\n runTime.write();\n\n Info<< \"ExecutionTime = \" << runTime.elapsedCpuTime() << \" s\"\n << \" ClockTime = \" << runTime.elapsedClockTime() << \" s\"\n << nl << endl;\n\n particleCloud.clockM().stop(\"Flow\");\n particleCloud.clockM().stop(\"Global\");\n }\n\n Info<< \"End\\n\" << endl;\n\n return 0;\n}\n\n\n// ************************************************************************* //\n" }, { "path": "applications/solvers/cfdemSolverPisoSTM/createFields.H", "content": " Info<< \"Reading field p\\n\" << endl;\n volScalarField p\n (\n IOobject\n (\n \"p\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh\n );\n\n Info<< \"Reading physical velocity field U\" << endl;\n Info<< \"Note: only if voidfraction at boundary is 1, U is superficial velocity!!!\\n\" << endl;\n volVectorField U\n (\n IOobject\n (\n \"U\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh\n );\n\n #include \"createCFDEMFields.H\"\n\n//========================\n// scalar field modelling\n//========================\n /* Info<< \"\\nCreating dummy density field rho = 1\\n\" << endl;\n volScalarField T\n (\n IOobject\n (\n \"T\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh//,\n //dimensionedScalar(\"0\", dimensionSet(0, 0, -1, 1, 0), 273.15)\n );*/\n\n Info<< \"\\nCreating fluid-particle heat flux field\\n\" << endl;\n volScalarField Tsource\n (\n IOobject\n (\n \"Tsource\",\n runTime.timeName(),\n mesh,\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n mesh,\n dimensionedScalar(\"0\", dimensionSet(0, 0, -1, 1, 0), 0.0)\n );\n\n /*IOdictionary transportProperties\n (\n IOobject\n (\n \"transportProperties\",\n runTime.constant(),\n mesh,\n IOobject::MUST_READ,\n IOobject::NO_WRITE\n )\n );\n\n dimensionedScalar DT\n (\n transportProperties.lookup(\"DT\")\n );*/\n\n//========================\n\n//# include \"createPhi.H\"\n#ifndef createPhi_H\n#define createPhi_H\nInfo<< \"Reading/calculating face flux field phi\\n\" << endl;\nsurfaceScalarField phi\n (\n IOobject\n (\n \"phi\",\n runTime.timeName(),\n mesh,\n IOobject::READ_IF_PRESENT,\n IOobject::AUTO_WRITE\n ),\n linearInterpolate(U*voidfraction) & mesh.Sf()\n );\n#endif\n\nInfo<< \"Generating interstitial face flux field phiByVoidfraction\\n\" << endl;\nsurfaceScalarField phiByVoidfraction\n(\n IOobject\n (\n \"phiByVoidfraction\",\n runTime.timeName(),\n mesh,\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n linearInterpolate(U) & mesh.Sf()\n);\n\n label pRefCell = 0;\n scalar pRefValue = 0.0;\n setRefCell(p, mesh.solutionDict().subDict(\"PISO\"), pRefCell, pRefValue);\n\n\n singlePhaseTransportModel laminarTransport(U, phi);\n\n autoPtr turbulence\n (\n incompressible::turbulenceModel::New(U, phi, laminarTransport)\n );\n" }, { "path": "applications/solvers/cfdemSolverPisoScalar/Make/files", "content": "cfdemSolverPisoScalar.C\n\nEXE = $(CFDEM_APP_DIR)/cfdemSolverPisoScalar\n" }, { "path": "applications/solvers/cfdemSolverPisoScalar/Make/options", "content": "sinclude $(GENERAL_RULES)/mplib$(WM_MPLIB)\ninclude $(CFDEM_ADD_LIBS_DIR)/$(CFDEM_ADD_LIBS_NAME)\n\nPFLAGS+= -DCFDEMWMPROJECTVERSION=\"$(CFDEM_WM_PROJECT_VERSION)\"\ninclude $(CFDEM_ADD_LIBS_DIR)/additionalLibs_solver\n\nEXE_INC = \\\n $(PFLAGS) \\\n $(PINC) \\\n $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \\\n -I$(LIB_SRC)/transportModels \\\n -I$(LIB_SRC)/transportModels/incompressible/singlePhaseTransportModel \\\n -I$(LIB_SRC)/finiteVolume/lnInclude \\\n -I$(LIB_SRC)/thermophysicalModels/radiation/lnInclude \\\n -I$(LIB_SRC)/meshTools/lnInclude \\\n -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/lnInclude \\\n -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/cfdTools \\\n -I$(CFDEM_LIGGGHTS_SRC_DIR)\n\nEXE_LIBS = \\\n -L$(CFDEM_LIB_DIR)\\\n $(CFDEM_ADD_INCOMPTURBMOD_LIBS) \\\n -lincompressibleTransportModels \\\n -lfiniteVolume \\\n -lradiationModels \\\n -lmeshTools \\\n -l$(CFDEM_LIB_NAME) \\\n $(CFDEM_ADD_LIB_PATHS) \\\n $(CFDEM_ADD_LIBS)\n" }, { "path": "applications/solvers/cfdemSolverPisoScalar/cfdemSolverPisoScalar.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright (C) 1991-2009 OpenCFD Ltd.\n Copyright (C) 2009-2012 JKU, Linz\n Copyright (C) 2012- DCS Computing GmbH,Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling. If not, see .\n\nApplication\n cfdemSolverPisoScalar\n\nDescription\n Transient solver for incompressible flow.\n Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.\n The code is an evolution of the solver pisoFoam in OpenFOAM(R) 1.6,\n where additional functionality for CFD-DEM coupling is added.\n\\*---------------------------------------------------------------------------*/\n\n#include \"fvCFD.H\"\n#include \"singlePhaseTransportModel.H\"\n\n#include \"OFversion.H\"\n#if defined(version30)\n #include \"turbulentTransportModel.H\"\n #include \"pisoControl.H\"\n#else\n #include \"turbulenceModel.H\"\n#endif\n#if defined(version60)\n#include \"noRadiation.H\"\n#else\n#include \"radiationModel.H\"\n#endif\n#include \"fixedFluxPressureFvPatchScalarField.H\"\n#include \"cfdemCloud.H\"\n#include \"implicitCouple.H\"\n#include \"clockModel.H\"\n#include \"smoothingModel.H\"\n#include \"forceModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nint main(int argc, char *argv[])\n{\n #include \"setRootCase.H\"\n #include \"createTime.H\"\n #include \"createMesh.H\"\n #if defined(version30)\n pisoControl piso(mesh);\n #include \"createTimeControls.H\"\n #endif\n #include \"createFields.H\"\n #include \"createIncompressibleRadiationModel.H\"\n #include \"initContinuityErrs.H\"\n\n // create cfdemCloud\n #include \"readGravitationalAcceleration.H\"\n #include \"checkImCoupleM.H\"\n cfdemCloud particleCloud(mesh);\n #include \"checkModelType.H\"\n\n // get ref to tempExchange models\n labelList tempExchangeModels(0);\n label id(particleCloud.registryM().getProperty(\"LaEuScalarTemp_index\"));\n if(id>=0) tempExchangeModels.append(id);\n id = particleCloud.registryM().getProperty(\"LaEuScalarRadiation_index\");\n if(id>=0) tempExchangeModels.append(id);\n // check ordering tempExchange models\n if(tempExchangeModels.size() > 1 && tempExchangeModels[0]>tempExchangeModels[1]) FatalError <<\"Please use correct order of forceModels: LaEuScalarTemp before LaEuScalarRadiation.\"<< abort(FatalError);\n\n // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n Info<< \"\\nStarting time loop\\n\" << endl;\n while (runTime.loop())\n {\n particleCloud.clockM().start(1,\"Global\");\n\n Info<< \"Time = \" << runTime.timeName() << nl << endl;\n\n #if defined(version30)\n #include \"readTimeControls.H\"\n #include \"CourantNo.H\"\n #include \"setDeltaT.H\"\n #else\n #include \"readPISOControls.H\"\n #include \"CourantNo.H\"\n #endif\n\n // do particle stuff\n particleCloud.clockM().start(2,\"Coupling\");\n bool hasEvolved = particleCloud.evolve(voidfraction,Us,U);\n\n if(hasEvolved && particleCloud.solveFlow())\n {\n particleCloud.smoothingM().smoothenAbsolutField(particleCloud.forceM(0).impParticleForces());\n }\n\n Info << \"update Ksl.internalField()\" << endl;\n Ksl = particleCloud.momCoupleM(particleCloud.registryM().getProperty(\"implicitCouple_index\")).impMomSource();\n Ksl.correctBoundaryConditions();\n\n surfaceScalarField voidfractionf = fvc::interpolate(voidfraction);\n phi = voidfractionf*phiByVoidfraction;\n\n //Force Checks\n #include \"forceCheckIm.H\"\n\n particleCloud.clockM().stop(\"Coupling\");\n\n particleCloud.clockM().start(26,\"Flow\");\n\n // solve scalar transport equation\n {\n alphat = turbulence->nut()/Prt;\n alphat.correctBoundaryConditions();\n volScalarField alphaEff(\"alphaEff\", turbulence->nu()/Pr + alphat);\n fvScalarMatrix TEqn\n (\n fvm::ddt(voidfraction,T) - fvm::Sp(fvc::ddt(voidfraction),T)\n + fvm::div(phi, T) - fvm::Sp(fvc::div(phi),T)\n - fvm::laplacian(alphaEff*voidfraction, T)\n ==\n Tsource\n + radiation->ST(rhoCpRef, T)\n );\n TEqn.relax();\n TEqn.solve();\n radiation->correct();\n }\n\n if(particleCloud.solveFlow())\n {\n // Pressure-velocity PISO corrector\n {\n // Momentum predictor\n fvVectorMatrix UEqn\n (\n fvm::ddt(voidfraction,U) - fvm::Sp(fvc::ddt(voidfraction),U)\n + fvm::div(phi,U) - fvm::Sp(fvc::div(phi),U)\n// + turbulence->divDevReff(U)\n + particleCloud.divVoidfractionTau(U, voidfraction)\n ==\n - fvm::Sp(Ksl/rho,U)\n );\n\n UEqn.relax();\n\n #if defined(version30)\n if (piso.momentumPredictor())\n #else\n if (momentumPredictor)\n #endif\n {\n if (modelType==\"B\" || modelType==\"Bfull\")\n solve(UEqn == - fvc::grad(p) + Ksl/rho*Us);\n else\n solve(UEqn == - voidfraction*fvc::grad(p) + Ksl/rho*Us);\n }\n\n // --- PISO loop\n #if defined(version30)\n while (piso.correct())\n #else\n for (int corr=0; corrcorrect();\n }// end solveFlow\n else\n {\n Info << \"skipping flow solution.\" << endl;\n }\n\n runTime.write();\n\n Info<< \"ExecutionTime = \" << runTime.elapsedCpuTime() << \" s\"\n << \" ClockTime = \" << runTime.elapsedClockTime() << \" s\"\n << nl << endl;\n\n particleCloud.clockM().stop(\"Flow\");\n particleCloud.clockM().stop(\"Global\");\n }\n\n Info<< \"End\\n\" << endl;\n\n return 0;\n}\n\n\n// ************************************************************************* //\n" }, { "path": "applications/solvers/cfdemSolverPisoScalar/createFields.H", "content": " Info<< \"Reading field p\\n\" << endl;\n volScalarField p\n (\n IOobject\n (\n \"p\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh\n );\n\n Info<< \"Reading physical velocity field U\" << endl;\n Info<< \"Note: only if voidfraction at boundary is 1, U is superficial velocity!!!\\n\" << endl;\n volVectorField U\n (\n IOobject\n (\n \"U\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh\n );\n\n #include \"createCFDEMFields.H\"\n\n//========================\n// scalar field modelling\n//========================\n Info<< \"\\nCreating T field\\n\" << endl;\n volScalarField T\n (\n IOobject\n (\n \"T\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh//,\n //dimensionedScalar(\"0\", dimensionSet(0, 0, -1, 1, 0), 273.15)\n );\n\n Info<< \"\\nCreating fluid-particle heat flux field\\n\" << endl;\n volScalarField Tsource\n (\n IOobject\n (\n \"Tsource\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh//,\n //dimensionedScalar(\"0\", dimensionSet(0, 0, -1, 1, 0), 0.0)\n );\n\n IOdictionary transportProperties\n (\n IOobject\n (\n \"transportProperties\",\n runTime.constant(),\n mesh,\n IOobject::MUST_READ,\n IOobject::NO_WRITE\n )\n );\n\n // kinematic turbulent thermal thermal conductivity m2/s\n Info<< \"Reading field alphat\\n\" << endl;\n volScalarField alphat\n (\n IOobject\n (\n \"alphat\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh\n );\n\n // Laminar Prandtl number\n dimensionedScalar Pr(\"Pr\", dimless, transportProperties);\n\n // Turbulent Prandtl number\n dimensionedScalar Prt(\"Prt\", dimless, transportProperties);\n\n//========================\n\n//# include \"createPhi.H\"\n#ifndef createPhi_H\n#define createPhi_H\nInfo<< \"Reading/calculating face flux field phi\\n\" << endl;\nsurfaceScalarField phi\n (\n IOobject\n (\n \"phi\",\n runTime.timeName(),\n mesh,\n IOobject::READ_IF_PRESENT,\n IOobject::AUTO_WRITE\n ),\n linearInterpolate(U*voidfraction) & mesh.Sf()\n );\n#endif\n\nInfo<< \"Generating interstitial face flux field phiByVoidfraction\\n\" << endl;\nsurfaceScalarField phiByVoidfraction\n(\n IOobject\n (\n \"phiByVoidfraction\",\n runTime.timeName(),\n mesh,\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n linearInterpolate(U) & mesh.Sf()\n);\n\n label pRefCell = 0;\n scalar pRefValue = 0.0;\n setRefCell(p, mesh.solutionDict().subDict(\"PISO\"), pRefCell, pRefValue);\n\n\n singlePhaseTransportModel laminarTransport(U, phi);\n\n autoPtr turbulence\n (\n incompressible::turbulenceModel::New(U, phi, laminarTransport)\n );\n" }, { "path": "applications/utilities/cfdemPostproc/Make/files", "content": "cfdemPostproc.C\n\nEXE=$(CFDEM_APP_DIR)/cfdemPostproc\n" }, { "path": "applications/utilities/cfdemPostproc/Make/options", "content": "sinclude $(GENERAL_RULES)/mplib$(WM_MPLIB)\ninclude $(CFDEM_ADD_LIBS_DIR)/$(CFDEM_ADD_LIBS_NAME)\n\nPFLAGS+= -DCFDEMWMPROJECTVERSION=\"$(CFDEM_WM_PROJECT_VERSION)\"\n\nEXE_INC = \\\n $(PFLAGS) \\\n $(PINC) \\\n $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \\\n -I$(LIB_SRC)/transportModels \\\n -I$(LIB_SRC)/transportModels/incompressible/singlePhaseTransportModel \\\n -I$(LIB_SRC)/finiteVolume/lnInclude \\\n -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/lnInclude \\\n -I$(LIB_SRC)/meshTools/lnInclude \\\n -I$(CFDEM_LIGGGHTS_SRC_DIR)\n\n\nEXE_LIBS = \\\n -L$(CFDEM_LIB_DIR)\\\n $(CFDEM_ADD_INCOMPTURBMOD_LIBS) \\\n -lincompressibleTransportModels \\\n -lfiniteVolume \\\n -l$(CFDEM_LIB_NAME) \\\n $(CFDEM_ADD_LIB_PATHS) \\\n $(CFDEM_ADD_LIBS)\n\n" }, { "path": "applications/utilities/cfdemPostproc/cfdemPostproc.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright (C) 1991-2009 OpenCFD Ltd.\n Copyright (C) 2009-2012 JKU, Linz\n Copyright (C) 2012- DCS Computing GmbH,Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling. If not, see .\n\nApplication\n cfdemPostproc\n\nDescription\n Tool for DEM->CFD (Lagrange->Euler) mapping to calculate local voidfraction\n\\*---------------------------------------------------------------------------*/\n\n#include \"fvCFD.H\"\n#include \"singlePhaseTransportModel.H\"\n\n#include \"OFversion.H\"\n#if defined(version30)\n #include \"turbulentTransportModel.H\"\n#else\n #include \"turbulenceModel.H\"\n#endif\n\n#include \"cfdemCloud.H\"\n#include \"dataExchangeModel.H\"\n#include \"voidFractionModel.H\"\n#include \"locateModel.H\"\n#include \"averagingModel.H\"\n#include \"momCoupleModel.H\"\n#include \"forceModel.H\"\n#include \"IOModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nint main(int argc, char *argv[])\n{\n #include \"setRootCase.H\"\n\n #include \"createTime.H\"\n #include \"createMesh.H\"\n #include \"createFields.H\"\n\n // create cfdemCloud\n cfdemCloud particleCloud(mesh);\n\n // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n Info<< \"\\nStarting time loop\\n\" << endl;\n\n int count=0;\n int DEM_dump_Interval=1000;\n particleCloud.reAllocArrays();\n\n double **positions_(NULL);\n double **velocities_(NULL);\n double **radii_(NULL);\n double **voidfractions_(NULL);\n double **particleWeights_(NULL);\n double **particleVolumes_(NULL);\n double **particleV_(NULL);\n double **cellIDs_(NULL);\n \n particleCloud.dataExchangeM().allocateArray(positions_,0.,3);\n particleCloud.dataExchangeM().allocateArray(velocities_,0.,3);\n particleCloud.get_radii(radii_); // get ref to radii\n //particleCloud.dataExchangeM().allocateArray(radii_,0.,1);\n particleCloud.dataExchangeM().allocateArray(voidfractions_,0.,1);\n particleCloud.dataExchangeM().allocateArray(particleWeights_,0.,1);\n particleCloud.dataExchangeM().allocateArray(particleVolumes_,0.,1);\n particleCloud.dataExchangeM().allocateArray(particleV_,0.,1);\n particleCloud.get_cellIDs(cellIDs_); // get ref to cellIDs\n //particleCloud.dataExchangeM().allocateArray(cellIDs_,0.,1);\n \n\n while (runTime.loop())\n {\n Info<< \"Time = \" << runTime.timeName() << nl << endl;\n count+=DEM_dump_Interval;// proceed loading new data\n\n particleCloud.averagingM().resetVectorAverage(particleCloud.averagingM().UsPrev(),particleCloud.averagingM().UsNext());\n particleCloud.voidFractionM().resetVoidFractions();\n particleCloud.averagingM().resetVectorAverage(particleCloud.forceM(0).impParticleForces(),particleCloud.forceM(0).impParticleForces(),true);\n particleCloud.averagingM().resetVectorAverage(particleCloud.forceM(0).expParticleForces(),particleCloud.forceM(0).expParticleForces(),true);\n particleCloud.averagingM().resetWeightFields();\n particleCloud.momCoupleM(0).resetMomSourceField();\n\n particleCloud.dataExchangeM().couple(0);\n\n particleCloud.dataExchangeM().getData(\"x\",\"vector-atom\",positions_,count);\n particleCloud.dataExchangeM().getData(\"v\",\"vector-atom\",velocities_,count);\n particleCloud.dataExchangeM().getData(\"radius\",\"scalar-atom\",radii_,count);\n\n particleCloud.locateM().findCell(NULL,positions_,cellIDs_,particleCloud.numberOfParticles());\n particleCloud.setPos(positions_);\n\n particleCloud.voidFractionM().setvoidFraction(NULL,voidfractions_,particleWeights_,particleVolumes_,particleV_);\n #if defined(versionv1612plus) || defined(version40) \n voidfraction = particleCloud.voidFractionM().voidFractionInterp();\n #else\n voidfraction.internalField() = particleCloud.voidFractionM().voidFractionInterp();\n #endif\n voidfraction.correctBoundaryConditions();\n\n particleCloud.averagingM().setVectorAverage\n (\n particleCloud.averagingM().UsNext(),\n velocities_,\n particleWeights_,\n particleCloud.averagingM().UsWeightField(),\n NULL, //mask\n NULL,\n false\n );\n\n //write Us field\n Us = particleCloud.averagingM().UsInterp();\n Us.correctBoundaryConditions();\n\n for (int i=0;i turbulence\n (\n incompressible::turbulenceModel::New(U, phi, laminarTransport)\n );\n\n" }, { "path": "applications/utilities/vizClock/matPlot.py", "content": "#!/usr/bin/env python\r\nimport csv, sys\r\nimport numpy as np\r\nimport matplotlib.pyplot as plt\r\n\r\n# Open the data\r\ndatafile = \"timeEvalFull.txt\"\r\nf = open(datafile, 'r')\r\nreader = csv.reader(f, dialect='excel-tab')\r\nreader.next()\r\n\r\nheader = []\r\nidentifier = []\r\ndeltaT = []\r\nmaxdeltaT = []\r\nnOfRuns = []\r\nlevel = []\r\nparentNr = []\r\nparentName = []\r\n\r\n\r\ni = 0\r\nfor row in reader:\r\n\tif i == 0:\r\n\t\tfor column in row:\r\n\t\t\theader.append(column)\r\n\t\tprint header\r\n\telse:\r\n\t\tidentifier.append(row[0])\r\n\t\tdeltaT.append(float(row[1]))\r\n\t\tmaxdeltaT.append(float(row[2]))\r\n\t\tnOfRuns.append(int(row[3]))\r\n\t\tlevel.append(int(row[4]))\r\n\t\tparentNr.append(int(row[5]))\r\n\t\tparentName.append(row[6])\r\n\ti+=1\r\n\r\nbottom = []\r\nchildheight = []\r\n\r\nfor i in range(len(identifier)):\r\n\tbottom.append(0)\r\n\tchildheight.append(0)\r\n\r\nlevelZero = 0.0\r\n\r\n#loop levels\r\nfor j in range(len(identifier)):\r\n\t#loop indices\r\n\tfor i in range(len(identifier)):\r\n\t\tif level[i] == j:\r\n\t\t\tif parentNr[i] != -1:\r\n\t\t\t\tbottom[i] = bottom[parentNr[i]] + childheight[parentNr[i]]\r\n\t\t\t\tchildheight[parentNr[i]] += deltaT[i]\r\n\t\t\telse:\r\n\t\t\t\tbottom[i] = levelZero\r\n\t\t\t\tlevelZero += deltaT[i]\r\n\r\n#Output\r\nfor i in range(len(identifier)):\r\n\tplt.bar(level[i],deltaT[i],width = 0.2, bottom=bottom[i])\r\n\tplt.text(level[i]+0.22,bottom[i]+deltaT[i]/2,identifier[i]+\" \"+str(nOfRuns[i])+\"x\",verticalalignment='center')\r\nplt.xlabel('run level')\r\nplt.ylabel('CPU time in s')\r\nplt.title('time measurement')\r\nplt.show()\r\n\r\n\r\n" }, { "path": "applications/utilities/vizClock/timeEvalFull.txt", "content": "Parallel Measurements in CPU-seconds of all Processors:\r\nName \t avgdeltaT \t maxdeltaT \t nOfRuns \t level \t parentNr \t parentName \r\nX\t5.000000e-06\t5.000000e-06\t1\t0\t-1\tnone\r\nA\t3.240000e-04\t3.240000e-04\t1\t0\t-1\tnone\r\nB\t1.680000e-04\t1.680000e-04\t1\t1\t1\tA\r\nC\t9.000000e-06\t9.000000e-06\t3\t2\t2\tB\r\nD\t6.000000e-06\t6.000000e-06\t3\t3\t3\tC\r\nE\t1.500000e-04\t1.500000e-04\t3\t2\t2\tB\r\nF\t2.400000e-05\t2.400000e-05\t3\t1\t1\tA\r\nG\t6.000000e-06\t6.000000e-06\t3\t1\t1\tA\r\nX\t6.000000e-06\t6.000000e-06\t3\t2\t7\tG\r\nH\t4.000000e-05\t4.000000e-05\t5\t1\t1\tA\r\nI\t2.000000e-05\t2.000000e-05\t1\t1\t1\tA\r\n" }, { "path": "applications/utilities/writeUfluid/Make/files", "content": "writeUfluid.C\n\nEXE = $(CFDEM_APP_DIR)/writeUfluid\n" }, { "path": "applications/utilities/writeUfluid/Make/options", "content": "EXE_INC = \\\n -I$(LIB_SRC)/finiteVolume/lnInclude \\\n -I$(LIB_SRC)/meshTools/lnInclude \\\n -I$(LIB_SRC)/lagrangian/basic/lnInclude\n\nEXE_LIBS = \\\n -lfiniteVolume \\\n -lmeshTools \\\n -lgenericPatchFields \\\n -llagrangian\n" }, { "path": "applications/utilities/writeUfluid/createFields.H", "content": "\nIOdictionary propsDict\n(\n IOobject\n (\n \"particleTrackProperties\",\n runTime.constant(),\n mesh,\n IOobject::MUST_READ_IF_MODIFIED\n )\n);\n\nconst word cloudName(propsDict.lookup(\"cloudName\"));\n\n//label sampleFrequency(readLabel(propsDict.lookup(\"sampleFrequency\")));\n\n// outputMode: compositeFile, filePerTrack\n//word outputmode(propsDict.lookup(\"outputMode\"))\n\n//label maxPositions(readLabel(propsDict.lookup(\"maxPositions\")));\n\n// outputFormat: raw, vtk\n//word outputFormat(propsDict.lookup(\"outputFormat\"));\n\n\n" }, { "path": "applications/utilities/writeUfluid/particleTrackProperties", "content": "/*--------------------------------*- C++ -*----------------------------------*\\\n| ========= | |\n| \\\\ / F ield | OpenFOAM: The Open Source CFD Toolbox |\n| \\\\ / O peration | Version: 2.1.x |\n| \\\\ / A nd | Web: www.OpenFOAM.org |\n| \\\\/ M anipulation | |\n\\*---------------------------------------------------------------------------*/\nFoamFile\n{\n version 2.0;\n format ascii;\n class dictionary;\n location \"constant\";\n object particleTrackProperties;\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\ncloudName cfdemCloud1;\n\nsampleFrequency 1;\n\nmaxPositions 1000000;\n\nmaxPositions 20000;\n// ************************************************************************* //\n" }, { "path": "applications/utilities/writeUfluid/writeUfluid.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright (C) 1991-2009 OpenCFD Ltd.\n Copyright (C) 2009-2012 JKU, Linz\n Copyright (C) 2012- DCS Computing GmbH,Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling. If not, see .\n\nApplication\n writeUfluidwriteUfluid\n\nDescription\n Writes the the cell center fluid velocity to particles in the lagrangian \n time directory.\n\\*---------------------------------------------------------------------------*/\n\n#include \"argList.H\"\n#include \"Cloud.H\"\n#include \"IOdictionary.H\"\n#include \"fvCFD.H\"\n#include \"fvMesh.H\"\n#include \"Time.H\"\n#include \"timeSelector.H\"\n#include \"OFstream.H\"\n#include \"passiveParticleCloud.H\"\n\nusing namespace Foam;\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nint main(int argc, char *argv[])\n{\n timeSelector::addOptions();\n #include \"addRegionOption.H\"\n\n #include \"setRootCase.H\"\n\n #include \"createTime.H\"\n instantList timeDirs = timeSelector::select0(runTime, args);\n #include \"createMesh.H\"\n #include \"createFields.H\"\n\n // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nint nParticle=0;\n forAll(timeDirs, timeI)\n {\n runTime.setTime(timeDirs[timeI], timeI);\n Info<< \"Time = \" << runTime.timeName() << endl;\n IOobject UHeader\n (\n \"U\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ\n );\n if (UHeader.headerOk())\n {\n volVectorField U(UHeader,mesh);\n passiveParticleCloud myCloud(mesh, cloudName);\n\t\tmyCloud.write();\n nParticle = myCloud.size();\n\t IOField Ufluid(myCloud.fieldIOobject(\"Ufluid\",IOobject::NO_READ),nParticle);\n label i = 0;\n forAllConstIter(passiveParticleCloud, myCloud, iter)\n {\n\t\t Ufluid[i]=U[iter().cell()];\n i++;\n }\n Ufluid.write();\n }\n else\n {\n Info << \"velocity field not found\" << endl;\n }\n }\n return 0;\n}\n\n\n// ************************************************************************* //\n" }, { "path": "doc/_build/html/.buildinfo", "content": "# Sphinx build info version 1\n# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.\nconfig: f1656ab2e65996c8f99500bd8a76741e\ntags: 645f666f9bcd5a90fca523b33c5a78b7\n" }, { "path": "doc/_build/html/CFDEMcoupling_Manual.html", "content": "\n\n\n \n\n \n CFDEM®coupling Documentation — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • CFDEM®coupling Documentation
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

CFDEM®coupling Documentation

\n
\n\"_images/Portfolio_CFDEMcoupling.png\"\n
\n
\n

Contents

\n

The CFDEM®coupling documentation is organized into the following sections. If you find any errors or omissions in this manual or have suggestions for useful information to add, please send an email to the developers so the CFDEM®coupling documentation can be improved.

\n
\n
1.1 About CFDEM®coupling
\n
1.2 Installation
\n
1.3 Tutorials
\n
1.4 couplingProperties dictionary
\n
1.5 liggghtsCommands dictionary
\n
1.6 chemistryProperties dictionary
\n
1.7 Models and solvers
\n

\n
\n
\n
\n

About CFDEM®coupling

\n

CFDEM®coupling provides an open source parallel coupled CFD-DEM framework combining the strengths of LIGGGHTS® DEM code and the Open Source CFD package OpenFOAM®(*). The CFDEM®coupling toolbox allows to expand standard CFD solvers of OpenFOAM®(*) to include a coupling to the DEM code LIGGGHTS®. In this toolbox the particle representation within the CFD solver is organized by “cloud” classes. Key functionalities are organised in sub-models (e.g. force models, data exchange models, etc.) which can easily be selected and combined by dictionary settings.

\n

The coupled solvers run fully parallel on distributed-memory clusters. Features are:

\n
    \n

  • its modular approach allows users to easily implement new models

    • \n

  • its MPI parallelization enables to use it for large scale problems

    • \n

  • the `forum <lws_>`_ on CFD-DEM gives the possibility to exchange with other users / developers

    • \n

  • the use of GIT allows to easily update to the latest version

    • \n

  • basic documentation is provided

    • \n
\n

The file structure:

\n
    \n

  • src directory contains the source-code files of the CFDEM®coupling toolbox library and models

    • \n

  • applications directory contains the solver source files for coupled CFD-DEM simulations

    • \n

  • doc directory including the documentation of CFDEM®coupling

    • \n

  • tutorials directory including basic tutorial cases showing the functionality

    • \n
\n

The functionality of this CFD-DEM framework is described via tutorial cases showing how to use different solvers and models.

\n

CFDEM®coupling stands for Computational Fluid Dynamics (CFD) -Discrete Element Method (DEM) coupling.

\n

CFDEM®coupling is an open-source code, distributed freely under the terms of the GNU Public License (GPL).

\n

Core development of CFDEM®coupling is done by Christoph Goniva and Christoph Kloss, both at DCS Computing GmbH, 2012

\n

This documentation was written by DCS Computing GmbH, 2017

\n
\n

How CFDEM®coupling works, a short description:

\n

The launched applications are CFDEM®coupling solvers, e.g. cfdemSolverPiso. Its job is to solve the Navier-Stokes equations with a solid phase present.\nA general formulation with a solid phase:

\n\"_images/NavierStokesLiquSoli.png\"\n

In general “l” denotes liquid and “s” solid properties. AlphaL is the fluid (liquid) content of a calculation-cell, the voidfraction. “rhoL” is the fluid (liquid) density, uL the fluid (liquid) velocity, p the pressure, Ksl the implicit momentum exchange term between solid and liquid phase, us the solid velocity, tau the liquid-stress-tensor, g the gravity vector and t the time. “f” is a general explicit term which can be used to explicitely exchange momentum from the solid to the liquid phase.

\n

All cfdemSolvers use a “cfdemCloud” object, which takes care of many things. The most important are:

\n
    \n

  • Control and communicate with the LIGGGHTS® library object. (liggghtsCommandModel and dataExchangeModel)

    • \n

  • Find the cell ID of a certain position, e.g. the particle center. (locateModel)

    • \n

  • Calculate the voidfraction field from particle positions, particle volumes and cell volumes. (voidFractionModel)

    • \n

  • Calculate the forces on the CFD field and the particle forces. These may be assembled by various forceModels, e.g. buyoancy and a drag-law. (forceModel and forceSubModel)

    • \n

  • Calculate the implicit and if necessary explicit source terms from the force fields for the Navier-Stokes-Equations, the solver needs to solve. (momCoupleModel)

    • \n

  • Calculate the “Us” field from particle data, map the particle data to the CFD field. (averagingModel)

    • \n
\n

In the standard setting the momentum coupling model takes the calculated forces of forceModels and produces the implicit momentum source term Ksl with

\n\"_images/Ksl.png\"\n

More advanced solvers have also an explicit source term field f which is assembled from those forces which have the treatForceExplicit=true flag (see forceSubModels).

\n
\n

(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks.

\n
\n
\n
\n

Installation

\n
\n

This section describes how to download repositories of the CFDEM®project from github.com .\nAfter setting some environment variables, LIGGGHTS® and CFDEM®coupling can be compiled.

\n

Procedure:

\n

Short summary:

\n\n
\n

Install git:

\n

This step is optional, but recommended. Git allows you to update the source code very easily with the git pull command.\nOn debian based systems you can run

\n
sudo apt-get install git-core\n
\n
\n

Similar packages are available on other systems too:

\n
sudo zypper install git-core\nsudo yum install git\n
\n
\n
\n

Note

\n

In this tutorial the git protocol is used to transfer files. If port 9418 is closed for internet connections, please switch to “https://” instead of “git://” for git clone commands.

\n
\n
\n

Download CFDEMproject software:

\n

With git you can clone git repositories from github . The following terminal commands will download the CFDEM®project software to your machine in the typical folder structure. The download of the post-processing tool LPP is optional and requires python-numpy.

\n
cd $HOME\nmkdir CFDEM\ncd CFDEM\ngit clone git://github.com/CFDEMproject/CFDEMcoupling-PUBLIC.git\ncd $HOME\nmkdir LIGGGHTS\ncd LIGGGHTS\ngit clone git://github.com/CFDEMproject/LIGGGHTS-PUBLIC.git\ngit clone git://github.com/CFDEMproject/LPP.git lpp\n
\n
\n

If you do not have git, you can use the download buttons after visiting a repository in the CFDEMproject project page and unzip the archives to the proper locations. Typically github tags the folders with “-master”, please rename them with

\n
cd $HOME/CFDEM\nmv CFDEMcoupling-PUBLIC-master CFDEMcoupling-PUBLIC\ncd $HOME/LIGGGHTS\nmv LIGGGHTS-PUBLIC-master LIGGGHTS-PUBLIC\nmv LPP-master lpp\n
\n
\n
\n

Download the correct OpenFOAM® version:

\n

All mentions of OpenFOAM® refer to this . It is strongly recommended to compile OpenFOAM® yourself with the latest compatible version.\nThe latest compatible OpenFOAM®-version can be found in the in your local copy of CFDEM®coupling in src/lagrangian/cfdemParticle/cfdTools/versionInfo.H, or directly at github .\nLook for the git commit hashtag in the following line:

\n
word OFversion="<OF-Release>-commit-<commitHashtag>";\ne.g. word OFversion="6-commit-af7d7f427be78e9b9beb6aceca8fe7d5d4636876";\n
\n
\n

With git you can use the following recipe to get the correct version:

\n
cd $HOME\nmkdir OpenFOAM\ncd OpenFOAM\ngit clone git://github.com/OpenFOAM/OpenFOAM-<OF-Release>.git\ngit clone git://github.com/OpenFOAM/ThirdParty-<OF-Release>.git\ncd OpenFOAM-<OF-Release>\ngit checkout <commitHashtag>\n
\n
\n

Without git you can visit git://github.com/OpenFOAM/OpenFOAM-<OF-Release>/tree/<commitHashtag> and use the download button.

\n

Other OpenFOAM® versions can be used for compilation, but aren’t officially supported. The list includes 6, 5.x, 4.x, 3.x, 2.4.x, 1706, 1612+, 1606+ and extend-3.2

\n
\n

Setup prerequisites for CFDEM®project:

\n

Prerequisites for OpenFOAM® can be found here .\nOn an Ubuntu system (16.04+), you can use the following

\n
sudo apt-get install build-essential flex bison cmake zlib1g-dev libboost-system-dev libboost-thread-dev libopenmpi-dev openmpi-bin gnuplot libreadline-dev libncurses-dev libxt-dev libscotch-dev libptscotch-dev\n
\n
\n

CFDEM®project requires OpenFOAM® with a working MPI version.\nOptional, but strongly recommended is the use of VTK . VTK is used to directly write data in vtk format, which is readable by ParaView . The minimum version is VTK 6.3, recommended is 8.0.1. On debian-based systems it is sufficient to run

\n
sudo apt-get install libvtk7-dev\n
\n
\n

For manual VTK compilation, please read the additional installation hints .

\n

The post-processing tool lpp requires the python numpy package.

\n
sudo apt-get install python-numpy\n
\n
\n
\n

Setup and compile OpenFOAM®

\n

You can follow the OpenFOAM® git compilation instructions , with a small number of exceptions:\nCFDEM®coupling requires the WM_LABEL_SIZE=32 , which is the standard setting.

\n

On an Ubuntu system (16.04+), you can use the following steps to install OpenFOAM®:

\n
gedit ~/.bashrc\nadd the following two lines in the end, where <NofProcs> is the integer number of the processors you want to compile with. Save and exit gedit.\n"export WM_NCOMPPROCS=<NofProcs>"\n"source $HOME/OpenFOAM/OpenFOAM-<OF-Release>/etc/bashrc"\nnow again in the terminal:\nsource ~/.bashrc\ncd $WM_PROJECT_DIR\nfoamSystemCheck\n./Allwmake\n
\n
\n

Additional OpenFOAM® installation hints can be found here .

\n
\n

Set environment variables and paths

\n

Typically the CFDEM®coupling folder is tagged with the OpenFOAM® version number. To do this, perform the following steps:

\n
cd $HOME/CFDEM\nmv CFDEMcoupling-PUBLIC CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION\n
\n
\n

You need to set some environment variables in ~/.bashrc (if you use c-shell, manipulate ~/.cshrc accordingly). Open your .bashrc and the CFDEM®coupling bashrc file.

\n
gedit ~/.bashrc $HOME/CFDEM/CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION/src/lagrangian/cfdemParticle/etc/bashrc\n
\n
\n

Add the STANDARD block to the end of your bashrc and modify entries if necessary. Make sure the statements are not comments; remove the “#”. Similar to:

\n
#================================================#\n#- source cfdem env vars\nexport CFDEM_VERSION=PUBLIC\nexport CFDEM_PROJECT_DIR=$HOME/CFDEM/CFDEMcoupling-$CFDEM_VERSION-$WM_PROJECT_VERSION\nexport CFDEM_PROJECT_USER_DIR=$HOME/CFDEM/$LOGNAME-$CFDEM_VERSION-$WM_PROJECT_VERSION\nexport CFDEM_bashrc=$CFDEM_PROJECT_DIR/src/lagrangian/cfdemParticle/etc/bashrc\nexport CFDEM_LIGGGHTS_SRC_DIR=$HOME/LIGGGHTS/LIGGGHTS-PUBLIC/src\nexport CFDEM_LIGGGHTS_MAKEFILE_NAME=auto\nexport CFDEM_LPP_DIR=$HOME/LIGGGHTS/lpp/src\n. $CFDEM_bashrc\n#================================================#\n
\n
\n

You may insert the EXTENDED block above “. $CFDEM_bashrc” for further customization.\nThe detailed description for allowed entries can be found here .

\n

To load and check the environment you can run now

\n
source ~/.bashrc\ncfdemSysTest\n
\n
\n
\n

Note

\n

Many useful aliases are set with sourcing of the CFDEMcoupling bashrc, e.g. cfdemEtc . Make use of them!

\n
\n
\n

Compile LIGGGHTS® and CFDEM®coupling

\n

To compile CFDEM®project open a new terminal and run

\n
cfdemCompCFDEMall\n
\n
\n

It compiles the LIGGGHTS® executable, LIGGGHTS® as a shared library, the CFDEM®coupling libraries, CFDEM®coupling solvers and CFDEM®coupling utilities. The compilation will stop, if build errors occur. Having a previous manually compiled LIGGGHTS® is not enough, it needs to be compiled as shared library with the cfdemCompLIG command.

\n

As step by step compilation of only specific parts, the following commands are available:

\n
cfdemCompLIG\ncfdemCompCFDEMsrc\ncfdemCompCFDEMsol\ncfdemCompCFDEMuti\n
\n
\n

The compilation is automatically logged and the logs can be found in:

\n
$CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/log\n
\n
\n

In case questions concerning the installation arise, please feel free to contact our forum at `www.cfdem.com <lws_>`_ .

\n
\n

Run your own cases

\n

If you want to run your own cases, please do so in $CFDEM_PROJECT_USER_DIR/run which is automatically being generated. E.g. copy one of the tutorial cases there, adapt it to your needs.\nChanges in $CFDEM_TUT_DIR might be lost after every git stash.

\n

You can run all the tutorial cases by executing the alias cfdemTestTUT.\nAlternatively you can run each tutorial using the Allrun.sh scripts in the tutorial directories.

\n

To run pure LIGGGHTS® cases, you can use the aliases

\n
cfdemLiggghts inputScriptName\ncfdemLiggghtsPar inputScriptName nOfProcs\n
\n
\n

or you can set a link in /usr/local/bin to the LIGGGHTS® executable as described in the LIGGGHTS®documentation .

\n
\n

Backwards Compatibility:

\n

Basically CFDEM®coupling supports one OpenFOAM® version therefore all settings are prepared for that. Nevertheless we try to maintain backwards compatibility as long as it works with reasonable effort.

\n

The supported OpenFOAM® and LIGGGHTS® versions are stated in:\nsrc/lagrangian/cfdemParticle/cfdTools/versionInfo.H

\n

For using other versions you can manipulate:\nsrc/lagrangian/cfdemParticle/etc/OFversion/OFversion.H\n(still not all functionality might work then!)

\n
\n

Installation, additional information

\n
\n

Procedure:

\n\n
\n

Setup prerequisites for CFDEM®project:

\n

If you need to compile VTK on your machine yourself, we recommend version 8.0.1, which is available here . The installation guide is available here .\nHowever, if you use the Makefile auto in LIGGGHTS you may set AUTOINSTALL_VTK to “ON” to automatically download and compile VTK.

\n

Please note the VTK components necessary need cmake, MPI and some X11 libraries on your machine. Compilation using ccmake is recommended. In the standard configuration MPI related packages are disabled. Enable Parallel / MPI packages during configuration. For VTK-6.3 set VTK_Group_MPI:BOOL=ON .

\n
\n

Setup and compile OpenFOAM®

\n

All mentions of OpenFOAM® refer to this .

\n

Often problems arise configuring OpenFOAM® to work with a specific MPI installation on a cluster. However it has built-in capability to work with nearly any MPI implementation.\nSet the following variable in the OpenFOAM® bashrc:

\n
export WM_MPLIB=SYSTEMMPI\n
\n
\n

Defining the following variables in your ~/.bashrc BEFORE the sourcing of OpenFOAM® will take care of the rest. This is an example for older MVAPICH installations where there is no libmpi.so, only libmpich.so

\n
export MPI_ROOT=<path/to/mpi/installation>\nexport MPI_ARCH_PATH=$MPI_ROOT\nexport MPI_ARCH_FLAGS="-DMPICH_SKIP_MPICXX"\nexport MPI_ARCH_INC="-I$MPI_ARCH_PATH/include"\nexport MPI_ARCH_LIBS='-L$(MPI_ARCH_PATH)/lib -lmpich -lmpichcxx -lmpl -lopa -lrt'\n
\n
\n
\n

Set environment variables and paths

\n

Detailed description of the environment variables:

\n

standard block:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

CFDEM_VERSION

CFDEMcoupling branch name; e.g. PUBLIC

CFDEM_PROJECT_DIR

path to the installation directory of CFDEM®coupling

CFDEM_PROJECT_USER_DIR

path to the user directory; used to store users simulation cases and source-code

CFDEM_bashrc

location of the CFDEM®coupling bashrc (or cshrc)

which sets up the environment

CFDEM_LIGGGHTS_SRC_DIR

path to the LIGGGHTS src directory

CFDEM_LIGGGHTS_MAKEFILE_NAME

Name of the LIGGGHTS® Makefile which defines how to compile LIGGGHTS®; more information on which Makefile to select is within the LIGGGHTS® documentation; standard is auto

CFDEM_LPP_DIR path

to the src directory of the local lpp installation

\n

extended block may be inserted above “. $CFDEM_bashrc”:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

CFDEM_SRC_DIR

can be used to use alternative src directory

CFDEM_SOLVER_DIR

can be used to use alternative solver directory

CFDEM_DOC_DIR

can be used to use alternative doc directory

CFDEM_UT_DIR

can be used to use alternative utilities directory

CFDEM_TUT_DIR

can be used to use alternative tutorials directory

CFDEM_LIGGGHTS_MAKEFILE_POSTIFX

if you wish to compile LIGGGHTS® to CFDEM®coupling with a postfix auto Makefile; for more information on postfixes please read the LIGGGHTS® documentation

CFDEM_VERBOSE

if set to false

standard output of environment variables is suppressed

\n
\n

additionalLibs:

\n

The additionalLibs are used as a centralized system for adding libraries and paths to CFDEM®coupling compilations. There is and automated detection of your OpenFOAM® version, which should select the proper additionalLibs file.\nIf the automated selection of the additionalLibs fails or if you wish to set it manually to a specific file, you may set the following environment variables above “. $CFDEM_bashrc”:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n

CFDEM_ADD_LIBS_DIR

path containing the user-defined additionalLibs file

CFDEM_ADD_LIBS_NAME

filename of the user-defined additionalLibs file

\n

even further customization with variables:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

CFDEM_LAMMPS_LIB_DIR

alternative path to LIGGGHTS® lib folder containing additional LIGGGHTS® packages; e.g. ASPHERE

CFDEM_LIGGGHTS_LIB_PATH

path to compiled LIGGGHTS® library; useful if the compiled LIGGGHTS® library has manually been moved from the LIGGGHTS® src path to an alternative location

CFDEM_LIB_DIR

alternative target directory for CFDEM®coupling libraries

CFDEM_USER_LIB_DIR

alternative target directory for CFDEM®coupling user-libraries

CFDEM_APP_DIR

alternative target directory for CFDEMcoupling executables

CFDEM_USER_APP_DIR

alternative target directory for CFDEM®coupling user-executables

\n
\n

Compile LIGGGHTS® and CFDEM®coupling

\n

LIGGGHTS® needs to be compiled as library with the cfdemCompLIG command. You can compile LIGGGHTS® manually as a shared library with

\n
make -f Makefile.shlib <Makefilename>\n
\n
\n

within your LIGGGHTS® src directory.\nLIGGGHTS® is included into CFDEM®coupling by the creation of a symbolic link in $CFDEM_LIB_DIR to the LIGGGHTS shared library. This link is automatically created during the compilation of the CFDEM®coupling lagrangian library at the beginning of the make phase. This means even if you compile the lagrangian library manually with “wmake libso”, the link is created.

\n
\n

Compiling OpenFOAM®, LIGGGHTS® and CFDEM®coupling in debug mode

\n

Set the WM_COMPILE_OPTION parameter in the OF bashrc to “Debug” and compile OF with the Allwmake script.\nIf you are using the LIGGGHTS® auto Makefile, simply compile LIGGGHTS® and CFDEM®coupling with “cfdemCompCFDEMall”. CFDEM®coupling detects the OpenFOAM® variable compiles LIGGGHTS® in debug mode. The coupling itself is compiled with OpenFOAM®s wmake, so this is automatically taken care of.\nIf you aren’t using the auto Makefile, you need to make sure the “-O0 -g” or “-O2 -g” compilation parameters are set properly within the LIGGGHTS®-Makefile.

\n
\n

Footnotes:

\n

OPENFOAM® is a registered trade mark of OpenCFD Limited, producer and distributor of the OpenFOAM software via wwww.openfoam.org.

\n
\n
\n
\n

Tutorials

\n

General:

\n

Each solver of the CFDEM®coupling comes with at least one tutorial example, showing its functionality and correct usage. Provided that the installation is correct, the tutorials can be run via “Allrun.sh” shell scripts. These scripts perform all necessary steps (preprocessing, run, postprocessing, visualization).

\n

Location:

\n

The tutorials can be found in the directory $CFDEM_PROJECT_DIR/tutorials, which can be reached by typing “cfdemTut”

\n

Structure:

\n

Each case is structured in a directory called “CFD” covering the CFD relevant settings and data, and a dirctory called “DEM” covering the DEM relevant settings and data. This allows to easily expand a pure CFD or DEM simulation case to a coupled case.

\n

Usage:

\n

Provided that the installation is correct, the tutorials can be run via “Allrun.sh” shell script, executed by typing “./Allrun.sh”. The successful run of the script might need some third party software (e.g. octave, evince, etc.).

\n

A typical Allrun.sh script executes the following steps:

\n
    \n

  • DEM: LIGGGHTS init run

    • \n

  • CFD: mesh generation (blockMesh)

    • \n

  • CFD: mesh decomposition (decomposePar)

    • \n

  • CFDEM: parallel CFDEM run; mpirun -np X cfdemSolverXXX -parallel

    • \n

  • post-processing

    • \n
\n

Settings:

\n

The main settings of a simulation are done via dictionaries:

\n

The DEM setup of each case is defined by a LIGGGHTS® input file located in $caseDir/DEM (e.g. in.liggghts_init). For details on the LIGGGHTS® setup, please have a look at the LIGGGHTS® manual.

\n

Standard CFD settings are defined in $caseDir/CFD/constant (e.g. transportProperties, RASproperties, etc.) and $caseDir/CFD/system (e.g. fvSchemes, controlDict). For settings related to the solver such as discretization schemes, solution settings for the equations and solver control (e.g. corrector or non-orthogonal corrector steps for non-orthogonal meshes) you can find more information in OpenFOAM®(*) documentations (www.openFoam.com)(*).

\n

Settings of the coupling routines are defined in $caseDir/CFD/constant/couplingProperies (e.g. force models, data exchange model, etc.) and $caseDir/CFD/constant/liggghtsCommands (allows to execute a LIGGGHTS® command during a coupled simulation).

\n
\n
\n
\n

“couplingProperties” dictionary

\n

General:

\n

In the “couplingProperties” dictionary the setup of the coupling routines of the CFD-DEM simulation are defined.

\n

Location: $caseDir/CFD/constant

\n

Structure:

\n

The dictionary is divided into two parts, “sub-models & settings” and “sub-model properties”.

\n

In “sub-models & settings” the following routines must be specified:

\n
    \n

  • modelType

    • \n

  • couplingInterval

    • \n

  • voidFractionModel

    • \n

  • locateModel

    • \n

  • meshMotionModel

    • \n

  • IOModel

    • \n

  • probeModel

    • \n

  • dataExchangeModel

    • \n

  • averagingModel

    • \n

  • clockModel

    • \n

  • smoothingModel

    • \n

  • forceModels

    • \n

  • momCoupleModels

    • \n

  • turbulenceModelType

    • \n
\n

The following keywords may be specified:

\n
    \n

  • particleShapeType

    • \n

  • solveFlow

    • \n

  • expCorrDeltaUError

    • \n
\n

In “sub-model properties” sub-dictionaries might be defined to specify model specific parameters.

\n

Settings:

\n

Reasonable example settings for the “couplingProperties” dictionary are given in the tutorial cases.

\n
particleShapeType\n
\n
\n

The particleShapeType keyword defines which particle shape is used. The default value for the particleShapeType\nis “sphere”. Further valid values are “multisphere”, “superquadric”, and “convex”. For the PUBLIC version of\nCFDEM®coupling only the particleShapeType sphere is available.

\n
solveFlow\n
\n
\n

The solveFlow switch determines, whether the fluid equations are solved or not. By setting solveFlow to false, the fluid solver becomes inactive.

\n
expCorrDeltaUError\n
\n
\n

The switch expCorrDeltaUError can be used with solvers capable of handling explicit volumetric forces on the fluid.\nImplicit force coupling will result in a typically small difference in the coupling force exerted on the particles and the fluid, i.e., Newton’s Third Law will be conflicted. This error can be calculated by TotalError(dU) = Ksl*(Uf_preStep-Uf_postStep), since CFD experiences new Uf values, while particles only experience drag with Uf_postStep. expCorrDeltaUError set to on will correct for this error in an explicit fashion. Typically, correcting for this error results in a less stable solution. The sum of this error normalized by the total implicit drag is displayed during the simulation.

\n
modelType\n
\n
\n

“modelType” refers to the formulation of the equations to be solved. Choose “A”, “B” or “Bfull”, according to Zhou et al. (2010): “Discrete particle simulation of particle-fluid flow: model formulations and their applicability”, JFM. “A” requires the use of the force models gradPForce and viscForce, whereas “B” requires the force model “Archimedes”. “Bfull” refers to model type I, “A” refers to model type II and “B” refers to type III in the nomenclature used by Zhou et al.

\n
couplingInterval\n
\n
\n

The coupling interval determines the time passing between two CFD-DEM data exchanges.

\n

A useful procedure would be:

\n
    \n

  1. Set the DEM timestep in the in.xxx file according to the needs of the pure DEM problem.

    2. \n

  2. Set the “couplingInterval”, which refers to the DEM timesteps. Depending on the problem you will need to have a close (small couplingInterval) or loose coupling.

    3. \n

  3. Choose the CFD timestep in the controlDict. It must be equal to or smaller than the coupling time, otherwise you will get the error: “Error - TS bigger than coupling interval!”.

    4. \n

  4. To ensure a synchronous run, the coupling time should be a multiple of the CFD timestep, or you’ll get a warning “Warning - Coupling time (= DEM time step * coupling interval) is not a multiple of CFD time-step!”

    5. \n
\n

Example: DEMts=1.0e-5s, couplingInterval=10 exchange data (=couple) will happen every 1.0e-4s.

\n
\n
\n
\n

“liggghtsCommands” dictionary

\n

General:

\n

In the “liggghtsCommands” dictionary LIGGGHTS® commands being executed during a coupled CFD-DEM simulation are specified.\nThe most important command is the “run” command. After the start-up read of the LIGGGHTS®-input-script it is fed by CFDEM®coupling\nwith commands. User-defined commands may be added.

\n

Location: $caseDir/CFD/constant

\n

Structure:

\n

The dictionary is divided into two parts, first a list of “liggghtsCommandModels” is defined, then the settings for each model must be specified.

\n

Settings:

\n

Reasonable example settings for the “liggghtsCommands” dictionary are given in the tutorial cases.

\n
\n
\n
\n

“chemistryProperties” dictionary

\n

Remark:

\n

This functionality is not available in the PUBLIC version of CFDEM®coupling!

\n

General:

\n

In the “chemistryProperties” dictionary different properties required for the numerical intragration of the chemical reactions, like chemistry solver and parameters for void fraction dependend reaction speed, are defined. Equations for corresponding chemical reactions must be defined in “reactions” file. For documentation of chemistry solver parameters and “reactions” file please refer to OpenFOAM® documentation. Parameters ffor void fraction dependend reactions are listed in VoidChemistryModelProps section. Available chemistry solvers in CFDEM®coupling are “EulerImplicitVoid” and “odeVoid” that have the same functionality as “EulerImplicit” and “ode” solvers in OpenFOAM®.

\n

Location: $caseDir/CFD/constant

\n

Structure:

\n
VoidChemistryModelProps\n{\n    solidSpecies\n    {\n         solidSpecie1;\n         solidSpecie2;\n         ...\n    }\n    gasReactionCoeffs\n    {\n        useVoidFractionCorrection "switch1";\n        gasSpecie1 "scalar01";\n        gasSpecie2 "scalar02";\n        gasSpecie3 "scalar03";\n        ...\n        e1 "scalar11";\n        e2 "scalar12";\n        e3 "scalar13";\n        e4 "scalar14";\n        e5 "scalar15";\n        e6 "scalar16";\n    }\n    solidProps\n     {\n        particles scalar20;\n        solidSpecie1 scalar21;\n        solidSpecie2 scalar22;\n        ...\n     }\n}
\n
    \n

  • Entry solidSpecies contains the list of the ids of the species that are treated as solid

    • \n

  • Entry gasReactionCoeffs contains parameters for void fraction corrected reaction rate for reaction with id gasReaction. Note that this entry must be defined for every reaction separately. Note that reaction id in chemistryProperties must be identical to that in reactions file

    • \n

  • switch1 = (optional, normally false) flag to use void fraction corrected reaction rate model

    • \n

  • If none of the solid species are present in the reaction with id gasReaction than the following equation is used for calculating the speed of chemical reaction:

    • \n
\n\"Eqs/ReactionRate1.png\"\n

otherwise

\n\"Eqs/ReactionRate2.png\"\n
    \n

  • where epsilon is the void fraction, c_1 , c_2, c_3 ,.. are the molar concetrations of reactants (species on the left hand side the equation for gasReaction), Asolids is the cumulative particle surface area, Nparticles is the number of particles located in the volume V. dp , mp and Ap are the average diameter, mass and surface area of particles in volume V.\nr_0 is the reaction rate normally calculated by Arrhenius reaction rate model (defined in reactions file for each reaction separately). scalar01, scalar02, scalar03, .. are the stoichiometric coefficients for gasSpecie1 , gasSpecie2 , gasSpecie3 ,.. for the reactants required for calculating r (= alpha , beta , gamma ,.. ). These parameters are optional and taken from the equation of gasReaction defined in reactions file.

    • \n

  • scalar11, scalar12, scalar13, scalar14, scalar15, scalar16 (optional, default are 0) are the exponents e1 , e2 , e3 , e4 , e5 , e6 in the above listed equations for the reaction speed.

    • \n
\n

w_1 , w_2 , .. are the mass concentrations of the solid species on the particle, including particle material. Parameters scalar21, scalar22, .. (optional, default values are 0) are the coefficients epsilon, delta , etc. in equation (2)

\n

For calculation of Asolids particleCellSurface force model must be used. For calculation of dp , mp , Ap and Nparticles LaEuFilmFormation force model must be used. Note that these force models cannot be used together in one simulation.

\n

Example:

\n
VoidChemistryModelProps\n{\n    solidSpecies\n    {\n        C;\n    }\n    gasReactionCoeffs\n    {\n        useVoidFractionCorrection true;\n        CH4 1;\n        e1 0.0;\n        e2 0.1;\n        e3 0.0;\n        e4 0.0;\n        e5 0.0;\n        e6 0.0;\n    }\n     solidProps\n     {\n        particles 0.5;\n        C 0.5;\n     }\n}\n
\n
\n
\n
\n
\n

Models/Solvers

\n

This section lists all CFDEMcoupling sub-models and solvers alphabetically, with a separate\nlisting below of styles within certain commands.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

IOModel

IOModel_basicIO

IOModel_noIO

IOModel_sophIO

IOModel_trackIO

averagingModel

averagingModel_dense

averagingModel_dilute

cfdemSolverIB

cfdemSolverPiso

cfdemSolverPisoSTM

cfdemSolverPisoScalar

clockModel

clockModel_noClock

clockModel_standardClock

couple/cfd

couple/cfd/force

dataExchangeModel

dataExchangeModel_noDataExchange

dataExchangeModel_oneWayVTK

dataExchangeModel_twoWayFiles

dataExchangeModel_twoWayMPI

forceModel

forceModel_Archimedes

forceModel_ArchimedesIB

forceModel_DiFeliceDrag

forceModel_GidaspowDrag

forceModel_KochHillDrag

forceModel_LaEuScalarTemp

forceModel_MeiLift

forceModel_SchillerNaumannDrag

forceModel_ShirgaonkarIB

forceModel_checkCouplingInterval

forceModel_fieldStore

forceModel_fieldTimeAverage

forceModel_gradPForce

forceModel_noDrag

forceModel_particleCellVolume

forceModel_particleVolume

forceModel_periodicPressure

forceModel_scalarGeneralExchange

forceModel_virtualMassForce

forceModel_viscForce

forceModel_volWeightedAverage

forceSubModel

forceSubModel_ImEx

fvOptions_meanSupVelocityForce

liggghtsCommandModel

liggghtsCommandModel_execute

liggghtsCommandModel_readLiggghtsData

liggghtsCommandModel_runLiggghts

liggghtsCommandModel_setDEMGravity

liggghtsCommandModel_writeLiggghts

locateModel

locateModel_engineSearch

locateModel_engineSearchIB

locateModel_standardSearch

meshMotionModel

meshMotionModel_noMeshMotion

momCoupleModel

momCoupleModel_explicitCouple

momCoupleModel_implicitCouple

momCoupleModel_noCouple

probeModel

probeModel_noProbe

probeModel_particleProbe

scalarTransportModel

scalarTransportModel_generalManual

smoothingModel

smoothingModel_constDiffSmoothing

smoothingModel_noSmoothing

voidfractionModel

voidfractionModel_GaussVoidFraction

voidfractionModel_IBVoidFraction

voidfractionModel_bigParticleVoidFraction

voidfractionModel_centreVoidFraction

voidfractionModel_dividedVoidFraction

voidfractionModel_noVoidFractionVoidFraction

voidfractionModel_trilinearVoidFraction

\n
\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/IOModel.html", "content": "\n\n\n \n\n \n IOModel command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • IOModel command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

IOModel command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
IOModel "model";\n
\n
\n
    \n

  • model = name of IO-model to be applied

    • \n
\n
\n
\n

Examples

\n

IOModel “off”;

\n
\n

Note

\n

This examples list might not be complete - please look for other models (IOModel_XY) in this documentation.

\n
\n
\n
\n

Description

\n

The IO-model is the base class to write data (e.g. particle properties) to files within the CFD file-structure.

\n
\n
\n

Restrictions

\n

none.

\n
\n
\n

Related commands

\n

basicIO, noIO, sophIO, trackIO

\n

Default: none.

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/IOModel_basicIO.html", "content": "\n\n\n \n\n \n IOModel_basicIO command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • IOModel_basicIO command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

IOModel_basicIO command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
IOModel "basicIO";\n
\n
\n
\n
\n

Examples

\n
IOModel "basicIO";\n
\n
\n
\n
\n

Description

\n

The basic IO-model writes particle positions velocities and radii to files. The default output directory ($casePath/CFD/proc*/time/lagrangian). Using the keyword “serialOutput;” in couplingProperties the IO is serial to the directory ($casePath/CFD/lagrangian). In the latter case only the data on processor 0 is written! Data is written every write time of the CFD simulation.

\n
\n
\n

Restrictions

\n
\n

None.

\n
\n
\n
\n

Related commands

\n

IOModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/IOModel_noIO.html", "content": "\n\n\n \n\n \n IOModel_noIO command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • IOModel_noIO command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

IOModel_noIO command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
IOModel "off";\n
\n
\n
\n
\n

Examples

\n
IOModel "off";\n
\n
\n
\n
\n

Description

\n

The noIO-model is a dummy IO model.

\n
\n
\n

Restrictions

\n
\n

None.

\n
\n
\n
\n

Related commands

\n

IOModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/IOModel_sophIO.html", "content": "\n\n\n \n\n \n IOModel_sophIO command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • IOModel_sophIO command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

IOModel_sophIO command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
IOModel "sophIO";\n
\n
\n
\n
\n

Examples

\n
IOModel "sophIO";\n
\n
\n
\n
\n

Description

\n

The sophIO-model is based on basicIO model and additionally writes voidfraction, implicit forces, explicit forces. Data is written every write time of the CFD simulation.

\n
\n
\n

Restrictions

\n
\n

None.

\n
\n
\n
\n

Related commands

\n

IOModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/IOModel_trackIO.html", "content": "\n\n\n \n\n \n IOModel_trackIO command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • IOModel_trackIO command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

IOModel_trackIO command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
IOModel "trackIO";\n
\n
\n
\n
\n

Examples

\n
IOModel "trackIO";\n
\n
\n
\n
\n

Description

\n

The trackIO-model writes in addition to basicIO fields the particleID from LIGGGHTS. This id can be used with Paraviews TemporalParticlesToPathlines filter to generate particle path-lines in post-processing.

\n
\n
\n

Restrictions

\n
\n

None.

\n
\n
\n
\n

Related commands

\n

IOModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/_static/basic.css", "content": "/*\n * basic.css\n * ~~~~~~~~~\n *\n * Sphinx stylesheet -- basic theme.\n *\n * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.\n * :license: BSD, see LICENSE for details.\n *\n */\n\n/* -- main layout ----------------------------------------------------------- */\n\ndiv.clearer {\n clear: both;\n}\n\ndiv.section::after {\n display: block;\n content: '';\n clear: left;\n}\n\n/* -- relbar ---------------------------------------------------------------- */\n\ndiv.related {\n width: 100%;\n font-size: 90%;\n}\n\ndiv.related h3 {\n display: none;\n}\n\ndiv.related ul {\n margin: 0;\n padding: 0 0 0 10px;\n list-style: none;\n}\n\ndiv.related li {\n display: inline;\n}\n\ndiv.related li.right {\n float: right;\n margin-right: 5px;\n}\n\n/* -- sidebar --------------------------------------------------------------- */\n\ndiv.sphinxsidebarwrapper {\n padding: 10px 5px 0 10px;\n}\n\ndiv.sphinxsidebar {\n float: left;\n width: 230px;\n margin-left: -100%;\n font-size: 90%;\n word-wrap: break-word;\n overflow-wrap : break-word;\n}\n\ndiv.sphinxsidebar ul {\n list-style: none;\n}\n\ndiv.sphinxsidebar ul ul,\ndiv.sphinxsidebar ul.want-points {\n margin-left: 20px;\n list-style: square;\n}\n\ndiv.sphinxsidebar ul ul {\n margin-top: 0;\n margin-bottom: 0;\n}\n\ndiv.sphinxsidebar form {\n margin-top: 10px;\n}\n\ndiv.sphinxsidebar input {\n border: 1px solid #98dbcc;\n font-family: sans-serif;\n font-size: 1em;\n}\n\ndiv.sphinxsidebar #searchbox form.search {\n overflow: hidden;\n}\n\ndiv.sphinxsidebar #searchbox input[type=\"text\"] {\n float: left;\n width: 80%;\n padding: 0.25em;\n box-sizing: border-box;\n}\n\ndiv.sphinxsidebar #searchbox input[type=\"submit\"] {\n float: left;\n width: 20%;\n border-left: none;\n padding: 0.25em;\n box-sizing: border-box;\n}\n\n\nimg {\n border: 0;\n max-width: 100%;\n}\n\n/* -- search page ----------------------------------------------------------- */\n\nul.search {\n margin: 10px 0 0 20px;\n padding: 0;\n}\n\nul.search li {\n padding: 5px 0 5px 20px;\n background-image: url(file.png);\n background-repeat: no-repeat;\n background-position: 0 7px;\n}\n\nul.search li a {\n font-weight: bold;\n}\n\nul.search li p.context {\n color: #888;\n margin: 2px 0 0 30px;\n text-align: left;\n}\n\nul.keywordmatches li.goodmatch a {\n font-weight: bold;\n}\n\n/* -- index page ------------------------------------------------------------ */\n\ntable.contentstable {\n width: 90%;\n margin-left: auto;\n margin-right: auto;\n}\n\ntable.contentstable p.biglink {\n line-height: 150%;\n}\n\na.biglink {\n font-size: 1.3em;\n}\n\nspan.linkdescr {\n font-style: italic;\n padding-top: 5px;\n font-size: 90%;\n}\n\n/* -- general index --------------------------------------------------------- */\n\ntable.indextable {\n width: 100%;\n}\n\ntable.indextable td {\n text-align: left;\n vertical-align: top;\n}\n\ntable.indextable ul {\n margin-top: 0;\n margin-bottom: 0;\n list-style-type: none;\n}\n\ntable.indextable > tbody > tr > td > ul {\n padding-left: 0em;\n}\n\ntable.indextable tr.pcap {\n height: 10px;\n}\n\ntable.indextable tr.cap {\n margin-top: 10px;\n background-color: #f2f2f2;\n}\n\nimg.toggler {\n margin-right: 3px;\n margin-top: 3px;\n cursor: pointer;\n}\n\ndiv.modindex-jumpbox {\n border-top: 1px solid #ddd;\n border-bottom: 1px solid #ddd;\n margin: 1em 0 1em 0;\n padding: 0.4em;\n}\n\ndiv.genindex-jumpbox {\n border-top: 1px solid #ddd;\n border-bottom: 1px solid #ddd;\n margin: 1em 0 1em 0;\n padding: 0.4em;\n}\n\n/* -- domain module index --------------------------------------------------- */\n\ntable.modindextable td {\n padding: 2px;\n border-collapse: collapse;\n}\n\n/* -- general body styles --------------------------------------------------- */\n\ndiv.body {\n min-width: 450px;\n max-width: 800px;\n}\n\ndiv.body p, div.body dd, div.body li, div.body blockquote {\n -moz-hyphens: auto;\n -ms-hyphens: auto;\n -webkit-hyphens: auto;\n hyphens: auto;\n}\n\na.headerlink {\n visibility: hidden;\n}\n\na.brackets:before,\nspan.brackets > a:before{\n content: \"[\";\n}\n\na.brackets:after,\nspan.brackets > a:after {\n content: \"]\";\n}\n\nh1:hover > a.headerlink,\nh2:hover > a.headerlink,\nh3:hover > a.headerlink,\nh4:hover > a.headerlink,\nh5:hover > a.headerlink,\nh6:hover > a.headerlink,\ndt:hover > a.headerlink,\ncaption:hover > a.headerlink,\np.caption:hover > a.headerlink,\ndiv.code-block-caption:hover > a.headerlink {\n visibility: visible;\n}\n\ndiv.body p.caption {\n text-align: inherit;\n}\n\ndiv.body td {\n text-align: left;\n}\n\n.first {\n margin-top: 0 !important;\n}\n\np.rubric {\n margin-top: 30px;\n font-weight: bold;\n}\n\nimg.align-left, figure.align-left, .figure.align-left, object.align-left {\n clear: left;\n float: left;\n margin-right: 1em;\n}\n\nimg.align-right, figure.align-right, .figure.align-right, object.align-right {\n clear: right;\n float: right;\n margin-left: 1em;\n}\n\nimg.align-center, figure.align-center, .figure.align-center, object.align-center {\n display: block;\n margin-left: auto;\n margin-right: auto;\n}\n\nimg.align-default, figure.align-default, .figure.align-default {\n display: block;\n margin-left: auto;\n margin-right: auto;\n}\n\n.align-left {\n text-align: left;\n}\n\n.align-center {\n text-align: center;\n}\n\n.align-default {\n text-align: center;\n}\n\n.align-right {\n text-align: right;\n}\n\n/* -- sidebars -------------------------------------------------------------- */\n\ndiv.sidebar,\naside.sidebar {\n margin: 0 0 0.5em 1em;\n border: 1px solid #ddb;\n padding: 7px;\n background-color: #ffe;\n width: 40%;\n float: right;\n clear: right;\n overflow-x: auto;\n}\n\np.sidebar-title {\n font-weight: bold;\n}\n\ndiv.admonition, div.topic, blockquote {\n clear: left;\n}\n\n/* -- topics ---------------------------------------------------------------- */\n\ndiv.topic {\n border: 1px solid #ccc;\n padding: 7px;\n margin: 10px 0 10px 0;\n}\n\np.topic-title {\n font-size: 1.1em;\n font-weight: bold;\n margin-top: 10px;\n}\n\n/* -- admonitions ----------------------------------------------------------- */\n\ndiv.admonition {\n margin-top: 10px;\n margin-bottom: 10px;\n padding: 7px;\n}\n\ndiv.admonition dt {\n font-weight: bold;\n}\n\np.admonition-title {\n margin: 0px 10px 5px 0px;\n font-weight: bold;\n}\n\ndiv.body p.centered {\n text-align: center;\n margin-top: 25px;\n}\n\n/* -- content of sidebars/topics/admonitions -------------------------------- */\n\ndiv.sidebar > :last-child,\naside.sidebar > :last-child,\ndiv.topic > :last-child,\ndiv.admonition > :last-child {\n margin-bottom: 0;\n}\n\ndiv.sidebar::after,\naside.sidebar::after,\ndiv.topic::after,\ndiv.admonition::after,\nblockquote::after {\n display: block;\n content: '';\n clear: both;\n}\n\n/* -- tables ---------------------------------------------------------------- */\n\ntable.docutils {\n margin-top: 10px;\n margin-bottom: 10px;\n border: 0;\n border-collapse: collapse;\n}\n\ntable.align-center {\n margin-left: auto;\n margin-right: auto;\n}\n\ntable.align-default {\n margin-left: auto;\n margin-right: auto;\n}\n\ntable caption span.caption-number {\n font-style: italic;\n}\n\ntable caption span.caption-text {\n}\n\ntable.docutils td, table.docutils th {\n padding: 1px 8px 1px 5px;\n border-top: 0;\n border-left: 0;\n border-right: 0;\n border-bottom: 1px solid #aaa;\n}\n\ntable.footnote td, table.footnote th {\n border: 0 !important;\n}\n\nth {\n text-align: left;\n padding-right: 5px;\n}\n\ntable.citation {\n border-left: solid 1px gray;\n margin-left: 1px;\n}\n\ntable.citation td {\n border-bottom: none;\n}\n\nth > :first-child,\ntd > :first-child {\n margin-top: 0px;\n}\n\nth > :last-child,\ntd > :last-child {\n margin-bottom: 0px;\n}\n\n/* -- figures --------------------------------------------------------------- */\n\ndiv.figure, figure {\n margin: 0.5em;\n padding: 0.5em;\n}\n\ndiv.figure p.caption, figcaption {\n padding: 0.3em;\n}\n\ndiv.figure p.caption span.caption-number,\nfigcaption span.caption-number {\n font-style: italic;\n}\n\ndiv.figure p.caption span.caption-text,\nfigcaption span.caption-text {\n}\n\n/* -- field list styles ----------------------------------------------------- */\n\ntable.field-list td, table.field-list th {\n border: 0 !important;\n}\n\n.field-list ul {\n margin: 0;\n padding-left: 1em;\n}\n\n.field-list p {\n margin: 0;\n}\n\n.field-name {\n -moz-hyphens: manual;\n -ms-hyphens: manual;\n -webkit-hyphens: manual;\n hyphens: manual;\n}\n\n/* -- hlist styles ---------------------------------------------------------- */\n\ntable.hlist {\n margin: 1em 0;\n}\n\ntable.hlist td {\n vertical-align: top;\n}\n\n/* -- object description styles --------------------------------------------- */\n\n.sig {\n\tfont-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;\n}\n\n.sig-name, code.descname {\n background-color: transparent;\n font-weight: bold;\n}\n\n.sig-name {\n\tfont-size: 1.1em;\n}\n\ncode.descname {\n font-size: 1.2em;\n}\n\n.sig-prename, code.descclassname {\n background-color: transparent;\n}\n\n.optional {\n font-size: 1.3em;\n}\n\n.sig-paren {\n font-size: larger;\n}\n\n.sig-param.n {\n\tfont-style: italic;\n}\n\n/* C++ specific styling */\n\n.sig-inline.c-texpr,\n.sig-inline.cpp-texpr {\n\tfont-family: unset;\n}\n\n.sig.c .k, .sig.c .kt,\n.sig.cpp .k, .sig.cpp .kt {\n\tcolor: #0033B3;\n}\n\n.sig.c .m,\n.sig.cpp .m {\n\tcolor: #1750EB;\n}\n\n.sig.c .s, .sig.c .sc,\n.sig.cpp .s, .sig.cpp .sc {\n\tcolor: #067D17;\n}\n\n\n/* -- other body styles ----------------------------------------------------- */\n\nol.arabic {\n list-style: decimal;\n}\n\nol.loweralpha {\n list-style: lower-alpha;\n}\n\nol.upperalpha {\n list-style: upper-alpha;\n}\n\nol.lowerroman {\n list-style: lower-roman;\n}\n\nol.upperroman {\n list-style: upper-roman;\n}\n\n:not(li) > ol > li:first-child > :first-child,\n:not(li) > ul > li:first-child > :first-child {\n margin-top: 0px;\n}\n\n:not(li) > ol > li:last-child > :last-child,\n:not(li) > ul > li:last-child > :last-child {\n margin-bottom: 0px;\n}\n\nol.simple ol p,\nol.simple ul p,\nul.simple ol p,\nul.simple ul p {\n margin-top: 0;\n}\n\nol.simple > li:not(:first-child) > p,\nul.simple > li:not(:first-child) > p {\n margin-top: 0;\n}\n\nol.simple p,\nul.simple p {\n margin-bottom: 0;\n}\n\ndl.footnote > dt,\ndl.citation > dt {\n float: left;\n margin-right: 0.5em;\n}\n\ndl.footnote > dd,\ndl.citation > dd {\n margin-bottom: 0em;\n}\n\ndl.footnote > dd:after,\ndl.citation > dd:after {\n content: \"\";\n clear: both;\n}\n\ndl.field-list {\n display: grid;\n grid-template-columns: fit-content(30%) auto;\n}\n\ndl.field-list > dt {\n font-weight: bold;\n word-break: break-word;\n padding-left: 0.5em;\n padding-right: 5px;\n}\n\ndl.field-list > dt:after {\n content: \":\";\n}\n\ndl.field-list > dd {\n padding-left: 0.5em;\n margin-top: 0em;\n margin-left: 0em;\n margin-bottom: 0em;\n}\n\ndl {\n margin-bottom: 15px;\n}\n\ndd > :first-child {\n margin-top: 0px;\n}\n\ndd ul, dd table {\n margin-bottom: 10px;\n}\n\ndd {\n margin-top: 3px;\n margin-bottom: 10px;\n margin-left: 30px;\n}\n\ndl > dd:last-child,\ndl > dd:last-child > :last-child {\n margin-bottom: 0;\n}\n\ndt:target, span.highlighted {\n background-color: #fbe54e;\n}\n\nrect.highlighted {\n fill: #fbe54e;\n}\n\ndl.glossary dt {\n font-weight: bold;\n font-size: 1.1em;\n}\n\n.versionmodified {\n font-style: italic;\n}\n\n.system-message {\n background-color: #fda;\n padding: 5px;\n border: 3px solid red;\n}\n\n.footnote:target {\n background-color: #ffa;\n}\n\n.line-block {\n display: block;\n margin-top: 1em;\n margin-bottom: 1em;\n}\n\n.line-block .line-block {\n margin-top: 0;\n margin-bottom: 0;\n margin-left: 1.5em;\n}\n\n.guilabel, .menuselection {\n font-family: sans-serif;\n}\n\n.accelerator {\n text-decoration: underline;\n}\n\n.classifier {\n font-style: oblique;\n}\n\n.classifier:before {\n font-style: normal;\n margin: 0 0.5em;\n content: \":\";\n display: inline-block;\n}\n\nabbr, acronym {\n border-bottom: dotted 1px;\n cursor: help;\n}\n\n/* -- code displays --------------------------------------------------------- */\n\npre {\n overflow: auto;\n overflow-y: hidden; /* fixes display issues on Chrome browsers */\n}\n\npre, div[class*=\"highlight-\"] {\n clear: both;\n}\n\nspan.pre {\n -moz-hyphens: none;\n -ms-hyphens: none;\n -webkit-hyphens: none;\n hyphens: none;\n}\n\ndiv[class*=\"highlight-\"] {\n margin: 1em 0;\n}\n\ntd.linenos pre {\n border: 0;\n background-color: transparent;\n color: #aaa;\n}\n\ntable.highlighttable {\n display: block;\n}\n\ntable.highlighttable tbody {\n display: block;\n}\n\ntable.highlighttable tr {\n display: flex;\n}\n\ntable.highlighttable td {\n margin: 0;\n padding: 0;\n}\n\ntable.highlighttable td.linenos {\n padding-right: 0.5em;\n}\n\ntable.highlighttable td.code {\n flex: 1;\n overflow: hidden;\n}\n\n.highlight .hll {\n display: block;\n}\n\ndiv.highlight pre,\ntable.highlighttable pre {\n margin: 0;\n}\n\ndiv.code-block-caption + div {\n margin-top: 0;\n}\n\ndiv.code-block-caption {\n margin-top: 1em;\n padding: 2px 5px;\n font-size: small;\n}\n\ndiv.code-block-caption code {\n background-color: transparent;\n}\n\ntable.highlighttable td.linenos,\nspan.linenos,\ndiv.highlight span.gp { /* gp: Generic.Prompt */\n user-select: none;\n -webkit-user-select: text; /* Safari fallback only */\n -webkit-user-select: none; /* Chrome/Safari */\n -moz-user-select: none; /* Firefox */\n -ms-user-select: none; /* IE10+ */\n}\n\ndiv.code-block-caption span.caption-number {\n padding: 0.1em 0.3em;\n font-style: italic;\n}\n\ndiv.code-block-caption span.caption-text {\n}\n\ndiv.literal-block-wrapper {\n margin: 1em 0;\n}\n\ncode.xref, a code {\n background-color: transparent;\n font-weight: bold;\n}\n\nh1 code, h2 code, h3 code, h4 code, h5 code, h6 code {\n background-color: transparent;\n}\n\n.viewcode-link {\n float: right;\n}\n\n.viewcode-back {\n float: right;\n font-family: sans-serif;\n}\n\ndiv.viewcode-block:target {\n margin: -1px -10px;\n padding: 0 10px;\n}\n\n/* -- math display ---------------------------------------------------------- */\n\nimg.math {\n vertical-align: middle;\n}\n\ndiv.body div.math p {\n text-align: center;\n}\n\nspan.eqno {\n float: right;\n}\n\nspan.eqno a.headerlink {\n position: absolute;\n z-index: 1;\n}\n\ndiv.math:hover a.headerlink {\n visibility: visible;\n}\n\n/* -- printout stylesheet --------------------------------------------------- */\n\n@media print {\n div.document,\n div.documentwrapper,\n div.bodywrapper {\n margin: 0 !important;\n width: 100%;\n }\n\n div.sphinxsidebar,\n div.related,\n div.footer,\n #top-link {\n display: none;\n }\n}" }, { "path": "doc/_build/html/_static/css/badge_only.css", "content": ".fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:\"\"}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:normal;src:url(\"../fonts/fontawesome-webfont.eot?#iefix\") format(\"embedded-opentype\"),url(\"../fonts/fontawesome-webfont.woff2\") format(\"woff2\"),url(\"../fonts/fontawesome-webfont.woff\") format(\"woff\"),url(\"../fonts/fontawesome-webfont.ttf\") format(\"truetype\"),url(\"../fonts/fontawesome-webfont.svg#FontAwesome\") format(\"svg\")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:\"\"}.icon-book:before{content:\"\"}.fa-caret-down:before{content:\"\"}.icon-caret-down:before{content:\"\"}.fa-caret-up:before{content:\"\"}.icon-caret-up:before{content:\"\"}.fa-caret-left:before{content:\"\"}.icon-caret-left:before{content:\"\"}.fa-caret-right:before{content:\"\"}.icon-caret-right:before{content:\"\"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:\"Lato\",\"proxima-nova\",\"Helvetica Neue\",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60}.rst-versions .rst-current-version::after{clear:both;content:\"\";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge .fa-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}\n" }, { "path": "doc/_build/html/_static/css/theme.css", "content": "html{box-sizing:border-box}*,*::after,*::before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}audio:not([controls]){display:none}[hidden]{display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:hover,a:active{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;color:#000;text-decoration:none}mark{background:#ff0;color:#000;font-style:italic;font-weight:bold}pre,code,.rst-content tt,.rst-content code,kbd,samp{font-family:monospace,serif;_font-family:\"courier new\",monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:before,q:after{content:\"\";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}ul,ol,dl{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure{margin:0}form{margin:0}fieldset{border:0;margin:0;padding:0}label{cursor:pointer}legend{border:0;*margin-left:-7px;padding:0;white-space:normal}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=\"button\"],input[type=\"reset\"],input[type=\"submit\"]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=\"checkbox\"],input[type=\"radio\"]{box-sizing:border-box;padding:0;*width:13px;*height:13px}input[type=\"search\"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type=\"search\"]::-webkit-search-decoration,input[type=\"search\"]::-webkit-search-cancel-button{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}textarea{overflow:auto;vertical-align:top;resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none !important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{html,body,section{background:none !important}*{box-shadow:none !important;text-shadow:none !important;filter:none !important;-ms-filter:none !important}a,a:visited{text-decoration:underline}.ir a:after,a[href^=\"javascript:\"]:after,a[href^=\"#\"]:after{content:\"\"}pre,blockquote{page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:.5cm}p,h2,.rst-content .toctree-wrapper>p.caption,h3{orphans:3;widows:3}h2,.rst-content .toctree-wrapper>p.caption,h3{page-break-after:avoid}}.fa:before,.wy-menu-vertical li button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.rst-content p .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.rst-content .admonition,.btn,input[type=\"text\"],input[type=\"password\"],input[type=\"email\"],input[type=\"url\"],input[type=\"date\"],input[type=\"month\"],input[type=\"time\"],input[type=\"datetime\"],input[type=\"datetime-local\"],input[type=\"week\"],input[type=\"number\"],input[type=\"search\"],input[type=\"tel\"],input[type=\"color\"],select,textarea,.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a,.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a,.wy-nav-top a{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:\"\"}.clearfix:after{clear:both}/*!\n * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome\n * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License)\n */@font-face{font-family:'FontAwesome';src:url(\"../fonts/fontawesome-webfont.eot?v=4.7.0\");src:url(\"../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0\") format(\"embedded-opentype\"),url(\"../fonts/fontawesome-webfont.woff2?v=4.7.0\") format(\"woff2\"),url(\"../fonts/fontawesome-webfont.woff?v=4.7.0\") format(\"woff\"),url(\"../fonts/fontawesome-webfont.ttf?v=4.7.0\") format(\"truetype\"),url(\"../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular\") format(\"svg\");font-weight:normal;font-style:normal}.fa,.wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li.current>a button.toctree-expand,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content tt.download span:first-child,.rst-content code.download span:first-child,.icon{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.3333333333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.2857142857em;text-align:center}.fa-ul{padding-left:0;margin-left:2.1428571429em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.1428571429em;width:2.1428571429em;top:.1428571429em;text-align:center}.fa-li.fa-lg{left:-1.8571428571em}.fa-border{padding:.2em .25em .15em;border:solid 0.08em #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa.fa-pull-left,.wy-menu-vertical li button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.rst-content .fa-pull-left.admonition-title,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content dl dt .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.rst-content code.download span.fa-pull-left:first-child,.fa-pull-left.icon{margin-right:.3em}.fa.fa-pull-right,.wy-menu-vertical li button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.rst-content .fa-pull-right.admonition-title,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content dl dt .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.rst-content code.download span.fa-pull-right:first-child,.fa-pull-right.icon{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.wy-menu-vertical li button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.rst-content .pull-left.admonition-title,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content dl dt .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.rst-content code.download span.pull-left:first-child,.pull-left.icon{margin-right:.3em}.fa.pull-right,.wy-menu-vertical li button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.rst-content .pull-right.admonition-title,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content dl dt .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.rst-content code.download span.pull-right:first-child,.pull-right.icon{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s infinite linear;animation:fa-spin 2s infinite linear}.fa-pulse{-webkit-animation:fa-spin 1s infinite steps(8);animation:fa-spin 1s infinite steps(8)}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:\"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)\";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:\"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)\";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:\"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)\";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:\"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)\";-webkit-transform:scale(-1, 1);-ms-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{-ms-filter:\"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)\";-webkit-transform:scale(1, -1);-ms-transform:scale(1, -1);transform:scale(1, -1)}:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270,:root .fa-flip-horizontal,:root .fa-flip-vertical{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:\"\"}.fa-music:before{content:\"\"}.fa-search:before,.icon-search:before{content:\"\"}.fa-envelope-o:before{content:\"\"}.fa-heart:before{content:\"\"}.fa-star:before{content:\"\"}.fa-star-o:before{content:\"\"}.fa-user:before{content:\"\"}.fa-film:before{content:\"\"}.fa-th-large:before{content:\"\"}.fa-th:before{content:\"\"}.fa-th-list:before{content:\"\"}.fa-check:before{content:\"\"}.fa-remove:before,.fa-close:before,.fa-times:before{content:\"\"}.fa-search-plus:before{content:\"\"}.fa-search-minus:before{content:\"\"}.fa-power-off:before{content:\"\"}.fa-signal:before{content:\"\"}.fa-gear:before,.fa-cog:before{content:\"\"}.fa-trash-o:before{content:\"\"}.fa-home:before,.icon-home:before{content:\"\"}.fa-file-o:before{content:\"\"}.fa-clock-o:before{content:\"\"}.fa-road:before{content:\"\"}.fa-download:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{content:\"\"}.fa-arrow-circle-o-down:before{content:\"\"}.fa-arrow-circle-o-up:before{content:\"\"}.fa-inbox:before{content:\"\"}.fa-play-circle-o:before{content:\"\"}.fa-rotate-right:before,.fa-repeat:before{content:\"\"}.fa-refresh:before{content:\"\"}.fa-list-alt:before{content:\"\"}.fa-lock:before{content:\"\"}.fa-flag:before{content:\"\"}.fa-headphones:before{content:\"\"}.fa-volume-off:before{content:\"\"}.fa-volume-down:before{content:\"\"}.fa-volume-up:before{content:\"\"}.fa-qrcode:before{content:\"\"}.fa-barcode:before{content:\"\"}.fa-tag:before{content:\"\"}.fa-tags:before{content:\"\"}.fa-book:before,.icon-book:before{content:\"\"}.fa-bookmark:before{content:\"\"}.fa-print:before{content:\"\"}.fa-camera:before{content:\"\"}.fa-font:before{content:\"\"}.fa-bold:before{content:\"\"}.fa-italic:before{content:\"\"}.fa-text-height:before{content:\"\"}.fa-text-width:before{content:\"\"}.fa-align-left:before{content:\"\"}.fa-align-center:before{content:\"\"}.fa-align-right:before{content:\"\"}.fa-align-justify:before{content:\"\"}.fa-list:before{content:\"\"}.fa-dedent:before,.fa-outdent:before{content:\"\"}.fa-indent:before{content:\"\"}.fa-video-camera:before{content:\"\"}.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:\"\"}.fa-pencil:before{content:\"\"}.fa-map-marker:before{content:\"\"}.fa-adjust:before{content:\"\"}.fa-tint:before{content:\"\"}.fa-edit:before,.fa-pencil-square-o:before{content:\"\"}.fa-share-square-o:before{content:\"\"}.fa-check-square-o:before{content:\"\"}.fa-arrows:before{content:\"\"}.fa-step-backward:before{content:\"\"}.fa-fast-backward:before{content:\"\"}.fa-backward:before{content:\"\"}.fa-play:before{content:\"\"}.fa-pause:before{content:\"\"}.fa-stop:before{content:\"\"}.fa-forward:before{content:\"\"}.fa-fast-forward:before{content:\"\"}.fa-step-forward:before{content:\"\"}.fa-eject:before{content:\"\"}.fa-chevron-left:before{content:\"\"}.fa-chevron-right:before{content:\"\"}.fa-plus-circle:before{content:\"\"}.fa-minus-circle:before{content:\"\"}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:\"\"}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:\"\"}.fa-question-circle:before{content:\"\"}.fa-info-circle:before{content:\"\"}.fa-crosshairs:before{content:\"\"}.fa-times-circle-o:before{content:\"\"}.fa-check-circle-o:before{content:\"\"}.fa-ban:before{content:\"\"}.fa-arrow-left:before{content:\"\"}.fa-arrow-right:before{content:\"\"}.fa-arrow-up:before{content:\"\"}.fa-arrow-down:before{content:\"\"}.fa-mail-forward:before,.fa-share:before{content:\"\"}.fa-expand:before{content:\"\"}.fa-compress:before{content:\"\"}.fa-plus:before{content:\"\"}.fa-minus:before{content:\"\"}.fa-asterisk:before{content:\"\"}.fa-exclamation-circle:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.rst-content .admonition-title:before{content:\"\"}.fa-gift:before{content:\"\"}.fa-leaf:before{content:\"\"}.fa-fire:before,.icon-fire:before{content:\"\"}.fa-eye:before{content:\"\"}.fa-eye-slash:before{content:\"\"}.fa-warning:before,.fa-exclamation-triangle:before{content:\"\"}.fa-plane:before{content:\"\"}.fa-calendar:before{content:\"\"}.fa-random:before{content:\"\"}.fa-comment:before{content:\"\"}.fa-magnet:before{content:\"\"}.fa-chevron-up:before{content:\"\"}.fa-chevron-down:before{content:\"\"}.fa-retweet:before{content:\"\"}.fa-shopping-cart:before{content:\"\"}.fa-folder:before{content:\"\"}.fa-folder-open:before{content:\"\"}.fa-arrows-v:before{content:\"\"}.fa-arrows-h:before{content:\"\"}.fa-bar-chart-o:before,.fa-bar-chart:before{content:\"\"}.fa-twitter-square:before{content:\"\"}.fa-facebook-square:before{content:\"\"}.fa-camera-retro:before{content:\"\"}.fa-key:before{content:\"\"}.fa-gears:before,.fa-cogs:before{content:\"\"}.fa-comments:before{content:\"\"}.fa-thumbs-o-up:before{content:\"\"}.fa-thumbs-o-down:before{content:\"\"}.fa-star-half:before{content:\"\"}.fa-heart-o:before{content:\"\"}.fa-sign-out:before{content:\"\"}.fa-linkedin-square:before{content:\"\"}.fa-thumb-tack:before{content:\"\"}.fa-external-link:before{content:\"\"}.fa-sign-in:before{content:\"\"}.fa-trophy:before{content:\"\"}.fa-github-square:before{content:\"\"}.fa-upload:before{content:\"\"}.fa-lemon-o:before{content:\"\"}.fa-phone:before{content:\"\"}.fa-square-o:before{content:\"\"}.fa-bookmark-o:before{content:\"\"}.fa-phone-square:before{content:\"\"}.fa-twitter:before{content:\"\"}.fa-facebook-f:before,.fa-facebook:before{content:\"\"}.fa-github:before,.icon-github:before{content:\"\"}.fa-unlock:before{content:\"\"}.fa-credit-card:before{content:\"\"}.fa-feed:before,.fa-rss:before{content:\"\"}.fa-hdd-o:before{content:\"\"}.fa-bullhorn:before{content:\"\"}.fa-bell:before{content:\"\"}.fa-certificate:before{content:\"\"}.fa-hand-o-right:before{content:\"\"}.fa-hand-o-left:before{content:\"\"}.fa-hand-o-up:before{content:\"\"}.fa-hand-o-down:before{content:\"\"}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:\"\"}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:\"\"}.fa-arrow-circle-up:before{content:\"\"}.fa-arrow-circle-down:before{content:\"\"}.fa-globe:before{content:\"\"}.fa-wrench:before{content:\"\"}.fa-tasks:before{content:\"\"}.fa-filter:before{content:\"\"}.fa-briefcase:before{content:\"\"}.fa-arrows-alt:before{content:\"\"}.fa-group:before,.fa-users:before{content:\"\"}.fa-chain:before,.fa-link:before,.icon-link:before{content:\"\"}.fa-cloud:before{content:\"\"}.fa-flask:before{content:\"\"}.fa-cut:before,.fa-scissors:before{content:\"\"}.fa-copy:before,.fa-files-o:before{content:\"\"}.fa-paperclip:before{content:\"\"}.fa-save:before,.fa-floppy-o:before{content:\"\"}.fa-square:before{content:\"\"}.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:\"\"}.fa-list-ul:before{content:\"\"}.fa-list-ol:before{content:\"\"}.fa-strikethrough:before{content:\"\"}.fa-underline:before{content:\"\"}.fa-table:before{content:\"\"}.fa-magic:before{content:\"\"}.fa-truck:before{content:\"\"}.fa-pinterest:before{content:\"\"}.fa-pinterest-square:before{content:\"\"}.fa-google-plus-square:before{content:\"\"}.fa-google-plus:before{content:\"\"}.fa-money:before{content:\"\"}.fa-caret-down:before,.wy-dropdown .caret:before,.icon-caret-down:before{content:\"\"}.fa-caret-up:before{content:\"\"}.fa-caret-left:before{content:\"\"}.fa-caret-right:before{content:\"\"}.fa-columns:before{content:\"\"}.fa-unsorted:before,.fa-sort:before{content:\"\"}.fa-sort-down:before,.fa-sort-desc:before{content:\"\"}.fa-sort-up:before,.fa-sort-asc:before{content:\"\"}.fa-envelope:before{content:\"\"}.fa-linkedin:before{content:\"\"}.fa-rotate-left:before,.fa-undo:before{content:\"\"}.fa-legal:before,.fa-gavel:before{content:\"\"}.fa-dashboard:before,.fa-tachometer:before{content:\"\"}.fa-comment-o:before{content:\"\"}.fa-comments-o:before{content:\"\"}.fa-flash:before,.fa-bolt:before{content:\"\"}.fa-sitemap:before{content:\"\"}.fa-umbrella:before{content:\"\"}.fa-paste:before,.fa-clipboard:before{content:\"\"}.fa-lightbulb-o:before{content:\"\"}.fa-exchange:before{content:\"\"}.fa-cloud-download:before{content:\"\"}.fa-cloud-upload:before{content:\"\"}.fa-user-md:before{content:\"\"}.fa-stethoscope:before{content:\"\"}.fa-suitcase:before{content:\"\"}.fa-bell-o:before{content:\"\"}.fa-coffee:before{content:\"\"}.fa-cutlery:before{content:\"\"}.fa-file-text-o:before{content:\"\"}.fa-building-o:before{content:\"\"}.fa-hospital-o:before{content:\"\"}.fa-ambulance:before{content:\"\"}.fa-medkit:before{content:\"\"}.fa-fighter-jet:before{content:\"\"}.fa-beer:before{content:\"\"}.fa-h-square:before{content:\"\"}.fa-plus-square:before{content:\"\"}.fa-angle-double-left:before{content:\"\"}.fa-angle-double-right:before{content:\"\"}.fa-angle-double-up:before{content:\"\"}.fa-angle-double-down:before{content:\"\"}.fa-angle-left:before{content:\"\"}.fa-angle-right:before{content:\"\"}.fa-angle-up:before{content:\"\"}.fa-angle-down:before{content:\"\"}.fa-desktop:before{content:\"\"}.fa-laptop:before{content:\"\"}.fa-tablet:before{content:\"\"}.fa-mobile-phone:before,.fa-mobile:before{content:\"\"}.fa-circle-o:before{content:\"\"}.fa-quote-left:before{content:\"\"}.fa-quote-right:before{content:\"\"}.fa-spinner:before{content:\"\"}.fa-circle:before{content:\"\"}.fa-mail-reply:before,.fa-reply:before{content:\"\"}.fa-github-alt:before{content:\"\"}.fa-folder-o:before{content:\"\"}.fa-folder-open-o:before{content:\"\"}.fa-smile-o:before{content:\"\"}.fa-frown-o:before{content:\"\"}.fa-meh-o:before{content:\"\"}.fa-gamepad:before{content:\"\"}.fa-keyboard-o:before{content:\"\"}.fa-flag-o:before{content:\"\"}.fa-flag-checkered:before{content:\"\"}.fa-terminal:before{content:\"\"}.fa-code:before{content:\"\"}.fa-mail-reply-all:before,.fa-reply-all:before{content:\"\"}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:\"\"}.fa-location-arrow:before{content:\"\"}.fa-crop:before{content:\"\"}.fa-code-fork:before{content:\"\"}.fa-unlink:before,.fa-chain-broken:before{content:\"\"}.fa-question:before{content:\"\"}.fa-info:before{content:\"\"}.fa-exclamation:before{content:\"\"}.fa-superscript:before{content:\"\"}.fa-subscript:before{content:\"\"}.fa-eraser:before{content:\"\"}.fa-puzzle-piece:before{content:\"\"}.fa-microphone:before{content:\"\"}.fa-microphone-slash:before{content:\"\"}.fa-shield:before{content:\"\"}.fa-calendar-o:before{content:\"\"}.fa-fire-extinguisher:before{content:\"\"}.fa-rocket:before{content:\"\"}.fa-maxcdn:before{content:\"\"}.fa-chevron-circle-left:before{content:\"\"}.fa-chevron-circle-right:before{content:\"\"}.fa-chevron-circle-up:before{content:\"\"}.fa-chevron-circle-down:before{content:\"\"}.fa-html5:before{content:\"\"}.fa-css3:before{content:\"\"}.fa-anchor:before{content:\"\"}.fa-unlock-alt:before{content:\"\"}.fa-bullseye:before{content:\"\"}.fa-ellipsis-h:before{content:\"\"}.fa-ellipsis-v:before{content:\"\"}.fa-rss-square:before{content:\"\"}.fa-play-circle:before{content:\"\"}.fa-ticket:before{content:\"\"}.fa-minus-square:before{content:\"\"}.fa-minus-square-o:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li.current>a button.toctree-expand:before{content:\"\"}.fa-level-up:before{content:\"\"}.fa-level-down:before{content:\"\"}.fa-check-square:before{content:\"\"}.fa-pencil-square:before{content:\"\"}.fa-external-link-square:before{content:\"\"}.fa-share-square:before{content:\"\"}.fa-compass:before{content:\"\"}.fa-toggle-down:before,.fa-caret-square-o-down:before{content:\"\"}.fa-toggle-up:before,.fa-caret-square-o-up:before{content:\"\"}.fa-toggle-right:before,.fa-caret-square-o-right:before{content:\"\"}.fa-euro:before,.fa-eur:before{content:\"\"}.fa-gbp:before{content:\"\"}.fa-dollar:before,.fa-usd:before{content:\"\"}.fa-rupee:before,.fa-inr:before{content:\"\"}.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:\"\"}.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:\"\"}.fa-won:before,.fa-krw:before{content:\"\"}.fa-bitcoin:before,.fa-btc:before{content:\"\"}.fa-file:before{content:\"\"}.fa-file-text:before{content:\"\"}.fa-sort-alpha-asc:before{content:\"\"}.fa-sort-alpha-desc:before{content:\"\"}.fa-sort-amount-asc:before{content:\"\"}.fa-sort-amount-desc:before{content:\"\"}.fa-sort-numeric-asc:before{content:\"\"}.fa-sort-numeric-desc:before{content:\"\"}.fa-thumbs-up:before{content:\"\"}.fa-thumbs-down:before{content:\"\"}.fa-youtube-square:before{content:\"\"}.fa-youtube:before{content:\"\"}.fa-xing:before{content:\"\"}.fa-xing-square:before{content:\"\"}.fa-youtube-play:before{content:\"\"}.fa-dropbox:before{content:\"\"}.fa-stack-overflow:before{content:\"\"}.fa-instagram:before{content:\"\"}.fa-flickr:before{content:\"\"}.fa-adn:before{content:\"\"}.fa-bitbucket:before,.icon-bitbucket:before{content:\"\"}.fa-bitbucket-square:before{content:\"\"}.fa-tumblr:before{content:\"\"}.fa-tumblr-square:before{content:\"\"}.fa-long-arrow-down:before{content:\"\"}.fa-long-arrow-up:before{content:\"\"}.fa-long-arrow-left:before{content:\"\"}.fa-long-arrow-right:before{content:\"\"}.fa-apple:before{content:\"\"}.fa-windows:before{content:\"\"}.fa-android:before{content:\"\"}.fa-linux:before{content:\"\"}.fa-dribbble:before{content:\"\"}.fa-skype:before{content:\"\"}.fa-foursquare:before{content:\"\"}.fa-trello:before{content:\"\"}.fa-female:before{content:\"\"}.fa-male:before{content:\"\"}.fa-gittip:before,.fa-gratipay:before{content:\"\"}.fa-sun-o:before{content:\"\"}.fa-moon-o:before{content:\"\"}.fa-archive:before{content:\"\"}.fa-bug:before{content:\"\"}.fa-vk:before{content:\"\"}.fa-weibo:before{content:\"\"}.fa-renren:before{content:\"\"}.fa-pagelines:before{content:\"\"}.fa-stack-exchange:before{content:\"\"}.fa-arrow-circle-o-right:before{content:\"\"}.fa-arrow-circle-o-left:before{content:\"\"}.fa-toggle-left:before,.fa-caret-square-o-left:before{content:\"\"}.fa-dot-circle-o:before{content:\"\"}.fa-wheelchair:before{content:\"\"}.fa-vimeo-square:before{content:\"\"}.fa-turkish-lira:before,.fa-try:before{content:\"\"}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:\"\"}.fa-space-shuttle:before{content:\"\"}.fa-slack:before{content:\"\"}.fa-envelope-square:before{content:\"\"}.fa-wordpress:before{content:\"\"}.fa-openid:before{content:\"\"}.fa-institution:before,.fa-bank:before,.fa-university:before{content:\"\"}.fa-mortar-board:before,.fa-graduation-cap:before{content:\"\"}.fa-yahoo:before{content:\"\"}.fa-google:before{content:\"\"}.fa-reddit:before{content:\"\"}.fa-reddit-square:before{content:\"\"}.fa-stumbleupon-circle:before{content:\"\"}.fa-stumbleupon:before{content:\"\"}.fa-delicious:before{content:\"\"}.fa-digg:before{content:\"\"}.fa-pied-piper-pp:before{content:\"\"}.fa-pied-piper-alt:before{content:\"\"}.fa-drupal:before{content:\"\"}.fa-joomla:before{content:\"\"}.fa-language:before{content:\"\"}.fa-fax:before{content:\"\"}.fa-building:before{content:\"\"}.fa-child:before{content:\"\"}.fa-paw:before{content:\"\"}.fa-spoon:before{content:\"\"}.fa-cube:before{content:\"\"}.fa-cubes:before{content:\"\"}.fa-behance:before{content:\"\"}.fa-behance-square:before{content:\"\"}.fa-steam:before{content:\"\"}.fa-steam-square:before{content:\"\"}.fa-recycle:before{content:\"\"}.fa-automobile:before,.fa-car:before{content:\"\"}.fa-cab:before,.fa-taxi:before{content:\"\"}.fa-tree:before{content:\"\"}.fa-spotify:before{content:\"\"}.fa-deviantart:before{content:\"\"}.fa-soundcloud:before{content:\"\"}.fa-database:before{content:\"\"}.fa-file-pdf-o:before{content:\"\"}.fa-file-word-o:before{content:\"\"}.fa-file-excel-o:before{content:\"\"}.fa-file-powerpoint-o:before{content:\"\"}.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:\"\"}.fa-file-zip-o:before,.fa-file-archive-o:before{content:\"\"}.fa-file-sound-o:before,.fa-file-audio-o:before{content:\"\"}.fa-file-movie-o:before,.fa-file-video-o:before{content:\"\"}.fa-file-code-o:before{content:\"\"}.fa-vine:before{content:\"\"}.fa-codepen:before{content:\"\"}.fa-jsfiddle:before{content:\"\"}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:\"\"}.fa-circle-o-notch:before{content:\"\"}.fa-ra:before,.fa-resistance:before,.fa-rebel:before{content:\"\"}.fa-ge:before,.fa-empire:before{content:\"\"}.fa-git-square:before{content:\"\"}.fa-git:before{content:\"\"}.fa-y-combinator-square:before,.fa-yc-square:before,.fa-hacker-news:before{content:\"\"}.fa-tencent-weibo:before{content:\"\"}.fa-qq:before{content:\"\"}.fa-wechat:before,.fa-weixin:before{content:\"\"}.fa-send:before,.fa-paper-plane:before{content:\"\"}.fa-send-o:before,.fa-paper-plane-o:before{content:\"\"}.fa-history:before{content:\"\"}.fa-circle-thin:before{content:\"\"}.fa-header:before{content:\"\"}.fa-paragraph:before{content:\"\"}.fa-sliders:before{content:\"\"}.fa-share-alt:before{content:\"\"}.fa-share-alt-square:before{content:\"\"}.fa-bomb:before{content:\"\"}.fa-soccer-ball-o:before,.fa-futbol-o:before{content:\"\"}.fa-tty:before{content:\"\"}.fa-binoculars:before{content:\"\"}.fa-plug:before{content:\"\"}.fa-slideshare:before{content:\"\"}.fa-twitch:before{content:\"\"}.fa-yelp:before{content:\"\"}.fa-newspaper-o:before{content:\"\"}.fa-wifi:before{content:\"\"}.fa-calculator:before{content:\"\"}.fa-paypal:before{content:\"\"}.fa-google-wallet:before{content:\"\"}.fa-cc-visa:before{content:\"\"}.fa-cc-mastercard:before{content:\"\"}.fa-cc-discover:before{content:\"\"}.fa-cc-amex:before{content:\"\"}.fa-cc-paypal:before{content:\"\"}.fa-cc-stripe:before{content:\"\"}.fa-bell-slash:before{content:\"\"}.fa-bell-slash-o:before{content:\"\"}.fa-trash:before{content:\"\"}.fa-copyright:before{content:\"\"}.fa-at:before{content:\"\"}.fa-eyedropper:before{content:\"\"}.fa-paint-brush:before{content:\"\"}.fa-birthday-cake:before{content:\"\"}.fa-area-chart:before{content:\"\"}.fa-pie-chart:before{content:\"\"}.fa-line-chart:before{content:\"\"}.fa-lastfm:before{content:\"\"}.fa-lastfm-square:before{content:\"\"}.fa-toggle-off:before{content:\"\"}.fa-toggle-on:before{content:\"\"}.fa-bicycle:before{content:\"\"}.fa-bus:before{content:\"\"}.fa-ioxhost:before{content:\"\"}.fa-angellist:before{content:\"\"}.fa-cc:before{content:\"\"}.fa-shekel:before,.fa-sheqel:before,.fa-ils:before{content:\"\"}.fa-meanpath:before{content:\"\"}.fa-buysellads:before{content:\"\"}.fa-connectdevelop:before{content:\"\"}.fa-dashcube:before{content:\"\"}.fa-forumbee:before{content:\"\"}.fa-leanpub:before{content:\"\"}.fa-sellsy:before{content:\"\"}.fa-shirtsinbulk:before{content:\"\"}.fa-simplybuilt:before{content:\"\"}.fa-skyatlas:before{content:\"\"}.fa-cart-plus:before{content:\"\"}.fa-cart-arrow-down:before{content:\"\"}.fa-diamond:before{content:\"\"}.fa-ship:before{content:\"\"}.fa-user-secret:before{content:\"\"}.fa-motorcycle:before{content:\"\"}.fa-street-view:before{content:\"\"}.fa-heartbeat:before{content:\"\"}.fa-venus:before{content:\"\"}.fa-mars:before{content:\"\"}.fa-mercury:before{content:\"\"}.fa-intersex:before,.fa-transgender:before{content:\"\"}.fa-transgender-alt:before{content:\"\"}.fa-venus-double:before{content:\"\"}.fa-mars-double:before{content:\"\"}.fa-venus-mars:before{content:\"\"}.fa-mars-stroke:before{content:\"\"}.fa-mars-stroke-v:before{content:\"\"}.fa-mars-stroke-h:before{content:\"\"}.fa-neuter:before{content:\"\"}.fa-genderless:before{content:\"\"}.fa-facebook-official:before{content:\"\"}.fa-pinterest-p:before{content:\"\"}.fa-whatsapp:before{content:\"\"}.fa-server:before{content:\"\"}.fa-user-plus:before{content:\"\"}.fa-user-times:before{content:\"\"}.fa-hotel:before,.fa-bed:before{content:\"\"}.fa-viacoin:before{content:\"\"}.fa-train:before{content:\"\"}.fa-subway:before{content:\"\"}.fa-medium:before{content:\"\"}.fa-yc:before,.fa-y-combinator:before{content:\"\"}.fa-optin-monster:before{content:\"\"}.fa-opencart:before{content:\"\"}.fa-expeditedssl:before{content:\"\"}.fa-battery-4:before,.fa-battery:before,.fa-battery-full:before{content:\"\"}.fa-battery-3:before,.fa-battery-three-quarters:before{content:\"\"}.fa-battery-2:before,.fa-battery-half:before{content:\"\"}.fa-battery-1:before,.fa-battery-quarter:before{content:\"\"}.fa-battery-0:before,.fa-battery-empty:before{content:\"\"}.fa-mouse-pointer:before{content:\"\"}.fa-i-cursor:before{content:\"\"}.fa-object-group:before{content:\"\"}.fa-object-ungroup:before{content:\"\"}.fa-sticky-note:before{content:\"\"}.fa-sticky-note-o:before{content:\"\"}.fa-cc-jcb:before{content:\"\"}.fa-cc-diners-club:before{content:\"\"}.fa-clone:before{content:\"\"}.fa-balance-scale:before{content:\"\"}.fa-hourglass-o:before{content:\"\"}.fa-hourglass-1:before,.fa-hourglass-start:before{content:\"\"}.fa-hourglass-2:before,.fa-hourglass-half:before{content:\"\"}.fa-hourglass-3:before,.fa-hourglass-end:before{content:\"\"}.fa-hourglass:before{content:\"\"}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:\"\"}.fa-hand-stop-o:before,.fa-hand-paper-o:before{content:\"\"}.fa-hand-scissors-o:before{content:\"\"}.fa-hand-lizard-o:before{content:\"\"}.fa-hand-spock-o:before{content:\"\"}.fa-hand-pointer-o:before{content:\"\"}.fa-hand-peace-o:before{content:\"\"}.fa-trademark:before{content:\"\"}.fa-registered:before{content:\"\"}.fa-creative-commons:before{content:\"\"}.fa-gg:before{content:\"\"}.fa-gg-circle:before{content:\"\"}.fa-tripadvisor:before{content:\"\"}.fa-odnoklassniki:before{content:\"\"}.fa-odnoklassniki-square:before{content:\"\"}.fa-get-pocket:before{content:\"\"}.fa-wikipedia-w:before{content:\"\"}.fa-safari:before{content:\"\"}.fa-chrome:before{content:\"\"}.fa-firefox:before{content:\"\"}.fa-opera:before{content:\"\"}.fa-internet-explorer:before{content:\"\"}.fa-tv:before,.fa-television:before{content:\"\"}.fa-contao:before{content:\"\"}.fa-500px:before{content:\"\"}.fa-amazon:before{content:\"\"}.fa-calendar-plus-o:before{content:\"\"}.fa-calendar-minus-o:before{content:\"\"}.fa-calendar-times-o:before{content:\"\"}.fa-calendar-check-o:before{content:\"\"}.fa-industry:before{content:\"\"}.fa-map-pin:before{content:\"\"}.fa-map-signs:before{content:\"\"}.fa-map-o:before{content:\"\"}.fa-map:before{content:\"\"}.fa-commenting:before{content:\"\"}.fa-commenting-o:before{content:\"\"}.fa-houzz:before{content:\"\"}.fa-vimeo:before{content:\"\"}.fa-black-tie:before{content:\"\"}.fa-fonticons:before{content:\"\"}.fa-reddit-alien:before{content:\"\"}.fa-edge:before{content:\"\"}.fa-credit-card-alt:before{content:\"\"}.fa-codiepie:before{content:\"\"}.fa-modx:before{content:\"\"}.fa-fort-awesome:before{content:\"\"}.fa-usb:before{content:\"\"}.fa-product-hunt:before{content:\"\"}.fa-mixcloud:before{content:\"\"}.fa-scribd:before{content:\"\"}.fa-pause-circle:before{content:\"\"}.fa-pause-circle-o:before{content:\"\"}.fa-stop-circle:before{content:\"\"}.fa-stop-circle-o:before{content:\"\"}.fa-shopping-bag:before{content:\"\"}.fa-shopping-basket:before{content:\"\"}.fa-hashtag:before{content:\"\"}.fa-bluetooth:before{content:\"\"}.fa-bluetooth-b:before{content:\"\"}.fa-percent:before{content:\"\"}.fa-gitlab:before,.icon-gitlab:before{content:\"\"}.fa-wpbeginner:before{content:\"\"}.fa-wpforms:before{content:\"\"}.fa-envira:before{content:\"\"}.fa-universal-access:before{content:\"\"}.fa-wheelchair-alt:before{content:\"\"}.fa-question-circle-o:before{content:\"\"}.fa-blind:before{content:\"\"}.fa-audio-description:before{content:\"\"}.fa-volume-control-phone:before{content:\"\"}.fa-braille:before{content:\"\"}.fa-assistive-listening-systems:before{content:\"\"}.fa-asl-interpreting:before,.fa-american-sign-language-interpreting:before{content:\"\"}.fa-deafness:before,.fa-hard-of-hearing:before,.fa-deaf:before{content:\"\"}.fa-glide:before{content:\"\"}.fa-glide-g:before{content:\"\"}.fa-signing:before,.fa-sign-language:before{content:\"\"}.fa-low-vision:before{content:\"\"}.fa-viadeo:before{content:\"\"}.fa-viadeo-square:before{content:\"\"}.fa-snapchat:before{content:\"\"}.fa-snapchat-ghost:before{content:\"\"}.fa-snapchat-square:before{content:\"\"}.fa-pied-piper:before{content:\"\"}.fa-first-order:before{content:\"\"}.fa-yoast:before{content:\"\"}.fa-themeisle:before{content:\"\"}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:\"\"}.fa-fa:before,.fa-font-awesome:before{content:\"\"}.fa-handshake-o:before{content:\"\"}.fa-envelope-open:before{content:\"\"}.fa-envelope-open-o:before{content:\"\"}.fa-linode:before{content:\"\"}.fa-address-book:before{content:\"\"}.fa-address-book-o:before{content:\"\"}.fa-vcard:before,.fa-address-card:before{content:\"\"}.fa-vcard-o:before,.fa-address-card-o:before{content:\"\"}.fa-user-circle:before{content:\"\"}.fa-user-circle-o:before{content:\"\"}.fa-user-o:before{content:\"\"}.fa-id-badge:before{content:\"\"}.fa-drivers-license:before,.fa-id-card:before{content:\"\"}.fa-drivers-license-o:before,.fa-id-card-o:before{content:\"\"}.fa-quora:before{content:\"\"}.fa-free-code-camp:before{content:\"\"}.fa-telegram:before{content:\"\"}.fa-thermometer-4:before,.fa-thermometer:before,.fa-thermometer-full:before{content:\"\"}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:\"\"}.fa-thermometer-2:before,.fa-thermometer-half:before{content:\"\"}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:\"\"}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:\"\"}.fa-shower:before{content:\"\"}.fa-bathtub:before,.fa-s15:before,.fa-bath:before{content:\"\"}.fa-podcast:before{content:\"\"}.fa-window-maximize:before{content:\"\"}.fa-window-minimize:before{content:\"\"}.fa-window-restore:before{content:\"\"}.fa-times-rectangle:before,.fa-window-close:before{content:\"\"}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:\"\"}.fa-bandcamp:before{content:\"\"}.fa-grav:before{content:\"\"}.fa-etsy:before{content:\"\"}.fa-imdb:before{content:\"\"}.fa-ravelry:before{content:\"\"}.fa-eercast:before{content:\"\"}.fa-microchip:before{content:\"\"}.fa-snowflake-o:before{content:\"\"}.fa-superpowers:before{content:\"\"}.fa-wpexplorer:before{content:\"\"}.fa-meetup:before{content:\"\"}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li.current>a button.toctree-expand,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content tt.download span:first-child,.rst-content code.download span:first-child,.icon,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context{font-family:inherit}.fa:before,.wy-menu-vertical li button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.rst-content p .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before{font-family:\"FontAwesome\";display:inline-block;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa,a .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li.current>a button.toctree-expand,a .rst-content .admonition-title,.rst-content a .admonition-title,a .rst-content h1 .headerlink,.rst-content h1 a .headerlink,a .rst-content h2 .headerlink,.rst-content h2 a .headerlink,a .rst-content h3 .headerlink,.rst-content h3 a .headerlink,a .rst-content h4 .headerlink,.rst-content h4 a .headerlink,a .rst-content h5 .headerlink,.rst-content h5 a .headerlink,a .rst-content h6 .headerlink,.rst-content h6 a .headerlink,a .rst-content dl dt .headerlink,.rst-content dl dt a .headerlink,a .rst-content p .headerlink,.rst-content p a .headerlink,a .rst-content p.caption .headerlink,.rst-content p.caption a .headerlink,a .rst-content table>caption .headerlink,.rst-content table>caption a .headerlink,a .rst-content .code-block-caption .headerlink,.rst-content .code-block-caption a .headerlink,a .rst-content .eqno .headerlink,.rst-content .eqno a .headerlink,a .rst-content tt.download span:first-child,.rst-content tt.download a span:first-child,a .rst-content code.download span:first-child,.rst-content code.download a span:first-child,a .icon{display:inline-block;text-decoration:inherit}.btn .fa,.btn .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .btn button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.btn .wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.btn .rst-content .admonition-title,.rst-content .btn .admonition-title,.btn .rst-content h1 .headerlink,.rst-content h1 .btn .headerlink,.btn .rst-content h2 .headerlink,.rst-content h2 .btn .headerlink,.btn .rst-content h3 .headerlink,.rst-content h3 .btn .headerlink,.btn .rst-content h4 .headerlink,.rst-content h4 .btn .headerlink,.btn .rst-content h5 .headerlink,.rst-content h5 .btn .headerlink,.btn .rst-content h6 .headerlink,.rst-content h6 .btn .headerlink,.btn .rst-content dl dt .headerlink,.rst-content dl dt .btn .headerlink,.btn .rst-content p .headerlink,.rst-content p .btn .headerlink,.btn .rst-content table>caption .headerlink,.rst-content table>caption .btn .headerlink,.btn .rst-content .code-block-caption .headerlink,.rst-content .code-block-caption .btn .headerlink,.btn .rst-content .eqno .headerlink,.rst-content .eqno .btn .headerlink,.btn .rst-content tt.download span:first-child,.rst-content tt.download .btn span:first-child,.btn .rst-content code.download span:first-child,.rst-content code.download .btn span:first-child,.btn .icon,.nav .fa,.nav .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand,.nav .wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.nav .rst-content .admonition-title,.rst-content .nav .admonition-title,.nav .rst-content h1 .headerlink,.rst-content h1 .nav .headerlink,.nav .rst-content h2 .headerlink,.rst-content h2 .nav .headerlink,.nav .rst-content h3 .headerlink,.rst-content h3 .nav .headerlink,.nav .rst-content h4 .headerlink,.rst-content h4 .nav .headerlink,.nav .rst-content h5 .headerlink,.rst-content h5 .nav .headerlink,.nav .rst-content h6 .headerlink,.rst-content h6 .nav .headerlink,.nav .rst-content dl dt .headerlink,.rst-content dl dt .nav .headerlink,.nav .rst-content p .headerlink,.rst-content p .nav .headerlink,.nav .rst-content table>caption .headerlink,.rst-content table>caption .nav .headerlink,.nav .rst-content .code-block-caption .headerlink,.rst-content .code-block-caption .nav .headerlink,.nav .rst-content .eqno .headerlink,.rst-content .eqno .nav .headerlink,.nav .rst-content tt.download span:first-child,.rst-content tt.download .nav span:first-child,.nav .rst-content code.download span:first-child,.rst-content code.download .nav span:first-child,.nav .icon{display:inline}.btn .fa.fa-large,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.btn .rst-content .fa-large.admonition-title,.rst-content .btn .fa-large.admonition-title,.btn .rst-content h1 .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.btn .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .btn .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.btn .rst-content .code-block-caption .fa-large.headerlink,.rst-content .code-block-caption .btn .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.rst-content tt.download .btn span.fa-large:first-child,.btn .rst-content code.download span.fa-large:first-child,.rst-content code.download .btn span.fa-large:first-child,.btn .fa-large.icon,.nav .fa.fa-large,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand,.nav .rst-content .fa-large.admonition-title,.rst-content .nav .fa-large.admonition-title,.nav .rst-content h1 .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.nav .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.nav .rst-content .code-block-caption .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.nav .rst-content code.download span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.nav .fa-large.icon{line-height:.9em}.btn .fa.fa-spin,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.btn .rst-content .fa-spin.admonition-title,.rst-content .btn .fa-spin.admonition-title,.btn .rst-content h1 .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.btn .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .btn .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.btn .rst-content .code-block-caption .fa-spin.headerlink,.rst-content .code-block-caption .btn .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.rst-content tt.download .btn span.fa-spin:first-child,.btn .rst-content code.download span.fa-spin:first-child,.rst-content code.download .btn span.fa-spin:first-child,.btn .fa-spin.icon,.nav .fa.fa-spin,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand,.nav .rst-content .fa-spin.admonition-title,.rst-content .nav .fa-spin.admonition-title,.nav .rst-content h1 .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.nav .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.nav .rst-content .code-block-caption .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.nav .rst-content code.download span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.nav .fa-spin.icon{display:inline-block}.btn.fa:before,.wy-menu-vertical li button.btn.toctree-expand:before,.rst-content .btn.admonition-title:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content dl dt .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.rst-content code.download span.btn:first-child:before,.btn.icon:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.rst-content code.download span.btn:first-child:hover:before,.btn.icon:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before,.btn-mini .rst-content .admonition-title:before,.rst-content .btn-mini .admonition-title:before,.btn-mini .rst-content h1 .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.btn-mini .rst-content dl dt .headerlink:before,.rst-content dl dt .btn-mini .headerlink:before,.btn-mini .rst-content p .headerlink:before,.rst-content p .btn-mini .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.rst-content tt.download .btn-mini span:first-child:before,.btn-mini .rst-content code.download span:first-child:before,.rst-content code.download .btn-mini span:first-child:before,.btn-mini .icon:before{font-size:14px;vertical-align:-15%}.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.rst-content .admonition{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.wy-alert-title,.rst-content .admonition-title{color:#fff;font-weight:bold;display:block;color:#fff;background:#6ab0de;margin:-12px;padding:6px 12px;margin-bottom:12px}.wy-alert.wy-alert-danger,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.admonition{background:#fdf3f2}.wy-alert.wy-alert-danger .wy-alert-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .danger .wy-alert-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .danger .admonition-title,.rst-content .error .admonition-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition .admonition-title{background:#f29f97}.wy-alert.wy-alert-warning,.rst-content .wy-alert-warning.note,.rst-content .attention,.rst-content .caution,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.tip,.rst-content .warning,.rst-content .wy-alert-warning.seealso,.rst-content .admonition-todo,.rst-content .wy-alert-warning.admonition{background:#ffedcc}.wy-alert.wy-alert-warning .wy-alert-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .attention .wy-alert-title,.rst-content .caution .wy-alert-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .attention .admonition-title,.rst-content .caution .admonition-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .warning .admonition-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .admonition-todo .admonition-title,.rst-content .wy-alert-warning.admonition .admonition-title{background:#f0b37e}.wy-alert.wy-alert-info,.rst-content .note,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.rst-content .seealso,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.admonition{background:#e7f2fa}.wy-alert.wy-alert-info .wy-alert-title,.rst-content .note .wy-alert-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.rst-content .note .admonition-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .seealso .admonition-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition .admonition-title{background:#6ab0de}.wy-alert.wy-alert-success,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.warning,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.admonition{background:#dbfaf4}.wy-alert.wy-alert-success .wy-alert-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .hint .wy-alert-title,.rst-content .important .wy-alert-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .hint .admonition-title,.rst-content .important .admonition-title,.rst-content .tip .admonition-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition .admonition-title{background:#1abc9c}.wy-alert.wy-alert-neutral,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.admonition{background:#f3f6f6}.wy-alert.wy-alert-neutral .wy-alert-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition .admonition-title{color:#404040;background:#e1e4e5}.wy-alert.wy-alert-neutral a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a{color:#2980B9}.wy-alert p:last-child,.rst-content .note p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.rst-content .seealso p:last-child,.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0px;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,0.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27AE60}.wy-tray-container li.wy-tray-item-info{background:#2980B9}.wy-tray-container li.wy-tray-item-warning{background:#E67E22}.wy-tray-container li.wy-tray-item-danger{background:#E74C3C}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width: 768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px 12px;color:#fff;border:1px solid rgba(0,0,0,0.1);background-color:#27AE60;text-decoration:none;font-weight:normal;font-family:\"Lato\",\"proxima-nova\",\"Helvetica Neue\",Arial,sans-serif;box-shadow:0px 1px 2px -1px rgba(255,255,255,0.5) inset,0px -2px 0px 0px rgba(0,0,0,0.1) inset;outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:0px -1px 0px 0px rgba(0,0,0,0.05) inset,0px 2px 0px 0px rgba(0,0,0,0.1) inset;padding:8px 12px 6px 12px}.btn:visited{color:#fff}.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn-disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn-disabled:hover,.btn-disabled:focus,.btn-disabled:active{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980B9 !important}.btn-info:hover{background-color:#2e8ece !important}.btn-neutral{background-color:#f3f6f6 !important;color:#404040 !important}.btn-neutral:hover{background-color:#e5ebeb !important;color:#404040}.btn-neutral:visited{color:#404040 !important}.btn-success{background-color:#27AE60 !important}.btn-success:hover{background-color:#295 !important}.btn-danger{background-color:#E74C3C !important}.btn-danger:hover{background-color:#ea6153 !important}.btn-warning{background-color:#E67E22 !important}.btn-warning:hover{background-color:#e98b39 !important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f !important}.btn-link{background-color:transparent !important;color:#2980B9;box-shadow:none;border-color:transparent !important}.btn-link:hover{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:active{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:visited{color:#9B59B6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:before,.wy-btn-group:after{display:table;content:\"\"}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:solid 1px #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,0.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980B9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:solid 1px #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=\"search\"]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980B9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:\" \";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned input,.wy-form-aligned textarea,.wy-form-aligned select,.wy-form-aligned .wy-help-inline,.wy-form-aligned label{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{border:0;margin:0;padding:0}legend{display:block;width:100%;border:0;padding:0;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label{display:block;margin:0 0 .3125em 0;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;*zoom:1;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:before,.wy-control-group:after{display:table;content:\"\"}.wy-control-group:after{clear:both}.wy-control-group:before,.wy-control-group:after{display:table;content:\"\"}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:\" *\";color:#E74C3C}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full input[type=\"text\"],.wy-control-group .wy-form-full input[type=\"password\"],.wy-control-group .wy-form-full input[type=\"email\"],.wy-control-group .wy-form-full input[type=\"url\"],.wy-control-group .wy-form-full input[type=\"date\"],.wy-control-group .wy-form-full input[type=\"month\"],.wy-control-group .wy-form-full input[type=\"time\"],.wy-control-group .wy-form-full input[type=\"datetime\"],.wy-control-group .wy-form-full input[type=\"datetime-local\"],.wy-control-group .wy-form-full input[type=\"week\"],.wy-control-group .wy-form-full input[type=\"number\"],.wy-control-group .wy-form-full input[type=\"search\"],.wy-control-group .wy-form-full input[type=\"tel\"],.wy-control-group .wy-form-full input[type=\"color\"],.wy-control-group .wy-form-halves input[type=\"text\"],.wy-control-group .wy-form-halves input[type=\"password\"],.wy-control-group .wy-form-halves input[type=\"email\"],.wy-control-group .wy-form-halves input[type=\"url\"],.wy-control-group .wy-form-halves input[type=\"date\"],.wy-control-group .wy-form-halves input[type=\"month\"],.wy-control-group .wy-form-halves input[type=\"time\"],.wy-control-group .wy-form-halves input[type=\"datetime\"],.wy-control-group .wy-form-halves input[type=\"datetime-local\"],.wy-control-group .wy-form-halves input[type=\"week\"],.wy-control-group .wy-form-halves input[type=\"number\"],.wy-control-group .wy-form-halves input[type=\"search\"],.wy-control-group .wy-form-halves input[type=\"tel\"],.wy-control-group .wy-form-halves input[type=\"color\"],.wy-control-group .wy-form-thirds input[type=\"text\"],.wy-control-group .wy-form-thirds input[type=\"password\"],.wy-control-group .wy-form-thirds input[type=\"email\"],.wy-control-group .wy-form-thirds input[type=\"url\"],.wy-control-group .wy-form-thirds input[type=\"date\"],.wy-control-group .wy-form-thirds input[type=\"month\"],.wy-control-group .wy-form-thirds input[type=\"time\"],.wy-control-group .wy-form-thirds input[type=\"datetime\"],.wy-control-group .wy-form-thirds input[type=\"datetime-local\"],.wy-control-group .wy-form-thirds input[type=\"week\"],.wy-control-group .wy-form-thirds input[type=\"number\"],.wy-control-group .wy-form-thirds input[type=\"search\"],.wy-control-group .wy-form-thirds input[type=\"tel\"],.wy-control-group .wy-form-thirds input[type=\"color\"]{width:100%}.wy-control-group .wy-form-full{float:left;display:block;margin-right:2.3576520234%;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.3576520234%;width:48.8211739883%}.wy-control-group .wy-form-halves:last-child{margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n+1){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.3576520234%;width:31.7615653177%}.wy-control-group .wy-form-thirds:last-child{margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control{margin:6px 0 0 0;font-size:90%}.wy-control-no-input{display:inline-block;margin:6px 0 0 0;font-size:90%}.wy-control-group.fluid-input input[type=\"text\"],.wy-control-group.fluid-input input[type=\"password\"],.wy-control-group.fluid-input input[type=\"email\"],.wy-control-group.fluid-input input[type=\"url\"],.wy-control-group.fluid-input input[type=\"date\"],.wy-control-group.fluid-input input[type=\"month\"],.wy-control-group.fluid-input input[type=\"time\"],.wy-control-group.fluid-input input[type=\"datetime\"],.wy-control-group.fluid-input input[type=\"datetime-local\"],.wy-control-group.fluid-input input[type=\"week\"],.wy-control-group.fluid-input input[type=\"number\"],.wy-control-group.fluid-input input[type=\"search\"],.wy-control-group.fluid-input input[type=\"tel\"],.wy-control-group.fluid-input input[type=\"color\"]{width:100%}.wy-form-message-inline{display:inline-block;padding-left:.3em;color:#666;vertical-align:middle;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=\"button\"],input[type=\"reset\"],input[type=\"submit\"]{-webkit-appearance:button;cursor:pointer;font-family:\"Lato\",\"proxima-nova\",\"Helvetica Neue\",Arial,sans-serif;*overflow:visible}input[type=\"text\"],input[type=\"password\"],input[type=\"email\"],input[type=\"url\"],input[type=\"date\"],input[type=\"month\"],input[type=\"time\"],input[type=\"datetime\"],input[type=\"datetime-local\"],input[type=\"week\"],input[type=\"number\"],input[type=\"search\"],input[type=\"tel\"],input[type=\"color\"]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:\"Lato\",\"proxima-nova\",\"Helvetica Neue\",Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=\"datetime-local\"]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=\"checkbox\"],input[type=\"radio\"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=\"search\"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=\"search\"]::-webkit-search-cancel-button,input[type=\"search\"]::-webkit-search-decoration{-webkit-appearance:none}input[type=\"text\"]:focus,input[type=\"password\"]:focus,input[type=\"email\"]:focus,input[type=\"url\"]:focus,input[type=\"date\"]:focus,input[type=\"month\"]:focus,input[type=\"time\"]:focus,input[type=\"datetime\"]:focus,input[type=\"datetime-local\"]:focus,input[type=\"week\"]:focus,input[type=\"number\"]:focus,input[type=\"search\"]:focus,input[type=\"tel\"]:focus,input[type=\"color\"]:focus{outline:0;outline:thin dotted \\9 ;border-color:#333}input.no-focus:focus{border-color:#ccc !important}input[type=\"file\"]:focus,input[type=\"radio\"]:focus,input[type=\"checkbox\"]:focus{outline:thin dotted #333;outline:1px auto #129FEA}input[type=\"text\"][disabled],input[type=\"password\"][disabled],input[type=\"email\"][disabled],input[type=\"url\"][disabled],input[type=\"date\"][disabled],input[type=\"month\"][disabled],input[type=\"time\"][disabled],input[type=\"datetime\"][disabled],input[type=\"datetime-local\"][disabled],input[type=\"week\"][disabled],input[type=\"number\"][disabled],input[type=\"search\"][disabled],input[type=\"tel\"][disabled],input[type=\"color\"][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,textarea:focus:invalid,select:focus:invalid{color:#E74C3C;border:1px solid #E74C3C}input:focus:invalid:focus,textarea:focus:invalid:focus,select:focus:invalid:focus{border-color:#E74C3C}input[type=\"file\"]:focus:invalid:focus,input[type=\"radio\"]:focus:invalid:focus,input[type=\"checkbox\"]:focus:invalid:focus{outline-color:#E74C3C}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:\"Lato\",\"proxima-nova\",\"Helvetica Neue\",Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}select[disabled],textarea[disabled],input[readonly],select[readonly],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=\"radio\"][disabled],input[type=\"checkbox\"][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:solid 1px #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{position:absolute;content:\"\";display:block;left:0;top:0;width:36px;height:12px;border-radius:4px;background:#ccc;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{position:absolute;content:\"\";display:block;width:18px;height:18px;border-radius:4px;background:#999;left:-3px;top:-3px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27AE60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#E74C3C}.wy-control-group.wy-control-group-error input[type=\"text\"],.wy-control-group.wy-control-group-error input[type=\"password\"],.wy-control-group.wy-control-group-error input[type=\"email\"],.wy-control-group.wy-control-group-error input[type=\"url\"],.wy-control-group.wy-control-group-error input[type=\"date\"],.wy-control-group.wy-control-group-error input[type=\"month\"],.wy-control-group.wy-control-group-error input[type=\"time\"],.wy-control-group.wy-control-group-error input[type=\"datetime\"],.wy-control-group.wy-control-group-error input[type=\"datetime-local\"],.wy-control-group.wy-control-group-error input[type=\"week\"],.wy-control-group.wy-control-group-error input[type=\"number\"],.wy-control-group.wy-control-group-error input[type=\"search\"],.wy-control-group.wy-control-group-error input[type=\"tel\"],.wy-control-group.wy-control-group-error input[type=\"color\"]{border:solid 1px #E74C3C}.wy-control-group.wy-control-group-error textarea{border:solid 1px #E74C3C}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27AE60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#E74C3C}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#E67E22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980B9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width: 480px){.wy-form button[type=\"submit\"]{margin:.7em 0 0}.wy-form input[type=\"text\"],.wy-form input[type=\"password\"],.wy-form input[type=\"email\"],.wy-form input[type=\"url\"],.wy-form input[type=\"date\"],.wy-form input[type=\"month\"],.wy-form input[type=\"time\"],.wy-form input[type=\"datetime\"],.wy-form input[type=\"datetime-local\"],.wy-form input[type=\"week\"],.wy-form input[type=\"number\"],.wy-form input[type=\"search\"],.wy-form input[type=\"tel\"],.wy-form input[type=\"color\"]{margin-bottom:.3em;display:block}.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=\"password\"],.wy-form input[type=\"email\"],.wy-form input[type=\"url\"],.wy-form input[type=\"date\"],.wy-form input[type=\"month\"],.wy-form input[type=\"time\"],.wy-form input[type=\"datetime\"],.wy-form input[type=\"datetime-local\"],.wy-form input[type=\"week\"],.wy-form input[type=\"number\"],.wy-form input[type=\"search\"],.wy-form input[type=\"tel\"],.wy-form input[type=\"color\"]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0 0}.wy-form .wy-help-inline,.wy-form-message-inline,.wy-form-message{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width: 768px){.tablet-hide{display:none}}@media screen and (max-width: 480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.wy-table,.rst-content table.docutils,.rst-content table.field-list{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.wy-table caption,.rst-content table.docutils caption,.rst-content table.field-list caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td,.wy-table th,.rst-content table.docutils th,.rst-content table.field-list th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.wy-table td:first-child,.rst-content table.docutils td:first-child,.rst-content table.field-list td:first-child,.wy-table th:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list th:first-child{border-left-width:0}.wy-table thead,.rst-content table.docutils thead,.rst-content table.field-list thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.wy-table thead th,.rst-content table.docutils thead th,.rst-content table.field-list thead th{font-weight:bold;border-bottom:solid 2px #e1e4e5}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td{background-color:transparent;vertical-align:middle}.wy-table td p,.rst-content table.docutils td p,.rst-content table.field-list td p{line-height:18px}.wy-table td p:last-child,.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child{margin-bottom:0}.wy-table .wy-table-cell-min,.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min{width:1%;padding-right:0}.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:gray;font-size:90%}.wy-table-tertiary{color:gray;font-size:80%}.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td,.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td{background-color:#f3f6f6}.wy-table-backed{background-color:#f3f6f6}.wy-table-bordered-all,.rst-content table.docutils{border:1px solid #e1e4e5}.wy-table-bordered-all td,.rst-content table.docutils td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.wy-table-bordered-all tbody>tr:last-child td,.rst-content table.docutils tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px 0;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0 !important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980B9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9B59B6}html{height:100%;overflow-x:hidden}body{font-family:\"Lato\",\"proxima-nova\",\"Helvetica Neue\",Arial,sans-serif;font-weight:normal;color:#404040;min-height:100%;overflow-x:hidden;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#E67E22 !important}a.wy-text-warning:hover{color:#eb9950 !important}.wy-text-info{color:#2980B9 !important}a.wy-text-info:hover{color:#409ad5 !important}.wy-text-success{color:#27AE60 !important}a.wy-text-success:hover{color:#36d278 !important}.wy-text-danger{color:#E74C3C !important}a.wy-text-danger:hover{color:#ed7669 !important}.wy-text-neutral{color:#404040 !important}a.wy-text-neutral:hover{color:#595959 !important}h1,h2,.rst-content .toctree-wrapper>p.caption,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:\"Roboto Slab\",\"ff-tisa-web-pro\",\"Georgia\",Arial,sans-serif}p{line-height:24px;margin:0;font-size:16px;margin-bottom:24px}h1{font-size:175%}h2,.rst-content .toctree-wrapper>p.caption{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}code,.rst-content tt,.rst-content code{white-space:nowrap;max-width:100%;background:#fff;border:solid 1px #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",Courier,monospace;color:#E74C3C;overflow-x:auto}code.code-large,.rst-content tt.code-large{font-size:90%}.wy-plain-list-disc,.rst-content .section ul,.rst-content section ul,.rst-content .toctree-wrapper ul,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.wy-plain-list-disc li,.rst-content .section ul li,.rst-content section ul li,.rst-content .toctree-wrapper ul li,article ul li{list-style:disc;margin-left:24px}.wy-plain-list-disc li p:last-child,.rst-content .section ul li p:last-child,.rst-content section ul li p:last-child,.rst-content .toctree-wrapper ul li p:last-child,article ul li p:last-child{margin-bottom:0}.wy-plain-list-disc li ul,.rst-content .section ul li ul,.rst-content section ul li ul,.rst-content .toctree-wrapper ul li ul,article ul li ul{margin-bottom:0}.wy-plain-list-disc li li,.rst-content .section ul li li,.rst-content section ul li li,.rst-content .toctree-wrapper ul li li,article ul li li{list-style:circle}.wy-plain-list-disc li li li,.rst-content .section ul li li li,.rst-content section ul li li li,.rst-content .toctree-wrapper ul li li li,article ul li li li{list-style:square}.wy-plain-list-disc li ol li,.rst-content .section ul li ol li,.rst-content section ul li ol li,.rst-content .toctree-wrapper ul li ol li,article ul li ol li{list-style:decimal}.wy-plain-list-decimal,.rst-content .section ol,.rst-content .section ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.wy-plain-list-decimal li,.rst-content .section ol li,.rst-content .section ol.arabic li,.rst-content section ol li,.rst-content section ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content .toctree-wrapper ol.arabic li,article ol li{list-style:decimal;margin-left:24px}.wy-plain-list-decimal li p:last-child,.rst-content .section ol li p:last-child,.rst-content section ol li p:last-child,.rst-content .toctree-wrapper ol li p:last-child,article ol li p:last-child{margin-bottom:0}.wy-plain-list-decimal li ul,.rst-content .section ol li ul,.rst-content .section ol.arabic li ul,.rst-content section ol li ul,.rst-content section ol.arabic li ul,.rst-content .toctree-wrapper ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,article ol li ul{margin-bottom:0}.wy-plain-list-decimal li ul li,.rst-content .section ol li ul li,.rst-content .section ol.arabic li ul li,.rst-content section ol li ul li,.rst-content section ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:before,.wy-breadcrumbs:after{display:table;content:\"\"}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs li{display:inline-block}.wy-breadcrumbs li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs li a{display:inline-block;padding:5px}.wy-breadcrumbs li a:first-child{padding-left:0}.wy-breadcrumbs li code,.wy-breadcrumbs li .rst-content tt,.rst-content .wy-breadcrumbs li tt{padding:5px;border:none;background:none}.wy-breadcrumbs li code.literal,.wy-breadcrumbs li .rst-content tt.literal,.rst-content .wy-breadcrumbs li tt.literal{color:#404040}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width: 480px){.wy-breadcrumbs-extra{display:none}.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:before,.wy-menu-horiz:after{display:table;content:\"\"}.wy-menu-horiz:after{clear:both}.wy-menu-horiz ul,.wy-menu-horiz li{display:inline-block}.wy-menu-horiz li:hover{background:rgba(255,255,255,0.1)}.wy-menu-horiz li.divide-left{border-left:solid 1px #404040}.wy-menu-horiz li.divide-right{border-right:solid 1px #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0 0;display:block;font-weight:bold;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:solid 1px #404040}.wy-menu-vertical li.divide-bottom{border-bottom:solid 1px #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:gray;border-right:solid 1px #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.wy-menu-vertical li code,.wy-menu-vertical li .rst-content tt,.rst-content .wy-menu-vertical li tt{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a{color:#404040;padding:.4045em 1.618em;font-weight:bold;position:relative;background:#fcfcfc;border:none;padding-left:1.618em -4px}.wy-menu-vertical li.on a:hover,.wy-menu-vertical li.current>a:hover{background:#fcfcfc}.wy-menu-vertical li.on a:hover button.toctree-expand,.wy-menu-vertical li.current>a:hover button.toctree-expand{color:gray}.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li.current>a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:solid 1px #c9c9c9;border-top:solid 1px #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:gray}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 4.045em;padding-right:1.618em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 5.663em;padding-right:1.618em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 7.281em;padding-right:1.618em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 8.899em;padding-right:1.618em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 10.517em;padding-right:1.618em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 12.135em;padding-right:1.618em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 13.753em;padding-right:1.618em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 15.371em;padding-right:1.618em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 16.989em;padding-right:1.618em}.wy-menu-vertical li.toctree-l2.current>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:normal}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980B9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980B9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em auto;height:45px;width:45px;background-color:#2980B9;padding:5px;border-radius:100%}.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a{color:#fcfcfc;font-size:100%;font-weight:bold;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search>a:hover,.wy-side-nav-search .wy-dropdown>a:hover{background:rgba(255,255,255,0.1)}.wy-side-nav-search>a img.logo,.wy-side-nav-search .wy-dropdown>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search>a.icon img.logo,.wy-side-nav-search .wy-dropdown>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:normal;color:rgba(255,255,255,0.3)}.wy-nav .wy-menu-vertical header{color:#2980B9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980B9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980B9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:before,.wy-nav-top:after{display:table;content:\"\"}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:bold}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980B9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,0.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:gray}footer p{margin-bottom:12px}footer span.commit code,footer span.commit .rst-content tt,.rst-content footer span.commit tt{padding:0px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",Courier,monospace;font-size:1em;background:none;border:none;color:gray}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:before,.rst-footer-buttons:after{width:100%}.rst-footer-buttons:before,.rst-footer-buttons:after{display:table;content:\"\"}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:before,.rst-breadcrumbs-buttons:after{display:table;content:\"\"}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:solid 1px #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:solid 1px #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:gray;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width: 768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-side-scroll{width:auto}.wy-side-nav-search{width:auto}.wy-menu.wy-menu-vertical{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width: 1100px){.wy-nav-content-wrap{background:rgba(0,0,0,0.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,footer,.wy-nav-side{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:\"Lato\",\"proxima-nova\",\"Helvetica Neue\",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:\"\"}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .icon{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content h1,.rst-content h2,.rst-content .toctree-wrapper>p.caption,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0px}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>img,.rst-content .section>a>img,.rst-content section>img,.rst-content section>a>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:\"\";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px 12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",Courier,monospace;display:block;overflow:auto}.rst-content pre.literal-block,.rst-content div[class^='highlight']{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px 0}.rst-content pre.literal-block div[class^='highlight'],.rst-content div[class^='highlight'] div[class^='highlight']{padding:0px;border:none;margin:0}.rst-content div[class^='highlight'] td.code{width:100%}.rst-content .linenodiv pre{border-right:solid 1px #e6e9ea;margin:0;padding:12px 12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^='highlight'] pre{white-space:pre;margin:0;padding:12px 12px;display:block;overflow:auto}.rst-content div[class^='highlight'] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content pre.literal-block,.rst-content div[class^='highlight'] pre,.rst-content .linenodiv pre{font-family:SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight span.linenos,.rst-content div.highlight .gp{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0px;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^='highlight'],.rst-content div[class^='highlight'] pre{white-space:pre-wrap}}.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.rst-content .admonition{clear:both}.rst-content .note .last,.rst-content .note>*:last-child,.rst-content .attention .last,.rst-content .attention>*:last-child,.rst-content .caution .last,.rst-content .caution>*:last-child,.rst-content .danger .last,.rst-content .danger>*:last-child,.rst-content .error .last,.rst-content .error>*:last-child,.rst-content .hint .last,.rst-content .hint>*:last-child,.rst-content .important .last,.rst-content .important>*:last-child,.rst-content .tip .last,.rst-content .tip>*:last-child,.rst-content .warning .last,.rst-content .warning>*:last-child,.rst-content .seealso .last,.rst-content .seealso>*:last-child,.rst-content .admonition-todo .last,.rst-content .admonition-todo>*:last-child,.rst-content .admonition .last,.rst-content .admonition>*:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,0.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent !important;border-color:rgba(0,0,0,0.1) !important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content section ol li>*,.rst-content section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>*:first-child,.rst-content .section ul li>*:first-child,.rst-content section ol li>*:first-child,.rst-content section ul li>*:first-child,.rst-content .toctree-wrapper ol li>*:first-child,.rst-content .toctree-wrapper ul li>*:first-child{margin-top:0rem}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child{margin-bottom:0rem}.rst-content .section ol li>ul,.rst-content .section ol li>ol,.rst-content .section ul li>ul,.rst-content .section ul li>ol,.rst-content section ol li>ul,.rst-content section ol li>ol,.rst-content section ul li>ul,.rst-content section ul li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content .toctree-wrapper ul li>ol{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ul.simple li>*,.rst-content section ol.simple li>*,.rst-content section ul.simple li>*,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ul.simple li>*{margin-top:0rem;margin-bottom:0rem}.rst-content .section ol.simple li ul,.rst-content .section ol.simple li ol,.rst-content .section ul.simple li ul,.rst-content .section ul.simple li ol,.rst-content section ol.simple li ul,.rst-content section ol.simple li ol,.rst-content section ul.simple li ul,.rst-content section ul.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content .toctree-wrapper ul.simple li ol{margin-top:0rem;margin-bottom:0rem}.rst-content .line-block{margin-left:0px;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0px}.rst-content .topic-title{font-weight:bold;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0px 0px 24px 24px}.rst-content .align-left{float:left;margin:0px 24px 24px 0px}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content h1 .headerlink:focus,.rst-content h2 .headerlink:focus,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content h3 .headerlink:focus,.rst-content h4 .headerlink:focus,.rst-content h5 .headerlink:focus,.rst-content h6 .headerlink:focus,.rst-content dl dt .headerlink:focus,.rst-content p .headerlink:focus,.rst-content p.caption .headerlink:focus,.rst-content table>caption .headerlink:focus,.rst-content .code-block-caption .headerlink:focus,.rst-content .eqno .headerlink:focus{opacity:1}.rst-content h1:hover .headerlink,.rst-content h2:hover .headerlink,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content h3:hover .headerlink,.rst-content h4:hover .headerlink,.rst-content h5:hover .headerlink,.rst-content h6:hover .headerlink,.rst-content dl dt:hover .headerlink,.rst-content p:hover .headerlink,.rst-content p.caption:hover .headerlink,.rst-content table>caption:hover .headerlink,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno:hover .headerlink{opacity:1}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:solid 1px #e1e4e5}.rst-content .sidebar p,.rst-content .sidebar ul,.rst-content .sidebar dl{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>*:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:\"Roboto Slab\",\"ff-tisa-web-pro\",\"Georgia\",Arial,sans-serif;font-weight:bold;background:#e1e4e5;padding:6px 12px;margin:-24px;margin-bottom:24px;font-size:100%}.rst-content .highlighted{background:#F1C40F;box-shadow:0 0 0 2px #F1C40F;display:inline;font-weight:bold}.rst-content .footnote-reference,.rst-content .citation-reference{vertical-align:baseline;position:relative;top:-0.4em;line-height:0;font-size:90%}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:\" : \"}.rst-content dl dt span.classifier-delimiter{display:none !important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent !important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.footnote,html.writer-html5 .rst-content dl.field-list{display:grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content dl.footnote>dt,html.writer-html5 .rst-content dl.field-list>dt{padding-left:1rem}html.writer-html5 .rst-content dl.footnote>dt:after,html.writer-html5 .rst-content dl.field-list>dt:after{content:\":\"}html.writer-html5 .rst-content dl.footnote>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.field-list>dd{margin-bottom:0rem}html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.footnote>dt{margin:0rem .5rem .5rem 0rem;line-height:1.2rem;word-break:break-all;font-weight:normal}html.writer-html5 .rst-content dl.footnote>dt>span.brackets{margin-right:.5rem}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:\"[\"}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:\"]\"}html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{font-style:italic}html.writer-html5 .rst-content dl.footnote>dd{margin:0rem 0rem .5rem 0rem;line-height:1.2rem}html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}html.writer-html4 .rst-content table.docutils.citation,.rst-content table.docutils.footnote,html.writer-html5 .rst-content dl.footnote{color:gray}html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html4 .rst-content table.docutils.citation code,.rst-content table.docutils.footnote tt,.rst-content table.docutils.footnote code,html.writer-html5 .rst-content dl.footnote tt,html.writer-html5 .rst-content dl.footnote code{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils th>p,html.writer-html5 .rst-content table.docutils td>p{line-height:1rem;margin-bottom:0rem;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>*:last-child{margin-bottom:0}.rst-content table.field-list{border:none}.rst-content table.field-list td{border:none}.rst-content table.field-list td p{font-size:inherit;line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content tt,.rst-content tt,.rst-content code{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",Courier,monospace;padding:2px 5px}.rst-content tt big,.rst-content tt em,.rst-content tt big,.rst-content code big,.rst-content tt em,.rst-content code em{font-size:100% !important;line-height:normal}.rst-content tt.literal,.rst-content tt.literal,.rst-content code.literal{color:#E74C3C;white-space:normal}.rst-content tt.xref,a .rst-content tt,.rst-content tt.xref,.rst-content code.xref,a .rst-content tt,a .rst-content code{font-weight:bold;color:#404040}.rst-content pre,.rst-content kbd,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",Courier,monospace}.rst-content a tt,.rst-content a tt,.rst-content a code{color:#2980B9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:bold;margin-bottom:12px}.rst-content dl p,.rst-content dl table,.rst-content dl ul,.rst-content dl ol{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980B9;border-top:solid 3px #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100% !important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt{margin-bottom:6px;border:none;border-left:solid 3px #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt .headerlink{color:#404040;font-size:100% !important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descclassname{background-color:transparent;border:none;padding:0;font-size:100% !important}html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname{font-weight:bold}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:bold}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .descclassname{font-family:SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",Courier,monospace;color:#000}.rst-content .viewcode-link,.rst-content .viewcode-back{display:inline-block;color:#27AE60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:bold}.rst-content tt.download,.rst-content code.download{background:inherit;padding:inherit;font-weight:normal;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content tt.download span:first-child,.rst-content code.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{margin-right:4px}.rst-content .guilabel{border:1px solid #7fbbe3;background:#e7f2fa;font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .versionmodified{font-style:italic}@media screen and (max-width: 480px){.rst-content .sidebar{width:100%}}span[id*='MathJax-Span']{color:#404040}.math{text-align:center}@font-face{font-family:\"Lato\";src:url(\"../fonts/Lato-Regular.woff2\") format(\"woff2\"),url(\"../fonts/Lato-Regular.ttf\") format(\"truetype\");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:\"Lato\";src:url(\"../fonts/Lato-Bold.woff2\") format(\"woff2\"),url(\"../fonts/Lato-Bold.ttf\") format(\"truetype\");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:\"Lato\";src:url(\"../fonts/Lato-BoldItalic.woff2\") format(\"woff2\"),url(\"../fonts/Lato-BoldItalic.ttf\") format(\"truetype\");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:\"Lato\";src:url(\"../fonts/Lato-Italic.woff2\") format(\"woff2\"),url(\"../fonts/Lato-Italic.ttf\") format(\"truetype\");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:\"Roboto Slab\";font-style:normal;font-weight:400;src:url(\"../fonts/RobotoSlab-Regular.woff2\") format(\"woff2\");font-display:block}@font-face{font-family:\"Roboto Slab\";font-style:normal;font-weight:700;src:url(\"../fonts/RobotoSlab-Bold.woff2\") format(\"woff2\");font-display:block}\n" }, { "path": "doc/_build/html/_static/css/theme_CFDEMcoupling.css", "content": "/** rtd_theme improved for CFDEMcoupling **/\n\n@import 'theme.css';\n\n/* add upper roman enumerations */\n.wy-plain-list-upperroman,.rst-content .section ol,.rst-content ol.upperroman,article ol{\nlist-style:upper-roman;\nline-height:24px;\nmargin-bottom:24px}\n.wy-plain-list-upperroman li,.rst-content .section ol li,.rst-content ol.upperroman li,article ol li{\nlist-style:upper-roman;\nmargin-left:24px}\n.wy-plain-list-upperroman li p:last-child,.rst-content .section ol li p:last-child,.rst-content ol.upperroman li p:last-child,article ol li p:last-child{\nmargin-bottom:0}\n.wy-plain-list-upperroman li ul,.rst-content .section ol li ul,.rst-content ol.upperroman li ul,article ol li ul{\nmargin-bottom:0}\n.wy-plain-list-upperroman li ul li,.rst-content .section ol li ul li,.rst-content ol.upperroman li ul li,article ol li ul li{\nlist-style:disc}\n" }, { "path": "doc/_build/html/_static/doctools.js", "content": "/*\n * doctools.js\n * ~~~~~~~~~~~\n *\n * Sphinx JavaScript utilities for all documentation.\n *\n * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.\n * :license: BSD, see LICENSE for details.\n *\n */\n\n/**\n * select a different prefix for underscore\n */\n$u = _.noConflict();\n\n/**\n * make the code below compatible with browsers without\n * an installed firebug like debugger\nif (!window.console || !console.firebug) {\n var names = [\"log\", \"debug\", \"info\", \"warn\", \"error\", \"assert\", \"dir\",\n \"dirxml\", \"group\", \"groupEnd\", \"time\", \"timeEnd\", \"count\", \"trace\",\n \"profile\", \"profileEnd\"];\n window.console = {};\n for (var i = 0; i < names.length; ++i)\n window.console[names[i]] = function() {};\n}\n */\n\n/**\n * small helper function to urldecode strings\n *\n * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL\n */\njQuery.urldecode = function(x) {\n if (!x) {\n return x\n }\n return decodeURIComponent(x.replace(/\\+/g, ' '));\n};\n\n/**\n * small helper function to urlencode strings\n */\njQuery.urlencode = encodeURIComponent;\n\n/**\n * This function returns the parsed url parameters of the\n * current request. Multiple values per key are supported,\n * it will always return arrays of strings for the value parts.\n */\njQuery.getQueryParameters = function(s) {\n if (typeof s === 'undefined')\n s = document.location.search;\n var parts = s.substr(s.indexOf('?') + 1).split('&');\n var result = {};\n for (var i = 0; i < parts.length; i++) {\n var tmp = parts[i].split('=', 2);\n var key = jQuery.urldecode(tmp[0]);\n var value = jQuery.urldecode(tmp[1]);\n if (key in result)\n result[key].push(value);\n else\n result[key] = [value];\n }\n return result;\n};\n\n/**\n * highlight a given string on a jquery object by wrapping it in\n * span elements with the given class name.\n */\njQuery.fn.highlightText = function(text, className) {\n function highlight(node, addItems) {\n if (node.nodeType === 3) {\n var val = node.nodeValue;\n var pos = val.toLowerCase().indexOf(text);\n if (pos >= 0 &&\n !jQuery(node.parentNode).hasClass(className) &&\n !jQuery(node.parentNode).hasClass(\"nohighlight\")) {\n var span;\n var isInSVG = jQuery(node).closest(\"body, svg, foreignObject\").is(\"svg\");\n if (isInSVG) {\n span = document.createElementNS(\"http://www.w3.org/2000/svg\", \"tspan\");\n } else {\n span = document.createElement(\"span\");\n span.className = className;\n }\n span.appendChild(document.createTextNode(val.substr(pos, text.length)));\n node.parentNode.insertBefore(span, node.parentNode.insertBefore(\n document.createTextNode(val.substr(pos + text.length)),\n node.nextSibling));\n node.nodeValue = val.substr(0, pos);\n if (isInSVG) {\n var rect = document.createElementNS(\"http://www.w3.org/2000/svg\", \"rect\");\n var bbox = node.parentElement.getBBox();\n rect.x.baseVal.value = bbox.x;\n rect.y.baseVal.value = bbox.y;\n rect.width.baseVal.value = bbox.width;\n rect.height.baseVal.value = bbox.height;\n rect.setAttribute('class', className);\n addItems.push({\n \"parent\": node.parentNode,\n \"target\": rect});\n }\n }\n }\n else if (!jQuery(node).is(\"button, select, textarea\")) {\n jQuery.each(node.childNodes, function() {\n highlight(this, addItems);\n });\n }\n }\n var addItems = [];\n var result = this.each(function() {\n highlight(this, addItems);\n });\n for (var i = 0; i < addItems.length; ++i) {\n jQuery(addItems[i].parent).before(addItems[i].target);\n }\n return result;\n};\n\n/*\n * backward compatibility for jQuery.browser\n * This will be supported until firefox bug is fixed.\n */\nif (!jQuery.browser) {\n jQuery.uaMatch = function(ua) {\n ua = ua.toLowerCase();\n\n var match = /(chrome)[ \\/]([\\w.]+)/.exec(ua) ||\n /(webkit)[ \\/]([\\w.]+)/.exec(ua) ||\n /(opera)(?:.*version|)[ \\/]([\\w.]+)/.exec(ua) ||\n /(msie) ([\\w.]+)/.exec(ua) ||\n ua.indexOf(\"compatible\") < 0 && /(mozilla)(?:.*? rv:([\\w.]+)|)/.exec(ua) ||\n [];\n\n return {\n browser: match[ 1 ] || \"\",\n version: match[ 2 ] || \"0\"\n };\n };\n jQuery.browser = {};\n jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;\n}\n\n/**\n * Small JavaScript module for the documentation.\n */\nvar Documentation = {\n\n init : function() {\n this.fixFirefoxAnchorBug();\n this.highlightSearchWords();\n this.initIndexTable();\n if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {\n this.initOnKeyListeners();\n }\n },\n\n /**\n * i18n support\n */\n TRANSLATIONS : {},\n PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },\n LOCALE : 'unknown',\n\n // gettext and ngettext don't access this so that the functions\n // can safely bound to a different name (_ = Documentation.gettext)\n gettext : function(string) {\n var translated = Documentation.TRANSLATIONS[string];\n if (typeof translated === 'undefined')\n return string;\n return (typeof translated === 'string') ? translated : translated[0];\n },\n\n ngettext : function(singular, plural, n) {\n var translated = Documentation.TRANSLATIONS[singular];\n if (typeof translated === 'undefined')\n return (n == 1) ? singular : plural;\n return translated[Documentation.PLURALEXPR(n)];\n },\n\n addTranslations : function(catalog) {\n for (var key in catalog.messages)\n this.TRANSLATIONS[key] = catalog.messages[key];\n this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');\n this.LOCALE = catalog.locale;\n },\n\n /**\n * add context elements like header anchor links\n */\n addContextElements : function() {\n $('div[id] > :header:first').each(function() {\n $('\\u00B6').\n attr('href', '#' + this.id).\n attr('title', _('Permalink to this headline')).\n appendTo(this);\n });\n $('dt[id]').each(function() {\n $('\\u00B6').\n attr('href', '#' + this.id).\n attr('title', _('Permalink to this definition')).\n appendTo(this);\n });\n },\n\n /**\n * workaround a firefox stupidity\n * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075\n */\n fixFirefoxAnchorBug : function() {\n if (document.location.hash && $.browser.mozilla)\n window.setTimeout(function() {\n document.location.href += '';\n }, 10);\n },\n\n /**\n * highlight the search words provided in the url in the text\n */\n highlightSearchWords : function() {\n var params = $.getQueryParameters();\n var terms = (params.highlight) ? params.highlight[0].split(/\\s+/) : [];\n if (terms.length) {\n var body = $('div.body');\n if (!body.length) {\n body = $('body');\n }\n window.setTimeout(function() {\n $.each(terms, function() {\n body.highlightText(this.toLowerCase(), 'highlighted');\n });\n }, 10);\n $('

' + _('Hide Search Matches') + '

')\n .appendTo($('#searchbox'));\n }\n },\n\n /**\n * init the domain index toggle buttons\n */\n initIndexTable : function() {\n var togglers = $('img.toggler').click(function() {\n var src = $(this).attr('src');\n var idnum = $(this).attr('id').substr(7);\n $('tr.cg-' + idnum).toggle();\n if (src.substr(-9) === 'minus.png')\n $(this).attr('src', src.substr(0, src.length-9) + 'plus.png');\n else\n $(this).attr('src', src.substr(0, src.length-8) + 'minus.png');\n }).css('display', '');\n if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {\n togglers.click();\n }\n },\n\n /**\n * helper function to hide the search marks again\n */\n hideSearchWords : function() {\n $('#searchbox .highlight-link').fadeOut(300);\n $('span.highlighted').removeClass('highlighted');\n },\n\n /**\n * make the url absolute\n */\n makeURL : function(relativeURL) {\n return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;\n },\n\n /**\n * get the current relative url\n */\n getCurrentURL : function() {\n var path = document.location.pathname;\n var parts = path.split(/\\//);\n $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\\//), function() {\n if (this === '..')\n parts.pop();\n });\n var url = parts.join('/');\n return path.substring(url.lastIndexOf('/') + 1, path.length - 1);\n },\n\n initOnKeyListeners: function() {\n $(document).keydown(function(event) {\n var activeElementType = document.activeElement.tagName;\n // don't navigate when in search box, textarea, dropdown or button\n if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'\n && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey\n && !event.shiftKey) {\n switch (event.keyCode) {\n case 37: // left\n var prevHref = $('link[rel=\"prev\"]').prop('href');\n if (prevHref) {\n window.location.href = prevHref;\n return false;\n }\n break;\n case 39: // right\n var nextHref = $('link[rel=\"next\"]').prop('href');\n if (nextHref) {\n window.location.href = nextHref;\n return false;\n }\n break;\n }\n }\n });\n }\n};\n\n// quick alias for translations\n_ = Documentation.gettext;\n\n$(document).ready(function() {\n Documentation.init();\n});\n" }, { "path": "doc/_build/html/_static/documentation_options.js", "content": "var DOCUMENTATION_OPTIONS = {\n URL_ROOT: document.getElementById(\"documentation_options\").getAttribute('data-url_root'),\n VERSION: '3.8.1',\n LANGUAGE: 'None',\n COLLAPSE_INDEX: false,\n BUILDER: 'html',\n FILE_SUFFIX: '.html',\n LINK_SUFFIX: '.html',\n HAS_SOURCE: false,\n SOURCELINK_SUFFIX: '.txt',\n NAVIGATION_WITH_KEYS: false\n};\n" }, { "path": "doc/_build/html/_static/jquery.js", "content": "/*!\n * jQuery JavaScript Library v3.6.0\n * https://jquery.com/\n *\n * Includes Sizzle.js\n * https://sizzlejs.com/\n *\n * Copyright OpenJS Foundation and other contributors\n * Released under the MIT license\n * https://jquery.org/license\n */\n( function( global, factory ) {\n\n\t\"use strict\";\n\n\tif ( typeof module === \"object\" && typeof module.exports === \"object\" ) {\n\n\t\t// For CommonJS and CommonJS-like environments where a proper `window`\n\t\t// is present, execute the factory and get jQuery.\n\t\t// For environments that do not have a `window` with a `document`\n\t\t// (such as Node.js), expose a factory as module.exports.\n\t\t// This accentuates the need for the creation of a real `window`.\n\t\t// e.g. var jQuery = require(\"jquery\")(window);\n\t\t// See ticket #14549 for more info.\n\t\tmodule.exports = global.document ?\n\t\t\tfactory( global, true ) :\n\t\t\tfunction( w ) {\n\t\t\t\tif ( !w.document ) {\n\t\t\t\t\tthrow new Error( \"jQuery requires a window with a document\" );\n\t\t\t\t}\n\t\t\t\treturn factory( w );\n\t\t\t};\n\t} else {\n\t\tfactory( global );\n\t}\n\n// Pass this if window is not defined yet\n} )( typeof window !== \"undefined\" ? window : this, function( window, noGlobal ) {\n\n// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1\n// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode\n// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common\n// enough that all such attempts are guarded in a try block.\n\"use strict\";\n\nvar arr = [];\n\nvar getProto = Object.getPrototypeOf;\n\nvar slice = arr.slice;\n\nvar flat = arr.flat ? function( array ) {\n\treturn arr.flat.call( array );\n} : function( array ) {\n\treturn arr.concat.apply( [], array );\n};\n\n\nvar push = arr.push;\n\nvar indexOf = arr.indexOf;\n\nvar class2type = {};\n\nvar toString = class2type.toString;\n\nvar hasOwn = class2type.hasOwnProperty;\n\nvar fnToString = hasOwn.toString;\n\nvar ObjectFunctionString = fnToString.call( Object );\n\nvar support = {};\n\nvar isFunction = function isFunction( obj ) {\n\n\t\t// Support: Chrome <=57, Firefox <=52\n\t\t// In some browsers, typeof returns \"function\" for HTML elements\n\t\t// (i.e., `typeof document.createElement( \"object\" ) === \"function\"`).\n\t\t// We don't want to classify *any* DOM node as a function.\n\t\t// Support: QtWeb <=3.8.5, WebKit <=534.34, wkhtmltopdf tool <=0.12.5\n\t\t// Plus for old WebKit, typeof returns \"function\" for HTML collections\n\t\t// (e.g., `typeof document.getElementsByTagName(\"div\") === \"function\"`). (gh-4756)\n\t\treturn typeof obj === \"function\" && typeof obj.nodeType !== \"number\" &&\n\t\t\ttypeof obj.item !== \"function\";\n\t};\n\n\nvar isWindow = function isWindow( obj ) {\n\t\treturn obj != null && obj === obj.window;\n\t};\n\n\nvar document = window.document;\n\n\n\n\tvar preservedScriptAttributes = {\n\t\ttype: true,\n\t\tsrc: true,\n\t\tnonce: true,\n\t\tnoModule: true\n\t};\n\n\tfunction DOMEval( code, node, doc ) {\n\t\tdoc = doc || document;\n\n\t\tvar i, val,\n\t\t\tscript = doc.createElement( \"script\" );\n\n\t\tscript.text = code;\n\t\tif ( node ) {\n\t\t\tfor ( i in preservedScriptAttributes ) {\n\n\t\t\t\t// Support: Firefox 64+, Edge 18+\n\t\t\t\t// Some browsers don't support the \"nonce\" property on scripts.\n\t\t\t\t// On the other hand, just using `getAttribute` is not enough as\n\t\t\t\t// the `nonce` attribute is reset to an empty string whenever it\n\t\t\t\t// becomes browsing-context connected.\n\t\t\t\t// See https://github.com/whatwg/html/issues/2369\n\t\t\t\t// See https://html.spec.whatwg.org/#nonce-attributes\n\t\t\t\t// The `node.getAttribute` check was added for the sake of\n\t\t\t\t// `jQuery.globalEval` so that it can fake a nonce-containing node\n\t\t\t\t// via an object.\n\t\t\t\tval = node[ i ] || node.getAttribute && node.getAttribute( i );\n\t\t\t\tif ( val ) {\n\t\t\t\t\tscript.setAttribute( i, val );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tdoc.head.appendChild( script ).parentNode.removeChild( script );\n\t}\n\n\nfunction toType( obj ) {\n\tif ( obj == null ) {\n\t\treturn obj + \"\";\n\t}\n\n\t// Support: Android <=2.3 only (functionish RegExp)\n\treturn typeof obj === \"object\" || typeof obj === \"function\" ?\n\t\tclass2type[ toString.call( obj ) ] || \"object\" :\n\t\ttypeof obj;\n}\n/* global Symbol */\n// Defining this global in .eslintrc.json would create a danger of using the global\n// unguarded in another place, it seems safer to define global only for this module\n\n\n\nvar\n\tversion = \"3.6.0\",\n\n\t// Define a local copy of jQuery\n\tjQuery = function( selector, context ) {\n\n\t\t// The jQuery object is actually just the init constructor 'enhanced'\n\t\t// Need init if jQuery is called (just allow error to be thrown if not included)\n\t\treturn new jQuery.fn.init( selector, context );\n\t};\n\njQuery.fn = jQuery.prototype = {\n\n\t// The current version of jQuery being used\n\tjquery: version,\n\n\tconstructor: jQuery,\n\n\t// The default length of a jQuery object is 0\n\tlength: 0,\n\n\ttoArray: function() {\n\t\treturn slice.call( this );\n\t},\n\n\t// Get the Nth element in the matched element set OR\n\t// Get the whole matched element set as a clean array\n\tget: function( num ) {\n\n\t\t// Return all the elements in a clean array\n\t\tif ( num == null ) {\n\t\t\treturn slice.call( this );\n\t\t}\n\n\t\t// Return just the one element from the set\n\t\treturn num < 0 ? this[ num + this.length ] : this[ num ];\n\t},\n\n\t// Take an array of elements and push it onto the stack\n\t// (returning the new matched element set)\n\tpushStack: function( elems ) {\n\n\t\t// Build a new jQuery matched element set\n\t\tvar ret = jQuery.merge( this.constructor(), elems );\n\n\t\t// Add the old object onto the stack (as a reference)\n\t\tret.prevObject = this;\n\n\t\t// Return the newly-formed element set\n\t\treturn ret;\n\t},\n\n\t// Execute a callback for every element in the matched set.\n\teach: function( callback ) {\n\t\treturn jQuery.each( this, callback );\n\t},\n\n\tmap: function( callback ) {\n\t\treturn this.pushStack( jQuery.map( this, function( elem, i ) {\n\t\t\treturn callback.call( elem, i, elem );\n\t\t} ) );\n\t},\n\n\tslice: function() {\n\t\treturn this.pushStack( slice.apply( this, arguments ) );\n\t},\n\n\tfirst: function() {\n\t\treturn this.eq( 0 );\n\t},\n\n\tlast: function() {\n\t\treturn this.eq( -1 );\n\t},\n\n\teven: function() {\n\t\treturn this.pushStack( jQuery.grep( this, function( _elem, i ) {\n\t\t\treturn ( i + 1 ) % 2;\n\t\t} ) );\n\t},\n\n\todd: function() {\n\t\treturn this.pushStack( jQuery.grep( this, function( _elem, i ) {\n\t\t\treturn i % 2;\n\t\t} ) );\n\t},\n\n\teq: function( i ) {\n\t\tvar len = this.length,\n\t\t\tj = +i + ( i < 0 ? len : 0 );\n\t\treturn this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] );\n\t},\n\n\tend: function() {\n\t\treturn this.prevObject || this.constructor();\n\t},\n\n\t// For internal use only.\n\t// Behaves like an Array's method, not like a jQuery method.\n\tpush: push,\n\tsort: arr.sort,\n\tsplice: arr.splice\n};\n\njQuery.extend = jQuery.fn.extend = function() {\n\tvar options, name, src, copy, copyIsArray, clone,\n\t\ttarget = arguments[ 0 ] || {},\n\t\ti = 1,\n\t\tlength = arguments.length,\n\t\tdeep = false;\n\n\t// Handle a deep copy situation\n\tif ( typeof target === \"boolean\" ) {\n\t\tdeep = target;\n\n\t\t// Skip the boolean and the target\n\t\ttarget = arguments[ i ] || {};\n\t\ti++;\n\t}\n\n\t// Handle case when target is a string or something (possible in deep copy)\n\tif ( typeof target !== \"object\" && !isFunction( target ) ) {\n\t\ttarget = {};\n\t}\n\n\t// Extend jQuery itself if only one argument is passed\n\tif ( i === length ) {\n\t\ttarget = this;\n\t\ti--;\n\t}\n\n\tfor ( ; i < length; i++ ) {\n\n\t\t// Only deal with non-null/undefined values\n\t\tif ( ( options = arguments[ i ] ) != null ) {\n\n\t\t\t// Extend the base object\n\t\t\tfor ( name in options ) {\n\t\t\t\tcopy = options[ name ];\n\n\t\t\t\t// Prevent Object.prototype pollution\n\t\t\t\t// Prevent never-ending loop\n\t\t\t\tif ( name === \"__proto__\" || target === copy ) {\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\n\t\t\t\t// Recurse if we're merging plain objects or arrays\n\t\t\t\tif ( deep && copy && ( jQuery.isPlainObject( copy ) ||\n\t\t\t\t\t( copyIsArray = Array.isArray( copy ) ) ) ) {\n\t\t\t\t\tsrc = target[ name ];\n\n\t\t\t\t\t// Ensure proper type for the source value\n\t\t\t\t\tif ( copyIsArray && !Array.isArray( src ) ) {\n\t\t\t\t\t\tclone = [];\n\t\t\t\t\t} else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) {\n\t\t\t\t\t\tclone = {};\n\t\t\t\t\t} else {\n\t\t\t\t\t\tclone = src;\n\t\t\t\t\t}\n\t\t\t\t\tcopyIsArray = false;\n\n\t\t\t\t\t// Never move original objects, clone them\n\t\t\t\t\ttarget[ name ] = jQuery.extend( deep, clone, copy );\n\n\t\t\t\t// Don't bring in undefined values\n\t\t\t\t} else if ( copy !== undefined ) {\n\t\t\t\t\ttarget[ name ] = copy;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t// Return the modified object\n\treturn target;\n};\n\njQuery.extend( {\n\n\t// Unique for each copy of jQuery on the page\n\texpando: \"jQuery\" + ( version + Math.random() ).replace( /\\D/g, \"\" ),\n\n\t// Assume jQuery is ready without the ready module\n\tisReady: true,\n\n\terror: function( msg ) {\n\t\tthrow new Error( msg );\n\t},\n\n\tnoop: function() {},\n\n\tisPlainObject: function( obj ) {\n\t\tvar proto, Ctor;\n\n\t\t// Detect obvious negatives\n\t\t// Use toString instead of jQuery.type to catch host objects\n\t\tif ( !obj || toString.call( obj ) !== \"[object Object]\" ) {\n\t\t\treturn false;\n\t\t}\n\n\t\tproto = getProto( obj );\n\n\t\t// Objects with no prototype (e.g., `Object.create( null )`) are plain\n\t\tif ( !proto ) {\n\t\t\treturn true;\n\t\t}\n\n\t\t// Objects with prototype are plain iff they were constructed by a global Object function\n\t\tCtor = hasOwn.call( proto, \"constructor\" ) && proto.constructor;\n\t\treturn typeof Ctor === \"function\" && fnToString.call( Ctor ) === ObjectFunctionString;\n\t},\n\n\tisEmptyObject: function( obj ) {\n\t\tvar name;\n\n\t\tfor ( name in obj ) {\n\t\t\treturn false;\n\t\t}\n\t\treturn true;\n\t},\n\n\t// Evaluates a script in a provided context; falls back to the global one\n\t// if not specified.\n\tglobalEval: function( code, options, doc ) {\n\t\tDOMEval( code, { nonce: options && options.nonce }, doc );\n\t},\n\n\teach: function( obj, callback ) {\n\t\tvar length, i = 0;\n\n\t\tif ( isArrayLike( obj ) ) {\n\t\t\tlength = obj.length;\n\t\t\tfor ( ; i < length; i++ ) {\n\t\t\t\tif ( callback.call( obj[ i ], i, obj[ i ] ) === false ) {\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\tfor ( i in obj ) {\n\t\t\t\tif ( callback.call( obj[ i ], i, obj[ i ] ) === false ) {\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn obj;\n\t},\n\n\t// results is for internal usage only\n\tmakeArray: function( arr, results ) {\n\t\tvar ret = results || [];\n\n\t\tif ( arr != null ) {\n\t\t\tif ( isArrayLike( Object( arr ) ) ) {\n\t\t\t\tjQuery.merge( ret,\n\t\t\t\t\ttypeof arr === \"string\" ?\n\t\t\t\t\t\t[ arr ] : arr\n\t\t\t\t);\n\t\t\t} else {\n\t\t\t\tpush.call( ret, arr );\n\t\t\t}\n\t\t}\n\n\t\treturn ret;\n\t},\n\n\tinArray: function( elem, arr, i ) {\n\t\treturn arr == null ? -1 : indexOf.call( arr, elem, i );\n\t},\n\n\t// Support: Android <=4.0 only, PhantomJS 1 only\n\t// push.apply(_, arraylike) throws on ancient WebKit\n\tmerge: function( first, second ) {\n\t\tvar len = +second.length,\n\t\t\tj = 0,\n\t\t\ti = first.length;\n\n\t\tfor ( ; j < len; j++ ) {\n\t\t\tfirst[ i++ ] = second[ j ];\n\t\t}\n\n\t\tfirst.length = i;\n\n\t\treturn first;\n\t},\n\n\tgrep: function( elems, callback, invert ) {\n\t\tvar callbackInverse,\n\t\t\tmatches = [],\n\t\t\ti = 0,\n\t\t\tlength = elems.length,\n\t\t\tcallbackExpect = !invert;\n\n\t\t// Go through the array, only saving the items\n\t\t// that pass the validator function\n\t\tfor ( ; i < length; i++ ) {\n\t\t\tcallbackInverse = !callback( elems[ i ], i );\n\t\t\tif ( callbackInverse !== callbackExpect ) {\n\t\t\t\tmatches.push( elems[ i ] );\n\t\t\t}\n\t\t}\n\n\t\treturn matches;\n\t},\n\n\t// arg is for internal usage only\n\tmap: function( elems, callback, arg ) {\n\t\tvar length, value,\n\t\t\ti = 0,\n\t\t\tret = [];\n\n\t\t// Go through the array, translating each of the items to their new values\n\t\tif ( isArrayLike( elems ) ) {\n\t\t\tlength = elems.length;\n\t\t\tfor ( ; i < length; i++ ) {\n\t\t\t\tvalue = callback( elems[ i ], i, arg );\n\n\t\t\t\tif ( value != null ) {\n\t\t\t\t\tret.push( value );\n\t\t\t\t}\n\t\t\t}\n\n\t\t// Go through every key on the object,\n\t\t} else {\n\t\t\tfor ( i in elems ) {\n\t\t\t\tvalue = callback( elems[ i ], i, arg );\n\n\t\t\t\tif ( value != null ) {\n\t\t\t\t\tret.push( value );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\t// Flatten any nested arrays\n\t\treturn flat( ret );\n\t},\n\n\t// A global GUID counter for objects\n\tguid: 1,\n\n\t// jQuery.support is not used in Core but other projects attach their\n\t// properties to it so it needs to exist.\n\tsupport: support\n} );\n\nif ( typeof Symbol === \"function\" ) {\n\tjQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ];\n}\n\n// Populate the class2type map\njQuery.each( \"Boolean Number String Function Array Date RegExp Object Error Symbol\".split( \" \" ),\n\tfunction( _i, name ) {\n\t\tclass2type[ \"[object \" + name + \"]\" ] = name.toLowerCase();\n\t} );\n\nfunction isArrayLike( obj ) {\n\n\t// Support: real iOS 8.2 only (not reproducible in simulator)\n\t// `in` check used to prevent JIT error (gh-2145)\n\t// hasOwn isn't used here due to false negatives\n\t// regarding Nodelist length in IE\n\tvar length = !!obj && \"length\" in obj && obj.length,\n\t\ttype = toType( obj );\n\n\tif ( isFunction( obj ) || isWindow( obj ) ) {\n\t\treturn false;\n\t}\n\n\treturn type === \"array\" || length === 0 ||\n\t\ttypeof length === \"number\" && length > 0 && ( length - 1 ) in obj;\n}\nvar Sizzle =\n/*!\n * Sizzle CSS Selector Engine v2.3.6\n * https://sizzlejs.com/\n *\n * Copyright JS Foundation and other contributors\n * Released under the MIT license\n * https://js.foundation/\n *\n * Date: 2021-02-16\n */\n( function( window ) {\nvar i,\n\tsupport,\n\tExpr,\n\tgetText,\n\tisXML,\n\ttokenize,\n\tcompile,\n\tselect,\n\toutermostContext,\n\tsortInput,\n\thasDuplicate,\n\n\t// Local document vars\n\tsetDocument,\n\tdocument,\n\tdocElem,\n\tdocumentIsHTML,\n\trbuggyQSA,\n\trbuggyMatches,\n\tmatches,\n\tcontains,\n\n\t// Instance-specific data\n\texpando = \"sizzle\" + 1 * new Date(),\n\tpreferredDoc = window.document,\n\tdirruns = 0,\n\tdone = 0,\n\tclassCache = createCache(),\n\ttokenCache = createCache(),\n\tcompilerCache = createCache(),\n\tnonnativeSelectorCache = createCache(),\n\tsortOrder = function( a, b ) {\n\t\tif ( a === b ) {\n\t\t\thasDuplicate = true;\n\t\t}\n\t\treturn 0;\n\t},\n\n\t// Instance methods\n\thasOwn = ( {} ).hasOwnProperty,\n\tarr = [],\n\tpop = arr.pop,\n\tpushNative = arr.push,\n\tpush = arr.push,\n\tslice = arr.slice,\n\n\t// Use a stripped-down indexOf as it's faster than native\n\t// https://jsperf.com/thor-indexof-vs-for/5\n\tindexOf = function( list, elem ) {\n\t\tvar i = 0,\n\t\t\tlen = list.length;\n\t\tfor ( ; i < len; i++ ) {\n\t\t\tif ( list[ i ] === elem ) {\n\t\t\t\treturn i;\n\t\t\t}\n\t\t}\n\t\treturn -1;\n\t},\n\n\tbooleans = \"checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|\" +\n\t\t\"ismap|loop|multiple|open|readonly|required|scoped\",\n\n\t// Regular expressions\n\n\t// http://www.w3.org/TR/css3-selectors/#whitespace\n\twhitespace = \"[\\\\x20\\\\t\\\\r\\\\n\\\\f]\",\n\n\t// https://www.w3.org/TR/css-syntax-3/#ident-token-diagram\n\tidentifier = \"(?:\\\\\\\\[\\\\da-fA-F]{1,6}\" + whitespace +\n\t\t\"?|\\\\\\\\[^\\\\r\\\\n\\\\f]|[\\\\w-]|[^\\0-\\\\x7f])+\",\n\n\t// Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors\n\tattributes = \"\\\\[\" + whitespace + \"*(\" + identifier + \")(?:\" + whitespace +\n\n\t\t// Operator (capture 2)\n\t\t\"*([*^$|!~]?=)\" + whitespace +\n\n\t\t// \"Attribute values must be CSS identifiers [capture 5]\n\t\t// or strings [capture 3 or capture 4]\"\n\t\t\"*(?:'((?:\\\\\\\\.|[^\\\\\\\\'])*)'|\\\"((?:\\\\\\\\.|[^\\\\\\\\\\\"])*)\\\"|(\" + identifier + \"))|)\" +\n\t\twhitespace + \"*\\\\]\",\n\n\tpseudos = \":(\" + identifier + \")(?:\\\\((\" +\n\n\t\t// To reduce the number of selectors needing tokenize in the preFilter, prefer arguments:\n\t\t// 1. quoted (capture 3; capture 4 or capture 5)\n\t\t\"('((?:\\\\\\\\.|[^\\\\\\\\'])*)'|\\\"((?:\\\\\\\\.|[^\\\\\\\\\\\"])*)\\\")|\" +\n\n\t\t// 2. simple (capture 6)\n\t\t\"((?:\\\\\\\\.|[^\\\\\\\\()[\\\\]]|\" + attributes + \")*)|\" +\n\n\t\t// 3. anything else (capture 2)\n\t\t\".*\" +\n\t\t\")\\\\)|)\",\n\n\t// Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter\n\trwhitespace = new RegExp( whitespace + \"+\", \"g\" ),\n\trtrim = new RegExp( \"^\" + whitespace + \"+|((?:^|[^\\\\\\\\])(?:\\\\\\\\.)*)\" +\n\t\twhitespace + \"+$\", \"g\" ),\n\n\trcomma = new RegExp( \"^\" + whitespace + \"*,\" + whitespace + \"*\" ),\n\trcombinators = new RegExp( \"^\" + whitespace + \"*([>+~]|\" + whitespace + \")\" + whitespace +\n\t\t\"*\" ),\n\trdescend = new RegExp( whitespace + \"|>\" ),\n\n\trpseudo = new RegExp( pseudos ),\n\tridentifier = new RegExp( \"^\" + identifier + \"$\" ),\n\n\tmatchExpr = {\n\t\t\"ID\": new RegExp( \"^#(\" + identifier + \")\" ),\n\t\t\"CLASS\": new RegExp( \"^\\\\.(\" + identifier + \")\" ),\n\t\t\"TAG\": new RegExp( \"^(\" + identifier + \"|[*])\" ),\n\t\t\"ATTR\": new RegExp( \"^\" + attributes ),\n\t\t\"PSEUDO\": new RegExp( \"^\" + pseudos ),\n\t\t\"CHILD\": new RegExp( \"^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\\\(\" +\n\t\t\twhitespace + \"*(even|odd|(([+-]|)(\\\\d*)n|)\" + whitespace + \"*(?:([+-]|)\" +\n\t\t\twhitespace + \"*(\\\\d+)|))\" + whitespace + \"*\\\\)|)\", \"i\" ),\n\t\t\"bool\": new RegExp( \"^(?:\" + booleans + \")$\", \"i\" ),\n\n\t\t// For use in libraries implementing .is()\n\t\t// We use this for POS matching in `select`\n\t\t\"needsContext\": new RegExp( \"^\" + whitespace +\n\t\t\t\"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\\\(\" + whitespace +\n\t\t\t\"*((?:-\\\\d)?\\\\d*)\" + whitespace + \"*\\\\)|)(?=[^-]|$)\", \"i\" )\n\t},\n\n\trhtml = /HTML$/i,\n\trinputs = /^(?:input|select|textarea|button)$/i,\n\trheader = /^h\\d$/i,\n\n\trnative = /^[^{]+\\{\\s*\\[native \\w/,\n\n\t// Easily-parseable/retrievable ID or TAG or CLASS selectors\n\trquickExpr = /^(?:#([\\w-]+)|(\\w+)|\\.([\\w-]+))$/,\n\n\trsibling = /[+~]/,\n\n\t// CSS escapes\n\t// http://www.w3.org/TR/CSS21/syndata.html#escaped-characters\n\trunescape = new RegExp( \"\\\\\\\\[\\\\da-fA-F]{1,6}\" + whitespace + \"?|\\\\\\\\([^\\\\r\\\\n\\\\f])\", \"g\" ),\n\tfunescape = function( escape, nonHex ) {\n\t\tvar high = \"0x\" + escape.slice( 1 ) - 0x10000;\n\n\t\treturn nonHex ?\n\n\t\t\t// Strip the backslash prefix from a non-hex escape sequence\n\t\t\tnonHex :\n\n\t\t\t// Replace a hexadecimal escape sequence with the encoded Unicode code point\n\t\t\t// Support: IE <=11+\n\t\t\t// For values outside the Basic Multilingual Plane (BMP), manually construct a\n\t\t\t// surrogate pair\n\t\t\thigh < 0 ?\n\t\t\t\tString.fromCharCode( high + 0x10000 ) :\n\t\t\t\tString.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 );\n\t},\n\n\t// CSS string/identifier serialization\n\t// https://drafts.csswg.org/cssom/#common-serializing-idioms\n\trcssescape = /([\\0-\\x1f\\x7f]|^-?\\d)|^-$|[^\\0-\\x1f\\x7f-\\uFFFF\\w-]/g,\n\tfcssescape = function( ch, asCodePoint ) {\n\t\tif ( asCodePoint ) {\n\n\t\t\t// U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER\n\t\t\tif ( ch === \"\\0\" ) {\n\t\t\t\treturn \"\\uFFFD\";\n\t\t\t}\n\n\t\t\t// Control characters and (dependent upon position) numbers get escaped as code points\n\t\t\treturn ch.slice( 0, -1 ) + \"\\\\\" +\n\t\t\t\tch.charCodeAt( ch.length - 1 ).toString( 16 ) + \" \";\n\t\t}\n\n\t\t// Other potentially-special ASCII characters get backslash-escaped\n\t\treturn \"\\\\\" + ch;\n\t},\n\n\t// Used for iframes\n\t// See setDocument()\n\t// Removing the function wrapper causes a \"Permission Denied\"\n\t// error in IE\n\tunloadHandler = function() {\n\t\tsetDocument();\n\t},\n\n\tinDisabledFieldset = addCombinator(\n\t\tfunction( elem ) {\n\t\t\treturn elem.disabled === true && elem.nodeName.toLowerCase() === \"fieldset\";\n\t\t},\n\t\t{ dir: \"parentNode\", next: \"legend\" }\n\t);\n\n// Optimize for push.apply( _, NodeList )\ntry {\n\tpush.apply(\n\t\t( arr = slice.call( preferredDoc.childNodes ) ),\n\t\tpreferredDoc.childNodes\n\t);\n\n\t// Support: Android<4.0\n\t// Detect silently failing push.apply\n\t// eslint-disable-next-line no-unused-expressions\n\tarr[ preferredDoc.childNodes.length ].nodeType;\n} catch ( e ) {\n\tpush = { apply: arr.length ?\n\n\t\t// Leverage slice if possible\n\t\tfunction( target, els ) {\n\t\t\tpushNative.apply( target, slice.call( els ) );\n\t\t} :\n\n\t\t// Support: IE<9\n\t\t// Otherwise append directly\n\t\tfunction( target, els ) {\n\t\t\tvar j = target.length,\n\t\t\t\ti = 0;\n\n\t\t\t// Can't trust NodeList.length\n\t\t\twhile ( ( target[ j++ ] = els[ i++ ] ) ) {}\n\t\t\ttarget.length = j - 1;\n\t\t}\n\t};\n}\n\nfunction Sizzle( selector, context, results, seed ) {\n\tvar m, i, elem, nid, match, groups, newSelector,\n\t\tnewContext = context && context.ownerDocument,\n\n\t\t// nodeType defaults to 9, since context defaults to document\n\t\tnodeType = context ? context.nodeType : 9;\n\n\tresults = results || [];\n\n\t// Return early from calls with invalid selector or context\n\tif ( typeof selector !== \"string\" || !selector ||\n\t\tnodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) {\n\n\t\treturn results;\n\t}\n\n\t// Try to shortcut find operations (as opposed to filters) in HTML documents\n\tif ( !seed ) {\n\t\tsetDocument( context );\n\t\tcontext = context || document;\n\n\t\tif ( documentIsHTML ) {\n\n\t\t\t// If the selector is sufficiently simple, try using a \"get*By*\" DOM method\n\t\t\t// (excepting DocumentFragment context, where the methods don't exist)\n\t\t\tif ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) {\n\n\t\t\t\t// ID selector\n\t\t\t\tif ( ( m = match[ 1 ] ) ) {\n\n\t\t\t\t\t// Document context\n\t\t\t\t\tif ( nodeType === 9 ) {\n\t\t\t\t\t\tif ( ( elem = context.getElementById( m ) ) ) {\n\n\t\t\t\t\t\t\t// Support: IE, Opera, Webkit\n\t\t\t\t\t\t\t// TODO: identify versions\n\t\t\t\t\t\t\t// getElementById can match elements by name instead of ID\n\t\t\t\t\t\t\tif ( elem.id === m ) {\n\t\t\t\t\t\t\t\tresults.push( elem );\n\t\t\t\t\t\t\t\treturn results;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\treturn results;\n\t\t\t\t\t\t}\n\n\t\t\t\t\t// Element context\n\t\t\t\t\t} else {\n\n\t\t\t\t\t\t// Support: IE, Opera, Webkit\n\t\t\t\t\t\t// TODO: identify versions\n\t\t\t\t\t\t// getElementById can match elements by name instead of ID\n\t\t\t\t\t\tif ( newContext && ( elem = newContext.getElementById( m ) ) &&\n\t\t\t\t\t\t\tcontains( context, elem ) &&\n\t\t\t\t\t\t\telem.id === m ) {\n\n\t\t\t\t\t\t\tresults.push( elem );\n\t\t\t\t\t\t\treturn results;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t// Type selector\n\t\t\t\t} else if ( match[ 2 ] ) {\n\t\t\t\t\tpush.apply( results, context.getElementsByTagName( selector ) );\n\t\t\t\t\treturn results;\n\n\t\t\t\t// Class selector\n\t\t\t\t} else if ( ( m = match[ 3 ] ) && support.getElementsByClassName &&\n\t\t\t\t\tcontext.getElementsByClassName ) {\n\n\t\t\t\t\tpush.apply( results, context.getElementsByClassName( m ) );\n\t\t\t\t\treturn results;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Take advantage of querySelectorAll\n\t\t\tif ( support.qsa &&\n\t\t\t\t!nonnativeSelectorCache[ selector + \" \" ] &&\n\t\t\t\t( !rbuggyQSA || !rbuggyQSA.test( selector ) ) &&\n\n\t\t\t\t// Support: IE 8 only\n\t\t\t\t// Exclude object elements\n\t\t\t\t( nodeType !== 1 || context.nodeName.toLowerCase() !== \"object\" ) ) {\n\n\t\t\t\tnewSelector = selector;\n\t\t\t\tnewContext = context;\n\n\t\t\t\t// qSA considers elements outside a scoping root when evaluating child or\n\t\t\t\t// descendant combinators, which is not what we want.\n\t\t\t\t// In such cases, we work around the behavior by prefixing every selector in the\n\t\t\t\t// list with an ID selector referencing the scope context.\n\t\t\t\t// The technique has to be used as well when a leading combinator is used\n\t\t\t\t// as such selectors are not recognized by querySelectorAll.\n\t\t\t\t// Thanks to Andrew Dupont for this technique.\n\t\t\t\tif ( nodeType === 1 &&\n\t\t\t\t\t( rdescend.test( selector ) || rcombinators.test( selector ) ) ) {\n\n\t\t\t\t\t// Expand context for sibling selectors\n\t\t\t\t\tnewContext = rsibling.test( selector ) && testContext( context.parentNode ) ||\n\t\t\t\t\t\tcontext;\n\n\t\t\t\t\t// We can use :scope instead of the ID hack if the browser\n\t\t\t\t\t// supports it & if we're not changing the context.\n\t\t\t\t\tif ( newContext !== context || !support.scope ) {\n\n\t\t\t\t\t\t// Capture the context ID, setting it first if necessary\n\t\t\t\t\t\tif ( ( nid = context.getAttribute( \"id\" ) ) ) {\n\t\t\t\t\t\t\tnid = nid.replace( rcssescape, fcssescape );\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tcontext.setAttribute( \"id\", ( nid = expando ) );\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\t// Prefix every selector in the list\n\t\t\t\t\tgroups = tokenize( selector );\n\t\t\t\t\ti = groups.length;\n\t\t\t\t\twhile ( i-- ) {\n\t\t\t\t\t\tgroups[ i ] = ( nid ? \"#\" + nid : \":scope\" ) + \" \" +\n\t\t\t\t\t\t\ttoSelector( groups[ i ] );\n\t\t\t\t\t}\n\t\t\t\t\tnewSelector = groups.join( \",\" );\n\t\t\t\t}\n\n\t\t\t\ttry {\n\t\t\t\t\tpush.apply( results,\n\t\t\t\t\t\tnewContext.querySelectorAll( newSelector )\n\t\t\t\t\t);\n\t\t\t\t\treturn results;\n\t\t\t\t} catch ( qsaError ) {\n\t\t\t\t\tnonnativeSelectorCache( selector, true );\n\t\t\t\t} finally {\n\t\t\t\t\tif ( nid === expando ) {\n\t\t\t\t\t\tcontext.removeAttribute( \"id\" );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t// All others\n\treturn select( selector.replace( rtrim, \"$1\" ), context, results, seed );\n}\n\n/**\n * Create key-value caches of limited size\n * @returns {function(string, object)} Returns the Object data after storing it on itself with\n *\tproperty name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength)\n *\tdeleting the oldest entry\n */\nfunction createCache() {\n\tvar keys = [];\n\n\tfunction cache( key, value ) {\n\n\t\t// Use (key + \" \") to avoid collision with native prototype properties (see Issue #157)\n\t\tif ( keys.push( key + \" \" ) > Expr.cacheLength ) {\n\n\t\t\t// Only keep the most recent entries\n\t\t\tdelete cache[ keys.shift() ];\n\t\t}\n\t\treturn ( cache[ key + \" \" ] = value );\n\t}\n\treturn cache;\n}\n\n/**\n * Mark a function for special use by Sizzle\n * @param {Function} fn The function to mark\n */\nfunction markFunction( fn ) {\n\tfn[ expando ] = true;\n\treturn fn;\n}\n\n/**\n * Support testing using an element\n * @param {Function} fn Passed the created element and returns a boolean result\n */\nfunction assert( fn ) {\n\tvar el = document.createElement( \"fieldset\" );\n\n\ttry {\n\t\treturn !!fn( el );\n\t} catch ( e ) {\n\t\treturn false;\n\t} finally {\n\n\t\t// Remove from its parent by default\n\t\tif ( el.parentNode ) {\n\t\t\tel.parentNode.removeChild( el );\n\t\t}\n\n\t\t// release memory in IE\n\t\tel = null;\n\t}\n}\n\n/**\n * Adds the same handler for all of the specified attrs\n * @param {String} attrs Pipe-separated list of attributes\n * @param {Function} handler The method that will be applied\n */\nfunction addHandle( attrs, handler ) {\n\tvar arr = attrs.split( \"|\" ),\n\t\ti = arr.length;\n\n\twhile ( i-- ) {\n\t\tExpr.attrHandle[ arr[ i ] ] = handler;\n\t}\n}\n\n/**\n * Checks document order of two siblings\n * @param {Element} a\n * @param {Element} b\n * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b\n */\nfunction siblingCheck( a, b ) {\n\tvar cur = b && a,\n\t\tdiff = cur && a.nodeType === 1 && b.nodeType === 1 &&\n\t\t\ta.sourceIndex - b.sourceIndex;\n\n\t// Use IE sourceIndex if available on both nodes\n\tif ( diff ) {\n\t\treturn diff;\n\t}\n\n\t// Check if b follows a\n\tif ( cur ) {\n\t\twhile ( ( cur = cur.nextSibling ) ) {\n\t\t\tif ( cur === b ) {\n\t\t\t\treturn -1;\n\t\t\t}\n\t\t}\n\t}\n\n\treturn a ? 1 : -1;\n}\n\n/**\n * Returns a function to use in pseudos for input types\n * @param {String} type\n */\nfunction createInputPseudo( type ) {\n\treturn function( elem ) {\n\t\tvar name = elem.nodeName.toLowerCase();\n\t\treturn name === \"input\" && elem.type === type;\n\t};\n}\n\n/**\n * Returns a function to use in pseudos for buttons\n * @param {String} type\n */\nfunction createButtonPseudo( type ) {\n\treturn function( elem ) {\n\t\tvar name = elem.nodeName.toLowerCase();\n\t\treturn ( name === \"input\" || name === \"button\" ) && elem.type === type;\n\t};\n}\n\n/**\n * Returns a function to use in pseudos for :enabled/:disabled\n * @param {Boolean} disabled true for :disabled; false for :enabled\n */\nfunction createDisabledPseudo( disabled ) {\n\n\t// Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable\n\treturn function( elem ) {\n\n\t\t// Only certain elements can match :enabled or :disabled\n\t\t// https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled\n\t\t// https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled\n\t\tif ( \"form\" in elem ) {\n\n\t\t\t// Check for inherited disabledness on relevant non-disabled elements:\n\t\t\t// * listed form-associated elements in a disabled fieldset\n\t\t\t// https://html.spec.whatwg.org/multipage/forms.html#category-listed\n\t\t\t// https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled\n\t\t\t// * option elements in a disabled optgroup\n\t\t\t// https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled\n\t\t\t// All such elements have a \"form\" property.\n\t\t\tif ( elem.parentNode && elem.disabled === false ) {\n\n\t\t\t\t// Option elements defer to a parent optgroup if present\n\t\t\t\tif ( \"label\" in elem ) {\n\t\t\t\t\tif ( \"label\" in elem.parentNode ) {\n\t\t\t\t\t\treturn elem.parentNode.disabled === disabled;\n\t\t\t\t\t} else {\n\t\t\t\t\t\treturn elem.disabled === disabled;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// Support: IE 6 - 11\n\t\t\t\t// Use the isDisabled shortcut property to check for disabled fieldset ancestors\n\t\t\t\treturn elem.isDisabled === disabled ||\n\n\t\t\t\t\t// Where there is no isDisabled, check manually\n\t\t\t\t\t/* jshint -W018 */\n\t\t\t\t\telem.isDisabled !== !disabled &&\n\t\t\t\t\tinDisabledFieldset( elem ) === disabled;\n\t\t\t}\n\n\t\t\treturn elem.disabled === disabled;\n\n\t\t// Try to winnow out elements that can't be disabled before trusting the disabled property.\n\t\t// Some victims get caught in our net (label, legend, menu, track), but it shouldn't\n\t\t// even exist on them, let alone have a boolean value.\n\t\t} else if ( \"label\" in elem ) {\n\t\t\treturn elem.disabled === disabled;\n\t\t}\n\n\t\t// Remaining elements are neither :enabled nor :disabled\n\t\treturn false;\n\t};\n}\n\n/**\n * Returns a function to use in pseudos for positionals\n * @param {Function} fn\n */\nfunction createPositionalPseudo( fn ) {\n\treturn markFunction( function( argument ) {\n\t\targument = +argument;\n\t\treturn markFunction( function( seed, matches ) {\n\t\t\tvar j,\n\t\t\t\tmatchIndexes = fn( [], seed.length, argument ),\n\t\t\t\ti = matchIndexes.length;\n\n\t\t\t// Match elements found at the specified indexes\n\t\t\twhile ( i-- ) {\n\t\t\t\tif ( seed[ ( j = matchIndexes[ i ] ) ] ) {\n\t\t\t\t\tseed[ j ] = !( matches[ j ] = seed[ j ] );\n\t\t\t\t}\n\t\t\t}\n\t\t} );\n\t} );\n}\n\n/**\n * Checks a node for validity as a Sizzle context\n * @param {Element|Object=} context\n * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value\n */\nfunction testContext( context ) {\n\treturn context && typeof context.getElementsByTagName !== \"undefined\" && context;\n}\n\n// Expose support vars for convenience\nsupport = Sizzle.support = {};\n\n/**\n * Detects XML nodes\n * @param {Element|Object} elem An element or a document\n * @returns {Boolean} True iff elem is a non-HTML XML node\n */\nisXML = Sizzle.isXML = function( elem ) {\n\tvar namespace = elem && elem.namespaceURI,\n\t\tdocElem = elem && ( elem.ownerDocument || elem ).documentElement;\n\n\t// Support: IE <=8\n\t// Assume HTML when documentElement doesn't yet exist, such as inside loading iframes\n\t// https://bugs.jquery.com/ticket/4833\n\treturn !rhtml.test( namespace || docElem && docElem.nodeName || \"HTML\" );\n};\n\n/**\n * Sets document-related variables once based on the current document\n * @param {Element|Object} [doc] An element or document object to use to set the document\n * @returns {Object} Returns the current document\n */\nsetDocument = Sizzle.setDocument = function( node ) {\n\tvar hasCompare, subWindow,\n\t\tdoc = node ? node.ownerDocument || node : preferredDoc;\n\n\t// Return early if doc is invalid or already selected\n\t// Support: IE 11+, Edge 17 - 18+\n\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t// two documents; shallow comparisons work.\n\t// eslint-disable-next-line eqeqeq\n\tif ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) {\n\t\treturn document;\n\t}\n\n\t// Update global variables\n\tdocument = doc;\n\tdocElem = document.documentElement;\n\tdocumentIsHTML = !isXML( document );\n\n\t// Support: IE 9 - 11+, Edge 12 - 18+\n\t// Accessing iframe documents after unload throws \"permission denied\" errors (jQuery #13936)\n\t// Support: IE 11+, Edge 17 - 18+\n\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t// two documents; shallow comparisons work.\n\t// eslint-disable-next-line eqeqeq\n\tif ( preferredDoc != document &&\n\t\t( subWindow = document.defaultView ) && subWindow.top !== subWindow ) {\n\n\t\t// Support: IE 11, Edge\n\t\tif ( subWindow.addEventListener ) {\n\t\t\tsubWindow.addEventListener( \"unload\", unloadHandler, false );\n\n\t\t// Support: IE 9 - 10 only\n\t\t} else if ( subWindow.attachEvent ) {\n\t\t\tsubWindow.attachEvent( \"onunload\", unloadHandler );\n\t\t}\n\t}\n\n\t// Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only,\n\t// Safari 4 - 5 only, Opera <=11.6 - 12.x only\n\t// IE/Edge & older browsers don't support the :scope pseudo-class.\n\t// Support: Safari 6.0 only\n\t// Safari 6.0 supports :scope but it's an alias of :root there.\n\tsupport.scope = assert( function( el ) {\n\t\tdocElem.appendChild( el ).appendChild( document.createElement( \"div\" ) );\n\t\treturn typeof el.querySelectorAll !== \"undefined\" &&\n\t\t\t!el.querySelectorAll( \":scope fieldset div\" ).length;\n\t} );\n\n\t/* Attributes\n\t---------------------------------------------------------------------- */\n\n\t// Support: IE<8\n\t// Verify that getAttribute really returns attributes and not properties\n\t// (excepting IE8 booleans)\n\tsupport.attributes = assert( function( el ) {\n\t\tel.className = \"i\";\n\t\treturn !el.getAttribute( \"className\" );\n\t} );\n\n\t/* getElement(s)By*\n\t---------------------------------------------------------------------- */\n\n\t// Check if getElementsByTagName(\"*\") returns only elements\n\tsupport.getElementsByTagName = assert( function( el ) {\n\t\tel.appendChild( document.createComment( \"\" ) );\n\t\treturn !el.getElementsByTagName( \"*\" ).length;\n\t} );\n\n\t// Support: IE<9\n\tsupport.getElementsByClassName = rnative.test( document.getElementsByClassName );\n\n\t// Support: IE<10\n\t// Check if getElementById returns elements by name\n\t// The broken getElementById methods don't pick up programmatically-set names,\n\t// so use a roundabout getElementsByName test\n\tsupport.getById = assert( function( el ) {\n\t\tdocElem.appendChild( el ).id = expando;\n\t\treturn !document.getElementsByName || !document.getElementsByName( expando ).length;\n\t} );\n\n\t// ID filter and find\n\tif ( support.getById ) {\n\t\tExpr.filter[ \"ID\" ] = function( id ) {\n\t\t\tvar attrId = id.replace( runescape, funescape );\n\t\t\treturn function( elem ) {\n\t\t\t\treturn elem.getAttribute( \"id\" ) === attrId;\n\t\t\t};\n\t\t};\n\t\tExpr.find[ \"ID\" ] = function( id, context ) {\n\t\t\tif ( typeof context.getElementById !== \"undefined\" && documentIsHTML ) {\n\t\t\t\tvar elem = context.getElementById( id );\n\t\t\t\treturn elem ? [ elem ] : [];\n\t\t\t}\n\t\t};\n\t} else {\n\t\tExpr.filter[ \"ID\" ] = function( id ) {\n\t\t\tvar attrId = id.replace( runescape, funescape );\n\t\t\treturn function( elem ) {\n\t\t\t\tvar node = typeof elem.getAttributeNode !== \"undefined\" &&\n\t\t\t\t\telem.getAttributeNode( \"id\" );\n\t\t\t\treturn node && node.value === attrId;\n\t\t\t};\n\t\t};\n\n\t\t// Support: IE 6 - 7 only\n\t\t// getElementById is not reliable as a find shortcut\n\t\tExpr.find[ \"ID\" ] = function( id, context ) {\n\t\t\tif ( typeof context.getElementById !== \"undefined\" && documentIsHTML ) {\n\t\t\t\tvar node, i, elems,\n\t\t\t\t\telem = context.getElementById( id );\n\n\t\t\t\tif ( elem ) {\n\n\t\t\t\t\t// Verify the id attribute\n\t\t\t\t\tnode = elem.getAttributeNode( \"id\" );\n\t\t\t\t\tif ( node && node.value === id ) {\n\t\t\t\t\t\treturn [ elem ];\n\t\t\t\t\t}\n\n\t\t\t\t\t// Fall back on getElementsByName\n\t\t\t\t\telems = context.getElementsByName( id );\n\t\t\t\t\ti = 0;\n\t\t\t\t\twhile ( ( elem = elems[ i++ ] ) ) {\n\t\t\t\t\t\tnode = elem.getAttributeNode( \"id\" );\n\t\t\t\t\t\tif ( node && node.value === id ) {\n\t\t\t\t\t\t\treturn [ elem ];\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\treturn [];\n\t\t\t}\n\t\t};\n\t}\n\n\t// Tag\n\tExpr.find[ \"TAG\" ] = support.getElementsByTagName ?\n\t\tfunction( tag, context ) {\n\t\t\tif ( typeof context.getElementsByTagName !== \"undefined\" ) {\n\t\t\t\treturn context.getElementsByTagName( tag );\n\n\t\t\t// DocumentFragment nodes don't have gEBTN\n\t\t\t} else if ( support.qsa ) {\n\t\t\t\treturn context.querySelectorAll( tag );\n\t\t\t}\n\t\t} :\n\n\t\tfunction( tag, context ) {\n\t\t\tvar elem,\n\t\t\t\ttmp = [],\n\t\t\t\ti = 0,\n\n\t\t\t\t// By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too\n\t\t\t\tresults = context.getElementsByTagName( tag );\n\n\t\t\t// Filter out possible comments\n\t\t\tif ( tag === \"*\" ) {\n\t\t\t\twhile ( ( elem = results[ i++ ] ) ) {\n\t\t\t\t\tif ( elem.nodeType === 1 ) {\n\t\t\t\t\t\ttmp.push( elem );\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\treturn tmp;\n\t\t\t}\n\t\t\treturn results;\n\t\t};\n\n\t// Class\n\tExpr.find[ \"CLASS\" ] = support.getElementsByClassName && function( className, context ) {\n\t\tif ( typeof context.getElementsByClassName !== \"undefined\" && documentIsHTML ) {\n\t\t\treturn context.getElementsByClassName( className );\n\t\t}\n\t};\n\n\t/* QSA/matchesSelector\n\t---------------------------------------------------------------------- */\n\n\t// QSA and matchesSelector support\n\n\t// matchesSelector(:active) reports false when true (IE9/Opera 11.5)\n\trbuggyMatches = [];\n\n\t// qSa(:focus) reports false when true (Chrome 21)\n\t// We allow this because of a bug in IE8/9 that throws an error\n\t// whenever `document.activeElement` is accessed on an iframe\n\t// So, we allow :focus to pass through QSA all the time to avoid the IE error\n\t// See https://bugs.jquery.com/ticket/13378\n\trbuggyQSA = [];\n\n\tif ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) {\n\n\t\t// Build QSA regex\n\t\t// Regex strategy adopted from Diego Perini\n\t\tassert( function( el ) {\n\n\t\t\tvar input;\n\n\t\t\t// Select is set to empty string on purpose\n\t\t\t// This is to test IE's treatment of not explicitly\n\t\t\t// setting a boolean content attribute,\n\t\t\t// since its presence should be enough\n\t\t\t// https://bugs.jquery.com/ticket/12359\n\t\t\tdocElem.appendChild( el ).innerHTML = \"\" +\n\t\t\t\t\"\";\n\n\t\t\t// Support: IE8, Opera 11-12.16\n\t\t\t// Nothing should be selected when empty strings follow ^= or $= or *=\n\t\t\t// The test attribute must be unknown in Opera but \"safe\" for WinRT\n\t\t\t// https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section\n\t\t\tif ( el.querySelectorAll( \"[msallowcapture^='']\" ).length ) {\n\t\t\t\trbuggyQSA.push( \"[*^$]=\" + whitespace + \"*(?:''|\\\"\\\")\" );\n\t\t\t}\n\n\t\t\t// Support: IE8\n\t\t\t// Boolean attributes and \"value\" are not treated correctly\n\t\t\tif ( !el.querySelectorAll( \"[selected]\" ).length ) {\n\t\t\t\trbuggyQSA.push( \"\\\\[\" + whitespace + \"*(?:value|\" + booleans + \")\" );\n\t\t\t}\n\n\t\t\t// Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+\n\t\t\tif ( !el.querySelectorAll( \"[id~=\" + expando + \"-]\" ).length ) {\n\t\t\t\trbuggyQSA.push( \"~=\" );\n\t\t\t}\n\n\t\t\t// Support: IE 11+, Edge 15 - 18+\n\t\t\t// IE 11/Edge don't find elements on a `[name='']` query in some cases.\n\t\t\t// Adding a temporary attribute to the document before the selection works\n\t\t\t// around the issue.\n\t\t\t// Interestingly, IE 10 & older don't seem to have the issue.\n\t\t\tinput = document.createElement( \"input\" );\n\t\t\tinput.setAttribute( \"name\", \"\" );\n\t\t\tel.appendChild( input );\n\t\t\tif ( !el.querySelectorAll( \"[name='']\" ).length ) {\n\t\t\t\trbuggyQSA.push( \"\\\\[\" + whitespace + \"*name\" + whitespace + \"*=\" +\n\t\t\t\t\twhitespace + \"*(?:''|\\\"\\\")\" );\n\t\t\t}\n\n\t\t\t// Webkit/Opera - :checked should return selected option elements\n\t\t\t// http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked\n\t\t\t// IE8 throws error here and will not see later tests\n\t\t\tif ( !el.querySelectorAll( \":checked\" ).length ) {\n\t\t\t\trbuggyQSA.push( \":checked\" );\n\t\t\t}\n\n\t\t\t// Support: Safari 8+, iOS 8+\n\t\t\t// https://bugs.webkit.org/show_bug.cgi?id=136851\n\t\t\t// In-page `selector#id sibling-combinator selector` fails\n\t\t\tif ( !el.querySelectorAll( \"a#\" + expando + \"+*\" ).length ) {\n\t\t\t\trbuggyQSA.push( \".#.+[+~]\" );\n\t\t\t}\n\n\t\t\t// Support: Firefox <=3.6 - 5 only\n\t\t\t// Old Firefox doesn't throw on a badly-escaped identifier.\n\t\t\tel.querySelectorAll( \"\\\\\\f\" );\n\t\t\trbuggyQSA.push( \"[\\\\r\\\\n\\\\f]\" );\n\t\t} );\n\n\t\tassert( function( el ) {\n\t\t\tel.innerHTML = \"\" +\n\t\t\t\t\"\";\n\n\t\t\t// Support: Windows 8 Native Apps\n\t\t\t// The type and name attributes are restricted during .innerHTML assignment\n\t\t\tvar input = document.createElement( \"input\" );\n\t\t\tinput.setAttribute( \"type\", \"hidden\" );\n\t\t\tel.appendChild( input ).setAttribute( \"name\", \"D\" );\n\n\t\t\t// Support: IE8\n\t\t\t// Enforce case-sensitivity of name attribute\n\t\t\tif ( el.querySelectorAll( \"[name=d]\" ).length ) {\n\t\t\t\trbuggyQSA.push( \"name\" + whitespace + \"*[*^$|!~]?=\" );\n\t\t\t}\n\n\t\t\t// FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled)\n\t\t\t// IE8 throws error here and will not see later tests\n\t\t\tif ( el.querySelectorAll( \":enabled\" ).length !== 2 ) {\n\t\t\t\trbuggyQSA.push( \":enabled\", \":disabled\" );\n\t\t\t}\n\n\t\t\t// Support: IE9-11+\n\t\t\t// IE's :disabled selector does not pick up the children of disabled fieldsets\n\t\t\tdocElem.appendChild( el ).disabled = true;\n\t\t\tif ( el.querySelectorAll( \":disabled\" ).length !== 2 ) {\n\t\t\t\trbuggyQSA.push( \":enabled\", \":disabled\" );\n\t\t\t}\n\n\t\t\t// Support: Opera 10 - 11 only\n\t\t\t// Opera 10-11 does not throw on post-comma invalid pseudos\n\t\t\tel.querySelectorAll( \"*,:x\" );\n\t\t\trbuggyQSA.push( \",.*:\" );\n\t\t} );\n\t}\n\n\tif ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches ||\n\t\tdocElem.webkitMatchesSelector ||\n\t\tdocElem.mozMatchesSelector ||\n\t\tdocElem.oMatchesSelector ||\n\t\tdocElem.msMatchesSelector ) ) ) ) {\n\n\t\tassert( function( el ) {\n\n\t\t\t// Check to see if it's possible to do matchesSelector\n\t\t\t// on a disconnected node (IE 9)\n\t\t\tsupport.disconnectedMatch = matches.call( el, \"*\" );\n\n\t\t\t// This should fail with an exception\n\t\t\t// Gecko does not error, returns false instead\n\t\t\tmatches.call( el, \"[s!='']:x\" );\n\t\t\trbuggyMatches.push( \"!=\", pseudos );\n\t\t} );\n\t}\n\n\trbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( \"|\" ) );\n\trbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( \"|\" ) );\n\n\t/* Contains\n\t---------------------------------------------------------------------- */\n\thasCompare = rnative.test( docElem.compareDocumentPosition );\n\n\t// Element contains another\n\t// Purposefully self-exclusive\n\t// As in, an element does not contain itself\n\tcontains = hasCompare || rnative.test( docElem.contains ) ?\n\t\tfunction( a, b ) {\n\t\t\tvar adown = a.nodeType === 9 ? a.documentElement : a,\n\t\t\t\tbup = b && b.parentNode;\n\t\t\treturn a === bup || !!( bup && bup.nodeType === 1 && (\n\t\t\t\tadown.contains ?\n\t\t\t\t\tadown.contains( bup ) :\n\t\t\t\t\ta.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16\n\t\t\t) );\n\t\t} :\n\t\tfunction( a, b ) {\n\t\t\tif ( b ) {\n\t\t\t\twhile ( ( b = b.parentNode ) ) {\n\t\t\t\t\tif ( b === a ) {\n\t\t\t\t\t\treturn true;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn false;\n\t\t};\n\n\t/* Sorting\n\t---------------------------------------------------------------------- */\n\n\t// Document order sorting\n\tsortOrder = hasCompare ?\n\tfunction( a, b ) {\n\n\t\t// Flag for duplicate removal\n\t\tif ( a === b ) {\n\t\t\thasDuplicate = true;\n\t\t\treturn 0;\n\t\t}\n\n\t\t// Sort on method existence if only one input has compareDocumentPosition\n\t\tvar compare = !a.compareDocumentPosition - !b.compareDocumentPosition;\n\t\tif ( compare ) {\n\t\t\treturn compare;\n\t\t}\n\n\t\t// Calculate position if both inputs belong to the same document\n\t\t// Support: IE 11+, Edge 17 - 18+\n\t\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t\t// two documents; shallow comparisons work.\n\t\t// eslint-disable-next-line eqeqeq\n\t\tcompare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ?\n\t\t\ta.compareDocumentPosition( b ) :\n\n\t\t\t// Otherwise we know they are disconnected\n\t\t\t1;\n\n\t\t// Disconnected nodes\n\t\tif ( compare & 1 ||\n\t\t\t( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) {\n\n\t\t\t// Choose the first element that is related to our preferred document\n\t\t\t// Support: IE 11+, Edge 17 - 18+\n\t\t\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t\t\t// two documents; shallow comparisons work.\n\t\t\t// eslint-disable-next-line eqeqeq\n\t\t\tif ( a == document || a.ownerDocument == preferredDoc &&\n\t\t\t\tcontains( preferredDoc, a ) ) {\n\t\t\t\treturn -1;\n\t\t\t}\n\n\t\t\t// Support: IE 11+, Edge 17 - 18+\n\t\t\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t\t\t// two documents; shallow comparisons work.\n\t\t\t// eslint-disable-next-line eqeqeq\n\t\t\tif ( b == document || b.ownerDocument == preferredDoc &&\n\t\t\t\tcontains( preferredDoc, b ) ) {\n\t\t\t\treturn 1;\n\t\t\t}\n\n\t\t\t// Maintain original order\n\t\t\treturn sortInput ?\n\t\t\t\t( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) :\n\t\t\t\t0;\n\t\t}\n\n\t\treturn compare & 4 ? -1 : 1;\n\t} :\n\tfunction( a, b ) {\n\n\t\t// Exit early if the nodes are identical\n\t\tif ( a === b ) {\n\t\t\thasDuplicate = true;\n\t\t\treturn 0;\n\t\t}\n\n\t\tvar cur,\n\t\t\ti = 0,\n\t\t\taup = a.parentNode,\n\t\t\tbup = b.parentNode,\n\t\t\tap = [ a ],\n\t\t\tbp = [ b ];\n\n\t\t// Parentless nodes are either documents or disconnected\n\t\tif ( !aup || !bup ) {\n\n\t\t\t// Support: IE 11+, Edge 17 - 18+\n\t\t\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t\t\t// two documents; shallow comparisons work.\n\t\t\t/* eslint-disable eqeqeq */\n\t\t\treturn a == document ? -1 :\n\t\t\t\tb == document ? 1 :\n\t\t\t\t/* eslint-enable eqeqeq */\n\t\t\t\taup ? -1 :\n\t\t\t\tbup ? 1 :\n\t\t\t\tsortInput ?\n\t\t\t\t( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) :\n\t\t\t\t0;\n\n\t\t// If the nodes are siblings, we can do a quick check\n\t\t} else if ( aup === bup ) {\n\t\t\treturn siblingCheck( a, b );\n\t\t}\n\n\t\t// Otherwise we need full lists of their ancestors for comparison\n\t\tcur = a;\n\t\twhile ( ( cur = cur.parentNode ) ) {\n\t\t\tap.unshift( cur );\n\t\t}\n\t\tcur = b;\n\t\twhile ( ( cur = cur.parentNode ) ) {\n\t\t\tbp.unshift( cur );\n\t\t}\n\n\t\t// Walk down the tree looking for a discrepancy\n\t\twhile ( ap[ i ] === bp[ i ] ) {\n\t\t\ti++;\n\t\t}\n\n\t\treturn i ?\n\n\t\t\t// Do a sibling check if the nodes have a common ancestor\n\t\t\tsiblingCheck( ap[ i ], bp[ i ] ) :\n\n\t\t\t// Otherwise nodes in our document sort first\n\t\t\t// Support: IE 11+, Edge 17 - 18+\n\t\t\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t\t\t// two documents; shallow comparisons work.\n\t\t\t/* eslint-disable eqeqeq */\n\t\t\tap[ i ] == preferredDoc ? -1 :\n\t\t\tbp[ i ] == preferredDoc ? 1 :\n\t\t\t/* eslint-enable eqeqeq */\n\t\t\t0;\n\t};\n\n\treturn document;\n};\n\nSizzle.matches = function( expr, elements ) {\n\treturn Sizzle( expr, null, null, elements );\n};\n\nSizzle.matchesSelector = function( elem, expr ) {\n\tsetDocument( elem );\n\n\tif ( support.matchesSelector && documentIsHTML &&\n\t\t!nonnativeSelectorCache[ expr + \" \" ] &&\n\t\t( !rbuggyMatches || !rbuggyMatches.test( expr ) ) &&\n\t\t( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) {\n\n\t\ttry {\n\t\t\tvar ret = matches.call( elem, expr );\n\n\t\t\t// IE 9's matchesSelector returns false on disconnected nodes\n\t\t\tif ( ret || support.disconnectedMatch ||\n\n\t\t\t\t// As well, disconnected nodes are said to be in a document\n\t\t\t\t// fragment in IE 9\n\t\t\t\telem.document && elem.document.nodeType !== 11 ) {\n\t\t\t\treturn ret;\n\t\t\t}\n\t\t} catch ( e ) {\n\t\t\tnonnativeSelectorCache( expr, true );\n\t\t}\n\t}\n\n\treturn Sizzle( expr, document, null, [ elem ] ).length > 0;\n};\n\nSizzle.contains = function( context, elem ) {\n\n\t// Set document vars if needed\n\t// Support: IE 11+, Edge 17 - 18+\n\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t// two documents; shallow comparisons work.\n\t// eslint-disable-next-line eqeqeq\n\tif ( ( context.ownerDocument || context ) != document ) {\n\t\tsetDocument( context );\n\t}\n\treturn contains( context, elem );\n};\n\nSizzle.attr = function( elem, name ) {\n\n\t// Set document vars if needed\n\t// Support: IE 11+, Edge 17 - 18+\n\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t// two documents; shallow comparisons work.\n\t// eslint-disable-next-line eqeqeq\n\tif ( ( elem.ownerDocument || elem ) != document ) {\n\t\tsetDocument( elem );\n\t}\n\n\tvar fn = Expr.attrHandle[ name.toLowerCase() ],\n\n\t\t// Don't get fooled by Object.prototype properties (jQuery #13807)\n\t\tval = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ?\n\t\t\tfn( elem, name, !documentIsHTML ) :\n\t\t\tundefined;\n\n\treturn val !== undefined ?\n\t\tval :\n\t\tsupport.attributes || !documentIsHTML ?\n\t\t\telem.getAttribute( name ) :\n\t\t\t( val = elem.getAttributeNode( name ) ) && val.specified ?\n\t\t\t\tval.value :\n\t\t\t\tnull;\n};\n\nSizzle.escape = function( sel ) {\n\treturn ( sel + \"\" ).replace( rcssescape, fcssescape );\n};\n\nSizzle.error = function( msg ) {\n\tthrow new Error( \"Syntax error, unrecognized expression: \" + msg );\n};\n\n/**\n * Document sorting and removing duplicates\n * @param {ArrayLike} results\n */\nSizzle.uniqueSort = function( results ) {\n\tvar elem,\n\t\tduplicates = [],\n\t\tj = 0,\n\t\ti = 0;\n\n\t// Unless we *know* we can detect duplicates, assume their presence\n\thasDuplicate = !support.detectDuplicates;\n\tsortInput = !support.sortStable && results.slice( 0 );\n\tresults.sort( sortOrder );\n\n\tif ( hasDuplicate ) {\n\t\twhile ( ( elem = results[ i++ ] ) ) {\n\t\t\tif ( elem === results[ i ] ) {\n\t\t\t\tj = duplicates.push( i );\n\t\t\t}\n\t\t}\n\t\twhile ( j-- ) {\n\t\t\tresults.splice( duplicates[ j ], 1 );\n\t\t}\n\t}\n\n\t// Clear input after sorting to release objects\n\t// See https://github.com/jquery/sizzle/pull/225\n\tsortInput = null;\n\n\treturn results;\n};\n\n/**\n * Utility function for retrieving the text value of an array of DOM nodes\n * @param {Array|Element} elem\n */\ngetText = Sizzle.getText = function( elem ) {\n\tvar node,\n\t\tret = \"\",\n\t\ti = 0,\n\t\tnodeType = elem.nodeType;\n\n\tif ( !nodeType ) {\n\n\t\t// If no nodeType, this is expected to be an array\n\t\twhile ( ( node = elem[ i++ ] ) ) {\n\n\t\t\t// Do not traverse comment nodes\n\t\t\tret += getText( node );\n\t\t}\n\t} else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) {\n\n\t\t// Use textContent for elements\n\t\t// innerText usage removed for consistency of new lines (jQuery #11153)\n\t\tif ( typeof elem.textContent === \"string\" ) {\n\t\t\treturn elem.textContent;\n\t\t} else {\n\n\t\t\t// Traverse its children\n\t\t\tfor ( elem = elem.firstChild; elem; elem = elem.nextSibling ) {\n\t\t\t\tret += getText( elem );\n\t\t\t}\n\t\t}\n\t} else if ( nodeType === 3 || nodeType === 4 ) {\n\t\treturn elem.nodeValue;\n\t}\n\n\t// Do not include comment or processing instruction nodes\n\n\treturn ret;\n};\n\nExpr = Sizzle.selectors = {\n\n\t// Can be adjusted by the user\n\tcacheLength: 50,\n\n\tcreatePseudo: markFunction,\n\n\tmatch: matchExpr,\n\n\tattrHandle: {},\n\n\tfind: {},\n\n\trelative: {\n\t\t\">\": { dir: \"parentNode\", first: true },\n\t\t\" \": { dir: \"parentNode\" },\n\t\t\"+\": { dir: \"previousSibling\", first: true },\n\t\t\"~\": { dir: \"previousSibling\" }\n\t},\n\n\tpreFilter: {\n\t\t\"ATTR\": function( match ) {\n\t\t\tmatch[ 1 ] = match[ 1 ].replace( runescape, funescape );\n\n\t\t\t// Move the given value to match[3] whether quoted or unquoted\n\t\t\tmatch[ 3 ] = ( match[ 3 ] || match[ 4 ] ||\n\t\t\t\tmatch[ 5 ] || \"\" ).replace( runescape, funescape );\n\n\t\t\tif ( match[ 2 ] === \"~=\" ) {\n\t\t\t\tmatch[ 3 ] = \" \" + match[ 3 ] + \" \";\n\t\t\t}\n\n\t\t\treturn match.slice( 0, 4 );\n\t\t},\n\n\t\t\"CHILD\": function( match ) {\n\n\t\t\t/* matches from matchExpr[\"CHILD\"]\n\t\t\t\t1 type (only|nth|...)\n\t\t\t\t2 what (child|of-type)\n\t\t\t\t3 argument (even|odd|\\d*|\\d*n([+-]\\d+)?|...)\n\t\t\t\t4 xn-component of xn+y argument ([+-]?\\d*n|)\n\t\t\t\t5 sign of xn-component\n\t\t\t\t6 x of xn-component\n\t\t\t\t7 sign of y-component\n\t\t\t\t8 y of y-component\n\t\t\t*/\n\t\t\tmatch[ 1 ] = match[ 1 ].toLowerCase();\n\n\t\t\tif ( match[ 1 ].slice( 0, 3 ) === \"nth\" ) {\n\n\t\t\t\t// nth-* requires argument\n\t\t\t\tif ( !match[ 3 ] ) {\n\t\t\t\t\tSizzle.error( match[ 0 ] );\n\t\t\t\t}\n\n\t\t\t\t// numeric x and y parameters for Expr.filter.CHILD\n\t\t\t\t// remember that false/true cast respectively to 0/1\n\t\t\t\tmatch[ 4 ] = +( match[ 4 ] ?\n\t\t\t\t\tmatch[ 5 ] + ( match[ 6 ] || 1 ) :\n\t\t\t\t\t2 * ( match[ 3 ] === \"even\" || match[ 3 ] === \"odd\" ) );\n\t\t\t\tmatch[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === \"odd\" );\n\n\t\t\t\t// other types prohibit arguments\n\t\t\t} else if ( match[ 3 ] ) {\n\t\t\t\tSizzle.error( match[ 0 ] );\n\t\t\t}\n\n\t\t\treturn match;\n\t\t},\n\n\t\t\"PSEUDO\": function( match ) {\n\t\t\tvar excess,\n\t\t\t\tunquoted = !match[ 6 ] && match[ 2 ];\n\n\t\t\tif ( matchExpr[ \"CHILD\" ].test( match[ 0 ] ) ) {\n\t\t\t\treturn null;\n\t\t\t}\n\n\t\t\t// Accept quoted arguments as-is\n\t\t\tif ( match[ 3 ] ) {\n\t\t\t\tmatch[ 2 ] = match[ 4 ] || match[ 5 ] || \"\";\n\n\t\t\t// Strip excess characters from unquoted arguments\n\t\t\t} else if ( unquoted && rpseudo.test( unquoted ) &&\n\n\t\t\t\t// Get excess from tokenize (recursively)\n\t\t\t\t( excess = tokenize( unquoted, true ) ) &&\n\n\t\t\t\t// advance to the next closing parenthesis\n\t\t\t\t( excess = unquoted.indexOf( \")\", unquoted.length - excess ) - unquoted.length ) ) {\n\n\t\t\t\t// excess is a negative index\n\t\t\t\tmatch[ 0 ] = match[ 0 ].slice( 0, excess );\n\t\t\t\tmatch[ 2 ] = unquoted.slice( 0, excess );\n\t\t\t}\n\n\t\t\t// Return only captures needed by the pseudo filter method (type and argument)\n\t\t\treturn match.slice( 0, 3 );\n\t\t}\n\t},\n\n\tfilter: {\n\n\t\t\"TAG\": function( nodeNameSelector ) {\n\t\t\tvar nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase();\n\t\t\treturn nodeNameSelector === \"*\" ?\n\t\t\t\tfunction() {\n\t\t\t\t\treturn true;\n\t\t\t\t} :\n\t\t\t\tfunction( elem ) {\n\t\t\t\t\treturn elem.nodeName && elem.nodeName.toLowerCase() === nodeName;\n\t\t\t\t};\n\t\t},\n\n\t\t\"CLASS\": function( className ) {\n\t\t\tvar pattern = classCache[ className + \" \" ];\n\n\t\t\treturn pattern ||\n\t\t\t\t( pattern = new RegExp( \"(^|\" + whitespace +\n\t\t\t\t\t\")\" + className + \"(\" + whitespace + \"|$)\" ) ) && classCache(\n\t\t\t\t\t\tclassName, function( elem ) {\n\t\t\t\t\t\t\treturn pattern.test(\n\t\t\t\t\t\t\t\ttypeof elem.className === \"string\" && elem.className ||\n\t\t\t\t\t\t\t\ttypeof elem.getAttribute !== \"undefined\" &&\n\t\t\t\t\t\t\t\t\telem.getAttribute( \"class\" ) ||\n\t\t\t\t\t\t\t\t\"\"\n\t\t\t\t\t\t\t);\n\t\t\t\t} );\n\t\t},\n\n\t\t\"ATTR\": function( name, operator, check ) {\n\t\t\treturn function( elem ) {\n\t\t\t\tvar result = Sizzle.attr( elem, name );\n\n\t\t\t\tif ( result == null ) {\n\t\t\t\t\treturn operator === \"!=\";\n\t\t\t\t}\n\t\t\t\tif ( !operator ) {\n\t\t\t\t\treturn true;\n\t\t\t\t}\n\n\t\t\t\tresult += \"\";\n\n\t\t\t\t/* eslint-disable max-len */\n\n\t\t\t\treturn operator === \"=\" ? result === check :\n\t\t\t\t\toperator === \"!=\" ? result !== check :\n\t\t\t\t\toperator === \"^=\" ? check && result.indexOf( check ) === 0 :\n\t\t\t\t\toperator === \"*=\" ? check && result.indexOf( check ) > -1 :\n\t\t\t\t\toperator === \"$=\" ? check && result.slice( -check.length ) === check :\n\t\t\t\t\toperator === \"~=\" ? ( \" \" + result.replace( rwhitespace, \" \" ) + \" \" ).indexOf( check ) > -1 :\n\t\t\t\t\toperator === \"|=\" ? result === check || result.slice( 0, check.length + 1 ) === check + \"-\" :\n\t\t\t\t\tfalse;\n\t\t\t\t/* eslint-enable max-len */\n\n\t\t\t};\n\t\t},\n\n\t\t\"CHILD\": function( type, what, _argument, first, last ) {\n\t\t\tvar simple = type.slice( 0, 3 ) !== \"nth\",\n\t\t\t\tforward = type.slice( -4 ) !== \"last\",\n\t\t\t\tofType = what === \"of-type\";\n\n\t\t\treturn first === 1 && last === 0 ?\n\n\t\t\t\t// Shortcut for :nth-*(n)\n\t\t\t\tfunction( elem ) {\n\t\t\t\t\treturn !!elem.parentNode;\n\t\t\t\t} :\n\n\t\t\t\tfunction( elem, _context, xml ) {\n\t\t\t\t\tvar cache, uniqueCache, outerCache, node, nodeIndex, start,\n\t\t\t\t\t\tdir = simple !== forward ? \"nextSibling\" : \"previousSibling\",\n\t\t\t\t\t\tparent = elem.parentNode,\n\t\t\t\t\t\tname = ofType && elem.nodeName.toLowerCase(),\n\t\t\t\t\t\tuseCache = !xml && !ofType,\n\t\t\t\t\t\tdiff = false;\n\n\t\t\t\t\tif ( parent ) {\n\n\t\t\t\t\t\t// :(first|last|only)-(child|of-type)\n\t\t\t\t\t\tif ( simple ) {\n\t\t\t\t\t\t\twhile ( dir ) {\n\t\t\t\t\t\t\t\tnode = elem;\n\t\t\t\t\t\t\t\twhile ( ( node = node[ dir ] ) ) {\n\t\t\t\t\t\t\t\t\tif ( ofType ?\n\t\t\t\t\t\t\t\t\t\tnode.nodeName.toLowerCase() === name :\n\t\t\t\t\t\t\t\t\t\tnode.nodeType === 1 ) {\n\n\t\t\t\t\t\t\t\t\t\treturn false;\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\t// Reverse direction for :only-* (if we haven't yet done so)\n\t\t\t\t\t\t\t\tstart = dir = type === \"only\" && !start && \"nextSibling\";\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\treturn true;\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\tstart = [ forward ? parent.firstChild : parent.lastChild ];\n\n\t\t\t\t\t\t// non-xml :nth-child(...) stores cache data on `parent`\n\t\t\t\t\t\tif ( forward && useCache ) {\n\n\t\t\t\t\t\t\t// Seek `elem` from a previously-cached index\n\n\t\t\t\t\t\t\t// ...in a gzip-friendly way\n\t\t\t\t\t\t\tnode = parent;\n\t\t\t\t\t\t\touterCache = node[ expando ] || ( node[ expando ] = {} );\n\n\t\t\t\t\t\t\t// Support: IE <9 only\n\t\t\t\t\t\t\t// Defend against cloned attroperties (jQuery gh-1709)\n\t\t\t\t\t\t\tuniqueCache = outerCache[ node.uniqueID ] ||\n\t\t\t\t\t\t\t\t( outerCache[ node.uniqueID ] = {} );\n\n\t\t\t\t\t\t\tcache = uniqueCache[ type ] || [];\n\t\t\t\t\t\t\tnodeIndex = cache[ 0 ] === dirruns && cache[ 1 ];\n\t\t\t\t\t\t\tdiff = nodeIndex && cache[ 2 ];\n\t\t\t\t\t\t\tnode = nodeIndex && parent.childNodes[ nodeIndex ];\n\n\t\t\t\t\t\t\twhile ( ( node = ++nodeIndex && node && node[ dir ] ||\n\n\t\t\t\t\t\t\t\t// Fallback to seeking `elem` from the start\n\t\t\t\t\t\t\t\t( diff = nodeIndex = 0 ) || start.pop() ) ) {\n\n\t\t\t\t\t\t\t\t// When found, cache indexes on `parent` and break\n\t\t\t\t\t\t\t\tif ( node.nodeType === 1 && ++diff && node === elem ) {\n\t\t\t\t\t\t\t\t\tuniqueCache[ type ] = [ dirruns, nodeIndex, diff ];\n\t\t\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t} else {\n\n\t\t\t\t\t\t\t// Use previously-cached element index if available\n\t\t\t\t\t\t\tif ( useCache ) {\n\n\t\t\t\t\t\t\t\t// ...in a gzip-friendly way\n\t\t\t\t\t\t\t\tnode = elem;\n\t\t\t\t\t\t\t\touterCache = node[ expando ] || ( node[ expando ] = {} );\n\n\t\t\t\t\t\t\t\t// Support: IE <9 only\n\t\t\t\t\t\t\t\t// Defend against cloned attroperties (jQuery gh-1709)\n\t\t\t\t\t\t\t\tuniqueCache = outerCache[ node.uniqueID ] ||\n\t\t\t\t\t\t\t\t\t( outerCache[ node.uniqueID ] = {} );\n\n\t\t\t\t\t\t\t\tcache = uniqueCache[ type ] || [];\n\t\t\t\t\t\t\t\tnodeIndex = cache[ 0 ] === dirruns && cache[ 1 ];\n\t\t\t\t\t\t\t\tdiff = nodeIndex;\n\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t// xml :nth-child(...)\n\t\t\t\t\t\t\t// or :nth-last-child(...) or :nth(-last)?-of-type(...)\n\t\t\t\t\t\t\tif ( diff === false ) {\n\n\t\t\t\t\t\t\t\t// Use the same loop as above to seek `elem` from the start\n\t\t\t\t\t\t\t\twhile ( ( node = ++nodeIndex && node && node[ dir ] ||\n\t\t\t\t\t\t\t\t\t( diff = nodeIndex = 0 ) || start.pop() ) ) {\n\n\t\t\t\t\t\t\t\t\tif ( ( ofType ?\n\t\t\t\t\t\t\t\t\t\tnode.nodeName.toLowerCase() === name :\n\t\t\t\t\t\t\t\t\t\tnode.nodeType === 1 ) &&\n\t\t\t\t\t\t\t\t\t\t++diff ) {\n\n\t\t\t\t\t\t\t\t\t\t// Cache the index of each encountered element\n\t\t\t\t\t\t\t\t\t\tif ( useCache ) {\n\t\t\t\t\t\t\t\t\t\t\touterCache = node[ expando ] ||\n\t\t\t\t\t\t\t\t\t\t\t\t( node[ expando ] = {} );\n\n\t\t\t\t\t\t\t\t\t\t\t// Support: IE <9 only\n\t\t\t\t\t\t\t\t\t\t\t// Defend against cloned attroperties (jQuery gh-1709)\n\t\t\t\t\t\t\t\t\t\t\tuniqueCache = outerCache[ node.uniqueID ] ||\n\t\t\t\t\t\t\t\t\t\t\t\t( outerCache[ node.uniqueID ] = {} );\n\n\t\t\t\t\t\t\t\t\t\t\tuniqueCache[ type ] = [ dirruns, diff ];\n\t\t\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\t\t\tif ( node === elem ) {\n\t\t\t\t\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\t// Incorporate the offset, then check against cycle size\n\t\t\t\t\t\tdiff -= last;\n\t\t\t\t\t\treturn diff === first || ( diff % first === 0 && diff / first >= 0 );\n\t\t\t\t\t}\n\t\t\t\t};\n\t\t},\n\n\t\t\"PSEUDO\": function( pseudo, argument ) {\n\n\t\t\t// pseudo-class names are case-insensitive\n\t\t\t// http://www.w3.org/TR/selectors/#pseudo-classes\n\t\t\t// Prioritize by case sensitivity in case custom pseudos are added with uppercase letters\n\t\t\t// Remember that setFilters inherits from pseudos\n\t\t\tvar args,\n\t\t\t\tfn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] ||\n\t\t\t\t\tSizzle.error( \"unsupported pseudo: \" + pseudo );\n\n\t\t\t// The user may use createPseudo to indicate that\n\t\t\t// arguments are needed to create the filter function\n\t\t\t// just as Sizzle does\n\t\t\tif ( fn[ expando ] ) {\n\t\t\t\treturn fn( argument );\n\t\t\t}\n\n\t\t\t// But maintain support for old signatures\n\t\t\tif ( fn.length > 1 ) {\n\t\t\t\targs = [ pseudo, pseudo, \"\", argument ];\n\t\t\t\treturn Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ?\n\t\t\t\t\tmarkFunction( function( seed, matches ) {\n\t\t\t\t\t\tvar idx,\n\t\t\t\t\t\t\tmatched = fn( seed, argument ),\n\t\t\t\t\t\t\ti = matched.length;\n\t\t\t\t\t\twhile ( i-- ) {\n\t\t\t\t\t\t\tidx = indexOf( seed, matched[ i ] );\n\t\t\t\t\t\t\tseed[ idx ] = !( matches[ idx ] = matched[ i ] );\n\t\t\t\t\t\t}\n\t\t\t\t\t} ) :\n\t\t\t\t\tfunction( elem ) {\n\t\t\t\t\t\treturn fn( elem, 0, args );\n\t\t\t\t\t};\n\t\t\t}\n\n\t\t\treturn fn;\n\t\t}\n\t},\n\n\tpseudos: {\n\n\t\t// Potentially complex pseudos\n\t\t\"not\": markFunction( function( selector ) {\n\n\t\t\t// Trim the selector passed to compile\n\t\t\t// to avoid treating leading and trailing\n\t\t\t// spaces as combinators\n\t\t\tvar input = [],\n\t\t\t\tresults = [],\n\t\t\t\tmatcher = compile( selector.replace( rtrim, \"$1\" ) );\n\n\t\t\treturn matcher[ expando ] ?\n\t\t\t\tmarkFunction( function( seed, matches, _context, xml ) {\n\t\t\t\t\tvar elem,\n\t\t\t\t\t\tunmatched = matcher( seed, null, xml, [] ),\n\t\t\t\t\t\ti = seed.length;\n\n\t\t\t\t\t// Match elements unmatched by `matcher`\n\t\t\t\t\twhile ( i-- ) {\n\t\t\t\t\t\tif ( ( elem = unmatched[ i ] ) ) {\n\t\t\t\t\t\t\tseed[ i ] = !( matches[ i ] = elem );\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t} ) :\n\t\t\t\tfunction( elem, _context, xml ) {\n\t\t\t\t\tinput[ 0 ] = elem;\n\t\t\t\t\tmatcher( input, null, xml, results );\n\n\t\t\t\t\t// Don't keep the element (issue #299)\n\t\t\t\t\tinput[ 0 ] = null;\n\t\t\t\t\treturn !results.pop();\n\t\t\t\t};\n\t\t} ),\n\n\t\t\"has\": markFunction( function( selector ) {\n\t\t\treturn function( elem ) {\n\t\t\t\treturn Sizzle( selector, elem ).length > 0;\n\t\t\t};\n\t\t} ),\n\n\t\t\"contains\": markFunction( function( text ) {\n\t\t\ttext = text.replace( runescape, funescape );\n\t\t\treturn function( elem ) {\n\t\t\t\treturn ( elem.textContent || getText( elem ) ).indexOf( text ) > -1;\n\t\t\t};\n\t\t} ),\n\n\t\t// \"Whether an element is represented by a :lang() selector\n\t\t// is based solely on the element's language value\n\t\t// being equal to the identifier C,\n\t\t// or beginning with the identifier C immediately followed by \"-\".\n\t\t// The matching of C against the element's language value is performed case-insensitively.\n\t\t// The identifier C does not have to be a valid language name.\"\n\t\t// http://www.w3.org/TR/selectors/#lang-pseudo\n\t\t\"lang\": markFunction( function( lang ) {\n\n\t\t\t// lang value must be a valid identifier\n\t\t\tif ( !ridentifier.test( lang || \"\" ) ) {\n\t\t\t\tSizzle.error( \"unsupported lang: \" + lang );\n\t\t\t}\n\t\t\tlang = lang.replace( runescape, funescape ).toLowerCase();\n\t\t\treturn function( elem ) {\n\t\t\t\tvar elemLang;\n\t\t\t\tdo {\n\t\t\t\t\tif ( ( elemLang = documentIsHTML ?\n\t\t\t\t\t\telem.lang :\n\t\t\t\t\t\telem.getAttribute( \"xml:lang\" ) || elem.getAttribute( \"lang\" ) ) ) {\n\n\t\t\t\t\t\telemLang = elemLang.toLowerCase();\n\t\t\t\t\t\treturn elemLang === lang || elemLang.indexOf( lang + \"-\" ) === 0;\n\t\t\t\t\t}\n\t\t\t\t} while ( ( elem = elem.parentNode ) && elem.nodeType === 1 );\n\t\t\t\treturn false;\n\t\t\t};\n\t\t} ),\n\n\t\t// Miscellaneous\n\t\t\"target\": function( elem ) {\n\t\t\tvar hash = window.location && window.location.hash;\n\t\t\treturn hash && hash.slice( 1 ) === elem.id;\n\t\t},\n\n\t\t\"root\": function( elem ) {\n\t\t\treturn elem === docElem;\n\t\t},\n\n\t\t\"focus\": function( elem ) {\n\t\t\treturn elem === document.activeElement &&\n\t\t\t\t( !document.hasFocus || document.hasFocus() ) &&\n\t\t\t\t!!( elem.type || elem.href || ~elem.tabIndex );\n\t\t},\n\n\t\t// Boolean properties\n\t\t\"enabled\": createDisabledPseudo( false ),\n\t\t\"disabled\": createDisabledPseudo( true ),\n\n\t\t\"checked\": function( elem ) {\n\n\t\t\t// In CSS3, :checked should return both checked and selected elements\n\t\t\t// http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked\n\t\t\tvar nodeName = elem.nodeName.toLowerCase();\n\t\t\treturn ( nodeName === \"input\" && !!elem.checked ) ||\n\t\t\t\t( nodeName === \"option\" && !!elem.selected );\n\t\t},\n\n\t\t\"selected\": function( elem ) {\n\n\t\t\t// Accessing this property makes selected-by-default\n\t\t\t// options in Safari work properly\n\t\t\tif ( elem.parentNode ) {\n\t\t\t\t// eslint-disable-next-line no-unused-expressions\n\t\t\t\telem.parentNode.selectedIndex;\n\t\t\t}\n\n\t\t\treturn elem.selected === true;\n\t\t},\n\n\t\t// Contents\n\t\t\"empty\": function( elem ) {\n\n\t\t\t// http://www.w3.org/TR/selectors/#empty-pseudo\n\t\t\t// :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5),\n\t\t\t// but not by others (comment: 8; processing instruction: 7; etc.)\n\t\t\t// nodeType < 6 works because attributes (2) do not appear as children\n\t\t\tfor ( elem = elem.firstChild; elem; elem = elem.nextSibling ) {\n\t\t\t\tif ( elem.nodeType < 6 ) {\n\t\t\t\t\treturn false;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn true;\n\t\t},\n\n\t\t\"parent\": function( elem ) {\n\t\t\treturn !Expr.pseudos[ \"empty\" ]( elem );\n\t\t},\n\n\t\t// Element/input types\n\t\t\"header\": function( elem ) {\n\t\t\treturn rheader.test( elem.nodeName );\n\t\t},\n\n\t\t\"input\": function( elem ) {\n\t\t\treturn rinputs.test( elem.nodeName );\n\t\t},\n\n\t\t\"button\": function( elem ) {\n\t\t\tvar name = elem.nodeName.toLowerCase();\n\t\t\treturn name === \"input\" && elem.type === \"button\" || name === \"button\";\n\t\t},\n\n\t\t\"text\": function( elem ) {\n\t\t\tvar attr;\n\t\t\treturn elem.nodeName.toLowerCase() === \"input\" &&\n\t\t\t\telem.type === \"text\" &&\n\n\t\t\t\t// Support: IE<8\n\t\t\t\t// New HTML5 attribute values (e.g., \"search\") appear with elem.type === \"text\"\n\t\t\t\t( ( attr = elem.getAttribute( \"type\" ) ) == null ||\n\t\t\t\t\tattr.toLowerCase() === \"text\" );\n\t\t},\n\n\t\t// Position-in-collection\n\t\t\"first\": createPositionalPseudo( function() {\n\t\t\treturn [ 0 ];\n\t\t} ),\n\n\t\t\"last\": createPositionalPseudo( function( _matchIndexes, length ) {\n\t\t\treturn [ length - 1 ];\n\t\t} ),\n\n\t\t\"eq\": createPositionalPseudo( function( _matchIndexes, length, argument ) {\n\t\t\treturn [ argument < 0 ? argument + length : argument ];\n\t\t} ),\n\n\t\t\"even\": createPositionalPseudo( function( matchIndexes, length ) {\n\t\t\tvar i = 0;\n\t\t\tfor ( ; i < length; i += 2 ) {\n\t\t\t\tmatchIndexes.push( i );\n\t\t\t}\n\t\t\treturn matchIndexes;\n\t\t} ),\n\n\t\t\"odd\": createPositionalPseudo( function( matchIndexes, length ) {\n\t\t\tvar i = 1;\n\t\t\tfor ( ; i < length; i += 2 ) {\n\t\t\t\tmatchIndexes.push( i );\n\t\t\t}\n\t\t\treturn matchIndexes;\n\t\t} ),\n\n\t\t\"lt\": createPositionalPseudo( function( matchIndexes, length, argument ) {\n\t\t\tvar i = argument < 0 ?\n\t\t\t\targument + length :\n\t\t\t\targument > length ?\n\t\t\t\t\tlength :\n\t\t\t\t\targument;\n\t\t\tfor ( ; --i >= 0; ) {\n\t\t\t\tmatchIndexes.push( i );\n\t\t\t}\n\t\t\treturn matchIndexes;\n\t\t} ),\n\n\t\t\"gt\": createPositionalPseudo( function( matchIndexes, length, argument ) {\n\t\t\tvar i = argument < 0 ? argument + length : argument;\n\t\t\tfor ( ; ++i < length; ) {\n\t\t\t\tmatchIndexes.push( i );\n\t\t\t}\n\t\t\treturn matchIndexes;\n\t\t} )\n\t}\n};\n\nExpr.pseudos[ \"nth\" ] = Expr.pseudos[ \"eq\" ];\n\n// Add button/input type pseudos\nfor ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) {\n\tExpr.pseudos[ i ] = createInputPseudo( i );\n}\nfor ( i in { submit: true, reset: true } ) {\n\tExpr.pseudos[ i ] = createButtonPseudo( i );\n}\n\n// Easy API for creating new setFilters\nfunction setFilters() {}\nsetFilters.prototype = Expr.filters = Expr.pseudos;\nExpr.setFilters = new setFilters();\n\ntokenize = Sizzle.tokenize = function( selector, parseOnly ) {\n\tvar matched, match, tokens, type,\n\t\tsoFar, groups, preFilters,\n\t\tcached = tokenCache[ selector + \" \" ];\n\n\tif ( cached ) {\n\t\treturn parseOnly ? 0 : cached.slice( 0 );\n\t}\n\n\tsoFar = selector;\n\tgroups = [];\n\tpreFilters = Expr.preFilter;\n\n\twhile ( soFar ) {\n\n\t\t// Comma and first run\n\t\tif ( !matched || ( match = rcomma.exec( soFar ) ) ) {\n\t\t\tif ( match ) {\n\n\t\t\t\t// Don't consume trailing commas as valid\n\t\t\t\tsoFar = soFar.slice( match[ 0 ].length ) || soFar;\n\t\t\t}\n\t\t\tgroups.push( ( tokens = [] ) );\n\t\t}\n\n\t\tmatched = false;\n\n\t\t// Combinators\n\t\tif ( ( match = rcombinators.exec( soFar ) ) ) {\n\t\t\tmatched = match.shift();\n\t\t\ttokens.push( {\n\t\t\t\tvalue: matched,\n\n\t\t\t\t// Cast descendant combinators to space\n\t\t\t\ttype: match[ 0 ].replace( rtrim, \" \" )\n\t\t\t} );\n\t\t\tsoFar = soFar.slice( matched.length );\n\t\t}\n\n\t\t// Filters\n\t\tfor ( type in Expr.filter ) {\n\t\t\tif ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] ||\n\t\t\t\t( match = preFilters[ type ]( match ) ) ) ) {\n\t\t\t\tmatched = match.shift();\n\t\t\t\ttokens.push( {\n\t\t\t\t\tvalue: matched,\n\t\t\t\t\ttype: type,\n\t\t\t\t\tmatches: match\n\t\t\t\t} );\n\t\t\t\tsoFar = soFar.slice( matched.length );\n\t\t\t}\n\t\t}\n\n\t\tif ( !matched ) {\n\t\t\tbreak;\n\t\t}\n\t}\n\n\t// Return the length of the invalid excess\n\t// if we're just parsing\n\t// Otherwise, throw an error or return tokens\n\treturn parseOnly ?\n\t\tsoFar.length :\n\t\tsoFar ?\n\t\t\tSizzle.error( selector ) :\n\n\t\t\t// Cache the tokens\n\t\t\ttokenCache( selector, groups ).slice( 0 );\n};\n\nfunction toSelector( tokens ) {\n\tvar i = 0,\n\t\tlen = tokens.length,\n\t\tselector = \"\";\n\tfor ( ; i < len; i++ ) {\n\t\tselector += tokens[ i ].value;\n\t}\n\treturn selector;\n}\n\nfunction addCombinator( matcher, combinator, base ) {\n\tvar dir = combinator.dir,\n\t\tskip = combinator.next,\n\t\tkey = skip || dir,\n\t\tcheckNonElements = base && key === \"parentNode\",\n\t\tdoneName = done++;\n\n\treturn combinator.first ?\n\n\t\t// Check against closest ancestor/preceding element\n\t\tfunction( elem, context, xml ) {\n\t\t\twhile ( ( elem = elem[ dir ] ) ) {\n\t\t\t\tif ( elem.nodeType === 1 || checkNonElements ) {\n\t\t\t\t\treturn matcher( elem, context, xml );\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn false;\n\t\t} :\n\n\t\t// Check against all ancestor/preceding elements\n\t\tfunction( elem, context, xml ) {\n\t\t\tvar oldCache, uniqueCache, outerCache,\n\t\t\t\tnewCache = [ dirruns, doneName ];\n\n\t\t\t// We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching\n\t\t\tif ( xml ) {\n\t\t\t\twhile ( ( elem = elem[ dir ] ) ) {\n\t\t\t\t\tif ( elem.nodeType === 1 || checkNonElements ) {\n\t\t\t\t\t\tif ( matcher( elem, context, xml ) ) {\n\t\t\t\t\t\t\treturn true;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\twhile ( ( elem = elem[ dir ] ) ) {\n\t\t\t\t\tif ( elem.nodeType === 1 || checkNonElements ) {\n\t\t\t\t\t\touterCache = elem[ expando ] || ( elem[ expando ] = {} );\n\n\t\t\t\t\t\t// Support: IE <9 only\n\t\t\t\t\t\t// Defend against cloned attroperties (jQuery gh-1709)\n\t\t\t\t\t\tuniqueCache = outerCache[ elem.uniqueID ] ||\n\t\t\t\t\t\t\t( outerCache[ elem.uniqueID ] = {} );\n\n\t\t\t\t\t\tif ( skip && skip === elem.nodeName.toLowerCase() ) {\n\t\t\t\t\t\t\telem = elem[ dir ] || elem;\n\t\t\t\t\t\t} else if ( ( oldCache = uniqueCache[ key ] ) &&\n\t\t\t\t\t\t\toldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) {\n\n\t\t\t\t\t\t\t// Assign to newCache so results back-propagate to previous elements\n\t\t\t\t\t\t\treturn ( newCache[ 2 ] = oldCache[ 2 ] );\n\t\t\t\t\t\t} else {\n\n\t\t\t\t\t\t\t// Reuse newcache so results back-propagate to previous elements\n\t\t\t\t\t\t\tuniqueCache[ key ] = newCache;\n\n\t\t\t\t\t\t\t// A match means we're done; a fail means we have to keep checking\n\t\t\t\t\t\t\tif ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) {\n\t\t\t\t\t\t\t\treturn true;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn false;\n\t\t};\n}\n\nfunction elementMatcher( matchers ) {\n\treturn matchers.length > 1 ?\n\t\tfunction( elem, context, xml ) {\n\t\t\tvar i = matchers.length;\n\t\t\twhile ( i-- ) {\n\t\t\t\tif ( !matchers[ i ]( elem, context, xml ) ) {\n\t\t\t\t\treturn false;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn true;\n\t\t} :\n\t\tmatchers[ 0 ];\n}\n\nfunction multipleContexts( selector, contexts, results ) {\n\tvar i = 0,\n\t\tlen = contexts.length;\n\tfor ( ; i < len; i++ ) {\n\t\tSizzle( selector, contexts[ i ], results );\n\t}\n\treturn results;\n}\n\nfunction condense( unmatched, map, filter, context, xml ) {\n\tvar elem,\n\t\tnewUnmatched = [],\n\t\ti = 0,\n\t\tlen = unmatched.length,\n\t\tmapped = map != null;\n\n\tfor ( ; i < len; i++ ) {\n\t\tif ( ( elem = unmatched[ i ] ) ) {\n\t\t\tif ( !filter || filter( elem, context, xml ) ) {\n\t\t\t\tnewUnmatched.push( elem );\n\t\t\t\tif ( mapped ) {\n\t\t\t\t\tmap.push( i );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\treturn newUnmatched;\n}\n\nfunction setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) {\n\tif ( postFilter && !postFilter[ expando ] ) {\n\t\tpostFilter = setMatcher( postFilter );\n\t}\n\tif ( postFinder && !postFinder[ expando ] ) {\n\t\tpostFinder = setMatcher( postFinder, postSelector );\n\t}\n\treturn markFunction( function( seed, results, context, xml ) {\n\t\tvar temp, i, elem,\n\t\t\tpreMap = [],\n\t\t\tpostMap = [],\n\t\t\tpreexisting = results.length,\n\n\t\t\t// Get initial elements from seed or context\n\t\t\telems = seed || multipleContexts(\n\t\t\t\tselector || \"*\",\n\t\t\t\tcontext.nodeType ? [ context ] : context,\n\t\t\t\t[]\n\t\t\t),\n\n\t\t\t// Prefilter to get matcher input, preserving a map for seed-results synchronization\n\t\t\tmatcherIn = preFilter && ( seed || !selector ) ?\n\t\t\t\tcondense( elems, preMap, preFilter, context, xml ) :\n\t\t\t\telems,\n\n\t\t\tmatcherOut = matcher ?\n\n\t\t\t\t// If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results,\n\t\t\t\tpostFinder || ( seed ? preFilter : preexisting || postFilter ) ?\n\n\t\t\t\t\t// ...intermediate processing is necessary\n\t\t\t\t\t[] :\n\n\t\t\t\t\t// ...otherwise use results directly\n\t\t\t\t\tresults :\n\t\t\t\tmatcherIn;\n\n\t\t// Find primary matches\n\t\tif ( matcher ) {\n\t\t\tmatcher( matcherIn, matcherOut, context, xml );\n\t\t}\n\n\t\t// Apply postFilter\n\t\tif ( postFilter ) {\n\t\t\ttemp = condense( matcherOut, postMap );\n\t\t\tpostFilter( temp, [], context, xml );\n\n\t\t\t// Un-match failing elements by moving them back to matcherIn\n\t\t\ti = temp.length;\n\t\t\twhile ( i-- ) {\n\t\t\t\tif ( ( elem = temp[ i ] ) ) {\n\t\t\t\t\tmatcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif ( seed ) {\n\t\t\tif ( postFinder || preFilter ) {\n\t\t\t\tif ( postFinder ) {\n\n\t\t\t\t\t// Get the final matcherOut by condensing this intermediate into postFinder contexts\n\t\t\t\t\ttemp = [];\n\t\t\t\t\ti = matcherOut.length;\n\t\t\t\t\twhile ( i-- ) {\n\t\t\t\t\t\tif ( ( elem = matcherOut[ i ] ) ) {\n\n\t\t\t\t\t\t\t// Restore matcherIn since elem is not yet a final match\n\t\t\t\t\t\t\ttemp.push( ( matcherIn[ i ] = elem ) );\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tpostFinder( null, ( matcherOut = [] ), temp, xml );\n\t\t\t\t}\n\n\t\t\t\t// Move matched elements from seed to results to keep them synchronized\n\t\t\t\ti = matcherOut.length;\n\t\t\t\twhile ( i-- ) {\n\t\t\t\t\tif ( ( elem = matcherOut[ i ] ) &&\n\t\t\t\t\t\t( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) {\n\n\t\t\t\t\t\tseed[ temp ] = !( results[ temp ] = elem );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t// Add elements to results, through postFinder if defined\n\t\t} else {\n\t\t\tmatcherOut = condense(\n\t\t\t\tmatcherOut === results ?\n\t\t\t\t\tmatcherOut.splice( preexisting, matcherOut.length ) :\n\t\t\t\t\tmatcherOut\n\t\t\t);\n\t\t\tif ( postFinder ) {\n\t\t\t\tpostFinder( null, results, matcherOut, xml );\n\t\t\t} else {\n\t\t\t\tpush.apply( results, matcherOut );\n\t\t\t}\n\t\t}\n\t} );\n}\n\nfunction matcherFromTokens( tokens ) {\n\tvar checkContext, matcher, j,\n\t\tlen = tokens.length,\n\t\tleadingRelative = Expr.relative[ tokens[ 0 ].type ],\n\t\timplicitRelative = leadingRelative || Expr.relative[ \" \" ],\n\t\ti = leadingRelative ? 1 : 0,\n\n\t\t// The foundational matcher ensures that elements are reachable from top-level context(s)\n\t\tmatchContext = addCombinator( function( elem ) {\n\t\t\treturn elem === checkContext;\n\t\t}, implicitRelative, true ),\n\t\tmatchAnyContext = addCombinator( function( elem ) {\n\t\t\treturn indexOf( checkContext, elem ) > -1;\n\t\t}, implicitRelative, true ),\n\t\tmatchers = [ function( elem, context, xml ) {\n\t\t\tvar ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || (\n\t\t\t\t( checkContext = context ).nodeType ?\n\t\t\t\t\tmatchContext( elem, context, xml ) :\n\t\t\t\t\tmatchAnyContext( elem, context, xml ) );\n\n\t\t\t// Avoid hanging onto element (issue #299)\n\t\t\tcheckContext = null;\n\t\t\treturn ret;\n\t\t} ];\n\n\tfor ( ; i < len; i++ ) {\n\t\tif ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) {\n\t\t\tmatchers = [ addCombinator( elementMatcher( matchers ), matcher ) ];\n\t\t} else {\n\t\t\tmatcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches );\n\n\t\t\t// Return special upon seeing a positional matcher\n\t\t\tif ( matcher[ expando ] ) {\n\n\t\t\t\t// Find the next relative operator (if any) for proper handling\n\t\t\t\tj = ++i;\n\t\t\t\tfor ( ; j < len; j++ ) {\n\t\t\t\t\tif ( Expr.relative[ tokens[ j ].type ] ) {\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn setMatcher(\n\t\t\t\t\ti > 1 && elementMatcher( matchers ),\n\t\t\t\t\ti > 1 && toSelector(\n\n\t\t\t\t\t// If the preceding token was a descendant combinator, insert an implicit any-element `*`\n\t\t\t\t\ttokens\n\t\t\t\t\t\t.slice( 0, i - 1 )\n\t\t\t\t\t\t.concat( { value: tokens[ i - 2 ].type === \" \" ? \"*\" : \"\" } )\n\t\t\t\t\t).replace( rtrim, \"$1\" ),\n\t\t\t\t\tmatcher,\n\t\t\t\t\ti < j && matcherFromTokens( tokens.slice( i, j ) ),\n\t\t\t\t\tj < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ),\n\t\t\t\t\tj < len && toSelector( tokens )\n\t\t\t\t);\n\t\t\t}\n\t\t\tmatchers.push( matcher );\n\t\t}\n\t}\n\n\treturn elementMatcher( matchers );\n}\n\nfunction matcherFromGroupMatchers( elementMatchers, setMatchers ) {\n\tvar bySet = setMatchers.length > 0,\n\t\tbyElement = elementMatchers.length > 0,\n\t\tsuperMatcher = function( seed, context, xml, results, outermost ) {\n\t\t\tvar elem, j, matcher,\n\t\t\t\tmatchedCount = 0,\n\t\t\t\ti = \"0\",\n\t\t\t\tunmatched = seed && [],\n\t\t\t\tsetMatched = [],\n\t\t\t\tcontextBackup = outermostContext,\n\n\t\t\t\t// We must always have either seed elements or outermost context\n\t\t\t\telems = seed || byElement && Expr.find[ \"TAG\" ]( \"*\", outermost ),\n\n\t\t\t\t// Use integer dirruns iff this is the outermost matcher\n\t\t\t\tdirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ),\n\t\t\t\tlen = elems.length;\n\n\t\t\tif ( outermost ) {\n\n\t\t\t\t// Support: IE 11+, Edge 17 - 18+\n\t\t\t\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t\t\t\t// two documents; shallow comparisons work.\n\t\t\t\t// eslint-disable-next-line eqeqeq\n\t\t\t\toutermostContext = context == document || context || outermost;\n\t\t\t}\n\n\t\t\t// Add elements passing elementMatchers directly to results\n\t\t\t// Support: IE<9, Safari\n\t\t\t// Tolerate NodeList properties (IE: \"length\"; Safari: ) matching elements by id\n\t\t\tfor ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) {\n\t\t\t\tif ( byElement && elem ) {\n\t\t\t\t\tj = 0;\n\n\t\t\t\t\t// Support: IE 11+, Edge 17 - 18+\n\t\t\t\t\t// IE/Edge sometimes throw a \"Permission denied\" error when strict-comparing\n\t\t\t\t\t// two documents; shallow comparisons work.\n\t\t\t\t\t// eslint-disable-next-line eqeqeq\n\t\t\t\t\tif ( !context && elem.ownerDocument != document ) {\n\t\t\t\t\t\tsetDocument( elem );\n\t\t\t\t\t\txml = !documentIsHTML;\n\t\t\t\t\t}\n\t\t\t\t\twhile ( ( matcher = elementMatchers[ j++ ] ) ) {\n\t\t\t\t\t\tif ( matcher( elem, context || document, xml ) ) {\n\t\t\t\t\t\t\tresults.push( elem );\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tif ( outermost ) {\n\t\t\t\t\t\tdirruns = dirrunsUnique;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// Track unmatched elements for set filters\n\t\t\t\tif ( bySet ) {\n\n\t\t\t\t\t// They will have gone through all possible matchers\n\t\t\t\t\tif ( ( elem = !matcher && elem ) ) {\n\t\t\t\t\t\tmatchedCount--;\n\t\t\t\t\t}\n\n\t\t\t\t\t// Lengthen the array for every element, matched or not\n\t\t\t\t\tif ( seed ) {\n\t\t\t\t\t\tunmatched.push( elem );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// `i` is now the count of elements visited above, and adding it to `matchedCount`\n\t\t\t// makes the latter nonnegative.\n\t\t\tmatchedCount += i;\n\n\t\t\t// Apply set filters to unmatched elements\n\t\t\t// NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount`\n\t\t\t// equals `i`), unless we didn't visit _any_ elements in the above loop because we have\n\t\t\t// no element matchers and no seed.\n\t\t\t// Incrementing an initially-string \"0\" `i` allows `i` to remain a string only in that\n\t\t\t// case, which will result in a \"00\" `matchedCount` that differs from `i` but is also\n\t\t\t// numerically zero.\n\t\t\tif ( bySet && i !== matchedCount ) {\n\t\t\t\tj = 0;\n\t\t\t\twhile ( ( matcher = setMatchers[ j++ ] ) ) {\n\t\t\t\t\tmatcher( unmatched, setMatched, context, xml );\n\t\t\t\t}\n\n\t\t\t\tif ( seed ) {\n\n\t\t\t\t\t// Reintegrate element matches to eliminate the need for sorting\n\t\t\t\t\tif ( matchedCount > 0 ) {\n\t\t\t\t\t\twhile ( i-- ) {\n\t\t\t\t\t\t\tif ( !( unmatched[ i ] || setMatched[ i ] ) ) {\n\t\t\t\t\t\t\t\tsetMatched[ i ] = pop.call( results );\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\t// Discard index placeholder values to get only actual matches\n\t\t\t\t\tsetMatched = condense( setMatched );\n\t\t\t\t}\n\n\t\t\t\t// Add matches to results\n\t\t\t\tpush.apply( results, setMatched );\n\n\t\t\t\t// Seedless set matches succeeding multiple successful matchers stipulate sorting\n\t\t\t\tif ( outermost && !seed && setMatched.length > 0 &&\n\t\t\t\t\t( matchedCount + setMatchers.length ) > 1 ) {\n\n\t\t\t\t\tSizzle.uniqueSort( results );\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Override manipulation of globals by nested matchers\n\t\t\tif ( outermost ) {\n\t\t\t\tdirruns = dirrunsUnique;\n\t\t\t\toutermostContext = contextBackup;\n\t\t\t}\n\n\t\t\treturn unmatched;\n\t\t};\n\n\treturn bySet ?\n\t\tmarkFunction( superMatcher ) :\n\t\tsuperMatcher;\n}\n\ncompile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) {\n\tvar i,\n\t\tsetMatchers = [],\n\t\telementMatchers = [],\n\t\tcached = compilerCache[ selector + \" \" ];\n\n\tif ( !cached ) {\n\n\t\t// Generate a function of recursive functions that can be used to check each element\n\t\tif ( !match ) {\n\t\t\tmatch = tokenize( selector );\n\t\t}\n\t\ti = match.length;\n\t\twhile ( i-- ) {\n\t\t\tcached = matcherFromTokens( match[ i ] );\n\t\t\tif ( cached[ expando ] ) {\n\t\t\t\tsetMatchers.push( cached );\n\t\t\t} else {\n\t\t\t\telementMatchers.push( cached );\n\t\t\t}\n\t\t}\n\n\t\t// Cache the compiled function\n\t\tcached = compilerCache(\n\t\t\tselector,\n\t\t\tmatcherFromGroupMatchers( elementMatchers, setMatchers )\n\t\t);\n\n\t\t// Save selector and tokenization\n\t\tcached.selector = selector;\n\t}\n\treturn cached;\n};\n\n/**\n * A low-level selection function that works with Sizzle's compiled\n * selector functions\n * @param {String|Function} selector A selector or a pre-compiled\n * selector function built with Sizzle.compile\n * @param {Element} context\n * @param {Array} [results]\n * @param {Array} [seed] A set of elements to match against\n */\nselect = Sizzle.select = function( selector, context, results, seed ) {\n\tvar i, tokens, token, type, find,\n\t\tcompiled = typeof selector === \"function\" && selector,\n\t\tmatch = !seed && tokenize( ( selector = compiled.selector || selector ) );\n\n\tresults = results || [];\n\n\t// Try to minimize operations if there is only one selector in the list and no seed\n\t// (the latter of which guarantees us context)\n\tif ( match.length === 1 ) {\n\n\t\t// Reduce context if the leading compound selector is an ID\n\t\ttokens = match[ 0 ] = match[ 0 ].slice( 0 );\n\t\tif ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === \"ID\" &&\n\t\t\tcontext.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) {\n\n\t\t\tcontext = ( Expr.find[ \"ID\" ]( token.matches[ 0 ]\n\t\t\t\t.replace( runescape, funescape ), context ) || [] )[ 0 ];\n\t\t\tif ( !context ) {\n\t\t\t\treturn results;\n\n\t\t\t// Precompiled matchers will still verify ancestry, so step up a level\n\t\t\t} else if ( compiled ) {\n\t\t\t\tcontext = context.parentNode;\n\t\t\t}\n\n\t\t\tselector = selector.slice( tokens.shift().value.length );\n\t\t}\n\n\t\t// Fetch a seed set for right-to-left matching\n\t\ti = matchExpr[ \"needsContext\" ].test( selector ) ? 0 : tokens.length;\n\t\twhile ( i-- ) {\n\t\t\ttoken = tokens[ i ];\n\n\t\t\t// Abort if we hit a combinator\n\t\t\tif ( Expr.relative[ ( type = token.type ) ] ) {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif ( ( find = Expr.find[ type ] ) ) {\n\n\t\t\t\t// Search, expanding context for leading sibling combinators\n\t\t\t\tif ( ( seed = find(\n\t\t\t\t\ttoken.matches[ 0 ].replace( runescape, funescape ),\n\t\t\t\t\trsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) ||\n\t\t\t\t\t\tcontext\n\t\t\t\t) ) ) {\n\n\t\t\t\t\t// If seed is empty or no tokens remain, we can return early\n\t\t\t\t\ttokens.splice( i, 1 );\n\t\t\t\t\tselector = seed.length && toSelector( tokens );\n\t\t\t\t\tif ( !selector ) {\n\t\t\t\t\t\tpush.apply( results, seed );\n\t\t\t\t\t\treturn results;\n\t\t\t\t\t}\n\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t// Compile and execute a filtering function if one is not provided\n\t// Provide `match` to avoid retokenization if we modified the selector above\n\t( compiled || compile( selector, match ) )(\n\t\tseed,\n\t\tcontext,\n\t\t!documentIsHTML,\n\t\tresults,\n\t\t!context || rsibling.test( selector ) && testContext( context.parentNode ) || context\n\t);\n\treturn results;\n};\n\n// One-time assignments\n\n// Sort stability\nsupport.sortStable = expando.split( \"\" ).sort( sortOrder ).join( \"\" ) === expando;\n\n// Support: Chrome 14-35+\n// Always assume duplicates if they aren't passed to the comparison function\nsupport.detectDuplicates = !!hasDuplicate;\n\n// Initialize against the default document\nsetDocument();\n\n// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27)\n// Detached nodes confoundingly follow *each other*\nsupport.sortDetached = assert( function( el ) {\n\n\t// Should return 1, but returns 4 (following)\n\treturn el.compareDocumentPosition( document.createElement( \"fieldset\" ) ) & 1;\n} );\n\n// Support: IE<8\n// Prevent attribute/property \"interpolation\"\n// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx\nif ( !assert( function( el ) {\n\tel.innerHTML = \"\";\n\treturn el.firstChild.getAttribute( \"href\" ) === \"#\";\n} ) ) {\n\taddHandle( \"type|href|height|width\", function( elem, name, isXML ) {\n\t\tif ( !isXML ) {\n\t\t\treturn elem.getAttribute( name, name.toLowerCase() === \"type\" ? 1 : 2 );\n\t\t}\n\t} );\n}\n\n// Support: IE<9\n// Use defaultValue in place of getAttribute(\"value\")\nif ( !support.attributes || !assert( function( el ) {\n\tel.innerHTML = \"\";\n\tel.firstChild.setAttribute( \"value\", \"\" );\n\treturn el.firstChild.getAttribute( \"value\" ) === \"\";\n} ) ) {\n\taddHandle( \"value\", function( elem, _name, isXML ) {\n\t\tif ( !isXML && elem.nodeName.toLowerCase() === \"input\" ) {\n\t\t\treturn elem.defaultValue;\n\t\t}\n\t} );\n}\n\n// Support: IE<9\n// Use getAttributeNode to fetch booleans when getAttribute lies\nif ( !assert( function( el ) {\n\treturn el.getAttribute( \"disabled\" ) == null;\n} ) ) {\n\taddHandle( booleans, function( elem, name, isXML ) {\n\t\tvar val;\n\t\tif ( !isXML ) {\n\t\t\treturn elem[ name ] === true ? name.toLowerCase() :\n\t\t\t\t( val = elem.getAttributeNode( name ) ) && val.specified ?\n\t\t\t\t\tval.value :\n\t\t\t\t\tnull;\n\t\t}\n\t} );\n}\n\nreturn Sizzle;\n\n} )( window );\n\n\n\njQuery.find = Sizzle;\njQuery.expr = Sizzle.selectors;\n\n// Deprecated\njQuery.expr[ \":\" ] = jQuery.expr.pseudos;\njQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort;\njQuery.text = Sizzle.getText;\njQuery.isXMLDoc = Sizzle.isXML;\njQuery.contains = Sizzle.contains;\njQuery.escapeSelector = Sizzle.escape;\n\n\n\n\nvar dir = function( elem, dir, until ) {\n\tvar matched = [],\n\t\ttruncate = until !== undefined;\n\n\twhile ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) {\n\t\tif ( elem.nodeType === 1 ) {\n\t\t\tif ( truncate && jQuery( elem ).is( until ) ) {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tmatched.push( elem );\n\t\t}\n\t}\n\treturn matched;\n};\n\n\nvar siblings = function( n, elem ) {\n\tvar matched = [];\n\n\tfor ( ; n; n = n.nextSibling ) {\n\t\tif ( n.nodeType === 1 && n !== elem ) {\n\t\t\tmatched.push( n );\n\t\t}\n\t}\n\n\treturn matched;\n};\n\n\nvar rneedsContext = jQuery.expr.match.needsContext;\n\n\n\nfunction nodeName( elem, name ) {\n\n\treturn elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase();\n\n}\nvar rsingleTag = ( /^<([a-z][^\\/\\0>:\\x20\\t\\r\\n\\f]*)[\\x20\\t\\r\\n\\f]*\\/?>(?:<\\/\\1>|)$/i );\n\n\n\n// Implement the identical functionality for filter and not\nfunction winnow( elements, qualifier, not ) {\n\tif ( isFunction( qualifier ) ) {\n\t\treturn jQuery.grep( elements, function( elem, i ) {\n\t\t\treturn !!qualifier.call( elem, i, elem ) !== not;\n\t\t} );\n\t}\n\n\t// Single element\n\tif ( qualifier.nodeType ) {\n\t\treturn jQuery.grep( elements, function( elem ) {\n\t\t\treturn ( elem === qualifier ) !== not;\n\t\t} );\n\t}\n\n\t// Arraylike of elements (jQuery, arguments, Array)\n\tif ( typeof qualifier !== \"string\" ) {\n\t\treturn jQuery.grep( elements, function( elem ) {\n\t\t\treturn ( indexOf.call( qualifier, elem ) > -1 ) !== not;\n\t\t} );\n\t}\n\n\t// Filtered directly for both simple and complex selectors\n\treturn jQuery.filter( qualifier, elements, not );\n}\n\njQuery.filter = function( expr, elems, not ) {\n\tvar elem = elems[ 0 ];\n\n\tif ( not ) {\n\t\texpr = \":not(\" + expr + \")\";\n\t}\n\n\tif ( elems.length === 1 && elem.nodeType === 1 ) {\n\t\treturn jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : [];\n\t}\n\n\treturn jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) {\n\t\treturn elem.nodeType === 1;\n\t} ) );\n};\n\njQuery.fn.extend( {\n\tfind: function( selector ) {\n\t\tvar i, ret,\n\t\t\tlen = this.length,\n\t\t\tself = this;\n\n\t\tif ( typeof selector !== \"string\" ) {\n\t\t\treturn this.pushStack( jQuery( selector ).filter( function() {\n\t\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t\tif ( jQuery.contains( self[ i ], this ) ) {\n\t\t\t\t\t\treturn true;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t} ) );\n\t\t}\n\n\t\tret = this.pushStack( [] );\n\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tjQuery.find( selector, self[ i ], ret );\n\t\t}\n\n\t\treturn len > 1 ? jQuery.uniqueSort( ret ) : ret;\n\t},\n\tfilter: function( selector ) {\n\t\treturn this.pushStack( winnow( this, selector || [], false ) );\n\t},\n\tnot: function( selector ) {\n\t\treturn this.pushStack( winnow( this, selector || [], true ) );\n\t},\n\tis: function( selector ) {\n\t\treturn !!winnow(\n\t\t\tthis,\n\n\t\t\t// If this is a positional/relative selector, check membership in the returned set\n\t\t\t// so $(\"p:first\").is(\"p:last\") won't return true for a doc with two \"p\".\n\t\t\ttypeof selector === \"string\" && rneedsContext.test( selector ) ?\n\t\t\t\tjQuery( selector ) :\n\t\t\t\tselector || [],\n\t\t\tfalse\n\t\t).length;\n\t}\n} );\n\n\n// Initialize a jQuery object\n\n\n// A central reference to the root jQuery(document)\nvar rootjQuery,\n\n\t// A simple way to check for HTML strings\n\t// Prioritize #id over to avoid XSS via location.hash (#9521)\n\t// Strict HTML recognition (#11290: must start with <)\n\t// Shortcut simple #id case for speed\n\trquickExpr = /^(?:\\s*(<[\\w\\W]+>)[^>]*|#([\\w-]+))$/,\n\n\tinit = jQuery.fn.init = function( selector, context, root ) {\n\t\tvar match, elem;\n\n\t\t// HANDLE: $(\"\"), $(null), $(undefined), $(false)\n\t\tif ( !selector ) {\n\t\t\treturn this;\n\t\t}\n\n\t\t// Method init() accepts an alternate rootjQuery\n\t\t// so migrate can support jQuery.sub (gh-2101)\n\t\troot = root || rootjQuery;\n\n\t\t// Handle HTML strings\n\t\tif ( typeof selector === \"string\" ) {\n\t\t\tif ( selector[ 0 ] === \"<\" &&\n\t\t\t\tselector[ selector.length - 1 ] === \">\" &&\n\t\t\t\tselector.length >= 3 ) {\n\n\t\t\t\t// Assume that strings that start and end with <> are HTML and skip the regex check\n\t\t\t\tmatch = [ null, selector, null ];\n\n\t\t\t} else {\n\t\t\t\tmatch = rquickExpr.exec( selector );\n\t\t\t}\n\n\t\t\t// Match html or make sure no context is specified for #id\n\t\t\tif ( match && ( match[ 1 ] || !context ) ) {\n\n\t\t\t\t// HANDLE: $(html) -> $(array)\n\t\t\t\tif ( match[ 1 ] ) {\n\t\t\t\t\tcontext = context instanceof jQuery ? context[ 0 ] : context;\n\n\t\t\t\t\t// Option to run scripts is true for back-compat\n\t\t\t\t\t// Intentionally let the error be thrown if parseHTML is not present\n\t\t\t\t\tjQuery.merge( this, jQuery.parseHTML(\n\t\t\t\t\t\tmatch[ 1 ],\n\t\t\t\t\t\tcontext && context.nodeType ? context.ownerDocument || context : document,\n\t\t\t\t\t\ttrue\n\t\t\t\t\t) );\n\n\t\t\t\t\t// HANDLE: $(html, props)\n\t\t\t\t\tif ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) {\n\t\t\t\t\t\tfor ( match in context ) {\n\n\t\t\t\t\t\t\t// Properties of context are called as methods if possible\n\t\t\t\t\t\t\tif ( isFunction( this[ match ] ) ) {\n\t\t\t\t\t\t\t\tthis[ match ]( context[ match ] );\n\n\t\t\t\t\t\t\t// ...and otherwise set as attributes\n\t\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\t\tthis.attr( match, context[ match ] );\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\treturn this;\n\n\t\t\t\t// HANDLE: $(#id)\n\t\t\t\t} else {\n\t\t\t\t\telem = document.getElementById( match[ 2 ] );\n\n\t\t\t\t\tif ( elem ) {\n\n\t\t\t\t\t\t// Inject the element directly into the jQuery object\n\t\t\t\t\t\tthis[ 0 ] = elem;\n\t\t\t\t\t\tthis.length = 1;\n\t\t\t\t\t}\n\t\t\t\t\treturn this;\n\t\t\t\t}\n\n\t\t\t// HANDLE: $(expr, $(...))\n\t\t\t} else if ( !context || context.jquery ) {\n\t\t\t\treturn ( context || root ).find( selector );\n\n\t\t\t// HANDLE: $(expr, context)\n\t\t\t// (which is just equivalent to: $(context).find(expr)\n\t\t\t} else {\n\t\t\t\treturn this.constructor( context ).find( selector );\n\t\t\t}\n\n\t\t// HANDLE: $(DOMElement)\n\t\t} else if ( selector.nodeType ) {\n\t\t\tthis[ 0 ] = selector;\n\t\t\tthis.length = 1;\n\t\t\treturn this;\n\n\t\t// HANDLE: $(function)\n\t\t// Shortcut for document ready\n\t\t} else if ( isFunction( selector ) ) {\n\t\t\treturn root.ready !== undefined ?\n\t\t\t\troot.ready( selector ) :\n\n\t\t\t\t// Execute immediately if ready is not present\n\t\t\t\tselector( jQuery );\n\t\t}\n\n\t\treturn jQuery.makeArray( selector, this );\n\t};\n\n// Give the init function the jQuery prototype for later instantiation\ninit.prototype = jQuery.fn;\n\n// Initialize central reference\nrootjQuery = jQuery( document );\n\n\nvar rparentsprev = /^(?:parents|prev(?:Until|All))/,\n\n\t// Methods guaranteed to produce a unique set when starting from a unique set\n\tguaranteedUnique = {\n\t\tchildren: true,\n\t\tcontents: true,\n\t\tnext: true,\n\t\tprev: true\n\t};\n\njQuery.fn.extend( {\n\thas: function( target ) {\n\t\tvar targets = jQuery( target, this ),\n\t\t\tl = targets.length;\n\n\t\treturn this.filter( function() {\n\t\t\tvar i = 0;\n\t\t\tfor ( ; i < l; i++ ) {\n\t\t\t\tif ( jQuery.contains( this, targets[ i ] ) ) {\n\t\t\t\t\treturn true;\n\t\t\t\t}\n\t\t\t}\n\t\t} );\n\t},\n\n\tclosest: function( selectors, context ) {\n\t\tvar cur,\n\t\t\ti = 0,\n\t\t\tl = this.length,\n\t\t\tmatched = [],\n\t\t\ttargets = typeof selectors !== \"string\" && jQuery( selectors );\n\n\t\t// Positional selectors never match, since there's no _selection_ context\n\t\tif ( !rneedsContext.test( selectors ) ) {\n\t\t\tfor ( ; i < l; i++ ) {\n\t\t\t\tfor ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) {\n\n\t\t\t\t\t// Always skip document fragments\n\t\t\t\t\tif ( cur.nodeType < 11 && ( targets ?\n\t\t\t\t\t\ttargets.index( cur ) > -1 :\n\n\t\t\t\t\t\t// Don't pass non-elements to Sizzle\n\t\t\t\t\t\tcur.nodeType === 1 &&\n\t\t\t\t\t\t\tjQuery.find.matchesSelector( cur, selectors ) ) ) {\n\n\t\t\t\t\t\tmatched.push( cur );\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched );\n\t},\n\n\t// Determine the position of an element within the set\n\tindex: function( elem ) {\n\n\t\t// No argument, return index in parent\n\t\tif ( !elem ) {\n\t\t\treturn ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1;\n\t\t}\n\n\t\t// Index in selector\n\t\tif ( typeof elem === \"string\" ) {\n\t\t\treturn indexOf.call( jQuery( elem ), this[ 0 ] );\n\t\t}\n\n\t\t// Locate the position of the desired element\n\t\treturn indexOf.call( this,\n\n\t\t\t// If it receives a jQuery object, the first element is used\n\t\t\telem.jquery ? elem[ 0 ] : elem\n\t\t);\n\t},\n\n\tadd: function( selector, context ) {\n\t\treturn this.pushStack(\n\t\t\tjQuery.uniqueSort(\n\t\t\t\tjQuery.merge( this.get(), jQuery( selector, context ) )\n\t\t\t)\n\t\t);\n\t},\n\n\taddBack: function( selector ) {\n\t\treturn this.add( selector == null ?\n\t\t\tthis.prevObject : this.prevObject.filter( selector )\n\t\t);\n\t}\n} );\n\nfunction sibling( cur, dir ) {\n\twhile ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {}\n\treturn cur;\n}\n\njQuery.each( {\n\tparent: function( elem ) {\n\t\tvar parent = elem.parentNode;\n\t\treturn parent && parent.nodeType !== 11 ? parent : null;\n\t},\n\tparents: function( elem ) {\n\t\treturn dir( elem, \"parentNode\" );\n\t},\n\tparentsUntil: function( elem, _i, until ) {\n\t\treturn dir( elem, \"parentNode\", until );\n\t},\n\tnext: function( elem ) {\n\t\treturn sibling( elem, \"nextSibling\" );\n\t},\n\tprev: function( elem ) {\n\t\treturn sibling( elem, \"previousSibling\" );\n\t},\n\tnextAll: function( elem ) {\n\t\treturn dir( elem, \"nextSibling\" );\n\t},\n\tprevAll: function( elem ) {\n\t\treturn dir( elem, \"previousSibling\" );\n\t},\n\tnextUntil: function( elem, _i, until ) {\n\t\treturn dir( elem, \"nextSibling\", until );\n\t},\n\tprevUntil: function( elem, _i, until ) {\n\t\treturn dir( elem, \"previousSibling\", until );\n\t},\n\tsiblings: function( elem ) {\n\t\treturn siblings( ( elem.parentNode || {} ).firstChild, elem );\n\t},\n\tchildren: function( elem ) {\n\t\treturn siblings( elem.firstChild );\n\t},\n\tcontents: function( elem ) {\n\t\tif ( elem.contentDocument != null &&\n\n\t\t\t// Support: IE 11+\n\t\t\t// elements with no `data` attribute has an object\n\t\t\t// `contentDocument` with a `null` prototype.\n\t\t\tgetProto( elem.contentDocument ) ) {\n\n\t\t\treturn elem.contentDocument;\n\t\t}\n\n\t\t// Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only\n\t\t// Treat the template element as a regular one in browsers that\n\t\t// don't support it.\n\t\tif ( nodeName( elem, \"template\" ) ) {\n\t\t\telem = elem.content || elem;\n\t\t}\n\n\t\treturn jQuery.merge( [], elem.childNodes );\n\t}\n}, function( name, fn ) {\n\tjQuery.fn[ name ] = function( until, selector ) {\n\t\tvar matched = jQuery.map( this, fn, until );\n\n\t\tif ( name.slice( -5 ) !== \"Until\" ) {\n\t\t\tselector = until;\n\t\t}\n\n\t\tif ( selector && typeof selector === \"string\" ) {\n\t\t\tmatched = jQuery.filter( selector, matched );\n\t\t}\n\n\t\tif ( this.length > 1 ) {\n\n\t\t\t// Remove duplicates\n\t\t\tif ( !guaranteedUnique[ name ] ) {\n\t\t\t\tjQuery.uniqueSort( matched );\n\t\t\t}\n\n\t\t\t// Reverse order for parents* and prev-derivatives\n\t\t\tif ( rparentsprev.test( name ) ) {\n\t\t\t\tmatched.reverse();\n\t\t\t}\n\t\t}\n\n\t\treturn this.pushStack( matched );\n\t};\n} );\nvar rnothtmlwhite = ( /[^\\x20\\t\\r\\n\\f]+/g );\n\n\n\n// Convert String-formatted options into Object-formatted ones\nfunction createOptions( options ) {\n\tvar object = {};\n\tjQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) {\n\t\tobject[ flag ] = true;\n\t} );\n\treturn object;\n}\n\n/*\n * Create a callback list using the following parameters:\n *\n *\toptions: an optional list of space-separated options that will change how\n *\t\t\tthe callback list behaves or a more traditional option object\n *\n * By default a callback list will act like an event callback list and can be\n * \"fired\" multiple times.\n *\n * Possible options:\n *\n *\tonce:\t\t\twill ensure the callback list can only be fired once (like a Deferred)\n *\n *\tmemory:\t\t\twill keep track of previous values and will call any callback added\n *\t\t\t\t\tafter the list has been fired right away with the latest \"memorized\"\n *\t\t\t\t\tvalues (like a Deferred)\n *\n *\tunique:\t\t\twill ensure a callback can only be added once (no duplicate in the list)\n *\n *\tstopOnFalse:\tinterrupt callings when a callback returns false\n *\n */\njQuery.Callbacks = function( options ) {\n\n\t// Convert options from String-formatted to Object-formatted if needed\n\t// (we check in cache first)\n\toptions = typeof options === \"string\" ?\n\t\tcreateOptions( options ) :\n\t\tjQuery.extend( {}, options );\n\n\tvar // Flag to know if list is currently firing\n\t\tfiring,\n\n\t\t// Last fire value for non-forgettable lists\n\t\tmemory,\n\n\t\t// Flag to know if list was already fired\n\t\tfired,\n\n\t\t// Flag to prevent firing\n\t\tlocked,\n\n\t\t// Actual callback list\n\t\tlist = [],\n\n\t\t// Queue of execution data for repeatable lists\n\t\tqueue = [],\n\n\t\t// Index of currently firing callback (modified by add/remove as needed)\n\t\tfiringIndex = -1,\n\n\t\t// Fire callbacks\n\t\tfire = function() {\n\n\t\t\t// Enforce single-firing\n\t\t\tlocked = locked || options.once;\n\n\t\t\t// Execute callbacks for all pending executions,\n\t\t\t// respecting firingIndex overrides and runtime changes\n\t\t\tfired = firing = true;\n\t\t\tfor ( ; queue.length; firingIndex = -1 ) {\n\t\t\t\tmemory = queue.shift();\n\t\t\t\twhile ( ++firingIndex < list.length ) {\n\n\t\t\t\t\t// Run callback and check for early termination\n\t\t\t\t\tif ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false &&\n\t\t\t\t\t\toptions.stopOnFalse ) {\n\n\t\t\t\t\t\t// Jump to end and forget the data so .add doesn't re-fire\n\t\t\t\t\t\tfiringIndex = list.length;\n\t\t\t\t\t\tmemory = false;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Forget the data if we're done with it\n\t\t\tif ( !options.memory ) {\n\t\t\t\tmemory = false;\n\t\t\t}\n\n\t\t\tfiring = false;\n\n\t\t\t// Clean up if we're done firing for good\n\t\t\tif ( locked ) {\n\n\t\t\t\t// Keep an empty list if we have data for future add calls\n\t\t\t\tif ( memory ) {\n\t\t\t\t\tlist = [];\n\n\t\t\t\t// Otherwise, this object is spent\n\t\t\t\t} else {\n\t\t\t\t\tlist = \"\";\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\n\t\t// Actual Callbacks object\n\t\tself = {\n\n\t\t\t// Add a callback or a collection of callbacks to the list\n\t\t\tadd: function() {\n\t\t\t\tif ( list ) {\n\n\t\t\t\t\t// If we have memory from a past run, we should fire after adding\n\t\t\t\t\tif ( memory && !firing ) {\n\t\t\t\t\t\tfiringIndex = list.length - 1;\n\t\t\t\t\t\tqueue.push( memory );\n\t\t\t\t\t}\n\n\t\t\t\t\t( function add( args ) {\n\t\t\t\t\t\tjQuery.each( args, function( _, arg ) {\n\t\t\t\t\t\t\tif ( isFunction( arg ) ) {\n\t\t\t\t\t\t\t\tif ( !options.unique || !self.has( arg ) ) {\n\t\t\t\t\t\t\t\t\tlist.push( arg );\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t} else if ( arg && arg.length && toType( arg ) !== \"string\" ) {\n\n\t\t\t\t\t\t\t\t// Inspect recursively\n\t\t\t\t\t\t\t\tadd( arg );\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t} );\n\t\t\t\t\t} )( arguments );\n\n\t\t\t\t\tif ( memory && !firing ) {\n\t\t\t\t\t\tfire();\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn this;\n\t\t\t},\n\n\t\t\t// Remove a callback from the list\n\t\t\tremove: function() {\n\t\t\t\tjQuery.each( arguments, function( _, arg ) {\n\t\t\t\t\tvar index;\n\t\t\t\t\twhile ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) {\n\t\t\t\t\t\tlist.splice( index, 1 );\n\n\t\t\t\t\t\t// Handle firing indexes\n\t\t\t\t\t\tif ( index <= firingIndex ) {\n\t\t\t\t\t\t\tfiringIndex--;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t} );\n\t\t\t\treturn this;\n\t\t\t},\n\n\t\t\t// Check if a given callback is in the list.\n\t\t\t// If no argument is given, return whether or not list has callbacks attached.\n\t\t\thas: function( fn ) {\n\t\t\t\treturn fn ?\n\t\t\t\t\tjQuery.inArray( fn, list ) > -1 :\n\t\t\t\t\tlist.length > 0;\n\t\t\t},\n\n\t\t\t// Remove all callbacks from the list\n\t\t\tempty: function() {\n\t\t\t\tif ( list ) {\n\t\t\t\t\tlist = [];\n\t\t\t\t}\n\t\t\t\treturn this;\n\t\t\t},\n\n\t\t\t// Disable .fire and .add\n\t\t\t// Abort any current/pending executions\n\t\t\t// Clear all callbacks and values\n\t\t\tdisable: function() {\n\t\t\t\tlocked = queue = [];\n\t\t\t\tlist = memory = \"\";\n\t\t\t\treturn this;\n\t\t\t},\n\t\t\tdisabled: function() {\n\t\t\t\treturn !list;\n\t\t\t},\n\n\t\t\t// Disable .fire\n\t\t\t// Also disable .add unless we have memory (since it would have no effect)\n\t\t\t// Abort any pending executions\n\t\t\tlock: function() {\n\t\t\t\tlocked = queue = [];\n\t\t\t\tif ( !memory && !firing ) {\n\t\t\t\t\tlist = memory = \"\";\n\t\t\t\t}\n\t\t\t\treturn this;\n\t\t\t},\n\t\t\tlocked: function() {\n\t\t\t\treturn !!locked;\n\t\t\t},\n\n\t\t\t// Call all callbacks with the given context and arguments\n\t\t\tfireWith: function( context, args ) {\n\t\t\t\tif ( !locked ) {\n\t\t\t\t\targs = args || [];\n\t\t\t\t\targs = [ context, args.slice ? args.slice() : args ];\n\t\t\t\t\tqueue.push( args );\n\t\t\t\t\tif ( !firing ) {\n\t\t\t\t\t\tfire();\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn this;\n\t\t\t},\n\n\t\t\t// Call all the callbacks with the given arguments\n\t\t\tfire: function() {\n\t\t\t\tself.fireWith( this, arguments );\n\t\t\t\treturn this;\n\t\t\t},\n\n\t\t\t// To know if the callbacks have already been called at least once\n\t\t\tfired: function() {\n\t\t\t\treturn !!fired;\n\t\t\t}\n\t\t};\n\n\treturn self;\n};\n\n\nfunction Identity( v ) {\n\treturn v;\n}\nfunction Thrower( ex ) {\n\tthrow ex;\n}\n\nfunction adoptValue( value, resolve, reject, noValue ) {\n\tvar method;\n\n\ttry {\n\n\t\t// Check for promise aspect first to privilege synchronous behavior\n\t\tif ( value && isFunction( ( method = value.promise ) ) ) {\n\t\t\tmethod.call( value ).done( resolve ).fail( reject );\n\n\t\t// Other thenables\n\t\t} else if ( value && isFunction( ( method = value.then ) ) ) {\n\t\t\tmethod.call( value, resolve, reject );\n\n\t\t// Other non-thenables\n\t\t} else {\n\n\t\t\t// Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer:\n\t\t\t// * false: [ value ].slice( 0 ) => resolve( value )\n\t\t\t// * true: [ value ].slice( 1 ) => resolve()\n\t\t\tresolve.apply( undefined, [ value ].slice( noValue ) );\n\t\t}\n\n\t// For Promises/A+, convert exceptions into rejections\n\t// Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in\n\t// Deferred#then to conditionally suppress rejection.\n\t} catch ( value ) {\n\n\t\t// Support: Android 4.0 only\n\t\t// Strict mode functions invoked without .call/.apply get global-object context\n\t\treject.apply( undefined, [ value ] );\n\t}\n}\n\njQuery.extend( {\n\n\tDeferred: function( func ) {\n\t\tvar tuples = [\n\n\t\t\t\t// action, add listener, callbacks,\n\t\t\t\t// ... .then handlers, argument index, [final state]\n\t\t\t\t[ \"notify\", \"progress\", jQuery.Callbacks( \"memory\" ),\n\t\t\t\t\tjQuery.Callbacks( \"memory\" ), 2 ],\n\t\t\t\t[ \"resolve\", \"done\", jQuery.Callbacks( \"once memory\" ),\n\t\t\t\t\tjQuery.Callbacks( \"once memory\" ), 0, \"resolved\" ],\n\t\t\t\t[ \"reject\", \"fail\", jQuery.Callbacks( \"once memory\" ),\n\t\t\t\t\tjQuery.Callbacks( \"once memory\" ), 1, \"rejected\" ]\n\t\t\t],\n\t\t\tstate = \"pending\",\n\t\t\tpromise = {\n\t\t\t\tstate: function() {\n\t\t\t\t\treturn state;\n\t\t\t\t},\n\t\t\t\talways: function() {\n\t\t\t\t\tdeferred.done( arguments ).fail( arguments );\n\t\t\t\t\treturn this;\n\t\t\t\t},\n\t\t\t\t\"catch\": function( fn ) {\n\t\t\t\t\treturn promise.then( null, fn );\n\t\t\t\t},\n\n\t\t\t\t// Keep pipe for back-compat\n\t\t\t\tpipe: function( /* fnDone, fnFail, fnProgress */ ) {\n\t\t\t\t\tvar fns = arguments;\n\n\t\t\t\t\treturn jQuery.Deferred( function( newDefer ) {\n\t\t\t\t\t\tjQuery.each( tuples, function( _i, tuple ) {\n\n\t\t\t\t\t\t\t// Map tuples (progress, done, fail) to arguments (done, fail, progress)\n\t\t\t\t\t\t\tvar fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ];\n\n\t\t\t\t\t\t\t// deferred.progress(function() { bind to newDefer or newDefer.notify })\n\t\t\t\t\t\t\t// deferred.done(function() { bind to newDefer or newDefer.resolve })\n\t\t\t\t\t\t\t// deferred.fail(function() { bind to newDefer or newDefer.reject })\n\t\t\t\t\t\t\tdeferred[ tuple[ 1 ] ]( function() {\n\t\t\t\t\t\t\t\tvar returned = fn && fn.apply( this, arguments );\n\t\t\t\t\t\t\t\tif ( returned && isFunction( returned.promise ) ) {\n\t\t\t\t\t\t\t\t\treturned.promise()\n\t\t\t\t\t\t\t\t\t\t.progress( newDefer.notify )\n\t\t\t\t\t\t\t\t\t\t.done( newDefer.resolve )\n\t\t\t\t\t\t\t\t\t\t.fail( newDefer.reject );\n\t\t\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\t\t\tnewDefer[ tuple[ 0 ] + \"With\" ](\n\t\t\t\t\t\t\t\t\t\tthis,\n\t\t\t\t\t\t\t\t\t\tfn ? [ returned ] : arguments\n\t\t\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t} );\n\t\t\t\t\t\t} );\n\t\t\t\t\t\tfns = null;\n\t\t\t\t\t} ).promise();\n\t\t\t\t},\n\t\t\t\tthen: function( onFulfilled, onRejected, onProgress ) {\n\t\t\t\t\tvar maxDepth = 0;\n\t\t\t\t\tfunction resolve( depth, deferred, handler, special ) {\n\t\t\t\t\t\treturn function() {\n\t\t\t\t\t\t\tvar that = this,\n\t\t\t\t\t\t\t\targs = arguments,\n\t\t\t\t\t\t\t\tmightThrow = function() {\n\t\t\t\t\t\t\t\t\tvar returned, then;\n\n\t\t\t\t\t\t\t\t\t// Support: Promises/A+ section 2.3.3.3.3\n\t\t\t\t\t\t\t\t\t// https://promisesaplus.com/#point-59\n\t\t\t\t\t\t\t\t\t// Ignore double-resolution attempts\n\t\t\t\t\t\t\t\t\tif ( depth < maxDepth ) {\n\t\t\t\t\t\t\t\t\t\treturn;\n\t\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\t\treturned = handler.apply( that, args );\n\n\t\t\t\t\t\t\t\t\t// Support: Promises/A+ section 2.3.1\n\t\t\t\t\t\t\t\t\t// https://promisesaplus.com/#point-48\n\t\t\t\t\t\t\t\t\tif ( returned === deferred.promise() ) {\n\t\t\t\t\t\t\t\t\t\tthrow new TypeError( \"Thenable self-resolution\" );\n\t\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\t\t// Support: Promises/A+ sections 2.3.3.1, 3.5\n\t\t\t\t\t\t\t\t\t// https://promisesaplus.com/#point-54\n\t\t\t\t\t\t\t\t\t// https://promisesaplus.com/#point-75\n\t\t\t\t\t\t\t\t\t// Retrieve `then` only once\n\t\t\t\t\t\t\t\t\tthen = returned &&\n\n\t\t\t\t\t\t\t\t\t\t// Support: Promises/A+ section 2.3.4\n\t\t\t\t\t\t\t\t\t\t// https://promisesaplus.com/#point-64\n\t\t\t\t\t\t\t\t\t\t// Only check objects and functions for thenability\n\t\t\t\t\t\t\t\t\t\t( typeof returned === \"object\" ||\n\t\t\t\t\t\t\t\t\t\t\ttypeof returned === \"function\" ) &&\n\t\t\t\t\t\t\t\t\t\treturned.then;\n\n\t\t\t\t\t\t\t\t\t// Handle a returned thenable\n\t\t\t\t\t\t\t\t\tif ( isFunction( then ) ) {\n\n\t\t\t\t\t\t\t\t\t\t// Special processors (notify) just wait for resolution\n\t\t\t\t\t\t\t\t\t\tif ( special ) {\n\t\t\t\t\t\t\t\t\t\t\tthen.call(\n\t\t\t\t\t\t\t\t\t\t\t\treturned,\n\t\t\t\t\t\t\t\t\t\t\t\tresolve( maxDepth, deferred, Identity, special ),\n\t\t\t\t\t\t\t\t\t\t\t\tresolve( maxDepth, deferred, Thrower, special )\n\t\t\t\t\t\t\t\t\t\t\t);\n\n\t\t\t\t\t\t\t\t\t\t// Normal processors (resolve) also hook into progress\n\t\t\t\t\t\t\t\t\t\t} else {\n\n\t\t\t\t\t\t\t\t\t\t\t// ...and disregard older resolution values\n\t\t\t\t\t\t\t\t\t\t\tmaxDepth++;\n\n\t\t\t\t\t\t\t\t\t\t\tthen.call(\n\t\t\t\t\t\t\t\t\t\t\t\treturned,\n\t\t\t\t\t\t\t\t\t\t\t\tresolve( maxDepth, deferred, Identity, special ),\n\t\t\t\t\t\t\t\t\t\t\t\tresolve( maxDepth, deferred, Thrower, special ),\n\t\t\t\t\t\t\t\t\t\t\t\tresolve( maxDepth, deferred, Identity,\n\t\t\t\t\t\t\t\t\t\t\t\t\tdeferred.notifyWith )\n\t\t\t\t\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\t\t// Handle all other returned values\n\t\t\t\t\t\t\t\t\t} else {\n\n\t\t\t\t\t\t\t\t\t\t// Only substitute handlers pass on context\n\t\t\t\t\t\t\t\t\t\t// and multiple values (non-spec behavior)\n\t\t\t\t\t\t\t\t\t\tif ( handler !== Identity ) {\n\t\t\t\t\t\t\t\t\t\t\tthat = undefined;\n\t\t\t\t\t\t\t\t\t\t\targs = [ returned ];\n\t\t\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\t\t\t// Process the value(s)\n\t\t\t\t\t\t\t\t\t\t// Default process is resolve\n\t\t\t\t\t\t\t\t\t\t( special || deferred.resolveWith )( that, args );\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\n\t\t\t\t\t\t\t\t// Only normal processors (resolve) catch and reject exceptions\n\t\t\t\t\t\t\t\tprocess = special ?\n\t\t\t\t\t\t\t\t\tmightThrow :\n\t\t\t\t\t\t\t\t\tfunction() {\n\t\t\t\t\t\t\t\t\t\ttry {\n\t\t\t\t\t\t\t\t\t\t\tmightThrow();\n\t\t\t\t\t\t\t\t\t\t} catch ( e ) {\n\n\t\t\t\t\t\t\t\t\t\t\tif ( jQuery.Deferred.exceptionHook ) {\n\t\t\t\t\t\t\t\t\t\t\t\tjQuery.Deferred.exceptionHook( e,\n\t\t\t\t\t\t\t\t\t\t\t\t\tprocess.stackTrace );\n\t\t\t\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\t\t\t\t// Support: Promises/A+ section 2.3.3.3.4.1\n\t\t\t\t\t\t\t\t\t\t\t// https://promisesaplus.com/#point-61\n\t\t\t\t\t\t\t\t\t\t\t// Ignore post-resolution exceptions\n\t\t\t\t\t\t\t\t\t\t\tif ( depth + 1 >= maxDepth ) {\n\n\t\t\t\t\t\t\t\t\t\t\t\t// Only substitute handlers pass on context\n\t\t\t\t\t\t\t\t\t\t\t\t// and multiple values (non-spec behavior)\n\t\t\t\t\t\t\t\t\t\t\t\tif ( handler !== Thrower ) {\n\t\t\t\t\t\t\t\t\t\t\t\t\tthat = undefined;\n\t\t\t\t\t\t\t\t\t\t\t\t\targs = [ e ];\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\t\t\t\t\tdeferred.rejectWith( that, args );\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t};\n\n\t\t\t\t\t\t\t// Support: Promises/A+ section 2.3.3.3.1\n\t\t\t\t\t\t\t// https://promisesaplus.com/#point-57\n\t\t\t\t\t\t\t// Re-resolve promises immediately to dodge false rejection from\n\t\t\t\t\t\t\t// subsequent errors\n\t\t\t\t\t\t\tif ( depth ) {\n\t\t\t\t\t\t\t\tprocess();\n\t\t\t\t\t\t\t} else {\n\n\t\t\t\t\t\t\t\t// Call an optional hook to record the stack, in case of exception\n\t\t\t\t\t\t\t\t// since it's otherwise lost when execution goes async\n\t\t\t\t\t\t\t\tif ( jQuery.Deferred.getStackHook ) {\n\t\t\t\t\t\t\t\t\tprocess.stackTrace = jQuery.Deferred.getStackHook();\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\twindow.setTimeout( process );\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t};\n\t\t\t\t\t}\n\n\t\t\t\t\treturn jQuery.Deferred( function( newDefer ) {\n\n\t\t\t\t\t\t// progress_handlers.add( ... )\n\t\t\t\t\t\ttuples[ 0 ][ 3 ].add(\n\t\t\t\t\t\t\tresolve(\n\t\t\t\t\t\t\t\t0,\n\t\t\t\t\t\t\t\tnewDefer,\n\t\t\t\t\t\t\t\tisFunction( onProgress ) ?\n\t\t\t\t\t\t\t\t\tonProgress :\n\t\t\t\t\t\t\t\t\tIdentity,\n\t\t\t\t\t\t\t\tnewDefer.notifyWith\n\t\t\t\t\t\t\t)\n\t\t\t\t\t\t);\n\n\t\t\t\t\t\t// fulfilled_handlers.add( ... )\n\t\t\t\t\t\ttuples[ 1 ][ 3 ].add(\n\t\t\t\t\t\t\tresolve(\n\t\t\t\t\t\t\t\t0,\n\t\t\t\t\t\t\t\tnewDefer,\n\t\t\t\t\t\t\t\tisFunction( onFulfilled ) ?\n\t\t\t\t\t\t\t\t\tonFulfilled :\n\t\t\t\t\t\t\t\t\tIdentity\n\t\t\t\t\t\t\t)\n\t\t\t\t\t\t);\n\n\t\t\t\t\t\t// rejected_handlers.add( ... )\n\t\t\t\t\t\ttuples[ 2 ][ 3 ].add(\n\t\t\t\t\t\t\tresolve(\n\t\t\t\t\t\t\t\t0,\n\t\t\t\t\t\t\t\tnewDefer,\n\t\t\t\t\t\t\t\tisFunction( onRejected ) ?\n\t\t\t\t\t\t\t\t\tonRejected :\n\t\t\t\t\t\t\t\t\tThrower\n\t\t\t\t\t\t\t)\n\t\t\t\t\t\t);\n\t\t\t\t\t} ).promise();\n\t\t\t\t},\n\n\t\t\t\t// Get a promise for this deferred\n\t\t\t\t// If obj is provided, the promise aspect is added to the object\n\t\t\t\tpromise: function( obj ) {\n\t\t\t\t\treturn obj != null ? jQuery.extend( obj, promise ) : promise;\n\t\t\t\t}\n\t\t\t},\n\t\t\tdeferred = {};\n\n\t\t// Add list-specific methods\n\t\tjQuery.each( tuples, function( i, tuple ) {\n\t\t\tvar list = tuple[ 2 ],\n\t\t\t\tstateString = tuple[ 5 ];\n\n\t\t\t// promise.progress = list.add\n\t\t\t// promise.done = list.add\n\t\t\t// promise.fail = list.add\n\t\t\tpromise[ tuple[ 1 ] ] = list.add;\n\n\t\t\t// Handle state\n\t\t\tif ( stateString ) {\n\t\t\t\tlist.add(\n\t\t\t\t\tfunction() {\n\n\t\t\t\t\t\t// state = \"resolved\" (i.e., fulfilled)\n\t\t\t\t\t\t// state = \"rejected\"\n\t\t\t\t\t\tstate = stateString;\n\t\t\t\t\t},\n\n\t\t\t\t\t// rejected_callbacks.disable\n\t\t\t\t\t// fulfilled_callbacks.disable\n\t\t\t\t\ttuples[ 3 - i ][ 2 ].disable,\n\n\t\t\t\t\t// rejected_handlers.disable\n\t\t\t\t\t// fulfilled_handlers.disable\n\t\t\t\t\ttuples[ 3 - i ][ 3 ].disable,\n\n\t\t\t\t\t// progress_callbacks.lock\n\t\t\t\t\ttuples[ 0 ][ 2 ].lock,\n\n\t\t\t\t\t// progress_handlers.lock\n\t\t\t\t\ttuples[ 0 ][ 3 ].lock\n\t\t\t\t);\n\t\t\t}\n\n\t\t\t// progress_handlers.fire\n\t\t\t// fulfilled_handlers.fire\n\t\t\t// rejected_handlers.fire\n\t\t\tlist.add( tuple[ 3 ].fire );\n\n\t\t\t// deferred.notify = function() { deferred.notifyWith(...) }\n\t\t\t// deferred.resolve = function() { deferred.resolveWith(...) }\n\t\t\t// deferred.reject = function() { deferred.rejectWith(...) }\n\t\t\tdeferred[ tuple[ 0 ] ] = function() {\n\t\t\t\tdeferred[ tuple[ 0 ] + \"With\" ]( this === deferred ? undefined : this, arguments );\n\t\t\t\treturn this;\n\t\t\t};\n\n\t\t\t// deferred.notifyWith = list.fireWith\n\t\t\t// deferred.resolveWith = list.fireWith\n\t\t\t// deferred.rejectWith = list.fireWith\n\t\t\tdeferred[ tuple[ 0 ] + \"With\" ] = list.fireWith;\n\t\t} );\n\n\t\t// Make the deferred a promise\n\t\tpromise.promise( deferred );\n\n\t\t// Call given func if any\n\t\tif ( func ) {\n\t\t\tfunc.call( deferred, deferred );\n\t\t}\n\n\t\t// All done!\n\t\treturn deferred;\n\t},\n\n\t// Deferred helper\n\twhen: function( singleValue ) {\n\t\tvar\n\n\t\t\t// count of uncompleted subordinates\n\t\t\tremaining = arguments.length,\n\n\t\t\t// count of unprocessed arguments\n\t\t\ti = remaining,\n\n\t\t\t// subordinate fulfillment data\n\t\t\tresolveContexts = Array( i ),\n\t\t\tresolveValues = slice.call( arguments ),\n\n\t\t\t// the primary Deferred\n\t\t\tprimary = jQuery.Deferred(),\n\n\t\t\t// subordinate callback factory\n\t\t\tupdateFunc = function( i ) {\n\t\t\t\treturn function( value ) {\n\t\t\t\t\tresolveContexts[ i ] = this;\n\t\t\t\t\tresolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value;\n\t\t\t\t\tif ( !( --remaining ) ) {\n\t\t\t\t\t\tprimary.resolveWith( resolveContexts, resolveValues );\n\t\t\t\t\t}\n\t\t\t\t};\n\t\t\t};\n\n\t\t// Single- and empty arguments are adopted like Promise.resolve\n\t\tif ( remaining <= 1 ) {\n\t\t\tadoptValue( singleValue, primary.done( updateFunc( i ) ).resolve, primary.reject,\n\t\t\t\t!remaining );\n\n\t\t\t// Use .then() to unwrap secondary thenables (cf. gh-3000)\n\t\t\tif ( primary.state() === \"pending\" ||\n\t\t\t\tisFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) {\n\n\t\t\t\treturn primary.then();\n\t\t\t}\n\t\t}\n\n\t\t// Multiple arguments are aggregated like Promise.all array elements\n\t\twhile ( i-- ) {\n\t\t\tadoptValue( resolveValues[ i ], updateFunc( i ), primary.reject );\n\t\t}\n\n\t\treturn primary.promise();\n\t}\n} );\n\n\n// These usually indicate a programmer mistake during development,\n// warn about them ASAP rather than swallowing them by default.\nvar rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;\n\njQuery.Deferred.exceptionHook = function( error, stack ) {\n\n\t// Support: IE 8 - 9 only\n\t// Console exists when dev tools are open, which can happen at any time\n\tif ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) {\n\t\twindow.console.warn( \"jQuery.Deferred exception: \" + error.message, error.stack, stack );\n\t}\n};\n\n\n\n\njQuery.readyException = function( error ) {\n\twindow.setTimeout( function() {\n\t\tthrow error;\n\t} );\n};\n\n\n\n\n// The deferred used on DOM ready\nvar readyList = jQuery.Deferred();\n\njQuery.fn.ready = function( fn ) {\n\n\treadyList\n\t\t.then( fn )\n\n\t\t// Wrap jQuery.readyException in a function so that the lookup\n\t\t// happens at the time of error handling instead of callback\n\t\t// registration.\n\t\t.catch( function( error ) {\n\t\t\tjQuery.readyException( error );\n\t\t} );\n\n\treturn this;\n};\n\njQuery.extend( {\n\n\t// Is the DOM ready to be used? Set to true once it occurs.\n\tisReady: false,\n\n\t// A counter to track how many items to wait for before\n\t// the ready event fires. See #6781\n\treadyWait: 1,\n\n\t// Handle when the DOM is ready\n\tready: function( wait ) {\n\n\t\t// Abort if there are pending holds or we're already ready\n\t\tif ( wait === true ? --jQuery.readyWait : jQuery.isReady ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Remember that the DOM is ready\n\t\tjQuery.isReady = true;\n\n\t\t// If a normal DOM Ready event fired, decrement, and wait if need be\n\t\tif ( wait !== true && --jQuery.readyWait > 0 ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// If there are functions bound, to execute\n\t\treadyList.resolveWith( document, [ jQuery ] );\n\t}\n} );\n\njQuery.ready.then = readyList.then;\n\n// The ready event handler and self cleanup method\nfunction completed() {\n\tdocument.removeEventListener( \"DOMContentLoaded\", completed );\n\twindow.removeEventListener( \"load\", completed );\n\tjQuery.ready();\n}\n\n// Catch cases where $(document).ready() is called\n// after the browser event has already occurred.\n// Support: IE <=9 - 10 only\n// Older IE sometimes signals \"interactive\" too soon\nif ( document.readyState === \"complete\" ||\n\t( document.readyState !== \"loading\" && !document.documentElement.doScroll ) ) {\n\n\t// Handle it asynchronously to allow scripts the opportunity to delay ready\n\twindow.setTimeout( jQuery.ready );\n\n} else {\n\n\t// Use the handy event callback\n\tdocument.addEventListener( \"DOMContentLoaded\", completed );\n\n\t// A fallback to window.onload, that will always work\n\twindow.addEventListener( \"load\", completed );\n}\n\n\n\n\n// Multifunctional method to get and set values of a collection\n// The value/s can optionally be executed if it's a function\nvar access = function( elems, fn, key, value, chainable, emptyGet, raw ) {\n\tvar i = 0,\n\t\tlen = elems.length,\n\t\tbulk = key == null;\n\n\t// Sets many values\n\tif ( toType( key ) === \"object\" ) {\n\t\tchainable = true;\n\t\tfor ( i in key ) {\n\t\t\taccess( elems, fn, i, key[ i ], true, emptyGet, raw );\n\t\t}\n\n\t// Sets one value\n\t} else if ( value !== undefined ) {\n\t\tchainable = true;\n\n\t\tif ( !isFunction( value ) ) {\n\t\t\traw = true;\n\t\t}\n\n\t\tif ( bulk ) {\n\n\t\t\t// Bulk operations run against the entire set\n\t\t\tif ( raw ) {\n\t\t\t\tfn.call( elems, value );\n\t\t\t\tfn = null;\n\n\t\t\t// ...except when executing function values\n\t\t\t} else {\n\t\t\t\tbulk = fn;\n\t\t\t\tfn = function( elem, _key, value ) {\n\t\t\t\t\treturn bulk.call( jQuery( elem ), value );\n\t\t\t\t};\n\t\t\t}\n\t\t}\n\n\t\tif ( fn ) {\n\t\t\tfor ( ; i < len; i++ ) {\n\t\t\t\tfn(\n\t\t\t\t\telems[ i ], key, raw ?\n\t\t\t\t\t\tvalue :\n\t\t\t\t\t\tvalue.call( elems[ i ], i, fn( elems[ i ], key ) )\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\t}\n\n\tif ( chainable ) {\n\t\treturn elems;\n\t}\n\n\t// Gets\n\tif ( bulk ) {\n\t\treturn fn.call( elems );\n\t}\n\n\treturn len ? fn( elems[ 0 ], key ) : emptyGet;\n};\n\n\n// Matches dashed string for camelizing\nvar rmsPrefix = /^-ms-/,\n\trdashAlpha = /-([a-z])/g;\n\n// Used by camelCase as callback to replace()\nfunction fcamelCase( _all, letter ) {\n\treturn letter.toUpperCase();\n}\n\n// Convert dashed to camelCase; used by the css and data modules\n// Support: IE <=9 - 11, Edge 12 - 15\n// Microsoft forgot to hump their vendor prefix (#9572)\nfunction camelCase( string ) {\n\treturn string.replace( rmsPrefix, \"ms-\" ).replace( rdashAlpha, fcamelCase );\n}\nvar acceptData = function( owner ) {\n\n\t// Accepts only:\n\t// - Node\n\t// - Node.ELEMENT_NODE\n\t// - Node.DOCUMENT_NODE\n\t// - Object\n\t// - Any\n\treturn owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType );\n};\n\n\n\n\nfunction Data() {\n\tthis.expando = jQuery.expando + Data.uid++;\n}\n\nData.uid = 1;\n\nData.prototype = {\n\n\tcache: function( owner ) {\n\n\t\t// Check if the owner object already has a cache\n\t\tvar value = owner[ this.expando ];\n\n\t\t// If not, create one\n\t\tif ( !value ) {\n\t\t\tvalue = {};\n\n\t\t\t// We can accept data for non-element nodes in modern browsers,\n\t\t\t// but we should not, see #8335.\n\t\t\t// Always return an empty object.\n\t\t\tif ( acceptData( owner ) ) {\n\n\t\t\t\t// If it is a node unlikely to be stringify-ed or looped over\n\t\t\t\t// use plain assignment\n\t\t\t\tif ( owner.nodeType ) {\n\t\t\t\t\towner[ this.expando ] = value;\n\n\t\t\t\t// Otherwise secure it in a non-enumerable property\n\t\t\t\t// configurable must be true to allow the property to be\n\t\t\t\t// deleted when data is removed\n\t\t\t\t} else {\n\t\t\t\t\tObject.defineProperty( owner, this.expando, {\n\t\t\t\t\t\tvalue: value,\n\t\t\t\t\t\tconfigurable: true\n\t\t\t\t\t} );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn value;\n\t},\n\tset: function( owner, data, value ) {\n\t\tvar prop,\n\t\t\tcache = this.cache( owner );\n\n\t\t// Handle: [ owner, key, value ] args\n\t\t// Always use camelCase key (gh-2257)\n\t\tif ( typeof data === \"string\" ) {\n\t\t\tcache[ camelCase( data ) ] = value;\n\n\t\t// Handle: [ owner, { properties } ] args\n\t\t} else {\n\n\t\t\t// Copy the properties one-by-one to the cache object\n\t\t\tfor ( prop in data ) {\n\t\t\t\tcache[ camelCase( prop ) ] = data[ prop ];\n\t\t\t}\n\t\t}\n\t\treturn cache;\n\t},\n\tget: function( owner, key ) {\n\t\treturn key === undefined ?\n\t\t\tthis.cache( owner ) :\n\n\t\t\t// Always use camelCase key (gh-2257)\n\t\t\towner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ];\n\t},\n\taccess: function( owner, key, value ) {\n\n\t\t// In cases where either:\n\t\t//\n\t\t// 1. No key was specified\n\t\t// 2. A string key was specified, but no value provided\n\t\t//\n\t\t// Take the \"read\" path and allow the get method to determine\n\t\t// which value to return, respectively either:\n\t\t//\n\t\t// 1. The entire cache object\n\t\t// 2. The data stored at the key\n\t\t//\n\t\tif ( key === undefined ||\n\t\t\t\t( ( key && typeof key === \"string\" ) && value === undefined ) ) {\n\n\t\t\treturn this.get( owner, key );\n\t\t}\n\n\t\t// When the key is not a string, or both a key and value\n\t\t// are specified, set or extend (existing objects) with either:\n\t\t//\n\t\t// 1. An object of properties\n\t\t// 2. A key and value\n\t\t//\n\t\tthis.set( owner, key, value );\n\n\t\t// Since the \"set\" path can have two possible entry points\n\t\t// return the expected data based on which path was taken[*]\n\t\treturn value !== undefined ? value : key;\n\t},\n\tremove: function( owner, key ) {\n\t\tvar i,\n\t\t\tcache = owner[ this.expando ];\n\n\t\tif ( cache === undefined ) {\n\t\t\treturn;\n\t\t}\n\n\t\tif ( key !== undefined ) {\n\n\t\t\t// Support array or space separated string of keys\n\t\t\tif ( Array.isArray( key ) ) {\n\n\t\t\t\t// If key is an array of keys...\n\t\t\t\t// We always set camelCase keys, so remove that.\n\t\t\t\tkey = key.map( camelCase );\n\t\t\t} else {\n\t\t\t\tkey = camelCase( key );\n\n\t\t\t\t// If a key with the spaces exists, use it.\n\t\t\t\t// Otherwise, create an array by matching non-whitespace\n\t\t\t\tkey = key in cache ?\n\t\t\t\t\t[ key ] :\n\t\t\t\t\t( key.match( rnothtmlwhite ) || [] );\n\t\t\t}\n\n\t\t\ti = key.length;\n\n\t\t\twhile ( i-- ) {\n\t\t\t\tdelete cache[ key[ i ] ];\n\t\t\t}\n\t\t}\n\n\t\t// Remove the expando if there's no more data\n\t\tif ( key === undefined || jQuery.isEmptyObject( cache ) ) {\n\n\t\t\t// Support: Chrome <=35 - 45\n\t\t\t// Webkit & Blink performance suffers when deleting properties\n\t\t\t// from DOM nodes, so set to undefined instead\n\t\t\t// https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted)\n\t\t\tif ( owner.nodeType ) {\n\t\t\t\towner[ this.expando ] = undefined;\n\t\t\t} else {\n\t\t\t\tdelete owner[ this.expando ];\n\t\t\t}\n\t\t}\n\t},\n\thasData: function( owner ) {\n\t\tvar cache = owner[ this.expando ];\n\t\treturn cache !== undefined && !jQuery.isEmptyObject( cache );\n\t}\n};\nvar dataPriv = new Data();\n\nvar dataUser = new Data();\n\n\n\n//\tImplementation Summary\n//\n//\t1. Enforce API surface and semantic compatibility with 1.9.x branch\n//\t2. Improve the module's maintainability by reducing the storage\n//\t\tpaths to a single mechanism.\n//\t3. Use the same single mechanism to support \"private\" and \"user\" data.\n//\t4. _Never_ expose \"private\" data to user code (TODO: Drop _data, _removeData)\n//\t5. Avoid exposing implementation details on user objects (eg. expando properties)\n//\t6. Provide a clear path for implementation upgrade to WeakMap in 2014\n\nvar rbrace = /^(?:\\{[\\w\\W]*\\}|\\[[\\w\\W]*\\])$/,\n\trmultiDash = /[A-Z]/g;\n\nfunction getData( data ) {\n\tif ( data === \"true\" ) {\n\t\treturn true;\n\t}\n\n\tif ( data === \"false\" ) {\n\t\treturn false;\n\t}\n\n\tif ( data === \"null\" ) {\n\t\treturn null;\n\t}\n\n\t// Only convert to a number if it doesn't change the string\n\tif ( data === +data + \"\" ) {\n\t\treturn +data;\n\t}\n\n\tif ( rbrace.test( data ) ) {\n\t\treturn JSON.parse( data );\n\t}\n\n\treturn data;\n}\n\nfunction dataAttr( elem, key, data ) {\n\tvar name;\n\n\t// If nothing was found internally, try to fetch any\n\t// data from the HTML5 data-* attribute\n\tif ( data === undefined && elem.nodeType === 1 ) {\n\t\tname = \"data-\" + key.replace( rmultiDash, \"-$&\" ).toLowerCase();\n\t\tdata = elem.getAttribute( name );\n\n\t\tif ( typeof data === \"string\" ) {\n\t\t\ttry {\n\t\t\t\tdata = getData( data );\n\t\t\t} catch ( e ) {}\n\n\t\t\t// Make sure we set the data so it isn't changed later\n\t\t\tdataUser.set( elem, key, data );\n\t\t} else {\n\t\t\tdata = undefined;\n\t\t}\n\t}\n\treturn data;\n}\n\njQuery.extend( {\n\thasData: function( elem ) {\n\t\treturn dataUser.hasData( elem ) || dataPriv.hasData( elem );\n\t},\n\n\tdata: function( elem, name, data ) {\n\t\treturn dataUser.access( elem, name, data );\n\t},\n\n\tremoveData: function( elem, name ) {\n\t\tdataUser.remove( elem, name );\n\t},\n\n\t// TODO: Now that all calls to _data and _removeData have been replaced\n\t// with direct calls to dataPriv methods, these can be deprecated.\n\t_data: function( elem, name, data ) {\n\t\treturn dataPriv.access( elem, name, data );\n\t},\n\n\t_removeData: function( elem, name ) {\n\t\tdataPriv.remove( elem, name );\n\t}\n} );\n\njQuery.fn.extend( {\n\tdata: function( key, value ) {\n\t\tvar i, name, data,\n\t\t\telem = this[ 0 ],\n\t\t\tattrs = elem && elem.attributes;\n\n\t\t// Gets all values\n\t\tif ( key === undefined ) {\n\t\t\tif ( this.length ) {\n\t\t\t\tdata = dataUser.get( elem );\n\n\t\t\t\tif ( elem.nodeType === 1 && !dataPriv.get( elem, \"hasDataAttrs\" ) ) {\n\t\t\t\t\ti = attrs.length;\n\t\t\t\t\twhile ( i-- ) {\n\n\t\t\t\t\t\t// Support: IE 11 only\n\t\t\t\t\t\t// The attrs elements can be null (#14894)\n\t\t\t\t\t\tif ( attrs[ i ] ) {\n\t\t\t\t\t\t\tname = attrs[ i ].name;\n\t\t\t\t\t\t\tif ( name.indexOf( \"data-\" ) === 0 ) {\n\t\t\t\t\t\t\t\tname = camelCase( name.slice( 5 ) );\n\t\t\t\t\t\t\t\tdataAttr( elem, name, data[ name ] );\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tdataPriv.set( elem, \"hasDataAttrs\", true );\n\t\t\t\t}\n\t\t\t}\n\n\t\t\treturn data;\n\t\t}\n\n\t\t// Sets multiple values\n\t\tif ( typeof key === \"object\" ) {\n\t\t\treturn this.each( function() {\n\t\t\t\tdataUser.set( this, key );\n\t\t\t} );\n\t\t}\n\n\t\treturn access( this, function( value ) {\n\t\t\tvar data;\n\n\t\t\t// The calling jQuery object (element matches) is not empty\n\t\t\t// (and therefore has an element appears at this[ 0 ]) and the\n\t\t\t// `value` parameter was not undefined. An empty jQuery object\n\t\t\t// will result in `undefined` for elem = this[ 0 ] which will\n\t\t\t// throw an exception if an attempt to read a data cache is made.\n\t\t\tif ( elem && value === undefined ) {\n\n\t\t\t\t// Attempt to get data from the cache\n\t\t\t\t// The key will always be camelCased in Data\n\t\t\t\tdata = dataUser.get( elem, key );\n\t\t\t\tif ( data !== undefined ) {\n\t\t\t\t\treturn data;\n\t\t\t\t}\n\n\t\t\t\t// Attempt to \"discover\" the data in\n\t\t\t\t// HTML5 custom data-* attrs\n\t\t\t\tdata = dataAttr( elem, key );\n\t\t\t\tif ( data !== undefined ) {\n\t\t\t\t\treturn data;\n\t\t\t\t}\n\n\t\t\t\t// We tried really hard, but the data doesn't exist.\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\t// Set the data...\n\t\t\tthis.each( function() {\n\n\t\t\t\t// We always store the camelCased key\n\t\t\t\tdataUser.set( this, key, value );\n\t\t\t} );\n\t\t}, null, value, arguments.length > 1, null, true );\n\t},\n\n\tremoveData: function( key ) {\n\t\treturn this.each( function() {\n\t\t\tdataUser.remove( this, key );\n\t\t} );\n\t}\n} );\n\n\njQuery.extend( {\n\tqueue: function( elem, type, data ) {\n\t\tvar queue;\n\n\t\tif ( elem ) {\n\t\t\ttype = ( type || \"fx\" ) + \"queue\";\n\t\t\tqueue = dataPriv.get( elem, type );\n\n\t\t\t// Speed up dequeue by getting out quickly if this is just a lookup\n\t\t\tif ( data ) {\n\t\t\t\tif ( !queue || Array.isArray( data ) ) {\n\t\t\t\t\tqueue = dataPriv.access( elem, type, jQuery.makeArray( data ) );\n\t\t\t\t} else {\n\t\t\t\t\tqueue.push( data );\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn queue || [];\n\t\t}\n\t},\n\n\tdequeue: function( elem, type ) {\n\t\ttype = type || \"fx\";\n\n\t\tvar queue = jQuery.queue( elem, type ),\n\t\t\tstartLength = queue.length,\n\t\t\tfn = queue.shift(),\n\t\t\thooks = jQuery._queueHooks( elem, type ),\n\t\t\tnext = function() {\n\t\t\t\tjQuery.dequeue( elem, type );\n\t\t\t};\n\n\t\t// If the fx queue is dequeued, always remove the progress sentinel\n\t\tif ( fn === \"inprogress\" ) {\n\t\t\tfn = queue.shift();\n\t\t\tstartLength--;\n\t\t}\n\n\t\tif ( fn ) {\n\n\t\t\t// Add a progress sentinel to prevent the fx queue from being\n\t\t\t// automatically dequeued\n\t\t\tif ( type === \"fx\" ) {\n\t\t\t\tqueue.unshift( \"inprogress\" );\n\t\t\t}\n\n\t\t\t// Clear up the last queue stop function\n\t\t\tdelete hooks.stop;\n\t\t\tfn.call( elem, next, hooks );\n\t\t}\n\n\t\tif ( !startLength && hooks ) {\n\t\t\thooks.empty.fire();\n\t\t}\n\t},\n\n\t// Not public - generate a queueHooks object, or return the current one\n\t_queueHooks: function( elem, type ) {\n\t\tvar key = type + \"queueHooks\";\n\t\treturn dataPriv.get( elem, key ) || dataPriv.access( elem, key, {\n\t\t\tempty: jQuery.Callbacks( \"once memory\" ).add( function() {\n\t\t\t\tdataPriv.remove( elem, [ type + \"queue\", key ] );\n\t\t\t} )\n\t\t} );\n\t}\n} );\n\njQuery.fn.extend( {\n\tqueue: function( type, data ) {\n\t\tvar setter = 2;\n\n\t\tif ( typeof type !== \"string\" ) {\n\t\t\tdata = type;\n\t\t\ttype = \"fx\";\n\t\t\tsetter--;\n\t\t}\n\n\t\tif ( arguments.length < setter ) {\n\t\t\treturn jQuery.queue( this[ 0 ], type );\n\t\t}\n\n\t\treturn data === undefined ?\n\t\t\tthis :\n\t\t\tthis.each( function() {\n\t\t\t\tvar queue = jQuery.queue( this, type, data );\n\n\t\t\t\t// Ensure a hooks for this queue\n\t\t\t\tjQuery._queueHooks( this, type );\n\n\t\t\t\tif ( type === \"fx\" && queue[ 0 ] !== \"inprogress\" ) {\n\t\t\t\t\tjQuery.dequeue( this, type );\n\t\t\t\t}\n\t\t\t} );\n\t},\n\tdequeue: function( type ) {\n\t\treturn this.each( function() {\n\t\t\tjQuery.dequeue( this, type );\n\t\t} );\n\t},\n\tclearQueue: function( type ) {\n\t\treturn this.queue( type || \"fx\", [] );\n\t},\n\n\t// Get a promise resolved when queues of a certain type\n\t// are emptied (fx is the type by default)\n\tpromise: function( type, obj ) {\n\t\tvar tmp,\n\t\t\tcount = 1,\n\t\t\tdefer = jQuery.Deferred(),\n\t\t\telements = this,\n\t\t\ti = this.length,\n\t\t\tresolve = function() {\n\t\t\t\tif ( !( --count ) ) {\n\t\t\t\t\tdefer.resolveWith( elements, [ elements ] );\n\t\t\t\t}\n\t\t\t};\n\n\t\tif ( typeof type !== \"string\" ) {\n\t\t\tobj = type;\n\t\t\ttype = undefined;\n\t\t}\n\t\ttype = type || \"fx\";\n\n\t\twhile ( i-- ) {\n\t\t\ttmp = dataPriv.get( elements[ i ], type + \"queueHooks\" );\n\t\t\tif ( tmp && tmp.empty ) {\n\t\t\t\tcount++;\n\t\t\t\ttmp.empty.add( resolve );\n\t\t\t}\n\t\t}\n\t\tresolve();\n\t\treturn defer.promise( obj );\n\t}\n} );\nvar pnum = ( /[+-]?(?:\\d*\\.|)\\d+(?:[eE][+-]?\\d+|)/ ).source;\n\nvar rcssNum = new RegExp( \"^(?:([+-])=|)(\" + pnum + \")([a-z%]*)$\", \"i\" );\n\n\nvar cssExpand = [ \"Top\", \"Right\", \"Bottom\", \"Left\" ];\n\nvar documentElement = document.documentElement;\n\n\n\n\tvar isAttached = function( elem ) {\n\t\t\treturn jQuery.contains( elem.ownerDocument, elem );\n\t\t},\n\t\tcomposed = { composed: true };\n\n\t// Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only\n\t// Check attachment across shadow DOM boundaries when possible (gh-3504)\n\t// Support: iOS 10.0-10.2 only\n\t// Early iOS 10 versions support `attachShadow` but not `getRootNode`,\n\t// leading to errors. We need to check for `getRootNode`.\n\tif ( documentElement.getRootNode ) {\n\t\tisAttached = function( elem ) {\n\t\t\treturn jQuery.contains( elem.ownerDocument, elem ) ||\n\t\t\t\telem.getRootNode( composed ) === elem.ownerDocument;\n\t\t};\n\t}\nvar isHiddenWithinTree = function( elem, el ) {\n\n\t\t// isHiddenWithinTree might be called from jQuery#filter function;\n\t\t// in that case, element will be second argument\n\t\telem = el || elem;\n\n\t\t// Inline style trumps all\n\t\treturn elem.style.display === \"none\" ||\n\t\t\telem.style.display === \"\" &&\n\n\t\t\t// Otherwise, check computed style\n\t\t\t// Support: Firefox <=43 - 45\n\t\t\t// Disconnected elements can have computed display: none, so first confirm that elem is\n\t\t\t// in the document.\n\t\t\tisAttached( elem ) &&\n\n\t\t\tjQuery.css( elem, \"display\" ) === \"none\";\n\t};\n\n\n\nfunction adjustCSS( elem, prop, valueParts, tween ) {\n\tvar adjusted, scale,\n\t\tmaxIterations = 20,\n\t\tcurrentValue = tween ?\n\t\t\tfunction() {\n\t\t\t\treturn tween.cur();\n\t\t\t} :\n\t\t\tfunction() {\n\t\t\t\treturn jQuery.css( elem, prop, \"\" );\n\t\t\t},\n\t\tinitial = currentValue(),\n\t\tunit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? \"\" : \"px\" ),\n\n\t\t// Starting value computation is required for potential unit mismatches\n\t\tinitialInUnit = elem.nodeType &&\n\t\t\t( jQuery.cssNumber[ prop ] || unit !== \"px\" && +initial ) &&\n\t\t\trcssNum.exec( jQuery.css( elem, prop ) );\n\n\tif ( initialInUnit && initialInUnit[ 3 ] !== unit ) {\n\n\t\t// Support: Firefox <=54\n\t\t// Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144)\n\t\tinitial = initial / 2;\n\n\t\t// Trust units reported by jQuery.css\n\t\tunit = unit || initialInUnit[ 3 ];\n\n\t\t// Iteratively approximate from a nonzero starting point\n\t\tinitialInUnit = +initial || 1;\n\n\t\twhile ( maxIterations-- ) {\n\n\t\t\t// Evaluate and update our best guess (doubling guesses that zero out).\n\t\t\t// Finish if the scale equals or crosses 1 (making the old*new product non-positive).\n\t\t\tjQuery.style( elem, prop, initialInUnit + unit );\n\t\t\tif ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) {\n\t\t\t\tmaxIterations = 0;\n\t\t\t}\n\t\t\tinitialInUnit = initialInUnit / scale;\n\n\t\t}\n\n\t\tinitialInUnit = initialInUnit * 2;\n\t\tjQuery.style( elem, prop, initialInUnit + unit );\n\n\t\t// Make sure we update the tween properties later on\n\t\tvalueParts = valueParts || [];\n\t}\n\n\tif ( valueParts ) {\n\t\tinitialInUnit = +initialInUnit || +initial || 0;\n\n\t\t// Apply relative offset (+=/-=) if specified\n\t\tadjusted = valueParts[ 1 ] ?\n\t\t\tinitialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] :\n\t\t\t+valueParts[ 2 ];\n\t\tif ( tween ) {\n\t\t\ttween.unit = unit;\n\t\t\ttween.start = initialInUnit;\n\t\t\ttween.end = adjusted;\n\t\t}\n\t}\n\treturn adjusted;\n}\n\n\nvar defaultDisplayMap = {};\n\nfunction getDefaultDisplay( elem ) {\n\tvar temp,\n\t\tdoc = elem.ownerDocument,\n\t\tnodeName = elem.nodeName,\n\t\tdisplay = defaultDisplayMap[ nodeName ];\n\n\tif ( display ) {\n\t\treturn display;\n\t}\n\n\ttemp = doc.body.appendChild( doc.createElement( nodeName ) );\n\tdisplay = jQuery.css( temp, \"display\" );\n\n\ttemp.parentNode.removeChild( temp );\n\n\tif ( display === \"none\" ) {\n\t\tdisplay = \"block\";\n\t}\n\tdefaultDisplayMap[ nodeName ] = display;\n\n\treturn display;\n}\n\nfunction showHide( elements, show ) {\n\tvar display, elem,\n\t\tvalues = [],\n\t\tindex = 0,\n\t\tlength = elements.length;\n\n\t// Determine new display value for elements that need to change\n\tfor ( ; index < length; index++ ) {\n\t\telem = elements[ index ];\n\t\tif ( !elem.style ) {\n\t\t\tcontinue;\n\t\t}\n\n\t\tdisplay = elem.style.display;\n\t\tif ( show ) {\n\n\t\t\t// Since we force visibility upon cascade-hidden elements, an immediate (and slow)\n\t\t\t// check is required in this first loop unless we have a nonempty display value (either\n\t\t\t// inline or about-to-be-restored)\n\t\t\tif ( display === \"none\" ) {\n\t\t\t\tvalues[ index ] = dataPriv.get( elem, \"display\" ) || null;\n\t\t\t\tif ( !values[ index ] ) {\n\t\t\t\t\telem.style.display = \"\";\n\t\t\t\t}\n\t\t\t}\n\t\t\tif ( elem.style.display === \"\" && isHiddenWithinTree( elem ) ) {\n\t\t\t\tvalues[ index ] = getDefaultDisplay( elem );\n\t\t\t}\n\t\t} else {\n\t\t\tif ( display !== \"none\" ) {\n\t\t\t\tvalues[ index ] = \"none\";\n\n\t\t\t\t// Remember what we're overwriting\n\t\t\t\tdataPriv.set( elem, \"display\", display );\n\t\t\t}\n\t\t}\n\t}\n\n\t// Set the display of the elements in a second loop to avoid constant reflow\n\tfor ( index = 0; index < length; index++ ) {\n\t\tif ( values[ index ] != null ) {\n\t\t\telements[ index ].style.display = values[ index ];\n\t\t}\n\t}\n\n\treturn elements;\n}\n\njQuery.fn.extend( {\n\tshow: function() {\n\t\treturn showHide( this, true );\n\t},\n\thide: function() {\n\t\treturn showHide( this );\n\t},\n\ttoggle: function( state ) {\n\t\tif ( typeof state === \"boolean\" ) {\n\t\t\treturn state ? this.show() : this.hide();\n\t\t}\n\n\t\treturn this.each( function() {\n\t\t\tif ( isHiddenWithinTree( this ) ) {\n\t\t\t\tjQuery( this ).show();\n\t\t\t} else {\n\t\t\t\tjQuery( this ).hide();\n\t\t\t}\n\t\t} );\n\t}\n} );\nvar rcheckableType = ( /^(?:checkbox|radio)$/i );\n\nvar rtagName = ( /<([a-z][^\\/\\0>\\x20\\t\\r\\n\\f]*)/i );\n\nvar rscriptType = ( /^$|^module$|\\/(?:java|ecma)script/i );\n\n\n\n( function() {\n\tvar fragment = document.createDocumentFragment(),\n\t\tdiv = fragment.appendChild( document.createElement( \"div\" ) ),\n\t\tinput = document.createElement( \"input\" );\n\n\t// Support: Android 4.0 - 4.3 only\n\t// Check state lost if the name is set (#11217)\n\t// Support: Windows Web Apps (WWA)\n\t// `name` and `type` must use .setAttribute for WWA (#14901)\n\tinput.setAttribute( \"type\", \"radio\" );\n\tinput.setAttribute( \"checked\", \"checked\" );\n\tinput.setAttribute( \"name\", \"t\" );\n\n\tdiv.appendChild( input );\n\n\t// Support: Android <=4.1 only\n\t// Older WebKit doesn't clone checked state correctly in fragments\n\tsupport.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked;\n\n\t// Support: IE <=11 only\n\t// Make sure textarea (and checkbox) defaultValue is properly cloned\n\tdiv.innerHTML = \"\";\n\tsupport.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue;\n\n\t// Support: IE <=9 only\n\t// IE <=9 replaces \";\n\tsupport.option = !!div.lastChild;\n} )();\n\n\n// We have to close these tags to support XHTML (#13200)\nvar wrapMap = {\n\n\t// XHTML parsers do not magically insert elements in the\n\t// same way that tag soup parsers do. So we cannot shorten\n\t// this by omitting or other required elements.\n\tthead: [ 1, \"\", \"
\" ],\n\tcol: [ 2, \"\", \"
\" ],\n\ttr: [ 2, \"\", \"
\" ],\n\ttd: [ 3, \"\", \"
\" ],\n\n\t_default: [ 0, \"\", \"\" ]\n};\n\nwrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead;\nwrapMap.th = wrapMap.td;\n\n// Support: IE <=9 only\nif ( !support.option ) {\n\twrapMap.optgroup = wrapMap.option = [ 1, \"\" ];\n}\n\n\nfunction getAll( context, tag ) {\n\n\t// Support: IE <=9 - 11 only\n\t// Use typeof to avoid zero-argument method invocation on host objects (#15151)\n\tvar ret;\n\n\tif ( typeof context.getElementsByTagName !== \"undefined\" ) {\n\t\tret = context.getElementsByTagName( tag || \"*\" );\n\n\t} else if ( typeof context.querySelectorAll !== \"undefined\" ) {\n\t\tret = context.querySelectorAll( tag || \"*\" );\n\n\t} else {\n\t\tret = [];\n\t}\n\n\tif ( tag === undefined || tag && nodeName( context, tag ) ) {\n\t\treturn jQuery.merge( [ context ], ret );\n\t}\n\n\treturn ret;\n}\n\n\n// Mark scripts as having already been evaluated\nfunction setGlobalEval( elems, refElements ) {\n\tvar i = 0,\n\t\tl = elems.length;\n\n\tfor ( ; i < l; i++ ) {\n\t\tdataPriv.set(\n\t\t\telems[ i ],\n\t\t\t\"globalEval\",\n\t\t\t!refElements || dataPriv.get( refElements[ i ], \"globalEval\" )\n\t\t);\n\t}\n}\n\n\nvar rhtml = /<|&#?\\w+;/;\n\nfunction buildFragment( elems, context, scripts, selection, ignored ) {\n\tvar elem, tmp, tag, wrap, attached, j,\n\t\tfragment = context.createDocumentFragment(),\n\t\tnodes = [],\n\t\ti = 0,\n\t\tl = elems.length;\n\n\tfor ( ; i < l; i++ ) {\n\t\telem = elems[ i ];\n\n\t\tif ( elem || elem === 0 ) {\n\n\t\t\t// Add nodes directly\n\t\t\tif ( toType( elem ) === \"object\" ) {\n\n\t\t\t\t// Support: Android <=4.0 only, PhantomJS 1 only\n\t\t\t\t// push.apply(_, arraylike) throws on ancient WebKit\n\t\t\t\tjQuery.merge( nodes, elem.nodeType ? [ elem ] : elem );\n\n\t\t\t// Convert non-html into a text node\n\t\t\t} else if ( !rhtml.test( elem ) ) {\n\t\t\t\tnodes.push( context.createTextNode( elem ) );\n\n\t\t\t// Convert html into DOM nodes\n\t\t\t} else {\n\t\t\t\ttmp = tmp || fragment.appendChild( context.createElement( \"div\" ) );\n\n\t\t\t\t// Deserialize a standard representation\n\t\t\t\ttag = ( rtagName.exec( elem ) || [ \"\", \"\" ] )[ 1 ].toLowerCase();\n\t\t\t\twrap = wrapMap[ tag ] || wrapMap._default;\n\t\t\t\ttmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ];\n\n\t\t\t\t// Descend through wrappers to the right content\n\t\t\t\tj = wrap[ 0 ];\n\t\t\t\twhile ( j-- ) {\n\t\t\t\t\ttmp = tmp.lastChild;\n\t\t\t\t}\n\n\t\t\t\t// Support: Android <=4.0 only, PhantomJS 1 only\n\t\t\t\t// push.apply(_, arraylike) throws on ancient WebKit\n\t\t\t\tjQuery.merge( nodes, tmp.childNodes );\n\n\t\t\t\t// Remember the top-level container\n\t\t\t\ttmp = fragment.firstChild;\n\n\t\t\t\t// Ensure the created nodes are orphaned (#12392)\n\t\t\t\ttmp.textContent = \"\";\n\t\t\t}\n\t\t}\n\t}\n\n\t// Remove wrapper from fragment\n\tfragment.textContent = \"\";\n\n\ti = 0;\n\twhile ( ( elem = nodes[ i++ ] ) ) {\n\n\t\t// Skip elements already in the context collection (trac-4087)\n\t\tif ( selection && jQuery.inArray( elem, selection ) > -1 ) {\n\t\t\tif ( ignored ) {\n\t\t\t\tignored.push( elem );\n\t\t\t}\n\t\t\tcontinue;\n\t\t}\n\n\t\tattached = isAttached( elem );\n\n\t\t// Append to fragment\n\t\ttmp = getAll( fragment.appendChild( elem ), \"script\" );\n\n\t\t// Preserve script evaluation history\n\t\tif ( attached ) {\n\t\t\tsetGlobalEval( tmp );\n\t\t}\n\n\t\t// Capture executables\n\t\tif ( scripts ) {\n\t\t\tj = 0;\n\t\t\twhile ( ( elem = tmp[ j++ ] ) ) {\n\t\t\t\tif ( rscriptType.test( elem.type || \"\" ) ) {\n\t\t\t\t\tscripts.push( elem );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\treturn fragment;\n}\n\n\nvar rtypenamespace = /^([^.]*)(?:\\.(.+)|)/;\n\nfunction returnTrue() {\n\treturn true;\n}\n\nfunction returnFalse() {\n\treturn false;\n}\n\n// Support: IE <=9 - 11+\n// focus() and blur() are asynchronous, except when they are no-op.\n// So expect focus to be synchronous when the element is already active,\n// and blur to be synchronous when the element is not already active.\n// (focus and blur are always synchronous in other supported browsers,\n// this just defines when we can count on it).\nfunction expectSync( elem, type ) {\n\treturn ( elem === safeActiveElement() ) === ( type === \"focus\" );\n}\n\n// Support: IE <=9 only\n// Accessing document.activeElement can throw unexpectedly\n// https://bugs.jquery.com/ticket/13393\nfunction safeActiveElement() {\n\ttry {\n\t\treturn document.activeElement;\n\t} catch ( err ) { }\n}\n\nfunction on( elem, types, selector, data, fn, one ) {\n\tvar origFn, type;\n\n\t// Types can be a map of types/handlers\n\tif ( typeof types === \"object\" ) {\n\n\t\t// ( types-Object, selector, data )\n\t\tif ( typeof selector !== \"string\" ) {\n\n\t\t\t// ( types-Object, data )\n\t\t\tdata = data || selector;\n\t\t\tselector = undefined;\n\t\t}\n\t\tfor ( type in types ) {\n\t\t\ton( elem, type, selector, data, types[ type ], one );\n\t\t}\n\t\treturn elem;\n\t}\n\n\tif ( data == null && fn == null ) {\n\n\t\t// ( types, fn )\n\t\tfn = selector;\n\t\tdata = selector = undefined;\n\t} else if ( fn == null ) {\n\t\tif ( typeof selector === \"string\" ) {\n\n\t\t\t// ( types, selector, fn )\n\t\t\tfn = data;\n\t\t\tdata = undefined;\n\t\t} else {\n\n\t\t\t// ( types, data, fn )\n\t\t\tfn = data;\n\t\t\tdata = selector;\n\t\t\tselector = undefined;\n\t\t}\n\t}\n\tif ( fn === false ) {\n\t\tfn = returnFalse;\n\t} else if ( !fn ) {\n\t\treturn elem;\n\t}\n\n\tif ( one === 1 ) {\n\t\torigFn = fn;\n\t\tfn = function( event ) {\n\n\t\t\t// Can use an empty set, since event contains the info\n\t\t\tjQuery().off( event );\n\t\t\treturn origFn.apply( this, arguments );\n\t\t};\n\n\t\t// Use same guid so caller can remove using origFn\n\t\tfn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ );\n\t}\n\treturn elem.each( function() {\n\t\tjQuery.event.add( this, types, fn, data, selector );\n\t} );\n}\n\n/*\n * Helper functions for managing events -- not part of the public interface.\n * Props to Dean Edwards' addEvent library for many of the ideas.\n */\njQuery.event = {\n\n\tglobal: {},\n\n\tadd: function( elem, types, handler, data, selector ) {\n\n\t\tvar handleObjIn, eventHandle, tmp,\n\t\t\tevents, t, handleObj,\n\t\t\tspecial, handlers, type, namespaces, origType,\n\t\t\telemData = dataPriv.get( elem );\n\n\t\t// Only attach events to objects that accept data\n\t\tif ( !acceptData( elem ) ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Caller can pass in an object of custom data in lieu of the handler\n\t\tif ( handler.handler ) {\n\t\t\thandleObjIn = handler;\n\t\t\thandler = handleObjIn.handler;\n\t\t\tselector = handleObjIn.selector;\n\t\t}\n\n\t\t// Ensure that invalid selectors throw exceptions at attach time\n\t\t// Evaluate against documentElement in case elem is a non-element node (e.g., document)\n\t\tif ( selector ) {\n\t\t\tjQuery.find.matchesSelector( documentElement, selector );\n\t\t}\n\n\t\t// Make sure that the handler has a unique ID, used to find/remove it later\n\t\tif ( !handler.guid ) {\n\t\t\thandler.guid = jQuery.guid++;\n\t\t}\n\n\t\t// Init the element's event structure and main handler, if this is the first\n\t\tif ( !( events = elemData.events ) ) {\n\t\t\tevents = elemData.events = Object.create( null );\n\t\t}\n\t\tif ( !( eventHandle = elemData.handle ) ) {\n\t\t\teventHandle = elemData.handle = function( e ) {\n\n\t\t\t\t// Discard the second event of a jQuery.event.trigger() and\n\t\t\t\t// when an event is called after a page has unloaded\n\t\t\t\treturn typeof jQuery !== \"undefined\" && jQuery.event.triggered !== e.type ?\n\t\t\t\t\tjQuery.event.dispatch.apply( elem, arguments ) : undefined;\n\t\t\t};\n\t\t}\n\n\t\t// Handle multiple events separated by a space\n\t\ttypes = ( types || \"\" ).match( rnothtmlwhite ) || [ \"\" ];\n\t\tt = types.length;\n\t\twhile ( t-- ) {\n\t\t\ttmp = rtypenamespace.exec( types[ t ] ) || [];\n\t\t\ttype = origType = tmp[ 1 ];\n\t\t\tnamespaces = ( tmp[ 2 ] || \"\" ).split( \".\" ).sort();\n\n\t\t\t// There *must* be a type, no attaching namespace-only handlers\n\t\t\tif ( !type ) {\n\t\t\t\tcontinue;\n\t\t\t}\n\n\t\t\t// If event changes its type, use the special event handlers for the changed type\n\t\t\tspecial = jQuery.event.special[ type ] || {};\n\n\t\t\t// If selector defined, determine special event api type, otherwise given type\n\t\t\ttype = ( selector ? special.delegateType : special.bindType ) || type;\n\n\t\t\t// Update special based on newly reset type\n\t\t\tspecial = jQuery.event.special[ type ] || {};\n\n\t\t\t// handleObj is passed to all event handlers\n\t\t\thandleObj = jQuery.extend( {\n\t\t\t\ttype: type,\n\t\t\t\torigType: origType,\n\t\t\t\tdata: data,\n\t\t\t\thandler: handler,\n\t\t\t\tguid: handler.guid,\n\t\t\t\tselector: selector,\n\t\t\t\tneedsContext: selector && jQuery.expr.match.needsContext.test( selector ),\n\t\t\t\tnamespace: namespaces.join( \".\" )\n\t\t\t}, handleObjIn );\n\n\t\t\t// Init the event handler queue if we're the first\n\t\t\tif ( !( handlers = events[ type ] ) ) {\n\t\t\t\thandlers = events[ type ] = [];\n\t\t\t\thandlers.delegateCount = 0;\n\n\t\t\t\t// Only use addEventListener if the special events handler returns false\n\t\t\t\tif ( !special.setup ||\n\t\t\t\t\tspecial.setup.call( elem, data, namespaces, eventHandle ) === false ) {\n\n\t\t\t\t\tif ( elem.addEventListener ) {\n\t\t\t\t\t\telem.addEventListener( type, eventHandle );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif ( special.add ) {\n\t\t\t\tspecial.add.call( elem, handleObj );\n\n\t\t\t\tif ( !handleObj.handler.guid ) {\n\t\t\t\t\thandleObj.handler.guid = handler.guid;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Add to the element's handler list, delegates in front\n\t\t\tif ( selector ) {\n\t\t\t\thandlers.splice( handlers.delegateCount++, 0, handleObj );\n\t\t\t} else {\n\t\t\t\thandlers.push( handleObj );\n\t\t\t}\n\n\t\t\t// Keep track of which events have ever been used, for event optimization\n\t\t\tjQuery.event.global[ type ] = true;\n\t\t}\n\n\t},\n\n\t// Detach an event or set of events from an element\n\tremove: function( elem, types, handler, selector, mappedTypes ) {\n\n\t\tvar j, origCount, tmp,\n\t\t\tevents, t, handleObj,\n\t\t\tspecial, handlers, type, namespaces, origType,\n\t\t\telemData = dataPriv.hasData( elem ) && dataPriv.get( elem );\n\n\t\tif ( !elemData || !( events = elemData.events ) ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Once for each type.namespace in types; type may be omitted\n\t\ttypes = ( types || \"\" ).match( rnothtmlwhite ) || [ \"\" ];\n\t\tt = types.length;\n\t\twhile ( t-- ) {\n\t\t\ttmp = rtypenamespace.exec( types[ t ] ) || [];\n\t\t\ttype = origType = tmp[ 1 ];\n\t\t\tnamespaces = ( tmp[ 2 ] || \"\" ).split( \".\" ).sort();\n\n\t\t\t// Unbind all events (on this namespace, if provided) for the element\n\t\t\tif ( !type ) {\n\t\t\t\tfor ( type in events ) {\n\t\t\t\t\tjQuery.event.remove( elem, type + types[ t ], handler, selector, true );\n\t\t\t\t}\n\t\t\t\tcontinue;\n\t\t\t}\n\n\t\t\tspecial = jQuery.event.special[ type ] || {};\n\t\t\ttype = ( selector ? special.delegateType : special.bindType ) || type;\n\t\t\thandlers = events[ type ] || [];\n\t\t\ttmp = tmp[ 2 ] &&\n\t\t\t\tnew RegExp( \"(^|\\\\.)\" + namespaces.join( \"\\\\.(?:.*\\\\.|)\" ) + \"(\\\\.|$)\" );\n\n\t\t\t// Remove matching events\n\t\t\torigCount = j = handlers.length;\n\t\t\twhile ( j-- ) {\n\t\t\t\thandleObj = handlers[ j ];\n\n\t\t\t\tif ( ( mappedTypes || origType === handleObj.origType ) &&\n\t\t\t\t\t( !handler || handler.guid === handleObj.guid ) &&\n\t\t\t\t\t( !tmp || tmp.test( handleObj.namespace ) ) &&\n\t\t\t\t\t( !selector || selector === handleObj.selector ||\n\t\t\t\t\t\tselector === \"**\" && handleObj.selector ) ) {\n\t\t\t\t\thandlers.splice( j, 1 );\n\n\t\t\t\t\tif ( handleObj.selector ) {\n\t\t\t\t\t\thandlers.delegateCount--;\n\t\t\t\t\t}\n\t\t\t\t\tif ( special.remove ) {\n\t\t\t\t\t\tspecial.remove.call( elem, handleObj );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Remove generic event handler if we removed something and no more handlers exist\n\t\t\t// (avoids potential for endless recursion during removal of special event handlers)\n\t\t\tif ( origCount && !handlers.length ) {\n\t\t\t\tif ( !special.teardown ||\n\t\t\t\t\tspecial.teardown.call( elem, namespaces, elemData.handle ) === false ) {\n\n\t\t\t\t\tjQuery.removeEvent( elem, type, elemData.handle );\n\t\t\t\t}\n\n\t\t\t\tdelete events[ type ];\n\t\t\t}\n\t\t}\n\n\t\t// Remove data and the expando if it's no longer used\n\t\tif ( jQuery.isEmptyObject( events ) ) {\n\t\t\tdataPriv.remove( elem, \"handle events\" );\n\t\t}\n\t},\n\n\tdispatch: function( nativeEvent ) {\n\n\t\tvar i, j, ret, matched, handleObj, handlerQueue,\n\t\t\targs = new Array( arguments.length ),\n\n\t\t\t// Make a writable jQuery.Event from the native event object\n\t\t\tevent = jQuery.event.fix( nativeEvent ),\n\n\t\t\thandlers = (\n\t\t\t\tdataPriv.get( this, \"events\" ) || Object.create( null )\n\t\t\t)[ event.type ] || [],\n\t\t\tspecial = jQuery.event.special[ event.type ] || {};\n\n\t\t// Use the fix-ed jQuery.Event rather than the (read-only) native event\n\t\targs[ 0 ] = event;\n\n\t\tfor ( i = 1; i < arguments.length; i++ ) {\n\t\t\targs[ i ] = arguments[ i ];\n\t\t}\n\n\t\tevent.delegateTarget = this;\n\n\t\t// Call the preDispatch hook for the mapped type, and let it bail if desired\n\t\tif ( special.preDispatch && special.preDispatch.call( this, event ) === false ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Determine handlers\n\t\thandlerQueue = jQuery.event.handlers.call( this, event, handlers );\n\n\t\t// Run delegates first; they may want to stop propagation beneath us\n\t\ti = 0;\n\t\twhile ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) {\n\t\t\tevent.currentTarget = matched.elem;\n\n\t\t\tj = 0;\n\t\t\twhile ( ( handleObj = matched.handlers[ j++ ] ) &&\n\t\t\t\t!event.isImmediatePropagationStopped() ) {\n\n\t\t\t\t// If the event is namespaced, then each handler is only invoked if it is\n\t\t\t\t// specially universal or its namespaces are a superset of the event's.\n\t\t\t\tif ( !event.rnamespace || handleObj.namespace === false ||\n\t\t\t\t\tevent.rnamespace.test( handleObj.namespace ) ) {\n\n\t\t\t\t\tevent.handleObj = handleObj;\n\t\t\t\t\tevent.data = handleObj.data;\n\n\t\t\t\t\tret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle ||\n\t\t\t\t\t\thandleObj.handler ).apply( matched.elem, args );\n\n\t\t\t\t\tif ( ret !== undefined ) {\n\t\t\t\t\t\tif ( ( event.result = ret ) === false ) {\n\t\t\t\t\t\t\tevent.preventDefault();\n\t\t\t\t\t\t\tevent.stopPropagation();\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\t// Call the postDispatch hook for the mapped type\n\t\tif ( special.postDispatch ) {\n\t\t\tspecial.postDispatch.call( this, event );\n\t\t}\n\n\t\treturn event.result;\n\t},\n\n\thandlers: function( event, handlers ) {\n\t\tvar i, handleObj, sel, matchedHandlers, matchedSelectors,\n\t\t\thandlerQueue = [],\n\t\t\tdelegateCount = handlers.delegateCount,\n\t\t\tcur = event.target;\n\n\t\t// Find delegate handlers\n\t\tif ( delegateCount &&\n\n\t\t\t// Support: IE <=9\n\t\t\t// Black-hole SVG instance trees (trac-13180)\n\t\t\tcur.nodeType &&\n\n\t\t\t// Support: Firefox <=42\n\t\t\t// Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861)\n\t\t\t// https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click\n\t\t\t// Support: IE 11 only\n\t\t\t// ...but not arrow key \"clicks\" of radio inputs, which can have `button` -1 (gh-2343)\n\t\t\t!( event.type === \"click\" && event.button >= 1 ) ) {\n\n\t\t\tfor ( ; cur !== this; cur = cur.parentNode || this ) {\n\n\t\t\t\t// Don't check non-elements (#13208)\n\t\t\t\t// Don't process clicks on disabled elements (#6911, #8165, #11382, #11764)\n\t\t\t\tif ( cur.nodeType === 1 && !( event.type === \"click\" && cur.disabled === true ) ) {\n\t\t\t\t\tmatchedHandlers = [];\n\t\t\t\t\tmatchedSelectors = {};\n\t\t\t\t\tfor ( i = 0; i < delegateCount; i++ ) {\n\t\t\t\t\t\thandleObj = handlers[ i ];\n\n\t\t\t\t\t\t// Don't conflict with Object.prototype properties (#13203)\n\t\t\t\t\t\tsel = handleObj.selector + \" \";\n\n\t\t\t\t\t\tif ( matchedSelectors[ sel ] === undefined ) {\n\t\t\t\t\t\t\tmatchedSelectors[ sel ] = handleObj.needsContext ?\n\t\t\t\t\t\t\t\tjQuery( sel, this ).index( cur ) > -1 :\n\t\t\t\t\t\t\t\tjQuery.find( sel, this, null, [ cur ] ).length;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif ( matchedSelectors[ sel ] ) {\n\t\t\t\t\t\t\tmatchedHandlers.push( handleObj );\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tif ( matchedHandlers.length ) {\n\t\t\t\t\t\thandlerQueue.push( { elem: cur, handlers: matchedHandlers } );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\t// Add the remaining (directly-bound) handlers\n\t\tcur = this;\n\t\tif ( delegateCount < handlers.length ) {\n\t\t\thandlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } );\n\t\t}\n\n\t\treturn handlerQueue;\n\t},\n\n\taddProp: function( name, hook ) {\n\t\tObject.defineProperty( jQuery.Event.prototype, name, {\n\t\t\tenumerable: true,\n\t\t\tconfigurable: true,\n\n\t\t\tget: isFunction( hook ) ?\n\t\t\t\tfunction() {\n\t\t\t\t\tif ( this.originalEvent ) {\n\t\t\t\t\t\treturn hook( this.originalEvent );\n\t\t\t\t\t}\n\t\t\t\t} :\n\t\t\t\tfunction() {\n\t\t\t\t\tif ( this.originalEvent ) {\n\t\t\t\t\t\treturn this.originalEvent[ name ];\n\t\t\t\t\t}\n\t\t\t\t},\n\n\t\t\tset: function( value ) {\n\t\t\t\tObject.defineProperty( this, name, {\n\t\t\t\t\tenumerable: true,\n\t\t\t\t\tconfigurable: true,\n\t\t\t\t\twritable: true,\n\t\t\t\t\tvalue: value\n\t\t\t\t} );\n\t\t\t}\n\t\t} );\n\t},\n\n\tfix: function( originalEvent ) {\n\t\treturn originalEvent[ jQuery.expando ] ?\n\t\t\toriginalEvent :\n\t\t\tnew jQuery.Event( originalEvent );\n\t},\n\n\tspecial: {\n\t\tload: {\n\n\t\t\t// Prevent triggered image.load events from bubbling to window.load\n\t\t\tnoBubble: true\n\t\t},\n\t\tclick: {\n\n\t\t\t// Utilize native event to ensure correct state for checkable inputs\n\t\t\tsetup: function( data ) {\n\n\t\t\t\t// For mutual compressibility with _default, replace `this` access with a local var.\n\t\t\t\t// `|| data` is dead code meant only to preserve the variable through minification.\n\t\t\t\tvar el = this || data;\n\n\t\t\t\t// Claim the first handler\n\t\t\t\tif ( rcheckableType.test( el.type ) &&\n\t\t\t\t\tel.click && nodeName( el, \"input\" ) ) {\n\n\t\t\t\t\t// dataPriv.set( el, \"click\", ... )\n\t\t\t\t\tleverageNative( el, \"click\", returnTrue );\n\t\t\t\t}\n\n\t\t\t\t// Return false to allow normal processing in the caller\n\t\t\t\treturn false;\n\t\t\t},\n\t\t\ttrigger: function( data ) {\n\n\t\t\t\t// For mutual compressibility with _default, replace `this` access with a local var.\n\t\t\t\t// `|| data` is dead code meant only to preserve the variable through minification.\n\t\t\t\tvar el = this || data;\n\n\t\t\t\t// Force setup before triggering a click\n\t\t\t\tif ( rcheckableType.test( el.type ) &&\n\t\t\t\t\tel.click && nodeName( el, \"input\" ) ) {\n\n\t\t\t\t\tleverageNative( el, \"click\" );\n\t\t\t\t}\n\n\t\t\t\t// Return non-false to allow normal event-path propagation\n\t\t\t\treturn true;\n\t\t\t},\n\n\t\t\t// For cross-browser consistency, suppress native .click() on links\n\t\t\t// Also prevent it if we're currently inside a leveraged native-event stack\n\t\t\t_default: function( event ) {\n\t\t\t\tvar target = event.target;\n\t\t\t\treturn rcheckableType.test( target.type ) &&\n\t\t\t\t\ttarget.click && nodeName( target, \"input\" ) &&\n\t\t\t\t\tdataPriv.get( target, \"click\" ) ||\n\t\t\t\t\tnodeName( target, \"a\" );\n\t\t\t}\n\t\t},\n\n\t\tbeforeunload: {\n\t\t\tpostDispatch: function( event ) {\n\n\t\t\t\t// Support: Firefox 20+\n\t\t\t\t// Firefox doesn't alert if the returnValue field is not set.\n\t\t\t\tif ( event.result !== undefined && event.originalEvent ) {\n\t\t\t\t\tevent.originalEvent.returnValue = event.result;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n};\n\n// Ensure the presence of an event listener that handles manually-triggered\n// synthetic events by interrupting progress until reinvoked in response to\n// *native* events that it fires directly, ensuring that state changes have\n// already occurred before other listeners are invoked.\nfunction leverageNative( el, type, expectSync ) {\n\n\t// Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add\n\tif ( !expectSync ) {\n\t\tif ( dataPriv.get( el, type ) === undefined ) {\n\t\t\tjQuery.event.add( el, type, returnTrue );\n\t\t}\n\t\treturn;\n\t}\n\n\t// Register the controller as a special universal handler for all event namespaces\n\tdataPriv.set( el, type, false );\n\tjQuery.event.add( el, type, {\n\t\tnamespace: false,\n\t\thandler: function( event ) {\n\t\t\tvar notAsync, result,\n\t\t\t\tsaved = dataPriv.get( this, type );\n\n\t\t\tif ( ( event.isTrigger & 1 ) && this[ type ] ) {\n\n\t\t\t\t// Interrupt processing of the outer synthetic .trigger()ed event\n\t\t\t\t// Saved data should be false in such cases, but might be a leftover capture object\n\t\t\t\t// from an async native handler (gh-4350)\n\t\t\t\tif ( !saved.length ) {\n\n\t\t\t\t\t// Store arguments for use when handling the inner native event\n\t\t\t\t\t// There will always be at least one argument (an event object), so this array\n\t\t\t\t\t// will not be confused with a leftover capture object.\n\t\t\t\t\tsaved = slice.call( arguments );\n\t\t\t\t\tdataPriv.set( this, type, saved );\n\n\t\t\t\t\t// Trigger the native event and capture its result\n\t\t\t\t\t// Support: IE <=9 - 11+\n\t\t\t\t\t// focus() and blur() are asynchronous\n\t\t\t\t\tnotAsync = expectSync( this, type );\n\t\t\t\t\tthis[ type ]();\n\t\t\t\t\tresult = dataPriv.get( this, type );\n\t\t\t\t\tif ( saved !== result || notAsync ) {\n\t\t\t\t\t\tdataPriv.set( this, type, false );\n\t\t\t\t\t} else {\n\t\t\t\t\t\tresult = {};\n\t\t\t\t\t}\n\t\t\t\t\tif ( saved !== result ) {\n\n\t\t\t\t\t\t// Cancel the outer synthetic event\n\t\t\t\t\t\tevent.stopImmediatePropagation();\n\t\t\t\t\t\tevent.preventDefault();\n\n\t\t\t\t\t\t// Support: Chrome 86+\n\t\t\t\t\t\t// In Chrome, if an element having a focusout handler is blurred by\n\t\t\t\t\t\t// clicking outside of it, it invokes the handler synchronously. If\n\t\t\t\t\t\t// that handler calls `.remove()` on the element, the data is cleared,\n\t\t\t\t\t\t// leaving `result` undefined. We need to guard against this.\n\t\t\t\t\t\treturn result && result.value;\n\t\t\t\t\t}\n\n\t\t\t\t// If this is an inner synthetic event for an event with a bubbling surrogate\n\t\t\t\t// (focus or blur), assume that the surrogate already propagated from triggering the\n\t\t\t\t// native event and prevent that from happening again here.\n\t\t\t\t// This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the\n\t\t\t\t// bubbling surrogate propagates *after* the non-bubbling base), but that seems\n\t\t\t\t// less bad than duplication.\n\t\t\t\t} else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) {\n\t\t\t\t\tevent.stopPropagation();\n\t\t\t\t}\n\n\t\t\t// If this is a native event triggered above, everything is now in order\n\t\t\t// Fire an inner synthetic event with the original arguments\n\t\t\t} else if ( saved.length ) {\n\n\t\t\t\t// ...and capture the result\n\t\t\t\tdataPriv.set( this, type, {\n\t\t\t\t\tvalue: jQuery.event.trigger(\n\n\t\t\t\t\t\t// Support: IE <=9 - 11+\n\t\t\t\t\t\t// Extend with the prototype to reset the above stopImmediatePropagation()\n\t\t\t\t\t\tjQuery.extend( saved[ 0 ], jQuery.Event.prototype ),\n\t\t\t\t\t\tsaved.slice( 1 ),\n\t\t\t\t\t\tthis\n\t\t\t\t\t)\n\t\t\t\t} );\n\n\t\t\t\t// Abort handling of the native event\n\t\t\t\tevent.stopImmediatePropagation();\n\t\t\t}\n\t\t}\n\t} );\n}\n\njQuery.removeEvent = function( elem, type, handle ) {\n\n\t// This \"if\" is needed for plain objects\n\tif ( elem.removeEventListener ) {\n\t\telem.removeEventListener( type, handle );\n\t}\n};\n\njQuery.Event = function( src, props ) {\n\n\t// Allow instantiation without the 'new' keyword\n\tif ( !( this instanceof jQuery.Event ) ) {\n\t\treturn new jQuery.Event( src, props );\n\t}\n\n\t// Event object\n\tif ( src && src.type ) {\n\t\tthis.originalEvent = src;\n\t\tthis.type = src.type;\n\n\t\t// Events bubbling up the document may have been marked as prevented\n\t\t// by a handler lower down the tree; reflect the correct value.\n\t\tthis.isDefaultPrevented = src.defaultPrevented ||\n\t\t\t\tsrc.defaultPrevented === undefined &&\n\n\t\t\t\t// Support: Android <=2.3 only\n\t\t\t\tsrc.returnValue === false ?\n\t\t\treturnTrue :\n\t\t\treturnFalse;\n\n\t\t// Create target properties\n\t\t// Support: Safari <=6 - 7 only\n\t\t// Target should not be a text node (#504, #13143)\n\t\tthis.target = ( src.target && src.target.nodeType === 3 ) ?\n\t\t\tsrc.target.parentNode :\n\t\t\tsrc.target;\n\n\t\tthis.currentTarget = src.currentTarget;\n\t\tthis.relatedTarget = src.relatedTarget;\n\n\t// Event type\n\t} else {\n\t\tthis.type = src;\n\t}\n\n\t// Put explicitly provided properties onto the event object\n\tif ( props ) {\n\t\tjQuery.extend( this, props );\n\t}\n\n\t// Create a timestamp if incoming event doesn't have one\n\tthis.timeStamp = src && src.timeStamp || Date.now();\n\n\t// Mark it as fixed\n\tthis[ jQuery.expando ] = true;\n};\n\n// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding\n// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html\njQuery.Event.prototype = {\n\tconstructor: jQuery.Event,\n\tisDefaultPrevented: returnFalse,\n\tisPropagationStopped: returnFalse,\n\tisImmediatePropagationStopped: returnFalse,\n\tisSimulated: false,\n\n\tpreventDefault: function() {\n\t\tvar e = this.originalEvent;\n\n\t\tthis.isDefaultPrevented = returnTrue;\n\n\t\tif ( e && !this.isSimulated ) {\n\t\t\te.preventDefault();\n\t\t}\n\t},\n\tstopPropagation: function() {\n\t\tvar e = this.originalEvent;\n\n\t\tthis.isPropagationStopped = returnTrue;\n\n\t\tif ( e && !this.isSimulated ) {\n\t\t\te.stopPropagation();\n\t\t}\n\t},\n\tstopImmediatePropagation: function() {\n\t\tvar e = this.originalEvent;\n\n\t\tthis.isImmediatePropagationStopped = returnTrue;\n\n\t\tif ( e && !this.isSimulated ) {\n\t\t\te.stopImmediatePropagation();\n\t\t}\n\n\t\tthis.stopPropagation();\n\t}\n};\n\n// Includes all common event props including KeyEvent and MouseEvent specific props\njQuery.each( {\n\taltKey: true,\n\tbubbles: true,\n\tcancelable: true,\n\tchangedTouches: true,\n\tctrlKey: true,\n\tdetail: true,\n\teventPhase: true,\n\tmetaKey: true,\n\tpageX: true,\n\tpageY: true,\n\tshiftKey: true,\n\tview: true,\n\t\"char\": true,\n\tcode: true,\n\tcharCode: true,\n\tkey: true,\n\tkeyCode: true,\n\tbutton: true,\n\tbuttons: true,\n\tclientX: true,\n\tclientY: true,\n\toffsetX: true,\n\toffsetY: true,\n\tpointerId: true,\n\tpointerType: true,\n\tscreenX: true,\n\tscreenY: true,\n\ttargetTouches: true,\n\ttoElement: true,\n\ttouches: true,\n\twhich: true\n}, jQuery.event.addProp );\n\njQuery.each( { focus: \"focusin\", blur: \"focusout\" }, function( type, delegateType ) {\n\tjQuery.event.special[ type ] = {\n\n\t\t// Utilize native event if possible so blur/focus sequence is correct\n\t\tsetup: function() {\n\n\t\t\t// Claim the first handler\n\t\t\t// dataPriv.set( this, \"focus\", ... )\n\t\t\t// dataPriv.set( this, \"blur\", ... )\n\t\t\tleverageNative( this, type, expectSync );\n\n\t\t\t// Return false to allow normal processing in the caller\n\t\t\treturn false;\n\t\t},\n\t\ttrigger: function() {\n\n\t\t\t// Force setup before trigger\n\t\t\tleverageNative( this, type );\n\n\t\t\t// Return non-false to allow normal event-path propagation\n\t\t\treturn true;\n\t\t},\n\n\t\t// Suppress native focus or blur as it's already being fired\n\t\t// in leverageNative.\n\t\t_default: function() {\n\t\t\treturn true;\n\t\t},\n\n\t\tdelegateType: delegateType\n\t};\n} );\n\n// Create mouseenter/leave events using mouseover/out and event-time checks\n// so that event delegation works in jQuery.\n// Do the same for pointerenter/pointerleave and pointerover/pointerout\n//\n// Support: Safari 7 only\n// Safari sends mouseenter too often; see:\n// https://bugs.chromium.org/p/chromium/issues/detail?id=470258\n// for the description of the bug (it existed in older Chrome versions as well).\njQuery.each( {\n\tmouseenter: \"mouseover\",\n\tmouseleave: \"mouseout\",\n\tpointerenter: \"pointerover\",\n\tpointerleave: \"pointerout\"\n}, function( orig, fix ) {\n\tjQuery.event.special[ orig ] = {\n\t\tdelegateType: fix,\n\t\tbindType: fix,\n\n\t\thandle: function( event ) {\n\t\t\tvar ret,\n\t\t\t\ttarget = this,\n\t\t\t\trelated = event.relatedTarget,\n\t\t\t\thandleObj = event.handleObj;\n\n\t\t\t// For mouseenter/leave call the handler if related is outside the target.\n\t\t\t// NB: No relatedTarget if the mouse left/entered the browser window\n\t\t\tif ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) {\n\t\t\t\tevent.type = handleObj.origType;\n\t\t\t\tret = handleObj.handler.apply( this, arguments );\n\t\t\t\tevent.type = fix;\n\t\t\t}\n\t\t\treturn ret;\n\t\t}\n\t};\n} );\n\njQuery.fn.extend( {\n\n\ton: function( types, selector, data, fn ) {\n\t\treturn on( this, types, selector, data, fn );\n\t},\n\tone: function( types, selector, data, fn ) {\n\t\treturn on( this, types, selector, data, fn, 1 );\n\t},\n\toff: function( types, selector, fn ) {\n\t\tvar handleObj, type;\n\t\tif ( types && types.preventDefault && types.handleObj ) {\n\n\t\t\t// ( event ) dispatched jQuery.Event\n\t\t\thandleObj = types.handleObj;\n\t\t\tjQuery( types.delegateTarget ).off(\n\t\t\t\thandleObj.namespace ?\n\t\t\t\t\thandleObj.origType + \".\" + handleObj.namespace :\n\t\t\t\t\thandleObj.origType,\n\t\t\t\thandleObj.selector,\n\t\t\t\thandleObj.handler\n\t\t\t);\n\t\t\treturn this;\n\t\t}\n\t\tif ( typeof types === \"object\" ) {\n\n\t\t\t// ( types-object [, selector] )\n\t\t\tfor ( type in types ) {\n\t\t\t\tthis.off( type, selector, types[ type ] );\n\t\t\t}\n\t\t\treturn this;\n\t\t}\n\t\tif ( selector === false || typeof selector === \"function\" ) {\n\n\t\t\t// ( types [, fn] )\n\t\t\tfn = selector;\n\t\t\tselector = undefined;\n\t\t}\n\t\tif ( fn === false ) {\n\t\t\tfn = returnFalse;\n\t\t}\n\t\treturn this.each( function() {\n\t\t\tjQuery.event.remove( this, types, fn, selector );\n\t\t} );\n\t}\n} );\n\n\nvar\n\n\t// Support: IE <=10 - 11, Edge 12 - 13 only\n\t// In IE/Edge using regex groups here causes severe slowdowns.\n\t// See https://connect.microsoft.com/IE/feedback/details/1736512/\n\trnoInnerhtml = /\\s*$/g;\n\n// Prefer a tbody over its parent table for containing new rows\nfunction manipulationTarget( elem, content ) {\n\tif ( nodeName( elem, \"table\" ) &&\n\t\tnodeName( content.nodeType !== 11 ? content : content.firstChild, \"tr\" ) ) {\n\n\t\treturn jQuery( elem ).children( \"tbody\" )[ 0 ] || elem;\n\t}\n\n\treturn elem;\n}\n\n// Replace/restore the type attribute of script elements for safe DOM manipulation\nfunction disableScript( elem ) {\n\telem.type = ( elem.getAttribute( \"type\" ) !== null ) + \"/\" + elem.type;\n\treturn elem;\n}\nfunction restoreScript( elem ) {\n\tif ( ( elem.type || \"\" ).slice( 0, 5 ) === \"true/\" ) {\n\t\telem.type = elem.type.slice( 5 );\n\t} else {\n\t\telem.removeAttribute( \"type\" );\n\t}\n\n\treturn elem;\n}\n\nfunction cloneCopyEvent( src, dest ) {\n\tvar i, l, type, pdataOld, udataOld, udataCur, events;\n\n\tif ( dest.nodeType !== 1 ) {\n\t\treturn;\n\t}\n\n\t// 1. Copy private data: events, handlers, etc.\n\tif ( dataPriv.hasData( src ) ) {\n\t\tpdataOld = dataPriv.get( src );\n\t\tevents = pdataOld.events;\n\n\t\tif ( events ) {\n\t\t\tdataPriv.remove( dest, \"handle events\" );\n\n\t\t\tfor ( type in events ) {\n\t\t\t\tfor ( i = 0, l = events[ type ].length; i < l; i++ ) {\n\t\t\t\t\tjQuery.event.add( dest, type, events[ type ][ i ] );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t// 2. Copy user data\n\tif ( dataUser.hasData( src ) ) {\n\t\tudataOld = dataUser.access( src );\n\t\tudataCur = jQuery.extend( {}, udataOld );\n\n\t\tdataUser.set( dest, udataCur );\n\t}\n}\n\n// Fix IE bugs, see support tests\nfunction fixInput( src, dest ) {\n\tvar nodeName = dest.nodeName.toLowerCase();\n\n\t// Fails to persist the checked state of a cloned checkbox or radio button.\n\tif ( nodeName === \"input\" && rcheckableType.test( src.type ) ) {\n\t\tdest.checked = src.checked;\n\n\t// Fails to return the selected option to the default selected state when cloning options\n\t} else if ( nodeName === \"input\" || nodeName === \"textarea\" ) {\n\t\tdest.defaultValue = src.defaultValue;\n\t}\n}\n\nfunction domManip( collection, args, callback, ignored ) {\n\n\t// Flatten any nested arrays\n\targs = flat( args );\n\n\tvar fragment, first, scripts, hasScripts, node, doc,\n\t\ti = 0,\n\t\tl = collection.length,\n\t\tiNoClone = l - 1,\n\t\tvalue = args[ 0 ],\n\t\tvalueIsFunction = isFunction( value );\n\n\t// We can't cloneNode fragments that contain checked, in WebKit\n\tif ( valueIsFunction ||\n\t\t\t( l > 1 && typeof value === \"string\" &&\n\t\t\t\t!support.checkClone && rchecked.test( value ) ) ) {\n\t\treturn collection.each( function( index ) {\n\t\t\tvar self = collection.eq( index );\n\t\t\tif ( valueIsFunction ) {\n\t\t\t\targs[ 0 ] = value.call( this, index, self.html() );\n\t\t\t}\n\t\t\tdomManip( self, args, callback, ignored );\n\t\t} );\n\t}\n\n\tif ( l ) {\n\t\tfragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored );\n\t\tfirst = fragment.firstChild;\n\n\t\tif ( fragment.childNodes.length === 1 ) {\n\t\t\tfragment = first;\n\t\t}\n\n\t\t// Require either new content or an interest in ignored elements to invoke the callback\n\t\tif ( first || ignored ) {\n\t\t\tscripts = jQuery.map( getAll( fragment, \"script\" ), disableScript );\n\t\t\thasScripts = scripts.length;\n\n\t\t\t// Use the original fragment for the last item\n\t\t\t// instead of the first because it can end up\n\t\t\t// being emptied incorrectly in certain situations (#8070).\n\t\t\tfor ( ; i < l; i++ ) {\n\t\t\t\tnode = fragment;\n\n\t\t\t\tif ( i !== iNoClone ) {\n\t\t\t\t\tnode = jQuery.clone( node, true, true );\n\n\t\t\t\t\t// Keep references to cloned scripts for later restoration\n\t\t\t\t\tif ( hasScripts ) {\n\n\t\t\t\t\t\t// Support: Android <=4.0 only, PhantomJS 1 only\n\t\t\t\t\t\t// push.apply(_, arraylike) throws on ancient WebKit\n\t\t\t\t\t\tjQuery.merge( scripts, getAll( node, \"script\" ) );\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tcallback.call( collection[ i ], node, i );\n\t\t\t}\n\n\t\t\tif ( hasScripts ) {\n\t\t\t\tdoc = scripts[ scripts.length - 1 ].ownerDocument;\n\n\t\t\t\t// Reenable scripts\n\t\t\t\tjQuery.map( scripts, restoreScript );\n\n\t\t\t\t// Evaluate executable scripts on first document insertion\n\t\t\t\tfor ( i = 0; i < hasScripts; i++ ) {\n\t\t\t\t\tnode = scripts[ i ];\n\t\t\t\t\tif ( rscriptType.test( node.type || \"\" ) &&\n\t\t\t\t\t\t!dataPriv.access( node, \"globalEval\" ) &&\n\t\t\t\t\t\tjQuery.contains( doc, node ) ) {\n\n\t\t\t\t\t\tif ( node.src && ( node.type || \"\" ).toLowerCase() !== \"module\" ) {\n\n\t\t\t\t\t\t\t// Optional AJAX dependency, but won't run scripts if not present\n\t\t\t\t\t\t\tif ( jQuery._evalUrl && !node.noModule ) {\n\t\t\t\t\t\t\t\tjQuery._evalUrl( node.src, {\n\t\t\t\t\t\t\t\t\tnonce: node.nonce || node.getAttribute( \"nonce\" )\n\t\t\t\t\t\t\t\t}, doc );\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tDOMEval( node.textContent.replace( rcleanScript, \"\" ), node, doc );\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\treturn collection;\n}\n\nfunction remove( elem, selector, keepData ) {\n\tvar node,\n\t\tnodes = selector ? jQuery.filter( selector, elem ) : elem,\n\t\ti = 0;\n\n\tfor ( ; ( node = nodes[ i ] ) != null; i++ ) {\n\t\tif ( !keepData && node.nodeType === 1 ) {\n\t\t\tjQuery.cleanData( getAll( node ) );\n\t\t}\n\n\t\tif ( node.parentNode ) {\n\t\t\tif ( keepData && isAttached( node ) ) {\n\t\t\t\tsetGlobalEval( getAll( node, \"script\" ) );\n\t\t\t}\n\t\t\tnode.parentNode.removeChild( node );\n\t\t}\n\t}\n\n\treturn elem;\n}\n\njQuery.extend( {\n\thtmlPrefilter: function( html ) {\n\t\treturn html;\n\t},\n\n\tclone: function( elem, dataAndEvents, deepDataAndEvents ) {\n\t\tvar i, l, srcElements, destElements,\n\t\t\tclone = elem.cloneNode( true ),\n\t\t\tinPage = isAttached( elem );\n\n\t\t// Fix IE cloning issues\n\t\tif ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) &&\n\t\t\t\t!jQuery.isXMLDoc( elem ) ) {\n\n\t\t\t// We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2\n\t\t\tdestElements = getAll( clone );\n\t\t\tsrcElements = getAll( elem );\n\n\t\t\tfor ( i = 0, l = srcElements.length; i < l; i++ ) {\n\t\t\t\tfixInput( srcElements[ i ], destElements[ i ] );\n\t\t\t}\n\t\t}\n\n\t\t// Copy the events from the original to the clone\n\t\tif ( dataAndEvents ) {\n\t\t\tif ( deepDataAndEvents ) {\n\t\t\t\tsrcElements = srcElements || getAll( elem );\n\t\t\t\tdestElements = destElements || getAll( clone );\n\n\t\t\t\tfor ( i = 0, l = srcElements.length; i < l; i++ ) {\n\t\t\t\t\tcloneCopyEvent( srcElements[ i ], destElements[ i ] );\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tcloneCopyEvent( elem, clone );\n\t\t\t}\n\t\t}\n\n\t\t// Preserve script evaluation history\n\t\tdestElements = getAll( clone, \"script\" );\n\t\tif ( destElements.length > 0 ) {\n\t\t\tsetGlobalEval( destElements, !inPage && getAll( elem, \"script\" ) );\n\t\t}\n\n\t\t// Return the cloned set\n\t\treturn clone;\n\t},\n\n\tcleanData: function( elems ) {\n\t\tvar data, elem, type,\n\t\t\tspecial = jQuery.event.special,\n\t\t\ti = 0;\n\n\t\tfor ( ; ( elem = elems[ i ] ) !== undefined; i++ ) {\n\t\t\tif ( acceptData( elem ) ) {\n\t\t\t\tif ( ( data = elem[ dataPriv.expando ] ) ) {\n\t\t\t\t\tif ( data.events ) {\n\t\t\t\t\t\tfor ( type in data.events ) {\n\t\t\t\t\t\t\tif ( special[ type ] ) {\n\t\t\t\t\t\t\t\tjQuery.event.remove( elem, type );\n\n\t\t\t\t\t\t\t// This is a shortcut to avoid jQuery.event.remove's overhead\n\t\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\t\tjQuery.removeEvent( elem, type, data.handle );\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\t// Support: Chrome <=35 - 45+\n\t\t\t\t\t// Assign undefined instead of using delete, see Data#remove\n\t\t\t\t\telem[ dataPriv.expando ] = undefined;\n\t\t\t\t}\n\t\t\t\tif ( elem[ dataUser.expando ] ) {\n\n\t\t\t\t\t// Support: Chrome <=35 - 45+\n\t\t\t\t\t// Assign undefined instead of using delete, see Data#remove\n\t\t\t\t\telem[ dataUser.expando ] = undefined;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n} );\n\njQuery.fn.extend( {\n\tdetach: function( selector ) {\n\t\treturn remove( this, selector, true );\n\t},\n\n\tremove: function( selector ) {\n\t\treturn remove( this, selector );\n\t},\n\n\ttext: function( value ) {\n\t\treturn access( this, function( value ) {\n\t\t\treturn value === undefined ?\n\t\t\t\tjQuery.text( this ) :\n\t\t\t\tthis.empty().each( function() {\n\t\t\t\t\tif ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {\n\t\t\t\t\t\tthis.textContent = value;\n\t\t\t\t\t}\n\t\t\t\t} );\n\t\t}, null, value, arguments.length );\n\t},\n\n\tappend: function() {\n\t\treturn domManip( this, arguments, function( elem ) {\n\t\t\tif ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {\n\t\t\t\tvar target = manipulationTarget( this, elem );\n\t\t\t\ttarget.appendChild( elem );\n\t\t\t}\n\t\t} );\n\t},\n\n\tprepend: function() {\n\t\treturn domManip( this, arguments, function( elem ) {\n\t\t\tif ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {\n\t\t\t\tvar target = manipulationTarget( this, elem );\n\t\t\t\ttarget.insertBefore( elem, target.firstChild );\n\t\t\t}\n\t\t} );\n\t},\n\n\tbefore: function() {\n\t\treturn domManip( this, arguments, function( elem ) {\n\t\t\tif ( this.parentNode ) {\n\t\t\t\tthis.parentNode.insertBefore( elem, this );\n\t\t\t}\n\t\t} );\n\t},\n\n\tafter: function() {\n\t\treturn domManip( this, arguments, function( elem ) {\n\t\t\tif ( this.parentNode ) {\n\t\t\t\tthis.parentNode.insertBefore( elem, this.nextSibling );\n\t\t\t}\n\t\t} );\n\t},\n\n\tempty: function() {\n\t\tvar elem,\n\t\t\ti = 0;\n\n\t\tfor ( ; ( elem = this[ i ] ) != null; i++ ) {\n\t\t\tif ( elem.nodeType === 1 ) {\n\n\t\t\t\t// Prevent memory leaks\n\t\t\t\tjQuery.cleanData( getAll( elem, false ) );\n\n\t\t\t\t// Remove any remaining nodes\n\t\t\t\telem.textContent = \"\";\n\t\t\t}\n\t\t}\n\n\t\treturn this;\n\t},\n\n\tclone: function( dataAndEvents, deepDataAndEvents ) {\n\t\tdataAndEvents = dataAndEvents == null ? false : dataAndEvents;\n\t\tdeepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents;\n\n\t\treturn this.map( function() {\n\t\t\treturn jQuery.clone( this, dataAndEvents, deepDataAndEvents );\n\t\t} );\n\t},\n\n\thtml: function( value ) {\n\t\treturn access( this, function( value ) {\n\t\t\tvar elem = this[ 0 ] || {},\n\t\t\t\ti = 0,\n\t\t\t\tl = this.length;\n\n\t\t\tif ( value === undefined && elem.nodeType === 1 ) {\n\t\t\t\treturn elem.innerHTML;\n\t\t\t}\n\n\t\t\t// See if we can take a shortcut and just use innerHTML\n\t\t\tif ( typeof value === \"string\" && !rnoInnerhtml.test( value ) &&\n\t\t\t\t!wrapMap[ ( rtagName.exec( value ) || [ \"\", \"\" ] )[ 1 ].toLowerCase() ] ) {\n\n\t\t\t\tvalue = jQuery.htmlPrefilter( value );\n\n\t\t\t\ttry {\n\t\t\t\t\tfor ( ; i < l; i++ ) {\n\t\t\t\t\t\telem = this[ i ] || {};\n\n\t\t\t\t\t\t// Remove element nodes and prevent memory leaks\n\t\t\t\t\t\tif ( elem.nodeType === 1 ) {\n\t\t\t\t\t\t\tjQuery.cleanData( getAll( elem, false ) );\n\t\t\t\t\t\t\telem.innerHTML = value;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\telem = 0;\n\n\t\t\t\t// If using innerHTML throws an exception, use the fallback method\n\t\t\t\t} catch ( e ) {}\n\t\t\t}\n\n\t\t\tif ( elem ) {\n\t\t\t\tthis.empty().append( value );\n\t\t\t}\n\t\t}, null, value, arguments.length );\n\t},\n\n\treplaceWith: function() {\n\t\tvar ignored = [];\n\n\t\t// Make the changes, replacing each non-ignored context element with the new content\n\t\treturn domManip( this, arguments, function( elem ) {\n\t\t\tvar parent = this.parentNode;\n\n\t\t\tif ( jQuery.inArray( this, ignored ) < 0 ) {\n\t\t\t\tjQuery.cleanData( getAll( this ) );\n\t\t\t\tif ( parent ) {\n\t\t\t\t\tparent.replaceChild( elem, this );\n\t\t\t\t}\n\t\t\t}\n\n\t\t// Force callback invocation\n\t\t}, ignored );\n\t}\n} );\n\njQuery.each( {\n\tappendTo: \"append\",\n\tprependTo: \"prepend\",\n\tinsertBefore: \"before\",\n\tinsertAfter: \"after\",\n\treplaceAll: \"replaceWith\"\n}, function( name, original ) {\n\tjQuery.fn[ name ] = function( selector ) {\n\t\tvar elems,\n\t\t\tret = [],\n\t\t\tinsert = jQuery( selector ),\n\t\t\tlast = insert.length - 1,\n\t\t\ti = 0;\n\n\t\tfor ( ; i <= last; i++ ) {\n\t\t\telems = i === last ? this : this.clone( true );\n\t\t\tjQuery( insert[ i ] )[ original ]( elems );\n\n\t\t\t// Support: Android <=4.0 only, PhantomJS 1 only\n\t\t\t// .get() because push.apply(_, arraylike) throws on ancient WebKit\n\t\t\tpush.apply( ret, elems.get() );\n\t\t}\n\n\t\treturn this.pushStack( ret );\n\t};\n} );\nvar rnumnonpx = new RegExp( \"^(\" + pnum + \")(?!px)[a-z%]+$\", \"i\" );\n\nvar getStyles = function( elem ) {\n\n\t\t// Support: IE <=11 only, Firefox <=30 (#15098, #14150)\n\t\t// IE throws on elements created in popups\n\t\t// FF meanwhile throws on frame elements through \"defaultView.getComputedStyle\"\n\t\tvar view = elem.ownerDocument.defaultView;\n\n\t\tif ( !view || !view.opener ) {\n\t\t\tview = window;\n\t\t}\n\n\t\treturn view.getComputedStyle( elem );\n\t};\n\nvar swap = function( elem, options, callback ) {\n\tvar ret, name,\n\t\told = {};\n\n\t// Remember the old values, and insert the new ones\n\tfor ( name in options ) {\n\t\told[ name ] = elem.style[ name ];\n\t\telem.style[ name ] = options[ name ];\n\t}\n\n\tret = callback.call( elem );\n\n\t// Revert the old values\n\tfor ( name in options ) {\n\t\telem.style[ name ] = old[ name ];\n\t}\n\n\treturn ret;\n};\n\n\nvar rboxStyle = new RegExp( cssExpand.join( \"|\" ), \"i\" );\n\n\n\n( function() {\n\n\t// Executing both pixelPosition & boxSizingReliable tests require only one layout\n\t// so they're executed at the same time to save the second computation.\n\tfunction computeStyleTests() {\n\n\t\t// This is a singleton, we need to execute it only once\n\t\tif ( !div ) {\n\t\t\treturn;\n\t\t}\n\n\t\tcontainer.style.cssText = \"position:absolute;left:-11111px;width:60px;\" +\n\t\t\t\"margin-top:1px;padding:0;border:0\";\n\t\tdiv.style.cssText =\n\t\t\t\"position:relative;display:block;box-sizing:border-box;overflow:scroll;\" +\n\t\t\t\"margin:auto;border:1px;padding:1px;\" +\n\t\t\t\"width:60%;top:1%\";\n\t\tdocumentElement.appendChild( container ).appendChild( div );\n\n\t\tvar divStyle = window.getComputedStyle( div );\n\t\tpixelPositionVal = divStyle.top !== \"1%\";\n\n\t\t// Support: Android 4.0 - 4.3 only, Firefox <=3 - 44\n\t\treliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12;\n\n\t\t// Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3\n\t\t// Some styles come back with percentage values, even though they shouldn't\n\t\tdiv.style.right = \"60%\";\n\t\tpixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36;\n\n\t\t// Support: IE 9 - 11 only\n\t\t// Detect misreporting of content dimensions for box-sizing:border-box elements\n\t\tboxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36;\n\n\t\t// Support: IE 9 only\n\t\t// Detect overflow:scroll screwiness (gh-3699)\n\t\t// Support: Chrome <=64\n\t\t// Don't get tricked when zoom affects offsetWidth (gh-4029)\n\t\tdiv.style.position = \"absolute\";\n\t\tscrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12;\n\n\t\tdocumentElement.removeChild( container );\n\n\t\t// Nullify the div so it wouldn't be stored in the memory and\n\t\t// it will also be a sign that checks already performed\n\t\tdiv = null;\n\t}\n\n\tfunction roundPixelMeasures( measure ) {\n\t\treturn Math.round( parseFloat( measure ) );\n\t}\n\n\tvar pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal,\n\t\treliableTrDimensionsVal, reliableMarginLeftVal,\n\t\tcontainer = document.createElement( \"div\" ),\n\t\tdiv = document.createElement( \"div\" );\n\n\t// Finish early in limited (non-browser) environments\n\tif ( !div.style ) {\n\t\treturn;\n\t}\n\n\t// Support: IE <=9 - 11 only\n\t// Style of cloned element affects source element cloned (#8908)\n\tdiv.style.backgroundClip = \"content-box\";\n\tdiv.cloneNode( true ).style.backgroundClip = \"\";\n\tsupport.clearCloneStyle = div.style.backgroundClip === \"content-box\";\n\n\tjQuery.extend( support, {\n\t\tboxSizingReliable: function() {\n\t\t\tcomputeStyleTests();\n\t\t\treturn boxSizingReliableVal;\n\t\t},\n\t\tpixelBoxStyles: function() {\n\t\t\tcomputeStyleTests();\n\t\t\treturn pixelBoxStylesVal;\n\t\t},\n\t\tpixelPosition: function() {\n\t\t\tcomputeStyleTests();\n\t\t\treturn pixelPositionVal;\n\t\t},\n\t\treliableMarginLeft: function() {\n\t\t\tcomputeStyleTests();\n\t\t\treturn reliableMarginLeftVal;\n\t\t},\n\t\tscrollboxSize: function() {\n\t\t\tcomputeStyleTests();\n\t\t\treturn scrollboxSizeVal;\n\t\t},\n\n\t\t// Support: IE 9 - 11+, Edge 15 - 18+\n\t\t// IE/Edge misreport `getComputedStyle` of table rows with width/height\n\t\t// set in CSS while `offset*` properties report correct values.\n\t\t// Behavior in IE 9 is more subtle than in newer versions & it passes\n\t\t// some versions of this test; make sure not to make it pass there!\n\t\t//\n\t\t// Support: Firefox 70+\n\t\t// Only Firefox includes border widths\n\t\t// in computed dimensions. (gh-4529)\n\t\treliableTrDimensions: function() {\n\t\t\tvar table, tr, trChild, trStyle;\n\t\t\tif ( reliableTrDimensionsVal == null ) {\n\t\t\t\ttable = document.createElement( \"table\" );\n\t\t\t\ttr = document.createElement( \"tr\" );\n\t\t\t\ttrChild = document.createElement( \"div\" );\n\n\t\t\t\ttable.style.cssText = \"position:absolute;left:-11111px;border-collapse:separate\";\n\t\t\t\ttr.style.cssText = \"border:1px solid\";\n\n\t\t\t\t// Support: Chrome 86+\n\t\t\t\t// Height set through cssText does not get applied.\n\t\t\t\t// Computed height then comes back as 0.\n\t\t\t\ttr.style.height = \"1px\";\n\t\t\t\ttrChild.style.height = \"9px\";\n\n\t\t\t\t// Support: Android 8 Chrome 86+\n\t\t\t\t// In our bodyBackground.html iframe,\n\t\t\t\t// display for all div elements is set to \"inline\",\n\t\t\t\t// which causes a problem only in Android 8 Chrome 86.\n\t\t\t\t// Ensuring the div is display: block\n\t\t\t\t// gets around this issue.\n\t\t\t\ttrChild.style.display = \"block\";\n\n\t\t\t\tdocumentElement\n\t\t\t\t\t.appendChild( table )\n\t\t\t\t\t.appendChild( tr )\n\t\t\t\t\t.appendChild( trChild );\n\n\t\t\t\ttrStyle = window.getComputedStyle( tr );\n\t\t\t\treliableTrDimensionsVal = ( parseInt( trStyle.height, 10 ) +\n\t\t\t\t\tparseInt( trStyle.borderTopWidth, 10 ) +\n\t\t\t\t\tparseInt( trStyle.borderBottomWidth, 10 ) ) === tr.offsetHeight;\n\n\t\t\t\tdocumentElement.removeChild( table );\n\t\t\t}\n\t\t\treturn reliableTrDimensionsVal;\n\t\t}\n\t} );\n} )();\n\n\nfunction curCSS( elem, name, computed ) {\n\tvar width, minWidth, maxWidth, ret,\n\n\t\t// Support: Firefox 51+\n\t\t// Retrieving style before computed somehow\n\t\t// fixes an issue with getting wrong values\n\t\t// on detached elements\n\t\tstyle = elem.style;\n\n\tcomputed = computed || getStyles( elem );\n\n\t// getPropertyValue is needed for:\n\t// .css('filter') (IE 9 only, #12537)\n\t// .css('--customProperty) (#3144)\n\tif ( computed ) {\n\t\tret = computed.getPropertyValue( name ) || computed[ name ];\n\n\t\tif ( ret === \"\" && !isAttached( elem ) ) {\n\t\t\tret = jQuery.style( elem, name );\n\t\t}\n\n\t\t// A tribute to the \"awesome hack by Dean Edwards\"\n\t\t// Android Browser returns percentage for some values,\n\t\t// but width seems to be reliably pixels.\n\t\t// This is against the CSSOM draft spec:\n\t\t// https://drafts.csswg.org/cssom/#resolved-values\n\t\tif ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) {\n\n\t\t\t// Remember the original values\n\t\t\twidth = style.width;\n\t\t\tminWidth = style.minWidth;\n\t\t\tmaxWidth = style.maxWidth;\n\n\t\t\t// Put in the new values to get a computed value out\n\t\t\tstyle.minWidth = style.maxWidth = style.width = ret;\n\t\t\tret = computed.width;\n\n\t\t\t// Revert the changed values\n\t\t\tstyle.width = width;\n\t\t\tstyle.minWidth = minWidth;\n\t\t\tstyle.maxWidth = maxWidth;\n\t\t}\n\t}\n\n\treturn ret !== undefined ?\n\n\t\t// Support: IE <=9 - 11 only\n\t\t// IE returns zIndex value as an integer.\n\t\tret + \"\" :\n\t\tret;\n}\n\n\nfunction addGetHookIf( conditionFn, hookFn ) {\n\n\t// Define the hook, we'll check on the first run if it's really needed.\n\treturn {\n\t\tget: function() {\n\t\t\tif ( conditionFn() ) {\n\n\t\t\t\t// Hook not needed (or it's not possible to use it due\n\t\t\t\t// to missing dependency), remove it.\n\t\t\t\tdelete this.get;\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\t// Hook needed; redefine it so that the support test is not executed again.\n\t\t\treturn ( this.get = hookFn ).apply( this, arguments );\n\t\t}\n\t};\n}\n\n\nvar cssPrefixes = [ \"Webkit\", \"Moz\", \"ms\" ],\n\temptyStyle = document.createElement( \"div\" ).style,\n\tvendorProps = {};\n\n// Return a vendor-prefixed property or undefined\nfunction vendorPropName( name ) {\n\n\t// Check for vendor prefixed names\n\tvar capName = name[ 0 ].toUpperCase() + name.slice( 1 ),\n\t\ti = cssPrefixes.length;\n\n\twhile ( i-- ) {\n\t\tname = cssPrefixes[ i ] + capName;\n\t\tif ( name in emptyStyle ) {\n\t\t\treturn name;\n\t\t}\n\t}\n}\n\n// Return a potentially-mapped jQuery.cssProps or vendor prefixed property\nfunction finalPropName( name ) {\n\tvar final = jQuery.cssProps[ name ] || vendorProps[ name ];\n\n\tif ( final ) {\n\t\treturn final;\n\t}\n\tif ( name in emptyStyle ) {\n\t\treturn name;\n\t}\n\treturn vendorProps[ name ] = vendorPropName( name ) || name;\n}\n\n\nvar\n\n\t// Swappable if display is none or starts with table\n\t// except \"table\", \"table-cell\", or \"table-caption\"\n\t// See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display\n\trdisplayswap = /^(none|table(?!-c[ea]).+)/,\n\trcustomProp = /^--/,\n\tcssShow = { position: \"absolute\", visibility: \"hidden\", display: \"block\" },\n\tcssNormalTransform = {\n\t\tletterSpacing: \"0\",\n\t\tfontWeight: \"400\"\n\t};\n\nfunction setPositiveNumber( _elem, value, subtract ) {\n\n\t// Any relative (+/-) values have already been\n\t// normalized at this point\n\tvar matches = rcssNum.exec( value );\n\treturn matches ?\n\n\t\t// Guard against undefined \"subtract\", e.g., when used as in cssHooks\n\t\tMath.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || \"px\" ) :\n\t\tvalue;\n}\n\nfunction boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) {\n\tvar i = dimension === \"width\" ? 1 : 0,\n\t\textra = 0,\n\t\tdelta = 0;\n\n\t// Adjustment may not be necessary\n\tif ( box === ( isBorderBox ? \"border\" : \"content\" ) ) {\n\t\treturn 0;\n\t}\n\n\tfor ( ; i < 4; i += 2 ) {\n\n\t\t// Both box models exclude margin\n\t\tif ( box === \"margin\" ) {\n\t\t\tdelta += jQuery.css( elem, box + cssExpand[ i ], true, styles );\n\t\t}\n\n\t\t// If we get here with a content-box, we're seeking \"padding\" or \"border\" or \"margin\"\n\t\tif ( !isBorderBox ) {\n\n\t\t\t// Add padding\n\t\t\tdelta += jQuery.css( elem, \"padding\" + cssExpand[ i ], true, styles );\n\n\t\t\t// For \"border\" or \"margin\", add border\n\t\t\tif ( box !== \"padding\" ) {\n\t\t\t\tdelta += jQuery.css( elem, \"border\" + cssExpand[ i ] + \"Width\", true, styles );\n\n\t\t\t// But still keep track of it otherwise\n\t\t\t} else {\n\t\t\t\textra += jQuery.css( elem, \"border\" + cssExpand[ i ] + \"Width\", true, styles );\n\t\t\t}\n\n\t\t// If we get here with a border-box (content + padding + border), we're seeking \"content\" or\n\t\t// \"padding\" or \"margin\"\n\t\t} else {\n\n\t\t\t// For \"content\", subtract padding\n\t\t\tif ( box === \"content\" ) {\n\t\t\t\tdelta -= jQuery.css( elem, \"padding\" + cssExpand[ i ], true, styles );\n\t\t\t}\n\n\t\t\t// For \"content\" or \"padding\", subtract border\n\t\t\tif ( box !== \"margin\" ) {\n\t\t\t\tdelta -= jQuery.css( elem, \"border\" + cssExpand[ i ] + \"Width\", true, styles );\n\t\t\t}\n\t\t}\n\t}\n\n\t// Account for positive content-box scroll gutter when requested by providing computedVal\n\tif ( !isBorderBox && computedVal >= 0 ) {\n\n\t\t// offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border\n\t\t// Assuming integer scroll gutter, subtract the rest and round down\n\t\tdelta += Math.max( 0, Math.ceil(\n\t\t\telem[ \"offset\" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] -\n\t\t\tcomputedVal -\n\t\t\tdelta -\n\t\t\textra -\n\t\t\t0.5\n\n\t\t// If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter\n\t\t// Use an explicit zero to avoid NaN (gh-3964)\n\t\t) ) || 0;\n\t}\n\n\treturn delta;\n}\n\nfunction getWidthOrHeight( elem, dimension, extra ) {\n\n\t// Start with computed style\n\tvar styles = getStyles( elem ),\n\n\t\t// To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322).\n\t\t// Fake content-box until we know it's needed to know the true value.\n\t\tboxSizingNeeded = !support.boxSizingReliable() || extra,\n\t\tisBorderBox = boxSizingNeeded &&\n\t\t\tjQuery.css( elem, \"boxSizing\", false, styles ) === \"border-box\",\n\t\tvalueIsBorderBox = isBorderBox,\n\n\t\tval = curCSS( elem, dimension, styles ),\n\t\toffsetProp = \"offset\" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 );\n\n\t// Support: Firefox <=54\n\t// Return a confounding non-pixel value or feign ignorance, as appropriate.\n\tif ( rnumnonpx.test( val ) ) {\n\t\tif ( !extra ) {\n\t\t\treturn val;\n\t\t}\n\t\tval = \"auto\";\n\t}\n\n\n\t// Support: IE 9 - 11 only\n\t// Use offsetWidth/offsetHeight for when box sizing is unreliable.\n\t// In those cases, the computed value can be trusted to be border-box.\n\tif ( ( !support.boxSizingReliable() && isBorderBox ||\n\n\t\t// Support: IE 10 - 11+, Edge 15 - 18+\n\t\t// IE/Edge misreport `getComputedStyle` of table rows with width/height\n\t\t// set in CSS while `offset*` properties report correct values.\n\t\t// Interestingly, in some cases IE 9 doesn't suffer from this issue.\n\t\t!support.reliableTrDimensions() && nodeName( elem, \"tr\" ) ||\n\n\t\t// Fall back to offsetWidth/offsetHeight when value is \"auto\"\n\t\t// This happens for inline elements with no explicit setting (gh-3571)\n\t\tval === \"auto\" ||\n\n\t\t// Support: Android <=4.1 - 4.3 only\n\t\t// Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602)\n\t\t!parseFloat( val ) && jQuery.css( elem, \"display\", false, styles ) === \"inline\" ) &&\n\n\t\t// Make sure the element is visible & connected\n\t\telem.getClientRects().length ) {\n\n\t\tisBorderBox = jQuery.css( elem, \"boxSizing\", false, styles ) === \"border-box\";\n\n\t\t// Where available, offsetWidth/offsetHeight approximate border box dimensions.\n\t\t// Where not available (e.g., SVG), assume unreliable box-sizing and interpret the\n\t\t// retrieved value as a content box dimension.\n\t\tvalueIsBorderBox = offsetProp in elem;\n\t\tif ( valueIsBorderBox ) {\n\t\t\tval = elem[ offsetProp ];\n\t\t}\n\t}\n\n\t// Normalize \"\" and auto\n\tval = parseFloat( val ) || 0;\n\n\t// Adjust for the element's box model\n\treturn ( val +\n\t\tboxModelAdjustment(\n\t\t\telem,\n\t\t\tdimension,\n\t\t\textra || ( isBorderBox ? \"border\" : \"content\" ),\n\t\t\tvalueIsBorderBox,\n\t\t\tstyles,\n\n\t\t\t// Provide the current computed size to request scroll gutter calculation (gh-3589)\n\t\t\tval\n\t\t)\n\t) + \"px\";\n}\n\njQuery.extend( {\n\n\t// Add in style property hooks for overriding the default\n\t// behavior of getting and setting a style property\n\tcssHooks: {\n\t\topacity: {\n\t\t\tget: function( elem, computed ) {\n\t\t\t\tif ( computed ) {\n\n\t\t\t\t\t// We should always get a number back from opacity\n\t\t\t\t\tvar ret = curCSS( elem, \"opacity\" );\n\t\t\t\t\treturn ret === \"\" ? \"1\" : ret;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t},\n\n\t// Don't automatically add \"px\" to these possibly-unitless properties\n\tcssNumber: {\n\t\t\"animationIterationCount\": true,\n\t\t\"columnCount\": true,\n\t\t\"fillOpacity\": true,\n\t\t\"flexGrow\": true,\n\t\t\"flexShrink\": true,\n\t\t\"fontWeight\": true,\n\t\t\"gridArea\": true,\n\t\t\"gridColumn\": true,\n\t\t\"gridColumnEnd\": true,\n\t\t\"gridColumnStart\": true,\n\t\t\"gridRow\": true,\n\t\t\"gridRowEnd\": true,\n\t\t\"gridRowStart\": true,\n\t\t\"lineHeight\": true,\n\t\t\"opacity\": true,\n\t\t\"order\": true,\n\t\t\"orphans\": true,\n\t\t\"widows\": true,\n\t\t\"zIndex\": true,\n\t\t\"zoom\": true\n\t},\n\n\t// Add in properties whose names you wish to fix before\n\t// setting or getting the value\n\tcssProps: {},\n\n\t// Get and set the style property on a DOM Node\n\tstyle: function( elem, name, value, extra ) {\n\n\t\t// Don't set styles on text and comment nodes\n\t\tif ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Make sure that we're working with the right name\n\t\tvar ret, type, hooks,\n\t\t\torigName = camelCase( name ),\n\t\t\tisCustomProp = rcustomProp.test( name ),\n\t\t\tstyle = elem.style;\n\n\t\t// Make sure that we're working with the right name. We don't\n\t\t// want to query the value if it is a CSS custom property\n\t\t// since they are user-defined.\n\t\tif ( !isCustomProp ) {\n\t\t\tname = finalPropName( origName );\n\t\t}\n\n\t\t// Gets hook for the prefixed version, then unprefixed version\n\t\thooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ];\n\n\t\t// Check if we're setting a value\n\t\tif ( value !== undefined ) {\n\t\t\ttype = typeof value;\n\n\t\t\t// Convert \"+=\" or \"-=\" to relative numbers (#7345)\n\t\t\tif ( type === \"string\" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) {\n\t\t\t\tvalue = adjustCSS( elem, name, ret );\n\n\t\t\t\t// Fixes bug #9237\n\t\t\t\ttype = \"number\";\n\t\t\t}\n\n\t\t\t// Make sure that null and NaN values aren't set (#7116)\n\t\t\tif ( value == null || value !== value ) {\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\t// If a number was passed in, add the unit (except for certain CSS properties)\n\t\t\t// The isCustomProp check can be removed in jQuery 4.0 when we only auto-append\n\t\t\t// \"px\" to a few hardcoded values.\n\t\t\tif ( type === \"number\" && !isCustomProp ) {\n\t\t\t\tvalue += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? \"\" : \"px\" );\n\t\t\t}\n\n\t\t\t// background-* props affect original clone's values\n\t\t\tif ( !support.clearCloneStyle && value === \"\" && name.indexOf( \"background\" ) === 0 ) {\n\t\t\t\tstyle[ name ] = \"inherit\";\n\t\t\t}\n\n\t\t\t// If a hook was provided, use that value, otherwise just set the specified value\n\t\t\tif ( !hooks || !( \"set\" in hooks ) ||\n\t\t\t\t( value = hooks.set( elem, value, extra ) ) !== undefined ) {\n\n\t\t\t\tif ( isCustomProp ) {\n\t\t\t\t\tstyle.setProperty( name, value );\n\t\t\t\t} else {\n\t\t\t\t\tstyle[ name ] = value;\n\t\t\t\t}\n\t\t\t}\n\n\t\t} else {\n\n\t\t\t// If a hook was provided get the non-computed value from there\n\t\t\tif ( hooks && \"get\" in hooks &&\n\t\t\t\t( ret = hooks.get( elem, false, extra ) ) !== undefined ) {\n\n\t\t\t\treturn ret;\n\t\t\t}\n\n\t\t\t// Otherwise just get the value from the style object\n\t\t\treturn style[ name ];\n\t\t}\n\t},\n\n\tcss: function( elem, name, extra, styles ) {\n\t\tvar val, num, hooks,\n\t\t\torigName = camelCase( name ),\n\t\t\tisCustomProp = rcustomProp.test( name );\n\n\t\t// Make sure that we're working with the right name. We don't\n\t\t// want to modify the value if it is a CSS custom property\n\t\t// since they are user-defined.\n\t\tif ( !isCustomProp ) {\n\t\t\tname = finalPropName( origName );\n\t\t}\n\n\t\t// Try prefixed name followed by the unprefixed name\n\t\thooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ];\n\n\t\t// If a hook was provided get the computed value from there\n\t\tif ( hooks && \"get\" in hooks ) {\n\t\t\tval = hooks.get( elem, true, extra );\n\t\t}\n\n\t\t// Otherwise, if a way to get the computed value exists, use that\n\t\tif ( val === undefined ) {\n\t\t\tval = curCSS( elem, name, styles );\n\t\t}\n\n\t\t// Convert \"normal\" to computed value\n\t\tif ( val === \"normal\" && name in cssNormalTransform ) {\n\t\t\tval = cssNormalTransform[ name ];\n\t\t}\n\n\t\t// Make numeric if forced or a qualifier was provided and val looks numeric\n\t\tif ( extra === \"\" || extra ) {\n\t\t\tnum = parseFloat( val );\n\t\t\treturn extra === true || isFinite( num ) ? num || 0 : val;\n\t\t}\n\n\t\treturn val;\n\t}\n} );\n\njQuery.each( [ \"height\", \"width\" ], function( _i, dimension ) {\n\tjQuery.cssHooks[ dimension ] = {\n\t\tget: function( elem, computed, extra ) {\n\t\t\tif ( computed ) {\n\n\t\t\t\t// Certain elements can have dimension info if we invisibly show them\n\t\t\t\t// but it must have a current display style that would benefit\n\t\t\t\treturn rdisplayswap.test( jQuery.css( elem, \"display\" ) ) &&\n\n\t\t\t\t\t// Support: Safari 8+\n\t\t\t\t\t// Table columns in Safari have non-zero offsetWidth & zero\n\t\t\t\t\t// getBoundingClientRect().width unless display is changed.\n\t\t\t\t\t// Support: IE <=11 only\n\t\t\t\t\t// Running getBoundingClientRect on a disconnected node\n\t\t\t\t\t// in IE throws an error.\n\t\t\t\t\t( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ?\n\t\t\t\t\tswap( elem, cssShow, function() {\n\t\t\t\t\t\treturn getWidthOrHeight( elem, dimension, extra );\n\t\t\t\t\t} ) :\n\t\t\t\t\tgetWidthOrHeight( elem, dimension, extra );\n\t\t\t}\n\t\t},\n\n\t\tset: function( elem, value, extra ) {\n\t\t\tvar matches,\n\t\t\t\tstyles = getStyles( elem ),\n\n\t\t\t\t// Only read styles.position if the test has a chance to fail\n\t\t\t\t// to avoid forcing a reflow.\n\t\t\t\tscrollboxSizeBuggy = !support.scrollboxSize() &&\n\t\t\t\t\tstyles.position === \"absolute\",\n\n\t\t\t\t// To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991)\n\t\t\t\tboxSizingNeeded = scrollboxSizeBuggy || extra,\n\t\t\t\tisBorderBox = boxSizingNeeded &&\n\t\t\t\t\tjQuery.css( elem, \"boxSizing\", false, styles ) === \"border-box\",\n\t\t\t\tsubtract = extra ?\n\t\t\t\t\tboxModelAdjustment(\n\t\t\t\t\t\telem,\n\t\t\t\t\t\tdimension,\n\t\t\t\t\t\textra,\n\t\t\t\t\t\tisBorderBox,\n\t\t\t\t\t\tstyles\n\t\t\t\t\t) :\n\t\t\t\t\t0;\n\n\t\t\t// Account for unreliable border-box dimensions by comparing offset* to computed and\n\t\t\t// faking a content-box to get border and padding (gh-3699)\n\t\t\tif ( isBorderBox && scrollboxSizeBuggy ) {\n\t\t\t\tsubtract -= Math.ceil(\n\t\t\t\t\telem[ \"offset\" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] -\n\t\t\t\t\tparseFloat( styles[ dimension ] ) -\n\t\t\t\t\tboxModelAdjustment( elem, dimension, \"border\", false, styles ) -\n\t\t\t\t\t0.5\n\t\t\t\t);\n\t\t\t}\n\n\t\t\t// Convert to pixels if value adjustment is needed\n\t\t\tif ( subtract && ( matches = rcssNum.exec( value ) ) &&\n\t\t\t\t( matches[ 3 ] || \"px\" ) !== \"px\" ) {\n\n\t\t\t\telem.style[ dimension ] = value;\n\t\t\t\tvalue = jQuery.css( elem, dimension );\n\t\t\t}\n\n\t\t\treturn setPositiveNumber( elem, value, subtract );\n\t\t}\n\t};\n} );\n\njQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft,\n\tfunction( elem, computed ) {\n\t\tif ( computed ) {\n\t\t\treturn ( parseFloat( curCSS( elem, \"marginLeft\" ) ) ||\n\t\t\t\telem.getBoundingClientRect().left -\n\t\t\t\t\tswap( elem, { marginLeft: 0 }, function() {\n\t\t\t\t\t\treturn elem.getBoundingClientRect().left;\n\t\t\t\t\t} )\n\t\t\t) + \"px\";\n\t\t}\n\t}\n);\n\n// These hooks are used by animate to expand properties\njQuery.each( {\n\tmargin: \"\",\n\tpadding: \"\",\n\tborder: \"Width\"\n}, function( prefix, suffix ) {\n\tjQuery.cssHooks[ prefix + suffix ] = {\n\t\texpand: function( value ) {\n\t\t\tvar i = 0,\n\t\t\t\texpanded = {},\n\n\t\t\t\t// Assumes a single number if not a string\n\t\t\t\tparts = typeof value === \"string\" ? value.split( \" \" ) : [ value ];\n\n\t\t\tfor ( ; i < 4; i++ ) {\n\t\t\t\texpanded[ prefix + cssExpand[ i ] + suffix ] =\n\t\t\t\t\tparts[ i ] || parts[ i - 2 ] || parts[ 0 ];\n\t\t\t}\n\n\t\t\treturn expanded;\n\t\t}\n\t};\n\n\tif ( prefix !== \"margin\" ) {\n\t\tjQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber;\n\t}\n} );\n\njQuery.fn.extend( {\n\tcss: function( name, value ) {\n\t\treturn access( this, function( elem, name, value ) {\n\t\t\tvar styles, len,\n\t\t\t\tmap = {},\n\t\t\t\ti = 0;\n\n\t\t\tif ( Array.isArray( name ) ) {\n\t\t\t\tstyles = getStyles( elem );\n\t\t\t\tlen = name.length;\n\n\t\t\t\tfor ( ; i < len; i++ ) {\n\t\t\t\t\tmap[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles );\n\t\t\t\t}\n\n\t\t\t\treturn map;\n\t\t\t}\n\n\t\t\treturn value !== undefined ?\n\t\t\t\tjQuery.style( elem, name, value ) :\n\t\t\t\tjQuery.css( elem, name );\n\t\t}, name, value, arguments.length > 1 );\n\t}\n} );\n\n\nfunction Tween( elem, options, prop, end, easing ) {\n\treturn new Tween.prototype.init( elem, options, prop, end, easing );\n}\njQuery.Tween = Tween;\n\nTween.prototype = {\n\tconstructor: Tween,\n\tinit: function( elem, options, prop, end, easing, unit ) {\n\t\tthis.elem = elem;\n\t\tthis.prop = prop;\n\t\tthis.easing = easing || jQuery.easing._default;\n\t\tthis.options = options;\n\t\tthis.start = this.now = this.cur();\n\t\tthis.end = end;\n\t\tthis.unit = unit || ( jQuery.cssNumber[ prop ] ? \"\" : \"px\" );\n\t},\n\tcur: function() {\n\t\tvar hooks = Tween.propHooks[ this.prop ];\n\n\t\treturn hooks && hooks.get ?\n\t\t\thooks.get( this ) :\n\t\t\tTween.propHooks._default.get( this );\n\t},\n\trun: function( percent ) {\n\t\tvar eased,\n\t\t\thooks = Tween.propHooks[ this.prop ];\n\n\t\tif ( this.options.duration ) {\n\t\t\tthis.pos = eased = jQuery.easing[ this.easing ](\n\t\t\t\tpercent, this.options.duration * percent, 0, 1, this.options.duration\n\t\t\t);\n\t\t} else {\n\t\t\tthis.pos = eased = percent;\n\t\t}\n\t\tthis.now = ( this.end - this.start ) * eased + this.start;\n\n\t\tif ( this.options.step ) {\n\t\t\tthis.options.step.call( this.elem, this.now, this );\n\t\t}\n\n\t\tif ( hooks && hooks.set ) {\n\t\t\thooks.set( this );\n\t\t} else {\n\t\t\tTween.propHooks._default.set( this );\n\t\t}\n\t\treturn this;\n\t}\n};\n\nTween.prototype.init.prototype = Tween.prototype;\n\nTween.propHooks = {\n\t_default: {\n\t\tget: function( tween ) {\n\t\t\tvar result;\n\n\t\t\t// Use a property on the element directly when it is not a DOM element,\n\t\t\t// or when there is no matching style property that exists.\n\t\t\tif ( tween.elem.nodeType !== 1 ||\n\t\t\t\ttween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) {\n\t\t\t\treturn tween.elem[ tween.prop ];\n\t\t\t}\n\n\t\t\t// Passing an empty string as a 3rd parameter to .css will automatically\n\t\t\t// attempt a parseFloat and fallback to a string if the parse fails.\n\t\t\t// Simple values such as \"10px\" are parsed to Float;\n\t\t\t// complex values such as \"rotate(1rad)\" are returned as-is.\n\t\t\tresult = jQuery.css( tween.elem, tween.prop, \"\" );\n\n\t\t\t// Empty strings, null, undefined and \"auto\" are converted to 0.\n\t\t\treturn !result || result === \"auto\" ? 0 : result;\n\t\t},\n\t\tset: function( tween ) {\n\n\t\t\t// Use step hook for back compat.\n\t\t\t// Use cssHook if its there.\n\t\t\t// Use .style if available and use plain properties where available.\n\t\t\tif ( jQuery.fx.step[ tween.prop ] ) {\n\t\t\t\tjQuery.fx.step[ tween.prop ]( tween );\n\t\t\t} else if ( tween.elem.nodeType === 1 && (\n\t\t\t\tjQuery.cssHooks[ tween.prop ] ||\n\t\t\t\t\ttween.elem.style[ finalPropName( tween.prop ) ] != null ) ) {\n\t\t\t\tjQuery.style( tween.elem, tween.prop, tween.now + tween.unit );\n\t\t\t} else {\n\t\t\t\ttween.elem[ tween.prop ] = tween.now;\n\t\t\t}\n\t\t}\n\t}\n};\n\n// Support: IE <=9 only\n// Panic based approach to setting things on disconnected nodes\nTween.propHooks.scrollTop = Tween.propHooks.scrollLeft = {\n\tset: function( tween ) {\n\t\tif ( tween.elem.nodeType && tween.elem.parentNode ) {\n\t\t\ttween.elem[ tween.prop ] = tween.now;\n\t\t}\n\t}\n};\n\njQuery.easing = {\n\tlinear: function( p ) {\n\t\treturn p;\n\t},\n\tswing: function( p ) {\n\t\treturn 0.5 - Math.cos( p * Math.PI ) / 2;\n\t},\n\t_default: \"swing\"\n};\n\njQuery.fx = Tween.prototype.init;\n\n// Back compat <1.8 extension point\njQuery.fx.step = {};\n\n\n\n\nvar\n\tfxNow, inProgress,\n\trfxtypes = /^(?:toggle|show|hide)$/,\n\trrun = /queueHooks$/;\n\nfunction schedule() {\n\tif ( inProgress ) {\n\t\tif ( document.hidden === false && window.requestAnimationFrame ) {\n\t\t\twindow.requestAnimationFrame( schedule );\n\t\t} else {\n\t\t\twindow.setTimeout( schedule, jQuery.fx.interval );\n\t\t}\n\n\t\tjQuery.fx.tick();\n\t}\n}\n\n// Animations created synchronously will run synchronously\nfunction createFxNow() {\n\twindow.setTimeout( function() {\n\t\tfxNow = undefined;\n\t} );\n\treturn ( fxNow = Date.now() );\n}\n\n// Generate parameters to create a standard animation\nfunction genFx( type, includeWidth ) {\n\tvar which,\n\t\ti = 0,\n\t\tattrs = { height: type };\n\n\t// If we include width, step value is 1 to do all cssExpand values,\n\t// otherwise step value is 2 to skip over Left and Right\n\tincludeWidth = includeWidth ? 1 : 0;\n\tfor ( ; i < 4; i += 2 - includeWidth ) {\n\t\twhich = cssExpand[ i ];\n\t\tattrs[ \"margin\" + which ] = attrs[ \"padding\" + which ] = type;\n\t}\n\n\tif ( includeWidth ) {\n\t\tattrs.opacity = attrs.width = type;\n\t}\n\n\treturn attrs;\n}\n\nfunction createTween( value, prop, animation ) {\n\tvar tween,\n\t\tcollection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ \"*\" ] ),\n\t\tindex = 0,\n\t\tlength = collection.length;\n\tfor ( ; index < length; index++ ) {\n\t\tif ( ( tween = collection[ index ].call( animation, prop, value ) ) ) {\n\n\t\t\t// We're done with this property\n\t\t\treturn tween;\n\t\t}\n\t}\n}\n\nfunction defaultPrefilter( elem, props, opts ) {\n\tvar prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display,\n\t\tisBox = \"width\" in props || \"height\" in props,\n\t\tanim = this,\n\t\torig = {},\n\t\tstyle = elem.style,\n\t\thidden = elem.nodeType && isHiddenWithinTree( elem ),\n\t\tdataShow = dataPriv.get( elem, \"fxshow\" );\n\n\t// Queue-skipping animations hijack the fx hooks\n\tif ( !opts.queue ) {\n\t\thooks = jQuery._queueHooks( elem, \"fx\" );\n\t\tif ( hooks.unqueued == null ) {\n\t\t\thooks.unqueued = 0;\n\t\t\toldfire = hooks.empty.fire;\n\t\t\thooks.empty.fire = function() {\n\t\t\t\tif ( !hooks.unqueued ) {\n\t\t\t\t\toldfire();\n\t\t\t\t}\n\t\t\t};\n\t\t}\n\t\thooks.unqueued++;\n\n\t\tanim.always( function() {\n\n\t\t\t// Ensure the complete handler is called before this completes\n\t\t\tanim.always( function() {\n\t\t\t\thooks.unqueued--;\n\t\t\t\tif ( !jQuery.queue( elem, \"fx\" ).length ) {\n\t\t\t\t\thooks.empty.fire();\n\t\t\t\t}\n\t\t\t} );\n\t\t} );\n\t}\n\n\t// Detect show/hide animations\n\tfor ( prop in props ) {\n\t\tvalue = props[ prop ];\n\t\tif ( rfxtypes.test( value ) ) {\n\t\t\tdelete props[ prop ];\n\t\t\ttoggle = toggle || value === \"toggle\";\n\t\t\tif ( value === ( hidden ? \"hide\" : \"show\" ) ) {\n\n\t\t\t\t// Pretend to be hidden if this is a \"show\" and\n\t\t\t\t// there is still data from a stopped show/hide\n\t\t\t\tif ( value === \"show\" && dataShow && dataShow[ prop ] !== undefined ) {\n\t\t\t\t\thidden = true;\n\n\t\t\t\t// Ignore all other no-op show/hide data\n\t\t\t\t} else {\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t}\n\t\t\torig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop );\n\t\t}\n\t}\n\n\t// Bail out if this is a no-op like .hide().hide()\n\tpropTween = !jQuery.isEmptyObject( props );\n\tif ( !propTween && jQuery.isEmptyObject( orig ) ) {\n\t\treturn;\n\t}\n\n\t// Restrict \"overflow\" and \"display\" styles during box animations\n\tif ( isBox && elem.nodeType === 1 ) {\n\n\t\t// Support: IE <=9 - 11, Edge 12 - 15\n\t\t// Record all 3 overflow attributes because IE does not infer the shorthand\n\t\t// from identically-valued overflowX and overflowY and Edge just mirrors\n\t\t// the overflowX value there.\n\t\topts.overflow = [ style.overflow, style.overflowX, style.overflowY ];\n\n\t\t// Identify a display type, preferring old show/hide data over the CSS cascade\n\t\trestoreDisplay = dataShow && dataShow.display;\n\t\tif ( restoreDisplay == null ) {\n\t\t\trestoreDisplay = dataPriv.get( elem, \"display\" );\n\t\t}\n\t\tdisplay = jQuery.css( elem, \"display\" );\n\t\tif ( display === \"none\" ) {\n\t\t\tif ( restoreDisplay ) {\n\t\t\t\tdisplay = restoreDisplay;\n\t\t\t} else {\n\n\t\t\t\t// Get nonempty value(s) by temporarily forcing visibility\n\t\t\t\tshowHide( [ elem ], true );\n\t\t\t\trestoreDisplay = elem.style.display || restoreDisplay;\n\t\t\t\tdisplay = jQuery.css( elem, \"display\" );\n\t\t\t\tshowHide( [ elem ] );\n\t\t\t}\n\t\t}\n\n\t\t// Animate inline elements as inline-block\n\t\tif ( display === \"inline\" || display === \"inline-block\" && restoreDisplay != null ) {\n\t\t\tif ( jQuery.css( elem, \"float\" ) === \"none\" ) {\n\n\t\t\t\t// Restore the original display value at the end of pure show/hide animations\n\t\t\t\tif ( !propTween ) {\n\t\t\t\t\tanim.done( function() {\n\t\t\t\t\t\tstyle.display = restoreDisplay;\n\t\t\t\t\t} );\n\t\t\t\t\tif ( restoreDisplay == null ) {\n\t\t\t\t\t\tdisplay = style.display;\n\t\t\t\t\t\trestoreDisplay = display === \"none\" ? \"\" : display;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tstyle.display = \"inline-block\";\n\t\t\t}\n\t\t}\n\t}\n\n\tif ( opts.overflow ) {\n\t\tstyle.overflow = \"hidden\";\n\t\tanim.always( function() {\n\t\t\tstyle.overflow = opts.overflow[ 0 ];\n\t\t\tstyle.overflowX = opts.overflow[ 1 ];\n\t\t\tstyle.overflowY = opts.overflow[ 2 ];\n\t\t} );\n\t}\n\n\t// Implement show/hide animations\n\tpropTween = false;\n\tfor ( prop in orig ) {\n\n\t\t// General show/hide setup for this element animation\n\t\tif ( !propTween ) {\n\t\t\tif ( dataShow ) {\n\t\t\t\tif ( \"hidden\" in dataShow ) {\n\t\t\t\t\thidden = dataShow.hidden;\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tdataShow = dataPriv.access( elem, \"fxshow\", { display: restoreDisplay } );\n\t\t\t}\n\n\t\t\t// Store hidden/visible for toggle so `.stop().toggle()` \"reverses\"\n\t\t\tif ( toggle ) {\n\t\t\t\tdataShow.hidden = !hidden;\n\t\t\t}\n\n\t\t\t// Show elements before animating them\n\t\t\tif ( hidden ) {\n\t\t\t\tshowHide( [ elem ], true );\n\t\t\t}\n\n\t\t\t/* eslint-disable no-loop-func */\n\n\t\t\tanim.done( function() {\n\n\t\t\t\t/* eslint-enable no-loop-func */\n\n\t\t\t\t// The final step of a \"hide\" animation is actually hiding the element\n\t\t\t\tif ( !hidden ) {\n\t\t\t\t\tshowHide( [ elem ] );\n\t\t\t\t}\n\t\t\t\tdataPriv.remove( elem, \"fxshow\" );\n\t\t\t\tfor ( prop in orig ) {\n\t\t\t\t\tjQuery.style( elem, prop, orig[ prop ] );\n\t\t\t\t}\n\t\t\t} );\n\t\t}\n\n\t\t// Per-property setup\n\t\tpropTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim );\n\t\tif ( !( prop in dataShow ) ) {\n\t\t\tdataShow[ prop ] = propTween.start;\n\t\t\tif ( hidden ) {\n\t\t\t\tpropTween.end = propTween.start;\n\t\t\t\tpropTween.start = 0;\n\t\t\t}\n\t\t}\n\t}\n}\n\nfunction propFilter( props, specialEasing ) {\n\tvar index, name, easing, value, hooks;\n\n\t// camelCase, specialEasing and expand cssHook pass\n\tfor ( index in props ) {\n\t\tname = camelCase( index );\n\t\teasing = specialEasing[ name ];\n\t\tvalue = props[ index ];\n\t\tif ( Array.isArray( value ) ) {\n\t\t\teasing = value[ 1 ];\n\t\t\tvalue = props[ index ] = value[ 0 ];\n\t\t}\n\n\t\tif ( index !== name ) {\n\t\t\tprops[ name ] = value;\n\t\t\tdelete props[ index ];\n\t\t}\n\n\t\thooks = jQuery.cssHooks[ name ];\n\t\tif ( hooks && \"expand\" in hooks ) {\n\t\t\tvalue = hooks.expand( value );\n\t\t\tdelete props[ name ];\n\n\t\t\t// Not quite $.extend, this won't overwrite existing keys.\n\t\t\t// Reusing 'index' because we have the correct \"name\"\n\t\t\tfor ( index in value ) {\n\t\t\t\tif ( !( index in props ) ) {\n\t\t\t\t\tprops[ index ] = value[ index ];\n\t\t\t\t\tspecialEasing[ index ] = easing;\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\tspecialEasing[ name ] = easing;\n\t\t}\n\t}\n}\n\nfunction Animation( elem, properties, options ) {\n\tvar result,\n\t\tstopped,\n\t\tindex = 0,\n\t\tlength = Animation.prefilters.length,\n\t\tdeferred = jQuery.Deferred().always( function() {\n\n\t\t\t// Don't match elem in the :animated selector\n\t\t\tdelete tick.elem;\n\t\t} ),\n\t\ttick = function() {\n\t\t\tif ( stopped ) {\n\t\t\t\treturn false;\n\t\t\t}\n\t\t\tvar currentTime = fxNow || createFxNow(),\n\t\t\t\tremaining = Math.max( 0, animation.startTime + animation.duration - currentTime ),\n\n\t\t\t\t// Support: Android 2.3 only\n\t\t\t\t// Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497)\n\t\t\t\ttemp = remaining / animation.duration || 0,\n\t\t\t\tpercent = 1 - temp,\n\t\t\t\tindex = 0,\n\t\t\t\tlength = animation.tweens.length;\n\n\t\t\tfor ( ; index < length; index++ ) {\n\t\t\t\tanimation.tweens[ index ].run( percent );\n\t\t\t}\n\n\t\t\tdeferred.notifyWith( elem, [ animation, percent, remaining ] );\n\n\t\t\t// If there's more to do, yield\n\t\t\tif ( percent < 1 && length ) {\n\t\t\t\treturn remaining;\n\t\t\t}\n\n\t\t\t// If this was an empty animation, synthesize a final progress notification\n\t\t\tif ( !length ) {\n\t\t\t\tdeferred.notifyWith( elem, [ animation, 1, 0 ] );\n\t\t\t}\n\n\t\t\t// Resolve the animation and report its conclusion\n\t\t\tdeferred.resolveWith( elem, [ animation ] );\n\t\t\treturn false;\n\t\t},\n\t\tanimation = deferred.promise( {\n\t\t\telem: elem,\n\t\t\tprops: jQuery.extend( {}, properties ),\n\t\t\topts: jQuery.extend( true, {\n\t\t\t\tspecialEasing: {},\n\t\t\t\teasing: jQuery.easing._default\n\t\t\t}, options ),\n\t\t\toriginalProperties: properties,\n\t\t\toriginalOptions: options,\n\t\t\tstartTime: fxNow || createFxNow(),\n\t\t\tduration: options.duration,\n\t\t\ttweens: [],\n\t\t\tcreateTween: function( prop, end ) {\n\t\t\t\tvar tween = jQuery.Tween( elem, animation.opts, prop, end,\n\t\t\t\t\tanimation.opts.specialEasing[ prop ] || animation.opts.easing );\n\t\t\t\tanimation.tweens.push( tween );\n\t\t\t\treturn tween;\n\t\t\t},\n\t\t\tstop: function( gotoEnd ) {\n\t\t\t\tvar index = 0,\n\n\t\t\t\t\t// If we are going to the end, we want to run all the tweens\n\t\t\t\t\t// otherwise we skip this part\n\t\t\t\t\tlength = gotoEnd ? animation.tweens.length : 0;\n\t\t\t\tif ( stopped ) {\n\t\t\t\t\treturn this;\n\t\t\t\t}\n\t\t\t\tstopped = true;\n\t\t\t\tfor ( ; index < length; index++ ) {\n\t\t\t\t\tanimation.tweens[ index ].run( 1 );\n\t\t\t\t}\n\n\t\t\t\t// Resolve when we played the last frame; otherwise, reject\n\t\t\t\tif ( gotoEnd ) {\n\t\t\t\t\tdeferred.notifyWith( elem, [ animation, 1, 0 ] );\n\t\t\t\t\tdeferred.resolveWith( elem, [ animation, gotoEnd ] );\n\t\t\t\t} else {\n\t\t\t\t\tdeferred.rejectWith( elem, [ animation, gotoEnd ] );\n\t\t\t\t}\n\t\t\t\treturn this;\n\t\t\t}\n\t\t} ),\n\t\tprops = animation.props;\n\n\tpropFilter( props, animation.opts.specialEasing );\n\n\tfor ( ; index < length; index++ ) {\n\t\tresult = Animation.prefilters[ index ].call( animation, elem, props, animation.opts );\n\t\tif ( result ) {\n\t\t\tif ( isFunction( result.stop ) ) {\n\t\t\t\tjQuery._queueHooks( animation.elem, animation.opts.queue ).stop =\n\t\t\t\t\tresult.stop.bind( result );\n\t\t\t}\n\t\t\treturn result;\n\t\t}\n\t}\n\n\tjQuery.map( props, createTween, animation );\n\n\tif ( isFunction( animation.opts.start ) ) {\n\t\tanimation.opts.start.call( elem, animation );\n\t}\n\n\t// Attach callbacks from options\n\tanimation\n\t\t.progress( animation.opts.progress )\n\t\t.done( animation.opts.done, animation.opts.complete )\n\t\t.fail( animation.opts.fail )\n\t\t.always( animation.opts.always );\n\n\tjQuery.fx.timer(\n\t\tjQuery.extend( tick, {\n\t\t\telem: elem,\n\t\t\tanim: animation,\n\t\t\tqueue: animation.opts.queue\n\t\t} )\n\t);\n\n\treturn animation;\n}\n\njQuery.Animation = jQuery.extend( Animation, {\n\n\ttweeners: {\n\t\t\"*\": [ function( prop, value ) {\n\t\t\tvar tween = this.createTween( prop, value );\n\t\t\tadjustCSS( tween.elem, prop, rcssNum.exec( value ), tween );\n\t\t\treturn tween;\n\t\t} ]\n\t},\n\n\ttweener: function( props, callback ) {\n\t\tif ( isFunction( props ) ) {\n\t\t\tcallback = props;\n\t\t\tprops = [ \"*\" ];\n\t\t} else {\n\t\t\tprops = props.match( rnothtmlwhite );\n\t\t}\n\n\t\tvar prop,\n\t\t\tindex = 0,\n\t\t\tlength = props.length;\n\n\t\tfor ( ; index < length; index++ ) {\n\t\t\tprop = props[ index ];\n\t\t\tAnimation.tweeners[ prop ] = Animation.tweeners[ prop ] || [];\n\t\t\tAnimation.tweeners[ prop ].unshift( callback );\n\t\t}\n\t},\n\n\tprefilters: [ defaultPrefilter ],\n\n\tprefilter: function( callback, prepend ) {\n\t\tif ( prepend ) {\n\t\t\tAnimation.prefilters.unshift( callback );\n\t\t} else {\n\t\t\tAnimation.prefilters.push( callback );\n\t\t}\n\t}\n} );\n\njQuery.speed = function( speed, easing, fn ) {\n\tvar opt = speed && typeof speed === \"object\" ? jQuery.extend( {}, speed ) : {\n\t\tcomplete: fn || !fn && easing ||\n\t\t\tisFunction( speed ) && speed,\n\t\tduration: speed,\n\t\teasing: fn && easing || easing && !isFunction( easing ) && easing\n\t};\n\n\t// Go to the end state if fx are off\n\tif ( jQuery.fx.off ) {\n\t\topt.duration = 0;\n\n\t} else {\n\t\tif ( typeof opt.duration !== \"number\" ) {\n\t\t\tif ( opt.duration in jQuery.fx.speeds ) {\n\t\t\t\topt.duration = jQuery.fx.speeds[ opt.duration ];\n\n\t\t\t} else {\n\t\t\t\topt.duration = jQuery.fx.speeds._default;\n\t\t\t}\n\t\t}\n\t}\n\n\t// Normalize opt.queue - true/undefined/null -> \"fx\"\n\tif ( opt.queue == null || opt.queue === true ) {\n\t\topt.queue = \"fx\";\n\t}\n\n\t// Queueing\n\topt.old = opt.complete;\n\n\topt.complete = function() {\n\t\tif ( isFunction( opt.old ) ) {\n\t\t\topt.old.call( this );\n\t\t}\n\n\t\tif ( opt.queue ) {\n\t\t\tjQuery.dequeue( this, opt.queue );\n\t\t}\n\t};\n\n\treturn opt;\n};\n\njQuery.fn.extend( {\n\tfadeTo: function( speed, to, easing, callback ) {\n\n\t\t// Show any hidden elements after setting opacity to 0\n\t\treturn this.filter( isHiddenWithinTree ).css( \"opacity\", 0 ).show()\n\n\t\t\t// Animate to the value specified\n\t\t\t.end().animate( { opacity: to }, speed, easing, callback );\n\t},\n\tanimate: function( prop, speed, easing, callback ) {\n\t\tvar empty = jQuery.isEmptyObject( prop ),\n\t\t\toptall = jQuery.speed( speed, easing, callback ),\n\t\t\tdoAnimation = function() {\n\n\t\t\t\t// Operate on a copy of prop so per-property easing won't be lost\n\t\t\t\tvar anim = Animation( this, jQuery.extend( {}, prop ), optall );\n\n\t\t\t\t// Empty animations, or finishing resolves immediately\n\t\t\t\tif ( empty || dataPriv.get( this, \"finish\" ) ) {\n\t\t\t\t\tanim.stop( true );\n\t\t\t\t}\n\t\t\t};\n\n\t\tdoAnimation.finish = doAnimation;\n\n\t\treturn empty || optall.queue === false ?\n\t\t\tthis.each( doAnimation ) :\n\t\t\tthis.queue( optall.queue, doAnimation );\n\t},\n\tstop: function( type, clearQueue, gotoEnd ) {\n\t\tvar stopQueue = function( hooks ) {\n\t\t\tvar stop = hooks.stop;\n\t\t\tdelete hooks.stop;\n\t\t\tstop( gotoEnd );\n\t\t};\n\n\t\tif ( typeof type !== \"string\" ) {\n\t\t\tgotoEnd = clearQueue;\n\t\t\tclearQueue = type;\n\t\t\ttype = undefined;\n\t\t}\n\t\tif ( clearQueue ) {\n\t\t\tthis.queue( type || \"fx\", [] );\n\t\t}\n\n\t\treturn this.each( function() {\n\t\t\tvar dequeue = true,\n\t\t\t\tindex = type != null && type + \"queueHooks\",\n\t\t\t\ttimers = jQuery.timers,\n\t\t\t\tdata = dataPriv.get( this );\n\n\t\t\tif ( index ) {\n\t\t\t\tif ( data[ index ] && data[ index ].stop ) {\n\t\t\t\t\tstopQueue( data[ index ] );\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tfor ( index in data ) {\n\t\t\t\t\tif ( data[ index ] && data[ index ].stop && rrun.test( index ) ) {\n\t\t\t\t\t\tstopQueue( data[ index ] );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tfor ( index = timers.length; index--; ) {\n\t\t\t\tif ( timers[ index ].elem === this &&\n\t\t\t\t\t( type == null || timers[ index ].queue === type ) ) {\n\n\t\t\t\t\ttimers[ index ].anim.stop( gotoEnd );\n\t\t\t\t\tdequeue = false;\n\t\t\t\t\ttimers.splice( index, 1 );\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Start the next in the queue if the last step wasn't forced.\n\t\t\t// Timers currently will call their complete callbacks, which\n\t\t\t// will dequeue but only if they were gotoEnd.\n\t\t\tif ( dequeue || !gotoEnd ) {\n\t\t\t\tjQuery.dequeue( this, type );\n\t\t\t}\n\t\t} );\n\t},\n\tfinish: function( type ) {\n\t\tif ( type !== false ) {\n\t\t\ttype = type || \"fx\";\n\t\t}\n\t\treturn this.each( function() {\n\t\t\tvar index,\n\t\t\t\tdata = dataPriv.get( this ),\n\t\t\t\tqueue = data[ type + \"queue\" ],\n\t\t\t\thooks = data[ type + \"queueHooks\" ],\n\t\t\t\ttimers = jQuery.timers,\n\t\t\t\tlength = queue ? queue.length : 0;\n\n\t\t\t// Enable finishing flag on private data\n\t\t\tdata.finish = true;\n\n\t\t\t// Empty the queue first\n\t\t\tjQuery.queue( this, type, [] );\n\n\t\t\tif ( hooks && hooks.stop ) {\n\t\t\t\thooks.stop.call( this, true );\n\t\t\t}\n\n\t\t\t// Look for any active animations, and finish them\n\t\t\tfor ( index = timers.length; index--; ) {\n\t\t\t\tif ( timers[ index ].elem === this && timers[ index ].queue === type ) {\n\t\t\t\t\ttimers[ index ].anim.stop( true );\n\t\t\t\t\ttimers.splice( index, 1 );\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Look for any animations in the old queue and finish them\n\t\t\tfor ( index = 0; index < length; index++ ) {\n\t\t\t\tif ( queue[ index ] && queue[ index ].finish ) {\n\t\t\t\t\tqueue[ index ].finish.call( this );\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Turn off finishing flag\n\t\t\tdelete data.finish;\n\t\t} );\n\t}\n} );\n\njQuery.each( [ \"toggle\", \"show\", \"hide\" ], function( _i, name ) {\n\tvar cssFn = jQuery.fn[ name ];\n\tjQuery.fn[ name ] = function( speed, easing, callback ) {\n\t\treturn speed == null || typeof speed === \"boolean\" ?\n\t\t\tcssFn.apply( this, arguments ) :\n\t\t\tthis.animate( genFx( name, true ), speed, easing, callback );\n\t};\n} );\n\n// Generate shortcuts for custom animations\njQuery.each( {\n\tslideDown: genFx( \"show\" ),\n\tslideUp: genFx( \"hide\" ),\n\tslideToggle: genFx( \"toggle\" ),\n\tfadeIn: { opacity: \"show\" },\n\tfadeOut: { opacity: \"hide\" },\n\tfadeToggle: { opacity: \"toggle\" }\n}, function( name, props ) {\n\tjQuery.fn[ name ] = function( speed, easing, callback ) {\n\t\treturn this.animate( props, speed, easing, callback );\n\t};\n} );\n\njQuery.timers = [];\njQuery.fx.tick = function() {\n\tvar timer,\n\t\ti = 0,\n\t\ttimers = jQuery.timers;\n\n\tfxNow = Date.now();\n\n\tfor ( ; i < timers.length; i++ ) {\n\t\ttimer = timers[ i ];\n\n\t\t// Run the timer and safely remove it when done (allowing for external removal)\n\t\tif ( !timer() && timers[ i ] === timer ) {\n\t\t\ttimers.splice( i--, 1 );\n\t\t}\n\t}\n\n\tif ( !timers.length ) {\n\t\tjQuery.fx.stop();\n\t}\n\tfxNow = undefined;\n};\n\njQuery.fx.timer = function( timer ) {\n\tjQuery.timers.push( timer );\n\tjQuery.fx.start();\n};\n\njQuery.fx.interval = 13;\njQuery.fx.start = function() {\n\tif ( inProgress ) {\n\t\treturn;\n\t}\n\n\tinProgress = true;\n\tschedule();\n};\n\njQuery.fx.stop = function() {\n\tinProgress = null;\n};\n\njQuery.fx.speeds = {\n\tslow: 600,\n\tfast: 200,\n\n\t// Default speed\n\t_default: 400\n};\n\n\n// Based off of the plugin by Clint Helfers, with permission.\n// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/\njQuery.fn.delay = function( time, type ) {\n\ttime = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time;\n\ttype = type || \"fx\";\n\n\treturn this.queue( type, function( next, hooks ) {\n\t\tvar timeout = window.setTimeout( next, time );\n\t\thooks.stop = function() {\n\t\t\twindow.clearTimeout( timeout );\n\t\t};\n\t} );\n};\n\n\n( function() {\n\tvar input = document.createElement( \"input\" ),\n\t\tselect = document.createElement( \"select\" ),\n\t\topt = select.appendChild( document.createElement( \"option\" ) );\n\n\tinput.type = \"checkbox\";\n\n\t// Support: Android <=4.3 only\n\t// Default value for a checkbox should be \"on\"\n\tsupport.checkOn = input.value !== \"\";\n\n\t// Support: IE <=11 only\n\t// Must access selectedIndex to make default options select\n\tsupport.optSelected = opt.selected;\n\n\t// Support: IE <=11 only\n\t// An input loses its value after becoming a radio\n\tinput = document.createElement( \"input\" );\n\tinput.value = \"t\";\n\tinput.type = \"radio\";\n\tsupport.radioValue = input.value === \"t\";\n} )();\n\n\nvar boolHook,\n\tattrHandle = jQuery.expr.attrHandle;\n\njQuery.fn.extend( {\n\tattr: function( name, value ) {\n\t\treturn access( this, jQuery.attr, name, value, arguments.length > 1 );\n\t},\n\n\tremoveAttr: function( name ) {\n\t\treturn this.each( function() {\n\t\t\tjQuery.removeAttr( this, name );\n\t\t} );\n\t}\n} );\n\njQuery.extend( {\n\tattr: function( elem, name, value ) {\n\t\tvar ret, hooks,\n\t\t\tnType = elem.nodeType;\n\n\t\t// Don't get/set attributes on text, comment and attribute nodes\n\t\tif ( nType === 3 || nType === 8 || nType === 2 ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Fallback to prop when attributes are not supported\n\t\tif ( typeof elem.getAttribute === \"undefined\" ) {\n\t\t\treturn jQuery.prop( elem, name, value );\n\t\t}\n\n\t\t// Attribute hooks are determined by the lowercase version\n\t\t// Grab necessary hook if one is defined\n\t\tif ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) {\n\t\t\thooks = jQuery.attrHooks[ name.toLowerCase() ] ||\n\t\t\t\t( jQuery.expr.match.bool.test( name ) ? boolHook : undefined );\n\t\t}\n\n\t\tif ( value !== undefined ) {\n\t\t\tif ( value === null ) {\n\t\t\t\tjQuery.removeAttr( elem, name );\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tif ( hooks && \"set\" in hooks &&\n\t\t\t\t( ret = hooks.set( elem, value, name ) ) !== undefined ) {\n\t\t\t\treturn ret;\n\t\t\t}\n\n\t\t\telem.setAttribute( name, value + \"\" );\n\t\t\treturn value;\n\t\t}\n\n\t\tif ( hooks && \"get\" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) {\n\t\t\treturn ret;\n\t\t}\n\n\t\tret = jQuery.find.attr( elem, name );\n\n\t\t// Non-existent attributes return null, we normalize to undefined\n\t\treturn ret == null ? undefined : ret;\n\t},\n\n\tattrHooks: {\n\t\ttype: {\n\t\t\tset: function( elem, value ) {\n\t\t\t\tif ( !support.radioValue && value === \"radio\" &&\n\t\t\t\t\tnodeName( elem, \"input\" ) ) {\n\t\t\t\t\tvar val = elem.value;\n\t\t\t\t\telem.setAttribute( \"type\", value );\n\t\t\t\t\tif ( val ) {\n\t\t\t\t\t\telem.value = val;\n\t\t\t\t\t}\n\t\t\t\t\treturn value;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t},\n\n\tremoveAttr: function( elem, value ) {\n\t\tvar name,\n\t\t\ti = 0,\n\n\t\t\t// Attribute names can contain non-HTML whitespace characters\n\t\t\t// https://html.spec.whatwg.org/multipage/syntax.html#attributes-2\n\t\t\tattrNames = value && value.match( rnothtmlwhite );\n\n\t\tif ( attrNames && elem.nodeType === 1 ) {\n\t\t\twhile ( ( name = attrNames[ i++ ] ) ) {\n\t\t\t\telem.removeAttribute( name );\n\t\t\t}\n\t\t}\n\t}\n} );\n\n// Hooks for boolean attributes\nboolHook = {\n\tset: function( elem, value, name ) {\n\t\tif ( value === false ) {\n\n\t\t\t// Remove boolean attributes when set to false\n\t\t\tjQuery.removeAttr( elem, name );\n\t\t} else {\n\t\t\telem.setAttribute( name, name );\n\t\t}\n\t\treturn name;\n\t}\n};\n\njQuery.each( jQuery.expr.match.bool.source.match( /\\w+/g ), function( _i, name ) {\n\tvar getter = attrHandle[ name ] || jQuery.find.attr;\n\n\tattrHandle[ name ] = function( elem, name, isXML ) {\n\t\tvar ret, handle,\n\t\t\tlowercaseName = name.toLowerCase();\n\n\t\tif ( !isXML ) {\n\n\t\t\t// Avoid an infinite loop by temporarily removing this function from the getter\n\t\t\thandle = attrHandle[ lowercaseName ];\n\t\t\tattrHandle[ lowercaseName ] = ret;\n\t\t\tret = getter( elem, name, isXML ) != null ?\n\t\t\t\tlowercaseName :\n\t\t\t\tnull;\n\t\t\tattrHandle[ lowercaseName ] = handle;\n\t\t}\n\t\treturn ret;\n\t};\n} );\n\n\n\n\nvar rfocusable = /^(?:input|select|textarea|button)$/i,\n\trclickable = /^(?:a|area)$/i;\n\njQuery.fn.extend( {\n\tprop: function( name, value ) {\n\t\treturn access( this, jQuery.prop, name, value, arguments.length > 1 );\n\t},\n\n\tremoveProp: function( name ) {\n\t\treturn this.each( function() {\n\t\t\tdelete this[ jQuery.propFix[ name ] || name ];\n\t\t} );\n\t}\n} );\n\njQuery.extend( {\n\tprop: function( elem, name, value ) {\n\t\tvar ret, hooks,\n\t\t\tnType = elem.nodeType;\n\n\t\t// Don't get/set properties on text, comment and attribute nodes\n\t\tif ( nType === 3 || nType === 8 || nType === 2 ) {\n\t\t\treturn;\n\t\t}\n\n\t\tif ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) {\n\n\t\t\t// Fix name and attach hooks\n\t\t\tname = jQuery.propFix[ name ] || name;\n\t\t\thooks = jQuery.propHooks[ name ];\n\t\t}\n\n\t\tif ( value !== undefined ) {\n\t\t\tif ( hooks && \"set\" in hooks &&\n\t\t\t\t( ret = hooks.set( elem, value, name ) ) !== undefined ) {\n\t\t\t\treturn ret;\n\t\t\t}\n\n\t\t\treturn ( elem[ name ] = value );\n\t\t}\n\n\t\tif ( hooks && \"get\" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) {\n\t\t\treturn ret;\n\t\t}\n\n\t\treturn elem[ name ];\n\t},\n\n\tpropHooks: {\n\t\ttabIndex: {\n\t\t\tget: function( elem ) {\n\n\t\t\t\t// Support: IE <=9 - 11 only\n\t\t\t\t// elem.tabIndex doesn't always return the\n\t\t\t\t// correct value when it hasn't been explicitly set\n\t\t\t\t// https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/\n\t\t\t\t// Use proper attribute retrieval(#12072)\n\t\t\t\tvar tabindex = jQuery.find.attr( elem, \"tabindex\" );\n\n\t\t\t\tif ( tabindex ) {\n\t\t\t\t\treturn parseInt( tabindex, 10 );\n\t\t\t\t}\n\n\t\t\t\tif (\n\t\t\t\t\trfocusable.test( elem.nodeName ) ||\n\t\t\t\t\trclickable.test( elem.nodeName ) &&\n\t\t\t\t\telem.href\n\t\t\t\t) {\n\t\t\t\t\treturn 0;\n\t\t\t\t}\n\n\t\t\t\treturn -1;\n\t\t\t}\n\t\t}\n\t},\n\n\tpropFix: {\n\t\t\"for\": \"htmlFor\",\n\t\t\"class\": \"className\"\n\t}\n} );\n\n// Support: IE <=11 only\n// Accessing the selectedIndex property\n// forces the browser to respect setting selected\n// on the option\n// The getter ensures a default option is selected\n// when in an optgroup\n// eslint rule \"no-unused-expressions\" is disabled for this code\n// since it considers such accessions noop\nif ( !support.optSelected ) {\n\tjQuery.propHooks.selected = {\n\t\tget: function( elem ) {\n\n\t\t\t/* eslint no-unused-expressions: \"off\" */\n\n\t\t\tvar parent = elem.parentNode;\n\t\t\tif ( parent && parent.parentNode ) {\n\t\t\t\tparent.parentNode.selectedIndex;\n\t\t\t}\n\t\t\treturn null;\n\t\t},\n\t\tset: function( elem ) {\n\n\t\t\t/* eslint no-unused-expressions: \"off\" */\n\n\t\t\tvar parent = elem.parentNode;\n\t\t\tif ( parent ) {\n\t\t\t\tparent.selectedIndex;\n\n\t\t\t\tif ( parent.parentNode ) {\n\t\t\t\t\tparent.parentNode.selectedIndex;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t};\n}\n\njQuery.each( [\n\t\"tabIndex\",\n\t\"readOnly\",\n\t\"maxLength\",\n\t\"cellSpacing\",\n\t\"cellPadding\",\n\t\"rowSpan\",\n\t\"colSpan\",\n\t\"useMap\",\n\t\"frameBorder\",\n\t\"contentEditable\"\n], function() {\n\tjQuery.propFix[ this.toLowerCase() ] = this;\n} );\n\n\n\n\n\t// Strip and collapse whitespace according to HTML spec\n\t// https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace\n\tfunction stripAndCollapse( value ) {\n\t\tvar tokens = value.match( rnothtmlwhite ) || [];\n\t\treturn tokens.join( \" \" );\n\t}\n\n\nfunction getClass( elem ) {\n\treturn elem.getAttribute && elem.getAttribute( \"class\" ) || \"\";\n}\n\nfunction classesToArray( value ) {\n\tif ( Array.isArray( value ) ) {\n\t\treturn value;\n\t}\n\tif ( typeof value === \"string\" ) {\n\t\treturn value.match( rnothtmlwhite ) || [];\n\t}\n\treturn [];\n}\n\njQuery.fn.extend( {\n\taddClass: function( value ) {\n\t\tvar classes, elem, cur, curValue, clazz, j, finalValue,\n\t\t\ti = 0;\n\n\t\tif ( isFunction( value ) ) {\n\t\t\treturn this.each( function( j ) {\n\t\t\t\tjQuery( this ).addClass( value.call( this, j, getClass( this ) ) );\n\t\t\t} );\n\t\t}\n\n\t\tclasses = classesToArray( value );\n\n\t\tif ( classes.length ) {\n\t\t\twhile ( ( elem = this[ i++ ] ) ) {\n\t\t\t\tcurValue = getClass( elem );\n\t\t\t\tcur = elem.nodeType === 1 && ( \" \" + stripAndCollapse( curValue ) + \" \" );\n\n\t\t\t\tif ( cur ) {\n\t\t\t\t\tj = 0;\n\t\t\t\t\twhile ( ( clazz = classes[ j++ ] ) ) {\n\t\t\t\t\t\tif ( cur.indexOf( \" \" + clazz + \" \" ) < 0 ) {\n\t\t\t\t\t\t\tcur += clazz + \" \";\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\t// Only assign if different to avoid unneeded rendering.\n\t\t\t\t\tfinalValue = stripAndCollapse( cur );\n\t\t\t\t\tif ( curValue !== finalValue ) {\n\t\t\t\t\t\telem.setAttribute( \"class\", finalValue );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn this;\n\t},\n\n\tremoveClass: function( value ) {\n\t\tvar classes, elem, cur, curValue, clazz, j, finalValue,\n\t\t\ti = 0;\n\n\t\tif ( isFunction( value ) ) {\n\t\t\treturn this.each( function( j ) {\n\t\t\t\tjQuery( this ).removeClass( value.call( this, j, getClass( this ) ) );\n\t\t\t} );\n\t\t}\n\n\t\tif ( !arguments.length ) {\n\t\t\treturn this.attr( \"class\", \"\" );\n\t\t}\n\n\t\tclasses = classesToArray( value );\n\n\t\tif ( classes.length ) {\n\t\t\twhile ( ( elem = this[ i++ ] ) ) {\n\t\t\t\tcurValue = getClass( elem );\n\n\t\t\t\t// This expression is here for better compressibility (see addClass)\n\t\t\t\tcur = elem.nodeType === 1 && ( \" \" + stripAndCollapse( curValue ) + \" \" );\n\n\t\t\t\tif ( cur ) {\n\t\t\t\t\tj = 0;\n\t\t\t\t\twhile ( ( clazz = classes[ j++ ] ) ) {\n\n\t\t\t\t\t\t// Remove *all* instances\n\t\t\t\t\t\twhile ( cur.indexOf( \" \" + clazz + \" \" ) > -1 ) {\n\t\t\t\t\t\t\tcur = cur.replace( \" \" + clazz + \" \", \" \" );\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\t// Only assign if different to avoid unneeded rendering.\n\t\t\t\t\tfinalValue = stripAndCollapse( cur );\n\t\t\t\t\tif ( curValue !== finalValue ) {\n\t\t\t\t\t\telem.setAttribute( \"class\", finalValue );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn this;\n\t},\n\n\ttoggleClass: function( value, stateVal ) {\n\t\tvar type = typeof value,\n\t\t\tisValidValue = type === \"string\" || Array.isArray( value );\n\n\t\tif ( typeof stateVal === \"boolean\" && isValidValue ) {\n\t\t\treturn stateVal ? this.addClass( value ) : this.removeClass( value );\n\t\t}\n\n\t\tif ( isFunction( value ) ) {\n\t\t\treturn this.each( function( i ) {\n\t\t\t\tjQuery( this ).toggleClass(\n\t\t\t\t\tvalue.call( this, i, getClass( this ), stateVal ),\n\t\t\t\t\tstateVal\n\t\t\t\t);\n\t\t\t} );\n\t\t}\n\n\t\treturn this.each( function() {\n\t\t\tvar className, i, self, classNames;\n\n\t\t\tif ( isValidValue ) {\n\n\t\t\t\t// Toggle individual class names\n\t\t\t\ti = 0;\n\t\t\t\tself = jQuery( this );\n\t\t\t\tclassNames = classesToArray( value );\n\n\t\t\t\twhile ( ( className = classNames[ i++ ] ) ) {\n\n\t\t\t\t\t// Check each className given, space separated list\n\t\t\t\t\tif ( self.hasClass( className ) ) {\n\t\t\t\t\t\tself.removeClass( className );\n\t\t\t\t\t} else {\n\t\t\t\t\t\tself.addClass( className );\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t// Toggle whole class name\n\t\t\t} else if ( value === undefined || type === \"boolean\" ) {\n\t\t\t\tclassName = getClass( this );\n\t\t\t\tif ( className ) {\n\n\t\t\t\t\t// Store className if set\n\t\t\t\t\tdataPriv.set( this, \"__className__\", className );\n\t\t\t\t}\n\n\t\t\t\t// If the element has a class name or if we're passed `false`,\n\t\t\t\t// then remove the whole classname (if there was one, the above saved it).\n\t\t\t\t// Otherwise bring back whatever was previously saved (if anything),\n\t\t\t\t// falling back to the empty string if nothing was stored.\n\t\t\t\tif ( this.setAttribute ) {\n\t\t\t\t\tthis.setAttribute( \"class\",\n\t\t\t\t\t\tclassName || value === false ?\n\t\t\t\t\t\t\t\"\" :\n\t\t\t\t\t\t\tdataPriv.get( this, \"__className__\" ) || \"\"\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t}\n\t\t} );\n\t},\n\n\thasClass: function( selector ) {\n\t\tvar className, elem,\n\t\t\ti = 0;\n\n\t\tclassName = \" \" + selector + \" \";\n\t\twhile ( ( elem = this[ i++ ] ) ) {\n\t\t\tif ( elem.nodeType === 1 &&\n\t\t\t\t( \" \" + stripAndCollapse( getClass( elem ) ) + \" \" ).indexOf( className ) > -1 ) {\n\t\t\t\treturn true;\n\t\t\t}\n\t\t}\n\n\t\treturn false;\n\t}\n} );\n\n\n\n\nvar rreturn = /\\r/g;\n\njQuery.fn.extend( {\n\tval: function( value ) {\n\t\tvar hooks, ret, valueIsFunction,\n\t\t\telem = this[ 0 ];\n\n\t\tif ( !arguments.length ) {\n\t\t\tif ( elem ) {\n\t\t\t\thooks = jQuery.valHooks[ elem.type ] ||\n\t\t\t\t\tjQuery.valHooks[ elem.nodeName.toLowerCase() ];\n\n\t\t\t\tif ( hooks &&\n\t\t\t\t\t\"get\" in hooks &&\n\t\t\t\t\t( ret = hooks.get( elem, \"value\" ) ) !== undefined\n\t\t\t\t) {\n\t\t\t\t\treturn ret;\n\t\t\t\t}\n\n\t\t\t\tret = elem.value;\n\n\t\t\t\t// Handle most common string cases\n\t\t\t\tif ( typeof ret === \"string\" ) {\n\t\t\t\t\treturn ret.replace( rreturn, \"\" );\n\t\t\t\t}\n\n\t\t\t\t// Handle cases where value is null/undef or number\n\t\t\t\treturn ret == null ? \"\" : ret;\n\t\t\t}\n\n\t\t\treturn;\n\t\t}\n\n\t\tvalueIsFunction = isFunction( value );\n\n\t\treturn this.each( function( i ) {\n\t\t\tvar val;\n\n\t\t\tif ( this.nodeType !== 1 ) {\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tif ( valueIsFunction ) {\n\t\t\t\tval = value.call( this, i, jQuery( this ).val() );\n\t\t\t} else {\n\t\t\t\tval = value;\n\t\t\t}\n\n\t\t\t// Treat null/undefined as \"\"; convert numbers to string\n\t\t\tif ( val == null ) {\n\t\t\t\tval = \"\";\n\n\t\t\t} else if ( typeof val === \"number\" ) {\n\t\t\t\tval += \"\";\n\n\t\t\t} else if ( Array.isArray( val ) ) {\n\t\t\t\tval = jQuery.map( val, function( value ) {\n\t\t\t\t\treturn value == null ? \"\" : value + \"\";\n\t\t\t\t} );\n\t\t\t}\n\n\t\t\thooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ];\n\n\t\t\t// If set returns undefined, fall back to normal setting\n\t\t\tif ( !hooks || !( \"set\" in hooks ) || hooks.set( this, val, \"value\" ) === undefined ) {\n\t\t\t\tthis.value = val;\n\t\t\t}\n\t\t} );\n\t}\n} );\n\njQuery.extend( {\n\tvalHooks: {\n\t\toption: {\n\t\t\tget: function( elem ) {\n\n\t\t\t\tvar val = jQuery.find.attr( elem, \"value\" );\n\t\t\t\treturn val != null ?\n\t\t\t\t\tval :\n\n\t\t\t\t\t// Support: IE <=10 - 11 only\n\t\t\t\t\t// option.text throws exceptions (#14686, #14858)\n\t\t\t\t\t// Strip and collapse whitespace\n\t\t\t\t\t// https://html.spec.whatwg.org/#strip-and-collapse-whitespace\n\t\t\t\t\tstripAndCollapse( jQuery.text( elem ) );\n\t\t\t}\n\t\t},\n\t\tselect: {\n\t\t\tget: function( elem ) {\n\t\t\t\tvar value, option, i,\n\t\t\t\t\toptions = elem.options,\n\t\t\t\t\tindex = elem.selectedIndex,\n\t\t\t\t\tone = elem.type === \"select-one\",\n\t\t\t\t\tvalues = one ? null : [],\n\t\t\t\t\tmax = one ? index + 1 : options.length;\n\n\t\t\t\tif ( index < 0 ) {\n\t\t\t\t\ti = max;\n\n\t\t\t\t} else {\n\t\t\t\t\ti = one ? index : 0;\n\t\t\t\t}\n\n\t\t\t\t// Loop through all the selected options\n\t\t\t\tfor ( ; i < max; i++ ) {\n\t\t\t\t\toption = options[ i ];\n\n\t\t\t\t\t// Support: IE <=9 only\n\t\t\t\t\t// IE8-9 doesn't update selected after form reset (#2551)\n\t\t\t\t\tif ( ( option.selected || i === index ) &&\n\n\t\t\t\t\t\t\t// Don't return options that are disabled or in a disabled optgroup\n\t\t\t\t\t\t\t!option.disabled &&\n\t\t\t\t\t\t\t( !option.parentNode.disabled ||\n\t\t\t\t\t\t\t\t!nodeName( option.parentNode, \"optgroup\" ) ) ) {\n\n\t\t\t\t\t\t// Get the specific value for the option\n\t\t\t\t\t\tvalue = jQuery( option ).val();\n\n\t\t\t\t\t\t// We don't need an array for one selects\n\t\t\t\t\t\tif ( one ) {\n\t\t\t\t\t\t\treturn value;\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\t// Multi-Selects return an array\n\t\t\t\t\t\tvalues.push( value );\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\treturn values;\n\t\t\t},\n\n\t\t\tset: function( elem, value ) {\n\t\t\t\tvar optionSet, option,\n\t\t\t\t\toptions = elem.options,\n\t\t\t\t\tvalues = jQuery.makeArray( value ),\n\t\t\t\t\ti = options.length;\n\n\t\t\t\twhile ( i-- ) {\n\t\t\t\t\toption = options[ i ];\n\n\t\t\t\t\t/* eslint-disable no-cond-assign */\n\n\t\t\t\t\tif ( option.selected =\n\t\t\t\t\t\tjQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1\n\t\t\t\t\t) {\n\t\t\t\t\t\toptionSet = true;\n\t\t\t\t\t}\n\n\t\t\t\t\t/* eslint-enable no-cond-assign */\n\t\t\t\t}\n\n\t\t\t\t// Force browsers to behave consistently when non-matching value is set\n\t\t\t\tif ( !optionSet ) {\n\t\t\t\t\telem.selectedIndex = -1;\n\t\t\t\t}\n\t\t\t\treturn values;\n\t\t\t}\n\t\t}\n\t}\n} );\n\n// Radios and checkboxes getter/setter\njQuery.each( [ \"radio\", \"checkbox\" ], function() {\n\tjQuery.valHooks[ this ] = {\n\t\tset: function( elem, value ) {\n\t\t\tif ( Array.isArray( value ) ) {\n\t\t\t\treturn ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 );\n\t\t\t}\n\t\t}\n\t};\n\tif ( !support.checkOn ) {\n\t\tjQuery.valHooks[ this ].get = function( elem ) {\n\t\t\treturn elem.getAttribute( \"value\" ) === null ? \"on\" : elem.value;\n\t\t};\n\t}\n} );\n\n\n\n\n// Return jQuery for attributes-only inclusion\n\n\nsupport.focusin = \"onfocusin\" in window;\n\n\nvar rfocusMorph = /^(?:focusinfocus|focusoutblur)$/,\n\tstopPropagationCallback = function( e ) {\n\t\te.stopPropagation();\n\t};\n\njQuery.extend( jQuery.event, {\n\n\ttrigger: function( event, data, elem, onlyHandlers ) {\n\n\t\tvar i, cur, tmp, bubbleType, ontype, handle, special, lastElement,\n\t\t\teventPath = [ elem || document ],\n\t\t\ttype = hasOwn.call( event, \"type\" ) ? event.type : event,\n\t\t\tnamespaces = hasOwn.call( event, \"namespace\" ) ? event.namespace.split( \".\" ) : [];\n\n\t\tcur = lastElement = tmp = elem = elem || document;\n\n\t\t// Don't do events on text and comment nodes\n\t\tif ( elem.nodeType === 3 || elem.nodeType === 8 ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// focus/blur morphs to focusin/out; ensure we're not firing them right now\n\t\tif ( rfocusMorph.test( type + jQuery.event.triggered ) ) {\n\t\t\treturn;\n\t\t}\n\n\t\tif ( type.indexOf( \".\" ) > -1 ) {\n\n\t\t\t// Namespaced trigger; create a regexp to match event type in handle()\n\t\t\tnamespaces = type.split( \".\" );\n\t\t\ttype = namespaces.shift();\n\t\t\tnamespaces.sort();\n\t\t}\n\t\tontype = type.indexOf( \":\" ) < 0 && \"on\" + type;\n\n\t\t// Caller can pass in a jQuery.Event object, Object, or just an event type string\n\t\tevent = event[ jQuery.expando ] ?\n\t\t\tevent :\n\t\t\tnew jQuery.Event( type, typeof event === \"object\" && event );\n\n\t\t// Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true)\n\t\tevent.isTrigger = onlyHandlers ? 2 : 3;\n\t\tevent.namespace = namespaces.join( \".\" );\n\t\tevent.rnamespace = event.namespace ?\n\t\t\tnew RegExp( \"(^|\\\\.)\" + namespaces.join( \"\\\\.(?:.*\\\\.|)\" ) + \"(\\\\.|$)\" ) :\n\t\t\tnull;\n\n\t\t// Clean up the event in case it is being reused\n\t\tevent.result = undefined;\n\t\tif ( !event.target ) {\n\t\t\tevent.target = elem;\n\t\t}\n\n\t\t// Clone any incoming data and prepend the event, creating the handler arg list\n\t\tdata = data == null ?\n\t\t\t[ event ] :\n\t\t\tjQuery.makeArray( data, [ event ] );\n\n\t\t// Allow special events to draw outside the lines\n\t\tspecial = jQuery.event.special[ type ] || {};\n\t\tif ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Determine event propagation path in advance, per W3C events spec (#9951)\n\t\t// Bubble up to document, then to window; watch for a global ownerDocument var (#9724)\n\t\tif ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) {\n\n\t\t\tbubbleType = special.delegateType || type;\n\t\t\tif ( !rfocusMorph.test( bubbleType + type ) ) {\n\t\t\t\tcur = cur.parentNode;\n\t\t\t}\n\t\t\tfor ( ; cur; cur = cur.parentNode ) {\n\t\t\t\teventPath.push( cur );\n\t\t\t\ttmp = cur;\n\t\t\t}\n\n\t\t\t// Only add window if we got to document (e.g., not plain obj or detached DOM)\n\t\t\tif ( tmp === ( elem.ownerDocument || document ) ) {\n\t\t\t\teventPath.push( tmp.defaultView || tmp.parentWindow || window );\n\t\t\t}\n\t\t}\n\n\t\t// Fire handlers on the event path\n\t\ti = 0;\n\t\twhile ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) {\n\t\t\tlastElement = cur;\n\t\t\tevent.type = i > 1 ?\n\t\t\t\tbubbleType :\n\t\t\t\tspecial.bindType || type;\n\n\t\t\t// jQuery handler\n\t\t\thandle = ( dataPriv.get( cur, \"events\" ) || Object.create( null ) )[ event.type ] &&\n\t\t\t\tdataPriv.get( cur, \"handle\" );\n\t\t\tif ( handle ) {\n\t\t\t\thandle.apply( cur, data );\n\t\t\t}\n\n\t\t\t// Native handler\n\t\t\thandle = ontype && cur[ ontype ];\n\t\t\tif ( handle && handle.apply && acceptData( cur ) ) {\n\t\t\t\tevent.result = handle.apply( cur, data );\n\t\t\t\tif ( event.result === false ) {\n\t\t\t\t\tevent.preventDefault();\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tevent.type = type;\n\n\t\t// If nobody prevented the default action, do it now\n\t\tif ( !onlyHandlers && !event.isDefaultPrevented() ) {\n\n\t\t\tif ( ( !special._default ||\n\t\t\t\tspecial._default.apply( eventPath.pop(), data ) === false ) &&\n\t\t\t\tacceptData( elem ) ) {\n\n\t\t\t\t// Call a native DOM method on the target with the same name as the event.\n\t\t\t\t// Don't do default actions on window, that's where global variables be (#6170)\n\t\t\t\tif ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) {\n\n\t\t\t\t\t// Don't re-trigger an onFOO event when we call its FOO() method\n\t\t\t\t\ttmp = elem[ ontype ];\n\n\t\t\t\t\tif ( tmp ) {\n\t\t\t\t\t\telem[ ontype ] = null;\n\t\t\t\t\t}\n\n\t\t\t\t\t// Prevent re-triggering of the same event, since we already bubbled it above\n\t\t\t\t\tjQuery.event.triggered = type;\n\n\t\t\t\t\tif ( event.isPropagationStopped() ) {\n\t\t\t\t\t\tlastElement.addEventListener( type, stopPropagationCallback );\n\t\t\t\t\t}\n\n\t\t\t\t\telem[ type ]();\n\n\t\t\t\t\tif ( event.isPropagationStopped() ) {\n\t\t\t\t\t\tlastElement.removeEventListener( type, stopPropagationCallback );\n\t\t\t\t\t}\n\n\t\t\t\t\tjQuery.event.triggered = undefined;\n\n\t\t\t\t\tif ( tmp ) {\n\t\t\t\t\t\telem[ ontype ] = tmp;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn event.result;\n\t},\n\n\t// Piggyback on a donor event to simulate a different one\n\t// Used only for `focus(in | out)` events\n\tsimulate: function( type, elem, event ) {\n\t\tvar e = jQuery.extend(\n\t\t\tnew jQuery.Event(),\n\t\t\tevent,\n\t\t\t{\n\t\t\t\ttype: type,\n\t\t\t\tisSimulated: true\n\t\t\t}\n\t\t);\n\n\t\tjQuery.event.trigger( e, null, elem );\n\t}\n\n} );\n\njQuery.fn.extend( {\n\n\ttrigger: function( type, data ) {\n\t\treturn this.each( function() {\n\t\t\tjQuery.event.trigger( type, data, this );\n\t\t} );\n\t},\n\ttriggerHandler: function( type, data ) {\n\t\tvar elem = this[ 0 ];\n\t\tif ( elem ) {\n\t\t\treturn jQuery.event.trigger( type, data, elem, true );\n\t\t}\n\t}\n} );\n\n\n// Support: Firefox <=44\n// Firefox doesn't have focus(in | out) events\n// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787\n//\n// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1\n// focus(in | out) events fire after focus & blur events,\n// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order\n// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857\nif ( !support.focusin ) {\n\tjQuery.each( { focus: \"focusin\", blur: \"focusout\" }, function( orig, fix ) {\n\n\t\t// Attach a single capturing handler on the document while someone wants focusin/focusout\n\t\tvar handler = function( event ) {\n\t\t\tjQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) );\n\t\t};\n\n\t\tjQuery.event.special[ fix ] = {\n\t\t\tsetup: function() {\n\n\t\t\t\t// Handle: regular nodes (via `this.ownerDocument`), window\n\t\t\t\t// (via `this.document`) & document (via `this`).\n\t\t\t\tvar doc = this.ownerDocument || this.document || this,\n\t\t\t\t\tattaches = dataPriv.access( doc, fix );\n\n\t\t\t\tif ( !attaches ) {\n\t\t\t\t\tdoc.addEventListener( orig, handler, true );\n\t\t\t\t}\n\t\t\t\tdataPriv.access( doc, fix, ( attaches || 0 ) + 1 );\n\t\t\t},\n\t\t\tteardown: function() {\n\t\t\t\tvar doc = this.ownerDocument || this.document || this,\n\t\t\t\t\tattaches = dataPriv.access( doc, fix ) - 1;\n\n\t\t\t\tif ( !attaches ) {\n\t\t\t\t\tdoc.removeEventListener( orig, handler, true );\n\t\t\t\t\tdataPriv.remove( doc, fix );\n\n\t\t\t\t} else {\n\t\t\t\t\tdataPriv.access( doc, fix, attaches );\n\t\t\t\t}\n\t\t\t}\n\t\t};\n\t} );\n}\nvar location = window.location;\n\nvar nonce = { guid: Date.now() };\n\nvar rquery = ( /\\?/ );\n\n\n\n// Cross-browser xml parsing\njQuery.parseXML = function( data ) {\n\tvar xml, parserErrorElem;\n\tif ( !data || typeof data !== \"string\" ) {\n\t\treturn null;\n\t}\n\n\t// Support: IE 9 - 11 only\n\t// IE throws on parseFromString with invalid input.\n\ttry {\n\t\txml = ( new window.DOMParser() ).parseFromString( data, \"text/xml\" );\n\t} catch ( e ) {}\n\n\tparserErrorElem = xml && xml.getElementsByTagName( \"parsererror\" )[ 0 ];\n\tif ( !xml || parserErrorElem ) {\n\t\tjQuery.error( \"Invalid XML: \" + (\n\t\t\tparserErrorElem ?\n\t\t\t\tjQuery.map( parserErrorElem.childNodes, function( el ) {\n\t\t\t\t\treturn el.textContent;\n\t\t\t\t} ).join( \"\\n\" ) :\n\t\t\t\tdata\n\t\t) );\n\t}\n\treturn xml;\n};\n\n\nvar\n\trbracket = /\\[\\]$/,\n\trCRLF = /\\r?\\n/g,\n\trsubmitterTypes = /^(?:submit|button|image|reset|file)$/i,\n\trsubmittable = /^(?:input|select|textarea|keygen)/i;\n\nfunction buildParams( prefix, obj, traditional, add ) {\n\tvar name;\n\n\tif ( Array.isArray( obj ) ) {\n\n\t\t// Serialize array item.\n\t\tjQuery.each( obj, function( i, v ) {\n\t\t\tif ( traditional || rbracket.test( prefix ) ) {\n\n\t\t\t\t// Treat each array item as a scalar.\n\t\t\t\tadd( prefix, v );\n\n\t\t\t} else {\n\n\t\t\t\t// Item is non-scalar (array or object), encode its numeric index.\n\t\t\t\tbuildParams(\n\t\t\t\t\tprefix + \"[\" + ( typeof v === \"object\" && v != null ? i : \"\" ) + \"]\",\n\t\t\t\t\tv,\n\t\t\t\t\ttraditional,\n\t\t\t\t\tadd\n\t\t\t\t);\n\t\t\t}\n\t\t} );\n\n\t} else if ( !traditional && toType( obj ) === \"object\" ) {\n\n\t\t// Serialize object item.\n\t\tfor ( name in obj ) {\n\t\t\tbuildParams( prefix + \"[\" + name + \"]\", obj[ name ], traditional, add );\n\t\t}\n\n\t} else {\n\n\t\t// Serialize scalar item.\n\t\tadd( prefix, obj );\n\t}\n}\n\n// Serialize an array of form elements or a set of\n// key/values into a query string\njQuery.param = function( a, traditional ) {\n\tvar prefix,\n\t\ts = [],\n\t\tadd = function( key, valueOrFunction ) {\n\n\t\t\t// If value is a function, invoke it and use its return value\n\t\t\tvar value = isFunction( valueOrFunction ) ?\n\t\t\t\tvalueOrFunction() :\n\t\t\t\tvalueOrFunction;\n\n\t\t\ts[ s.length ] = encodeURIComponent( key ) + \"=\" +\n\t\t\t\tencodeURIComponent( value == null ? \"\" : value );\n\t\t};\n\n\tif ( a == null ) {\n\t\treturn \"\";\n\t}\n\n\t// If an array was passed in, assume that it is an array of form elements.\n\tif ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) {\n\n\t\t// Serialize the form elements\n\t\tjQuery.each( a, function() {\n\t\t\tadd( this.name, this.value );\n\t\t} );\n\n\t} else {\n\n\t\t// If traditional, encode the \"old\" way (the way 1.3.2 or older\n\t\t// did it), otherwise encode params recursively.\n\t\tfor ( prefix in a ) {\n\t\t\tbuildParams( prefix, a[ prefix ], traditional, add );\n\t\t}\n\t}\n\n\t// Return the resulting serialization\n\treturn s.join( \"&\" );\n};\n\njQuery.fn.extend( {\n\tserialize: function() {\n\t\treturn jQuery.param( this.serializeArray() );\n\t},\n\tserializeArray: function() {\n\t\treturn this.map( function() {\n\n\t\t\t// Can add propHook for \"elements\" to filter or add form elements\n\t\t\tvar elements = jQuery.prop( this, \"elements\" );\n\t\t\treturn elements ? jQuery.makeArray( elements ) : this;\n\t\t} ).filter( function() {\n\t\t\tvar type = this.type;\n\n\t\t\t// Use .is( \":disabled\" ) so that fieldset[disabled] works\n\t\t\treturn this.name && !jQuery( this ).is( \":disabled\" ) &&\n\t\t\t\trsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) &&\n\t\t\t\t( this.checked || !rcheckableType.test( type ) );\n\t\t} ).map( function( _i, elem ) {\n\t\t\tvar val = jQuery( this ).val();\n\n\t\t\tif ( val == null ) {\n\t\t\t\treturn null;\n\t\t\t}\n\n\t\t\tif ( Array.isArray( val ) ) {\n\t\t\t\treturn jQuery.map( val, function( val ) {\n\t\t\t\t\treturn { name: elem.name, value: val.replace( rCRLF, \"\\r\\n\" ) };\n\t\t\t\t} );\n\t\t\t}\n\n\t\t\treturn { name: elem.name, value: val.replace( rCRLF, \"\\r\\n\" ) };\n\t\t} ).get();\n\t}\n} );\n\n\nvar\n\tr20 = /%20/g,\n\trhash = /#.*$/,\n\trantiCache = /([?&])_=[^&]*/,\n\trheaders = /^(.*?):[ \\t]*([^\\r\\n]*)$/mg,\n\n\t// #7653, #8125, #8152: local protocol detection\n\trlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/,\n\trnoContent = /^(?:GET|HEAD)$/,\n\trprotocol = /^\\/\\//,\n\n\t/* Prefilters\n\t * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example)\n\t * 2) These are called:\n\t * - BEFORE asking for a transport\n\t * - AFTER param serialization (s.data is a string if s.processData is true)\n\t * 3) key is the dataType\n\t * 4) the catchall symbol \"*\" can be used\n\t * 5) execution will start with transport dataType and THEN continue down to \"*\" if needed\n\t */\n\tprefilters = {},\n\n\t/* Transports bindings\n\t * 1) key is the dataType\n\t * 2) the catchall symbol \"*\" can be used\n\t * 3) selection will start with transport dataType and THEN go to \"*\" if needed\n\t */\n\ttransports = {},\n\n\t// Avoid comment-prolog char sequence (#10098); must appease lint and evade compression\n\tallTypes = \"*/\".concat( \"*\" ),\n\n\t// Anchor tag for parsing the document origin\n\toriginAnchor = document.createElement( \"a\" );\n\noriginAnchor.href = location.href;\n\n// Base \"constructor\" for jQuery.ajaxPrefilter and jQuery.ajaxTransport\nfunction addToPrefiltersOrTransports( structure ) {\n\n\t// dataTypeExpression is optional and defaults to \"*\"\n\treturn function( dataTypeExpression, func ) {\n\n\t\tif ( typeof dataTypeExpression !== \"string\" ) {\n\t\t\tfunc = dataTypeExpression;\n\t\t\tdataTypeExpression = \"*\";\n\t\t}\n\n\t\tvar dataType,\n\t\t\ti = 0,\n\t\t\tdataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || [];\n\n\t\tif ( isFunction( func ) ) {\n\n\t\t\t// For each dataType in the dataTypeExpression\n\t\t\twhile ( ( dataType = dataTypes[ i++ ] ) ) {\n\n\t\t\t\t// Prepend if requested\n\t\t\t\tif ( dataType[ 0 ] === \"+\" ) {\n\t\t\t\t\tdataType = dataType.slice( 1 ) || \"*\";\n\t\t\t\t\t( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func );\n\n\t\t\t\t// Otherwise append\n\t\t\t\t} else {\n\t\t\t\t\t( structure[ dataType ] = structure[ dataType ] || [] ).push( func );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t};\n}\n\n// Base inspection function for prefilters and transports\nfunction inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) {\n\n\tvar inspected = {},\n\t\tseekingTransport = ( structure === transports );\n\n\tfunction inspect( dataType ) {\n\t\tvar selected;\n\t\tinspected[ dataType ] = true;\n\t\tjQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) {\n\t\t\tvar dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR );\n\t\t\tif ( typeof dataTypeOrTransport === \"string\" &&\n\t\t\t\t!seekingTransport && !inspected[ dataTypeOrTransport ] ) {\n\n\t\t\t\toptions.dataTypes.unshift( dataTypeOrTransport );\n\t\t\t\tinspect( dataTypeOrTransport );\n\t\t\t\treturn false;\n\t\t\t} else if ( seekingTransport ) {\n\t\t\t\treturn !( selected = dataTypeOrTransport );\n\t\t\t}\n\t\t} );\n\t\treturn selected;\n\t}\n\n\treturn inspect( options.dataTypes[ 0 ] ) || !inspected[ \"*\" ] && inspect( \"*\" );\n}\n\n// A special extend for ajax options\n// that takes \"flat\" options (not to be deep extended)\n// Fixes #9887\nfunction ajaxExtend( target, src ) {\n\tvar key, deep,\n\t\tflatOptions = jQuery.ajaxSettings.flatOptions || {};\n\n\tfor ( key in src ) {\n\t\tif ( src[ key ] !== undefined ) {\n\t\t\t( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ];\n\t\t}\n\t}\n\tif ( deep ) {\n\t\tjQuery.extend( true, target, deep );\n\t}\n\n\treturn target;\n}\n\n/* Handles responses to an ajax request:\n * - finds the right dataType (mediates between content-type and expected dataType)\n * - returns the corresponding response\n */\nfunction ajaxHandleResponses( s, jqXHR, responses ) {\n\n\tvar ct, type, finalDataType, firstDataType,\n\t\tcontents = s.contents,\n\t\tdataTypes = s.dataTypes;\n\n\t// Remove auto dataType and get content-type in the process\n\twhile ( dataTypes[ 0 ] === \"*\" ) {\n\t\tdataTypes.shift();\n\t\tif ( ct === undefined ) {\n\t\t\tct = s.mimeType || jqXHR.getResponseHeader( \"Content-Type\" );\n\t\t}\n\t}\n\n\t// Check if we're dealing with a known content-type\n\tif ( ct ) {\n\t\tfor ( type in contents ) {\n\t\t\tif ( contents[ type ] && contents[ type ].test( ct ) ) {\n\t\t\t\tdataTypes.unshift( type );\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t}\n\n\t// Check to see if we have a response for the expected dataType\n\tif ( dataTypes[ 0 ] in responses ) {\n\t\tfinalDataType = dataTypes[ 0 ];\n\t} else {\n\n\t\t// Try convertible dataTypes\n\t\tfor ( type in responses ) {\n\t\t\tif ( !dataTypes[ 0 ] || s.converters[ type + \" \" + dataTypes[ 0 ] ] ) {\n\t\t\t\tfinalDataType = type;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif ( !firstDataType ) {\n\t\t\t\tfirstDataType = type;\n\t\t\t}\n\t\t}\n\n\t\t// Or just use first one\n\t\tfinalDataType = finalDataType || firstDataType;\n\t}\n\n\t// If we found a dataType\n\t// We add the dataType to the list if needed\n\t// and return the corresponding response\n\tif ( finalDataType ) {\n\t\tif ( finalDataType !== dataTypes[ 0 ] ) {\n\t\t\tdataTypes.unshift( finalDataType );\n\t\t}\n\t\treturn responses[ finalDataType ];\n\t}\n}\n\n/* Chain conversions given the request and the original response\n * Also sets the responseXXX fields on the jqXHR instance\n */\nfunction ajaxConvert( s, response, jqXHR, isSuccess ) {\n\tvar conv2, current, conv, tmp, prev,\n\t\tconverters = {},\n\n\t\t// Work with a copy of dataTypes in case we need to modify it for conversion\n\t\tdataTypes = s.dataTypes.slice();\n\n\t// Create converters map with lowercased keys\n\tif ( dataTypes[ 1 ] ) {\n\t\tfor ( conv in s.converters ) {\n\t\t\tconverters[ conv.toLowerCase() ] = s.converters[ conv ];\n\t\t}\n\t}\n\n\tcurrent = dataTypes.shift();\n\n\t// Convert to each sequential dataType\n\twhile ( current ) {\n\n\t\tif ( s.responseFields[ current ] ) {\n\t\t\tjqXHR[ s.responseFields[ current ] ] = response;\n\t\t}\n\n\t\t// Apply the dataFilter if provided\n\t\tif ( !prev && isSuccess && s.dataFilter ) {\n\t\t\tresponse = s.dataFilter( response, s.dataType );\n\t\t}\n\n\t\tprev = current;\n\t\tcurrent = dataTypes.shift();\n\n\t\tif ( current ) {\n\n\t\t\t// There's only work to do if current dataType is non-auto\n\t\t\tif ( current === \"*\" ) {\n\n\t\t\t\tcurrent = prev;\n\n\t\t\t// Convert response if prev dataType is non-auto and differs from current\n\t\t\t} else if ( prev !== \"*\" && prev !== current ) {\n\n\t\t\t\t// Seek a direct converter\n\t\t\t\tconv = converters[ prev + \" \" + current ] || converters[ \"* \" + current ];\n\n\t\t\t\t// If none found, seek a pair\n\t\t\t\tif ( !conv ) {\n\t\t\t\t\tfor ( conv2 in converters ) {\n\n\t\t\t\t\t\t// If conv2 outputs current\n\t\t\t\t\t\ttmp = conv2.split( \" \" );\n\t\t\t\t\t\tif ( tmp[ 1 ] === current ) {\n\n\t\t\t\t\t\t\t// If prev can be converted to accepted input\n\t\t\t\t\t\t\tconv = converters[ prev + \" \" + tmp[ 0 ] ] ||\n\t\t\t\t\t\t\t\tconverters[ \"* \" + tmp[ 0 ] ];\n\t\t\t\t\t\t\tif ( conv ) {\n\n\t\t\t\t\t\t\t\t// Condense equivalence converters\n\t\t\t\t\t\t\t\tif ( conv === true ) {\n\t\t\t\t\t\t\t\t\tconv = converters[ conv2 ];\n\n\t\t\t\t\t\t\t\t// Otherwise, insert the intermediate dataType\n\t\t\t\t\t\t\t\t} else if ( converters[ conv2 ] !== true ) {\n\t\t\t\t\t\t\t\t\tcurrent = tmp[ 0 ];\n\t\t\t\t\t\t\t\t\tdataTypes.unshift( tmp[ 1 ] );\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// Apply converter (if not an equivalence)\n\t\t\t\tif ( conv !== true ) {\n\n\t\t\t\t\t// Unless errors are allowed to bubble, catch and return them\n\t\t\t\t\tif ( conv && s.throws ) {\n\t\t\t\t\t\tresponse = conv( response );\n\t\t\t\t\t} else {\n\t\t\t\t\t\ttry {\n\t\t\t\t\t\t\tresponse = conv( response );\n\t\t\t\t\t\t} catch ( e ) {\n\t\t\t\t\t\t\treturn {\n\t\t\t\t\t\t\t\tstate: \"parsererror\",\n\t\t\t\t\t\t\t\terror: conv ? e : \"No conversion from \" + prev + \" to \" + current\n\t\t\t\t\t\t\t};\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\treturn { state: \"success\", data: response };\n}\n\njQuery.extend( {\n\n\t// Counter for holding the number of active queries\n\tactive: 0,\n\n\t// Last-Modified header cache for next request\n\tlastModified: {},\n\tetag: {},\n\n\tajaxSettings: {\n\t\turl: location.href,\n\t\ttype: \"GET\",\n\t\tisLocal: rlocalProtocol.test( location.protocol ),\n\t\tglobal: true,\n\t\tprocessData: true,\n\t\tasync: true,\n\t\tcontentType: \"application/x-www-form-urlencoded; charset=UTF-8\",\n\n\t\t/*\n\t\ttimeout: 0,\n\t\tdata: null,\n\t\tdataType: null,\n\t\tusername: null,\n\t\tpassword: null,\n\t\tcache: null,\n\t\tthrows: false,\n\t\ttraditional: false,\n\t\theaders: {},\n\t\t*/\n\n\t\taccepts: {\n\t\t\t\"*\": allTypes,\n\t\t\ttext: \"text/plain\",\n\t\t\thtml: \"text/html\",\n\t\t\txml: \"application/xml, text/xml\",\n\t\t\tjson: \"application/json, text/javascript\"\n\t\t},\n\n\t\tcontents: {\n\t\t\txml: /\\bxml\\b/,\n\t\t\thtml: /\\bhtml/,\n\t\t\tjson: /\\bjson\\b/\n\t\t},\n\n\t\tresponseFields: {\n\t\t\txml: \"responseXML\",\n\t\t\ttext: \"responseText\",\n\t\t\tjson: \"responseJSON\"\n\t\t},\n\n\t\t// Data converters\n\t\t// Keys separate source (or catchall \"*\") and destination types with a single space\n\t\tconverters: {\n\n\t\t\t// Convert anything to text\n\t\t\t\"* text\": String,\n\n\t\t\t// Text to html (true = no transformation)\n\t\t\t\"text html\": true,\n\n\t\t\t// Evaluate text as a json expression\n\t\t\t\"text json\": JSON.parse,\n\n\t\t\t// Parse text as xml\n\t\t\t\"text xml\": jQuery.parseXML\n\t\t},\n\n\t\t// For options that shouldn't be deep extended:\n\t\t// you can add your own custom options here if\n\t\t// and when you create one that shouldn't be\n\t\t// deep extended (see ajaxExtend)\n\t\tflatOptions: {\n\t\t\turl: true,\n\t\t\tcontext: true\n\t\t}\n\t},\n\n\t// Creates a full fledged settings object into target\n\t// with both ajaxSettings and settings fields.\n\t// If target is omitted, writes into ajaxSettings.\n\tajaxSetup: function( target, settings ) {\n\t\treturn settings ?\n\n\t\t\t// Building a settings object\n\t\t\tajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) :\n\n\t\t\t// Extending ajaxSettings\n\t\t\tajaxExtend( jQuery.ajaxSettings, target );\n\t},\n\n\tajaxPrefilter: addToPrefiltersOrTransports( prefilters ),\n\tajaxTransport: addToPrefiltersOrTransports( transports ),\n\n\t// Main method\n\tajax: function( url, options ) {\n\n\t\t// If url is an object, simulate pre-1.5 signature\n\t\tif ( typeof url === \"object\" ) {\n\t\t\toptions = url;\n\t\t\turl = undefined;\n\t\t}\n\n\t\t// Force options to be an object\n\t\toptions = options || {};\n\n\t\tvar transport,\n\n\t\t\t// URL without anti-cache param\n\t\t\tcacheURL,\n\n\t\t\t// Response headers\n\t\t\tresponseHeadersString,\n\t\t\tresponseHeaders,\n\n\t\t\t// timeout handle\n\t\t\ttimeoutTimer,\n\n\t\t\t// Url cleanup var\n\t\t\turlAnchor,\n\n\t\t\t// Request state (becomes false upon send and true upon completion)\n\t\t\tcompleted,\n\n\t\t\t// To know if global events are to be dispatched\n\t\t\tfireGlobals,\n\n\t\t\t// Loop variable\n\t\t\ti,\n\n\t\t\t// uncached part of the url\n\t\t\tuncached,\n\n\t\t\t// Create the final options object\n\t\t\ts = jQuery.ajaxSetup( {}, options ),\n\n\t\t\t// Callbacks context\n\t\t\tcallbackContext = s.context || s,\n\n\t\t\t// Context for global events is callbackContext if it is a DOM node or jQuery collection\n\t\t\tglobalEventContext = s.context &&\n\t\t\t\t( callbackContext.nodeType || callbackContext.jquery ) ?\n\t\t\t\tjQuery( callbackContext ) :\n\t\t\t\tjQuery.event,\n\n\t\t\t// Deferreds\n\t\t\tdeferred = jQuery.Deferred(),\n\t\t\tcompleteDeferred = jQuery.Callbacks( \"once memory\" ),\n\n\t\t\t// Status-dependent callbacks\n\t\t\tstatusCode = s.statusCode || {},\n\n\t\t\t// Headers (they are sent all at once)\n\t\t\trequestHeaders = {},\n\t\t\trequestHeadersNames = {},\n\n\t\t\t// Default abort message\n\t\t\tstrAbort = \"canceled\",\n\n\t\t\t// Fake xhr\n\t\t\tjqXHR = {\n\t\t\t\treadyState: 0,\n\n\t\t\t\t// Builds headers hashtable if needed\n\t\t\t\tgetResponseHeader: function( key ) {\n\t\t\t\t\tvar match;\n\t\t\t\t\tif ( completed ) {\n\t\t\t\t\t\tif ( !responseHeaders ) {\n\t\t\t\t\t\t\tresponseHeaders = {};\n\t\t\t\t\t\t\twhile ( ( match = rheaders.exec( responseHeadersString ) ) ) {\n\t\t\t\t\t\t\t\tresponseHeaders[ match[ 1 ].toLowerCase() + \" \" ] =\n\t\t\t\t\t\t\t\t\t( responseHeaders[ match[ 1 ].toLowerCase() + \" \" ] || [] )\n\t\t\t\t\t\t\t\t\t\t.concat( match[ 2 ] );\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t\tmatch = responseHeaders[ key.toLowerCase() + \" \" ];\n\t\t\t\t\t}\n\t\t\t\t\treturn match == null ? null : match.join( \", \" );\n\t\t\t\t},\n\n\t\t\t\t// Raw string\n\t\t\t\tgetAllResponseHeaders: function() {\n\t\t\t\t\treturn completed ? responseHeadersString : null;\n\t\t\t\t},\n\n\t\t\t\t// Caches the header\n\t\t\t\tsetRequestHeader: function( name, value ) {\n\t\t\t\t\tif ( completed == null ) {\n\t\t\t\t\t\tname = requestHeadersNames[ name.toLowerCase() ] =\n\t\t\t\t\t\t\trequestHeadersNames[ name.toLowerCase() ] || name;\n\t\t\t\t\t\trequestHeaders[ name ] = value;\n\t\t\t\t\t}\n\t\t\t\t\treturn this;\n\t\t\t\t},\n\n\t\t\t\t// Overrides response content-type header\n\t\t\t\toverrideMimeType: function( type ) {\n\t\t\t\t\tif ( completed == null ) {\n\t\t\t\t\t\ts.mimeType = type;\n\t\t\t\t\t}\n\t\t\t\t\treturn this;\n\t\t\t\t},\n\n\t\t\t\t// Status-dependent callbacks\n\t\t\t\tstatusCode: function( map ) {\n\t\t\t\t\tvar code;\n\t\t\t\t\tif ( map ) {\n\t\t\t\t\t\tif ( completed ) {\n\n\t\t\t\t\t\t\t// Execute the appropriate callbacks\n\t\t\t\t\t\t\tjqXHR.always( map[ jqXHR.status ] );\n\t\t\t\t\t\t} else {\n\n\t\t\t\t\t\t\t// Lazy-add the new callbacks in a way that preserves old ones\n\t\t\t\t\t\t\tfor ( code in map ) {\n\t\t\t\t\t\t\t\tstatusCode[ code ] = [ statusCode[ code ], map[ code ] ];\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\treturn this;\n\t\t\t\t},\n\n\t\t\t\t// Cancel the request\n\t\t\t\tabort: function( statusText ) {\n\t\t\t\t\tvar finalText = statusText || strAbort;\n\t\t\t\t\tif ( transport ) {\n\t\t\t\t\t\ttransport.abort( finalText );\n\t\t\t\t\t}\n\t\t\t\t\tdone( 0, finalText );\n\t\t\t\t\treturn this;\n\t\t\t\t}\n\t\t\t};\n\n\t\t// Attach deferreds\n\t\tdeferred.promise( jqXHR );\n\n\t\t// Add protocol if not provided (prefilters might expect it)\n\t\t// Handle falsy url in the settings object (#10093: consistency with old signature)\n\t\t// We also use the url parameter if available\n\t\ts.url = ( ( url || s.url || location.href ) + \"\" )\n\t\t\t.replace( rprotocol, location.protocol + \"//\" );\n\n\t\t// Alias method option to type as per ticket #12004\n\t\ts.type = options.method || options.type || s.method || s.type;\n\n\t\t// Extract dataTypes list\n\t\ts.dataTypes = ( s.dataType || \"*\" ).toLowerCase().match( rnothtmlwhite ) || [ \"\" ];\n\n\t\t// A cross-domain request is in order when the origin doesn't match the current origin.\n\t\tif ( s.crossDomain == null ) {\n\t\t\turlAnchor = document.createElement( \"a\" );\n\n\t\t\t// Support: IE <=8 - 11, Edge 12 - 15\n\t\t\t// IE throws exception on accessing the href property if url is malformed,\n\t\t\t// e.g. http://example.com:80x/\n\t\t\ttry {\n\t\t\t\turlAnchor.href = s.url;\n\n\t\t\t\t// Support: IE <=8 - 11 only\n\t\t\t\t// Anchor's host property isn't correctly set when s.url is relative\n\t\t\t\turlAnchor.href = urlAnchor.href;\n\t\t\t\ts.crossDomain = originAnchor.protocol + \"//\" + originAnchor.host !==\n\t\t\t\t\turlAnchor.protocol + \"//\" + urlAnchor.host;\n\t\t\t} catch ( e ) {\n\n\t\t\t\t// If there is an error parsing the URL, assume it is crossDomain,\n\t\t\t\t// it can be rejected by the transport if it is invalid\n\t\t\t\ts.crossDomain = true;\n\t\t\t}\n\t\t}\n\n\t\t// Convert data if not already a string\n\t\tif ( s.data && s.processData && typeof s.data !== \"string\" ) {\n\t\t\ts.data = jQuery.param( s.data, s.traditional );\n\t\t}\n\n\t\t// Apply prefilters\n\t\tinspectPrefiltersOrTransports( prefilters, s, options, jqXHR );\n\n\t\t// If request was aborted inside a prefilter, stop there\n\t\tif ( completed ) {\n\t\t\treturn jqXHR;\n\t\t}\n\n\t\t// We can fire global events as of now if asked to\n\t\t// Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118)\n\t\tfireGlobals = jQuery.event && s.global;\n\n\t\t// Watch for a new set of requests\n\t\tif ( fireGlobals && jQuery.active++ === 0 ) {\n\t\t\tjQuery.event.trigger( \"ajaxStart\" );\n\t\t}\n\n\t\t// Uppercase the type\n\t\ts.type = s.type.toUpperCase();\n\n\t\t// Determine if request has content\n\t\ts.hasContent = !rnoContent.test( s.type );\n\n\t\t// Save the URL in case we're toying with the If-Modified-Since\n\t\t// and/or If-None-Match header later on\n\t\t// Remove hash to simplify url manipulation\n\t\tcacheURL = s.url.replace( rhash, \"\" );\n\n\t\t// More options handling for requests with no content\n\t\tif ( !s.hasContent ) {\n\n\t\t\t// Remember the hash so we can put it back\n\t\t\tuncached = s.url.slice( cacheURL.length );\n\n\t\t\t// If data is available and should be processed, append data to url\n\t\t\tif ( s.data && ( s.processData || typeof s.data === \"string\" ) ) {\n\t\t\t\tcacheURL += ( rquery.test( cacheURL ) ? \"&\" : \"?\" ) + s.data;\n\n\t\t\t\t// #9682: remove data so that it's not used in an eventual retry\n\t\t\t\tdelete s.data;\n\t\t\t}\n\n\t\t\t// Add or update anti-cache param if needed\n\t\t\tif ( s.cache === false ) {\n\t\t\t\tcacheURL = cacheURL.replace( rantiCache, \"$1\" );\n\t\t\t\tuncached = ( rquery.test( cacheURL ) ? \"&\" : \"?\" ) + \"_=\" + ( nonce.guid++ ) +\n\t\t\t\t\tuncached;\n\t\t\t}\n\n\t\t\t// Put hash and anti-cache on the URL that will be requested (gh-1732)\n\t\t\ts.url = cacheURL + uncached;\n\n\t\t// Change '%20' to '+' if this is encoded form body content (gh-2658)\n\t\t} else if ( s.data && s.processData &&\n\t\t\t( s.contentType || \"\" ).indexOf( \"application/x-www-form-urlencoded\" ) === 0 ) {\n\t\t\ts.data = s.data.replace( r20, \"+\" );\n\t\t}\n\n\t\t// Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.\n\t\tif ( s.ifModified ) {\n\t\t\tif ( jQuery.lastModified[ cacheURL ] ) {\n\t\t\t\tjqXHR.setRequestHeader( \"If-Modified-Since\", jQuery.lastModified[ cacheURL ] );\n\t\t\t}\n\t\t\tif ( jQuery.etag[ cacheURL ] ) {\n\t\t\t\tjqXHR.setRequestHeader( \"If-None-Match\", jQuery.etag[ cacheURL ] );\n\t\t\t}\n\t\t}\n\n\t\t// Set the correct header, if data is being sent\n\t\tif ( s.data && s.hasContent && s.contentType !== false || options.contentType ) {\n\t\t\tjqXHR.setRequestHeader( \"Content-Type\", s.contentType );\n\t\t}\n\n\t\t// Set the Accepts header for the server, depending on the dataType\n\t\tjqXHR.setRequestHeader(\n\t\t\t\"Accept\",\n\t\t\ts.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ?\n\t\t\t\ts.accepts[ s.dataTypes[ 0 ] ] +\n\t\t\t\t\t( s.dataTypes[ 0 ] !== \"*\" ? \", \" + allTypes + \"; q=0.01\" : \"\" ) :\n\t\t\t\ts.accepts[ \"*\" ]\n\t\t);\n\n\t\t// Check for headers option\n\t\tfor ( i in s.headers ) {\n\t\t\tjqXHR.setRequestHeader( i, s.headers[ i ] );\n\t\t}\n\n\t\t// Allow custom headers/mimetypes and early abort\n\t\tif ( s.beforeSend &&\n\t\t\t( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) {\n\n\t\t\t// Abort if not done already and return\n\t\t\treturn jqXHR.abort();\n\t\t}\n\n\t\t// Aborting is no longer a cancellation\n\t\tstrAbort = \"abort\";\n\n\t\t// Install callbacks on deferreds\n\t\tcompleteDeferred.add( s.complete );\n\t\tjqXHR.done( s.success );\n\t\tjqXHR.fail( s.error );\n\n\t\t// Get transport\n\t\ttransport = inspectPrefiltersOrTransports( transports, s, options, jqXHR );\n\n\t\t// If no transport, we auto-abort\n\t\tif ( !transport ) {\n\t\t\tdone( -1, \"No Transport\" );\n\t\t} else {\n\t\t\tjqXHR.readyState = 1;\n\n\t\t\t// Send global event\n\t\t\tif ( fireGlobals ) {\n\t\t\t\tglobalEventContext.trigger( \"ajaxSend\", [ jqXHR, s ] );\n\t\t\t}\n\n\t\t\t// If request was aborted inside ajaxSend, stop there\n\t\t\tif ( completed ) {\n\t\t\t\treturn jqXHR;\n\t\t\t}\n\n\t\t\t// Timeout\n\t\t\tif ( s.async && s.timeout > 0 ) {\n\t\t\t\ttimeoutTimer = window.setTimeout( function() {\n\t\t\t\t\tjqXHR.abort( \"timeout\" );\n\t\t\t\t}, s.timeout );\n\t\t\t}\n\n\t\t\ttry {\n\t\t\t\tcompleted = false;\n\t\t\t\ttransport.send( requestHeaders, done );\n\t\t\t} catch ( e ) {\n\n\t\t\t\t// Rethrow post-completion exceptions\n\t\t\t\tif ( completed ) {\n\t\t\t\t\tthrow e;\n\t\t\t\t}\n\n\t\t\t\t// Propagate others as results\n\t\t\t\tdone( -1, e );\n\t\t\t}\n\t\t}\n\n\t\t// Callback for when everything is done\n\t\tfunction done( status, nativeStatusText, responses, headers ) {\n\t\t\tvar isSuccess, success, error, response, modified,\n\t\t\t\tstatusText = nativeStatusText;\n\n\t\t\t// Ignore repeat invocations\n\t\t\tif ( completed ) {\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tcompleted = true;\n\n\t\t\t// Clear timeout if it exists\n\t\t\tif ( timeoutTimer ) {\n\t\t\t\twindow.clearTimeout( timeoutTimer );\n\t\t\t}\n\n\t\t\t// Dereference transport for early garbage collection\n\t\t\t// (no matter how long the jqXHR object will be used)\n\t\t\ttransport = undefined;\n\n\t\t\t// Cache response headers\n\t\t\tresponseHeadersString = headers || \"\";\n\n\t\t\t// Set readyState\n\t\t\tjqXHR.readyState = status > 0 ? 4 : 0;\n\n\t\t\t// Determine if successful\n\t\t\tisSuccess = status >= 200 && status < 300 || status === 304;\n\n\t\t\t// Get response data\n\t\t\tif ( responses ) {\n\t\t\t\tresponse = ajaxHandleResponses( s, jqXHR, responses );\n\t\t\t}\n\n\t\t\t// Use a noop converter for missing script but not if jsonp\n\t\t\tif ( !isSuccess &&\n\t\t\t\tjQuery.inArray( \"script\", s.dataTypes ) > -1 &&\n\t\t\t\tjQuery.inArray( \"json\", s.dataTypes ) < 0 ) {\n\t\t\t\ts.converters[ \"text script\" ] = function() {};\n\t\t\t}\n\n\t\t\t// Convert no matter what (that way responseXXX fields are always set)\n\t\t\tresponse = ajaxConvert( s, response, jqXHR, isSuccess );\n\n\t\t\t// If successful, handle type chaining\n\t\t\tif ( isSuccess ) {\n\n\t\t\t\t// Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.\n\t\t\t\tif ( s.ifModified ) {\n\t\t\t\t\tmodified = jqXHR.getResponseHeader( \"Last-Modified\" );\n\t\t\t\t\tif ( modified ) {\n\t\t\t\t\t\tjQuery.lastModified[ cacheURL ] = modified;\n\t\t\t\t\t}\n\t\t\t\t\tmodified = jqXHR.getResponseHeader( \"etag\" );\n\t\t\t\t\tif ( modified ) {\n\t\t\t\t\t\tjQuery.etag[ cacheURL ] = modified;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// if no content\n\t\t\t\tif ( status === 204 || s.type === \"HEAD\" ) {\n\t\t\t\t\tstatusText = \"nocontent\";\n\n\t\t\t\t// if not modified\n\t\t\t\t} else if ( status === 304 ) {\n\t\t\t\t\tstatusText = \"notmodified\";\n\n\t\t\t\t// If we have data, let's convert it\n\t\t\t\t} else {\n\t\t\t\t\tstatusText = response.state;\n\t\t\t\t\tsuccess = response.data;\n\t\t\t\t\terror = response.error;\n\t\t\t\t\tisSuccess = !error;\n\t\t\t\t}\n\t\t\t} else {\n\n\t\t\t\t// Extract error from statusText and normalize for non-aborts\n\t\t\t\terror = statusText;\n\t\t\t\tif ( status || !statusText ) {\n\t\t\t\t\tstatusText = \"error\";\n\t\t\t\t\tif ( status < 0 ) {\n\t\t\t\t\t\tstatus = 0;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Set data for the fake xhr object\n\t\t\tjqXHR.status = status;\n\t\t\tjqXHR.statusText = ( nativeStatusText || statusText ) + \"\";\n\n\t\t\t// Success/Error\n\t\t\tif ( isSuccess ) {\n\t\t\t\tdeferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] );\n\t\t\t} else {\n\t\t\t\tdeferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] );\n\t\t\t}\n\n\t\t\t// Status-dependent callbacks\n\t\t\tjqXHR.statusCode( statusCode );\n\t\t\tstatusCode = undefined;\n\n\t\t\tif ( fireGlobals ) {\n\t\t\t\tglobalEventContext.trigger( isSuccess ? \"ajaxSuccess\" : \"ajaxError\",\n\t\t\t\t\t[ jqXHR, s, isSuccess ? success : error ] );\n\t\t\t}\n\n\t\t\t// Complete\n\t\t\tcompleteDeferred.fireWith( callbackContext, [ jqXHR, statusText ] );\n\n\t\t\tif ( fireGlobals ) {\n\t\t\t\tglobalEventContext.trigger( \"ajaxComplete\", [ jqXHR, s ] );\n\n\t\t\t\t// Handle the global AJAX counter\n\t\t\t\tif ( !( --jQuery.active ) ) {\n\t\t\t\t\tjQuery.event.trigger( \"ajaxStop\" );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn jqXHR;\n\t},\n\n\tgetJSON: function( url, data, callback ) {\n\t\treturn jQuery.get( url, data, callback, \"json\" );\n\t},\n\n\tgetScript: function( url, callback ) {\n\t\treturn jQuery.get( url, undefined, callback, \"script\" );\n\t}\n} );\n\njQuery.each( [ \"get\", \"post\" ], function( _i, method ) {\n\tjQuery[ method ] = function( url, data, callback, type ) {\n\n\t\t// Shift arguments if data argument was omitted\n\t\tif ( isFunction( data ) ) {\n\t\t\ttype = type || callback;\n\t\t\tcallback = data;\n\t\t\tdata = undefined;\n\t\t}\n\n\t\t// The url can be an options object (which then must have .url)\n\t\treturn jQuery.ajax( jQuery.extend( {\n\t\t\turl: url,\n\t\t\ttype: method,\n\t\t\tdataType: type,\n\t\t\tdata: data,\n\t\t\tsuccess: callback\n\t\t}, jQuery.isPlainObject( url ) && url ) );\n\t};\n} );\n\njQuery.ajaxPrefilter( function( s ) {\n\tvar i;\n\tfor ( i in s.headers ) {\n\t\tif ( i.toLowerCase() === \"content-type\" ) {\n\t\t\ts.contentType = s.headers[ i ] || \"\";\n\t\t}\n\t}\n} );\n\n\njQuery._evalUrl = function( url, options, doc ) {\n\treturn jQuery.ajax( {\n\t\turl: url,\n\n\t\t// Make this explicit, since user can override this through ajaxSetup (#11264)\n\t\ttype: \"GET\",\n\t\tdataType: \"script\",\n\t\tcache: true,\n\t\tasync: false,\n\t\tglobal: false,\n\n\t\t// Only evaluate the response if it is successful (gh-4126)\n\t\t// dataFilter is not invoked for failure responses, so using it instead\n\t\t// of the default converter is kludgy but it works.\n\t\tconverters: {\n\t\t\t\"text script\": function() {}\n\t\t},\n\t\tdataFilter: function( response ) {\n\t\t\tjQuery.globalEval( response, options, doc );\n\t\t}\n\t} );\n};\n\n\njQuery.fn.extend( {\n\twrapAll: function( html ) {\n\t\tvar wrap;\n\n\t\tif ( this[ 0 ] ) {\n\t\t\tif ( isFunction( html ) ) {\n\t\t\t\thtml = html.call( this[ 0 ] );\n\t\t\t}\n\n\t\t\t// The elements to wrap the target around\n\t\t\twrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true );\n\n\t\t\tif ( this[ 0 ].parentNode ) {\n\t\t\t\twrap.insertBefore( this[ 0 ] );\n\t\t\t}\n\n\t\t\twrap.map( function() {\n\t\t\t\tvar elem = this;\n\n\t\t\t\twhile ( elem.firstElementChild ) {\n\t\t\t\t\telem = elem.firstElementChild;\n\t\t\t\t}\n\n\t\t\t\treturn elem;\n\t\t\t} ).append( this );\n\t\t}\n\n\t\treturn this;\n\t},\n\n\twrapInner: function( html ) {\n\t\tif ( isFunction( html ) ) {\n\t\t\treturn this.each( function( i ) {\n\t\t\t\tjQuery( this ).wrapInner( html.call( this, i ) );\n\t\t\t} );\n\t\t}\n\n\t\treturn this.each( function() {\n\t\t\tvar self = jQuery( this ),\n\t\t\t\tcontents = self.contents();\n\n\t\t\tif ( contents.length ) {\n\t\t\t\tcontents.wrapAll( html );\n\n\t\t\t} else {\n\t\t\t\tself.append( html );\n\t\t\t}\n\t\t} );\n\t},\n\n\twrap: function( html ) {\n\t\tvar htmlIsFunction = isFunction( html );\n\n\t\treturn this.each( function( i ) {\n\t\t\tjQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html );\n\t\t} );\n\t},\n\n\tunwrap: function( selector ) {\n\t\tthis.parent( selector ).not( \"body\" ).each( function() {\n\t\t\tjQuery( this ).replaceWith( this.childNodes );\n\t\t} );\n\t\treturn this;\n\t}\n} );\n\n\njQuery.expr.pseudos.hidden = function( elem ) {\n\treturn !jQuery.expr.pseudos.visible( elem );\n};\njQuery.expr.pseudos.visible = function( elem ) {\n\treturn !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length );\n};\n\n\n\n\njQuery.ajaxSettings.xhr = function() {\n\ttry {\n\t\treturn new window.XMLHttpRequest();\n\t} catch ( e ) {}\n};\n\nvar xhrSuccessStatus = {\n\n\t\t// File protocol always yields status code 0, assume 200\n\t\t0: 200,\n\n\t\t// Support: IE <=9 only\n\t\t// #1450: sometimes IE returns 1223 when it should be 204\n\t\t1223: 204\n\t},\n\txhrSupported = jQuery.ajaxSettings.xhr();\n\nsupport.cors = !!xhrSupported && ( \"withCredentials\" in xhrSupported );\nsupport.ajax = xhrSupported = !!xhrSupported;\n\njQuery.ajaxTransport( function( options ) {\n\tvar callback, errorCallback;\n\n\t// Cross domain only allowed if supported through XMLHttpRequest\n\tif ( support.cors || xhrSupported && !options.crossDomain ) {\n\t\treturn {\n\t\t\tsend: function( headers, complete ) {\n\t\t\t\tvar i,\n\t\t\t\t\txhr = options.xhr();\n\n\t\t\t\txhr.open(\n\t\t\t\t\toptions.type,\n\t\t\t\t\toptions.url,\n\t\t\t\t\toptions.async,\n\t\t\t\t\toptions.username,\n\t\t\t\t\toptions.password\n\t\t\t\t);\n\n\t\t\t\t// Apply custom fields if provided\n\t\t\t\tif ( options.xhrFields ) {\n\t\t\t\t\tfor ( i in options.xhrFields ) {\n\t\t\t\t\t\txhr[ i ] = options.xhrFields[ i ];\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// Override mime type if needed\n\t\t\t\tif ( options.mimeType && xhr.overrideMimeType ) {\n\t\t\t\t\txhr.overrideMimeType( options.mimeType );\n\t\t\t\t}\n\n\t\t\t\t// X-Requested-With header\n\t\t\t\t// For cross-domain requests, seeing as conditions for a preflight are\n\t\t\t\t// akin to a jigsaw puzzle, we simply never set it to be sure.\n\t\t\t\t// (it can always be set on a per-request basis or even using ajaxSetup)\n\t\t\t\t// For same-domain requests, won't change header if already provided.\n\t\t\t\tif ( !options.crossDomain && !headers[ \"X-Requested-With\" ] ) {\n\t\t\t\t\theaders[ \"X-Requested-With\" ] = \"XMLHttpRequest\";\n\t\t\t\t}\n\n\t\t\t\t// Set headers\n\t\t\t\tfor ( i in headers ) {\n\t\t\t\t\txhr.setRequestHeader( i, headers[ i ] );\n\t\t\t\t}\n\n\t\t\t\t// Callback\n\t\t\t\tcallback = function( type ) {\n\t\t\t\t\treturn function() {\n\t\t\t\t\t\tif ( callback ) {\n\t\t\t\t\t\t\tcallback = errorCallback = xhr.onload =\n\t\t\t\t\t\t\t\txhr.onerror = xhr.onabort = xhr.ontimeout =\n\t\t\t\t\t\t\t\t\txhr.onreadystatechange = null;\n\n\t\t\t\t\t\t\tif ( type === \"abort\" ) {\n\t\t\t\t\t\t\t\txhr.abort();\n\t\t\t\t\t\t\t} else if ( type === \"error\" ) {\n\n\t\t\t\t\t\t\t\t// Support: IE <=9 only\n\t\t\t\t\t\t\t\t// On a manual native abort, IE9 throws\n\t\t\t\t\t\t\t\t// errors on any property access that is not readyState\n\t\t\t\t\t\t\t\tif ( typeof xhr.status !== \"number\" ) {\n\t\t\t\t\t\t\t\t\tcomplete( 0, \"error\" );\n\t\t\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\t\t\tcomplete(\n\n\t\t\t\t\t\t\t\t\t\t// File: protocol always yields status 0; see #8605, #14207\n\t\t\t\t\t\t\t\t\t\txhr.status,\n\t\t\t\t\t\t\t\t\t\txhr.statusText\n\t\t\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\t\tcomplete(\n\t\t\t\t\t\t\t\t\txhrSuccessStatus[ xhr.status ] || xhr.status,\n\t\t\t\t\t\t\t\t\txhr.statusText,\n\n\t\t\t\t\t\t\t\t\t// Support: IE <=9 only\n\t\t\t\t\t\t\t\t\t// IE9 has no XHR2 but throws on binary (trac-11426)\n\t\t\t\t\t\t\t\t\t// For XHR2 non-text, let the caller handle it (gh-2498)\n\t\t\t\t\t\t\t\t\t( xhr.responseType || \"text\" ) !== \"text\" ||\n\t\t\t\t\t\t\t\t\ttypeof xhr.responseText !== \"string\" ?\n\t\t\t\t\t\t\t\t\t\t{ binary: xhr.response } :\n\t\t\t\t\t\t\t\t\t\t{ text: xhr.responseText },\n\t\t\t\t\t\t\t\t\txhr.getAllResponseHeaders()\n\t\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t};\n\t\t\t\t};\n\n\t\t\t\t// Listen to events\n\t\t\t\txhr.onload = callback();\n\t\t\t\terrorCallback = xhr.onerror = xhr.ontimeout = callback( \"error\" );\n\n\t\t\t\t// Support: IE 9 only\n\t\t\t\t// Use onreadystatechange to replace onabort\n\t\t\t\t// to handle uncaught aborts\n\t\t\t\tif ( xhr.onabort !== undefined ) {\n\t\t\t\t\txhr.onabort = errorCallback;\n\t\t\t\t} else {\n\t\t\t\t\txhr.onreadystatechange = function() {\n\n\t\t\t\t\t\t// Check readyState before timeout as it changes\n\t\t\t\t\t\tif ( xhr.readyState === 4 ) {\n\n\t\t\t\t\t\t\t// Allow onerror to be called first,\n\t\t\t\t\t\t\t// but that will not handle a native abort\n\t\t\t\t\t\t\t// Also, save errorCallback to a variable\n\t\t\t\t\t\t\t// as xhr.onerror cannot be accessed\n\t\t\t\t\t\t\twindow.setTimeout( function() {\n\t\t\t\t\t\t\t\tif ( callback ) {\n\t\t\t\t\t\t\t\t\terrorCallback();\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t} );\n\t\t\t\t\t\t}\n\t\t\t\t\t};\n\t\t\t\t}\n\n\t\t\t\t// Create the abort callback\n\t\t\t\tcallback = callback( \"abort\" );\n\n\t\t\t\ttry {\n\n\t\t\t\t\t// Do send the request (this may raise an exception)\n\t\t\t\t\txhr.send( options.hasContent && options.data || null );\n\t\t\t\t} catch ( e ) {\n\n\t\t\t\t\t// #14683: Only rethrow if this hasn't been notified as an error yet\n\t\t\t\t\tif ( callback ) {\n\t\t\t\t\t\tthrow e;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\n\t\t\tabort: function() {\n\t\t\t\tif ( callback ) {\n\t\t\t\t\tcallback();\n\t\t\t\t}\n\t\t\t}\n\t\t};\n\t}\n} );\n\n\n\n\n// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432)\njQuery.ajaxPrefilter( function( s ) {\n\tif ( s.crossDomain ) {\n\t\ts.contents.script = false;\n\t}\n} );\n\n// Install script dataType\njQuery.ajaxSetup( {\n\taccepts: {\n\t\tscript: \"text/javascript, application/javascript, \" +\n\t\t\t\"application/ecmascript, application/x-ecmascript\"\n\t},\n\tcontents: {\n\t\tscript: /\\b(?:java|ecma)script\\b/\n\t},\n\tconverters: {\n\t\t\"text script\": function( text ) {\n\t\t\tjQuery.globalEval( text );\n\t\t\treturn text;\n\t\t}\n\t}\n} );\n\n// Handle cache's special case and crossDomain\njQuery.ajaxPrefilter( \"script\", function( s ) {\n\tif ( s.cache === undefined ) {\n\t\ts.cache = false;\n\t}\n\tif ( s.crossDomain ) {\n\t\ts.type = \"GET\";\n\t}\n} );\n\n// Bind script tag hack transport\njQuery.ajaxTransport( \"script\", function( s ) {\n\n\t// This transport only deals with cross domain or forced-by-attrs requests\n\tif ( s.crossDomain || s.scriptAttrs ) {\n\t\tvar script, callback;\n\t\treturn {\n\t\t\tsend: function( _, complete ) {\n\t\t\t\tscript = jQuery( \"\n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • averagingModel command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

averagingModel command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
averagingModel model;\n
\n
\n
    \n

  • model = name of averaging model to be applied

    • \n
\n
\n
\n

Examples

\n
averagingModel dense;\naveragingModel dilute;\n
\n
\n
\n

Note

\n

This examples list might not be complete - please have a look for other averaging models (averagingModel_XY) in this documentation.

\n
\n
\n
\n

Description

\n

The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. particle velocities).

\n
\n
\n

Restrictions

\n

None.

\n
\n
\n

Related commands

\n

dense, dilute

\n

Default: none

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/averagingModel_dense.html", "content": "\n\n\n \n\n \n averagingModel_dense command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • averagingModel_dense command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

averagingModel_dense command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
averagingModel dense;\n
\n
\n
\n
\n

Examples

\n
averagingModel dense;\n
\n
\n
\n
\n

Description

\n

The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. particle velocities). In the “cfdemParticle cloud” this averaging model is used to calculate the average particle velocity inside a CFD cell. The “dense” model is supposed to be applied to cases where the granular regime is rather dense.

\n
\n
\n

Restrictions

\n

No known restrictions.

\n
\n
\n

Related commands

\n

averagingModel, dilute

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/averagingModel_dilute.html", "content": "\n\n\n \n\n \n averagingModel_dilute command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • averagingModel_dilute command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

averagingModel_dilute command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
averagingModel dilute;\n
\n
\n
\n
\n

Examples

\n
averagingModel dilute;\n
\n
\n
\n
\n

Description

\n

The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. particle velocities).\nIn the “cfdemParticle cloud” this averaging model is used to calculate the average particle velocity inside a CFD cell. The “dilute” model is supposed to be applied to cases where the granular regime is rather dilute. The particle velocity inside a CFD cell is evaluated from a single particle in a cell (no averaging).

\n
\n
\n

Restrictions

\n

This model is computationally efficient, but should only be used when only one particle is inside one CFD cell.

\n
\n
\n

Related commands

\n

averagingModel, dense

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/cfdemSolverIB.html", "content": "\n\n\n \n\n \n cfdemSolverIB command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • cfdemSolverIB command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

cfdemSolverIB command

\n
\n

Description

\n

“cfdemSolverIB” is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework, for calculating\nthe dynamics between immersed bodies and the surrounding fluid. Being an implementation of an immersed boundary method it allows tackling problems where the body diameter exceeds the maximal size of a fluid cell. Using the toolbox of OpenFOAM®(*) the governing equations of the fluid are computed and the corrections of velocity and pressure field with respect to the body-movement information, gained from LIGGGHTS, are incorporated.

\n

Code of this solver contributions by Alice Hager, JKU.

\n

Algorithm:

\n

For each time step …

\n
    \n

  • the motion of the spheres is calculated (position, velocity, angular velocity, force…) with LIGGGHTS using the velocity and pressure-field from the previous time step (initial condition for t=0).

    • \n

  • the Navier-Stokes equations are solved on the whole computational domain, disregarding the solid phase.

    • \n

  • the spheres are located within the mesh: each sphere is represented by a cluster of cells, which are either totally or partially covered by the body, depending on its exact position.

    • \n

  • the correction of the velocity and pressure field of the fluid phase takes place, using the information about the location of the spheres and their (angular) velocity.

    • \n
\n

Use:

\n

The solver is realized within the Open Source framework CFDEMcoupling. Just as for the unresolved CFD-DEM solver cfdemSolverPiso the file CFD/constant/couplingProperties contains information about the settings for the different models. While IOmodel, DataExchangeModel etc. are applicable for all CFDEMcoupling-solvers, special locate-, force- and void fraction models were designed for the present case:

\n

engineSearchIB, ArchimedesIB, ShirgaonkarIB, IBVoidfraction

\n

References:

\n

GONIVA, C., KLOSS, C., HAGER,A., WIERINK, G. and PIRKER, S. (2011): “A MULTI-PURPOSE OPEN SOURCE CFD-DEM APPROACH”, Proc. of the 8th Int. Conf. on CFD in Oil and Gas, Metallurgical and Process Industries, Trondheim, Norway

\n

and

\n

HAGER, A., KLOSS, C. and GONIVA, C. (2011): “TOWARDS AN EFFICIENT IMMERSED BOUNDARY METHOD WITHIN AN OPEN SOURCE FRAMEWORK”, Proc. of the 8th Int. Conf. on CFD in Oil and Gas, Metallurgical and Process Industries, Trondheim, Norway

\n
\n

(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks.

\n
\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/cfdemSolverPiso.html", "content": "\n\n\n \n\n \n cfdemSolverPiso command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • cfdemSolverPiso command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

cfdemSolverPiso command

\n
\n

Description

\n

“cfdemSolverPiso” is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam®(*), a finite volume based solver for turbulent Navier-Stokes equations applying the PISO algorithm, “cfdemSolverPiso” has additional functionality for a coupling to the DEM code “LIGGGHTS”. The volume averaged Navier-Stokes Equations are solved accounting for momentum exchange and volume displacement of discrete particles whose trajectories are calculated in the DEM code LIGGGHTS.

\n

see:

\n

GONIVA, C., KLOSS, C., HAGER,A. and PIRKER, S. (2010): “An Open Source CFD-DEM Perspective”, Proc. of OpenFOAM Workshop, Göteborg, June 22.-24.

\n
\n

(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks.

\n
\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/cfdemSolverPisoSTM.html", "content": "\n\n\n \n\n \n cfdemSolverPisoSTM command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • cfdemSolverPisoSTM command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

cfdemSolverPisoSTM command

\n
\n

Description

\n

“cfdemSolverPisoSTM” is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam®(*), a finite volume based solver for turbulent Navier-Stokes equations applying PISO algorithm, “cfdemSolverPisoSTM” has additional functionality for a coupling to the DEM code “LIGGGHTS” as well as a scalar transport equation. The volume averaged Navier-Stokes Equations are solved accounting for momentum exchange and volume displacement of discrete particles, whose trajectories are calculated in the DEM code LIGGGHTS. Scalar transport equations coupled to scalar properties of the particle phase, (e.g. convective heat transfer) in a fluid granular system can be modeled with “cfdemSolverPisoSTM”.

\n

see:

\n

GONIVA, C., KLOSS, C., HAGER,A. and PIRKER, S. (2010): “An Open Source CFD-DEM Perspective”, Proc. of OpenFOAM Workshop, Göteborg, June 22.-24.

\n
\n

(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks.

\n
\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/cfdemSolverPisoScalar.html", "content": "\n\n\n \n\n \n cfdemSolverPisoScalar command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • cfdemSolverPisoScalar command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

cfdemSolverPisoScalar command

\n
\n

Description

\n

“cfdemSolverPisoScalar” is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam®(*), a finite volume based solver for turbulent Navier-Stokes equations applying PISO algorithm, “cfdemSolverPisoScalar” has additional functionality for a coupling to the DEM code “LIGGGHTS” as well as a scalar transport equation. The volume averaged Navier-Stokes Equations are solved accounting for momentum exchange and volume displacement of discrete particles, whose trajectories are calculated in the DEM code LIGGGHTS. The scalar transport equation is coupled to scalar properties of the particle phase, thus convective heat transfer in a fluid granular system can be modeled with “cfdemSolverPisoScalar”.

\n

The transport equation uses a field “alphat” to calculate local kinematic turbulent thermal conductivities based on the laminar and turbulent Prandtl numbers. There can be source terms with the field Tsource and radiation.

\n

Necessary additional input is:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name

location

type

unit

T

0

scalar field

K

Tsource

0

scalar field

K/s

alphat

0

scalar field

m²/s

Pr

transportProperties

scalar

1

Prt

transportProperties

scalar

1

\n

The transport equation is:

\n

alphat = nut/Prt

\n

alphaEff = nu/Pr + alphat

\n

d(voidfraction*T)/dt + div(phi*T) - div(alphaEff*voidfraction grad(T)) = Tsource + SourceRadiation

\n

see:

\n

GONIVA, C., KLOSS, C., HAGER,A. and PIRKER, S. (2010): “An Open Source CFD-DEM Perspective”, Proc. of OpenFOAM Workshop, Göteborg, June 22.-24.

\n

The heat transfer equation is implemented according to Nield & Bejan (2013), Convection in Porous Media, DOI 10.1007/978-1-3.8.14-5541-7_2, Springer

\n
\n

(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks.

\n
\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/clockModel.html", "content": "\n\n\n \n\n \n clockModel command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • clockModel command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

clockModel command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
clockModel model;\n
\n
\n
    \n

  • model = name of the clockModel to be applied

    • \n
\n
\n
\n

Examples

\n
clockModel standardClock;\n
\n
\n
\n

Note

\n

This examples list might not be complete - please look for other models (clockModel_XY) in this documentation.

\n
\n
\n
\n

Description

\n

The clockModel is the base class for models to examine the code/algorithm with respect to run time.

\n

Main parts of the clockModel classes are written by Josef Kerbl, JKU.

\n
\n
\n

Restrictions

\n
\n

none.

\n
\n

Default: none.

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/clockModel_noClock.html", "content": "\n\n\n \n\n \n clockModel_noClock command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • clockModel_noClock command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

clockModel_noClock command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
clockModel off;\n
\n
\n
\n
\n

Examples

\n
clockModel off;\n
\n
\n
\n
\n

Description

\n

The “noClock” model is a dummy clockModel model which does not measure/evaluate the run time.

\n
\n
\n

Restrictions

\n
\n

none.

\n
\n
\n
\n

Related commands

\n

clockModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/clockModel_standardClock.html", "content": "\n\n\n \n\n \n clockModel_standardClock command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • clockModel_standardClock command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

clockModel_standardClock command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
clockModel standardClock;\n
\n
\n
\n
\n

Examples

\n
clockModel standardClock;\n
\n
\n
\n
\n

Description

\n

The “standardClock” model is a basic clockModel model which measures the run time between every “.start(int arrayPos,string name)” and “.stop(string name)” statement placed in the code. If a “.start(name)” is called more than once (e.g. in a loop) the accumulated times are calculated. After the simulation has finished, the data is stored in $caseDir/CFD/clockData/$startTime/*.txt .\nSince the measurements are stored in an array, it is necessary to put a variable arrayPos (type integer) at the start command. Those do not need to be in ascending order and positions may be omitted. The standard size of this array is 30 and can be changed at the initialization of the standardClock class. If arrayPos is out of bounds, the array size will be doubled. The stop command does not need arrayPos, since the class remembers the positions. The string name is intended for easier evaluation afterwards an may be omitted like “.start(int arrayPos)” and “.stop()”. The command “.stop(string name)” is a safety feature, because if the name is not equal to the started name, output will be produced for information.\nAfter the case ran you may use the matPlot.py script located in $CFDEM_UT_DIR/vizClock/ to produce a graphical output of your measurements. The usage is like ‘python < matPlot.py’ and you have to be in the directory of the desired time step, where there is a file called “timeEvalFull.txt”, which contains averaged and maximum data with respect to the number of processes. There is an alias called “vizClock” to run this python routine for visualizing the data.

\n
\n
\n

Restrictions

\n
\n

none.

\n
\n
\n
\n

Related commands

\n

clockModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/dataExchangeModel.html", "content": "\n\n\n \n\n \n dataExchangeModel command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • dataExchangeModel command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

dataExchangeModel command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
dataExchangeModel model;\n
\n
\n
    \n

  • model = name of data exchange model to be applied

    • \n
\n
\n
\n

Examples

\n
dataExchangeModel twoWayFiles;\ndataExchangeModel twoWayMPI;\n
\n
\n
\n

Note

\n

This examples list might not be complete - please look for other models (dataExchangeModel_XY) in this documentation.

\n
\n
\n
\n

Description

\n

The data exchange model performs the data exchange between LIGGGHTS® and the cfdemCloud within CFDEM®coupling toolbox. The exchanged data at least consits of positions, radii, velocities and forces.

\n

The twoWayMPI model is considered as the standard model, whereas the file-exchange is much slower and its purpose is debugging.

\n
\n
\n

Restrictions

\n

None.

\n
\n
\n

Related commands

\n

noDataExchange, oneWayVTK, twoWayFiles, twoWayMPI

\n

Default: none

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/dataExchangeModel_noDataExchange.html", "content": "\n\n\n \n\n \n dataExchangeModel_noDataExchange command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • dataExchangeModel_noDataExchange command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

dataExchangeModel_noDataExchange command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
dataExchangeModel noDataExchange;\n
\n
\n
\n
\n

Examples

\n
dataExchangeModel noDataExchange;\n
\n
\n
\n
\n

Description

\n

The data exchange model performs the data exchange between the DEM code and the CFD code. The noDataExchange model is a dummy model where no data is exchanged.

\n
\n
\n

Restrictions

\n

None.

\n
\n
\n

Related commands

\n

dataExchangeModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/dataExchangeModel_oneWayVTK.html", "content": "\n\n\n \n\n \n dataExchangeModel_oneWayVTK command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • dataExchangeModel_oneWayVTK command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

dataExchangeModel_oneWayVTK command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
dataExchangeModel oneWayVTK;\noneWayVTKProps\n{\n    DEMts timeStep;\n    relativePath "path";\n    couplingFilename "filename";\n    maxNumberOfParticles number;\n};\n
\n
\n
    \n

  • timeStep = time step size of stored DEM data

    • \n

  • path = path to the VTK data files relative do simulation directory

    • \n

  • filename = filename of the VTK file series

    • \n

  • number = maximum number of particles in DEM simulation

    • \n
\n
\n
\n

Examples

\n
dataExchangeModel oneWayVTK;\noneWayVTKProps\n{\n    DEMts 0.0001;\n    relativePath "../DEM/post";\n    couplingFilename "vtk_out%4.4d.vtk";\n    maxNumberOfParticles 30000;\n}\n
\n
\n
\n
\n

Description

\n

The data exchange model performs the data exchange between the DEM code and the CFD code. The oneWayVTK model is a model that can exchange particle properties from DEM to CFD based on previously stored VTK data.

\n
\n
\n

Restrictions

\n

None.

\n
\n
\n

Related commands

\n

dataExchangeModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/dataExchangeModel_twoWayFiles.html", "content": "\n\n\n \n\n \n dataExchangeModel_twoWayFiles command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • dataExchangeModel_twoWayFiles command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

dataExchangeModel_twoWayFiles command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
dataExchangeModel twoWayFiles;\ntwoWayFilesProps\n{\n    couplingFilename "filename";\n    maxNumberOfParticles scalar1;\n    DEMts scalar2;\n};\n
\n
\n
    \n

  • filename = filename of the VTK file series

    • \n

  • scalar1 = maximum number of particles in DEM simulation

    • \n

  • scalar2 = DEM time step width

    • \n
\n
\n
\n

Examples

\n
dataExchangeModel twoWayFiles;\ntwoWayFilesProps\n{\n    couplingFilename "vtk_out%4.4d.vtk";\n    maxNumberOfParticles 30000;\n}\n
\n
\n
\n
\n

Description

\n

The data exchange model performs the data exchange between the DEM code and the CFD code. The twoWayFiles model is a model that can exchange particle properties from DEM to CFD and from CFD to DEM. Data is exchanged via files that are sequentially written/read by the codes.

\n
\n
\n

Restrictions

\n

Developed only for two processors, one for DEM and one for CFD run.

\n
\n
\n

Related commands

\n

dataExchangeModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/dataExchangeModel_twoWayMPI.html", "content": "\n\n\n \n\n \n dataExchangeModel_twoWayMPI command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • dataExchangeModel_twoWayMPI command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

dataExchangeModel_twoWayMPI command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
dataExchangeModel twoWayMPI;\ntwoWayMPIProps\n{\n    liggghtsPath "path";\n};\n
\n
\n
    \n

  • path = path to the DEM simulation input file

    • \n
\n
\n
\n

Examples

\n
dataExchangeModel twoWayMPI;\ntwoWayMPIProps\n{\n    liggghtsPath "../DEM/in.liggghts_init";\n}\n
\n
\n
\n
\n

Description

\n

The data exchange model performs the data exchange between the DEM code and the CFD code. The twoWayMPI model is a model that can exchange particle properties from DEM to CFD and from CFD to DEM. Data is exchanged via MPI technique. The DEM run is executed by the coupling model, via a liggghtsCommandModel object.

\n
\n
\n

Restrictions

\n

none.

\n
\n
\n

Related commands

\n

dataExchangeModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/fix_couple_cfd.html", "content": "\n\n\n \n\n \n couple/cfd command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • couple/cfd command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

couple/cfd command

\n
\n

Syntax

\n
fix ID group-ID couple/cfd couple_every N mpi\n
\n
\n
    \n

  • ID, group-ID are documented in fix command

    • \n

  • couple/cfd = style name of this fix command

    • \n

  • couple_every = obligatory keyword

    • \n

  • N = number of DEM time steps between two coupling steps

    • \n
\n
\n
\n

Examples

\n

fix cfd all couple/cfd couple_every 1000 mpi

\n
\n
\n

Description

\n

This fix is responsible for the coupling between CFD and DEM calculation, i.e. for pushing and pulling of properties.

\n
\n
\n

Restrictions

\n

None.

\n

Related Commands:\nfix couple/cfd/force

\n
\n
\n

Default

\n

None

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/fix_couple_cfd_force.html", "content": "\n\n\n \n\n \n couple/cfd/force command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • couple/cfd/force command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

couple/cfd/force command

\n
\n

Syntax

\n
fix ID group-ID couple/cfd/force\n
\n
\n
    \n

  • ID, group-ID are documented in fix command

    • \n

  • couple/cfd = style name of this fix command

    • \n

  • zero or more keyword/value pairs may be appended

    • \n

  • keyword = force or torque or transfer_superquadric or transfer_ellipsoid or transfer_stochastic or transfer_property or CAddRhoFluid

    \n
    force values = implicit or excplicit\n  for allocating memory required for implicit/explicit drag force handling
    \n
    torque values = implicit or excplicit\n  for allocating memory required for implicit/explicit hydrodynamic torque handling
    \n
    CAddRhoFluid value = CAdd RhoFluid\n  CAdd = Coefficient for additional mass term. (Usually 0.5)\n  RhoFluid = Fluid density
    \n
    transfer_superquadric values = yes or no\n  for allocating memory required for handling superquadrics
    \n
    transfer_stochastic values = yes or no\n  for allocating memory required for handling stochastic dispersion
    \n
    • \n
\n
\n
\n

Examples

\n

fix cfd all couple/cfd couple_every 100 mpi\nfix cfd2 all couple/cfd/force

\n

fix cfd all couple/cfd couple_every 100 mpi\nfix cfd2 all couple/cfd/force force implicit transfer_type yes

\n

fix cfd all couple/cfd couple_every 100 mpi\nfix cfd2 all couple/cfd/force force implicit transfer_property name color type scalar-atom

\n
\n
\n

Description

\n

The command couple/cfd/force can only be used in combination with fix_couple_cfd. This model transfers the force that the fluid exceeds on each particle to the DEM calculation. At every coupling time step the force term, which contains contributions from all force models active in the CFD calculation, is passed on to LIGGGHTS®. This (constant) term is then used in the particle calculations at every DEM time step until the next coupling takes place.\nAdditionally Ksl and Uf terms are transferred to LIGGGHTS® unless the force is set to explicit.

\n
\n

Note

\n

It is strongly recommended to use the fix nve/cfd_cn/* integrator style with implicit force terms, otherwise these will be ignored.

\n
\n

Additional information, as the LIGGGHTS® atom_type can be transferred to the CFDEMcoupling environment with the keywork transfer_type yes. Similar keywords are transfer_density, transfer_torque and the more general transfer_property. The syntax is transfer_property name “name” type “data-type”. The data-type can be scalar-atom or vector-atom and this needs to be a per atom property previously defined.

\n

The option CAddRhoFluid enables additional mass terms for the integration of particles. These model the influence of displaced fluid on the particle motion.

\n
\n
\n

Restrictions

\n

transfer_superquadric = yes requires atom_style superquadric

\n

Related Commands:\nfix couple/cfd

\n
\n
\n

Default

\n

force implicit:all(b)

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel.html", "content": "\n\n\n \n\n \n forceModel command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    model_x\n    model_y\n);\n
\n
\n
    \n

  • model = name of force model to be applied

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    Archimedes\n    DiFeliceDrag\n);\n
\n
\n
\n

Note

\n

This examples list might not be complete - please look for other models (forceModel_XY) in this documentation.

\n
\n
\n
\n

Description

\n

The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle and on each CFD cell. All force models selected are executed sequentially and the forces on the particles are superposed. If the fluid density field is needed, by default a field named “rho” will be used. Via the forceSubModel an alternative field can be chosen.

\n

Some force models aren’t actual force calculations, but might be used to create additional output fields.

\n
\n
\n

Restrictions

\n

Most force models are ready to be used with coarse graining. If any force model used in the simulation is not ready for coarse graining, but is used with coarse graining, the simulation is stopped. Setting a flag “cgWarnOnly true;” in coupling properties, the simulation will print a warning to the terminal (log file).

\n
\n
\n

Related commands

\n

Archimedes, DiFeliceDrag, gradPForce, viscForce

\n

Note: This examples list may be incomplete - please look for other models (forceModel_XY) in this documentation.

\n

Default: none.

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_Archimedes.html", "content": "\n\n\n \n\n \n forceModel_Archimedes command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_Archimedes command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_Archimedes command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    Archimedes\n);\nArchimedesProps\n{\n    gravityFieldName "gravity";\n    densityFieldName "density";\n    twoDimensional;\n    suppressProbe   switch1;\n    treatForceDEM   switch2;\n    verbose         switch3;\n    interpolation   switch4;\n};\n
\n
\n
    \n

  • gravity = (optional, default “g”) name of the finite volume gravity field

    • \n

  • density = (optional, default “rho”) name of the finite volume density field

    • \n

  • twoDimensional = optional keyword for conducting a two dimensional calculation

    • \n

  • switch1 = (optional, default false) can be used to suppress the output of the probe model

    • \n

  • switch2 = (optional, default true) sub model switch, see forceSubModel for details

    • \n

  • switch3 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • switch4 = (optional, default false) sub model switch, see forceSubModel for details

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    Archimedes\n);\nArchimedesProps\n{\n    gravityFieldName "g";\n}\n
\n
\n
\n
\n

Description

\n

The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The Archimedes model is a model that calculates the Archimedes’ volumetric lift force stemming from density difference of fluid and particle.

\n

If the particleShapeType multisphere is selected, caluclations are performed for multisphere particles. In this operation mode additional input for DHc or area per particle type may be required. Without this input the multisphere variant may fail.

\n
\n
\n

Restrictions

\n

none.

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_ArchimedesIB.html", "content": "\n\n\n \n\n \n forceModel_ArchimedesIB command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_ArchimedesIB command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_ArchimedesIB command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    ArchimedesIB\n);\nArchimedesIBProps\n{\n    gravityFieldName "gravity";\n    voidfractionFieldName "voidfraction";\n    twoDimensional;\n    treatForceExplicit  switch1;\n};\n
\n
\n
    \n

  • gravity = (optional, default “g”) name of the finite volume gravity field

    • \n

  • voidfraction = (optional, default “voidfraction”) name of the finite volume voidfraction field

    • \n

  • twoDimensional = optional keyword for conducting a two dimensional calculation

    • \n

  • switch1 = (optional, default true) sub model switch, see forceSubModel for details

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    ArchimedesIB\n);\nArchimedesIBProps\n{\n    gravityFieldName "g";\n    voidfractionFieldName "voidfractionNext";\n}\n
\n
\n
\n
\n

Description

\n

The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The ArchimedesIB model is a model that calculates the ArchimedesIB’ volumetric lift force stemming from density difference of fluid and particle. This model is especially suited for resolved CFD-DEM simulations where the particle is represented by immersed boundary method.

\n
\n
\n

Restrictions

\n

Only for immersed boundary solvers.

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_DiFeliceDrag.html", "content": "\n\n\n \n\n \n forceModel_DiFeliceDrag command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_DiFeliceDrag command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_DiFeliceDrag command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    DiFeliceDrag\n);\nDiFeliceDragProps\n{\n    velFieldName "U";\n    voidfractionFieldName "voidfraction";\n    granVelFieldName "Us";\n    interpolation switch1;\n    voidfractionInterpolationType "type1";\n    UInterpolationType "type2";\n    suppressProbe       switch2;\n    scale               scalar1;\n    scaleDrag           scalar2;\n    scaleDH             scalar3;\n    treatForceExplicit  switch3;\n    implForceDEM        switch4;\n    verbose             switch5;\n    scalarViscosity     switch6;\n    voidageFunctionDiFelice switch7;\n    voidageFunctionRong switch8;\n    voidageFunctionTang switch9;\n    nu                  scalar4;\n};\n
\n
\n
    \n

  • U = (optional, default “U”) name of the finite volume fluid velocity field

    • \n

  • voidfraction = (optional, default “voidfraction”) name of the finite volume voidfraction field

    • \n

  • Us = (optional, default “Us”) name of the finite volume granular velocity field

    • \n

  • switch1 = (optional, normally off) flag to use interpolated voidfraction and velocity values

    • \n

  • type1 = (optional, default cellPoint) interpolation type for voidfraction field

    • \n

  • type2 = (optional, default cellPointFace) interpolation type for velocity field

    • \n

  • switch2 = (optional, default false) can be used to suppress the output of the probe model

    • \n

  • scalar1 = (optional) scaling of particle diameter: d_sim=scale*d_real. d_sim=(potentially coarse grained) particle diameter. scale=coarse graining factor. d_real= particle diameter as it is measured.

    • \n

  • scalar2 = (optional) scaling factor which directly scales the drag force.

    • \n

  • scalar3 = (optional) scaling factor between particle diameter and hydraulic diameter of clump

    • \n

  • switch3 = sub model switch, see forceSubModel for details

    • \n

  • switch4 = sub model switch, see forceSubModel for details

    • \n

  • switch5 = sub model switch, see forceSubModel for details

    • \n

  • switch6 = sub model switch, see forceSubModel for details

    • \n

  • switch7 = (optional, default true) sub model switch, see forceSubModel for details

    • \n

  • switch8 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • switch9 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • scalar4 = optional, only if switch6 is true

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    DiFeliceDrag\n);\nDiFeliceDragProps\n{\n    velFieldName "U";\n    interpolation true;\n}\n
\n
\n
\n
\n

Description

\n

The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The DiFeliceDrag model is a model that calculates the particle based drag force following the correlation of Di Felice (see Zhou et al. (2010), JFM).

\n

If the particleShapeType multisphere is selected, caluclations are performed for multisphere particles. In this operation mode additional input for DHc or area per particle type may be required. Without this input the multisphere variant may fail.

\n
\n
\n

Restrictions

\n

none.

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_GidaspowDrag.html", "content": "\n\n\n \n\n \n forceModel_GidaspowDrag command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_GidaspowDrag command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_GidaspowDrag command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    GidaspowDrag\n);\nGidaspowDragProps\n{\n    velFieldName "U";\n    voidfractionFieldName "voidfraction";\n    granVelFieldName "Us";\n    phi                 scalar1;\n    interpolation switch1;\n    voidfractionInterpolationType "type1"\n    UInterpolationType "type2"\n    implForceDEM        switch2;\n    suppressProbe       switch3;\n    scale               scalar2;\n    scaleDrag           scalar3;\n    scaleDH             scalar4;\n    switchingVoidfraction scalar5;\n    treatForceExplicit  switch4;\n    implForceDEM        switch5;\n    verbose             switch6;\n    scalarViscosity     switch7;\n    nu                  scalar6;\n};\n
\n
\n
    \n

  • U = (optional, default “U”) name of the finite volume fluid velocity field

    • \n

  • voidfraction = (optional, default “voidfraction”) name of the finite volume voidfraction field

    • \n

  • Us = (optional, default “Us”) name of the finite volume cell averaged particle velocity field

    • \n

  • scalar1 = (optional, default 1) drag correction factor

    • \n

  • switch1 = (optional, default off) flag to use interpolated voidfraction and fluid velocity values

    • \n

  • type1 = (optional, default cellPoint) interpolation type for voidfraction field

    • \n

  • type2 = (optional, default cellPointFace) interpolation type for velocity field

    • \n

  • switch2 = (optional, default false) flag to use implicit formulation of drag on DEM side\nswitch3 = (optional, default false) can be used to suppress the output of the probe model

    • \n

  • scalar2 = (optional) scaling of particle diameter: d_sim=scale*d_real. d_sim=(potentially coarse grained) particle diameter. scale=coarse graining factor. d_real= particle diameter as it is measured.

    • \n

  • scalar3 = (optional) scaling of drag law

    • \n

  • scalar4 = (optional) scaling factor between particle diameter and hydraulic diameter of clump

    • \n

  • scalar5 = (optional) voidfraction above which dilute formulation will be used

    • \n

  • switch4 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • switch5 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • switch6 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • switch7 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • scalar6 = (optional, default false) optional, only if switch6 is true

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    GidaspowDrag\n);\nGidaspowDragProps\n{\n    velFieldName "U";\n    voidfractionFieldName "voidfraction";\n    granVelFieldName "Us";\n}\n
\n
\n
\n
\n

Description

\n

The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The GidaspowDrag model is a model that calculates the particle based drag force following the correlation of Gidaspow which is a combination of Ergun (1952) and Wen & Yu (1966) (see Zhu et al. (2007): “Discrete particle simulation of particulate systems: Theoretical developments”, ChemEngScience).

\n
\n
\n

Restrictions

\n

none.

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_KochHillDrag.html", "content": "\n\n\n \n\n \n forceModel_KochHillDrag command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_KochHillDrag command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_KochHillDrag command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    KochHillDrag\n);\nKochHillDragProps\n{\n    velFieldName "U";\n    voidfractionFieldName "voidfraction";\n    granVelFieldName "Us"\n    interpolation       "switch1";\n    voidfractionInterpolationType "type1"\n    UInterpolationType  "type2"\n    implForceDEM        "switch2";\n    suppressProbe       "switch3";\n    scale               "scalar1";\n    scaleDrag           "scalar2";\n    scaleDH             "scalar3";\n    treatForceExplicit  "switch4";\n    verbose             "switch5";\n    implForceDEMaccumulated "switch6";\n    scalarViscosity     "switch7";\n    nu                  "scalar4";\n};\n
\n
\n
    \n

  • U = (optional, default “U”) name of the finite volume fluid velocity field

    • \n

  • voidfraction = (optional, default “voidfraction”) name of the finite volume voidfraction field

    • \n

  • Us = (optional, default “Us”) name of finite volume granular velocity field

    • \n

  • switch1 = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values

    • \n

  • type1 = (optional, default cellPoint) interpolation type for voidfraction field

    • \n

  • type2 = (optional, default cellPointFace) interpolation type for velocity field

    • \n

  • switch2 = (optional, normally off) flag to use implicit formulation of drag on DEM side\nswitch3 = (optional, default false) can be used to suppress the output of the probe model

    • \n

  • scalar1 = (optional) scaling of particle diameter: d_sim=scale*d_real. d_sim=(potentially coarse grained) particle diameter. scale=coarse graining factor. d_real= particle diameter as it is measured.

    • \n

  • scalar2 = (optional) scaling of drag law

    • \n

  • scalar3 = (optional) scaling factor between particle diameter and hydraulic diameter of clump

    • \n

  • switch4 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • switch5 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • switch6 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • switch7 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • scalar4 = optional, only if switch7 is true

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    KochHillDrag\n);\nKochHillDragProps\n{\n    velFieldName "U";\n    voidfractionFieldName "voidfraction";\n}\n
\n
\n
\n
\n

Description

\n

The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The KochHillDrag model is a model that calculates the particle based drag force following the correlation of Koch & Hill (2001) (see van Buijtenen et al. (2011): “Numerical and experimental study on multiple-spout fluidized beds”, ChemEngScience).

\n
\n
\n

Restrictions

\n

none.

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_LaEuScalarTemp.html", "content": "\n\n\n \n\n \n forceModel_LaEuScalarTemp command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_LaEuScalarTemp command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_LaEuScalarTemp command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    LaEuScalarTemp\n);\nLaEuScalarTempProps\n{\n    velFieldName "U";\n    tempFieldName "T";\n    voidfractionFieldName "voidfraction";\n    partTempName "Temp";\n    partHeatFluxName "convectiveHeatFlux";\n    partHeatTransCoeffName "heatTransCoeff";\n    partHeatFluidName "heatFluid";\n    lambda scalar1;\n    Cp scalar2;\n    interpolation switch1;\n    TInterpolationType "type1"\n    verbose switch2;\n    maxSource scalar3;\n    scale scalar4;\n    scalarViscosity switch3;\n    nu scalar5;\n    NuCorrelation "NuCorrelation";\n};\n
\n
\n
    \n

  • U = (optional, default “U”) name of the finite volume fluid velocity field

    • \n

  • T = name of the finite volume scalar temperature field

    • \n

  • voidfraction = (optional, default “voidfraction”) name of the finite volume voidfraction field

    • \n

  • Temp = name of the DEM data representing the particles temperature

    • \n

  • convectiveHeatFlux = name of the DEM data representing the particle-fluid convective heat flux

    • \n

  • heatTransCoeff = name of heat transfer coefficient

    • \n

  • heatFluid =\nscalar1 = fluid thermal conductivity [W/(m*K)]. Must be chosen >= 0! If 0, then heat transfer is ignored.

    • \n

  • scalar2 = fluid specific heat capacity [W*s/(kg*K)]

    • \n

  • switch1 = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values

    • \n

  • type1 = (optional, default cellPoint) interpolation type for T field

    • \n

  • switch2 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • scalar3 = (optional) limit maximal turbulence

    • \n

  • scalar4 = scaling of particle diameter: d_sim=scale*d_real. d_sim=(potentially coarse grained) particle diameter. scale=coarse graining factor. d_real= particle diameter as it is measured.

    • \n

  • switch3 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • scalar5 = optional, only if switch3 is true

    • \n
\n

NuCorrelation = (optional, default=”LiMason”) chooses the heat correlation to be used for Nusselt\nnumber correlation. Valid options: ‘LiMason’, ‘Deen’.:l

\n
\n
\n

Examples

\n
forceModels\n(\n    LaEuScalarTemp\n);\nLaEuScalarTempProps\n{\n    velFieldName "U";\n    tempFieldName "T";\n    voidfractionFieldName "voidfraction";\n    partTempName "Temp";\n    partHeatFluxName "convectiveHeatFlux";\n    lambda 0.0256;\n    Cp 1007;\n}\n
\n
\n
\n
\n

Description

\n

This “forceModel” does not influence the particles or the fluid flow! Using the particles’ temperature a scalar field representing “particle-fluid heatflux” is calculated. The solver then uses this source field in the scalar transport equation for the temperature. The model for convective heat transfer is based on Li and Mason (2000), A computational investigation of transient heat transfer in pneumatic transport of granular particles, Pow.Tech 112

\n
\n
\n

Restrictions

\n

Goes only with cfdemSolverScalar and cfdemSolverReacting.

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_MeiLift.html", "content": "\n\n\n \n\n \n forceModel_MeiLift command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_MeiLift command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_MeiLift command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    MeiLift\n);\nMeiLiftProps\n{\n    velFieldName "U";\n    useSecondOrderTerms;\n    interpolation switch1;\n    vorticityInterpolationType "type1"\n    UInterpolationType "type2"\n    verbose switch2;\n    treatForceExplicit switch3;\n    scalarViscosity switch4;\n    nu scalar1;\n};\n
\n
\n
    \n

  • U = (optional, default “U”) name of the finite volume fluid velocity field

    • \n

  • useSecondOrderTerms = switch to activate second order terms in the lift force model

    • \n

  • switch1 = switch to activate tri-linear interpolation of the flow quantities at the particle position

    • \n

  • type1 = (optional, default cellPoint) interpolation type for vorticity field

    • \n

  • type2 = (optional, default cellPointFace) interpolation type for velocity field

    • \n

  • switch2 = switch to activate the report of per-particle quantities to the screen

    • \n

  • switch3 = (optional, default true) sub model switch, see forceSubModel for details

    • \n

  • switch4 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • scalar1 = optional, only if switch4 is true

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    MeiLift\n);\nMeiLiftProps\n{\n    velFieldName "U";\n    useSecondOrderTerms;\n    interpolation true;\n    verbose true;\n}\n
\n
\n
\n
\n

Description

\n

The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The MeiLift model calculates the lift force for each particle based on Loth and Dorgan (2009). In case the keyword “useSecondOrderTerms” is not specified, this lift force model uses the expression of McLaughlin (1991, Journal of Fluid Mechanics 224:261-274).

\n
\n
\n

Restrictions

\n

None.

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_SchillerNaumannDrag.html", "content": "\n\n\n \n\n \n forceModel_SchillerNaumannDrag command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_SchillerNaumannDrag command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_SchillerNaumannDrag command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    SchillerNaumannDrag\n);\nSchillerNaumannDragProps\n{\n    velFieldName "U";\n    voidfractionFieldName "voidfraction";\n    interpolation "bool1";\n    voidfractionInterpolationType "type1"\n    UInterpolationType "type2"\n    implForceDEM "bool2";\n};\n
\n
\n
    \n

  • U = (optional, default “U”) name of the finite volume fluid velocity field

    • \n

  • voidfraction = (optional, default “voidfraction”) name of the finite volume voidfraction field

    • \n

  • bool1 = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values

    • \n

  • type1 = (optional, default cellPoint) interpolation type for voidfraction field

    • \n

  • type2 = (optional, default cellPointFace) interpolation type for velocity field

    • \n
\n

bool2 = (optional, normally off) flag to use implicit formulation of drag on DEM side:l

\n
\n
\n

Examples

\n
forceModels\n(\n    SchillerNaumannDrag\n);\nSchillerNaumannDragProps\n{\n    velFieldName "U";\n}\n
\n
\n
\n
\n

Description

\n

The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The SchillerNaumannDrag model is a model that calculates the particle based drag force following the correlation of Schiller and Naumann.

\n
\n
\n

Restrictions

\n

none.

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_ShirgaonkarIB.html", "content": "\n\n\n \n\n \n forceModel_ShirgaonkarIB command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_ShirgaonkarIB command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_ShirgaonkarIB command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    ShirgaonkarIB\n);\nShirgaonkarIBProps\n{\n    velFieldName "U";\n    pressureFieldName "p";\n    twoDimensional;\n    depth scalar1;\n    verbose switch1;\n    treatForceExplicit switch2;\n};\n
\n
\n
    \n

  • U = (optional, default “U”) name of the finite volume fluid velocity field

    • \n

  • p = name of the finite volume pressure field

    • \n

  • twoDimensional = optional keyword for conducting a two dimensional calculation

    • \n

  • scalar1 = optional, only necessary if twoDimensional is active

    • \n

  • switch1 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • switch2 = (optional, default false) sub model switch, see forceSubModel for details

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    ShirgaonkarIB\n);\nShirgaonkarIBProps\n{\n    velFieldName "U";\n    pressureFieldName "p";\n}\n
\n
\n
\n
\n

Description

\n

The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The ShirgaonkarIB model calculates the drag force (viscous and pressure force) acting on each particle in a resolved manner (see Shirgaonkar et al. (2009): “A new mathematical formulation and fast algorithm for fully resolved simulation of self-propulsion”, Journal of Comp. Physics). This model is only suited for resolved CFD-DEM simulations where the particle is represented by immersed boundary method.

\n

References:

\n

SHIRGAONKAR, A.A., MACIVER, M.A. and PATANKAR, N.A., (2009), “A new mathematical formulation and fast algorithm for fully resolved simulation of self-propulsion”, J. Comput. Phys., 228, 2366-2390.

\n
\n
\n

Restrictions

\n

Only for immersed boundary solvers.

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_checkCouplingInterval.html", "content": "\n\n\n \n\n \n forceModel_checkCouplingInterval command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_checkCouplingInterval command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_checkCouplingInterval command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    checkCouplingInterval\n);\ncheckCouplingIntervalProps\n{\n    warnOnly                    bool1;\n    velocityFieldName           word1;\n    rhoP                        scalar1;\n    maxCFL                      scalar2;\n    maxPCFL                     scalar3;\n    maxAccNr                    scalar4;\n    UmaxExpected                scalar5;\n    minAllowedVcellByVparcel    scalar6;\n    largeVcellByVparcel         scalar7;\n    timeInterval                scalar8;\n    maxRelVelChange             scalar9;\n};\n
\n
\n
    \n

  • bool1 = (optional, default true) switch to warn or stop simulation if criterion is broken.

    • \n

  • word1 = (optional, default U) name of velocity field.

    • \n

  • scalar1 = particle density assumed for calculation of the particle relaxation time

    • \n

  • scalar2 = (optional, default=1) maximum allowed CFL number.

    • \n

  • scalar3 = (optional, default=1) maximum allowed particle coupling CFL number.

    • \n

  • scalar4 = (optional, default=0.005) maximum allowed ratio of coupling time to particle relaxation time.

    • \n

  • scalar5 = maximum expected velocity fluid velocity (e.g. due to BCs) - used for CFL estimation.

    • \n

  • scalar6 = (optional, default=3) min allowed volume ratio of cell / particle.

    • \n

  • scalar7 = (optional, default=10000) maximal min volume ratio of cell / particle for which divided void fraction model is recommended.

    • \n

  • scalar8 = (optional, default=coupling time) interval of execution.

    • \n

  • scalar9 = (optional, default=0.1) max allowed ratio of fluid velocity gradient and coupling interval.

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    checkCouplingInterval\n);\ncheckCouplingIntervalProps\n{\n    rhoP 2500;\n    UmaxExpected 10;\n    timeInterval 0.002;\n}\n
\n
\n
\n
\n

Description

\n

This “forceModel” does not influence the particles or the simulation - it is a postprocessing tool! At the first coupling step and at every time interval several criteria are checked:

\n
    \n

  1. The acceleration number is defined as the ratio of DEMtime/particleRelaxationTime, where DEMtime is DEM time step size * coupling interval. The acceleration nr should be smaller than ~0.005.

    2. \n

  2. The Courant Number (CFL). If the CFL number exceeds a reasonable value the quality of the result becomes bad - therefore the simulation settings should be changed.

    3. \n

  3. The particle coupling Courant number (pCFL). Similar to the fluid CFL, the pCFL should not exceed a reasonable value. It is defined as max(vparticle)*couplingTime/min(cellLength) .

    4. \n

  4. The ratio of smallest cell biggest particle volume. Typically this should be larger than 3.

    5. \n

  5. If the ratio of the smallest cell to the largest particle exceeds a certain limit (current default value 10000) it is recommended to use the more efficient centre voidfraction model.

    6. \n

  6. The minimum and maximum Stokes Number. The Stokes number is a measure for in how far the particles follow the flow. It is calculated as the product of the particle relaxation time and the relative velocity between fluid and particle over the particle diameter: relaxation time * relative velocity / particle diameter. Note that the highest appearing value of scaleDrag will be used to scale the relaxation time reciprocally.

    7. \n

  7. The product of max fluid velocity gradient and coupling time is checked as a benchmark for particle acceleration due to changes the particles experience in the velocity field.

    8. \n
\n

For the criteria (1)-(4) the user can define its own allowed bounds and with the flag “warnOnly” the user can choose if the simulation should be stopped or if just a warning is given if a criterion is broken.

\n
\n
\n

Restrictions

\n

needs MPI based dataExchange model - e.g. oneWayVTK will not work.

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_fieldStore.html", "content": "\n\n\n \n\n \n forceModel_fieldStore command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_fieldStore command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_fieldStore command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    fieldStore\n);\nfieldStoreProps\n{\n    scalarFieldNames\n    (\n        "scalarField"\n    );\n    vectorFieldNames\n    (\n        "vectorField"\n    );\n};\n
\n
\n
    \n

  • scalarField = names of the finite volume scalar fields to be stored

    • \n

  • vectorField = names of the finite volume vector fields to be stored

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    fieldStore\n);\nfieldStoreProps\n{\n    scalarFieldNames\n    (\n        "voidfraction"\n    );\n    vectorFieldNames\n    (\n        "U"\n    );\n}\n
\n
\n
\n
\n

Description

\n

This “forceModel” does not influence the particles or the flow - it is a tool to store a scalar/vector field! This is especially useful if you use a boundary condition which cannot interpreted correctly in your postporcessor (e.g. paraview).

\n
\n
\n

Restrictions

\n

none.

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_fieldTimeAverage.html", "content": "\n\n\n \n\n \n forceModel_fieldTimeAverage command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_fieldTimeAverage command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_fieldTimeAverage command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    fieldTimeAverage\n);\nfieldTimeAverageProps\n{\n    startTime time;\n    scalarFieldNames\n    (\n        "scalarField"\n    );\n    vectorFieldNames\n    (\n        "vectorField"\n    );\n};\n
\n
\n
    \n

  • time = (optional) time to start temporal averaging

    • \n

  • scalarField = names of the finite volume scalar fields to be temporally averaged

    • \n

  • vectorField = names of the finite volume vector fields to be temporally averaged

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    fieldTimeAverage\n);\nfieldTimeAverageProps\n{\n    startTime 1.0;\n    scalarFieldNames\n    (\n        "voidfraction"\n    );\n    vectorFieldNames\n    (\n        "Us"\n    );\n}\n
\n
\n
\n
\n

Description

\n

This “forceModel” does not influence the particles or the simulation - it is a postprocessing tool! Starting at start time the specified fields are temporally averaged and written at “writeTime”. They can then be probed using standard function object probes. The output name is timeAverage_scalarField, where scalarField is the name of the original field.

\n
\n
\n

Restrictions

\n

none.

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_gradPForce.html", "content": "\n\n\n \n\n \n forceModel_gradPForce command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_gradPForce command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_gradPForce command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    gradPForce;\n);\ngradPForceProps\n{\n    pFieldName "pressure";\n    velocityFieldName "U";\n    interpolation       switch1;\n    gradPInterpolationType "type1"\n    useAddedMass        scalar1;\n    suppressProbe       switch2;\n    treatForceExplicit  switch3;\n    treatForceDEM       switch4;\n};\n
\n
\n
    \n

  • pressure = name of the finite volume fluid pressure field

    • \n

  • U = (optional, default “U”) name of the finite volume fluid velocity field

    • \n

  • switch1 = flag to use interpolated pressure values (normally off)

    • \n

  • type1 = (optional, default cellPointFace) interpolation type for grad(p) field

    • \n

  • useAddedMass = (optional) coefficient of added mass accounted for

    • \n

  • switch2 = (optional, default false) can be used to suppress the output of the probe model

    • \n

  • switch3 = (optional, default true) sub model switch, see forceSubModel for details

    • \n

  • switch4 = (optional, default false) sub model switch, see forceSubModel for details

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    gradPForce;\n);\ngradPForceProps\n{\n    pFieldName "p";\n    velocityFieldName "U";\n    interpolation true;\n}\n
\n
\n
\n
\n

Description

\n

The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The gradPForce model is a model that calculates the particle based pressure gradient force -(grad(p)) * Vparticle (see Zhou et al. (2010): “Discrete particle simulation of particle-fluid flow: model formulations and their applicability” ,JFM).

\n
\n
\n

Restrictions

\n

none.

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_noDrag.html", "content": "\n\n\n \n\n \n forceModel_noDrag command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_noDrag command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_noDrag command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    noDrag\n);\n
\n
\n

noDragProps\n{

\n
\n

noDEMForce “switch1”;\nkeepCFDForce “switch2”;

\n
\n

}

\n
    \n

  • switch1 = (optional, default false) do not apply the previously calculated forces (implicitly and explicitly treated) in DEM integration

    • \n

  • switch2 = (optional, default false) do not delete the previously calculated forces (implicitly and explicitly treated) and use them in CFD source terms

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    noDrag\n);\n\nnoDragProps\n{\n    noDEMForce true;\n    keepCFDForce false;\n};\n
\n
\n
\n
\n

Description

\n

The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The noDrag model sets the forces acting on the particle (which were previously caclulated) to zero. If several force models are selected and noDrag is the last model being executed, the fluid particle force will be set to zero. If the variable noDEMForce is set, then the forces communicated to the DEM solver are also set to zero.

\n

If the particleShapeType multisphere is selected, caluclations are performed for multisphere particles. In this operation mode additional input for DHc or area per particle type may be required. Without this input the multisphere variant may fail.

\n
\n
\n

Restrictions

\n

None.

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_particleCellVolume.html", "content": "\n\n\n \n\n \n forceModel_particleCellVolume command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_particleCellVolume command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_particleCellVolume command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    particleCellVolume\n);\nparticleCellVolumeProps\n{\n    verbose switch1;\n    writeToFile switch2;\n    startTime number1;\n    upperThreshold number2;\n    lowerThreshold number3;\n    verbose;\n};\n
\n
\n
    \n

  • switch1 = (optional, default true) switch for output to screen

    • \n

  • switch2 = (optional, default false) switch for output to file

    • \n

  • number1 = (optional, default 0) start time of volume calculation and output

    • \n

  • number2 = (optional, default 1.01) only cells with a field value (magnitude) lower than this upper threshold are considered

    • \n

  • number3 = (optional, default -0.01) only cells with a field value (magnitude) greater than this lower threshold are considered

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    particleCellVolume\n);\nparticleCellVolumeProps\n{\n    upperThreshold 0.999;\n    lowerThreshold 0;\n}\n
\n
\n
\n
\n

Description

\n

This “forceModel” does not influence the particles or the simulation - it is a postprocessing tool! The total volume of the particles as they are represented on the CFD mesh is calculated. Further the total volume of the cells particles are in is calculated.\nAt “writeTime” a field named particleCellVolume , where scalarField is the name of the original field, is written. This can then be probed using standard function object probes. Analogously a field named cellVolume is written. Using the verbose option a screen output is given.

\n
\n
\n

Restrictions

\n

None.

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_particleVolume.html", "content": "\n\n\n \n\n \n forceModel_particleVolume command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_particleVolume command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_particleVolume command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    particleVolume\n);\nparticleVolumeProps\n{\n    verbose switch1;\n    writeToFile switch2;\n    scale scalar1;\n    startTime scalar2;\n};\n
\n
\n
    \n

  • switch1 = (optional, default false) switch for output to screen

    • \n

  • switch2 = (optional, default true) switch for output to file

    • \n

  • scalar1 = (optional, default 1) scaling of the particle volume d=dSphere/scale

    • \n

  • scalar2 = (optional, default 0) start time of volume calculation and output

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    particleVolume\n);\nparticleVolumeProps\n{\n    writeToFile false;\n}\n
\n
\n
\n
\n

Description

\n

This “forceModel” does not influence the particles or the simulation - it is a postprocessing tool! The total volume of the particles located in the CFD domain is calculated.

\n
\n
\n

Restrictions

\n

None.

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_periodicPressure.html", "content": "\n\n\n \n\n \n forceModel_periodicPressure command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_periodicPressure command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_periodicPressure command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    periodicPressure\n);\nperiodicPressureProps\n{\n    gravityFieldName "g";\n    voidfractionFieldName "voidfraction";\n    mode "word";\n    targetVelocity vector1;\n    p scalar1;\n    i scalar2;\n    avMixtureDensity scalar3;\n};\n
\n
\n
    \n

  • g = name of gravity field

    • \n

  • voidfraction = (optional, default “voidfraction”) name of voidfraction field

    • \n

  • word = keyword for operation mode, choose “controlled” or “mixtureDensity”

    • \n

  • vector1 = target ensemble average particle velocity (for monodisperse systems) - only for mode “controlled”

    • \n

  • scalar1 = proportional constant for controller - only for mode “controlled”

    • \n

  • scalar2 = integral constant for controller - only for mode “controlled”

    • \n

  • scalar3 = average density of the mixture in the domain - only for mode “mixtureDensity”

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    periodicPressure\n);\nperiodicPressureProps\n{\n    gravityFieldName "g";\n    voidfractionFieldName "voidfraction";\n    mode "controlled";\n    targetVelocity (0. 0. 0.);\n    p 2500;\n    i 1;\n}\n
\n
\n
\n
\n

Description

\n

The force model calculates a force field following two different modi: a) “controlled” and b) “mixtureDensity”, which can be used to transform fluid pressure gradient to dynamic pressure gradient which is necessary for periodic boundaries. With modus “controlled” the force field is set in a way, that the ensemble average particle velocity reaches a target velocity. With modus “mixtureDensity”, a force field rhoMix*g*voidfraction is calculated. The force is passed to the explicitCoupleSource model via the setSourceField(..) function. For theoretical background see Radl, Girardi and Sundaresan (2012): “Effective drag law for parcel-based approaches - what can we learn from CFD-DEM?”, ECCOMAS 2012, Vienna.)

\n

The following images show a brief summary of the equations and an overview of how the force on the CFD and DEM side is calculated:

\n\"img/forceModel_periodicPressure_1.PNG\"\n\"img/forceModel_periodicPressure_2.PNG\"\n\"img/forceModel_periodicPressure_3.PNG\"\n
\n
\n

Restrictions

\n

none.

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_scalarGeneralExchange.html", "content": "\n\n\n \n\n \n forceModel_scalarGeneralExchange command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_scalarGeneralExchange command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_scalarGeneralExchange command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    scalarGeneralExchange  // must be 2nd position!\n);\nscalarGeneralExchangeProps\n{\n    useLiMason "switch1"; //default: DeenEtAl\n    useGeneralCorrelation "switch3"; //default: DeenEtAl\n    generalCorrelationParameters (1 2 3 4 5 6 7 8);\n    verbose "switch2";\n    velFieldName "U";\n    voidfractionFieldName "voidfraction";\n    tempFieldName "T";\n    partTempName "Temp";\n    /* partHeatFluxName "convectiveHeatFlux"; //switch off for implicit coupling, e.g., to ParScale */\n    partHeatTransCoeffName "heatTransCoeff";\n    partHeatFluidName "heatFluid";\n    lambda value;\n    Cp value1;\n    //Lists with information for each species FOR THE PARTICLES\n    //MUST be in the same order as eulerian species in 'scalarTransportProperties'\n    //MUST correspond to property/atom in ligghts (use 'couple/cfd/speciesConvection' to auto-generate individual fields)\n    partSpeciesNames\n    (\n    speciesC\n    );\n    partSpeciesFluxNames\n    (\n    speciesCFlux\n    );\n    partSpeciesTransCoeffNames\n    (\n    speciesCTransCoeff\n    );\n    partSpeciesFluidNames\n    (\n    speciesCFluid\n    );\n    DMolecular\n    (\n    value2\n    );\n    interpolation "bool1";\n    voidfractionInterpolationType "type1"\n    UInterpolationType "type2"\n    fluidScalarFieldInterpolationType "type2"\n    scalarViscosity switch5;\n    nu scalar5;\n    suppressProbe switch6;\n    scale scalar6;\n    maxSource scalar7;\n}
\n
    \n

  • switch1 = (optional) flag to use Nusselt correlations of Li and Mason (2000)

    • \n

  • switch2 = (normally off) for verbose run

    • \n

  • switch3 = (optional) flag to use a general Nusselt number correlation (must specify parameters of this correlation in a list called ‘generalCorrelationParameters’ )

    • \n

  • generalCorrelationParameters = list with a predefined number of parameters (for length see src code, only read if useGeneralCorrelation is set to true)

    • \n

  • U = (optional, default “U”) name of the finite volume fluid velocity field

    • \n

  • voidfraction = (optional, default “voidfraction”) name of the finite volume voidfraction field

    • \n

  • T = name of the finite volume scalar temperature field

    • \n

  • Temp = name of the DEM data representing the particles temperature

    • \n

  • convectiveHeatFlux = name of the DEM data representing the particle-fluid convective heat flux

    • \n

  • heatTransCoeff = name of the DEM data representing the particle-fluid heat transfer coefficient

    • \n

  • heatFluid = name of the DEM data representing the fluid heat

    • \n

  • value = fluid thermal conductivity [W/(m*K)]

    • \n

  • value1 = fluid specific heat capacity [W*s/(kg*K)]

    • \n

  • speciesC = name of the DEM data representing the transport species of the particles

    • \n

  • speciesCFlux = name of the DEM data representing the particle-fluid species flux

    • \n

  • speciesCTransCoeff = name of the DEM data representing the particle-fluid species transfer coefficient

    • \n

  • speciesCFluid = name of the DEM data representing the transport species of the fluid

    • \n

  • value2 = molecular diffusion coefficient [m^2/s]

    • \n

  • bool1 = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values

    • \n

  • type1 = (optional, default cellPoint) interpolation type for voidfraction field

    • \n

  • type2 = (optional, default cellPointFace) interpolation type for velocity field

    • \n

  • type3 = (optional, default cellPoint) interpolation type for fluidScalarField field

    • \n

  • switch5 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • scalar5 = (optional) optional, only if switch5 is true

    • \n

  • switch6 = (optional, default false) can be used to suppress the output of the probe model

    • \n

  • scalar7 = (optional) scaling of particle diameter: d_sim=scale*d_real. d_sim=(potentially coarse grained) particle diameter. scale=coarse graining factor. d_real= particle diameter as it is measured.

    • \n

  • scalar7 = limit maximal turbulence

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    scalarGeneralExchange  // must be 2nd position!\n);\nscalarGeneralExchangeProps\n{\n    useLiMason false; //default: DeenEtAl\n    useGeneralCorrelation true; //default: DeenEtAl\n    generalCorrelationParameters\n    (\n     7.0 -10 5\n     1.0 0.17\n     1.33 -2.31 1.16\n    );\n    verbose false;\n    velFieldName "U";\n    voidfractionFieldName "voidfraction";\n    tempFieldName "T";\n    partTempName "Temp";\n    /* partHeatFluxName "convectiveHeatFlux"; //switch off for implicit coupling, e.g., to ParScale */\n    partHeatTransCoeffName "heatTransCoeff";\n    partHeatFluidName "heatFluid";\n    lambda 0.0271;\n    Cp 1007;\n    //Lists with information for each species FOR THE PARTICLES\n    //MUST be in the same order as eulerian species in 'scalarTransportProperties'\n    //MUST correspond to property/atom in ligghts (use 'couple/cfd/speciesConvection' to auto-generate individual fields)\n    partSpeciesNames\n    (\n    speciesC\n    );\n    partSpeciesFluxNames\n    (\n    speciesCFlux\n    );\n    partSpeciesTransCoeffNames\n    (\n    speciesCTransCoeff\n    );\n    partSpeciesFluidNames\n    (\n    speciesCFluid\n    );\n    DMolecular\n    (\n    1e-5\n    );\n}
\n
\n
\n

Description

\n

This “forceModel” does not influence the particles or the fluid flow!\nUsing the particles’ temperature and/or species a scalar field\nrepresenting “particle-fluid heatflux” and/or “particle-fluid speciesflux” is calculated.

\n

This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\nand OpenFOAM®. Note: this code is not part of OpenFOAM® (see DISCLAIMER).

\n

Two way general scalar exchange between DEM and CFD\nconvective heat and species transfer model. The standard model is that of\nDeen, N.G. et al., Review of direct numerical simulation of\nfluid-particle mass, momentum and heat transfer in dense gas-solid flows.\nChemical Engineering Science 116 (2014) 710-724.\nThis correlation is based on that of Gunn (1978).

\n

The switch ‘useGeneralCorrelation’ allows one to specify the parameters\nof the Gunn correlation as a list called ‘generalCorrelationParameters’.

\n

Alternatively, the correclation of\nLi and Mason (2000), A computational investigation of transient heat\ntransfer in pneumatic transport of granular particles, Pow.Tech 112\ncan be activated. However, this correlation is not suitable for\ndense granular flows.

\n

If the particleShapeType multisphere is selected, caluclations are performed for multisphere particles. In this operation mode additional input for DHc or area per particle type may be required. Without this input the multisphere variant may fail.

\n

WARNING:\nThis model REQUIRES the ‘generalManual’ speciesTransportModel

\n
\n
\n

Restrictions

\n

Goes only with cfdemSolverPimpleImEx and cfdemSolverPisoSTM. The force model has to be the second (!!!) model in the forces list.

\n
\n
\n

Related commands

\n

forceModel forceModel_LaEuScalarTemp

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_virtualMassForce.html", "content": "\n\n\n \n\n \n forceModel_virtualMassForce command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_virtualMassForce command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_virtualMassForce command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    virtualMassForce\n);\nvirtualMassForceProps\n{\n    velFieldName "U";\n    phiFieldName "phi";\n    splitUrelCalculation switch1;\n    Cadd scalar1;\n    treatForceExplicit switch2;\n    treatForceDEM switch3;\n    interpolation switch4;\n    UInterpolationType "type1"\n    DDtUInterpolationType "type2"\n};\n
\n
\n
    \n

  • U = (optional, default “U”) name of the finite volume fluid velocity field

    • \n

  • phi = name of the finite volume flux field

    • \n

  • switch1 = indicator to split calculation of Urel between CFDEM and LIGGGHTS

    • \n

  • scalar1 = scalar value

    • \n

  • switch2 = (optional, default true) sub model switch, see forceSubModel for details

    • \n

  • switch3 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • switch4 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • type1 = (optional, default cellPointFace) interpolation type for U field

    • \n

  • type2 = (optional, default cellPointFace) interpolation type for ddt(U) field

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    virtualMassForce\n);\nvirtualMassForceProps\n{\n    velFieldName "U";\n}\n
\n
\n
\n
\n

Description

\n

The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The virtualMassForce model calculates the virtual mass force for each particle.

\n
\n
\n

Restrictions

\n

Model not validated!

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_viscForce.html", "content": "\n\n\n \n\n \n forceModel_viscForce command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_viscForce command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_viscForce command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    viscForce;\n);\nviscForceProps\n{\n    velocityFieldName "U";\n    useAddedMass scalar1;\n    suppressProbe switch1;\n    treatForceExplicit switch2;\n    treatForceDEM switch3;\n    interpolation switch4;\n    divTauInterpolationType "type1";\n    scalarViscosity switch5;\n    nu scalar2;\n};\n
\n
\n
    \n

  • U = (optional, default “U”) name of the finite volume fluid velocity field

    • \n

  • scalar1 = (optional) coefficient of added mass accounted for

    • \n

  • switch1 = (optional, default false) can be used to suppress the output of the probe model

    • \n

  • switch2 = (optional, default true) sub model switch, see forceSubModel for details

    • \n

  • switch3 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • switch4 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • type1 = (optional, default cellPointFace) interpolation type for div(Tau) field

    • \n

  • switch5 = (optional, default false) sub model switch, see forceSubModel for details

    • \n

  • scalar2 = optional, only if switch5 is true

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    viscForce;\n);\nviscForceProps\n{\n    velocityFieldName "U";\n}\n
\n
\n
\n
\n

Description

\n

The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The viscForce model calculates the particle based viscous force, -(grad(tau)) * Vparticle (see Zhou et al. (2010): “Discrete particle simulation of particle-fluid flow: model formulations and their applicability”, JFM).

\n
\n
\n

Restrictions

\n

none.

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceModel_volWeightedAverage.html", "content": "\n\n\n \n\n \n forceModel_volWeightedAverage command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceModel_volWeightedAverage command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceModel_volWeightedAverage command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
forceModels\n(\n    volWeightedAverage\n);\nvolWeightedAverageProps\n{\n    startTime time;\n    scalarFieldNames\n    (\n        scalarField\n    );\n    vectorFieldNames\n    (\n        vectorField\n    );\n    upperThreshold scalar1;\n    lowerThreshold scalar2;\n    useVolumeFraction switch0;\n    volumeFractionName word1;\n    verbose ;\n    writeToFile switch1;\n};\n
\n
\n
    \n

  • time = (optional, default 0.) time to start the averaging

    • \n

  • scalarField = names of the finite volume scalar fields to be temporally averaged

    • \n

  • vectorField = names of the finite volume vector fields to be temporally averaged

    • \n

  • scalar1 = only cells with a field value (magnitude) lower than this upper threshold are considered

    • \n

  • scalar2 = only cells with a field value (magnitude) greater than this lower threshold are considered

    • \n

  • switch0 = (optional, default false) consider a volume fraction for the calculation

    • \n

  • word1 = (optional, default “voidfraction”) name of the volume fraction, only used if useVolumeFraction is true

    • \n

  • verbose = (optional, default false) keyword only (mostly used for debugging)

    • \n

  • switch1 = (optional, default false) switch for the output.

    • \n
\n
\n
\n

Examples

\n
forceModels\n(\n    volWeightedAverage\n);\nvolWeightedAverageProps\n{\n    startTime 0.1;\n    scalarFieldNames\n    (\n        voidfraction\n    );\n    vectorFieldNames\n    (\n    );\n    upperThreshold 0.999;\n    lowerThreshold 0;\n}\n
\n
\n
\n
\n

Description

\n

This “forceModel” does not influence the particles or the simulation - it is a postprocessing tool! Starting at start time\nthe volume weighted averages of those cells of the fields within the threshold are calculated.\nAt “writeTime” a field named volAverage_field , where scalarField is the name of the original field, is written. This can then be probed using standard function object probes.

\n
\n
\n

Restrictions

\n

Currently all fields have the same threshold value!

\n
\n
\n

Related commands

\n

forceModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceSubModel.html", "content": "\n\n\n \n\n \n forceSubModel command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceSubModel command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceSubModel command

\n
\n

Syntax

\n

Defined in couplingProperties sub-dictionary of the force model in use. If no force sub-model is applied ImEx is used as default. If the keyword “forceSubModels” is provided, a choice of sub model is demanded.

\n
forceSubModels\n(\n    model_x\n    model_y\n);\n
\n
\n
    \n

  • model = name of force sub-model to be applied

    • \n
\n
\n
\n

Examples

\n
forceSubModels\n(\n    ImEx\n);\n
\n
\n
\n

Note

\n

This examples list might not be complete - please look for other models (forceSubModel_XY) in this documentation.

\n
\n
\n
\n

Description

\n

The force sub model is designed to hold the settings a force model can have. For now it handles the treatExplicit, treatDEM and implDEM option.

\n

Switches:

\n

Depending on the availability within the respective force model, a number of switches can be activated:

\n

treatForceExplicit: switch for the purely explicit consideration of the force term in the equation of motion on the CFD side (off -> the force is considered semi-implicitly; default off)\ntreatForceDEM: switch for the consideration of the forces on the DEM side only (off -> calculate forces for DEM and CFD; default off)\nimplForceDEM: If true, the fluid velocity and drag coefficient are communicated to the DEM calculation at each coupling time step and the drag force is calculated at each DEM time step, using the current particle velocity. If false, a force term is communiated to the DEM calculation at each coupling time step, the term is constant for one coupling interval. (on -> DEM forces are updated every DEM step; default off)\nimplForceDEM: If true, all fields for implicit torque handling on DEM side are communicated to DEM. (default off)\nverbose: switch for debug output to screen (on -> enable debug output; default off)\ninterpolation: switch for the usage of interpolation models when getting data for the Lagrangian calculation from Eulerian fields; If false, the cell centre values are used. (default off)\nuseFilteredDragModel: switch for using a coarse-grid version of the Beetstra drag model (takes grid-size effects into account; default = off)\nuseParcelSizeDependentFilteredDrag: switch for using a coarse-grid version of the Beetstra drag model (takes parcel-size effects into account, will force the switch useFilteredDragModel to “on”; default = off)\nimplForceDEMaccumulated: Can only be used in combination with implForceDEM switch, drag force values of each DEM time step are accumulated and passed on to the CFD-calculation. (default off)\nscalarViscosity: switch for the usage of a user-defined viscosity nu for the calculation of the drag force; The CFD calculation always uses the value of the transport model. (off -> use tranportProperties nu; default off)\nvoidageFunctionDiFelice: switch for the usage of the DiFelice voidage correction function during the drag force calculation. The correction is given by the relation\nXi = 3.7 - 0.65 * exp(-sqr(1.5-log10(Rep))/2),\nwhere Rep is the particle Reynolds number.\nIf switch is set to true, the voidageFunctionRong switch (or others) must be set to false if false is not the default value for the selected model.\nvoidageFunctionRong: switch for the usage of the Rong voidage correction function during the drag force calculation. The correction is given by the relation\nXi = 2.65 * (voidfraction + 1) - (5.3-3.5*voidfraction)*sqr(voidfraction)*exp(-sqr(1.5-log10(Rep))/2),\nwhere Rep is the particle Reynolds number.\nvoidageFunctionTang: switch for the usage of the Tang voidage correction function during the drag force calculation. The correction is given by the relation\nXi = 2 - log10(((1.5*sqrt(1-voidfraction)+1)*voidfraction^2 - (10*(voidfraction-1))/(voidfraction^2) + (0.0644*voidfraction^-4+0.169*voidfraction)*Rep^0.657 - (0.00456*Rep)*voidfraction^-4 + 0.11*(voidfraction-2)*(voidfraction-1)*Rep) / (0.2334*Rep^0.657 - 0.00456*Rep + 1)) / log10(voidfraction); (see: 2018,ChemEngSci, Mahajan et al., Non-spherical particles in a pseudo-2d fluidized bed: Modelling Study)\n,\nwhere Rep is the particle Reynolds number.:ul

\n
\n
\n

Restrictions

\n

None.

\n
\n
\n

Related commands

\n

ImEx

\n

Default: ImEx.

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/forceSubModel_ImEx.html", "content": "\n\n\n \n\n \n forceSubModel_ImEx command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • forceSubModel_ImEx command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

forceSubModel_ImEx command

\n
\n

Syntax

\n

Defined in couplingProperties sub-dictionary of the force model in use.

\n

forceSubModels\n(

\n
\n

ImEx;

\n
\n

);

\n

treatExplicit true; // optional for some force models.\ntreatDEM true; // optional for some force models.\nimplDEM true; // optional for some force models.

\n
\n
\n

Examples

\n

forceSubModels\n(

\n
\n

ImEx;

\n
\n

);\ntreatExplicit true; // optional for some force models.

\n
\n
\n

Description

\n

If no force sub-model is applied ImEx is used as default. If the keyword “forceSubModels” is provided, a choice of sub model is demanded. Depending on the force model different keywords are read and can therefrore be set (see the log file). If the keyword is provided, its value is used.

\n
\n
\n

Restrictions

\n

none.

\n
\n
\n

Related commands

\n

forceSubModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/fvOptions.html", "content": "\n\n\n \n\n \n fvOptions dictionary — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • fvOptions dictionary
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

fvOptions dictionary

\n
\n

Syntax

\n
\n
\n

Description

\n

An fvOptions dictionary ca be used to impose physics that can be represented as forces or constraints on the governing equations, such as for example porous media or imposed flow velocities.

\n
\n
\n

Restrictions

\n

No known restrictions.

\n
\n
\n

Related commands

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/fvOptions_meanSupVelocityForce.html", "content": "\n\n\n \n\n \n fvOptions_meanSupVelocityForce command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • fvOptions_meanSupVelocityForce command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

fvOptions_meanSupVelocityForce command

\n
\n

Syntax

\n

Defined in an fvOptions dictionary in the system folder of the CFD case. Can only be applied if solver is able to handle fvOptions.

\n
fvOptions uniformFixedValueVoidfraction;\n
\n
\n
\n
\n

Examples

\n
momentumSource\n{\n    type            meanSupVelocityForce;\n    active          yes;\n    meanSupVelocityForceCoeffs\n    {\n        seletionMode    all; // all and cellZoneSet is permitted\n        fieldNames      (U); // velocity field\n        twoPhase        true; // refers to the number of fluid/liquid phases\n        alphaField      alpha.water; // mandatory if twoPhase is set to true\n        coupled         true; // refers to the presence of a particle phase\n        voidfractionField voidfraction; // mandatory if coupled is set to true\n        Ubar            (1 0 0); // desired mean superficial velocity\n        relaxation      0.9; // optional relaxation factor;\n        alphaMin        0.9999; // settings will only take place in cells with alpha >= alphaMin (smoothening)\n\n    }\n}\n
\n
\n
\n
\n

Description

\n

The fvOption meanSupVelocityForce can be used to impose an average superficial velocity within a specific area (either defined by all when the whole domain is affected or the name of the according cellZoneSet), while at the same time accounting for the resulting pressure drop. The fvOption can be used for fluid/fluid, fluid/particle and fluid/fluid/particle cases, whereas Ubar can only be imposed to one of the fluid phases. Application examples are periodic channel flow situations or pumps within the computational domain. Please note that particularly for periodic channel flows instabilities might occur at the air-water interface due to the big differences in the densities. For such cases a cutoff-vlaue alphaMin has been introduced, which allows the user to restrict the affected area by means of a minimal phase fraction.

\n
\n
\n

Restrictions

\n

No known restrictions.

\n
\n
\n

Related commands

\n

fvOptions

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/genindex.html", "content": "\n\n\n \n \n Index — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • Index
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n\n

Index

\n\n
\n A\n | C\n | D\n | F\n | I\n | L\n | M\n | P\n | S\n | V\n \n
\n

A

\n\n \n \n
\n\n

C

\n\n \n \n
\n\n

D

\n\n \n \n
\n\n

F

\n\n \n \n
\n\n

I

\n\n \n \n
\n\n

L

\n\n \n \n
\n\n

M

\n\n \n \n
\n\n

P

\n\n \n \n
\n\n

S

\n\n \n \n
\n\n

V

\n\n \n \n
\n\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/liggghtsCommandModel.html", "content": "\n\n\n \n\n \n liggghtsCommandModel command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • liggghtsCommandModel command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

liggghtsCommandModel command

\n
\n

Syntax

\n

Defined in liggghtsCommmands dictionary.

\n
liggghtsCommandModels\n(\n    model_x\n    model_y\n);\n
\n
\n
    \n

  • model = name of the liggghtsCommandModel to be applied

    • \n
\n
\n
\n

Examples

\n
liggghtsCommandModels\n(\n   runLiggghts\n   writeLiggghts\n);\n
\n
\n
\n

Note

\n

This examples list might not be complete - please look for other models (liggghtsCommandModel_XY) in this documentation.

\n
\n
\n
\n

Description

\n

The liggghtsCommandModel is the base class to execute DEM commands within a CFDEM® run.

\n
\n
\n

Restrictions

\n

Works only with MPI coupling.

\n

Default: none.

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/liggghtsCommandModel_execute.html", "content": "\n\n\n \n\n \n liggghtsCommandModel_execute command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • liggghtsCommandModel_execute command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

liggghtsCommandModel_execute command

\n
\n

Syntax

\n

Defined in liggghtsCommmands dictionary.

\n
liggghtsCommandModels\n(\n   execute\n);\nexecuteProps0\n{\n    command\n    (\n        run\n        $couplingInterval\n    );\n    runFirst switch1;\n    runLast switch2;\n    runEveryCouplingStep switch3;\n    runEveryWriteStep switch4;\n    verbose;\n}\n
\n
\n
    \n

  • command = LIGGGHTS command to be executed. Each word in a new line, numbers and symbols need special treatment (e.g. $couplingInterval will be replaced by correct coupling interval in the simulation). For using arbitrary labels and number use the placeholders label and number in the command and define them in a labels and scalars section below the command (see example below). For using pathes within commands, particular keywords are provided (details see description)

    • \n

  • switch1 = switch (choose on/off) if the command is executed only at first time step

    • \n

  • switch2 = switch (choose on/off) if the command is executed only at last time step

    • \n

  • switch3 = switch (choose on/off) if the command is executed at every coupling step

    • \n

  • switch4 = switch (choose on/off) if the command is executed at every writing step

    • \n

  • verbose = (normally off) for verbose run

    • \n
\n
\n
\n

Examples

\n
liggghtsCommandModels\n(\n   execute\n   execute\n   execute\n);\nexecuteProps0\n{\n    command\n    (\n        run\n        $couplingInterval\n    );\n    runFirst off;\n    runLast off;\n    runEveryCouplingStep on;\n}\nexecuteProps1\n{\n    command\n    (\n        write_restart\n        noBlanks\n        dotdot\n        slash\n        DEM\n        slash\n        liggghts.restart_\n        timeStamp\n    );\n    runFirst off;\n    runLast off;\n    runEveryCouplingStep off;\n    runEveryWriteStep on;\n}\nexecuteProps3\n{\n    command\n    (\n        create_atoms\n        label\n        single\n        number\n        number\n        number\n        units\n        box\n    );\n    labels\n    (\n        1\n    );\n    scalars\n    (\n        0.\n        0.\n        0.001\n    );\n    runFirst off;\n    runLast off;\n    runEveryCouplingStep off;\n    runEveryWriteStep off;\n    startTime 0.09;\n    endTime 0.09;\n    timeInterval 0.001;\n}\n
\n
\n
\n
\n

Description

\n

The execute liggghtsCommand Model can be used to execute a LIGGGHTS command during a CFD run. In above example execute_0 for instance executes “run $couplingInterval” every coupling step. $couplingInterval is automatically replaced by the correct number of DEM steps. Additionally execute_1 executes “write_restart ../DEM/liggghts.restart_$timeStamp” every writing step, where $timeStamp is automatically set. The keywords used in the command (dot, dotdot, slash) are replaced by the according signs internally, noBlanks inidicates the the following words are not separated by blanks. Using the keyword blanks would re-enable the usage of blanks again.

\n
\n

These rather complex execute commands can be replaced by the “readLiggghts” and “writeLiggghts” commands!

\n
\n
\n
\n

Restrictions

\n
\n

None.

\n
\n
\n
\n

Related commands

\n

liggghtsCommandModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/liggghtsCommandModel_readLiggghtsData.html", "content": "\n\n\n \n\n \n liggghtsCommandModel_readLiggghtsData command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • liggghtsCommandModel_readLiggghtsData command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

liggghtsCommandModel_readLiggghtsData command

\n
\n

Syntax

\n

Defined in liggghtsCommmands dictionary.

\n
liggghtsCommandModels\n(\n   readLiggghtsData\n);\nreadLiggghtsDataProps0\n{\n    startIndex "scalar1";\n    verbose ;\n    exactTiming ;\n    filePath\n    (\n        "word"\n    );\n    runFirst "bool1";\n    runEveryCouplingStep "bool2";\n    startTime "scalar2";\n    endTime "scalar3";\n    timeInterval "scalar4";\n}\n
\n
\n
    \n

  • scalar1 = start index of data file to be read

    • \n

  • verbose = (default off) flag for verbose run

    • \n

  • exactTiming = flag indicating that start time should be kept even during a coupling interval

    • \n

  • filePath = path to LIGGGHTS data file. Each word in a new line, numbers and symbols need special treatment (e.g. $couplingInterval will be replaced by correct coupling interval in the simulation)

    • \n

  • bool1 = true if to be run at first timestep only (prio 1)

    • \n

  • bool2 = true if to be run at every coupling step (prio 2)

    • \n

  • scalar2 = if bool2 and bool3 false then starts at scalar2 (prio 3) run

    • \n

  • scalar3 = if bool2 and bool3 false then it ends at scalar3 (prio 3) run

    • \n

  • scalar4 = if bool2 and bool3 false then it repeats at scalar3 increasing the data file index (prio 3) run

    • \n
\n
\n
\n

Examples

\n
liggghtsCommandModels\n(\n   readLiggghtsData\n);\nreadLiggghtsDataProps0\n{\n    startIndex 0;\n    exactTiming true;\n    filePath\n    (\n        dotdot\n        slash\n        DEM\n        slash\n        packing.data\n    );\n    runFirst off;\n    runEveryCouplingStep off;\n    startTime 0.002;\n    endTime 0.012;\n    timeInterval 0.001;\n}\n
\n
\n
\n
\n

Description

\n

The readLiggghtsData liggghtsCommand Model can be used to read liggghts data files into liggghts during runtime of a coupled simulation.

\n
\n
\n

Restrictions

\n

Note: Model is not up to date.

\n
\n
\n

Related commands

\n

liggghtsCommandModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/liggghtsCommandModel_runLiggghts.html", "content": "\n\n\n \n\n \n liggghtsCommandModel_runLiggghts command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • liggghtsCommandModel_runLiggghts command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

liggghtsCommandModel_runLiggghts command

\n
\n

Syntax

\n

Defined in liggghtsCommmands dictionary.

\n
liggghtsCommandModels\n(\n   runLiggghts\n);\n//- optional\nrunLiggghtsProps\n{\n    preNo true;\n    verbose; (optional)\n    runFirst true; (optional, default false)\n}\n
\n
\n
\n
\n

Examples

\n
liggghtsCommandModels\n(\n   runLiggghts\n);\n
\n
\n
\n
\n

Description

\n

The liggghtsCommand models can be used to execute a LIGGGHTS command during a CFD run. The “runLiggghts” command executes the command “run $nrDEMsteps”, where $nrDEMsteps is automatically set according to the coupling intervals, every coupling step. Optionally a dictionary called runLiggghtsProps can be specified where the “preNo” switch can be set, which uses the command “run $nrDEMsteps pre no” for every time step except the first. If the runFirst option is chosen the run command is executed only at the first coupling step.

\n
\n
\n

Restrictions

\n
\n

Warning: the “pre no” option can cause troubles (dump data of particles changing the domain might be erroneous)!

\n
\n
\n
\n

Related commands

\n

liggghtsCommandModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/liggghtsCommandModel_setDEMGravity.html", "content": "\n\n\n \n\n \n liggghtsCommandModel_setDEMGravity command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • liggghtsCommandModel_setDEMGravity command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

liggghtsCommandModel_setDEMGravity command

\n
\n

Syntax

\n

Defined in liggghtsCommmands dictionary.

\n

liggghtsCommandModels\n(

\n
\n

setDEMGravity

\n
\n

);

\n
setDEMGravityProps0\n{\n    runFirst switch1;\n    startTime scalar1;\n    endTime scalar2;\n    timeInterval scalar3;\n    verbose;\n    unfix switch2;\n}\n
\n
\n
    \n

  • switch1 = switch (must be on!!!) to select if executed only first step.

    • \n

  • scalar1 = start time of command (use simulation start time)

    • \n

  • scalar2 = end time of command (use simulation start time)

    • \n

  • scalar3 = time interval of command (use 1.)\nverbose = (normally off) for verbose run

    • \n

  • switch2 = (false by default) switch to select if the command is used as fix (default) or unfix

    • \n
\n
\n
\n

Examples

\n
liggghtsCommandModels\n(\n   runLiggghts\n   setDEMGravity\n);\nsetDEMGravityProps1\n{\n    runFirst on;\n    startTime 0;\n    endTime 0;\n    timeInterval 1;\n    verbose;\n    unfix false;\n}\n
\n
\n
\n
\n

Description

\n

The liggghtsCommand models can be used to set LIGGGHTS gravity during a CFD run.

\n
\n
\n

Restrictions

\n
\n

None.

\n
\n
\n
\n

Related commands

\n

liggghtsCommandModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/liggghtsCommandModel_writeLiggghts.html", "content": "\n\n\n \n\n \n liggghtsCommandModel_writeLiggghts command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • liggghtsCommandModel_writeLiggghts command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

liggghtsCommandModel_writeLiggghts command

\n
\n

Syntax

\n

Defined in liggghtsCommmands dictionary.

\n
liggghtsCommandModels\n(\n   writeLiggghts\n);\n//- optional\nwriteLiggghtsProps\n{\n    writeLastOnly switch1;\n    path "path";\n    writeName "name";\n    overwrite switch2;\n    writeEvery "label1";\n    verbose;\n}\n
\n
\n
    \n

  • switch1 = (optional, default off) switch to select if only(!) last step is stored or every write step.

    • \n

  • path = (optional, default “../DEM”) alternative write path relative to execution directory for saving the restart file. Path must exist!

    • \n

  • name = (optional, default “liggghts.restartCFDEM”) name of the restart file to be written in path. Note: You can define a path and filename, where the path will be created if it does not exist.

    • \n

  • switch2 = (optional, default off) switch to select if only one restart file $name or many files $name_$timeStamp are written

    • \n

  • label1 = (optional, default 1) restart file is written every label1 number of write intervals\nverbose = (optional, default off) flag for verbose output

    • \n
\n
\n
\n

Examples

\n
liggghtsCommandModels\n(\n   runLiggghts\n   writeLiggghts\n);\n
\n
\n
\n
\n

Description

\n

The liggghtsCommand models can be used to execute a LIGGGHTS command during a CFD write. The “writeLiggghts” command executes the command “write_restart $name”, where $name is the name of the restart file, every write step or every X time steps if the writeEvery keyword is used.

\n
\n
\n

Restrictions

\n
\n

None.

\n
\n
\n
\n

Related commands

\n

liggghtsCommandModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/locateModel.html", "content": "\n\n\n \n\n \n locateModel command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • locateModel command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

locateModel command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
locateModel model;\n
\n
\n
    \n

  • model = name of the locateModel to be applied

    • \n
\n
\n
\n

Examples

\n
locateModel engine;\n
\n
\n
\n

Note

\n

This examples list might not be complete - please look for other models (locateModel_XY) in this documentation.

\n
\n
\n
\n

Description

\n

The locateModel is the base class for models which search for the CFD cell and cellID corresponding to a position. In general it is used to find the cell a particle is located in.

\n
\n
\n

Restrictions

\n
\n

none.

\n
\n

Default: none.

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/locateModel_engineSearch.html", "content": "\n\n\n \n\n \n locateModel_engineSearch command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • locateModel_engineSearch command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

locateModel_engineSearch command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
locateModel engine;\nengineProps\n{\n    treeSearch switch1;\n}\n
\n
\n
    \n

  • switch1 = (optional, default true) switch to use tree search algorithm

    • \n
\n
\n
\n

Examples

\n
locateModel engine;\nengineProps\n{\n    treeSearch true;\n}\n
\n
\n
\n
\n

Description

\n

The locateModel “engine” locates the CFD cell and cellID corresponding to a given position.\nA geometric search using the last known cellID is implemented.\nThe engineSearch locate model can be used with different settings to use different fallback algorithms,\nif there is no previously found cellID:

\n

The model will use the walk algorithmus using the provided seed cell, if this is not successful, it will if:

\n
    \n

  • treeSearch false; fall back to geometric (linear) search

    • \n

  • treeSearch true; fall back to a recursive tree search to find the cell (recommended).

    • \n
\n
\n
\n

Restrictions

\n
\n

none.

\n
\n
\n
\n

Related commands

\n

locateModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/locateModel_engineSearchIB.html", "content": "\n\n\n \n\n \n locateModel_engineSearchIB command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • locateModel_engineSearchIB command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

locateModel_engineSearchIB command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
locateModel engineIB;\nengineIBProps\n{\n    treeSearch switch1;\n    zSplit value1;\n    xySplit value2;\n    checkPeriodicCells;\n}\n
\n
\n
    \n

  • switch1 = names of the finite volume scalar fields to be temporally averaged

    • \n

  • value1 = number of z-normal layers for satellite points (optional, default 8)

    • \n

  • value2 = number of satellite points in each layer (optional, default 16)

    • \n

  • checkPeriodicCells = (optional, default false) flag for considering the minimal distance to all periodic images of this particle

    • \n
\n
\n
\n

Examples

\n
locateModel engineIB;\nengineIBProps\n{\n    treeSearch false;\n    zSplit 8;\n    xySplit 16;\n}\n
\n
\n
\n
\n

Description

\n

The locateModel “engine” locates the CFD cell and cellID corresponding to a given position. This locate model is especially designed for parallel immersed boundary method. Each particle is represented by “satellite points” if it is distributed over several processors.

\n

The engineSearchIB locate Model can be used with different settings to use different algorithms:

\n
    \n

  • treeSearch false; will execute some geometric (linear) search using the last known cellID (recommended)

    • \n

  • treeSearch true; will use a recursive tree structure to find the cell.

    • \n
\n

This model is a modification of the engine search model. Instead of using the centre-cell as starting point for the engine search, further satellite points located on the surface of the sphere are checked. This ensures that (parts of) spheres can be located even when their centre is on another processor. This is especially important for parallel computations, when a sphere is about to move from one processor to another.

\n
\n
\n

Restrictions

\n

Only for immersed boundary solvers!

\n
\n
\n

Related commands

\n

locateModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/locateModel_standardSearch.html", "content": "\n\n\n \n\n \n locateModel_standardSearch command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • locateModel_standardSearch command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

locateModel_standardSearch command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
locateModel standard;\n
\n
\n
\n
\n

Examples

\n
locateModel standard;\n
\n
\n
\n
\n

Description

\n

The locateModel “standard” locates the CFD cell and cellID corresponding to a given position. A very straight-forward (robust!) locate algorithm is used.

\n
\n
\n

Restrictions

\n
\n

none.

\n
\n
\n
\n

Related commands

\n

locateModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/meshMotionModel.html", "content": "\n\n\n \n\n \n meshMotionModel command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • meshMotionModel command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

meshMotionModel command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
meshMotionModel model;\n
\n
\n
    \n

  • model = name of the meshMotionModel to be applied

    • \n
\n
\n
\n

Examples

\n
meshMotionModel noMeshMotion;\n
\n
\n
\n

Note

\n

This examples list might not be complete - please look for other models (meshMotionModel_XY) in this documentation.

\n
\n
\n
\n

Description

\n

The meshMotionModel is the base class for models which manipulate the CFD mesh according to the DEM mesh motion.

\n
\n
\n

Restrictions

\n
\n

none.

\n
\n

Default: none.

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/meshMotionModel_noMeshMotion.html", "content": "\n\n\n \n\n \n meshMotionModel_noMeshMotion command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • meshMotionModel_noMeshMotion command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

meshMotionModel_noMeshMotion command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
meshMotionModel noMeshMotion;\n
\n
\n
\n
\n

Examples

\n
meshMotionModel noMeshMotion;\n
\n
\n
\n
\n

Description

\n

The noMeshMotion-model is a dummy meshMotion model.

\n
\n
\n

Restrictions

\n
\n

None.

\n
\n
\n
\n

Related commands

\n

meshMotionModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/momCoupleModel.html", "content": "\n\n\n \n\n \n momCoupleModel command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • momCoupleModel command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

momCoupleModel command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
momCoupleModels\n(\n    model\n);\n
\n
\n
    \n

  • model = name of the momCoupleModel to be applied

    • \n
\n
\n
\n

Examples

\n
momCoupleModels\n(\n    implicitCouple\n);\n
\n
\n
\n

Note

\n

This examples list might not be complete - please look for other models (momCoupleModel_XY) in this documentation.

\n
\n

Forces can be coupled in an implicit way to the fluid solver (i.e., when solving the Navier-Stokes equations, the fluid velocity at the new time will be considered for the coupling force). This implicit coupling is typically done for the drag forces (look for “impForces()” in the implementation of the drag model). Implicit coupling is more stable (especially important for dense flows), but conflicts Newton’s third law. Explicit forces are imposed on the flow solver in an explicit fashion (look for “expForces()” in the implementation of the drag model), which is less stable, but does not conflict Newton’s third law.

\n

Note that the switch “treatVoidCellsAsExplicitForce true;” can be set in the couplingProperties in order to change the treatment of cells which are void of particles. This is only relevant if (i) smoothing is used, and (ii) implicit force coupling is performed. By default, the particle veloctiy field (Us) will be smoothed to obtain a meaningful reference quantity for the implicit force coupling. In case “treatVoidCellsAsExplicitForce true;” is set, however, Us will not be smoothed and implicit forces (after the smoothing has been performed) in cells void of particles be treated as explicit ones. This avoids the problem of defining Us in cells that are void of particles, but for which an implicit coupling force is obtained in the smoothing process.

\n
\n
\n

Description

\n

The momCoupleModel is the base class for momentum exchange between DEM and CFD simulation.

\n
\n
\n

Restrictions

\n
\n

none.

\n
\n

Default: none.

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/momCoupleModel_explicitCouple.html", "content": "\n\n\n \n\n \n momCoupleModel_explicitCouple command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • momCoupleModel_explicitCouple command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

momCoupleModel_explicitCouple command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
momCoupleModels\n(\n    explicitCouple\n);\nexplicitCoupleProps\n{\n    fLimit vector;\n}\n
\n
\n
    \n

  • vector = limiter vector for explicit force term (default (1e10,1e10,1e10) )

    • \n
\n
\n
\n

Examples

\n
momCoupleModels\n(\n    explicitCouple\n);\nexplicitCoupleProps\n{\n    fLimit (1e3 1e2 1e4);\n}\n
\n
\n
\n
\n

Description

\n

The explicitCouple-model is a momCoupleModel model providing an explicit momentum source term for the CFD solver and additionally it superposes an additional source field which can be set via the function setSourceField.

\n
\n
\n

Restrictions

\n

Only for solvers that include explicit momentum exchange.

\n
\n
\n

Related commands

\n

momCoupleModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/momCoupleModel_implicitCouple.html", "content": "\n\n\n \n\n \n momCoupleModel_implicitCouple command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • momCoupleModel_implicitCouple command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

momCoupleModel_implicitCouple command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
momCoupleModels\n(\n    implicitCouple\n);\nimplicitCoupleProps\n{\n    velFieldName "U";\n    granVelFieldName "Us";\n    voidfractionFieldName "voidfraction";\n    minAlphaP number;\n}\n
\n
\n
    \n

  • U = (optional, default “U”) name of the finite volume fluid velocity field

    • \n

  • Us = (optional, default “Us”) name of the finite volume granular velocity field

    • \n

  • voidfraction = (optional, default “voidfraction”) name of the finite volume voidfraction field

    • \n
\n

number = minimum value for local particle volume fraction to calculate the exchange filed (default SMALL):l

\n
\n
\n

Examples

\n
momCoupleModels\n(\n    implicitCouple\n);\nimplicitCoupleProps\n{\n    velFieldName "U";\n    granVelFieldName "Us";\n    voidfractionFieldName "voidfraction";\n}\n
\n
\n
\n
\n

Description

\n

The implicitCouple-model is a momCoupleModel model providing an implicit momentum source term for the CFD solver.

\n
\n
\n

Restrictions

\n

Only for solvers that include implicit momentum exchange.

\n
\n
\n

Related commands

\n

momCoupleModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/momCoupleModel_noCouple.html", "content": "\n\n\n \n\n \n momCoupleModel_noCouple command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • momCoupleModel_noCouple command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

momCoupleModel_noCouple command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
momCoupleModels\n(\n    off\n);\n
\n
\n
\n
\n

Examples

\n
momCoupleModels\n(\n    off\n);\n
\n
\n
\n
\n

Description

\n

The noCouple-model is a dummy momCoupleModel model providing a no momentum source term for the CFD solver.

\n
\n
\n

Restrictions

\n

Only for solvers that include no momentum exchange, e.g. immersed boundary.

\n
\n
\n

Related commands

\n

momCoupleModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/probeModel.html", "content": "\n\n\n \n\n \n probeModel command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • probeModel command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

probeModel command

\n
\n

Syntax

\n

To be activated via couplingProperties dictionary.

\n
probeModel myProbeModel;\n
\n
\n

Use probe model “off” to disable this feature.

\n
myProbeModelProps\n{\nprobeModelSetting mySetting\n};\n
\n
\n
\n
\n

Examples

\n

See particleProbe

\n
\n

Note

\n

This examples list might not be complete - please check below for the list of force models that can perform particle probing.

\n
\n
\n
\n

Description

\n

The probeModel feature allows to implement various probing features in CFDEM®. Currently, only the particleProbe model is implemented, that performs probing of particle forces.

\n
\n
\n

Restrictions

\n

None.

\n

Default: none.

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/probeModel_noProbe.html", "content": "\n\n\n \n\n \n probeModel_noProbe command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • probeModel_noProbe command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

probeModel_noProbe command

\n
\n

Syntax

\n

To be activated via couplingProperties dictionary.

\n
forceModels\n{\n    myForceModel1\n    myForceModel2\n    myForceModel3\n};\n
\n
\n

probeModel off;

\n
\n
\n

Examples

\n
probeModel off;\n
\n
\n

Note: This examples list might not be complete - please check below for the list of force models that can perform particle probing.

\n
\n
\n

Description

\n

Does not perform any probing.

\n
\n
\n

Restrictions

\n

None.

\n

Related commands which are currently enabled for particle probing:

\n

particleProbe

\n

Default: none.

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/probeModel_particleProbe.html", "content": "\n\n\n \n\n \n probeModel_particleProbe command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • probeModel_particleProbe command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

probeModel_particleProbe command

\n
\n

Syntax

\n

To be activated via couplingProperties dictionary.

\n

forceModels\n(

\n
\n

myForceModel1\nmyForceModel2\nmyForceModel3

\n
\n

);

\n

probeModel particleProbe;

\n
particleProbeProps\n{\n    particleIDsToSample (ID1 ID2 ID3 ...);  //list of particleIDs to sample\n    verboseToFile;                          //main switch\n    verbose;                                //currently not used\n    printEvery       xEvery;                //print every this many CFD time steps\n    printOnlyAtStep  xStep;                 //print only at this CFD time step (overrides "printEvery")\n    sampleAll;                              //Activate sampling for all particles\n    probeDebug;                             //probes additional fields\n    includePosition;                        //will include particle position in the output file\n    writePrecision xPrecision;              //number of significant digits to print\n};\n
\n
\n
    \n

  • particleIDsToSample = list of particle IDs to be sampled.

    • \n

  • myForceModeli = list of force models in the simulation, the particleProbe will be applied to all of these models!

    • \n

  • verboseToFile = main switch to activate the particle probe (default = off).

    • \n

  • verbose = main switch to activate output to Info (currently not implemented).

    • \n

  • xEvery = integer to specify the interval for sampling (default = 1, i.e., probing occurs every CFD time step).

    • \n

  • xStep = integer to specify the step for sampling (default = deactivated, i.e., it will print accordingly to “printEvery”).

    • \n

  • sampleAll = switch to activate sampling of all particles. Otherwise (default) only particles specified via “particleIDsToSample” in the couplingProperties dictionary will be sampled.

    • \n

  • probeDebug = switch to activate probing of debug properties of secondary importance (specific for each force model).

    • \n

  • includePosition = switch to add the particle position in the log file (default = off).

    • \n

  • xPrecision= number of significant digits of the text output (default = 3).

    • \n
\n
\n
\n

Examples

\n
particleIDsToSample (0 1 2 3);\nforceModels\n(\n    gradPForce\n);\nparticleProbeProps\n{\n    verboseToFile;       //main switch\n    verbose;                //currently not used\n    printEvery  100;      //print every this many CFD time steps\n    sampleAll;            //Activate sampling for all particles\n    probeDebug;  //probes additional fields\n    includePosition;  //will include particle position in the output file\n    writePrecision 4;           //number of significant digits to print\n};\n
\n
\n

Note: This examples list might not be complete - please check below for the list of force models that can perform particle probing.

\n
\n
\n

Description

\n

The particleProbe feature keeps track of per-particle quantities (e.g., the fluid-particle interaction forces) acting on each DEM particle, and handles its storage during the simulation. Data is saved in the CFD/particleProbes/startTime directory, where startTime is the time at which the simulation is started (this avoids unwanted deletion of particleProbe data).

\n
\n
\n

Restrictions

\n

You can manually switch off the probe model for each force model by specifying the Switch “suppressProbe” in the corresponding force properties dictionary.

\n

Related commands which are currently enabled for particle probing:

\n

gradPForce, viscForce, BeetstraDrag, HollowayDrag, MeiLift, as well as most other forceModels (see src directory for details, i.e., use “grep -r ‘probeM(’ ./” in the terminal).

\n

Default: none.

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/scalarTransportModel.html", "content": "\n\n\n \n\n \n scalarTransportModel command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • scalarTransportModel command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

scalarTransportModel command

\n
\n

Syntax

\n

Defined in scalarTransportProperties dictionary. A variety of derived classes exist that implement different physics of the scalarTransportModel. If no scalar transport shall be used, use the model ‘none’.

\n
scalarTransportModel model;\n
\n
\n
    \n

  • model = name of the scalarTransportModel to be applied

    • \n
\n
\n
\n

Examples

\n
scalarTransportModel generalManual;\n
\n
\n

Note: This examples list might not be complete - please look for other models (scalarTransportModel_XY) in this documentation.

\n
\n
\n

Description

\n

Solves the advection-dispersion transport equation for a dilute scalar quantity in the fluid phase. fvOptions can be specified to model sources, etc. in the fluid phase. Exchange models with a particle phase can be included by including appropriate forceModels in couplingProperties.

\n
\n
\n

Restrictions

\n
\n

none.

\n
\n

Default: none.

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/scalarTransportModel_generalManual.html", "content": "\n\n\n \n\n \n scalarTransportModel_generalManual command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • scalarTransportModel_generalManual command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

scalarTransportModel_generalManual command

\n
\n

Syntax

\n

Defined in scalarTransportProperties dictionary.

\n

scalarTransportModel generalManual;

\n
generalManualProps\n{\n    phiFieldName phiName;\n    voidfractionFieldName voidfractionName;\n    ScT scalar1;\n    PrT scalar2;\n    cpVolumetric scalar3;\n    cpVolumetricFieldName word1;\n    rhoMixFieldName word2;\n    eulerianFields\n    (\n        C\n        T\n    );\n\n}
\n
    \n

  • phiName = (optional) name of the surface field for the SUPERFICIAL flux, default “phi”.

    • \n

  • voidfractionName = (optional) name of the finite volume voidfraction field, default “voidfraction”.

    • \n

  • scalar1 = (optional, default 0.7) turbulent Schmidt Nr, set to large value to suppress turbulent species transport

    • \n

  • scalar2 = (optional, default 0.7) turbulent Prandtl Nr, set to large value to suppress turbulent heat transport

    • \n

  • scalar3 = (optional, alternatively define word1) volumetric heat capacity as a global constant (in contrast to cpVolumetricFieldName for a field). This is the mixture density times the heat capacity J/K/(m_voidspace)^3, will only be used if cpVolumetricFieldName, or updateMixtureProperties = false

    • \n

  • word1 = (optional, alternatively define scalar3) volumetric heat capacity as a field

    • \n

  • word3 = mixture density field

    • \n

  • C = concentration field name

    • \n

  • T = temperature field name

    • \n
\n
\n
\n

Examples

\n
generalManualProps\n{\n    phiFieldName "phi";\n    ScT 0.7;\n    PrT 0.7;\n    cpVolumetric 1196;\n    rhoMixFieldName "rhoMix";\n    eulerianFields\n    (\n        C\n        T\n    );\n\n    fvOptionsC\n    {\n    };\n\n    fvOptionsT\n    {\n    };\n\n}\n
\n
\n
\n
\n

Description

\n

Solves the advection-dispersion transport equation for a dilute scalar quantity in the fluid phase. fvOptions can be specified to model sources, etc. in the fluid phase. Exchange models with a particle phase can be included by including appropriate forceModels in couplingProperties.

\n
\n
\n

Restrictions

\n

The user MUST ensure the “phi” field is SUPERFICIAL (i.e., the fluid-phase velocity times voidfraction interpolatedat the cells’ faces). The code cannot know or check whether this is the case, so the user of a certain solver has to ensure this.

\n
\n
\n

Related commands

\n

none.

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/search.html", "content": "\n\n\n \n \n Search — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • Search
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n \n\n \n
\n \n
\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n \n \n \n \n\n\n\n" }, { "path": "doc/_build/html/searchindex.js", "content": "Search.setIndex({docnames:[\"CFDEMcoupling_Manual\",\"IOModel\",\"IOModel_basicIO\",\"IOModel_noIO\",\"IOModel_sophIO\",\"IOModel_trackIO\",\"averagingModel\",\"averagingModel_dense\",\"averagingModel_dilute\",\"cfdemSolverIB\",\"cfdemSolverPiso\",\"cfdemSolverPisoSTM\",\"cfdemSolverPisoScalar\",\"clockModel\",\"clockModel_noClock\",\"clockModel_standardClock\",\"dataExchangeModel\",\"dataExchangeModel_noDataExchange\",\"dataExchangeModel_oneWayVTK\",\"dataExchangeModel_twoWayFiles\",\"dataExchangeModel_twoWayMPI\",\"fix_couple_cfd\",\"fix_couple_cfd_force\",\"forceModel\",\"forceModel_Archimedes\",\"forceModel_ArchimedesIB\",\"forceModel_DiFeliceDrag\",\"forceModel_GidaspowDrag\",\"forceModel_KochHillDrag\",\"forceModel_LaEuScalarTemp\",\"forceModel_MeiLift\",\"forceModel_SchillerNaumannDrag\",\"forceModel_ShirgaonkarIB\",\"forceModel_checkCouplingInterval\",\"forceModel_fieldStore\",\"forceModel_fieldTimeAverage\",\"forceModel_gradPForce\",\"forceModel_noDrag\",\"forceModel_particleCellVolume\",\"forceModel_particleVolume\",\"forceModel_periodicPressure\",\"forceModel_scalarGeneralExchange\",\"forceModel_virtualMassForce\",\"forceModel_viscForce\",\"forceModel_volWeightedAverage\",\"forceSubModel\",\"forceSubModel_ImEx\",\"fvOptions\",\"fvOptions_meanSupVelocityForce\",\"liggghtsCommandModel\",\"liggghtsCommandModel_execute\",\"liggghtsCommandModel_readLiggghtsData\",\"liggghtsCommandModel_runLiggghts\",\"liggghtsCommandModel_setDEMGravity\",\"liggghtsCommandModel_writeLiggghts\",\"locateModel\",\"locateModel_engineSearch\",\"locateModel_engineSearchIB\",\"locateModel_standardSearch\",\"meshMotionModel\",\"meshMotionModel_noMeshMotion\",\"momCoupleModel\",\"momCoupleModel_explicitCouple\",\"momCoupleModel_implicitCouple\",\"momCoupleModel_noCouple\",\"probeModel\",\"probeModel_noProbe\",\"probeModel_particleProbe\",\"scalarTransportModel\",\"scalarTransportModel_generalManual\",\"smoothingModel\",\"smoothingModel_constDiffSmoothing\",\"smoothingModel_noSmoothing\",\"voidFractionModel\",\"voidFractionModel_GaussVoidFraction\",\"voidFractionModel_IBVoidFraction\",\"voidFractionModel_bigParticleVoidFraction\",\"voidFractionModel_centreVoidFraction\",\"voidFractionModel_dividedVoidFraction\",\"voidFractionModel_noVoidFraction\",\"voidFractionModel_trilinearVoidFraction\"],envversion:{\"sphinx.domains.c\":2,\"sphinx.domains.changeset\":1,\"sphinx.domains.citation\":1,\"sphinx.domains.cpp\":4,\"sphinx.domains.index\":1,\"sphinx.domains.javascript\":2,\"sphinx.domains.math\":2,\"sphinx.domains.python\":3,\"sphinx.domains.rst\":2,\"sphinx.domains.std\":2,\"sphinx.ext.intersphinx\":1,\"sphinx.ext.todo\":2,sphinx:56},filenames:[\"CFDEMcoupling_Manual.rst\",\"IOModel.rst\",\"IOModel_basicIO.rst\",\"IOModel_noIO.rst\",\"IOModel_sophIO.rst\",\"IOModel_trackIO.rst\",\"averagingModel.rst\",\"averagingModel_dense.rst\",\"averagingModel_dilute.rst\",\"cfdemSolverIB.rst\",\"cfdemSolverPiso.rst\",\"cfdemSolverPisoSTM.rst\",\"cfdemSolverPisoScalar.rst\",\"clockModel.rst\",\"clockModel_noClock.rst\",\"clockModel_standardClock.rst\",\"dataExchangeModel.rst\",\"dataExchangeModel_noDataExchange.rst\",\"dataExchangeModel_oneWayVTK.rst\",\"dataExchangeModel_twoWayFiles.rst\",\"dataExchangeModel_twoWayMPI.rst\",\"fix_couple_cfd.rst\",\"fix_couple_cfd_force.rst\",\"forceModel.rst\",\"forceModel_Archimedes.rst\",\"forceModel_ArchimedesIB.rst\",\"forceModel_DiFeliceDrag.rst\",\"forceModel_GidaspowDrag.rst\",\"forceModel_KochHillDrag.rst\",\"forceModel_LaEuScalarTemp.rst\",\"forceModel_MeiLift.rst\",\"forceModel_SchillerNaumannDrag.rst\",\"forceModel_ShirgaonkarIB.rst\",\"forceModel_checkCouplingInterval.rst\",\"forceModel_fieldStore.rst\",\"forceModel_fieldTimeAverage.rst\",\"forceModel_gradPForce.rst\",\"forceModel_noDrag.rst\",\"forceModel_particleCellVolume.rst\",\"forceModel_particleVolume.rst\",\"forceModel_periodicPressure.rst\",\"forceModel_scalarGeneralExchange.rst\",\"forceModel_virtualMassForce.rst\",\"forceModel_viscForce.rst\",\"forceModel_volWeightedAverage.rst\",\"forceSubModel.rst\",\"forceSubModel_ImEx.rst\",\"fvOptions.rst\",\"fvOptions_meanSupVelocityForce.rst\",\"liggghtsCommandModel.rst\",\"liggghtsCommandModel_execute.rst\",\"liggghtsCommandModel_readLiggghtsData.rst\",\"liggghtsCommandModel_runLiggghts.rst\",\"liggghtsCommandModel_setDEMGravity.rst\",\"liggghtsCommandModel_writeLiggghts.rst\",\"locateModel.rst\",\"locateModel_engineSearch.rst\",\"locateModel_engineSearchIB.rst\",\"locateModel_standardSearch.rst\",\"meshMotionModel.rst\",\"meshMotionModel_noMeshMotion.rst\",\"momCoupleModel.rst\",\"momCoupleModel_explicitCouple.rst\",\"momCoupleModel_implicitCouple.rst\",\"momCoupleModel_noCouple.rst\",\"probeModel.rst\",\"probeModel_noProbe.rst\",\"probeModel_particleProbe.rst\",\"scalarTransportModel.rst\",\"scalarTransportModel_generalManual.rst\",\"smoothingModel.rst\",\"smoothingModel_constDiffSmoothing.rst\",\"smoothingModel_noSmoothing.rst\",\"voidFractionModel.rst\",\"voidFractionModel_GaussVoidFraction.rst\",\"voidFractionModel_IBVoidFraction.rst\",\"voidFractionModel_bigParticleVoidFraction.rst\",\"voidFractionModel_centreVoidFraction.rst\",\"voidFractionModel_dividedVoidFraction.rst\",\"voidFractionModel_noVoidFraction.rst\",\"voidFractionModel_trilinearVoidFraction.rst\"],objects:{},objnames:{},objtypes:{},terms:{\"\":[0,9,10,11,12,29,41,61,73,74,75,76,78,80],\"0\":[0,2,9,12,18,22,29,33,35,38,39,40,41,44,45,48,50,51,53,67,69,71,74,75,76,77,78,80],\"0001\":18,\"001\":[50,51],\"002\":[33,51],\"00456\":45,\"005\":33,\"01\":38,\"012\":51,\"0256\":29,\"0271\":41,\"04\":0,\"0644\":45,\"09\":50,\"0e\":0,\"1\":[0,12,27,33,35,38,39,40,41,44,45,48,50,51,53,54,67,71,74,75,76,77,78,80],\"10\":[0,12,33,41,45,74,75,76],\"100\":[22,67],\"1000\":[21,74,75,76],\"10000\":33,\"1007\":[12,29,41],\"11\":45,\"112\":[29,41],\"116\":41,\"1196\":69,\"14\":78,\"1500e\":71,\"16\":[0,41,57],\"1606\":0,\"1612\":0,\"169\":45,\"17\":41,\"1706\":0,\"1952\":27,\"1966\":27,\"1978\":41,\"1991\":30,\"1e\":41,\"1e10\":[62,71],\"1e2\":62,\"1e3\":62,\"1e4\":62,\"2\":[0,41,45,51,67,78],\"2000\":[29,41],\"2001\":28,\"2007\":27,\"2009\":[30,32],\"2010\":[0,10,11,12,26,36,43],\"2011\":[9,28],\"2012\":[0,40],\"2013\":12,\"2014\":41,\"2017\":0,\"2018\":45,\"22\":[10,11,12],\"224\":30,\"228\":32,\"2334\":45,\"2366\":32,\"2390\":32,\"24\":[10,11,12],\"2500\":[33,40],\"261\":30,\"274\":30,\"29\":78,\"2d\":45,\"2nd\":41,\"3\":[0,33,41,45,51,67,69,74,76,77,80],\"30\":15,\"30000\":[18,19],\"31\":41,\"32\":0,\"33\":41,\"4\":[0,18,19,33,41,45,67],\"4614\":12,\"4d\":[18,19],\"5\":[0,22,41,45,75,76],\"5541\":12,\"6\":[0,41,71,74,76,77],\"65\":45,\"657\":45,\"7\":[0,41,45,69],\"710\":41,\"724\":41,\"7_2\":12,\"8\":[0,41,57,76,80],\"8th\":9,\"9\":48,\"9000e\":71,\"9418\":0,\"978\":12,\"999\":[38,44],\"9999\":48,\"case\":[0,2,7,8,9,15,30,48,61,69,70,71],\"class\":[0,1,13,15,49,55,59,61,68,70,73],\"default\":[0,1,2,6,13,16,23,24,25,26,27,28,29,30,31,32,33,36,37,38,39,40,41,42,43,44,45,46,49,51,52,53,54,55,56,57,59,61,62,63,65,66,67,68,69,70,71,73,74,75,76,77,78,80],\"do\":[0,15,18,37],\"export\":0,\"function\":[0,10,11,12,35,38,40,44,45,62],\"g\\u00f6teborg\":[10,11,12],\"import\":[0,57,61,67],\"int\":[9,15],\"long\":0,\"m\\u00b2\":12,\"new\":[0,32,50,51,61],\"public\":0,\"short\":0,\"switch\":[0,24,25,26,27,28,29,30,32,33,36,38,39,41,42,43,44,45,50,52,53,54,56,61,67],\"transient\":[29,41],\"true\":[0,23,24,25,26,27,28,29,30,33,36,37,38,39,41,42,43,44,45,46,48,51,52,56,57,61],\"try\":0,\"var\":0,\"void\":[0,9,33,61,78],\"while\":[0,9,48],A:[0,9,10,11,12,29,32,41,56,58,68],As:0,At:[22,33,38,44],Being:9,By:[0,61],FOR:41,For:[0,9,33,40,45,48,50,76],If:[0,15,23,24,26,29,33,37,41,45,46,52,68,71,78],In:[0,2,7,8,24,26,30,37,41,50,55,61,70,71,78],It:[0,22,33],Its:0,NOT:71,No:[7,47,48],OF:0,ON:0,On:0,THE:41,The:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40,41,42,43,45,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,67,69,70,71,72,73,74,75,76,77,78,79,80],There:[0,12,15],These:[0,22,70,71],To:[0,65,66,67,71],With:[0,40],_:0,abl:48,about:[9,57],abov:[0,27,50],acceler:33,accord:[0,12,48,50,52,59,74,75,76,78],accordingli:[0,67],account:[10,11,12,36,43,45,48,74,76,77,78],accumul:[15,45],accur:76,act:[23,24,25,26,27,28,30,31,32,36,37,42,43,67],activ:[22,30,32,41,45,48,65,66,67],actual:23,ad:[0,36,43],adapt:0,add:[0,67],addit:[0,5,10,11,12,22,23,24,26,37,41,62,67,78],addition:[4,22,50,62],additionallib:0,adjust:[74,76,77,78],advanc:0,advect:[68,69],af7d7f427be78e9b9beb6aceca8fe7d5d4636876:0,affect:48,after:[0,15,61],afterward:15,again:[0,50],agglomer:[74,76,77,78],air:48,al:[0,26,27,28,32,36,41,43,45],algorithm:[9,10,11,12,13,32,56,57,58,71],algorithmu:56,alia:[0,15],alias:0,alic:[9,75,76],all:[0,9,21,22,23,44,45,48,57,67,71,75,78],alloc:22,allow:[0,9,33,41,48,65,78,80],allrun:0,allwmak:0,alpha:[0,48],alphabet:0,alphaeff:12,alphafield:48,alphal:0,alphamin:[48,74,75,76,77,78,80],alphat:12,also:[0,37,78],altern:[0,23,41,54,69],alwai:[45,71],an:[0,9,10,11,12,15,23,40,47,48,61,62,63,70,71],analog:38,angular:9,ani:[0,23,66],anoth:[57,80],ap:0,appear:33,append:22,appli:[1,6,7,8,10,11,12,13,16,23,37,45,46,48,49,55,59,61,67,68,70,73],applic:[0,9,36,43,48],approach:[0,9,40,70,78],appropri:[68,69,78],approv:[0,9,10,11,12],approx:76,apt:0,ar:[0,9,10,11,12,13,15,19,21,22,23,24,26,33,35,37,38,41,44,45,46,48,50,54,57,61,66,67,70,71,74,75,76,77,78],arbitrari:50,archimed:[0,23,24],archimedesib:[9,25],archimedesibprop:25,archimedesprop:24,archiv:[0,76],area:[0,24,26,37,41,48,78],aren:[0,23],aris:0,arrai:15,arraypo:15,arrheniu:0,artifici:[74,75,76,78],ascend:15,asolid:0,aspher:0,assembl:0,assum:33,atom:[22,41],atom_styl:22,atom_typ:22,attent:[70,71],auto:[0,41],autoinstall_vtk:0,autom:0,automat:[0,50,52],avail:[0,45],averag:[0,6,7,8,10,11,12,15,27,35,40,44,48,57,71],averagingmodel:[0,7,8],averagingmodel_dens:0,averagingmodel_dilut:0,averagingmodel_xi:6,avmixturedens:40,avoid:[61,67],b:[0,22,40],back:56,background:40,backward:0,bad:33,base:[0,1,4,10,11,12,13,18,26,27,28,29,30,31,33,36,40,41,43,49,55,59,61,70,73,78],bashrc:0,basic:[0,2,15,71,78],basicio:[1,2,4,5],bc:33,becaus:[15,70,71],becom:[0,33],bed:[28,45],been:[0,48,61],beetstra:45,beetstradrag:67,befor:0,begin:0,being:[0,37,71],bejan:12,below:[0,50,65,66,67],benchmark:33,beta:[0,70],between:[0,9,15,16,17,18,19,20,21,26,27,28,33,41,42,61,75,78],bfull:0,big:48,bigger:[0,74,75,76],biggest:33,bigparticl:[74,76],bigparticleprop:76,bin:0,bison:0,blank:50,block:0,blockmesh:0,blow:[74,75,76,78],bodi:[9,76],bool1:[31,33,41,51,78],bool2:[31,51],bool3:51,bool:0,border:78,both:0,bound:[15,33,71],boundari:[9,25,32,34,40,57,64,70,71,78],box:50,branch:0,brief:40,broken:33,buijtenen:28,build:0,built:0,button:0,buyoanc:0,c:[0,9,10,11,12,69],c_1:0,c_2:0,c_3:0,ca:47,caclul:37,cadd:[22,42],caddrhofluid:22,calcul:[0,7,8,9,10,11,12,15,21,22,23,24,25,26,27,28,29,30,31,32,33,36,37,38,39,40,41,42,43,44,45,63,71,74,75,76,77,78],call:[0,15,41,52],calucl:[24,26,37,41,78],can:[0,5,11,12,15,18,19,20,22,23,24,26,27,28,33,35,36,38,40,41,43,44,45,46,47,48,51,52,53,54,56,57,61,62,65,66,67,68,69,71,74,75,76,77,78],cannot:[0,34,69],capabl:0,capac:[29,41,69],care:0,casedir:[0,15],casepath:2,caus:52,ccmake:0,cd:0,cell:[0,7,8,9,23,27,33,38,44,45,48,55,56,57,58,61,69,71,74,75,76,77,78,80],cellid:[55,56,57,58],celllength:33,cellpoint:[26,27,28,29,30,31,41],cellpointfac:[26,27,28,30,31,36,41,42,43],cellvolum:38,cellzoneset:48,center:[0,78],centr:[33,45,57,73,74,75,76,77,80],central:0,centreprop:77,centroid:78,certain:[0,33,69,78],cfd2:22,cfd:[0,1,2,4,7,8,9,10,11,12,15,17,18,19,20,23,25,32,37,38,39,40,41,45,48,50,52,53,54,55,56,57,58,59,61,62,63,64,67,73,74,75,76,77,78,80],cfd_cn:22,cfdem:[16,42,49,65],cfdem_add_libs_dir:0,cfdem_add_libs_nam:0,cfdem_app_dir:0,cfdem_bashrc:0,cfdem_doc_dir:0,cfdem_lammps_lib_dir:0,cfdem_lib_dir:0,cfdem_liggghts_lib_path:0,cfdem_liggghts_makefile_nam:0,cfdem_liggghts_makefile_postifx:0,cfdem_liggghts_src_dir:0,cfdem_lpp_dir:0,cfdem_project_dir:0,cfdem_project_user_dir:0,cfdem_solver_dir:0,cfdem_src_dir:0,cfdem_tut_dir:0,cfdem_user_app_dir:0,cfdem_user_lib_dir:0,cfdem_ut_dir:[0,15],cfdem_verbos:0,cfdem_vers:0,cfdemcloud:[0,16],cfdemcompcfdemal:0,cfdemcompcfdemsol:0,cfdemcompcfdemsrc:0,cfdemcompcfdemuti:0,cfdemcomplig:0,cfdemcoupl:[0,9,10,11,12,22],cfdemetc:0,cfdemliggght:0,cfdemliggghtspar:0,cfdemparticl:[0,7,8],cfdemproject:0,cfdemsolv:0,cfdemsolverib:[0,75],cfdemsolverpimpleimex:41,cfdemsolverpiso:[0,9],cfdemsolverpisoscalar:0,cfdemsolverpisostm:[0,41],cfdemsolverreact:29,cfdemsolverscalar:29,cfdemsolverxxx:0,cfdemsystest:0,cfdemtesttut:0,cfdemtut:0,cfdemuseonli:78,cfdtool:0,cfl:33,cgwarnonli:23,ch4:0,chang:[0,15,33,52,61,71],channel:48,check:[0,33,57,65,66,67,69],checkcouplinginterv:33,checkcouplingintervalprop:33,checkout:0,checkperiodiccel:[57,75],chemengsci:[27,28,45],chemic:[0,41],chemistri:0,choic:[45,46],choos:[0,29,33,40,50],chosen:[23,29,52],christoph:0,clean:80,clockdata:15,clockmodel:[0,14,15],clockmodel_noclock:0,clockmodel_standardclock:0,clockmodel_xi:13,clone:0,close:0,cloud:[0,7,8],clump:[26,27,28],cluster:[0,9],cmake:0,coars:[23,26,27,28,29,41,45],code:[0,9,10,11,12,13,15,17,18,19,20,41,69,75],coeffici:[0,22,29,36,41,43,45],coincid:78,color:22,com:0,combin:[0,22,27,45],come:0,command:0,comment:0,commit:0,commithashtag:0,commun:[0,37,45],communi:45,comp:32,compar:70,compat:0,compil:0,complet:[1,6,13,16,23,45,49,55,59,61,65,66,67,68,70,73],compon:0,comput:[0,9,29,32,41,48,57],computation:8,concentr:[0,69],concern:0,concetr:0,condit:[9,34,70,71],conduct:[12,24,25,29,32,41],conf:9,configur:0,conflict:[0,61],conjunct:[70,71],connect:0,consid:[16,38,44,45,57,61,75,80],consider:45,consit:16,constant:[0,9,22,40,45,69,74,75,76,78],constdiffsmooth:[70,71],constdiffsmoothingprop:71,constraint:47,contact:0,contain:[0,9,15,22],contrast:69,contribut:[9,22,75,76],control:[0,40],controldict:0,convect:[11,12,29,41],convectiveheatflux:[29,41],convex:0,copi:0,core:0,correcl:41,correct:[0,9,27,45,50,51,78],correctli:34,corrector:0,correl:[26,27,28,29,31,41],correspond:[0,41,55,56,57,58,67],coupl:[9,10,11,12,16,20,23,33,41,45,48,49,50,51,52,61,70,71],couple_everi:[21,22],couplingfilenam:[18,19],couplinginterv:[0,50,51],couplingproperi:0,couplingproperti:[1,2,3,4,5,6,7,8,9,13,14,15,16,17,18,19,20,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,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],couplingtim:33,courant:33,cover:[0,9,74,75,76],cp:[29,41],cpvolumetr:69,cpvolumetricfieldnam:69,creat:[0,23,54,75],create_atom:50,creation:0,criteria:33,criterion:33,cshrc:0,cubic:80,cumul:0,current:[33,44,45,65,66,67],custom:0,cutoff:48,d:[12,39],d_real:[26,27,28,29,41],d_sim:[26,27,28,29,41],data:[0,1,2,4,6,7,8,15,16,17,18,19,20,22,29,41,45,51,52,67],dataexchang:33,dataexchangemodel:[0,9,17,18,19,20],dataexchangemodel_nodataexchang:0,dataexchangemodel_onewayvtk:0,dataexchangemodel_twowayfil:0,dataexchangemodel_twowaympi:0,dataexchangemodel_xi:16,date:51,dc:0,ddt:42,ddtuinterpolationtyp:42,deactiv:67,debian:0,debug:[0,16,44,45,67,71,78],decomposepar:0,decomposit:0,deen:[29,41],deenet:41,defin:[0,1,2,3,4,5,6,7,8,13,14,15,16,17,18,19,20,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,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,68,69,70,71,72,73,74,75,76,77,78,79,80],delet:[37,67],delta:0,dem:[0,9,10,11,12,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,36,37,40,41,42,43,45,49,50,51,54,59,61,67,73],demand:[45,46],demt:[0,18,19],demtim:33,denot:0,dens:[6,7,8,41,61],densiti:[0,22,23,24,25,33,40,48,69],densityfieldnam:24,depend:[0,9,45,46,78],dependend:0,depth:32,deriv:68,describ:0,descript:0,design:[9,41,45,57,75],desir:[15,48],detail:[0,24,25,26,27,28,29,30,32,36,41,42,43,50,67],detect:0,determin:0,dev:0,develop:[0,19,27],dhc:[24,26,37,41,78],di:26,diamet:[0,9,26,27,28,29,33,41,70,74,75,76,78],dictionari:[1,2,3,4,5,6,7,8,13,14,15,16,17,18,19,20,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,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],difelic:45,difelicedrag:[23,26],difelicedragprop:26,differ:[0,9,24,25,40,46,48,56,57,68],diffus:41,digit:67,dilut:[6,7,8,27,68,69,71],dimension:[24,25,32],dirctori:0,direct:[41,78],directli:[0,26],directori:[0,2,15,18,54,67,70,71],disabl:[0,65],disclaim:41,discret:[0,10,11,12,27,36,43],dispers:[22,68,69],displac:[10,11,12,22],displai:0,disregard:9,distanc:[57,75],distribut:[0,57,74,80],distributor:0,div:[12,43],divid:[0,33,78],dividedprop:78,divtauinterpolationtyp:43,dmolecular:41,dmpich_skip_mpicxx:0,doc:0,document:[1,6,13,16,21,22,23,45,49,55,59,61,68,70,73],doe:[14,15,29,33,34,35,38,39,41,44,54,61,66,72],doi:12,domain:[9,39,40,48,52,73,74,76,77,78],done:[0,61],dorgan:30,dot:50,dotdot:[50,51],doubl:15,download:0,dp:0,drag:[0,22,26,27,28,31,32,40,45,61],drop:48,dsphere:[39,74,76,77],dt:12,du:0,due:[33,48],dummi:[3,14,17,60,64,72,79],dump:52,dure:[0,45,50,51,52,53,54,67],dynam:[0,9,40],e1:0,e2:0,e3:0,e4:0,e5:0,e6:0,e:[0,1,6,7,8,11,15,21,23,24,25,26,27,28,30,31,32,33,34,36,37,41,42,43,50,51,61,64,67,69,70,71,76,78],each:[0,9,22,23,24,25,26,27,28,30,31,32,36,37,41,42,43,45,50,51,57,67,78],easier:15,easili:[0,78],eccoma:40,effect:[40,45],effici:[8,9,33],effort:0,either:[9,48,76],element:[0,78],email:0,enabl:[0,22,45,50,66,67],end:[0,51,53],endors:[0,9,10,11,12],endtim:[50,51,53],engin:[41,55,56,57],engineib:[57,78],engineibprop:57,engineprop:56,enginesearch:56,enginesearchib:[9,57],enough:0,ensembl:40,ensur:[0,57,69],entri:0,env:0,environ:[0,22],epsilon:0,equal:[0,15,71,78,80],equat:[0,9,10,11,12,29,40,45,47,61,68,69],ergun:27,erron:52,error:[0,70,71],especi:[25,34,57,61],essenti:0,estim:33,et:[0,26,27,28,32,36,41,43,45],etc:[0,9,68,69],euler:71,eulerian:[6,7,8,41,45],eulerianfield:69,eulerimplicit:0,eulerimplicitvoid:0,evalu:[8,14,15],even:[0,51,57],everi:[0,2,4,15,22,33,45,50,51,52,54,67],evinc:0,exact:9,exacttim:51,examin:13,exampl:[0,47],exce:[9,22,33],except:[0,52],exchang:[0,10,11,12,16,17,18,19,20,41,61,62,63,64,68,69,70,71],excplicit:22,execut:[0,20,23,33,37,49,52,53,54,57],execute_0:50,execute_1:50,executeprops0:50,executeprops1:50,executeprops3:50,exert:0,exist:[54,68],exit:0,exp:45,expand:0,expcorrdeltauerror:0,expect:33,experi:[0,33],experiment:28,expforc:61,explicit:[0,4,22,45,61,62,71],explicitcoupl:62,explicitcoupleprop:62,explicitcouplesourc:40,explicitli:37,expon:0,express:30,extend:0,extern:78,f:[0,71],face:69,factor:[26,27,28,29,41,48],fail:[0,24,26,37,41,74,75,76,78],fall:56,fallback:56,fals:[0,24,26,27,28,29,30,32,36,37,38,39,41,42,43,44,45,51,52,53,56,57,69,71,75,78],far:33,fashion:[0,61],fast:32,featur:[0,15,65,67],fed:0,feel:0,felic:26,ffor:0,field:[0,5,9,12,23,24,25,26,27,28,29,30,31,32,33,34,35,36,38,40,41,42,43,44,45,48,57,61,62,63,67,69,70,71,73,74,75,76,78],fieldnam:48,fieldstor:34,fieldstoreprop:34,fieldtimeaverag:35,fieldtimeaverageprop:35,file:[0,1,2,9,15,16,18,19,20,23,38,39,46,51,54,63,67],filenam:[0,18,19,54],filepath:51,fill:71,filter:5,find:[0,55,56,57],finish:15,finit:[10,11,12,24,25,26,27,28,29,30,31,32,34,35,36,41,42,43,44,57,63,69],first:[0,33,50,51,52,53,78],fix:[21,22,53],fix_couple_cfd:22,flag:[0,23,26,27,28,29,31,33,36,41,51,54,57,71,75,78],flex:0,flimit:62,flow:[0,29,30,33,34,36,41,43,47,48,61,71],fluid:[0,9,11,12,22,23,24,25,26,27,28,29,30,31,32,33,36,37,40,41,42,43,45,48,61,63,67,68,69,76],fluidiz:[28,45],fluidscalarfield:41,fluidscalarfieldinterpolationtyp:41,flux:[29,41,42,69],foamsystemcheck:0,folder:[0,48],follow:[0,26,27,28,31,33,40,50,78],footnot:0,forc:[0,4,9,16,21,23,24,25,26,27,28,30,31,32,36,37,40,41,42,43,45,46,47,61,62,65,66,67,70,71],forcemodel:[0,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,66,67,68,69],forcemodel_archimed:0,forcemodel_archimedesib:0,forcemodel_checkcouplinginterv:0,forcemodel_difelicedrag:0,forcemodel_fieldstor:0,forcemodel_fieldtimeaverag:0,forcemodel_gidaspowdrag:0,forcemodel_gradpforc:0,forcemodel_kochhilldrag:0,forcemodel_laeuscalartemp:[0,41],forcemodel_meilift:0,forcemodel_nodrag:0,forcemodel_particlecellvolum:0,forcemodel_particlevolum:0,forcemodel_periodicpressur:0,forcemodel_scalargeneralexchang:0,forcemodel_schillernaumanndrag:0,forcemodel_shirgaonkarib:0,forcemodel_virtualmassforc:0,forcemodel_viscforc:0,forcemodel_volweightedaverag:0,forcemodel_xi:23,forcesubmodel:[0,23,24,25,26,27,28,29,30,32,36,41,42,43,46],forcesubmodel_imex:0,forcesubmodel_xi:45,format:0,formul:[0,27,28,31,32,36,43],forum:0,forward:58,found:[0,56,78],fraction:[0,9,33,44,48,63,78],framework:[0,9,10,11,12],free:0,freeli:0,from:[0,5,8,9,18,19,20,22,24,25,40,45,57,78,80],fsmooth:71,fulli:[0,32],further:[0,38,57],fvoption:[48,68,69],fvoptions_meansupvelocityforc:0,fvoptionsc:69,fvoptionst:69,fvscheme:0,g:[0,1,6,7,8,9,11,15,23,24,25,26,27,28,30,31,32,33,34,36,37,40,41,42,43,50,51,64,67,71],ga:[9,41],gain:9,gamma:0,gasreact:0,gasreactioncoeff:0,gasspecie1:0,gasspecie2:0,gasspecie3:0,gauss:74,gaussian:74,gaussprop:74,gedit:0,gener:[0,5,22,41,55],generalcorrelationparamet:41,generalmanu:[41,68,69],generalmanualprop:69,geometr:[56,57],get:[0,45],gidaspow:27,gidaspowdrag:27,gidaspowdragprop:27,girardi:40,git:0,github:0,give:[0,70,71],given:[0,33,38,45,56,57,58],global:69,gmbh:0,gnu:0,gnuplot:0,goe:[29,41],goniva:[0,9,10,11,12],govern:[9,47],gpl:0,grad:[12,36,43],gradient:[33,36,40],gradpforc:[0,23,36,67],gradpforceprop:36,gradpinterpolationtyp:36,grain:[23,26,27,28,29,41],granular:[7,8,11,12,26,28,29,41,63],granvelfieldnam:[26,27,28,63],graphic:15,graviti:[0,24,25,40,53],gravityfieldnam:[24,25,40],greater:[38,44],grep:67,grid:[45,70],group:[21,22],guid:0,gunn:41,h:0,ha:[0,10,11,12,15,41,48,61,69,78,79],hager:[9,10,11,12,75,76],hand:0,handl:[0,22,45,48,67],happen:0,hashtag:0,have:[0,6,15,44,45,78],heat:[11,12,29,41,69],heatfluid:[29,41],heatflux:[29,41],heattranscoeff:[29,41],here:[0,74],highest:33,hill:28,hint:0,hold:45,hollowaydrag:67,home:0,how:[0,33,40],howev:[0,41,61],http:0,hydraul:[26,27,28],hydrodynam:22,i:[0,1,2,3,4,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,43,44,45,46,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,67,69,70,71,72,73,74,75,76,78,79,80],ib:75,ibprop:75,ibvoidfract:9,id1:67,id2:67,id3:67,id:[0,5,21,22,67],ident:0,ignor:[22,29],ii:[0,61],iii:0,imag:[40,57,75],imex:[45,46],immers:[9,25,32,57,64],impforc:61,impldem:[45,46],implement:[0,9,12,56,61,65,67,68,78],implforcedem:[26,27,28,31,45],implforcedemaccumul:[28,45],implicit:[0,4,22,27,28,31,41,45,61,63,70,71],implicitcoupl:[61,63],implicitcoupleprop:63,implicitli:[37,45],impos:[47,48,61],improv:0,inact:0,includ:[0,62,63,64,67,68,69],includeposit:67,incomplet:23,incorpor:9,increas:[51,74,75,76,78],index:51,indic:[42,51],individu:41,industri:9,influenc:[22,29,33,34,35,38,39,41,44,74,75,76,78],info:67,inform:[0,9,15,22,41],inid:50,init:0,initi:[9,15,70,71],input:[0,12,20,24,26,37,41,78],inputscriptnam:0,insert:0,insid:[7,8,74,75,76,77],instabl:48,instanc:50,instead:[0,57],instruct:0,integ:[0,15,67],integr:[22,37,40],intend:15,interact:[23,24,25,26,27,28,30,31,32,36,37,42,43,67],interfac:48,intern:50,internet:0,interpol:[24,26,27,28,29,30,31,36,41,42,43,45,78,80],interpolatedat:69,interpret:34,interv:[0,33,45,50,51,52,53,54,67],intragr:0,introduc:48,investig:[29,41],io:[1,2,3],iomodel:[0,2,3,4,5,9],iomodel_basicio:0,iomodel_noio:0,iomodel_sophio:0,iomodel_trackio:0,iomodel_xi:1,its:[0,9,16,33,46,67,74,75,76,78,80],itself:0,j:[32,69],jfm:[0,26,36,43],jku:[9,13,75,76],job:0,josef:13,journal:[30,32],june:[10,11,12],just:[9,33],k:[12,29,41,69],keep:[67,74,75,76,78],keepcfdforc:37,kei:0,kept:51,kerbl:13,keyword:[0,2,21,22,24,25,30,32,40,44,45,46,50,54],keywork:22,kg:[29,41],kinemat:12,kloss:[0,9,10,11,12],know:69,known:[7,47,48,56,57],koch:28,kochhilldrag:28,kochhilldragprop:28,ksl:[0,22,70,71],l:[0,29,31,63],label1:54,label:50,laeufilmform:0,laeuscalartemp:29,laeuscalartempprop:29,lagrangian:[0,2,6,7,8,45,71],lambda:[29,41],laminar:12,larg:[0,69],larger:[33,71],largest:33,largevcellbyvparcel:33,last:[37,50,54,56,57],later:78,latest:0,latter:2,launch:0,law:[0,27,28,40,61],layer:[57,78],learn:40,least:[0,16],left:0,length:[41,71],lengthscal:71,lengthscalereffield:71,less:[0,61],li:[29,41],lib:0,libboost:0,libmpi:0,libmpich:0,libncurs:0,libopenmpi:0,libptscotch:0,librari:0,libreadlin:0,libscotch:0,libso:0,libvtk7:0,libxt:0,licens:0,lift:[24,25,30],liggght:[0,5,9,10,11,12,16,22,41,42,50,51,52,53,54],liggghts_init:[0,20],liggghtscommand:[50,51,52,53,54],liggghtscommandmodel:[0,20,50,51,52,53,54],liggghtscommandmodel_execut:0,liggghtscommandmodel_readliggghtsdata:0,liggghtscommandmodel_runliggght:0,liggghtscommandmodel_setdemgrav:0,liggghtscommandmodel_writeliggght:0,liggghtscommandmodel_xi:49,liggghtscommmand:[49,50,51,52,53,54],liggghtspath:20,ligght:41,like:[0,15],limason:29,limit:[0,9,10,11,12,29,33,41,62,71,74,75,76,77,78,80],line:[0,5,50,51],linear:[30,56,57],link:0,liquid:[0,48],list:[0,1,6,13,16,23,41,45,49,55,59,61,65,66,67,68,70,73],ll:0,lmpich:0,lmpichcxx:0,lmpl:0,load:0,local:[0,12,63,70],localpsizediffsmooth:70,locat:[0,9,12,15,39,55,56,57,58],locatemodel:[0,56,57,58],locatemodel_enginesearch:0,locatemodel_enginesearchib:0,locatemodel_standardsearch:0,locatemodel_xi:55,log10:45,log:[0,23,46,67],lognam:0,look:[0,1,6,13,16,23,45,49,55,59,61,68,70,73],loop:15,loos:0,lopa:0,lost:0,loth:30,lower:[38,44,71],lowerlimit:71,lowerthreshold:[38,44],lpp:0,lrt:0,lws_:0,m:[29,32,41],m_voidspac:69,machin:0,maciv:32,magnitud:[38,44],mahajan:45,mai:[0,15,22,23,24,26,37,41,78],main:[0,13,67],maintain:0,make:0,makefil:0,makefilenam:0,mandatori:48,mani:[0,54,67],manipul:[0,59],manner:32,manual:[0,67],map:[0,6,7,8,71],mark:[0,9,10,11,12,75],mason:[29,41],mass:[0,22,36,41,42,43],master:0,materi:0,mathemat:32,matplot:15,max:33,maxaccnr:33,maxcellsperparticl:[74,75,76],maxcfl:33,maxim:[9,29,33,41],maximum:[15,18,19,33,74,75,76],maxnumberofparticl:[18,19],maxpcfl:33,maxrelvelchang:33,maxsourc:[29,41],mclaughlin:30,mean:[0,48,79],meaning:61,meansupvelocityforc:48,meansupvelocityforcecoeff:48,measur:[14,15,26,27,28,29,33,41],mechan:30,media:[12,47],meilift:[30,67],meiliftprop:30,memori:[0,22],mention:0,mesh:[0,9,38,59,76,80],meshmot:60,meshmotionmodel:[0,60],meshmotionmodel_nomeshmot:0,meshmotionmodel_xi:59,metallurg:9,method:[0,9,25,32,57],might:[0,1,6,13,16,23,45,48,49,52,55,59,61,65,66,67,68,70,73],min:33,minallowedvcellbyvparcel:33,minalphap:63,minim:[48,57,75],minimum:[0,33,63,74,75,76,77,78,80],mixtur:[40,69],mixturedens:40,mkdir:0,mode:[0,24,26,37,40,41,78],model:[1,2,3,4,5,6,7,8,9,11,12,13,14,15,16,17,18,19,20,22,23,24,25,26,27,28,29,30,31,32,33,36,37,40,41,42,43,45,46,49,50,51,52,53,54,55,56,57,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80],model_i:[23,45,49],model_x:[23,45,49],modeltyp:0,modi:40,modif:57,modifi:0,modu:40,modular:0,molar:0,molecular:41,momcouplemodel:[0,62,63,64],momcouplemodel_explicitcoupl:0,momcouplemodel_implicitcoupl:0,momcouplemodel_nocoupl:0,momcouplemodel_xi:61,momentum:[0,10,11,12,41,61,62,63,64],momentumsourc:48,monodispers:40,more:[0,15,22,33,61,74,75,76],most:[0,23,67],mostli:44,motion:[9,22,45,59],move:[0,57],movement:9,mp:0,mpi:[0,20,21,22,33,49],mpi_arch_flag:0,mpi_arch_inc:0,mpi_arch_lib:0,mpi_arch_path:0,mpi_root:0,mpirun:0,much:16,multi:9,multipl:[0,28],multispher:[0,24,26,37,41,78],must:[0,29,41,45,53,54,69,70,71,78],mv:0,mvapich:0,myforcemod:67,myforcemodel1:[66,67],myforcemodel2:[66,67],myforcemodel3:[66,67],myprobemodel:65,myprobemodelprop:65,myset:65,n:[21,32,41],name:[0,1,6,12,13,15,16,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,38,40,41,42,43,44,45,48,49,54,55,57,59,61,63,68,69,70,73,78],name_:54,naumann:31,navier:[0,9,10,11,12,61],nearli:0,necessari:[0,12,15,32,40,76],need:[0,15,22,23,33,50,51],neighbour:80,nevertheless:0,newton:[0,61],next:[22,78],nield:12,noblank:50,noclock:14,nocoupl:64,nodataexchang:[16,17],nodemforc:37,nodrag:37,nodragprop:37,nofproc:0,noio:[1,3],nomenclatur:0,nomeshmot:[59,60],non:[0,45,78],none:[0,1,2,3,4,5,6,13,14,15,16,17,18,20,21,23,24,26,27,28,30,31,34,35,36,37,38,39,40,43,45,46,49,50,53,54,55,56,58,59,60,61,65,66,67,68,69,70,72,73,74,75,76,77,78,79],normal:[0,26,28,29,31,36,41,50,53,57],norwai:9,nosmooth:72,note:[0,23,33,41,48,51,54,61,66,67,68],novoidfract:79,now:[0,45],np:0,nparticl:0,nr:[33,69],nrdemstep:52,nu:[12,26,27,28,29,30,41,43,45],nucorrel:29,number1:[38,71,74,75,76,77,78,80],number2:[38,71,74,75,76,77,78],number3:[38,74,75,76,78],number4:[74,76],number:[0,12,15,18,19,21,29,33,41,45,48,50,51,54,57,63,67,71,74,75,76],numer:[0,28,41],numpi:0,nusselt:[29,41],nut:12,nve:22,o0:0,o2:0,object:[0,20,35,38,44],obligatori:21,obtain:[61,78],occupi:[74,76,77,78],occur:[0,48,67],octav:0,od:0,odevoid:0,off:[1,3,14,26,27,28,29,31,36,41,45,50,51,53,54,64,65,66,67,70,72],offer:[0,9,10,11,12],offici:0,often:0,ofvers:0,oil:9,older:0,omiss:0,omit:15,onc:15,one:[0,8,19,41,45,48,54,57,70,80],ones:61,onewayvtk:[16,18,33],onewayvtkprop:18,onli:[0,2,8,19,22,25,26,27,28,29,30,32,38,40,41,43,44,45,48,49,50,51,52,53,54,57,61,62,63,64,65,67,69,75,80],open:[0,9,10,11,12],opencfd:[0,9,10,11,12],openfoam:[0,9,10,11,12,41],openmpi:0,oper:[24,26,37,40,41,70,71,78],option:[0,22,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40,41,42,43,44,45,46,48,52,54,56,57,63,69,71,74,75,76,77,78,80],order:[15,30,41,61],org:0,organ:0,organis:0,origin:[35,38,44],orthogon:0,other:[0,1,6,13,16,23,45,49,55,59,61,67,68,70,73],otherwis:[0,22,67,70,71],our:0,out:[15,71],output:[0,2,15,23,24,26,27,28,35,36,38,39,41,43,44,45,54,67,71,78],over:[33,57,71,80],overlap:78,overrid:67,overview:40,overwrit:54,own:[0,33],owner:[0,9,10,11,12],p:[0,32,36,40],pack:51,packag:0,page:0,pair:22,parallel:[0,9,10,11,12,57,80],paramet:[0,41,74,76,77,78,80],paraview:[0,5,34],parcel:[40,45,70],parscal:41,part:[0,13,41,57,76],partheatfluidnam:[29,41],partheatfluxnam:[29,41],partheattranscoeffnam:[29,41],parti:0,partial:[9,75],particl:[0,1,2,5,6,7,8,10,11,12,18,19,20,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,48,52,55,57,61,63,65,66,67,68,69,70,71,73,74,75,76,77,78,80],particlecellsurfac:0,particlecellvolum:38,particlecellvolumeprop:38,particleid:[5,67],particleidstosampl:67,particleprob:[65,66,67],particleprobeprop:67,particlerelaxationtim:33,particleshapetyp:[0,24,26,37,41,78],particlevolum:39,particlevolumeprop:39,particul:27,particular:50,particularli:48,partspeciesfluidnam:41,partspeciesfluxnam:41,partspeciesnam:41,partspeciestranscoeffnam:41,parttempnam:[29,41],pass:[0,22,40,45],patankar:32,path:[0,5,18,20,50,51,54],pcfl:33,per:[22,24,26,30,37,41,67,76,77,78],perform:[0,6,7,8,16,17,18,19,20,23,24,25,26,27,28,30,31,32,36,37,41,42,43,61,65,66,67,71,78],period:[40,48,57,75],periodicpressur:40,periodicpressureprop:40,permit:48,perspect:[10,11,12],pfieldnam:36,phase:[0,9,11,12,48,68,69],phi:[12,27,42,69],phifieldnam:[42,69],phinam:69,phy:32,physic:[32,47,68,79],pi:[74,76,77],pimpleimex:[70,71],pirker:[9,10,11,12],piso:[10,11,12],pisofoam:[10,11,12],place:[9,15,22,48,70,71],placehold:50,pleas:[0,1,6,13,16,23,45,48,49,55,59,61,65,66,67,68,70,73],pneumat:[29,41],point:[57,78],poros:[74,76,77,78],porou:[12,47],port:0,posit:[0,2,9,15,16,30,41,55,56,57,58,67,78],possibl:0,post:[0,5,18],postfix:0,postporcessor:34,postprocess:[0,33,35,38,39,44],potenti:[26,27,28,29,41],pow:[29,41],pr:12,prandtl:[12,69],pre:52,predefin:41,preno:52,prepar:0,preprocess:0,prerequisit:0,presenc:48,present:[0,9,71],pressur:[0,9,32,36,40,48],pressurefieldnam:32,previou:[0,9,78],previous:[18,22,37,56],print:[23,67],printeveri:67,printonlyatstep:67,prio:51,probe:[24,26,27,28,35,36,38,41,43,44,65,66,67],probedebug:67,probem:67,probemodel:[0,66,67],probemodel_noprob:0,probemodel_particleprob:0,probemodelset:65,problem:[0,9,61],proc:[2,9,10,11,12],procboundarycorrect:78,procedur:0,process:[0,5,9,15,61],processor:[0,2,19,57,78],produc:[0,9,10,11,12,15],product:33,project:0,proper:0,properli:0,properti:[0,1,11,12,18,19,20,21,22,23,41,67],proport:40,propuls:32,protocol:0,provid:[0,45,46,50,56,62,63,64],prt:[12,69],pseudo:45,pull:[0,21],pump:48,pure:[0,45],purpos:[9,16],push:21,put:15,py:15,python:[0,15],qualiti:33,quantiti:[30,61,67,68,69],question:0,r:[0,67,78],r_0:0,radial:78,radiat:12,radii:[2,16],radiu:78,radl:40,ran:15,rang:[78,80],rasproperti:0,rate:0,rather:[7,8,71],ratio:33,re:50,reach:[0,40],reactant:0,reaction:0,read:[0,19,41,46,51,71],readabl:0,readi:23,readliggghtsdata:51,readliggghtsdataprops0:51,realiz:[9,41],reason:[0,33],recip:0,reciproc:33,recommend:[0,22,33,56,57],recurs:[56,57],refer:[0,9,32,48,61,71],regim:[7,8],region:[74,75,76,78],regist:0,rel:[18,33,54],relat:[0,21,22,66,67],relativepath:18,relax:[33,48],releas:0,relev:[0,61,70],remain:[74,75,76,78],remark:0,rememb:[15,78],remov:0,renam:0,rep:45,repeat:51,replac:51,report:30,repositori:0,repres:[9,25,29,32,38,41,47,57,73],represent:[0,74,75,76,78,80],reproduc:78,requir:[0,22,24,26,37,41,78],reset:78,resolut:70,resolv:[25,32],respect:[9,13,15,45,75],respons:21,rest:[0,78],restart:54,restart_:50,restartcfdem:54,result:[0,33,48,76],review:41,reynold:45,rho:[23,24],rhofluid:22,rhol:0,rhomix:[40,69],rhomixfieldnam:69,rhop:33,robust:58,rong:45,routin:[0,15],run:[0,13,14,15,19,20,41,49,50,51,52,53],runeverycouplingstep:[50,51],runeverywritestep:50,runfirst:[50,51,52,53],runlast:50,runliggght:[49,52,53,54],runliggghtsprop:52,runtim:51,safeti:15,same:[0,41,44,48],sampl:67,sampleal:67,satellit:57,save:[0,54,67],scalar01:0,scalar02:0,scalar03:0,scalar11:0,scalar12:0,scalar13:0,scalar14:0,scalar15:0,scalar16:0,scalar1:[19,26,27,28,29,30,32,33,36,39,40,42,43,44,51,53,69],scalar20:0,scalar21:0,scalar22:0,scalar2:[19,26,27,28,29,33,39,40,43,44,51,53,69],scalar3:[26,27,28,29,33,40,51,53,69],scalar4:[26,27,28,29,33,51],scalar5:[27,29,33,41],scalar6:[27,33,41],scalar7:[33,41],scalar8:33,scalar9:33,scalar:[11,12,22,29,34,35,41,42,44,50,57,68,69,71],scalarfield:[34,35,38,44],scalarfieldnam:[34,35,44],scalargeneralexchang:41,scalargeneralexchangeprop:41,scalartransportmodel:[0,69],scalartransportmodel_generalmanu:0,scalartransportmodel_xi:68,scalartransportproperti:[41,68,69],scalarviscos:[26,27,28,29,30,41,43,45],scale:[0,26,27,28,29,33,39,41,71,74,76,77,78],scaledh:[26,27,28],scaledrag:[26,27,28,33],scaleupvol:75,scheme:0,schiller:31,schillernaumanndrag:31,schillernaumanndragprop:31,schmidt:69,scienc:41,screen:[30,38,39,45],script:[0,15],sct:69,search:[55,56,57,74,75,76],second:[30,41,78],secondari:67,section:[0,50],see:[0,10,11,12,24,25,26,27,28,29,30,32,36,40,41,42,43,45,46,50,65,67],seed:56,select:[0,23,24,26,37,41,45,53,54,78],seletionmod:48,self:32,semi:45,send:0,separ:[0,50],sequenti:[19,23],seri:[18,19],serial:2,serialoutput:2,set:[0,9,22,23,33,37,40,41,45,46,48,50,52,53,56,57,61,62,69,74,75,76,78],setdemgrav:53,setdemgravityprops0:53,setdemgravityprops1:53,setsourcefield:[40,62],setup:0,sever:[33,37,57],sh:0,shall:68,shape:0,share:0,shell:0,shirgaonkar:32,shirgaonkarib:[9,32],shirgaonkaribprop:32,shlib:0,should:[0,8,33,51,71],show:[0,40],side:[0,27,28,31,40,45],sign:50,signific:67,similar:[0,22,33],similarli:78,simpli:0,simul:[0,2,4,15,18,19,20,23,25,27,32,33,35,36,38,39,41,43,44,50,51,53,61,67],sinc:[0,15],singl:[8,50],situat:[48,71],size:[9,15,18,33,45,78,80],slash:[50,51],slower:16,small:[0,63,70],smaller:[0,33],smallest:33,smooth:[61,70,71,72,75,80],smoothen:[48,70],smoothinglength:71,smoothinglengthreferencefield:71,smoothingmodel:[0,71,72],smoothingmodel_constdiffsmooth:0,smoothingmodel_nosmooth:0,smoothingmodel_xi:70,so:[0,69],softwar:[0,9,10,11,12],solid:[0,9,41,75,76],solidprop:0,solidspeci:0,solidspecie1:0,solidspecie2:0,solut:0,solv:[0,9,10,11,12,61,68,69],solveflow:0,solver:[9,10,11,12,25,29,32,37,48,57,61,62,63,64,69,70,71,78],some:[0,23,46,57],sophio:[1,4],sourc:[0,9,10,11,12,29,37,62,63,64,68,69],sourceradi:12,speci:[0,41,69],special:[9,50,51,75],speciesc:41,speciescfluid:41,speciescflux:41,speciesconvect:41,speciesctranscoeff:41,speciesflux:41,speciestransportmodel:41,specif:[0,29,41,48,67],specifi:[0,30,35,41,52,67,68,69,70,71,78],speed:0,sphere:[0,9,57,78],spheric:[45,78],split:42,spliturelcalcul:42,spout:28,springer:12,sqr:45,sqrt:45,src:[0,41,67],ssmoothfield:70,stabl:[0,61],stairstep:76,stand:0,standard:[0,15,16,35,38,41,44,58],standardclock:[13,15],start:[0,15,35,38,39,44,51,53,57,67],startindex:51,starttim:[15,35,38,39,44,50,51,53,67],stash:0,state:0,statement:[0,15],stem:[24,25],step:[0,9,15,18,19,21,22,33,45,50,51,52,53,54,67,78],still:0,stochast:22,stoichiometr:0,stoke:[0,9,10,11,12,33,61],stop:[0,15,23,33],storag:67,store:[0,15,18,34,54],straight:58,strength:0,stress:0,string:15,strongli:[0,22],structur:[0,1,57,80],studi:[28,45],style:[0,21,22],sub:[0,24,25,26,27,28,29,30,32,36,41,42,43,45,46,75,76,78],subspher:78,success:[0,56],sudo:0,suffici:0,suggest:0,suit:[25,32],suitabl:41,sum:0,summari:[0,40],sundaresan:40,superfici:[48,69],superpos:[23,62],superquadr:[0,22],support:0,suppos:[7,8,74,75,76,78,80],suppress:[0,24,26,27,28,36,41,43,69],suppressprob:[24,26,27,28,36,41,43,67],sure:0,surfac:[0,57,69,75],surround:9,switch0:44,switch1:[0,24,25,26,27,28,29,30,32,36,37,38,39,41,42,43,44,50,53,54,56,57,78],switch2:[24,26,27,28,29,30,32,36,37,38,39,41,42,43,50,53,54],switch3:[24,26,27,28,29,30,36,41,42,43,50],switch4:[24,26,27,28,30,36,42,43,50],switch5:[26,27,28,41,43],switch6:[26,27,28,41],switch7:[26,27,28],switch8:26,switch9:26,switchingvoidfract:27,symbol:[0,50,51],synchron:0,system:[0,11,12,27,40,48],systemmpi:0,t:[0,9,12,23,29,41,69],tackl:9,tag:0,take:[0,9,22,45,48],taken:0,tang:45,target:[0,40],targetveloc:40,tau:[0,43],tech:[29,41],techniqu:20,temp:[29,41],temperatur:[29,41,69],tempfieldnam:[29,41],tempor:[35,44,57],temporalparticlestopathlin:5,tensor:0,term:[0,12,22,30,37,45,62,63,64],termin:[0,23,67],test:[70,71],text:67,than:[0,15,33,38,44,71,74,75,76],thei:[35,38],them:[0,37,50],theoret:[27,40],therefor:[0,33],therefror:46,thermal:[12,29,41],thi:[0,1,5,6,7,8,9,10,11,12,13,15,16,21,22,23,24,25,26,29,30,32,33,34,35,37,38,39,41,44,45,49,55,56,57,59,61,65,66,67,68,69,70,71,73,75,76,78,80],thing:0,third:[0,61],thirdparti:0,those:[0,15,44,74,75,76],thread:0,three:78,threshold:[38,44],thu:12,time:[0,2,4,9,13,14,15,18,19,21,22,33,35,38,39,44,45,48,50,51,52,53,54,61,67,69,70,71,78],timeaverage_scalarfield:35,timeevalful:15,timeinterv:[33,50,51,53],timestamp:[50,54],timestep:[0,18,51],tinterpolationtyp:29,togeth:0,too:0,tool:[0,33,34,35,38,39,44],toolbox:[0,9,16],torqu:[22,45],total:[0,9,38,39],totalerror:0,toward:9,track:67,trackio:[1,5],trade:[0,9,10,11,12],trajectori:[10,11,12],tranportproperti:45,transfer:[0,11,12,22,29,41],transfer_dens:22,transfer_ellipsoid:22,transfer_properti:22,transfer_stochast:22,transfer_superquadr:22,transfer_torqu:22,transfer_typ:22,transform:40,transit:[75,80],transport:[11,12,29,41,45,68,69],transportproperti:[0,12],travel:80,treat:[0,37,61],treatdem:[45,46],treatexplicit:[45,46],treatforcedem:[24,36,42,43,45],treatforceexplicit:[0,25,26,27,28,30,32,36,42,43,45],treatment:[50,51,61],treatvoidcellsasexplicitforc:61,tree:[0,56,57],treesearch:[56,57],tri:30,trilinear:80,trilinearprop:80,trondheim:9,troubl:52,tsourc:12,turbul:[10,11,12,29,41,69],turbulencemodeltyp:0,two:[0,19,21,24,25,32,40,41,78],twodimension:[24,25,32],twophas:48,twowayfil:[16,19],twowayfilesprop:19,twowaympi:[16,20],twowaympiprop:20,txt:15,type1:[26,27,28,29,30,31,36,41,42,43],type2:[26,27,28,30,31,41,42],type3:41,type:[0,12,15,22,24,26,27,28,29,30,31,36,37,41,42,43,48,77,78],typic:[0,33,61],u:[0,26,27,28,29,30,31,32,33,34,35,36,41,42,43,48,61,63],ubar:48,ubuntu:0,uf:[0,22],uf_poststep:0,uf_prestep:0,uinterpolationtyp:[26,27,28,30,31,41,42],ul:[0,45],umaxexpect:33,unalt:[74,75,76,78],under:0,unfix:53,uniformfixedvaluevoidfract:48,unit:[12,50],unless:22,unresolv:9,until:22,unwant:67,unzip:0,up:[0,51,74,75,76,78],updat:[0,45],updatemixtureproperti:69,upper:[38,44,71],upperlimit:71,upperthreshold:[38,44],urel:42,us:[0,2,5,7,8,9,10,11,12,15,22,23,24,26,27,28,29,30,31,33,34,35,36,37,38,40,41,43,44,45,46,47,48,50,51,52,53,54,55,56,57,58,61,65,67,68,69,70,71,74,75,76,77,78,80],usag:[0,15,45,50],useaddedmass:[36,43],usefiltereddragmodel:45,usegeneralcorrel:41,uselimason:41,useparcelsizedependentfiltereddrag:45,user:[0,33,45,48,69],usesecondorderterm:30,usevoidfractioncorrect:0,usevolumefract:44,usind:80,usr:0,usual:22,util:0,v:0,valid:[0,29,42],valu:[0,22,26,27,28,29,31,33,36,38,41,42,44,45,46,63,69,71,75],value1:[41,57],value2:[41,57],van:28,variabl:[0,15,37],variant:[24,26,37,41,78],varieti:68,variou:[0,65],vector1:40,vector:[0,22,34,35,44,62],vectorfield:[34,35,44],vectorfieldnam:[34,35,44],velfieldnam:[26,27,28,29,30,31,32,41,42,63],veloc:[0,2,6,7,8,9,16,26,27,28,29,30,31,32,33,36,40,41,42,43,45,47,48,61,63,69,71],velocityfieldnam:[33,36,43],veloctii:61,verbos:[24,26,27,28,29,30,32,38,39,41,44,45,50,51,52,53,54,67,71,78],verbosetofil:67,veri:[0,58,80],versa:78,version:[0,45],versioninfo:0,via:[0,19,20,23,40,62,65,66,67,71,73],vice:78,vienna:40,virtual:42,virtualmassforc:42,virtualmassforceprop:42,viscforc:[0,23,43,67],viscforceprop:43,viscos:45,viscou:[32,43],visit:0,visual:[0,15],vizclock:15,vlaue:48,voidag:45,voidagefunctiondifelic:[26,45],voidagefunctionrong:[26,45],voidagefunctiontang:[26,45],voidchemistrymodelprop:0,voidfracfieldnamesnext:78,voidfracfieldnamesprev:78,voidfract:[0,4,12,25,26,27,28,29,31,33,34,35,40,41,44,45,48,63,69,70,71,73,74,75,76,77,78,79,80],voidfractionfield:48,voidfractionfieldnam:[25,26,27,28,29,31,40,41,63,69],voidfractioninterpolationtyp:[26,27,28,31,41],voidfractionmodel:[0,74,75,76,77,78,79,80],voidfractionmodel_bigparticlevoidfract:0,voidfractionmodel_centrevoidfract:0,voidfractionmodel_dividedvoidfract:0,voidfractionmodel_gaussvoidfract:0,voidfractionmodel_ibvoidfract:0,voidfractionmodel_novoidfractionvoidfract:0,voidfractionmodel_trilinearvoidfract:0,voidfractionmodel_xi:73,voidfractionnam:69,voidfractionnext:25,volaverage_field:44,volscal:[77,78],volum:[0,10,11,12,24,25,26,27,28,29,30,31,32,33,34,35,36,38,39,41,42,43,44,57,63,69,73,74,75,76,77,78,80],volumefractionnam:44,volumetr:[0,24,25,69],volweightedaverag:44,volweightedaverageprop:44,vortic:30,vorticityinterpolationtyp:30,vparticl:[33,36,43,74,75,76,77,78],vsmoothfield:70,vtk:[0,18,19],vtk_group_mpi:0,vtk_out:[18,19],w:[29,41],w_1:0,w_2:0,wa:0,wai:[40,41,61],walk:56,want:0,warn:[0,23,33,41,52,80],warnonli:33,water:48,we:[0,40],weight:[44,74,76],well:[11,12,67,71],wen:27,were:[9,37],what:40,when:[8,45,48,57,61,74,75,76,78,80],where:[0,7,8,9,15,17,25,32,33,35,38,44,45,50,52,54,67],wherea:[0,16,48],whether:[0,69],which:[0,9,14,15,22,26,27,33,34,37,40,48,52,55,59,61,62,66,67,71,72,74,75,76,78],whole:[9,48],whose:[10,11,12,74,75,76,77],width:19,wierink:9,wish:0,within:[0,1,9,16,44,45,48,49,50,76],without:[0,24,26,37,41,78],wm_compile_opt:0,wm_label_s:0,wm_mplib:0,wm_ncompproc:0,wm_project_dir:0,wm_project_vers:0,wmake:0,word1:[33,44,69],word2:69,word3:69,word:[0,40,50,51],work:[0,33,49,80],workshop:[10,11,12],would:[0,50],write:[0,1,2,4,5,50,54],write_restart:[50,54],writeeveri:54,writelastonli:54,writeliggght:[49,54],writeliggghtsprop:54,writenam:54,writeprecis:67,writetim:[35,38,44],writetofil:[38,39,44],written:[0,2,4,13,19,35,38,44,54],www:0,wwww:0,x11:0,x:[0,54,80],xeveri:67,xi:45,xprecis:67,xstep:67,xxx:0,xysplit:57,y:80,ye:[22,48],yet:80,you:[0,15,34,54,67],your:[0,15,34],yourself:0,yu:27,yum:0,z:[57,80],zero:[22,37,76],zerogradi:[70,71],zhou:[0,26,36,43],zhu:27,zlib1g:0,zsplit:57,zypper:0},titles:[\"CFDEM\\u00aecoupling Documentation\",\"IOModel command\",\"IOModel_basicIO command\",\"IOModel_noIO command\",\"IOModel_sophIO command\",\"IOModel_trackIO command\",\"averagingModel command\",\"averagingModel_dense command\",\"averagingModel_dilute command\",\"cfdemSolverIB command\",\"cfdemSolverPiso command\",\"cfdemSolverPisoSTM command\",\"cfdemSolverPisoScalar command\",\"clockModel command\",\"clockModel_noClock command\",\"clockModel_standardClock command\",\"dataExchangeModel command\",\"dataExchangeModel_noDataExchange command\",\"dataExchangeModel_oneWayVTK command\",\"dataExchangeModel_twoWayFiles command\",\"dataExchangeModel_twoWayMPI command\",\"couple/cfd command\",\"couple/cfd/force command\",\"forceModel command\",\"forceModel_Archimedes command\",\"forceModel_ArchimedesIB command\",\"forceModel_DiFeliceDrag command\",\"forceModel_GidaspowDrag command\",\"forceModel_KochHillDrag command\",\"forceModel_LaEuScalarTemp command\",\"forceModel_MeiLift command\",\"forceModel_SchillerNaumannDrag command\",\"forceModel_ShirgaonkarIB command\",\"forceModel_checkCouplingInterval command\",\"forceModel_fieldStore command\",\"forceModel_fieldTimeAverage command\",\"forceModel_gradPForce command\",\"forceModel_noDrag command\",\"forceModel_particleCellVolume command\",\"forceModel_particleVolume command\",\"forceModel_periodicPressure command\",\"forceModel_scalarGeneralExchange command\",\"forceModel_virtualMassForce command\",\"forceModel_viscForce command\",\"forceModel_volWeightedAverage command\",\"forceSubModel command\",\"forceSubModel_ImEx command\",\"fvOptions dictionary\",\"fvOptions_meanSupVelocityForce command\",\"liggghtsCommandModel command\",\"liggghtsCommandModel_execute command\",\"liggghtsCommandModel_readLiggghtsData command\",\"liggghtsCommandModel_runLiggghts command\",\"liggghtsCommandModel_setDEMGravity command\",\"liggghtsCommandModel_writeLiggghts command\",\"locateModel command\",\"locateModel_engineSearch command\",\"locateModel_engineSearchIB command\",\"locateModel_standardSearch command\",\"meshMotionModel command\",\"meshMotionModel_noMeshMotion command\",\"momCoupleModel command\",\"momCoupleModel_explicitCouple command\",\"momCoupleModel_implicitCouple command\",\"momCoupleModel_noCouple command\",\"probeModel command\",\"probeModel_noProbe command\",\"probeModel_particleProbe command\",\"scalarTransportModel command\",\"scalarTransportModel_generalManual command\",\"smoothingModel command\",\"smoothingModel_constDiffSmoothing command\",\"smoothingModel_noSmoothing command\",\"voidfractionModel command\",\"voidfractionModel_GaussVoidFraction command\",\"voidfractionModel_IBVoidFraction command\",\"voidfractionModel_bigParticleVoidFraction command\",\"voidfractionModel_centreVoidFraction command\",\"voidfractionModel_dividedVoidFraction command\",\"voidfractionModel_noVoidFractionVoidFraction command\",\"voidfractionModel_trilinearVoidFraction command\"],titleterms:{\"default\":[21,22],These:50,about:0,averagingmodel:6,averagingmodel_dens:7,averagingmodel_dilut:8,can:50,cfd:[21,22],cfdem:0,cfdemsolverib:9,cfdemsolverpiso:10,cfdemsolverpisoscalar:12,cfdemsolverpisostm:11,chemistryproperti:0,clockmodel:13,clockmodel_noclock:14,clockmodel_standardclock:15,command:[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],complex:50,content:0,coupl:[0,21,22],couplingproperti:0,dataexchangemodel:16,dataexchangemodel_nodataexchang:17,dataexchangemodel_onewayvtk:18,dataexchangemodel_twowayfil:19,dataexchangemodel_twowaympi:20,descript:[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],dictionari:[0,47],document:0,exampl:[1,2,3,4,5,6,7,8,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,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],execut:50,forc:22,forcemodel:23,forcemodel_archimed:24,forcemodel_archimedesib:25,forcemodel_checkcouplinginterv:33,forcemodel_difelicedrag:26,forcemodel_fieldstor:34,forcemodel_fieldtimeaverag:35,forcemodel_gidaspowdrag:27,forcemodel_gradpforc:36,forcemodel_kochhilldrag:28,forcemodel_laeuscalartemp:29,forcemodel_meilift:30,forcemodel_nodrag:37,forcemodel_particlecellvolum:38,forcemodel_particlevolum:39,forcemodel_periodicpressur:40,forcemodel_scalargeneralexchang:41,forcemodel_schillernaumanndrag:31,forcemodel_shirgaonkarib:32,forcemodel_virtualmassforc:42,forcemodel_viscforc:43,forcemodel_volweightedaverag:44,forcesubmodel:45,forcesubmodel_imex:46,fvoption:47,fvoptions_meansupvelocityforc:48,instal:0,iomodel:1,iomodel_basicio:2,iomodel_noio:3,iomodel_sophio:4,iomodel_trackio:5,liggghtscommand:0,liggghtscommandmodel:49,liggghtscommandmodel_execut:50,liggghtscommandmodel_readliggghtsdata:51,liggghtscommandmodel_runliggght:52,liggghtscommandmodel_setdemgrav:53,liggghtscommandmodel_writeliggght:54,locatemodel:55,locatemodel_enginesearch:56,locatemodel_enginesearchib:57,locatemodel_standardsearch:58,meshmotionmodel:59,meshmotionmodel_nomeshmot:60,model:0,momcouplemodel:61,momcouplemodel_explicitcoupl:62,momcouplemodel_implicitcoupl:63,momcouplemodel_nocoupl:64,probemodel:65,probemodel_noprob:66,probemodel_particleprob:67,rather:50,readliggght:50,relat:[1,2,3,4,5,6,7,8,14,15,16,17,18,19,20,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,50,51,52,53,54,56,57,58,60,62,63,64,69,71,72,74,75,76,77,78,79,80],replac:50,restrict:[1,2,3,4,5,6,7,8,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],scalartransportmodel:68,scalartransportmodel_generalmanu:69,smoothingmodel:70,smoothingmodel_constdiffsmooth:71,smoothingmodel_nosmooth:72,solver:0,syntax:[1,2,3,4,5,6,7,8,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],tutori:0,voidfractionmodel:73,voidfractionmodel_bigparticlevoidfract:76,voidfractionmodel_centrevoidfract:77,voidfractionmodel_dividedvoidfract:78,voidfractionmodel_gaussvoidfract:74,voidfractionmodel_ibvoidfract:75,voidfractionmodel_novoidfractionvoidfract:79,voidfractionmodel_trilinearvoidfract:80,writeliggght:50}})" }, { "path": "doc/_build/html/smoothingModel.html", "content": "\n\n\n \n\n \n smoothingModel command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • smoothingModel command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

smoothingModel command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
smoothingModel model;\n
\n
\n
    \n

  • model = name of the smoothingModel to be applied

    • \n
\n
\n
\n

Examples

\n
smoothingModel off;\nsmoothingModel  constDiffSmoothing;\nsmoothingModel  localPSizeDiffSmoothing;\n
\n
\n
\n

Note

\n

This examples list might not be complete - please look for other models (smoothingModel_XY) in this documentation.

\n
\n

ATTENTION: In case a smoothing model is used in conjunction with “PimpleImEx” solvers, the fields “sSmoothField” and “vSmoothField” must be placed in the initial time directory! This is because zeroGradient boundary conditions for these fields must be specified, otherwise the smoothing operation will give an Error.

\n
\n
\n

Description

\n

The smoothingModel is the base class for models that smoothen the exchange fields (i.e., voidfraction and the Ksl field in case of implicit force coupling). This is relevant in case one uses a small grid resolution compared to the local particle diameter (or parcel diameter in case one uses a parcel approach).

\n
\n
\n

Restrictions

\n
\n

These models are in beta testing.

\n
\n

Default: none.

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/smoothingModel_constDiffSmoothing.html", "content": "\n\n\n \n\n \n smoothingModel_constDiffSmoothing command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • smoothingModel_constDiffSmoothing command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

smoothingModel_constDiffSmoothing command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
smoothingModel constDiffSmoothing;\nconstDiffSmoothingProps\n{\n    lowerLimit number1;\n    upperLimit number2;\n    smoothingLength lengthScale;\n    smoothingLengthReferenceField lengthScaleRefField;\n    verbose;\n}\n
\n
\n
    \n

  • number1 = scalar fields will be bound to this lower value

    • \n

  • number2 = scalar fields will be bound to this upper value

    • \n

  • lengthScale = length scale over which the exchange fields will be smoothed out

    • \n

  • lengthScaleRefField = length scale over which reference fields (e.g., the average particle velocity) will be smoothed out. Should be always larger than lengthScale. If not specified, will be equal to lengthScale.

    • \n

  • verbose = (optional, default false) flag for debugging output

    • \n
\n
\n
\n

Examples

\n
constDiffSmoothingProps\n{\n    lowerLimit 0.1;\n    upperLimit 1e10;\n    smoothingLength 1500e-6;\n    smoothingLengthReferenceField 9000e-6;\n}\n
\n
\n
\n
\n

Description

\n

The “constDiffSmoothing” model is a basic smoothingModel model which reads a smoothing length scale being used for smoothing the exchange fields (voidfraction, Ksl, f if present). This model can be used for smoothing explicit force coupling fields, as well as implicit force coupling algorithms.\nSmoothing for reference fields is performed to “fill in” values in cells in which these reference fields are not specified. Values calculated in the cells (via Lagrangian-To-Euler mapping) are NOT changed! These reference fields are, e.g., the average particle velocity, which are not specified in all cells in case the flow is rather dilute.

\n
\n
\n

Restrictions

\n
\n

This model is tested in a limited number of flow situations.

\n
\n

ATTENTION: In case a smoothing model is used in conjunction with “PimpleImEx” solvers, the fields “f” and “fSmooth” must be placed in the initial time directory! This is because zeroGradient boundary conditions for the fields “f” and “fSmooth” must be specified, otherwise the smoothing operation will give an Error.

\n
\n
\n

Related commands

\n

smoothingModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/smoothingModel_noSmoothing.html", "content": "\n\n\n \n\n \n smoothingModel_noSmoothing command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • smoothingModel_noSmoothing command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

smoothingModel_noSmoothing command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
smoothingModel off;\n
\n
\n
\n
\n

Examples

\n
smoothingModel off;\n
\n
\n
\n
\n

Description

\n

The “noSmoothing” model is a dummy smoothingModel model which does no smoothing.

\n
\n
\n

Restrictions

\n
\n

none.

\n
\n
\n
\n

Related commands

\n

smoothingModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/voidFractionModel.html", "content": "\n\n\n \n\n \n voidfractionModel command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • voidfractionModel command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

voidfractionModel command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
voidfractionModel model;\n
\n
\n
    \n

  • model = name of the voidfractionModel to be applied

    • \n
\n
\n
\n

Examples

\n
voidfractionModel centre;\n
\n
\n
\n

Note

\n

This examples list might not be complete - please look for other models (voidfractionModel_XY) in this documentation.

\n
\n
\n
\n

Description

\n

The voidfractionModel is the base class for models to represent the DEM particle’s volume in the CFD domain via a voidfraction field.

\n
\n
\n

Restrictions

\n
\n

none.

\n
\n

Default: none.

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/voidFractionModel_GaussVoidFraction.html", "content": "\n\n\n \n\n \n voidfractionModel_GaussVoidFraction command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • voidfractionModel_GaussVoidFraction command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

voidfractionModel_GaussVoidFraction command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
voidfractionModel Gauss;\nGaussProps\n{\n    maxCellsPerParticle number1;\n    alphaMin number2;\n    weight number3;\n    porosity number4;\n}\n
\n
\n
    \n

  • number1 = maximum number of cells covered by a particle (search will fail when more than number1 cells are covered by the particle)

    • \n

  • number2 = (optional, default 0.1) minimum limit for voidfraction

    • \n

  • number3 = (optional) scaling of the particle volume to account for porosity or agglomerations.

    • \n

  • number4 = (optional) diameter of the particle’s representation is artificially increased according to number2 * Vparticle, volume remains unaltered!

    • \n
\n
\n
\n

Examples

\n
voidfractionModel Gauss;\nGaussProps\n{\n    maxCellsPerParticle 1000;\n    alphaMin 0.10;\n    weight 1.;\n    porosity 1.;\n}\n
\n
\n
\n
\n

Description

\n

The Gauss voidFraction model is supposed to be used when a particle (or its representation) is bigger than a CFD cell. The voidfraction field is set in those cell whose centres are inside the particle. The volume is here distributed according to a Gaussian distribution.

\n

The region of influence of a particle can be increased artificially by “porosity”, which blows up the particles, but keeps their volume (for voidfraction calculation) constant.

\n

The particle volume occupied in the CFD domain can be adjusted by the parameter “weight”, using Vparticle=dsphere^3*pi/6*weight.

\n
\n
\n

Restrictions

\n
\n

none.

\n
\n
\n
\n

Related commands

\n

voidfractionModel , bigParticle

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/voidFractionModel_IBVoidFraction.html", "content": "\n\n\n \n\n \n voidfractionModel_IBVoidFraction command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • voidfractionModel_IBVoidFraction command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

voidfractionModel_IBVoidFraction command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
voidfractionModel IB;\nIBProps\n{\n    maxCellsPerParticle number1;\n    alphaMin number2;\n    scaleUpVol number3;\n    checkPeriodicCells ;\n}\n
\n
\n
    \n

  • number1 = maximum number of cells covered by a particle (search will fail when more than number1 cells are covered by the particle)

    • \n

  • number2 = (optional, default 0.1) minimum limit for voidfraction

    • \n

  • number3 = diameter of the particle’s representation is artificially increased according to number3 * Vparticle, volume remains unaltered!

    • \n

  • checkPeriodicCells = (optional, default false) flag for considering the minimal distance to all periodic images of this particle

    • \n
\n
\n
\n

Examples

\n
voidfractionModel IB;\nIBProps\n{\n    maxCellsPerParticle 1000;\n    alphaMin 0.10;\n    scaleUpVol 5.0;\n}\n
\n
\n
\n
\n

Description

\n

The IB voidFraction model is supposed to be used when a particle (or its representation) is bigger than a CFD cell. The voidfraction field is set in those cell whose centres are inside the particle. The model is specially designed for cfdemSolverIB and creates a smooth transition of the voidfraction at the particle surface. Cells which are only partially covered by solid are marked by voidfraction values between 0 and 1 respectively.

\n

The region of influence of a particle can be increased artificially by “scaleUpVol”, which blows up the particles, but keeps their volume (for voidfraction calculation) constant.

\n

Code of this sub-model contributed by Alice Hager, JKU.

\n
\n
\n

Restrictions

\n
\n

none.

\n
\n
\n
\n

Related commands

\n

voidfractionModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/voidFractionModel_bigParticleVoidFraction.html", "content": "\n\n\n \n\n \n voidfractionModel_bigParticleVoidFraction command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • voidfractionModel_bigParticleVoidFraction command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

voidfractionModel_bigParticleVoidFraction command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
voidfractionModel bigParticle;\nbigParticleProps\n{\n    maxCellsPerParticle number1;\n    alphaMin number2;\n    weight number3;\n    porosity number4;\n}\n
\n
\n
    \n

  • number1 = maximum number of cells covered by a particle (search will fail when more than number1 cells are covered by the particle)

    • \n

  • number2 = (optional, default 0.1) minimum limit for voidfraction

    • \n

  • number3 = (optional) scaling of the particle volume to account for porosity or agglomerations.

    • \n

  • number4 = (optional) diameter of the particle’s representation is artificially increased according to number2 * Vparticle, volume remains unaltered!

    • \n
\n
\n
\n

Examples

\n
voidfractionModel bigParticle;\nbigParticleProps\n{\n    maxCellsPerParticle 1000;\n    alphaMin 0.10;\n    weight 1.;\n    porosity 5.0;\n}\n
\n
\n
\n
\n

Description

\n

The bigParticle voidFraction model is supposed to be used when a particle (or its representation) is bigger than a CFD cell. The voidfraction field is set in those cell whose centres are inside the particle which results in a stairstep representation of the bodies within the mesh (i.e. voidfraction is either 1 (fluid) of zero (solid)). For archiving accurate results, approx. 8 cells per particle diameter are necessary.

\n

The region of influence of a particle can be increased artificially by “porosity”, which blows up the particles, but keeps their volume (for voidfraction calculation) constant.

\n

The particle volume occupied in the CFD domain can be adjusted by the parameter “weight”, using Vparticle=dsphere^3*pi/6*weight.

\n

Parts of this sub-model contributed by Alice Hager, JKU.

\n
\n
\n

Restrictions

\n
\n

none.

\n
\n
\n
\n

Related commands

\n

voidfractionModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/voidFractionModel_centreVoidFraction.html", "content": "\n\n\n \n\n \n voidfractionModel_centreVoidFraction command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • voidfractionModel_centreVoidFraction command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

voidfractionModel_centreVoidFraction command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
voidfractionModel centre;\ncentreProps\n{\n    alphaMin number1;\n    volScale number2;\n}\n
\n
\n
    \n

  • number1 = (optional, default 0.1) minimum limit for voidfraction

    • \n

  • number2 = (optional, default 1) scaling (per type) of the particle volume to account for porosity or agglomerations.

    • \n
\n
\n
\n

Examples

\n
voidfractionModel centre;\ncentreProps\n{\n    alphaMin 0.1;\n    volScale ( 1. );\n}\n
\n
\n
\n
\n

Description

\n

The centre voidFraction model calculates the voidfraction in a CFD cell accounting for the volume of the particles whose centres are inside the cell.

\n

The particle volume occupied in the CFD domain can be adjusted by the parameter “volScale”, using Vparticle=dsphere^3*pi/6*volScale.

\n
\n
\n

Restrictions

\n
\n

none.

\n
\n
\n
\n

Related commands

\n

voidfractionModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/voidFractionModel_dividedVoidFraction.html", "content": "\n\n\n \n\n \n voidfractionModel_dividedVoidFraction command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • voidfractionModel_dividedVoidFraction command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

voidfractionModel_dividedVoidFraction command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
voidfractionModel divided;\ndividedProps\n{\n    alphaMin number1;\n    interpolation;\n    volScale number2;\n    porosity number3;\n    procBoundaryCorrection Switch1;\n    verbose  bool1;\n    cfdemUseOnly;\n}\n
\n
\n
    \n

  • number1 = (optional, default 0.1) minimum limit for voidfraction

    • \n

  • interpolation = (optional, default false) flag to interpolate voidfraction to particle positions

    • \n

  • number2 = (optional, default 1) scaling (per type) of the particle volume to account for porosity or agglomerations.

    • \n

  • number3 = (optional) diameter of the particle’s representation is artificially increased according to number2 * Vparticle, volume remains unaltered!

    • \n

  • Switch1 = (optional, default false) allow for correction at processor boundaries. This requires the use of engineIB and vice versa.

    • \n

  • bool1 = (optional, default false) flag for debugging output

    • \n

  • cfdemUseOnly = optional flag, default false

    • \n
\n
\n
\n

Examples

\n
voidfractionModel divided;\ndividedProps\n{\n    alphaMin 0.2;\n    volScale ( 1. );\n}\n
\n
\n
\n
\n

Description

\n

The divided voidFraction model is supposed to be used when a particle (or its representation) is in the size range of a CFD cell. The particle has radius R and it’s volume is divided in 29 non-overlapping regions of equal volume. The centroids of these volumes are then used to reproduce each volume. The first volume is a sphere with the center coinciding with the particle center. Radius of this subsphere can be found as follows:

\n\"_images/voidfractionModel_divided_pic2.png\"\n

The rest volume is a spherical layer that must is divided in 2 layers of equal volume. Position of the border between these two spherical layers in radial direction can be easily obtained:

\n\"_images/voidfractionModel_divided_pic3.png\"\n

Each of these spherical layers is later divided in 14 elements of equal volume. Position of the centroid point in radial direction of each volume in the first spherical layer is as follows

\n\"_images/voidfractionModel_divided_pic4.png\"\n

Similarly, for the second spherical layer remembering that the external radius is the particle radius:

\n\"_images/voidfractionModel_divided_pic5.png\"\n

The region of influence of a particle can be increased artificially by “porosity”, which blows up the particles, but keeps their volume (for voidfraction calculation) constant.

\n

The particle volume occupied in the CFD domain can be adjusted by the parameter “volScale”, using

\n\"_images/voidfractionModel_divided_pic6.png\"\n

In the basic implementation of solvers, the void fraction is calculated based on all particles. Depending on the solver used, the void fraction calculation is also performed for a certain type of particles.\nThe void fraction calculation is based on a three-step approach (reset, set and interpolate), i.e., the void fraction is time interpolated from a previous and a next void fraction field. Appropriate names for these fields have to be specified in the sub-dictionaries voidFracFieldNamesPrev and voidFracFieldNamesNext in the couplingProperties dictionary.

\n

If the particleShapeType multisphere is selected, caluclations are performed for multisphere particles. In this operation mode additional input for DHc or area per particle type may be required. Without this input the multisphere variant may fail.

\n
\n
\n

Restrictions

\n
\n

none.

\n
\n
\n
\n

Related commands

\n

voidfractionModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/voidFractionModel_noVoidFraction.html", "content": "\n\n\n \n\n \n voidfractionModel_noVoidFractionVoidFraction command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • voidfractionModel_noVoidFractionVoidFraction command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

voidfractionModel_noVoidFractionVoidFraction command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n

voidfractionModel noVoidFraction;

\n
\n
\n

Examples

\n

voidfractionModel noVoidFraction;

\n
\n
\n

Description

\n

The noVoidFraction voidFraction model is a dummy model and has no physical meaning.

\n
\n
\n

Restrictions

\n
\n

none.

\n
\n
\n
\n

Related commands

\n

voidfractionModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_build/html/voidFractionModel_trilinearVoidFraction.html", "content": "\n\n\n \n\n \n voidfractionModel_trilinearVoidFraction command — CFDEMcoupling 3.8.1 documentation\n \n \n \n \n \n \n \n \n \n \n\n\n \n
\n \n\n
\n\n
\n
\n
\n
    \n
  • »
    • \n
  • voidfractionModel_trilinearVoidFraction command
    • \n
  • \n
    • \n
\n
\n
\n
\n
\n \n
\n

voidfractionModel_trilinearVoidFraction command

\n
\n

Syntax

\n

Defined in couplingProperties dictionary.

\n
voidfractionModel trilinear;\ntrilinearProps\n{\n    alphaMin number1;\n}\n
\n
\n
    \n

  • number1 = (optional, default 0.1) minimum limit for voidfraction

    • \n
\n
\n
\n

Examples

\n
voidfractionModel trilinear;\ntrilinearProps\n{\n    alphaMin 0.3;\n}\n
\n
\n
\n
\n

Description

\n

The trilinear voidFraction model is supposed to be used when a particle (or its representation) is in the size range of a CFD cell. The particle’s volume is distributed over 8 neighbouring cell centres usind trilinear interpolation. This allows for a very smooth transition of particle volume when a particle travels from one cell to another cell.

\n
\n
\n

Restrictions

\n
\n

The model works only for a structured mesh with equal cubic cells and a clean x/y/z parallel distribution of the cells. WARNING: the alphaMin parameter is not yet considered in the model!!!

\n
\n
\n
\n

Related commands

\n

voidfractionModel

\n
\n
\n\n\n
\n
\n
\n\n
\n\n
\n

© Copyright 2025, DCS Computing GmbH.

\n
\n\n Built with Sphinx using a\n theme\n provided by Read the Docs.\n \n\n
\n
\n
\n
\n
\n \n\n\n" }, { "path": "doc/_static/css/theme_CFDEMcoupling.css", "content": "/** rtd_theme improved for CFDEMcoupling **/\n\n@import 'theme.css';\n\n/* add upper roman enumerations */\n.wy-plain-list-upperroman,.rst-content .section ol,.rst-content ol.upperroman,article ol{\nlist-style:upper-roman;\nline-height:24px;\nmargin-bottom:24px}\n.wy-plain-list-upperroman li,.rst-content .section ol li,.rst-content ol.upperroman li,article ol li{\nlist-style:upper-roman;\nmargin-left:24px}\n.wy-plain-list-upperroman li p:last-child,.rst-content .section ol li p:last-child,.rst-content ol.upperroman li p:last-child,article ol li p:last-child{\nmargin-bottom:0}\n.wy-plain-list-upperroman li ul,.rst-content .section ol li ul,.rst-content ol.upperroman li ul,article ol li ul{\nmargin-bottom:0}\n.wy-plain-list-upperroman li ul li,.rst-content .section ol li ul li,.rst-content ol.upperroman li ul li,article ol li ul li{\nlist-style:disc}\n" }, { "path": "doc/release-notes-PUBLIC-3.8.0.txt", "content": "\n===============================================================\nRelease notes for PUBLIC, version 3.8.0 \n\nsrc/lagrangian/cfdemParticle/subModels/IOModel/trackIO/trackIO.C | Josef Kerbl (DCS) reworked the trackIO IOModel to transfer the LIGGGHTS® particle IDs to the CFDEMcoupling output \nsrc/lagrangian/cfdemParticle/subModels/forceModel/checkCouplingInterval/checkCouplingInterval.C | Josef Kerbl (DCS) changed the default maximum values of CFL and particle CFL numbers to 1 \napplications/solvers/cfdemSolverIB/cfdemSolverIB.C | Josef Kerbl (DCS) added compatibility for non-Newtonian viscosity models \napplications/solvers/cfdemSolverPiso/cfdemSolverPiso.C | Josef Kerbl (DCS) added compatibility for non-Newtonian viscosity models \napplications/solvers/cfdemSolverPisoSTM/cfdemSolverPisoSTM.C | Josef Kerbl (DCS) added compatibility for non-Newtonian viscosity models \napplications/solvers/cfdemSolverPisoScalar/cfdemSolverPisoScalar.C | Josef Kerbl (DCS) added compatibility for non-Newtonian viscosity models \ntutorials/.gitignore | Alice Hager (DCS) moved all blockMeshDict files from constant/polyMesh to system \ndoc/_build/html/liggghtsCommandModel_execute.html | Alice Hager (DCS) updated the documentation of new features and keywords (handling of numbers and labels, defined keywords, noBlanks, ...) \ndoc/_build/html/liggghtsCommandModel_setDEMGravity.html | Alice Hager (DCS) added keyword unfix to documentation \ndoc/_build/html/CFDEMcoupling_Manual.html | Alice Hager (DCS) added information about the solveFlow keyword. \napplications/solvers/cfdemSolverIB/cfdemSolverIB.C | Alice Hager (DCS) added the solveFlow keyword \ncfdemCloudIB.C | Alice Hager (DCS) removed the DEMTorques_ from the getDEMdata function (bugfix) \nsrc/lagrangian/cfdemParticle/cfdemCloud/cfdemCloud.C | Josef Kerbl (DCS) removed the unused coupleForce_ switch \nsrc/lagrangian/cfdemParticle/subModels/forceModel/forceModel/forceModel.C | Josef Kerbl (DCS) removed the unused coupleForce_ switch \nsrc/lagrangian/cfdemParticle/subModels/forceModel/forceModel/forceModel.H | Josef Kerbl (DCS) removed the unused coupleForce_ switch \nsrc/lagrangian/cfdemParticle/subModels/forceModel/noDrag/noDrag.C | Josef Kerbl (DCS) removed the unused coupleForce_ switch \nsrc/lagrangian/cfdemParticle/subModels/dataExchangeModel/dataExchangeModel/dataExchangeModel.H | Josef Kerbl (DCS) elevated the warning of non-matching DEM-timestep, couplingInterval and CFD-timestep to error \ncheckCouplingInterval.C | Josef Kerbl (DCS) added checkCG to forceModels missing this \nfieldStore.C | Josef Kerbl (DCS) added checkCG to forceModels missing this \nfieldTimeAverage.C | Josef Kerbl (DCS) added checkCG to forceModels missing this \nnoDrag.C | Josef Kerbl (DCS) added checkCG to forceModels missing this \nvolWeightedAverage.C | Josef Kerbl (DCS) added checkCG to forceModels missing this \nArchimedes.C | Josef Kerbl (DCS) added support for typeSpecificCG to some force models \ncheckCouplingInterval.C | Josef Kerbl (DCS) added support for typeSpecificCG to some force models \ncfdemCloud.C | Josef Kerbl (DCS) changed the default value of cgWarnOnly to false \noneWayVTK.C | Christoph Goniva (DCS) bugfix to enable correct reading of v field (thx to Moritz Höfert) \napplications/utilities/cfdemPostproc/cfdemPostproc.C | Christoph Goniva (DCS) enable calculating an writing Us field (thx to Moritz Höfert) \nmeanSupVelocityForce.C | Christoph Goniva (DCS) enable using cellZones \nforceSubModel.C | Josef Kerbl (DCS) added check, if scaleDrag > 0 \nbashrc | Josef Kerbl (DCS) added support to automatically compile LIGGGHTS in debug mode for the Makefile.auto, if WM_COMPILE_OPTION is set to Debug \ncshrc | Josef Kerbl (DCS) added support to automatically compile LIGGGHTS in debug mode for the Makefile.auto, if WM_COMPILE_OPTION is set to Debug \nfunctions.sh | Josef Kerbl (DCS) added support to automatically compile LIGGGHTS in debug mode for the Makefile.auto, if WM_COMPILE_OPTION is set to Debug \ncfdemSolverPisoSTM.C | Christoph Goniva (DCS) added fvOptions and fixedFluxPressureBC for 5.x \ncfdemSolverPiso.C | Alice Hager (DCS) ported 5.x \ncfdemSolverPisoSTM.C | Christoph Goniva (DCS) - fvOptions added \napplications/utilities/cfdemPostproc/cfdemPostproc.C | Alice Hager (DCS) ported 5.x \nmeanSupVelocityForce.C | Alice Hager (DCS) ported 5.x & major revision \neulerianScalarField.C | Alice Hager (DCS) ported 5.x \ncfdemCloud.C | Alice Hager (DCS) ported 5.x \ncfdemCloud.C | Christoph Goniva (DCS) minor revision \ncfdemCloudIB.C | Alexander Podlozhnyuk (DCS) adaptions for periodic bc \nIOModel.C | Josef Kerbl (DCS) - revision ofor 5.x \ndataExchangeModel.C | Christoph Goniva (DCS) improved calculation of time step fraction \noneWayVTK.C | Josef Kerbl (DCS) bugfix \nLaEuScalarTemp.C | Alexander Podlozhnyuk (DCS) extension for compressible flow \nMeiLift.H | Stefan Radl (TUG) reference added \ncheckCouplingInterval.C | Christoph Goniva (DCS) consider scaleDia \ncheckCouplingInterval.C | Christoph Goniva (DCS) default maxCFL=1 \ncheckCouplingInterval.C | Christoph Goniva (DCS) default maxPCFL=1 \nforceSubModel.C | Christoph Goniva (DCS) new option scaleDH \ngradPForce.C | Christoph Goniva (DCS) verbose option \nnoDrag.C | Christoph Goniva (DCS) bugfix \nparticleCellVolume.C | Josef Kerbl (DCS) added header to output \nscalarGeneralExchange.C | Stefan Radl (TUG) major revisions \nviscForce.C | Christoph Goniva (DCS) verbose option \nengineSearch.C | Josef Kerbl (DCS) bugfix for MS use \nengineSearchIB.C | Alexander Podlozhnyuk (DCS) Stefan Radl (TUG) improved periodic \nstandardSearch.C | Josef Kerbl (DCS) bugfix for MS use \nIBVoidFraction.C | Alexander Podlozhnyuk (DCS) Stefan Radl (TUG) improved periodic \n===============================================================\n\n" }, { "path": "doc/release-notes-PUBLIC-3.8.1.txt", "content": "\n===============================================================\nRelease notes for PUBLIC, version 3.8.1\n\nUpdated CFDEMcoupling-PUBLIC to be compatible with OpenFOAM-6 ensuring\nfunctionality on Ubuntu 22.04 and 24.04.\n\nThis updated version and all tutorials are still compatible to LIGGGHTS-PUBLIC 3.8.0\n\nWhile this update contains some bugfixes and improvements, the main intention of this\nupdate is keeping CFDEMcoupling usable also on newer systems where the compilation of\nolder OpenFOAM versions may prove difficult.\n\nNote: On Ubuntu 24.04 set / export the environment variable WM_CXX_STD=c++14\nbefore starting the OpenFOAM-6 compilation.\n===============================================================\n\n" }, { "path": "src/eulerian/fvOptionsCFDEM/Make/files", "content": "derivedSources=sources/derived\n\n$(derivedSources)/meanSupVelocityForce/meanSupVelocityForce.C\n\nLIB = $(CFDEM_LIB_DIR)/libfvOptionsCFDEM\n" }, { "path": "src/eulerian/fvOptionsCFDEM/Make/options", "content": "sinclude $(GENERAL_RULES)/mplib$(WM_MPLIB)\nsinclude $(RULES)/mplib$(WM_MPLIB)\n\nGIT_VERSION := $(shell git describe --dirty --always --tags)\nPFLAGS+= -DGITVERSION=\\\"$(GIT_VERSION)\\\"\nPFLAGS+= -DDEBUGFLAG=\\\"$(DEBUG)\\\"\nPFLAGS+= -DCFDEMWMPROJECTVERSION=\"$(CFDEM_WM_PROJECT_VERSION)\"\n\ninclude $(CFDEM_ADD_LIBS_DIR)/$(CFDEM_ADD_LIBS_NAME)\n\nEXE_INC = \\\n $(PFLAGS) \\\n $(PINC) \\\n -I$(LIB_SRC)/finiteVolume/lnInclude \\\n -I$(LIB_SRC)/meshTools/lnInclude \\\n -I$(LIB_SRC)/sampling/lnInclude \\\n -I$(LIB_SRC)/fvOptions/lnInclude \\\n -I$(CFDEM_OFVERSION_DIR) \\\n\n\nLIB_LIBS = \\\n $(PLIBS) \\\n -lfiniteVolume \\\n -lsampling \\\n -lmeshTools \\\n -lfvOptions\n" }, { "path": "src/eulerian/fvOptionsCFDEM/sources/derived/meanSupVelocityForce/meanSupVelocityForce.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright (C) 2011 OpenFOAM Foundation\n Copyright (C) 2012- DCS Computing GmbH,Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling. If not, see .\n\n\\*---------------------------------------------------------------------------*/\n\n#include \"meanSupVelocityForce.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n#include \"DimensionedField.H\"\n#include \"fvMatrices.H\"\n\n// * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * //\n\nnamespace Foam\n{\nnamespace fv\n{\n defineTypeNameAndDebug(meanSupVelocityForce, 0);\n\n addToRunTimeSelectionTable\n (\n option,\n meanSupVelocityForce,\n dictionary\n );\n}\n}\n\n// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\nFoam::fv::meanSupVelocityForce::meanSupVelocityForce\n(\n const word& sourceName,\n const word& modelType,\n const dictionary& dict,\n const fvMesh& mesh\n)\n:\n meanVelocityForce(sourceName, modelType, dict, mesh),\n twoPhase_( coeffs_.lookupOrDefault(\"twoPhase\",false) ),\n alpha_\n ( \n IOobject\n (\n \"voidfractionPrev\",\n mesh_.time().timeName(),\n mesh_,\n IOobject::NO_READ,//MUST_READ,\n IOobject::NO_WRITE\n ),\n mesh_,\n dimensionedScalar(\"ones\", dimensionSet(0,0,0,0,0), 1)\n ),\n coupled_( coeffs_.lookupOrDefault(\"coupled\",false) ),\n voidfraction_\n ( \n IOobject\n (\n \"voidfractionPrev\",\n mesh_.time().timeName(),\n mesh_,\n IOobject::NO_READ,//MUST_READ,\n IOobject::NO_WRITE\n ),\n mesh_,\n dimensionedScalar(\"ones\", dimensionSet(0,0,0,0,0), 1)\n ),\n modelName_(modelType),\n alphaMin_(coeffs_.lookupOrDefault(\"alphaMin\",0.0))\n\n{\n Warning << \"THE FVOPTION meanSupVelocityForce has not been tested/validated!!! \" << endl;\n}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\nvoid Foam::fv::meanSupVelocityForce::correct(volVectorField& U)\n{\n if (twoPhase_)\n {\n word alphaName = coeffs_.lookup(\"alphaField\");\n alpha_ = mesh_.lookupObject(alphaName);\n }\n\n if (coupled_)\n {\n word voidfractionName = coeffs_.lookup(\"voidfractionField\");\n voidfraction_ = mesh_.lookupObject(voidfractionName);\n }\n \n // making sure that alpha is only set almost-only fluid regions if desired\n forAll(alpha_,cellI)\n {\n if(alpha_[cellI]());\n reduce(totV, sumOp());\n V_=totV;\n\n // Volume averages\n rAUave /= V_;\n\n scalar magUbarAve = this->magUbarAve(U);\n\n // Calculate the pressure gradient increment needed to adjust the average\n // flow-rate to the desired value\n dGradP_ = relaxation_*(mag(Ubar_) - magUbarAve)/rAUave;\n\n // Apply correction to velocity field\n if (modelName_==\"B\" || modelName_==\"Bfull\")\n {\n forAll(cells_, i)\n {\n label cellI = cells_[i];\n U[cellI] += flowDir_*rAU[cellI]*dGradP_*alpha_[cellI];\n }\n }\n else\n {\n forAll(cells_, i)\n {\n label cellI = cells_[i];\n U[cellI] += voidfraction_[cellI]*flowDir_*rAU[cellI]*dGradP_*alpha_[cellI];\n }\n }\n\n scalar gradP = gradP0_ + dGradP_;\n\n Info<< \"Pressure gradient source: uncorrected Ubar = \" << magUbarAve\n << \", pressure gradient = \" << gradP << endl;\n\n writeProps(gradP);\n\n Warning << \"Pressure gradient force is neglected in this model!!\" << endl; \n\n // The following lines would compensate the error that occurs due to the splitting \n // of the pressure gradient. However, the particleCloud_ object is currently not\n // accessible here. \n /*scalar ds(0.0);\n scalar Vs(0.0);\n label cellI=0;\n for(int index = 0;index < particleCloud_.numberOfParticles(); index++)\n {\n //if(mask[index][0])\n //{\n cellI = particleCloud_.cellIDs()[index][0];\n \n if (cellI > -1) // particle found on this processor\n {\n //Calc the particle volume\n ds = 2*particleCloud_.radius(index);\n Vs = ds*ds*ds*M_PI/6;\n \n // set force on particle\n for(int j=0;j<3;j++) \n {\n // calc particle's static pressure gradient force\n particleCloud_.DEMForces()[index][j] -= Vs*gradP*flowDir_[j];\n }\n }\n }*/\n\n\n}\n\nvoid Foam::fv::meanSupVelocityForce::addSup\n(\n fvMatrix& eqn,\n const label fieldI\n)\n{\n DimensionedField Su\n (\n IOobject\n (\n name_ + fieldNames_[fieldI] + \"Sup\",\n mesh_.time().timeName(),\n mesh_,\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n mesh_,\n dimensionedVector(\"zero\", eqn.dimensions()/dimVolume, vector::zero)\n );\n\n scalar gradP = gradP0_ + dGradP_;\n\n if (modelName_==\"B\" || modelName_==\"Bfull\")\n {\n UIndirectList(Su, cells_) = flowDir_*gradP;\n }\n else\n {\n //UIndirectList(Su, cells_) = voidfraction_*flowDir_*gradP*alpha_; // org version does not work for zones\n\n UIndirectList(Su, cells_) = vector::zero;\n label cellI(-1);\n forAll(cells_,i)\n {\n cellI = cells_[i];\n Su[cellI] = voidfraction_[cellI]*flowDir_*gradP*alpha_[cellI];\n }\n }\n\n eqn += Su;\n\n}\n\nFoam::scalar Foam::fv::meanSupVelocityForce::magUbarAve\n(\n const volVectorField& U\n) const\n{\n scalar magUbarAve = 0.0;\n\n const scalarField& cv = mesh_.V();\n forAll(cells_, i)\n {\n label cellI = cells_[i];\n scalar volCell = cv[cellI];\n magUbarAve += (flowDir_ & U[cellI])*volCell*alpha_[cellI]*voidfraction_[cellI];\n }\n\n reduce(magUbarAve, sumOp());\n\n magUbarAve /= V_;\n\n return magUbarAve;\n}\n\n\n\n\n// ************************************************************************* //\n" }, { "path": "src/eulerian/fvOptionsCFDEM/sources/derived/meanSupVelocityForce/meanSupVelocityForce.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright (C) 2011 OpenFOAM Foundation\n Copyright (C) 2012- DCS Computing GmbH,Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling. If not, see .\n\nDescription\n This code is based on meanSupVelocity model of OpenFOAM 3.0.x\n It is extended to account for the presence of a particle phase.\n\n Calculates and applies the force necessary to maintain the specified mean\n velocity.\n\n Note: Currently only handles kinematic pressure (incompressible solvers).\n\n \\heading Source usage\n Example usage:\n \\verbatim\n meanSupVelocityForceCoeffs\n {\n selectionMode all; // Apply force to all cells\n fieldNames (U); // Name of velocity field\n Ubar (10.0 0 0); // Desired mean velocity\n relaxation 0.2; // Optional relaxation factor\n }\n \\endverbatim\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef meanSupVelocityForce_H\n#define meanSupVelocityForce_H\n\n#include \"meanVelocityForce.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\nnamespace fv\n{\n\n/*---------------------------------------------------------------------------*\\\n Class meanSupVelocityForce Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass meanSupVelocityForce\n:\n public meanVelocityForce\n{\nprotected:\n\n // Protected data\n\n const bool twoPhase_;\n\n volScalarField alpha_;\n\n const bool coupled_;\n\n\t volScalarField voidfraction_;\n\n const word modelName_;\n\n const scalar alphaMin_;\n\n // Protected Member Functions\n\n virtual scalar magUbarAve(const volVectorField& U) const;\n\nprivate:\n\n // Private Member Functions\n\n //- Disallow default bitwise copy construct\n meanSupVelocityForce(const meanSupVelocityForce&);\n\n //- Disallow default bitwise assignment\n void operator=(const meanSupVelocityForce&);\n\npublic:\n\n //- Runtime type information\n TypeName(\"meanSupVelocityForce\");\n\n\n // Constructors\n\n //- Construct from explicit source name and mesh\n meanSupVelocityForce\n (\n const word& sourceName,\n const word& modelType,\n const dictionary& dict,\n const fvMesh& mesh\n );\n\n\n // Member Functions\n\n // Evaluate\n\n virtual void correct(volVectorField& U);\n\n virtual void addSup\n (\n fvMatrix& eqn,\n const label fieldI\n );\n\n // IO\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace fv\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/eulerian/scalarTransportModelsCFDEM/Make/files", "content": "scalarTransportModel/scalarTransportModel.C\nscalarTransportModel/newScalarTransportModel.C\n\n/*Sub-Level*/\ntemperatureModel/temperatureModel.C\ngeneralManual/generalManual.C\nnoTransport/noTransport.C\ngeneralPhaseChange/generalPhaseChange.C\n\n/*Fields*/\neulerianScalarField/eulerianScalarField.C\neulerianScalarField/newEulerianScalarField.C\n\n/*PhaseChangeModels*/\nphaseChangeModel/phaseChangeModel.C\nphaseChangeModel/newPhaseChangeModel.C\n\nLIB = $(CFDEM_LIB_DIR)/libscalarTransportModelsCFDEM\n" }, { "path": "src/eulerian/scalarTransportModelsCFDEM/Make/options", "content": "sinclude $(GENERAL_RULES)/mplib$(WM_MPLIB)\nsinclude $(RULES)/mplib$(WM_MPLIB)\n\nGIT_VERSION := $(shell git describe --dirty --always --tags)\nPFLAGS+= -DGITVERSION=\\\"$(GIT_VERSION)\\\"\nPFLAGS+= -DDEBUGFLAG=\\\"$(DEBUG)\\\"\nPFLAGS+= -DCFDEMWMPROJECTVERSION=\"$(CFDEM_WM_PROJECT_VERSION)\"\n\ninclude $(CFDEM_ADD_LIBS_DIR)/$(CFDEM_ADD_LIBS_NAME)\n\nEXE_INC = \\\n $(PFLAGS) \\\n $(PINC) \\\n $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \\\n -I$(LIB_SRC)/transportModels \\\n -I$(LIB_SRC)/transportModels/incompressible/singlePhaseTransportModel \\\n -I$(LIB_SRC)/finiteVolume/lnInclude \\\n -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/lnInclude \\\n -I$(LIB_SRC)/meshTools/lnInclude \\\n -I$(LIB_SRC)/sampling/lnInclude \\\n -I$(CFDEM_LIGGGHTS_SRC_DIR)\n\nLIB_LIBS = \\\n -L$(CFDEM_LIB_DIR)\\\n $(CFDEM_ADD_INCOMPTURBMOD_LIBS) \\\n -lincompressibleTransportModels \\\n -lfiniteVolume \\\n -lmeshTools \\\n -lsampling \\\n" }, { "path": "src/eulerian/scalarTransportModelsCFDEM/eulerianScalarField/eulerianScalarField.C", "content": "/*---------------------------------------------------------------------------*\\\nLicense\n\n This is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This code is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with this code. If not, see .\n\n Copyright (C) 2014- Stefan Radl, TU Graz, Austria\n\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n#include \"eulerianScalarField.H\"\n#include \"OFversion.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(eulerianScalarField, 0);\n\ndefineRunTimeSelectionTable(eulerianScalarField, dictionary);\n\n// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\neulerianScalarField::eulerianScalarField\n(\n const dictionary& dict,\n cfdemCloud& sm,\n word modelType,\n int modelID\n)\n:\n dict_(dict),\n particleCloud_(sm),\n fieldName_(modelType),\n cpVolumetricFieldName_(dict_.lookupOrDefault(\"cpVolumetricFieldName\", \"na\")),\n cpVolumetric_(dict_.lookupOrDefault(\"cpVolumetric\", 0.0)),\n updateMixtureProperties_(dict_.lookupOrDefault(\"updateMixtureProperties\", false)),\n rho_(dict_.lookupOrDefault(\"rho\"+fieldName_, -1)),\n rhoCarrier_(dict_.lookupOrDefault(\"rhoCarrier\", -1)),\n cp_(dict_.lookupOrDefault(\"cp\"+fieldName_, -1)),\n cpCarrier_(dict_.lookupOrDefault(\"cpCarrier\", -1)),\n m_\n ( IOobject\n (\n fieldName_,\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n sm.mesh()\n ),\n mSource_\n ( IOobject\n (\n fieldName_+\"Source\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n sm.mesh()\n ),\n mSourceKImpl_\n ( IOobject\n (\n fieldName_+\"SourceKImpl\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::NO_READ,\n IOobject::AUTO_WRITE\n ),\n 0.0*mSource_ /( m_ + dimensionedScalar(\"dummy\", m_.dimensions(), 1e-32) ) //initi with zero\n ),\n fieldType_(\"undefined\")\n #ifndef versionExt32\n ,fvOptions_(sm.mesh())\n #endif\n{\n\n\n if ( m_.dimensions() == dimensionSet(0, 0, 0, 1, 0) )\n {\n speciesID_ = -1;\n fieldType_ = \"temperature\";\n Info << \"eulerianScalarField:: found a Temperature field! \" << endl;\n }\n else\n {\n speciesID_ = modelID;\n fieldType_ = \"species\";\n Info << \"eulerianScalarField:: found a species field, will assign speciesID: \" \n << speciesID_\n << endl;\n }\n\n #ifndef versionExt32\n fvOptions_.reset(dict.subDict(\"fvOptions\"+fieldName_));\n #endif\n\n if( (cpVolumetricFieldName_==\"na\"||!updateMixtureProperties_) && cpVolumetric_<=0.0)\n FatalError <<\"You did not specify a cpVolumetricFieldName (or you do not updateMixtureProperties) and also cpVolumetric is zero (or negative)! Either provide the field name, or set cpVolumetric to a reasonable value. \\n\" \n << abort(FatalError); \n\n if(speciesID_>-1 && updateMixtureProperties_ && (rho_<=0 || cp_<=0) )\n FatalError <<\"You like to update the phase properties, but density and cp of the eulerianScalarField with name '\" \n << fieldName_\n <<\"' are not specified or zero. \\n\" \n << abort(FatalError); \n\n if(speciesID_>-1 && updateMixtureProperties_ && (rhoCarrier_<=0 || cpCarrier_<=0) )\n FatalError <<\"You like to update the phase properties, but density and cp of the carrier phase are not specified or zero \\n\" \n << abort(FatalError); \n \n //Report options for cp \n if(fieldType_==\"temperature\")\n {\n if(cpVolumetric_!=0.0 && cpVolumetricFieldName_!=\"na\")\n FatalError <<\"eulerianScalarField:: You have specified 'cpVolumetric' and 'cpVolumetricFieldName' in a dictionary in '/constant'. This might be confusing. Please unset one of these two inputs to avoid confusion. \\n\" \n << abort(FatalError); \n\n if(cpVolumetricFieldName_==\"na\" || !updateMixtureProperties_) //use also if mixture properties are not updated\n Info << \"eulerianScalarField:: will use the following FIXED VOLUMETRIC HEAT CAPACITY: \" \n << cpVolumetric_ << \" [J/K/m³]\" << endl;\n else\n Info << \"eulerianScalarField:: will use the a SPATIALLY-VARAIBLE VOLUMETRIC HEAT CAPACITY with name: \" << cpVolumetricFieldName_ << endl;\n }\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\neulerianScalarField::~eulerianScalarField()\n{}\n\n// * * * * * * * * * * * * * * * * Member Fct * * * * * * * * * * * * * * * //\n\n// ************************************************************\nvoid eulerianScalarField::update(surfaceScalarField phi, volScalarField voidfraction, volScalarField nuEff, scalar Sc, bool limitDiffusion) const \n{\n scalar oneByCpVolumetric = 1./(cpVolumetric_+SMALL);\n //Normalize source in case we have a temperature field\n if(fieldType_==\"temperature\")\n {\n if(cpVolumetricFieldName_==\"na\" || !updateMixtureProperties_) //use also if mixture properties are not updated\n {\n mSource_ *= oneByCpVolumetric;\n mSourceKImpl_ *= oneByCpVolumetric;\n }\n else\n {\n const volScalarField& cpVolumetricField_(particleCloud_.mesh().lookupObject (cpVolumetricFieldName_));\n\n #if defined(version40) || defined(versionv1612plus)\n mSource_.primitiveFieldRef() /= cpVolumetricField_.primitiveField()+SMALL;\n mSourceKImpl_.primitiveFieldRef() /= cpVolumetricField_.primitiveField()+SMALL;\n #else\n mSource_.internalField() /= cpVolumetricField_.internalField()+SMALL;\n mSourceKImpl_.internalField() /= cpVolumetricField_.internalField()+SMALL;\n #endif\n }\n }\n\n word divScheme(\"div(phi,m)\");\n word laplacianScheme(\"laplacian(D,m)\");\n\n if( speciesID_== -1)\n {\n divScheme = \"div(phi,T)\";\n laplacianScheme = \"laplacian((DT*voidfraction),T)\";\n }\n\n // calc diffusionCoeff field\n volScalarField a=nuEff/Sc*voidfraction;\n if(limitDiffusion)\n {\n forAll(a,cellI)\n if(voidfraction[cellI] <2*SMALL)\n a[cellI]=0.;\n }\n\n // solve scalar transport equation\n fvScalarMatrix mEqn\n (\n\n fvm::ddt(voidfraction, m_) //This is the material derivative in a modified form\n - fvm::Sp(fvc::ddt(voidfraction), m_) //Needed since phi is (U_face * voidfraction)!\n + fvm::div(phi, m_, divScheme) //This phi must be SUPERFICIAL! (i.e., U_face * voidfraction)!\n - fvm::Sp(fvc::div(phi), m_)\n\n ==\n\n fvm::laplacian(a, m_, laplacianScheme) \n + mSource_\n + fvm::Sp(mSourceKImpl_, m_)\n #ifndef versionExt32\n + fvOptions_(m_)\n #endif\n );\n\n mEqn.relax();\n #ifndef versionExt32\n fvOptions_.constrain(mEqn);\n #endif\n mEqn.solve();\n\n\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/eulerian/scalarTransportModelsCFDEM/eulerianScalarField/eulerianScalarField.H", "content": "/*---------------------------------------------------------------------------*\\\nLicense\n\n This is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This code is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with this code. If not, see .\n\n Copyright (C) 2014- Stefan Radl, TU Graz, Austria\n\nApplication / Class\n eulerianScalarField\n \nDescription\n Base class for moment transport model & FVM-based solver.\n WARNING: the surfaceScalarField 'phi' must be based on U*voidfraction,\n and not on U!\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef eulerianScalarField_H\n#define eulerianScalarField_H\n\n#include \"cfdemCloud.H\"\n#include \"forceModel.H\"\n#ifndef versionExt32\n#include \"fvOptionList.H\"\n#endif\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class eulerianScalarField Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass eulerianScalarField\n{\n\nprotected:\n\n // Protected data\n const dictionary& dict_;\n\n cfdemCloud& particleCloud_;\n\n const word fieldName_;\n\n word cpVolumetricFieldName_; // name of the field holding the volumetric heat capacity\n // if not provided, must specify a constant holding this value\n\n scalar cpVolumetric_; // the (constant) volumetric heat capacity (optional)\n\n //species properties (if required, these properties will be set, default = -1\n bool updateMixtureProperties_; // switch to indicate whether phase properties will be updated or not\n scalar rho_; // the density of this field\n scalar rhoCarrier_; // the density of the carrier field\n scalar cp_; // the heat capacity of this field\n scalar cpCarrier_; // the heat capacity of the carrier field\n\n mutable volScalarField m_; // transported quantity\n\n mutable volScalarField mSource_; // source of transported quantity; \n // might involve part of implicit term\n\n mutable volScalarField mSourceKImpl_; // pre-factor for implicit source\n // will be added with negative sign in transport eqn.\n // will shadowed\n\n mutable word fieldType_;\n\n #ifndef versionExt32\n mutable fv::optionList fvOptions_;\n #endif\n\n int speciesID_;\n\n\npublic:\n\n //- Runtime type information\n TypeName(\"eulerianScalarField\");\n\n // Declare runtime constructor selection table\n\n declareRunTimeSelectionTable\n (\n autoPtr,\n eulerianScalarField,\n dictionary,\n (\n const dictionary& dict,\n cfdemCloud& sm,\n word modelType,\n int modelID\n ),\n (dict,sm,modelType,modelID)\n );\n\n\n // Constructors\n\n //- Construct from components\n eulerianScalarField\n (\n const dictionary& dict,\n cfdemCloud& sm,\n word modelType,\n int modelID\n );\n\n\n // Destructor\n\n virtual ~eulerianScalarField();\n\n\n // Selector\n\n static autoPtr New\n (\n const dictionary& dict,\n cfdemCloud& sm,\n word modelType,\n int modelID\n );\n\n\n // Member Functions\n void update(surfaceScalarField, volScalarField, volScalarField, scalar Sc, bool limitDiffusion=false) const ;\n\n void bound(autoPtr*) const {};\n\n // Access\n word fieldType() const { return fieldType_; };\n\n inline bool updateMixtureProperties() const { return updateMixtureProperties_; };\n inline scalar rho() const { return rho_; };\n inline scalar rhoCarrier() const { return rhoCarrier_; };\n inline scalar cp() const { return cp_; };\n inline scalar cpCarrier() const { return cpCarrier_; };\n\n inline volScalarField& m() const {return m_;}; //returns the transported quantity\n\n inline volScalarField& mSource() const {return mSource_;}; //returns the source\n inline volScalarField& mSourceKImpl() const {return mSourceKImpl_;}; //returns the implicit prefactor of the source\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/eulerian/scalarTransportModelsCFDEM/eulerianScalarField/newEulerianScalarField.C", "content": "/*---------------------------------------------------------------------------*\\\nLicense\n\n This is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This code is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with this code. If not, see .\n\n Copyright (C) 2014- Stefan Radl, TU Graz, Austria\n\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n#include \"eulerianScalarField.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\nautoPtr eulerianScalarField::New\n(\n const dictionary& dict,\n cfdemCloud& sm,\n word modelType,\n int modelID\n)\n{\n Info<< \"Creating eulerianScalarField with name: \"\n << modelType \n << \" and ID \" << modelID << endl;\n\n return autoPtr(new eulerianScalarField(dict,sm,modelType,modelID));\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/eulerian/scalarTransportModelsCFDEM/generalManual/generalManual.C", "content": "/*---------------------------------------------------------------------------*\\\nLicense\n\n This is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This code is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with this code. If not, see .\n\n Copyright (C) 2014- Stefan Radl, TU Graz, Austria\n\n\\*---------------------------------------------------------------------------*/\n\n#include \"generalManual.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(generalManual, 0);\n\naddToRunTimeSelectionTable\n(\n\tscalarTransportModel,\n\tgeneralManual,\n\tdictionary\n);\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\ngeneralManual::generalManual\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n scalarTransportModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n phiFieldName_(propsDict_.lookupOrDefault(\"phiFieldName\", \"phi\")),\n voidfractionFieldName_(propsDict_.lookupOrDefault(\"voidfractionFieldName\", \"voidfraction\")),\n eulerianFieldList_(propsDict_.lookup(\"eulerianFields\")),\n ScT_(0.7),\n PrT_(0.7),\n idTemp_(-1),\n updateMixtureProperties_(propsDict_.lookupOrDefault(\"updateMixtureProperties\", true)),\n rhoMix_\n ( IOobject\n (\n propsDict_.lookupOrDefault(\"rhoMixFieldName\",\"rhoMixDefault\"),\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::NO_READ,\n IOobject::AUTO_WRITE\n ),\n sm.mesh(),\n dimensionedScalar(\"dummy\", dimensionSet(1,-3,0,0,0), -1)\n ),\n cpRho_\n ( IOobject\n (\n propsDict_.lookupOrDefault(\"cpVolumetricFieldName\",\"cpRhoDefault\"),\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n sm.mesh(),\n dimensionedScalar(\"dummy\", dimensionSet(1,-1,-2,-1,0), -1)\n )\n{\n\n propsDict_.readIfPresent(\"ScT\", ScT_);\n propsDict_.readIfPresent(\"PrT\", PrT_);\n \n Info << \"generalManual:: Using the following turbulent dispersion coefficients: ScT = \" << ScT_ << \" and PrT \" << PrT_ << endl;\n\n eulerianFields_ = new autoPtr[eulerianFieldList_.size()];\n for (int i=0;i (phiFieldName_));\n const volScalarField& voidfraction(particleCloud_.mesh().lookupObject (voidfractionFieldName_));\n //==============================\n\n //Loop through all eulerian fields and update them\n for (int i=0;i.\n\n Copyright (C) 2014- Stefan Radl, TU Graz, Austria\n\n Description\n Evolves an arbitrary number of scalar quantities, exchanges sources\n with the granular phase\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef generalManual_H\n#define generalManual_H\n\n#include \"scalarTransportModel.H\"\n#include \"forceModel.H\"\n#include \"eulerianScalarField.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class generalManual Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass generalManual\n:\n public scalarTransportModel\n{\n\nprotected:\n\n dictionary propsDict_;\n\n word phiFieldName_;\n\n word voidfractionFieldName_;\n\n const wordList eulerianFieldList_;\n\n autoPtr* eulerianFields_;\n\n scalar ScT_; // - Turbulent Schmidt number (optional, default = 0.7)\n\n scalar PrT_; // - Turbulent Prandtl number (optional, default = 0.7)\n\n int idTemp_; //id with temperature field\n\n //Extra fields to represent a mixture in the void space\n bool updateMixtureProperties_; // switch to indicate whether phase properties will be updated or not\n volScalarField rhoMix_; //field (if needed) to hold mixture density\n volScalarField cpRho_; //field (if needed) to hold volumetric cp-value\n \n\n\npublic:\n\n //- Runtime type information\n TypeName(\"generalManual\");\n\n\n // Constructors\n\n //- Construct from components\n generalManual\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~generalManual();\n\n\n // Member Functions\n\n const eulerianScalarField& eulerianTemperatureF();\n\n const eulerianScalarField& eulerianScalarF(int);\n\n void createFields();\n\n void update();\n\n void evolveFields();\n\n volScalarField& sourceField(int i);\n\n\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/eulerian/scalarTransportModelsCFDEM/generalPhaseChange/generalPhaseChange.C", "content": "/*---------------------------------------------------------------------------*\\\nLicense\n\n This is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This code is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with this code. If not, see .\n\n Copyright (C) 2014- Stefan Radl, TU Graz, Austria\n\n\\*---------------------------------------------------------------------------*/\n\n#include \"generalPhaseChange.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(generalPhaseChange, 0);\n\naddToRunTimeSelectionTable\n(\n\tscalarTransportModel,\n\tgeneralPhaseChange,\n\tdictionary\n);\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\ngeneralPhaseChange::generalPhaseChange\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n generalManual(dict,sm),\n phaseChangeDict_(propsDict_.subDict(\"PhaseChangeParameters\")),\n phaseChangeModelList_(phaseChangeDict_.lookup(\"phaseChangeModels\"))\n{\n\n phaseChangeModels_ = new autoPtr[phaseChangeModelList_.size()];\n for (int i=0;i (voidfractionFieldName_));\n for (int i=0;i.\n\n Copyright (C) 2015 -Stefan Radl, TU Graz, Austria\n\n Description\n Derived from generalManual transport Model\n Evolves an arbitrary number of scalar quantities, exchanges sources\n with the granular phase, and implements phase-change physics \n between the Eulerian phases\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef generalPhaseChange_H\n#define generalPhaseChange_H\n\n#include \"generalManual.H\"\n#include \"forceModel.H\"\n#include \"phaseChangeModel.H\"\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class generalPhaseChange Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass generalPhaseChange\n:\n public generalManual\n{\n\nprotected:\n\n dictionary phaseChangeDict_;\n\n const wordList phaseChangeModelList_;\n\n autoPtr* phaseChangeModels_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"generalPhaseChange\");\n\n\n // Constructors\n //- Construct from components\n generalPhaseChange\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n ~generalPhaseChange();\n\n //Access function\n const phaseChangeModel& phaseChangeModelRef(int); //must be const to satisfy compiler!\n\n // Member Functions\n\n void createFields();\n\n void update();\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/eulerian/scalarTransportModelsCFDEM/noTransport/noTransport.C", "content": "/*---------------------------------------------------------------------------*\\\nLicense\n\n This is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This code is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with this code. If not, see .\n\n Copyright (C) 2014- Stefan Radl, TU Graz, Austria\n\n\\*---------------------------------------------------------------------------*/\n\n#include \"noTransport.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(noTransport, 0);\n\naddToRunTimeSelectionTable\n(\n\tscalarTransportModel,\n\tnoTransport,\n\tdictionary\n);\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n// Construct from components\nnoTransport::noTransport\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n scalarTransportModel(dict,sm)\n{\n}\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\nnoTransport::~noTransport()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\nvoid noTransport::createFields()\n{}\n\n// ************************************************************\nvoid noTransport::update()\n{}\n\n// ************************************************************\nconst volScalarField& noTransport::sourceField()\n{\n FatalErrorIn(\"const volScalarField& noTransport::sourceField() \")\n << \"this source field is NOT implemented, and hence MUST NOT be called!\" << abort(FatalError);\n return volScalarField::null();\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/eulerian/scalarTransportModelsCFDEM/noTransport/noTransport.H", "content": "/*---------------------------------------------------------------------------*\\\nLicense\n\n This is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This code is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with this code. If not, see .\n\n Copyright (C) 2014- Stefan Radl, TU Graz, Austria\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef noTransport_H\n#define noTransport_H\n\n#include \"scalarTransportModel.H\"\n#include \"forceModel.H\"\n#include \"eulerianScalarField.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noTransport Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass noTransport\n:\n public scalarTransportModel\n{\n\npublic:\n\n //- Runtime type information\n TypeName(\"none\");\n\n\n // Constructors\n\n //- Construct from components\n noTransport\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n \t~noTransport();\n\n\n // Member Functions\n\n void createFields();\n\n void update();\n\n const volScalarField& sourceField();\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/eulerian/scalarTransportModelsCFDEM/phaseChangeModel/newPhaseChangeModel.C", "content": "/*---------------------------------------------------------------------------*\\\nLicense\n\n This is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This code is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with this code. If not, see .\n\n Copyright (C) 2014- Stefan Radl, TU Graz, Austria\n\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n#include \"phaseChangeModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\nautoPtr phaseChangeModel::New\n(\n const dictionary& dict,\n cfdemCloud& sm,\n word modelType,\n int modelID\n)\n{\n Info<< \"Creating phaseChangeModel with name: \"\n << modelType \n << \" and ID \" << modelID << endl;\n\n return autoPtr(new phaseChangeModel(dict,sm,modelType,modelID));\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/eulerian/scalarTransportModelsCFDEM/phaseChangeModel/phaseChangeModel.C", "content": "/*---------------------------------------------------------------------------*\\\nLicense\n\n This is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This code is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with this code. If not, see .\n\n Copyright (C) 2014- Stefan Radl, TU Graz, Austria\n\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n#include \"phaseChangeModel.H\"\n#include \"IOmanip.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(phaseChangeModel, 0);\n\ndefineRunTimeSelectionTable(phaseChangeModel, dictionary);\n\n// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nphaseChangeModel::phaseChangeModel\n(\n const dictionary& dict,\n cfdemCloud& sm,\n word modelType,\n int modelID\n)\n:\n dict_(dict),\n particleCloud_(sm),\n modelName_(modelType),\n mSaturation_\n ( IOobject\n (\n modelName_+\"Saturation\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n sm.mesh(),\n dimensionedScalar(\"dummy\", dimensionSet(0,0,0,0,0), -1)\n ),\n mSource_\n ( IOobject\n (\n modelName_+\"Rate\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::NO_READ,\n IOobject::AUTO_WRITE\n ),\n sm.mesh(),\n dimensionedScalar(\"dummy\", dimensionSet(0,0,-1,0,0), -1)\n ),\n speciesIDFrom_(0),\n speciesIDTo_(1),\n parameterVap_(dict_.lookup(\"parameterVap\")),\n Rvap_(dict_.lookupOrDefault(\"Rvap\", 461.5)),\n alphaImExSplit_(dict_.lookupOrDefault(\"alphaImExSplit\", 0.5)),\n cpFromField_(0.0),\n cpToField_(0.0),\n deltaHEvap_(dict_.lookup(\"deltaHEvap\")),\n tEvap_(dict_.lookup(\"tEvap\")),\n verboseDiskIntervall_(-1), //zero or negative--> deaktivate output to disk\n verboseDiskCounter_(0),\n sPtr_(NULL)\n{\n if(parameterVap_.size()<5)\n FatalError <<\"phaseChangeModel: parameterVap_.size()<5! Provide more parameters to this model. \\n\" \n << abort(FatalError); \n\n if(alphaImExSplit_<0 || alphaImExSplit_>1)\n FatalError <<\"alphaImExSplit must be between 0 and 1. \\n\" \n << abort(FatalError); \n if(dict_.found(\"verboseDiskIntervall\"))\n verboseDiskIntervall_=readScalar(dict_.lookup(\"verboseDiskIntervall\"));\n\n if (verboseDiskIntervall_>0)\n {\n Info << \"phaseChangeModel will report to disk with intervall \" << verboseDiskIntervall_ << endl;\n initialzeSummation(typeName, \"phaseChange.logDat\");\n }\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nphaseChangeModel::~phaseChangeModel()\n{}\n\n// * * * * * * * * * * * * * * * * Member Fct * * * * * * * * * * * * * * * //\nvoid phaseChangeModel::update(const volScalarField& voidfraction, //this is 1-particleFraction field\n const volScalarField& temp, //this is temperature field of the fluid phase\n const eulerianScalarField& fromField, const eulerianScalarField& toField) const \n{\n //To implement phase change model updates that directly affect \"fromField\", and \"toField\"\n //MUST ADD to sources (not reset sources!)\n //MUST be per m³ TOTAL volume, since scalar transport solver is based on this\n \n //update the saturation field and cp quantities\n cpFromField_ = fromField.cpCarrier();\n cpToField_ = toField.cpCarrier();\n\n forAll(mSaturation_, iter)\n mSaturation_[iter] = pVapor( temp[iter] ) / temp[iter] / Rvap_; \n\n //update the reference quantities\n\n volScalarField tempF = voidfraction \n\t / ( \n fromField.m()\n + toField.m() * fromField.rho() / toField.rho()\n + fromField.rho() / fromField.rhoCarrier()\n ); //phi_liquid ... (global) liquid volume fraction (per m³ total!)\n //divided by fromField.m() \n\n\n //leaving mass rate - implicit/explicit term (divided by fromFiel.m())\n#if defined(version40) || defined(versionv1612plus)\n fromField.mSource() -= (1-alphaImExSplit_) * tempF * fromField.m()\n#else\n fromField.mSource().internalField() -= (1-alphaImExSplit_) * tempF.internalField() * fromField.m()\n#endif\n / tEvap_.value() //characteristic evaporation time\n * ( \n mSaturation_ \n - toField.m()\n *fromField.rhoCarrier()\n );\n\n#if defined(version40) || defined(versionv1612plus)\n fromField.mSourceKImpl() -= alphaImExSplit_ * tempF\n#else\n fromField.mSourceKImpl().internalField() -= alphaImExSplit_ * tempF.internalField() \n#endif\n / tEvap_.value() //characteristic evaporation time\n * ( \n mSaturation_ \n - toField.m()\n *fromField.rhoCarrier()\n );\n\n tempF *= fromField.m() / tEvap_.value(); //phi_liquid ... (global) liquid volume fraction\n //divided by evaporation time scale\n\n\n //entering mass rate - explicit & implicit term\n\n#if defined(version40) || defined(versionv1612plus)\n toField.mSource() += tempF * mSaturation_;\n toField.mSourceKImpl()-= tempF * toField.rhoCarrier();\n#else\n toField.mSource().internalField() += tempF.internalField() * mSaturation_;\n toField.mSourceKImpl().internalField() -= tempF.internalField() * toField.rhoCarrier();\n#endif\n\n\n //set the rate\n#if defined(version40) || defined(versionv1612plus)\n mSource_ = tempF \n#else\n mSource_.internalField() = tempF .internalField()\n#endif\n * ( \n mSaturation_\n - toField.m()\n * toField.rhoCarrier() \n );\n\n if(verboseToDisk())\n computeIntegral(mSource_);\n}\n\n//************************************************\nvoid phaseChangeModel::setEnthalpySource(const eulerianScalarField& Temperature) const\n{\n\n //update the heat source\n#if defined(version40) || defined(versionv1612plus)\n Temperature.mSource() -= mSource_\n * ( deltaHEvap_.value() \n - Temperature.m() * (cpFromField_ - cpToField_)\n );\n#else\n Temperature.mSource().internalField() -= mSource_.internalField()\n * ( deltaHEvap_.value() \n - Temperature.m().internalField() * (cpFromField_ - cpToField_)\n );\n#endif\n\n\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\nvoid phaseChangeModel::initialzeSummation(word typeName, word logFileName) const\n{\n if (Pstream::master())\n {\n fileName file_ =logFileName;\n fileName probeDir;\n fileName probeSubDir = typeName;\n\n Info << \"Integral quantity for model \" << typeName << \" will write to file \" << file_ << endl;\n\n if (particleCloud_.mesh().name() != polyMesh::defaultRegion)\n {\n probeSubDir = probeSubDir/particleCloud_.mesh().name();\n }\n probeSubDir = \"postProcessing\"/probeSubDir/particleCloud_.mesh().time().timeName();\n\n if (Pstream::parRun())\n {\n // Put in undecomposed case\n // (Note: gives problems for distributed data running)\n probeDir = particleCloud_.mesh().time().path()/\"..\"/probeSubDir;\n }\n else\n {\n probeDir = particleCloud_.mesh().time().path()/probeSubDir;\n }\n\n\n // Create directory if does not exist.\n mkDir(probeDir);\n\n sPtr_ = new OFstream(probeDir+\"/\"+file_);\n\n *sPtr_ << '#' \n << \"Time\" << \" \" \n << \"sourceValue\" << endl;\n }\n}\n\n//*******************************************************************\nvoid phaseChangeModel::computeIntegral(volScalarField& explicitEulerSource) const\n{\n volScalarField expEulerSrc=explicitEulerSource;\n particleCloud_.scaleWithVcell(expEulerSrc);\n scalar integralValue = gSum(expEulerSrc);\n\n if (Pstream::master() )\n {\n *sPtr_ << setprecision(IOstream::defaultPrecision()) ;\n *sPtr_ << particleCloud_.mesh().time().value() \n << \" \" //setw(IOstream::defaultPrecision() + 6)\n << integralValue\n << endl;\n }\n}\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/eulerian/scalarTransportModelsCFDEM/phaseChangeModel/phaseChangeModel.H", "content": "/*---------------------------------------------------------------------------*\\\nLicense\n\n This is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This code is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with this code. If not, see .\n\n Copyright (C) 2015 - Stefan Radl, TU Graz, Austria\n\nApplication / Class\n phaseChangeModel\n \nDescription\n Base class for phase change modeling (e.g., evaporation)\n TODO: currently handles only evaporation!\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef phaseChangeModel_H\n#define phaseChangeModel_H\n\n#include \"cfdemCloud.H\"\n#include \"forceModel.H\"\n#ifndef versionExt32\n#include \"fvOptionList.H\"\n#endif\n#include \"eulerianScalarField.H\"\n#include \"generalManual.H\"\n#include \"OFstream.H\"\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class phaseChangeModel Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass phaseChangeModel\n{\n\nprotected:\n\n // Protected data\n const dictionary& dict_;\n\n cfdemCloud& particleCloud_;\n\n const word modelName_; \n\n mutable volScalarField mSaturation_; // saturation concentration field\n\n mutable volScalarField mSource_; // volumetric source of transported quantity (for the leaving phase)\n \n int speciesIDFrom_; // id of leaving phase\n\n int speciesIDTo_; // id of receiving phase\n\n scalarList parameterVap_; // parameters for vapor pressure\n\n scalar Rvap_; // Gas constant of vapor (in J/kg/K)\n\n scalar alphaImExSplit_; // 0...1 (indicate split into implicit and explicit part)\n\n // Key Evaporation properties\n mutable scalar cpFromField_;\n mutable scalar cpToField_;\n dimensionedScalar deltaHEvap_; //units: K; deltaHEvap = deltaH_v / cp_g\n dimensionedScalar tEvap_; //units: s; tEvap_ = d_d^2 / (6*Sh*D_Vapor)\n\n //Reporting\n mutable int verboseDiskIntervall_;\n\n mutable int verboseDiskCounter_;\n\n mutable OFstream* sPtr_; \n\n\n inline bool verboseToDisk() const\n { \n if(verboseDiskIntervall_<=0) return false;\n\n verboseDiskCounter_++;\n if(verboseDiskCounter_>=verboseDiskIntervall_)\n {\n verboseDiskCounter_=0;\n return true; \n }\n else\n return false;\n };\n\n //Private/protected member functions\n inline double pVapor(double T) const\n { //T in K, p in Pa, from http://ddbonline.ddbst.de/AntoineCalculation/AntoineCalculationCGI.exe?component=Water\n const double A = parameterVap_[0];\n const double B = parameterVap_[1];\n const double C = parameterVap_[2];\n const double Tmin = parameterVap_[3];\n const double Tmax = parameterVap_[4];\n \n double result = 0;\n if( T>Tmin )\n result = 133.322368 * pow(10.0, A - B / ( C + min(Tmax,T) ) );\n return result;\n }\n\npublic:\n\n //- Runtime type information\n TypeName(\"phaseChangeModel\");\n\n // Declare runtime constructor selection table\n\n declareRunTimeSelectionTable\n (\n autoPtr,\n phaseChangeModel,\n dictionary,\n (\n const dictionary& dict,\n cfdemCloud& sm,\n word modelType,\n int modelID\n ),\n (dict,sm,modelType,modelID)\n );\n\n\n // Constructors\n\n //- Construct from components\n phaseChangeModel\n (\n const dictionary& dict,\n cfdemCloud& sm,\n word modelType,\n int modelID\n );\n\n\n // Destructor\n\n virtual ~phaseChangeModel();\n\n\n // Selector\n\n static autoPtr New\n (\n const dictionary& dict,\n cfdemCloud& sm,\n word modelType,\n int modelID\n );\n\n\n // Member Functions\n int fromID() const {return speciesIDFrom_;};\n int toID() const {return speciesIDTo_;};\n\n void update(const volScalarField&, const volScalarField&, const eulerianScalarField&, const eulerianScalarField&) const ;\n\n void setEnthalpySource(const eulerianScalarField&) const;\n\n void bound(autoPtr*) const {};\n void initialzeSummation(word typeName, word logFileName) const;\n void computeIntegral (volScalarField& explicitEulerSource) const;\n\n // Access\n inline volScalarField& mSource() const {return mSource_;}; //returns the source\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/eulerian/scalarTransportModelsCFDEM/scalarTransportModel/newScalarTransportModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"scalarTransportModel.H\"\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\nautoPtr scalarTransportModel::New\n(\n const dictionary& dict, //Not used at the moment\n cfdemCloud& sm\n)\n{\n IOdictionary tempDict\n (\n IOobject\n (\n \"scalarTransportProperties\",\n sm.mesh().time().constant(),\n sm.mesh(),\n IOobject::MUST_READ,\n IOobject::NO_WRITE\n )\n );\n\n word scalarTransportModelType\n (\n tempDict.lookup(\"scalarTransportModel\")\n );\n\n Info<< \"Selecting scalarTransportModel \"\n\t\t << scalarTransportModelType << endl;\n\n dictionaryConstructorTable::iterator cstrIter =\n dictionaryConstructorTablePtr_->find(scalarTransportModelType);\n\n if (cstrIter == dictionaryConstructorTablePtr_->end())\n {\n FatalError\n << \"scalarTransportModel::New(const dictionary&, const spray&) : \"\n << endl\n << \" unknown scalarTransportModelType type \"\n << scalarTransportModelType\n << \", constructor not in hash table\" << endl << endl\n << \" Valid scalarTransportModel types are :\"\n << endl;\n Info<< dictionaryConstructorTablePtr_->toc()\n << abort(FatalError);\n }\n\n autoPtr h(cstrIter()(tempDict,sm));\n\n sm.registryM().addProperty(\"scalarTransportModel_\"+h().type()+\"_index\", 0);\n\n return h;\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/eulerian/scalarTransportModelsCFDEM/scalarTransportModel/scalarTransportModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"scalarTransportModel.H\"\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(scalarTransportModel, 0);\n\ndefineRunTimeSelectionTable(scalarTransportModel, dictionary);\n\n// * * * * * * * * * * * * * public Member Functions * * * * * * * * * * * * //\nvoid scalarTransportModel::createFields()\n{}\n\nvoid scalarTransportModel::update()\n{}\n\nconst volScalarField& scalarTransportModel::sourceField()\n{\n // dummy source field\n tmp tsource\n (\n volScalarField\n (\n IOobject\n (\n \"tsource\",\n particleCloud_.mesh().time().timeName(),\n particleCloud_.mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n particleCloud_.mesh(),\n dimensionedScalar\n (\n \"zero\",\n dimensionSet(0,0,0,0,0),\n 0\n )\n )\n );\n return tsource();\n}\n\n// * * * * * * * * * * * * * private Member Functions * * * * * * * * * * * * //\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from Components\nscalarTransportModel::scalarTransportModel\n(\n const dictionary& dict, //not used at the moment\n cfdemCloud& sm\n)\n:\n particleCloud_(sm),\n mesh_(sm.mesh()),\n scalarTransportProperties_\n (\n IOobject\n (\n \"scalarTransportProperties\",\n mesh_.time().constant(),\n mesh_,\n IOobject::MUST_READ,\n IOobject::NO_WRITE\n )\n ),\n verbose_(false),\n ignore_(false)\n{\n createFields();\n}\n\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nscalarTransportModel::~scalarTransportModel()\n{}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/eulerian/scalarTransportModelsCFDEM/scalarTransportModel/scalarTransportModel.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n transport model for scalar properties\n\nClass\n Foam::scalarTransportModel\n\nSourceFiles\n scalarTransportModel.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef scalarTransportModel_H\n#define scalarTransportModel_H\n\n\n#include \"fvCFD.H\"\n#include \"cfdemCloud.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class scalarTransportModel Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass scalarTransportModel\n{\nprotected:\n\n // Protected data\n cfdemCloud& particleCloud_;\n\n const fvMesh& mesh_;\n\n const IOdictionary scalarTransportProperties_;\n\n bool verbose_; //switch for debug output to screen\n\n bool ignore_; //ignore updating the model, i.e., deactivate\n\npublic:\n\n //- Runtime type information\n TypeName(\"scalarTransportModel\");\n\n // Declare runtime constructor selection table\n\n declareRunTimeSelectionTable\n (\n autoPtr,\n scalarTransportModel,\n dictionary,\n (\n const dictionary& dict,\n cfdemCloud& sm\n ),\n (dict,sm)\n );\n\n\n // Constructors\n\n //- Construct from components\n scalarTransportModel\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n\n // Destructor\n \tvirtual ~scalarTransportModel();\n\n // Selector\n\n static autoPtr New\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n\n\t// Member Functions\n\n virtual void createFields();\n\n virtual void update();\n\n virtual const volScalarField& sourceField();\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/eulerian/scalarTransportModelsCFDEM/temperatureModel/temperatureModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"temperatureModel.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(temperatureModel, 0);\n\naddToRunTimeSelectionTable\n(\n\tscalarTransportModel,\n\ttemperatureModel,\n\tdictionary\n);\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n// Construct from components\ntemperatureModel::temperatureModel\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n scalarTransportModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n PrT_(0.7)\n{\n propsDict_.readIfPresent(\"PrT\", PrT_);\n\n Info << \"Using PrT \" << PrT_ << endl;\n\n temperatureField_ = eulerianScalarField::New\n (\n propsDict_,\n sm,\n \"T\",\n 0\n );\n}\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\ntemperatureModel::~temperatureModel()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\nvoid temperatureModel::createFields()\n{}\n\n// ************************************************************\nvoid temperatureModel::update()\n{\n\n //==============================\n // get references\n const surfaceScalarField& phi(particleCloud_.mesh().lookupObject (\"phi\"));\n const volScalarField& voidfraction(particleCloud_.mesh().lookupObject (\"voidfraction\"));\n //==============================\n temperatureField_->update(phi, voidfraction, particleCloud_.turbulence_.nuEff(), PrT_);\n\n}\n\n// ************************************************************\nconst volScalarField& temperatureModel::sourceField()\n{\n return temperatureField_->mSource();\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/eulerian/scalarTransportModelsCFDEM/temperatureModel/temperatureModel.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n transport model for scalar properties\n\nClass\n temperatureModel\n\nSourceFiles\n temperatureModel.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef temperatureModel_H\n#define temperatureModel_H\n\n#include \"scalarTransportModel.H\"\n#include \"forceModel.H\"\n#include \"eulerianScalarField.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class temperatureModel Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass temperatureModel\n:\n public scalarTransportModel\n{\n\n dictionary propsDict_;\n\n autoPtr temperatureField_;\n\n scalar PrT_; // - Turbulent Prandtl number (optional, default = 0.7)\n\npublic:\n\n //- Runtime type information\n TypeName(\"temperatureModel\");\n\n\n // Constructors\n\n //- Construct from components\n temperatureModel\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n \t~temperatureModel();\n\n\n // Member Functions\n\n void createFields();\n\n void update();\n\n const volScalarField& sourceField();\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/Make/files", "content": "path = ../cfdemParticle\ncfdemCloud = $(path)/cfdemCloud\nderived = $(path)/derived\ncfdTools = $(path)/cfdTools\nforceModels = $(path)/subModels/forceModel\nforceSubModels = $(path)/subModels/forceModel/forceSubModels\nforceModelsMS = $(path)/subModels/forceModelMS\nIOModels = $(path)/subModels/IOModel\nvoidFractionModels = $(path)/subModels/voidFractionModel\nlocateModels = $(path)/subModels/locateModel\nmeshMotionModels = $(path)/subModels/meshMotionModel\nmomCoupleModels = $(path)/subModels/momCoupleModel\ndataExchangeModels = $(path)/subModels/dataExchangeModel\naveragingModels = $(path)/subModels/averagingModel\nclockModels = $(path)/subModels/clockModel\nliggghtsCommandModels = $(path)/subModels/liggghtsCommandModel\nsmoothingModels = $(path)/subModels/smoothingModel\nprobeModels = $(path)/subModels/probeModel\nregistryModels = $(path)/subModels/registryModel\nabsorptionEmissionModels = $(path)/subModels/absorptionEmissionModels\n\n\n$(cfdemCloud)/cfdemCloud.C\n$(derived)/cfdemCloudIB/cfdemCloudIB.C\n\n$(cfdTools)/global.C\n$(cfdTools)/IOtools/json/json.C\n$(cfdTools)/newGlobal.C\n\n$(averagingModels)/averagingModel/averagingModel.C\n$(averagingModels)/averagingModel/newAveragingModel.C\n$(averagingModels)/dense/dense.C\n$(averagingModels)/dilute/dilute.C\n\n$(clockModels)/clockModel/clockModel.C\n$(clockModels)/clockModel/newClockModel.C\n$(clockModels)/noClock/noClock.C\n$(clockModels)/standardClock/standardClock.C\n\n$(dataExchangeModels)/dataExchangeModel/dataExchangeModel.C\n$(dataExchangeModels)/dataExchangeModel/newDataExchangeModel.C\n$(dataExchangeModels)/noDataExchange/noDataExchange.C\n$(dataExchangeModels)/oneWayVTK/oneWayVTK.C\n$(dataExchangeModels)/twoWayFiles/twoWayFiles.C\n$(dataExchangeModels)/twoWayMPI/twoWayMPI.C\n\n$(forceModels)/Archimedes/Archimedes.C\n$(forceModels)/ArchimedesIB/ArchimedesIB.C\n$(forceModels)/checkCouplingInterval/checkCouplingInterval.C\n$(forceModels)/DiFeliceDrag/DiFeliceDrag.C\n$(forceModels)/fieldStore/fieldStore.C\n$(forceModels)/fieldTimeAverage/fieldTimeAverage.C\n$(forceModels)/forceModel/forceModel.C\n$(forceModels)/forceModel/newForceModel.C\n$(forceModels)/GidaspowDrag/GidaspowDrag.C\n$(forceModels)/gradPForce/gradPForce.C\n$(forceModels)/KochHillDrag/KochHillDrag.C\n$(forceModels)/LaEuScalarTemp/LaEuScalarTemp.C\n$(forceModels)/MeiLift/MeiLift.C\n$(forceModels)/noDrag/noDrag.C\n$(forceModels)/particleCellVolume/particleCellVolume.C\n$(forceModels)/particleVolume/particleVolume.C\n$(forceModels)/scalarGeneralExchange/scalarGeneralExchange.C\n$(forceModels)/SchillerNaumannDrag/SchillerNaumannDrag.C\n$(forceModels)/ShirgaonkarIB/ShirgaonkarIB.C\n$(forceModels)/virtualMassForce/virtualMassForce.C\n$(forceModels)/viscForce/viscForce.C\n$(forceModels)/volWeightedAverage/volWeightedAverage.C\n\n$(forceSubModels)/forceSubModel/forceSubModel.C\n$(forceSubModels)/forceSubModel/newForceSubModel.C\n$(forceSubModels)/ImEx/ImEx.C\n\n$(IOModels)/basicIO/basicIO.C\n$(IOModels)/IOModel/IOModel.C\n$(IOModels)/IOModel/newIOModel.C\n$(IOModels)/noIO/noIO.C\n$(IOModels)/sophIO/sophIO.C\n$(IOModels)/trackIO/trackIO.C\n\n$(liggghtsCommandModels)/execute/execute.C\n$(liggghtsCommandModels)/liggghtsCommandModel/liggghtsCommandModel.C\n$(liggghtsCommandModels)/liggghtsCommandModel/newLiggghtsCommandModel.C\n$(liggghtsCommandModels)/readLiggghtsData/readLiggghtsData.C\n$(liggghtsCommandModels)/runLiggghts/runLiggghts.C\n$(liggghtsCommandModels)/setDEMGravity/setDEMGravity.C\n$(liggghtsCommandModels)/writeLiggghts/writeLiggghts.C\n\n$(locateModels)/engineSearch/engineSearch.C\n$(locateModels)/engineSearchIB/engineSearchIB.C\n$(locateModels)/locateModel/locateModel.C\n$(locateModels)/locateModel/newLocateModel.C\n$(locateModels)/standardSearch/standardSearch.C\n\n$(meshMotionModels)/meshMotionModel/meshMotionModel.C\n$(meshMotionModels)/meshMotionModel/newMeshMotionModel.C\n$(meshMotionModels)/noMeshMotion/noMeshMotion.C\n\n$(momCoupleModels)/explicitCouple/explicitCouple.C\n$(momCoupleModels)/implicitCouple/implicitCouple.C\n$(momCoupleModels)/momCoupleModel/momCoupleModel.C\n$(momCoupleModels)/momCoupleModel/newMomCoupleModel.C\n$(momCoupleModels)/noCouple/noCouple.C\n\n$(probeModels)/noProbe/noProbe.C\n$(probeModels)/particleProbe/particleProbe.C\n$(probeModels)/probeModel/newProbeModel.C\n$(probeModels)/probeModel/probeModel.C\n\n$(registryModels)/defaultRegistry/defaultRegistry.C\n$(registryModels)/registryModel/newRegistryModel.C\n$(registryModels)/registryModel/registryModel.C\n\n$(smoothingModels)/constDiffSmoothing/constDiffSmoothing.C\n$(smoothingModels)/noSmoothing/noSmoothing.C\n$(smoothingModels)/smoothingModel/newSmoothingModel.C\n$(smoothingModels)/smoothingModel/smoothingModel.C\n\n$(voidFractionModels)/bigParticleVoidFraction/bigParticleVoidFraction.C\n$(voidFractionModels)/centreVoidFraction/centreVoidFraction.C\n$(voidFractionModels)/dividedVoidFraction/dividedVoidFraction.C\n$(voidFractionModels)/GaussVoidFraction/GaussVoidFraction.C\n$(voidFractionModels)/IBVoidFraction/IBVoidFraction.C\n$(voidFractionModels)/noVoidFraction/noVoidFraction.C\n$(voidFractionModels)/trilinearVoidFraction/trilinearVoidFraction.C\n$(voidFractionModels)/voidFractionModel/newVoidFractionModel.C\n$(voidFractionModels)/voidFractionModel/voidFractionModel.C\n\nLIB = $(CFDEM_LIB_DIR)/lib$(CFDEM_LIB_NAME)\n" }, { "path": "src/lagrangian/cfdemParticle/Make/options", "content": "sinclude $(GENERAL_RULES)/mplib$(WM_MPLIB)\nsinclude $(RULES)/mplib$(WM_MPLIB)\n\n$(shell if [ ! -e \"$(CFDEM_LIB_DIR)\" ]; then mkdir -p \"$(CFDEM_LIB_DIR)\"; fi)\n$(shell ln -sf $(CFDEM_LIGGGHTS_LIB_PATH)/lib$(CFDEM_LIGGGHTS_LIB_NAME).so $(CFDEM_LIB_DIR)/)\n\nGIT_VERSION := $(shell git describe --dirty --always --tags)\nPFLAGS+= -DGITVERSION=\\\"$(GIT_VERSION)\\\"\nPFLAGS+= -DDEBUGFLAG=\\\"$(WM_COMPILE_OPTION)\\\"\nPFLAGS+= -DCFDEMWMPROJECTVERSION=\"$(CFDEM_WM_PROJECT_VERSION)\"\n\ninclude $(CFDEM_ADD_LIBS_DIR)/$(CFDEM_ADD_LIBS_NAME)\n\nEXE_INC = \\\n $(PFLAGS) \\\n $(PINC) \\\n -I ./cfdemParticle \\\n -I$(LIB_SRC)/finiteVolume/lnInclude \\\n -I$(LIB_SRC)/thermophysicalModels/radiation/lnInclude \\\n -I$(LIB_SRC)/transportModels \\\n $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \\\n -I$(LIB_SRC)/meshTools/lnInclude \\\n -I$(LIB_SRC)/triSurface/lnInclude \\\n -I$(LIB_SRC)/lagrangian/basic/lnInclude \\\n -I$(LIB_SRC)/OpenFOAM/containers/HashTables/labelHashSet \\\n -I$(CFDEM_LIGGGHTS_SRC_DIR) \\\n -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/cfdTools \\\n\nLIB_LIBS = \\\n $(PLIBS) \\\n -L$(CFDEM_LIB_DIR) \\\n -lfiniteVolume \\\n -lradiationModels \\\n $(CFDEM_ADD_INCOMPTURBMOD_LIBS) \\\n -lmeshTools \\\n -llagrangian \\\n -Wl,--whole-archive -l$(CFDEM_LIGGGHTS_LIB_NAME) -Wl,--no-whole-archive \\\n $(CFDEM_ADD_LIB_PATHS) \\\n $(CFDEM_ADD_STATICLIBS) \n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/IOtools/json/json.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code implements a simple JSON file writer\n \nContributing Authors\n\n copyright: Federico Municchi, TU Graz, 2015\n Stefan Radl, TU Graz, 2015\n\n\n\\*---------------------------------------------------------------------------*/\n\n#include \"json.H\"\n#include \"error.H\"\n#include \"IOmanip.H\"\n#include \n#include \n#include \n\nusing namespace Foam;\n\njsonObject::jsonObject()\n:\nlastObject(false)\n{\n};\n\njsonObject::~jsonObject()\n{\n};\n/*-----------------Auxiliary Functions------------------------------------------*/\nvoid indentation(int ind, OFstream* file)\n{\n \n for(int i=0;isetIndent(indent+2);\n data->setPtr(sPtr);\n \n};\n\n/*-------------------------------------------------------------------------------*/\nvoid jsonObject::addjVector(std::string elemName, std::vector* data) const\n{\n //Register data name\n jVectorNames_.push_back(elemName);\n \n //Register data\n jVectors_.push_back(data);\n \n};\n\n/*-------------------------------------------------------------------------------*/\nvoid jsonObject::addjScalar(std::string elemName, double* data) const\n{\n //Register data name\n jScalarNames_.push_back(elemName);\n \n //Register data\n jScalars_.push_back(data);\n \n};\n\n/*-------------------------------------------------------------------------------*/\nvoid jsonObject::addjString(std::string elemName, std::string* data) const\n{\n //Register data name\n jStringNames_.push_back(elemName);\n \n //Register data\n jStrings_.push_back(data);\n \n};\n\n/*-------------------------------------------------------------------------------*/\nvoid jsonObject::addjBool(std::string elemName, bool* data) const\n{\n //Register data name\n jBoolNames_.push_back(elemName);\n \n //Register data\n jBools_.push_back(data);\n \n};\n\n/*-----------------Write Functions-----------------------------------------------*/\nvoid jsonObject::write() const\n{\n \n //start writing\n indentation(indent-2,sPtr);\n *sPtr<<\"{\" << endl;\n \n bool comma=false;\n \n //Write Objects\n for(unsigned int i=0;iwrite();\n \n }\n \n \n if(jObjects_.size()!=0)\n comma=true;\n \n //Write vectors\n for(unsigned int i=0;isize();s++)\n {\n if(s!=0)\n *sPtr<<\",\"<lookupObject(rootName);\n\n objList_[id]->addjObject(objName,ob);\n }\n objList_.push_back(ob);\n jObjectNames_.push_back(objName);\n}\n\n/*-----------------------------------------------------------------------------*/\nvoid jsonFile::addjVector(std::vector* data , std::string dataname, std::string rootName) const\n{\n if(rootName==\"mainObject\")\n {\n mainObject.addjVector(dataname,data);\n }\n else\n {\n int id=this->lookupObject(rootName);\n\n objList_[id]->addjVector(dataname, data);\n }\n}\n\n/*-----------------------------------------------------------------------------*/\nvoid jsonFile::addjScalar(double* data , std::string dataname, std::string rootName) const\n{\n if(rootName==\"mainObject\")\n {\n mainObject.addjScalar(dataname,data);\n }\n else\n {\n int id=this->lookupObject(rootName);\n\n objList_[id]->addjScalar(dataname, data);\n }\n}\n\n/*-----------------------------------------------------------------------------*/\nvoid jsonFile::addjString(std::string* data , std::string dataname, std::string rootName) const\n{\n if(rootName==\"mainObject\")\n {\n mainObject.addjString(dataname,data);\n }\n else\n {\n int id=this->lookupObject(rootName);\n\n objList_[id]->addjString(dataname, data);\n }\n}\n\n/*-----------------------------------------------------------------------------*/\nvoid jsonFile::addjBool(bool* data , std::string dataname, std::string rootName) const\n{\n if(rootName==\"mainObject\")\n {\n mainObject.addjBool(dataname,data);\n }\n else\n {\n int id=this->lookupObject(rootName);\n\n objList_[id]->addjBool(dataname, data);\n } \n}\n\n/*-----------------------------------------------------------------------------*/\nvoid jsonFile::write()\n{\n //remove old file\n int myProcID(Pstream::myProcNo());\n if(myProcID==0)\n {\n char buf[128];\n sprintf(buf,\"rm %s\",fileName_.c_str());\n system(buf);\n }\n\n setFileName(fileName_);\n mainObject.write();\n}\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/IOtools/json/json.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code implements a simple JSON file writer\n \nContributing Authors\n\n copyright: Federico Municchi, TU Graz, 2015\n Stefan Radl, TU Graz, 2015\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef OF_JSON_H\n#define OF_JSON_H\n\n#include \n#include \n#include \n#include \"OFstream.H\"\n#include \"Pstream.H\"\n\n\nnamespace Foam\n{\n\n class jsonObject\n {\n friend class jsonFile;\n private: \n \n mutable OFstream* sPtr;\n mutable int indent;\n mutable bool lastObject;\n mutable std::vector jObjects_;\n mutable std::vector jObjectNames_;\n \n mutable std::vector*> jVectors_;\n mutable std::vector jVectorNames_;\n \n mutable std::vector jScalars_;\n mutable std::vector jScalarNames_;\n \n mutable std::vector jStrings_;\n mutable std::vector jStringNames_;\n \n mutable std::vector jBools_;\n mutable std::vector jBoolNames_;\n \n \n jsonObject();\n ~jsonObject();\n \n void addjObject(std::string elemName, jsonObject* data) const;\n \n void addjVector(std::string elemName, std::vector* data) const;\n void addjScalar(std::string elemName, double* data) const;\n void addjString(std::string elemName, std::string* data) const;\n void addjBool(std::string elemName, bool* data) const;\n \n void setIndent(int ind) const {indent=ind;};\n void setPtr(OFstream* ptr) const {sPtr=ptr;};\n \n \n void write() const;\n \n void lastObj() const {lastObject=true;};\n \n public:\n \n \n };\n \n class jsonFile\n {\n \n \n private:\n \n mutable std::string dirName_;\n mutable std::string fileName_;\n jsonObject mainObject;\n mutable OFstream* sPtr;\n \n mutable std::vector objList_;\n mutable std::vector jObjectNames_; \n \n int lookupObject(std::string name) const;\n public:\n \n jsonFile(std::string, std::string);\n ~jsonFile();\n \n void setFileName(std::string newname) const;\n \n \n jsonObject* getMainObject() {return &mainObject;};\n \n void write();\n \n void newObject(std::string objName, std::string rootName=\"mainObject\") const;\n \n void addjVector( std::vector* data , std::string dataname, std::string objName=\"mainObject\") const;\n void addjScalar( double* data, std::string dataname, std::string objName=\"mainObject\") const;\n void addjString(std::string* data, std::string dataname, std::string objName=\"mainObject\") const;\n void addjBool(bool* data, std::string dataname, std::string objName=\"mainObject\") const;\n \n \n };\n\n\n\n}\n\n/*--------USAGE EXAMPLE---------------------------\n\n jsonFile file(\"newDir\",\"test.json\");\n \n std::string teststring1(\"Is the\");\n std::string teststring2(\"output working?\");\n \n bool ans=true;\n \n double scal=9.9999;\n \n std::vector vec2_;\n \n for(int i=0;i<7;i++)\n vec2_.push_back(i);\n \n file.addjScalar(&scal,\"smaller than 10\");\n \n file.newObject(\"test_object\");\n \n file.addjVector(&vec2_,\"nested_vector\",\"test_object\");\n \n file.newObject(\"nested_object\",\"test_object\");\n \n file.addjString(&teststring1,\"teststring1\",\"nested_object\");\n file.addjString(&teststring2,\"teststring2\",\"nested_object\");\n file.addjBool(&ans,\"answer\",\"nested_object\");\n \n \n file.write();\n \n-------THIS CODE WILL PRODUCE A JSON FILE-----------\n{\n\n\n \"test_object\":\n {\n\n\n \"nested_object\":\n {\n\n\n \"teststring1\": \"Is the\",\n\n \"teststring2\": \"output working?\",\n\n \"answer\": 1\n\n },\n\n \"nested_vector\": [\n 0,\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ]\n\n },\n\n \"smaller than 10\": 9.9999\n\n}\n \n\n\n\n*/\n#endif\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/checkImCoupleM.H", "content": "// check if NO explicitCouple model is declared - otherwise error!\n// include this file before the cloud class is created\n\n{\n // read dict\n IOdictionary dict(\n IOobject\n (\n \"couplingProperties\",\n mesh.time().constant(),\n mesh,\n IOobject::MUST_READ,\n IOobject::NO_WRITE\n )\n );\n\n // read dict\n wordList a(dict.lookup(\"momCoupleModels\"));\n\n // look for explicit and throw error if found\n for(int i=0; i.\n\nGlobal\n continuityErrs\n\nDescription\n Calculates and prints the continuity errors.\n The code is an evolution of compressibleContinuityErrs.H in OpenFOAM(R) 2.3.x,\n where additional functionality for CFD-DEM coupling is added.\n\\*---------------------------------------------------------------------------*/\n\n{\n dimensionedScalar totalMass = fvc::domainIntegrate(rho*voidfraction);\n\n scalar sumLocalContErr =\n (fvc::domainIntegrate(mag(rho - thermo.rho())*voidfraction)/totalMass).value();\n\n scalar globalContErr =\n (fvc::domainIntegrate((rho - thermo.rho())*voidfraction)/totalMass).value();\n\n cumulativeContErr += globalContErr;\n\n Info<< \"time step continuity errors : sum local = \" << sumLocalContErr\n << \", global = \" << globalContErr\n << \", cumulative = \" << cumulativeContErr\n << endl;\n}\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/constructCFDEMcloud.H", "content": "#if defined(MS)\n #if defined(superquadrics_flag)\n cfdemCloudRotationSuperquadric particleCloud(mesh);\n #else\n cfdemCloudMS particleCloud(mesh);\n #endif\n#else\n cfdemCloud particleCloud(mesh);\n#endif\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/continuityErrorPhiPU.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright (C) 1991-2009 OpenCFD Ltd.\n Copyright (C) 2009-2012 JKU, Linz\n Copyright (C) 2012- DCS Computing GmbH,Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling. If not, see .\n\nGlobal\n continuityErrs\n\nDescription\n Calculates and prints the continuity errors.\n The code is an evolution of continuityErrs.H in OpenFOAM(R) 2.1.x,\n where additional functionality for CFD-DEM coupling is added.\n\\*---------------------------------------------------------------------------*/\n\n{\n volScalarField contErr( fvc::div(phi) + particleCloud.ddtVoidfraction() );\n\n scalar sumLocalContErr = runTime.deltaTValue()*\n mag(contErr)().weightedAverage(mesh.V()).value();\n\n scalar globalContErr = runTime.deltaTValue()*\n contErr.weightedAverage(mesh.V()).value();\n cumulativeContErr += globalContErr;\n\n Info<< \"time step continuity errors : sum local = \" << sumLocalContErr\n << \", global = \" << globalContErr\n << \", cumulative = \" << cumulativeContErr\n << endl;\n}\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/continuityErrorPhiVoidfraction.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright (C) 1991-2009 OpenCFD Ltd.\n Copyright (C) 2012- DCS Computing GmbH,Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software: you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling. If not, see .\n\nGlobal\n continuityErrs\n\nDescription\n Calculates and prints the continuity errors.\n The code is an evolution of continuityErrs.H in OpenFOAM(R) 2.1.x,\n where additional functionality for CFD-DEM coupling is added.\n\\*---------------------------------------------------------------------------*/\n\n{\n volScalarField contErr( fvc::div(phi*voidfractionf) + particleCloud.ddtVoidfraction() );\n\n scalar sumLocalContErr = runTime.deltaTValue()*\n mag(contErr)().weightedAverage(mesh.V()).value();\n\n scalar globalContErr = runTime.deltaTValue()*\n contErr.weightedAverage(mesh.V()).value();\n cumulativeContErr += globalContErr;\n\n Info<< \"time step continuity errors : sum local = \" << sumLocalContErr\n << \", global = \" << globalContErr\n << \", cumulative = \" << cumulativeContErr\n << endl;\n}\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/couplingForceError.H", "content": "//Compute error due to implicit part of the \n//coupling force acting on particle cloud (using fluid velocity AFTER solving NS)\n#if defined(version40)\n fError.ref() -= U.ref() * dimensionedScalar(\"1\", dimensionSet(1, -3, -1, 0, 0), 1.0);\n fError.ref() *= Ksl.oldTime().ref() * dimensionedScalar(\"1\", dimensionSet(-1, 3, 1, 0, 0), 1.0); \n#else\n fError.internalField() -= U.internalField();\n fError.internalField() *= Ksl.oldTime().internalField(); \n#endif\n\n//Remove the old error of coupling force from last fluid time step\n//to f to conserve the overall momentum\n//Minus here, because -f in UEqn\nif(particleCloud.expCorrDeltaUError())\n f += fError;\n\n//Integrate error\nvector fErrorSum(0.0,0.0,0.0);\n#if defined(version40)\n fErrorSum = sum(mesh.V()*fError.primitiveField());\n#else\n fErrorSum = sum(mesh.V()*fError.internalField());\n#endif\nreduce(fErrorSum, sumOp());\n\nInfo << \"TotalError(dU): \" << fErrorSum;\nif(particleCloud.verbose()) // in verbose mode we have data for fImpTotal and fExpTotal to normalize fErrorSum\n{\n Info << \" = \" \n << mag(fErrorSum) / (mag(fImpTotal.value()+fExpTotal.value())+SMALL)*100.0 << \"% of TotalForceImp\";\n}\n\nif(particleCloud.expCorrDeltaUError())\n Info << \" (corrected) \" << endl;\nelse\n Info << \" (uncorrected) \" << endl;\n\n//Save U BEFORE solving NS for computing error later\n#if defined(version40)\n fError.ref() = U.ref() * dimensionedScalar(\"1\", dimensionSet(1, -3, -1, 0, 0), 1.0);\n#else\n fError.internalField() = U.internalField();\n#endif\n\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/createCFDEMFields.H", "content": " Info<< \"\\nReading momentum exchange field Ksl\\n\" << endl;\n volScalarField Ksl\n (\n IOobject\n (\n \"Ksl\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh\n //dimensionedScalar(\"0\", dimensionSet(1, -3, -1, 0, 0), 1.0)\n );\n\n Info<< \"\\nReading voidfraction field voidfraction = (Vgas/Vparticle)\\n\" << endl;\n volScalarField voidfraction\n (\n IOobject\n (\n \"voidfraction\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh\n );\n\n Info<< \"Reading particle velocity field Us\\n\" << endl;\n volVectorField Us\n (\n IOobject\n (\n \"Us\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh\n );\n\n Info<< \"\\nCreating density field rho\\n\" << endl;\n volScalarField rho\n (\n IOobject\n (\n \"rho\",\n runTime.timeName(),\n mesh,\n IOobject::MUST_READ,\n IOobject::AUTO_WRITE\n ),\n mesh//,\n //dimensionedScalar(\"0\", dimensionSet(1, -3, 0, 0, 0), 1.0)\n );\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/createFieldsAddOn.H", "content": " Info<< \"\\nConstructing explicit momentum exchange field f.\\n\" << endl;\n volVectorField f\n (\n IOobject\n (\n \"f\",\n runTime.timeName(),\n mesh,\n IOobject::NO_READ, // zeroGradient here + zeroGradient in p can cause troubles --> force calculated by not reading the field \n IOobject::AUTO_WRITE\n ),\n mesh,\n dimensionedVector(\"0\", dimensionSet(1, -2, -2, 0, 0), vector::zero)\n );\n f.storePrevIter();\n\n Info<< \"Constructing coupling force error field fError.\\n\" << endl;\n volVectorField fError\n (\n IOobject\n (\n \"fError\",\n runTime.timeName(),\n mesh,\n IOobject::NO_READ,\n IOobject::AUTO_WRITE\n ),\n mesh,\n dimensionedVector(\"0\", dimensionSet(1, -2, -2, 0, 0), vector::zero)\n );\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/debugInfo.H", "content": "\n //========================================================================//\n scalar countCell=0; // number of cells touched by particles\n int points=0; // number of particles and sub-points\n scalar totalParticleWeights=0; // total weight of all particles and sub-points\n vector totalForce_array(0,0,0); // total force on particles based on particle array\n vector totalForce_field(0,0,0); // forceField of forceM(), used to calc Ksl\n scalar particleVolume_radius=0; // total particle voulme based on radius array\n scalar particleVolume_field=0; // total particle voulme based on voidfractionfield\n scalar particleVolume_array=0; // total particle voulme based on particle array\n scalar meanR_array=0; // mean particle radius based on particle array\n vector meanUs_array(0,0,0); // mean solid velocity based on particle array\n vector meanUs_field(0,0,0); // mean solid velocity based on field Us\n scalar meanAlpha_field=0; // mean voidfraction\n vector meanU_field(0,0,0); // mean fluid velocity based on field U\n scalar fpth=4./3.*M_PI;// 4.*pi/3.\n //========================================================================//\n\n // get particle based data\n for(int index = 0;index < numberOfParticles(); ++index)\n {\n for(int i=0;i<3;i++){\n totalForce_array[i] += impForces_[index][i]; // in giveDEMdata() exp imp and DEM are summed\n meanUs_array[i] += fieldsToDEM[idVel()][index][i];\n }\n meanR_array += fieldsToDEM[idRadius()][index][0];\n particleVolume_radius += fieldsToDEM[idRadius()][index][0]*fieldsToDEM[idRadius()][index][0]*fieldsToDEM[idRadius()][index][0]*fpth;\n \n // loop subCells\n for(int subCell=0;subCell0)\n {\n meanAlpha_field /= countCell;\n meanU_field /= countCell; \n meanUs_field /= countCell;\n }\n else\n {\n meanAlpha_field = 0;\n meanU_field = vector(0,0,0); \n meanUs_field = vector(0,0,0);\n }\n meanUs_array /= numberOfParticles()+SMALL; \n meanR_array /= numberOfParticles()+SMALL; \n\n Info <<\"=============================================================================\" << endl;\n Info << \"Debug Info, only serial and not tested!\" << endl;\n Info <<\" numberOfParticles_ = \"<< numberOfParticles() << \" != \" << endl;\n Info <<\"totalParticleWeights = \"<< totalParticleWeights << endl;\n Info <<\" points= \"<< points << endl;\n Info <<\"countCell= \"<< countCell << endl;\n Info <<\" totalForce_array = \"<< mag(totalForce_array)<< \" != \" << endl;\n Info <<\" totalForce_field = \"<< mag(totalForce_field) << endl;\n Info <<\" particleVolume_field = \"<< particleVolume_field << \" != \" << endl;\n Info <<\" particleVolume_array = \"<< particleVolume_array << \" != \" << endl;\n Info <<\" particleVolume_radius = \"<< particleVolume_radius << endl;\n Info <<\"meanUs_field = \"<< mag(meanUs_field) << \" ~= \" << endl;\n Info <<\"meanUs_array = \"<< mag(meanUs_array) << endl;\n Info <<\"meanU_field = \"<< mag(meanU_field) << endl;\n Info <<\"meanAlpha_field = \"<< meanAlpha_field << endl;\n Info <<\"meanR_array = \"<< meanR_array << endl;\n Info <<\"=============================================================================\" << endl;\n Info << endl;\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/declareCFDEMcloud.H", "content": "#if defined(MS)\n #if defined(superquadrics_flag)\n #include \"cfdemCloudRotationSuperquadric.H\"\n #else\n #include \"cfdemCloudMS.H\"\n #endif\n#else\n #include \"cfdemCloud.H\"\n#endif\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/fixedFluxPressureHandling.H", "content": "#ifdef version50\n if (modelType==\"A\")\n {\n volScalarField rUsed = rUA*voidfraction;\n constrainPressure(p, U, phi, rUsed);\n }\n else constrainPressure(p, U, phi, rUA);\n#endif\n#ifndef versionExt32\n#ifndef version40\n if (modelType==\"A\")\n {\n setSnGrad\n (\n #ifdef versionv1612plus\n p.boundaryFieldRef(),\n #else\n p.boundaryField(),\n #endif\n (\n phi.boundaryField()\n - (mesh.Sf().boundaryField() & U.boundaryField())\n )/(mesh.magSf().boundaryField()*rUAf.boundaryField()*voidfractionf.boundaryField())\n );\n }else\n {\n setSnGrad\n (\n #ifdef versionv1612plus\n p.boundaryFieldRef(),\n #else\n p.boundaryField(),\n #endif\n (\n phi.boundaryField()\n - (mesh.Sf().boundaryField() & U.boundaryField())\n )/(mesh.magSf().boundaryField()*rUAf.boundaryField())\n );\n }\n#endif\n#endif\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/forceCheckEx.H", "content": "// NOTE:\n// this file is typically included at a position of the solver so that\n// it reports the momentum exchange based on f of the current time step\n\ndimensionedVector fExpTotal;\n\nif(particleCloud.verbose())\n{\n //calc. total source - this NOT a relevant explicit force!\n dimensionedVector fExpSource = -1 * particleCloud.momCoupleM(particleCloud.registryM().getProperty(\"explicitCouple_index\")).returnIntegralSourceField(); //negative because we want the force on the fluid\n reduce(fExpSource, sumOp()); //must reduce, since sum in function is not the global sum!\n\n //calc. total explicit force\n fExpTotal = -gSum( \n mesh.V()\n #if defined(version40)\n * f.primitiveField()\n #else\n * f.internalField()\n #endif\n //\n ); //negative because we want the force on the fluid\n\n fExpTotal.value() -= fExpSource.value(); //Subtract the explicit source, since this is NOT a coupling force!!\n\n Info << \" TotalSourceExp [N]: \" << fExpSource.value() << endl;\n Info << \" TotalForceExp [N]: \" << fExpTotal.value() << endl;\n Info << \" These values are based on latest f and fExpSource.\\n\" << endl;\n}\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/forceCheckIm.H", "content": "// NOTE:\n// this file is typically included at a position of the solver so that\n// it reports the momentum exchange based on Ksl and Us of the current time step\n// but U is the solution of the previous time step!!!\n\ndimensionedVector fImpTotal;\n\nif(particleCloud.verbose())\n{\n Info << \"\\nSolver level total Eulerian momentum exchange:\"<< endl;\n\n //calc. total implicit force\n volVectorField fImp(Ksl*(Us-U));\n particleCloud.scaleWithVcell(fImp);\n fImpTotal = gSum(fImp);\n Info << \" TotalForceImp [N]: \" << fImpTotal.value() << endl;\n Info << \" Warning, these values are based on latest Ksl and Us but prev. iteration U!\\n\" << endl;\n}\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/forceCheckImEx.H", "content": "//Force Checks - calc. total explicit and implicit force\n#include \"forceCheckIm.H\"\n#include \"forceCheckEx.H\"\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/global.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n#include \"global.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(global, 0);\n\ndefineRunTimeSelectionTable(global, dictionary);\n\n// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\nvoid global::info()\n{\n Info << \"\\nYou are currently using:\" << endl;\n Info << \"OF version: \" << FOAMversion << endl;\n Info << \"OF build: \" << FOAMbuild << endl;\n Info << \"CFDEM build: \" << CFDEMversion << \"\\n\" << endl;\n}\n\nbool global::debugMode()\n{\n if(word(DEBUG)!=word(\"Opt\"))\n {\n return true;\n }else\n {\n return false;\n }\n}\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nglobal::global\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n dict_(dict),\n particleCloud_(sm),\n CFDEMversion(GITVERSION),\n DEBUG(DEBUGFLAG)\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nglobal::~global()\n{}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/global.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n global\n\nSourceFiles\n global.Cver\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef global_H\n#define global_H\n\n#include \"fvCFD.H\"\n#include \"cfdemCloud.H\"\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class global Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass global\n{\n\nprotected:\n\n // Protected data\n const dictionary& dict_;\n\n cfdemCloud& particleCloud_;\n\n const char* const CFDEMversion;\n\n const char* const DEBUG;\n\n\n // Protected member functions\n\npublic:\n\n //- Runtime type information\n TypeName(\"global\");\n\n // Declare runtime constructor selection table\n\n declareRunTimeSelectionTable\n (\n autoPtr,\n global,\n dictionary,\n (\n const dictionary& dict,\n cfdemCloud& sm\n ),\n (dict,sm)\n );\n\n\n // Constructors\n\n //- Construct from components\n global\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n\n // Destructor\n\n virtual ~global();\n\n\n // Selector\n\n static autoPtr New\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Member Function\n\n void info();\n\n // Access\n\n bool debugMode();\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/mathExtra.H", "content": "/* ----------------------------------------------------------------------\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n \n Copyright of this contribution:\n Copyright 2014- TU Graz, IPPT\n------------------------------------------------------------------------- */\n\n#ifndef CFDEM_MATH_EXTRA_H\n#define CFDEM_MATH_EXTRA_H\n\n#include \"error.h\"\n\n#include \n//#include \n#include \n#include \n\n#define TOLERANCE_ORTHO 1e-10\n\nnamespace MathExtra \n{\n\n// inline void outerProduct(double *vec1, double *vec2, double **m);\n// inline double spheroidGeometry(int index, double bi, double ai);\n\n\n\n//--------------------------------------------------------------------\n// Outer Product of two vectors\ninline void outerProduct(double *vec1, double *vec2, double **m)\n{\n int i, j;\n //debug output\n// for( i = 0; i < 3; ++i )\n// printf(\"OUTER PRODUCT: Input: vec1 element %d = %g\", i, vec1[i]);\n// for( i = 0; i < 3; ++i )\n// printf(\"OUTER PRODUCT: Input: vec2 element %d=%g\", i, vec2[i]);\n \n //calculation\n for( i = 0; i < 3; ++i )\n for( j = 0; j < 3; ++j )\n {\n m[i][j] = vec1[i] * vec2[j];\n printf(\"OUTER PRODUCT: Result: m[%d][%d]=%g\", i, j, m[i][j]);\n }\n \n \n}\n\n//--------------------------------------------------------------------\n// Compute the diameter of the hydrodynamically equivalent cylinder\ninline double spheroidDiameter(\n double shapeX, double shapeY, double shapeZ,\n double& aspectRatio\n )\n{\n //INPUT\n // shape ...values with the half-axes of the spheroid\n \n //OUTPUT\n // aspectRatio ...the aspect ratio of the spheroid (ai/bi)\n // is also that of the cylinder element\n // return value... the hydrodynamically equivalent diameter \n\n double bi = std::min( shapeX, std::min(shapeY,shapeZ) );\n aspectRatio = std::max( shapeX, std::max(shapeY,shapeZ) ) \n / std::max(bi,1e-32);\n aspectRatio = std::max(1.000001,aspectRatio);\n\n return 2.48 * bi / std::sqrt( std::log(aspectRatio) );\n\n}\n\n//--------------------------------------------------------------------\n// Compute the major, minor axis and eccentricity parameters of a prolate spheroid\ninline bool spheroidGeometry(double aspectRatio, //input\n double& ei, double& Le //outputs\n ) //\n{\n //INPUT\n // aspectRatio ...major/minor aspect ratio\n \n //OUTPUT\n // ei ... \n // Le ... \n\n \tei = std::sqrt( \n 1.0\n - 1.0 / (aspectRatio*aspectRatio)\n \t );\n \tLe = std::log(\n \t\t (1.0+ei)\n \t\t /(1.0-ei)\n );\n\n\treturn true; \t\t \n}\n\n//--------------------------------------------------------------------\n// Compute the major, minor axis and eccentricity parameters of a prolate spheroid\ninline double Pi()\n{\n return 3.1415926535897932384626433832795;\n}\n\n\n//--------------------------------------------------------------------\n// Compute the eccentricity parameters of a prolate spheroid\ninline bool spheroidGeometry2( double aspectRatio, //inputs\n double& XAe, double& YAe, //outputs\n double& XCe, double& YCe, //outputs\n double& YHe //outputs\n ) //\n{\n //INPUT\n // aspectRatio ...major/minor aspect ratio of the spheroid\n \n //OUTPUT\n // XAe ...Eccentricity dependet parameter\n // YAe ...Eccentricity dependet parameter\n // XCe ...Eccentricity dependet parameter\n // XCe ...Eccentricity dependet parameter\n // YCe ...Eccentricity dependet parameter\n // YHe ...Eccentricity dependet parameter\n \n\n double ei(0.0), Le(0.0); \n bool result = \n spheroidGeometry(aspectRatio, //inputs\n ei, Le //outputs\n );\n if(!result)\n return false;\n \n XAe= 2.6666666666666666666666667\n *ei*ei*ei\n /(-2.0*ei+(1.0+ei*ei)*Le); \n YAe= 5.333333333333333333333333333\n *ei*ei*ei\n /(2.0*ei+(3*ei*ei-1.0)*Le);\n XCe= 1.333333333333333333333333333\n *ei*ei*ei\n *(1.0-ei*ei)\n /(2.0*ei-(1.0-ei*ei)*Le);\n YCe= 1.3333333333333333333333\n *ei*ei*ei\n *(2.0-ei*ei)\n /(-2.0*ei+(1.0+ei*ei)*Le);\n YHe= 1.3333333333333333333333\n *ei*ei*ei*ei*ei\n /(-2.0*ei+(1.0+ei*ei)*Le);\n\n\treturn true; \t\t \n\n}\n\n//--------------------------------------------------------------------\n// zeroize a 3x3x3 tensor\ninline void zeroize333(double tensor[3][3][3] )\n{\n for(int iX=0; iX<3; iX++)\n for(int iY=0; iY<3; iY++)\n for(int iZ=0; iZ<3; iZ++)\n tensor[iX][iY][iZ] = 0.0;\n}\n\n//--------------------------------------------------------------------\n// zeroize a 3x3 tensor\ninline void zeroize33(double tensor[3][3] )\n{\n for(int iX=0; iX<3; iX++)\n for(int iY=0; iY<3; iY++)\n tensor[iX][iY] = 0.0;\n}\n\n//--------------------------------------------------------------------\n// multiply a 3x3x3 tensor with a scalar\ninline void multiply333(double scalar, double tensor[3][3][3] )\n{\n for(int iX=0; iX<3; iX++)\n for(int iY=0; iY<3; iY++)\n for(int iZ=0; iZ<3; iZ++)\n tensor[iX][iY][iZ] *= scalar;\n}\n//--------------------------------------------------------------------\n// Compute a dot and dyadic product of with a vector\ninline void permutationTensor(double tensor[3][3][3] )\n{\n zeroize333(tensor);\n tensor[0][1][2] = 1.0; \n tensor[1][2][0] = 1.0; \n tensor[2][0][1] = 1.0; \n tensor[0][2][1] =-1.0; \n tensor[2][1][0] =-1.0; \n tensor[1][0][2] =-1.0; \n}\n\n\n\n//--------------------------------------------------------------------\n// Compute a dot product of the permutation tensor and \n// then a dyadic product of with a vector\ninline bool permutationDotDyadic( \n double vector[3], \n double tensor[3][3][3] \n )\n{\n //Generate permutation tensor\n double permutationT[3][3][3];\n permutationTensor(permutationT);\n \n //Step 1: compute dot prodcut of permutation tensor\n double permutationDotProd[3][3];\n zeroize33(permutationDotProd);\n\n for(int iX=0; iX<3; iX++)\n for(int iY=0; iY<3; iY++)\n for(int iZ=0; iZ<3; iZ++)\n permutationDotProd[iX][iY] += permutationT[iX][iY][iZ]\n * vector[iZ];\n\n for(int iX=0; iX<3; iX++)\n for(int iY=0; iY<3; iY++)\n for(int iZ=0; iZ<3; iZ++)\n tensor[iX][iY][iZ] = permutationDotProd[iX][iY]\n * vector[iZ]; \n return true;\n\n}\n\n//--------------------------------------------------------------------\n// Compute a dot and dyadic product of with a vector\ninline bool doubleDotTensor333Tensor33(double tensor333[3][3][3], \n double tensor33[3][3],\n double result[3]\n )\n{\n result[0]=0.0;result[1]=0.0;result[2]=0.0;\n \n for(int iX=0; iX<3; iX++)\n for(int iY=0; iY<3; iY++)\n for(int iZ=0; iZ<3; iZ++)\n result[iX] += tensor333[iX][iY][iZ] * tensor33[iY][iZ];\n\n return true;\n}\n\n}; //end of namespace\n\n#endif\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/newGlobal.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"global.H\"\n#include \"dilute.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\nautoPtr global::New\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n{\n word globalType\n (\n dict.lookup(\"global\")\n );\n\n Info<< \"Selecting global \"\n << globalType << endl;\n\n\n dictionaryConstructorTable::iterator cstrIter =\n dictionaryConstructorTablePtr_->find(globalType);\n\n if (cstrIter == dictionaryConstructorTablePtr_->end())\n {\n FatalError\n << \"global::New(const dictionary&, const spray&) : \"\n << endl\n << \" unknown globalType type \"\n << globalType\n << \", constructor not in hash table\" << endl << endl\n << \" Valid global types are :\"\n << endl;\n Info<< dictionaryConstructorTablePtr_->toc()\n << abort(FatalError);\n }\n\n return autoPtr(cstrIter()(dict,sm));\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/readPISOControls_OF30.H", "content": "\n//create PISO object\npisoControl piso(mesh);\n\n//create lables\nlabel nCorr = piso.nCorrPISO();\nlabel nNonOrthCorr = piso.nNonOrthCorr();\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetAlphaInterpolator.H", "content": "alphaInterpolator_.clear();\nalphaInterpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"alphaInterpolationType\",word(\"cellPoint\")),alpha_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetDDtUInterpolator.H", "content": "DDtUInterpolator_.clear();\nDDtUInterpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"DDtUInterpolationType\",word(\"cellPointFace\")),DDtU_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetDSauterInterpolator.H", "content": "dSauterInterpolator_.clear();\ndSauterInterpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"dSauterInterpolationType\",word(\"cellPoint\")),dSauter_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetDivTauInterpolator.H", "content": "divTauInterpolator_.clear();\ndivTauInterpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"divTauInterpolationType\",word(\"cellPointFace\")),divTau_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetFluidScalarFieldInterpolator.H", "content": "fluidScalarFieldInterpolator_.clear();\nfluidScalarFieldInterpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"fluidScalarFieldInterpolationType\",word(\"cellPoint\")),fluidScalarField_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetGInterpolator.H", "content": "GInterpolator_.clear();\nGInterpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"GInterpolationType\",word(\"cellPoint\")),G_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetGradAlphaInterpolator.H", "content": "gradAlphaInterpolator_.clear();\ngradAlphaInterpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"gradAlphaInterpolationType\",word(\"cellPointFace\")),gradAlpha_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetGradPInterpolator.H", "content": "gradPInterpolator_.clear();\ngradPInterpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"gradPInterpolationType\",word(\"cellPointFace\")),gradP_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetGradPsolidInterpolator.H", "content": "gradPsolidInterpolator_.clear();\ngradPsolidInterpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"gradPsolidInterpolationType\",word(\"cellPoint\")),gradPsolid_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetGradUInterpolator.H", "content": "gradUInterpolator_.clear();\ngradUInterpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"gradUInterpolationType\",word(\"cellPointFace\")),gradU_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetGradVoidfractionInterpolator.H", "content": "gradVoidfractionInterpolator_.clear();\ngradVoidfractionInterpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"gradVoidfractionInterpolationType\",word(\"cellPointFace\")),gradVoidfraction_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetPhiP1Interpolator.H", "content": "phiP1Interpolator_.clear();\nphiP1Interpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"phiP1InterpolationType\",word(\"cellPoint\")),phiP1_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetPhiP2Interpolator.H", "content": "phiP2Interpolator_.clear();\nphiP2Interpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"phiP2InterpolationType\",word(\"cellPoint\")),phiP2_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetRhoInterpolator.H", "content": "RhoInterpolator_.clear();\nRhoInterpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"RhoInterpolationType\",word(\"cellPoint\")),rho_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetShearRateInterpolator.H", "content": "shearRateInterpolator_.clear();\nshearRateInterpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"shearRateInterpolationType\",word(\"cellPointFace\")),shearRate_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetTInterpolator.H", "content": "TInterpolator_.clear();\nTInterpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"TInterpolationType\",word(\"cellPoint\")),T_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetUInterpolator.H", "content": "UInterpolator_.clear();\nUInterpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"UInterpolationType\",word(\"cellPointFace\")),U_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetUp1Interpolator.H", "content": "Up1Interpolator_.clear();\nUp1Interpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"Up1InterpolationType\",word(\"cellPointFace\")),Up1_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetUp2Interpolator.H", "content": "Up2Interpolator_.clear();\nUp2Interpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"Up2InterpolationType\",word(\"cellPointFace\")),Up2_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetUsInterpolator.H", "content": "UsInterpolator_.clear();\nUsInterpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"UsInterpolationType\",word(\"cellPointFace\")),Us_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetVoidfractionInterpolator.H", "content": "voidfractionInterpolator_.clear();\nvoidfractionInterpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"voidfractionInterpolationType\",word(\"cellPoint\")),voidfraction_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/resetInterpolators/resetVorticityInterpolator.H", "content": "vorticityInterpolator_.clear();\nvorticityInterpolator_.reset(interpolation::New(propsDict_.lookupOrDefault(\"vorticityInterpolationType\",word(\"cellPointFace\")),vorticity_).ptr());\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/sanityChecks/level0_Cloud.H", "content": "//======================================================================//\n//Check if user attempts to change fluid time step\nif( mesh_.time().controlDict().lookupOrDefault(\"adjustTimeStep\", false) && !allowAdjustTimeStep_ )\n{\n FatalError << \"cfdemCloud:: you want to adjustTimeStep in controlDict. This is not allowed in this version of CFDEM.\"\n << abort(FatalError);\n}\n\n//======================================================================//\n//Check if mesh is empty (decomposition error)\nif(mesh_.cells().size() < 1)\n{\n int nprocs;\n MPI_Comm_size(MPI_COMM_WORLD,&nprocs);\n if(nprocs > 2) FatalError << endl << \"cfdemCloud:: local mesh has zero cells. Please check the mesh and the decomposition!\" << abort(FatalError);\n\n Pout << \"WARNING: cfdemCloud:: local mesh has zero cells. Please check the mesh and the decomposition!\" << endl;\n}\n\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/sanityChecks/level0_Solver.H", "content": "//============================================================//\n// check model type\n// referring to: Zhou et al. 2010,JFM\nword modelType = particleCloud.modelType();\n\n//Warning << \"model type not being checked\" << endl;\nif (modelType==\"Bfull\"){\n Info << \"solving volume averaged Navier Stokes equations of type Bfull\\n\"<< endl;\n\n // check if gradPForce is used\n bool found=false;\n forAll(particleCloud.forceModels(),i)\n {\n if(particleCloud.forceModels()[i]==\"gradPForce\")\n found=true;\n }\n if(!found)\n FatalError <<\"gradPForce model not found! Consider selecting gradPForce model or switching to model type B.\\n\" << abort(FatalError);\n\n // check if viscForce is used\n found=false;\n forAll(particleCloud.forceModels(),i)\n {\n if(particleCloud.forceModels()[i]==\"viscForce\")\n found=true;\n }\n if(!found)\n FatalError <<\"viscForce model not found! Consider selecting viscForce model or switching to model type B.\\n\" << abort(FatalError);\n\n}else if(modelType==\"B\"){\n Info << \"solving volume averaged Navier Stokes equations of type B\\n\"<< endl;\n\n // check if gradP and viscForce are used\n bool found=false;\n forAll(particleCloud.forceModels(),i)\n {\n if(particleCloud.forceModels()[i]==\"gradPForce\" || particleCloud.forceModels()[i]==\"viscForce\")\n found=true;\n }\n if(found)\n FatalError <<\"do not use gradPForce and viscForce with model type B!\\n\" << abort(FatalError);\n\n}else if (modelType==\"A\"){\n Info << \"solving volume averaged Navier Stokes equations of type A\"<< endl;\n\n // check if gradP is used\n bool found=false;\n forAll(particleCloud.forceModels(),i)\n {\n if(particleCloud.forceModels()[i]==\"gradPForce\")\n found=true;\n }\n if(!found)\n FatalError <<\"gradPForce model not found! Consider selecting gradPForce model or switching to model type B.\\n\" << abort(FatalError);\n\n // check if viscForce is used\n found=false;\n forAll(particleCloud.forceModels(),i)\n {\n if(particleCloud.forceModels()[i]==\"viscForce\")\n found=true;\n }\n if(!found)\n {\n FatalError <<\"viscForce model not found! Consider selecting viscForce model or switching to model type B.\\n\" << abort(FatalError);\n }\n}else if (modelType==\"none\")\n{\n Warning << \"You chose model type -none- you might get erroneous results!\" << endl;\n}\nelse\n{\n FatalError <<\"no suitable model type specified:\" << modelType << \"\\n\" << abort(FatalError);\n}\n//============================================================//\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/setupProbeModel.H", "content": " //set probeModel parameters for this force model\n //CANNOT be used for scalarGeneralExchange force model, since this force model handles multiple species\n if(probeIt_)\n particleCloud_.probeM().setOutputFile(typeName+\".logDat\");\n\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/setupProbeModelfields.H", "content": "Field vValues;\nvValues.clear();\nField sValues;\nsValues.clear();\n" }, { "path": "src/lagrangian/cfdemParticle/cfdTools/versionInfo.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef versionInfo_H\n#define versionInfo_H\n\nword CFDEMversion=\"cfdem-3.8.1\";\nword compatibleLIGGGHTSversion=\"3.8.0\";\nword OFversion=\"6-commit-af7d7f427be78e9b9beb6aceca8fe7d5d4636876\";\n\nInfo << \"\\nCFDEMcoupling version: \" << CFDEMversion << endl;\nInfo << \", compatible to LIGGGHTS version: \" << compatibleLIGGGHTSversion << endl;\nInfo << \", compatible to OF version and build: \" << OFversion << endl;\n\n#endif\n" }, { "path": "src/lagrangian/cfdemParticle/cfdemCloud/cfdemCloud.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"fileName.H\"\n#include \"cfdemCloud.H\"\n#include \"global.H\"\n#include \"forceModel.H\"\n#include \"locateModel.H\"\n#include \"momCoupleModel.H\"\n#include \"meshMotionModel.H\"\n#include \"voidFractionModel.H\"\n#include \"dataExchangeModel.H\"\n#include \"IOModel.H\"\n#include \"probeModel.H\"\n#include \"registryModel.H\"\n#include \"averagingModel.H\"\n#include \"clockModel.H\"\n#include \"smoothingModel.H\"\n#include \"liggghtsCommandModel.H\"\n#include \"cyclicPolyPatch.H\"\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\nFoam::cfdemCloud::cfdemCloud\n(\n const fvMesh& mesh\n)\n:\n mesh_(mesh),\n couplingProperties_\n (\n IOobject\n (\n \"couplingProperties\",\n mesh_.time().constant(),\n mesh_,\n IOobject::MUST_READ,\n IOobject::NO_WRITE\n )\n ),\n liggghtsCommandDict_\n (\n IOobject\n (\n \"liggghtsCommands\",\n mesh_.time().constant(),\n mesh_,\n IOobject::MUST_READ,\n IOobject::NO_WRITE\n )\n ),\n cgParticleSpecific_(false),\n cgTypeSpecificDifferent_(false),\n allowAdjustTimeStep_(couplingProperties_.lookupOrDefault(\"allowAdjustTimeStep\", false)),\n solveFlow_(true),\n solveScalarTransport_(true),\n verbose_(couplingProperties_.lookupOrDefault(\"verbose\", false)),\n expCorrDeltaUError_(false),\n debug_(false),\n allowCFDsubTimestep_(true),\n ignore_(false),\n writeTimePassed_(false),\n resetWriteTimePassed_(false),\n modelType_(couplingProperties_.lookup(\"modelType\")),\n impForces_(NULL),\n expForces_(NULL),\n voidfractions_(NULL),\n cellIDs_(NULL),\n particleWeights_(NULL),\n particleVolumes_(NULL),\n particleV_(NULL),\n dragPrev_(NULL),\n numberOfParticles_(-1),\n d32_(-1),\n numberOfParticlesChanged_(false),\n arraysReallocated_(false),\n forceModels_(couplingProperties_.lookup(\"forceModels\")),\n momCoupleModels_(couplingProperties_.lookup(\"momCoupleModels\")),\n liggghtsCommandModelList_(liggghtsCommandDict_.lookup(\"liggghtsCommandModels\")),\n turbulenceModelType_(couplingProperties_.lookup(\"turbulenceModelType\")),\n isLES_(false),\n cg_(1.),\n cgOK_(true),\n impDEMdrag_(false),\n impDEMdragAcc_(false),\n imExSplitFactor_(1.0),\n treatVoidCellsAsExplicitForce_(false),\n useDDTvoidfraction_(\"off\"),\n ddtVoidfraction_\n (\n IOobject\n (\n \"ddtVoidfraction\",\n mesh.time().timeName(),\n mesh,\n IOobject::NO_READ,\n IOobject::AUTO_WRITE\n ),\n mesh,\n dimensionedScalar(\"zero\", dimensionSet(0,0,-1,0,0), 0) // 1/s\n ),\n checkPeriodicCells_(couplingProperties_.lookupOrDefault(\"checkPeriodicCells\",false)),\n wall_periodicityCheckRange_(vector(1,1,1)),\n wall_periodicityCheckTolerance_(1e-07),\n meshHasUpdated_(false),\n turbulence_\n (\n #if defined(version24Dev)\n mesh.lookupObject\n #elif defined(version21) || defined(version16ext)\n #ifdef compre\n mesh.lookupObject\n #else\n mesh.lookupObject\n #endif\n #elif defined(version15)\n mesh.lookupObject\n #endif\n (\n turbulenceModelType_\n )\n ),\n turbulenceMultiphase_\n (\n IOobject\n (\n \"turbulenceMultiphase\",\n mesh.time().timeName(),\n mesh,\n IOobject::NO_READ,\n IOobject::AUTO_WRITE\n ),\n mesh,\n#ifdef compre\n dimensionedScalar(\"zero\", dimensionSet(1,-1,-1,0,0), 0) // kg/m/s\n#else\n dimensionedScalar(\"zero\", dimensionSet(0,2,-1,0,0), 0) // m²/s\n#endif\n ),\n locateModel_\n (\n locateModel::New\n (\n couplingProperties_,\n *this\n )\n ),\n /*momCoupleModel_\n (\n momCoupleModel::New\n (\n couplingProperties_,\n *this\n )\n ),*/\n dataExchangeModel_\n (\n dataExchangeModel::New\n (\n couplingProperties_,\n *this\n )\n ),\n IOModel_\n (\n IOModel::New\n (\n couplingProperties_,\n *this\n )\n ),\n probeModel_\n (\n probeModel::New\n (\n couplingProperties_,\n *this,\n const_cast(\"none\"),\n const_cast(\"none\")\n )\n ),\n registryModel_\n (\n registryModel::New\n (\n couplingProperties_,\n *this\n )\n ),\n voidFractionModel_\n (\n voidFractionModel::New\n (\n couplingProperties_,\n *this\n )\n ),\n averagingModel_\n (\n averagingModel::New\n (\n couplingProperties_,\n *this\n )\n ),\n clockModel_\n (\n clockModel::New\n (\n couplingProperties_,\n *this\n )\n ),\n smoothingModel_\n (\n smoothingModel::New\n (\n couplingProperties_,\n *this\n )\n ),\n meshMotionModel_\n (\n meshMotionModel::New\n (\n couplingProperties_,\n *this\n )\n ),\n idRadius_(-1),\n idPos_(-1),\n idVel_(-1),\n idFacc_(-1),\n idPartTypes_(-1),\n idDragExp_(-1),\n idKsl_(-1),\n idKslExtra_(-1),\n idUf_(-1),\n idTorqueExp_(-1),\n idKslRotation_(-1),\n idPullRotation_(-1),\n idPullOrientation_(-1),\n idPullOrientation1_(-1),\n idPullShape_(-1),\n idDragExpCM_(-1),\n idKslCM_(-1),\n idKslExtraCM_(-1),\n idUfCM_(-1),\n idTorqueExpCM_(-1),\n idKslRotationCM_(-1),\n idFhydro_(-1),\n idVisc_(-1),\n idBlockiness_(-1),\n idArea_(-1),\n idVol_(-1),\n idQuat_(-1),\n idK_(-1),\n idEpsilon_(-1),\n idParticleCG_(-1),\n idMass_(-1),\n idDensity_(-1),\n idType_(-1),\n idConvectiveHeatFlux_(-1),\n idTemp_(-1)\n{\n #include \"versionInfo.H\"\n global buildInfo(couplingProperties_,*this);\n buildInfo.info();\n\n //-- apply debug Mode to sub models\n\n // set debug flag according to env\n debug_ = buildInfo.debugMode();\n\n // overwrite debug flag if found in dict\n if (couplingProperties_.found(\"debug\"))\n debug_=Switch(couplingProperties_.lookup(\"debug\"));\n\n // apply flag\n if(!debugMode()) ddtVoidfraction_.writeOpt() = IOobject::NO_WRITE;\n if(!debugMode()) turbulenceMultiphase_.writeOpt() = IOobject::NO_WRITE;\n voidFractionM().applyDebugSettings(debugMode());\n averagingM().applyDebugSettings(debugMode());\n //--\n\n //push dummy to type-specific cg factor since types start with 1\n cgTypeSpecific_.push_back(-1);\n cgTypeSpecificDifferent_ = false;\n dataExchangeM().setCG();\n\n Info << \"If BC are important, please provide volScalarFields -imp/expParticleForces-\" << endl;\n if (couplingProperties_.found(\"solveFlow\"))\n solveFlow_=Switch(couplingProperties_.lookup(\"solveFlow\"));\n if (couplingProperties_.found(\"solveScalarTransport\"))\n solveScalarTransport_=Switch(couplingProperties_.lookup(\"solveScalarTransport\"));\n if (couplingProperties_.found(\"imExSplitFactor\"))\n imExSplitFactor_ = readScalar(couplingProperties_.lookup(\"imExSplitFactor\"));\n\n if(imExSplitFactor_>1.0)\n FatalError << \"You have set imExSplitFactor > 1 in your couplingProperties. Must be <=1.\"\n << abort(FatalError);\n if(imExSplitFactor_<0.0)\n FatalError << \"You have set imExSplitFactor < 0 in your couplingProperties. Must be >=0\"\n << abort(FatalError);\n\n if (couplingProperties_.found(\"ignore\")) ignore_=true;\n if (turbulenceModelType_==\"LESProperties\")\n {\n isLES_ = true;\n Info << \"WARNING - LES functionality not yet tested!\" << endl;\n }\n\n if (couplingProperties_.found(\"useDDTvoidfraction\"))\n {\n useDDTvoidfraction_=word(couplingProperties_.lookup(\"useDDTvoidfraction\"));\n\n if(useDDTvoidfraction_==word(\"a\") ||\n useDDTvoidfraction_==word(\"b\") ||\n useDDTvoidfraction_==word(\"off\")\n )\n Info << \"choice for ddt(voidfraction) = \" << useDDTvoidfraction_ << endl;\n else\n FatalError << \"Model \" << useDDTvoidfraction_\n << \" is not a valid choice for ddt(voidfraction). Choose a or b or off.\"\n << abort(FatalError);\n }\n else\n Info << \"ignoring ddt(voidfraction)\" << endl;\n\n momCoupleModel_ = new autoPtr[momCoupleModels_.size()];\n for (int i=0;i[nrForceModels()];\n for (int i=0;i[liggghtsCommandModelList_.size()];\n for (int i=0;i::iterator\n it = fieldsToDEM.begin();\n it != fieldsToDEM.end();\n ++it)\n {\n Info << \"cfdemCloud destroys UserCFDEM data: \" << namesfieldsToDEM[iUser++] << endl;\n int id = std::distance(fieldsToDEM.begin(), it);\n if(typesfieldsToDEM[id]==\"scalar-atom\" || typesfieldsToDEM[id]==\"scalar-multisphere\")\n dataExchangeM().destroy((*it),1);\n else if(typesfieldsToDEM[id]==\"vector-atom\" || typesfieldsToDEM[id]==\"vector-multisphere\")\n dataExchangeM().destroy((*it),3);\n else if(typesfieldsToDEM[id]==\"vector2D-atom\" || typesfieldsToDEM[id]==\"vector2D-multisphere\")\n dataExchangeM().destroy((*it),2);\n else if(typesfieldsToDEM[id]==\"quaternion-atom\" || typesfieldsToDEM[id]==\"quaternion-multisphere\")\n dataExchangeM().destroy((*it),4);\n else\n FatalError << \"cfdemCloud::~cfdemCloud(): unknown data type \"<< typesfieldsToDEM[id] << \" to destroy.\" << abort(FatalError);\n }\n //=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=\n}\n// * * * * * * * * * * * * * * * private Member Functions * * * * * * * * * * * * * //\nvoid Foam::cfdemCloud::getDEMdata()\n{\n if(verbose_) Info << \"Foam::cfdemCloud::getDEMdata()\" << endl;\n for(std::vector::iterator it = namesfieldsToDEM.begin(); it != namesfieldsToDEM.end(); ++it)\n {\n int id = std::distance(namesfieldsToDEM.begin(), it);\n if(pullfieldsToDEM[id])\n {\n Info << \"get field with name '\" << *it << \"' at position: \" << id << endl;\n if(namesfieldsToDEM[id]==\"shapetype\" || namesfieldsToDEM[id]==\"type\" || namesfieldsToDEM[id]==\"body\" || namesfieldsToDEM[id]==\"id\") //type is of type int and we do not yet have fieldsToDEM for int\n {\n int** h=NULL;\n dataExchangeM().allocateArray(h,0.,1);\n dataExchangeM().getData(namesfieldsToDEM[id],typesfieldsToDEM[id],h);\n for(int i=0;i::iterator it = namesfieldsToDEM.begin(); it != namesfieldsToDEM.end(); ++it)\n {\n int id = std::distance(namesfieldsToDEM.begin(), it);\n if(!pullfieldsToDEM[id])\n {\n Info << \"giveData field with name '\" << *it << \"' at position: \" << id << endl;\n dataExchangeM().giveData(namesfieldsToDEM[id],typesfieldsToDEM[id],fieldsToDEM[id]);\n }\n }\n if(verbose_) Info << \"giveDEMdata done.\" << endl;\n}\n\n// * * * * * * * * * * * * * * * protected Member Functions * * * * * * * * * * * * * //\n\nvoid Foam::cfdemCloud::setNumberOfParticles(int nP)\n{\n if(nP != numberOfParticles())\n {\n numberOfParticlesChanged_ = true;\n numberOfParticles_ = nP;\n }\n}\n\nvoid Foam::cfdemCloud::setNumberOfClumps(int nC)\n{\n //Info << \"Foam::cfdemCloud::setNumberOfClumps(int nC) ... do nothing\" << endl;\n}\n\nvoid Foam::cfdemCloud::setPositionsCM(label n,double* pos)\n{\n //Info << \"Foam::cfdemCloud::setPositionsCM(int nC) ... do nothing\" << endl;\n}\n\nvoid Foam::cfdemCloud::setCellIDsCM(label n,int* ID)\n{\n //Info << \"Foam::cfdemCloud::setCellIDsCM(int nC) ... do nothing\" << endl;\n}\n\nvoid Foam::cfdemCloud::findCells()\n{\n locateM().findCell(NULL,fieldsToDEM[idPos()],cellIDs_,numberOfParticles());\n}\n\nvoid Foam::cfdemCloud::setForces()\n{\n resetArray(impForces_,numberOfParticles(),3);\n resetArray(expForces_,numberOfParticles(),3);\n\n cfdemCloud::zeroizeFieldsToDEM();\n\n for (int i=0;i >* Foam::cfdemCloud::getVprobe()\n{\n return probeModel_->getVprobe();\n}\n\nstd::vector< std::vector >* Foam::cfdemCloud::getSprobe()\n{\n return probeModel_->getSprobe();\n}\n\n// * * * * * * * * * * * * * * * WRITE * * * * * * * * * * * * * //\n\n// * * * write cfdemCloud internal data * * * //\n\nbool Foam::cfdemCloud::evolve\n(\n volScalarField& alpha,\n volVectorField& Us,\n volVectorField& U\n)\n{\n numberOfParticlesChanged_ = false;\n arraysReallocated_=false;\n bool doCouple=false;\n\n if(!ignore())\n {\n if(!writeTimePassed_ && mesh_.time().outputTime()) writeTimePassed_=true;\n if (dataExchangeM().doCoupleNow())\n {\n Info << \"\\n Coupling...\" << endl;\n dataExchangeM().couple(0);\n doCouple=true;\n\n // reset vol Fields\n clockM().start(16,\"resetVolFields\");\n if(verbose_)\n {\n Info << \"couplingStep:\" << dataExchangeM().couplingStep()\n << \"\\n- resetVolFields()\" << endl;\n }\n averagingM().resetVectorAverage(averagingM().UsPrev(),averagingM().UsNext(),false);\n resetVoidFraction();\n averagingM().resetVectorAverage(forceM(0).impParticleForces(),forceM(0).impParticleForces(),true);\n averagingM().resetVectorAverage(forceM(0).expParticleForces(),forceM(0).expParticleForces(),true);\n averagingM().resetWeightFields();\n for (int i=0;i 1.001 || dataExchangeM().timeStepFraction() < -0.001 )\n {\n FatalError << \"cfdemCloud::dataExchangeM().timeStepFraction() = \"<< dataExchangeM().timeStepFraction() <<\" must be >1 or <0 : This might be due to the fact that you used a adjustable CFD time step. Please use a fixed CFD time step.\" << abort(FatalError);\n }\n clockM().start(24,\"interpolateEulerFields\");\n\n // update voidFractionField\n setAlpha(alpha);\n if(dataExchangeM().couplingStep() < 2)\n {\n alpha.oldTime() = alpha; // supress volume src\n alpha.oldTime().correctBoundaryConditions();\n }\n alpha.correctBoundaryConditions();\n\n // calc ddt(voidfraction)\n calcDdtVoidfraction(alpha,Us);\n\n // update mean particle velocity Field\n Us = averagingM().UsInterp();\n Us.correctBoundaryConditions();\n\n clockM().stop(\"interpolateEulerFields\");\n //============================================\n\n if(doCouple)\n {\n // set particles forces\n clockM().start(21,\"setForce\");\n if(verbose_) Info << \"- setForce(forces_)\" << endl;\n setForces();\n if(verbose_) Info << \"setForce done.\" << endl;\n calcMultiphaseTurbulence();\n if(verbose_) Info << \"calcMultiphaseTurbulence done.\" << endl;\n clockM().stop(\"setForce\");\n\n // get next force field\n clockM().start(22,\"setParticleForceField\");\n if(verbose_) Info << \"- setParticleForceField()\" << endl;\n setParticleForceField();\n if(verbose_) Info << \"- setParticleForceField done.\" << endl;\n clockM().stop(\"setParticleForceField\");\n\n // write DEM data\n if(verbose_) Info << \" -giveDEMdata()\" << endl;\n clockM().start(23,\"giveDEMdata\");\n giveDEMdata();\n clockM().stop(\"giveDEMdata\");\n\n dataExchangeM().couple(1);\n }//end dataExchangeM().couple()\n\n\n if(verbose_){\n #include \"debugInfo.H\"\n }\n\n clockM().start(25,\"dumpDEMdata\");\n // do particle IO\n IOM().dumpDEMdata();\n clockM().stop(\"dumpDEMdata\");\n\n if(resetWriteTimePassed_)\n {\n writeTimePassed_=false;\n resetWriteTimePassed_=false;\n }\n\n }//end ignore\n return doCouple;\n}\n\nbool Foam::cfdemCloud::reAllocArrays() const\n{\n if(verbose_) Info << \"cfdemCloud::reAllocArrays()\" << endl;\n if(numberOfParticlesChanged_ && !arraysReallocated_)\n {\n // get arrays of new length\n dataExchangeM().allocateArray(impForces_,0.,3);\n dataExchangeM().allocateArray(expForces_,0.,3);\n dataExchangeM().allocateArray(voidfractions_,1.,voidFractionM().maxCellsPerParticle());\n dataExchangeM().allocateArray(cellIDs_,-1.,voidFractionM().maxCellsPerParticle());\n dataExchangeM().allocateArray(particleWeights_,0.,voidFractionM().maxCellsPerParticle());\n dataExchangeM().allocateArray(particleVolumes_,0.,voidFractionM().maxCellsPerParticle());\n dataExchangeM().allocateArray(particleV_,0.,1);\n\n //=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=\n if(namesfieldsToDEM.size()!=fieldsToDEM.size())\n cfdemCloud::allocateFieldsToDEM();\n else\n cfdemCloud::reAllocateFieldsToDEM();\n //=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=\n\n arraysReallocated_ = true;\n return true;\n }\n return false;\n}\n\nbool Foam::cfdemCloud::reAllocArrays(int nP, bool forceRealloc) const\n{\n if( (numberOfParticlesChanged_ && !arraysReallocated_) || forceRealloc)\n {\n // get arrays of new length\n dataExchangeM().allocateArray(impForces_,0.,3,nP);\n dataExchangeM().allocateArray(expForces_,0.,3,nP);\n dataExchangeM().allocateArray(voidfractions_,1.,voidFractionM().maxCellsPerParticle(),nP);\n dataExchangeM().allocateArray(cellIDs_,0.,voidFractionM().maxCellsPerParticle(),nP);\n dataExchangeM().allocateArray(particleWeights_,0.,voidFractionM().maxCellsPerParticle(),nP);\n dataExchangeM().allocateArray(particleVolumes_,0.,voidFractionM().maxCellsPerParticle(),nP);\n\n //=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=\n if(namesfieldsToDEM.size()!=fieldsToDEM.size())\n cfdemCloud::allocateFieldsToDEM();\n else\n cfdemCloud::reAllocateFieldsToDEM();\n //=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=\n arraysReallocated_ = true;\n return true;\n }\n return false;\n}\n\ntmp cfdemCloud::divVoidfractionTau(volVectorField& U,volScalarField& voidfraction) const\n{\n return\n (\n - fvm::laplacian(voidfractionNuEff(voidfraction), U)\n - fvc::div(voidfractionNuEff(voidfraction)*dev2(fvc::grad(U)().T()))\n );\n}\n\ntmp cfdemCloud::divVoidfractionTau(volVectorField& U,volScalarField& voidfraction,volScalarField& rho) const\n{\n return\n (\n - fvm::laplacian(rho*voidfractionNuEff(voidfraction), U)\n - fvc::div(rho*voidfractionNuEff(voidfraction)*dev2(fvc::grad(U)().T()))\n );\n}\n\ntmp cfdemCloud::ddtVoidfraction() const\n{\n if (useDDTvoidfraction_==word(\"off\"))\n {\n return tmp (ddtVoidfraction_ * 0.);\n if(verbose_)\n Info << \"suppressing ddt(voidfraction)\" << endl;\n }\n return tmp (ddtVoidfraction_ * 1.) ;\n}\n\nvoid cfdemCloud::calcDdtVoidfraction(volScalarField& voidfraction, volVectorField& Us) const\n{\n if (useDDTvoidfraction_==word(\"a\"))\n {\n // Calculation of new ddtVoidfraction by using divergence of particle fluxes instead\n ddtVoidfraction_=fvc::div(Us*(1.-voidfraction));\n }else // \"b\" or \"off\"\n {\n ddtVoidfraction_ = fvc::ddt(voidfraction);\n }\n}\n\n//****************************************\nvoid cfdemCloud::calcMultiphaseTurbulence()\n{\n //Temporary field for collecting the sources\n volScalarField tmpSource\n ( IOobject\n (\n \"tmpSource\",\n mesh().time().timeName(),\n mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n turbulenceMultiphase_*0.0\n );\n\n //reset sources, and compute the sources due to the cloud\n //Will accumulate all sources for all force models\n for (int iModel=0; iModel cfdemCloud::ddtVoidfractionU(volVectorField& U,volScalarField& voidfraction) const\n{\n if (dataExchangeM().couplingStep() <= 2) return fvm::ddt(U);\n\n return fvm::ddt(voidfraction,U);\n}*/\n\ntmp cfdemCloud::voidfractionNuEff(volScalarField& voidfraction) const\n{\n if (modelType_==\"B\" || modelType_==\"Bfull\")\n {\n return tmp\n (\n #ifdef compre\n new volScalarField(\"viscousTerm\", ( turbulence_.mut()\n + turbulence_.mu()\n + turbulenceMultiphase_\n )\n )\n #else\n new volScalarField(\"viscousTerm\", ( turbulence_.nut()\n + turbulence_.nu()\n + turbulenceMultiphase_\n )\n )\n #endif\n );\n }\n else\n {\n return tmp\n (\n #ifdef compre\n new volScalarField(\"viscousTerm\", voidfraction*( turbulence_.mut()\n + turbulence_.mu()\n + turbulenceMultiphase_\n )\n )\n #else\n new volScalarField(\"viscousTerm\", voidfraction*( turbulence_.nut()\n + turbulence_.nu()\n + turbulenceMultiphase_\n )\n )\n #endif\n );\n }\n}\n\nvoid cfdemCloud::resetArray(double**& array,int length,int width,double resetVal)\n{\n for(int index = 0;index < length; ++index){\n for(int i=0;i::iterator it;\n it = std::find(namesfieldsToDEM.begin(), namesfieldsToDEM.end(), name);\n if ( it != namesfieldsToDEM.end() )\n {\n id = std::distance(namesfieldsToDEM.begin(), it);\n Info << \"cfdemCloud already found field '\" << name << \"' at position: \" << id << endl;\n }\n else\n {\n Info << \"cfdemCloud adds field '\" << name <<\"' at end of list.\" << endl;\n namesfieldsToDEM.push_back(name);\n typesfieldsToDEM.push_back(type);\n pullfieldsToDEM.push_back(pull);\n id = namesfieldsToDEM.size()-1;\n }\n}\n\n//****************************************\nbool cfdemCloud::checkAndRegisterFieldsToDEM(const wordList names, const word type, std::vector & id)\n{\n bool validFieldName=false;\n forAll(names,i) {\n int tempPosition=-1; //by default use -1 to indicate invalid field\n if(names[i]!=\"none\")\n {\n validFieldName = true;\n registerFieldsToDEM(names[i], type, tempPosition);\n }\n id.push_back(tempPosition);\n }\n return validFieldName;\n}\n\n//****************************************\nvoid cfdemCloud::allocateFieldsToDEM(word shapeType) const\n{\n if(verbose_) Info << \"cfdemCloud::allocateFieldsToDEM()\" << endl;\n if(fieldsToDEM.size()>0)\n FatalError << \"cfdemCloud::allocateFieldsToDEM(): you are attempting to allocate fields in a container that already contains elements. This is not allowed, please clear container.\" << abort(FatalError);\n //Go through list and allocate\n for(std::vector::iterator it = namesfieldsToDEM.begin(); it != namesfieldsToDEM.end(); ++it)\n {\n int id = std::distance(namesfieldsToDEM.begin(), it);\n\n fieldsToDEM.push_back(NULL); //Must be NULL, otherwise this might confuse external code\n\n word type(typesfieldsToDEM[id]);\n int len(-1);\n if(type==\"scalar-\" + shapeType)\n len=1;\n else if(type==\"vector-\" + shapeType)\n len=3;\n else if(type==\"vector2D-\" + shapeType)\n len=2;\n else if(type==\"quaternion-\" + shapeType)\n len=4;\n// else\n// FatalError << \"cfdemCloud::allocateFieldsToDEM -- unknown array shape: \"\n// << type << abort(FatalError);\n\n if(len>0)\n {\n if(verbose_) Info << \"cfdemCloud::allocateFieldsToDEM() allocating field with name '\" << *it << \"'\" << endl;\n dataExchangeM().allocateArray(fieldsToDEM.back(),0.0,len);\n }\n }\n}\n\n//****************************************\nvoid cfdemCloud::reAllocateFieldsToDEM(word shapeType) const\n{\n if(verbose_) Info << \"cfdemCloud::reAllocateFieldsToDEM()\" << endl;\n //Go through list and allocate\n for(std::vector::iterator it = namesfieldsToDEM.begin(); it != namesfieldsToDEM.end(); ++it)\n {\n int id = std::distance(namesfieldsToDEM.begin(), it);\n\n word type(typesfieldsToDEM[id]);\n int len(-1);\n if(type==\"scalar-\" + shapeType)\n len=1;\n else if(type==\"vector-\" + shapeType)\n len=3;\n else if(type==\"vector2D-\" + shapeType)\n len=2;\n else if(type==\"quaternion-\" + shapeType)\n len=4;\n// else\n// FatalError << \"cfdemCloud::reAllocateFieldsToDEM -- unknown array shape: \"\n// << type << abort(FatalError);\n\n\n if(len>0)\n {\n if(verbose_) Info << \"cfdemCloud::reAllocateFieldsToDEM() reAllocating field with name '\" << *it << \"' at position: \" << id << endl;\n dataExchangeM().allocateArray(fieldsToDEM[id],0.0,len);\n }\n }\n}\n\n//****************************************\nvoid cfdemCloud::zeroizeFieldsToDEM(word shapeType)\n{\n //Go through list and set zero\n for(std::vector::iterator it = namesfieldsToDEM.begin(); it != namesfieldsToDEM.end(); ++it)\n {\n int id = std::distance(namesfieldsToDEM.begin(), it);\n if(!pullfieldsToDEM[id])\n {\n if(typesfieldsToDEM[id]==\"scalar-\" + shapeType)\n {\n //if(verbose_)\n Info << \"Zeroizing field with name '\" << *it\n << \"' at position: \" << id\n << \" with type \" << typesfieldsToDEM[id] << endl;\n resetArray(fieldsToDEM[id],numberOfParticles(),1);\n }\n else if(typesfieldsToDEM[id]==\"vector-\" + shapeType)\n {\n //if(verbose_)\n Info << \"Zeroizing field with name '\" << *it\n << \"' at position: \" << id\n << \" with type \" << typesfieldsToDEM[id] << endl;\n resetArray(fieldsToDEM[id],numberOfParticles(),3);\n }\n }\n }\n}\n\n//****************************************\nvoid cfdemCloud::accessFieldsToDEM(word name, double **& field)\n{\n //set pointer to correct location in the memory\n if(verbose_)\n Info << \"cfdemCloud is accessing field '\" << name << \"'\" << endl;\n std::vector::iterator it;\n it = std::find(namesfieldsToDEM.begin(), namesfieldsToDEM.end(), name);\n if ( it != namesfieldsToDEM.end() )\n {\n int id = std::distance(namesfieldsToDEM.begin(), it);\n if(verbose_)\n Info << \"cfdemCloud found field '\" << name << \"' at position: \" << id << endl;\n field = fieldsToDEM[id];\n }\n else\n FatalError << \"field \" << name\n << \" not found.\"\n << abort(FatalError);\n}\n//****************************************\nint cfdemCloud::existsFieldsToDEM(word name)\n{\n //set pointer to correct location in the memory\n if(verbose_)\n Info << \"cfdemCloud is testing existence field '\" << name << \"'\" << endl;\n\n int id(-1);\n std::vector::iterator it;\n it = std::find(namesfieldsToDEM.begin(), namesfieldsToDEM.end(), name);\n if ( it != namesfieldsToDEM.end() )\n {\n id = std::distance(namesfieldsToDEM.begin(), it);\n if(verbose_)\n {\n if(pullfieldsToDEM[id]) Info << \" cfdemCloud found the pull field '\" << name << \"' at position: \" << id << endl;\n else Info << \" cfdemCloud found the push field '\" << name << \"' at position: \" << id << endl;\n }\n }\n else\n {\n if(verbose_)\n Info << \" cfdemCloud could not fine field '\" << name << \"'\" << endl;\n }\n return id;\n}\n//=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=\n\n// * * * * * * * * * * * * * * * * IOStream operators * * * * * * * * * * * //\n\n#include \"cfdemCloudIO.C\"\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/cfdemCloud/cfdemCloud.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n cloud class managing DEM data for CFD-DEM coupling\n\nClass\n Foam::cfdemCloud\n\nSourceFiles\n cfdemCloud.C\n cfdemCloudIO.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef cfdemCloud_H\n#define cfdemCloud_H\n\n// choose version\n#include \"OFversion.H\"\n#include \n\n#include \"fvCFD.H\"\n#include \"IFstream.H\"\n\n#if defined(version21) || defined(version16ext)\n #include \"turbulenceModel.H\"\n#elif defined(version15)\n #include \"RASModel.H\"\n#endif\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// forward declarations\nclass forceModel;\nclass locateModel;\nclass voidFractionModel;\nclass dataExchangeModel;\nclass IOModel;\nclass probeModel;\nclass registryModel;\nclass averagingModel;\nclass clockModel;\nclass smoothingModel;\nclass momCoupleModel;\nclass meshMotionModel;\nclass liggghtsCommandModel;\n\n/*---------------------------------------------------------------------------*\\\n Class cfdemCloud Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass cfdemCloud\n{\n\n// protected data\nprotected:\n const fvMesh& mesh_;\n\n IOdictionary couplingProperties_;\n\n IOdictionary liggghtsCommandDict_;\n\n Switch allowAdjustTimeStep_;\n\n Switch solveFlow_;\n\n Switch solveScalarTransport_;\n\n Switch verbose_;\n\n Switch expCorrDeltaUError_;\n\n bool debug_;\n\n bool allowCFDsubTimestep_;\n\n bool ignore_;\n\n bool writeTimePassed_;\n\n bool resetWriteTimePassed_;\n\n const word modelType_;\n\n mutable double **impForces_;\n\n mutable double **expForces_;\n\n mutable double **voidfractions_;\n\n mutable double **cellIDs_;\n\n mutable double **particleWeights_;\n\n mutable double **particleVolumes_;\n\n mutable double **particleV_;\n\n mutable double **dragPrev_;\n\n int numberOfParticles_;\n\n //mutable int maxCellsPerParticle_; // lives now in voidFractionModel.H\n\n scalar d32_;\n\n bool numberOfParticlesChanged_;\n\n mutable bool arraysReallocated_;\n\n const wordList forceModels_;\n\n const wordList momCoupleModels_;\n\n const wordList liggghtsCommandModelList_;\n\n const word turbulenceModelType_;\n\n mutable bool isLES_;\n\n mutable scalar cg_;\n\n mutable std::vector cgTypeSpecific_;\n\n bool cgOK_;\n\n bool impDEMdrag_;\n\n bool impDEMdragAcc_;\n\n mutable scalar imExSplitFactor_;\n\n mutable bool treatVoidCellsAsExplicitForce_; //will treat the coupling force in cells with no Us data explicitly\n\n mutable word useDDTvoidfraction_;\n\n mutable volScalarField ddtVoidfraction_;\n\n //Variable used to de-activate mirroring across periodic boundary conditions\n mutable Switch checkPeriodicCells_;\n //de-activation and tolerance variables\n //if set to (for a specific direction), the periodic check will NOT be done\n //default = (1,1,1), i.e., periodic checks will be done\n //important for probing ambient points. Only read-in in case checkPeriodicCells is active\n mutable vector wall_periodicityCheckRange_;\n scalar wall_periodicityCheckTolerance_;\n\n bool meshHasUpdated_;\n\n #if defined(version24Dev)\n const turbulenceModel& turbulence_;\n #elif defined(version21) || defined(version16ext)\n #ifdef compre\n const compressible::turbulenceModel& turbulence_;\n #else\n const incompressible::turbulenceModel& turbulence_;\n #endif\n #elif defined(version15)\n const incompressible::RASModel& turbulence_;\n #endif\n\n //Multiphase Turbulence (e.g., slip-induced turbulence)\n mutable volScalarField turbulenceMultiphase_;\n\n autoPtr* forceModel_;\n\n autoPtr locateModel_;\n\n autoPtr* momCoupleModel_;\n\n autoPtr dataExchangeModel_;\n\n autoPtr IOModel_;\n\n autoPtr probeModel_;\n\n autoPtr registryModel_;\n\n autoPtr voidFractionModel_;\n\n autoPtr averagingModel_;\n\n autoPtr clockModel_;\n\n autoPtr smoothingModel_;\n\n autoPtr meshMotionModel_;\n\n autoPtr* liggghtsCommand_;\n\n// Protected member functions\n virtual void getDEMdata();\n\n virtual void giveDEMdata();\n\n virtual void setNumberOfParticles(int);\n\n virtual void setNumberOfClumps(int);\n\n virtual void setPositionsCM(label,double*);\n\n virtual void setCellIDsCM(label,int*);\n\n virtual void findCells();\n\n virtual void setForces();\n\n virtual void setVoidFraction();\n\n virtual void resetVoidFraction();\n\n virtual void setAlpha(volScalarField&);\n\n virtual void setParticleForceField();\n\n virtual void setVectorAverages();\n\npublic:\n\n friend class dataExchangeModel;\n friend class voidFractionModel;\n friend class forceModel;\n friend class forceSubModel;\n friend class generalManual;\n friend class temperatureModel;\n\n// Constructors\n\n //- Construct from mesh and a list of particles\n cfdemCloud\n (\n const fvMesh& mesh\n );\n\n //- Destructor\n virtual ~cfdemCloud();\n\n// public Member Functions\n\n // Access\n const turbulenceModel& turbulence() {return turbulence_;};\n\n bool isLES() const {return isLES_; };\n\n bool debugMode(){ return debug_;};\n\n bool allowCFDsubTimestep(){ return allowCFDsubTimestep_;};\n\n void setAllowCFDsubTimestep(bool b){allowCFDsubTimestep_=b;};\n\n bool expCorrDeltaUError(){ return expCorrDeltaUError_;};\n\n void setExpCorrDeltaUError(){expCorrDeltaUError_=couplingProperties_.lookupOrDefault(\"expCorrDeltaUError\", false);};\n\n void checkCG(bool);\n\n void setPos(double **&);\n\n word modelType(){ return modelType_; };\n\n label particleCell(int);\n\n virtual inline vector position(int, bool ovr=false, int mp=-1);\n\n virtual inline vector velocity(int, bool ovr=false, int mp=-1);\n\n vector fluidVel(int);\n\n virtual const forceModel& forceM(int);\n\n virtual int nrForceModels();\n\n virtual double** cellsPerParticle();\n\n scalar voidfraction(int);\n\n label liggghtsCommandModelIndex(word);\n\n inline void setCG(double) const;\n\n inline void setCGTypeSpecific(int, double);\n\n mutable bool cgParticleSpecific_;\n\n mutable bool cgTypeSpecificDifferent_;\n\n inline const scalar& cg() const;\n\n inline scalar cg(int index) const;\n\n inline const bool& impDEMdrag() const;\n\n inline const bool& impDEMdragAcc() const;\n\n inline const scalar& imExSplitFactor() const;\n\n inline const bool& treatVoidCellsAsExplicitForce() const;\n\n inline const bool& ignore() const;\n\n inline const bool& writeTimePassed() const;\n\n inline void resetWriteTimePassed();\n\n inline const fvMesh& mesh() const;\n\n inline bool allowAdjustTimeStep() const;\n\n inline bool solveFlow() const;\n\n inline bool solveScalarTransport() const;\n\n inline bool verbose() const;\n\n inline const IOdictionary& couplingProperties() const;\n\n inline double ** positions() const;\n\n inline double ** velocities() const;\n\n inline double ** fluidVels() const;\n\n inline double ** fAccs() const;\n\n inline double ** impForces() const;\n\n inline double ** expForces() const;\n\n inline double ** Cds() const;\n\n inline double ** radii() const;\n\n inline double ** voidfractions() const;\n\n inline void get_radii(double**&) const;\n\n virtual inline double ** cellIDs(bool ovr=false) const;\n\n virtual inline label cellID(int, bool ovr=false, int mp=-1) const;\n\n inline void get_cellIDs(double**&) const;\n\n inline double ** particleWeights() const;\n\n virtual inline label body(int);\n\n virtual inline double particleVolume(int);\n\n inline scalar radius(int, bool ovr=false);\n\n virtual inline double diameter(int, bool ovr=false, int mp=-1);\n\n inline scalar d32(bool recalc=true);\n label particleType(label index) const\n {\n if(idPartTypes()>-1) return fieldsToDEM[idPartTypes()][index][0];\n return 1;\n };\n\n //access to the particle's rotation and torque data\n virtual inline double ** DEMTorques() const {return NULL;};\n virtual inline double ** omegaArray() const {return NULL;};\n virtual vector omega(int) const {return Foam::vector(0,0,0);};\n\n// //access to the particles' orientation information\n virtual vector ex(int) const {\n FatalError << \"cfdemCloud::ex(): you are attempting to get an access to ex array for spheroids/superquadrics. This is not allowed for spheres. Recompile the code with #define anisotropicRotation in OFversion.H or Are you using the correct solver?\" << abort(FatalError);\n return Foam::vector(0,0,0);\n };\n\n virtual vector ey(int) const {\n FatalError << \"cfdemCloud::ey(): you are attempting to get an access to ey array for spheroids/superquadrics. This is not allowed for spheres. Recompile the code with #define anisotropicRotation in OFversion.H or Are you using the correct solver?\" << abort(FatalError);\n return Foam::vector(0,0,0);\n };\n\n virtual vector shape(int) const {\n FatalError << \"cfdemCloud::shapeArray(): you are attempting to get an access to shape array for spheroids/superquadrics. This is not allowed for spheres. Recompile the code with #define anisotropicRotation in OFversion.H or Are you using the correct solver?\" << abort(FatalError);\n return Foam::vector(0,0,0);\n };\n\n // access to complex shape information\n virtual scalar volume(int) const {\n FatalError << \"cfdemCloud::volume(): you are attempting to get an access to volume array for superquadrics. This is not allowed for spheres. Are you using the correct solver?\" << abort(FatalError);\n return 0;\n };\n\n virtual scalar area(int) const {\n FatalError << \"cfdemCloud::area(): you are attempting to get an access to area array for superquadrics. This is not allowed for spheres. Are you using the correct solver?\" << abort(FatalError);\n return 0;\n };\n virtual inline scalarList& area() { static scalarList foo(0); return foo; }\n\n virtual quaternion quat(int) const {\n FatalError << \"cfdemCloud::quat(): you are attempting to get an access to quaternion array for superquadrics. This is not allowed for spheres. Are you using the correct solver?\" << abort(FatalError);\n return quaternion(1);\n };\n\n virtual vector2D blockiness(int) const {\n FatalError << \"cfdemCloud::blockiness(): you are attempting to get an access to blockiness array for superquadrics. This is not allowed for spheres. Are you using the correct solver?\" << abort(FatalError);\n return Foam::vector2D(0,0);\n };\n\n // MS access functions\n#define ErrorMsg FatalError<<\"cfdemCloud: You are attempting to use a MS interface routine. However, your solver is not compiled to use multispheres.\"<* liggghtsCommand() const;\n\n inline void makeSpecific(volScalarField&);\n\n inline void makeSpecific(volVectorField&);\n\n inline void scaleWithVcell(volScalarField&);\n\n inline void scaleWithVcell(volVectorField&);\n\n // Write\n\n // write cfdemCloud internal data\n virtual bool evolve(volScalarField&,volVectorField&,volVectorField&);\n\n virtual bool reAllocArrays() const;\n\n virtual bool reAllocArrays(int nP, bool forceRealloc) const; //force number of particles during reallocation\n\n\n // IO\n void writeScalarFieldToTerminal(double**&);\n\n void writeVectorFieldToTerminal(double**&);\n\n // functions\n tmp divVoidfractionTau(volVectorField& ,volScalarField&) const;\n\n tmp divVoidfractionTau(volVectorField& ,volScalarField& ,volScalarField&) const;\n\n tmp ddtVoidfraction() const;\n\n void calcDdtVoidfraction(volScalarField& voidfraction, volVectorField& Us) const;\n\n void calcMultiphaseTurbulence();\n\n volScalarField& turbulenceMultiphase() const {return turbulenceMultiphase_;};\n\n //tmp ddtVoidfractionU(volVectorField& ,volScalarField&) const;\n\n tmp voidfractionNuEff(volScalarField&) const;\n\n void resetArray(double**&,int,int,double resetVal=0.);\n\n std::vector< std::vector >* getVprobe();\n\n std::vector< std::vector >* getSprobe();\n\n //=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=\n // EXPERIMENAL CODE\n //SHARED GLOBAL PARTICLE Arrays (public containers for data management)\n //1-USER-defined particle fields for CFDEM-->ExternalCode transfer (e.g., to handle fluxes)\n mutable std::vector namesfieldsToDEM; // names of field which are communicated to DEM\n mutable std::vector typesfieldsToDEM; // types of field which are communicated to DEM\n mutable std::vector pullfieldsToDEM; // types of field which are pulled (only) from DEM\n mutable std::vector fieldsToDEM; // fields which are communicated to DEM\n\n void registerFieldsToDEM(word name, word type, int& id, bool pull=false);\n bool checkAndRegisterFieldsToDEM(const wordList names,const word types,std::vector & id);\n virtual void allocateFieldsToDEM(word shapeType=\"atom\") const;\n virtual void reAllocateFieldsToDEM(word shapeType=\"atom\") const;\n virtual void zeroizeFieldsToDEM(word shapeType=\"atom\");\n void accessFieldsToDEM(word name, double **& field);\n int existsFieldsToDEM(word name);\n\n mutable int idRadius_; // id of particle radius in DEM in modular data exchange framework\n mutable int idPos_; // id of particle position in DEM in modular data exchange framework\n mutable int idVel_; // id of particle velocity in DEM in modular data exchange framework\n mutable int idFacc_; // id of accumulated force on particle in DEM in modular data exchange framework\n mutable int idPartTypes_; // id of particle type in DEM in modular data exchange framework\n mutable int idDragExp_; // id of explicit drag in DEM in modular data exchange framework\n mutable int idKsl_; // id of implicit drag coefficient in DEM in modular data exchange framework\n mutable int idKslExtra_; // id of implicit anisotropic drag coefficient in DEM in modular data exchange framework\n mutable int idUf_; // id of fluid vel in DEM in modular data exchange framework\n mutable int idTorqueExp_; // id of explicit torque in DEM in modular data exchange framework\n mutable int idKslRotation_; // id of implicit torque coefficient in DEM in modular data exchange framework\n mutable int idPullRotation_; // id of rotation omega in DEM in modular data exchange framework\n mutable int idPullOrientation_; // id of orientation (ex) in DEM in modular data exchange framework\n mutable int idPullOrientation1_; // id of orientation (ey) in DEM in modular data exchange framework\n mutable int idPullShape_; // id of orientation in DEM in modular data exchange framework\n mutable int idDragExpCM_; // id of explicit drag for multisphere in DEM in modular data exchange framework\n mutable int idKslCM_; // id of implicit anisotropic drag for multisphere in DEM in modular data exchange framework\n mutable int idKslExtraCM_; // id of implicit drag for multisphere in DEM in modular data exchange framework\n mutable int idUfCM_; // id of fluid vel for multisphere in DEM in modular data exchange framework\n mutable int idTorqueExpCM_; // id of explicit torque for multisphere in DEM in modular data exchange framework\n mutable int idKslRotationCM_; // id of implicit torque coefficient for multisphere in DEM in modular data exchange framework\n mutable int idFhydro_; // id of void fraction in DEM in modular data exchange framework\n mutable int idVisc_; // id of fluid vel in DEM in modular data exchange framework\n mutable int idBlockiness_; // id of sq blockiness in DEM in modular data exchange framework\n mutable int idArea_; // id of sq area in DEM in modular data exchange framework\n mutable int idVol_; // id of sq volume in DEM in modular data exchange framework\n mutable int idQuat_; // id of quaternion in DEM in modular data exchange framework\n mutable int idK_; // id of turbulence k in DEM in modular data exchange framework\n mutable int idEpsilon_; // id of turbulence epsilon in DEM in modular data exchange framework\n mutable int idParticleCG_; // id of particle specifig CG factor in DEM in modular data exchange framework\n mutable int idMass_; // id of convex volume in DEM in modular data exchange framework\n mutable int idDensity_; // id of convex volume in DEM in modular data exchange framework\n mutable int idType_; // id of particle type in DEM in modular data exchange framework\n mutable int idConvectiveHeatFlux_; // id of particle convectiveHeatFlux in DEM in modular data exchange framework\n mutable int idTemp_; // id of particle convectiveHeatFlux in DEM in modular data exchange framework\n\n int& idRadius() const {return idRadius_;};\n int& idPos() const {return idPos_;};\n int& idVel() const {return idVel_;};\n int& idFacc() const {return idFacc_;};\n int& idPartTypes() const {return idPartTypes_;};\n int& idDragExp() const {return idDragExp_;};\n int& idKsl() const {return idKsl_;};\n int& idKslExtra() const {return idKslExtra_;};\n int& idUf() const {return idUf_;};\n int& idTorqueExp() const {return idTorqueExp_;};\n int& idKslRotation() const {return idKslRotation_;};\n int& idPullRotation() const {return idPullRotation_;};\n int& idPullOrientation() const {return idPullOrientation_;};\n int& idPullOrientation1() const {return idPullOrientation1_;};\n int& idPullShape() const {return idPullShape_;};\n int& idDragExpCM() const {return idDragExpCM_;};\n int& idKslCM() const {return idKslCM_;};\n int& idKslExtraCM() const {return idKslExtraCM_;};\n int& idUfCM() const {return idUfCM_;};\n int& idTorqueExpCM() const {return idTorqueExpCM_;};\n int& idKslRotationCM() const {return idKslRotationCM_;};\n int& idFhydro() const {return idFhydro_;};\n int& idVisc() const {return idVisc_;};\n int& idBlockiness() const {return idBlockiness_;};\n int& idArea() const {return idArea_;};\n int& idVol() const {return idVol_;};\n int& idQuat() const {return idQuat_;};\n int& idK() const {return idK_;};\n int& idEpsilon() const {return idEpsilon_;};\n int& idParticleCG() const {return idParticleCG_;};\n int& idMass() const {return idMass_;};\n int& idDensity() const {return idDensity_;};\n int& idType() const {return idType_;};\n int& idConvectiveHeatFlux() const {return idConvectiveHeatFlux_;};\n int& idTemp() const {return idTemp_;};\n //=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=\n bool checkPeriodicCells() { return checkPeriodicCells_; }\n int wall_periodicityCheckRange(int dir) {return static_cast(wall_periodicityCheckRange_[dir]);}\n vector wall_periodicityCheckRange() {return wall_periodicityCheckRange_;}\n bool meshHasUpdated() { return meshHasUpdated_; }\n void setMeshHasUpdatedFlag(bool hasUpdated) { meshHasUpdated_ = hasUpdated; }\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#include \"cfdemCloudI.H\"\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/cfdemCloud/cfdemCloudI.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n\\*---------------------------------------------------------------------------*/\n\n#include \"momCoupleModel.H\"\n#include \"smoothingModel.H\"\n#include \"meshMotionModel.H\"\n#include \"averagingModel.H\"\n#include \"clockModel.H\"\n#include \"IOModel.H\"\n#include \"voidFractionModel.H\"\n#include \"locateModel.H\"\n#include \"probeModel.H\"\n#include \"registryModel.H\"\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\ninline void cfdemCloud::setCG(double cg) const\n{\n cg_ = cg;\n Info << \"cg is set to: \" << cg_ << endl;\n};\n\nvector Foam::cfdemCloud::position(int index, bool ovr, int mp)\n{\n vector pos;\n for(int i=0;i<3;i++)\n pos[i] = positions()[index][i];\n return pos;\n}\n\nvector Foam::cfdemCloud::velocity(int index, bool ovr, int mp)\n{\n vector vel;\n for(int i=0;i<3;i++)\n vel[i] = velocities()[index][i];\n return vel;\n}\n\ninline void cfdemCloud::setCGTypeSpecific(int type, double cg)\n{\n if(int(cgTypeSpecific_.size())!=type)\n FatalError << \"setCGTypeSpecific attempts to set at location \"\n << int(cgTypeSpecific_.size())\n << \", but caller requests to set at \"\n << type\n << \". This is fatal. \"\n << abort(FatalError);\n cgTypeSpecific_.push_back(cg);\n if(cgcg_*1.00001)\n {\n cgTypeSpecificDifferent_ = true;\n registerFieldsToDEM(\"type\",\"scalar-atom\",idPartTypes(),true);\n }\n Info << \"type specific cg for type \" << type << \" is set to: \" << cg << endl;\n}\n\ninline const bool& cfdemCloud::impDEMdrag() const\n{\n return impDEMdrag_;\n};\n\ninline const bool& cfdemCloud::impDEMdragAcc() const\n{\n return impDEMdragAcc_;\n};\n\ninline const scalar& cfdemCloud::imExSplitFactor() const\n{\n return imExSplitFactor_;\n};\n\ninline const bool& cfdemCloud::treatVoidCellsAsExplicitForce() const\n{\n return treatVoidCellsAsExplicitForce_;\n}\n\ninline const scalar& cfdemCloud::cg() const\n{\n return cg_;\n};\n\ninline scalar cfdemCloud::cg(int index) const\n{\n if (cgTypeSpecificDifferent_)\n return cgTypeSpecific_[particleType(index)];\n else if (cgParticleSpecific_)\n // idParticleCG constains the char. diameter -> convert to cg factor\n // on top, there may be a global cg -> apply that too\n return 2*fieldsToDEM[idRadius()][index][0]/fieldsToDEM[idParticleCG()][index][0]*cg_;\n else\n return cg_;\n};\n\ninline const bool& cfdemCloud::ignore() const\n{\n return ignore_;\n}\n\ninline const bool& cfdemCloud::writeTimePassed() const\n{\n return writeTimePassed_;\n}\n\ninline void cfdemCloud::resetWriteTimePassed()\n{\n resetWriteTimePassed_=true;\n}\n\ninline const fvMesh& cfdemCloud::mesh() const\n{\n return mesh_;\n}\n\ninline bool cfdemCloud::solveFlow() const\n{\n return bool(solveFlow_);\n}\n\ninline bool cfdemCloud::solveScalarTransport() const\n{\n return bool(solveScalarTransport_);\n}\n\n\ninline bool cfdemCloud::verbose() const\n{\n return verbose_;\n}\n\ninline const IOdictionary& cfdemCloud::couplingProperties() const\n{\n return couplingProperties_;\n}\n\ninline double ** cfdemCloud::positions() const\n{\n return fieldsToDEM[idPos()];\n}\n\ninline double ** cfdemCloud::velocities() const\n{\n return fieldsToDEM[idVel()];\n}\n\ninline double ** cfdemCloud::fAccs() const\n{\n return fieldsToDEM[idFacc()];\n}\n\ninline double ** cfdemCloud::impForces() const\n{\n return impForces_;\n}\n\ninline double ** cfdemCloud::expForces() const\n{\n return expForces_;\n}\n\ninline double ** cfdemCloud::radii() const\n{\n return fieldsToDEM[idRadius()];\n}\n\ninline double ** cfdemCloud::voidfractions() const\n{\n return voidfractions_;\n}\n\ninline void cfdemCloud::get_radii(double **& values) const\n{\n// Info << \"set_radii level=\" << numberOfParticles_ << endl;\n // make a copy of the array entries\n// for (int i=0;iSMALL) d32_ = Ntot/Dtot;\n else d32_ = 0.;\n }\n\n return d32_;\n}\n\ninline int cfdemCloud::numberOfObjects(bool ovr) const\n{\n return numberOfParticles_;\n}\n\ninline int cfdemCloud::numberOfParticles() const\n{\n return numberOfParticles_;\n}\n\ninline bool cfdemCloud::numberOfParticlesChanged() const\n{\n return numberOfParticlesChanged_;\n}\n\ninline int cfdemCloud::numberOfClumps() const\n{\n FatalError << \"cfdemCloud::numberOfClumps() is not called correctly!\" << abort(FatalError);\n return -1;\n}\n\n/*inline void cfdemCloud::setMaxCellsPerParticle(int maxCellsPerParticle) const\n{\n maxCellsPerParticle_ = maxCellsPerParticle;\n};\n\ninline int cfdemCloud::maxCellsPerParticle() const\n{\n return maxCellsPerParticle_;\n}*/\n\ninline bool cfdemCloud::arraysReallocated() const\n{\n return arraysReallocated_;\n}\n\ninline const wordList& cfdemCloud::forceModels()\n{\n return forceModels_;\n}\n\ninline const locateModel& cfdemCloud::locateM() const\n{\n return locateModel_;\n}\n\ninline const momCoupleModel& cfdemCloud::momCoupleM(int i) const\n{\n return momCoupleModel_[i];\n}\n\ninline const dataExchangeModel& cfdemCloud::dataExchangeM() const\n{\n return dataExchangeModel_;\n}\n\ninline const IOModel& cfdemCloud::IOM() const\n{\n return IOModel_;\n}\n\ninline const probeModel& cfdemCloud::probeM() const\n{\n return probeModel_;\n}\n\ninline const registryModel& cfdemCloud::registryM() const\n{\n return registryModel_;\n}\n\ninline const voidFractionModel& cfdemCloud::voidFractionM() const\n{\n return voidFractionModel_;\n}\n\ninline const averagingModel& cfdemCloud::averagingM() const\n{\n return averagingModel_;\n}\n\ninline const clockModel& cfdemCloud::clockM() const\n{\n return clockModel_;\n}\n\ninline const smoothingModel& cfdemCloud::smoothingM() const\n{\n return smoothingModel_;\n}\n\ninline const meshMotionModel& cfdemCloud::meshMotionM() const\n{\n return meshMotionModel_;\n}\n\ninline const wordList& cfdemCloud::liggghtsCommandModelList() const\n{\n return liggghtsCommandModelList_;\n}\n\ninline autoPtr* cfdemCloud::liggghtsCommand() const\n{\n return liggghtsCommand_;\n}\n\ninline void cfdemCloud::makeSpecific(volScalarField& field)\n{\n forAll(field,cellI)\n field[cellI] /= mesh_.V()[cellI];\n}\n\ninline void cfdemCloud::makeSpecific(volVectorField& field)\n{\n forAll(field,cellI)\n field[cellI] /= mesh_.V()[cellI];\n}\n\ninline void cfdemCloud::scaleWithVcell(volScalarField& field)\n{\n forAll(field,cellI)\n field[cellI] *= mesh_.V()[cellI];\n}\n\ninline void cfdemCloud::scaleWithVcell(volVectorField& field)\n{\n forAll(field,cellI)\n field[cellI] *= mesh_.V()[cellI];\n}\n\n}\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/cfdemCloud/cfdemCloudIO.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n\\*---------------------------------------------------------------------------*/\n\n#include \"cfdemCloud.H\"\n\n// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\n\n\n// * * * * * * * * * * * * * * * IO * * * * * * * * * * * * * //\n\nvoid Foam::cfdemCloud::writeScalarFieldToTerminal(double**& array)\n{\n // init double array\n for (int i=0; i\n#include \"IOmanip.H\"\n#include \"OFversion.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\ncfdemCloudIB::cfdemCloudIB\n(\n const fvMesh& mesh\n)\n:\n cfdemCloud(mesh),\n angularVelocities_(NULL),\n pRefCell_(readLabel(mesh.solutionDict().subDict(\"PISO\").lookup(\"pRefCell\"))),\n pRefValue_(readScalar(mesh.solutionDict().subDict(\"PISO\").lookup(\"pRefValue\"))),\n DEMTorques_(NULL),\n haveEvolvedOnce_(false),\n skipLagrangeToEulerMapping_(false),\n skipAfter_(false),\n timeStepsToSkip_(0),\n calculateTortuosity_(false),\n frontMeshRefine_(false)\n{\n if(this->couplingProperties().found(\"skipLagrangeToEulerMapping\"))\n {\n Info << \"Will skip lagrange-to-Euler mapping...\" << endl;\n skipLagrangeToEulerMapping_=true;\n }\n if(this->couplingProperties().found(\"timeStepsBeforeSkipping\"))\n {\n skipAfter_=true;\n timeStepsToSkip_ = readScalar\n (\n this->couplingProperties().lookup(\"timeStepsBeforeSkipping\")\n );\n Info << \"Will skip LagrangeToEuler mapping after \" << timeStepsToSkip_ << \" time steps\" << endl;\n }\n if(this->couplingProperties().found(\"tortuosity\"))\n {\n calculateTortuosity_ = true;\n flowDir_ = this->couplingProperties().subDict(\"tortuosity\").lookup(\"flowDirection\");\n flowDir_ = flowDir_ / mag(flowDir_);\n Info << \"Will calculate tortuosity in the mean flow direction (\"<couplingProperties().subDict(\"wall_blockPeriodicityCheck\").lookup(\"x\")))\n wall_periodicityCheckRange_[0] = 0;\n if(readBool(this->couplingProperties().subDict(\"wall_blockPeriodicityCheck\").lookup(\"y\")))\n wall_periodicityCheckRange_[1] = 0;\n if(readBool(this->couplingProperties().subDict(\"wall_blockPeriodicityCheck\").lookup(\"z\")))\n wall_periodicityCheckRange_[2] = 0;\n\n if(this->couplingProperties().found(\"wall_periodicityCheckTolerance\"))\n wall_periodicityCheckTolerance_ = readScalar (this->couplingProperties().lookup(\"wall_periodicityCheckTolerance\"));\n }\n\n // add flag for IB cloud --> model checks\n registryM().addProperty(\"IB\", 1);\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\ncfdemCloudIB::~cfdemCloudIB()\n{\n dataExchangeM().destroy(angularVelocities_,3);\n dataExchangeM().destroy(dragPrev_,3);\n dataExchangeM().destroy(DEMTorques_,3);\n}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\nvoid Foam::cfdemCloudIB::getDEMdata()\n{\n cfdemCloud::getDEMdata();\n dataExchangeM().getData(\"omega\",\"vector-atom\",angularVelocities_);\n}\n\nbool Foam::cfdemCloudIB::reAllocArrays() const\n{\n if(cfdemCloud::reAllocArrays())\n {\n Info <<\"Foam::cfdemCloudIB::reAllocArrays()\"<= 0)\n {\n // calc particle velocity\n for(int i=0;i<3;i++) rVec[i]=U.mesh().C()[cellI][i]-position(index)[i];\n for(int i=0;i<3;i++) angVel[i]=angularVelocities()[index][i];\n velRot=angVel^rVec;\n for(int i=0;i<3;i++) uParticle[i] = velocities()[index][i]+velRot[i];\n\n // impose field velocity\n U[cellI]=(1-voidfractions_[index][subCell])*uParticle+voidfractions_[index][subCell]*U[cellI];\n }\n }\n }\n U.correctBoundaryConditions();\n}\n\nvector Foam::cfdemCloudIB::angularVelocity(int index)\n{\n vector vel;\n for(int i=0;i<3;i++) vel[i] = angularVelocities_[index][i];\n return vel;\n}\n\ndouble Foam::cfdemCloudIB::getTortuosity(vector dir)\n{\n volVectorField U = mesh_.lookupObject(\"U\");\n volScalarField voidfraction = mesh_.lookupObject(\"voidfraction\");\n double ux = 0.0;\n double umag = 0.0;\n forAll(mesh_.V(),cellI)\n {\n if(voidfraction[cellI] > 0.5)\n {\n double V = mesh_.V()[cellI];\n ux += ((U[cellI] & dir))*V;\n umag += mag(U[cellI])*V;\n }\n }\n //double ux_reduced = 0.0;\n //double umag_reduced = 0.0;\n //MPI_Allreduce(&ux, &ux_reduced, 1, MPI_DOUBLE, MPI_SUM, MPI_COMM_WORLD);\n //MPI_Allreduce(&umag, &umag_reduced, 1, MPI_DOUBLE, MPI_SUM, MPI_COMM_WORLD);\n reduce(umag, sumOp());\n reduce(ux, sumOp());\n double tortuosity = ux == 0.0 ? 1.0 : umag / ux;\n return tortuosity;\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\nvoid cfdemCloudIB::setRefinementField(volScalarField* refine_)\n{\n //Function to allow for setting and activating special refinement operations\n frontMeshRefineField_ = refine_;\n frontMeshRefine_ = true;\n\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/derived/cfdemCloudIB/cfdemCloudIB.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n cloud class managing DEM data for CFD-DEM coupling and IB representation\n\nClass\n Foam::cfdemCloudIB derived from cfdemCloud\n\nSourceFiles\n cfdemCloudIB.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef cfdemCloudIB_H\n#define cfdemCloudIB_H\n\n#include \"cfdemCloud.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class cfdemCloudIB Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass cfdemCloudIB\n:\n public cfdemCloud\n{\nprotected:\n\n mutable double **angularVelocities_;\n label pRefCell_;\n scalar pRefValue_;\n \n mutable double **DEMTorques_;\n\n mutable bool haveEvolvedOnce_;\n mutable bool skipLagrangeToEulerMapping_;\n mutable bool skipAfter_;\n mutable int timeStepsToSkip_;\n mutable bool calculateTortuosity_;\n\n vector flowDir_;\n\n //for refinement - needed to ensure correct probing around the interface\n volScalarField* frontMeshRefineField_;\n bool frontMeshRefine_;\n\npublic:\n\n // Constructors\n\n //- Construct from components\n cfdemCloudIB\n (\n const fvMesh& mesh\n );\n\n // Destructor\n\n ~cfdemCloudIB();\n\n\n // Member Functions\n void giveDEMdata();\n\n void getDEMdata();\n\n bool reAllocArrays() const;\n\n inline double ** DEMTorques() const;\n \n bool evolve(volScalarField&,volScalarField&);\n\n void calcVelocityCorrection(volScalarField&,volVectorField&,volScalarField&,volScalarField&);\n\n virtual void setParticleVelocity(volVectorField&);\n\n // Access\n vector angularVelocity(int);\n\n inline double ** angularVelocities() const\n {\n return angularVelocities_;\n };\n void setInterFace(volScalarField& interFace); //this field can be used for refinement outside of the cloud\n\n double getTortuosity(vector dir);\n\n void setRefinementField(volScalarField* refine_); //this pointer is meant for a field that is used refinement outside of the cloud. can point to the same field as interFace\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/etc/OFVersionChange/changeDictionaryDicts/changeDictionaryDict_2.4.x", "content": "/*--------------------------------*- C++ -*----------------------------------*\\\n| ========= | |\n| \\\\ / F ield | OpenFOAM: The Open Source CFD Toolbox |\n| \\\\ / O peration | Version: 3.0.x |\n| \\\\ / A nd | Web: www.OpenFOAM.org |\n| \\\\/ M anipulation | |\n\\*---------------------------------------------------------------------------*/\nFoamFile\n{\n version 2.0;\n format ascii;\n class dictionary;\n object changeDictionaryDict;\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\ndictionaryReplacement\n{\n\n turbulenceProperties \n {\n simulationType RASModel;\n }\n couplingProperties\n {\n turbulenceModelType \"RASProperties\";\n }\n}\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/etc/OFVersionChange/changeDictionaryDicts/changeDictionaryDict_3.0.x", "content": "/*--------------------------------*- C++ -*----------------------------------*\\\n| ========= | |\n| \\\\ / F ield | OpenFOAM: The Open Source CFD Toolbox |\n| \\\\ / O peration | Version: 3.0.x |\n| \\\\ / A nd | Web: www.OpenFOAM.org |\n| \\\\/ M anipulation | |\n\\*---------------------------------------------------------------------------*/\nFoamFile\n{\n version 2.0;\n format ascii;\n class dictionary;\n object changeDictionaryDict;\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\ndictionaryReplacement\n{\n\n turbulenceProperties \n {\n simulationType laminar;\n\n RAS\n {\n RASModel laminar;\n\n turbulence off;\n\n printCoeffs on;\n }\n }\n couplingProperties\n {\n turbulenceModelType turbulenceProperties;\n }\n}\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/etc/OFVersionChange/shellScripts/activateVersion.sh", "content": "#!/bin/bash\nsource $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/bashrc\n#shopt -s expand_aliases\n\nETCpath=$CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/OFVersionChange/shellScripts\n\n$ETCpath/unComment.sh $1 CFD/constant/turbulenceProperties\n$ETCpath/unComment.sh $1 CFD/constant/transportProperties\n$ETCpath/unComment.sh $1 CFD/constant/couplingProperties\n$ETCpath/unComment.sh $1 CFD/constant/couplingProperties_run\n$ETCpath/unComment.sh $1 CFD/constant/couplingProperties_restart\n$ETCpath/unComment.sh $1 CFD/system/fvOptions\n" }, { "path": "src/lagrangian/cfdemParticle/etc/OFVersionChange/shellScripts/cfdemChangeTutOFversion.sh", "content": "#!/bin/bash\n\nsource $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/bashrc\n#shopt -s expand_aliases\n\n# find my OF version\nif [ \"$WM_PROJECT_VERSION\" == \"3.0.x\" ]; then\n echo 'You are using OpenFOAM 3.0.x. Will activate dicts now...'\n OFV=OFversion30x\nelse\n echo 'You are using OpenFOAM 2.4.x or lower. Will activate dicts now...'\n OFV=OFversion24x\nfi\nETCpath=$CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/OFVersionChange/shellScripts\n\n\n# remove old comment // in every line ending with OFversionXYZ\n# doing this three times to make sure multiple comments are removed\nbash $ETCpath/activateVersion.sh OFversion\nbash $ETCpath/activateVersion.sh OFversion\nbash $ETCpath/activateVersion.sh OFversion\n\n# adding comment // to all lines ending with OFversionXYZ\nbash $ETCpath/commentOut.sh OFversion CFD/constant/turbulenceProperties\nbash $ETCpath/commentOut.sh OFversion CFD/constant/transportProperties\nbash $ETCpath/commentOut.sh OFversion CFD/constant/couplingProperties\nbash $ETCpath/commentOut.sh OFversion CFD/constant/couplingProperties_run\nbash $ETCpath/commentOut.sh OFversion CFD/constant/couplingProperties_restart\nbash $ETCpath/commentOut.sh OFversion CFD/system/fvOptions\n\n# removing the comment // in every line ending with $OFV\nbash $ETCpath/activateVersion.sh $OFV\n" }, { "path": "src/lagrangian/cfdemParticle/etc/OFVersionChange/shellScripts/cfdemChangeTutOFversion_all.sh", "content": "#! /bin/bash\n\n##########################################################################\n# Shellscript:\tupdate tutorial cases in the whole tree according to OFV\n# Author :\tAndreas Aigner \n# Date :\t2016-04-15\n# Category :\tAdmin Utilities\n##########################################################################\n# Description\n# update tutorial cases in the whole tree according to OFV\n##########################################################################\n\nPN=`basename \"$0\"` # Program name\nBASEDIR=`dirname \"$0\"`\nVER='0.1'\n\nUsage () {\n echo >&2 \"$PN - update all tutorials in a whole tree, $VER\nusage: $PN [-f] path\n -f: force to ignore security check;\n allows other directories than 'cfdemTut' and sub-directories\n -v: verbose output\n -h: show this help\n\n path: path to the root directory of all tutorials\n\nExample:\n $PN $HOME/Repositories\"\n exit 1\n}\n\nMsg () { echo >&2 \"$*\"; } # removed \"$PN:\" to shorten output\nFatal () { Msg \"Error: $@\"; exit 1; }\n\n# defaults\nforce_flag=false\nverbose_flag=false\n\nwhile getopts hfv opt\ndo\n case \"$opt\" in\n f) force_flag=true;;\n v) verbose_flag=true;;\n h) Usage;;\n \\?) Usage;;\n esac\ndone\nshift `expr $OPTIND - 1`\n\n[ $# -lt 1 ] && Msg \"No path defined\" && Usage # check for path\n\n# check if readlink exists (we need it for the savety check)\ncommand -v readlink >/dev/null 2>&1 || { Fatal \"readlink is required but it's not installed. Aborting.\"; }\n\n# global paths\ncurRunDir=$(pwd)\ncfdemTutDir=$(readlink -m $CFDEM_TUT_DIR)\n\n#set -x\nfor dir in \"$@\"\ndo\n Msg \"INFO: Checking $dir\"\n\n # is directory?\n if [ ! -d \"$dir\" ]; then\n Msg \"$dir is not a directory\"\n continue\n fi\n\n # clean paths from multiple separators (pure bash)\n #dir=$(echo \"$dir\" | sed s#//*#/#g)\n #cfdemTutDir=$(echo \"$CFDEM_TUT_DIR\" | sed s#//*#/#g)\n\n # resolve absolute and relative paths (with readlink)\n # clean paths from multiple separators and resolve ./..\n if [ \"${dir:0:1}\" = \"/\" ]; then # absolute path\n curDir=$(readlink -m $dir)\n else # relative path\n curDir=$(readlink -m $curRunDir/$dir)\n fi\n\n # savety check: check if dir is within $CFDEM_TUT_DIR; skip if forced\n if [[ $curDir != $cfdemTutDir ]] && [ $force_flag != true ]; then\n Fatal \"$curDir is not within $cfdemTutDir. Change the directory or use the option -f.\"\n fi\n\n # performe change steps\n ldir=$(find \"$dir\" -name 'CFD' -type d)\n for cfd in $ldir\n do\n casedir=$(dirname \"$cfd\") ## get parent directory of the CFD directory\n Msg \"INFO: Updating $casedir\"\n #echo \"do sth here...\"\n if [ $verbose_flag = true ]; then\n (cd $casedir && bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/OFVersionChange/shellScripts/cfdemChangeTutOFversion.sh)\n else\n (cd $casedir && bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/OFVersionChange/shellScripts/cfdemChangeTutOFversion.sh) &>/dev/null\n fi\n done\ndone\n" }, { "path": "src/lagrangian/cfdemParticle/etc/OFVersionChange/shellScripts/commentOut.sh", "content": "#!/bin/bash\n#Syntax: commentOut \n#This will do a GLOBAL commenting out!\n\nsed -i \"/$1/ s:^://:g\" $2\n" }, { "path": "src/lagrangian/cfdemParticle/etc/OFVersionChange/shellScripts/integratorAndCouplingStyleChange.sh", "content": "#!/bin/bash\n\n#===================================================================#\n# script which should support changing the syntax in the liggghts\n# input files to new integrators and force coupling.\n# WARNING: Use this script at YOUR OWN RISK!!!\n# Please use with caution and prepare a copy of your files\n# BEFORE (!!!) you run this script.\n# DCS Computing GmbH - June 2018\n#===================================================================#\n# SYNTAX CHANGES FOR SPHERES:\n#A) nve/sphere-->nve/cfd_cn/sphere\n#B) couple/cfd/force/implicit-->couple/cfd/force\n#C) CrankNicolson entry goes from couple/cfd/force/implicit to nve/cfd_cn/sphere\n#D) CAddRhoFluid is only used with couple/cfd/force and entries are split up to ${Cadd} and ${rhoFluid}\n#E) transfer_type yes is now handled via transfer_property type\n#F) fix multisphere is no longer an integrator and needs a separate integrator fix integrator all nve/cfd_cn/nonspherical\n# the fix multisphere and fix integrator command must be before the fix couple/cfd/force/multisphere\n#G) IB cases need for the fix couple/cfd/force the extra keyword torque explicit to communicate hdtorque\n#===================================================================#\n\necho \"WARNING: Use this script at YOUR OWN RISK (!!!). Please use with caution and prepare a copy of your files. BEFORE (!!!) you run this script.\"\necho \"In doubt press Ctrl-C!\"\nread\n\n\necho \"apply rule A) nve/sphere-->nve/cfd_cn/sphere\"\necho \"to all in.* (files named differently will be ignored!)\"\nread\nfind . -iname \"in.*\" -exec sed -i 's/nve\\/sphere/nve\\/cfd_cn\\/sphere/g' {} +\n\necho \"apply rule B) couple/cfd/force/implicit-->couple/cfd/force\"\necho \"to all in.* (files named differently will be ignored!)\"\nread\nfind . -iname \"in.*\" -exec sed -i 's/couple\\/cfd\\/force\\/implicit/couple\\/cfd\\/force/g' {} +\n\necho \"apply rule B)2) couple/cfd/force/integrateImp-->couple/cfd/force && nve/cfd_cn/sphere\"\necho \"to all in.* (files named differently will be ignored!)\"\necho \"please add the command fix integr all nve/cfd_cn/sphere to the files being opend in gedit\"\necho \"Then please save the files and close the gedit window. Then press enter.\"\nread\nfind . -iname \"in.*\" -exec grep -rl \"integrateImp\" {} + | xargs gedit -s;\nread\nfind . -iname \"in.*\" -exec sed -i 's/couple\\/cfd\\/force\\/integrateImp/couple\\/cfd\\/force/g' {} +\n\necho \"Please manually apply rule C): CrankNicolson entry goes from couple/cfd/force/implicit to nve/cfd_cn/sphere (the files will open in gedit.)\"\necho \"Then please save the files and close the gedit window. Then press enter.\"\nread\nfind . -iname \"in.*\" -exec grep -rl \"CrankNicolson\" {} + | xargs gedit -s;\nread\n\necho \"Please manually apply rule D): CAddRhoFluid is only used with couple/cfd/force and entries are split up to \\${Cadd} and \\${rhoFluid}\"\necho \"Then please save the files and close the gedit window. Then press enter.\"\nread\nfind . -iname \"in.*\" -exec grep -rl \"CAddRhoFluid\" {} + | xargs gedit -s;\n\necho \"Please manually apply rule E): transfer_type yes is now handled via couple/cfd (not force!!!) transfer_property name type vector_atom\"\necho \"Then please save the files and close the gedit window. Then press enter.\"\nread\nfind . -iname \"in.*\" -exec grep -rl \"transfer_type\" {} + | xargs gedit -s;\n\necho \"Please manually apply rule F): fix multisphere is no longer an integrator and needs a separate integrator fix integrator all nve/cfd_cn/nonspherical.\"\necho \"The fix multisphere and fix integrator command must be before the fix couple/cfd/force/multisphere!\"\necho \"Then please save the files and close the gedit window. Then press enter.\"\nread\nfind . -iname \"in.*\" -exec grep -rl \"multisphere\" {} + | xargs gedit -s;\n\n" }, { "path": "src/lagrangian/cfdemParticle/etc/OFVersionChange/shellScripts/unComment.sh", "content": "#!/bin/bash\n#Syntax: unComment \n#This will do a GLOBAL uncomment!\n\nsed -i \"/$1/ s:^//::g\" $2\n" }, { "path": "src/lagrangian/cfdemParticle/etc/OFversion/OFversion.H", "content": "#if(CFDEMWMPROJECTVERSION == 60) || (CFDEMWMPROJECTVERSION == 6)\n #define version60\n#elif(CFDEMWMPROJECTVERSION == 50)\n #define version50\n#elif(CFDEMWMPROJECTVERSION == 40)\n #define version40\n#elif(CFDEMWMPROJECTVERSION == 24)\n #define version24\n#elif(CFDEMWMPROJECTVERSION == 30)\n #define version30\n#elif(CFDEMWMPROJECTVERSION == 132)\n #define versionExt32\n#elif(CFDEMWMPROJECTVERSION == 1606)\n #define versionv1606plus\n#elif(CFDEMWMPROJECTVERSION == 1612)\n #define versionv1612plus\n#elif(CFDEMWMPROJECTVERSION == 1706)\n #define versionv1706\n#endif\n\n// features of 16ext work also in extend 3.2\n#if defined(versionExt32)\n #define version16ext\n#endif\n\n// features of 5.0 work also in 6.0\n#if defined(version60)\n #define version50\n#endif\n\n// features of 4.0 work also in 5.0\n#if defined(version50)\n #define version40\n#endif\n\n// features of 3.0 work also in 4.0\n#if defined(version40)\n #define version30\n#endif\n\n// features of v1706 work also in v1612+\n#if defined(versionv1706)\n #define versionv1612plus\n#endif\n\n#if defined(versionv1612plus)\n #define version40\n#endif\n\n// features of v1606+ work also in v1612+\n#if defined(versionv1612plus)\n #define versionv1606plus\n#endif\n\n// features of 3.0 work also in v1606+\n#if defined(versionv1606plus)\n #define version30\n#endif\n\n// features of 2.4Dev work also in 3.0\n#if defined(version30)\n #define version24Dev\n#endif\n\n// basically use 24x settings + some dev features (e.g. new turbulence model structure)\n#if defined(version24Dev)\n #define version24\n#endif\n\n// features of 2.4 work also in 2.3\n#if defined(version24)\n #define version23\n#endif\n\n// features of 2.1 work also in 2.3\n#if defined(version23)\n #define version21\n #define version221\n#endif\n\n// features of 2.1 work also in 2.2\n#if defined(version22)\n #define version21\n #define version221\n#endif\n" }, { "path": "src/lagrangian/cfdemParticle/etc/addLibs_universal/additionalLibs_2.4.x", "content": "# Specify additional include and library paths, as well as libraries for the compilation\n#\n# CFDEM_ADD_INC =\n# CFDEM_ADD_LIB_PATHS =\n# CFDEM_ADD_LIBS =\n\n# additional static libraries to be linked to lagrangian library\nCFDEM_ADD_STATICLIBS = \\\n\n# include flags for compiling with SQ\ninclude $(CFDEM_ADD_LIBS_DIR)/additionalLibs_superquadric\n\n#################################################################\n## SETTINGS FOR 2.4.x ##\n#################################################################\n#----------------------------------------------------------------\n# incompressible turbulence model settings\n#----------------------------------------------------------------\n# paths for incompressible turbulence models to use\nCFDEM_ADD_INCOMPTURBMOD_PATHS = \\\n-I$(LIB_SRC)/turbulenceModels/incompressible/turbulenceModel \\\n-I$(LIB_SRC)/fvOptions/lnInclude \\\n-I$(LIB_SRC)/sampling/lnInclude\n\n# libs for turbulence models to use\nCFDEM_ADD_INCOMPTURBMOD_LIBS = \\\n-lincompressibleRASModels \\\n-lincompressibleLESModels \\\n-lfvOptions \\\n-lsampling\n\nCFDEM_TRI_SURF = \\\n-ltriSurface\n\nCFDEM_SPRAY_LIBS = \\\n -lliquidProperties \\\n -lliquidMixtureProperties \\\n -lsolidProperties \\\n -lsolidMixtureProperties \\\n -lthermophysicalFunctions \n\n#----------------------------------------------------------------\n# compressible turbulence model settings\n#----------------------------------------------------------------\n# paths for compressible turbulence models to use\nCFDEM_ADD_COMPTURBMOD_PATHS = \\\n-I$(LIB_SRC)/turbulenceModels/compressible/turbulenceModel \\\n-I$(LIB_SRC)/thermophysicalModels/basic/lnInclude \\\n-I$(LIB_SRC)/thermophysicalModels/radiationModels/lnInclude \\\n\n# libs for turbulence models to use\nCFDEM_ADD_COMPTURBMOD_LIBS = \\\n-lcompressibleRASModels \\\n-lcompressibleLESModels \\\n-lfluidThermophysicalModels \\\n" }, { "path": "src/lagrangian/cfdemParticle/etc/addLibs_universal/additionalLibs_3.0.x", "content": "# Specify additional include and library paths, as well as libraries for the compilation\n#\n#CFDEM_ADD_INC = \\\n#CFDEM_ADD_LIB_PATHS = \\\n#CFDEM_ADD_LIBS = \\\n\n# additional static libraries to be linked to lagrangian library\nCFDEM_ADD_STATICLIBS = \\\n\n# include flags for compiling with SQ\ninclude $(CFDEM_ADD_LIBS_DIR)/additionalLibs_superquadric\n\n#################################################################\n## SETTINGS FOR 3.0.x ##\n#################################################################\n#----------------------------------------------------------------\n# incompressible turbulence model settings\n#----------------------------------------------------------------\n# paths for incompressible turbulence models to use\nCFDEM_ADD_INCOMPTURBMOD_PATHS = \\\n-I$(LIB_SRC)/TurbulenceModels/turbulenceModels/lnInclude \\\n-I$(LIB_SRC)/TurbulenceModels/incompressible/lnInclude \\\n-I$(LIB_SRC)/fvOptions/lnInclude \\\n###-I$(LIB_SRC)/thermophysicalModels/radiation/lnInclude \\\n\n# libs for turbulence models to use\nCFDEM_ADD_INCOMPTURBMOD_LIBS = \\\n-lturbulenceModels \\\n-lincompressibleTurbulenceModels \\\n-lfvOptions \\\n\nCFDEM_TRI_SURF = \\\n-ltriSurface\n\nCFDEM_SPRAY_LIBS = \\\n -lliquidProperties \\\n -lliquidMixtureProperties \\\n -lsolidProperties \\\n -lsolidMixtureProperties \\\n -lthermophysicalFunctions \n\n#----------------------------------------------------------------\n# compressible turbulence model settings\n#----------------------------------------------------------------\n# paths for compressible turbulence models to use\nCFDEM_ADD_COMPTURBMOD_PATHS = \\\n-I$(LIB_SRC)/TurbulenceModels/turbulenceModels/lnInclude \\\n-I$(LIB_SRC)/TurbulenceModels/compressible/lnInclude \\\n-I$(LIB_SRC)/transportModels/compressible/lnInclude \\\n-I$(LIB_SRC)/thermophysicalModels/radiation/lnInclude \\\n\n# libs for turbulence models to use\nCFDEM_ADD_COMPTURBMOD_LIBS = \\\n-lturbulenceModels \\\n-lcompressibleTurbulenceModels \\\n#################################################################\n" }, { "path": "src/lagrangian/cfdemParticle/etc/addLibs_universal/additionalLibs_3.2", "content": "# Specify additional include and library paths, as well as libraries for the compilation\n#\n# CFDEM_ADD_INC =\n# CFDEM_ADD_LIB_PATHS =\n# CFDEM_ADD_LIBS =\n\n# additional static libraries to be linked to lagrangian library\nCFDEM_ADD_STATICLIBS = \\\n\n# include flags for compiling with SQ\ninclude $(CFDEM_ADD_LIBS_DIR)/additionalLibs_superquadric\n\n#################################################################\n## SETTINGS FOR Extend 3.2 ##\n#################################################################\n#----------------------------------------------------------------\n# incompressible turbulence model settings\n#----------------------------------------------------------------\n# paths for incompressible turbulence models to use\nCFDEM_ADD_INCOMPTURBMOD_PATHS = \\\n-I$(LIB_SRC)/turbulenceModels/incompressible/turbulenceModel \\\n\n# libs for turbulence models to use\nCFDEM_ADD_INCOMPTURBMOD_LIBS = \\\n-lincompressibleRASModels \\\n-lincompressibleLESModels \\\n\n#----------------------------------------------------------------\n# compressible turbulence model settings\n#----------------------------------------------------------------\n# paths for compressible turbulence models to use\nCFDEM_ADD_COMPTURBMOD_PATHS = \\\n-I$(LIB_SRC)/turbulenceModels/compressible/turbulenceModel \\\n-I$(LIB_SRC)/thermophysicalModels/basic/lnInclude \\\n-I$(LIB_SRC)/thermophysicalModels/radiationModels/lnInclude \\\n\nCFDEM_TRI_SURF = \\\n-ltriSurface\n\nCFDEM_SPRAY_LIBS = \\\n -lliquidProperties \\\n -lliquidMixtureProperties \\\n -lsolidProperties \\\n -lsolidMixtureProperties \\\n -lthermophysicalFunctions \n\n# libs for turbulence models to use\nCFDEM_ADD_COMPTURBMOD_LIBS = \\\n-lcompressibleRASModels \\\n-lcompressibleLESModels \\\n" }, { "path": "src/lagrangian/cfdemParticle/etc/addLibs_universal/additionalLibs_4.x", "content": "# Specify additional include and library paths, as well as libraries for the compilation\n#\n# CFDEM_ADD_INC =\n# CFDEM_ADD_LIB_PATHS =\n# CFDEM_ADD_LIBS =\n\n# additional static libraries to be linked to lagrangian library\nCFDEM_ADD_STATICLIBS = \\\n\n# include flags for compiling with SQ\ninclude $(CFDEM_ADD_LIBS_DIR)/additionalLibs_superquadric\n\n#################################################################\n## SETTINGS FOR 3.0.x ##\n#################################################################\n#----------------------------------------------------------------\n# incompressible turbulence model settings\n#----------------------------------------------------------------\n# paths for incompressible turbulence models to use\nCFDEM_ADD_INCOMPTURBMOD_PATHS = \\\n-I$(LIB_SRC)/TurbulenceModels/turbulenceModels/lnInclude \\\n-I$(LIB_SRC)/TurbulenceModels/incompressible/lnInclude \\\n-I$(LIB_SRC)/fvOptions/lnInclude \\\n\n# libs for turbulence models to use\nCFDEM_ADD_INCOMPTURBMOD_LIBS = \\\n-lturbulenceModels \\\n-lincompressibleTurbulenceModels \\\n-lfvOptions \\\n\nCFDEM_TRI_SURF = \\\n-ltriSurface\n\nCFDEM_SPRAY_LIBS = \\\n -lliquidProperties \\\n -lliquidMixtureProperties \\\n -lsolidProperties \\\n -lsolidMixtureProperties \\\n -lthermophysicalFunctions \n\n#----------------------------------------------------------------\n# compressible turbulence model settings\n#----------------------------------------------------------------\n# paths for compressible turbulence models to use\nCFDEM_ADD_COMPTURBMOD_PATHS = \\\n-I$(LIB_SRC)/TurbulenceModels/turbulenceModels/lnInclude \\\n-I$(LIB_SRC)/TurbulenceModels/compressible/lnInclude \\\n-I$(LIB_SRC)/transportModels/compressible/lnInclude \\\n-I$(LIB_SRC)/thermophysicalModels/radiation/lnInclude \\\n\n# libs for turbulence models to use\nCFDEM_ADD_COMPTURBMOD_LIBS = \\\n-lturbulenceModels \\\n-lcompressibleTurbulenceModels \\\n#################################################################\n" }, { "path": "src/lagrangian/cfdemParticle/etc/addLibs_universal/additionalLibs_5.x", "content": "# Specify additional include and library paths, as well as libraries for the compilation\n#\n# CFDEM_ADD_INC =\n# CFDEM_ADD_LIB_PATHS =\n# CFDEM_ADD_LIBS =\n\n# additional static libraries to be linked to lagrangian library\nCFDEM_ADD_STATICLIBS = \\\n\n# include flags for compiling with SQ\ninclude $(CFDEM_ADD_LIBS_DIR)/additionalLibs_superquadric\n\n#################################################################\n## SETTINGS FOR 5.x ##\n#################################################################\n#----------------------------------------------------------------\n# incompressible turbulence model settings\n#----------------------------------------------------------------\n# paths for incompressible turbulence models to use\nCFDEM_ADD_INCOMPTURBMOD_PATHS = \\\n-I$(LIB_SRC)/TurbulenceModels/turbulenceModels/lnInclude \\\n-I$(LIB_SRC)/TurbulenceModels/incompressible/lnInclude \\\n-I$(LIB_SRC)/fvOptions/lnInclude \\\n\n# libs for turbulence models to use\nCFDEM_ADD_INCOMPTURBMOD_LIBS = \\\n-lturbulenceModels \\\n-lincompressibleTurbulenceModels \\\n-lfvOptions \\\n\nCFDEM_TRI_SURF = \\\n-ltriSurface\n\nCFDEM_SPRAY_LIBS = \\\n -lthermophysicalProperties \\\n\n#----------------------------------------------------------------\n# compressible turbulence model settings\n#----------------------------------------------------------------\n# paths for compressible turbulence models to use\nCFDEM_ADD_COMPTURBMOD_PATHS = \\\n-I$(LIB_SRC)/TurbulenceModels/turbulenceModels/lnInclude \\\n-I$(LIB_SRC)/TurbulenceModels/compressible/lnInclude \\\n-I$(LIB_SRC)/transportModels/compressible/lnInclude \\\n-I$(LIB_SRC)/thermophysicalModels/radiation/lnInclude \\\n\n# libs for turbulence models to use\nCFDEM_ADD_COMPTURBMOD_LIBS = \\\n-lturbulenceModels \\\n-lcompressibleTurbulenceModels \\\n#################################################################\n" }, { "path": "src/lagrangian/cfdemParticle/etc/addLibs_universal/additionalLibs_6", "content": "# Specify additional include and library paths, as well as libraries for the compilation\n#\n# CFDEM_ADD_INC =\n# CFDEM_ADD_LIB_PATHS =\n# CFDEM_ADD_LIBS =\n\n# additional static libraries to be linked to lagrangian library\nCFDEM_ADD_STATICLIBS = \\\n\n# include flags for compiling with SQ\ninclude $(CFDEM_ADD_LIBS_DIR)/additionalLibs_superquadric\n\n#################################################################\n## SETTINGS FOR 6.x ##\n#################################################################\n#----------------------------------------------------------------\n# incompressible turbulence model settings\n#----------------------------------------------------------------\n# paths for incompressible turbulence models to use\nCFDEM_ADD_INCOMPTURBMOD_PATHS = \\\n-I$(CFDEM_LIB_DIR)/../include \\\n-I$(LIB_SRC)/TurbulenceModels/turbulenceModels/lnInclude \\\n-I$(LIB_SRC)/TurbulenceModels/incompressible/lnInclude \\\n-I$(LIB_SRC)/fvOptions/lnInclude \\\n\n# libs for turbulence models to use\nCFDEM_ADD_INCOMPTURBMOD_LIBS = \\\n-L$(CFDEM_LIB_DIR)/../lib \\\n-lturbulenceModels \\\n-lincompressibleTurbulenceModels \\\n-lfvOptions \\\n\nCFDEM_TRI_SURF = \\\n-ltriSurface\n\nCFDEM_SPRAY_LIBS = \\\n -lthermophysicalProperties \\\n\n#----------------------------------------------------------------\n# compressible turbulence model settings\n#----------------------------------------------------------------\n# paths for compressible turbulence models to use\nCFDEM_ADD_COMPTURBMOD_PATHS = \\\n-I$(CFDEM_LIB_DIR)/../include \\\n-I$(LIB_SRC)/TurbulenceModels/turbulenceModels/lnInclude \\\n-I$(LIB_SRC)/TurbulenceModels/compressible/lnInclude \\\n-I$(LIB_SRC)/transportModels/compressible/lnInclude \\\n-I$(LIB_SRC)/thermophysicalModels/radiation/lnInclude \\\n\n# libs for turbulence models to use\nCFDEM_ADD_COMPTURBMOD_LIBS = \\\n-L$(CFDEM_LIB_DIR)/../lib \\\n-lturbulenceModels \\\n-lcompressibleTurbulenceModels \\\n#################################################################\n" }, { "path": "src/lagrangian/cfdemParticle/etc/addLibs_universal/additionalLibs_solver", "content": "ifdef CFDEM_LIGGGHTS_MAKEFILE_POSTFIX\n ifneq ($(CFDEM_LIGGGHTS_MAKEFILE_POSTFIX),)\n sinclude $(CFDEM_LIGGGHTS_SRC_DIR)/MAKE/Makefile.auto.options_$(CFDEM_LIGGGHTS_MAKEFILE_POSTFIX)\n else\n sinclude $(CFDEM_LIGGGHTS_SRC_DIR)/MAKE/Makefile.auto.options\n endif\nelse\n sinclude $(CFDEM_LIGGGHTS_SRC_DIR)/MAKE/Makefile.auto.options\nendif\nifdef OPTIONS_EXTRA_RPATH\n PFLAGS+=$(OPTIONS_EXTRA_RPATH)\nendif\n$(info OPTIONS_EXTRA_RPATH = $(OPTIONS_EXTRA_RPATH))\n" }, { "path": "src/lagrangian/cfdemParticle/etc/addLibs_universal/additionalLibs_superquadric", "content": "ifdef CFDEM_LIGGGHTS_MAKEFILE_POSTFIX\n ifneq ($(CFDEM_LIGGGHTS_MAKEFILE_POSTFIX),)\n sinclude $(CFDEM_LIGGGHTS_SRC_DIR)/MAKE/Makefile.user_$(CFDEM_LIGGGHTS_MAKEFILE_POSTFIX)\n else\n sinclude $(CFDEM_LIGGGHTS_SRC_DIR)/MAKE/Makefile.user\n endif\nelse\n sinclude $(CFDEM_LIGGGHTS_SRC_DIR)/MAKE/Makefile.user\nendif\nifeq ($(USE_SUPERQUADRICS), \"ON\")\n PFLAGS+=-DSUPERQUADRIC_ACTIVE_FLAG -DNONSPHERICAL_ACTIVE_FLAG\nendif\n" }, { "path": "src/lagrangian/cfdemParticle/etc/addLibs_universal/additionalLibs_v1606+", "content": "# Specify additional include and library paths, as well as libraries for the compilation\n#\n#CFDEM_ADD_INC = \\\n#CFDEM_ADD_LIB_PATHS = \\\n#CFDEM_ADD_LIBS = \\\n\n# additional static libraries to be linked to lagrangian library\nCFDEM_ADD_STATICLIBS = \\\n\n# include flags for compiling with SQ\ninclude $(CFDEM_ADD_LIBS_DIR)/additionalLibs_superquadric\n\n#################################################################\n## SETTINGS FOR 3.0.x ##\n#################################################################\n#----------------------------------------------------------------\n# incompressible turbulence model settings\n#----------------------------------------------------------------\n# paths for incompressible turbulence models to use\nCFDEM_ADD_INCOMPTURBMOD_PATHS = \\\n-I$(LIB_SRC)/TurbulenceModels/turbulenceModels/lnInclude \\\n-I$(LIB_SRC)/TurbulenceModels/incompressible/lnInclude \\\n-I$(LIB_SRC)/fvOptions/lnInclude \\\n\n# libs for turbulence models to use\nCFDEM_ADD_INCOMPTURBMOD_LIBS = \\\n-lturbulenceModels \\\n-lincompressibleTurbulenceModels \\\n-lfvOptions \\\n\nCFDEM_TRI_SURF = \\\n-ltriSurface\n\nCFDEM_SPRAY_LIBS = \\\n -lliquidProperties \\\n -lliquidMixtureProperties \\\n -lsolidProperties \\\n -lsolidMixtureProperties \\\n -lthermophysicalFunctions \n\n#----------------------------------------------------------------\n# compressible turbulence model settings\n#----------------------------------------------------------------\n# paths for compressible turbulence models to use\nCFDEM_ADD_COMPTURBMOD_PATHS = \\\n-I$(LIB_SRC)/TurbulenceModels/turbulenceModels/lnInclude \\\n-I$(LIB_SRC)/TurbulenceModels/compressible/lnInclude \\\n-I$(LIB_SRC)/transportModels/compressible/lnInclude \\\n-I$(LIB_SRC)/thermophysicalModels/radiation/lnInclude \\\n\n# libs for turbulence models to use\nCFDEM_ADD_COMPTURBMOD_LIBS = \\\n-lturbulenceModels \\\n-lcompressibleTurbulenceModels \\\n#################################################################\n" }, { "path": "src/lagrangian/cfdemParticle/etc/addLibs_universal/additionalLibs_v1612+", "content": "# Specify additional include and library paths, as well as libraries for the compilation\n#\n#CFDEM_ADD_INC = \\\n#CFDEM_ADD_LIB_PATHS = \\\n#CFDEM_ADD_LIBS = \\\n\n# additional static libraries to be linked to lagrangian library\nCFDEM_ADD_STATICLIBS = \\\n\n# include flags for compiling with SQ\ninclude $(CFDEM_ADD_LIBS_DIR)/additionalLibs_superquadric\n\n#################################################################\n## SETTINGS FOR 3.0.x ##\n#################################################################\n#----------------------------------------------------------------\n# incompressible turbulence model settings\n#----------------------------------------------------------------\n# paths for incompressible turbulence models to use\nCFDEM_ADD_INCOMPTURBMOD_PATHS = \\\n-I$(LIB_SRC)/TurbulenceModels/turbulenceModels/lnInclude \\\n-I$(LIB_SRC)/TurbulenceModels/incompressible/lnInclude \\\n-I$(LIB_SRC)/fvOptions/lnInclude \\\n\n# libs for turbulence models to use\nCFDEM_ADD_INCOMPTURBMOD_LIBS = \\\n-lturbulenceModels \\\n-lincompressibleTurbulenceModels \\\n-lfvOptions \\\n\nCFDEM_TRI_SURF = \\\n-ltriSurface\n\nCFDEM_SPRAY_LIBS = \\\n -lliquidProperties \\\n -lliquidMixtureProperties \\\n -lsolidProperties \\\n -lsolidMixtureProperties \\\n -lthermophysicalFunctions \n\n#----------------------------------------------------------------\n# compressible turbulence model settings\n#----------------------------------------------------------------\n# paths for compressible turbulence models to use\nCFDEM_ADD_COMPTURBMOD_PATHS = \\\n-I$(LIB_SRC)/TurbulenceModels/turbulenceModels/lnInclude \\\n-I$(LIB_SRC)/TurbulenceModels/compressible/lnInclude \\\n-I$(LIB_SRC)/transportModels/compressible/lnInclude \\\n-I$(LIB_SRC)/thermophysicalModels/radiation/lnInclude \\\n\n# libs for turbulence models to use\nCFDEM_ADD_COMPTURBMOD_LIBS = \\\n-lturbulenceModels \\\n-lcompressibleTurbulenceModels \\\n#################################################################\n" }, { "path": "src/lagrangian/cfdemParticle/etc/bashrc", "content": "#----------------------------------*-sh-*--------------------------------------\n# CFDEMcoupling\n# Christoph Goniva\n# June 2012\n#------------------------------------------------------------------------------\n#\n# Script\n# etc/bashrc\n#\n# Description\n# Startup file for cfdem exporting environment variables\n# Sourced ~/.bashrc\n#\n#- add this block to your ~/.bashrc and modify for your installation\n#- you can test the correctness using cfdemSystemTest.sh\n\n## STANDARD BLOCK FOR REGULAR INSTALLATIONS\n##================================================#\n##- source cfdem env vars\n#export CFDEM_VERSION=PUBLIC\n#export CFDEM_PROJECT_DIR=$HOME/CFDEM/CFDEMcoupling-$CFDEM_VERSION-$WM_PROJECT_VERSION\n#export CFDEM_PROJECT_USER_DIR=$HOME/CFDEM/$LOGNAME-$CFDEM_VERSION-$WM_PROJECT_VERSION\n#export CFDEM_bashrc=$CFDEM_PROJECT_DIR/src/lagrangian/cfdemParticle/etc/bashrc\n#export CFDEM_LIGGGHTS_SRC_DIR=$HOME/LIGGGHTS/LIGGGHTS-PUBLIC/src\n#export CFDEM_LIGGGHTS_MAKEFILE_NAME=auto\n#export CFDEM_LPP_DIR=$HOME/LIGGGHTS/mylpp/src\n#. $CFDEM_bashrc\n#================================================#\n#------------------------------------------------------------------------------\n\n\n## EXTENDED BLOCK FOR HIGHLY CUSTOMIZED INSTALLATIONS\n## you may insert this right above \". $CFDEM_bashrc\"\n##================================================#\n#export CFDEM_SRC_DIR=$CFDEM_PROJECT_DIR/src\n#export CFDEM_SOLVER_DIR=$CFDEM_PROJECT_DIR/applications/solvers\n#export CFDEM_DOC_DIR=$CFDEM_PROJECT_DIR/doc\n#export CFDEM_UT_DIR=$CFDEM_PROJECT_DIR/applications/utilities\n#export CFDEM_TUT_DIR=$CFDEM_PROJECT_DIR/tutorials\n#export CFDEM_LIGGGHTS_MAKEFILE_POSTIFX=\n#export CFDEM_VERBOSE=false\n#================================================#\n\n#------------------------------------------------------------------------------\n#- export environment variables (adapt to your paths)\n#------------------------------------------------------------------------------\n\nif [[ $CFDEM_SCHEMEMODE == \"\" ]]; then export CFDEM_SCHEMEMODE=robust; fi\n\n## small function defs\naddPath()\n{\nfor path in \"$@\"; do\n export PATH=\"$path\":\"$PATH\"\ndone\n}\n\naddLDLib()\n{\nfor path in \"$@\"; do\n export LD_LIBRARY_PATH=\"$path\":\"$LD_LIBRARY_PATH\"\ndone\n}\n\ncfdemecho()\n{\nif [[ ! $CFDEM_VERBOSE == \"false\" ]]; then echo \"$1\"; fi\n}\n\nsetVar()\n{\nvarCont=$(eval echo \\$$1)\nif [[ \"$varCont\" == \"\" ]]; then\n eval export $1=\"$2\"\n cfdemecho \"using default $1 = $2\"\nelse\n cfdemecho \"using userdefined $1 = $varCont\"\nfi\n}\n\ncfdemecho \"************************************\"\nsetVar CFDEM_SRC_DIR $CFDEM_PROJECT_DIR/src\nsetVar CFDEM_SOLVER_DIR $CFDEM_PROJECT_DIR/applications/solvers\nsetVar CFDEM_DOC_DIR $CFDEM_PROJECT_DIR/doc\nsetVar CFDEM_UT_DIR $CFDEM_PROJECT_DIR/applications/utilities\nsetVar CFDEM_TUT_DIR $CFDEM_PROJECT_DIR/tutorials\nsetVar CFDEM_RHEO_DIR $WM_PROJECT_DIR/../ViscoElastic/of60\nsetVar CFDEM_RHEO_LIB_DIR $FOAM_USER_LIBBIN\n\n#check if default lammps lib path should be used\nsetVar CFDEM_LAMMPS_LIB_DIR $CFDEM_LIGGGHTS_SRC_DIR/../lib\n\n#test CFDEM_LAMMPS_LIB_DIR\nif [ -f \"$CFDEM_LAMMPS_LIB_DIR/poems/Makefile.lammps\" ]; then\n :\nelse\n echo \"\"\n echo \" !!! WARNING CFDEM_LAMMPS_LIB_DIR = $CFDEM_LAMMPS_LIB_DIR seems to be wrong !!!\"\n echo \"\"\nfi\n\n#- LIGGGHTS lib name\nif [[ $CFDEM_LIGGGHTS_MAKEFILE_NAME == \"auto\" ]] && [[ $CFDEM_LIGGGHTS_MAKEFILE_POSTFIX != \"\" ]] ; then\n export CFDEM_LIGGGHTS_LIB_NAME=\"lmp_\"$CFDEM_LIGGGHTS_MAKEFILE_NAME\"_\"$CFDEM_LIGGGHTS_MAKEFILE_POSTFIX\nelse\n export CFDEM_LIGGGHTS_LIB_NAME=lmp_$CFDEM_LIGGGHTS_MAKEFILE_NAME\nfi\n\nif [[ ${WM_COMPILE_OPTION} == \"Debug\" ]] && [[ $CFDEM_LIGGGHTS_MAKEFILE_NAME == \"auto\" ]]; then\n export CFDEM_LIGGGHTS_LIB_NAME=\"${CFDEM_LIGGGHTS_LIB_NAME}-fulldebug\"\nfi\n\n#- LIGGGHTS lib path\nsetVar CFDEM_LIGGGHTS_MAKEFILE_NAME \"auto\"\nsetVar CFDEM_LIGGGHTS_LIB_PATH $CFDEM_LIGGGHTS_SRC_DIR\n\n#- LIGGGHTS executable\nexport CFDEM_LIGGGHTS_EXEC=$CFDEM_LIGGGHTS_LIB_PATH/$CFDEM_LIGGGHTS_LIB_NAME\n\n#- CFDEM lib name\nexport CFDEM_LIB_NAME=lagrangianCFDEM-$CFDEM_VERSION-$WM_PROJECT_VERSION\n\n#- CFDEM compressible lib name\nexport CFDEM_LIB_COMP_NAME=lagrangianCFDEMcomp-$CFDEM_VERSION-$WM_PROJECT_VERSION\n\n#check if additional libraries should be compiled together with solvers\nsetVar CFDEM_ADD_LIBS_DIR $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/addLibs_universal\nsetVar CFDEM_ADD_LIBS_NAME additionalLibs_$WM_PROJECT_VERSION\n\n# check addLibs path and file name\nif [[ ! -f $CFDEM_ADD_LIBS_DIR/$CFDEM_ADD_LIBS_NAME ]]; then\n echo \"!!! ERROR !!!: CFDEM_ADD_LIBS_DIR/CFDEM_ADD_LIBS_NAME=$CFDEM_ADD_LIBS_DIR/$CFDEM_ADD_LIBS_NAME does not exist.\"\nfi\n\n#-----------------------------------------------------\n# additional libraries\n\n#- LMP Many2Many lib path and makefile\nexport CFDEM_Many2ManyLIB_PATH=$CFDEM_SRC_DIR/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayMany2Many/library\nexport CFDEM_Many2ManyLIB_MAKEFILENAME=$CFDEM_LIGGGHTS_MAKEFILE_NAME\n\n#- LMP M2M lib path and makefile\nexport CFDEM_M2MLIB_PATH=$CFDEM_SRC_DIR/lagrangian/cfdemParticle/subModels/dataExchangeModel/M2M/library\nsetVar CFDEM_M2MLIB_MAKEFILENAME $CFDEM_LIGGGHTS_MAKEFILE_NAME\n\n#- LMP M2MMS lib path and makefile\nexport CFDEM_M2MMSLIB_PATH=$CFDEM_SRC_DIR/lagrangian/cfdemParticle/subModels/dataExchangeModel/M2M/library\nexport CFDEM_M2MMSLIB_MAKEFILENAME=$CFDEM_LIGGGHTS_MAKEFILE_NAME\n\n#- socketLib lib path and makefile\nexport CFDEM_socketLibLIB_PATH=$CFDEM_SRC_DIR/CoSimProtocols/socketLib\nexport CFDEM_socketLibLIB_MAKEFILENAME=script\n\n#- LMP POEMS lib default path\nexport CFDEM_POEMSLIB_PATH=$CFDEM_LAMMPS_LIB_DIR/poems\n#-----------------------------------------------------\n\n#- path to test harness\nexport CFDEM_TEST_HARNESS_PATH=$CFDEM_PROJECT_USER_DIR/log/logFilesCFDEM-$CFDEM_VERSION-$WM_PROJECT_VERSION\n\n#- path to libraries\n# check if pathes are already set automatically\nsetVar CFDEM_LIB_DIR $CFDEM_PROJECT_DIR/platforms/$WM_OPTIONS/lib\nsetVar CFDEM_USER_LIB_DIR $CFDEM_PROJECT_USER_DIR/platforms/$WM_OPTIONS/lib\n\naddLDLib \"$CFDEM_LIB_DIR\" \"$CFDEM_USER_LIB_DIR\"\n\n#- path to apps\nsetVar CFDEM_APP_DIR $CFDEM_PROJECT_DIR/platforms/$WM_OPTIONS/bin\nsetVar CFDEM_USER_APP_DIR $CFDEM_PROJECT_USER_DIR/platforms/$WM_OPTIONS/bin\n\naddPath \"$CFDEM_APP_DIR\" \"$CFDEM_USER_APP_DIR\"\n\n#- path to OF version flag file\nexport CFDEM_OFVERSION_DIR=$CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/OFversion\n#------------------------------------------------------------------------------\n#- settings for lpp postproc tool\n#------------------------------------------------------------------------------\n\n#- nr of procs for lpp tool\nexport CFDEM_LPP_NPROCS=1\n\n#- nr of procs for lpp tool\nexport CFDEM_LPP_CHUNKSIZE=1\n\n#- shortcut to run lpp\nalias cfdemLpp='python -i $CFDEM_LPP_DIR/lpp.py --cpunum $CFDEM_LPP_NPROCS --chunksize $CFDEM_LPP_CHUNKSIZE'\n\n#------------------------------------------------------------------------------\n#- aliases for easy navigation (no changes necessary)\n#------------------------------------------------------------------------------\n#- shortcut to cfdem path\nalias cfdem='cd $CFDEM_PROJECT_DIR'\n\n#- shortcut to src path\nalias cfdemSrc='cd $CFDEM_SRC_DIR'\n\n#- shortcut to etc path\nalias cfdemEtc='cd $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc'\n\n#- shortcut to tutorial path\nalias cfdemTut='cd $CFDEM_TUT_DIR'\n\n#- shortcut to solver path\nalias cfdemSol='cd $CFDEM_SOLVER_DIR'\n\n#- shortcut to utilities path\nalias cfdemUt='cd $CFDEM_UT_DIR'\n\n#- shortcut to run path\nalias cfdemRun='cd $CFDEM_PROJECT_USER_DIR/run'\n\n#- shortcut to user solver path\nalias cfdemUsrSol='cd $CFDEM_PROJECT_USER_DIR/applications/solvers'\n\n#- shortcut to documentation path\nalias cfdemDoc='cd $CFDEM_DOC_DIR'\n\n#- shortcut to open the doxygen with firefox\nalias cfdemDox='firefox $CFDEM_DOC_DIR/doxygen/html/index.html'\n\n#- shortcut to LIGGGHTS path\nalias cfdemLIG='cd $CFDEM_LIGGGHTS_SRC_DIR'\n\n#- shortcut to system test\nalias cfdemSysTest='bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/cfdemSystemTest.sh'\n\n#- shortcut to pull LIGGGHTS\nalias cfdemPullLIG='bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/pullLIGGGHTS.sh'\n\n#- shortcut to pull CFDEMcoupling\nalias cfdemPullCFDEMcoupling='bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/pullCFDEMcoupling.sh'\n\n#- shortcut to clean CFDEM\nalias cfdemCleanCFDEM='bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/cleanCFDEMcoupling.sh'\n\n#- shortcut to compile LIGGGHTS + sublibraries\nalias cfdemCompLIG='bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileLIGGGHTS.sh'\n\n#- shortcut to compile LIGGGHTS' sublibraries\nalias cfdemCompLIGlibs='bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileLIGGGHTS_lib.sh'\n\n#- shortcut to compile CFDEMcoupling +LIGGGHTS\nalias cfdemCompCFDEMall='bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_all.sh'\n\n#- shortcut to compile CFDEMcoupling (src+solvers)\nalias cfdemCompCFDEM='bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling.sh'\n\n#- shortcut to compile CFDEMcoupling src\nalias cfdemCompCFDEMsrc='bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_src.sh'\n\n#- shortcut to compile CFDEMcoupling solvers\nalias cfdemCompCFDEMsol='bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_sol.sh'\n\n#- shortcut to compile CFDEMcoupling utilities\nalias cfdemCompCFDEMuti='bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_uti.sh'\n\n#- shortcut to test basic tutorials\nalias cfdemTestTUT='bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/testTutorials.sh'\n\n#- refresh link to LIGGGHTS binary\nalias cfdemRefreshLigLink='ln -sf $CFDEM_LIGGGHTS_LIB_PATH/lib$CFDEM_LIGGGHTS_LIB_NAME.so $CFDEM_LIB_DIR'\n\n#- shortcut to change dictionaries according to OF version\ncfdemChangeTutOFversion() { bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/OFVersionChange/shellScripts/cfdemChangeTutOFversion_all.sh $1; }\nexport -f cfdemChangeTutOFversion\n\n#- shortcut to use script for changing integrator and force coupling syntax\nintegratorAndCouplingStyleChange() { bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/OFVersionChange/shellScripts/integratorAndCouplingStyleChange.sh; }\nexport -f integratorAndCouplingStyleChange\n\n#- shortcut to visualize the clock model data\nalias vizClock='python $CFDEM_UT_DIR/vizClock/matPlot.py'\n\n#- recursive touch of current directory\nalias touchRec='find ./* -exec touch {} \\;'\n\n#- shortcut to run liggghts in serial\ncfdemLiggghts() { $CFDEM_LIGGGHTS_EXEC -in $1; }\nexport -f cfdemLiggghts\n\n#- shortcut to run liggghts in parallel\ncfdemLiggghtsPar() { mpirun -np $2 $CFDEM_LIGGGHTS_EXEC -in $1; }\nis_openmpi=`mpirun -version | grep \"Open MPI\" | wc -l`\n# Open MPI (version > 3) no longer allows oversubscription by default, we do want that though\nif [[ $is_openmpi == 1 ]]; then\n cfdemLiggghtsPar() { mpirun -oversubscribe -np $2 $CFDEM_LIGGGHTS_EXEC -in $1; }\nfi\nunset is_openmpi\nexport -f cfdemLiggghtsPar\n\n#- shortcut to open files including a pattern\ncfdemGrep() { grep -rl \"$1\" ./* | xargs gedit; }\nexport -f cfdemGrep\n\n#- shortcut lo list files in a directory\n#cfdemListFiles() { find $1 | sed s:\"\"$1\"\":: > listOfFiles.txt; } #leave out the dir iteslf in list\ncfdemListFiles() { find $1 > listOfFiles.txt; } #keep the dir in list\nexport -f cfdemListFiles\n\n#- function to unload environment, everything starting with CFDEM_ and containing cfdem\ncfdemUnsetEnv() { unset cfdemLiggghts cfdemLiggghtsPar cfdemGrep cfdemListFiles cfdemChangeTutOFversion cfdemUnsetEnv integratorAndCouplingStyleChange;\n cfdemDirs=\"$CFDEM_PROJECT_DIR $CFDEM_LIB_DIR $CFDEM_USER_LIB_DIR $CFDEM_APP_DIR $CFDEM_USER_APP_DIR\";\n foamClean=$WM_PROJECT_DIR/bin/foamCleanPath;\n cleaned=$($foamClean \"$PATH\" \"$cfdemDirs\") && PATH=\"$cleaned\";\n cleaned=$($foamClean \"$LD_LIBRARY_PATH\" \"$cfdemDirs\") && LD_LIBRARY_PATH=\"$cleaned\";\n unset $(env | grep \"CFDEM_\" |awk -F'=' '{print $1}');\n unalias $(env | grep \"cfdem\" |awk -F'=' '{print $1}');\n unset foamClean cleaned; }\n\nexport -f cfdemUnsetEnv\n\n# check if the run directory exists\nif [ -d \"$CFDEM_PROJECT_USER_DIR\" ]; then\n :\nelse\n echo \"make new dirs $CFDEM_PROJECT_USER_DIR ? (y/n)\"\n read YN\n if [ $YN == \"y\" ]; then\n mkdir -p $CFDEM_PROJECT_USER_DIR\n cd $CFDEM_PROJECT_USER_DIR\n mkdir run\n mkdir -p log/logFilesCFDEM-$CFDEM_VERSION-$WM_PROJECT_VERSION\n mkdir -p applications/solvers\n mkdir -p $CFDEM_LIB_DIR\n mkdir -p $CFDEM_USER_LIB_DIR\n mkdir -p $CFDEM_APP_DIR\n mkdir -p $CFDEM_USER_APP_DIR\n else\n echo \"aborted by user.\"\n #exit\n fi\nfi\n\n# set thermophysical library version to 6, overwrite if OF5\nsetVar CFDEM_THERMOPHYSICAL_VERSION 6\n\n# detect OF version\nif [[ $WM_PROJECT_VERSION == 6 ]]; then\n export CFDEM_WM_PROJECT_VERSION=60\nelif [[ $WM_PROJECT_VERSION == 5.* ]]; then\n export CFDEM_WM_PROJECT_VERSION=50\n cfdemecho \"************************************\"\n cfdemecho \"WARNING from your CFDEM code!\"\n cfdemecho \"WARNING: Coupling with your OpenFOAM(R) version is not officially supported!\"\n cfdemecho \"In doubt switch to OpenFOAM(R) 6.\"\n cfdemecho \"************************************\"\n setVar CFDEM_THERMOPHYSICAL_VERSION 5.x\n sleep 1.5\nelif [[ $WM_PROJECT_VERSION == 4.* ]]; then\n export CFDEM_WM_PROJECT_VERSION=40\n cfdemecho \"************************************\"\n cfdemecho \"WARNING from your CFDEM code!\"\n cfdemecho \"WARNING: Coupling with your OpenFOAM(R) version is not officially supported!\"\n cfdemecho \"In doubt switch to OpenFOAM(R) 6.\"\n cfdemecho \"************************************\"\n sleep 1.5\nelif [[ $WM_PROJECT_VERSION == 3.0.* ]]; then\n export CFDEM_WM_PROJECT_VERSION=30\n cfdemecho \"************************************\"\n cfdemecho \"WARNING from your CFDEM code!\"\n cfdemecho \"WARNING: Coupling with your OpenFOAM(R) version is not officially supported!\"\n cfdemecho \"In doubt switch to OpenFOAM(R) 6.\"\n cfdemecho \"************************************\"\n sleep 1.5\nelif [[ $WM_PROJECT_VERSION == v1606+ ]]; then \n export CFDEM_WM_PROJECT_VERSION=1606\n cfdemecho \"************************************\"\n cfdemecho \"WARNING from your CFDEM code!\"\n cfdemecho \"WARNING: Coupling with your OpenFOAM(R) version is not officially supported!\"\n cfdemecho \"In doubt switch to OpenFOAM(R) 6.\"\n cfdemecho \"************************************\"\n sleep 1.5\nelif [[ $WM_PROJECT_VERSION == v1612+ ]]; then \n export CFDEM_WM_PROJECT_VERSION=1612\n cfdemecho \"************************************\"\n cfdemecho \"WARNING from your CFDEM code!\"\n cfdemecho \"WARNING: Coupling with your OpenFOAM(R) version is not officially supported!\"\n cfdemecho \"In doubt switch to OpenFOAM(R) 6.\"\n cfdemecho \"************************************\"\n sleep 1.5\nelif [[ $WM_PROJECT_VERSION == v1706 ]]; then \n export CFDEM_WM_PROJECT_VERSION=1706\n cfdemecho \"************************************\"\n cfdemecho \"WARNING from your CFDEM code!\"\n cfdemecho \"WARNING: Coupling with your OpenFOAM(R) version is not officially supported!\"\n cfdemecho \"In doubt switch to OpenFOAM(R) 6.\"\n cfdemecho \"************************************\"\n sleep 1.5\nelif [[ $WM_PROJECT_VERSION == 2.4.* ]]; then\n export CFDEM_WM_PROJECT_VERSION=24\n cfdemecho \"************************************\"\n cfdemecho \"WARNING from your CFDEM code!\"\n cfdemecho \"WARNING: Coupling with your OpenFOAM(R) version is not officially supported!\"\n cfdemecho \"In doubt switch to OpenFOAM(R) 6.\"\n cfdemecho \"************************************\"\n sleep 1.5\nelif [[ $WM_PROJECT_VERSION == \"3.2\" && $WM_FORK == \"extend\" ]]; then\n export CFDEM_WM_PROJECT_VERSION=132\n cfdemecho \"************************************\"\n cfdemecho \"WARNING from your CFDEM code!\"\n cfdemecho \"WARNING: Coupling with your OpenFOAM(R) version is not officially supported!\"\n cfdemecho \"In doubt switch to OpenFOAM(R) 6.\"\n cfdemecho \"************************************\"\n sleep 1.5\nelse\n clear\n cfdemecho \"************************************\"\n cfdemecho \"ERROR from your CFDEM code!\"\n cfdemecho \"ERROR: your OpenFOAM(R) version is not supported!\"\n cfdemecho \"Please use a version that is supported, i.e., see the bashrc file in the source directory!\"\n cfdemecho \"************************************\"\n sleep 1.5\nfi\n\ncfdemecho \"************************************\"\n\nunset addPath addLDLib cfdemecho setVar\n" }, { "path": "src/lagrangian/cfdemParticle/etc/cfdemSystemTest.sh", "content": "#!/bin/bash\n\n#===================================================================#\n# sytsem settings test routine for cfdem project \n# Christoph Goniva - May. 2011, DCS Computing GmbH\n#===================================================================#\n\n#- include functions\nsource $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/functions.sh\n\n#- show gcc settings\ncheckGPP=\"true\"\n\n#- sys check for add on\ncheckAddOn=\"false\"\n\n#- system settings\nprintHeader\n\necho \"*********************************\"\necho \"CFDEM(R)coupling system settings:\"\necho \"*********************************\"\n\necho \"CFDEM_VERSION=$CFDEM_VERSION\"\necho \"couple to OF_VERSION=$WM_PROJECT_VERSION\"\necho \"compile option=$WM_COMPILE_OPTION\"\n\n\necho\necho \"check if paths are set correctly\"\ncheckDirComment \"$CFDEM_PROJECT_DIR\" '$CFDEM_PROJECT_DIR' \"yes\"\ncheckDirComment \"$CFDEM_PROJECT_USER_DIR\" '$CFDEM_PROJECT_USER_DIR' \"no\"\ncheckDirComment \"$CFDEM_SRC_DIR\" '$CFDEM_SRC_DIR' \"yes\"\ncheckDirComment \"$CFDEM_SOLVER_DIR\" '$CFDEM_SOLVER_DIR' \"yes\"\ncheckDirComment \"$CFDEM_TUT_DIR\" '$CFDEM_TUT_DIR' \"yes\"\ncheckDirComment \"$CFDEM_LIGGGHTS_SRC_DIR\" '$CFDEM_LIGGGHTS_SRC_DIR' \"yes\"\ncheckDirComment \"$CFDEM_LIGGGHTS_LIB_PATH\" '$CFDEM_LIGGGHTS_LIB_PATH' \"yes\"\ncheckDirComment \"$CFDEM_ADD_LIBS_DIR\" '$CFDEM_ADD_LIBS_DIR' \"yes\"\ncheckDirComment \"$CFDEM_LIB_DIR\" '$CFDEM_LIB_DIR' \"yes\"\ncheckDirComment \"$CFDEM_APP_DIR\" '$CFDEM_APP_DIR' \"yes\"\ncheckDirComment \"$CFDEM_USER_LIB_DIR\" '$CFDEM_USER_LIB_DIR' \"no\"\ncheckDirComment \"$CFDEM_USER_APP_DIR\" '$CFDEM_USER_APP_DIR' \"no\"\ncheckDirComment \"$CFDEM_TEST_HARNESS_PATH\" '$CFDEM_TEST_HARNESS_PATH' \"no\"\ncheckDirComment \"$C3PO_SRC_DIR\" '$C3PO_SRC_DIR' \"no\"\ncheckDirComment \"$CFDEM_LPP_DIR\" '$CFDEM_LPP_DIR' \"no\"\necho \"\"\n\necho \"library names\"\necho '$CFDEM_LIGGGHTS_LIB_NAME = '\"$CFDEM_LIGGGHTS_LIB_NAME\"\necho '$CFDEM_LIB_NAME = '\"$CFDEM_LIB_NAME\"\necho '$LD_LIBRARY_PATH = '\"$LD_LIBRARY_PATH\"\necho '$WM_NCOMPPROCS = '\"$WM_NCOMPPROCS\"\necho '$WM_LABEL_SIZE = '\"$WM_LABEL_SIZE\"\nif [ $WM_LABEL_SIZE != 32 ]; then\n echo \"!!!! Warning: WM_LABEL_SIZE must be 32!!!!! (Please correct in $FOAM_ETC/bashrc.)\"\nfi\necho \"\"\necho \"Additional lib settings\"\necho 'CFDEM_ADD_LIBS_DIR/CFDEM_ADD_LIBS_NAME = '\"${CFDEM_ADD_LIBS_DIR}/${CFDEM_ADD_LIBS_NAME}\"\ncat < .Makefile_vtk_tmp\ninclude $CFDEM_ADD_LIBS_DIR/$CFDEM_ADD_LIBS_NAME\n\n.PHONY: all\n\nall:\n\t@echo \"CFDEM_ADD_LIB_PATHS = \\$(CFDEM_ADD_LIB_PATHS)\"\n\t@echo \"CFDEM_ADD_LIBS = \\$(CFDEM_ADD_LIBS)\"\nEOT\nmake -f .Makefile_vtk_tmp\nrm -f .Makefile_vtk_tmp\necho\n\necho \"LIGGGHTS library link (created during compilation of CFDEM)\"\nls -al ${CFDEM_LIB_DIR}/liblmp*\n\necho \"*******************\"\n\n\nif [ $checkGPP == \"true\" ]\n then\n echo \"g++:\"\n which g++\n g++ --version\n\n echo \"gcc:\"\n which gcc\n gcc --version\n\n echo \"mpic++:\"\n which mpic++\n mpic++ --version\n\n echo \"mpirun:\"\n which mpirun\n mpirun --version\nfi\n\necho \"**********************\"\necho \"additional packages...\"\n\nif [ $checkAddOn == \"true\" ]\n then\n packageName=c3po\n filePath=$CFDEM_SRC_DIR/$packageName\n if [ $(checkDir $filePath) == \"true\" ]; then\n source $filePath/etc/$packageName\"SystemTest.sh\"\n else\n echo \"$packageName does not exist.\" \n fi\n\n packageName=parScale\n filePath=$PASCAL_SRC_DIR/..\n if [ $(checkDir $filePath) == \"true\" ]; then\n source $filePath/etc/$packageName\"SystemTest.sh\"\n else\n echo \"$packageName does not exist.\" \n fi\nfi\n" }, { "path": "src/lagrangian/cfdemParticle/etc/cleanCFDEMcoupling.sh", "content": "#!/bin/bash\n\n#===================================================================#\n# clean routine for CFDEMcoupling, part of CFDEMproject \n# Christoph Goniva - Sept. 2013, DCS Computing GmbH\n#===================================================================#\n\n#- include functions\nsource $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/functions.sh\n\n#================================================================================#\n# clean src remove object files\n#================================================================================#\ncleanCFDEM\n\n" }, { "path": "src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling.sh", "content": "#!/bin/bash\n\n#===================================================================#\n# compile routine for CFDEMcoupling, part of CFDEMproject \n# Christoph Goniva - May. 2012, DCS Computing GmbH\n#===================================================================#\n\n#- include functions\nsource $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/functions.sh\n\nNOW=\"$(date +\"%Y-%m-%d-%H:%M\")\"\nlogDir=\"log\"\n\n\ncd $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc\nmkdir -p $logDir\n\n#================================================================================#\n# compile src\n#================================================================================#\n. $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_src.sh\n\n#================================================================================#\n# compile solvers\n#================================================================================#\n. $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_sol.sh\n\n#================================================================================#\n# compile utilities\n#================================================================================#\n. $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_uti.sh\n" }, { "path": "src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_all.sh", "content": "#!/bin/bash\n\n#===================================================================#\n# compile routine for CFDEMcoupling + LIGGGHTS, part of CFDEMproject \n# Christoph Goniva - May. 2012, DCS Computing GmbH\n# update March 2014\n#===================================================================#\n\n#- include functions\nsource $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/functions.sh\n\nNOW=\"$(date +\"%Y-%m-%d-%H:%M\")\"\nlogDir=\"log\"\n\n\ncd $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc\nmkdir -p $logDir\n\n#================================================================================#\n# compile LIGGGHTS src + libraries\n#================================================================================#\n. $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileLIGGGHTS.sh\n\n#================================================================================#\n# compile CFDEMcoupling\n#================================================================================#\n. $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling.sh\n" }, { "path": "src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_sol.sh", "content": "#!/bin/bash\n\n#===================================================================#\n# compile routine for CFDEMcoupling solvers, part of CFDEMproject \n# Christoph Goniva - May. 2012, DCS Computing GmbH\n#===================================================================#\n\nwhitelist=\"solver-list.txt\"\n\n#- include functions\nsource $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/functions.sh\n\nlogDir=\"log\"\ncd $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc\nmkdir -p $logDir\n\n#- remove old success/fail logs\nrm $logDir/log_compile_results_sol_success\nrm $logDir/log_compile_results_sol_fail\n\nCWD=\"$(dirname \"$(readlink -f ${BASH_SOURCE[0]})\")\"\nNOW=\"$(date +\"%Y-%m-%d-%H:%M\")\"\n\necho \"\"\necho \"This routine will compile the solvers specified in solver-list.txt\"\necho \"\"\n#echo \"Are the variables CFDEM_SOLVER_DIR=$CFDEM_SOLVER_DIR\"\n#echo \"and CFDEM_SRC_DIR=$CFDEM_SRC_DIR/lagrangian/cfdemParticle correct? (y/n)\"\n#read YN\n#if [ \"$YN\" != \"y\" ];then\n# \techo \"Aborted by user.\"\n# \texit 1\n#fi\n\necho \"\"\necho \"Please provide the solvers to be compiled in the $CWD/$whitelist file.\"\necho \"structure:\"\necho \"path to provide the path relative to CFDEM_SOLVER_DIR\"\necho \"\"\necho \"example:\"\necho \"cfdemSolverPiso/dir\"\necho \"\"\n\n#- create a tmp file and delete comments in it - work with tmp file then.\ncp $whitelist \"tmpFile.txt\"\nsed -i '/^#/d' \"tmpFile.txt\"\nsed -i '/^$/d' \"tmpFile.txt\"\nwhitelist=\"tmpFile.txt\"\n\nif [ ! -f \"$CWD/$whitelist\" ];then\n echo \"$whitelist does not exist in $CWD\"\nelse\n njobs=`wc -l < $CWD/$whitelist` \n echo \"\"\n echo \"running compilation in pseudo-parallel mode of $njobs solvers\"\n\n #--------------------------------------------------------------------------------#\n logpath=\"$(dirname \"$(readlink -f ${BASH_SOURCE[0]})\")/$logDir\"\n\n ##number of solvers compiled at a time\n\n if [[ $WM_NCOMPPROCS == \"\" ]] || [ $WM_NCOMPPROCS -eq 1 ]; then\n nsteps=1\n let nchunk=$njobs+1 # +1, to wait for the last compilation too\n echo \"do compilation in serial\"\n else \n nsteps=$WM_NCOMPPROCS\n let nchunk=$njobs/$nsteps+1\n echo \"do compilation on $nsteps procs in $nchunk chunks\" \n let nchunk++ # +1, to wait for the last compilation too \n fi\n\n counter=0\n for i in `seq $nchunk`\n do\n\n #wait until prev. compilation is finished\n echo \"waiting...\"\n #until [ `ps -a | grep make | wc -l` -eq 0 ]; \n until [ `ls -a | grep $logpath/*.tempXYZ | wc -l` -eq 0 ];\n do \n sleep 2\n done\n\n for j in `seq $nsteps`\n do\n let solNr=($i-1)*$nsteps+$j\n LINE=`head -n $solNr $CWD/$whitelist | tail -1`\n\n # white lines\n if [[ \"$LINE\" == \"\" ]]; then\n continue\n # comments\n elif [[ \"$LINE\" == \\#* ]]; then\n continue\n # paths\n elif [[ \"$LINE\" == */dir ]]; then\n #echo \"change path\"\n LINE=$(echo \"${LINE%????}\")\n path=\"$CFDEM_SOLVER_DIR/$LINE\"\n #cd $path\n let solNr++\n fi\n\n if [[ \"$counter\" -lt \"$njobs\" ]]; then\n #--------------------------------------------------------------------------------#\n #- define variables\n #logpath=\"$(dirname \"$(readlink -f ${BASH_SOURCE[0]})\")/$logDir\"\n if [[ ${LINE:0:6} = \"Course\" ]] \n then\n LINE=$(basename $LINE)\n logfileName=\"log_compileCFDEMcoupling\"\"_$LINE\" \n casePath=\"$CFDEM_SOLVER_DIR/Course/$LINE\"\n else\n logfileName=\"log_compileCFDEMcoupling\"\"_$LINE\" \n casePath=\"$CFDEM_SOLVER_DIR/$LINE\"\n fi\n headerText=\"$logfileName\"\"_$LINE\"\"-$NOW\"\n parallel=\"true\"\n #--------------------------------------------------------------------------------#\n\n echo \"compiling $LINE\"\n compileSolver $logpath $logfileName $casePath $headerText $parallel\n let counter++\n fi\n done\n\n #sleep 1 # wait a second until compilation starts\n done\n\n echo \"compilation done.\"\nfi\n\n#--------------------------------------------------------------------------------#\n# loop all solvers and collect the logs\n#--------------------------------------------------------------------------------#\n\n#wait until prev. compilation is finished\necho \"waiting...\"\n#until [ `ps -a | grep make | wc -l` -eq 0 ]; \nuntil [ `ls -a | grep $logpath/*.tempXYZ | wc -l` -eq 0 ];\ndo \n sleep 2\ndone\n\nif [ ! -f \"$CWD/$whitelist\" ];then\n echo \"$whitelist does not exist in $CWD\"\nelse\n NLINES=`wc -l < $CWD/$whitelist`\n COUNT=0\n\n for masterLogFile in \"$masterLogName\"\n do\n\n while [ $COUNT -lt $NLINES ]\n do\n let COUNT++ \n LINE=`head -n $COUNT $CWD/$whitelist | tail -1`\n \n # white lines\n if [[ \"$LINE\" == \"\" ]]; then\n continue\n # comments\n elif [[ \"$LINE\" == \\#* ]]; then\n continue\n # paths\n elif [[ \"$LINE\" == */dir ]]; then\n LINE=$(echo \"${LINE%????}\")\n path=\"$CFDEM_SOLVER_DIR/$LINE\"\n #continue\n fi\n\n #- execute tutorial\n echo \"collecting log of $path\"\n\n #--------------------------------------------------------------------------------#\n #- define variables\n #logpath=\"$(dirname \"$(readlink -f ${BASH_SOURCE[0]})\")/$logDir\"\n if [[ ${LINE:0:6} = \"Course\" ]] \n then\n LINE=$(basename $LINE)\n logfileName=\"log_compileCFDEMcoupling\"\"_$LINE\" \n casePath=\"$CFDEM_SOLVER_DIR/Course/$LINE\"\n else\n logfileName=\"log_compileCFDEMcoupling\"\"_$LINE\" \n casePath=\"$CFDEM_SOLVER_DIR/$LINE\"\n fi\n #--------------------------------------------------------------------------------# \n collectLogCFDEMcoupling_sol $logpath $logfileName $casePath\n done\n done\nfi\nrm \"$CWD/tmpFile.txt\"\n" }, { "path": "src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_src.sh", "content": "#!/bin/bash\n\n#===================================================================#\n# compile routine for CFDEMcoupling source, part of CFDEMproject \n# will create all lnInclude directories before compilation in order\n# to avoid missing headers in foreign libraries\n# Christoph Goniva - May. 2012, DCS Computing GmbH\n# update: Stefan Radl (TU Graz, April 2016)\n#===================================================================#\n \n#- include functions\nsource $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/functions.sh\n\nNOW=\"$(date +\"%Y-%m-%d-%H:%M\")\"\nlogDir=\"log\"\n\n\ncd $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc\nmkdir -p $logDir\n\nrm $logDir/log_compile_results_src_success\nrm $logDir/log_compile_results_src_fail\n\n##================================================================================#\n## Must compile (but not clean) LIGGGHTS libraries, since it could have been \n## compiled before with the compileLIGGGHTS command\n## Then, check successful compilation\n##================================================================================#\n#bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileLIGGGHTS_lib.sh noClean\n#echo \"...now checking if LIGGGHTS libraries are compiled that are needed for CFDEM's src packages.\"\n#bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileLIGGGHTS_lib.sh false\n\n#================================================================================#\n# compile src\n#================================================================================#\nwhitelist=\"$CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/library-list.txt\"\necho \"\"\necho \"Please provide the libraries to be compiled in the $whitelist file.\"\n\nif [ ! -f \"$whitelist\" ];then\n echo \"$whitelist does not exist in $CWD. Nothing will be done.\"\n NLINES=0\n COUNT=0\nelse\n NLINES=`wc -l < $whitelist`\n COUNT=0\nfi\n\n#Generate lnIncludes, only for paths\nwhile [ $COUNT -lt $NLINES ]\ndo\n let COUNT++ \n LINE=$( head -n $COUNT $whitelist | tail -1 )\n LINE=$( eval echo $LINE )\n\n # white lines\n if [[ \"$LINE\" == \"\" ]]; then\n echo \"compile $LINE\"\n continue\n # comments\n elif [[ \"$LINE\" == \\#* ]]; then\n continue\n # paths\n elif [[ \"$LINE\" == */dir ]]; then\n echo \"will change path and create lnInclude...\"\n LINE=$(echo \"${LINE%????}\")\n path=\"$CFDEM_SRC_DIR/$LINE\"\n cd $path\n #continue\n fi\n wmakeLnInclude .\ndone\nCOUNT=0\n\necho\necho\necho \"\\n Creation of lnInclude directories finished!\"\necho\necho\n\nwhile [ $COUNT -lt $NLINES ]\ndo\n let COUNT++ \n LINE=$( head -n $COUNT $whitelist | tail -1 )\n LINE=$( eval echo $LINE )\n\n # white lines\n if [[ \"$LINE\" == \"\" ]]; then\n echo \"compile $LINE\"\n continue\n # comments\n elif [[ \"$LINE\" == \\#* ]]; then\n continue\n # paths\n elif [[ \"$LINE\" == */dir ]]; then\n echo \"will change path...\"\n LINE=$(echo \"${LINE%????}\")\n path=\"$CFDEM_SRC_DIR/$LINE\"\n cd $path\n #continue\n fi\n #--------------------------------------------------------------------------------#\n #- define variables\n logpath=\"$(dirname \"$(readlink -f ${BASH_SOURCE[0]})\")/$logDir\"\n logfileName=\"log_compileCFDEMcoupling_\"$(basename $LINE)\"\"\n casePath=\"$path\"\n headerText=\"$logfileName\"\"-$NOW\"\n #--------------------------------------------------------------------------------#\n # remove old log file\n rm \"$logpath/$logfileName\"*\n compileLib $logpath $logfileName $casePath $headerText\n\n if [ ${PIPESTATUS[0]} -ne 0 ]; then \n exit 1\n fi\n\n collectLogCFDEMcoupling_src $logpath $logfileName $casePath\n \n\ndone\n\n" }, { "path": "src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_uti.sh", "content": "#!/bin/bash\n\n#===================================================================#\n# compile routine for CFDEMcoupling utilities, part of CFDEMproject \n# Christoph Goniva - May. 2012, DCS Computing GmbH\n#===================================================================#\n\nwhitelist=\"utilities-list.txt\"\n\n#- include functions\nsource $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/functions.sh\n\nlogDir=\"log\"\ncd $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc\nmkdir -p $logDir\n\nCWD=\"$(dirname \"$(readlink -f ${BASH_SOURCE[0]})\")\"\nNOW=\"$(date +\"%Y-%m-%d-%H:%M\")\"\n\necho \"\"\necho \"This routine will compile the utilities specified in utilities-list.txt\"\necho \"\"\n#echo \"Are the variables CFDEM_UT_DIR=$CFDEM_UT_DIR\"\n#echo \"and CFDEM_SRC_DIR=$CFDEM_SRC_DIR/lagrangian/cfdemParticle correct? (y/n)\"\n#read YN\n#if [ \"$YN\" != \"y\" ];then\n# \techo \"Aborted by user.\"\n# \texit 1\n#fi\n\necho \"\"\necho \"Please provide the utilities to be compiled in the $CWD/$whitelist file.\"\necho \"structure:\"\necho \"path to provide the path relative to CFDEM_UT_DIR\"\necho \"\"\necho \"example:\"\necho \"cfdemPostproc/dir\"\necho \"\"\n\n#- create a tmp file and delete comments in it - work with tmp file then.\ncp $whitelist \"tmpFile.txt\"\nsed -i '/^#/d' \"tmpFile.txt\"\nsed -i '/^$/d' \"tmpFile.txt\"\nwhitelist=\"tmpFile.txt\"\n\nif [ ! -f \"$CWD/$whitelist\" ];then\n echo \"$whitelist does not exist in $CWD\"\nelse\n njobs=`wc -l < $CWD/$whitelist` \n echo \"\"\n echo \"running compilation in pseudo-parallel mode of $njobs utilities\"\n\n #--------------------------------------------------------------------------------#\n logpath=\"$(dirname \"$(readlink -f ${BASH_SOURCE[0]})\")/$logDir\"\n\n ##number of utilities compiled at a time\n\n if [[ $WM_NCOMPPROCS == \"\" ]] || [ $WM_NCOMPPROCS -eq 1 ]; then\n nsteps=1\n let nchunk=$njobs+1 # +1, to wait for the last compilation too\n echo \"do compilation in serial\"\n else \n nsteps=$WM_NCOMPPROCS\n let nchunk=$njobs/$nsteps+1\n echo \"do compilation on $nsteps procs in $nchunk chunks\" \n let nchunk++ # +1, to wait for the last compilation too \n fi\n\n counter=0\n for i in `seq $nchunk`\n do\n\n #wait until prev. compilation is finished\n echo \"waiting...\"\n #until [ `ps -a | grep make | wc -l` -eq 0 ]; \n until [ `ls -a | grep $logpath/*.tempXYZ | wc -l` -eq 0 ];\n do \n sleep 2\n done\n\n for j in `seq $nsteps`\n do\n let solNr=($i-1)*$nsteps+$j\n LINE=`head -n $solNr $CWD/$whitelist | tail -1`\n\n # white lines\n if [[ \"$LINE\" == \"\" ]]; then\n continue\n # comments\n elif [[ \"$LINE\" == \\#* ]]; then\n continue\n # paths\n elif [[ \"$LINE\" == */dir ]]; then\n #echo \"change path\"\n LINE=$(echo \"${LINE%????}\")\n path=\"$CFDEM_UT_DIR/$LINE\"\n #cd $path\n let solNr++\n fi\n\n if [[ \"$counter\" -lt \"$njobs\" ]]; then\n #--------------------------------------------------------------------------------#\n #- define variables\n #logpath=\"$(dirname \"$(readlink -f ${BASH_SOURCE[0]})\")/$logDir\"\n logfileName=\"log_compileCFDEMcoupling\"\"_$LINE\" \n casePath=\"$CFDEM_UT_DIR/$LINE\"\n headerText=\"$logfileName\"\"_$LINE\"\"-$NOW\"\n parallel=\"true\"\n #--------------------------------------------------------------------------------#\n\n echo \"compiling $LINE\"\n compileSolver $logpath $logfileName $casePath $headerText $parallel\n let counter++\n fi\n done\n\n #sleep 1 # wait a second until compilation starts\n done\n\n echo \"compilation done.\"\nfi\n\n\n#wait until prev. compilation is finished\necho \"waiting...\"\n#until [ `ps -a | grep make | wc -l` -eq 0 ]; \nuntil [ `ls -a | grep $logpath/*.tempXYZ | wc -l` -eq 0 ];\ndo \n sleep 2\ndone\n\nrm \"$CWD/tmpFile.txt\"\n" }, { "path": "src/lagrangian/cfdemParticle/etc/compileLIGGGHTS.sh", "content": "#!/bin/bash\n\n#===================================================================#\n# compile routine for LIGGGHTS, part of CFDEMproject \n# Christoph Goniva - May. 2012, DCS Computing GmbH\n#===================================================================\n\n#- include functions\nsource $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/functions.sh\n\nNOW=\"$(date +\"%Y-%m-%d-%H:%M\")\"\nlogDir=\"log\"\n\ncd $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc\nmkdir -p $logDir\n\n#================================================================================#\n# copy LIGGGHTS patch files if available\n#================================================================================#\necho \"copying patch files for LIGGGHTS if available\"\ncp $CFDEM_SRC_DIR/LIGGGHTSpatch/* $CFDEM_LIGGGHTS_SRC_DIR\n\n#--------------------------------------------------------------------------------#\n#- define variables\nlogpath=\"$(dirname \"$(readlink -f ${BASH_SOURCE[0]})\")/$logDir\"\nlogfileName=\"log_compileLIGGGHTS\" #alternative: logfileName=\"log_compileLIGGGHTS_$NOW\"\nheaderText=\"$logfileName\"\"-$NOW\"\n#--------------------------------------------------------------------------------#\n\n#================================================================================#\n# compile LIGGGHTS dataExchange libraries (forces clean, and then compile)\n#================================================================================#\n. $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileLIGGGHTS_dataExchLib.sh\n\nif [ ${PIPESTATUS[0]} -ne 0 ]; then\n exit 1\nfi\n\n#================================================================================#\n# compile LIGGGHTS libraries (forces clean, and then compile)\n#================================================================================#\nbash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileLIGGGHTS_lib.sh \n\nif [ ${PIPESTATUS[0]} -ne 0 ]; then\n exit 1\nfi\n\n#================================================================================#\n# compile LIGGGHTS src\n#================================================================================#\n\ncompileLIGGGHTS $logpath $logfileName $headerText\n\nif [ ${PIPESTATUS[0]} -ne 0 ]; then \n exit 1\nfi\n" }, { "path": "src/lagrangian/cfdemParticle/etc/compileLIGGGHTS_dataExchLib.sh", "content": "#!/bin/bash\n\n#===================================================================#\n# compile routine for LIGGGHTS dataExchangeModel libraries, part of CFDEMproject \n# Christoph Goniva - March. 2014, DCS Computing GmbH\n#===================================================================#\n \n#- include functions\nsource $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/functions.sh\n\nNOW=\"$(date +\"%Y-%m-%d-%H:%M\")\"\nlogDir=\"log\"\n\n\ncd $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc\nmkdir -p $logDir\n\n#================================================================================#\n# compile src\n#================================================================================#\n whitelist=\"$CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/library-liggghts-list.txt\"\n echo \"\"\n echo \"===========================================\"\n echo \"Compiling sub-libraries of LIGGGHTS now...\"\n echo \"Please provide the libraries to be compiled in the $CWD/$whitelist file.\"\n echo \"Libraries must be in: $CFDEM_LAMMPS_LIB_DIR, or a path defined by the Line in the above file.\"\n\n if [ ! -f \"$CWD/$whitelist\" ];then\n echo \"$whitelist does not exist in $CWD. Nothing will be done.\"\n NLINES=0\n COUNT=0\n else\n NLINES=`wc -l < $CWD/$whitelist`\n COUNT=0\n fi\n\n logpath=\"$(dirname \"$(readlink -f ${BASH_SOURCE[0]})\")/$logDir\"\n\n while [ $COUNT -lt $NLINES ]\n do\n let COUNT++ \n LINE=`head -n $COUNT $CWD/$whitelist | tail -1`\n \n # white lines\n if [[ \"$LINE\" == \"\" ]]; then\n echo \"compile $LINE\"\n continue\n # comments\n elif [[ \"$LINE\" == \\#* ]]; then\n continue\n # paths\n elif [[ \"$LINE\" == */dir ]]; then\n echo \"will change path...\"\n LINE=$(echo \"${LINE%????}\")\n path=\"$CFDEM_LAMMPS_LIB_DIR\"\n cd $path\n echo $PWD\n #continue\n fi\n\n #--------------------------------------------------------------------------------#\n #- define variables\n #logpath=\"$(dirname \"$(readlink -f ${BASH_SOURCE[0]})\")/$logDir\"\n logfileName=\"log_compile$LINE\"\"lib\"\n headerText=\"$logfileName\"\"-$NOW\"\n libVarMakefileName=\"CFDEM_$LINE\"\"LIB_MAKEFILENAME\"\n makeFileName=\"Makefile.${!libVarMakefileName}\"\n libVarName=\"CFDEM_$LINE\"\"LIB_PATH\"\n libraryPath=\"${!libVarName}\"\n compilationModeSwitch=\"$1\"\n #--------------------------------------------------------------------------------#\n compileLMPlib $logpath $logfileName $headerText $makeFileName $libraryPath $compilationModeSwitch\n\n if [ ${PIPESTATUS[0]} -ne 0 ]; then \n exit 1\n fi\n\n done\n" }, { "path": "src/lagrangian/cfdemParticle/etc/compileLIGGGHTS_lib.sh", "content": "#!/bin/bash\n\n#===================================================================#\n# compile routine for LIGGGHTS libraries, part of CFDEMproject \n# Christoph Goniva - March. 2014, DCS Computing GmbH\n#===================================================================#\n \n#- include functions\nsource $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/functions.sh\n\nNOW=\"$(date +\"%Y-%m-%d-%H:%M\")\"\nlogDir=\"log\"\n\n\ncd $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc\nmkdir -p $logDir\n\n#================================================================================#\n# compile src\n#================================================================================#\n whitelist=\"$CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/package-undo-liggghts-list.txt\"\n echo \"\"\n echo \"===========================================\"\n echo \"deactivating all possible packages of LIGGGHTS now...\"\n echo \"Please provide the packages to be compiled in the $CWD/$whitelist file.\"\n echo \"Packages must be in: $CFDEM_LAMMPS_LIB_DIR.\"\n\n if [ ! -f \"$CWD/$whitelist\" ];then\n echo \"$whitelist does not exist in $CWD. Nothing will be done.\"\n NLINES=0\n COUNT=0\n else\n NLINES=`wc -l < $CWD/$whitelist`\n COUNT=0\n fi\n\n logpath=\"$(dirname \"$(readlink -f ${BASH_SOURCE[0]})\")/$logDir\"\n\n # resetting Makefile.package\n cp $CFDEM_LIGGGHTS_SRC_DIR/Makefile.package.empty $CFDEM_LIGGGHTS_SRC_DIR/Makefile.package\n cp $CFDEM_LIGGGHTS_SRC_DIR/Makefile.package.settings.empty $CFDEM_LIGGGHTS_SRC_DIR/Makefile.package.settings\n\n while [ $COUNT -lt $NLINES ]\n do\n let COUNT++ \n LINE=`head -n $COUNT $CWD/$whitelist | tail -1`\n \n # white lines\n if [[ \"$LINE\" == \"\" ]]; then\n echo \"compile $LINE\"\n continue\n # comments\n elif [[ \"$LINE\" == \\#* ]]; then\n continue\n # paths\n elif [[ \"$LINE\" == */dir ]]; then\n echo \"will change path...\"\n LINE=$(echo \"${LINE%????}\")\n path=\"$CFDEM_LIGGGHTS_SRC_DIR\"\n cd $path\n echo $PWD\n #continue\n fi\n\n #--------------------------------------------------------------------------------#\n #- define variables\n logfileName=\"log_compile$LINE\"\"lib\"\n #--------------------------------------------------------------------------------#\n rm $logfileName 2>&1 | tee -a $logpath/$logfileName\n\n make no-$LINE 2>&1 | tee -a $logpath/$logfileName\n done\n\n #===================================================================================\n whitelist=\"$CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/package-liggghts-list.txt\"\n echo \"\"\n echo \"===========================================\"\n echo \"activating packages of LIGGGHTS now...\"\n echo \"Please provide the packages to be compiled in the $CWD/$whitelist file.\"\n echo \"Packages must be in: $CFDEM_LAMMPS_LIB_DIR.\"\n\n if [ ! -f \"$CWD/$whitelist\" ];then\n echo \"$whitelist does not exist in $CWD. Nothing will be done.\"\n NLINES=0\n COUNT=0\n else\n NLINES=`wc -l < $CWD/$whitelist`\n COUNT=0\n fi\n\n logpath=\"$(dirname \"$(readlink -f ${BASH_SOURCE[0]})\")/$logDir\"\n\n while [ $COUNT -lt $NLINES ]\n do\n let COUNT++ \n LINE=`head -n $COUNT $CWD/$whitelist | tail -1`\n \n # white lines\n if [[ \"$LINE\" == \"\" ]]; then\n echo \"compile $LINE\"\n continue\n # comments\n elif [[ \"$LINE\" == \\#* ]]; then\n continue\n # paths\n elif [[ \"$LINE\" == */dir ]]; then\n echo \"will change path...\"\n LINE=$(echo \"${LINE%????}\")\n path=\"$CFDEM_LIGGGHTS_SRC_DIR\"\n cd $path\n echo $PWD\n #continue\n fi\n\n #--------------------------------------------------------------------------------#\n #- define variables\n logfileName=\"log_compile$LINE\"\"lib\"\n #--------------------------------------------------------------------------------#\n\n rm $logpath/$logfileName\n make yes-$LINE 2>&1 | tee -a $logpath/$logfileName\n\n # assuming we need the poems lib if the package POEMS is activated\n if [[ \"$LINE\" == \"POEMS\" ]]; then\n echo \"compile $LINE\"\n cd $CFDEM_POEMSLIB_PATH\n make -f Makefile.g++ clean 2>&1 | tee -a $logpath/$logfileName\n #make -j $nProc -f Makefile.g++ lib 2>&1 | tee -a $logpath/$logfileName # I do not see where nProc would be defined here, so let us compile in serial here\n make -f Makefile.g++ lib 2>&1 | tee -a $logpath/$logfileName\n cd $path\n fi\n\n # special handling of PARSCALE\n if [[ \"$LINE\" == \"PASCAL\" ]]; then\n echo \"compile $LINE\"\n #. $PASCAL_SRC_DIR/refresh 2>&1 | tee -a $logpath/$logfileName\n . $PASCAL_SRC_DIR/refreshLibrary.sh 2>&1 | tee -a $logpath/$logfileName\n fi\n done\n" }, { "path": "src/lagrangian/cfdemParticle/etc/compileLIGGGHTS_noClean.sh", "content": "#!/bin/bash\n\n#===================================================================#\n# compile routine for LIGGGHTS, part of CFDEMproject \n# Christoph Goniva - May. 2012, DCS Computing GmbH\n#===================================================================\n\n#- include functions\nsource $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/functions.sh\n\nNOW=\"$(date +\"%Y-%m-%d-%H:%M\")\"\nlogDir=\"log\"\n\ncd $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc\nmkdir -p $logDir\n\n#================================================================================#\n# copy LIGGGHTS patch files if available\n#================================================================================#\necho \"copying patch files for LIGGGHTS if available\"\ncp $CFDEM_SRC_DIR/LIGGGHTSpatch/* $CFDEM_LIGGGHTS_SRC_DIR\n\n#--------------------------------------------------------------------------------#\n#- define variables\nlogpath=\"$(dirname \"$(readlink -f ${BASH_SOURCE[0]})\")/$logDir\"\nlogfileName=\"log_compileLIGGGHTS\" #alternative: logfileName=\"log_compileLIGGGHTS_$NOW\"\nheaderText=\"$logfileName\"\"-$NOW\"\n#--------------------------------------------------------------------------------#\n\n#================================================================================#\n# compile LIGGGHTS libraries\n#================================================================================#\n#bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileLIGGGHTS_lib.sh\n\n#================================================================================#\n# compile LIGGGHTS src\n#================================================================================#\n\ncompileLIGGGHTS $logpath $logfileName $headerText \"false\"\n\n\n" }, { "path": "src/lagrangian/cfdemParticle/etc/controlDict_cgs_2.1.x", "content": "/*--------------------------------*- C++ -*----------------------------------*\\\n| ========= | |\n| \\\\ / F ield | OpenFOAM: The Open Source CFD Toolbox |\n| \\\\ / O peration | Version: 2.0.0 |\n| \\\\ / A nd | Web: www.OpenFOAM.org |\n| \\\\/ M anipulation | |\n\\*---------------------------------------------------------------------------*/\nFoamFile\n{\n version 2.0;\n format ascii;\n class dictionary;\n object controlDict;\n}\n\n// NB: the #functions do not work here\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nDocumentation\n{\n docBrowser \"firefox %f\";\n doxyDocDirs\n (\n \"$WM_PROJECT_USER_DIR/html\"\n \"~OpenFOAM/html\"\n \"$WM_PROJECT_DIR/doc/Doxygen/html\"\n );\n doxySourceFileExts\n (\n \"App_8C.html\"\n \"_8C.html\"\n );\n}\n\n\nInfoSwitches\n{\n writePrecision 6;\n writeJobInfo 0;\n writeDictionaries 0;\n\n // Allow case-supplied C++ code (#codeStream, codedFixedValue)\n allowSystemOperations 0;\n}\n\n\nOptimisationSwitches\n{\n fileModificationSkew 10;\n\n //- Modification checking:\n // - timeStamp : use modification time on file\n // - inotify : use inotify framework\n // - timeStampMaster : do time stamp (and file reading) only on master.\n // - inotifyMaster : do inotify (and file reading) only on master.\n fileModificationChecking timeStampMaster;//inotify;timeStamp;inotifyMaster;\n\n commsType nonBlocking; //scheduled; //blocking;\n floatTransfer 0;\n nProcsSimpleSum 0;\n\n // Force dumping (at next timestep) upon signal (-1 to disable)\n writeNowSignal -1; //10;\n // Force dumping (at next timestep) upon signal (-1 to disable) and exit\n stopAtWriteNowSignal -1;\n}\n\n\nDebugSwitches\n{\n Analytical 0;\n APIdiffCoefFunc 0;\n Ar 0;\n BICCG 0;\n BirdCarreau 0;\n C10H22 0;\n C12H26 0;\n C13H28 0;\n C14H30 0;\n C16H34 0;\n C2H5OH 0;\n C2H6 0;\n C2H6O 0;\n C3H6O 0;\n C3H8 0;\n C4H10O 0;\n C6H14 0;\n C6H6 0;\n C7H16 0;\n C7H8 0;\n C8H10 0;\n C8H18 0;\n C9H20 0;\n CH3OH 0;\n CH4N2O 0;\n CarnahanStarling 0;\n CallbackRegistry 0;\n CentredFitData 0;\n CentredFitData 0;\n CentredFitData 0;\n CentredFitData 0;\n ChomiakInjector 0;\n Cloud 0;\n Cloud 0;\n Cloud 0;\n Cloud 0;\n Cloud 0;\n Cloud 0;\n Cloud 0;\n CoEuler 0;\n CompositionModel 0;\n ConeInjection 0;\n Constant 0;\n ConstantRateDevolatilisation 0;\n CrankNicholson 0;\n CrossPowerLaw 0;\n Cs 0;\n DIC 0;\n DICGaussSeidel 0;\n DILU 0;\n DILUGaussSeidel 0;\n DataEntry 0;\n DeardorffDiffStress 0;\n DispersionModel 0;\n DispersionRASModel 0;\n DragModel 0;\n ETAB 0;\n Ergun 0;\n Euler 0;\n EulerImplicit 0;\n EulerRotation 0;\n extendedCellToFaceStencil 0;\n FDIC 0;\n FaceCellWave 0;\n GAMG 0;\n GAMGAgglomeration 0;\n GAMGInterface 0;\n GAMGInterfaceField 0;\n Gamma 0;\n Gamma01 0;\n GammaV 0;\n Gauss 0;\n GaussSeidel 0;\n Gibilaro 0;\n Gidaspow 0;\n GidaspowErgunWenYu 0;\n GidaspowSchillerNaumann 0;\n GradientDispersionRAS 0;\n Gulders 0;\n GuldersEGR 0;\n H2O 0;\n HashTable 0;\n HeatTransferModel 0;\n HerschelBulkley 0;\n HrenyaSinclair 0;\n IC8H18 0;\n ICCG 0;\n IDDESDelta 0;\n IDEA 0;\n IFstream 0;\n IOMap 0;\n IOPtrList 0;\n IOPtrList 0;\n IOPtrList 0;\n IOPtrList 0;\n IOobject 0;\n InjectionModel 0;\n IntegrationScheme 0;\n JohnsonJackson 0;\n KRR4 0;\n KinematicCloud 0;\n KinematicCloud 0;\n KinematicCloud 0;\n KinematicParcel 0;\n KinematicParcel 0;\n LESModel 0;\n LESdelta 0;\n LESfilter 0;\n LISA 0;\n LRR 0;\n LRRDiffStress 0;\n LamBremhorstKE 0;\n LaunderGibsonRSTM 0;\n LaunderSharmaKE 0;\n LienCubicKE 0;\n LienCubicKELowRe 0;\n LienLeschzinerLowRe 0;\n MB 0;\n MC 0;\n MCV 0;\n MUSCL 0;\n MUSCL01 0;\n MUSCLV 0;\n ManualInjection 0;\n MarshakRadiation 0;\n MarshakRadiationFixedT 0;\n MassTransferModel 0;\n MeshWave 0;\n Minmod 0;\n MinmodV 0;\n N2 0;\n NSRDSfunc0 0;\n NSRDSfunc1 0;\n NSRDSfunc14 0;\n NSRDSfunc2 0;\n NSRDSfunc3 0;\n NSRDSfunc4 0;\n NSRDSfunc5 0;\n NSRDSfunc6 0;\n NSRDSfunc7 0;\n Newtonian 0;\n NoDispersion 0;\n NoDrag 0;\n NoHeatTransfer 0;\n NoInjection 0;\n NoMassTransfer 0;\n NoSurfaceReaction 0;\n NonlinearKEShih 0;\n ODE 0;\n ODESolver 0;\n OFstream 0;\n ORourke 0;\n OSPRE 0;\n OSPREV 0;\n P1 0;\n PBiCG 0;\n PCG 0;\n PackedList 0;\n ParSortableList 0;\n PatchToPatchInterpolation 0;\n Phi 0;\n PointEdgeWave 0;\n POSIX 0;\n Prandtl 0;\n PrimitivePatch 0;\n Pstream 0;\n QUICK 0;\n QUICKV 0;\n QZeta 0;\n RASModel 0;\n RK 0;\n RNGkEpsilon 0;\n RanzMarshall 0;\n ReactingCloud 0;\n ReactingParcel 0;\n Rebound 0;\n ReitzDiwakar 0;\n ReitzKHRT 0;\n RosinRammler 0;\n RutlandFlashBoil 0;\n SDA 0;\n SFCD 0;\n SFCDV 0;\n SHF 0;\n SIBS 0;\n SKA 0;\n SLTS 0;\n SRFModel 0;\n SRFVelocity 0;\n STARCDRotation 0;\n Schaeffer 0;\n SchillerNaumann 0;\n SinclairJackson 0;\n SingleKineticRateDevolatilisation 0;\n SingleMixtureFraction 0;\n Smagorinsky 0;\n SpalartAllmaras 0;\n SpalartAllmarasDDES 0;\n SpalartAllmarasIDDES 0;\n SphereDrag 0;\n StandardWallInteraction 0;\n StaticHashTable 0;\n StochasticDispersionRAS 0;\n SuperBee 0;\n SuperBeeV 0;\n SurfaceReactionModel 0;\n Syamlal 0;\n SyamlalOBrien 0;\n SyamlalRogersOBrien 0;\n TAB 0;\n Table 0;\n ThermoCloud 0;\n ThermoCloud 0;\n ThermoParcel 0;\n ThermoParcel 0;\n UMIST 0;\n UMISTV 0;\n UpwindFitData 0;\n UpwindFitData 0;\n UpwindFitData 0;\n WallInteractionModel 0;\n WenYu 0;\n aC11H10 0;\n absorptionEmissionModel 0;\n addCell 0;\n addFace 0;\n addPatchCellLayer 0;\n addPoint 0;\n advective 0;\n algebraicPair 0;\n alphaContactAngle 0;\n alphaFixedPressure 0;\n alphatWallFunction 0;\n angularOscillatingDisplacement 0;\n angularOscillatingVelocity 0;\n anisotropic 0;\n ash 0;\n atomizationModel 0;\n attachDetach 0;\n autoDensity 0;\n autoHexMeshDriver 0;\n autoLayerDriver 0;\n autoRefineDriver 0;\n autoSnapDriver 0;\n bC11H10 0;\n backgroundMeshDecomposition 0;\n backward 0;\n basePatch 0;\n basicKinematicCloud 0;\n basicKinematicParcel 0;\n basicMixture 0;\n basicReactingCloud 0;\n basicReactingParcel 0;\n basicThermo 0;\n basicThermoCloud 0;\n basicThermoParcel 0;\n biLinearFit 0;\n binaryAbsorptionEmission 0;\n blended 0;\n blobsSheetAtomization 0;\n blobsSwirlInjector 0;\n booleanSurface 0;\n boundaryCutter 0;\n boundaryMesh 0;\n boundaryToFace 0;\n boundedBackward 0;\n boxToCell 0;\n boxToFace 0;\n boxToPoint 0;\n breakupModel 0;\n calculated 0;\n cell 0;\n cellClassification 0;\n cellCuts 0;\n cellDistFuncs 0;\n cellLimited 0;\n cellList 0;\n cellLooper 0;\n cellMDLimited 0;\n cellMotion 0;\n cellPoint 0;\n cellPointFace 0;\n cellPointWeight 0;\n cellSet 0;\n cellSizeControlSurfaces 0;\n cellToCell 0;\n cellToFace 0;\n cellToPoint 0;\n cellZone 0;\n centredCECStencil 0;\n centredCFCStencil 0;\n chemistryReader 0;\n chemistrySolver 0;\n chemkinReader 0;\n clippedLinear 0;\n cloud 0;\n cloudAbsorptionEmission 0;\n cloudScatter 0;\n collisionModel 0;\n combineFaces 0;\n commSchedule 0;\n commonRailInjector 0;\n compound 0;\n constInjector 0;\n constant 0;\n constantAbsorptionEmission 0;\n constantAlphaContactAngle 0;\n constantScatter 0;\n coordinateRotation 0;\n coordinateSystem 0;\n coordinateSystems 0;\n corrected 0;\n coupled 0;\n cubeRootVol 0;\n cubic 0;\n cubicUpwindFit 0;\n curve 0;\n cyclic 0;\n cyclicLduInterface 0;\n cyclicLduInterfaceField 0;\n cylinderToCell 0;\n cylindrical 0;\n decompositionMethod 0;\n definedHollowConeInjector 0;\n definedInjector 0;\n definedPressureSwirlInjector 0;\n diagTensorField 0;\n diagonal 0;\n dictionary 0;\n dimensionSet 1;\n mappedBase 0;\n mappedPatch 0;\n mappedVelocityFlux 0;\n directionMixed 0;\n directional 0;\n disallowGenericFvPatchField 0;\n disallowGenericPointPatchField 0;\n disallowGenericPolyPatch 0;\n dispersionLESModel 0;\n dispersionModel 0;\n dispersionRASModel 0;\n displacementComponentLaplacian 0;\n displacementInterpolation 0;\n displacementLaplacian 0;\n displacementSBRStress 0;\n distanceSurface 0;\n Distribution 0;\n downwind 0;\n dragModel 0;\n duplicatePoints 0;\n dx 0;\n dynMixedSmagorinsky 0;\n dynOneEqEddy 0;\n dynSmagorinsky 0;\n dynamicAlphaContactAngle 0;\n dynamicFvMesh 0;\n dynamicInkJetFvMesh 0;\n dynamicMotionSolverFvMesh 0;\n dynamicRefineFvMesh 0;\n edgeIntersections 0;\n edgeList 0;\n edgeSurface 0;\n empty 0;\n engineMesh 0;\n enrichedPatch 0;\n epsilonWallFunction 0;\n errorDrivenRefinement 0;\n evaporationModel 0;\n exponential 0;\n extendedLeastSquares 0;\n extendedLeastSquaresVectors 0;\n face 0;\n faceAreaPair 0;\n faceCoupleInfo 0;\n faceLimited 0;\n faceList 0;\n faceMDLimited 0;\n faceSet 0;\n faceToCell 0;\n faceToFace 0;\n faceToPoint 0;\n faceZone 0;\n fan 0;\n featureEdgeMesh 0;\n fieldToCell 0;\n file 0;\n fileName 2;\n filteredLinear 0;\n filteredLinear2 0;\n filteredLinear2V 0;\n filteredLinear3 0;\n filteredLinear3V 0;\n fixedEnthalpy 0;\n buoyantPressure 0;\n fixedFluxBoussinesqBuoyantPressure 0;\n fixedFluxPressure 0;\n fixedGradient 0;\n fixedInternalEnergy 0;\n fixedInternalValue 0;\n fixedNormalSlip 0;\n fixedPressureCompressibleDensity 0;\n fixedUnburntEnthalpy 0;\n fixedValue 0;\n flowRateInletVelocity 0;\n fluxCorrectedVelocity 0;\n foamChemistryReader 0;\n foamFile 0;\n forceCoeffs 0;\n forces 0;\n fourth 0;\n freestream 0;\n freestreamPressure 0;\n frictionalStressModel 0;\n functionObject 0;\n fv 0;\n fvMesh 0;\n fvMeshDistribute 0;\n fvMotionSolver 0;\n fvPatchField 0;\n fvScalarMatrix 0;\n fvSchemes 0;\n fvSphericalTensorMatrix 0;\n fvSymmTensorMatrix 0;\n fvTensorMatrix 0;\n fvVectorMatrix 0;\n fvsPatchField 0;\n general 0;\n generic 0;\n genericPatch 0;\n geomCellLooper 0;\n geometricSurfacePatch 0;\n global 0;\n globalIndexAndTransform 0;\n globalMeshData 0;\n globalPoints 0;\n gnuplot 0;\n gradientDispersionRAS 0;\n gradientEnthalpy 0;\n gradientInternalEnergy 0;\n gradientUnburntEnthalpy 0;\n granularPressureModel 0;\n hCombustionThermo 0;\n hMixtureThermo>>>> 0;\n hMixtureThermo>>>> 0;\n hMixtureThermo>>>> 0;\n hMixtureThermo>>>> 0;\n hMixtureThermo>>>> 0;\n hMixtureThermo>>>> 0;\n hMixtureThermo 0;\n hMixtureThermo>>>> 0;\n hMixtureThermo>>>> 0;\n hThermo>>>> 0;\n hThermo>>>> 0;\n hThermo>>>> 0;\n harmonic 0;\n heatTransferModel 0;\n hexCellLooper 0;\n hexRef8 0;\n hhuCombustionThermo 0;\n hhuMixtureThermo>>>> 0;\n hhuMixtureThermo>>>> 0;\n hhuMixtureThermo>>>> 0;\n hhuMixtureThermo>>>> 0;\n hhuMixtureThermo>>>> 0;\n hhuMixtureThermo>>>> 0;\n hhuMixtureThermo>>>> 0;\n hhuMixtureThermo>>>> 0;\n hierarchical 0;\n hollowConeInjector 0;\n iC3H8O 0;\n indexedOctree 0;\n indexedParticle 0;\n injectorModel 0;\n injectorType 0;\n inletOutlet 0;\n inletOutletTotalTemperature 0;\n interfaceCompression 0;\n intersectedSurface 0;\n inverseDistance 0;\n inverseFaceDistance 0;\n inversePointDistance 0;\n inverseVolume 0;\n isoSurface 0;\n isoSurfaceCell 0;\n jplot 0;\n jumpCyclic 0;\n kEpsilon 0;\n kOmega 0;\n kOmegaSST 0;\n kOmegaSSTSAS 0;\n kqRWallFunction 0;\n kinematicCloud 0;\n labelField 0;\n labelList 0;\n labelListList 0;\n labelToCell 0;\n labelToFace 0;\n labelToPoint 0;\n laminar 0;\n laminarFlameSpeed 0;\n laplace 0;\n layerAdditionRemoval 0;\n layered 0;\n lduInterface 0;\n lduInterfaceField 0;\n lduMatrix 1;\n lduMesh 0;\n leastSquares 0;\n leastSquaresVectors 0;\n level 2;\n limitWith 0;\n limited 0;\n limitedCubic 0;\n limitedCubic01 0;\n limitedCubicV 0;\n limitedGamma 0;\n limitedLimitedCubic 0;\n limitedLimitedLinear 0;\n limitedLinear 0;\n limitedLinear01 0;\n limitedLinearV 0;\n limitedMUSCL 0;\n limitedSurfaceInterpolationScheme 0;\n limitedVanLeer 0;\n linear 0;\n linearFit 0;\n linearUpwind 0;\n linearUpwindV 0;\n liquid 0;\n locDynOneEqEddy 0;\n localBlended 0;\n localMax 0;\n localMin 0;\n localPointRegion 0;\n lowReOneEqEddy 0;\n manual 0;\n meshCutAndRemove 0;\n meshCutter 0;\n meshModifier 0;\n meshRefinement 0;\n meshSearch 0;\n meshToMesh 0;\n metis 0;\n midPoint 0;\n midPointAndFace 0;\n mixed 0;\n mixedEnthalpy 0;\n mixedInternalEnergy 0;\n mixedSmagorinsky 0;\n mixedUnburntEnthalpy 0;\n mixerFvMesh 0;\n modifyCell 0;\n modifyFace 0;\n modifyPoint 0;\n motionDiffusivity 0;\n motionDirectional 0;\n motionSmoother 0;\n motionSolver 0;\n movingConeTopoFvMesh 0;\n movingWallVelocity 0;\n muSgsSpalartAllmarasWallFunction 0;\n multiDirRefinement 0;\n multiHoleInjector 0;\n multiLevel 1;\n multivariateSelection 0;\n mutRoughWallFunction 0;\n mutSpalartAllmarasStandardRoughWallFunction 0;\n mutSpalartAllmarasStandardWallFunction 0;\n mutSpalartAllmarasWallFunction 0;\n mutWallFunction 0;\n nC3H8O 0;\n nbrToCell 0;\n nearestToCell 0;\n nearestToPoint 0;\n noAbsorptionEmission 0;\n noDragModel 0;\n noRadiation 0;\n none 0;\n normal 0;\n normalToFace 0;\n nuSgsSpalartAllmarasWallFunction 0;\n nutRoughWallFunction 0;\n nutSpalartAllmarasStandardRoughWallFunction 0;\n nutSpalartAllmarasStandardWallFunction 0;\n nutSpalartAllmarasWallFunction 0;\n nutWallFunction 0;\n obj 0;\n objectRegistry 0;\n off 0;\n omegaWallFunction 0;\n oneEqEddy 0;\n orientedSurface 0;\n oscillatingDisplacement 0;\n oscillatingFixedValue 0;\n oscillatingVelocity 0;\n outletInlet 0;\n outletStabilised 0;\n pair 0;\n parabolicCylindrical 0;\n parcel 0;\n partialSlip 0;\n passiveParticle 0;\n patch 0;\n patchToFace 0;\n patchZones 0;\n pdf 0;\n perfectInterface 0;\n pointIndexHitList 0;\n pointPatchField 0;\n pointScalarField 0;\n pointScalarField::DimensionedInternalField 0;\n pointSet 0;\n pointSphericalTensorField 0;\n pointSphericalTensorField::DimensionedInternalField 0;\n pointSymmTensorField 0;\n pointSymmTensorField::DimensionedInternalField 0;\n pointTensorField 0;\n pointTensorField::DimensionedInternalField 0;\n pointToCell 0;\n pointToFace 0;\n pointToPoint 0;\n pointVectorField 0;\n pointVectorField::DimensionedInternalField 0;\n pointZone 0;\n polyBoundaryMesh 0;\n polyMesh 0;\n polyMeshGeometry 0;\n polyMeshInfo 0;\n polyTopoChange 0;\n polyTopoChanger 0;\n powerLaw 0;\n pressureDirectedInletOutletVelocity 0;\n pressureDirectedInletVelocity 0;\n pressureInletOutletVelocity 0;\n pressureInletUniformVelocity 0;\n pressureInletVelocity 0;\n pressureNormalInletOutletVelocity 0;\n pressureSwirlInjector 0;\n primitiveMesh 0;\n primitiveMeshGeometry 0;\n probes 0;\n processor 0;\n processorLduInterface 0;\n processorLduInterfaceField 0;\n pureMixture>>> 0;\n pureMixture>>> 0;\n pureMixture>>> 0;\n quadratic 0;\n quadraticFit 0;\n quadraticLinearFit 0;\n quadraticLinearUpwindFit 0;\n quadraticUpwindFit 0;\n radiationModel 0;\n raw 0;\n reactingCloud 0;\n reaction 0;\n realizableKE 0;\n refinementHistory 0;\n refinementIterator 0;\n reflect 0;\n regIOobject 0;\n regionSplit 0;\n regionToCell 0;\n remove 0;\n removeCell 0;\n removeCells 0;\n removeFace 0;\n removeFaces 0;\n removePoint 0;\n removePoints 0;\n reverseLinear 0;\n rotatedBoxToCell 0;\n rotatingPressureInletOutletVelocity 0;\n rotatingTotalPressure 0;\n sampledPatch 0;\n sampledPlane 0;\n sampledSet 0;\n sampledSurface 0;\n saturateEvaporationModel 0;\n scalarAverageField 0;\n scalarField 0;\n scalarRange 0;\n scaleSimilarity 0;\n scatterModel 0;\n searchableBox 0;\n searchableSurface 0;\n sequential 0;\n setUpdater 0;\n sets 0;\n shapeList 0;\n shapeToCell 0;\n simple 0;\n sixDoFRigidBodyMotionConstraint 0;\n skewCorrected 0;\n skewCorrectionVectors 0;\n sliced 0;\n slidingInterface 0;\n slip 0;\n smooth 0;\n smoothSolver 0;\n solid 0;\n solidBodyMotionFunction 0;\n solidBodyMotionFvMesh 0;\n solution 0;\n spectEddyVisc 0;\n sphereToCell 0;\n spherical 0;\n sphericalTensorAverageField 0;\n sphericalTensorField 0;\n standardDragModel 0;\n standardEvaporationModel 0;\n staticFvMesh 0;\n steadyState 0;\n stl 0;\n string 0;\n stochasticDispersionRAS 0;\n supersonicFreestream 0;\n surfaceFeatures 0;\n surfaceInterpolation 0;\n surfaceInterpolationScheme 0;\n surfaceIntersection 0;\n surfaceNormalFixedValue 0;\n surfacePatch 0;\n surfacePatchIOList 0;\n surfaceScalarField 0;\n surfaceScalarField::DimensionedInternalField 0;\n surfaceSlipDisplacement 0;\n surfaceSphericalTensorField 0;\n surfaceSphericalTensorField::DimensionedInternalField 0;\n surfaceSymmTensorField 0;\n surfaceSymmTensorField::DimensionedInternalField 0;\n surfaceTensorField 0;\n surfaceTensorField::DimensionedInternalField 0;\n surfaceToCell 0;\n surfaceToPoint 0;\n surfaceVectorField 0;\n surfaceVectorField::DimensionedInternalField 0;\n surfaceWriter 0;\n surfaces 0;\n swirlInjector 0;\n symmTensorAverageField 0;\n symmTensorField 0;\n symmetryPlane 0;\n syringePressure 0;\n tensorAverageField 0;\n tensorField 0;\n tetDecomposedPolyMesh 0;\n thermoCloud 0;\n thermophysicalFunction 0;\n time 0;\n timeVaryingAlphaContactAngle 0;\n timeVaryingFlowRateInletVelocity 0;\n timeVaryingMappedFixedValue 0;\n timeVaryingTotalPressure 0;\n timeVaryingUniformFixedValue 0;\n timer 0;\n topoAction 0;\n topoCellLooper 0;\n topoChangerFvMesh 0;\n topoSet 0;\n topoSetSource 0;\n toroidal 0;\n totalPressure 0;\n totalTemperature 0;\n trackedParticle 0;\n trajectory 0;\n transform 0;\n treeDataCell 0;\n treeDataFace 0;\n treeDataTriSurface 0;\n treeLeaf 0;\n treeNode 0;\n triSurface 0;\n triSurfaceMesh 0;\n turbulenceModel 0;\n turbulentHeatFluxTemperature 0;\n turbulentInlet 0;\n turbulentIntensityKineticEnergyInlet 0;\n turbulentMixingLengthDissipationRateInlet 0;\n turbulentMixingLengthFrequencyInlet 0;\n uncorrected 0;\n undoableMeshCutter 0;\n uniform 0;\n uniformFixedValue 0;\n unitInjector 0;\n upwind 0;\n upwindCFCStencil 0;\n value 0;\n vanAlbada 0;\n vanAlbadaV 0;\n vanDriest 0;\n vanLeer 0;\n vanLeer01 0;\n vanLeerV 0;\n vector2DField 0;\n vectorAverageField 0;\n vectorField 0;\n velocityComponentLaplacian 0;\n velocityLaplacian 0;\n viscosityModel 0;\n volPointInterpolation 0;\n volScalarField 0;\n volScalarField::DimensionedInternalField 0;\n volSphericalTensorField 0;\n volSphericalTensorField::DimensionedInternalField 0;\n volSymmTensorField 0;\n volSymmTensorField::DimensionedInternalField 0;\n volTensorField 0;\n volTensorField::DimensionedInternalField 0;\n volVectorField 0;\n volVectorField::DimensionedInternalField 0;\n vtk 0;\n walkPatch 0;\n wall 0;\n wallHeatTransfer 0;\n wallLayerCells 0;\n wallModel 0;\n waveTransmissive 0;\n wedge 0;\n weighted 0;\n word 2;\n writer 0;\n xmgr 0;\n zeroGradient 0;\n zoneToCell 0;\n zoneToFace 0;\n zoneToPoint 0;\n}\n\n\nDimensionedConstants\n{\n unitSet CGS; // SI // USCS\n\n CGSCoeffs\n {\n universal\n {\n c c [ 0 1 -1 0 0 0 0 ] 2.99792e+10; // speed of light in vacuum (cm/s)\n G G [ -1 3 -2 0 0 0 0 ] 6.67429e-8; // gravitational constant (cm^3/(gs^2))\n h h [ 1 2 -1 0 0 0 0 ] 6.62607e-27; // Planck's constant (erg.s)\n }\n electromagnetic\n {\n e e [ 0 0 1 0 0 1 0 ] 4.803204e-10; // elementary charge (statcoulomb)\n }\n atomic\n {\n me me [ 1 0 0 0 0 0 0 ] 9.10938e-28; // electron mass (g)\n mp mp [ 1 0 0 0 0 0 0 ] 1.67262e-24; // proton mass (g)\n }\n physicoChemical\n {\n mu mu [ 1 0 0 0 0 0 0 ] 1.66054e-24; // atomic mass unit (g)\n k k [ 1 2 -2 -1 0 0 0 ] 1.38065e-16; // Boltzman constant (erg/K)\n }\n standard\n {\n //- Standard pressure [Pa]\n Pstd Pstd [ 1 -1 -2 0 0 0 0 ] 1000000; // 1 bar (barye)\n //- Standard temperature [degK]\n Tstd Tstd [ 0 0 0 1 0 0 0 ] 298.15; // should be same as in SI unit system\n }\n }\n\n SICoeffs\n {\n universal\n {\n c c [ 0 1 -1 0 0 0 0 ] 2.99792e+08;\n G G [ -1 3 -2 0 0 0 0 ] 6.67429e-11;\n h h [ 1 2 -1 0 0 0 0 ] 6.62607e-34;\n }\n electromagnetic\n {\n e e [ 0 0 1 0 0 1 0 ] 1.60218e-19;\n }\n atomic\n {\n me me [ 1 0 0 0 0 0 0 ] 9.10938e-31;\n mp mp [ 1 0 0 0 0 0 0 ] 1.67262e-27;\n }\n physicoChemical\n {\n mu mu [ 1 0 0 0 0 0 0 ] 1.66054e-27;\n k k [ 1 2 -2 -1 0 0 0 ] 1.38065e-23;\n }\n standard\n {\n //- Standard pressure [Pa]\n Pstd Pstd [ 1 -1 -2 0 0 0 0 ] 100000;\n //- Standard temperature [degK]\n Tstd Tstd [ 0 0 0 1 0 0 0 ] 298.15;\n }\n }\n USCSCoeffs\n {\n universal\n {\n c c [ 0 1 -1 0 0 0 0 ] 9.83558e+08;\n G G [ -1 3 -2 0 0 0 0 ] 1.06909e-09;\n h h [ 1 2 -1 0 0 0 0 ] 1.57234e-32;\n }\n electromagnetic\n {\n e e [ 0 0 1 0 0 1 0 ] 1.60218e-19;\n }\n atomic\n {\n me me [ 1 0 0 0 0 0 0 ] 2.00825e-30;\n mp mp [ 1 0 0 0 0 0 0 ] 3.68746e-27;\n }\n physicoChemical\n {\n mu mu [ 1 0 0 0 0 0 0 ] 3.66083e-27;\n k k [ 1 2 -2 -1 0 0 0 ] 1.82012e-22;\n }\n standard\n {\n //- Standard pressure [lbm/ft^2]\n Pstd Pstd [ 1 -1 -2 0 0 0 0 ] 2088.6;\n //- Standard temperature [degR]\n Tstd Tstd [ 0 0 0 1 0 0 0 ] 536.67;\n }\n }\n}\n\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/etc/controlDict_cgs_2.2.x", "content": "/*--------------------------------*- C++ -*----------------------------------*\\\n| ========= | |\n| \\\\ / F ield | OpenFOAM: The Open Source CFD Toolbox |\n| \\\\ / O peration | Version: 2.2.1 |\n| \\\\ / A nd | Web: www.OpenFOAM.org |\n| \\\\/ M anipulation | |\n\\*---------------------------------------------------------------------------*/\nFoamFile\n{\n version 2.0;\n format ascii;\n class dictionary;\n object controlDict;\n}\n\n// NB: the #functions do not work here\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nDocumentation\n{\n docBrowser \"firefox %f\";\n doxyDocDirs\n (\n \"$WM_PROJECT_USER_DIR/html\"\n \"~OpenFOAM/html\"\n \"$WM_PROJECT_DIR/doc/Doxygen/html\"\n );\n doxySourceFileExts\n (\n \"App_8C.html\"\n \"_8C.html\"\n );\n}\n\n\nInfoSwitches\n{\n writePrecision 6;\n writeJobInfo 0;\n writeDictionaries 0;\n\n // Allow case-supplied C++ code (#codeStream, codedFixedValue)\n allowSystemOperations 0;\n}\n\n\nOptimisationSwitches\n{\n // On NFS mounted file system: maximum wait for files to appear/get\n // updated. Set to 0 on distributed case.\n fileModificationSkew 30;\n\n //- Modification checking:\n // - timeStamp : use modification time on file\n // - inotify : use inotify framework\n // - timeStampMaster : do time stamp (and file reading) only on master.\n // - inotifyMaster : do inotify (and file reading) only on master.\n fileModificationChecking timeStampMaster;//inotify;timeStamp;inotifyMaster;\n\n commsType nonBlocking; //scheduled; //blocking;\n floatTransfer 0;\n nProcsSimpleSum 0;\n\n // Force dumping (at next timestep) upon signal (-1 to disable)\n writeNowSignal -1; //10;\n // Force dumping (at next timestep) upon signal (-1 to disable) and exit\n stopAtWriteNowSignal -1;\n}\n\n\nDebugSwitches\n{\n Analytical 0;\n APIdiffCoefFunc 0;\n Ar 0;\n BICCG 0;\n BirdCarreau 0;\n C10H22 0;\n C12H26 0;\n C13H28 0;\n C14H30 0;\n C16H34 0;\n C2H5OH 0;\n C2H6 0;\n C2H6O 0;\n C3H6O 0;\n C3H8 0;\n C4H10O 0;\n C6H14 0;\n C6H6 0;\n C7H16 0;\n C7H8 0;\n C8H10 0;\n C8H18 0;\n C9H20 0;\n CH3OH 0;\n CH4N2O 0;\n CarnahanStarling 0;\n CallbackRegistry 0;\n CentredFitData 0;\n CentredFitData 0;\n CentredFitData 0;\n CentredFitData 0;\n ChomiakInjector 0;\n Cloud 0;\n Cloud 0;\n Cloud 0;\n Cloud 0;\n Cloud 0;\n Cloud 0;\n Cloud 0;\n CoEuler 0;\n CompositionModel 0;\n ConeInjection 0;\n Constant 0;\n ConstantRateDevolatilisation 0;\n CrankNicolson 0;\n CrossPowerLaw 0;\n Cs 0;\n DIC 0;\n DICGaussSeidel 0;\n DILU 0;\n DILUGaussSeidel 0;\n DataEntry 0;\n DeardorffDiffStress 0;\n DispersionModel 0;\n DispersionRASModel 0;\n DragModel 0;\n ETAB 0;\n Ergun 0;\n Euler 0;\n EulerImplicit 0;\n EulerRotation 0;\n extendedCellToFaceStencil 0;\n FDIC 0;\n FaceCellWave 0;\n GAMG 0;\n GAMGAgglomeration 0;\n GAMGInterface 0;\n GAMGInterfaceField 0;\n Gamma 0;\n Gamma01 0;\n GammaV 0;\n Gauss 0;\n GaussSeidel 0;\n Gibilaro 0;\n Gidaspow 0;\n GidaspowErgunWenYu 0;\n GidaspowSchillerNaumann 0;\n GradientDispersionRAS 0;\n Gulders 0;\n GuldersEGR 0;\n H2O 0;\n HashTable 0;\n HeatTransferModel 0;\n HerschelBulkley 0;\n HrenyaSinclair 0;\n IC8H18 0;\n ICCG 0;\n IDDESDelta 0;\n IDEA 0;\n IFstream 0;\n IOMap 0;\n IOPtrList 0;\n IOPtrList 0;\n IOPtrList 0;\n IOPtrList 0;\n IOobject 0;\n InjectionModel 0;\n IntegrationScheme 0;\n JohnsonJackson 0;\n KRR4 0;\n KinematicCloud 0;\n KinematicCloud 0;\n KinematicCloud 0;\n KinematicParcel 0;\n KinematicParcel 0;\n LESModel 0;\n LESdelta 0;\n LESfilter 0;\n LISA 0;\n LRR 0;\n LRRDiffStress 0;\n LamBremhorstKE 0;\n LaunderGibsonRSTM 0;\n LaunderSharmaKE 0;\n LienCubicKE 0;\n LienCubicKELowRe 0;\n LienLeschzinerLowRe 0;\n MB 0;\n MC 0;\n MCV 0;\n MUSCL 0;\n MUSCL01 0;\n MUSCLV 0;\n ManualInjection 0;\n MarshakRadiation 0;\n MarshakRadiationFixedT 0;\n MassTransferModel 0;\n MeshWave 0;\n Minmod 0;\n MinmodV 0;\n N2 0;\n NSRDSfunc0 0;\n NSRDSfunc1 0;\n NSRDSfunc14 0;\n NSRDSfunc2 0;\n NSRDSfunc3 0;\n NSRDSfunc4 0;\n NSRDSfunc5 0;\n NSRDSfunc6 0;\n NSRDSfunc7 0;\n Newtonian 0;\n NoDispersion 0;\n NoDrag 0;\n NoHeatTransfer 0;\n NoInjection 0;\n NoMassTransfer 0;\n NoSurfaceReaction 0;\n NonlinearKEShih 0;\n ODE 0;\n ODESolver 0;\n OFstream 0;\n ORourke 0;\n OSPRE 0;\n OSPREV 0;\n P1 0;\n PBiCG 0;\n PCG 0;\n PackedList 0;\n ParSortableList 0;\n PatchToPatchInterpolation 0;\n Phi 0;\n PointEdgeWave 0;\n POSIX 0;\n Prandtl 0;\n PrimitivePatch 0;\n Pstream 0;\n QUICK 0;\n QUICKV 0;\n QZeta 0;\n RASModel 0;\n RK 0;\n RNGkEpsilon 0;\n RanzMarshall 0;\n ReactingCloud 0;\n ReactingParcel 0;\n Rebound 0;\n ReitzDiwakar 0;\n ReitzKHRT 0;\n RosinRammler 0;\n RutlandFlashBoil 0;\n SDA 0;\n SFCD 0;\n SFCDV 0;\n SHF 0;\n SIBS 0;\n SKA 0;\n SLTS 0;\n SRFModel 0;\n SRFVelocity 0;\n STARCDRotation 0;\n Schaeffer 0;\n SchillerNaumann 0;\n SinclairJackson 0;\n SingleKineticRateDevolatilisation 0;\n SingleMixtureFraction 0;\n Smagorinsky 0;\n SolverPerformance 1;\n SpalartAllmaras 0;\n SpalartAllmarasDDES 0;\n SpalartAllmarasIDDES 0;\n SphereDrag 0;\n StandardWallInteraction 0;\n StaticHashTable 0;\n StochasticDispersionRAS 0;\n SuperBee 0;\n SuperBeeV 0;\n SurfaceReactionModel 0;\n Syamlal 0;\n SyamlalOBrien 0;\n SyamlalRogersOBrien 0;\n TAB 0;\n Table 0;\n ThermoCloud 0;\n ThermoCloud 0;\n ThermoParcel 0;\n ThermoParcel 0;\n UMIST 0;\n UMISTV 0;\n UpwindFitData 0;\n UpwindFitData 0;\n UpwindFitData 0;\n WallInteractionModel 0;\n WenYu 0;\n aC11H10 0;\n absorptionEmissionModel 0;\n addCell 0;\n addFace 0;\n addPatchCellLayer 0;\n addPoint 0;\n advective 0;\n algebraicPair 0;\n alphaContactAngle 0;\n alphaFixedPressure 0;\n alphatWallFunction 0;\n angularOscillatingDisplacement 0;\n angularOscillatingVelocity 0;\n anisotropic 0;\n ash 0;\n atomizationModel 0;\n attachDetach 0;\n autoDensity 0;\n autoHexMeshDriver 0;\n autoLayerDriver 0;\n autoRefineDriver 0;\n autoSnapDriver 0;\n bC11H10 0;\n backgroundMeshDecomposition 0;\n backward 0;\n basePatch 0;\n basicKinematicCloud 0;\n basicKinematicParcel 0;\n basicMixture 0;\n basicReactingCloud 0;\n basicReactingParcel 0;\n fluidThermo 0;\n fluidThermoCloud 0;\n fluidThermoParcel 0;\n biLinearFit 0;\n binaryAbsorptionEmission 0;\n blended 0;\n blobsSheetAtomization 0;\n blobsSwirlInjector 0;\n booleanSurface 0;\n boundaryCutter 0;\n boundaryMesh 0;\n boundaryToFace 0;\n boundedBackward 0;\n boxToCell 0;\n boxToFace 0;\n boxToPoint 0;\n breakupModel 0;\n calculated 0;\n cell 0;\n cellClassification 0;\n cellCuts 0;\n cellDistFuncs 0;\n cellLimited 0;\n cellList 0;\n cellLooper 0;\n cellMDLimited 0;\n cellMotion 0;\n cellPoint 0;\n cellPointFace 0;\n cellPointWeight 0;\n cellSet 0;\n cellSizeControlSurfaces 0;\n cellToCell 0;\n cellToFace 0;\n cellToPoint 0;\n cellZone 0;\n centredCECStencil 0;\n centredCFCStencil 0;\n chemistryReader 0;\n chemistrySolver 0;\n chemkinReader 0;\n clippedLinear 0;\n cloud 0;\n cloudAbsorptionEmission 0;\n cloudScatter 0;\n collisionModel 0;\n combineFaces 0;\n commSchedule 0;\n commonRailInjector 0;\n compound 0;\n constInjector 0;\n constant 0;\n constantAbsorptionEmission 0;\n constantAlphaContactAngle 0;\n constantScatter 0;\n coordinateRotation 0;\n coordinateSystem 0;\n coordinateSystems 0;\n corrected 0;\n coupled 0;\n cubeRootVol 0;\n cubic 0;\n cubicUpwindFit 0;\n curve 0;\n cyclic 0;\n cyclicLduInterface 0;\n cyclicLduInterfaceField 0;\n cylinderToCell 0;\n cylindrical 0;\n decompositionMethod 0;\n definedHollowConeInjector 0;\n definedInjector 0;\n definedPressureSwirlInjector 0;\n diagTensorField 0;\n diagonal 0;\n dictionary 0;\n dimensionSet 1;\n mappedBase 0;\n mappedPatch 0;\n mappedVelocityFlux 0;\n directionMixed 0;\n directional 0;\n disallowGenericFvPatchField 0;\n disallowGenericPointPatchField 0;\n disallowGenericPolyPatch 0;\n dispersionLESModel 0;\n dispersionModel 0;\n dispersionRASModel 0;\n displacementComponentLaplacian 0;\n displacementInterpolation 0;\n displacementLaplacian 0;\n displacementSBRStress 0;\n distanceSurface 0;\n Distribution 0;\n downwind 0;\n dragModel 0;\n duplicatePoints 0;\n dx 0;\n dynMixedSmagorinsky 0;\n dynOneEqEddy 0;\n dynSmagorinsky 0;\n dynamicAlphaContactAngle 0;\n dynamicFvMesh 0;\n dynamicInkJetFvMesh 0;\n dynamicMotionSolverFvMesh 0;\n dynamicRefineFvMesh 0;\n edgeIntersections 0;\n edgeList 0;\n edgeSurface 0;\n empty 0;\n engineMesh 0;\n enrichedPatch 0;\n epsilonWallFunction 0;\n errorDrivenRefinement 0;\n evaporationModel 0;\n exponential 0;\n extendedLeastSquares 0;\n extendedLeastSquaresVectors 0;\n face 0;\n faceAreaPair 0;\n faceCoupleInfo 0;\n faceLimited 0;\n faceList 0;\n faceMDLimited 0;\n faceSet 0;\n faceToCell 0;\n faceToFace 0;\n faceToPoint 0;\n faceZone 0;\n fan 0;\n featureEdgeMesh 0;\n fieldToCell 0;\n file 0;\n fileName 2;\n filteredLinear 0;\n filteredLinear2 0;\n filteredLinear2V 0;\n filteredLinear3 0;\n filteredLinear3V 0;\n fixedEnthalpy 0;\n buoyantPressure 0;\n fixedFluxBoussinesqBuoyantPressure 0;\n fixedFluxPressure 0;\n fixedGradient 0;\n fixedInternalEnergy 0;\n fixedInternalValue 0;\n fixedNormalSlip 0;\n fixedPressureCompressibleDensity 0;\n fixedUnburntEnthalpy 0;\n fixedValue 0;\n flowRateInletVelocity 0;\n fluxCorrectedVelocity 0;\n foamChemistryReader 0;\n foamFile 0;\n forceCoeffs 0;\n forces 0;\n fourth 0;\n freestream 0;\n freestreamPressure 0;\n frictionalStressModel 0;\n functionObject 0;\n fv 0;\n fvMesh 0;\n fvMeshDistribute 0;\n fvMotionSolver 0;\n fvPatchField 0;\n fvScalarMatrix 0;\n fvSchemes 0;\n fvSphericalTensorMatrix 0;\n fvSymmTensorMatrix 0;\n fvTensorMatrix 0;\n fvVectorMatrix 0;\n fvsPatchField 0;\n general 0;\n generic 0;\n genericPatch 0;\n geomCellLooper 0;\n geometricSurfacePatch 0;\n global 0;\n globalIndexAndTransform 0;\n globalMeshData 0;\n globalPoints 0;\n gnuplot 0;\n gradientDispersionRAS 0;\n gradientEnthalpy 0;\n gradientInternalEnergy 0;\n gradientUnburntEnthalpy 0;\n granularPressureModel 0;\n hCombustionThermo 0;\n hMixtureThermo>>>> 0;\n hMixtureThermo>>>> 0;\n hMixtureThermo>>>> 0;\n hMixtureThermo>>>> 0;\n hMixtureThermo>>>> 0;\n hMixtureThermo 0;\n hMixtureThermo>>>> 0;\n hMixtureThermo>>>> 0;\n hThermo>>>> 0;\n hThermo>>>> 0;\n hThermo>>>> 0;\n harmonic 0;\n heatTransferModel 0;\n hexCellLooper 0;\n hexRef8 0;\n hhuCombustionThermo 0;\n hhuMixtureThermo>>>> 0;\n hhuMixtureThermo>>>> 0;\n hhuMixtureThermo>>>> 0;\n hhuMixtureThermo>>>> 0;\n hhuMixtureThermo>>>> 0;\n hhuMixtureThermo>>>> 0;\n hhuMixtureThermo>>>> 0;\n hhuMixtureThermo>>>> 0;\n hierarchical 0;\n hollowConeInjector 0;\n iC3H8O 0;\n indexedOctree 0;\n indexedParticle 0;\n injectorModel 0;\n injectorType 0;\n inletOutlet 0;\n inletOutletTotalTemperature 0;\n interfaceCompression 0;\n intersectedSurface 0;\n inverseDistance 0;\n inverseFaceDistance 0;\n inversePointDistance 0;\n inverseVolume 0;\n isoSurface 0;\n isoSurfaceCell 0;\n jplot 0;\n jumpCyclic 0;\n kEpsilon 0;\n kOmega 0;\n kOmegaSST 0;\n kOmegaSSTSAS 0;\n kqRWallFunction 0;\n kinematicCloud 0;\n labelField 0;\n labelList 0;\n labelListList 0;\n labelToCell 0;\n labelToFace 0;\n labelToPoint 0;\n laminar 0;\n laminarFlameSpeed 0;\n laplace 0;\n layerAdditionRemoval 0;\n layered 0;\n lduInterface 0;\n lduInterfaceField 0;\n lduMatrix 1;\n lduMesh 0;\n leastSquares 0;\n leastSquaresVectors 0;\n level 2;\n limitWith 0;\n limited 0;\n limitedCubic 0;\n limitedCubic01 0;\n limitedCubicV 0;\n limitedGamma 0;\n limitedLimitedCubic 0;\n limitedLimitedLinear 0;\n limitedLinear 0;\n limitedLinear01 0;\n limitedLinearV 0;\n limitedMUSCL 0;\n limitedSurfaceInterpolationScheme 0;\n limitedVanLeer 0;\n linear 0;\n linearFit 0;\n linearUpwind 0;\n linearUpwindV 0;\n liquid 0;\n locDynOneEqEddy 0;\n localBlended 0;\n localMax 0;\n localMin 0;\n localPointRegion 0;\n lowReOneEqEddy 0;\n manual 0;\n meshCutAndRemove 0;\n meshCutter 0;\n meshModifier 0;\n meshRefinement 0;\n meshSearch 0;\n meshToMesh 0;\n metis 0;\n midPoint 0;\n midPointAndFace 0;\n mixed 0;\n mixedEnthalpy 0;\n mixedInternalEnergy 0;\n mixedSmagorinsky 0;\n mixedUnburntEnthalpy 0;\n mixerFvMesh 0;\n modifyCell 0;\n modifyFace 0;\n modifyPoint 0;\n motionDiffusivity 0;\n motionDirectional 0;\n motionSmoother 0;\n motionSolver 0;\n movingConeTopoFvMesh 0;\n movingWallVelocity 0;\n muSgsSpalartAllmarasWallFunction 0;\n multiDirRefinement 0;\n multiHoleInjector 0;\n multiLevel 0;\n multivariateSelection 0;\n mutRoughWallFunction 0;\n mutSpalartAllmarasStandardRoughWallFunction 0;\n mutSpalartAllmarasStandardWallFunction 0;\n mutSpalartAllmarasWallFunction 0;\n mutWallFunction 0;\n nC3H8O 0;\n nbrToCell 0;\n nearestToCell 0;\n nearestToPoint 0;\n noAbsorptionEmission 0;\n noDragModel 0;\n noRadiation 0;\n none 0;\n normal 0;\n normalToFace 0;\n nuSgsSpalartAllmarasWallFunction 0;\n nutRoughWallFunction 0;\n nutSpalartAllmarasStandardRoughWallFunction 0;\n nutSpalartAllmarasStandardWallFunction 0;\n nutSpalartAllmarasWallFunction 0;\n nutWallFunction 0;\n obj 0;\n objectRegistry 0;\n off 0;\n omegaWallFunction 0;\n oneEqEddy 0;\n orientedSurface 0;\n oscillatingDisplacement 0;\n oscillatingFixedValue 0;\n oscillatingVelocity 0;\n outletInlet 0;\n outletStabilised 0;\n pair 0;\n parabolicCylindrical 0;\n parcel 0;\n partialSlip 0;\n passiveParticle 0;\n patch 0;\n patchToFace 0;\n patchZones 0;\n pdf 0;\n perfectInterface 0;\n pointIndexHitList 0;\n pointPatchField 0;\n pointScalarField 0;\n pointScalarField::DimensionedInternalField 0;\n pointSet 0;\n pointSphericalTensorField 0;\n pointSphericalTensorField::DimensionedInternalField 0;\n pointSymmTensorField 0;\n pointSymmTensorField::DimensionedInternalField 0;\n pointTensorField 0;\n pointTensorField::DimensionedInternalField 0;\n pointToCell 0;\n pointToFace 0;\n pointToPoint 0;\n pointVectorField 0;\n pointVectorField::DimensionedInternalField 0;\n pointZone 0;\n polyBoundaryMesh 0;\n polyMesh 0;\n polyMeshGeometry 0;\n polyMeshInfo 0;\n polyTopoChange 0;\n polyTopoChanger 0;\n powerLaw 0;\n pressureDirectedInletOutletVelocity 0;\n pressureDirectedInletVelocity 0;\n pressureInletOutletVelocity 0;\n pressureInletUniformVelocity 0;\n pressureInletVelocity 0;\n pressureNormalInletOutletVelocity 0;\n pressureSwirlInjector 0;\n primitiveMesh 0;\n primitiveMeshGeometry 0;\n probes 0;\n processor 0;\n processorLduInterface 0;\n processorLduInterfaceField 0;\n pureMixture>>> 0;\n pureMixture>>> 0;\n pureMixture>>> 0;\n quadratic 0;\n quadraticFit 0;\n quadraticLinearFit 0;\n quadraticLinearUpwindFit 0;\n quadraticUpwindFit 0;\n radiationModel 0;\n raw 0;\n reactingCloud 0;\n reaction 0;\n realizableKE 0;\n refinementHistory 0;\n refinementIterator 0;\n reflect 0;\n regIOobject 0;\n regionSplit 0;\n regionToCell 0;\n remove 0;\n removeCell 0;\n removeCells 0;\n removeFace 0;\n removeFaces 0;\n removePoint 0;\n removePoints 0;\n reverseLinear 0;\n rotatedBoxToCell 0;\n rotatingPressureInletOutletVelocity 0;\n rotatingTotalPressure 0;\n sampledPatch 0;\n sampledPlane 0;\n sampledSet 0;\n sampledSurface 0;\n saturateEvaporationModel 0;\n scalarAverageField 0;\n scalarField 0;\n scalarRange 0;\n scaleSimilarity 0;\n scatterModel 0;\n searchableBox 0;\n searchableSurface 0;\n sequential 0;\n setUpdater 0;\n sets 0;\n shapeList 0;\n shapeToCell 0;\n simple 0;\n sixDoFRigidBodyMotionConstraint 0;\n skewCorrected 0;\n skewCorrectionVectors 0;\n sliced 0;\n slidingInterface 0;\n slip 0;\n smooth 0;\n smoothSolver 0;\n solid 0;\n solidBodyMotionFunction 0;\n solidBodyMotionFvMesh 0;\n solution 0;\n spectEddyVisc 0;\n sphereToCell 0;\n spherical 0;\n sphericalTensorAverageField 0;\n sphericalTensorField 0;\n standardDragModel 0;\n standardEvaporationModel 0;\n staticFvMesh 0;\n steadyState 0;\n stl 0;\n string 0;\n stochasticDispersionRAS 0;\n supersonicFreestream 0;\n surfaceFeatures 0;\n surfaceInterpolation 0;\n surfaceInterpolationScheme 0;\n surfaceIntersection 0;\n surfaceNormalFixedValue 0;\n surfacePatch 0;\n surfacePatchIOList 0;\n surfaceScalarField 0;\n surfaceScalarField::DimensionedInternalField 0;\n surfaceSlipDisplacement 0;\n surfaceSphericalTensorField 0;\n surfaceSphericalTensorField::DimensionedInternalField 0;\n surfaceSymmTensorField 0;\n surfaceSymmTensorField::DimensionedInternalField 0;\n surfaceTensorField 0;\n surfaceTensorField::DimensionedInternalField 0;\n surfaceToCell 0;\n surfaceToPoint 0;\n surfaceVectorField 0;\n surfaceVectorField::DimensionedInternalField 0;\n surfaceWriter 0;\n surfaces 0;\n swirlInjector 0;\n symmTensorAverageField 0;\n symmTensorField 0;\n symmetryPlane 0;\n syringePressure 0;\n tensorAverageField 0;\n tensorField 0;\n tetDecomposedPolyMesh 0;\n thermoCloud 0;\n thermophysicalFunction 0;\n time 0;\n timeVaryingAlphaContactAngle 0;\n timeVaryingFlowRateInletVelocity 0;\n timeVaryingMappedFixedValue 0;\n timeVaryingTotalPressure 0;\n timeVaryingUniformFixedValue 0;\n timer 0;\n topoAction 0;\n topoCellLooper 0;\n topoChangerFvMesh 0;\n topoSet 0;\n topoSetSource 0;\n toroidal 0;\n totalPressure 0;\n totalTemperature 0;\n trackedParticle 0;\n trajectory 0;\n transform 0;\n treeDataCell 0;\n treeDataFace 0;\n treeDataTriSurface 0;\n treeLeaf 0;\n treeNode 0;\n triSurface 0;\n triSurfaceMesh 0;\n turbulenceModel 0;\n turbulentHeatFluxTemperature 0;\n turbulentInlet 0;\n turbulentIntensityKineticEnergyInlet 0;\n turbulentMixingLengthDissipationRateInlet 0;\n turbulentMixingLengthFrequencyInlet 0;\n uncorrected 0;\n undoableMeshCutter 0;\n uniform 0;\n uniformFixedValue 0;\n unitInjector 0;\n upwind 0;\n upwindCFCStencil 0;\n value 0;\n vanAlbada 0;\n vanAlbadaV 0;\n vanDriest 0;\n vanLeer 0;\n vanLeer01 0;\n vanLeerV 0;\n vector2DField 0;\n vectorAverageField 0;\n vectorField 0;\n velocityComponentLaplacian 0;\n velocityLaplacian 0;\n viscosityModel 0;\n volPointInterpolation 0;\n volScalarField 0;\n volScalarField::DimensionedInternalField 0;\n volSphericalTensorField 0;\n volSphericalTensorField::DimensionedInternalField 0;\n volSymmTensorField 0;\n volSymmTensorField::DimensionedInternalField 0;\n volTensorField 0;\n volTensorField::DimensionedInternalField 0;\n volVectorField 0;\n volVectorField::DimensionedInternalField 0;\n vtk 0;\n walkPatch 0;\n wall 0;\n wallHeatTransfer 0;\n wallLayerCells 0;\n wallModel 0;\n warnUnboundedGauss 1;\n waveTransmissive 0;\n wedge 0;\n weighted 0;\n word 2;\n writer 0;\n xmgr 0;\n zeroGradient 0;\n zoneToCell 0;\n zoneToFace 0;\n zoneToPoint 0;\n}\n\n\nDimensionedConstants\n{\n unitSet CGS; // SI; // USCS\n\n SICoeffs\n {\n universal\n {\n c c [ 0 1 -1 0 0 0 0 ] 2.99792e+08;\n G G [ -1 3 -2 0 0 0 0 ] 6.67429e-11;\n h h [ 1 2 -1 0 0 0 0 ] 6.62607e-34;\n }\n electromagnetic\n {\n e e [ 0 0 1 0 0 1 0 ] 1.60218e-19;\n }\n atomic\n {\n me me [ 1 0 0 0 0 0 0 ] 9.10938e-31;\n mp mp [ 1 0 0 0 0 0 0 ] 1.67262e-27;\n }\n physicoChemical\n {\n mu mu [ 1 0 0 0 0 0 0 ] 1.66054e-27;\n k k [ 1 2 -2 -1 0 0 0 ] 1.38065e-23;\n }\n standard\n {\n //- Standard pressure [Pa]\n Pstd Pstd [ 1 -1 -2 0 0 0 0 ] 100000;\n //- Standard temperature [degK]\n Tstd Tstd [ 0 0 0 1 0 0 0 ] 298.15;\n }\n }\n USCSCoeffs\n {\n universal\n {\n c c [ 0 1 -1 0 0 0 0 ] 9.83558e+08;\n G G [ -1 3 -2 0 0 0 0 ] 1.06909e-09;\n h h [ 1 2 -1 0 0 0 0 ] 1.57234e-32;\n }\n electromagnetic\n {\n e e [ 0 0 1 0 0 1 0 ] 1.60218e-19;\n }\n atomic\n {\n me me [ 1 0 0 0 0 0 0 ] 2.00825e-30;\n mp mp [ 1 0 0 0 0 0 0 ] 3.68746e-27;\n }\n physicoChemical\n {\n mu mu [ 1 0 0 0 0 0 0 ] 3.66083e-27;\n k k [ 1 2 -2 -1 0 0 0 ] 1.82012e-22;\n }\n standard\n {\n //- Standard pressure [lbm/ft^2]\n Pstd Pstd [ 1 -1 -2 0 0 0 0 ] 2088.6;\n //- Standard temperature [degR]\n Tstd Tstd [ 0 0 0 1 0 0 0 ] 536.67;\n }\n }\n}\n\n\nDimensionSets\n{\n unitSet SI; // USCS\n\n SICoeffs\n {\n // Basic units\n kg kg [ 1 0 0 0 0 0 0 ] 1.0;\n m m [ 0 1 0 0 0 0 0 ] 1.0;\n s s [ 0 0 1 0 0 0 0 ] 1.0;\n K K [ 0 0 0 1 0 0 0 ] 1.0;\n mol mol [ 0 0 0 0 1 0 0 ] 1.0;\n A A [ 0 0 0 0 0 1 0 ] 1.0;\n Cd Cd [ 0 0 0 0 0 0 1 ] 1.0;\n\n // Derived units\n Hz Hz [ s^-1 ] 1.0;\n N N [ kg m s^-2 ] 1.0;\n Pa Pa [ N m^-2 ] 1.0;\n J J [ N m ] 1.0;\n W W [ J s^-1 ] 1.0;\n\n // Some non-symbolic ones\n area area [m^2] 1.0;\n volume volume [m^3] 1.0;\n density density [ kg m^-3 ] 1.0;\n acceleration acceleration [ m s^-2 ] 1.0;\n kinematicPressure kinematicPressure [ Pa density^-1 ] 1.0;\n\n // Scaled units. Only allowed in dimensionedType (dimensionedScalar,\n // dimensionedVector etc.) and UniformDimensionedField, not\n // in DimensionedField or GeometricField\n cm cm [ m ] 1e-2;\n mm mm [ m ] 1e-3;\n km km [ m ] 1e3;\n\n // Set of units used for printing. Can be any basic or derived\n // but not scaled (only supported for dimensionedScalar, etc)\n //writeUnits (kg m s K mol A Cd);\n }\n\n USCSCoeffs\n {\n // Basic units\n lb lb [ 1 0 0 0 0 0 0 ] 1.0;\n ft ft [ 0 1 0 0 0 0 0 ] 1.0;\n s s [ 0 0 1 0 0 0 0 ] 1.0;\n R R [ 0 0 0 1 0 0 0 ] 1.0;\n mol mol [ 0 0 0 0 1 0 0 ] 1.0;\n A A [ 0 0 0 0 0 1 0 ] 1.0;\n Cd Cd [ 0 0 0 0 0 0 1 ] 1.0;\n\n // Set of units used for printing. Can be any basic or derived\n // but not scaled (only supported for dimensionedScalar, etc)\n //writeUnits (lb ft s R mol A Cd);\n }\n}\n\n\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/etc/cshrc", "content": "#----------------------------------*-sh-*--------------------------------------\n# CFDEMcoupling\n# Christoph Goniva\n# June 2012\n#------------------------------------------------------------------------------\n#\n# Script\n# etc/cshrc\n#\n# Description\n# Startup file for cfdem exporting environment variables\n# Sourced ~/.cshrc\n#\n#- add this block to your ~/.cshrc and modify for your installation\n#- you can test the correctness using cfdemSystemTest.sh\n\n## STANDARD BLOCK FOR REGULAR INSTALLATIONS\n##================================================#\n##- source cfdem env vars\n#setenv CFDEM_VERSION PUBLIC\n#setenv CFDEM_PROJECT_DIR $HOME/CFDEM/CFDEMcoupling-$CFDEM_VERSION-$WM_PROJECT_VERSION\n#setenv CFDEM_PROJECT_USER_DIR $HOME/CFDEM/$LOGNAME-$CFDEM_VERSION-$WM_PROJECT_VERSION\n#setenv CFDEM_bashrc $CFDEM_PROJECT_DIR/src/lagrangian/cfdemParticle/etc/cshrc\n#setenv CFDEM_LIGGGHTS_SRC_DIR $HOME/LIGGGHTS/LIGGGHTS-PUBLIC/src\n#setenv CFDEM_LIGGGHTS_MAKEFILE_NAME auto\n#setenv CFDEM_LPP_DIR $HOME/LIGGGHTS/mylpp/src\n#source $CFDEM_bashrc\n#================================================#\n#------------------------------------------------------------------------------\n\n\n## EXTENDED BLOCK FOR HIGHLY CUSTOMIZED INSTALLATIONS\n## you may insert this right above \"source $CFDEM_bashrc\"\n##================================================#\n#setenv CFDEM_SRC_DIR $CFDEM_PROJECT_DIR/src\n#setenv CFDEM_SOLVER_DIR $CFDEM_PROJECT_DIR/applications/solvers\n#setenv CFDEM_DOC_DIR $CFDEM_PROJECT_DIR/doc\n#setenv CFDEM_UT_DIR $CFDEM_PROJECT_DIR/applications/utilities\n#setenv CFDEM_TUT_DIR $CFDEM_PROJECT_DIR/tutorials\n#setenv CFDEM_LIGGGHTS_MAKEFILE_POSTFIX\n#setenv CFDEM_VERBOSE=false\n#================================================#\n\n#------------------------------------------------------------------------------\n#- export environment variables (adapt to your paths)\n#------------------------------------------------------------------------------\n\nif (! $?CFDEM_VERBOSE ) setenv CFDEM_VERBOSE true\n\nif (! $?CFDEM_SCHEMEMODE ) setenv CFDEM_SCHEMEMODE robust\n\n## small function defs\nalias addPath 'setenv PATH \\!*\\:${PATH}'\n\nalias addLDLib 'setenv LD_LIBRARY_PATH \\!*\\:${LD_LIBRARY_PATH}'\n\nalias cfdemecho 'if ($CFDEM_VERBOSE == \"true\") echo \\!*'\n\nalias cfdemecho2 'if ($CFDEM_VERBOSE == \"true\") echo \"using userdefined \\!* = ${\\!*}\"'\nalias setVar 'eval \"if (! $?\\!:1 ) then \\\\\neval setenv \\!:1 \\!:2 \\\\\ncfdemecho using default \\!:1 = \\!:2 \\\\\nelse \\\\\ncfdemecho2 \\!:1 \\\\\nendif\"'\n\ncfdemecho \"************************************\"\nsetVar CFDEM_SRC_DIR $CFDEM_PROJECT_DIR/src\nsetVar CFDEM_SOLVER_DIR $CFDEM_PROJECT_DIR/applications/solvers\nsetVar CFDEM_DOC_DIR $CFDEM_PROJECT_DIR/doc\nsetVar CFDEM_UT_DIR $CFDEM_PROJECT_DIR/applications/utilities\nsetVar CFDEM_TUT_DIR $CFDEM_PROJECT_DIR/tutorials\nsetVar CFDEM_RHEO_DIR $WM_PROJECT_DIR/../ViscoElastic/of60\nsetVar CFDEM_RHEO_LIB_DIR $FOAM_USER_LIBBIN\n\n#check if default lammps lib path should be used\nsetVar CFDEM_LAMMPS_LIB_DIR $CFDEM_LIGGGHTS_SRC_DIR/../lib\n\n#test CFDEM_LAMMPS_LIB_DIR\nset h=$CFDEM_LAMMPS_LIB_DIR/poems/Makefile.lammps\nif ( ! ($?h) ) then\n echo \"\"\n echo \"WARNING CFDEM_LAMMPS_LIB_DIR = $CFDEM_LAMMPS_LIB_DIR seems to be wrong\"\n echo \"\"\nendif\nunset h\n\n#- LIGGGHTS lib name\nif ( ($CFDEM_LIGGGHTS_MAKEFILE_NAME == auto) && ($?CFDEM_LIGGGHTS_MAKEFILE_POSTFIX) ) then\n setenv CFDEM_LIGGGHTS_LIB_NAME \"lmp_\"$CFDEM_LIGGGHTS_MAKEFILE_NAME\"_\"$CFDEM_LIGGGHTS_MAKEFILE_POSTFIX\nelse\n setenv CFDEM_LIGGGHTS_LIB_NAME lmp_$CFDEM_LIGGGHTS_MAKEFILE_NAME\nendif\n\nif ( ($WM_COMPILE_OPTION == Debug) && ($CFDEM_LIGGGHTS_MAKEFILE_NAME == auto) ) then\n setenv CFDEM_LIGGGHTS_LIB_NAME \"${CFDEM_LIGGGHTS_LIB_NAME}-fulldebug\"\nendif\n\n#- LIGGGHTS lib path\nsetVar CFDEM_LIGGGHTS_MAKEFILE_NAME \"auto\"\nsetVar CFDEM_LIGGGHTS_LIB_PATH $CFDEM_LIGGGHTS_SRC_DIR\n\n#- LIGGGHTS executable\nsetenv CFDEM_LIGGGHTS_EXEC $CFDEM_LIGGGHTS_LIB_PATH/$CFDEM_LIGGGHTS_LIB_NAME\n\n#- CFDEM lib name\nsetenv CFDEM_LIB_NAME lagrangianCFDEM-$CFDEM_VERSION-$WM_PROJECT_VERSION\n\n#- CFDEM compressible lib name\nsetenv CFDEM_LIB_COMP_NAME lagrangianCFDEMcomp-$CFDEM_VERSION-$WM_PROJECT_VERSION\n\n#check if additional libraries should be compiled together with solvers\nsetVar CFDEM_ADD_LIBS_DIR $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/addLibs_universal\nsetVar CFDEM_ADD_LIBS_NAME additionalLibs_$WM_PROJECT_VERSION\n\n# check addLibs path and file name\nset h=$CFDEM_ADD_LIBS_DIR/$CFDEM_ADD_LIBS_NAME\nif ( ! ($?h) ) then\n echo \"!!! ERROR !!!: CFDEM_ADD_LIBS_DIR/CFDEM_ADD_LIBS_NAME=$CFDEM_ADD_LIBS_DIR/$CFDEM_ADD_LIBS_NAME does not exist.\"\nendif\nunset h\n\n#-----------------------------------------------------\n# additional libraries\n\n#- LMP Many2Many lib path and makefile\nsetenv CFDEM_Many2ManyLIB_PATH $CFDEM_SRC_DIR/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayMany2Many/library\nsetenv CFDEM_Many2ManyLIB_MAKEFILENAME $CFDEM_LIGGGHTS_MAKEFILE_NAME\n\n#- LMP M2M lib path and makefile\nsetenv CFDEM_M2MLIB_PATH $CFDEM_SRC_DIR/lagrangian/cfdemParticle/subModels/dataExchangeModel/M2M/library\nsetVar CFDEM_M2MLIB_MAKEFILENAME $CFDEM_LIGGGHTS_MAKEFILE_NAME\n\n#- LMP M2MMS lib path and makefile\nsetenv CFDEM_M2MMSLIB_PATH $CFDEM_SRC_DIR/lagrangian/cfdemParticle/subModels/dataExchangeModel/M2M/library\nsetenv CFDEM_M2MMSLIB_MAKEFILENAME $CFDEM_LIGGGHTS_MAKEFILE_NAME\n\n#- socketLib lib path and makefile\nsetenv CFDEM_socketLibLIB_PATH $CFDEM_SRC_DIR/CoSimProtocols/socketLib\nsetenv CFDEM_socketLibLIB_MAKEFILENAME script\n\n#- LMP POEMS lib default path\nsetenv CFDEM_POEMSLIB_PATH $CFDEM_LAMMPS_LIB_DIR/poems\n#-----------------------------------------------------\n\n#- path to test harness\nsetenv CFDEM_TEST_HARNESS_PATH $CFDEM_PROJECT_USER_DIR/log/logFilesCFDEM-$CFDEM_VERSION-$WM_PROJECT_VERSION\n\n#- path to libraries\nsetVar CFDEM_LIB_DIR $CFDEM_PROJECT_DIR/platforms/$WM_OPTIONS/lib\nsetVar CFDEM_USER_LIB_DIR $CFDEM_PROJECT_USER_DIR/platforms/$WM_OPTIONS/lib\n\naddLDLib ${CFDEM_LIB_DIR}\naddLDLib ${CFDEM_USER_LIB_DIR}\n\n#- path to apps\nsetVar CFDEM_APP_DIR $CFDEM_PROJECT_DIR/platforms/$WM_OPTIONS/bin\nsetVar CFDEM_USER_APP_DIR $CFDEM_PROJECT_USER_DIR/platforms/$WM_OPTIONS/bin\n\naddPath ${CFDEM_APP_DIR}\naddPath ${CFDEM_USER_APP_DIR}\n\n#- path to OF version flag file\nsetenv CFDEM_OFVERSION_DIR $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/OFversion\n#------------------------------------------------------------------------------\n#- settings for lpp postproc tool\n#------------------------------------------------------------------------------\n\n#- nr of procs for lpp tool\nsetenv CFDEM_LPP_NPROCS 1\n\n#- nr of procs for lpp tool\nsetenv CFDEM_LPP_CHUNKSIZE 1\n\n#- shortcut to run lpp\nalias cfdemLpp 'python -i $CFDEM_LPP_DIR/lpp.py --cpunum $CFDEM_LPP_NPROCS --chunksize $CFDEM_LPP_CHUNKSIZE \\!:1'\n\n#------------------------------------------------------------------------------\n#- aliases for easy navigation (no changes necessary)\n#------------------------------------------------------------------------------\n#- shortcut to cfdem path\nalias cfdem 'cd $CFDEM_PROJECT_DIR'\n\n#- shortcut to src path\nalias cfdemSrc 'cd $CFDEM_SRC_DIR'\n\n#- shortcut to etc path\nalias cfdemEtc 'cd $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc'\n\n#- shortcut to tutorial path\nalias cfdemTut 'cd $CFDEM_TUT_DIR'\n\n#- shortcut to solver path\nalias cfdemSol 'cd $CFDEM_SOLVER_DIR'\n\n#- shortcut to utilities path\nalias cfdemUt 'cd $CFDEM_UT_DIR'\n\n#- shortcut to run path\nalias cfdemRun 'cd $CFDEM_PROJECT_USER_DIR/run'\n\n#- shortcut to user solver path\nalias cfdemUsrSol 'cd $CFDEM_PROJECT_USER_DIR/applications/solvers'\n\n#- shortcut to documentation path\nalias cfdemDoc 'cd $CFDEM_DOC_DIR'\n\n#- shortcut to open the doxygen with firefox\nalias cfdemDox 'firefox $CFDEM_DOC_DIR/doxygen/html/index.html'\n\n#- shortcut to LIGGGHTS path\nalias cfdemLIG 'cd $CFDEM_LIGGGHTS_SRC_DIR'\n\n#- shortcut to system test\nalias cfdemSysTest 'bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/cfdemSystemTest.sh'\n\n#- shortcut to pull LIGGGHTS\nalias cfdemPullLIG 'bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/pullLIGGGHTS.sh'\n\n#- shortcut to pull CFDEMcoupling\nalias cfdemPullCFDEMcoupling 'bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/pullCFDEMcoupling.sh'\n\n#- shortcut to clean CFDEM\nalias cfdemCleanCFDEM 'bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/cleanCFDEMcoupling.sh'\n\n#- shortcut to compile LIGGGHTS + sublibraries\nalias cfdemCompLIG 'bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileLIGGGHTS.sh'\n\n#- shortcut to compile LIGGGHTS' sublibraries\nalias cfdemCompLIGlibs 'bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileLIGGGHTS_lib.sh'\n\n#- shortcut to compile CFDEMcoupling +LIGGGHTS\nalias cfdemCompCFDEMall 'bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_all.sh'\n\n#- shortcut to compile CFDEMcoupling (src+solvers)\nalias cfdemCompCFDEM 'bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling.sh'\n\n#- shortcut to compile CFDEMcoupling src\nalias cfdemCompCFDEMsrc 'bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_src.sh'\n\n#- shortcut to compile CFDEMcoupling solvers\nalias cfdemCompCFDEMsol 'bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_sol.sh'\n\n#- shortcut to compile CFDEMcoupling utilities\nalias cfdemCompCFDEMuti 'bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_uti.sh'\n\n#- shortcut to test basic tutorials\nalias cfdemTestTUT 'bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/testTutorials.sh'\n\n#- refresh link to LIGGGHTS binary\nalias cfdemRefreshLigLink='ln -sf $CFDEM_LIGGGHTS_LIB_PATH/lib$CFDEM_LIGGGHTS_LIB_NAME.so $CFDEM_LIB_DIR'\n\n#- shortcut to change dictionaries according to OF version\n#cfdemChangeTutOFversion() { bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/OFVersionChange/shellScripts/cfdemChangeTutOFversion_all.sh $1; }\n#export -f cfdemChangeTutOFversion\n\n#- shortcut to visualize the clock model data\nalias vizClock 'python $CFDEM_UT_DIR/vizClock/matPlot.py'\n\n#- recursive touch of current directory\nalias touchRec 'find ./* -exec touch {} \\;'\n\n#- shortcut to run liggghts in serial\nalias cfdemLiggghts '$CFDEM_LIGGGHTS_EXEC -in \\!:1'\n\n#- shortcut to run liggghts in parallel\nalias cfdemLiggghtsPar 'mpirun -np \\!:2 -machinefile mynodes $CFDEM_LIGGGHTS_EXEC -in \\!:1'\nset is_openmpi=`mpirun -version | grep \"Open MPI\" | wc -l`\nif ( $is_openmpi == 1 ) then\n alias cfdemLiggghtsPar 'mpirun -oversubscribe -np \\!:2 $CFDEM_LIGGGHTS_EXEC -in \\!:1'\nendif\nunset is_openmpi\n\n#- shortcut to run lpp\nalias lpp 'python -i $CFDEM_LPP_DIR/lpp.py \\!:1'\n\n#- alias to unload environment, everything starting with CFDEM_ and containing cfdem\nalias cfdemUnsetEnv 'unsetenv cfdemLiggghts cfdemLiggghtsPar cfdemGrep cfdemListFiles cfdemChangeTutOFversion; unalias cfdemUnsetEnv; set cfdemDirs=\"$CFDEM_PROJECT_DIR $CFDEM_LIB_DIR $CFDEM_USER_LIB_DIR $CFDEM_APP_DIR $CFDEM_USER_APP_DIR\"; set foamClean=$WM_PROJECT_DIR/bin/foamCleanPath; set cleaned=`$foamClean \"$PATH\" \"$cfdemDirs\"`; if ( $status == 0 ) setenv PATH \"$cleaned\"; set cleaned=`($foamClean \"$LD_LIBRARY_PATH\" \"$cfdemDirs\"`; if ( $status == 0 ) setenv LD_LIBRARY_PATH \"$cleaned\"; unsetenv \"CFDEM_*\"; unalias \"cfdem*\"; unset foamClean cleaned;'\n\n# check if the directory exists\nif ( -d \"$CFDEM_PROJECT_USER_DIR\" ) then\n :\nelse\n if ( -d \"$CFDEM_PROJECT_DIR\" ) then\n echo \"make new dirs $CFDEM_PROJECT_USER_DIR ? (y/n)\"\n\tset YN=$<\n if ( $YN == \"y\" ) then\n mkdir -p $CFDEM_PROJECT_USER_DIR\n cd $CFDEM_PROJECT_USER_DIR\n mkdir run\n mkdir -p log/logFilesCFDEM-$CFDEM_VERSION-$WM_PROJECT_VERSION\n mkdir -p applications/solvers\n mkdir -p $CFDEM_LIB_DIR\n mkdir -p $CFDEM_USER_LIB_DIR\n mkdir -p $CFDEM_APP_DIR\n mkdir -p $CFDEM_USER_APP_DIR\n else\n echo \"aborted by user.\"\n exit\n endif\n else\n echo \"error in CFDEMcoupling's cshrc.\"\n exit\n endif\nendif\n\n# set thermophysical library version to 6, overwrite if OF5\nsetVar CFDEM_THERMOPHYSICAL_VERSION 6\n\n# detect OF version\nif ( $WM_PROJECT_VERSION =~ \"6\" ) then\n setenv CFDEM_WM_PROJECT_VERSION 60\nelse if ( $WM_PROJECT_VERSION =~ 5.* ) then\n setenv CFDEM_WM_PROJECT_VERSION 50\n cfdemecho \"************************************\"\n cfdemecho \"WARNING from your CFDEM code!\"\n cfdemecho \"WARNING: Coupling with your OpenFOAM(R) version is not officially supported!\"\n cfdemecho \"In doubt switch to OpenFOAM(R) 6.\"\n cfdemecho \"************************************\"\n setVar CFDEM_THERMOPHYSICAL_VERSION 5.x\n sleep 1.5\nelse if ( $WM_PROJECT_VERSION =~ \"4.*\" ) then\n setenv CFDEM_WM_PROJECT_VERSION 40\n cfdemecho \"************************************\"\n cfdemecho \"WARNING from your CFDEM code!\"\n cfdemecho \"WARNING: Coupling with your OpenFOAM(R) version is not officially supported!\"\n cfdemecho \"In doubt switch to OpenFOAM(R) 6.\"\n cfdemecho \"************************************\"\n sleep 1.5\nelse if ( $WM_PROJECT_VERSION =~ \"3.0.*\" ) then\n setenv CFDEM_WM_PROJECT_VERSION 30\n cfdemecho \"************************************\"\n cfdemecho \"WARNING from your CFDEM code!\"\n cfdemecho \"WARNING: Coupling with your OpenFOAM(R) version is not officially supported!\"\n cfdemecho \"In doubt switch to OpenFOAM(R) 6.\"\n cfdemecho \"************************************\"\n sleep 1.5\nelse if ( $WM_PROJECT_VERSION =~ \"v1606+\" ) then\n setenv CFDEM_WM_PROJECT_VERSION v1606\n cfdemecho \"************************************\"\n cfdemecho \"WARNING from your CFDEM code!\"\n cfdemecho \"WARNING: Coupling with your OpenFOAM(R) version is not officially supported!\"\n cfdemecho \"In doubt switch to OpenFOAM(R) 6.\"\n cfdemecho \"************************************\"\n sleep 1.5\nelse if ( $WM_PROJECT_VERSION =~ \"v1612+\" ) then\n setenv CFDEM_WM_PROJECT_VERSION v1606\n cfdemecho \"************************************\"\n cfdemecho \"WARNING from your CFDEM code!\"\n cfdemecho \"WARNING: Coupling with your OpenFOAM(R) version is not officially supported!\"\n cfdemecho \"In doubt switch to OpenFOAM(R) 6.\"\n cfdemecho \"************************************\"\n sleep 1.5\nelse if ( $WM_PROJECT_VERSION =~ \"2.4.*\" ) then\n setenv CFDEM_WM_PROJECT_VERSION 24\n cfdemecho \"************************************\"\n cfdemecho \"WARNING from your CFDEM code!\"\n cfdemecho \"WARNING: Coupling with your OpenFOAM(R) version is not officially supported!\"\n cfdemecho \"In doubt switch to OpenFOAM(R) 6.\"\n cfdemecho \"************************************\"\n sleep 1.5\nelse if ( $WM_PROJECT_VERSION == \"3.2\" ) then\n if ( $WM_FORK == \"extend\" ) then\n setenv CFDEM_WM_PROJECT_VERSION 132\n endif\n cfdemecho \"************************************\"\n cfdemecho \"WARNING from your CFDEM code!\"\n cfdemecho \"WARNING: Coupling with your OpenFOAM(R) version is not officially supported!\"\n cfdemecho \"In doubt switch to OpenFOAM(R) 6.\"\n cfdemecho \"************************************\"\n sleep 1.5\nelse\n clear\n cfdemecho \"************************************\"\n cfdemecho \"ERROR from your CFDEM code!\"\n cfdemecho \"ERROR: your OpenFOAM(R) version is not supported!\"\n cfdemecho \"Please use a version that is supported, i.e., see the bashrc file in the source directory!\"\n cfdemecho \"************************************\"\n sleep 1.5\nendif\n\ncfdemecho \"************************************\"\n\nunalias addPath addLDLib cfdemecho cfdemecho2 setVar\n" }, { "path": "src/lagrangian/cfdemParticle/etc/functions.sh", "content": "#!/bin/bash\n\n#===================================================================#\n# test routine for cfdem project \n# defining functions used by the shell scripts\n# Christoph Goniva - June. 2011, DCS Computing GmbH\n#===================================================================#\n\n#==================================#\n#- function to pull from a repo\n\npullRepo()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n logpath=\"$1\"\n logfileName=\"$2\"\n casePath=\"$3\"\n headerText=\"$4\"\n #--------------------------------------------------------------------------------#\n\n #- clean up old log file\n rm $logpath/$logfileName\n\n #- change path\n cd $casePath\n\n #- header\n echo 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n echo \"//=== $headerText ===//\" 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n #- write path\n pwd 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n #- pull\n git pull 2>&1 | tee -a $logpath/$logfileName\n}\n#==================================#\n\n#==================================#\n#- function to compile a cfdem library\n\ncompileLib()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n logpath=\"$1\"\n logfileName=\"$2\"\n casePath=\"$3\"\n headerText=\"$4\"\n #doClean=\"$5\"\n #--------------------------------------------------------------------------------#\n\n #- clean up old log file\n rm $logpath/$logfileName\n\n #- change path\n cd $casePath\n\n #- header\n echo 2>&1 | tee -a $logpath/$logfileName\n echo \"// $headerText //\" 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n #- write path\n pwd 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n #- wclean and wmake\n #if [ $doClean != \"noClean\" ]; then\n # check library to compile is compressible\n str=$casePath\n i=$((${#str}-4))\n ending=${str:$i:4}\n if [[ $ending == \"Comp\" ]]; then\n echo \"Compiling a compressible library - so doing an rmdepall of incomp library first.\"\n echo \"Please make sure to have the incompressible libraries first in the library-list.txt!\"\n cd $CFDEM_SRC_DIR/lagrangian/cfdemParticle\n echo \"changing to $PWD\"\n if [[ $WM_PROJECT_VERSION == v1606+ || $WM_PROJECT_VERSION == v1612+ || $WM_PROJECT_VERSION == v1706 || $WM_PROJECT_VERSION == 2.4.* || ($WM_PROJECT_VERSION == \"3.2\" && $WM_FORK == \"extend\") ]]; then\n rmdepall 2>&1 | tee -a $logpath/$logfileName\n else\n wrmdep 2>&1 | tee -a $logpath/$logfileName\n fi\n cd $casePath\n echo \"changing to $PWD\"\n else\n echo \"Compiling a incompressible library.\"\n fi\n if [[ $WM_PROJECT_VERSION == v1606+ || $WM_PROJECT_VERSION == v1612+ || $WM_PROJECT_VERSION == v1706 || $WM_PROJECT_VERSION == 2.4.* || ($WM_PROJECT_VERSION == \"3.2\" && $WM_FORK == \"extend\") ]]; then\n rmdepall 2>&1 | tee -a $logpath/$logfileName\n else\n wrmdep 2>&1 | tee -a $logpath/$logfileName\n fi\n wclean 2>&1 | tee -a $logpath/$logfileName\n rm -r $casePath/Make/cfdemParticle\n #fi\n wmake libso 2>&1 | tee -a $logpath/$logfileName\n\n if [ ${PIPESTATUS[0]} -ne 0 ]; then \n return 1\n fi\n\n #- keep terminal open\n #read\n}\n#==================================#\n\n#==================================#\n#- function to compile a cfdem solver\n\ncompileSolver()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n logpath=\"$1\"\n logfileName=\"$2\"\n casePath=\"$3\"\n headerText=\"$4\"\n #doClean=\"$5\"\n parallel=\"$5\"\n #--------------------------------------------------------------------------------#\n\n #- clean up old log file\n rm $logpath/$logfileName\n\n #- change path\n cd $casePath\n\n #- header\n echo 2>&1 | tee -a $logpath/$logfileName\n echo \"// $headerText //\" 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n #- write path\n pwd 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n # check if there is an Allwmake\n if [ -f \"Allwmake\" ]; then\n echo \"doing Allwclean and Allwmake for the solver\"\n bash Allwclean 2>&1 | tee -a $logpath/$logfileName\n bash Allwmake 2>&1 | tee -a $logpath/$logfileName\n else\n #- wclean and wmake\n #if [ $doClean != \"noClean\" ]; then\n if [[ $WM_PROJECT_VERSION == v1606+ || $WM_PROJECT_VERSION == v1612+ || $WM_PROJECT_VERSION == v1706 || $WM_PROJECT_VERSION == 2.4.* || ($WM_PROJECT_VERSION == \"3.2\" && $WM_FORK == \"extend\") ]]; then\n rmdepall 2>&1 | tee -a $logpath/$logfileName\n else\n wrmdep 2>&1 | tee -a $logpath/$logfileName\n fi\n wclean 2>&1 | tee -a $logpath/$logfileName\n #fi\n fi\n \n # compile parallel?\n if [[ $parallel == \"true\" ]]; then\n touch $logpath/$logfileName.tempXYZ\n wmake 2>&1 | tee -a $logpath/$logfileName #&\n rm $logpath/$logfileName.tempXYZ\n else\n touch $logpath/$logfileName.tempXYZ\n wmake 2>&1 | tee -a $logpath/$logfileName\n rm $logpath/$logfileName.tempXYZ\n\n fi\n\n #- keep terminal open\n #read\n}\n#==================================#\n\n#==================================#\n#- function to compile LIGGGHTS\n\ncompileLIGGGHTS()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n logpath=\"$1\"\n logfileName=\"$2\"\n headerText=\"$3\"\n clean=\"$4\"\n #--------------------------------------------------------------------------------#\n\n #- clean up old log file\n rm $logpath/$logfileName\n\n #- change path\n cd $CFDEM_LIGGGHTS_SRC_DIR\n\n #- header\n echo 2>&1 | tee -a $logpath/$logfileName\n echo \"// $headerText //\" 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n #- write path\n pwd 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n # LIGGGHTS compilation flags\n if [[ $WM_NCOMPPROCS == \"\" ]]; then\n LIG_COMP_FLAGS=\" \"\n else\n LIG_COMP_FLAGS=\"-j $WM_NCOMPPROCS \"\n fi\n\n if [[ ${WM_COMPILE_OPTION} == \"Debug\" ]] && [[ $CFDEM_LIGGGHTS_MAKEFILE_NAME == \"auto\" ]]; then\n LIG_COMP_FLAGS=\"${LIG_COMP_FLAGS} debug=FULL\"\n fi\n\n #- clean and make\n if [[ $clean == \"false\" ]]; then\n echo \"not cleaning LIGGGHTS\"\n else\n rm $CFDEM_LIGGGHTS_SRC_DIR/$CFDEM_LIGGGHTS_LIB_NAME\n make clean-$CFDEM_LIGGGHTS_MAKEFILE_NAME postfix=$CFDEM_LIGGGHTS_MAKEFILE_POSTFIX ${LIG_COMP_FLAGS} 2>&1 | tee -a $logpath/$logfileName\n rm $CFDEM_LIGGGHTS_SRC_DIR/\"lib\"$CFDEM_LIGGGHTS_LIB_NAME\".a\"\n echo \"cleaning LIGGGHTS\"\n fi\n \n echo \"compiling LIGGGHTS with ${LIG_COMP_FLAGS}\"\n make $CFDEM_LIGGGHTS_MAKEFILE_NAME postfix=$CFDEM_LIGGGHTS_MAKEFILE_POSTFIX ${LIG_COMP_FLAGS} 2>&1 | tee -a $logpath/$logfileName\n make makeshlib 2>&1 | tee -a $logpath/$logfileName\n make -f Makefile.shlib $CFDEM_LIGGGHTS_MAKEFILE_NAME postfix=$CFDEM_LIGGGHTS_MAKEFILE_POSTFIX ${LIG_COMP_FLAGS} 2>&1 | tee -a $logpath/$logfileName\n\n if [ ${PIPESTATUS[0]} -ne 0 ]; then \n return 1\n fi\n}\n\n#==================================#\n#- function to compile a lammps lib\n\ncompileLMPlib()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n logpath=\"$1\"\n logfileName=\"$2\"\n headerText=\"$3\"\n makeFileName=\"$4\"\n libraryPath=\"$5\"\n compilationModeSwitch=\"$6\"\n #--------------------------------------------------------------------------------#\n\n #- change path\n if [ -d \"$libraryPath\" ]; then\n cd $libraryPath\n else\n echo \"\"\n echo \"lib path $libraryPath does not exist - check settings in .../etc/bashrc.\"\n read\n fi\n\n # LIGGGHTS compilation flags\n if [[ $WM_NCOMPPROCS == \"\" ]]; then\n LIG_COMP_FLAGS=\" \"\n else\n LIG_COMP_FLAGS=\"-j $WM_NCOMPPROCS \"\n fi\n\n if [[ ${WM_COMPILE_OPTION} == \"Debug\" ]] && [[ $CFDEM_LIGGGHTS_MAKEFILE_NAME == \"auto\" ]]; then\n LIG_COMP_FLAGS=\"${LIG_COMP_FLAGS} debug=FULL\"\n fi\n\n\n # check if compilation of library should be done with a separate script\n if [[ $makeFileName == \"Makefile.script\" ]]; then\n echo \"use script to complile...\"\n ./compileMe.sh\n else\n # Fallback if $makeFileName does not exist\n if [[ ! -f \"${makeFileName}\" ]]; then\n echo \"WARNING: userdefined Makefile ${makeFileName} cannot be found in ${libraryPath}, using default Makefile.mpi\"\n makeFileName=\"Makefile.mpi\"\n fi\n\n #Just check if library is there and and abort if not\n if [[ $compilationModeSwitch == \"false\" ]]; then\n if [ -d \"$libraryPath\" ]; then\n echo \"lib path $libraryPath EXISTS!\"\n libraries=$(ls ${libraryPath}/*.a 2> /dev/null | wc -l)\n if [[ $libraries != \"0\" ]]; then\n echo \"... and contains the following libraries: \"\n ls $libraryPath/*.a\n echo \"Congratulations! Check passed! \"\n else\n echo \"\"\n echo \"ERROR!!\"\n echo \"... could not find Library!\"\n echo \"... it should contain a *.a file to be linked to the final application.\"\n echo \"You need to ensure all libaries in this path are compiled.\"\n echo \"$libraryPath\"\n echo \"are compiled. Therefore, you may want to use an appropriate script that compiles these libraries first. (e.g. cfdemCompLIGlibs)\"\n read\n fi\n fi\n else\n if [[ $compilationModeSwitch == \"noClean\" ]]; then\n echo \"compileLMPlib will skip the cleaning step!\"\n echo \"\"\n else\n #Clean and then compile library\n #- clean up old log file\n rm $logpath/$logfileName\n fi\n #- header\n echo 2>&1 | tee -a $logpath/$logfileName\n echo \"// $headerText //\" 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n #- write path\n pwd 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n if [[ $makeFileName == \"Makefile.Install\" ]]; then\n echo \"using Install.sh\"\n bash Install.sh 0 2>&1 | tee -a $logpath/$logfileName\n bash Install.sh 1 2>&1 | tee -a $logpath/$logfileName\n else\n if [[ $compilationModeSwitch == \"noClean\" ]]; then\n echo \"compileLMPlib will skip the cleaning step!\"\n echo \"\"\n else\n #- clean up\n echo \"make clean\" 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n make -f $makeFileName clean 2>&1 | tee -a $logpath/$logfileName\n fi\n\n #- compile\n echo \"compiling LIB with ${LIG_COMP_FLAGS}\"\n echo \"make\" 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n make -f $makeFileName ${LIG_COMP_FLAGS} 2>&1 | tee -a $logpath/$logfileName\n\n if [ ${PIPESTATUS[0]} -ne 0 ]; then \n return 1\n fi\n fi\n fi\n fi\n}\n#==================================#\n\n#==================================#\n#- function to clean CFDEMcoupling solvers and src\n\ncleanCFDEM()\n{\n echo \"do you really want to clean CFDEM src?\"\n echo \"if not, abort with ctrl-C\"\n read\n\n #**********************************************\n #cleaning libraries\n whitelist=\"$CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/library-list.txt\"\n echo \"\"\n echo \"Please provide the libraries to be cleaned in the $whitelist file.\"\n\n if [ ! -f \"$whitelist\" ];then\n echo \"$whitelist does not exist in $CWD. Nothing will be done.\"\n NLINES=0\n COUNT=0\n else\n NLINES=`wc -l < $whitelist`\n COUNT=0\n fi\n\n while [ $COUNT -lt $NLINES ]\n do\n let COUNT++ \n LINE=`head -n $COUNT $whitelist | tail -1`\n \n # white lines\n if [[ \"$LINE\" == \"\" ]]; then\n continue\n # comments\n elif [[ \"$LINE\" == \\#* ]]; then\n continue\n # paths\n elif [[ \"$LINE\" == */dir ]]; then\n echo \"will change path...\"\n LINE=$(echo \"${LINE%????}\")\n path=\"$CFDEM_PROJECT_DIR/src/$LINE\"\n cd $path\n #continue\n fi\n\n cd $path\n echo \"cleaning library $PWD\"\n if [[ $WM_PROJECT_VERSION == v1606+ || $WM_PROJECT_VERSION == v1612+ || $WM_PROJECT_VERSION == v1706 || $WM_PROJECT_VERSION == 2.4.* || ($WM_PROJECT_VERSION == \"3.2\" && $WM_FORK == \"extend\") ]]; then\n rmdepall\n else\n wrmdep\n fi\n wclean \n rm -r ./Make/linux*\n rm -r ./lnInclude\n done\n\n\n #**********************************************\n #cleaning utilities\n echo \"removing object files in\"\n echo \" $CFDEM_UT_DIR\"\n rm -r $CFDEM_UT_DIR/*/Make/linux*\n rm -r $CFDEM_UT_DIR/*/Make/linux*\n rm -r $CFDEM_UT_DIR/*/*.dep\n\n\n\n #**********************************************\n #cleaning solvers\n whitelist=\"$CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/solver-list.txt\"\n echo \"\"\n echo \"Please provide the solvers to be cleaned in the $whitelist file.\"\n\n if [ ! -f \"$whitelist\" ];then\n echo \"$whitelist does not exist in $CWD. Nothing will be done.\"\n NLINES=0\n COUNT=0\n else\n NLINES=`wc -l < $whitelist`\n COUNT=0\n fi\n\n while [ $COUNT -lt $NLINES ]\n do\n let COUNT++ \n LINE=`head -n $COUNT $whitelist | tail -1`\n \n # white lines\n if [[ \"$LINE\" == \"\" ]]; then\n continue\n # comments\n elif [[ \"$LINE\" == \\#* ]]; then\n continue\n # paths\n elif [[ \"$LINE\" == */dir ]]; then\n echo \"will change path...\"\n LINE=$(echo \"${LINE%????}\")\n path=\"$CFDEM_SOLVER_DIR/$LINE\"\n cd $path\n #continue\n fi\n\n cd $path \n echo \"cleaning solver $PWD\"\n if [[ $WM_PROJECT_VERSION == v1606+ || $WM_PROJECT_VERSION == v1612+ || $WM_PROJECT_VERSION == v1706 || $WM_PROJECT_VERSION == 2.4.* || ($WM_PROJECT_VERSION == \"3.2\" && $WM_FORK == \"extend\") ]]; then\n rmdepall\n else\n wrmdep\n fi\n wclean \n done\n\n #**********************************************\n #cleaning logs\n rm $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/log/log_*\n}\n#==================================#\n\n#==================================#\n#- function to clean CFDEMcoupling case\n\ncleanCFDEMcase()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n casepath=\"$1\"\n keepDEMrestart=\"$2\"\n keepCFDmesh=\"$3\"\n #--------------------------------------------------------------------------------#\n\n echo \"deleting data at: $casePath ? otherwise press Ctrl-C:\\n\"\n read\n source $WM_PROJECT_DIR/bin/tools/CleanFunctions\n #CFD\n cd $casePath/CFD\n if [[ $keepCFDmesh == true ]]; then\n echo \"keeping CFD mesh files\"\n cp -r constant/polyMesh constant/polyMesh_backup\n cleanCase\n mv constant/polyMesh_backup constant/polyMesh\n rm -r constant/polyMesh_backup\n else\n echo \"deleting CFD mesh files\"\n cleanCase\n fi\n\n #CFDEM\n rm -r $casePath/CFD/clockData\n rm -r $casePath/CFD/particleProbes\n rm -r $casePath/CFD/averageProps/\n rm -r $casePath/CFD/octave/octave-core\n rm -r $casePath/CFD/octave/octave-workspace\n rm -r $casePath/remotePlace\n rm -r $casePath/CFD/oldProcDirs\n rm -r $casePath/CFD/tmp.balance\n rm $casePath/CFD/callgrind.out.*\n rm -r $casePath/CFD/hpctoolkit-*\n rm -r $casePath/CFD/warnings.liggghts\n rm $casePath/log_*\n #DEM\n rm $casePath/DEM/post/*\n touch $casePath/DEM/post/.gitignore\n if [[ $keepDEMrestart == true ]]; then\n echo \"keeping DEM restart files\"\n else\n rm $casePath/DEM/post/restart/*\n fi\n touch $casePath/DEM/post/restart/.gitignore\n rm $casePath/DEM/tmp.lammps.variable\n rm $casePath/DEM/log*\n rm $casePath/DEM/.portOffset.txt\n #ParScale\n rm $casePath/CFD/*.dat\n rm $casePath/CFD/*.pascal\n rm $casePath/CFD/*.profile\n rm -r $casePath/CFD/pascal/0.*\n rm -r $casePath/CFD/pascal/1\n rm -r $casePath/CFD/pascal/1.*\n rm -r $casePath/CFD/pascal/2\n rm -r $casePath/CFD/pascal/2.*\n rm -r $casePath/CFD/pascal/3\n rm -r $casePath/CFD/pascal/3.*\n rm -r $casePath/CFD/pascal/4\n rm -r $casePath/CFD/pascal/4.*\n rm -r $casePath/CFD/pascal/5\n rm -r $casePath/CFD/pascal/5.*\n rm -r $casePath/CFD/pascal/6\n rm -r $casePath/CFD/pascal/6.*\n rm -r $casePath/CFD/pascal/7\n rm -r $casePath/CFD/pascal/7.*\n rm -r $casePath/CFD/pascal/8\n rm -r $casePath/CFD/pascal/8.*\n rm -r $casePath/CFD/pascal/9\n rm -r $casePath/CFD/pascal/9.*\n rm -r $casePath/CFD/pascal/10\n rm -r $casePath/CFD/pascal/10.*\n cd $casePath\n echo \"done\"\n}\n\n#==================================#\n#- function to run a DEM case\n\nDEMrun()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n logpath=\"$1\"\n logfileName=\"$2\"\n casePath=\"$3\"\n headerText=\"$4\"\n solverName=\"$5\"\n debugMode=\"$6\"\n #--------------------------------------------------------------------------------#\n\n if [[ $debugMode == \"on\" ]]; then\n debugMode=\"valgrind\"\n elif [[ $debugMode == \"strict\" ]]; then\n #debugMode=\"valgrind --leak-check=full -v --trace-children=yes --track-origins=yes\" \n debugMode=\"valgrind --tool=memcheck --track-origins=yes --leak-check=yes --show-reachable=yes --num-callers=20 --track-fds=yes\" \n elif [[ $debugMode == \"strictXML\" ]]; then\n #debugMode=\"valgrind --leak-check=full -v --trace-children=yes --track-origins=yes\" \n debugMode=\"valgrind --tool=memcheck --leak-check=yes --leak-check-heuristics=stdstring,length64,newarray,multipleinheritance --show-reachable=no --num-callers=20 --track-fds=yes --xml=yes --xml-file=valgrind.xml\" \n else\n debugMode=\"\"\n fi\n\n #- clean up old log file\n rm $logpath/$logfileName\n\n #- change path\n cd $casePath/DEM\n\n #- header\n echo 2>&1 | tee -a $logpath/$logfileName\n echo \"// $headerText //\" 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n #- write path\n pwd 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n #- run applictaion\n $debugMode $CFDEM_LIGGGHTS_EXEC -in $solverName 2>&1 | tee -a $logpath/$logfileName\n\n #- keep terminal open (if started in new terminal)\n #read\n}\n#==================================#\n\n#==================================#\n#- function to detect MPI variant\n\nget_mpirun_cmd()\n{\n is_openmpi=`mpirun -version | grep \"Open MPI\" | wc -l`\n # Open MPI (version > 3) no longer allows oversubscription by default, we do want that though\n if [[ $is_openmpi == 1 ]]; then\n echo \"mpirun -oversubscribe\"\n else\n echo \"mpirun\"\n fi\n}\n#==================================#\n\n#==================================#\n#- function to run a DEM case in parallel\n\nparDEMrun()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n logpath=\"$1\"\n logfileName=\"$2\"\n casePath=\"$3\"\n headerText=\"$4\"\n solverName=\"$5\"\n nrProcs=\"$6\"\n machineFileName=\"$7\"\n debugMode=\"$8\"\n #--------------------------------------------------------------------------------#\n\n if [[ $debugMode == \"on\" ]]; then\n debugMode=\"valgrind\"\n elif [[ $debugMode == \"strict\" ]]; then\n #debugMode=\"valgrind --leak-check=full -v --trace-children=yes --track-origins=yes\" \n debugMode=\"valgrind --tool=memcheck --track-origins=yes --leak-check=yes --show-reachable=yes --num-callers=20 --track-fds=yes\" \n elif [[ $debugMode == \"strictXML\" ]]; then\n #debugMode=\"valgrind --leak-check=full -v --trace-children=yes --track-origins=yes\" \n debugMode=\"valgrind --tool=memcheck --leak-check=yes --leak-check-heuristics=stdstring,length64,newarray,multipleinheritance --show-reachable=no --num-callers=20 --track-fds=yes --xml=yes --xml-file=valgrind.xml\" \n else\n debugMode=\"\"\n fi\n\n #- clean up old log file\n rm $logpath/$logfileName\n\n #- change path\n cd $casePath/DEM\n\n #- header\n echo 2>&1 | tee -a $logpath/$logfileName\n echo \"// $headerText //\" 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n #- write path\n pwd 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n #- detect mpi variant and set oversubscribe flag if open mpi\n MPIRUN_CMD=`get_mpirun_cmd`\n\n #- run applictaion\n if [[ $machineFileName == \"none\" ]]; then\n $MPIRUN_CMD -np $nrProcs $debugMode $CFDEM_LIGGGHTS_EXEC -in $solverName 2>&1 | tee -a $logpath/$logfileName\n else\n $MPIRUN_CMD -machinefile $machineFileName -np $nrProcs $debugMode $CFDEM_LIGGGHTS_EXEC -in $solverName 2>&1 | tee -a $logpath/$logfileName\n fi\n\n #- keep terminal open (if started in new terminal)\n #read\n}\n#==================================#\n\n#==================================#\n#- function to run a CFD case\n\nCFDrun()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n logpath=\"$1\"\n logfileName=\"$2\"\n casePath=\"$3\"\n headerText=\"$4\"\n solverName=\"$5\"\n debugMode=\"$6\"\n #--------------------------------------------------------------------------------#\n\n if [[ $debugMode == \"on\" ]]; then\n debugMode=\"valgrind\"\n else\n debugMode=\"\"\n fi\n\n #- clean up old log file\n rm $logpath/$logfileName\n\n #- change path\n cd $casePath/CFD\n\n #- header\n echo 2>&1 | tee -a /$logpath/$logfileName\n echo \"// $headerText //\" 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n #- write path\n pwd 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n #- clean up case\n #rm couplingFiles/*\n\n #- run applictaion\n $debugMode $solverName 2>&1 | tee -a $logpath/$logfileName\n\n #- keep terminal open (if started in new terminal)\n #read\n}\n#==================================#\n\n#==================================#\n#- function to run a CFD case in parallel !!!NOT DEBUGGED!!!\nparCFDrun()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n logpath=\"$1\"\n logfileName=\"$2\"\n casePath=\"$3\"\n headerText=\"$4\"\n solverName=\"$5\"\n nrProcs=\"$6\"\n machineFileName=\"$7\"\n debugMode=\"$8\"\n #--------------------------------------------------------------------------------#\n\n if [[ $debugMode == \"on\" ]]; then\n debugMode=\"valgrind\"\n else\n debugMode=\"\"\n fi\n\n #- clean up old log file\n rm $logpath/$logfileName\n\n #- change path\n cd $casePath\n\n #- remove old data\n rm -rf processor*\n\n #- decompose case\n decomposePar\n\n #- make proc dirs visible\n count=0\n for i in `seq $nrProcs`\n do\n let count=$i-1\n (cd $casePath/processor$count && touch file.foam)\n done\n\n #- header\n echo 2>&1 | tee -a /$logpath/$logfileName\n echo \"// $headerText //\" 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n #- write path\n pwd 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n #- detect mpi variant and set oversubscribe flag if open mpi\n MPIRUN_CMD=`get_mpirun_cmd`\n\n #- run applictaion\n if [[ $machineFileName == \"none\" ]]; then\n $MPIRUN_CMD -np $nrProcs $debugMode $solverName -parallel 2>&1 | tee -a $logpath/$logfileName\n else\n $MPIRUN_CMD -machinefile $machineFileName -np $nrProcs $debugMode $solverName -parallel 2>&1 | tee -a $logpath/$logfileName\n fi\n\n #- keep terminal open (if started in new terminal)\n #read\n}\n#==================================#\n\n#==================================#\n#- function to run a parallel CFD-DEM case\n\nparCFDDEMrun()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n logpath=\"$1\"\n logfileName=\"$2\"\n casePath=\"$3\"\n headerText=\"$4\"\n solverName=\"$5\"\n nrProcs=\"$6\"\n machineFileName=\"$7\"\n debugMode=\"$8\"\n separateDEM=\"$9\"\n reconstuctCase=${10}\n decomposeCase=${11}\n remoteStorageLocation=${12}\n #--------------------------------------------------------------------------------#\n\n if [[ $debugMode == \"on\" ]]; then\n debugMode=\"valgrind\"\n elif [[ $debugMode == \"strict\" ]]; then\n #debugMode=\"valgrind --leak-check=full -v --trace-children=yes --track-origins=yes\" \n debugMode=\"valgrind --tool=memcheck --track-origins=yes --leak-check=yes --show-reachable=yes --num-callers=20 --track-fds=yes\"\n elif [[ $debugMode == \"strictXML\" ]]; then\n #debugMode=\"valgrind --leak-check=full -v --trace-children=yes --track-origins=yes\" \n debugMode=\"valgrind --tool=memcheck --leak-check=yes --leak-check-heuristics=stdstring,length64,newarray,multipleinheritance --show-reachable=no --num-callers=20 --track-fds=yes --xml=yes --xml-file=valgrind.xml\" \n elif [[ $debugMode == \"profile\" ]]; then\n if [[ $WM_COMPILE_OPTION == \"Debug\" ]]; then\n # make sure you did hpcstruct before\n debugMode=\"hpcrun\"\n rm -r $casePath/CFD/hpctoolkit-$solverName-measurements\n else\n echo \"\"\n echo \"WARNING - you do not use proper Debug flags! (for hpcrun you need Debug)\"\n echo \"using debugMode off now.\"\n debugMode=\"\"\n read\n fi\n elif [[ $debugMode == \"callgrind\" ]]; then\n if [[ $WM_COMPILE_OPTION == \"Debug\" ]]; then\n debugMode=\"valgrind --tool=callgrind\"\n else\n echo \"\"\n echo \"WARNING - you do not use proper Debug flags! Only when using debug, cachegrind will be able to look through you code.\"\n debugMode=\"valgrind --tool=callgrind\"\n read\n fi\n\n else\n debugMode=\"\"\n fi\n\n #- clean up old log file\n rm $logpath/$logfileName\n\n #- change path\n cd $casePath/CFD\n\n #- decompose case\n if [[ $decomposeCase == \"false\" ]]; then \n echo \"Not decomposing case.\"\n else\n echo \"Decomposing case.\"\n decomposePar -force\n\n if [[ $remoteStorageLocation == \"false\" || $remoteStorageLocation == \"\" ]]; then\n echo \"do nothing.\"\n else\n echo \"do links\"\n linkProcDirs $remoteStorageLocation\n fi\n fi\n\n #- make proc dirs visible\n count=0\n for i in `seq $nrProcs`\n do\n let count=$i-1\n (cd $casePath/CFD/processor$count && touch file.foam)\n done\n\n #- header\n echo 2>&1 | tee -a /$logpath/$logfileName\n echo \"// $headerText //\" 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n #- write path\n pwd 2>&1 | tee -a $logpath/$logfileName\n echo 2>&1 | tee -a $logpath/$logfileName\n\n #- clean up case\n rm couplingFiles/*\n\n #- detect mpi variant and set oversubscribe flag if open mpi\n MPIRUN_CMD=`get_mpirun_cmd`\n\n #- run DEM application (if separate)\n if [[ $separateDEM == \"false\" || $separateDEM == \"\" ]]; then\n echo \"no separate DEM run.\"\n else\n #gnome-terminal --title='separate DEM' -e \"bash $casePath/DEMrun.sh\"\n #source $casePath/DEMrun.sh &\n parDEMrun $logpath $logfileName\"_DEM\" $casePath $headerText $separateDEM $nrProcs $machineFileName $debugMode&\n fi \n\n #- run CFD application\n if [[ $machineFileName == \"none\" ]]; then\n $MPIRUN_CMD -np $nrProcs $debugMode $solverName -parallel 2>&1 | tee -a $logpath/$logfileName\n\n #- reconstruct case\n if [[ $reconstuctCase == \"true\" ]]; then \n #pseudoParallelRun \"reconstructPar\" $nrProcs\n reconstructPar -noLagrangian\n fi\n else\n $MPIRUN_CMD -machinefile $machineFileName -np $nrProcs $debugMode $solverName -parallel 2>&1 | tee -a $logpath/$logfileName\n\n #- reconstruct case\n if [[ $reconstuctCase == \"true\" ]]; then \n #pseudoParallelRun \"reconstructPar\" $nrProcs\n reconstructPar -noLagrangian\n fi\n fi\n\n if [[ $debugMode == \"hpcrun\" ]]; then\n if [ -f $CFDEM_APP_DIR/$solverName.hpcstruct ]; then\n rm -r hpctoolkit-$solverName-database*\n hpcprof -S $CFDEM_APP_DIR/$solverName.hpcstruct -I ./'*' hpctoolkit-$solverName-measurements\n else\n echo \"you need to run hpcstruct first for your app!\"\n read\n fi \n fi\n\n #- keep terminal open (if started in new terminal)\n #read\n}\n#==================================#\n\n\n#==================================#\n#- function to collect results from \n#- logfiles to one log file\n\ncollectLog()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n logpath=\"$1\"\n logfileName=\"$2\"\n casePath=\"$3\"\n headerText=\"$4\"\n nrOfLines=\"$5\"\n #--------------------------------------------------------------------------------#\n\n echo 2>&1 | tee -a $logpath/$logfileName\n echo \"// $headerText //\" 2>&1 | tee -a $logpath/$logfileName\n tail --lines=$nrOfLines $casePath |cut -d \" \" -f1- 2>&1 | tee -a $logpath/$logfileName\n}\n#==================================#\n\n#==================================#\n#- function to collect results from \n#- logfiles to one log file\n\ncollectLogCFDEMcoupling_sol()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n logpath=\"$1\"\n logfileName=\"$2\"\n casePath=\"$3\"\n #--------------------------------------------------------------------------------#\n # read name of solver\n SOLVERNAME=$(basename $casePath)\n \n # read last line of log\n LASTLINE=`tac $logpath/$logfileName | egrep -m 1 .`\n LASTSTRING=`echo ${LASTLINE##* }`\n LASTWORD=$(basename $LASTSTRING)\n\n # log if compilation was success \n if [[ $LASTWORD == $SOLVERNAME || $LASTWORD == \"date.\" || ${LASTWORD: -3} == \".so\" ]]; then\n echo \"$SOLVERNAME\" >> $logpath/log_compile_results_sol_success\n else\n echo \"$SOLVERNAME\" >> $logpath/log_compile_results_sol_fail\n fi\n}\n\ncollectLogCFDEMcoupling_src()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n logpath=\"$1\"\n logfileName=\"$2\"\n casePath=\"$3\"\n #--------------------------------------------------------------------------------#\n # read name of solver\n SOLVERNAME=$(basename $casePath)\n \n # read last line of log\n LASTLINE=`tac $logpath/$logfileName | egrep -m 1 .`\n LASTSTRING=`echo ${LASTLINE##* }`\n LASTWORD=$(basename $LASTSTRING)\n\n # log if compilation was success \n if [[ $LASTWORD == $SOLVERNAME || ${LASTWORD: -3} == \".so\" ]]; then\n echo \"$SOLVERNAME\" >> $logpath/log_compile_results_src_success\n else\n echo \"$SOLVERNAME\" >> $logpath/log_compile_results_src_fail\n fi\n}\n#==================================#\n\n#==================================#\n#- function to replace a line in a file where text consecutive\n# the old line must look like: oldWord\n# and will be replaced by: newWord\n\nreplaceLineInFile()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n logpath=\"$1\"\n logfileName=\"$2\"\n filePath=\"$3\"\n oldWord=\"$4\" # give text only until first \"/\"\n newWord=\"$5\"\n #--------------------------------------------------------------------------------#\n\n #- adapt /etc/bashrc\n echo \"replaceLineInFile $filePath\" 2>&1 | tee -a $logpath/$logfileName\n sed \"/$oldWord/ c\\ $newWord\" $filePath > $filePath\"2\" 2>&1 | tee -a $logpath/$logfileName\n cp $filePath\"2\" $filePath 2>&1 | tee -a $logpath/$logfileName\n rm $filePath\"2\" 2>&1 | tee -a $logpath/$logfileName\n}\n#==================================#\n\n#==================================#\n#- function to replace a line in a file where text is separated by one blank\n# the old line must look like: oldWord1 oldWord2\n# and will be replaced by: newWord1 newWord2\n\nreplaceSeparatedLineInFile()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n logpath=\"$1\"\n logfileName=\"$2\"\n filePath=\"$3\"\n oldWord1=\"$4\"\n oldWord2=\"$5\"\n newWord1=\"$6\"\n newWord2=\"$7\"\n #--------------------------------------------------------------------------------#\n\n #- adapt /etc/bashrc\n echo \"replaceLineInFile $filePath\" 2>&1 | tee -a $logpath/$logfileName\n sed \"/$oldWord1 $oldWord2/ c\\ $newWord1 $newWord2\" $filePath > $filePath\"2\" 2>&1 | tee -a $logpath/$logfileName\n cp $filePath\"2\" $filePath 2>&1 | tee -a $logpath/$logfileName\n rm $filePath\"2\" 2>&1 | tee -a $logpath/$logfileName\n}\n#==================================#\n\n#=======================================#\n#- script to run a function in pseudo-parallel\n# several runs of the function are started \n# simultanously. Only makes sense on shared memory sys\n# based on script by K. Wardle 6/22/09\n# published at CFDonline forum\n\npseudoParallelRun()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n appname=$1\n njobs=$2\n outputfile=\"log.$appname\"\n #--------------------------------------------------------------------------------#\n\nif [[ -z \"$njobs\" ]]; then \n echo \"\"\n echo \" K. Wardle 6/22/09\"\n echo \" bash script to run reconstructPar (or other fct) in pseudo-parallel mode\"\n echo \" by breaking time directories into multiple ranges\"\n echo \"\" \n echo \" USAGE: appname [output file is optional] \"\n echo \"\"\n exit\nfi\n\n\nappflag=\"-noZero\"\n\n#let njobs1=$njobs+1 \necho \"running $appname $appflag in pseudo-parallel mode on $njobs processors\"\n\n#count the number of time directories\nnsteps=`ls -d processor0/[0-9]*/ | wc -l`\necho \"do $appname on $nsteps time directories\"\n##nsteps=`ls processor0 | wc -l`\n#echo \"nsteps= $nsteps\"\n#let nsteps=$nsteps1-1\n\nlet nchunk=$nsteps/$njobs+1\n#echo \"nchunk = $nchunk\"\n\n#find max time\ntmin=`ls processor0 | sort -nr | tail -1`\n#echo \"tmin = $tmin\"\ntmax=`ls processor0 | sort -nr | head -1`\n#echo \"tmax = $tmax\"\n\necho \"making temp dir\"\ntempdir=\"temp.par$appname\"\nmkdir $tempdir\n\ntstart=$tmin\np=p\n\nfor i in `seq $njobs`\ndo\n let nn=$i*$nchunk\n tstop=`ls processor0 | sed -n $nn$p`\n if [[ $i == $njobs ]] \n\tthen\n\ttstop=$tmax\n fi\n \n echo \"Starting Job $i - $appname time = $tstart through $tstop\"\n `$appname $appflag -time \"$tstart:$tstop\" > $tempdir/output-$tstop &`\n \n let nn=$nn+1\n tstart=`ls processor0 | sed -n $nn$p` \ndone\n\n#sleep until jobs finish\n#if number of jobs > njobs, hold loop until job finishes\nnmore_old=`echo 0`\nuntil [ `ps -C $appname | wc -l` -eq 1 ]; \n do \n sleep 10\n## n1=`ps -C $appname | wc -l`\n## let n2=$n1-1\n nnow=`ls -d [0-9]*/ | wc -l` ##count time directories in case root dir, this will include 0\n let nmore=$nsteps-$nnow+1 ##calculate number left to reconstruct and subtract 0 dir\n if [[ $nmore != $nmore_old ]]\n then\n echo \"$nmore directories remaining...\"\n fi\n nmore_old=$nmore\n done\n\n#combine and cleanup\nif [[ -n \"$outputfile\" ]] \n then\n#check if output file already exists\n if [ -e \"$outputfile\" ] \n then\n echo \"output file $outputfile exists, moving to $outputfile.bak\"\n mv $outputfile $outputfile.bak\n fi\n\n echo \"cleaning up temp files\"\n for i in `ls $tempdir`\n do\n cat $tempdir/$i >> $outputfile\n done\nfi\n\nrm -rf $tempdir\n\necho \"finished\"\n\n}\n#==================================#\n#- function make a tar.gz copy with date tag from a directory\n# Remove the original directory\n\nbackupRemoveDir()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n filePath=\"$1\"\n backupPath=\"$2\"\n date=\"$3\"\n #--------------------------------------------------------------------------------#\n echo \"creating dirctory :\\n $filePath\"\"-until\"\"$date\\n\"\n mkdir $filePath\"-until\"$date\n echo \"move : $filePath/* to\\n $filePath\"\"-until\"\"$date\\n and tar.gz\"\n mv $filePath/* $filePath\"-until\"$date\n tar czvf $filePath\"-until\"$date.tar.gz $filePath\"-until\"$date\n rm -r $filePath\"-until\"$date\n mv $filePath\"-until\"$date.tar.gz $backupPath\n}\n\n#==================================#\n#- function make a tar.gz copy with date tag from a directory\n# Keep the original directory\n\nbackupDir()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n filePath=\"$1\"\n backupPath=\"$2\"\n date=\"$3\"\n #--------------------------------------------------------------------------------#\n echo \"creating dirctory :\\n $filePath\"\"-until\"\"$date\\n\"\n mkdir $filePath\"-until\"$date\n echo \"move : $filePath/* to\\n $filePath\"\"-until\"\"$date\\n and tar.gz\"\n cp -r $filePath/* $filePath\"-until\"$date\n tar czvf $filePath\"-until\"$date.tar.gz $filePath\"-until\"$date\n rm -r $filePath\"-until\"$date\n mv $filePath\"-until\"$date.tar.gz $backupPath\n}\n\n#========================================#\n#- function to check if a directory exits\ncheckDir()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n filePath=\"$1\"\n #--------------------------------------------------------------------------------#\n if [ -d \"$filePath\" ]; then\n echo \"true\" \n else\n echo \"false\" \n fi\n}\n\n#========================================#\n#- function to check if a directory exits\ncheckDirComment()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n filePath=\"$1\"\n varName=\"$2\"\n critical=\"$3\"\n #--------------------------------------------------------------------------------#\n if [ $(checkDir $filePath) == \"true\" ]; then\n echo \"valid:yes critical:$critical - $varName = $filePath\" \n else\n echo \"valid:NO critical:$critical - $varName = $filePath does not exist\" \n fi\n}\n\n#========================================#\n#- function to check if a variable exits\ncheckEnv()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n var=\"$1\"\n #--------------------------------------------------------------------------------#\n if [[ $var == \"\" ]]; then\n echo \"false\"\n else\n echo \"true\"\n fi\n}\n\n#========================================#\n#- function to check if a variable exits\ncheckEnvComment()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n var=\"$1\"\n varName=\"$2\"\n critical=\"$3\"\n #--------------------------------------------------------------------------------#\n if [ $(checkEnv $var) == \"true\" ]; then\n echo \"valid:yes critical:$critical - $varName = $var\" \n else\n echo \"valid:NO critical:$critical - $varName = $var variable not set!\" \n fi\n}\n\n#========================================#\n#- function to print a header to terminal\nprintHeader()\n{\n echo \"\"\n echo \"*********************************************\"\n echo \"* C F D E M (R) c o u p l i n g *\"\n echo \"* *\"\n echo \"* by DCS Computing GmbH *\"\n echo \"* www.dcs-computing.com *\"\n echo \"*********************************************\"\n echo \"\" \n}\n\n#========================================#\n#- track memory usage\ntrackMem()\n{\n\n #--------------------------------------------------------------------------------#\n #- define variables\n appname=\"$1\"\n fileName=\"$2\"\n #--------------------------------------------------------------------------------#\n\n rm $fileName\n\n echo \"please use only the the first 15 strings of the command !!!\"\n\n /usr/bin/printf \"%-6s %-9s %s\\n\" \"PID\" \"Total\" \"Command\" >> $fileName\n /usr/bin/printf \"%-6s %-9s %s\\n\" \"---\" \"-----\" \"-------\" >> $fileName\n\n for PID in $(/bin/ps -e | /usr/bin/awk '$1 ~ /[0-9]+/ { print $1 }')\n do\n CMD=$(/bin/ps -o comm -p $PID | /usr/bin/tail -1)\n\n if [[ $CMD == $appname ]]\n then\n\n TOTAL=$(/usr/bin/pmap $PID 2>/dev/null | /usr/bin/tail -1 | /usr/bin/awk '{ print $2 }')\n [ -n \"$TOTAL\" ] && /usr/bin/printf \"%-6s %-9s %s\\n\" \"$PID\" \"$TOTAL\" \"$CMD\"\n fi\n done | /usr/bin/sort -n -k2 >> $fileName\n}\n\n#========================================#\n#- remove brackets from file\nremoveBracketsFromFile()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n oldFileName=\"$1\"\n overwrite=\"$2\"\n #--------------------------------------------------------------------------------#\n\n if [[ $overwrite == \"true\" ]]\n then\n sed -i 's/[(,)]//g' $oldFileName\n else\n newFileName=\"$oldFileName\"\"_noBrackets\"\n sed -e 's/[(,)]//g' $oldFileName > $newFileName\n fi\n}\n\n#========================================#\n#- remove brackets from file\nlinkProcDirs()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n remoteDir=\"$1\"\n #--------------------------------------------------------------------------------#\n\n # check remote directory exist\n if [[ -d \"$remoteDir\" ]]\n then\n echo \" $remoteDir exists - **check**\"\n else\n Fatal \"ERROR: remote directory does not exist: $remoteDir\"\n fi\n\n # check case is decomposed\n if [[ -d \"processor0\" ]]\n then\n echo \" case is decomposed - **check**\"\n else\n Fatal \"ERROR: case is NOT decomposed - please do so and run again.\"\n fi\n\n # check CFD dir exists at remote location\n if [[ -d $remoteDir/CFD ]]\n then\n Fatal \"ERROR: there is (!) a dir called CFD at $remoteDir - please rename it and run again.\"\n else\n echo \" there is no dir called CFD at $remoteDir - **check**\"\n fi\n\n # create a dir CFD at remoteDir\n mkdir $remoteDir/CFD\n\n # create a backup dir oldProcDirs\n mkdir oldProcDirs\n\n # check if oldProcDirs is empty\n if [[ -d oldProcDirs/processor0 ]]\n then\n Fatal \"ERROR: ./oldProcDirs is not empty - please clean up and run again.\"\n else\n echo \" ./oldProcDirs is empty - **check**\"\n fi\n\n # moving proc dirs to oldProcsDir (backup)\n cp -r processor* $remoteDir/CFD\n mv processor* oldProcDirs\n\n # create a link to remote proc dirs\n counter=0\n for procDir in $remoteDir/CFD/*/; do\n ln -s $remoteDir/CFD/processor$counter processor$counter\n counter=$[counter + 1]\n done\n\n # create a link to postProcessing dir\n mkdir postProcessing\n mv postProcessing $remoteDir/CFD\n ln -s $remoteDir/CFD/postProcessing postProcessing\n\n # success\n echo \"linking was successful\"\n}\n\n#========================================#\n#- function to enable a LIGGGHTS package\nenableLiggghtsPackage()\n{\n #--------------------------------------------------------------------------------#\n #- define variables\n pkgName=\"$1\"\n whitelist=\"$CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/package-liggghts-list.txt\"\n #--------------------------------------------------------------------------------#\n\n if [ ! -f \"$CWD/$whitelist\" ];then\n echo \"$whitelist does not exist in $CWD. Nothing will be done.\"\n NLINES=0\n COUNT=0\n else\n NLINES=`wc -l < $CWD/$whitelist`\n COUNT=0\n fi\n\n\t\tfound=false\n while [ $COUNT -lt $NLINES ]\n do\n let COUNT++ \n LINE=`head -n $COUNT $CWD/$whitelist | tail -1`\n \n # white lines\n if [[ \"$LINE\" == \"\" ]]; then\n continue\n # comments\n elif [[ \"$LINE\" == \\#* ]]; then\n continue\n # paths\n elif [[ \"$LINE\" == */dir ]]; then\n LINE=$(echo \"${LINE%????}\")\n\t\t\t\t\t\t\t\techo \"$LINE\"\n\t\t\t\t\t\t\t\tif [[ \"$LINE\" == \"$pkgName\" ]]; then\n\t\t\t\t\t\t\t\t\t\techo \"Package $pkgName already enabled\"\n\t\t\t\t\t\t\t\t\t\tfound=true\n\t\t\t\t\t\t\t\t\t\tbreak\n\t\t\t\t\t\t\t\tfi\n fi\n done\n\n\t\tif [ $found = false ]; then\n\t\t\t\techo \"Package $pkgName not found - add it to list\"\n\t\t\t\techo $pkgName\"/dir\" >> $CWD/$whitelist\n\t\tfi\n}\n\n" }, { "path": "src/lagrangian/cfdemParticle/etc/library-liggghts-list.txt", "content": "#syntax: makefileName/dir\n#note: dir is not a path, just a keyword here\n###############################################\n" }, { "path": "src/lagrangian/cfdemParticle/etc/library-list.txt", "content": "lagrangian/cfdemParticle/dir\neulerian/scalarTransportModelsCFDEM/dir\neulerian/fvOptionsCFDEM/dir\n" }, { "path": "src/lagrangian/cfdemParticle/etc/package-liggghts-list.txt", "content": "#syntax: packageName/dir\n#note: dir is not a path, just a keyword here\n###############################################\n#POEMS/dir\n#PASCAL/dir\n" }, { "path": "src/lagrangian/cfdemParticle/etc/package-undo-liggghts-list.txt", "content": "#syntax: packageName/dir\n#note: dir is not a path, just a keyword here\n###############################################\nPOEMS/dir\nDIPOLE/dir\nASPHERE/dir\nPASCAL/dir\n" }, { "path": "src/lagrangian/cfdemParticle/etc/pullLIGGGHTS.sh", "content": "#!/bin/bash\n\n#===================================================================#\n# pull routine for LIGGGHTS, part of CFDEMproject \n# Christoph Goniva - August. 2013, DCS Computing GmbH\n#===================================================================\n\n#- include functions\nsource $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/functions.sh\n\nNOW=\"$(date +\"%Y-%m-%d-%H:%M\")\"\nlogDir=\"log\"\n\ncd $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc\nmkdir -p $logDir\n\n#--------------------------------------------------------------------------------#\n#- define variables\nlogpath=\"$(dirname \"$(readlink -f ${BASH_SOURCE[0]})\")/$logDir\"\nlogfileName=\"log_pullLIGGGHTS\"\ncasePath=\"$CFDEM_LIGGGHTS_SRC_DIR\"\nheaderText=\"$logfileName\"\"-$NOW\"\n#--------------------------------------------------------------------------------#\n\npullRepo $logpath $logfileName $casePath $headerText\n" }, { "path": "src/lagrangian/cfdemParticle/etc/solver-list.txt", "content": "cfdemSolverPiso/dir\ncfdemSolverIB/dir\ncfdemSolverPisoScalar/dir\ncfdemSolverPisoSTM/dir\n" }, { "path": "src/lagrangian/cfdemParticle/etc/testTutorials.sh", "content": "#!/bin/bash\n\n#===================================================================#\n# script to run the basic examples\n# Christoph Goniva - June 2012, DCS Computing GmbH\n#===================================================================#\n\nwhitelist=\"tutorial-list.txt\"\n\nCWD=\"$(dirname \"$(readlink -f ${BASH_SOURCE[0]})\")\"\nNOW=\"$(date +\"%Y-%m-%d-%H:%M\")\"\n\necho \"\"\necho \"This routine will execute the CFDEMcoupling tutorial cases specified in tutorial-list.txt\"\necho \"\"\necho \"Are the variables CFDEM_TUT_DIR=$CFDEM_TUT_DIR\"\necho \"and CFDEM_SRC_DIR=$CFDEM_SRC_DIR correct? (y/n)\"\nread YN\nif [ \"$YN\" != \"y\" ];then\n \techo \"Aborted by user.\"\n \texit 1\nfi\n\necho \"\"\necho \"Please provide the examples to be calculated in the $CWD/$whitelist file.\"\necho \"structure:\"\necho \"path to provide the path relative to CFDEM_TUT_DIR\"\necho \"\"\necho \"example:\"\necho \"cfdemSolverPiso/settlingTestMPI/dir\"\necho \"\"\n\nif [ ! -f \"$CWD/$whitelist\" ];then\n echo \"$whitelist does not exist in $CWD\"\nelse\n NLINES=`wc -l < $CWD/$whitelist`\n COUNT=0\n\n for masterLogFile in \"$masterLogName\" #\"$masterLogName\"\"_valgrind\" \n do\n\n while [ $COUNT -lt $NLINES ]\n do\n let COUNT++ \n LINE=`head -n $COUNT $CWD/$whitelist | tail -1`\n \n # white lines\n if [[ \"$LINE\" == \"\" ]]; then\n continue\n # comments\n elif [[ \"$LINE\" == \\#* ]]; then\n continue\n # paths\n elif [[ \"$LINE\" == */dir ]]; then\n echo \"change path\"\n LINE=$(echo \"${LINE%????}\")\n path=\"$CFDEM_TUT_DIR/$LINE\"\n cd $path\n #continue\n fi\n\n #- execute tutorial\n echo \"running testcase $path\"\n bash Allrun.sh\n\n echo \"did the case run correcty? - press enter to proceed.\"\n read\n done\n done\nfi\n\n## run pvg tool on logfile\n#cd $CWD\n#grep \"==\" \"$masterLogName\"\"_valgrind\" > parallel_\"$masterLogName\"\"_valgrind\"\n\n## sort by first arg (+0 -0) and disable last resort comparison (-s)\n## so sorted by first arg only\n#sort +0 -0 -s parallel_\"$masterLogName\"\"_valgrind\" > tmp\n#mv tmp parallel_\"$masterLogName\"\"_valgrind\"\n\n" }, { "path": "src/lagrangian/cfdemParticle/etc/tutorial-list.txt", "content": "#===================================================================#\n# This file specifies the example cases being executed by\n# .../etc/testTutorial.sh , which can be run with the alias\n# cfdemTestTUT\n# Christoph Goniva - June. 2011, DCS Computing GmbH\n#===================================================================#\n\ncfdemPostproc/fillCylinder/dir\ncfdemSolverPiso/settlingTestMPI/dir\ncfdemSolverPiso/ErgunTestMPI/dir\ncfdemSolverPiso/ErgunTestMPI_cgs/dir\ncfdemSolverPiso/ErgunTestMPI_restart/dir\ncfdemSolverPiso/periodicChannel/dir\ncfdemSolverPiso/voidfractionTest/dir\ncfdemSolverIB/twoSpheresGlowinskiMPI/dir\ncfdemSolverPisoScalar/packedBedTemp/dir\ncfdemSolverPisoSTM/packedBedTemp/dir\n" }, { "path": "src/lagrangian/cfdemParticle/etc/utilities-list.txt", "content": "cfdemPostproc/dir\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/IOModel/IOModel/IOModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n#include \"IOModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(IOModel, 0);\n\ndefineRunTimeSelectionTable(IOModel, dictionary);\n\n// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nint IOModel::dumpDEMdata() const\n{\n return -1;\n}\n\nbool IOModel::dumpNow() const\n{\n //bool dmp(false);\n //if (time_.value()+SMALL > time_.endTime().value()-time_.deltaT().value() || time_.outputTime())\n // dmp=true;\n\n return time_.outputTime();\n}\n\nfileName IOModel::createTimeDir(fileName path) const\n{\n fileName timeDirPath(path/time_.timeName());\n mkDir(timeDirPath,0777);\n return timeDirPath;\n}\n\nfileName IOModel::createLagrangianDir(fileName path) const\n{\n fileName lagrangianDirPath(path/\"lagrangian\");\n mkDir(lagrangianDirPath,0777);\n fileName cfdemCloudDirPath(lagrangianDirPath/\"cfdemCloud1\");\n mkDir(cfdemCloudDirPath,0777);\n return cfdemCloudDirPath;\n}\n\nfileName IOModel::buildFilePath(word dirName) const\n{\n // create file structure\n\tfileName path(\"\");\n if(parOutput_)\n {\n \tpath=fileName(particleCloud_.mesh().time().path()/particleCloud_.mesh().time().timeName()/dirName/\"particleCloud\");\n \tmkDir(path,0777);\n } else\n {\n\t\tpath=fileName(\".\"/dirName);\n \tmkDir(path,0777);\n \tmkDir(fileName(path/\"constant\"),0777);\n \tOFstream* stubFile = new OFstream(fileName(path/\"particles.foam\"));\n \tdelete stubFile;\n }\n return path;\n}\n\nvoid IOModel::streamDataToPath(fileName path, double** array,int nPProc,word name,word type,word className,word finaliser) const\n{\n vector vec;\n OFstream* fileStream = new OFstream(fileName(path/name));\n *fileStream << \"FoamFile\\n\";\n *fileStream << \"{version 2.0; format ascii;class \"<< className << \"; location 0;object \"<< name <<\";}\\n\";\n *fileStream << nPProc <<\"\\n\";\n\n *fileStream << \"(\\n\";\n\n for(int index = 0;index < particleCloud_.numberOfParticles(); ++index)\n {\n if (particleCloud_.cfdemCloud::cellIDs()[index][0] > -1) // particle Found\n {\n if (type==\"scalar\"){\n *fileStream << array[index][0] << \" \\n\";\n }else if (type==\"position\" || type==\"vector\"){\n for(int i=0;i<3;i++) vec[i] = array[index][i];\n *fileStream <<\"( \"<< vec[0] <<\" \"< -1) // particle Found\n {\n if (type==\"scalar\"){\n *fileStream << array[index][0] << \" \\n\";\n }else if (type==\"position\" || type==\"vector\"){\n for(int i=0;i<3;i++) vec[i] = array[index][i];\n *fileStream <<\"( \"<< vec[0] <<\" \"< New\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n\n // Member Functions\n\n virtual int dumpDEMdata() const;\n\n virtual void allocFieldsToDEM() const { /* do nothing */ };\n\n bool dumpNow() const;\n\n fileName createTimeDir(fileName) const;\n\n fileName createLagrangianDir(fileName) const;\n\n fileName buildFilePath(word) const;\n\n void streamDataToPath(fileName,double**,int,word,word type,word className,word finaliser) const;\n\n void streamDataToPath(fileName,int**,int,word,word type,word className,word finaliser) const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/IOModel/IOModel/newIOModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"IOModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\nautoPtr IOModel::New\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n{\n word IOModelType\n (\n dict.lookup(\"IOModel\")\n );\n\n Info<< \"Selecting IOModel \"\n << IOModelType << endl;\n\n dictionaryConstructorTable::iterator cstrIter =\n dictionaryConstructorTablePtr_->find(IOModelType);\n\n if (cstrIter == dictionaryConstructorTablePtr_->end())\n {\n FatalError\n << \"IOModel::New(const dictionary&, const spray&) : \"\n << endl\n << \" unknown IOModelType type \"\n << IOModelType\n << \", constructor not in hash table\" << endl << endl\n << \" Valid IOModel types are :\"\n << endl;\n Info<< dictionaryConstructorTablePtr_->toc()\n << abort(FatalError);\n }\n\n return autoPtr(cstrIter()(dict,sm));\n}\n\n// * * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/IOModel/basicIO/basicIO.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"basicIO.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(basicIO, 0);\n\naddToRunTimeSelectionTable\n(\n IOModel,\n basicIO,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nbasicIO::basicIO\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n IOModel(dict,sm),\n //propsDict_(dict.subDict(typeName + \"Props\")),\n dirName_(\"lagrangian\"),\n path_(\"dev/null\"),\n nPProc_(-1),\n lagPath_(\"dev/null\")\n{\n //if (propsDict_.found(\"dirName\")) dirName_=word(propsDict_.lookup(\"dirName\"));\n path_ = buildFilePath(dirName_);\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nbasicIO::~basicIO()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\n// Public Member Functions\n\nint basicIO::dumpDEMdata() const\n{\n if (dumpNow())\n {\n // make time directory\n if (parOutput_) lagPath_=buildFilePath(dirName_);\n else\n {\n Info << \"createTimeDir(path_), path=\"< -1) count++;\n nPProc_=count;\n \n // stream data to file\n streamDataToPath(lagPath_, particleCloud_.positions(),nPProc_,\"positions\",\"vector\",\"Cloud\",\"0\");\n streamDataToPath(lagPath_, particleCloud_.velocities(),nPProc_,\"v\",\"vector\",\"vectorField\",\"\");\n streamDataToPath(lagPath_, particleCloud_.radii(),nPProc_,\"r\",\"scalar\",\"scalarField\",\"\");\n }\n return nPProc_;\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n// Private Member Functions\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/IOModel/basicIO/basicIO.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n basicIO\n\nSourceFiles\n basicIO.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef basicIO_H\n#define basicIO_H\n\n#include \"IOModel.H\"\n#include \"dataExchangeModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass basicIO\n:\n public IOModel\n{\n\nprivate:\n\n //dictionary propsDict_;\n\n word dirName_;\n\n fileName path_;\n\n mutable int nPProc_;\n\n // Member Functions\n\nprotected:\n mutable fileName lagPath_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"basicIO\");\n\n\n // Constructors\n\n //- Construct from components\n basicIO\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~basicIO();\n\n\n // Member Functions\n int dumpDEMdata() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/IOModel/noIO/noIO.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"noIO.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(noIO, 0);\n\naddToRunTimeSelectionTable\n(\n IOModel,\n noIO,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nnoIO::noIO\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n IOModel(dict,sm)\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nnoIO::~noIO()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/IOModel/noIO/noIO.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n noIO\n\nSourceFiles\n noIO.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef noIO_H\n#define noIO_H\n\n#include \"IOModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass noIO\n:\n public IOModel\n{\n\npublic:\n\n //- Runtime type information\n TypeName(\"off\");\n\n\n // Constructors\n\n //- Construct from components\n noIO\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~noIO();\n\n\n // Member Functions\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/IOModel/sophIO/sophIO.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"sophIO.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \"forceModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(sophIO, 0);\n\naddToRunTimeSelectionTable\n(\n IOModel,\n sophIO,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nsophIO::sophIO\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n basicIO(dict,sm)\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nsophIO::~sophIO()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\n// Public Member Functions\n\nint sophIO::dumpDEMdata() const\n{\n int npProcs(-1);\n\n if (dumpNow())\n {\n int idDragExp=particleCloud_.idDragExp();\n npProcs=basicIO::dumpDEMdata();\n\n // stream data to file\n streamDataToPath(lagPath_, particleCloud_.voidfractions(),npProcs,\"voidfractions\",\"scalar\",\"scalarField\",\"\");\n streamDataToPath(lagPath_, particleCloud_.impForces(),npProcs,\"impForces\",\"vector\",\"vectorField\",\"\");\n streamDataToPath(lagPath_, particleCloud_.expForces(),npProcs,\"expForces\",\"vector\",\"vectorField\",\"\");\n streamDataToPath(lagPath_, particleCloud_.fieldsToDEM[idDragExp],npProcs,\"DEMForces\",\"vector\",\"vectorField\",\"\");\n }\n return npProcs;\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n// Private Member Functions\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/IOModel/sophIO/sophIO.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n sophIO\n\nSourceFiles\n sophIO.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef sophIO_H\n#define sophIO_H\n\n#include \"IOModel.H\"\n#include \"basicIO.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass sophIO\n:\n public basicIO\n{\n\nprivate:\n\n // Member Functions\n\npublic:\n\n //- Runtime type information\n TypeName(\"sophIO\");\n\n\n // Constructors\n\n //- Construct from components\n sophIO\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~sophIO();\n\n\n // Member Functions\n int dumpDEMdata() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/IOModel/trackIO/trackIO.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"trackIO.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(trackIO, 0);\n\naddToRunTimeSelectionTable\n(\n IOModel,\n trackIO,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\ntrackIO::trackIO\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n sophIO(dict,sm),\n idFieldToDEMid_(-1)\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\ntrackIO::~trackIO()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\n// Public Member Functions\n\nint trackIO::dumpDEMdata() const\n{\n int npProcs(-1);\n\n if (dumpNow())\n {\n npProcs=sophIO::dumpDEMdata();\n\n // stream data to file\n streamDataToPath(lagPath_, particleCloud_.fieldsToDEM[idFieldToDEMid_],npProcs,\"id\",\"scalar\",\"scalarField\",\"\");\n }\n return npProcs;\n}\n\nvoid trackIO::allocFieldsToDEM() const\n{\n // register data to be communicated\n particleCloud_.registerFieldsToDEM(\"id\",\"scalar-atom\",idFieldToDEMid_,true);\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n// Private Member Functions\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/IOModel/trackIO/trackIO.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n trackIO\n\nSourceFiles\n trackIO.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef trackIO_H\n#define trackIO_H\n\n#include \"sophIO.H\"\n#include \"interpolationCellPoint.H\"\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass trackIO\n:\n public sophIO\n{\n\nprivate:\n\n // Member Functions\n\n mutable label idFieldToDEMid_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"trackIO\");\n\n\n // Constructors\n\n //- Construct from components\n trackIO\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~trackIO();\n\n\n // Member Functions\n int dumpDEMdata() const;\n\n void allocFieldsToDEM() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/averagingModel/averagingModel/averagingModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n#include \"averagingModel.H\"\n#include \"voidFractionModel.H\"\n#include \"forceModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(averagingModel, 0);\n\ndefineRunTimeSelectionTable(averagingModel, dictionary);\n\n// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\nvoid averagingModel::undoVectorAverage\n(\n volVectorField& fieldPrev,\n volVectorField& fieldNext,\n volScalarField& weightField,\n double** const& value,\n double** const& weight,\n double**const& mask,\n bool single\n) const\n{\n// WARNING - not sure if this is valid for dilute model!!!\n\n if(!single) fieldPrev == fieldNext;\n\n label cellI;\n vector valueVec;\n scalar weightP;\n\n for(int index=0; index< particleCloud_.numberOfParticles(); index++)\n {\n for(int subCell=0;subCell= 0)\n {\n for(int i=0;i<3;i++) valueVec[i] = value[index][i];\n weightP = weight[index][subCell];\n\n if(weightField[cellI] == weightP)\n {\n fieldNext[cellI] = vector(0,0,0);\n }else\n {\n fieldNext[cellI] = (fieldNext[cellI]*weightField[cellI]-valueVec*weightP)/(weightField[cellI]-weightP);\n }\n }\n }\n }\n\n // correct cell values to patches\n fieldNext.correctBoundaryConditions();\n}\n\nvoid averagingModel::undoVectorSum\n(\n volVectorField& field,\n double** const& value,\n double** const& weight,\n double**const& mask\n) const\n{\n label cellI;\n vector valueVec;\n scalar weightP;\n\n for(int index=0; index< particleCloud_.numberOfParticles(); index++)\n {\n for(int subCell=0;subCell= 0)\n {\n for(int i=0;i<3;i++) valueVec[i] = value[index][i];\n weightP = weight[index][subCell];\n\n field[cellI] -= valueVec*weightP;\n }\n }//forAllSubPoints\n }\n\n // correct cell values to patches\n field.correctBoundaryConditions();\n}\n\nvoid averagingModel::setVectorSum\n(\n volVectorField& field,\n double**& value,\n double**& weight,\n double**const& mask\n) const\n{\n label cellI;\n vector valueVec;\n scalar weightP;\n\n for(int index=0; index< particleCloud_.numberOfParticles(); index++)\n {\n for(int subCell=0;subCell= 0)\n {\n for(int i=0;i<3;i++) valueVec[i] = value[index][i];\n weightP = weight[index][subCell];\n field[cellI] += valueVec*weightP;\n }\n }//forAllSubPoints\n }\n\n // correct cell values to patches\n field.correctBoundaryConditions();\n}\n\nvoid averagingModel::setVectorSumSimple\n(\n volVectorField& field,\n double**& value,\n double**& weight,\n int nP\n) const\n{\n label cellI;\n label subCell=0;\n vector valueVec;\n scalar weightP;\n\n for(int index=0; index< nP; index++)\n {\n cellI = particleCloud_.cfdemCloud::cellIDs()[index][subCell];\n\n if (cellI >= 0)\n {\n for(int i=0;i<3;i++) valueVec[i] = value[index][i];\n weightP = weight[index][subCell];\n field[cellI] += valueVec*weightP;\n }\n }\n\n // correct cell values to patches\n field.correctBoundaryConditions();\n}\n\nvoid averagingModel::setScalarSum\n(\n volScalarField& field,\n double**& value,\n double**const& weight,\n double**const& mask\n) const\n{\n label cellI;\n scalar valueScal;\n scalar weightP;\n\n for(int index=0; index< particleCloud_.numberOfParticles(); index++)\n {\n //if(mask[index][0])\n //{\n for(int subCell=0;subCell= 0)\n {\n valueScal = value[index][0];\n weightP = weight[index][subCell];\n field[cellI] += valueScal*weightP;\n }\n }//forAllSubPoints\n //}\n }\n\n // correct cell values to patches\n field.correctBoundaryConditions();\n}\n\nvoid averagingModel::setDSauter\n(\n volScalarField& dSauter,\n double**& weight,\n volScalarField& weightField,\n label myParticleType\n) const\n{\n label cellI;\n scalar weightP;\n scalar radius(-1);\n scalar radiusPow2(-1);\n scalar radiusPow3(-1);\n\n scalar scale_ = particleCloud_.cg(); //scaling of parcel vs. primary particle diameter\n dSauter = 0.0 * dSauter; //set to zero, because we will use it to calc sum(wi*ri^3)\n volScalarField riPower2\n (\n IOobject\n (\n \"dummy2\",\n particleCloud_.mesh().time().timeName(),\n particleCloud_.mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n particleCloud_.mesh(),\n dimensionedScalar(\"zero\", dimensionSet(0, 0, 0, 0, 0),0)\n );\n\n for(int index=0; index< particleCloud_.numberOfParticles(); index++)\n {\n if(myParticleType!=0) //in case a particle type is specified, only consider particles of the right type\n if(myParticleType != particleCloud_.particleType(index)) continue; \n\n radius = particleCloud_.radii()[index][0] / scale_; //the primary particle diameter\n radiusPow2 = radius*radius;\n radiusPow3 = radiusPow2*radius;\n weightP = weight[index][0];\n\n for(int subCell=0;subCell= 0)\n {\n // first entry in this cell\n if(weightField[cellI] == 0)\n {\n dSauter[cellI] = radiusPow3; //use dSauter to store sum(ri^3)\n riPower2[cellI] = radiusPow2;\n weightField[cellI] = weightP;\n }\n else\n {\n dSauter[cellI] = (dSauter[cellI]*weightField[cellI]+radiusPow3*weightP)\n /(weightField[cellI]+weightP);\n riPower2[cellI] = (riPower2[cellI]*weightField[cellI]+radiusPow2*weightP)\n /(weightField[cellI]+weightP);\n weightField[cellI] += weightP;\n }\n }\n }\n }\n\n // set value and correct cell values to patches\n dSauter=2.0*dSauter / (riPower2+1e-99);\n dSauter.correctBoundaryConditions();\n\n return;\n}\n\nvoid averagingModel::resetVectorAverage(volVectorField& prev,volVectorField& next,bool single) const\n{\n if(!single) prev == next;\n next == dimensionedVector(\"zero\", next.dimensions(), vector::zero);\n}\n\nvoid averagingModel::resetWeightFields() const\n{\n UsWeightField_ == dimensionedScalar(\"zero\", UsWeightField_.dimensions(), 0.0);\n}\n\n\nvoid Foam::averagingModel::undoWeightFields(double**const& mask) const\n{\n for(int index=0; index< particleCloud_.numberOfParticles(); index++)\n {\n //if(mask[index][0])\n //{\n // undo voidfraction cause by particle\n label cellI = particleCloud_.cfdemCloud::cellIDs()[index][0];\n UsWeightField_[cellI] -= particleCloud_.particleWeights()[index][0];\n //}\n }\n}\n\ntmp Foam::averagingModel::UsInterp() const\n{\n scalar tsf = particleCloud_.dataExchangeM().timeStepFraction();\n /*if(1-tsf < 1e-4 && particleCloud_.dataExchangeM().couplingStep() > 1) // if no subTS && !firstTS\n {\n //Info << \"using UsNext\" << endl;\n // NOTE: voidfraction uses Prev (does not work due to Ksl?)\n return tmp\n (\n new volVectorField(\"Us_averagingModel\", UsNext_)\n );\n }\n else */ // if subTS || firstTS\n {\n //Info << \"using Us blend, tsf=\" << tsf << endl;\n return tmp\n (\n new volVectorField(\"Us_averagingModel\", (1 - tsf) * UsPrev_ + tsf * UsNext_)\n );\n }\n}\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\naveragingModel::averagingModel\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n dict_(dict),\n particleCloud_(sm),\n UsWeightField_\n (\n IOobject\n (\n \"UsWeightField_\",\n particleCloud_.mesh().time().timeName(),\n particleCloud_.mesh(),\n IOobject::NO_READ,\n IOobject::AUTO_WRITE\n ),\n particleCloud_.mesh(),\n dimensionedScalar(\"zero\", dimensionSet(0,0,0,0,0), 0.0)\n ),\n UsPrev_\n ( IOobject\n (\n \"UsPrev\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::READ_IF_PRESENT,//MUST_READ,\n IOobject::AUTO_WRITE\n ),\n sm.mesh().lookupObject (\"Us\")\n /*sm.mesh(),\n dimensionedVector(\"zero\", dimensionSet(0,1,-1,0,0),vector::zero)*/\n ),\n UsNext_\n ( IOobject\n (\n \"UsNext\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::READ_IF_PRESENT,//MUST_READ,\n IOobject::AUTO_WRITE\n ),\n sm.mesh().lookupObject (\"Us\")\n /*sm.mesh(),\n dimensionedVector(\"zero\", dimensionSet(0,1,-1,0,0),vector::zero)*/\n )\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\naveragingModel::~averagingModel()\n{}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nvoid Foam::averagingModel::applyDebugSettings(bool debug) const\n{\n if(!debug)\n {\n UsWeightField_.writeOpt() = IOobject::NO_WRITE;\n UsPrev_.writeOpt() = IOobject::NO_WRITE;\n UsNext_.writeOpt() = IOobject::NO_WRITE;\n }\n}\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/averagingModel/averagingModel/averagingModel.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n averagingModel\n\nSourceFiles\n averagingModel.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef averagingModel_H\n#define averagingModel_H\n\n#include \"fvCFD.H\"\n#include \"cfdemCloud.H\"\n#include \"dataExchangeModel.H\"\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class averagingModel Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass averagingModel\n{\n\nprotected:\n\n // Protected data\n const dictionary& dict_;\n\n cfdemCloud& particleCloud_;\n\n mutable volScalarField UsWeightField_;\n\n mutable volVectorField UsPrev_;\n\n mutable volVectorField UsNext_;\n\n // Protected member functions\n\npublic:\n\n //- Runtime type information\n TypeName(\"averagingModel\");\n\n // Declare runtime constructor selection table\n\n declareRunTimeSelectionTable\n (\n autoPtr,\n averagingModel,\n dictionary,\n (\n const dictionary& dict,\n cfdemCloud& sm\n ),\n (dict,sm)\n );\n\n\n // Constructors\n\n //- Construct from components\n averagingModel\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n\n // Destructor\n\n virtual ~averagingModel();\n\n\n // Selector\n\n static autoPtr New\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n\n // Member Function\n void applyDebugSettings(bool) const;\n\n virtual void setScalarAverage\n (\n volScalarField& field,\n double**& value,\n double**& weight,\n volScalarField& weightField,\n double**const& mask,\n double**const& weight2, //allows the specification of a 2nd weight field\n bool weightWithWeight2=false //switch to activate 2nd weight field\n ) const = 0;\n\n virtual void setVectorAverage\n (\n volVectorField& field,\n double**& value,\n double**& weight,\n volScalarField& weightField,\n double**const& mask,\n double**const& weight2, //allows the specification of a 2nd weight field\n bool weightWithWeight2=false //switch to activate 2nd weight field\n ) const = 0;\n\n void undoVectorAverage\n (\n volVectorField& fieldPrev,\n volVectorField& fieldNext,\n volScalarField& weightField,\n double** const& value,\n double** const& weight,\n double**const& mask,\n bool single=false\n ) const;\n\n void undoVectorSum\n (\n volVectorField& field,\n double** const& value,\n double** const& weight,\n double**const& mask\n ) const;\n\n\n void setVectorSum\n (\n volVectorField& field,\n double**& value,\n double**& weight,\n double**const& mask\n ) const;\n\n void setVectorSumSimple\n (\n volVectorField& field,\n double**& value,\n double**& weight,\n int np\n ) const;\n\n void setScalarSum\n (\n volScalarField& field,\n double**& value,\n double**const& weight,\n double**const& mask\n ) const;\n\n void setDSauter\n (\n volScalarField& dSauter,\n double**& weight,\n volScalarField& weightField,\n label myParticleType = 0 // can be evaluated for a special type\n ) const;\n\n void resetVectorAverage(volVectorField& prev,volVectorField& next,bool single=false) const;\n\n void resetWeightFields() const;\n\n void undoWeightFields(double**const&) const;\n\n tmp UsInterp() const;\n\n virtual void setParticleType(label type) const {};\n\n virtual bool checkParticleType(label) const {return true;}; //consider all particles by default\n\n // Access\n inline volVectorField& UsPrev() const {return UsPrev_;};\n\n inline volVectorField& UsNext() const {return UsNext_;};\n\n inline volScalarField& UsWeightField() const {return UsWeightField_;};\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/averagingModel/averagingModel/newAveragingModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"averagingModel.H\"\n#include \"dilute.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\nautoPtr averagingModel::New\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n{\n word averagingModelType\n (\n dict.lookup(\"averagingModel\")\n );\n\n Info<< \"Selecting averagingModel \"\n << averagingModelType << endl;\n\n\n dictionaryConstructorTable::iterator cstrIter =\n dictionaryConstructorTablePtr_->find(averagingModelType);\n\n if (cstrIter == dictionaryConstructorTablePtr_->end())\n {\n FatalError\n << \"averagingModel::New(const dictionary&, const spray&) : \"\n << endl\n << \" unknown averagingModelType type \"\n << averagingModelType\n << \", constructor not in hash table\" << endl << endl\n << \" Valid averagingModel types are :\"\n << endl;\n Info<< dictionaryConstructorTablePtr_->toc()\n << abort(FatalError);\n }\n\n return autoPtr(cstrIter()(dict,sm));\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/averagingModel/dense/dense.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"dense.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \"voidFractionModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(dense, 0);\n\naddToRunTimeSelectionTable\n(\n averagingModel,\n dense,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\ndense::dense\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n averagingModel(dict,sm)\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\ndense::~dense()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nvoid dense::setScalarAverage\n(\n volScalarField& field,\n double**& value,\n double**& weight,\n volScalarField& weightField,\n double**const& mask,\n double**const& weight2, //allows the specification of a 2nd weight field\n bool weightWithWeight2 //switch to activate 2nd weight field\n) const\n{\n label cellI;\n scalar valueScal;\n scalar weightP;\n\n #if defined(moreAccuracy)\n List sum(field.size());\n for(int i=0;i= 0)\n {\n valueScal = value[index][0];\n weightP = weight[index][0];\n\n #if defined(moreAccuracy)\n // build sum\n sum[cellI] += valueScal*weightP;\n weightField[cellI] += weightP;\n #else\n // first entry in this cell\n if(weightField[cellI] == 0)\n {\n field[cellI] = valueScal;\n weightField[cellI] = weightP;\n }\n else\n {\n field[cellI] = (field[cellI]*weightField[cellI]+valueScal*weightP)/(weightField[cellI]+weightP);\n weightField[cellI] += weightP;\n }\n #endif\n }\n }\n }\n\n // build average\n #if defined(moreAccuracy)\n forAll(field,cellI) if(weightField[cellI] > SMALL) field[cellI] = sum[cellI]/weightField[cellI];\n #endif\n\n // correct cell values to patches\n field.correctBoundaryConditions();\n}\n\nvoid dense::setVectorAverage\n(\n volVectorField& field,\n double**& value,\n double**& weight,\n volScalarField& weightField,\n double**const& mask,\n double**const& weight2, //allows the specification of a 2nd weight field\n bool weightWithWeight2 //switch to activate 2nd weight field\n) const\n{\n label cellI;\n vector valueVec;\n scalar weightP;\n\n #if defined(moreAccuracy)\n List sumX(field.size());\n List sumY(field.size());\n List sumZ(field.size());\n for(int i=0;i= 0)\n {\n Pout << \"---subCell=\" << subCell << endl;\n Pout << \"---weight=\" << weight[index][subCell] << endl;\n if(weightWithWeight2) \n Pout << \"---weight2=\" << weight2[index][subCell] << endl;\n }\n else\n Pout << \"---subCell not found\" << endl;\n }\n }*/\n //====================\n if(weightWithWeight2) //use weight2, e.g., mass-averaged\n for(int index=0; index< particleCloud_.numberOfParticles(); index++)\n {\n if(!checkParticleType(index)) continue; //skip this particle if not correct type\n\n for(int subCell=0;subCell= 0)\n {\n for(int i=0;i<3;i++) valueVec[i] = value[index][i];\n weightP = weight[index][subCell]*weight2[index][subCell];\n\n #if defined(moreAccuracy)\n // build sum\n sumX[cellI] += valueVec[0]*weightP;\n sumY[cellI] += valueVec[1]*weightP;\n sumZ[cellI] += valueVec[2]*weightP;\n weightField[cellI] += weightP;\n #else\n // first entry in this cell\n if(weightField[cellI] == 0)\n {\n field[cellI] = valueVec;\n weightField[cellI] = weightP;\n }\n else\n {\n field[cellI] = (field[cellI]*weightField[cellI]+valueVec*weightP)/(weightField[cellI]+weightP); //Running average calc. style\n weightField[cellI] += weightP;\n }\n #endif\n }\n }//forAllSubPoints\n }\n else //standard, i.e., volume-averaged\n for(int index=0; index< particleCloud_.numberOfParticles(); index++)\n {\n if(!checkParticleType(index)) continue; //skip this particle if not correct type\n\n for(int subCell=0;subCell= 0)\n {\n for(int i=0;i<3;i++) valueVec[i] = value[index][i];\n weightP = weight[index][subCell];\n\n #if defined(moreAccuracy)\n // build sum\n sumX[cellI] += valueVec[0]*weightP;\n sumY[cellI] += valueVec[1]*weightP;\n sumZ[cellI] += valueVec[2]*weightP;\n weightField[cellI] += weightP;\n #else\n // first entry in this cell\n if(weightField[cellI] == 0)\n {\n field[cellI] = valueVec;\n weightField[cellI] = weightP;\n }\n else\n {\n field[cellI] = (field[cellI]*weightField[cellI]+valueVec*weightP)/(weightField[cellI]+weightP); //Running average calc. style\n weightField[cellI] += weightP;\n }\n #endif\n }\n }//forAllSubPoints\n }\n\n #if defined(moreAccuracy)\n // build average\n forAll(field,cellI)\n {\n if(weightField[cellI] > SMALL)\n {\n scalar w=weightField[cellI];\n field[cellI][0] = sumX[cellI]/w;\n field[cellI][1] = sumY[cellI]/w;\n field[cellI][2] = sumZ[cellI]/w;\n }\n }\n #endif\n // correct cell values to patches\n field.correctBoundaryConditions();\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/averagingModel/dense/dense.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n averaging model for dense regime\n\nClass\n dense\n\nSourceFiles\n dense.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef dense_H\n#define dense_H\n\n//#define moreAccuracy\n\n#include \"averagingModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass dense\n:\n public averagingModel\n{\n\npublic:\n\n //- Runtime type information\n TypeName(\"dense\");\n\n\n // Constructors\n\n //- Construct from components\n dense\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~dense();\n\n\n // Member Functions\n void setScalarAverage\n (\n volScalarField& field,\n double**& value,\n double**& weight,\n volScalarField& weightField,\n double**const& mask,\n double**const& weight2, //allows the specification of a 2nd weight field\n bool weightWithWeight2=false //switch to activate 2nd weight field\n ) const;\n\n void setVectorAverage\n (\n volVectorField& field,\n double**& value,\n double**& weight,\n volScalarField& weightField,\n double**const& mask,\n double**const& weight2, //allows the specification of a 2nd weight field\n bool weightWithWeight2=false //switch to activate 2nd weight field\n ) const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/averagingModel/dilute/dilute.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"dilute.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \"voidFractionModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(dilute, 0);\n\naddToRunTimeSelectionTable\n(\n averagingModel,\n dilute,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\ndilute::dilute\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n averagingModel(dict,sm)\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\ndilute::~dilute()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nvoid dilute::setScalarAverage\n(\n volScalarField& field,\n double**& value,\n double**& weight,\n volScalarField& weightField,\n double**const& mask,\n double**const& weight2, //allows the specification of a 2nd weight field\n bool weightWithWeight2 //switch to activate 2nd weight field\n) const\n{\n label cellI;\n scalar valueScal;\n scalar weightP;\n\n if(weightWithWeight2) \n FatalError << \"dilute::setScalarAverage: attempt to weight with weight2, which is not implemented\" << abort(FatalError);\n\n for(int index=0; index< particleCloud_.numberOfParticles(); index++)\n {\n for(int subCell=0;subCell= 0)\n {\n valueScal = value[index][0];\n weightP = weight[index][0];\n weightField[cellI] += weightP;\n\n field[cellI] = valueScal/weightP;\n }\n }\n }\n\n // correct cell values to patches\n field.correctBoundaryConditions();\n}\n\nvoid dilute::setVectorAverage\n(\n volVectorField& field,\n double**& value,\n double**& weight,\n volScalarField& weightField,\n double**const& mask,\n double**const& weight2, //allows the specification of a 2nd weight field\n bool weightWithWeight2 //switch to activate 2nd weight field\n) const\n{\n label cellI;\n vector valueVec;\n scalar weightP;\n\n if(weightWithWeight2) //use weight2, e.g., mass-averaged - has no effect, just weight is DIFFERENT!\n {\n for(int index=0; index< particleCloud_.numberOfParticles(); index++)\n {\n for(int subCell=0;subCell= 0)\n {\n for(int i=0;i<3;i++) valueVec[i] = value[index][i];\n weightP = weight[index][subCell]*weight2[index][subCell];\n weightField[cellI] += weightP;\n if(weightP > 0) field[cellI] = valueVec; //field[cellI] = valueVec/weightP;\n }\n }\n }\n }\n else //standard, i.e., volume-averaged - has no effect, just weight is DIFFERENT!\n {\n for(int index=0; index< particleCloud_.numberOfParticles(); index++)\n {\n for(int subCell=0;subCell= 0)\n {\n for(int i=0;i<3;i++) valueVec[i] = value[index][i];\n weightP = weight[index][subCell];\n weightField[cellI] += weightP;\n if(weightP > 0) field[cellI] = valueVec; //field[cellI] = valueVec/weightP;\n //else Warning << \"!!! W A R N I N G --- weightP <= 0\" << endl;\n }\n }\n }\n }\n\n // correct cell values to patches\n field.correctBoundaryConditions();\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/averagingModel/dilute/dilute.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n averaging model for dilute regime - assumes only one particle per cell\n\nClass\n dilute\n\nSourceFiles\n dilute.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef dilute_H\n#define dilute_H\n\n#include \"averagingModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass dilute\n:\n public averagingModel\n{\nprivate:\n\n\npublic:\n\n //- Runtime type information\n TypeName(\"dilute\");\n\n\n // Constructors\n\n //- Construct from components\n dilute\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~dilute();\n\n\n // Member Functions\n void setScalarAverage\n (\n volScalarField& field,\n double**& value,\n double**& weight,\n volScalarField& weightField,\n double**const& mask,\n double**const& weight2, //allows the specification of a 2nd weight field\n bool weightWithWeight2=false //switch to activate 2nd weight field\n ) const;\n\n void setVectorAverage\n (\n volVectorField& field,\n double**& value,\n double**& weight,\n volScalarField& weightField,\n double**const& mask,\n double**const& weight2, //allows the specification of a 2nd weight field\n bool weightWithWeight2=false //switch to activate 2nd weight field\n ) const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/clockModel/clockModel/clockModel.C", "content": "/*---------------------------------------------------------------------------*\\\r\n CFDEMcoupling - Open Source CFD-DEM coupling\r\n\r\n CFDEMcoupling is part of the CFDEMproject\r\n www.cfdem.com\r\n Christoph Goniva, christoph.goniva@cfdem.com\r\n Copyright 2009-2012 JKU Linz\r\n Copyright 2012- DCS Computing GmbH, Linz\r\n-------------------------------------------------------------------------------\r\nLicense\r\n This file is part of CFDEMcoupling.\r\n\r\n CFDEMcoupling is free software; you can redistribute it and/or modify it\r\n under the terms of the GNU General Public License as published by the\r\n Free Software Foundation; either version 3 of the License, or (at your\r\n option) any later version.\r\n\r\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\r\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\r\n for more details.\r\n\r\n You should have received a copy of the GNU General Public License\r\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\r\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\r\n\r\nDescription\r\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\r\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\r\n\\*---------------------------------------------------------------------------*/\r\n\r\n#include \"error.H\"\r\n#include \r\n#include \"clockModel.H\"\r\n#include \r\n\r\n\r\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\r\n\r\nnamespace Foam\r\n{\r\n\r\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\r\n\r\ndefineTypeNameAndDebug(clockModel, 0);\r\n\r\ndefineRunTimeSelectionTable(clockModel, dictionary);\r\n\r\n// * * * * * * * * * * * * * public Member Functions * * * * * * * * * * * * //\r\n\r\nvoid Foam::clockModel::start(int pos) const\r\n{\r\n start(pos,\"\");\r\n return;\r\n}\r\n\r\nvoid Foam::clockModel::start(int pos,const std::string& ident) const\r\n{\r\n if(particleCloud_.mesh().time().value() > startTime_)\r\n {\r\n if (pos >= n_) // alternatively one fixed size?\r\n {\r\n n_ = 2*n_;\r\n deltaT_.resize(n_,0);\r\n identifier_.resize(n_,\"\");\r\n nOfRuns_.resize(n_,0);\r\n level_.resize(n_,-1);\r\n parent_.resize(n_,-2);\r\n }\r\n identifier_[pos]=ident;\r\n level_[pos] = curLev_;\r\n curLev_ += 1;\r\n parent_[pos]=curParent_;\r\n curParent_ = pos;\r\n nOfRuns_[pos] += 1;\r\n deltaT_[pos]-=std::clock();\r\n }\r\n return;\r\n}\r\n\r\nvoid Foam::clockModel::stop() const\r\n{\r\n if(particleCloud_.mesh().time().value() > startTime_)\r\n {\r\n deltaT_[curParent_]+=std::clock();\r\n curLev_ -= 1;\r\n if (curParent_ >= 0)\r\n {\r\n curParent_ = parent_[curParent_];\r\n }\r\n else\r\n {\r\n curParent_ = -1;\r\n }\r\n }\r\n return;\r\n}\r\n\r\nvoid Foam::clockModel::stop(const std::string& ident) const\r\n{\r\n if(particleCloud_.mesh().time().value() > startTime_)\r\n {\r\n deltaT_[curParent_] += std::clock();\r\n if (curParent_ > 0 && identifier_[curParent_].compare(ident)!=0)\r\n {\r\n Pout<<\"Warning: stop identifier did not equal start identifier! \"<= 0)\r\n {\r\n curParent_ = parent_[curParent_];\r\n }\r\n else\r\n {\r\n curParent_ = -1;\r\n }\r\n }\r\n return;\r\n}\r\n\r\nstd::string Foam::clockModel::eval() const\r\n{\r\n std::ostringstream strs(\"Measurements in CPU-seconds:\\n\");\r\n strs << \"Name\\tdeltaT\\tnOfRuns\\tlevel\\tparentNr\\tparentName\\n\";\r\n strs.setf(std::ios_base::scientific);\r\n std::vector shifts = calcShift();\r\n\r\n for (int i=0; i(deltaT_[i])/(CLOCKS_PER_SEC) << \"\\t\";\r\n strs << nOfRuns_[i] << \"\\t\";\r\n strs << level_[i] << \"\\t\";\r\n\r\n if (parent_[i] >= 0)\r\n {\r\n strs << (shifts[parent_[i]]) << \"\\t\";\r\n strs << identifier_[parent_[i]] << \"\\n\";\r\n }\r\n else\r\n {\r\n strs << parent_[i] << \"\\t\";\r\n strs << \"none\\n\";\r\n }\r\n }\r\n }\r\n return strs.str();\r\n}\r\n\r\nvoid Foam::clockModel::evalFile() const\r\n{\r\n std::ofstream outFile;\r\n std::string fileName(path_/\"timeEval.txt\");\r\n outFile.open(fileName.c_str(), ios_base::trunc);\r\n outFile << \"Time Evaluation\" << nl;\r\n outFile << eval();\r\n outFile.close();\r\n}\r\n\r\nvoid Foam::clockModel::evalPar() const\r\n{\r\n int myrank, numprocs;\r\n MPI_Comm_rank(MPI_COMM_WORLD,&myrank);\r\n MPI_Comm_size(MPI_COMM_WORLD, &numprocs);\r\n\r\n std::ofstream outFile;\r\n std::ostringstream strs;\r\n strs.setf(std::ios_base::scientific);\r\n\r\n std::string fileName(path_/\"timeEval_\");\r\n strs << myrank << \".txt\";\r\n fileName.append(strs.str());\r\n\r\n outFile.open(fileName.c_str(), ios_base::trunc);\r\n outFile << \"Time Evaluation for Processor Nr.\" << myrank << nl;\r\n outFile << eval();\r\n outFile.close();\r\n\r\n // MPI_REDUCE SUM NODES\r\n MPI_Barrier(MPI_COMM_WORLD);\r\n strs.str(\"Parallel Measurements in CPU-seconds of all Processors (starting after first t.s.):\\n\");\r\n strs << \"Name\\tavgdeltaT\\tmaxdeltaT\\tnOfRuns\\tlevel\\tparentNr\\tparentName\\n\";\r\n double buffOut = 0.;\r\n double buffIn = 0.;\r\n std::vector shifts = calcShift();\r\n\r\n for (int i=0; i(deltaT_[i])/(CLOCKS_PER_SEC);\r\n\r\n MPI_Reduce(&buffIn, &buffOut, 1, MPI_DOUBLE, MPI_SUM, 0, MPI_COMM_WORLD);\r\n MPI_Barrier(MPI_COMM_WORLD);\r\n\r\n strs << buffOut/numprocs << \"\\t\";\r\n\r\n MPI_Reduce(&buffIn, &buffOut, 1, MPI_DOUBLE, MPI_MAX, 0, MPI_COMM_WORLD);\r\n MPI_Barrier(MPI_COMM_WORLD);\r\n\r\n strs << buffOut << \"\\t\";\r\n strs << nOfRuns_[i] << \"\\t\";\r\n strs << level_[i] << \"\\t\";\r\n\r\n if (parent_[i] >= 0)\r\n {\r\n strs << (shifts[parent_[i]]) << \"\\t\";\r\n strs << identifier_[parent_[i]] << \"\\n\";\r\n }\r\n else\r\n {\r\n strs << parent_[i] << \"\\t\";\r\n strs << \"none\\n\";\r\n }\r\n }\r\n }\r\n MPI_Barrier(MPI_COMM_WORLD);\r\n\r\n if (myrank == 0)\r\n {\r\n std::string fileName(path_/\"timeEvalFull.txt\");\r\n outFile.open(fileName.c_str(),ios_base::trunc);\r\n outFile << strs.str();\r\n outFile.close();\r\n }\r\n}\r\n\r\n\r\nvoid Foam::clockModel::initElems()\r\n{\r\n //init elems\r\n for (int i = 0;i < n_; i++)\r\n {\r\n deltaT_[i] = 0;\r\n identifier_[i] = \"\";\r\n nOfRuns_[i] = 0;\r\n level_[i] = -1;\r\n parent_[i] = -2;\r\n }\r\n}\r\n\r\nstd::vector Foam::clockModel::calcShift() const\r\n{\r\n std::vector shifts = std::vector (n_);\r\n shifts[0]=0;\r\n for (int i=1;iSMALL) buffIn = buffIn*double(numprocs)/buffOut;\r\n plotHist(buffIn,identifier_[1],numprocs,myrank);\r\n\r\n //LIGGGHTS = 3\r\n buffIn = double(deltaT_[3]);\r\n MPI_Allreduce(&buffIn, &buffOut, 1, MPI_DOUBLE, MPI_SUM, MPI_COMM_WORLD);\r\n if(buffOut>SMALL) buffIn = buffIn*double(numprocs)/buffOut;\r\n plotHist(buffIn,identifier_[3],numprocs,myrank);\r\n\r\n //Coupling - LIGGGHTS = 2 - 3\r\n buffIn = double(deltaT_[2]) - buffIn;\r\n MPI_Allreduce(&buffIn, &buffOut, 1, MPI_DOUBLE, MPI_SUM, MPI_COMM_WORLD);\r\n if(buffOut>SMALL) buffIn = buffIn*double(numprocs)/buffOut;\r\n plotHist(buffIn,\"Coupling (routines)\",numprocs,myrank);\r\n\r\n //Flow = 26\r\n buffIn = double(deltaT_[26]);\r\n MPI_Allreduce(&buffIn, &buffOut, 1, MPI_DOUBLE, MPI_SUM, MPI_COMM_WORLD);\r\n if(buffOut>SMALL) buffIn = buffIn*double(numprocs)/buffOut;\r\n plotHist(buffIn,identifier_[26],numprocs,myrank);\r\n Info << \"===========================\" << endl;\r\n\r\n getRAMUsage();\r\n return;\r\n}\r\n\r\nvoid Foam::clockModel::plotHist(double buffIn,const std::string& identifier,int numprocs,int myrank) const\r\n{\r\n double* globalTime_all = NULL;\r\n if (myrank == 0) globalTime_all = new double[numprocs];\r\n MPI_Gather(&buffIn, 1, MPI_DOUBLE, globalTime_all, 1, MPI_DOUBLE, 0, MPI_COMM_WORLD);\r\n\r\n if (myrank == 0)\r\n for (int j=0; j> line >> temp;\r\n RssMem = RssMem + temp;\r\n //Pout << temp << \" \";\r\n }\r\n else if (line.substr(0,5).compare(\"Swap:\") == 0)\r\n {\r\n strs << line;\r\n strs >> line >> temp;\r\n SwapMem = SwapMem + temp;\r\n //Pout << strs.str() << \" \";\r\n }\r\n }\r\n }\r\n double SwapMB = double(SwapMem)/1024.0; //kB -> MB\r\n double RssMB = double(RssMem)/1024.0;\r\n\r\n inFile.close();\r\n\r\n // set up communication between Procs and plot Stuff\r\n Info << \" RAM USAGE HISTOGRAM in MB\" << endl;\r\n plotHist(RssMB,\"RSS memory used\",numprocs,myrank);\r\n if (SwapMem > 0)\r\n {\r\n plotHist(SwapMB,\"WARNING: Swap\",numprocs,myrank);\r\n }\r\n Info << \"===========================\" << endl;\r\n\r\n //Pout << \"SWAP Memory used: \" << SwapMem <<\"MB\\n\";\r\n //Pout << \"Rss Memory used: \" << RssMem <<\"MB\\n\";\r\n\r\n\r\n return;\r\n}\r\n// * * * * * * * * * * * * * private Member Functions * * * * * * * * * * * * //\r\n\r\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\r\n\r\n// Construct from components\r\nFoam::clockModel::clockModel\r\n(\r\n const dictionary& dict,\r\n cfdemCloud& sm\r\n)\r\n:\r\n dict_(dict),\r\n particleCloud_(sm),\r\n path_(\"clockData\"),\r\n startTime_(sm.mesh().time().startTime().value()+2.*sm.dataExchangeM().couplingTime()), // delay start of measurement by 2*tCouple\r\n //startTime_(0), //no delay\r\n n_(30),\r\n deltaT_(n_),\r\n identifier_(n_),\r\n nOfRuns_(n_),\r\n level_(n_),\r\n curLev_(0),\r\n parent_(n_),\r\n curParent_(0)\r\n{\r\n\r\n Info << \"start clock measurement at t >\" << startTime_ << endl;\r\n}\r\n\r\n\r\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\r\n\r\nFoam::clockModel::~clockModel()\r\n{}\r\n\r\n\r\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\r\n\r\n} // End namespace Foam\r\n\r\n// ************************************************************************* //\r\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/clockModel/clockModel/clockModel.H", "content": "/*---------------------------------------------------------------------------*\\\r\n CFDEMcoupling - Open Source CFD-DEM coupling\r\n\r\n CFDEMcoupling is part of the CFDEMproject\r\n www.cfdem.com\r\n Christoph Goniva, christoph.goniva@cfdem.com\r\n Copyright 2009-2012 JKU Linz\r\n Copyright 2012- DCS Computing GmbH, Linz\r\n-------------------------------------------------------------------------------\r\nLicense\r\n This file is part of CFDEMcoupling.\r\n\r\n CFDEMcoupling is free software; you can redistribute it and/or modify it\r\n under the terms of the GNU General Public License as published by the\r\n Free Software Foundation; either version 3 of the License, or (at your\r\n option) any later version.\r\n\r\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\r\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\r\n for more details.\r\n\r\n You should have received a copy of the GNU General Public License\r\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\r\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\r\n\r\nDescription\r\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\r\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\r\n\r\nClass\r\n clockModel\r\n\r\nSourceFiles\r\n clockModel.C\r\n\r\n\\*---------------------------------------------------------------------------*/\r\n\r\n#ifndef clockModel_H\r\n#define clockModel_H\r\n\r\n#define START(x) start(__COUNTER__,x)\r\n\r\n#include \"fvCFD.H\"\r\n#include \"cfdemCloud.H\"\r\n#include \"dataExchangeModel.H\"\r\n\r\n#include \r\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\r\n\r\nnamespace Foam\r\n{\r\n\r\n/*---------------------------------------------------------------------------*\\\r\n Class clockModel Declaration\r\n\\*---------------------------------------------------------------------------*/\r\n\r\nclass clockModel\r\n{\r\nprotected:\r\n\r\n // Protected data\r\n const dictionary& dict_;\r\n cfdemCloud& particleCloud_;\r\n fileName path_;\r\n scalar startTime_;\r\n\r\n mutable int n_;\r\n mutable std::vector deltaT_;\r\n mutable std::vector identifier_;\r\n mutable std::vector nOfRuns_;\r\n mutable std::vector level_;\r\n mutable short curLev_;\r\n mutable std::vector parent_;\r\n mutable int curParent_;\r\n\r\npublic:\r\n\r\n //- Runtime type information\r\n TypeName(\"clockModel\");\r\n\r\n // Declare runtime constructor selection table\r\n\r\n declareRunTimeSelectionTable\r\n (\r\n autoPtr,\r\n clockModel,\r\n dictionary,\r\n (\r\n const dictionary& dict,\r\n cfdemCloud& sm\r\n ),\r\n (dict,sm)\r\n );\r\n\r\n\r\n // Constructors\r\n\r\n //- Construct from components\r\n clockModel\r\n (\r\n const dictionary& dict,\r\n cfdemCloud& sm\r\n );\r\n\r\n\r\n // Destructor\r\n\r\n virtual ~clockModel();\r\n\r\n\r\n // Selector\r\n\r\n static autoPtr New\r\n (\r\n const dictionary& dict,\r\n cfdemCloud& sm\r\n );\r\n\r\n\r\n // Member Functions\r\n\r\n\t virtual void start(int pos) const;\t //start measurement with custom string identifier\r\n\t virtual void start(int pos,const std::string& identifier) const; //start measurement with custom string identifier\r\n\t virtual void stop() const;\t\t\t\t //stop last started measurement\r\n\t virtual void stop(const std::string& identifier) const; //stop last started measurement with check if identifier is equal\r\n\t virtual std::string eval() const;\r\n\t virtual void evalFile() const;\r\n\t virtual void evalPar() const;\r\n\t void initElems();\r\n\t std::vector calcShift() const;\t\t\t //detects empty indices in vector, when times are evaluated\r\n\t void Hist() const;\t\t\t\t\t //calc Histogram\r\n\t virtual void normHist() const;\t\t\t\t //calc normalized Histogram\r\n\tvoid plotHist(double,const std::string&,int,int) const; //plot histogramm to terminal\r\n \tvoid getRAMUsage() const;\r\n\r\n};\r\n\r\n\r\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\r\n\r\n} // End namespace Foam\r\n\r\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\r\n\r\n#endif\r\n\r\n// ************************************************************************* //\r\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/clockModel/clockModel/newClockModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"clockModel.H\"\n#include \"standardSearch.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\nautoPtr clockModel::New\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n{\n word clockModelType\n (\n dict.lookup(\"clockModel\")\n );\n\n Info<< \"Selecting clockModel \"\n << clockModelType << endl;\n\n\n dictionaryConstructorTable::iterator cstrIter =\n dictionaryConstructorTablePtr_->find(clockModelType);\n\n if (cstrIter == dictionaryConstructorTablePtr_->end())\n {\n FatalError\n << \"clockModel::New(const dictionary&, const spray&) : \"\n << endl\n << \" unknown clockModelType type \"\n << clockModelType\n << \", constructor not in hash table\" << endl << endl\n << \" Valid clockModel types are :\"\n << endl;\n Info<< dictionaryConstructorTablePtr_->toc()\n << abort(FatalError);\n }\n\n return autoPtr(cstrIter()(dict,sm));\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/clockModel/noClock/noClock.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"noClock.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(noClock, 0);\n\naddToRunTimeSelectionTable\n(\n clockModel,\n noClock,\n dictionary\n);\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nnoClock::noClock\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n clockModel(dict,sm)\n{\n initElems();\n}\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nnoClock::~noClock()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/clockModel/noClock/noClock.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n noClock\n\nSourceFiles\n noClock.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef noClock_H\n#define noClock_H\n\n#include \"clockModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass noClock\n:\n public clockModel\n{\n\npublic:\n\n //- Runtime type information\n TypeName(\"off\");\n\n\n // Constructors\n\n //- Construct from components\n noClock\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~noClock();\n\n\n // Member Functions\n\n\t void start(int pos) const {};\n\t void start(int pos,const std::string& identifier) const {};\n\t void stop() const {};\n\t void stop(const std::string& identifier) const {};\n\t std::string eval() const {return \"\";};\n\t void evalFile() const {};\n\t void evalPar() const {};\n void normHist() const {};\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/clockModel/standardClock/standardClock.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n#include \"IOModel.H\"\n#include \"standardClock.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(standardClock, 0);\n\naddToRunTimeSelectionTable\n(\n clockModel,\n standardClock,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nstandardClock::standardClock\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n clockModel(dict,sm)\n{\n path_=particleCloud_.IOM().createTimeDir(path_);\n initElems();\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nstandardClock::~standardClock()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/clockModel/standardClock/standardClock.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n standardClock\n\nSourceFiles\n standardClock.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef standardClock_H\n#define standardClock_H\n\n#include \"clockModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass standardClock\n:\n public clockModel\n{\n\npublic:\n\n //- Runtime type information\n TypeName(\"standardClock\");\n\n\n // Constructors\n\n //- Construct from components\n standardClock\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~standardClock();\n\n\n // Member Functions\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/dataExchangeModel/dataExchangeModel/dataExchangeModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"dataExchangeModel.H\"\n#include \"error.H\"\n#include \n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(dataExchangeModel, 0);\n\ndefineRunTimeSelectionTable(dataExchangeModel, dictionary);\n\n// * * * * * * * * * * * * * * protected Member Functions * * * * * * * * * * * * * //\n\n// * * * * * * * * * * * * * * public Member Functions * * * * * * * * * * * * * //\n\nvoid Foam::dataExchangeModel::setNumberOfParticles(int numberOfParticles) const\n{\n particleCloud_.setNumberOfParticles(numberOfParticles);\n}\n\nvoid Foam::dataExchangeModel::setNumberOfClumps(int numberOfClumps) const\n{\n particleCloud_.setNumberOfClumps(numberOfClumps);\n}\n\n//====\n// double ***\n\nvoid Foam::dataExchangeModel::allocateArray\n(\n double***& array,\n double initVal,\n int width,\n int length,\n int depth\n) const\n{\n //Pout << \"depth=\" << depth << \" length=\" << length<< \" width=\" << width << endl;\n // allocate and init double array\n destroy(array, -1);\n\n double *data = new double[width*length*depth];\n double **plane = new double*[length*depth];\n std::fill_n(data, width*length*depth, initVal);\n\n array = new double**[depth];\n\n int n = 0;\n int m = 0;\n for (int i=0; i\n#include \n#include \n#include \n#include \n#include \n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class dataExchangeModel Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass dataExchangeModel\n{\n\nprotected:\n\n // Protected data\n const dictionary& dict_;\n\n cfdemCloud& particleCloud_;\n\n int maxNumberOfParticles_;\n\n mutable int couplingStep_;\n\n scalar DEMts_;\n\n int couplingInterval_;\n\n const int timeIndexOffset_;\n\n // Protected member functions\n\npublic:\n\n //- Runtime type information\n TypeName(\"dataExchangeModel\");\n\n // Declare runtime constructor selection table\n\n declareRunTimeSelectionTable\n (\n autoPtr,\n dataExchangeModel,\n dictionary,\n (\n const dictionary& dict,\n cfdemCloud& sm\n ),\n (dict,sm)\n );\n\n\n // Constructors\n\n //- Construct from components\n dataExchangeModel\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n\n // Destructor\n\n virtual ~dataExchangeModel();\n\n\n // Selector\n\n static autoPtr New\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n\n // Member Function\n void setNumberOfParticles(int) const;\n\n void setNumberOfClumps(int) const;\n\n inline const int& maxNumberOfParticles() const {return maxNumberOfParticles_;};\n\n template \n void getData\n (\n word name,\n word type,\n T ** const& field\n ) const { getData(name,type,field,couplingStep_-1); }\n\n virtual void getData\n (\n word name,\n word type,\n double ** const& field,\n label step\n ) const = 0;\n\n virtual void getData\n (\n word name,\n word type,\n int ** const& field,\n label step\n ) const=0;\n\n virtual void giveData\n (\n word name,\n word type,\n double ** const& field,\n const char* datatype=\"double\"\n ) const = 0;\n\n //====\n // double ***\n virtual void allocateArray(double***&, double, int, int,int) const;\n virtual void destroy(double***,int) const;\n\n //====\n // double **\n virtual void allocateArray(double**&, double, int, int) const;\n virtual void allocateArray(double**&, double, int, const char* =\"nparticles\") const;\n virtual void destroy(double**,int) const;\n\n //====\n // int **\n virtual void allocateArray(int**&, int, int, int) const;\n virtual void allocateArray(int**&, int, int, const char* =\"nparticles\") const;\n virtual void destroy(int**,int) const;\n //====\n\n //====\n // int *\n virtual void allocateArray(int*&, int, int) const;\n virtual void destroy(int*) const;\n //====\n\n //====\n // double *\n virtual void allocateArray(double*&, double, int) const;\n virtual void destroy(double*) const;\n //====\n\n virtual bool couple(int) const;\n\n virtual scalar timeStepFraction() const;\n\n inline int couplingStep() const {return couplingStep_;};\n\n inline const scalar& DEMts() const {return DEMts_;};\n\n inline int couplingInterval() const {return couplingInterval_;};\n\n inline bool subTS() const {\n if(mag(particleCloud_.mesh().time().deltaT().value()-couplingTime())>SMALL) return true;\n else return false;\n };\n\n inline scalar couplingTime() const {return couplingInterval_ * DEMts_;};\n\n inline scalar TSstart() const { return particleCloud_.mesh().time().startTime().value()\n + (couplingStep_-1) * couplingTime();};\n\n inline scalar TSend() const {return particleCloud_.mesh().time().startTime().value()\n + (couplingStep_) * couplingTime();};\n\n inline int DEMstepsTillT(scalar t) const {return (t - (particleCloud_.mesh().time().value() - couplingTime()) + SMALL) / DEMts_;};\n\n inline void checkTSsize() const\n {\n if(particleCloud_.mesh().time().deltaT().value() > couplingTime() + SMALL)\n {\n Info << \"particleCloud_.mesh().time().deltaT().value() = \" << particleCloud_.mesh().time().deltaT().value() << endl;\n Info << \"couplingInterval_ = \" << couplingInterval_ << endl;\n Info << \"DEMts_ = \" << DEMts_ << endl;\n FatalError<<\"\\nError - CFD time-step bigger than coupling time (= DEM time step * coupling interval)!\\n\"<< abort(FatalError);\n }\n if ( std::fabs(( round(couplingTime()/particleCloud_.mesh().time().deltaT().value()) * particleCloud_.mesh().time().deltaT().value() )-couplingTime()) > SMALL )\n {\n Info << \"particleCloud_.mesh().time().deltaT().value() = \" << particleCloud_.mesh().time().deltaT().value() << endl;\n Info << \"couplingInterval_ = \" << couplingInterval_ << endl;\n Info << \"DEMts_ = \" << DEMts_ << endl;\n FatalError <<\"\\nWarning - Coupling time (= DEM time step * coupling interval) is not a multiple of CFD time-step!\\n\"<< abort(FatalError);\n }\n if(!particleCloud_.allowCFDsubTimestep() && subTS()) FatalError<<\"\\nYour models require: CFD time-step = coupling interval (= DEM time step * coupling interval)! \\n\"<< abort(FatalError);\n\n // warn if sub-TS\n if (particleCloud_.mesh().time().deltaT().value() < couplingTime() - SMALL)\n Warning << \"You are using sub-time-steps (i.e. CFD TS < coupling time)! Check your settings properly.\" << endl;\n }\n\n /*inline bool checkExactTiming() const\n {\n return false;\n }*/\n\n //void checkNClumpTypes() const {};\n\n inline void readDEMtsfromDict(dictionary& propsDict)\n {\n DEMts_ = readScalar(propsDict.lookup(\"DEMts\"));\n checkTSsize();\n }\n\n inline bool doCoupleNow() const\n {\n // couple at first sub TS\n if ((particleCloud_.mesh().time().timeIndex()-timeIndexOffset_)*particleCloud_.mesh().time().deltaT().value()-SMALL\n > couplingStep_*DEMts_*couplingInterval_)\n {\n return true;\n }\n else\n {\n return false;\n }\n }\n\n virtual int getNumberOfParticles() const;\n virtual int getNumberOfClumps() const;\n virtual int getNumberOfTypes() const;\n virtual double* getTypeVol() const;\n\n inline void setPositions(label n,double* pos) const\n {\n for (int i=0;iforce->cg(INT_MAX));\n \n Info << \"LIGGGHTS hosts \" << lmp->atom->ntypes << \" atom types.\" << endl;\n\n// if ( lmp->force->typeSpecificCG() )\n// {\n// Warning << \"\\nYou are using untested code (type specific coarse graining)!!!\\n\"\n// << \"\\nThis will most probably give wrong results for most models!!!\\n\"<< endl;\n// for(int iTyp=1; iTyp<=lmp->atom->ntypes; iTyp++)\n// particleCloud_.setCGTypeSpecific(iTyp,lmp->force->cg(iTyp));\n// lmp->force->reportCG();\n// }\n };\n\n //virtual void doDebug() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/dataExchangeModel/dataExchangeModel/newDataExchangeModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"dataExchangeModel.H\"\n#include \"twoWayFiles.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\nautoPtr dataExchangeModel::New\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n{\n word dataExchangeModelType\n (\n dict.lookup(\"dataExchangeModel\")\n );\n\n Info<< \"Selecting dataExchangeModel \"\n << dataExchangeModelType << endl;\n\n\n dictionaryConstructorTable::iterator cstrIter =\n dictionaryConstructorTablePtr_->find(dataExchangeModelType);\n\n if (cstrIter == dictionaryConstructorTablePtr_->end())\n {\n FatalError\n << \"dataExchangeModel::New(const dictionary&, const spray&) : \"\n << endl\n << \" unknown dataExchangeModelType type \"\n << dataExchangeModelType\n << \", constructor not in hash table\" << endl << endl\n << \" Valid dataExchangeModel types are :\"\n << endl;\n Info<< dictionaryConstructorTablePtr_->toc()\n << abort(FatalError);\n }\n\n return autoPtr(cstrIter()(dict,sm));\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/dataExchangeModel/noDataExchange/noDataExchange.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"noDataExchange.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(noDataExchange, 0);\n\naddToRunTimeSelectionTable\n(\n dataExchangeModel,\n noDataExchange,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nnoDataExchange::noDataExchange\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n dataExchangeModel(dict,sm)\n{\n Info << \"DEMts_ not set!\" << endl;\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nnoDataExchange::~noDataExchange()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/dataExchangeModel/noDataExchange/noDataExchange.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n noDataExchange\n\nSourceFiles\n noDataExchange.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef noDataExchange_H\n#define noDataExchange_H\n\n#include \"dataExchangeModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noDataExchange Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass noDataExchange\n:\n public dataExchangeModel\n{\n\npublic:\n\n //- Runtime type information\n TypeName(\"noDataExchange\");\n\n\n // Constructors\n\n //- Construct from components\n noDataExchange\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~noDataExchange();\n\n\n // Member Functions\n void getData\n (\n word name,\n word type,\n double ** const& field,\n label step\n ) const {};\n\n void getData\n (\n word name,\n word type,\n int ** const& field,\n label step\n ) const {};\n\n void giveData\n (\n word name,\n word type,\n double ** const& field,\n const char* datatype = \"\"\n ) const {};\n\n word myType() const{return typeName; };\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/dataExchangeModel/oneWayVTK/oneWayVTK.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"oneWayVTK.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(oneWayVTK, 0);\n\naddToRunTimeSelectionTable\n(\n dataExchangeModel,\n oneWayVTK,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\noneWayVTK::oneWayVTK\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n dataExchangeModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n filename_(propsDict_.lookup(\"couplingFilename\")),\n relativePath_(propsDict_.lookup(\"relativePath\"))\n{\n readDEMtsfromDict(propsDict_);\n\n // set max nr of particles from dict\n maxNumberOfParticles_ = readScalar(propsDict_.lookup(\"maxNumberOfParticles\"));\n setNumberOfParticles(maxNumberOfParticles_);\n\n // make a const char* from word\n //string HH=string(filename_);\n //charFilename_=const_cast(HH.c_str());\n charFilename_ = wordToChar(filename_);\n\n Info << \"relativePath_\" << relativePath_ << endl;\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\noneWayVTK::~oneWayVTK()\n{}\n\n// * * * * * * * * * * * * * * * private Member Functions * * * * * * * * * * * * * //\nchar* oneWayVTK::wordToChar(word& inWord) const\n{\n return const_cast(inWord.c_str());\n}\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\nvoid oneWayVTK::getData\n(\n word name,\n word type,\n double ** const& field,\n int step\n) const\n{\n if (type == \"scalar-atom\")\n {\n // get path to particle VTK files\n char index[100];\n sprintf(index, charFilename_, step);\n //fileName H(particleCloud_.mesh().time().path()/\"..\"/\"DEM\"/\"post\"/index);\n fileName H(particleCloud_.mesh().time().path()/relativePath_/index);\n Info << \"opening file: \" << H << endl;\n\n // set file pointer\n string HH=string(H);\n const char * paricleFilePath=HH.c_str();\n ifstream* inputPtr;\n inputPtr = new ifstream(paricleFilePath);\n if(!*inputPtr) FatalError << \"File not found!, \" << H << \"\\n\" << abort(FatalError);\n\n if (name == \"radius\")\n {\n // read data\n string just_read = \" \";\n while(just_read.compare(name) != 0) *inputPtr >> just_read; //read until we read \"name\"\n *inputPtr >> just_read; // skip text for dataType\n *inputPtr >> just_read; // skip text for \"1\"\n *inputPtr >> just_read; // skip text for \"LookUp\"\n *inputPtr >> just_read; // skip text for \"default\"\n for(int index = 0;index < particleCloud_.numberOfParticles(); ++index)\n {\n *inputPtr >> field[index][0];\n }\n }\n else\n {\n // read data\n string just_read = \" \";\n while(just_read.compare(name) != 0) *inputPtr >> just_read; //read until we read \"name\"\n *inputPtr >> just_read; // skip text for dataType\n for(int index = 0;index < particleCloud_.numberOfParticles(); ++index)\n {\n *inputPtr >> field[index][0];\n }\n }\n\n // clean up inputStream\n delete inputPtr;\n } else if (type == \"vector-atom\")\n {\n // get path to particle VTK files\n char index[100];\n sprintf(index, charFilename_, step);\n Info << \"debug: index is \" << index << endl; //JOKER\n //fileName H(particleCloud_.mesh().time().path()/\"..\"/\"DEM\"/\"post\"/index);\n fileName H(particleCloud_.mesh().time().path()/relativePath_/index);\n Info << \"opening file: \" << H << endl;\n\n // set file pointer\n string HH=string(H);\n const char * paricleFilePath=HH.c_str();\n ifstream* inputPtr;\n inputPtr = new ifstream(paricleFilePath);\n if(!*inputPtr) FatalError << \"File not found!, \" << H << \"\\n\" << abort(FatalError);\n\n // read position data from VTK file\n //NP: secial case as position data has no \"name\" in the vtk file\n if (name == \"x\")\n {\n int numberOfParticles; // remove this?\n\n string just_read = \" \";\n// if(!*inputPtr) FatalIOError << \"File not found!, \" << H << \"\\n\" << abort(FatalError);\n while(just_read.compare(\"POINTS\") != 0) *inputPtr >> just_read; //read until we read \"POINTS\"\n *inputPtr >> numberOfParticles; //this is now the number of points in the file\n *inputPtr >> just_read; // skip text for dataType\n\n // give nr of particles to cloud\n setNumberOfParticles(numberOfParticles);\n\n // re-allocate arrays of cloud\n particleCloud_.reAllocArrays();\n\n for(int index = 0;index < numberOfParticles; ++index)\n {\n *inputPtr >> field[index][0] >> field[index][1] >> field[index][2];\n }\n }\n else\n {\n string just_read = \" \";\n while(just_read.compare(name) != 0) *inputPtr >> just_read; //read until we read \"name\"\n *inputPtr >> just_read; // skip \"3\"\n *inputPtr >> just_read; // skip nr entries\n *inputPtr >> just_read; // skip text for dataType\n for(int index = 0;index < particleCloud_.numberOfParticles(); ++index)\n {\n *inputPtr >> field[index][0] >> field[index][1] >> field[index][2];\n }\n }\n\n // clean up inputStream\n delete inputPtr;\n }\n else\n {\n Info << \"unknown type in getData!!!\" << endl;\n }\n}\n\nvoid oneWayVTK::giveData\n(\n word name,\n word type,\n double ** const& field,\n const char* datatype\n) const\n{\n // do nothing\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/dataExchangeModel/oneWayVTK/oneWayVTK.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n one way DEM->CFD coupling via VTK files\n\nClass\n oneWayVTK\n\nSourceFiles\n oneWayVTK.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef oneWayVTK_H\n#define oneWayVTK_H\n\n#include \"dataExchangeModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class oneWayVTK Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass oneWayVTK\n:\n public dataExchangeModel\n{\nprivate:\n\n dictionary propsDict_;\n\n word filename_;\n\n fileName relativePath_;\n\n const char* charFilename_;\n\n // private member functions\n\n char* wordToChar(word&) const;\n\npublic:\n\n //- Runtime type information\n TypeName(\"oneWayVTK\");\n\n\n // Constructors\n\n //- Construct from components\n oneWayVTK\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~oneWayVTK();\n\n\n // Member Functions\n void getData\n (\n word name,\n word type,\n double ** const& field,\n label step\n ) const;\n\n void getData\n (\n word name,\n word type,\n int ** const& field,\n label step\n ) const\n {};\n\n void giveData\n (\n word name,\n word type,\n double ** const& field,\n const char* datatype = \"\"\n ) const;\n\n word myType() const{return typeName; };\n\n void setCG() const { \n //no coarse graining data available, assume 1\n particleCloud_.setCG(1.); \n };\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayFiles/twoWayFiles.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"twoWayFiles.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \"error.H\"\n\n#include \n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(twoWayFiles, 0);\n\naddToRunTimeSelectionTable\n(\n dataExchangeModel,\n twoWayFiles,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\ntwoWayFiles::twoWayFiles\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n dataExchangeModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\"))\n{\n readDEMtsfromDict(propsDict_);\n\n // set max nr of particles from dict\n maxNumberOfParticles_ = readScalar(propsDict_.lookup(\"maxNumberOfParticles\"));\n\n // give max nr of particles to cloud (corrected later)\n setNumberOfParticles(maxNumberOfParticles_);\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\ntwoWayFiles::~twoWayFiles()\n{}\n\n\n// * * * * * * * * * * * * * * * private Member Functions * * * * * * * * * * * * * //\n\nconst char* twoWayFiles::wordToChar(word& inWord) const\n{\n return const_cast(inWord.c_str());\n}\n\nconst char* twoWayFiles::fileNameToChar(fileName& inWord) const\n{\n return const_cast(inWord.c_str());\n}\n\nfileName twoWayFiles::getFilePath(word& name, bool in) const\n{\n const char* charName = wordToChar(name);\n char timeStep[40];\n\n // file touched by DEM\n strcpy(timeStep, charName);\n strcat(timeStep,\"1\");\n fileName particleFilePathOld(particleCloud_.mesh().time().path()/\"couplingFiles\"/timeStep);\n\n //NP no waiting when writing out at first time\n if (couplingStep() > 1 || in)\n {\n Info << \"wait for file \" << particleFilePathOld << endl;\n struct stat st;\n while (stat(fileNameToChar(particleFilePathOld),&st)) sleep(0.03);\n }\n\n return particleFilePathOld;\n}\n\nvoid twoWayFiles::renameFilePath(fileName& particleFilePathOld,word& name) const\n{\n const char* charName = wordToChar(name);\n char timeStep[40];\n\n // file touched by CFD\n strcpy(timeStep, charName);\n strcat(timeStep,\"0\");\n fileName particleFilePath(particleCloud_.mesh().time().path()/\"couplingFiles\"/timeStep);\n\n // rename old file\n rename(fileNameToChar(particleFilePathOld),fileNameToChar(particleFilePath));\n}\n\n// * * * * * * * * * * * * * * * public Member Functions * * * * * * * * * * * * * //\nvoid twoWayFiles::getData\n(\n word name,\n word type,\n double ** const& field,\n label step\n) const\n{\n // get input path\n fileName particleFilePath = getFilePath(name,true);\n Info << \"reading from file: \" << particleFilePath << endl;\n\n // set file pointer\n IFstream* inputPtr = new IFstream(particleFilePath);\n\n // write data to variable\n int numberOfParticles;\n /*if(name != \"outRegion1\" && name != \"inRegion1\")*/ *inputPtr >> numberOfParticles;\n\n // give nr of particles to cloud\n setNumberOfParticles(numberOfParticles);\n\n // re-allocate arrays of cloud\n particleCloud_.reAllocArrays();\n\n for(int index = 0;index < numberOfParticles; ++index)\n {\n if (type == \"scalar-atom\")\n {\n *inputPtr >> field[index][0];\n }\n else if (type == \"vector-atom\")\n {\n for(int i=0;i<3;i++) *inputPtr >> field[index][i];\n }\n else\n {\n FatalError<<\"unknown type in twoWayFiles::getData!!!\\n\" << abort(FatalError);\n }\n }\n\n // clean up inputStream\n delete inputPtr;\n\n // rename file\n renameFilePath(particleFilePath,name);\n}\n\nvoid twoWayFiles::giveData\n(\n word name,\n word type,\n double ** const& field,\n const char* datatype\n) const\n{\n // get output path\n fileName particleFilePath = getFilePath(name,false);\n Info << \"writing to file: \" << particleFilePath << endl;\n\n // set file pointer\n OFstream* outputPtr = new OFstream(particleFilePath);\n\n // write data to file\n int numberOfParticles = particleCloud_.numberOfParticles();\n *outputPtr << numberOfParticles << endl;\n\n for(int index = 0;index < numberOfParticles; ++index)\n {\n if (type == \"scalar-atom\")\n {\n *outputPtr << field[index][0] << endl;\n }\n else if (type == \"vector-atom\")\n {\n for(int i=0;i<3;i++) *outputPtr << field[index][i] << \" \";\n *outputPtr << endl;\n }\n else\n {\n FatalError<<\"unknown type in twoWayFiles::giveData!!!\\n\" << abort(FatalError);\n }\n }\n\n // clean up outputStream\n delete outputPtr;\n\n // rename file\n renameFilePath(particleFilePath,name);\n\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayFiles/twoWayFiles.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n two way DEM-CFD coupling via files\n\nClass\n twoWayFiles\n\nSourceFiles\n twoWayFiles.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef twoWayFiles_H\n#define twoWayFiles_H\n\n#include \"dataExchangeModel.H\"\n#include \"OFstream.H\"\n#include \"sys/stat.h\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class twoWayFiles Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass twoWayFiles\n:\n public dataExchangeModel\n{\nprivate:\n\n // private data\n dictionary propsDict_;\n\n // private member functions\n\n const char* wordToChar(word&) const;\n\n const char* fileNameToChar(fileName&) const;\n\n fileName getFilePath(word&, bool) const;\n\n void renameFilePath(fileName&,word&) const;\n\npublic:\n\n //- Runtime type information\n TypeName(\"twoWayFiles\");\n\n\n // Constructors\n\n //- Construct from components\n twoWayFiles\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~twoWayFiles();\n\n\n // Member Functions\n void getData\n (\n word name,\n word type,\n double ** const& field,\n label step\n ) const;\n\n void getData\n (\n word name,\n word type,\n int ** const& field,\n label step\n ) const {FatalError<<\"function not implemented !!! twoWayFiles::getData!!!\\n\" << abort(FatalError);};\n\n void giveData\n (\n word name,\n word type,\n double ** const& field,\n const char* datatype = \"\"\n ) const;\n\n word myType() const{return typeName; };\n\n void setCG() const\n {\n Warning << \"setCG() not used correctly here...we assume cg=1\" << endl;\n particleCloud_.setCG(1);\n };\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayMPI/twoWayMPI.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n#include \"twoWayMPI.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \"clockModel.H\"\n#include \"pair.h\"\n#include \"force.h\"\n#include \"forceModel.H\"\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(twoWayMPI, 0);\n\naddToRunTimeSelectionTable\n(\n dataExchangeModel,\n twoWayMPI,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\ntwoWayMPI::twoWayMPI\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n dataExchangeModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n lmp(NULL)\n{\n Info<<\"Starting up LIGGGHTS for first time execution\"<input->file(liggghtsPath.c_str());\n\n // get DEM time step size\n DEMts_ = lmp->update->dt;\n checkTSsize();\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\ntwoWayMPI::~twoWayMPI()\n{\n delete lmp;\n}\n\n// * * * * * * * * * * * * * * * private Member Functions * * * * * * * * * * * * * //\nchar* twoWayMPI::wordToChar(word& inWord) const\n{\n return const_cast(inWord.c_str());\n}\n\n\n// * * * * * * * * * * * * * * * public Member Functions * * * * * * * * * * * * * //\n\nvoid twoWayMPI::getData\n(\n word name,\n word type,\n double ** const& field,\n label step\n) const\n{\n char* charName = wordToChar(name);\n char* charType = wordToChar(type);\n data_liggghts_to_of(charName,charType, lmp, (void*&) field, (char *)\"double\");\n}\n\nvoid twoWayMPI::getData\n(\n word name,\n word type,\n int ** const& field,\n label step\n) const\n{\n char* charName = wordToChar(name);\n char* charType = wordToChar(type);\n data_liggghts_to_of(charName,charType, lmp, (void*&) field, (char *)\"int\");\n}\n\nvoid twoWayMPI::giveData\n(\n word name,\n word type,\n double ** const& field,\n const char* datatype\n) const\n{\n char* charName = wordToChar(name);\n char* charType = wordToChar(type);\n char* charDatatype= const_cast (datatype);\n data_of_to_liggghts(charName,charType, lmp, (void*) field,charDatatype);\n}\n//============\n// double **\nvoid Foam::twoWayMPI::allocateArray\n(\n double**& array,\n double initVal,\n int width,\n int length\n) const\n{\n //if(length==-1) then LIGGGHTS uses own length data\n allocate_external_double(array, width,length,initVal,lmp);\n}\n\nvoid Foam::twoWayMPI::allocateArray\n(\n double**& array,\n double initVal,\n int width,\n const char* length\n) const\n{\n //if(length==-1) then LIGGGHTS uses own length data\n char* charLength= const_cast (length);\n allocate_external_double(array, width,charLength,initVal,lmp);\n}\nvoid Foam::twoWayMPI::destroy(double** array,int len) const\n{\n if (array == NULL) return;\n\n //for ( int i = 0; i < len; i++ ) // does not work\n for ( int i = 0; i < 1; i++ )\n free(array[i]); \n\n free(array);\n}\n//============\n// int **\nvoid Foam::twoWayMPI::allocateArray\n(\n int**& array,\n int initVal,\n int width,\n int length\n) const\n{\n //if(length==-1) then LIGGGHTS uses own length data\n allocate_external_int(array, width,length,initVal,lmp);\n}\n\nvoid Foam::twoWayMPI::allocateArray\n(\n int**& array,\n int initVal,\n int width,\n const char* length\n) const\n{\n //if(length==-1) then LIGGGHTS uses own length data\n char* charLength= const_cast (length);\n allocate_external_int(array, width,charLength,initVal,lmp);\n}\nvoid Foam::twoWayMPI::destroy(int** array,int len) const\n{\n if (array == NULL) return;\n\n //for ( int i = 0; i < len; i++ ) // does not work\n for ( int i = 0; i < 1; i++ )\n free(array[i]); \n\n free(array);\n}\n\nbool Foam::twoWayMPI::couple(int i) const\n{\n bool coupleNow = false;\n if (i==0)\n {\n couplingStep_++;\n coupleNow = true;\n\n // start liggghts\n {\n // run commands from liggghtsCommands dict\n Info<<\"Starting up LIGGGHTS\" << endl;\n particleCloud_.clockM().start(3,\"LIGGGHTS\");\n\n // check if liggghtsCommandModels with exaxt timing are being run\n bool exactTiming(false);\n int runComNr = -10;\n DynamicList interruptTimes(0);\n DynamicList DEMstepsToInterrupt(0);\n DynamicList lcModel(0);\n\n forAll(particleCloud_.liggghtsCommandModelList(),i)\n {\n // Check if exact timing is needed\n // get time for execution\n // store time for execution in list\n if(particleCloud_.liggghtsCommand()[i]().exactTiming())\n {\n exactTiming = true;\n DynamicList h = particleCloud_.liggghtsCommand()[i]().executionsWithinPeriod(TSstart(),TSend());\n\n forAll(h,j)\n {\n // save interrupt times (is this necessary)\n interruptTimes.append(h[j]);\n\n // calc stepsToInterrupt\n DEMstepsToInterrupt.append(DEMstepsTillT(h[j]));\n\n // remember which liggghtsCommandModel to run\n lcModel.append(i);\n }\n\n // make cumulative\n label len = DEMstepsToInterrupt.size();\n label ind(0);\n forAll(DEMstepsToInterrupt,i)\n {\n ind = len-i-1;\n if(ind>0)\n DEMstepsToInterrupt[ind] -= DEMstepsToInterrupt[ind-1];\n } \n\n Info << \"Foam::twoWayMPI::couple(i): interruptTimes=\" << interruptTimes << endl;\n Info << \"Foam::twoWayMPI::couple(i): DEMstepsToInterrupt=\" << DEMstepsToInterrupt << endl;\n Info << \"Foam::twoWayMPI::couple(i): lcModel=\" << lcModel << endl;\n }\n\n if(particleCloud_.liggghtsCommand()[i]().type()==\"runLiggghts\")\n runComNr=i;\n }\n\n // models with exact timing exists\n label commandLines(0);\n if(exactTiming)\n {\n // extension for more liggghtsCommands active the same time:\n // sort interrupt list within this run period\n // keep track of corresponding liggghtsCommand\n int DEMstepsRun(0);\n \n forAll(interruptTimes,j)\n { \n // set run command till interrupt\n DEMstepsRun += DEMstepsToInterrupt[j]; \n particleCloud_.liggghtsCommand()[runComNr]().set(DEMstepsToInterrupt[j]);\n const char* command = particleCloud_.liggghtsCommand()[runComNr]().command(0);\n Info << \"Executing run command: '\"<< command <<\"'\"<< endl;\n lmp->input->one(command);\n \n // run liggghts command with exact timing\n command = particleCloud_.liggghtsCommand()[lcModel[j]]().command(0);\n Info << \"Executing command: '\"<< command <<\"'\"<< endl;\n lmp->input->one(command);\n }\n\n // do the run\n if(particleCloud_.liggghtsCommand()[runComNr]().runCommand(couplingStep()))\n {\n particleCloud_.liggghtsCommand()[runComNr]().set(couplingInterval() - DEMstepsRun);\n const char* command = particleCloud_.liggghtsCommand()[runComNr]().command(0);\n Info << \"Executing run command: '\"<< command <<\"'\"<< endl;\n lmp->input->one(command);\n }\n\n // do the other non exact timing models\n forAll(particleCloud_.liggghtsCommandModelList(),i)\n {\n if\n (\n ! particleCloud_.liggghtsCommand()[i]().exactTiming() &&\n particleCloud_.liggghtsCommand()[i]().runCommand(couplingStep())\n )\n {\n commandLines=particleCloud_.liggghtsCommand()[i]().commandLines();\n for(int j=0;jinput->one(command);\n }\n }\n }\n }\n // no model with exact timing exists\n else\n {\n forAll(particleCloud_.liggghtsCommandModelList(),i)\n {\n if(particleCloud_.liggghtsCommand()[i]().runCommand(couplingStep()))\n {\n commandLines=particleCloud_.liggghtsCommand()[i]().commandLines();\n for(int j=0;jinput->one(command);\n }\n }\n }\n }\n\n particleCloud_.clockM().stop(\"LIGGGHTS\");\n Info<<\"LIGGGHTS finished\"<\n#include \n#include \n#include \n#include // these are LAMMPS include files\n#include \n#include \n#include \n#include \n#include \n#include \n//=================================//\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass twoWayMPI\n:\n public dataExchangeModel\n{\nprivate:\n\n // private data\n dictionary propsDict_;\n MPI_Comm comm_liggghts;\n\n // private member functions\n\n char* wordToChar(word&) const;\n\nprotected:\n LAMMPS_NS::LAMMPS *lmp;\n\npublic:\n\n //- Runtime type information\n TypeName(\"twoWayMPI\");\n\n\n // Constructors\n\n //- Construct from components\n twoWayMPI\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~twoWayMPI();\n\n\n // Member Functions\n\n void getData\n (\n word name,\n word type,\n double ** const& field,\n label step\n ) const;\n\n void getData\n (\n word name,\n word type,\n int ** const& field,\n label step\n ) const;\n\n void giveData\n (\n word name,\n word type,\n double ** const& field,\n const char* datatype\n ) const;\n\n //============\n // double **\n void allocateArray(double**&, double, int, int) const;\n void allocateArray(double**&, double, int,const char* =\"nparticles\") const;\n void destroy(double**,int) const;\n //============\n // int **\n void allocateArray(int**&, int, int, int) const;\n void allocateArray(int**&, int, int,const char* =\"nparticles\") const;\n void destroy(int**,int) const;\n //==============\n\n bool couple(int) const;\n\n int getNumberOfParticles() const;\n int getNumberOfClumps() const;\n int getNumberOfTypes() const;\n double* getTypeVol() const;\n\n word myType() const{return typeName; };\n\n void setCG() const { setCGs(lmp); };\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/Archimedes/Archimedes.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"Archimedes.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(Archimedes, 0);\n\naddToRunTimeSelectionTable\n(\n forceModel,\n Archimedes,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nArchimedes::Archimedes\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n forceModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n twoDimensional_(false),\n gravityFieldName_(propsDict_.lookupOrDefault(\"gravityFieldName\",\"g\")),\n #if defined(version21) || defined(version16ext)\n g_(sm.mesh().lookupObject (gravityFieldName_)),\n #elif defined(version15)\n g_(dimensionedVector(sm.mesh().lookupObject(\"environmentalProperties\").lookup(gravityFieldName_)).value()),\n #endif\n rhoFieldName_(propsDict_.lookupOrDefault(\"densityFieldName\",\"rho\")),\n rho_(sm.mesh().lookupObject (rhoFieldName_))\n{\n // suppress particle probe\n if (probeIt_ && propsDict_.found(\"suppressProbe\"))\n probeIt_=!Switch(propsDict_.lookup(\"suppressProbe\"));\n if(probeIt_)\n {\n particleCloud_.probeM().initialize(typeName, typeName+\".logDat\");\n particleCloud_.probeM().vectorFields_.append(\"archimedesForce\"); //first entry must the be the force\n particleCloud_.probeM().scalarFields_.append(\"Vp\");\n particleCloud_.probeM().writeHeader();\n }\n\n particleCloud_.checkCG(true);\n\n if (propsDict_.found(\"twoDimensional\"))\n {\n twoDimensional_=true;\n Info << \"2-dimensional simulation - make sure DEM side is 2D\" << endl;\n }\n\n // init force sub model\n setForceSubModels(propsDict_);\n\n // define switches which can be read from dict\n forceSubM(0).setSwitchesList(3,true); // activate search for verbose switch\n forceSubM(0).setSwitchesList(4,true); // activate search for interpolate switch\n\n //set default switches (hard-coded default = false)\n forceSubM(0).setSwitches(1,true); // Archimedes only on DEM side (treatForceDEM=true)\n\n // read those switches defined above, if provided in dict\n for (int iFSub=0;iFSub disallow for now\n FatalError << type() << \": You are trying to run this model in particle based operation mode. This has not been tested. Aborting...\" << endl;\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nArchimedes::~Archimedes()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nvoid Archimedes::setForce() const\n{\n vector force(0,0,0);\n scalar piBySix(M_PI/6.);\n scalar Vs(0.);\n scalar ds(0.);\n vector position(0,0,0);\n label cellI=0;\n scalar RhoInt(0.);\n\n #include \"resetRhoInterpolator.H\"\n #include \"setupProbeModel.H\"\n\n for(int index = 0;index < particleCloud_.numberOfObjects(particleBased_); index++)\n {\n cellI = particleCloud_.cfdemCloud::cellIDs(particleBased_)[index][0];\n force=vector::zero;\n\n if (cellI > -1) // particle Found\n {\n if(twoDimensional_)\n {\n scalar r = particleCloud_.radius(index);\n force = -g_.value()*forceSubM(0).rhoField()[cellI]*r*r*M_PI; // circle area\n Warning << \"Archimedes::setForce() : this functionality is not tested!\" << endl;\n }\n else\n {\n if (forceSubM(0).interpolation())\n {\n position = particleCloud_.cfdemCloud::position(index, particleBased_);\n RhoInt = RhoInterpolator_().interpolate(position, cellI);\n }\n else\n RhoInt = forceSubM(0).rhoField()[cellI];\n\n if (forceSubM(0).sq() || forceSubM(0).convex())\n {\n Vs = particleCloud_.volume(index);\n }\n else\n {\n ds = particleCloud_.diameter(index, particleBased_);\n scalar dParcel = ds;\n forceSubM(0).scaleDia(dParcel,index); //caution: this fct will scale ds!\n Vs = dParcel*dParcel*dParcel*piBySix;\n }\n\n force = -g_.value() * RhoInt * Vs;\n\n forceSubM(0).scaleForce(force,ds,index);\n }\n\n if(forceSubM(0).verbose() && index==0)\n {\n Pout << \"g = \" << g_.value() << endl;\n Pout << \"cellI = \" << cellI << endl;\n Pout << \"index = \" << index << endl;\n if (forceSubM(0).interpolation())\n Pout << \"Rho(\" << position <<\") = \"<< RhoInt << endl;\n else\n Pout << \"forceSubM(0).rhoField()[cellI] = \" << forceSubM(0).rhoField()[cellI] << endl;\n Pout << \"Vs = \" << Vs << endl;\n Pout << \"force = \" << force << endl;\n\n if (forceSubM(0).ms())\n {\n label ind = particleCloud_.clumpIndexOfParticle(index);\n Pout << \"clumpType = \" << particleCloud_.clumpType(ind) << endl;\n }\n }\n\n //Set value fields and write the probe\n if(probeIt_)\n {\n #include \"setupProbeModelfields.H\"\n // Note: for other than ext one could use vValues.append(x)\n // instead of setSize\n vValues.setSize(vValues.size()+1, force); //first entry must the be the force\n sValues.setSize(sValues.size()+1, particleCloud_.cfdemCloud::particleVolume(index)); //change this to Vs after TH is clean\n particleCloud_.probeM().writeProbe(index, sValues, vValues);\n }\n }\n\n // write particle based data to global array\n forceSubM(0).partToArray(index,force,vector::zero);\n }\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/Archimedes/Archimedes.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n Archimedes buoyancy force for sphere / cylinder (2d)\n basic \"on-off\" handling of buoyancy at the interface\n\nClass\n Archimedes\n\nSourceFiles\n Archimedes.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef Archimedes_H\n#define Archimedes_H\n\n#include \"forceModel.H\"\n#include \"interpolationCellPoint.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class Archimedes Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass Archimedes\n:\n public forceModel\n{\nprivate:\n dictionary propsDict_;\n\n bool twoDimensional_;\n\n word gravityFieldName_;\n\n #ifdef version21\n const uniformDimensionedVectorField& g_; // ref to gravity\n #elif defined(version16ext) || defined(version15)\n const dimensionedVector& g_; // ref to gravity\n #endif\n\n word rhoFieldName_;\n const volScalarField& rho_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"Archimedes\");\n\n\n // Constructors\n\n //- Construct from components\n Archimedes\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~Archimedes();\n\n\n // Member Functions\n void setForce() const;\n\n void MSinit();\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/ArchimedesIB/ArchimedesIB.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"ArchimedesIB.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \"voidFractionModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(ArchimedesIB, 0);\n\naddToRunTimeSelectionTable\n(\n forceModel,\n ArchimedesIB,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nArchimedesIB::ArchimedesIB\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n forceModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n twoDimensional_(false),\n voidfractionFieldName_(propsDict_.lookupOrDefault(\"voidfractionFieldName\",\"voidfraction\")), //mod by alice\n voidfractions_(sm.mesh().lookupObject (voidfractionFieldName_)),//mod by alice\n gravityFieldName_(propsDict_.lookupOrDefault(\"gravityFieldName\",\"g\")),\n #if defined(version21) || defined(version16ext)\n g_(sm.mesh().lookupObject (gravityFieldName_))\n #elif defined(version15)\n g_(dimensionedVector(sm.mesh().lookupObject(\"environmentalProperties\").lookup(gravityFieldName_)).value())\n #endif\n{\n // suppress particle probe\n if (probeIt_ && propsDict_.found(\"suppressProbe\"))\n probeIt_=!Switch(propsDict_.lookup(\"suppressProbe\"));\n if(probeIt_)\n {\n particleCloud_.probeM().initialize(typeName, typeName+\".logDat\");\n particleCloud_.probeM().vectorFields_.append(\"archimedesIBForce\"); //first entry must the be the force\n particleCloud_.probeM().writeHeader();\n }\n\n particleCloud_.checkCG(true);\n\n if (propsDict_.found(\"twoDimensional\"))\n {\n twoDimensional_=true;\n Info << \"2-dimensional simulation - make sure DEM side is 2D\" << endl;\n }\n\n // init force sub model\n setForceSubModels(propsDict_);\n\n // define switches which can be read from dict\n forceSubM(0).setSwitchesList(0,true); // activate treatExplicit switch\n\n //set default switches (hard-coded default = false)\n forceSubM(0).setSwitches(0,true); // enable treatExplicit, otherwise this force would be implicit in slip vel! - IMPORTANT!\n forceSubM(0).setSwitches(1,true); // treatDEM = true\n\n // read those switches defined above, if provided in dict\n for (int iFSub=0;iFSub -1) // particle Found\n {\n //force += -g_.value()*forceSubM(0).rhoField()[cellI]*forceSubM(0).rhoField().mesh().V()[cellI]*(1-particleCloud_.voidfractions()[index][subCell]);//mod by alice\n \tforce += -g_.value()*forceSubM(0).rhoField()[cellI]*particleCloud_.mesh().V()[cellI]*(1-voidfractions_[cellI]);//mod by alice\n \t }\n }\n\n //Set value fields and write the probe\n if(probeIt_)\n {\n #include \"setupProbeModelfields.H\"\n // Note: for other than ext one could use vValues.append(x)\n // instead of setSize\n vValues.setSize(vValues.size()+1, force); //first entry must the be the force\n particleCloud_.probeM().writeProbe(index, sValues, vValues);\n }\n\n // set force on particle\n if(twoDimensional_) Warning<<\"ArchimedesIB model doesn't work for 2D right now!!\\n\"<< endl;\n\n // write particle based data to global array\n forceSubM(0).partToArray(index,force,vector::zero);\n }\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/ArchimedesIB/ArchimedesIB.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n ArchimedesIB buoyancy force for sphere / cylinder (2d)\n basic \"on-off\" handling of buoyancy at the interface\n\n\tContribution by Alice Hager.\n\nClass\n ArchimedesIB\n\nSourceFiles\n ArchimedesIB.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef ArchimedesIB_H\n#define ArchimedesIB_H\n\n#include \"forceModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class ArchimedesIB Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass ArchimedesIB\n:\n public forceModel\n{\nprivate:\n dictionary propsDict_;\n\n bool twoDimensional_;\n\n word voidfractionFieldName_;\n\n const volScalarField& voidfractions_;\n\n word gravityFieldName_;\n\n #ifdef version21\n const uniformDimensionedVectorField& g_; // ref to gravity\n #elif defined(version16ext) || defined(version15)\n const dimensionedVector& g_; // ref to gravity\n #endif\n\n\npublic:\n\n //- Runtime type information\n TypeName(\"ArchimedesIB\");\n\n\n // Constructors\n\n //- Construct from components\n ArchimedesIB\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~ArchimedesIB();\n\n\n // Member Functions\n void setForce() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/DiFeliceDrag/DiFeliceDrag.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"DiFeliceDrag.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(DiFeliceDrag, 0);\n\naddToRunTimeSelectionTable\n(\n forceModel,\n DiFeliceDrag,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nDiFeliceDrag::DiFeliceDrag\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n forceModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n velFieldName_(propsDict_.lookupOrDefault(\"velFieldName\",\"U\")),\n U_(sm.mesh().lookupObject (velFieldName_)),\n voidfractionFieldName_(propsDict_.lookupOrDefault(\"voidfractionFieldName\",\"voidfraction\")),\n voidfraction_(sm.mesh().lookupObject (voidfractionFieldName_)),\n UsFieldName_(propsDict_.lookupOrDefault(\"granVelFieldName\",\"Us\")),\n UsField_(sm.mesh().lookupObject (UsFieldName_))\n{\n // suppress particle probe\n if (probeIt_ && propsDict_.found(\"suppressProbe\"))\n probeIt_=!Switch(propsDict_.lookup(\"suppressProbe\"));\n if (probeIt_)\n {\n particleCloud_.probeM().initialize(typeName, typeName+\".logDat\");\n particleCloud_.probeM().vectorFields_.append(\"dragForce\"); //first entry must be the force\n particleCloud_.probeM().vectorFields_.append(\"Urel\"); //other are debug\n particleCloud_.probeM().scalarFields_.append(\"Rep\"); //other are debug\n particleCloud_.probeM().scalarFields_.append(\"Cd\"); //other are debug\n particleCloud_.probeM().scalarFields_.append(\"voidfraction\"); //other are debug\n particleCloud_.probeM().writeHeader();\n }\n\n particleCloud_.checkCG(true);\n\n // init force sub model\n setForceSubModels(propsDict_);\n\n // define switches which can be read from dict\n forceSubM(0).setSwitchesList(0,true); // activate treatExplicit switch\n forceSubM(0).setSwitchesList(2,true,true); // activate implForceDEM switch and set default to true\n forceSubM(0).setSwitchesList(3,true); // activate search for verbose switch\n forceSubM(0).setSwitchesList(4,true); // activate search for interpolate switch\n forceSubM(0).setSwitchesList(8,true); // activate scalarViscosity switch\n forceSubM(0).setSwitchesList(17,true); // activate DiFelice drag correction switch\n forceSubM(0).setSwitchesList(18,true); // activate Rong drag correction switch\n forceSubM(0).setSwitchesList(23,true); // activate Tang drag correction switch\n forceSubM(0).setSwitchesList(28,true); // allow particle specific coarsegraining\n\n //set default switches (hard-coded default = false)\n forceSubM(0).setSwitches(17,true); // DiFelice drag correction as default\n forceSubM(0).setSwitches(18,false); // Rong drag correction NOT default\n forceSubM(0).setSwitches(23,false); // Tang drag correction NOT default\n\n // read those switches defined above, if provided in dict\n for (int iFSub=0;iFSub -1) // particle Found\n {\n if (forceSubM(0).interpolation())\n {\n position = particleCloud_.position(index, particleBased_);\n\n voidfraction = voidfractionInterpolator_().interpolate(position,cellI);\n Ufluid = UInterpolator_().interpolate(position,cellI);\n\n //Ensure interpolated void fraction to be meaningful\n // Info << \" --> voidfraction: \" << voidfraction << endl;\n if(voidfraction>1.00) voidfraction = 1.00;\n if(voidfraction<0.30) voidfraction = 0.30;\n }\n else\n {\n voidfraction = voidfraction_[cellI];\n Ufluid = U_[cellI];\n }\n\n // correct voidfraction\n ds = particleCloud_.diameter(index, particleBased_);\n// for (int iFSub=0;iFSub SMALL && ds > SMALL)\n {\n\n // calc particle Re Nr\n Rep = ds*voidfraction*magUr/(nuf+SMALL);\n\n // calc fluid drag Coeff\n Cd = sqr(0.63 + 4.8/sqrt(Rep));\n\n // calc model coefficient Xi\n scalar Xi = 0;\n for (int iFSub=0;iFSub(\"velFieldName\",\"U\")),\n U_(sm.mesh().lookupObject (velFieldName_)),\n voidfractionFieldName_(propsDict_.lookupOrDefault(\"voidfractionFieldName\",\"voidfraction\")),\n voidfraction_(sm.mesh().lookupObject (voidfractionFieldName_)),\n phi_(propsDict_.lookupOrDefault(\"phi\",1.)),\n UsFieldName_(propsDict_.lookupOrDefault(\"granVelFieldName\",\"Us\")),\n UsField_(sm.mesh().lookupObject (UsFieldName_)),\n switchingVoidfraction_(0.8)\n{\n // suppress particle probe\n if (probeIt_ && propsDict_.found(\"suppressProbe\"))\n probeIt_=!Switch(propsDict_.lookup(\"suppressProbe\"));\n if(probeIt_)\n {\n particleCloud_.probeM().initialize(typeName, typeName+\".logDat\");\n particleCloud_.probeM().vectorFields_.append(\"dragForce\"); //first entry must be the force\n particleCloud_.probeM().vectorFields_.append(\"Urel\"); //other are debug\n particleCloud_.probeM().scalarFields_.append(\"Rep\"); //other are debug\n particleCloud_.probeM().scalarFields_.append(\"betaP\");\n particleCloud_.probeM().scalarFields_.append(\"voidfraction\"); //other are debug\n particleCloud_.probeM().writeHeader();\n }\n\n particleCloud_.checkCG(true);\n\n // init force sub model\n setForceSubModels(propsDict_);\n\n // define switches which can be read from dict\n forceSubM(0).setSwitchesList(0,true); // activate treatExplicit switch\n forceSubM(0).setSwitchesList(2,true,true); // activate implForceDEM switch and set default to true\n forceSubM(0).setSwitchesList(3,true); // activate search for verbose switch\n forceSubM(0).setSwitchesList(4,true); // activate search for interpolate switch\n forceSubM(0).setSwitchesList(8,true); // activate scalarViscosity switch\n\n //set default switches (hard-coded default = false)\n //forceSubM(0).setSwitches(XXX,true);\n\n // read those switches defined above, if provided in dict\n for (int iFSub=0;iFSub -1) // particle Found\n {\n if(forceSubM(0).interpolation())\n {\n position = particleCloud_.cfdemCloud::position(index);\n voidfraction = voidfractionInterpolator_().interpolate(position,cellI);\n Ufluid = UInterpolator_().interpolate(position,cellI);\n\n //Ensure interpolated void fraction to be meaningful\n // Info << \" --> voidfraction: \" << voidfraction << endl;\n if(voidfraction>1.00) voidfraction = 1.0;\n if(voidfraction<0.10) voidfraction = 0.10;\n }else\n {\n voidfraction = voidfraction_[cellI];\n Ufluid = U_[cellI];\n }\n\n // correct voidfraction\n ds = 2*particleCloud_.radius(index);\n for (int iFSub=0;iFSub switchingVoidfraction_) //dilute\n {\n Rep=ds*voidfraction*magUr/(nuf+SMALL);\n CdMagUrLag = (24.0*nuf/(ds*voidfraction)) //1/magUr missing here, but compensated in expression for betaP!\n *(scalar(1.0)+0.15*Foam::pow(Rep, 0.687));\n\n betaP = 0.75*( //this is betaP = beta / localPhiP!\n rho*voidfraction*CdMagUrLag\n /\n (ds*Foam::pow(voidfraction,2.65))\n );\n }\n else //dense\n {\n betaP = (150 * localPhiP*nuf*rho) //this is betaP = beta / localPhiP!\n / (voidfraction*ds*phi_*ds*phi_)\n +\n (1.75 * magUr * rho)\n /((ds*phi_));\n }\n\n // calc particle's drag\n dragCoefficient = Vs*betaP;\n if (modelType_==\"B\")\n dragCoefficient /= voidfraction;\n\n for (int iFSub=0;iFSub=0 && index <2)\n {\n Pout << \"cellI = \" << cellI << endl;\n Pout << \"index = \" << index << endl;\n Pout << \"Us = \" << Us << endl;\n Pout << \"Ur = \" << Ur << endl;\n Pout << \"dprim = \" << ds << endl;\n Pout << \"phi = \" << phi_ << endl;\n Pout << \"rho = \" << rho << endl;\n Pout << \"nuf = \" << nuf << endl;\n Pout << \"voidfraction = \" << voidfraction << endl;\n Pout << \"Rep = \" << Rep << endl;\n Pout << \"betaP = \" << betaP << endl;\n Pout << \"drag = \" << drag << endl;\n }\n\n //Set value fields and write the probe\n if(probeIt_)\n {\n #include \"setupProbeModelfields.H\"\n // Note: for other than ext one could use vValues.append(x)\n // instead of setSize\n vValues.setSize(vValues.size()+1, drag); //first entry must the be the force\n vValues.setSize(vValues.size()+1, Ur);\n sValues.setSize(sValues.size()+1, Rep);\n sValues.setSize(sValues.size()+1, betaP);\n sValues.setSize(sValues.size()+1, voidfraction);\n particleCloud_.probeM().writeProbe(index, sValues, vValues);\n }\n }\n\n // write particle based data to global array\n forceSubM(0).partToArray(index,drag,dragExplicit,Ufluid,dragCoefficient);\n }\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/GidaspowDrag/GidaspowDrag.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n Gidaspow drag law\n - only valid for low-Reynolds number systems (Re_p<1000)\n - including interpolation of the velocity to the exact position\n - splits off explicit drag component due to fluctuation in fluid and particle\n velocity (optional via forceSubModel \"ImExCorr\")\n\nClass\n GidaspowDrag\n\nSourceFiles\n GidaspowDrag.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef GidaspowDrag_H\n#define GidaspowDrag_H\n\n#include \"forceModel.H\"\n#include \"interpolationCellPoint.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class GidaspowDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass GidaspowDrag\n:\n public forceModel\n{\nprivate:\n dictionary propsDict_;\n\n word velFieldName_;\n\n const volVectorField& U_;\n\n word voidfractionFieldName_;\n\n const volScalarField& voidfraction_;\n\n const scalar phi_;\n\n word UsFieldName_; \n\n const volVectorField& UsField_; // the average particle velocity field\n\n mutable scalar switchingVoidfraction_; //voidfraction above which dilute formulation will be used\n\npublic:\n\n //- Runtime type information\n TypeName(\"GidaspowDrag\");\n\n\n // Constructors\n\n //- Construct from components\n GidaspowDrag\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~GidaspowDrag();\n\n\n // Member Functions\n void setForce() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/KochHillDrag/KochHillDrag.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"KochHillDrag.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \"dataExchangeModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(KochHillDrag, 0);\n\naddToRunTimeSelectionTable\n(\n forceModel,\n KochHillDrag,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nKochHillDrag::KochHillDrag\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n forceModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n velFieldName_(propsDict_.lookupOrDefault(\"velFieldName\",\"U\")),\n U_(sm.mesh().lookupObject (velFieldName_)),\n voidfractionFieldName_(propsDict_.lookupOrDefault(\"voidfractionFieldName\",\"voidfraction\")),\n voidfraction_(sm.mesh().lookupObject (voidfractionFieldName_)),\n UsFieldName_(propsDict_.lookupOrDefault(\"granVelFieldName\",word(\"Us\"))),\n UsField_(sm.mesh().lookupObject (UsFieldName_))\n{\n // suppress particle probe\n if (probeIt_ && propsDict_.found(\"suppressProbe\"))\n probeIt_=!Switch(propsDict_.lookup(\"suppressProbe\"));\n if(probeIt_)\n {\n particleCloud_.probeM().initialize(typeName, typeName+\".logDat\");\n particleCloud_.probeM().vectorFields_.append(\"dragForce\"); //first entry must be the force\n particleCloud_.probeM().vectorFields_.append(\"Urel\"); //other are debug\n particleCloud_.probeM().scalarFields_.append(\"Rep\"); //other are debug\n particleCloud_.probeM().scalarFields_.append(\"beta\"); //other are debug\n particleCloud_.probeM().scalarFields_.append(\"voidfraction\"); //other are debug\n particleCloud_.probeM().writeHeader();\n }\n\n particleCloud_.checkCG(true);\n\n // init force sub model\n setForceSubModels(propsDict_);\n\n // define switches which can be read from dict\n forceSubM(0).setSwitchesList(0,true); // activate treatExplicit switch\n forceSubM(0).setSwitchesList(2,true,true); // activate implForceDEM switch and set default to true\n forceSubM(0).setSwitchesList(3,true); // activate search for verbose switch\n forceSubM(0).setSwitchesList(4,true); // activate search for interpolate switch\n forceSubM(0).setSwitchesList(7,true); // activate implForceDEMacc switch\n forceSubM(0).setSwitchesList(8,true); // activate scalarViscosity switch\n\n //set default switches (hard-coded default = false)\n //forceSubM(0).setSwitches(XXX,true);\n\n // read those switches defined above, if provided in dict\n for (int iFSub=0;iFSub -1) // particle Found\n {\n if(forceSubM(0).interpolation())\n {\n position = particleCloud_.cfdemCloud::position(index);\n voidfraction = voidfractionInterpolator_().interpolate(position,cellI);\n Ufluid = UInterpolator_().interpolate(position,cellI);\n\n //Ensure interpolated void fraction to be meaningful\n // Info << \" --> voidfraction: \" << voidfraction << endl;\n if(voidfraction>1.00) voidfraction = 1.00;\n if(voidfraction<0.40) voidfraction = 0.40;\n }else\n {\n voidfraction = voidfraction_[cellI];\n Ufluid = U_[cellI];\n }\n\n // correct voidfraction\n ds = particleCloud_.diameter(index);\n for (int iFSub=0;iFSub 0)\n {\n\n // calc particle Re Nr\n Rep = ds*voidfraction*magUr/(nuf+SMALL);\n\n // calc model coefficient F0\n scalar F0=0.;\n if(volumefraction < 0.4)\n {\n F0 = (1. + 3.*sqrt((volumefraction)/2.) + (135./64.)*volumefraction*log(volumefraction)\n + 16.14*volumefraction\n )/\n (1+0.681*volumefraction-8.48*sqr(volumefraction)\n +8.16*volumefraction*volumefraction*volumefraction\n );\n } else {\n F0 = 10*volumefraction/(voidfraction*voidfraction*voidfraction);\n }\n\n // calc model coefficient F3\n scalar F3 = 0.0673+0.212*volumefraction+0.0232/pow(voidfraction,5);\n\n //Calculate F (the factor 0.5 is introduced, since Koch and Hill, ARFM 33:619–47, use the radius\n //to define Rep, and we use the particle diameter, see vanBuijtenen et al., CES 66:2368–2376.\n scalar F = voidfraction * (F0 + 0.5*F3*Rep);\n\n // calc drag model coefficient betaP\n betaP = 18.*nuf*rho/(ds*ds)*voidfraction*F;\n\n // calc particle's drag\n dragCoefficient = Vs*betaP;\n if (modelType_==\"B\")\n dragCoefficient /= voidfraction;\n\n for (int iFSub=0;iFSub=0 && index <2)\n {\n Pout << \"cellI = \" << cellI << endl;\n Pout << \"index = \" << index << endl;\n Pout << \"Us = \" << Us << endl;\n Pout << \"Ur = \" << Ur << endl;\n Pout << \"dprim = \" << ds << endl;\n Pout << \"rho = \" << rho << endl;\n Pout << \"nuf = \" << nuf << endl;\n Pout << \"voidfraction = \" << voidfraction << endl;\n Pout << \"Rep = \" << Rep << endl;\n Pout << \"betaP = \" << betaP << endl;\n Pout << \"dragCoefficient = \" << dragCoefficient << endl;\n Pout << \"drag = \" << drag << endl;\n }\n\n //Set value fields and write the probe\n if(probeIt_)\n {\n #include \"setupProbeModelfields.H\"\n // Note: for other than ext one could use vValues.append(x)\n // instead of setSize\n vValues.setSize(vValues.size()+1, drag); //first entry must the be the force\n vValues.setSize(vValues.size()+1, Ur);\n sValues.setSize(sValues.size()+1, Rep);\n sValues.setSize(sValues.size()+1, betaP);\n sValues.setSize(sValues.size()+1, voidfraction);\n particleCloud_.probeM().writeProbe(index, sValues, vValues);\n }\n }\n\n // write particle based data to global array\n forceSubM(0).partToArray(index,drag,dragExplicit,Ufluid,dragCoefficient);\n }\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/KochHillDrag/KochHillDrag.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n Koch, Hill drag law\n based on Koch Hill 2001,\"Inertial effects in suspensions and porous-media \n flows\", Annual Review of fluid mechanics.\n including interpolation of the velocity to the exact position\n including drag coefficient for implicit drag for DEM\n\nClass\n KochHillDrag\n\nSourceFiles\n KochHillDrag.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef KochHillDrag_H\n#define KochHillDrag_H\n\n#include \"forceModel.H\"\n#include \"interpolationCellPoint.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class KochHillDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass KochHillDrag\n:\n public forceModel\n{\nprivate:\n dictionary propsDict_;\n\n word velFieldName_;\n\n const volVectorField& U_;\n\n word voidfractionFieldName_;\n\n const volScalarField& voidfraction_;\n\n word UsFieldName_; \n\n const volVectorField& UsField_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"KochHillDrag\");\n\n\n // Constructors\n\n //- Construct from components\n KochHillDrag\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~KochHillDrag();\n\n\n // Member Functions\n void setForce() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/LaEuScalarTemp/LaEuScalarTemp.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"LaEuScalarTemp.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \"dataExchangeModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(LaEuScalarTemp, 0);\n\naddToRunTimeSelectionTable\n(\n forceModel,\n LaEuScalarTemp,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nLaEuScalarTemp::LaEuScalarTemp\n(\n const dictionary& dict,\n cfdemCloud& sm,\n word name\n)\n:\n forceModel(dict,sm),\n propsDict_(dict.subDict(name == \"\" ? typeName + \"Props\" : name + \"Props\")),\n compressible_(propsDict_.lookupOrDefault(\"compressible\",false)),\n EuFieldName_(propsDict_.lookupOrDefault (\"EuFieldName\",(compressible_ == false) ? \"Tsource\" : \"Qsource\")),\n tempFieldName_(propsDict_.lookup(\"tempFieldName\")),\n T_(sm.mesh().lookupObject (tempFieldName_)),\n voidfractionFieldName_(propsDict_.lookupOrDefault(\"voidfractionFieldName\",\"voidfraction\")),\n voidfraction_(sm.mesh().lookupObject (voidfractionFieldName_)),\n maxSource_(1e30),\n velFieldName_(propsDict_.lookupOrDefault(\"velFieldName\",\"U\")),\n U_(sm.mesh().lookupObject (velFieldName_)),\n lambda_(propsDict_.lookupOrDefault(\"lambda\", -1.0)),\n Cp_(propsDict_.lookupOrDefault(\"Cp\", -1.0)),\n CpField_\n (\n IOobject\n (\n \"CpField\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::NO_READ,\n IOobject::AUTO_WRITE\n ),\n sm.mesh(),\n dimensionedScalar(\"zero\", dimensionSet(0, 2, -2, -1, 0, 0, 0), Cp_)\n ),\n LambdaField_\n (\n IOobject\n (\n \"LambdaField\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::NO_READ,\n IOobject::AUTO_WRITE\n ),\n sm.mesh(),\n dimensionedScalar(\"zero\", dimensionSet(1, 1, -3, -1, 0, 0, 0), lambda_)\n ),\n NuCorrelation_(propsDict_.lookupOrDefault(\"NuCorrelation\", \"LiMason\"))\n{\n /*if (lambda_<0)\n {\n Warning << \"You tried using an invalid value (<0) for lambda - using SMALL instead!\" << endl;\n lambda_=SMALL;\n } else if (lambda_==0)\n Warning << \"Ignoring fluid-particle heat transfer as lambda was is to 0!\" << endl;*/\n\n if (propsDict_.found(\"maxSource\"))\n {\n maxSource_=readScalar(propsDict_.lookup (\"maxSource\"));\n Info << \"limiting eulerian source field to: \" << maxSource_ << endl;\n }\n\n if(compressible_) Info << \"Compressibility mode enabled.\" << endl;\n\n if (NuCorrelation_ == \"LiMason\")\n {\n Info << \"LaEuScalarTemp: using LiMason correlation for Nusselt number.\" << endl;\n Nusselt=&LaEuScalarTemp::NuLiMason;\n }\n else if (NuCorrelation_ == \"Deen\")\n {\n Info << \"LaEuScalarTemp: using Deen correlation for Nusselt number.\" << endl;\n Nusselt = &LaEuScalarTemp::NuDeen;\n }\n else if (NuCorrelation_ == \"Gunn\")\n {\n Info << \"LaEuScalarTemp: using Gunn correlation for Nusselt number.\" << endl;\n Nusselt = &LaEuScalarTemp::NuGunn;\n }\n else\n FatalError << \"Unknown name for Nusselt number correlation: '\" << NuCorrelation_\n << \"'. Must be 'LiMason' or 'Deen' or 'Gunn'.\"\n << abort(FatalError);\n\n // init force sub model\n setForceSubModels(propsDict_);\n\n // define switches which can be read from dict\n forceSubM(0).setSwitchesList(3,true); // activate search for verbose switch\n forceSubM(0).setSwitchesList(4,true); // activate search for interpolate switch\n forceSubM(0).setSwitchesList(8,true); // activate scalarViscosity switch\n\n // read those switches defined above, if provided in dict\n for (int iFSub=0;iFSub (EuFieldName_));\n\n // reset Scalar field\n forAll(EuField,cellI) EuField[cellI] = 0.;\n\n const volScalarField& nufField = forceSubM(0).nuField();\n const volScalarField& rhoField = forceSubM(0).rhoField();\n\n // calc La based heat flux\n vector position(0,0,0);\n scalar voidfraction(1);\n vector Ufluid(0,0,0);\n scalar Tfluid(0);\n label cellI=0;\n vector Us(0,0,0);\n scalar ds(0);\n scalar dparcel(0);\n scalar numberParticlesInParcel(1);\n scalar nuf(0);\n scalar rho(0);\n scalar magUr(0);\n scalar As(0);\n scalar Rep(0);\n scalar Pr(0);\n scalar Nup(0);\n\n #include \"resetVoidfractionInterpolator.H\"\n #include \"resetUInterpolator.H\"\n #include \"resetTInterpolator.H\"\n\n if(Cp_ < 0) CpField_ = EuField.mesh().lookupObject (\"Cp\");\n if(lambda_<0)\n {\n const volScalarField& alpha = EuField.mesh().lookupObject (\"thermo:alpha\");\n LambdaField_ = alpha*CpField_;\n }\n\n for(int index = 0;index < particleCloud_.numberOfParticles(); ++index)\n {\n //if(particleCloud_.regionM().inRegion()[index][0])\n //{\n cellI = particleCloud_.cfdemCloud::cellIDs()[index][0];\n if(cellI >= 0)\n {\n if(forceSubM(0).interpolation())\n {\n position = particleCloud_.cfdemCloud::position(index);\n voidfraction = voidfractionInterpolator_().interpolate(position,cellI);\n Ufluid = UInterpolator_().interpolate(position,cellI);\n Tfluid = TInterpolator_().interpolate(position,cellI);\n }else\n {\n voidfraction = voidfraction_[cellI];\n Ufluid = U_[cellI];\n Tfluid = T_[cellI];\n }\n\n // calc relative velocity\n Us = particleCloud_.cfdemCloud::velocity(index);\n ds = 2*particleCloud_.radius(index);\n dparcel = ds;\n forceSubM(0).scaleDia(ds,index); //caution: this fct will scale ds!\n numberParticlesInParcel = dparcel/ds;\n numberParticlesInParcel *= numberParticlesInParcel*numberParticlesInParcel;\n nuf = nufField[cellI];\n rho = rhoField[cellI];\n if (LambdaField_[cellI]<0)\n {\n Warning << \"You tried using an invalid value (<0) for lambda - using SMALL instead!\" << endl;\n LambdaField_[cellI]=SMALL;\n }\n if (CpField_[cellI]<0)\n {\n Warning << \"You tried using an invalid value (<0) for Cp - using SMALL instead!\" << endl;\n CpField_[cellI]=SMALL;\n }\n\n //Update any scalar or vector quantity\n for (int iFSub=0;iFSub0)\n {\n Pr = max(SMALL,CpField_[cellI]*nuf*rho/LambdaField_[cellI]);\n\n Nup = (this->*Nusselt)(Rep, Pr, voidfraction);\n\n h = LambdaField_[cellI]*Nup/(ds);\n }\n\n // calc convective heat flux [W]\n scalar partHeatFlux = h * As * (Tfluid - particleCloud_.fieldsToDEM[particleCloud_.idTemp()][index][0]);\n particleCloud_.fieldsToDEM[particleCloud_.idConvectiveHeatFlux()][index][0] = partHeatFlux;\n\n if(forceSubM(0).verbose() && index >=0 && index <2)\n {\n Pout << \"magUr = \" << magUr << endl;\n Pout << \"As = \" << As << endl;\n Pout << \"r = \" << particleCloud_.radius(index) << endl;\n Pout << \"dprim = \" << ds << endl;\n Pout << \"nuf = \" << nuf << endl;\n Pout << \"Rep = \" << Rep << endl;\n Pout << \"Pr = \" << Pr << endl;\n Pout << \"Nup = \" << Nup << endl;\n Pout << \"voidfraction = \" << voidfraction << endl;\n Pout << \"particleCloud_.fieldsToDEM[particleCloud_.idTemp()][index][0] = \" << particleCloud_.fieldsToDEM[particleCloud_.idTemp()][index][0] << endl;\n Pout << \"particleCloud_.fieldsToDEM[particleCloud_.idConvectiveHeatFlux()][index][0] = \" << particleCloud_.fieldsToDEM[particleCloud_.idConvectiveHeatFlux()][index][0] << endl;\n Pout << \"Tfluid = \" << Tfluid << endl ;\n }\n }\n //}\n }\n\n particleCloud_.averagingM().setScalarSum\n (\n EuField,\n particleCloud_.fieldsToDEM[particleCloud_.idConvectiveHeatFlux()],\n particleCloud_.particleWeights(),\n NULL\n );\n\n // scale with -1./(Vcell*rho*Cp)\n\n if(compressible_)\n {\n forAll(EuField,cellI)\n EuField[cellI] /= -EuField.mesh().V()[cellI];\n } else\n {\n forAll(EuField,cellI)\n EuField[cellI] /= -rhoField[cellI]*CpField_[cellI]*EuField.mesh().V()[cellI];\n }\n\n // limit source term\n scalar EuFieldInCell;\n forAll(EuField,cellI)\n {\n EuFieldInCell = EuField[cellI];\n\n if(mag(EuFieldInCell) > maxSource_ )\n {\n EuField[cellI] = sign(EuFieldInCell) * maxSource_;\n }\n }\n\n EuField.correctBoundaryConditions();\n\n if(compressible_)\n {\n Info << \"total convective particle-fluid heat flux [W] (Eulerian) = \"\n << gSum(EuField*1*EuField.mesh().V())\n << endl;\n } else\n {\n Info << \"total convective particle-fluid heat flux [W] (Eulerian) = \"\n << gSum(EuField*rhoField*CpField_*EuField.mesh().V())\n << endl;\n }\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/LaEuScalarTemp/LaEuScalarTemp.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n two way LaEu Scalar Exchange between DEM and CFD\n convective heat transfer model following\n Li and Mason (2000), A computational investigation of transient heat\n transfer in pneumatic transport of granular particles, Pow.Tech 112\n\n This model will put all the source into the explicit coupling term\n for the fluid-side integration (might be unstable)\n\nClass\n LaEuScalarTemp\n\nSourceFiles\n LaEuScalarTemp.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef LaEuScalarTemp_H\n#define LaEuScalarTemp_H\n\n#include \"forceModel.H\"\n#include \"averagingModel.H\"\n#include \"interpolationCellPoint.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class LaEuScalarTemp Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass LaEuScalarTemp\n:\n public forceModel\n{\nprotected:\n\n dictionary propsDict_;\n\n bool compressible_;\n\n const word EuFieldName_;\n\n word tempFieldName_;\n\n const volScalarField& T_; // ref to temperature field\n\n word voidfractionFieldName_;\n\n const volScalarField& voidfraction_; // ref to voidfraction field\n\n scalar maxSource_; // max (limited) value of src field\n\n word velFieldName_;\n\n const volVectorField& U_;\n\n scalar lambda_; // fluid thermal conductivity [W/(m*K)]\n\n scalar Cp_; // specific heat capacity [W*s/(kg*K)]\n\n mutable volScalarField CpField_;\n\n mutable volScalarField LambdaField_;\n\n word NuCorrelation_;\n double (LaEuScalarTemp::*Nusselt)(double Re, double Pr, double vf) const;\n\npublic:\n\n //- Runtime type information\n TypeName(\"LaEuScalarTemp\");\n\n // Constructors\n\n //- Construct from components\n LaEuScalarTemp\n (\n const dictionary& dict,\n cfdemCloud& sm,\n word name = word(\"\")\n );\n\n // Destructor\n\n ~LaEuScalarTemp();\n\n\n // Member Functions\n void setForce() const;\n\n //--- Nusselt correlations ---\n\n// Nusselt number correlation from\n// Li and Mason (2000), A computational investigation of transient heat\n// transfer in pneumatic transport of granular particles, Pow.Tech 112\n double NuLiMason(double Re, double Pr, double vf) const\n {\n double Nup(1.);\n double n(3.5);\n\n if (Re < 200)\n Nup = 2. + 0.6 * pow(vf,n) * sqrt(Re) * pow(Pr,0.33);\n else if (Re < 1500)\n Nup = 2. + (0.5 * sqrt(Re) + 0.02 * pow(Re,0.8)) * pow(vf,n) * pow(Pr,0.33);\n else\n Nup = 2. + 0.000045 * pow(vf,n) * pow(Re,1.8);\n\n return Nup;\n }\n\n// Nusselt number correlation from\n// Deen, N.G. et al., Review of direct numerical simulation of\n// fluid–particle mass, momentum and heat transfer in dense gas–solid flows.\n// Chemical Engineering Science 116 (2014) 710–724\n double NuDeen(double Re, double Pr, double vf) const\n {\n //NOTE: This function is fitted for Reynolds numbers between 0 and 100!!!\n double Nup(1.);\n double PrPowOneThird = pow(Pr, 0.3333333333);\n\n Nup = (7.00 - 10.0*vf + 5*vf*vf)\n * (1.00 + 0.17 * pow(Re, 0.2) * PrPowOneThird)\n + (1.33 - 2.31*vf + 1.16*vf*vf) * pow(Re, 0.7) * PrPowOneThird ;\n\n return Nup;\n }\n\n// Nusselt number correlation from\n// Gunn, D. (1978). Transfer of heat or mass to particles in fixed and fluidised beds.\n// International Journal of Heat and Mass Transfer, 21(4):467–476.\n double NuGunn(double Re, double Pr, double vf) const\n {\n //NOTE: This function is fitted for Reynolds numbers between 0 and 100!!!\n double Nup(1.);\n double PrPowOneThird = pow(Pr, 0.3333333333);\n\n Nup = (7.00 - 10.0*vf + 5*vf*vf)\n * (1.00 + 0.70 * pow(Re, 0.2) * PrPowOneThird)\n + (1.33 - 2.40*vf + 1.20*vf*vf) * pow(Re, 0.7) * PrPowOneThird ;\n\n return Nup;\n }\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/MeiLift/MeiLift.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"MeiLift.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(MeiLift, 0);\n\naddToRunTimeSelectionTable\n(\n forceModel,\n MeiLift,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nMeiLift::MeiLift\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n forceModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n velFieldName_(propsDict_.lookupOrDefault(\"velFieldName\",\"U\")),\n U_(sm.mesh().lookupObject (velFieldName_)),\n useSecondOrderTerms_(false)\n{\n if (propsDict_.found(\"useSecondOrderTerms\")) useSecondOrderTerms_=true;\n\n // suppress particle probe\n if (probeIt_ && propsDict_.found(\"suppressProbe\"))\n probeIt_=!Switch(propsDict_.lookup(\"suppressProbe\"));\n if(probeIt_)\n {\n particleCloud_.probeM().initialize(typeName, typeName+\".logDat\");\n particleCloud_.probeM().vectorFields_.append(\"liftForce\"); //first entry must the be the force\n particleCloud_.probeM().vectorFields_.append(\"Urel\"); //other are debug\n particleCloud_.probeM().vectorFields_.append(\"vorticity\"); //other are debug\n particleCloud_.probeM().vectorFields_.append(\"omegaPart\"); //particle rotation rate\n particleCloud_.probeM().scalarFields_.append(\"Rep\"); //other are debug\n particleCloud_.probeM().scalarFields_.append(\"Rew\"); //other are debug\n particleCloud_.probeM().scalarFields_.append(\"J_star\"); //other are debug\n particleCloud_.probeM().writeHeader();\n }\n\n particleCloud_.checkCG(false);\n\n // init force sub model\n setForceSubModels(propsDict_);\n\n // define switches which can be read from dict\n forceSubM(0).setSwitchesList(0,true); // activate treatExplicit switch\n forceSubM(0).setSwitchesList(3,true); // activate search for verbose switch\n forceSubM(0).setSwitchesList(4,true); // activate search for interpolate switch\n forceSubM(0).setSwitchesList(8,true); // activate scalarViscosity switch\n forceSubM(0).setSwitches(14,true); // pullRotation=true\n\n //set default switches (hard-coded default = false)\n forceSubM(0).setSwitches(0,true); // enable treatExplicit, otherwise this force would be implicit in slip vel! - IMPORTANT!\n\n // read those switches defined above, if provided in dict\n for (int iFSub=0;iFSub -1) // particle Found\n {\n Us = particleCloud_.cfdemCloud::velocity(index);\n for(int j=0;j<3;j++)\n omegaParticle[j] = particleCloud_.fieldsToDEM[particleCloud_.idPullRotation()][index][j];\n\n if( forceSubM(0).interpolation() )\n {\n position = particleCloud_.cfdemCloud::position(index);\n Ur = UInterpolator_().interpolate(position,cellI)\n - Us;\n// vorticity = vorticityInterpolator_().interpolate(position,cellI);\n }\n else\n {\n Ur = U_[cellI]\n - Us;\n// vorticity=vorticity_[cellI];\n }\n\n magUr = mag(Ur);\n// magVorticity = mag(vorticity);\n magOmega = mag(omegaParticle);\n\n if (magUr > 0 && magOmega > 0)\n {\n ds = 2*particleCloud_.radius(index);\n dParcel = ds;\n forceSubM(0).scaleDia(ds,index); //caution: this fct will scale ds!\n nuf = nufField[cellI];\n rho = rhoField[cellI];\n\n //Update any scalar or vector quantity\n for (int iFSub=0;iFSub 20)\n {\n J_star = 1.0-0.287/(epsilon*epsilon+SMALL);\n }\n else\n {\n J_star = 0.3\n *( 1.0\n +tanh( 2.5 * log10(epsilon)+0.191 )\n )\n *( 0.667\n +tanh( 6.0 * (epsilon-0.32) )\n );\n }\n Cl=J_star*4.11*epsilon; //multiply McLaughlin's correction to the basic Saffman model\n\n //Second order terms given by Loth and Dorgan 2009\n if(useSecondOrderTerms_)\n {\n Omega_eq = omega_star/2.0*(1.0-0.0075*Rew)*(1.0-0.062*sqrt(Rep)-0.001*Rep);\n Cl_star=1.0-(0.675+0.15*(1.0+tanh(0.28*(omega_star/2.0-2.0))))*tanh(0.18*sqrt(Rep));\n Cl += Omega_eq*Cl_star;\n }\n\n lift = 0.125*M_PI\n *rho\n *Cl\n //*magUr*Ur^vorticity/magVorticity\n *magUr*magUr*omegaParticle^Ur/mag(omegaParticle^Ur)\n *ds*ds; //total force on all particles in parcel\n\n forceSubM(0).scaleForce(lift,dParcel,index);\n\n if (modelType_==\"B\")\n {\n voidfraction = particleCloud_.voidfraction(index);\n lift /= voidfraction;\n }\n }\n\n if(forceSubM(0).verbose() && index==0)\n {\n Pout << \"cellI = \" << cellI << endl;\n Pout << \"index = \" << index << endl;\n Pout << \"Us = \" << Us << endl;\n Pout << \"Ur = \" << Ur << endl;\n// Pout << \"vorticity = \" << vorticity << endl;\n Pout << \"omega_s = \" << omegaParticle << endl;\n Pout << \"dprim = \" << ds << endl;\n Pout << \"rho = \" << rho << endl;\n Pout << \"nuf = \" << nuf << endl;\n Pout << \"Rep = \" << Rep << endl;\n Pout << \"Rew = \" << Rew << endl;\n Pout << \"alphaStar = \" << alphaStar << endl;\n Pout << \"epsilon = \" << epsilon << endl;\n Pout << \"J_star = \" << J_star << endl;\n Pout << \"lift = \" << lift << endl;\n }\n\n //Set value fields and write the probe\n if(probeIt_)\n {\n #include \"setupProbeModelfields.H\"\n // Note: for other than ext one could use vValues.append(x)\n // instead of setSize\n vValues.setSize(vValues.size()+1, lift); //first entry must the be the force\n vValues.setSize(vValues.size()+1, Ur);\n vValues.setSize(vValues.size()+1, omegaParticle);\n sValues.setSize(sValues.size()+1, Rep);\n sValues.setSize(sValues.size()+1, Rew);\n sValues.setSize(sValues.size()+1, J_star);\n particleCloud_.probeM().writeProbe(index, sValues, vValues);\n }\n }\n\n // write particle based data to global array\n forceSubM(0).partToArray(index,lift,vector::zero);\n }\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/MeiLift/MeiLift.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n This function is based on the derivation in R. Kurose, S. Komori, \n Drag and lift forces on a rotating sphere in a linear shear flow, \n Journal of Fluid Mechanics. 384 (1999) 183-206.\n\n The data for this functions is based on J.B. Mclaughlin, \n Inertial migration of a small sphere in linear shear flows, \n Journal of Fluid Mechanics. 224 (1991) 261-274.\n\n The second order terms are based on: \n Mei Lift force following Loth and Dorgan 2009,\n Environ Fluid Mech (2009) 9:187–206, DOI 10.1007/s10652-009-9123-x\n and can be added to the lift coefficient if desired\n (contribution from RQ)\n\n - including interpolation of the velocity to the particle position (optional)\n - including output to file for testing/data analysis (optional)\n\n\nClass\n MeiLift\n\nSourceFiles\n MeiLift.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef MeiLift_H\n#define MeiLift_H\n\n#include \"forceModel.H\"\n#include \"IOList.H\"\n#include \"interpolationCellPoint.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class MeiLift Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass MeiLift\n:\n public forceModel\n{\nprivate:\n dictionary propsDict_;\n\n word velFieldName_;\n\n const volVectorField& U_;\n\n bool useSecondOrderTerms_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"MeiLift\");\n\n\n // Constructors\n\n //- Construct from components\n MeiLift\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~MeiLift();\n\n\n // Member Functions\n void setForce() const;\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/SchillerNaumannDrag/SchillerNaumannDrag.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"SchillerNaumannDrag.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(SchillerNaumannDrag, 0);\n\naddToRunTimeSelectionTable\n(\n forceModel,\n SchillerNaumannDrag,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nSchillerNaumannDrag::SchillerNaumannDrag\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n forceModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n velFieldName_(propsDict_.lookupOrDefault(\"velFieldName\",\"U\")),\n U_(sm.mesh().lookupObject (velFieldName_)),\n voidfractionFieldName_(propsDict_.lookupOrDefault(\"voidfractionFieldName\",\"voidfraction\")),\n voidfraction_(sm.mesh().lookupObject (voidfractionFieldName_)),\n UsFieldName_(propsDict_.lookupOrDefault(\"granVelFieldName\",\"Us\")),\n UsField_(sm.mesh().lookupObject (UsFieldName_))\n{\n // suppress particle probe\n if (probeIt_ && propsDict_.found(\"suppressProbe\"))\n probeIt_=!Switch(propsDict_.lookup(\"suppressProbe\"));\n if(probeIt_)\n {\n particleCloud_.probeM().initialize(typeName, typeName+\".logDat\");\n particleCloud_.probeM().vectorFields_.append(\"dragForce\"); //first entry must the be the force\n particleCloud_.probeM().vectorFields_.append(\"Urel\"); //other are debug\n particleCloud_.probeM().scalarFields_.append(\"Rep\"); //other are debug\n particleCloud_.probeM().scalarFields_.append(\"Cd\"); //other are debug\n particleCloud_.probeM().writeHeader();\n }\n\n particleCloud_.checkCG(false);\n\n // init force sub model\n setForceSubModels(propsDict_);\n\n // define switches which can be read from dict\n forceSubM(0).setSwitchesList(0,true); // activate treatExplicit switch\n forceSubM(0).setSwitchesList(2,true,true); // activate implForceDEM switch and set default to true\n forceSubM(0).setSwitchesList(3,true); // activate search for verbose switch\n forceSubM(0).setSwitchesList(4,true); // activate search for interpolate switch\n forceSubM(0).setSwitchesList(8,true); // activate scalarViscosity switch\n\n //set default switches (hard-coded default = false)\n //forceSubM(0).setSwitches(XXX,true);\n\n // read those switches defined above, if provided in dict\n for (int iFSub=0;iFSub -1) // particle Found\n {\n if(forceSubM(0).interpolation())\n {\n position = particleCloud_.cfdemCloud::position(index);\n voidfraction = voidfractionInterpolator_().interpolate(position,cellI);\n Ufluid = UInterpolator_().interpolate(position,cellI);\n }else\n {\n voidfraction = voidfraction_[cellI];\n Ufluid = U_[cellI];\n }\n\n // correct voidfraction\n ds = 2*particleCloud_.radius(index);\n for (int iFSub=0;iFSub 0)\n {\n // calc particle Re Nr\n Rep = ds*magUr/nuf;\n\n // calc fluid drag Coeff\n Cd = max(0.44,24.0/Rep*(1.0+0.15*pow(Rep,0.687)));\n\n // calc particle's drag\n dragCoefficient = 0.125*Cd*rho\n *M_PI\n *ds*ds\n *magUr;\n\n if (modelType_==\"B\")\n dragCoefficient /= voidfraction;\n\n for (int iFSub=0;iFSub(\"velFieldName\",\"U\")),\n U_(sm.mesh().lookupObject (velFieldName_)),\n pressureFieldName_(propsDict_.lookup(\"pressureFieldName\")),\n p_(sm.mesh().lookupObject (pressureFieldName_)),\n useTorque_(false)\n{\n //Append the field names to be probed\n particleCloud_.probeM().initialize(typeName, typeName+\".logDat\");\n particleCloud_.probeM().vectorFields_.append(\"dragForce\"); //first entry must the be the force\n particleCloud_.probeM().writeHeader();\n\n\n if (propsDict_.found(\"twoDimensional\"))\n {\n twoDimensional_=true;\n depth_ = readScalar(propsDict_.lookup(\"depth\"));\n Info << \"2-dimensional simulation - make sure DEM side is 2D\" << endl;\n Info << \"depth of domain is assumed to be :\" << depth_ << endl;\n }\n\n if(propsDict_.found(\"useTorque\")) useTorque_ = true;\n\n particleCloud_.checkCG(false);\n\n // init force sub model\n setForceSubModels(propsDict_);\n\n // define switches which can be read from dict\n forceSubM(0).setSwitchesList(0,true); // activate treatExplicit switch\n forceSubM(0).setSwitchesList(3,true); // activate search for verbose switch\n\n // read those switches defined above, if provided in dict\n for (int iFSub=0;iFSub -1) // particle Found\n {\n vector rc = particleCloud_.mesh().C()[cellI];\n drag += h[cellI]*h.mesh().V()[cellI];\n torque += (rc - positionCenter)^h[cellI]*h.mesh().V()[cellI];\n }\n\n }\n\n // set force on particle\n if(twoDimensional_) drag /= depth_;\n\n //Set value fields and write the probe\n if(probeIt_)\n {\n #include \"setupProbeModelfields.H\"\n // Note: for other than ext one could use vValues.append(x)\n // instead of setSize\n vValues.setSize(vValues.size()+1, drag); //first entry must the be the force\n particleCloud_.probeM().writeProbe(index, sValues, vValues);\n }\n\n // write particle based data to global array\n forceSubM(0).partToArray(index,drag,vector::zero);\n\n if(forceSubM(0).verbose()) Info << \"impForces = \" << impForces()[index][0]<<\",\"<(\"warnOnly\", true)),\n velocityFieldName_(propsDict_.lookupOrDefault(\"velocityFieldName\", \"U\")),\n U_(sm.mesh().lookupObject (velocityFieldName_)),\n rhoP_(readScalar(propsDict_.lookup(\"rhoP\"))),\n maxCFL_(propsDict_.lookupOrDefault(\"maxCFL\", 1.)),\n maxPCFL_(propsDict_.lookupOrDefault(\"maxPCFL\", 1.)),\n maxAccNr_(propsDict_.lookupOrDefault(\"maxAccNr\", 0.005)),\n maxRelVelChange_(propsDict_.lookupOrDefault(\"maxRelVelChange\", 0.1)),\n UmaxExpected_(readScalar(propsDict_.lookup(\"UmaxExpected\"))),\n minAllowedVcellByVparcel_(propsDict_.lookupOrDefault(\"minAllowedVcellByVparcel\", 3.)),\n largeVcellByVparcel_(propsDict_.lookupOrDefault(\"largeVcellByVparcel\", 10000)),\n nextRun_(0),\n timeInterval_(propsDict_.lookupOrDefault(\"timeInterval\", sm.dataExchangeM().couplingTime())*10.),\n couplingStepInterval_(floor(timeInterval_/sm.dataExchangeM().couplingTime()))\n{\n particleCloud_.checkCG(true);\n\n // init force sub model\n setForceSubModels(propsDict_);\n\n // define switches which can be read from dict\n\n //set default switches (hard-coded default = false)\n //forceSubM(0).setSwitches(XXX,true);\n\n // read those switches defined above, if provided in dict\n for (int iFSub=0;iFSub= nextRun_)\n {\n nextRun_ += couplingStepInterval_;\n return true;\n }\n return false;\n}\n\nvoid checkCouplingInterval::setForce() const\n{\n if(doCheck())\n {\n Info << \"========================================================================\" << endl;\n Info << \"Check Coupling Interval\" << endl;\n Info << \"========================================================================\" << endl;\n\n //==============================================================================================\n // calc the maximum CFL number\n scalar CFL = 0.0;\n scalar CFLexpected = 0.0;\n scalar ts = particleCloud_.mesh().time().deltaT().value();\n\n if (particleCloud_.mesh().nInternalFaces())\n {\n surfaceScalarField phi(particleCloud_.mesh().lookupObject (\"phi\"));\n scalarField sumPhi(fvc::surfaceSum(mag(phi))().internalField());\n\n CFL = 0.5*gMax(sumPhi/particleCloud_.mesh().V().field())*ts;\n\n scalar minVol = gMin(particleCloud_.mesh().V());\n scalar minLen = pow(minVol,1./3.);\n CFLexpected = UmaxExpected_ * ts / minLen;\n }\n\n if (CFL > maxCFL_)\n {\n if(warnOnly_)\n Warning << \"CFL exceeds maximum allowed value:\" << maxCFL_\n << \", and reached the value:\" << CFL\n << \"\\ncheck your settings!\" << endl;\n else\n FatalError << \"CFL exceeds maximum allowed value:\" << maxCFL_\n << \", and reached the value:\" << CFL\n << \"\\nThe simulation is stopped, check your settings.\" << abort(FatalError);\n }\n else if (CFLexpected > maxCFL_)\n if(warnOnly_)\n Warning << \"Expected CFL (based on UmaxExpected) exceeds maximum allowed value:\" << maxCFL_\n << \", and reached the value:\" << CFLexpected\n << \"\\ncheck your settings.\" << endl;\n else\n FatalError << \"Expected CFL (based on UmaxExpected) exceeds maximum allowed value:\" << maxCFL_\n << \", and reached the value:\" << CFLexpected\n << \"\\nThe simulation is stopped, check your settings.\" << abort(FatalError);\n else\n {\n Info << \"max. CFL = \" << CFL << endl;\n Info << \"max. expected CFL (based on UmaxExpected) = \" << CFLexpected << endl;\n }\n //==============================================================================================\n\n\n //==============================================================================================\n // particle relaxation time tau,\n // Stokes nr,\n // cell/particle volume ratio\n\n const volScalarField& nufField = forceSubM(0).nuField();\n const volScalarField& rhoField = forceSubM(0).rhoField();\n\n // find min particle relaxation time\n scalar minTauP = 1e10;\n scalar minTauPAll = 1e10;\n scalar tauP = -1;\n scalar rad = -1;\n scalar scaledRad = -1.;\n\n // find min/max particle stokes Nr\n scalar St = -1;\n scalar minSt = 1e10;\n scalar minStAll = 1e10;\n scalar maxSt = -1;\n scalar maxStAll = -1;\n\n // max particle CFL Nr\n scalar maxVel = -1;\n scalar maxVelAll = -1;\n scalar minVel = 1e10;\n //scalar minVelAll = 1e10;\n\n // find max parcel diameter\n scalar maxDparcel = -1;\n scalar maxDparcelAll = -1;\n\n // find min cell vol\n scalar minVcell = 1e10;\n scalar minVcellAll = 1e10;\n\n // get info on scaleDrag being used.\n // we do not call getProperty in constructor to be independent of order of forceModels\n scalar scaleDrag=particleCloud_.registryM().getProperty(\"scaleDrag\");\n Info << \"checkCouplingInterval considers scaleDrag = \"<< scaleDrag << endl;\n\n for(int index = 0;index < particleCloud_.numberOfParticles(); index++)\n {\n label cellI = particleCloud_.cfdemCloud::cellIDs()[index][0];\n\n if (cellI > -1) // particle Found\n {\n rad = particleCloud_.radius(index);\n forceSubM(0).scaleDia(rad,index);\n tauP = rhoP_*4*scaledRad*scaledRad/\n (18 * nufField[cellI] * rhoField[cellI])/scaleDrag;\n minTauP = min(minTauP,tauP);\n\n maxDparcel = max(maxDparcel,2*particleCloud_.radius(index));\n\n minVcell = min(minVcell,particleCloud_.mesh().V()[cellI]);\n\n // StokesNr\n St = tauP*mag(U_[cellI]-particleCloud_.cfdemCloud::velocity(index))/(2*rad);\n minSt = min(minSt,St);\n maxSt = max(maxSt,St);\n\n maxVel = max(maxVel,mag(particleCloud_.cfdemCloud::velocity(index)));\n minVel = min(minVel,mag(particleCloud_.cfdemCloud::velocity(index)));\n }\n }\n\n // allreduce results\n MPI_Allreduce(&minTauP, &minTauPAll, 1, MPI_DOUBLE, MPI_MIN, MPI_COMM_WORLD);\n MPI_Allreduce(&minSt, &minStAll, 1, MPI_DOUBLE, MPI_MIN, MPI_COMM_WORLD);\n MPI_Allreduce(&maxSt, &maxStAll, 1, MPI_DOUBLE, MPI_MAX, MPI_COMM_WORLD);\n MPI_Allreduce(&maxDparcel, &maxDparcelAll, 1, MPI_DOUBLE, MPI_MAX, MPI_COMM_WORLD);\n MPI_Allreduce(&minVcell, &minVcellAll, 1, MPI_DOUBLE, MPI_MIN, MPI_COMM_WORLD);\n MPI_Allreduce(&maxVel, &maxVelAll, 1, MPI_DOUBLE, MPI_MAX, MPI_COMM_WORLD);\n //MPI_Allreduce(&minVel, &minVelAll, 1, MPI_DOUBLE, MPI_MIN, MPI_COMM_WORLD);\n\n // calc based on reduced results\n\n // calc max couplingTime/particle relaxation time ratio\n scalar DEMtime = particleCloud_.dataExchangeM().DEMts()\n *particleCloud_.dataExchangeM().couplingInterval();\n scalar accNr = DEMtime/minTauPAll;\n\n // calc min cell/parcel volume ratio\n scalar maxVparcelAll = maxDparcelAll*maxDparcelAll*maxDparcelAll*3.1416/6.0;\n scalar minVcellByVparcel = minVcellAll/maxVparcelAll;\n\n //particle CFL number\n scalar pCFL = maxVelAll*particleCloud_.dataExchangeM().couplingTime()/pow(minVcellAll,1./3.);\n\n if(accNr > maxAccNr_)\n {\n if(warnOnly_)\n Warning << \"The max. acceleration nr (coupling time / particle relaxation time) exceeds the maximum allowed value \" << maxAccNr_\n << \", and reached the value:\" << accNr\n << \"\\ncheck your settings.\" << endl;\n else\n FatalError << \"The max. acceleration nr (coupling time / particle relaxation time) exceeds the maximum allowed value \" << maxAccNr_\n << \", and reached the value:\" << accNr\n << \"\\nThe simulation is stopped, check your settings.\" << abort(FatalError);\n }\n else\n {\n Info << \"min. occurring particle relaxation time [s]: \" << minTauPAll << endl;\n Info << \"coupling interval [s]: \" << DEMtime << endl;\n Info << \"max. occurring acceleration nr (coupling time [s] / min. particle relaxation time [s]): \" << accNr << endl;\n }\n\n if(minVcellByVparcel < minAllowedVcellByVparcel_)\n {\n if(warnOnly_)\n Warning << \"The min. ratio of Vcell / Vparcel is below the minimum allowed value \" << minAllowedVcellByVparcel_\n << \", and reached the value: \" << minVcellByVparcel << \".\"\n << \"\\ncheck your settings.\" << endl;\n else\n FatalError << \"The min. ratio of Vcell / Vparcel is below the minimum allowed value \" << minAllowedVcellByVparcel_\n << \", and reached the value: \" << minVcellByVparcel\n << \"\\nThe simulation is stopped, check your settings.\" << abort(FatalError);\n }\n else if (minVcellByVparcel > largeVcellByVparcel_)\n {\n Warning << \"The ratio of Vcell / Vparcel is above the defined value of \" << largeVcellByVparcel_\n << \", and reached the value: \" << minVcellByVparcel << \".\"\n << \"\\nFor efficiency reasons the voidfraction model centre is recommended.\" << endl;\n }\n else\n Info << \"min. ratio of Vcell / Vparcel is \" << minVcellByVparcel << endl;\n\n Info << \"min./max. Stokes Nr: \" << minStAll << \" / \" << maxStAll << endl;\n\n if(pCFL > maxPCFL_)\n {\n if(warnOnly_)\n Warning << \"The max. particle coupling CFL number is aboce the maximum allowed value \" << maxPCFL_\n << \", and reached the value:\" << pCFL\n << \"\\ncheck your settings.\" << endl;\n else\n FatalError << \"The max. particle coupling CFL number is aboce the maximum allowed value \" << maxPCFL_\n << \", and reached the value:\" << pCFL\n << \"\\ncheck your settings.\" << abort(FatalError);\n }\n else\n Info << \"max. particle coupling CFL Nr: \" << pCFL << endl;\n\n /*//Set value fields and write the probe\n if(probeIt_)\n {\n #include \"setupProbeModelfields.H\"\n // Note: for other than ext one could use vValues.append(x)\n // instead of setSize\n sValues.setSize(sValues.size()+1, CFL);\n sValues.setSize(sValues.size()+1, CFLexpected);\n sValues.setSize(sValues.size()+1, minTauPAll);\n sValues.setSize(sValues.size()+1, minVcellByVparcel);\n sValues.setSize(sValues.size()+1, minStAll);\n sValues.setSize(sValues.size()+1, maxStAll);\n particleCloud_.probeM().writeProbe(0, sValues, vValues);\n }*/\n\n // look for patches of type empty -> 2d simulation\n bool empty_check = false;\n bool size_check = false;\n const polyBoundaryMesh& pbm = particleCloud_.mesh().boundaryMesh();\n forAll(pbm, i)\n {\n if ( pbm[i].type() == \"empty\" )\n {\n empty_check = true;\n break;\n }\n }\n\n // get domain size\n const faceList & ff = particleCloud_.mesh().faces();\n const pointField & pp = particleCloud_.mesh().points();\n scalar xDim, yDim, zDim;\n pointField pLocal;\n\n xDim = (Foam::max(particleCloud_.mesh().C() & vector(1,0,0)) -\n Foam::min(particleCloud_.mesh().C() & vector(1,0,0))).value();\n yDim = (Foam::max(particleCloud_.mesh().C() & vector(0,1,0)) -\n Foam::min(particleCloud_.mesh().C() & vector(0,1,0))).value();\n zDim = (Foam::max(particleCloud_.mesh().C() & vector(0,0,1)) -\n Foam::min(particleCloud_.mesh().C() & vector(0,0,1))).value();\n\n // if there is only one cell\n // -> smallest dim will be 0\n // -> correct by considering points\n const cell & cc = particleCloud_.mesh().cells()[0];\n labelList pLabels(cc.labels(ff));\n pLocal = pointField(pLabels.size(), vector::zero);\n\n forAll (pLabels, pointi)\n pLocal[pointi] = pp[pLabels[pointi]];\n\n if (xDim <= 1e-12)\n xDim = Foam::max(pLocal & vector(1,0,0)) - Foam::min(pLocal & vector(1,0,0));\n else if (yDim <= 1e-12)\n yDim = Foam::max(pLocal & vector(0,1,0)) - Foam::min(pLocal & vector(0,1,0));\n else if (zDim <= 1e-12)\n zDim = Foam::max(pLocal & vector(0,0,1)) - Foam::min(pLocal & vector(0,0,1));\n\n if (std::min({xDim, yDim, zDim}) >= 10*maxDparcel)\n size_check = true;\n\n if (empty_check && size_check)\n Warning << \"\\n You are running a 2d simulation with quite a large domain.\"\n << \"\\n Min domain size: \" << std::min({xDim, yDim, zDim})\n << \"\\n Particle diameter: \" << maxDparcel\n << \"\\n Is this intentional?\"\n << endl;\n\n // check ratio of smoothing length and average particle diameter\n if(particleCloud_.smoothingM().doSmoothing() && particleCloud_.dataExchangeM().couplingStep() == 1)\n {\n // calculate average particle diameter:\n double averageParticleDiameter = 0;\n for(int index = 0;index < particleCloud_.numberOfParticles(); index++)\n {\n averageParticleDiameter += particleCloud_.radius(index)*2;\n }\n if (particleCloud_.numberOfParticles() > 0)\n averageParticleDiameter /= particleCloud_.numberOfParticles();\n // get smoothing length\n double smoothingLength = particleCloud_.smoothingM().smoothingLength().value();\n Info << \"smoothingLength: \" << smoothingLength << endl;\n if (smoothingLength > averageParticleDiameter)\n {\n if(warnOnly_)\n Warning << \"Smoothing length is recommended to be lower than than average particle diameter (in this case: \"\n << averageParticleDiameter << \")\" << endl;\n else\n FatalError << \"Smoothing length is recommended to be lower than than average particle diameter (in this case: \"\n << averageParticleDiameter << \")\" << abort(FatalError);\n }\n }\n\n // check change of fluid velocity over particle path length\n volTensorField velGrad = fvc::grad(particleCloud_.mesh().lookupObject (\"U\"));\n\n scalar maxVelGradMag = -1;\n forAll(velGrad, i)\n {\n scalar velGradMag = mag(velGrad[i]);\n maxVelGradMag = max(velGradMag, maxVelGradMag);\n }\n\n scalar deltaFluidVel = maxVelGradMag * maxVelAll * particleCloud_.dataExchangeM().couplingTime();\n\n scalar deltaFluidVelAll= -1;\n MPI_Allreduce(&deltaFluidVel, &deltaFluidVelAll, 1,\n MPI_DOUBLE, MPI_MAX, MPI_COMM_WORLD);\n\n if (deltaFluidVelAll > maxRelVelChange_ * maxVelAll)\n {\n if (warnOnly_)\n Warning\n << \"\\n Change of fluid velocity over one coupling interval that\"\n << \"\\n one particle may experience is quite large: \"\n << \"\\n delta Uf / max(Vp) = \" << deltaFluidVelAll / maxVelAll\n << \"\\n The allowed maximum limit is set to \" << maxRelVelChange_\n << \"\\n Consider decreasing the coupling interval.\"\n << endl;\n else\n FatalError\n << \"\\n Change of fluid velocity over one coupling interval that\"\n << \"\\n one particle may experience is quite large: \"\n << \"\\n delta Uf / max(Vp) = \" << deltaFluidVelAll / maxVelAll\n << \"\\n The allowed maximum limit is set to \" << maxRelVelChange_\n << \"\\n Consider decreasing the coupling interval.\"\n << abort(FatalError);\n }\n\n // if mesh moves, make sure that turboEngine model is used\n if(particleCloud_.mesh().changing())\n {\n if ( particleCloud_.locateM().type() == \"engine\")\n {\n if(warnOnly_)\n Warning << \"For changing meshes use turboEngine type locate model - engine model might lead to loss of particles!!\" << endl;\n else\n FatalError << \"For changing meshes use turboEngine type locate model - engine model might lead to loss of particles!!\" << abort(FatalError);\n }\n }\n\n Info << \"========================================================================\" << endl;\n }\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/checkCouplingInterval/checkCouplingInterval.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n check the coupling interval,\n by comparing couplingTime/particle relaxation time\n\nClass\n checkCouplingInterval\n\nSourceFiles\n checkCouplingInterval.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef checkCouplingInterval_H\n#define checkCouplingInterval_H\n\n#include \"forceModel.H\"\n#include \"dataExchangeModel.H\"\n#include \n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class checkCouplingInterval Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass checkCouplingInterval\n:\n public forceModel\n{\nprivate:\n dictionary propsDict_;\n\n Switch warnOnly_;\n\n word velocityFieldName_;\n\n const volVectorField& U_;\n\n const scalar rhoP_;\n\n scalar maxCFL_;\n\n scalar maxPCFL_;\n\n scalar maxAccNr_;\n\n scalar maxRelVelChange_;\n\n scalar UmaxExpected_;\n\n scalar minAllowedVcellByVparcel_;\n\n scalar largeVcellByVparcel_;\n\n mutable int nextRun_;\n\n scalar timeInterval_;\n\n int couplingStepInterval_;\n\n inline bool doCheck() const;\n\npublic:\n\n //- Runtime type information\n TypeName(\"checkCouplingInterval\");\n\n\n // Constructors\n\n //- Construct from components\n checkCouplingInterval\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~checkCouplingInterval();\n\n\n // Member Functions\n void setForce() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/fieldStore/fieldStore.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"fieldStore.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \"dataExchangeModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(fieldStore, 0);\n\naddToRunTimeSelectionTable\n(\n forceModel,\n fieldStore,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nfieldStore::fieldStore\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n forceModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n mesh_(particleCloud_.mesh()),\n scalarFieldNames_(propsDict_.lookup(\"scalarFieldNames\")),\n vectorFieldNames_(propsDict_.lookup(\"vectorFieldNames\"))\n{\n // init force sub model\n setForceSubModels(propsDict_);\n\n // create time average scalar fields\n scalarFields_.setSize(scalarFieldNames_.size());\n\n for (int i=0;i < scalarFieldNames_.size(); i++)\n {\n word fieldName = \"stored_\" + scalarFieldNames_[i];\n\n Info<< \"Creating field \" << fieldName << endl;\n scalarFields_.set\n (\n i,\n new volScalarField\n (\n IOobject\n (\n fieldName,\n mesh_.time().timeName(),\n mesh_,\n IOobject::NO_READ,\n IOobject::AUTO_WRITE\n ),\n mesh_,\n dimensionedScalar(\"0\", mesh_.lookupObject(scalarFieldNames_[i]).dimensions(), 0)\n )\n );\n }\n\n // create time average vector fields\n vectorFields_.setSize(vectorFieldNames_.size());\n\n for (int i=0;i < vectorFieldNames_.size(); i++)\n {\n word fieldName = \"stored_\" + vectorFieldNames_[i];\n\n Info<< \"Creating field \" << fieldName << endl;\n vectorFields_.set\n (\n i,\n new volVectorField\n (\n IOobject\n (\n fieldName,\n mesh_.time().timeName(),\n mesh_,\n IOobject::NO_READ,\n IOobject::AUTO_WRITE\n ),\n mesh_,\n dimensionedVector(\"0\", mesh_.lookupObject(vectorFieldNames_[i]).dimensions(), vector::zero)\n )\n );\n }\n\n particleCloud_.checkCG(true);\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nfieldStore::~fieldStore()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nvoid fieldStore::setForce() const\n{\n if(particleCloud_.writeTimePassed())\n {\n if(particleCloud_.verbose()) Info << \"fieldStore.C - setForce()\" << endl;\n\n for (int i=0;i < scalarFieldNames_.size(); i++)\n {\n // get reference to actual field\n const volScalarField& field = mesh_.lookupObject(scalarFieldNames_[i]);\n\n // save field\n scalarFields_[i] = field;\n }\n\n for (int i=0;i < vectorFieldNames_.size(); i++)\n {\n // get reference to actual field\n const volVectorField& field = mesh_.lookupObject(vectorFieldNames_[i]);\n\n // save field\n vectorFields_[i] = field;\n }\n }\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/fieldStore/fieldStore.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n calc time average of scalar or vector field\n\nClass\n fieldStore\n\nSourceFiles\n fieldStore.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef fieldStore_H\n#define fieldStore_H\n\n#include \"forceModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class fieldStore Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass fieldStore\n:\n public forceModel\n{\nprivate:\n\n dictionary propsDict_;\n\n const fvMesh& mesh_;\n\n const wordList scalarFieldNames_;\n\n const wordList vectorFieldNames_;\n\n mutable PtrList scalarFields_;\n\n mutable PtrList vectorFields_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"fieldStore\");\n\n\n // Constructors\n\n //- Construct from components\n fieldStore\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~fieldStore();\n\n\n // Member Functions\n void setForce() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/fieldTimeAverage/fieldTimeAverage.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"fieldTimeAverage.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \"dataExchangeModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(fieldTimeAverage, 0);\n\naddToRunTimeSelectionTable\n(\n forceModel,\n fieldTimeAverage,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nfieldTimeAverage::fieldTimeAverage\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n forceModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n mesh_(particleCloud_.mesh())\n{\n init();\n particleCloud_.checkCG(true);\n}\n\n// Construct from components\nfieldTimeAverage::fieldTimeAverage\n(\n const dictionary& dict,\n const dictionary& mydict,\n const word& fieldPrefix,\n cfdemCloud& sm\n)\n:\n forceModel(dict,sm),\n propsDict_(mydict),\n mesh_(particleCloud_.mesh())\n{\n init(fieldPrefix);\n particleCloud_.checkCG(true);\n}\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nfieldTimeAverage::~fieldTimeAverage()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\nvoid fieldTimeAverage::init(word fieldPrefix)\n{\n startTime_=0.;\n scalarFieldNames_=wordList(propsDict_.lookup(\"scalarFieldNames\"));\n vectorFieldNames_=wordList(propsDict_.lookup(\"vectorFieldNames\"));\n nrAverages_=0.0;\n\n // create time average scalar fields\n scalarFields_.setSize(scalarFieldNames_.size());\n\n if (propsDict_.found(\"startTime\"))\n startTime_=readScalar(propsDict_.lookup(\"startTime\"));\n\n for (int i=0;i < scalarFieldNames_.size(); i++)\n {\n word fieldName = fieldPrefix + scalarFieldNames_[i];\n\n Info<< \"Creating field \" << fieldName << endl;\n scalarFields_.set\n (\n i,\n new volScalarField\n (\n IOobject\n (\n fieldName,\n mesh_.time().timeName(),\n mesh_,\n IOobject::READ_IF_PRESENT,\n IOobject::AUTO_WRITE\n ),\n mesh_,\n dimensionedScalar(\"0\", mesh_.lookupObject(scalarFieldNames_[i]).dimensions(), 0)\n )\n );\n }\n\n // create time average vector fields\n vectorFields_.setSize(vectorFieldNames_.size());\n\n for (int i=0;i < vectorFieldNames_.size(); i++)\n {\n word fieldName = fieldPrefix + vectorFieldNames_[i];\n\n Info<< \"Creating field \" << fieldName << endl;\n vectorFields_.set\n (\n i,\n new volVectorField\n (\n IOobject\n (\n fieldName,\n mesh_.time().timeName(),\n mesh_,\n IOobject::READ_IF_PRESENT,\n IOobject::AUTO_WRITE\n ),\n mesh_,\n dimensionedVector(\"0\", mesh_.lookupObject(vectorFieldNames_[i]).dimensions(), vector::zero)\n )\n );\n }\n}\n\nvoid fieldTimeAverage::setForce() const\n{\n if(mesh_.time().value() >= startTime_)\n {\n if(particleCloud_.verbose()) Info << \"fieldTimeAverage.C - setForce()\" << endl;\n\n for (int i=0;i < scalarFieldNames_.size(); i++)\n {\n // get reference to actual field\n const volScalarField& field = mesh_.lookupObject(scalarFieldNames_[i]);\n averaging(field,i,nrAverages_);\n }\n\n for (int i=0;i < vectorFieldNames_.size(); i++)\n {\n // get reference to actual field\n const volVectorField& field = mesh_.lookupObject(vectorFieldNames_[i]);\n averaging(field,i,nrAverages_);\n }\n nrAverages_++;\n }// end if time >= startTime_\n}\n\nvoid fieldTimeAverage::averaging(const volScalarField& field,int& i,double& nrAverages_) const\n{\n // first entry in this field\n if(nrAverages_ == 0)\n scalarFields_[i] = field;\n else\n scalarFields_[i] = (scalarFields_[i]*nrAverages_+field*1)/(nrAverages_+1);\n}\n\nvoid fieldTimeAverage::averaging(const volVectorField& field,int& i,double& nrAverages_) const\n{\n // first entry in this field\n if(nrAverages_ == 0)\n vectorFields_[i] = field;\n else\n vectorFields_[i] = (vectorFields_[i]*nrAverages_+field*1)/(nrAverages_+1);\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/fieldTimeAverage/fieldTimeAverage.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n calc time average of scalar or vector field\n\nClass\n fieldTimeAverage\n\nSourceFiles\n fieldTimeAverage.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef fieldTimeAverage_H\n#define fieldTimeAverage_H\n\n#include \"forceModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class fieldTimeAverage Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass fieldTimeAverage\n:\n public forceModel\n{\nprotected:\n\n dictionary propsDict_;\n\n const fvMesh& mesh_;\n\n scalar startTime_;\n\n wordList scalarFieldNames_;\n\n wordList vectorFieldNames_;\n\n mutable PtrList scalarFields_;\n\n mutable PtrList vectorFields_;\n\n mutable double nrAverages_;\n\n void init(word fieldPrefix = word(\"timeAverage_\"));\n\npublic:\n\n //- Runtime type information\n TypeName(\"fieldTimeAverage\");\n\n\n // Constructors\n\n //- Construct from components\n fieldTimeAverage\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n //- Construct from components\n fieldTimeAverage\n (\n const dictionary& dict,\n const dictionary& mydict,\n const word& fieldPrefix,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~fieldTimeAverage();\n\n\n // Member Functions\n void setForce() const;\n\n virtual inline void averaging(const volScalarField&,int&,double&) const;\n\n virtual inline void averaging(const volVectorField&,int&,double&) const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/forceModel/forceModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n#include \"forceModel.H\"\n#include \"mathExtra.H\"\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(forceModel, 0);\n\ndefineRunTimeSelectionTable(forceModel, dictionary);\n\n// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nforceModel::forceModel\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n dict_(dict),\n particleCloud_(sm),\n //treatExplicit_(false),\n //treatDEM_(false),\n //implDEM_(false),\n impParticleForces_\n ( IOobject\n (\n \"impParticleForces\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::READ_IF_PRESENT,\n IOobject::AUTO_WRITE\n ),\n sm.mesh(),\n dimensionedVector(\"zero\", dimensionSet(1,1,-2,0,0), vector(0,0,0)) // N\n ),\n expParticleForces_\n ( IOobject\n (\n \"expParticleForces\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::READ_IF_PRESENT,\n IOobject::AUTO_WRITE\n ),\n sm.mesh(),\n dimensionedVector(\"zero\", dimensionSet(1,1,-2,0,0), vector(0,0,0)) // N\n ),\n modelType_(sm.modelType()),\n probeIt_(sm.probeM().active()),\n particleBased_(dict.lookupOrDefault(\"particleBased\", false)),\n forceSubModels_(0),\n forceSubModel_(new autoPtr[nrForceSubModels()]),\n voidfractionInterpolator_(NULL),\n UInterpolator_(NULL),\n vorticityInterpolator_(NULL),\n gradPInterpolator_(NULL),\n gradUInterpolator_(NULL),\n gradVoidfractionInterpolator_(NULL),\n Up1Interpolator_(NULL),\n Up2Interpolator_(NULL),\n dSauterInterpolator_(NULL),\n phiP1Interpolator_(NULL),\n phiP2Interpolator_(NULL),\n alphaInterpolator_(NULL),\n gradAlphaInterpolator_(NULL),\n TInterpolator_(NULL),\n UsInterpolator_(NULL),\n fluidScalarFieldInterpolator_(NULL),\n gradPsolidInterpolator_(NULL),\n shearRateInterpolator_(NULL),\n DDtUInterpolator_(NULL),\n divTauInterpolator_(NULL),\n RhoInterpolator_(NULL),\n kInterpolator_(NULL),\n epsilonInterpolator_(NULL)\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nforceModel::~forceModel()\n{}\n\n// * * * * * * * * * * * * * * * * Member Fct * * * * * * * * * * * * * * * //\n\nvoid Foam::forceModel::applyDebugSettings(bool debug) const\n{\n if(!debug)\n {\n impParticleForces_.writeOpt() = IOobject::NO_WRITE;\n expParticleForces_.writeOpt() = IOobject::NO_WRITE;\n }\n}\n\n//Function for to add turbulence due to multiphase interaction\nvoid forceModel::multiphaseTurbulence(volScalarField& field, bool) const\n{\n // just return zero\n field *= 0.0;\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nvoid forceModel::repartitionImExForces() const\n{\n if(particleCloud_.imExSplitFactor()<1.0)\n {\n Info << \"Will re-partition split of implicit and explicit forces: alpha = \"\n << particleCloud_.imExSplitFactor() << endl;\n // Update implicit particle\n expParticleForces_ += (1.0-particleCloud_.imExSplitFactor())*impParticleForces_;\n impParticleForces_ *= particleCloud_.imExSplitFactor();\n }\n}\n\nvoid forceModel::treatVoidCells() const\n{\n //force coupling force in cells where there are no particles to be explicit force\n if(particleCloud_.treatVoidCellsAsExplicitForce())\n {\n int counter(0);\n volVectorField& Us = particleCloud_.averagingM().UsNext();\n forAll(Us,cellI)\n {\n if ( mag(Us[cellI]) == 0.0) // cell is void of particles\n {\n expParticleForces_[cellI] += impParticleForces_[cellI];\n impParticleForces_[cellI] *= 0.0;\n counter +=1;\n }\n }\n Info << \"Re-partitioned \"<< counter << \" cells void of particles\" << endl;\n }\n}\n\nvoid forceModel::setForceSubModels(dictionary& dict)\n{\n if (dict.found(\"forceSubModels\"))\n {\n forceSubModels_ = wordList(dict.lookup(\"forceSubModels\"));\n if(forceSubModels_.size()==0) // empty list found\n {\n Info << \" Found empty list of forceSubModels - setting to default forceSubModel ImEx\" << endl;\n forceSubModels_.setSize(1, \"ImEx\");\n }\n else\n {\n // check if an ImEx model is there\n bool foundImEx=false;\n forAll(forceSubModels_,i)\n {\n if(forceSubModels_[i]==\"ImEx\" || forceSubModels_[i]==\"ImExCorr\" || forceSubModels_[i]==\"ImExDipole\" || forceSubModels_[i]==\"ImExFibre\") foundImEx=true;\n }\n\n if(!foundImEx) // add ImEx if none found\n {\n Info << \" Adding the default forceSubModel ImEx on top of your selection (as first model).\" << endl;\n wordList h(0);\n h.setSize(1, \"ImEx\");\n h.append(forceSubModels_);\n forceSubModels_=h;\n }\n\n if(forceSubModels_.size()>1)\n {\n Warning << \" You are using more than one forceSubModel: \"\n << forceSubModels_ <<\"Make sure all operations can be superposed.\\n\" << endl;\n }\n }\n }\n else if (dict.found(\"forceSubModel\"))\n {\n FatalError << \"Did you mean the forceSubModels keyword? \" << abort(FatalError);\n }\n else // use ImEx as default forceSubModel if nothing is specifed\n {\n Info << \" No forceSubModel specified - setting to default forceSubModel ImEx.\" << endl;\n forceSubModels_.setSize(1, \"ImEx\");\n }\n\n delete[] forceSubModel_;\n forceSubModel_ = new autoPtr[nrForceSubModels()];\n for (int i=0;i 0 && forceSubM(0).getCG()>1)\n {\n Warning << \"\\n\\n==============================================================================\\n\"\n << \" ! ! ! W A R N I N G ! ! !\\n\"\n << \" You specified area and coarse graining is active - take care you specify\\n\"\n << \" area for the coarse grained particles!\\n\" \n << \" ! ! ! W A R N I N G ! ! !\\n\"\n << \"==============================================================================\\n\\n\" << endl;\n }\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/forceModel/forceModel.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n forceModel\n\nSourceFiles\n forceModel.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef forceModel_H\n#define forceModel_H\n\n#include \"fvCFD.H\"\n#include \"cfdemCloud.H\"\n#include \"probeModel.H\"\n#include \"forceSubModel.H\"\n#include \"interpolationCellPointFace.H\"\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class forceModel Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass forceModel\n{\n\nprotected:\n\n // Protected data\n const dictionary& dict_;\n\n cfdemCloud& particleCloud_;\n\n //Switch treatExplicit_; // marker to treat force in implicit way (otherwise explicit)\n //Switch treatDEM_; // marker to use the force only on DEM side\n //Switch implDEM_; // marker to use the implicit force on DEM side\n\n mutable volVectorField impParticleForces_; // sum of implicit particle forces [N]\n\n mutable volVectorField expParticleForces_; // sum of explicit particle forces [N]\n\n const word modelType_;\n\n bool probeIt_;\n\n bool particleBased_;\n\n wordList forceSubModels_;\n\n autoPtr* forceSubModel_;\n\n mutable autoPtr > GInterpolator_;\n\n mutable autoPtr > voidfractionInterpolator_;\n\n mutable autoPtr > UInterpolator_;\n\n mutable autoPtr > vorticityInterpolator_;\n\n mutable autoPtr > gradPInterpolator_;\n\n mutable autoPtr > gradUInterpolator_;\n\n mutable autoPtr > gradVoidfractionInterpolator_;\n\n mutable autoPtr > Up1Interpolator_;\n\n mutable autoPtr > Up2Interpolator_;\n\n mutable autoPtr > dSauterInterpolator_;\n\n mutable autoPtr > phiP1Interpolator_;\n\n mutable autoPtr > phiP2Interpolator_;\n\n mutable autoPtr > alphaInterpolator_;\n\n mutable autoPtr > gradAlphaInterpolator_;\n\n mutable autoPtr > TInterpolator_;\n\n mutable autoPtr > UsInterpolator_;\n\n mutable autoPtr > fluidScalarFieldInterpolator_;\n\n mutable autoPtr > gradPsolidInterpolator_;\n\n mutable autoPtr > shearRateInterpolator_;\n\n mutable autoPtr > DDtUInterpolator_;\n\n mutable autoPtr > divTauInterpolator_;\n\n mutable autoPtr > RhoInterpolator_;\n\n mutable autoPtr > kInterpolator_;\n\n mutable autoPtr > epsilonInterpolator_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"forceModel\");\n\n // Declare runtime constructor selection table\n\n declareRunTimeSelectionTable\n (\n autoPtr,\n forceModel,\n dictionary,\n (\n const dictionary& dict,\n cfdemCloud& sm\n ),\n (dict,sm)\n );\n\n\n // Constructors\n\n //- Construct from components\n forceModel\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n\n // Destructor\n\n virtual ~forceModel();\n\n\n // Selector\n\n static autoPtr New\n (\n const dictionary& dict,\n cfdemCloud& sm,\n word forceType\n );\n\n\n // Member Functions\n\n void applyDebugSettings(bool) const;\n\n virtual void setForce() const = 0;\n\n virtual void multiphaseTurbulence(volScalarField&, bool) const;\n\n //tmp provideScalarField();\n\n // Access\n word modelType(){ return modelType_; };\n\n bool modelIsParticleBased() {return particleBased_;};\n\n inline volVectorField& impParticleForces() const { return impParticleForces_;};\n\n inline volVectorField& expParticleForces() const { return expParticleForces_;};\n\n// virtual inline double ** impForces() const { return particleCloud_.impForces_;};\n//\n// virtual inline double ** expForces() const { return particleCloud_.expForces_;};\n\n inline double ** omegaFluid() const { return particleCloud_.omegaFluid();};\n\n virtual inline bool requiresQuaternion() { return forceSubM(0).useQuat();};\n\n virtual inline bool requiresSuperquadric() { return forceSubM(0).sq();};\n\n void repartitionImExForces() const; //Repartition Implixit/Explicit forces\n\n void treatVoidCells() const;\n\n inline const wordList& forceSubModels(){ return forceSubModels_; };\n\n inline const forceSubModel& forceSubM(int i) const { return forceSubModel_[i]; };\n\n inline int nrForceSubModels() const { return forceSubModels_.size(); };\n\n void setForceSubModels(dictionary& dict);\n\n // MS member funtions\n void readDHcorr(dictionary& dict);\n\n void readArea(dictionary& dict);\n\n virtual void MSinit() {}; // extra init function for MS stuff\n\n // MS access\n virtual inline double ** impForces() const\n {\n if (forceSubM(0).ms())\n return particleCloud_.impForcesCM();\n else\n return particleCloud_.impForces();\n };\n\n virtual inline double ** expForces() const\n {\n if (forceSubM(0).ms())\n return particleCloud_.expForcesCM();\n else\n return particleCloud_.expForces();\n };\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/forceModel/newForceModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"forceModel.H\"\n#include \"DiFeliceDrag.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\nautoPtr forceModel::New\n(\n const dictionary& dict,\n cfdemCloud& sm,\n word forceType\n)\n{\n Info<< \"Selecting forceModel \"\n << forceType << endl;\n\n dictionaryConstructorTable::iterator cstrIter =\n dictionaryConstructorTablePtr_->find(forceType);\n\n if (cstrIter == dictionaryConstructorTablePtr_->end())\n {\n FatalError\n << \"forceModel::New(const dictionary&, const spray&) : \"\n << endl\n << \" unknown forceModelType type \"\n << forceType\n << \", constructor not in hash table\" << endl << endl\n << \" Valid forceModel types are :\"\n << endl;\n Info<< dictionaryConstructorTablePtr_->toc()\n << abort(FatalError);\n }\n\n return autoPtr(cstrIter()(dict,sm));\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/forceSubModels/ImEx/ImEx.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"ImEx.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(ImEx, 0);\n\naddToRunTimeSelectionTable\n(\n forceSubModel,\n ImEx,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nImEx::ImEx\n(\n const dictionary& dict,\n cfdemCloud& sm,\n forceModel& fm\n)\n:\n forceSubModel(dict,sm,fm)\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nImEx::~ImEx()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nvoid ImEx::calcXi(const scalar& ds, const scalar& voidfraction, const scalar& magUr, const scalar& nuf, scalar& Xi ) const\n{\n forceSubModel::calcXi(ds,voidfraction,magUr,nuf,Xi);\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/forceSubModels/ImEx/ImEx.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n ImEx\n\nSourceFiles\n ImEx.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef ImEx_H\n#define ImEx_H\n\n#include \"forceSubModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class ImEx Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass ImEx\n:\n public forceSubModel\n{\nprivate:\n\n\npublic:\n\n //- Runtime type information\n TypeName(\"ImEx\");\n\n\n // Constructors\n\n //- Construct from components\n ImEx\n (\n const dictionary& dict,\n cfdemCloud& sm,\n forceModel& fm\n );\n\n // Destructor\n\n ~ImEx();\n\n\n // Member Functions\n\n word myType() const{return typeName; };\n\n void calcXi(const scalar& ds, const scalar& voidfaction, const scalar& magUr, const scalar& nuf, scalar& Xi ) const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/forceSubModels/forceSubModel/forceSubModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n#include \"forceSubModel.H\"\n#include \"forceModel.H\"\n#include \"mathExtra.H\"\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(forceSubModel, 0);\n\ndefineRunTimeSelectionTable(forceSubModel, dictionary);\n\n// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nforceSubModel::forceSubModel\n(\n const dictionary& dict,\n cfdemCloud& sm,\n forceModel& fm\n)\n:\n dict_(dict),\n particleCloud_(sm),\n forceModel_(fm),\n nrDefaultSwitches_(34), // !!!\n switchesNameList_(wordList(nrDefaultSwitches_)),\n switchesList_(List(nrDefaultSwitches_)),\n switches_(List(nrDefaultSwitches_)),\n nu_\n (\n IOobject\n (\n \"scalarViscosity\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n sm.mesh(),\n dimensionedScalar(\"nu0\", dimensionSet(0, 2, -1, 0, 0), 1.)\n ),\n /*mu_\n (\n IOobject\n (\n \"scalarViscosity\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n sm.mesh(),\n dimensionedScalar(\"mu0\", dimensionSet(1, -1, -1, 0, 0), 1.)\n ),*/\n divTau_\n (\n IOobject\n (\n \"divTau\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n sm.mesh(),\n dimensionedVector(\"divTau\", dimensionSet(1, -2, -2, 0, 0), vector::zero)\n ),\n IBDragPerV_\n (\n IOobject\n (\n \"IBDragPerV\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n sm.mesh(),\n dimensionedVector(\"IBDragPerV\", dimensionSet(1, -2, -2, 0, 0), vector::zero)\n ),\n densityFieldName_(dict_.lookupOrDefault(\"densityFieldName\",\"rho\")),\n rho_(sm.mesh().lookupObject (densityFieldName_)),\n verboseDiskIntervall_(1),\n verboseDiskCounter_(0),\n cg_(dict_.lookupOrDefault(\"scale\",1.)),\n scaleDrag_(dict_.lookupOrDefault(\"scaleDrag\",1.)),\n scaleDragLocal_(dict_.lookupOrDefault(\"scaleDragLocal\",1.)),\n scaleTorque_(dict_.lookupOrDefault(\"scaleTorque\",1.)),\n scaleDH_(dict_.lookupOrDefault(\"scaleDH\",1.))\n{\n // init standard switch list\n int iCounter(0);\n switchesNameList_[iCounter]=\"treatForceExplicit\"; iCounter++; //0 - will treat force explicity (based on slip velocity)\n switchesNameList_[iCounter]=\"treatForceDEM\";iCounter++; //1 - will treat forces on DEM side only\n switchesNameList_[iCounter]=\"implForceDEM\";iCounter++; //2\n switchesNameList_[iCounter]=\"verbose\";iCounter++; //3\n switchesNameList_[iCounter]=\"interpolation\";iCounter++; //4\n switchesNameList_[iCounter]=\"useFilteredDragModel\";iCounter++; //5\n switchesNameList_[iCounter]=\"useParcelSizeDependentFilteredDrag\";iCounter++; //6\n switchesNameList_[iCounter]=\"implForceDEMaccumulated\";iCounter++; //7\n switchesNameList_[iCounter]=\"scalarViscosity\";iCounter++; //8\n switchesNameList_[iCounter]=\"verboseToDisk\";iCounter++; //9\n switchesNameList_[iCounter]=\"useCorrectedVoidage\";iCounter++; //10\n switchesNameList_[iCounter]=\"multisphere\";iCounter++; //11\n switchesNameList_[iCounter]=\"useTorque\";iCounter++; //12\n switchesNameList_[iCounter]=\"anisotropicDrag\";iCounter++; //13\n switchesNameList_[iCounter]=\"pullRotation\";iCounter++; //14\n switchesNameList_[iCounter]=\"pullOrientation\";iCounter++; //15\n switchesNameList_[iCounter]=\"pullShape\";iCounter++; //16\n switchesNameList_[iCounter]=\"voidageFunctionDiFelice\";iCounter++; //17\n switchesNameList_[iCounter]=\"voidageFunctionRong\";iCounter++; //18\n switchesNameList_[iCounter]=\"useUf\";iCounter++; //19\n switchesNameList_[iCounter]=\"useFhydro\";iCounter++; //20\n switchesNameList_[iCounter]=\"implTorqueDEM\";iCounter++; //21\n switchesNameList_[iCounter]=\"useVisc\";iCounter++; //22\n switchesNameList_[iCounter]=\"voidageFunctionTang\";iCounter++; //23\n switchesNameList_[iCounter]=\"useMpData\";iCounter++; //24\n switchesNameList_[iCounter]=\"superquadric\";iCounter++; //25\n switchesNameList_[iCounter]=\"useQuaternion\";iCounter++; //26\n switchesNameList_[iCounter]=\"pushTurbulence\";iCounter++; //27\n switchesNameList_[iCounter]=\"particleSpecificCG\";iCounter++; //28\n switchesNameList_[iCounter]=\"convex\";iCounter++; //29\n switchesNameList_[iCounter]=\"pullType\";iCounter++; //30\n switchesNameList_[iCounter]=\"pullDensity\";iCounter++; //31\n switchesNameList_[iCounter]=\"pushConvectiveHeatFlux\";iCounter++; //32\n switchesNameList_[iCounter]=\"pullTemp\";iCounter++; //33\n\n // should be done by default\n //for(int i=0;i 0 required\" << abort(FatalError);\n\n particleCloud_.registryM().addProperty(\"scaleDrag\",scaleDrag_);\n\n // info about scaleDrag being used\n if (scaleDragLocal_ != 1.)\n Info << \"using scaleDragLocal = \" << scaleDragLocal_ << endl;\n\n if (scaleDragLocal_ < SMALL)\n FatalError<< \"scaleDragLocal > 0 required\" << abort(FatalError);\n\n // info about scaleTorque being used\n if (scaleTorque_ != 1.)\n Info << \"using scaleTorque = \" << scaleTorque_ << endl;\n\n if (scaleTorque_ < SMALL)\n FatalError<< \"scaleTorque > 0 required\" << abort(FatalError);\n\n // info about scaleDH being used\n if (scaleDH_ != 1)\n Info << \"using scaleDH = \" << scaleDH_ << endl;\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nforceSubModel::~forceSubModel()\n{}\n\n// * * * * * * * * * * * * * * * * Member Fct * * * * * * * * * * * * * * * //\nvoid forceSubModel::partToArray\n(\n const label& index,\n const vector& dragTot,\n const vector& dragEx,\n const vector& Ufluid,\n scalar Cd,\n const vector& CdExtra\n) const\n{\n // forces for CFD\n if(!treatForceDEM())\n {\n if(treatForceExplicit())\n {\n for(int j=0;j<3;j++)\n myForceM().expForces()[index][j] += dragTot[j];\n }\n else //implicit treatment, taking explicit force contribution into account\n {\n for(int j=0;j<3;j++)\n {\n myForceM().impForces()[index][j] += dragTot[j] - dragEx[j];\n myForceM().expForces()[index][j] += dragEx[j];\n }\n }\n }\n\n // forces for DEM\n if(implForceDEM())\n {\n if(ms())\n {\n for(int j=0;j<3;j++)\n particleCloud_.fieldsToDEM[particleCloud_.idUfCM()][index][j] = Ufluid[j];\n\n if(anisotropicDrag())\n {\n for(int j=0;j<3;j++)\n particleCloud_.fieldsToDEM[particleCloud_.idKslExtraCM()][index][j] = CdExtra[j];\n\n for(int j=0;j<3;j++)\n particleCloud_.fieldsToDEM[particleCloud_.idDragExpCM()][index][j] += dragEx[j];\n }\n else\n particleCloud_.fieldsToDEM[particleCloud_.idKslCM()][index][0] = Cd;\n }\n else\n {\n for(int j=0;j<3;j++)\n particleCloud_.fieldsToDEM[particleCloud_.idUf()][index][j] = Ufluid[j];\n\n if(anisotropicDrag())\n {\n for(int j=0;j<3;j++)\n particleCloud_.fieldsToDEM[particleCloud_.idKslExtra()][index][j] = CdExtra[j];\n\n for(int j=0;j<3;j++)\n particleCloud_.fieldsToDEM[particleCloud_.idDragExp()][index][j] += dragEx[j];\n }\n else\n particleCloud_.fieldsToDEM[particleCloud_.idKsl()][index][0] = Cd;\n }\n }\n else\n {\n if(ms())\n {\n for(int j=0;j<3;j++)\n particleCloud_.fieldsToDEM[particleCloud_.idDragExpCM()][index][j] += dragTot[j];\n }\n else\n {\n for(int j=0;j<3;j++)\n particleCloud_.fieldsToDEM[particleCloud_.idDragExp()][index][j] += dragTot[j];\n }\n }\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\nvoid forceSubModel::partToArrayAnisotropicTorque\n(\n const label& index,\n const vector& CdTorque,\n const vector& torqueTotal //this is the total torque\n) const\n{\n\n if(useTorque())\n {\n if(implTorqueDEM())\n {\n if(ms())\n {\n for(int iDir=0;iDir<3;iDir++)\n {\n particleCloud_.fieldsToDEM[particleCloud_.idKslRotationCM()][index][iDir] = CdTorque[iDir];\n particleCloud_.fieldsToDEM[particleCloud_.idTorqueExpCM()][index][iDir] += torqueTotal[iDir];\n }\n /*if(verbose()) Pout << \"*********forceSubModel::partToArrayAnisotropic: CdTorque: \"\n << CdTorque\n << \", torqueTotal: \" << torqueTotal << endl;*/\n }\n else\n {\n for(int iDir=0;iDir<3;iDir++)\n {\n particleCloud_.fieldsToDEM[particleCloud_.idKslRotation()][index][iDir] = CdTorque[iDir];\n particleCloud_.fieldsToDEM[particleCloud_.idTorqueExp()][index][iDir] += torqueTotal[iDir];\n }\n }\n }\n else\n {\n for(int iDir=0;iDir<3;iDir++)\n particleCloud_.fieldsToDEM[particleCloud_.idTorqueExpCM()][index][iDir] += torqueTotal[iDir];\n }\n\n }\n else\n {\n if(index==0) Info << \"forceSubModel::partToArrayAnisotropicTorque, useTorque=false\" << endl;\n }\n\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\nvoid forceSubModel::explicitCorr\n(\n vector& dragImplicit,\n vector& dragExplicit,\n scalar& dragCoefficient,\n vector& Ufluid,\n const vector& Ucell,\n vector& Us,\n const vector& UsCell,\n bool verbose,\n label index\n) const\n{\n dragExplicit=vector::zero;\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\nvoid forceSubModel::explicitCorrScalar(scalar& sourceKImplicit,\n scalar& sourceExplicit,\n scalar& areaTimesTransferCoefficient,\n scalar& fluidProperty,\n const scalar& fluidPropertyCell,\n scalar& particleProperty,\n bool verbose,\n label index) const\n{\n\n //everything is explicit, no verbose\n sourceExplicit = areaTimesTransferCoefficient * (fluidProperty - particleProperty);\n sourceKImplicit = 0.0;\n\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\nvoid forceSubModel::update( label particleI,\n label cellI,\n scalar& d,\n scalar& scalToUpdate1,\n scalar& scalToUpdate2,\n bool verbose\n ) const\n{\n //no action\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\nvoid forceSubModel::update( label particleI,\n label cellI,\n scalar& d,\n vector& vecToUpdate1,\n vector& vecToUpdate2,\n scalar& scalToUpdate1,\n scalar& scalToUpdate2,\n bool verbose\n ) const\n{\n //no action\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\nvoid forceSubModel::scaleDia(scalar& d, int index) const\n{\n if (particleCG() || particleCloud_.cgTypeSpecificDifferent_)\n d /= particleCloud_.cg(index) / scaleDH_;\n else\n d /= cg_ / scaleDH_;\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\nvoid forceSubModel::scaleForce(vector& force, scalar& d, int index) const\n{\n if (particleCG() || particleCloud_.cgTypeSpecificDifferent_)\n force *= getCG(index)*getCG(index)*getCG(index);\n else\n force *= cg_*cg_*cg_;\n\n force *= scaleDrag_;\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\nvoid forceSubModel::scaleCoeff(scalar& coeff, scalar& d, scalar& Rep, int index) const\n{\n if (particleCG() || particleCloud_.cgTypeSpecificDifferent_)\n coeff *= getCG(index)*getCG(index)*getCG(index);\n else\n coeff *= cg_*cg_*cg_;\n\n coeff *= scaleDrag_;\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\nvoid forceSubModel::scaleForceLocal(vector& force) const\n{\n force *= scaleDragLocal_;\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\nvoid forceSubModel::scaleTorque(vector& torque) const\n{\n torque *= scaleTorque_;\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\nconst scalar forceSubModel::scaleDrag(int index) const\n{\n return particleCloud_.cg(index);\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\nvoid forceSubModel::explicitLimit\n(\n vector& dragImplicit,\n vector& dragExplicit,\n scalar& d\n) const\n{\n dragExplicit=vector::zero;\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nvoid forceSubModel::readSwitches() const\n{\n bool first(true);\n forAll(switchesNameList_,i)\n {\n if(switchesList_[i] > 0+SMALL) //check if switch is read from dict\n {\n if(first)\n {\n Info << \" reading switches:\" << endl;\n first = false;\n }\n Info << \" looking for \" << switchesNameList_[i] << \" ... \";\n if (dict_.found(switchesNameList_[i]))\n {\n Info << \" found in dict. \" ;\n switches_[i]=Switch(dict_.lookup(switchesNameList_[i]));\n }else\n {\n Info << \" not found in dict, using default. \" ;\n if(i==2) Warning << \"\\n You are using the default value for 'implForceDEM' - beware that in CFDEMcoupling versions newer than 3.8.0 this default value has changed from (previously) false to (now) true!\" << endl;\n }\n\n // user set treatForceExplicit to true && no explicitCouple model is defined && treatForceDEM=false(i.e. it will go to f) && modelType != \"none\"\n if(i==0 && switches_[0] > 0+SMALL && particleCloud_.registryM().getProperty(\"explicitCouple_index\") < 0 && switches_[1] < 0+SMALL && particleCloud_.modelType() != \"none\")\n FatalError << \"You are using treatForceExplicit=true here, this requres having an explicit momentum couple model!\" << abort(FatalError);\n else\n Info << switchesNameList_[i] << \" = \" << switches_[i] << endl;\n }\n }\n Info << endl;\n\n /*// sanity check\n if(switchesList_[0] < 0+SMALL) //check if switch is not read from dict\n {\n // (treatForceExplicit is set to true) && no explicitCouple model is defined && treatForceDEM=false\n if(switches_[0] > 0+SMALL && particleCloud_.registryM().getProperty(\"explicitCouple_index\") < 0 && switches_[1] < 0+SMALL)\n FatalError << \"treatForceExplicit = true. This requres having an explicit momentum couple model!\" << abort(FatalError);\n }\n\n\n // debug info\n Info << \"other switches for forceSubModel which are auot-set:\" << myType() << endl;\n forAll(switchesNameList_,i)\n {\n if(switchesList_[i] < 0+SMALL) //check if switch is NOT read from dict but exists\n {\n Info << \"\\t\" << switchesNameList_[i] << \" = \" << switches_[i] << endl;\n }\n }\n Info << endl;*/\n\n if(implForceDEM()) // implForceDEM=true\n {\n // communicate implForceDEM to particleCloud\n particleCloud_.impDEMdrag_=true;\n\n // do sanity check\n // This can work if the accumulator is used, but is explicitely applied on the CFD side\n // Sanity check is therefore not necessary here\n /*\n if(switches_[0]) // treatExplicit=true\n {\n FatalError << \"Please check your settings, treatExplicit together with implForceDEM does not work!.\"\n << abort(FatalError);\n }\n */\n }\n\n if(switches_[7]) // implForceDEMaccumulated=true\n {\n // sanity check for implForceDEMaccumulated\n if(!switches_[2]) //implForceDEM=false\n {\n Warning<< \"please check your settings, implForceDEMaccumulated without implForceDEM does not work! (using implForceDEMaccumulated=false)\" << endl;\n switches_[3]=false;\n }else\n {\n particleCloud_.impDEMdragAcc_=true;\n }\n }\n\n if(switches_[8]) // scalarViscosity=true\n {\n Info << \"Using a constant viscosity for this force model.\" << endl;\n dimensionedScalar nu0_(\"nu\", dimensionSet(0, 2, -1, 0, 0), dict_.lookup(\"nu\"));\n nu_=volScalarField\n (\n IOobject\n (\n \"scalarViscosity\",\n particleCloud_.mesh().time().timeName(),\n particleCloud_.mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n particleCloud_.mesh(),\n nu0_\n );\n\n /*if (dict_.found(\"mu\"))\n {\n Info << \"Using a constant viscosity for this force model.\" << endl;\n dimensionedScalar mu0_(\"mu\", dimensionSet(1, -1, -1, 0, 0), dict_.lookup(\"mu\"));\n mu_=volScalarField\n (\n IOobject\n (\n \"scalarViscosity\",\n particleCloud_.mesh().time().timeName(),\n particleCloud_.mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n particleCloud_.mesh(),\n mu0_\n );\n }*/\n }\n\n if(anisotropicDrag() && !implForceDEM())\n FatalError<< \"You have set 'implForceDEM' to false, but 'anisotropicDrag' to true.\"<< abort (FatalError);\n\n // read extra variables\n dict_.readIfPresent(\"verboseDiskIntervall\", verboseDiskIntervall_);\n\n // look for old nomenclature\n if (dict_.found(\"treatExplicit\") || dict_.found(\"treatDEM\") || dict_.found(\"implDEM\"))\n FatalError<< \"You are using an old nomenclature for force model settings, please have a look at the forceSubModel doc.\" << abort(FatalError);\n\n // look for old nomenclature\n if (dict_.found(\"verbose\"))\n Warning<< \"Please make sure you use the new nomenclature for verbose force model settings, please have a look at the forceSubModel doc.\" << endl;\n}\n\nvoid forceSubModel::setupCommunication() const\n{\n particleCloud_.registerFieldsToDEM(\"radius\",\"scalar-atom\",particleCloud_.idRadius(),true);\n particleCloud_.registerFieldsToDEM(\"x\",\"vector-atom\",particleCloud_.idPos(),true);\n particleCloud_.registerFieldsToDEM(\"v\",\"vector-atom\",particleCloud_.idVel(),true);\n\n if(particleCloud_.impDEMdragAcc())\n particleCloud_.registerFieldsToDEM(\"dragAcc\",\"vector-atom\",particleCloud_.idFacc(),true);\n\n if(ms())\n {\n if(implForceDEM())\n {\n if(anisotropicDrag())\n particleCloud_.registerFieldsToDEM(\"Ksl_Extra_cm\",\"vector-multisphere\",particleCloud_.idKslExtraCM());\n else\n particleCloud_.registerFieldsToDEM(\"Ksl_cm\",\"scalar-multisphere\",particleCloud_.idKslCM());\n\n particleCloud_.registerFieldsToDEM(\"uf_cm\",\"vector-multisphere\",particleCloud_.idUfCM());\n }\n else\n {\n particleCloud_.registerFieldsToDEM(\"dragforce_cm\",\"vector-multisphere\",particleCloud_.idDragExpCM());\n }\n if(useTorque())\n {\n if(implTorqueDEM())\n {\n particleCloud_.registerFieldsToDEM(\"KslRotation\",\"vector-multisphere\",particleCloud_.idKslRotationCM()); // TODO: this should have other name on DEM side (is ambigous with MS version)\n }\n particleCloud_.registerFieldsToDEM(\"hdtorque_cm\",\"vector-multisphere\",particleCloud_.idTorqueExpCM());\n }\n }\n else\n {\n if(implForceDEM())\n {\n if(anisotropicDrag())\n particleCloud_.registerFieldsToDEM(\"KslExtra\",\"vector-atom\",particleCloud_.idKslExtra());\n else\n particleCloud_.registerFieldsToDEM(\"Ksl\",\"scalar-atom\",particleCloud_.idKsl());\n\n particleCloud_.registerFieldsToDEM(\"uf\",\"vector-atom\",particleCloud_.idUf());\n }\n else\n {\n particleCloud_.registerFieldsToDEM(\"dragforce\",\"vector-atom\",particleCloud_.idDragExp());\n }\n if(useTorque())\n {\n if(implTorqueDEM())\n {\n particleCloud_.registerFieldsToDEM(\"KslRotation\",\"vector-atom\",particleCloud_.idKslRotation());\n }\n particleCloud_.registerFieldsToDEM(\"hdtorque\",\"vector-atom\",particleCloud_.idTorqueExp());\n }\n }\n\n\n if(pullRotation())\n particleCloud_.registerFieldsToDEM(\"omega\",\"vector-atom\",particleCloud_.idPullRotation(),true);\n\n if(pullOrientation())\n {\n if(ms())\n {\n particleCloud_.registerFieldsToDEM(\"ex_space\",\"vector-multisphere\",particleCloud_.idPullOrientation(),true);\n particleCloud_.registerFieldsToDEM(\"ey_space\",\"vector-multisphere\",particleCloud_.idPullOrientation1(),true);\n }\n else\n {\n particleCloud_.registerFieldsToDEM(\"ex\",\"vector-atom\",particleCloud_.idPullOrientation(),true);\n }\n }\n if(pullShape())\n particleCloud_.registerFieldsToDEM(\"shape\",\"vector-atom\",particleCloud_.idPullShape(),true);\n if(useUf())\n particleCloud_.registerFieldsToDEM(\"uf\",\"vector-atom\",particleCloud_.idUf());\n if(useFhydro())\n particleCloud_.registerFieldsToDEM(\"Fhydro\",\"vector-atom\",particleCloud_.idFhydro(),true);\n if(useVisc())\n particleCloud_.registerFieldsToDEM(\"muf\",\"scalar-atom\",particleCloud_.idVisc());\n\n if(sq())\n {\n particleCloud_.registerFieldsToDEM(\"area\",\"scalar-atom\",particleCloud_.idArea(),true);\n particleCloud_.registerFieldsToDEM(\"volume\",\"scalar-atom\",particleCloud_.idVol(),true);\n particleCloud_.registerFieldsToDEM(\"blockiness\",\"vector2D-atom\",particleCloud_.idBlockiness(),true);\n }\n if(convex())\n {\n particleCloud_.registerFieldsToDEM(\"rmass\",\"scalar-atom\",particleCloud_.idMass(),true);\n particleCloud_.registerFieldsToDEM(\"density\",\"scalar-atom\",particleCloud_.idDensity(),true);\n particleCloud_.registerFieldsToDEM(\"shapetype\",\"scalar-atom\",particleCloud_.idType(),true);\n }\n if(pullType())\n {\n word nameForType;\n if(particleCloud_.shapeTypeName()==\"convex\")\n nameForType=word(\"shapetype\");\n else\n {\n nameForType=word(\"type\");\n Warning <<\"\\n Using (material) type to distinguish types (e.g. scaleVol).\\n\"\n <<\" You might use separate material types if you want to scale them separately.\" << endl;\n }\n //TODO use e.g. group to identify different sq types and use groups for SQ templates\n //if(particleCloud_.shapeTypeName()==\"superquadric\")\n particleCloud_.registerFieldsToDEM(nameForType,\"scalar-atom\",particleCloud_.idType(),true);\n }\n if(pullDensity())\n particleCloud_.registerFieldsToDEM(\"density\",\"scalar-atom\",particleCloud_.idDensity(),true);\n if(pushConvectiveHeatFlux())\n particleCloud_.registerFieldsToDEM(\"convectiveHeatFlux\",\"scalar-atom\",particleCloud_.idConvectiveHeatFlux());\n if(pullTemp())\n particleCloud_.registerFieldsToDEM(\"Temp\",\"scalar-atom\",particleCloud_.idTemp(),true);\n if(useQuat())\n particleCloud_.registerFieldsToDEM(\"quaternion\",\"quaternion-atom\",particleCloud_.idQuat(),true);\n\n if(pushTurbulence())\n {\n particleCloud_.registerFieldsToDEM(\"k\",\"scalar-atom\",particleCloud_.idK());\n particleCloud_.registerFieldsToDEM(\"epsilon\",\"scalar-atom\",particleCloud_.idEpsilon());\n }\n\n if (particleCG())\n {\n particleCloud_.registerFieldsToDEM(\"dSauter\", \"scalar-atom\", particleCloud_.idParticleCG(), true);\n particleCloud_.cgParticleSpecific_ = true;\n }\n}\n\nconst volScalarField& forceSubModel::nuField() const\n{\n #ifdef compre\n nu_=particleCloud_.turbulence_.mu() / rho_;\n return nu_;\n #else\n if(switches_[8]) // scalarViscosity=true\n return nu_;\n else\n return particleCloud_.turbulence_.nu();\n #endif\n}\n\nconst volScalarField& forceSubModel::muField() const\n{\n #ifdef compre\n return particleCloud_.turbulence_.mu();\n #else\n if(switches_[8]) // scalarViscosity=true\n {\n // usage of constant mu_ is still commented, as not tested\n // particleCloud_.turbulence_.nu()*rho_ does not work properly\n FatalError<< \"implementation not complete!\" << abort(FatalError);\n //return mu_; // to be used with above code to set mu_ in readSwitches()\n\n return particleCloud_.turbulence_.nu()*rho_;// for now just to have a return\n }else\n return particleCloud_.turbulence_.nu()*rho_;\n #endif\n}\n\nconst volScalarField& forceSubModel::rhoField() const\n{\n return rho_;\n}\n\nconst volVectorField& forceSubModel::divTauField(const volVectorField& U) const\n{\n // calc div(Tau)\n #ifdef compre\n const volScalarField& mu_ = muField();\n divTau_ = -fvc::laplacian(mu_, U) - fvc::div(mu_*dev(fvc::grad(U)().T()));\n return divTau_;\n #else\n const volScalarField& nu_ = nuField();\n const volScalarField& rho_ = rhoField();\n divTau_ = -fvc::laplacian(nu_*rho_, U)- fvc::div(nu_*rho_*dev(fvc::grad(U)().T()));\n return divTau_;\n #endif\n}\n\nconst volVectorField& forceSubModel::IBDragPerV(const volVectorField& U,const volScalarField& p) const\n{\n #ifdef compre\n IBDragPerV_ = muField()*fvc::laplacian(U)-fvc::grad(p);\n #else\n IBDragPerV_ = rhoField()*(nuField()*fvc::laplacian(U)-fvc::grad(p));\n #endif\n return IBDragPerV_;\n}\n\nvoid forceSubModel::calcXi(const scalar& ds, const scalar& voidfraction, const scalar& magUr, const scalar& nuf, scalar& Xi ) const\n{\n if(!(voidageFunctionDiFelice() || voidageFunctionRong() || voidageFunctionTang()))\n {\n Xi = 2;\n } else if(!(voidageFunctionDiFelice() ^ voidageFunctionRong() ^ voidageFunctionTang() ))\n { //triple XOR, \"There can be only one!\"\n FatalError<< \"Only one drag correction function permitted, please select either voidageFunctionDiFelice OR voidageFunctionRong!\" << abort(FatalError);\n } else if (voidageFunctionDiFelice())\n {\n // calc DiFelice drag correction\n\n // calc particle Re number\n scalar Rep = ds*voidfraction*magUr/(nuf+SMALL);\n\n // calc Xi\n if(Rep < SMALL)\n Xi = 3.7;\n else\n Xi = 3.7 - 0.65 * exp(-sqr(1.5-log10(Rep))/2);\n\n } else if (voidageFunctionRong())\n {\n // calculate Rong drag correction\n\n scalar Rep = ds*voidfraction*magUr/(nuf+SMALL);\n if(Rep < SMALL)\n Xi = 2.65 * (voidfraction + 1.0);\n else\n Xi = 2.65 * (voidfraction + 1.0) - (5.3-3.5*voidfraction)*voidfraction*voidfraction*exp(-sqr(1.5-Foam::log10(Rep))/2.0);\n } else if (voidageFunctionTang())\n {\n // calculate Tang drag correction\n scalar Rep = ds*voidfraction*magUr/(nuf+SMALL);\n if(Rep < SMALL || 1 - voidfraction < SMALL)\n Xi = 2;\n else\n Xi = 2 -\n Foam::log10(((1.5*sqrt(1-voidfraction)+1)*voidfraction*voidfraction - (10*(voidfraction-1))/(voidfraction*voidfraction) +\n (0.0644*pow(voidfraction,-4)+0.169*voidfraction)*pow(Rep,0.657) - (0.00456*Rep)*pow(voidfraction,-4) + 0.11*(voidfraction-2)*(voidfraction-1)*Rep)\n / (0.2334*pow(Rep,0.657) - 0.00456*Rep + 1))\n / Foam::log10(voidfraction);\n }\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/forceSubModels/forceSubModel/forceSubModel.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n forceSubModel\n\nSourceFiles\n forceSubModel.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef forceSubModel_H\n#define forceSubModel_H\n\n#include \"fvCFD.H\"\n#include \"cfdemCloud.H\"\n#include \"probeModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class forceSubModel Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass forceSubModel\n{\nprivate:\n\n\nprotected:\n\n // Protected data\n const dictionary& dict_;\n\n cfdemCloud& particleCloud_;\n\n forceModel& forceModel_;\n\n label nrDefaultSwitches_; // nr of switches defined in mother class\n\n wordList switchesNameList_; // names of switches available\n\n mutable List switchesList_; // switches which are requested in dict\n\n mutable List switches_;\n\n mutable volScalarField nu_;\n\n //mutable volScalarField mu_;\n\n mutable volVectorField divTau_;\n\n mutable volVectorField IBDragPerV_;\n\n word densityFieldName_;\n\n const volScalarField& rho_;\n\n mutable int verboseDiskIntervall_;\n\n mutable int verboseDiskCounter_;\n\n scalar cg_;\n\n scalar scaleDrag_;\n\n scalar scaleDragLocal_;\n\n scalar scaleTorque_;\n\n scalar scaleDH_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"forceSubModel\");\n\n // Declare runtime constructor selection table\n\n declareRunTimeSelectionTable\n (\n autoPtr,\n forceSubModel,\n dictionary,\n (\n const dictionary& dict,\n cfdemCloud& sm,\n forceModel& fm\n ),\n (dict,sm,fm)\n );\n\n\n // Constructors\n\n //- Construct from components\n forceSubModel\n (\n const dictionary& dict,\n cfdemCloud& sm,\n forceModel& fm\n );\n\n\n // Destructor\n\n virtual ~forceSubModel();\n\n\n // Selector\n\n static autoPtr New\n (\n const dictionary& dict,\n cfdemCloud& sm,\n forceModel& fm,\n word forceType\n );\n\n\n // Member Functions\n void partToArray(const label&, const vector&, const vector&, const vector& Ufluid=vector::zero, scalar Cd=scalar(0),const vector& CdExtra=vector::zero) const;\n\n //function to set anisotropic drag components for DEM side only.\n void partToArrayAnisotropic(const label&, const vector&, const vector& dragEx=vector::zero) const;\n\n //function to set anisotropic torque components for DEM side only.\n void partToArrayAnisotropicTorque(const label&, const vector&, const vector& torqueTotal=vector::zero) const;\n\n virtual void constructorCalls(word typeName) const {}\n\n virtual void preParticleLoop(bool verbose=false) const {}\n\n virtual void postParticleLoop(bool verbose=false) const {}\n\n virtual void explicitCorr(vector&, vector&, scalar&, vector&, const vector&, vector&, const vector&, bool,label index=100) const;\n\n virtual void explicitCorrScalar(scalar&, scalar&, scalar&,\n scalar&, const scalar&, scalar&, bool, label index=100) const;\n\n virtual void update(label particleI, label cellI, scalar& d,\n scalar& scalToUpdate1, scalar& scalToUpdate2, bool verbose) const;\n\n virtual void update(label particleI, label cellI, scalar& d,\n vector& vecToUpdate1, vector& vecToUpdate2,\n scalar& scalToUpdate1, scalar& scalToUpdate2,\n bool verbose) const;\n\n virtual void scaleDia(scalar& d, int index=0) const;\n\n virtual void scaleForce(vector& force, scalar& d, int index=0) const;\n\n virtual void scaleCoeff(scalar& coeff, scalar& d, scalar& Rep, int index=0) const;\n\n virtual void scaleForceLocal(vector& force) const;\n\n virtual void scaleTorque(vector& torque) const;\n\n virtual void explicitLimit(vector&, vector&, scalar&) const;\n\n virtual void verboseToDiskWrite(Field& writeValues) const {};//implement writing to disk\n\n virtual void calculateCorrectedVoidage(\n scalar& voidfraction, vector& Ufluid, scalar cellVolume, scalar diameter\n ) const {};\n\n virtual void updateField(volScalarField* scalField, volVectorField* vecField) const {};\n\n virtual void getField(vector position, label cellI, scalar& scalVal, vector& vecVal) const {};\n\n // Access\n inline bool treatForceExplicit() const { return switches_[0]; }\n\n inline bool treatForceDEM() const { return switches_[1]; }\n\n inline bool implForceDEM() const { return switches_[2]; }\n\n inline bool verbose() const { return switches_[3]; }\n\n inline bool interpolation() const { return switches_[4]; }\n\n inline bool useFilteredDragModel() const { return switches_[5]; }\n\n inline bool useParcelSizeDependentFilteredDrag() const { return switches_[6]; }\n\n inline bool verboseToDisk() const\n {\n verboseDiskCounter_++;\n if(verboseDiskCounter_>=verboseDiskIntervall_)\n {\n verboseDiskCounter_=0;\n return switches_[9];\n }\n else\n return false;\n }\n\n virtual word myType() const=0;\n\n inline bool ms() const { return switches_[11]; }\n inline bool sq() const { return switches_[25]; }\n inline bool convex() const { return switches_[29]; }\n\n inline bool useTorque() const { return switches_[12]; }\n\n inline bool anisotropicDrag() const { return switches_[13]; }\n\n inline bool pullRotation() const { return switches_[14]; }\n\n inline bool pullOrientation() const { return switches_[15]; }\n\n inline bool pullShape() const { return switches_[16]; }\n\n inline bool voidageFunctionDiFelice() const { return switches_[17]; }\n\n inline bool voidageFunctionRong() const { return switches_[18]; }\n inline bool voidageFunctionTang() const { return switches_[23]; }\n\n inline bool useUf() const { return switches_[19]; }\n\n inline bool useFhydro() const { return switches_[20]; }\n\n inline bool implTorqueDEM() const { return switches_[21]; }\n\n inline bool useVisc() const { return switches_[22]; }\n\n inline bool useMpData() const { return switches_[24]; }\n\n inline bool useQuat() const { return switches_[26]; }\n\n inline bool pushTurbulence() const { return switches_[27]; }\n\n inline bool particleCG() const { return switches_[28]; }\n\n inline bool pullType() const { return switches_[30]; }\n\n inline bool pullDensity() const { return switches_[31]; }\n\n inline bool pushConvectiveHeatFlux() const { return switches_[32]; }\n\n inline bool pullTemp() const { return switches_[33]; }\n\n inline forceModel& myForceM() const { return forceModel_; }\n\n inline const List& switches() const { return switches_; }\n\n inline const wordList& switchesNameList() const { return switchesNameList_; }\n\n void setSwitchesList(label i, bool v, bool defaultValue=false) const { switchesList_[i] = v; switches_[i]=defaultValue; }\n\n void setSwitches(label i, Switch v) const { switches_[i] = v; }\n\n virtual void readSwitches() const;\n\n void setupCommunication() const;\n\n const label& nrDefaultSwitches() const { return nrDefaultSwitches_; }\n\n const volScalarField& nuField() const;\n\n const volScalarField& muField() const;\n\n const volScalarField& rhoField() const;\n\n const volVectorField& divTauField(const volVectorField&) const;\n\n const volVectorField& IBDragPerV(const volVectorField&,const volScalarField&) const;\n\n inline scalar getCG(int index=0) const { return particleCloud_.cg(index); };\n\n const scalar scaleDrag(int index=0) const;\n\n const scalar& scaleDragLocal() const {return scaleDragLocal_;};\n\n const scalar& scaleTorque() const {return scaleTorque_;};\n\n virtual void calcXi(const scalar& ds, const scalar& voidfaction, const scalar& magUr, const scalar& nuf, scalar& Xi ) const=0;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/forceSubModels/forceSubModel/newForceSubModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"forceSubModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\nautoPtr forceSubModel::New\n(\n const dictionary& dict,\n cfdemCloud& sm,\n forceModel& fm,\n word forceType\n)\n{\n Info<< \" Selecting forceSubModel \"\n << forceType << endl;\n\n dictionaryConstructorTable::iterator cstrIter =\n dictionaryConstructorTablePtr_->find(forceType);\n\n if (cstrIter == dictionaryConstructorTablePtr_->end())\n {\n FatalError\n << \"forceSubModel::New(const dictionary&, const spray&) : \"\n << endl\n << \" unknown forceSubModelType type \"\n << forceType\n << \", constructor not in hash table\" << endl << endl\n << \" Valid forceSubModel types are :\"\n << endl;\n Info<< dictionaryConstructorTablePtr_->toc()\n << abort(FatalError);\n }\n\n return autoPtr(cstrIter()(dict,sm,fm));\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/gradPForce/gradPForce.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"gradPForce.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(gradPForce, 0);\n\naddToRunTimeSelectionTable\n(\n forceModel,\n gradPForce,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\ngradPForce::gradPForce\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n forceModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n pFieldName_(propsDict_.lookupOrDefault(\"pFieldName\",\"p\")),\n p_(sm.mesh().lookupObject (pFieldName_)),\n velocityFieldName_(propsDict_.lookupOrDefault(\"velocityFieldName\",\"U\")),\n U_(sm.mesh().lookupObject (velocityFieldName_)),\n useRho_(false),\n useU_(false),\n addedMassCoeff_(0.0)\n{\n // block gradPForceModel for type B\n if (modelType_ == \"B\") FatalError <<\"using model gradPForce with model type B is not valid\\n\" << abort(FatalError);\n\n // suppress particle probe\n if (probeIt_ && propsDict_.found(\"suppressProbe\"))\n probeIt_=!Switch(propsDict_.lookup(\"suppressProbe\"));\n if(probeIt_)\n {\n particleCloud_.probeM().initialize(typeName, typeName+\".logDat\");\n particleCloud_.probeM().vectorFields_.append(\"gradPForce\"); //first entry must the be the force\n particleCloud_.probeM().scalarFields_.append(\"Vs\");\n particleCloud_.probeM().scalarFields_.append(\"rho\");\n particleCloud_.probeM().writeHeader();\n }\n\n particleCloud_.checkCG(true);\n\n // init force sub model\n setForceSubModels(propsDict_);\n\n // define switches which can be read from dict\n forceSubM(0).setSwitchesList(0,true); // activate treatExplicit switch\n forceSubM(0).setSwitchesList(3,true); // activate search for verbose switch\n forceSubM(0).setSwitchesList(4,true); // activate search for interpolate switch\n\n //set default switches (hard-coded default = false)\n forceSubM(0).setSwitches(0,true); // make treatForceExplicit=true the default (is desired, otherwise this force would be implicit in slip vel!)\n if (modelType_ == \"Bfull\") // type Bfull\n forceSubM(0).setSwitches(1,false); // treatForceDEM = false\n else // type A\n forceSubM(0).setSwitches(1,true); // treatForceDEM = true\n\n // read those switches defined above, if provided in dict\n for (int iFSub=0;iFSub (\"voidfraction\");\n volScalarField U2 = U_&U_;// *voidfraction_*voidfraction_;\n if (useRho_)\n gradP_ = fvc::grad(0.5*U2);\n else\n gradP_ = fvc::grad(0.5*forceSubM(0).rhoField()*U2);\n }*/\n vector gradP;\n scalar Vs;\n scalar rho;\n vector position;\n vector force;\n label cellI;\n scalar rs(0);\n const scalar fourPiByThree(4./3.*M_PI);\n\n #include \"resetGradPInterpolator.H\"\n #include \"setupProbeModel.H\"\n\n for(int index = 0;index < particleCloud_.numberOfParticles(); index++)\n {\n force=vector(0,0,0);\n cellI = particleCloud_.cfdemCloud::cellIDs()[index][0];\n\n if (cellI > -1) // particle Found\n {\n position = particleCloud_.cfdemCloud::position(index);\n rs = particleCloud_.radius(index);\n\n if(forceSubM(0).interpolation()) // use intepolated values for alpha (normally off!!!)\n {\n gradP = gradPInterpolator_().interpolate(position,cellI);\n }else\n {\n gradP = gradP_[cellI];\n }\n\n Vs = particleCloud_.cfdemCloud::particleVolume(index);\n //Vs = rs*rs*rs*fourPiByThree; //change Vs calc to this after TH is clean!\n rho = forceSubM(0).rhoField()[cellI];\n\n // calc particle's pressure gradient force\n if (useRho_)\n force = -Vs*gradP*rho*(1.0+addedMassCoeff_);\n else\n force = -Vs*gradP*(1.0+addedMassCoeff_);\n\n if(forceSubM(0).verbose() && index >=0 && index <2)\n {\n Info << \"index = \" << index << endl;\n Info << \"gradP = \" << gradP << endl;\n Info << \"force = \" << force << endl;\n }\n\n //Set value fields and write the probe\n if(probeIt_)\n {\n #include \"setupProbeModelfields.H\"\n // Note: for other than ext one could use vValues.append(x)\n // instead of setSize\n vValues.setSize(vValues.size()+1, force); //first entry must the be the force\n sValues.setSize(sValues.size()+1, Vs);\n sValues.setSize(sValues.size()+1, rho);\n particleCloud_.probeM().writeProbe(index, sValues, vValues);\n }\n }\n\n // write particle based data to global array\n forceSubM(0).partToArray(index,force,vector::zero);\n }\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/gradPForce/gradPForce.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n -grad(p)*Vp * rho ... if p is normalized with pressure\n -grad(p)*Vp ... if p is real pressure\n pressure gradient force\n including interpolation of the velocity to the exact position\n\nClass\n gradPForce\n\nSourceFiles\n gradPForce.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef gradPForce_H\n#define gradPForce_H\n\n#include \"forceModel.H\"\n#include \"interpolationCellPoint.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class gradPForce Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass gradPForce\n:\n public forceModel\n{\nprivate:\n dictionary propsDict_;\n\n word pFieldName_;\n\n const volScalarField& p_;\n\n word velocityFieldName_;\n\n const volVectorField& U_;\n\n bool useRho_;\n\n bool useU_; // if false: substitution p=0.5*rho*U^2\n\n mutable double addedMassCoeff_; //added mass coefficient\n\npublic:\n\n //- Runtime type information\n TypeName(\"gradPForce\");\n\n\n // Constructors\n\n //- Construct from components\n gradPForce\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~gradPForce();\n\n\n // Member Functions\n void setForce() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/noDrag/noDrag.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"noDrag.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(noDrag, 0);\n\naddToRunTimeSelectionTable\n(\n forceModel,\n noDrag,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nnoDrag::noDrag\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n forceModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n noDEMForce_(propsDict_.lookupOrDefault(\"noDEMForce\",false)),\n keepCFDForce_(propsDict_.lookupOrDefault(\"keepCFDForce\",false))\n{\n Info << \"noDragTestMe: \" << noDEMForce_ << \" \" << keepCFDForce_ << endl;\n\n particleCloud_.checkCG(true);\n\n // init force sub model\n setForceSubModels(propsDict_);\n\n // define switches which can be read from dict\n forceSubM(0).setSwitchesList(3,true); // activate search for verbose switch\n\n //set default switches (hard-coded default = false)\n //forceSubM(0).setSwitches(XXX,true);\n\n // read those switches defined above, if provided in dict\n for (int iFSub=0;iFSub -1) // particle Found\n {\n //==========================\n // set force on particle (proposed new code)\n // write particle based data to global array\n //forceSubM(0).partToArray(index,drag,dragExplicit);\n //==========================\n // set force on particle (old code)\n if (!keepCFDForce_)\n {\n for (int j=0;j<3;j++)\n {\n expForces()[index][j] = 0.;\n impForces()[index][j] = 0.;\n }\n }\n if (noDEMForce_)\n {\n for (int j=0;j<3;j++)\n particleCloud_.fieldsToDEM[idDragExp][index][j] = 0.;\n\n if (particleCloud_.impDEMdrag())\n {\n particleCloud_.fieldsToDEM[idKsl][index][0] = 0.;\n for (int j=0;j<3;j++)\n particleCloud_.fieldsToDEM[idUf][index][j] = 0.;\n }\n }\n //==========================\n }\n }\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/noDrag/noDrag.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n noDrag\n\nSourceFiles\n noDrag.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef noDrag_H\n#define noDrag_H\n\n#include \"forceModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass noDrag\n:\n public forceModel\n{\nprivate:\n dictionary propsDict_;\n\n Switch noDEMForce_;\n\n Switch keepCFDForce_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"noDrag\");\n\n\n // Constructors\n\n //- Construct from components\n noDrag\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~noDrag();\n\n\n // Member Functions\n void setForce() const;\n\n void MSinit();\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/particleCellVolume/particleCellVolume.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"particleCellVolume.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \"dataExchangeModel.H\"\n#include \n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(particleCellVolume, 0);\n\naddToRunTimeSelectionTable\n(\n forceModel,\n particleCellVolume,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nparticleCellVolume::particleCellVolume\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n forceModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n mesh_(particleCloud_.mesh()),\n startTime_(propsDict_.lookupOrDefault(\"startTime\",0.)),\n scalarFieldName_(\"voidfraction\"),\n scalarField_\n ( \n IOobject\n (\n \"particleCellVolume\",\n mesh_.time().timeName(),\n mesh_,\n IOobject::NO_READ,\n IOobject::AUTO_WRITE\n ),\n mesh_,\n dimensionedScalar(\"zero\", dimensionSet(0,0,0,0,0), 0)\n ),\n scalarField2_\n ( \n IOobject\n (\n \"cellVolume\",\n mesh_.time().timeName(),\n mesh_,\n IOobject::NO_READ,\n IOobject::AUTO_WRITE\n ),\n mesh_,\n dimensionedScalar(\"zero\", dimensionSet(0,0,0,0,0), 0)\n ),\n upperThreshold_(propsDict_.lookupOrDefault(\"upperThreshold\",1.01)),\n lowerThreshold_(propsDict_.lookupOrDefault(\"lowerThreshold\",-0.01)),\n path_(\"postProcessing/particleCellVolume\"),\n sPtr_(NULL),\n writeToFile_(propsDict_.lookupOrDefault(\"writeToFile\",false))\n{\n // init force sub model\n setForceSubModels(propsDict_);\n\n // define switches which can be read from dict\n forceSubM(0).setSwitchesList(3,true); // activate search for verbose switch\n\n // read those switches defined above, if provided in dict\n forceSubM(0).readSwitches();\n\n particleCloud_.checkCG(true);\n\n // create the path and generate output file\n if(writeToFile_)\n {\n path_=particleCloud_.IOM().createTimeDir(path_);\n\t sPtr_ = new OFstream(path_/\"particleCellVolume.txt\");\n *sPtr_ << \"# time | total particle volume in cells | total volume of cells with particles | average volume fraction | min(voidfraction) | max(voidfraction)\" << endl;\n }\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nparticleCellVolume::~particleCellVolume()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nvoid particleCellVolume::setForce() const\n{\n if(mesh_.time().value() >= startTime_)\n {\n if(forceSubM(0).verbose()) Info << \"particleCellVolume.C - setForce()\" << endl;\n\n scalarField_ == dimensionedScalar(\"zero\", scalarField_.dimensions(), 0.);\n\n // get reference to actual field\n const volScalarField& field = mesh_.lookupObject(scalarFieldName_);\n\n scalar fieldValue=-1;\n scalar cellVol=-1;\n scalar minFieldVal=1e18;\n scalar maxFieldVal=-1e18;\n\n forAll(field,cellI)\n {\n fieldValue = field[cellI];\n if(fieldValue < upperThreshold_ && fieldValue > lowerThreshold_)\n {\n cellVol = mesh_.V()[cellI];\n scalarField_[cellI] = (1-fieldValue) * cellVol;\n scalarField2_[cellI] = cellVol;\n minFieldVal=min(minFieldVal,fieldValue);\n maxFieldVal=max(maxFieldVal,fieldValue);\n }\n else\n {\n scalarField_[cellI] = 0.;\n scalarField2_[cellI] = 0.;\n }\n }\n scalarField_ == dimensionedScalar(\"zero\", scalarField_.dimensions(), gSum(scalarField_));\n scalarField2_ == dimensionedScalar(\"zero\", scalarField_.dimensions(), gSum(scalarField2_));\n reduce(minFieldVal, minOp());\n reduce(maxFieldVal, maxOp());\n\n if(forceSubM(0).verbose())\n {\n Info << \"calculated integral particle volume \"\n << \" = \" << scalarField_[0]\n << \",\\n considering cells where the field < \" << upperThreshold_\n << \", and > \" << lowerThreshold_\n << \",\\n the total volume of cells holding particles = \" << scalarField2_[0]\n << \",\\n this results in an average volume fraction of:\" << scalarField_[0]/(scalarField2_[0]+SMALL)\n << \",\\n the min occurring \" << scalarFieldName_ << \" is:\" << minFieldVal\n << \",\\n the max occurring \" << scalarFieldName_ << \" is:\" << maxFieldVal\n << endl;\n }\n\n // write to file\n if(writeToFile_)\n {\n *sPtr_<< mesh_.time().value() << \" \" ;\n *sPtr_<< scalarField_[0] << \" \" ;\n *sPtr_<< scalarField2_[0] << \" \" ;\n *sPtr_<< scalarField_[0]/(scalarField2_[0]+SMALL) << \" \" ;\n *sPtr_<< minFieldVal << \" \" ;\n *sPtr_<< maxFieldVal << endl;\n }\n }// end if time >= startTime_\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/particleCellVolume/particleCellVolume.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n calc volume of the particles from the voidfraction field\nClass\n particleCellVolume\n\nSourceFiles\n particleCellVolume.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef particleCellVolume_H\n#define particleCellVolume_H\n\n#include \"forceModel.H\"\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class particleCellVolume Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass particleCellVolume\n:\n public forceModel\n{\nprivate:\n\n dictionary propsDict_;\n\n const fvMesh& mesh_;\n\n mutable scalar startTime_;\n\n const word scalarFieldName_;\n\n mutable volScalarField scalarField_;\n\n mutable volScalarField scalarField2_;\n\n mutable scalar upperThreshold_;\n\n mutable scalar lowerThreshold_;\n\n mutable fileName path_;\n\n mutable OFstream* sPtr_;\n\n Switch writeToFile_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"particleCellVolume\");\n\n\n // Constructors\n\n //- Construct from components\n particleCellVolume\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~particleCellVolume();\n\n\n // Member Functions\n void setForce() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/particleVolume/particleVolume.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"particleVolume.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \"dataExchangeModel.H\"\n#include \n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(particleVolume, 0);\n\naddToRunTimeSelectionTable\n(\n forceModel,\n particleVolume,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nparticleVolume::particleVolume\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n forceModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n startTime_(propsDict_.lookupOrDefault(\"startTime\",0.)),\n path_(\"postProcessing/particleVolume\"),\n sPtr_(NULL),\n writeToFile_(propsDict_.lookupOrDefault(\"writeToFile\",false))\n{\n // init force sub model\n setForceSubModels(propsDict_);\n\n // define switches which can be read from dict\n forceSubM(0).setSwitchesList(3,true); // activate search for verbose switch\n\n // read those switches defined above, if provided in dict\n forceSubM(0).readSwitches();\n\n particleCloud_.checkCG(true);\n\n // create the path and generate output file\n if(writeToFile_)\n {\n path_=particleCloud_.IOM().createTimeDir(path_);\n\t sPtr_ = new OFstream(path_/\"particleVolume.txt\");\n //*sPtr_ << \"time | total particle volume\" << nl;\n }\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nparticleVolume::~particleVolume()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nvoid particleVolume::setForce() const\n{\n if(particleCloud_.mesh().time().value() >= startTime_)\n {\n\n if(forceSubM(0).verbose()) Info << \"particleVolume.C - setForce()\" << endl;\n\n scalar rs(0);\n scalar VsTot(0);\n const scalar fpth=(4./3.*M_PI);//4.188790204786390525;//4./3.*pi;\n \n for(int index = 0;index < particleCloud_.numberOfParticles(); ++index)\n {\n if(particleCloud_.cfdemCloud::cellIDs()[index][0] >= 0)\n {\n rs = particleCloud_.radius(index);\n forceSubM(0).scaleDia(rs,index); //caution: this fct will scale ds!\n VsTot += rs*rs*rs*fpth;\n }\n }\n\n reduce(VsTot, sumOp());\n if(forceSubM(0).verbose()) Info << \"Total particle volume (located in domain) = \" << VsTot << endl;\n\n // write to file\n if(writeToFile_)\n {\n *sPtr_<< particleCloud_.mesh().time().value() << \" \" ;\n *sPtr_<< VsTot << endl;\n }\n }// end if time >= startTime_\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/particleVolume/particleVolume.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n calc volume of the particles from the voidfraction field\nClass\n particleVolume\n\nSourceFiles\n particleVolume.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef particleVolume_H\n#define particleVolume_H\n\n#include \"forceModel.H\"\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class particleVolume Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass particleVolume\n:\n public forceModel\n{\nprivate:\n\n dictionary propsDict_;\n\n scalar startTime_;\n\n mutable fileName path_;\n\n mutable OFstream* sPtr_;\n\n Switch writeToFile_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"particleVolume\");\n\n\n // Constructors\n\n //- Construct from components\n particleVolume\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~particleVolume();\n\n\n // Member Functions\n void setForce() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/scalarGeneralExchange/scalarGeneralExchange.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"scalarGeneralExchange.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \"dataExchangeModel.H\"\n#define ALARGECONCENTRATION 1e32\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(scalarGeneralExchange, 0);\n\naddToRunTimeSelectionTable\n(\n forceModel,\n scalarGeneralExchange,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nscalarGeneralExchange::scalarGeneralExchange\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n forceModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n scalarTransportProperties_ //this is clumsy, but effective\n (\n IOobject\n (\n \"scalarTransportProperties\",\n sm.mesh().time().constant(),\n sm.mesh(),\n IOobject::MUST_READ,\n IOobject::NO_WRITE\n )\n ),\n generalPropsDict_(scalarTransportProperties_.subDict(\"generalManualProps\")),\n voidfractionFieldName_(propsDict_.lookupOrDefault(\"voidfractionFieldName\",\"voidfraction\")), //common names/data\n velFieldName_(propsDict_.lookupOrDefault(\"velFieldName\",\"U\")),\n tempFieldName_(propsDict_.lookup(\"tempFieldName\")), //temperature names/data\n partTempName_(propsDict_.lookup(\"partTempName\")),\n partHeatFluxName_(propsDict_.lookupOrDefault( \"partHeatFluxName\", \"none\")),\n partHeatTransCoeffName_(propsDict_.lookupOrDefault(\"partHeatTransCoeffName\", \"none\")),\n partHeatFluidName_(propsDict_.lookupOrDefault( \"partHeatFluidName\", \"none\")),\n partDat_(NULL),\n partDatFlux_(NULL),\n partDatTransCoeff_(NULL),\n partDatFluid_(NULL),\n partDatTmpExpl_(NULL),\n partDatTmpImpl_(NULL),\n validPartFlux_(false),\n validPartTransCoeff_(false),\n validPartFluid_(false),\n haveTemperatureEqn_(false),\n useLiMason_(false),\n useGeneralCorrelation_(false),\n generalCorrelationParameters_(propsDict_.lookupOrDefault(\"generalCorrelationParameters\",scalarList(0))),\n lambda_(readScalar(propsDict_.lookup(\"lambda\"))),\n Prandtl_(readScalar(propsDict_.lookup(\"Prandtl\"))),\n eulerianFieldNames_( generalPropsDict_.lookup(\"eulerianFields\")),\n partDatPositionInRegister_(eulerianFieldNames_.size(),-1),\n partSpeciesNames_(propsDict_.lookup(\"partSpeciesNames\")),\n partSpeciesFluxNames_(propsDict_.lookup(\"partSpeciesFluxNames\")),\n partSpeciesTransCoeffNames_(propsDict_.lookup(\"partSpeciesTransCoeffNames\")),\n partSpeciesFluidNames_(propsDict_.lookup(\"partSpeciesFluidNames\")),\n DMolecular_(propsDict_.lookup(\"DMolecular\")),\n maxSource_(1e30),\n scaleDia_(1.)\n{\n setForceSubModels(propsDict_);\n particleBased_ = true; // this model is always particle based\n setupModel();\n // suppress particle probe\n if (probeIt_ && propsDict_.found(\"suppressProbe\"))\n probeIt_=!Switch(propsDict_.lookup(\"suppressProbe\"));\n if(probeIt_)\n {\n forAll(eulerianFieldNames_, fieldIt)\n {\n particleCloud_.probeM().initialize(typeName, typeName + \"_\" + eulerianFieldNames_[fieldIt] + \".logDat\");\n particleCloud_.probeM().vectorFields_.append(\"Urel\"); //first entry must the be the vector to probe\n if(eulerianFieldNames_[fieldIt]==tempFieldName_) //this is the temperature\n {\n particleCloud_.probeM().scalarFields_.append(\"Rep\");\n particleCloud_.probeM().scalarFields_.append(\"Nu\");\n }\n else\n particleCloud_.probeM().scalarFields_.append(\"Sh\");\n particleCloud_.probeM().scalarFields_.append(\"exchangeRate\");\n particleCloud_.probeM().writeHeader();\n }\n }\n\n for (int iFSub=0;iFSub(\"voidfractionFieldName\",\"voidfraction\")), //common names/data\n velFieldName_(propsDict_.lookupOrDefault(\"velFieldName\",\"U\")),\n tempFieldName_(propsDict_.lookup(\"tempFieldName\")), //temperature names/data\n partTempName_(propsDict_.lookup(\"partTempName\")),\n partHeatFluxName_(propsDict_.lookupOrDefault( \"partHeatFluxName\", \"none\")),\n partHeatTransCoeffName_(propsDict_.lookupOrDefault(\"partHeatTransCoeffName\", \"none\")),\n partHeatFluidName_(propsDict_.lookupOrDefault( \"partHeatFluidName\", \"none\")),\n partDat_(NULL),\n partDatFlux_(NULL),\n partDatTransCoeff_(NULL),\n partDatFluid_(NULL),\n partDatTmpExpl_(NULL),\n partDatTmpImpl_(NULL),\n validPartFlux_(false),\n validPartTransCoeff_(false),\n validPartFluid_(false),\n haveTemperatureEqn_(false),\n useLiMason_(false),\n useGeneralCorrelation_(false),\n lambda_(readScalar(propsDict_.lookup(\"lambda\"))),\n Prandtl_(readScalar(propsDict_.lookup(\"Prandtl\"))),\n eulerianFieldNames_( generalPropsDict_.lookup(\"eulerianFields\")),\n partDatPositionInRegister_(eulerianFieldNames_.size(),-1),\n partSpeciesNames_(propsDict_.lookup(\"partSpeciesNames\")),\n partSpeciesFluxNames_(propsDict_.lookup(\"partSpeciesFluxNames\")),\n partSpeciesTransCoeffNames_(propsDict_.lookup(\"partSpeciesTransCoeffNames\")),\n partSpeciesFluidNames_(propsDict_.lookup(\"partSpeciesFluidNames\")),\n DMolecular_(propsDict_.lookup(\"DMolecular\")),\n partHeatFluxPositionInRegister_(-1),\n partHeatTransCoeffPositionInRegister_(-1),\n partHeatFluidPositionInRegister_(-1),\n maxSource_(1e30),\n scaleDia_(1.)\n{\n setForceSubModels(propsDict_);\n particleBased_ = true; // this model is always particle based\n setupModel();\n if (probeIt_ && propsDict_.found(\"suppressProbe\"))\n probeIt_=!Switch(propsDict_.lookup(\"suppressProbe\"));\n if(probeIt_)\n {\n forAll(eulerianFieldNames_, fieldIt)\n {\n particleCloud_.probeM().initialize(dictName, dictName + \"_\" + eulerianFieldNames_[fieldIt] + \".logDat\");\n particleCloud_.probeM().vectorFields_.append(\"Urel\"); //first entry must the be the vector to probe\n if(eulerianFieldNames_[fieldIt]==tempFieldName_) //this is the temperature\n {\n particleCloud_.probeM().scalarFields_.append(\"Rep\");\n particleCloud_.probeM().scalarFields_.append(\"Nu\"); //other are debug\n }\n else\n particleCloud_.probeM().scalarFields_.append(\"Sh\");\n particleCloud_.probeM().scalarFields_.append(\"exchangeRate\");\n particleCloud_.probeM().writeHeader();\n }\n }\n\n for (int iFSub=0;iFSub (eulerianFieldNames_[fieldI]+\"Source\"));\n volScalarField& implicitEulerSource(particleCloud_.mesh().lookupObjectRef (eulerianFieldNames_[fieldI]+\"SourceKImpl\"));\n\n // reset Scalar field (== means hard reset)\n explicitEulerSource == dimensionedScalar(\"zero\", explicitEulerSource.dimensions(), 0.);\n implicitEulerSource == dimensionedScalar(\"zero\", implicitEulerSource.dimensions(), 0.);\n\n if(eulerianFieldNames_[fieldI]!=\"T\" && particleSpeciesValue_[fieldI]<0.0) //skip if species is not active\n return;\n\n //Set the names of the exchange fields\n word fieldName;\n scalar transportParameter;\n\n if(eulerianFieldNames_[fieldI]==\"T\") //this is the temperature\n {\n fieldName = tempFieldName_;\n transportParameter = lambda_;\n\n setPointersToExternalArrays( partHeatFluxName_, partHeatFluxPositionInRegister_,\n partHeatTransCoeffName_, partHeatTransCoeffPositionInRegister_,\n partHeatFluidName_, partHeatFluidPositionInRegister_\n );\n if(probeIt_)\n particleCloud_.probeM().setOutputFile(typeName+\"_\"+tempFieldName_+\".logDat\");\n }\n else\n {\n fieldName = eulerianFieldNames_[fieldI];\n transportParameter = DMolecular_[fieldI];\n\n setPointersToExternalArrays( partSpeciesFluxNames_[fieldI], partSpeciesFluxPositionInRegister_[fieldI],\n partSpeciesTransCoeffNames_[fieldI], partSpeciesTransCoeffPositionInRegister_[fieldI],\n partSpeciesFluidNames_[fieldI], partSpeciesFluidPositionInRegister_[fieldI]\n );\n if(probeIt_)\n particleCloud_.probeM().setOutputFile(typeName + \"_\" + fieldName + \".logDat\");\n }\n\n\n //==============================\n // get references\n const volScalarField& voidfraction_(particleCloud_.mesh().lookupObject (voidfractionFieldName_)); // ref to voidfraction field\n const volVectorField& U_(particleCloud_.mesh().lookupObject (velFieldName_));\n const volScalarField& fluidScalarField_(particleCloud_.mesh().lookupObject (fieldName)); // ref to scalar field\n const volScalarField& nufField = forceSubM(0).nuField();\n //==============================\n\n if (particleCloud_.shapeTypeName() == \"multisphere\")\n {\n if (scaleDia_ > 1)\n Info << typeName << \" using scale = \" << scaleDia_ << endl;\n else if (particleCloud_.cg() > 1)\n {\n scaleDia_=particleCloud_.cg();\n Info << typeName << \" using scale from liggghts cg = \" << scaleDia_ << endl;\n }\n }\n\n // realloc the arrays and get data\n allocateMyArrays(0.0);\n\n // calc La based heat flux\n vector position(0,0,0);\n scalar voidfraction(1);\n vector Ufluid(0,0,0);\n scalar fluidValue(0);\n label cellI=0;\n vector Us(0,0,0);\n vector Ur(0,0,0);\n scalar dscaled(0);\n scalar dparcel(0);\n scalar numberParticlesInParcel(1);\n scalar nuf(0);\n scalar magUr(0);\n scalar As(0);\n scalar Rep(0);\n scalar Pr(0);\n scalar sDth(scaleDia_*scaleDia_*scaleDia_);\n\n #include \"resetVoidfractionInterpolator.H\"\n #include \"resetUInterpolator.H\"\n #include \"resetFluidScalarFieldInterpolator.H\"\n\n for (int index = 0;index < particleCloud_.numberOfParticles(); ++index)\n {\n cellI = particleCloud_.cfdemCloud::cellIDs(particleBased_)[index][0];\n if (cellI >= 0)\n {\n if (forceSubM(0).interpolation())\n {\n position = particleCloud_.cfdemCloud::position(index, particleBased_);\n voidfraction = voidfractionInterpolator_().interpolate(position,cellI);\n Ufluid = UInterpolator_().interpolate(position,cellI);\n fluidValue = fluidScalarFieldInterpolator_().interpolate(position,cellI);\n }\n else\n {\n voidfraction = voidfraction_[cellI];\n Ufluid = U_[cellI];\n fluidValue = fluidScalarField_[cellI];\n }\n\n if (particleCloud_.shapeTypeName() != \"multisphere\")\n {\n dscaled = 2*particleCloud_.radius(index);\n dparcel = dscaled;\n\n // correct voidfraction\n vector dummy(0,0,0);\n for (int iFSub=0;iFSub*Nusselt)(Rep,Pr,voidfraction)/dscaled;\n\n // calc convective heat flux [W]\n scalar areaTimesTransferCoefficient = alpha * As;\n scalar partValue;\n if(eulerianFieldNames_[fieldI]==\"T\") partValue=particleCloud_.fieldsToDEM[partDatPositionInRegister_[fieldI]][index][0];\n else partValue=particleCloud_.fieldsToDEM[partDatPositionInRegister_[fieldI]][index][0];\n scalar tmpPartFlux = areaTimesTransferCoefficient\n * (fluidValue - partValue);\n\n // split implicit/explicit contribution\n forceSubM(0).explicitCorrScalar( partDatTmpImpl_[index][0],\n partDatTmpExpl_[index][0],\n areaTimesTransferCoefficient,\n fluidValue,\n fluidScalarField_[cellI],\n partValue,\n forceSubM(0).verbose()\n );\n if(validPartFlux_)\n partDatFlux_[index][0]+= tmpPartFlux; //MUST ADD total source for ALL particles in parcel\n\n if(validPartTransCoeff_)\n partDatTransCoeff_[index][0]+= alpha; //MUST ADD total source coefficient here\n\n if(validPartFluid_)\n partDatFluid_[index][0] = fluidValue; //MUST NOT add here, since this is factor\n\n\n if( forceSubM(0).verbose())\n {\n Pout << \"fieldName = \" << fieldName << endl;\n Pout << \"index = \" <*Nusselt)(Rep,Pr,voidfraction) << endl;\n Pout << \"voidfraction = \" << voidfraction << endl;\n Pout << \"fluidValue = \" << fluidValue << endl ;\n Pout << \"partValue = \" << partValue << endl;\n if(validPartFlux_)\n Pout << \"partDatFlux: \" << partDatFlux_[index][0] << endl;\n if(validPartTransCoeff_)\n Pout << \"partDatTransCoeff: \" << partDatTransCoeff_[index][0] << endl;\n }\n\n //Set value fields and write the probe\n if(probeIt_)\n {\n #include \"setupProbeModelfields.H\"\n // Note: for other than ext one could use vValues.append(x)\n // instead of setSize\n vValues.setSize(vValues.size()+1, Ur);\n if(eulerianFieldNames_[fieldI]==\"T\") //this is the temperature, then also report Rep\n sValues.setSize(sValues.size()+1, Rep);\n sValues.setSize(sValues.size()+1, (this->*Nusselt)(Rep,Pr,voidfraction));\n sValues.setSize(sValues.size()+1, tmpPartFlux);\n particleCloud_.probeM().writeProbe(index, sValues, vValues);\n }\n }\n }\n\n //Handle explicit and implicit source terms on the Euler side\n //these are simple summations!\n particleCloud_.averagingM().setScalarSum\n (\n explicitEulerSource,\n partDatTmpExpl_,\n particleCloud_.particleWeights(),\n NULL\n );\n\n particleCloud_.averagingM().setScalarSum\n (\n implicitEulerSource,\n partDatTmpImpl_,\n particleCloud_.particleWeights(),\n NULL\n );\n\n // scale with the cell volume to get (total) volume-specific source\n particleCloud_.makeSpecific(explicitEulerSource);\n explicitEulerSource*=-1;\n particleCloud_.makeSpecific(implicitEulerSource);\n implicitEulerSource*=-1;\n\n // limit explicit source term\n scalar explicitEulerSourceInCell;\n forAll(explicitEulerSource,cellI)\n {\n explicitEulerSourceInCell = explicitEulerSource[cellI];\n\n if(mag(explicitEulerSourceInCell) > maxSource_ )\n {\n explicitEulerSource[cellI] = sign(explicitEulerSourceInCell) * maxSource_;\n }\n }\n\n\n //Reporting of integral quantities\n //TODO: write to different file for fieldI>0\n Field writeValues; bool writeDiskNow=forceSubM(0).verboseToDisk(); //must call 'verboseToDisk()' only once since this function is incremeting a counter!\n writeValues.clear();\n if( forceSubM(0).verbose() || writeDiskNow)\n {\n scalar exchangeRate = gSum(-(explicitEulerSource\n +implicitEulerSource*fluidScalarField_)\n *explicitEulerSource.mesh().V()\n );\n // Note: for other than ext one could use writeValues.append(x)\n // instead of setSize\n writeValues.setSize(writeValues.size()+1, exchangeRate);\n\n if(forceSubM(0).verbose())\n {\n if(eulerianFieldNames_[fieldI]==\"T\") //have temperature\n Info << \"total convective particle-fluid heat flux [W] (Eulerian) = \"\n << exchangeRate\n << endl;\n else\n Info << \"fieldI: \" << fieldI\n << \": total convective particle-fluid species flux [kmol/s] (or [kg/s]) (Eulerian) = \"\n << exchangeRate\n << endl;\n }\n }\n if( writeDiskNow )\n for (int iFSub=0;iFSub0) || (!validPartFlux_ && validspeciesFlux ))\n FatalError << \"scalarGeneralExchange::setupModel: you have set a valid species flux name, but a non-valid heatflux name (or vice versa). This will mess up memory allocation. Please use both valid or non-valid flux names\" << abort(FatalError);\n\n //TRANSCOEFF and FLUID (implicit coupling strategy)\n if(partHeatTransCoeffName_!=\"none\") {\n validPartTransCoeff_=true;\n Info << \"Found a valid partHeatTransCoeffName: \" << partHeatTransCoeffName_ << endl;\n particleCloud_.registerFieldsToDEM(partHeatTransCoeffName_,\"scalar-atom\", partHeatTransCoeffPositionInRegister_);\n }\n if(partHeatFluidName_!=\"none\") {\n validPartFluid_=true;\n Info << \"Found a valid partHeatFluidName: \" << partHeatFluidName_ << endl;\n particleCloud_.registerFieldsToDEM(partHeatFluidName_,\"scalar-atom\", partHeatFluidPositionInRegister_);\n }\n if( validPartTransCoeff_ && !validPartFluid_ )\n FatalError <<\"Transfer coefficient set, but and fluid name missing. Check your entries in the couplingProperties! \\n\"\n << abort(FatalError);\n if( !validPartTransCoeff_ && validPartFluid_ )\n FatalError <<\"Fluid name set, but transfer coefficient missing. Check your entries in the couplingProperties! \\n\"\n << abort(FatalError);\n\n bool validspeciesTransCoeff =\n particleCloud_.checkAndRegisterFieldsToDEM(partSpeciesTransCoeffNames_,\"scalar-atom\",partSpeciesTransCoeffPositionInRegister_);\n bool validspeciesFluid =\n particleCloud_.checkAndRegisterFieldsToDEM(partSpeciesFluidNames_,\"scalar-atom\",partSpeciesFluidPositionInRegister_);\n\n if( (validPartTransCoeff_ && !validspeciesTransCoeff && partSpeciesTransCoeffNames_.size()>0 ) || (!validPartTransCoeff_ && validspeciesTransCoeff ))\n FatalError << \"scalarGeneralExchange::setupModel: you have set a valid species transCoeff name, but a non-valid heat trans coeff name (or vice versa). This will mess up memory allocation. Please use both valid or non-valid transCoeff names. You might want to use 'none' in partSpeciesTransCoeffNames to de-activate the species transCoeff name!\" << abort(FatalError);\n\n if( (validPartFluid_ && !validspeciesFluid && partSpeciesFluidNames_.size()>0) || (!validPartFluid_ && validspeciesFluid ))\n FatalError << \"scalarGeneralExchange::setupModel: you have set a valid species fluid name, but a non-valid heat fluid name (or vice versa). This will mess up memory allocation. Please use both valid or non-valid fluid names. You might want to use 'none' in partSpeciesFluidNames to de-activate the species fluid name!\" << abort(FatalError);\n\n\n //FINALY check and Info\n if(validPartFlux_ && validspeciesFlux) {\n Info << \"Found a valid partHeatFluxName and partSpeciesFluxName: \" << partHeatFluxName_ << endl;\n Info << \"scalarGeneralExchange (or derived model) will now proceed with EXPLICIT flux coupling \" << endl;\n }\n else if(validPartTransCoeff_ && validPartFluid_)\n {\n Info << \"Found a valid partHeatTransCoeffName and partHeatFluidfName (& corresponding species names).\" << endl;\n Info << \"scalarGeneralExchange (or derived model) will now proceed with IMPLICIT flux coupling \" << endl;\n }\n else if(validPartFlux_ ) {\n Info << \"Found a valid partHeatFluxName: \" << partHeatFluxName_ << endl;\n Info << \"scalarGeneralExchange (or derived model) will now proceed with EXPLICIT flux coupling for heat. \" << endl;\n }\n else\n FatalError << \"scalarGeneralExchange::setupModel: you did not specify a valid flux or transCoeff name set. Please either specify valid flux names, or valid transCoeff and fluid names.\" << abort(FatalError);\n\n\n //Make internal settings\n if (propsDict_.found(\"maxSource\"))\n {\n maxSource_=readScalar(propsDict_.lookup (\"maxSource\"));\n Info << \"limiting eulerian source field to: \" << maxSource_ << endl;\n }\n\n if (propsDict_.found(\"useLiMason\"))\n {\n useLiMason_=readBool(propsDict_.lookup (\"useLiMason\"));\n Info << \"setting for useLiMason: \" << useLiMason_ << endl;\n }\n if (propsDict_.found(\"useGeneralCorrelation\"))\n {\n useGeneralCorrelation_=readBool(propsDict_.lookup (\"useGeneralCorrelation\"));\n Info << \"setting for useGeneralCorrelation: \" << useGeneralCorrelation_ << endl;\n }\n\n if(useLiMason_ && useGeneralCorrelation_)\n FatalError <<\"You cannot set 'useLiMason' AND 'useGeneralCorrelation' to true. Just set one seeting to true. \\n\"\n << abort(FatalError);\n\n if(useLiMason_)\n Nusselt=&scalarGeneralExchange::NusseltLiMason;\n else if(useGeneralCorrelation_)\n {\n //generalCorrelationParameters_ = propsDict_.lookup(\"generalCorrelationParameters\");\n if(generalCorrelationParameters_.size()<8 || generalCorrelationParameters_.size()>8)\n FatalError <<\"The data array specified as 'generalCorrelationParameters' is too short or too long. Must specify exactly 8 values. You specified: \\n\"\n << generalCorrelationParameters_ << endl\n << abort(FatalError);\n Nusselt=&scalarGeneralExchange::NusseltGeneralCorrelation;\n }\n else\n Nusselt=&scalarGeneralExchange::NusseltDeenEtAl;\n\n // define switches which can be read from dict\n forceSubM(0).setSwitchesList(3,true); // activate search for verbose switch\n forceSubM(0).setSwitchesList(4,true); // activate search for interpolate switch\n forceSubM(0).setSwitchesList(8,true); // activate scalarViscosity switch\n forceSubM(0).setSwitchesList(9,true); // activate verboseToDisk switch\n\n if (particleCloud_.shapeTypeName() != \"multisphere\")\n forceSubM(0).setSwitchesList(10,true); // activate correctedVoidage switch\n\n // read those switches defined above, if provided in dict\n for (int iFSub=0;iFSubALARGECONCENTRATION)\n particleCloud_.registerFieldsToDEM(partSpeciesNames_[fieldI],\"scalar-atom\", partDatPositionInRegister_[fieldI],true);\n }\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\nvoid scalarGeneralExchange::setPointersToExternalArrays( word nameFlux, int positionFlux,\n word nameTransCoeff, int positionTransCoeff,\n word nameFluid, int positionFluid\n ) const\n{\n if(particleCloud_.fieldsToDEM.size() !=\n particleCloud_.namesfieldsToDEM.size()\n )\n FatalError << \"\\n\\n****CATASTROPHIC ERROR MOST LIKELY CAUSED BY USER!!! \\n\"\n << \"particleCloud_.fieldsToDEM.size() is NOT EQUAL to particleCloud_.namesfieldsToDEM.size().\"\n << \"This may be caused by an incorrect time step, or coupling interval, resulting in the fact that an array inside particleCloud_ was not allocated. \"\n << \"Please check your time step and coupling interval settings, such that fluid-particle coupling is done EVERY fluid time step. \\n\\n\"\n << abort(FatalError);\n\n if(validPartFlux_) //EXPLICIT coupling strategy for Lagrangian part\n {\n partDatFlux_ = particleCloud_.fieldsToDEM[positionFlux];\n if( forceSubM(0).verbose() ) {\n Info <<\"scalarParticleFilter will push particle fluxes to '\" << nameFlux\n << \"' (register:\" << positionFlux << \"). \\n\" << endl;\n }\n }\n\n if(validPartTransCoeff_) //IMPLICIT coupling strategy for Lagrangian part\n {\n partDatTransCoeff_ = particleCloud_.fieldsToDEM[positionTransCoeff];\n partDatFluid_ = particleCloud_.fieldsToDEM[positionFluid];\n if( forceSubM(0).verbose() ) {\n Info <<\"scalarParticleFilter will push transfer coefficients to '\" << nameTransCoeff\n << \"' (register:\" << positionTransCoeff << \"). \\n\" << endl;\n Info <<\"scalarParticleFilter will push fluid values to '\" << nameFluid\n << \"' (register:\" << positionFluid << \"). \\n\" << endl;\n }\n }\n\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/scalarGeneralExchange/scalarGeneralExchange.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n Two way general scalar exchange between DEM and CFD\n convective heat and species transfer model. The standard model is that of\n Deen, N.G. et al., Review of direct numerical simulation of \n fluid–particle mass, momentum and heat transfer in dense gas–solid flows.\n Chemical Engineering Science 116 (2014) 710–724\n This correlation is based on that of Gunn (1978).\n\n Alternatively, the correclation of\n Li and Mason (2000), A computational investigation of transient heat\n transfer in pneumatic transport of granular particles, Pow.Tech 112\n can be activated. However, this correlation is not suitable for \n dense granular flows.\n\n This model allows an implicit/explicit split of the coupling term.\n The implicit/explicit splitting is realized in a force sub-model\n\n WARNING:\n This model REQUIRES the 'generalManual' speciesTransportModel\n\nClass\n scalarGeneralExchange\n\nSourceFiles\n scalarGeneralExchange.C\n\nContributing author and copyright holder of this model/file\n Copyright, 2015 Stefan Radl, TU Graz (radl@tugraz.at)\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef scalarGeneralExchange_H\n#define scalarGeneralExchange_H\n\n#include \"forceModel.H\"\n#include \"averagingModel.H\"\n#include \"interpolationCellPoint.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class scalarGeneralExchange Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass scalarGeneralExchange\n:\n public forceModel\n{\nprotected:\n\n mutable dictionary propsDict_;\n\n const IOdictionary scalarTransportProperties_;\n\n dictionary generalPropsDict_;\n\n word voidfractionFieldName_;\n\n word velFieldName_;\n\n word tempFieldName_; \n word partTempName_;\n word partHeatFluxName_;\n word partHeatTransCoeffName_;\n word partHeatFluidName_;\n\n mutable double **partDat_; // Lagrangian array ExtCode-->CFDEM\n\n mutable double **partDatFlux_; // Lagrangian array CFDEM-->ExtCode (explicit contribution)\n mutable double **partDatTransCoeff_; // Lagrangian array CFDEM-->ExtCode (implicit contribution)\n mutable double **partDatFluid_; // Lagrangian array CFDEM-->ExtCode (implicit contribution)\n\n mutable double **partTemp_;\n\n mutable double **partDatTmpExpl_; // Lagrangian array - for explicit source to fluid eqns\n mutable double **partDatTmpImpl_; // Lagrangian array - for implicit source to fluid eqns\n\n mutable double **partDatSaturation_; // Lagrangian array\n mutable double **partCoolingFlux_;\n \n mutable bool validPartFlux_; //indicator if found, based on heat, but also used for species \n //also indicates EXplicit Coupling\n mutable bool validPartTransCoeff_; //indicator if found, based on heat, but also used for species\n //also indicates IMplicit Coupling\n mutable bool validPartFluid_; //indicator if found, based on heat, but also used for species\n\n mutable bool haveTemperatureEqn_; //indicator for temperature field or not\n\n mutable bool useLiMason_; //switch to activate calculation using Li-Mason\n mutable bool useGeneralCorrelation_; //switch to activate calculation using a generalized correlation\n mutable scalarList generalCorrelationParameters_; //parameter for general correlation\n\n scalar lambda_; // fluid thermal conductivity [W/(m*K)]\n scalar Prandtl_; // Prandtl number\n\n //Species Word Lists\n mutable wordList eulerianFieldNames_; //List with Eulerian fields to exchange (handed over)\n\n mutable scalarList particleSpeciesValue_; //list with scalar to indicate particle property is available\n const wordList partSpeciesNames_;\n const wordList partSpeciesFluxNames_;\n const wordList partSpeciesTransCoeffNames_;\n const wordList partSpeciesFluidNames_;\n\n scalarList DMolecular_; \n\n //information related to external register\n mutable labelList partDatPositionInRegister_;\n mutable int partHeatFluxPositionInRegister_;\n mutable std::vector partSpeciesFluxPositionInRegister_;\n mutable int partHeatTransCoeffPositionInRegister_;\n mutable std::vector partSpeciesTransCoeffPositionInRegister_;\n mutable int partHeatFluidPositionInRegister_;\n mutable std::vector partSpeciesFluidPositionInRegister_;\n\n //Scalar properties\n mutable scalar maxSource_; // max (limited) value of src field\n\n mutable scalar scaleDia_;\n\n void allocateMyArrays(scalar initialValue) const;\n void setupModel() const;\n void setPointersToExternalArrays( word nameFlux, int positionFlux,\n word nameTransCoeff, int positionTransCoeff,\n word nameFluid, int positionFluid\n ) const;\n\n mutable double (scalarGeneralExchange::*Nusselt)(double Re, double Pr, double voidfraction) const;\n double NusseltLiMason(double Re, double Pr, double voidfraction) const;\n double NusseltDeenEtAl(double Re, double Pr, double voidfraction) const;\n double NusseltGeneralCorrelation(double Re, double Pr, double voidfraction) const;\n\npublic:\n\n //- Runtime type information\n TypeName(\"scalarGeneralExchange\");\n\n // Constructors\n\n //- Construct from components\n scalarGeneralExchange\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n //- Construct from components\n scalarGeneralExchange\n (\n const dictionary& dict,\n cfdemCloud& sm,\n word dictName\n );\n\n // Destructor\n\n ~scalarGeneralExchange();\n\n\n // Member Functions\n void setForce() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/virtualMassForce/virtualMassForce.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"virtualMassForce.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n#define NOTONCPU 9999\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(virtualMassForce, 0);\n\naddToRunTimeSelectionTable\n(\n forceModel,\n virtualMassForce,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nvirtualMassForce::virtualMassForce\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n forceModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n velFieldName_(propsDict_.lookupOrDefault(\"velFieldName\",\"U\")),\n U_(sm.mesh().lookupObject (velFieldName_)),\n phiFieldName_(propsDict_.lookup(\"phiFieldName\")),\n phi_(sm.mesh().lookupObject (phiFieldName_)),\n UrelOldName_(propsDict_.lookupOrDefault(\"UrelOldName\",\"UrelOld\")),\n UrelOldFieldToDEMid_(-1),\n splitUrelCalculation_(false),\n Cadd_(0.5)\n{\n // suppress particle probe\n if (probeIt_ && propsDict_.found(\"suppressProbe\"))\n probeIt_=!Switch(propsDict_.lookup(\"suppressProbe\"));\n if(probeIt_)\n {\n particleCloud_.probeM().initialize(typeName, typeName+\".logDat\");\n particleCloud_.probeM().vectorFields_.append(\"virtualMassForce\"); //first entry must the be the force\n particleCloud_.probeM().vectorFields_.append(\"Urel\");\n particleCloud_.probeM().vectorFields_.append(\"UrelOld\");\n particleCloud_.probeM().vectorFields_.append(\"ddtUrel\");\n particleCloud_.probeM().scalarFields_.append(\"Vs\");\n particleCloud_.probeM().scalarFields_.append(\"rho\");\n particleCloud_.probeM().writeHeader();\n }\n\n particleCloud_.checkCG(true);\n\n // init force sub model\n setForceSubModels(propsDict_);\n\n // define switches which can be read from dict\n forceSubM(0).setSwitchesList(0,true); // activate treatExplicit switch\n forceSubM(0).setSwitchesList(1,true); // activate treatForceDEM switch (DEM side only treatment)\n forceSubM(0).setSwitchesList(4,true); // activate search for interpolate switch\n\n //set default switches (hard-coded default = false)\n forceSubM(0).setSwitches(0,true); // will treat forces explicitly on CFD side - IMPORTANT!\n\n // read those switches defined above, if provided in dict\n for (int iFSub=0;iFSub -1) // particle Found\n {\n\n if(forceSubM(0).interpolation()) \n {\n position = particleCloud_.cfdemCloud::position(index);\n Ufluid = UInterpolator_().interpolate(position,cellI);\n }\n else\n {\n Ufluid = U_[cellI];\n }\n \n\n if(splitUrelCalculation_) //if split, just use total derivative of fluid velocity\n {\n if(forceSubM(0).interpolation()) \n {\n DDtU = DDtUInterpolator_().interpolate(position,cellI);\n }\n else\n {\n DDtU = DDtU_[cellI];\n }\n }\n else\n {\n vector Us = particleCloud_.cfdemCloud::velocity(index);\n Ur = Ufluid - Us;\n }\n\n if(splitUrelCalculation_) //we can always compute the total derivative in case we split\n ddtUrel = DDtU;\n else\n { \n //Check of particle was on this CPU the last step\n if(particleCloud_.fieldsToDEM[UrelOldFieldToDEMid_][index][0]==NOTONCPU) //use 1. element to indicate that particle was on this CPU the last time step\n {\n haveUrelOld_ = false;\n ddtUrel = vector(0,0,0);\n }\n else\n haveUrelOld_ = true;\n\n for(int j=0;j<3;j++)\n {\n UrelOld[j] = particleCloud_.fieldsToDEM[UrelOldFieldToDEMid_][index][j];\n particleCloud_.fieldsToDEM[UrelOldFieldToDEMid_][index][j] = Ur[j];\n }\n if(haveUrelOld_ ) //only compute force if we have old (relative) velocity\n ddtUrel = (Ur-UrelOld)/dt;\n }\n scalar rs = particleCloud_.radius(index);\n scalar Vs = rs*rs*rs*fourPiByThree;\n scalar rho = forceSubM(0).rhoField()[cellI];\n\n virtualMassForce = Cadd_ * rho * Vs * ddtUrel;\n\n if( forceSubM(0).verbose() ) //&& index>100 && index < 105)\n {\n Pout << \"index / cellI = \" << index << tab << cellI << endl;\n Pout << \"position = \" << particleCloud_.cfdemCloud::position(index) << endl;\n }\n\n //Set value fields and write the probe\n if(probeIt_)\n {\n #include \"setupProbeModelfields.H\"\n // Note: for other than ext one could use vValues.append(x)\n // instead of setSize\n vValues.setSize(vValues.size()+1, virtualMassForce); //first entry must the be the force\n vValues.setSize(vValues.size()+1, Ur);\n vValues.setSize(vValues.size()+1, UrelOld); \n vValues.setSize(vValues.size()+1, ddtUrel);\n sValues.setSize(sValues.size()+1, Vs);\n sValues.setSize(sValues.size()+1, rho);\n particleCloud_.probeM().writeProbe(index, sValues, vValues);\n }\n }\n\n // write particle based data to global array\n forceSubM(0).partToArray(index,virtualMassForce,vector::zero);\n }\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/virtualMassForce/virtualMassForce.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n virtualMassForce\n\nSourceFiles\n virtualMassForce.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef virtualMassForce_H\n#define virtualMassForce_H\n\n#include \"forceModel.H\"\n#include \"dataExchangeModel.H\"\n#include \"interpolationCellPoint.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class virtualMassForce Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass virtualMassForce\n:\n public forceModel\n{\nprivate:\n dictionary propsDict_;\n\n word velFieldName_;\n\n const volVectorField& U_;\n\n word phiFieldName_;\n\n const surfaceScalarField& phi_;\n\n word UrelOldName_;\n\n mutable label UrelOldFieldToDEMid_;\n\n mutable bool splitUrelCalculation_; //indicator to split calculation of Urel between CFDEM and LIGGGHTS\n //requires the integration fix to take dv/dt into account!\n\n mutable double Cadd_; //indicator to split calculation of Urel between CFDEM and LIGGGHTS\n //requires the integration fix to take dv/dt into account!\n\npublic:\n\n //- Runtime type information\n TypeName(\"virtualMassForce\");\n\n\n // Constructors\n\n //- Construct from components\n virtualMassForce\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~virtualMassForce();\n\n\n // Member Functions\n void setForce() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/viscForce/viscForce.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"viscForce.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(viscForce, 0);\n\naddToRunTimeSelectionTable\n(\n forceModel,\n viscForce,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nviscForce::viscForce\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n forceModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n velocityFieldName_(propsDict_.lookupOrDefault(\"velocityFieldName\",\"U\")),\n U_(sm.mesh().lookupObject (velocityFieldName_)),\n addedMassCoeff_(0.0)\n{\n // block viscForceModel for type B\n if (modelType_ == \"B\") FatalError <<\"using model viscForce with model type B is not valid\\n\" << abort(FatalError);\n\n // suppress particle probe\n if (probeIt_ && propsDict_.found(\"suppressProbe\"))\n probeIt_=!Switch(propsDict_.lookup(\"suppressProbe\"));\n if(probeIt_)\n {\n particleCloud_.probeM().initialize(typeName, typeName+\".logDat\");\n particleCloud_.probeM().vectorFields_.append(\"viscForce\"); //first entry must the be the force\n particleCloud_.probeM().scalarFields_.append(\"Vs\");\n particleCloud_.probeM().writeHeader();\n }\n\n particleCloud_.checkCG(true);\n\n // init force sub model\n setForceSubModels(propsDict_);\n\n // define switches which can be read from dict\n forceSubM(0).setSwitchesList(0,true); // activate treatExplicit switch\n forceSubM(0).setSwitchesList(3,true); // activate search for verbose switch\n forceSubM(0).setSwitchesList(4,true); // activate search for interpolate switch\n forceSubM(0).setSwitchesList(8,true); // activate scalarViscosity switch\n\n //set default switches (hard-coded default = false)\n forceSubM(0).setSwitches(0,true); // make treatForceExplicit=true the default (is desired, otherwise this force would be implicit in slip vel!)\n if (modelType_ == \"Bfull\") // type Bfull\n forceSubM(0).setSwitches(1,false); // treatForceDEM = false\n else // type A\n forceSubM(0).setSwitches(1,true); // treatForceDEM = true\n\n // read those switches defined above, if provided in dict\n for (int iFSub=0;iFSub -1) // particle Found\n {\n rs = particleCloud_.radius(index);\n position = particleCloud_.cfdemCloud::position(index);\n\n if(forceSubM(0).interpolation()) // use intepolated values for alpha (normally off!!!)\n {\n divTau = divTauInterpolator_().interpolate(position,cellI);\n }else\n {\n divTau = divTau_[cellI];\n }\n\n Vs = particleCloud_.cfdemCloud::particleVolume(index);\n //Vs = rs*rs*rs*fourPiByThree; //change Vs calc to this after TH is clean!\n\n // calc the contribution of the deviatoric stress \n // to the generalized buoyancy force\n force = -Vs*divTau*(1.0+addedMassCoeff_);\n\n if(forceSubM(0).verbose() && index >0 && index <2)\n {\n Info << \"index = \" << index << endl;\n Info << \"gradP = \" << divTau << endl;\n Info << \"force = \" << force << endl;\n }\n\n //Set value fields and write the probe\n if(probeIt_)\n {\n #include \"setupProbeModelfields.H\"\n // Note: for other than ext one could use vValues.append(x)\n // instead of setSize\n vValues.setSize(vValues.size()+1, force); //first entry must the be the force\n sValues.setSize(sValues.size()+1, Vs);\n particleCloud_.probeM().writeProbe(index, sValues, vValues);\n }\n }\n\n // write particle based data to global array\n forceSubM(0).partToArray(index,force,vector::zero);\n }\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/viscForce/viscForce.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n -div(tau)*Vp\nClass\n viscForce\n\nSourceFiles\n viscForce.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef viscForce_H\n#define viscForce_H\n\n#include \"forceModel.H\"\n#include \"interpolationCellPoint.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class viscForce Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass viscForce\n:\n public forceModel\n{\nprivate:\n dictionary propsDict_;\n\n word velocityFieldName_;\n\n const volVectorField& U_;\n\n mutable double addedMassCoeff_; //added mass coefficient\n\n\npublic:\n\n //- Runtime type information\n TypeName(\"viscForce\");\n\n\n // Constructors\n\n //- Construct from components\n viscForce\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~viscForce();\n\n\n // Member Functions\n void setForce() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/volWeightedAverage/volWeightedAverage.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"volWeightedAverage.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \"dataExchangeModel.H\"\n#include \n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(volWeightedAverage, 0);\n\naddToRunTimeSelectionTable\n(\n forceModel,\n volWeightedAverage,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nvolWeightedAverage::volWeightedAverage\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n forceModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n mesh_(particleCloud_.mesh()),\n startTime_(propsDict_.lookupOrDefault(\"startTime\",0.)),\n scalarFieldNames_(propsDict_.lookup(\"scalarFieldNames\")),\n vectorFieldNames_(propsDict_.lookup(\"vectorFieldNames\")),\n volumeFractionName_(propsDict_.lookupOrDefault(\"volumeFractionName\",\"voidfraction\")),\n volumeFraction_(particleCloud_.mesh().lookupObject(volumeFractionName_)),\n upperThreshold_(readScalar(propsDict_.lookup(\"upperThreshold\"))),\n lowerThreshold_(readScalar(propsDict_.lookup(\"lowerThreshold\"))),\n useVolumeFraction_(propsDict_.lookupOrDefault(\"useVolumeFraction\",false)),\n verbose_(propsDict_.lookupOrDefault(\"verbose\",false)),\n path_(\"postProcessing/volWeightedAverage\"),\n sPtr_(NULL),\n writeToFile_(propsDict_.lookupOrDefault(\"writeToFile\",false))\n{\n // create vol weighted average scalar fields\n scalarFields_.setSize(scalarFieldNames_.size());\n\n for (int i=0;i < scalarFieldNames_.size(); i++)\n {\n word fieldName = \"volAverage_\" + scalarFieldNames_[i];\n\n Info<< \"Creating field \" << fieldName << endl;\n scalarFields_.set\n (\n i,\n new volScalarField\n (\n IOobject\n (\n fieldName,\n mesh_.time().timeName(),\n mesh_,\n IOobject::NO_READ,\n IOobject::AUTO_WRITE\n ),\n mesh_,\n dimensionedScalar(\"0\", mesh_.lookupObject(scalarFieldNames_[i]).dimensions(), 0)\n )\n );\n }\n\n // create vol weighted average vector fields\n vectorFields_.setSize(vectorFieldNames_.size());\n\n for (int i=0;i < vectorFieldNames_.size(); i++)\n {\n word fieldName = \"volAverage_\" + vectorFieldNames_[i];\n\n Info<< \"Creating field \" << fieldName << endl;\n vectorFields_.set\n (\n i,\n new volVectorField\n (\n IOobject\n (\n fieldName,\n mesh_.time().timeName(),\n mesh_,\n IOobject::NO_READ,\n IOobject::AUTO_WRITE\n ),\n mesh_,\n dimensionedVector(\"0\", mesh_.lookupObject(vectorFieldNames_[i]).dimensions(), vector::zero)\n )\n );\n }\n\n // create the path and generate output file\n if(writeToFile_)\n {\n path_=particleCloud_.IOM().createTimeDir(path_);\n\t sPtr_ = new OFstream(path_/\"volWeightedAverage.txt\");\n //*sPtr_ << \"time | vol av. scalar field i | ... | vol av. vector field i\" << nl;\n }\n\n particleCloud_.checkCG(true);\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nvolWeightedAverage::~volWeightedAverage()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nvoid volWeightedAverage::setForce() const\n{\n if(mesh_.time().value() >= startTime_)\n {\n if(verbose_) Info << \"volWeightedAverage.C - setForce()\" << endl;\n\n // write to file\n if(writeToFile_) *sPtr_<< mesh_.time().value() << \" \" ;\n\n for (int i=0;i < scalarFieldNames_.size(); i++)\n {\n // get reference to actual field\n const volScalarField& field = mesh_.lookupObject(scalarFieldNames_[i]);\n\n scalar fieldValue=-1.;\n scalar volWeightedAverage=-1.;\n scalar cellVol=-1.;\n scalar totVol=0.;\n scalar totVol_all=0.;\n scalar integralValue=0.;\n scalar volumeFraction(1.);\n\n forAll(field,cellI)\n {\n fieldValue = field[cellI];\n if(fieldValue < upperThreshold_ && fieldValue > lowerThreshold_)\n {\n cellVol = mesh_.V()[cellI];\n if(useVolumeFraction_)\n volumeFraction = volumeFraction_[cellI];\n scalarFields_[i][cellI] = fieldValue * cellVol * volumeFraction;\n totVol += cellVol;\n }\n else\n {\n scalarFields_[i][cellI] = 0.;\n }\n }\n\n MPI_Allreduce(&totVol, &totVol_all, 3, MPI_DOUBLE, MPI_SUM, MPI_COMM_WORLD);\n integralValue = gSum(scalarFields_[i]);\n volWeightedAverage = integralValue / (totVol_all+SMALL);\n scalarFields_[i] == dimensionedScalar(\"value\", scalarFields_[i].dimensions(), volWeightedAverage);\n\n if(verbose_)\n {\n Info << \"calculated vol. weighted average of field: \" << scalarFieldNames_[i]\n << \" = \" << volWeightedAverage\n << \",\\n integral value \"\n << \" = \" << integralValue\n << \",\\n volume accounted for \"\n << \" = \" << totVol_all\n << \",\\n considering cells where the field < \" << upperThreshold_\n << \", and > \" << lowerThreshold_ << endl;\n }\n\n // write to file\n if(writeToFile_) *sPtr_<< volWeightedAverage << \" \" ;\n }\n\n for (int i=0;i < vectorFieldNames_.size(); i++)\n {\n // get reference to actual field\n const volVectorField& field = mesh_.lookupObject(vectorFieldNames_[i]);\n\n vector fieldValue(-1.,-1.,-1.);\n vector volWeightedAverage(-1.,-1.,-1.);\n scalar magvolWeightedAverage=-1.;\n scalar cellVol=-1.;\n scalar totVol=0.;\n scalar totVol_all=0.;\n scalar volumeFraction(1.);\n\n forAll(field,cellI)\n {\n fieldValue = field[cellI];\n magvolWeightedAverage = mag(fieldValue);\n if(magvolWeightedAverage < upperThreshold_ && magvolWeightedAverage > lowerThreshold_)\n {\n cellVol = mesh_.V()[cellI];\n if(useVolumeFraction_)\n volumeFraction = volumeFraction_[cellI];\n vectorFields_[i][cellI] = fieldValue * cellVol * volumeFraction;\n totVol += cellVol;\n }\n else\n {\n vectorFields_[i][cellI] = vector::zero;\n }\n }\n\n MPI_Allreduce(&totVol, &totVol_all, 3, MPI_DOUBLE, MPI_SUM, MPI_COMM_WORLD);\n volWeightedAverage = gSum(vectorFields_[i]) / (totVol_all+SMALL);\n vectorFields_[i] == volWeightedAverage;\n\n if(verbose_)\n {\n Info << \"calculated vol. weighted average of field: \" << vectorFieldNames_[i]\n << \" = \" << volWeightedAverage\n << \",\\n considering cells where the mag(field) < \" << upperThreshold_\n << \", and > \" << lowerThreshold_ << endl;\n }\n\n // write to file\n if(writeToFile_) *sPtr_<< volWeightedAverage << \" \";\n }\n\n // write to file\n if(writeToFile_) *sPtr_<< endl;\n\n }// end if time >= startTime_\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/forceModel/volWeightedAverage/volWeightedAverage.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n calc time average of scalar or vector field\nClass\n volWeightedAverage\n\nSourceFiles\n volWeightedAverage.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef volWeightedAverage_H\n#define volWeightedAverage_H\n\n#include \"forceModel.H\"\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class volWeightedAverage Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass volWeightedAverage\n:\n public forceModel\n{\nprivate:\n\n dictionary propsDict_;\n\n const fvMesh& mesh_;\n\n scalar startTime_;\n\n const wordList scalarFieldNames_;\n\n const wordList vectorFieldNames_;\n\n const word volumeFractionName_;\n\n mutable PtrList scalarFields_;\n\n mutable PtrList vectorFields_;\n\n const volScalarField& volumeFraction_;\n\n mutable scalar upperThreshold_;\n\n mutable scalar lowerThreshold_;\n\n Switch useVolumeFraction_;\n\n Switch verbose_;\n\n mutable fileName path_;\n\n mutable OFstream* sPtr_;\n\n Switch writeToFile_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"volWeightedAverage\");\n\n\n // Constructors\n\n //- Construct from components\n volWeightedAverage\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~volWeightedAverage();\n\n\n // Member Functions\n void setForce() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/execute/execute.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"execute.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(execute, 0);\n\naddToRunTimeSelectionTable\n(\n liggghtsCommandModel,\n execute,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nexecute::execute\n(\n const dictionary& dict,\n cfdemCloud& sm,\n int i\n)\n:\n liggghtsCommandModel(dict,sm,i),\n nrModel_(i),\n myName_(\"notYetGiven\"),\n propsDict_(dict),\n commandList_(0),\n command_(\"\"),\n scalarList_(0),\n labelList_(0)\n{\n // define dictionary\n char h[80];\n sprintf(h,\"%d\",nrModel_);\n myName_=word(typeName + \"Props\" + h);\n propsDict_=dictionary(dict.subDict(myName_));\n\n // read command from dict\n commandList_ = wordList(propsDict_.lookup(\"command\"));\n\n // read list of scalars\n if(propsDict_.found(\"scalars\")) scalarList_ = scalarList(propsDict_.lookup(\"scalars\"));\n\n // read list of labels\n if(propsDict_.found(\"labels\")) labelList_ = labelList(propsDict_.lookup(\"labels\"));\n\n // check if verbose\n if (propsDict_.found(\"verbose\")) verbose_=true;\n\n parseCommandList(commandList_, labelList_, scalarList_, command_, propsDict_, timeStamp_);\n Info << \"liggghtsCommand \" << command_ << endl;\n\n strCommand_=string(command_);\n\n checkTimeMode(propsDict_);\n\n checkTimeSettings(propsDict_);\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nexecute::~execute()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nconst char* execute::command(int commandLine)\n{\n return strCommand_.c_str();\n}\n\nbool execute::runCommand(int couplingStep)\n{\n if(timeStamp_) strCommand_=addTimeStamp(command_);\n checkTimeSettings(propsDict_);\n\n return runThisCommand(couplingStep);\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/execute/execute.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n execute a liggghts command\nClass\n execute\n\nSourceFiles\n execute.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef execute_H\n#define execute_H\n\n#include \"liggghtsCommandModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class execute Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass execute\n:\n public liggghtsCommandModel\n{\nprivate:\n\n int nrModel_;\n\n word myName_;\n\n dictionary propsDict_;\n\n wordList commandList_;\n\n word command_;\n\n scalarList scalarList_;\n\n labelList labelList_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"execute\");\n\n\n // Constructors\n\n //- Construct from components\n execute\n (\n const dictionary& dict,\n cfdemCloud& sm,\n int i\n );\n\n // Destructor\n\n ~execute();\n\n\n // Member Functions\n\n word name(){return myName_;};\n\n const char* command(int);\n\n bool runCommand(int);\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/liggghtsCommandModel/liggghtsCommandModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n#include \n#include \"liggghtsCommandModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(liggghtsCommandModel, 0);\n\ndefineRunTimeSelectionTable(liggghtsCommandModel, dictionary);\n\n// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nliggghtsCommandModel::liggghtsCommandModel\n(\n const dictionary& dict,\n cfdemCloud& sm,\n int i\n)\n:\n dict_(dict),\n particleCloud_(sm),\n strCommand_(\"notDefined\"),\n nextRun_(-1),\n lastRun_(-1),\n runFirst_(false),\n runLast_(false),\n runEveryCouplingStep_(false),\n runEveryWriteStep_(false),\n startTime_(-1.),\n endTime_(-1.),\n timeInterval_(0.),\n firstCouplingStep_(-1),\n lastCouplingStep_(-1),\n couplingStepInterval_(0),\n exactTiming_(false),\n commandLines_(1),\n verbose_(false),\n timeStamp_(false)\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nliggghtsCommandModel::~liggghtsCommandModel()\n{}\n\n// * * * * * * * * * * * * * * * * Member Fct * * * * * * * * * * * * * * * //\n\nvoid liggghtsCommandModel::checkTimeMode(dictionary& propsDict)\n{\n runFirst_=Switch(propsDict.lookup(\"runFirst\"));\n\n if(!runFirst_)\n {\n // check if being run only at last coupling step\n runLast_=Switch(propsDict.lookup(\"runLast\"));\n\n if(!runLast_)\n {\n // check if being run every coupling step\n runEveryCouplingStep_=Switch(propsDict.lookup(\"runEveryCouplingStep\"));\n\n if(!runEveryCouplingStep_)\n {\n runEveryWriteStep_=Switch(propsDict.lookup(\"runEveryWriteStep\"));\n }\n }\n }\n if(verbose_){\n Info << \"runFirst = \" << runFirst_ << endl;\n Info << \"runLast = \" << runLast_ << endl;\n Info << \"runEveryCouplingStep = \" << runEveryCouplingStep_ << endl;\n Info << \"runEveryWriteStep = \" << runEveryWriteStep_ << endl;\n }\n}\n\nvoid liggghtsCommandModel::checkTimeSettings(const dictionary& propsDict)\n{\n if(!runFirst_) //lastRun or runEveryCouplingStep or every n steps or every writeStep\n {\n scalar DEMts = particleCloud_.dataExchangeM().DEMts();\n scalar couplingInterval = particleCloud_.dataExchangeM().couplingInterval();\n scalar simStartTime = particleCloud_.mesh().time().startTime().value();\n\n if(runLast_) // last run\n {\n // read time options from subdict\n endTime_ = particleCloud_.mesh().time().endTime().value()-simStartTime;\n startTime_ = endTime_;\n timeInterval_ = -1;\n\n // calculate coupling times\n firstCouplingStep_ = floor((startTime_+SMALL)/DEMts/couplingInterval);\n lastCouplingStep_ = floor((endTime_+SMALL)/DEMts/couplingInterval);\n couplingStepInterval_ = -1;\n }\n else //runEveryCouplingStep of every n steps or every writeStep\n {\n if (!runEveryCouplingStep_ && !runEveryWriteStep_) // every n steps\n {\n // read time options from subdict\n startTime_ = readScalar(propsDict.lookup(\"startTime\"));\n endTime_ = readScalar(propsDict.lookup(\"endTime\"));\n timeInterval_ = readScalar(propsDict.lookup(\"timeInterval\"));\n\n // calculate coupling times\n firstCouplingStep_ = floor((startTime_+SMALL-simStartTime)/DEMts/couplingInterval);\n lastCouplingStep_ = floor((endTime_+SMALL-simStartTime)/DEMts/couplingInterval);\n couplingStepInterval_ = floor(timeInterval_+SMALL/DEMts/couplingInterval);\n }\n else //runEveryCouplingStep or writeStep\n {\n firstCouplingStep_ =1;\n lastCouplingStep_ =1e9;\n couplingStepInterval_ =1;\n }\n }\n }\n else // runFirst\n {\n firstCouplingStep_ =1;\n lastCouplingStep_ =1;\n couplingStepInterval_ =-1;\n }\n\n if(verbose_){\n Info << \"firstCouplingStep = \" << firstCouplingStep_ << endl;\n Info << \"lastCouplingStep = \" << lastCouplingStep_ << endl;\n Info << \"couplingStepInterval = \" << couplingStepInterval_ << endl;\n Info << \"nextRun = \" << nextRun_ << endl;\n }\n}\n\nbool liggghtsCommandModel::runThisCommand(int couplingStep)\n{\n if(verbose_) Info << \"couplingStep = \" << couplingStep << endl;\n bool runIt=false;\n if(\n (!runEveryWriteStep_ && firstCouplingStep_ <= couplingStep && lastCouplingStep_ >= couplingStep) ||\n (runEveryWriteStep_ && particleCloud_.mesh().time().outputTime()) || // classic handling for !subTS\n (runEveryWriteStep_ && particleCloud_.writeTimePassed()) // special handling for subTS (will not allow >1 commands at writeTime)\n )\n {\n if(couplingStep >= nextRun_)\n {\n runIt=true;\n nextRun_=couplingStep + couplingStepInterval_;\n lastRun_=couplingStep;\n\n if(runEveryWriteStep_ && particleCloud_.writeTimePassed()) particleCloud_.resetWriteTimePassed();\n }\n }\n return runIt;\n}\n\nstring liggghtsCommandModel::addTimeStamp(word command)\n{\n char add[100];\n sprintf(add,\"%f\",particleCloud_.mesh().time().value());\n\n return string(command+add);\n}\n\nDynamicList liggghtsCommandModel::executionsWithinPeriod(scalar TSstart,scalar TSend)\n{\n Info << \"liggghtsCommandModel::executionsWithinPeriod TSstart\" << TSstart << endl;\n Info << \"liggghtsCommandModel::executionsWithinPeriod TSend\" << TSend << endl;\n Info << \"startTime =\" << startTime_ << endl;\n Info << \"endTime =\" << endTime_ << endl;\n\n // init exec times array\n DynamicList executions(0);\n\n // current TS within active period\n if(startTime_+SMALLTSstart-SMALL )\n {\n Info << \"working time within this TS\" << endl;\n\n // find first execution within TS (better routine with modulo)\n int startNr = 0;\n scalar t = startTime_ + startNr * timeInterval_;\n\n if(timeInterval_ > SMALL)\n {\n while (TSend - t > SMALL)\n {\n t = startTime_ + startNr * timeInterval_;\n startNr++;\n }\n t -= timeInterval_;\n }\n // check if first exec found within TS\n if(TSstart < t + SMALL && t +SMALL < TSend)\n {\n // check for more executions\n while (t < endTime_ + SMALL && TSend - t > SMALL)\n {\n executions.append(t);\n t += timeInterval_;\n }\n }\n //else\n // Info << \"liggghtsCommandModel::executionsWithinPeriod error???\" << endl; \n\n // debug\n Info << \"liggghtsCommandModel::executionsWithinPeriod executions=\" << executions << endl;\n }\n\n // return dummy\n\n return executions;\n}\n\nbool liggghtsCommandModel::checkPath(fileName path)\n{\n string strPath = string(path);\n struct stat buffer; \n return (stat (strPath.c_str(), &buffer) == 0); \n}\n\n\nvoid liggghtsCommandModel::parseCommandList(wordList& commandList,labelList& labelList,\n scalarList& scalarList,\n word& command, dictionary& propsDict, \n bool& timeStamp)\n{\n bool addBlank = true; // std no blanks after each word\n fileName add;\n label numberCount=0; // nr of scalars inserted to command\n label labelCount=0; // nr of labels inserted to command\n\n forAll(commandList,i)\n {\n add = word(commandList[i]);\n\n //- handle symbols\n if (add == \"$couplingInterval\")\n {\n char h[50];\n sprintf(h,\"%d\",particleCloud_.dataExchangeM().couplingInterval());\n add = h;\n }\n else if (add==\"dot\") add = \".\";\n else if (add==\"dotdot\") add = \"..\";\n else if (add==\"slash\") add = \"/\";\n else if (add==\"noBlanks\") // no blanks after the following words\n {\n add = \"\";\n addBlank = false;\n }else if (add==\"blanks\") // add a blank here and after the following words\n {\n add = \"\";\n addBlank = true;\n }else if (add==\"timeStamp\") // next command will be a number read from labelList\n {\n add = \"\";\n timeStamp=true;\n }else if (add==\"number\") // next command will be a number read from labelList\n {\n /*if (!propsDict.found(\"scalars\"))\n {\n FatalError<<\"you want to use a number in the command\\n - specify a scalar list with all numbers\"\n << abort(FatalError);\n }*/\n char h[50];\n sprintf(h,\"%f\",scalarList[numberCount]);\n add = h;\n numberCount ++;\n }else if (add==\"label\") // next command will be a number read from labelList\n {\n /*if (!propsDict.found(\"labels\"))\n {\n FatalError<<\"you want to use a label in the command\\n - specify a label list with all numbers\"\n << abort(FatalError);\n }*/\n char h[50];\n sprintf(h,\"%d\",labelList[labelCount]);\n add = h;\n labelCount ++;\n }\n\n // compose command\n if (addBlank)\n {\n command += add + \" \";\n }else\n {\n command += add;\n }\n }\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/liggghtsCommandModel/liggghtsCommandModel.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n liggghtsCommandModel\n\nSourceFiles\n liggghtsCommandModel.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef liggghtsCommandModel_H\n#define liggghtsCommandModel_H\n\n#include \"fvCFD.H\"\n#include \"cfdemCloud.H\"\n#include \"dataExchangeModel.H\"\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class liggghtsCommandModel Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass liggghtsCommandModel\n{\n\nprotected:\n\n // Protected data\n const dictionary& dict_;\n\n cfdemCloud& particleCloud_;\n\n string strCommand_;\n\n int nextRun_;\n\n int lastRun_;\n\n Switch runFirst_;\n\n Switch runLast_;\n\n Switch runEveryCouplingStep_;\n\n Switch runEveryWriteStep_;\n\n scalar startTime_;\n\n scalar endTime_;\n\n scalar timeInterval_;\n\n int firstCouplingStep_;\n\n int lastCouplingStep_;\n\n int couplingStepInterval_;\n\n bool exactTiming_;\n\n label commandLines_;\n\n bool verbose_;\n\n bool timeStamp_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"liggghtsCommandModel\");\n\n // Declare runtime constructor selection table\n\n\n declareRunTimeSelectionTable\n (\n autoPtr,\n liggghtsCommandModel,\n dictionary,\n (\n const dictionary& dict,\n cfdemCloud& sm,\n int i\n ),\n (dict,sm,i)\n );\n\n\n // Constructors\n\n //- Construct from components\n liggghtsCommandModel\n (\n const dictionary& dict,\n cfdemCloud& sm,\n int i\n );\n\n\n // Destructor\n\n virtual ~liggghtsCommandModel();\n\n\n // Selector\n\n static autoPtr New\n (\n const dictionary& dict,\n cfdemCloud& sm,\n word liggghtsCommandType,\n int i\n );\n\n\n // Member Functions\n\n virtual const char* command(int)=0;\n\n void checkTimeMode(dictionary&);\n\n void checkTimeSettings(const dictionary&);\n\n virtual bool runCommand(int)=0;\n\n bool runThisCommand(int);\n\n string addTimeStamp(word);\n\n virtual void set(int){};\n\n DynamicList executionsWithinPeriod(scalar,scalar);\n\n bool checkPath(fileName);\n\n // Access\n\n int nextRun(){return nextRun_;};\n\n int lastRun(){return lastRun_;};\n\n virtual word name()=0;\n\n bool exactTiming(){return exactTiming_;};\n\n label commandLines(){return commandLines_;};\n\n void parseCommandList(wordList&, labelList&, scalarList&, word&, dictionary&, bool& timeStamp);\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/liggghtsCommandModel/newLiggghtsCommandModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"liggghtsCommandModel.H\"\n#include \"execute.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\nautoPtr liggghtsCommandModel::New\n(\n const dictionary& dict,\n cfdemCloud& sm,\n word liggghtsCommandType,\n int i\n)\n{\n Info<< \"Selecting liggghtsCommandModel \"\n << liggghtsCommandType << \" ,provide dicts, numbered from 0 to n\" << endl;\n\n dictionaryConstructorTable::iterator cstrIter =\n dictionaryConstructorTablePtr_->find(liggghtsCommandType);\n\n if (cstrIter == dictionaryConstructorTablePtr_->end())\n {\n FatalError\n << \"liggghtsCommandModel::New(const dictionary&, const spray&) : \"\n << endl\n << \" unknown liggghtsCommandModelType type \"\n << liggghtsCommandType\n << \", constructor not in hash table\" << endl << endl\n << \" Valid liggghtsCommandModel types are :\"\n << endl;\n Info<< dictionaryConstructorTablePtr_->toc()\n << abort(FatalError);\n }\n\n return autoPtr(cstrIter()(dict,sm,i));\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/readLiggghtsData/readLiggghtsData.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"readLiggghtsData.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(readLiggghtsData, 0);\n\naddToRunTimeSelectionTable\n(\n liggghtsCommandModel,\n readLiggghtsData,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nreadLiggghtsData::readLiggghtsData\n(\n const dictionary& dict,\n cfdemCloud& sm,\n int i\n)\n:\n liggghtsCommandModel(dict,sm,i),\n nrModel_(i),\n insertionNr_(0.),\n command_(\"read_data\"),\n myName_(\"notYetGiven\"),\n propsDict_(dict),\n filePathList_(0)\n{\n // define dictionary\n char h[80];\n sprintf(h,\"%d\",nrModel_);\n myName_=word(typeName + \"Props\" + h);\n propsDict_=dictionary(dict.subDict(myName_));\n\n if (propsDict_.found(\"exactTiming\"))\n exactTiming_=true;\n Info << \"exactTiming==\" << exactTiming_ << endl;\n\n if (propsDict_.found(\"verbose\")) verbose_=true;\n\n // read first index of data file to be injected\n insertionNr_=readScalar(propsDict_.lookup(\"startIndex\"));\n\n // read command from dict\n filePathList_ = wordList(propsDict_.lookup(\"filePath\"));\n\n command_ += \" \";\n forAll(filePathList_,i)\n {\n fileName add = filePathList_[i];\n\n //- handle symbols\n if (add==\"dot\") add = \".\";\n else if (add==\"dotdot\") add = \"..\";\n else if (add==\"slash\") add = \"/\";\n\n // compose command\n command_ += add;\n }\n\n checkTimeMode(propsDict_);\n\n checkTimeSettings(propsDict_);\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nreadLiggghtsData::~readLiggghtsData()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\nconst char* readLiggghtsData::command(int commandLine)\n{\n char h[50];\n sprintf(h,\"_%d\",insertionNr_);\n word add = h;\n insertionNr_++;\n strCommand_=string(command_ + add + \" add\");\n\n return strCommand_.c_str();\n}\n\nbool readLiggghtsData::runCommand(int couplingStep)\n{\n checkTimeSettings(propsDict_);\n return runThisCommand(couplingStep);\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/readLiggghtsData/readLiggghtsData.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n readLiggghtsData\n\nSourceFiles\n readLiggghtsData.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef readLiggghtsData_H\n#define readLiggghtsData_H\n\n#include \"liggghtsCommandModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class readLiggghtsData Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass readLiggghtsData\n:\n public liggghtsCommandModel\n{\nprivate:\n\n int nrModel_;\n\n int insertionNr_;\n\n word command_;\n\n word myName_;\n\n dictionary propsDict_;\n\n wordList filePathList_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"readLiggghtsData\");\n\n\n // Constructors\n\n //- Construct from components\n readLiggghtsData\n (\n const dictionary& dict,\n cfdemCloud& sm,\n int i\n );\n\n // Destructor\n\n ~readLiggghtsData();\n\n\n // Member Functions\n\n word name(){return myName_;};\n\n const char* command(int);\n\n bool runCommand(int);\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/runLiggghts/runLiggghts.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"runLiggghts.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(runLiggghts, 0);\n\naddToRunTimeSelectionTable\n(\n liggghtsCommandModel,\n runLiggghts,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nrunLiggghts::runLiggghts\n(\n const dictionary& dict,\n cfdemCloud& sm,\n int i\n)\n:\n liggghtsCommandModel(dict,sm,i),\n propsDict_(dict),\n command_(\"run\"),\n preNo_(false),\n stdInterval_(0)\n{\n word myName=word(typeName + \"Props\");\n if (dict.found(myName)) \n {\n propsDict_=dictionary(dict.subDict(myName));\n preNo_=Switch(propsDict_.lookup(\"preNo\"));\n\n // check if verbose\n if (propsDict_.found(\"verbose\")) verbose_=true;\n }\n\n runEveryCouplingStep_=true;\n\n strCommand_=createCommand(command_);\n\n //this allows to do run command only once, better use checkTimeMode(propsDict_) to get all options\n runFirst_=Switch(propsDict_.lookupOrDefault(\"runFirst\",false));\n if(runFirst_) lastCouplingStep_ = firstCouplingStep_;\n\n checkTimeSettings(dict_);\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nrunLiggghts::~runLiggghts()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nconst char* runLiggghts::command(int commandLine)\n{\n return strCommand_.c_str();\n}\n\nstring runLiggghts::createCommand( word command, int interval, word appendix, word appendix2, word appendix3, word appendix4)\n{\n fileName add;\n char h[50];\n sprintf(h,\"%d\",interval);\n add = h;\n command += \" \" + add + \" \" + appendix + \" \" + appendix2 + \" \" + appendix3 + \" \" + appendix4;\n\n return string(command);\n}\n\nbool runLiggghts::runCommand(int couplingStep)\n{\n if(couplingStep <= lastCouplingStep_)\n {\n //change command to \"run xxx pre no\"\n if (preNo_ && (couplingStep > firstCouplingStep_))\n strCommand_=createCommand(command_, particleCloud_.dataExchangeM().couplingInterval(),\"pre\",\"no\",\"post\",\"no\");\n else\n strCommand_=createCommand(command_, particleCloud_.dataExchangeM().couplingInterval());\n }else strCommand_=createCommand(command_, 0);\n \n return runThisCommand(couplingStep);\n}\n\nvoid runLiggghts::set(int interval)\n{\n if (preNo_)\n strCommand_ = createCommand(command_, interval,\"pre\",\"no\",\"post\",\"no\");\n else\n strCommand_ = createCommand(command_, interval);\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/runLiggghts/runLiggghts.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n execute the liggghts command run $nrSteps\n\nClass\n runLiggghts\n\nSourceFiles\n runLiggghts.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef runLiggghts_H\n#define runLiggghts_H\n\n#include \"liggghtsCommandModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class runLiggghts Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass runLiggghts\n:\n public liggghtsCommandModel\n{\nprivate:\n dictionary propsDict_;\n\n word command_;\n\n bool preNo_;\n\n int stdInterval_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"runLiggghts\");\n\n\n // Constructors\n\n //- Construct from components\n runLiggghts\n (\n const dictionary& dict,\n cfdemCloud& sm,\n int i\n );\n\n // Destructor\n\n ~runLiggghts();\n\n\n // Member Functions\n\n const char* command(int);\n\n string createCommand(word=\"\",int=0,word=\"\",word=\"\",word=\"\",word=\"\");\n\n bool runCommand(int);\n\n word name(){return \"runLiggghts\";};\n\n void set(int);\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/setDEMGravity/setDEMGravity.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"setDEMGravity.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(setDEMGravity, 0);\n\naddToRunTimeSelectionTable\n(\n liggghtsCommandModel,\n setDEMGravity,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nsetDEMGravity::setDEMGravity\n(\n const dictionary& dict,\n cfdemCloud& sm,\n int i\n)\n:\n liggghtsCommandModel(dict,sm,i),\n propsDict_(dict),\n nrModel_(i),\n insertionNr_(0.),\n command_(0),\n filePathList_(100),\n scalarList_(40),\n labelList_(1),\n #if defined(version21) || defined(version16ext)\n g_(sm.mesh().lookupObject (\"g\")),\n #elif defined(version15)\n g_(dimensionedVector(sm.mesh().lookupObject(\"environmentalProperties\").lookup(\"g\")).value()),\n #endif\n unfix_(false)\n{\n // define dictionary\n char h[80];\n sprintf(h,\"%d\",nrModel_);\n word myName_=word(typeName + \"Props\" + h);\n propsDict_=dictionary(dict.subDict(myName_));\n\n // read unfix flag\n unfix_=Switch(propsDict_.lookupOrDefault(\"unfix\",false));\n\n if (propsDict_.found(\"exactTiming\"))\n exactTiming_=true;\n Info << \"exactTiming==\" << exactTiming_ << endl;\n\n if (propsDict_.found(\"verbose\")) verbose_=true;\n\n scalar gNorm=mag(g_.value());\n vector g=g_.value()/mag(g_.value());\n\n\n //=======================================\n // create command\n\n if(unfix_)\n {\n filePathList_[0] = \"unfix\";\n filePathList_[1] = \"gravity\";\n }\n else\n {\n filePathList_[0] = \"fix\";\n filePathList_[1] = \"gravity\";\n filePathList_[2] = \"all\";\n filePathList_[3] = \"gravity\";\n filePathList_[4] = \"number\";\n filePathList_[5] = \"vector\";\n filePathList_[6] = \"number\";\n filePathList_[7] = \"number\";\n filePathList_[8] = \"number\";\n scalarList_[0]=gNorm;\n scalarList_[1]=g[0];\n scalarList_[2]=g[1];\n scalarList_[3]=g[2];\n }\n\n command_=wordList(1);\n\n parseCommandList(filePathList_, labelList_, scalarList_, command_[0], propsDict_, timeStamp_);\n Info << \"liggghtsCommand \" << command_[0] << endl;\n\n checkTimeSettings(propsDict_);\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nsetDEMGravity::~setDEMGravity()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\nconst char* setDEMGravity::command(int commandLine)\n{\nInfo << \"commandLine=\" << commandLine << endl;\n strCommand_=string(command_[commandLine]);\n \n return strCommand_.c_str();\n}\n\nbool setDEMGravity::runCommand(int couplingStep)\n{\n checkTimeSettings(propsDict_);\n return runThisCommand(couplingStep);\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/setDEMGravity/setDEMGravity.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n setDEMGravity\n\nSourceFiles\n setDEMGravity.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef setDEMGravity_H\n#define setDEMGravity_H\n\n#include \"liggghtsCommandModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class setDEMGravity Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass setDEMGravity\n:\n public liggghtsCommandModel\n{\nprivate:\n\n dictionary propsDict_;\n\n int nrModel_;\n\n int insertionNr_;\n\n wordList command_;\n\n wordList filePathList_;\n\n scalarList scalarList_;\n\n labelList labelList_;\n\n #ifdef version21\n const uniformDimensionedVectorField& g_; // ref to gravity\n #elif defined(version16ext) || defined(version15)\n const dimensionedVector& g_; // ref to gravity\n #endif\n\n Switch unfix_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"setDEMGravity\");\n\n\n // Constructors\n\n //- Construct from components\n setDEMGravity\n (\n const dictionary& dict,\n cfdemCloud& sm,\n int i\n );\n\n // Destructor\n\n ~setDEMGravity();\n\n\n // Member Functions\n\n word name(){return typeName;};\n\n const char* command(int);\n\n bool runCommand(int);\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/writeLiggghts/writeLiggghts.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"writeLiggghts.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(writeLiggghts, 0);\n\naddToRunTimeSelectionTable\n(\n liggghtsCommandModel,\n writeLiggghts,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nwriteLiggghts::writeLiggghts\n(\n const dictionary& dict,\n cfdemCloud& sm,\n int i\n)\n:\n liggghtsCommandModel(dict,sm,i),\n propsDict_(dict),\n command_(\"write_restart\"),\n path_(word(\"..\")/word(\"DEM\")),\n writeName_(\"liggghts.restartCFDEM\"),\n writeLastOnly_(false),\n overwrite_(false),\n writeEvery_(1),\n counter_(-1)\n{\n if (dict.found(typeName + \"Props\")) \n {\n Info << \" Found a dictionary \" << word(typeName + \"Props\") << \", reading user defined values (if specified):\" << endl;\n propsDict_=dictionary(dict.subDict(typeName + \"Props\"));\n\n // check if verbose\n if (propsDict_.found(\"verbose\")) verbose_=true;\n\n if(propsDict_.found(\"writeLastOnly\"))\n {\n writeLastOnly_=Switch(propsDict_.lookup(\"writeLastOnly\"));\n }\n if(propsDict_.found(\"writeLast\")) FatalError<<\"You are using the old style variable name - this keyword has changed to .\" << abort(FatalError);\n\n if (propsDict_.found(\"path\"))\n {\n path_=fileName(propsDict_.lookup(\"path\"));\n if (!checkPath(path_))\n FatalError<<\"The path you provided in writeLiggghtsProps is incorrect: \" << path_ << \"\\n\" << abort(FatalError);\n else\n Info << \" Using user defined path to write LIGGGHTS restart file: \" << path_ << endl;\n }\n\n if(propsDict_.found(\"writeName\"))\n {\n propsDict_.lookup(\"writeName\") >> writeName_;\n }\n\n if(propsDict_.found(\"writeEvery\"))\n {\n propsDict_.lookup(\"writeEvery\") >> writeEvery_;\n if(writeEvery_<1) FatalError << \"writeEvery must be chosen > 0\" << abort(FatalError);\n }\n\n overwrite_=Switch(propsDict_.lookup(\"overwrite\"));\n }\n else\n {\n Info << \" Did not find a dictionary \" << word(typeName + \"Props\") << \", using default values:\" << endl;\n }\n\n if(writeLastOnly_)\n runLast_=true;\n else\n {\n //Warning << \"Using invalid options of writeLiggghts, please use 'writeLast' option.\" << endl;\n runEveryWriteStep_=true;\n } \n\n command_ += \" \" + path_ + \"/\" + writeName_;\n if(overwrite_)\n strCommand_=string(command_);\n else\n command_ += \"_\";\n\n // output for user\n Info << \" overwrite = \" << Switch(overwrite_) << endl;\n Info << \" path = \" << path_ << endl;\n if(overwrite_) Info << \" writeName = \" << writeName_ << \" (Restart file is written to \" << command_ << \" .\" << endl;\n else Info << \" writeName = \" << writeName_ << \" (Restart file is written to \" << command_ << \" .\" << endl;\n Info << \" writeLastOnly = \" << writeLastOnly_ << endl;\n Info << \" writeEvery = \" << writeEvery_ << \" (Restart file is written every \" << writeEvery_ \n << \" CFD's writeInterval.)\" << endl;\n Info << \" verbose = \" << Switch(verbose_) << endl;\n\n checkTimeSettings(dict_);\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nwriteLiggghts::~writeLiggghts()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nconst char* writeLiggghts::command(int commandLine)\n{\n return strCommand_.c_str();\n}\n\nbool writeLiggghts::runCommand(int couplingStep)\n{\n if(!overwrite_) strCommand_=addTimeStamp(command_);\n if(particleCloud_.writeTimePassed()) counter_ = counter_+1;\n label writeInterval = counter_ % writeEvery_;\n bool a=runThisCommand(couplingStep); // needs to be called as it triggers resetWriteTimePassed()\n if(writeInterval == 0) return a;\n else return 0;\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/writeLiggghts/writeLiggghts.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\n execute the liggghts command write_restart\n\nClass\n writeLiggghts\n\nSourceFiles\n writeLiggghts.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef writeLiggghts_H\n#define writeLiggghts_H\n\n#include \"liggghtsCommandModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class writeLiggghts Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass writeLiggghts\n:\n public liggghtsCommandModel\n{\nprivate:\n\n dictionary propsDict_;\n\n word command_;\n\n fileName path_;\n\n fileName writeName_;\n\n Switch writeLastOnly_;\n\n Switch overwrite_;\n\n label writeEvery_;\n\n label counter_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"writeLiggghts\");\n\n\n // Constructors\n\n //- Construct from components\n writeLiggghts\n (\n const dictionary& dict,\n cfdemCloud& sm,\n int i\n );\n\n // Destructor\n\n ~writeLiggghts();\n\n\n // Member Functions\n\n const char* command(int);\n\n bool runCommand(int);\n\n word name(){return \"writeLiggghts\";};\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/locateModel/engineSearch/engineSearch.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n#include \"error.H\"\n\n#include \"engineSearch.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(engineSearch, 0);\n\naddToRunTimeSelectionTable\n(\n locateModel,\n engineSearch,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nengineSearch::engineSearch\n(\n const dictionary& dict,\n cfdemCloud& sm,\n word name\n)\n:\n locateModel(dict,sm),\n propsDict_(dict.subDict(name == \"\" ? typeName + \"Props\" : name + \"Props\")),\n treeSearch_(propsDict_.lookupOrDefault(\"treeSearch\", true)),\n #if defined(version30)\n searchEngine_(particleCloud_.mesh(),polyMesh::FACE_PLANES)\n #elif defined(version21)\n searchEngine_(particleCloud_.mesh(),polyMesh::FACEPLANES) // FACEPLANES or FACECENTRETETS; FACEDIAGTETS not stable\n #elif defined(version16ext)\n searchEngine_(particleCloud_.mesh(),false) //(particleCloud_.mesh(),faceDecomp_)\n #endif\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nengineSearch::~engineSearch()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nlabel engineSearch::findCell\n(\n double** const& mask,\n double**& positions,\n double**& cellIDs,\n int size,\n bool checkRad\n) const\n{\n vector position;\n for(int index = 0;index < size; ++index)\n {\n if(!checkRad || particleCloud_.radius(index) > SMALL)\n {\n // create pos vector\n for(int i=0;i<3;i++) position[i] = positions[index][i];\n\n cellIDs[index][0] = searchEngine_.findCell(position,-1,treeSearch_);\n\n // give it another try with CELL_TETS (very expensive)\n //if(cellIDs[index][0]==-1) cellIDs[index][0] = particleCloud_.mesh().findCell(position,polyMesh::CELL_TETS);\n }\n else cellIDs[index][0] = -1;\n }\n return 1;\n}\n\nlabel engineSearch::findSingleCell\n(\n vector& position,\n label& oldCellID\n) const\n{\n label cellI = searchEngine_.findCell(position,oldCellID,treeSearch_);\n\n // give it another try with CELL_TETS (very expensive)\n //if(cellI==-1) cellI = particleCloud_.mesh().findCell(position,polyMesh::CELL_TETS);\n\n return cellI;\n}\n\nlabel engineSearch::intersection\n(\n const point& pStart,\n const point& pEnd\n) const\n{\n // find intersection with boundary\n label face = searchEngine_.findNearestBoundaryFace(pEnd);\n\n // try alternative\n if (face==-1)\n {\n face = searchEngine_.intersection(pStart,pEnd).index();\n\n if (face==-1 && mag(pStart-point(0,0,0))\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(engineSearchIB, 0);\n\naddToRunTimeSelectionTable\n(\n engineSearch,\n engineSearchIB,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nengineSearchIB::engineSearchIB\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n engineSearch(dict,sm,typeName),\n zSplit_(propsDict_.lookupOrDefault(\"zSplit\",8)),\n xySplit_(propsDict_.lookupOrDefault(\"xySplit\",16)),\n coef_(2.0),\n verbose_(propsDict_.lookupOrDefault(\"verbose\", false)),\n numberOfSatellitePoints_((zSplit_-1)*xySplit_ + 2)\n{\n bbPtr_.reset(new boundBox(particleCloud_.mesh().points(), false));\n if(verbose_)\n {\n Pout<<\"MinBounds (x,y,z): \"< SMALL)\n if(radius > SMALL)\n {\n // create pos vector\n for(int i=0;i<3;i++) position[i] = positions[index][i];\n\n bool isInside = isInsideRectangularDomain(position, coef_*radius);\n\n if(!isInside && checkPeriodicCells)\n {\n vector positionCenterPeriodic;\n for(int xDir=-1*particleCloud_.wall_periodicityCheckRange(0); \n xDir<=particleCloud_.wall_periodicityCheckRange(0); \n xDir++)\n {\n positionCenterPeriodic[0] = position[0]\n + static_cast(xDir)\n * (globalBb.max()[0]-globalBb.min()[0]);\n for(int yDir=-1*particleCloud_.wall_periodicityCheckRange(1); \n yDir<=particleCloud_.wall_periodicityCheckRange(1); \n yDir++)\n {\n positionCenterPeriodic[1] = position[1]\n + static_cast(yDir)\n * (globalBb.max()[1]-globalBb.min()[1]);\n for(int zDir=-1*particleCloud_.wall_periodicityCheckRange(2); \n zDir<=particleCloud_.wall_periodicityCheckRange(2); \n zDir++)\n {\n positionCenterPeriodic[2] = position[2]\n + static_cast(zDir)\n * (globalBb.max()[2]-globalBb.min()[2]);\n isInside = isInsideRectangularDomain(positionCenterPeriodic, coef_*radius);\n if(isInside) break;\n }\n if(isInside) break;\n }\n if(isInside) break;\n }\n }\n\n\n if(isInside)\n {\n // find cell\n label oldID = cellIDs[index][0];\n cellIDs[index][0] = findSingleCell(position,oldID);\n\n if(cellIDs[index][0] < 0)\n {\n label altStartPos = -1;\n\n for(unsigned int countPoints = 0; countPoints < satellitePoints_.size(); ++countPoints)\n {\n vector pos = getSatellitePoint(index, countPoints);\n isInside = isInsideRectangularDomain(pos, SMALL);\n\n if(isInside)\n altStartPos = findSingleCell(pos,oldID);\n\n //check for periodic domains, only do if check range is larger than 0\n if(checkPeriodicCells)\n {\n for(int iDir=0;iDir<3;iDir++)\n {\n if( pos[iDir] > globalBb.max()[iDir] && particleCloud_.wall_periodicityCheckRange(iDir)>0 ) \n pos[iDir]-=globalBb.max()[iDir]-globalBb.min()[iDir];\n else if( pos[iDir] < globalBb.min()[iDir] && particleCloud_.wall_periodicityCheckRange(iDir)>0 )\n pos[iDir]+=globalBb.max()[iDir]-globalBb.min()[iDir];\n }\n isInside = isInsideRectangularDomain(pos, SMALL);\n\n if(isInside)\n altStartPos=findSingleCell(pos,oldID); //particleCloud_.mesh().findCell(pos);//\n }\n\n if(altStartPos >= 0) // found position, we're done\n {\n cellIDs[index][0] = altStartPos;\n break;\n }\n }\n }\n }\n }\n }\n return 1;\n}\n\nbool engineSearchIB::isInsideRectangularDomain(vector centre, scalar skin) const\n{\n vector offset(skin, skin, skin);\n boundBox bb(bbPtr_().min()-offset, bbPtr_().max() + offset);\n return bb.contains(centre);\n}\n\nvector engineSearchIB::generateSatellitePoint(int countPoints) const\n{\n scalar theta, phi;\n const scalar thetaSize = 180./zSplit_, phiSize = 360./xySplit_;\n const scalar deg2rad = M_PI/180.;\n vector pos(0.0, 0.0, 0.0);\n // 1 point at bottom, 1 point at top\n if(countPoints == 0)\n {\n pos[2] = 1.0;\n } else if(countPoints == 1)\n {\n pos[2] = -1.0;\n } else {\n scalar thetaLevel = (countPoints - 2) / xySplit_;\n theta = deg2rad * thetaSize * (thetaLevel+1);\n phi = deg2rad * phiSize * (countPoints - 2 - thetaLevel*xySplit_);\n pos[0] = sin(theta) * cos(phi);\n pos[1] = sin(theta) * sin(phi);\n pos[2] = cos(theta);\n }\n return pos;\n}\n\nvector engineSearchIB::getSatellitePoint(int index, int countPoints) const\n{\n double radius=particleCloud_.radius(index);\n vector position = particleCloud_.cfdemCloud::position(index);\n vector pos = radius*satellitePoints_[countPoints] + position;\n return pos;\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/locateModel/engineSearchIB/engineSearchIB.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n engineSearchIB\n\nSourceFiles\n engineSearchIB.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef engineSearchIB_H\n#define engineSearchIB_H\n\n#include \"engineSearch.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass engineSearchIB\n:\n public engineSearch\n{\n\nprotected:\n const label zSplit_;\n\n const label xySplit_;\n\n scalar coef_;\n\n mutable autoPtr bbPtr_;\n\n bool verbose_;\n\n const label numberOfSatellitePoints_;\n\n std::vector satellitePoints_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"engineIB\");\n\n\n // Constructors\n\n //- Construct from components\n engineSearchIB\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~engineSearchIB();\n\n\n // Member Functions\n label findCell\n (\n double** const& mask,\n double**& positions,\n double**& cellIDs,\n int size,\n bool checkRad=true\n ) const;\n\n vector generateSatellitePoint\n (\n int countPoints\n ) const;\n virtual vector getSatellitePoint\n (\n int index,\n int countPoints\n ) const;\n bool isInsideRectangularDomain\n (\n vector point,\n scalar skin\n ) const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/locateModel/locateModel/locateModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n#include \"locateModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(locateModel, 0);\n\ndefineRunTimeSelectionTable(locateModel, dictionary);\n\n// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nlocateModel::locateModel\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n dict_(dict),\n particleCloud_(sm)\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nlocateModel::~locateModel()\n{}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/locateModel/locateModel/locateModel.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n locateModel\n\nSourceFiles\n locateModel.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef locateModel_H\n#define locateModel_H\n\n#include \"fvCFD.H\"\n#include \"cfdemCloud.H\"\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class locateModel Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass locateModel\n{\n\nprotected:\n\n // Protected data\n const dictionary& dict_;\n\n cfdemCloud& particleCloud_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"locateModel\");\n\n // Declare runtime constructor selection table\n\n declareRunTimeSelectionTable\n (\n autoPtr,\n locateModel,\n dictionary,\n (\n const dictionary& dict,\n cfdemCloud& sm\n ),\n (dict,sm)\n );\n\n\n // Constructors\n\n //- Construct from components\n locateModel\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n\n // Destructor\n\n virtual ~locateModel();\n\n\n // Selector\n\n static autoPtr New\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n\n // Member Functions\n virtual label findCell\n (\n double** const& mask,\n double**& positions,\n double**& cellIDs,\n int size,\n bool checkRad=true\n ) const = 0;\n\n virtual label findSingleCell\n (\n vector& position,\n label& oldCellID\n ) const = 0;\n\n virtual label intersection\n (\n const point& pStart,\n const point& pEnd\n ) const\n {\n FatalError << \"The locate model you use does not define the function intersection(...).\" << abort(FatalError);\n return -1;\n };\n\n virtual label intersections\n (\n const point& pStart,\n const point& pEnd\n ) const\n {\n FatalError << \"The locate model you use does not define the function intersections(...).\" << abort(FatalError);\n return -1;\n };\n\n virtual label findNearestCell\n (\n const point& pStart\n ) const\n {\n FatalError << \"The locate model you use does not define the function findNearestCell(...).\" << abort(FatalError);\n return -1;\n };\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/locateModel/locateModel/newLocateModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"locateModel.H\"\n#include \"standardSearch.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\nautoPtr locateModel::New\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n{\n word read_lfm\n (\n dict.lookup(\"locateModel\")\n );\n\n word ps\n (\n dict.lookupOrDefault(\"particleShapeType\", \"\")\n );\n if (ps == \"superquadric\")\n ps = \"Superquadric\"; // NOTE: change in case\n else\n ps = \"\";\n word locateModelType(read_lfm + ps);\n\n Info<< \"Selecting locateModel \"\n << locateModelType << endl;\n\n dictionaryConstructorTable::iterator cstrIter =\n dictionaryConstructorTablePtr_->find(locateModelType);\n\n if (cstrIter == dictionaryConstructorTablePtr_->end())\n {\n FatalError\n << \"locateModel::New(const dictionary&, const spray&) : \"\n << endl\n << \" unknown locateModelType type \"\n << locateModelType\n << \", constructor not in hash table\" << endl << endl\n << \" Valid locateModel types are :\"\n << endl;\n Info<< dictionaryConstructorTablePtr_->toc()\n << abort(FatalError);\n }\n\n return autoPtr(cstrIter()(dict,sm));\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/locateModel/standardSearch/standardSearch.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n#include \"standardSearch.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(standardSearch, 0);\n\naddToRunTimeSelectionTable\n(\n locateModel,\n standardSearch,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nstandardSearch::standardSearch\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n locateModel(dict,sm)\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nstandardSearch::~standardSearch()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nlabel standardSearch::findCell\n(\n double** const& mask,\n double**& positions,\n double**& cellIDs,\n int size,\n bool checkRad\n) const\n{\n vector position;\n for(int index = 0;index < size; ++index)\n {\n //if(mask[index][0] && particleCloud_.radius(index) > SMALL)\n if(!checkRad || particleCloud_.radius(index) > SMALL)\n {\n // create pos vector\n for(int i=0;i<3;i++) position[i] = positions[index][i];\n\n // find cell\n #if defined(version30)\n cellIDs[index][0] = particleCloud_.mesh().findCell(position, polyMesh::FACE_PLANES);\n #elif defined(version21)\n cellIDs[index][0] = particleCloud_.mesh().findCell(position, polyMesh::FACEPLANES);\n #elif defined(version16ext)\n cellIDs[index][0] = particleCloud_.mesh().findCell(position);\n #endif\n }\n else cellIDs[index][0]=-1;\n }\n\n return 1;\n}\n\nlabel standardSearch::findSingleCell\n(\n vector& position,\n label& oldCellID\n) const\n{\n // find cell\n #if defined(version30)\n return particleCloud_.mesh().findCell(position, polyMesh::FACE_PLANES);\n #elif defined(version21)\n return particleCloud_.mesh().findCell(position, polyMesh::FACEPLANES);\n #elif defined(version16ext)\n return particleCloud_.mesh().findCell(position);\n #endif\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/locateModel/standardSearch/standardSearch.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n standardSearch\n\nSourceFiles\n standardSearch.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef standardSearch_H\n#define standardSearch_H\n\n#include \"locateModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass standardSearch\n:\n public locateModel\n{\n\npublic:\n\n //- Runtime type information\n TypeName(\"standard\");\n\n\n // Constructors\n\n //- Construct from components\n standardSearch\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~standardSearch();\n\n\n // Member Functions\n label findCell\n (\n double** const& mask,\n double**& positions,\n double**& cellIDs,\n int size,\n bool checkRad=true\n ) const;\n\n label findSingleCell\n (\n vector& position,\n label& oldCellID\n ) const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/meshMotionModel/meshMotionModel/meshMotionModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n#include \"meshMotionModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(meshMotionModel, 0);\n\ndefineRunTimeSelectionTable(meshMotionModel, dictionary);\n\n// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nmeshMotionModel::meshMotionModel\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n dict_(dict),\n particleCloud_(sm),\n moveZoneName_(\"\")\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nmeshMotionModel::~meshMotionModel()\n{}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\ntmp meshMotionModel::f() const\n{\n tmp tmp\n (\n new volVectorField\n (\n IOobject\n (\n \"xxx\",\n particleCloud_.mesh().time().timeName(),\n particleCloud_.mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n particleCloud_.mesh(),\n dimensionedVector\n (\n \"zero\",\n dimensionSet(0, 1, -2, 0, 0),\n vector::zero\n )\n )\n );\n return tmp;\n}\n\ntmp meshMotionModel::body() const\n{\n tmp tmp\n (\n new volScalarField\n (\n IOobject\n (\n \"xxx\",\n particleCloud_.mesh().time().timeName(),\n particleCloud_.mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n particleCloud_.mesh(),\n scalar(0)\n )\n );\n return tmp;\n}\n\ntmp meshMotionModel::inside() const\n{\n tmp tmp\n (\n new volScalarField\n (\n IOobject\n (\n \"xxx\",\n particleCloud_.mesh().time().timeName(),\n particleCloud_.mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n particleCloud_.mesh(),\n scalar(0)\n )\n );\n return tmp;\n}\n\ntmp meshMotionModel::momentumSource() const\n{\n tmp tmp\n (\n new volVectorField\n (\n IOobject\n (\n \"xxx\",\n particleCloud_.mesh().time().timeName(),\n particleCloud_.mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n particleCloud_.mesh(),\n dimensionedVector\n (\n \"zero\",\n dimensionSet(0, 1, -2, 0, 0),\n vector::zero\n )\n )\n );\n return tmp;\n}\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/meshMotionModel/meshMotionModel/meshMotionModel.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n meshMotionModel\n\nSourceFiles\n meshMotionModel.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef meshMotionModel_H\n#define meshMotionModel_H\n\n#include \"fvCFD.H\"\n#include \"cfdemCloud.H\"\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class meshMotionModel Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass meshMotionModel\n{\n\nprotected:\n\n // Protected data\n const dictionary& dict_;\n\n cfdemCloud& particleCloud_;\n\n mutable word moveZoneName_;\n\n // Protected member functions\n\npublic:\n\n //- Runtime type information\n TypeName(\"meshMotionModel\");\n\n // Declare runtime constructor selection table\n\n declareRunTimeSelectionTable\n (\n autoPtr,\n meshMotionModel,\n dictionary,\n (\n const dictionary& dict,\n cfdemCloud& sm\n ),\n (dict,sm)\n );\n\n\n // Constructors\n\n //- Construct from components\n meshMotionModel\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n\n // Destructor\n\n virtual ~meshMotionModel();\n\n\n // Selector\n\n static autoPtr New\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n\n // Member Function\n virtual labelList moveZone() const {return labelList(0);};\n\n const word& moveZoneName() const {return moveZoneName_;}\n\n virtual tmp setMotion() const=0;\n\n virtual void correctF(volVectorField&) const {};\n\n virtual void correctUo(volVectorField&) const {};\n\n virtual tmp f() const;\n\n virtual tmp body() const;\n\n virtual tmp inside() const;\n\n virtual tmp momentumSource() const;\n\n virtual void postProcessing(volScalarField&) const {};\n\n // Access\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/meshMotionModel/meshMotionModel/newMeshMotionModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"meshMotionModel.H\"\n#include \"noMeshMotion.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\nautoPtr meshMotionModel::New\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n{\n word meshMotionModelType\n (\n dict.lookup(\"meshMotionModel\")\n );\n\n Info<< \"Selecting meshMotionModel \"\n << meshMotionModelType << endl;\n\n\n dictionaryConstructorTable::iterator cstrIter =\n dictionaryConstructorTablePtr_->find(meshMotionModelType);\n\n if (cstrIter == dictionaryConstructorTablePtr_->end())\n {\n FatalError\n << \"meshMotionModel::New(const dictionary&, const spray&) : \"\n << endl\n << \" unknown meshMotionModelType type \"\n << meshMotionModelType\n << \", constructor not in hash table\" << endl << endl\n << \" Valid meshMotionModel types are :\"\n << endl;\n Info<< dictionaryConstructorTablePtr_->toc()\n << abort(FatalError);\n }\n\n return autoPtr(cstrIter()(dict,sm));\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/meshMotionModel/noMeshMotion/noMeshMotion.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"noMeshMotion.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(noMeshMotion, 0);\n\naddToRunTimeSelectionTable\n(\n meshMotionModel,\n noMeshMotion,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nnoMeshMotion::noMeshMotion\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n meshMotionModel(dict,sm)\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nnoMeshMotion::~noMeshMotion()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\ntmp noMeshMotion::setMotion() const\n{\n tmp tsource\n (\n new volVectorField\n (\n IOobject\n (\n \"xxx\",\n particleCloud_.mesh().time().timeName(),\n particleCloud_.mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n particleCloud_.mesh(),\n dimensionedVector\n (\n \"zero\",\n dimensionSet(0, 1, -1, 0, 0),\n vector::zero\n )\n )\n );\n\n // do sth\n return tsource;\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/meshMotionModel/noMeshMotion/noMeshMotion.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n noMeshMotion\n\nSourceFiles\n noMeshMotion.C\n\n\\*---------------------------------------------------------------------------*/\n#ifndef noMeshMotion_H\n#define noMeshMotion_H\n\n#include \"meshMotionModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass noMeshMotion\n:\n public meshMotionModel\n{\n\npublic:\n\n //- Runtime type information\n TypeName(\"noMeshMotion\");\n\n\n // Constructors\n\n //- Construct from components\n noMeshMotion\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~noMeshMotion();\n\n\n // Member Functions\n tmp setMotion() const;\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/momCoupleModel/explicitCouple/explicitCouple.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"explicitCouple.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \"forceModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(explicitCouple, 0);\n\naddToRunTimeSelectionTable\n(\n momCoupleModel,\n explicitCouple,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nexplicitCouple::explicitCouple\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n momCoupleModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n fPrev_\n ( IOobject\n (\n \"fPrev\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::READ_IF_PRESENT,//MUST_READ,\n IOobject::AUTO_WRITE\n ),\n sm.mesh().lookupObject (\"f\")\n //sm.mesh(),\n //dimensionedVector(\"zero\", dimensionSet(1,-2,-2,0,0), vector(0,0,0)) // N/m3\n ),\n fNext_\n ( IOobject\n (\n \"fNext\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::READ_IF_PRESENT,//MUST_READ,\n IOobject::AUTO_WRITE\n ),\n sm.mesh().lookupObject (\"f\")\n //sm.mesh(),\n //dimensionedVector(\"zero\", dimensionSet(1,-2,-2,0,0), vector(0,0,0)) // N/m3\n ),\n fLimit_(1e10,1e10,1e10),\n sourceField_\n ( IOobject\n (\n \"sourceField\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::READ_IF_PRESENT,\n IOobject::AUTO_WRITE\n ),\n sm.mesh(),\n dimensionedVector(\"zero\", dimensionSet(1,-2,-2,0,0), vector(0,0,0)) // N/m3\n )\n{\n if (propsDict_.found(\"fLimit\"))\n {\n fLimit_=vector(propsDict_.lookup (\"fLimit\"));\n Info << \"explicit momentum exchange field is limited to : \" << fLimit_ << endl;\n }\n bool treatVoidCellsAsExplicitForce = propsDict_.lookupOrDefault(\"treatVoidCellsAsExplicitForce\", true);\n if (treatVoidCellsAsExplicitForce) particleCloud_.registryM().addProperty(\"treatVoidCellsAsExplicitForce\",1);\n else particleCloud_.registryM().addProperty(\"treatVoidCellsAsExplicitForce\",0);\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nexplicitCouple::~explicitCouple()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nvoid Foam::explicitCouple::applyDebugSettings(bool debug) const\n{\n if(!debug)\n {\n fPrev_.writeOpt() = IOobject::NO_WRITE;\n fNext_.writeOpt() = IOobject::NO_WRITE;\n }\n}\n\n// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\ndimensionedVector explicitCouple::returnIntegralSourceField() const\n{\n //Sum is over cells of PROCESOR ONLY!!\n dimensionedVector intSource = dimensionedVector(\"0\", dimensionSet(1, 1, -2, 0, 0), vector::zero);\n forAll(sourceField_,cellI)\n intSource.value() += sourceField_.internalField()[cellI] * particleCloud_.mesh().V()[cellI];\n\n return intSource; // in Newton\n}\n\n// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\ntmp explicitCouple::expMomSource() const\n{\n //This INCLUDES the source field that is set separately!\n scalar tsf = particleCloud_.dataExchangeM().timeStepFraction();\n\n // update fNext at last subTS\n //if(1-tsf < 1e-4) //tsf==1\n\n // update KslNext in first subTS\n // NOTE: without following if we could update f every subTS (based on current values) and use this value\n if(tsf < particleCloud_.mesh().time().deltaT().value()/particleCloud_.dataExchangeM().couplingTime() + 0.000001 )\n {\n // calc fNext\n forAll(fNext_,cellI)\n {\n fNext_[cellI] = arrayToField(cellI);\n \n // limiter\n for (int i=0;i<3;i++)\n {\n if (mag(fNext_[cellI][i]) > fLimit_[i]) fNext_[cellI][i] = fLimit_[i];\n }\n }\n }\n\n /*if(1-tsf < 1e-4) //tsf==1\n {\n return tmp\n (\n new volVectorField(\"f_explicitCouple\", fPrev_)\n );\n }else*/\n {\n return tmp\n (\n new volVectorField(\"f_explicitCouple\", (1 - tsf) * fPrev_ + tsf * fNext_)\n );\n }\n}\n\n// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\nvoid Foam::explicitCouple::resetMomSourceField() const\n{\n fPrev_ == fNext_;\n fNext_ == dimensionedVector(\"zero\", fNext_.dimensions(), vector::zero);\n}\n\n// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\ninline vector Foam::explicitCouple::arrayToField(label cellI) const\n{\n //This INCLUDES the source field that is set separately!\n return particleCloud_.forceM(0).expParticleForces()[cellI] / particleCloud_.mesh().V()[cellI] \n + sourceField_[cellI];\n}\n\nvoid Foam::explicitCouple::setSourceField(volVectorField & field) const\n{\n sourceField_ = field;\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/momCoupleModel/explicitCouple/explicitCouple.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n explicitCouple\n\nSourceFiles\n explicitCouple.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef explicitCouple_H\n#define explicitCouple_H\n\n#include \"momCoupleModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass explicitCouple\n:\n public momCoupleModel\n{\nprivate:\n\n dictionary propsDict_;\n\n mutable volVectorField fPrev_;\n\n mutable volVectorField fNext_;\n\n vector fLimit_; // limit for for exchange field\n\n virtual inline vector arrayToField(label) const;\n\n mutable volVectorField sourceField_; // N/m3\n\npublic:\n\n //- Runtime type information\n TypeName(\"explicitCouple\");\n\n\n // Constructors\n\n //- Construct from components\n explicitCouple\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~explicitCouple();\n\n\n // Member Functions\n\n void applyDebugSettings(bool) const;\n\n tmp expMomSource() const;\n\n void resetMomSourceField() const;\n\n void setSourceField(volVectorField &) const;\n\n dimensionedVector returnIntegralSourceField() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/momCoupleModel/implicitCouple/implicitCouple.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"implicitCouple.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \"forceModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(implicitCouple, 0);\n\naddToRunTimeSelectionTable\n(\n momCoupleModel,\n implicitCouple,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nimplicitCouple::implicitCouple\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n momCoupleModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n velFieldName_(propsDict_.lookupOrDefault(\"velFieldName\",\"U\")),\n granVelFieldName_(propsDict_.lookupOrDefault(\"granVelFieldName\",\"Us\")),\n voidfractionFieldName_(propsDict_.lookupOrDefault(\"voidfractionFieldName\",\"voidfraction\")),\n U_(sm.mesh().lookupObject (velFieldName_)),\n Us_(sm.mesh().lookupObject (granVelFieldName_)),\n alpha_(sm.mesh().lookupObject (voidfractionFieldName_)),\n KslLimit_(1e10),\n KslPrev_\n ( IOobject\n (\n \"KslPrev\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::READ_IF_PRESENT,//MUST_READ,\n IOobject::AUTO_WRITE\n ),\n sm.mesh().lookupObject (\"Ksl\")\n //sm.mesh(),\n //dimensionedScalar(\"zero\", dimensionSet(1,-3,-1,0,0), 0) // N/m3 / m/s\n ),\n KslNext_\n ( IOobject\n (\n \"KslNext\",\n sm.mesh().time().timeName(),\n sm.mesh(),\n IOobject::READ_IF_PRESENT,//MUST_READ,\n IOobject::AUTO_WRITE\n ),\n sm.mesh().lookupObject (\"Ksl\")\n //sm.mesh(),\n //dimensionedScalar(\"zero\", dimensionSet(1,-3,-1,0,0), 0) // N/m3 / m/s\n )\n{\n Info << \"\" << endl;\n\n if (propsDict_.found(\"KslLimit\"))\n {\n KslLimit_=readScalar(propsDict_.lookup (\"KslLimit\"));\n Info << \"implicit momentum exchange field is limited to : \" << KslLimit_ << endl;\n }\n\n if (propsDict_.found(\"minAlphaP\"))\n maxAlpha_ = 1-readScalar(propsDict_.lookup (\"minAlphaP\"));\n\n Info << \"implicit momentum exchange field calculate if alphaP larger than : \" << maxAlpha_ << endl;\n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nimplicitCouple::~implicitCouple()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nvoid Foam::implicitCouple::applyDebugSettings(bool debug) const\n{\n if(!debug)\n {\n KslPrev_.writeOpt() = IOobject::NO_WRITE;\n KslNext_.writeOpt() = IOobject::NO_WRITE;\n }\n}\n\ntmp implicitCouple::impMomSource() const\n{\n scalar tsf = particleCloud_.dataExchangeM().timeStepFraction();\n\n // calc Ksl\n scalar Ur;\n\n // update KslNext at last subTS\n //if(1-tsf < 1e-4) //tsf==1\n\n // update KslNext in first subTS\n // NOTE: without following if we could update Ksl every subTS (based on current values) and use this value\n if(tsf < particleCloud_.mesh().time().deltaT().value()/particleCloud_.dataExchangeM().couplingTime() + 0.000001 )\n {\n forAll(KslNext_,cellI)\n {\n Ur = mag(U_[cellI] - Us_[cellI]);\n\n if(Ur > SMALL && alpha_[cellI] < maxAlpha_) //momentum exchange switched off if alpha too big\n {\n // NOTE: impParticleForces() are calculated at coupling step based on current values\n // therefore the us of Next fields in forceM and here is recommended\n KslNext_[cellI] = mag(particleCloud_.forceM(0).impParticleForces()[cellI])\n / Ur\n / particleCloud_.mesh().V()[cellI];\n }\n else KslNext_[cellI] = 0;\n\n // limiter\n if (KslNext_[cellI] > KslLimit_) KslNext_[cellI] = KslLimit_;\n }\n }\n\n /*if(1-tsf < 1e-4) //tsf==1\n {\n return tmp\n (\n new volScalarField(\"Ksl_implicitCouple\", KslPrev_)\n );\n }else*/\n {\n return tmp\n (\n new volScalarField(\"Ksl_implicitCouple\", (1 - tsf) * KslPrev_ + tsf * KslNext_)\n );\n }\n}\n\nvoid Foam::implicitCouple::resetMomSourceField() const\n{\n KslPrev_ == KslNext_;\n KslNext_ == dimensionedScalar(\"zero\", KslNext_.dimensions(), 0.0);\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/momCoupleModel/implicitCouple/implicitCouple.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n implicitCouple\n\nSourceFiles\n implicitCouple.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef implicitCouple_H\n#define implicitCouple_H\n\n#include \"momCoupleModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass implicitCouple\n:\n public momCoupleModel\n{\n\nprivate:\n\n dictionary propsDict_;\n\n word velFieldName_;\n\n word granVelFieldName_;\n\n word voidfractionFieldName_;\n\n const volVectorField& U_; // ref to fluid velocity\n\n const volVectorField& Us_; // ref to granular velocity\n\n const volScalarField& alpha_; // ref to voidfraction\n\n scalar KslLimit_; // limit for for exchange field\n\n mutable volScalarField KslPrev_;\n\n mutable volScalarField KslNext_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"implicitCouple\");\n\n\n // Constructors\n\n //- Construct from components\n implicitCouple\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~implicitCouple();\n\n\n // Member Functions\n\n void applyDebugSettings(bool) const;\n\n tmp impMomSource() const;\n\n void resetMomSourceField() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/momCoupleModel/momCoupleModel/momCoupleModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n#include \"momCoupleModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(momCoupleModel, 0);\n\ndefineRunTimeSelectionTable(momCoupleModel, dictionary);\n\n// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\ntmp momCoupleModel::impMomSource() const\n{\n FatalError<<\"the solver calls for impMomSource()\\n\"\n <<\", please set 'momCoupleModel' to type 'implicitCouple'\\n\"\n << abort(FatalError);\n\n tmp tsource;\n return tsource;\n}\n\n// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\ntmp momCoupleModel::expMomSource() const\n{\n FatalError<<\"the solver calls for expMomSource()\\n\"\n <<\", please set 'momCoupleModel' to type 'explicitCouple'\\n\"\n << abort(FatalError);\n tmp tsource;\n return tsource;\n}\n\n// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\nvoid momCoupleModel::setSourceField(volVectorField & a) const\n{\n //do nothing;\n}\n\n// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\ndimensionedVector momCoupleModel::returnIntegralSourceField() const\n{\n FatalError<<\"the solver calls for returnIntegralSourceField()\\n\"\n <<\", please set 'momCoupleModel' to type 'explicitCouple' to access this data.\\n\"\n << abort(FatalError);\n\n return dimensionedVector(\"0\", dimensionSet(1, 1, -2, 0, 0), vector::zero); // Newton\n}\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nmomCoupleModel::momCoupleModel\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n dict_(dict),\n particleCloud_(sm),\n maxAlpha_(1-SMALL)\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nmomCoupleModel::~momCoupleModel()\n{}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/momCoupleModel/momCoupleModel/momCoupleModel.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n momCoupleModel\n\nSourceFiles\n momCoupleModel.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef momCoupleModel_H\n#define momCoupleModel_H\n\n#include \"fvCFD.H\"\n#include \"cfdemCloud.H\"\n#include \"dataExchangeModel.H\"\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class momCoupleModel Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass momCoupleModel\n{\n\nprotected:\n\n // Protected data\n const dictionary& dict_;\n\n cfdemCloud& particleCloud_;\n\n scalar maxAlpha_; // max fluid volume fraction to calculate exchange field\n\npublic:\n\n //- Runtime type information\n TypeName(\"momCoupleModel\");\n\n // Declare runtime constructor selection table\n\n declareRunTimeSelectionTable\n (\n autoPtr,\n momCoupleModel,\n dictionary,\n (\n const dictionary& dict,\n cfdemCloud& sm\n ),\n (dict,sm)\n );\n\n\n // Constructors\n\n //- Construct from components\n momCoupleModel\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n\n // Destructor\n\n virtual ~momCoupleModel();\n\n\n // Selector\n\n static autoPtr New\n (\n const dictionary& dict,\n cfdemCloud& sm,\n word momCoupleType\n );\n\n\n // Member Functions\n\n virtual void applyDebugSettings(bool) const {};\n\n // implicit momentum source field\n virtual tmp impMomSource() const;\n\n // explicit momentum source field\n virtual tmp expMomSource() const;\n\n virtual void resetMomSourceField() const=0;\n\n virtual void setSourceField(volVectorField &) const;\n\n virtual dimensionedVector returnIntegralSourceField() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/momCoupleModel/momCoupleModel/newMomCoupleModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"momCoupleModel.H\"\n#include \"explicitCouple.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\nautoPtr momCoupleModel::New\n(\n const dictionary& dict,\n cfdemCloud& sm,\n word momCoupleType\n)\n{\n Info<< \"Selecting momCoupleModel \"\n << momCoupleType << endl;\n\n\n dictionaryConstructorTable::iterator cstrIter =\n dictionaryConstructorTablePtr_->find(momCoupleType);\n\n if (cstrIter == dictionaryConstructorTablePtr_->end())\n {\n FatalError\n << \"momCoupleModel::New(const dictionary&, const spray&) : \"\n << endl\n << \" unknown momCoupleType type \"\n << momCoupleType\n << \", constructor not in hash table\" << endl << endl\n << \" Valid momCoupleModel types are :\"\n << endl;\n Info<< dictionaryConstructorTablePtr_->toc()\n << abort(FatalError);\n }\n\n return autoPtr(cstrIter()(dict,sm));\n}\n\n// * * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/momCoupleModel/noCouple/noCouple.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"noCouple.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \"voidFractionModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(noCouple, 0);\n\naddToRunTimeSelectionTable\n(\n momCoupleModel,\n noCouple,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nnoCouple::noCouple\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n momCoupleModel(dict,sm)\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nnoCouple::~noCouple()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\nvoid Foam::noCouple::resetMomSourceField() const\n{\n FatalError<<\"the solver calls for resetMomSourceField() although you use IB method where this is not needed!\\n\"\n <<\", check your solver! - PANIC -\\n\";\n //<< abort(FatalError);\n}\n\ntmp noCouple::impMomSource() const\n{\n tmp tsource\n (\n new volScalarField\n (\n IOobject\n (\n \"Ksl_implicitCouple\",\n particleCloud_.mesh().time().timeName(),\n particleCloud_.mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n particleCloud_.mesh(),\n dimensionedScalar\n (\n \"zero\",\n dimensionSet(1, -3, -1, 0, 0), // N/m3 / m/s\n 0\n )\n )\n );\n\n return tsource;\n}\n\ntmp noCouple::expMomSource() const\n{\n tmp tsource\n (\n new volVectorField\n (\n IOobject\n (\n \"f_explicitCouple\",\n particleCloud_.mesh().time().timeName(),\n particleCloud_.mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n particleCloud_.mesh(),\n dimensionedVector\n (\n \"zero\",\n dimensionSet(1, -2, -2, 0, 0), // N/m3\n vector::zero\n )\n )\n );\n\n return tsource;\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/momCoupleModel/noCouple/noCouple.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n noCouple\n\nSourceFiles\n noCouple.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef noCouple_H\n#define noCouple_H\n\n#include \"momCoupleModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass noCouple\n:\n public momCoupleModel\n{\nprivate:\n\n\npublic:\n\n //- Runtime type information\n TypeName(\"off\");\n\n\n // Constructors\n\n //- Construct from components\n noCouple\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~noCouple();\n\n\n // Member Functions\n void resetMomSourceField() const;\n\n tmp impMomSource() const;\n\n tmp expMomSource() const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/probeModel/noProbe/noProbe.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"noProbe.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \n#include \"IOmanip.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(noProbe, 0);\n\naddToRunTimeSelectionTable\n(\n probeModel,\n noProbe,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nnoProbe::noProbe\n(\n const dictionary& dict,\n cfdemCloud& sm,\n word typeName,\n const char* logFileName\n)\n:\n probeModel(dict,sm,typeName,logFileName)\n{}\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nnoProbe::~noProbe()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/probeModel/noProbe/noProbe.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n noProbe\n\nSourceFiles\n noProbe.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef noProbe_H\n#define noProbe_H\n\n#include \"probeModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noDrag Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass noProbe\n:\n public probeModel\n{\n\nprivate:\n\n\npublic:\n\n //- Runtime type information\n TypeName(\"off\");\n\n\n // Constructors\n\n //- Construct from components\n noProbe\n (\n const dictionary& dict,\n cfdemCloud& sm,\n word typeName,\n const char* logFileName\n );\n\n // Destructor\n\n ~noProbe();\n\n // Member Functions\n bool active() const {return false;}; \n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/probeModel/particleProbe/particleProbe.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"particleProbe.H\"\n#include \"addToRunTimeSelectionTable.H\"\n#include \"error.H\"\n#include \"IOmanip.H\"\n#include \n#include \n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(particleProbe, 0);\n\naddToRunTimeSelectionTable\n(\n probeModel,\n particleProbe,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nparticleProbe::particleProbe\n(\n const dictionary& dict,\n cfdemCloud& sm,\n const word& typeName,\n const char* logFileName\n)\n:\n probeModel(dict,sm,typeName,logFileName),\n propsDict_(dict.subDict(typeName + \"Props\")),\n name_(typeName),\n particleCloud_(sm),\n verbose_(false),\n verboseToFile_(false),\n writePrecision_(3),\n dirName_(\"particleProbes\"),\n rank_(-1),\n sPtr(NULL),\n printEvery_(1),\n sampleAll_(false),\n probeDebug_(false),\n includePosition_(false),\n particleIDsToSample_(propsDict_.lookup(\"particleIDsToSample\")),\n itemCounter_(0),\n currItemId_(0),\n printCounter_(0),\n printNow_(false),\n printOnlyAt_(-1)\n{\n if (propsDict_.found(\"verbose\")) verbose_=true;\n if (propsDict_.found(\"verboseToFile\")) verboseToFile_=true;\n\n if (propsDict_.found(\"printEvery\")) printEvery_= readScalar(propsDict_.lookup(\"printEvery\"));\n if (propsDict_.found(\"printOnlyAtStep\")) printOnlyAt_= readScalar(propsDict_.lookup(\"printOnlyAtStep\"));\n if (propsDict_.found(\"sampleAll\")) sampleAll_=true;\n if (propsDict_.found(\"probeDebug\")) probeDebug_=true;\n if (propsDict_.found(\"includePosition\")) includePosition_=true;\n\n if (propsDict_.found(\"writePrecision\")) writePrecision_= readScalar(propsDict_.lookup(\"writePrecision\"));\n\n}\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nparticleProbe::~particleProbe()\n{\n clearProbes();\n forAll(sPtrList_, i)\n delete sPtrList_[i];\n}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nvoid particleProbe::setOutputFile(const word& logFileName) const\n{\n bool foundFile = false;\n if(itemCounter_>0 && verboseToFile_ )\n {\n forAll(itemsToSample_, iterator)\n {\n if(itemsToSample_[iterator] == logFileName)\n {\n probeIndex_ = iterator ;\n foundFile = true;\n }\n }\n\n if(!foundFile)\n FatalError << \"particleProbe::setOutputFile for logFileName \" << logFileName << \" : \"<< \"File not found\" << abort(FatalError);\n currItemId_ = probeIndex_ + 1;\n setCounter(); //set counter, will auto-check if first item\n }\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *\nvoid particleProbe::initialize(const word& modelName,const word& logFileName) const\n{\n //update the list of items to be sampled\n itemCounter_ += 1; \n // Note: for other than ext one could use vValues.append(x)\n // instead of setSize\n itemsToSample_.setSize(itemsToSample_.size()+1, logFileName);\n\n // init environment\n name_ = modelName;\n const char* fileNameOut_ = logFileName.c_str();\n\n if(verboseToFile_)\n {\n\n if(printOnlyAt_==-1)\n {\n Info << \"Will sample these particle IDs: \" << particleIDsToSample_ << \" every \" << printEvery_ << endl;\n }\n else if(printOnlyAt_>-1)\n {\n Info << \"Will sample these particle IDs: \" << particleIDsToSample_ << \" at step \" << printOnlyAt_ << endl;\n }\n else\n {\n FatalError << \"particleProbe for model \" << name_ << \" : \"<< \"printOnlyAtStep cannot be negative or zero\" << abort(FatalError);\n }\n\n //initialize the output files\n MPI_Comm_rank(MPI_COMM_WORLD,&rank_);\n\n //open a separate file for each processor\n char* filecurrent_ = new char[strlen(fileNameOut_) + 5]; //reserve 4 chars for processor name\n sprintf(filecurrent_,\"%s%s%d\", fileNameOut_, \".\", rank_);\n Info << \"particleProbe for model \" << name_ << \" will write to file \" << filecurrent_ \n << \". This is item \" << itemCounter_ << \" to probe.\" << endl;\n\n //generate the file streams\n fileName probeSubDir = dirName_;\n if (particleCloud_.mesh().name() != polyMesh::defaultRegion)\n {\n probeSubDir = probeSubDir/particleCloud_.mesh().name();\n }\n probeSubDir = probeSubDir/particleCloud_.mesh().time().timeName();\n\n fileName probeDir_;\n if (Pstream::parRun())\n {\n // Put in undecomposed case\n // (Note: gives problems for distributed data running)\n probeDir_ = particleCloud_.mesh().time().path()/\"..\"/probeSubDir;\n }\n else\n {\n probeDir_ = particleCloud_.mesh().time().path()/probeSubDir;\n }\n\n //manage files and OFstreams\n mkDir(probeDir_);\n sPtr = new OFstream(probeDir_/filecurrent_);\n // Note: for other than ext one could use xx.append(x)\n // instead of setSize\n sPtrList_.setSize(sPtrList_.size()+1, sPtr);\n\n delete [] filecurrent_;\n //Clear the containers for the fields to be probed\n scalarFields_.clear();\n vectorFields_.clear();\n }\n\n Info << \"particleProbe::initialize done!\" << endl;\n return;\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *\nvoid particleProbe::writeHeader() const\n{\n\n if(verboseToFile_ )\n {\n *sPtr<<\"#processor: \" << rank_ << endl;\n *sPtr<<\"#index time \" << \" \"; \n\n\n *sPtr<<\"|| vectorData: \" << \" \"; \n \n forAll(vectorFields_, iter)\n {\n if(!probeDebug_ && iter>0) break;\n *sPtr << vectorFields_(iter) << \" \"; \n }\n\n if(probeDebug_)\n {\n *sPtr<<\"|| scalarData: \" << \" \"; \n forAll(scalarFields_, iter)\n {\n *sPtr << scalarFields_(iter) << \" \";\n }\n }\n\n if(includePosition_) *sPtr<<\" || position\" << endl; \n else *sPtr << endl; \n }\n\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *\nvoid particleProbe::clearProbes() const\n{\n\n for(std::vector< std::vector >::iterator \n it = vProbes_.begin(); \n it != vProbes_.end(); \n ++it) \n {\n for(std::vector::iterator \n jt = (*it).begin(); \n jt != (*it).end(); \n ++jt) \n {\n delete[] (*jt);\n }\n (*it).clear();\n \n }\n\n for (unsigned int j=0; j sValues, Field vValues) const\n{\n //check if the particle already has an allocated vector. If not, create it. It should be only called at the beginning. \n while(index >= static_cast(vProbes_.size()))\n {\n std::vector particleVector_;\n vProbes_.push_back(particleVector_);\n }\n \n while(index >= static_cast(sProbes_.size()))\n {\n std::vector particleScalar_;\n sProbes_.push_back(particleScalar_);\n }\n \n //register vector probes on the corresponding vector\n forAll(vValues, iter)\n {\n if(probeIndex_(vProbes_[index].size())) //The corresponding probe for this particle already exists, values are overwritten.\n {\n vProbes_[index][probeIndex_][0]=vValues[iter][0];\n vProbes_[index][probeIndex_][1]=vValues[iter][1];\n vProbes_[index][probeIndex_][2]=vValues[iter][2];\n }\n else //The corresponding probe for this particle has to be created\n {\n vProbes_[index].push_back(new double[3]); //this pointer MUST be freed in the destructor\n vProbes_[index].back()[0]=vValues[iter][0];\n vProbes_[index].back()[1]=vValues[iter][1];\n vProbes_[index].back()[2]=vValues[iter][2];\n }\n }\n \n //register scalar probes on the corresponding vector\n forAll(sValues, iter)\n {\n if(probeIndex_(sProbes_[index].size())) //The corresponding probe for this particle already exists, values are overwritten.\n sProbes_[index][probeIndex_]=sValues[iter];\n else //The corresponding probe for this particle has to be created\n sProbes_[index].push_back(sValues[iter]); \n }\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *\nvoid particleProbe::writeProbe(int index, Field sValues, Field vValues) const\n{\n updateProbes(index,sValues,vValues); //update probe vectors\n \n if(printNow_ && checkIDForPrint(index) && verboseToFile_) \n {\n sPtr = sPtrList_[probeIndex_]; //set the pointer to the output file from list\n\n //index and time\n *sPtr << setprecision(IOstream::defaultPrecision()+7) ;\n *sPtr << index << \" \" \n << particleCloud_.mesh().time().value() << \" \" ;\n *sPtr << \"|| \";\n \n //vectorFields\n *sPtr << setprecision(writePrecision_) ;\n forAll(vValues, iter)\n {\n // if(!probeDebug_ && iter>0) break;\n *sPtr << vValues[iter][0] << \" \";\n *sPtr << vValues[iter][1] << \" \";\n *sPtr << vValues[iter][2] << \" \"; \n }\n\n //scalarFields\n if(probeDebug_)\n {\n *sPtr << \"|| \";\n forAll(sValues, iter)\n {\n *sPtr << sValues[iter] << \" \"; \n }\n }\n\n if(includePosition_)\n {\n *sPtr << \"|| \";\n *sPtr << particleCloud_.cfdemCloud::position(index)[0] << \" \" \n << particleCloud_.cfdemCloud::position(index)[1] << \" \"\n << particleCloud_.cfdemCloud::position(index)[2]\n << endl;\n }\n else *sPtr << endl;\n }\n \n return;\n \n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *\nbool particleProbe::checkIDForPrint(int index) const\n{\n \n bool sampleThisId_ = false;\n if(sampleAll_) sampleThisId_ = true;\n else\n {\n forAll(particleIDsToSample_, iSample)\n {\n if(index==particleIDsToSample_[iSample]) sampleThisId_ = true;\n }\n }\n return sampleThisId_;\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *\nvoid particleProbe::setCounter() const\n{\n\n //reset or increment counter for printing to file \n //Do only if called by first item in the list of items!\n if(currItemId_==1)\n {\n printCounter_++;\n if(printOnlyAt_==-1)\n {\n if( printCounter_ >= printEvery_ )\n {\n printCounter_=0;\n printNow_ = true;\n }\n else printNow_ = false;\n }\n else if(printCounter_==printOnlyAt_)\n {\n printNow_ = true;\n }\n else \n {\n printNow_ = false;\n }\n \n }\n return; \n\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/probeModel/particleProbe/particleProbe.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n particleProbe\n\nSourceFiles\n particleProbe.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef particleProbe_H\n#define particleProbe_H\n\n#include \"probeModel.H\"\n#include \"fvCFD.H\"\n#include \"polyMesh.H\"\n#include \"cfdemCloud.H\"\n#include \"OFstream.H\"\n#include \n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class particleProbe Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass particleProbe\n:\n public probeModel\n{\n\nprivate:\n\n dictionary propsDict_;\n\n mutable word name_;\n\n cfdemCloud& particleCloud_;\n\n bool verbose_;\n\n bool verboseToFile_;\n\n int writePrecision_;\n\n word dirName_;\n\n mutable int rank_;\n\n mutable OFstream* sPtr;\n\n int printEvery_;\n\n bool sampleAll_;\n\n bool probeDebug_;\n\n bool includePosition_;\n\n const labelList particleIDsToSample_;\n\n mutable wordList itemsToSample_;\n\n mutable List sPtrList_; //Must delete elements in destructor\n\n mutable int itemCounter_;\n\n mutable int currItemId_;\n\n mutable int printCounter_;\n\n mutable bool printNow_;\n\n mutable std::vector< std::vector > sProbes_;\n \n mutable std::vector< std::vector > vProbes_; //Must delete elements in destructor\n \n mutable std::vector probeName_;\n \n mutable int probeIndex_;\n \n mutable int printOnlyAt_;\n \n \npublic:\n\n //- Runtime type information\n TypeName(\"particleProbe\");\n\n\n // Constructors\n\n //- Construct from components\n particleProbe\n (\n const dictionary& dict,\n cfdemCloud& sm,\n const word& typeName,\n const char* logFileName\n );\n\n // Destructor\n\n ~particleProbe();\n\n // Member Functions\n void updateProbes(int index, Field sValues, Field vValues) const;\n void initialize(const word& modelName, const word& logFileName) const;\n void setOutputFile(const word& logFileName) const;\n void writeHeader() const;\n void writeProbe(int index, Field sValues, Field vValues) const;\n bool checkIDForPrint(int) const;\n void setCounter() const;\n void clearProbes() const;\n std::vector< std::vector >* getVprobe() { return &vProbes_; };\n std::vector< std::vector >* getSprobe() {return &sProbes_; };\n \n \n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/probeModel/probeModel/newProbeModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"probeModel.H\"\n#include \"particleProbe.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\nautoPtr probeModel::New\n(\n const dictionary& dict,\n cfdemCloud& sm,\n const word& typeName,\n const char* logFileName\n)\n{\n word probeModelType\n (\n dict.lookup(\"probeModel\")\n );\n\n Info<< \"Selecting probeModel \"\n << probeModelType << endl;\n\n\n dictionaryConstructorTable::iterator cstrIter =\n dictionaryConstructorTablePtr_->find(probeModelType);\n\n if (cstrIter == dictionaryConstructorTablePtr_->end())\n {\n FatalError\n << \"probeModel::New(const dictionary&, const spray&) : \"\n << endl\n << \" unknown probeModelType type \"\n << probeModelType\n << \", constructor not in hash table\" << endl << endl\n << \" Valid probeModel types are :\"\n << endl;\n Info<< dictionaryConstructorTablePtr_->toc()\n << abort(FatalError);\n }\n\n return autoPtr(cstrIter()(dict,sm,probeModelType,logFileName));\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/probeModel/probeModel/probeModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n#include \"probeModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(probeModel, 0);\n\ndefineRunTimeSelectionTable(probeModel, dictionary);\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nprobeModel::probeModel\n(\n const dictionary& dict,\n cfdemCloud& sm,\n const word& typeName,\n const char* logFileName\n)\n:\n dict_(dict),\n particleCloud_(sm)\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nprobeModel::~probeModel(){}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/probeModel/probeModel/probeModel.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n probeModel\n\nSourceFiles\n probeModel.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef probeModel_H\n#define probeModel_H\n\n#include \"fvCFD.H\"\n#include \"cfdemCloud.H\"\n#include \n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class probeModel Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass probeModel\n{\n\nprotected:\n\n // Protected data\n const dictionary& dict_;\n\n cfdemCloud& particleCloud_;\n\n //- Class used for grouping field types\n template\n class cfdemFieldGroup\n :\n public DynamicList\n {\n public:\n //- Construct null\n cfdemFieldGroup()\n :\n DynamicList(0)\n {}\n\n };\n\n\npublic:\n\n // Variables\n //- Categorized scalar/vector/tensor vol fields\n mutable cfdemFieldGroup scalarFields_;\n mutable cfdemFieldGroup vectorFields_;\n\n //- Runtime type information\n TypeName(\"probeModel\");\n\n // Declare runtime constructor selection table\n\n declareRunTimeSelectionTable\n (\n autoPtr,\n probeModel,\n dictionary,\n (\n const dictionary& dict,\n cfdemCloud& sm,\n const word& typeName,\n const char* logFileName\n ),\n (dict,sm,typeName,logFileName)\n );\n\n\n // Constructors\n\n //- Construct from components\n probeModel\n (\n const dictionary& dict,\n cfdemCloud& sm,\n const word& typeName,\n const char* logFileName\n );\n\n\n // Destructor\n\n virtual ~probeModel();\n\n\n // Selector\n\n static autoPtr New\n (\n const dictionary& dict,\n cfdemCloud& sm,\n const word& typeName,\n const char* logFileName\n );\n\n // Member Functions\n\n virtual void initialize(const word& modelName, const word& logFileName) const {};\n virtual void setOutputFile(const word& logFileName) const {};\n virtual void writeHeader() const {};\n virtual void writeProbe(int index, Field sValues, Field vValues) const {};\n virtual bool checkIDForPrint(int) const {return false;};\n virtual void setCounter() const {};\n virtual bool active() const {return true;}; \n virtual std::vector< std::vector >* getVprobe() {return NULL;};\n virtual std::vector< std::vector >* getSprobe() {return NULL;};\n virtual void clearProbes() const {};\n\n\n // Access\n\n};\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/registryModel/defaultRegistry/defaultRegistry.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"defaultRegistry.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(defaultRegistry, 0);\n\naddToRunTimeSelectionTable\n(\n registryModel,\n defaultRegistry,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\ndefaultRegistry::defaultRegistry\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n registryModel(dict,sm)\n{}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\ndefaultRegistry::~defaultRegistry()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/registryModel/defaultRegistry/defaultRegistry.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n defaultRegistry\n\nSourceFiles\n defaultRegistry.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef defaultRegistry_H\n#define defaultRegistry_H\n\n#include \"registryModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class defaultRegistry Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass defaultRegistry\n:\n public registryModel\n{\n\npublic:\n\n //- Runtime type information\n TypeName(\"defaultRegistry\");\n\n\n // Constructors\n\n //- Construct from components\n defaultRegistry\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~defaultRegistry();\n\n\n // Member Functions\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/registryModel/registryModel/newRegistryModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"registryModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\nautoPtr registryModel::New\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n{\n // for now always use default model here without asking for dict entry\n word registryModelType(\"defaultRegistry\");\n /*word registryModelType\n (\n dict.lookup(\"registryModel\")\n );\n\n Info<< \"Selecting registryModel \"\n << registryModelType << endl;*/\n\n\n dictionaryConstructorTable::iterator cstrIter =\n dictionaryConstructorTablePtr_->find(registryModelType);\n\n if (cstrIter == dictionaryConstructorTablePtr_->end())\n {\n FatalError\n << \"registryModel::New(const dictionary&, const spray&) : \"\n << endl\n << \" unknown registryModelType type \"\n << registryModelType\n << \", constructor not in hash table\" << endl << endl\n << \" Valid registryModel types are :\"\n << endl;\n Info<< dictionaryConstructorTablePtr_->toc()\n << abort(FatalError);\n }\n\n return autoPtr(cstrIter()(dict,sm));\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/registryModel/registryModel/registryModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n#include \"registryModel.H\"\n#include \"dataExchangeModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(registryModel, 0);\n\ndefineRunTimeSelectionTable(registryModel, dictionary);\n\n// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nvoid registryModel::addProperty(word name, scalar value) const\n{\n //Pout << \"trying to add the property\" << name << \" to registry, with a value of \" << value << endl;\n int index(checkIfExists(name,value));\n if(index > -1)\n {\n scalar newValue(max(value,valuesScalar_[index]));\n valuesScalar_[index] = newValue;\n //Pout << \" the property \" << name << \" was found in registry, the value is updated (if bigger than old) to \" << newValue << endl;\n }\n else\n {\n namesScalar_.append(name);\n valuesScalar_.append(value);\n //Pout << \" the property \" << name << \" is (NEW!!!) put to the registry, the value is set to \" << value << endl;\n }\n}\n\nscalar registryModel::getProperty(word name) const\n{\n //Pout << \"trying to receive the property\" << name << \" from the registry...\" << endl;\n int index(checkIfExists(name,scalar(1.)));\n if(index > -1)\n {\n //Pout << \" the property\" << name << \" was found in registry, the value is \" << valuesScalar_[index] << endl;\n return valuesScalar_[index];\n }\n else\n {\n //Pout << \" the property\" << name << \" is not found in the registry!\" << endl;\n return -1.; \n }\n}\n\ninline int registryModel::checkIfExists(word name, scalar value) const\n{\n for(int i=0;i New\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n\n // Member Functions\n\n void addProperty(word,scalar) const;\n\n scalar getProperty(word) const;\n\n inline int checkIfExists(word,scalar) const;\n\n\n // Access\n\n};\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/smoothingModel/constDiffSmoothing/constDiffSmoothing.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n Copyright (C) 2013- Graz University of \n Technology, IPPT\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"constDiffSmoothing.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(constDiffSmoothing, 0);\n\naddToRunTimeSelectionTable\n(\n smoothingModel,\n constDiffSmoothing,\n dictionary\n);\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nconstDiffSmoothing::constDiffSmoothing\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n smoothingModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n lowerLimit_(readScalar(propsDict_.lookup(\"lowerLimit\"))),\n upperLimit_(readScalar(propsDict_.lookup(\"upperLimit\"))),\n smoothingLength_(dimensionedScalar(\"smoothingLength\",dimensionSet(0,1,0,0,0,0,0), readScalar(propsDict_.lookup(\"smoothingLength\")))),\n smoothingLengthReferenceField_(dimensionedScalar(\"smoothingLengthReferenceField\",dimensionSet(0,1,0,0,0,0,0), readScalar(propsDict_.lookup(\"smoothingLength\")))),\n DT_(\"DT\", dimensionSet(0,2,-1,0,0), 0.),\n verbose_(false)\n{\n\n if(propsDict_.found(\"verbose\")) \n verbose_ = true;\n\n if(propsDict_.found(\"smoothingLengthReferenceField\")) \n smoothingLengthReferenceField_.value() = double(readScalar(propsDict_.lookup(\"smoothingLengthReferenceField\")));\n\n checkFields(sSmoothField_);\n checkFields(vSmoothField_);\n}\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nconstDiffSmoothing::~constDiffSmoothing()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\nbool constDiffSmoothing::doSmoothing() const\n{\n return true;\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\nvoid Foam::constDiffSmoothing::smoothen(volScalarField& fieldSrc) const\n{\n // Create scalar smooth field from virgin scalar smooth field template\n volScalarField sSmoothField = sSmoothField_;\n\n sSmoothField.dimensions().reset(fieldSrc.dimensions());\n sSmoothField ==fieldSrc;\n sSmoothField.correctBoundaryConditions();\n sSmoothField.oldTime().dimensions().reset(fieldSrc.dimensions());\n sSmoothField.oldTime()=fieldSrc;\n sSmoothField.oldTime().correctBoundaryConditions();\n\n double deltaT = sSmoothField.mesh().time().deltaTValue();\n DT_.value() = smoothingLength_.value() * smoothingLength_.value() / deltaT;\n\n // do smoothing\n solve\n (\n fvm::ddt(sSmoothField)\n -fvm::laplacian(DT_, sSmoothField)\n );\n\n // bound sSmoothField_\n forAll(sSmoothField,cellI)\n {\n sSmoothField[cellI]=max(lowerLimit_,min(upperLimit_,sSmoothField[cellI]));\n } \n\n // get data from working sSmoothField - will copy only values at new time\n fieldSrc=sSmoothField;\n fieldSrc.correctBoundaryConditions(); \n\n if(verbose_)\n {\n Info << \"min/max(fieldoldTime) (unsmoothed): \" << min(sSmoothField.oldTime()) << tab << max(sSmoothField.oldTime()) << endl;\n Info << \"min/max(fieldSrc): \" << min(fieldSrc) << tab << max(fieldSrc) << endl;\n Info << \"min/max(fieldSrc.oldTime): \" << min(fieldSrc.oldTime()) << tab << max(fieldSrc.oldTime()) << endl;\n }\n\n}\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\nvoid Foam::constDiffSmoothing::smoothen(volVectorField& fieldSrc) const\n{\n // Create scalar smooth field from virgin scalar smooth field template\n volVectorField vSmoothField = vSmoothField_;\n\n vSmoothField.dimensions().reset(fieldSrc.dimensions());\n vSmoothField=fieldSrc;\n vSmoothField.correctBoundaryConditions();\n vSmoothField.oldTime().dimensions().reset(fieldSrc.dimensions());\n vSmoothField.oldTime()=fieldSrc;\n vSmoothField.oldTime().correctBoundaryConditions();\n\n double deltaT = vSmoothField_.mesh().time().deltaTValue();\n DT_.value() = smoothingLength_.value() * smoothingLength_.value() / deltaT;\n\n // do smoothing\n solve\n (\n fvm::ddt(vSmoothField)\n -fvm::laplacian(DT_, vSmoothField)\n );\n\n // get data from working vSmoothField\n fieldSrc=vSmoothField;\n fieldSrc.correctBoundaryConditions(); \n\n if(verbose_)\n {\n Info << \"min/max(fieldoldTime) (unsmoothed): \" << min(vSmoothField.oldTime()) << tab << max(vSmoothField.oldTime()) << endl;\n Info << \"min/max(fieldSrc): \" << min(fieldSrc) << tab << max(fieldSrc) << endl;\n Info << \"min/max(fieldSrc.oldTime): \" << min(fieldSrc.oldTime()) << tab << max(fieldSrc.oldTime()) << endl;\n }\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\nvoid Foam::constDiffSmoothing::smoothenReferenceField(volVectorField& fieldSrc) const\n{\n // Create scalar smooth field from virgin scalar smooth field template\n volVectorField vSmoothField = vSmoothField_;\n\n vSmoothField.dimensions().reset(fieldSrc.dimensions());\n vSmoothField=fieldSrc;\n vSmoothField.correctBoundaryConditions();\n vSmoothField.oldTime().dimensions().reset(fieldSrc.dimensions());\n vSmoothField.oldTime()=fieldSrc;\n vSmoothField.oldTime().correctBoundaryConditions();\n\n double sourceStrength = 1e5; //large number to keep reference values constant\n\n dimensionedScalar deltaT = vSmoothField.mesh().time().deltaT();\n DT_.value() = smoothingLengthReferenceField_.value() \n * smoothingLengthReferenceField_.value() / deltaT.value();\n\n volScalarField NLarge\n (\n IOobject\n (\n \"NLarge\",\n particleCloud_.mesh().time().timeName(),\n particleCloud_.mesh(),\n IOobject::NO_READ,\n IOobject::NO_WRITE\n ),\n particleCloud_.mesh(),\n 0.0\n );\n\n\n //loop over particles and map max particle diameter to Euler Grid\n forAll(vSmoothField,cellI)\n {\n if ( mag(vSmoothField.oldTime().internalField()[cellI]) > 0.0f) // have a vector in the OLD vSmoothField, so keep it!\n NLarge[cellI] = sourceStrength;\n }\n\n // do the smoothing\n solve\n (\n fvm::ddt(vSmoothField)\n -fvm::laplacian( DT_, vSmoothField)\n == \n NLarge / deltaT * vSmoothField.oldTime() //add source to keep cell values constant\n -fvm::Sp( NLarge / deltaT, vSmoothField) //add sink to keep cell values constant\n );\n\n // get data from working vSmoothField\n fieldSrc=vSmoothField;\n fieldSrc.correctBoundaryConditions(); \n\n if(verbose_)\n {\n Info << \"min/max(fieldoldTime) (unsmoothed): \" << min(vSmoothField.oldTime()) << tab << max(vSmoothField.oldTime()) << endl;\n Info << \"min/max(fieldSrc): \" << min(fieldSrc) << tab << max(fieldSrc) << endl;\n Info << \"min/max(fieldSrc.oldTime): \" << min(fieldSrc.oldTime()) << tab << max(fieldSrc.oldTime()) << endl;\n }\n\n}\n\ndimensionedScalar Foam::constDiffSmoothing::smoothingLength() const\n{\n return smoothingLength_;\n}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/smoothingModel/constDiffSmoothing/constDiffSmoothing.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n Copyright (C) 2013- Graz University of \n Technology, IPPT\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n constDiffSmoothing\n\nSourceFiles\n constDiffSmoothing.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef constDiffSmoothing_H\n#define constDiffSmoothing_H\n\n#include \"smoothingModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class constDiffSmoothing Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass constDiffSmoothing\n:\n public smoothingModel\n{\n\nprivate:\n\n dictionary propsDict_;\n scalar lowerLimit_;\n scalar upperLimit_;\n dimensionedScalar smoothingLength_;\n dimensionedScalar smoothingLengthReferenceField_;\n mutable dimensionedScalar DT_;\n bool verbose_;\n\npublic:\n\n //- Runtime type information\n TypeName(\"constDiffSmoothing\");\n\n\n // Constructors\n\n //- Construct from components\n constDiffSmoothing\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~constDiffSmoothing();\n\n\n // Member Functions\n bool doSmoothing() const;\n\n //void dSmoothing(volScalarField&) const;\n \n void smoothen(volScalarField&) const;\n\n void smoothen(volVectorField&) const;\n\n void smoothenReferenceField(volVectorField&) const;\n\n dimensionedScalar smoothingLength() const;\n\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/smoothingModel/noSmoothing/noSmoothing.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"noSmoothing.H\"\n#include \"addToRunTimeSelectionTable.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(noSmoothing, 0);\n\naddToRunTimeSelectionTable\n(\n smoothingModel,\n noSmoothing,\n dictionary\n);\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nnoSmoothing::noSmoothing\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n smoothingModel(dict,sm)\n{}\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nnoSmoothing::~noSmoothing()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nvoid Foam::noSmoothing::smoothen(volScalarField& field) const\n{}\n\nvoid Foam::noSmoothing::smoothen(volVectorField& field) const\n{}\n\nvoid Foam::noSmoothing::smoothenAbsolutField(volScalarField& field) const\n{}\n\nvoid Foam::noSmoothing::smoothenAbsolutField(volVectorField& field) const\n{}\n\nvoid Foam::noSmoothing::smoothenReferenceField(volVectorField& field) const\n{}\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/smoothingModel/noSmoothing/noSmoothing.H", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\nClass\n noSmoothing\n\nSourceFiles\n noSmoothing.C\n\n\\*---------------------------------------------------------------------------*/\n\n#ifndef noSmoothing_H\n#define noSmoothing_H\n\n#include \"smoothingModel.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n/*---------------------------------------------------------------------------*\\\n Class noSmoothing Declaration\n\\*---------------------------------------------------------------------------*/\n\nclass noSmoothing\n:\n public smoothingModel\n{\n\npublic:\n\n //- Runtime type information\n TypeName(\"off\");\n\n\n // Constructors\n\n //- Construct from components\n noSmoothing\n (\n const dictionary& dict,\n cfdemCloud& sm\n );\n\n // Destructor\n\n ~noSmoothing();\n\n\n // Member Functions\n void smoothen(volScalarField&) const;\n\n void smoothen(volVectorField&) const;\n\n void smoothenAbsolutField(volScalarField&) const;\n\n void smoothenAbsolutField(volVectorField&) const;\n\n void smoothenReferenceField(volVectorField&) const;\n};\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n#endif\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/smoothingModel/smoothingModel/newSmoothingModel.C", "content": "/*---------------------------------------------------------------------------*\\\n CFDEMcoupling - Open Source CFD-DEM coupling\n\n CFDEMcoupling is part of the CFDEMproject\n www.cfdem.com\n Christoph Goniva, christoph.goniva@cfdem.com\n Copyright 2009-2012 JKU Linz\n Copyright 2012- DCS Computing GmbH, Linz\n-------------------------------------------------------------------------------\nLicense\n This file is part of CFDEMcoupling.\n\n CFDEMcoupling is free software; you can redistribute it and/or modify it\n under the terms of the GNU General Public License as published by the\n Free Software Foundation; either version 3 of the License, or (at your\n option) any later version.\n\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n for more details.\n\n You should have received a copy of the GNU General Public License\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n\nDescription\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\n\\*---------------------------------------------------------------------------*/\n\n#include \"error.H\"\n\n#include \"smoothingModel.H\"\n#include \"standardSearch.H\"\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\nautoPtr smoothingModel::New\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n{\n word smoothingModelType\n (\n dict.lookup(\"smoothingModel\")\n );\n\n Info<< \"Selecting smoothingModel \"\n << smoothingModelType << endl;\n\n\n dictionaryConstructorTable::iterator cstrIter =\n dictionaryConstructorTablePtr_->find(smoothingModelType);\n\n if (cstrIter == dictionaryConstructorTablePtr_->end())\n {\n FatalError\n << \"smoothingModel::New(const dictionary&, const spray&) : \"\n << endl\n << \" unknown smoothingModelType type \"\n << smoothingModelType\n << \", constructor not in hash table\" << endl << endl\n << \" Valid smoothingModel types are :\"\n << endl;\n Info<< dictionaryConstructorTablePtr_->toc()\n << abort(FatalError);\n }\n\n return autoPtr(cstrIter()(dict,sm));\n}\n\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\n} // End namespace Foam\n\n// ************************************************************************* //\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/smoothingModel/smoothingModel/smoothingModel.C", "content": "/*---------------------------------------------------------------------------*\\\r\n CFDEMcoupling - Open Source CFD-DEM coupling\r\n\r\n CFDEMcoupling is part of the CFDEMproject\r\n www.cfdem.com\r\n Christoph Goniva, christoph.goniva@cfdem.com\r\n Copyright 2009-2012 JKU Linz\r\n Copyright 2012- DCS Computing GmbH, Linz\r\n-------------------------------------------------------------------------------\r\nLicense\r\n This file is part of CFDEMcoupling.\r\n\r\n CFDEMcoupling is free software; you can redistribute it and/or modify it\r\n under the terms of the GNU General Public License as published by the\r\n Free Software Foundation; either version 3 of the License, or (at your\r\n option) any later version.\r\n\r\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\r\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\r\n for more details.\r\n\r\n You should have received a copy of the GNU General Public License\r\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\r\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\r\n\r\nDescription\r\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\r\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\r\n\\*---------------------------------------------------------------------------*/\r\n\r\n#include \"error.H\"\r\n#include \"smoothingModel.H\"\r\n\r\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\r\n\r\nnamespace Foam\r\n{\r\n\r\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\r\n\r\ndefineTypeNameAndDebug(smoothingModel, 0);\r\n\r\ndefineRunTimeSelectionTable(smoothingModel, dictionary);\r\n\r\n// * * * * * * * * * * * * * public Member Functions * * * * * * * * * * * * //\r\n\r\n// * * * * * * * * * * * * * private Member Functions * * * * * * * * * * * * //\r\n\r\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\r\n\r\n// Construct from components\r\nFoam::smoothingModel::smoothingModel\r\n(\r\n const dictionary& dict,\r\n cfdemCloud& sm\r\n)\r\n:\r\n dict_(dict),\r\n particleCloud_(sm),\r\n vSmoothField_\r\n ( \r\n IOobject\r\n (\r\n \"vSmoothField\",\r\n particleCloud_.mesh().time().timeName(),\r\n particleCloud_.mesh(),\r\n IOobject::READ_IF_PRESENT,\r\n IOobject::NO_WRITE\r\n ),\r\n particleCloud_.mesh(),\r\n dimensionedVector(\"zero\", dimensionSet(0,0,0,0,0), vector::zero)\r\n ),\r\n sSmoothField_\r\n ( \r\n IOobject\r\n (\r\n \"sSmoothField\",\r\n particleCloud_.mesh().time().timeName(),\r\n particleCloud_.mesh(),\r\n IOobject::READ_IF_PRESENT,\r\n IOobject::NO_WRITE\r\n ),\r\n particleCloud_.mesh(),\r\n dimensionedScalar(\"zero\", dimensionSet(0,0,0,0,0), 0)\r\n ),\r\n smoothingLength_(dimensionedScalar(\"zero\", dimensionSet(0,0,0,0,0), 0))\r\n{}\r\n\r\n\r\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\r\n\r\nFoam::smoothingModel::~smoothingModel()\r\n{}\r\n\r\n\r\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\r\n\r\nvoid smoothingModel::checkFields(volScalarField& sSmoothField_) const\r\n{\r\n // currently it is detected if field was auto generated or defined\r\n // improvement would be changing the type here automatically\r\n forAll(sSmoothField_.boundaryField(),patchI)\r\n if(sSmoothField_.boundaryField()[patchI].type()==\"calculated\")\r\n FatalError <<\"Scalar field:\"<< sSmoothField_.name() << \" must be defined.\\n\" << abort(FatalError);\r\n\r\n sSmoothField_.writeOpt() = IOobject::AUTO_WRITE;\r\n}\r\n\r\nvoid smoothingModel::checkFields(volVectorField& vSmoothField_) const\r\n{\r\n // currently it is detected if field was auto generated or defined\r\n // improvement would be changing the type here automatically\r\n forAll(vSmoothField_.boundaryField(),patchI) \r\n if(vSmoothField_.boundaryField()[patchI].type()==\"calculated\")\r\n FatalError <<\"Vector field:\"<< vSmoothField_.name() << \" must be defined.\\n\" << abort(FatalError);\r\n\r\n vSmoothField_.writeOpt() = IOobject::AUTO_WRITE;\r\n}\r\n\r\n// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\r\nbool smoothingModel::doSmoothing() const\r\n{\r\n return false;\r\n}\r\n\r\nvoid smoothingModel::dSmoothing() const\r\n{\r\n // do nothing\r\n //dSmooth *= 0.0;\r\n}\r\n\r\n\r\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\r\nvoid smoothingModel::smoothenAbsolutField(volScalarField& scalField) const\r\n{\r\n\r\n //1 - First make the field volume-specific\r\n particleCloud_.makeSpecific(scalField);\r\n\r\n //2 - smoothen now the volume-specific field (the volume integral of this field will be conserved!)\r\n smoothen(scalField);\r\n\r\n //3 - Finally, make field absolute again\r\n particleCloud_.scaleWithVcell(scalField);\r\n}\r\n\r\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\r\nvoid smoothingModel::smoothenAbsolutField(volVectorField& vecField) const\r\n{\r\n\r\n //1 - First make the field volume-specific\r\n particleCloud_.makeSpecific(vecField);\r\n\r\n //2 - smoothen now the volume-specific field (the volume integral of this field will be conserved!)\r\n smoothen(vecField);\r\n\r\n //3 - Finally, make field absolute again\r\n particleCloud_.scaleWithVcell(vecField);\r\n}\r\n\r\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\r\ndimensionedScalar smoothingModel::smoothingLength() const\r\n{\r\n return smoothingLength_;\r\n}\r\n\r\n} // End namespace Foam\r\n\r\n// ************************************************************************* //\r\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/smoothingModel/smoothingModel/smoothingModel.H", "content": "/*---------------------------------------------------------------------------*\\\r\n CFDEMcoupling - Open Source CFD-DEM coupling\r\n\r\n CFDEMcoupling is part of the CFDEMproject\r\n www.cfdem.com\r\n Christoph Goniva, christoph.goniva@cfdem.com\r\n Copyright 2009-2012 JKU Linz\r\n Copyright 2012- DCS Computing GmbH, Linz\r\n-------------------------------------------------------------------------------\r\nLicense\r\n This file is part of CFDEMcoupling.\r\n\r\n CFDEMcoupling is free software; you can redistribute it and/or modify it\r\n under the terms of the GNU General Public License as published by the\r\n Free Software Foundation; either version 3 of the License, or (at your\r\n option) any later version.\r\n\r\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\r\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\r\n for more details.\r\n\r\n You should have received a copy of the GNU General Public License\r\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\r\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\r\n\r\nDescription\r\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\r\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\r\n\r\nClass\r\n smoothingModel\r\n\r\nSourceFiles\r\n smoothingModel.C\r\n\r\n\\*---------------------------------------------------------------------------*/\r\n\r\n#ifndef smoothingModel_H\r\n#define smoothingModel_H\r\n\r\n#include \"fvCFD.H\"\r\n#include \"cfdemCloud.H\"\r\n\r\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\r\n\r\nnamespace Foam\r\n{\r\n\r\n/*---------------------------------------------------------------------------*\\\r\n Class smoothingModel Declaration\r\n\\*---------------------------------------------------------------------------*/\r\n\r\nclass smoothingModel\r\n{\r\nprotected:\r\n\r\n // Protected data\r\n const dictionary& dict_;\r\n cfdemCloud& particleCloud_;\r\n\r\n mutable volVectorField vSmoothField_;\r\n mutable volScalarField sSmoothField_;\r\n\r\n void checkFields(volScalarField&) const;\r\n void checkFields(volVectorField&) const;\r\n\r\n dimensionedScalar smoothingLength_;\r\n \r\npublic:\r\n\r\n //- Runtime type information\r\n TypeName(\"smoothingModel\");\r\n\r\n // Declare runtime constructor selection table\r\n\r\n declareRunTimeSelectionTable\r\n (\r\n autoPtr,\r\n smoothingModel,\r\n dictionary,\r\n (\r\n const dictionary& dict,\r\n cfdemCloud& sm\r\n ),\r\n (dict,sm)\r\n );\r\n\r\n // Constructors\r\n\r\n //- Construct from components\r\n smoothingModel\r\n (\r\n const dictionary& dict,\r\n cfdemCloud& sm\r\n );\r\n\r\n // Destructor\r\n\r\n virtual ~smoothingModel();\r\n\r\n // Selector\r\n\r\n static autoPtr New\r\n (\r\n const dictionary& dict,\r\n cfdemCloud& sm\r\n );\r\n\r\n // Member Functions\r\n\r\n virtual bool doSmoothing() const;\r\n\r\n // the particle diameter for smoothing\r\n virtual void dSmoothing() const;\r\n\r\n virtual void smoothen(volScalarField&) const=0;\r\n\r\n virtual void smoothen(volVectorField&) const=0;\r\n\r\n virtual void smoothenAbsolutField(volScalarField&) const; //for smoothing absolute fields (NOT per m³)\r\n\r\n virtual void smoothenAbsolutField(volVectorField&) const; //for smoothing absolute fields (NOT per m³)\r\n\r\n virtual void smoothenReferenceField(volVectorField&) const=0;\r\n\r\n virtual dimensionedScalar smoothingLength() const;\r\n};\r\n\r\n\r\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\r\n\r\n} // End namespace Foam\r\n\r\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\r\n\r\n#endif\r\n\r\n// ************************************************************************* //\r\n" }, { "path": "src/lagrangian/cfdemParticle/subModels/voidFractionModel/GaussVoidFraction/GaussVoidFraction.C", "content": "/*---------------------------------------------------------------------------*\\\r\n CFDEMcoupling - Open Source CFD-DEM coupling\r\n\r\n CFDEMcoupling is part of the CFDEMproject\r\n www.cfdem.com\r\n Christoph Goniva, christoph.goniva@cfdem.com\r\n Copyright 2009-2012 JKU Linz\r\n Copyright 2012- DCS Computing GmbH, Linz\r\n-------------------------------------------------------------------------------\r\nLicense\r\n This file is part of CFDEMcoupling.\r\n\r\n CFDEMcoupling is free software; you can redistribute it and/or modify it\r\n under the terms of the GNU General Public License as published by the\r\n Free Software Foundation; either version 3 of the License, or (at your\r\n option) any later version.\r\n\r\n CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT\r\n ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r\n FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\r\n for more details.\r\n\r\n You should have received a copy of the GNU General Public License\r\n along with CFDEMcoupling; if not, write to the Free Software Foundation,\r\n Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\r\n\r\nDescription\r\n This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS\r\n and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).\r\n\\*---------------------------------------------------------------------------*/\r\n\r\n#include \"error.H\"\r\n\r\n#include \"GaussVoidFraction.H\"\r\n#include \"addToRunTimeSelectionTable.H\"\r\n#include \"locateModel.H\"\r\n#include \"dataExchangeModel.H\"\r\n\r\n\r\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\r\n\r\nnamespace Foam\r\n{\r\n\r\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\r\n\r\ndefineTypeNameAndDebug(GaussVoidFraction, 0);\r\n\r\naddToRunTimeSelectionTable\r\n(\r\n voidFractionModel,\r\n GaussVoidFraction,\r\n dictionary\r\n);\r\n\r\n\r\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\r\n\r\n// Construct from components\r\nGaussVoidFraction::GaussVoidFraction\r\n(\r\n const dictionary& dict,\r\n cfdemCloud& sm\r\n)\r\n:\r\n voidFractionModel(dict,sm),\r\n propsDict_(dict.subDict(typeName + \"Props\")),\r\n alphaMin_(propsDict_.lookupOrDefault(\"alphaMin\",0.1)),\r\n alphaLimited_(0)\r\n{\r\n Info << \"\\n\\n W A R N I N G - do not use in combination with differentialRegion model! \\n\\n\" << endl;\r\n FatalError << \"\\n\\n This model does not yet work properly - Eqns need to be revised!!! \\n\\n\" << abort(FatalError);\r\n //reading maxCellsPerParticle from dictionary\r\n maxCellsPerParticle_=readLabel(propsDict_.lookup(\"maxCellsPerParticle\"));\r\n //particleCloud_.setMaxCellsPerParticle(readLabel(propsDict_.lookup(\"maxCellsPerParticle\"))); // alternative to line above\r\n if(alphaMin_ > 1 || alphaMin_ < 0.01){ FatalError<< \"alphaMin shloud be > 1 and < 0.01.\" << abort(FatalError); }\r\n\r\n checkWeightNporosity(propsDict_);\r\n}\r\n\r\n\r\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\r\n\r\nGaussVoidFraction::~GaussVoidFraction()\r\n{}\r\n\r\n\r\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\r\n\r\nvoid GaussVoidFraction::setvoidFraction(double** const& mask,double**& voidfractions,double**& particleWeights,double**& particleVolumes,double**& particleV) const\r\n{\r\n reAllocArrays();\r\n\r\n voidfractionNext_ == dimensionedScalar(\"one\", voidfractionNext_.dimensions(), 1.);\r\n\r\n scalar radius(-1);\r\n scalar volume(0);\r\n scalar scaleVol= weight();\r\n scalar scaleRadius = pow(porosity(),1./3.);\r\n\r\n for(int index=0; index< particleCloud_.numberOfParticles(); index++)\r\n {\r\n //if(mask[index][0])\r\n //{\r\n //reset\r\n for(int subcell=0;subcell= 0)\r\n {\r\n labelHashSet hashSett;\r\n\r\n //determining label and degree of coveredness of cells covered by the particle\r\n buildLabelHashSet(radius*3.0, positionCenter, particleCenterCellID, hashSett);\r\n //Info << \"completeSize=\" << hashSett.size() << \", completeList =\\n\" << endl;\r\n //for(label i=0;i maxCellsPerParticle_)\r\n {\r\n FatalError<< \"big particle algo found more cells (\"<< hashSetLength\r\n <<\") than storage is prepared (\"< 0)\r\n {\r\n cellsPerParticle_[index][0]=hashSetLength;\r\n\r\n //making sure that the cell containing the center is the first subcell\r\n particleCloud_.cfdemCloud::cellIDs()[index][0]=particleCenterCellID;\r\n //deleting the cell containing the center of the particle\r\n hashSett.erase(particleCenterCellID);\r\n\r\n //==========================//\r\n //setting the voidfractions\r\n\r\n // ===\r\n\t\t dist = mag(particleCloud_.mesh().C()[particleCenterCellID]-particleCloud_.cfdemCloud::position(index));\r\n\t\t core = pow(2.0/radius/radius/M_PI,1.5)*exp(-dist*dist/2.0/radius/radius)*particleCloud_.mesh().V()[particleCenterCellID]; //TODO revise!!!\r\n\r\n // ===\r\n\r\n // volume occupied in every covered cell\r\n scalar occupiedVolume = volume*core;\r\n\r\n // correct volumefraction of centre\r\n voidfractionNext_[particleCenterCellID] -=occupiedVolume/particleCloud_.mesh().V()[particleCenterCellID];\r\n\r\n particleWeights[index][0] += core;\r\n particleVolumes[index][0] += occupiedVolume;\r\n particleV[index][0] += occupiedVolume;\r\n\r\n //Info << \"Centre:set voidfraction in cellI=\" << particleCenterCellID\r\n // << \", voidfraction =\" << voidfractionNext_[particleCenterCellID] << endl;\r\n\r\n // correct volumefraction of sub-cells\r\n for(label i=0;i= 0)\r\n {\r\n // limiting voidfraction\r\n if (voidfractionNext_[cellID] < alphaMin_) voidfractionNext_[cellID]=alphaMin_;\r\n\r\n // set particle based voidfraction\r\n voidfractions[index][subcell] = voidfractionNext_[cellID];\r\n //Info<<\"setting the voidfraction, index = \"<\n\n// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //\n\nnamespace Foam\n{\n\n// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //\n\ndefineTypeNameAndDebug(IBVoidFraction, 0);\n\naddToRunTimeSelectionTable\n(\n voidFractionModel,\n IBVoidFraction,\n dictionary\n);\n\n\n// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //\n\n// Construct from components\nIBVoidFraction::IBVoidFraction\n(\n const dictionary& dict,\n cfdemCloud& sm\n)\n:\n voidFractionModel(dict,sm),\n propsDict_(dict.subDict(typeName + \"Props\")),\n alphaMin_(propsDict_.lookupOrDefault(\"alphaMin\",0.1)),\n alphaLimited_(0),\n scaleUpVol_(readScalar(propsDict_.lookup(\"scaleUpVol\"))),\n sqrtThree_(sqrt(3.0))\n{\n Info << \"\\n\\n W A R N I N G - do not use in combination with differentialRegion model! \\n\\n\" << endl;\n //Info << \"\\n\\n W A R N I N G - this model does not yet work properly! \\n\\n\" << endl;\n maxCellsPerParticle_=readLabel(propsDict_.lookup(\"maxCellsPerParticle\"));\n //particleCloud_.setMaxCellsPerParticle(readLabel(propsDict_.lookup(\"maxCellsPerParticle\"))); // alternative to line above\n\n if(scaleUpVol_ < 1){ FatalError<< \"scaleUpVol shloud be > 1.\"<< abort(FatalError); }\n if(alphaMin_ > 1 || alphaMin_ < 0.01){ FatalError<< \"alphaMin shloud be > 1 and < 0.01.\" << abort(FatalError); }\n \n}\n\n\n// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //\n\nIBVoidFraction::~IBVoidFraction()\n{}\n\n\n// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //\n\nvoid IBVoidFraction::setvoidFraction(double** const& mask,double**& voidfractions,double**& particleWeights,double**& particleVolumes,double**& particleV) const\n{\n\n int numprocs, me;\n MPI_Comm_size(MPI_COMM_WORLD, &numprocs);\n MPI_Comm_rank(MPI_COMM_WORLD, &me);\n const boundBox& globalBb = particleCloud_.mesh().bounds();\n\n reAllocArrays();\n\n voidfractionNext_ == dimensionedScalar(\"one\", voidfractionNext_.dimensions(), 1.);\n\n for(int index=0; index < particleCloud_.numberOfParticles(); index++)\n {\n //if(mask[index][0])\n //{\n //reset\n for(int subcell=0;subcell= 0)\n {\n labelHashSet hashSett;\n\n //compute the voidfraction for the cell \"particleCentreCellID\n vector cellCentrePosition = particleCloud_.mesh().C()[particleCenterCellID];\n scalar fc = pointInParticle(index, positionCenter, cellCentrePosition);\n\n vector minPeriodicParticlePos=positionCenter;\n if(particleCloud_.checkPeriodicCells()) //consider minimal distance to all periodic images of this particle\n {\n fc = minPeriodicDistance(index,cellCentrePosition, positionCenter, globalBb,\n minPeriodicParticlePos,\n particleCloud_.wall_periodicityCheckRange());\n }\n scalar centreDist=mag(cellCentrePosition-minPeriodicParticlePos);\n scalar corona = 0.5*sqrtThree_*cbrt(particleCloud_.mesh().V()[particleCenterCellID]);\n vector coronaPoint = cellCentrePosition;\n if(centreDist > 0.0)\n coronaPoint = cellCentrePosition + (cellCentrePosition - minPeriodicParticlePos) * (corona / centreDist);\n\n if(pointInParticle(index, minPeriodicParticlePos, coronaPoint) < 0.0)\n {\n voidfractionNext_[particleCenterCellID] = 0;\n }\n else\n {\n const labelList& vertices = particleCloud_.mesh().cellPoints()[particleCenterCellID];\n int nn = 0.0;\n forAll(vertices, i) nn ++;\n\n double ratio = 0.125; //1.0 / static_cast(nn);\n forAll(vertices, i)\n {\n vector vertexPosition = particleCloud_.mesh().points()[vertices[i]];\n scalar fv = pointInParticle(index, positionCenter, vertexPosition);\n if(particleCloud_.checkPeriodicCells()) { //consider minimal distance to all periodic images of this particle\n fv = minPeriodicDistance(index,vertexPosition, positionCenter, globalBb, \n minPeriodicParticlePos,\n particleCloud_.wall_periodicityCheckRange());\n }\n if(fc < 0.0 && fv < 0.0)\n voidfractionNext_[particleCenterCellID]-=ratio;\n else if(fc < 0.0 && fv > 0.0) {\n //compute lambda\n scalar lambda = segmentParticleIntersection(index, minPeriodicParticlePos, cellCentrePosition, vertexPosition);\n voidfractionNext_[particleCenterCellID] -= ratio*lambda;\n } else if(fc > 0.0 && fv < 0.0) {\n //compute lambda\n scalar lambda = segmentParticleIntersection(index, minPeriodicParticlePos, vertexPosition, cellCentrePosition);\n voidfractionNext_[particleCenterCellID] -= ratio*lambda;\n }\n }\n } //end particle partially overlapping with cell\n\n //generating list with cell and subcells\n buildLabelHashSet(index,minPeriodicParticlePos, particleCenterCellID, hashSett, true);\n\n //Add cells of periodic particle images on same processor\n if(particleCloud_.checkPeriodicCells())\n {\n int doPeriodicImage[3];\n for(int iDir=0;iDir<3;iDir++)\n {\n doPeriodicImage[iDir]= 0;\n if( (minPeriodicParticlePos[iDir]+radius)>globalBb.max()[iDir] && particleCloud_.wall_periodicityCheckRange(iDir)>0)\n {\n doPeriodicImage[iDir] =-1;\n }\n if( (minPeriodicParticlePos[iDir]-radius)0)\n {\n doPeriodicImage[iDir] = 1;\n }\n }\n //scan directions and map particles\n List particlePosList; //List of particle center position\n List