Classes | |
class | Sed_cell |
Describe a unit of sediment. More... | |
Functions | |
Sed_cell | sed_cell_new (gssize n_grains) |
Create a new cell of sediment. | |
Sed_cell | sed_cell_new_env (void) |
Sed_cell | sed_cell_new_sized (gssize n, double t, double *f) |
Sed_cell | sed_cell_new_typed (Sed_sediment s, double t, Sed_type a_type) |
Sed_cell | sed_cell_new_classed (Sed_sediment s, double t, Sed_size_class class) |
Sed_cell | sed_cell_new_bedload (Sed_sediment s, double t) |
Sed_cell | sed_cell_dup (Sed_cell c) |
Sed_cell * | sed_cell_list_new (gssize len, gssize n) |
Create a Cell_list. | |
Sed_cell * | sed_cell_list_destroy (Sed_cell *c_list) |
Destroy a Cell_list Free resources used for a Cell_list. | |
Sed_cell | sed_cell_destroy (Sed_cell c) |
gssize | sed_cell_fprint (FILE *fp, const Sed_cell c) |
Sed_cell | sed_cell_clear (Sed_cell c) |
Sed_cell * | sed_cell_clear_vector (Sed_cell *vec, int low, int high) |
Sed_cell | sed_cell_copy (Sed_cell dest, const Sed_cell src) |
Sed_cell | sed_cell_set_age (Sed_cell c, double age) |
Sed_cell | sed_cell_set_thickness (Sed_cell c, double t) |
Sed_cell | sed_cell_set_pressure (Sed_cell c, double p) |
Sed_cell | sed_cell_set_facies (Sed_cell c, Sed_facies f) |
Sed_cell | sed_cell_add_facies (Sed_cell c, Sed_facies f) |
Sed_cell | sed_cell_set_fraction (Sed_cell c, double f[]) |
Sed_cell | sed_cell_set_equal_fraction (Sed_cell c) |
Sed_cell | sed_cell_add (Sed_cell a, const Sed_cell b) |
gboolean | sed_cell_is_empty (Sed_cell c) |
gboolean | sed_cell_is_clear (Sed_cell c) |
gboolean | sed_cell_is_size (Sed_cell c, double t) |
gboolean | sed_cell_is_age (Sed_cell c, double a) |
gboolean | sed_cell_is_mass (Sed_cell c, double m) |
gboolean | sed_cell_is_size_class (Sed_cell c, Sed_size_class size) |
gboolean | sed_cell_is_compatible (Sed_cell a, Sed_cell b) |
Sed_cell | sed_cell_separate_amount (Sed_cell in, double t[], Sed_cell out) |
Sed_cell | sed_cell_separate_thickness (Sed_cell in, double t, Sed_cell out) |
Sed_cell | sed_cell_separate_fraction (Sed_cell in, double f[], Sed_cell out) |
Sed_cell | sed_cell_set_amount (Sed_cell c, const double *t) |
Sed_cell | sed_cell_add_amount (Sed_cell a, const double t[]) |
Add a vector of amounts of sediment to a cell. | |
Sed_cell | sed_cell_separate_cell (Sed_cell in, Sed_cell out) |
Sed_cell | sed_cell_separate (Sed_cell in, double f[], double t, Sed_cell out) |
void | sed_cell_move_thickness (Sed_cell src, Sed_cell dest, double t) |
Move sediment from one cell into another. | |
void | sed_cell_move_fraction (Sed_cell src, Sed_cell dest, double f[]) |
void | sed_cell_move (Sed_cell src, Sed_cell dest, double f[], double t) |
double | sed_cell_density_0 (const Sed_cell c) |
Get the density of a Sed_cell . | |
double | sed_cell_grain_density (const Sed_cell c) |
Get the density of a sediment type in a Sed_cell . | |
double | sed_cell_max_density (const Sed_cell c) |
Get the closest packed density of a sediment type in a Sed_cell . | |
double | sed_cell_grain_size (const Sed_cell c) |
Get the mean grain size of a sediment type in a Sed_cell. | |
double | sed_cell_grain_size_in_phi (const Sed_cell c) |
Get the mean grain size (in phi units) of a sediment type in a Sed_cell. | |
double | sed_cell_sand_fraction (const Sed_cell c) |
double | sed_cell_silt_fraction (const Sed_cell c) |
double | sed_cell_clay_fraction (const Sed_cell c) |
double | sed_cell_mud_fraction (const Sed_cell c) |
double | sed_cell_nth_fraction (const Sed_cell c, gssize n) |
double | sed_cell_nth_amount (const Sed_cell c, gssize n) |
double * | sed_cell_fraction_ptr (const Sed_cell c) |
double * | sed_cell_copy_fraction (double *f, const Sed_cell c) |
double | sed_cell_c_consolidation (const Sed_cell c) |
Get the coefficient of consolidation for a sediment type in a cell. | |
double | sed_cell_velocity (const Sed_cell c) |
Get the velocity of water of a sediment type in a Sed_cell. | |
double | sed_cell_viscosity (const Sed_cell c) |
Get the viscosity of a sediment type in a Sed_cell. | |
double | sed_cell_relative_density (const Sed_cell c) |
Get the relative density of a sediment type in a Sed_cell. | |
double | sed_cell_porosity (const Sed_cell c) |
Get the porosity of a sediment type in a Sed_cell. | |
double | sed_cell_porosity_max (const Sed_cell c) |
Get the maximum porosity of a sediment type in a Sed_cell. | |
double | sed_cell_porosity_min (const Sed_cell c) |
Get the minimum porosity of a sediment type in a Sed_cell. | |
double | sed_cell_plastic_index (const Sed_cell c) |
Get the plastic index of a sediment type in a Sed_cell. | |
double | sed_cell_permeability (const Sed_cell c) |
Get the permeability of a sediment type in a Sed_cell. | |
double | sed_cell_hydraulic_conductivity (const Sed_cell c) |
Get the hydraulic conductivity of a sediment type in a Sed_cell. | |
double | sed_cell_bulk_permeability (const Sed_cell c) |
Get the permeability of a Sed_cell. | |
double | sed_cell_bulk_log_permeability (const Sed_cell c) |
double | sed_cell_bulk_hydraulic_conductivity (const Sed_cell c) |
double | sed_cell_void_ratio (const Sed_cell c) |
Get the void ratio of a sediment type in a Sed_cell. | |
double | sed_cell_void_ratio_min (const Sed_cell c) |
Get the minimum void ratio of a sediment type in a Sed_cell. | |
double | sed_cell_void_ratio_max (const Sed_cell c) |
Get the maximum void ratio of a sediment type in a Sed_cell. | |
double | sed_cell_friction_angle (const Sed_cell c) |
Get the Coulomb friction angle of a sediment type in a Sed_cell. | |
double | sed_cell_cc (const Sed_cell c) |
double | sed_cell_compressibility (const Sed_cell c) |
double | sed_cell_yield_strength (const Sed_cell c) |
Get the yield strength of a sediment type in a Sed_cell. | |
double | sed_cell_bulk_yield_strength (const Sed_cell c) |
Get the bulk yield strength of a Sed_cell. | |
double | sed_cell_dynamic_viscosity (const Sed_cell c) |
Get the dynamic viscosity of a sediment type in a Sed_cell . | |
double | sed_cell_bulk_dynamic_viscosity (const Sed_cell c) |
Get the bulk dynamic viscosity of a Sed_cell . | |
double | sed_cell_relative_pressure (const Sed_cell c, double load) |
Sed_size_class | sed_cell_size_class (const Sed_cell c) |
Get the Wentworth size class for a Sed_cell . | |
double | sed_cell_size_class_percent (const Sed_cell c, Sed_size_class size) |
Return the percentage of a certain size class with a Sed_cell. | |
Sed_size_class | sed_cell_size_classes (const Sed_cell c) |
double | sed_cell_density (const Sed_cell c) |
double | sed_cell_sediment_volume (const Sed_cell c) |
double | sed_cell_sediment_mass (const Sed_cell c) |
double | sed_cell_mv (const Sed_cell c) |
double | sed_cell_cv (const Sed_cell c) |
double | sed_cell_bulk_cv (const Sed_cell c) |
double | sed_cell_shear_strength (const Sed_cell c, double load) |
Get the shear strength of a sediment type in a Sed_cell . | |
double | sed_cell_cohesion (const Sed_cell c, double load) |
Get the cohesion of a sediment type in a Sed_cell . | |
double | sed_cell_consolidation (const Sed_cell c, double time_now) |
Get the degree of consolidation of a sediment type in a Sed_cell . | |
double | sed_cell_consolidation_rate (const Sed_cell c, double time_now) |
double | sed_cell_thickness (const Sed_cell c) |
double | sed_cell_size (const Sed_cell c) |
double | sed_cell_size_0 (const Sed_cell c) |
double | sed_cell_fraction (const Sed_cell c, gssize n) |
double | sed_cell_pressure (const Sed_cell c) |
double | sed_cell_excess_pressure (const Sed_cell c, double hydro_static) |
double | sed_cell_age (const Sed_cell c) |
gssize | sed_cell_n_types (const Sed_cell c) |
double | sed_cell_age_in_years (const Sed_cell c) |
Sed_facies | sed_cell_facies (const Sed_cell c) |
double | sed_cell_mass (const Sed_cell c) |
double | sed_cell_load (const Sed_cell c) |
double | sed_cell_sediment_load (const Sed_cell c) |
gssize | sed_cell_write (FILE *fp, const Sed_cell c) |
Write the contents of a Sed_cell to a binary file. | |
gssize | sed_cell_write_to_byte_order (FILE *fp, const Sed_cell c, int order) |
Sed_cell | sed_cell_read (FILE *fp) |
Read the contents of a Sed_cell from a binary file. | |
Sed_cell | sed_cell_resize (Sed_cell c, double t) |
Change the size of a cell. | |
Sed_cell | sed_cell_compact (Sed_cell c, double new_t) |
Compact a cell of sediment. | |
Sed_cell_grid | sed_cell_grid_new (gsize n_x, gsize n_y) |
Create a two-dimensional array of Sed_cell's. | |
Sed_cell_grid | sed_cell_grid_new_env (gsize n_x, gsize n_y) |
Sed_cell_grid | sed_cell_grid_init (Sed_cell_grid g, gssize n_grains) |
Initalize a two-dimensional array of Sed_cell's. | |
void | sed_cell_grid_free (Sed_cell_grid g) |
Free the resources used for each element of a Sed_cell_grid. | |
Sed_cell_grid | sed_cell_grid_destroy (Sed_cell_grid g) |
void | sed_cell_grid_free_data (Sed_cell_grid g) |
Sed_cell | sed_cell_grid_val (Sed_cell_grid g, gssize i, gssize j) |
Sed_cell_grid | sed_cell_grid_add (Sed_cell_grid g_1, Sed_cell_grid g_2) |
Sed_cell_grid | sed_cell_grid_copy_data (Sed_cell_grid dest, Sed_cell_grid src) |
Sed_cell_grid | sed_cell_grid_clear (Sed_cell_grid g) |
double | sed_cell_grid_mass (Sed_cell_grid g) |
Sed_cell ** | sed_cell_grid_data (Sed_cell_grid g) |
gboolean | sed_cell_is_same (Sed_cell a, Sed_cell b) |
gboolean | sed_cell_is_valid (Sed_cell c) |
Sed_cell * | sed_cell_array_free (Sed_cell *a) |
double | sed_cell_array_mass (Sed_cell *a) |
gint | sed_cell_array_fprint (FILE *fp, Sed_cell *a) |
Sed_cell * | sed_cell_array_delete_empty (Sed_cell *a) |
Add one Sed_cell to another.
Add the Sed_cell b to a. Both a and b must contain the same number of sediment types, n. The Sed_cell a will contain the total amount of sediment while b remains unchanged. The new age (pressure) of a will be a weighted average of the ages (pressures) of a and b based on their relative amounts. The new facies will be a combination of the facies of the two cells. That is, the new facies of a will include both the facies of a and b.
[out] | a | The destination cell. |
[in] | b | The source cell. |
Definition at line 581 of file sed_cell.c.
References eh_require, eh_require_critical, sed_cell_is_compatible(), sed_cell_is_empty(), sed_cell_is_valid(), and sed_cell_n_types().
Referenced by bio_array_to_cell_array(), decider(), deposit_in_ocean(), diffuse_profile(), diffuse_sediment(), diffuse_sediment_2(), erode_profile(), fill_to_bruun_profile(), move_sediment(), run_debris_flow(), sed_cell_add_column(), sed_cell_grid_add(), sed_cell_move(), sed_cell_move_fraction(), sed_cell_move_thickness(), sed_column_add_cell_real(), sed_column_extract_top_fill(), sed_column_top(), sed_cube_to_cell(), squall(), and xshore().
Add a vector of amounts of sediment to a cell.
Add a vector that gives the amounts of each sediment type to a Sed_cell. The length of the vector, t, must match the number of sediment types in the Sed_cell c. We assume that the sediment being added is uncompacted and so,
thickness == uncompacted_thickness
for the new sediment.
a | The Sed_cell to add the sediment to. | |
t | A vector giving the amount of each grain type to add to, c. |
Definition at line 920 of file sed_cell.c.
References eh_dbl_array_sum(), eh_return_val_if_fail, and sed_cell_n_types().
Referenced by inflow_deposit_sediment(), main(), plume_centerline_deposit(), plume_width_averaged_deposit(), plume_width_averaged_deposit_num(), run_plume_hypo(), sakura_deposit_sediment(), sed_column_add_vec(), and squall().
Sed_cell sed_cell_add_facies | ( | Sed_cell | c, | |
Sed_facies | f | |||
) |
double sed_cell_age | ( | const Sed_cell | c | ) |
Get the age of a Sed_cell .
c | The Sed_cell to query. |
Definition at line 1913 of file sed_cell.c.
References eh_require.
Referenced by get_m(), run_debris_flow(), run_exponential_flow(), run_terzaghi_flow(), sed_cell_is_age(), sed_cell_is_same(), sed_column_depth_age(), sed_column_top_age(), and sed_measure_cube_age().
double sed_cell_age_in_years | ( | const Sed_cell | c | ) |
Get the age of a Sed_cell in years.
c | The Sed_cell to query. |
Definition at line 1930 of file sed_cell.c.
References eh_require.
Referenced by sed_cell_consolidation(), and sed_cell_consolidation_rate().
Definition at line 2453 of file sed_cell.c.
References eh_free, sed_cell_destroy(), sed_cell_is_clear(), and sed_cell_is_empty().
Referenced by bio_array_to_cell_array().
gint sed_cell_array_fprint | ( | FILE * | fp, | |
Sed_cell * | a | |||
) |
Definition at line 2438 of file sed_cell.c.
References sed_cell_fprint().
Referenced by sed_column_stack_cells().
Definition at line 2412 of file sed_cell.c.
References eh_free, and sed_cell_destroy().
Referenced by sed_column_bioturbate().
double sed_cell_array_mass | ( | Sed_cell * | a | ) |
Definition at line 2424 of file sed_cell.c.
References sed_cell_mass().
Referenced by bio_array_to_cell_array().
double sed_cell_bulk_cv | ( | const Sed_cell | c | ) |
Definition at line 1719 of file sed_cell.c.
References S_GAMMA_WATER, sed_cell_bulk_hydraulic_conductivity(), and sed_cell_mv().
double sed_cell_bulk_dynamic_viscosity | ( | const Sed_cell | c | ) |
Get the bulk dynamic viscosity of a Sed_cell .
c | The cell to measure. |
Definition at line 1569 of file sed_cell.c.
References S_ETA_WATER, sed_cell_porosity(), and sed_cell_sand_fraction().
Referenced by run_debris_flow().
double sed_cell_bulk_hydraulic_conductivity | ( | const Sed_cell | c | ) |
Definition at line 1416 of file sed_cell.c.
References S_ETA_WATER, S_GAMMA_WATER, and sed_cell_bulk_permeability().
Referenced by sed_cell_bulk_cv().
double sed_cell_bulk_log_permeability | ( | const Sed_cell | c | ) |
double sed_cell_bulk_permeability | ( | const Sed_cell | c | ) |
Get the permeability of a Sed_cell.
c | The cell to measure. |
Definition at line 1397 of file sed_cell.c.
References SED_CELL_CONST_S_F, sed_cell_void_ratio(), sed_sediment_property_avg(), and sed_type_inv_grain_size_in_meters().
Referenced by sed_cell_bulk_hydraulic_conductivity(), and sed_cell_bulk_log_permeability().
double sed_cell_bulk_yield_strength | ( | const Sed_cell | c | ) |
Get the bulk yield strength of a Sed_cell.
c | The cell to measure. |
Definition at line 1519 of file sed_cell.c.
References sed_cell_clay_fraction(), sed_cell_porosity(), sed_cell_sand_fraction(), and sed_cell_silt_fraction().
Referenced by run_debris_flow().
double sed_cell_c_consolidation | ( | const Sed_cell | c | ) |
Get the coefficient of consolidation for a sediment type in a cell.
c | The cell to measure. |
Definition at line 1255 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_c_consolidation().
double sed_cell_cc | ( | const Sed_cell | c | ) |
Definition at line 1481 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_c_consolidation().
Referenced by run_exponential_flow().
double sed_cell_clay_fraction | ( | const Sed_cell | c | ) |
Definition at line 1195 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_is_clay().
Referenced by decider(), and sed_cell_bulk_yield_strength().
Remove the sediment from a cell.
Remove all of the sediment from a cell. This clears the Sed_cell so that it looks just like a newly allocated cell created by sed_create_cell.
c | A pointer to the cell to clear. |
Definition at line 374 of file sed_cell.c.
References eh_require, S_FACIES_NOTHING, and sed_cell_n_types().
Referenced by diffuse_sediment(), diffuse_sediment_2(), inflow_deposit_sediment(), run_plume_hypo(), run_river(), sakura_deposit_sediment(), sed_cell_clear_vector(), sed_cell_grid_clear(), sed_cell_resize(), sed_cell_set_amount(), sed_column_clear(), sed_column_extract_top_fill(), sed_column_remove_top_cell(), sed_column_resize(), sed_column_top(), and sed_cube_to_cell().
Clear each of the cells of sediment in an array of Sed_cells.
Clear each of the cell of sediment in an (NULL terminated) array of Sed_cells. The function sed_clear_cell is called for for each element of the array.
vec | The NULL terminated array of Sed_cell s. | |
low | The index into vec to start clearing from. | |
high | The index into vec to stop clearing at. |
Definition at line 406 of file sed_cell.c.
References sed_cell_clear().
double sed_cell_cohesion | ( | const Sed_cell | c, | |
double | load | |||
) |
Get the cohesion of a sediment type in a Sed_cell .
c | The cell to measure. | |
load | The load on the cell. |
Definition at line 1746 of file sed_cell.c.
References eh_lower_bound, sed_sediment_property_avg_with_data(), and sed_type_cohesion_with_data().
Compact a cell of sediment.
Compact a Sed_cell.
Definition at line 2137 of file sed_cell.c.
References eh_lower_bound, and eh_require.
Referenced by sed_column_compact_cell().
double sed_cell_compressibility | ( | const Sed_cell | c | ) |
Definition at line 1487 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_compressibility().
Referenced by run_darcy_flow().
double sed_cell_consolidation | ( | const Sed_cell | c, | |
double | time_now | |||
) |
Get the degree of consolidation of a sediment type in a Sed_cell .
this is taken from bardet, experimental soil mechanics, p. 312. get the degree of consolidation for a cell of sediment. the excess porewater pressure, u_e is related to the degree of consolidation as, u_e = s ( 1 - u ) where s is the load on the cell.
c | The cell to measure. | |
time_now | The current time. |
Definition at line 1770 of file sed_cell.c.
References sed_cell_age_in_years(), sed_cell_size(), sed_sediment_property_avg_with_data(), and sed_type_consolidation_with_data().
double sed_cell_consolidation_rate | ( | const Sed_cell | c, | |
double | time_now | |||
) |
Definition at line 1820 of file sed_cell.c.
References sed_cell_age_in_years(), sed_cell_size(), sed_sediment_property_avg_with_data(), and sed_type_consolidation_rate_with_data().
Copy a Sed_cell.
Copy the Sed_cell src to dest. The pointers of sediment type fractions are not copied, only their elements. Thus, the number of sediment types allocated for by each Sed_cell must be the same (ie the parameter n in sed_create_cell ).
dest | A pointer to the destination Sed_cell . | |
src | A pointer to the Sed_cell to be copied. |
Definition at line 429 of file sed_cell.c.
References eh_require, sed_cell_is_compatible(), sed_cell_n_types(), and sed_cell_new().
Referenced by construct_deposit_array_3(), diffuse_sediment(), diffuse_sediment_2(), main(), move_sediment(), sed_cell_dup(), sed_cell_grid_copy_data(), sed_cell_separate(), sed_cell_separate_amount(), sed_cell_separate_fraction(), sed_cell_separate_thickness(), sed_column_add_cell_real(), sed_column_copy(), sed_column_extract_top_cell(), and sed_column_stack_cell_real().
double* sed_cell_copy_fraction | ( | double * | f, | |
const Sed_cell | c | |||
) |
Copy the fraction infrormation of a Sed_cell
Copy the fraction of each grain type held in a Sed_cell. If the input pointer is NULL, a newly created array is allocated.
f | A pointer to the location to copy data (or NULL) | |
c | A Sed_cell |
Definition at line 1235 of file sed_cell.c.
References eh_new, eh_require, and sed_cell_n_types().
Referenced by inflow_flood_from_cell(), sakura_flood_from_cell(), and sakura_sed_get_phe().
double sed_cell_cv | ( | const Sed_cell | c | ) |
Definition at line 1713 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_cv().
Referenced by run_terzaghi_flow().
double sed_cell_density | ( | const Sed_cell | c | ) |
Definition at line 1660 of file sed_cell.c.
References sed_sediment_property_avg_with_data(), and sed_type_density_compacted().
Referenced by inflow_flood_from_cell(), run_debris_flow(), sakura_flood_from_cell(), sed_cell_mass(), sed_column_top_rho(), and sed_measure_cube_density().
double sed_cell_density_0 | ( | const Sed_cell | c | ) |
Get the density of a Sed_cell .
c | The cell to measure. |
Definition at line 1116 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_density_0().
Destroy a Sed_cell.
Frees the memory used by a Sed_cell. The pointer to the Sed_cell itself is also freed.
c | A pointer to the Sed_cell to be freed. |
Definition at line 321 of file sed_cell.c.
References eh_free.
Referenced by _scan_sediment_column(), add_sediment_from_external_source(), construct_deposit_array_3(), decider(), deposit_in_ocean(), deposit_in_river(), deposit_sediment_helper(), diffuse_cols(), diffuse_profile(), diffuse_sediment(), diffuse_sediment_2(), erode_profile(), inflow_deposit_sediment(), main(), move_sediment(), muddy(), rain_sediment_3(), run_debris_flow(), run_diffusion(), run_erosion(), run_turbidity_inflow(), run_turbidity_sakura(), run_xshore(), sakura_deposit_sediment(), sakura_sed_get_phe(), sakura_sed_remove_sediment(), sed_cell_array_delete_empty(), sed_cell_array_free(), sed_cell_grid_free(), sed_cell_grid_free_data(), sed_cell_list_destroy(), sed_cell_move(), sed_cell_move_fraction(), sed_cell_move_thickness(), sed_cell_separate_cell(), sed_column_add_cell_real(), sed_column_add_vec(), sed_column_destroy(), sed_column_extract_cells_above(), sed_column_extract_top_fill(), sed_column_new_filled(), sed_column_separate_top(), sed_column_separate_top_amounts(), sed_column_separate_top_amounts_fill(), sed_column_stack_cell_loc_real(), sed_column_top_age(), sed_column_top_property(), sed_column_top_property_0(), sed_column_top_rho(), sed_cube_free(), sed_cube_to_cell(), sed_get_phe(), squall(), test_2d(), and xshore().
The copy constructor for a Sed_cell.
Duplicates the contents of a Sed_cell, returning a newly allocated cell or NULL if an error occured. The return value should be freed when no longer in needed.
c | A Sed_cell to duplicate |
Definition at line 245 of file sed_cell.c.
References eh_require, and sed_cell_copy().
Referenced by sed_column_add_cell_real(), and squall().
double sed_cell_dynamic_viscosity | ( | const Sed_cell | c | ) |
Get the dynamic viscosity of a sediment type in a Sed_cell .
This formlation is taken from 'erosion and sedimentation' by Pierre Julien (p. 190).
c | The cell to measure. |
Definition at line 1557 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_dynamic_viscosity().
double sed_cell_excess_pressure | ( | const Sed_cell | c, | |
double | hydro_static | |||
) |
Definition at line 1898 of file sed_cell.c.
References eh_require, and sed_cell_pressure().
Referenced by fail_reinit_fail_column().
Sed_facies sed_cell_facies | ( | const Sed_cell | c | ) |
Get the facies designation of a cell.
c | The Sed_cell to query. |
Definition at line 1940 of file sed_cell.c.
References eh_require.
Referenced by sed_cell_is_same(), and sed_measure_cube_facies().
gssize sed_cell_fprint | ( | FILE * | fp, | |
const Sed_cell | c | |||
) |
Print the contents of a cell
fp | A FILE to print to which | |
c | A Sed_cell |
Definition at line 340 of file sed_cell.c.
References sed_cell_n_types().
Referenced by bio_array_to_cell_array(), and sed_cell_array_fprint().
double sed_cell_fraction | ( | const Sed_cell | c, | |
gssize | n | |||
) |
Get the fraction of a cell composed of a sediment type.
c | The Sed_cell to query. | |
n | The sediment type to query. |
Definition at line 1875 of file sed_cell.c.
References eh_require, and sed_cell_n_types().
Referenced by compact(), muddy(), sed_cell_nth_amount(), sed_cell_nth_fraction(), sed_hydro_add_cell(), and squall().
double* sed_cell_fraction_ptr | ( | const Sed_cell | c | ) |
double sed_cell_friction_angle | ( | const Sed_cell | c | ) |
Get the Coulomb friction angle of a sediment type in a Sed_cell.
c | The cell to measure. |
Definition at line 1475 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_friction_angle().
double sed_cell_grain_density | ( | const Sed_cell | c | ) |
Get the density of a sediment type in a Sed_cell .
c | The cell to measure. |
Definition at line 1130 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_rho_grain().
Referenced by sed_cell_sediment_mass().
double sed_cell_grain_size | ( | const Sed_cell | c | ) |
Get the mean grain size of a sediment type in a Sed_cell.
c | The cell to measure. |
Definition at line 1158 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_grain_size().
double sed_cell_grain_size_in_phi | ( | const Sed_cell | c | ) |
Get the mean grain size (in phi units) of a sediment type in a Sed_cell.
c | The cell to measure. |
Definition at line 1177 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_grain_size_in_phi().
Referenced by sed_measure_cube_grain_size().
Sed_cell_grid sed_cell_grid_add | ( | Sed_cell_grid | g_1, | |
Sed_cell_grid | g_2 | |||
) |
Definition at line 2266 of file sed_cell.c.
References eh_grid_data_start(), eh_grid_is_compatible(), eh_grid_n_el(), eh_require, and sed_cell_add().
Referenced by run_plume_hypo().
Sed_cell_grid sed_cell_grid_clear | ( | Sed_cell_grid | g | ) |
Definition at line 2300 of file sed_cell.c.
References eh_grid_data_start(), eh_grid_n_el(), eh_require, and sed_cell_clear().
Referenced by rain_sediment_3(), run_bbl(), and run_plume_hypo().
Sed_cell_grid sed_cell_grid_copy_data | ( | Sed_cell_grid | dest, | |
Sed_cell_grid | src | |||
) |
Definition at line 2283 of file sed_cell.c.
References eh_grid_data_start(), eh_grid_is_compatible(), eh_grid_n_el(), eh_require, and sed_cell_copy().
Referenced by run_plume_hypo().
Sed_cell** sed_cell_grid_data | ( | Sed_cell_grid | g | ) |
The data part of the grid
Get the data member of a Sed_cell_grid
g | A Sed_cell_grid |
Definition at line 2342 of file sed_cell.c.
References eh_grid_data().
Referenced by diffuse_sediment_2(), and run_plume_hypo().
Sed_cell_grid sed_cell_grid_destroy | ( | Sed_cell_grid | g | ) |
Definition at line 2232 of file sed_cell.c.
References eh_grid_destroy(), and sed_cell_grid_free().
Referenced by rain_sediment_3().
void sed_cell_grid_free | ( | Sed_cell_grid | g | ) |
Free the resources used for each element of a Sed_cell_grid.
Destroy each element of a Sed_cell_grid. The resources used for the grid itself is not freed. To free the Sed_cell_grid as well, use sed_destroy_grid .
g | A pointer to a Sed_cell_grid. |
Definition at line 2219 of file sed_cell.c.
References eh_grid_data_start(), eh_grid_n_el(), and sed_cell_destroy().
Referenced by destroy_plume_hypo(), diffuse_sediment_2(), main(), sed_cell_grid_destroy(), and sed_cube_destroy_in_suspension().
void sed_cell_grid_free_data | ( | Sed_cell_grid | g | ) |
Definition at line 2244 of file sed_cell.c.
References eh_grid_data_start(), eh_grid_n_el(), eh_require, and sed_cell_destroy().
Sed_cell_grid sed_cell_grid_init | ( | Sed_cell_grid | g, | |
gssize | n_grains | |||
) |
Initalize a two-dimensional array of Sed_cell's.
Initialize a Sed_cell_grid with new Sed_cell's. The input grid must first have been created with sed_create_cell_grid .
g | A pointer to a Sed_cell_grid. | |
n_grains | The number of grain types for each Sed_cell. |
Definition at line 2191 of file sed_cell.c.
References eh_grid_data_start(), eh_grid_n_el(), eh_require, and sed_cell_new().
Referenced by diffuse_sediment_2(), init_plume_hypo_data(), main(), sed_cell_grid_new_env(), and sed_cube_create_in_suspension().
double sed_cell_grid_mass | ( | Sed_cell_grid | g | ) |
Definition at line 2316 of file sed_cell.c.
References eh_grid_data_start(), eh_grid_n_el(), eh_require, and sed_cell_mass().
Referenced by run_plume_hypo(), and sed_cube_mass_in_suspension().
Sed_cell_grid sed_cell_grid_new | ( | gsize | n_x, | |
gsize | n_y | |||
) |
Create a two-dimensional array of Sed_cell's.
Create a two-dimensional array of pointer to Sed_cell's. Only resources needed to hold the pointers are allocated, the pointers are not initialized. To create pointers to Sed_cell's, use sed_init_cell_grid once the grid has been created.
n_x | The size of the slow-dimension. | |
n_y | The size of the fast-dimension. |
Definition at line 2165 of file sed_cell.c.
References eh_grid_new.
Referenced by diffuse_sediment_2(), init_plume_hypo_data(), sed_cell_grid_new_env(), and sed_cube_create_in_suspension().
Sed_cell_grid sed_cell_grid_new_env | ( | gsize | n_x, | |
gsize | n_y | |||
) |
Definition at line 2172 of file sed_cell.c.
References sed_cell_grid_init(), sed_cell_grid_new(), and sed_sediment_env_n_types().
Referenced by rain_sediment_3().
Sed_cell sed_cell_grid_val | ( | Sed_cell_grid | g, | |
gssize | i, | |||
gssize | j | |||
) |
Definition at line 2260 of file sed_cell.c.
References eh_grid_row().
Referenced by construct_deposit_array_3(), deposit_in_ocean(), main(), plume_centerline_deposit(), plume_width_averaged_deposit(), plume_width_averaged_deposit_num(), and rain_sediment_3().
double sed_cell_hydraulic_conductivity | ( | const Sed_cell | c | ) |
Get the hydraulic conductivity of a sediment type in a Sed_cell.
c | The cell to measure. |
Definition at line 1385 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_hydraulic_conductivity().
Referenced by run_darcy_flow().
gboolean sed_cell_is_age | ( | Sed_cell | c, | |
double | a | |||
) |
Test if a Sed_cell is of a certain age
c | A Sed_cell | |
a | The age to compare to. |
Definition at line 688 of file sed_cell.c.
References eh_compare_dbl(), and sed_cell_age().
gboolean sed_cell_is_clear | ( | Sed_cell | c | ) |
Test if a Sed_cell is clear
A Sed_cell is clear if it is empty and the fraction of each grain size is set to zero. This is the state of a newly created Sed_cell.
c | A Sed_cell |
Definition at line 643 of file sed_cell.c.
References sed_cell_is_empty(), and sed_cell_n_types().
Referenced by sed_cell_array_delete_empty(), sed_cell_is_valid(), sed_column_stack_cells(), and sed_column_stack_cells_loc().
Test if two Sed_cell's are compatible.
Two cells are compatible if the contain the same number of grain types. If so, they can interact with one another through adding, subtracting etc.
Definition at line 730 of file sed_cell.c.
References sed_cell_n_types().
Referenced by sed_cell_add(), sed_cell_copy(), sed_cell_move_fraction(), and sed_cell_move_thickness().
gboolean sed_cell_is_empty | ( | Sed_cell | c | ) |
Test if a Sed_cell is empty
A Sed_cell is determined to be empty if its size is less than some tolerance.
c | A Sed_cell |
Definition at line 626 of file sed_cell.c.
Referenced by sed_cell_add(), sed_cell_array_delete_empty(), sed_cell_is_clear(), sed_cell_mass(), sed_cell_separate(), sed_cell_separate_amount(), sed_cell_separate_fraction(), sed_column_add_cell_real(), and sed_column_stack_cells_loc().
gboolean sed_cell_is_mass | ( | Sed_cell | c, | |
double | m | |||
) |
Test if a Sed_cell is of a certain mass
c | A Sed_cell | |
m | The age to compare to. |
Definition at line 701 of file sed_cell.c.
References eh_compare_dbl(), and sed_cell_mass().
Definition at line 2348 of file sed_cell.c.
References eh_require, sed_cell_age(), sed_cell_facies(), sed_cell_n_types(), and sed_cell_size().
Referenced by sed_column_is_same().
gboolean sed_cell_is_size | ( | Sed_cell | c, | |
double | t | |||
) |
Test if a Sed_cell is of a certain size
c | A Sed_cell | |
t | The thickness to compare to. |
Definition at line 675 of file sed_cell.c.
References eh_compare_dbl(), and sed_cell_size().
gboolean sed_cell_is_size_class | ( | Sed_cell | c, | |
Sed_size_class | size | |||
) |
Test if a Sed_cell is of a certain size class
c | A Sed_cell | |
size | The Sed_size_class to compare to. |
Definition at line 714 of file sed_cell.c.
References sed_cell_size_class().
gboolean sed_cell_is_valid | ( | Sed_cell | c | ) |
Definition at line 2379 of file sed_cell.c.
References sed_cell_is_clear(), sed_cell_n_types(), and sed_cell_size().
Referenced by sed_cell_add(), sed_column_stack_cell_loc_real(), and sed_column_stack_cells_loc().
Destroy a Cell_list Free resources used for a Cell_list.
c_list | A Cell_list that was created with sed_create_cell_list . |
Definition at line 298 of file sed_cell.c.
References eh_free, eh_require, and sed_cell_destroy().
Sed_cell* sed_cell_list_new | ( | gssize | len, | |
gssize | n | |||
) |
Create a Cell_list.
Create a list of Sed_cell s. The elements of the array will be pointers to Sed_cell s and will be NULL terminated. A newly created Cell_list is returned. When this Cell_list is no longer used it should be freed with sed_destroy_cell_list .
len | The number of Sed_cell s to put in the list. | |
n | The number of sediment types in each Sed_cell . |
Definition at line 272 of file sed_cell.c.
References eh_new, eh_require, and sed_cell_new().
double sed_cell_load | ( | const Sed_cell | c | ) |
Get the load of a Sed_cell .
Get the load that a cell of sediment exerts. load is in N/m/m or Pa.
c | The Sed_cell to query. |
Definition at line 1981 of file sed_cell.c.
References sed_cell_mass(), and sed_gravity().
Referenced by run_debris_flow(), sed_column_add_cell_real(), sed_column_load_at(), sed_column_stack_cell_loc_real(), sed_column_stack_cell_real(), and sed_column_top_property().
double sed_cell_mass | ( | const Sed_cell | c | ) |
Get the mass of a Sed_cell .
Calculate the mass of sediment in a cell. mass is in units of kg/m^2.
c | A Sed_cell to query. |
Definition at line 1957 of file sed_cell.c.
References eh_require, sed_cell_density(), and sed_cell_is_empty().
Referenced by add_sediment_from_external_source(), diffuse_cols(), main(), move_sediment(), run_xshore(), sed_cell_array_mass(), sed_cell_grid_mass(), sed_cell_is_mass(), sed_cell_load(), sed_column_mass(), and xshore().
double sed_cell_max_density | ( | const Sed_cell | c | ) |
Get the closest packed density of a sediment type in a Sed_cell .
c | The cell to measure. |
Definition at line 1144 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_rho_max().
Move a Sed_cell by fractions of a thickness into another.
Move a Sed_Cell by specifying a maximum thickness to remove and then specifying individual fractions of that thickness to remove. That is, if fraction is an array of ones, then it is equivalent to: sed_move_sediment_to_cell_by_thickness( dest , src , thickness , n_grains ); If however, fraction is an array of zeros then it is equivalent to removing nothing from src and not changing dest at all.
[in] | src | The source cell where sediment is removed from. |
[out] | dest | The destination cell where sediment is added to. |
[in] | f | The fractions of each grain type to move. |
[in] | t | The total amount of sediment to transfer. |
Definition at line 1084 of file sed_cell.c.
References sed_cell_add(), sed_cell_destroy(), sed_cell_separate_fraction(), and sed_cell_separate_thickness().
Referenced by squall().
Move sediment from one cell into another.
Moves a given amount of sediment (specified by fraction of each grain size) from one cell and adds it to another. The difference from the sed_separate functions is that the sed_move_sediment functions add the removed sediment to any existing sediment that is already in the destination cell.
src | The source cell where sediment is removed from. | |
dest | The destination cell where sediment is added to. | |
f | The fraction of each grain size to move. |
Definition at line 1051 of file sed_cell.c.
References eh_require, sed_cell_add(), sed_cell_destroy(), sed_cell_is_compatible(), and sed_cell_separate_fraction().
Referenced by diffuse_sediment(), and diffuse_sediment_2().
Move sediment from one cell into another.
Moves a given amount of sediment (specified as thickness) from one cell and adds it to another. The difference from the sed_separate functions is that the sed_move_sediment functions add the removed sediment to any existing sediment that is already in the destination cell.
src | The source cell where sediment is removed from. | |
dest | The destination cell where sediment is added to. | |
t | The amount of sediment to transfer. |
Definition at line 1023 of file sed_cell.c.
References eh_require, sed_cell_add(), sed_cell_destroy(), sed_cell_is_compatible(), and sed_cell_separate_thickness().
double sed_cell_mud_fraction | ( | const Sed_cell | c | ) |
Definition at line 1201 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_is_mud().
double sed_cell_mv | ( | const Sed_cell | c | ) |
Definition at line 1702 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_compressibility().
Referenced by sed_cell_bulk_cv().
gssize sed_cell_n_types | ( | const Sed_cell | c | ) |
Definition at line 1920 of file sed_cell.c.
References eh_require.
Referenced by inflow_flood_from_cell(), sakura_flood_from_cell(), sed_cell_add(), sed_cell_add_amount(), sed_cell_clear(), sed_cell_copy(), sed_cell_copy_fraction(), sed_cell_fprint(), sed_cell_fraction(), sed_cell_is_clear(), sed_cell_is_compatible(), sed_cell_is_same(), sed_cell_is_valid(), sed_cell_separate(), sed_cell_separate_amount(), sed_cell_separate_fraction(), sed_cell_set_amount(), sed_cell_set_equal_fraction(), sed_cell_set_fraction(), sed_hydro_add_cell(), and sed_hydro_subtract_cell().
Sed_cell sed_cell_new | ( | gssize | n_grains | ) |
Create a new cell of sediment.
n_grains | the number of Sediment types held in the cell. |
Definition at line 76 of file sed_cell.c.
References eh_new0, NEW_OBJECT, and S_FACIES_NOTHING.
Referenced by decider(), diffuse_sediment(), diffuse_sediment_2(), main(), muddy(), sed_cell_add_column(), sed_cell_copy(), sed_cell_grid_init(), sed_cell_list_new(), sed_cell_new_env(), sed_cell_new_sized(), sed_cell_read(), sed_column_add_vec(), sed_column_extract_top_fill(), sed_column_separate_top(), sed_column_separate_top_amounts(), sed_column_top(), sed_column_top_age(), sed_column_top_property_0(), sed_column_top_rho(), squall(), test_2d(), and xshore().
Sed_cell sed_cell_new_bedload | ( | Sed_sediment | s, | |
double | t | |||
) |
Create a new cell of just bedload
s | Sediment that the cell will be formed from | |
t | The initial size of the cell |
Definition at line 209 of file sed_cell.c.
References eh_free, eh_new0, sed_cell_new_sized(), sed_sediment_env(), and sed_sediment_n_types().
Referenced by deposit_in_ocean(), and deposit_in_river().
Sed_cell sed_cell_new_classed | ( | Sed_sediment | s, | |
double | t, | |||
Sed_size_class | class | |||
) |
Create a new cell with a certain size class
s | Sediment that the cell will be formed from | |
t | The initial size of the cell | |
class | A Sed_size_class that describes the sediment to be put into the Sed_cell |
Definition at line 173 of file sed_cell.c.
References eh_dbl_array_normalize(), eh_free, eh_new0, sed_cell_new_sized(), sed_sediment_env(), sed_sediment_n_types(), sed_sediment_type(), and sed_type_size_class().
Referenced by main(), and sed_column_new_filled().
Sed_cell sed_cell_new_env | ( | void | ) |
Create a new cell based on the sediment of the current sediment environment
Definition at line 102 of file sed_cell.c.
References sed_cell_new(), sed_sediment_env_is_set(), and sed_sediment_env_n_types().
Referenced by add_sediment_from_external_source(), bio_array_to_cell_array(), construct_deposit_array_3(), diffuse_cols(), diffuse_profile(), erode_profile(), inflow_deposit_sediment(), move_sediment(), rain_sediment_3(), run_debris_flow(), run_xshore(), sakura_deposit_sediment(), sakura_sed_get_phe(), sed_column_extract_top_fill(), sed_column_extract_top_n_cells(), sed_column_resize(), sed_column_separate_top_amounts_fill(), sed_cube_new_empty(), sed_cube_to_cell(), and sed_get_phe().
Sed_cell sed_cell_new_sized | ( | gssize | n, | |
double | t, | |||
double * | f | |||
) |
Create a new cell and initialize it with a specified size and fractions.
n | The number of sediment types within the cell | |
t | The initial size of the cell | |
f | A pointer to an array of fractions of each grain type |
Definition at line 121 of file sed_cell.c.
References sed_cell_new(), sed_cell_resize(), and sed_cell_set_fraction().
Referenced by _scan_sediment_column(), deposit_sediment_helper(), move_sediment(), sed_cell_new_bedload(), sed_cell_new_classed(), and sed_cell_new_typed().
Sed_cell sed_cell_new_typed | ( | Sed_sediment | s, | |
double | t, | |||
Sed_type | a_type | |||
) |
Create a new cell with a certain type of sediment
s | Sediment that the cell will be formed from | |
t | The initial size of the cell | |
a_type | A Sed_type that describes the sediment to be put into the Sed_cell |
Definition at line 140 of file sed_cell.c.
References eh_free, eh_new0, sed_cell_new_sized(), sed_sediment_env(), sed_sediment_n_types(), sed_sediment_type(), and sed_type_is_same().
double sed_cell_nth_amount | ( | const Sed_cell | c, | |
gssize | n | |||
) |
Definition at line 1213 of file sed_cell.c.
References sed_cell_fraction(), and sed_cell_size().
Referenced by sed_array_to_bio_array().
double sed_cell_nth_fraction | ( | const Sed_cell | c, | |
gssize | n | |||
) |
Definition at line 1207 of file sed_cell.c.
References sed_cell_fraction().
Referenced by _print_sediment_column(), get_sediment_flux(), sed_get_phe(), and sed_hydro_subtract_cell().
double sed_cell_permeability | ( | const Sed_cell | c | ) |
Get the permeability of a sediment type in a Sed_cell.
c | The cell to measure. |
Definition at line 1371 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_permeability().
Referenced by sed_measure_cube_permeability().
double sed_cell_plastic_index | ( | const Sed_cell | c | ) |
Get the plastic index of a sediment type in a Sed_cell.
c | The cell to measure. |
Definition at line 1357 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_plastic_index().
double sed_cell_porosity | ( | const Sed_cell | c | ) |
Get the porosity of a sediment type in a Sed_cell.
c | The cell to measure. |
Definition at line 1311 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_porosity().
Referenced by sed_cell_bulk_dynamic_viscosity(), sed_cell_bulk_yield_strength(), and sed_measure_cube_porosity().
double sed_cell_porosity_max | ( | const Sed_cell | c | ) |
Get the maximum porosity of a sediment type in a Sed_cell.
Returns the porosity of a Sed_cell when it is in its uncompacted state.
c | The cell to measure. |
Definition at line 1327 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_porosity_max().
double sed_cell_porosity_min | ( | const Sed_cell | c | ) |
Get the minimum porosity of a sediment type in a Sed_cell.
Returns the porosity of a cell if it were in its closest packed state.
c | The cell to measure. |
Definition at line 1343 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_porosity_min().
double sed_cell_pressure | ( | const Sed_cell | c | ) |
Get the pressure felt by a Sed_cell .
c | The Sed_cell to query. |
Definition at line 1891 of file sed_cell.c.
References eh_require.
Referenced by compact(), get_janbu_parameters(), run_darcy_flow(), run_exponential_flow(), run_terzaghi_flow(), sed_cell_excess_pressure(), sed_cell_relative_pressure(), sed_column_add_cell_real(), sed_column_stack_cell_loc_real(), and sed_column_stack_cell_real().
Sed_cell sed_cell_read | ( | FILE * | fp | ) |
Read the contents of a Sed_cell from a binary file.
Read the contents of a Sed_cell from a binary file. The information must have been written with sed_dump_cell . A newly created Sed_cell is returned that contains the information read from the file. This Sed_cell should be destroyed with sed_destroy_cell when no longer in use.
fp | A pointer to a file to read the data from. |
Definition at line 2058 of file sed_cell.c.
References eh_require, and sed_cell_new().
Referenced by sed_column_read(), and sed_cube_read().
double sed_cell_relative_density | ( | const Sed_cell | c | ) |
Get the relative density of a sediment type in a Sed_cell.
c | The cell to measure. |
Definition at line 1297 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_relative_density().
double sed_cell_relative_pressure | ( | const Sed_cell | c, | |
double | load | |||
) |
Change the size of a cell.
Change the size of a Sed_cell .
Definition at line 2098 of file sed_cell.c.
References eh_require, and sed_cell_clear().
Referenced by add_sediment_from_external_source(), bio_array_to_cell_array(), construct_deposit_array_3(), deposit_in_ocean(), deposit_sediment_helper(), diffuse_cols(), diffuse_profile(), diffuse_sediment(), diffuse_sediment_2(), erode_profile(), fill_to_bruun(), fill_to_bruun_profile(), main(), run_debris_flow(), run_river(), sed_cell_new_sized(), sed_cell_separate_amount(), sed_cell_separate_thickness(), sed_cell_set_amount(), sed_column_add_cell_real(), sed_column_extract_cells_above(), sed_column_extract_top_cell(), sed_column_extract_top_fill(), sed_column_height_copy(), sed_column_remove_top_cell(), sed_column_resize_cell(), sed_column_top(), squall(), test_2d(), and xshore().
double sed_cell_sand_fraction | ( | const Sed_cell | c | ) |
Definition at line 1183 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_is_sand().
Referenced by decider(), sed_cell_bulk_dynamic_viscosity(), and sed_cell_bulk_yield_strength().
double sed_cell_sediment_load | ( | const Sed_cell | c | ) |
Definition at line 1987 of file sed_cell.c.
References sed_cell_sediment_mass(), and sed_gravity().
Referenced by sed_column_total_load().
double sed_cell_sediment_mass | ( | const Sed_cell | c | ) |
Definition at line 1678 of file sed_cell.c.
References sed_cell_grain_density(), and sed_cell_sediment_volume().
Referenced by _sed_diag_mass(), sed_cell_sediment_load(), and sed_column_sediment_mass().
double sed_cell_sediment_volume | ( | const Sed_cell | c | ) |
Definition at line 1667 of file sed_cell.c.
References sed_cell_void_ratio().
Referenced by compact(), and sed_cell_sediment_mass().
Remove sediment from one cell and place it into another
Sediment is removed from the source cell and put into the new cell.
[in,out] | in | The cell to be separated |
[in] | f | The fraction of each grain type to remove |
[in] | t | The amount of each grain type to remove |
[in,out] | out | A cell containing the separated sediment |
Definition at line 977 of file sed_cell.c.
References eh_free, eh_new, eh_require, sed_cell_copy(), sed_cell_is_empty(), sed_cell_n_types(), and sed_cell_separate_amount().
Referenced by sed_cell_separate_cell().
Remove sediment from one cell and put it in another by specifying the amount of each type
Remove sediment from the source cell by specifying the amount of each type of sediment sediment to remove. The sediment is removed with the same make-up of the original cell.
[in] | in | The source cell |
[in] | t | The amount of each sediment type to be removed |
[out] | out | The location to put the removed sediment. If NULL, a new cell is created. |
Definition at line 749 of file sed_cell.c.
References eh_clamp, eh_free, eh_new0, eh_require, sed_cell_copy(), sed_cell_is_empty(), sed_cell_n_types(), sed_cell_resize(), sed_cell_separate_fraction(), and sed_cell_size().
Referenced by sed_cell_separate(), sed_column_separate_top_amounts(), and sed_column_separate_top_amounts_fill().
Remove sediment from one cell based on another cell
Sediment is removed from the source cell based on the fraction and amount of sediment in another cell.
[in] | in | The source cell from which sediment is removed |
[out] | out | Sediment is removed based on the make up of this cell |
Definition at line 956 of file sed_cell.c.
References sed_cell_destroy(), sed_cell_separate(), and sed_cell_size().
Referenced by diffuse_profile().
Remove fractions of sediment from one cell and put it in another
Remove sediment from the source cell by specifying fractions of each grain type to remove.
[in] | in | The source cell |
[in] | f | The fraction of each grain type to remove |
[out] | out | The location to put the removed sediment. If NULL, a new cell is created. |
Definition at line 837 of file sed_cell.c.
References eh_free, eh_new, eh_require, sed_cell_copy(), sed_cell_is_empty(), sed_cell_n_types(), sed_cell_set_amount(), and sed_cell_size().
Referenced by sed_cell_move(), sed_cell_move_fraction(), sed_cell_separate_amount(), sed_column_separate_top(), and squall().
Remove an amount of sediment from one cell and put it in another
Remove sediment from the source cell by specifying the amount of sediment to remove. The sediment is removed with the same make-up of the original cell.
in | The source cell | |
t | The total amount of sediment to be removed | |
out | The location to put the removed sediment. If NULL, a new cell is created. |
Definition at line 801 of file sed_cell.c.
References eh_clamp, eh_require, sed_cell_copy(), sed_cell_resize(), and sed_cell_size().
Referenced by sed_cell_move(), and sed_cell_move_thickness().
Set the age of a cell.
c | The Sed_cell to set. | |
age | The new age value. |
Definition at line 462 of file sed_cell.c.
References eh_require.
Referenced by construct_deposit_array_3(), diffuse_sediment(), fill_to_bruun(), fill_to_bruun_profile(), inflow_deposit_sediment(), move_sediment(), run_debris_flow(), sakura_deposit_sediment(), and squall().
Set the amount of each grain type in a Sed_Cell
c | A Sed_cell | |
t | A pointer to an array of amounts of each grain type |
Definition at line 880 of file sed_cell.c.
References eh_dbl_array_sum(), eh_return_val_if_fail, sed_cell_clear(), sed_cell_n_types(), and sed_cell_resize().
Referenced by sed_cell_separate_fraction().
Set the fractions of each grain to be uniform.
[in,out] | c | The sediment cell |
Definition at line 553 of file sed_cell.c.
References eh_require, and sed_cell_n_types().
Referenced by add_sediment_from_external_source(), and test_2d().
Sed_cell sed_cell_set_facies | ( | Sed_cell | c, | |
Sed_facies | f | |||
) |
Sed the facies designation of a cell.
c | The Sed_cell to set. | |
f | The new facies to add to the cell. |
Definition at line 507 of file sed_cell.c.
References eh_require.
Referenced by diffuse_sediment(), diffuse_sediment_2(), fill_to_bruun(), fill_to_bruun_profile(), inflow_deposit_sediment(), move_sediment(), run_debris_flow(), run_plume_hypo(), sakura_deposit_sediment(), and squall().
Set the fractions of each sediment type found in a cell.
Set each of the fractions of sediment types within a Sed_cell . Each of the elements of f
are copied to c
. Thus, f
is free to be freed after sed_set_cell_fraction is called.
c | The Sed_cell to set. | |
f | A vector of new fractions. |
Definition at line 534 of file sed_cell.c.
References eh_require, and sed_cell_n_types().
Referenced by _scan_sediment_column(), diffuse_sediment(), diffuse_sediment_2(), run_xshore(), and sed_cell_new_sized().
Sed the pressure of a cell.
c | The Sed_cell to set. | |
p | The new pressure value. |
Definition at line 492 of file sed_cell.c.
References eh_require.
Referenced by run_darcy_flow(), run_debris_flow(), run_exponential_flow(), run_terzaghi_flow(), sed_column_add_cell_real(), sed_column_stack_cell_loc_real(), and sed_column_stack_cell_real().
Sed the thickness of a cell.
c | The Sed_cell to set. | |
t | The new thickness value. |
Definition at line 477 of file sed_cell.c.
References eh_require.
double sed_cell_shear_strength | ( | const Sed_cell | c, | |
double | load | |||
) |
Get the shear strength of a sediment type in a Sed_cell .
c | The cell to measure. | |
load | The load on the cell. |
Definition at line 1733 of file sed_cell.c.
References sed_sediment_property_avg_with_data(), and sed_type_shear_strength_with_data().
Referenced by run_debris_flow().
double sed_cell_silt_fraction | ( | const Sed_cell | c | ) |
Definition at line 1189 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_is_silt().
Referenced by sed_cell_bulk_yield_strength().
double sed_cell_size | ( | const Sed_cell | c | ) |
Get the thickness of a cell.
c | The Sed_cell to query. |
Definition at line 1853 of file sed_cell.c.
Referenced by _print_sediment_column(), compact(), construct_deposit_array_3(), deposit_sediment_helper(), diffuse_profile(), diffuse_sediment_2(), erode_profile(), fail_reinit_fail_column(), get_sediment_flux(), main(), muddy(), rain_sediment_3(), run_river(), run_terzaghi_flow(), sakura_sed_get_phe(), sakura_sed_remove_sediment(), sed_cell_consolidation(), sed_cell_consolidation_rate(), sed_cell_is_same(), sed_cell_is_size(), sed_cell_is_valid(), sed_cell_nth_amount(), sed_cell_separate_amount(), sed_cell_separate_cell(), sed_cell_separate_fraction(), sed_cell_separate_thickness(), sed_column_add_cell_real(), sed_column_avg_property(), sed_column_avg_property_with_load(), sed_column_bioturbate(), sed_column_compact_cell(), sed_column_depth_age(), sed_column_extract_cells_above(), sed_column_extract_top_cell(), sed_column_extract_top_cell_loc(), sed_column_extract_top_fill(), sed_column_extract_top_n_cells(), sed_column_index_depth(), sed_column_index_thickness(), sed_column_property(), sed_column_property_0(), sed_column_remove_top(), sed_column_remove_top_cell(), sed_column_resize_cell(), sed_column_stack_cell_loc_real(), sed_column_stack_cell_real(), sed_column_thickness_index(), sed_column_top(), sed_hydro_add_cell(), sed_hydro_subtract_cell(), and squall().
double sed_cell_size_0 | ( | const Sed_cell | c | ) |
Definition at line 1862 of file sed_cell.c.
Referenced by inflow_flood_from_cell(), and sakura_flood_from_cell().
Sed_size_class sed_cell_size_class | ( | const Sed_cell | c | ) |
Get the Wentworth size class for a Sed_cell .
Returns the Wentworth size class for the sediment in a cell. The mean grain size of the sediment contained in a Sed_cell is averaged (in terms of phi units). The mean grain size is then placed into a sand (phi<4), silt (4<phi<9), or clay (phi>9) class.
c | The Sed_cell to measure. |
Definition at line 1614 of file sed_cell.c.
References S_SED_TYPE_NONE, sed_sediment_property_avg(), sed_size_class(), and sed_type_grain_size_in_phi().
Referenced by sed_cell_is_size_class().
double sed_cell_size_class_percent | ( | const Sed_cell | c, | |
Sed_size_class | size | |||
) |
Return the percentage of a certain size class with a Sed_cell.
Retruns the fraction of a given size class (from the Wentworth scale) contained in a Sed_cell.
c | The Sed_cell to examine. | |
size | The size class to look for. |
Definition at line 1640 of file sed_cell.c.
References sed_sediment_property_avg_with_data(), and sed_type_is_size_class_with_data().
Referenced by sed_measure_cube_clay_fraction(), sed_measure_cube_mud_fraction(), sed_measure_cube_sand_fraction(), and sed_measure_cube_silt_fraction().
Sed_size_class sed_cell_size_classes | ( | const Sed_cell | c | ) |
Definition at line 1650 of file sed_cell.c.
References S_SED_TYPE_NONE, sed_sediment_property_avg_with_data(), and sed_type_sum_size_classes_with_data().
double sed_cell_thickness | ( | const Sed_cell | c | ) |
Definition at line 1838 of file sed_cell.c.
double sed_cell_velocity | ( | const Sed_cell | c | ) |
Get the velocity of water of a sediment type in a Sed_cell.
c | The cell to measure. |
Definition at line 1269 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_velocity().
double sed_cell_viscosity | ( | const Sed_cell | c | ) |
Get the viscosity of a sediment type in a Sed_cell.
c | The cell to measure. |
Definition at line 1283 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_viscosity().
Referenced by run_debris_flow().
double sed_cell_void_ratio | ( | const Sed_cell | c | ) |
Get the void ratio of a sediment type in a Sed_cell.
c | The cell to measure. |
Definition at line 1430 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_void_ratio().
Referenced by sed_cell_bulk_permeability(), and sed_cell_sediment_volume().
double sed_cell_void_ratio_max | ( | const Sed_cell | c | ) |
Get the maximum void ratio of a sediment type in a Sed_cell.
Returns the void ratio of a cell if it were in its uncompacted state.
c | The cell to measure. |
Definition at line 1463 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_void_ratio_max().
double sed_cell_void_ratio_min | ( | const Sed_cell | c | ) |
Get the minimum void ratio of a sediment type in a Sed_cell.
Returns the void ratio of a Sed_cell if it were in its closest packed state.
c | The cell to measure. |
Definition at line 1447 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_void_ratio_min().
gssize sed_cell_write | ( | FILE * | fp, | |
const Sed_cell | c | |||
) |
Write the contents of a Sed_cell to a binary file.
Dump the contents of a Sed_cell to a binary file. The contents can be read back into the Sed_cell from a file using sed_load_cell .
fp | A file pointer to the file to dump the information. | |
c | The Sed_cell to dump. |
Definition at line 2005 of file sed_cell.c.
References sed_cell_write_to_byte_order().
Referenced by sed_column_write_to_byte_order(), and sed_cube_write().
gssize sed_cell_write_to_byte_order | ( | FILE * | fp, | |
const Sed_cell | c, | |||
int | order | |||
) |
Definition at line 2011 of file sed_cell.c.
References eh_fwrite_dbl_swap, eh_fwrite_int32_swap, and eh_require.
Referenced by sed_cell_write(), and sed_column_write_to_byte_order().
double sed_cell_yield_strength | ( | const Sed_cell | c | ) |
Get the yield strength of a sediment type in a Sed_cell.
This formlation is taken from 'erosion and sedimentation' by Pierre Julien (p. 190). The yieled strength (in Pa) of a debris flow. That is, it should be the remolded yield strength of the sediment which is different from the yield strength of the sediment before failure. The concentration here is the volume concentration of sediment. That is, the volume of sediment divided by the total volume (of sediment plus water); this is the same as one minus the porosity.
c | The cell to measure. |
Definition at line 1507 of file sed_cell.c.
References sed_sediment_property_avg(), and sed_type_yield_strength().