/Users/huttone/Devel/sedflux-new/sedflux/trunk/ew/inflow/inflow.h File Reference

#include <stdio.h>
#include <glib.h>
#include <sed/sed_sedflux.h>
#include <sed/datadir_path.h>

Go to the source code of this file.

Classes

struct  Inflow_phe_query_st
struct  Inflow_const_st

Defines

#define DATADIR   "/usr/local/share"
#define INFLOW_TEST_PARAM_FILE   DATADIR "/ew/inflow_param.kvf"
#define INFLOW_TEST_BATHY_FILE   DATADIR "/ew/inflow_bathy.csv"
#define INFLOW_TEST_FLOOD_FILE   DATADIR "/ew/inflow_flood.kvf"
#define INFLOW_ERROR   inflow_error_quark()

Typedefs

typedef void(*) Inflow_query_func (Inflow_phe_query_st *data, gpointer user_data)

Enumerations

enum  Inflow_error { INFLOW_ERROR_BAD_PARAMETER }

Functions

gboolean inflow (double day, double x[], double slopeX[], double wX[], int nNodes, double dx, double xDep, double riverWidth, double u0, double h0, double dc, double *gzF, double *grainDia, double *lambda, double *rhoSed, double *rhoGrain, int nGrains, double rho0, double rhoF0, Inflow_const_st *c, double **deposit, double **eroded, FILE *fpout)
Sed_hydro inflow_flood_from_cell (Sed_cell c, double area)
gboolean sed_inflow (Sed_cube p, Sed_hydro f, gint i_start, double dx, Inflow_const_st *c)


Define Documentation

#define DATADIR   "/usr/local/share"

Definition at line 44 of file inflow.h.

#define INFLOW_ERROR   inflow_error_quark()

Definition at line 56 of file inflow.h.

Referenced by inflow_check_params().

#define INFLOW_TEST_BATHY_FILE   DATADIR "/ew/inflow_bathy.csv"

Definition at line 47 of file inflow.h.

Referenced by inflow_scan_bathy_file().

#define INFLOW_TEST_FLOOD_FILE   DATADIR "/ew/inflow_flood.kvf"

Definition at line 48 of file inflow.h.

Referenced by inflow_scan_flood_file().

#define INFLOW_TEST_PARAM_FILE   DATADIR "/ew/inflow_param.kvf"

Definition at line 46 of file inflow.h.

Referenced by inflow_scan_parameter_file().


Typedef Documentation

typedef void(*) Inflow_query_func(Inflow_phe_query_st *data, gpointer user_data)

Definition at line 67 of file inflow.h.


Enumeration Type Documentation

enum Inflow_error

Enumerator:
INFLOW_ERROR_BAD_PARAMETER 

Definition at line 50 of file inflow.h.


Function Documentation

gboolean inflow ( double  day,
double  x[],
double  slope[],
double  width[],
int  n_nodes,
double  dx,
double  x_dep,
double  river_width,
double  river_vel,
double  river_depth,
double  dc,
double *  gzF0,
double *  grain_dia,
double *  lambda,
double *  rho_sed,
double *  rho_grain,
int  n_grains,
double  rho_rw,
double  rho_flow,
Inflow_const_st c,
double **  deposited,
double **  eroded,
FILE *  fpout 
)

inflow turbidity current model.

A steady state turbidity current model based on the Mulder model.

Mulder, T., Savoye, B., and Syvitski, J.P.M., 1997. Numerical modelling of a mid-sized gravity flow: the 1979 Nice turbidity current (dynamics, processes, sediment budget and seafloor impact). Sedimentology, v. 44, pp. 305-326.

Parameters:
day duration of the flow (s). Typically this is one day.
x x coordinate of each node (m).
slope sea-floor slope (rads). a negative slope means downward dipping.
width width of the channel (m).
n_nodes number of nodes in the domain.
dx distance between nodes (m).
x_dep distance (m) from the river mouth before which no deposition is allowed.
river_width width of the river mouth (m).
river_vel velocity of the river at the river mouth (m/s).
river_depth depth of the river at the river mouth (m).
dc water discharge at the river mouth (m^3/s).
gzF0 fraction of each grain type in the flow.
grain_dia grain diameter of each grain type in the flow (m).
lambda removal rate for each grain type (1/s).
rho_sed bulk density of each grain type (kg/m^3).
rho_grain grain density of each grain type (kg/m^3).
n_grains number of grain types.
rho_rw density of the river water (kg/m^3). This is the river water without any sediment.
rho_flow density of the flow (kg/m^3). This is the river water plus the sediment.
c some constants that are required by the turbidity current model.
deposited 2d array for storing the deposition rates for each node. The fast dimension is over grid node number and the slow dimension is over grain type.
eroded 2d array for storing the erosion rates for each node. The fast dimension is over grid node number and the slow dimension is over grain type.
fpout The output file
Returns:
TRUE on success and FALSE if a problem is found.

Definition at line 75 of file inflow.c.

References Inflow_const_st::c_drag, Inflow_phe_query_st::dx, Inflow_const_st::e_a, Inflow_const_st::e_b, eh_dbl_array_mean_weighted(), eh_free, eh_free_2, eh_new, eh_new_2, Inflow_phe_query_st::erode_depth, Inflow_const_st::get_phe, Inflow_const_st::get_phe_data, Inflow_const_st::mu_water, Inflow_phe_query_st::phe, Inflow_const_st::rho_sea_water, S_DAYS_PER_SECOND, sed_gravity(), Inflow_const_st::sua, Inflow_const_st::sub, Inflow_const_st::tan_phi, and Inflow_phe_query_st::x.

Referenced by inflow_wrapper(), sakura(), and sakura_array_set_bc().

Sed_hydro inflow_flood_from_cell ( Sed_cell  c,
double  area 
)

Definition at line 212 of file inflow_sedflux_interface.c.

References eh_dbl_array_mult(), eh_free, eh_require, INFLOW_GRAIN_DENSITY, INFLOW_INITIAL_CONCENTRATION, INFLOW_INITIAL_HEIGHT, INFLOW_INITIAL_VELOCITY, INFLOW_INITIAL_WIDTH, S_DAYS_PER_SECOND, sed_cell_copy_fraction(), sed_cell_density(), sed_cell_n_types(), sed_cell_size_0(), sed_hydro_check(), sed_hydro_new(), sed_hydro_set_bedload(), sed_hydro_set_depth(), sed_hydro_set_duration(), sed_hydro_set_nth_concentration(), sed_hydro_set_velocity(), sed_hydro_set_width(), sed_hydro_size(), and sed_hydro_suspended_flux().

Referenced by run_turbidity_inflow().

gboolean sed_inflow ( Sed_cube  p,
Sed_hydro  f,
gint  i_start,
double  dx,
Inflow_const_st c 
)

Definition at line 37 of file inflow_sedflux_interface.c.

References Inflow_flood_st::duration, eh_free_2, eh_new_2, eh_require, Inflow_const_st::get_phe, Inflow_const_st::get_phe_data, inflow_deposit_sediment(), inflow_destroy_bathy_data(), inflow_destroy_flood_data(), inflow_erode_sediment(), inflow_set_bathy_data_from_cube(), inflow_set_flood_data(), inflow_set_sediment_data_from_env(), inflow_set_width_from_cube(), inflow_wrapper(), Inflow_bathy_st::len, Inflow_sediment_st::n_grains, Inflow_const_st::rho_river_water, S_SECONDS_PER_DAY, sed_get_phe(), and sed_hydro_duration().

Referenced by run_plume_hyper_inflow(), and run_turbidity_inflow().


Generated on Fri Jan 4 18:04:17 2008 for sedflux by  doxygen 1.5.2