Function
Created Thursday 26 July 2012
Short description of the function
1. Purpose of Function
description of typical application cases
2. Limits of Validity
...
3. Interfaces
4. Nomenclature
a table referencing the nomenclature in the source code, the descriptions of variables and the "human-readable" , use the following latex table template and respect the overall textwidth of 150mm:
\renewcommand{\arraystretch}{1.25}
\begin{longtable}{||p{65mm}|p{20mm}|p{65mm}||}
\hline \multicolumn{1}{||p{65mm}|}{\textbf{Source Code}} & \multicolumn{1}{p{20mm}|}{\textbf{Variable ClaRa}} & \multicolumn{1}{p{65mm}||}{\textbf{Description}} \\ \hline\hline
\endfirsthead
\multicolumn{3}{r}%
{Nomenclature -- continued from previous page} \\
\hline \hline \multicolumn{1}{||p{65mm}|}{\textbf{Source Code}} & \multicolumn{1}{p{20mm}|}{\textbf{Variable ClaRa}} & \multicolumn{1}{p{65mm}||}{\textbf{Description}} \\ \hline
\endhead
\hline \multicolumn{3}{r}Continued on next page \\ \hline
\endfoot
\hline
\endlastfoot
\texttt{Delta\_h\_vap} & $\Delta hvap$ & Heat of vapourisation $[J/kg]$ \\\hline
\end{longtable}
5. Governing Equations
6. Remarks for Usage
7. Validation
8. References
9. Authorship and Copyright Statement for original (initial) Contribution
Author:
DYNCAP/DYNSTART development team, Copyright © 2011 - 2020.
Remarks:
This component was developed during DYNCAP/DYNSTART projects.
Acknowledgements:
Acknowledgements:
ClaRa originated from the collaborative research projects DYNCAP and DYNSTART. Both research projects were supported by the German Federal Ministry for Economic Affairs and Energy (FKZ 03ET2009 and FKZ 03ET7060).
CLA:
The author(s) have agreed to ClaRa CLA, version 1.0. See https://claralib.com/CLA
By agreeing to ClaRa CLA, version 1.0 the author has granted the ClaRa development team a permanent right to use and modify his initial contribution as well as to publish it or its modified versions under the 3-clause BSD License.
10. Version History
Date - Version - Description of changes - author/revisor
Backlinks: ZIM DocumentationTemplate:Creating Nice ClaRa Documentation