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

Go to the source code of this file.

Classes

struct  Sed_constants

Defines

#define SED_CONST_H
#define PROGRAM_NAME   "sedflux"
#define SED_MAJOR_VERSION_S   "2"
#define SED_MINOR_VERSION_S   "0"
#define SED_MICRO_VERSION_S   "33"
#define SED_VERSION_S   SED_MAJOR_VERSION_S"."SED_MINOR_VERSION_S"."SED_MICRO_VERSION_S
#define S_MAJOR_VERSION   (2)
#define S_MINOR_VERSION   (0)
#define S_MICRO_VERSION   (33)
#define S_CHECK_VERSION(major, minor, micro)
#define S_MPS_PER_KNOT   (.51444)
#define S_SECONDS_PER_HOUR   (3600.)
#define S_SECONDS_PER_DAY   (86400.)
#define S_DAYS_PER_SECOND   (1.157407407407407e-5)
#define S_SECONDS_PER_YEAR   (31536000.)
#define S_DAYS_PER_YEAR   (365.)
#define S_YEARS_PER_DAY   (0.00273972602740)
#define S_RADS_PER_DEGREE   (0.0174532925199433)
#define S_DEGREES_PER_RAD   (57.2957795130823)
#define S_GRAVITY   (9.81)
#define S_RHO_SEA_WATER   (1030.)
#define S_RHO_FRESH_WATER   (1000.)
#define S_RHO_WATER   S_RHO_SEA_WATER
#define S_ETA_WATER   (0.0014e-3)
#define S_MU_WATER   (0.0014)
#define S_SALINITY_SEA   (35)
#define S_GAMMA_WATER   (10000.)
#define S_GAMMA_GRAIN   (26500.)
#define S_VELOCITY_IN_WATER   (1500.)
#define S_VELOCITY_IN_ROCK   (5230.)
#define S_RHO_QUARTZ   (2650.)
#define S_RHO_GRAIN   (S_RHO_QUARTZ)
#define S_RHO_MANTLE   (3300.)
#define SED_INIT_CONSTANTS   { S_GRAVITY , S_RHO_SEA_WATER , S_RHO_FRESH_WATER , S_MU_WATER , S_ETA_WATER , S_SALINITY_SEA , S_RHO_MANTLE }
#define years_to_secs(a)   ( (a)*S_SECONDS_PER_YEAR )
#define secs_to_years(a)   ( (a)/S_SECONDS_PER_YEAR )
#define FRAC(a)   ( (a) - (int)(a) )
#define SWAP(a, b, a_type)   { a_type temp=(a); (a)=(b); (b)=temp; }
#define S_ADDBINS   (512)
#define S_FACIES_NOTHING   (0)
#define S_FACIES_BEDLOAD   (1<<0)
#define S_FACIES_PLUME   (1<<1)
#define S_FACIES_DEBRIS_FLOW   (1<<2)
#define S_FACIES_TURBIDITE   (1<<3)
#define S_FACIES_DIFFUSED   (1<<4)
#define S_FACIES_RIVER   (1<<5)
#define S_FACIES_WAVE   (1<<6)
#define S_FACIES_ALONG_SHORE   (1<<7)
#define S_NORTH_EDGE   ( 1<<0 )
#define S_WEST_EDGE   ( 1<<1 )
#define S_SOUTH_EDGE   ( 1<<2 )
#define S_EAST_EDGE   ( 1<<3 )
#define DEFAULT_SEDIMENT_FILE
#define DEFAULT_HYDRO_INLINE_FILE

Enumerations

enum  Sed_units { UNITS_MKS, UNITS_CGS, UNITS_IMPERIAL }


Define Documentation

#define DEFAULT_HYDRO_INLINE_FILE

Value:

{ \
"Number of grain sizes:                    5                                 ",\
"Event duration:                           .25y                              ",\
"Bedload (kg/s):                           100.0                             ",\
"Suspended load concentrations (kg/m^3):   1.0,      1.0,      1.0,      1.0 ",\
"Velocity (m/s):                           1                                 ",\
"Width (m):                                100.0                             ",\
"Depth (m):                                2.0                               ",\
NULL }

Definition at line 171 of file sed_const.h.

Referenced by sed_hydro_fprint_default_inline_file().

#define DEFAULT_SEDIMENT_FILE

Definition at line 118 of file sed_const.h.

Referenced by sed_sediment_fprint_default().

#define FRAC (  )     ( (a) - (int)(a) )

Definition at line 92 of file sed_const.h.

#define PROGRAM_NAME   "sedflux"

Definition at line 24 of file sed_const.h.

Referenced by sed_property_file_header_fprint(), sed_tripod_header_fprint(), sedflux_get_file_name_interactively(), and sedflux_parse_command_line().

#define S_ADDBINS   (512)

Definition at line 99 of file sed_const.h.

#define S_CHECK_VERSION ( major,
minor,
micro   ) 

Value:

(S_MAJOR_VERSION > (major) || \
     (S_MAJOR_VERSION == (major) && S_MINOR_VERSION > (minor)) || \
     (S_MAJOR_VERSION == (major) && S_MINOR_VERSION == (minor) && \
      S_MICRO_VERSION >= (micro)))

Definition at line 34 of file sed_const.h.

#define S_DAYS_PER_SECOND   (1.157407407407407e-5)

Definition at line 43 of file sed_const.h.

Referenced by compute_c_grain(), inflow(), inflow_flood_from_cell(), inflow_scan_parameter_file(), main(), plume_wrapper(), sakura_erode_depth(), sakura_flood_from_cell(), sakura_scan_parameter_file(), sakura_set_sediment_data(), sakura_set_sediment_data_from_env(), and sed_type_lambda_in_per_seconds().

#define S_DAYS_PER_YEAR   (365.)

Definition at line 45 of file sed_const.h.

Referenced by run_storm(), sed_cube_time_step_in_days(), and sed_hydro_new_from_table().

#define S_DEGREES_PER_RAD   (57.2957795130823)

Definition at line 48 of file sed_const.h.

Referenced by avulsion_full(), avulsion_lite(), and sed_river_angle_to_deg().

#define S_EAST_EDGE   ( 1<<3 )

Definition at line 116 of file sed_const.h.

Referenced by sed_cube_find_shore_edge(), and sed_shift_index_over_edge().

#define S_ETA_WATER   (0.0014e-3)

Definition at line 54 of file sed_const.h.

Referenced by sed_cell_bulk_dynamic_viscosity(), sed_cell_bulk_hydraulic_conductivity(), and sed_type_viscosity().

#define S_FACIES_ALONG_SHORE   (1<<7)

Definition at line 111 of file sed_const.h.

Referenced by fill_to_bruun().

#define S_FACIES_BEDLOAD   (1<<0)

Definition at line 104 of file sed_const.h.

Referenced by fill_to_bruun_profile().

#define S_FACIES_DEBRIS_FLOW   (1<<2)

Definition at line 106 of file sed_const.h.

Referenced by run_debris_flow().

#define S_FACIES_DIFFUSED   (1<<4)

Definition at line 108 of file sed_const.h.

Referenced by diffuse_sediment(), and diffuse_sediment_2().

#define S_FACIES_NOTHING   (0)

Definition at line 103 of file sed_const.h.

Referenced by sed_cell_clear(), and sed_cell_new().

#define S_FACIES_PLUME   (1<<1)

Definition at line 105 of file sed_const.h.

Referenced by run_plume_hypo().

#define S_FACIES_RIVER   (1<<5)

Definition at line 109 of file sed_const.h.

Referenced by diffuse_sediment(), and diffuse_sediment_2().

#define S_FACIES_TURBIDITE   (1<<3)

Definition at line 107 of file sed_const.h.

Referenced by inflow_deposit_sediment(), and sakura_deposit_sediment().

#define S_FACIES_WAVE   (1<<6)

Definition at line 110 of file sed_const.h.

Referenced by move_sediment(), and squall().

#define S_GAMMA_GRAIN   (26500.)

Definition at line 58 of file sed_const.h.

#define S_GAMMA_WATER   (10000.)

Definition at line 57 of file sed_const.h.

Referenced by sed_cell_bulk_cv(), sed_cell_bulk_hydraulic_conductivity(), sed_type_cv(), and sed_type_hydraulic_conductivity().

#define S_GRAVITY   (9.81)

Definition at line 50 of file sed_const.h.

#define S_MAJOR_VERSION   (2)

Definition at line 30 of file sed_const.h.

Referenced by sedflux_get_file_name_interactively(), and sedflux_parse_command_line().

#define S_MICRO_VERSION   (33)

Definition at line 32 of file sed_const.h.

Referenced by sedflux_get_file_name_interactively(), and sedflux_parse_command_line().

#define S_MINOR_VERSION   (0)

Definition at line 31 of file sed_const.h.

Referenced by sedflux_get_file_name_interactively(), and sedflux_parse_command_line().

#define S_MPS_PER_KNOT   (.51444)

Definition at line 40 of file sed_const.h.

Referenced by get_wind_from_beaufort_scale().

#define S_MU_WATER   (0.0014)

Definition at line 55 of file sed_const.h.

Referenced by sed_type_dynamic_viscosity(), and sed_type_hydraulic_conductivity().

#define S_NORTH_EDGE   ( 1<<0 )

Definition at line 113 of file sed_const.h.

Referenced by sed_cube_find_shore_edge(), and sed_shift_index_over_edge().

#define S_RADS_PER_DEGREE   (0.0174532925199433)

Definition at line 47 of file sed_const.h.

Referenced by avulsion_full(), fail_reinit_fail_column(), inflow_set_width_from_cube(), init_failure(), init_inflow(), main(), run_avulsion(), sakura_set_width_from_cube(), and sed_river_fprint().

#define S_RHO_FRESH_WATER   (1000.)

Definition at line 52 of file sed_const.h.

#define S_RHO_GRAIN   (S_RHO_QUARTZ)

Definition at line 62 of file sed_const.h.

#define S_RHO_MANTLE   (3300.)

Definition at line 63 of file sed_const.h.

#define S_RHO_QUARTZ   (2650.)

Definition at line 61 of file sed_const.h.

#define S_RHO_SEA_WATER   (1030.)

Definition at line 51 of file sed_const.h.

#define S_RHO_WATER   S_RHO_SEA_WATER

Definition at line 53 of file sed_const.h.

#define S_SALINITY_SEA   (35)

Definition at line 56 of file sed_const.h.

#define S_SECONDS_PER_DAY   (86400.)

Definition at line 42 of file sed_const.h.

Referenced by bio_run(), diffuse_profile(), get_sediment_flux(), get_time_step(), getTime(), inflow_run_flood(), main(), plume_centerline_inv(), plume_inv(), plume_non_dim_lambda(), plume_wrapper(), run_bedload(), sakura(), sakura_set_sediment_data(), sakura_set_sediment_data_from_env(), sed_hydro_duration_in_seconds(), sed_inflow(), sed_ocean_storm_duration_in_seconds(), sed_sakura(), and update_bruun_zone_data().

#define S_SECONDS_PER_HOUR   (3600.)

Definition at line 41 of file sed_const.h.

#define S_SECONDS_PER_YEAR   (31536000.)

Definition at line 44 of file sed_const.h.

Referenced by bio_run(), get_m(), main(), plume_width_averaged_inv(), run_exponential_flow(), run_river(), run_terzaghi_flow(), and sed_cube_time_step_in_seconds().

#define S_SOUTH_EDGE   ( 1<<2 )

Definition at line 115 of file sed_const.h.

Referenced by sed_cube_find_shore_edge(), and sed_shift_index_over_edge().

#define S_VELOCITY_IN_ROCK   (5230.)

Definition at line 60 of file sed_const.h.

Referenced by sed_type_velocity().

#define S_VELOCITY_IN_WATER   (1500.)

Definition at line 59 of file sed_const.h.

Referenced by sed_type_velocity().

#define S_WEST_EDGE   ( 1<<1 )

Definition at line 114 of file sed_const.h.

Referenced by sed_cube_find_shore_edge(), and sed_shift_index_over_edge().

#define S_YEARS_PER_DAY   (0.00273972602740)

Definition at line 46 of file sed_const.h.

Referenced by run_storm(), and run_xshore().

#define secs_to_years (  )     ( (a)/S_SECONDS_PER_YEAR )

Definition at line 89 of file sed_const.h.

#define SED_CONST_H

Definition at line 22 of file sed_const.h.

#define SED_INIT_CONSTANTS   { S_GRAVITY , S_RHO_SEA_WATER , S_RHO_FRESH_WATER , S_MU_WATER , S_ETA_WATER , S_SALINITY_SEA , S_RHO_MANTLE }

Definition at line 86 of file sed_const.h.

#define SED_MAJOR_VERSION_S   "2"

Definition at line 25 of file sed_const.h.

Referenced by sed_tripod_header_fprint().

#define SED_MICRO_VERSION_S   "33"

Definition at line 27 of file sed_const.h.

Referenced by sed_tripod_header_fprint().

#define SED_MINOR_VERSION_S   "0"

Definition at line 26 of file sed_const.h.

Referenced by sed_tripod_header_fprint().

#define SED_VERSION_S   SED_MAJOR_VERSION_S"."SED_MINOR_VERSION_S"."SED_MICRO_VERSION_S

Definition at line 28 of file sed_const.h.

Referenced by fill_sedflux_info_file(), and sed_property_file_header_fprint().

#define SWAP ( a,
b,
a_type   )     { a_type temp=(a); (a)=(b); (b)=temp; }

Definition at line 95 of file sed_const.h.

#define years_to_secs (  )     ( (a)*S_SECONDS_PER_YEAR )

Definition at line 88 of file sed_const.h.

Referenced by run_darcy_flow().


Enumeration Type Documentation

enum Sed_units

Enumerator:
UNITS_MKS 
UNITS_CGS 
UNITS_IMPERIAL 

Definition at line 65 of file sed_const.h.


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