diff --git a/COPYING b/COPYING deleted file mode 100644 index de2dcce..0000000 --- a/COPYING +++ /dev/null @@ -1,678 +0,0 @@ -------------------------------------------------------------------------- - - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program 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. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. - -------------------------------------------------------------------------- diff --git a/DISCLAIMER b/DISCLAIMER deleted file mode 100644 index 5a7dfe2..0000000 --- a/DISCLAIMER +++ /dev/null @@ -1,10 +0,0 @@ -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. - -Detailed information on the OpenFOAM trademark can be found at - - - http://www.openfoam.com/legal/trademark-policy.php - - http://www.openfoam.com/legal/trademark-guidelines.php - -For further information on OpenCFD and OpenFOAM, please refer to - - - http://www.openfoam.com diff --git a/README b/README deleted file mode 100755 index 816c6c1..0000000 --- a/README +++ /dev/null @@ -1,107 +0,0 @@ -/*---------------------------------------------------------------------------*\ - CFDEMcoupling - Open Source CFD-DEM coupling - - CFD-DEM coupling toolbox, released by - DCS Computing GmbH, Linz, Austria - www.dcs-computing.com, office@dcs-computing.com - - CFDEMcoupling is part of the CFDEMproject - www.cfdem.com - - CFDEMcoupling 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. - - CFDEMcoupling is part of CFDEMproject: - www.liggghts.com | www.cfdem.com - - Core developer and main author: - Christoph Goniva, christoph.goniva@dcs-computing.com - - LIGGGHTS® 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. -/*---------------------------------------------------------------------------*\ -Copyright - - Copyright 2012- DCS Computing GmbH, Linz - Copyright 2009-2015 JKU Linz - - Some parts of CFDEMcoupling 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. -/*---------------------------------------------------------------------------*\ -License - - This file is part of CFDEMcoupling. - - CFDEMcoupling 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. - - CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT - ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or - FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License - for more details. - - You should have received a copy of the GNU General Public License - along with CFDEMcoupling; if not, write to the Free Software Foundation, - Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -/*---------------------------------------------------------------------------*\ -Description - This code provides models and solvers to realize coupled CFD-DEM simulations - using LIGGGHTS and OpenFOAM® technology. - Note: this code is not part of OpenFOAM®. - 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. -\*---------------------------------------------------------------------------*/ - - -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. - -The coupled solvers run fully parallel on distributed-memory clusters. - -Features are: - -- its modular approach allows users to easily implement new models -- its MPI parallelization enables to use it for large scale problems -- the "forum" (www.cfdem.com) on CFD-DEM gives the possibility - to exchange with other users / developers -- the use of GIT allows to easily update to the latest version -- basic documentation is provided - -The CFDEM®coupling distribution includes the following files and directories: - -- "README" file (this file) -- "COPYING" file the GNU General Public License (GPL) -- "DISCLAIMER" file -- "src" directory including the source files of the coupling toolbox and models -- "applications" directory including the solver files for coupled CFD-DEM simulations -- "doc" directory including the documentation of CFDEM®coupling -- "tutorials" directory including basic tutorial cases showing the functionality - -Details on installation are given on the "www.cfdem.com" website. - -The functionality of this CFD-DEM framwork is described via "tutorial cases" showing -how to use different solvers and models. - -CFDEM®coupling stands for Computational Fluid Dynamics (CFD) - -Discrete Element Method (DEM) coupling. - -\*---------------------------------------------------------------------------*/ -(*) 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. -\*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/cfdemSolverIB/cfdemSolverIB.C b/applications/solvers/cfdemSolverIB/cfdemSolverIB.C index a45a519..3a005b1 100755 --- a/applications/solvers/cfdemSolverIB/cfdemSolverIB.C +++ b/applications/solvers/cfdemSolverIB/cfdemSolverIB.C @@ -121,7 +121,7 @@ int main(int argc, char *argv[]) // do particle stuff Info << "- evolve()" << endl; - particleCloud.evolve(voidfraction); + particleCloud.evolve(voidfraction, interFace); // Pressure-velocity PISO corrector { diff --git a/applications/solvers/cfdemSolverIB/createFields.H b/applications/solvers/cfdemSolverIB/createFields.H index 017d435..276d6e2 100755 --- a/applications/solvers/cfdemSolverIB/createFields.H +++ b/applications/solvers/cfdemSolverIB/createFields.H @@ -42,6 +42,21 @@ mesh ); + /*Info<< "\nCreating outside field\n" << endl; + volScalarField outside + ( + IOobject + ( + "outside", + runTime.timeName(), + mesh, + IOobject::NO_READ, + IOobject::AUTO_WRITE + ), + mesh, + scalar(0) + );*/ + //======================== // drag law modelling //======================== diff --git a/applications/solvers/cfdemSolverPiso/cfdemSolverPiso.C b/applications/solvers/cfdemSolverPiso/cfdemSolverPiso.C index 31651a1..104a0a8 100644 --- a/applications/solvers/cfdemSolverPiso/cfdemSolverPiso.C +++ b/applications/solvers/cfdemSolverPiso/cfdemSolverPiso.C @@ -108,13 +108,16 @@ int main(int argc, char *argv[]) if(hasEvolved) { - particleCloud.smoothingM().smoothen(particleCloud.forceM(0).impParticleForces()); + particleCloud.smoothingM().smoothenAbsolutField(particleCloud.forceM(0).impParticleForces()); } Info << "update Ksl.internalField()" << endl; Ksl = particleCloud.momCoupleM(0).impMomSource(); Ksl.correctBoundaryConditions(); + surfaceScalarField voidfractionf = fvc::interpolate(voidfraction); + phi = voidfractionf*phiByVoidfraction; + //Force Checks #include "forceCheckIm.H" @@ -168,18 +171,46 @@ int main(int argc, char *argv[]) U = rUA*UEqn.H(); #ifdef version23 - phi = ( fvc::interpolate(U*voidfraction) & mesh.Sf() ) - + rUAfvoidfraction*fvc::ddtCorr(U, phi); + phi = ( fvc::interpolate(U) & mesh.Sf() ) + + rUAfvoidfraction*fvc::ddtCorr(U, phiByVoidfraction); #else - phi = ( fvc::interpolate(U*voidfraction) & mesh.Sf() ) - + fvc::ddtPhiCorr(rUAvoidfraction, U, phi); + phi = ( fvc::interpolate(U) & mesh.Sf() ) + + fvc::ddtPhiCorr(rUAvoidfraction, U, phiByVoidfraction); #endif - surfaceScalarField phiS(fvc::interpolate(Us*voidfraction) & mesh.Sf()); - surfaceScalarField phiGes = phi + rUAf*(fvc::interpolate(Ksl/rho) * phiS); + surfaceScalarField phiS(fvc::interpolate(Us) & mesh.Sf()); + phi += rUAf*(fvc::interpolate(Ksl/rho) * phiS); if (modelType=="A") rUAvoidfraction = volScalarField("(voidfraction2|A(U))",rUA*voidfraction*voidfraction); + // Update the fixedFluxPressure BCs to ensure flux consistency + #ifndef versionExt32 + #ifndef version40 + if (modelType=="A") + { + setSnGrad + ( + p.boundaryField(), + ( + phi.boundaryField() + - (mesh.Sf().boundaryField() & U.boundaryField()) + )/(mesh.magSf().boundaryField()*rUAf.boundaryField()*voidfractionf.boundaryField()) + ); + }else + { + setSnGrad + ( + p.boundaryField(), + ( + phi.boundaryField() + - (mesh.Sf().boundaryField() & U.boundaryField()) + )/(mesh.magSf().boundaryField()*rUAf.boundaryField()) + ); + } + #endif + #endif + + // Non-orthogonal pressure corrector loop #if defined(version30) while (piso.correctNonOrthogonal()) @@ -190,7 +221,7 @@ int main(int argc, char *argv[]) // Pressure corrector fvScalarMatrix pEqn ( - fvm::laplacian(rUAvoidfraction, p) == fvc::div(phiGes) + particleCloud.ddtVoidfraction() + fvm::laplacian(rUAvoidfraction, p) == fvc::div(voidfractionf*phi) + particleCloud.ddtVoidfraction() ); pEqn.setReference(pRefCell, pRefValue); @@ -198,8 +229,7 @@ int main(int argc, char *argv[]) pEqn.solve(mesh.solver(p.select(piso.finalInnerIter()))); if (piso.finalNonOrthogonalIter()) { - phiGes -= pEqn.flux(); - phi = phiGes; + phiByVoidfraction = phi - pEqn.flux()/voidfractionf; } #else if( corr == nCorr-1 && nonOrth == nNonOrthCorr ) @@ -213,13 +243,13 @@ int main(int argc, char *argv[]) if (nonOrth == nNonOrthCorr) { - phiGes -= pEqn.flux(); - phi = phiGes; + phiByVoidfraction = phi - pEqn.flux()/voidfractionf; } #endif } // end non-orthogonal corrector loop + phi = voidfractionf*phiByVoidfraction; #include "continuityErrorPhiPU.H" if (modelType=="B" || modelType=="Bfull") diff --git a/applications/solvers/cfdemSolverPiso/createFields.H b/applications/solvers/cfdemSolverPiso/createFields.H index 849ef33..a09be9a 100644 --- a/applications/solvers/cfdemSolverPiso/createFields.H +++ b/applications/solvers/cfdemSolverPiso/createFields.H @@ -60,7 +60,7 @@ mesh ); - Info<< "\nCreating dummy density field rho\n" << endl; + Info<< "\nCreating density field rho\n" << endl; volScalarField rho ( IOobject @@ -109,7 +109,19 @@ surfaceScalarField phi ); #endif - +Info<< "Generating interstitial face flux field phiByVoidfraction\n" << endl; +surfaceScalarField phiByVoidfraction +( + IOobject + ( + "phiByVoidfraction", + runTime.timeName(), + mesh, + IOobject::NO_READ, + IOobject::NO_WRITE + ), + linearInterpolate(U) & mesh.Sf() +); label pRefCell = 0; scalar pRefValue = 0.0; diff --git a/applications/solvers/cfdemSolverPisoSTM/cfdemSolverPisoSTM.C b/applications/solvers/cfdemSolverPisoSTM/cfdemSolverPisoSTM.C index 5cfb879..d4763f8 100644 --- a/applications/solvers/cfdemSolverPisoSTM/cfdemSolverPisoSTM.C +++ b/applications/solvers/cfdemSolverPisoSTM/cfdemSolverPisoSTM.C @@ -106,13 +106,16 @@ int main(int argc, char *argv[]) if(hasEvolved) { - particleCloud.smoothingM().smoothen(particleCloud.forceM(0).impParticleForces()); + particleCloud.smoothingM().smoothenAbsolutField(particleCloud.forceM(0).impParticleForces()); } Info << "update Ksl.internalField()" << endl; Ksl = particleCloud.momCoupleM(0).impMomSource(); Ksl.correctBoundaryConditions(); + surfaceScalarField voidfractionf = fvc::interpolate(voidfraction); + phi = voidfractionf*phiByVoidfraction; + //Force Checks #include "forceCheckIm.H" @@ -121,24 +124,12 @@ int main(int argc, char *argv[]) particleCloud.clockM().start(26,"Flow"); - /*// get scalar source from DEM + // get scalar source from DEM particleCloud.forceM(1).manipulateScalarField(Tsource); - Tsource.correctBoundaryConditions();*/ + Tsource.correctBoundaryConditions(); stm().update(); - /*// solve scalar transport equation - fvScalarMatrix TEqn - ( - fvm::ddt(voidfraction,T) - fvm::Sp(fvc::ddt(voidfraction),T) - + fvm::div(phi, T) - fvm::Sp(fvc::div(phi),T) - - fvm::laplacian(DT*voidfraction, T) - == - Tsource - ); - TEqn.relax(); - TEqn.solve();*/ - particleCloud.clockM().start(26,"Flow"); if(particleCloud.solveFlow()) @@ -186,23 +177,23 @@ int main(int argc, char *argv[]) U = rUA*UEqn.H(); #ifdef version23 - phi = ( fvc::interpolate(U*voidfraction) & mesh.Sf() ) - + rUAfvoidfraction*fvc::ddtCorr(U, phi); + phi = ( fvc::interpolate(U) & mesh.Sf() ) + + rUAfvoidfraction*fvc::ddtCorr(U, phiByVoidfraction); #else - phi = ( fvc::interpolate(U*voidfraction) & mesh.Sf() ) - + fvc::ddtPhiCorr(rUAvoidfraction, U, phi); + phi = ( fvc::interpolate(U) & mesh.Sf() ) + + fvc::ddtPhiCorr(rUAvoidfraction, U, phiByVoidfraction); #endif - surfaceScalarField phiS(fvc::interpolate(Us*voidfraction) & mesh.Sf()); - surfaceScalarField phiGes = phi + rUAf*(fvc::interpolate(Ksl/rho) * phiS); + surfaceScalarField phiS(fvc::interpolate(Us) & mesh.Sf()); + phi += rUAf*(fvc::interpolate(Ksl/rho) * phiS); if (modelType=="A") rUAvoidfraction = volScalarField("(voidfraction2|A(U))",rUA*voidfraction*voidfraction); // Update the fixedFluxPressure BCs to ensure flux consistency #ifndef versionExt32 + #ifndef version40 if (modelType=="A") { - surfaceScalarField voidfractionf(fvc::interpolate(voidfraction)); setSnGrad ( p.boundaryField(), @@ -223,6 +214,8 @@ int main(int argc, char *argv[]) ); } #endif + #endif + // Non-orthogonal pressure corrector loop #if defined(version30) @@ -234,7 +227,7 @@ int main(int argc, char *argv[]) // Pressure corrector fvScalarMatrix pEqn ( - fvm::laplacian(rUAvoidfraction, p) == fvc::div(phiGes) + particleCloud.ddtVoidfraction() + fvm::laplacian(rUAvoidfraction, p) == fvc::div(voidfractionf*phi) + particleCloud.ddtVoidfraction() ); pEqn.setReference(pRefCell, pRefValue); @@ -242,8 +235,7 @@ int main(int argc, char *argv[]) pEqn.solve(mesh.solver(p.select(piso.finalInnerIter()))); if (piso.finalNonOrthogonalIter()) { - phiGes -= pEqn.flux(); - phi = phiGes; + phiByVoidfraction = phi - pEqn.flux()/voidfractionf; } #else if( corr == nCorr-1 && nonOrth == nNonOrthCorr ) @@ -257,13 +249,13 @@ int main(int argc, char *argv[]) if (nonOrth == nNonOrthCorr) { - phiGes -= pEqn.flux(); - phi = phiGes; + phiByVoidfraction = phi - pEqn.flux()/voidfractionf; } #endif } // end non-orthogonal corrector loop + phi = voidfractionf*phiByVoidfraction; #include "continuityErrorPhiPU.H" if (modelType=="B" || modelType=="Bfull") diff --git a/applications/solvers/cfdemSolverPisoSTM/createFields.H b/applications/solvers/cfdemSolverPisoSTM/createFields.H index 5766995..09dbfe6 100644 --- a/applications/solvers/cfdemSolverPisoSTM/createFields.H +++ b/applications/solvers/cfdemSolverPisoSTM/createFields.H @@ -105,7 +105,7 @@ ), mesh//, //dimensionedScalar("0", dimensionSet(0, 0, -1, 1, 0), 273.15) - ); + );*/ Info<< "\nCreating fluid-particle heat flux field\n" << endl; volScalarField Tsource @@ -115,14 +115,14 @@ "Tsource", runTime.timeName(), mesh, - IOobject::MUST_READ, - IOobject::AUTO_WRITE + IOobject::NO_READ, + IOobject::NO_WRITE ), - mesh//, - //dimensionedScalar("0", dimensionSet(0, 0, -1, 1, 0), 0.0) + mesh, + dimensionedScalar("0", dimensionSet(0, 0, -1, 1, 0), 0.0) ); - IOdictionary transportProperties + /*IOdictionary transportProperties ( IOobject ( @@ -159,7 +159,19 @@ surfaceScalarField phi ); #endif - +Info<< "Generating interstitial face flux field phiByVoidfraction\n" << endl; +surfaceScalarField phiByVoidfraction +( + IOobject + ( + "phiByVoidfraction", + runTime.timeName(), + mesh, + IOobject::NO_READ, + IOobject::NO_WRITE + ), + linearInterpolate(U) & mesh.Sf() +); label pRefCell = 0; scalar pRefValue = 0.0; diff --git a/applications/solvers/cfdemSolverPisoScalar/cfdemSolverPisoScalar.C b/applications/solvers/cfdemSolverPisoScalar/cfdemSolverPisoScalar.C index 8e29a87..b1af991 100644 --- a/applications/solvers/cfdemSolverPisoScalar/cfdemSolverPisoScalar.C +++ b/applications/solvers/cfdemSolverPisoScalar/cfdemSolverPisoScalar.C @@ -100,13 +100,16 @@ int main(int argc, char *argv[]) if(hasEvolved) { - particleCloud.smoothingM().smoothen(particleCloud.forceM(0).impParticleForces()); + particleCloud.smoothingM().smoothenAbsolutField(particleCloud.forceM(0).impParticleForces()); } Info << "update Ksl.internalField()" << endl; Ksl = particleCloud.momCoupleM(0).impMomSource(); Ksl.correctBoundaryConditions(); + surfaceScalarField voidfractionf = fvc::interpolate(voidfraction); + phi = voidfractionf*phiByVoidfraction; + //Force Checks #include "forceCheckIm.H" @@ -176,23 +179,23 @@ int main(int argc, char *argv[]) U = rUA*UEqn.H(); #ifdef version23 - phi = ( fvc::interpolate(U*voidfraction) & mesh.Sf() ) - + rUAfvoidfraction*fvc::ddtCorr(U, phi); + phi = ( fvc::interpolate(U) & mesh.Sf() ) + + rUAfvoidfraction*fvc::ddtCorr(U, phiByVoidfraction); #else - phi = ( fvc::interpolate(U*voidfraction) & mesh.Sf() ) - + fvc::ddtPhiCorr(rUAvoidfraction, U, phi); + phi = ( fvc::interpolate(U) & mesh.Sf() ) + + fvc::ddtPhiCorr(rUAvoidfraction, U, phiByVoidfraction); #endif - surfaceScalarField phiS(fvc::interpolate(Us*voidfraction) & mesh.Sf()); - surfaceScalarField phiGes = phi + rUAf*(fvc::interpolate(Ksl/rho) * phiS); + surfaceScalarField phiS(fvc::interpolate(Us) & mesh.Sf()); + phi += rUAf*(fvc::interpolate(Ksl/rho) * phiS); if (modelType=="A") rUAvoidfraction = volScalarField("(voidfraction2|A(U))",rUA*voidfraction*voidfraction); // Update the fixedFluxPressure BCs to ensure flux consistency #ifndef versionExt32 + #ifndef version40 if (modelType=="A") { - surfaceScalarField voidfractionf(fvc::interpolate(voidfraction)); setSnGrad ( p.boundaryField(), @@ -213,6 +216,8 @@ int main(int argc, char *argv[]) ); } #endif + #endif + // Non-orthogonal pressure corrector loop #if defined(version30) @@ -224,7 +229,7 @@ int main(int argc, char *argv[]) // Pressure corrector fvScalarMatrix pEqn ( - fvm::laplacian(rUAvoidfraction, p) == fvc::div(phiGes) + particleCloud.ddtVoidfraction() + fvm::laplacian(rUAvoidfraction, p) == fvc::div(voidfractionf*phi) + particleCloud.ddtVoidfraction() ); pEqn.setReference(pRefCell, pRefValue); @@ -232,8 +237,7 @@ int main(int argc, char *argv[]) pEqn.solve(mesh.solver(p.select(piso.finalInnerIter()))); if (piso.finalNonOrthogonalIter()) { - phiGes -= pEqn.flux(); - phi = phiGes; + phiByVoidfraction = phi - pEqn.flux()/voidfractionf; } #else if( corr == nCorr-1 && nonOrth == nNonOrthCorr ) @@ -247,13 +251,13 @@ int main(int argc, char *argv[]) if (nonOrth == nNonOrthCorr) { - phiGes -= pEqn.flux(); - phi = phiGes; + phiByVoidfraction = phi - pEqn.flux()/voidfractionf; } #endif } // end non-orthogonal corrector loop + phi = voidfractionf*phiByVoidfraction; #include "continuityErrorPhiPU.H" if (modelType=="B" || modelType=="Bfull") diff --git a/applications/solvers/cfdemSolverPisoScalar/createFields.H b/applications/solvers/cfdemSolverPisoScalar/createFields.H index 2e442af..0a7d7c5 100644 --- a/applications/solvers/cfdemSolverPisoScalar/createFields.H +++ b/applications/solvers/cfdemSolverPisoScalar/createFields.H @@ -159,7 +159,19 @@ surfaceScalarField phi ); #endif - +Info<< "Generating interstitial face flux field phiByVoidfraction\n" << endl; +surfaceScalarField phiByVoidfraction +( + IOobject + ( + "phiByVoidfraction", + runTime.timeName(), + mesh, + IOobject::NO_READ, + IOobject::NO_WRITE + ), + linearInterpolate(U) & mesh.Sf() +); label pRefCell = 0; scalar pRefValue = 0.0; diff --git a/doc/CFDEMcoupling_Manual.html b/doc/CFDEMcoupling_Manual.html deleted file mode 100644 index ea2e8b0..0000000 --- a/doc/CFDEMcoupling_Manual.html +++ /dev/null @@ -1,245 +0,0 @@ - -
CFDEMproject WWW Site -
- - - - - - - - -
- -

CFDEMcoupling Documentation -

-
- -
-
-
- -

1. Contents -

-

The CFDEMcoupling 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 CFDEMcoupling documentation can be improved. -

-1.1 About CFDEMcoupling
-1.2 Installation
-1.3 Tutorials
-1.4 couplingProperties dictionary
-1.5 liggghtsCommands dictionary
-1.6 Models and solvers
- -
- -

1.1 About CFDEMcoupling -

-

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(R)(*). The CFDEMcoupling toolbox allows to expand standard CFD solvers of OpenFOAM(R)(*) 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. -

-

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

-
  • its modular approach allows users to easily implement new models - -
  • its MPI parallelization enables to use it for large scale problems - -
  • the forum on CFD-DEM gives the possibility to exchange with other users / developers - -
  • the use of GIT allows to easily update to the latest version - -
  • basic documentation is provided - - -
-

The file structure: -

-
  • src directory including the source files of the coupling toolbox and models - -
  • applications directory including the solver files for coupled CFD-DEM simulations - -
  • doc directory including the documentation of CFDEMcoupling - -
  • tutorials directory including basic tutorial cases showing the functionality - - -
-

Details on installation are given on the CFDEMproject WWW Site . -The functionality of this CFD-DEM framework is described via tutorial cases showing how to use different solvers and models. -

-

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

-

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

-

Core development of CFDEMcoupling is done by Christoph Goniva and Christoph Kloss, both at DCS Computing GmbH, 2012 -

-

This documentation was written by Christoph Goniva, DCS Computing GmbH, 2012 -

-
- -

(*) 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. -

-
- -

1.2 Installation -

-

Please follow the installation routine provided at www.cfdem.com. -In order to get the latest code version, please use the git repository at http://github.com (githubAccess). -

-
- -

1.3 Tutorials -

-

General: -

-

Each solver of the CFDEMcoupling 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). -

-

Location: -

-

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

-

Structure: -

-

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. -

-

Usage: -

-

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.). -

-

Settings: -

-

The main settings of a simulation are done via dictionaries: -

-

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. -

-

Standard CFD settings are defined in $caseDir/CFD/constant (e.g. transportProperties, RASproperties, etc.) and $caseDir/CFD/system (e.g. fvSchemes, controlDict). You can find more information on that in OpenFOAM(R)(*) documentations (www.openFoam.com)(*). -

-

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). -

-
- -

1.4 "couplingProperties" dictionary -

-

General: -

-

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

-

Location: $caseDir/CFD/constant -

-

Structure: -

-

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

-

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

-
  • modelType - -
  • couplingInterval - -
  • voidFractionModel - -
  • locateModel - -
  • meshMotionModel - -
  • regionModel - -
  • IOModel - -
  • dataExchangeModel - -
  • averagingModel - -
  • forceModels - -
  • momCoupleModels - -
  • turbulenceModelType - - -
-

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

-

Settings: -

-

Reasonable example settings for the "couplingProperties" dictionary are given in the tutorial cases. -

-
modelType 
-
-

"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. -

-
couplingInterval 
-
-

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

-

A useful procedure would be: -1) Set the DEM timestep in the in.xxx file according to the needs of the pure DEM problem. -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) 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!". -

-

Example: DEMts=0.00001s, couplingInterval=10 exchange data (=couple) will happen every 0.0001s. -

-
- -

1.5 "liggghtsCommands" dictionary -

-

General: -

-

In the "liggghtsCommands" dictionary liggghts commands being executed during a coupled CFD-DEM simulation are specified. -

-

Location: $caseDir/CFD/constant -

-

Structure: -

-

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

-

Settings: -

-

Reasonable example settings for the "liggghtsCommands" dictionary are given in the tutorial cases. -

-
- -

1.6 Models/Solvers -

-

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

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
IOModelIOModel_basicIO
IOModel_noIOIOModel_sophIO
IOModel_trackIOaveragingModel
averagingModel_denseaveragingModel_dilute
cfdemSolverIBcfdemSolverPiso
cfdemSolverPisoScalarclockModel
clockModel_noClockclockModel_standardClock
dataExchangeModeldataExchangeModel_noDataExchange
dataExchangeModel_oneWayVTKdataExchangeModel_twoWayFiles
dataExchangeModel_twoWayMPIforceModel
forceModel_ArchimedesforceModel_ArchimedesIB
forceModel_DiFeliceDragforceModel_GidaspowDrag
forceModel_KochHillDragforceModel_LaEuScalarTemp
forceModel_MeiLiftforceModel_SchillerNaumannDrag
forceModel_ShirgaonkarIBforceModel_fieldStore
forceModel_fieldTimeAverageforceModel_gradPForce
forceModel_noDragforceModel_particleCellVolume
forceModel_particleVolumeforceModel_scalarGeneralExchange
forceModel_virtualMassForceforceModel_viscForce
forceModel_volWeightedAverageforceSubModel
forceSubModel_ImExliggghtsCommandModel
liggghtsCommandModel_executeliggghtsCommandModel_readLiggghtsData
liggghtsCommandModel_runLiggghtsliggghtsCommandModel_writeLiggghts
locateModellocateModel_engineSearch
locateModel_engineSearchIBlocateModel_standardSearch
meshMotionModelmeshMotionModel_noMeshMotion
momCoupleModelmomCoupleModel_explicitCouple
momCoupleModel_implicitCouplemomCoupleModel_noCouple
probeModelprobeModel_noProbe
probeModel_particleProberegionModel
regionModel_allRegionscalarTransportModel
smoothingModelsmoothingModel_constDiffSmoothing
smoothingModel_noSmoothingvoidfractionModel
voidfractionModel_GaussVoidFractionvoidfractionModel_IBVoidFraction
voidfractionModel_bigParticleVoidFractionvoidfractionModel_centreVoidFraction
voidfractionModel_dividedVoidFractionvoidfractionModel_noVoidFractionVoidFraction
voidfractionModel_trilinearVoidFraction -
- - diff --git a/doc/CFDEMcoupling_Manual.html b/doc/CFDEMcoupling_Manual.html new file mode 120000 index 0000000..eb84c00 --- /dev/null +++ b/doc/CFDEMcoupling_Manual.html @@ -0,0 +1 @@ +_build/html/CFDEMcoupling_Manual.html \ No newline at end of file diff --git a/doc/CFDEMcoupling_Manual.pdf b/doc/CFDEMcoupling_Manual.pdf deleted file mode 100644 index 8a26cc4..0000000 Binary files a/doc/CFDEMcoupling_Manual.pdf and /dev/null differ diff --git a/doc/CFDEMcoupling_Manual.txt b/doc/CFDEMcoupling_Manual.txt new file mode 100644 index 0000000..22108c1 --- /dev/null +++ b/doc/CFDEMcoupling_Manual.txt @@ -0,0 +1,257 @@ +"CFDEMproject WWW Site"_lws :c + +:line +CFDEMcoupling Documentation :h2,c +:line +:c,image(Portfolio_CFDEMcoupling.png) +:line + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) +:link(of,http://www.openfoam.com) +:link(lig,http://www.cfdem.com) + +1. Contents :h3 + +The CFDEMcoupling 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 CFDEMcoupling documentation can be improved. + +1.1 "About CFDEMcoupling"_#1_1 +1.2 "Installation"_#1_2 +1.3 "Tutorials"_#1_3 +1.4 "couplingProperties dictionary"_#1_4 +1.5 "liggghtsCommands dictionary"_#1_5 +1.6 "Models and solvers"_#cmd_5 :all(b) + +:line + +1.1 About CFDEMcoupling :link(1_1),h4 + +CFDEM coupling provides an open source parallel coupled CFD-DEM framework combining the strengths of "LIGGGHTS"_lig DEM code and the Open Source CFD package "OpenFOAM(R)(*)"_of. The CFDEMcoupling toolbox allows to expand standard CFD solvers of "OpenFOAM(R)(*)"_of to include a coupling to the DEM code "LIGGGHTS"_lig. 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. + +The coupled solvers run fully parallel on distributed-memory clusters. Features are: + +its modular approach allows users to easily implement new models :ulb,l +its MPI parallelization enables to use it for large scale problems :l +the "forum"_lws on CFD-DEM gives the possibility to exchange with other users / developers :l +the use of GIT allows to easily update to the latest version :l +basic documentation is provided :l +:ule + +The file structure: + +{src} directory including the source files of the coupling toolbox and models :ulb,l +{applications} directory including the solver files for coupled CFD-DEM simulations :l +{doc} directory including the documentation of CFDEMcoupling :l +{tutorials} directory including basic tutorial cases showing the functionality :l +:ule + +Details on installation are given on the "CFDEMproject WWW Site"_lws . +The functionality of this CFD-DEM framework is described via "tutorial cases"_#_1_2 showing how to use different solvers and models. + +CFDEMcoupling stands for Computational Fluid Dynamics (CFD) -Discrete Element Method (DEM) coupling. + +CFDEMcoupling is an open-source code, distributed freely under the terms of the GNU Public License (GPL). + +Core development of CFDEMcoupling is done by Christoph Goniva and Christoph Kloss, both at DCS Computing GmbH, 2012 + +This documentation was written by Christoph Goniva, DCS Computing GmbH, 2012 + +:line +(*) 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. + +:line + +1.2 Installation :link(1_2),h4 + +Please follow the installation routine provided at www.cfdem.com. +In order to get the latest code version, please use the git repository at http://github.com ("githubAccess"_githubAccess_public.html). + +:line + +1.3 Tutorials :link(1_3),h4 + +[General:] + +Each solver of the CFDEMcoupling 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). + +[Location:] + +The tutorials can be found in the directory $CFDEM_PROJECT_DIR/tutorials, which can be reached by typing "cfdemTut" + +[Structure:] + +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. + +[Usage:] + +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.). + +[Settings:] + +The main settings of a simulation are done via dictionaries: + +The DEM setup of each case is defined by a "LIGGGHTS"_lig input file located in $caseDir/DEM (e.g. in.liggghts_init). For details on the "LIGGGHTS"_lig setup, please have a look at the "LIGGGHTS"_lig manual. + +Standard CFD settings are defined in $caseDir/CFD/constant (e.g. transportProperties, RASproperties, etc.) and $caseDir/CFD/system (e.g. fvSchemes, controlDict). You can find more information on that in "OpenFOAM(R)(*)"_of documentations (www.openFoam.com)(*). + +Settings of the coupling routines are defined in $caseDir/CFD/constant/"couplingProperies"_#1_3 (e.g. force models, data exchange model, etc.) and $caseDir/CFD/constant/"liggghtsCommands"_#1_3 (allows to execute a LIGGGHTS command during a coupled simulation). + +:line + +1.4 "couplingProperties" dictionary :link(1_4),h4 + +[General:] + +In the "couplingProperties" dictionary the setup of the coupling routines of the CFD-DEM simulation are defined. + +[Location:] $caseDir/CFD/constant + +[Structure:] + +The dictionary is divided into two parts, "sub-models & settings" and "sub-model properties". + +In "sub-models & settings" the following routines must be specified: + +modelType :ulb,l +couplingInterval :l +voidFractionModel :l +locateModel :l +meshMotionModel :l +regionModel :l +IOModel :l +dataExchangeModel :l +averagingModel :l +forceModels :l +momCoupleModels :l +turbulenceModelType :l +:ule + +In "sub-model properties" sub-dictionaries might be defined to specify model specific parameters. + +[Settings:] + +Reasonable example settings for the "couplingProperties" dictionary are given in the tutorial cases. + +modelType :pre + +"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. + +couplingInterval :pre + +The coupling interval determines the time passing between two CFD-DEM data exchanges. + +A useful procedure would be: +1) Set the DEM timestep in the in.xxx file according to the needs of the pure DEM problem. +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) 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!". + +Example: DEMts=0.00001s, couplingInterval=10 exchange data (=couple) will happen every 0.0001s. + +:line + +1.5 "liggghtsCommands" dictionary :h4,link(1_5) + +[General:] + +In the "liggghtsCommands" dictionary liggghts commands being executed during a coupled CFD-DEM simulation are specified. + +[Location:] $caseDir/CFD/constant + +[Structure:] + +The dictionary is divided into two parts, first a list of "liggghtsCommandModels" is defined, then the settings for each model must be specified. + +[Settings:] + +Reasonable example settings for the "liggghtsCommands" dictionary are given in the tutorial cases. + +:line + + + + + + + + +1.6 Models/Solvers :h4,link(cmd_5),link(comm) + +This section lists all CFDEMcoupling sub-models and solvers alphabetically, with a separate +listing below of styles within certain commands. + + +"IOModel"_IOModel.html, +"IOModel_basicIO"_IOModel_basicIO.html, +"IOModel_noIO"_IOModel_noIO.html, +"IOModel_sophIO"_IOModel_sophIO.html, +"IOModel_trackIO"_IOModel_trackIO.html, +"averagingModel"_averagingModel.html, +"averagingModel_dense"_averagingModel_dense.html, +"averagingModel_dilute"_averagingModel_dilute.html, +"cfdemSolverIB"_cfdemSolverIB.html, +"cfdemSolverPiso"_cfdemSolverPiso.html, +"cfdemSolverPisoScalar"_cfdemSolverPisoScalar.html, +"clockModel"_clockModel.html, +"clockModel_noClock"_clockModel_noClock.html, +"clockModel_standardClock"_clockModel_standardClock.html, +"dataExchangeModel"_dataExchangeModel.html, +"dataExchangeModel_noDataExchange"_dataExchangeModel_noDataExchange.html, +"dataExchangeModel_oneWayVTK"_dataExchangeModel_oneWayVTK.html, +"dataExchangeModel_twoWayFiles"_dataExchangeModel_twoWayFiles.html, +"dataExchangeModel_twoWayMPI"_dataExchangeModel_twoWayMPI.html, +"forceModel"_forceModel.html, +"forceModel_Archimedes"_forceModel_Archimedes.html, +"forceModel_ArchimedesIB"_forceModel_ArchimedesIB.html, +"forceModel_DiFeliceDrag"_forceModel_DiFeliceDrag.html, +"forceModel_GidaspowDrag"_forceModel_GidaspowDrag.html, +"forceModel_KochHillDrag"_forceModel_KochHillDrag.html, +"forceModel_LaEuScalarTemp"_forceModel_LaEuScalarTemp.html, +"forceModel_MeiLift"_forceModel_MeiLift.html, +"forceModel_SchillerNaumannDrag"_forceModel_SchillerNaumannDrag.html, +"forceModel_ShirgaonkarIB"_forceModel_ShirgaonkarIB.html, +"forceModel_checkCouplingInterval"_forceModel_checkCouplingInterval.html, +"forceModel_fieldStore"_forceModel_fieldStore.html, +"forceModel_fieldTimeAverage"_forceModel_fieldTimeAverage.html, +"forceModel_gradPForce"_forceModel_gradPForce.html, +"forceModel_noDrag"_forceModel_noDrag.html, +"forceModel_particleCellVolume"_forceModel_particleCellVolume.html, +"forceModel_particleVolume"_forceModel_particleVolume.html, +"forceModel_scalarGeneralExchange"_forceModel_scalarGeneralExchange.html, +"forceModel_virtualMassForce"_forceModel_virtualMassForce.html, +"forceModel_viscForce"_forceModel_viscForce.html, +"forceModel_volWeightedAverage"_forceModel_volWeightedAverage.html, +"forceSubModel"_forceSubModel.html, +"forceSubModel_ImEx"_forceSubModel_ImEx.html, +"liggghtsCommandModel"_liggghtsCommandModel.html, +"liggghtsCommandModel_execute"_liggghtsCommandModel_execute.html, +"liggghtsCommandModel_readLiggghtsData"_liggghtsCommandModel_readLiggghtsData.html, +"liggghtsCommandModel_runLiggghts"_liggghtsCommandModel_runLiggghts.html, +"liggghtsCommandModel_setDEMGravity"_liggghtsCommandModel_setDEMGravity.html, +"liggghtsCommandModel_writeLiggghts"_liggghtsCommandModel_writeLiggghts.html, +"locateModel"_locateModel.html, +"locateModel_engineSearch"_locateModel_engineSearch.html, +"locateModel_engineSearchIB"_locateModel_engineSearchIB.html, +"locateModel_standardSearch"_locateModel_standardSearch.html, +"meshMotionModel"_meshMotionModel.html, +"meshMotionModel_noMeshMotion"_meshMotionModel_noMeshMotion.html, +"momCoupleModel"_momCoupleModel.html, +"momCoupleModel_explicitCouple"_momCoupleModel_explicitCouple.html, +"momCoupleModel_implicitCouple"_momCoupleModel_implicitCouple.html, +"momCoupleModel_noCouple"_momCoupleModel_noCouple.html, +"probeModel"_probeModel.html, +"probeModel_noProbe"_probeModel_noProbe.html, +"probeModel_particleProbe"_probeModel_particleProbe.html, +"regionModel"_regionModel.html, +"regionModel_allRegion"_regionModel_allRegion.html, +"scalarTransportModel"_scalarTransportModel.html, +"smoothingModel"_smoothingModel.html, +"smoothingModel_constDiffSmoothing"_smoothingModel_constDiffSmoothing.html, +"smoothingModel_noSmoothing"_smoothingModel_noSmoothing.html, +"voidfractionModel"_voidFractionModel.html, +"voidfractionModel_GaussVoidFraction"_voidFractionModel_GaussVoidFraction.html, +"voidfractionModel_IBVoidFraction"_voidFractionModel_IBVoidFraction.html, +"voidfractionModel_bigParticleVoidFraction"_voidFractionModel_bigParticleVoidFraction.html, +"voidfractionModel_centreVoidFraction"_voidFractionModel_centreVoidFraction.html, +"voidfractionModel_dividedVoidFraction"_voidFractionModel_dividedVoidFraction.html, +"voidfractionModel_noVoidFractionVoidFraction"_voidFractionModel_noVoidFraction.html, +"voidfractionModel_trilinearVoidFraction"_voidFractionModel_trilinearVoidFraction.html :tb(c=2,ea=c) \ No newline at end of file diff --git a/doc/IOModel.html b/doc/IOModel.html deleted file mode 100644 index 516fa6e..0000000 --- a/doc/IOModel.html +++ /dev/null @@ -1,40 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

IOModel command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
IOModel "model"; 
-
-
  • model = name of IO-model to be applied -
-

Examples: -

-

IOModel "off"; -

-

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

-

Description: -

-

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

-

Restrictions: -

-

none. -

-

Related commands: -

-

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

-

Default: none. -

- diff --git a/doc/IOModel.txt b/doc/IOModel.txt new file mode 100644 index 0000000..77014da --- /dev/null +++ b/doc/IOModel.txt @@ -0,0 +1,36 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +IOModel command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +IOModel "model"; :pre + +model = name of IO-model to be applied :ul + +[Examples:] + +IOModel "off"; + +Note: This examples list might not be complete - please look for other models (IOModel_XY) in this documentation. + +[Description:] + +The IO-model is the base class to write data (e.g. particle properties) to files. + +[Restrictions:] + +none. + +[Related commands:] + +Note: This examples list may be incomplete - please look for other models (IOModel_XY) in this documentation. + +[Default:] none. diff --git a/doc/IOModel_basicIO.html b/doc/IOModel_basicIO.html deleted file mode 100644 index 8152c9e..0000000 --- a/doc/IOModel_basicIO.html +++ /dev/null @@ -1,32 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

IOModel_basicIO command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
IOModel "basicIO"; 
-
-

Examples: -

-
IOModel "basicIO"; 
-
-

Description: -

-

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. -

-

Restrictions: None. -

-

Related commands: -

-

IOModel -

- diff --git a/doc/IOModel_basicIO.txt b/doc/IOModel_basicIO.txt new file mode 100644 index 0000000..98daa37 --- /dev/null +++ b/doc/IOModel_basicIO.txt @@ -0,0 +1,29 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +IOModel_basicIO command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +IOModel "basicIO"; :pre + +[Examples:] + +IOModel "basicIO"; :pre + +[Description:] + +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. + +[Restrictions:] None. + +[Related commands:] + +"IOModel"_IOModel.html + diff --git a/doc/IOModel_noIO.html b/doc/IOModel_noIO.html deleted file mode 100644 index 0fb2343..0000000 --- a/doc/IOModel_noIO.html +++ /dev/null @@ -1,32 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

IOModel_noIO command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
IOModel "off"; 
-
-

Examples: -

-
IOModel "off"; 
-
-

Description: -

-

The noIO-model is a dummy IO model. -

-

Restrictions: None. -

-

Related commands: -

-

IOModel -

- diff --git a/doc/IOModel_noIO.txt b/doc/IOModel_noIO.txt new file mode 100644 index 0000000..d90d77c --- /dev/null +++ b/doc/IOModel_noIO.txt @@ -0,0 +1,29 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +IOModel_noIO command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +IOModel "off"; :pre + +[Examples:] + +IOModel "off"; :pre + +[Description:] + +The noIO-model is a dummy IO model. + +[Restrictions:] None. + +[Related commands:] + +"IOModel"_IOModel.html + diff --git a/doc/IOModel_sophIO.html b/doc/IOModel_sophIO.html deleted file mode 100644 index 2bbf56c..0000000 --- a/doc/IOModel_sophIO.html +++ /dev/null @@ -1,32 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

IOModel_sophIO command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
IOModel "sophIO"; 
-
-

Examples: -

-
IOModel "sophIO"; 
-
-

Description: -

-

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. -

-

Restrictions: None. -

-

Related commands: -

-

IOModel -

- diff --git a/doc/IOModel_sophIO.txt b/doc/IOModel_sophIO.txt new file mode 100644 index 0000000..09dcd3e --- /dev/null +++ b/doc/IOModel_sophIO.txt @@ -0,0 +1,29 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +IOModel_sophIO command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +IOModel "sophIO"; :pre + +[Examples:] + +IOModel "sophIO"; :pre + +[Description:] + +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. + +[Restrictions:] None. + +[Related commands:] + +"IOModel"_IOModel.html + diff --git a/doc/IOModel_trackIO.html b/doc/IOModel_trackIO.html deleted file mode 100644 index 28d1e86..0000000 --- a/doc/IOModel_trackIO.html +++ /dev/null @@ -1,32 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

IOModel_trackIO command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
IOModel "trackIO"; 
-
-

Examples: -

-
IOModel "trackIO"; 
-
-

Description: -

-

The trackIO-model is based on sophIO model and additionally writes fields necessary to use the particleTracks utility (which needs a particleTrackProperties file in the constant dir). The particleTracks utility generates tracks of the particles and writes them to a vtk file. -

-

Restrictions: None. -

-

Related commands: -

-

IOModel -

- diff --git a/doc/IOModel_trackIO.txt b/doc/IOModel_trackIO.txt new file mode 100644 index 0000000..dff7906 --- /dev/null +++ b/doc/IOModel_trackIO.txt @@ -0,0 +1,29 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +IOModel_trackIO command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +IOModel "trackIO"; :pre + +[Examples:] + +IOModel "trackIO"; :pre + +[Description:] + +The trackIO-model is based on sophIO model and additionally writes fields necessary to use the particleTracks utility (which needs a particleTrackProperties file in the constant dir). The particleTracks utility generates tracks of the particles and writes them to a vtk file. + +[Restrictions:] None. + +[Related commands:] + +"IOModel"_IOModel.html + diff --git a/doc/_build/doctrees/CFDEMcoupling_Manual.doctree b/doc/_build/doctrees/CFDEMcoupling_Manual.doctree new file mode 100644 index 0000000..8c5a4a4 Binary files /dev/null and b/doc/_build/doctrees/CFDEMcoupling_Manual.doctree differ diff --git a/doc/_build/doctrees/IOModel.doctree b/doc/_build/doctrees/IOModel.doctree new file mode 100644 index 0000000..024f6b5 Binary files /dev/null and b/doc/_build/doctrees/IOModel.doctree differ diff --git a/doc/_build/doctrees/IOModel_basicIO.doctree b/doc/_build/doctrees/IOModel_basicIO.doctree new file mode 100644 index 0000000..ac7e404 Binary files /dev/null and b/doc/_build/doctrees/IOModel_basicIO.doctree differ diff --git a/doc/_build/doctrees/IOModel_noIO.doctree b/doc/_build/doctrees/IOModel_noIO.doctree new file mode 100644 index 0000000..d6109cd Binary files /dev/null and b/doc/_build/doctrees/IOModel_noIO.doctree differ diff --git a/doc/_build/doctrees/IOModel_sophIO.doctree b/doc/_build/doctrees/IOModel_sophIO.doctree new file mode 100644 index 0000000..5a6cedf Binary files /dev/null and b/doc/_build/doctrees/IOModel_sophIO.doctree differ diff --git a/doc/_build/doctrees/IOModel_trackIO.doctree b/doc/_build/doctrees/IOModel_trackIO.doctree new file mode 100644 index 0000000..89c9c27 Binary files /dev/null and b/doc/_build/doctrees/IOModel_trackIO.doctree differ diff --git a/doc/_build/doctrees/averagingModel.doctree b/doc/_build/doctrees/averagingModel.doctree new file mode 100644 index 0000000..f666bf2 Binary files /dev/null and b/doc/_build/doctrees/averagingModel.doctree differ diff --git a/doc/_build/doctrees/averagingModel_dense.doctree b/doc/_build/doctrees/averagingModel_dense.doctree new file mode 100644 index 0000000..d5a2769 Binary files /dev/null and b/doc/_build/doctrees/averagingModel_dense.doctree differ diff --git a/doc/_build/doctrees/averagingModel_dilute.doctree b/doc/_build/doctrees/averagingModel_dilute.doctree new file mode 100644 index 0000000..c38143c Binary files /dev/null and b/doc/_build/doctrees/averagingModel_dilute.doctree differ diff --git a/doc/_build/doctrees/cfdemSolverIB.doctree b/doc/_build/doctrees/cfdemSolverIB.doctree new file mode 100644 index 0000000..bf3c79b Binary files /dev/null and b/doc/_build/doctrees/cfdemSolverIB.doctree differ diff --git a/doc/_build/doctrees/cfdemSolverPiso.doctree b/doc/_build/doctrees/cfdemSolverPiso.doctree new file mode 100644 index 0000000..07ac119 Binary files /dev/null and b/doc/_build/doctrees/cfdemSolverPiso.doctree differ diff --git a/doc/_build/doctrees/cfdemSolverPisoScalar.doctree b/doc/_build/doctrees/cfdemSolverPisoScalar.doctree new file mode 100644 index 0000000..242a881 Binary files /dev/null and b/doc/_build/doctrees/cfdemSolverPisoScalar.doctree differ diff --git a/doc/_build/doctrees/clockModel.doctree b/doc/_build/doctrees/clockModel.doctree new file mode 100644 index 0000000..637235a Binary files /dev/null and b/doc/_build/doctrees/clockModel.doctree differ diff --git a/doc/_build/doctrees/clockModel_noClock.doctree b/doc/_build/doctrees/clockModel_noClock.doctree new file mode 100644 index 0000000..bf88018 Binary files /dev/null and b/doc/_build/doctrees/clockModel_noClock.doctree differ diff --git a/doc/_build/doctrees/clockModel_standardClock.doctree b/doc/_build/doctrees/clockModel_standardClock.doctree new file mode 100644 index 0000000..08041e1 Binary files /dev/null and b/doc/_build/doctrees/clockModel_standardClock.doctree differ diff --git a/doc/_build/doctrees/dataExchangeModel.doctree b/doc/_build/doctrees/dataExchangeModel.doctree new file mode 100644 index 0000000..ac76134 Binary files /dev/null and b/doc/_build/doctrees/dataExchangeModel.doctree differ diff --git a/doc/_build/doctrees/dataExchangeModel_noDataExchange.doctree b/doc/_build/doctrees/dataExchangeModel_noDataExchange.doctree new file mode 100644 index 0000000..f42abf4 Binary files /dev/null and b/doc/_build/doctrees/dataExchangeModel_noDataExchange.doctree differ diff --git a/doc/_build/doctrees/dataExchangeModel_oneWayVTK.doctree b/doc/_build/doctrees/dataExchangeModel_oneWayVTK.doctree new file mode 100644 index 0000000..eb519ca Binary files /dev/null and b/doc/_build/doctrees/dataExchangeModel_oneWayVTK.doctree differ diff --git a/doc/_build/doctrees/dataExchangeModel_twoWayFiles.doctree b/doc/_build/doctrees/dataExchangeModel_twoWayFiles.doctree new file mode 100644 index 0000000..053f0fd Binary files /dev/null and b/doc/_build/doctrees/dataExchangeModel_twoWayFiles.doctree differ diff --git a/doc/_build/doctrees/dataExchangeModel_twoWayMPI.doctree b/doc/_build/doctrees/dataExchangeModel_twoWayMPI.doctree new file mode 100644 index 0000000..281e5c6 Binary files /dev/null and b/doc/_build/doctrees/dataExchangeModel_twoWayMPI.doctree differ diff --git a/doc/_build/doctrees/environment.pickle b/doc/_build/doctrees/environment.pickle new file mode 100644 index 0000000..b3f6408 Binary files /dev/null and b/doc/_build/doctrees/environment.pickle differ diff --git a/doc/_build/doctrees/forceModel.doctree b/doc/_build/doctrees/forceModel.doctree new file mode 100644 index 0000000..5e95700 Binary files /dev/null and b/doc/_build/doctrees/forceModel.doctree differ diff --git a/doc/_build/doctrees/forceModel_Archimedes.doctree b/doc/_build/doctrees/forceModel_Archimedes.doctree new file mode 100644 index 0000000..af9401a Binary files /dev/null and b/doc/_build/doctrees/forceModel_Archimedes.doctree differ diff --git a/doc/_build/doctrees/forceModel_ArchimedesIB.doctree b/doc/_build/doctrees/forceModel_ArchimedesIB.doctree new file mode 100644 index 0000000..e650bf6 Binary files /dev/null and b/doc/_build/doctrees/forceModel_ArchimedesIB.doctree differ diff --git a/doc/_build/doctrees/forceModel_DiFeliceDrag.doctree b/doc/_build/doctrees/forceModel_DiFeliceDrag.doctree new file mode 100644 index 0000000..96e76ec Binary files /dev/null and b/doc/_build/doctrees/forceModel_DiFeliceDrag.doctree differ diff --git a/doc/_build/doctrees/forceModel_GidaspowDrag.doctree b/doc/_build/doctrees/forceModel_GidaspowDrag.doctree new file mode 100644 index 0000000..0728f7e Binary files /dev/null and b/doc/_build/doctrees/forceModel_GidaspowDrag.doctree differ diff --git a/doc/_build/doctrees/forceModel_KochHillDrag.doctree b/doc/_build/doctrees/forceModel_KochHillDrag.doctree new file mode 100644 index 0000000..906177c Binary files /dev/null and b/doc/_build/doctrees/forceModel_KochHillDrag.doctree differ diff --git a/doc/_build/doctrees/forceModel_LaEuScalarTemp.doctree b/doc/_build/doctrees/forceModel_LaEuScalarTemp.doctree new file mode 100644 index 0000000..291a9c1 Binary files /dev/null and b/doc/_build/doctrees/forceModel_LaEuScalarTemp.doctree differ diff --git a/doc/_build/doctrees/forceModel_MeiLift.doctree b/doc/_build/doctrees/forceModel_MeiLift.doctree new file mode 100644 index 0000000..0f687a4 Binary files /dev/null and b/doc/_build/doctrees/forceModel_MeiLift.doctree differ diff --git a/doc/_build/doctrees/forceModel_SchillerNaumannDrag.doctree b/doc/_build/doctrees/forceModel_SchillerNaumannDrag.doctree new file mode 100644 index 0000000..8d8d7db Binary files /dev/null and b/doc/_build/doctrees/forceModel_SchillerNaumannDrag.doctree differ diff --git a/doc/_build/doctrees/forceModel_ShirgaonkarIB.doctree b/doc/_build/doctrees/forceModel_ShirgaonkarIB.doctree new file mode 100644 index 0000000..0cc2eb2 Binary files /dev/null and b/doc/_build/doctrees/forceModel_ShirgaonkarIB.doctree differ diff --git a/doc/_build/doctrees/forceModel_checkCouplingInterval.doctree b/doc/_build/doctrees/forceModel_checkCouplingInterval.doctree new file mode 100644 index 0000000..e4ffeb9 Binary files /dev/null and b/doc/_build/doctrees/forceModel_checkCouplingInterval.doctree differ diff --git a/doc/_build/doctrees/forceModel_fieldStore.doctree b/doc/_build/doctrees/forceModel_fieldStore.doctree new file mode 100644 index 0000000..9bd6bcb Binary files /dev/null and b/doc/_build/doctrees/forceModel_fieldStore.doctree differ diff --git a/doc/_build/doctrees/forceModel_fieldTimeAverage.doctree b/doc/_build/doctrees/forceModel_fieldTimeAverage.doctree new file mode 100644 index 0000000..7bae69c Binary files /dev/null and b/doc/_build/doctrees/forceModel_fieldTimeAverage.doctree differ diff --git a/doc/_build/doctrees/forceModel_gradPForce.doctree b/doc/_build/doctrees/forceModel_gradPForce.doctree new file mode 100644 index 0000000..531e6fc Binary files /dev/null and b/doc/_build/doctrees/forceModel_gradPForce.doctree differ diff --git a/doc/_build/doctrees/forceModel_noDrag.doctree b/doc/_build/doctrees/forceModel_noDrag.doctree new file mode 100644 index 0000000..8d893aa Binary files /dev/null and b/doc/_build/doctrees/forceModel_noDrag.doctree differ diff --git a/doc/_build/doctrees/forceModel_particleCellVolume.doctree b/doc/_build/doctrees/forceModel_particleCellVolume.doctree new file mode 100644 index 0000000..4b7e8b5 Binary files /dev/null and b/doc/_build/doctrees/forceModel_particleCellVolume.doctree differ diff --git a/doc/_build/doctrees/forceModel_particleVolume.doctree b/doc/_build/doctrees/forceModel_particleVolume.doctree new file mode 100644 index 0000000..b72ba76 Binary files /dev/null and b/doc/_build/doctrees/forceModel_particleVolume.doctree differ diff --git a/doc/_build/doctrees/forceModel_scalarGeneralExchange.doctree b/doc/_build/doctrees/forceModel_scalarGeneralExchange.doctree new file mode 100644 index 0000000..e00bb94 Binary files /dev/null and b/doc/_build/doctrees/forceModel_scalarGeneralExchange.doctree differ diff --git a/doc/_build/doctrees/forceModel_virtualMassForce.doctree b/doc/_build/doctrees/forceModel_virtualMassForce.doctree new file mode 100644 index 0000000..04e874a Binary files /dev/null and b/doc/_build/doctrees/forceModel_virtualMassForce.doctree differ diff --git a/doc/_build/doctrees/forceModel_viscForce.doctree b/doc/_build/doctrees/forceModel_viscForce.doctree new file mode 100644 index 0000000..5e7bedd Binary files /dev/null and b/doc/_build/doctrees/forceModel_viscForce.doctree differ diff --git a/doc/_build/doctrees/forceModel_volWeightedAverage.doctree b/doc/_build/doctrees/forceModel_volWeightedAverage.doctree new file mode 100644 index 0000000..4e1f91f Binary files /dev/null and b/doc/_build/doctrees/forceModel_volWeightedAverage.doctree differ diff --git a/doc/_build/doctrees/forceSubModel.doctree b/doc/_build/doctrees/forceSubModel.doctree new file mode 100644 index 0000000..5f887e3 Binary files /dev/null and b/doc/_build/doctrees/forceSubModel.doctree differ diff --git a/doc/_build/doctrees/forceSubModel_ImEx.doctree b/doc/_build/doctrees/forceSubModel_ImEx.doctree new file mode 100644 index 0000000..c6c1f3f Binary files /dev/null and b/doc/_build/doctrees/forceSubModel_ImEx.doctree differ diff --git a/doc/_build/doctrees/githubAccess_public.doctree b/doc/_build/doctrees/githubAccess_public.doctree new file mode 100644 index 0000000..ae79e77 Binary files /dev/null and b/doc/_build/doctrees/githubAccess_public.doctree differ diff --git a/doc/_build/doctrees/liggghtsCommandModel.doctree b/doc/_build/doctrees/liggghtsCommandModel.doctree new file mode 100644 index 0000000..8a321e2 Binary files /dev/null and b/doc/_build/doctrees/liggghtsCommandModel.doctree differ diff --git a/doc/_build/doctrees/liggghtsCommandModel_execute.doctree b/doc/_build/doctrees/liggghtsCommandModel_execute.doctree new file mode 100644 index 0000000..7f3a23a Binary files /dev/null and b/doc/_build/doctrees/liggghtsCommandModel_execute.doctree differ diff --git a/doc/_build/doctrees/liggghtsCommandModel_readLiggghtsData.doctree b/doc/_build/doctrees/liggghtsCommandModel_readLiggghtsData.doctree new file mode 100644 index 0000000..72fafff Binary files /dev/null and b/doc/_build/doctrees/liggghtsCommandModel_readLiggghtsData.doctree differ diff --git a/doc/_build/doctrees/liggghtsCommandModel_runLiggghts.doctree b/doc/_build/doctrees/liggghtsCommandModel_runLiggghts.doctree new file mode 100644 index 0000000..e353c87 Binary files /dev/null and b/doc/_build/doctrees/liggghtsCommandModel_runLiggghts.doctree differ diff --git a/doc/_build/doctrees/liggghtsCommandModel_setDEMGravity.doctree b/doc/_build/doctrees/liggghtsCommandModel_setDEMGravity.doctree new file mode 100644 index 0000000..5123ae7 Binary files /dev/null and b/doc/_build/doctrees/liggghtsCommandModel_setDEMGravity.doctree differ diff --git a/doc/_build/doctrees/liggghtsCommandModel_writeLiggghts.doctree b/doc/_build/doctrees/liggghtsCommandModel_writeLiggghts.doctree new file mode 100644 index 0000000..95d50e8 Binary files /dev/null and b/doc/_build/doctrees/liggghtsCommandModel_writeLiggghts.doctree differ diff --git a/doc/_build/doctrees/locateModel.doctree b/doc/_build/doctrees/locateModel.doctree new file mode 100644 index 0000000..2cbf730 Binary files /dev/null and b/doc/_build/doctrees/locateModel.doctree differ diff --git a/doc/_build/doctrees/locateModel_engineSearch.doctree b/doc/_build/doctrees/locateModel_engineSearch.doctree new file mode 100644 index 0000000..c8b2439 Binary files /dev/null and b/doc/_build/doctrees/locateModel_engineSearch.doctree differ diff --git a/doc/_build/doctrees/locateModel_engineSearchIB.doctree b/doc/_build/doctrees/locateModel_engineSearchIB.doctree new file mode 100644 index 0000000..cb1486d Binary files /dev/null and b/doc/_build/doctrees/locateModel_engineSearchIB.doctree differ diff --git a/doc/_build/doctrees/locateModel_standardSearch.doctree b/doc/_build/doctrees/locateModel_standardSearch.doctree new file mode 100644 index 0000000..caa51c2 Binary files /dev/null and b/doc/_build/doctrees/locateModel_standardSearch.doctree differ diff --git a/doc/_build/doctrees/meshMotionModel.doctree b/doc/_build/doctrees/meshMotionModel.doctree new file mode 100644 index 0000000..c50b212 Binary files /dev/null and b/doc/_build/doctrees/meshMotionModel.doctree differ diff --git a/doc/_build/doctrees/meshMotionModel_noMeshMotion.doctree b/doc/_build/doctrees/meshMotionModel_noMeshMotion.doctree new file mode 100644 index 0000000..9edd982 Binary files /dev/null and b/doc/_build/doctrees/meshMotionModel_noMeshMotion.doctree differ diff --git a/doc/_build/doctrees/momCoupleModel.doctree b/doc/_build/doctrees/momCoupleModel.doctree new file mode 100644 index 0000000..a793dac Binary files /dev/null and b/doc/_build/doctrees/momCoupleModel.doctree differ diff --git a/doc/_build/doctrees/momCoupleModel_explicitCouple.doctree b/doc/_build/doctrees/momCoupleModel_explicitCouple.doctree new file mode 100644 index 0000000..f5cc6c5 Binary files /dev/null and b/doc/_build/doctrees/momCoupleModel_explicitCouple.doctree differ diff --git a/doc/_build/doctrees/momCoupleModel_implicitCouple.doctree b/doc/_build/doctrees/momCoupleModel_implicitCouple.doctree new file mode 100644 index 0000000..3d3c140 Binary files /dev/null and b/doc/_build/doctrees/momCoupleModel_implicitCouple.doctree differ diff --git a/doc/_build/doctrees/momCoupleModel_noCouple.doctree b/doc/_build/doctrees/momCoupleModel_noCouple.doctree new file mode 100644 index 0000000..5a83391 Binary files /dev/null and b/doc/_build/doctrees/momCoupleModel_noCouple.doctree differ diff --git a/doc/_build/doctrees/probeModel.doctree b/doc/_build/doctrees/probeModel.doctree new file mode 100644 index 0000000..10a622c Binary files /dev/null and b/doc/_build/doctrees/probeModel.doctree differ diff --git a/doc/_build/doctrees/probeModel_noProbe.doctree b/doc/_build/doctrees/probeModel_noProbe.doctree new file mode 100644 index 0000000..7e1c2ee Binary files /dev/null and b/doc/_build/doctrees/probeModel_noProbe.doctree differ diff --git a/doc/_build/doctrees/probeModel_particleProbe.doctree b/doc/_build/doctrees/probeModel_particleProbe.doctree new file mode 100644 index 0000000..4d9c03f Binary files /dev/null and b/doc/_build/doctrees/probeModel_particleProbe.doctree differ diff --git a/doc/_build/doctrees/regionModel.doctree b/doc/_build/doctrees/regionModel.doctree new file mode 100644 index 0000000..f856d40 Binary files /dev/null and b/doc/_build/doctrees/regionModel.doctree differ diff --git a/doc/_build/doctrees/regionModel_allRegion.doctree b/doc/_build/doctrees/regionModel_allRegion.doctree new file mode 100644 index 0000000..3e8f9fe Binary files /dev/null and b/doc/_build/doctrees/regionModel_allRegion.doctree differ diff --git a/doc/_build/doctrees/scalarTransportModel.doctree b/doc/_build/doctrees/scalarTransportModel.doctree new file mode 100644 index 0000000..80e6a14 Binary files /dev/null and b/doc/_build/doctrees/scalarTransportModel.doctree differ diff --git a/doc/_build/doctrees/smoothingModel.doctree b/doc/_build/doctrees/smoothingModel.doctree new file mode 100644 index 0000000..abc9426 Binary files /dev/null and b/doc/_build/doctrees/smoothingModel.doctree differ diff --git a/doc/_build/doctrees/smoothingModel_constDiffSmoothing.doctree b/doc/_build/doctrees/smoothingModel_constDiffSmoothing.doctree new file mode 100644 index 0000000..34d50ed Binary files /dev/null and b/doc/_build/doctrees/smoothingModel_constDiffSmoothing.doctree differ diff --git a/doc/_build/doctrees/smoothingModel_noSmoothing.doctree b/doc/_build/doctrees/smoothingModel_noSmoothing.doctree new file mode 100644 index 0000000..d450342 Binary files /dev/null and b/doc/_build/doctrees/smoothingModel_noSmoothing.doctree differ diff --git a/doc/_build/doctrees/voidFractionModel.doctree b/doc/_build/doctrees/voidFractionModel.doctree new file mode 100644 index 0000000..12aac55 Binary files /dev/null and b/doc/_build/doctrees/voidFractionModel.doctree differ diff --git a/doc/_build/doctrees/voidFractionModel_GaussVoidFraction.doctree b/doc/_build/doctrees/voidFractionModel_GaussVoidFraction.doctree new file mode 100644 index 0000000..e4c9063 Binary files /dev/null and b/doc/_build/doctrees/voidFractionModel_GaussVoidFraction.doctree differ diff --git a/doc/_build/doctrees/voidFractionModel_IBVoidFraction.doctree b/doc/_build/doctrees/voidFractionModel_IBVoidFraction.doctree new file mode 100644 index 0000000..7c4fd03 Binary files /dev/null and b/doc/_build/doctrees/voidFractionModel_IBVoidFraction.doctree differ diff --git a/doc/_build/doctrees/voidFractionModel_bigParticleVoidFraction.doctree b/doc/_build/doctrees/voidFractionModel_bigParticleVoidFraction.doctree new file mode 100644 index 0000000..55d297b Binary files /dev/null and b/doc/_build/doctrees/voidFractionModel_bigParticleVoidFraction.doctree differ diff --git a/doc/_build/doctrees/voidFractionModel_centreVoidFraction.doctree b/doc/_build/doctrees/voidFractionModel_centreVoidFraction.doctree new file mode 100644 index 0000000..6bfcbe4 Binary files /dev/null and b/doc/_build/doctrees/voidFractionModel_centreVoidFraction.doctree differ diff --git a/doc/_build/doctrees/voidFractionModel_dividedVoidFraction.doctree b/doc/_build/doctrees/voidFractionModel_dividedVoidFraction.doctree new file mode 100644 index 0000000..ca4e7b1 Binary files /dev/null and b/doc/_build/doctrees/voidFractionModel_dividedVoidFraction.doctree differ diff --git a/doc/_build/doctrees/voidFractionModel_noVoidFraction.doctree b/doc/_build/doctrees/voidFractionModel_noVoidFraction.doctree new file mode 100644 index 0000000..9ba1ada Binary files /dev/null and b/doc/_build/doctrees/voidFractionModel_noVoidFraction.doctree differ diff --git a/doc/_build/doctrees/voidFractionModel_trilinearVoidFraction.doctree b/doc/_build/doctrees/voidFractionModel_trilinearVoidFraction.doctree new file mode 100644 index 0000000..6b0d63f Binary files /dev/null and b/doc/_build/doctrees/voidFractionModel_trilinearVoidFraction.doctree differ diff --git a/doc/_build/html/.buildinfo b/doc/_build/html/.buildinfo new file mode 100644 index 0000000..7144bb4 --- /dev/null +++ b/doc/_build/html/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 3caf5141115bcddaf056fb58ef355acd +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/doc/_build/html/CFDEMcoupling_Manual.html b/doc/_build/html/CFDEMcoupling_Manual.html new file mode 100644 index 0000000..eeafe69 --- /dev/null +++ b/doc/_build/html/CFDEMcoupling_Manual.html @@ -0,0 +1,451 @@ + + + + + + + + + + + CFDEMcoupling Documentation — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • CFDEMcoupling Documentation
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

CFDEMcoupling Documentation

+
+_images/Portfolio_CFDEMcoupling.png +
+
+

Contents

+

The CFDEMcoupling 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 CFDEMcoupling documentation can be improved.

+
+
1.1 About CFDEMcoupling
+
1.2 Installation
+
1.3 Tutorials
+
1.4 couplingProperties dictionary
+
1.5 liggghtsCommands dictionary
+
1.6 Models and solvers
+

+
+
+
+

About CFDEMcoupling

+

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(R)(*). The CFDEMcoupling toolbox allows to expand standard CFD solvers of OpenFOAM(R)(*) 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.

+

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

+
    +
  • its modular approach allows users to easily implement new models
    • +
  • its MPI parallelization enables to use it for large scale problems
    • +
  • the forum on CFD-DEM gives the possibility to exchange with other users / developers
    • +
  • the use of GIT allows to easily update to the latest version
    • +
  • basic documentation is provided
    • +
+

The file structure:

+
    +
  • src directory including the source files of the coupling toolbox and models
    • +
  • applications directory including the solver files for coupled CFD-DEM simulations
    • +
  • doc directory including the documentation of CFDEMcoupling
    • +
  • tutorials directory including basic tutorial cases showing the functionality
    • +
+

Details on installation are given on the CFDEMproject WWW Site . +The functionality of this CFD-DEM framework is described via tutorial cases showing how to use different solvers and models.

+

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

+

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

+

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

+

This documentation was written by Christoph Goniva, DCS Computing GmbH, 2012

+
+

(*) 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.

+
+
+
+

Installation

+

Please follow the installation routine provided at www.cfdem.com. +In order to get the latest code version, please use the git repository at http://github.com (githubAccess).

+
+
+
+

Tutorials

+

General:

+

Each solver of the CFDEMcoupling 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).

+

Location:

+

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

+

Structure:

+

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.

+

Usage:

+

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.).

+

Settings:

+

The main settings of a simulation are done via dictionaries:

+

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.

+

Standard CFD settings are defined in $caseDir/CFD/constant (e.g. transportProperties, RASproperties, etc.) and $caseDir/CFD/system (e.g. fvSchemes, controlDict). You can find more information on that in OpenFOAM(R)(*) documentations (www.openFoam.com)(*).

+

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).

+
+
+
+

“couplingProperties” dictionary

+

General:

+

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

+

Location: $caseDir/CFD/constant

+

Structure:

+

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

+

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

+
    +
  • modelType
    • +
  • couplingInterval
    • +
  • voidFractionModel
    • +
  • locateModel
    • +
  • meshMotionModel
    • +
  • regionModel
    • +
  • IOModel
    • +
  • dataExchangeModel
    • +
  • averagingModel
    • +
  • forceModels
    • +
  • momCoupleModels
    • +
  • turbulenceModelType
    • +
+

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

+

Settings:

+

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

+
modelType
+
+
+

“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.

+
couplingInterval
+
+
+

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

+

A useful procedure would be: +1) Set the DEM timestep in the in.xxx file according to the needs of the pure DEM problem. +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) 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!”.

+

Example: DEMts=0.00001s, couplingInterval=10 exchange data (=couple) will happen every 0.0001s.

+
+
+
+

“liggghtsCommands” dictionary

+

General:

+

In the “liggghtsCommands” dictionary liggghts commands being executed during a coupled CFD-DEM simulation are specified.

+

Location: $caseDir/CFD/constant

+

Structure:

+

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

+

Settings:

+

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

+
+
+
+

Models/Solvers

+

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

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IOModelIOModel_basicIO
IOModel_noIOIOModel_sophIO
IOModel_trackIOaveragingModel
averagingModel_denseaveragingModel_dilute
cfdemSolverIBcfdemSolverPiso
cfdemSolverPisoScalarclockModel
clockModel_noClockclockModel_standardClock
dataExchangeModeldataExchangeModel_noDataExchange
dataExchangeModel_oneWayVTKdataExchangeModel_twoWayFiles
dataExchangeModel_twoWayMPIforceModel
forceModel_ArchimedesforceModel_ArchimedesIB
forceModel_DiFeliceDragforceModel_GidaspowDrag
forceModel_KochHillDragforceModel_LaEuScalarTemp
forceModel_MeiLiftforceModel_SchillerNaumannDrag
forceModel_ShirgaonkarIBforceModel_checkCouplingInterval
forceModel_fieldStoreforceModel_fieldTimeAverage
forceModel_gradPForceforceModel_noDrag
forceModel_particleCellVolumeforceModel_particleVolume
forceModel_scalarGeneralExchangeforceModel_virtualMassForce
forceModel_viscForceforceModel_volWeightedAverage
forceSubModelforceSubModel_ImEx
liggghtsCommandModelliggghtsCommandModel_execute
liggghtsCommandModel_readLiggghtsDataliggghtsCommandModel_runLiggghts
liggghtsCommandModel_setDEMGravityliggghtsCommandModel_writeLiggghts
locateModellocateModel_engineSearch
locateModel_engineSearchIBlocateModel_standardSearch
meshMotionModelmeshMotionModel_noMeshMotion
momCoupleModelmomCoupleModel_explicitCouple
momCoupleModel_implicitCouplemomCoupleModel_noCouple
probeModelprobeModel_noProbe
probeModel_particleProberegionModel
regionModel_allRegionscalarTransportModel
smoothingModelsmoothingModel_constDiffSmoothing
smoothingModel_noSmoothingvoidfractionModel
voidfractionModel_GaussVoidFractionvoidfractionModel_IBVoidFraction
voidfractionModel_bigParticleVoidFractionvoidfractionModel_centreVoidFraction
voidfractionModel_dividedVoidFractionvoidfractionModel_noVoidFractionVoidFraction
voidfractionModel_trilinearVoidFraction 
+
+
+
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/IOModel.html b/doc/_build/html/IOModel.html new file mode 100644 index 0000000..3d8be17 --- /dev/null +++ b/doc/_build/html/IOModel.html @@ -0,0 +1,229 @@ + + + + + + + + + + + IOModel command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+ +
+ +
+
+
+ +
+

IOModel command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
IOModel "model";
+
+
+
    +
  • model = name of IO-model to be applied
    • +
+
+
+

Examples

+

IOModel “off”;

+

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

+
+
+

Description

+

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

+
+
+

Restrictions

+

none.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/IOModel_basicIO.html b/doc/_build/html/IOModel_basicIO.html new file mode 100644 index 0000000..befb94d --- /dev/null +++ b/doc/_build/html/IOModel_basicIO.html @@ -0,0 +1,227 @@ + + + + + + + + + + + IOModel_basicIO command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • IOModel_basicIO command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

IOModel_basicIO command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
IOModel "basicIO";
+
+
+
+
+

Examples

+
IOModel "basicIO";
+
+
+
+
+

Description

+

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.

+
+
+

Restrictions

+
+
None.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/IOModel_noIO.html b/doc/_build/html/IOModel_noIO.html new file mode 100644 index 0000000..1da88df --- /dev/null +++ b/doc/_build/html/IOModel_noIO.html @@ -0,0 +1,227 @@ + + + + + + + + + + + IOModel_noIO command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • IOModel_noIO command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

IOModel_noIO command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
IOModel "off";
+
+
+
+
+

Examples

+
IOModel "off";
+
+
+
+
+

Description

+

The noIO-model is a dummy IO model.

+
+
+

Restrictions

+
+
None.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/IOModel_sophIO.html b/doc/_build/html/IOModel_sophIO.html new file mode 100644 index 0000000..942996c --- /dev/null +++ b/doc/_build/html/IOModel_sophIO.html @@ -0,0 +1,227 @@ + + + + + + + + + + + IOModel_sophIO command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • IOModel_sophIO command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

IOModel_sophIO command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
IOModel "sophIO";
+
+
+
+
+

Examples

+
IOModel "sophIO";
+
+
+
+
+

Description

+

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.

+
+
+

Restrictions

+
+
None.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/IOModel_trackIO.html b/doc/_build/html/IOModel_trackIO.html new file mode 100644 index 0000000..113807b --- /dev/null +++ b/doc/_build/html/IOModel_trackIO.html @@ -0,0 +1,227 @@ + + + + + + + + + + + IOModel_trackIO command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • IOModel_trackIO command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

IOModel_trackIO command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
IOModel "trackIO";
+
+
+
+
+

Examples

+
IOModel "trackIO";
+
+
+
+
+

Description

+

The trackIO-model is based on sophIO model and additionally writes fields necessary to use the particleTracks utility (which needs a particleTrackProperties file in the constant dir). The particleTracks utility generates tracks of the particles and writes them to a vtk file.

+
+
+

Restrictions

+
+
None.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/Portfolio_CFDEMcoupling.png b/doc/_build/html/_images/Portfolio_CFDEMcoupling.png old mode 100755 new mode 100644 similarity index 100% rename from doc/Portfolio_CFDEMcoupling.png rename to doc/_build/html/_images/Portfolio_CFDEMcoupling.png diff --git a/doc/_build/html/_sources/CFDEMcoupling_Manual.txt b/doc/_build/html/_sources/CFDEMcoupling_Manual.txt new file mode 100644 index 0000000..a865658 --- /dev/null +++ b/doc/_build/html/_sources/CFDEMcoupling_Manual.txt @@ -0,0 +1,314 @@ +CFDEMcoupling Documentation +*************************** + + +---------- + + +.. image:: Portfolio_CFDEMcoupling.png + :align: center + + +---------- + + +.. _lws: http://www.cfdem.com + + + +.. _lc: CFDEMcoupling_Manual.html#comm + + + +.. _of: http://www.openfoam.com + + + +.. _lig: http://www.cfdem.com + + + +Contents +======== + +The CFDEMcoupling 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 CFDEMcoupling documentation can be improved. + +| 1.1 :ref:`About CFDEMcoupling <1_1>` +| 1.2 :ref:`Installation <1_2>` +| 1.3 :ref:`Tutorials <1_3>` +| 1.4 :ref:`couplingProperties dictionary <1_4>` +| 1.5 :ref:`liggghtsCommands dictionary <1_5>` +| 1.6 :ref:`Models and solvers ` +| + + +---------- + + +.. _1_1: + +About CFDEMcoupling +------------------- + +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(R)(*) `_. The CFDEMcoupling toolbox allows to expand standard CFD solvers of `OpenFOAM(R)(*) `_ 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. + +The coupled solvers run fully parallel on distributed-memory clusters. Features are: + +* its modular approach allows users to easily implement new models +* its MPI parallelization enables to use it for large scale problems +* the `forum `_ on CFD-DEM gives the possibility to exchange with other users / developers +* the use of GIT allows to easily update to the latest version +* basic documentation is provided + + +The file structure: + +* *src* directory including the source files of the coupling toolbox and models +* *applications* directory including the solver files for coupled CFD-DEM simulations +* *doc* directory including the documentation of CFDEMcoupling +* *tutorials* directory including basic tutorial cases showing the functionality + + +Details on installation are given on the `CFDEMproject WWW Site `_ . +The functionality of this CFD-DEM framework is described via :ref:`tutorial cases <_1_2>` showing how to use different solvers and models. + +CFDEMcoupling stands for Computational Fluid Dynamics (CFD) -Discrete Element Method (DEM) coupling. + +CFDEMcoupling is an open-source code, distributed freely under the terms of the GNU Public License (GPL). + +Core development of CFDEMcoupling is done by Christoph Goniva and Christoph Kloss, both at DCS Computing GmbH, 2012 + +This documentation was written by Christoph Goniva, DCS Computing GmbH, 2012 + + +---------- + + +(*) 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. + + +---------- + + +.. _1_2: + +Installation +------------ + +Please follow the installation routine provided at www.cfdem.com. +In order to get the latest code version, please use the git repository at http://github.com (:doc:`githubAccess `). + + +---------- + + +.. _1_3: + +Tutorials +--------- + +**General:** + +Each solver of the CFDEMcoupling 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). + +**Location:** + +The tutorials can be found in the directory $CFDEM_PROJECT_DIR/tutorials, which can be reached by typing "cfdemTut" + +**Structure:** + +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. + +**Usage:** + +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.). + +**Settings:** + +The main settings of a simulation are done via dictionaries: + +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. + +Standard CFD settings are defined in $caseDir/CFD/constant (e.g. transportProperties, RASproperties, etc.) and $caseDir/CFD/system (e.g. fvSchemes, controlDict). You can find more information on that in `OpenFOAM(R)(*) `_ documentations (www.openFoam.com)(*). + +Settings of the coupling routines are defined in $caseDir/CFD/constant/:ref:`couplingProperies <1_3>` (e.g. force models, data exchange model, etc.) and $caseDir/CFD/constant/:ref:`liggghtsCommands <1_3>` (allows to execute a LIGGGHTS command during a coupled simulation). + + +---------- + + +.. _1_4: + +"couplingProperties" dictionary +------------------------------- + +**General:** + +In the "couplingProperties" dictionary the setup of the coupling routines of the CFD-DEM simulation are defined. + +**Location:** $caseDir/CFD/constant + +**Structure:** + +The dictionary is divided into two parts, "sub-models & settings" and "sub-model properties". + +In "sub-models & settings" the following routines must be specified: + +* modelType +* couplingInterval +* voidFractionModel +* locateModel +* meshMotionModel +* regionModel +* IOModel +* dataExchangeModel +* averagingModel +* forceModels +* momCoupleModels +* turbulenceModelType + + +In "sub-model properties" sub-dictionaries might be defined to specify model specific parameters. + +**Settings:** + +Reasonable example settings for the "couplingProperties" dictionary are given in the tutorial cases. + +.. parsed-literal:: + + modelType + +"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. + +.. parsed-literal:: + + couplingInterval + +The coupling interval determines the time passing between two CFD-DEM data exchanges. + +A useful procedure would be: +1) Set the DEM timestep in the in.xxx file according to the needs of the pure DEM problem. +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) 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!". + +Example: DEMts=0.00001s, couplingInterval=10 exchange data (=couple) will happen every 0.0001s. + + +---------- + + +.. _1_5: + +"liggghtsCommands" dictionary +--------------------------------------- + +**General:** + +In the "liggghtsCommands" dictionary liggghts commands being executed during a coupled CFD-DEM simulation are specified. + +**Location:** $caseDir/CFD/constant + +**Structure:** + +The dictionary is divided into two parts, first a list of "liggghtsCommandModels" is defined, then the settings for each model must be specified. + +**Settings:** + +Reasonable example settings for the "liggghtsCommands" dictionary are given in the tutorial cases. + + +---------- + + +.. _cmd_5: + +.. _comm: + +Models/Solvers +------------------------------------- + +This section lists all CFDEMcoupling sub-models and solvers alphabetically, with a separate +listing below of styles within certain commands. + ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`IOModel ` | :doc:`IOModel_basicIO ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`IOModel_noIO ` | :doc:`IOModel_sophIO ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`IOModel_trackIO ` | :doc:`averagingModel ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`averagingModel_dense ` | :doc:`averagingModel_dilute ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`cfdemSolverIB ` | :doc:`cfdemSolverPiso ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`cfdemSolverPisoScalar ` | :doc:`clockModel ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`clockModel_noClock ` | :doc:`clockModel_standardClock ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`dataExchangeModel ` | :doc:`dataExchangeModel_noDataExchange ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`dataExchangeModel_oneWayVTK ` | :doc:`dataExchangeModel_twoWayFiles ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`dataExchangeModel_twoWayMPI ` | :doc:`forceModel ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`forceModel_Archimedes ` | :doc:`forceModel_ArchimedesIB ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`forceModel_DiFeliceDrag ` | :doc:`forceModel_GidaspowDrag ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`forceModel_KochHillDrag ` | :doc:`forceModel_LaEuScalarTemp ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`forceModel_MeiLift ` | :doc:`forceModel_SchillerNaumannDrag ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`forceModel_ShirgaonkarIB ` | :doc:`forceModel_checkCouplingInterval ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`forceModel_fieldStore ` | :doc:`forceModel_fieldTimeAverage ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`forceModel_gradPForce ` | :doc:`forceModel_noDrag ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`forceModel_particleCellVolume ` | :doc:`forceModel_particleVolume ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`forceModel_scalarGeneralExchange ` | :doc:`forceModel_virtualMassForce ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`forceModel_viscForce ` | :doc:`forceModel_volWeightedAverage ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`forceSubModel ` | :doc:`forceSubModel_ImEx ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`liggghtsCommandModel ` | :doc:`liggghtsCommandModel_execute ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`liggghtsCommandModel_readLiggghtsData ` | :doc:`liggghtsCommandModel_runLiggghts ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`liggghtsCommandModel_setDEMGravity ` | :doc:`liggghtsCommandModel_writeLiggghts ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`locateModel ` | :doc:`locateModel_engineSearch ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`locateModel_engineSearchIB ` | :doc:`locateModel_standardSearch ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`meshMotionModel ` | :doc:`meshMotionModel_noMeshMotion ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`momCoupleModel ` | :doc:`momCoupleModel_explicitCouple ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`momCoupleModel_implicitCouple ` | :doc:`momCoupleModel_noCouple ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`probeModel ` | :doc:`probeModel_noProbe ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`probeModel_particleProbe ` | :doc:`regionModel ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`regionModel_allRegion ` | :doc:`scalarTransportModel ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`smoothingModel ` | :doc:`smoothingModel_constDiffSmoothing ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`smoothingModel_noSmoothing ` | :doc:`voidfractionModel ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`voidfractionModel_GaussVoidFraction ` | :doc:`voidfractionModel_IBVoidFraction ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`voidfractionModel_bigParticleVoidFraction ` | :doc:`voidfractionModel_centreVoidFraction ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`voidfractionModel_dividedVoidFraction ` | :doc:`voidfractionModel_noVoidFractionVoidFraction ` | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :doc:`voidfractionModel_trilinearVoidFraction ` | | ++----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/IOModel.txt b/doc/_build/html/_sources/IOModel.txt new file mode 100644 index 0000000..72b5a22 --- /dev/null +++ b/doc/_build/html/_sources/IOModel.txt @@ -0,0 +1,45 @@ +.. index:: IOModel + +IOModel command +=============== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + IOModel "model"; + +* model = name of IO-model to be applied + +Examples +"""""""" + +IOModel "off"; + +Note: This examples list might not be complete - please look for other models (IOModel_XY) in this documentation. + +Description +""""""""""" + +The IO-model is the base class to write data (e.g. particle properties) to files. + +Restrictions +"""""""""""" + + +none. + +Related commands +"""""""""""""""" + +Note: This examples list may be incomplete - please look for other models (IOModel_XY) in this documentation. + +**Default:** none. + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/IOModel_basicIO.txt b/doc/_build/html/_sources/IOModel_basicIO.txt new file mode 100644 index 0000000..3a72680 --- /dev/null +++ b/doc/_build/html/_sources/IOModel_basicIO.txt @@ -0,0 +1,39 @@ +.. index:: IOModel_basicIO + +IOModel_basicIO command +======================= + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + IOModel "basicIO"; + +Examples +"""""""" + +.. parsed-literal:: + + IOModel "basicIO"; + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + None. + +Related commands +"""""""""""""""" + +:doc:`IOModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/IOModel_noIO.txt b/doc/_build/html/_sources/IOModel_noIO.txt new file mode 100644 index 0000000..953b2cb --- /dev/null +++ b/doc/_build/html/_sources/IOModel_noIO.txt @@ -0,0 +1,39 @@ +.. index:: IOModel_noIO + +IOModel_noIO command +==================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + IOModel "off"; + +Examples +"""""""" + +.. parsed-literal:: + + IOModel "off"; + +Description +""""""""""" + +The noIO-model is a dummy IO model. + +Restrictions +"""""""""""" + None. + +Related commands +"""""""""""""""" + +:doc:`IOModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/IOModel_sophIO.txt b/doc/_build/html/_sources/IOModel_sophIO.txt new file mode 100644 index 0000000..17443f1 --- /dev/null +++ b/doc/_build/html/_sources/IOModel_sophIO.txt @@ -0,0 +1,39 @@ +.. index:: IOModel_sophIO + +IOModel_sophIO command +====================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + IOModel "sophIO"; + +Examples +"""""""" + +.. parsed-literal:: + + IOModel "sophIO"; + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + None. + +Related commands +"""""""""""""""" + +:doc:`IOModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/IOModel_trackIO.txt b/doc/_build/html/_sources/IOModel_trackIO.txt new file mode 100644 index 0000000..122a333 --- /dev/null +++ b/doc/_build/html/_sources/IOModel_trackIO.txt @@ -0,0 +1,39 @@ +.. index:: IOModel_trackIO + +IOModel_trackIO command +======================= + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + IOModel "trackIO"; + +Examples +"""""""" + +.. parsed-literal:: + + IOModel "trackIO"; + +Description +""""""""""" + +The trackIO-model is based on sophIO model and additionally writes fields necessary to use the particleTracks utility (which needs a particleTrackProperties file in the constant dir). The particleTracks utility generates tracks of the particles and writes them to a vtk file. + +Restrictions +"""""""""""" + None. + +Related commands +"""""""""""""""" + +:doc:`IOModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/averagingModel.txt b/doc/_build/html/_sources/averagingModel.txt new file mode 100644 index 0000000..43df6a3 --- /dev/null +++ b/doc/_build/html/_sources/averagingModel.txt @@ -0,0 +1,48 @@ +.. index:: averagingModel + +averagingModel command +====================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + averagingModel model; + +* model = name of averaging model to be applied + +Examples +"""""""" + +.. parsed-literal:: + + averagingModel dense; + averagingModel dilute; + +Note: This examples list might not be complete - please have a look for other averaging models (averagingModel_XY) in this documentation. + +Description +""""""""""" + +The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. particle velocities). + +Restrictions +"""""""""""" + + +None. + +Related commands +"""""""""""""""" + +:doc:`dense `, :doc:`dilute ` + +**Default:** none + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/averagingModel_dense.txt b/doc/_build/html/_sources/averagingModel_dense.txt new file mode 100644 index 0000000..edd9a42 --- /dev/null +++ b/doc/_build/html/_sources/averagingModel_dense.txt @@ -0,0 +1,41 @@ +.. index:: averagingModel_dense + +averagingModel_dense command +============================ + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + averagingModel dense; + +Examples +"""""""" + +.. parsed-literal:: + + averagingModel dense; + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + + +No known restrictions. + +Related commands +"""""""""""""""" + +:doc:`averagingModel `, :doc:`dilute ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/averagingModel_dilute.txt b/doc/_build/html/_sources/averagingModel_dilute.txt new file mode 100644 index 0000000..5ae7c3b --- /dev/null +++ b/doc/_build/html/_sources/averagingModel_dilute.txt @@ -0,0 +1,42 @@ +.. index:: averagingModel_dilute + +averagingModel_dilute command +============================= + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + averagingModel dilute; + +Examples +"""""""" + +.. parsed-literal:: + + averagingModel dilute; + +Description +""""""""""" + +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 "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). + +Restrictions +"""""""""""" + + +This model is computationally efficient, but should only be used when only one particle is inside one CFD cell. + +Related commands +"""""""""""""""" + +:doc:`averagingModel `, :doc:`dense ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/cfdemSolverIB.txt b/doc/_build/html/_sources/cfdemSolverIB.txt new file mode 100644 index 0000000..30ee3cc --- /dev/null +++ b/doc/_build/html/_sources/cfdemSolverIB.txt @@ -0,0 +1,51 @@ +.. index:: cfdemSolverIB + +cfdemSolverIB command +===================== + +Description +""""""""""" + +"cfdemSolverIB" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework, for calculating +the 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(R)(*) 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. + +Code of this solver contributions by Alice Hager, JKU. + +**Algorithm:** + +For each time step ... + +* 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). +* the Navier-Stokes equations are solved on the whole computational domain, disregarding the solid phase. +* 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. +* 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. + + +**Use:** + +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: + +:doc:`engineSearchIB `, :doc:`ArchimedesIB `, :doc:`ShirgaonkarIB `, :doc:`IBVoidfraction ` + +**References:** + +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 + +and + +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 + + +---------- + + +(*) 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. + + +---------- + + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/cfdemSolverPiso.txt b/doc/_build/html/_sources/cfdemSolverPiso.txt new file mode 100644 index 0000000..a610f1c --- /dev/null +++ b/doc/_build/html/_sources/cfdemSolverPiso.txt @@ -0,0 +1,28 @@ +.. index:: cfdemSolverPiso + +cfdemSolverPiso command +======================= + +Description +""""""""""" + +"cfdemSolverPiso" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam(R)(*), 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. + +see: + +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. + + +---------- + + +(*) 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. + + +---------- + + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/cfdemSolverPisoScalar.txt b/doc/_build/html/_sources/cfdemSolverPisoScalar.txt new file mode 100644 index 0000000..b7e5bd3 --- /dev/null +++ b/doc/_build/html/_sources/cfdemSolverPisoScalar.txt @@ -0,0 +1,30 @@ +.. index:: cfdemSolverPisoScalar + +cfdemSolverPisoScalar command +============================= + +Description +""""""""""" + +"cfdemSolverPisoScalar" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam(R)(*), 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". + +see: + +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. + +The heat transfer equation is implemented according to Nield & Bejan (2013), Convection in Porous Media, DOI 10.1007/978-1-4614-5541-7_2, Springer + + +---------- + + +(*) 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. + + +---------- + + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/clockModel.txt b/doc/_build/html/_sources/clockModel.txt new file mode 100644 index 0000000..d6932a9 --- /dev/null +++ b/doc/_build/html/_sources/clockModel.txt @@ -0,0 +1,42 @@ +.. index:: clockModel + +clockModel command +================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + clockModel model; + +* model = name of the clockModel to be applied + +Examples +"""""""" + +.. parsed-literal:: + + clockModel standardClock; + +Note: This examples list might not be complete - please look for other models (clockModel_XY) in this documentation. + +Description +""""""""""" + +The clockModel is the base class for models to examine the code/algorithm with respect to run time. + +Main parts of the clockModel classes are written by Josef Kerbl, JKU. + +Restrictions +"""""""""""" + none. + +**Default:** none. + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/clockModel_noClock.txt b/doc/_build/html/_sources/clockModel_noClock.txt new file mode 100644 index 0000000..0966a47 --- /dev/null +++ b/doc/_build/html/_sources/clockModel_noClock.txt @@ -0,0 +1,39 @@ +.. index:: clockModel_noClock + +clockModel_noClock command +========================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + clockModel off; + +Examples +"""""""" + +.. parsed-literal:: + + clockModel off; + +Description +""""""""""" + +The "noClock" model is a dummy clockModel model which does not measure/evaluate the run time. + +Restrictions +"""""""""""" + none. + +Related commands +"""""""""""""""" + +:doc:`clockModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/clockModel_standardClock.txt b/doc/_build/html/_sources/clockModel_standardClock.txt new file mode 100644 index 0000000..bafe86e --- /dev/null +++ b/doc/_build/html/_sources/clockModel_standardClock.txt @@ -0,0 +1,41 @@ +.. index:: clockModel_standardClock + +clockModel_standardClock command +================================ + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + clockModel standardClock; + +Examples +"""""""" + +.. parsed-literal:: + + clockModel standardClock; + +Description +""""""""""" + +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 . +Since 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. +After 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. + +Restrictions +"""""""""""" + none. + +Related commands +"""""""""""""""" + +:doc:`clockModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/dataExchangeModel.txt b/doc/_build/html/_sources/dataExchangeModel.txt new file mode 100644 index 0000000..56e183d --- /dev/null +++ b/doc/_build/html/_sources/dataExchangeModel.txt @@ -0,0 +1,48 @@ +.. index:: dataExchangeModel + +dataExchangeModel command +========================= + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + dataExchangeModel model; + +* model = name of data exchange model to be applied + +Examples +"""""""" + +.. parsed-literal:: + + dataExchangeModel twoWayFiles; + dataExchangeModel twoWayMPI; + +Note: This examples list might not be complete - please look for other models (dataExchangeModel_XY) in this documentation. + +Description +""""""""""" + +The data exchange model performs the data exchange between the DEM code and the CFD code. + +Restrictions +"""""""""""" + + +None. + +Related commands +"""""""""""""""" + +:doc:`noDataExchange `, :doc:`oneWayVTK `, :doc:`twoWayFiles `, :doc:`twoWayMPI ` + +**Default:** none + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/dataExchangeModel_noDataExchange.txt b/doc/_build/html/_sources/dataExchangeModel_noDataExchange.txt new file mode 100644 index 0000000..09304d4 --- /dev/null +++ b/doc/_build/html/_sources/dataExchangeModel_noDataExchange.txt @@ -0,0 +1,41 @@ +.. index:: dataExchangeModel_noDataExchange + +dataExchangeModel_noDataExchange command +======================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + dataExchangeModel noDataExchange; + +Examples +"""""""" + +.. parsed-literal:: + + dataExchangeModel noDataExchange; + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + + +None. + +Related commands +"""""""""""""""" + +:doc:`dataExchangeModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/dataExchangeModel_oneWayVTK.txt b/doc/_build/html/_sources/dataExchangeModel_oneWayVTK.txt new file mode 100644 index 0000000..266998e --- /dev/null +++ b/doc/_build/html/_sources/dataExchangeModel_oneWayVTK.txt @@ -0,0 +1,61 @@ +.. index:: dataExchangeModel_oneWayVTK + +dataExchangeModel_oneWayVTK command +=================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + dataExchangeModel oneWayVTK; + oneWayVTKProps + { + DEMts timeStep; + relativePath "path"; + couplingFilename "filename"; + maxNumberOfParticles number; + }; + +* *timeStep* = time step size of stored DEM data +* *path* = path to the VTK data files relative do simulation directory +* *filename* = filename of the VTK file series +* *number* = maximum number of particles in DEM simulation + + +Examples +"""""""" + +.. parsed-literal:: + + dataExchangeModel oneWayVTK; + oneWayVTKProps + { + DEMts 0.0001; + relativePath "../DEM/post"; + couplingFilename "vtk_out%4.4d.vtk"; + maxNumberOfParticles 30000; + } + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + + +None. + +Related commands +"""""""""""""""" + +:doc:`dataExchangeModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/dataExchangeModel_twoWayFiles.txt b/doc/_build/html/_sources/dataExchangeModel_twoWayFiles.txt new file mode 100644 index 0000000..ce54768 --- /dev/null +++ b/doc/_build/html/_sources/dataExchangeModel_twoWayFiles.txt @@ -0,0 +1,57 @@ +.. index:: dataExchangeModel_twoWayFiles + +dataExchangeModel_twoWayFiles command +===================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + dataExchangeModel twoWayFiles; + twoWayFilesProps + { + couplingFilename "filename"; + maxNumberOfParticles scalar1; + DEMts scalar2; + }; + +* *filename* = filename of the VTK file series +* *scalar1* = maximum number of particles in DEM simulation +* *scalar2* = DEM time step width + + +Examples +"""""""" + +.. parsed-literal:: + + dataExchangeModel twoWayFiles; + twoWayFilesProps + { + couplingFilename "vtk_out%4.4d.vtk"; + maxNumberOfParticles 30000; + } + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + + +Developed only for two processors, one for DEM and one for CFD run. + +Related commands +"""""""""""""""" + +:doc:`dataExchangeModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/dataExchangeModel_twoWayMPI.txt b/doc/_build/html/_sources/dataExchangeModel_twoWayMPI.txt new file mode 100644 index 0000000..0b82181 --- /dev/null +++ b/doc/_build/html/_sources/dataExchangeModel_twoWayMPI.txt @@ -0,0 +1,52 @@ +.. index:: dataExchangeModel_twoWayMPI + +dataExchangeModel_twoWayMPI command +=================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + dataExchangeModel twoWayMPI; + twoWayMPIProps + { + liggghtsPath "path"; + }; + +* *path* = path to the DEM simulation input file + + +Examples +"""""""" + +.. parsed-literal:: + + dataExchangeModel twoWayMPI; + twoWayMPIProps + { + liggghtsPath "../DEM/in.liggghts_init"; + } + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + + +none. + +Related commands +"""""""""""""""" + +:doc:`dataExchangeModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel.txt b/doc/_build/html/_sources/forceModel.txt new file mode 100644 index 0000000..d4b60d7 --- /dev/null +++ b/doc/_build/html/_sources/forceModel.txt @@ -0,0 +1,57 @@ +.. index:: forceModel + +forceModel command +================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + model_x + model_y + ); + +* model = name of force model to be applied + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + Archimedes + DiFeliceDrag + ); + +Note: This examples list might not be complete - please look for other models (forceModel_XY) in this documentation. + +Description +""""""""""" + +The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. 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. + +Restrictions +"""""""""""" + + +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, a warning is written to the terminal (log file). Setting a flag "cgWarnOnly false;" in coupling properties, the simulation will be stopped if there is a violation. + +Related commands +"""""""""""""""" + +:doc:`Archimedes `, :doc:`DiFeliceDrag `, :doc:`gradPForce `, :doc:`viscForce ` + +Note: This examples list may be incomplete - please look for other models (forceModel_XY) in this documentation. + +**Default:** none. + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_Archimedes.txt b/doc/_build/html/_sources/forceModel_Archimedes.txt new file mode 100644 index 0000000..97b6e7e --- /dev/null +++ b/doc/_build/html/_sources/forceModel_Archimedes.txt @@ -0,0 +1,66 @@ +.. index:: forceModel_Archimedes + +forceModel_Archimedes command +============================= + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + Archimedes + ); + ArchimedesProps + { + gravityFieldName "gravity"; + twoDimensional; + suppressProbe switch1; + treatForceDEM switch2; + verbose switch3; + }; + +* *gravity* = name of the finite volume gravity field +* *twoDimensional* = optional keyword for conducting a two dimensional calculation +* *switch1* = (optional, default false) can be used to suppress the output of the probe model +* *switch2* = (optional, default true) sub model switch, see :doc:`forceSubModel ` for details +* *switch3* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + Archimedes + ); + ArchimedesProps + { + gravityFieldName "g"; + } + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + + +none. + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_ArchimedesIB.txt b/doc/_build/html/_sources/forceModel_ArchimedesIB.txt new file mode 100644 index 0000000..8c748e2 --- /dev/null +++ b/doc/_build/html/_sources/forceModel_ArchimedesIB.txt @@ -0,0 +1,65 @@ +.. index:: forceModel_ArchimedesIB + +forceModel_ArchimedesIB command +=============================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + ArchimedesIB + ); + ArchimedesIBProps + { + gravityFieldName "gravity"; + voidfractionFieldName "voidfraction"; + twoDimensional; + treatForceExplicit switch1; + }; + +* *gravity* = name of the finite volume gravity field +* *voidfraction* = name of the finite volume voidfraction field +* *twoDimensional* = optional keyword for conducting a two dimensional calculation +* *switch1* = (optional, default true) sub model switch, see :doc:`forceSubModel ` for details + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + ArchimedesIB + ); + ArchimedesIBProps + { + gravityFieldName "g"; + voidfractionFieldName "voidfractionNext"; + } + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + + +Only for immersed boundary solvers. + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_DiFeliceDrag.txt b/doc/_build/html/_sources/forceModel_DiFeliceDrag.txt new file mode 100644 index 0000000..19212a0 --- /dev/null +++ b/doc/_build/html/_sources/forceModel_DiFeliceDrag.txt @@ -0,0 +1,85 @@ +.. index:: forceModel_DiFeliceDrag + +forceModel_DiFeliceDrag command +=============================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + DiFeliceDrag + ); + DiFeliceDragProps + { + velFieldName "U"; + voidfractionFieldName "voidfraction"; + granVelFieldName "Us"; + interpolation switch1; + voidfractionInterpolationType "type1"; + UInterpolationType "type2"; + suppressProbe switch2; + scale scalar1; + scaleDrag scalar2; + treatForceExplicit switch3; + implForceDEM switch4; + verbose switch5; + scalarViscosity switch6; + nu scalar3; + }; + +* *U* = name of the finite volume fluid velocity field +* *voidfraction* = name of the finite volume voidfraction field +* *Us* = name of the finite volume granular velocity field +* *switch1* = (optional, normally off) flag to use interpolated voidfraction and velocity values +* *type1* = (optional, default cellPoint) interpolation type for voidfraction field +* *type2* = (optional, default cellPointFace) interpolation type for velocity field +* *switch2* = (optional, default false) can be used to suppress the output of the probe model +* *scalar1* = (optional) scaling of particle diameter +* *scalar2* = (optional) scaling of drag law +* *switch3* = sub model switch, see :doc:`forceSubModel ` for details +* *switch4* = sub model switch, see :doc:`forceSubModel ` for details +* *switch5* = sub model switch, see :doc:`forceSubModel ` for details +* *switch6* = sub model switch, see :doc:`forceSubModel ` for details +* *scalar3* = optional, only if switch6 is true + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + DiFeliceDrag + ); + DiFeliceDragProps + { + velFieldName "U"; + interpolation true; + } + +Description +""""""""""" + +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). + +Restrictions +"""""""""""" + + +none. + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_GidaspowDrag.txt b/doc/_build/html/_sources/forceModel_GidaspowDrag.txt new file mode 100644 index 0000000..0e1f9d3 --- /dev/null +++ b/doc/_build/html/_sources/forceModel_GidaspowDrag.txt @@ -0,0 +1,92 @@ +.. index:: forceModel_GidaspowDrag + +forceModel_GidaspowDrag command +=============================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + GidaspowDrag + ); + GidaspowDragProps + { + velFieldName "U"; + voidfractionFieldName "voidfraction"; + granVelFieldName "Us"; + phi scalar1; + interpolation switch1; + voidfractionInterpolationType "type1" + UInterpolationType "type2" + implForceDEM switch2; + suppressProbe switch3; + scale scalar2; + scaleDrag scalar3; + switchingVoidfraction scalar4; + treatForceExplicit switch4; + implForceDEM switch5; + verbose switch6; + scalarViscosity switch7; + nu scalar5; + }; + +* *U* = name of the finite volume fluid velocity field +* *voidfraction* = name of the finite volume voidfraction field +* *Us* = name of the finite volume cell averaged particle velocity field +* *scalar1* = drag correction factor (in doubt 1) +* *switch1* = (optional, default off) flag to use interpolated voidfraction and fluid velocity values +* *type1* = (optional, default cellPoint) interpolation type for voidfraction field +* *type2* = (optional, default cellPointFace) interpolation type for velocity field +* *switch2* = (optional, default false) flag to use implicit formulation of drag on DEM side + *switch3* = (optional, default false) can be used to suppress the output of the probe model +* *scalar2* = (optional) scaling of particle diameter +* *scalar3* = (optional) scaling of drag law +* *scalar4* = (optional) voidfraction above which dilute formulation will be used +* *switch4* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details +* *switch5* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details +* *switch6* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details +* *switch7* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details +* *scalar5* = (optional, default false) optional, only if switch6 is true + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + GidaspowDrag + ); + GidaspowDragProps + { + velFieldName "U"; + voidfractionFieldName "voidfraction"; + granVelFieldName "Us"; + } + +Description +""""""""""" + +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). + +Restrictions +"""""""""""" + + +none. + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_KochHillDrag.txt b/doc/_build/html/_sources/forceModel_KochHillDrag.txt new file mode 100644 index 0000000..828e3f5 --- /dev/null +++ b/doc/_build/html/_sources/forceModel_KochHillDrag.txt @@ -0,0 +1,87 @@ +.. index:: forceModel_KochHillDrag + +forceModel_KochHillDrag command +=============================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + KochHillDrag + ); + KochHillDragProps + { + velFieldName "U"; + voidfractionFieldName "voidfraction"; + granVelFieldName "Us" + interpolation "switch1"; + voidfractionInterpolationType "type1" + UInterpolationType "type2" + implForceDEM "switch2"; + suppressProbe "switch3"; + scale "scalar1"; + scaleDrag "scalar2"; + treatForceExplicit "switch4"; + verbose "switch5"; + implForceDEMaccumulated "switch6"; + scalarViscosity "switch7"; + nu "scalar3"; + }; + +* *U* = name of the finite volume fluid velocity field +* *voidfraction* = name of the finite volume voidfraction field +* *Us* = (optional) name of finite volume granular velocity field +* *switch1* = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values +* *type1* = (optional, default cellPoint) interpolation type for voidfraction field +* *type2* = (optional, default cellPointFace) interpolation type for velocity field +* *switch2* = (optional, normally off) flag to use implicit formulation of drag on DEM side + *switch3* = (optional, default false) can be used to suppress the output of the probe model +* *scalar1* = (optional) scaling of particle diameter +* *scalar2* = (optional) scaling of drag law +* *switch4* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details +* *switch5* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details +* *switch6* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details +* *switch7* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details +* *scalar3* = optional, only if switch7 is true + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + KochHillDrag + ); + KochHillDragProps + { + velFieldName "U"; + voidfractionFieldName "voidfraction"; + } + +Description +""""""""""" + +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). + +Restrictions +"""""""""""" + + +none. + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_LaEuScalarTemp.txt b/doc/_build/html/_sources/forceModel_LaEuScalarTemp.txt new file mode 100644 index 0000000..01c712f --- /dev/null +++ b/doc/_build/html/_sources/forceModel_LaEuScalarTemp.txt @@ -0,0 +1,94 @@ +.. index:: forceModel_LaEuScalarTemp + +forceModel_LaEuScalarTemp command +================================= + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + LaEuScalarTemp + ); + LaEuScalarTempProps + { + velFieldName "U"; + tempFieldName "T"; + voidfractionFieldName "voidfraction"; + partTempName "Temp"; + partHeatFluxName "convectiveHeatFlux"; + partHeatTransCoeffName "heatTransCoeff"; + partHeatFluidName "heatFluid"; + lambda scalar1; + Cp scalar2; + interpolation switch1; + TInterpolationType "type1" + verbose switch2; + maxSource scalar3; + scale scalar4; + scalarViscosity switch3; + nu scalar5; + }; + +* *U* = name of the finite volume fluid velocity field +* *T* = name of the finite volume scalar temperature field +* *voidfraction* = name of the finite volume voidfraction field +* *Temp* = name of the DEM data representing the particles temperature +* *convectiveHeatFlux* = name of the DEM data representing the particle-fluid convective heat flux +* *heatTransCoeff* = name of heat transfer coefficient +* *heatFluid* = + *scalar1* = fluid thermal conductivity [W/(m*K)] +* *scalar2* = fluid specific heat capacity [W*s/(kg*K)] +* *switch1* = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values +* *type1* = (optional, default cellPoint) interpolation type for T field +* *switch2* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details +* *scalar3* = (optional) limit maximal turbulence +* *scalar4* = scaling of particle diameter +* *switch3* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details +* *scalar5* = optional, only if switch3 is true + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + LaEuScalarTemp + ); + LaEuScalarTempProps + { + velFieldName "U"; + tempFieldName "T"; + voidfractionFieldName "voidfraction"; + partTempName "Temp"; + partHeatFluxName "convectiveHeatFlux"; + lambda 0.0256; + Cp 1007; + } + +Description +""""""""""" + +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 + +Restrictions +"""""""""""" + + +Goes only with cfdemSolverScalar. The force model has to be the second (!!!) model in the forces list. + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_MeiLift.txt b/doc/_build/html/_sources/forceModel_MeiLift.txt new file mode 100644 index 0000000..b59b5f7 --- /dev/null +++ b/doc/_build/html/_sources/forceModel_MeiLift.txt @@ -0,0 +1,77 @@ +.. index:: forceModel_MeiLift + +forceModel_MeiLift command +========================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + MeiLift + ); + MeiLiftProps + { + velFieldName "U"; + useSecondOrderTerms; + interpolation switch1; + vorticityInterpolationType "type1" + UInterpolationType "type2" + verbose switch2; + treatForceExplicit switch3; + scalarViscosity switch4; + nu scalar1; + }; + +* *U* = name of the finite volume fluid velocity field +* *useSecondOrderTerms* = switch to activate second order terms in the lift force model +* *switch1* = switch to activate tri-linear interpolation of the flow quantities at the particle position +* *type1* = (optional, default cellPoint) interpolation type for vorticity field +* *type2* = (optional, default cellPointFace) interpolation type for velocity field +* *switch2* = switch to activate the report of per-particle quantities to the screen +* *switch3* = (optional, default true) sub model switch, see :doc:`forceSubModel ` for details +* *switch4* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details +* *scalar1* = optional, only if switch4 is true + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + MeiLift + ); + MeiLiftProps + { + velFieldName "U"; + useSecondOrderTerms; + interpolation true; + verbose true; + } + +Description +""""""""""" + +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). + +Restrictions +"""""""""""" + + +None. + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_SchillerNaumannDrag.txt b/doc/_build/html/_sources/forceModel_SchillerNaumannDrag.txt new file mode 100644 index 0000000..e51a4f0 --- /dev/null +++ b/doc/_build/html/_sources/forceModel_SchillerNaumannDrag.txt @@ -0,0 +1,68 @@ +.. index:: forceModel_SchillerNaumannDrag + +forceModel_SchillerNaumannDrag command +====================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + SchillerNaumannDrag + ); + SchillerNaumannDragProps + { + velFieldName "U"; + voidfractionFieldName "voidfraction"; + interpolation "bool1"; + voidfractionInterpolationType "type1" + UInterpolationType "type2" + implForceDEM "bool2"; + }; + +* *U* = name of the finite volume fluid velocity field +* *voidfraction* = name of the finite volume voidfraction field +* *bool1* = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values +* *type1* = (optional, default cellPoint) interpolation type for voidfraction field +* *type2* = (optional, default cellPointFace) interpolation type for velocity field +*bool2* = (optional, normally off) flag to use implicit formulation of drag on DEM side:l + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + SchillerNaumannDrag + ); + SchillerNaumannDragProps + { + velFieldName "U"; + } + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + + +none. + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_ShirgaonkarIB.txt b/doc/_build/html/_sources/forceModel_ShirgaonkarIB.txt new file mode 100644 index 0000000..92ec9b9 --- /dev/null +++ b/doc/_build/html/_sources/forceModel_ShirgaonkarIB.txt @@ -0,0 +1,73 @@ +.. index:: forceModel_ShirgaonkarIB + +forceModel_ShirgaonkarIB command +================================ + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + ShirgaonkarIB + ); + ShirgaonkarIBProps + { + velFieldName "U"; + pressureFieldName "p"; + twoDimensional; + depth scalar1; + verbose switch1; + treatForceExplicit switch2; + }; + +* *U* = name of the finite volume fluid velocity field +* *p* = name of the finite volume pressure field +* *twoDimensional* = optional keyword for conducting a two dimensional calculation +* *scalar1* = optional, only necessary if twoDimensional is active +* *switch1* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details +* *switch2* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + ShirgaonkarIB + ); + ShirgaonkarIBProps + { + velFieldName "U"; + pressureFieldName "p"; + } + +Description +""""""""""" + +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. + +**References:** + +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. + +Restrictions +"""""""""""" + + +Only for immersed boundary solvers. + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_checkCouplingInterval.txt b/doc/_build/html/_sources/forceModel_checkCouplingInterval.txt new file mode 100644 index 0000000..87adad1 --- /dev/null +++ b/doc/_build/html/_sources/forceModel_checkCouplingInterval.txt @@ -0,0 +1,74 @@ +.. index:: forceModel_checkCouplingInterval + +forceModel_checkCouplingInterval command +======================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + checkCouplingInterval + ); + checkCouplingIntervalProps + { + warnOnly bool1; + velocityFieldName word1; + rhoP scalar1; + maxCFL scalar2; + maxAccNr scalar3; + UmaxExpected scalar4; + minAllowedVcellByVparcel scalar5; + timeInterval scalar6; + }; + +* *bool1* = (optional, default true) switch to warn or stop simulation if criterion is broken. +* *word1* = (optional, default U) name of velocity field. +* *scalar1* = particle density assumed for calculation of the particle relaxation time +* *scalar2* = (optional, default=50) maximum allowed CFL number. +* *scalar3* = (optional, default=0.1) maximum allowed ratio of coupling time to particle relaxation time. +* *scalar4* = maximum expected velocity fluid velocity (e.g. due to BCs) - used for CFL estimation. +* *scalar5* = (optional, default=3) min allowed volume ratio of cell / particle. +* *scalar6* = (optional, default=coupling time) interval of execution. + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + checkCouplingInterval + ); + checkCouplingIntervalProps + { + rhoP 2500; + UmaxExpected 10; + timeInterval 0.002; + } + +Description +""""""""""" + +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: (i) 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.1. (ii) 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. (iii) The ratio of smallest cell biggest particle volume. Typically this should be larger than 3. (iiii) The minimum and maximum Stokes Number. For the criteria (i)-(iii) 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. + +Restrictions +"""""""""""" + + +needs MPI based dataExchange model - e.g. oneWayVTK will not work. + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_fieldStore.txt b/doc/_build/html/_sources/forceModel_fieldStore.txt new file mode 100644 index 0000000..3e7a5e1 --- /dev/null +++ b/doc/_build/html/_sources/forceModel_fieldStore.txt @@ -0,0 +1,73 @@ +.. index:: forceModel_fieldStore + +forceModel_fieldStore command +============================= + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + fieldStore + ); + fieldStoreProps + { + scalarFieldNames + ( + "scalarField" + ); + vectorFieldNames + ( + "vectorField" + ); + }; + +* *scalarField* = names of the finite volume scalar fields to be stored +* *vectorField* = names of the finite volume vector fields to be stored + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + fieldStore + ); + fieldStoreProps + { + scalarFieldNames + ( + "voidfraction" + ); + vectorFieldNames + ( + "U" + ); + } + +Description +""""""""""" + +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). + +Restrictions +"""""""""""" + + +none. + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_fieldTimeAverage.txt b/doc/_build/html/_sources/forceModel_fieldTimeAverage.txt new file mode 100644 index 0000000..17f6098 --- /dev/null +++ b/doc/_build/html/_sources/forceModel_fieldTimeAverage.txt @@ -0,0 +1,76 @@ +.. index:: forceModel_fieldTimeAverage + +forceModel_fieldTimeAverage command +=================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + fieldTimeAverage + ); + fieldTimeAverageProps + { + startTime time; + scalarFieldNames + ( + "scalarField" + ); + vectorFieldNames + ( + "vectorField" + ); + }; + +* *time* = (optional) time to start temporal averaging +* *scalarField* = names of the finite volume scalar fields to be temporally averaged +* *vectorField* = names of the finite volume vector fields to be temporally averaged + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + fieldTimeAverage + ); + fieldTimeAverageProps + { + startTime 1.0; + scalarFieldNames + ( + "voidfraction" + ); + vectorFieldNames + ( + "Us" + ); + } + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + + +none. + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_gradPForce.txt b/doc/_build/html/_sources/forceModel_gradPForce.txt new file mode 100644 index 0000000..f2286d8 --- /dev/null +++ b/doc/_build/html/_sources/forceModel_gradPForce.txt @@ -0,0 +1,74 @@ +.. index:: forceModel_gradPForce + +forceModel_gradPForce command +============================= + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + gradPForce; + ); + gradPForceProps + { + pFieldName "pressure"; + velocityFieldName "U"; + interpolation switch1; + gradPInterpolationType "type1" + useAddedMass scalar1; + suppressProbe switch2; + treatForceExplicit switch3; + treatForceDEM switch4; + }; + +* *pressure* = name of the finite volume fluid pressure field +* *U* = name of the finite volume fluid velocity field +* *switch1* = flag to use interpolated pressure values (normally off) +* *type1* = (optional, default cellPointFace) interpolation type for grad(p) field +* *useAddedMass* = (optional) coefficient of added mass accounted for +* *switch2* = (optional, default false) can be used to suppress the output of the probe model +* *switch3* = (optional, default true) sub model switch, see :doc:`forceSubModel ` for details +* *switch4* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + gradPForce; + ); + gradPForceProps + { + pFieldName "p"; + velocityFieldName "U"; + interpolation true; + } + +Description +""""""""""" + +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). + +Restrictions +"""""""""""" + + +none. + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_noDrag.txt b/doc/_build/html/_sources/forceModel_noDrag.txt new file mode 100644 index 0000000..81dac8d --- /dev/null +++ b/doc/_build/html/_sources/forceModel_noDrag.txt @@ -0,0 +1,67 @@ +.. index:: forceModel_noDrag + +forceModel_noDrag command +========================= + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + noDrag + ); + +noDragProps +{ + noDEMForce "switch1"; + keepCFDForce "switch2"; + treatForceExplicit "switch3"; +} + +* *switch1* = (optional, default false) do not apply the previously calculated forces in DEM integration +* *switch2* = (optional, default false) do not delete the previously calculated forces and use them in CFD source terms +* *switch3* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + noDrag + ); + +.. parsed-literal:: + + noDragProps + { + noDEMForce true; + keepCFDForce false; + }; + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + + +None. + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_particleCellVolume.txt b/doc/_build/html/_sources/forceModel_particleCellVolume.txt new file mode 100644 index 0000000..b66e94a --- /dev/null +++ b/doc/_build/html/_sources/forceModel_particleCellVolume.txt @@ -0,0 +1,69 @@ +.. index:: forceModel_particleCellVolume + +forceModel_particleCellVolume command +===================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + particleCellVolume + ); + particleCellVolumeProps + { + verbose switch1; + writeToFile switch2; + startTime number1; + upperThreshold number2; + lowerThreshold number3; + verbose; + }; + +* *switch1* = (optional, default true) switch for output to screen +* *switch2* = (optional, default false) switch for output to file +* *number1* = (optional, default 0) start time of volume calculation and output +* *number2* = only cells with a field value (magnitude) lower than this upper threshold are considered +* *number3* = only cells with a field value (magnitude) greater than this lower threshold are considered + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + particleCellVolume + ); + particleCellVolumeProps + { + upperThreshold 0.999; + lowerThreshold 0; + } + +Description +""""""""""" + +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. +At "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. + +Restrictions +"""""""""""" + + +None. + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_particleVolume.txt b/doc/_build/html/_sources/forceModel_particleVolume.txt new file mode 100644 index 0000000..0ab13b5 --- /dev/null +++ b/doc/_build/html/_sources/forceModel_particleVolume.txt @@ -0,0 +1,64 @@ +.. index:: forceModel_particleVolume + +forceModel_particleVolume command +================================= + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + particleVolume + ); + particleVolumeProps + { + verbose switch1; + writeToFile switch2; + scale scalar1; + startTime scalar2; + }; + +* *switch1* = (optional, default false) switch for output to screen +* *switch2* = (optional, default true) switch for output to file +* *scalar1* = (optional, default 1) scaling of the particle volume d=dSphere/scale +* *scalar2* = (optional, default 0) start time of volume calculation and output + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + particleVolume + ); + particleVolumeProps + { + writeToFile false; + } + +Description +""""""""""" + +This "forceModel" does not influence the particles or the simulation - it is a postprocessing tool! The total volume of the particles is calculated. + +Restrictions +"""""""""""" + + +None. + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_scalarGeneralExchange.txt b/doc/_build/html/_sources/forceModel_scalarGeneralExchange.txt new file mode 100644 index 0000000..cdff19e --- /dev/null +++ b/doc/_build/html/_sources/forceModel_scalarGeneralExchange.txt @@ -0,0 +1,192 @@ +.. index:: forceModel_scalarGeneralExchange + +forceModel_scalarGeneralExchange command +======================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + scalarGeneralExchange // must be 2nd position! + ); + scalarGeneralExchangeProps + { + useLiMason "switch1"; //default: DeenEtAl + useGeneralCorrelation "switch3"; //default: DeenEtAl + generalCorrelationParameters (1 2 3 4 5 6 7 8); + verbose "switch2"; + velFieldName "U"; + voidfractionFieldName "voidfraction"; + tempFieldName "T"; + partTempName "Temp"; + /* partHeatFluxName "convectiveHeatFlux"; //switch off for implicit coupling, e.g., to ParScale */ + partHeatTransCoeffName "heatTransCoeff"; + partHeatFluidName "heatFluid"; + lambda value; + Cp value1; + //Lists with information for each species FOR THE PARTICLES + //MUST be in the same order as eulerian species in 'scalarTransportProperties' + //MUST correspond to property/atom in ligghts (use 'couple/cfd/speciesConvection' to auto-generate individual fields) + partSpeciesNames + ( + speciesC + ); + partSpeciesFluxNames + ( + speciesCFlux + ); + partSpeciesTransCoeffNames + ( + speciesCTransCoeff + ); + partSpeciesFluidNames + ( + speciesCFluid + ); + DMolecular + ( + value2 + ); + interpolation "bool1"; + voidfractionInterpolationType "type1" + UInterpolationType "type2" + fluidScalarFieldInterpolationType "type2" + scalarViscosity switch5; + nu scalar5; + suppressProbe switch6; + scale scalar6; + maxSource scalar7; + } + +* *switch1* = (optional) flag to use Nusselt correlations of Li and Mason (2000) +* *switch2* = (normally off) for verbose run +* *switch3* = (optional) flag to use a general Nusselt number correlation (must specify parameters of this correlation in a list called 'generalCorrelationParameters' ) +* generalCorrelationParameters = list with a predefined number of parameters (for length see src code, only read if useGeneralCorrelation is set to true) +* *U* = name of the finite volume fluid velocity field +* *voidfraction* = name of the finite volume voidfraction field +* *T* = name of the finite volume scalar temperature field +* *Temp* = name of the DEM data representing the particles temperature +* *convectiveHeatFlux* = name of the DEM data representing the particle-fluid convective heat flux +* *heatTransCoeff* = name of the DEM data representing the particle-fluid heat transfer coefficient +* *heatFluid* = name of the DEM data representing the fluid heat +* *value* = fluid thermal conductivity [W/(m*K)] +* *value1* = fluid specific heat capacity [W*s/(kg*K)] +* *speciesC* = name of the DEM data representing the transport species of the particles +* *speciesCFlux* = name of the DEM data representing the particle-fluid species flux +* *speciesCTransCoeff* = name of the DEM data representing the particle-fluid species transfer coefficient +* *speciesCFluid* = name of the DEM data representing the transport species of the fluid +* *value2* = molecular diffusion coefficient [m^2/s] +* *bool1* = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values +* *type1* = (optional, default cellPoint) interpolation type for voidfraction field +* *type2* = (optional, default cellPointFace) interpolation type for velocity field +* *type3* = (optional, default cellPoint) interpolation type for fluidScalarField field +* *switch5* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details +* *scalar5* = (optional) optional, only if switch5 is true +* *switch6* = (optional, default false) can be used to suppress the output of the probe model +* *scalar7* = (optional) scaling of particle diameter +* *scalar7* = limit maximal turbulence + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + scalarGeneralExchange // must be 2nd position! + ); + scalarGeneralExchangeProps + { + useLiMason false; //default: DeenEtAl + useGeneralCorrelation true; //default: DeenEtAl + generalCorrelationParameters + ( + 7.0 -10 5 + 1.0 0.17 + 1.33 -2.31 1.16 + ); + verbose false; + velFieldName "U"; + voidfractionFieldName "voidfraction"; + tempFieldName "T"; + partTempName "Temp"; + /* partHeatFluxName "convectiveHeatFlux"; //switch off for implicit coupling, e.g., to ParScale */ + partHeatTransCoeffName "heatTransCoeff"; + partHeatFluidName "heatFluid"; + lambda 0.0271; + Cp 1007; + //Lists with information for each species FOR THE PARTICLES + //MUST be in the same order as eulerian species in 'scalarTransportProperties' + //MUST correspond to property/atom in ligghts (use 'couple/cfd/speciesConvection' to auto-generate individual fields) + partSpeciesNames + ( + speciesC + ); + partSpeciesFluxNames + ( + speciesCFlux + ); + partSpeciesTransCoeffNames + ( + speciesCTransCoeff + ); + partSpeciesFluidNames + ( + speciesCFluid + ); + DMolecular + ( + 1e-5 + ); + } + +Description +""""""""""" + +This "forceModel" does not influence the particles or the fluid flow! +Using the particles' temperature and/or species a scalar field +representing "particle-fluid heatflux" and/or "particle-fluid speciesflux" is calculated. + +This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS +and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER). + +Two way general scalar exchange between DEM and CFD +convective heat and species transfer model. The standard model is that of +Deen, N.G. et al., Review of direct numerical simulation of +fluid-particle mass, momentum and heat transfer in dense gas-solid flows. +Chemical Engineering Science 116 (2014) 710-724. +This correlation is based on that of Gunn (1978). + +The switch 'useGeneralCorrelation' allows one to specify the parameters +of the Gunn correlation as a list called 'generalCorrelationParameters'. + +Alternatively, the correclation of +Li and Mason (2000), A computational investigation of transient heat +transfer in pneumatic transport of granular particles, Pow.Tech 112 +can be activated. However, this correlation is not suitable for +dense granular flows. + +WARNING: +This model REQUIRES the 'generalManual' speciesTransportModel + +Restrictions +"""""""""""" + + +Goes only with cfdemSolverPimpleImEx and cfdemSolverPisoSTM. The force model has to be the second (!!!) model in the forces list. + +Related commands +"""""""""""""""" + +:doc:`forceModel ` :doc:`forceModel_LaEuScalarTemp ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_virtualMassForce.txt b/doc/_build/html/_sources/forceModel_virtualMassForce.txt new file mode 100644 index 0000000..db78404 --- /dev/null +++ b/doc/_build/html/_sources/forceModel_virtualMassForce.txt @@ -0,0 +1,74 @@ +.. index:: forceModel_virtualMassForce + +forceModel_virtualMassForce command +=================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + virtualMassForce + ); + virtualMassForceProps + { + velFieldName "U"; + phiFieldName "phi"; + splitUrelCalculation switch1; + Cadd scalar1; + treatForceExplicit switch2; + treatForceDEM switch3; + interpolation switch4; + UInterpolationType "type1" + DDtUInterpolationType "type2" + }; + +* *U* = name of the finite volume fluid velocity field +* *phi* = name of the finite volume flux field +* *switch1* = indicator to split calculation of Urel between CFDEM and LIGGGHTS +* *scalar1* = scalar value +* *switch2* = (optional, default true) sub model switch, see :doc:`forceSubModel ` for details +* *switch3* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details +* *switch4* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details +* *type1* = (optional, default cellPointFace) interpolation type for U field +* *type2* = (optional, default cellPointFace) interpolation type for ddt(U) field + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + virtualMassForce + ); + virtualMassForceProps + { + velFieldName "U"; + } + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + + +Model not validated! + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_viscForce.txt b/doc/_build/html/_sources/forceModel_viscForce.txt new file mode 100644 index 0000000..d29a85d --- /dev/null +++ b/doc/_build/html/_sources/forceModel_viscForce.txt @@ -0,0 +1,74 @@ +.. index:: forceModel_viscForce + +forceModel_viscForce command +============================ + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + viscForce; + ); + viscForceProps + { + velocityFieldName "U"; + useAddedMass scalar1; + suppressProbe switch1; + treatForceExplicit switch2; + treatForceDEM switch3; + interpolation switch4; + divTauInterpolationType "type1"; + scalarViscosity switch5; + nu scalar2; + }; + +* *U* = name of the finite volume fluid velocity field +* *scalar1* = (optional) coefficient of added mass accounted for +* *switch1* = (optional, default false) can be used to suppress the output of the probe model +* *switch2* = (optional, default true) sub model switch, see :doc:`forceSubModel ` for details +* *switch3* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details +* *switch4* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details +* *type1* = (optional, default cellPointFace) interpolation type for div(Tau) field +* *switch5* = (optional, default false) sub model switch, see :doc:`forceSubModel ` for details +* *scalar2* = optional, only if switch5 is true + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + viscForce; + ); + viscForceProps + { + velocityFieldName "U"; + } + +Description +""""""""""" + +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). + +Restrictions +"""""""""""" + + +none. + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceModel_volWeightedAverage.txt b/doc/_build/html/_sources/forceModel_volWeightedAverage.txt new file mode 100644 index 0000000..07199ca --- /dev/null +++ b/doc/_build/html/_sources/forceModel_volWeightedAverage.txt @@ -0,0 +1,91 @@ +.. index:: forceModel_volWeightedAverage + +forceModel_volWeightedAverage command +===================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + ( + volWeightedAverage + ); + volWeightedAverageProps + { + startTime time; + scalarFieldNames + ( + scalarField + ); + vectorFieldNames + ( + vectorField + ); + upperThreshold scalar1; + lowerThreshold scalar2; + useVolumeFraction switch0; + volumeFractionName word1; + verbose ; + writeToFile switch1; + }; + +* *time* = (optional, default 0.) time to start the averaging +* *scalarField* = names of the finite volume scalar fields to be temporally averaged +* *vectorField* = names of the finite volume vector fields to be temporally averaged +* *scalar1* = only cells with a field value (magnitude) lower than this upper threshold are considered +* *scalar2* = only cells with a field value (magnitude) greater than this lower threshold are considered +* *switch0* = (optional, default false) consider a volume fraction for the calculation +* *word1* = (optional, default "voidfraction") name of the volume fraction, only used if useVolumeFraction is true +* *verbose* = (optional, default false) keyword only (mostly used for debugging) +* *switch1* = (optional, default false) switch for the output. + + +Examples +"""""""" + +.. parsed-literal:: + + forceModels + ( + volWeightedAverage + ); + volWeightedAverageProps + { + startTime 0.1; + scalarFieldNames + ( + voidfraction + ); + vectorFieldNames + ( + ); + upperThreshold 0.999; + lowerThreshold 0; + } + +Description +""""""""""" + +This "forceModel" does not influence the particles or the simulation - it is a postprocessing tool! Starting at start time +the volume weighted averages of those cells of the fields within the threshold are calculated. +At "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. + +Restrictions +"""""""""""" + + +Currently all fields have the same threshold value! + +Related commands +"""""""""""""""" + +:doc:`forceModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceSubModel.txt b/doc/_build/html/_sources/forceSubModel.txt new file mode 100644 index 0000000..e91fb8b --- /dev/null +++ b/doc/_build/html/_sources/forceSubModel.txt @@ -0,0 +1,77 @@ +.. index:: forceSubModel + +forceSubModel command +===================== + +Syntax +"""""" + +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. + +.. parsed-literal:: + + forceSubModels + ( + model_x + model_y + ); + +* model = name of force sub-model to be applied + +Examples +"""""""" + +.. parsed-literal:: + + forceSubModels + ( + ImEx + ); + +Note: This examples list might not be complete - please look for other models (forceSubModel_XY) in this documentation. + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + + +None. + +Related commands +"""""""""""""""" + +:doc:`ImEx ` + +Note: This examples list may be incomplete - please look for other models (forceSubModel_XY) in this documentation. + +**Default:** none. + +**Swtiches:** + +* Depending on the availability within the respective force model, a number of switches can be activated: +* treatForceExplicit: switch for the purely explicit consideration of the force term in the equation of motion on the CFD side (if switched off, the force is considered semi-implicitly) + +* treatForceDEM: switch for the consideration of the forces on the DEM side only + +* implForceDEM: 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 not within a coupling interval. + +* verbose: switch for debug output to screen + +* interpolation: 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. + +* useFilteredDragModel: switch for using a coarse-grid version of the Beetstra drag model (takes grid-size effects into account; default = off) + +* useParcelSizeDependentFilteredDrag: 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) + +* implForceDEMaccumulated: 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. + +* scalarViscosity: 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. + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/forceSubModel_ImEx.txt b/doc/_build/html/_sources/forceSubModel_ImEx.txt new file mode 100644 index 0000000..f02ccce --- /dev/null +++ b/doc/_build/html/_sources/forceSubModel_ImEx.txt @@ -0,0 +1,48 @@ +.. index:: forceSubModel_ImEx + +forceSubModel_ImEx command +========================== + +Syntax +"""""" + +Defined in couplingProperties sub-dictionary of the force model in use. + +forceSubModels +( + ImEx; +); + +treatExplicit true; // optional for some force models. +treatDEM true; // optional for some force models. +implDEM true; // optional for some force models. + +Examples +"""""""" + +forceSubModels +( + ImEx; +); +treatExplicit true; // optional for some force models. + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + + +none. + +Related commands +"""""""""""""""" + +:doc:`forceSubModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/githubAccess_public.txt b/doc/_build/html/_sources/githubAccess_public.txt new file mode 100644 index 0000000..fe11d6f --- /dev/null +++ b/doc/_build/html/_sources/githubAccess_public.txt @@ -0,0 +1,317 @@ +githubAccess_public +=================== + + +---------- + + +Description +""""""""""" + +This routine describes how to pull repositories of the CFDEM(R)project from `github.com `_. +After setting some environment variables, LIGGGHTS(R) and CFDEM(R)coupling can be compiled. + +**Procedure:** + +Basically the following steps have to be performed: + +* *git clone* and setup OpenFOAM +* *git clone* the desired repositories +* update your repositories by *git pull* +* set environment variables +* compile LIGGGHTS(R) and CFDEM(R)coupling +* run your own cases + + +***git clone* and setup OpenFOAM:** + +Have a look at the latest compatible OpenFOAM(R)-version in the versionInfo.H file at `github `_. +This file will later be downloaded as a part of the source-code. +Look for the git commit hashtag in the following line: + +.. parsed-literal:: + + word OFversion="<OF-Release>-commit-<commitHashtag>"; + +.. parsed-literal:: + + e.g. word OFversion="2.4.x-commit-3d8da0e960c717ff582f1517a27724144f086b83"; + +However sometimes even newer versions are supported, please check the `release notes `_ and the "Advanced Settings"-section. + +Basically follow the OpenFOAM(R) git compilation `instructions `_, with a small number of exceptions: + +When you git clone the repository, replace the release-version with <OF-Release>. + +with git-protocol: + +.. parsed-literal:: + + git clone git://github.com/OpenFOAM/OpenFOAM-<OF-Release>.git + +or with https: + +.. parsed-literal:: + + git clone https://github.com/OpenFOAM/OpenFOAM-<OF-Release>.git + +Now change into the new directory and checkout the correct compatible version: + +.. parsed-literal:: + + cd OpenFOAM-<OF-Release> + git checkout <commitHashtag> + +The result will be a status report, that indicates a 'detached head state'. +Now continue with installing and compiling OpenFOAM(R). +Make sure that OpenFOAM(R) works properly with a parallel Simulation! + +If you want to use an older OpenFOAM(R)-version, please have a look at the "Backwards Compatibility"-section. + +***git clone* the desired repositories:** + +You may want to take a look around on CFDEMproject on github: github.com/CFDEMproject_gitCFDEM + +If not already done, open a terminal and create a directory for LIGGGHTS(R) in $HOME: + +.. parsed-literal:: + + cd + mkdir LIGGGHTS + cd LIGGGHTS + +To clone the public LIGGGHTS repository, open a terminal and execute: +with git-protocol: + +.. parsed-literal:: + + git clone git://github.com/CFDEMproject/LIGGGHTS-PUBLIC.git LIGGGHTS-PUBLIC + +or with https: + +.. parsed-literal:: + + git clone https://github.com/CFDEMproject/LIGGGHTS-PUBLIC.git LIGGGHTS-PUBLIC + +If not already done, open a terminal and create a directory for CFDEM(R)coupling in $HOME: + +.. parsed-literal:: + + cd + mkdir CFDEM + cd CFDEM + +To clone the public CFDEM(R)coupling repository, open a terminal and execute: +with git-protocol: + +.. parsed-literal:: + + git clone git://github.com/CFDEMproject/CFDEMcoupling-PUBLIC.git CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION + +or with https: + +.. parsed-literal:: + + git clone https://github.com/CFDEMcoupling-PUBLIC.git CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION + +.. parsed-literal:: + + Additionally the lpp tool for converting LIGGGHTS dump-files into the paraview readable VTK-format might be of use: + with git-protocol: + git clone git://github.com:CFDEMproject/LPP.git $HOME/LIGGGHTS/mylpp + +.. parsed-literal:: + + or with https: + git clone https://github.com:CFDEMproject/LPP.git $HOME/LIGGGHTS/mylpp + +Please have a look at README and INSTALL.txt in the root directory of LPP for further information. + +Troubles? See Troubleshooting git section below. + +**Update your repositories by *git pull*:** + +To get the latest version, open a terminal, go to the location of your local installation and type: +*Warning: git stash will remove your changes in $HOME/CFDEM/CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION !* + +.. parsed-literal:: + + cd $HOME/CFDEM/CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION + git stash + git pull + +**Set Environment Variables:** + +Now you need to set some environment variables in ~/.bashrc (if you use c-shell, manipulate ~/.cshrc accordingly). Open ~/.bashrc + +.. parsed-literal:: + + gedit ~/.bashrc & + +add the lines (you find them also in CFDEMCoupling-$WM_PROJECT_VERSION/src/lagrangian/cfdemParticle/etc/bashrc and cshrc respectively): + +.. parsed-literal:: + + #================================================# + #- source cfdem env vars + export CFDEM_VERSION=PUBLIC + export CFDEM_PROJECT_DIR=$HOME/CFDEM/CFDEMcoupling-$CFDEM_VERSION-$WM_PROJECT_VERSION + export CFDEM_SRC_DIR=$CFDEM_PROJECT_DIR/src + export CFDEM_SOLVER_DIR=$CFDEM_PROJECT_DIR/applications/solvers + export CFDEM_DOC_DIR=$CFDEM_PROJECT_DIR/doc + export CFDEM_UT_DIR=$CFDEM_PROJECT_DIR/applications/utilities + export CFDEM_TUT_DIR=$CFDEM_PROJECT_DIR/tutorials + export CFDEM_PROJECT_USER_DIR=$HOME/CFDEM/$LOGNAME-$CFDEM_VERSION-$WM_PROJECT_VERSION + export CFDEM_bashrc=$CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/bashrc + export CFDEM_LIGGGHTS_SRC_DIR=$HOME/LIGGGHTS/LIGGGHTS-PUBLIC/src + export CFDEM_LIGGGHTS_MAKEFILE_NAME=fedora_fpic + export CFDEM_LPP_DIR=$HOME/LIGGGHTS/mylpp/src + export CFDEM_PIZZA_DIR=$HOME/LIGGGHTS/PIZZA/gran_pizza_17Aug10/src + . $CFDEM_bashrc + #================================================# + +If you installed LIGGGHTS(R) or CFDEM(R)coupling in non-standard paths, please have a look at least at CFDEM_PROJECT_DIR and CFDEM_LIGGGHTS_SRC_DIR. +The standard CFDEM_LIGGGHTS_MAKEFILE_NAME is fedora_fpic, which works on most systems. However please checkout LIGGGHTS-PUBLIC/src/MAKE for additional makefiles, wich are available. The most used ones are fedora_fpic and ubuntuVTK_fpic. Beware that the CFDEMcoupling needs a fpic compilation to use LIGGGHTS as a library. Please check the "Advanced Settings" for VTK information. + +Save the ~/.bashrc, open a new terminal and test the settings. The commands: + +.. parsed-literal:: + + $CFDEM_PROJECT_DIR + $CFDEM_SRC_DIR + $CFDEM_LIGGGHTS_SRC_DIR + +should give "...: is a directory" otherwise something went wrong and the environment variables in ~/.bashrc are not set correctly. + +To specify the paths of pizza, please check the settings in $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/bashrc. + +If $CFDEM_SRC_DIR is set correctly, you can type + +.. parsed-literal:: + + cfdemSysTest + +to get some information if the paths are set correctly. + +**Compile LIGGGHTS(R) and CFDEM(R)coupling:** + +If above settings were done correctly, you can compile LIGGGHTS(R) by typing: + +.. parsed-literal:: + + cfdemCompLIG + +and you can then compile CFDEM(R)coupling by typing: + +.. parsed-literal:: + + cfdemCompCFDEM + +or compile both at once with: + +.. parsed-literal:: + + cfdemCompCFDEMall + +You can run the tutorial cases by executing .../etc/testTutorial.sh through the alias *cfdemTestTUT*. +Alternatively you can run each tutorial using the *Allrun.sh* scripts in the tutorial directories. + +In case questions concerning the installation arise, please feel free to contact our forum at www.cfdem.com. + +**Run Your Own Cases:** + +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. +Changes in $CFDEM_TUT_DIR will be lost after every *git stash*! + +**Additional Installations:** + +Optionally you can install lpp which will help you convert the DEM (dump) data to VTK format. For standard CFD-DEM runs this will not be necessary. To get the DEM postprocessing tool "lpp" you need python-numpy package installed: + +.. parsed-literal:: + + sudo apt-get install python-numpy + +You can pull the latest version of lpp with: + +.. parsed-literal:: + + cd $HOME/LIGGGHTS + +with git-protocol: +git clone git://github.com/CFDEMproject/LPP.git +with https: +git clone https://github.com/CFDEMproject/LPP.git + +**Backwards Compatibility:** + +Basically CFDEM(R)coupling supports one OpenFOAM(R) version therefore all settings are prepared for that. Nevertheless we try to maintain backwards compatibility as long as it works with reasonable effort. + +The supported OpenFOAM(R) and LIGGGHTS(R) versions are stated in: +src/lagrangian/cfdemParticle/cfdTools/versionInfo.H + +For using other versions you can manipulate: +src/lagrangian/cfdemParticle/etc/OFversion/OFversion.H +(still not all functionality might work then!) + +**Advanced Settings:** + +Here some advanced settings and hints for non-standard compilations are presented. +As stated in the "Backwards Compatibility"-section, there are compiler flags for different OpenFOAM versions. Checkout src/lagrangian/cfdemParticle/etc/OFversion/OFversion.H for compatibility settings. Just comment the current "#define version2X" in the top-section and uncomment the one you want to compile it with. + +There are advanced compilation settings for library-paths, includes and libraries are within the additionalLibs file in src/lagrangian/cfdemParticle/etc/additionalLibs. There are predefined files for different OpenFOAM versions. To use a different version, add the following lines to your .bashrc (.cshrc) before the standard CFDEM variables: + +.. parsed-literal:: + + export CFDEM_ADD_LIBS_DIR=FOLDER_OF_NEW_additionalLibs_FILE/ + +.. parsed-literal:: + + export CFDEM_ADD_LIBS_NAME=additionalLibs30x + +This is an example to use a predefined additionalLibs file for OpenFOAM-3.0.x. + +To enable direct VTK-dump (dump custom/vtk) support of LIGGGHTS and CFDEMcoupling, you have to install the VTK libraries. Either 5.8 or 6 are predefined for ubuntu. + +.. parsed-literal:: + + sudo apt-get libvtk5.8 libvtk5-dev + +Change "export CFDEM_LIGGGHTS_MAKEFILE_NAME=fedora_fpic" in your .bashrc according to your preferred LIGGGHTS makefile. +If you have a non-standard installation location you have to adapt the LIGGGHTS makefile accordingly. +To enable this feature in a coupled run the additionalLibs file has to be modified. +It basically needs to include the same libraries as the LIGGGHTS-Makefile. +E.g. for Ubuntu-14.04 with vtk-5.8: + +.. parsed-literal:: + + CFDEM_ADD_LIB_PATHS = -L/usr/include/vtk-5.8 + +.. parsed-literal:: + + CFDEM_ADD_LIBS = -lvtkCommon -lvtkFiltering -lvtkIO + +**Troubleshooting git:** + +* Troubles with git clone? + + +**a)** The git protocol will not work if your computer is behind a firewall which blocks the relevant TCP port, you can use alternatively https instead of git (write command in one line): + +git clone https://github.com/CFDEMproject/CFDEMcoupling-PUBLIC.git CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION + +**b)** If you face the error: "error: SSL certificate problem, verify that the CA cert is OK. Details: error:14090086:SSL routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed while accessing https://github.com/...", + +please use: env GIT_SSL_NO_VERIFY=true git clone https://github... + +(see http://stackoverflow.com/questions/3777075/https-github-access) + +**c)** If you face the error: "Agent admitted failure to sign using the key. Permission denied (publickey).", after ssh -T git@github.com + +please type: "ssh-add" + +(see: https://help.github.com/articles/error-agent-admitted-failure-to-sign) + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/liggghtsCommandModel.txt b/doc/_build/html/_sources/liggghtsCommandModel.txt new file mode 100644 index 0000000..d4826f3 --- /dev/null +++ b/doc/_build/html/_sources/liggghtsCommandModel.txt @@ -0,0 +1,50 @@ +.. index:: liggghtsCommandModel + +liggghtsCommandModel command +============================ + +Syntax +"""""" + +Defined in liggghtsCommmands dictionary. + +.. parsed-literal:: + + liggghtsCommandModels + ( + model_x + model_y + ); + +* model = name of the liggghtsCommandModel to be applied + +Examples +"""""""" + +.. parsed-literal:: + + liggghtsCommandModels + ( + runLiggghts + writeLiggghts + ); + +Note: This examples list might not be complete - please look for other models (liggghtsCommandModel_XY) in this documentation. + +Description +""""""""""" + +The liggghtsCommandModel is the base class to execute DEM commands within a CFD run. + +Restrictions +"""""""""""" + + +Works only with MPI coupling. + +**Default:** none. + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/liggghtsCommandModel_execute.txt b/doc/_build/html/_sources/liggghtsCommandModel_execute.txt new file mode 100644 index 0000000..6b088dc --- /dev/null +++ b/doc/_build/html/_sources/liggghtsCommandModel_execute.txt @@ -0,0 +1,99 @@ +.. index:: liggghtsCommandModel_execute + +liggghtsCommandModel_execute command +==================================== + +Syntax +"""""" + +Defined in liggghtsCommmands dictionary. + +.. parsed-literal:: + + liggghtsCommandModels + ( + execute + ); + executeProps0 + { + command + ( + run + $couplingInterval + ); + runFirst switch1; + runLast switch2; + runEveryCouplingStep switch3; + runEveryWriteStep switch4; + verbose; + } + +* *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) +* *switch1* = switch (choose on/off) if the command is executed only at first time step +* *switch2* = switch (choose on/off) if the command is executed only at last time step +* *switch3* = switch (choose on/off) if the command is executed at every coupling step +* *switch4* = switch (choose on/off) if the command is executed at every writing step +* *verbose* = (normally off) for verbose run + + +Examples +"""""""" + +.. parsed-literal:: + + liggghtsCommandModels + ( + execute + execute + ); + executeProps0 + { + command + ( + run + $couplingInterval + ); + runFirst off; + runLast off; + runEveryCouplingStep on; + } + executeProps1 + { + command + ( + write_restart + noBlanks + dotdot + slash + DEM + slash + liggghts.restart_ + timeStamp + ); + runFirst off; + runLast off; + runEveryCouplingStep off; + runEveryWriteStep on; + } + +Description +""""""""""" + +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. + +These rather complex execute commands can be replaced by the "readLiggghts" and "writeLiggghts" commands! +--------------------------------------------------------------------------------------------------------- + +Restrictions +"""""""""""" + None. + +Related commands +"""""""""""""""" + +:doc:`liggghtsCommandModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/liggghtsCommandModel_readLiggghtsData.txt b/doc/_build/html/_sources/liggghtsCommandModel_readLiggghtsData.txt new file mode 100644 index 0000000..aa20287 --- /dev/null +++ b/doc/_build/html/_sources/liggghtsCommandModel_readLiggghtsData.txt @@ -0,0 +1,91 @@ +.. index:: liggghtsCommandModel_readLiggghtsData + +liggghtsCommandModel_readLiggghtsData command +============================================= + +Syntax +"""""" + +Defined in liggghtsCommmands dictionary. + +.. parsed-literal:: + + liggghtsCommandModels + ( + readLiggghtsData + ); + readLiggghtsDataProps0 + { + startIndex "scalar1"; + verbose ; + exactTiming ; + filePath + ( + "word" + ); + runFirst "bool1"; + runEveryCouplingStep "bool2"; + startTime "scalar2"; + endTime "scalar3"; + timeInterval "scalar4"; + } + +* *scalar1* = start index of data file to be read +* *verbose* = (default off) flag for verbose run +* *exactTiming* = flag indicating that start time should be kept even during a coupling interval +* *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) +* *bool1* = true if to be run at first timestep only (prio 1) +* *bool2* = true if to be run at every coupling step (prio 2) +* *scalar2* = if bool2 and bool3 false then starts at scalar2 (prio 3) run +* *scalar3* = if bool2 and bool3 false then it ends at scalar3 (prio 3) run +* *scalar4* = if bool2 and bool3 false then it repeats at scalar3 increasing the data file index (prio 3) run + + +Examples +"""""""" + +.. parsed-literal:: + + liggghtsCommandModels + ( + readLiggghtsData + ); + readLiggghtsDataProps0 + { + startIndex 0; + exactTiming true; + filePath + ( + dotdot + slash + DEM + slash + packing.data + ); + runFirst off; + runEveryCouplingStep off; + startTime 0.002; + endTime 0.012; + timeInterval 0.001; + } + +Description +""""""""""" + +The readLiggghtsData liggghtsCommand Model can be used to read liggghts data files into liggghts during runtime of a coupled simulation. + +Restrictions +"""""""""""" + + +Note: Model is not up to date. + +Related commands +"""""""""""""""" + +:doc:`liggghtsCommandModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/liggghtsCommandModel_runLiggghts.txt b/doc/_build/html/_sources/liggghtsCommandModel_runLiggghts.txt new file mode 100644 index 0000000..90f2c82 --- /dev/null +++ b/doc/_build/html/_sources/liggghtsCommandModel_runLiggghts.txt @@ -0,0 +1,51 @@ +.. index:: liggghtsCommandModel_runLiggghts + +liggghtsCommandModel_runLiggghts command +======================================== + +Syntax +"""""" + +Defined in liggghtsCommmands dictionary. + +.. parsed-literal:: + + liggghtsCommandModels + ( + runLiggghts + ); + //- optional + runLiggghtsProps + { + preNo true; + verbose; (optional) + } + +Examples +"""""""" + +.. parsed-literal:: + + liggghtsCommandModels + ( + runLiggghts + ); + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + Warning: the "pre no" option can cause troubles (dump data of particles changing the domain might be erroneous)! + +Related commands +"""""""""""""""" + +:doc:`liggghtsCommandModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/liggghtsCommandModel_setDEMGravity.txt b/doc/_build/html/_sources/liggghtsCommandModel_setDEMGravity.txt new file mode 100644 index 0000000..8ff2a76 --- /dev/null +++ b/doc/_build/html/_sources/liggghtsCommandModel_setDEMGravity.txt @@ -0,0 +1,70 @@ +.. index:: liggghtsCommandModel_setDEMGravity + +liggghtsCommandModel_setDEMGravity command +========================================== + +Syntax +"""""" + +Defined in liggghtsCommmands dictionary. + +liggghtsCommandModels +( + setDEMGravity +); + +.. parsed-literal:: + + setDEMGravityProps0 + { + runFirst switch1; + startTime scalar1; + endTime scalar2; + timeInterval scalar3; + verbose; + } + +* *switch1* = switch (must be on!!!) to select if executed only first step. +* *scalar1* = start time of command (use simulation start time) +* *scalar2* = end time of command (use simulation start time) +* *scalar3* = time interval of command (use 1.) + *verbose* = (normally off) for verbose run + + +Examples +"""""""" + +.. parsed-literal:: + + liggghtsCommandModels + ( + runLiggghts + setDEMGravity + ); + setDEMGravityProps1 + { + runFirst on; + startTime 0; + endTime 0; + timeInterval 1; + verbose; + } + +Description +""""""""""" + +The liggghtsCommand models can be used to set LIGGGHTS gravity during a CFD run. + +Restrictions +"""""""""""" + None. + +Related commands +"""""""""""""""" + +:doc:`liggghtsCommandModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/liggghtsCommandModel_writeLiggghts.txt b/doc/_build/html/_sources/liggghtsCommandModel_writeLiggghts.txt new file mode 100644 index 0000000..9ecbc6f --- /dev/null +++ b/doc/_build/html/_sources/liggghtsCommandModel_writeLiggghts.txt @@ -0,0 +1,62 @@ +.. index:: liggghtsCommandModel_writeLiggghts + +liggghtsCommandModel_writeLiggghts command +========================================== + +Syntax +"""""" + +Defined in liggghtsCommmands dictionary. + +.. parsed-literal:: + + liggghtsCommandModels + ( + writeLiggghts + ); + //- optional + writeLiggghtsProps + { + writeLast switch1; + path "path"; + writeName "name"; + overwrite switch2; + verbose; + } + +* *switch1* = switch (choose on/off) to select if only last step is stored or every write step (default on). +* *path* = optionally an alternative path (relative to execution directory) for saving the restart file can be defined (default "../DEM"). +* *name* = name of the restart file to be written in /$caseDir/DEM/ default (default "liggghts.restartCFDEM") +* *switch2* = switch (choose on/off) to select if only one restart file $name or many files $name_$timeStamp are written (default off) + *verbose* = (default off) for verbose run + + +Examples +"""""""" + +.. parsed-literal:: + + liggghtsCommandModels + ( + runLiggghts + writeLiggghts + ); + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + None. + +Related commands +"""""""""""""""" + +:doc:`liggghtsCommandModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/locateModel.txt b/doc/_build/html/_sources/locateModel.txt new file mode 100644 index 0000000..05dac3b --- /dev/null +++ b/doc/_build/html/_sources/locateModel.txt @@ -0,0 +1,40 @@ +.. index:: locateModel + +locateModel command +=================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + locateModel model; + +* model = name of the locateModel to be applied + +Examples +"""""""" + +.. parsed-literal:: + + locateModel engine; + +Note: This examples list might not be complete - please look for other models (locateModel_XY) in this documentation. + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + none. + +**Default:** none. + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/locateModel_engineSearch.txt b/doc/_build/html/_sources/locateModel_engineSearch.txt new file mode 100644 index 0000000..48d60bf --- /dev/null +++ b/doc/_build/html/_sources/locateModel_engineSearch.txt @@ -0,0 +1,55 @@ +.. index:: locateModel_engineSearch + +locateModel_engineSearch command +================================ + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + locateModel engine; + engineProps + { + treeSearch switch1; + } + +* *switch1* = (optional, default true) switch to use tree search algorithm + + +Examples +"""""""" + +.. parsed-literal:: + + locateModel engine; + engineProps + { + treeSearch true; + } + +Description +""""""""""" + +The locateModel "engine" locates the CFD cell and cellID corresponding to a given position. +The engineSearch locate model can be used with different settings to use different algorithms: + +* treeSearch false; will execute some geometric (linear) search using the last known cellID +* treeSearch true; will use a recursive tree structure to find the cell (recommended). + + +Restrictions +"""""""""""" + none. + +Related commands +"""""""""""""""" + +:doc:`locateModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/locateModel_engineSearchIB.txt b/doc/_build/html/_sources/locateModel_engineSearchIB.txt new file mode 100644 index 0000000..38686d4 --- /dev/null +++ b/doc/_build/html/_sources/locateModel_engineSearchIB.txt @@ -0,0 +1,68 @@ +.. index:: locateModel_engineSearchIB + +locateModel_engineSearchIB command +================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + locateModel engineIB; + engineIBProps + { + treeSearch switch1; + zSplit value1; + xySplit value2; + checkPeriodicCells; + } + +* *switch1* = names of the finite volume scalar fields to be temporally averaged +* *value1* = number of z-normal layers for satellite points +* *value2* = number of satellite points in each layer +* *checkPeriodicCells* = (optional, default false) flag for considering the minimal distance to all periodic images of this particle + + +Examples +"""""""" + +.. parsed-literal:: + + locateModel engineIB; + engineIBProps + { + treeSearch false; + zSplit 8; + xySplit 16; + } + +Description +""""""""""" + +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. + +The engineSearchIB locate Model can be used with different settings to use different algorithms: + +* treeSearch false; will execute some geometric (linear) search using the last known cellID (recommended) +* treeSearch true; will use a recursive tree structure to find the cell. + + +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. + +Restrictions +"""""""""""" + + +Only for immersed boundary solvers! + +Related commands +"""""""""""""""" + +:doc:`locateModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/locateModel_standardSearch.txt b/doc/_build/html/_sources/locateModel_standardSearch.txt new file mode 100644 index 0000000..4c9f7ee --- /dev/null +++ b/doc/_build/html/_sources/locateModel_standardSearch.txt @@ -0,0 +1,39 @@ +.. index:: locateModel_standardSearch + +locateModel_standardSearch command +================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + locateModel standard; + +Examples +"""""""" + +.. parsed-literal:: + + locateModel standard; + +Description +""""""""""" + +The locateModel "standard" locates the CFD cell and cellID corresponding to a given position. A very straight-forward (robust!) locate algorithm is used. + +Restrictions +"""""""""""" + none. + +Related commands +"""""""""""""""" + +:doc:`locateModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/meshMotionModel.txt b/doc/_build/html/_sources/meshMotionModel.txt new file mode 100644 index 0000000..52aef58 --- /dev/null +++ b/doc/_build/html/_sources/meshMotionModel.txt @@ -0,0 +1,40 @@ +.. index:: meshMotionModel + +meshMotionModel command +======================= + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + meshMotionModel model; + +* model = name of the meshMotionModel to be applied + +Examples +"""""""" + +.. parsed-literal:: + + meshMotionModel noMeshMotion; + +Note: This examples list might not be complete - please look for other models (meshMotionModel_XY) in this documentation. + +Description +""""""""""" + +The meshMotionModel is the base class for models which manipulate the CFD mesh according to the DEM mesh motion. + +Restrictions +"""""""""""" + none. + +**Default:** none. + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/meshMotionModel_noMeshMotion.txt b/doc/_build/html/_sources/meshMotionModel_noMeshMotion.txt new file mode 100644 index 0000000..8c65b83 --- /dev/null +++ b/doc/_build/html/_sources/meshMotionModel_noMeshMotion.txt @@ -0,0 +1,39 @@ +.. index:: meshMotionModel_noMeshMotion + +meshMotionModel_noMeshMotion command +==================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + meshMotionModel noMeshMotion; + +Examples +"""""""" + +.. parsed-literal:: + + meshMotionModel noMeshMotion; + +Description +""""""""""" + +The noMeshMotion-model is a dummy meshMotion model. + +Restrictions +"""""""""""" + None. + +Related commands +"""""""""""""""" + +:doc:`meshMotionModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/momCoupleModel.txt b/doc/_build/html/_sources/momCoupleModel.txt new file mode 100644 index 0000000..4a8ff24 --- /dev/null +++ b/doc/_build/html/_sources/momCoupleModel.txt @@ -0,0 +1,51 @@ +.. index:: momCoupleModel + +momCoupleModel command +====================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + momCoupleModels + ( + model + ); + +* model = name of the momCoupleModel to be applied + +Examples +"""""""" + +.. parsed-literal:: + + momCoupleModels + ( + implicitCouple + ); + +Note: This examples list might not be complete - please look for other models (momCoupleModel_XY) in this documentation. + +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. + +Note that the variable "imExSplitFactor" can be set in the couplingProperties in order to treat implicitly defined forces (in the implementation of the force model) as explicit ones. "imExSplitFactor 1.0;" is set by default, meaning that all implicit forces will be considered implicitly, whereas "imExSplitFactor 0.0;" would mean that implicitly defined forces will be treated in an explicit fashion. + +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. +Description +""""""""""" + +The momCoupleModel is the base class for momentum exchange between DEM and CFD simulation. + +Restrictions +"""""""""""" + none. + +**Default:** none. + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/momCoupleModel_explicitCouple.txt b/doc/_build/html/_sources/momCoupleModel_explicitCouple.txt new file mode 100644 index 0000000..872d186 --- /dev/null +++ b/doc/_build/html/_sources/momCoupleModel_explicitCouple.txt @@ -0,0 +1,58 @@ +.. index:: momCoupleModel_explicitCouple + +momCoupleModel_explicitCouple command +===================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + momCoupleModels + ( + explicitCouple + ); + explicitCoupleProps + { + fLimit vector; + } + +* *vector* = limiter vector for explicit force term (default (1e10,1e10,1e10) ) + + +Examples +"""""""" + +.. parsed-literal:: + + momCoupleModels + ( + explicitCouple + ); + explicitCoupleProps + { + fLimit (1e3 1e2 1e4); + } + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + + +Only for solvers that include explicit momentum exchange. + +Related commands +"""""""""""""""" + +:doc:`momCoupleModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/momCoupleModel_implicitCouple.txt b/doc/_build/html/_sources/momCoupleModel_implicitCouple.txt new file mode 100644 index 0000000..9303c79 --- /dev/null +++ b/doc/_build/html/_sources/momCoupleModel_implicitCouple.txt @@ -0,0 +1,66 @@ +.. index:: momCoupleModel_implicitCouple + +momCoupleModel_implicitCouple command +===================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + momCoupleModels + ( + implicitCouple + ); + implicitCoupleProps + { + velFieldName "U"; + granVelFieldName "Us"; + voidfractionFieldName "voidfraction"; + minAlphaP number; + } + +* *U* = name of the finite volume fluid velocity field +* *Us* = name of the finite volume granular velocity field +* *voidfraction* = name of the finite volume voidfraction field +*number* = minimum value for local particle volume fraction to calculate the exchange filed (default SMALL):l + + +Examples +"""""""" + +.. parsed-literal:: + + momCoupleModels + ( + implicitCouple + ); + implicitCoupleProps + { + velFieldName "U"; + granVelFieldName "Us"; + voidfractionFieldName "voidfraction"; + } + +Description +""""""""""" + +The implicitCouple-model is a momCoupleModel model providing an implicit momentum source term for the CFD solver. + +Restrictions +"""""""""""" + + +Only for solvers that include implicit momentum exchange. + +Related commands +"""""""""""""""" + +:doc:`momCoupleModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/momCoupleModel_noCouple.txt b/doc/_build/html/_sources/momCoupleModel_noCouple.txt new file mode 100644 index 0000000..f2d5d62 --- /dev/null +++ b/doc/_build/html/_sources/momCoupleModel_noCouple.txt @@ -0,0 +1,47 @@ +.. index:: momCoupleModel_noCouple + +momCoupleModel_noCouple command +=============================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + momCoupleModels + ( + off + ); + +Examples +"""""""" + +.. parsed-literal:: + + momCoupleModels + ( + off + ); + +Description +""""""""""" + +The noCouple-model is a dummy momCoupleModel model providing a no momentum source term for the CFD solver. + +Restrictions +"""""""""""" + + +Only for solvers that include no momentum exchange, e.g. immersed boundary. + +Related commands +"""""""""""""""" + +:doc:`momCoupleModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/probeModel.txt b/doc/_build/html/_sources/probeModel.txt new file mode 100644 index 0000000..c611471 --- /dev/null +++ b/doc/_build/html/_sources/probeModel.txt @@ -0,0 +1,52 @@ +.. index:: probeModel + +probeModel command +================== + +Syntax +"""""" + +To be activated via couplingProperties dictionary. + +.. parsed-literal:: + + probeModel myProbeModel; + +Use probe model "off" to disable this feature. + +.. parsed-literal:: + + myProbeModelProps + +.. parsed-literal:: + + { + +.. parsed-literal:: + + }; + +Examples +"""""""" + +See :doc:`particleProbe ` + +Note: This examples list might not be complete - please check below for the list of force models that can perform particle probing. + +Description +""""""""""" + +The probeModel feature allows to implement various probing features in CFDEM. Currently, only the :doc:`particleProbe ` model is implemented, that performs probing of particle forces. + +Restrictions +"""""""""""" + + +None. + +**Default:** none. + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/probeModel_noProbe.txt b/doc/_build/html/_sources/probeModel_noProbe.txt new file mode 100644 index 0000000..3aa7514 --- /dev/null +++ b/doc/_build/html/_sources/probeModel_noProbe.txt @@ -0,0 +1,51 @@ +.. index:: probeModel_noProbe + +probeModel_noProbe command +========================== + +Syntax +"""""" + +To be activated via couplingProperties dictionary. + +.. parsed-literal:: + + forceModels + { + myForceModel1 + myForceModel2 + myForceModel3 + }; + +probeModel off; + +Examples +"""""""" + +.. parsed-literal:: + + probeModel off; + +Note: This examples list might not be complete - please check below for the list of force models that can perform particle probing. + +Description +""""""""""" + +Does not perform any probing. + +Restrictions +"""""""""""" + + +None. + +**Related commands which are currently enabled for particle probing:** + +:doc:`particleProbe ` + +**Default:** none. + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/probeModel_particleProbe.txt b/doc/_build/html/_sources/probeModel_particleProbe.txt new file mode 100644 index 0000000..69c2cb0 --- /dev/null +++ b/doc/_build/html/_sources/probeModel_particleProbe.txt @@ -0,0 +1,90 @@ +.. index:: probeModel_particleProbe + +probeModel_particleProbe command +================================ + +Syntax +"""""" + +To be activated via couplingProperties dictionary. + +forceModels +( + myForceModel1 + myForceModel2 + myForceModel3 +); + +probeModel particleProbe; + +.. parsed-literal:: + + particleProbeProps + { + particleIDsToSample (ID1 ID2 ID3 ...); //list of particleIDs to sample + verboseToFile; //main switch + verbose; //currently not used + printEvery xEvery; //print every this many CFD time steps + printOnlyAtStep xStep; //print only at this CFD time step (overrides "printEvery") + sampleAll; //Activate sampling for all particles + probeDebug; //probes additional fields + includePosition; //will include particle position in the output file + writePrecision xPrecision; //number of significant digits to print + }; + +* *particleIDsToSample* = list of particle IDs to be sampled. +* *myForceModeli* = list of force models in the simulation, the particleProbe will be applied to all of these models! +* *verboseToFile* = main switch to activate the particle probe (default = off). +* *verbose* = main switch to activate output to Info (currently not implemented). +* *xEvery* = integer to specify the interval for sampling (default = 1, i.e., probing occurs every CFD time step). +* *xStep* = integer to specify the step for sampling (default = deactivated, i.e., it will print accordingly to "printEvery"). +* *sampleAll* = switch to activate sampling of all particles. Otherwise (default) only particles specified via "particleIDsToSample" in the couplingProperties dictionary will be sampled. +* *probeDebug* = switch to activate probing of debug properties of secondary importance (specific for each force model). +* *includePosition* = switch to add the particle position in the log file (default = off). +* *xPrecision*= number of significant digits of the text output (default = 3). + + +Examples +"""""""" + +.. parsed-literal:: + + particleIDsToSample (0 1 2 3); + forceModels + ( + gradPForce + ); + particleProbeProps + { + verboseToFile; //main switch + verbose; //currently not used + printEvery 100; //print every this many CFD time steps + sampleAll; //Activate sampling for all particles + probeDebug; //probes additional fields + includePosition; //will include particle position in the output file + writePrecision 4; //number of significant digits to print + }; + +Note: This examples list might not be complete - please check below for the list of force models that can perform particle probing. + +Description +""""""""""" + +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). + +Restrictions +"""""""""""" + + +You can manually switch off the probe model for each force model by specifying the Switch "suppressProbe" in the corresponding force properties dictionary. + +**Related commands which are currently enabled for particle probing:** + +:doc:`gradPForce `, :doc:`viscForce `, :doc:`BeetstraDrag `, :doc:`HollowayDrag `, :doc:`MeiLift `, as well as most other forceModels (see src directory for details, i.e., use "grep -r 'probeM(' ./" in the terminal). + +**Default:** none. + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/regionModel.txt b/doc/_build/html/_sources/regionModel.txt new file mode 100644 index 0000000..15e74c0 --- /dev/null +++ b/doc/_build/html/_sources/regionModel.txt @@ -0,0 +1,40 @@ +.. index:: regionModel + +regionModel command +=================== + +Syntax +"""""" + +Note: In the current CFDEMcoupling version, this model is no longer used. Defined in couplingProperties dictionary. + +.. parsed-literal:: + + regionModel model; + +* model = name of the regionModel to be applied + +Examples +"""""""" + +.. parsed-literal:: + + regionModel allRegion; + +Note: This examples list might not be complete - please look for other models (regionModel_XY) in this documentation. + +Description +""""""""""" + +The regionModel is the base class for region models to select a certain region for coupled simulation. + +Restrictions +"""""""""""" + none. + +**Default:** none. + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/regionModel_allRegion.txt b/doc/_build/html/_sources/regionModel_allRegion.txt new file mode 100644 index 0000000..a8db89f --- /dev/null +++ b/doc/_build/html/_sources/regionModel_allRegion.txt @@ -0,0 +1,39 @@ +.. index:: regionModel_allRegion + +regionModel_allRegion command +============================= + +Syntax +"""""" + +Note: In the current CFDEMcoupling version, this model is no longer used. Defined in couplingProperties dictionary. + +.. parsed-literal:: + + regionModel allRegion; + +Examples +"""""""" + +.. parsed-literal:: + + regionModel allRegion; + +Description +""""""""""" + +The allRegion-model is a region model including the whole CFD region for the coupling. + +Restrictions +"""""""""""" + None. + +Related commands +"""""""""""""""" + +:doc:`regionModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/scalarTransportModel.txt b/doc/_build/html/_sources/scalarTransportModel.txt new file mode 100644 index 0000000..7bdca53 --- /dev/null +++ b/doc/_build/html/_sources/scalarTransportModel.txt @@ -0,0 +1,95 @@ +.. index:: scalarTransportModel + +scalarTransportModel command +============================ + +Syntax +"""""" + +Defined in scalarTransportProperties dictionary. A variety of derived classes exist that implement different physics of the scalarTransportModel. Here, the most general one, i.e., 'generalManual' is discussed. If no scalar transport shall be used, use the model 'none'. + +.. parsed-literal:: + + generalManualProps + { + phiFieldName *phiName*; + voidfractionFieldName *voidfractionName*; + ScT *scalar1*; + PrT *scalar2*; + cpVolumetric *scalar3*; + cpVolumetricFieldName *word1*; + rhoMixFieldName *word2*; + eulerianFields + ( + *C* + *T* + ); + +.. parsed-literal:: + + } + +* *phiName* = (optional) name of the surface field for the SUPERFICIAL flux, default "phi". +* *voidfractionName* = (optional) name of the finite volume voidfraction field, default "voidfraction". +* *scalar1* = (optional, default 0.7) turbulent Schmidt Nr, set to large value to suppress turbulent species transport +* *scalar2* = (optional, default 0.7) turbulent Prandtl Nr, set to large value to suppress turbulent heat transport +* *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 +* *word1* = (optional, alternatively define scalar3) volumetric heat capacity as a field +* *word3* = mixture density field +* *C* = concentration field name +* *T* = temperature field name + + +Examples +"""""""" + +.. parsed-literal:: + + generalManualProps + { + phiFieldName "phi"; + ScT 0.7; + PrT 0.7; + cpVolumetric 1196; + rhoMixFieldName "rhoMix"; + eulerianFields + ( + C + T + ); + +.. parsed-literal:: + + fvOptionsC + { + }; + +.. parsed-literal:: + + fvOptionsT + { + }; + +.. parsed-literal:: + + } + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + +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. + +Related commands +"""""""""""""""" + +none. + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/smoothingModel.txt b/doc/_build/html/_sources/smoothingModel.txt new file mode 100644 index 0000000..8709519 --- /dev/null +++ b/doc/_build/html/_sources/smoothingModel.txt @@ -0,0 +1,50 @@ +.. index:: smoothingModel + +smoothingModel command +====================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + smoothingModel model; + +* model = name of the smoothingModel to be applied + +Examples +"""""""" + +.. parsed-literal:: + + smoothingModel off; + +.. parsed-literal:: + + smoothingModel constDiffSmoothing; + +.. parsed-literal:: + + smoothingModel localPSizeDiffSmoothing; + +Note: This examples list might not be complete - please look for other models (smoothingModel_XY) in this documentation. + +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. + +Description +""""""""""" + +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). + +Restrictions +"""""""""""" + These models are in beta testing. + +**Default:** none. + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/smoothingModel_constDiffSmoothing.txt b/doc/_build/html/_sources/smoothingModel_constDiffSmoothing.txt new file mode 100644 index 0000000..e5c7e3b --- /dev/null +++ b/doc/_build/html/_sources/smoothingModel_constDiffSmoothing.txt @@ -0,0 +1,63 @@ +.. index:: smoothingModel_constDiffSmoothing + +smoothingModel_constDiffSmoothing command +========================================= + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + smoothingModel constDiffSmoothing; + constDiffSmoothingProps + { + lowerLimit number1; + upperLimit number2; + smoothingLength lengthScale; + smoothingLengthReferenceField lengthScaleRefField; + verbose; + } + +* *number1* = scalar fields will be bound to this lower value +* *number2* = scalar fields will be bound to this upper value +* *lengthScale* = length scale over which the exchange fields will be smoothed out +* *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. +* *verbose* = (optional, default false) flag for debugging output + + +Examples +"""""""" + +.. parsed-literal:: + + constDiffSmoothingProps + { + lowerLimit 0.1; + upperLimit 1e10; + smoothingLength 1500e-6; + smoothingLengthReferenceField 9000e-6; + } + +Description +""""""""""" + +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. +Smoothing 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. + +Restrictions +"""""""""""" + This model is tested in a limited number of flow situations. + +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. + +Related commands +"""""""""""""""" + +:doc:`smoothingModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/smoothingModel_noSmoothing.txt b/doc/_build/html/_sources/smoothingModel_noSmoothing.txt new file mode 100644 index 0000000..a312bfa --- /dev/null +++ b/doc/_build/html/_sources/smoothingModel_noSmoothing.txt @@ -0,0 +1,39 @@ +.. index:: smoothingModel_noSmoothing + +smoothingModel_noSmoothing command +================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + smoothingModel off; + +Examples +"""""""" + +.. parsed-literal:: + + smoothingModel off; + +Description +""""""""""" + +The "noSmoothing" model is a dummy smoothingModel model which does no smoothing. + +Restrictions +"""""""""""" + none. + +Related commands +"""""""""""""""" + +:doc:`smoothingModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/voidFractionModel.txt b/doc/_build/html/_sources/voidFractionModel.txt new file mode 100644 index 0000000..975ea8a --- /dev/null +++ b/doc/_build/html/_sources/voidFractionModel.txt @@ -0,0 +1,40 @@ +.. index:: voidfractionModel + +voidfractionModel command +========================= + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + voidfractionModel model; + +* model = name of the voidfractionModel to be applied + +Examples +"""""""" + +.. parsed-literal:: + + voidfractionModel centre; + +Note: This examples list might not be complete - please look for other models (voidfractionModel_XY) in this documentation. + +Description +""""""""""" + +The voidfractionModel is the base class for models to represent the DEM particle's volume in the CFD domain via a voidfraction field. + +Restrictions +"""""""""""" + none. + +**Default:** none. + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/voidFractionModel_GaussVoidFraction.txt b/doc/_build/html/_sources/voidFractionModel_GaussVoidFraction.txt new file mode 100644 index 0000000..8ee13e7 --- /dev/null +++ b/doc/_build/html/_sources/voidFractionModel_GaussVoidFraction.txt @@ -0,0 +1,63 @@ +.. index:: voidfractionModel_GaussVoidFraction + +voidfractionModel_GaussVoidFraction command +=========================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + voidfractionModel Gauss; + GaussProps + { + maxCellsPerParticle number1; + alphaMin number2; + weight number3; + porosity number4; + } + +* *number1* = maximum number of cells covered by a particle (search will fail when more than *number1* cells are covered by the particle) +* *number2* = minimum limit for voidfraction +* *number3* = (optional) scaling of the particle volume to account for porosity or agglomerations. +* *number4* = (optional) diameter of the particle's representation is artificially increased according to *number2* * Vparticle, volume remains unaltered! + + +Examples +"""""""" + +.. parsed-literal:: + + voidfractionModel Gauss; + GaussProps + { + maxCellsPerParticle 1000; + alphaMin 0.10; + weight 1.; + porosity 1.; + } + +Description +""""""""""" + +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. + +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. + +The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. + +Restrictions +"""""""""""" + none. + +Related commands +"""""""""""""""" + +:doc:`voidfractionModel ` , :doc:`bigParticle ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/voidFractionModel_IBVoidFraction.txt b/doc/_build/html/_sources/voidFractionModel_IBVoidFraction.txt new file mode 100644 index 0000000..4ca12a8 --- /dev/null +++ b/doc/_build/html/_sources/voidFractionModel_IBVoidFraction.txt @@ -0,0 +1,62 @@ +.. index:: voidfractionModel_IBVoidFraction + +voidfractionModel_IBVoidFraction command +======================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + voidfractionModel IB; + IBProps + { + maxCellsPerParticle number1; + alphaMin number2; + scaleUpVol number3; + checkPeriodicCells ; + } + +* *number1* = maximum number of cells covered by a particle (search will fail when more than *number1* cells are covered by the particle) +* *number2* = minimum limit for voidfraction +* *number3* = diameter of the particle's representation is artificially increased according to *number3* * Vparticle, volume remains unaltered! +* *checkPeriodicCells* = (optional, default false) flag for considering the minimal distance to all periodic images of this particle + + +Examples +"""""""" + +.. parsed-literal:: + + voidfractionModel IB; + IBProps + { + maxCellsPerParticle 1000; + alphaMin 0.10; + scaleUpVol 5.0; + } + +Description +""""""""""" + +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. + +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. + +Code of this sub-model contributed by Alice Hager, JKU. + +Restrictions +"""""""""""" + none. + +Related commands +"""""""""""""""" + +:doc:`voidfractionModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/voidFractionModel_bigParticleVoidFraction.txt b/doc/_build/html/_sources/voidFractionModel_bigParticleVoidFraction.txt new file mode 100644 index 0000000..5895a15 --- /dev/null +++ b/doc/_build/html/_sources/voidFractionModel_bigParticleVoidFraction.txt @@ -0,0 +1,65 @@ +.. index:: voidfractionModel_bigParticleVoidFraction + +voidfractionModel_bigParticleVoidFraction command +================================================= + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + voidfractionModel bigParticle; + bigParticleProps + { + maxCellsPerParticle number1; + alphaMin number2; + weight number3; + porosity number4; + } + +* *number1* = maximum number of cells covered by a particle (search will fail when more than *number1* cells are covered by the particle) +* *number2* = minimum limit for voidfraction +* *number3* = (optional) scaling of the particle volume to account for porosity or agglomerations. +* *number4* = (optional) diameter of the particle's representation is artificially increased according to *number2* * Vparticle, volume remains unaltered! + + +Examples +"""""""" + +.. parsed-literal:: + + voidfractionModel bigParticle; + bigParticleProps + { + maxCellsPerParticle 1000; + alphaMin 0.10; + weight 1.; + porosity 5.0; + } + +Description +""""""""""" + +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. + +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. + +The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. + +Parts of this sub-model contributed by Alice Hager, JKU. + +Restrictions +"""""""""""" + none. + +Related commands +"""""""""""""""" + +:doc:`voidfractionModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/voidFractionModel_centreVoidFraction.txt b/doc/_build/html/_sources/voidFractionModel_centreVoidFraction.txt new file mode 100644 index 0000000..e429d67 --- /dev/null +++ b/doc/_build/html/_sources/voidFractionModel_centreVoidFraction.txt @@ -0,0 +1,55 @@ +.. index:: voidfractionModel_centreVoidFraction + +voidfractionModel_centreVoidFraction command +============================================ + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + voidfractionModel centre; + centreProps + { + alphaMin number1; + weight number2; + } + +* *number1* = minimum limit for voidfraction +* *number2* = (optional) scaling of the particle volume to account for porosity or agglomerations. + + +Examples +"""""""" + +.. parsed-literal:: + + voidfractionModel centre; + centreProps + { + alphaMin 0.1; + weight 1.; + } + +Description +""""""""""" + +The centre voidFraction model calculates the voidfraction in a CFD cell accounting for the volume of the particles whose centres are inside the cell. + +The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. + +Restrictions +"""""""""""" + none. + +Related commands +"""""""""""""""" + +:doc:`voidfractionModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/voidFractionModel_dividedVoidFraction.txt b/doc/_build/html/_sources/voidFractionModel_dividedVoidFraction.txt new file mode 100644 index 0000000..2896295 --- /dev/null +++ b/doc/_build/html/_sources/voidFractionModel_dividedVoidFraction.txt @@ -0,0 +1,69 @@ +.. index:: voidfractionModel_dividedVoidFraction + +voidfractionModel_dividedVoidFraction command +============================================= + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + voidfractionModel divided; + dividedProps + { + alphaMin number1; + interpolation; + weight number2; + porosity number3; + procBoundaryCorrection Switch1; + verbose; + cfdemUseOnly; + } + +* *number1* = minimum limit for voidfraction +* *interpolation* = flag to interpolate voidfraction to particle positions (normally off) +* *number2* = (optional) scaling of the particle volume to account for porosity or agglomerations. +* *number3* = (optional) diameter of the particle's representation is artificially increased according to *number2* * Vparticle, volume remains unaltered! +* *Switch1* = (optional, default false) allow for correction at processor boundaries. This requires the use of engineIB and vice versa. +* *verbose* = (optional, default false) flag for debugging output +* *cfdemUseOnly* = optional flag, default false + + +Examples +"""""""" + +.. parsed-literal:: + + voidfractionModel divided; + dividedProps + { + alphaMin 0.2; + } + +Description +""""""""""" + +The divided voidFraction model is supposed to be used when a particle (or its representation) is in the size range of a CFD cell. Satellite points are used to divide the particle's volume to the touched cells. + +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. + +The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. + +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. +The 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. + +Restrictions +"""""""""""" + none. + +Related commands +"""""""""""""""" + +:doc:`voidfractionModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/voidFractionModel_noVoidFraction.txt b/doc/_build/html/_sources/voidFractionModel_noVoidFraction.txt new file mode 100644 index 0000000..967df09 --- /dev/null +++ b/doc/_build/html/_sources/voidFractionModel_noVoidFraction.txt @@ -0,0 +1,35 @@ +.. index:: voidfractionModel_noVoidFractionVoidFraction + +voidfractionModel_noVoidFractionVoidFraction command +==================================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +voidfractionModel noVoidFraction; + +Examples +"""""""" + +voidfractionModel noVoidFraction; + +Description +""""""""""" + +The noVoidFraction voidFraction model is a dummy model and has no physical meaning. + +Restrictions +"""""""""""" + none. + +Related commands +"""""""""""""""" + +:doc:`voidfractionModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_sources/voidFractionModel_trilinearVoidFraction.txt b/doc/_build/html/_sources/voidFractionModel_trilinearVoidFraction.txt new file mode 100644 index 0000000..7d23123 --- /dev/null +++ b/doc/_build/html/_sources/voidFractionModel_trilinearVoidFraction.txt @@ -0,0 +1,50 @@ +.. index:: voidfractionModel_trilinearVoidFraction + +voidfractionModel_trilinearVoidFraction command +=============================================== + +Syntax +"""""" + +Defined in couplingProperties dictionary. + +.. parsed-literal:: + + voidfractionModel trilinear; + trilinearProps + { + alphaMin number1; + } + +* *number1* = minimum limit for voidfraction + + +Examples +"""""""" + +.. parsed-literal:: + + voidfractionModel trilinear; + trilinearProps + { + alphaMin 0.3; + } + +Description +""""""""""" + +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. + +Restrictions +"""""""""""" + 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!!! + +Related commands +"""""""""""""""" + +:doc:`voidfractionModel ` + + +.. _liws: http://www.cfdem.com +.. _ld: Manual.html +.. _lc: Section_commands.html#comm diff --git a/doc/_build/html/_static/ajax-loader.gif b/doc/_build/html/_static/ajax-loader.gif new file mode 100644 index 0000000..61faf8c Binary files /dev/null and b/doc/_build/html/_static/ajax-loader.gif differ diff --git a/doc/_build/html/_static/basic.css b/doc/_build/html/_static/basic.css new file mode 100644 index 0000000..967e36c --- /dev/null +++ b/doc/_build/html/_static/basic.css @@ -0,0 +1,537 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox input[type="text"] { + width: 170px; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + width: 30px; +} + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable dl, table.indextable dd { + margin-top: 0; + margin-bottom: 0; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- general body styles --------------------------------------------------- */ + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.field-list ul { + padding-left: 1em; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #ffe; + width: 40%; + float: right; +} + +p.sidebar-title { + font-weight: bold; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +div.admonition dl { + margin-bottom: 0; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + border: 0; + border-collapse: collapse; +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.field-list td, table.field-list th { + border: 0 !important; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +dl { + margin-bottom: 15px; +} + +dd p { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dt:target, .highlighted { + background-color: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.optional { + font-size: 1.3em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +td.linenos pre { + padding: 5px 0px; + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + margin-left: 0.5em; +} + +table.highlighttable td { + padding: 0 0.5em 0 0.5em; +} + +tt.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +tt.descclassname { + background-color: transparent; +} + +tt.xref, a tt { + background-color: transparent; + font-weight: bold; +} + +h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/doc/_build/html/_static/comment-bright.png b/doc/_build/html/_static/comment-bright.png new file mode 100644 index 0000000..551517b Binary files /dev/null and b/doc/_build/html/_static/comment-bright.png differ diff --git a/doc/_build/html/_static/comment-close.png b/doc/_build/html/_static/comment-close.png new file mode 100644 index 0000000..09b54be Binary files /dev/null and b/doc/_build/html/_static/comment-close.png differ diff --git a/doc/_build/html/_static/comment.png b/doc/_build/html/_static/comment.png new file mode 100644 index 0000000..92feb52 Binary files /dev/null and b/doc/_build/html/_static/comment.png differ diff --git a/doc/_build/html/_static/css/badge_only.css b/doc/_build/html/_static/css/badge_only.css new file mode 100644 index 0000000..7e17fb1 --- /dev/null +++ b/doc/_build/html/_static/css/badge_only.css @@ -0,0 +1,2 @@ +.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-weight:normal;font-style:normal;src:url("../font/fontawesome_webfont.eot");src:url("../font/fontawesome_webfont.eot?#iefix") format("embedded-opentype"),url("../font/fontawesome_webfont.woff") format("woff"),url("../font/fontawesome_webfont.ttf") format("truetype"),url("../font/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:0.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;border-top:solid 10px #343131;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{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 .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}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.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}img{width:100%;height:auto}} +/*# sourceMappingURL=badge_only.css.map */ diff --git a/doc/_build/html/_static/css/badge_only.css.map b/doc/_build/html/_static/css/badge_only.css.map new file mode 100644 index 0000000..9d07b87 --- /dev/null +++ b/doc/_build/html/_static/css/badge_only.css.map @@ -0,0 +1,7 @@ +{ +"version": 3, +"mappings": "CAyDA,SAAY,EACV,qBAAsB,EAAE,UAAW,EAqDrC,QAAS,EARP,IAAK,EAAE,AAAC,EACR,+BAAS,EAEP,MAAO,EAAE,IAAK,EACd,MAAO,EAAE,CAAE,EACb,cAAO,EACL,IAAK,EAAE,GAAI,EC1Gb,SAkBC,EAjBC,UAAW,ECFJ,UAAW,EDGlB,UAAW,EAHqC,KAAM,EAItD,SAAU,EAJsD,KAAM,EAapE,EAAG,EAAE,qCAAwB,EAC7B,EAAG,EAAE,0PAAyE,ECZpF,SAAU,EACR,MAAO,EAAE,WAAY,EACrB,UAAW,EAAE,UAAW,EACxB,SAAU,EAAE,KAAM,EAClB,UAAW,EAAE,KAAM,EACnB,UAAW,EAAE,AAAC,EACd,cAAe,EAAE,MAAO,EAG1B,IAAK,EACH,MAAO,EAAE,WAAY,EACrB,cAAe,EAAE,MAAO,EAIxB,KAAG,EACD,MAAO,EAAE,WAAY,EACvB,sCAAiB,EAGf,IAAK,EAAE,MAAY,EAEvB,KAAM,EACJ,cAAe,EAAE,GAAI,EACrB,UAAW,EAAE,EAAG,EAChB,UAAW,EAAE,KAAM,EAEjB,YAAG,EACD,IAAK,EAAE,IAAI,EACb,oDAAiB,EAGf,aAAc,EAAE,OAAQ,EAG9B,cAAe,EACb,MAAO,EAAE,EAAO,EAElB,gBAAiB,EACf,MAAO,EAAE,EAAO,EAElB,oBAAqB,EACnB,MAAO,EAAE,EAAO,EAElB,sBAAuB,EACrB,MAAO,EAAE,EAAO,EAElB,kBAAmB,EACjB,MAAO,EAAE,EAAO,EAElB,oBAAqB,EACnB,MAAO,EAAE,EAAO,EAElB,oBAAqB,EACnB,MAAO,EAAE,EAAO,EAElB,sBAAuB,EACrB,MAAO,EAAE,EAAO,EAElB,qBAAsB,EACpB,MAAO,EAAE,EAAO,EAElB,uBAAwB,EACtB,MAAO,EAAE,EAAO,ECnElB,YAAa,EACX,OAAQ,EAAE,IAAK,EACf,KAAM,EAAE,AAAC,EACT,GAAI,EAAE,AAAC,EACP,IAAK,EC6E+B,IAAK,ED5EzC,IAAK,EEoC+B,MAAyB,EFnC7D,SAAU,EAAE,MAAkC,EAC9C,SAAU,EAAE,iBAAiC,EAC7C,UAAW,EE+CyB,sDAAM,EF9C1C,MAAO,EC+E6B,EAAG,ED9EvC,cAAC,EACC,IAAK,EE+B6B,MAAK,EF9BvC,cAAe,EAAE,GAAI,EACvB,6BAAgB,EACd,MAAO,EAAE,GAAI,EACf,iCAAoB,EAClB,MAAO,EAAE,GAAqB,EAC9B,eAAgB,EAAE,MAAkC,EACpD,MAAO,EAAE,IAAK,EACd,SAAU,EAAE,IAAK,EACjB,QAAS,EAAE,EAAG,EACd,KAAM,EAAE,MAAO,EACf,IAAK,EEX6B,MAAM,EL4F1C,IAAK,EAAE,AAAC,EACR,iFAAS,EAEP,MAAO,EAAE,IAAK,EACd,MAAO,EAAE,CAAE,EACb,uCAAO,EACL,IAAK,EAAE,GAAI,EGrFX,qCAAG,EACD,IAAK,EEgB2B,MAAyB,EFf3D,0CAAQ,EACN,IAAK,EAAE,GAAI,EACb,4CAAU,EACR,IAAK,EAAE,GAAI,EACb,iDAAiB,EACf,eAAgB,ECQgB,MAAI,EDPpC,IAAK,EEI2B,GAAM,EFHxC,wDAAwB,EACtB,eAAgB,EEmBgB,MAAO,EFlBvC,IAAK,ECzB2B,GAAI,ED0BxC,yCAA8B,EAC5B,MAAO,EAAE,IAAK,EAChB,gCAAmB,EACjB,QAAS,EAAE,EAAG,EACd,MAAO,EAAE,GAAqB,EAC9B,IAAK,EEP6B,GAAY,EFQ9C,MAAO,EAAE,GAAI,EACb,mCAAE,EACA,MAAO,EAAE,IAAK,EACd,KAAM,EAAE,EAAG,EACX,KAAM,EAAE,AAAC,EACT,KAAM,EAAE,KAAM,EACd,MAAO,EAAE,AAAC,EACV,SAAU,EAAE,gBAA6C,EAC3D,mCAAE,EACA,MAAO,EAAE,WAAY,EACrB,KAAM,EAAE,AAAC,EACT,qCAAC,EACC,MAAO,EAAE,WAAY,EACrB,MAAO,EAAE,EAAqB,EAC9B,IAAK,EEfyB,MAAyB,EFgB7D,sBAAW,EACT,IAAK,EAAE,GAAI,EACX,KAAM,EAAE,GAAI,EACZ,IAAK,EAAE,GAAI,EACX,GAAI,EAAE,GAAI,EACV,KAAM,EAAE,GAAI,EACZ,QAAS,ECkByB,IAAK,EDjBvC,iCAAU,EACR,IAAK,EAAE,GAAI,EACb,+BAAQ,EACN,IAAK,EAAE,GAAI,EACb,oDAA+B,EAC7B,SAAU,EAAE,IAAK,EACjB,6DAAQ,EACN,IAAK,EAAE,GAAI,EACb,+DAAU,EACR,IAAK,EAAE,GAAI,EACf,2CAAoB,EAClB,IAAK,EAAE,GAAI,EACX,KAAM,EAAE,GAAI,EACZ,UAAW,EAAE,GAAI,EACjB,MAAO,EAAE,IAAuB,EAChC,MAAO,EAAE,IAAK,EACd,SAAU,EAAE,KAAM,EGhDpB,mCAAsB,EHmDxB,YAAa,EACX,IAAK,EAAE,EAAG,EACV,MAAO,EAAE,GAAI,EACb,kBAAO,EACL,MAAO,EAAE,IAAK,EAClB,EAAG,EACD,IAAK,EAAE,GAAI,EACX,KAAM,EAAE,GAAI", +"sources": ["../../../bower_components/wyrm/sass/wyrm_core/_mixin.sass","../../../bower_components/bourbon/dist/css3/_font-face.scss","../../../sass/_theme_badge_fa.sass","../../../sass/_theme_badge.sass","../../../bower_components/wyrm/sass/wyrm_core/_wy_variables.sass","../../../sass/_theme_variables.sass","../../../bower_components/neat/app/assets/stylesheets/grid/_media.scss"], +"names": [], +"file": "badge_only.css" +} diff --git a/doc/_build/html/_static/css/theme.css b/doc/_build/html/_static/css/theme.css new file mode 100644 index 0000000..fc956fa --- /dev/null +++ b/doc/_build/html/_static/css/theme.css @@ -0,0 +1,5 @@ +*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}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:0.2em 0;background:#ccc;color:#000;padding:0.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:0.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 span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.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.caption .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,.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}/*! + * Font Awesome 4.2.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:'FontAwesome';src:url("../fonts/fontawesome-webfont.eot?v=4.2.0");src:url("../fonts/fontawesome-webfont.eot?#iefix&v=4.2.0") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff?v=4.2.0") format("woff"),url("../fonts/fontawesome-webfont.ttf?v=4.2.0") format("truetype"),url("../fonts/fontawesome-webfont.svg?v=4.2.0#fontawesomeregular") format("svg");font-weight:normal;font-style:normal}.fa,.wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.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.caption .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.33333em;line-height:0.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.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:0.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:solid 0.08em #eee;border-radius:.1em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.wy-menu-vertical li span.pull-left.toctree-expand,.wy-menu-vertical li.on a span.pull-left.toctree-expand,.wy-menu-vertical li.current>a span.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.caption .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 span.pull-right.toctree-expand,.wy-menu-vertical li.on a span.pull-right.toctree-expand,.wy-menu-vertical li.current>a span.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.caption .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}@-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{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=1);-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=2);-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=3);-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=0);-webkit-transform:scale(-1, 1);-ms-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=2);-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:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.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 span.toctree-expand:before,.wy-menu-vertical li.current>a span.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{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 span.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: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-rebel:before{content:""}.fa-ge:before,.fa-empire:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.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,.wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.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.caption .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 span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.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.caption .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 span.toctree-expand,.wy-menu-vertical li a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.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.caption .headerlink,.rst-content p.caption 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 span.toctree-expand,.wy-menu-vertical li .btn span.toctree-expand,.btn .wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.on a .btn span.toctree-expand,.btn .wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.current>a .btn span.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.caption .headerlink,.rst-content p.caption .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 span.toctree-expand,.wy-menu-vertical li .nav span.toctree-expand,.nav .wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.on a .nav span.toctree-expand,.nav .wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.current>a .nav span.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.caption .headerlink,.rst-content p.caption .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 span.fa-large.toctree-expand,.wy-menu-vertical li .btn span.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.caption .fa-large.headerlink,.rst-content p.caption .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 span.fa-large.toctree-expand,.wy-menu-vertical li .nav span.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.caption .fa-large.headerlink,.rst-content p.caption .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:0.9em}.btn .fa.fa-spin,.btn .wy-menu-vertical li span.fa-spin.toctree-expand,.wy-menu-vertical li .btn span.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.caption .fa-spin.headerlink,.rst-content p.caption .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 span.fa-spin.toctree-expand,.wy-menu-vertical li .nav span.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.caption .fa-spin.headerlink,.rst-content p.caption .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 span.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.caption .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:0.5;-webkit-transition:opacity 0.05s ease-in;-moz-transition:opacity 0.05s ease-in;transition:opacity 0.05s ease-in}.btn.fa:hover:before,.wy-menu-vertical li span.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.caption .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 span.toctree-expand:before,.wy-menu-vertical li .btn-mini span.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.caption .headerlink:before,.rst-content p.caption .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{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{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,.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{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{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,.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{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{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,.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{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{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,.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{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{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,.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{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{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{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 0.3s ease-in;-moz-transition:all 0.3s ease-in;transition:all 0.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 0.1s linear;-moz-transition:all 0.1s linear;transition:all 0.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:0.4;cursor:not-allowed;box-shadow:none}.btn-disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:0.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:0.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 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:68em;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.35765%;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.35765%;width:48.82117%}.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.35765%;width:31.76157%}.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:0.3em;color:#666;vertical-align:middle;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:0.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 0.3s linear;-moz-transition:border 0.3s linear;transition:border 0.3s linear}input[type="datetime-local"]{padding:0.34375em 0.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:0.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:0.5em 0.625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border 0.3s linear;-moz-transition:border 0.3s linear;transition:border 0.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{width:36px;height:12px;margin:12px 0;position:relative;border-radius:4px;background:#ccc;cursor:pointer;-webkit-transition:all 0.2s ease-in-out;-moz-transition:all 0.2s ease-in-out;transition:all 0.2s ease-in-out}.wy-switch:before{position:absolute;content:"";display:block;width:18px;height:18px;border-radius:4px;background:#999;left:-3px;top:-3px;-webkit-transition:all 0.2s ease-in-out;-moz-transition:all 0.2s ease-in-out;transition:all 0.2s ease-in-out}.wy-switch:after{content:"false";position:absolute;left:48px;display:block;font-size:12px;color:#ccc}.wy-switch.active{background:#1e8449}.wy-switch.active:before{left:24px;background:#27AE60}.wy-switch.active:after{content:"true"}.wy-switch.disabled,.wy-switch.active.disabled{cursor:not-allowed}.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:0.5em 0.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:0.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:0.3em;display:block}.wy-form label{margin-bottom:0.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:0.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:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"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 .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 .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 .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 .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 .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 .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 .toctree-wrapper ul li ol li,article ul li ol li{list-style:decimal}.wy-plain-list-decimal,.rst-content .section ol,.rst-content 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 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 ol.arabic 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 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 ol.arabic li ul li,article ol li ul li{list-style:disc}.codeblock-example{border:1px solid #e1e4e5;border-bottom:none;padding:24px;padding-top:48px;font-weight:500;background:#fff;position:relative}.codeblock-example:after{content:"Example";position:absolute;top:0px;left:0px;background:#9B59B6;color:#fff;padding:6px 12px}.codeblock-example.prettyprint-example-only{border:1px solid #e1e4e5;margin-bottom:24px}.codeblock,pre.literal-block,.rst-content .literal-block,.rst-content pre.literal-block,div[class^='highlight']{border:1px solid #e1e4e5;padding:0px;overflow-x:auto;background:#fff;margin:1px 0 24px 0}.codeblock div[class^='highlight'],pre.literal-block div[class^='highlight'],.rst-content .literal-block div[class^='highlight'],div[class^='highlight'] div[class^='highlight']{border:none;background:none;margin:0}div[class^='highlight'] td.code{width:100%}.linenodiv pre{border-right:solid 1px #e6e9ea;margin:0;padding:12px 12px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;font-size:12px;line-height:1.5;color:#d9d9d9}div[class^='highlight'] pre{white-space:pre;margin:0;padding:12px 12px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;font-size:12px;line-height:1.5;display:block;overflow:auto;color:#404040}@media print{.codeblock,pre.literal-block,.rst-content .literal-block,.rst-content pre.literal-block,div[class^='highlight'],div[class^='highlight'] pre{white-space:pre-wrap}}.hll{background-color:#ffc;margin:0 -12px;padding:0 12px;display:block}.c{color:#998;font-style:italic}.err{color:#a61717;background-color:#e3d2d2}.k{font-weight:bold}.o{font-weight:bold}.cm{color:#998;font-style:italic}.cp{color:#999;font-weight:bold}.c1{color:#998;font-style:italic}.cs{color:#999;font-weight:bold;font-style:italic}.gd{color:#000;background-color:#fdd}.gd .x{color:#000;background-color:#faa}.ge{font-style:italic}.gr{color:#a00}.gh{color:#999}.gi{color:#000;background-color:#dfd}.gi .x{color:#000;background-color:#afa}.go{color:#888}.gp{color:#555}.gs{font-weight:bold}.gu{color:purple;font-weight:bold}.gt{color:#a00}.kc{font-weight:bold}.kd{font-weight:bold}.kn{font-weight:bold}.kp{font-weight:bold}.kr{font-weight:bold}.kt{color:#458;font-weight:bold}.m{color:#099}.s{color:#d14}.n{color:#333}.na{color:teal}.nb{color:#0086b3}.nc{color:#458;font-weight:bold}.no{color:teal}.ni{color:purple}.ne{color:#900;font-weight:bold}.nf{color:#900;font-weight:bold}.nn{color:#555}.nt{color:navy}.nv{color:teal}.ow{font-weight:bold}.w{color:#bbb}.mf{color:#099}.mh{color:#099}.mi{color:#099}.mo{color:#099}.sb{color:#d14}.sc{color:#d14}.sd{color:#d14}.s2{color:#d14}.se{color:#d14}.sh{color:#d14}.si{color:#d14}.sx{color:#d14}.sr{color:#009926}.s1{color:#d14}.ss{color:#990073}.bp{color:#999}.vc{color:teal}.vg{color:teal}.vi{color:teal}.il{color:#099}.gc{color:#999;background-color:#EAF2F5}.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}}.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{height:32px;display:inline-block;line-height:32px;padding:0 1.618em;margin-bottom:0;display:block;font-weight:bold;text-transform:uppercase;font-size:80%;color:#555;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:0.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 span.toctree-expand{display:block;float:left;margin-left:-1.2em;font-size:0.8em;line-height:1.6em;color:#4d4d4d}.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a{color:#404040;padding:0.4045em 1.618em;font-weight:bold;position:relative;background:#fcfcfc;border:none;border-bottom:solid 1px #c9c9c9;border-top:solid 1px #c9c9c9;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 span.toctree-expand,.wy-menu-vertical li.current>a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand{display:block;font-size:0.8em;line-height:1.6em;color:#333}.wy-menu-vertical li.toctree-l1.current li.toctree-l2>ul,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>ul{display:none}.wy-menu-vertical li.toctree-l1.current li.toctree-l2.current>ul,.wy-menu-vertical li.toctree-l2.current li.toctree-l3.current>ul{display:block}.wy-menu-vertical li.toctree-l2.current>a{background:#c9c9c9;padding:0.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{display:block;background:#c9c9c9;padding:0.4045em 4.045em}.wy-menu-vertical li.toctree-l2 a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.toctree-l2 span.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3{font-size:0.9em}.wy-menu-vertical li.toctree-l3.current>a{background:#bdbdbd;padding:0.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{display:block;background:#bdbdbd;padding:0.4045em 5.663em;border-top:none;border-bottom:none}.wy-menu-vertical li.toctree-l3 a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.toctree-l3 span.toctree-expand{color:#969696}.wy-menu-vertical li.toctree-l4{font-size:0.9em}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical .local-toc li ul{display:block}.wy-menu-vertical li ul li a{margin-bottom:0;color:#b3b3b3;font-weight:normal}.wy-menu-vertical a{display:inline-block;line-height:18px;padding:0.4045em 1.618em;display:block;position:relative;font-size:90%;color:#b3b3b3}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover span.toctree-expand{color:#b3b3b3}.wy-menu-vertical a:active{background-color:#2980B9;cursor:pointer;color:#fff}.wy-menu-vertical a:active span.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:0.809em;margin-bottom:0.809em;z-index:200;background-color:#2980B9;text-align:center;padding:0.809em;display:block;color:#fcfcfc;margin-bottom:0.809em}.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 0.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:0.809em}.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:0.85em}.wy-side-nav-search>div.version{margin-top:-0.4045em;margin-bottom:0.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 0.2s ease-in;-moz-transition:all 0.2s ease-in;transition:all 0.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:left repeat-y #fcfcfc;background-image:url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDoxOERBMTRGRDBFMUUxMUUzODUwMkJCOThDMEVFNURFMCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDoxOERBMTRGRTBFMUUxMUUzODUwMkJCOThDMEVFNURFMCI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjE4REExNEZCMEUxRTExRTM4NTAyQkI5OEMwRUU1REUwIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjE4REExNEZDMEUxRTExRTM4NTAyQkI5OEMwRUU1REUwIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+EwrlwAAAAA5JREFUeNpiMDU0BAgwAAE2AJgB9BnaAAAAAElFTkSuQmCC);background-size:300px 1px}.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%;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:0.4045em 0.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%;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:#999}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:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;font-size:1em;background:none;border:none;color:#999}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:before,.rst-footer-buttons:after{display:table;content:""}.rst-footer-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%}@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: 1400px){.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;border-top:solid 10px #343131;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 span.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version span.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.caption .headerlink,.rst-content p.caption .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 .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}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none}.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}img{width:100%;height:auto}}.rst-content img{max-width:100%;height:auto !important}.rst-content div.figure{margin-bottom:24px}.rst-content div.figure p.caption{font-style:italic}.rst-content div.figure.align-center{text-align:center}.rst-content .section>img,.rst-content .section>a>img{margin-bottom:24px}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content .note .last,.rst-content .attention .last,.rst-content .caution .last,.rst-content .danger .last,.rst-content .error .last,.rst-content .hint .last,.rst-content .important .last,.rst-content .tip .last,.rst-content .warning .last,.rst-content .seealso .last,.rst-content .admonition-todo .last{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{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha li{list-style:upper-alpha}.rst-content .section ol p,.rst-content .section ul p{margin-bottom:12px}.rst-content .line-block{margin-left:24px}.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;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.caption .headerlink{display:none;visibility:hidden;font-size:14px}.rst-content h1 .headerlink:after,.rst-content h2 .headerlink:after,.rst-content .toctree-wrapper p.caption .headerlink:after,.rst-content h3 .headerlink:after,.rst-content h4 .headerlink:after,.rst-content h5 .headerlink:after,.rst-content h6 .headerlink:after,.rst-content dl dt .headerlink:after,.rst-content p.caption .headerlink:after{visibility:visible;content:"";font-family:FontAwesome;display:inline-block}.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.caption:hover .headerlink{display:inline-block}.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{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;display:inline-block;font-weight:bold;padding:0 6px}.rst-content .footnote-reference,.rst-content .citation-reference{vertical-align:super;font-size:90%}.rst-content table.docutils.citation,.rst-content table.docutils.footnote{background:none;border:none;color:#999}.rst-content table.docutils.citation td,.rst-content table.docutils.citation tr,.rst-content table.docutils.footnote td,.rst-content table.docutils.footnote tr{border:none;background-color:transparent !important;white-space:normal}.rst-content table.docutils.citation td.label,.rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}.rst-content table.docutils.citation tt,.rst-content table.docutils.citation code,.rst-content table.docutils.footnote tt,.rst-content table.docutils.footnote code{color:#555}.rst-content table.field-list{border:none}.rst-content table.field-list td{border:none;padding-top:5px}.rst-content table.field-list td>strong{display:inline-block;margin-top:3px}.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;padding-left:0}.rst-content tt,.rst-content tt,.rst-content code{color:#000;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}.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 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}.rst-content dl p,.rst-content dl table,.rst-content dl ul,.rst-content dl ol{margin-bottom:12px !important}.rst-content dl dd{margin:0 0 12px 24px}.rst-content dl:not(.docutils){margin-bottom:24px}.rst-content dl:not(.docutils) dt{display:inline-block;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980B9;border-top:solid 3px #6ab0de;padding:6px;position:relative}.rst-content dl:not(.docutils) dt:before{color:#6ab0de}.rst-content dl:not(.docutils) dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dl dt{margin-bottom:6px;border:none;border-left:solid 3px #ccc;background:#f0f0f0;color:#555}.rst-content dl:not(.docutils) dl dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dt:first-child{margin-top:0}.rst-content dl:not(.docutils) tt,.rst-content dl:not(.docutils) tt,.rst-content dl:not(.docutils) code{font-weight:bold}.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) code.descclassname{background-color:transparent;border:none;padding:0;font-size:100% !important}.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname{font-weight:bold}.rst-content dl:not(.docutils) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:bold}.rst-content dl:not(.docutils) .property{display:inline-block;padding-right:8px}.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-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{margin-right:4px}@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:"Inconsolata";font-style:normal;font-weight:400;src:local("Inconsolata"),local("Inconsolata-Regular"),url(../fonts/Inconsolata-Regular.ttf) format("truetype")}@font-face{font-family:"Inconsolata";font-style:normal;font-weight:700;src:local("Inconsolata Bold"),local("Inconsolata-Bold"),url(../fonts/Inconsolata-Bold.ttf) format("truetype")}@font-face{font-family:"Lato";font-style:normal;font-weight:400;src:local("Lato Regular"),local("Lato-Regular"),url(../fonts/Lato-Regular.ttf) format("truetype")}@font-face{font-family:"Lato";font-style:normal;font-weight:700;src:local("Lato Bold"),local("Lato-Bold"),url(../fonts/Lato-Bold.ttf) format("truetype")}@font-face{font-family:"Roboto Slab";font-style:normal;font-weight:400;src:local("Roboto Slab Regular"),local("RobotoSlab-Regular"),url(../fonts/RobotoSlab-Regular.ttf) format("truetype")}@font-face{font-family:"Roboto Slab";font-style:normal;font-weight:700;src:local("Roboto Slab Bold"),local("RobotoSlab-Bold"),url(../fonts/RobotoSlab-Bold.ttf) format("truetype")} +/*# sourceMappingURL=theme.css.map */ diff --git a/doc/_build/html/_static/css/theme.css.map b/doc/_build/html/_static/css/theme.css.map new file mode 100644 index 0000000..96cc9d2 --- /dev/null +++ b/doc/_build/html/_static/css/theme.css.map @@ -0,0 +1,7 @@ +{ +"version": 3, +"mappings": "CACE,AAAE,ECQI,iBAAoB,EDPJ,SAAU,ECY1B,cAAiB,EDZD,SAAU,EC2B1B,SAAY,ED3BI,SAAU,EEFlC,uEAAiF,EAC/E,MAAO,EAAE,IAAK,EAEhB,iBAAoB,EAClB,MAAO,EAAE,WAAY,EACrB,OAAQ,EAAE,KAAM,EAChB,IAAK,EAAE,AAAC,EAEV,oBAAqB,EACnB,MAAO,EAAE,GAAI,EAEf,OAAQ,EACN,MAAO,EAAE,GAAI,EAEf,AAAC,EDLO,iBAAoB,ECMd,SAAU,EDDhB,cAAiB,ECCX,SAAU,EDchB,SAAY,ECdN,SAAU,EAExB,GAAI,EACF,QAAS,EAAE,GAAI,EACf,uBAAwB,EAAE,GAAI,EAC9B,mBAAoB,EAAE,GAAI,EAE5B,GAAI,EACF,KAAM,EAAE,AAAC,EAEX,eAAiB,EACf,MAAO,EAAE,AAAC,EAEZ,UAAW,EACT,YAAa,EAAE,SAAU,EAE3B,OAAS,EACP,UAAW,EAAE,GAAI,EAEnB,SAAU,EACR,KAAM,EAAE,AAAC,EAEX,EAAG,EACD,SAAU,EAAE,KAAM,EAGpB,EAAG,EACD,SAAU,EAAE,GAAI,EAChB,IAAK,EAAE,GAAI,EACX,cAAe,EAAE,GAAI,EAEvB,GAAI,EACF,SAAU,EAAE,GAAI,EAChB,IAAK,EAAE,GAAI,EACX,SAAU,EAAE,KAAM,EAClB,UAAW,EAAE,GAAI,EAEnB,kDAAoB,EAClB,UAAW,EAAE,cAAS,EACtB,WAAY,EAAE,sBAAa,EAC3B,QAAS,EAAE,EAAG,EAEhB,EAAG,EACD,UAAW,EAAE,EAAG,EAElB,AAAC,EACC,KAAM,EAAE,GAAI,EAEd,eAAiB,EACf,MAAO,EAAE,CAAE,EACX,MAAO,EAAE,GAAI,EAEf,IAAK,EACH,QAAS,EAAE,EAAG,EAEhB,MAAQ,EACN,QAAS,EAAE,EAAG,EACd,UAAW,EAAE,AAAC,EACd,OAAQ,EAAE,OAAQ,EAClB,aAAc,EAAE,OAAQ,EAE1B,EAAG,EACD,EAAG,EAAE,KAAM,EAEb,EAAG,EACD,KAAM,EAAE,MAAO,EAEjB,OAAU,EACR,KAAM,EAAE,AAAC,EACT,MAAO,EAAE,AAAC,EACV,SAAU,EAAE,GAAI,EAChB,eAAgB,EAAE,GAAI,EAExB,CAAE,EACA,SAAU,EAAE,GAAI,EAElB,CAAE,EACA,KAAM,EAAE,AAAC,EAEX,EAAG,EACD,KAAM,EAAE,AAAC,EACT,qBAAsB,EAAE,MAAO,EAC/B,aAAc,EAAE,KAAM,EACtB,QAAS,EAAE,GAAI,EAEjB,aAAc,EACZ,OAAQ,EAAE,KAAM,EAElB,KAAM,EACJ,KAAM,EAAE,AAAC,EAEX,GAAI,EACF,KAAM,EAAE,AAAC,EAEX,OAAQ,EACN,KAAM,EAAE,AAAC,EACT,KAAM,EAAE,AAAC,EACT,MAAO,EAAE,AAAC,EAEZ,IAAK,EACH,KAAM,EAAE,MAAO,EAEjB,KAAM,EACJ,KAAM,EAAE,AAAC,EACT,WAAY,EAAE,GAAI,EAClB,MAAO,EAAE,AAAC,EACV,UAAW,EAAE,KAAM,EAErB,2BAA+B,EAC7B,QAAS,EAAE,GAAI,EACf,KAAM,EAAE,AAAC,EACT,aAAc,EAAE,OAAQ,EACxB,cAAe,EAAE,KAAM,EAEzB,WAAa,EACX,UAAW,EAAE,KAAM,EAErB,mEAAuE,EACrE,KAAM,EAAE,MAAO,EACf,iBAAkB,EAAE,KAAM,EAC1B,QAAS,EAAE,MAAO,EAEpB,+BAAiC,EAC/B,KAAM,EAAE,MAAO,EAEjB,yCAA2C,EACzC,SAAU,EAAE,SAAU,EACtB,MAAO,EAAE,AAAC,EACV,KAAM,EAAE,GAAI,EACZ,MAAO,EAAE,GAAI,EAEf,mBAAoB,EAClB,iBAAkB,EAAE,QAAS,EAC7B,cAAe,EAAE,UAAW,EAC5B,iBAAkB,EAAE,UAAW,EAC/B,SAAU,EAAE,UAAW,EAEzB,iGAAmG,EACjG,iBAAkB,EAAE,GAAI,EAE1B,+CAAiD,EAC/C,KAAM,EAAE,AAAC,EACT,MAAO,EAAE,AAAC,EAEZ,OAAQ,EACN,OAAQ,EAAE,GAAI,EACd,aAAc,EAAE,EAAG,EACnB,KAAM,EAAE,OAAQ,EAElB,IAAK,EACH,cAAe,EAAE,OAAQ,EACzB,aAAc,EAAE,AAAC,EAEnB,CAAE,EACA,aAAc,EAAE,EAAG,EAErB,WAAY,EACV,KAAM,EAAE,MAAO,EACf,SAAU,EAAE,GAAI,EAChB,IAAK,EAAE,GAAK,EACZ,MAAO,EAAE,MAAO,EAElB,EAAG,EACD,MAAO,EAAE,IAAK,EACd,KAAM,EAAE,AAAC,EACT,UAAW,EAAE,KAAM,EACnB,OAAQ,EAAE,KAAM,EAChB,eAAgB,EAAE,UAAW,EAC7B,gBAAiB,EAAE,QAAS,EAC5B,SAAU,EAAE,GAAI,EAChB,QAAS,EAAE,EAAG,EACd,WAAY,EAAE,AAAC,EAEjB,KAAM,EACJ,MAAO,EAAE,GAAI,EAEf,MAAO,EACL,MAAO,EAAE,cAAe,EACxB,SAAU,EAAE,KAAM,EAEpB,cAAe,EACb,KAAM,EAAE,AAAC,EACT,GAAI,EAAE,YAAa,EACnB,KAAM,EAAE,EAAG,EACX,KAAM,EAAE,GAAI,EACZ,OAAQ,EAAE,KAAM,EAChB,MAAO,EAAE,AAAC,EACV,OAAQ,EAAE,OAAQ,EAClB,IAAK,EAAE,EAAG,EAEZ,+DAAiE,EAC/D,GAAI,EAAE,GAAI,EACV,KAAM,EAAE,GAAI,EACZ,KAAM,EAAE,AAAC,EACT,OAAQ,EAAE,MAAO,EACjB,OAAQ,EAAE,KAAM,EAChB,IAAK,EAAE,GAAI,EAEb,SAAU,EACR,SAAU,EAAE,KAAM,EAEpB,QAAS,EACP,OAAQ,EAAE,OAAQ,EAEpB,QAAU,EACR,QAAS,EAAE,GAAI,EAEjB,WAAY,EACV,gBAAmB,EACjB,SAAU,EAAE,cAAe,EAC7B,AAAC,EACC,SAAU,EAAE,cAAe,EAC3B,UAAW,EAAE,cAAe,EAC5B,KAAM,EAAE,cAAe,EACvB,SAAU,EAAE,cAAe,EAC7B,UAAY,EACV,cAAe,EAAE,QAAS,EAC5B,0DAA6D,EAC3D,MAAO,EAAE,CAAE,EACb,aAAe,EACb,gBAAiB,EAAE,IAAK,EAC1B,IAAK,EACH,MAAO,EAAE,iBAAkB,EAC7B,KAAO,EACL,gBAAiB,EAAE,IAAK,EAC1B,EAAG,EACD,QAAS,EAAE,cAAe,QAE1B,KAAM,EAAE,IAAK,EAEf,8CAAS,EACP,MAAO,EAAE,AAAC,EACV,KAAM,EAAE,AAAC,EACX,4CAAM,EACJ,eAAgB,EAAE,IAAK,GChM3B,ykDAAY,EACV,qBAAsB,EAAE,UAAW,EAqDrC,QAAS,EARP,IAAK,EAAE,AAAC,EACR,+BAAS,EAEP,MAAO,EAAE,IAAK,EACd,MAAO,EAAE,CAAE,EACb,cAAO,EACL,IAAK,EAAE,GAAI;;;GC1Gf,UAUC,CATC,WAAW,CAAE,aAAa,CAC1B,GAAG,CAAE,+CAAgE,CACrE,GAAG,CAAE,sSAAmG,CAKxG,WAAW,CAAE,MAAM,CACnB,UAAU,CAAE,MAAM,CCTpB,kfAAmB,CACjB,OAAO,CAAE,YAAY,CACrB,IAAI,CAAE,uCAAuC,CAC7C,SAAS,CAAE,OAAO,CAClB,cAAc,CAAE,IAAI,CACpB,sBAAsB,CAAE,WAAW,CACnC,uBAAuB,CAAE,SAAS,CCLpC,MAAsB,CACpB,SAAS,CAAE,SAAS,CACpB,WAAW,CAAE,MAAS,CACtB,cAAc,CAAE,IAAI,CAEtB,MAAsB,CAAE,SAAS,CAAE,GAAG,CACtC,MAAsB,CAAE,SAAS,CAAE,GAAG,CACtC,MAAsB,CAAE,SAAS,CAAE,GAAG,CACtC,MAAsB,CAAE,SAAS,CAAE,GAAG,CCVtC,MAAsB,CACpB,KAAK,CAAE,SAAW,CAClB,UAAU,CAAE,MAAM,CCDpB,MAAsB,CACpB,YAAY,CAAE,CAAC,CACf,WAAW,CCIU,SAAS,CDH9B,eAAe,CAAE,IAAI,CACrB,SAAK,CAAE,QAAQ,CAAE,QAAQ,CAE3B,MAAsB,CACpB,QAAQ,CAAE,QAAQ,CAClB,IAAI,CAAE,UAAa,CACnB,KAAK,CCHgB,SAAS,CDI9B,GAAG,CAAE,SAAU,CACf,UAAU,CAAE,MAAM,CAClB,YAAuB,CACrB,IAAI,CAAE,UAA0B,CEbpC,UAA0B,CACxB,OAAO,CAAE,gBAAgB,CACzB,MAAM,CAAE,iBAA4B,CACpC,aAAa,CAAE,IAAI,CAGrB,WAAY,CAAE,KAAK,CAAE,KAAK,CAC1B,UAAW,CAAE,KAAK,CAAE,IAAI,CAGtB,kpBAAY,CAAE,YAAY,CAAE,IAAI,CAChC,kqBAAa,CAAE,WAAW,CAAE,IAAI,CCXlC,QAAwB,CACtB,iBAAiB,CAAE,0BAA0B,CACrC,SAAS,CAAE,0BAA0B,CAG/C,0BASC,CARC,EAAG,CACD,iBAAiB,CAAE,YAAY,CACvB,SAAS,CAAE,YAAY,CAEjC,IAAK,CACH,iBAAiB,CAAE,cAAc,CACzB,SAAS,CAAE,cAAc,EAIrC,kBASC,CARC,EAAG,CACD,iBAAiB,CAAE,YAAY,CACvB,SAAS,CAAE,YAAY,CAEjC,IAAK,CACH,iBAAiB,CAAE,cAAc,CACzB,SAAS,CAAE,cAAc,ECvBrC,aAA8B,CCU5B,MAAM,CAAE,wDAAmE,CAC3E,iBAAiB,CAAE,aAAgB,CAC/B,aAAa,CAAE,aAAgB,CAC3B,SAAS,CAAE,aAAgB,CDZrC,cAA8B,CCS5B,MAAM,CAAE,wDAAmE,CAC3E,iBAAiB,CAAE,cAAgB,CAC/B,aAAa,CAAE,cAAgB,CAC3B,SAAS,CAAE,cAAgB,CDXrC,cAA8B,CCQ5B,MAAM,CAAE,wDAAmE,CAC3E,iBAAiB,CAAE,cAAgB,CAC/B,aAAa,CAAE,cAAgB,CAC3B,SAAS,CAAE,cAAgB,CDTrC,mBAAmC,CCajC,MAAM,CAAE,wDAAmE,CAC3E,iBAAiB,CAAE,YAAoB,CACnC,aAAa,CAAE,YAAoB,CAC/B,SAAS,CAAE,YAAoB,CDfzC,iBAAmC,CCYjC,MAAM,CAAE,wDAAmE,CAC3E,iBAAiB,CAAE,YAAoB,CACnC,aAAa,CAAE,YAAoB,CAC/B,SAAS,CAAE,YAAoB,CDVzC,+GAIuC,CACrC,MAAM,CAAE,IAAI,CEfd,SAAyB,CACvB,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,YAAY,CACrB,KAAK,CAAE,GAAG,CACV,MAAM,CAAE,GAAG,CACX,WAAW,CAAE,GAAG,CAChB,cAAc,CAAE,MAAM,CAExB,yBAAyD,CACvD,QAAQ,CAAE,QAAQ,CAClB,IAAI,CAAE,CAAC,CACP,KAAK,CAAE,IAAI,CACX,UAAU,CAAE,MAAM,CAEpB,YAA4B,CAAE,WAAW,CAAE,OAAO,CAClD,YAA4B,CAAE,SAAS,CAAE,GAAG,CAC5C,WAA2B,CAAE,KAAK,CLXZ,IAAI,CML1B,gBAAgC,CAAE,OAAO,CNwP1B,GAAO,CMvPtB,gBAAgC,CAAE,OAAO,CNkV1B,GAAO,CMjVtB,qCAAiC,CAAE,OAAO,CNyZ1B,GAAO,CMxZvB,qBAAqC,CAAE,OAAO,CN2K1B,GAAO,CM1K3B,gBAAgC,CAAE,OAAO,CNqQ1B,GAAO,CMpQtB,eAA+B,CAAE,OAAO,CNkc1B,GAAO,CMjcrB,iBAAiC,CAAE,OAAO,CNsc1B,GAAO,CMrcvB,eAA+B,CAAE,OAAO,CN0gB1B,GAAO,CMzgBrB,eAA+B,CAAE,OAAO,CN+M1B,GAAO,CM9MrB,mBAAmC,CAAE,OAAO,CN8d1B,GAAO,CM7dzB,aAA6B,CAAE,OAAO,CN4d1B,GAAO,CM3dnB,kBAAkC,CAAE,OAAO,CN6d1B,GAAO,CM5dxB,gBAAgC,CAAE,OAAO,CN+F1B,GAAO,CM9FtB,mDAEgC,CAAE,OAAO,CNge1B,GAAO,CM/dtB,sBAAsC,CAAE,OAAO,CN6Y1B,GAAO,CM5Y5B,uBAAuC,CAAE,OAAO,CN2Y1B,GAAO,CM1Y7B,oBAAoC,CAAE,OAAO,CNqW1B,GAAO,CMpW1B,iBAAiC,CAAE,OAAO,CNwZ1B,GAAO,CMvZvB,8BAC8B,CAAE,OAAO,CNmH1B,GAAO,CMlHpB,kBAAkC,CAAE,OAAO,CNoe1B,GAAO,CMnexB,iCAA+B,CAAE,OAAO,CNqP1B,GAAO,CMpPrB,iBAAiC,CAAE,OAAO,CNmL1B,GAAO,CMlLvB,kBAAkC,CAAE,OAAO,CNqG1B,GAAO,CMpGxB,eAA+B,CAAE,OAAO,CNqX1B,GAAO,CMpXrB,uHAAmC,CAAE,OAAO,CNyI1B,GAAO,CMxIzB,8BAA8C,CAAE,OAAO,CNG1B,GAAO,CMFpC,4BAA4C,CAAE,OAAO,CNK1B,GAAO,CMJlC,gBAAgC,CAAE,OAAO,CNmP1B,GAAO,CMlPtB,wBAAwC,CAAE,OAAO,CNkV1B,GAAO,CMjV9B,yCACiC,CAAE,OAAO,CNyW1B,GAAO,CMxWvB,kBAAkC,CAAE,OAAO,CNoW1B,GAAO,CMnWxB,mBAAmC,CAAE,OAAO,CNiR1B,GAAO,CMhRzB,eAA+B,CAAE,OAAO,CNoR1B,GAAO,CMnRrB,eAA+B,CAAE,OAAO,CNsL1B,GAAO,CMrLrB,qBAAqC,CAAE,OAAO,CNkO1B,GAAO,CMjO3B,qBAAqC,CAAE,OAAO,CNkf1B,GAAO,CMjf3B,sBAAsC,CAAE,OAAO,CNgf1B,GAAO,CM/e5B,oBAAoC,CAAE,OAAO,CNif1B,GAAO,CMhf1B,iBAAiC,CAAE,OAAO,CNiV1B,GAAO,CMhVvB,kBAAkC,CAAE,OAAO,CNU1B,GAAO,CMTxB,cAA8B,CAAE,OAAO,CNkb1B,GAAO,CMjbpB,eAA+B,CAAE,OAAO,CNkb1B,GAAO,CMjbrB,iCAA+B,CAAE,OAAO,CNyB1B,GAAO,CMxBrB,mBAAmC,CAAE,OAAO,CNyB1B,GAAO,CMxBzB,gBAAgC,CAAE,OAAO,CNwU1B,GAAO,CMvUtB,iBAAiC,CAAE,OAAO,CNqC1B,GAAO,CMpCvB,eAA+B,CAAE,OAAO,CNoL1B,GAAO,CMnLrB,eAA+B,CAAE,OAAO,CNiB1B,GAAO,CMhBrB,iBAAiC,CAAE,OAAO,CNqO1B,GAAO,CMpOvB,sBAAsC,CAAE,OAAO,CN+a1B,GAAO,CM9a5B,qBAAqC,CAAE,OAAO,CN+a1B,GAAO,CM9a3B,qBAAqC,CAAE,OAAO,CN3C1B,GAAO,CM4C3B,uBAAuC,CAAE,OAAO,CN9C1B,GAAO,CM+C7B,sBAAsC,CAAE,OAAO,CN5C1B,GAAO,CM6C5B,wBAAwC,CAAE,OAAO,CN/C1B,GAAO,CMgD9B,eAA+B,CAAE,OAAO,CNwP1B,GAAO,CMvPrB,oCACkC,CAAE,OAAO,CN0R1B,GAAO,CMzRxB,iBAAiC,CAAE,OAAO,CNoN1B,GAAO,CMnNvB,uBAAuC,CAAE,OAAO,CNqd1B,GAAO,CMpd7B,sDAEoC,CAAE,OAAO,CNsS1B,GAAO,CMrS1B,iBAAiC,CAAE,OAAO,CN+R1B,GAAO,CM9RvB,qBAAqC,CAAE,OAAO,CN+P1B,GAAO,CM9P3B,iBAAiC,CAAE,OAAO,CN7D1B,GAAO,CM8DvB,eAA+B,CAAE,OAAO,CN4a1B,GAAO,CM3arB,0CAC0C,CAAE,OAAO,CN4R1B,GAAO,CM3RhC,yBAAyC,CAAE,OAAO,CN2V1B,GAAO,CM1V/B,yBAAyC,CAAE,OAAO,CNqC1B,GAAO,CMpC/B,iBAAiC,CAAE,OAAO,CNlC1B,GAAO,CMmCvB,wBAAwC,CAAE,OAAO,CNmY1B,GAAO,CMlY9B,wBAAwC,CAAE,OAAO,CNkH1B,GAAO,CMjH9B,mBAAmC,CAAE,OAAO,CN9B1B,GAAO,CM+BzB,eAA+B,CAAE,OAAO,CNgS1B,GAAO,CM/RrB,gBAAgC,CAAE,OAAO,CN+Q1B,GAAO,CM9QtB,eAA+B,CAAE,OAAO,CNiY1B,GAAO,CMhYrB,kBAAkC,CAAE,OAAO,CNqJ1B,GAAO,CMpJxB,uBAAuC,CAAE,OAAO,CN6G1B,GAAO,CM5G7B,uBAAuC,CAAE,OAAO,CN4X1B,GAAO,CM3X7B,gBAAgC,CAAE,OAAO,CNoF1B,GAAO,CMnFtB,uBAAuC,CAAE,OAAO,CN+B1B,GAAO,CM9B7B,wBAAwC,CAAE,OAAO,CN+B1B,GAAO,CM9B9B,sBAAsC,CAAE,OAAO,CN4R1B,GAAO,CM3R5B,uBAAuC,CAAE,OAAO,CNkP1B,GAAO,CMjP7B,8FAAuC,CAAE,OAAO,CNsZ1B,GAAO,CMrZ7B,+FAAuC,CAAE,OAAO,CNiB1B,GAAO,CMhB7B,0BAA0C,CAAE,OAAO,CNiS1B,GAAO,CMhShC,sBAAsC,CAAE,OAAO,CNuL1B,GAAO,CMtL5B,qBAAqC,CAAE,OAAO,CNuD1B,GAAO,CMtD3B,yBAAyC,CAAE,OAAO,CNkZ1B,GAAO,CMjZ/B,yBAAyC,CAAE,OAAO,CNa1B,GAAO,CMZ/B,cAA8B,CAAE,OAAO,CNhD1B,GAAO,CMiDpB,qBAAqC,CAAE,OAAO,CN5D1B,GAAO,CM6D3B,sBAAsC,CAAE,OAAO,CN5D1B,GAAO,CM6D5B,mBAAmC,CAAE,OAAO,CN5D1B,GAAO,CM6DzB,qBAAqC,CAAE,OAAO,CNhE1B,GAAO,CMiE3B,wCACgC,CAAE,OAAO,CNyT1B,GAAO,CMxTtB,iBAAiC,CAAE,OAAO,CN+E1B,GAAO,CM9EvB,mBAAmC,CAAE,OAAO,CNuC1B,GAAO,CMtCzB,eAA+B,CAAE,OAAO,CNyQ1B,GAAO,CMxQrB,gBAAgC,CAAE,OAAO,CN+N1B,GAAO,CM9NtB,mBAAmC,CAAE,OAAO,CN/D1B,GAAO,CMgEzB,gNAA6C,CAAE,OAAO,CNwE1B,GAAO,CMvEnC,eAA+B,CAAE,OAAO,CNmI1B,GAAO,CMlIrB,eAA+B,CAAE,OAAO,CNqL1B,GAAO,CMpLrB,iCAA+B,CAAE,OAAO,CNyG1B,GAAO,CMxGrB,cAA8B,CAAE,OAAO,CNyE1B,GAAO,CMxEpB,oBAAoC,CAAE,OAAO,CNyE1B,GAAO,CMxE1B,kDAC+C,CAAE,OAAO,CNkE1B,GAAO,CMjErC,gBAAgC,CAAE,OAAO,CNyP1B,GAAO,CMxPtB,mBAAmC,CAAE,OAAO,CNlC1B,GAAO,CMmCzB,iBAAiC,CAAE,OAAO,CN0Q1B,GAAO,CMzQvB,kBAAkC,CAAE,OAAO,CNmB1B,GAAO,CMlBxB,iBAAiC,CAAE,OAAO,CNqM1B,GAAO,CMpMvB,qBAAqC,CAAE,OAAO,CNH1B,GAAO,CMI3B,uBAAuC,CAAE,OAAO,CNP1B,GAAO,CMQ7B,kBAAkC,CAAE,OAAO,CNiR1B,GAAO,CMhRxB,wBAAwC,CAAE,OAAO,CN2S1B,GAAO,CM1S9B,iBAAiC,CAAE,OAAO,CNoG1B,GAAO,CMnGvB,sBAAsC,CAAE,OAAO,CNqG1B,GAAO,CMpG5B,mBAAmC,CAAE,OAAO,CNpF1B,GAAO,CMqFzB,mBAAmC,CAAE,OAAO,CNtF1B,GAAO,CMuFzB,2CACoC,CAAE,OAAO,CNhF1B,GAAO,CMiF1B,yBAAyC,CAAE,OAAO,CNkY1B,GAAO,CMjY/B,0BAA0C,CAAE,OAAO,CNyD1B,GAAO,CMxDhC,uBAAuC,CAAE,OAAO,CN/C1B,GAAO,CMgD7B,cAA8B,CAAE,OAAO,CNsJ1B,GAAO,CMrJpB,gCAC+B,CAAE,OAAO,CNA1B,GAAO,CMCrB,mBAAmC,CAAE,OAAO,CNG1B,GAAO,CMFzB,sBAAsC,CAAE,OAAO,CNiW1B,GAAO,CMhW5B,wBAAwC,CAAE,OAAO,CN+V1B,GAAO,CM9V9B,oBAAoC,CAAE,OAAO,CN2T1B,GAAO,CM1T1B,kBAAkC,CAAE,OAAO,CN4H1B,GAAO,CM3HxB,mBAAmC,CAAE,OAAO,CN2R1B,GAAO,CM1RzB,0BAA0C,CAAE,OAAO,CNiK1B,GAAO,CMhKhC,qBAAqC,CAAE,OAAO,CNwV1B,GAAO,CMvV3B,wBAAwC,CAAE,OAAO,CNsC1B,GAAO,CMrC9B,kBAAkC,CAAE,OAAO,CNsR1B,GAAO,CMrRxB,iBAAiC,CAAE,OAAO,CNyW1B,GAAO,CMxWvB,wBAAwC,CAAE,OAAO,CNiG1B,GAAO,CMhG9B,iBAAiC,CAAE,OAAO,CNyX1B,GAAO,CMxXvB,kBAAkC,CAAE,OAAO,CN+I1B,GAAO,CM9IxB,gBAAgC,CAAE,OAAO,CN6M1B,GAAO,CM5MtB,mBAAmC,CAAE,OAAO,CN2S1B,GAAO,CM1SzB,qBAAqC,CAAE,OAAO,CNjF1B,GAAO,CMkF3B,uBAAuC,CAAE,OAAO,CN2M1B,GAAO,CM1M7B,kBAAkC,CAAE,OAAO,CNyW1B,GAAO,CMxWxB,mBAAmC,CAAE,OAAO,CNgC1B,GAAO,CM/BzB,qCAAiC,CAAE,OAAO,CNsF1B,GAAO,CMrFvB,iBAAiC,CAAE,OAAO,CN6W1B,GAAO,CM5WvB,sBAAsC,CAAE,OAAO,CNb1B,GAAO,CMc5B,cAA8B,CAAE,OAAO,CNmP1B,GAAO,CMlPpB,gBAAgC,CAAE,OAAO,CNoG1B,GAAO,CMnGtB,mBAAmC,CAAE,OAAO,CNpF1B,GAAO,CMqFzB,eAA+B,CAAE,OAAO,CN1G1B,GAAO,CM2GrB,sBAAsC,CAAE,OAAO,CN7D1B,GAAO,CM8D5B,uBAAuC,CAAE,OAAO,CN8F1B,GAAO,CM7F7B,sBAAsC,CAAE,OAAO,CN4F1B,GAAO,CM3F5B,oBAAoC,CAAE,OAAO,CN6F1B,GAAO,CM5F1B,sBAAsC,CAAE,OAAO,CNyF1B,GAAO,CMxF5B,2DAA4C,CAAE,OAAO,CN5I1B,GAAO,CM6IlC,6DAA6C,CAAE,OAAO,CNxI1B,GAAO,CMyInC,0BAA0C,CAAE,OAAO,CNxI1B,GAAO,CMyIhC,4BAA4C,CAAE,OAAO,CNhJ1B,GAAO,CMiJlC,gBAAgC,CAAE,OAAO,CN2E1B,GAAO,CM1EtB,iBAAiC,CAAE,OAAO,CNqX1B,GAAO,CMpXvB,gBAAgC,CAAE,OAAO,CNgT1B,GAAO,CM/StB,iBAAiC,CAAE,OAAO,CNuC1B,GAAO,CMtCvB,oBAAoC,CAAE,OAAO,CNxG1B,GAAO,CMyG1B,qBAAqC,CAAE,OAAO,CNzI1B,GAAO,CM0I3B,iCACgC,CAAE,OAAO,CN8V1B,GAAO,CM7VtB,kDAC+B,CAAE,OAAO,CNwH1B,GAAO,CMvHrB,gBAAgC,CAAE,OAAO,CNxD1B,GAAO,CMyDtB,gBAAgC,CAAE,OAAO,CNsC1B,GAAO,CMrCtB,kCACmC,CAAE,OAAO,CN+N1B,GAAO,CM9NzB,kCACkC,CAAE,OAAO,CNyB1B,GAAO,CMxBxB,oBAAoC,CAAE,OAAO,CN8J1B,GAAO,CM7J1B,mCACmC,CAAE,OAAO,CNiC1B,GAAO,CMhCzB,iBAAiC,CAAE,OAAO,CNkQ1B,GAAO,CMjQvB,qDAE+B,CAAE,OAAO,CN9I1B,GAAO,CM+IrB,kBAAkC,CAAE,OAAO,CNiH1B,GAAO,CMhHxB,kBAAkC,CAAE,OAAO,CN+G1B,GAAO,CM9GxB,wBAAwC,CAAE,OAAO,CN4Q1B,GAAO,CM3Q9B,oBAAoC,CAAE,OAAO,CNgU1B,GAAO,CM/T1B,gBAAgC,CAAE,OAAO,CNkR1B,GAAO,CMjRtB,gBAAgC,CAAE,OAAO,CNmH1B,GAAO,CMlHtB,gBAAgC,CAAE,OAAO,CNmT1B,GAAO,CMlTtB,oBAAoC,CAAE,OAAO,CNgK1B,GAAO,CM/J1B,2BAA2C,CAAE,OAAO,CNgK1B,GAAO,CM/JjC,6BAA6C,CAAE,OAAO,CN8C1B,GAAO,CM7CnC,sBAAsC,CAAE,OAAO,CN4C1B,GAAO,CM3C5B,gBAAgC,CAAE,OAAO,CNgI1B,GAAO,CM/HtB,wEAAqC,CAAE,OAAO,CNxH1B,GAAO,CMyH3B,mBAAmC,CAAE,OAAO,CNlH1B,GAAO,CMmHzB,qBAAqC,CAAE,OAAO,CNzH1B,GAAO,CM0H3B,sBAAsC,CAAE,OAAO,CNzH1B,GAAO,CM0H5B,kBAAkC,CAAE,OAAO,CN3E1B,GAAO,CM4ExB,mCAC+B,CAAE,OAAO,CN4N1B,GAAO,CM3NrB,yCACoC,CAAE,OAAO,CNgO1B,GAAO,CM/N1B,sCACmC,CAAE,OAAO,CN6N1B,GAAO,CM5NzB,mBAAmC,CAAE,OAAO,CN/C1B,GAAO,CMgDzB,mBAAmC,CAAE,OAAO,CNmF1B,GAAO,CMlFzB,sCAC+B,CAAE,OAAO,CN0S1B,GAAO,CMzSrB,iCACgC,CAAE,OAAO,CNW1B,GAAO,CMVtB,0CACqC,CAAE,OAAO,CN0P1B,GAAO,CMzP3B,oBAAoC,CAAE,OAAO,CNxF1B,GAAO,CMyF1B,qBAAqC,CAAE,OAAO,CNvF1B,GAAO,CMwF3B,gCAC+B,CAAE,OAAO,CNlK1B,GAAO,CMmKrB,kBAAkC,CAAE,OAAO,CNoM1B,GAAO,CMnMxB,mBAAmC,CAAE,OAAO,CN8R1B,GAAO,CM7RzB,qCACoC,CAAE,OAAO,CN9G1B,GAAO,CM+G1B,sBAAsC,CAAE,OAAO,CNiE1B,GAAO,CMhE5B,mBAAmC,CAAE,OAAO,CN1D1B,GAAO,CM2DzB,yBAAyC,CAAE,OAAO,CN7G1B,GAAO,CM8G/B,uBAAuC,CAAE,OAAO,CN7G1B,GAAO,CM8G7B,kBAAkC,CAAE,OAAO,CNkS1B,GAAO,CMjSxB,sBAAsC,CAAE,OAAO,CNgO1B,GAAO,CM/N5B,mBAAmC,CAAE,OAAO,CNqO1B,GAAO,CMpOzB,iBAAiC,CAAE,OAAO,CNxL1B,GAAO,CMyLvB,iBAAiC,CAAE,OAAO,CN7G1B,GAAO,CM8GvB,kBAAkC,CAAE,OAAO,CN3F1B,GAAO,CM4FxB,sBAAsC,CAAE,OAAO,CNpC1B,GAAO,CMqC5B,qBAAqC,CAAE,OAAO,CNzK1B,GAAO,CM0K3B,qBAAqC,CAAE,OAAO,CNqB1B,GAAO,CMpB3B,oBAAoC,CAAE,OAAO,CN3O1B,GAAO,CM4O1B,iBAAiC,CAAE,OAAO,CN4E1B,GAAO,CM3EvB,sBAAsC,CAAE,OAAO,CNxD1B,GAAO,CMyD5B,eAA+B,CAAE,OAAO,CNrM1B,GAAO,CMsMrB,mBAAmC,CAAE,OAAO,CNG1B,GAAO,CMFzB,sBAAsC,CAAE,OAAO,CNuH1B,GAAO,CMtH5B,4BAA4C,CAAE,OAAO,CN5O1B,GAAO,CM6OlC,6BAA6C,CAAE,OAAO,CN5O1B,GAAO,CM6OnC,0BAA0C,CAAE,OAAO,CN5O1B,GAAO,CM6OhC,4BAA4C,CAAE,OAAO,CNhP1B,GAAO,CMiPlC,qBAAqC,CAAE,OAAO,CN5O1B,GAAO,CM6O3B,sBAAsC,CAAE,OAAO,CN5O1B,GAAO,CM6O5B,mBAAmC,CAAE,OAAO,CN5O1B,GAAO,CM6OzB,qBAAqC,CAAE,OAAO,CNhP1B,GAAO,CMiP3B,kBAAkC,CAAE,OAAO,CNxG1B,GAAO,CMyGxB,iBAAiC,CAAE,OAAO,CNyB1B,GAAO,CMxBvB,iBAAiC,CAAE,OAAO,CNmN1B,GAAO,CMlNvB,yCACiC,CAAE,OAAO,CNmE1B,GAAO,CMlEvB,mBAAmC,CAAE,OAAO,CNlJ1B,GAAO,CMmJzB,qBAAqC,CAAE,OAAO,CNiH1B,GAAO,CMhH3B,sBAAsC,CAAE,OAAO,CNiH1B,GAAO,CMhH5B,kBAAkC,CAAE,OAAO,CNiL1B,GAAO,CMhLxB,iBAAiC,CAAE,OAAO,CNvJ1B,GAAO,CMwJvB,sCACgC,CAAE,OAAO,CNyH1B,GAAO,CMxHtB,qBAAqC,CAAE,OAAO,CN9B1B,GAAO,CM+B3B,mBAAmC,CAAE,OAAO,CNjD1B,GAAO,CMkDzB,wBAAwC,CAAE,OAAO,CNhD1B,GAAO,CMiD9B,kBAAkC,CAAE,OAAO,CN2J1B,GAAO,CM1JxB,kBAAkC,CAAE,OAAO,CN9C1B,GAAO,CM+CxB,gBAAgC,CAAE,OAAO,CN+C1B,GAAO,CM9CtB,kBAAkC,CAAE,OAAO,CN9C1B,GAAO,CM+CxB,qBAAqC,CAAE,OAAO,CNI1B,GAAO,CMH3B,iBAAiC,CAAE,OAAO,CN9D1B,GAAO,CM+DvB,yBAAyC,CAAE,OAAO,CNhE1B,GAAO,CMiE/B,mBAAmC,CAAE,OAAO,CNsM1B,GAAO,CMrMzB,eAA+B,CAAE,OAAO,CN1J1B,GAAO,CM2JrB,8CACoC,CAAE,OAAO,CN4G1B,GAAO,CM3G1B,2EAEsC,CAAE,OAAO,CNwK1B,GAAO,CMvK5B,yBAAyC,CAAE,OAAO,CNmB1B,GAAO,CMlB/B,eAA+B,CAAE,OAAO,CNjJ1B,GAAO,CMkJrB,oBAAoC,CAAE,OAAO,CNjK1B,GAAO,CMkK1B,yCACuC,CAAE,OAAO,CN9L1B,GAAO,CM+L7B,mBAAmC,CAAE,OAAO,CNmF1B,GAAO,CMlFzB,eAA+B,CAAE,OAAO,CNvB1B,GAAO,CMwBrB,sBAAsC,CAAE,OAAO,CNvH1B,GAAO,CMwH5B,sBAAsC,CAAE,OAAO,CN6K1B,GAAO,CM5K5B,oBAAoC,CAAE,OAAO,CNyK1B,GAAO,CMxK1B,iBAAiC,CAAE,OAAO,CN9H1B,GAAO,CM+HvB,uBAAuC,CAAE,OAAO,CN0E1B,GAAO,CMzE7B,qBAAqC,CAAE,OAAO,CNwB1B,GAAO,CMvB3B,2BAA2C,CAAE,OAAO,CNwB1B,GAAO,CMvBjC,iBAAiC,CAAE,OAAO,CNqH1B,GAAO,CMpHvB,qBAAqC,CAAE,OAAO,CN9N1B,GAAO,CM+N3B,4BAA4C,CAAE,OAAO,CN1F1B,GAAO,CM2FlC,iBAAiC,CAAE,OAAO,CN2F1B,GAAO,CM1FvB,iBAAiC,CAAE,OAAO,CNc1B,GAAO,CMbvB,8BAA8C,CAAE,OAAO,CNtM1B,GAAO,CMuMpC,+BAA+C,CAAE,OAAO,CNtM1B,GAAO,CMuMrC,4BAA4C,CAAE,OAAO,CNtM1B,GAAO,CMuMlC,8BAA8C,CAAE,OAAO,CN1M1B,GAAO,CM2MpC,gBAAgC,CAAE,OAAO,CN7C1B,GAAO,CM8CtB,eAA+B,CAAE,OAAO,CNtK1B,GAAO,CMuKrB,iBAAiC,CAAE,OAAO,CN9S1B,GAAO,CM+SvB,qBAAqC,CAAE,OAAO,CN+M1B,GAAO,CM9M3B,mBAAmC,CAAE,OAAO,CN/O1B,GAAO,CMgPzB,qBAAqC,CAAE,OAAO,CNtJ1B,GAAO,CMuJ3B,qBAAqC,CAAE,OAAO,CNtJ1B,GAAO,CMuJ3B,qBAAqC,CAAE,OAAO,CNmF1B,GAAO,CMlF3B,sBAAsC,CAAE,OAAO,CN6C1B,GAAO,CM5C5B,iBAAiC,CAAE,OAAO,CN0K1B,GAAO,CMzKvB,uBAAuC,CAAE,OAAO,CNO1B,GAAO,CMN7B,wIAAyC,CAAE,OAAO,CNO1B,GAAO,CMN/B,mBAAmC,CAAE,OAAO,CN/B1B,GAAO,CMgCzB,qBAAqC,CAAE,OAAO,CNjC1B,GAAO,CMkC3B,uBAAuC,CAAE,OAAO,CN3N1B,GAAO,CM4N7B,wBAAwC,CAAE,OAAO,CNyB1B,GAAO,CMxB9B,+BAA+C,CAAE,OAAO,CNlJ1B,GAAO,CMmJrC,uBAAuC,CAAE,OAAO,CNuF1B,GAAO,CMtF7B,kBAAkC,CAAE,OAAO,CN9L1B,GAAO,CM+LxB,qDAC8C,CAAE,OAAO,CNnP1B,GAAO,CMoPpC,iDAC4C,CAAE,OAAO,CNlP1B,GAAO,CMmPlC,uDAC+C,CAAE,OAAO,CNrP1B,GAAO,CMsPrC,8BAC8B,CAAE,OAAO,CNpK1B,GAAO,CMqKpB,cAA8B,CAAE,OAAO,CNzG1B,GAAO,CM0GpB,gCAC8B,CAAE,OAAO,CNwL1B,GAAO,CMvLpB,+BAC8B,CAAE,OAAO,CNrE1B,GAAO,CMsEpB,2DAG8B,CAAE,OAAO,CNnE1B,GAAO,CMoEpB,iDAE8B,CAAE,OAAO,CNqD1B,GAAO,CMpDpB,6BAC8B,CAAE,OAAO,CNpE1B,GAAO,CMqEpB,iCAC8B,CAAE,OAAO,CN1R1B,GAAO,CM2RpB,eAA+B,CAAE,OAAO,CNlK1B,GAAO,CMmKrB,oBAAoC,CAAE,OAAO,CNtJ1B,GAAO,CMuJ1B,yBAAyC,CAAE,OAAO,CN4E1B,GAAO,CM3E/B,0BAA0C,CAAE,OAAO,CN4E1B,GAAO,CM3EhC,0BAA0C,CAAE,OAAO,CN4E1B,GAAO,CM3EhC,2BAA2C,CAAE,OAAO,CN4E1B,GAAO,CM3EjC,2BAA2C,CAAE,OAAO,CN+E1B,GAAO,CM9EjC,4BAA4C,CAAE,OAAO,CN+E1B,GAAO,CM9ElC,oBAAoC,CAAE,OAAO,CN+H1B,GAAO,CM9H1B,sBAAsC,CAAE,OAAO,CN2H1B,GAAO,CM1H5B,yBAAyC,CAAE,OAAO,CN4L1B,GAAO,CM3L/B,kBAAkC,CAAE,OAAO,CNyL1B,GAAO,CMxLxB,eAA+B,CAAE,OAAO,CNmL1B,GAAO,CMlLrB,sBAAsC,CAAE,OAAO,CNmL1B,GAAO,CMlL5B,uBAAuC,CAAE,OAAO,CNuL1B,GAAO,CMtL7B,kBAAkC,CAAE,OAAO,CN/M1B,GAAO,CMgNxB,yBAAyC,CAAE,OAAO,CNgF1B,GAAO,CM/E/B,oBAAoC,CAAE,OAAO,CNjG1B,GAAO,CMkG1B,iBAAiC,CAAE,OAAO,CNxJ1B,GAAO,CMyJvB,cAA8B,CAAE,OAAO,CNhX1B,GAAO,CMiXpB,2CAAoC,CAAE,OAAO,CNzT1B,GAAO,CM0T1B,2BAA2C,CAAE,OAAO,CNzT1B,GAAO,CM0TjC,iBAAiC,CAAE,OAAO,CNqI1B,GAAO,CMpIvB,wBAAwC,CAAE,OAAO,CNqI1B,GAAO,CMpI9B,0BAA0C,CAAE,OAAO,CNrE1B,GAAO,CMsEhC,wBAAwC,CAAE,OAAO,CNnE1B,GAAO,CMoE9B,0BAA0C,CAAE,OAAO,CNtE1B,GAAO,CMuEhC,2BAA2C,CAAE,OAAO,CNtE1B,GAAO,CMuEjC,gBAAgC,CAAE,OAAO,CNxW1B,GAAO,CMyWtB,kBAAkC,CAAE,OAAO,CN8J1B,GAAO,CM7JxB,kBAAkC,CAAE,OAAO,CNpX1B,GAAO,CMqXxB,gBAAgC,CAAE,OAAO,CNnF1B,GAAO,CMoFtB,mBAAmC,CAAE,OAAO,CNjO1B,GAAO,CMkOzB,gBAAgC,CAAE,OAAO,CNsC1B,GAAO,CMrCtB,qBAAqC,CAAE,OAAO,CNhK1B,GAAO,CMiK3B,iBAAiC,CAAE,OAAO,CNmH1B,GAAO,CMlHvB,iBAAiC,CAAE,OAAO,CNxM1B,GAAO,CMyMvB,eAA+B,CAAE,OAAO,CNzE1B,GAAO,CM0ErB,iBAAiC,CAAE,OAAO,CNrJ1B,GAAO,CMsJvB,gBAAgC,CAAE,OAAO,CN2E1B,GAAO,CM1EtB,iBAAiC,CAAE,OAAO,CN7D1B,GAAO,CM8DvB,kBAAkC,CAAE,OAAO,CNpX1B,GAAO,CMqXxB,cAA8B,CAAE,OAAO,CNpU1B,GAAO,CMqUpB,aAA6B,CAAE,OAAO,CNsI1B,GAAO,CMrInB,gBAAgC,CAAE,OAAO,CN2I1B,GAAO,CM1ItB,iBAAiC,CAAE,OAAO,CNX1B,GAAO,CMYvB,oBAAoC,CAAE,OAAO,CN5D1B,GAAO,CM6D1B,yBAAyC,CAAE,OAAO,CNgD1B,GAAO,CM/C/B,+BAA+C,CAAE,OAAO,CNrX1B,GAAO,CMsXrC,8BAA8C,CAAE,OAAO,CNvX1B,GAAO,CMwXpC,qDAC8C,CAAE,OAAO,CN5T1B,GAAO,CM6TpC,uBAAuC,CAAE,OAAO,CNvP1B,GAAO,CMwP7B,qBAAqC,CAAE,OAAO,CNoI1B,GAAO,CMnI3B,uBAAuC,CAAE,OAAO,CNyH1B,GAAO,CMxH7B,sCAC8B,CAAE,OAAO,CNiG1B,GAAO,CMhGpB,wEAAwC,CAAE,OAAO,CNzC1B,GAAO,CM0C9B,wBAAwC,CAAE,OAAO,CN+B1B,GAAO,CM9B9B,gBAAgC,CAAE,OAAO,CNa1B,GAAO,CMZtB,0BAA0C,CAAE,OAAO,CNnP1B,GAAO,CMoPhC,oBAAoC,CAAE,OAAO,CNgI1B,GAAO,CM/H1B,iBAAiC,CAAE,OAAO,CN9E1B,GAAO,CM+EvB,4DAEqC,CAAE,OAAO,CNmG1B,GAAO,CMlG3B,iDACyC,CAAE,OAAO,CN3K1B,GAAO,CM4K/B,gBAAgC,CAAE,OAAO,CN6H1B,GAAO,CM5HtB,iBAAiC,CAAE,OAAO,CNjL1B,GAAO,CMkLvB,iBAAiC,CAAE,OAAO,CNxC1B,GAAO,CMyCvB,wBAAwC,CAAE,OAAO,CNxC1B,GAAO,CMyC9B,6BAA6C,CAAE,OAAO,CNuC1B,GAAO,CMtCnC,sBAAsC,CAAE,OAAO,CNqC1B,GAAO,CMpC5B,oBAAoC,CAAE,OAAO,CNlR1B,GAAO,CMmR1B,eAA+B,CAAE,OAAO,CNhR1B,GAAO,CMiRrB,qBAAqC,CAAE,OAAO,CNxE1B,GAAO,CMyE3B,yBAAyC,CAAE,OAAO,CNxE1B,GAAO,CMyE/B,iBAAiC,CAAE,OAAO,CN7Q1B,GAAO,CM8QvB,iBAAiC,CAAE,OAAO,CN3J1B,GAAO,CM4JvB,mBAAmC,CAAE,OAAO,CNtJ1B,GAAO,CMuJzB,cAA8B,CAAE,OAAO,CNtP1B,GAAO,CMuPpB,mBAAmC,CAAE,OAAO,CN3W1B,GAAO,CM4WzB,gBAAgC,CAAE,OAAO,CNjU1B,GAAO,CMkUtB,cAA8B,CAAE,OAAO,CN1F1B,GAAO,CM2FpB,gBAAgC,CAAE,OAAO,CNM1B,GAAO,CMLtB,eAA+B,CAAE,OAAO,CNrS1B,GAAO,CMsSrB,gBAAgC,CAAE,OAAO,CNrS1B,GAAO,CMsStB,kBAAkC,CAAE,OAAO,CNtY1B,GAAO,CMuYxB,yBAAyC,CAAE,OAAO,CNtY1B,GAAO,CMuY/B,gBAAgC,CAAE,OAAO,CNa1B,GAAO,CMZtB,uBAAuC,CAAE,OAAO,CNa1B,GAAO,CMZ7B,kBAAkC,CAAE,OAAO,CN/D1B,GAAO,CMgExB,oCAC8B,CAAE,OAAO,CN5W1B,GAAO,CM6WpB,8BAC+B,CAAE,OAAO,CN2B1B,GAAO,CM1BrB,eAA+B,CAAE,OAAO,CNoD1B,GAAO,CMnDrB,kBAAkC,CAAE,OAAO,CNN1B,GAAO,CMOxB,qBAAqC,CAAE,OAAO,CNzS1B,GAAO,CM0S3B,qBAAqC,CAAE,OAAO,CNZ1B,GAAO,CMa3B,mBAAmC,CAAE,OAAO,CN/S1B,GAAO,CMgTzB,qBAAqC,CAAE,OAAO,CNhQ1B,GAAO,CMiQ3B,sBAAsC,CAAE,OAAO,CNzP1B,GAAO,CM0P5B,uBAAuC,CAAE,OAAO,CNtQ1B,GAAO,CMuQ7B,4BAA4C,CAAE,OAAO,CNhQ1B,GAAO,CMiQlC,yEAEuC,CAAE,OAAO,CNzQ1B,GAAO,CM0Q7B,+CACyC,CAAE,OAAO,CN/Q1B,GAAO,CMgR/B,+CACuC,CAAE,OAAO,CNhR1B,GAAO,CMiR7B,+CACuC,CAAE,OAAO,CNrQ1B,GAAO,CMsQ7B,sBAAsC,CAAE,OAAO,CNlR1B,GAAO,CMmR5B,eAA+B,CAAE,OAAO,CN4D1B,GAAO,CM3DrB,kBAAkC,CAAE,OAAO,CNrV1B,GAAO,CMsVxB,mBAAmC,CAAE,OAAO,CNhM1B,GAAO,CMiMzB,uGAIoC,CAAE,OAAO,CNtL1B,GAAO,CMuL1B,yBAAyC,CAAE,OAAO,CNvW1B,GAAO,CMwW/B,8BACgC,CAAE,OAAO,CNlG1B,GAAO,CMmGtB,+BACiC,CAAE,OAAO,CN1T1B,GAAO,CM2TvB,qBAAqC,CAAE,OAAO,CNpP1B,GAAO,CMqP3B,cAA8B,CAAE,OAAO,CNtP1B,GAAO,CMuPpB,sBAAsC,CAAE,OAAO,CNxO1B,GAAO,CMyO5B,wBAAwC,CAAE,OAAO,CNR1B,GAAO,CMS9B,aAA6B,CAAE,OAAO,CNjH1B,GAAO,CMkHnB,mCACiC,CAAE,OAAO,CNiD1B,GAAO,CMhDvB,sCACsC,CAAE,OAAO,CNrJ1B,GAAO,CMsJ5B,0CACwC,CAAE,OAAO,CNtJ1B,GAAO,CMuJ9B,kBAAkC,CAAE,OAAO,CNvO1B,GAAO,CMwOxB,sBAAsC,CAAE,OAAO,CNvX1B,GAAO,CMwX5B,iBAAiC,CAAE,OAAO,CN7O1B,GAAO,CM8OvB,oBAAoC,CAAE,OAAO,CNxJ1B,GAAO,CMyJ1B,kBAAkC,CAAE,OAAO,CNvE1B,GAAO,CMwExB,oBAAoC,CAAE,OAAO,CNtF1B,GAAO,CMuF1B,2BAA2C,CAAE,OAAO,CNtF1B,GAAO,CMuFjC,eAA+B,CAAE,OAAO,CNnb1B,GAAO,CMobrB,4CACmC,CAAE,OAAO,CNjR1B,GAAO,CMkRzB,cAA8B,CAAE,OAAO,CNI1B,GAAO,CMHpB,qBAAqC,CAAE,OAAO,CN9b1B,GAAO,CM+b3B,eAA+B,CAAE,OAAO,CN5I1B,GAAO,CM6IrB,qBAAqC,CAAE,OAAO,CN/E1B,GAAO,CMgF3B,iBAAiC,CAAE,OAAO,CNI1B,GAAO,CMHvB,eAA+B,CAAE,OAAO,CNuC1B,GAAO,CMtCrB,sBAAsC,CAAE,OAAO,CN7K1B,GAAO,CM8K5B,eAA+B,CAAE,OAAO,CN6B1B,GAAO,CM5BrB,qBAAqC,CAAE,OAAO,CNjb1B,GAAO,CMkb3B,iBAAiC,CAAE,OAAO,CNpK1B,GAAO,CMqKvB,wBAAwC,CAAE,OAAO,CNzQ1B,GAAO,CM0Q9B,kBAAkC,CAAE,OAAO,CNha1B,GAAO,CMiaxB,wBAAwC,CAAE,OAAO,CNpa1B,GAAO,CMqa9B,sBAAsC,CAAE,OAAO,CNta1B,GAAO,CMua5B,kBAAkC,CAAE,OAAO,CNxa1B,GAAO,CMyaxB,oBAAoC,CAAE,OAAO,CNta1B,GAAO,CMua1B,oBAAoC,CAAE,OAAO,CNta1B,GAAO,CMua1B,qBAAqC,CAAE,OAAO,CNjd1B,GAAO,CMkd3B,uBAAuC,CAAE,OAAO,CNjd1B,GAAO,CMkd7B,gBAAgC,CAAE,OAAO,CNtB1B,GAAO,CMuBtB,oBAAoC,CAAE,OAAO,CN9X1B,GAAO,CM+X1B,aAA6B,CAAE,OAAO,CNne1B,GAAO,CMoenB,qBAAqC,CAAE,OAAO,CNtV1B,GAAO,CMuV3B,sBAAsC,CAAE,OAAO,CN1L1B,GAAO,CM2L5B,wBAAwC,CAAE,OAAO,CNpd1B,GAAO,CMqd9B,qBAAqC,CAAE,OAAO,CNzf1B,GAAO,CM0f3B,oBAAoC,CAAE,OAAO,CN7K1B,GAAO,CM8K1B,qBAAqC,CAAE,OAAO,CNzO1B,GAAO,CM0O3B,iBAAiC,CAAE,OAAO,CNtP1B,GAAO,CMuPvB,wBAAwC,CAAE,OAAO,CNtP1B,GAAO,CMuP9B,qBAAqC,CAAE,OAAO,CNrC1B,GAAO,CMsC3B,oBAAoC,CAAE,OAAO,CNrC1B,GAAO,CMsC1B,kBAAkC,CAAE,OAAO,CN9d1B,GAAO,CM+dxB,cAA8B,CAAE,OAAO,CN5c1B,GAAO,CM6cpB,kBAAkC,CAAE,OAAO,CNtQ1B,GAAO,CMuQxB,oBAAoC,CAAE,OAAO,CN9gB1B,GAAO,CM+gB1B,aAA6B,CAAE,OAAO,CN/b1B,GAAO,CMgcnB,kDAE8B,CAAE,OAAO,CNpR1B,GAAO,CMqRpB,mBAAmC,CAAE,OAAO,CN/N1B,GAAO,COtUzB,swBAAK,CACH,WAAW,CAAE,OAAO,CACpB,y5BAAQ,CACN,WAAW,CC+BuB,aAAa,CD9B/C,OAAO,CAAE,YAAY,CACrB,UAAU,CAAE,MAAM,CAClB,WAAW,CAAE,MAAM,CACnB,WAAW,CAAE,CAAC,CACd,eAAe,CAAE,OAAO,CAM5B,86BAAkB,CAChB,OAAO,CAAE,YAAY,CACrB,eAAe,CAAE,OAAO,CAGxB,muEAAgB,CACd,OAAO,CAAE,MAAM,CACf,2wEAAuB,CACrB,WAAW,CAAE,KAAI,CACnB,utEAAsB,CACpB,OAAO,CAAE,YAAY,CAE3B,2iBAA2B,CACzB,OAAO,CAAE,GAAE,CfpBL,kBAAoB,CAAE,qBAAM,CAK5B,eAAiB,CAAE,qBAAM,CAezB,UAAY,CAAE,qBAAM,CeE5B,+nBAAiC,CAC/B,OAAO,CAAE,CAAC,CAGV,mtCAAuB,CACrB,SAAS,CAAE,IAAI,CACf,cAAc,CAAE,IAAI,CEpBxB,0PAAS,CACP,OAAO,CAAE,IAAqB,CAC9B,WAAW,CDayB,IAAI,CCZxC,aAAa,CDYuB,IAAI,CCXxC,UAAU,CAAE,OAAmB,CAEjC,8CAAe,CACb,KAAK,CCY+B,IAAM,CDX1C,WAAW,CAAE,IAAI,CACjB,OAAO,CAAE,KAAK,CACd,KAAK,CCS+B,IAAM,CDR1C,UAAU,CAAE,OAAkB,CAC9B,MAAM,CAAE,KAAsB,CAC9B,OAAO,CAAE,QAA2C,CACpD,aAAa,CAAE,IAAqB,CAEtC,0ZAAyB,CACvB,UAAU,CAAE,OAAkB,CAC9B,mxCAAe,CACb,UAAU,CAAE,OAAiB,CACjC,kYAA0B,CACxB,UAAU,CAAE,OAAmB,CAC/B,ouCAAe,CACb,UAAU,CAAE,OAAoB,CAEpC,sYAAuB,CACrB,UAAU,CAAE,OAAmB,CAC/B,yuCAAe,CACb,UAAU,CAAE,OAAkB,CAElC,mZAA0B,CACxB,UAAU,CAAE,OAAuB,CACnC,swCAAe,CACb,UAAU,CAAE,OAAqB,CAErC,scAA0B,CACxB,UAAU,CCL0B,OAAmB,CDMvD,42CAAe,CACb,KAAK,CCvB6B,OAAW,CDwB7C,UAAU,CCNwB,OAAmB,CDOvD,8dAAC,CACC,KAAK,CChB6B,OAAK,CDkB3C,sZAAsB,CACpB,aAAa,CAAE,CAAC,CAsBlB,kBAAkB,CAChB,QAAQ,CAAE,KAAK,CACf,MAAM,CAAE,GAAG,CACX,IAAI,CAAE,CAAC,CACP,OAAO,CDG6B,GAAG,CCFvC,qBAAE,CACA,OAAO,CAAE,KAAK,CACd,KAAK,CDT6B,KAAK,CCUvC,UAAU,CAAE,WAAW,CACvB,KAAK,CCxD6B,IAAM,CDyDxC,UAAU,CAAE,MAAM,CAClB,UAAU,CAAE,2BAA0B,CACtC,OAAO,CAAE,MAAmB,CAC5B,SAAS,CAAE,GAAG,CACd,OAAO,CAAE,CAAC,CACV,MAAM,CAAE,CAAC,CACT,WAAW,CAAE,IAAI,CACjB,QAAQ,CAAE,MAAM,CjB3FZ,kBAAoB,CAAE,gBAAM,CAK5B,eAAiB,CAAE,gBAAM,CAezB,UAAY,CAAE,gBAAM,CiByExB,0CAAsB,CACpB,UAAU,CC5FsB,OAAM,CD6FxC,uCAAmB,CACjB,UAAU,CC/DsB,OAAK,CDgEvC,0CAAsB,CACpB,UAAU,CDnFsB,OAAO,CCoFzC,yCAAqB,CACnB,UAAU,CDtEsB,OAAI,CCuEtC,wBAAI,CACF,OAAO,CAAE,CAAC,CACV,MAAM,CAAE,IAAI,CEhFd,oCAAsB,CFmFxB,kBAAkB,CAChB,MAAM,CAAE,IAAI,CACZ,GAAG,CAAE,CAAC,CACN,KAAK,CAAE,IAAI,CACX,qBAAE,CACA,KAAK,CAAE,IAAI,EG3FjB,MAAM,CACJ,SAAS,CAAE,IAAI,CACf,MAAM,CAAE,CAAC,CACT,cAAc,CAAE,QAAQ,CACxB,eAAe,CAAE,MAAM,CACvB,MAAM,CAAE,OAAO,CACf,WAAW,CAAE,MAAM,CACnB,kBAAkB,CAAE,MAAM,CAC1B,SAAS,CAAE,OAAO,CACpB,gDAAiD,CAC/C,MAAM,CAAE,CAAC,CACT,OAAO,CAAE,CAAC,CACZ,gBAAgB,CACd,MAAM,CAAE,OAAO,CAEjB,IAAI,CAEF,OAAO,CAAE,YAAY,CACrB,aAAa,CAAE,GAAG,CAClB,WAAW,CAAE,MAAM,CACnB,WAAW,CAAE,MAAM,CACnB,UAAU,CAAE,MAAM,CAClB,MAAM,CAAE,OAAO,CACf,SAAS,CAAE,IAAI,CACf,OAAO,CAAE,iBAA6F,CACtG,KAAK,CFlB+B,IAAM,CEmB1C,MAAM,CAAE,yBAAyB,CACjC,gBAAgB,CF7CoB,OAAM,CE8C1C,eAAe,CAAE,IAAI,CACrB,WAAW,CAAE,MAAM,CACnB,WAAW,CFJyB,uDAAM,CEK1C,UAAU,CAAE,mFAA8C,CAC1D,YAAY,CAAE,KAAK,CACnB,cAAc,CAAE,MAAM,CACtB,QAAQ,CAAE,MAAM,CAChB,IAAI,CAAE,CAAC,CACP,iBAAiB,CAAE,IAAI,CpBxDjB,mBAAoB,CoByDb,IAAI,CpBpDX,gBAAiB,CoBoDV,IAAI,CpB/CX,eAAgB,CoB+CT,IAAI,CpBrCX,WAAY,CoBqCL,IAAI,CpBzDX,kBAAoB,CAAE,eAAM,CAK5B,eAAiB,CAAE,eAAM,CAezB,UAAY,CAAE,eAAM,CoByC5B,UAAU,CACR,UAAU,CAAE,OAAwB,CACpC,KAAK,CFpC+B,IAAM,CEuC1C,UAAO,CACL,UAAU,CAAE,OAAqC,CACjD,KAAK,CFzC6B,IAAM,CE0C1C,UAAO,CACL,UAAU,CAAE,OAAqC,CACjD,OAAO,CAAE,CAAC,CACZ,WAAQ,CACN,UAAU,CAAE,6EAAyC,CACrD,OAAO,CAAE,iBAA6F,CACxG,YAAS,CACP,KAAK,CFjD6B,IAAM,CEkD1C,aAAU,CACR,gBAAgB,CAAE,IAAI,CACtB,MAAM,CAAE,2DAA2D,CACnE,MAAM,CAAE,iBAAmB,CAC3B,OAAO,CAAE,GAAG,CACZ,MAAM,CAAE,WAAW,CACnB,UAAU,CAAE,IAAI,CAEpB,aAAa,CACX,gBAAgB,CAAE,IAAI,CACtB,MAAM,CAAE,2DAA2D,CACnE,MAAM,CAAE,iBAAmB,CAC3B,OAAO,CAAE,GAAG,CACZ,MAAM,CAAE,WAAW,CACnB,UAAU,CAAE,IAAI,CAChB,4DAA0B,CACxB,gBAAgB,CAAE,IAAI,CACtB,MAAM,CAAE,2DAA2D,CACnE,MAAM,CAAE,iBAAmB,CAC3B,OAAO,CAAE,GAAI,CACb,MAAM,CAAE,WAAW,CACnB,UAAU,CAAE,IAAI,CAGpB,sBAAsB,CACpB,OAAO,CAAE,CAAC,CACV,MAAM,CAAE,CAAC,CAEX,UAAU,CACR,SAAS,CAAE,GAAG,CAEhB,SAAS,CACP,gBAAgB,CAAE,kBAAgB,CAClC,eAAO,CACL,gBAAgB,CAAE,kBAA6B,CAEnD,YAAY,CACV,gBAAgB,CAAE,kBAA2C,CAC7D,KAAK,CAAE,kBAAsB,CAC7B,kBAAO,CACL,gBAAgB,CAAE,kBAAuD,CACzE,KAAK,CF/F6B,OAAW,CEgG/C,oBAAS,CACP,KAAK,CAAE,kBAAsB,CAEjC,YAAY,CACV,gBAAgB,CAAE,kBAAiB,CACnC,kBAAO,CACL,gBAAgB,CAAE,eAA6B,CAEnD,WAAW,CACT,gBAAgB,CAAE,kBAAe,CACjC,iBAAO,CACL,gBAAgB,CAAE,kBAA4B,CAElD,YAAY,CACV,gBAAgB,CAAE,kBAAkB,CACpC,kBAAO,CACL,gBAAgB,CAAE,kBAA+B,CACrD,WAAW,CACT,gBAAgB,CJvIoB,IAAI,CIwIxC,iBAAO,CACL,gBAAgB,CAAE,kBAAoC,CAE1D,SAAS,CACP,gBAAgB,CAAE,sBAAsB,CACxC,KAAK,CF9G+B,OAAK,CE+GzC,UAAU,CAAE,IAAI,CAChB,YAAY,CAAE,sBAAsB,CACpC,eAAO,CACL,gBAAgB,CAAE,sBAAsB,CACxC,KAAK,CAAE,kBAAoC,CAC3C,UAAU,CAAE,IAAI,CAClB,gBAAQ,CACN,gBAAgB,CAAE,sBAAsB,CACxC,KAAK,CAAE,kBAAoC,CAC3C,UAAU,CAAE,IAAI,CAClB,iBAAS,CACP,KAAK,CFzH6B,OAAO,CE2H7C,mCAAoC,CAClC,cAAc,CAAE,MAAM,CAExB,aAAa,CACX,aAAa,CJ1IuB,IAAI,CduExC,KAAK,CAAE,CAAC,CACR,wCAAS,CAEP,OAAO,CAAE,KAAK,CACd,OAAO,CAAE,EAAE,CACb,mBAAO,CACL,KAAK,CAAE,IAAI,CmB3Ff,YAAY,CACV,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,YAAY,CAIvB,qCAAqC,CACnC,OAAO,CAAE,KAAK,CAChB,iBAAiB,CACf,QAAQ,CAAE,QAAQ,CAClB,IAAI,CAAE,CAAC,CACP,OAAO,CAAE,IAAI,CACb,KAAK,CAAE,IAAI,CACX,GAAG,CAAE,IAAI,CACT,SAAS,CAAE,IAAI,CACf,UAAU,CHQ0B,OAAyB,CGP7D,OAAO,CLmD6B,GAAG,CKlDvC,MAAM,CAAE,iBAAgC,CACxC,UAAU,CAAE,2BAA0B,CACtC,OAAO,CAAE,IAAqB,CAC9B,sBAAQ,CACN,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,IAAI,CACX,KAAK,CHT6B,OAAW,CGU7C,WAAW,CAAE,MAAM,CACnB,SAAS,CAAE,GAAG,CACd,OAAO,CAAE,MAAuB,CAChC,MAAM,CAAE,OAAO,CACf,4BAAO,CACL,UAAU,CHLsB,OAAK,CGMrC,KAAK,CHZ2B,IAAM,CGa1C,4BAAY,CACV,UAAU,CAAE,iBAAgC,CAC5C,MAAM,CAAE,KAAuB,CACjC,2BAAW,CACT,cAAc,CAAE,IAAqB,CACrC,gDAAoB,CAClB,KAAK,CAAE,IAAI,CACf,mCAAmB,CACjB,UAAU,CAAE,OAA4B,CACxC,cAAc,CAAE,SAAS,CACzB,WAAW,CAAE,GAAG,CAChB,SAAS,CAAE,GAAG,CACd,yCAAO,CACL,UAAU,CAAE,OAA4B,CAC1C,wCAAI,CACF,KAAK,CH5B2B,IAAM,CG8B5C,6CAA6C,CAC3C,MAAM,CAAE,IAAI,CACZ,GAAG,CAAE,IAAI,CACT,IAAI,CAAE,IAAI,CACV,KAAK,CAAE,CAAC,CAGR,iDAAiB,CACf,UAAU,CHjCwB,OAAyB,CGkC3D,UAAU,CAAE,GAAG,CACjB,mDAAmB,CACjB,OAAO,CAAE,QAA2C,CACpD,yDAAO,CACL,UAAU,CHrCsB,OAAK,CGsCrC,KAAK,CH5C2B,IAAM,CG8C5C,+CAA+C,CAC7C,KAAK,CAAE,CAAC,CACR,IAAI,CAAE,IAAI,CACV,UAAU,CAAE,KAAK,CAGjB,yBAAQ,CACN,OAAO,CAAE,GAAG,CACZ,aAAa,CAAE,iBAA0B,CACzC,WAAW,CAAE,qBAAqB,CAClC,YAAY,CAAE,qBAAqB,CACnC,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,KAAK,CACd,GAAG,CAAE,IAAI,CACT,IAAI,CAAE,GAAG,CACT,WAAW,CAAE,IAAI,CACnB,gDAA+B,CAC7B,IAAI,CAAE,IAAI,CCtEZ,uBAAM,CACJ,OAAO,CAAE,KAAK,CAEhB,gIAA+C,CAC7C,OAAO,CAAE,YAAY,CACrB,QAAQ,CAAE,MAAM,CAChB,KAAK,CAAE,CAAC,CACR,cAAc,CAAE,MAAM,CAItB,wCAAO,CACL,OAAO,CAAE,YAAY,CACrB,cAAc,CAAE,MAAM,CACtB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,YAA+C,CACvD,KAAK,CAAE,IAAI,CACf,4BAAW,CACT,KAAK,CAAE,IAAI,CACX,kCAAK,CACH,OAAO,CAAE,KAAK,CAChB,mCAAM,CACJ,UAAU,CAAE,GAAqB,CAEvC,QAAQ,CACN,MAAM,CAAE,CAAC,CACT,MAAM,CAAE,CAAC,CACT,OAAO,CAAE,CAAC,CACZ,MAAM,CACJ,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,CAAC,CACT,OAAO,CAAE,CAAC,CACV,WAAW,CAAE,MAAM,CACnB,aAAa,CN/BuB,IAAI,CMgCxC,SAAS,CAAE,IAAI,CACf,YAAY,CAAE,IAAI,CACpB,KAAK,CACH,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,cAAa,CACrB,KAAK,CNR+B,IAAU,CMS9C,SAAS,CAAE,GAAG,CAEhB,qBAAuB,CACrB,SAAS,CAAE,IAAI,CACf,MAAM,CAAE,CAAC,CACT,cAAc,CAAE,QAAQ,CACxB,eAAe,CAAE,MAAM,CAGzB,iBAAiB,CACf,aAAa,CNhDuB,IAAI,CduExC,KAAK,CAAE,CAAC,CqBrGR,SAAS,CCCC,IAAQ,CDChB,WAAI,CAAE,IAAI,CACV,YAAK,CAAE,IAAI,CrBkGb,KAAK,CAAE,CAAC,CACR,gDAAS,CAEP,OAAO,CAAE,KAAK,CACd,OAAO,CAAE,EAAE,CACb,uBAAO,CACL,KAAK,CAAE,IAAI,CALb,gDAAS,CAEP,OAAO,CAAE,KAAK,CACd,OAAO,CAAE,EAAE,CACb,uBAAO,CACL,KAAK,CAAE,IAAI,CoBzBf,uDAAyD,CACvD,OAAO,CAAE,IAAI,CACb,KAAK,CN/C+B,OAAI,CMoDxC,mGAA+C,CAC7C,cAAc,CAAE,IAAqB,CACrC,wHAAM,CACJ,KAAK,CAAE,IAAI,CAEX,0tEAAqP,CACnP,KAAK,CAAE,IAAI,CACnB,+BAA+B,CGlF3B,KAAK,CAAE,IAAsB,CAG3B,OAAO,CAAE,KAAK,CAed,YAAoB,CAAE,QAA+B,CACrD,KAAK,CAAE,IAAuC,CCnB5C,YAAoB,CAAE,CAAC,CDqBzB,0CAAa,CACX,YAAoB,CAAE,CAAC,CHgE/B,iCAAiC,CGtF7B,KAAK,CAAE,IAAsB,CAG3B,OAAO,CAAE,KAAK,CAed,YAAoB,CAAE,QAA+B,CACrD,KAAK,CAAE,SAAuC,CAE9C,4CAAa,CACX,YAAoB,CAAE,CAAC,CCA7B,iDAAwB,CACtB,YAAoB,CAAE,CAAC,CAEvB,mDAA0B,CACxB,KAAK,CALY,IAAkC,CJqEzD,iCAAiC,CG1F7B,KAAK,CAAE,IAAsB,CAG3B,OAAO,CAAE,KAAK,CAed,YAAoB,CAAE,QAA+B,CACrD,KAAK,CAAE,SAAuC,CAE9C,4CAAa,CACX,YAAoB,CAAE,CAAC,CCA7B,iDAAwB,CACtB,YAAoB,CAAE,CAAC,CAEvB,mDAA0B,CACxB,KAAK,CALY,IAAkC,CJ0EzD,uDAAuD,CACrD,MAAM,CAAE,SAA2B,CACnC,SAAS,CAAE,GAAG,CAEhB,oBAAoB,CAClB,OAAO,CAAE,YAAY,CACrB,MAAM,CAAE,SAA2B,CACnC,SAAS,CAAE,GAAG,CAOZ,osBAAqP,CACnP,KAAK,CAAE,IAAI,CAIjB,uBAAuB,CACrB,OAAO,CAAE,YAAY,CACrB,YAAY,CAAE,KAAK,CACnB,KAAK,CAAE,IAAI,CACX,cAAc,CAAE,MAAM,CACtB,SAAS,CAAE,GAAG,CAEhB,gBAAgB,CACd,OAAO,CAAE,KAAK,CACd,KAAK,CJxH+B,IAAW,CIyH/C,SAAS,CAAE,GAAG,CACd,UAAU,CAAE,QAAO,CACnB,UAAU,CAAE,MAAM,CAClB,kBAAC,CACC,SAAS,CAAE,OAAO,CAClB,UAAU,CAAE,MAAM,CAClB,aAAa,CAAE,GAAqB,CACtC,6BAAY,CACV,aAAa,CAAE,CAAC,CA4DpB,KAAK,CACH,WAAW,CAAE,MAAM,CAGnB,6DAAmD,CACjD,kBAAkB,CAAE,MAAM,CAC1B,MAAM,CAAE,OAAO,CACf,WAAW,CJhKuB,uDAAM,CIiKxC,SAAS,CAAE,OAAO,CACpB,gSAAqP,CACnP,kBAAkB,CAAE,IAAI,CACxB,OAAO,CAAE,GAAqB,CAC9B,OAAO,CAAE,YAAY,CACrB,MAAM,CAAE,cAA6B,CACrC,SAAS,CAAE,GAAG,CACd,WAAW,CJxKuB,uDAAM,CIyKxC,UAAU,CAAE,oBAAmC,CAC/C,aAAa,CAAE,CAAC,CtBxNZ,kBAAoB,CAAE,kBAAM,CAK5B,eAAiB,CAAE,kBAAM,CAezB,UAAY,CAAE,kBAAM,CsBuM1B,4BAAwB,CACtB,OAAO,CAAE,iBAAkB,CAC7B,eAAW,CACT,MAAM,CAAE,OAAO,CACjB,0CAAmC,CtB/N7B,kBAAoB,CsBgOZ,UAAU,CtB3NlB,eAAiB,CsB2NT,UAAU,CtB5MlB,UAAY,CsB4MJ,UAAU,CACtB,OAAO,CAAE,CAAC,CACV,YAAY,CAAE,QAAO,CACrB,OAAO,CAAE,IAAI,CACb,MAAM,CAAE,IAAI,CACd,oBAAgB,CtBrOV,kBAAoB,CsBsOZ,UAAU,CtBjOlB,eAAiB,CsBiOT,UAAU,CtBlNlB,UAAY,CsBkNJ,UAAU,CACtB,kGAA6D,CAC3D,kBAAkB,CAAE,IAAI,CAC5B,oXAAyU,CACvU,OAAO,CAAE,CAAC,CACV,OAAO,CAAE,cAAc,CACvB,YAAY,CNxLsB,IAAU,CMyL9C,oBAAgB,CACd,YAAY,CAAE,eAA8B,CAC9C,+EAAqE,CACnE,OAAO,CAAE,gBAAsB,CAC/B,OAAO,CAAE,gBAAgB,CAC3B,4aAAiY,CAC/X,MAAM,CAAE,WAAW,CACnB,gBAAgB,CAAE,OAAmC,CAEzD,+DAAiE,CAC/D,KAAK,CNzN+B,OAAI,CM0NxC,MAAM,CAAE,iBAAc,CACxB,iFAAmF,CACjF,YAAY,CN5NwB,OAAI,CM8NxC,yHAA+G,CAC7G,aAAa,CN/NqB,OAAI,CMiO1C,oBAAoB,CAClB,OAAO,CAAE,IAAqB,CAC9B,SAAS,CAAE,IAAI,CAKjB,QAAQ,CACN,QAAQ,CAAE,IAAI,CACd,cAAc,CAAE,GAAG,CACnB,KAAK,CAAE,IAAI,CACX,WAAW,CJ5NyB,uDAAM,CI6N5C,eAAgB,CACd,OAAO,CAAE,aAAgB,CACzB,OAAO,CAAE,YAAY,CACrB,MAAM,CAAE,cAA6B,CACrC,SAAS,CAAE,GAAG,CACd,UAAU,CAAE,oBAAmC,CtBhRzC,kBAAoB,CAAE,kBAAM,CAK5B,eAAiB,CAAE,kBAAM,CAezB,UAAY,CAAE,kBAAM,CsB+P5B,MAAM,CACJ,MAAM,CAAE,cAA6B,CACrC,gBAAgB,CJ1PoB,IAAM,CI2P1C,gBAAW,CACT,MAAM,CAAE,IAAI,CAChB,2BAA4B,CAC1B,OAAO,CAAE,CAAC,CACZ,uFAA2F,CACzF,MAAM,CAAE,WAAW,CACnB,gBAAgB,CAAE,OAAmC,CAKrD,8DAAuD,CACrD,MAAM,CAAE,WAAW,CACvB,sBAAuB,CACrB,MAAM,CAAE,KAAuB,CAE/B,KAAK,CJ/Q+B,OAAW,CIgR/C,OAAO,CAAE,KAAK,CACd,kCAAK,CACH,cAAc,CAAE,QAAQ,CAI5B,uBAAuB,CACrB,OAAO,CAAE,YAAY,CACrB,QAAQ,CAAE,MAAM,CAChB,KAAK,CAAE,CAAC,CACR,cAAc,CAAE,MAAM,CAuBxB,iCAAkC,CAChC,WAAW,CAAE,MAAM,CACnB,OAAO,CAAE,GAAqB,CAC9B,qEAAiB,CACf,WAAW,CAAE,IAAI,CACjB,OAAO,CAAE,KAAK,CACd,OAAO,CAAE,YAAY,CACrB,SAAS,CAAE,GAAG,CACd,gBAAgB,CJzSkB,OAAmB,CI0SrD,MAAM,CAAE,cAA6B,CACrC,KAAK,CJxU6B,IAAW,CI0UjD,kCAAkC,CAChC,WAAW,CAAE,CAAC,CAChB,kCAAkC,CAChC,YAAY,CAAE,CAAC,CAcjB,UAAU,CACR,KAAK,CAAE,IAAuB,CAC9B,MAAM,CAAE,IAAqB,CAC7B,MAAM,CAAE,MAAwB,CAChC,QAAQ,CAAE,QAAQ,CAClB,aAAa,CAAE,GAAG,CAClB,UAAU,CNrW0B,IAAI,CMsWxC,MAAM,CAAE,OAAO,CtB5WT,kBAAoB,CAAE,oBAAM,CAK5B,eAAiB,CAAE,oBAAM,CAezB,UAAY,CAAE,oBAAM,CsB0V1B,iBAAQ,CACN,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,EAAE,CACX,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,aAAa,CAAE,GAAG,CAClB,UAAU,CJ3WwB,IAAW,CI4W7C,IAAI,CAAE,IAAI,CACV,GAAG,CAAE,IAAI,CtBvXL,kBAAoB,CAAE,oBAAM,CAK5B,eAAiB,CAAE,oBAAM,CAezB,UAAY,CAAE,oBAAM,CsBqW1B,gBAAO,CACL,OAAO,CAAE,OAAO,CAChB,QAAQ,CAAE,QAAQ,CAClB,IAAI,CAAE,IAAqB,CAC3B,OAAO,CAAE,KAAK,CACd,SAAS,CAAE,IAAI,CACf,KAAK,CNzX6B,IAAI,CM0X1C,iBAAiB,CACf,UAAU,CAAE,OAAmB,CAC/B,wBAAQ,CACN,IAAI,CN5W8B,IAAI,CM6WtC,UAAU,CJlYwB,OAAM,CImY1C,uBAAO,CACL,OAAO,CAAE,MAAM,CAEnB,8CAA+C,CAC7C,MAAM,CAAE,WAAW,CAiDnB,wGAAyB,CACvB,KAAK,CN7Z6B,OAAI,CM+ZtC,81BAAqP,CACnP,MAAM,CAAE,iBAAc,CAC1B,iDAAQ,CACN,MAAM,CAAE,iBAAc,CAE1B,mBAAmB,CACjB,WAAW,CAAE,MAAM,CACnB,qCAAiB,CACf,OAAO,CAAE,aAAgB,CACzB,OAAO,CAAE,YAAY,CACrB,SAAS,CAAE,GAAG,CAClB,gEAAgE,CAC9D,KAAK,CJvc+B,OAAM,CI0c5C,+DAA+D,CAC7D,KAAK,CN/a+B,OAAI,CMkb1C,gEAAgE,CAC9D,KAAK,CNlc+B,OAAO,CMqc7C,6DAA6D,CAC3D,KAAK,CJpb+B,OAAK,CI0b3C,UAAU,CtB3dF,iBAAoB,CAAE,aAAM,CAK5B,cAAiB,CAAE,aAAM,CAKzB,aAAgB,CAAE,aAAM,CAKxB,YAAe,CAAE,aAAM,CAKvB,SAAY,CAAE,aAAM,CsByc5B,WAAW,CtB7dH,iBAAoB,CAAE,cAAM,CAK5B,cAAiB,CAAE,cAAM,CAKzB,aAAgB,CAAE,cAAM,CAKxB,YAAe,CAAE,cAAM,CAKvB,SAAY,CAAE,cAAM,CsB2c5B,WAAW,CtB/dH,iBAAoB,CAAE,cAAM,CAK5B,cAAiB,CAAE,cAAM,CAKzB,aAAgB,CAAE,cAAM,CAKxB,YAAe,CAAE,cAAM,CAKvB,SAAY,CAAE,cAAM,CsB6c5B,OAAO,CtBjeC,iBAAoB,CAAE,UAAM,CAK5B,cAAiB,CAAE,UAAM,CAKzB,aAAgB,CAAE,UAAM,CAKxB,YAAe,CAAE,UAAM,CAKvB,SAAY,CAAE,UAAM,CsB+c1B,iBAAW,CtBneL,iBAAoB,CsBoeL,wBAAwB,CtB/dvC,cAAiB,CsB+dF,wBAAwB,CtB1dvC,aAAgB,CsB0dD,wBAAwB,CtBrdvC,YAAe,CsBqdA,wBAAwB,CtBhdvC,SAAY,CsBgdG,wBAAwB,CAC7C,kBAAY,CtBreN,iBAAoB,CsBseL,yBAAyB,CtBjexC,cAAiB,CsBieF,yBAAyB,CtB5dxC,aAAgB,CsB4dD,yBAAyB,CtBvdxC,YAAe,CsBudA,yBAAyB,CtBldxC,SAAY,CsBkdG,yBAAyB,CAC9C,kBAAY,CtBveN,iBAAoB,CsBweL,yBAAyB,CtBnexC,cAAiB,CsBmeF,yBAAyB,CtB9dxC,aAAgB,CsB8dD,yBAAyB,CtBzdxC,YAAe,CsBydA,yBAAyB,CtBpdxC,SAAY,CsBodG,yBAAyB,CAEhD,yCAAyC,CAErC,8BAAqB,CACnB,MAAM,CAAE,SAAS,CAEjB,8ZAAqP,CACnP,aAAa,CAAE,KAAK,CACpB,OAAO,CAAE,KAAK,CAClB,cAAK,CACH,aAAa,CAAE,KAAK,CACpB,OAAO,CAAE,KAAK,CAEhB,kYAAqO,CACnO,aAAa,CAAE,CAAC,CAElB,wCAAuB,CACrB,aAAa,CAAE,KAAK,CACpB,UAAU,CAAE,IAAI,CAChB,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,IAAI,CACb,4BAAW,CACT,MAAM,CAAE,WAAW,CACvB,iEAAmE,CACjE,OAAO,CAAE,KAAK,CACd,SAAS,CAAE,GAAG,CACd,OAAO,CAAE,KAAuB,EH5ehC,oCAAsB,CQhC1B,YAAY,CAER,OAAO,CAAE,IAAI,ER8Bb,oCAAsB,CQ5B1B,YAAY,CAER,OAAO,CAAE,IAAI,EAEjB,WAAW,CACT,KAAK,CAAE,IAAI,CAEb,YAAY,CACV,KAAK,CAAE,KAAK,CAEd,WAAW,CACT,KAAK,CAAE,IAAI,CC4Cb,mEAAS,CACP,eAAe,CAAE,QAAQ,CACzB,cAAc,CAAE,CAAC,CACjB,WAAW,CAAE,IAAI,CACjB,aAAa,CZ/BuB,IAAI,CYgCxC,2FAAO,CACL,KAAK,CAAE,IAAI,CACX,IAAI,CAAE,6BAAkB,CACxB,OAAO,CAAE,KAAK,CACd,UAAU,CAAE,MAAM,CACpB,yJAAM,CACJ,SAAS,CZjByB,GAAG,CYkBrC,MAAM,CAAE,CAAC,CACT,QAAQ,CAAE,OAAO,CACjB,OAAO,CZnB2B,QAAmC,CYoBvE,iOAA8B,CAC5B,iBAAiB,CAAE,CAAC,CACtB,qFAAK,CACH,KAAK,CAAE,IAAI,CACX,UAAU,CAAE,IAAI,CAChB,cAAc,CAAE,MAAM,CACtB,WAAW,CAAE,MAAM,CACnB,8FAAE,CACA,WAAW,CZnDqB,IAAI,CYoDpC,aAAa,CAAE,iBAA6B,CAChD,4EAAE,CACA,gBAAgB,CAAE,WAAW,CAC7B,cAAc,CAAE,MAAM,CAE1B,kFAAc,CACZ,WAAW,CAAE,IAAuB,CACpC,mHAAY,CACV,aAAa,CAAE,CAAC,CACpB,4HAA4B,CAC1B,KAAK,CAAE,EAAE,CACT,aAAa,CAAE,CAAC,CAChB,uXAA0C,CACxC,MAAM,CAAE,CAAC,CAEb,mBAAmB,CACjB,KAAK,CVjE+B,IAAY,CUkEhD,SAAS,CAAE,GAAG,CAChB,kBAAkB,CAChB,KAAK,CVpE+B,IAAY,CUqEhD,SAAS,CAAE,GAAG,CAIhB,2HAAyD,CACvD,gBAAgB,CV5DoB,OAAmB,CU8DzD,gBAAgB,CACd,gBAAgB,CV/DoB,OAAmB,CUoEzD,kDAAsB,CACpB,MAAM,CAAE,iBAA6B,CACrC,wDAAE,CACA,aAAa,CAAE,iBAA6B,CAC5C,WAAW,CAAE,iBAA6B,CAC5C,gGAAwB,CACtB,mBAAmB,CAAE,CAAC,CAE1B,kBAAkB,CAChB,MAAM,CAAE,iBAA6B,CAGrC,0BAAE,CACA,aAAa,CAAE,iBAA6B,CAC9C,8CAAwB,CACtB,mBAAmB,CAAE,CAAC,CAGxB,2CAAwB,CACtB,mBAAmB,CAAE,CAAC,CACxB,+CAAM,CACJ,YAAY,CAAE,SAAS,CACvB,aAAa,CAAE,iBAA6B,CAC9C,2CAAwB,CACtB,mBAAmB,CAAE,CAAC,CAG1B,oBAAoB,CAClB,aAAa,CZhHuB,IAAI,CYiHxC,SAAS,CAAE,IAAI,CACf,QAAQ,CAAE,IAAI,CACd,0BAAK,CACH,aAAa,CAAE,YAAY,CAC3B,2DAAM,CACJ,WAAW,CAAE,MAAM,CCzIzB,CAAC,CACC,KAAK,CX4B+B,OAAK,CW3BzC,eAAe,CAAE,IAAI,CACrB,MAAM,CAAE,OAAO,CACf,OAAO,CACL,KAAK,CbgD6B,OAAwB,Ca/C5D,SAAS,CACP,KAAK,CXuB6B,OAAO,CWG7C,IAAI,CACF,MAAM,CAAE,IAAI,CACZ,UAAU,CAAE,MAAM,CAEpB,IAAI,CACF,WAAW,CXIyB,uDAAM,CWH1C,WAAW,CAAE,MAAM,CACnB,KAAK,CXrB+B,OAAW,CWsB/C,UAAU,CAAE,IAAI,CAChB,UAAU,CAAE,MAAM,CAClB,UAAU,CbnD0B,OAAO,CaqD7C,aAAa,CACX,UAAU,CAAE,IAAI,CAElB,eAAe,CACb,UAAU,CAAE,MAAM,CAEpB,cAAc,CACZ,UAAU,CAAE,KAAK,CAEnB,cAAc,CACZ,SAAS,CAAE,IAAI,CAEjB,eAAe,CACb,SAAS,CAAE,IAAI,CAEjB,oBAAqB,CACnB,SAAS,CAAE,GAAG,CAEhB,eAAe,CACb,eAAe,CAAE,YAAY,CAE/B,gBAAgB,CACd,KAAK,CAAE,kBAAkB,CAC3B,uBAAuB,CACrB,KAAK,CAAE,kBAAgC,CACzC,aAAa,CACX,KAAK,CAAE,kBAAgB,CACzB,oBAAoB,CAClB,KAAK,CAAE,kBAA8B,CACvC,gBAAgB,CACd,KAAK,CAAE,kBAAiB,CAC1B,uBAAuB,CACrB,KAAK,CAAE,kBAA+B,CACxC,eAAe,CACb,KAAK,CAAE,kBAAe,CACxB,sBAAsB,CACpB,KAAK,CAAE,kBAA6B,CACtC,gBAAgB,CACd,KAAK,CAAE,kBAAsB,CAC/B,uBAAuB,CACrB,KAAK,CAAE,kBAAoC,CAkB7C,gEAAyB,CACvB,UAAU,CAAE,CAAC,CACb,WAAW,CAAE,GAAG,CAChB,WAAW,CX/DyB,0DAAa,CWiEnD,CAAC,CACC,WAAW,Cb1FyB,IAAI,Ca2FxC,MAAM,CAAE,CAAC,CACT,SAAS,Cb/F2B,IAAI,CagGxC,aAAa,Cb7FuB,IAAI,Ca+F1C,EAAE,CACA,SAAS,CAAE,IAAI,CAEjB,0CAAE,CACA,SAAS,CAAE,IAAI,CAEjB,EAAE,CACA,SAAS,CAAE,IAAI,CAEjB,EAAE,CACA,SAAS,CAAE,IAAI,CAEjB,EAAE,CACA,SAAS,CAAE,IAAI,CAEjB,EAAE,CACA,SAAS,CAAE,IAAI,CAEjB,EAAE,CACA,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,GAAG,CACX,MAAM,CAAE,CAAC,CACT,UAAU,CAAE,iBAA6B,CACzC,MAAM,CAAE,MAAmB,CAC3B,OAAO,CAAE,CAAC,CAEZ,sCAAI,CACF,WAAW,CAAE,MAAM,CACnB,SAAS,CAAE,IAAI,CACf,UAAU,CXxH0B,IAAM,CWyH1C,MAAM,CAAE,iBAAiC,CACzC,SAAS,CAAE,GAAG,CACd,OAAO,CAAE,KAAK,CACd,WAAW,CXtGyB,wMAAQ,CWuG5C,KAAK,Cb1H+B,OAAI,Ca2HxC,UAAU,CAAE,IAAI,CAChB,0CAAY,CACV,SAAS,CAAE,GAAG,CAmClB,wFAAmB,CACjB,UAAU,CAAE,IAAI,CAChB,WAAW,CbzKyB,IAAI,Ca0KxC,aAAa,Cb1KuB,IAAI,Ca2KxC,oGAAE,CACA,UAAU,CAAE,IAAI,CAChB,WAAW,Cb7KuB,IAAI,Ca8KtC,wJAAY,CACV,aAAa,CAAE,CAAC,CAClB,gHAAE,CACA,aAAa,CAAE,CAAC,CAClB,gHAAE,CACA,UAAU,CAAE,MAAM,CAClB,4HAAE,CACA,UAAU,CAAE,MAAM,CACtB,4HAAK,CACH,UAAU,CAAE,OAAO,CAEzB,iFAAsB,CACpB,UAAU,CAAE,OAAO,CACnB,WAAW,Cb3LyB,IAAI,Ca4LxC,aAAa,Cb5LuB,IAAI,Ca6LxC,6FAAE,CACA,UAAU,CAAE,OAAO,CACnB,WAAW,Cb/LuB,IAAI,CagMtC,iJAAY,CACV,aAAa,CAAE,CAAC,CAClB,yGAAE,CACA,aAAa,CAAE,CAAC,CAChB,qHAAE,CACA,UAAU,CAAE,IAAI,CCrOxB,kBAAkB,CAChB,MAAM,CAAE,iBAA6B,CACrC,aAAa,CAAE,IAAI,CACnB,OAAO,Cd6B6B,IAAI,Cc5BxC,WAAW,CAAE,IAAqB,CAClC,WAAW,CAAE,GAAG,CAChB,UAAU,CZ8B0B,IAAM,CY7B1C,QAAQ,CAAE,QAAQ,CAClB,wBAAO,CACL,OAAO,CAAE,SAAS,CAClB,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,GAAG,CACR,IAAI,CAAE,GAAG,CACT,UAAU,CZ8BwB,OAAO,CY7BzC,KAAK,CAAE,IAAoB,CAC3B,OAAO,CAAE,QAA2C,CACtD,2CAA0B,CACxB,MAAM,CAAE,iBAA6B,CACrC,aAAa,CdcqB,IAAI,CcZ1C,+GAAmC,CACjC,MAAM,CAAE,iBAA6B,CACrC,OAAO,CAAE,GAAG,CACZ,UAAU,CAAE,IAAI,CAChB,UAAU,CZY0B,IAAM,CYV1C,MAAM,CAAE,YAAyB,CACjC,gLAAuB,CACrB,MAAM,CAAE,IAAI,CACZ,UAAU,CAAE,IAAI,CAChB,MAAM,CAAE,CAAC,CAEb,+BAA+B,CAC7B,KAAK,CAAE,IAAI,CACb,cAAc,CACZ,YAAY,CAAE,iBAA0C,CACxD,MAAM,CAAE,CAAC,CACT,OAAO,CAAE,SAA2C,CACpD,WAAW,CZoByB,wMAAQ,CYnB5C,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,KAAK,CdI+B,OAAwB,CcH9D,2BAA2B,CACzB,WAAW,CAAE,GAAG,CAChB,MAAM,CAAE,CAAC,CACT,OAAO,CAAE,SAA2C,CACpD,WAAW,CZYyB,wMAAQ,CYX5C,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,OAAO,CAAE,KAAK,CACd,QAAQ,CAAE,IAAI,CACd,KAAK,CZnB+B,OAAW,CYuBjD,YAAY,CACV,2IAAgE,CAC9D,WAAW,CAAE,QAAQ,ECzDzB,IAAI,CACF,gBAAgB,CAAE,IAAO,CACzB,MAAM,CAAE,OAAO,CACf,OAAO,CAAE,MAAM,CACf,OAAO,CAAE,KAAK,CAChB,EAAE,CACA,KAAK,CAAE,IAAO,CACd,UAAU,CAAE,MAAM,CACpB,IAAI,CACF,KAAK,CAAE,OAAO,CACd,gBAAgB,CAAE,OAAO,CAC3B,EAAE,CACA,WAAW,CAAE,IAAI,CACnB,EAAE,CACA,WAAW,CAAE,IAAI,CACnB,GAAG,CACD,KAAK,CAAE,IAAO,CACd,UAAU,CAAE,MAAM,CACpB,GAAG,CACD,KAAK,CAAE,IAAO,CACd,WAAW,CAAE,IAAI,CACnB,GAAG,CACD,KAAK,CAAE,IAAO,CACd,UAAU,CAAE,MAAM,CACpB,GAAG,CACD,KAAK,CAAE,IAAO,CACd,WAAW,CAAE,IAAI,CACjB,UAAU,CAAE,MAAM,CACpB,GAAG,CACD,KAAK,CAAE,IAAO,CACd,gBAAgB,CAAE,IAAO,CAC3B,MAAM,CACJ,KAAK,CAAE,IAAO,CACd,gBAAgB,CAAE,IAAO,CAC3B,GAAG,CACD,UAAU,CAAE,MAAM,CACpB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAO,CACd,gBAAgB,CAAE,IAAO,CAC3B,MAAM,CACJ,KAAK,CAAE,IAAO,CACd,gBAAgB,CAAE,IAAO,CAC3B,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,WAAW,CAAE,IAAI,CACnB,GAAG,CACD,KAAK,CAAE,MAAO,CACd,WAAW,CAAE,IAAI,CACnB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,WAAW,CAAE,IAAI,CACnB,GAAG,CACD,WAAW,CAAE,IAAI,CACnB,GAAG,CACD,WAAW,CAAE,IAAI,CACnB,GAAG,CACD,WAAW,CAAE,IAAI,CACnB,GAAG,CACD,WAAW,CAAE,IAAI,CACnB,GAAG,CACD,KAAK,CAAE,IAAO,CACd,WAAW,CAAE,IAAI,CACnB,EAAE,CACA,KAAK,CAAE,IAAO,CAChB,EAAE,CACA,KAAK,CAAE,IAAO,CAChB,EAAE,CACA,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAI,CACb,GAAG,CACD,KAAK,CAAE,OAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAO,CACd,WAAW,CAAE,IAAI,CACnB,GAAG,CACD,KAAK,CAAE,IAAI,CACb,GAAG,CACD,KAAK,CAAE,MAAM,CACf,GAAG,CACD,KAAK,CAAE,IAAO,CACd,WAAW,CAAE,IAAI,CACnB,GAAG,CACD,KAAK,CAAE,IAAO,CACd,WAAW,CAAE,IAAI,CACnB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAI,CACb,GAAG,CACD,KAAK,CAAE,IAAI,CACb,GAAG,CACD,WAAW,CAAE,IAAI,CACnB,EAAE,CACA,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,OAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,OAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAI,CACb,GAAG,CACD,KAAK,CAAE,IAAI,CACb,GAAG,CACD,KAAK,CAAE,IAAI,CACb,GAAG,CACD,KAAK,CAAE,IAAO,CAChB,GAAG,CACD,KAAK,CAAE,IAAI,CACX,gBAAgB,CAAE,OAAO,CCjJ3B,kBAAkB,CAChB,OAAO,CAAE,YAAY,CACrB,uCAAsB,CACpB,KAAK,CAAE,KAAK,CACd,oBAAC,CACC,OAAO,CAAE,YAAY,CACrB,OAAO,CAAE,GAAG,CACZ,gCAAa,CACX,YAAY,CAAE,CAAC,CACnB,6FAAI,CACF,OAAO,CAAE,GAAG,CACZ,MAAM,CAAE,IAAI,CACZ,UAAU,CAAE,IAAI,CAChB,qHAAS,CACP,KAAK,CdkB2B,OAAW,CcjBjD,qBAAqB,CACnB,aAAa,CAAE,CAAC,CAChB,KAAK,CdkB+B,OAAW,CcjB/C,SAAS,CAAE,GAAG,CACd,OAAO,CAAE,YAAY,CbanB,oCAAsB,CaTxB,qBAAqB,CACnB,OAAO,CAAE,IAAI,CACf,uCAAuC,CACrC,OAAO,CAAE,IAAI,EAEjB,YAAY,CACV,uCAAuC,CACrC,OAAO,CAAE,IAAI,EC9BjB,SAAS,CACP,QAAQ,CAAE,KAAK,CACf,GAAG,CCAO,OAAO,CDGjB,gBAAO,CACL,eAAe,CAAE,IAAI,CAEzB,cAAc,C/B+FZ,KAAK,CAAE,CAAC,CACR,0CAAS,CAEP,OAAO,CAAE,KAAK,CACd,OAAO,CAAE,EAAE,CACb,oBAAO,CACL,KAAK,CAAE,IAAI,C+BnGb,mCAAM,CACJ,OAAO,CAAE,YAAY,CACvB,uBAAQ,CACN,UAAU,CAAE,qBAAoB,CAEhC,6BAAa,CACX,WAAW,CAAE,iBAAyB,CACxC,8BAAc,CACZ,YAAY,CAAE,iBAAyB,CAC3C,gBAAC,CACC,MAAM,CAAE,IAAmB,CAC3B,OAAO,CAAE,YAAY,CACrB,WAAW,CAAE,IAAmB,CAChC,OAAO,CAAE,MAAiB,CAE9B,iBAAiB,CACf,KAAK,CjBuD+B,KAAK,CiBtDzC,oDAAiB,CACf,MAAM,CAAE,IAAmB,CAC3B,OAAO,CAAE,YAAY,CACrB,WAAW,CAAE,IAAmB,CAChC,OAAO,CAAE,SAAS,CAClB,aAAa,CAAE,CAAC,CAChB,OAAO,CAAE,KAAK,CACd,WAAW,CAAE,IAAI,CACjB,cAAc,CAAE,SAAS,CACzB,SAAS,CAAE,GAAG,CACd,KAAK,CfZ6B,IAAK,CeavC,WAAW,CAAE,MAAM,CAErB,oBAAE,CACA,aAAa,CAAE,CAAC,CAEhB,+BAAY,CACV,UAAU,CAAE,iBAAyB,CACvC,kCAAe,CACb,aAAa,CAAE,iBAAyB,CAC1C,4BAAS,CACP,UAAU,CAAE,OAA4C,CACxD,8BAAC,CACC,KAAK,CfhByB,IAAY,CeiB1C,YAAY,CAAE,iBAAsD,CACpE,OAAO,CAAE,gBAAyB,CAClC,oCAAO,CACL,UAAU,CAAE,OAA4C,CAC9D,mGAAI,CACF,MAAM,CAAE,IAAI,CACZ,UAAU,CAAE,OAAO,CACnB,KAAK,CAAE,OAAO,CACd,YAAY,CAAE,CAAC,CACf,aAAa,CAAE,CAAC,CAElB,wCAAmB,CACjB,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,IAAI,CACX,WAAW,CAAE,MAAM,CAGnB,SAAS,CAAE,KAAI,CACf,WAAW,CAAE,KAAK,CAClB,KAAK,CAAE,OAA8B,CAGzC,wDAAuB,CACrB,KAAK,Cf1C6B,OAAW,Ce2C7C,OAAO,CAAE,gBAAmB,CAC5B,WAAW,CAAE,IAAI,CACjB,QAAQ,CAAE,QAAQ,CAClB,UAAU,CfrCwB,OAAyB,CesC3D,MAAM,CAAE,IAAI,CACZ,aAAa,CAAE,iBAAsD,CACrE,UAAU,CAAE,iBAAsD,CAClE,YAAY,CAAE,YAAY,CAE1B,oEAAO,CACL,UAAU,Cf5CsB,OAAyB,Ce6CzD,4GAAmB,CACjB,KAAK,CfrDyB,IAAY,CesD9C,gGAAmB,CAGjB,OAAO,CAAE,KAAK,CACd,SAAS,CAAE,KAAI,CACf,WAAW,CAAE,KAAK,CAClB,KAAK,CAAE,IAA8B,CAIvC,iHAAI,CACF,OAAO,CAAE,IAAI,CACf,iIAAc,CACZ,OAAO,CAAE,KAAK,CAGd,yCAAG,CACD,UAAU,CAAE,OAA4C,CACxD,OAAO,CAAE,gBAAyB,CACpC,uDAAiB,CACf,OAAO,CAAE,KAAK,CACd,UAAU,CAAE,OAA4C,CACxD,OAAO,CAAE,gBAAyB,CACtC,2DAA2B,CACzB,KAAK,Cf9E2B,IAAY,Ce+E9C,mDAAmB,CACjB,KAAK,CAAE,OAA4C,CACvD,+BAAa,CACX,SAAS,CAAE,KAAI,CAEb,yCAAG,CACD,UAAU,CAAE,OAA4C,CACxD,OAAO,CAAE,gBAAyB,CACpC,uDAAiB,CACf,OAAO,CAAE,KAAK,CACd,UAAU,CAAE,OAA4C,CACxD,OAAO,CAAE,gBAAyB,CAClC,UAAU,CAAE,IAAI,CAChB,aAAa,CAAE,IAAI,CACvB,2DAA2B,CACzB,KAAK,Cf9F2B,IAAY,Ce+F9C,mDAAmB,CACjB,KAAK,CAAE,OAA4C,CACvD,+BAAa,CACX,SAAS,CAAE,KAAI,CAEjB,+BAAa,CACX,OAAO,CAAE,KAAK,CAChB,uBAAK,CACH,aAAa,CAAE,CAAC,CAChB,OAAO,CAAE,IAAI,CAEb,kCAAK,CACH,OAAO,CAAE,KAAK,CAClB,4BAAU,CACR,aAAa,CAAE,CAAC,CAChB,KAAK,Cf7G6B,OAAW,Ce8G7C,WAAW,CAAE,MAAM,CACrB,mBAAC,CACC,OAAO,CAAE,YAAY,CACrB,WAAW,CAAE,IAAI,CACjB,OAAO,CAAE,gBAAmB,CAC5B,OAAO,CAAE,KAAK,CACd,QAAQ,CAAE,QAAQ,CAClB,SAAS,CAAE,GAAG,CACd,KAAK,CftH6B,OAAW,CeuH7C,yBAAO,CACL,gBAAgB,CAAE,OAAoC,CACtD,MAAM,CAAE,OAAO,CACf,6CAAmB,CACjB,KAAK,Cf3HyB,OAAW,Ce4H7C,0BAAQ,CACN,gBAAgB,CftHgB,OAAK,CeuHrC,MAAM,CAAE,OAAO,CACf,KAAK,Cf9H2B,IAAM,Ce+HtC,8CAAmB,CACjB,KAAK,CfhIyB,IAAM,CekI5C,mBAAmB,CACjB,OAAO,CAAE,KAAK,CACd,KAAK,CjBvF+B,KAAK,CiBwFzC,OAAO,CAAE,OAAW,CACpB,aAAa,CAAE,OAAW,CAC1B,OAAO,CjBrF6B,GAAG,CiBsFvC,gBAAgB,CflIoB,OAAK,CemIzC,UAAU,CAAE,MAAM,CAClB,OAAO,CAAE,OAAW,CACpB,OAAO,CAAE,KAAK,CACd,KAAK,CfvI+B,OAAyB,CewI7D,aAAa,CAAE,OAAW,CAC1B,oCAAgB,CACd,KAAK,CAAE,IAAI,CACX,aAAa,CAAE,IAAI,CACnB,OAAO,CAAE,QAAQ,CACjB,YAAY,CAAE,OAAuB,CACvC,uBAAG,CACD,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,sBAA0B,CAClC,MAAM,CAAE,IAAI,CACZ,KAAK,CAAE,IAAI,CACX,gBAAgB,CflJkB,OAAK,CemJvC,OAAO,CAAE,GAAG,CACZ,aAAa,CAAE,IAAI,CACrB,wDAAqB,CACnB,KAAK,CfvJ6B,OAAyB,CewJ3D,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CACjB,OAAO,CAAE,YAAY,CACrB,OAAO,CAAE,OAA2C,CACpD,aAAa,CAAE,OAAW,CAE1B,oEAAO,CACL,UAAU,CAAE,qBAAoB,CAClC,0EAAQ,CACN,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,MAAM,CACd,MAAM,CAAE,IAAI,CACZ,KAAK,CAAE,IAAI,CACX,aAAa,CAAE,CAAC,CAChB,SAAS,CAAE,IAAI,CACf,UAAU,CAAE,WAAa,CAEzB,oFAAQ,CACN,UAAU,CAAE,MAAM,CACxB,+BAAa,CACX,UAAU,CAAE,SAAkB,CAC9B,aAAa,CAAE,OAAW,CAC1B,WAAW,CAAE,MAAM,CACnB,KAAK,CAAE,qBAAoB,CAI7B,gCAAM,CACJ,KAAK,CfnL6B,OAAK,CeoLzC,2BAAC,CACC,KAAK,Cf5L6B,OAAW,Ce6L7C,iCAAO,CACL,gBAAgB,CfvLgB,OAAK,CewLrC,KAAK,Cf9L2B,IAAM,CegM5C,gBAAgB,CjC3NR,kBAAoB,CAAE,gBAAM,CAK5B,eAAiB,CAAE,gBAAM,CAezB,UAAY,CAAE,gBAAM,CiCyM1B,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,CAAC,CACV,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,CAAC,CACV,4BAAa,CACX,IAAI,CAAE,CAAC,CACP,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,CAAC,CACZ,0BAAW,CACT,KAAK,CAAE,IAAI,CACX,IAAI,CAAE,KAAK,CACX,OAAO,CAAE,CAAC,CACZ,2BAAY,CACV,KAAK,CAAE,KAAK,CACZ,IAAI,CAAE,IAAI,CACV,OAAO,CAAE,CAAC,CAGd,gBAAgB,CACd,UAAU,CAAE,qBAAuC,CACnD,gBAAgB,CAAE,2uCAA2uC,CAC7vC,eAAe,CAAE,SAAsB,CAEzC,gBAAgB,CACd,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CAEd,YAAY,CACV,QAAQ,CAAE,KAAK,CACf,GAAG,CAAE,CAAC,CACN,MAAM,CAAE,CAAC,CACT,IAAI,CAAE,CAAC,CACP,cAAc,CAAE,GAAG,CACnB,KAAK,CjBvL+B,KAAK,CiBwLzC,UAAU,CAAE,MAAM,CAClB,UAAU,CAAE,MAAM,CAClB,UAAU,CAAE,IAAI,CAChB,UAAU,CfrO0B,OAAsB,CesO1D,OAAO,CjBvL6B,GAAG,CiByLzC,eAAe,CACb,KAAK,CAAE,KAAyB,CAChC,QAAQ,CAAE,QAAQ,CAClB,UAAU,CAAE,MAAM,CAClB,UAAU,CAAE,MAAM,CAClB,MAAM,CAAE,IAAI,CAEd,WAAW,CACT,OAAO,CAAE,IAAI,CACb,UAAU,Cf9O0B,OAAK,Ce+OzC,KAAK,CfrP+B,IAAM,CesP1C,OAAO,CAAE,gBAAuB,CAChC,QAAQ,CAAE,QAAQ,CAClB,WAAW,CAAE,IAAI,CACjB,UAAU,CAAE,MAAM,CAClB,SAAS,CAAE,IAAI,C/BvLf,KAAK,CAAE,CAAC,CACR,oCAAS,CAEP,OAAO,CAAE,KAAK,CACd,OAAO,CAAE,EAAE,CACb,iBAAO,CACL,KAAK,CAAE,IAAI,C+BmLb,aAAC,CACC,KAAK,Cf7P6B,IAAM,Ce8PxC,WAAW,CAAE,IAAI,CAEnB,eAAG,CACD,YAAY,CAAE,IAAqB,CACnC,MAAM,CAAE,IAAI,CACZ,KAAK,CAAE,IAAI,CACX,gBAAgB,Cf9PkB,OAAK,Ce+PvC,OAAO,CAAE,GAAG,CACZ,aAAa,CAAE,IAAI,CACrB,aAAC,CACC,SAAS,CAAE,IAAI,CACf,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,OAAO,CAEnB,oBAAoB,CAClB,WAAW,CjBhOyB,KAAK,CiBiOzC,UAAU,CfzQ0B,OAAyB,Ce0Q7D,UAAU,CAAE,IAAI,CAElB,eAAe,CACb,OAAO,CAAE,eAAmB,CAC5B,MAAM,CAAE,IAAI,CACZ,SAAS,CAAE,KAAK,CAChB,MAAM,CAAE,IAAI,CAEd,aAAa,CACX,QAAQ,CAAE,KAAK,CACf,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,UAAU,CAAE,eAAc,CAC1B,OAAO,CAAE,IAAI,CACb,OAAO,CAAE,GAAkB,CAC3B,gBAAI,CACF,OAAO,CAAE,KAAK,CAClB,MAAM,CACJ,KAAK,CflT+B,IAAW,CemT/C,QAAC,CACC,aAAa,CAAE,IAAqB,CACtC,6FAAgB,CACd,OAAO,CAAE,GAAG,CACZ,WAAW,CfhRuB,wMAAQ,CeiR1C,SAAS,CAAE,GAAG,CACd,UAAU,CAAE,IAAI,CAChB,MAAM,CAAE,IAAI,CACZ,KAAK,Cf3T6B,IAAW,Ce6TjD,mBAAmB,C/BzOjB,KAAK,CAAE,CAAC,CACR,oDAAS,CAEP,OAAO,CAAE,KAAK,CACd,OAAO,CAAE,EAAE,CACb,yBAAO,CACL,KAAK,CAAE,IAAI,C+BuOb,0BAAU,CACR,aAAa,CjBrTqB,IAAI,CiBsTtC,aAAa,CAAE,iBAA6B,CAC5C,cAAc,CjBvToB,IAAI,CiBwTxC,sCAAsB,CACpB,UAAU,CAAE,iBAA6B,CACzC,WAAW,CjB1TuB,IAAI,CiB2TxC,4BAAY,CACV,SAAS,CAAE,IAAI,CACf,aAAa,CAAE,IAAqB,CACpC,OAAO,CAAE,YAAY,CACvB,wBAAQ,CACN,KAAK,Cf9T6B,IAAY,Ce+T9C,SAAS,CAAE,GAAG,CdjUd,oCAAsB,CcqUxB,gBAAgB,CACd,UAAU,Cf7TwB,OAAyB,Ce8T7D,WAAW,CACT,OAAO,CAAE,KAAK,CAChB,YAAY,CAER,IAAI,CAAE,MAAmB,CAG3B,kBAAO,CACL,KAAK,CAAE,GAAG,CACV,IAAI,CAAE,CAAC,CACX,eAAe,CACb,KAAK,CAAE,IAAI,CACb,mBAAmB,CACjB,KAAK,CAAE,IAAI,CACb,yBAAyB,CACvB,KAAK,CAAE,IAAI,CACb,oBAAoB,CAClB,WAAW,CAAE,CAAC,CACd,oCAAe,CACb,OAAO,CCxXD,OAAO,CDyXf,0BAAO,CACL,QAAQ,CAAE,KAAK,CACf,SAAS,CAAE,IAAI,CACf,IAAI,CAAE,GAAG,CACT,GAAG,CAAE,CAAC,CACN,MAAM,CAAE,IAAI,CACZ,QAAQ,CAAE,MAAM,EdjWlB,qCAAsB,CcoWxB,oBAAoB,CAClB,UAAU,CAAE,gBAAe,CAC7B,eAAe,CACb,MAAM,CAAE,CAAC,CACT,UAAU,Cf/VwB,OAAyB,EeiW/D,YAAY,CACV,iCAAmC,CACjC,OAAO,CAAE,IAAI,CACf,oBAAoB,CAClB,WAAW,CAAE,CAAC,EE9YlB,aAAa,CACX,QAAQ,CAAE,KAAK,CACf,MAAM,CAAE,CAAC,CACT,IAAI,CAAE,CAAC,CACP,KAAK,CnB6E+B,KAAK,CmB5EzC,KAAK,CjBoC+B,OAAyB,CiBnC7D,UAAU,CAAE,OAAkC,CAC9C,UAAU,CAAE,kBAAiC,CAC7C,WAAW,CjB+CyB,uDAAM,CiB9C1C,OAAO,CnB+E6B,GAAG,CmB9EvC,eAAC,CACC,KAAK,CjB+B6B,OAAK,CiB9BvC,eAAe,CAAE,IAAI,CACvB,8BAAgB,CACd,OAAO,CAAE,IAAI,CACf,kCAAoB,CAClB,OAAO,CAAE,IAAqB,CAC9B,gBAAgB,CAAE,OAAkC,CACpD,OAAO,CAAE,KAAK,CACd,UAAU,CAAE,KAAK,CACjB,SAAS,CAAE,GAAG,CACd,MAAM,CAAE,OAAO,CACf,KAAK,CjBX6B,OAAM,ChB4F1C,KAAK,CAAE,CAAC,CACR,kFAAS,CAEP,OAAO,CAAE,KAAK,CACd,OAAO,CAAE,EAAE,CACb,wCAAO,CACL,KAAK,CAAE,IAAI,CiCrFX,uqDAAG,CACD,KAAK,CjBgB2B,OAAyB,CiBf3D,yFAAQ,CACN,KAAK,CAAE,IAAI,CACb,6CAAU,CACR,KAAK,CAAE,IAAI,CACb,kDAAiB,CACf,gBAAgB,CnBQgB,OAAI,CmBPpC,KAAK,CjBI2B,IAAM,CiBHxC,yDAAwB,CACtB,gBAAgB,CjBmBgB,OAAO,CiBlBvC,KAAK,CnBzB2B,IAAI,CmB0BxC,0CAA8B,CAC5B,OAAO,CAAE,KAAK,CAChB,iCAAmB,CACjB,SAAS,CAAE,GAAG,CACd,OAAO,CAAE,IAAqB,CAC9B,KAAK,CjBP6B,IAAY,CiBQ9C,OAAO,CAAE,IAAI,CACb,oCAAE,CACA,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,GAAG,CACX,MAAM,CAAE,CAAC,CACT,MAAM,CAAE,MAAM,CACd,OAAO,CAAE,CAAC,CACV,UAAU,CAAE,iBAA6C,CAC3D,oCAAE,CACA,OAAO,CAAE,YAAY,CACrB,MAAM,CAAE,CAAC,CACT,sCAAC,CACC,OAAO,CAAE,YAAY,CACrB,OAAO,CAAE,GAAqB,CAC9B,KAAK,CjBfyB,OAAyB,CiBgB7D,uBAAW,CACT,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,KAAK,CAAE,IAAI,CACX,IAAI,CAAE,IAAI,CACV,MAAM,CAAE,IAAI,CACZ,SAAS,CnBkByB,KAAK,CmBjBvC,kCAAU,CACR,KAAK,CAAE,IAAI,CACb,mEAAQ,CACN,KAAK,CAAE,IAAI,CACb,qDAA+B,CAC7B,UAAU,CAAE,KAAK,CACjB,+HAAQ,CACN,KAAK,CAAE,IAAI,CACb,gEAAU,CACR,KAAK,CAAE,IAAI,CACf,4CAAoB,CAClB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,WAAW,CAAE,IAAI,CACjB,OAAO,CAAE,KAAuB,CAChC,OAAO,CAAE,KAAK,CACd,UAAU,CAAE,MAAM,ChBhDpB,oCAAsB,CgBmDxB,aAAa,CACX,KAAK,CAAE,GAAG,CACV,OAAO,CAAE,IAAI,CACb,mBAAO,CACL,OAAO,CAAE,KAAK,CAClB,GAAG,CACD,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,ECzEd,gBAAG,CACD,SAAS,CAAE,IAAI,CACf,MAAM,CAAE,eAAe,CAEzB,uBAAU,CACR,aAAa,CpBUqB,IAAI,CoBTtC,iCAAS,CACP,UAAU,CAAE,MAAM,CAEtB,oCAAuB,CACrB,UAAU,CAAE,MAAM,CAGpB,qDAAoC,CAClC,aAAa,CpBCqB,IAAI,CoBUxC,uBAAU,CACR,WAAW,CpBXuB,IAAI,CoBYtC,WAAW,CpBZuB,IAAI,CoBatC,aAAa,CpBbqB,IAAI,CoBmBtC,kTAAK,CACH,aAAa,CAAE,CAAC,CAKlB,qCAAQ,CACN,YAAY,CAAE,GAAG,CAUrB,8BAAiB,CACf,YAAY,CAAE,eAAc,CAC5B,mEAAM,CACJ,UAAU,CAAE,sBAAsB,CAClC,YAAY,CAAE,0BAAyB,CAG3C,0EAAiD,CAC/C,UAAU,CAAE,WAAW,CACzB,0EAAiD,CAC/C,UAAU,CAAE,WAAW,CAGzB,qDAA4B,CAC1B,aAAa,CAAE,IAAqB,CACtC,wBAAW,CACT,WAAW,CpBpDuB,IAAI,CoBuDxC,yBAAY,CACV,WAAW,CAAE,IAAI,CACjB,aAAa,CAAE,IAAqB,CACtC,yBAAY,CACV,KAAK,ClB3D6B,OAAW,CkB4D/C,yBAAY,CACV,KAAK,CAAE,KAAK,CACZ,MAAM,CAAE,iBAA2C,CACrD,wBAAW,CACT,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,iBAA2C,CACrD,0BAAa,CACX,MAAM,CAAE,IAAI,CACZ,OAAO,CAAE,KAAK,CAMd,6RAAW,CACT,OAAO,CAAE,IAAI,CACb,UAAU,CAAE,MAAM,CAClB,SAAS,CAAE,IAAI,CAEf,mVAAO,CACL,UAAU,CAAE,OAAO,CACnB,OAAO,CAAE,GAAO,CAChB,WAAW,CAAE,WAAW,CACxB,OAAO,CAAE,YAAY,CACzB,mVAAmB,CACjB,OAAO,CAAE,YAAY,CAGzB,qBAAQ,CACN,KAAK,CAAE,KAAK,CACZ,KAAK,CAAE,GAAG,CACV,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,aAAuC,CAC/C,OAAO,CpB7F2B,IAAI,CoB8FtC,UAAU,ClB9EwB,OAAmB,CkB+ErD,MAAM,CAAE,iBAA+B,CAEvC,yEAAS,CACP,SAAS,CAAE,GAAG,CAChB,2BAAK,CACH,aAAa,CAAE,CAAC,CAClB,oCAAc,CACZ,OAAO,CAAE,KAAK,CACd,WAAW,ClB/EqB,0DAAa,CkBgF7C,WAAW,CAAE,IAAI,CACjB,UAAU,ClBvFsB,OAAmB,CkBwFnD,OAAO,CAAE,QAA2C,CACpD,MAAM,CAAE,KAAkB,CAC1B,aAAa,CpB5GmB,IAAI,CoB6GpC,SAAS,CAAE,IAAI,CAEnB,yBAAY,CACV,UAAU,ClB3FwB,OAAO,CkB4FzC,OAAO,CAAE,YAAY,CACrB,WAAW,CAAE,IAAI,CACjB,OAAO,CAAE,KAAuB,CAGlC,iEAAwC,CACtC,cAAc,CAAE,KAAK,CACrB,SAAS,CAAE,GAAG,CAIhB,yEAAgD,CAC9C,UAAU,CAAE,IAAI,CAChB,MAAM,CAAE,IAAI,CACZ,KAAK,ClB5I6B,IAAW,CkB6I7C,+JAAM,CACJ,MAAM,CAAE,IAAI,CACZ,gBAAgB,CAAE,sBAAsB,CACxC,WAAW,CAAE,MAAM,CACrB,2FAAQ,CACN,YAAY,CAAE,CAAC,CACf,aAAa,CAAE,CAAC,CAChB,cAAc,CAAE,GAAG,CACrB,mKAAI,CACF,KAAK,ClBhJ2B,IAAK,CkBuJzC,6BAAgB,CAEd,MAAM,CAAE,IAAI,CACZ,gCAAE,CACA,MAAM,CAAE,IAAI,CACZ,WAAW,CAAE,GAAG,CAClB,uCAAW,CACT,OAAO,CAAE,YAAY,CACrB,UAAU,CAAE,GAAG,CACjB,yCAAW,CACT,aAAa,CAAE,IAAI,CACnB,UAAU,CAAE,IAAI,CAChB,WAAW,CAAE,MAAM,CACrB,yCAAW,CACT,UAAU,CAAE,IAAI,CAChB,YAAY,CAAE,CAAC,CAGnB,iDAAQ,CAEN,KAAK,CpB1L6B,IAAI,CoB2LtC,OAAO,CAAE,OAAO,CAChB,wHAAO,CACL,SAAS,CAAE,eAAe,CAC1B,WAAW,CAAE,MAAM,CAErB,yEAAS,CACP,KAAK,CpBpK2B,OAAI,CoBqKtC,wHAAW,CACT,WAAW,CAAE,IAAI,CACjB,KAAK,ClB9K2B,OAAW,CkBgL/C,uDAAY,CACV,KAAK,ClBvK6B,OAAK,CkBwKzC,eAAE,CACA,aAAa,CpBnLqB,IAAI,CoBoLtC,kBAAE,CACA,WAAW,CAAE,IAAI,CAEnB,6EAAgB,CACd,aAAa,CAAE,eAAgC,CAEjD,kBAAE,CACA,MAAM,CAAE,aAA4C,CAMxD,8BAAiB,CACf,aAAa,CpBlMqB,IAAI,CoBoMtC,iCAAE,CACA,OAAO,CAAE,YAAY,CACrB,MAAM,CAAE,KAAuB,CAC/B,SAAS,CAAE,GAAG,CACd,WAAW,CAAE,MAAM,CACnB,UAAU,CAAE,OAA0B,CACtC,KAAK,ClBhM2B,OAAK,CkBiMrC,UAAU,CAAE,iBAAoC,CAChD,OAAO,CAAE,GAAqB,CAC9B,QAAQ,CAAE,QAAQ,CAClB,wCAAQ,CACN,KAAK,CAAE,OAA0B,CACnC,6CAAW,CACT,KAAK,ClBjNyB,OAAW,CkBkNzC,SAAS,CAAE,eAAe,CAE9B,oCAAK,CACH,aAAa,CAAE,GAAqB,CACpC,MAAM,CAAE,IAAI,CACZ,WAAW,CAAE,cAAuB,CACpC,UAAU,CAAE,OAAa,CACzB,KAAK,ClBhO2B,IAAK,CkBiOrC,gDAAW,CACT,KAAK,ClB3NyB,OAAW,CkB4NzC,SAAS,CAAE,eAAe,CAC9B,6CAAc,CACZ,UAAU,CAAE,CAAC,CAEf,uGAAQ,CACN,WAAW,CAAE,IAAI,CACjB,oRAA2B,CACzB,gBAAgB,CAAE,WAAW,CAC7B,MAAM,CAAE,IAAI,CACZ,OAAO,CAAE,CAAC,CACV,SAAS,CAAE,eAAe,CAC5B,kIAAU,CACR,WAAW,CAAE,IAAI,CAErB,wCAAS,CACP,OAAO,CAAE,YAAY,CACrB,OAAO,CAAE,KAAK,CACd,KAAK,CpBnQ2B,IAAI,CoBoQpC,WAAW,CAAE,IAAI,CACnB,wCAAS,CACP,OAAO,CAAE,YAAY,CACrB,aAAa,CAAE,GAAG,CAEtB,uDAA8B,CAC5B,OAAO,CAAE,YAAY,CACrB,KAAK,ClB1Q6B,OAAM,CkB2QxC,SAAS,CAAE,GAAG,CACd,YAAY,CpBvPsB,IAAI,CoBwPxC,2BAAc,CACZ,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,KAAK,CACd,qBAAQ,CACN,aAAa,CAAE,IAAI,CACnB,WAAW,CAAE,IAAI,CAEnB,mDAAa,CACX,UAAU,CAAE,OAAO,CACnB,OAAO,CAAE,OAAO,CAChB,WAAW,CAAE,OAAO,CACpB,SAAS,CAAE,OAAO,CAClB,KAAK,CAAE,OAAO,CACd,MAAM,CAAE,OAAO,CACf,WAAW,CAAE,OAAO,CAIlB,mGAAQ,CACN,YAAY,CAAE,GAAG,CjB3QrB,oCAAsB,CiBgRtB,qBAAQ,CACN,KAAK,CAAE,IAAI,ECjTjB,wBAAwB,CACtB,KAAK,CnB+B+B,OAAW,CmB7BjD,KAAK,CACH,UAAU,CAAE,MAAM,YCHlB,WAAW,CAAE,aAAa,CAC1B,UAAU,CAAE,MAAM,CAClB,WAAW,CAAE,GAAG,CAChB,GAAG,CAAE,0GAAoB,YAGzB,WAAW,CAAE,aAAa,CAC1B,UAAU,CAAE,MAAM,CAClB,WAAW,CAAE,GAAG,CAChB,GAAG,CAAE,yGAAyB,YAG9B,WAAW,CAAE,MAAM,CACnB,UAAU,CAAE,MAAM,CAClB,WAAW,CAAE,GAAG,CAChB,GAAG,CAAE,6FAAqB,YAG1B,WAAW,CAAE,MAAM,CACnB,UAAU,CAAE,MAAM,CAClB,WAAW,CAAE,GAAG,CAChB,GAAG,CAAE,oFAAkB,YAGvB,WAAW,CAAE,aAAa,CAC1B,UAAU,CAAE,MAAM,CAClB,WAAW,CAAE,GAAG,CAChB,GAAG,CAAE,gHAA4B,YAGjC,WAAW,CAAE,aAAa,CAC1B,UAAU,CAAE,MAAM,CAClB,WAAW,CAAE,GAAG,CAChB,GAAG,CAAE,uGAAyB", +"sources": ["../../../bower_components/neat/app/assets/stylesheets/grid/_grid.scss","../../../bower_components/bourbon/dist/addons/_prefixer.scss","../../../bower_components/wyrm/sass/wyrm_core/_reset.sass","../../../bower_components/wyrm/sass/wyrm_core/_mixin.sass","../../../bower_components/font-awesome/scss/_path.scss","../../../bower_components/font-awesome/scss/_core.scss","../../../bower_components/font-awesome/scss/_larger.scss","../../../bower_components/font-awesome/scss/_fixed-width.scss","../../../bower_components/font-awesome/scss/_list.scss","../../../bower_components/font-awesome/scss/_variables.scss","../../../bower_components/font-awesome/scss/_bordered-pulled.scss","../../../bower_components/font-awesome/scss/_spinning.scss","../../../bower_components/font-awesome/scss/_rotated-flipped.scss","../../../bower_components/font-awesome/scss/_mixins.scss","../../../bower_components/font-awesome/scss/_stacked.scss","../../../bower_components/font-awesome/scss/_icons.scss","../../../bower_components/wyrm/sass/wyrm_core/_font_icon_defaults.sass","../../../bower_components/wyrm/sass/wyrm_core/_wy_variables.sass","../../../bower_components/wyrm/sass/wyrm_core/_alert.sass","../../../sass/_theme_variables.sass","../../../bower_components/neat/app/assets/stylesheets/grid/_media.scss","../../../bower_components/wyrm/sass/wyrm_core/_button.sass","../../../bower_components/wyrm/sass/wyrm_core/_dropdown.sass","../../../bower_components/wyrm/sass/wyrm_core/_form.sass","../../../bower_components/neat/app/assets/stylesheets/grid/_outer-container.scss","../../../bower_components/neat/app/assets/stylesheets/settings/_grid.scss","../../../bower_components/neat/app/assets/stylesheets/grid/_span-columns.scss","../../../bower_components/wyrm/sass/wyrm_core/_neat_extra.sass","../../../bower_components/wyrm/sass/wyrm_core/_generic.sass","../../../bower_components/wyrm/sass/wyrm_core/_table.sass","../../../bower_components/wyrm/sass/wyrm_core/_type.sass","../../../bower_components/wyrm/sass/wyrm_addons/pygments/_pygments.sass","../../../bower_components/wyrm/sass/wyrm_addons/pygments/_pygments_light.sass","../../../sass/_theme_breadcrumbs.sass","../../../sass/_theme_layout.sass","../../../bower_components/neat/app/assets/stylesheets/grid/_private.scss","../../../sass/_theme_badge.sass","../../../sass/_theme_rst.sass","../../../sass/_theme_mathjax.sass","../../../sass/_theme_font_local.sass"], +"names": [], +"file": "theme.css" +} diff --git a/doc/_build/html/_static/doctools.js b/doc/_build/html/_static/doctools.js new file mode 100644 index 0000000..c5455c9 --- /dev/null +++ b/doc/_build/html/_static/doctools.js @@ -0,0 +1,238 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + */ +jQuery.urldecode = function(x) { + return decodeURIComponent(x).replace(/\+/g, ' '); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s == 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node) { + if (node.nodeType == 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { + var span = document.createElement("span"); + span.className = className; + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this); + }); + } + } + return this.each(function() { + highlight(this); + }); +}; + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated == 'undefined') + return string; + return (typeof translated == 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated == 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('

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

') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) == 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this == '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/doc/_build/html/_static/down-pressed.png b/doc/_build/html/_static/down-pressed.png new file mode 100644 index 0000000..6f7ad78 Binary files /dev/null and b/doc/_build/html/_static/down-pressed.png differ diff --git a/doc/_build/html/_static/down.png b/doc/_build/html/_static/down.png new file mode 100644 index 0000000..3003a88 Binary files /dev/null and b/doc/_build/html/_static/down.png differ diff --git a/doc/_build/html/_static/file.png b/doc/_build/html/_static/file.png new file mode 100644 index 0000000..d18082e Binary files /dev/null and b/doc/_build/html/_static/file.png differ diff --git a/doc/_build/html/_static/fonts/FontAwesome.otf b/doc/_build/html/_static/fonts/FontAwesome.otf new file mode 100644 index 0000000..81c9ad9 Binary files /dev/null and b/doc/_build/html/_static/fonts/FontAwesome.otf differ diff --git a/doc/_build/html/_static/fonts/Inconsolata-Bold.ttf b/doc/_build/html/_static/fonts/Inconsolata-Bold.ttf new file mode 100644 index 0000000..58c9fef Binary files /dev/null and b/doc/_build/html/_static/fonts/Inconsolata-Bold.ttf differ diff --git a/doc/_build/html/_static/fonts/Inconsolata-Regular.ttf b/doc/_build/html/_static/fonts/Inconsolata-Regular.ttf new file mode 100644 index 0000000..a87ffba Binary files /dev/null and b/doc/_build/html/_static/fonts/Inconsolata-Regular.ttf differ diff --git a/doc/_build/html/_static/fonts/Lato-Bold.ttf b/doc/_build/html/_static/fonts/Lato-Bold.ttf new file mode 100644 index 0000000..7434369 Binary files /dev/null and b/doc/_build/html/_static/fonts/Lato-Bold.ttf differ diff --git a/doc/_build/html/_static/fonts/Lato-Regular.ttf b/doc/_build/html/_static/fonts/Lato-Regular.ttf new file mode 100644 index 0000000..04ea8ef Binary files /dev/null and b/doc/_build/html/_static/fonts/Lato-Regular.ttf differ diff --git a/doc/_build/html/_static/fonts/RobotoSlab-Bold.ttf b/doc/_build/html/_static/fonts/RobotoSlab-Bold.ttf new file mode 100644 index 0000000..df5d1df Binary files /dev/null and b/doc/_build/html/_static/fonts/RobotoSlab-Bold.ttf differ diff --git a/doc/_build/html/_static/fonts/RobotoSlab-Regular.ttf b/doc/_build/html/_static/fonts/RobotoSlab-Regular.ttf new file mode 100644 index 0000000..eb52a79 Binary files /dev/null and b/doc/_build/html/_static/fonts/RobotoSlab-Regular.ttf differ diff --git a/doc/_build/html/_static/fonts/fontawesome-webfont.eot b/doc/_build/html/_static/fonts/fontawesome-webfont.eot new file mode 100644 index 0000000..84677bc Binary files /dev/null and b/doc/_build/html/_static/fonts/fontawesome-webfont.eot differ diff --git a/doc/_build/html/_static/fonts/fontawesome-webfont.svg b/doc/_build/html/_static/fonts/fontawesome-webfont.svg new file mode 100644 index 0000000..d907b25 --- /dev/null +++ b/doc/_build/html/_static/fonts/fontawesome-webfont.svg @@ -0,0 +1,520 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/_static/fonts/fontawesome-webfont.ttf b/doc/_build/html/_static/fonts/fontawesome-webfont.ttf new file mode 100644 index 0000000..96a3639 Binary files /dev/null and b/doc/_build/html/_static/fonts/fontawesome-webfont.ttf differ diff --git a/doc/_build/html/_static/fonts/fontawesome-webfont.woff b/doc/_build/html/_static/fonts/fontawesome-webfont.woff new file mode 100644 index 0000000..628b6a5 Binary files /dev/null and b/doc/_build/html/_static/fonts/fontawesome-webfont.woff differ diff --git a/doc/_build/html/_static/jquery.js b/doc/_build/html/_static/jquery.js new file mode 100644 index 0000000..e2efc33 --- /dev/null +++ b/doc/_build/html/_static/jquery.js @@ -0,0 +1,9404 @@ +/*! + * jQuery JavaScript Library v1.7.2 + * http://jquery.com/ + * + * Copyright 2011, John Resig + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * Copyright 2011, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * + * Date: Fri Jul 5 14:07:58 UTC 2013 + */ +(function( window, undefined ) { + +// Use the correct document accordingly with window argument (sandbox) +var document = window.document, + navigator = window.navigator, + location = window.location; +var jQuery = (function() { + +// Define a local copy of jQuery +var jQuery = function( selector, context ) { + // The jQuery object is actually just the init constructor 'enhanced' + return new jQuery.fn.init( selector, context, rootjQuery ); + }, + + // Map over jQuery in case of overwrite + _jQuery = window.jQuery, + + // Map over the $ in case of overwrite + _$ = window.$, + + // A central reference to the root jQuery(document) + rootjQuery, + + // A simple way to check for HTML strings or ID strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + quickExpr = /^(?:[^#<]*(<[\w\W]+>)[^>]*$|#([\w\-]*)$)/, + + // Check if a string has a non-whitespace character in it + rnotwhite = /\S/, + + // Used for trimming whitespace + trimLeft = /^\s+/, + trimRight = /\s+$/, + + // Match a standalone tag + rsingleTag = /^<(\w+)\s*\/?>(?:<\/\1>)?$/, + + // JSON RegExp + rvalidchars = /^[\],:{}\s]*$/, + rvalidescape = /\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g, + rvalidtokens = /"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g, + rvalidbraces = /(?:^|:|,)(?:\s*\[)+/g, + + // Useragent RegExp + rwebkit = /(webkit)[ \/]([\w.]+)/, + ropera = /(opera)(?:.*version)?[ \/]([\w.]+)/, + rmsie = /(msie) ([\w.]+)/, + rmozilla = /(mozilla)(?:.*? rv:([\w.]+))?/, + + // Matches dashed string for camelizing + rdashAlpha = /-([a-z]|[0-9])/ig, + rmsPrefix = /^-ms-/, + + // Used by jQuery.camelCase as callback to replace() + fcamelCase = function( all, letter ) { + return ( letter + "" ).toUpperCase(); + }, + + // Keep a UserAgent string for use with jQuery.browser + userAgent = navigator.userAgent, + + // For matching the engine and version of the browser + browserMatch, + + // The deferred used on DOM ready + readyList, + + // The ready event handler + DOMContentLoaded, + + // Save a reference to some core methods + toString = Object.prototype.toString, + hasOwn = Object.prototype.hasOwnProperty, + push = Array.prototype.push, + slice = Array.prototype.slice, + trim = String.prototype.trim, + indexOf = Array.prototype.indexOf, + + // [[Class]] -> type pairs + class2type = {}; + +jQuery.fn = jQuery.prototype = { + constructor: jQuery, + init: function( selector, context, rootjQuery ) { + var match, elem, ret, doc; + + // Handle $(""), $(null), or $(undefined) + if ( !selector ) { + return this; + } + + // Handle $(DOMElement) + if ( selector.nodeType ) { + this.context = this[0] = selector; + this.length = 1; + return this; + } + + // The body element only exists once, optimize finding it + if ( selector === "body" && !context && document.body ) { + this.context = document; + this[0] = document.body; + this.selector = selector; + this.length = 1; + return this; + } + + // Handle HTML strings + if ( typeof selector === "string" ) { + // Are we dealing with HTML string or an ID? + if ( selector.charAt(0) === "<" && selector.charAt( selector.length - 1 ) === ">" && selector.length >= 3 ) { + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = quickExpr.exec( selector ); + } + + // Verify a match, and that no context was specified for #id + if ( match && (match[1] || !context) ) { + + // HANDLE: $(html) -> $(array) + if ( match[1] ) { + context = context instanceof jQuery ? context[0] : context; + doc = ( context ? context.ownerDocument || context : document ); + + // If a single string is passed in and it's a single tag + // just do a createElement and skip the rest + ret = rsingleTag.exec( selector ); + + if ( ret ) { + if ( jQuery.isPlainObject( context ) ) { + selector = [ document.createElement( ret[1] ) ]; + jQuery.fn.attr.call( selector, context, true ); + + } else { + selector = [ doc.createElement( ret[1] ) ]; + } + + } else { + ret = jQuery.buildFragment( [ match[1] ], [ doc ] ); + selector = ( ret.cacheable ? jQuery.clone(ret.fragment) : ret.fragment ).childNodes; + } + + return jQuery.merge( this, selector ); + + // HANDLE: $("#id") + } else { + elem = document.getElementById( match[2] ); + + // Check parentNode to catch when Blackberry 4.6 returns + // nodes that are no longer in the document #6963 + if ( elem && elem.parentNode ) { + // Handle the case where IE and Opera return items + // by name instead of ID + if ( elem.id !== match[2] ) { + return rootjQuery.find( selector ); + } + + // Otherwise, we inject the element directly into the jQuery object + this.length = 1; + this[0] = elem; + } + + this.context = document; + this.selector = selector; + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || rootjQuery ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( jQuery.isFunction( selector ) ) { + return rootjQuery.ready( selector ); + } + + if ( selector.selector !== undefined ) { + this.selector = selector.selector; + this.context = selector.context; + } + + return jQuery.makeArray( selector, this ); + }, + + // Start with an empty selector + selector: "", + + // The current version of jQuery being used + jquery: "1.7.2", + + // The default length of a jQuery object is 0 + length: 0, + + // The number of elements contained in the matched element set + size: function() { + return this.length; + }, + + toArray: function() { + return slice.call( this, 0 ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + return num == null ? + + // Return a 'clean' array + this.toArray() : + + // Return just the object + ( num < 0 ? this[ this.length + num ] : this[ num ] ); + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems, name, selector ) { + // Build a new jQuery matched element set + var ret = this.constructor(); + + if ( jQuery.isArray( elems ) ) { + push.apply( ret, elems ); + + } else { + jQuery.merge( ret, elems ); + } + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + ret.context = this.context; + + if ( name === "find" ) { + ret.selector = this.selector + ( this.selector ? " " : "" ) + selector; + } else if ( name ) { + ret.selector = this.selector + "." + name + "(" + selector + ")"; + } + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + // (You can seed the arguments with an array of args, but this is + // only used internally.) + each: function( callback, args ) { + return jQuery.each( this, callback, args ); + }, + + ready: function( fn ) { + // Attach the listeners + jQuery.bindReady(); + + // Add the callback + readyList.add( fn ); + + return this; + }, + + eq: function( i ) { + i = +i; + return i === -1 ? + this.slice( i ) : + this.slice( i, i + 1 ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ), + "slice", slice.call(arguments).join(",") ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map(this, function( elem, i ) { + return callback.call( elem, i, elem ); + })); + }, + + end: function() { + return this.prevObject || this.constructor(null); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: [].sort, + splice: [].splice +}; + +// Give the init function the jQuery prototype for later instantiation +jQuery.fn.init.prototype = jQuery.fn; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[0] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + target = arguments[1] || {}; + // skip the boolean and the target + i = 2; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !jQuery.isFunction(target) ) { + target = {}; + } + + // extend jQuery itself if only one argument is passed + if ( length === i ) { + target = this; + --i; + } + + for ( ; i < length; i++ ) { + // Only deal with non-null/undefined values + if ( (options = arguments[ i ]) != null ) { + // Extend the base object + for ( name in options ) { + src = target[ name ]; + copy = options[ name ]; + + // Prevent never-ending loop + if ( target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject(copy) || (copyIsArray = jQuery.isArray(copy)) ) ) { + if ( copyIsArray ) { + copyIsArray = false; + clone = src && jQuery.isArray(src) ? src : []; + + } else { + clone = src && jQuery.isPlainObject(src) ? src : {}; + } + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend({ + noConflict: function( deep ) { + if ( window.$ === jQuery ) { + window.$ = _$; + } + + if ( deep && window.jQuery === jQuery ) { + window.jQuery = _jQuery; + } + + return jQuery; + }, + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Hold (or release) the ready event + holdReady: function( hold ) { + if ( hold ) { + jQuery.readyWait++; + } else { + jQuery.ready( true ); + } + }, + + // Handle when the DOM is ready + ready: function( wait ) { + // Either a released hold or an DOMready/load event and not yet ready + if ( (wait === true && !--jQuery.readyWait) || (wait !== true && !jQuery.isReady) ) { + // Make sure body exists, at least, in case IE gets a little overzealous (ticket #5443). + if ( !document.body ) { + return setTimeout( jQuery.ready, 1 ); + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.fireWith( document, [ jQuery ] ); + + // Trigger any bound ready events + if ( jQuery.fn.trigger ) { + jQuery( document ).trigger( "ready" ).off( "ready" ); + } + } + }, + + bindReady: function() { + if ( readyList ) { + return; + } + + readyList = jQuery.Callbacks( "once memory" ); + + // Catch cases where $(document).ready() is called after the + // browser event has already occurred. + if ( document.readyState === "complete" ) { + // Handle it asynchronously to allow scripts the opportunity to delay ready + return setTimeout( jQuery.ready, 1 ); + } + + // Mozilla, Opera and webkit nightlies currently support this event + if ( document.addEventListener ) { + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", DOMContentLoaded, false ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", jQuery.ready, false ); + + // If IE event model is used + } else if ( document.attachEvent ) { + // ensure firing before onload, + // maybe late but safe also for iframes + document.attachEvent( "onreadystatechange", DOMContentLoaded ); + + // A fallback to window.onload, that will always work + window.attachEvent( "onload", jQuery.ready ); + + // If IE and not a frame + // continually check to see if the document is ready + var toplevel = false; + + try { + toplevel = window.frameElement == null; + } catch(e) {} + + if ( document.documentElement.doScroll && toplevel ) { + doScrollCheck(); + } + } + }, + + // See test/unit/core.js for details concerning isFunction. + // Since version 1.3, DOM methods and functions like alert + // aren't supported. They return false on IE (#2968). + isFunction: function( obj ) { + return jQuery.type(obj) === "function"; + }, + + isArray: Array.isArray || function( obj ) { + return jQuery.type(obj) === "array"; + }, + + isWindow: function( obj ) { + return obj != null && obj == obj.window; + }, + + isNumeric: function( obj ) { + return !isNaN( parseFloat(obj) ) && isFinite( obj ); + }, + + type: function( obj ) { + return obj == null ? + String( obj ) : + class2type[ toString.call(obj) ] || "object"; + }, + + isPlainObject: function( obj ) { + // Must be an Object. + // Because of IE, we also have to check the presence of the constructor property. + // Make sure that DOM nodes and window objects don't pass through, as well + if ( !obj || jQuery.type(obj) !== "object" || obj.nodeType || jQuery.isWindow( obj ) ) { + return false; + } + + try { + // Not own constructor property must be Object + if ( obj.constructor && + !hasOwn.call(obj, "constructor") && + !hasOwn.call(obj.constructor.prototype, "isPrototypeOf") ) { + return false; + } + } catch ( e ) { + // IE8,9 Will throw exceptions on certain host objects #9897 + return false; + } + + // Own properties are enumerated firstly, so to speed up, + // if last one is own, then all properties are own. + + var key; + for ( key in obj ) {} + + return key === undefined || hasOwn.call( obj, key ); + }, + + isEmptyObject: function( obj ) { + for ( var name in obj ) { + return false; + } + return true; + }, + + error: function( msg ) { + throw new Error( msg ); + }, + + parseJSON: function( data ) { + if ( typeof data !== "string" || !data ) { + return null; + } + + // Make sure leading/trailing whitespace is removed (IE can't handle it) + data = jQuery.trim( data ); + + // Attempt to parse using the native JSON parser first + if ( window.JSON && window.JSON.parse ) { + return window.JSON.parse( data ); + } + + // Make sure the incoming data is actual JSON + // Logic borrowed from http://json.org/json2.js + if ( rvalidchars.test( data.replace( rvalidescape, "@" ) + .replace( rvalidtokens, "]" ) + .replace( rvalidbraces, "")) ) { + + return ( new Function( "return " + data ) )(); + + } + jQuery.error( "Invalid JSON: " + data ); + }, + + // Cross-browser xml parsing + parseXML: function( data ) { + if ( typeof data !== "string" || !data ) { + return null; + } + var xml, tmp; + try { + if ( window.DOMParser ) { // Standard + tmp = new DOMParser(); + xml = tmp.parseFromString( data , "text/xml" ); + } else { // IE + xml = new ActiveXObject( "Microsoft.XMLDOM" ); + xml.async = "false"; + xml.loadXML( data ); + } + } catch( e ) { + xml = undefined; + } + if ( !xml || !xml.documentElement || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; + }, + + noop: function() {}, + + // Evaluates a script in a global context + // Workarounds based on findings by Jim Driscoll + // http://weblogs.java.net/blog/driscoll/archive/2009/09/08/eval-javascript-global-context + globalEval: function( data ) { + if ( data && rnotwhite.test( data ) ) { + // We use execScript on Internet Explorer + // We use an anonymous function so that context is window + // rather than jQuery in Firefox + ( window.execScript || function( data ) { + window[ "eval" ].call( window, data ); + } )( data ); + } + }, + + // Convert dashed to camelCase; used by the css and data modules + // Microsoft forgot to hump their vendor prefix (#9572) + camelCase: function( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); + }, + + nodeName: function( elem, name ) { + return elem.nodeName && elem.nodeName.toUpperCase() === name.toUpperCase(); + }, + + // args is for internal usage only + each: function( object, callback, args ) { + var name, i = 0, + length = object.length, + isObj = length === undefined || jQuery.isFunction( object ); + + if ( args ) { + if ( isObj ) { + for ( name in object ) { + if ( callback.apply( object[ name ], args ) === false ) { + break; + } + } + } else { + for ( ; i < length; ) { + if ( callback.apply( object[ i++ ], args ) === false ) { + break; + } + } + } + + // A special, fast, case for the most common use of each + } else { + if ( isObj ) { + for ( name in object ) { + if ( callback.call( object[ name ], name, object[ name ] ) === false ) { + break; + } + } + } else { + for ( ; i < length; ) { + if ( callback.call( object[ i ], i, object[ i++ ] ) === false ) { + break; + } + } + } + } + + return object; + }, + + // Use native String.trim function wherever possible + trim: trim ? + function( text ) { + return text == null ? + "" : + trim.call( text ); + } : + + // Otherwise use our own trimming functionality + function( text ) { + return text == null ? + "" : + text.toString().replace( trimLeft, "" ).replace( trimRight, "" ); + }, + + // results is for internal usage only + makeArray: function( array, results ) { + var ret = results || []; + + if ( array != null ) { + // The window, strings (and functions) also have 'length' + // Tweaked logic slightly to handle Blackberry 4.7 RegExp issues #6930 + var type = jQuery.type( array ); + + if ( array.length == null || type === "string" || type === "function" || type === "regexp" || jQuery.isWindow( array ) ) { + push.call( ret, array ); + } else { + jQuery.merge( ret, array ); + } + } + + return ret; + }, + + inArray: function( elem, array, i ) { + var len; + + if ( array ) { + if ( indexOf ) { + return indexOf.call( array, elem, i ); + } + + len = array.length; + i = i ? i < 0 ? Math.max( 0, len + i ) : i : 0; + + for ( ; i < len; i++ ) { + // Skip accessing in sparse arrays + if ( i in array && array[ i ] === elem ) { + return i; + } + } + } + + return -1; + }, + + merge: function( first, second ) { + var i = first.length, + j = 0; + + if ( typeof second.length === "number" ) { + for ( var l = second.length; j < l; j++ ) { + first[ i++ ] = second[ j ]; + } + + } else { + while ( second[j] !== undefined ) { + first[ i++ ] = second[ j++ ]; + } + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, inv ) { + var ret = [], retVal; + inv = !!inv; + + // Go through the array, only saving the items + // that pass the validator function + for ( var i = 0, length = elems.length; i < length; i++ ) { + retVal = !!callback( elems[ i ], i ); + if ( inv !== retVal ) { + ret.push( elems[ i ] ); + } + } + + return ret; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var value, key, ret = [], + i = 0, + length = elems.length, + // jquery objects are treated as arrays + isArray = elems instanceof jQuery || length !== undefined && typeof length === "number" && ( ( length > 0 && elems[ 0 ] && elems[ length -1 ] ) || length === 0 || jQuery.isArray( elems ) ) ; + + // Go through the array, translating each of the items to their + if ( isArray ) { + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret[ ret.length ] = value; + } + } + + // Go through every key on the object, + } else { + for ( key in elems ) { + value = callback( elems[ key ], key, arg ); + + if ( value != null ) { + ret[ ret.length ] = value; + } + } + } + + // Flatten any nested arrays + return ret.concat.apply( [], ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // Bind a function to a context, optionally partially applying any + // arguments. + proxy: function( fn, context ) { + if ( typeof context === "string" ) { + var tmp = fn[ context ]; + context = fn; + fn = tmp; + } + + // Quick check to determine if target is callable, in the spec + // this throws a TypeError, but we will just return undefined. + if ( !jQuery.isFunction( fn ) ) { + return undefined; + } + + // Simulated bind + var args = slice.call( arguments, 2 ), + proxy = function() { + return fn.apply( context, args.concat( slice.call( arguments ) ) ); + }; + + // Set the guid of unique handler to the same of original handler, so it can be removed + proxy.guid = fn.guid = fn.guid || proxy.guid || jQuery.guid++; + + return proxy; + }, + + // Mutifunctional method to get and set values to a collection + // The value/s can optionally be executed if it's a function + access: function( elems, fn, key, value, chainable, emptyGet, pass ) { + var exec, + bulk = key == null, + i = 0, + length = elems.length; + + // Sets many values + if ( key && typeof key === "object" ) { + for ( i in key ) { + jQuery.access( elems, fn, i, key[i], 1, emptyGet, value ); + } + chainable = 1; + + // Sets one value + } else if ( value !== undefined ) { + // Optionally, function values get executed if exec is true + exec = pass === undefined && jQuery.isFunction( value ); + + if ( bulk ) { + // Bulk operations only iterate when executing function values + if ( exec ) { + exec = fn; + fn = function( elem, key, value ) { + return exec.call( jQuery( elem ), value ); + }; + + // Otherwise they run against the entire set + } else { + fn.call( elems, value ); + fn = null; + } + } + + if ( fn ) { + for (; i < length; i++ ) { + fn( elems[i], key, exec ? value.call( elems[i], i, fn( elems[i], key ) ) : value, pass ); + } + } + + chainable = 1; + } + + return chainable ? + elems : + + // Gets + bulk ? + fn.call( elems ) : + length ? fn( elems[0], key ) : emptyGet; + }, + + now: function() { + return ( new Date() ).getTime(); + }, + + // Use of jQuery.browser is frowned upon. + // More details: http://docs.jquery.com/Utilities/jQuery.browser + uaMatch: function( ua ) { + ua = ua.toLowerCase(); + + var match = rwebkit.exec( ua ) || + ropera.exec( ua ) || + rmsie.exec( ua ) || + ua.indexOf("compatible") < 0 && rmozilla.exec( ua ) || + []; + + return { browser: match[1] || "", version: match[2] || "0" }; + }, + + sub: function() { + function jQuerySub( selector, context ) { + return new jQuerySub.fn.init( selector, context ); + } + jQuery.extend( true, jQuerySub, this ); + jQuerySub.superclass = this; + jQuerySub.fn = jQuerySub.prototype = this(); + jQuerySub.fn.constructor = jQuerySub; + jQuerySub.sub = this.sub; + jQuerySub.fn.init = function init( selector, context ) { + if ( context && context instanceof jQuery && !(context instanceof jQuerySub) ) { + context = jQuerySub( context ); + } + + return jQuery.fn.init.call( this, selector, context, rootjQuerySub ); + }; + jQuerySub.fn.init.prototype = jQuerySub.fn; + var rootjQuerySub = jQuerySub(document); + return jQuerySub; + }, + + browser: {} +}); + +// Populate the class2type map +jQuery.each("Boolean Number String Function Array Date RegExp Object".split(" "), function(i, name) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +}); + +browserMatch = jQuery.uaMatch( userAgent ); +if ( browserMatch.browser ) { + jQuery.browser[ browserMatch.browser ] = true; + jQuery.browser.version = browserMatch.version; +} + +// Deprecated, use jQuery.browser.webkit instead +if ( jQuery.browser.webkit ) { + jQuery.browser.safari = true; +} + +// IE doesn't match non-breaking spaces with \s +if ( rnotwhite.test( "\xA0" ) ) { + trimLeft = /^[\s\xA0]+/; + trimRight = /[\s\xA0]+$/; +} + +// All jQuery objects should point back to these +rootjQuery = jQuery(document); + +// Cleanup functions for the document ready method +if ( document.addEventListener ) { + DOMContentLoaded = function() { + document.removeEventListener( "DOMContentLoaded", DOMContentLoaded, false ); + jQuery.ready(); + }; + +} else if ( document.attachEvent ) { + DOMContentLoaded = function() { + // Make sure body exists, at least, in case IE gets a little overzealous (ticket #5443). + if ( document.readyState === "complete" ) { + document.detachEvent( "onreadystatechange", DOMContentLoaded ); + jQuery.ready(); + } + }; +} + +// The DOM ready check for Internet Explorer +function doScrollCheck() { + if ( jQuery.isReady ) { + return; + } + + try { + // If IE is used, use the trick by Diego Perini + // http://javascript.nwbox.com/IEContentLoaded/ + document.documentElement.doScroll("left"); + } catch(e) { + setTimeout( doScrollCheck, 1 ); + return; + } + + // and execute any waiting functions + jQuery.ready(); +} + +return jQuery; + +})(); + + +// String to Object flags format cache +var flagsCache = {}; + +// Convert String-formatted flags into Object-formatted ones and store in cache +function createFlags( flags ) { + var object = flagsCache[ flags ] = {}, + i, length; + flags = flags.split( /\s+/ ); + for ( i = 0, length = flags.length; i < length; i++ ) { + object[ flags[i] ] = true; + } + return object; +} + +/* + * Create a callback list using the following parameters: + * + * flags: an optional list of space-separated flags that will change how + * the callback list behaves + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible flags: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( flags ) { + + // Convert flags from String-formatted to Object-formatted + // (we check in cache first) + flags = flags ? ( flagsCache[ flags ] || createFlags( flags ) ) : {}; + + var // Actual callback list + list = [], + // Stack of fire calls for repeatable lists + stack = [], + // Last fire value (for non-forgettable lists) + memory, + // Flag to know if list was already fired + fired, + // Flag to know if list is currently firing + firing, + // First callback to fire (used internally by add and fireWith) + firingStart, + // End of the loop when firing + firingLength, + // Index of currently firing callback (modified by remove if needed) + firingIndex, + // Add one or several callbacks to the list + add = function( args ) { + var i, + length, + elem, + type, + actual; + for ( i = 0, length = args.length; i < length; i++ ) { + elem = args[ i ]; + type = jQuery.type( elem ); + if ( type === "array" ) { + // Inspect recursively + add( elem ); + } else if ( type === "function" ) { + // Add if not in unique mode and callback is not in + if ( !flags.unique || !self.has( elem ) ) { + list.push( elem ); + } + } + } + }, + // Fire callbacks + fire = function( context, args ) { + args = args || []; + memory = !flags.memory || [ context, args ]; + fired = true; + firing = true; + firingIndex = firingStart || 0; + firingStart = 0; + firingLength = list.length; + for ( ; list && firingIndex < firingLength; firingIndex++ ) { + if ( list[ firingIndex ].apply( context, args ) === false && flags.stopOnFalse ) { + memory = true; // Mark as halted + break; + } + } + firing = false; + if ( list ) { + if ( !flags.once ) { + if ( stack && stack.length ) { + memory = stack.shift(); + self.fireWith( memory[ 0 ], memory[ 1 ] ); + } + } else if ( memory === true ) { + self.disable(); + } else { + list = []; + } + } + }, + // Actual Callbacks object + self = { + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + var length = list.length; + add( arguments ); + // Do we need to add the callbacks to the + // current firing batch? + if ( firing ) { + firingLength = list.length; + // With memory, if we're not firing then + // we should call right away, unless previous + // firing was halted (stopOnFalse) + } else if ( memory && memory !== true ) { + firingStart = length; + fire( memory[ 0 ], memory[ 1 ] ); + } + } + return this; + }, + // Remove a callback from the list + remove: function() { + if ( list ) { + var args = arguments, + argIndex = 0, + argLength = args.length; + for ( ; argIndex < argLength ; argIndex++ ) { + for ( var i = 0; i < list.length; i++ ) { + if ( args[ argIndex ] === list[ i ] ) { + // Handle firingIndex and firingLength + if ( firing ) { + if ( i <= firingLength ) { + firingLength--; + if ( i <= firingIndex ) { + firingIndex--; + } + } + } + // Remove the element + list.splice( i--, 1 ); + // If we have some unicity property then + // we only need to do this once + if ( flags.unique ) { + break; + } + } + } + } + } + return this; + }, + // Control if a given callback is in the list + has: function( fn ) { + if ( list ) { + var i = 0, + length = list.length; + for ( ; i < length; i++ ) { + if ( fn === list[ i ] ) { + return true; + } + } + } + return false; + }, + // Remove all callbacks from the list + empty: function() { + list = []; + return this; + }, + // Have the list do nothing anymore + disable: function() { + list = stack = memory = undefined; + return this; + }, + // Is it disabled? + disabled: function() { + return !list; + }, + // Lock the list in its current state + lock: function() { + stack = undefined; + if ( !memory || memory === true ) { + self.disable(); + } + return this; + }, + // Is it locked? + locked: function() { + return !stack; + }, + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( stack ) { + if ( firing ) { + if ( !flags.once ) { + stack.push( [ context, args ] ); + } + } else if ( !( flags.once && memory ) ) { + fire( context, args ); + } + } + return this; + }, + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + + + +var // Static reference to slice + sliceDeferred = [].slice; + +jQuery.extend({ + + Deferred: function( func ) { + var doneList = jQuery.Callbacks( "once memory" ), + failList = jQuery.Callbacks( "once memory" ), + progressList = jQuery.Callbacks( "memory" ), + state = "pending", + lists = { + resolve: doneList, + reject: failList, + notify: progressList + }, + promise = { + done: doneList.add, + fail: failList.add, + progress: progressList.add, + + state: function() { + return state; + }, + + // Deprecated + isResolved: doneList.fired, + isRejected: failList.fired, + + then: function( doneCallbacks, failCallbacks, progressCallbacks ) { + deferred.done( doneCallbacks ).fail( failCallbacks ).progress( progressCallbacks ); + return this; + }, + always: function() { + deferred.done.apply( deferred, arguments ).fail.apply( deferred, arguments ); + return this; + }, + pipe: function( fnDone, fnFail, fnProgress ) { + return jQuery.Deferred(function( newDefer ) { + jQuery.each( { + done: [ fnDone, "resolve" ], + fail: [ fnFail, "reject" ], + progress: [ fnProgress, "notify" ] + }, function( handler, data ) { + var fn = data[ 0 ], + action = data[ 1 ], + returned; + if ( jQuery.isFunction( fn ) ) { + deferred[ handler ](function() { + returned = fn.apply( this, arguments ); + if ( returned && jQuery.isFunction( returned.promise ) ) { + returned.promise().then( newDefer.resolve, newDefer.reject, newDefer.notify ); + } else { + newDefer[ action + "With" ]( this === deferred ? newDefer : this, [ returned ] ); + } + }); + } else { + deferred[ handler ]( newDefer[ action ] ); + } + }); + }).promise(); + }, + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + if ( obj == null ) { + obj = promise; + } else { + for ( var key in promise ) { + obj[ key ] = promise[ key ]; + } + } + return obj; + } + }, + deferred = promise.promise({}), + key; + + for ( key in lists ) { + deferred[ key ] = lists[ key ].fire; + deferred[ key + "With" ] = lists[ key ].fireWith; + } + + // Handle state + deferred.done( function() { + state = "resolved"; + }, failList.disable, progressList.lock ).fail( function() { + state = "rejected"; + }, doneList.disable, progressList.lock ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( firstParam ) { + var args = sliceDeferred.call( arguments, 0 ), + i = 0, + length = args.length, + pValues = new Array( length ), + count = length, + pCount = length, + deferred = length <= 1 && firstParam && jQuery.isFunction( firstParam.promise ) ? + firstParam : + jQuery.Deferred(), + promise = deferred.promise(); + function resolveFunc( i ) { + return function( value ) { + args[ i ] = arguments.length > 1 ? sliceDeferred.call( arguments, 0 ) : value; + if ( !( --count ) ) { + deferred.resolveWith( deferred, args ); + } + }; + } + function progressFunc( i ) { + return function( value ) { + pValues[ i ] = arguments.length > 1 ? sliceDeferred.call( arguments, 0 ) : value; + deferred.notifyWith( promise, pValues ); + }; + } + if ( length > 1 ) { + for ( ; i < length; i++ ) { + if ( args[ i ] && args[ i ].promise && jQuery.isFunction( args[ i ].promise ) ) { + args[ i ].promise().then( resolveFunc(i), deferred.reject, progressFunc(i) ); + } else { + --count; + } + } + if ( !count ) { + deferred.resolveWith( deferred, args ); + } + } else if ( deferred !== firstParam ) { + deferred.resolveWith( deferred, length ? [ firstParam ] : [] ); + } + return promise; + } +}); + + + + +jQuery.support = (function() { + + var support, + all, + a, + select, + opt, + input, + fragment, + tds, + events, + eventName, + i, + isSupported, + div = document.createElement( "div" ), + documentElement = document.documentElement; + + // Preliminary tests + div.setAttribute("className", "t"); + div.innerHTML = "
a"; + + all = div.getElementsByTagName( "*" ); + a = div.getElementsByTagName( "a" )[ 0 ]; + + // Can't get basic test support + if ( !all || !all.length || !a ) { + return {}; + } + + // First batch of supports tests + select = document.createElement( "select" ); + opt = select.appendChild( document.createElement("option") ); + input = div.getElementsByTagName( "input" )[ 0 ]; + + support = { + // IE strips leading whitespace when .innerHTML is used + leadingWhitespace: ( div.firstChild.nodeType === 3 ), + + // Make sure that tbody elements aren't automatically inserted + // IE will insert them into empty tables + tbody: !div.getElementsByTagName("tbody").length, + + // Make sure that link elements get serialized correctly by innerHTML + // This requires a wrapper element in IE + htmlSerialize: !!div.getElementsByTagName("link").length, + + // Get the style information from getAttribute + // (IE uses .cssText instead) + style: /top/.test( a.getAttribute("style") ), + + // Make sure that URLs aren't manipulated + // (IE normalizes it by default) + hrefNormalized: ( a.getAttribute("href") === "/a" ), + + // Make sure that element opacity exists + // (IE uses filter instead) + // Use a regex to work around a WebKit issue. See #5145 + opacity: /^0.55/.test( a.style.opacity ), + + // Verify style float existence + // (IE uses styleFloat instead of cssFloat) + cssFloat: !!a.style.cssFloat, + + // Make sure that if no value is specified for a checkbox + // that it defaults to "on". + // (WebKit defaults to "" instead) + checkOn: ( input.value === "on" ), + + // Make sure that a selected-by-default option has a working selected property. + // (WebKit defaults to false instead of true, IE too, if it's in an optgroup) + optSelected: opt.selected, + + // Test setAttribute on camelCase class. If it works, we need attrFixes when doing get/setAttribute (ie6/7) + getSetAttribute: div.className !== "t", + + // Tests for enctype support on a form(#6743) + enctype: !!document.createElement("form").enctype, + + // Makes sure cloning an html5 element does not cause problems + // Where outerHTML is undefined, this still works + html5Clone: document.createElement("nav").cloneNode( true ).outerHTML !== "<:nav>", + + // Will be defined later + submitBubbles: true, + changeBubbles: true, + focusinBubbles: false, + deleteExpando: true, + noCloneEvent: true, + inlineBlockNeedsLayout: false, + shrinkWrapBlocks: false, + reliableMarginRight: true, + pixelMargin: true + }; + + // jQuery.boxModel DEPRECATED in 1.3, use jQuery.support.boxModel instead + jQuery.boxModel = support.boxModel = (document.compatMode === "CSS1Compat"); + + // Make sure checked status is properly cloned + input.checked = true; + support.noCloneChecked = input.cloneNode( true ).checked; + + // Make sure that the options inside disabled selects aren't marked as disabled + // (WebKit marks them as disabled) + select.disabled = true; + support.optDisabled = !opt.disabled; + + // Test to see if it's possible to delete an expando from an element + // Fails in Internet Explorer + try { + delete div.test; + } catch( e ) { + support.deleteExpando = false; + } + + if ( !div.addEventListener && div.attachEvent && div.fireEvent ) { + div.attachEvent( "onclick", function() { + // Cloning a node shouldn't copy over any + // bound event handlers (IE does this) + support.noCloneEvent = false; + }); + div.cloneNode( true ).fireEvent( "onclick" ); + } + + // Check if a radio maintains its value + // after being appended to the DOM + input = document.createElement("input"); + input.value = "t"; + input.setAttribute("type", "radio"); + support.radioValue = input.value === "t"; + + input.setAttribute("checked", "checked"); + + // #11217 - WebKit loses check when the name is after the checked attribute + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + fragment = document.createDocumentFragment(); + fragment.appendChild( div.lastChild ); + + // WebKit doesn't clone checked state correctly in fragments + support.checkClone = fragment.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Check if a disconnected checkbox will retain its checked + // value of true after appended to the DOM (IE6/7) + support.appendChecked = input.checked; + + fragment.removeChild( input ); + fragment.appendChild( div ); + + // Technique from Juriy Zaytsev + // http://perfectionkills.com/detecting-event-support-without-browser-sniffing/ + // We only care about the case where non-standard event systems + // are used, namely in IE. Short-circuiting here helps us to + // avoid an eval call (in setAttribute) which can cause CSP + // to go haywire. See: https://developer.mozilla.org/en/Security/CSP + if ( div.attachEvent ) { + for ( i in { + submit: 1, + change: 1, + focusin: 1 + }) { + eventName = "on" + i; + isSupported = ( eventName in div ); + if ( !isSupported ) { + div.setAttribute( eventName, "return;" ); + isSupported = ( typeof div[ eventName ] === "function" ); + } + support[ i + "Bubbles" ] = isSupported; + } + } + + fragment.removeChild( div ); + + // Null elements to avoid leaks in IE + fragment = select = opt = div = input = null; + + // Run tests that need a body at doc ready + jQuery(function() { + var container, outer, inner, table, td, offsetSupport, + marginDiv, conMarginTop, style, html, positionTopLeftWidthHeight, + paddingMarginBorderVisibility, paddingMarginBorder, + body = document.getElementsByTagName("body")[0]; + + if ( !body ) { + // Return for frameset docs that don't have a body + return; + } + + conMarginTop = 1; + paddingMarginBorder = "padding:0;margin:0;border:"; + positionTopLeftWidthHeight = "position:absolute;top:0;left:0;width:1px;height:1px;"; + paddingMarginBorderVisibility = paddingMarginBorder + "0;visibility:hidden;"; + style = "style='" + positionTopLeftWidthHeight + paddingMarginBorder + "5px solid #000;"; + html = "
" + + "" + + "
"; + + container = document.createElement("div"); + container.style.cssText = paddingMarginBorderVisibility + "width:0;height:0;position:static;top:0;margin-top:" + conMarginTop + "px"; + body.insertBefore( container, body.firstChild ); + + // Construct the test element + div = document.createElement("div"); + container.appendChild( div ); + + // Check if table cells still have offsetWidth/Height when they are set + // to display:none and there are still other visible table cells in a + // table row; if so, offsetWidth/Height are not reliable for use when + // determining if an element has been hidden directly using + // display:none (it is still safe to use offsets if a parent element is + // hidden; don safety goggles and see bug #4512 for more information). + // (only IE 8 fails this test) + div.innerHTML = "
t
"; + tds = div.getElementsByTagName( "td" ); + isSupported = ( tds[ 0 ].offsetHeight === 0 ); + + tds[ 0 ].style.display = ""; + tds[ 1 ].style.display = "none"; + + // Check if empty table cells still have offsetWidth/Height + // (IE <= 8 fail this test) + support.reliableHiddenOffsets = isSupported && ( tds[ 0 ].offsetHeight === 0 ); + + // Check if div with explicit width and no margin-right incorrectly + // gets computed margin-right based on width of container. For more + // info see bug #3333 + // Fails in WebKit before Feb 2011 nightlies + // WebKit Bug 13343 - getComputedStyle returns wrong value for margin-right + if ( window.getComputedStyle ) { + div.innerHTML = ""; + marginDiv = document.createElement( "div" ); + marginDiv.style.width = "0"; + marginDiv.style.marginRight = "0"; + div.style.width = "2px"; + div.appendChild( marginDiv ); + support.reliableMarginRight = + ( parseInt( ( window.getComputedStyle( marginDiv, null ) || { marginRight: 0 } ).marginRight, 10 ) || 0 ) === 0; + } + + if ( typeof div.style.zoom !== "undefined" ) { + // Check if natively block-level elements act like inline-block + // elements when setting their display to 'inline' and giving + // them layout + // (IE < 8 does this) + div.innerHTML = ""; + div.style.width = div.style.padding = "1px"; + div.style.border = 0; + div.style.overflow = "hidden"; + div.style.display = "inline"; + div.style.zoom = 1; + support.inlineBlockNeedsLayout = ( div.offsetWidth === 3 ); + + // Check if elements with layout shrink-wrap their children + // (IE 6 does this) + div.style.display = "block"; + div.style.overflow = "visible"; + div.innerHTML = "
"; + support.shrinkWrapBlocks = ( div.offsetWidth !== 3 ); + } + + div.style.cssText = positionTopLeftWidthHeight + paddingMarginBorderVisibility; + div.innerHTML = html; + + outer = div.firstChild; + inner = outer.firstChild; + td = outer.nextSibling.firstChild.firstChild; + + offsetSupport = { + doesNotAddBorder: ( inner.offsetTop !== 5 ), + doesAddBorderForTableAndCells: ( td.offsetTop === 5 ) + }; + + inner.style.position = "fixed"; + inner.style.top = "20px"; + + // safari subtracts parent border width here which is 5px + offsetSupport.fixedPosition = ( inner.offsetTop === 20 || inner.offsetTop === 15 ); + inner.style.position = inner.style.top = ""; + + outer.style.overflow = "hidden"; + outer.style.position = "relative"; + + offsetSupport.subtractsBorderForOverflowNotVisible = ( inner.offsetTop === -5 ); + offsetSupport.doesNotIncludeMarginInBodyOffset = ( body.offsetTop !== conMarginTop ); + + if ( window.getComputedStyle ) { + div.style.marginTop = "1%"; + support.pixelMargin = ( window.getComputedStyle( div, null ) || { marginTop: 0 } ).marginTop !== "1%"; + } + + if ( typeof container.style.zoom !== "undefined" ) { + container.style.zoom = 1; + } + + body.removeChild( container ); + marginDiv = div = container = null; + + jQuery.extend( support, offsetSupport ); + }); + + return support; +})(); + + + + +var rbrace = /^(?:\{.*\}|\[.*\])$/, + rmultiDash = /([A-Z])/g; + +jQuery.extend({ + cache: {}, + + // Please use with caution + uuid: 0, + + // Unique for each copy of jQuery on the page + // Non-digits removed to match rinlinejQuery + expando: "jQuery" + ( jQuery.fn.jquery + Math.random() ).replace( /\D/g, "" ), + + // The following elements throw uncatchable exceptions if you + // attempt to add expando properties to them. + noData: { + "embed": true, + // Ban all objects except for Flash (which handle expandos) + "object": "clsid:D27CDB6E-AE6D-11cf-96B8-444553540000", + "applet": true + }, + + hasData: function( elem ) { + elem = elem.nodeType ? jQuery.cache[ elem[jQuery.expando] ] : elem[ jQuery.expando ]; + return !!elem && !isEmptyDataObject( elem ); + }, + + data: function( elem, name, data, pvt /* Internal Use Only */ ) { + if ( !jQuery.acceptData( elem ) ) { + return; + } + + var privateCache, thisCache, ret, + internalKey = jQuery.expando, + getByName = typeof name === "string", + + // We have to handle DOM nodes and JS objects differently because IE6-7 + // can't GC object references properly across the DOM-JS boundary + isNode = elem.nodeType, + + // Only DOM nodes need the global jQuery cache; JS object data is + // attached directly to the object so GC can occur automatically + cache = isNode ? jQuery.cache : elem, + + // Only defining an ID for JS objects if its cache already exists allows + // the code to shortcut on the same path as a DOM node with no cache + id = isNode ? elem[ internalKey ] : elem[ internalKey ] && internalKey, + isEvents = name === "events"; + + // Avoid doing any more work than we need to when trying to get data on an + // object that has no data at all + if ( (!id || !cache[id] || (!isEvents && !pvt && !cache[id].data)) && getByName && data === undefined ) { + return; + } + + if ( !id ) { + // Only DOM nodes need a new unique ID for each element since their data + // ends up in the global cache + if ( isNode ) { + elem[ internalKey ] = id = ++jQuery.uuid; + } else { + id = internalKey; + } + } + + if ( !cache[ id ] ) { + cache[ id ] = {}; + + // Avoids exposing jQuery metadata on plain JS objects when the object + // is serialized using JSON.stringify + if ( !isNode ) { + cache[ id ].toJSON = jQuery.noop; + } + } + + // An object can be passed to jQuery.data instead of a key/value pair; this gets + // shallow copied over onto the existing cache + if ( typeof name === "object" || typeof name === "function" ) { + if ( pvt ) { + cache[ id ] = jQuery.extend( cache[ id ], name ); + } else { + cache[ id ].data = jQuery.extend( cache[ id ].data, name ); + } + } + + privateCache = thisCache = cache[ id ]; + + // jQuery data() is stored in a separate object inside the object's internal data + // cache in order to avoid key collisions between internal data and user-defined + // data. + if ( !pvt ) { + if ( !thisCache.data ) { + thisCache.data = {}; + } + + thisCache = thisCache.data; + } + + if ( data !== undefined ) { + thisCache[ jQuery.camelCase( name ) ] = data; + } + + // Users should not attempt to inspect the internal events object using jQuery.data, + // it is undocumented and subject to change. But does anyone listen? No. + if ( isEvents && !thisCache[ name ] ) { + return privateCache.events; + } + + // Check for both converted-to-camel and non-converted data property names + // If a data property was specified + if ( getByName ) { + + // First Try to find as-is property data + ret = thisCache[ name ]; + + // Test for null|undefined property data + if ( ret == null ) { + + // Try to find the camelCased property + ret = thisCache[ jQuery.camelCase( name ) ]; + } + } else { + ret = thisCache; + } + + return ret; + }, + + removeData: function( elem, name, pvt /* Internal Use Only */ ) { + if ( !jQuery.acceptData( elem ) ) { + return; + } + + var thisCache, i, l, + + // Reference to internal data cache key + internalKey = jQuery.expando, + + isNode = elem.nodeType, + + // See jQuery.data for more information + cache = isNode ? jQuery.cache : elem, + + // See jQuery.data for more information + id = isNode ? elem[ internalKey ] : internalKey; + + // If there is already no cache entry for this object, there is no + // purpose in continuing + if ( !cache[ id ] ) { + return; + } + + if ( name ) { + + thisCache = pvt ? cache[ id ] : cache[ id ].data; + + if ( thisCache ) { + + // Support array or space separated string names for data keys + if ( !jQuery.isArray( name ) ) { + + // try the string as a key before any manipulation + if ( name in thisCache ) { + name = [ name ]; + } else { + + // split the camel cased version by spaces unless a key with the spaces exists + name = jQuery.camelCase( name ); + if ( name in thisCache ) { + name = [ name ]; + } else { + name = name.split( " " ); + } + } + } + + for ( i = 0, l = name.length; i < l; i++ ) { + delete thisCache[ name[i] ]; + } + + // If there is no data left in the cache, we want to continue + // and let the cache object itself get destroyed + if ( !( pvt ? isEmptyDataObject : jQuery.isEmptyObject )( thisCache ) ) { + return; + } + } + } + + // See jQuery.data for more information + if ( !pvt ) { + delete cache[ id ].data; + + // Don't destroy the parent cache unless the internal data object + // had been the only thing left in it + if ( !isEmptyDataObject(cache[ id ]) ) { + return; + } + } + + // Browsers that fail expando deletion also refuse to delete expandos on + // the window, but it will allow it on all other JS objects; other browsers + // don't care + // Ensure that `cache` is not a window object #10080 + if ( jQuery.support.deleteExpando || !cache.setInterval ) { + delete cache[ id ]; + } else { + cache[ id ] = null; + } + + // We destroyed the cache and need to eliminate the expando on the node to avoid + // false lookups in the cache for entries that no longer exist + if ( isNode ) { + // IE does not allow us to delete expando properties from nodes, + // nor does it have a removeAttribute function on Document nodes; + // we must handle all of these cases + if ( jQuery.support.deleteExpando ) { + delete elem[ internalKey ]; + } else if ( elem.removeAttribute ) { + elem.removeAttribute( internalKey ); + } else { + elem[ internalKey ] = null; + } + } + }, + + // For internal use only. + _data: function( elem, name, data ) { + return jQuery.data( elem, name, data, true ); + }, + + // A method for determining if a DOM node can handle the data expando + acceptData: function( elem ) { + if ( elem.nodeName ) { + var match = jQuery.noData[ elem.nodeName.toLowerCase() ]; + + if ( match ) { + return !(match === true || elem.getAttribute("classid") !== match); + } + } + + return true; + } +}); + +jQuery.fn.extend({ + data: function( key, value ) { + var parts, part, attr, name, l, + elem = this[0], + i = 0, + data = null; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = jQuery.data( elem ); + + if ( elem.nodeType === 1 && !jQuery._data( elem, "parsedAttrs" ) ) { + attr = elem.attributes; + for ( l = attr.length; i < l; i++ ) { + name = attr[i].name; + + if ( name.indexOf( "data-" ) === 0 ) { + name = jQuery.camelCase( name.substring(5) ); + + dataAttr( elem, name, data[ name ] ); + } + } + jQuery._data( elem, "parsedAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each(function() { + jQuery.data( this, key ); + }); + } + + parts = key.split( ".", 2 ); + parts[1] = parts[1] ? "." + parts[1] : ""; + part = parts[1] + "!"; + + return jQuery.access( this, function( value ) { + + if ( value === undefined ) { + data = this.triggerHandler( "getData" + part, [ parts[0] ] ); + + // Try to fetch any internally stored data first + if ( data === undefined && elem ) { + data = jQuery.data( elem, key ); + data = dataAttr( elem, key, data ); + } + + return data === undefined && parts[1] ? + this.data( parts[0] ) : + data; + } + + parts[1] = value; + this.each(function() { + var self = jQuery( this ); + + self.triggerHandler( "setData" + part, parts ); + jQuery.data( this, key, value ); + self.triggerHandler( "changeData" + part, parts ); + }); + }, null, value, arguments.length > 1, null, false ); + }, + + removeData: function( key ) { + return this.each(function() { + jQuery.removeData( this, key ); + }); + } +}); + +function dataAttr( elem, key, data ) { + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + + var name = "data-" + key.replace( rmultiDash, "-$1" ).toLowerCase(); + + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = data === "true" ? true : + data === "false" ? false : + data === "null" ? null : + jQuery.isNumeric( data ) ? +data : + rbrace.test( data ) ? jQuery.parseJSON( data ) : + data; + } catch( e ) {} + + // Make sure we set the data so it isn't changed later + jQuery.data( elem, key, data ); + + } else { + data = undefined; + } + } + + return data; +} + +// checks a cache object for emptiness +function isEmptyDataObject( obj ) { + for ( var name in obj ) { + + // if the public data object is empty, the private is still empty + if ( name === "data" && jQuery.isEmptyObject( obj[name] ) ) { + continue; + } + if ( name !== "toJSON" ) { + return false; + } + } + + return true; +} + + + + +function handleQueueMarkDefer( elem, type, src ) { + var deferDataKey = type + "defer", + queueDataKey = type + "queue", + markDataKey = type + "mark", + defer = jQuery._data( elem, deferDataKey ); + if ( defer && + ( src === "queue" || !jQuery._data(elem, queueDataKey) ) && + ( src === "mark" || !jQuery._data(elem, markDataKey) ) ) { + // Give room for hard-coded callbacks to fire first + // and eventually mark/queue something else on the element + setTimeout( function() { + if ( !jQuery._data( elem, queueDataKey ) && + !jQuery._data( elem, markDataKey ) ) { + jQuery.removeData( elem, deferDataKey, true ); + defer.fire(); + } + }, 0 ); + } +} + +jQuery.extend({ + + _mark: function( elem, type ) { + if ( elem ) { + type = ( type || "fx" ) + "mark"; + jQuery._data( elem, type, (jQuery._data( elem, type ) || 0) + 1 ); + } + }, + + _unmark: function( force, elem, type ) { + if ( force !== true ) { + type = elem; + elem = force; + force = false; + } + if ( elem ) { + type = type || "fx"; + var key = type + "mark", + count = force ? 0 : ( (jQuery._data( elem, key ) || 1) - 1 ); + if ( count ) { + jQuery._data( elem, key, count ); + } else { + jQuery.removeData( elem, key, true ); + handleQueueMarkDefer( elem, type, "mark" ); + } + } + }, + + queue: function( elem, type, data ) { + var q; + if ( elem ) { + type = ( type || "fx" ) + "queue"; + q = jQuery._data( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !q || jQuery.isArray(data) ) { + q = jQuery._data( elem, type, jQuery.makeArray(data) ); + } else { + q.push( data ); + } + } + return q || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + fn = queue.shift(), + hooks = {}; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + } + + if ( fn ) { + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + jQuery._data( elem, type + ".run", hooks ); + fn.call( elem, function() { + jQuery.dequeue( elem, type ); + }, hooks ); + } + + if ( !queue.length ) { + jQuery.removeData( elem, type + "queue " + type + ".run", true ); + handleQueueMarkDefer( elem, type, "queue" ); + } + } +}); + +jQuery.fn.extend({ + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[0], type ); + } + + return data === undefined ? + this : + this.each(function() { + var queue = jQuery.queue( this, type, data ); + + if ( type === "fx" && queue[0] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + }); + }, + dequeue: function( type ) { + return this.each(function() { + jQuery.dequeue( this, type ); + }); + }, + // Based off of the plugin by Clint Helfers, with permission. + // http://blindsignals.com/index.php/2009/07/jquery-delay/ + delay: function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = setTimeout( next, time ); + hooks.stop = function() { + clearTimeout( timeout ); + }; + }); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, object ) { + if ( typeof type !== "string" ) { + object = type; + type = undefined; + } + type = type || "fx"; + var defer = jQuery.Deferred(), + elements = this, + i = elements.length, + count = 1, + deferDataKey = type + "defer", + queueDataKey = type + "queue", + markDataKey = type + "mark", + tmp; + function resolve() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + } + while( i-- ) { + if (( tmp = jQuery.data( elements[ i ], deferDataKey, undefined, true ) || + ( jQuery.data( elements[ i ], queueDataKey, undefined, true ) || + jQuery.data( elements[ i ], markDataKey, undefined, true ) ) && + jQuery.data( elements[ i ], deferDataKey, jQuery.Callbacks( "once memory" ), true ) )) { + count++; + tmp.add( resolve ); + } + } + resolve(); + return defer.promise( object ); + } +}); + + + + +var rclass = /[\n\t\r]/g, + rspace = /\s+/, + rreturn = /\r/g, + rtype = /^(?:button|input)$/i, + rfocusable = /^(?:button|input|object|select|textarea)$/i, + rclickable = /^a(?:rea)?$/i, + rboolean = /^(?:autofocus|autoplay|async|checked|controls|defer|disabled|hidden|loop|multiple|open|readonly|required|scoped|selected)$/i, + getSetAttribute = jQuery.support.getSetAttribute, + nodeHook, boolHook, fixSpecified; + +jQuery.fn.extend({ + attr: function( name, value ) { + return jQuery.access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each(function() { + jQuery.removeAttr( this, name ); + }); + }, + + prop: function( name, value ) { + return jQuery.access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + name = jQuery.propFix[ name ] || name; + return this.each(function() { + // try/catch handles cases where IE balks (such as removing a property on window) + try { + this[ name ] = undefined; + delete this[ name ]; + } catch( e ) {} + }); + }, + + addClass: function( value ) { + var classNames, i, l, elem, + setClass, c, cl; + + if ( jQuery.isFunction( value ) ) { + return this.each(function( j ) { + jQuery( this ).addClass( value.call(this, j, this.className) ); + }); + } + + if ( value && typeof value === "string" ) { + classNames = value.split( rspace ); + + for ( i = 0, l = this.length; i < l; i++ ) { + elem = this[ i ]; + + if ( elem.nodeType === 1 ) { + if ( !elem.className && classNames.length === 1 ) { + elem.className = value; + + } else { + setClass = " " + elem.className + " "; + + for ( c = 0, cl = classNames.length; c < cl; c++ ) { + if ( !~setClass.indexOf( " " + classNames[ c ] + " " ) ) { + setClass += classNames[ c ] + " "; + } + } + elem.className = jQuery.trim( setClass ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classNames, i, l, elem, className, c, cl; + + if ( jQuery.isFunction( value ) ) { + return this.each(function( j ) { + jQuery( this ).removeClass( value.call(this, j, this.className) ); + }); + } + + if ( (value && typeof value === "string") || value === undefined ) { + classNames = ( value || "" ).split( rspace ); + + for ( i = 0, l = this.length; i < l; i++ ) { + elem = this[ i ]; + + if ( elem.nodeType === 1 && elem.className ) { + if ( value ) { + className = (" " + elem.className + " ").replace( rclass, " " ); + for ( c = 0, cl = classNames.length; c < cl; c++ ) { + className = className.replace(" " + classNames[ c ] + " ", " "); + } + elem.className = jQuery.trim( className ); + + } else { + elem.className = ""; + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isBool = typeof stateVal === "boolean"; + + if ( jQuery.isFunction( value ) ) { + return this.each(function( i ) { + jQuery( this ).toggleClass( value.call(this, i, this.className, stateVal), stateVal ); + }); + } + + return this.each(function() { + if ( type === "string" ) { + // toggle individual class names + var className, + i = 0, + self = jQuery( this ), + state = stateVal, + classNames = value.split( rspace ); + + while ( (className = classNames[ i++ ]) ) { + // check each className given, space seperated list + state = isBool ? state : !self.hasClass( className ); + self[ state ? "addClass" : "removeClass" ]( className ); + } + + } else if ( type === "undefined" || type === "boolean" ) { + if ( this.className ) { + // store className if set + jQuery._data( this, "__className__", this.className ); + } + + // toggle whole className + this.className = this.className || value === false ? "" : jQuery._data( this, "__className__" ) || ""; + } + }); + }, + + hasClass: function( selector ) { + var className = " " + selector + " ", + i = 0, + l = this.length; + for ( ; i < l; i++ ) { + if ( this[i].nodeType === 1 && (" " + this[i].className + " ").replace(rclass, " ").indexOf( className ) > -1 ) { + return true; + } + } + + return false; + }, + + val: function( value ) { + var hooks, ret, isFunction, + elem = this[0]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && "get" in hooks && (ret = hooks.get( elem, "value" )) !== undefined ) { + return ret; + } + + ret = elem.value; + + return typeof ret === "string" ? + // handle most common string cases + ret.replace(rreturn, "") : + // handle cases where value is null/undef or number + ret == null ? "" : ret; + } + + return; + } + + isFunction = jQuery.isFunction( value ); + + return this.each(function( i ) { + var self = jQuery(this), val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( isFunction ) { + val = value.call( this, i, self.val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + } else if ( typeof val === "number" ) { + val += ""; + } else if ( jQuery.isArray( val ) ) { + val = jQuery.map(val, function ( value ) { + return value == null ? "" : value + ""; + }); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !("set" in hooks) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + }); + } +}); + +jQuery.extend({ + valHooks: { + option: { + get: function( elem ) { + // attributes.value is undefined in Blackberry 4.7 but + // uses .value. See #6932 + var val = elem.attributes.value; + return !val || val.specified ? elem.value : elem.text; + } + }, + select: { + get: function( elem ) { + var value, i, max, option, + index = elem.selectedIndex, + values = [], + options = elem.options, + one = elem.type === "select-one"; + + // Nothing was selected + if ( index < 0 ) { + return null; + } + + // Loop through all the selected options + i = one ? index : 0; + max = one ? index + 1 : options.length; + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Don't return options that are disabled or in a disabled optgroup + if ( option.selected && (jQuery.support.optDisabled ? !option.disabled : option.getAttribute("disabled") === null) && + (!option.parentNode.disabled || !jQuery.nodeName( option.parentNode, "optgroup" )) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + // Fixes Bug #2551 -- select.val() broken in IE after form.reset() + if ( one && !values.length && options.length ) { + return jQuery( options[ index ] ).val(); + } + + return values; + }, + + set: function( elem, value ) { + var values = jQuery.makeArray( value ); + + jQuery(elem).find("option").each(function() { + this.selected = jQuery.inArray( jQuery(this).val(), values ) >= 0; + }); + + if ( !values.length ) { + elem.selectedIndex = -1; + } + return values; + } + } + }, + + attrFn: { + val: true, + css: true, + html: true, + text: true, + data: true, + width: true, + height: true, + offset: true + }, + + attr: function( elem, name, value, pass ) { + var ret, hooks, notxml, + nType = elem.nodeType; + + // don't get/set attributes on text, comment and attribute nodes + if ( !elem || nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( pass && name in jQuery.attrFn ) { + return jQuery( elem )[ name ]( value ); + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + notxml = nType !== 1 || !jQuery.isXMLDoc( elem ); + + // All attributes are lowercase + // Grab necessary hook if one is defined + if ( notxml ) { + name = name.toLowerCase(); + hooks = jQuery.attrHooks[ name ] || ( rboolean.test( name ) ? boolHook : nodeHook ); + } + + if ( value !== undefined ) { + + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + + } else if ( hooks && "set" in hooks && notxml && (ret = hooks.set( elem, value, name )) !== undefined ) { + return ret; + + } else { + elem.setAttribute( name, "" + value ); + return value; + } + + } else if ( hooks && "get" in hooks && notxml && (ret = hooks.get( elem, name )) !== null ) { + return ret; + + } else { + + ret = elem.getAttribute( name ); + + // Non-existent attributes return null, we normalize to undefined + return ret === null ? + undefined : + ret; + } + }, + + removeAttr: function( elem, value ) { + var propName, attrNames, name, l, isBool, + i = 0; + + if ( value && elem.nodeType === 1 ) { + attrNames = value.toLowerCase().split( rspace ); + l = attrNames.length; + + for ( ; i < l; i++ ) { + name = attrNames[ i ]; + + if ( name ) { + propName = jQuery.propFix[ name ] || name; + isBool = rboolean.test( name ); + + // See #9699 for explanation of this approach (setting first, then removal) + // Do not do this for boolean attributes (see #10870) + if ( !isBool ) { + jQuery.attr( elem, name, "" ); + } + elem.removeAttribute( getSetAttribute ? name : propName ); + + // Set corresponding property to false for boolean attributes + if ( isBool && propName in elem ) { + elem[ propName ] = false; + } + } + } + } + }, + + attrHooks: { + type: { + set: function( elem, value ) { + // We can't allow the type property to be changed (since it causes problems in IE) + if ( rtype.test( elem.nodeName ) && elem.parentNode ) { + jQuery.error( "type property can't be changed" ); + } else if ( !jQuery.support.radioValue && value === "radio" && jQuery.nodeName(elem, "input") ) { + // Setting the type on a radio button after the value resets the value in IE6-9 + // Reset value to it's default in case type is set after value + // This is for element creation + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + }, + // Use the value property for back compat + // Use the nodeHook for button elements in IE6/7 (#1954) + value: { + get: function( elem, name ) { + if ( nodeHook && jQuery.nodeName( elem, "button" ) ) { + return nodeHook.get( elem, name ); + } + return name in elem ? + elem.value : + null; + }, + set: function( elem, value, name ) { + if ( nodeHook && jQuery.nodeName( elem, "button" ) ) { + return nodeHook.set( elem, value, name ); + } + // Does not return so that setAttribute is also used + elem.value = value; + } + } + }, + + propFix: { + tabindex: "tabIndex", + readonly: "readOnly", + "for": "htmlFor", + "class": "className", + maxlength: "maxLength", + cellspacing: "cellSpacing", + cellpadding: "cellPadding", + rowspan: "rowSpan", + colspan: "colSpan", + usemap: "useMap", + frameborder: "frameBorder", + contenteditable: "contentEditable" + }, + + prop: function( elem, name, value ) { + var ret, hooks, notxml, + nType = elem.nodeType; + + // don't get/set properties on text, comment and attribute nodes + if ( !elem || nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + notxml = nType !== 1 || !jQuery.isXMLDoc( elem ); + + if ( notxml ) { + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && (ret = hooks.set( elem, value, name )) !== undefined ) { + return ret; + + } else { + return ( elem[ name ] = value ); + } + + } else { + if ( hooks && "get" in hooks && (ret = hooks.get( elem, name )) !== null ) { + return ret; + + } else { + return elem[ name ]; + } + } + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + // elem.tabIndex doesn't always return the correct value when it hasn't been explicitly set + // http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + var attributeNode = elem.getAttributeNode("tabindex"); + + return attributeNode && attributeNode.specified ? + parseInt( attributeNode.value, 10 ) : + rfocusable.test( elem.nodeName ) || rclickable.test( elem.nodeName ) && elem.href ? + 0 : + undefined; + } + } + } +}); + +// Add the tabIndex propHook to attrHooks for back-compat (different case is intentional) +jQuery.attrHooks.tabindex = jQuery.propHooks.tabIndex; + +// Hook for boolean attributes +boolHook = { + get: function( elem, name ) { + // Align boolean attributes with corresponding properties + // Fall back to attribute presence where some booleans are not supported + var attrNode, + property = jQuery.prop( elem, name ); + return property === true || typeof property !== "boolean" && ( attrNode = elem.getAttributeNode(name) ) && attrNode.nodeValue !== false ? + name.toLowerCase() : + undefined; + }, + set: function( elem, value, name ) { + var propName; + if ( value === false ) { + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + // value is true since we know at this point it's type boolean and not false + // Set boolean attributes to the same name and set the DOM property + propName = jQuery.propFix[ name ] || name; + if ( propName in elem ) { + // Only set the IDL specifically if it already exists on the element + elem[ propName ] = true; + } + + elem.setAttribute( name, name.toLowerCase() ); + } + return name; + } +}; + +// IE6/7 do not support getting/setting some attributes with get/setAttribute +if ( !getSetAttribute ) { + + fixSpecified = { + name: true, + id: true, + coords: true + }; + + // Use this for any attribute in IE6/7 + // This fixes almost every IE6/7 issue + nodeHook = jQuery.valHooks.button = { + get: function( elem, name ) { + var ret; + ret = elem.getAttributeNode( name ); + return ret && ( fixSpecified[ name ] ? ret.nodeValue !== "" : ret.specified ) ? + ret.nodeValue : + undefined; + }, + set: function( elem, value, name ) { + // Set the existing or create a new attribute node + var ret = elem.getAttributeNode( name ); + if ( !ret ) { + ret = document.createAttribute( name ); + elem.setAttributeNode( ret ); + } + return ( ret.nodeValue = value + "" ); + } + }; + + // Apply the nodeHook to tabindex + jQuery.attrHooks.tabindex.set = nodeHook.set; + + // Set width and height to auto instead of 0 on empty string( Bug #8150 ) + // This is for removals + jQuery.each([ "width", "height" ], function( i, name ) { + jQuery.attrHooks[ name ] = jQuery.extend( jQuery.attrHooks[ name ], { + set: function( elem, value ) { + if ( value === "" ) { + elem.setAttribute( name, "auto" ); + return value; + } + } + }); + }); + + // Set contenteditable to false on removals(#10429) + // Setting to empty string throws an error as an invalid value + jQuery.attrHooks.contenteditable = { + get: nodeHook.get, + set: function( elem, value, name ) { + if ( value === "" ) { + value = "false"; + } + nodeHook.set( elem, value, name ); + } + }; +} + + +// Some attributes require a special call on IE +if ( !jQuery.support.hrefNormalized ) { + jQuery.each([ "href", "src", "width", "height" ], function( i, name ) { + jQuery.attrHooks[ name ] = jQuery.extend( jQuery.attrHooks[ name ], { + get: function( elem ) { + var ret = elem.getAttribute( name, 2 ); + return ret === null ? undefined : ret; + } + }); + }); +} + +if ( !jQuery.support.style ) { + jQuery.attrHooks.style = { + get: function( elem ) { + // Return undefined in the case of empty string + // Normalize to lowercase since IE uppercases css property names + return elem.style.cssText.toLowerCase() || undefined; + }, + set: function( elem, value ) { + return ( elem.style.cssText = "" + value ); + } + }; +} + +// Safari mis-reports the default selected property of an option +// Accessing the parent's selectedIndex property fixes it +if ( !jQuery.support.optSelected ) { + jQuery.propHooks.selected = jQuery.extend( jQuery.propHooks.selected, { + get: function( elem ) { + var parent = elem.parentNode; + + if ( parent ) { + parent.selectedIndex; + + // Make sure that it also works with optgroups, see #5701 + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + return null; + } + }); +} + +// IE6/7 call enctype encoding +if ( !jQuery.support.enctype ) { + jQuery.propFix.enctype = "encoding"; +} + +// Radios and checkboxes getter/setter +if ( !jQuery.support.checkOn ) { + jQuery.each([ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + get: function( elem ) { + // Handle the case where in Webkit "" is returned instead of "on" if a value isn't specified + return elem.getAttribute("value") === null ? "on" : elem.value; + } + }; + }); +} +jQuery.each([ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = jQuery.extend( jQuery.valHooks[ this ], { + set: function( elem, value ) { + if ( jQuery.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery(elem).val(), value ) >= 0 ); + } + } + }); +}); + + + + +var rformElems = /^(?:textarea|input|select)$/i, + rtypenamespace = /^([^\.]*)?(?:\.(.+))?$/, + rhoverHack = /(?:^|\s)hover(\.\S+)?\b/, + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|contextmenu)|click/, + rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + rquickIs = /^(\w*)(?:#([\w\-]+))?(?:\.([\w\-]+))?$/, + quickParse = function( selector ) { + var quick = rquickIs.exec( selector ); + if ( quick ) { + // 0 1 2 3 + // [ _, tag, id, class ] + quick[1] = ( quick[1] || "" ).toLowerCase(); + quick[3] = quick[3] && new RegExp( "(?:^|\\s)" + quick[3] + "(?:\\s|$)" ); + } + return quick; + }, + quickIs = function( elem, m ) { + var attrs = elem.attributes || {}; + return ( + (!m[1] || elem.nodeName.toLowerCase() === m[1]) && + (!m[2] || (attrs.id || {}).value === m[2]) && + (!m[3] || m[3].test( (attrs[ "class" ] || {}).value )) + ); + }, + hoverHack = function( events ) { + return jQuery.event.special.hover ? events : events.replace( rhoverHack, "mouseenter$1 mouseleave$1" ); + }; + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + add: function( elem, types, handler, data, selector ) { + + var elemData, eventHandle, events, + t, tns, type, namespaces, handleObj, + handleObjIn, quick, handlers, special; + + // Don't attach events to noData or text/comment nodes (allow plain objects tho) + if ( elem.nodeType === 3 || elem.nodeType === 8 || !types || !handler || !(elemData = jQuery._data( elem )) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + events = elemData.events; + if ( !events ) { + elemData.events = events = {}; + } + eventHandle = elemData.handle; + if ( !eventHandle ) { + elemData.handle = eventHandle = function( e ) { + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && (!e || jQuery.event.triggered !== e.type) ? + jQuery.event.dispatch.apply( eventHandle.elem, arguments ) : + undefined; + }; + // Add elem as a property of the handle fn to prevent a memory leak with IE non-native events + eventHandle.elem = elem; + } + + // Handle multiple events separated by a space + // jQuery(...).bind("mouseover mouseout", fn); + types = jQuery.trim( hoverHack(types) ).split( " " ); + for ( t = 0; t < types.length; t++ ) { + + tns = rtypenamespace.exec( types[t] ) || []; + type = tns[1]; + namespaces = ( tns[2] || "" ).split( "." ).sort(); + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend({ + type: type, + origType: tns[1], + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + quick: selector && quickParse( selector ), + namespace: namespaces.join(".") + }, handleObjIn ); + + // Init the event handler queue if we're the first + handlers = events[ type ]; + if ( !handlers ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener/attachEvent if the special events handler returns false + if ( !special.setup || special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + // Bind the global event handler to the element + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle, false ); + + } else if ( elem.attachEvent ) { + elem.attachEvent( "on" + type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + // Nullify elem to prevent memory leaks in IE + elem = null; + }, + + global: {}, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var elemData = jQuery.hasData( elem ) && jQuery._data( elem ), + t, tns, type, origType, namespaces, origCount, + j, events, special, handle, eventType, handleObj; + + if ( !elemData || !(events = elemData.events) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = jQuery.trim( hoverHack( types || "" ) ).split(" "); + for ( t = 0; t < types.length; t++ ) { + tns = rtypenamespace.exec( types[t] ) || []; + type = origType = tns[1]; + namespaces = tns[2]; + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector? special.delegateType : special.bindType ) || type; + eventType = events[ type ] || []; + origCount = eventType.length; + namespaces = namespaces ? new RegExp("(^|\\.)" + namespaces.split(".").sort().join("\\.(?:.*\\.)?") + "(\\.|$)") : null; + + // Remove matching events + for ( j = 0; j < eventType.length; j++ ) { + handleObj = eventType[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !namespaces || namespaces.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || selector === "**" && handleObj.selector ) ) { + eventType.splice( j--, 1 ); + + if ( handleObj.selector ) { + eventType.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( eventType.length === 0 && origCount !== eventType.length ) { + if ( !special.teardown || special.teardown.call( elem, namespaces ) === false ) { + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + handle = elemData.handle; + if ( handle ) { + handle.elem = null; + } + + // removeData also checks for emptiness and clears the expando if empty + // so use it instead of delete + jQuery.removeData( elem, [ "events", "handle" ], true ); + } + }, + + // Events that are safe to short-circuit if no handlers are attached. + // Native DOM events should not be added, they may have inline handlers. + customEvent: { + "getData": true, + "setData": true, + "changeData": true + }, + + trigger: function( event, data, elem, onlyHandlers ) { + // Don't do events on text and comment nodes + if ( elem && (elem.nodeType === 3 || elem.nodeType === 8) ) { + return; + } + + // Event object or event type + var type = event.type || event, + namespaces = [], + cache, exclusive, i, cur, old, ontype, special, handle, eventPath, bubbleType; + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "!" ) >= 0 ) { + // Exclusive events trigger only for the exact event (no namespaces) + type = type.slice(0, -1); + exclusive = true; + } + + if ( type.indexOf( "." ) >= 0 ) { + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split("."); + type = namespaces.shift(); + namespaces.sort(); + } + + if ( (!elem || jQuery.event.customEvent[ type ]) && !jQuery.event.global[ type ] ) { + // No jQuery handlers for this event type, and it can't have inline handlers + return; + } + + // Caller can pass in an Event, Object, or just an event type string + event = typeof event === "object" ? + // jQuery.Event object + event[ jQuery.expando ] ? event : + // Object literal + new jQuery.Event( type, event ) : + // Just the event type (string) + new jQuery.Event( type ); + + event.type = type; + event.isTrigger = true; + event.exclusive = exclusive; + event.namespace = namespaces.join( "." ); + event.namespace_re = event.namespace? new RegExp("(^|\\.)" + namespaces.join("\\.(?:.*\\.)?") + "(\\.|$)") : null; + ontype = type.indexOf( ":" ) < 0 ? "on" + type : ""; + + // Handle a global trigger + if ( !elem ) { + + // TODO: Stop taunting the data cache; remove global events and always attach to document + cache = jQuery.cache; + for ( i in cache ) { + if ( cache[ i ].events && cache[ i ].events[ type ] ) { + jQuery.event.trigger( event, data, cache[ i ].handle.elem, true ); + } + } + return; + } + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data != null ? jQuery.makeArray( data ) : []; + data.unshift( event ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + eventPath = [[ elem, special.bindType || type ]]; + if ( !onlyHandlers && !special.noBubble && !jQuery.isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + cur = rfocusMorph.test( bubbleType + type ) ? elem : elem.parentNode; + old = null; + for ( ; cur; cur = cur.parentNode ) { + eventPath.push([ cur, bubbleType ]); + old = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( old && old === elem.ownerDocument ) { + eventPath.push([ old.defaultView || old.parentWindow || window, bubbleType ]); + } + } + + // Fire handlers on the event path + for ( i = 0; i < eventPath.length && !event.isPropagationStopped(); i++ ) { + + cur = eventPath[i][0]; + event.type = eventPath[i][1]; + + handle = ( jQuery._data( cur, "events" ) || {} )[ event.type ] && jQuery._data( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + // Note that this is a bare JS function and not a jQuery handler + handle = ontype && cur[ ontype ]; + if ( handle && jQuery.acceptData( cur ) && handle.apply( cur, data ) === false ) { + event.preventDefault(); + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( (!special._default || special._default.apply( elem.ownerDocument, data ) === false) && + !(type === "click" && jQuery.nodeName( elem, "a" )) && jQuery.acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name name as the event. + // Can't use an .isFunction() check here because IE6/7 fails that test. + // Don't do default actions on window, that's where global variables be (#6170) + // IE<9 dies on focus/blur to hidden element (#1486) + if ( ontype && elem[ type ] && ((type !== "focus" && type !== "blur") || event.target.offsetWidth !== 0) && !jQuery.isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + old = elem[ ontype ]; + + if ( old ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + elem[ type ](); + jQuery.event.triggered = undefined; + + if ( old ) { + elem[ ontype ] = old; + } + } + } + } + + return event.result; + }, + + dispatch: function( event ) { + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( event || window.event ); + + var handlers = ( (jQuery._data( this, "events" ) || {} )[ event.type ] || []), + delegateCount = handlers.delegateCount, + args = [].slice.call( arguments, 0 ), + run_all = !event.exclusive && !event.namespace, + special = jQuery.event.special[ event.type ] || {}, + handlerQueue = [], + i, j, cur, jqcur, ret, selMatch, matched, matches, handleObj, sel, related; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[0] = event; + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers that should run if there are delegated events + // Avoid non-left-click bubbling in Firefox (#3861) + if ( delegateCount && !(event.button && event.type === "click") ) { + + // Pregenerate a single jQuery object for reuse with .is() + jqcur = jQuery(this); + jqcur.context = this.ownerDocument || this; + + for ( cur = event.target; cur != this; cur = cur.parentNode || this ) { + + // Don't process events on disabled elements (#6911, #8165) + if ( cur.disabled !== true ) { + selMatch = {}; + matches = []; + jqcur[0] = cur; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + sel = handleObj.selector; + + if ( selMatch[ sel ] === undefined ) { + selMatch[ sel ] = ( + handleObj.quick ? quickIs( cur, handleObj.quick ) : jqcur.is( sel ) + ); + } + if ( selMatch[ sel ] ) { + matches.push( handleObj ); + } + } + if ( matches.length ) { + handlerQueue.push({ elem: cur, matches: matches }); + } + } + } + } + + // Add the remaining (directly-bound) handlers + if ( handlers.length > delegateCount ) { + handlerQueue.push({ elem: this, matches: handlers.slice( delegateCount ) }); + } + + // Run delegates first; they may want to stop propagation beneath us + for ( i = 0; i < handlerQueue.length && !event.isPropagationStopped(); i++ ) { + matched = handlerQueue[ i ]; + event.currentTarget = matched.elem; + + for ( j = 0; j < matched.matches.length && !event.isImmediatePropagationStopped(); j++ ) { + handleObj = matched.matches[ j ]; + + // Triggered event must either 1) be non-exclusive and have no namespace, or + // 2) have namespace(s) a subset or equal to those in the bound event (both can have no namespace). + if ( run_all || (!event.namespace && !handleObj.namespace) || event.namespace_re && event.namespace_re.test( handleObj.namespace ) ) { + + event.data = handleObj.data; + event.handleObj = handleObj; + + ret = ( (jQuery.event.special[ handleObj.origType ] || {}).handle || handleObj.handler ) + .apply( matched.elem, args ); + + if ( ret !== undefined ) { + event.result = ret; + if ( ret === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + // Includes some event props shared by KeyEvent and MouseEvent + // *** attrChange attrName relatedNode srcElement are not normalized, non-W3C, deprecated, will be removed in 1.8 *** + props: "attrChange attrName relatedNode srcElement altKey bubbles cancelable ctrlKey currentTarget eventPhase metaKey relatedTarget shiftKey target timeStamp view which".split(" "), + + fixHooks: {}, + + keyHooks: { + props: "char charCode key keyCode".split(" "), + filter: function( event, original ) { + + // Add which for key events + if ( event.which == null ) { + event.which = original.charCode != null ? original.charCode : original.keyCode; + } + + return event; + } + }, + + mouseHooks: { + props: "button buttons clientX clientY fromElement offsetX offsetY pageX pageY screenX screenY toElement".split(" "), + filter: function( event, original ) { + var eventDoc, doc, body, + button = original.button, + fromElement = original.fromElement; + + // Calculate pageX/Y if missing and clientX/Y available + if ( event.pageX == null && original.clientX != null ) { + eventDoc = event.target.ownerDocument || document; + doc = eventDoc.documentElement; + body = eventDoc.body; + + event.pageX = original.clientX + ( doc && doc.scrollLeft || body && body.scrollLeft || 0 ) - ( doc && doc.clientLeft || body && body.clientLeft || 0 ); + event.pageY = original.clientY + ( doc && doc.scrollTop || body && body.scrollTop || 0 ) - ( doc && doc.clientTop || body && body.clientTop || 0 ); + } + + // Add relatedTarget, if necessary + if ( !event.relatedTarget && fromElement ) { + event.relatedTarget = fromElement === event.target ? original.toElement : fromElement; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + // Note: button is not normalized, so don't use it + if ( !event.which && button !== undefined ) { + event.which = ( button & 1 ? 1 : ( button & 2 ? 3 : ( button & 4 ? 2 : 0 ) ) ); + } + + return event; + } + }, + + fix: function( event ) { + if ( event[ jQuery.expando ] ) { + return event; + } + + // Create a writable copy of the event object and normalize some properties + var i, prop, + originalEvent = event, + fixHook = jQuery.event.fixHooks[ event.type ] || {}, + copy = fixHook.props ? this.props.concat( fixHook.props ) : this.props; + + event = jQuery.Event( originalEvent ); + + for ( i = copy.length; i; ) { + prop = copy[ --i ]; + event[ prop ] = originalEvent[ prop ]; + } + + // Fix target property, if necessary (#1925, IE 6/7/8 & Safari2) + if ( !event.target ) { + event.target = originalEvent.srcElement || document; + } + + // Target should not be a text node (#504, Safari) + if ( event.target.nodeType === 3 ) { + event.target = event.target.parentNode; + } + + // For mouse/key events; add metaKey if it's not there (#3368, IE6/7/8) + if ( event.metaKey === undefined ) { + event.metaKey = event.ctrlKey; + } + + return fixHook.filter? fixHook.filter( event, originalEvent ) : event; + }, + + special: { + ready: { + // Make sure the ready event is setup + setup: jQuery.bindReady + }, + + load: { + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + + focus: { + delegateType: "focusin" + }, + blur: { + delegateType: "focusout" + }, + + beforeunload: { + setup: function( data, namespaces, eventHandle ) { + // We only want to do this special case on windows + if ( jQuery.isWindow( this ) ) { + this.onbeforeunload = eventHandle; + } + }, + + teardown: function( namespaces, eventHandle ) { + if ( this.onbeforeunload === eventHandle ) { + this.onbeforeunload = null; + } + } + } + }, + + simulate: function( type, elem, event, bubble ) { + // Piggyback on a donor event to simulate a different one. + // Fake originalEvent to avoid donor's stopPropagation, but if the + // simulated event prevents default then we do the same on the donor. + var e = jQuery.extend( + new jQuery.Event(), + event, + { type: type, + isSimulated: true, + originalEvent: {} + } + ); + if ( bubble ) { + jQuery.event.trigger( e, null, elem ); + } else { + jQuery.event.dispatch.call( elem, e ); + } + if ( e.isDefaultPrevented() ) { + event.preventDefault(); + } + } +}; + +// Some plugins are using, but it's undocumented/deprecated and will be removed. +// The 1.7 special event interface should provide all the hooks needed now. +jQuery.event.handle = jQuery.event.dispatch; + +jQuery.removeEvent = document.removeEventListener ? + function( elem, type, handle ) { + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle, false ); + } + } : + function( elem, type, handle ) { + if ( elem.detachEvent ) { + elem.detachEvent( "on" + type, handle ); + } + }; + +jQuery.Event = function( src, props ) { + // Allow instantiation without the 'new' keyword + if ( !(this instanceof jQuery.Event) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = ( src.defaultPrevented || src.returnValue === false || + src.getPreventDefault && src.getPreventDefault() ) ? returnTrue : returnFalse; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || jQuery.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +function returnFalse() { + return false; +} +function returnTrue() { + return true; +} + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// http://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + preventDefault: function() { + this.isDefaultPrevented = returnTrue; + + var e = this.originalEvent; + if ( !e ) { + return; + } + + // if preventDefault exists run it on the original event + if ( e.preventDefault ) { + e.preventDefault(); + + // otherwise set the returnValue property of the original event to false (IE) + } else { + e.returnValue = false; + } + }, + stopPropagation: function() { + this.isPropagationStopped = returnTrue; + + var e = this.originalEvent; + if ( !e ) { + return; + } + // if stopPropagation exists run it on the original event + if ( e.stopPropagation ) { + e.stopPropagation(); + } + // otherwise set the cancelBubble property of the original event to true (IE) + e.cancelBubble = true; + }, + stopImmediatePropagation: function() { + this.isImmediatePropagationStopped = returnTrue; + this.stopPropagation(); + }, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse +}; + +// Create mouseenter/leave events using mouseover/out and event-time checks +jQuery.each({ + mouseenter: "mouseover", + mouseleave: "mouseout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var target = this, + related = event.relatedTarget, + handleObj = event.handleObj, + selector = handleObj.selector, + ret; + + // For mousenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || (related !== target && !jQuery.contains( target, related )) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +}); + +// IE submit delegation +if ( !jQuery.support.submitBubbles ) { + + jQuery.event.special.submit = { + setup: function() { + // Only need this for delegated form submit events + if ( jQuery.nodeName( this, "form" ) ) { + return false; + } + + // Lazy-add a submit handler when a descendant form may potentially be submitted + jQuery.event.add( this, "click._submit keypress._submit", function( e ) { + // Node name check avoids a VML-related crash in IE (#9807) + var elem = e.target, + form = jQuery.nodeName( elem, "input" ) || jQuery.nodeName( elem, "button" ) ? elem.form : undefined; + if ( form && !form._submit_attached ) { + jQuery.event.add( form, "submit._submit", function( event ) { + event._submit_bubble = true; + }); + form._submit_attached = true; + } + }); + // return undefined since we don't need an event listener + }, + + postDispatch: function( event ) { + // If form was submitted by the user, bubble the event up the tree + if ( event._submit_bubble ) { + delete event._submit_bubble; + if ( this.parentNode && !event.isTrigger ) { + jQuery.event.simulate( "submit", this.parentNode, event, true ); + } + } + }, + + teardown: function() { + // Only need this for delegated form submit events + if ( jQuery.nodeName( this, "form" ) ) { + return false; + } + + // Remove delegated handlers; cleanData eventually reaps submit handlers attached above + jQuery.event.remove( this, "._submit" ); + } + }; +} + +// IE change delegation and checkbox/radio fix +if ( !jQuery.support.changeBubbles ) { + + jQuery.event.special.change = { + + setup: function() { + + if ( rformElems.test( this.nodeName ) ) { + // IE doesn't fire change on a check/radio until blur; trigger it on click + // after a propertychange. Eat the blur-change in special.change.handle. + // This still fires onchange a second time for check/radio after blur. + if ( this.type === "checkbox" || this.type === "radio" ) { + jQuery.event.add( this, "propertychange._change", function( event ) { + if ( event.originalEvent.propertyName === "checked" ) { + this._just_changed = true; + } + }); + jQuery.event.add( this, "click._change", function( event ) { + if ( this._just_changed && !event.isTrigger ) { + this._just_changed = false; + jQuery.event.simulate( "change", this, event, true ); + } + }); + } + return false; + } + // Delegated event; lazy-add a change handler on descendant inputs + jQuery.event.add( this, "beforeactivate._change", function( e ) { + var elem = e.target; + + if ( rformElems.test( elem.nodeName ) && !elem._change_attached ) { + jQuery.event.add( elem, "change._change", function( event ) { + if ( this.parentNode && !event.isSimulated && !event.isTrigger ) { + jQuery.event.simulate( "change", this.parentNode, event, true ); + } + }); + elem._change_attached = true; + } + }); + }, + + handle: function( event ) { + var elem = event.target; + + // Swallow native change events from checkbox/radio, we already triggered them above + if ( this !== elem || event.isSimulated || event.isTrigger || (elem.type !== "radio" && elem.type !== "checkbox") ) { + return event.handleObj.handler.apply( this, arguments ); + } + }, + + teardown: function() { + jQuery.event.remove( this, "._change" ); + + return rformElems.test( this.nodeName ); + } + }; +} + +// Create "bubbling" focus and blur events +if ( !jQuery.support.focusinBubbles ) { + jQuery.each({ focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler while someone wants focusin/focusout + var attaches = 0, + handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ), true ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + if ( attaches++ === 0 ) { + document.addEventListener( orig, handler, true ); + } + }, + teardown: function() { + if ( --attaches === 0 ) { + document.removeEventListener( orig, handler, true ); + } + } + }; + }); +} + +jQuery.fn.extend({ + + on: function( types, selector, data, fn, /*INTERNAL*/ one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { // && selector != null + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + this.on( type, selector, data, types[ type ], one ); + } + return this; + } + + if ( data == null && fn == null ) { + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return this; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return this.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + }); + }, + one: function( types, selector, data, fn ) { + return this.on( types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + if ( types && types.preventDefault && types.handleObj ) { + // ( event ) dispatched jQuery.Event + var handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? handleObj.origType + "." + handleObj.namespace : handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + // ( types-object [, selector] ) + for ( var type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each(function() { + jQuery.event.remove( this, types, fn, selector ); + }); + }, + + bind: function( types, data, fn ) { + return this.on( types, null, data, fn ); + }, + unbind: function( types, fn ) { + return this.off( types, null, fn ); + }, + + live: function( types, data, fn ) { + jQuery( this.context ).on( types, this.selector, data, fn ); + return this; + }, + die: function( types, fn ) { + jQuery( this.context ).off( types, this.selector || "**", fn ); + return this; + }, + + delegate: function( selector, types, data, fn ) { + return this.on( types, selector, data, fn ); + }, + undelegate: function( selector, types, fn ) { + // ( namespace ) or ( selector, types [, fn] ) + return arguments.length == 1? this.off( selector, "**" ) : this.off( types, selector, fn ); + }, + + trigger: function( type, data ) { + return this.each(function() { + jQuery.event.trigger( type, data, this ); + }); + }, + triggerHandler: function( type, data ) { + if ( this[0] ) { + return jQuery.event.trigger( type, data, this[0], true ); + } + }, + + toggle: function( fn ) { + // Save reference to arguments for access in closure + var args = arguments, + guid = fn.guid || jQuery.guid++, + i = 0, + toggler = function( event ) { + // Figure out which function to execute + var lastToggle = ( jQuery._data( this, "lastToggle" + fn.guid ) || 0 ) % i; + jQuery._data( this, "lastToggle" + fn.guid, lastToggle + 1 ); + + // Make sure that clicks stop + event.preventDefault(); + + // and execute the function + return args[ lastToggle ].apply( this, arguments ) || false; + }; + + // link all the functions, so any of them can unbind this click handler + toggler.guid = guid; + while ( i < args.length ) { + args[ i++ ].guid = guid; + } + + return this.click( toggler ); + }, + + hover: function( fnOver, fnOut ) { + return this.mouseenter( fnOver ).mouseleave( fnOut || fnOver ); + } +}); + +jQuery.each( ("blur focus focusin focusout load resize scroll unload click dblclick " + + "mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave " + + "change select submit keydown keypress keyup error contextmenu").split(" "), function( i, name ) { + + // Handle event binding + jQuery.fn[ name ] = function( data, fn ) { + if ( fn == null ) { + fn = data; + data = null; + } + + return arguments.length > 0 ? + this.on( name, null, data, fn ) : + this.trigger( name ); + }; + + if ( jQuery.attrFn ) { + jQuery.attrFn[ name ] = true; + } + + if ( rkeyEvent.test( name ) ) { + jQuery.event.fixHooks[ name ] = jQuery.event.keyHooks; + } + + if ( rmouseEvent.test( name ) ) { + jQuery.event.fixHooks[ name ] = jQuery.event.mouseHooks; + } +}); + + + +/*! + * Sizzle CSS Selector Engine + * Copyright 2011, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * More information: http://sizzlejs.com/ + */ +(function(){ + +var chunker = /((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^\[\]]*\]|['"][^'"]*['"]|[^\[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g, + expando = "sizcache" + (Math.random() + '').replace('.', ''), + done = 0, + toString = Object.prototype.toString, + hasDuplicate = false, + baseHasDuplicate = true, + rBackslash = /\\/g, + rReturn = /\r\n/g, + rNonWord = /\W/; + +// Here we check if the JavaScript engine is using some sort of +// optimization where it does not always call our comparision +// function. If that is the case, discard the hasDuplicate value. +// Thus far that includes Google Chrome. +[0, 0].sort(function() { + baseHasDuplicate = false; + return 0; +}); + +var Sizzle = function( selector, context, results, seed ) { + results = results || []; + context = context || document; + + var origContext = context; + + if ( context.nodeType !== 1 && context.nodeType !== 9 ) { + return []; + } + + if ( !selector || typeof selector !== "string" ) { + return results; + } + + var m, set, checkSet, extra, ret, cur, pop, i, + prune = true, + contextXML = Sizzle.isXML( context ), + parts = [], + soFar = selector; + + // Reset the position of the chunker regexp (start from head) + do { + chunker.exec( "" ); + m = chunker.exec( soFar ); + + if ( m ) { + soFar = m[3]; + + parts.push( m[1] ); + + if ( m[2] ) { + extra = m[3]; + break; + } + } + } while ( m ); + + if ( parts.length > 1 && origPOS.exec( selector ) ) { + + if ( parts.length === 2 && Expr.relative[ parts[0] ] ) { + set = posProcess( parts[0] + parts[1], context, seed ); + + } else { + set = Expr.relative[ parts[0] ] ? + [ context ] : + Sizzle( parts.shift(), context ); + + while ( parts.length ) { + selector = parts.shift(); + + if ( Expr.relative[ selector ] ) { + selector += parts.shift(); + } + + set = posProcess( selector, set, seed ); + } + } + + } else { + // Take a shortcut and set the context if the root selector is an ID + // (but not if it'll be faster if the inner selector is an ID) + if ( !seed && parts.length > 1 && context.nodeType === 9 && !contextXML && + Expr.match.ID.test(parts[0]) && !Expr.match.ID.test(parts[parts.length - 1]) ) { + + ret = Sizzle.find( parts.shift(), context, contextXML ); + context = ret.expr ? + Sizzle.filter( ret.expr, ret.set )[0] : + ret.set[0]; + } + + if ( context ) { + ret = seed ? + { expr: parts.pop(), set: makeArray(seed) } : + Sizzle.find( parts.pop(), parts.length === 1 && (parts[0] === "~" || parts[0] === "+") && context.parentNode ? context.parentNode : context, contextXML ); + + set = ret.expr ? + Sizzle.filter( ret.expr, ret.set ) : + ret.set; + + if ( parts.length > 0 ) { + checkSet = makeArray( set ); + + } else { + prune = false; + } + + while ( parts.length ) { + cur = parts.pop(); + pop = cur; + + if ( !Expr.relative[ cur ] ) { + cur = ""; + } else { + pop = parts.pop(); + } + + if ( pop == null ) { + pop = context; + } + + Expr.relative[ cur ]( checkSet, pop, contextXML ); + } + + } else { + checkSet = parts = []; + } + } + + if ( !checkSet ) { + checkSet = set; + } + + if ( !checkSet ) { + Sizzle.error( cur || selector ); + } + + if ( toString.call(checkSet) === "[object Array]" ) { + if ( !prune ) { + results.push.apply( results, checkSet ); + + } else if ( context && context.nodeType === 1 ) { + for ( i = 0; checkSet[i] != null; i++ ) { + if ( checkSet[i] && (checkSet[i] === true || checkSet[i].nodeType === 1 && Sizzle.contains(context, checkSet[i])) ) { + results.push( set[i] ); + } + } + + } else { + for ( i = 0; checkSet[i] != null; i++ ) { + if ( checkSet[i] && checkSet[i].nodeType === 1 ) { + results.push( set[i] ); + } + } + } + + } else { + makeArray( checkSet, results ); + } + + if ( extra ) { + Sizzle( extra, origContext, results, seed ); + Sizzle.uniqueSort( results ); + } + + return results; +}; + +Sizzle.uniqueSort = function( results ) { + if ( sortOrder ) { + hasDuplicate = baseHasDuplicate; + results.sort( sortOrder ); + + if ( hasDuplicate ) { + for ( var i = 1; i < results.length; i++ ) { + if ( results[i] === results[ i - 1 ] ) { + results.splice( i--, 1 ); + } + } + } + } + + return results; +}; + +Sizzle.matches = function( expr, set ) { + return Sizzle( expr, null, null, set ); +}; + +Sizzle.matchesSelector = function( node, expr ) { + return Sizzle( expr, null, null, [node] ).length > 0; +}; + +Sizzle.find = function( expr, context, isXML ) { + var set, i, len, match, type, left; + + if ( !expr ) { + return []; + } + + for ( i = 0, len = Expr.order.length; i < len; i++ ) { + type = Expr.order[i]; + + if ( (match = Expr.leftMatch[ type ].exec( expr )) ) { + left = match[1]; + match.splice( 1, 1 ); + + if ( left.substr( left.length - 1 ) !== "\\" ) { + match[1] = (match[1] || "").replace( rBackslash, "" ); + set = Expr.find[ type ]( match, context, isXML ); + + if ( set != null ) { + expr = expr.replace( Expr.match[ type ], "" ); + break; + } + } + } + } + + if ( !set ) { + set = typeof context.getElementsByTagName !== "undefined" ? + context.getElementsByTagName( "*" ) : + []; + } + + return { set: set, expr: expr }; +}; + +Sizzle.filter = function( expr, set, inplace, not ) { + var match, anyFound, + type, found, item, filter, left, + i, pass, + old = expr, + result = [], + curLoop = set, + isXMLFilter = set && set[0] && Sizzle.isXML( set[0] ); + + while ( expr && set.length ) { + for ( type in Expr.filter ) { + if ( (match = Expr.leftMatch[ type ].exec( expr )) != null && match[2] ) { + filter = Expr.filter[ type ]; + left = match[1]; + + anyFound = false; + + match.splice(1,1); + + if ( left.substr( left.length - 1 ) === "\\" ) { + continue; + } + + if ( curLoop === result ) { + result = []; + } + + if ( Expr.preFilter[ type ] ) { + match = Expr.preFilter[ type ]( match, curLoop, inplace, result, not, isXMLFilter ); + + if ( !match ) { + anyFound = found = true; + + } else if ( match === true ) { + continue; + } + } + + if ( match ) { + for ( i = 0; (item = curLoop[i]) != null; i++ ) { + if ( item ) { + found = filter( item, match, i, curLoop ); + pass = not ^ found; + + if ( inplace && found != null ) { + if ( pass ) { + anyFound = true; + + } else { + curLoop[i] = false; + } + + } else if ( pass ) { + result.push( item ); + anyFound = true; + } + } + } + } + + if ( found !== undefined ) { + if ( !inplace ) { + curLoop = result; + } + + expr = expr.replace( Expr.match[ type ], "" ); + + if ( !anyFound ) { + return []; + } + + break; + } + } + } + + // Improper expression + if ( expr === old ) { + if ( anyFound == null ) { + Sizzle.error( expr ); + + } else { + break; + } + } + + old = expr; + } + + return curLoop; +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Utility function for retreiving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +var getText = Sizzle.getText = function( elem ) { + var i, node, + nodeType = elem.nodeType, + ret = ""; + + if ( nodeType ) { + if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + // Use textContent || innerText for elements + if ( typeof elem.textContent === 'string' ) { + return elem.textContent; + } else if ( typeof elem.innerText === 'string' ) { + // Replace IE's carriage returns + return elem.innerText.replace( rReturn, '' ); + } else { + // Traverse it's children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + } else { + + // If no nodeType, this is expected to be an array + for ( i = 0; (node = elem[i]); i++ ) { + // Do not traverse comment nodes + if ( node.nodeType !== 8 ) { + ret += getText( node ); + } + } + } + return ret; +}; + +var Expr = Sizzle.selectors = { + order: [ "ID", "NAME", "TAG" ], + + match: { + ID: /#((?:[\w\u00c0-\uFFFF\-]|\\.)+)/, + CLASS: /\.((?:[\w\u00c0-\uFFFF\-]|\\.)+)/, + NAME: /\[name=['"]*((?:[\w\u00c0-\uFFFF\-]|\\.)+)['"]*\]/, + ATTR: /\[\s*((?:[\w\u00c0-\uFFFF\-]|\\.)+)\s*(?:(\S?=)\s*(?:(['"])(.*?)\3|(#?(?:[\w\u00c0-\uFFFF\-]|\\.)*)|)|)\s*\]/, + TAG: /^((?:[\w\u00c0-\uFFFF\*\-]|\\.)+)/, + CHILD: /:(only|nth|last|first)-child(?:\(\s*(even|odd|(?:[+\-]?\d+|(?:[+\-]?\d*)?n\s*(?:[+\-]\s*\d+)?))\s*\))?/, + POS: /:(nth|eq|gt|lt|first|last|even|odd)(?:\((\d*)\))?(?=[^\-]|$)/, + PSEUDO: /:((?:[\w\u00c0-\uFFFF\-]|\\.)+)(?:\((['"]?)((?:\([^\)]+\)|[^\(\)]*)+)\2\))?/ + }, + + leftMatch: {}, + + attrMap: { + "class": "className", + "for": "htmlFor" + }, + + attrHandle: { + href: function( elem ) { + return elem.getAttribute( "href" ); + }, + type: function( elem ) { + return elem.getAttribute( "type" ); + } + }, + + relative: { + "+": function(checkSet, part){ + var isPartStr = typeof part === "string", + isTag = isPartStr && !rNonWord.test( part ), + isPartStrNotTag = isPartStr && !isTag; + + if ( isTag ) { + part = part.toLowerCase(); + } + + for ( var i = 0, l = checkSet.length, elem; i < l; i++ ) { + if ( (elem = checkSet[i]) ) { + while ( (elem = elem.previousSibling) && elem.nodeType !== 1 ) {} + + checkSet[i] = isPartStrNotTag || elem && elem.nodeName.toLowerCase() === part ? + elem || false : + elem === part; + } + } + + if ( isPartStrNotTag ) { + Sizzle.filter( part, checkSet, true ); + } + }, + + ">": function( checkSet, part ) { + var elem, + isPartStr = typeof part === "string", + i = 0, + l = checkSet.length; + + if ( isPartStr && !rNonWord.test( part ) ) { + part = part.toLowerCase(); + + for ( ; i < l; i++ ) { + elem = checkSet[i]; + + if ( elem ) { + var parent = elem.parentNode; + checkSet[i] = parent.nodeName.toLowerCase() === part ? parent : false; + } + } + + } else { + for ( ; i < l; i++ ) { + elem = checkSet[i]; + + if ( elem ) { + checkSet[i] = isPartStr ? + elem.parentNode : + elem.parentNode === part; + } + } + + if ( isPartStr ) { + Sizzle.filter( part, checkSet, true ); + } + } + }, + + "": function(checkSet, part, isXML){ + var nodeCheck, + doneName = done++, + checkFn = dirCheck; + + if ( typeof part === "string" && !rNonWord.test( part ) ) { + part = part.toLowerCase(); + nodeCheck = part; + checkFn = dirNodeCheck; + } + + checkFn( "parentNode", part, doneName, checkSet, nodeCheck, isXML ); + }, + + "~": function( checkSet, part, isXML ) { + var nodeCheck, + doneName = done++, + checkFn = dirCheck; + + if ( typeof part === "string" && !rNonWord.test( part ) ) { + part = part.toLowerCase(); + nodeCheck = part; + checkFn = dirNodeCheck; + } + + checkFn( "previousSibling", part, doneName, checkSet, nodeCheck, isXML ); + } + }, + + find: { + ID: function( match, context, isXML ) { + if ( typeof context.getElementById !== "undefined" && !isXML ) { + var m = context.getElementById(match[1]); + // Check parentNode to catch when Blackberry 4.6 returns + // nodes that are no longer in the document #6963 + return m && m.parentNode ? [m] : []; + } + }, + + NAME: function( match, context ) { + if ( typeof context.getElementsByName !== "undefined" ) { + var ret = [], + results = context.getElementsByName( match[1] ); + + for ( var i = 0, l = results.length; i < l; i++ ) { + if ( results[i].getAttribute("name") === match[1] ) { + ret.push( results[i] ); + } + } + + return ret.length === 0 ? null : ret; + } + }, + + TAG: function( match, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( match[1] ); + } + } + }, + preFilter: { + CLASS: function( match, curLoop, inplace, result, not, isXML ) { + match = " " + match[1].replace( rBackslash, "" ) + " "; + + if ( isXML ) { + return match; + } + + for ( var i = 0, elem; (elem = curLoop[i]) != null; i++ ) { + if ( elem ) { + if ( not ^ (elem.className && (" " + elem.className + " ").replace(/[\t\n\r]/g, " ").indexOf(match) >= 0) ) { + if ( !inplace ) { + result.push( elem ); + } + + } else if ( inplace ) { + curLoop[i] = false; + } + } + } + + return false; + }, + + ID: function( match ) { + return match[1].replace( rBackslash, "" ); + }, + + TAG: function( match, curLoop ) { + return match[1].replace( rBackslash, "" ).toLowerCase(); + }, + + CHILD: function( match ) { + if ( match[1] === "nth" ) { + if ( !match[2] ) { + Sizzle.error( match[0] ); + } + + match[2] = match[2].replace(/^\+|\s*/g, ''); + + // parse equations like 'even', 'odd', '5', '2n', '3n+2', '4n-1', '-n+6' + var test = /(-?)(\d*)(?:n([+\-]?\d*))?/.exec( + match[2] === "even" && "2n" || match[2] === "odd" && "2n+1" || + !/\D/.test( match[2] ) && "0n+" + match[2] || match[2]); + + // calculate the numbers (first)n+(last) including if they are negative + match[2] = (test[1] + (test[2] || 1)) - 0; + match[3] = test[3] - 0; + } + else if ( match[2] ) { + Sizzle.error( match[0] ); + } + + // TODO: Move to normal caching system + match[0] = done++; + + return match; + }, + + ATTR: function( match, curLoop, inplace, result, not, isXML ) { + var name = match[1] = match[1].replace( rBackslash, "" ); + + if ( !isXML && Expr.attrMap[name] ) { + match[1] = Expr.attrMap[name]; + } + + // Handle if an un-quoted value was used + match[4] = ( match[4] || match[5] || "" ).replace( rBackslash, "" ); + + if ( match[2] === "~=" ) { + match[4] = " " + match[4] + " "; + } + + return match; + }, + + PSEUDO: function( match, curLoop, inplace, result, not ) { + if ( match[1] === "not" ) { + // If we're dealing with a complex expression, or a simple one + if ( ( chunker.exec(match[3]) || "" ).length > 1 || /^\w/.test(match[3]) ) { + match[3] = Sizzle(match[3], null, null, curLoop); + + } else { + var ret = Sizzle.filter(match[3], curLoop, inplace, true ^ not); + + if ( !inplace ) { + result.push.apply( result, ret ); + } + + return false; + } + + } else if ( Expr.match.POS.test( match[0] ) || Expr.match.CHILD.test( match[0] ) ) { + return true; + } + + return match; + }, + + POS: function( match ) { + match.unshift( true ); + + return match; + } + }, + + filters: { + enabled: function( elem ) { + return elem.disabled === false && elem.type !== "hidden"; + }, + + disabled: function( elem ) { + return elem.disabled === true; + }, + + checked: function( elem ) { + return elem.checked === true; + }, + + selected: function( elem ) { + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + parent: function( elem ) { + return !!elem.firstChild; + }, + + empty: function( elem ) { + return !elem.firstChild; + }, + + has: function( elem, i, match ) { + return !!Sizzle( match[3], elem ).length; + }, + + header: function( elem ) { + return (/h\d/i).test( elem.nodeName ); + }, + + text: function( elem ) { + var attr = elem.getAttribute( "type" ), type = elem.type; + // IE6 and 7 will map elem.type to 'text' for new HTML5 types (search, etc) + // use getAttribute instead to test this case + return elem.nodeName.toLowerCase() === "input" && "text" === type && ( attr === type || attr === null ); + }, + + radio: function( elem ) { + return elem.nodeName.toLowerCase() === "input" && "radio" === elem.type; + }, + + checkbox: function( elem ) { + return elem.nodeName.toLowerCase() === "input" && "checkbox" === elem.type; + }, + + file: function( elem ) { + return elem.nodeName.toLowerCase() === "input" && "file" === elem.type; + }, + + password: function( elem ) { + return elem.nodeName.toLowerCase() === "input" && "password" === elem.type; + }, + + submit: function( elem ) { + var name = elem.nodeName.toLowerCase(); + return (name === "input" || name === "button") && "submit" === elem.type; + }, + + image: function( elem ) { + return elem.nodeName.toLowerCase() === "input" && "image" === elem.type; + }, + + reset: function( elem ) { + var name = elem.nodeName.toLowerCase(); + return (name === "input" || name === "button") && "reset" === elem.type; + }, + + button: function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && "button" === elem.type || name === "button"; + }, + + input: function( elem ) { + return (/input|select|textarea|button/i).test( elem.nodeName ); + }, + + focus: function( elem ) { + return elem === elem.ownerDocument.activeElement; + } + }, + setFilters: { + first: function( elem, i ) { + return i === 0; + }, + + last: function( elem, i, match, array ) { + return i === array.length - 1; + }, + + even: function( elem, i ) { + return i % 2 === 0; + }, + + odd: function( elem, i ) { + return i % 2 === 1; + }, + + lt: function( elem, i, match ) { + return i < match[3] - 0; + }, + + gt: function( elem, i, match ) { + return i > match[3] - 0; + }, + + nth: function( elem, i, match ) { + return match[3] - 0 === i; + }, + + eq: function( elem, i, match ) { + return match[3] - 0 === i; + } + }, + filter: { + PSEUDO: function( elem, match, i, array ) { + var name = match[1], + filter = Expr.filters[ name ]; + + if ( filter ) { + return filter( elem, i, match, array ); + + } else if ( name === "contains" ) { + return (elem.textContent || elem.innerText || getText([ elem ]) || "").indexOf(match[3]) >= 0; + + } else if ( name === "not" ) { + var not = match[3]; + + for ( var j = 0, l = not.length; j < l; j++ ) { + if ( not[j] === elem ) { + return false; + } + } + + return true; + + } else { + Sizzle.error( name ); + } + }, + + CHILD: function( elem, match ) { + var first, last, + doneName, parent, cache, + count, diff, + type = match[1], + node = elem; + + switch ( type ) { + case "only": + case "first": + while ( (node = node.previousSibling) ) { + if ( node.nodeType === 1 ) { + return false; + } + } + + if ( type === "first" ) { + return true; + } + + node = elem; + + /* falls through */ + case "last": + while ( (node = node.nextSibling) ) { + if ( node.nodeType === 1 ) { + return false; + } + } + + return true; + + case "nth": + first = match[2]; + last = match[3]; + + if ( first === 1 && last === 0 ) { + return true; + } + + doneName = match[0]; + parent = elem.parentNode; + + if ( parent && (parent[ expando ] !== doneName || !elem.nodeIndex) ) { + count = 0; + + for ( node = parent.firstChild; node; node = node.nextSibling ) { + if ( node.nodeType === 1 ) { + node.nodeIndex = ++count; + } + } + + parent[ expando ] = doneName; + } + + diff = elem.nodeIndex - last; + + if ( first === 0 ) { + return diff === 0; + + } else { + return ( diff % first === 0 && diff / first >= 0 ); + } + } + }, + + ID: function( elem, match ) { + return elem.nodeType === 1 && elem.getAttribute("id") === match; + }, + + TAG: function( elem, match ) { + return (match === "*" && elem.nodeType === 1) || !!elem.nodeName && elem.nodeName.toLowerCase() === match; + }, + + CLASS: function( elem, match ) { + return (" " + (elem.className || elem.getAttribute("class")) + " ") + .indexOf( match ) > -1; + }, + + ATTR: function( elem, match ) { + var name = match[1], + result = Sizzle.attr ? + Sizzle.attr( elem, name ) : + Expr.attrHandle[ name ] ? + Expr.attrHandle[ name ]( elem ) : + elem[ name ] != null ? + elem[ name ] : + elem.getAttribute( name ), + value = result + "", + type = match[2], + check = match[4]; + + return result == null ? + type === "!=" : + !type && Sizzle.attr ? + result != null : + type === "=" ? + value === check : + type === "*=" ? + value.indexOf(check) >= 0 : + type === "~=" ? + (" " + value + " ").indexOf(check) >= 0 : + !check ? + value && result !== false : + type === "!=" ? + value !== check : + type === "^=" ? + value.indexOf(check) === 0 : + type === "$=" ? + value.substr(value.length - check.length) === check : + type === "|=" ? + value === check || value.substr(0, check.length + 1) === check + "-" : + false; + }, + + POS: function( elem, match, i, array ) { + var name = match[2], + filter = Expr.setFilters[ name ]; + + if ( filter ) { + return filter( elem, i, match, array ); + } + } + } +}; + +var origPOS = Expr.match.POS, + fescape = function(all, num){ + return "\\" + (num - 0 + 1); + }; + +for ( var type in Expr.match ) { + Expr.match[ type ] = new RegExp( Expr.match[ type ].source + (/(?![^\[]*\])(?![^\(]*\))/.source) ); + Expr.leftMatch[ type ] = new RegExp( /(^(?:.|\r|\n)*?)/.source + Expr.match[ type ].source.replace(/\\(\d+)/g, fescape) ); +} +// Expose origPOS +// "global" as in regardless of relation to brackets/parens +Expr.match.globalPOS = origPOS; + +var makeArray = function( array, results ) { + array = Array.prototype.slice.call( array, 0 ); + + if ( results ) { + results.push.apply( results, array ); + return results; + } + + return array; +}; + +// Perform a simple check to determine if the browser is capable of +// converting a NodeList to an array using builtin methods. +// Also verifies that the returned array holds DOM nodes +// (which is not the case in the Blackberry browser) +try { + Array.prototype.slice.call( document.documentElement.childNodes, 0 )[0].nodeType; + +// Provide a fallback method if it does not work +} catch( e ) { + makeArray = function( array, results ) { + var i = 0, + ret = results || []; + + if ( toString.call(array) === "[object Array]" ) { + Array.prototype.push.apply( ret, array ); + + } else { + if ( typeof array.length === "number" ) { + for ( var l = array.length; i < l; i++ ) { + ret.push( array[i] ); + } + + } else { + for ( ; array[i]; i++ ) { + ret.push( array[i] ); + } + } + } + + return ret; + }; +} + +var sortOrder, siblingCheck; + +if ( document.documentElement.compareDocumentPosition ) { + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + if ( !a.compareDocumentPosition || !b.compareDocumentPosition ) { + return a.compareDocumentPosition ? -1 : 1; + } + + return a.compareDocumentPosition(b) & 4 ? -1 : 1; + }; + +} else { + sortOrder = function( a, b ) { + // The nodes are identical, we can exit early + if ( a === b ) { + hasDuplicate = true; + return 0; + + // Fallback to using sourceIndex (in IE) if it's available on both nodes + } else if ( a.sourceIndex && b.sourceIndex ) { + return a.sourceIndex - b.sourceIndex; + } + + var al, bl, + ap = [], + bp = [], + aup = a.parentNode, + bup = b.parentNode, + cur = aup; + + // If the nodes are siblings (or identical) we can do a quick check + if ( aup === bup ) { + return siblingCheck( a, b ); + + // If no parents were found then the nodes are disconnected + } else if ( !aup ) { + return -1; + + } else if ( !bup ) { + return 1; + } + + // Otherwise they're somewhere else in the tree so we need + // to build up a full list of the parentNodes for comparison + while ( cur ) { + ap.unshift( cur ); + cur = cur.parentNode; + } + + cur = bup; + + while ( cur ) { + bp.unshift( cur ); + cur = cur.parentNode; + } + + al = ap.length; + bl = bp.length; + + // Start walking down the tree looking for a discrepancy + for ( var i = 0; i < al && i < bl; i++ ) { + if ( ap[i] !== bp[i] ) { + return siblingCheck( ap[i], bp[i] ); + } + } + + // We ended someplace up the tree so do a sibling check + return i === al ? + siblingCheck( a, bp[i], -1 ) : + siblingCheck( ap[i], b, 1 ); + }; + + siblingCheck = function( a, b, ret ) { + if ( a === b ) { + return ret; + } + + var cur = a.nextSibling; + + while ( cur ) { + if ( cur === b ) { + return -1; + } + + cur = cur.nextSibling; + } + + return 1; + }; +} + +// Check to see if the browser returns elements by name when +// querying by getElementById (and provide a workaround) +(function(){ + // We're going to inject a fake input element with a specified name + var form = document.createElement("div"), + id = "script" + (new Date()).getTime(), + root = document.documentElement; + + form.innerHTML = ""; + + // Inject it into the root element, check its status, and remove it quickly + root.insertBefore( form, root.firstChild ); + + // The workaround has to do additional checks after a getElementById + // Which slows things down for other browsers (hence the branching) + if ( document.getElementById( id ) ) { + Expr.find.ID = function( match, context, isXML ) { + if ( typeof context.getElementById !== "undefined" && !isXML ) { + var m = context.getElementById(match[1]); + + return m ? + m.id === match[1] || typeof m.getAttributeNode !== "undefined" && m.getAttributeNode("id").nodeValue === match[1] ? + [m] : + undefined : + []; + } + }; + + Expr.filter.ID = function( elem, match ) { + var node = typeof elem.getAttributeNode !== "undefined" && elem.getAttributeNode("id"); + + return elem.nodeType === 1 && node && node.nodeValue === match; + }; + } + + root.removeChild( form ); + + // release memory in IE + root = form = null; +})(); + +(function(){ + // Check to see if the browser returns only elements + // when doing getElementsByTagName("*") + + // Create a fake element + var div = document.createElement("div"); + div.appendChild( document.createComment("") ); + + // Make sure no comments are found + if ( div.getElementsByTagName("*").length > 0 ) { + Expr.find.TAG = function( match, context ) { + var results = context.getElementsByTagName( match[1] ); + + // Filter out possible comments + if ( match[1] === "*" ) { + var tmp = []; + + for ( var i = 0; results[i]; i++ ) { + if ( results[i].nodeType === 1 ) { + tmp.push( results[i] ); + } + } + + results = tmp; + } + + return results; + }; + } + + // Check to see if an attribute returns normalized href attributes + div.innerHTML = ""; + + if ( div.firstChild && typeof div.firstChild.getAttribute !== "undefined" && + div.firstChild.getAttribute("href") !== "#" ) { + + Expr.attrHandle.href = function( elem ) { + return elem.getAttribute( "href", 2 ); + }; + } + + // release memory in IE + div = null; +})(); + +if ( document.querySelectorAll ) { + (function(){ + var oldSizzle = Sizzle, + div = document.createElement("div"), + id = "__sizzle__"; + + div.innerHTML = "

"; + + // Safari can't handle uppercase or unicode characters when + // in quirks mode. + if ( div.querySelectorAll && div.querySelectorAll(".TEST").length === 0 ) { + return; + } + + Sizzle = function( query, context, extra, seed ) { + context = context || document; + + // Only use querySelectorAll on non-XML documents + // (ID selectors don't work in non-HTML documents) + if ( !seed && !Sizzle.isXML(context) ) { + // See if we find a selector to speed up + var match = /^(\w+$)|^\.([\w\-]+$)|^#([\w\-]+$)/.exec( query ); + + if ( match && (context.nodeType === 1 || context.nodeType === 9) ) { + // Speed-up: Sizzle("TAG") + if ( match[1] ) { + return makeArray( context.getElementsByTagName( query ), extra ); + + // Speed-up: Sizzle(".CLASS") + } else if ( match[2] && Expr.find.CLASS && context.getElementsByClassName ) { + return makeArray( context.getElementsByClassName( match[2] ), extra ); + } + } + + if ( context.nodeType === 9 ) { + // Speed-up: Sizzle("body") + // The body element only exists once, optimize finding it + if ( query === "body" && context.body ) { + return makeArray( [ context.body ], extra ); + + // Speed-up: Sizzle("#ID") + } else if ( match && match[3] ) { + var elem = context.getElementById( match[3] ); + + // Check parentNode to catch when Blackberry 4.6 returns + // nodes that are no longer in the document #6963 + if ( elem && elem.parentNode ) { + // Handle the case where IE and Opera return items + // by name instead of ID + if ( elem.id === match[3] ) { + return makeArray( [ elem ], extra ); + } + + } else { + return makeArray( [], extra ); + } + } + + try { + return makeArray( context.querySelectorAll(query), extra ); + } catch(qsaError) {} + + // qSA works strangely on Element-rooted queries + // We can work around this by specifying an extra ID on the root + // and working up from there (Thanks to Andrew Dupont for the technique) + // IE 8 doesn't work on object elements + } else if ( context.nodeType === 1 && context.nodeName.toLowerCase() !== "object" ) { + var oldContext = context, + old = context.getAttribute( "id" ), + nid = old || id, + hasParent = context.parentNode, + relativeHierarchySelector = /^\s*[+~]/.test( query ); + + if ( !old ) { + context.setAttribute( "id", nid ); + } else { + nid = nid.replace( /'/g, "\\$&" ); + } + if ( relativeHierarchySelector && hasParent ) { + context = context.parentNode; + } + + try { + if ( !relativeHierarchySelector || hasParent ) { + return makeArray( context.querySelectorAll( "[id='" + nid + "'] " + query ), extra ); + } + + } catch(pseudoError) { + } finally { + if ( !old ) { + oldContext.removeAttribute( "id" ); + } + } + } + } + + return oldSizzle(query, context, extra, seed); + }; + + for ( var prop in oldSizzle ) { + Sizzle[ prop ] = oldSizzle[ prop ]; + } + + // release memory in IE + div = null; + })(); +} + +(function(){ + var html = document.documentElement, + matches = html.matchesSelector || html.mozMatchesSelector || html.webkitMatchesSelector || html.msMatchesSelector; + + if ( matches ) { + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9 fails this) + var disconnectedMatch = !matches.call( document.createElement( "div" ), "div" ), + pseudoWorks = false; + + try { + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( document.documentElement, "[test!='']:sizzle" ); + + } catch( pseudoError ) { + pseudoWorks = true; + } + + Sizzle.matchesSelector = function( node, expr ) { + // Make sure that attribute selectors are quoted + expr = expr.replace(/\=\s*([^'"\]]*)\s*\]/g, "='$1']"); + + if ( !Sizzle.isXML( node ) ) { + try { + if ( pseudoWorks || !Expr.match.PSEUDO.test( expr ) && !/!=/.test( expr ) ) { + var ret = matches.call( node, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || !disconnectedMatch || + // As well, disconnected nodes are said to be in a document + // fragment in IE 9, so check for that + node.document && node.document.nodeType !== 11 ) { + return ret; + } + } + } catch(e) {} + } + + return Sizzle(expr, null, null, [node]).length > 0; + }; + } +})(); + +(function(){ + var div = document.createElement("div"); + + div.innerHTML = "
"; + + // Opera can't find a second classname (in 9.6) + // Also, make sure that getElementsByClassName actually exists + if ( !div.getElementsByClassName || div.getElementsByClassName("e").length === 0 ) { + return; + } + + // Safari caches class attributes, doesn't catch changes (in 3.2) + div.lastChild.className = "e"; + + if ( div.getElementsByClassName("e").length === 1 ) { + return; + } + + Expr.order.splice(1, 0, "CLASS"); + Expr.find.CLASS = function( match, context, isXML ) { + if ( typeof context.getElementsByClassName !== "undefined" && !isXML ) { + return context.getElementsByClassName(match[1]); + } + }; + + // release memory in IE + div = null; +})(); + +function dirNodeCheck( dir, cur, doneName, checkSet, nodeCheck, isXML ) { + for ( var i = 0, l = checkSet.length; i < l; i++ ) { + var elem = checkSet[i]; + + if ( elem ) { + var match = false; + + elem = elem[dir]; + + while ( elem ) { + if ( elem[ expando ] === doneName ) { + match = checkSet[elem.sizset]; + break; + } + + if ( elem.nodeType === 1 && !isXML ){ + elem[ expando ] = doneName; + elem.sizset = i; + } + + if ( elem.nodeName.toLowerCase() === cur ) { + match = elem; + break; + } + + elem = elem[dir]; + } + + checkSet[i] = match; + } + } +} + +function dirCheck( dir, cur, doneName, checkSet, nodeCheck, isXML ) { + for ( var i = 0, l = checkSet.length; i < l; i++ ) { + var elem = checkSet[i]; + + if ( elem ) { + var match = false; + + elem = elem[dir]; + + while ( elem ) { + if ( elem[ expando ] === doneName ) { + match = checkSet[elem.sizset]; + break; + } + + if ( elem.nodeType === 1 ) { + if ( !isXML ) { + elem[ expando ] = doneName; + elem.sizset = i; + } + + if ( typeof cur !== "string" ) { + if ( elem === cur ) { + match = true; + break; + } + + } else if ( Sizzle.filter( cur, [elem] ).length > 0 ) { + match = elem; + break; + } + } + + elem = elem[dir]; + } + + checkSet[i] = match; + } + } +} + +if ( document.documentElement.contains ) { + Sizzle.contains = function( a, b ) { + return a !== b && (a.contains ? a.contains(b) : true); + }; + +} else if ( document.documentElement.compareDocumentPosition ) { + Sizzle.contains = function( a, b ) { + return !!(a.compareDocumentPosition(b) & 16); + }; + +} else { + Sizzle.contains = function() { + return false; + }; +} + +Sizzle.isXML = function( elem ) { + // documentElement is verified for cases where it doesn't yet exist + // (such as loading iframes in IE - #4833) + var documentElement = (elem ? elem.ownerDocument || elem : 0).documentElement; + + return documentElement ? documentElement.nodeName !== "HTML" : false; +}; + +var posProcess = function( selector, context, seed ) { + var match, + tmpSet = [], + later = "", + root = context.nodeType ? [context] : context; + + // Position selectors must be done after the filter + // And so must :not(positional) so we move all PSEUDOs to the end + while ( (match = Expr.match.PSEUDO.exec( selector )) ) { + later += match[0]; + selector = selector.replace( Expr.match.PSEUDO, "" ); + } + + selector = Expr.relative[selector] ? selector + "*" : selector; + + for ( var i = 0, l = root.length; i < l; i++ ) { + Sizzle( selector, root[i], tmpSet, seed ); + } + + return Sizzle.filter( later, tmpSet ); +}; + +// EXPOSE +// Override sizzle attribute retrieval +Sizzle.attr = jQuery.attr; +Sizzle.selectors.attrMap = {}; +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; +jQuery.expr[":"] = jQuery.expr.filters; +jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; + + +})(); + + +var runtil = /Until$/, + rparentsprev = /^(?:parents|prevUntil|prevAll)/, + // Note: This RegExp should be improved, or likely pulled from Sizzle + rmultiselector = /,/, + isSimple = /^.[^:#\[\.,]*$/, + slice = Array.prototype.slice, + POS = jQuery.expr.match.globalPOS, + // methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend({ + find: function( selector ) { + var self = this, + i, l; + + if ( typeof selector !== "string" ) { + return jQuery( selector ).filter(function() { + for ( i = 0, l = self.length; i < l; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + }); + } + + var ret = this.pushStack( "", "find", selector ), + length, n, r; + + for ( i = 0, l = this.length; i < l; i++ ) { + length = ret.length; + jQuery.find( selector, this[i], ret ); + + if ( i > 0 ) { + // Make sure that the results are unique + for ( n = length; n < ret.length; n++ ) { + for ( r = 0; r < length; r++ ) { + if ( ret[r] === ret[n] ) { + ret.splice(n--, 1); + break; + } + } + } + } + } + + return ret; + }, + + has: function( target ) { + var targets = jQuery( target ); + return this.filter(function() { + for ( var i = 0, l = targets.length; i < l; i++ ) { + if ( jQuery.contains( this, targets[i] ) ) { + return true; + } + } + }); + }, + + not: function( selector ) { + return this.pushStack( winnow(this, selector, false), "not", selector); + }, + + filter: function( selector ) { + return this.pushStack( winnow(this, selector, true), "filter", selector ); + }, + + is: function( selector ) { + return !!selector && ( + typeof selector === "string" ? + // If this is a positional selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + POS.test( selector ) ? + jQuery( selector, this.context ).index( this[0] ) >= 0 : + jQuery.filter( selector, this ).length > 0 : + this.filter( selector ).length > 0 ); + }, + + closest: function( selectors, context ) { + var ret = [], i, l, cur = this[0]; + + // Array (deprecated as of jQuery 1.7) + if ( jQuery.isArray( selectors ) ) { + var level = 1; + + while ( cur && cur.ownerDocument && cur !== context ) { + for ( i = 0; i < selectors.length; i++ ) { + + if ( jQuery( cur ).is( selectors[ i ] ) ) { + ret.push({ selector: selectors[ i ], elem: cur, level: level }); + } + } + + cur = cur.parentNode; + level++; + } + + return ret; + } + + // String + var pos = POS.test( selectors ) || typeof selectors !== "string" ? + jQuery( selectors, context || this.context ) : + 0; + + for ( i = 0, l = this.length; i < l; i++ ) { + cur = this[i]; + + while ( cur ) { + if ( pos ? pos.index(cur) > -1 : jQuery.find.matchesSelector(cur, selectors) ) { + ret.push( cur ); + break; + + } else { + cur = cur.parentNode; + if ( !cur || !cur.ownerDocument || cur === context || cur.nodeType === 11 ) { + break; + } + } + } + } + + ret = ret.length > 1 ? jQuery.unique( ret ) : ret; + + return this.pushStack( ret, "closest", selectors ); + }, + + // Determine the position of an element within + // the matched set of elements + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[0] && this[0].parentNode ) ? this.prevAll().length : -1; + } + + // index in selector + if ( typeof elem === "string" ) { + return jQuery.inArray( this[0], jQuery( elem ) ); + } + + // Locate the position of the desired element + return jQuery.inArray( + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[0] : elem, this ); + }, + + add: function( selector, context ) { + var set = typeof selector === "string" ? + jQuery( selector, context ) : + jQuery.makeArray( selector && selector.nodeType ? [ selector ] : selector ), + all = jQuery.merge( this.get(), set ); + + return this.pushStack( isDisconnected( set[0] ) || isDisconnected( all[0] ) ? + all : + jQuery.unique( all ) ); + }, + + andSelf: function() { + return this.add( this.prevObject ); + } +}); + +// A painfully simple check to see if an element is disconnected +// from a document (should be improved, where feasible). +function isDisconnected( node ) { + return !node || !node.parentNode || node.parentNode.nodeType === 11; +} + +jQuery.each({ + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return jQuery.dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, i, until ) { + return jQuery.dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return jQuery.nth( elem, 2, "nextSibling" ); + }, + prev: function( elem ) { + return jQuery.nth( elem, 2, "previousSibling" ); + }, + nextAll: function( elem ) { + return jQuery.dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return jQuery.dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, i, until ) { + return jQuery.dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, i, until ) { + return jQuery.dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return jQuery.sibling( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return jQuery.sibling( elem.firstChild ); + }, + contents: function( elem ) { + return jQuery.nodeName( elem, "iframe" ) ? + elem.contentDocument || elem.contentWindow.document : + jQuery.makeArray( elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var ret = jQuery.map( this, fn, until ); + + if ( !runtil.test( name ) ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + ret = jQuery.filter( selector, ret ); + } + + ret = this.length > 1 && !guaranteedUnique[ name ] ? jQuery.unique( ret ) : ret; + + if ( (this.length > 1 || rmultiselector.test( selector )) && rparentsprev.test( name ) ) { + ret = ret.reverse(); + } + + return this.pushStack( ret, name, slice.call( arguments ).join(",") ); + }; +}); + +jQuery.extend({ + filter: function( expr, elems, not ) { + if ( not ) { + expr = ":not(" + expr + ")"; + } + + return elems.length === 1 ? + jQuery.find.matchesSelector(elems[0], expr) ? [ elems[0] ] : [] : + jQuery.find.matches(expr, elems); + }, + + dir: function( elem, dir, until ) { + var matched = [], + cur = elem[ dir ]; + + while ( cur && cur.nodeType !== 9 && (until === undefined || cur.nodeType !== 1 || !jQuery( cur ).is( until )) ) { + if ( cur.nodeType === 1 ) { + matched.push( cur ); + } + cur = cur[dir]; + } + return matched; + }, + + nth: function( cur, result, dir, elem ) { + result = result || 1; + var num = 0; + + for ( ; cur; cur = cur[dir] ) { + if ( cur.nodeType === 1 && ++num === result ) { + break; + } + } + + return cur; + }, + + sibling: function( n, elem ) { + var r = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + r.push( n ); + } + } + + return r; + } +}); + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, keep ) { + + // Can't pass null or undefined to indexOf in Firefox 4 + // Set to 0 to skip string check + qualifier = qualifier || 0; + + if ( jQuery.isFunction( qualifier ) ) { + return jQuery.grep(elements, function( elem, i ) { + var retVal = !!qualifier.call( elem, i, elem ); + return retVal === keep; + }); + + } else if ( qualifier.nodeType ) { + return jQuery.grep(elements, function( elem, i ) { + return ( elem === qualifier ) === keep; + }); + + } else if ( typeof qualifier === "string" ) { + var filtered = jQuery.grep(elements, function( elem ) { + return elem.nodeType === 1; + }); + + if ( isSimple.test( qualifier ) ) { + return jQuery.filter(qualifier, filtered, !keep); + } else { + qualifier = jQuery.filter( qualifier, filtered ); + } + } + + return jQuery.grep(elements, function( elem, i ) { + return ( jQuery.inArray( elem, qualifier ) >= 0 ) === keep; + }); +} + + + + +function createSafeFragment( document ) { + var list = nodeNames.split( "|" ), + safeFrag = document.createDocumentFragment(); + + if ( safeFrag.createElement ) { + while ( list.length ) { + safeFrag.createElement( + list.pop() + ); + } + } + return safeFrag; +} + +var nodeNames = "abbr|article|aside|audio|bdi|canvas|data|datalist|details|figcaption|figure|footer|" + + "header|hgroup|mark|meter|nav|output|progress|section|summary|time|video", + rinlinejQuery = / jQuery\d+="(?:\d+|null)"/g, + rleadingWhitespace = /^\s+/, + rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/ig, + rtagName = /<([\w:]+)/, + rtbody = /]", "i"), + // checked="checked" or checked + rchecked = /checked\s*(?:[^=]|=\s*.checked.)/i, + rscriptType = /\/(java|ecma)script/i, + rcleanScript = /^\s*", "" ], + legend: [ 1, "
", "
" ], + thead: [ 1, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + col: [ 2, "", "
" ], + area: [ 1, "", "" ], + _default: [ 0, "", "" ] + }, + safeFragment = createSafeFragment( document ); + +wrapMap.optgroup = wrapMap.option; +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// IE can't serialize and + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • averagingModel command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

averagingModel command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
averagingModel model;
+
+
+
    +
  • model = name of averaging model to be applied
    • +
+
+
+

Examples

+
averagingModel dense;
+averagingModel dilute;
+
+
+

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

+
+
+

Description

+

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

+
+
+

Restrictions

+

None.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/averagingModel_dense.html b/doc/_build/html/averagingModel_dense.html new file mode 100644 index 0000000..318253e --- /dev/null +++ b/doc/_build/html/averagingModel_dense.html @@ -0,0 +1,226 @@ + + + + + + + + + + + averagingModel_dense command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • averagingModel_dense command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

averagingModel_dense command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
averagingModel dense;
+
+
+
+
+

Examples

+
averagingModel dense;
+
+
+
+
+

Description

+

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.

+
+
+

Restrictions

+

No known restrictions.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/averagingModel_dilute.html b/doc/_build/html/averagingModel_dilute.html new file mode 100644 index 0000000..7270651 --- /dev/null +++ b/doc/_build/html/averagingModel_dilute.html @@ -0,0 +1,227 @@ + + + + + + + + + + + averagingModel_dilute command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • averagingModel_dilute command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

averagingModel_dilute command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
averagingModel dilute;
+
+
+
+
+

Examples

+
averagingModel dilute;
+
+
+
+
+

Description

+

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 “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).

+
+
+

Restrictions

+

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

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/cfdemSolverIB.html b/doc/_build/html/cfdemSolverIB.html new file mode 100644 index 0000000..44894e9 --- /dev/null +++ b/doc/_build/html/cfdemSolverIB.html @@ -0,0 +1,221 @@ + + + + + + + + + + + cfdemSolverIB command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • cfdemSolverIB command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

cfdemSolverIB command

+
+

Description

+

“cfdemSolverIB” is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework, for calculating +the 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(R)(*) 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.

+

Code of this solver contributions by Alice Hager, JKU.

+

Algorithm:

+

For each time step ...

+
    +
  • 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).
    • +
  • the Navier-Stokes equations are solved on the whole computational domain, disregarding the solid phase.
    • +
  • 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.
    • +
  • 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.
    • +
+

Use:

+

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:

+

engineSearchIB, ArchimedesIB, ShirgaonkarIB, IBVoidfraction

+

References:

+

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

+

and

+

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

+
+

(*) 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.

+
+
+
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/cfdemSolverPiso.html b/doc/_build/html/cfdemSolverPiso.html new file mode 100644 index 0000000..819f814 --- /dev/null +++ b/doc/_build/html/cfdemSolverPiso.html @@ -0,0 +1,206 @@ + + + + + + + + + + + cfdemSolverPiso command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • cfdemSolverPiso command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

cfdemSolverPiso command

+
+

Description

+

“cfdemSolverPiso” is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam(R)(*), 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.

+

see:

+

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.

+
+

(*) 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.

+
+
+
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/cfdemSolverPisoScalar.html b/doc/_build/html/cfdemSolverPisoScalar.html new file mode 100644 index 0000000..89d9149 --- /dev/null +++ b/doc/_build/html/cfdemSolverPisoScalar.html @@ -0,0 +1,207 @@ + + + + + + + + + + + cfdemSolverPisoScalar command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • cfdemSolverPisoScalar command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

cfdemSolverPisoScalar command

+
+

Description

+

“cfdemSolverPisoScalar” is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam(R)(*), 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”.

+

see:

+

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.

+

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

+
+

(*) 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.

+
+
+
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/clockModel.html b/doc/_build/html/clockModel.html new file mode 100644 index 0000000..5af8dce --- /dev/null +++ b/doc/_build/html/clockModel.html @@ -0,0 +1,228 @@ + + + + + + + + + + + clockModel command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+ +
+ +
+
+
+ +
+

clockModel command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
clockModel model;
+
+
+
    +
  • model = name of the clockModel to be applied
    • +
+
+
+

Examples

+
clockModel standardClock;
+
+
+

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

+
+
+

Description

+

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

+

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

+
+
+

Restrictions

+
+
none.
+

Default: none.

+
+
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/clockModel_noClock.html b/doc/_build/html/clockModel_noClock.html new file mode 100644 index 0000000..2113e0b --- /dev/null +++ b/doc/_build/html/clockModel_noClock.html @@ -0,0 +1,227 @@ + + + + + + + + + + + clockModel_noClock command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • clockModel_noClock command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

clockModel_noClock command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
clockModel off;
+
+
+
+
+

Examples

+
clockModel off;
+
+
+
+
+

Description

+

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

+
+
+

Restrictions

+
+
none.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/clockModel_standardClock.html b/doc/_build/html/clockModel_standardClock.html new file mode 100644 index 0000000..b27fa7f --- /dev/null +++ b/doc/_build/html/clockModel_standardClock.html @@ -0,0 +1,229 @@ + + + + + + + + + + + clockModel_standardClock command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • clockModel_standardClock command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

clockModel_standardClock command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
clockModel standardClock;
+
+
+
+
+

Examples

+
clockModel standardClock;
+
+
+
+
+

Description

+

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 . +Since 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. +After 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.

+
+
+

Restrictions

+
+
none.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/dataExchangeModel.html b/doc/_build/html/dataExchangeModel.html new file mode 100644 index 0000000..7f9d5cb --- /dev/null +++ b/doc/_build/html/dataExchangeModel.html @@ -0,0 +1,232 @@ + + + + + + + + + + + dataExchangeModel command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • dataExchangeModel command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

dataExchangeModel command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
dataExchangeModel model;
+
+
+
    +
  • model = name of data exchange model to be applied
    • +
+
+
+

Examples

+
dataExchangeModel twoWayFiles;
+dataExchangeModel twoWayMPI;
+
+
+

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

+
+
+

Description

+

The data exchange model performs the data exchange between the DEM code and the CFD code.

+
+
+

Restrictions

+

None.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/dataExchangeModel_noDataExchange.html b/doc/_build/html/dataExchangeModel_noDataExchange.html new file mode 100644 index 0000000..c5d9e7e --- /dev/null +++ b/doc/_build/html/dataExchangeModel_noDataExchange.html @@ -0,0 +1,226 @@ + + + + + + + + + + + dataExchangeModel_noDataExchange command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • dataExchangeModel_noDataExchange command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

dataExchangeModel_noDataExchange command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
dataExchangeModel noDataExchange;
+
+
+
+
+

Examples

+
dataExchangeModel noDataExchange;
+
+
+
+
+

Description

+

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.

+
+
+

Restrictions

+

None.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/dataExchangeModel_oneWayVTK.html b/doc/_build/html/dataExchangeModel_oneWayVTK.html new file mode 100644 index 0000000..12de7e5 --- /dev/null +++ b/doc/_build/html/dataExchangeModel_oneWayVTK.html @@ -0,0 +1,246 @@ + + + + + + + + + + + dataExchangeModel_oneWayVTK command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • dataExchangeModel_oneWayVTK command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

dataExchangeModel_oneWayVTK command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
dataExchangeModel oneWayVTK;
+oneWayVTKProps
+{
+    DEMts timeStep;
+    relativePath "path";
+    couplingFilename "filename";
+    maxNumberOfParticles number;
+};
+
+
+
    +
  • timeStep = time step size of stored DEM data
    • +
  • path = path to the VTK data files relative do simulation directory
    • +
  • filename = filename of the VTK file series
    • +
  • number = maximum number of particles in DEM simulation
    • +
+
+
+

Examples

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

Description

+

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.

+
+
+

Restrictions

+

None.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/dataExchangeModel_twoWayFiles.html b/doc/_build/html/dataExchangeModel_twoWayFiles.html new file mode 100644 index 0000000..2a678fe --- /dev/null +++ b/doc/_build/html/dataExchangeModel_twoWayFiles.html @@ -0,0 +1,242 @@ + + + + + + + + + + + dataExchangeModel_twoWayFiles command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • dataExchangeModel_twoWayFiles command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

dataExchangeModel_twoWayFiles command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
dataExchangeModel twoWayFiles;
+twoWayFilesProps
+{
+    couplingFilename "filename";
+    maxNumberOfParticles scalar1;
+    DEMts scalar2;
+};
+
+
+
    +
  • filename = filename of the VTK file series
    • +
  • scalar1 = maximum number of particles in DEM simulation
    • +
  • scalar2 = DEM time step width
    • +
+
+
+

Examples

+
dataExchangeModel twoWayFiles;
+twoWayFilesProps
+{
+    couplingFilename "vtk_out%4.4d.vtk";
+    maxNumberOfParticles 30000;
+}
+
+
+
+
+

Description

+

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.

+
+
+

Restrictions

+

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

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/dataExchangeModel_twoWayMPI.html b/doc/_build/html/dataExchangeModel_twoWayMPI.html new file mode 100644 index 0000000..7b4f1d0 --- /dev/null +++ b/doc/_build/html/dataExchangeModel_twoWayMPI.html @@ -0,0 +1,237 @@ + + + + + + + + + + + dataExchangeModel_twoWayMPI command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • dataExchangeModel_twoWayMPI command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

dataExchangeModel_twoWayMPI command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
dataExchangeModel twoWayMPI;
+twoWayMPIProps
+{
+    liggghtsPath "path";
+};
+
+
+
    +
  • path = path to the DEM simulation input file
    • +
+
+
+

Examples

+
dataExchangeModel twoWayMPI;
+twoWayMPIProps
+{
+    liggghtsPath "../DEM/in.liggghts_init";
+}
+
+
+
+
+

Description

+

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.

+
+
+

Restrictions

+

none.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel.html b/doc/_build/html/forceModel.html new file mode 100644 index 0000000..d05ee34 --- /dev/null +++ b/doc/_build/html/forceModel.html @@ -0,0 +1,240 @@ + + + + + + + + + + + forceModel command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+ +
+ +
+
+
+ +
+

forceModel command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    model_x
+    model_y
+);
+
+
+
    +
  • model = name of force model to be applied
    • +
+
+
+

Examples

+
forceModels
+(
+    Archimedes
+    DiFeliceDrag
+);
+
+
+

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

+
+
+

Description

+

The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. 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.

+
+
+

Restrictions

+

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, a warning is written to the terminal (log file). Setting a flag “cgWarnOnly false;” in coupling properties, the simulation will be stopped if there is a violation.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_Archimedes.html b/doc/_build/html/forceModel_Archimedes.html new file mode 100644 index 0000000..78fbd1c --- /dev/null +++ b/doc/_build/html/forceModel_Archimedes.html @@ -0,0 +1,251 @@ + + + + + + + + + + + forceModel_Archimedes command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_Archimedes command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_Archimedes command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    Archimedes
+);
+ArchimedesProps
+{
+    gravityFieldName "gravity";
+    twoDimensional;
+    suppressProbe   switch1;
+    treatForceDEM   switch2;
+    verbose         switch3;
+};
+
+
+
    +
  • gravity = name of the finite volume gravity field
    • +
  • twoDimensional = optional keyword for conducting a two dimensional calculation
    • +
  • switch1 = (optional, default false) can be used to suppress the output of the probe model
    • +
  • switch2 = (optional, default true) sub model switch, see forceSubModel for details
    • +
  • switch3 = (optional, default false) sub model switch, see forceSubModel for details
    • +
+
+
+

Examples

+
forceModels
+(
+    Archimedes
+);
+ArchimedesProps
+{
+    gravityFieldName "g";
+}
+
+
+
+
+

Description

+

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.

+
+
+

Restrictions

+

none.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_ArchimedesIB.html b/doc/_build/html/forceModel_ArchimedesIB.html new file mode 100644 index 0000000..07aaa06 --- /dev/null +++ b/doc/_build/html/forceModel_ArchimedesIB.html @@ -0,0 +1,250 @@ + + + + + + + + + + + forceModel_ArchimedesIB command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_ArchimedesIB command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_ArchimedesIB command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    ArchimedesIB
+);
+ArchimedesIBProps
+{
+    gravityFieldName "gravity";
+    voidfractionFieldName "voidfraction";
+    twoDimensional;
+    treatForceExplicit  switch1;
+};
+
+
+
    +
  • gravity = name of the finite volume gravity field
    • +
  • voidfraction = name of the finite volume voidfraction field
    • +
  • twoDimensional = optional keyword for conducting a two dimensional calculation
    • +
  • switch1 = (optional, default true) sub model switch, see forceSubModel for details
    • +
+
+
+

Examples

+
forceModels
+(
+    ArchimedesIB
+);
+ArchimedesIBProps
+{
+    gravityFieldName "g";
+    voidfractionFieldName "voidfractionNext";
+}
+
+
+
+
+

Description

+

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.

+
+
+

Restrictions

+

Only for immersed boundary solvers.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_DiFeliceDrag.html b/doc/_build/html/forceModel_DiFeliceDrag.html new file mode 100644 index 0000000..d223c63 --- /dev/null +++ b/doc/_build/html/forceModel_DiFeliceDrag.html @@ -0,0 +1,270 @@ + + + + + + + + + + + forceModel_DiFeliceDrag command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_DiFeliceDrag command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_DiFeliceDrag command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    DiFeliceDrag
+);
+DiFeliceDragProps
+{
+    velFieldName "U";
+    voidfractionFieldName "voidfraction";
+    granVelFieldName "Us";
+    interpolation switch1;
+    voidfractionInterpolationType "type1";
+    UInterpolationType "type2";
+    suppressProbe       switch2;
+    scale               scalar1;
+    scaleDrag           scalar2;
+    treatForceExplicit  switch3;
+    implForceDEM        switch4;
+    verbose             switch5;
+    scalarViscosity     switch6;
+    nu                  scalar3;
+};
+
+
+
    +
  • U = name of the finite volume fluid velocity field
    • +
  • voidfraction = name of the finite volume voidfraction field
    • +
  • Us = name of the finite volume granular velocity field
    • +
  • switch1 = (optional, normally off) flag to use interpolated voidfraction and velocity values
    • +
  • type1 = (optional, default cellPoint) interpolation type for voidfraction field
    • +
  • type2 = (optional, default cellPointFace) interpolation type for velocity field
    • +
  • switch2 = (optional, default false) can be used to suppress the output of the probe model
    • +
  • scalar1 = (optional) scaling of particle diameter
    • +
  • scalar2 = (optional) scaling of drag law
    • +
  • switch3 = sub model switch, see forceSubModel for details
    • +
  • switch4 = sub model switch, see forceSubModel for details
    • +
  • switch5 = sub model switch, see forceSubModel for details
    • +
  • switch6 = sub model switch, see forceSubModel for details
    • +
  • scalar3 = optional, only if switch6 is true
    • +
+
+
+

Examples

+
forceModels
+(
+    DiFeliceDrag
+);
+DiFeliceDragProps
+{
+    velFieldName "U";
+    interpolation true;
+}
+
+
+
+
+

Description

+

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).

+
+
+

Restrictions

+

none.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_GidaspowDrag.html b/doc/_build/html/forceModel_GidaspowDrag.html new file mode 100644 index 0000000..793b984 --- /dev/null +++ b/doc/_build/html/forceModel_GidaspowDrag.html @@ -0,0 +1,277 @@ + + + + + + + + + + + forceModel_GidaspowDrag command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_GidaspowDrag command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_GidaspowDrag command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    GidaspowDrag
+);
+GidaspowDragProps
+{
+    velFieldName "U";
+    voidfractionFieldName "voidfraction";
+    granVelFieldName "Us";
+    phi                 scalar1;
+    interpolation switch1;
+    voidfractionInterpolationType "type1"
+    UInterpolationType "type2"
+    implForceDEM        switch2;
+    suppressProbe       switch3;
+    scale               scalar2;
+    scaleDrag           scalar3;
+    switchingVoidfraction scalar4;
+    treatForceExplicit  switch4;
+    implForceDEM        switch5;
+    verbose             switch6;
+    scalarViscosity     switch7;
+    nu                  scalar5;
+};
+
+
+
    +
  • U = name of the finite volume fluid velocity field
    • +
  • voidfraction = name of the finite volume voidfraction field
    • +
  • Us = name of the finite volume cell averaged particle velocity field
    • +
  • scalar1 = drag correction factor (in doubt 1)
    • +
  • switch1 = (optional, default off) flag to use interpolated voidfraction and fluid velocity values
    • +
  • type1 = (optional, default cellPoint) interpolation type for voidfraction field
    • +
  • type2 = (optional, default cellPointFace) interpolation type for velocity field
    • +
  • switch2 = (optional, default false) flag to use implicit formulation of drag on DEM side +switch3 = (optional, default false) can be used to suppress the output of the probe model
    • +
  • scalar2 = (optional) scaling of particle diameter
    • +
  • scalar3 = (optional) scaling of drag law
    • +
  • scalar4 = (optional) voidfraction above which dilute formulation will be used
    • +
  • switch4 = (optional, default false) sub model switch, see forceSubModel for details
    • +
  • switch5 = (optional, default false) sub model switch, see forceSubModel for details
    • +
  • switch6 = (optional, default false) sub model switch, see forceSubModel for details
    • +
  • switch7 = (optional, default false) sub model switch, see forceSubModel for details
    • +
  • scalar5 = (optional, default false) optional, only if switch6 is true
    • +
+
+
+

Examples

+
forceModels
+(
+    GidaspowDrag
+);
+GidaspowDragProps
+{
+    velFieldName "U";
+    voidfractionFieldName "voidfraction";
+    granVelFieldName "Us";
+}
+
+
+
+
+

Description

+

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).

+
+
+

Restrictions

+

none.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_KochHillDrag.html b/doc/_build/html/forceModel_KochHillDrag.html new file mode 100644 index 0000000..3e598f0 --- /dev/null +++ b/doc/_build/html/forceModel_KochHillDrag.html @@ -0,0 +1,272 @@ + + + + + + + + + + + forceModel_KochHillDrag command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_KochHillDrag command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_KochHillDrag command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    KochHillDrag
+);
+KochHillDragProps
+{
+    velFieldName "U";
+    voidfractionFieldName "voidfraction";
+    granVelFieldName "Us"
+    interpolation       "switch1";
+    voidfractionInterpolationType "type1"
+    UInterpolationType  "type2"
+    implForceDEM        "switch2";
+    suppressProbe       "switch3";
+    scale               "scalar1";
+    scaleDrag           "scalar2";
+    treatForceExplicit  "switch4";
+    verbose             "switch5";
+    implForceDEMaccumulated "switch6";
+    scalarViscosity     "switch7";
+    nu                  "scalar3";
+};
+
+
+
    +
  • U = name of the finite volume fluid velocity field
    • +
  • voidfraction = name of the finite volume voidfraction field
    • +
  • Us = (optional) name of finite volume granular velocity field
    • +
  • switch1 = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values
    • +
  • type1 = (optional, default cellPoint) interpolation type for voidfraction field
    • +
  • type2 = (optional, default cellPointFace) interpolation type for velocity field
    • +
  • switch2 = (optional, normally off) flag to use implicit formulation of drag on DEM side +switch3 = (optional, default false) can be used to suppress the output of the probe model
    • +
  • scalar1 = (optional) scaling of particle diameter
    • +
  • scalar2 = (optional) scaling of drag law
    • +
  • switch4 = (optional, default false) sub model switch, see forceSubModel for details
    • +
  • switch5 = (optional, default false) sub model switch, see forceSubModel for details
    • +
  • switch6 = (optional, default false) sub model switch, see forceSubModel for details
    • +
  • switch7 = (optional, default false) sub model switch, see forceSubModel for details
    • +
  • scalar3 = optional, only if switch7 is true
    • +
+
+
+

Examples

+
forceModels
+(
+    KochHillDrag
+);
+KochHillDragProps
+{
+    velFieldName "U";
+    voidfractionFieldName "voidfraction";
+}
+
+
+
+
+

Description

+

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).

+
+
+

Restrictions

+

none.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_LaEuScalarTemp.html b/doc/_build/html/forceModel_LaEuScalarTemp.html new file mode 100644 index 0000000..527e766 --- /dev/null +++ b/doc/_build/html/forceModel_LaEuScalarTemp.html @@ -0,0 +1,279 @@ + + + + + + + + + + + forceModel_LaEuScalarTemp command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_LaEuScalarTemp command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_LaEuScalarTemp command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    LaEuScalarTemp
+);
+LaEuScalarTempProps
+{
+    velFieldName "U";
+    tempFieldName "T";
+    voidfractionFieldName "voidfraction";
+    partTempName "Temp";
+    partHeatFluxName "convectiveHeatFlux";
+    partHeatTransCoeffName "heatTransCoeff";
+    partHeatFluidName "heatFluid";
+    lambda scalar1;
+    Cp scalar2;
+    interpolation switch1;
+    TInterpolationType "type1"
+    verbose switch2;
+    maxSource scalar3;
+    scale scalar4;
+    scalarViscosity switch3;
+    nu scalar5;
+};
+
+
+
    +
  • U = name of the finite volume fluid velocity field
    • +
  • T = name of the finite volume scalar temperature field
    • +
  • voidfraction = name of the finite volume voidfraction field
    • +
  • Temp = name of the DEM data representing the particles temperature
    • +
  • convectiveHeatFlux = name of the DEM data representing the particle-fluid convective heat flux
    • +
  • heatTransCoeff = name of heat transfer coefficient
    • +
  • heatFluid = +scalar1 = fluid thermal conductivity [W/(m*K)]
    • +
  • scalar2 = fluid specific heat capacity [W*s/(kg*K)]
    • +
  • switch1 = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values
    • +
  • type1 = (optional, default cellPoint) interpolation type for T field
    • +
  • switch2 = (optional, default false) sub model switch, see forceSubModel for details
    • +
  • scalar3 = (optional) limit maximal turbulence
    • +
  • scalar4 = scaling of particle diameter
    • +
  • switch3 = (optional, default false) sub model switch, see forceSubModel for details
    • +
  • scalar5 = optional, only if switch3 is true
    • +
+
+
+

Examples

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

Description

+

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

+
+
+

Restrictions

+

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

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_MeiLift.html b/doc/_build/html/forceModel_MeiLift.html new file mode 100644 index 0000000..e74b9e0 --- /dev/null +++ b/doc/_build/html/forceModel_MeiLift.html @@ -0,0 +1,262 @@ + + + + + + + + + + + forceModel_MeiLift command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_MeiLift command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_MeiLift command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    MeiLift
+);
+MeiLiftProps
+{
+    velFieldName "U";
+    useSecondOrderTerms;
+    interpolation switch1;
+    vorticityInterpolationType "type1"
+    UInterpolationType "type2"
+    verbose switch2;
+    treatForceExplicit switch3;
+    scalarViscosity switch4;
+    nu scalar1;
+};
+
+
+
    +
  • U = name of the finite volume fluid velocity field
    • +
  • useSecondOrderTerms = switch to activate second order terms in the lift force model
    • +
  • switch1 = switch to activate tri-linear interpolation of the flow quantities at the particle position
    • +
  • type1 = (optional, default cellPoint) interpolation type for vorticity field
    • +
  • type2 = (optional, default cellPointFace) interpolation type for velocity field
    • +
  • switch2 = switch to activate the report of per-particle quantities to the screen
    • +
  • switch3 = (optional, default true) sub model switch, see forceSubModel for details
    • +
  • switch4 = (optional, default false) sub model switch, see forceSubModel for details
    • +
  • scalar1 = optional, only if switch4 is true
    • +
+
+
+

Examples

+
forceModels
+(
+    MeiLift
+);
+MeiLiftProps
+{
+    velFieldName "U";
+    useSecondOrderTerms;
+    interpolation true;
+    verbose true;
+}
+
+
+
+
+

Description

+

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).

+
+
+

Restrictions

+

None.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_SchillerNaumannDrag.html b/doc/_build/html/forceModel_SchillerNaumannDrag.html new file mode 100644 index 0000000..bd3043c --- /dev/null +++ b/doc/_build/html/forceModel_SchillerNaumannDrag.html @@ -0,0 +1,253 @@ + + + + + + + + + + + forceModel_SchillerNaumannDrag command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_SchillerNaumannDrag command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_SchillerNaumannDrag command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    SchillerNaumannDrag
+);
+SchillerNaumannDragProps
+{
+    velFieldName "U";
+    voidfractionFieldName "voidfraction";
+    interpolation "bool1";
+    voidfractionInterpolationType "type1"
+    UInterpolationType "type2"
+    implForceDEM "bool2";
+};
+
+
+
    +
  • U = name of the finite volume fluid velocity field
    • +
  • voidfraction = name of the finite volume voidfraction field
    • +
  • bool1 = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values
    • +
  • type1 = (optional, default cellPoint) interpolation type for voidfraction field
    • +
  • type2 = (optional, default cellPointFace) interpolation type for velocity field
    • +
+

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

+
+
+

Examples

+
forceModels
+(
+    SchillerNaumannDrag
+);
+SchillerNaumannDragProps
+{
+    velFieldName "U";
+}
+
+
+
+
+

Description

+

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.

+
+
+

Restrictions

+

none.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_ShirgaonkarIB.html b/doc/_build/html/forceModel_ShirgaonkarIB.html new file mode 100644 index 0000000..8e49647 --- /dev/null +++ b/doc/_build/html/forceModel_ShirgaonkarIB.html @@ -0,0 +1,256 @@ + + + + + + + + + + + forceModel_ShirgaonkarIB command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_ShirgaonkarIB command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_ShirgaonkarIB command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    ShirgaonkarIB
+);
+ShirgaonkarIBProps
+{
+    velFieldName "U";
+    pressureFieldName "p";
+    twoDimensional;
+    depth scalar1;
+    verbose switch1;
+    treatForceExplicit switch2;
+};
+
+
+
    +
  • U = name of the finite volume fluid velocity field
    • +
  • p = name of the finite volume pressure field
    • +
  • twoDimensional = optional keyword for conducting a two dimensional calculation
    • +
  • scalar1 = optional, only necessary if twoDimensional is active
    • +
  • switch1 = (optional, default false) sub model switch, see forceSubModel for details
    • +
  • switch2 = (optional, default false) sub model switch, see forceSubModel for details
    • +
+
+
+

Examples

+
forceModels
+(
+    ShirgaonkarIB
+);
+ShirgaonkarIBProps
+{
+    velFieldName "U";
+    pressureFieldName "p";
+}
+
+
+
+
+

Description

+

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.

+

References:

+

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.

+
+
+

Restrictions

+

Only for immersed boundary solvers.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_checkCouplingInterval.html b/doc/_build/html/forceModel_checkCouplingInterval.html new file mode 100644 index 0000000..dba9031 --- /dev/null +++ b/doc/_build/html/forceModel_checkCouplingInterval.html @@ -0,0 +1,259 @@ + + + + + + + + + + + forceModel_checkCouplingInterval command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_checkCouplingInterval command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_checkCouplingInterval command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    checkCouplingInterval
+);
+checkCouplingIntervalProps
+{
+    warnOnly                    bool1;
+    velocityFieldName           word1;
+    rhoP                        scalar1;
+    maxCFL                      scalar2;
+    maxAccNr                    scalar3;
+    UmaxExpected                scalar4;
+    minAllowedVcellByVparcel    scalar5;
+    timeInterval                scalar6;
+};
+
+
+
    +
  • bool1 = (optional, default true) switch to warn or stop simulation if criterion is broken.
    • +
  • word1 = (optional, default U) name of velocity field.
    • +
  • scalar1 = particle density assumed for calculation of the particle relaxation time
    • +
  • scalar2 = (optional, default=50) maximum allowed CFL number.
    • +
  • scalar3 = (optional, default=0.1) maximum allowed ratio of coupling time to particle relaxation time.
    • +
  • scalar4 = maximum expected velocity fluid velocity (e.g. due to BCs) - used for CFL estimation.
    • +
  • scalar5 = (optional, default=3) min allowed volume ratio of cell / particle.
    • +
  • scalar6 = (optional, default=coupling time) interval of execution.
    • +
+
+
+

Examples

+
forceModels
+(
+    checkCouplingInterval
+);
+checkCouplingIntervalProps
+{
+    rhoP 2500;
+    UmaxExpected 10;
+    timeInterval 0.002;
+}
+
+
+
+
+

Description

+

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: (i) 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.1. (ii) 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. (iii) The ratio of smallest cell biggest particle volume. Typically this should be larger than 3. (iiii) The minimum and maximum Stokes Number. For the criteria (i)-(iii) 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.

+
+
+

Restrictions

+

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

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_fieldStore.html b/doc/_build/html/forceModel_fieldStore.html new file mode 100644 index 0000000..be2947d --- /dev/null +++ b/doc/_build/html/forceModel_fieldStore.html @@ -0,0 +1,258 @@ + + + + + + + + + + + forceModel_fieldStore command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_fieldStore command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_fieldStore command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    fieldStore
+);
+fieldStoreProps
+{
+    scalarFieldNames
+    (
+        "scalarField"
+    );
+    vectorFieldNames
+    (
+        "vectorField"
+    );
+};
+
+
+
    +
  • scalarField = names of the finite volume scalar fields to be stored
    • +
  • vectorField = names of the finite volume vector fields to be stored
    • +
+
+
+

Examples

+
forceModels
+(
+    fieldStore
+);
+fieldStoreProps
+{
+    scalarFieldNames
+    (
+        "voidfraction"
+    );
+    vectorFieldNames
+    (
+        "U"
+    );
+}
+
+
+
+
+

Description

+

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).

+
+
+

Restrictions

+

none.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_fieldTimeAverage.html b/doc/_build/html/forceModel_fieldTimeAverage.html new file mode 100644 index 0000000..65dc1ef --- /dev/null +++ b/doc/_build/html/forceModel_fieldTimeAverage.html @@ -0,0 +1,261 @@ + + + + + + + + + + + forceModel_fieldTimeAverage command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_fieldTimeAverage command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_fieldTimeAverage command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    fieldTimeAverage
+);
+fieldTimeAverageProps
+{
+    startTime time;
+    scalarFieldNames
+    (
+        "scalarField"
+    );
+    vectorFieldNames
+    (
+        "vectorField"
+    );
+};
+
+
+
    +
  • time = (optional) time to start temporal averaging
    • +
  • scalarField = names of the finite volume scalar fields to be temporally averaged
    • +
  • vectorField = names of the finite volume vector fields to be temporally averaged
    • +
+
+
+

Examples

+
forceModels
+(
+    fieldTimeAverage
+);
+fieldTimeAverageProps
+{
+    startTime 1.0;
+    scalarFieldNames
+    (
+        "voidfraction"
+    );
+    vectorFieldNames
+    (
+        "Us"
+    );
+}
+
+
+
+
+

Description

+

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.

+
+
+

Restrictions

+

none.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_gradPForce.html b/doc/_build/html/forceModel_gradPForce.html new file mode 100644 index 0000000..c288180 --- /dev/null +++ b/doc/_build/html/forceModel_gradPForce.html @@ -0,0 +1,259 @@ + + + + + + + + + + + forceModel_gradPForce command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_gradPForce command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_gradPForce command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    gradPForce;
+);
+gradPForceProps
+{
+    pFieldName "pressure";
+    velocityFieldName "U";
+    interpolation       switch1;
+    gradPInterpolationType "type1"
+    useAddedMass        scalar1;
+    suppressProbe       switch2;
+    treatForceExplicit  switch3;
+    treatForceDEM       switch4;
+};
+
+
+
    +
  • pressure = name of the finite volume fluid pressure field
    • +
  • U = name of the finite volume fluid velocity field
    • +
  • switch1 = flag to use interpolated pressure values (normally off)
    • +
  • type1 = (optional, default cellPointFace) interpolation type for grad(p) field
    • +
  • useAddedMass = (optional) coefficient of added mass accounted for
    • +
  • switch2 = (optional, default false) can be used to suppress the output of the probe model
    • +
  • switch3 = (optional, default true) sub model switch, see forceSubModel for details
    • +
  • switch4 = (optional, default false) sub model switch, see forceSubModel for details
    • +
+
+
+

Examples

+
forceModels
+(
+    gradPForce;
+);
+gradPForceProps
+{
+    pFieldName "p";
+    velocityFieldName "U";
+    interpolation true;
+}
+
+
+
+
+

Description

+

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).

+
+
+

Restrictions

+

none.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_noDrag.html b/doc/_build/html/forceModel_noDrag.html new file mode 100644 index 0000000..d56b181 --- /dev/null +++ b/doc/_build/html/forceModel_noDrag.html @@ -0,0 +1,251 @@ + + + + + + + + + + + forceModel_noDrag command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_noDrag command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_noDrag command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    noDrag
+);
+
+
+

noDragProps +{

+
+
noDEMForce “switch1”; +keepCFDForce “switch2”; +treatForceExplicit “switch3”;
+

}

+
    +
  • switch1 = (optional, default false) do not apply the previously calculated forces in DEM integration
    • +
  • switch2 = (optional, default false) do not delete the previously calculated forces and use them in CFD source terms
    • +
  • switch3 = (optional, default false) sub model switch, see forceSubModel for details
    • +
+
+
+

Examples

+
forceModels
+(
+    noDrag
+);
+
+
+
noDragProps
+{
+    noDEMForce true;
+    keepCFDForce false;
+};
+
+
+
+
+

Description

+

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.

+
+
+

Restrictions

+

None.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_particleCellVolume.html b/doc/_build/html/forceModel_particleCellVolume.html new file mode 100644 index 0000000..239930c --- /dev/null +++ b/doc/_build/html/forceModel_particleCellVolume.html @@ -0,0 +1,254 @@ + + + + + + + + + + + forceModel_particleCellVolume command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_particleCellVolume command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_particleCellVolume command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    particleCellVolume
+);
+particleCellVolumeProps
+{
+    verbose switch1;
+    writeToFile switch2;
+    startTime number1;
+    upperThreshold number2;
+    lowerThreshold number3;
+    verbose;
+};
+
+
+
    +
  • switch1 = (optional, default true) switch for output to screen
    • +
  • switch2 = (optional, default false) switch for output to file
    • +
  • number1 = (optional, default 0) start time of volume calculation and output
    • +
  • number2 = only cells with a field value (magnitude) lower than this upper threshold are considered
    • +
  • number3 = only cells with a field value (magnitude) greater than this lower threshold are considered
    • +
+
+
+

Examples

+
forceModels
+(
+    particleCellVolume
+);
+particleCellVolumeProps
+{
+    upperThreshold 0.999;
+    lowerThreshold 0;
+}
+
+
+
+
+

Description

+

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. +At “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.

+
+
+

Restrictions

+

None.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_particleVolume.html b/doc/_build/html/forceModel_particleVolume.html new file mode 100644 index 0000000..20fd1cf --- /dev/null +++ b/doc/_build/html/forceModel_particleVolume.html @@ -0,0 +1,249 @@ + + + + + + + + + + + forceModel_particleVolume command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_particleVolume command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_particleVolume command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    particleVolume
+);
+particleVolumeProps
+{
+    verbose switch1;
+    writeToFile switch2;
+    scale scalar1;
+    startTime scalar2;
+};
+
+
+
    +
  • switch1 = (optional, default false) switch for output to screen
    • +
  • switch2 = (optional, default true) switch for output to file
    • +
  • scalar1 = (optional, default 1) scaling of the particle volume d=dSphere/scale
    • +
  • scalar2 = (optional, default 0) start time of volume calculation and output
    • +
+
+
+

Examples

+
forceModels
+(
+    particleVolume
+);
+particleVolumeProps
+{
+    writeToFile false;
+}
+
+
+
+
+

Description

+

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

+
+
+

Restrictions

+

None.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_scalarGeneralExchange.html b/doc/_build/html/forceModel_scalarGeneralExchange.html new file mode 100644 index 0000000..a9eab9e --- /dev/null +++ b/doc/_build/html/forceModel_scalarGeneralExchange.html @@ -0,0 +1,372 @@ + + + + + + + + + + + forceModel_scalarGeneralExchange command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_scalarGeneralExchange command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_scalarGeneralExchange command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    scalarGeneralExchange  // must be 2nd position!
+);
+scalarGeneralExchangeProps
+{
+    useLiMason "switch1"; //default: DeenEtAl
+    useGeneralCorrelation "switch3"; //default: DeenEtAl
+    generalCorrelationParameters (1 2 3 4 5 6 7 8);
+    verbose "switch2";
+    velFieldName "U";
+    voidfractionFieldName "voidfraction";
+    tempFieldName "T";
+    partTempName "Temp";
+    /* partHeatFluxName "convectiveHeatFlux"; //switch off for implicit coupling, e.g., to ParScale */
+    partHeatTransCoeffName "heatTransCoeff";
+    partHeatFluidName "heatFluid";
+    lambda value;
+    Cp value1;
+    //Lists with information for each species FOR THE PARTICLES
+    //MUST be in the same order as eulerian species in 'scalarTransportProperties'
+    //MUST correspond to property/atom in ligghts (use 'couple/cfd/speciesConvection' to auto-generate individual fields)
+    partSpeciesNames
+    (
+    speciesC
+    );
+    partSpeciesFluxNames
+    (
+    speciesCFlux
+    );
+    partSpeciesTransCoeffNames
+    (
+    speciesCTransCoeff
+    );
+    partSpeciesFluidNames
+    (
+    speciesCFluid
+    );
+    DMolecular
+    (
+    value2
+    );
+    interpolation "bool1";
+    voidfractionInterpolationType "type1"
+    UInterpolationType "type2"
+    fluidScalarFieldInterpolationType "type2"
+    scalarViscosity switch5;
+    nu scalar5;
+    suppressProbe switch6;
+    scale scalar6;
+    maxSource scalar7;
+}
+
+
+
    +
  • switch1 = (optional) flag to use Nusselt correlations of Li and Mason (2000)
    • +
  • switch2 = (normally off) for verbose run
    • +
  • switch3 = (optional) flag to use a general Nusselt number correlation (must specify parameters of this correlation in a list called ‘generalCorrelationParameters’ )
    • +
  • generalCorrelationParameters = list with a predefined number of parameters (for length see src code, only read if useGeneralCorrelation is set to true)
    • +
  • U = name of the finite volume fluid velocity field
    • +
  • voidfraction = name of the finite volume voidfraction field
    • +
  • T = name of the finite volume scalar temperature field
    • +
  • Temp = name of the DEM data representing the particles temperature
    • +
  • convectiveHeatFlux = name of the DEM data representing the particle-fluid convective heat flux
    • +
  • heatTransCoeff = name of the DEM data representing the particle-fluid heat transfer coefficient
    • +
  • heatFluid = name of the DEM data representing the fluid heat
    • +
  • value = fluid thermal conductivity [W/(m*K)]
    • +
  • value1 = fluid specific heat capacity [W*s/(kg*K)]
    • +
  • speciesC = name of the DEM data representing the transport species of the particles
    • +
  • speciesCFlux = name of the DEM data representing the particle-fluid species flux
    • +
  • speciesCTransCoeff = name of the DEM data representing the particle-fluid species transfer coefficient
    • +
  • speciesCFluid = name of the DEM data representing the transport species of the fluid
    • +
  • value2 = molecular diffusion coefficient [m^2/s]
    • +
  • bool1 = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values
    • +
  • type1 = (optional, default cellPoint) interpolation type for voidfraction field
    • +
  • type2 = (optional, default cellPointFace) interpolation type for velocity field
    • +
  • type3 = (optional, default cellPoint) interpolation type for fluidScalarField field
    • +
  • switch5 = (optional, default false) sub model switch, see forceSubModel for details
    • +
  • scalar5 = (optional) optional, only if switch5 is true
    • +
  • switch6 = (optional, default false) can be used to suppress the output of the probe model
    • +
  • scalar7 = (optional) scaling of particle diameter
    • +
  • scalar7 = limit maximal turbulence
    • +
+
+
+

Examples

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

Description

+

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

+

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

+

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

+

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

+

Alternatively, the correclation of +Li and Mason (2000), A computational investigation of transient heat +transfer in pneumatic transport of granular particles, Pow.Tech 112 +can be activated. However, this correlation is not suitable for +dense granular flows.

+

WARNING: +This model REQUIRES the ‘generalManual’ speciesTransportModel

+
+
+

Restrictions

+

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

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_virtualMassForce.html b/doc/_build/html/forceModel_virtualMassForce.html new file mode 100644 index 0000000..0393dd4 --- /dev/null +++ b/doc/_build/html/forceModel_virtualMassForce.html @@ -0,0 +1,259 @@ + + + + + + + + + + + forceModel_virtualMassForce command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_virtualMassForce command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_virtualMassForce command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    virtualMassForce
+);
+virtualMassForceProps
+{
+    velFieldName "U";
+    phiFieldName "phi";
+    splitUrelCalculation switch1;
+    Cadd scalar1;
+    treatForceExplicit switch2;
+    treatForceDEM switch3;
+    interpolation switch4;
+    UInterpolationType "type1"
+    DDtUInterpolationType "type2"
+};
+
+
+
    +
  • U = name of the finite volume fluid velocity field
    • +
  • phi = name of the finite volume flux field
    • +
  • switch1 = indicator to split calculation of Urel between CFDEM and LIGGGHTS
    • +
  • scalar1 = scalar value
    • +
  • switch2 = (optional, default true) sub model switch, see forceSubModel for details
    • +
  • switch3 = (optional, default false) sub model switch, see forceSubModel for details
    • +
  • switch4 = (optional, default false) sub model switch, see forceSubModel for details
    • +
  • type1 = (optional, default cellPointFace) interpolation type for U field
    • +
  • type2 = (optional, default cellPointFace) interpolation type for ddt(U) field
    • +
+
+
+

Examples

+
forceModels
+(
+    virtualMassForce
+);
+virtualMassForceProps
+{
+    velFieldName "U";
+}
+
+
+
+
+

Description

+

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.

+
+
+

Restrictions

+

Model not validated!

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_viscForce.html b/doc/_build/html/forceModel_viscForce.html new file mode 100644 index 0000000..db4206d --- /dev/null +++ b/doc/_build/html/forceModel_viscForce.html @@ -0,0 +1,259 @@ + + + + + + + + + + + forceModel_viscForce command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_viscForce command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_viscForce command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    viscForce;
+);
+viscForceProps
+{
+    velocityFieldName "U";
+    useAddedMass scalar1;
+    suppressProbe switch1;
+    treatForceExplicit switch2;
+    treatForceDEM switch3;
+    interpolation switch4;
+    divTauInterpolationType "type1";
+    scalarViscosity switch5;
+    nu scalar2;
+};
+
+
+
    +
  • U = name of the finite volume fluid velocity field
    • +
  • scalar1 = (optional) coefficient of added mass accounted for
    • +
  • switch1 = (optional, default false) can be used to suppress the output of the probe model
    • +
  • switch2 = (optional, default true) sub model switch, see forceSubModel for details
    • +
  • switch3 = (optional, default false) sub model switch, see forceSubModel for details
    • +
  • switch4 = (optional, default false) sub model switch, see forceSubModel for details
    • +
  • type1 = (optional, default cellPointFace) interpolation type for div(Tau) field
    • +
  • switch5 = (optional, default false) sub model switch, see forceSubModel for details
    • +
  • scalar2 = optional, only if switch5 is true
    • +
+
+
+

Examples

+
forceModels
+(
+    viscForce;
+);
+viscForceProps
+{
+    velocityFieldName "U";
+}
+
+
+
+
+

Description

+

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).

+
+
+

Restrictions

+

none.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceModel_volWeightedAverage.html b/doc/_build/html/forceModel_volWeightedAverage.html new file mode 100644 index 0000000..90533d6 --- /dev/null +++ b/doc/_build/html/forceModel_volWeightedAverage.html @@ -0,0 +1,276 @@ + + + + + + + + + + + forceModel_volWeightedAverage command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceModel_volWeightedAverage command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceModel_volWeightedAverage command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
forceModels
+(
+    volWeightedAverage
+);
+volWeightedAverageProps
+{
+    startTime time;
+    scalarFieldNames
+    (
+        scalarField
+    );
+    vectorFieldNames
+    (
+        vectorField
+    );
+    upperThreshold scalar1;
+    lowerThreshold scalar2;
+    useVolumeFraction switch0;
+    volumeFractionName word1;
+    verbose ;
+    writeToFile switch1;
+};
+
+
+
    +
  • time = (optional, default 0.) time to start the averaging
    • +
  • scalarField = names of the finite volume scalar fields to be temporally averaged
    • +
  • vectorField = names of the finite volume vector fields to be temporally averaged
    • +
  • scalar1 = only cells with a field value (magnitude) lower than this upper threshold are considered
    • +
  • scalar2 = only cells with a field value (magnitude) greater than this lower threshold are considered
    • +
  • switch0 = (optional, default false) consider a volume fraction for the calculation
    • +
  • word1 = (optional, default “voidfraction”) name of the volume fraction, only used if useVolumeFraction is true
    • +
  • verbose = (optional, default false) keyword only (mostly used for debugging)
    • +
  • switch1 = (optional, default false) switch for the output.
    • +
+
+
+

Examples

+
forceModels
+(
+    volWeightedAverage
+);
+volWeightedAverageProps
+{
+    startTime 0.1;
+    scalarFieldNames
+    (
+        voidfraction
+    );
+    vectorFieldNames
+    (
+    );
+    upperThreshold 0.999;
+    lowerThreshold 0;
+}
+
+
+
+
+

Description

+

This “forceModel” does not influence the particles or the simulation - it is a postprocessing tool! Starting at start time +the volume weighted averages of those cells of the fields within the threshold are calculated. +At “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.

+
+
+

Restrictions

+

Currently all fields have the same threshold value!

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceSubModel.html b/doc/_build/html/forceSubModel.html new file mode 100644 index 0000000..f1fe47e --- /dev/null +++ b/doc/_build/html/forceSubModel.html @@ -0,0 +1,252 @@ + + + + + + + + + + + forceSubModel command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceSubModel command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceSubModel command

+
+

Syntax

+

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.

+
forceSubModels
+(
+    model_x
+    model_y
+);
+
+
+
    +
  • model = name of force sub-model to be applied
    • +
+
+
+

Examples

+
forceSubModels
+(
+    ImEx
+);
+
+
+

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

+
+
+

Description

+

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.

+
+
+

Restrictions

+

None.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/forceSubModel_ImEx.html b/doc/_build/html/forceSubModel_ImEx.html new file mode 100644 index 0000000..e6418ad --- /dev/null +++ b/doc/_build/html/forceSubModel_ImEx.html @@ -0,0 +1,234 @@ + + + + + + + + + + + forceSubModel_ImEx command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • forceSubModel_ImEx command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

forceSubModel_ImEx command

+
+

Syntax

+

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

+

forceSubModels +(

+
+
ImEx;
+

);

+

treatExplicit true; // optional for some force models. +treatDEM true; // optional for some force models. +implDEM true; // optional for some force models.

+
+
+

Examples

+

forceSubModels +(

+
+
ImEx;
+

); +treatExplicit true; // optional for some force models.

+
+
+

Description

+

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.

+
+
+

Restrictions

+

none.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/genindex.html b/doc/_build/html/genindex.html new file mode 100644 index 0000000..fbed5c3 --- /dev/null +++ b/doc/_build/html/genindex.html @@ -0,0 +1,594 @@ + + + + + + + + + + + + Index — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+ +
+ +
+
+
+ + +

Index

+ +
+ A + | C + | D + | F + | I + | L + | M + | P + | R + | S + | V + +
+

A

+ + + +
+ +
averagingModel +
+ + +
averagingModel_dense +
+ +
+ +
averagingModel_dilute +
+ +
+ +

C

+ + + +
+ +
cfdemSolverIB +
+ + +
cfdemSolverPiso +
+ + +
cfdemSolverPisoScalar +
+ +
+ +
clockModel +
+ + +
clockModel_noClock +
+ + +
clockModel_standardClock +
+ +
+ +

D

+ + + +
+ +
dataExchangeModel +
+ + +
dataExchangeModel_noDataExchange +
+ + +
dataExchangeModel_oneWayVTK +
+ +
+ +
dataExchangeModel_twoWayFiles +
+ + +
dataExchangeModel_twoWayMPI +
+ +
+ +

F

+ + + +
+ +
forceModel +
+ + +
forceModel_Archimedes +
+ + +
forceModel_ArchimedesIB +
+ + +
forceModel_checkCouplingInterval +
+ + +
forceModel_DiFeliceDrag +
+ + +
forceModel_fieldStore +
+ + +
forceModel_fieldTimeAverage +
+ + +
forceModel_GidaspowDrag +
+ + +
forceModel_gradPForce +
+ + +
forceModel_KochHillDrag +
+ + +
forceModel_LaEuScalarTemp +
+ + +
forceModel_MeiLift +
+ +
+ +
forceModel_noDrag +
+ + +
forceModel_particleCellVolume +
+ + +
forceModel_particleVolume +
+ + +
forceModel_scalarGeneralExchange +
+ + +
forceModel_SchillerNaumannDrag +
+ + +
forceModel_ShirgaonkarIB +
+ + +
forceModel_virtualMassForce +
+ + +
forceModel_viscForce +
+ + +
forceModel_volWeightedAverage +
+ + +
forceSubModel +
+ + +
forceSubModel_ImEx +
+ +
+ +

I

+ + + +
+ +
IOModel +
+ + +
IOModel_basicIO +
+ + +
IOModel_noIO +
+ +
+ +
IOModel_sophIO +
+ + +
IOModel_trackIO +
+ +
+ +

L

+ + + +
+ +
liggghtsCommandModel +
+ + +
liggghtsCommandModel_execute +
+ + +
liggghtsCommandModel_readLiggghtsData +
+ + +
liggghtsCommandModel_runLiggghts +
+ + +
liggghtsCommandModel_setDEMGravity +
+ +
+ +
liggghtsCommandModel_writeLiggghts +
+ + +
locateModel +
+ + +
locateModel_engineSearch +
+ + +
locateModel_engineSearchIB +
+ + +
locateModel_standardSearch +
+ +
+ +

M

+ + + +
+ +
meshMotionModel +
+ + +
meshMotionModel_noMeshMotion +
+ + +
momCoupleModel +
+ +
+ +
momCoupleModel_explicitCouple +
+ + +
momCoupleModel_implicitCouple +
+ + +
momCoupleModel_noCouple +
+ +
+ +

P

+ + + +
+ +
probeModel +
+ + +
probeModel_noProbe +
+ +
+ +
probeModel_particleProbe +
+ +
+ +

R

+ + + +
+ +
regionModel +
+ +
+ +
regionModel_allRegion +
+ +
+ +

S

+ + + +
+ +
scalarTransportModel +
+ + +
smoothingModel +
+ +
+ +
smoothingModel_constDiffSmoothing +
+ + +
smoothingModel_noSmoothing +
+ +
+ +

V

+ + + +
+ +
voidfractionModel +
+ + +
voidfractionModel_bigParticleVoidFraction +
+ + +
voidfractionModel_centreVoidFraction +
+ + +
voidfractionModel_dividedVoidFraction +
+ +
+ +
voidfractionModel_GaussVoidFraction +
+ + +
voidfractionModel_IBVoidFraction +
+ + +
voidfractionModel_noVoidFractionVoidFraction +
+ + +
voidfractionModel_trilinearVoidFraction +
+ +
+ + + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/githubAccess_public.html b/doc/_build/html/githubAccess_public.html new file mode 100644 index 0000000..87f6080 --- /dev/null +++ b/doc/_build/html/githubAccess_public.html @@ -0,0 +1,411 @@ + + + + + + + + + + + githubAccess_public — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+ +
+ +
+
+
+ +
+

githubAccess_public

+
+
+

Description

+

This routine describes how to pull repositories of the CFDEM(R)project from `github.com <github_>`_ <github_>. +After setting some environment variables, LIGGGHTS(R) and CFDEM(R)coupling can be compiled.

+

Procedure:

+

Basically the following steps have to be performed:

+
    +
  • git clone and setup OpenFOAM
    • +
  • git clone the desired repositories
    • +
  • update your repositories by git pull
    • +
  • set environment variables
    • +
  • compile LIGGGHTS(R) and CFDEM(R)coupling
    • +
  • run your own cases
    • +
+

*git clone* and setup OpenFOAM:

+

Have a look at the latest compatible OpenFOAM(R)-version in the versionInfo.H file at `github <compOF_>`_. +This file will later be downloaded as a part of the source-code. +Look for the git commit hashtag in the following line:

+
word OFversion="&lt;OF-Release&gt;-commit-&lt;commitHashtag&gt;";
+
+
+
e.g. word OFversion="2.4.x-commit-3d8da0e960c717ff582f1517a27724144f086b83";
+
+
+

However sometimes even newer versions are supported, please check the `release notes <relNotes_>`_ and the “Advanced Settings”-section.

+

Basically follow the OpenFOAM(R) git compilation `instructions <downOF_>`_, with a small number of exceptions:

+

When you git clone the repository, replace the release-version with &lt;OF-Release&gt;.

+

with git-protocol:

+
git clone git://github.com/OpenFOAM/OpenFOAM-&lt;OF-Release&gt;.git
+
+
+

or with https:

+
git clone https://github.com/OpenFOAM/OpenFOAM-&lt;OF-Release&gt;.git
+
+
+

Now change into the new directory and checkout the correct compatible version:

+
cd OpenFOAM-&lt;OF-Release&gt;
+git checkout &lt;commitHashtag&gt;
+
+
+

The result will be a status report, that indicates a ‘detached head state’. +Now continue with installing and compiling OpenFOAM(R). +Make sure that OpenFOAM(R) works properly with a parallel Simulation!

+

If you want to use an older OpenFOAM(R)-version, please have a look at the “Backwards Compatibility”-section.

+

*git clone* the desired repositories:

+

You may want to take a look around on CFDEMproject on github: github.com/CFDEMproject_gitCFDEM

+

If not already done, open a terminal and create a directory for LIGGGHTS(R) in $HOME:

+
cd
+mkdir LIGGGHTS
+cd LIGGGHTS
+
+
+

To clone the public LIGGGHTS repository, open a terminal and execute: +with git-protocol:

+
git clone git://github.com/CFDEMproject/LIGGGHTS-PUBLIC.git LIGGGHTS-PUBLIC
+
+
+

or with https:

+
git clone https://github.com/CFDEMproject/LIGGGHTS-PUBLIC.git LIGGGHTS-PUBLIC
+
+
+

If not already done, open a terminal and create a directory for CFDEM(R)coupling in $HOME:

+
cd
+mkdir CFDEM
+cd CFDEM
+
+
+

To clone the public CFDEM(R)coupling repository, open a terminal and execute: +with git-protocol:

+
git clone git://github.com/CFDEMproject/CFDEMcoupling-PUBLIC.git CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION
+
+
+

or with https:

+
git clone https://github.com/CFDEMcoupling-PUBLIC.git CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION
+
+
+
Additionally the lpp tool for converting LIGGGHTS dump-files into the paraview readable VTK-format might be of use:
+with git-protocol:
+git clone git://github.com:CFDEMproject/LPP.git $HOME/LIGGGHTS/mylpp
+
+
+
or with https:
+git clone https://github.com:CFDEMproject/LPP.git $HOME/LIGGGHTS/mylpp
+
+
+

Please have a look at README and INSTALL.txt in the root directory of LPP for further information.

+

Troubles? See Troubleshooting git section below.

+

Update your repositories by *git pull*:

+

To get the latest version, open a terminal, go to the location of your local installation and type: +Warning: git stash will remove your changes in $HOME/CFDEM/CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION !

+
cd $HOME/CFDEM/CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION
+git stash
+git pull
+
+
+

Set Environment Variables:

+

Now you need to set some environment variables in ~/.bashrc (if you use c-shell, manipulate ~/.cshrc accordingly). Open ~/.bashrc

+
gedit ~/.bashrc &
+
+
+

add the lines (you find them also in CFDEMCoupling-$WM_PROJECT_VERSION/src/lagrangian/cfdemParticle/etc/bashrc and cshrc respectively):

+
#================================================#
+#- source cfdem env vars
+export CFDEM_VERSION=PUBLIC
+export CFDEM_PROJECT_DIR=$HOME/CFDEM/CFDEMcoupling-$CFDEM_VERSION-$WM_PROJECT_VERSION
+export CFDEM_SRC_DIR=$CFDEM_PROJECT_DIR/src
+export CFDEM_SOLVER_DIR=$CFDEM_PROJECT_DIR/applications/solvers
+export CFDEM_DOC_DIR=$CFDEM_PROJECT_DIR/doc
+export CFDEM_UT_DIR=$CFDEM_PROJECT_DIR/applications/utilities
+export CFDEM_TUT_DIR=$CFDEM_PROJECT_DIR/tutorials
+export CFDEM_PROJECT_USER_DIR=$HOME/CFDEM/$LOGNAME-$CFDEM_VERSION-$WM_PROJECT_VERSION
+export CFDEM_bashrc=$CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/bashrc
+export CFDEM_LIGGGHTS_SRC_DIR=$HOME/LIGGGHTS/LIGGGHTS-PUBLIC/src
+export CFDEM_LIGGGHTS_MAKEFILE_NAME=fedora_fpic
+export CFDEM_LPP_DIR=$HOME/LIGGGHTS/mylpp/src
+export CFDEM_PIZZA_DIR=$HOME/LIGGGHTS/PIZZA/gran_pizza_17Aug10/src
+. $CFDEM_bashrc
+#================================================#
+
+
+

If you installed LIGGGHTS(R) or CFDEM(R)coupling in non-standard paths, please have a look at least at CFDEM_PROJECT_DIR and CFDEM_LIGGGHTS_SRC_DIR. +The standard CFDEM_LIGGGHTS_MAKEFILE_NAME is fedora_fpic, which works on most systems. However please checkout LIGGGHTS-PUBLIC/src/MAKE for additional makefiles, wich are available. The most used ones are fedora_fpic and ubuntuVTK_fpic. Beware that the CFDEMcoupling needs a fpic compilation to use LIGGGHTS as a library. Please check the “Advanced Settings” for VTK information.

+

Save the ~/.bashrc, open a new terminal and test the settings. The commands:

+
$CFDEM_PROJECT_DIR
+$CFDEM_SRC_DIR
+$CFDEM_LIGGGHTS_SRC_DIR
+
+
+

should give ”...: is a directory” otherwise something went wrong and the environment variables in ~/.bashrc are not set correctly.

+

To specify the paths of pizza, please check the settings in $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/bashrc.

+

If $CFDEM_SRC_DIR is set correctly, you can type

+
cfdemSysTest
+
+
+

to get some information if the paths are set correctly.

+

Compile LIGGGHTS(R) and CFDEM(R)coupling:

+

If above settings were done correctly, you can compile LIGGGHTS(R) by typing:

+
cfdemCompLIG
+
+
+

and you can then compile CFDEM(R)coupling by typing:

+
cfdemCompCFDEM
+
+
+

or compile both at once with:

+
cfdemCompCFDEMall
+
+
+

You can run the tutorial cases by executing .../etc/testTutorial.sh through the alias cfdemTestTUT. +Alternatively you can run each tutorial using the Allrun.sh scripts in the tutorial directories.

+

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

+

Run Your Own Cases:

+

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. +Changes in $CFDEM_TUT_DIR will be lost after every git stash!

+

Additional Installations:

+

Optionally you can install lpp which will help you convert the DEM (dump) data to VTK format. For standard CFD-DEM runs this will not be necessary. To get the DEM postprocessing tool “lpp” you need python-numpy package installed:

+
sudo apt-get install python-numpy
+
+
+

You can pull the latest version of lpp with:

+
cd $HOME/LIGGGHTS
+
+
+

with git-protocol: +git clone git://github.com/CFDEMproject/LPP.git +with https: +git clone https://github.com/CFDEMproject/LPP.git

+

Backwards Compatibility:

+

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

+

The supported OpenFOAM(R) and LIGGGHTS(R) versions are stated in: +src/lagrangian/cfdemParticle/cfdTools/versionInfo.H

+

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

+

Advanced Settings:

+

Here some advanced settings and hints for non-standard compilations are presented. +As stated in the “Backwards Compatibility”-section, there are compiler flags for different OpenFOAM versions. Checkout src/lagrangian/cfdemParticle/etc/OFversion/OFversion.H for compatibility settings. Just comment the current “#define version2X” in the top-section and uncomment the one you want to compile it with.

+

There are advanced compilation settings for library-paths, includes and libraries are within the additionalLibs file in src/lagrangian/cfdemParticle/etc/additionalLibs. There are predefined files for different OpenFOAM versions. To use a different version, add the following lines to your .bashrc (.cshrc) before the standard CFDEM variables:

+
export CFDEM_ADD_LIBS_DIR=FOLDER_OF_NEW_additionalLibs_FILE/
+
+
+
export CFDEM_ADD_LIBS_NAME=additionalLibs30x
+
+
+

This is an example to use a predefined additionalLibs file for OpenFOAM-3.0.x.

+

To enable direct VTK-dump (dump custom/vtk) support of LIGGGHTS and CFDEMcoupling, you have to install the VTK libraries. Either 5.8 or 6 are predefined for ubuntu.

+
sudo apt-get libvtk5.8 libvtk5-dev
+
+
+

Change “export CFDEM_LIGGGHTS_MAKEFILE_NAME=fedora_fpic” in your .bashrc according to your preferred LIGGGHTS makefile. +If you have a non-standard installation location you have to adapt the LIGGGHTS makefile accordingly. +To enable this feature in a coupled run the additionalLibs file has to be modified. +It basically needs to include the same libraries as the LIGGGHTS-Makefile. +E.g. for Ubuntu-14.04 with vtk-5.8:

+
CFDEM_ADD_LIB_PATHS  = -L/usr/include/vtk-5.8
+
+
+
CFDEM_ADD_LIBS       = -lvtkCommon -lvtkFiltering -lvtkIO
+
+
+

Troubleshooting git:

+
    +
  • Troubles with git clone?
    • +
+

a) The git protocol will not work if your computer is behind a firewall which blocks the relevant TCP port, you can use alternatively https instead of git (write command in one line):

+

git clone https://github.com/CFDEMproject/CFDEMcoupling-PUBLIC.git CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION

+

b) If you face the error: “error: SSL certificate problem, verify that the CA cert is OK. Details: error:14090086:SSL routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed while accessing https://github.com/...”,

+

please use: env GIT_SSL_NO_VERIFY=true git clone https://github...

+

(see http://stackoverflow.com/questions/3777075/https-github-access)

+

c) If you face the error: “Agent admitted failure to sign using the key. Permission denied (publickey).”, after ssh -T git@github.com

+

please type: “ssh-add”

+

(see: https://help.github.com/articles/error-agent-admitted-failure-to-sign)

+
+
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/liggghtsCommandModel.html b/doc/_build/html/liggghtsCommandModel.html new file mode 100644 index 0000000..04f6f28 --- /dev/null +++ b/doc/_build/html/liggghtsCommandModel.html @@ -0,0 +1,234 @@ + + + + + + + + + + + liggghtsCommandModel command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • liggghtsCommandModel command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

liggghtsCommandModel command

+
+

Syntax

+

Defined in liggghtsCommmands dictionary.

+
liggghtsCommandModels
+(
+    model_x
+    model_y
+);
+
+
+
    +
  • model = name of the liggghtsCommandModel to be applied
    • +
+
+
+

Examples

+
liggghtsCommandModels
+(
+   runLiggghts
+   writeLiggghts
+);
+
+
+

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

+
+
+

Description

+

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

+
+
+

Restrictions

+

Works only with MPI coupling.

+

Default: none.

+
+
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/liggghtsCommandModel_execute.html b/doc/_build/html/liggghtsCommandModel_execute.html new file mode 100644 index 0000000..af4ac20 --- /dev/null +++ b/doc/_build/html/liggghtsCommandModel_execute.html @@ -0,0 +1,290 @@ + + + + + + + + + + + liggghtsCommandModel_execute command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • liggghtsCommandModel_execute command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

liggghtsCommandModel_execute command

+
+

Syntax

+

Defined in liggghtsCommmands dictionary.

+
liggghtsCommandModels
+(
+   execute
+);
+executeProps0
+{
+    command
+    (
+        run
+        $couplingInterval
+    );
+    runFirst switch1;
+    runLast switch2;
+    runEveryCouplingStep switch3;
+    runEveryWriteStep switch4;
+    verbose;
+}
+
+
+
    +
  • 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)
    • +
  • switch1 = switch (choose on/off) if the command is executed only at first time step
    • +
  • switch2 = switch (choose on/off) if the command is executed only at last time step
    • +
  • switch3 = switch (choose on/off) if the command is executed at every coupling step
    • +
  • switch4 = switch (choose on/off) if the command is executed at every writing step
    • +
  • verbose = (normally off) for verbose run
    • +
+
+
+

Examples

+
liggghtsCommandModels
+(
+   execute
+   execute
+);
+executeProps0
+{
+    command
+    (
+        run
+        $couplingInterval
+    );
+    runFirst off;
+    runLast off;
+    runEveryCouplingStep on;
+}
+executeProps1
+{
+    command
+    (
+        write_restart
+        noBlanks
+        dotdot
+        slash
+        DEM
+        slash
+        liggghts.restart_
+        timeStamp
+    );
+    runFirst off;
+    runLast off;
+    runEveryCouplingStep off;
+    runEveryWriteStep on;
+}
+
+
+
+
+

Description

+

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.

+
+

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

+
+
+
+

Restrictions

+
+
None.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/liggghtsCommandModel_readLiggghtsData.html b/doc/_build/html/liggghtsCommandModel_readLiggghtsData.html new file mode 100644 index 0000000..80c6e61 --- /dev/null +++ b/doc/_build/html/liggghtsCommandModel_readLiggghtsData.html @@ -0,0 +1,276 @@ + + + + + + + + + + + liggghtsCommandModel_readLiggghtsData command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • liggghtsCommandModel_readLiggghtsData command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

liggghtsCommandModel_readLiggghtsData command

+
+

Syntax

+

Defined in liggghtsCommmands dictionary.

+
liggghtsCommandModels
+(
+   readLiggghtsData
+);
+readLiggghtsDataProps0
+{
+    startIndex "scalar1";
+    verbose ;
+    exactTiming ;
+    filePath
+    (
+        "word"
+    );
+    runFirst "bool1";
+    runEveryCouplingStep "bool2";
+    startTime "scalar2";
+    endTime "scalar3";
+    timeInterval "scalar4";
+}
+
+
+
    +
  • scalar1 = start index of data file to be read
    • +
  • verbose = (default off) flag for verbose run
    • +
  • exactTiming = flag indicating that start time should be kept even during a coupling interval
    • +
  • 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)
    • +
  • bool1 = true if to be run at first timestep only (prio 1)
    • +
  • bool2 = true if to be run at every coupling step (prio 2)
    • +
  • scalar2 = if bool2 and bool3 false then starts at scalar2 (prio 3) run
    • +
  • scalar3 = if bool2 and bool3 false then it ends at scalar3 (prio 3) run
    • +
  • scalar4 = if bool2 and bool3 false then it repeats at scalar3 increasing the data file index (prio 3) run
    • +
+
+
+

Examples

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

Description

+

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

+
+
+

Restrictions

+

Note: Model is not up to date.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/liggghtsCommandModel_runLiggghts.html b/doc/_build/html/liggghtsCommandModel_runLiggghts.html new file mode 100644 index 0000000..0f67286 --- /dev/null +++ b/doc/_build/html/liggghtsCommandModel_runLiggghts.html @@ -0,0 +1,239 @@ + + + + + + + + + + + liggghtsCommandModel_runLiggghts command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • liggghtsCommandModel_runLiggghts command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

liggghtsCommandModel_runLiggghts command

+
+

Syntax

+

Defined in liggghtsCommmands dictionary.

+
liggghtsCommandModels
+(
+   runLiggghts
+);
+//- optional
+runLiggghtsProps
+{
+    preNo true;
+    verbose; (optional)
+}
+
+
+
+
+

Examples

+
liggghtsCommandModels
+(
+   runLiggghts
+);
+
+
+
+
+

Description

+

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.

+
+
+

Restrictions

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

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/liggghtsCommandModel_setDEMGravity.html b/doc/_build/html/liggghtsCommandModel_setDEMGravity.html new file mode 100644 index 0000000..ca017dd --- /dev/null +++ b/doc/_build/html/liggghtsCommandModel_setDEMGravity.html @@ -0,0 +1,258 @@ + + + + + + + + + + + liggghtsCommandModel_setDEMGravity command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • liggghtsCommandModel_setDEMGravity command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

liggghtsCommandModel_setDEMGravity command

+
+

Syntax

+

Defined in liggghtsCommmands dictionary.

+

liggghtsCommandModels +(

+
+
setDEMGravity
+

);

+
setDEMGravityProps0
+{
+    runFirst switch1;
+    startTime scalar1;
+    endTime scalar2;
+    timeInterval scalar3;
+    verbose;
+}
+
+
+
    +
  • switch1 = switch (must be on!!!) to select if executed only first step.
    • +
  • scalar1 = start time of command (use simulation start time)
    • +
  • scalar2 = end time of command (use simulation start time)
    • +
  • scalar3 = time interval of command (use 1.) +verbose = (normally off) for verbose run
    • +
+
+
+

Examples

+
liggghtsCommandModels
+(
+   runLiggghts
+   setDEMGravity
+);
+setDEMGravityProps1
+{
+    runFirst on;
+    startTime 0;
+    endTime 0;
+    timeInterval 1;
+    verbose;
+}
+
+
+
+
+

Description

+

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

+
+
+

Restrictions

+
+
None.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/liggghtsCommandModel_writeLiggghts.html b/doc/_build/html/liggghtsCommandModel_writeLiggghts.html new file mode 100644 index 0000000..bbf0489 --- /dev/null +++ b/doc/_build/html/liggghtsCommandModel_writeLiggghts.html @@ -0,0 +1,250 @@ + + + + + + + + + + + liggghtsCommandModel_writeLiggghts command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • liggghtsCommandModel_writeLiggghts command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

liggghtsCommandModel_writeLiggghts command

+
+

Syntax

+

Defined in liggghtsCommmands dictionary.

+
liggghtsCommandModels
+(
+   writeLiggghts
+);
+//- optional
+writeLiggghtsProps
+{
+    writeLast switch1;
+    path "path";
+    writeName "name";
+    overwrite switch2;
+    verbose;
+}
+
+
+
    +
  • switch1 = switch (choose on/off) to select if only last step is stored or every write step (default on).
    • +
  • path = optionally an alternative path (relative to execution directory) for saving the restart file can be defined (default ”../DEM”).
    • +
  • name = name of the restart file to be written in /$caseDir/DEM/ default (default “liggghts.restartCFDEM”)
    • +
  • switch2 = switch (choose on/off) to select if only one restart file $name or many files $name_$timeStamp are written (default off) +verbose = (default off) for verbose run
    • +
+
+
+

Examples

+
liggghtsCommandModels
+(
+   runLiggghts
+   writeLiggghts
+);
+
+
+
+
+

Description

+

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.

+
+
+

Restrictions

+
+
None.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/locateModel.html b/doc/_build/html/locateModel.html new file mode 100644 index 0000000..9615aff --- /dev/null +++ b/doc/_build/html/locateModel.html @@ -0,0 +1,227 @@ + + + + + + + + + + + locateModel command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+ +
+ +
+
+
+ +
+

locateModel command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
locateModel model;
+
+
+
    +
  • model = name of the locateModel to be applied
    • +
+
+
+

Examples

+
locateModel engine;
+
+
+

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

+
+
+

Description

+

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.

+
+
+

Restrictions

+
+
none.
+

Default: none.

+
+
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/locateModel_engineSearch.html b/doc/_build/html/locateModel_engineSearch.html new file mode 100644 index 0000000..018724f --- /dev/null +++ b/doc/_build/html/locateModel_engineSearch.html @@ -0,0 +1,243 @@ + + + + + + + + + + + locateModel_engineSearch command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • locateModel_engineSearch command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

locateModel_engineSearch command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
locateModel engine;
+engineProps
+{
+    treeSearch switch1;
+}
+
+
+
    +
  • switch1 = (optional, default true) switch to use tree search algorithm
    • +
+
+
+

Examples

+
locateModel engine;
+engineProps
+{
+    treeSearch true;
+}
+
+
+
+
+

Description

+

The locateModel “engine” locates the CFD cell and cellID corresponding to a given position. +The engineSearch locate model can be used with different settings to use different algorithms:

+
    +
  • treeSearch false; will execute some geometric (linear) search using the last known cellID
    • +
  • treeSearch true; will use a recursive tree structure to find the cell (recommended).
    • +
+
+
+

Restrictions

+
+
none.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/locateModel_engineSearchIB.html b/doc/_build/html/locateModel_engineSearchIB.html new file mode 100644 index 0000000..de92d40 --- /dev/null +++ b/doc/_build/html/locateModel_engineSearchIB.html @@ -0,0 +1,251 @@ + + + + + + + + + + + locateModel_engineSearchIB command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • locateModel_engineSearchIB command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

locateModel_engineSearchIB command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
locateModel engineIB;
+engineIBProps
+{
+    treeSearch switch1;
+    zSplit value1;
+    xySplit value2;
+    checkPeriodicCells;
+}
+
+
+
    +
  • switch1 = names of the finite volume scalar fields to be temporally averaged
    • +
  • value1 = number of z-normal layers for satellite points
    • +
  • value2 = number of satellite points in each layer
    • +
  • checkPeriodicCells = (optional, default false) flag for considering the minimal distance to all periodic images of this particle
    • +
+
+
+

Examples

+
locateModel engineIB;
+engineIBProps
+{
+    treeSearch false;
+    zSplit 8;
+    xySplit 16;
+}
+
+
+
+
+

Description

+

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.

+

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

+
    +
  • treeSearch false; will execute some geometric (linear) search using the last known cellID (recommended)
    • +
  • treeSearch true; will use a recursive tree structure to find the cell.
    • +
+

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.

+
+
+

Restrictions

+

Only for immersed boundary solvers!

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/locateModel_standardSearch.html b/doc/_build/html/locateModel_standardSearch.html new file mode 100644 index 0000000..6d3e7d5 --- /dev/null +++ b/doc/_build/html/locateModel_standardSearch.html @@ -0,0 +1,227 @@ + + + + + + + + + + + locateModel_standardSearch command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • locateModel_standardSearch command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

locateModel_standardSearch command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
locateModel standard;
+
+
+
+
+

Examples

+
locateModel standard;
+
+
+
+
+

Description

+

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

+
+
+

Restrictions

+
+
none.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/meshMotionModel.html b/doc/_build/html/meshMotionModel.html new file mode 100644 index 0000000..0501c95 --- /dev/null +++ b/doc/_build/html/meshMotionModel.html @@ -0,0 +1,227 @@ + + + + + + + + + + + meshMotionModel command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • meshMotionModel command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

meshMotionModel command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
meshMotionModel model;
+
+
+
    +
  • model = name of the meshMotionModel to be applied
    • +
+
+
+

Examples

+
meshMotionModel noMeshMotion;
+
+
+

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

+
+
+

Description

+

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

+
+
+

Restrictions

+
+
none.
+

Default: none.

+
+
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/meshMotionModel_noMeshMotion.html b/doc/_build/html/meshMotionModel_noMeshMotion.html new file mode 100644 index 0000000..b64b182 --- /dev/null +++ b/doc/_build/html/meshMotionModel_noMeshMotion.html @@ -0,0 +1,227 @@ + + + + + + + + + + + meshMotionModel_noMeshMotion command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • meshMotionModel_noMeshMotion command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

meshMotionModel_noMeshMotion command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
meshMotionModel noMeshMotion;
+
+
+
+
+

Examples

+
meshMotionModel noMeshMotion;
+
+
+
+
+

Description

+

The noMeshMotion-model is a dummy meshMotion model.

+
+
+

Restrictions

+
+
None.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/momCoupleModel.html b/doc/_build/html/momCoupleModel.html new file mode 100644 index 0000000..b61e765 --- /dev/null +++ b/doc/_build/html/momCoupleModel.html @@ -0,0 +1,234 @@ + + + + + + + + + + + momCoupleModel command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • momCoupleModel command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

momCoupleModel command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
momCoupleModels
+(
+    model
+);
+
+
+
    +
  • model = name of the momCoupleModel to be applied
    • +
+
+
+

Examples

+
momCoupleModels
+(
+    implicitCouple
+);
+
+
+

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

+

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.

+

Note that the variable “imExSplitFactor” can be set in the couplingProperties in order to treat implicitly defined forces (in the implementation of the force model) as explicit ones. “imExSplitFactor 1.0;” is set by default, meaning that all implicit forces will be considered implicitly, whereas “imExSplitFactor 0.0;” would mean that implicitly defined forces will be treated in an explicit fashion.

+

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. +Description +“”“”“”“”“”“

+

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

+
+
+

Restrictions

+
+
none.
+

Default: none.

+
+
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/momCoupleModel_explicitCouple.html b/doc/_build/html/momCoupleModel_explicitCouple.html new file mode 100644 index 0000000..41334eb --- /dev/null +++ b/doc/_build/html/momCoupleModel_explicitCouple.html @@ -0,0 +1,243 @@ + + + + + + + + + + + momCoupleModel_explicitCouple command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • momCoupleModel_explicitCouple command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

momCoupleModel_explicitCouple command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
momCoupleModels
+(
+    explicitCouple
+);
+explicitCoupleProps
+{
+    fLimit vector;
+}
+
+
+
    +
  • vector = limiter vector for explicit force term (default (1e10,1e10,1e10) )
    • +
+
+
+

Examples

+
momCoupleModels
+(
+    explicitCouple
+);
+explicitCoupleProps
+{
+    fLimit (1e3 1e2 1e4);
+}
+
+
+
+
+

Description

+

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.

+
+
+

Restrictions

+

Only for solvers that include explicit momentum exchange.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/momCoupleModel_implicitCouple.html b/doc/_build/html/momCoupleModel_implicitCouple.html new file mode 100644 index 0000000..2eb0bc6 --- /dev/null +++ b/doc/_build/html/momCoupleModel_implicitCouple.html @@ -0,0 +1,251 @@ + + + + + + + + + + + momCoupleModel_implicitCouple command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • momCoupleModel_implicitCouple command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

momCoupleModel_implicitCouple command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
momCoupleModels
+(
+    implicitCouple
+);
+implicitCoupleProps
+{
+    velFieldName "U";
+    granVelFieldName "Us";
+    voidfractionFieldName "voidfraction";
+    minAlphaP number;
+}
+
+
+
    +
  • U = name of the finite volume fluid velocity field
    • +
  • Us = name of the finite volume granular velocity field
    • +
  • voidfraction = name of the finite volume voidfraction field
    • +
+

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

+
+
+

Examples

+
momCoupleModels
+(
+    implicitCouple
+);
+implicitCoupleProps
+{
+    velFieldName "U";
+    granVelFieldName "Us";
+    voidfractionFieldName "voidfraction";
+}
+
+
+
+
+

Description

+

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

+
+
+

Restrictions

+

Only for solvers that include implicit momentum exchange.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/momCoupleModel_noCouple.html b/doc/_build/html/momCoupleModel_noCouple.html new file mode 100644 index 0000000..8409469 --- /dev/null +++ b/doc/_build/html/momCoupleModel_noCouple.html @@ -0,0 +1,232 @@ + + + + + + + + + + + momCoupleModel_noCouple command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • momCoupleModel_noCouple command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

momCoupleModel_noCouple command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
momCoupleModels
+(
+    off
+);
+
+
+
+
+

Examples

+
momCoupleModels
+(
+    off
+);
+
+
+
+
+

Description

+

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

+
+
+

Restrictions

+

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

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/objects.inv b/doc/_build/html/objects.inv new file mode 100644 index 0000000..03fe130 --- /dev/null +++ b/doc/_build/html/objects.inv @@ -0,0 +1,5 @@ +# Sphinx inventory version 2 +# Project: CFDEMcoupling +# Version: v3.X +# The remainder of this file is compressed using zlib. +xڍOk0 "5inݠ@A%!e߄~ IV/(?д QWK~߽pidmեG'&z'|92@ŰDެ>M#* fb9cP"jg߳ٶl srn$5m6pNy2.l!"3>r3ۖ-|]]KM%mJ=V/ݰ҉ \ No newline at end of file diff --git a/doc/_build/html/probeModel.html b/doc/_build/html/probeModel.html new file mode 100644 index 0000000..0e0f8c3 --- /dev/null +++ b/doc/_build/html/probeModel.html @@ -0,0 +1,231 @@ + + + + + + + + + + + probeModel command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+ +
+ +
+
+
+ +
+

probeModel command

+
+

Syntax

+

To be activated via couplingProperties dictionary.

+
probeModel myProbeModel;
+
+
+

Use probe model “off” to disable this feature.

+
myProbeModelProps
+
+
+
{
+
+
+
};
+
+
+
+
+

Examples

+

See particleProbe

+

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

+
+
+

Description

+

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

+
+
+

Restrictions

+

None.

+

Default: none.

+
+
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/probeModel_noProbe.html b/doc/_build/html/probeModel_noProbe.html new file mode 100644 index 0000000..ffb9316 --- /dev/null +++ b/doc/_build/html/probeModel_noProbe.html @@ -0,0 +1,231 @@ + + + + + + + + + + + probeModel_noProbe command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • probeModel_noProbe command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

probeModel_noProbe command

+
+

Syntax

+

To be activated via couplingProperties dictionary.

+
forceModels
+{
+    myForceModel1
+    myForceModel2
+    myForceModel3
+};
+
+
+

probeModel off;

+
+
+

Examples

+
probeModel off;
+
+
+

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

+
+
+

Description

+

Does not perform any probing.

+
+
+

Restrictions

+

None.

+

Related commands which are currently enabled for particle probing:

+

particleProbe

+

Default: none.

+
+
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/probeModel_particleProbe.html b/doc/_build/html/probeModel_particleProbe.html new file mode 100644 index 0000000..b542789 --- /dev/null +++ b/doc/_build/html/probeModel_particleProbe.html @@ -0,0 +1,270 @@ + + + + + + + + + + + probeModel_particleProbe command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • probeModel_particleProbe command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

probeModel_particleProbe command

+
+

Syntax

+

To be activated via couplingProperties dictionary.

+

forceModels +(

+
+
myForceModel1 +myForceModel2 +myForceModel3
+

);

+

probeModel particleProbe;

+
particleProbeProps
+{
+    particleIDsToSample (ID1 ID2 ID3 ...);  //list of particleIDs to sample
+    verboseToFile;                          //main switch
+    verbose;                                //currently not used
+    printEvery       xEvery;                //print every this many CFD time steps
+    printOnlyAtStep  xStep;                 //print only at this CFD time step (overrides "printEvery")
+    sampleAll;                              //Activate sampling for all particles
+    probeDebug;                             //probes additional fields
+    includePosition;                        //will include particle position in the output file
+    writePrecision xPrecision;              //number of significant digits to print
+};
+
+
+
    +
  • particleIDsToSample = list of particle IDs to be sampled.
    • +
  • myForceModeli = list of force models in the simulation, the particleProbe will be applied to all of these models!
    • +
  • verboseToFile = main switch to activate the particle probe (default = off).
    • +
  • verbose = main switch to activate output to Info (currently not implemented).
    • +
  • xEvery = integer to specify the interval for sampling (default = 1, i.e., probing occurs every CFD time step).
    • +
  • xStep = integer to specify the step for sampling (default = deactivated, i.e., it will print accordingly to “printEvery”).
    • +
  • sampleAll = switch to activate sampling of all particles. Otherwise (default) only particles specified via “particleIDsToSample” in the couplingProperties dictionary will be sampled.
    • +
  • probeDebug = switch to activate probing of debug properties of secondary importance (specific for each force model).
    • +
  • includePosition = switch to add the particle position in the log file (default = off).
    • +
  • *xPrecision*= number of significant digits of the text output (default = 3).
    • +
+
+
+

Examples

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

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

+
+
+

Description

+

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).

+
+
+

Restrictions

+

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

+

Related commands which are currently enabled for particle probing:

+

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).

+

Default: none.

+
+
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/regionModel.html b/doc/_build/html/regionModel.html new file mode 100644 index 0000000..4d74509 --- /dev/null +++ b/doc/_build/html/regionModel.html @@ -0,0 +1,227 @@ + + + + + + + + + + + regionModel command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+ +
+ +
+
+
+ +
+

regionModel command

+
+

Syntax

+

Note: In the current CFDEMcoupling version, this model is no longer used. Defined in couplingProperties dictionary.

+
regionModel model;
+
+
+
    +
  • model = name of the regionModel to be applied
    • +
+
+
+

Examples

+
regionModel allRegion;
+
+
+

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

+
+
+

Description

+

The regionModel is the base class for region models to select a certain region for coupled simulation.

+
+
+

Restrictions

+
+
none.
+

Default: none.

+
+
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/regionModel_allRegion.html b/doc/_build/html/regionModel_allRegion.html new file mode 100644 index 0000000..ae5a03a --- /dev/null +++ b/doc/_build/html/regionModel_allRegion.html @@ -0,0 +1,227 @@ + + + + + + + + + + + regionModel_allRegion command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • regionModel_allRegion command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

regionModel_allRegion command

+
+

Syntax

+

Note: In the current CFDEMcoupling version, this model is no longer used. Defined in couplingProperties dictionary.

+
regionModel allRegion;
+
+
+
+
+

Examples

+
regionModel allRegion;
+
+
+
+
+

Description

+

The allRegion-model is a region model including the whole CFD region for the coupling.

+
+
+

Restrictions

+
+
None.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/scalarTransportModel.html b/doc/_build/html/scalarTransportModel.html new file mode 100644 index 0000000..600ef65 --- /dev/null +++ b/doc/_build/html/scalarTransportModel.html @@ -0,0 +1,277 @@ + + + + + + + + + + + scalarTransportModel command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • scalarTransportModel command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

scalarTransportModel command

+
+

Syntax

+

Defined in scalarTransportProperties dictionary. A variety of derived classes exist that implement different physics of the scalarTransportModel. Here, the most general one, i.e., ‘generalManual’ is discussed. If no scalar transport shall be used, use the model ‘none’.

+
+generalManualProps
+{
+    phiFieldName phiName;
+    voidfractionFieldName voidfractionName;
+    ScT scalar1;
+    PrT scalar2;
+    cpVolumetric scalar3;
+    cpVolumetricFieldName word1;
+    rhoMixFieldName word2;
+    eulerianFields
+    (
+        C
+        T
+    );
+
+
}
+
+
+
    +
  • phiName = (optional) name of the surface field for the SUPERFICIAL flux, default “phi”.
    • +
  • voidfractionName = (optional) name of the finite volume voidfraction field, default “voidfraction”.
    • +
  • scalar1 = (optional, default 0.7) turbulent Schmidt Nr, set to large value to suppress turbulent species transport
    • +
  • scalar2 = (optional, default 0.7) turbulent Prandtl Nr, set to large value to suppress turbulent heat transport
    • +
  • 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
    • +
  • word1 = (optional, alternatively define scalar3) volumetric heat capacity as a field
    • +
  • word3 = mixture density field
    • +
  • C = concentration field name
    • +
  • T = temperature field name
    • +
+
+
+

Examples

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

Description

+

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.

+
+
+

Restrictions

+

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.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/search.html b/doc/_build/html/search.html new file mode 100644 index 0000000..50eec4f --- /dev/null +++ b/doc/_build/html/search.html @@ -0,0 +1,204 @@ + + + + + + + + + + + Search — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • +
  • + +
    • +
+
+ +
+
+
+ + + + +
+ +
+ +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/searchindex.js b/doc/_build/html/searchindex.js new file mode 100644 index 0000000..20fca44 --- /dev/null +++ b/doc/_build/html/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({envversion:42,terms:{maxsourc:[37,38],whose:[22,20,50,44,11,15],accur:22,under:13,preprocess:13,digit:74,localpsizediffsmooth:18,everi:[30,39,43,46,75,27,21,13,74,51,66],"void":[36,62,29],govern:62,exacttim:51,clockmodel_xi:28,solid:[62,22,50,38],vector:[72,59,4,73],speci:[38,54],clockmodel:13,direct:[38,39],second:[37,61,38],follow:[17,39,3,34,6,13],liggghtscommandmodel_readliggghtsdata:13,even:[47,51,39],flimit:72,conduct:[41,37,2,38,52],"new":[36,30,39,52,13,51],rhop:66,checkperiodiccel:[47,50],here:[44,54,39],openfoam:[39,20,62,38,11,13],path:[46,31,51,23,39],interpret:4,forum:[13,39],studi:6,cfdem_solver_dir:39,bashrc:39,total:[12,5,62],describ:[13,39],would:[36,13],granvelfieldnam:[6,3,34,64],iomodel:13,recommend:[47,69],type:[17,43,37,38,39,61,3,24,34,29,49,6,13,14],forcemodel_gradpforc:13,relax:66,warn:[65,39,42,66,27,38],postporcessor:4,exce:[62,66],"9000e":10,hold:55,must:[18,38,10,13,32,54],swtich:55,springer:11,mylpp:39,word:[30,51,39],setup:[13,39],work:[1,65,39,66],smoothingmodel:13,root:39,particleprobeprop:74,xeveri:74,overrid:74,trackio:70,give:[13,18,39,10],forcesubmodel_xi:55,indic:[51,39,14],want:39,type1:[17,37,61,3,24,34,38,49,6,14],type3:38,type2:[17,61,3,34,38,6,14],end:[32,51],travel:65,locatemodel_xi:68,iiii:66,fvscheme:13,maxaccnr:66,env:39,verifi:39,perspect:[11,20],updat:[13,39],after:[36,43,39],befor:39,wrong:39,mesh:[12,22,62,65,60],patankar:52,explicitcoupleprop:72,nodragprop:9,law:[6,36,3,34],parallel:[39,20,47,62,11,13,65],averag:[56,20,57,43,3,47,25,10,11,59,73],dilut:[56,3,57,25,10,54],third:[36,13],spout:6,momcouplemodel_nocoupl:13,maintain:39,environ:39,incorpor:62,first:[30,66,27,13,32,51],order:[13,43,36,61,38],oper:[18,10],meiliftprop:61,endors:[11,62,13,20],over:[47,65,10],becaus:[43,18,10],maxcfl:66,heatflux:[37,38],implicitcoupleprop:64,writeliggghtsprop:46,additionallibs30x:39,schmidt:54,easier:43,them:[70,9,39],thei:[12,59],trondheim:62,choic:[55,71],dotdot:[30,51],volumefractionnam:73,each:[61,3,30,9,6,13,51,17,24,14,38,34,39,41,42,52,47,62,55,2,49,74],nodataexchang:[26,45],went:39,side:[6,17,3,55],clockmodel_noclock:13,dataexchangemodel_xi:45,gradient:24,imexsplitfactor:36,mason:[37,38],adapt:39,bigparticleprop:22,linear:[47,61,69],situat:10,omiss:13,standard:[39,43,38,16,12,13,59,73],switch3:[37,2,61,3,24,30,9,38,49,6,14,34],switch2:[37,2,61,3,24,46,5,30,9,38,49,6,12,52,14,34],switch1:[30,3,9,49,6,12,14,24,34,38,32,73,37,69,41,52,46,47,5,29,2,61],switch0:73,switch7:[6,3],switch6:[6,3,34,38],forcemodel_scalargeneralexchang:13,switch4:[49,61,3,24,30,34,6,14],writeprecis:74,rang:[65,29],mkdir:39,pisofoam:[11,20],cfdemtut:13,capac:[37,38,54],instruct:39,alreadi:39,allrun:[13,39],scalartransportmodel:13,advect:54,top:39,sometim:39,startindex:51,cfdemsolverpisostm:38,iomodel_noio:13,tool:[39,4,5,66,12,59,73],locatemodel_standardsearch:13,compof_:39,keyword:[55,75,2,41,61,52,71,73],provid:[35,55,64,71,72,13],particletrackproperti:70,tree:[47,69],project:39,thu:11,fashion:36,ran:43,locatemodel_enginesearchib:13,shell:[13,39],manner:52,meshmotionmodel_xi:60,strength:13,unresolv:62,procboundarycorrect:29,liggghtscommandmodel_writeliggght:13,gaussprop:44,shall:54,object:[31,12,59,73],kloss:[11,62,13,20],phase:[11,62,54],doi:11,doc:[13,39],flow:[10,36,37,61,4,24,38,49,13],doe:[36,37,58,43,4,5,48,76,38,12,73,59,66],dummi:[35,7,58,26,63,53,76],bejan:11,kochhilldrag:6,heattranscoeff:[37,38],prio:51,probe:[48,2,59,49,3,24,34,38,67,6,12,74,73],radii:75,regionmodel:13,speciestransportmodel:38,runlast:30,voidfractioninterpolationtyp:[6,17,3,34,38],stop:[43,42,66],fluid:[49,3,6,9,11,13,14,17,22,24,34,38,36,37,41,42,52,62,54,55,2,61,64,66,74],report:[61,39],toolbox:[62,13],method:[41,47,62,13,52],bad:66,novoidfract:7,shirgaonkarib:[62,52],structur:[47,13,65,69],fail:[50,22,44,39],dirctori:13,loth:61,approach:[62,13,18,29],accord:[50,39,22,44,60,27,29,11,13],cfdem_doc_dir:39,cfdem:[13,39,14,67],rasproperti:13,particleprob:[48,74,67],howev:[36,38,39],com:[13,39],archimedesibprop:41,serialoutput:75,assum:66,partspeciesnam:38,numpi:39,three:29,been:36,accumul:[55,43],velfieldnam:[17,37,61,3,52,34,38,6,64,14],basic:[75,39,43,29,10,13],relnotes_:39,suppress:[2,49,3,24,34,38,6,54],xxx:13,cfdemparticl:[25,56,39],gidaspow:3,partheatfluidnam:[37,38],lift:[41,61,2],gnu:13,properti:[19,42,23,8,38,11,31,13,74],calcul:[49,3,6,9,10,11,12,14,15,17,20,22,24,25,34,38,73,37,29,41,42,43,44,52,62,50,55,56,2,61,5,64,66],dataexchang:66,stairstep:22,conf:62,sever:[47,66,9],maxcellsperparticl:[22,50,44],perform:[48,10,3,9,49,6,13,14,17,39,23,24,25,34,29,31,36,19,41,42,45,57,52,56,2,61,26,67,74],suggest:13,make:39,additionallib:39,split:14,complet:[0,55,36,1,42,28,45,57,48,8,68,67,60,18,74,33],vizclock:43,schiller:17,jku:[50,62,22,28],josef:28,liggghtscommandmodel_execut:13,kept:51,bewar:39,momcouplemodel_explicitcoupl:13,forcemodel_fieldstor:13,contact:39,thi:[0,48,4,1,8,10,11,12,18,65,13,20,22,25,28,38,33,73,36,37,29,39,40,41,42,43,45,47,62,50,52,54,55,56,57,59,60,61,5,66,67,74,68],cellid:[47,68,69,16],protocol:39,just:[62,66,39],wm_project_vers:39,newton:36,yet:65,previous:[9,23],propuls:52,debug:[55,73,74,29,10],save:[46,74,39],applic:[13,62,49,39,24],liggghtscommandmodel:[31,13],ibprop:50,runliggght:[46,32,1,27],measur:[43,76],specif:[13,37,74,38],manual:[13,74],uselimason:38,forcemodel_difelicedrag:13,nield:11,maciv:52,www:[13,39],interv:[55,30,74,66,27,13,32,51],maxim:[62,37,38],smoothinglength:10,txt:[43,39],fpic:39,condit:[62,18,4,10],twowaympiprop:31,core:13,forcemodel_viscforc:13,repositori:[13,39],post:23,voidfracfieldnamesnext:29,surround:62,simul:[0,30,3,12,13,51,39,23,24,38,31,32,73,36,75,19,41,42,43,52,5,59,49,66,74,21],libvtk5:39,difelicedrag:[42,34],done:[36,13,39],coars:[55,42],commit:39,produc:[11,43,13,62,20],scaleupvol:50,bound:[43,66,10],latter:75,volaverage_field:73,storag:74,liggghtscommandmodel_setdemgrav:13,standardclock:[43,28],git:[13,39],casedir:[46,43,13],support:39,centreprop:15,width:19,regionmodel_allregion:13,call:[43,13,27,38],head:39,offer:[11,62,13,20],forc:[48,10,3,71,9,49,6,18,14,17,13,24,34,38,36,37,41,42,52,62,55,2,61,67,72,74,21],heat:[11,37,38,54],"true":[49,3,71,9,6,12,51,24,27,14,69,73,36,37,38,39,41,47,5,34,55,2,61,66],expforc:36,reset:29,myprobemodelprop:67,maximum:[22,19,43,44,50,66,23],dataexchangemodel_onewayvtk:13,vortic:61,featur:[43,13,74,39,67],forcemodel_shirgaonkarib:13,exist:54,arraypo:43,check:[48,39,47,66,67,74,54],when:[55,36,50,65,39,22,44,47,25,29],test:[18,39,10],noclock:76,intend:43,consid:[55,36,65,50,47,12,73],stoke:[11,36,66,62,20],bigparticl:[22,44],longer:[0,40],treatvoidcellsasexplicitforc:36,phifieldnam:[54,14],turbul:[11,37,54,20,38],geometr:[47,69],maxnumberofparticl:[19,23],time:[30,10,12,18,51,13,28,23,27,29,32,73,36,75,19,43,5,54,55,59,62,66,74,21,76],backward:39,particlerelaxationtim:66,global:54,signific:74,computation:25,usesecondorderterm:61,alphamin:[22,65,50,44,29,15],depend:[55,62,13,71,29],speciesctranscoeff:38,readabl:39,sourc:[35,37,39,20,64,62,9,11,72,13,54],string:43,fvoptionsc:54,exact:62,drag:[17,36,55,3,52,34,6],forcemodel_xi:42,div:49,git_ssl_no_verifi:39,dir:70,upper:[12,73,10],lvtkio:39,sign:39,useaddedmass:[49,24],port:39,suppressprob:[2,49,3,24,34,38,6,74],couplinginterv:[30,13,51],current:[0,55,48,39,40,67,74,73],deriv:54,gener:[39,54,38,70,13,68],coeffici:[24,37,55,38,49],disclaim:38,modif:47,lengthscal:10,viscforceprop:49,treatforceexplicit:[55,49,41,61,3,24,9,6,52,14,34],prefer:39,volumetr:[41,54,2],should:[25,66,51,39,10],useparcelsizedependentfiltereddrag:55,memori:13,cfdemcompcfdemal:39,value2:[47,38],value1:[47,38],criteria:66,myforcemodel3:[48,74],myforcemodel2:[48,74],myforcemodel1:[48,74],checkout:39,setdemgrav:32,generalcorrelationparamet:38,finit:[17,37,20,2,41,11,61,3,4,24,47,52,64,54,38,49,6,73,59,14,34],visual:[43,13],endtim:[32,51],examin:28,noio:63,effort:39,graphic:43,prepar:39,pfieldnam:24,onewayvtk:[66,23,45],can:[55,43,19,39,2,42,49,3,23,24,11,66,71,34,38,6,31,12,13,59,73],onewayvtkprop:23,twodimension:[41,2,52],purpos:62,runfirst:[30,32,51],agent:39,ssl3_get_server_certif:39,occur:74,alwai:[55,10],multipl:6,write:[75,39,46,30,8,70,21],criterion:66,pure:[55,13],map:[57,25,56,10],clone:39,mai:[55,42,43,8,39],data:[55,26,37,56,19,39,43,23,45,57,25,75,8,21,38,31,27,13,74,51],explicit:[55,36,72,21,10],virtualmassforceprop:14,inform:[62,43,13,38,39],"switch":[30,3,9,49,6,12,14,24,27,34,69,32,73,36,37,38,41,52,46,5,55,2,61,66,74],combin:[55,13,3],liggghts_init:[31,13],approx:22,approv:[11,62,13,20],includeposit:74,voidfractionmodel_bigparticlevoidfract:13,still:39,dynam:[62,13],conjunct:[18,10],how:[13,39],vtk:[19,70,23,39],norwai:62,main:[13,74,28],particleidstosampl:74,non:39,initi:[43,18,62,10],partheattranscoeffnam:[37,38],voidfractionmodel_novoidfractionvoidfract:13,now:[55,39],discuss:54,enabl:[13,48,74,39],term:[35,55,61,64,9,72,13],name:[0,1,2,3,4,60,8,49,6,12,18,14,17,28,24,34,38,33,73,36,37,29,41,42,43,45,46,47,52,54,55,57,61,64,66,59,68],forcemodel:13,separ:13,implforcedem:[6,17,3,34,55],dataexchangemodel_twowaympi:13,pizza:39,compil:39,domain:[22,44,62,27,29,33,15],beetstra:55,replac:39,individu:38,continu:39,scienc:38,forcemodel_kochhilldrag:13,happen:13,setdemgravityprops1:32,setdemgravityprops0:32,forcesubmodel:[37,2,41,42,61,3,24,52,9,38,49,6,13,14,34],correcl:38,cellpointfac:[17,49,61,3,24,34,38,6,14],lagrangian:[55,75,39,57,25,56,10],correct:[30,39,3,62,29,13,51],accordingli:[74,39],particlecellvolumeprop:12,schillernaumanndragprop:17,usefiltereddragmodel:55,chemengsci:[6,3],base:[0,1,3,6,60,8,49,11,18,17,20,28,23,24,34,38,33,36,37,29,61,66,21,70,68],wai:[36,38],motion:[55,62,60],place:[43,18,62,10],lambda:[37,38],origin:[12,59,73],onc:[43,39],arrai:43,fast:52,open:[11,62,13,20,39],angular:62,size:[55,65,43,23,62,66,29],avail:[55,39],given:[47,66,69,16,12,13],bool1:[17,66,51,38],bool3:51,bool2:[17,51],lognam:39,nosmooth:58,m_voidspac:54,"1500e":10,githubaccess:13,dataexchangemodel_twowayfil:13,fraction:[62,64,29,73],eulerianfield:54,especi:[41,47,36,4],copi:39,specifi:[18,38,39,59,61,27,29,10,13,74,54],github:[13,39],mostli:73,than:[43,22,44,66,50,10,12,13,73],iomodel_sophio:13,speciesflux:38,sophio:[70,21],were:[62,9,39],posit:[43,75,29,61,47,62,38,69,16,74,68],seri:[19,23],pre:27,dorgan:61,ani:[13,42,48],prt:54,nodemforc:9,cfdemproject_gitcfdem:39,engin:[68,47,69,38],techniqu:31,note:[0,55,36,1,40,39,42,28,68,45,57,48,8,51,38,67,60,18,74,33],satellit:[47,29],take:[55,62,39],probem:74,sure:39,normal:[17,37,38,24,47,30,34,29,6,32],track:[70,74],dataexchangemodel_nodataexchang:13,beta:18,implicitcoupl:[36,64],cfdemcompcfdem:39,later:39,quantiti:[36,61,74,54],fsmooth:[18,10],runtim:51,probemodel_particleprob:13,regionmodel_xi:0,viscou:[49,52],viscos:55,show:13,forcemodel_archimedesib:13,permiss:39,threshold:[12,73],onli:[1,3,75,49,6,12,51,50,25,34,38,30,32,73,35,36,37,65,19,41,52,46,47,54,55,61,64,67,72,74],ratio:66,therefror:71,activ:[55,48,61,52,38,67,74],written:[75,19,42,28,46,12,13,59,21,73],allregion:[0,40],locatemodel_enginesearch:13,variou:67,get:[55,13,39],secondari:74,ssl:39,cannot:[4,54],ssh:39,trade:[11,62,13,20],requir:[13,38,29],averagingmodel_dilut:13,cfdemsolverpiso:[62,13],gradpforceprop:24,email:13,scalarfield:[12,59,4,73],where:[26,30,56,41,59,43,62,52,46,25,66,27,12,74,73],speciescfluid:38,fieldstoreprop:4,concern:39,review:38,behind:39,ibvoidfract:62,between:[36,50,19,43,23,45,62,26,38,31,13,14],"import":[47,36,74],paramet:[29,22,44,65,38,13,15],comp:52,screen:[55,12,61,5],interpolatedat:54,scaledrag:[6,3,34],come:13,jfm:[13,49,34,24],region:[0,50,29,22,44,40],parttempnam:[37,38],improv:13,kerbl:28,acceler:66,pow:[37,38],period:[47,50],explicitcoupl:72,goniva:[11,62,13,20],cfdemsystest:39,mark:[11,62,13,50,20],cfdemsolverib:13,workshop:[11,20],fieldstor:4,addit:[11,72,74,20,39],restartcfdem:46,resolut:18,usegeneralcorrel:38,hashtag:39,those:[43,22,50,44,73],"case":[43,36,18,39,61,62,56,25,75,10,13,54],readliggghtsdataprops0:51,commithashtag:39,voidfractionmodel_centrevoidfract:13,forcemodel_checkcouplinginterv:13,keepcfdforc:9,cluster:[62,13],uncom:39,locatemodel:13,lengthscalereffield:10,develop:[13,3,19],alphabet:13,upperthreshold:[12,73],same:[38,39,73],bfull:13,generalmanualprop:54,finish:43,minalphap:64,treesearch:[47,69],mani:[46,74],controldict:13,appropri:[54,29],cpvolumetricfieldnam:54,choos:[30,46,13,66],nomeshmot:[60,53],dimension:[41,2,52],ddtuinterpolationtyp:14,execut:[1,39,42,66,9,31,13],touch:29,blow:[50,22,44,29],hint:39,clockdata:43,except:[27,39],treatment:[36,30,51],versa:29,momentum:[35,36,20,64,38,11,72],around:39,read:[51,71,19,38,10],regim:[25,56],temperatur:[37,38,54],grid:[55,18],usind:65,integ:[43,74],either:[62,22,39],output:[55,43,75,38,2,59,49,3,24,5,34,29,10,6,12,74,73],scalartransportproperti:[38,54],ligght:38,ascend:43,gravityfieldnam:[41,2],ddt:14,readliggghtsdata:51,treatexplicit:[55,71],refer:[36,13,62,52,10],nusselt:38,broken:66,starttim:[32,43,5,12,74,59,51,73],fulli:[13,52],treatforcedem:[2,55,49,14,24],src:[13,74,38,39],coupl:[0,55,36,13,20,39,40,30,62,1,27,38,10,11,31,18,42,51,66],voidfractionnext:41,scalargeneralexchangeprop:38,agglomer:[22,44,29,15],stand:13,"3d8da0e960c717ff582f1517a27724144f086b83":39,act:[17,49,2,41,42,61,3,24,9,6,52,74,14,34],industri:62,mean:[36,7],processor:[47,75,19,29],routin:[43,13,39],effici:[25,62],paraview:[4,39],your:[43,4,39],parscal:38,log:[71,42,74],overwrit:46,start:[74,43,47,5,12,32,59,51,73],cfdem_liggghts_makefile_nam:39,divtauinterpolationtyp:49,diffus:38,vectorfield:[59,4,73],momcouplemodel_implicitcoupl:13,cfdemsolverpimpleimex:38,possibl:13,"default":[0,48,2,3,1,8,9,10,6,12,18,14,17,28,24,34,29,33,73,36,37,38,41,42,67,45,46,47,5,49,50,51,52,54,55,57,60,61,64,66,68,69,71,72,74,75],creat:[50,39],certain:[0,13,54,29],nocoupl:35,felic:34,file:[75,19,39,71,42,43,5,23,64,46,62,8,70,31,12,13,74,51],cgwarnonli:42,fill:10,smoothingmodel_constdiffsmooth:13,field:[49,3,4,10,6,12,18,14,17,22,24,34,38,33,73,36,37,29,41,42,44,52,47,62,50,54,55,2,59,61,64,66,70,72,74],zerogradi:[18,10],valid:14,you:[43,13,74,4,39],symbol:[30,51],averagingmodel_xi:57,particlevolum:5,directori:[75,18,39,43,23,46,10,13,74],goe:[37,38],mass:[49,38,14,24],represent:[50,65,22,44,29,13],all:[36,39,42,50,47,62,29,10,13,74,73],consider:55,rhomixfieldnam:54,voidfractionfieldnam:[17,37,41,3,64,34,38,6,54],scalar:[37,4,47,54,38,10,11,59,14,73],correl:[6,17,3,34,38],sct:54,veloctii:36,writelast:46,articl:39,cfdtool:39,laeuscalartempprop:37,parcel:[55,18],fals:[49,3,9,10,6,12,51,50,24,14,38,73,37,69,42,52,47,5,29,34,54,55,2,61],urel:14,mpi:[31,13,1,66],util:[70,39],mechan:61,failur:39,veri:[16,65],modeltyp:13,unalt:[50,22,44,29],cfdemuseonli:29,list:[0,55,36,37,18,74,42,28,45,57,48,8,68,38,67,60,13,1,33],adjust:[22,44,29,15],small:[13,18,39,64],cfdem_add_libs_dir:39,zero:[22,9],pressur:[62,52,24],design:[47,62,50,38,55],pass:[55,13],further:[47,12,39],forcemodel_virtualmassforc:13,gunn:38,sub:[55,37,38,2,41,22,3,61,50,52,71,9,29,49,6,24,13,14,34],liggghtspath:31,section:[13,39],delet:[74,9],version:[0,55,13,40,39],convectiveheatflux:[37,38],"public":[13,39],contrast:54,movement:62,modular:13,free:39,tinterpolationtyp:37,modifi:39,valu:[17,37,55,64,50,3,24,66,71,54,38,10,6,12,73,14,34],search:[22,50,44,47,69,68],xstep:74,writenam:46,versioninfo:39,speciescflux:38,magnitud:[12,73],myforcemod:74,diamet:[37,38,22,3,44,50,62,34,29,6,18],via:[48,19,42,67,10,31,72,13,74,33],cfdem_add_lib_path:39,timestep:[13,51,23],transit:[50,65],filenam:[19,23],minallowedvcellbyvparcel:66,writetim:[12,59,73],select:[0,42,46,9,13,32],laeuscalartemp:37,tackl:62,two:[19,2,41,52,38,13],formul:[17,49,3,24,52,6,13],more:[36,22,43,44,50,13],desir:[43,39],forcemodel_archimed:13,nrdemstep:27,flag:[17,37,38,39,42,50,3,24,47,66,34,29,10,6,51],known:[47,56,69],none:[0,7,58,3,4,48,8,9,49,6,12,18,1,15,17,22,23,24,26,28,29,30,31,32,33,34,36,75,69,40,42,43,44,45,46,57,5,50,16,54,55,2,59,60,61,63,21,67,70,71,53,74,68,76],dev:39,remain:[50,22,44,29],dem:[30,3,6,1,9,49,11,51,13,14,17,19,20,23,24,26,34,38,31,33,36,37,39,41,42,45,46,62,52,55,2,60,61,66,74],sphere:[47,62],minimum:[22,65,50,44,64,66,29,15],dmolecular:38,switch5:[6,49,3,34,38],forcemodel_particlevolum:13,divid:[13,29],rather:[25,56],anoth:[47,65],couplingproperi:13,number4:[22,44],number2:[50,22,44,29,10,12,15],number3:[50,12,22,44,29],number1:[50,65,22,44,29,10,12,15],phinam:54,momcouplemodel_xi:36,trilinear:65,stash:39,caus:27,media:11,help:39,myprobemodel:67,metallurg:62,treatdem:[55,71],dataexchangemodel:[62,13],thermal:[37,38],through:39,hollowaydrag:74,fieldtimeaverageprop:59,style:13,fvoptionst:54,pimpleimex:[18,10],timeevalful:43,usevolumefract:73,might:[0,55,36,1,39,42,28,45,57,48,8,68,67,13,27,18,74,33,60],turbulencemodeltyp:13,timestamp:[46,30],framework:[11,62,13,20],detach:39,archimedesprop:2,bigger:[13,22,50,44],troubleshoot:39,convect:[11,37,38],easili:13,found:13,weight:[73,22,44,29,15],procedur:[13,39],runeverycouplingstep:[30,51],oil:62,expect:66,upperlimit:10,safeti:43,execute_1:30,execute_0:30,difelicedragprop:34,hill:6,print:74,naumann:17,advanc:39,reason:[13,39,66],voidfractionnam:54,put:43,forcemodel_schillernaumanndrag:13,kochhilldragprop:6,smoothingmodel_nosmooth:13,veloc:[49,3,75,10,6,14,17,24,25,34,38,36,37,52,57,62,54,55,56,61,64,66],omit:43,success:13,cfdem_ut_dir:[43,39],feel:39,exchang:[35,36,18,19,20,23,45,26,64,38,10,11,31,72,13,54],number:[55,43,30,19,39,22,23,64,50,47,66,44,38,10,74,51],cadd:14,stabl:36,gpl:13,superpos:[42,72],differ:[39,2,41,47,62,71,69,13,54],script:[43,13,39],interact:[17,49,2,41,42,61,3,24,9,6,52,74,14,34],least:[13,39],statement:43,smoothen:18,molecular:38,cfd:[1,30,9,11,12,13,15,19,20,22,23,25,27,29,31,32,33,35,36,75,38,39,40,41,43,44,45,46,47,62,50,16,52,55,56,60,64,65,26,21,69,72,74,68],evinc:13,option:[49,3,71,9,10,6,12,14,15,17,22,24,27,34,38,73,37,29,39,41,44,52,46,47,5,50,54,55,2,61,66,69,59],verbosetofil:74,part:[28,39,22,47,38,13],preno:27,timeinterv:[66,32,51],mclaughlin:61,grep:74,noblank:30,remov:39,store:[46,43,4,23],meshmot:53,toward:62,gidaspowdragprop:3,comput:[37,39,52,47,62,38,13],gedit:39,packag:[13,39],fluidscalarfield:38,self:52,violat:42,also:[39,9,29],cfdemtesttut:39,cellpoint:[17,37,61,3,34,38,6],ergun:3,distribut:[47,13,65,44],lowerthreshold:[12,73],writetofil:[12,5,73],implforcedemaccumul:[6,55],previou:[62,29],reach:13,mixtur:54,beetstradrag:74,most:[42,74,54,39],rho:42,cover:[13,62,22,50,44],liggghtscommandmodel_runliggght:13,clean:65,lvtkfilter:39,particlecellvolum:12,engineib:[47,29],find:[68,47,13,69,39],access:39,firewal:39,particlevolumeprop:5,factor:3,cfdemsolverpisoscalar:13,voidfractionmodel:13,ubuntuvtk_fp:39,model_i:[55,42,1],express:61,cfdem_add_libs_nam:39,model_x:[55,42,1],cfdem_project_dir:[13,39],restart:46,ofvers:39,volweightedaverag:73,relativepath:23,certif:39,set:[55,36,30,38,39,42,22,44,50,47,62,66,27,9,29,69,71,72,13,32,54],dump:[27,39],transportproperti:13,see:[37,20,39,2,41,61,3,24,11,67,9,38,49,6,71,52,74,14,34],iomodel_trackio:13,close:13,analog:12,piso:[11,20],someth:39,voidfractionmodel_gaussvoidfract:13,smallest:66,altern:[46,42,54,39,38],concentr:54,numer:[6,38],solv:[36,20,62,11,13,54],cfdem_src_dir:39,both:[13,39],voidfract:[50,3,4,7,10,6,18,65,17,22,34,38,15,33,73,37,29,41,44,54,64,59,21],last:[46,47,30,9,69],immers:[41,47,62,52,35],tempor:[47,59,73],whole:[62,40],point:[47,29],warnonli:66,pneumat:[37,38],trilinearprop:65,due:66,timeaverage_scalarfield:59,implicit:[17,36,3,64,38,10,6,18,21],imag:[47,50],demand:[55,71],spliturelcalcul:14,look:[0,55,36,1,18,39,42,28,45,57,60,8,68,13,33],twowayfilesprop:19,straight:16,erron:27,"while":[62,39],abov:[30,3,39],error:[13,18,39,10],loos:13,loop:43,pack:51,readi:42,centr:[55,22,65,50,44,47,33,15],readm:39,octav:13,minim:[47,50],executeprops0:30,executeprops1:30,conflict:36,updatemixtureproperti:54,wherea:[36,13],pressurefieldnam:52,forcesubmodel_imex:13,user:[55,13,54,66],koch:6,robust:16,implement:[36,62,29,67,11,13,74,54],lower:[12,73,10],particul:3,older:39,runeverywritestep:30,enginesearch:69,cfdem_lpp_dir:39,vorticityinterpolationtyp:61,partspeciesfluxnam:38,tempfieldnam:[37,38],theoret:3,voidfracfieldnamesprev:29,input:[31,13],euler:10,format:39,impldem:[55,71],fedora_fp:39,lost:39,semi:55,resolv:[41,52],flux:[37,54,14,38],pirker:[11,62,20],engineibprop:47,some:[47,13,71,69,39],sampl:74,poros:[22,44,29,15],scale:[37,38,22,3,44,5,34,29,10,6,13,15],id2:74,id3:74,per:[22,74,61],id1:74,mathemat:52,larg:[13,54],slash:[30,51],xprecis:74,proc:[11,62,75,20],liggghtscommmand:[30,46,1,27,32,51],clockmodel_standardclock:13,run:[43,1,19,39,28,46,30,27,38,31,13,32,51,76],particleid:74,stem:[41,2],forcemodel_volweightedaverag:13,step:[55,30,19,39,74,43,23,46,62,66,27,29,13,32,51],voidfractionmodel_ibvoidfract:13,writeliggght:1,impos:36,folder_of_new_additionallibs_fil:39,cfdemproject:[13,39],block:39,within:[55,1,39,22,62,13,73],ensur:[47,54],chang:[36,39,43,66,27,10],artifici:[50,22,44,29],occupi:[22,44,29,15],lowerlimit:10,question:39,"long":39,custom:39,includ:[35,39,64,40,72,13,74,54],suit:[41,52],forward:16,properli:39,gauss:44,newer:39,atom:38,line:[30,51,39],info:74,zhu:3,archimedesib:[41,62],lvtkcommon:39,constant:[50,22,44,62,29,70,13,54],repres:[37,41,52,47,62,38,12,33],incomplet:[55,42,8],lpp:39,sequenti:[42,19],forcemodel_fieldtimeaverag:13,printeveri:74,librari:39,tech:[37,38],smoothingmodel_xi:18,meaning:36,cfdemsolverscalar:37,cfdem_tut_dir:39,algorithm:[20,28,52,47,62,69,10,11,16],vice:29,depth:52,uinterpolationtyp:[17,61,3,34,38,6,14],code:[43,39,20,28,23,45,19,62,26,50,38,11,31,13,54],gran_pizza_17aug10:39,cfdem_project_user_dir:39,fieldtimeaverag:59,superfici:54,forcemodel_laeuscalartemp:13,forcemodel_gidaspowdrag:13,send:13,granular:[37,64,11,25,56,34,38,6],aris:39,shirgaonkaribprop:52,deactiv:74,account:[55,49,20,22,44,24,29,11,15],volum:[49,3,4,6,11,12,14,15,17,20,22,24,34,38,33,73,37,29,41,44,52,47,5,50,54,2,61,64,65,66,59],stackoverflow:39,implicitli:[55,36],relev:[36,13,18,39],tri:61,cpvolumetr:54,"try":39,pleas:[0,55,36,1,39,42,28,45,57,48,8,68,67,13,18,74,33,60],cfl:66,smaller:[13,66],prandtl:54,"g\u00f6teborg":[11,20],gmbh:13,investig:[37,38],download:39,compat:39,index:51,compar:18,cell:[55,36,50,69,22,3,62,44,56,65,47,25,66,68,29,10,16,12,73,54,15],experiment:6,github_:39,bodi:[62,22],checkcouplinginterv:66,ubuntu:39,becom:66,sinc:43,convert:39,larger:[66,10],cert:39,typic:[36,66],particletrack:70,appli:[0,55,36,1,20,42,28,68,45,57,25,56,8,9,11,71,18,74,33,60],forcemodel_meilift:13,apt:39,cloud:[25,13,56],from:[55,19,39,2,41,62,23,47,25,29,31,65],commun:[55,9],doubl:43,particl:[48,2,3,4,6,75,8,9,10,11,12,18,14,15,17,13,20,22,23,24,25,27,34,29,31,33,73,36,37,38,19,41,42,44,52,47,5,49,50,54,55,56,57,59,61,64,65,66,67,70,74,68],next:29,doubt:3,usr:39,postprocess:[39,5,66,12,13,59,73],name_:46,casepath:75,sampleal:74,"transient":[37,38],iii:66,smoothinglengthreferencefield:10,alia:[43,39],alic:[62,22,50],tau:49,process:[36,43,62],sudo:39,gidaspowdrag:3,serial:75,virtualmassforc:14,surfac:[47,50,54],filepath:51,probemodel_noprob:13,instead:[47,39],switchingvoidfract:3,voidfractionmodel_dividedvoidfract:13,forcemodel_nodrag:13,attent:[18,10],physic:[7,54,52],correspond:[38,47,69,16,74,68],element:13,allow:[65,67,62,66,38,29,13],velocityfieldnam:[66,49,24],move:47,fluidscalarfieldinterpolationtyp:38,chosen:42,liggghtscommandmodel_xi:1,cfdem_add_lib:39,fluidiz:6,therefor:[66,39],engineprop:69,greater:[12,73],cfdem_vers:39,handl:[55,74],auto:38,probemodel:13,scalargeneralexchang:38,shirgaonkar:52,disregard:62,our:39,scalarviscos:[55,37,61,3,34,38,49,6],special:[62,30,50,51],out:[43,10],variabl:[36,43,9,39],speciesconvect:38,influenc:[37,38,22,4,44,5,66,50,29,12,59,73],scalarfieldnam:[59,4,73],suitabl:38,rel:[46,23],wich:39,communi:55,cfdemcomplig:39,constdiffsmooth:[18,10],archimed:[42,13,2],insid:[56,22,44,25,50,15],manipul:[60,39],heatfluid:[37,38],releas:39,afterward:43,speciesc:38,unwant:74,keep:[50,22,74,44,29],averagingmodel:13,length:[38,10],organis:13,navier:[11,36,62,20],gradpforc:[42,13,74,24],softwar:[11,62,13,20],downof_:39,christoph:13,qualiti:66,date:51,"1e3":72,"1e2":72,"1e4":72,owner:[11,62,13,20],publickei:39,licens:13,wierink:62,system:[11,13,3,39],viscforc:[13,42,49,74],termin:[42,74,39],meshmotionmodel:13,"var":39,bed:6,meshmotionmodel_nomeshmot:13,result:[22,39,66],caclul:9,hager:[11,62,22,50,20],have:[55,39,43,57,29,13,73],need:[30,39,42,43,66,70,13,51],probedebug:74,min:66,discret:[20,49,3,24,11,13],which:[48,58,3,4,9,10,13,22,27,29,36,60,39,43,44,62,50,70,72,74,68,76],deenet:38,graviti:[41,32,2],singl:25,forcemodel_particlecellvolum:13,"1e10":[72,10],xysplit:47,"class":[0,43,36,1,18,28,68,60,8,33,13,54],iomodel_basicio:13,dens:[57,25,56,36,38],face:[54,39],deni:39,determin:13,gain:62,cfdem_pizza_dir:39,vtk_out:[19,23],text:74,verbos:[55,37,38,2,74,61,3,52,46,5,30,27,34,29,10,6,12,32,51,73],word1:[66,54,73],word3:54,word2:54,locat:[39,43,47,62,69,16,13,68],vectorfieldnam:[59,4,73],dispers:54,suppos:[22,65,50,44,25,56,29],ksl:[18,10],local:[18,39,64],contribut:[62,22,50],pull:39,increas:[50,51,22,44,29],enginesearchib:[47,62],organ:13,checkcouplingintervalprop:66,integr:9,contain:[62,43],grad:[49,24],runliggghtsprop:27,statu:39,correctli:[4,39],boundari:[35,41,4,52,47,62,29,10,18],state:39,chemic:38,cfdem_bashrc:39,partheatfluxnam:[37,38],generalmanu:[38,54],predefin:[38,39],kei:[13,39],zsplit:47,fvoption:54,equal:[43,13,65,10],etc:[62,13,54,39],admit:39,instanc:30,grain:42,equat:[55,36,37,20,62,11,13,54],freeli:13,meilift:[61,74],comment:39,partspeciestranscoeffnam:38,scalar3:[37,3,66,34,6,51,32,54],scalar2:[37,19,49,3,5,66,34,6,51,32,54,73],scalar1:[37,19,61,3,5,24,52,66,54,49,6,51,73,32,14,34],testtutori:39,scalar7:38,scalar6:[66,38],scalar5:[37,3,38,66],scalar4:[37,3,51,66],respect:[55,43,39,50,62,28],addition:[70,72,30,21,39],treat:36,trajectori:[11,20],partial:[62,50],neighbour:65,write_restart:[46,30],present:[62,39,10],deen:38,multi:62,nodrag:9,couplingfilenam:[19,23],defin:[0,7,2,3,4,1,8,9,10,6,12,18,14,15,16,17,13,19,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,5,49,50,51,52,53,54,55,56,57,58,60,61,63,64,65,66,68,69,70,71,72,73,59,75,76],version2x:39,layer:47,volweightedaverageprop:73,impforc:36,site:13,demt:[13,19,23],archiv:22,"7_2":11,parti:13,python:[43,39],phi:[3,54,14],http:[13,39],dividedprop:29,cubic:65,effect:55,phy:52,eulerian:[57,25,56,38,55],expand:13,off:[48,58,3,30,8,6,18,51,17,24,34,38,32,35,37,29,46,55,63,67,74,76],nevertheless:39,well:[11,74,10],exampl:13,command:13,averagingmodel_dens:13,interpol:[17,37,38,55,61,3,24,34,29,49,6,14,65],dsphere:[5,22,44,29,15],latest:[13,39],distanc:[47,50],opencfd:[11,62,13,20],less:36,obtain:36,tcp:39,cellvolum:12,makefil:39,wen:3,add:[13,74,39],densiti:[41,42,66,54,2],imex:[55,71],realiz:[62,38],know:54,"2nd":38,recurs:[47,69],iomodel_xi:8,twowayfil:[19,45],like:43,cshrc:39,constdiffsmoothingprop:10,gradpinterpolationtyp:24,necessari:[22,39,43,52,70,13],porou:11,schillernaumanndrag:17,momcouplemodel:13,liggght:[30,39,20,46,62,27,51,38,11,13,32,14],"export":39,home:39,transport:[11,55,37,38,54],cfdem_liggghts_src_dir:39,vparticl:[49,22,44,24,50,29,15],restart_:30,avoid:[36,74],estim:66,setsourcefield:72,journal:[61,52],usag:[55,43,13],voidfractionmodel_trilinearvoidfract:13,disabl:67,own:[66,39],automat:[30,27,39],partspeciesfluidnam:38,van:6,transfer:[11,37,38],demtim:66,biggest:66,"function":[39,20,11,12,13,59,72,73],twowaympi:[31,45],gaussian:44,basicio:[75,21],matplot:43,temp:[37,38],displac:[11,20],whether:54,smooth:[36,50,65,58,10,18],troubl:[27,39],below:[13,48,74,39,67],limit:[37,38,20,22,44,65,62,50,29,10,11,72,13,15],umaxexpect:66,otherwis:[74,13,18,39,10],problem:[36,13,62,39],evalu:[25,43,76],"int":[62,43],dure:[30,74,46,27,13,32,51],voidfractionmodel_xi:33,courant:66,detail:[37,39,2,41,61,3,24,52,9,38,49,6,13,74,14,34],virtual:14,other:[0,55,36,1,18,39,42,28,45,57,60,8,68,13,74,33],rememb:43,varieti:54,buijtenen:6,repeat:51,zhou:[13,49,34,24],june:[11,20],rhomix:54,printonlyatstep:74,"8th":62},objtypes:{},objnames:{},filenames:["regionModel","liggghtsCommandModel","forceModel_Archimedes","forceModel_GidaspowDrag","forceModel_fieldStore","forceModel_particleVolume","forceModel_KochHillDrag","voidFractionModel_noVoidFraction","IOModel","forceModel_noDrag","smoothingModel_constDiffSmoothing","cfdemSolverPisoScalar","forceModel_particleCellVolume","CFDEMcoupling_Manual","forceModel_virtualMassForce","voidFractionModel_centreVoidFraction","locateModel_standardSearch","forceModel_SchillerNaumannDrag","smoothingModel","dataExchangeModel_twoWayFiles","cfdemSolverPiso","IOModel_sophIO","voidFractionModel_bigParticleVoidFraction","dataExchangeModel_oneWayVTK","forceModel_gradPForce","averagingModel_dilute","dataExchangeModel_noDataExchange","liggghtsCommandModel_runLiggghts","clockModel","voidFractionModel_dividedVoidFraction","liggghtsCommandModel_execute","dataExchangeModel_twoWayMPI","liggghtsCommandModel_setDEMGravity","voidFractionModel","forceModel_DiFeliceDrag","momCoupleModel_noCouple","momCoupleModel","forceModel_LaEuScalarTemp","forceModel_scalarGeneralExchange","githubAccess_public","regionModel_allRegion","forceModel_ArchimedesIB","forceModel","clockModel_standardClock","voidFractionModel_GaussVoidFraction","dataExchangeModel","liggghtsCommandModel_writeLiggghts","locateModel_engineSearchIB","probeModel_noProbe","forceModel_viscForce","voidFractionModel_IBVoidFraction","liggghtsCommandModel_readLiggghtsData","forceModel_ShirgaonkarIB","meshMotionModel_noMeshMotion","scalarTransportModel","forceSubModel","averagingModel_dense","averagingModel","smoothingModel_noSmoothing","forceModel_fieldTimeAverage","meshMotionModel","forceModel_MeiLift","cfdemSolverIB","IOModel_noIO","momCoupleModel_implicitCouple","voidFractionModel_trilinearVoidFraction","forceModel_checkCouplingInterval","probeModel","locateModel","locateModel_engineSearch","IOModel_trackIO","forceSubModel_ImEx","momCoupleModel_explicitCouple","forceModel_volWeightedAverage","probeModel_particleProbe","IOModel_basicIO","clockModel_noClock"],titles:["regionModel command","liggghtsCommandModel command","forceModel_Archimedes command","forceModel_GidaspowDrag command","forceModel_fieldStore command","forceModel_particleVolume command","forceModel_KochHillDrag command","voidfractionModel_noVoidFractionVoidFraction command","IOModel command","forceModel_noDrag command","smoothingModel_constDiffSmoothing command","cfdemSolverPisoScalar command","forceModel_particleCellVolume command","CFDEMcoupling Documentation","forceModel_virtualMassForce command","voidfractionModel_centreVoidFraction command","locateModel_standardSearch command","forceModel_SchillerNaumannDrag command","smoothingModel command","dataExchangeModel_twoWayFiles command","cfdemSolverPiso command","IOModel_sophIO command","voidfractionModel_bigParticleVoidFraction command","dataExchangeModel_oneWayVTK command","forceModel_gradPForce command","averagingModel_dilute command","dataExchangeModel_noDataExchange command","liggghtsCommandModel_runLiggghts command","clockModel command","voidfractionModel_dividedVoidFraction command","liggghtsCommandModel_execute command","dataExchangeModel_twoWayMPI command","liggghtsCommandModel_setDEMGravity command","voidfractionModel command","forceModel_DiFeliceDrag command","momCoupleModel_noCouple command","momCoupleModel command","forceModel_LaEuScalarTemp command","forceModel_scalarGeneralExchange command","githubAccess_public","regionModel_allRegion command","forceModel_ArchimedesIB command","forceModel command","clockModel_standardClock command","voidfractionModel_GaussVoidFraction command","dataExchangeModel command","liggghtsCommandModel_writeLiggghts command","locateModel_engineSearchIB command","probeModel_noProbe command","forceModel_viscForce command","voidfractionModel_IBVoidFraction command","liggghtsCommandModel_readLiggghtsData command","forceModel_ShirgaonkarIB command","meshMotionModel_noMeshMotion command","scalarTransportModel command","forceSubModel command","averagingModel_dense command","averagingModel command","smoothingModel_noSmoothing command","forceModel_fieldTimeAverage command","meshMotionModel command","forceModel_MeiLift command","cfdemSolverIB command","IOModel_noIO command","momCoupleModel_implicitCouple command","voidfractionModel_trilinearVoidFraction command","forceModel_checkCouplingInterval command","probeModel command","locateModel command","locateModel_engineSearch command","IOModel_trackIO command","forceSubModel_ImEx command","momCoupleModel_explicitCouple command","forceModel_volWeightedAverage command","probeModel_particleProbe command","IOModel_basicIO command","clockModel_noClock command"],objects:{},titleterms:{execut:30,forcemodel_archimedesib:41,syntax:[0,1,2,3,4,7,8,9,10,6,12,18,14,15,17,16,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,19,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,5,63,64,65,66,67,68,69,70,71,72,73,74,75,76],voidfractionmodel_bigparticlevoidfract:22,githubaccess_publ:39,regionmodel:0,forcemodel_laeuscalartemp:37,forcemodel_gidaspowdrag:3,locatemodel_enginesearch:69,cfdemsolverpisoscalar:11,voidfractionmodel:33,liggghtscommandmodel:1,voidfractionmodel_novoidfractionvoidfract:7,probemodel:67,dataexchangemodel:45,averagingmodel_dilut:25,cfdemsolverpiso:20,solver:13,forcemodel:42,forcemodel_difelicedrag:34,dataexchangemodel_twowaympi:31,iomodel_trackio:70,clockmodel_noclock:76,momcouplemodel:36,replac:30,clockmodel:28,forcemodel_kochhilldrag:6,forcemodel_virtualmassforc:14,liggghtscommandmodel_readliggghtsdata:51,forcesubmodel:55,content:13,voidfractionmodel_gaussvoidfract:44,liggghtscommand:13,forcemodel_viscforc:49,forcemodel_volweightedaverag:73,voidfractionmodel_trilinearvoidfract:65,dictionari:13,writeliggght:30,forcemodel_schillernaumanndrag:17,about:13,smoothingmodel_nosmooth:58,forcemodel_scalargeneralexchang:38,averagingmodel:57,tutori:13,readliggght:30,voidfractionmodel_ibvoidfract:50,forcemodel_meilift:61,restrict:[0,1,2,3,4,7,8,9,10,6,12,18,14,15,17,16,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,19,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,5,63,64,65,66,67,68,69,70,71,72,73,74,75,76],instal:13,scalartransportmodel:54,liggghtscommandmodel_setdemgrav:32,cfdemsolverib:62,iomodel:8,regionmodel_allregion:40,locatemodel_standardsearch:16,forcemodel_gradpforc:24,couplingproperti:13,meshmotionmodel:60,dataexchangemodel_twowayfil:19,forcemodel_archimed:2,relat:[7,2,3,4,30,8,9,10,6,12,14,15,17,16,22,23,24,25,26,27,34,29,31,32,73,35,37,38,19,40,41,42,43,44,45,46,47,5,49,50,51,52,54,55,56,57,58,61,63,64,65,66,21,69,70,71,72,53,59,75,76],iomodel_noio:63,iomodel_sophio:21,momcouplemodel_implicitcoupl:64,cfdemcoupl:13,dataexchangemodel_onewayvtk:23,can:30,meshmotionmodel_nomeshmot:53,voidfractionmodel_centrevoidfract:15,smoothingmodel:18,forcemodel_checkcouplinginterv:66,forcemodel_shirgaonkarib:52,locatemodel_enginesearchib:47,locatemodel:68,forcemodel_particlevolum:5,smoothingmodel_constdiffsmooth:10,liggghtscommandmodel_execut:30,momcouplemodel_nocoupl:35,rather:30,liggghtscommandmodel_writeliggght:46,forcemodel_fieldtimeaverag:59,probemodel_noprob:48,complex:30,document:13,forcemodel_particlecellvolum:12,clockmodel_standardclock:43,dataexchangemodel_nodataexchang:26,voidfractionmodel_dividedvoidfract:29,forcesubmodel_imex:71,forcemodel_nodrag:9,iomodel_basicio:75,momcouplemodel_explicitcoupl:72,forcemodel_fieldstor:4,descript:[0,1,2,3,4,5,6,7,8,9,10,11,12,18,14,15,16,17,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,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],liggghtscommandmodel_runliggght:27,exampl:[0,1,2,3,4,7,8,9,10,6,12,18,14,15,17,16,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,19,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,5,63,64,65,66,67,68,69,70,71,72,73,74,75,76],command:[0,1,2,3,4,5,6,7,8,9,10,11,12,18,14,15,17,16,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,19,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],averagingmodel_dens:56,model:13,probemodel_particleprob:74}}) \ No newline at end of file diff --git a/doc/_build/html/smoothingModel.html b/doc/_build/html/smoothingModel.html new file mode 100644 index 0000000..fc6d932 --- /dev/null +++ b/doc/_build/html/smoothingModel.html @@ -0,0 +1,234 @@ + + + + + + + + + + + smoothingModel command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • smoothingModel command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

smoothingModel command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
smoothingModel model;
+
+
+
    +
  • model = name of the smoothingModel to be applied
    • +
+
+
+

Examples

+
smoothingModel off;
+
+
+
smoothingModel  constDiffSmoothing;
+
+
+
smoothingModel  localPSizeDiffSmoothing;
+
+
+

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

+

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.

+
+
+

Description

+

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).

+
+
+

Restrictions

+
+
These models are in beta testing.
+

Default: none.

+
+
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/smoothingModel_constDiffSmoothing.html b/doc/_build/html/smoothingModel_constDiffSmoothing.html new file mode 100644 index 0000000..c226a1f --- /dev/null +++ b/doc/_build/html/smoothingModel_constDiffSmoothing.html @@ -0,0 +1,250 @@ + + + + + + + + + + + smoothingModel_constDiffSmoothing command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • smoothingModel_constDiffSmoothing command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

smoothingModel_constDiffSmoothing command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
smoothingModel constDiffSmoothing;
+constDiffSmoothingProps
+{
+    lowerLimit number1;
+    upperLimit number2;
+    smoothingLength lengthScale;
+    smoothingLengthReferenceField lengthScaleRefField;
+    verbose;
+}
+
+
+
    +
  • number1 = scalar fields will be bound to this lower value
    • +
  • number2 = scalar fields will be bound to this upper value
    • +
  • lengthScale = length scale over which the exchange fields will be smoothed out
    • +
  • 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.
    • +
  • verbose = (optional, default false) flag for debugging output
    • +
+
+
+

Examples

+
constDiffSmoothingProps
+{
+    lowerLimit 0.1;
+    upperLimit 1e10;
+    smoothingLength 1500e-6;
+    smoothingLengthReferenceField 9000e-6;
+}
+
+
+
+
+

Description

+

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. +Smoothing 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.

+
+
+

Restrictions

+
+
This model is tested in a limited number of flow situations.
+

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.

+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/smoothingModel_noSmoothing.html b/doc/_build/html/smoothingModel_noSmoothing.html new file mode 100644 index 0000000..4e69b7e --- /dev/null +++ b/doc/_build/html/smoothingModel_noSmoothing.html @@ -0,0 +1,227 @@ + + + + + + + + + + + smoothingModel_noSmoothing command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • smoothingModel_noSmoothing command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

smoothingModel_noSmoothing command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
smoothingModel off;
+
+
+
+
+

Examples

+
smoothingModel off;
+
+
+
+
+

Description

+

The “noSmoothing” model is a dummy smoothingModel model which does no smoothing.

+
+
+

Restrictions

+
+
none.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/voidFractionModel.html b/doc/_build/html/voidFractionModel.html new file mode 100644 index 0000000..d594fe0 --- /dev/null +++ b/doc/_build/html/voidFractionModel.html @@ -0,0 +1,227 @@ + + + + + + + + + + + voidfractionModel command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • voidfractionModel command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

voidfractionModel command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
voidfractionModel model;
+
+
+
    +
  • model = name of the voidfractionModel to be applied
    • +
+
+
+

Examples

+
voidfractionModel centre;
+
+
+

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

+
+
+

Description

+

The voidfractionModel is the base class for models to represent the DEM particle’s volume in the CFD domain via a voidfraction field.

+
+
+

Restrictions

+
+
none.
+

Default: none.

+
+
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/voidFractionModel_GaussVoidFraction.html b/doc/_build/html/voidFractionModel_GaussVoidFraction.html new file mode 100644 index 0000000..4915776 --- /dev/null +++ b/doc/_build/html/voidFractionModel_GaussVoidFraction.html @@ -0,0 +1,249 @@ + + + + + + + + + + + voidfractionModel_GaussVoidFraction command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • voidfractionModel_GaussVoidFraction command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

voidfractionModel_GaussVoidFraction command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
voidfractionModel Gauss;
+GaussProps
+{
+    maxCellsPerParticle number1;
+    alphaMin number2;
+    weight number3;
+    porosity number4;
+}
+
+
+
    +
  • number1 = maximum number of cells covered by a particle (search will fail when more than number1 cells are covered by the particle)
    • +
  • number2 = minimum limit for voidfraction
    • +
  • number3 = (optional) scaling of the particle volume to account for porosity or agglomerations.
    • +
  • number4 = (optional) diameter of the particle’s representation is artificially increased according to number2 * Vparticle, volume remains unaltered!
    • +
+
+
+

Examples

+
voidfractionModel Gauss;
+GaussProps
+{
+    maxCellsPerParticle 1000;
+    alphaMin 0.10;
+    weight 1.;
+    porosity 1.;
+}
+
+
+
+
+

Description

+

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.

+

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.

+

The particle volume occupied in the CFD domain can be adjusted by the parameter “weight”, using Vparticle=dsphere^3*pi/6*weight.

+
+
+

Restrictions

+
+
none.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/voidFractionModel_IBVoidFraction.html b/doc/_build/html/voidFractionModel_IBVoidFraction.html new file mode 100644 index 0000000..e28d51d --- /dev/null +++ b/doc/_build/html/voidFractionModel_IBVoidFraction.html @@ -0,0 +1,248 @@ + + + + + + + + + + + voidfractionModel_IBVoidFraction command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • voidfractionModel_IBVoidFraction command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

voidfractionModel_IBVoidFraction command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
voidfractionModel IB;
+IBProps
+{
+    maxCellsPerParticle number1;
+    alphaMin number2;
+    scaleUpVol number3;
+    checkPeriodicCells ;
+}
+
+
+
    +
  • number1 = maximum number of cells covered by a particle (search will fail when more than number1 cells are covered by the particle)
    • +
  • number2 = minimum limit for voidfraction
    • +
  • number3 = diameter of the particle’s representation is artificially increased according to number3 * Vparticle, volume remains unaltered!
    • +
  • checkPeriodicCells = (optional, default false) flag for considering the minimal distance to all periodic images of this particle
    • +
+
+
+

Examples

+
voidfractionModel IB;
+IBProps
+{
+    maxCellsPerParticle 1000;
+    alphaMin 0.10;
+    scaleUpVol 5.0;
+}
+
+
+
+
+

Description

+

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.

+

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.

+

Code of this sub-model contributed by Alice Hager, JKU.

+
+
+

Restrictions

+
+
none.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/voidFractionModel_bigParticleVoidFraction.html b/doc/_build/html/voidFractionModel_bigParticleVoidFraction.html new file mode 100644 index 0000000..1129bf5 --- /dev/null +++ b/doc/_build/html/voidFractionModel_bigParticleVoidFraction.html @@ -0,0 +1,250 @@ + + + + + + + + + + + voidfractionModel_bigParticleVoidFraction command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • voidfractionModel_bigParticleVoidFraction command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

voidfractionModel_bigParticleVoidFraction command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
voidfractionModel bigParticle;
+bigParticleProps
+{
+    maxCellsPerParticle number1;
+    alphaMin number2;
+    weight number3;
+    porosity number4;
+}
+
+
+
    +
  • number1 = maximum number of cells covered by a particle (search will fail when more than number1 cells are covered by the particle)
    • +
  • number2 = minimum limit for voidfraction
    • +
  • number3 = (optional) scaling of the particle volume to account for porosity or agglomerations.
    • +
  • number4 = (optional) diameter of the particle’s representation is artificially increased according to number2 * Vparticle, volume remains unaltered!
    • +
+
+
+

Examples

+
voidfractionModel bigParticle;
+bigParticleProps
+{
+    maxCellsPerParticle 1000;
+    alphaMin 0.10;
+    weight 1.;
+    porosity 5.0;
+}
+
+
+
+
+

Description

+

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.

+

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.

+

The particle volume occupied in the CFD domain can be adjusted by the parameter “weight”, using Vparticle=dsphere^3*pi/6*weight.

+

Parts of this sub-model contributed by Alice Hager, JKU.

+
+
+

Restrictions

+
+
none.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/voidFractionModel_centreVoidFraction.html b/doc/_build/html/voidFractionModel_centreVoidFraction.html new file mode 100644 index 0000000..81f4c60 --- /dev/null +++ b/doc/_build/html/voidFractionModel_centreVoidFraction.html @@ -0,0 +1,242 @@ + + + + + + + + + + + voidfractionModel_centreVoidFraction command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • voidfractionModel_centreVoidFraction command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

voidfractionModel_centreVoidFraction command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
voidfractionModel centre;
+centreProps
+{
+    alphaMin number1;
+    weight number2;
+}
+
+
+
    +
  • number1 = minimum limit for voidfraction
    • +
  • number2 = (optional) scaling of the particle volume to account for porosity or agglomerations.
    • +
+
+
+

Examples

+
voidfractionModel centre;
+centreProps
+{
+    alphaMin 0.1;
+    weight 1.;
+}
+
+
+
+
+

Description

+

The centre voidFraction model calculates the voidfraction in a CFD cell accounting for the volume of the particles whose centres are inside the cell.

+

The particle volume occupied in the CFD domain can be adjusted by the parameter “weight”, using Vparticle=dsphere^3*pi/6*weight.

+
+
+

Restrictions

+
+
none.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/voidFractionModel_dividedVoidFraction.html b/doc/_build/html/voidFractionModel_dividedVoidFraction.html new file mode 100644 index 0000000..8c7dab5 --- /dev/null +++ b/doc/_build/html/voidFractionModel_dividedVoidFraction.html @@ -0,0 +1,254 @@ + + + + + + + + + + + voidfractionModel_dividedVoidFraction command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • voidfractionModel_dividedVoidFraction command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

voidfractionModel_dividedVoidFraction command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
voidfractionModel divided;
+dividedProps
+{
+    alphaMin number1;
+    interpolation;
+    weight number2;
+    porosity number3;
+    procBoundaryCorrection Switch1;
+    verbose;
+    cfdemUseOnly;
+}
+
+
+
    +
  • number1 = minimum limit for voidfraction
    • +
  • interpolation = flag to interpolate voidfraction to particle positions (normally off)
    • +
  • number2 = (optional) scaling of the particle volume to account for porosity or agglomerations.
    • +
  • number3 = (optional) diameter of the particle’s representation is artificially increased according to number2 * Vparticle, volume remains unaltered!
    • +
  • Switch1 = (optional, default false) allow for correction at processor boundaries. This requires the use of engineIB and vice versa.
    • +
  • verbose = (optional, default false) flag for debugging output
    • +
  • cfdemUseOnly = optional flag, default false
    • +
+
+
+

Examples

+
voidfractionModel divided;
+dividedProps
+{
+    alphaMin 0.2;
+}
+
+
+
+
+

Description

+

The divided voidFraction model is supposed to be used when a particle (or its representation) is in the size range of a CFD cell. Satellite points are used to divide the particle’s volume to the touched cells.

+

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.

+

The particle volume occupied in the CFD domain can be adjusted by the parameter “weight”, using Vparticle=dsphere^3*pi/6*weight.

+

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. +The 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.

+
+
+

Restrictions

+
+
none.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/voidFractionModel_noVoidFraction.html b/doc/_build/html/voidFractionModel_noVoidFraction.html new file mode 100644 index 0000000..9b5b458 --- /dev/null +++ b/doc/_build/html/voidFractionModel_noVoidFraction.html @@ -0,0 +1,223 @@ + + + + + + + + + + + voidfractionModel_noVoidFractionVoidFraction command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • voidfractionModel_noVoidFractionVoidFraction command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

voidfractionModel_noVoidFractionVoidFraction command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+

voidfractionModel noVoidFraction;

+
+
+

Examples

+

voidfractionModel noVoidFraction;

+
+
+

Description

+

The noVoidFraction voidFraction model is a dummy model and has no physical meaning.

+
+
+

Restrictions

+
+
none.
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/_build/html/voidFractionModel_trilinearVoidFraction.html b/doc/_build/html/voidFractionModel_trilinearVoidFraction.html new file mode 100644 index 0000000..07142d9 --- /dev/null +++ b/doc/_build/html/voidFractionModel_trilinearVoidFraction.html @@ -0,0 +1,238 @@ + + + + + + + + + + + voidfractionModel_trilinearVoidFraction command — CFDEMcoupling v3.X documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+
    +
  • Docs »
    • + +
  • voidfractionModel_trilinearVoidFraction command
    • +
  • + + + Website + + +
    • +
+
+ +
+
+
+ +
+

voidfractionModel_trilinearVoidFraction command

+
+

Syntax

+

Defined in couplingProperties dictionary.

+
voidfractionModel trilinear;
+trilinearProps
+{
+    alphaMin number1;
+}
+
+
+
    +
  • number1 = minimum limit for voidfraction
    • +
+
+
+

Examples

+
voidfractionModel trilinear;
+trilinearProps
+{
+    alphaMin 0.3;
+}
+
+
+
+
+

Description

+

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.

+
+
+

Restrictions

+
+
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!!!
+
+ +
+ + +
+
+
+ + +
+ +
+

+ © Copyright 2016, DCS Computing GmbH, JKU Linz. + +

+
+ Built with Sphinx using a theme provided by Read the Docs. + +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/averagingModel.html b/doc/averagingModel.html deleted file mode 100644 index 4ac82b3..0000000 --- a/doc/averagingModel.html +++ /dev/null @@ -1,41 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

averagingModel command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
averagingModel model; 
-
-
  • model = name of averaging model to be applied -
-

Examples: -

-
averagingModel dense;
-averagingModel dilute; 
-
-

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

-

Description: -

-

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

-

Restrictions: -

-

None. -

-

Related commands: -

-

dense, dilute -

-

Default: none -

- diff --git a/doc/averagingModel.txt b/doc/averagingModel.txt new file mode 100644 index 0000000..cfa4d4a --- /dev/null +++ b/doc/averagingModel.txt @@ -0,0 +1,37 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +averagingModel command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +averagingModel model; :pre + +model = name of averaging model to be applied :ul + +[Examples:] + +averagingModel dense; +averagingModel dilute; :pre + +Note: This examples list might not be complete - please have a look for other averaging models (averagingModel_XY) in this documentation. + +[Description:] + +The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. particle velocities). + +[Restrictions:] + +None. + +[Related commands:] + +"dense"_averagingModel_dense.html, "dilute"_averagingModel_dilute.html + +[Default:] none diff --git a/doc/averagingModel_dense.html b/doc/averagingModel_dense.html deleted file mode 100644 index 239c82d..0000000 --- a/doc/averagingModel_dense.html +++ /dev/null @@ -1,34 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

averagingModel_dense command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
averagingModel dense; 
-
-

Examples: -

-
averagingModel dense; 
-
-

Description: -

-

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. -

-

Restrictions: -

-

No known restrictions. -

-

Related commands: -

-

averagingModel, dilute -

- diff --git a/doc/averagingModel_dense.txt b/doc/averagingModel_dense.txt new file mode 100644 index 0000000..52da602 --- /dev/null +++ b/doc/averagingModel_dense.txt @@ -0,0 +1,31 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +averagingModel_dense command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +averagingModel dense; :pre + +[Examples:] + +averagingModel dense; :pre + +[Description:] + +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. + +[Restrictions:] + +No known restrictions. + +[Related commands:] + +"averagingModel"_averagingModel.html, "dilute"_averagingModel_dilute.html + diff --git a/doc/averagingModel_dilute.html b/doc/averagingModel_dilute.html deleted file mode 100644 index 6f75339..0000000 --- a/doc/averagingModel_dilute.html +++ /dev/null @@ -1,35 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

averagingModel_dilute command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
averagingModel dilute; 
-
-

Examples: -

-
averagingModel dilute; 
-
-

Description: -

-

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 "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). -

-

Restrictions: -

-

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

-

Related commands: -

-

averagingModel, dense -

- diff --git a/doc/averagingModel_dilute.txt b/doc/averagingModel_dilute.txt new file mode 100644 index 0000000..56640de --- /dev/null +++ b/doc/averagingModel_dilute.txt @@ -0,0 +1,32 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +averagingModel_dilute command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +averagingModel dilute; :pre + +[Examples:] + +averagingModel dilute; :pre + +[Description:] + +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 "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). + +[Restrictions:] + +This model is computationally efficient, but should only be used when only one particle is inside one CFD cell. + +[Related commands:] + +"averagingModel"_averagingModel.html, "dense"_averagingModel_dense.html + diff --git a/doc/cfdemSolverIB.html b/doc/cfdemSolverIB.html deleted file mode 100644 index 70a9f1c..0000000 --- a/doc/cfdemSolverIB.html +++ /dev/null @@ -1,53 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

cfdemSolverIB command -

-

Description: -

-

"cfdemSolverIB" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework, for calculating -the 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(R)(*) 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. -

-

Code of this solver contributions by Alice Hager, JKU. -

-

Algorithm: -

-

For each time step ... -

-
  • 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). - -
  • the Navier-Stokes equations are solved on the whole computational domain, disregarding the solid phase. - -
  • 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. - -
  • 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. - - -
-

Use: -

-

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: -

-

engineSearchIB, ArchimedesIB, ShirgaonkarIB, IBVoidfraction -

-

References: -

-

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 -

-

and -

-

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 -

-
- -

(*) 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. -

-
- - diff --git a/doc/cfdemSolverIB.txt b/doc/cfdemSolverIB.txt new file mode 100644 index 0000000..aeed18d --- /dev/null +++ b/doc/cfdemSolverIB.txt @@ -0,0 +1,44 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +cfdemSolverIB command :h3 + +[Description:] + +"cfdemSolverIB" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework, for calculating +the 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(R)(*) 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. + +Code of this solver contributions by Alice Hager, JKU. + +[Algorithm:] + +For each time step ... + +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). :ulb,l +the Navier-Stokes equations are solved on the whole computational domain, disregarding the solid phase. :l +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. :l +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. :l +:ule + +[Use:] + +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: + +"engineSearchIB"_locateModel_engineSearchIB.html, "ArchimedesIB"_forceModel_ArchimedesIB.html, "ShirgaonkarIB"_forceModel_ShirgaonkarIB.html, "IBVoidfraction"_voidFractionModel_IBVoidFraction.html + +[References:] + +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 + +and + +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 + +:line +(*) 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. + +:line diff --git a/doc/cfdemSolverPiso.html b/doc/cfdemSolverPiso.html deleted file mode 100644 index f517f0e..0000000 --- a/doc/cfdemSolverPiso.html +++ /dev/null @@ -1,26 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

cfdemSolverPiso command -

-

Description: -

-

"cfdemSolverPiso" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam(R)(*), 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. -

-

see: -

-

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. -

-
- -

(*) 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. -

-
- - diff --git a/doc/cfdemSolverPiso.txt b/doc/cfdemSolverPiso.txt new file mode 100644 index 0000000..19e8310 --- /dev/null +++ b/doc/cfdemSolverPiso.txt @@ -0,0 +1,24 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +cfdemSolverPiso command :h3 + +[Description:] + +"cfdemSolverPiso" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam(R)(*), 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. + +see: + +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. + + + + +:line +(*) 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. + +:line diff --git a/doc/cfdemSolverPisoScalar.html b/doc/cfdemSolverPisoScalar.html deleted file mode 100644 index 3732a72..0000000 --- a/doc/cfdemSolverPisoScalar.html +++ /dev/null @@ -1,28 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

cfdemSolverPisoScalar command -

-

Description: -

-

"cfdemSolverPisoScalar" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam(R)(*), 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". -

-

see: -

-

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. -

-

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

-
- -

(*) 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. -

-
- - diff --git a/doc/cfdemSolverPisoScalar.txt b/doc/cfdemSolverPisoScalar.txt new file mode 100644 index 0000000..7565ed0 --- /dev/null +++ b/doc/cfdemSolverPisoScalar.txt @@ -0,0 +1,25 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +cfdemSolverPisoScalar command :h3 + +[Description:] + +"cfdemSolverPisoScalar" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam(R)(*), 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". + +see: + +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. + +The heat transfer equation is implemented according to Nield & Bejan (2013), Convection in Porous Media, DOI 10.1007/978-1-4614-5541-7_2, Springer + + + +:line +(*) 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. + +:line diff --git a/doc/clockModel.html b/doc/clockModel.html deleted file mode 100644 index 7b590f8..0000000 --- a/doc/clockModel.html +++ /dev/null @@ -1,36 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

clockModel command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
clockModel model; 
-
-
  • model = name of the clockModel to be applied -
-

Examples: -

-
clockModel standardClock; 
-
-

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

-

Description: -

-

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

-

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

-

Restrictions: none. -

-

Default: none. -

- diff --git a/doc/clockModel.txt b/doc/clockModel.txt new file mode 100644 index 0000000..fa93276 --- /dev/null +++ b/doc/clockModel.txt @@ -0,0 +1,32 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +clockModel command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +clockModel model; :pre + +model = name of the clockModel to be applied :ul + +[Examples:] + +clockModel standardClock; :pre + +Note: This examples list might not be complete - please look for other models (clockModel_XY) in this documentation. + +[Description:] + +The clockModel is the base class for models to examine the code/algorithm with respect to run time. + +Main parts of the clockModel classes are written by Josef Kerbl, JKU. + +[Restrictions:] none. + +[Default:] none. diff --git a/doc/clockModel_noClock.html b/doc/clockModel_noClock.html deleted file mode 100644 index 23448e4..0000000 --- a/doc/clockModel_noClock.html +++ /dev/null @@ -1,32 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

clockModel_noClock command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
clockModel off; 
-
-

Examples: -

-
clockModel off; 
-
-

Description: -

-

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

-

Restrictions: none. -

-

Related commands: -

-

clockModel -

- diff --git a/doc/clockModel_noClock.txt b/doc/clockModel_noClock.txt new file mode 100644 index 0000000..509c0b6 --- /dev/null +++ b/doc/clockModel_noClock.txt @@ -0,0 +1,29 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +clockModel_noClock command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +clockModel off; :pre + +[Examples:] + +clockModel off; :pre + +[Description:] + +The "noClock" model is a dummy clockModel model which does not measure/evaluate the run time. + +[Restrictions:] none. + +[Related commands:] + +"clockModel"_clockModel.html + diff --git a/doc/clockModel_standardClock.html b/doc/clockModel_standardClock.html deleted file mode 100644 index b757df1..0000000 --- a/doc/clockModel_standardClock.html +++ /dev/null @@ -1,34 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

clockModel_standardClock command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
clockModel standardClock; 
-
-

Examples: -

-
clockModel standardClock; 
-
-

Description: -

-

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 . -Since 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. -After 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. -

-

Restrictions: none. -

-

Related commands: -

-

clockModel -

- diff --git a/doc/clockModel_standardClock.txt b/doc/clockModel_standardClock.txt new file mode 100644 index 0000000..bae9832 --- /dev/null +++ b/doc/clockModel_standardClock.txt @@ -0,0 +1,31 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +clockModel_standardClock command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +clockModel standardClock; :pre + +[Examples:] + +clockModel standardClock; :pre + +[Description:] + +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 . +Since 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. +After 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. + +[Restrictions:] none. + +[Related commands:] + +"clockModel"_clockModel.html + diff --git a/doc/dataExchangeModel.html b/doc/dataExchangeModel.html deleted file mode 100644 index 51d81bb..0000000 --- a/doc/dataExchangeModel.html +++ /dev/null @@ -1,41 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

dataExchangeModel command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
dataExchangeModel model; 
-
-
  • model = name of data exchange model to be applied -
-

Examples: -

-
dataExchangeModel twoWayFiles;
-dataExchangeModel twoWayMPI; 
-
-

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

-

Description: -

-

The data exchange model performs the data exchange between the DEM code and the CFD code. -

-

Restrictions: -

-

None. -

-

Related commands: -

-

noDataExchange, oneWayVTK, twoWayFiles, twoWayMPI -

-

Default: none -

- diff --git a/doc/dataExchangeModel.txt b/doc/dataExchangeModel.txt new file mode 100644 index 0000000..42e0638 --- /dev/null +++ b/doc/dataExchangeModel.txt @@ -0,0 +1,37 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +dataExchangeModel command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +dataExchangeModel model; :pre + +model = name of data exchange model to be applied :ul + +[Examples:] + +dataExchangeModel twoWayFiles; +dataExchangeModel twoWayMPI; :pre + +Note: This examples list might not be complete - please look for other models (dataExchangeModel_XY) in this documentation. + +[Description:] + +The data exchange model performs the data exchange between the DEM code and the CFD code. + +[Restrictions:] + +None. + +[Related commands:] + +"noDataExchange"_dataExchangeModel_noDataExchange.html, "oneWayVTK"_dataExchangeModel_oneWayVTK.html, "twoWayFiles"_dataExchangeModel_twoWayFiles.html, "twoWayMPI"_dataExchangeModel_twoWayMPI.html + +[Default:] none diff --git a/doc/dataExchangeModel_noDataExchange.html b/doc/dataExchangeModel_noDataExchange.html deleted file mode 100644 index f84f4a5..0000000 --- a/doc/dataExchangeModel_noDataExchange.html +++ /dev/null @@ -1,34 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

dataExchangeModel_noDataExchange command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
dataExchangeModel noDataExchange; 
-
-

Examples: -

-
dataExchangeModel noDataExchange; 
-
-

Description: -

-

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. -

-

Restrictions: -

-

None. -

-

Related commands: -

-

dataExchangeModel -

- diff --git a/doc/dataExchangeModel_noDataExchange.txt b/doc/dataExchangeModel_noDataExchange.txt new file mode 100644 index 0000000..ee6db03 --- /dev/null +++ b/doc/dataExchangeModel_noDataExchange.txt @@ -0,0 +1,31 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +dataExchangeModel_noDataExchange command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +dataExchangeModel noDataExchange; :pre + +[Examples:] + +dataExchangeModel noDataExchange; :pre + +[Description:] + +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. + +[Restrictions:] + +None. + +[Related commands:] + +"dataExchangeModel"_dataExchangeModel.html + diff --git a/doc/dataExchangeModel_oneWayVTK.html b/doc/dataExchangeModel_oneWayVTK.html deleted file mode 100644 index def2619..0000000 --- a/doc/dataExchangeModel_oneWayVTK.html +++ /dev/null @@ -1,58 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

dataExchangeModel_oneWayVTK command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
dataExchangeModel oneWayVTK;
-oneWayVTKProps
-{
-    DEMts timeStep;
-    relativePath "path";
-    couplingFilename "filename";
-    maxNumberOfParticles number;
-}; 
-
-
  • timeStep = time step size of stored DEM data - -
  • path = path to the VTK data files relative do simulation directory - -
  • filename = filename of the VTK file series - -
  • number = maximum number of particles in DEM simulation - - -
-

Examples: -

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

Description: -

-

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. -

-

Restrictions: -

-

None. -

-

Related commands: -

-

dataExchangeModel -

- diff --git a/doc/dataExchangeModel_oneWayVTK.txt b/doc/dataExchangeModel_oneWayVTK.txt new file mode 100644 index 0000000..3cf6642 --- /dev/null +++ b/doc/dataExchangeModel_oneWayVTK.txt @@ -0,0 +1,51 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +dataExchangeModel_oneWayVTK command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +dataExchangeModel oneWayVTK; +oneWayVTKProps +\{ + DEMts timeStep; + relativePath "path"; + couplingFilename "filename"; + maxNumberOfParticles number; +\}; :pre + +{timeStep} = time step size of stored DEM data :ulb,l +{path} = path to the VTK data files relative do simulation directory :l +{filename} = filename of the VTK file series :l +{number} = maximum number of particles in DEM simulation :l +:ule + +[Examples:] + +dataExchangeModel oneWayVTK; +oneWayVTKProps +\{ + DEMts 0.0001; + relativePath "../DEM/post"; + couplingFilename "vtk_out%4.4d.vtk"; + maxNumberOfParticles 30000; +\} :pre + +[Description:] + +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. + +[Restrictions:] + +None. + +[Related commands:] + +"dataExchangeModel"_dataExchangeModel.html + diff --git a/doc/dataExchangeModel_twoWayFiles.html b/doc/dataExchangeModel_twoWayFiles.html deleted file mode 100644 index d281513..0000000 --- a/doc/dataExchangeModel_twoWayFiles.html +++ /dev/null @@ -1,53 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

dataExchangeModel_twoWayFiles command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
dataExchangeModel twoWayFiles;
-twoWayFilesProps
-{
-    couplingFilename "filename";
-    maxNumberOfParticles scalar1;
-    DEMts scalar2;
-}; 
-
-
  • filename = filename of the VTK file series - -
  • scalar1 = maximum number of particles in DEM simulation - -
  • scalar2 = DEM time step width - - -
-

Examples: -

-
dataExchangeModel twoWayFiles;
-twoWayFilesProps
-{
-    couplingFilename "vtk_out%4.4d.vtk";
-    maxNumberOfParticles 30000;
-} 
-
-

Description: -

-

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. -

-

Restrictions: -

-

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

-

Related commands: -

-

dataExchangeModel -

- diff --git a/doc/dataExchangeModel_twoWayFiles.txt b/doc/dataExchangeModel_twoWayFiles.txt new file mode 100644 index 0000000..4504f6e --- /dev/null +++ b/doc/dataExchangeModel_twoWayFiles.txt @@ -0,0 +1,47 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +dataExchangeModel_twoWayFiles command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +dataExchangeModel twoWayFiles; +twoWayFilesProps +\{ + couplingFilename "filename"; + maxNumberOfParticles scalar1; + DEMts scalar2; +\}; :pre + +{filename} = filename of the VTK file series :ulb,l +{scalar1} = maximum number of particles in DEM simulation :l +{scalar2} = DEM time step width :l +:ule + +[Examples:] + +dataExchangeModel twoWayFiles; +twoWayFilesProps +\{ + couplingFilename "vtk_out%4.4d.vtk"; + maxNumberOfParticles 30000; +\} :pre + +[Description:] + +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. + +[Restrictions:] + +Developed only for two processors, one for DEM and one for CFD run. + +[Related commands:] + +"dataExchangeModel"_dataExchangeModel.html + diff --git a/doc/dataExchangeModel_twoWayMPI.html b/doc/dataExchangeModel_twoWayMPI.html deleted file mode 100644 index cde5fab..0000000 --- a/doc/dataExchangeModel_twoWayMPI.html +++ /dev/null @@ -1,46 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

dataExchangeModel_twoWayMPI command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
dataExchangeModel twoWayMPI;
-twoWayMPIProps
-{
-    liggghtsPath "path";
-}; 
-
-
  • path = path to the DEM simulation input file - - -
-

Examples: -

-
dataExchangeModel twoWayMPI;
-twoWayMPIProps
-{
-    liggghtsPath "../DEM/in.liggghts_init";
-} 
-
-

Description: -

-

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. -

-

Restrictions: -

-

none. -

-

Related commands: -

-

dataExchangeModel -

- diff --git a/doc/dataExchangeModel_twoWayMPI.txt b/doc/dataExchangeModel_twoWayMPI.txt new file mode 100644 index 0000000..f698b0e --- /dev/null +++ b/doc/dataExchangeModel_twoWayMPI.txt @@ -0,0 +1,42 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +dataExchangeModel_twoWayMPI command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +dataExchangeModel twoWayMPI; +twoWayMPIProps +\{ + liggghtsPath "path"; +\}; :pre + +{path} = path to the DEM simulation input file :ulb,l +:ule + +[Examples:] + +dataExchangeModel twoWayMPI; +twoWayMPIProps +\{ + liggghtsPath "../DEM/in.liggghts_init"; +\} :pre + +[Description:] + +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. + +[Restrictions:] + +none. + +[Related commands:] + +"dataExchangeModel"_dataExchangeModel.html + diff --git a/doc/forceModel.html b/doc/forceModel.html deleted file mode 100644 index 0e71fa5..0000000 --- a/doc/forceModel.html +++ /dev/null @@ -1,50 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    model_x
-    model_y
-); 
-
-
  • model = name of force model to be applied -
-

Examples: -

-
forceModels
-(
-    Archimedes
-    DiFeliceDrag
-); 
-
-

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

-

Description: -

-

The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. 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. -

-

Restrictions: -

-

None. -

-

Related commands: -

-

Archimedes, DiFeliceDrag, gradPForce, viscForce -

-

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

-

Default: none. -

- diff --git a/doc/forceModel.txt b/doc/forceModel.txt new file mode 100644 index 0000000..4254843 --- /dev/null +++ b/doc/forceModel.txt @@ -0,0 +1,46 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + model_x + model_y +); :pre + +model = name of force model to be applied :ul + +[Examples:] + +forceModels +( + Archimedes + DiFeliceDrag +); :pre + +Note: This examples list might not be complete - please look for other models (forceModel_XY) in this documentation. + +[Description:] + +The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. 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. + +[Restrictions:] + +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, a warning is written to the terminal (log file). Setting a flag "cgWarnOnly false;" in coupling properties, the simulation will be stopped if there is a violation. + +[Related commands:] + +"Archimedes"_forceModel_Archimedes.html, "DiFeliceDrag"_forceModel_DiFeliceDrag.html, "gradPForce"_forceModel_gradPForce.html, "viscForce"_forceModel_viscForce.html + +Note: This examples list may be incomplete - please look for other models (forceModel_XY) in this documentation. + +[Default:] none. diff --git a/doc/forceModel_Archimedes.html b/doc/forceModel_Archimedes.html deleted file mode 100644 index 49d86b7..0000000 --- a/doc/forceModel_Archimedes.html +++ /dev/null @@ -1,61 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_Archimedes command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    Archimedes
-);
-ArchimedesProps
-{
-    gravityFieldName "gravity";
-    twoDimensional;
-    suppressProbe   switch1;
-    treatForceDEM   switch2;
-}; 
-
-
  • gravity = name of the finite volume gravity field - -
  • twoDimensional = optional keyword for conducting a two dimensional calculation - -
  • switch1 = (optional, default false) can be used to suppress the output of the probe model - -
  • switch2 = (optional, default true) sub model switch, see forceSubModel for details - - -
-

Examples: -

-
forceModels
-(
-    Archimedes
-);
-ArchimedesProps
-{
-    gravityFieldName "g";
-} 
-
-

Description: -

-

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. -

-

Restrictions: -

-

none. -

-

Related commands: -

-

forceModel -

- diff --git a/doc/forceModel_Archimedes.txt b/doc/forceModel_Archimedes.txt new file mode 100644 index 0000000..596284e --- /dev/null +++ b/doc/forceModel_Archimedes.txt @@ -0,0 +1,56 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_Archimedes command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + Archimedes +); +ArchimedesProps +\{ + gravityFieldName "gravity"; + twoDimensional; + suppressProbe switch1; + treatForceDEM switch2; + verbose switch3; +\}; :pre + +{gravity} = name of the finite volume gravity field :ulb,l +{twoDimensional} = optional keyword for conducting a two dimensional calculation :l +{switch1} = (optional, default false) can be used to suppress the output of the probe model :l +{switch2} = (optional, default true) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch3} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +:ule + +[Examples:] + +forceModels +( + Archimedes +); +ArchimedesProps +\{ + gravityFieldName "g"; +\} :pre + +[Description:] + +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. + +[Restrictions:] + +none. + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_ArchimedesIB.html b/doc/forceModel_ArchimedesIB.html deleted file mode 100644 index 681bf9f..0000000 --- a/doc/forceModel_ArchimedesIB.html +++ /dev/null @@ -1,62 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_ArchimedesIB command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    ArchimedesIB
-);
-ArchimedesIBProps
-{
-    gravityFieldName "gravity";
-    voidfractionFieldName "voidfraction";
-    twoDimensional;
-    treatForceExplicit  switch1;
-}; 
-
-
  • gravity = name of the finite volume gravity field - -
  • voidfraction = name of the finite volume voidfraction field - -
  • twoDimensional = optional keyword for conducting a two dimensional calculation - -
  • switch1 = (optional, default true) sub model switch, see forceSubModel for details - - -
-

Examples: -

-
forceModels
-(
-    ArchimedesIB
-);
-ArchimedesIBProps
-{
-    gravityFieldName "g";
-    voidfractionFieldName "voidfractionNext";
-} 
-
-

Description: -

-

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. -

-

Restrictions: -

-

Only for immersed boundary solvers. -

-

Related commands: -

-

forceModel -

- diff --git a/doc/forceModel_ArchimedesIB.txt b/doc/forceModel_ArchimedesIB.txt new file mode 100644 index 0000000..45582f7 --- /dev/null +++ b/doc/forceModel_ArchimedesIB.txt @@ -0,0 +1,55 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_ArchimedesIB command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + ArchimedesIB +); +ArchimedesIBProps +\{ + gravityFieldName "gravity"; + voidfractionFieldName "voidfraction"; + twoDimensional; + treatForceExplicit switch1; +\}; :pre + +{gravity} = name of the finite volume gravity field :ulb,l +{voidfraction} = name of the finite volume voidfraction field :l +{twoDimensional} = optional keyword for conducting a two dimensional calculation :l +{switch1} = (optional, default true) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +:ule + +[Examples:] + +forceModels +( + ArchimedesIB +); +ArchimedesIBProps +\{ + gravityFieldName "g"; + voidfractionFieldName "voidfractionNext"; +\} :pre + +[Description:] + +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. + +[Restrictions:] + +Only for immersed boundary solvers. + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_DiFeliceDrag.html b/doc/forceModel_DiFeliceDrag.html deleted file mode 100644 index 94eb175..0000000 --- a/doc/forceModel_DiFeliceDrag.html +++ /dev/null @@ -1,92 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_DiFeliceDrag command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    DiFeliceDrag
-);
-DiFeliceDragProps
-{
-    velFieldName "U";
-    voidfractionFieldName "voidfraction";
-    granVelFieldName "Us";
-    interpolation switch1;
-    voidfractionInterpolationType "type1";
-    UInterpolationType "type2";
-    suppressProbe       switch2;
-    scale               scalar1;
-    scaleDrag           scalar2;
-    treatForceExplicit  switch3;
-    implForceDEM        switch4;
-    verbose             switch5;
-    scalarViscosity     switch6;
-    nu                  scalar3;
-}; 
-
-
  • U = name of the finite volume fluid velocity field - -
  • voidfraction = name of the finite volume voidfraction field - -
  • Us = name of the finite volume granular velocity field - -
  • switch1 = (optional, normally off) flag to use interpolated voidfraction and velocity values - -
  • type1 = (optional, default cellPoint) interpolation type for voidfraction field - -
  • type2 = (optional, default cellPointFace) interpolation type for velocity field - -
  • switch2 = (optional, default false) can be used to suppress the output of the probe model - -
  • scalar1 = (optional) scaling of particle diameter - -
  • scalar2 = (optional) scaling of drag law - -
  • switch3 = sub model switch, see forceSubModel for details - -
  • switch4 = sub model switch, see forceSubModel for details - -
  • switch5 = sub model switch, see forceSubModel for details - -
  • switch6 = sub model switch, see forceSubModel for details - -
  • scalar3 = optional, only if switch6 is true - - -
-

Examples: -

-
forceModels
-(
-    DiFeliceDrag
-);
-DiFeliceDragProps
-{
-    velFieldName "U";
-    interpolation true;
-} 
-
-

Description: -

-

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). -

-

Restrictions: -

-

none. -

-

Related commands: -

-

forceModel -

- diff --git a/doc/forceModel_DiFeliceDrag.txt b/doc/forceModel_DiFeliceDrag.txt new file mode 100644 index 0000000..eba8234 --- /dev/null +++ b/doc/forceModel_DiFeliceDrag.txt @@ -0,0 +1,75 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_DiFeliceDrag command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + DiFeliceDrag +); +DiFeliceDragProps +\{ + velFieldName "U"; + voidfractionFieldName "voidfraction"; + granVelFieldName "Us"; + interpolation switch1; + voidfractionInterpolationType "type1"; + UInterpolationType "type2"; + suppressProbe switch2; + scale scalar1; + scaleDrag scalar2; + treatForceExplicit switch3; + implForceDEM switch4; + verbose switch5; + scalarViscosity switch6; + nu scalar3; +\}; :pre + +{U} = name of the finite volume fluid velocity field :ulb,l +{voidfraction} = name of the finite volume voidfraction field :l +{Us} = name of the finite volume granular velocity field :l +{switch1} = (optional, normally off) flag to use interpolated voidfraction and velocity values :l +{type1} = (optional, default cellPoint) interpolation type for voidfraction field :l +{type2} = (optional, default cellPointFace) interpolation type for velocity field :l +{switch2} = (optional, default false) can be used to suppress the output of the probe model :l +{scalar1} = (optional) scaling of particle diameter :l +{scalar2} = (optional) scaling of drag law :l +{switch3} = sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch4} = sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch5} = sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch6} = sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{scalar3} = optional, only if switch6 is true :l +:ule + +[Examples:] + +forceModels +( + DiFeliceDrag +); +DiFeliceDragProps +\{ + velFieldName "U"; + interpolation true; +\} :pre + +[Description:] + +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). + +[Restrictions:] + +none. + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_GidaspowDrag.html b/doc/forceModel_GidaspowDrag.html deleted file mode 100644 index 1d4cd7e..0000000 --- a/doc/forceModel_GidaspowDrag.html +++ /dev/null @@ -1,101 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_GidaspowDrag command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    GidaspowDrag
-);
-GidaspowDragProps
-{
-    velFieldName "U";
-    voidfractionFieldName "voidfraction";
-    granVelFieldName "Us";
-    phi                 scalar1;
-    interpolation switch1;
-    voidfractionInterpolationType "type1"
-    UInterpolationType "type2"
-    implForceDEM        switch2;
-    suppressProbe       switch3;
-    scale               scalar2;
-    scaleDrag           scalar3;
-    switchingVoidfraction scalar4;
-    treatForceExplicit  switch4;
-    implForceDEM        switch5;
-    verbose             switch6;
-    scalarViscosity     switch7;
-    nu                  scalar5;
-}; 
-
-
  • U = name of the finite volume fluid velocity field - -
  • voidfraction = name of the finite volume voidfraction field - -
  • Us = name of the finite volume cell averaged particle velocity field - -
  • scalar1 = drag correction factor (in doubt 1) - -
  • switch1 = (optional, default off) flag to use interpolated voidfraction and fluid velocity values - -
  • type1 = (optional, default cellPoint) interpolation type for voidfraction field - -
  • type2 = (optional, default cellPointFace) interpolation type for velocity field - -
  • switch2 = (optional, default false) flag to use implicit formulation of drag on DEM side:l -switch3 = (optional, default false) can be used to suppress the output of the probe model - -
  • scalar2 = (optional) scaling of particle diameter - -
  • scalar3 = (optional) scaling of drag law - -
  • scalar4 = (optional) voidfraction above which dilute formulation will be used - -
  • switch4 = (optional, default false) sub model switch, see forceSubModel for details - -
  • switch5 = (optional, default false) sub model switch, see forceSubModel for details - -
  • switch6 = (optional, default false) sub model switch, see forceSubModel for details - -
  • switch7 = (optional, default false) sub model switch, see forceSubModel for details - -
  • scalar5 = (optional, default false) optional, only if switch6 is true - - -
-

Examples: -

-
forceModels
-(
-    GidaspowDrag
-);
-GidaspowDragProps
-{
-    velFieldName "U";
-    voidfractionFieldName "voidfraction";
-    granVelFieldName "Us";
-} 
-
-

Description: -

-

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). -

-

Restrictions: -

-

none. -

-

Related commands: -

-

forceModel -

- diff --git a/doc/forceModel_GidaspowDrag.txt b/doc/forceModel_GidaspowDrag.txt new file mode 100644 index 0000000..4460736 --- /dev/null +++ b/doc/forceModel_GidaspowDrag.txt @@ -0,0 +1,82 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_GidaspowDrag command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + GidaspowDrag +); +GidaspowDragProps +\{ + velFieldName "U"; + voidfractionFieldName "voidfraction"; + granVelFieldName "Us"; + phi scalar1; + interpolation switch1; + voidfractionInterpolationType "type1" + UInterpolationType "type2" + implForceDEM switch2; + suppressProbe switch3; + scale scalar2; + scaleDrag scalar3; + switchingVoidfraction scalar4; + treatForceExplicit switch4; + implForceDEM switch5; + verbose switch6; + scalarViscosity switch7; + nu scalar5; +\}; :pre + +{U} = name of the finite volume fluid velocity field :ulb,l +{voidfraction} = name of the finite volume voidfraction field :l +{Us} = name of the finite volume cell averaged particle velocity field :l +{scalar1} = drag correction factor (in doubt 1) :l +{switch1} = (optional, default off) flag to use interpolated voidfraction and fluid velocity values :l +{type1} = (optional, default cellPoint) interpolation type for voidfraction field :l +{type2} = (optional, default cellPointFace) interpolation type for velocity field :l +{switch2} = (optional, default false) flag to use implicit formulation of drag on DEM side:l +{switch3} = (optional, default false) can be used to suppress the output of the probe model :l +{scalar2} = (optional) scaling of particle diameter :l +{scalar3} = (optional) scaling of drag law :l +{scalar4} = (optional) voidfraction above which dilute formulation will be used :l +{switch4} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch5} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch6} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch7} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{scalar5} = (optional, default false) optional, only if switch6 is true :l +:ule + +[Examples:] + +forceModels +( + GidaspowDrag +); +GidaspowDragProps +\{ + velFieldName "U"; + voidfractionFieldName "voidfraction"; + granVelFieldName "Us"; +\} :pre + +[Description:] + +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). + +[Restrictions:] + +none. + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_KochHillDrag.html b/doc/forceModel_KochHillDrag.html deleted file mode 100644 index bebc637..0000000 --- a/doc/forceModel_KochHillDrag.html +++ /dev/null @@ -1,94 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_KochHillDrag command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    KochHillDrag
-);
-KochHillDragProps
-{
-    velFieldName "U";
-    voidfractionFieldName "voidfraction";
-    granVelFieldName "Us"
-    interpolation       "switch1";
-    voidfractionInterpolationType "type1"
-    UInterpolationType  "type2"
-    implForceDEM        "switch2";
-    suppressProbe       "switch3";
-    scale               "scalar1";
-    scaleDrag           "scalar2";
-    treatForceExplicit  "switch4";
-    verbose             "switch5";
-    implForceDEMaccumulated "switch6";
-    scalarViscosity     "switch7";
-    nu                  "scalar3";
-}; 
-
-
  • U = name of the finite volume fluid velocity field - -
  • voidfraction = name of the finite volume voidfraction field - -
  • Us = (optional) name of finite volume granular velocity field - -
  • switch1 = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values - -
  • type1 = (optional, default cellPoint) interpolation type for voidfraction field - -
  • type2 = (optional, default cellPointFace) interpolation type for velocity field - -
  • switch2 = (optional, normally off) flag to use implicit formulation of drag on DEM side:l -switch3 = (optional, default false) can be used to suppress the output of the probe model - -
  • scalar1 = (optional) scaling of particle diameter - -
  • scalar2 = (optional) scaling of drag law - -
  • switch4 = (optional, default false) sub model switch, see forceSubModel for details - -
  • switch5 = (optional, default false) sub model switch, see forceSubModel for details - -
  • switch6 = (optional, default false) sub model switch, see forceSubModel for details - -
  • switch7 = (optional, default false) sub model switch, see forceSubModel for details - -
  • scalar3 = optional, only if switch7 is true - - -
-

Examples: -

-
forceModels
-(
-    KochHillDrag
-);
-KochHillDragProps
-{
-    velFieldName "U";
-    voidfractionFieldName "voidfraction";
-} 
-
-

Description: -

-

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). -

-

Restrictions: -

-

none. -

-

Related commands: -

-

forceModel -

- diff --git a/doc/forceModel_KochHillDrag.txt b/doc/forceModel_KochHillDrag.txt new file mode 100644 index 0000000..cb9df8d --- /dev/null +++ b/doc/forceModel_KochHillDrag.txt @@ -0,0 +1,77 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_KochHillDrag command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + KochHillDrag +); +KochHillDragProps +\{ + velFieldName "U"; + voidfractionFieldName "voidfraction"; + granVelFieldName "Us" + interpolation "switch1"; + voidfractionInterpolationType "type1" + UInterpolationType "type2" + implForceDEM "switch2"; + suppressProbe "switch3"; + scale "scalar1"; + scaleDrag "scalar2"; + treatForceExplicit "switch4"; + verbose "switch5"; + implForceDEMaccumulated "switch6"; + scalarViscosity "switch7"; + nu "scalar3"; +\}; :pre + +{U} = name of the finite volume fluid velocity field :ulb,l +{voidfraction} = name of the finite volume voidfraction field :l +{Us} = (optional) name of finite volume granular velocity field :l +{switch1} = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values :l +{type1} = (optional, default cellPoint) interpolation type for voidfraction field :l +{type2} = (optional, default cellPointFace) interpolation type for velocity field :l +{switch2} = (optional, normally off) flag to use implicit formulation of drag on DEM side:l +{switch3} = (optional, default false) can be used to suppress the output of the probe model :l +{scalar1} = (optional) scaling of particle diameter :l +{scalar2} = (optional) scaling of drag law :l +{switch4} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch5} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch6} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch7} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{scalar3} = optional, only if switch7 is true :l +:ule + +[Examples:] + +forceModels +( + KochHillDrag +); +KochHillDragProps +\{ + velFieldName "U"; + voidfractionFieldName "voidfraction"; +\} :pre + +[Description:] + +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). + +[Restrictions:] + +none. + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_LaEuScalarTemp.html b/doc/forceModel_LaEuScalarTemp.html deleted file mode 100644 index 7d765b9..0000000 --- a/doc/forceModel_LaEuScalarTemp.html +++ /dev/null @@ -1,102 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_LaEuScalarTemp command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    LaEuScalarTemp
-);
-LaEuScalarTempProps
-{
-    velFieldName "U";
-    tempFieldName "T";
-    voidfractionFieldName "voidfraction";
-    partTempName "Temp";
-    partHeatFluxName "convectiveHeatFlux";
-    partHeatTransCoeffName "heatTransCoeff";
-    partHeatFluidName "heatFluid";
-    lambda scalar1;
-    Cp scalar2;
-    interpolation switch1;
-    TInterpolationType "type1"
-    verbose switch2;
-    maxSource scalar3;
-    scale scalar4;
-    scalarViscosity switch3;
-    nu scalar5;
-}; 
-
-
  • U = name of the finite volume fluid velocity field - -
  • T = name of the finite volume scalar temperature field - -
  • voidfraction = name of the finite volume voidfraction field - -
  • Temp = name of the DEM data representing the particles temperature - -
  • convectiveHeatFlux = name of the DEM data representing the particle-fluid convective heat flux - -
  • heatTransCoeff = name of heat transfer coefficient - -
  • heatFluid = -scalar1 = fluid thermal conductivity [W/(m*K)] - -
  • scalar2 = fluid specific heat capacity [W*s/(kg*K)] - -
  • switch1 = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values - -
  • type1 = (optional, default cellPoint) interpolation type for T field - -
  • switch2 = (optional, default false) sub model switch, see forceSubModel for details - -
  • scalar3 = (optional) limit maximal turbulence - -
  • scalar4 = scaling of particle diameter - -
  • switch3 = (optional, default false) sub model switch, see forceSubModel for details - -
  • scalar5 = optional, only if switch3 is true - - -
-

Examples: -

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

Description: -

-

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 -

-

Restrictions: -

-

Goes only with cfdemSolverScalar. The force model has to be the second (!!!) model in the forces list. -

-

Related commands: -

-

forceModel -

- diff --git a/doc/forceModel_LaEuScalarTemp.txt b/doc/forceModel_LaEuScalarTemp.txt new file mode 100644 index 0000000..9feb241 --- /dev/null +++ b/doc/forceModel_LaEuScalarTemp.txt @@ -0,0 +1,84 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_LaEuScalarTemp command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + LaEuScalarTemp +); +LaEuScalarTempProps +\{ + velFieldName "U"; + tempFieldName "T"; + voidfractionFieldName "voidfraction"; + partTempName "Temp"; + partHeatFluxName "convectiveHeatFlux"; + partHeatTransCoeffName "heatTransCoeff"; + partHeatFluidName "heatFluid"; + lambda scalar1; + Cp scalar2; + interpolation switch1; + TInterpolationType "type1" + verbose switch2; + maxSource scalar3; + scale scalar4; + scalarViscosity switch3; + nu scalar5; +\}; :pre + +{U} = name of the finite volume fluid velocity field :ulb,l +{T} = name of the finite volume scalar temperature field :l +{voidfraction} = name of the finite volume voidfraction field :l +{Temp} = name of the DEM data representing the particles temperature :l +{convectiveHeatFlux} = name of the DEM data representing the particle-fluid convective heat flux :l +{heatTransCoeff} = name of heat transfer coefficient :l +{heatFluid} = +{scalar1} = fluid thermal conductivity \[W/(m*K)\] :l +{scalar2} = fluid specific heat capacity \[W*s/(kg*K)\] :l +{switch1} = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values :l +{type1} = (optional, default cellPoint) interpolation type for T field :l +{switch2} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{scalar3} = (optional) limit maximal turbulence :l +{scalar4} = scaling of particle diameter :l +{switch3} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{scalar5} = optional, only if switch3 is true :l +:ule + +[Examples:] + +forceModels +( + LaEuScalarTemp +); +LaEuScalarTempProps +\{ + velFieldName "U"; + tempFieldName "T"; + voidfractionFieldName "voidfraction"; + partTempName "Temp"; + partHeatFluxName "convectiveHeatFlux"; + lambda 0.0256; + Cp 1007; +\} :pre + +[Description:] + +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 + +[Restrictions:] + +Goes only with cfdemSolverScalar. The force model has to be the second (!!!) model in the forces list. + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_MeiLift.html b/doc/forceModel_MeiLift.html deleted file mode 100644 index b41fbf3..0000000 --- a/doc/forceModel_MeiLift.html +++ /dev/null @@ -1,79 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_MeiLift command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    MeiLift
-);
-MeiLiftProps
-{
-    velFieldName "U";
-    useSecondOrderTerms;
-    interpolation switch1;
-    vorticityInterpolationType "type1"
-    UInterpolationType "type2"
-    verbose switch2;
-    treatForceExplicit switch3;
-    scalarViscosity switch4;
-    nu scalar1;
-}; 
-
-
  • U = name of the finite volume fluid velocity field - -
  • useSecondOrderTerms = switch to activate second order terms in the lift force model - -
  • switch1 = switch to activate tri-linear interpolation of the flow quantities at the particle position - -
  • type1 = (optional, default cellPoint) interpolation type for vorticity field - -
  • type2 = (optional, default cellPointFace) interpolation type for velocity field - -
  • switch2 = switch to activate the report of per-particle quantities to the screen - -
  • switch3 = (optional, default true) sub model switch, see forceSubModel for details - -
  • switch4 = (optional, default false) sub model switch, see forceSubModel for details - -
  • scalar1 = optional, only if switch4 is true - - -
-

Examples: -

-
forceModels
-(
-    MeiLift
-);
-MeiLiftProps
-{
-    velFieldName "U";
-    useSecondOrderTerms;
-    interpolation true;
-    verbose true;
-} 
-
-

Description: -

-

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). -

-

Restrictions: -

-

None. -

-

Related commands: -

-

forceModel -

- diff --git a/doc/forceModel_MeiLift.txt b/doc/forceModel_MeiLift.txt new file mode 100644 index 0000000..270a281 --- /dev/null +++ b/doc/forceModel_MeiLift.txt @@ -0,0 +1,67 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_MeiLift command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + MeiLift +); +MeiLiftProps +\{ + velFieldName "U"; + useSecondOrderTerms; + interpolation switch1; + vorticityInterpolationType "type1" + UInterpolationType "type2" + verbose switch2; + treatForceExplicit switch3; + scalarViscosity switch4; + nu scalar1; +\}; :pre + +{U} = name of the finite volume fluid velocity field :ulb,l +{useSecondOrderTerms} = switch to activate second order terms in the lift force model :l +{switch1} = switch to activate tri-linear interpolation of the flow quantities at the particle position :l +{type1} = (optional, default cellPoint) interpolation type for vorticity field :l +{type2} = (optional, default cellPointFace) interpolation type for velocity field :l +{switch2} = switch to activate the report of per-particle quantities to the screen :l +{switch3} = (optional, default true) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch4} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{scalar1} = optional, only if switch4 is true :l +:ule + +[Examples:] + +forceModels +( + MeiLift +); +MeiLiftProps +\{ + velFieldName "U"; + useSecondOrderTerms; + interpolation true; + verbose true; +\} :pre + +[Description:] + +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). + +[Restrictions:] + +None. + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_SchillerNaumannDrag.html b/doc/forceModel_SchillerNaumannDrag.html deleted file mode 100644 index 8a06f39..0000000 --- a/doc/forceModel_SchillerNaumannDrag.html +++ /dev/null @@ -1,66 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_SchillerNaumannDrag command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    SchillerNaumannDrag
-);
-SchillerNaumannDragProps
-{
-    velFieldName "U";
-    voidfractionFieldName "voidfraction";
-    interpolation "bool1";
-    voidfractionInterpolationType "type1"
-    UInterpolationType "type2"
-    implForceDEM "bool2";
-}; 
-
-
  • U = name of the finite volume fluid velocity field - -
  • voidfraction = name of the finite volume voidfraction field - -
  • bool1 = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values - -
  • type1 = (optional, default cellPoint) interpolation type for voidfraction field - -
  • type2 = (optional, default cellPointFace) interpolation type for velocity field - -bool2 = (optional, normally off) flag to use implicit formulation of drag on DEM side:l - -
-

Examples: -

-
forceModels
-(
-    SchillerNaumannDrag
-);
-SchillerNaumannDragProps
-{
-    velFieldName "U";
-} 
-
-

Description: -

-

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. -

-

Restrictions: -

-

none. -

-

Related commands: -

-

forceModel -

- diff --git a/doc/forceModel_SchillerNaumannDrag.txt b/doc/forceModel_SchillerNaumannDrag.txt new file mode 100644 index 0000000..53ca666 --- /dev/null +++ b/doc/forceModel_SchillerNaumannDrag.txt @@ -0,0 +1,58 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_SchillerNaumannDrag command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + SchillerNaumannDrag +); +SchillerNaumannDragProps +\{ + velFieldName "U"; + voidfractionFieldName "voidfraction"; + interpolation "bool1"; + voidfractionInterpolationType "type1" + UInterpolationType "type2" + implForceDEM "bool2"; +\}; :pre + +{U} = name of the finite volume fluid velocity field :ulb,l +{voidfraction} = name of the finite volume voidfraction field :l +{bool1} = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values :l +{type1} = (optional, default cellPoint) interpolation type for voidfraction field :l +{type2} = (optional, default cellPointFace) interpolation type for velocity field :l +{bool2} = (optional, normally off) flag to use implicit formulation of drag on DEM side:l +:ule + +[Examples:] + +forceModels +( + SchillerNaumannDrag +); +SchillerNaumannDragProps +\{ + velFieldName "U"; +\} :pre + +[Description:] + +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. + +[Restrictions:] + +none. + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_ShirgaonkarIB.html b/doc/forceModel_ShirgaonkarIB.html deleted file mode 100644 index 52c6c43..0000000 --- a/doc/forceModel_ShirgaonkarIB.html +++ /dev/null @@ -1,72 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_ShirgaonkarIB command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    ShirgaonkarIB
-);
-ShirgaonkarIBProps
-{
-    velFieldName "U";
-    pressureFieldName "p";
-    twoDimensional;
-    depth scalar1;
-    verbose switch1;
-    treatForceExplicit switch2;
-}; 
-
-
  • U = name of the finite volume fluid velocity field - -
  • p = name of the finite volume pressure field - -
  • twoDimensional = optional keyword for conducting a two dimensional calculation - -
  • scalar1 = optional, only necessary if twoDimensional is active - -
  • switch1 = (optional, default false) sub model switch, see forceSubModel for details - -
  • switch2 = (optional, default false) sub model switch, see forceSubModel for details - - -
-

Examples: -

-
forceModels
-(
-    ShirgaonkarIB
-);
-ShirgaonkarIBProps
-{
-    velFieldName "U";
-    pressureFieldName "p";
-} 
-
-

Description: -

-

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. -

-

References: -

-

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. -

-

Restrictions: -

-

Only for immersed boundary solvers. -

-

Related commands: -

-

forceModel -

- diff --git a/doc/forceModel_ShirgaonkarIB.txt b/doc/forceModel_ShirgaonkarIB.txt new file mode 100644 index 0000000..eaf4fa2 --- /dev/null +++ b/doc/forceModel_ShirgaonkarIB.txt @@ -0,0 +1,63 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_ShirgaonkarIB command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + ShirgaonkarIB +); +ShirgaonkarIBProps +\{ + velFieldName "U"; + pressureFieldName "p"; + twoDimensional; + depth scalar1; + verbose switch1; + treatForceExplicit switch2; +\}; :pre + +{U} = name of the finite volume fluid velocity field :ulb,l +{p} = name of the finite volume pressure field :l +{twoDimensional} = optional keyword for conducting a two dimensional calculation :l +{scalar1} = optional, only necessary if twoDimensional is active :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch2} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +:ule + +[Examples:] + +forceModels +( + ShirgaonkarIB +); +ShirgaonkarIBProps +\{ + velFieldName "U"; + pressureFieldName "p"; +\} :pre + +[Description:] + +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. + +[References:] + +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. + +[Restrictions:] + +Only for immersed boundary solvers. + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_checkCouplingInterval.txt b/doc/forceModel_checkCouplingInterval.txt new file mode 100644 index 0000000..4f50900 --- /dev/null +++ b/doc/forceModel_checkCouplingInterval.txt @@ -0,0 +1,64 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_checkCouplingInterval command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + checkCouplingInterval +); +checkCouplingIntervalProps +\{ + warnOnly bool1; + velocityFieldName word1; + rhoP scalar1; + maxCFL scalar2; + maxAccNr scalar3; + UmaxExpected scalar4; + minAllowedVcellByVparcel scalar5; + timeInterval scalar6; +\}; :pre + +{bool1} = (optional, default true) switch to warn or stop simulation if criterion is broken. :ulb,l +{word1} = (optional, default U) name of velocity field. :l +{scalar1} = particle density assumed for calculation of the particle relaxation time :l +{scalar2} = (optional, default=50) maximum allowed CFL number. :l +{scalar3} = (optional, default=0.1) maximum allowed ratio of coupling time to particle relaxation time. :l +{scalar4} = maximum expected velocity fluid velocity (e.g. due to BCs) - used for CFL estimation. :l +{scalar5} = (optional, default=3) min allowed volume ratio of cell / particle. :l +{scalar6} = (optional, default=coupling time) interval of execution. :l +:ule + +[Examples:] + +forceModels +( + checkCouplingInterval +); +checkCouplingIntervalProps +\{ + rhoP 2500; + UmaxExpected 10; + timeInterval 0.002; +\} :pre + +[Description:] + +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: (i) 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.1. (ii) 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. (iii) The ratio of smallest cell biggest particle volume. Typically this should be larger than 3. (iiii) The minimum and maximum Stokes Number. For the criteria (i)-(iii) 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. + +[Restrictions:] + +needs MPI based dataExchange model - e.g. oneWayVTK will not work. + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_fieldStore.html b/doc/forceModel_fieldStore.html deleted file mode 100644 index d21cbcb..0000000 --- a/doc/forceModel_fieldStore.html +++ /dev/null @@ -1,68 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_fieldStore command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    fieldStore
-);
-fieldStoreProps
-{
-    scalarFieldNames
-    (
-        "scalarField"
-    );
-    vectorFieldNames
-    (
-        "vectorField"
-    );
-}; 
-
-
  • scalarField = names of the finite volume scalar fields to be stored - -
  • vectorField = names of the finite volume vector fields to be stored - - -
-

Examples: -

-
forceModels
-(
-    fieldStore
-);
-fieldStoreProps
-{
-    scalarFieldNames
-    (
-        "voidfraction"
-    );
-    vectorFieldNames
-    (
-        "U"
-    );
-} 
-
-

Description: -

-

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). -

-

Restrictions: -

-

none. -

-

Related commands: -

-

forceModel -

- diff --git a/doc/forceModel_fieldStore.txt b/doc/forceModel_fieldStore.txt new file mode 100644 index 0000000..2e8af44 --- /dev/null +++ b/doc/forceModel_fieldStore.txt @@ -0,0 +1,63 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_fieldStore command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + fieldStore +); +fieldStoreProps +\{ + scalarFieldNames + ( + "scalarField" + ); + vectorFieldNames + ( + "vectorField" + ); +\}; :pre + +{scalarField} = names of the finite volume scalar fields to be stored :ulb,l +{vectorField} = names of the finite volume vector fields to be stored :l +:ule + +[Examples:] + +forceModels +( + fieldStore +); +fieldStoreProps +\{ + scalarFieldNames + ( + "voidfraction" + ); + vectorFieldNames + ( + "U" + ); +\} :pre + +[Description:] + +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). + +[Restrictions:] + +none. + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_fieldTimeAverage.html b/doc/forceModel_fieldTimeAverage.html deleted file mode 100644 index ac6453e..0000000 --- a/doc/forceModel_fieldTimeAverage.html +++ /dev/null @@ -1,72 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_fieldTimeAverage command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    fieldTimeAverage
-);
-fieldTimeAverageProps
-{
-    startTime time;
-    scalarFieldNames
-    (
-        "scalarField"
-    );
-    vectorFieldNames
-    (
-        "vectorField"
-    );
-}; 
-
-
  • time = (optional) time to start temporal averaging - -
  • scalarField = names of the finite volume scalar fields to be temporally averaged - -
  • vectorField = names of the finite volume vector fields to be temporally averaged - - -
-

Examples: -

-
forceModels
-(
-    fieldTimeAverage
-);
-fieldTimeAverageProps
-{
-    startTime 1.0;
-    scalarFieldNames
-    (
-        "voidfraction"
-    );
-    vectorFieldNames
-    (
-        "Us"
-    );
-} 
-
-

Description: -

-

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. -

-

Restrictions: -

-

none. -

-

Related commands: -

-

forceModel -

- diff --git a/doc/forceModel_fieldTimeAverage.txt b/doc/forceModel_fieldTimeAverage.txt new file mode 100644 index 0000000..94980a1 --- /dev/null +++ b/doc/forceModel_fieldTimeAverage.txt @@ -0,0 +1,66 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_fieldTimeAverage command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + fieldTimeAverage +); +fieldTimeAverageProps +\{ + startTime time; + scalarFieldNames + ( + "scalarField" + ); + vectorFieldNames + ( + "vectorField" + ); +\}; :pre + +{time} = (optional) time to start temporal averaging :ulb,l +{scalarField} = names of the finite volume scalar fields to be temporally averaged :l +{vectorField} = names of the finite volume vector fields to be temporally averaged :l +:ule + +[Examples:] + +forceModels +( + fieldTimeAverage +); +fieldTimeAverageProps +\{ + startTime 1.0; + scalarFieldNames + ( + "voidfraction" + ); + vectorFieldNames + ( + "Us" + ); +\} :pre + +[Description:] + +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. + +[Restrictions:] + +none. + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_gradPForce.html b/doc/forceModel_gradPForce.html deleted file mode 100644 index 1f9728f..0000000 --- a/doc/forceModel_gradPForce.html +++ /dev/null @@ -1,75 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_gradPForce command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    gradPForce;
-);
-gradPForceProps
-{
-    pFieldName "pressure";
-    velocityFieldName "U";
-    interpolation       switch1;
-    gradPInterpolationType "type1"
-    useAddedMass        scalar1;
-    suppressProbe       switch2;
-    treatForceExplicit  switch3;
-    treatForceDEM       switch4;
-}; 
-
-
  • pressure = name of the finite volume fluid pressure field - -
  • U = name of the finite volume fluid velocity field - -
  • switch1 = flag to use interpolated pressure values (normally off) - -
  • type1 = (optional, default cellPointFace) interpolation type for grad(p) field - -
  • useAddedMass = (optional) coefficient of added mass accounted for - -
  • switch2 = (optional, default false) can be used to suppress the output of the probe model - -
  • switch3 = (optional, default true) sub model switch, see forceSubModel for details - -
  • switch4 = (optional, default false) sub model switch, see forceSubModel for details - - -
-

Examples: -

-
forceModels
-(
-    gradPForce;
-);
-gradPForceProps
-{
-    pFieldName "p";
-    velocityFieldName "U";
-    interpolation true;
-} 
-
-

Description: -

-

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). -

-

Restrictions: -

-

none. -

-

Related commands: -

-

forceModel -

- diff --git a/doc/forceModel_gradPForce.txt b/doc/forceModel_gradPForce.txt new file mode 100644 index 0000000..829b553 --- /dev/null +++ b/doc/forceModel_gradPForce.txt @@ -0,0 +1,64 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_gradPForce command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + gradPForce; +); +gradPForceProps +\{ + pFieldName "pressure"; + velocityFieldName "U"; + interpolation switch1; + gradPInterpolationType "type1" + useAddedMass scalar1; + suppressProbe switch2; + treatForceExplicit switch3; + treatForceDEM switch4; +\}; :pre + +{pressure} = name of the finite volume fluid pressure field :ulb,l +{U} = name of the finite volume fluid velocity field :l +{switch1} = flag to use interpolated pressure values (normally off) :l +{type1} = (optional, default cellPointFace) interpolation type for grad(p) field :l +{useAddedMass} = (optional) coefficient of added mass accounted for :l +{switch2} = (optional, default false) can be used to suppress the output of the probe model :l +{switch3} = (optional, default true) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch4} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +:ule + +[Examples:] + +forceModels +( + gradPForce; +); +gradPForceProps +\{ + pFieldName "p"; + velocityFieldName "U"; + interpolation true; +\} :pre + +[Description:] + +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). + +[Restrictions:] + +none. + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_noDrag.html b/doc/forceModel_noDrag.html deleted file mode 100644 index db8df51..0000000 --- a/doc/forceModel_noDrag.html +++ /dev/null @@ -1,62 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_noDrag command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    noDrag
-); 
-
-

noDragProps -{ - noDEMForce; - keepCFDForce; - treatForceExplicit switch1; -} -

-
  • noDragProps are optional. -noDEMForce = optional - -
  • keepCFDForce = optional - -
  • switch1 = (optional, default false) sub model switch, see forceSubModel for details - - -
-

Examples: -

-
forceModels
-(
-    noDrag
-); 
-
-
noDragProps (optional)
-{
-    noDEMForce; (optional, default false) do not apply the previously calculated forces in DEM integration
-    keepCFDForce; (optional, default false) do not delete the previously calculated forces and use them in CFD source terms
-}; 
-
-

Description: -

-

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. -

-

Restrictions: -

-

None. -

-

Related commands: -

-

forceModel -

- diff --git a/doc/forceModel_noDrag.txt b/doc/forceModel_noDrag.txt new file mode 100644 index 0000000..fbb7881 --- /dev/null +++ b/doc/forceModel_noDrag.txt @@ -0,0 +1,54 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_noDrag command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + noDrag +); :pre +noDragProps +\{ + noDEMForce "switch1"; + keepCFDForce "switch2"; + treatForceExplicit "switch3"; +\} + +{switch1} = (optional, default false) do not apply the previously calculated forces in DEM integration :ulb,l +{switch2} = (optional, default false) do not delete the previously calculated forces and use them in CFD source terms :l +{switch3} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +:ule + +[Examples:] + +forceModels +( + noDrag +); :pre + +noDragProps +\{ + noDEMForce true; + keepCFDForce false; +\}; :pre + +[Description:] + +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. + +[Restrictions:] + +None. + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_particleCellVolume.html b/doc/forceModel_particleCellVolume.html deleted file mode 100644 index f6e3ce8..0000000 --- a/doc/forceModel_particleCellVolume.html +++ /dev/null @@ -1,67 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_particleCellVolume command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    particleCellVolume
-);
-particleCellVolumeProps
-{
-    verbose switch1;
-    writeToFile switch2;
-    startTime number1;
-    upperThreshold number2;
-    lowerThreshold number3;
-    verbose;
-}; 
-
-
  • switch1 = (optional, default true) switch for output to screen - -
  • switch2 = (optional, default false) switch for output to file - -
  • number1 = (optional, default 0) start time of volume calculation and output - -
  • number2 = only cells with a field value (magnitude) lower than this upper threshold are considered - -
  • number3 = only cells with a field value (magnitude) greater than this lower threshold are considered - - -
-

Examples: -

-
forceModels
-(
-    particleCellVolume
-);
-particleCellVolumeProps
-{
-    upperThreshold 0.999;
-    lowerThreshold 0;
-} 
-
-

Description: -

-

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. -At "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. -

-

Restrictions: -

-

None. -

-

Related commands: -

-

forceModel -

- diff --git a/doc/forceModel_particleCellVolume.txt b/doc/forceModel_particleCellVolume.txt new file mode 100644 index 0000000..9021c27 --- /dev/null +++ b/doc/forceModel_particleCellVolume.txt @@ -0,0 +1,59 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_particleCellVolume command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + particleCellVolume +); +particleCellVolumeProps +\{ + verbose switch1; + writeToFile switch2; + startTime number1; + upperThreshold number2; + lowerThreshold number3; + verbose; +\}; :pre + +{switch1} = (optional, default true) switch for output to screen :ulb,l +{switch2} = (optional, default false) switch for output to file :l +{number1} = (optional, default 0) start time of volume calculation and output :l +{number2} = only cells with a field value (magnitude) lower than this upper threshold are considered :l +{number3} = only cells with a field value (magnitude) greater than this lower threshold are considered :l +:ule + +[Examples:] + +forceModels +( + particleCellVolume +); +particleCellVolumeProps +\{ + upperThreshold 0.999; + lowerThreshold 0; +\} :pre + +[Description:] + +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. +At "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. + +[Restrictions:] + +None. + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_particleVolume.html b/doc/forceModel_particleVolume.html deleted file mode 100644 index a9e36a3..0000000 --- a/doc/forceModel_particleVolume.html +++ /dev/null @@ -1,61 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_particleVolume command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    particleVolume
-);
-particleVolumeProps
-{
-    verbose switch1;
-    writeToFile switch2;
-    scale scalar1;
-    startTime scalar2;
-}; 
-
-
  • switch1 = (optional, default false) switch for output to screen - -
  • switch2 = (optional, default true) switch for output to file - -
  • scalar1 = (optional, default 1) scaling of the particle volume d=dSphere/scale - -
  • scalar2 = (optional, default 0) start time of volume calculation and output - - -
-

Examples: -

-
forceModels
-(
-    particleVolume
-);
-particleVolumeProps
-{
-    writeToFile false;
-} 
-
-

Description: -

-

This "forceModel" does not influence the particles or the simulation - it is a postprocessing tool! The total volume of the particles is calculated. -

-

Restrictions: -

-

None. -

-

Related commands: -

-

forceModel -

- diff --git a/doc/forceModel_particleVolume.txt b/doc/forceModel_particleVolume.txt new file mode 100644 index 0000000..2386b40 --- /dev/null +++ b/doc/forceModel_particleVolume.txt @@ -0,0 +1,54 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_particleVolume command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + particleVolume +); +particleVolumeProps +\{ + verbose switch1; + writeToFile switch2; + scale scalar1; + startTime scalar2; +\}; :pre + +{switch1} = (optional, default false) switch for output to screen :ulb,l +{switch2} = (optional, default true) switch for output to file :l +{scalar1} = (optional, default 1) scaling of the particle volume d=dSphere/scale :l +{scalar2} = (optional, default 0) start time of volume calculation and output :l +:ule + +[Examples:] + +forceModels +( + particleVolume +); +particleVolumeProps +\{ + writeToFile false; +\} :pre + +[Description:] + +This "forceModel" does not influence the particles or the simulation - it is a postprocessing tool! The total volume of the particles is calculated. + +[Restrictions:] + +None. + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_scalarGeneralExchange.html b/doc/forceModel_scalarGeneralExchange.html deleted file mode 100644 index 408ce00..0000000 --- a/doc/forceModel_scalarGeneralExchange.html +++ /dev/null @@ -1,212 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_scalarGeneralExchange command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    scalarGeneralExchange  // must be 2nd position!
-);
-scalarGeneralExchangeProps
-{
-    useLiMason "switch1"; //default: DeenEtAl
-    useGeneralCorrelation "switch3"; //default: DeenEtAl
-    generalCorrelationParameters (1 2 3 4 5 6 7 8);
-    verbose "switch2";
-    velFieldName "U";
-    voidfractionFieldName "voidfraction";
-    tempFieldName "T";
-    partTempName "Temp";
-    /* partHeatFluxName "convectiveHeatFlux"; //switch off for implicit coupling, e.g., to ParScale */
-    partHeatTransCoeffName "heatTransCoeff";
-    partHeatFluidName "heatFluid";
-    lambda value;
-    Cp value1;
-    //Lists with information for each species FOR THE PARTICLES
-    //MUST be in the same order as eulerian species in 'scalarTransportProperties'
-    //MUST correspond to property/atom in ligghts (use 'couple/cfd/speciesConvection' to auto-generate individual fields)
-    partSpeciesNames
-    (
-    speciesC
-    );
-    partSpeciesFluxNames
-    (
-    speciesCFlux
-    );
-    partSpeciesTransCoeffNames
-    (
-    speciesCTransCoeff
-    );
-    partSpeciesFluidNames
-    (
-    speciesCFluid
-    );
-    DMolecular
-    (
-    value2
-    );
-    interpolation "bool1";
-    voidfractionInterpolationType "type1"
-    UInterpolationType "type2"
-    fluidScalarFieldInterpolationType "type2"
-    scalarViscosity switch5;
-    nu scalar5;
-    suppressProbe switch6;
-    scale scalar6;
-    maxSource scalar7;
-} 
-
-
  • switch1 = (optional) flag to use Nusselt correlations of Li and Mason (2000) - -
  • switch2 = (normally off) for verbose run - -
  • switch3 = (optional) flag to use a general Nusselt number correlation (must specify parameters of this correlation in a list called 'generalCorrelationParameters' ) - -
  • generalCorrelationParameters = list with a predefined number of parameters (for length see src code, only read if useGeneralCorrelation is set to true) - -
  • U = name of the finite volume fluid velocity field - -
  • voidfraction = name of the finite volume voidfraction field - -
  • T = name of the finite volume scalar temperature field - -
  • Temp = name of the DEM data representing the particles temperature - -
  • convectiveHeatFlux = name of the DEM data representing the particle-fluid convective heat flux - -
  • heatTransCoeff = name of the DEM data representing the particle-fluid heat transfer coefficient - -
  • heatFluid = name of the DEM data representing the fluid heat - -
  • value = fluid thermal conductivity [W/(m*K)] - -
  • value1 = fluid specific heat capacity [W*s/(kg*K)] - -
  • speciesC = name of the DEM data representing the transport species of the particles - -
  • speciesCFlux = name of the DEM data representing the particle-fluid species flux - -
  • speciesCTransCoeff = name of the DEM data representing the particle-fluid species transfer coefficient - -
  • speciesCFluid = name of the DEM data representing the transport species of the fluid - -
  • value2 = molecular diffusion coefficient [m^2/s] - -
  • bool1 = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values - -
  • type1 = (optional, default cellPoint) interpolation type for voidfraction field - -
  • type2 = (optional, default cellPointFace) interpolation type for velocity field - -
  • type3 = (optional, default cellPoint) interpolation type for fluidScalarField field - -
  • switch5 = (optional, default false) sub model switch, see forceSubModel for details - -
  • scalar5 = (optional) optional, only if switch5 is true - -
  • switch6 = (optional, default false) can be used to suppress the output of the probe model - -
  • scalar7 = (optional) scaling of particle diameter - -
  • scalar7 = limit maximal turbulence - - -
-

Examples: -

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

Description: -

-

This "forceModel" does not influence the particles or the fluid flow! -Using the particles' temperature and/or species a scalar field -representing "particle-fluid heatflux" and/or "particle-fluid speciesflux" is calculated. -

-

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

-

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

-

The switch 'useGeneralCorrelation' allows one to specify the parameters -of the Gunn correlation as a list called 'generalCorrelationParameters'. -

-

Alternatively, the correclation of -Li and Mason (2000), A computational investigation of transient heat -transfer in pneumatic transport of granular particles, Pow.Tech 112 -can be activated. However, this correlation is not suitable for -dense granular flows. -

-

WARNING: -This model REQUIRES the 'generalManual' speciesTransportModel -

-

Restrictions: -

-

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

-

Related commands: -

-

forceModel forceModel_LaEuScalarTemp -

- diff --git a/doc/forceModel_scalarGeneralExchange.txt b/doc/forceModel_scalarGeneralExchange.txt new file mode 100644 index 0000000..90aaca0 --- /dev/null +++ b/doc/forceModel_scalarGeneralExchange.txt @@ -0,0 +1,184 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_scalarGeneralExchange command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + scalarGeneralExchange // must be 2nd position! +); +scalarGeneralExchangeProps +\{ + useLiMason "switch1"; //default: DeenEtAl + useGeneralCorrelation "switch3"; //default: DeenEtAl + generalCorrelationParameters (1 2 3 4 5 6 7 8); + verbose "switch2"; + velFieldName "U"; + voidfractionFieldName "voidfraction"; + tempFieldName "T"; + partTempName "Temp"; + /* partHeatFluxName "convectiveHeatFlux"; //switch off for implicit coupling, e.g., to ParScale */ + partHeatTransCoeffName "heatTransCoeff"; + partHeatFluidName "heatFluid"; + lambda value; + Cp value1; + //Lists with information for each species FOR THE PARTICLES + //MUST be in the same order as eulerian species in 'scalarTransportProperties' + //MUST correspond to property/atom in ligghts (use 'couple/cfd/speciesConvection' to auto-generate individual fields) + partSpeciesNames + ( + speciesC + ); + partSpeciesFluxNames + ( + speciesCFlux + ); + partSpeciesTransCoeffNames + ( + speciesCTransCoeff + ); + partSpeciesFluidNames + ( + speciesCFluid + ); + DMolecular + ( + value2 + ); + interpolation "bool1"; + voidfractionInterpolationType "type1" + UInterpolationType "type2" + fluidScalarFieldInterpolationType "type2" + scalarViscosity switch5; + nu scalar5; + suppressProbe switch6; + scale scalar6; + maxSource scalar7; +\} :pre + + +{switch1} = (optional) flag to use Nusselt correlations of Li and Mason (2000) :ulb,l +{switch2} = (normally off) for verbose run :l +{switch3} = (optional) flag to use a general Nusselt number correlation (must specify parameters of this correlation in a list called 'generalCorrelationParameters' ) :l +generalCorrelationParameters = list with a predefined number of parameters (for length see src code, only read if useGeneralCorrelation is set to true) :l +{U} = name of the finite volume fluid velocity field :l +{voidfraction} = name of the finite volume voidfraction field :l +{T} = name of the finite volume scalar temperature field :l +{Temp} = name of the DEM data representing the particles temperature :l +{convectiveHeatFlux} = name of the DEM data representing the particle-fluid convective heat flux :l +{heatTransCoeff} = name of the DEM data representing the particle-fluid heat transfer coefficient :l +{heatFluid} = name of the DEM data representing the fluid heat :l +{value} = fluid thermal conductivity \[W/(m*K)\] :l +{value1} = fluid specific heat capacity \[W*s/(kg*K)\] :l +{speciesC} = name of the DEM data representing the transport species of the particles :l +{speciesCFlux} = name of the DEM data representing the particle-fluid species flux :l +{speciesCTransCoeff} = name of the DEM data representing the particle-fluid species transfer coefficient :l +{speciesCFluid} = name of the DEM data representing the transport species of the fluid :l +{value2} = molecular diffusion coefficient \[m^2/s\] :l +{bool1} = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values :l +{type1} = (optional, default cellPoint) interpolation type for voidfraction field :l +{type2} = (optional, default cellPointFace) interpolation type for velocity field :l +{type3} = (optional, default cellPoint) interpolation type for fluidScalarField field :l +{switch5} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{scalar5} = (optional) optional, only if switch5 is true :l +{switch6} = (optional, default false) can be used to suppress the output of the probe model :l +{scalar7} = (optional) scaling of particle diameter :l +{scalar7} = limit maximal turbulence :l +:ule + + +[Examples:] + +forceModels +( + scalarGeneralExchange // must be 2nd position! +); +scalarGeneralExchangeProps +\{ + useLiMason false; //default: DeenEtAl + useGeneralCorrelation true; //default: DeenEtAl + generalCorrelationParameters + ( + 7.0 -10 5 + 1.0 0.17 + 1.33 -2.31 1.16 + ); + verbose false; + velFieldName "U"; + voidfractionFieldName "voidfraction"; + tempFieldName "T"; + partTempName "Temp"; + /* partHeatFluxName "convectiveHeatFlux"; //switch off for implicit coupling, e.g., to ParScale */ + partHeatTransCoeffName "heatTransCoeff"; + partHeatFluidName "heatFluid"; + lambda 0.0271; + Cp 1007; + //Lists with information for each species FOR THE PARTICLES + //MUST be in the same order as eulerian species in 'scalarTransportProperties' + //MUST correspond to property/atom in ligghts (use 'couple/cfd/speciesConvection' to auto-generate individual fields) + partSpeciesNames + ( + speciesC + ); + partSpeciesFluxNames + ( + speciesCFlux + ); + partSpeciesTransCoeffNames + ( + speciesCTransCoeff + ); + partSpeciesFluidNames + ( + speciesCFluid + ); + DMolecular + ( + 1e-5 + ); +\} :pre + +[Description:] + +This "forceModel" does not influence the particles or the fluid flow! +Using the particles' temperature and/or species a scalar field +representing "particle-fluid heatflux" and/or "particle-fluid speciesflux" is calculated. + +This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS +and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER). + +Two way general scalar exchange between DEM and CFD +convective heat and species transfer model. The standard model is that of +Deen, N.G. et al., Review of direct numerical simulation of +fluid-particle mass, momentum and heat transfer in dense gas-solid flows. +Chemical Engineering Science 116 (2014) 710-724. +This correlation is based on that of Gunn (1978). + +The switch 'useGeneralCorrelation' allows one to specify the parameters +of the Gunn correlation as a list called 'generalCorrelationParameters'. + +Alternatively, the correclation of +Li and Mason (2000), A computational investigation of transient heat +transfer in pneumatic transport of granular particles, Pow.Tech 112 +can be activated. However, this correlation is not suitable for +dense granular flows. + +WARNING: +This model REQUIRES the 'generalManual' speciesTransportModel + +[Restrictions:] + +Goes only with cfdemSolverPimpleImEx and cfdemSolverPisoSTM. The force model has to be the second (!!!) model in the forces list. + +[Related commands:] + +"forceModel"_forceModel.html "forceModel_LaEuScalarTemp"_forceModel_LaEuScalarTemp.html + diff --git a/doc/forceModel_virtualMassForce.html b/doc/forceModel_virtualMassForce.html deleted file mode 100644 index 01a9957..0000000 --- a/doc/forceModel_virtualMassForce.html +++ /dev/null @@ -1,76 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_virtualMassForce command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    virtualMassForce
-);
-virtualMassForceProps
-{
-    velFieldName "U";
-    phiFieldName "phi";
-    splitUrelCalculation switch1;
-    Cadd scalar1;
-    treatForceExplicit switch2;
-    treatForceDEM switch3;
-    interpolation switch4;
-    UInterpolationType "type1"
-    DDtUInterpolationType "type2"
-}; 
-
-
  • U = name of the finite volume fluid velocity field - -
  • phi = name of the finite volume flux field - -
  • switch1 = indicator to split calculation of Urel between CFDEM and LIGGGHTS - -
  • scalar1 = scalar value - -
  • switch2 = (optional, default true) sub model switch, see forceSubModel for details - -
  • switch3 = (optional, default false) sub model switch, see forceSubModel for details - -
  • switch4 = (optional, default false) sub model switch, see forceSubModel for details - -
  • type1 = (optional, default cellPointFace) interpolation type for U field - -
  • type2 = (optional, default cellPointFace) interpolation type for ddt(U) field - - -
-

Examples: -

-
forceModels
-(
-    virtualMassForce
-);
-virtualMassForceProps
-{
-    velFieldName "U";
-} 
-
-

Description: -

-

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. -

-

Restrictions: -

-

Model not validated! -

-

Related commands: -

-

forceModel -

- diff --git a/doc/forceModel_virtualMassForce.txt b/doc/forceModel_virtualMassForce.txt new file mode 100644 index 0000000..15aff75 --- /dev/null +++ b/doc/forceModel_virtualMassForce.txt @@ -0,0 +1,64 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_virtualMassForce command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + virtualMassForce +); +virtualMassForceProps +\{ + velFieldName "U"; + phiFieldName "phi"; + splitUrelCalculation switch1; + Cadd scalar1; + treatForceExplicit switch2; + treatForceDEM switch3; + interpolation switch4; + UInterpolationType "type1" + DDtUInterpolationType "type2" +\}; :pre + +{U} = name of the finite volume fluid velocity field :ulb,l +{phi} = name of the finite volume flux field :l +{switch1} = indicator to split calculation of Urel between CFDEM and LIGGGHTS :l +{scalar1} = scalar value :l +{switch2} = (optional, default true) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch3} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch4} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{type1} = (optional, default cellPointFace) interpolation type for U field :l +{type2} = (optional, default cellPointFace) interpolation type for ddt(U) field :l +:ule + +[Examples:] + +forceModels +( + virtualMassForce +); +virtualMassForceProps +\{ + velFieldName "U"; +\} :pre + +[Description:] + +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. + +[Restrictions:] + +Model not validated! + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_viscForce.html b/doc/forceModel_viscForce.html deleted file mode 100644 index e9b8073..0000000 --- a/doc/forceModel_viscForce.html +++ /dev/null @@ -1,76 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_viscForce command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    viscForce;
-);
-viscForceProps
-{
-    velocityFieldName "U";
-    useAddedMass scalar1;
-    suppressProbe switch1;
-    treatForceExplicit switch2;
-    treatForceDEM switch3;
-    interpolation switch4;
-    divTauInterpolationType "type1";
-    scalarViscosity switch5;
-    nu scalar2;
-}; 
-
-
  • U = name of the finite volume fluid velocity field - -
  • scalar1 = (optional) coefficient of added mass accounted for - -
  • switch1 = (optional, default false) can be used to suppress the output of the probe model - -
  • switch2 = (optional, default true) sub model switch, see forceSubModel for details - -
  • switch3 = (optional, default false) sub model switch, see forceSubModel for details - -
  • switch4 = (optional, default false) sub model switch, see forceSubModel for details - -
  • type1 = (optional, default cellPointFace) interpolation type for div(Tau) field - -
  • switch5 = (optional, default false) sub model switch, see forceSubModel for details - -
  • scalar2 = optional, only if switch5 is true - - -
-

Examples: -

-
forceModels
-(
-    viscForce;
-);
-viscForceProps
-{
-    velocityFieldName "U";
-} 
-
-

Description: -

-

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). -

-

Restrictions: -

-

none. -

-

Related commands: -

-

forceModel -

- diff --git a/doc/forceModel_viscForce.txt b/doc/forceModel_viscForce.txt new file mode 100644 index 0000000..5a9c80a --- /dev/null +++ b/doc/forceModel_viscForce.txt @@ -0,0 +1,64 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_viscForce command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + viscForce; +); +viscForceProps +\{ + velocityFieldName "U"; + useAddedMass scalar1; + suppressProbe switch1; + treatForceExplicit switch2; + treatForceDEM switch3; + interpolation switch4; + divTauInterpolationType "type1"; + scalarViscosity switch5; + nu scalar2; +\}; :pre + +{U} = name of the finite volume fluid velocity field :ulb,l +{scalar1} = (optional) coefficient of added mass accounted for :l +{switch1} = (optional, default false) can be used to suppress the output of the probe model :l +{switch2} = (optional, default true) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch3} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch4} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{type1} = (optional, default cellPointFace) interpolation type for div(Tau) field :l +{switch5} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{scalar2} = optional, only if switch5 is true :l +:ule + +[Examples:] + +forceModels +( + viscForce; +); +viscForceProps +\{ + velocityFieldName "U"; +\} :pre + +[Description:] + +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). + +[Restrictions:] + +none. + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_volWeightedAverage.html b/doc/forceModel_volWeightedAverage.html deleted file mode 100644 index af38c37..0000000 --- a/doc/forceModel_volWeightedAverage.html +++ /dev/null @@ -1,93 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceModel_volWeightedAverage command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
forceModels
-(
-    volWeightedAverage
-);
-volWeightedAverageProps
-{
-    startTime time;
-    scalarFieldNames
-    (
-        scalarField
-    );
-    vectorFieldNames
-    (
-        vectorField
-    );
-    upperThreshold scalar1;
-    lowerThreshold scalar2;
-    useVolumeFraction switch0;
-    volumeFractionName word1;
-    verbose ;
-    writeToFile switch1;
-}; 
-
-
  • time = (optional, default 0.) time to start the averaging - -
  • scalarField = names of the finite volume scalar fields to be temporally averaged - -
  • vectorField = names of the finite volume vector fields to be temporally averaged - -
  • scalar1 = only cells with a field value (magnitude) lower than this upper threshold are considered - -
  • scalar2 = only cells with a field value (magnitude) greater than this lower threshold are considered - -
  • switch0 = (optional, default false) consider a volume fraction for the calculation - -
  • word1 = (optional, default "voidfraction") name of the volume fraction, only used if useVolumeFraction is true - -
  • verbose = (optional, default false) keyword only (mostly used for debugging) - -
  • switch1 = (optional, default false) switch for the output. - - -
-

Examples: -

-
forceModels
-(
-    volWeightedAverage
-);
-volWeightedAverageProps
-{
-    startTime 0.1;
-    scalarFieldNames
-    (
-        voidfraction
-    );
-    vectorFieldNames
-    (
-    );
-    upperThreshold 0.999;
-    lowerThreshold 0;
-} 
-
-

Description: -

-

This "forceModel" does not influence the particles or the simulation - it is a postprocessing tool! Starting at start time -the volume weighted averages of those cells of the fields within the threshold are calculated. -At "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. -

-

Restrictions: -

-

Currently all fields have the same threshold value! -

-

Related commands: -

-

forceModel -

- diff --git a/doc/forceModel_volWeightedAverage.txt b/doc/forceModel_volWeightedAverage.txt new file mode 100644 index 0000000..89bc531 --- /dev/null +++ b/doc/forceModel_volWeightedAverage.txt @@ -0,0 +1,81 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_volWeightedAverage command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + volWeightedAverage +); +volWeightedAverageProps +\{ + startTime time; + scalarFieldNames + ( + scalarField + ); + vectorFieldNames + ( + vectorField + ); + upperThreshold scalar1; + lowerThreshold scalar2; + useVolumeFraction switch0; + volumeFractionName word1; + verbose ; + writeToFile switch1; +\}; :pre + +{time} = (optional, default 0.) time to start the averaging :ulb,l +{scalarField} = names of the finite volume scalar fields to be temporally averaged :l +{vectorField} = names of the finite volume vector fields to be temporally averaged :l +{scalar1} = only cells with a field value (magnitude) lower than this upper threshold are considered :l +{scalar2} = only cells with a field value (magnitude) greater than this lower threshold are considered :l +{switch0} = (optional, default false) consider a volume fraction for the calculation :l +{word1} = (optional, default "voidfraction") name of the volume fraction, only used if useVolumeFraction is true :l +{verbose} = (optional, default false) keyword only (mostly used for debugging) :l +{switch1} = (optional, default false) switch for the output. :l +:ule + +[Examples:] + +forceModels +( + volWeightedAverage +); +volWeightedAverageProps +\{ + startTime 0.1; + scalarFieldNames + ( + voidfraction + ); + vectorFieldNames + ( + ); + upperThreshold 0.999; + lowerThreshold 0; +\} :pre + +[Description:] + +This "forceModel" does not influence the particles or the simulation - it is a postprocessing tool! Starting at start time +the volume weighted averages of those cells of the fields within the threshold are calculated. +At "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. + +[Restrictions:] + +Currently all fields have the same threshold value! + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceSubModel.html b/doc/forceSubModel.html deleted file mode 100644 index 6919095..0000000 --- a/doc/forceSubModel.html +++ /dev/null @@ -1,70 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceSubModel command -

-

Syntax: -

-

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. -

-
forceSubModels
-(
-    model_x
-    model_y
-); 
-
-
  • model = name of force sub-model to be applied -
-

Examples: -

-
forceSubModels
-(
-    ImEx
-); 
-
-

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

-

Description: -

-

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. -

-

Restrictions: -

-

None. -

-

Related commands: -

-

ImEx -

-

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

-

Default: none. -

-

Swtiches: -

-
  • Depending on the availability within the respective force model, a number of switches can be activated: -
  • treatForceExplicit: switch for the purely explicit consideration of the force term in the equation of motion on the CFD side (if switched off, the force is considered semi-implicitly) -
-
  • treatForceDEM: switch for the consideration of the forces on the DEM side only -
-
  • implForceDEM: 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 not within a coupling interval. -
-
  • verbose: switch for debug output to screen -
-
  • interpolation: 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. -
-
  • useFilteredDragModel: switch for using a coarse-grid version of the Beetstra drag model (takes grid-size effects into account; default = off) -
-
  • useParcelSizeDependentFilteredDrag: 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) -
-
  • implForceDEMaccumulated: 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. -
-
  • scalarViscosity: 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. -
- diff --git a/doc/forceSubModel.txt b/doc/forceSubModel.txt new file mode 100644 index 0000000..903e611 --- /dev/null +++ b/doc/forceSubModel.txt @@ -0,0 +1,58 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceSubModel command :h3 + +[Syntax:] + +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. + +forceSubModels +( + model_x + model_y +); :pre + +model = name of force sub-model to be applied :ul + +[Examples:] + +forceSubModels +( + ImEx +); :pre + +Note: This examples list might not be complete - please look for other models (forceSubModel_XY) in this documentation. + +[Description:] + +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. + +[Restrictions:] + +None. + +[Related commands:] + +"ImEx"_forceSubModel_ImEx.html + +Note: This examples list may be incomplete - please look for other models (forceSubModel_XY) in this documentation. + +[Default:] none. + +[Swtiches:] + +Depending on the availability within the respective force model, a number of switches can be activated: +treatForceExplicit: switch for the purely explicit consideration of the force term in the equation of motion on the CFD side (if switched off, the force is considered semi-implicitly) :ul +treatForceDEM: switch for the consideration of the forces on the DEM side only :ul +implForceDEM: 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 not within a coupling interval. :ul +verbose: switch for debug output to screen :ul +interpolation: 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. :ul +useFilteredDragModel: switch for using a coarse-grid version of the Beetstra drag model (takes grid-size effects into account; default = off) :ul +useParcelSizeDependentFilteredDrag: 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) :ul +implForceDEMaccumulated: 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. :ul +scalarViscosity: 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. :ul diff --git a/doc/forceSubModel_ImEx.html b/doc/forceSubModel_ImEx.html deleted file mode 100644 index 43b92d4..0000000 --- a/doc/forceSubModel_ImEx.html +++ /dev/null @@ -1,45 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

forceSubModel_ImEx command -

-

Syntax: -

-

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

-

forceSubModels -( - ImEx; -); -

-

treatExplicit true; // optional for some force models. -treatDEM true; // optional for some force models. -implDEM true; // optional for some force models. -

-

Examples: -

-

forceSubModels -( - ImEx; -); -treatExplicit true; // optional for some force models. -

-

Description: -

-

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. -

-

Restrictions: -

-

none. -

-

Related commands: -

-

forceSubModel -

- diff --git a/doc/forceSubModel_ImEx.txt b/doc/forceSubModel_ImEx.txt new file mode 100644 index 0000000..e81f55e --- /dev/null +++ b/doc/forceSubModel_ImEx.txt @@ -0,0 +1,42 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceSubModel_ImEx command :h3 + +[Syntax:] + +Defined in couplingProperties sub-dictionary of the force model in use. + +forceSubModels +( + ImEx; +); + +treatExplicit true; // optional for some force models. +treatDEM true; // optional for some force models. +implDEM true; // optional for some force models. + +[Examples:] + +forceSubModels +( + ImEx; +); +treatExplicit true; // optional for some force models. + +[Description:] + + 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. + +[Restrictions:] + +none. + +[Related commands:] + +"forceSubModel"_forceSubModel.html + diff --git a/doc/githubAccess_public.html b/doc/githubAccess_public.html deleted file mode 100644 index 8830fc4..0000000 --- a/doc/githubAccess_public.html +++ /dev/null @@ -1,284 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - - - - - - - - - - - - - - - -
- -

githubAccess_public -

-
- -

Description: -

-

This routine describes how to pull repositories of the CFDEM(R)project from github.com. -After setting some environment variables, LIGGGHTS(R) and CFDEM(R)coupling can be compiled. -

-

Procedure: -

-

Basically the following steps have to be performed: -

-
  • git clone and setup OpenFOAM - -
  • git clone the desired repositories - -
  • update your repositories by git pull - -
  • set environment variables - -
  • compile LIGGGHTS(R) and CFDEM(R)coupling - -
  • run your own cases - - -
-

git clone and setup OpenFOAM: -

-

Have a look at the latest compatible OpenFOAM(R)-version in the versionInfo.H file at github. -This file will later be downloaded as a part of the source-code. -Look for the git commit hashtag in the following line: -

-
word OFversion="<OF-Release>-commit-<commitHashtag>";  
-
-
e.g. word OFversion="2.4.x-commit-3d8da0e960c717ff582f1517a27724144f086b83"; 
-
-

However sometimes even newer versions are supported, please check the release notes and the "Advanced Settings"-section. -

-

Basically follow the OpenFOAM(R) git compilation instructions, with a small number of exceptions: -

-

When you git clone the repository, replace the release-version with <OF-Release>. -

-

with git-protocol: -

-
git clone git://github.com/OpenFOAM/OpenFOAM-<OF-Release>.git 
-
-

or with https: -

-
git clone https://github.com/OpenFOAM/OpenFOAM-<OF-Release>.git 
-
-

Now change into the new directory and checkout the correct compatible version: -

-
cd OpenFOAM-<OF-Release>
-git checkout <commitHashtag> 
-
-

The result will be a status report, that indicates a 'detached head state'. -Now continue with installing and compiling OpenFOAM(R). -Make sure that OpenFOAM(R) works properly with a parallel Simulation! -

-

If you want to use an older OpenFOAM(R)-version, please have a look at the "Backwards Compatibility"-section. -

-

git clone the desired repositories: -

-

You may want to take a look around on CFDEMproject on github: github.com/CFDEMproject_gitCFDEM -

-

If not already done, open a terminal and create a directory for LIGGGHTS(R) in $HOME: -

-
cd
-mkdir LIGGGHTS
-cd LIGGGHTS 
-
-

To clone the public LIGGGHTS repository, open a terminal and execute: -with git-protocol: -

-
git clone git://github.com/CFDEMproject/LIGGGHTS-PUBLIC.git LIGGGHTS-PUBLIC  
-
-

or with https: -

-
git clone https://github.com/CFDEMproject/LIGGGHTS-PUBLIC.git LIGGGHTS-PUBLIC    
-
-

If not already done, open a terminal and create a directory for CFDEM(R)coupling in $HOME: -

-
cd
-mkdir CFDEM
-cd CFDEM 
-
-

To clone the public CFDEM(R)coupling repository, open a terminal and execute: -with git-protocol: -

-
git clone git://github.com/CFDEMproject/CFDEMcoupling-PUBLIC.git CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION 
-
-

or with https: -

-
git clone https://github.com/CFDEMcoupling-PUBLIC.git CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION   
-
-
Additionally the lpp tool for converting LIGGGHTS dump-files into the paraview readable VTK-format might be of use:
-with git-protocol:
-git clone git://github.com:CFDEMproject/LPP.git $HOME/LIGGGHTS/mylpp 
-
-
or with https:
-git clone https://github.com:CFDEMproject/LPP.git $HOME/LIGGGHTS/mylpp 
-
-

Please have a look at README and INSTALL.txt in the root directory of LPP for further information. -

-

Troubles? See Troubleshooting git section below. -

-

Update your repositories by git pull: -

-

To get the latest version, open a terminal, go to the location of your local installation and type: -Warning: git stash will remove your changes in $HOME/CFDEM/CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION ! -

-
cd $HOME/CFDEM/CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION
-git stash
-git pull 
-
-

Set Environment Variables: -

-

Now you need to set some environment variables in ~/.bashrc (if you use c-shell, manipulate ~/.cshrc accordingly). Open ~/.bashrc -

-
gedit ~/.bashrc & 
-
-

add the lines (you find them also in CFDEMCoupling-$WM_PROJECT_VERSION/src/lagrangian/cfdemParticle/etc/bashrc and cshrc respectively): -

-
#================================================#
-#- source cfdem env vars
-export CFDEM_VERSION=PUBLIC
-export CFDEM_PROJECT_DIR=$HOME/CFDEM/CFDEMcoupling-$CFDEM_VERSION-$WM_PROJECT_VERSION
-export CFDEM_SRC_DIR=$CFDEM_PROJECT_DIR/src
-export CFDEM_SOLVER_DIR=$CFDEM_PROJECT_DIR/applications/solvers
-export CFDEM_DOC_DIR=$CFDEM_PROJECT_DIR/doc
-export CFDEM_UT_DIR=$CFDEM_PROJECT_DIR/applications/utilities
-export CFDEM_TUT_DIR=$CFDEM_PROJECT_DIR/tutorials
-export CFDEM_PROJECT_USER_DIR=$HOME/CFDEM/$LOGNAME-$CFDEM_VERSION-$WM_PROJECT_VERSION
-export CFDEM_bashrc=$CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/bashrc
-export CFDEM_LIGGGHTS_SRC_DIR=$HOME/LIGGGHTS/LIGGGHTS-PUBLIC/src
-export CFDEM_LIGGGHTS_MAKEFILE_NAME=fedora_fpic
-export CFDEM_LPP_DIR=$HOME/LIGGGHTS/mylpp/src
-export CFDEM_PIZZA_DIR=$HOME/LIGGGHTS/PIZZA/gran_pizza_17Aug10/src
-. $CFDEM_bashrc
-#================================================# 
-
-

If you installed LIGGGHTS(R) or CFDEM(R)coupling in non-standard paths, please have a look at least at CFDEM_PROJECT_DIR and CFDEM_LIGGGHTS_SRC_DIR. -The standard CFDEM_LIGGGHTS_MAKEFILE_NAME is fedora_fpic, which works on most systems. However please checkout LIGGGHTS-PUBLIC/src/MAKE for additional makefiles, wich are available. The most used ones are fedora_fpic and ubuntuVTK_fpic. Beware that the CFDEMcoupling needs a fpic compilation to use LIGGGHTS as a library. Please check the "Advanced Settings" for VTK information. -

-

Save the ~/.bashrc, open a new terminal and test the settings. The commands: -

-
$CFDEM_PROJECT_DIR
-$CFDEM_SRC_DIR
-$CFDEM_LIGGGHTS_SRC_DIR 
-
-

should give "...: is a directory" otherwise something went wrong and the environment variables in ~/.bashrc are not set correctly. -

-

To specify the paths of pizza, please check the settings in $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/bashrc. -

-

If $CFDEM_SRC_DIR is set correctly, you can type -

-
cfdemSysTest 
-
-

to get some information if the paths are set correctly. -

-

Compile LIGGGHTS(R) and CFDEM(R)coupling: -

-

If above settings were done correctly, you can compile LIGGGHTS(R) by typing: -

-
cfdemCompLIG 
-
-

and you can then compile CFDEM(R)coupling by typing: -

-
cfdemCompCFDEM 
-
-

or compile both at once with: -

-
cfdemCompCFDEMall 
-
-

You can run the tutorial cases by executing .../etc/testTutorial.sh through the alias cfdemTestTUT. -Alternatively you can run each tutorial using the Allrun.sh scripts in the tutorial directories. -

-

In case questions concerning the installation arise, please feel free to contact our forum at www.cfdem.com. -

-

Run Your Own Cases: -

-

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. -Changes in $CFDEM_TUT_DIR will be lost after every git stash! -

-

Additional Installations: -

-

Optionally you can install lpp which will help you convert the DEM (dump) data to VTK format. For standard CFD-DEM runs this will not be necessary. To get the DEM postprocessing tool "lpp" you need python-numpy package installed: -

-
sudo apt-get install python-numpy 
-
-

You can pull the latest version of lpp with: -

-
cd $HOME/LIGGGHTS 
-
-

with git-protocol: -git clone git://github.com/CFDEMproject/LPP.git -with https: -git clone https://github.com/CFDEMproject/LPP.git -

-

Backwards Compatibility: -

-

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

-

The supported OpenFOAM(R) and LIGGGHTS(R) versions are stated in: -src/lagrangian/cfdemParticle/cfdTools/versionInfo.H -

-

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

-

Advanced Settings: -

-

Here some advanced settings and hints for non-standard compilations are presented. -As stated in the "Backwards Compatibility"-section, there are compiler flags for different OpenFOAM versions. Checkout src/lagrangian/cfdemParticle/etc/OFversion/OFversion.H for compatibility settings. Just comment the current "#define version2X" in the top-section and uncomment the one you want to compile it with. -

-

There are advanced compilation settings for library-paths, includes and libraries are within the additionalLibs file in src/lagrangian/cfdemParticle/etc/additionalLibs. There are predefined files for different OpenFOAM versions. To use a different version, add the following lines to your .bashrc (.cshrc) before the standard CFDEM variables: -

-
export CFDEM_ADD_LIBS_DIR=FOLDER_OF_NEW_additionalLibs_FILE/ 
-
-
export CFDEM_ADD_LIBS_NAME=additionalLibs30x 
-
-

This is an example to use a predefined additionalLibs file for OpenFOAM-3.0.x. -

-

To enable direct VTK-dump (dump custom/vtk) support of LIGGGHTS and CFDEMcoupling, you have to install the VTK libraries. Either 5.8 or 6 are predefined for ubuntu. -

-
sudo apt-get libvtk5.8 libvtk5-dev 
-
-

Change "export CFDEM_LIGGGHTS_MAKEFILE_NAME=fedora_fpic" in your .bashrc according to your preferred LIGGGHTS makefile. -If you have a non-standard installation location you have to adapt the LIGGGHTS makefile accordingly. -To enable this feature in a coupled run the additionalLibs file has to be modified. -It basically needs to include the same libraries as the LIGGGHTS-Makefile. -E.g. for Ubuntu-14.04 with vtk-5.8: -

-
CFDEM_ADD_LIB_PATHS  = -L/usr/include/vtk-5.8 
-
-
CFDEM_ADD_LIBS       = -lvtkCommon -lvtkFiltering -lvtkIO 
-
-

Troubleshooting git: -

-
  • Troubles with git clone? - - -
-

a) The git protocol will not work if your computer is behind a firewall which blocks the relevant TCP port, you can use alternatively https instead of git (write command in one line): -

-

git clone https://github.com/CFDEMproject/CFDEMcoupling-PUBLIC.git CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION -

-

b) If you face the error: "error: SSL certificate problem, verify that the CA cert is OK. Details: error:14090086:SSL routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed while accessing https://github.com/...", -

-

please use: env GIT_SSL_NO_VERIFY=true git clone https://github... -

-

(see http://stackoverflow.com/questions/3777075/https-github-access) -

-

c) If you face the error: "Agent admitted failure to sign using the key. Permission denied (publickey).", after ssh -T git@github.com -

-

please type: "ssh-add" -

-

(see: https://help.github.com/articles/error-agent-admitted-failure-to-sign) -

- diff --git a/doc/githubAccess_public.pdf b/doc/githubAccess_public.pdf deleted file mode 100644 index ef8c364..0000000 Binary files a/doc/githubAccess_public.pdf and /dev/null differ diff --git a/doc/githubAccess_public.txt b/doc/githubAccess_public.txt new file mode 100644 index 0000000..f59dc94 --- /dev/null +++ b/doc/githubAccess_public.txt @@ -0,0 +1,263 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) +:link(github,http://github.com) +:link(gitHelp,http://help.github.com/linux-set-up-git) +:link(gitCFDEM,http://github.com/CFDEMproject) +:link(gitscm,http://git-scm.com/downloads) +:link(compOF,https://github.com/CFDEMproject/CFDEMcoupling-PUBLIC/blob/master/src/lagrangian/cfdemParticle/cfdTools/versionInfo.H) +:link(downOF,http://openfoam.org/download/git.php) +:link(relNotes,http://www.cfdem.com/node/414) + +:line +githubAccess_public :h3 +:line + +[Description:] + +This routine describes how to pull repositories of the CFDEM(R)project from "github.com"_github. +After setting some environment variables, LIGGGHTS(R) and CFDEM(R)coupling can be compiled. + +[Procedure:] + +Basically the following steps have to be performed: + +{git clone} and setup OpenFOAM :ulb,l +{git clone} the desired repositories :l +update your repositories by {git pull} :l +set environment variables :l +compile LIGGGHTS(R) and CFDEM(R)coupling :l +run your own cases :l +:ule + +[{git clone} and setup OpenFOAM:] + +Have a look at the latest compatible OpenFOAM(R)-version in the versionInfo.H file at "github"_compOF. +This file will later be downloaded as a part of the source-code. +Look for the git commit hashtag in the following line: + +word OFversion="<OF-Release>-commit-<commitHashtag>"; :pre +e.g. word OFversion="2.4.x-commit-3d8da0e960c717ff582f1517a27724144f086b83"; :pre + +However sometimes even newer versions are supported, please check the "release notes"_relNotes and the "Advanced Settings"-section. + +Basically follow the OpenFOAM(R) git compilation "instructions"_downOF, with a small number of exceptions: + +When you git clone the repository, replace the release-version with <OF-Release>. + +with git-protocol: + +git clone git://github.com/OpenFOAM/OpenFOAM-<OF-Release>.git :pre + +or with https: + +git clone https://github.com/OpenFOAM/OpenFOAM-<OF-Release>.git :pre + +Now change into the new directory and checkout the correct compatible version: + +cd OpenFOAM-<OF-Release> +git checkout <commitHashtag> :pre + +The result will be a status report, that indicates a 'detached head state'. +Now continue with installing and compiling OpenFOAM(R). +Make sure that OpenFOAM(R) works properly with a parallel Simulation! + +If you want to use an older OpenFOAM(R)-version, please have a look at the "Backwards Compatibility"-section. + + +[{git clone} the desired repositories:] + +You may want to take a look around on CFDEMproject on github: github.com/CFDEMproject_gitCFDEM + +If not already done, open a terminal and create a directory for LIGGGHTS(R) in $HOME: + +cd +mkdir LIGGGHTS +cd LIGGGHTS :pre + +To clone the public LIGGGHTS repository, open a terminal and execute: +with git-protocol: + +git clone git://github.com/CFDEMproject/LIGGGHTS-PUBLIC.git LIGGGHTS-PUBLIC :pre + +or with https: + +git clone https://github.com/CFDEMproject/LIGGGHTS-PUBLIC.git LIGGGHTS-PUBLIC :pre + +If not already done, open a terminal and create a directory for CFDEM(R)coupling in $HOME: + +cd +mkdir CFDEM +cd CFDEM :pre + +To clone the public CFDEM(R)coupling repository, open a terminal and execute: +with git-protocol: + +git clone git://github.com/CFDEMproject/CFDEMcoupling-PUBLIC.git CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION :pre + +or with https: + +git clone https://github.com/CFDEMcoupling-PUBLIC.git CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION :pre + +Additionally the lpp tool for converting LIGGGHTS dump-files into the paraview readable VTK-format might be of use: +with git-protocol: +git clone git://github.com:CFDEMproject/LPP.git $HOME/LIGGGHTS/mylpp :pre +or with https: +git clone https://github.com:CFDEMproject/LPP.git $HOME/LIGGGHTS/mylpp :pre +Please have a look at README and INSTALL.txt in the root directory of LPP for further information. + +Troubles? See Troubleshooting git section below. + +[Update your repositories by {git pull}:] + +To get the latest version, open a terminal, go to the location of your local installation and type: +{Warning: git stash will remove your changes in $HOME/CFDEM/CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION !} + +cd $HOME/CFDEM/CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION +git stash +git pull :pre + +[Set Environment Variables:] + +Now you need to set some environment variables in ~/.bashrc (if you use c-shell, manipulate ~/.cshrc accordingly). Open ~/.bashrc + +gedit ~/.bashrc & :pre + +add the lines (you find them also in CFDEMCoupling-$WM_PROJECT_VERSION/src/lagrangian/cfdemParticle/etc/bashrc and cshrc respectively): + +#================================================# +#- source cfdem env vars +export CFDEM_VERSION=PUBLIC +export CFDEM_PROJECT_DIR=$HOME/CFDEM/CFDEMcoupling-$CFDEM_VERSION-$WM_PROJECT_VERSION +export CFDEM_SRC_DIR=$CFDEM_PROJECT_DIR/src +export CFDEM_SOLVER_DIR=$CFDEM_PROJECT_DIR/applications/solvers +export CFDEM_DOC_DIR=$CFDEM_PROJECT_DIR/doc +export CFDEM_UT_DIR=$CFDEM_PROJECT_DIR/applications/utilities +export CFDEM_TUT_DIR=$CFDEM_PROJECT_DIR/tutorials +export CFDEM_PROJECT_USER_DIR=$HOME/CFDEM/$LOGNAME-$CFDEM_VERSION-$WM_PROJECT_VERSION +export CFDEM_bashrc=$CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/bashrc +export CFDEM_LIGGGHTS_SRC_DIR=$HOME/LIGGGHTS/LIGGGHTS-PUBLIC/src +export CFDEM_LIGGGHTS_MAKEFILE_NAME=fedora_fpic +export CFDEM_LPP_DIR=$HOME/LIGGGHTS/mylpp/src +export CFDEM_PIZZA_DIR=$HOME/LIGGGHTS/PIZZA/gran_pizza_17Aug10/src +. $CFDEM_bashrc +#================================================# :pre + +If you installed LIGGGHTS(R) or CFDEM(R)coupling in non-standard paths, please have a look at least at CFDEM_PROJECT_DIR and CFDEM_LIGGGHTS_SRC_DIR. +The standard CFDEM_LIGGGHTS_MAKEFILE_NAME is fedora_fpic, which works on most systems. However please checkout LIGGGHTS-PUBLIC/src/MAKE for additional makefiles, wich are available. The most used ones are fedora_fpic and ubuntuVTK_fpic. Beware that the CFDEMcoupling needs a fpic compilation to use LIGGGHTS as a library. Please check the "Advanced Settings" for VTK information. + +Save the ~/.bashrc, open a new terminal and test the settings. The commands: + +$CFDEM_PROJECT_DIR +$CFDEM_SRC_DIR +$CFDEM_LIGGGHTS_SRC_DIR :pre + +should give "...: is a directory" otherwise something went wrong and the environment variables in ~/.bashrc are not set correctly. + +To specify the paths of pizza, please check the settings in $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/bashrc. + +If $CFDEM_SRC_DIR is set correctly, you can type + +cfdemSysTest :pre + +to get some information if the paths are set correctly. + +[Compile LIGGGHTS(R) and CFDEM(R)coupling:] + +If above settings were done correctly, you can compile LIGGGHTS(R) by typing: + +cfdemCompLIG :pre + +and you can then compile CFDEM(R)coupling by typing: + +cfdemCompCFDEM :pre + +or compile both at once with: + +cfdemCompCFDEMall :pre + +You can run the tutorial cases by executing .../etc/testTutorial.sh through the alias {cfdemTestTUT}. +Alternatively you can run each tutorial using the {Allrun.sh} scripts in the tutorial directories. + +In case questions concerning the installation arise, please feel free to contact our forum at www.cfdem.com. + +[Run Your Own Cases:] + +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. +Changes in $CFDEM_TUT_DIR will be lost after every {git stash}! + +[Additional Installations:] + +Optionally you can install lpp which will help you convert the DEM (dump) data to VTK format. For standard CFD-DEM runs this will not be necessary. To get the DEM postprocessing tool "lpp" you need python-numpy package installed: + +sudo apt-get install python-numpy :pre + +You can pull the latest version of lpp with: + +cd $HOME/LIGGGHTS :pre + +with git-protocol: +git clone git://github.com/CFDEMproject/LPP.git +with https: +git clone https://github.com/CFDEMproject/LPP.git + +[Backwards Compatibility:] + +Basically CFDEM(R)coupling supports one OpenFOAM(R) version therefore all settings are prepared for that. Nevertheless we try to maintain backwards compatibility as long as it works with reasonable effort. + +The supported OpenFOAM(R) and LIGGGHTS(R) versions are stated in: +src/lagrangian/cfdemParticle/cfdTools/versionInfo.H + +For using other versions you can manipulate: +src/lagrangian/cfdemParticle/etc/OFversion/OFversion.H +(still not all functionality might work then!) + +[Advanced Settings:] + +Here some advanced settings and hints for non-standard compilations are presented. +As stated in the "Backwards Compatibility"-section, there are compiler flags for different OpenFOAM versions. Checkout src/lagrangian/cfdemParticle/etc/OFversion/OFversion.H for compatibility settings. Just comment the current "#define version2X" in the top-section and uncomment the one you want to compile it with. + +There are advanced compilation settings for library-paths, includes and libraries are within the additionalLibs file in src/lagrangian/cfdemParticle/etc/additionalLibs. There are predefined files for different OpenFOAM versions. To use a different version, add the following lines to your .bashrc (.cshrc) before the standard CFDEM variables: + +export CFDEM_ADD_LIBS_DIR=FOLDER_OF_NEW_additionalLibs_FILE/ :pre + +export CFDEM_ADD_LIBS_NAME=additionalLibs30x :pre + +This is an example to use a predefined additionalLibs file for OpenFOAM-3.0.x. + +To enable direct VTK-dump (dump custom/vtk) support of LIGGGHTS and CFDEMcoupling, you have to install the VTK libraries. Either 5.8 or 6 are predefined for ubuntu. + +sudo apt-get libvtk5.8 libvtk5-dev :pre + +Change "export CFDEM_LIGGGHTS_MAKEFILE_NAME=fedora_fpic" in your .bashrc according to your preferred LIGGGHTS makefile. +If you have a non-standard installation location you have to adapt the LIGGGHTS makefile accordingly. +To enable this feature in a coupled run the additionalLibs file has to be modified. +It basically needs to include the same libraries as the LIGGGHTS-Makefile. +E.g. for Ubuntu-14.04 with vtk-5.8: + +CFDEM_ADD_LIB_PATHS = -L/usr/include/vtk-5.8 :pre + +CFDEM_ADD_LIBS = -lvtkCommon -lvtkFiltering -lvtkIO :pre + +[Troubleshooting git:] + +Troubles with git clone? :ulb,l +:ule + +[a)] The git protocol will not work if your computer is behind a firewall which blocks the relevant TCP port, you can use alternatively https instead of git (write command in one line): + +git clone https://github.com/CFDEMproject/CFDEMcoupling-PUBLIC.git CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION + +[b)] If you face the error: "error: SSL certificate problem, verify that the CA cert is OK. Details: error:14090086:SSL routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed while accessing https://github.com/...", + +please use: env GIT_SSL_NO_VERIFY=true git clone https://github... + +(see http://stackoverflow.com/questions/3777075/https-github-access) + + +[c)] If you face the error: "Agent admitted failure to sign using the key. Permission denied (publickey).", after ssh -T git@github.com + +please type: "ssh-add" + +(see: https://help.github.com/articles/error-agent-admitted-failure-to-sign) diff --git a/doc/liggghtsCommandModel.html b/doc/liggghtsCommandModel.html deleted file mode 100644 index 2c0ca7e..0000000 --- a/doc/liggghtsCommandModel.html +++ /dev/null @@ -1,44 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

liggghtsCommandModel command -

-

Syntax: -

-

Defined in liggghtsCommmands dictionary. -

-
liggghtsCommandModels
-(
-    model_x
-    model_y
-); 
-
-
  • model = name of the liggghtsCommandModel to be applied -
-

Examples: -

-
liggghtsCommandModels
-(
-   runLiggghts
-   writeLiggghts
-); 
-
-

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

-

Description: -

-

The liggghtsCommandModel is the base class to execute DEM commands within a CFD run. -

-

Restrictions: -

-

Works only with MPI coupling. -

-

Default: none. -

- diff --git a/doc/liggghtsCommandModel.txt b/doc/liggghtsCommandModel.txt new file mode 100644 index 0000000..37fbe26 --- /dev/null +++ b/doc/liggghtsCommandModel.txt @@ -0,0 +1,40 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +liggghtsCommandModel command :h3 + +[Syntax:] + +Defined in liggghtsCommmands dictionary. + +liggghtsCommandModels +( + model_x + model_y +); :pre + +model = name of the liggghtsCommandModel to be applied :ul + +[Examples:] + +liggghtsCommandModels +( + runLiggghts + writeLiggghts +); :pre + +Note: This examples list might not be complete - please look for other models (liggghtsCommandModel_XY) in this documentation. + +[Description:] + +The liggghtsCommandModel is the base class to execute DEM commands within a CFD run. + +[Restrictions:] + +Works only with MPI coupling. + +[Default:] none. diff --git a/doc/liggghtsCommandModel_execute.html b/doc/liggghtsCommandModel_execute.html deleted file mode 100644 index 58909fe..0000000 --- a/doc/liggghtsCommandModel_execute.html +++ /dev/null @@ -1,97 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

liggghtsCommandModel_execute command -

-

Syntax: -

-

Defined in liggghtsCommmands dictionary. -

-
liggghtsCommandModels
-(
-   execute
-);
-executeProps0
-{
-    command
-    (
-        run
-        $couplingInterval
-    );
-    runFirst switch1; 
-    runLast switch2;
-    runEveryCouplingStep switch3;
-    runEveryWriteStep switch4;
-    verbose;
-} 
-
-
  • 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) - -
  • switch1 = switch (choose on/off) if the command is executed only at first time step - -
  • switch2 = switch (choose on/off) if the command is executed only at last time step - -
  • switch3 = switch (choose on/off) if the command is executed at every coupling step - -
  • switch4 = switch (choose on/off) if the command is executed at every writing step - -
  • verbose = (normally off) for verbose run - - -
-

Examples: -

-
liggghtsCommandModels
-(
-   execute
-   execute
-);
-executeProps0
-{
-    command
-    (
-        run
-        $couplingInterval
-    );
-    runFirst off;
-    runLast off;
-    runEveryCouplingStep on;
-}
-executeProps1
-{
-    command
-    (
-        write_restart
-        noBlanks
-        dotdot
-        slash
-        DEM
-        slash
-        liggghts.restart_
-        timeStamp
-    );
-    runFirst off;
-    runLast off;
-    runEveryCouplingStep off;
-    runEveryWriteStep on;
-} 
-
-

Description: -

-

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. -

-

These rather complex execute commands can be replaced by the "readLiggghts" and "writeLiggghts" commands! -

-

Restrictions: None. -

-

Related commands: -

-

liggghtsCommandModel -

- diff --git a/doc/liggghtsCommandModel_execute.txt b/doc/liggghtsCommandModel_execute.txt new file mode 100644 index 0000000..5db5f2a --- /dev/null +++ b/doc/liggghtsCommandModel_execute.txt @@ -0,0 +1,88 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +liggghtsCommandModel_execute command :h3 + +[Syntax:] + +Defined in liggghtsCommmands dictionary. + +liggghtsCommandModels +( + execute +); +executeProps0 +\{ + command + ( + run + $couplingInterval + ); + runFirst switch1; + runLast switch2; + runEveryCouplingStep switch3; + runEveryWriteStep switch4; + verbose; +\} :pre + +{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) :ulb,l +{switch1} = switch (choose on/off) if the command is executed only at first time step :l +{switch2} = switch (choose on/off) if the command is executed only at last time step :l +{switch3} = switch (choose on/off) if the command is executed at every coupling step :l +{switch4} = switch (choose on/off) if the command is executed at every writing step :l +{verbose} = (normally off) for verbose run :l +:ule + +[Examples:] + +liggghtsCommandModels +( + execute + execute +); +executeProps0 +\{ + command + ( + run + $couplingInterval + ); + runFirst off; + runLast off; + runEveryCouplingStep on; +\} +executeProps1 +\{ + command + ( + write_restart + noBlanks + dotdot + slash + DEM + slash + liggghts.restart_ + timeStamp + ); + runFirst off; + runLast off; + runEveryCouplingStep off; + runEveryWriteStep on; +\} :pre + +[Description:] + +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. + +These rather complex execute commands can be replaced by the "readLiggghts" and "writeLiggghts" commands! :h4 + +[Restrictions:] None. + +[Related commands:] + +"liggghtsCommandModel"_liggghtsCommandModel.html + diff --git a/doc/liggghtsCommandModel_readLiggghtsData.html b/doc/liggghtsCommandModel_readLiggghtsData.html deleted file mode 100644 index bdd117c..0000000 --- a/doc/liggghtsCommandModel_readLiggghtsData.html +++ /dev/null @@ -1,93 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

liggghtsCommandModel_readLiggghtsData command -

-

Syntax: -

-

Defined in liggghtsCommmands dictionary. -

-
liggghtsCommandModels
-(
-   readLiggghtsData
-);
-readLiggghtsDataProps0
-{
-    startIndex "scalar1";
-    verbose ;
-    exactTiming ;
-    filePath 
-    (
-        "word"
-    );
-    runFirst "bool1";
-    runEveryCouplingStep "bool2";
-    startTime "scalar2";
-    endTime "scalar3";
-    timeInterval "scalar4";
-} 
-
-
  • scalar1 = start index of data file to be read - -
  • verbose = (default off) flag for verbose run - -
  • exactTiming = flag indicating that start time should be kept even during a coupling interval - -
  • 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) - -
  • bool1 = true if to be run at first timestep only (prio 1) - -
  • bool2 = true if to be run at every coupling step (prio 2) - -
  • scalar2 = if bool2 and bool3 false then starts at scalar2 (prio 3) run - -
  • scalar3 = if bool2 and bool3 false then it ends at scalar3 (prio 3) run - -
  • scalar4 = if bool2 and bool3 false then it repeats at scalar3 increasing the data file index (prio 3) run - - -
-

Examples: -

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

Description: -

-

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

-

Restrictions: -

-

Note: Model is not up to date. -

-

Related commands: -

-

liggghtsCommandModel -

- diff --git a/doc/liggghtsCommandModel_readLiggghtsData.txt b/doc/liggghtsCommandModel_readLiggghtsData.txt new file mode 100644 index 0000000..e9bc050 --- /dev/null +++ b/doc/liggghtsCommandModel_readLiggghtsData.txt @@ -0,0 +1,82 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +liggghtsCommandModel_readLiggghtsData command :h3 + +[Syntax:] + +Defined in liggghtsCommmands dictionary. + +liggghtsCommandModels +( + readLiggghtsData +); +readLiggghtsDataProps0 +\{ + startIndex "scalar1"; + verbose ; + exactTiming ; + filePath + ( + "word" + ); + runFirst "bool1"; + runEveryCouplingStep "bool2"; + startTime "scalar2"; + endTime "scalar3"; + timeInterval "scalar4"; +\} :pre + +{scalar1} = start index of data file to be read :ulb,l +{verbose} = (default off) flag for verbose run :l +{exactTiming} = flag indicating that start time should be kept even during a coupling interval :l +{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) :l +{bool1} = true if to be run at first timestep only (prio 1) :l +{bool2} = true if to be run at every coupling step (prio 2) :l +{scalar2} = if bool2 and bool3 false then starts at scalar2 (prio 3) run :l +{scalar3} = if bool2 and bool3 false then it ends at scalar3 (prio 3) run :l +{scalar4} = if bool2 and bool3 false then it repeats at scalar3 increasing the data file index (prio 3) run :l +:ule + +[Examples:] + +liggghtsCommandModels +( + readLiggghtsData +); +readLiggghtsDataProps0 +\{ + startIndex 0; + exactTiming true; + filePath + ( + dotdot + slash + DEM + slash + packing.data + ); + runFirst off; + runEveryCouplingStep off; + startTime 0.002; + endTime 0.012; + timeInterval 0.001; +\} :pre + +[Description:] + +The readLiggghtsData liggghtsCommand Model can be used to read liggghts data files into liggghts during runtime of a coupled simulation. + + +[Restrictions:] + +Note: Model is not up to date. + +[Related commands:] + +"liggghtsCommandModel"_liggghtsCommandModel.html + diff --git a/doc/liggghtsCommandModel_runLiggghts.html b/doc/liggghtsCommandModel_runLiggghts.html deleted file mode 100644 index b9ad886..0000000 --- a/doc/liggghtsCommandModel_runLiggghts.html +++ /dev/null @@ -1,44 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

liggghtsCommandModel_runLiggghts command -

-

Syntax: -

-

Defined in liggghtsCommmands dictionary. -

-
liggghtsCommandModels
-(
-   runLiggghts
-);
-//- optional
-runLiggghtsProps
-{
-    preNo true;
-    verbose; (optional)
-} 
-
-

Examples: -

-
liggghtsCommandModels
-(
-   runLiggghts
-); 
-
-

Description: -

-

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. -

-

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

-

Related commands: -

-

liggghtsCommandModel -

- diff --git a/doc/liggghtsCommandModel_runLiggghts.txt b/doc/liggghtsCommandModel_runLiggghts.txt new file mode 100644 index 0000000..a1f0ef4 --- /dev/null +++ b/doc/liggghtsCommandModel_runLiggghts.txt @@ -0,0 +1,41 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +liggghtsCommandModel_runLiggghts command :h3 + +[Syntax:] + +Defined in liggghtsCommmands dictionary. + +liggghtsCommandModels +( + runLiggghts +); +//- optional +runLiggghtsProps +\{ + preNo true; + verbose; (optional) +\} :pre + +[Examples:] + +liggghtsCommandModels +( + runLiggghts +); :pre + +[Description:] + +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. + +[Restrictions:] Warning: the "pre no" option can cause troubles (dump data of particles changing the domain might be erroneous)! + +[Related commands:] + +"liggghtsCommandModel"_liggghtsCommandModel.html + diff --git a/doc/liggghtsCommandModel_setDEMGravity.txt b/doc/liggghtsCommandModel_setDEMGravity.txt new file mode 100644 index 0000000..35b07d0 --- /dev/null +++ b/doc/liggghtsCommandModel_setDEMGravity.txt @@ -0,0 +1,60 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +liggghtsCommandModel_setDEMGravity command :h3 + +[Syntax:] + +Defined in liggghtsCommmands dictionary. + +liggghtsCommandModels +( + setDEMGravity +); + +setDEMGravityProps0 +\{ + runFirst switch1; + startTime scalar1; + endTime scalar2; + timeInterval scalar3; + verbose; +\} :pre + +{switch1} = switch (must be on!!!) to select if executed only first step. :ulb,l +{scalar1} = start time of command (use simulation start time) :l +{scalar2} = end time of command (use simulation start time) :l +{scalar3} = time interval of command (use 1.):l +{verbose} = (normally off) for verbose run :l +:ule + +[Examples:] + +liggghtsCommandModels +( + runLiggghts + setDEMGravity +); +setDEMGravityProps1 +\{ + runFirst on; + startTime 0; + endTime 0; + timeInterval 1; + verbose; +\} :pre + +[Description:] + +The liggghtsCommand models can be used to set LIGGGHTS gravity during a CFD run. + +[Restrictions:] None. + +[Related commands:] + +"liggghtsCommandModel"_liggghtsCommandModel.html + diff --git a/doc/liggghtsCommandModel_writeLiggghts.html b/doc/liggghtsCommandModel_writeLiggghts.html deleted file mode 100644 index 8b6b55b..0000000 --- a/doc/liggghtsCommandModel_writeLiggghts.html +++ /dev/null @@ -1,59 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

liggghtsCommandModel_writeLiggghts command -

-

Syntax: -

-

Defined in liggghtsCommmands dictionary. -

-
liggghtsCommandModels
-(
-   writeLiggghts
-);
-//- optional
-writeLiggghtsProps
-{
-    writeLast switch1;
-    path "path";
-    writeName "name";
-    overwrite switch2;
-    verbose;
-} 
-
-
  • switch1 = switch (choose on/off) to select if only last step is stored or every write step (default on). - -
  • path = optionally an alternative path (relative to execution directory) for saving the restart file can be defined (default "../DEM"). - -
  • name = name of the restart file to be written in /$caseDir/DEM/ default (default "liggghts.restartCFDEM") - -
  • switch2 = switch (choose on/off) to select if only one restart file $name or many files $name_$timeStamp are written (default off):l -verbose = (default off) for verbose run - - -
-

Examples: -

-
liggghtsCommandModels
-(
-   runLiggghts
-   writeLiggghts
-); 
-
-

Description: -

-

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. -

-

Restrictions: None. -

-

Related commands: -

-

liggghtsCommandModel -

- diff --git a/doc/liggghtsCommandModel_writeLiggghts.txt b/doc/liggghtsCommandModel_writeLiggghts.txt new file mode 100644 index 0000000..2ca1a31 --- /dev/null +++ b/doc/liggghtsCommandModel_writeLiggghts.txt @@ -0,0 +1,52 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +liggghtsCommandModel_writeLiggghts command :h3 + +[Syntax:] + +Defined in liggghtsCommmands dictionary. + +liggghtsCommandModels +( + writeLiggghts +); +//- optional +writeLiggghtsProps +\{ + writeLast switch1; + path "path"; + writeName "name"; + overwrite switch2; + verbose; +\} :pre + +{switch1} = switch (choose on/off) to select if only last step is stored or every write step (default on). :ulb,l +{path} = optionally an alternative path (relative to execution directory) for saving the restart file can be defined (default "../DEM"). :l +{name} = name of the restart file to be written in /$caseDir/DEM/ default (default "liggghts.restartCFDEM") :l +{switch2} = switch (choose on/off) to select if only one restart file $name or many files $name_$timeStamp are written (default off):l +{verbose} = (default off) for verbose run :l +:ule + +[Examples:] + +liggghtsCommandModels +( + runLiggghts + writeLiggghts +); :pre + +[Description:] + +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. + +[Restrictions:] None. + +[Related commands:] + +"liggghtsCommandModel"_liggghtsCommandModel.html + diff --git a/doc/locateModel.html b/doc/locateModel.html deleted file mode 100644 index 58c59a0..0000000 --- a/doc/locateModel.html +++ /dev/null @@ -1,34 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

locateModel command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
locateModel model; 
-
-
  • model = name of the locateModel to be applied -
-

Examples: -

-
locateModel engine; 
-
-

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

-

Description: -

-

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. -

-

Restrictions: none. -

-

Default: none. -

- diff --git a/doc/locateModel.txt b/doc/locateModel.txt new file mode 100644 index 0000000..b18b9e4 --- /dev/null +++ b/doc/locateModel.txt @@ -0,0 +1,30 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +locateModel command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +locateModel model; :pre + +model = name of the locateModel to be applied :ul + +[Examples:] + +locateModel engine; :pre + +Note: This examples list might not be complete - please look for other models (locateModel_XY) in this documentation. + +[Description:] + +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. + +[Restrictions:] none. + +[Default:] none. diff --git a/doc/locateModel_engineSearch.html b/doc/locateModel_engineSearch.html deleted file mode 100644 index c68e36f..0000000 --- a/doc/locateModel_engineSearch.html +++ /dev/null @@ -1,51 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

locateModel_engineSearch command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
locateModel engine;
-engineProps
-{
-    treeSearch switch1;
-} 
-
-
  • switch1 = switch to use tree search algorithm - - -
-

Examples: -

-
locateModel engine;
-engineProps
-{
-    treeSearch true;
-} 
-
-

Description: -

-

The locateModel "engine" locates the CFD cell and cellID corresponding to a given position. -The engineSearch locate Model can be used with different settings to use different algorithms: -

-
  • treeSearch false; will execute some geometric (linear) search using the last known cellID - -
  • treeSearch true; will use a recursive tree structure to find the cell (recommended). - - -
-

Restrictions: none. -

-

Related commands: -

-

locateModel -

- diff --git a/doc/locateModel_engineSearch.txt b/doc/locateModel_engineSearch.txt new file mode 100644 index 0000000..eac8009 --- /dev/null +++ b/doc/locateModel_engineSearch.txt @@ -0,0 +1,45 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +locateModel_engineSearch command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +locateModel engine; +engineProps +\{ + treeSearch switch1; +\} :pre + +{switch1} = (optional, default true) switch to use tree search algorithm :ulb,l +:ule + +[Examples:] + +locateModel engine; +engineProps +\{ + treeSearch true; +\} :pre + +[Description:] + +The locateModel "engine" locates the CFD cell and cellID corresponding to a given position. +The engineSearch locate model can be used with different settings to use different algorithms: + +treeSearch false; will execute some geometric (linear) search using the last known cellID :ulb,l +treeSearch true; will use a recursive tree structure to find the cell (recommended). :l +:ule + +[Restrictions:] none. + +[Related commands:] + +"locateModel"_locateModel.html + diff --git a/doc/locateModel_engineSearchIB.html b/doc/locateModel_engineSearchIB.html deleted file mode 100644 index 6d5c6b7..0000000 --- a/doc/locateModel_engineSearchIB.html +++ /dev/null @@ -1,73 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

locateModel_engineSearchIB command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
locateModel engineIB;
-engineIBProps
-{
-    engineProps
-    {
-        treeSearch switch1;
-    }
-    zSplit value1;
-    xySplit value2;
-    checkPeriodicCells;
-}  
-
-
  • switch1 = names of the finite volume scalar fields to be temporally averaged - -
  • value1 = number of z-normal layers for satellite points - -
  • value2 = number of satellite points in each layer - -
  • checkPeriodicCells = (optional, default false) flag for considering the minimal distance to all periodic images of this particle - - -
-

Examples: -

-
locateModel engineIB;
-engineIBProps
-{
-    engineProps
-    {
-        treeSearch false;
-    }
-    zSplit 8;
-    xySplit 16;
-} 
-
-

Description: -

-

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. -

-

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

-
  • treeSearch false; will execute some geometric (linear) search using the last known cellID (recommended) - -
  • treeSearch true; will use a recursive tree structure to find the cell. - - -
-

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. -

-

Restrictions: -

-

Only for immersed boundary solvers! -

-

Related commands: -

-

locateModel -

- diff --git a/doc/locateModel_engineSearchIB.txt b/doc/locateModel_engineSearchIB.txt new file mode 100644 index 0000000..ac9d986 --- /dev/null +++ b/doc/locateModel_engineSearchIB.txt @@ -0,0 +1,58 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +locateModel_engineSearchIB command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +locateModel engineIB; +engineIBProps +\{ + treeSearch switch1; + zSplit value1; + xySplit value2; + checkPeriodicCells; +\} :pre + +{switch1} = names of the finite volume scalar fields to be temporally averaged :ulb,l +{value1} = number of z-normal layers for satellite points :l +{value2} = number of satellite points in each layer :l +{checkPeriodicCells} = (optional, default false) flag for considering the minimal distance to all periodic images of this particle :l +:ule + +[Examples:] + +locateModel engineIB; +engineIBProps +\{ + treeSearch false; + zSplit 8; + xySplit 16; +\} :pre + +[Description:] + +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. + +The engineSearchIB locate Model can be used with different settings to use different algorithms: + +treeSearch false; will execute some geometric (linear) search using the last known cellID (recommended) :ulb,l +treeSearch true; will use a recursive tree structure to find the cell. :l +:ule + +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. + +[Restrictions:] + +Only for immersed boundary solvers! + +[Related commands:] + +"locateModel"_locateModel.html + diff --git a/doc/locateModel_standardSearch.html b/doc/locateModel_standardSearch.html deleted file mode 100644 index d5e37a0..0000000 --- a/doc/locateModel_standardSearch.html +++ /dev/null @@ -1,32 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

locateModel_standardSearch command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
locateModel standard;  
-
-

Examples: -

-
locateModel standard; 
-
-

Description: -

-

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

-

Restrictions: none. -

-

Related commands: -

-

locateModel -

- diff --git a/doc/locateModel_standardSearch.txt b/doc/locateModel_standardSearch.txt new file mode 100644 index 0000000..84fb1db --- /dev/null +++ b/doc/locateModel_standardSearch.txt @@ -0,0 +1,30 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +locateModel_standardSearch command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +locateModel standard; :pre + +[Examples:] + +locateModel standard; :pre + +[Description:] + +The locateModel "standard" locates the CFD cell and cellID corresponding to a given position. A very straight-forward (robust!) locate algorithm is used. + + +[Restrictions:] none. + +[Related commands:] + +"locateModel"_locateModel.html + diff --git a/doc/meshMotionModel.html b/doc/meshMotionModel.html deleted file mode 100644 index c056b6b..0000000 --- a/doc/meshMotionModel.html +++ /dev/null @@ -1,34 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

meshMotionModel command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
meshMotionModel model; 
-
-
  • model = name of the meshMotionModel to be applied -
-

Examples: -

-
meshMotionModel noMeshMotion; 
-
-

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

-

Description: -

-

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

-

Restrictions: none. -

-

Default: none. -

- diff --git a/doc/meshMotionModel.txt b/doc/meshMotionModel.txt new file mode 100644 index 0000000..60410ed --- /dev/null +++ b/doc/meshMotionModel.txt @@ -0,0 +1,30 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +meshMotionModel command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +meshMotionModel model; :pre + +model = name of the meshMotionModel to be applied :ul + +[Examples:] + +meshMotionModel noMeshMotion; :pre + +Note: This examples list might not be complete - please look for other models (meshMotionModel_XY) in this documentation. + +[Description:] + +The meshMotionModel is the base class for models which manipulate the CFD mesh according to the DEM mesh motion. + +[Restrictions:] none. + +[Default:] none. diff --git a/doc/meshMotionModel_noMeshMotion.html b/doc/meshMotionModel_noMeshMotion.html deleted file mode 100644 index 5f166bd..0000000 --- a/doc/meshMotionModel_noMeshMotion.html +++ /dev/null @@ -1,32 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

meshMotionModel_noMeshMotion command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
meshMotionModel noMeshMotion; 
-
-

Examples: -

-
meshMotionModel noMeshMotion; 
-
-

Description: -

-

The noMeshMotion-model is a dummy meshMotion model. -

-

Restrictions: None. -

-

Related commands: -

-

meshMotionModel -

- diff --git a/doc/meshMotionModel_noMeshMotion.txt b/doc/meshMotionModel_noMeshMotion.txt new file mode 100644 index 0000000..ca47a35 --- /dev/null +++ b/doc/meshMotionModel_noMeshMotion.txt @@ -0,0 +1,29 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +meshMotionModel_noMeshMotion command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +meshMotionModel noMeshMotion; :pre + +[Examples:] + +meshMotionModel noMeshMotion; :pre + +[Description:] + +The noMeshMotion-model is a dummy meshMotion model. + +[Restrictions:] None. + +[Related commands:] + +"meshMotionModel"_meshMotionModel.html + diff --git a/doc/momCoupleModel.html b/doc/momCoupleModel.html deleted file mode 100644 index 3a37c23..0000000 --- a/doc/momCoupleModel.html +++ /dev/null @@ -1,45 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

momCoupleModel command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
momCoupleModels
-(
-    model
-); 
-
-
  • model = name of the momCoupleModel to be applied -
-

Examples: -

-
momCoupleModels
-(
-    implicitCouple
-); 
-
-

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

-

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. -

-

Note that the variable "imExSplitFactor" can be set in the couplingProperties in order to treat implicitly defined forces (in the implementation of the force model) as explicit ones. "imExSplitFactor 1.0;" is set by default, meaning that all implicit forces will be considered implicitly, whereas "imExSplitFactor 0.0;" would mean that implicitly defined forces will be treated in an explicit fashion. -

-

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. -Description: -

-

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

-

Restrictions: none. -

-

Default: none. -

- diff --git a/doc/momCoupleModel.txt b/doc/momCoupleModel.txt new file mode 100644 index 0000000..0a7dbf2 --- /dev/null +++ b/doc/momCoupleModel.txt @@ -0,0 +1,41 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +momCoupleModel command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +momCoupleModels +( + model +); :pre + +model = name of the momCoupleModel to be applied :ul + +[Examples:] + +momCoupleModels +( + implicitCouple +); :pre + +Note: This examples list might not be complete - please look for other models (momCoupleModel_XY) in this documentation. + +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. + +Note that the variable "imExSplitFactor" can be set in the couplingProperties in order to treat implicitly defined forces (in the implementation of the force model) as explicit ones. "imExSplitFactor 1.0;" is set by default, meaning that all implicit forces will be considered implicitly, whereas "imExSplitFactor 0.0;" would mean that implicitly defined forces will be treated in an explicit fashion. + +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. +[Description:] + +The momCoupleModel is the base class for momentum exchange between DEM and CFD simulation. + +[Restrictions:] none. + +[Default:] none. diff --git a/doc/momCoupleModel_explicitCouple.html b/doc/momCoupleModel_explicitCouple.html deleted file mode 100644 index b1f86a0..0000000 --- a/doc/momCoupleModel_explicitCouple.html +++ /dev/null @@ -1,52 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

momCoupleModel_explicitCouple command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
momCoupleModels
-(
-    explicitCouple
-);
-explicitCoupleProps
-{
-    fLimit vector;
-} 
-
-
  • vector = limiter vector for explicit force term (default (1e10,1e10,1e10) ) - - -
-

Examples: -

-
momCoupleModels
-(
-    explicitCouple
-);
-explicitCoupleProps
-{
-    fLimit (1e3 1e2 1e4);
-} 
-
-

Description: -

-

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. -

-

Restrictions: -

-

Only for solvers that include explicit momentum exchange. -

-

Related commands: -

-

momCoupleModel -

- diff --git a/doc/momCoupleModel_explicitCouple.txt b/doc/momCoupleModel_explicitCouple.txt new file mode 100644 index 0000000..e292dec --- /dev/null +++ b/doc/momCoupleModel_explicitCouple.txt @@ -0,0 +1,48 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +momCoupleModel_explicitCouple command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +momCoupleModels +( + explicitCouple +); +explicitCoupleProps +\{ + fLimit vector; +\} :pre + +{vector} = limiter vector for explicit force term (default (1e10,1e10,1e10) ) :ulb,l +:ule + +[Examples:] + +momCoupleModels +( + explicitCouple +); +explicitCoupleProps +\{ + fLimit (1e3 1e2 1e4); +\} :pre + +[Description:] + +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. + +[Restrictions:] + +Only for solvers that include explicit momentum exchange. + +[Related commands:] + +"momCoupleModel"_momCoupleModel.html + diff --git a/doc/momCoupleModel_implicitCouple.html b/doc/momCoupleModel_implicitCouple.html deleted file mode 100644 index f2b1a00..0000000 --- a/doc/momCoupleModel_implicitCouple.html +++ /dev/null @@ -1,62 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

momCoupleModel_implicitCouple command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
momCoupleModels
-(
-    implicitCouple
-);
-implicitCoupleProps
-{
-    velFieldName "U";
-    granVelFieldName "Us";
-    voidfractionFieldName "voidfraction";
-    minAlphaP number;
-} 
-
-
  • U = name of the finite volume fluid velocity field - -
  • Us = name of the finite volume granular velocity field - -
  • voidfraction = name of the finite volume voidfraction field - -number = minimum value for local particle volume fraction to calculate the exchange filed (default SMALL):l - -
-

Examples: -

-
momCoupleModels
-(
-    implicitCouple
-);
-implicitCoupleProps
-{
-    velFieldName "U";
-    granVelFieldName "Us";
-    voidfractionFieldName "voidfraction";
-} 
-
-

Description: -

-

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

-

Restrictions: -

-

Only for solvers that include implicit momentum exchange. -

-

Related commands: -

-

momCoupleModel -

- diff --git a/doc/momCoupleModel_implicitCouple.txt b/doc/momCoupleModel_implicitCouple.txt new file mode 100644 index 0000000..08433ee --- /dev/null +++ b/doc/momCoupleModel_implicitCouple.txt @@ -0,0 +1,56 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +momCoupleModel_implicitCouple command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +momCoupleModels +( + implicitCouple +); +implicitCoupleProps +\{ + velFieldName "U"; + granVelFieldName "Us"; + voidfractionFieldName "voidfraction"; + minAlphaP number; +\} :pre + +{U} = name of the finite volume fluid velocity field :ulb,l +{Us} = name of the finite volume granular velocity field :l +{voidfraction} = name of the finite volume voidfraction field :l +{number} = minimum value for local particle volume fraction to calculate the exchange filed (default SMALL):l +:ule + +[Examples:] + +momCoupleModels +( + implicitCouple +); +implicitCoupleProps +\{ + velFieldName "U"; + granVelFieldName "Us"; + voidfractionFieldName "voidfraction"; +\} :pre + +[Description:] + +The implicitCouple-model is a momCoupleModel model providing an implicit momentum source term for the CFD solver. + +[Restrictions:] + +Only for solvers that include implicit momentum exchange. + +[Related commands:] + +"momCoupleModel"_momCoupleModel.html + diff --git a/doc/momCoupleModel_noCouple.html b/doc/momCoupleModel_noCouple.html deleted file mode 100644 index 0ec1e60..0000000 --- a/doc/momCoupleModel_noCouple.html +++ /dev/null @@ -1,40 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

momCoupleModel_noCouple command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
momCoupleModels
-(
-    off
-); 
-
-

Examples: -

-
momCoupleModels
-(
-    off
-); 
-
-

Description: -

-

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

-

Restrictions: -

-

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

-

Related commands: -

-

momCoupleModel -

- diff --git a/doc/momCoupleModel_noCouple.txt b/doc/momCoupleModel_noCouple.txt new file mode 100644 index 0000000..6972d30 --- /dev/null +++ b/doc/momCoupleModel_noCouple.txt @@ -0,0 +1,38 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +momCoupleModel_noCouple command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +momCoupleModels +( + off +); :pre + + +[Examples:] + +momCoupleModels +( + off +); :pre + +[Description:] + +The noCouple-model is a dummy momCoupleModel model providing a no momentum source term for the CFD solver. + +[Restrictions:] + +Only for solvers that include no momentum exchange, e.g. immersed boundary. + +[Related commands:] + +"momCoupleModel"_momCoupleModel.html + diff --git a/doc/probeModel.html b/doc/probeModel.html deleted file mode 100644 index 72309a3..0000000 --- a/doc/probeModel.html +++ /dev/null @@ -1,42 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

probeModel command -

-

Syntax: -

-

To be activated via couplingProperties dictionary. -

-
probeModel myProbeModel; 
-
-

Use probe model "off" to disable this feature. -

-
myProbeModelProps 
-
-
{ 
-
-
}; 
-
-

Examples: -

-

See particleProbe -

-

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

-

Description: -

-

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

-

Restrictions: -

-

None. -

-

Default: none. -

- diff --git a/doc/probeModel.txt b/doc/probeModel.txt new file mode 100644 index 0000000..64826ed --- /dev/null +++ b/doc/probeModel.txt @@ -0,0 +1,38 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +probeModel command :h3 + +[Syntax:] + +To be activated via couplingProperties dictionary. + +probeModel myProbeModel; :pre + +Use probe model "off" to disable this feature. + +myProbeModelProps :pre +\{ :pre + +\}; :pre + + +[Examples:] + +See "particleProbe"_probeModel_particleProbe.html + +Note: This examples list might not be complete - please check below for the list of force models that can perform particle probing. + +[Description:] + +The probeModel feature allows to implement various probing features in CFDEM. Currently, only the "particleProbe"_probeModel_particleProbe.html model is implemented, that performs probing of particle forces. + +[Restrictions:] + +None. + +[Default:] none. diff --git a/doc/probeModel_noProbe.html b/doc/probeModel_noProbe.html deleted file mode 100644 index 0348cad..0000000 --- a/doc/probeModel_noProbe.html +++ /dev/null @@ -1,45 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

probeModel_noProbe command -

-

Syntax: -

-

To be activated via couplingProperties dictionary. -

-
forceModels
-{
-    myForceModel1
-    myForceModel2
-    myForceModel3
-}; 
-
-

probeModel off; -

-

Examples: -

-
probeModel off; 
-
-

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

-

Description: -

-

Does not perform any probing. -

-

Restrictions: -

-

None. -

-

Related commands which are currently enabled for particle probing: -

-

particleProbe -

-

Default: none. -

- diff --git a/doc/probeModel_noProbe.txt b/doc/probeModel_noProbe.txt new file mode 100644 index 0000000..cbad7fe --- /dev/null +++ b/doc/probeModel_noProbe.txt @@ -0,0 +1,41 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +probeModel_noProbe command :h3 + +[Syntax:] + +To be activated via couplingProperties dictionary. + +forceModels +\{ + myForceModel1 + myForceModel2 + myForceModel3 +\}; :pre + +probeModel off; + +[Examples:] + +probeModel off; :pre + +Note: This examples list might not be complete - please check below for the list of force models that can perform particle probing. + +[Description:] + +Does not perform any probing. + +[Restrictions:] + +None. + +[Related commands which are currently enabled for particle probing:] + +"particleProbe"_probeModel_particleProbe.html + +[Default:] none. diff --git a/doc/probeModel_particleProbe.html b/doc/probeModel_particleProbe.html deleted file mode 100644 index f33d7bf..0000000 --- a/doc/probeModel_particleProbe.html +++ /dev/null @@ -1,94 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

probeModel_particleProbe command -

-

Syntax: -

-

To be activated via couplingProperties dictionary. -

-

forceModels -( - myForceModel1 - myForceModel2 - myForceModel3 -); -

-

probeModel particleProbe; -

-
particleProbeProps
-{
-    particleIDsToSample (ID1 ID2 ID3 ...);  //list of particleIDs to sample
-    verboseToFile;                          //main switch
-    verbose;                                //currently not used
-    printEvery       xEvery;                //print every this many CFD time steps
-    printOnlyAtStep  xStep;                 //print only at this CFD time step (overrides "printEvery")
-    sampleAll;                              //Activate sampling for all particles
-    probeDebug;                             //probes additional fields
-    includePosition;                        //will include particle position in the output file
-    writePrecision xPrecision;              //number of significant digits to print
-}; 
-
-
  • particleIDsToSample = list of particle IDs to be sampled. - -
  • myForceModeli = list of force models in the simulation, the particleProbe will be applied to all of these models! - -
  • verboseToFile = main switch to activate the particle probe (default = off). - -
  • verbose = main switch to activate output to Info (currently not implemented). - -
  • xEvery = integer to specify the interval for sampling (default = 1, i.e., probing occurs every CFD time step). - -
  • xStep = integer to specify the step for sampling (default = deactivated, i.e., it will print accordingly to "printEvery"). - -
  • sampleAll = switch to activate sampling of all particles. Otherwise (default) only particles specified via "particleIDsToSample" in the couplingProperties dictionary will be sampled. - -
  • probeDebug = switch to activate probing of debug properties of secondary importance (specific for each force model). - -
  • includePosition = switch to add the particle position in the log file (default = off). - -
  • xPrecision= number of significant digits of the text output (default = 3). - - -
-

Examples: -

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

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

-

Description: -

-

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). -

-

Restrictions: -

-

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

-

Related commands which are currently enabled for particle probing: -

-

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). -

-

Default: none. -

- diff --git a/doc/probeModel_particleProbe.txt b/doc/probeModel_particleProbe.txt new file mode 100644 index 0000000..564218f --- /dev/null +++ b/doc/probeModel_particleProbe.txt @@ -0,0 +1,82 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +probeModel_particleProbe command :h3 + +[Syntax:] + +To be activated via couplingProperties dictionary. + +forceModels +( + myForceModel1 + myForceModel2 + myForceModel3 +); + +probeModel particleProbe; + +particleProbeProps +\{ + particleIDsToSample (ID1 ID2 ID3 ...); //list of particleIDs to sample + verboseToFile; //main switch + verbose; //currently not used + printEvery xEvery; //print every this many CFD time steps + printOnlyAtStep xStep; //print only at this CFD time step (overrides "printEvery") + sampleAll; //Activate sampling for all particles + probeDebug; //probes additional fields + includePosition; //will include particle position in the output file + writePrecision xPrecision; //number of significant digits to print +\}; :pre + +{particleIDsToSample} = list of particle IDs to be sampled. :ulb,l + +{myForceModeli} = list of force models in the simulation, the particleProbe will be applied to all of these models! :l +{verboseToFile} = main switch to activate the particle probe (default = off). :l +{verbose} = main switch to activate output to Info (currently not implemented). :l +{xEvery} = integer to specify the interval for sampling (default = 1, i.e., probing occurs every CFD time step). :l +{xStep} = integer to specify the step for sampling (default = deactivated, i.e., it will print accordingly to "printEvery"). :l +{sampleAll} = switch to activate sampling of all particles. Otherwise (default) only particles specified via "particleIDsToSample" in the couplingProperties dictionary will be sampled. :l + +{probeDebug} = switch to activate probing of debug properties of secondary importance (specific for each force model). :l +{includePosition} = switch to add the particle position in the log file (default = off). :l +{xPrecision}= number of significant digits of the text output (default = 3). :l +:ule + +[Examples:] + +particleIDsToSample (0 1 2 3); +forceModels +( + gradPForce +); +particleProbeProps +\{ + verboseToFile; //main switch + verbose; //currently not used + printEvery 100; //print every this many CFD time steps + sampleAll; //Activate sampling for all particles + probeDebug; //probes additional fields + includePosition; //will include particle position in the output file + writePrecision 4; //number of significant digits to print +\}; :pre + +Note: This examples list might not be complete - please check below for the list of force models that can perform particle probing. + +[Description:] + +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). + +[Restrictions:] + +You can manually switch off the probe model for each force model by specifying the Switch "suppressProbe" in the corresponding force properties dictionary. + +[Related commands which are currently enabled for particle probing:] + +"gradPForce"_forceModel_gradPForce.html, "viscForce"_forceModel_viscForce.html, "BeetstraDrag"_forceModel_Beetstra.html, "HollowayDrag"_forceModel_Holloway.html, "MeiLift"_forceModel_MeiLift.html, as well as most other forceModels (see src directory for details, i.e., use "grep -r 'probeM(' ./" in the terminal). + +[Default:] none. diff --git a/doc/regionModel.html b/doc/regionModel.html deleted file mode 100644 index 7d2304f..0000000 --- a/doc/regionModel.html +++ /dev/null @@ -1,34 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

regionModel command -

-

Syntax: -

-

Note: In the current CFDEMcoupling version, this model is no longer used. Defined in couplingProperties dictionary. -

-
regionModel model; 
-
-
  • model = name of the regionModel to be applied -
-

Examples: -

-
regionModel allRegion; 
-
-

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

-

Description: -

-

The regionModel is the base class for region models to select a certain region for coupled simulation. -

-

Restrictions: none. -

-

Default: none. -

- diff --git a/doc/regionModel.txt b/doc/regionModel.txt new file mode 100644 index 0000000..e83d013 --- /dev/null +++ b/doc/regionModel.txt @@ -0,0 +1,30 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +regionModel command :h3 + +[Syntax:] + +Note: In the current CFDEMcoupling version, this model is no longer used. Defined in couplingProperties dictionary. + +regionModel model; :pre + +model = name of the regionModel to be applied :ul + +[Examples:] + +regionModel allRegion; :pre + +Note: This examples list might not be complete - please look for other models (regionModel_XY) in this documentation. + +[Description:] + +The regionModel is the base class for region models to select a certain region for coupled simulation. + +[Restrictions:] none. + +[Default:] none. diff --git a/doc/regionModel_allRegion.html b/doc/regionModel_allRegion.html deleted file mode 100644 index 048c863..0000000 --- a/doc/regionModel_allRegion.html +++ /dev/null @@ -1,32 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

regionModel_allRegion command -

-

Syntax: -

-

Note: In the current CFDEMcoupling version, this model is no longer used. Defined in couplingProperties dictionary. -

-
regionModel allRegion; 
-
-

Examples: -

-
regionModel allRegion; 
-
-

Description: -

-

The allRegion-model is a region model including the whole CFD region for the coupling. -

-

Restrictions: None. -

-

Related commands: -

-

regionModel -

- diff --git a/doc/regionModel_allRegion.txt b/doc/regionModel_allRegion.txt new file mode 100644 index 0000000..c0e3744 --- /dev/null +++ b/doc/regionModel_allRegion.txt @@ -0,0 +1,29 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +regionModel_allRegion command :h3 + +[Syntax:] + +Note: In the current CFDEMcoupling version, this model is no longer used. Defined in couplingProperties dictionary. + +regionModel allRegion; :pre + +[Examples:] + +regionModel allRegion; :pre + +[Description:] + +The allRegion-model is a region model including the whole CFD region for the coupling. + +[Restrictions:] None. + +[Related commands:] + +"regionModel"_regionModel.html + diff --git a/doc/scalarTransportModel.html b/doc/scalarTransportModel.html deleted file mode 100644 index 2694eec..0000000 --- a/doc/scalarTransportModel.html +++ /dev/null @@ -1,89 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

scalarTransportModel command -

-

Syntax: -

-

Defined in scalarTransportProperties dictionary. A variety of derived classes exist that implement different physics of the scalarTransportModel. Here, the most general one, i.e., 'generalManual' is discussed. If no scalar transport shall be used, use the model 'none'. -

-
generalManualProps
-{
-    phiFieldName phiName;
-    voidfractionFieldName voidfractionName;
-    ScT scalar1;
-    PrT scalar2;
-    cpVolumetric scalar3;
-    cpVolumetricFieldName word1;
-    rhoMixFieldName word2;
-    eulerianFields
-    (
-        C
-        T
-    ); 
-
-
} 
-
-
  • phiName = (optional) name of the surface field for the SUPERFICIAL flux, default "phi". - -
  • voidfractionName = (optional) name of the finite volume voidfraction field, default "voidfraction". - -
  • scalar1 = (optional, default 0.7) turbulent Schmidt Nr, set to large value to suppress turbulent species transport - -
  • scalar2 = (optional, default 0.7) turbulent Prandtl Nr, set to large value to suppress turbulent heat transport - -
  • 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 - -
  • word1 = (optional, alternatively define scalar3) volumetric heat capacity as a field - -
  • word3 = mixture density field - -
  • C = concentration field name - -
  • T = temperature field name - - -
-

Examples: -

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

Description: -

-

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. -

-

Restrictions: -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. -

-

Related commands: -

-

none. -

- diff --git a/doc/scalarTransportModel.txt b/doc/scalarTransportModel.txt new file mode 100644 index 0000000..9e16117 --- /dev/null +++ b/doc/scalarTransportModel.txt @@ -0,0 +1,78 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +scalarTransportModel command :h3 + +[Syntax:] + +Defined in scalarTransportProperties dictionary. A variety of derived classes exist that implement different physics of the scalarTransportModel. Here, the most general one, i.e., 'generalManual' is discussed. If no scalar transport shall be used, use the model 'none'. + +generalManualProps +\{ + phiFieldName {phiName}; + voidfractionFieldName {voidfractionName}; + ScT {scalar1}; + PrT {scalar2}; + cpVolumetric {scalar3}; + cpVolumetricFieldName {word1}; + rhoMixFieldName {word2}; + eulerianFields + ( + {C} + {T} + ); :pre +\} :pre + +{phiName} = (optional) name of the surface field for the SUPERFICIAL flux, default "phi". :ulb,l +{voidfractionName} = (optional) name of the finite volume voidfraction field, default "voidfraction". :l +{scalar1} = (optional, default 0.7) turbulent Schmidt Nr, set to large value to suppress turbulent species transport :l +{scalar2} = (optional, default 0.7) turbulent Prandtl Nr, set to large value to suppress turbulent heat transport :l +{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 :l +{word1} = (optional, alternatively define scalar3) volumetric heat capacity as a field :l +{word3} = mixture density field :l +{C} = concentration field name :l +{T} = temperature field name :l +:ule + + +[Examples:] + +generalManualProps +\{ + phiFieldName "phi"; + ScT 0.7; + PrT 0.7; + cpVolumetric 1196; + rhoMixFieldName "rhoMix"; + eulerianFields + ( + C + T + ); :pre + + fvOptionsC + \{ + \}; :pre + fvOptionsT + \{ + \}; :pre + +\} :pre + +[Description:] + +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. + + +[Restrictions:] +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. + + +[Related commands:] + +none. + diff --git a/doc/smoothingModel.html b/doc/smoothingModel.html deleted file mode 100644 index 9aace85..0000000 --- a/doc/smoothingModel.html +++ /dev/null @@ -1,40 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

smoothingModel command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
smoothingModel model; 
-
-
  • model = name of the smoothingModel to be applied -
-

Examples: -

-
smoothingModel off; 
-
-
smoothingModel  constDiffSmoothing; 
-
-
smoothingModel  localPSizeDiffSmoothing; 
-
-

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

-

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. -

-

Description: -

-

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). -

-

Restrictions: These models are in beta testing. -

-

Default: none. -

- diff --git a/doc/smoothingModel.txt b/doc/smoothingModel.txt new file mode 100644 index 0000000..77561ba --- /dev/null +++ b/doc/smoothingModel.txt @@ -0,0 +1,34 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +smoothingModel command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +smoothingModel model; :pre + +model = name of the smoothingModel to be applied :ul + +[Examples:] + +smoothingModel off; :pre +smoothingModel constDiffSmoothing; :pre +smoothingModel localPSizeDiffSmoothing; :pre + +Note: This examples list might not be complete - please look for other models (smoothingModel_XY) in this documentation. + +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. + +[Description:] + +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). + +[Restrictions:] These models are in beta testing. + +[Default:] none. diff --git a/doc/smoothingModel_constDiffSmoothing.html b/doc/smoothingModel_constDiffSmoothing.html deleted file mode 100644 index 031a7bc..0000000 --- a/doc/smoothingModel_constDiffSmoothing.html +++ /dev/null @@ -1,61 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

smoothingModel_constDiffSmoothing command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
smoothingModel constDiffSmoothing;
-constDiffSmoothingProps
-{
-    lowerLimit number1;
-    upperLimit number2;
-    smoothingLength lengthScale;
-    smoothingLengthReferenceField lengthScaleRefField;
-    verbose;
-} 
-
-
  • number1 = scalar fields will be bound to this lower value - -
  • number2 = scalar fields will be bound to this upper value - -
  • lengthScale = length scale over which the exchange fields will be smoothed out - -
  • 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. - -
  • verbose = (optional, default false) flag for debugging output - - -
-

Examples: -

-
constDiffSmoothingProps
-{
-    lowerLimit 0.1;
-    upperLimit 1e10;
-    smoothingLength 1500e-6;
-    smoothingLengthReferenceField 9000e-6;
-} 
-
-

Description: -

-

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. -Smoothing 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. -

-

Restrictions: This model is tested in a limited number of flow situations. -

-

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. -

-

Related commands: -

-

smoothingModel -

- diff --git a/doc/smoothingModel_constDiffSmoothing.txt b/doc/smoothingModel_constDiffSmoothing.txt new file mode 100644 index 0000000..b067fda --- /dev/null +++ b/doc/smoothingModel_constDiffSmoothing.txt @@ -0,0 +1,54 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +smoothingModel_constDiffSmoothing command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +smoothingModel constDiffSmoothing; +constDiffSmoothingProps +\{ + lowerLimit number1; + upperLimit number2; + smoothingLength lengthScale; + smoothingLengthReferenceField lengthScaleRefField; + verbose; +\} :pre + +{number1} = scalar fields will be bound to this lower value :ulb,l +{number2} = scalar fields will be bound to this upper value :l +{lengthScale} = length scale over which the exchange fields will be smoothed out :l +{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. :l +{verbose} = (optional, default false) flag for debugging output :l +:ule + +[Examples:] + +constDiffSmoothingProps +\{ + lowerLimit 0.1; + upperLimit 1e10; + smoothingLength 1500e-6; + smoothingLengthReferenceField 9000e-6; +\} :pre + +[Description:] + +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. +Smoothing 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. + +[Restrictions:] This model is tested in a limited number of flow situations. + +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. + + +[Related commands:] + +"smoothingModel"_smoothingModel.html + diff --git a/doc/smoothingModel_noSmoothing.html b/doc/smoothingModel_noSmoothing.html deleted file mode 100644 index 40081ed..0000000 --- a/doc/smoothingModel_noSmoothing.html +++ /dev/null @@ -1,32 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

smoothingModel_noSmoothing command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
smoothingModel off; 
-
-

Examples: -

-
smoothingModel off; 
-
-

Description: -

-

The "noSmoothing" model is a dummy smoothingModel model which does no smoothing. -

-

Restrictions: none. -

-

Related commands: -

-

smoothingModel -

- diff --git a/doc/smoothingModel_noSmoothing.txt b/doc/smoothingModel_noSmoothing.txt new file mode 100644 index 0000000..827748e --- /dev/null +++ b/doc/smoothingModel_noSmoothing.txt @@ -0,0 +1,29 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +smoothingModel_noSmoothing command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +smoothingModel off; :pre + +[Examples:] + +smoothingModel off; :pre + +[Description:] + +The "noSmoothing" model is a dummy smoothingModel model which does no smoothing. + +[Restrictions:] none. + +[Related commands:] + +"smoothingModel"_smoothingModel.html + diff --git a/doc/voidFractionModel.html b/doc/voidFractionModel.html deleted file mode 100644 index 0dd3793..0000000 --- a/doc/voidFractionModel.html +++ /dev/null @@ -1,34 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

voidfractionModel command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
voidfractionModel model; 
-
-
  • model = name of the voidfractionModel to be applied -
-

Examples: -

-
voidfractionModel centre; 
-
-

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

-

Description: -

-

The voidfractionModel is the base class for models to represent the DEM particle's volume in the CFD domain via a voidfraction field. -

-

Restrictions: none. -

-

Default: none. -

- diff --git a/doc/voidFractionModel.txt b/doc/voidFractionModel.txt new file mode 100644 index 0000000..c431069 --- /dev/null +++ b/doc/voidFractionModel.txt @@ -0,0 +1,30 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +voidfractionModel command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +voidfractionModel model; :pre + +model = name of the voidfractionModel to be applied :ul + +[Examples:] + +voidfractionModel centre; :pre + +Note: This examples list might not be complete - please look for other models (voidfractionModel_XY) in this documentation. + +[Description:] + +The voidfractionModel is the base class for models to represent the DEM particle's volume in the CFD domain via a voidfraction field. + +[Restrictions:] none. + +[Default:] none. diff --git a/doc/voidFractionModel_GaussVoidFraction.html b/doc/voidFractionModel_GaussVoidFraction.html deleted file mode 100644 index 9e04c0d..0000000 --- a/doc/voidFractionModel_GaussVoidFraction.html +++ /dev/null @@ -1,60 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

voidfractionModel_GaussVoidFraction command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
voidfractionModel Gauss;
-GaussProps
-{
-    maxCellsPerParticle number1;
-    alphaMin number2;
-    weight number3;
-    porosity number4;
-} 
-
-
  • number1 = maximum number of cells covered by a particle (search will fail when more than number1 cells are covered by the particle) - -
  • number2 = minimum limit for voidfraction - -
  • number3 = (optional) scaling of the particle volume to account for porosity or agglomerations. - -
  • number4 = (optional) diameter of the particle's representation is artificially increased according to number2 * Vparticle, volume remains unaltered! - - -
-

Examples: -

-
voidfractionModel Gauss;
-GaussProps
-{
-    maxCellsPerParticle 1000;
-    alphaMin 0.10;
-    weight 1.;
-    porosity 1.;
-} 
-
-

Description: -

-

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. -

-

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. -

-

The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. -

-

Restrictions: none. -

-

Related commands: -

-

voidfractionModel , bigParticle -

- diff --git a/doc/voidFractionModel_GaussVoidFraction.txt b/doc/voidFractionModel_GaussVoidFraction.txt new file mode 100644 index 0000000..b6dba1c --- /dev/null +++ b/doc/voidFractionModel_GaussVoidFraction.txt @@ -0,0 +1,53 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +voidfractionModel_GaussVoidFraction command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +voidfractionModel Gauss; +GaussProps +\{ + maxCellsPerParticle number1; + alphaMin number2; + weight number3; + porosity number4; +\} :pre + +{number1} = maximum number of cells covered by a particle (search will fail when more than {number1} cells are covered by the particle) :ulb,l +{number2} = minimum limit for voidfraction :l +{number3} = (optional) scaling of the particle volume to account for porosity or agglomerations. :l +{number4} = (optional) diameter of the particle's representation is artificially increased according to {number2} * Vparticle, volume remains unaltered! :l +:ule + +[Examples:] + +voidfractionModel Gauss; +GaussProps +\{ + maxCellsPerParticle 1000; + alphaMin 0.10; + weight 1.; + porosity 1.; +\} :pre + +[Description:] + +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. + +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. + +The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. + +[Restrictions:] none. + +[Related commands:] + +"voidfractionModel"_voidFractionModel.html , "bigParticle"_voidFractionModel_bigParticleVoidFraction.html + diff --git a/doc/voidFractionModel_IBVoidFraction.html b/doc/voidFractionModel_IBVoidFraction.html deleted file mode 100644 index d2376c0..0000000 --- a/doc/voidFractionModel_IBVoidFraction.html +++ /dev/null @@ -1,59 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

voidfractionModel_IBVoidFraction command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
voidfractionModel IB;
-IBProps
-{
-    maxCellsPerParticle number1;
-    alphaMin number2;
-    scaleUpVol number3;
-    checkPeriodicCells ;
-} 
-
-
  • number1 = maximum number of cells covered by a particle (search will fail when more than number1 cells are covered by the particle) - -
  • number2 = minimum limit for voidfraction - -
  • number3 = diameter of the particle's representation is artificially increased according to number3 * Vparticle, volume remains unaltered! - -
  • checkPeriodicCells = (optional, default false) flag for considering the minimal distance to all periodic images of this particle - - -
-

Examples: -

-
voidfractionModel IB;
-IBProps
-{
-    maxCellsPerParticle 1000;
-    alphaMin 0.10;
-    scaleUpVol 5.0;
-} 
-
-

Description: -

-

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. -

-

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. -

-

Code of this sub-model contributed by Alice Hager, JKU. -

-

Restrictions: none. -

-

Related commands: -

-

voidfractionModel -

- diff --git a/doc/voidFractionModel_IBVoidFraction.txt b/doc/voidFractionModel_IBVoidFraction.txt new file mode 100644 index 0000000..70fb00c --- /dev/null +++ b/doc/voidFractionModel_IBVoidFraction.txt @@ -0,0 +1,52 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +voidfractionModel_IBVoidFraction command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +voidfractionModel IB; +IBProps +\{ + maxCellsPerParticle number1; + alphaMin number2; + scaleUpVol number3; + checkPeriodicCells ; +\} :pre + +{number1} = maximum number of cells covered by a particle (search will fail when more than {number1} cells are covered by the particle) :ulb,l +{number2} = minimum limit for voidfraction :l +{number3} = diameter of the particle's representation is artificially increased according to {number3} * Vparticle, volume remains unaltered! :l +{checkPeriodicCells} = (optional, default false) flag for considering the minimal distance to all periodic images of this particle :l +:ule + +[Examples:] + +voidfractionModel IB; +IBProps +\{ + maxCellsPerParticle 1000; + alphaMin 0.10; + scaleUpVol 5.0; +\} :pre + +[Description:] + +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. + +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. + +Code of this sub-model contributed by Alice Hager, JKU. + +[Restrictions:] none. + +[Related commands:] + +"voidfractionModel"_voidFractionModel.html + diff --git a/doc/voidFractionModel_bigParticleVoidFraction.html b/doc/voidFractionModel_bigParticleVoidFraction.html deleted file mode 100644 index 58d9f75..0000000 --- a/doc/voidFractionModel_bigParticleVoidFraction.html +++ /dev/null @@ -1,62 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

voidfractionModel_bigParticleVoidFraction command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
voidfractionModel bigParticle;
-bigParticleProps
-{
-    maxCellsPerParticle number1;
-    alphaMin number2;
-    weight number3;
-    porosity number4;
-} 
-
-
  • number1 = maximum number of cells covered by a particle (search will fail when more than number1 cells are covered by the particle) - -
  • number2 = minimum limit for voidfraction - -
  • number3 = (optional) scaling of the particle volume to account for porosity or agglomerations. - -
  • number4 = (optional) diameter of the particle's representation is artificially increased according to number2 * Vparticle, volume remains unaltered! - - -
-

Examples: -

-
voidfractionModel bigParticle;
-bigParticleProps
-{
-    maxCellsPerParticle 1000;
-    alphaMin 0.10;
-    weight 1.;
-    porosity 5.0;
-} 
-
-

Description: -

-

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. -

-

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. -

-

The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. -

-

Parts of this sub-model contributed by Alice Hager, JKU. -

-

Restrictions: none. -

-

Related commands: -

-

voidfractionModel -

- diff --git a/doc/voidFractionModel_bigParticleVoidFraction.txt b/doc/voidFractionModel_bigParticleVoidFraction.txt new file mode 100644 index 0000000..15cecec --- /dev/null +++ b/doc/voidFractionModel_bigParticleVoidFraction.txt @@ -0,0 +1,55 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +voidfractionModel_bigParticleVoidFraction command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +voidfractionModel bigParticle; +bigParticleProps +\{ + maxCellsPerParticle number1; + alphaMin number2; + weight number3; + porosity number4; +\} :pre + +{number1} = maximum number of cells covered by a particle (search will fail when more than {number1} cells are covered by the particle) :ulb,l +{number2} = minimum limit for voidfraction :l +{number3} = (optional) scaling of the particle volume to account for porosity or agglomerations. :l +{number4} = (optional) diameter of the particle's representation is artificially increased according to {number2} * Vparticle, volume remains unaltered! :l +:ule + +[Examples:] + +voidfractionModel bigParticle; +bigParticleProps +\{ + maxCellsPerParticle 1000; + alphaMin 0.10; + weight 1.; + porosity 5.0; +\} :pre + +[Description:] + +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. + +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. + +The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. + +Parts of this sub-model contributed by Alice Hager, JKU. + +[Restrictions:] none. + +[Related commands:] + +"voidfractionModel"_voidFractionModel.html + diff --git a/doc/voidFractionModel_centreVoidFraction.html b/doc/voidFractionModel_centreVoidFraction.html deleted file mode 100644 index dc916bb..0000000 --- a/doc/voidFractionModel_centreVoidFraction.html +++ /dev/null @@ -1,50 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

voidfractionModel_centreVoidFraction command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
voidfractionModel centre;
-centreProps
-{
-    alphaMin number1;
-    weight number2;
-} 
-
-
  • number1 = minimum limit for voidfraction - -
  • number2 = (optional) scaling of the particle volume to account for porosity or agglomerations. - - -
-

Examples: -

-
voidfractionModel centre;
-centreProps
-{
-    alphaMin 0.1;
-    weight 1.;
-} 
-
-

Description: -

-

The centre voidFraction model calculates the voidfraction in a CFD cell accounting for the volume of the particles whose centres are inside the cell. -

-

The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. -

-

Restrictions: none. -

-

Related commands: -

-

voidfractionModel -

- diff --git a/doc/voidFractionModel_centreVoidFraction.txt b/doc/voidFractionModel_centreVoidFraction.txt new file mode 100644 index 0000000..e96a075 --- /dev/null +++ b/doc/voidFractionModel_centreVoidFraction.txt @@ -0,0 +1,45 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +voidfractionModel_centreVoidFraction command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +voidfractionModel centre; +centreProps +\{ + alphaMin number1; + weight number2; +\} :pre + +{number1} = minimum limit for voidfraction :ulb,l +{number2} = (optional) scaling of the particle volume to account for porosity or agglomerations. :l +:ule + +[Examples:] + +voidfractionModel centre; +centreProps +\{ + alphaMin 0.1; + weight 1.; +\} :pre + +[Description:] + +The centre voidFraction model calculates the voidfraction in a CFD cell accounting for the volume of the particles whose centres are inside the cell. + +The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. + +[Restrictions:] none. + +[Related commands:] + +"voidfractionModel"_voidFractionModel.html + diff --git a/doc/voidFractionModel_dividedVoidFraction.html b/doc/voidFractionModel_dividedVoidFraction.html deleted file mode 100644 index 18dff0d..0000000 --- a/doc/voidFractionModel_dividedVoidFraction.html +++ /dev/null @@ -1,66 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

voidfractionModel_dividedVoidFraction command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
voidfractionModel divided;
-dividedProps
-{
-    alphaMin number1;
-    interpolation;
-    weight number2;
-    porosity number3;
-    verbose;
-    cfdemUseOnly;
-} 
-
-
  • number1 = minimum limit for voidfraction - -
  • interpolation = flag to interpolate voidfraction to particle positions (normally off) - -
  • number2 = (optional) scaling of the particle volume to account for porosity or agglomerations. - -
  • number3 = (optional) diameter of the particle's representation is artificially increased according to number2 * Vparticle, volume remains unaltered! - -
  • verbose = (optional, default false) flag for debugging output - -
  • cfdemUseOnly = optional flag, default false - - -
-

Examples: -

-
voidfractionModel divided;
-dividedProps
-{
-    alphaMin 0.2;
-} 
-
-

Description: -

-

The divided voidFraction model is supposed to be used when a particle (or its representation) is in the size range of a CFD cell. Satellite points are used to divide the particle's volume to the touched cells. -

-

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. -

-

The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. -

-

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. -The 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. -

-

Restrictions: none. -

-

Related commands: -

-

voidfractionModel -

- diff --git a/doc/voidFractionModel_dividedVoidFraction.txt b/doc/voidFractionModel_dividedVoidFraction.txt new file mode 100644 index 0000000..7b55fc9 --- /dev/null +++ b/doc/voidFractionModel_dividedVoidFraction.txt @@ -0,0 +1,59 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +voidfractionModel_dividedVoidFraction command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +voidfractionModel divided; +dividedProps +\{ + alphaMin number1; + interpolation; + weight number2; + porosity number3; + procBoundaryCorrection Switch1; + verbose; + cfdemUseOnly; +\} :pre + +{number1} = minimum limit for voidfraction :ulb,l +{interpolation} = flag to interpolate voidfraction to particle positions (normally off) :l +{number2} = (optional) scaling of the particle volume to account for porosity or agglomerations. :l +{number3} = (optional) diameter of the particle's representation is artificially increased according to {number2} * Vparticle, volume remains unaltered! :l +{Switch1} = (optional, default false) allow for correction at processor boundaries. This requires the use of engineIB and vice versa. :l +{verbose} = (optional, default false) flag for debugging output :l +{cfdemUseOnly} = optional flag, default false :l +:ule + +[Examples:] + +voidfractionModel divided; +dividedProps +\{ + alphaMin 0.2; +\} :pre + +[Description:] + +The divided voidFraction model is supposed to be used when a particle (or its representation) is in the size range of a CFD cell. Satellite points are used to divide the particle's volume to the touched cells. + +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. + +The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. + +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. +The 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. + +[Restrictions:] none. + +[Related commands:] + +"voidfractionModel"_voidFractionModel.html + diff --git a/doc/voidFractionModel_noVoidFraction.html b/doc/voidFractionModel_noVoidFraction.html deleted file mode 100644 index 2f27f17..0000000 --- a/doc/voidFractionModel_noVoidFraction.html +++ /dev/null @@ -1,32 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

voidfractionModel_noVoidFractionVoidFraction command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-

voidfractionModel noVoidFraction; -

-

Examples: -

-

voidfractionModel noVoidFraction; -

-

Description: -

-

The noVoidFraction voidFraction model is a dummy model and has no physical meaning. -

-

Restrictions: none. -

-

Related commands: -

-

voidfractionModel -

- diff --git a/doc/voidFractionModel_noVoidFraction.txt b/doc/voidFractionModel_noVoidFraction.txt new file mode 100644 index 0000000..85a812a --- /dev/null +++ b/doc/voidFractionModel_noVoidFraction.txt @@ -0,0 +1,29 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +voidfractionModel_noVoidFractionVoidFraction command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +voidfractionModel noVoidFraction; + +[Examples:] + +voidfractionModel noVoidFraction; + +[Description:] + +The noVoidFraction voidFraction model is a dummy model and has no physical meaning. + +[Restrictions:] none. + +[Related commands:] + +"voidfractionModel"_voidFractionModel.html + diff --git a/doc/voidFractionModel_trilinearVoidFraction.html b/doc/voidFractionModel_trilinearVoidFraction.html deleted file mode 100644 index 9da9161..0000000 --- a/doc/voidFractionModel_trilinearVoidFraction.html +++ /dev/null @@ -1,44 +0,0 @@ - -
CFDEMproject WWW Site - CFDEM Commands -
- - - - -
- -

voidfractionModel_trilinearVoidFraction command -

-

Syntax: -

-

Defined in couplingProperties dictionary. -

-
voidfractionModel trilinear;
-trilinearProps
-{
-    alphaMin number1;
-} 
-
-
  • number1 = minimum limit for voidfraction - - -
-

Examples: -

-
voidfractionModel trilinear;
-trilinearProps
-{
-    alphaMin 0.3;
-} 
-
-

Description: -

-

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. -

-

Restrictions: 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!!! -

-

Related commands: -

-

voidfractionModel -

- diff --git a/doc/voidFractionModel_trilinearVoidFraction.txt b/doc/voidFractionModel_trilinearVoidFraction.txt new file mode 100644 index 0000000..1fae83e --- /dev/null +++ b/doc/voidFractionModel_trilinearVoidFraction.txt @@ -0,0 +1,39 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +voidfractionModel_trilinearVoidFraction command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +voidfractionModel trilinear; +trilinearProps +\{ + alphaMin number1; +\} :pre + +{number1} = minimum limit for voidfraction :ulb,l +:ule + +[Examples:] + +voidfractionModel trilinear; +trilinearProps +\{ + alphaMin 0.3; +\} :pre + +[Description:] + +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. + +[Restrictions:] 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!!! + +[Related commands:] + +"voidfractionModel"_voidFractionModel.html diff --git a/src/eulerian/scalarTransportModelsCFDEM/Make/files b/src/eulerian/scalarTransportModelsCFDEM/Make/files index f77abd3..07fbf6a 100644 --- a/src/eulerian/scalarTransportModelsCFDEM/Make/files +++ b/src/eulerian/scalarTransportModelsCFDEM/Make/files @@ -3,6 +3,7 @@ scalarTransportModel/newScalarTransportModel.C /*Sub-Level*/ temperatureModel/temperatureModel.C +solidTemperatureModel/solidTemperatureModel.C generalManual/generalManual.C noTransport/noTransport.C generalPhaseChange/generalPhaseChange.C diff --git a/src/eulerian/scalarTransportModelsCFDEM/eulerianScalarField/eulerianScalarField.C b/src/eulerian/scalarTransportModelsCFDEM/eulerianScalarField/eulerianScalarField.C index 5e93e3e..dca778f 100644 --- a/src/eulerian/scalarTransportModelsCFDEM/eulerianScalarField/eulerianScalarField.C +++ b/src/eulerian/scalarTransportModelsCFDEM/eulerianScalarField/eulerianScalarField.C @@ -197,22 +197,22 @@ void eulerianScalarField::pullCloudFields() const } // ************************************************************ -void eulerianScalarField::update(surfaceScalarField phi, volScalarField voidfraction, volScalarField nuEff, scalar Sc) const +void eulerianScalarField::update(surfaceScalarField phi, volScalarField voidfraction, volScalarField nuEff, scalar Sc, bool limitDiffusion) const { - + scalar oneByCpVolumetric = 1./cpVolumetric_; //Normalize source in case we have a temperature field if(fieldType_=="temperature") { if(cpVolumetricFieldName_=="na" || !updateMixtureProperties_) //use also if mixture properties are not updated { - mSource_.internalField() /= cpVolumetric_; - mSourceKImpl_.internalField() /= cpVolumetric_; + mSource_ *= oneByCpVolumetric; + mSourceKImpl_ *= oneByCpVolumetric; } else { const volScalarField& cpVolumetricField_(particleCloud_.mesh().lookupObject (cpVolumetricFieldName_)); - mSource_.internalField() /= cpVolumetricField_.internalField(); - mSourceKImpl_.internalField() /= cpVolumetricField_.internalField(); + mSource_ /= cpVolumetricField_; + mSourceKImpl_ /= cpVolumetricField_; } } @@ -226,6 +226,14 @@ void eulerianScalarField::update(surfaceScalarField phi, volScalarField voidfrac laplacianScheme = "laplacian((DT*voidfraction),T)"; } + // calc diffusionCoeff field + volScalarField a=nuEff/Sc*voidfraction; + if(limitDiffusion) + { + forAll(a,cellI) + if(voidfraction[cellI] <2*SMALL) + a[cellI]=0.; + } // solve scalar transport equation fvScalarMatrix mEqn @@ -238,7 +246,7 @@ void eulerianScalarField::update(surfaceScalarField phi, volScalarField voidfrac == - fvm::laplacian(nuEff/Sc*voidfraction, m_, laplacianScheme) + fvm::laplacian(a, m_, laplacianScheme) + mSource_ + fvm::Sp(mSourceKImpl_, m_) #ifndef versionExt32 diff --git a/src/eulerian/scalarTransportModelsCFDEM/eulerianScalarField/eulerianScalarField.H b/src/eulerian/scalarTransportModelsCFDEM/eulerianScalarField/eulerianScalarField.H index 888647c..ac6c62b 100644 --- a/src/eulerian/scalarTransportModelsCFDEM/eulerianScalarField/eulerianScalarField.H +++ b/src/eulerian/scalarTransportModelsCFDEM/eulerianScalarField/eulerianScalarField.H @@ -138,7 +138,7 @@ public: // Member Functions void pullCloudFields() const ; - void update(surfaceScalarField, volScalarField, volScalarField, scalar Sc) const ; + void update(surfaceScalarField, volScalarField, volScalarField, scalar Sc, bool limitDiffusion=false) const ; void bound(autoPtr*) const {}; diff --git a/src/eulerian/scalarTransportModelsCFDEM/generalManual/generalManual.C b/src/eulerian/scalarTransportModelsCFDEM/generalManual/generalManual.C index efb86fa..8ac530b 100644 --- a/src/eulerian/scalarTransportModelsCFDEM/generalManual/generalManual.C +++ b/src/eulerian/scalarTransportModelsCFDEM/generalManual/generalManual.C @@ -135,25 +135,25 @@ void generalManual::evolveFields() FatalError <<"generalManual: first eulerianField is temperature, but we need a species. Please re-order your eulerianFields in the input dict. \n" << abort(FatalError); - forAll(rhoMix_.internalField(), iter) + forAll(rhoMix_, iter) { double denominator = 1./eulerianScalarF(0).rhoCarrier(); - rhoMix_.internalField()[iter] = 1.0; - cpRho_.internalField()[iter] = eulerianScalarF(0).cpCarrier(); + rhoMix_[iter] = 1.0; + cpRho_[iter] = eulerianScalarF(0).cpCarrier(); for (int i=0;i tsource diff --git a/src/eulerian/scalarTransportModelsCFDEM/scalarTransportModel/scalarTransportModel.H b/src/eulerian/scalarTransportModelsCFDEM/scalarTransportModel/scalarTransportModel.H index 3c2feea..01b6ae1 100644 --- a/src/eulerian/scalarTransportModelsCFDEM/scalarTransportModel/scalarTransportModel.H +++ b/src/eulerian/scalarTransportModelsCFDEM/scalarTransportModel/scalarTransportModel.H @@ -116,7 +116,7 @@ public: virtual void update(); - virtual volScalarField& sourceField(); + virtual const volScalarField& sourceField(); }; diff --git a/src/eulerian/scalarTransportModelsCFDEM/temperatureModel/temperatureModel.C b/src/eulerian/scalarTransportModelsCFDEM/temperatureModel/temperatureModel.C index aa72fb7..fcef87a 100644 --- a/src/eulerian/scalarTransportModelsCFDEM/temperatureModel/temperatureModel.C +++ b/src/eulerian/scalarTransportModelsCFDEM/temperatureModel/temperatureModel.C @@ -95,7 +95,7 @@ void temperatureModel::update() } // ************************************************************ -volScalarField& temperatureModel::sourceField() +const volScalarField& temperatureModel::sourceField() { return temperatureField_->mSource(); } diff --git a/src/eulerian/scalarTransportModelsCFDEM/temperatureModel/temperatureModel.H b/src/eulerian/scalarTransportModelsCFDEM/temperatureModel/temperatureModel.H index 40c5b1f..4fddda3 100644 --- a/src/eulerian/scalarTransportModelsCFDEM/temperatureModel/temperatureModel.H +++ b/src/eulerian/scalarTransportModelsCFDEM/temperatureModel/temperatureModel.H @@ -90,7 +90,7 @@ public: void update(); - volScalarField& sourceField(); + const volScalarField& sourceField(); }; diff --git a/src/lagrangian/cfdemParticle/Make/files b/src/lagrangian/cfdemParticle/Make/files deleted file mode 100755 index 085cc9c..0000000 --- a/src/lagrangian/cfdemParticle/Make/files +++ /dev/null @@ -1,125 +0,0 @@ -cfdemCloud = cfdemCloud -cfdTools = cfdTools -forceModels = subModels/forceModel -forceSubModels = subModels/forceModel/forceSubModels -IOModels = subModels/IOModel -voidFractionModels = subModels/voidFractionModel -locateModels = subModels/locateModel -meshMotionModels = subModels/meshMotionModel -momCoupleModels = subModels/momCoupleModel -regionModels = subModels/regionModel -dataExchangeModels = subModels/dataExchangeModel -averagingModels = subModels/averagingModel -clockModels = subModels/clockModel -liggghtsCommandModels = subModels/liggghtsCommandModel -smoothingModels = subModels/smoothingModel -probeModels = subModels/probeModel - -$(cfdemCloud)/cfdemCloud.C -derived/cfdemCloudIB/cfdemCloudIB.C - -$(cfdTools)/IOtools/json/json.C -$(cfdTools)/global.C -$(cfdTools)/newGlobal.C - -$(forceModels)/forceModel/forceModel.C -$(forceModels)/forceModel/newForceModel.C -$(forceModels)/noDrag/noDrag.C -$(forceModels)/checkCouplingInterval/checkCouplingInterval.C -$(forceModels)/DiFeliceDrag/DiFeliceDrag.C -$(forceModels)/fieldStore/fieldStore.C -$(forceModels)/GidaspowDrag/GidaspowDrag.C -$(forceModels)/SchillerNaumannDrag/SchillerNaumannDrag.C -$(forceModels)/Archimedes/Archimedes.C -$(forceModels)/ArchimedesIB/ArchimedesIB.C -$(forceModels)/interface/interface.C -$(forceModels)/ShirgaonkarIB/ShirgaonkarIB.C -$(forceModels)/KochHillDrag/KochHillDrag.C -$(forceModels)/LaEuScalarTemp/LaEuScalarTemp.C -$(forceModels)/virtualMassForce/virtualMassForce.C -$(forceModels)/gradPForce/gradPForce.C -$(forceModels)/viscForce/viscForce.C -$(forceModels)/MeiLift/MeiLift.C -$(forceModels)/particleCellVolume/particleCellVolume.C -$(forceModels)/particleVolume/particleVolume.C -$(forceModels)/scalarGeneralExchange/scalarGeneralExchange.C -$(forceModels)/fieldTimeAverage/fieldTimeAverage.C -$(forceModels)/volWeightedAverage/volWeightedAverage.C - -$(forceSubModels)/forceSubModel/newForceSubModel.C -$(forceSubModels)/forceSubModel/forceSubModel.C -$(forceSubModels)/ImEx/ImEx.C - -$(probeModels)/probeModel/probeModel.C -$(probeModels)/probeModel/newProbeModel.C -$(probeModels)/noProbe/noProbe.C -$(probeModels)/particleProbe/particleProbe.C - -$(IOModels)/IOModel/IOModel.C -$(IOModels)/IOModel/newIOModel.C -$(IOModels)/noIO/noIO.C -$(IOModels)/basicIO/basicIO.C -$(IOModels)/trackIO/trackIO.C -$(IOModels)/sophIO/sophIO.C - -$(voidFractionModels)/voidFractionModel/voidFractionModel.C -$(voidFractionModels)/voidFractionModel/newVoidFractionModel.C -$(voidFractionModels)/centreVoidFraction/centreVoidFraction.C -$(voidFractionModels)/dividedVoidFraction/dividedVoidFraction.C -$(voidFractionModels)/bigParticleVoidFraction/bigParticleVoidFraction.C -$(voidFractionModels)/GaussVoidFraction/GaussVoidFraction.C -$(voidFractionModels)/IBVoidFraction/IBVoidFraction.C -$(voidFractionModels)/trilinearVoidFraction/trilinearVoidFraction.C -$(voidFractionModels)/noVoidFraction/noVoidFraction.C - -$(locateModels)/locateModel/locateModel.C -$(locateModels)/locateModel/newLocateModel.C -$(locateModels)/standardSearch/standardSearch.C -$(locateModels)/engineSearch/engineSearch.C -$(locateModels)/engineSearchIB/engineSearchIB.C - - -$(meshMotionModels)/meshMotionModel/meshMotionModel.C -$(meshMotionModels)/meshMotionModel/newMeshMotionModel.C -$(meshMotionModels)/noMeshMotion/noMeshMotion.C - -$(momCoupleModels)/momCoupleModel/momCoupleModel.C -$(momCoupleModels)/momCoupleModel/newMomCoupleModel.C -$(momCoupleModels)/explicitCouple/explicitCouple.C -$(momCoupleModels)/implicitCouple/implicitCouple.C -$(momCoupleModels)/noCouple/noCouple.C - -$(regionModels)/regionModel/regionModel.C -$(regionModels)/regionModel/newRegionModel.C -$(regionModels)/allRegion/allRegion.C - -$(dataExchangeModels)/dataExchangeModel/dataExchangeModel.C -$(dataExchangeModels)/dataExchangeModel/newDataExchangeModel.C -$(dataExchangeModels)/oneWayVTK/oneWayVTK.C -$(dataExchangeModels)/twoWayFiles/twoWayFiles.C -$(dataExchangeModels)/noDataExchange/noDataExchange.C -$(dataExchangeModels)/twoWayMPI/twoWayMPI.C - -$(averagingModels)/averagingModel/averagingModel.C -$(averagingModels)/averagingModel/newAveragingModel.C -$(averagingModels)/dilute/dilute.C -$(averagingModels)/dense/dense.C - -$(clockModels)/clockModel/clockModel.C -$(clockModels)/clockModel/newClockModel.C -$(clockModels)/standardClock/standardClock.C -$(clockModels)/noClock/noClock.C - -$(liggghtsCommandModels)/liggghtsCommandModel/liggghtsCommandModel.C -$(liggghtsCommandModels)/liggghtsCommandModel/newLiggghtsCommandModel.C -$(liggghtsCommandModels)/execute/execute.C -$(liggghtsCommandModels)/runLiggghts/runLiggghts.C -$(liggghtsCommandModels)/writeLiggghts/writeLiggghts.C -$(liggghtsCommandModels)/readLiggghtsData/readLiggghtsData.C - -$(smoothingModels)/smoothingModel/smoothingModel.C -$(smoothingModels)/smoothingModel/newSmoothingModel.C -$(smoothingModels)/noSmoothing/noSmoothing.C -$(smoothingModels)/constDiffSmoothing/constDiffSmoothing.C - -LIB = $(CFDEM_LIB_DIR)/lib$(CFDEM_LIB_NAME) diff --git a/src/lagrangian/cfdemParticle/Make/options b/src/lagrangian/cfdemParticle/Make/options deleted file mode 100755 index e30bb1f..0000000 --- a/src/lagrangian/cfdemParticle/Make/options +++ /dev/null @@ -1,34 +0,0 @@ -sinclude $(GENERAL_RULES)/mplib$(WM_MPLIB) -sinclude $(RULES)/mplib$(WM_MPLIB) - -GIT_VERSION := $(shell git describe --dirty --always --tags) -PFLAGS+= -DGITVERSION=\"$(GIT_VERSION)\" -PFLAGS+= -DDEBUGFLAG=\"$(DEBUG)\" -PFLAGS+= -DCFDEMWMPROJECTVERSION="$(CFDEM_WM_PROJECT_VERSION)" - -include $(CFDEM_ADD_LIBS_DIR)/$(CFDEM_ADD_LIBS_NAME) - -EXE_INC = \ - $(PFLAGS) \ - $(PINC) \ - -I ./cfdemParticle \ - -I$(LIB_SRC)/finiteVolume/lnInclude \ - -I$(LIB_SRC)/transportModels \ - $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \ - -I$(LIB_SRC)/meshTools/lnInclude \ - -I$(LIB_SRC)/lagrangian/basic/lnInclude \ - -I$(LIB_SRC)/OpenFOAM/containers/HashTables/labelHashSet \ - -I$(CFDEM_LIGGGHTS_SRC_DIR) \ - -I$(CFDEM_SRC_DIR)/cfdTools \ - -LIB_LIBS = \ - $(PLIBS) \ - -L$(CFDEM_LIB_DIR) \ - -lfiniteVolume \ - $(CFDEM_ADD_INCOMPTURBMOD_LIBS) \ - -lmeshTools \ - -llagrangian \ - -L$(CFDEM_LIGGGHTS_SRC_DIR) \ - -Wl,--whole-archive -l$(CFDEM_LIGGGHTS_LIB_NAME) -Wl,--no-whole-archive \ - $(CFDEM_ADD_LIB_PATHS) \ - $(CFDEM_ADD_STATICLIBS) diff --git a/src/lagrangian/cfdemParticle/cfdTools/forceCheckEx.H b/src/lagrangian/cfdemParticle/cfdTools/forceCheckEx.H index 104030d..fb660bc 100644 --- a/src/lagrangian/cfdemParticle/cfdTools/forceCheckEx.H +++ b/src/lagrangian/cfdemParticle/cfdTools/forceCheckEx.H @@ -1,4 +1,14 @@ +//calc. total source - this NOT a relevant explicit force! +dimensionedVector fExpSource = -1 * particleCloud.momCoupleM(1).returnIntegralSourceField(); //negative because we want the force on the fluid +reduce(fExpSource, sumOp()); //must reduce, since sum in function is not the global sum! + //calc. total explicit force -vector fExpTotal =-sum(mesh.V()*f.internalField()); //negative because we want the force on the fluid -reduce(fExpTotal, sumOp()); -Info << "TotalForceExp: " << fExpTotal << endl; +dimensionedVector fExpTotal = -gSum( + mesh.V() + * f.internalField() + ); //negative because we want the force on the fluid + +fExpTotal.value() -= fExpSource.value(); //Subtract the explicit source, since this is NOT a coupling force!! + +Info << "TotalSourceExp: " << fExpSource.value() << endl; +Info << "TotalForceExp: " << fExpTotal.value() << endl; diff --git a/src/lagrangian/cfdemParticle/cfdTools/forceCheckIm.H b/src/lagrangian/cfdemParticle/cfdTools/forceCheckIm.H index 5622daf..ef603bd 100644 --- a/src/lagrangian/cfdemParticle/cfdTools/forceCheckIm.H +++ b/src/lagrangian/cfdemParticle/cfdTools/forceCheckIm.H @@ -1,4 +1,9 @@ //calc. total implicit force -vector fImpTotal = sum(mesh.V()*Ksl.internalField()*(Us.internalField()-U.internalField())); -reduce(fImpTotal, sumOp()); -Info << "TotalForceImp: " << fImpTotal << endl; +volVectorField fImp(Ksl*(Us-U)); +particleCloud.scaleWithVcell(fImp); +dimensionedVector fImpTotal = gSum(fImp); +// mesh.V() +// * Ksl.internalField() +// * ( Us.internalField() - U.internalField() ) +// ); +Info << "TotalForceImp: " << fImpTotal.value() << endl; diff --git a/src/lagrangian/cfdemParticle/cfdTools/readPISOControls_OF30.H b/src/lagrangian/cfdemParticle/cfdTools/readPISOControls_OF30.H index c432889..f935921 100644 --- a/src/lagrangian/cfdemParticle/cfdTools/readPISOControls_OF30.H +++ b/src/lagrangian/cfdemParticle/cfdTools/readPISOControls_OF30.H @@ -5,4 +5,3 @@ pisoControl piso(mesh); //create lables label nCorr = piso.nCorrPISO(); label nNonOrthCorr = piso.nNonOrthCorr(); -bool momentumPredictor = piso.momentumPredictor(); diff --git a/src/lagrangian/cfdemParticle/cfdTools/setupProbeModel.H b/src/lagrangian/cfdemParticle/cfdTools/setupProbeModel.H index d94133e..e54437f 100644 --- a/src/lagrangian/cfdemParticle/cfdTools/setupProbeModel.H +++ b/src/lagrangian/cfdemParticle/cfdTools/setupProbeModel.H @@ -1,3 +1,5 @@ //set probeModel parameters for this force model - particleCloud_.probeM().setOutputFile(); - particleCloud_.probeM().setCounter(); + //CANNOT be used for scalarGeneralExchange force model, since this force model handles multiple species + if(probeIt_) + particleCloud_.probeM().setOutputFile(typeName+".logDat"); + diff --git a/src/lagrangian/cfdemParticle/cfdTools/versionInfo.H b/src/lagrangian/cfdemParticle/cfdTools/versionInfo.H index 1e39cb6..faebedc 100755 --- a/src/lagrangian/cfdemParticle/cfdTools/versionInfo.H +++ b/src/lagrangian/cfdemParticle/cfdTools/versionInfo.H @@ -33,8 +33,8 @@ Description #ifndef versionInfo_H #define versionInfo_H -word CFDEMversion="cfdem-3.4.0"; -word compatibleLIGGGHTSversion="3.4.0"; +word CFDEMversion="cfdem-3.5.0"; +word compatibleLIGGGHTSversion="3.5.0"; word OFversion="3.0.x-commit-ac3f6c67e02f0aac3777c27f9fb7558fc3536e37"; Info << "\nCFDEMcoupling version: " << CFDEMversion << endl; diff --git a/src/lagrangian/cfdemParticle/cfdemCloud/cfdemCloud.C b/src/lagrangian/cfdemParticle/cfdemCloud/cfdemCloud.C index 7d82bae..d454746 100644 --- a/src/lagrangian/cfdemParticle/cfdemCloud/cfdemCloud.C +++ b/src/lagrangian/cfdemParticle/cfdemCloud/cfdemCloud.C @@ -44,6 +44,7 @@ Description #include "clockModel.H" #include "smoothingModel.H" #include "liggghtsCommandModel.H" +#include "cyclicPolyPatch.H" // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // Foam::cfdemCloud::cfdemCloud @@ -78,6 +79,7 @@ Foam::cfdemCloud::cfdemCloud solveScalarTransport_(true), verbose_(false), debug_(false), + allowCFDsubTimestep_(true), ignore_(false), modelType_(couplingProperties_.lookup("modelType")), positions_(NULL), @@ -94,6 +96,7 @@ Foam::cfdemCloud::cfdemCloud particleWeights_(NULL), particleVolumes_(NULL), particleV_(NULL), + dragPrev_(NULL), numberOfParticles_(0), d32_(-1), numberOfParticlesChanged_(false), @@ -110,7 +113,6 @@ Foam::cfdemCloud::cfdemCloud imExSplitFactor_(1.0), treatVoidCellsAsExplicitForce_(false), useDDTvoidfraction_("off"), - dragPrev_(NULL), ddtVoidfraction_ ( IOobject @@ -124,6 +126,7 @@ Foam::cfdemCloud::cfdemCloud mesh, dimensionedScalar("zero", dimensionSet(0,0,-1,0,0), 0) // 1/s ), + checkPeriodicCells_(false), turbulence_ ( #if defined(version24Dev) @@ -261,6 +264,8 @@ Foam::cfdemCloud::cfdemCloud averagingM().applyDebugSettings(debugMode()); //-- + dataExchangeM().setCG(); + Info << "If BC are important, please provide volScalarFields -imp/expParticleForces-" << endl; if (couplingProperties_.found("solveFlow")) solveFlow_=Switch(couplingProperties_.lookup("solveFlow")); @@ -268,6 +273,14 @@ Foam::cfdemCloud::cfdemCloud solveScalarTransport_=Switch(couplingProperties_.lookup("solveScalarTransport")); if (couplingProperties_.found("imExSplitFactor")) imExSplitFactor_ = readScalar(couplingProperties_.lookup("imExSplitFactor")); + + if(imExSplitFactor_>1.0) + FatalError << "You have set imExSplitFactor > 1 in your couplingProperties. Must be <=1." + << abort(FatalError); + if(imExSplitFactor_<0.0) + FatalError << "You have set imExSplitFactor < 0 in your couplingProperties. Must be >=0" + << abort(FatalError); + if (couplingProperties_.found("treatVoidCellsAsExplicitForce")) treatVoidCellsAsExplicitForce_ = readBool(couplingProperties_.lookup("treatVoidCellsAsExplicitForce")); if (couplingProperties_.found("verbose")) verbose_=true; @@ -332,8 +345,41 @@ Foam::cfdemCloud::cfdemCloud ); } - dataExchangeM().setCG(); - if (!cgOK_ && cg_ > 1) FatalError<< "at least one of your models is not fit for cg !!!"<< abort(FatalError); + Switch cgWarnOnly_(couplingProperties_.lookupOrDefault("cgWarnOnly", true)); + if (!cgOK_ && cg_ > 1) + { + if(cgWarnOnly_) + Warning<< "at least one of your models is not fit for cg !!!"<< endl; + else + FatalError<< "at least one of your models is not fit for cg !!!"<< abort(FatalError); + } + + // check if sim is fully peridic box + const polyBoundaryMesh& patches = mesh_.boundaryMesh(); + int nPatchesCyclic(0); + int nPatchesNonCyclic(0); + forAll(patches, patchI) + { + const polyPatch& pp = patches[patchI]; + #if defined(versionExt32) + if (isA(pp)) + nPatchesCyclic++; + else if (!isA(pp)) + nPatchesNonCyclic++; + #else + if (isA(pp) || isA(pp)) + nPatchesCyclic++; + else if (!isA(pp)) + nPatchesNonCyclic++; + #endif + } + if(nPatchesNonCyclic==0) + checkPeriodicCells_=true; + if(nPatchesCyclic>0 && nPatchesNonCyclic>0) + { + if(verbose_) Info << "nPatchesNonCyclic=" << nPatchesNonCyclic << ", nPatchesCyclic=" << nPatchesCyclic << endl; + Warning << "Periodic handing is disabled because the domain is not fully periodic!\n" << endl; + } } // * * * * * * * * * * * * * * * * Destructors * * * * * * * * * * * * * * // @@ -809,8 +855,9 @@ tmp cfdemCloud::ddtVoidfraction() const { if (useDDTvoidfraction_==word("off")) { - Info << "suppressing ddt(voidfraction)" << endl; return tmp (ddtVoidfraction_ * 0.); + if(verbose_) + Info << "suppressing ddt(voidfraction)" << endl; } return tmp (ddtVoidfraction_ * 1.) ; } diff --git a/src/lagrangian/cfdemParticle/cfdemCloud/cfdemCloud.H b/src/lagrangian/cfdemParticle/cfdemCloud/cfdemCloud.H index 5df99b3..42077ca 100644 --- a/src/lagrangian/cfdemParticle/cfdemCloud/cfdemCloud.H +++ b/src/lagrangian/cfdemParticle/cfdemCloud/cfdemCloud.H @@ -97,6 +97,8 @@ protected: bool debug_; + bool allowCFDsubTimestep_; + bool ignore_; const word modelType_; @@ -167,6 +169,8 @@ protected: mutable volScalarField ddtVoidfraction_; + mutable Switch checkPeriodicCells_; + #if defined(version24Dev) const turbulenceModel& turbulence_; #elif defined(version21) || defined(version16ext) @@ -252,6 +256,10 @@ public: bool debugMode(){ return debug_;}; + bool allowCFDsubTimestep(){ return allowCFDsubTimestep_;}; + + void setAllowCFDsubTimestep(bool b){allowCFDsubTimestep_=b;}; + void checkCG(bool); void setPos(double **&); @@ -365,7 +373,10 @@ public: 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 enable superquadrics in LIGGGHTS (SUPERQUADRIC_ACTIVE_FLAG)" << abort(FatalError); return NULL; }; - virtual vector shape(int) const {return Foam::vector(0,0,0);}; + virtual vector shape(int) const { + 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 enable superquadrics in LIGGGHTS (SUPERQUADRIC_ACTIVE_FLAG)" << abort(FatalError); + return Foam::vector(0,0,0); + }; // access to complex shape information virtual inline double ** vectorArray() const {return NULL;}; @@ -460,6 +471,14 @@ public: inline const incompressible::RASModel& turbulence() const; #endif + inline void makeSpecific(volScalarField&); + + inline void makeSpecific(volVectorField&); + + inline void scaleWithVcell(volScalarField&); + + inline void scaleWithVcell(volVectorField&); + // Write // write cfdemCloud internal data @@ -511,6 +530,7 @@ public: void zeroizeParticleDatFieldsUserCFDEMToExt(); void accessParticleDatFieldsUserCFDEMToExt(word fieldToAccess, double **& fieldData); //=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*= + bool checkPeriodicCells() { return checkPeriodicCells_; } }; diff --git a/src/lagrangian/cfdemParticle/cfdemCloud/cfdemCloudI.H b/src/lagrangian/cfdemParticle/cfdemCloud/cfdemCloudI.H index 4ad6b40..22cc99f 100644 --- a/src/lagrangian/cfdemParticle/cfdemCloud/cfdemCloudI.H +++ b/src/lagrangian/cfdemParticle/cfdemCloud/cfdemCloudI.H @@ -332,5 +332,30 @@ inline autoPtr* cfdemCloud::liggghtsCommand() const { return turbulence_; } + +inline void cfdemCloud::makeSpecific(volScalarField& field) +{ + forAll(field,cellI) + field[cellI] /= mesh_.V()[cellI]; +} + +inline void cfdemCloud::makeSpecific(volVectorField& field) +{ + forAll(field,cellI) + field[cellI] /= mesh_.V()[cellI]; +} + +inline void cfdemCloud::scaleWithVcell(volScalarField& field) +{ + forAll(field,cellI) + field[cellI] *= mesh_.V()[cellI]; +} + +inline void cfdemCloud::scaleWithVcell(volVectorField& field) +{ + forAll(field,cellI) + field[cellI] *= mesh_.V()[cellI]; +} + } // ************************************************************************* // diff --git a/src/lagrangian/cfdemParticle/derived/cfdemCloudIB/cfdemCloudIB.C b/src/lagrangian/cfdemParticle/derived/cfdemCloudIB/cfdemCloudIB.C index 731d55b..45c8d7a 100644 --- a/src/lagrangian/cfdemParticle/derived/cfdemCloudIB/cfdemCloudIB.C +++ b/src/lagrangian/cfdemParticle/derived/cfdemCloudIB/cfdemCloudIB.C @@ -59,14 +59,32 @@ cfdemCloudIB::cfdemCloudIB pRefCell_(readLabel(mesh.solutionDict().subDict("PISO").lookup("pRefCell"))), pRefValue_(readScalar(mesh.solutionDict().subDict("PISO").lookup("pRefValue"))), haveEvolvedOnce_(false), - skipLagrangeToEulerMapping_(false) + skipLagrangeToEulerMapping_(false), + skipAfter_(false), + timeStepsToSkip_(0), + calculateTortuosity_(false) { - if(this->couplingProperties().found("skipLagrangeToEulerMapping")) { Info << "Will skip lagrange-to-Euler mapping..." << endl; skipLagrangeToEulerMapping_=true; } + if(this->couplingProperties().found("timeStepsBeforeSkipping")) + { + skipAfter_=true; + timeStepsToSkip_ = readScalar + ( + this->couplingProperties().lookup("timeStepsBeforeSkipping") + ); + Info << "Will skip LagrangeToEuler mapping after " << timeStepsToSkip_ << " time steps" << endl; + } + if(this->couplingProperties().found("tortuosity")) + { + calculateTortuosity_ = true; + flowDir_ = this->couplingProperties().subDict("tortuosity").lookup("flowDirection"); + flowDir_ = flowDir_ / mag(flowDir_); + Info << "Will calculate tortuosity in the mean flow direction ("<("U"); + volScalarField voidfraction = mesh_.lookupObject("voidfraction"); + double ux = 0.0; + double umag = 0.0; + forAll(mesh_.V(),cellI) + { + if(voidfraction[cellI] > 0.5) + { + double V = mesh_.V()[cellI]; + ux += ((U[cellI] & dir))*V; + umag += mag(U[cellI])*V; + } + } + //double ux_reduced = 0.0; + //double umag_reduced = 0.0; + //MPI_Allreduce(&ux, &ux_reduced, 1, MPI_DOUBLE, MPI_SUM, MPI_COMM_WORLD); + //MPI_Allreduce(&umag, &umag_reduced, 1, MPI_DOUBLE, MPI_SUM, MPI_COMM_WORLD); + reduce(umag, sumOp()); + reduce(ux, sumOp()); + double tortuosity = ux == 0.0 ? 1.0 : umag / ux; + return tortuosity; +} + // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // } // End namespace Foam diff --git a/src/lagrangian/cfdemParticle/derived/cfdemCloudIB/cfdemCloudIB.H b/src/lagrangian/cfdemParticle/derived/cfdemCloudIB/cfdemCloudIB.H index 19b70c8..14bc241 100644 --- a/src/lagrangian/cfdemParticle/derived/cfdemCloudIB/cfdemCloudIB.H +++ b/src/lagrangian/cfdemParticle/derived/cfdemCloudIB/cfdemCloudIB.H @@ -64,6 +64,11 @@ protected: mutable bool haveEvolvedOnce_; mutable bool skipLagrangeToEulerMapping_; + mutable bool skipAfter_; + mutable int timeStepsToSkip_; + mutable bool calculateTortuosity_; + + vector flowDir_; public: @@ -85,7 +90,7 @@ public: bool reAllocArrays() const; - bool evolve(volScalarField&); + bool evolve(volScalarField&,volScalarField&); void calcVelocityCorrection(volScalarField&,volVectorField&,volScalarField&,volScalarField&); @@ -98,6 +103,10 @@ public: { return angularVelocities_; }; + void setInterFace(volScalarField& interFace); + + double getTortuosity(vector dir); + }; diff --git a/src/lagrangian/cfdemParticle/etc/OFversion/OFversion.H b/src/lagrangian/cfdemParticle/etc/OFversion/OFversion.H deleted file mode 100644 index 168aa9a..0000000 --- a/src/lagrangian/cfdemParticle/etc/OFversion/OFversion.H +++ /dev/null @@ -1,42 +0,0 @@ -#if(CFDEMWMPROJECTVERSION == 24) - #define version24 -#elif(CFDEMWMPROJECTVERSION == 30) - #define version30 -#elif(CFDEMWMPROJECTVERSION == 132) - #define versionExt32 -#endif - -//define anisotropicRotation cloud models -//#define anisotropicRotation - -// features of 16ext work also in extend 3.2 -#if defined(versionExt32) - #define version16ext -#endif - -// features of 2.4Dev work also in Dev -#if defined(version30) - #define version24Dev -#endif - -// basically use 24x settings + some dev features (e.g. new turbulence model structure) -#if defined(version24Dev) - #define version24 -#endif - -// features of 2.4 work also in 2.3 -#if defined(version24) - #define version23 -#endif - -// features of 2.1 work also in 2.3 -#if defined(version23) - #define version21 - #define version221 -#endif - -// features of 2.1 work also in 2.2 -#if defined(version22) - #define version21 - #define version221 -#endif diff --git a/src/lagrangian/cfdemParticle/etc/additionalLibs_2.4.x b/src/lagrangian/cfdemParticle/etc/additionalLibs_2.4.x deleted file mode 100644 index bda1adf..0000000 --- a/src/lagrangian/cfdemParticle/etc/additionalLibs_2.4.x +++ /dev/null @@ -1,41 +0,0 @@ -# paths for additional libraries -CFDEM_ADD_LIB_PATHS = \ - -# additional libraries to be linked to solvers -CFDEM_ADD_LIBS = \ - -# additional static libraries to be linked to lagrangian library -CFDEM_ADD_STATICLIBS = \ --lmpi_cxx \ - -################################################################# -## SETTINGS FOR 2.4.x ## -################################################################# -#---------------------------------------------------------------- -# incompressible turbulence model settings -#---------------------------------------------------------------- -# paths for incompressible turbulence models to use -CFDEM_ADD_INCOMPTURBMOD_PATHS = \ --I$(LIB_SRC)/turbulenceModels/incompressible/turbulenceModel \ --I$(LIB_SRC)/fvOptions/lnInclude \ - -# libs for turbulence models to use -CFDEM_ADD_INCOMPTURBMOD_LIBS = \ --lincompressibleRASModels \ --lincompressibleLESModels \ --lfvOptions \ - -#---------------------------------------------------------------- -# compressible turbulence model settings -#---------------------------------------------------------------- -# paths for compressible turbulence models to use -CFDEM_ADD_COMPTURBMOD_PATHS = \ --I$(LIB_SRC)/turbulenceModels/compressible/turbulenceModel \ --I$(LIB_SRC)/thermophysicalModels/basic/lnInclude \ --I$(LIB_SRC)/thermophysicalModels/radiationModels/lnInclude \ - -# libs for turbulence models to use -CFDEM_ADD_COMPTURBMOD_LIBS = \ --lcompressibleRASModels \ --lcompressibleLESModels \ --lfluidThermophysicalModels \ diff --git a/src/lagrangian/cfdemParticle/etc/additionalLibs_3.0.x b/src/lagrangian/cfdemParticle/etc/additionalLibs_3.0.x deleted file mode 100644 index 91bbfb3..0000000 --- a/src/lagrangian/cfdemParticle/etc/additionalLibs_3.0.x +++ /dev/null @@ -1,43 +0,0 @@ -# paths for additional libraries -CFDEM_ADD_LIB_PATHS = \ - -# additional libraries to be linked to solvers -CFDEM_ADD_LIBS = \ - -# additional static libraries to be linked to lagrangian library -CFDEM_ADD_STATICLIBS = \ --lmpi_cxx \ - -################################################################# -## SETTINGS FOR 3.0.x ## -################################################################# -#---------------------------------------------------------------- -# incompressible turbulence model settings -#---------------------------------------------------------------- -# paths for incompressible turbulence models to use -CFDEM_ADD_INCOMPTURBMOD_PATHS = \ --I$(LIB_SRC)/TurbulenceModels/turbulenceModels/lnInclude \ --I$(LIB_SRC)/TurbulenceModels/incompressible/lnInclude \ --I$(LIB_SRC)/fvOptions/lnInclude \ - -# libs for turbulence models to use -CFDEM_ADD_INCOMPTURBMOD_LIBS = \ --lturbulenceModels \ --lincompressibleTurbulenceModels \ --lfvOptions \ - -#---------------------------------------------------------------- -# compressible turbulence model settings -#---------------------------------------------------------------- -# paths for compressible turbulence models to use -CFDEM_ADD_COMPTURBMOD_PATHS = \ --I$(LIB_SRC)/TurbulenceModels/turbulenceModels/lnInclude \ --I$(LIB_SRC)/TurbulenceModels/compressible/lnInclude \ --I$(LIB_SRC)/transportModels/compressible/lnInclude \ --I$(LIB_SRC)/thermophysicalModels/radiation/lnInclude \ - -# libs for turbulence models to use -CFDEM_ADD_COMPTURBMOD_LIBS = \ --lturbulenceModels \ --lcompressibleTurbulenceModels \ -################################################################# diff --git a/src/lagrangian/cfdemParticle/etc/additionalLibs_3.2 b/src/lagrangian/cfdemParticle/etc/additionalLibs_3.2 deleted file mode 100644 index c5bdc5a..0000000 --- a/src/lagrangian/cfdemParticle/etc/additionalLibs_3.2 +++ /dev/null @@ -1,45 +0,0 @@ -# paths for additional libraries -CFDEM_ADD_LIB_PATHS = \ --L/usr/include/vtk \ --L/usr/lib64/vtk \ - -# additional libraries to be linked to solvers -CFDEM_ADD_LIBS = \ --lvtkCommonCore \ --lvtkIOCore \ --lvtkIOXML \ --lvtkIOLegacy \ --lvtkCommonDataModel \ - -# additional static libraries to be linked to lagrangian library -CFDEM_ADD_STATICLIBS = \ --lmpi_cxx \ - -################################################################# -## SETTINGS FOR Extend 3.2 ## -################################################################# -#---------------------------------------------------------------- -# incompressible turbulence model settings -#---------------------------------------------------------------- -# paths for incompressible turbulence models to use -CFDEM_ADD_INCOMPTURBMOD_PATHS = \ --I$(LIB_SRC)/turbulenceModels/incompressible/turbulenceModel \ - -# libs for turbulence models to use -CFDEM_ADD_INCOMPTURBMOD_LIBS = \ --lincompressibleRASModels \ --lincompressibleLESModels \ - -#---------------------------------------------------------------- -# compressible turbulence model settings -#---------------------------------------------------------------- -# paths for compressible turbulence models to use -CFDEM_ADD_COMPTURBMOD_PATHS = \ --I$(LIB_SRC)/turbulenceModels/compressible/turbulenceModel \ --I$(LIB_SRC)/thermophysicalModels/basic/lnInclude \ --I$(LIB_SRC)/thermophysicalModels/radiationModels/lnInclude \ - -# libs for turbulence models to use -CFDEM_ADD_COMPTURBMOD_LIBS = \ --lcompressibleRASModels \ --lcompressibleLESModels \ diff --git a/src/lagrangian/cfdemParticle/etc/bashrc b/src/lagrangian/cfdemParticle/etc/bashrc index c16b40a..121c107 100755 --- a/src/lagrangian/cfdemParticle/etc/bashrc +++ b/src/lagrangian/cfdemParticle/etc/bashrc @@ -240,10 +240,26 @@ else fi # detect OF version -if [ $WM_PROJECT_VERSION == "3.0.x" ]; then +if [[ $WM_PROJECT_VERSION == 4.* ]]; then + export CFDEM_WM_PROJECT_VERSION=40 + echo "************************************" + echo "WARNING from your CFDEM code!" + echo "WARNING: Coupling with your OpenFOAM(R) version is currently under development!" + echo "In doubt switch to another version." + echo "************************************" + sleep 1.5 +elif [[ $WM_PROJECT_VERSION == 3.0.* ]]; then export CFDEM_WM_PROJECT_VERSION=30 -elif [ $WM_PROJECT_VERSION == "2.4.x" ]; then +elif [[ $WM_PROJECT_VERSION == 2.4.* ]]; then export CFDEM_WM_PROJECT_VERSION=24 elif [[ $WM_PROJECT_VERSION == "3.2" && $WM_FORK == "extend" ]]; then export CFDEM_WM_PROJECT_VERSION=132 +else + clear + echo "************************************" + echo "ERROR from your CFDEM code!" + echo "ERROR: your OpenFOAM(R) version is not supported!" + echo "Please use a version that is supported, i.e., see the bashrc file in the source directory!" + echo "************************************" + sleep 1.5 fi diff --git a/src/lagrangian/cfdemParticle/etc/cfdemSystemTest.sh b/src/lagrangian/cfdemParticle/etc/cfdemSystemTest.sh index 66b686a..eb05dcf 100755 --- a/src/lagrangian/cfdemParticle/etc/cfdemSystemTest.sh +++ b/src/lagrangian/cfdemParticle/etc/cfdemSystemTest.sh @@ -25,6 +25,7 @@ echo "CFDEM_VERSION=$CFDEM_VERSION" echo "couple to OF_VERSION=$WM_PROJECT_VERSION" echo "compile option=$WM_COMPILE_OPTION" + echo echo "check if paths are set correctly" checkDirComment "$CFDEM_PROJECT_DIR" '$CFDEM_PROJECT_DIR' "yes" @@ -45,6 +46,10 @@ echo '$CFDEM_LIGGGHTS_LIB_NAME = '"$CFDEM_LIGGGHTS_LIB_NAME" echo '$CFDEM_LIB_NAME = '"$CFDEM_LIB_NAME" echo '$LD_LIBRARY_PATH = '"$LD_LIBRARY_PATH" echo '$WM_NCOMPPROCS = '"$WM_NCOMPPROCS" +echo '$WM_LABEL_SIZE = '"$WM_LABEL_SIZE" +if [ $WM_LABEL_SIZE != 32 ]; then + echo "!!!! Warning: WM_LABEL_SIZE must be 32!!!!! (Please correct in $FOAM_ETC/bashrc.)" +fi echo "*******************" diff --git a/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling.sh b/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling.sh index 9792a1a..b51b202 100755 --- a/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling.sh +++ b/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling.sh @@ -18,14 +18,14 @@ mkdir -p $logDir #================================================================================# # compile src #================================================================================# -bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_src.sh +. $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_src.sh #================================================================================# # compile solvers #================================================================================# -bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_sol.sh +. $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_sol.sh #================================================================================# # compile utilities #================================================================================# -bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_uti.sh +. $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_uti.sh diff --git a/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_all.sh b/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_all.sh index 445712a..d9c1c5b 100755 --- a/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_all.sh +++ b/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_all.sh @@ -19,9 +19,9 @@ mkdir -p $logDir #================================================================================# # compile LIGGGHTS src + libraries #================================================================================# -bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileLIGGGHTS.sh +. $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileLIGGGHTS.sh #================================================================================# # compile CFDEMcoupling #================================================================================# -bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling.sh +. $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compileCFDEMcoupling.sh diff --git a/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_sol.sh b/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_sol.sh index b80c0f4..ae807ee 100755 --- a/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_sol.sh +++ b/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_sol.sh @@ -9,6 +9,7 @@ whitelist="solver-list.txt" #- include functions source $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/functions.sh + logDir="log" cd $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc mkdir -p $logDir @@ -63,7 +64,7 @@ else echo "do compilation in serial" else nsteps=$WM_NCOMPPROCS - nchunk=`echo $njobs/$nsteps+1 | bc` + let nchunk=$njobs/$nsteps+1 echo "do compilation on $nsteps procs in $nchunk chunks" let nchunk++ # +1, to wait for the last compilation too fi @@ -74,7 +75,8 @@ else #wait until prev. compilation is finished echo "waiting..." - until [ `ps -a | grep make | wc -l` -eq 0 ]; + #until [ `ps -a | grep make | wc -l` -eq 0 ]; + until [ `ls -a | $logpath/grep *.tempXYZ | wc -l` -eq 0 ]; do sleep 2 done @@ -127,7 +129,8 @@ fi #wait until prev. compilation is finished echo "waiting..." -until [ `ps -a | grep make | wc -l` -eq 0 ]; +#until [ `ps -a | grep make | wc -l` -eq 0 ]; +until [ `ls -a | grep $logpath/*.tempXYZ | wc -l` -eq 0 ]; do sleep 2 done diff --git a/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_uti.sh b/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_uti.sh index 360b167..22a7cde 100755 --- a/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_uti.sh +++ b/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_uti.sh @@ -9,6 +9,7 @@ whitelist="utilities-list.txt" #- include functions source $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/functions.sh + logDir="log" cd $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc mkdir -p $logDir @@ -36,6 +37,11 @@ echo "example:" echo "cfdemPostproc/dir" echo "" +#- create a tmp file and delete comments in it - work with tmp file then. +cp $whitelist "tmpFile.txt" +sed -i '/^#/d' "tmpFile.txt" +whitelist="tmpFile.txt" + if [ ! -f "$CWD/$whitelist" ];then echo "$whitelist does not exist in $CWD" else @@ -54,7 +60,7 @@ else echo "do compilation in serial" else nsteps=$WM_NCOMPPROCS - nchunk=`echo $njobs/$nsteps+1 | bc` + let nchunk=$njobs/$nsteps+1 echo "do compilation on $nsteps procs in $nchunk chunks" let nchunk++ # +1, to wait for the last compilation too fi @@ -65,7 +71,8 @@ else #wait until prev. compilation is finished echo "waiting..." - until [ `ps -a | grep make | wc -l` -eq 0 ]; + #until [ `ps -a | grep make | wc -l` -eq 0 ]; + until [ `ls -a | $logpath/grep *.tempXYZ | wc -l` -eq 0 ]; do sleep 2 done @@ -100,16 +107,25 @@ else parallel="true" #--------------------------------------------------------------------------------# - #echo "compiling $LINE" + echo "compiling $LINE" compileSolver $logpath $logfileName $casePath $headerText $parallel let counter++ fi done - sleep 1 # wait a second until compilation starts + #sleep 1 # wait a second until compilation starts done echo "compilation done." fi +#wait until prev. compilation is finished +echo "waiting..." +#until [ `ps -a | grep make | wc -l` -eq 0 ]; +until [ `ls -a | grep $logpath/*.tempXYZ | wc -l` -eq 0 ]; +do + sleep 2 +done + +rm "$CWD/tmpFile.txt" \ No newline at end of file diff --git a/src/lagrangian/cfdemParticle/etc/cshrc b/src/lagrangian/cfdemParticle/etc/cshrc index 08c1306..0d413b7 100755 --- a/src/lagrangian/cfdemParticle/etc/cshrc +++ b/src/lagrangian/cfdemParticle/etc/cshrc @@ -181,8 +181,8 @@ alias cfdemCompCFDEMuti 'bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/compil alias cfdemTestTUT 'bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/testTutorials.sh' #- shortcut to change dictionaries according to OF version -cfdemChangeTutOFversion() { bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/OFVersionChange/shellScripts/cfdemChangeTutOFversion_all.sh $1; } -export -f cfdemChangeTutOFversion +#cfdemChangeTutOFversion() { bash $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/OFVersionChange/shellScripts/cfdemChangeTutOFversion_all.sh $1; } +#export -f cfdemChangeTutOFversion #- shortcut to visualize the clock model data alias vizClock 'python $CFDEM_UT_DIR/vizClock/matPlot.py' @@ -223,10 +223,28 @@ else endif # detect OF version -if ( $WM_PROJECT_VERSION == "3.0.x" ) then +if ( $WM_PROJECT_VERSION =~ "4.*" ) then + setenv CFDEM_WM_PROJECT_VERSION 40 + echo "************************************" + echo "WARNING from your CFDEM code!" + echo "WARNING: Coupling with your OpenFOAM(R) version is currently under development!" + echo "In doubt switch to another version." + echo "************************************" + sleep 1.5 +else if ( $WM_PROJECT_VERSION =~ "3.0.*" ) then setenv CFDEM_WM_PROJECT_VERSION 30 -else if ( $WM_PROJECT_VERSION == "2.4.x" ) then +else if ( $WM_PROJECT_VERSION =~ "2.4.*" ) then setenv CFDEM_WM_PROJECT_VERSION 24 -else if ( $WM_PROJECT_VERSION == "3.2" && $WM_FORK == "extend" ) then - setenv CFDEM_WM_PROJECT_VERSION 132 +else if ( $WM_PROJECT_VERSION == "3.2" ) then + if ( $WM_FORK == "extend" ) then + setenv CFDEM_WM_PROJECT_VERSION 132 + endif +else + clear + echo "************************************" + echo "ERROR from your CFDEM code!" + echo "ERROR: your openFOAM(R)s version is not supported!" + echo "Please use a version that is supported, i.e., see the bashrc file in the source directory!" + echo "************************************" + sleep 1.5 endif diff --git a/src/lagrangian/cfdemParticle/etc/functions.sh b/src/lagrangian/cfdemParticle/etc/functions.sh index 1a72d88..c219c87 100755 --- a/src/lagrangian/cfdemParticle/etc/functions.sh +++ b/src/lagrangian/cfdemParticle/etc/functions.sh @@ -80,7 +80,7 @@ compileLib() echo "Please make sure to have the incompressible libraries first in the library-list.txt!" cd $CFDEM_SRC_DIR/lagrangian/cfdemParticle echo "changing to $PWD" - if [[ $WM_PROJECT_VERSION == "dev" || $WM_PROJECT_VERSION == "3.0.x" ]]; then + if [[ $WM_PROJECT_VERSION == dev || $WM_PROJECT_VERSION == 3.0.* || $WM_PROJECT_VERSION == 4.* ]]; then wrmdep 2>&1 | tee -a $logpath/$logfileName else rmdepall 2>&1 | tee -a $logpath/$logfileName @@ -90,12 +90,13 @@ compileLib() else echo "Compiling a incompressible library." fi - if [[ $WM_PROJECT_VERSION == "dev" || $WM_PROJECT_VERSION == "3.0.x" ]]; then + if [[ $WM_PROJECT_VERSION == dev || $WM_PROJECT_VERSION == 3.0.* || $WM_PROJECT_VERSION == 4.* ]]; then wrmdep 2>&1 | tee -a $logpath/$logfileName else rmdepall 2>&1 | tee -a $logpath/$logfileName fi wclean 2>&1 | tee -a $logpath/$logfileName + rm -r $casePath/Make/cfdemParticle #fi wmake libso 2>&1 | tee -a $logpath/$logfileName @@ -142,7 +143,7 @@ compileSolver() else #- wclean and wmake #if [ $doClean != "noClean" ]; then - if [[ $WM_PROJECT_VERSION == "dev" || $WM_PROJECT_VERSION == "3.0.x" ]]; then + if [[ $WM_PROJECT_VERSION == dev || $WM_PROJECT_VERSION == 3.0.* || $WM_PROJECT_VERSION == 4.* ]]; then wrmdep 2>&1 | tee -a $logpath/$logfileName else rmdepall 2>&1 | tee -a $logpath/$logfileName @@ -153,9 +154,14 @@ compileSolver() # compile parallel? if [[ $parallel == "true" ]]; then + touch $logpath/$logfileName.tempXYZ wmake 2>&1 | tee -a $logpath/$logfileName #& + rm $logpath/$logfileName.tempXYZ else + touch $logpath/$logfileName.tempXYZ wmake 2>&1 | tee -a $logpath/$logfileName + rm $logpath/$logfileName.tempXYZ + fi #- keep terminal open @@ -237,11 +243,11 @@ compileLMPlib() fi #Just check if library is there and and abort if not - if [ $compilationModeSwitch == "false" ]; then + if [[ $compilationModeSwitch == "false" ]]; then if [ -d "$libraryPath" ]; then echo "lib path $libraryPath EXISTS!" - cd $libraryPath - if [ -e *.a ]; then + libraries=$(ls ${libraryPath}/*.a 2> /dev/null | wc -l) + if [[ $libraries != "0" ]]; then echo "... and contains the following libraries: " ls $libraryPath/*.a echo "Congratulations! Check passed! " @@ -257,7 +263,7 @@ compileLMPlib() fi fi else - if [ $compilationModeSwitch == "noClean" ]; then + if [[ $compilationModeSwitch == "noClean" ]]; then echo "compileLMPlib will skip the cleaning step!" echo "" else @@ -279,7 +285,7 @@ compileLMPlib() bash Install.sh 0 2>&1 | tee -a $logpath/$logfileName bash Install.sh 1 2>&1 | tee -a $logpath/$logfileName else - if [ $compilationModeSwitch == "noClean" ]; then + if [[ $compilationModeSwitch == "noClean" ]]; then echo "compileLMPlib will skip the cleaning step!" echo "" else @@ -344,7 +350,7 @@ cleanCFDEM() cd $path echo "cleaning library $PWD" - if [[ $WM_PROJECT_VERSION == "dev" || $WM_PROJECT_VERSION == "3.0.x" ]]; then + if [[ $WM_PROJECT_VERSION == dev || $WM_PROJECT_VERSION == 3.0.* || $WM_PROJECT_VERSION == 4.* ]]; then wrmdep else rmdepall @@ -402,7 +408,7 @@ cleanCFDEM() cd $path echo "cleaning solver $PWD" - if [[ $WM_PROJECT_VERSION == "dev" || $WM_PROJECT_VERSION == "3.0.x" ]]; then + if [[ $WM_PROJECT_VERSION == dev || $WM_PROJECT_VERSION == 3.0.* || $WM_PROJECT_VERSION == 4.* ]]; then wrmdep else rmdepall @@ -451,12 +457,12 @@ DEMrun() debugMode="$6" #--------------------------------------------------------------------------------# - if [ $debugMode == "on" ]; then + if [[ $debugMode == "on" ]]; then debugMode="valgrind" - elif [ $debugMode == "strict" ]; then + elif [[ $debugMode == "strict" ]]; then #debugMode="valgrind --leak-check=full -v --trace-children=yes --track-origins=yes" debugMode="valgrind --tool=memcheck --track-origins=yes --leak-check=yes --show-reachable=yes --num-callers=20 --track-fds=yes" - elif [ $debugMode == "strictXML" ]; then + elif [[ $debugMode == "strictXML" ]]; then #debugMode="valgrind --leak-check=full -v --trace-children=yes --track-origins=yes" 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" else @@ -503,12 +509,12 @@ parDEMrun() debugMode="$8" #--------------------------------------------------------------------------------# - if [ $debugMode == "on" ]; then + if [[ $debugMode == "on" ]]; then debugMode="valgrind" - elif [ $debugMode == "strict" ]; then + elif [[ $debugMode == "strict" ]]; then #debugMode="valgrind --leak-check=full -v --trace-children=yes --track-origins=yes" debugMode="valgrind --tool=memcheck --track-origins=yes --leak-check=yes --show-reachable=yes --num-callers=20 --track-fds=yes" - elif [ $debugMode == "strictXML" ]; then + elif [[ $debugMode == "strictXML" ]]; then #debugMode="valgrind --leak-check=full -v --trace-children=yes --track-origins=yes" 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" else @@ -531,7 +537,7 @@ parDEMrun() echo 2>&1 | tee -a $logpath/$logfileName #- run applictaion - if [ $machineFileName == "none" ]; then + if [[ $machineFileName == "none" ]]; then mpirun -np $nrProcs $debugMode $CFDEM_LIGGGHTS_SRC_DIR/$CFDEM_LIGGGHTS_LIB_NAME < $solverName 2>&1 | tee -a $logpath/$logfileName else mpirun -machinefile $machineFileName -np $nrProcs $debugMode $CFDEM_LIGGGHTS_SRC_DIR/$CFDEM_LIGGGHTS_LIB_NAME < $solverName 2>&1 | tee -a $logpath/$logfileName @@ -557,7 +563,7 @@ CFDrun() debugMode="$6" #--------------------------------------------------------------------------------# - if [ $debugMode == "on" ]; then + if [[ $debugMode == "on" ]]; then debugMode="valgrind" else debugMode="" @@ -605,7 +611,7 @@ parCFDrun() debugMode="$8" #--------------------------------------------------------------------------------# - if [ $debugMode == "on" ]; then + if [[ $debugMode == "on" ]]; then debugMode="valgrind" else debugMode="" @@ -641,7 +647,7 @@ parCFDrun() echo 2>&1 | tee -a $logpath/$logfileName #- run applictaion - if [ $machineFileName == "none" ]; then + if [[ $machineFileName == "none" ]]; then mpirun -np $nrProcs $debugMode $solverName -parallel 2>&1 | tee -a $logpath/$logfileName else mpirun -machinefile $machineFileName -np $nrProcs $debugMode $solverName -parallel 2>&1 | tee -a $logpath/$logfileName @@ -669,17 +675,18 @@ parCFDDEMrun() debugMode="$8" reconstuctCase="$9" decomposeCase=${10} + remoteStorageLocation=${11} #--------------------------------------------------------------------------------# - if [ $debugMode == "on" ]; then + if [[ $debugMode == "on" ]]; then debugMode="valgrind" - elif [ $debugMode == "strict" ]; then + elif [[ $debugMode == "strict" ]]; then #debugMode="valgrind --leak-check=full -v --trace-children=yes --track-origins=yes" debugMode="valgrind --tool=memcheck --track-origins=yes --leak-check=yes --show-reachable=yes --num-callers=20 --track-fds=yes" - elif [ $debugMode == "strictXML" ]; then + elif [[ $debugMode == "strictXML" ]]; then #debugMode="valgrind --leak-check=full -v --trace-children=yes --track-origins=yes" 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" - elif [ $debugMode == "profile" ]; then + elif [[ $debugMode == "profile" ]]; then # make sure you did hpcstruct before debugMode="hpcrun" rm -r $casePath/CFD/hpctoolkit-$solverName-measurements @@ -698,10 +705,14 @@ parCFDDEMrun() echo "Not decomposing case." else echo "Decomposing case." - #- remove old data - rm -rf processor* + decomposePar -force - decomposePar + if [[ $remoteStorageLocation == "" ]]; then + echo "do nothing." + else + echo "do links" + linkProcDirs $remoteStorageLocation + fi fi #- make proc dirs visible @@ -745,8 +756,7 @@ parCFDDEMrun() if [[ $debugMode == "hpcrun" ]]; then rm hpctoolkit-$solverName-database* - hpcprof -S $CFDEM_APP_DIR/$solverName.hpcstruct -I ./'*' hpctoolkit-$solverName-measurements - echo "huhu" + hpcprof -S $CFDEM_APP_DIR/$solverName.hpcstruct -I ./'*' hpctoolkit-$solverName-measurements fi #- keep terminal open (if started in new terminal) @@ -871,7 +881,7 @@ pseudoParallelRun() outputfile="log.$appname" #--------------------------------------------------------------------------------# -if [ -z "$njobs" ]; then +if [[ -z "$njobs" ]]; then echo "" echo " K. Wardle 6/22/09" echo " bash script to run reconstructPar (or other fct) in pseudo-parallel mode" @@ -895,7 +905,7 @@ echo "do $appname on $nsteps time directories" #echo "nsteps= $nsteps" #let nsteps=$nsteps1-1 -nchunk=`echo $nsteps/$njobs+1 | bc` +let nchunk=$nsteps/$njobs+1 #echo "nchunk = $nchunk" #find max time @@ -913,9 +923,9 @@ p=p for i in `seq $njobs` do - nn=`echo $i*$nchunk | bc` + let nn=$i*$nchunk tstop=`ls processor0 | sed -n $nn$p` - if [ $i == $njobs ] + if [[ $i == $njobs ]] then tstop=$tmax fi @@ -934,10 +944,10 @@ until [ `ps -C $appname | wc -l` -eq 1 ]; do sleep 10 ## n1=`ps -C $appname | wc -l` -## n2=`echo $n1-1 | bc` +## let n2=$n1-1 nnow=`ls -d [0-9]*/ | wc -l` ##count time directories in case root dir, this will include 0 - nmore=`echo $nsteps-$nnow+1 | bc` ##calculate number left to reconstruct and subtract 0 dir - if [ $nmore != $nmore_old ] + let nmore=$nsteps-$nnow+1 ##calculate number left to reconstruct and subtract 0 dir + if [[ $nmore != $nmore_old ]] then echo "$nmore directories remaining..." fi @@ -945,7 +955,7 @@ until [ `ps -C $appname | wc -l` -eq 1 ]; done #combine and cleanup -if [ -n "$outputfile" ] +if [[ -n "$outputfile" ]] then #check if output file already exists if [ -e "$outputfile" ] @@ -1108,7 +1118,7 @@ trackMem() do CMD=$(/bin/ps -o comm -p $PID | /usr/bin/tail -1) - if [ $CMD == $appname ] + if [[ $CMD == $appname ]] then TOTAL=$(/usr/bin/pmap $PID 2>/dev/null | /usr/bin/tail -1 | /usr/bin/awk '{ print $2 }') @@ -1124,11 +1134,81 @@ removeBracketsFromFile() #--------------------------------------------------------------------------------# #- define variables oldFileName="$1" - newFileName="$oldFileName""_noBrackets" + overwrite="$2" #--------------------------------------------------------------------------------# - sed -e 's/[(,)]//g' $oldFileName > $newFileName + if [[ $overwrite == "true" ]] + then + sed -i 's/[(,)]//g' $oldFileName + else + newFileName="$oldFileName""_noBrackets" + sed -e 's/[(,)]//g' $oldFileName > $newFileName + fi } +#========================================# +#- remove brackets from file +linkProcDirs() +{ + #--------------------------------------------------------------------------------# + #- define variables + remoteDir="$1" + #--------------------------------------------------------------------------------# + # check remote directory exist + if [[ -d "$remoteDir" ]] + then + echo " $remoteDir exists - **check**" + else + Fatal "ERROR: remote directory does not exist: $remoteDir" + fi + # check case is decomposed + if [[ -d "processor0" ]] + then + echo " case is decomposed - **check**" + else + Fatal "ERROR: case is NOT decomposed - please do so and run again." + fi + + # check CFD dir exists at remote location + if [[ -d $remoteDir/CFD ]] + then + Fatal "ERROR: there is (!) a dir called CFD at $remoteDir - please rename it and run again." + else + echo " there is no dir called CFD at $remoteDir - **check**" + fi + + # create a dir CFD at remoteDir + mkdir $remoteDir/CFD + + # create a backup dir oldProcDirs + mkdir oldProcDirs + + # check if oldProcDirs is empty + if [[ -d oldProcDirs/processor0 ]] + then + Fatal "ERROR: ./oldProcDirs is not empty - please clean up and run again." + else + echo " ./oldProcDirs is empty - **check**" + fi + + # moving proc dirs to oldProcsDir (backup) + cp -r processor* $remoteDir/CFD + mv processor* oldProcDirs + + # create a link to remote proc dirs + counter=0 + for procDir in $remoteDir/CFD/*/; do + ln -s $remoteDir/CFD/processor$counter processor$counter + counter=$[counter + 1] + done + + # create a link to postProcessing dir + mkdir postProcessing + mv postProcessing $remoteDir/CFD + ln -s $remoteDir/CFD/postProcessing postProcessing + + # success + echo "linking was successful" +} diff --git a/src/lagrangian/cfdemParticle/etc/library-liggghts-list.txt b/src/lagrangian/cfdemParticle/etc/library-liggghts-list.txt deleted file mode 100644 index bb409f7..0000000 --- a/src/lagrangian/cfdemParticle/etc/library-liggghts-list.txt +++ /dev/null @@ -1,3 +0,0 @@ -#syntax: makefileName/dir -#note: dir is not a path, just a keyword here -############################################### diff --git a/src/lagrangian/cfdemParticle/etc/library-list.txt b/src/lagrangian/cfdemParticle/etc/library-list.txt deleted file mode 100644 index 59f9fe9..0000000 --- a/src/lagrangian/cfdemParticle/etc/library-list.txt +++ /dev/null @@ -1,2 +0,0 @@ -lagrangian/cfdemParticle/dir -eulerian/scalarTransportModelsCFDEM/dir diff --git a/src/lagrangian/cfdemParticle/etc/solver-list.txt b/src/lagrangian/cfdemParticle/etc/solver-list.txt deleted file mode 100644 index 41ca4d9..0000000 --- a/src/lagrangian/cfdemParticle/etc/solver-list.txt +++ /dev/null @@ -1,4 +0,0 @@ -cfdemSolverPiso/dir -cfdemSolverIB/dir -cfdemSolverPisoScalar/dir -cfdemSolverPisoSTM/dir diff --git a/src/lagrangian/cfdemParticle/etc/tutorial-list.txt b/src/lagrangian/cfdemParticle/etc/tutorial-list.txt deleted file mode 100644 index c287909..0000000 --- a/src/lagrangian/cfdemParticle/etc/tutorial-list.txt +++ /dev/null @@ -1,22 +0,0 @@ - -#===================================================================# -# This file specifies the example cases being executed by -# .../etc/testTutorial.sh , which can be run with the alias -# cfdemTestTUT -# Christoph Goniva - June. 2011, DCS Computing GmbH -#===================================================================# - -cfdemSolverPiso/settlingTestMPI/dir - -cfdemSolverPiso/ErgunTestMPI/dir - -cfdemSolverPiso/ErgunTestMPI_cgs/dir - -cfdemSolverPiso/ErgunTestMPI_restart/dir -cfdemSolverPiso/voidfractionTest/dir - -cfdemSolverIB/twoSpheresGlowinskiMPI/dir - -cfdemSolverPisoScalar/packedBedTemp/dir - -cfdemSolverPisoSTM/packedBedTemp/dir diff --git a/src/lagrangian/cfdemParticle/etc/utilities-list.txt b/src/lagrangian/cfdemParticle/etc/utilities-list.txt deleted file mode 100644 index a8ac78b..0000000 --- a/src/lagrangian/cfdemParticle/etc/utilities-list.txt +++ /dev/null @@ -1 +0,0 @@ -cfdemPostproc/dir diff --git a/src/lagrangian/cfdemParticle/subModels/averagingModel/averagingModel/averagingModel.C b/src/lagrangian/cfdemParticle/subModels/averagingModel/averagingModel/averagingModel.C index 1e4ea73..cd35eb9 100644 --- a/src/lagrangian/cfdemParticle/subModels/averagingModel/averagingModel/averagingModel.C +++ b/src/lagrangian/cfdemParticle/subModels/averagingModel/averagingModel/averagingModel.C @@ -59,7 +59,7 @@ void averagingModel::undoVectorAverage { // WARNING - not sure if this is valid for dilute model!!! - if(!single) fieldPrev.internalField() = fieldNext.internalField(); + if(!single) fieldPrev == fieldNext; label cellI; vector valueVec; @@ -294,13 +294,13 @@ void averagingModel::setDSauter void averagingModel::resetVectorAverage(volVectorField& prev,volVectorField& next,bool single) const { - if(!single) prev.internalField() = next.internalField(); - next.internalField() = vector::zero; + if(!single) prev == next; + next == dimensionedVector("zero", next.dimensions(), vector::zero); } void averagingModel::resetWeightFields() const { - UsWeightField_.internalField() = 0; + UsWeightField_ == dimensionedScalar("zero", UsWeightField_.dimensions(), 0.0); } @@ -319,39 +319,20 @@ void Foam::averagingModel::undoWeightFields(double**const& mask) const tmp Foam::averagingModel::UsInterp() const { - tmp tsource - ( - new volVectorField - ( - IOobject - ( - "Us_averagingModel", - particleCloud_.mesh().time().timeName(), - particleCloud_.mesh(), - IOobject::NO_READ, - IOobject::NO_WRITE - ), - particleCloud_.mesh(), - dimensionedVector - ( - "zero", - dimensionSet(0, 1, -1, 0, 0), - vector::zero - ) - ) - ); - if (particleCloud_.dataExchangeM().couplingStep() > 1) { - tsource() = (1 - particleCloud_.dataExchangeM().timeStepFraction()) * UsPrev_ - + particleCloud_.dataExchangeM().timeStepFraction() * UsNext_; + return tmp + ( + new volVectorField("Us_averagingModel", (1 - particleCloud_.dataExchangeM().timeStepFraction()) * UsPrev_ + particleCloud_.dataExchangeM().timeStepFraction() * UsNext_) + ); } else { - tsource() = UsNext_; + return tmp + ( + new volVectorField("Us_averagingModel", UsNext_) + ); } - - return tsource; } // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // diff --git a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/dataExchangeModel/dataExchangeModel.H b/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/dataExchangeModel/dataExchangeModel.H index a1794f6..a11956e 100755 --- a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/dataExchangeModel/dataExchangeModel.H +++ b/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/dataExchangeModel/dataExchangeModel.H @@ -203,8 +203,11 @@ public: Info << "particleCloud_.mesh().time().deltaT().value() = " << particleCloud_.mesh().time().deltaT().value() << endl; Info << "couplingInterval_ = " << couplingInterval_ << endl; Info << "DEMts_ = " << DEMts_ << endl; - FatalError<<"\nError - TS bigger than coupling interval!\n"<< abort(FatalError); + FatalError<<"\nError - CFD time-step bigger than coupling time (= DEM time step * coupling interval)!\n"<< abort(FatalError); } + if(!particleCloud_.allowCFDsubTimestep()) + if(particleCloud_.mesh().time().deltaT().value() < couplingInterval_ * DEMts_ + SMALL) + FatalError<<"\nYour models require: CFD time-step = coupling interval (= DEM time step * coupling interval)! \n"<< abort(FatalError); } /*inline bool checkExactTiming() const diff --git a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayMPI/twoWayMPI.C b/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayMPI/twoWayMPI.C index 03c3a9d..15c2d1a 100644 --- a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayMPI/twoWayMPI.C +++ b/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayMPI/twoWayMPI.C @@ -110,7 +110,7 @@ void twoWayMPI::getData { char* charName = wordToChar(name); char* charType = wordToChar(type); - data_liggghts_to_of(charName,charType, lmp, (void*&) field,"double"); + data_liggghts_to_of(charName,charType, lmp, (void*&) field, (char *)"double"); } void twoWayMPI::getData @@ -123,7 +123,7 @@ void twoWayMPI::getData { char* charName = wordToChar(name); char* charType = wordToChar(type); - data_liggghts_to_of(charName,charType, lmp, (void*&) field,"int"); + data_liggghts_to_of(charName,charType, lmp, (void*&) field, (char *)"int"); } void twoWayMPI::giveData @@ -232,7 +232,6 @@ bool Foam::twoWayMPI::couple(int i) const DynamicList interruptTimes(0); DynamicList DEMstepsToInterrupt(0); DynamicList lcModel(0); - scalar interruptTime = -1; forAll(particleCloud_.liggghtsCommandModelList(),i) { diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/Archimedes/Archimedes.C b/src/lagrangian/cfdemParticle/subModels/forceModel/Archimedes/Archimedes.C index 4722a8c..89360ba 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/Archimedes/Archimedes.C +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/Archimedes/Archimedes.C @@ -77,7 +77,7 @@ Archimedes::Archimedes probeIt_=!Switch(propsDict_.lookup("suppressProbe")); if(probeIt_) { - particleCloud_.probeM().initialize(typeName, "archimedesF.logDat"); + particleCloud_.probeM().initialize(typeName, typeName+".logDat"); particleCloud_.probeM().vectorFields_.append("archimedesForce"); //first entry must the be the force particleCloud_.probeM().scalarFields_.append("Vp"); particleCloud_.probeM().writeHeader(); @@ -94,6 +94,7 @@ Archimedes::Archimedes // define switches which can be read from dict (default = false) forceSubM(0).setSwitchesList(1,true); // activate treatForceDEM switch (DEM side only treatment) + forceSubM(0).setSwitchesList(3,true); // activate search for verbose switch //set default switches (hard-coded default = false) forceSubM(0).setSwitches(1,true); // will treat forces on DEM side only - IMPORTANT! @@ -129,51 +130,56 @@ Archimedes::~Archimedes() void Archimedes::setForce() const { vector force(0,0,0); + scalar piBySix(M_PI/6.); + scalar Vs(0.); + scalar ds(0.); #include "setupProbeModel.H" for(int index = 0;index < particleCloud_.numberOfParticles(); ++index) { - //if(mask[index][0]) - //{ - label cellI = particleCloud_.cellIDs()[index][0]; - force=vector::zero; + label cellI = particleCloud_.cellIDs()[index][0]; + force=vector::zero; - if (cellI > -1) // particle Found + if (cellI > -1) // particle Found + { + if(twoDimensional_) { - if(twoDimensional_) - { - scalar r = particleCloud_.radius(index); - force = -g_.value()*forceSubM(0).rhoField()[cellI]*r*r*M_PI; // circle area - Warning << "Archimedes::setForce() : this functionality is not tested!" << endl; - }else{ - force = -g_.value()*forceSubM(0).rhoField()[cellI]*particleCloud_.particleVolume(index); - } - - //if(index >=0 && index <100) - //{ - // Pout << "cellI = " << cellI << endl; - // Pout << "index = " << index << endl; - // Pout << "forceSubM(0).rhoField()[cellI] = " << forceSubM(0).rhoField()[cellI] << endl; - // Pout << "particleCloud_.particleVolume(index) = " << particleCloud_.particleVolume(index) << endl; - // Pout << "force = " << force << endl; - //} - - //Set value fields and write the probe - if(probeIt_) - { - #include "setupProbeModelfields.H" - // Note: for other than ext one could use vValues.append(x) - // instead of setSize - vValues.setSize(vValues.size()+1, force); //first entry must the be the force - sValues.setSize(sValues.size()+1, particleCloud_.particleVolume(index)); - particleCloud_.probeM().writeProbe(index, sValues, vValues); - } + scalar r = particleCloud_.radius(index); + force = -g_.value()*forceSubM(0).rhoField()[cellI]*r*r*M_PI; // circle area + Warning << "Archimedes::setForce() : this functionality is not tested!" << endl; + }else{ + ds = particleCloud_.d(index); + scalar dParcel = ds; + forceSubM(0).scaleDia(dParcel); //caution: this fct will scale ds! + Vs = dParcel*dParcel*dParcel*piBySix; + force = -g_.value()*forceSubM(0).rhoField()[cellI]*Vs; + forceSubM(0).scaleForce(force,ds); } - // write particle based data to global array - forceSubM(0).partToArray(index,force,vector::zero); - //} + if(forceSubM(0).verbose() && index >=0 && index <2) + { + Pout << "cellI = " << cellI << endl; + Pout << "index = " << index << endl; + Pout << "forceSubM(0).rhoField()[cellI] = " << forceSubM(0).rhoField()[cellI] << endl; + Pout << "particleCloud_.particleVolume(index) = " << particleCloud_.particleVolume(index) << endl; + Pout << "force = " << force << endl; + } + + //Set value fields and write the probe + if(probeIt_) + { + #include "setupProbeModelfields.H" + // Note: for other than ext one could use vValues.append(x) + // instead of setSize + vValues.setSize(vValues.size()+1, force); //first entry must the be the force + sValues.setSize(sValues.size()+1, particleCloud_.particleVolume(index)); + particleCloud_.probeM().writeProbe(index, sValues, vValues); + } + } + + // write particle based data to global array + forceSubM(0).partToArray(index,force,vector::zero); } } diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/ArchimedesIB/ArchimedesIB.C b/src/lagrangian/cfdemParticle/subModels/forceModel/ArchimedesIB/ArchimedesIB.C index 0c85072..38155da 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/ArchimedesIB/ArchimedesIB.C +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/ArchimedesIB/ArchimedesIB.C @@ -73,7 +73,7 @@ ArchimedesIB::ArchimedesIB #endif { //Append the field names to be probed - particleCloud_.probeM().initialize(typeName, "archimedesIBF.logDat"); + particleCloud_.probeM().initialize(typeName, typeName+".logDat"); particleCloud_.probeM().vectorFields_.append("archimedesIBForce"); //first entry must the be the force particleCloud_.probeM().writeHeader(); diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/DiFeliceDrag/DiFeliceDrag.C b/src/lagrangian/cfdemParticle/subModels/forceModel/DiFeliceDrag/DiFeliceDrag.C index 72ef958..0969bf3 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/DiFeliceDrag/DiFeliceDrag.C +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/DiFeliceDrag/DiFeliceDrag.C @@ -67,16 +67,14 @@ DiFeliceDrag::DiFeliceDrag voidfractionFieldName_(propsDict_.lookup("voidfractionFieldName")), voidfraction_(sm.mesh().lookupObject (voidfractionFieldName_)), UsFieldName_(propsDict_.lookup("granVelFieldName")), - UsField_(sm.mesh().lookupObject (UsFieldName_)), - scaleDia_(1.), - scaleDrag_(1.) + UsField_(sm.mesh().lookupObject (UsFieldName_)) { // suppress particle probe if (probeIt_ && propsDict_.found("suppressProbe")) probeIt_=!Switch(propsDict_.lookup("suppressProbe")); if(probeIt_) { - particleCloud_.probeM().initialize(typeName, "diFeliceDrag.logDat"); + particleCloud_.probeM().initialize(typeName, typeName+".logDat"); particleCloud_.probeM().vectorFields_.append("dragForce"); //first entry must the be the force particleCloud_.probeM().vectorFields_.append("Urel"); //other are debug particleCloud_.probeM().scalarFields_.append("Rep"); //other are debug @@ -86,10 +84,6 @@ DiFeliceDrag::DiFeliceDrag } particleCloud_.checkCG(true); - if (propsDict_.found("scale")) - scaleDia_=scalar(readScalar(propsDict_.lookup("scale"))); - if (propsDict_.found("scaleDrag")) - scaleDrag_=scalar(readScalar(propsDict_.lookup("scaleDrag"))); // init force sub model setForceSubModels(propsDict_); @@ -117,13 +111,6 @@ DiFeliceDrag::~DiFeliceDrag() void DiFeliceDrag::setForce() const { - if (scaleDia_ > 1) - Info << typeName << " using scale = " << scaleDia_ << endl; - else if (particleCloud_.cg() > 1){ - scaleDia_=particleCloud_.cg(); - Info << typeName << " using scale from liggghts cg = " << scaleDia_ << endl; - } - const volScalarField& nufField = forceSubM(0).nuField(); const volScalarField& rhoField = forceSubM(0).rhoField(); @@ -141,6 +128,7 @@ void DiFeliceDrag::setForce() const vector Us(0,0,0); vector Ur(0,0,0); scalar ds(0); + scalar dParcel(0); scalar nuf(0); scalar rho(0); scalar magUr(0); @@ -165,6 +153,11 @@ void DiFeliceDrag::setForce() const position = particleCloud_.position(index); voidfraction = voidfractionInterpolator_().interpolate(position,cellI); Ufluid = UInterpolator_().interpolate(position,cellI); + + //Ensure interpolated void fraction to be meaningful + // Info << " --> voidfraction: " << voidfraction << endl; + if(voidfraction>1.00) voidfraction = 1.00; + if(voidfraction<0.30) voidfraction = 0.30; }else { voidfraction = voidfraction_[cellI]; @@ -172,12 +165,15 @@ void DiFeliceDrag::setForce() const } Us = particleCloud_.velocity(index); + ds = 2*particleCloud_.radius(index); + dParcel = ds; + forceSubM(0).scaleDia(ds); //caution: this fct will scale ds! //Update any scalar or vector quantity for (int iFSub=0;iFSub-1 && index <102) { Pout << "index = " << index << endl; - Pout << "scaleDrag_ = " << scaleDrag_ << endl; Pout << "Us = " << Us << endl; Pout << "Ur = " << Ur << endl; - Pout << "ds/scale = " << ds/scaleDia_ << endl; + Pout << "dprim = " << ds << endl; + Pout << "dParcel = " << dParcel << endl; Pout << "rho = " << rho << endl; Pout << "nuf = " << nuf << endl; Pout << "voidfraction = " << voidfraction << endl; Pout << "Rep = " << Rep << endl; Pout << "Cd = " << Cd << endl; + Pout << "dragCoefficient = " << dragCoefficient << endl; Pout << "drag (total) = " << drag << endl; } diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/DiFeliceDrag/DiFeliceDrag.H b/src/lagrangian/cfdemParticle/subModels/forceModel/DiFeliceDrag/DiFeliceDrag.H index a043b28..e4706b5 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/DiFeliceDrag/DiFeliceDrag.H +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/DiFeliceDrag/DiFeliceDrag.H @@ -72,10 +72,6 @@ private: const volVectorField& UsField_; // the average particle velocity field (for implicit/expliti force split) - mutable scalar scaleDia_; - - mutable scalar scaleDrag_; - public: //- Runtime type information diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/GidaspowDrag/GidaspowDrag.C b/src/lagrangian/cfdemParticle/subModels/forceModel/GidaspowDrag/GidaspowDrag.C index 93f3a15..d28af6c 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/GidaspowDrag/GidaspowDrag.C +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/GidaspowDrag/GidaspowDrag.C @@ -70,8 +70,6 @@ GidaspowDrag::GidaspowDrag phi_(readScalar(propsDict_.lookup("phi"))), UsFieldName_(propsDict_.lookup("granVelFieldName")), UsField_(sm.mesh().lookupObject (UsFieldName_)), - scaleDia_(1.), - scaleDrag_(1.), switchingVoidfraction_(0.8) { //Append the field names to be probed @@ -80,7 +78,7 @@ GidaspowDrag::GidaspowDrag probeIt_=!Switch(propsDict_.lookup("suppressProbe")); if(probeIt_) { - particleCloud_.probeM().initialize(typeName, "gidaspowDrag.logDat"); + particleCloud_.probeM().initialize(typeName, typeName+".logDat"); particleCloud_.probeM().vectorFields_.append("dragForce"); //first entry must be the force particleCloud_.probeM().vectorFields_.append("Urel"); particleCloud_.probeM().scalarFields_.append("Rep"); @@ -103,10 +101,6 @@ GidaspowDrag::GidaspowDrag forceSubM(iFSub).readSwitches(); particleCloud_.checkCG(true); - if (propsDict_.found("scale")) - scaleDia_=scalar(readScalar(propsDict_.lookup("scale"))); - if (propsDict_.found("scaleDrag")) - scaleDrag_=scalar(readScalar(propsDict_.lookup("scaleDrag"))); if (propsDict_.found("switchingVoidfraction")) switchingVoidfraction_ = readScalar(propsDict_.lookup("switchingVoidfraction")); @@ -123,15 +117,16 @@ GidaspowDrag::~GidaspowDrag() void GidaspowDrag::setForce() const { - if (scaleDia_ > 1) - Info << typeName << " using scale = " << scaleDia_ << endl; - else if (particleCloud_.cg() > 1){ - scaleDia_=particleCloud_.cg(); - Info << typeName << " using scale from liggghts cg = " << scaleDia_ << endl; - } - const volScalarField& nufField = forceSubM(0).nuField(); const volScalarField& rhoField = forceSubM(0).rhoField(); + #if defined(version24Dev) + // there seems to have been a change in the return value of + // particleCloud_.turbulence().nu() used by forceSubM(0).nuField(); + const volScalarField& nufField = particleCloud_.turbulence().nu(); + #else + const volScalarField& nufField = forceSubM(0).nuField(); + #endif + //update force submodels to prepare for loop for (int iFSub=0;iFSub switchingVoidfraction_) //dilute { - Rep=ds/scaleDia_*voidfraction*magUr/(nuf+SMALL); - CdMagUrLag = (24.0*nuf/(ds/scaleDia_*voidfraction)) //1/magUr missing here, but compensated in expression for betaP! + Rep=ds*voidfraction*magUr/(nuf+SMALL); + CdMagUrLag = (24.0*nuf/(ds*voidfraction)) //1/magUr missing here, but compensated in expression for betaP! *(scalar(1.0)+0.15*Foam::pow(Rep, 0.687)); betaP = 0.75*( //this is betaP = beta / localPhiP! rho*voidfraction*CdMagUrLag / - (ds/scaleDia_*Foam::pow(voidfraction,2.65)) + (ds*Foam::pow(voidfraction,2.65)) ); } else //dense { betaP = (150 * localPhiP*nuf*rho) //this is betaP = beta / localPhiP! - / (voidfraction*ds/scaleDia_*phi_*ds/scaleDia_*phi_) + / (voidfraction*ds*phi_*ds*phi_) + (1.75 * magUr * rho) - /((ds/scaleDia_*phi_)); + /((ds*phi_)); } // calc particle's drag - dragCoefficient = Vs*betaP*scaleDrag_; + dragCoefficient = Vs*betaP; if (modelType_=="B") dragCoefficient /= voidfraction; + forceSubM(0).scaleCoeff(dragCoefficient,dParcel); drag = dragCoefficient * Ur; // explicitCorr @@ -256,8 +260,7 @@ void GidaspowDrag::setForce() const Pout << "index = " << index << endl; Pout << "Us = " << Us << endl; Pout << "Ur = " << Ur << endl; - Pout << "ds = " << ds << endl; - Pout << "ds/scale = " << ds/scaleDia_ << endl; + Pout << "dprim = " << ds << endl; Pout << "phi = " << phi_ << endl; Pout << "rho = " << rho << endl; Pout << "nuf = " << nuf << endl; diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/GidaspowDrag/GidaspowDrag.H b/src/lagrangian/cfdemParticle/subModels/forceModel/GidaspowDrag/GidaspowDrag.H index 61c7d19..475c158 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/GidaspowDrag/GidaspowDrag.H +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/GidaspowDrag/GidaspowDrag.H @@ -78,10 +78,6 @@ private: const volVectorField& UsField_; // the average particle velocity field - mutable scalar scaleDia_; - - mutable scalar scaleDrag_; - mutable scalar switchingVoidfraction_; //voidfraction above which dilute formulation will be used public: diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/KochHillDrag/KochHillDrag.C b/src/lagrangian/cfdemParticle/subModels/forceModel/KochHillDrag/KochHillDrag.C index 41b9996..b831f2f 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/KochHillDrag/KochHillDrag.C +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/KochHillDrag/KochHillDrag.C @@ -67,16 +67,14 @@ KochHillDrag::KochHillDrag voidfractionFieldName_(propsDict_.lookup("voidfractionFieldName")), voidfraction_(sm.mesh().lookupObject (voidfractionFieldName_)), UsFieldName_(propsDict_.lookupOrDefault("granVelFieldName",word("Us"))), - UsField_(sm.mesh().lookupObject (UsFieldName_)), - scaleDia_(1.), - scaleDrag_(1.) + UsField_(sm.mesh().lookupObject (UsFieldName_)) { // suppress particle probe if (probeIt_ && propsDict_.found("suppressProbe")) probeIt_=!Switch(propsDict_.lookup("suppressProbe")); if(probeIt_) { - particleCloud_.probeM().initialize(typeName, "kochHillDrag.logDat"); + particleCloud_.probeM().initialize(typeName, typeName+".logDat"); particleCloud_.probeM().vectorFields_.append("dragForce"); //first entry must the be the force particleCloud_.probeM().vectorFields_.append("Urel"); //other are debug particleCloud_.probeM().scalarFields_.append("Rep"); //other are debug @@ -101,11 +99,6 @@ KochHillDrag::KochHillDrag forceSubM(iFSub).readSwitches(); particleCloud_.checkCG(true); - - if (propsDict_.found("scale")) - scaleDia_=scalar(readScalar(propsDict_.lookup("scale"))); - if (propsDict_.found("scaleDrag")) - scaleDrag_=scalar(readScalar(propsDict_.lookup("scaleDrag"))); } @@ -119,13 +112,6 @@ KochHillDrag::~KochHillDrag() void KochHillDrag::setForce() const { - if (scaleDia_ > 1) - Info << typeName << " using scale = " << scaleDia_ << endl; - else if (particleCloud_.cg() > 1){ - scaleDia_=particleCloud_.cg(); - Info << typeName << " using scale from liggghts cg = " << scaleDia_ << endl; - } - const volScalarField& nufField = forceSubM(0).nuField(); const volScalarField& rhoField = forceSubM(0).rhoField(); @@ -146,6 +132,7 @@ void KochHillDrag::setForce() const vector Us(0,0,0); vector Ur(0,0,0); scalar ds(0); + scalar dParcel(0); scalar nuf(0); scalar rho(0); scalar magUr(0); @@ -193,6 +180,8 @@ void KochHillDrag::setForce() const } ds = particleCloud_.d(index); + dParcel = ds; + forceSubM(0).scaleDia(ds); //caution: this fct will scale ds! nuf = nufField[cellI]; rho = rhoField[cellI]; @@ -200,9 +189,9 @@ void KochHillDrag::setForce() const //Update any scalar or vector quantity for (int iFSub=0;iFSub 0) { // calc particle Re Nr - Rep = ds/scaleDia_*voidfraction*magUr/(nuf+SMALL); + Rep = ds*voidfraction*magUr/(nuf+SMALL); // calc model coefficient F0 scalar F0=0.; @@ -245,13 +234,15 @@ void KochHillDrag::setForce() const scalar F = voidfraction * (F0 + 0.5*F3*Rep); // calc drag model coefficient betaP - betaP = 18.*nuf*rho/(ds/scaleDia_*ds/scaleDia_)*voidfraction*F; + betaP = 18.*nuf*rho/(ds*ds)*voidfraction*F; // calc particle's drag - dragCoefficient = Vs*betaP*scaleDrag_; + dragCoefficient = Vs*betaP; if (modelType_=="B") dragCoefficient /= voidfraction; + forceSubM(0).scaleCoeff(dragCoefficient,dParcel); + if(forceSubM(0).switches()[7]) // implForceDEMaccumulated=true { //get drag from the particle itself @@ -277,8 +268,7 @@ void KochHillDrag::setForce() const Pout << "index = " << index << endl; Pout << "Us = " << Us << endl; Pout << "Ur = " << Ur << endl; - Pout << "ds = " << ds << endl; - Pout << "ds/scale = " << ds/scaleDia_ << endl; + Pout << "dprim = " << ds << endl; Pout << "rho = " << rho << endl; Pout << "nuf = " << nuf << endl; Pout << "voidfraction = " << voidfraction << endl; diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/KochHillDrag/KochHillDrag.H b/src/lagrangian/cfdemParticle/subModels/forceModel/KochHillDrag/KochHillDrag.H index 95d6712..70a3200 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/KochHillDrag/KochHillDrag.H +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/KochHillDrag/KochHillDrag.H @@ -74,11 +74,7 @@ private: word UsFieldName_; - const volVectorField& UsField_; - - mutable scalar scaleDia_; - - mutable scalar scaleDrag_; + const volVectorField& UsField_; public: diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/LaEuScalarTemp/LaEuScalarTemp.C b/src/lagrangian/cfdemParticle/subModels/forceModel/LaEuScalarTemp/LaEuScalarTemp.C index 03d6096..d8b054f 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/LaEuScalarTemp/LaEuScalarTemp.C +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/LaEuScalarTemp/LaEuScalarTemp.C @@ -58,11 +58,12 @@ addToRunTimeSelectionTable LaEuScalarTemp::LaEuScalarTemp ( const dictionary& dict, - cfdemCloud& sm + cfdemCloud& sm, + word name ) : forceModel(dict,sm), - propsDict_(dict.subDict(typeName + "Props")), + propsDict_(dict.subDict(name == "" ? typeName + "Props" : name + "Props")), tempFieldName_(propsDict_.lookup("tempFieldName")), T_(sm.mesh().lookupObject (tempFieldName_)), voidfractionFieldName_(propsDict_.lookup("voidfractionFieldName")), @@ -82,8 +83,7 @@ LaEuScalarTemp::LaEuScalarTemp partHeatFluid_(NULL), validPartHeatFluid_(false), lambda_(readScalar(propsDict_.lookup("lambda"))), - Cp_(readScalar(propsDict_.lookup("Cp"))), - scaleDia_(1.) + Cp_(readScalar(propsDict_.lookup("Cp"))) { allocateMyArrays(); @@ -123,12 +123,8 @@ LaEuScalarTemp::LaEuScalarTemp // forceSubM(iFSub).readSwitches(); particleCloud_.checkCG(true); - - if (propsDict_.found("scale")) - scaleDia_=scalar(readScalar(propsDict_.lookup("scale"))); } - // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // LaEuScalarTemp::~LaEuScalarTemp() @@ -167,18 +163,11 @@ void LaEuScalarTemp::setForce() const void LaEuScalarTemp::manipulateScalarField(volScalarField& EuField) const { - if (scaleDia_ > 1) - Info << typeName << " using scale = " << scaleDia_ << endl; - else if (particleCloud_.cg() > 1){ - scaleDia_=particleCloud_.cg(); - Info << typeName << " using scale from liggghts cg = " << scaleDia_ << endl; - } - // realloc the arrays allocateMyArrays(); // reset Scalar field - EuField.internalField() = 0.0; + EuField == dimensionedScalar("zero", EuField.dimensions(), 0.); // get DEM data particleCloud_.dataExchangeM().getData(partTempName_,"scalar-atom",partTemp_); @@ -193,15 +182,17 @@ void LaEuScalarTemp::manipulateScalarField(volScalarField& EuField) const scalar Tfluid(0); label cellI=0; vector Us(0,0,0); - scalar dscaled(0); + scalar ds(0); scalar nuf(0); + scalar rho(0); scalar magUr(0); scalar As(0); scalar Rep(0); scalar Pr(0); scalar Nup(0); scalar n = 3.5; // model parameter - scalar sDth(scaleDia_*scaleDia_*scaleDia_); + scalar scaleDia = forceSubM(0).scaleDia(); + scalar sDth(scaleDia*scaleDia*scaleDia); #include "resetVoidfractionInterpolator.H" #include "resetUInterpolator.H" @@ -229,12 +220,28 @@ void LaEuScalarTemp::manipulateScalarField(volScalarField& EuField) const // calc relative velocity Us = particleCloud_.velocity(index); - magUr = mag(Ufluid-Us); - dscaled = 2*particleCloud_.radius(index)/scaleDia_; - As = dscaled*dscaled*M_PI*sDth; + ds = 2*particleCloud_.radius(index); + forceSubM(0).scaleDia(ds); //caution: this fct will scale ds! nuf = nufField[cellI]; - Rep = dscaled*magUr/nuf; - Pr = max(SMALL,Cp_*nuf*rhoField[cellI]/lambda_); + rho = rhoField[cellI]; + + //Update any scalar or vector quantity + for (int iFSub=0;iFSub (velFieldName_)), - useSecondOrderTerms_(false), - scaleDia_(1.), - numParticlesParcel_(1) + useSecondOrderTerms_(false) { if (propsDict_.found("useSecondOrderTerms")) useSecondOrderTerms_=true; @@ -87,11 +85,9 @@ MeiLift::MeiLift forceSubM(iFSub).readSwitches(); particleCloud_.checkCG(false); - if (propsDict_.found("scale")) - scaleDia_=scalar(readScalar(propsDict_.lookup("scale"))); //Append the field names to be probed - particleCloud_.probeM().initialize(typeName, "meiLift.logDat"); + particleCloud_.probeM().initialize(typeName, typeName+".logDat"); particleCloud_.probeM().vectorFields_.append("liftForce"); //first entry must the be the force particleCloud_.probeM().vectorFields_.append("Urel"); //other are debug particleCloud_.probeM().vectorFields_.append("vorticity"); //other are debug @@ -113,14 +109,6 @@ MeiLift::~MeiLift() void MeiLift::setForce() const { - if (scaleDia_ > 1) - Info << typeName << " using scale = " << scaleDia_ << endl; - else if (particleCloud_.cg() > 1){ - scaleDia_=particleCloud_.cg(); - Info << typeName << " using scale from liggghts cg = " << scaleDia_ << endl; - } - numParticlesParcel_ = scaleDia_*scaleDia_*scaleDia_; - const volScalarField& nufField = forceSubM(0).nuField(); const volScalarField& rhoField = forceSubM(0).rhoField(); @@ -131,6 +119,7 @@ void MeiLift::setForce() const scalar magUr(0); scalar magVorticity(0); scalar ds(0); + scalar dParcel(0); scalar nuf(0); scalar rho(0); scalar voidfraction(1); @@ -139,7 +128,6 @@ void MeiLift::setForce() const scalar Cl(0); scalar Cl_star(0); scalar J_star(0); - scalar dPrim(0); scalar Omega_eq(0); scalar alphaStar(0); scalar epsilon(0); @@ -183,15 +171,27 @@ void MeiLift::setForce() const if (magUr > 0 && magVorticity > 0) { ds = 2*particleCloud_.radius(index); - dPrim = ds/scaleDia_; + dParcel = ds; + forceSubM(0).scaleDia(ds); //caution: this fct will scale ds! nuf = nufField[cellI]; rho = rhoField[cellI]; - // calc dimensionless properties - Rep = dPrim*magUr/nuf; - Rew = magVorticity*dPrim*dPrim/nuf; + //Update any scalar or vector quantity + for (int iFSub=0;iFSub (voidfractionFieldName_)), UsFieldName_(propsDict_.lookup("granVelFieldName")), - UsField_(sm.mesh().lookupObject (UsFieldName_)), - scaleDia_(1.), - scaleDrag_(1.) + UsField_(sm.mesh().lookupObject (UsFieldName_)) { // suppress particle probe if (probeIt_ && propsDict_.found("suppressProbe")) probeIt_=!Switch(propsDict_.lookup("suppressProbe")); if(probeIt_) { - particleCloud_.probeM().initialize(typeName, "schillerNaumannDrag.logDat"); + particleCloud_.probeM().initialize(typeName, typeName+".logDat"); particleCloud_.probeM().vectorFields_.append("dragForce"); //first entry must the be the force particleCloud_.probeM().vectorFields_.append("Urel"); //other are debug particleCloud_.probeM().scalarFields_.append("Rep"); //other are debug @@ -99,10 +97,6 @@ SchillerNaumannDrag::SchillerNaumannDrag forceSubM(iFSub).readSwitches(); particleCloud_.checkCG(false); - if (propsDict_.found("scale")) - scaleDia_=scalar(readScalar(propsDict_.lookup("scale"))); - if (propsDict_.found("scaleDrag")) - scaleDrag_=scalar(readScalar(propsDict_.lookup("scaleDrag"))); } @@ -116,13 +110,6 @@ SchillerNaumannDrag::~SchillerNaumannDrag() void SchillerNaumannDrag::setForce() const { - if (scaleDia_ > 1) - Info << typeName << " using scale = " << scaleDia_ << endl; - else if (particleCloud_.cg() > 1){ - scaleDia_=particleCloud_.cg(); - Info << typeName << " using scale from liggghts cg = " << scaleDia_ << endl; - } - const volScalarField& nufField = forceSubM(0).nuField(); const volScalarField& rhoField = forceSubM(0).rhoField(); @@ -140,6 +127,7 @@ void SchillerNaumannDrag::setForce() const vector Us(0,0,0); vector Ur(0,0,0); scalar ds(0); + scalar dParcel(0); scalar nuf(0); scalar rho(0); scalar magUr(0); @@ -171,12 +159,17 @@ void SchillerNaumannDrag::setForce() const } Us = particleCloud_.velocity(index); + ds = 2*particleCloud_.radius(index); + dParcel = ds; + forceSubM(0).scaleDia(ds); //caution: this fct will scale ds! + nuf = nufField[cellI]; + rho = rhoField[cellI]; //Update any scalar or vector quantity for (int iFSub=0;iFSub 0) { // calc particle Re Nr - Rep = ds/scaleDia_*magUr/nuf; + Rep = ds*magUr/nuf; // calc fluid drag Coeff Cd = max(0.44,24.0/Rep*(1.0+0.15*pow(Rep,0.687))); @@ -204,14 +194,13 @@ void SchillerNaumannDrag::setForce() const dragCoefficient = 0.125*Cd*rho *M_PI *ds*ds - *scaleDia_ - *magUr - *scaleDrag_; + *magUr; if (modelType_=="B") dragCoefficient /= voidfraction; // calc particle's drag + forceSubM(0).scaleCoeff(dragCoefficient,dParcel); drag = dragCoefficient*Ur; // explicitCorr @@ -227,10 +216,9 @@ void SchillerNaumannDrag::setForce() const if(forceSubM(0).verbose() && index >-1 && index <102) { Pout << "index = " << index << endl; - Pout << "scaleDrag_ = " << scaleDrag_ << endl; Pout << "Us = " << Us << endl; Pout << "Ur = " << Ur << endl; - Pout << "ds/scale = " << ds/scaleDia_ << endl; + Pout << "dprim = " << ds << endl; Pout << "rho = " << rho << endl; Pout << "nuf = " << nuf << endl; Pout << "voidfraction = " << voidfraction << endl; diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/SchillerNaumannDrag/SchillerNaumannDrag.H b/src/lagrangian/cfdemParticle/subModels/forceModel/SchillerNaumannDrag/SchillerNaumannDrag.H index c9da6f8..bbc9923 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/SchillerNaumannDrag/SchillerNaumannDrag.H +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/SchillerNaumannDrag/SchillerNaumannDrag.H @@ -72,10 +72,6 @@ private: const volVectorField& UsField_; - mutable scalar scaleDia_; - - mutable scalar scaleDrag_; - public: //- Runtime type information diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/ShirgaonkarIB/ShirgaonkarIB.C b/src/lagrangian/cfdemParticle/subModels/forceModel/ShirgaonkarIB/ShirgaonkarIB.C index 983970c..c672697 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/ShirgaonkarIB/ShirgaonkarIB.C +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/ShirgaonkarIB/ShirgaonkarIB.C @@ -71,7 +71,7 @@ ShirgaonkarIB::ShirgaonkarIB p_(sm.mesh().lookupObject (pressureFieldName_)) { //Append the field names to be probed - particleCloud_.probeM().initialize(typeName, "shirgaonkarIB.logDat"); + particleCloud_.probeM().initialize(typeName, typeName+".logDat"); particleCloud_.probeM().vectorFields_.append("dragForce"); //first entry must the be the force particleCloud_.probeM().writeHeader(); diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/checkCouplingInterval/checkCouplingInterval.C b/src/lagrangian/cfdemParticle/subModels/forceModel/checkCouplingInterval/checkCouplingInterval.C index 92cff1d..12f3898 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/checkCouplingInterval/checkCouplingInterval.C +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/checkCouplingInterval/checkCouplingInterval.C @@ -34,8 +34,6 @@ Description #include "checkCouplingInterval.H" #include "addToRunTimeSelectionTable.H" -//#include "mpi.h" - // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // namespace Foam @@ -64,31 +62,40 @@ checkCouplingInterval::checkCouplingInterval : forceModel(dict,sm), propsDict_(dict.subDict(typeName + "Props")), - U_(sm.mesh().lookupObject ("U")), + warnOnly_(propsDict_.lookupOrDefault("warnOnly", true)), + velocityFieldName_(propsDict_.lookupOrDefault("velocityFieldName", "U")), + U_(sm.mesh().lookupObject (velocityFieldName_)), rhoP_(readScalar(propsDict_.lookup("rhoP"))), - maxCFL_(50) + maxCFL_(propsDict_.lookupOrDefault("maxCFL", 50.)), + maxAccNr_(propsDict_.lookupOrDefault("maxAccNr", 0.1)), + UmaxExpected_(readScalar(propsDict_.lookup("UmaxExpected"))), + minAllowedVcellByVparcel_(propsDict_.lookupOrDefault("minAllowedVcellByVparcel", 3.)), + nextRun_(0), + timeInterval_(propsDict_.lookupOrDefault("timeInterval", sm.dataExchangeM().couplingTime())), + couplingStepInterval_(floor(timeInterval_/sm.dataExchangeM().couplingTime())) { - if (propsDict_.found("maxCFL")) - maxCFL_=readScalar(propsDict_.lookup("maxCFL")); - // init force sub model setForceSubModels(propsDict_); // read those switches defined above, if provided in dict forceSubM(0).readSwitches(); - if (probeIt_ && propsDict_.found("suppressProbe")) + /*if (probeIt_ && propsDict_.found("suppressProbe")) probeIt_=!Switch(propsDict_.lookup("suppressProbe")); if(probeIt_) { - particleCloud_.probeM().initialize(typeName, "checkCouplingInterval.logDat"); + particleCloud_.probeM().initialize(typeName, typeName+".logDat"); + particleCloud_.probeM().scalarFields_.append("maxCFL"); + particleCloud_.probeM().scalarFields_.append("maxCFLexpected"); particleCloud_.probeM().scalarFields_.append("minTauP"); particleCloud_.probeM().scalarFields_.append("minVcellByVparcel"); particleCloud_.probeM().scalarFields_.append("minStokes"); particleCloud_.probeM().scalarFields_.append("maxStokes"); particleCloud_.probeM().writeHeader(); - } + }*/ + Info << "running checkCouplingInterval every " << couplingStepInterval_ << " coupling steps," + << "which is every " << timeInterval_ << " seconds." << endl; } @@ -99,29 +106,77 @@ checkCouplingInterval::~checkCouplingInterval() // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // +inline bool checkCouplingInterval::doCheck() const +{ + label couplingStep = particleCloud_.dataExchangeM().couplingStep(); + if(couplingStep >= nextRun_) + { + nextRun_ += couplingStepInterval_; + return true; + } + return false; +} void checkCouplingInterval::setForce() const { #include "setupProbeModel.H" - if(particleCloud_.mesh().time().write()) + if(doCheck()) { + Info << "========================================================================" << endl; + Info << "Check Coupling Interval" << endl; + Info << "========================================================================" << endl; + //============================================================================================== // calc the maximum CFL number scalar CFL = 0.0; + scalar CFLexpected = 0.0; + scalar ts = particleCloud_.mesh().time().deltaT().value(); if (particleCloud_.mesh().nInternalFaces()) { surfaceScalarField phi(particleCloud_.mesh().lookupObject ("phi")); scalarField sumPhi(fvc::surfaceSum(mag(phi))().internalField()); - CFL = 0.5*gMax(sumPhi/particleCloud_.mesh().V().field())*particleCloud_.mesh().time().deltaT().value(); - } - if (CFL > maxCFL_) - FatalError << "CFL exceeds maximum allowed value:" << maxCFL_ - << ", and reached the value:" << CFL - << "\nThe simulation is stopped, check your settings." << abort(FatalError); + CFL = 0.5*gMax(sumPhi/particleCloud_.mesh().V().field())*ts; + scalar minVol = gMin(particleCloud_.mesh().V()); + scalar minLen = pow(minVol,1./3.); + CFLexpected = UmaxExpected_ * ts / minLen; + } + + if (CFL > maxCFL_) + { + if(warnOnly_) + Warning << "CFL exceeds maximum allowed value:" << maxCFL_ + << ", and reached the value:" << CFL + << "\ncheck your settings!" << endl; + else + FatalError << "CFL exceeds maximum allowed value:" << maxCFL_ + << ", and reached the value:" << CFL + << "\nThe simulation is stopped, check your settings." << abort(FatalError); + } + else if (CFLexpected > maxCFL_) + if(warnOnly_) + Warning << "Expected CFL (based on UmaxExpected) exceeds maximum allowed value:" << maxCFL_ + << ", and reached the value:" << CFLexpected + << "\ncheck your settings." << endl; + else + FatalError << "Expected CFL (based on UmaxExpected) exceeds maximum allowed value:" << maxCFL_ + << ", and reached the value:" << CFLexpected + << "\nThe simulation is stopped, check your settings." << abort(FatalError); + else + { + Info << "max. CFL = " << CFL << endl; + Info << "max. expected CFL (based on UmaxExpected) = " << CFLexpected << endl; + } + //============================================================================================== + + + //============================================================================================== + // particle relaxation time tau, + // Stokes nr, + // cell/particle volume ratio const volScalarField& nufField = forceSubM(0).nuField(); const volScalarField& rhoField = forceSubM(0).rhoField(); @@ -189,30 +244,56 @@ void checkCouplingInterval::setForce() const scalar maxVparcelAll = maxDparcelAll*maxDparcelAll*maxDparcelAll*3.1416/6.0; scalar minVcellByVparcel = minVcellAll/maxVparcelAll; + if(accNr > maxAccNr_) + { + if(warnOnly_) + Warning << "The max. acceleration nr (coupling time / particle relaxation time) exceeds the maximum allowed value " << maxAccNr_ + << ", and reached the value:" << accNr + << "\ncheck your settings." << endl; + else + FatalError << "The max. acceleration nr (coupling time / particle relaxation time) exceeds the maximum allowed value " << maxAccNr_ + << ", and reached the value:" << accNr + << "\nThe simulation is stopped, check your settings." << abort(FatalError); + } + else + { + Info << "min. occurring particle relaxation time [s]: " << minTauPAll << endl; + Info << "coupling interval [s]: " << DEMtime << endl; + Info << "max. occurring acceleration nr: " << accNr << endl; + } - Info << "min. occurring particle relaxation time [s]: " << minTauPAll << endl; - Info << "coupling interval [s]: " << DEMtime << endl; - Info << "max. occurring acceleration nr: " << accNr << endl; - if(accNr > 0.1) Warning << "you should use a smaller coupling interval!" << endl; + if(minVcellByVparcel < minAllowedVcellByVparcel_) + { + if(warnOnly_) + Warning << "The min. ratio of Vcell / Vparcel is below the minimum allowed value " << minAllowedVcellByVparcel_ + << ", and reached the value:" << minVcellByVparcel + << "\ncheck your settings." << endl; + else + FatalError << "The min. ratio of Vcell / Vparcel is below the minimum allowed value " << minAllowedVcellByVparcel_ + << ", and reached the value:" << minVcellByVparcel + << "\nThe simulation is stopped, check your settings." << abort(FatalError); + } + else + Info << "min. ratio of Vcell / Vparcel is " << minVcellByVparcel << endl; - Info << "min. occurring cell/parcel volume ratio: " << minVcellByVparcel << endl; - if(minVcellByVparcel < 3) Warning << "you should use bigger cells!" << endl; + Info << "min./max. Stokes Nr: " << minStAll << " / " << maxStAll << endl; - Info << "min. Stokes Nr: " << minStAll << endl; - Info << "max. Stokes Nr: " << maxStAll << endl; + Info << "========================================================================" << endl; - //Set value fields and write the probe + /*//Set value fields and write the probe if(probeIt_) { #include "setupProbeModelfields.H" // Note: for other than ext one could use vValues.append(x) // instead of setSize + sValues.setSize(sValues.size()+1, CFL); + sValues.setSize(sValues.size()+1, CFLexpected); sValues.setSize(sValues.size()+1, minTauPAll); sValues.setSize(sValues.size()+1, minVcellByVparcel); sValues.setSize(sValues.size()+1, minStAll); sValues.setSize(sValues.size()+1, maxStAll); particleCloud_.probeM().writeProbe(0, sValues, vValues); - } + }*/ } } diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/checkCouplingInterval/checkCouplingInterval.H b/src/lagrangian/cfdemParticle/subModels/forceModel/checkCouplingInterval/checkCouplingInterval.H index 2ec2e7b..23655d5 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/checkCouplingInterval/checkCouplingInterval.H +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/checkCouplingInterval/checkCouplingInterval.H @@ -62,12 +62,30 @@ class checkCouplingInterval private: dictionary propsDict_; + Switch warnOnly_; + + word velocityFieldName_; + const volVectorField& U_; const scalar rhoP_; scalar maxCFL_; + scalar maxAccNr_; + + scalar UmaxExpected_; + + scalar minAllowedVcellByVparcel_; + + mutable int nextRun_; + + scalar timeInterval_; + + int couplingStepInterval_; + + inline bool doCheck() const; + public: //- Runtime type information diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/forceModel/forceModel.C b/src/lagrangian/cfdemParticle/subModels/forceModel/forceModel/forceModel.C index 6c13e86..148546b 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/forceModel/forceModel.C +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/forceModel/forceModel.C @@ -225,6 +225,10 @@ void forceModel::setForceSubModels(dictionary& dict) { forceSubModels_ = wordList(dict.lookup("forceSubModels")); } + else if (dict.found("forceSubModel")) + { + FatalError << "Did you mean the forceSubModels keyword? " << abort(FatalError); + } else { forceSubModels_.setSize(1, "ImEx"); diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/forceSubModels/forceSubModel/forceSubModel.C b/src/lagrangian/cfdemParticle/subModels/forceModel/forceSubModels/forceSubModel/forceSubModel.C index 2115a36..2f15549 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/forceSubModels/forceSubModel/forceSubModel.C +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/forceSubModels/forceSubModel/forceSubModel.C @@ -118,7 +118,9 @@ forceSubModel::forceSubModel densityFieldName_(dict_.lookupOrDefault("densityFieldName","rho")), rho_(sm.mesh().lookupObject (densityFieldName_)), verboseDiskIntervall_(1), - verboseDiskCounter_(0) + verboseDiskCounter_(0), + scaleDia_(dict_.lookupOrDefault("scale",1.)), + scaleDrag_(dict_.lookupOrDefault("scaleDrag",1.)) { // init standard switch list int iCounter(0); @@ -143,6 +145,15 @@ forceSubModel::forceSubModel // sanity check of what is defined above if(switchesNameList_.size() != nrDefaultSwitches_) FatalError<< "please check the nr of switches defined in forceSubModel class." << abort(FatalError); + + // info about scaleDia being used + if (scaleDia_ != 1) + Info << "using scale = " << scaleDia_ << endl; + else if (particleCloud_.cg() != 1) + { + scaleDia_=particleCloud_.cg(); + Info << "using scale from liggghts cg = " << scaleDia_ << endl; + } } @@ -282,31 +293,56 @@ void forceSubModel::explicitCorrScalar(scalar& sourceKImplicit, // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // -void forceSubModel::update( scalar& deltaT, - label particleI, - label cellI, - scalar& scalToUpdate1, - scalar& scalToUpdate2, - bool verbose +void forceSubModel::update( label particleI, + label cellI, + scalar& d, + scalar& scalToUpdate1, + scalar& scalToUpdate2, + bool verbose ) const { //no action } // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // -void forceSubModel::update( scalar& deltaT, - label particleI, - label cellI, - vector& vecToUpdate1, - vector& vecToUpdate2, - scalar& scalToUpdate1, - scalar& scalToUpdate2, - bool verbose +void forceSubModel::update( label particleI, + label cellI, + scalar& d, + vector& vecToUpdate1, + vector& vecToUpdate2, + scalar& scalToUpdate1, + scalar& scalToUpdate2, + bool verbose ) const { //no action } // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // +void forceSubModel::scaleDia(scalar& d) const +{ + d /= scaleDia_; +} +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // +void forceSubModel::scaleForce(vector& force, scalar& d) const +{ + force *= scaleDia_*scaleDia_*scaleDia_*scaleDrag_; +} +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // +void forceSubModel::scaleForce(vector& force) const +{ + Warning << "Function not defined!" << endl; +} +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // +void forceSubModel::scaleCoeff(scalar& coeff,scalar& d) const +{ + coeff *= scaleDia_*scaleDia_*scaleDia_*scaleDrag_; +} +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // +void forceSubModel::scaleCoeff(scalar& coeff) const +{ + Warning << "Function not defined!" << endl; +} +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // void forceSubModel::explicitLimit ( vector& dragImplicit, diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/forceSubModels/forceSubModel/forceSubModel.H b/src/lagrangian/cfdemParticle/subModels/forceModel/forceSubModels/forceSubModel/forceSubModel.H index 5ecd622..ce47eb7 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/forceSubModels/forceSubModel/forceSubModel.H +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/forceSubModels/forceSubModel/forceSubModel.H @@ -88,6 +88,10 @@ protected: mutable int verboseDiskCounter_; + scalar scaleDia_; + + scalar scaleDrag_; + public: //- Runtime type information @@ -156,14 +160,24 @@ public: virtual void explicitCorrScalar(scalar&, scalar&, scalar&, scalar&, const scalar&, scalar&, bool, label index=100) const; - virtual void update(scalar& deltaT, label particleI, label cellI, + virtual void update(label particleI, label cellI, scalar& d, scalar& scalToUpdate1, scalar& scalToUpdate2, bool verbose) const; - virtual void update(scalar& deltaT, label particleI, label cellI, + virtual void update(label particleI, label cellI, scalar& d, vector& vecToUpdate1, vector& vecToUpdate2, scalar& scalToUpdate1, scalar& scalToUpdate2, bool verbose) const; + virtual void scaleDia(scalar& d) const; + + virtual void scaleForce(vector& force) const; + + virtual void scaleForce(vector& force, scalar& d) const; + + virtual void scaleCoeff(scalar& coeff) const; + + virtual void scaleCoeff(scalar& coeff, scalar& d) const; + virtual void explicitLimit(vector&, vector&, scalar&) const; virtual void verboseToDiskWrite(Field& writeValues) const {};//implement writing to disk @@ -217,6 +231,10 @@ public: const volVectorField& divTauField(const volVectorField&) const; const volVectorField& IBDragPerV(const volVectorField&,const volScalarField&) const; + + const scalar& scaleDia() const {return scaleDia_;}; + + const scalar& scaleDrag() const {return scaleDia_;}; }; diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/gradPForce/gradPForce.C b/src/lagrangian/cfdemParticle/subModels/forceModel/gradPForce/gradPForce.C index 0bdd42e..b077aa9 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/gradPForce/gradPForce.C +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/gradPForce/gradPForce.C @@ -121,7 +121,7 @@ gradPForce::gradPForce probeIt_=!Switch(propsDict_.lookup("suppressProbe")); if(probeIt_) { - particleCloud_.probeM().initialize(typeName, "gradP.logDat"); + particleCloud_.probeM().initialize(typeName, typeName+".logDat"); particleCloud_.probeM().vectorFields_.append("gradPForce"); //first entry must the be the force particleCloud_.probeM().scalarFields_.append("Vs"); particleCloud_.probeM().scalarFields_.append("rho"); diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/noDrag/noDrag.C b/src/lagrangian/cfdemParticle/subModels/forceModel/noDrag/noDrag.C index af0726c..fa697b1 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/noDrag/noDrag.C +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/noDrag/noDrag.C @@ -61,27 +61,20 @@ noDrag::noDrag ) : forceModel(dict,sm), - propsDict_(dict), - verbose_(false), - noDEMForce_(false), - keepCFDForce_(false) + propsDict_(dict.subDict(typeName + "Props")), + noDEMForce_(propsDict_.lookupOrDefault("noDEMForce",false)), + keepCFDForce_(propsDict_.lookupOrDefault("keepCFDForce",false)) { - if(dict.found(word(typeName + "Props"))) - propsDict_=dictionary(dict.subDict(typeName + "Props")); - // init force sub model setForceSubModels(propsDict_); // define switches which can be read from dict forceSubM(0).setSwitchesList(0,true); // activate treatExplicit + forceSubM(0).setSwitchesList(3,true); // activate search for verbose switch // read those switches defined above, if provided in dict forceSubM(0).readSwitches(); - if (propsDict_.found("noDEMForce")) noDEMForce_=true; - - if (propsDict_.found("keepCFDForce")) keepCFDForce_=true; - coupleForce_=false; } @@ -96,7 +89,13 @@ noDrag::~noDrag() void noDrag::setForce() const { - Info << "noDrag::setForce" << endl; + if(forceSubM(0).verbose()) + { + Info << "noDrag::setForce:" << endl; + Info << "noDEMForce=" << noDEMForce_ << endl; + Info << "keepCFDForce=" << keepCFDForce_ << endl; + } + label cellI=0; bool treatExplicit=forceSubM(0).switches()[0]; for(int index = 0;index < particleCloud_.numberOfParticles(); ++index) diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/noDrag/noDrag.H b/src/lagrangian/cfdemParticle/subModels/forceModel/noDrag/noDrag.H index 8928267..65e3c65 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/noDrag/noDrag.H +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/noDrag/noDrag.H @@ -57,11 +57,9 @@ class noDrag private: dictionary propsDict_; - bool verbose_; + Switch noDEMForce_; - bool noDEMForce_; - - bool keepCFDForce_; + Switch keepCFDForce_; public: diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/particleCellVolume/particleCellVolume.C b/src/lagrangian/cfdemParticle/subModels/forceModel/particleCellVolume/particleCellVolume.C index 991f0c0..17735be 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/particleCellVolume/particleCellVolume.C +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/particleCellVolume/particleCellVolume.C @@ -141,7 +141,7 @@ void particleCellVolume::setForce() const { if(forceSubM(0).verbose()) Info << "particleCellVolume.C - setForce()" << endl; - scalarField_.internalField()=0.; + scalarField_ == dimensionedScalar("zero", scalarField_.dimensions(), 0.); // get reference to actual field const volScalarField& field = mesh_.lookupObject(scalarFieldName_); @@ -168,8 +168,8 @@ void particleCellVolume::setForce() const scalarField2_[cellI] = 0.; } } - scalarField_.internalField() = gSum(scalarField_); - scalarField2_.internalField() = gSum(scalarField2_); + scalarField_ == dimensionedScalar("zero", scalarField_.dimensions(), gSum(scalarField_)); + scalarField2_ == dimensionedScalar("zero", scalarField_.dimensions(), gSum(scalarField2_)); reduce(minFieldVal, minOp()); reduce(maxFieldVal, maxOp()); diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/scalarGeneralExchange/scalarGeneralExchange.C b/src/lagrangian/cfdemParticle/subModels/forceModel/scalarGeneralExchange/scalarGeneralExchange.C index f68ca9d..6a1bd43 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/scalarGeneralExchange/scalarGeneralExchange.C +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/scalarGeneralExchange/scalarGeneralExchange.C @@ -112,17 +112,26 @@ scalarGeneralExchange::scalarGeneralExchange probeIt_=!Switch(propsDict_.lookup("suppressProbe")); if(probeIt_) { - particleCloud_.probeM().initialize(typeName, typeName+".logDat"); + forAll(eulerianFieldNames_, fieldIt) + { + particleCloud_.probeM().initialize(typeName, typeName + "_" + eulerianFieldNames_[fieldIt] + ".logDat"); particleCloud_.probeM().vectorFields_.append("Urel"); //first entry must the be the vector to probe - particleCloud_.probeM().scalarFields_.append("Nu"); //other are debug - particleCloud_.probeM().scalarFields_.append("Rep"); //other are debug + if(eulerianFieldNames_[fieldIt]==tempFieldName_) //this is the temperature + { + particleCloud_.probeM().scalarFields_.append("Rep"); + particleCloud_.probeM().scalarFields_.append("Nu"); + } + else + particleCloud_.probeM().scalarFields_.append("Sh"); particleCloud_.probeM().scalarFields_.append("exchangeRate"); particleCloud_.probeM().writeHeader(); + } } for (int iFSub=0;iFSub=0 && particleSpeciesValue_[speciesID]<0.0) //skip if species is not active return; @@ -261,6 +278,8 @@ void scalarGeneralExchange::manipulateScalarField(volScalarField& explicitEulerS partHeatTransCoeffName_, partHeatTransCoeffPositionInRegister_, partHeatFluidName_, partHeatFluidPositionInRegister_ ); + if(probeIt_) + particleCloud_.probeM().setOutputFile(typeName+"_"+tempFieldName_+".logDat"); } else { @@ -272,8 +291,11 @@ void scalarGeneralExchange::manipulateScalarField(volScalarField& explicitEulerS partSpeciesTransCoeffNames_[speciesID], partSpeciesTransCoeffPositionInRegister_[speciesID], partSpeciesFluidNames_[speciesID], partSpeciesFluidPositionInRegister_[speciesID] ); + if(probeIt_) + particleCloud_.probeM().setOutputFile(typeName + "_" + fieldName + ".logDat"); } + //============================== // get references const volScalarField& voidfraction_(particleCloud_.mesh().lookupObject (voidfractionFieldName_)); // ref to voidfraction field @@ -318,7 +340,6 @@ void scalarGeneralExchange::manipulateScalarField(volScalarField& explicitEulerS #include "resetVoidfractionInterpolator.H" #include "resetUInterpolator.H" #include "resetFluidScalarFieldInterpolator.H" - #include "setupProbeModel.H" for(int index = 0;index < particleCloud_.numberOfParticles(); ++index) { @@ -406,8 +427,9 @@ void scalarGeneralExchange::manipulateScalarField(volScalarField& explicitEulerS // Note: for other than ext one could use vValues.append(x) // instead of setSize vValues.setSize(vValues.size()+1, Ur); + if(speciesID<0) //this is the temperature, then also report Rep + sValues.setSize(sValues.size()+1, Rep); sValues.setSize(sValues.size()+1, (this->*Nusselt)(Rep,Pr,voidfraction)); - sValues.setSize(sValues.size()+1, Rep); sValues.setSize(sValues.size()+1, tmpPartFlux); particleCloud_.probeM().writeProbe(index, sValues, vValues); } @@ -432,9 +454,11 @@ void scalarGeneralExchange::manipulateScalarField(volScalarField& explicitEulerS NULL ); - // scale with the cell volume to get (total) volume-specific source - explicitEulerSource.internalField() /= -explicitEulerSource.mesh().V(); - implicitEulerSource.internalField() /= -implicitEulerSource.mesh().V(); + // scale with the cell volume to get (total) volume-specific source + particleCloud_.makeSpecific(explicitEulerSource); + explicitEulerSource*=-1; + particleCloud_.makeSpecific(implicitEulerSource); + implicitEulerSource*=-1; // limit explicit source term scalar explicitEulerSourceInCell; @@ -452,6 +476,7 @@ void scalarGeneralExchange::manipulateScalarField(volScalarField& explicitEulerS //Reporting of integral quantities //TODO: write to different file for speciesId>0 Field writeValues; bool writeDiskNow=forceSubM(0).verboseToDisk(); //must call 'verboseToDisk()' only once since this function is incremeting a counter! + writeValues.clear(); if( forceSubM(0).verbose() || writeDiskNow) { scalar exchangeRate = gSum(-(explicitEulerSource @@ -734,6 +759,15 @@ void scalarGeneralExchange::setPointersToExternalArrays( word nameFlux, word nameFluid, int positionFluid ) const { + if(particleCloud_.particleDatFieldsUserCFDEMToExt.size() != + particleCloud_.namesFieldsUserCFDEMToExt.size() + ) + FatalError << "\n\n****CATASTROPHIC ERROR MOST LIKELY CAUSED BY USER!!! \n" + << "particleCloud_.particleDatFieldsUserCFDEMToExt.size() is NOT EQUAL to particleCloud_.namesFieldsUserCFDEMToExt.size()." + << "This may be caused by an incorrect time step, or coupling interval, resulting in the fact that an array inside particleCloud_ was not allocated. " + << "Please check your time step and coupling interval settings, such that fluid-particle coupling is done EVERY fluid time step. \n\n" + << abort(FatalError); + if(validPartFlux_) //EXPLICIT coupling strategy for Lagrangian part { partDatFlux_ = particleCloud_.particleDatFieldsUserCFDEMToExt[positionFlux]; diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/virtualMassForce/virtualMassForce.C b/src/lagrangian/cfdemParticle/subModels/forceModel/virtualMassForce/virtualMassForce.C index 53feed5..702d4ad 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/virtualMassForce/virtualMassForce.C +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/virtualMassForce/virtualMassForce.C @@ -73,13 +73,6 @@ virtualMassForce::virtualMassForce splitUrelCalculation_(false), Cadd_(0.5) { - - if (particleCloud_.dataExchangeM().maxNumberOfParticles() > 0 && !splitUrelCalculation_) - { - // get memory for 2d array - particleCloud_.dataExchangeM().allocateArray(UrelOld_,NOTONCPU,3); - } - // init force sub model setForceSubModels(propsDict_); // define switches which can be read from dict @@ -110,7 +103,7 @@ virtualMassForce::virtualMassForce particleCloud_.checkCG(true); //Append the field names to be probed - particleCloud_.probeM().initialize(typeName, "virtualMass.logDat"); + particleCloud_.probeM().initialize(typeName, typeName+".logDat"); particleCloud_.probeM().vectorFields_.append("virtualMassForce"); //first entry must the be the force particleCloud_.probeM().vectorFields_.append("Urel"); particleCloud_.probeM().vectorFields_.append("UrelOld"); @@ -118,6 +111,17 @@ virtualMassForce::virtualMassForce particleCloud_.probeM().scalarFields_.append("Vs"); particleCloud_.probeM().scalarFields_.append("rho"); particleCloud_.probeM().writeHeader(); + + if(!splitUrelCalculation_) + FatalError << "Virtual mass model: you have set 'splitUrelCalculation' to false, but this is not implemented. use true!" << abort(FatalError); + + if (particleCloud_.dataExchangeM().maxNumberOfParticles() > 0 && !splitUrelCalculation_) + { + // get memory for 2d array + particleCloud_.dataExchangeM().allocateArray(UrelOld_,NOTONCPU,3); + Info << "**Virtual mass model: allocating UrelOld " << endl; + } + } @@ -253,7 +257,10 @@ void Foam::virtualMassForce::reAllocArrays() const if (!splitUrelCalculation_) { if(particleCloud_.numberOfParticlesChanged()) + { particleCloud_.dataExchangeM().allocateArray(UrelOld_,NOTONCPU,3); + Info << "**Virtual mass model: allocating UrelOld " << endl; + } // get DEM data particleCloud_.dataExchangeM().getData("UrelOld", "vector-atom", UrelOld_); diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/viscForce/viscForce.C b/src/lagrangian/cfdemParticle/subModels/forceModel/viscForce/viscForce.C index b716e81..d58aef5 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/viscForce/viscForce.C +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/viscForce/viscForce.C @@ -118,7 +118,7 @@ viscForce::viscForce if(probeIt_) { - particleCloud_.probeM().initialize(typeName, "visc.logDat"); + particleCloud_.probeM().initialize(typeName, typeName+".logDat"); particleCloud_.probeM().vectorFields_.append("viscForce"); //first entry must the be the force particleCloud_.probeM().scalarFields_.append("Vs"); particleCloud_.probeM().writeHeader(); diff --git a/src/lagrangian/cfdemParticle/subModels/forceModel/volWeightedAverage/volWeightedAverage.C b/src/lagrangian/cfdemParticle/subModels/forceModel/volWeightedAverage/volWeightedAverage.C index 27bf26f..19e4db0 100644 --- a/src/lagrangian/cfdemParticle/subModels/forceModel/volWeightedAverage/volWeightedAverage.C +++ b/src/lagrangian/cfdemParticle/subModels/forceModel/volWeightedAverage/volWeightedAverage.C @@ -65,9 +65,9 @@ volWeightedAverage::volWeightedAverage propsDict_(dict.subDict(typeName + "Props")), mesh_(particleCloud_.mesh()), startTime_(propsDict_.lookupOrDefault("startTime",0.)), - volumeFractionName_(propsDict_.lookupOrDefault("volumeFractionName","voidfraction")), scalarFieldNames_(propsDict_.lookup("scalarFieldNames")), vectorFieldNames_(propsDict_.lookup("vectorFieldNames")), + volumeFractionName_(propsDict_.lookupOrDefault("volumeFractionName","voidfraction")), volumeFraction_(particleCloud_.mesh().lookupObject(volumeFractionName_)), upperThreshold_(readScalar(propsDict_.lookup("upperThreshold"))), lowerThreshold_(readScalar(propsDict_.lookup("lowerThreshold"))), @@ -191,7 +191,7 @@ void volWeightedAverage::setForce() const MPI_Allreduce(&totVol, &totVol_all, 3, MPI_DOUBLE, MPI_SUM, MPI_COMM_WORLD); integralValue = gSum(scalarFields_[i]); volWeightedAverage = integralValue / (totVol_all+SMALL); - scalarFields_[i].internalField() = volWeightedAverage; + scalarFields_[i] == dimensionedScalar("value", scalarFields_[i].dimensions(), volWeightedAverage); if(verbose_) { @@ -242,7 +242,7 @@ void volWeightedAverage::setForce() const MPI_Allreduce(&totVol, &totVol_all, 3, MPI_DOUBLE, MPI_SUM, MPI_COMM_WORLD); volWeightedAverage = gSum(vectorFields_[i]) / (totVol_all+SMALL); - vectorFields_[i].internalField() = volWeightedAverage; + vectorFields_[i] == volWeightedAverage; if(verbose_) { diff --git a/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/execute/execute.C b/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/execute/execute.C index c13c59e..e3448e6 100644 --- a/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/execute/execute.C +++ b/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/execute/execute.C @@ -68,8 +68,7 @@ execute::execute commandList_(0), command_(""), scalarList_(0), - labelList_(0), - timeStamp_(false) + labelList_(0) { // define dictionary char h[80]; diff --git a/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/execute/execute.H b/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/execute/execute.H index 1b73e65..78b3755 100644 --- a/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/execute/execute.H +++ b/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/execute/execute.H @@ -71,8 +71,6 @@ private: labelList labelList_; - bool timeStamp_; - public: //- Runtime type information diff --git a/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/liggghtsCommandModel/liggghtsCommandModel.C b/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/liggghtsCommandModel/liggghtsCommandModel.C index 0267e8b..ad7e306 100644 --- a/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/liggghtsCommandModel/liggghtsCommandModel.C +++ b/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/liggghtsCommandModel/liggghtsCommandModel.C @@ -73,7 +73,8 @@ liggghtsCommandModel::liggghtsCommandModel couplingStepInterval_(0), exactTiming_(false), commandLines_(1), - verbose_(false) + verbose_(false), + timeStamp_(false) {} @@ -255,7 +256,10 @@ bool liggghtsCommandModel::checkPath(fileName path) } -void liggghtsCommandModel::parseCommandList(wordList& commandList,labelList& labelList,scalarList& scalarList,word& command, dictionary& propsDict, bool timeStamp) +void liggghtsCommandModel::parseCommandList(wordList& commandList,labelList& labelList, + scalarList& scalarList, + word& command, dictionary& propsDict, + bool& timeStamp) { bool addBlank = true; // std no blanks after each word fileName add; diff --git a/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/liggghtsCommandModel/liggghtsCommandModel.H b/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/liggghtsCommandModel/liggghtsCommandModel.H index 57144f5..17a560a 100644 --- a/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/liggghtsCommandModel/liggghtsCommandModel.H +++ b/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/liggghtsCommandModel/liggghtsCommandModel.H @@ -93,6 +93,8 @@ protected: bool verbose_; + bool timeStamp_; + public: //- Runtime type information @@ -174,7 +176,7 @@ public: label commandLines(){return commandLines_;}; - void parseCommandList(wordList&, labelList&, scalarList&, word&, dictionary&, bool=false); + void parseCommandList(wordList&, labelList&, scalarList&, word&, dictionary&, bool& timeStamp); }; diff --git a/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/setDEMGravity/setDEMGravity.C b/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/setDEMGravity/setDEMGravity.C new file mode 100644 index 0000000..f2e8b63 --- /dev/null +++ b/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/setDEMGravity/setDEMGravity.C @@ -0,0 +1,156 @@ +/*---------------------------------------------------------------------------*\ + CFDEMcoupling - Open Source CFD-DEM coupling + + CFDEMcoupling is part of the CFDEMproject + www.cfdem.com + Christoph Goniva, christoph.goniva@cfdem.com + Copyright 2009-2012 JKU Linz + Copyright 2012- DCS Computing GmbH, Linz +------------------------------------------------------------------------------- +License + This file is part of CFDEMcoupling. + + CFDEMcoupling 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. + + CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + for more details. + + You should have received a copy of the GNU General Public License + along with CFDEMcoupling; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +Description + This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS + and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER). +\*---------------------------------------------------------------------------*/ + +#include "error.H" + +#include "setDEMGravity.H" +#include "addToRunTimeSelectionTable.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ + +// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // + +defineTypeNameAndDebug(setDEMGravity, 0); + +addToRunTimeSelectionTable +( + liggghtsCommandModel, + setDEMGravity, + dictionary +); + + +// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // + +// Construct from components +setDEMGravity::setDEMGravity +( + const dictionary& dict, + cfdemCloud& sm, + int i +) +: + liggghtsCommandModel(dict,sm,i), + propsDict_(dict), + nrModel_(i), + insertionNr_(0.), + command_(0), + filePathList_(100), + scalarList_(40), + labelList_(1), + #if defined(version21) || defined(version16ext) + g_(sm.mesh().lookupObject ("g")), + #elif defined(version15) + g_(dimensionedVector(sm.mesh().lookupObject("environmentalProperties").lookup("g")).value()), + #endif + unfix_(false) +{ + // define dictionary + char h[80]; + sprintf(h,"%d",nrModel_); + word myName_=word(typeName + "Props" + h); + propsDict_=dictionary(dict.subDict(myName_)); + + // read unfix flag + unfix_=Switch(propsDict_.lookupOrDefault("unfix",false)); + + if (propsDict_.found("exactTiming")) + exactTiming_=true; + Info << "exactTiming==" << exactTiming_ << endl; + + if (propsDict_.found("verbose")) verbose_=true; + + scalar gNorm=mag(g_.value()); + vector g=g_.value()/mag(g_.value()); + + + //======================================= + // create command + + if(unfix_) + { + filePathList_[0] = "unfix"; + filePathList_[1] = "gravity"; + } + else + { + filePathList_[0] = "fix"; + filePathList_[1] = "gravity"; + filePathList_[2] = "all"; + filePathList_[3] = "gravity"; + filePathList_[4] = "number"; + filePathList_[5] = "vector"; + filePathList_[6] = "number"; + filePathList_[7] = "number"; + filePathList_[8] = "number"; + scalarList_[0]=gNorm; + scalarList_[1]=g[0]; + scalarList_[2]=g[1]; + scalarList_[3]=g[2]; + } + + command_=wordList(1); + + parseCommandList(filePathList_, labelList_, scalarList_, command_[0], propsDict_, timeStamp_); + Info << "liggghtsCommand " << command_[0] << endl; + + checkTimeSettings(propsDict_); +} + + +// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // + +setDEMGravity::~setDEMGravity() +{} + + +// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // +const char* setDEMGravity::command(int commandLine) +{ +Info << "commandLine=" << commandLine << endl; + strCommand_=string(command_[commandLine]); + + return strCommand_.c_str(); +} + +bool setDEMGravity::runCommand(int couplingStep) +{ + checkTimeSettings(propsDict_); + return runThisCommand(couplingStep); +} +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace Foam + +// ************************************************************************* // diff --git a/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/setDEMGravity/setDEMGravity.H b/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/setDEMGravity/setDEMGravity.H new file mode 100644 index 0000000..8caaeec --- /dev/null +++ b/src/lagrangian/cfdemParticle/subModels/liggghtsCommandModel/setDEMGravity/setDEMGravity.H @@ -0,0 +1,121 @@ +/*---------------------------------------------------------------------------*\ + CFDEMcoupling - Open Source CFD-DEM coupling + + CFDEMcoupling is part of the CFDEMproject + www.cfdem.com + Christoph Goniva, christoph.goniva@cfdem.com + Copyright 2009-2012 JKU Linz + Copyright 2012- DCS Computing GmbH, Linz +------------------------------------------------------------------------------- +License + This file is part of CFDEMcoupling. + + CFDEMcoupling 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. + + CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + for more details. + + You should have received a copy of the GNU General Public License + along with CFDEMcoupling; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +Description + This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS + and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER). + +Class + setDEMGravity + +SourceFiles + setDEMGravity.C + +\*---------------------------------------------------------------------------*/ + +#ifndef setDEMGravity_H +#define setDEMGravity_H + +#include "liggghtsCommandModel.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ + +/*---------------------------------------------------------------------------*\ + Class setDEMGravity Declaration +\*---------------------------------------------------------------------------*/ + +class setDEMGravity +: + public liggghtsCommandModel +{ +private: + + dictionary propsDict_; + + int nrModel_; + + int insertionNr_; + + wordList command_; + + wordList filePathList_; + + scalarList scalarList_; + + labelList labelList_; + + #ifdef version21 + const uniformDimensionedVectorField& g_; // ref to gravity + #elif defined(version16ext) || defined(version15) + const dimensionedVector& g_; // ref to gravity + #endif + + Switch unfix_; + +public: + + //- Runtime type information + TypeName("setDEMGravity"); + + + // Constructors + + //- Construct from components + setDEMGravity + ( + const dictionary& dict, + cfdemCloud& sm, + int i + ); + + // Destructor + + ~setDEMGravity(); + + + // Member Functions + + word name(){return typeName;}; + + const char* command(int); + + bool runCommand(int); + +}; + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace Foam + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // diff --git a/src/lagrangian/cfdemParticle/subModels/locateModel/engineSearch/engineSearch.C b/src/lagrangian/cfdemParticle/subModels/locateModel/engineSearch/engineSearch.C index 2dc56f4..260d9ef 100644 --- a/src/lagrangian/cfdemParticle/subModels/locateModel/engineSearch/engineSearch.C +++ b/src/lagrangian/cfdemParticle/subModels/locateModel/engineSearch/engineSearch.C @@ -56,13 +56,13 @@ addToRunTimeSelectionTable engineSearch::engineSearch ( const dictionary& dict, - cfdemCloud& sm + cfdemCloud& sm, + word name ) : locateModel(dict,sm), - propsDict_(dict.subDict(typeName + "Props")), - //faceDecomp_(propsDict_.lookup("faceDecomp")), - treeSearch_(propsDict_.lookup("treeSearch")), + propsDict_(dict.subDict(name == "" ? typeName + "Props" : name + "Props")), + treeSearch_(propsDict_.lookupOrDefault("treeSearch", true)), #if defined(version30) searchEngine_(particleCloud_.mesh(),polyMesh::FACE_PLANES) #elif defined(version21) @@ -70,7 +70,6 @@ engineSearch::engineSearch #elif defined(version16ext) searchEngine_(particleCloud_.mesh(),false) //(particleCloud_.mesh(),faceDecomp_) #endif - //searchEngine_(particleCloud_.mesh(),faceDecomp_) // only 2.0.x {} @@ -98,10 +97,7 @@ label engineSearch::findCell // create pos vector for(int i=0;i<3;i++) position[i] = positions[index][i]; - // find cell using tree search if switched on cellIDs[index][0] = searchEngine_.findCell(position,-1,treeSearch_); - //label cellIdOld = cellIDs[index][0]; - //cellIDs[index][0] = searchEngine_.findCell(position,cellIdOld,treeSearch_); } else cellIDs[index][0] = -1; } diff --git a/src/lagrangian/cfdemParticle/subModels/locateModel/engineSearch/engineSearch.H b/src/lagrangian/cfdemParticle/subModels/locateModel/engineSearch/engineSearch.H index b52f2bc..be7b493 100644 --- a/src/lagrangian/cfdemParticle/subModels/locateModel/engineSearch/engineSearch.H +++ b/src/lagrangian/cfdemParticle/subModels/locateModel/engineSearch/engineSearch.H @@ -57,17 +57,13 @@ class engineSearch public locateModel { -private: +protected: dictionary propsDict_; - //Switch faceDecomp_; - Switch treeSearch_; -protected: - - meshSearch searchEngine_; + mutable meshSearch searchEngine_; public: @@ -81,7 +77,8 @@ public: engineSearch ( const dictionary& dict, - cfdemCloud& sm + cfdemCloud& sm, + word name = word("") ); // Destructor @@ -90,7 +87,7 @@ public: // Member Functions - label findCell + virtual label findCell ( double** const& mask, double**& positions, diff --git a/src/lagrangian/cfdemParticle/subModels/locateModel/engineSearchIB/engineSearchIB.C b/src/lagrangian/cfdemParticle/subModels/locateModel/engineSearchIB/engineSearchIB.C index d06c8d3..580c1ce 100644 --- a/src/lagrangian/cfdemParticle/subModels/locateModel/engineSearchIB/engineSearchIB.C +++ b/src/lagrangian/cfdemParticle/subModels/locateModel/engineSearchIB/engineSearchIB.C @@ -64,16 +64,10 @@ engineSearchIB::engineSearchIB cfdemCloud& sm ) : - engineSearch(dict.subDict(typeName + "Props"),sm), - propsDict_(dict.subDict(typeName + "Props")), + engineSearch(dict,sm,typeName), zSplit_(readLabel(propsDict_.lookup("zSplit"))), - xySplit_(readLabel(propsDict_.lookup("xySplit"))), - checkPeriodicCells_(false) -{ - - if(propsDict_.found("checkPeriodicCells")) checkPeriodicCells_=true; - -} + xySplit_(readLabel(propsDict_.lookup("xySplit"))) +{} // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // @@ -93,13 +87,12 @@ label engineSearchIB::findCell int size ) const { - + bool checkPeriodicCells(particleCloud_.checkPeriodicCells()); int numprocs, me; MPI_Comm_size(MPI_COMM_WORLD, &numprocs); MPI_Comm_rank(MPI_COMM_WORLD, &me); const boundBox& globalBb = particleCloud_.mesh().bounds(); - vector position; for(int index = 0;index < size; ++index) { @@ -122,35 +115,14 @@ label engineSearchIB::findCell vector pos = position; label altStartPos = -1; label numberOfPoints = (zSplit_-1)*xySplit_ + 2; // 1 point at bottom, 1 point at top - label thetaLevel = 0; - scalar theta, phi; - const scalar thetaSize = 180./zSplit_, phiSize = 360./xySplit_; - const scalar deg2rad = M_PI/180.; for(int countPoints = 0; countPoints < numberOfPoints; ++countPoints) { - pos = position; - if(countPoints == 0) - { - pos[2] += radius; - } - else if(countPoints == 1) - { - pos[2] -= radius; - } - else - { - thetaLevel = (countPoints - 2) / xySplit_; - theta = deg2rad * thetaSize * (thetaLevel+1); - phi = deg2rad * phiSize * (countPoints - 2 - thetaLevel*xySplit_); - pos[0] += radius * sin(theta) * cos(phi); - pos[1] += radius * sin(theta) * sin(phi); - pos[2] += radius * cos(theta); - } + pos = generateSatellitePoint(index, countPoints); - altStartPos=findSingleCell(pos,oldID); //particleCloud_.mesh().findCell(pos);// + altStartPos=findSingleCell(pos,oldID); //particleCloud_.mesh().findCell(pos);// //check for periodic domains - if(checkPeriodicCells_) + if(checkPeriodicCells) { for(int iDir=0;iDir<3;iDir++) { @@ -163,7 +135,7 @@ label engineSearchIB::findCell pos[iDir]+=globalBb.max()[iDir]-globalBb.min()[iDir]; } } - altStartPos=findSingleCell(pos,oldID); //particleCloud_.mesh().findCell(pos);// + altStartPos=findSingleCell(pos,oldID); //particleCloud_.mesh().findCell(pos);// } if(altStartPos >= 0) // found position, we're done @@ -179,6 +151,29 @@ label engineSearchIB::findCell return 1; } +vector engineSearchIB::generateSatellitePoint(int index, int countPoints) const +{ + vector position = particleCloud_.position(index); + scalar theta, phi; + const scalar thetaSize = 180./zSplit_, phiSize = 360./xySplit_; + const scalar deg2rad = M_PI/180.; + vector pos = position; + double radius=particleCloud_.radius(index); + if(countPoints == 0) { + pos[2] += radius; + } else if(countPoints == 1) { + pos[2] -= radius; + } else { + scalar thetaLevel = (countPoints - 2) / xySplit_; + theta = deg2rad * thetaSize * (thetaLevel+1); + phi = deg2rad * phiSize * (countPoints - 2 - thetaLevel*xySplit_); + pos[0] += radius * sin(theta) * cos(phi); + pos[1] += radius * sin(theta) * sin(phi); + pos[2] += radius * cos(theta); + } + return pos; +} + // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // diff --git a/src/lagrangian/cfdemParticle/subModels/locateModel/engineSearchIB/engineSearchIB.H b/src/lagrangian/cfdemParticle/subModels/locateModel/engineSearchIB/engineSearchIB.H index dcd24ed..17a5c39 100644 --- a/src/lagrangian/cfdemParticle/subModels/locateModel/engineSearchIB/engineSearchIB.H +++ b/src/lagrangian/cfdemParticle/subModels/locateModel/engineSearchIB/engineSearchIB.H @@ -56,13 +56,9 @@ class engineSearchIB { protected: - dictionary propsDict_; - const label zSplit_; const label xySplit_; - - bool checkPeriodicCells_; public: @@ -93,6 +89,12 @@ public: int size ) const; + virtual vector generateSatellitePoint + ( + int index, + int countPoints + ) const; + }; diff --git a/src/lagrangian/cfdemParticle/subModels/momCoupleModel/explicitCouple/explicitCouple.C b/src/lagrangian/cfdemParticle/subModels/momCoupleModel/explicitCouple/explicitCouple.C index b0168b0..0aa4767 100644 --- a/src/lagrangian/cfdemParticle/subModels/momCoupleModel/explicitCouple/explicitCouple.C +++ b/src/lagrangian/cfdemParticle/subModels/momCoupleModel/explicitCouple/explicitCouple.C @@ -128,30 +128,21 @@ void Foam::explicitCouple::applyDebugSettings(bool debug) const } } +// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +dimensionedVector explicitCouple::returnIntegralSourceField() const +{ + //Sum is over cells of PROCESOR ONLY!! + dimensionedVector intSource = dimensionedVector("0", dimensionSet(1, 1, -2, 0, 0), vector::zero); + forAll(sourceField_,cellI) + intSource.value() += sourceField_.internalField()[cellI] * particleCloud_.mesh().V()[cellI]; + + return intSource; // in Newton +} + +// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - tmp explicitCouple::expMomSource() const { - tmp tsource - ( - new volVectorField - ( - IOobject - ( - "f_explicitCouple", - particleCloud_.mesh().time().timeName(), - particleCloud_.mesh(), - IOobject::NO_READ, - IOobject::NO_WRITE - ), - particleCloud_.mesh(), - dimensionedVector - ( - "zero", - dimensionSet(1, -2, -2, 0, 0), // N/m3 - vector::zero - ) - ) - ); - + //This INCLUDES the source field that is set separately! scalar tsf = particleCloud_.dataExchangeM().timeStepFraction(); if(1-tsf < 1e-4) //tsf==1 @@ -167,23 +158,32 @@ tmp explicitCouple::expMomSource() const if (mag(fNext_[cellI][i]) > fLimit_[i]) fNext_[cellI][i] = fLimit_[i]; } } - tsource() = fPrev_; + return tmp + ( + new volVectorField("f_explicitCouple", fPrev_) + ); }else { - tsource() = (1 - tsf) * fPrev_ + tsf * fNext_; + return tmp + ( + new volVectorField("f_explicitCouple", (1 - tsf) * fPrev_ + tsf * fNext_) + ); } - return tsource; } +// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - void Foam::explicitCouple::resetMomSourceField() const { - fPrev_.internalField() = fNext_.internalField(); - fNext_.internalField() = vector::zero; + fPrev_ == fNext_; + fNext_ == dimensionedVector("zero", fNext_.dimensions(), vector::zero); } +// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - inline vector Foam::explicitCouple::arrayToField(label cellI) const { - return particleCloud_.forceM(0).expParticleForces()[cellI] / particleCloud_.mesh().V()[cellI] + sourceField_[cellI]; + //This INCLUDES the source field that is set separately! + return particleCloud_.forceM(0).expParticleForces()[cellI] / particleCloud_.mesh().V()[cellI] + + sourceField_[cellI]; } void Foam::explicitCouple::setSourceField(volVectorField & field) const diff --git a/src/lagrangian/cfdemParticle/subModels/momCoupleModel/explicitCouple/explicitCouple.H b/src/lagrangian/cfdemParticle/subModels/momCoupleModel/explicitCouple/explicitCouple.H index 3a88ef0..04dfc00 100644 --- a/src/lagrangian/cfdemParticle/subModels/momCoupleModel/explicitCouple/explicitCouple.H +++ b/src/lagrangian/cfdemParticle/subModels/momCoupleModel/explicitCouple/explicitCouple.H @@ -97,6 +97,8 @@ public: void resetMomSourceField() const; void setSourceField(volVectorField &) const; + + dimensionedVector returnIntegralSourceField() const; }; diff --git a/src/lagrangian/cfdemParticle/subModels/momCoupleModel/implicitCouple/implicitCouple.C b/src/lagrangian/cfdemParticle/subModels/momCoupleModel/implicitCouple/implicitCouple.C index 6da34fa..c6729f8 100644 --- a/src/lagrangian/cfdemParticle/subModels/momCoupleModel/implicitCouple/implicitCouple.C +++ b/src/lagrangian/cfdemParticle/subModels/momCoupleModel/implicitCouple/implicitCouple.C @@ -131,28 +131,6 @@ void Foam::implicitCouple::applyDebugSettings(bool debug) const tmp implicitCouple::impMomSource() const { - tmp tsource - ( - new volScalarField - ( - IOobject - ( - "Ksl_implicitCouple", - particleCloud_.mesh().time().timeName(), - particleCloud_.mesh(), - IOobject::NO_READ, - IOobject::NO_WRITE - ), - particleCloud_.mesh(), - dimensionedScalar - ( - "zero", - dimensionSet(1, -3, -1, 0, 0), // N/m3 / m/s - 0 - ) - ) - ); - scalar tsf = particleCloud_.dataExchangeM().timeStepFraction(); // calc Ksl @@ -175,19 +153,23 @@ tmp implicitCouple::impMomSource() const // limiter if (KslNext_[cellI] > KslLimit_) KslNext_[cellI] = KslLimit_; } - tsource() = KslPrev_; + return tmp + ( + new volScalarField("Ksl_implicitCouple", KslPrev_) + ); }else { - tsource() = (1 - tsf) * KslPrev_ + tsf * KslNext_; + return tmp + ( + new volScalarField("Ksl_implicitCouple", (1 - tsf) * KslPrev_ + tsf * KslNext_) + ); } - - return tsource; } void Foam::implicitCouple::resetMomSourceField() const { - KslPrev_.internalField() = KslNext_.internalField(); - KslNext_.internalField() = 0; + KslPrev_ == KslNext_; + KslNext_ == dimensionedScalar("zero", KslNext_.dimensions(), 0.0); } // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // diff --git a/src/lagrangian/cfdemParticle/subModels/momCoupleModel/momCoupleModel/momCoupleModel.C b/src/lagrangian/cfdemParticle/subModels/momCoupleModel/momCoupleModel/momCoupleModel.C index 9478883..d13db22 100644 --- a/src/lagrangian/cfdemParticle/subModels/momCoupleModel/momCoupleModel/momCoupleModel.C +++ b/src/lagrangian/cfdemParticle/subModels/momCoupleModel/momCoupleModel/momCoupleModel.C @@ -55,6 +55,7 @@ tmp momCoupleModel::impMomSource() const return tsource; } +// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - tmp momCoupleModel::expMomSource() const { FatalError<<"the solver calls for expMomSource()\n" @@ -64,11 +65,22 @@ tmp momCoupleModel::expMomSource() const return tsource; } +// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - void momCoupleModel::setSourceField(volVectorField & a) const { //do nothing; } +// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +dimensionedVector momCoupleModel::returnIntegralSourceField() const +{ + FatalError<<"the solver calls for returnIntegralSourceField()\n" + <<", please set 'momCoupleModel' to type 'explicitCouple' to access this data.\n" + << abort(FatalError); + + return dimensionedVector("0", dimensionSet(1, 1, -2, 0, 0), vector::zero); // Newton +} + // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // // Construct from components diff --git a/src/lagrangian/cfdemParticle/subModels/momCoupleModel/momCoupleModel/momCoupleModel.H b/src/lagrangian/cfdemParticle/subModels/momCoupleModel/momCoupleModel/momCoupleModel.H index fc05165..c0d7858 100644 --- a/src/lagrangian/cfdemParticle/subModels/momCoupleModel/momCoupleModel/momCoupleModel.H +++ b/src/lagrangian/cfdemParticle/subModels/momCoupleModel/momCoupleModel/momCoupleModel.H @@ -121,6 +121,8 @@ public: virtual void resetMomSourceField() const=0; virtual void setSourceField(volVectorField &) const; + + virtual dimensionedVector returnIntegralSourceField() const; }; diff --git a/src/lagrangian/cfdemParticle/subModels/probeModel/particleProbe/particleProbe.C b/src/lagrangian/cfdemParticle/subModels/probeModel/particleProbe/particleProbe.C index b8045f8..b1c455c 100644 --- a/src/lagrangian/cfdemParticle/subModels/probeModel/particleProbe/particleProbe.C +++ b/src/lagrangian/cfdemParticle/subModels/probeModel/particleProbe/particleProbe.C @@ -110,21 +110,28 @@ particleProbe::~particleProbe() // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // -void particleProbe::setOutputFile() const +void particleProbe::setOutputFile(const word& logFileName) const { - if(itemCounter_>0) + bool foundFile = false; + if(itemCounter_>0 && verboseToFile_ ) { - //set the current item ID - if(currItemId_== itemCounter_) - currItemId_=1; - else - currItemId_+=1; - sPtr = sPtrList_[currItemId_-1]; //set the pointer to the output file from list - probeIndex_=currItemId_-1; + forAll(itemsToSample_, iterator) + { + if(itemsToSample_[iterator] == logFileName) + { + probeIndex_ = iterator ; + foundFile = true; + } + } + + if(!foundFile) + FatalError << "particleProbe::setOutputFile for logFileName " << logFileName << " : "<< "File not found" << abort(FatalError); + currItemId_ = probeIndex_ + 1; + setCounter(); //set counter, will auto-check if first item } } - +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * void particleProbe::initialize(const word& modelName,const word& logFileName) const { //update the list of items to be sampled @@ -157,9 +164,10 @@ void particleProbe::initialize(const word& modelName,const word& logFileName) co MPI_Comm_rank(MPI_COMM_WORLD,&rank_); //open a separate file for each processor - char* filecurrent_ = new char[strlen(fileNameOut_) + 4]; //reserve 4 chars for processor name + char* filecurrent_ = new char[strlen(fileNameOut_) + 5]; //reserve 4 chars for processor name sprintf(filecurrent_,"%s%s%d", fileNameOut_, ".", rank_); - Info << "particleProbe for model " << name_ << " will write to file " << filecurrent_ << endl; + Info << "particleProbe for model " << name_ << " will write to file " << filecurrent_ + << ". This is item " << itemCounter_ << " to probe." << endl; //generate the file streams fileName probeSubDir = dirName_; @@ -196,8 +204,9 @@ void particleProbe::initialize(const word& modelName,const word& logFileName) co Info << "particleProbe::initialize done!" << endl; return; - } + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * void particleProbe::writeHeader() const { @@ -230,6 +239,7 @@ void particleProbe::writeHeader() const } +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * void particleProbe::clearProbes() const { @@ -256,6 +266,7 @@ void particleProbe::clearProbes() const vProbes_.clear(); } +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * void particleProbe::updateProbes(int index, Field sValues, Field vValues) const { //check if the particle already has an allocated vector. If not, create it. It should be only called at the beginning. @@ -299,16 +310,18 @@ void particleProbe::updateProbes(int index, Field sValues, Field } } +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * void particleProbe::writeProbe(int index, Field sValues, Field vValues) const { updateProbes(index,sValues,vValues); //update probe vectors if(printNow_ && checkIDForPrint(index) && verboseToFile_) { + sPtr = sPtrList_[probeIndex_]; //set the pointer to the output file from list //index and time - *sPtr << setprecision(IOstream::defaultPrecision()+7) ; - *sPtr << index << tab + *sPtr << setprecision(IOstream::defaultPrecision()+7) ; + *sPtr << index << tab << particleCloud_.mesh().time().value() << " " ; *sPtr << "|| "; @@ -341,13 +354,13 @@ void particleProbe::writeProbe(int index, Field sValues, Field v << endl; } else *sPtr << endl; - } return; } +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * bool particleProbe::checkIDForPrint(int index) const { @@ -363,6 +376,7 @@ bool particleProbe::checkIDForPrint(int index) const return sampleThisId_; } +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * void particleProbe::setCounter() const { @@ -370,7 +384,7 @@ void particleProbe::setCounter() const //Do only if called by first item in the list of items! if(currItemId_==1) { - printCounter_++; + printCounter_++; if(printOnlyAt_==-1) { if( printCounter_ >= printEvery_ ) @@ -393,7 +407,6 @@ void particleProbe::setCounter() const return; } - // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // } // End namespace Foam diff --git a/src/lagrangian/cfdemParticle/subModels/probeModel/particleProbe/particleProbe.H b/src/lagrangian/cfdemParticle/subModels/probeModel/particleProbe/particleProbe.H index 92f5748..6004b5a 100644 --- a/src/lagrangian/cfdemParticle/subModels/probeModel/particleProbe/particleProbe.H +++ b/src/lagrangian/cfdemParticle/subModels/probeModel/particleProbe/particleProbe.H @@ -136,7 +136,7 @@ public: // Member Functions void updateProbes(int index, Field sValues, Field vValues) const; void initialize(const word& modelName, const word& logFileName) const; - void setOutputFile() const; + void setOutputFile(const word& logFileName) const; void writeHeader() const; void writeProbe(int index, Field sValues, Field vValues) const; bool checkIDForPrint(int) const; diff --git a/src/lagrangian/cfdemParticle/subModels/probeModel/probeModel/probeModel.H b/src/lagrangian/cfdemParticle/subModels/probeModel/probeModel/probeModel.H index 087fe89..cb4f623 100644 --- a/src/lagrangian/cfdemParticle/subModels/probeModel/probeModel/probeModel.H +++ b/src/lagrangian/cfdemParticle/subModels/probeModel/probeModel/probeModel.H @@ -134,7 +134,7 @@ public: // Member Functions virtual void initialize(const word& modelName, const word& logFileName) const {}; - virtual void setOutputFile() const {}; + virtual void setOutputFile(const word& logFileName) const {}; virtual void writeHeader() const {}; virtual void writeProbe(int index, Field sValues, Field vValues) const {}; virtual bool checkIDForPrint(int) const {return false;}; diff --git a/src/lagrangian/cfdemParticle/subModels/smoothingModel/constDiffSmoothing/constDiffSmoothing.C b/src/lagrangian/cfdemParticle/subModels/smoothingModel/constDiffSmoothing/constDiffSmoothing.C index 695e515..f657bfd 100644 --- a/src/lagrangian/cfdemParticle/subModels/smoothingModel/constDiffSmoothing/constDiffSmoothing.C +++ b/src/lagrangian/cfdemParticle/subModels/smoothingModel/constDiffSmoothing/constDiffSmoothing.C @@ -93,14 +93,14 @@ bool constDiffSmoothing::doSmoothing() const return true; } - +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // void Foam::constDiffSmoothing::smoothen(volScalarField& fieldSrc) const { // Create scalar smooth field from virgin scalar smooth field template volScalarField sSmoothField = sSmoothField_; sSmoothField.dimensions().reset(fieldSrc.dimensions()); - sSmoothField.internalField()=fieldSrc.internalField(); + sSmoothField ==fieldSrc; sSmoothField.correctBoundaryConditions(); sSmoothField.oldTime().dimensions().reset(fieldSrc.dimensions()); sSmoothField.oldTime()=fieldSrc; @@ -141,7 +141,7 @@ void Foam::constDiffSmoothing::smoothen(volVectorField& fieldSrc) const volVectorField vSmoothField = vSmoothField_; vSmoothField.dimensions().reset(fieldSrc.dimensions()); - vSmoothField.internalField()=fieldSrc.internalField(); + vSmoothField=fieldSrc; vSmoothField.correctBoundaryConditions(); vSmoothField.oldTime().dimensions().reset(fieldSrc.dimensions()); vSmoothField.oldTime()=fieldSrc; @@ -176,7 +176,7 @@ void Foam::constDiffSmoothing::smoothenReferenceField(volVectorField& fieldSrc) volVectorField vSmoothField = vSmoothField_; vSmoothField.dimensions().reset(fieldSrc.dimensions()); - vSmoothField.internalField()=fieldSrc.internalField(); + vSmoothField=fieldSrc; vSmoothField.correctBoundaryConditions(); vSmoothField.oldTime().dimensions().reset(fieldSrc.dimensions()); vSmoothField.oldTime()=fieldSrc; @@ -188,21 +188,18 @@ void Foam::constDiffSmoothing::smoothenReferenceField(volVectorField& fieldSrc) DT_.value() = smoothingLengthReferenceField_.value() * smoothingLengthReferenceField_.value() / deltaT.value(); - tmp NLarge + volScalarField NLarge ( - new volScalarField + IOobject ( - IOobject - ( - "xxx", - particleCloud_.mesh().time().timeName(), - particleCloud_.mesh(), - IOobject::NO_READ, - IOobject::NO_WRITE - ), + "NLarge", + particleCloud_.mesh().time().timeName(), particleCloud_.mesh(), - 0.0 - ) + IOobject::NO_READ, + IOobject::NO_WRITE + ), + particleCloud_.mesh(), + 0.0 ); @@ -210,7 +207,7 @@ void Foam::constDiffSmoothing::smoothenReferenceField(volVectorField& fieldSrc) forAll(vSmoothField,cellI) { if ( mag(vSmoothField.oldTime().internalField()[cellI]) > 0.0f) // have a vector in the OLD vSmoothField, so keep it! - NLarge()[cellI] = sourceStrength; + NLarge[cellI] = sourceStrength; } // do the smoothing @@ -219,8 +216,8 @@ void Foam::constDiffSmoothing::smoothenReferenceField(volVectorField& fieldSrc) fvm::ddt(vSmoothField) -fvm::laplacian( DT_, vSmoothField) == - NLarge() / deltaT * vSmoothField.oldTime() //add source to keep cell values constant - -fvm::Sp( NLarge() / deltaT, vSmoothField) //add sink to keep cell values constant + NLarge / deltaT * vSmoothField.oldTime() //add source to keep cell values constant + -fvm::Sp( NLarge / deltaT, vSmoothField) //add sink to keep cell values constant ); // get data from working vSmoothField diff --git a/src/lagrangian/cfdemParticle/subModels/smoothingModel/noSmoothing/noSmoothing.C b/src/lagrangian/cfdemParticle/subModels/smoothingModel/noSmoothing/noSmoothing.C index 01a73ab..ef8e2d2 100644 --- a/src/lagrangian/cfdemParticle/subModels/smoothingModel/noSmoothing/noSmoothing.C +++ b/src/lagrangian/cfdemParticle/subModels/smoothingModel/noSmoothing/noSmoothing.C @@ -76,6 +76,12 @@ void Foam::noSmoothing::smoothen(volScalarField& field) const void Foam::noSmoothing::smoothen(volVectorField& field) const {} +void Foam::noSmoothing::smoothenAbsolutField(volScalarField& field) const +{} + +void Foam::noSmoothing::smoothenAbsolutField(volVectorField& field) const +{} + void Foam::noSmoothing::smoothenReferenceField(volVectorField& field) const {} diff --git a/src/lagrangian/cfdemParticle/subModels/smoothingModel/noSmoothing/noSmoothing.H b/src/lagrangian/cfdemParticle/subModels/smoothingModel/noSmoothing/noSmoothing.H index d26ad39..559029f 100644 --- a/src/lagrangian/cfdemParticle/subModels/smoothingModel/noSmoothing/noSmoothing.H +++ b/src/lagrangian/cfdemParticle/subModels/smoothingModel/noSmoothing/noSmoothing.H @@ -80,6 +80,10 @@ public: void smoothen(volVectorField&) const; + void smoothenAbsolutField(volScalarField&) const; + + void smoothenAbsolutField(volVectorField&) const; + void smoothenReferenceField(volVectorField&) const; }; diff --git a/src/lagrangian/cfdemParticle/subModels/smoothingModel/smoothingModel/smoothingModel.C b/src/lagrangian/cfdemParticle/subModels/smoothingModel/smoothingModel/smoothingModel.C index b906a16..d20b639 100644 --- a/src/lagrangian/cfdemParticle/subModels/smoothingModel/smoothingModel/smoothingModel.C +++ b/src/lagrangian/cfdemParticle/subModels/smoothingModel/smoothingModel/smoothingModel.C @@ -129,6 +129,34 @@ void smoothingModel::dSmoothing() const //dSmooth *= 0.0; } + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // +void smoothingModel::smoothenAbsolutField(volScalarField& scalField) const +{ + + //1 - First make the field volume-specific + particleCloud_.makeSpecific(scalField); + + //2 - smoothen now the volume-specific field (the volume integral of this field will be conserved!) + smoothen(scalField); + + //3 - Finally, make field absolute again + particleCloud_.scaleWithVcell(scalField); +} + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // +void smoothingModel::smoothenAbsolutField(volVectorField& vecField) const +{ + + //1 - First make the field volume-specific + particleCloud_.makeSpecific(vecField); + + //2 - smoothen now the volume-specific field (the volume integral of this field will be conserved!) + smoothen(vecField); + + //3 - Finally, make field absolute again + particleCloud_.scaleWithVcell(vecField); +} } // End namespace Foam // ************************************************************************* // diff --git a/src/lagrangian/cfdemParticle/subModels/smoothingModel/smoothingModel/smoothingModel.H b/src/lagrangian/cfdemParticle/subModels/smoothingModel/smoothingModel/smoothingModel.H index d0c56a6..330855e 100644 --- a/src/lagrangian/cfdemParticle/subModels/smoothingModel/smoothingModel/smoothingModel.H +++ b/src/lagrangian/cfdemParticle/subModels/smoothingModel/smoothingModel/smoothingModel.H @@ -116,6 +116,10 @@ public: virtual void smoothen(volVectorField&) const=0; + virtual void smoothenAbsolutField(volScalarField&) const; //for smoothing absolute fields (NOT per m³) + + virtual void smoothenAbsolutField(volVectorField&) const; //for smoothing absolute fields (NOT per m³) + virtual void smoothenReferenceField(volVectorField&) const=0; }; diff --git a/src/lagrangian/cfdemParticle/subModels/voidFractionModel/GaussVoidFraction/GaussVoidFraction.C b/src/lagrangian/cfdemParticle/subModels/voidFractionModel/GaussVoidFraction/GaussVoidFraction.C index 40b8f7a..020f6f0 100644 --- a/src/lagrangian/cfdemParticle/subModels/voidFractionModel/GaussVoidFraction/GaussVoidFraction.C +++ b/src/lagrangian/cfdemParticle/subModels/voidFractionModel/GaussVoidFraction/GaussVoidFraction.C @@ -91,7 +91,7 @@ void GaussVoidFraction::setvoidFraction(double** const& mask,double**& voidfract { reAllocArrays(); - voidfractionNext_.internalField()=1; + voidfractionNext_ == dimensionedScalar("one", voidfractionNext_.dimensions(), 1.); scalar radius(-1); scalar volume(0); diff --git a/src/lagrangian/cfdemParticle/subModels/voidFractionModel/IBVoidFraction/IBVoidFraction.C b/src/lagrangian/cfdemParticle/subModels/voidFractionModel/IBVoidFraction/IBVoidFraction.C index b3e16e5..083275e 100755 --- a/src/lagrangian/cfdemParticle/subModels/voidFractionModel/IBVoidFraction/IBVoidFraction.C +++ b/src/lagrangian/cfdemParticle/subModels/voidFractionModel/IBVoidFraction/IBVoidFraction.C @@ -68,8 +68,7 @@ IBVoidFraction::IBVoidFraction propsDict_(dict.subDict(typeName + "Props")), alphaMin_(readScalar(propsDict_.lookup("alphaMin"))), alphaLimited_(0), - scaleUpVol_(readScalar(propsDict_.lookup("scaleUpVol"))), - checkPeriodicCells_(false) + scaleUpVol_(readScalar(propsDict_.lookup("scaleUpVol"))) { Info << "\n\n W A R N I N G - do not use in combination with differentialRegion model! \n\n" << endl; //Info << "\n\n W A R N I N G - this model does not yet work properly! \n\n" << endl; @@ -79,7 +78,6 @@ IBVoidFraction::IBVoidFraction if(scaleUpVol_ < 1){ FatalError<< "scaleUpVol shloud be > 1."<< abort(FatalError); } if(alphaMin_ > 1 || alphaMin_ < 0.01){ FatalError<< "alphaMin shloud be > 1 and < 0.01." << abort(FatalError); } - if(propsDict_.found("checkPeriodicCells")) checkPeriodicCells_=true; } @@ -101,7 +99,7 @@ void IBVoidFraction::setvoidFraction(double** const& mask,double**& voidfraction reAllocArrays(); - voidfractionNext_.internalField()=1; + voidfractionNext_ == dimensionedScalar("one", voidfractionNext_.dimensions(), 1.); for(int index=0; index< particleCloud_.numberOfParticles(); index++) { @@ -127,87 +125,55 @@ void IBVoidFraction::setvoidFraction(double** const& mask,double**& voidfraction //compute the voidfraction for the cell "particleCentreCellID vector cellCentrePosition = particleCloud_.mesh().C()[particleCenterCellID]; - scalar centreDist=mag(cellCentrePosition-positionCenter); + scalar fc = pointInParticle(index, positionCenter, cellCentrePosition); vector minPeriodicParticlePos=positionCenter; - if(checkPeriodicCells_) //consider minimal distance to all periodic images of this particle + if(particleCloud_.checkPeriodicCells()) //consider minimal distance to all periodic images of this particle { - centreDist = minPeriodicDistance(cellCentrePosition, positionCenter, globalBb, + fc = minPeriodicDistance(index,cellCentrePosition, positionCenter, globalBb, minPeriodicParticlePos); } + scalar centreDist=mag(cellCentrePosition-minPeriodicParticlePos); + scalar corona = 0.5*sqrt(3.0)*pow(particleCloud_.mesh().V()[particleCenterCellID],0.33333); + vector coronaPoint = cellCentrePosition + (cellCentrePosition - minPeriodicParticlePos) * (corona / centreDist); - if(centreDist + 0.5*sqrt(3.0)*pow(particleCloud_.mesh().V()[particleCenterCellID],0.33333) < radius) + if(pointInParticle(index, minPeriodicParticlePos, coronaPoint) < 0.0) { voidfractionNext_[particleCenterCellID] = 0; } else { - const labelList& vertices = particleCloud_.mesh().cellPoints()[particleCenterCellID]; - forAll(vertices, i) + const labelList& vertices = particleCloud_.mesh().cellPoints()[particleCenterCellID]; + int nn = 0.0; + forAll(vertices, i) nn ++; + + double ratio = 0.125; //1.0 / static_cast(nn); + forAll(vertices, i) { - vector vertexPosition = particleCloud_.mesh().points()[vertices[i]]; - scalar centreVertexDist = mag(vertexPosition-positionCenter); - if(checkPeriodicCells_) //consider minimal distance to all periodic images of this particle - { - centreVertexDist = minPeriodicDistance(vertexPosition, positionCenter, globalBb, - minPeriodicParticlePos); - } - - if(centreDistradius) - { - //compute lambda - scalar a = (vertexPosition - cellCentrePosition) - & (vertexPosition - cellCentrePosition); - scalar b = 2. * (vertexPosition - cellCentrePosition) - & (cellCentrePosition-minPeriodicParticlePos); - scalar c = ((cellCentrePosition-minPeriodicParticlePos) - & (cellCentrePosition-minPeriodicParticlePos) - ) - - radius*radius; - - scalar lambda = 0.; - - if (b*b-4*a*c>=0) lambda = (-b+sqrt(b*b-4*a*c))/(2*a); - if (lambda > 0 && lambda <=1) voidfractionNext_[particleCenterCellID]-=lambda*.125; - else - { - lambda = (-b-sqrt(b*b-4*a*c))/(2*a); - if (lambda > 0 && lambda <=1) voidfractionNext_[particleCenterCellID]-=lambda*.125; - } - } - else if(centreDist>radius && centreVertexDist=0) lambda = (-b+sqrt(b*b-4*a*c))/(2*a); - if(lambda > 0 && lambda <=1) voidfractionNext_[particleCenterCellID]-=(1-lambda)*0.125; - else - { - lambda = (-b-sqrt(b*b-4*a*c))/(2*a); - if (lambda > 0 && lambda <=1) voidfractionNext_[particleCenterCellID]-=(1-lambda)*0.125; - } - } - } + vector vertexPosition = particleCloud_.mesh().points()[vertices[i]]; + scalar fv = pointInParticle(index, positionCenter, vertexPosition); + if(particleCloud_.checkPeriodicCells()) { //consider minimal distance to all periodic images of this particle + fv = minPeriodicDistance(index,vertexPosition, positionCenter, globalBb, minPeriodicParticlePos); + } + if(fc < 0.0 && fv < 0.0) + voidfractionNext_[particleCenterCellID]-=ratio; + else if(fc < 0.0 && fv > 0.0) { + //compute lambda + scalar lambda = segmentParticleIntersection(index, minPeriodicParticlePos, cellCentrePosition, vertexPosition); + voidfractionNext_[particleCenterCellID] -= ratio*lambda; + } else if(fc > 0.0 && fv < 0.0) { + //compute lambda + scalar lambda = segmentParticleIntersection(index, minPeriodicParticlePos, vertexPosition, cellCentrePosition); + voidfractionNext_[particleCenterCellID] -= ratio*lambda; + } + } } //end particle partially overlapping with cell //generating list with cell and subcells - buildLabelHashSet(radius, minPeriodicParticlePos, particleCenterCellID, hashSett, true); + buildLabelHashSet(index,minPeriodicParticlePos, particleCenterCellID, hashSett, true); //Add cells of periodic particle images on same processor - if(checkPeriodicCells_) + if(particleCloud_.checkPeriodicCells()) { int doPeriodicImage[3]; for(int iDir=0;iDir<3;iDir++) @@ -227,117 +193,100 @@ void IBVoidFraction::setvoidFraction(double** const& mask,double**& voidfraction List particlePosList; //List of particle center position List