Logo

Library Contents

Search

Download

QCalc.UsersGuide QCalc.UsersGuide

Extends from Icons.Information (Icon for general information packages (from MSL 3.2.1)).

Package Contents

Name Description
QCalc.UsersGuide.GettingStarted GettingStarted Getting started
QCalc.UsersGuide.Glossary Glossary Glossary
QCalc.UsersGuide.Publications Publications Publications
QCalc.UsersGuide.References References References
QCalc.UsersGuide.ReleaseNotes ReleaseNotes Release notes
QCalc.UsersGuide.Contact Contact Contact
QCalc.UsersGuide.License License License

QCalc.UsersGuide.GettingStarted QCalc.UsersGuide.GettingStarted


QCalc.UsersGuide.GettingStarted

There are some points to note besides those in the "Usage" section of the top-level documentation:

  1. Turn off unit checking in Dymola: 
        Advanced.CheckUnits = false;
    This is automatic if QCalc is loaded via load.mos.
  2. Call QCalc.Units.setup() to establish the display units in Dymola. This is automatic if QCalc is loaded via load.mos.
  3. Note that angle is explicit in the definitions of quantities, units, and constants. This helps to identify dimensional inconsistencies and provide insight into the physical equations. Sometimes it is necessary to include factors of U.rad, U.cyc, etc. (where U is QCalc.Units), but usually those units cancel. See QCalc.Units for details on where this is important.
  4. The global variable time is in seconds. It is not a quantity, so it must be multiplied by the unit second (U.s) when used with other quantities. When writing a derivative, it is important to divide the result of the der operator by the unit second: der(x)/U.s. By default, the second has a value of one, but this will not be the case if the base constants are changed.
  5. When using results based on QCalc in an external tool, note that the values of the SI base and coherently derived units are not necessarily one. The values can be loaded from the "units.mos" file that is automatically generated by load.mos in the working directory.
  6. If you wish to introduce new quantities, it may help to use the quantities.xlsx spreadsheet.
  7. There are more details about the implementation in QCalc.Units.

Extends from Icons.Information (Icon for general information packages (from MSL 3.2.1)).

QCalc.UsersGuide.Contact QCalc.UsersGuide.Contact


QCalc.UsersGuide.Contact

If you find a bug, have a suggestion, or just want to leave a comment, please open an issue. If possible, please share any fixes and improvements as pull requests to the master branch of the GitHub repository.

Author:
Hawaiʻi Natural Energy Institute
School of Ocean and Earth Science and Technology
University of Hawaiʻi at Mānoa
1680 East-West Road, POST 109
Honolulu, HI 96822
USA
email: kdavies@hawaii.edu

Credits:
The logo is based on a diagram of the electron shell transitions of hydrogen by Szdori (Mar. 19 2009).

Extends from Icons.Contact (Icon for contact information (from MSL 3.2.1)).

QCalc.UsersGuide.License QCalc.UsersGuide.License


QCalc.UsersGuide.License

All files in this directory (QCalc) and all subdirectories are licensed by the Hawaii Natural Energy Institute under the Modelica License 2 with the additional condition:

  • This software is controlled under the jurisdiction of the United States Department of Commerce and subject to Export Administration Regulations. By downloading or using the Software, you are agreeing to comply with U. S. export controls. Diversion contrary to law is prohibited. The software cannot be exported or reexported to sanctioned countries that are controlled for Anti-Terrorism (15 CFR Part 738 Supplement 1) or to denied parties, http://www.bis.doc.gov/index.php/policy-guidance/lists-of-parties-of-concern. EAR99 items cannot be exported or reexported to Iraq for a military purpose or to a military end-user (15 CFR Part 746.3). Export and reexport include any release of technology to a foreign national within the United States. Technology is released for export when it is available to foreign nationals for visual inspection, when technology is exchanged orally or when technology is made available by practice or application under the guidance of persons with knowledge of the technology.

Copyright © 2009–2014, Hawaii Natural Energy Institute and Georgia Tech Research Corporation

The Modelica License 2

Preamble. The goal of this license is that Modelica related model libraries, software, images, documents, data files etc. can be used freely in the original or a modified form, in open source and in commercial environments (as long as the license conditions below are fulfilled, in particular sections 2c) and 2d). The Original Work is provided free of charge and the use is completely at your own risk. Developers of free Modelica packages are encouraged to utilize this license for their work.

The Modelica License applies to any Original Work that contains the following licensing notice adjacent to the copyright notice(s) for this Original Work:

Licensed by the Hawaii Natural Energy Institute under the Modelica License 2

1. Definitions.

  1. “License” is this Modelica License.
  2. “Original Work” is any work of authorship, including software, images, documents, data files, that contains the above licensing notice or that is packed together with a licensing notice referencing it.
  3. “Licensor” is the provider of the Original Work who has placed this licensing notice adjacent to the copyright notice(s) for the Original Work. The Original Work is either directly provided by the owner of the Original Work, or by a licensee of the owner.
  4. “Derivative Work” is any modification of the Original Work which represents, as a whole, an original work of authorship. For the matter of clarity and as examples:
    1. Derivative Work shall not include work that remains separable from the Original Work, as well as merely extracting a part of the Original Work without modifying it.
    2. Derivative Work shall not include (a) fixing of errors and/or (b) adding vendor-specific Modelica annotations and/or (c) using a subset of the classes of a Modelica package, and/or (d) using a different representation, e.g., a binary representation.
    3. Derivative Work shall include classes that are copied from the Original Work where declarations, equations or the documentation are modified.
    4. Derivative Work shall include executables to simulate the models that are generated by a Modelica translator based on the Original Work (of a Modelica package).
  5. “Modified Work” is any modification of the Original Work with the following exceptions: (a) fixing of errors and/or (b) adding vendor-specific Modelica annotations and/or (c) using a subset of the classes of a Modelica package, and/or (d) using a different representation, e.g., a binary representation.
  6. "Source Code" means the preferred form of the Original Work for making modifications to it and all available documentation describing how to modify the Original Work.
  7. “You” means an individual or a legal entity exercising rights under, and complying with all of the terms of, this License.
  8. “Modelica package” means any Modelica library that is defined with the “package <Name> … end <Name>;” Modelica language element.

2. Grant of Copyright License. Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable license, for the duration of the copyright, to do the following:

  1. To reproduce the Original Work in copies, either alone or as part of a collection.

  2. To create Derivative Works according to Section 1d) of this License.

  3. To distribute or communicate to the public copies of the Original Work or a Derivative Work under this License. No fee, neither as a copyright-license fee, nor as a selling fee for the copy as such may be charged under this License. Furthermore, a verbatim copy of this License must be included in any copy of the Original Work or a Derivative Work under this License.
    For the matter of clarity, it is permitted A) to distribute or communicate such copies as part of a (possible commercial) collection where other parts are provided under different licenses and a license fee is charged for the other parts only and B) to charge for mere printing and shipping costs.

  4. To distribute or communicate to the public copies of a Derivative Work, alternatively to Section 2c), under any other license of your choice, especially also under a license for commercial/proprietary software, as long as You comply with Sections 3, 4 and 8 below.
    For the matter of clarity, no restrictions regarding fees, either as to a copyright-license fee or as to a selling fee for the copy as such apply.

  5. To perform the Original Work publicly.

  6. To display the Original Work publicly.

3. Acceptance. Any use of the Original Work or a Derivative Work, or any action according to either Section 2a) to 2f) above constitutes Your acceptance of this License.

4. Designation of Derivative Works and of Modified Works. The identifying designation of Derivative Work and of Modified Work must be different to the corresponding identifying designation of the Original Work. This means especially that the (root-level) name of a Modelica package under this license must be changed if the package is modified (besides fixing of errors, adding vendor-specific Modelica annotations, using a subset of the classes of a Modelica package, or using another representation, e.g. a binary representation).

5. Grant of Patent License. Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable license, under patent claims owned by the Licensor or licensed to the Licensor by the owners of the Original Work that are embodied in the Original Work as furnished by the Licensor, for the duration of the patents, to make, use, sell, offer for sale, have made, and import the Original Work and Derivative Works under the conditions as given in Section 2. For the matter of clarity, the license regarding Derivative Works covers patent claims to the extent as they are embodied in the Original Work only.

6. Provision of Source Code. Licensor agrees to provide You with a copy of the Source Code of the Original Work but reserves the right to decide freely on the manner of how the Original Work is provided.
      For the matter of clarity, Licensor might provide only a binary representation of the Original Work. In that case, You may (a) either reproduce the Source Code from the binary representation if this is possible (e.g., by performing a copy of an encrypted Modelica package, if encryption allows the copy operation) or (b) request the Source Code from the Licensor who will provide it to You.

7. Exclusions from License Grant. Neither the names of Licensor, nor the names of any contributors to the Original Work, nor any of their trademarks or service marks, may be used to endorse or promote products derived from this Original Work without express prior permission of the Licensor. Except as otherwise expressly stated in this License and in particular in Sections 2 and 5, nothing in this License grants any license to Licensor’s trademarks, copyrights, patents, trade secrets or any other intellectual property, and no patent license is granted to make, use, sell, offer for sale, have made, or import embodiments of any patent claims.
      No license is granted to the trademarks of Licensor even if such trademarks are included in the Original Work, except as expressly stated in this License. Nothing in this License shall be interpreted to prohibit Licensor from licensing under terms different from this License any Original Work that Licensor otherwise would have a right to license.

8. Attribution Rights. You must retain in the Source Code of the Original Work and of any Derivative Works that You create, all author, copyright, patent, or trademark notices, as well as any descriptive text identified therein as an "Attribution Notice". The same applies to the licensing notice of this License in the Original Work. For the matter of clarity, “author notice” means the notice that identifies the original author(s).
      You must cause the Source Code for any Derivative Works that You create to carry a prominent Attribution Notice reasonably calculated to inform recipients that You have modified the Original Work.
      In case the Original Work or Derivative Work is not provided in Source Code, the Attribution Notices shall be appropriately displayed, e.g., in the documentation of the Derivative Work.

9. Disclaimer of Warranty.
The Original Work is provided under this License on an "as is" basis and without warranty, either express or implied, including, without limitation, the warranties of non-infringement, merchantability or fitness for a particular purpose. The entire risk as to the quality of the Original Work is with You. This disclaimer of warranty constitutes an essential part of this License. No license to the Original Work is granted by this License except under this disclaimer.

10. Limitation of Liability. Under no circumstances and under no legal theory, whether in tort (including negligence), contract, or otherwise, shall the Licensor, the owner or a licensee of the Original Work be liable to anyone for any direct, indirect, general, special, incidental, or consequential damages of any character arising as a result of this License or the use of the Original Work including, without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses. This limitation of liability shall not apply to the extent applicable law prohibits such limitation.

11. Termination. This License conditions your rights to undertake the activities listed in Section 2 and 5, including your right to create Derivative Works based upon the Original Work, and doing so without observing these terms and conditions is prohibited by copyright law and international treaty. Nothing in this License is intended to affect copyright exceptions and limitations. This License shall terminate immediately and You may no longer exercise any of the rights granted to You by this License upon your failure to observe the conditions of this license.

12. Termination for Patent Action. This License shall terminate automatically and You may no longer exercise any of the rights granted to You by this License as of the date You commence an action, including a cross-claim or counterclaim, against Licensor, any owners of the Original Work or any licensee alleging that the Original Work infringes a patent. This termination provision shall not apply for an action alleging patent infringement through combinations of the Original Work under combination with other software or hardware.

13. Jurisdiction. Any action or suit relating to this License may be brought only in the courts of a jurisdiction wherein the Licensor resides and under the laws of that jurisdiction excluding its conflict-of-law provisions. The application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded. Any use of the Original Work outside the scope of this License or after its termination shall be subject to the requirements and penalties of copyright or patent law in the appropriate jurisdiction. This section shall survive the termination of this License.

14. Attorneys’ Fees. In any action to enforce the terms of this License or seeking damages relating thereto, the prevailing party shall be entitled to recover its costs and expenses, including, without limitation, reasonable attorneys' fees and costs incurred in connection with such action, including any appeal of such action. This section shall survive the termination of this License.

15. Miscellaneous.

  1. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable.
  2. No verbal ancillary agreements have been made. Changes and additions to this License must appear in writing to be valid. This also applies to changing the clause pertaining to written form.
  3. You may use the Original Work in all ways not otherwise restricted or conditioned by this License or by law, and Licensor promises not to interfere with or be responsible for such uses by You.

Extends from Icons.Information (Icon for general information packages (from MSL 3.2.1)).

Copyright © 2009–2014, , Hawaii Natural Energy Institute. Last updated Tue Mar 24 10:35:51 2015.