MohidWiki - User contributions [en]

Current End User Agreement

2006-04-03T23:53:24Z

87.196.135.215:

Mohid End-User License Agreement

Mohid grants to the applicant a personal, non-transferable and non-exclusive License for use to Mohid software. A designated staff will assist participants to utilize the Mohid Software within the domain of its capability.

In return, the Mohid user agrees to voluntarily submit suggestions for improvements regarding the technical capabilities of the model and its GUI. Any research work developed and published with any reference to the utilization of Mohid model should be communicated to Mohid Group.
The user should have sufficient expertise and experience in numerical model applications and in Mohid scientific application areas, to insure the effective use of the Mohid Software to solve the problems within the capabilities of this model. Any liability caused by the misuse of the model, including his GUI and input data, shall be the responsibility of the user. Mohid does not provide warranty of any kind.
This software cannot be used with commercial purposes. Selling, giving, lending or granting access to the software to anyone that is not bound to all of the terms and conditions of this License Agreement is prohibited.

Cooperation between Mohid developers and users is encouraged, in order to improve and/or solve any specific problem requiring capabilities not available in Mohid. This cooperation can be established without financial obligations as long as it is mutually beneficial.

Runtime short notice

2006-04-03T21:55:20Z

87.196.135.215:

the GNU page, [http://www.gnu.org/copyleft/gpl.html#SEC3], recomends that if the program is interactive, a short notice like this should apear when it starts:
----------------
Mohid version 4, Copyright (C) 1986, 1998, 2005, MARETEC / IST 
Mohid 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.
------------------

Reference to the license

2006-04-03T21:53:23Z

87.196.135.215:

According to the GNU web page, the following text is to be attached to the start of each source file:
------------------------------
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 2 
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, write to the Free Software 
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-----------------------------------
Information on how to contact MARETEC by electronic and paper mail.

Copyright

2006-04-03T21:52:44Z

87.196.135.215:

To copyright a program every file containing source code must include the following information:
*One line to give the program's name and an idea of what it does. 
*Copyright (C) yyyy name of author 

Mohid source files should include this couple of lines:
-------------------------
MOHID Water Modelling System. 
Copyright (C) 1985, 1998, 2002, 2006. MARETEC, Instituto Superior Técnico, Technical University of Lisbon.
------------------------

Copyrighting and licensing the Mohid system

2006-04-03T21:52:20Z

87.196.135.215:

The Mohid system is currently undergoing its licensing process. The first step towards this goal is to [[copyright]] it.

The second and most important one will be its release to the public domain under a free software license. The adoption of a particular license requires a balance between what the public will be entitled to do with the Mohid source code and the obligation of its users.

The aim of the MARETEC (IST) group is to release the Mohid source code in a way that:
*software based on Mohid's foundations must be public and freely available to everyone in general and to MARETEC in particular;
*developers interested in marine and limnology modelation will be able to contribute back their work to the Mohid system.

GPL, [http://www.gnu.org/copyleft/gpl.html#SEC3], is the most likely candidate license to be chosen. To license a program a [[reference to the license]] must be included at the top of every source code files.

The executable should also have a reference to the GPL license ([[Runtime short notice]]).

[[Current End User Agreement]].

Acomulated volumes

2006-04-03T21:51:05Z

87.196.135.215:

The acomulated volumes files describes the relationship between the free surface heigth and the reservoir water's volume.
The keywords are:
*<Fill>....</Fill> - a block containig free surface heigths/reservoir water's volume. It must be ordered, increasing from the top to the bottom of the file.

Acomulated volumes file sample:
--------------------------------
Alqueva's acomulated volumes 
height volume 
<Fill> 
0.4 802456000 
0.65 815154000 
1 833269000 
1.17 842213000 
1.64 867442000 
1.8 876202000 
2.15 895674000 
2.42 910991000 
2.75 930067000 
3.54 977373000 
3.68 986004000 
3.8 993463000 
3.9 999721000 
4 1006019000 
4.25 1021938000 
4.81 1058517000 
5.24 1087491000 
5.63 1114455000 
5.98 1139222000 
6.6 1184453000 
6.7 1191915000 
6.8 1199424000 
6.87 1204708000 
6.91 1207738000 
7.14 1225309000 
7.18 1228391000 
7.24 1233028000 
7.28 1236130000 
7.33 1240017000 
7.46 1250182000 
7.5 1253327000 
7.54 1256479000 
7.57 1258848000 
7.61 1262014000 
7.7 1269168000 
7.73 1271561000 
7.8 1277163000 
7.97 1290871000 
8.15 1305546000 
8.55 1338757000 
8.77 1357381000 
9.05 1381460000 
9.61 1430908000 
10.2 1484920000 
10.96 1557511000 
11 1561429000 
11.01 1562410000 
11.02 1563391000 
11.03 1564373000 
11.03 1564373000 
11.04 1565356000 
11.05 1566339000 
11.05 1566339000 
11.06 1567323000 
11.06 1567323000 
11.08 1569293000 
11.08 1569293000 
11.08 1569293000 
11.1 1571265000 
11.1 1571265000 
11.1 1571265000 
11.1 1571265000 
11.1 1571265000 
11.11 1572252000 
11.12 1573240000 
11.12 1573240000 
11.12 1573240000 
11.13 1574228000 
11.14 1575217000 
11.14 1575217000 
11.14 1575217000 
11.14 1575217000 
11.14 1575217000 
11.14 1575217000 
11.14 1575217000 
11.14 1575217000 
11.14 1575217000 
11.14 1575217000 
11.14 1575217000 
11.15 1576207000 
11.16 1577197000 
11.16 1577197000 
11.18 1579179000 
11.18 1579179000 
11.18 1579179000 
11.18 1579179000 
11.18 1579179000 
11.18 1579179000 
11.18 1579179000 
11.19 1580171000 
11.19 1580171000 
11.19 1580171000 
11.19 1580171000 
11.19 1580171000 
11.2 1581164000 
11.2 1581164000 
11.2 1581164000 
11.2 1581164000 
11.2 1581164000 
11.2 1581164000 
11.2 1581164000 
11.2 1581164000 
11.2 1581164000 
11.2 1581164000 
11.21 1582157000 
11.21 1582157000 
11.21 1582157000 
11.21 1582157000 
11.22 1583151000 
11.22 1583151000 
11.22 1583151000 
11.22 1583151000 
11.22 1583151000 
11.22 1583151000 
11.22 1583151000 
11.22 1583151000 
11.23 1584146000 
11.23 1584146000 
11.26 1587133000 
11.26 1587133000 
11.29 1590126000 
11.3 1591125000 
11.33 1594125000 
11.35 1596129000 
11.35 1596129000 
11.35 1596129000 
11.36 1597132000 
11.36 1597132000 
11.36 1597132000 
11.36 1597132000 
11.41 1602154000 
11.44 1605176000 
11.45 1606184000 
11.49 1610224000 
11.6 1621386000 
11.6 1621386000 
11.6 1621386000 
11.62 1623424000 
11.62 1623424000 
11.64 1625464000 
11.64 1625464000 
11.66 1627507000 
11.67 1628529000 
11.67 1628529000 
11.7 1631600000 
11.71 1632625000 
11.72 1633651000 
11.73 1634677000 
11.74 1635704000 
11.8 1641879000 
11.86 1648077000 
11.92 1654299000 
11.96 1658460000 
12.02 1664720000 
12.27 1691063000 
12.35 1699580000 
12.39 1703855000 
12.45 1710287000 
12.48 1713512000 
12.56 1722143000 
12.59 1725390000 
12.64 1730816000 
12.66 1732992000 
12.67 1734080000 
12.87 1755998000 
12.97 1767060000 
13.11 1782665000 
13.2 1792769000 
</Fill>
---------------------------------

CQUAL-W2's format

2006-04-03T21:49:13Z

87.196.135.215:

The CQUAL-W2's format s complicated and you should refer to its documentation at [http://www.ce.pdx.edu/w2/].

Sample CQUAL-W2's bathymetry file:
-------------------------------
Bathymetry File for CE-Qual-W2 V3.12 - ALQUEVA (SEG 25, LAY 30, BRA 1)

Segment length [DLX]
3428.67 3428.67 2142.86 2142.86 1714.29 2142.86 2142.86 1285.71 1714.29 1714.29
3000.00 1714.29 2142.86 2142.86 2785.71 3000.00 2571.43 2571.43 1714.29 2571.43
1928.57 857.14 1071.43 1928.57 1928.57

Water surface elevation [ELWS]
50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00
50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00
50.00 50.00 50.00 50.00 50.00

Angle/Segment orientation [PHI0]
0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00
0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00
0.00 0.00 0.00 0.00 0.00

Bottom Friction [FRICT]
75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00
75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00
75.00 75.00 75.00 75.00 75.00

Dz/Layer thickness (weigth,m) [H]
2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000
2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000
2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000

Segment #1 Dist(m) - Upstream segmento of
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000

Segment # 2 Dist(m)
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000

Segment # 3 Dist(m)
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000

Segment # 4 Dist(m)
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000

Segment # 5 Dist(m)
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000

Segment # 6 Dist(m)
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000

Segment # 7 Dist(m)
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000

Segment # 8 Dist(m)
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000

Segment # 9 Dist(m) 20
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000

Segment # 10 Dist(m)
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000

Segment # 11 Dist(m) 24
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000

Segment # 12 Dist(m) 30
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000

Segment # 13 Dist(m) 34
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000

Segment # 14 Dist(m) 36
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000

Segment # 15 Dist(m) 40
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000

Segment # 16 Dist(m) 42
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000

Segment # 17 Dist(m)
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000

Segment # 18 Dist(m) 46
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000

Segment # 19 Dist(m) 50
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 0.0000 0.0000 0.0000 0.0000

Segment # 20 Dist(m)
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 0.0000 0.0000 0.0000 0.0000

Segment # 21 Dist(m) 50
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 0.0000 0.0000 0.0000 0.0000

Segment # 22 Dist(m) 52
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 0.0000 0.0000 0.0000

Segment # 23 Dist(m) 54
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 0.0000

Segment # 24 Dist(m) 54
0.0000 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00
1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 1500.00 0.0000

Segment # 25 Dist(m)
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000
0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000
-------------------------------

Free form

2006-04-03T21:48:15Z

87.196.135.215:

A free form bathymetry uses the following keywords:
*COMMENT_HEADER - a optional comment line describing the bathymetry;
*COMMENT_DLX - a optional comment line;
*DLX - a array with with IMX elements, containing the length of each reservoier segment, from 1 to IMX;
*COMMENT_ELWS - a optional comment line;
*ELWS - a array with with IMX elements, containing the inicial surface elevation at each reservoier segment, from 1 to IMX;
*COMMENT_EPHI0 - aCOMMENT_FRIC
*EPHI0 - a array with with IMX elements, Angle/Segment orientation, from 1 to IMX;
*COMMENT_FRIC - a optional comment line;
*FRIC - a array with with IMX elements, containing the Bottom Friction, from 1 to IMX;
*COMMENT_H - a optional comment line;
*H - a array with with KMX elements, Dz/Layer thickness, from 1 (surface) to KMX (bottom);
*COMMENT_SEGMENT - a optional comment line;
*<Segments>...</Segments> - block of data with IMX raws and 4 columns. The first column specifies the segment it refers to, the second column contains the width of the surface layer, the third column contains the bottom width and the forth column specifies the bottom layer. If the last 3 columns are zero it means it is the extremity of a branch.

Sample free form bathymetry:
------------------------
COMMENT_HEADER : Bathymetry File for CE-Qual-W2 V3.12 - ALQUEVA (SEG 25, LAY 30, BRA 1)

COMMENT_DLX : Segment length [DLX] 
DLX : 3428.67 3428.67 2142.86 2142.86 1714.29 2142.86 2142.86 1285.71 1714.29 1714.29 3000.00 1714.29 2142.86 2142.86 2785.71 3000.00 2571.43 2571.43 1714.29 2571.43 1928.57 857.14 1071.43 1928.57 1928.57

COMMENT_ELWS : Water surface elevation [ELWS] 
ELWS : 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00 50.00

COMMENT_EPHI0 : Angle/Segment orientation [PHI0] 
PHI0 : 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00

COMMENT_FRIC : Bottom Friction [FRICT] 
FRIC : 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00 75.00

COMMENT_H : Dz/Layer thickness (weigth,m) [H] 
H : 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000 2.000

COMMENT_SEGMENT : Dist(m) - Upstream segmento of 
!i B_K2 B_KN KN 
<Segments> 
1 0 0 0 
2 1500 500 3 
3 1500 500 4 
4 1500 500 5 
5 1500 500 7 
6 1500 500 8 
7 1500 500 9 
8 1500 500 9 
9 1600 670 9 
10 1600 670 10 
11 1600 670 11 
12 1600 670 11 
13 1600 670 11 
14 1600 670 11 
15 1700 670 12 
16 1700 670 12 
17 1700 670 14 
18 1700 300 14 
19 1700 300 14 
20 1700 300 19 
21 1700 300 19 
22 2000 200 25 
23 2000 200 28 
24 2000 200 29 
25 0 0 0 
</Segments>
---------------------------