AVS Modules							river bed

NAME
	river bed - constructs the outline of a river bed

SUMMARY
        Name       river bed

        Type       Data Input

        Inputs     None

        Outputs    field 3D scalar real 3-space

        Parameters 	Name 		Type	Default	Min	Max
                        ----            ----    ------- ---     ---
			depth 		int	1	1	100
			length		int	30	1	100
			width		int	7	1	10
			omega		real	2.5	0.0	5.0
			amplitude	real	1.0 	0.0	10.0	
			offset		int	5	0	100

DESCRIPTION

    This module is used to construct the outline of a river
    bed. The length parameter specifies the length of the
    river in grid cells and cooridinates.  The river starts
    at y coordinate 0 and extends downward to y coordinate
    length at y index length.  The river is constructed in the
    xy plane.  Width specifies the width of the river in the
    x direction in grid cells.  Width has nothing to do with
    the shape of the river.  The outline of the river is built
    from a set of sinusoidal line segments of the form 
    A * Sin (wt) + O, where A - Amplitude w - Omega t - Length 
    O - Offset.  The data set that is constructed is filled 
    with 0's initially.  This module subroutine can be conected 
    to the "river fill" coroutine to create a simulation of river
    contaminants.

INPUTS
   None       

PARAMETERS
   depth     - specify how deep the pipe is
   length    - specify how long the pipe is
   width     - specify how wide the pipe is
   omega     - specify the frequency value of the sine 
               function used to construct the outline 
	       of the pipe
   amplitude - specify the amplitude of the sine wave 
               used to construct the outline of the pipe
   offset    - specify an offset that will be added to the  
               value of the sine function used to construct 
	       the outline of the pipe

OUTPUTS
   real 3D scalar field

EXAMPLE 1

+ indicates junction
> or < indicates data passes through

	       
				  	       ---------------------
				  	       |     river bed     |
				  	       --------------------- 
				  			  |
				  			  |
				  	|-----------------+
				   	|		  |
---------------------    ---------------------		  |
| generate colormap |	 |    river fill     |		  |
---------------------    ---------------------		  |
	 |			        |  		  |
	 |			        |  		  |
	 |		  |-------------+  		  |
	 |		  |	        |  		  |
	 |	---------------------	|  		  |
	 |	| orthogonal slicer |	|  		  |
	 |	---------------------	|  		  |
	 |   		  |             |  		  |
	 |    |-----------|          |--+--| 		  |
	 |    |			     |     |		  |
	 +---->----------------|     |     |		  |
	 |    |		       |     |     |		  |
	 |    |		       |     |     |		  |
---------------------    ---------------------    --------------------- 
|  field to mesh    |	 |     isosurface    |    |   volume bounds   |
---------------------	 ---------------------    ---------------------
         |			 |		          |	    
         |			 |		          |	    
         |-----------------------+----------------------- |	    
				 |				    
				 |				    
			 ---------------------
			 | geometry  viewer  |
			 ---------------------


RELATED MODULES
river fill

SEE ALSO