diff --git a/.github/workflows/compile.yml b/.github/workflows/compile.yml
index faee29b..8fb43af 100644
--- a/.github/workflows/compile.yml
+++ b/.github/workflows/compile.yml
@@ -1,31 +1,49 @@
-# Build and test the solver using Docker containers
+# Build the solver and run a short smoke test of the tutorial
name: Build and test
on:
workflow_dispatch:
pull_request:
push:
+ branches: [main]
+
+permissions:
+ contents: read
jobs:
build-and-test:
runs-on: ubuntu-22.04
strategy:
+ fail-fast: false
matrix:
- container-image:
- - name: "OpenFOAM-v2312"
- image: "opencfd/openfoam-dev:2312"
- source: "/usr/lib/openfoam/openfoam2312/etc/bashrc"
- buildflags: "-j"
+ version: ["2312", "2512"]
container:
- image: ${{ matrix.container-image.image }}
+ image: opencfd/openfoam-dev:${{ matrix.version }}
steps:
- - uses: actions/checkout@v3
+ - uses: actions/checkout@v4
- - name: make
- shell: bash -l {0}
+ # OpenFOAM's bashrc is not safe under "bash -e": source it first
+ - name: Build
+ shell: bash {0}
run: |
- source ${{ matrix.container-image.source }}
- (cd src && wmake)
+ source /usr/lib/openfoam/openfoam${{ matrix.version }}/etc/bashrc
+ set -eo pipefail
+ cd src && wmake 2>&1 | tee log.wmake
+ test -x "$FOAM_USER_APPBIN/interTrackFoam"
+ - name: Smoke test (bubbleColumn, coarse mesh, 20 steps)
+ shell: bash {0}
+ run: |
+ source /usr/lib/openfoam/openfoam${{ matrix.version }}/etc/bashrc
+ set -eo pipefail
+ cp -r Tutorial/bubbleColumn "$RUNNER_TEMP/case" && cd "$RUNNER_TEMP/case"
+ sed -i 's/(160 320 1)/(40 80 1)/' system/blockMeshDict
+ foamDictionary -entry levelSet/cellSize -remove constant/transportProperties
+ foamDictionary -entry endTime -set 0.0078125 system/controlDict
+ foamDictionary -entry writeInterval -set 0.0078125 system/controlDict
+ ./Allrun
+ grep -q '^End' log.interTrackFoam
+ test -s postProcessing/bubble/0/volFieldValue.dat
+ tail -n 2 postProcessing/bubble/0/volFieldValue.dat
diff --git a/.gitignore b/.gitignore
index 2b30571..05c3c75 100644
--- a/.gitignore
+++ b/.gitignore
@@ -153,3 +153,12 @@ PlyParser_FoamFileParser_parsetab.py
/.tags
# end-of-file
+
+# tutorial run output (0.orig holds the initial fields)
+Tutorial/*/0/
+Tutorial/*/0.[0-9]*/
+Tutorial/*/[1-9]*/
+Tutorial/*/constant/polyMesh/
+Tutorial/*/postProcessing/
+Tutorial/*/processor*/
+Tutorial/*/log.*
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..f288702
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ 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/README.md b/README.md
index d2ef4eb..463823d 100644
--- a/README.md
+++ b/README.md
@@ -1,63 +1,122 @@
-# Level-Set and VOF Hybrid Method in OpenFOAM
-
-
-
-## Overview
-This repository contains the implementation of a **hybrid Level-Set and Volume of Fluid (VOF) method** for interface tracking in OpenFOAM. The hybrid approach combines the high interface precision of the Level-Set method with the mass conservation benefits of the VOF method, enabling robust and accurate multiphase flow simulations.
-
-The solver is designed for applications such as:
-- Free-surface flows
-- Droplet dynamics
-- Multiphase interactions
-- Interface capturing in complex geometries
-
-
-
-## Features
-- **Hybrid Level-Set and VOF Approach**: Improved interface tracking by leveraging both methods.
-- **Mass Conservation**: Retains the advantages of VOF for global mass conservation.
-- **Sharp Interface Representation**: Enhanced by the Level-Set method's ability to track fine interface details.
-- **Robust Solver**: Built on the OpenFOAM framework for extensibility and flexibility.
-- **Customization Options**: Adjustable parameters for interface smoothing, reinitialization, and flux correction.
-
-## Installation
- **Clone the Repository**:
- ```bash
- git clone https://github.com/cloner0110/LevelSet-VOF.git
- cd LevelSet-VOF/src && wmake
- ```
-
-
-## Prerequisites
-- **OpenFOAM** (v2312)
-
-## Methodology
-This implementation integrates:
-1. **Level-Set Method**: Solves for a signed distance function to track interfaces.
-2. **VOF Method**: Utilizes a volume fraction field for mass conservation.
-3. **Hybrid Correction**:
- - Reinitialization of the Level-Set field.
- - Flux corrections to ensure interface consistency.
-
-
-## Contact
-For questions, feedback, or collaboration inquiries, please reach out:
-- **Email**: [amirhossein.taran@ucdconnect.ie](mailto:amirhossein.taran@ucdconnect.ie)
-- **GitHub Issues**: [Report an Issue](https://github.com/cloner0110/LevelSet-VOF/issues)
-
-
+# Coupled Level-Set / VOF Solver for OpenFOAM
+
+
+
+
+`interTrackFoam` simulates two incompressible, immiscible fluids. The volume
+fraction is transported with VOF/MULES, which conserves mass. At every outer
+corrector, a signed-distance level set is rebuilt from that volume fraction.
+The level set then supplies the interface curvature and the smooth density
+and viscosity that the momentum equation uses.
+
+
+
+## How it works
+
+All of the level-set work lives in one class, `levelSetCoupledMixture`
+(`src/levelSetCoupledMixture`). It extends OpenFOAM's
+`immiscibleIncompressibleTwoPhaseMixture`, so the rest of the solver
+(MULES, turbulence, `fvOptions`, dynamic meshes) is unchanged. With `h` the
+reference cell size, every rebuild does the following:
+
+| Step | Operation |
+|---|---|
+| Seed | `d0 = (2 alpha1 - 1) * seedCoeff * h` |
+| Redistance | `d <- d + dTau * sgn(d0) * (1 - \|grad d\|)`, `dTau = pseudoTimeCoeff * h`, `nRedistanceIter` times |
+| Heaviside | `H = (1 + x + sin(pi x)/pi) / 2`, `x = clamp(d/eps, -1, 1)`, `eps = widthCoeff * h` |
+| Curvature | `kappa = -div(n_f)`, `n_f = (grad d)_f / \|(grad d)_f\|` |
+| Surface tension | `f_f = sigma * kappa_f * snGrad(H)` |
+| Properties | `rho = H rho1 + (1-H) rho2`, `mu = H mu1 + (1-H) mu2` |
+
+The density and the mass flux `rhoPhi` both come from `H`. The momentum
+equation also removes the remaining mass imbalance,
+`ddt(rho) + div(rhoPhi)`. Together, these keep `ddt(rho U)` and
+`div(rhoPhi U)` consistent with each other. The coupling follows the
+simple coupled level-set/VOF approach of Albadawi et al. (2013).
+
+## Settings
+
+Every entry is optional. They all go in a `levelSet` sub-dictionary of
+`constant/transportProperties`. The surface tension coefficient is the usual
+`sigma` entry.
+
+```
+levelSet
+{
+ cellSize 0.00625; // h [m]; default: smallest cell spacing
+ widthCoeff 1.5; // interface half-width eps / h
+ seedCoeff 0.75; // |seed distance| / h
+ pseudoTimeCoeff 0.1; // redistance pseudo-time step / h
+ nRedistanceIter 15; // default: ceil(widthCoeff/pseudoTimeCoeff)
+ curvatureFrom levelSet; // levelSet | volumeFraction
+ propertiesFrom levelSet; // levelSet | volumeFraction
+}
+```
+
+On graded meshes, set `cellSize` explicitly to the cell size near the
+interface. The solver writes three extra fields: `levelSet` (signed distance),
+`heaviside` and `levelSetCurvature`.
+
+## Build
+
+```bash
+git clone https://github.com/cloner0110/LevelSet-VOF.git
+cd LevelSet-VOF/src && wmake
+```
+
+Tested with OpenFOAM.com v2306, v2312 (CI), v2512 (CI) and v2606.
+
+## Tutorial: 2-D rising bubble
+
+`Tutorial/bubbleColumn` is test case 2 of Hysing et al. (2009):
+ρ1/ρ2 = 1000, μ1/μ2 = 100, σ = 1.96, g = 0.98. The case writes the bubble's
+centre of mass and its mean rise velocity at every time step, to
+`postProcessing/bubble/0/volFieldValue.dat`.
+
+```bash
+cd Tutorial/bubbleColumn && ./Allrun
+```
+
+Benchmark results below were run with OpenFOAM v2606 and `cAlpha 1`. The
+1/h = 160 run is the tutorial as shipped, on 4 MPI ranks. The 1/h = 80 runs use
+`(80 160 1)` cells and `deltaT 7.8125e-4`. The reference is TP2D from Hysing
+et al. (2009), Table XIII.
+
+| Run | Vmax,1 (t) | Vmax,2 (t) | yc(t = 3) |
+|---|---|---|---|
+| TP2D, 1/h = 80 | 0.2638 (0.725) | 0.2597 (1.969) | 1.1370 |
+| TP2D, 1/h = 160 | 0.2570 (0.743) | 0.2522 (2.023) | 1.1377 |
+| TP2D, 1/h = 640 | 0.2524 (0.733) | 0.2434 (2.071) | 1.1380 |
+| this solver, 1/h = 80, level-set coupling (default) | 0.2450 (0.753) | 0.2274 (1.904) | 1.1085 |
+| this solver, 1/h = 80, `curvatureFrom`/`propertiesFrom volumeFraction` | 0.2445 (0.750) | 0.2267 (1.910) | 1.1046 |
+| this solver, 1/h = 160, level-set coupling (default) | 0.2415 (0.756) | 0.2299 (1.985) | 1.1099 |
+
+The phase volume is conserved to all printed digits. The first rise-velocity
+peak is about 6% below TP2D, and refining from 1/h = 80 to 160 does not close
+that gap.
+
+## References
+
+- Albadawi, A., Donoghue, D.B., Robinson, A.J., Murray, D.B., Delauré, Y.M.C.
+ (2013). Influence of surface tension implementation in Volume of Fluid and
+ coupled Volume of Fluid with Level Set methods for bubble growth and
+ detachment. *Int. J. Multiphase Flow* 53:11–28.
+- Hysing, S., Turek, S., Kuzmin, D., Parolini, N., Burman, E., Ganesan, S.,
+ Tobiska, L. (2009). Quantitative benchmark computations of two-dimensional
+ bubble dynamics. *Int. J. Numer. Meth. Fluids* 60:1259–1288.
## License
-This project is licensed under the [MIT License](LICENSE). You are free to use, modify, and distribute the code with proper attribution.
-
-
-
-
-
-
-
-
+This solver is derived from OpenFOAM's `interFoam` and links against
+OpenFOAM libraries. It is therefore distributed under the
+[GNU General Public License v3](LICENSE), like OpenFOAM itself. Files that
+derive from OpenFOAM keep the original OpenFOAM Foundation and OpenCFD
+copyright lines.
+OpenFOAM® is a registered trade mark of OpenCFD Ltd. This project is not
+approved or endorsed by OpenCFD Ltd.
+## Contact
+- **Email**: [amirhossein.taran@ucdconnect.ie](mailto:amirhossein.taran@ucdconnect.ie)
+- **Issues**: [GitHub Issues](https://github.com/cloner0110/LevelSet-VOF/issues)
diff --git a/Tutorial/bubbleColumn/0.orig/U b/Tutorial/bubbleColumn/0.orig/U
index e0f5909..2ce48bd 100755
--- a/Tutorial/bubbleColumn/0.orig/U
+++ b/Tutorial/bubbleColumn/0.orig/U
@@ -1,8 +1,8 @@
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: 2.3.0 |
-| \\ / A nd | Web: www.OpenFOAM.org |
+| \\ / O peration | Version: v2312 |
+| \\ / A nd | Website: www.openfoam.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
FoamFile
diff --git a/Tutorial/bubbleColumn/0.orig/alpha.water b/Tutorial/bubbleColumn/0.orig/alpha.water
index bd42574..39985d5 100755
--- a/Tutorial/bubbleColumn/0.orig/alpha.water
+++ b/Tutorial/bubbleColumn/0.orig/alpha.water
@@ -1,8 +1,8 @@
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: 2.3.0 |
-| \\ / A nd | Web: www.OpenFOAM.org |
+| \\ / O peration | Version: v2312 |
+| \\ / A nd | Website: www.openfoam.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
FoamFile
diff --git a/Tutorial/bubbleColumn/0.orig/alpha.water.org b/Tutorial/bubbleColumn/0.orig/alpha.water.org
deleted file mode 100755
index bd42574..0000000
--- a/Tutorial/bubbleColumn/0.orig/alpha.water.org
+++ /dev/null
@@ -1,44 +0,0 @@
-/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: 2.3.0 |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
-\*---------------------------------------------------------------------------*/
-FoamFile
-{
- version 2.0;
- format ascii;
- class volScalarField;
- object alpha.water;
-}
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-dimensions [0 0 0 0 0 0 0];
-
-internalField uniform 0;
-
-boundaryField
-{
- bottom
- {
- type zeroGradient;
- }
-
- outlet
- {
- type zeroGradient;
- }
-
- walls
- {
- type zeroGradient;
- }
-
- defaultFaces
- {
- type empty;
- }
-}
-
-// ************************************************************************* //
diff --git a/Tutorial/bubbleColumn/0.orig/p_rgh b/Tutorial/bubbleColumn/0.orig/p_rgh
index 273e861..94327b2 100755
--- a/Tutorial/bubbleColumn/0.orig/p_rgh
+++ b/Tutorial/bubbleColumn/0.orig/p_rgh
@@ -1,8 +1,8 @@
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: 2.3.0 |
-| \\ / A nd | Web: www.OpenFOAM.org |
+| \\ / O peration | Version: v2312 |
+| \\ / A nd | Website: www.openfoam.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
FoamFile
diff --git a/Tutorial/bubbleColumn/0.orig/psi b/Tutorial/bubbleColumn/0.orig/psi
deleted file mode 100644
index 605a426..0000000
--- a/Tutorial/bubbleColumn/0.orig/psi
+++ /dev/null
@@ -1,44 +0,0 @@
-/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: 2.3.0 |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
-\*---------------------------------------------------------------------------*/
-FoamFile
-{
- version 2.0;
- format ascii;
- class volScalarField;
- object psi;
-}
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-dimensions [0 0 0 0 0 0 0];
-
-internalField uniform 0;
-
-boundaryField
-{
- walls
- {
- type zeroGradient;
- }
-
- bottom
- {
- type zeroGradient;
- }
-
- outlet
- {
- type zeroGradient;
- }
-
- defaultFaces
- {
- type empty;
- }
-}
-
-// ************************************************************************* //
diff --git a/Tutorial/bubbleColumn/Allrun b/Tutorial/bubbleColumn/Allrun
index 0884e0f..bffc988 100755
--- a/Tutorial/bubbleColumn/Allrun
+++ b/Tutorial/bubbleColumn/Allrun
@@ -1,14 +1,13 @@
-#!/bin/bash
-# Created by Amirhossein Taran
-# Dec 26 2024
-
-cd ${0%/*} || exit 1 # run from this directory
-
-# Source tutorial run functions
-. $WM_PROJECT_DIR/bin/tools/RunFunctions
+#!/bin/sh
+cd "${0%/*}" || exit # Run from this directory
+. ${WM_PROJECT_DIR:?}/bin/tools/RunFunctions # Tutorial run functions
+#------------------------------------------------------------------------------
+# 2-D rising bubble, test case 2 of Hysing et al. (2009)
restore0Dir
runApplication blockMesh
runApplication setFields
-runApplication interTrackFoam
+runApplication $(getApplication)
+
+#------------------------------------------------------------------------------
diff --git a/Tutorial/bubbleColumn/constant/g b/Tutorial/bubbleColumn/constant/g
index 6e6ce00..02ddffb 100755
--- a/Tutorial/bubbleColumn/constant/g
+++ b/Tutorial/bubbleColumn/constant/g
@@ -1,8 +1,8 @@
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: 2.3.0 |
-| \\ / A nd | Web: www.OpenFOAM.org |
+| \\ / O peration | Version: v2312 |
+| \\ / A nd | Website: www.openfoam.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
FoamFile
diff --git a/Tutorial/bubbleColumn/constant/levelSetProperties b/Tutorial/bubbleColumn/constant/levelSetProperties
deleted file mode 100755
index 45df38c..0000000
--- a/Tutorial/bubbleColumn/constant/levelSetProperties
+++ /dev/null
@@ -1,37 +0,0 @@
-/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: 2.3.0 |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
-\*---------------------------------------------------------------------------*/
-FoamFile
-{
- version 2.0;
- format ascii;
- class dictionary;
- location "constant";
- object transportProperties;
-}
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-phases (water air);
-
-water
-{
- transportModel Newtonian;
- nu nu [ 0 2 -1 0 0 0 0 ] 0.01;
-}
-
-air
-{
- transportModel Newtonian;
- nu nu [ 0 2 -1 0 0 0 0 ] 0.1;
-}
-
-sigma sigma [ 1 0 -2 0 0 0 0 ] 1.96;
-
-deltaX deltaX [ 0 0 0 0 0 0 0 ] 0.00625; //0.006667;
-epsilon epsilon [ 0 0 0 0 0 0 0 ] 0.009375; //1.5*deltaX;
-
-// ************************************************************************* //
diff --git a/Tutorial/bubbleColumn/constant/transportProperties b/Tutorial/bubbleColumn/constant/transportProperties
index 5114566..c8dc52a 100755
--- a/Tutorial/bubbleColumn/constant/transportProperties
+++ b/Tutorial/bubbleColumn/constant/transportProperties
@@ -1,8 +1,8 @@
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: 2.3.0 |
-| \\ / A nd | Web: www.OpenFOAM.org |
+| \\ / O peration | Version: v2312 |
+| \\ / A nd | Website: www.openfoam.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
FoamFile
@@ -15,25 +15,35 @@ FoamFile
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-phases (water air);
+phases (water air);
water
{
transportModel Newtonian;
- nu nu [ 0 2 -1 0 0 0 0 ] 0.01;
- rho rho [ 1 -3 0 0 0 0 0 ] 1000;
+ nu 1e-2;
+ rho 1000;
}
air
{
transportModel Newtonian;
- nu nu [ 0 2 -1 0 0 0 0 ] 0.1;
- rho rho [ 1 -3 0 0 0 0 0 ] 1;
+ nu 1e-1;
+ rho 1;
}
-sigma sigma [ 1 0 -2 0 0 0 0 ] 1.96;
+sigma 1.96;
+
+// Level-set coupling. Every entry is optional; the values below are the
+// defaults, except cellSize, which defaults to the smallest cell spacing.
+levelSet
+{
+ cellSize 0.00625; // reference cell size h [m]
+ widthCoeff 1.5; // interface half-width / h
+ seedCoeff 0.75; // |initial distance| / h
+ pseudoTimeCoeff 0.1; // redistance pseudo-time step / h
+ curvatureFrom levelSet; // levelSet | volumeFraction
+ propertiesFrom levelSet; // levelSet | volumeFraction
+}
-deltaX deltaX [ 0 0 0 0 0 0 0 ] 0.00625; //0.006667;
-epsilon epsilon [ 0 0 0 0 0 0 0 ] 0.009375; //1.5*deltaX;
// ************************************************************************* //
diff --git a/Tutorial/bubbleColumn/constant/turbulenceProperties b/Tutorial/bubbleColumn/constant/turbulenceProperties
index b2fc0a4..f85e505 100755
--- a/Tutorial/bubbleColumn/constant/turbulenceProperties
+++ b/Tutorial/bubbleColumn/constant/turbulenceProperties
@@ -1,8 +1,8 @@
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: 2.3.0 |
-| \\ / A nd | Web: www.OpenFOAM.org |
+| \\ / O peration | Version: v2312 |
+| \\ / A nd | Website: www.openfoam.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
FoamFile
diff --git a/Tutorial/bubbleColumn/system/blockMeshDict b/Tutorial/bubbleColumn/system/blockMeshDict
index 82b18bd..c0aeb56 100755
--- a/Tutorial/bubbleColumn/system/blockMeshDict
+++ b/Tutorial/bubbleColumn/system/blockMeshDict
@@ -1,8 +1,8 @@
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: 2.3.0 |
-| \\ / A nd | Web: www.OpenFOAM.org |
+| \\ / O peration | Version: v2312 |
+| \\ / A nd | Website: www.openfoam.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
FoamFile
diff --git a/Tutorial/bubbleColumn/system/controlDict b/Tutorial/bubbleColumn/system/controlDict
index 36e0cc9..a9c1740 100755
--- a/Tutorial/bubbleColumn/system/controlDict
+++ b/Tutorial/bubbleColumn/system/controlDict
@@ -1,8 +1,8 @@
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: 2.3.0 |
-| \\ / A nd | Web: www.OpenFOAM.org |
+| \\ / O peration | Version: v2312 |
+| \\ / A nd | Website: www.openfoam.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
FoamFile
@@ -15,7 +15,7 @@ FoamFile
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-application sclsVOFFoam;
+application interTrackFoam;
startFrom startTime;
@@ -52,5 +52,37 @@ maxAlphaCo 1;
maxDeltaT 1e-3;
+// Benchmark quantities of Hysing et al. (2009), test case 2: centre of mass
+// and mean rise velocity of the bubble (phase "air"), written every step to
+// postProcessing/bubble/0/volFieldValue.dat
+functions
+{
+ bubbleY
+ {
+ type exprField;
+ libs (fieldFunctionObjects);
+ field bubbleY;
+ useNamePrefix false;
+ expression "pos().y()";
+ dimensions [0 1 0 0 0 0 0];
+ executeControl timeStep;
+ writeControl none;
+ }
+
+ bubble
+ {
+ type volFieldValue;
+ libs (fieldFunctionObjects);
+ fields (bubbleY U);
+ operation weightedVolAverage;
+ weightField alpha.air;
+ regionType all;
+ writeFields false;
+ log false;
+ executeControl timeStep;
+ writeControl timeStep;
+ }
+}
+
// ************************************************************************* //
diff --git a/Tutorial/bubbleColumn/system/decomposeParDict b/Tutorial/bubbleColumn/system/decomposeParDict
index 21583ef..c60fd0e 100755
--- a/Tutorial/bubbleColumn/system/decomposeParDict
+++ b/Tutorial/bubbleColumn/system/decomposeParDict
@@ -1,8 +1,8 @@
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: 2.3.0 |
-| \\ / A nd | Web: www.OpenFOAM.org |
+| \\ / O peration | Version: v2312 |
+| \\ / A nd | Website: www.openfoam.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
FoamFile
diff --git a/Tutorial/bubbleColumn/system/fvSchemes b/Tutorial/bubbleColumn/system/fvSchemes
index 3ba57e4..649af2c 100755
--- a/Tutorial/bubbleColumn/system/fvSchemes
+++ b/Tutorial/bubbleColumn/system/fvSchemes
@@ -1,8 +1,8 @@
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: 2.3.0 |
-| \\ / A nd | Web: www.OpenFOAM.org |
+| \\ / O peration | Version: v2312 |
+| \\ / A nd | Website: www.openfoam.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
FoamFile
diff --git a/Tutorial/bubbleColumn/system/fvSolution b/Tutorial/bubbleColumn/system/fvSolution
index 9de0581..b45c3f2 100755
--- a/Tutorial/bubbleColumn/system/fvSolution
+++ b/Tutorial/bubbleColumn/system/fvSolution
@@ -1,8 +1,8 @@
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: 2.3.0 |
-| \\ / A nd | Web: www.OpenFOAM.org |
+| \\ / O peration | Version: v2312 |
+| \\ / A nd | Website: www.openfoam.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
FoamFile
@@ -22,7 +22,7 @@ solvers
nAlphaCorr 2;
nAlphaSubCycles 1;
alphaOuterCorrectors yes;
- cAlpha 0;
+ cAlpha 1;
MULESCorr yes;
nLimiterIter 3;
diff --git a/Tutorial/bubbleColumn/system/setFieldsDict b/Tutorial/bubbleColumn/system/setFieldsDict
index 7a55b12..0503c26 100755
--- a/Tutorial/bubbleColumn/system/setFieldsDict
+++ b/Tutorial/bubbleColumn/system/setFieldsDict
@@ -1,8 +1,8 @@
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: 2.3.0 |
-| \\ / A nd | Web: www.OpenFOAM.org |
+| \\ / O peration | Version: v2312 |
+| \\ / A nd | Website: www.openfoam.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
FoamFile
diff --git a/src/Make/files b/src/Make/files
index 1ae090d..2269a56 100644
--- a/src/Make/files
+++ b/src/Make/files
@@ -1,3 +1,4 @@
+levelSetCoupledMixture/levelSetCoupledMixture.C
interTrackFoam.C
EXE = $(FOAM_USER_APPBIN)/interTrackFoam
diff --git a/src/Make/options b/src/Make/options
index 7a0dfa9..2d54a09 100644
--- a/src/Make/options
+++ b/src/Make/options
@@ -1,4 +1,5 @@
EXE_INC = \
+ -IlevelSetCoupledMixture \
-I$(FOAM_APP)/solvers/multiphase/VoF \
-I$(LIB_SRC)/phaseSystemModels/twoPhaseInter/incompressibleInterPhaseTransportModel/lnInclude \
-I$(LIB_SRC)/phaseSystemModels/twoPhaseInter/VoFphaseIncompressibleTurbulenceModels/lnInclude \
diff --git a/src/UEqn.H b/src/UEqn.H
index 77d1dcd..2a93caf 100644
--- a/src/UEqn.H
+++ b/src/UEqn.H
@@ -1,8 +1,14 @@
MRF.correctBoundaryVelocity(U);
+ // Mass imbalance of the rho and rhoPhi used below. Taking it out keeps
+ // the momentum equation consistent when rho comes from the level set
+ // and is not transported by rhoPhi exactly; it is negligible for VOF.
+ const volScalarField massImbalance(fvc::ddt(rho) + fvc::div(rhoPhi));
+
fvVectorMatrix UEqn
(
fvm::ddt(rho, U) + fvm::div(rhoPhi, U)
+ + fvm::SuSp(-massImbalance, U)
+ MRF.DDt(rho, U)
+ turbulence->divDevRhoReff(rho, U)
==
@@ -22,7 +28,7 @@
fvc::reconstruct
(
(
- mixture.surfaceTensionForce()
+ mixture.capillaryForce()
- ghf*fvc::snGrad(rho)
- fvc::snGrad(p_rgh)
) * mesh.magSf()
diff --git a/src/blendDensity.H b/src/blendDensity.H
new file mode 100644
index 0000000..303b2df
--- /dev/null
+++ b/src/blendDensity.H
@@ -0,0 +1,8 @@
+// Replace the VOF density and mass flux set by the alpha equation with the
+// Heaviside blend, so that ddt(rho, U) and div(rhoPhi, U) see the same
+// density field
+if (mixture.propertiesFromLevelSet())
+{
+ rho == mixture.blendedDensity();
+ rhoPhi = mixture.blendedMassFlux(phi);
+}
diff --git a/src/calcNewCurvature.H b/src/calcNewCurvature.H
deleted file mode 100644
index 57e8c5d..0000000
--- a/src/calcNewCurvature.H
+++ /dev/null
@@ -1,8 +0,0 @@
-// calculate normal vector
-volVectorField gradPsi(fvc::grad(psi));
-surfaceVectorField gradPsif(fvc::interpolate(gradPsi));
-surfaceVectorField nVecfv(gradPsif/(mag(gradPsif)+scalar(1.0e-6)/dimChange));
-surfaceScalarField nVecf(nVecfv & mesh.Sf());
-
-// calculate new curvature based on psi (LS function)
-C == -fvc::div(nVecf);
diff --git a/src/correctPhi.H b/src/correctMeshPhi.H
similarity index 100%
rename from src/correctPhi.H
rename to src/correctMeshPhi.H
diff --git a/src/createFields.H b/src/createFields.H
index 3378d36..4ce16e0 100644
--- a/src/createFields.H
+++ b/src/createFields.H
@@ -1,79 +1,3 @@
-Info<< "Reading field psi0\n" << endl;
-
-Info<< "Reading field psi\n" << endl;
-volScalarField psi
-(
- IOobject
- (
- "psi",
- runTime.timeName(),
- mesh,
- IOobject::MUST_READ,
- IOobject::AUTO_WRITE
- ),
- mesh
-);
-
-volScalarField psi0
-(
- IOobject
- (
- "psi0",
- runTime.timeName(),
- mesh,
- IOobject::NO_READ,
- IOobject::AUTO_WRITE
- ),
- psi
-);
-
-Info<< "Reading field delta\n" << endl;
-volScalarField delta
-(
- IOobject
- (
- "delta",
- runTime.timeName(),
- mesh,
- IOobject::NO_READ,
- IOobject::AUTO_WRITE
- ),
- mesh,
- dimensionedScalar("delta",dimless, 0.0)
-);
-
-Info<< "Reading field H\n" << endl;
-
-volScalarField H
-(
- IOobject
- (
- "H",
- runTime.timeName(),
- mesh,
- IOobject::NO_READ,
- IOobject::AUTO_WRITE
- ),
- mesh,
- dimensionedScalar("H", dimless, 0.0)
-);
-
-H.oldTime();
-
-volScalarField C
-(
- IOobject
- (
- "C",
- runTime.timeName(),
- mesh,
- IOobject::NO_READ,
- IOobject::AUTO_WRITE
- ),
- mesh,
- dimensionedScalar("C",dimless/dimLength, 0.0)
-);
-
#include "createRDeltaT.H"
Info<< "Reading field p_rgh\n" << endl;
@@ -108,7 +32,7 @@ volVectorField U
Info<< "Reading transportProperties\n" << endl;
-immiscibleIncompressibleTwoPhaseMixture mixture(U, phi);
+levelSetCoupledMixture mixture(U, phi);
volScalarField& alpha1(mixture.alpha1());
volScalarField& alpha2(mixture.alpha2());
@@ -116,62 +40,8 @@ volScalarField& alpha2(mixture.alpha2());
const dimensionedScalar& rho1 = mixture.rho1();
const dimensionedScalar& rho2 = mixture.rho2();
-IOdictionary levelSetProperties
-(
- IOobject
- (
- "levelSetProperties",
- runTime.constant(),
- mesh,
- IOobject::MUST_READ_IF_MODIFIED,
- IOobject::NO_WRITE
- )
-);
-
-
-dimensionedScalar deltaX
-(
- levelSetProperties.get("deltaX")
-);
-
-dimensionedScalar gamma
-(
- dimensionedScalar(deltaX*0.75)
-);
-dimensionedScalar epsilon
-(
- // dimensionedScalar(deltaX*1.5)
- levelSetProperties.get("epsilon")
-);
-
-dimensionedScalar deltaTau
-(
- dimensionedScalar(deltaX*0.1)
-);
-
-dimensionedScalar dimChange
-(
- dimensionedScalar("dimChange",dimLength, 1.0)
-);
-
-dimensionedScalar sigma
-(
- levelSetProperties.get("sigma")
-);
-
-dimensionedScalar nu1
-(
- levelSetProperties.subDict("water").get("nu")
-);
-
-dimensionedScalar nu2
-(
- levelSetProperties.subDict("air").get("nu")
-);
-
-
-// Need to store rho for ddt(rho, U)
+// Mixture density, stored with its old time level for ddt(rho, U)
volScalarField rho
(
IOobject
@@ -200,6 +70,9 @@ surfaceScalarField rhoPhi
fvc::interpolate(rho)*phi
);
+#include "blendDensity.H"
+
+
typedef incompressibleInterPhaseTransportModel
<
immiscibleIncompressibleTwoPhaseMixture
diff --git a/src/initCorrectPhi.H b/src/initCorrectPhi.H
index 03eb7fd..735e424 100644
--- a/src/initCorrectPhi.H
+++ b/src/initCorrectPhi.H
@@ -16,7 +16,7 @@ if (correctPhi)
dimensionedScalar("rAU", dimTime/dimDensity, 1)
);
- #include "correctPhi.H"
+ #include "correctMeshPhi.H"
}
else
{
diff --git a/src/interTrackFoam.C b/src/interTrackFoam.C
index d2c0764..1f3433e 100644
--- a/src/interTrackFoam.C
+++ b/src/interTrackFoam.C
@@ -7,37 +7,41 @@
-------------------------------------------------------------------------------
Copyright (C) 2011-2017 OpenFOAM Foundation
Copyright (C) 2020 OpenCFD Ltd.
+ Copyright (C) 2022-2026 Amirhossein Taran
-------------------------------------------------------------------------------
License
- This file is part of OpenFOAM.
+ This file is part of the LevelSet-VOF solver, derived from the OpenFOAM
+ interFoam solver (applications/solvers/multiphase/interFoam).
- OpenFOAM is free software: you can redistribute it and/or modify it
+ 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.
- OpenFOAM 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
+ 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 OpenFOAM. If not, see .
+ along with this program. If not, see .
Application
interTrackFoam
-
-Author
- Amirhossein Taran
-
+
Group
grpMultiphaseSolvers
Description
- Solver for two incompressible, isothermal immiscible fluids using a coupled VOF
- (volume of fluid) and level-set phase-fraction based interface capturing approach,
- with optional mesh motion and mesh topology changes including adaptive
- re-meshing.
+ Two incompressible, isothermal, immiscible fluids. The volume fraction is
+ transported with MULES; a signed-distance level set is rebuilt from it at
+ every outer corrector and supplies the interface curvature and the smooth
+ density and viscosity used in the momentum equation.
+
+ Optional mesh motion and topology changes, including adaptive re-meshing.
+
+Author
+ Amirhossein Taran
\*---------------------------------------------------------------------------*/
@@ -48,7 +52,7 @@ Description
#include "localEulerDdtScheme.H"
#include "CrankNicolsonDdtScheme.H"
#include "subCycle.H"
-#include "immiscibleIncompressibleTwoPhaseMixture.H"
+#include "levelSetCoupledMixture.H"
#include "incompressibleInterPhaseTransportModel.H"
#include "turbulentTransportModel.H"
#include "pimpleControl.H"
@@ -62,8 +66,9 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Solver for two incompressible, isothermal immiscible fluids"
- " using a coupled VOF Level-set phase-fraction based interface capturing.\n"
+ "Two incompressible immiscible fluids: VOF transport of the volume"
+ " fraction, with a signed-distance level set rebuilt from it for the"
+ " curvature and the smooth fluid properties.\n"
"With optional mesh motion and mesh topology changes including"
" adaptive re-meshing."
);
@@ -88,6 +93,7 @@ int main(int argc, char *argv[])
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
Info<< "\nStarting time loop\n" << endl;
while (runTime.run())
@@ -100,15 +106,13 @@ int main(int argc, char *argv[])
}
else
{
- #include "mappingPsi.H"
- #include "solveLsFunction.H"
- #include "calcNewCurvature.H"
#include "CourantNo.H"
#include "alphaCourantNo.H"
#include "setDeltaT.H"
}
++runTime;
+
Info<< "Time = " << runTime.timeName() << nl << endl;
// --- Pressure-velocity PIMPLE corrector loop
@@ -134,11 +138,10 @@ int main(int argc, char *argv[])
if (correctPhi)
{
- // Calculate absolute flux
- // from the mapped surface velocity
+ // Absolute flux from the mapped surface velocity
phi = mesh.Sf() & Uf();
- #include "correctPhi.H"
+ #include "correctMeshPhi.H"
// Make the flux relative to the mesh motion
fvc::makeRelative(phi, U);
@@ -156,10 +159,11 @@ int main(int argc, char *argv[])
#include "alphaControls.H"
#include "alphaEqnSubCycle.H"
+ // VOF properties, then the level set rebuilt from the new alpha
mixture.correct();
- #include "mappingPsi.H"
- #include "solveLsFunction.H"
- #include "calcNewCurvature.H"
+ mixture.rebuildLevelSet();
+
+ #include "blendDensity.H"
if (pimple.frozenFlow())
{
diff --git a/src/levelSetCoupledMixture/levelSetCoupledMixture.C b/src/levelSetCoupledMixture/levelSetCoupledMixture.C
new file mode 100644
index 0000000..8829c2b
--- /dev/null
+++ b/src/levelSetCoupledMixture/levelSetCoupledMixture.C
@@ -0,0 +1,356 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | www.openfoam.com
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+ Copyright (C) 2022-2026 Amirhossein Taran
+-------------------------------------------------------------------------------
+License
+ This file is part of the LevelSet-VOF solver, built on OpenFOAM.
+
+ 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 .
+
+\*---------------------------------------------------------------------------*/
+
+#include "levelSetCoupledMixture.H"
+#include "fvcGrad.H"
+#include "fvcDiv.H"
+#include "fvcSnGrad.H"
+#include "surfaceInterpolate.H"
+#include "zeroGradientFvPatchFields.H"
+#include "mathematicalConstants.H"
+
+// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
+
+namespace Foam
+{
+ defineTypeNameAndDebug(levelSetCoupledMixture, 0);
+}
+
+
+const Foam::Enum
+Foam::levelSetCoupledMixture::couplingSourceNames
+({
+ { couplingSource::volumeFraction, "volumeFraction" },
+ { couplingSource::levelSet, "levelSet" },
+});
+
+
+// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
+
+Foam::scalar Foam::levelSetCoupledMixture::minCellSpacing() const
+{
+ // Cell-centre spacing across internal faces. Unlike cbrt(V) this is
+ // also right for 2-D and axisymmetric meshes of any thickness.
+ return gMin(mag(levelSet_.mesh().delta())().primitiveField());
+}
+
+
+void Foam::levelSetCoupledMixture::readCoupling()
+{
+ const dictionary coeffs(subOrEmptyDict("levelSet"));
+
+ cellSize_ = coeffs.getOrDefault("cellSize", minCellSpacing());
+ widthCoeff_ = coeffs.getOrDefault("widthCoeff", 1.5);
+ seedCoeff_ = coeffs.getOrDefault("seedCoeff", 0.75);
+ pseudoTimeCoeff_ = coeffs.getOrDefault("pseudoTimeCoeff", 0.1);
+
+ if (cellSize_ <= 0 || widthCoeff_ <= 0 || pseudoTimeCoeff_ <= 0)
+ {
+ FatalIOErrorInFunction(coeffs)
+ << "cellSize, widthCoeff and pseudoTimeCoeff must be positive"
+ << exit(FatalIOError);
+ }
+
+ // Enough pseudo-time to push the distance a full half-width away from
+ // the interface, so cells outside the band always see |d| > eps
+ nRedistanceIter_ = coeffs.getOrDefault