This is the readme file for the SSIIM program, version 1.0 The program can be downloaded from "ugle.unit.no" from the directory "/pub/os2". WHAT THE PROGRAM DOES (SHORT): The program is made for use in River/Environmental/Hydraulic/ Sedimentation Engineering. SSIIM is an abbreviation for Sediment Simulation In Intakes with Multiblock option. The program solves the Navier-Stokes equations with the k-epsilon model on a three-dimensional almost general non-orthogonal grid. The grid is structured. A control volume method is used for the discretization, together with the power-law scheme. The SIMPLE method is used for the pressure coupling. The convection-diffusion equations for different sediment sizes are also solved. OPERATING SYSTEM: The program is developed and runs only under OS/2 2.x. The program may be ported to UNIX, but not within at least a year, and this version will not be public domain. There are no plans of porting the program to DOS/Windows, as this opterating system is too primitive to run the program in practical situations. HARDWARE REQUIREMENTS: Processor requirement is a 386 with math co-processor or better. The water flow calculations typically takes from some hours to some days to run on a 486. Memory requrements are at least 8 MB RAM. This depends upon the grid size. The program and manual takes under 1 MB space on the harddisk. However, one result file may take several MB. USER INTERFACE: The binary code includes a simple pre and post-processor with 2D graphics. DOCUMENTATION: There is a user's manual which is written in WP5.1 for DOS. This includes references. As most programmers, I find it much more interesting to develop new code than to test it out or make documentation/presentations. This is unfortunately also reflected in this program. I apologize for the corresponding inadequacies. EXAMPLES: Some examples accompany the code. The input files for the program are called "control" and "koordina". The different examples have extensions and need to be renamed/copied to "control" / "koordina" I'm sorry that there are no sediment examples here, but the file in Appendix A in the manual has input for sediment transport. SOME LIMITATIONS: The program can only calculate with non-compressible fluid with density and viscosity of water. Rough boundary conditions are used, and wall laws for smooth boundaries are not included. Non-orthogonal diffusive terms are neglected. The grid lines in the vertical direction have to be completely vertical. Beside from this, the grid is general non-orthogonal. Only non-transient (steady) flow can be calculated. Sediment transport can only be calculated with a single block. DISCLAIMER AND LEGAL MATTERS: I disclaim all warranties with regard to this software and the information in this document, wheter expressed or implied, including without limitation, warranties of fitness and merchantability. In no event shall I or my employer, SINTEF NHL, be liable for any special, indirect or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of this software. This program has known and unknown bugs. It should therefore not be used for mission-critcal or commercial purposes. To understand and interpret the program results properly it is required that the user has knowledge and experience in computational fluid dynamics and hydraulic engineering. The conditions for use is that the user complies with the above statements, and that I under no circumstance will be legally responsible for the use of the program or the results from the program. It is not certain that future versions/upgrades of the program will be public domain. Trondheim 17th of June 1993 Nils Reidar B. Olsen