commit da9da84ecdc288521d70f8711e7acccc88106001
parent e9f1d8d85eb03fe2d1258bc900a3c76fe5a790d1
Author: Anders Damsgaard <andersd@riseup.net>
Date: Tue, 18 Apr 2017 22:08:39 -0400
Merge remote-tracking branch 'origin/master'
Diffstat:
19 files changed, 1810 insertions(+), 10 deletions(-)
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,11 @@
+# julia-specific files
*.jl.cov
*.jl.*.cov
*.jl.mem
+deps/deps.jl
+
+# editor swap files
+*.swp
+
+# simulation output files
+*.vtu
diff --git a/.travis.yml b/.travis.yml
@@ -7,13 +7,13 @@ julia:
- release
- nightly
notifications:
- email: false
-# uncomment the following lines to override the default test script
-#script:
-# - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
-# - julia -e 'Pkg.clone(pwd()); Pkg.build("SeaIce"); Pkg.test("SeaIce"; coverage=true)'
-after_success:
- # push coverage results to Coveralls
+ email:
+ recipients:
+ - andersd@riseup.net
+ on_success: never # default: change
+ on_failure: always # default: always
+
+# push coverage results to Coveralls
- julia -e 'cd(Pkg.dir("SeaIce")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
- # push coverage results to Codecov
+# push coverage results to Codecov
- julia -e 'cd(Pkg.dir("SeaIce")); Pkg.add("Coverage"); using Coverage; Codecov.submit(Codecov.process_folder())'
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ 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.
+
+ {one line to give the program's name and a brief idea of what it does.}
+ Copyright (C) {year} {name of author}
+
+ 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 <http://www.gnu.org/licenses/>.
+
+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:
+
+ {project} Copyright (C) {year} {fullname}
+ 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
+<http://www.gnu.org/licenses/>.
+
+ 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
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
diff --git a/README.md b/README.md
@@ -5,3 +5,22 @@
[](https://coveralls.io/github/anders-dc/SeaIce.jl?branch=master)
[](http://codecov.io/github/anders-dc/SeaIce.jl?branch=master)
+
+Toy model for sea-ice thermodynamics and granular mechanics.
+
+## Installation
+Clone the [SeaIce.jl](https://github.com/anders-dc/SeaIce.jl) repository and add
+the source folder to your julia path, for example by:
+
+ push!(LOAD_PATH, "/home/user/src/SeaIce.jl/src/")
+
+If this statement is added to `~/.juliarc.jl`, it will become persistent between
+julia sessions. Note that the `~` symbol for the home folder does not seem to
+work (julia v. 0.4.1) in the `.juliarc.jl` file.
+
+Import package contents with:
+ import SeaIce
+
+## Author
+[Anders Damsgaard](mailto:andersd@riseup.net)
+[www.adamsgaard.dk](https://adamsgaard.dk)
diff --git a/REQUIRE b/REQUIRE
@@ -1 +1,6 @@
julia 0.5
+<<<<<<< HEAD
+=======
+WriteVTK
+NetCDF
+>>>>>>> origin/master
diff --git a/SeaIceParaviewFilter.cpd b/SeaIceParaviewFilter.cpd
@@ -0,0 +1,200 @@
+<CustomFilterDefinitions>
+ <CustomProxyDefinition name="SeaIce" group="filters">
+ <CompoundSourceProxy id="6702" servers="1">
+ <Proxy group="filters" type="Glyph" id="6613" servers="1" compound_name="Glyph1">
+ <Property name="GlyphMode" id="6613.GlyphMode" number_of_elements="1">
+ <Element index="0" value="0"/>
+ <Domain name="enum" id="6613.GlyphMode.enum">
+ <Entry value="0" text="All Points"/>
+ <Entry value="1" text="Every Nth Point"/>
+ <Entry value="2" text="Uniform Spatial Distribution"/>
+ </Domain>
+ </Property>
+ <Property name="GlyphTransform" id="6613.GlyphTransform" number_of_elements="1">
+ <Proxy value="6535"/>
+ <Domain name="proxy_list" id="6613.GlyphTransform.proxy_list">
+ <Proxy value="6535"/>
+ </Domain>
+ </Property>
+ <Property name="Input" id="6613.Input" number_of_elements="1">
+ <Domain name="groups" id="6613.Input.groups"/>
+ <Domain name="input_array1" id="6613.Input.input_array1"/>
+ <Domain name="input_array2" id="6613.Input.input_array2"/>
+ <Domain name="input_type" id="6613.Input.input_type"/>
+ </Property>
+ <Property name="MaximumNumberOfSamplePoints" id="6613.MaximumNumberOfSamplePoints" number_of_elements="1">
+ <Element index="0" value="5000"/>
+ <Domain name="range" id="6613.MaximumNumberOfSamplePoints.range"/>
+ </Property>
+ <Property name="Orient" id="6613.Orient" number_of_elements="1">
+ <Element index="0" value="1"/>
+ <Domain name="bool" id="6613.Orient.bool"/>
+ </Property>
+ <Property name="Scalars" id="6613.Scalars" number_of_elements="5">
+ <Element index="0" value=""/>
+ <Element index="1" value=""/>
+ <Element index="2" value=""/>
+ <Element index="3" value="0"/>
+ <Element index="4" value="Diameter (areal) [m]"/>
+ <Domain name="array_list" id="6613.Scalars.array_list">
+ <String text="Contact friction (dynamic) [-]"/>
+ <String text="Contact friction (static) [-]"/>
+ <String text="Contact stiffness (normal) [N m^-1]"/>
+ <String text="Contact stiffness (tangential) [N m^-1]"/>
+ <String text="Contact viscosity (normal) [N m^-1 s]"/>
+ <String text="Contact viscosity (tangential) [N m^-1 s]"/>
+ <String text="Density [kg m^-3]"/>
+ <String text="Diameter (areal) [m]"/>
+ <String text="Diameter (contact) [m]"/>
+ <String text="Fixed in space [-]"/>
+ <String text="Free to rotate [-]"/>
+ <String text="Mass [kg]"/>
+ <String text="Moment of inertia [kg m^2]"/>
+ <String text="Surface area [m^2]"/>
+ <String text="Thickness [m]"/>
+ <String text="Volume [m^3]"/>
+ </Domain>
+ </Property>
+ <Property name="ScaleFactor" id="6613.ScaleFactor" number_of_elements="1">
+ <Element index="0" value="1"/>
+ <Domain name="bounds" id="6613.ScaleFactor.bounds"/>
+ <Domain name="scalar_range" id="6613.ScaleFactor.scalar_range"/>
+ <Domain name="vector_range" id="6613.ScaleFactor.vector_range"/>
+ </Property>
+ <Property name="ScaleMode" id="6613.ScaleMode" number_of_elements="1">
+ <Element index="0" value="0"/>
+ <Domain name="enum" id="6613.ScaleMode.enum">
+ <Entry value="0" text="scalar"/>
+ <Entry value="1" text="vector"/>
+ <Entry value="2" text="vector_components"/>
+ <Entry value="3" text="off"/>
+ </Domain>
+ </Property>
+ <Property name="Seed" id="6613.Seed" number_of_elements="1">
+ <Element index="0" value="10339"/>
+ <Domain name="range" id="6613.Seed.range"/>
+ </Property>
+ <Property name="Source" id="6613.Source" number_of_elements="1">
+ <Proxy value="6591" output_port="0"/>
+ <Domain name="groups" id="6613.Source.groups"/>
+ <Domain name="input_type" id="6613.Source.input_type"/>
+ <Domain name="proxy_list" id="6613.Source.proxy_list">
+ <Proxy value="6536"/>
+ <Proxy value="6547"/>
+ <Proxy value="6558"/>
+ <Proxy value="6569"/>
+ <Proxy value="6580"/>
+ <Proxy value="6591"/>
+ <Proxy value="6602"/>
+ </Domain>
+ </Property>
+ <Property name="Stride" id="6613.Stride" number_of_elements="1">
+ <Element index="0" value="1"/>
+ <Domain name="range" id="6613.Stride.range"/>
+ </Property>
+ <Property name="Vectors" id="6613.Vectors" number_of_elements="5">
+ <Element index="0" value="1"/>
+ <Element index="1" value=""/>
+ <Element index="2" value=""/>
+ <Element index="3" value="0"/>
+ <Element index="4" value="Angular position [rad]"/>
+ <Domain name="array_list" id="6613.Vectors.array_list">
+ <String text="Angular acceleration [rad s^-2]"/>
+ <String text="Angular position [rad]"/>
+ <String text="Angular velocity [rad s^-1]"/>
+ <String text="Linear acceleration [m s^-2]"/>
+ <String text="Linear velocity [m s^-1]"/>
+ <String text="Sum of forces [N]"/>
+ <String text="Sum of torques [N*m]"/>
+ </Domain>
+ </Property>
+ </Proxy>
+ <Proxy group="extended_sources" type="Transform2" id="6535" servers="1" compound_name="auto_6535">
+ <Property name="Position" id="6535.Position" number_of_elements="3">
+ <Element index="0" value="0"/>
+ <Element index="1" value="0"/>
+ <Element index="2" value="0"/>
+ <Domain name="range" id="6535.Position.range"/>
+ </Property>
+ <Property name="PositionInfo" id="6535.PositionInfo" number_of_elements="3">
+ <Element index="0" value="0"/>
+ <Element index="1" value="0"/>
+ <Element index="2" value="0"/>
+ </Property>
+ <Property name="Rotation" id="6535.Rotation" number_of_elements="3">
+ <Element index="0" value="0"/>
+ <Element index="1" value="0"/>
+ <Element index="2" value="0"/>
+ <Domain name="range" id="6535.Rotation.range"/>
+ </Property>
+ <Property name="RotationInfo" id="6535.RotationInfo" number_of_elements="3">
+ <Element index="0" value="0"/>
+ <Element index="1" value="0"/>
+ <Element index="2" value="0"/>
+ </Property>
+ <Property name="Scale" id="6535.Scale" number_of_elements="3">
+ <Element index="0" value="1"/>
+ <Element index="1" value="1"/>
+ <Element index="2" value="1"/>
+ <Domain name="range" id="6535.Scale.range"/>
+ </Property>
+ <Property name="ScaleInfo" id="6535.ScaleInfo" number_of_elements="3">
+ <Element index="0" value="1"/>
+ <Element index="1" value="1"/>
+ <Element index="2" value="1"/>
+ </Property>
+ </Proxy>
+ <Proxy group="sources" type="SphereSource" id="6591" servers="1" compound_name="auto_6591">
+ <Property name="Center" id="6591.Center" number_of_elements="3">
+ <Element index="0" value="0"/>
+ <Element index="1" value="0"/>
+ <Element index="2" value="0"/>
+ <Domain name="range" id="6591.Center.range"/>
+ </Property>
+ <Property name="EndPhi" id="6591.EndPhi" number_of_elements="1">
+ <Element index="0" value="180"/>
+ <Domain name="range" id="6591.EndPhi.range"/>
+ </Property>
+ <Property name="EndTheta" id="6591.EndTheta" number_of_elements="1">
+ <Element index="0" value="360"/>
+ <Domain name="range" id="6591.EndTheta.range"/>
+ </Property>
+ <Property name="PhiResolution" id="6591.PhiResolution" number_of_elements="1">
+ <Element index="0" value="8"/>
+ <Domain name="range" id="6591.PhiResolution.range"/>
+ </Property>
+ <Property name="Radius" id="6591.Radius" number_of_elements="1">
+ <Element index="0" value="0.5"/>
+ <Domain name="range" id="6591.Radius.range"/>
+ </Property>
+ <Property name="StartPhi" id="6591.StartPhi" number_of_elements="1">
+ <Element index="0" value="0"/>
+ <Domain name="range" id="6591.StartPhi.range"/>
+ </Property>
+ <Property name="StartTheta" id="6591.StartTheta" number_of_elements="1">
+ <Element index="0" value="0"/>
+ <Domain name="range" id="6591.StartTheta.range"/>
+ </Property>
+ <Property name="ThetaResolution" id="6591.ThetaResolution" number_of_elements="1">
+ <Element index="0" value="8"/>
+ <Domain name="range" id="6591.ThetaResolution.range"/>
+ </Property>
+ </Proxy>
+ <ExposedProperties>
+ <Property name="GlyphMode" proxy_name="Glyph1" exposed_name="Glyph Mode"/>
+ <Property name="GlyphTransform" proxy_name="Glyph1" exposed_name="Glyph Transform"/>
+ <Property name="Input" proxy_name="Glyph1" exposed_name="Input"/>
+ <Property name="MaximumNumberOfSamplePoints" proxy_name="Glyph1" exposed_name="Maximum Number Of Sample Points"/>
+ <Property name="Orient" proxy_name="Glyph1" exposed_name="Orient"/>
+ <Property name="Scalars" proxy_name="Glyph1" exposed_name="Scalars"/>
+ <Property name="ScaleFactor" proxy_name="Glyph1" exposed_name="Scale Factor"/>
+ <Property name="ScaleMode" proxy_name="Glyph1" exposed_name="Scale Mode"/>
+ <Property name="Vectors" proxy_name="Glyph1" exposed_name="Vectors"/>
+ </ExposedProperties>
+ <OutputPort name="Output" proxy="Glyph1" port_index="0"/>
+ <Hints>
+ <ShowInMenu/>
+ </Hints>
+ </CompoundSourceProxy>
+ </CustomProxyDefinition>
+</CustomFilterDefinitions>
diff --git a/src/SeaIce.jl b/src/SeaIce.jl
@@ -1,5 +1,36 @@
+#!/usr/bin/env julia
+
+##############################
+# Sea-ice dynamics simulator #
+##############################
+
+#=
+Add SeaIce to your julia path, e.g. by:
+ push!(LOAD_PATH, "/home/user/src/seaice/")
+
+If this statement is added to `~/.juliarc.jl`, it will become persistent between
+julia sessions. Note that the `~` symbol for the home folder does not seem to
+work (julia v. 0.4.1) in the `.juliarc.jl` file.
+
+Import package contents with:
+ import SeaIce
+
+If this file is changed, reimport it with:
+ reload("SeaIce")
+=#
+
module SeaIce
-# package code goes here
+include("datatypes.jl")
+include("icefloe.jl")
+include("simulation.jl")
+include("arrays.jl")
+include("grid.jl")
+include("packing.jl")
+include("contact_search.jl")
+include("interaction.jl")
+include("temporal.jl")
+include("temporal_integration.jl")
+include("io.jl")
-end # module
+end # module end
diff --git a/src/arrays.jl b/src/arrays.jl
@@ -0,0 +1 @@
+## Global arrays for general simulation data
diff --git a/src/contact_search.jl b/src/contact_search.jl
@@ -0,0 +1,84 @@
+## Contact mapping
+function findContacts!(simulation::Simulation,
+ method::String = "all to all")
+
+ if method == "all to all"
+ findContactsAllToAll!(simulation)
+ else
+ error("Unknown contact search method '$method'")
+ end
+end
+
+function interIceFloePositionVector(simulation::Simulation,
+ i::Integer, j::Integer)
+ return simulation.ice_floes[j].lin_pos - simulation.ice_floes[i].lin_pos
+end
+
+"""
+position_ij is the inter-grain position vector, and can be found with
+interIceFloePositionVector().
+"""
+function findOverlap(simulation::Simulation, i::Integer, j::Integer,
+ position_ij::vector)
+ return norm(position_ij) - (simulation.ice_floes[i].contact_radius +
+ simulation.ice_floes[j].contact_radius)
+end
+
+function findContactsAllToAll!(simulation::Simulation)
+
+ for i = 1:length(simulation.ice_floes)
+
+ # Check contacts with other grains
+ for j = 1:length(simulation.ice_floes)
+ if i < j
+
+ # Inter-grain position vector and grain overlap
+ position_ij = interIceFloePositionVector(simulation, i, j)
+ overlap_ij = findOverlap(simulation, i, j, position_ij)
+
+ # Check if grains overlap (overlap when negative)
+ if overlap_ij < 0.0
+ push!(simulation.contact_pairs, [i, j])
+ push!(simulation.overlaps,
+ overlap_ij*position_ij/norm(position_ij))
+ end
+ end
+ end
+ end
+end
+
+"""
+Check contacts with world boundaries (walls). Contacts are stored in
+g_wall_contacts with the format [i, w], where i is the grain number and w is the
+wall number. The walls are orthorectangular. The wall at negative x is called
+-1, and 1 at positive x. For negative y it is called -2, and 2 at positive y.
+For negative z it is called -3, and 3 at positive z.
+"""
+function findIceFloeWallContacts(simulation::Simulation)
+
+ for i = 1:length(g_radius)
+
+ # Overlap with origo
+ if (simulation.ice_floes[i].lin_pos[1] -
+ simulation.ice_floes[i].contact_radius - simulation.origo[1]
+ < 0.0)
+ push!(simulation.wall_contacts, [i, -1])
+ end
+
+ if (simulation.ice_floes[i].lin_pos[2] -
+ simulation.ice_floes[i].contact_radius - simulation.origo[2] < 0.0)
+ push!(simulation.ice_floes[i].wall_contacts, [i, -2])
+ end
+
+ # Overlap with world_size
+ if (simulation.world_size[1] - simulation.ice_floes[i].lin_pos[1] -
+ simulation.ice_floes[i].contact_radius < 0.0)
+ push!(simulation.ice_floes[i].wall_contacts, [i, 1])
+ end
+
+ if (simulation.world_size[2] - simulation.ice_floes[i].lin_pos[2] -
+ simulation.ice_floes[i].contact_radius < 0.0)
+ push!(simulation.ice_floes[i].wall_contacts, [i, 2])
+ end
+ end
+end
diff --git a/src/datatypes.jl b/src/datatypes.jl
@@ -0,0 +1,104 @@
+# Define floating point data types
+const float = Float64
+const vector = Array{Float64, 1}
+
+## Particle composite types
+
+type IceFloeCylindrical
+
+ # Material properties
+ density::float
+
+ # Geometrical parameters
+ thickness::float
+ contact_radius::float
+ areal_radius::float
+ surface_area::float
+ volume::float
+ mass::float
+ moment_of_inertia::float
+
+ # Linear kinematic degrees of freedom along horizontal plane
+ lin_pos::vector
+ lin_vel::vector
+ lin_acc::vector
+ force::vector
+
+ # Angular kinematic degrees of freedom for vertical rotation around center
+ ang_pos::float
+ ang_vel::float
+ ang_acc::float
+ torque::float
+
+ # Kinematic constraint flags
+ fixed::Bool
+ rotating::Bool
+
+ # Rheological parameters
+ contact_stiffness_normal::float
+ contact_stiffness_tangential::float
+ contact_viscosity_normal::float
+ contact_viscosity_tangential::float
+ contact_static_friction::float
+ contact_dynamic_friction::float
+end
+
+# Type for gathering data from ice floe objects into single arrays
+type IceFloeArrays
+
+ # Material properties
+ density
+
+ # Geometrical parameters
+ thickness
+ contact_radius
+ areal_radius
+ surface_area
+ volume
+ mass
+ moment_of_inertia
+
+ # Linear kinematic degrees of freedom along horizontal plane
+ lin_pos
+ lin_vel
+ lin_acc
+ force
+
+ # Angular kinematic degrees of freedom for vertical rotation around center
+ ang_pos
+ ang_vel
+ ang_acc
+ torque
+
+ # Kinematic constraint flags
+ fixed
+ rotating
+
+ # Rheological parameters
+ contact_stiffness_normal
+ contact_stiffness_tangential
+ contact_viscosity_normal
+ contact_viscosity_tangential
+ contact_static_friction
+ contact_dynamic_friction
+end
+
+## Top-level simulation type
+
+# Simulation-scope data
+type Simulation
+ id::String
+
+ time_iteration::Int
+ time::Float64
+ time_total::Float64
+ time_step::Float64
+ file_time_step::Float64 # 0.0: no output files
+ file_number::Int
+
+ ice_floes::Array{IceFloeCylindrical, 1}
+ contact_pairs::Array{Array{Int, 1}, 1}
+ overlaps::Array{Array{Float64, 1}, 1}
+ wall_contacts::Array{Array{Int, 1}, 1}
+end
+
diff --git a/src/grid.jl b/src/grid.jl
@@ -0,0 +1,29 @@
+function fitWorldSize(margin::vector = zeros(3))
+
+ if length(g_radius) < 1
+ error("At least a single grain must be added before setting world
+ size.")
+ end
+
+ minpos = [Inf, Inf, Inf]
+ maxpos = [-Inf, -Inf, -Inf]
+ for i = 1:length(g_radius)
+
+ min_position = g_position[i]::vector - g_radius[i]::float
+ max_position = g_position[i]::vector + g_radius[i]::float
+
+ for i = 1:3
+ if min_position[i] < g_origo[i]
+ g_origo[i] = min_position[i]
+ end
+
+ if max_position[i] > g_world_size[i]
+ g_world_size[i] = max_position[i]
+ end
+ end
+ end
+
+ g_origo[:] = minpos[:] - margin[:]
+ g_world_size[:] = maxpos[:] + margin[:]
+end
+
diff --git a/src/icefloe.jl b/src/icefloe.jl
@@ -0,0 +1,220 @@
+## Manage icefloes in the model
+
+"""
+Adds a grain to the simulation. Example:
+
+ SeaIce.addIceFloeCylindrical([1.0, 2.0, 3.0], 1.0)
+"""
+function addIceFloeCylindrical(simulation::Simulation,
+ lin_pos::vector,
+ contact_radius::float,
+ thickness::float;
+ areal_radius = false,
+ lin_vel::vector = [0., 0.],
+ lin_acc::vector = [0., 0.],
+ force::vector = [0., 0.],
+ ang_pos::float = 0.,
+ ang_vel::float = 0.,
+ ang_acc::float = 0.,
+ torque::float = 0.,
+ density::float = 934.,
+ contact_stiffness_normal::float = 1.e6,
+ contact_stiffness_tangential::float = 1.e6,
+ contact_viscosity_normal::float = 0.,
+ contact_viscosity_tangential::float = 0.,
+ contact_static_friction::float = 0.4,
+ contact_dynamic_friction::float = 0.4,
+ fixed::Bool = false,
+ rotating::Bool = true,
+ verbose::Bool = true)
+
+ # Check input values
+ if length(lin_pos) != 2
+ error("Linear position must be a two-element array (lin_pos = ",
+ "$lin_pos)")
+ end
+ if length(lin_vel) != 2
+ error("Linear velocity must be a two-element array (lin_vel = ",
+ "$lin_vel)")
+ end
+ if length(lin_acc) != 2
+ error("Linear acceleration must be a two-element array (lin_acc = ",
+ "$lin_acc)")
+ end
+ if length(ang_pos) != 1
+ error("Angular position must be a scalar (ang_pos = $ang_pos)")
+ end
+ if length(ang_vel) != 1
+ error("Angular velocity must be a scalar (ang_vel = $ang_vel)")
+ end
+ if length(ang_acc) != 1
+ error("Angular acceleration must be a scalar (ang_acc = $ang_acc)")
+ end
+ if contact_radius <= 0.0
+ error("Radius must be greater than 0.0 (radius = $contact_radius m)")
+ end
+ if density <= 0.0
+ error("Density must be greater than 0.0 (density = $density kg/m^3)")
+ end
+
+ if !areal_radius
+ areal_radius = contact_radius
+ end
+
+
+ # Create icefloe object with placeholder values for surface area, volume,
+ # mass, and moment of inertia.
+ icefloe = IceFloeCylindrical(density,
+
+ thickness,
+ contact_radius,
+ areal_radius,
+ 1.0, # surface_area
+ 1.0, # volume
+ 1.0, # mass
+ 1.0, # moment_of_inertia
+ lin_pos,
+ lin_vel,
+ lin_acc,
+ force,
+
+ ang_pos,
+ ang_vel,
+ ang_acc,
+ torque,
+
+ fixed,
+ rotating,
+
+ contact_stiffness_normal,
+ contact_stiffness_tangential,
+ contact_viscosity_normal,
+ contact_viscosity_tangential,
+ contact_static_friction,
+ contact_dynamic_friction
+ )
+
+ # Overwrite previous placeholder values
+ icefloe.surface_area = iceFloeSurfaceArea(icefloe)
+ icefloe.volume = iceFloeVolume(icefloe)
+ icefloe.mass = iceFloeMass(icefloe)
+ icefloe.moment_of_inertia = iceFloeMomentOfInertia(icefloe)
+
+ # Add to simulation object
+ addIceFloe!(simulation, icefloe, verbose)
+end
+
+function iceFloeSurfaceArea(icefloe::IceFloeCylindrical)
+ return pi*icefloe.areal_radius^2.
+end
+
+function iceFloeVolume(icefloe::IceFloeCylindrical)
+ return iceFloeSurfaceArea(icefloe)*icefloe.thickness
+end
+
+function iceFloeMass(icefloe::IceFloeCylindrical)
+ return iceFloeVolume(icefloe)*icefloe.density
+end
+
+function iceFloeMomentOfInertia(icefloe::IceFloeCylindrical)
+ return 0.5*iceFloeMass(icefloe)*icefloe.areal_radius^2.
+end
+
+function convertIceFloeDataToArrays(simulation::Simulation)
+
+ ifarr = IceFloeArrays(
+ Array(Float64, length(simulation.ice_floes)),
+
+ Array(Float64, length(simulation.ice_floes)),
+ Array(Float64, length(simulation.ice_floes)),
+ Array(Float64, length(simulation.ice_floes)),
+ Array(Float64, length(simulation.ice_floes)),
+ Array(Float64, length(simulation.ice_floes)),
+ Array(Float64, length(simulation.ice_floes)),
+ Array(Float64, length(simulation.ice_floes)),
+
+ zeros(Float64, 3, length(simulation.ice_floes)),
+ zeros(Float64, 3, length(simulation.ice_floes)),
+ zeros(Float64, 3, length(simulation.ice_floes)),
+ zeros(Float64, 3, length(simulation.ice_floes)),
+
+ zeros(Float64, 3, length(simulation.ice_floes)),
+ zeros(Float64, 3, length(simulation.ice_floes)),
+ zeros(Float64, 3, length(simulation.ice_floes)),
+ zeros(Float64, 3, length(simulation.ice_floes)),
+
+ Array(Int, length(simulation.ice_floes)),
+ Array(Int, length(simulation.ice_floes)),
+
+ Array(Float64, length(simulation.ice_floes)),
+ Array(Float64, length(simulation.ice_floes)),
+ Array(Float64, length(simulation.ice_floes)),
+ Array(Float64, length(simulation.ice_floes)),
+ Array(Float64, length(simulation.ice_floes)),
+ Array(Float64, length(simulation.ice_floes)))
+
+ # fill arrays
+ for i=1:length(simulation.ice_floes)
+ ifarr.density[i] = simulation.ice_floes[i].density
+
+ ifarr.thickness[i] = simulation.ice_floes[i].thickness
+ ifarr.contact_radius[i] = simulation.ice_floes[i].contact_radius
+ ifarr.areal_radius[i] = simulation.ice_floes[i].areal_radius
+ ifarr.surface_area[i] = simulation.ice_floes[i].surface_area
+ ifarr.volume[i] = simulation.ice_floes[i].volume
+ ifarr.mass[i] = simulation.ice_floes[i].mass
+ ifarr.moment_of_inertia[i] = simulation.ice_floes[i].moment_of_inertia
+
+ ifarr.lin_pos[1:2, i] = simulation.ice_floes[i].lin_pos
+ ifarr.lin_vel[1:2, i] = simulation.ice_floes[i].lin_vel
+ ifarr.lin_acc[1:2, i] = simulation.ice_floes[i].lin_acc
+ ifarr.force[1:2, i] = simulation.ice_floes[i].force
+
+ ifarr.ang_pos[3, i] = simulation.ice_floes[i].ang_pos
+ ifarr.ang_vel[3, i] = simulation.ice_floes[i].ang_vel
+ ifarr.ang_acc[3, i] = simulation.ice_floes[i].ang_acc
+ ifarr.torque[3, i] = simulation.ice_floes[i].torque
+
+ ifarr.fixed[i] = Int(simulation.ice_floes[i].fixed)
+ ifarr.rotating[i] = Int(simulation.ice_floes[i].rotating)
+
+ ifarr.contact_stiffness_normal[i] =
+ simulation.ice_floes[i].contact_stiffness_normal
+ ifarr.contact_stiffness_tangential[i] =
+ simulation.ice_floes[i].contact_stiffness_tangential
+ ifarr.contact_viscosity_normal[i] =
+ simulation.ice_floes[i].contact_viscosity_normal
+ ifarr.contact_viscosity_tangential[i] =
+ simulation.ice_floes[i].contact_viscosity_tangential
+ ifarr.contact_static_friction[i] =
+ simulation.ice_floes[i].contact_static_friction
+ ifarr.contact_dynamic_friction[i] =
+ simulation.ice_floes[i].contact_dynamic_friction
+ end
+
+ return ifarr
+end
+
+function iceFloeKineticTranslationalEnergy(icefloe::IceFloeCylindrical)
+ return 0.5*icefloe.mass*norm(icefloe.lin_vel)^2.
+end
+
+function totalIceFloeKineticTranslationalEnergy(simulation::Simulation)
+ E_sum = 0
+ for icefloe in simulation.ice_floes
+ E_sum += iceFloeKineticTranslationalEnergy(icefloe)
+ end
+ return E_sum
+end
+
+function iceFloeKineticRotationalEnergy(icefloe::IceFloeCylindrical)
+ return 0.5*icefloe.moment_of_inertia*norm(icefloe.ang_vel)^2.
+end
+
+function totalIceFloeKineticRotationalEnergy(simulation::Simulation)
+ E_sum = 0
+ for icefloe in simulation.ice_floes
+ E_sum += iceFloeKineticRotationalEnergy(icefloe)
+ end
+ return E_sum
+end
diff --git a/src/interaction.jl b/src/interaction.jl
@@ -0,0 +1,59 @@
+## Interaction functions
+
+"""
+Resolve mechanical interaction between all grain pairs and walls.
+"""
+function interact!(simulation::Simulation)
+ contact_pair = Array{Integer, 1}
+ #overlap_ij = float
+
+ # IceFloe to grain collisions
+ while !isempty(simulation.contact_pairs)
+ contact_pair = pop!(simulation.contact_pairs)
+ overlap_vector = pop!(simulation.overlaps)
+ interactIceFloes!(simulation, contact_pair[1], contact_pair[2],
+ overlap_vector)
+ end
+
+ # IceFloe to wall collisions
+ while !isempty(simulation.wall_contacts)
+ contact_pair = pop!(simulation.wall_contacts)
+ interactIceFloeWall!(simulation, contact_pair[1], contact_pair[2])
+ end
+end
+
+"""
+Resolve an grain-to-grain interaction using a prescibed contact law.
+"""
+function interactIceFloes!(simulation::Simulation,
+ i::Integer, j::Integer,
+ overlap_vector::Array{Float64, 1};
+ contact_normal::String = "LinearElastic")
+
+ force = zeros(2)
+
+ if contact_normal == "None"
+ # do nothing
+
+ elseif contact_normal == "LinearElastic"
+ force = interactNormalLinearElastic(simulation, i, j, overlap_vector)
+
+ else
+ error("Unknown contact_normal interaction model '$contact_normal'")
+ end
+
+ simulation.ice_floes[i].force += force;
+ simulation.ice_floes[j].force -= force;
+
+end
+
+function interactNormalLinearElastic(simulation::Simulation,
+ i::Integer, j::Integer,
+ overlap_vector::vector)
+
+ k_n_i = simulation.ice_floes[i].contact_stiffness_normal
+ k_n_j = simulation.ice_floes[j].contact_stiffness_normal
+ k_n_harmonic_mean = 2.*k_n_i*k_n_j/(k_n_i + k_n_j)
+
+ return k_n_harmonic_mean * overlap_vector
+end
diff --git a/src/io.jl b/src/io.jl
@@ -0,0 +1,64 @@
+import WriteVTK # Install with Pkg.add("WriteVTK")
+
+## IO functions
+
+function writeVTK(simulation::Simulation;
+ folder::String=".",
+ verbose::Bool=false)
+
+ simulation.file_number += 1
+ filename = string(folder, "/", simulation.id, ".", simulation.file_number)
+
+ ifarr = convertIceFloeDataToArrays(simulation)
+
+ # write to disk
+ vtkfile = WriteVTK.vtk_grid(filename, ifarr.lin_pos, WriteVTK.MeshCell[])
+
+ WriteVTK.vtk_point_data(vtkfile, ifarr.density, "Density [kg m^-3]")
+
+ WriteVTK.vtk_point_data(vtkfile, ifarr.thickness, "Thickness [m]")
+ WriteVTK.vtk_point_data(vtkfile, ifarr.contact_radius*2.,
+ "Diameter (contact) [m]")
+ WriteVTK.vtk_point_data(vtkfile, ifarr.areal_radius*2.,
+ "Diameter (areal) [m]")
+ WriteVTK.vtk_point_data(vtkfile, ifarr.surface_area, "Surface area [m^2]")
+ WriteVTK.vtk_point_data(vtkfile, ifarr.volume, "Volume [m^3]")
+ WriteVTK.vtk_point_data(vtkfile, ifarr.mass, "Mass [kg]")
+ WriteVTK.vtk_point_data(vtkfile, ifarr.moment_of_inertia,
+ "Moment of inertia [kg m^2]")
+
+ WriteVTK.vtk_point_data(vtkfile, ifarr.lin_vel, "Linear velocity [m s^-1]")
+ WriteVTK.vtk_point_data(vtkfile, ifarr.lin_acc,
+ "Linear acceleration [m s^-2]")
+ WriteVTK.vtk_point_data(vtkfile, ifarr.force, "Sum of forces [N]")
+
+ WriteVTK.vtk_point_data(vtkfile, ifarr.ang_pos, "Angular position [rad]")
+ WriteVTK.vtk_point_data(vtkfile, ifarr.ang_vel,
+ "Angular velocity [rad s^-1]")
+ WriteVTK.vtk_point_data(vtkfile, ifarr.ang_acc,
+ "Angular acceleration [rad s^-2]")
+ WriteVTK.vtk_point_data(vtkfile, ifarr.torque, "Sum of torques [N*m]")
+
+ WriteVTK.vtk_point_data(vtkfile, ifarr.fixed, "Fixed in space [-]")
+ WriteVTK.vtk_point_data(vtkfile, ifarr.rotating, "Free to rotate [-]")
+
+ WriteVTK.vtk_point_data(vtkfile, ifarr.contact_stiffness_normal,
+ "Contact stiffness (normal) [N m^-1]")
+ WriteVTK.vtk_point_data(vtkfile, ifarr.contact_stiffness_tangential,
+ "Contact stiffness (tangential) [N m^-1]")
+ WriteVTK.vtk_point_data(vtkfile, ifarr.contact_viscosity_normal,
+ "Contact viscosity (normal) [N m^-1 s]")
+ WriteVTK.vtk_point_data(vtkfile, ifarr.contact_viscosity_tangential,
+ "Contact viscosity (tangential) [N m^-1 s]")
+ WriteVTK.vtk_point_data(vtkfile, ifarr.contact_static_friction,
+ "Contact friction (static) [-]")
+ WriteVTK.vtk_point_data(vtkfile, ifarr.contact_dynamic_friction,
+ "Contact friction (dynamic) [-]")
+
+ outfiles = WriteVTK.vtk_save(vtkfile)
+ if verbose
+ println("Output file: " * outfiles[1])
+ else
+ return nothing
+ end
+end
diff --git a/src/packing.jl b/src/packing.jl
diff --git a/src/simulation.jl b/src/simulation.jl
@@ -0,0 +1,97 @@
+## General simulation functions
+
+function createSimulation(;id::String="unnamed",
+ time_iteration::Int=0,
+ time::Float64=0.0,
+ time_total::Float64=-1.,
+ time_step::Float64=-1.,
+ file_time_step::Float64=-1.,
+ file_number::Int=0,
+ ice_floes=Array{IceFloeCylindrical, 1}[],
+ contact_pairs=Array{Int64, 1}[],
+ overlaps=Array{Array{Float64, 1}, 1}[],
+ wall_contacts=Array{Int64, 1}[])
+
+ return Simulation(id,
+ time_iteration,
+ time,
+ time_total,
+ time_step,
+ file_time_step,
+ file_number,
+ ice_floes,
+ contact_pairs,
+ overlaps,
+ wall_contacts)
+end
+
+function run!(simulation::Simulation;
+ verbose::Bool = true,
+ status_interval = 100.,
+ show_file_output = true,
+ single_step=false)
+
+ if single_step && simulation.time >= simulation.time_total
+ simulation.time_total += simulation.time_step
+ end
+
+ checkTimeParameters(simulation)
+ if simulation.file_time_step > 0.0
+ writeVTK(simulation, verbose=show_file_output)
+ end
+
+ time_since_output_file = 0.0
+
+ while simulation.time <= simulation.time_total
+
+ if simulation.file_time_step > 0.0 &&
+ time_since_output_file >= simulation.file_time_step
+
+ writeVTK(simulation, verbose=show_file_output)
+ time_since_output_file = 0.0
+ end
+
+ if verbose && simulation.time_iteration % status_interval == 0
+ print("\r t = ", simulation.time, '/', simulation.time_total,
+ " s ")
+ end
+
+ findContacts!(simulation)
+ interact!(simulation)
+ updateIceFloeKinematics!(simulation)
+
+ # Update time variables
+ simulation.time_iteration += 1
+ simulation.time += simulation.time_step
+ time_since_output_file = time_since_output_file + simulation.time_step
+
+ if single_step
+ if verbose
+ println("Current time: ", simulation.time)
+ end
+ return
+ end
+ end
+ if verbose
+ println()
+ end
+end
+
+function addIceFloe!(simulation::Simulation,
+ icefloe::IceFloeCylindrical,
+ verbose::Bool = False)
+ # Append icefloe to global icefloe array
+ push!(simulation.ice_floes, icefloe)
+
+ if verbose
+ info("Added IceFloe $(length(simulation.ice_floes))")
+ end
+end
+
+function removeIceFloe!(simulation::Simulation, i::Integer)
+ if i < 1
+ error("Index must be greater than 0 (i = $i)")
+ end
+
+ delete!(simulation.ice_floes, i)
+end
diff --git a/src/temporal.jl b/src/temporal.jl
@@ -0,0 +1,109 @@
+## Set temporal parameters
+function setTotalTime!(simulation::Simulation, t::float)
+ if t <= 0.0
+ error("Total time should be a positive value (t = $t s)")
+ end
+ simulation.time_total = t
+end
+
+function setCurrentTime!(simulation::Simulation, t::float)
+ if t <= 0.0
+ error("Current time should be a positive value (t = $t s)")
+ end
+ simulation.time = t
+end
+
+function incrementCurrentTime!(simulation::Simulation, t::float)
+ if t <= 0.0
+ error("Current time increment should be a positive value (t = $t s)")
+ end
+ simulation.time = simulation.time + t
+end
+
+function setOutputFileInterval!(simulation::Simulation, t::float)
+ if t <= 0.0
+ info("The output file interval should be a positive value (t = $t s)")
+ end
+ simulation.file_time_step = t
+end
+
+function disableOutputFiles!(simulation::Simulation)
+ simulation.file_time_step = 0.0
+end
+
+function checkTimeParameters(simulation::Simulation)
+ if simulation.time_total <= 0.0 || simulation.time_total <= simulation.time
+ error("Total time should be positive and larger than current time.\n",
+ " t_total = ", simulation.time_total, " s, t = ", simulation.time,
+ " s")
+ end
+ if simulation.time_step <= 0.0
+ error("Time step should be positive (t = ", simulation.time_step, ")")
+ end
+end
+
+function findSmallestIceFloeMass(simulation::Simulation)
+ m_min = 1e20
+ i_min = -1
+ for i in length(simulation.ice_floes)
+ icefloe = simulation.ice_floes[i]
+ if icefloe.mass < m_min
+ m_min = icefloe.mass
+ i_min = i
+ end
+ end
+ return m_min, i_min
+end
+
+function findLargestIceFloeStiffness(simulation::Simulation)
+ k_n_max = 0.
+ k_t_max = 0.
+ i_n_max = -1
+ i_t_max = -1
+ for i in length(simulation.ice_floes)
+ icefloe = simulation.ice_floes[i]
+ if icefloe.contact_stiffness_normal > k_n_max
+ k_n_max = icefloe.contact_stiffness_normal
+ i_n_max = i
+ end
+ if icefloe.contact_stiffness_tangential > k_t_max
+ k_t_max = icefloe.contact_stiffness_tangential
+ i_t_max = i
+ end
+ end
+ return k_n_max, k_t_max, i_n_max, i_t_max
+end
+
+"""
+Find the computational time step length suitable given the grain radii, contact
+stiffnesses, and grain density. Uses the scheme by Radjaii et al. 2011.
+"""
+function setTimeStep!(simulation::Simulation;
+ epsilon::float=0.07, verbose::Bool=true)
+
+ if length(simulation.ice_floes) < 1
+ error("At least 1 grain is needed to find the computational time step.")
+ end
+
+ k_n_max, k_t_max, _, _ = findLargestIceFloeStiffness(simulation)
+ m_min, _ = findSmallestIceFloeMass(simulation)
+
+ simulation.time_step = epsilon/(sqrt(maximum([k_n_max, k_t_max])/m_min))
+
+ if simulation.time_step <= 1.0e-20
+ error("Time step too small or negative (", simulation.time_step, " s)")
+ end
+
+ if verbose
+ info("Time step length t=", simulation.time_step, " s")
+ end
+end
+
+"""
+Perform temporal integration for all grains.
+"""
+function updateKinematics!(simulation::Simulation)
+ for i = 1:length(simulation.ice_floes)
+ updateIceFloeKinematics(simulation.ice_floes[i])
+ end
+end
diff --git a/src/temporal_integration.jl b/src/temporal_integration.jl
@@ -0,0 +1,69 @@
+"""
+Update the ice floe kinematic parameters using a temporal integration scheme,
+the current force and torque balance, and gravitational acceleration.
+"""
+function updateIceFloeKinematics!(simulation::Simulation;
+ method::String = "Three-term Taylor")
+
+ if method == "Two-term Taylor"
+ for ice_floe in simulation.ice_floes
+ updateIceFloeKinematicsTwoTermTaylor(ice_floe, simulation)
+ end
+ elseif method == "Three-term Taylor"
+ for ice_floe in simulation.ice_floes
+ updateIceFloeKinematicsThreeTermTaylor(ice_floe, simulation)
+ end
+ else
+ error("Unknown integration method '$method'")
+ end
+end
+
+function updateIceFloeKinematicsTwoTermTaylor(icefloe::IceFloeCylindrical,
+ simulation::Simulation)
+ icefloe.lin_acc = icefloe.force/icefloe.mass
+ icefloe.ang_acc = icefloe.torque/icefloe.moment_of_inertia
+
+ icefloe.lin_pos +=
+ icefloe.lin_vel * simulation.time_step +
+ 0.5*icefloe.lin_acc * simulation.time_step^2.0
+ icefloe.ang_pos +=
+ icefloe.ang_vel * simulation.time_step +
+ 0.5*icefloe.ang_acc * simulation.time_step^2.0
+
+ icefloe.lin_vel += icefloe.lin_acc * simulation.time_step
+ icefloe.ang_vel += icefloe.ang_acc * simulation.time_step
+end
+
+function updateIceFloeKinematicsThreeTermTaylor(icefloe::IceFloeCylindrical,
+ simulation::Simulation)
+
+ if simulation.time_iteration == 0
+ lin_acc_0 = zeros(2)
+ ang_acc_0 = 0.
+ else
+ lin_acc_0 = icefloe.lin_acc
+ ang_acc_0 = icefloe.ang_acc
+ end
+
+ icefloe.lin_acc = icefloe.force/icefloe.mass
+ icefloe.ang_acc = icefloe.torque/icefloe.moment_of_inertia
+
+ # Temporal gradient in acceleration using backwards differences
+ d_lin_acc_dt = (icefloe.lin_acc - lin_acc_0)/simulation.time_step
+ d_ang_acc_dt = (icefloe.ang_acc - ang_acc_0)/simulation.time_step
+
+ icefloe.lin_pos +=
+ icefloe.lin_vel * simulation.time_step +
+ 0.5 * icefloe.lin_acc * simulation.time_step^2. +
+ 1./6. * d_lin_acc_dt * simulation.time_step^3.
+ icefloe.ang_pos +=
+ icefloe.ang_vel * simulation.time_step +
+ 0.5 * icefloe.ang_acc * simulation.time_step^2. +
+ 1./6. * d_ang_acc_dt * simulation.time_step^3.
+
+ icefloe.lin_vel += icefloe.lin_acc * simulation.time_step +
+ 0.5 * d_lin_acc_dt * simulation.time_step^2.
+ icefloe.ang_vel += icefloe.ang_acc * simulation.time_step +
+ 0.5 * d_ang_acc_dt * simulation.time_step^2.
+end
+
diff --git a/test/collision-2floes-normal.jl b/test/collision-2floes-normal.jl
@@ -0,0 +1,27 @@
+#!/usr/bin/env julia
+
+# Check for conservation of kinetic energy (=momentum) during a normal collision
+# between two ice cylindrical ice floes
+
+push!(LOAD_PATH, "../src/")
+
+import Base.Test
+import SeaIce
+
+sim = SeaIce.createSimulation(id="test")
+SeaIce.addIceFloeCylindrical(sim, [ 0., 0.], 10., 1.)
+SeaIce.addIceFloeCylindrical(sim, [20., 0.], 10., 1.)
+sim.ice_floes[1].lin_vel[1] = 1.
+
+E_kin_lin_init = SeaIce.totalIceFloeKineticTranslationalEnergy(sim)
+E_kin_rot_init = SeaIce.totalIceFloeKineticRotationalEnergy(sim)
+
+SeaIce.setTimeStep!(sim)
+SeaIce.setTotalTime!(sim, 1.0)
+SeaIce.run!(sim)
+
+E_kin_lin_final = SeaIce.totalIceFloeKineticTranslationalEnergy(sim)
+E_kin_rot_final = SeaIce.totalIceFloeKineticRotationalEnergy(sim)
+
+Base.Test.@test_approx_eq E_kin_lin_init E_kin_lin_final
+Base.Test.@test_approx_eq E_kin_rot_init E_kin_rot_final
