/Users/huttone/Devel/sedflux-new/sedflux/trunk/ew/sedflux/run_avulsion.c File Reference

#include <stdio.h>
#include <math.h>
#include <utils/utils.h>
#include <sed/sed_sedflux.h>
#include <avulsion.h>
#include "my_processes.h"
#include "sedflux.h"

Go to the source code of this file.

Defines

#define SED_AVULSION_PROC_NAME   "avulsion"
#define EH_LOG_DOMAIN   SED_AVULSION_PROC_NAME
Input paramaters for avulsion module.
#define AVULSION_KEY_STDDEV   "standard deviation"
 Standard deviation of angle change of river mouth with hinge point.
#define AVULSION_KEY_MIN_ANGLE   "minimum angle"
 Minumum angle that the river mouth can make with the hinge point.
#define AVULSION_KEY_MAX_ANGLE   "maximum angle"
 Maximum angle that the river mouth can make with the hinge point.
#define AVULSION_KEY_RIVER_NAME   "river name"
 The name of the river that this avulsion process is associated with.
#define AVULSION_KEY_HINGE_POINT   "hinge point"
 The (x,y) location of the hinge point.
#define AVULSION_KEY_FRACTION   "fraction of sediment remaining in plane"
#define AVULSION_KEY_BRANCHING   "river can branch?"
 If yes, the river is allowed to bifurcate.
#define AVULSION_KEY_SEED   "seed for random number generator"
 Seed for the avulsion random number generator.

Functions

gboolean init_avulsion_data (Sed_process p, Sed_cube prof)
Sed_process_info run_avulsion (Sed_process p, Sed_cube prof)
gboolean init_avulsion (Sed_process p, Eh_symbol_table tab, GError **error)
gboolean destroy_avulsion (Sed_process p)


Define Documentation

#define AVULSION_KEY_BRANCHING   "river can branch?"

If yes, the river is allowed to bifurcate.

Definition at line 137 of file run_avulsion.c.

Referenced by init_avulsion().

#define AVULSION_KEY_FRACTION   "fraction of sediment remaining in plane"

Fraction of total sediment to be placed within this profile (2D-sedflux only)

Definition at line 135 of file run_avulsion.c.

Referenced by init_avulsion().

#define AVULSION_KEY_HINGE_POINT   "hinge point"

The (x,y) location of the hinge point.

Definition at line 132 of file run_avulsion.c.

Referenced by init_avulsion().

#define AVULSION_KEY_MAX_ANGLE   "maximum angle"

Maximum angle that the river mouth can make with the hinge point.

Definition at line 128 of file run_avulsion.c.

Referenced by init_avulsion().

#define AVULSION_KEY_MIN_ANGLE   "minimum angle"

Minumum angle that the river mouth can make with the hinge point.

Definition at line 126 of file run_avulsion.c.

Referenced by init_avulsion().

#define AVULSION_KEY_RIVER_NAME   "river name"

The name of the river that this avulsion process is associated with.

Definition at line 130 of file run_avulsion.c.

Referenced by init_avulsion().

#define AVULSION_KEY_SEED   "seed for random number generator"

Seed for the avulsion random number generator.

Definition at line 139 of file run_avulsion.c.

Referenced by init_avulsion().

#define AVULSION_KEY_STDDEV   "standard deviation"

Standard deviation of angle change of river mouth with hinge point.

Definition at line 124 of file run_avulsion.c.

Referenced by init_avulsion().

#define EH_LOG_DOMAIN   SED_AVULSION_PROC_NAME

Definition at line 22 of file run_avulsion.c.

#define SED_AVULSION_PROC_NAME   "avulsion"

Definition at line 21 of file run_avulsion.c.


Function Documentation

gboolean destroy_avulsion ( Sed_process  p  ) 

Definition at line 240 of file run_avulsion.c.

References eh_free, eh_input_val_destroy(), Avulsion_t::f_remain, Avulsion_t::max_angle, Avulsion_t::min_angle, Avulsion_t::rand, Avulsion_t::river_name, sed_process_user_data(), and Avulsion_t::std_dev.

gboolean init_avulsion ( Sed_process  p,
Eh_symbol_table  tab,
GError **  error 
)

Definition at line 160 of file run_avulsion.c.

References AVULSION_KEY_BRANCHING, AVULSION_KEY_FRACTION, AVULSION_KEY_HINGE_POINT, AVULSION_KEY_MAX_ANGLE, AVULSION_KEY_MIN_ANGLE, AVULSION_KEY_RIVER_NAME, AVULSION_KEY_SEED, AVULSION_KEY_STDDEV, Avulsion_t::branching_is_on, eh_check_to_s(), eh_return_val_if_fail, eh_set_error_strv(), eh_symbol_table_bool_value(), eh_symbol_table_input_value(), eh_symbol_table_int_value(), eh_symbol_table_lookup(), eh_symbol_table_require_labels(), eh_symbol_table_value(), Avulsion_t::f_remain, Avulsion_t::hinge_i, Avulsion_t::hinge_j, Avulsion_t::max_angle, Avulsion_t::min_angle, Avulsion_t::rand, Avulsion_t::rand_seed, Avulsion_t::reset_angle, Avulsion_t::river_name, sed_mode_is_3d(), sed_process_new_user_data, SEDFLUX_ERROR, SEDFLUX_ERROR_BAD_PARAM, and Avulsion_t::std_dev.

gboolean init_avulsion_data ( Sed_process  p,
Sed_cube  prof 
)

Definition at line 220 of file run_avulsion.c.

References avulsion_new(), Avulsion_t::rand, Avulsion_t::rand_seed, Avulsion_t::reset_angle, Avulsion_t::river_name, sed_cube_river_by_name(), sed_process_user_data(), and sed_river_set_avulsion_data().

Referenced by run_avulsion().

Sed_process_info run_avulsion ( Sed_process  p,
Sed_cube  prof 
)

Definition at line 36 of file run_avulsion.c.

References Avulsion_t::branching_is_on, eh_input_val_eval(), eh_isnan(), eh_require, eh_require_not_reached, Avulsion_t::f_remain, Avulsion_t::hinge_i, Avulsion_t::hinge_j, init_avulsion_data(), Avulsion_t::max_angle, Avulsion_t::min_angle, Avulsion_t::rand, Avulsion_st::rand, Avulsion_t::reset_angle, Avulsion_t::river_name, S_RADS_PER_DEGREE, sed_cube_age_in_years(), sed_cube_area_above(), sed_cube_avulse_river(), sed_cube_n_branches(), sed_cube_river_by_name(), sed_cube_sea_level(), sed_cube_split_river(), SED_EMPTY_INFO, sed_mode_is_2d(), sed_process_run_count(), sed_process_user_data(), sed_river_adjust_mass(), sed_river_avulsion_data(), sed_river_impart_avulsion_data(), sed_river_name_loc(), sed_river_set_angle(), sed_river_set_angle_limit(), sed_river_set_hinge(), Avulsion_st::std_dev, and Avulsion_t::std_dev.


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