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

#include <glib.h>
#include "utils/eh_types.h"

Go to the source code of this file.

Defines

#define SED_WAVE_H

Functions

 new_handle (Sed_wave)
 new_handle (Sed_ocean_storm)
Sed_wave sed_wave_new (double h, double k, double w)
Sed_wave sed_wave_copy (Sed_wave dest, Sed_wave src)
Sed_wave sed_wave_dup (Sed_wave src)
gboolean sed_wave_is_same (Sed_wave w_1, Sed_wave w_2)
Sed_wave sed_wave_destroy (Sed_wave w)
double sed_wave_height (Sed_wave w)
double sed_wave_number (Sed_wave w)
double sed_wave_length (Sed_wave w)
double sed_wave_frequency (Sed_wave w)
double sed_wave_period (Sed_wave w)
double sed_wave_phase_velocity (Sed_wave w)
gboolean sed_wave_is_bad (Sed_wave w)
Sed_wave sed_gravity_wave_new (Sed_wave w_infinity, double h, Sed_wave new_wave)
Sed_wave sed_gravity_wave_set_frequency (Sed_wave a, double w, double h)
Sed_wave sed_gravity_wave_set_number (Sed_wave w, double k, double h)
Sed_wave sed_gravity_wave_set_height (Sed_wave w, Sed_wave w_infinity, double h)
double sed_gravity_wave_deep_water_height (Sed_wave w)
double sed_gravity_wave_deep_water_wave_number (Sed_wave w)
gboolean sed_wave_is_breaking (Sed_wave w, double h)
double sed_wave_break_depth (Sed_wave w)
double sed_dispersion_relation_frequency (double water_depth, double wave_number)
double sed_dispersion_relation_wave_number (double water_depth, double frequency)
Sed_ocean_storm sed_ocean_storm_new (void)
Sed_ocean_storm sed_ocean_storm_destroy (Sed_ocean_storm s)
gssize sed_ocean_storm_index (Sed_ocean_storm s)
double sed_ocean_storm_val (Sed_ocean_storm s)
double sed_ocean_storm_duration (Sed_ocean_storm s)
double sed_ocean_storm_duration_in_seconds (Sed_ocean_storm s)
double sed_ocean_storm_wave_height (Sed_ocean_storm s)
double sed_ocean_storm_wave_number (Sed_ocean_storm s)
double sed_ocean_storm_wave_length (Sed_ocean_storm s)
double sed_ocean_storm_wave_freq (Sed_ocean_storm s)
double sed_ocean_storm_wave_period (Sed_ocean_storm s)
double sed_ocean_storm_phase_velocity (Sed_ocean_storm s)
Sed_ocean_storm sed_ocean_storm_set_wave (Sed_ocean_storm s, Sed_wave w)
Sed_ocean_storm sed_ocean_storm_set_index (Sed_ocean_storm s, gssize ind)
Sed_ocean_storm sed_ocean_storm_set_duration (Sed_ocean_storm s, double dt_in_days)
Sed_ocean_storm sed_ocean_storm_set_val (Sed_ocean_storm s, double val)
gssize sed_ocean_storm_fprint (FILE *fp, Sed_ocean_storm s)


Define Documentation

#define SED_WAVE_H

Definition at line 2 of file sed_wave.h.


Function Documentation

new_handle ( Sed_ocean_storm   ) 

new_handle ( Sed_wave   ) 

double sed_dispersion_relation_frequency ( double  water_depth,
double  wave_number 
)

Definition at line 257 of file sed_wave.c.

References eh_nan(), eh_require, and sed_gravity().

Referenced by sed_gravity_wave_set_number().

double sed_dispersion_relation_wave_number ( double  water_depth,
double  frequency 
)

Solve the dispersion relation for wave number

The dispersion relation for gravity waves is

\[ \omega^2 = g \kappa \tanh\left( \kappa z \right) \]

where $ \omega $ is wave frequency, $ f $ is acceleration due to gravity, $ \kappa $ is wave number, and $ z $ is water depth.

Parameters:
water_depth Water depth in meters
frequency Wave frequencey in 1/s
Returns:
Wave number in 1/m

Definition at line 285 of file sed_wave.c.

References eh_nan(), eh_require, rtsafe(), and sed_dispersion_relation_wave_number_helper().

Referenced by sed_gravity_wave_set_frequency().

double sed_gravity_wave_deep_water_height ( Sed_wave  w  ) 

Definition at line 184 of file sed_wave.c.

References sed_gravity().

Referenced by sed_wave_break_depth().

double sed_gravity_wave_deep_water_wave_number ( Sed_wave  w  ) 

Definition at line 200 of file sed_wave.c.

References sed_gravity().

Sed_wave sed_gravity_wave_new ( Sed_wave  w_infinity,
double  h,
Sed_wave  new_wave 
)

Definition at line 166 of file sed_wave.c.

References sed_gravity_wave_set_frequency(), sed_gravity_wave_set_height(), and sed_wave_new().

Referenced by get_sediment_flux(), get_time_step(), update_bruun_zone_data(), and wave_break_helper().

Sed_wave sed_gravity_wave_set_frequency ( Sed_wave  a,
double  w,
double  h 
)

Definition at line 135 of file sed_wave.c.

References eh_require, and sed_dispersion_relation_wave_number().

Referenced by sed_gravity_wave_new().

Sed_wave sed_gravity_wave_set_height ( Sed_wave  w,
Sed_wave  w_infinity,
double  h 
)

Definition at line 155 of file sed_wave.c.

References sed_wave_phase_velocity().

Referenced by sed_gravity_wave_new().

Sed_wave sed_gravity_wave_set_number ( Sed_wave  w,
double  k,
double  h 
)

Definition at line 145 of file sed_wave.c.

References eh_require, and sed_dispersion_relation_frequency().

Sed_ocean_storm sed_ocean_storm_destroy ( Sed_ocean_storm  s  ) 

Definition at line 338 of file sed_wave.c.

References eh_free, and sed_wave_destroy().

Referenced by __free_slist_ocean_storm_data().

double sed_ocean_storm_duration ( Sed_ocean_storm  s  ) 

Definition at line 348 of file sed_wave.c.

Referenced by average_storms(), run_storm(), run_xshore(), and xshore().

double sed_ocean_storm_duration_in_seconds ( Sed_ocean_storm  s  ) 

Definition at line 363 of file sed_wave.c.

References S_SECONDS_PER_DAY.

gssize sed_ocean_storm_fprint ( FILE *  fp,
Sed_ocean_storm  s 
)

Definition at line 427 of file sed_wave.c.

References eh_require, sed_wave_height(), sed_wave_length(), and sed_wave_period().

Referenced by print_ocean_storm_list().

gssize sed_ocean_storm_index ( Sed_ocean_storm  s  ) 

Definition at line 353 of file sed_wave.c.

Referenced by average_storms(), cmp_storm_time(), and get_equivalent_storm().

Sed_ocean_storm sed_ocean_storm_new ( void   ) 

Definition at line 324 of file sed_wave.c.

References NEW_OBJECT, and sed_wave_new().

Referenced by average_storms(), and get_equivalent_storm().

double sed_ocean_storm_phase_velocity ( Sed_ocean_storm  s  ) 

Definition at line 393 of file sed_wave.c.

References sed_wave_phase_velocity().

Sed_ocean_storm sed_ocean_storm_set_duration ( Sed_ocean_storm  s,
double  dt_in_days 
)

Definition at line 413 of file sed_wave.c.

Referenced by average_storms(), and get_equivalent_storm().

Sed_ocean_storm sed_ocean_storm_set_index ( Sed_ocean_storm  s,
gssize  ind 
)

Definition at line 406 of file sed_wave.c.

Referenced by average_storms(), and get_equivalent_storm().

Sed_ocean_storm sed_ocean_storm_set_val ( Sed_ocean_storm  s,
double  val 
)

Definition at line 420 of file sed_wave.c.

Referenced by average_storms(), and get_equivalent_storm().

Sed_ocean_storm sed_ocean_storm_set_wave ( Sed_ocean_storm  s,
Sed_wave  w 
)

Definition at line 398 of file sed_wave.c.

References eh_require, and sed_wave_copy().

Referenced by set_ocean_storm_wave().

double sed_ocean_storm_val ( Sed_ocean_storm  s  ) 

Definition at line 358 of file sed_wave.c.

Referenced by average_storms(), cmp_storm_size(), and set_ocean_storm_wave().

double sed_ocean_storm_wave_freq ( Sed_ocean_storm  s  ) 

Definition at line 383 of file sed_wave.c.

References sed_wave_frequency().

Referenced by xshore().

double sed_ocean_storm_wave_height ( Sed_ocean_storm  s  ) 

Definition at line 368 of file sed_wave.c.

References sed_wave_height().

Referenced by is_worth_running(), run_storm(), run_xshore(), and xshore().

double sed_ocean_storm_wave_length ( Sed_ocean_storm  s  ) 

Definition at line 378 of file sed_wave.c.

References sed_wave_length().

Referenced by run_storm().

double sed_ocean_storm_wave_number ( Sed_ocean_storm  s  ) 

Definition at line 373 of file sed_wave.c.

References sed_wave_number().

Referenced by xshore().

double sed_ocean_storm_wave_period ( Sed_ocean_storm  s  ) 

Definition at line 388 of file sed_wave.c.

References sed_wave_period().

Referenced by run_storm().

double sed_wave_break_depth ( Sed_wave  w  ) 

Definition at line 205 of file sed_wave.c.

References rtsafe(), sed_gravity(), sed_gravity_wave_deep_water_height(), and sed_wave_break_depth_helper().

Referenced by get_closure_depth(), and get_max_erosion_profile().

Sed_wave sed_wave_copy ( Sed_wave  dest,
Sed_wave  src 
)

Definition at line 43 of file sed_wave.c.

References eh_require, and sed_wave_new().

Referenced by sed_ocean_storm_set_wave(), and sed_wave_dup().

Sed_wave sed_wave_destroy ( Sed_wave  w  ) 

Definition at line 91 of file sed_wave.c.

References eh_free.

Referenced by get_time_step(), sed_ocean_storm_destroy(), update_bruun_zone_data(), and xshore().

Sed_wave sed_wave_dup ( Sed_wave  src  ) 

Definition at line 64 of file sed_wave.c.

References sed_wave_copy().

double sed_wave_frequency ( Sed_wave  w  ) 

Definition at line 113 of file sed_wave.c.

Referenced by near_bed_velocity_func_komar(), sed_ocean_storm_wave_freq(), and sed_wave_is_bad().

double sed_wave_height ( Sed_wave  w  ) 

Definition at line 98 of file sed_wave.c.

Referenced by get_breaking_wave_depth(), get_h_c(), near_bed_velocity_func_komar(), near_bed_velocity_func_mean(), near_bed_velocity_func_stokes(), sed_ocean_storm_fprint(), sed_ocean_storm_wave_height(), sed_wave_is_bad(), and wave_break_helper().

gboolean sed_wave_is_bad ( Sed_wave  w  ) 

Definition at line 128 of file sed_wave.c.

References eh_isnan(), sed_wave_frequency(), sed_wave_height(), and sed_wave_number().

Referenced by diffuse_cols(), get_breaking_wave_depth(), get_sediment_flux(), get_time_step(), and xshore().

gboolean sed_wave_is_breaking ( Sed_wave  w,
double  h 
)

Definition at line 179 of file sed_wave.c.

References sed_wave_length().

gboolean sed_wave_is_same ( Sed_wave  w_1,
Sed_wave  w_2 
)

Definition at line 69 of file sed_wave.c.

References eh_require.

double sed_wave_length ( Sed_wave  w  ) 

Definition at line 108 of file sed_wave.c.

Referenced by sed_ocean_storm_fprint(), sed_ocean_storm_wave_length(), and sed_wave_is_breaking().

Sed_wave sed_wave_new ( double  h,
double  k,
double  w 
)

A structure to describe an ocean storm

Definition at line 27 of file sed_wave.c.

References NEW_OBJECT.

Referenced by get_breaking_wave_depth(), get_sediment_flux(), sed_gravity_wave_new(), sed_ocean_storm_new(), sed_wave_copy(), set_ocean_storm_wave(), and xshore().

double sed_wave_number ( Sed_wave  w  ) 

Definition at line 103 of file sed_wave.c.

Referenced by near_bed_velocity_func_komar(), near_bed_velocity_func_stokes(), sed_ocean_storm_wave_number(), and sed_wave_is_bad().

double sed_wave_period ( Sed_wave  w  ) 

Definition at line 118 of file sed_wave.c.

Referenced by get_h_c(), get_sediment_flux(), sed_ocean_storm_fprint(), sed_ocean_storm_wave_period(), and update_bruun_zone_data().

double sed_wave_phase_velocity ( Sed_wave  w  ) 

Definition at line 123 of file sed_wave.c.

Referenced by near_bed_velocity_func_stokes(), sed_gravity_wave_set_height(), and sed_ocean_storm_phase_velocity().


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