diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9bd9b01 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +*.~undo-tree~ 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/app/main.f90 b/app/main.f90 new file mode 100644 index 0000000..8c50727 --- /dev/null +++ b/app/main.f90 @@ -0,0 +1,224 @@ +program main + + use kind_parameter + use cust_fns + use data_types + use inputs + use elastance + use funcs + use ieee_arithmetic + implicit none + + ! Declares initial variables + integer :: nstep, ncycle, rk, i, icycle, k, io, nan_count, inf_count, offset + real(dp) :: T, pini_sys, pini_pulm, h, t_val + type (arterial_network) :: a_cof + type (chambers) :: h_cof + type (valve) :: AV, MV, PV, TV + type (valve_system) :: v_cof + real(dp), allocatable, dimension(:) :: ELV, ELA, ERV, ERA + type (heart_elastance) :: elast, elast_half + real(dp) :: current_sol(22) + real(dp), allocatable :: sol(:, :) + real(dp), allocatable :: h_pres(:, :) + real(dp), allocatable :: t_axis(:) + real(dp), dimension(22) :: k1, k2, k3, k4 + character(len=50), dimension(22) :: headers + real(dp) :: scale_Rsys, scale_Csys, scale_Rpulm, scale_Cpulm + real(dp) :: scale_Emax, scale_EmaxLV, scale_EmaxRV + real(dp) :: rho + type (arterial_system) :: sys + type (arterial_system) :: pulm + type (chamber) :: LV, LA, RV, RA + + ! Declares the namelists + namelist /INPUTS/ nstep, T, ncycle, pini_sys, pini_pulm, rk + namelist /VALVES/ AV, MV, PV, TV + namelist /ARTERIES/ scale_Rsys, scale_Csys, scale_Rpulm, scale_Cpulm, rho, sys, pulm + namelist /HEART/ scale_EmaxLV, scale_EmaxRV, scale_Emax, LV, LA, RV, RA + + !!! Initialisation !!! + ! Defines initial variables + io = 42 + open(action='read', file='inputs.nml', newunit=io) + read(nml=INPUTS, unit=io) + read(nml=VALVES, unit=io) + read(nml=ARTERIES, unit=io) + read(nml=HEART, unit=io) + close(io) + + headers = [ character(len=50) :: 'Aortic Valve Flow', & + 'Sinus Flow','Aortic Flow', & + 'Tricuspid Valve Flow', & + 'Pulmonary Valve Flow', & + 'Arterial Flow', & + 'Aterioles Flow', & + 'Mitral Valve Flow', & + 'Systemic Sinus Pressure', & + 'Systemic Artery Pressure', & + 'Systemic Venous Pressure', & + 'Pulmonary Sinus Pressure', & + 'Pulmonary Artery Pressure', & + 'Pulmonary Venous Pressure', & + 'Left Ventricular Volume', & + 'Left Atrial Volume', & + 'Right Ventricular Volume', & + 'Right Atrial Volume', & + 'Aortic Valve Status', & + 'Mitral Valve Status',& + 'Pulmonary Valve Status', & + 'Tricuspid Valve Status'] + + ! Relevant arterial coefficients + call artery_input(sys, pulm, scale_Rsys, scale_Csys, scale_Rpulm, scale_Cpulm) + a_cof = arterial_network(sys, pulm, rho) + + ! Relevant heart coefficients + call heart_input(LV, LA, RV, RA, T, scale_EmaxLV, scale_EmaxRV, scale_Emax) + h_cof = chambers(LV, LA, RV, RA) + + ! Relevant valve coefficients + v_cof = valve_system(AV, MV, PV, TV) + + !!! Main code !!! + ! Calculates elastance curves for the different chambers of the heart + allocate(t_axis(nstep)) + h = T / real(nstep, dp) + t_val = 0.0_dp + do i = 1, nstep + t_axis(i) = t_val + t_val = t_val + h + end do + allocate(ELV(nstep)) + allocate(ELA(nstep)) + allocate(ERV(nstep)) + allocate(ERA(nstep)) + ELV = calc_elastance(h_cof%LV, nstep, T, t_axis) + ELA = calc_elastance(h_cof%LA, nstep, T, t_axis) + ERV = calc_elastance(h_cof%RV, nstep, T, t_axis) + ERA = calc_elastance(h_cof%RA, nstep, T, t_axis) + + ! Saves the heart information at the points + elast = heart_elastance(ELV=ELV, ELA=ELA, ERV=ERV, ERA=ERA) + elast_half = heart_elastance(ELV=midpoint(ELV), & + ELA=midpoint(ELA), & + ERV=midpoint(ERV), & + ERA=midpoint(ERA)) + + ! Initialise the solution + allocate(sol(22, ncycle * nstep + 1)) + + sol(1, 1) = 0.0_dp ! Flow through aortic valve + sol(2, 1) = 0.0_dp ! Flow through sinus + sol(3, 1) = 0.0_dp ! Flow through aorta + sol(4, 1) = 0.0_dp ! Flow through tricuspid + sol(5, 1) = 0.0_dp ! Flow through pulmonary + sol(6, 1) = 0.0_dp ! Flow through arteries + sol(7, 1) = 0.0_dp ! Flow through arterioles + sol(8, 1) = 0.0_dp ! Flow through mitral valve + + sol(9, 1) = pini_sys ! Initial arterial pressure + sol(10, 1) = pini_sys ! Initial arterial pressure + sol(11, 1) = pini_sys ! Initial arterial pressure + sol(12, 1) = pini_pulm ! Initial pulmonary pressure + sol(13, 1) = pini_pulm ! Initial pulmonary pressure + sol(14, 1) = pini_pulm ! Initial pulmonary pressure + + sol(15, 1) = h_cof%LV%v0_2 ! End diastolic left ventricular volume + sol(16, 1) = h_cof%LA%v0_2 ! End diastolic left atrial volume + sol(17, 1) = h_cof%RV%v0_2 ! End diastolic right ventricular volume + sol(18, 1) = h_cof%RA%v0_2 ! End diastolic right atrial volume + + sol(19, 1) = 0.0_dp ! Aortic valve is initially closed. + sol(20, 1) = 0.0_dp ! Mitral valve is initially closed. + sol(21, 1) = 0.0_dp ! Pulmonary valve is initially closed. + sol(22, 1) = 0.0_dp ! Tricuspid valve is initially closed. + + ! Solves the system of equations using a 4th order Runge-Kutta method + i = 0 ! Initialise + + do icycle = 1, ncycle + print *, 'Cycle: ', icycle + do k = 1, nstep + i = i + 1 + current_sol = sol(:, i) + if (rk == 2) then ! Second order Runge-Kutta + k1 = h * solver(current_sol, a_cof, v_cof, h_cof, elast, k) + k2 = h * solver(current_sol + k1/2, a_cof, v_cof, h_cof, elast, k) + sol(:, i+1) = current_sol + k2 + else if (rk == 4) then ! Fourth order Runge-Kutta + k1 = h * solver(current_sol, a_cof, v_cof, h_cof, elast, k) + k2 = h * solver(current_sol + k1/2, a_cof, v_cof, h_cof, elast, k) + k3 = h * solver(current_sol + k2/2, a_cof, v_cof, h_cof, elast, k) + if ( k /= nstep ) then + k4 = h * solver(current_sol + k3, a_cof, v_cof, h_cof, elast, k+1) + else + k4 = h * solver(current_sol + k3, a_cof, v_cof, h_cof, elast, 1) + end if + sol(:, i + 1) = current_sol + (k1 + 2 * k2 + 2 * k3 + k4) / 6 + end if + end do + end do + + ! Calculates ventricular pressures + allocate(h_pres(4, nstep)) + offset = (ncycle - 1) * nstep + 2 + h_pres(1, :) = ELV * (sol(15, offset:) - LV%v0_1) + h_pres(2, :) = ELA * (sol(16, offset:) - LA%v0_1) + h_pres(3, :) = ERV * (sol(17, offset:) - RV%v0_1) + h_pres(4, :) = ERA * (sol(18, offset:) - RA%v0_1) + + ! Saves the solution + io = 42 + nan_count = 0 + inf_count = 0 + open(newunit=io, file='output.csv', status='replace') + do i=offset, ncycle * nstep + do k=1, 22 + if ( i == offset ) then + write(io, fmt="(A, A)", advance='no') trim(headers(k)), ',' + if ( k == 22 ) then + write(io, fmt="(A)", advance='no') 'Left Ventricular Pressure,' + write(io, fmt="(A)", advance='no') 'Left Atrial Pressure,' + write(io, fmt="(A)", advance='no') 'Right Ventricular Pressure,' + write(io, fmt="(A)", advance='no') 'Right Atrial Pressure,' + write(io, fmt="(A)", advance='no') 'Left Ventricular Elastance,' + write(io, fmt="(A)", advance='no') 'Left Atrial Elastance,' + write(io, fmt="(A)", advance='no') 'Right Ventricular Elastance,' + write(io, fmt="(A)", advance='no') 'Right Atrial Elastance,' + write(io, fmt="(A)", advance='no') 'Time (s)' + end if + else + write(io, fmt="(f15.8, A)", advance='no') sol(k, i), ',' + if ( k == 22 ) then + write(io, fmt="(f15.8, A)", advance='no') h_pres(1, i - offset), ',' + write(io, fmt="(f15.8, A)", advance='no') h_pres(2, i - offset), ',' + write(io, fmt="(f15.8, A)", advance='no') h_pres(3, i - offset), ',' + write(io, fmt="(f15.8, A)", advance='no') h_pres(4, i - offset), ',' + write(io, fmt="(f15.8, A)", advance='no') ELV(i - offset), ',' + write(io, fmt="(f15.8, A)", advance='no') ELA(i - offset), ',' + write(io, fmt="(f15.8, A)", advance='no') ERV(i - offset), ',' + write(io, fmt="(f15.8, A)", advance='no') ERA(i - offset), ',' + write(io, fmt="(f15.8)", advance='no') t_axis(i - offset) + end if + + if (ieee_is_nan(sol(k, i))) then + nan_count = nan_count + 1 + else if (.not. ieee_is_finite(sol(k, i))) then + inf_count = inf_count + 1 + end if + end if + end do + write(io, *) ! New line + end do + close(io) + + if (nan_count > 0) then + print *, 'NaN values found in solution.' + print *, '% NaN values:', 100.0_dp * nan_count / size(sol) + print *, '% Inf values:', 100.0_dp * inf_count / size(sol) + else + print *, 'Converged!' + print *, 'Mean value:', sum(sol) / size(sol) + end if +end program main diff --git a/fpm.toml b/fpm.toml new file mode 100644 index 0000000..4289cf1 --- /dev/null +++ b/fpm.toml @@ -0,0 +1,14 @@ +name = "full_tree_lumped" +version = "0.1.0" +license = "license" +author = "Alex Drysdale" +maintainer = "reissuecardboard@duck.com" +copyright = "Copyright 2022, Alex Drysdale" +[build] +auto-executables = true +auto-tests = false +auto-examples = true +[install] +library = false +[dependencies] +toml-f.git = "https://github.com/toml-f/toml-f" diff --git a/src/cust_fns.f90 b/src/cust_fns.f90 new file mode 100644 index 0000000..0d9602a --- /dev/null +++ b/src/cust_fns.f90 @@ -0,0 +1,24 @@ +module cust_fns + + use kind_parameter + implicit none + + private + public midpoint + +contains + + pure function midpoint(x) result(mp) + + ! Declares initial variables + real(dp), allocatable, intent(in) :: x(:) + integer :: i + real(dp) :: dx(size(x) - 1) + real(dp) :: mp(size(x) - 1) + + do i = 1, size(dx) + dx(i) = x(i + 1) - x(i) + end do + mp = x(1:size(x)-1) + dx / 2 + end function midpoint +end module cust_fns diff --git a/src/data_types.f90 b/src/data_types.f90 new file mode 100644 index 0000000..58232fc --- /dev/null +++ b/src/data_types.f90 @@ -0,0 +1,80 @@ +module data_types + + use kind_parameter + implicit none + + private + public chamber, chambers + public arterial_system, arterial_network + public valve, valve_system + public heart_elastance + + ! Declares the type for each chamber + type :: chamber + real(dp) :: Ks + real(dp) :: Emin + real(dp) :: Emax + real(dp) :: V0_1 + real(dp) :: V0_2 + real(dp) :: m1 + real(dp) :: m2 + real(dp) :: tau1 + real(dp) :: tau2 + real(dp) :: onset + end type + + ! Declares the type for all 4 heart chambers + type :: chambers + type (chamber) :: LV + type (chamber) :: LA + type (chamber) :: RV + type (chamber) :: RA + end type + + ! Declare artery system + type :: arterial_system + real(dp) :: Ras + real(dp) :: Rat + real(dp) :: Rar + real(dp) :: Rcp + real(dp) :: Rvn + real(dp) :: Cas + real(dp) :: Cat + real(dp) :: Cvn + real(dp) :: Las + real(dp) :: Lat + end type + + ! Declares the complete network + type :: arterial_network + type (arterial_system) :: sys + type (arterial_system) :: pulm + real(dp) :: rho + end type + + ! Declares the valve type + type :: valve + real(dp) :: Leff ! cm + real(dp) :: Aeffmin + real(dp) :: Aeffmax + real(dp) :: Kvc + real(dp) :: Kvo + end type + + ! Declares a system of valves + type :: valve_system + type (valve) :: AV ! Aortic + type (valve) :: MV ! Mitral + type (valve) :: PV ! Pulmonary + type (valve) :: TV ! Tricuspid + end type + + ! Declares the heart elastance type + type :: heart_elastance + real(dp), allocatable :: ELV(:) + real(dp), allocatable :: ELA(:) + real(dp), allocatable :: ERV(:) + real(dp), allocatable :: ERA(:) + end type + +end module data_types diff --git a/src/elastance.f90 b/src/elastance.f90 new file mode 100644 index 0000000..e4150d6 --- /dev/null +++ b/src/elastance.f90 @@ -0,0 +1,89 @@ +module elastance + + use kind_parameter + use data_types + implicit none + + private + public calc_elastance + +contains + + elemental function mult(a, b) result(c) + real(dp), intent(in) :: a + real(dp), intent(in) :: b + real(dp) :: c + c = a * b + end function + + elemental function calc_g1(g1_1) result(g1_2) + real(dp), intent(in) :: g1_1 + real(dp) :: g1_2 + g1_2 = g1_1 / ( 1 + g1_1) + end function calc_g1 + + elemental function calc_g2(g2_1) result(g2_2) + real(dp), intent(in) :: g2_1 + real(dp) :: g2_2 + g2_2 = 1 / ( 1 + g2_1) + end function calc_g2 + + ! Calculates the elastance of the heart + pure function calc_elastance(LV, nstep, T, E_t) result(E_out) + + ! Declares input variables + type(chamber), intent(in) :: LV + integer, intent(in) :: nstep + real(dp), intent(in) :: T + real(dp), intent(in) :: E_t(nstep) + + ! Declares output variable + real(dp), dimension(nstep) :: E_out + + ! Declares intermediate variables + real(dp), dimension(nstep) :: E_tmp + integer :: i, t_idx + real(dp), dimension(nstep) :: q + real(dp), dimension(nstep - 1) :: dt + real(dp), dimension(nstep) :: v + real(dp), dimension(nstep) :: g1_1 ! g1 in MATLAB + real(dp), dimension(nstep) :: g2_1 + real(dp), dimension(nstep) :: g1_2 ! G1 in MATLAB + real(dp), dimension(nstep) :: g2_2 + real(dp), dimension(nstep) :: g12_prod + real(dp) :: k + real(dp), dimension(nstep) :: p_tmp + real(dp), dimension(nstep) :: p + real(dp), parameter :: pi=4.D0*datan(1.D0) + + ! Initialise output + E_out = 0 + + ! Defines variables + q = sin(2 * pi * E_t / ( 2 * T)) + do i = 1, nstep - 1 + dt(i) = E_t(i + 1) - E_t(i) + end do + v(1) = LV%V0_2 + v(2:) = LV%V0_2 - q(2:) * dt + + g1_1 = (E_t / (LV%tau1 * T)) ** LV%m1 + g2_1 = (E_t / (LV%tau2 * T)) ** LV%m2 + g1_2 = calc_g1(g1_1) + g2_2 = calc_g2(g2_1) + g12_prod = mult(g1_2, g2_2) + k = (LV%Emax - LV%Emin) / maxval(g12_prod) + + E_tmp = (k * g12_prod) + LV%Emin + p_tmp = mult(E_tmp, (v - LV%V0_1)) + p = mult(p_tmp, (1 - LV%Ks * q)) + + t_idx = count(E_t <= T - LV%onset) + if ( t_idx == nstep ) then + E_out = E_tmp + else + E_out(1:nstep-t_idx) = E_tmp(t_idx+1:) + E_out(1 + nstep-t_idx:) = E_tmp(:t_idx) + end if + end function calc_elastance +end module elastance diff --git a/src/funcs.f90 b/src/funcs.f90 new file mode 100644 index 0000000..0816a3e --- /dev/null +++ b/src/funcs.f90 @@ -0,0 +1,170 @@ +module funcs + + use kind_parameter + use data_types + implicit none + + private + public solver + +contains + + ! Solves the system + pure function solver(sol, a_cof, v_cof, h_cof, elast, k) result(ftot) + + ! Declare input variables + real(dp), dimension(22), intent(in) :: sol + type (arterial_network), intent(in) :: a_cof + type (valve_system), intent(in) :: v_cof + type (chambers), intent(in) :: h_cof + type (heart_elastance), intent(in) :: elast + integer, intent(in) :: k + + real(dp), dimension(22) :: ftot + real(dp) :: mmHg, resist, rho + real(dp) :: Qav, Qsas, Qsat, Qtv, Qpv, Qpas, Qpat, Qmv, Qpvn, Qsvn + real(dp) :: psas, psat, psvn, ppas, ppat, ppvn + real(dp) :: Vlv, Vla, Vrv, Vra + real(dp) :: ksi_av, ksi_mv, ksi_pv, ksi_tv + real(dp) :: plv, pla, prv, pra + real(dp), dimension(4) :: Aeff + real(dp), dimension(4) :: B + real(dp), dimension(4) :: Z + real(dp) :: dpav, dpmv, dppv, dptv + + ! Initialises ftot to be zero + ftot = 0.0_dp + + mmHg = 1333.0_dp + resist = 1.0_dp + + ! Flows + Qav = sol(1) + Qsas = sol(2) + Qsat = sol(3) + Qtv = sol(4) + Qpv = sol(5) + Qpas = sol(6) + Qpat = sol(7) + Qmv = sol(8) + + ! Pressures + psas = sol(9) + psat = sol(10) + psvn = sol(11) + ppas = sol(12) + ppat = sol(13) + ppvn = sol(14) + + ! Volumes + Vlv = sol(15) + Vla = sol(16) + Vrv = sol(17) + Vra = sol(18) + + ! Valves + ksi_av = sol(19) + ksi_mv = sol(20) + ksi_pv = sol(21) + ksi_tv = sol(22) + + ! Blood density + rho = a_cof%rho + + ! Pressures in the chambers of the heart + plv = elast%ELV(k) * (Vlv - h_cof%LV%V0_1) + pla = elast%ELA(k) * (Vla - h_cof%LA%V0_1) + prv = elast%ERV(k) * (VRv - h_cof%RV%V0_1) + pra = elast%ERA(k) * (VRa - h_cof%RA%V0_1) + + ! Inductance and resistance systemic + ftot(2) = (psas - psat - a_cof%sys%Ras * Qsas) / a_cof%sys%Las + ftot(3) = (psat - psvn - (a_cof%sys%Rat + a_cof%sys%Rar + a_cof%sys%Rcp)* Qsat) / a_cof%sys%Lat + Qsvn = (psvn - pra) / a_cof%sys%Rvn + + ! Inductance and resistance pulmonary + ftot(6) = (ppas - ppat - a_cof%pulm%Ras * Qpas) / a_cof%pulm%Las + ftot(7) = (ppat - ppvn - (a_cof%pulm%Rat + a_cof%pulm%Rar + a_cof%pulm%Rcp)* Qpat) / a_cof%pulm%Lat + Qpvn = (ppvn - pla) / a_cof%pulm%Rvn + + ! Compliance systemic + ftot(9) = (Qav - Qsas) / a_cof%sys%Cas + ftot(10) = (Qsas - Qsat) / a_cof%sys%Cat + ftot(11) = (Qsat - Qsvn) / a_cof%sys%Cvn + + ! Compliance Pulmonary + ftot(12) = (Qpv - Qpas) / a_cof%pulm%Cas + ftot(13) = (Qpas - Qpat) / a_cof%pulm%Cat + ftot(14) = (Qpat - Qpvn) / a_cof%pulm%Cvn + + ! Volume-Flow relations systemic + ftot(15) = Qmv- Qav + ftot(16) = Qpvn - Qmv + ftot(17) = Qtv - Qpv + ftot(18) = Qsvn - Qtv + + !!! Aortic Valve !!! + ! Effective area of the valve + Aeff(1) = (v_cof%AV%Aeffmax - v_cof%AV%Aeffmin) * ksi_av + v_cof%AV%Aeffmin + ! Bernoulli resistance of the valve + B(1) = rho / (2 * Aeff(1) ** 2) * resist + ! Impedance of the valve + Z(1) = rho * v_cof%AV%Leff/Aeff(1) + + ! Pressure-flow relations through valve + dpav = (plv - psas) * mmHg + ftot(1) = (dpav - B(1) * Qav * abs(Qav))/ Z(1) + + if (dpav <= 0) then ! Valve closing + ftot(19) = ksi_av * v_cof%AV%Kvc * dpav + else ! Valve opening + ftot(19) = (1 - ksi_av) * v_cof%AV%Kvo * dpav + end if + + !!! Mitral Valve !!! + Aeff(2) = (v_cof%MV%Aeffmax - v_cof%MV%Aeffmin) * ksi_mv + v_cof%MV%Aeffmin + B(2) = rho / (2 * Aeff(2) ** 2) * resist + Z(2) = rho * v_cof%MV%Leff / Aeff(2) + + ! Pressure-flow relations through valve + dpmv = (pla-plv)*mmHg + ftot(8) = (dpmv-B(2)*Qmv*abs(Qmv) )/Z(2) + + if (dpmv <= 0) then ! Valve closing + ftot(20) = ksi_mv*v_cof%MV%Kvc*dpmv + else ! Valve opening + ftot(20) = (1-ksi_mv)*v_cof%MV%Kvo*dpmv + end if + + + !!! Pulmonary Valve !!! + Aeff(3) = (v_cof%PV%Aeffmax-v_cof%PV%Aeffmin)*ksi_pv + v_cof%PV%Aeffmin + B(3) = rho/(2 * Aeff(3) ** 2)*resist + Z(3) = rho*v_cof%PV%Leff/Aeff(3) + + ! pressure-flow relations through valve + dppv = (prv-ppas)*mmHg + ftot(5) = (dppv-B(3)*Qpv*abs(Qpv) )/Z(3) ! Qpv + + if (dppv <= 0) then !valve closing + ftot(21) = ksi_pv*v_cof%PV%Kvc*dppv + else ! valve opening + ftot(21) = (1-ksi_pv)*v_cof%PV%Kvo*dppv ! ksi_pv + end if + + !!! Tricuspic Valve !!! + Aeff(4) = (v_cof%TV%Aeffmax-v_cof%TV%Aeffmin)*ksi_tv + v_cof%TV%Aeffmin + B(4) = rho/(2*Aeff(4)**2)*resist + Z(4) = rho*v_cof%MV%Leff/Aeff(4) + + ! pressure-flow relations through valve + dptv = (pra-prv)*mmHg + ftot(4) = (dptv-B(4)*Qtv*abs(Qtv) )/Z(4) !Qtv + + if (dptv <= 0) then ! Valve closing + ftot(22) = ksi_tv*v_cof%TV%Kvc*dptv + else ! Valve opening + ftot(22) = (1-ksi_tv)*v_cof%TV%Kvo*dptv !ksi_tv + end if + end function solver +end module funcs diff --git a/src/inputs.f90 b/src/inputs.f90 new file mode 100644 index 0000000..e2ff356 --- /dev/null +++ b/src/inputs.f90 @@ -0,0 +1,78 @@ +module inputs + ! Heart Input Declaration + use kind_parameter + use data_types + implicit none + + private + public heart_input, artery_input + +contains + + ! Gets the heart input + subroutine heart_input(LV, LA, RV, RA, T, scale_EmaxLV, scale_EmaxRV, scale_Emax) + + ! Defines initial variables + real(dp), intent(in) :: T + real(dp), intent(in) :: scale_EmaxLV + real(dp), intent(in) :: scale_EmaxRV + real(dp), intent(in) :: scale_Emax + + type (chamber), intent(inout) :: LV + type (chamber), intent(inout) :: LA + type (chamber), intent(inout) :: RV + type (chamber), intent(inout) :: RA + + ! Left Ventricle + LV%Emax = LV%Emax * scale_EmaxLV + LV%tau1 = LV%tau1 * T + LV%tau2 = LV%tau2 * T + + ! Left Atrium + LA%Emax = LA%Emax * scale_Emax + LA%tau1 = LA%tau1 * T + LA%tau2 = LA%tau2 * T + LA%onset = LA%onset * T + + ! Right Ventricle + RV%Emax = RV%Emax * scale_EmaxRV + RV%tau1 = RV%tau1 * T + RV%tau2 = RV%tau2 * T + + ! Right Atrium + RA%Emax = RA%Emax * scale_Emax + RA%tau1 = RA%tau1 * T + RA%tau2 = RA%tau2 * T + RA%onset = RA%onset * T + + end subroutine heart_input + + ! Gets the artery input + subroutine artery_input(sys, pulm, scale_Rsys, scale_Csys, scale_Rpulm, scale_Cpulm) + + ! Declare inputs + type (arterial_system), intent(inout) :: sys, pulm + real(dp), intent(in) :: scale_Rsys, scale_Csys, scale_Rpulm, scale_Cpulm + + ! Systemic system + sys%Ras = sys%Ras * scale_Rsys + sys%Rat = sys%Rat * scale_Rsys + sys%Rar = sys%Rar * scale_Rsys + sys%Rcp = sys%Rcp * scale_Rsys + + sys%Cas = sys%Cas * scale_Csys + sys%Cat = sys%Cat * scale_Csys + sys%Cvn = sys%Cvn * scale_Csys + + ! Pulmonary system + pulm%Ras = pulm%Ras * scale_Rpulm + pulm%Rat = pulm%Rat * scale_Rpulm + pulm%Rar = pulm%Rar * scale_Rpulm + pulm%Rcp = pulm%Rcp * scale_Rpulm + + pulm%Cas = pulm%Cas * scale_Cpulm + pulm%Cat = pulm%Cat * scale_Cpulm + pulm%Cvn = pulm%Cvn * scale_Cpulm + + end subroutine artery_input +end module inputs diff --git a/src/kind_parameter.f90 b/src/kind_parameter.f90 new file mode 100644 index 0000000..61b8039 --- /dev/null +++ b/src/kind_parameter.f90 @@ -0,0 +1,22 @@ +!> Numerical storage size parameters for real and integer values +module kind_parameter + implicit none + public + + !> Single precision real numbers, 6 digits, range 10⁻³⁷ to 10³⁷-1; 32 bits + integer, parameter :: sp = selected_real_kind(6, 37) + !> Double precision real numbers, 15 digits, range 10⁻³⁰⁷ to 10³⁰⁷-1; 64 bits + integer, parameter :: dp = selected_real_kind(15, 307) + !> Quadruple precision real numbers, 33 digits, range 10⁻⁴⁹³¹ to 10⁴⁹³¹-1; 128 bits + integer, parameter :: qp = selected_real_kind(33, 4931) + + !> Char length for integers, range -2⁷ to 2⁷-1; 8 bits + integer, parameter :: i1 = selected_int_kind(2) + !> Short length for integers, range -2¹⁵ to 2¹⁵-1; 16 bits + integer, parameter :: i2 = selected_int_kind(4) + !> Length of default integers, range -2³¹ to 2³¹-1; 32 bits + integer, parameter :: i4 = selected_int_kind(9) + !> Long length for integers, range -2⁶³ to 2⁶³-1; 64 bits + integer, parameter :: i8 = selected_int_kind(18) + +end module kind_parameter