sbf_DCCM2012 Function

  1. mod_source_functions.f90
  2. mod_source_functions
  3. sbf_DCCM2012

public pure elemental function sbf_DCCM2012(spectrum, friction_coefficient, percolation_coefficient) result(tendency)

proc~~sbf_dccm2012~~UsesGraph proc~sbf_dccm2012 sbf_DCCM2012 module~mod_spectrum mod_spectrum module~mod_spectrum->proc~sbf_dccm2012 json_module json_module json_module->module~mod_spectrum module~mod_utility mod_utility module~mod_utility->module~mod_spectrum module~mod_precision mod_precision module~mod_precision->module~mod_spectrum module~mod_precision->module~mod_utility module~mod_const mod_const module~mod_precision->module~mod_const datetime_module datetime_module datetime_module->module~mod_spectrum module~mod_const->module~mod_spectrum iso_c_binding iso_c_binding iso_c_binding->module~mod_spectrum iso_fortran_env iso_fortran_env iso_fortran_env->module~mod_precision
Help

Returns a spectrum instance with the wave dissipation tendency due to bottom friction and percolation, formulated by Donelan et al. (2012).

The result instance has the units of 1/s. If the mean water depth and wavenumber arrays are constant, this source function can be evaluated once and stored. Otherwise, the function must be re-evaluated if the mean water depth or wavenumber array change.

References:

Donelan, M. A., M. Curcic, S. S. Chen, and A. K. Magnusson, 2012: Modeling waves and wind stress, J. Geophys. Res. Oceans, 117, C00J23, doi:10.1029/2011JC007787.

Shemdin, P., K. Hasselmann, S. V. Hsiao, and K. Herterich, 1978: Non-linear and linear bottom interaction effects in shallow water, p347-372 in: Turbulent fluxes through the sea surface, wave dynamics and prediction, A. Favre and K. Hasselmann (eds), Plenum, New York, 677p.

Arguments

Type IntentOptional AttributesName
type(spectrum_type), intent(in) :: spectrum

Spectrum instance
real(kind=rk), intent(in) :: friction_coefficient

Bottom friction coefficient [m/s]
real(kind=rk), intent(in) :: percolation_coefficient

Bottom permeability coefficient [m/s]

Return Value type(spectrum_type)

Result tendency instance

Calls

proc~~sbf_dccm2012~~CallsGraph proc~sbf_dccm2012 sbf_DCCM2012 getdepth getdepth proc~sbf_dccm2012->getdepth getwavenumber2d getwavenumber2d proc~sbf_dccm2012->getwavenumber2d
Help

Source Code

sbf_DCCM2012

Source Code

pure elemental function sbf_DCCM2012(spectrum,friction_coefficient,&
  percolation_coefficient) result(tendency)

  !! Returns a spectrum instance with the wave dissipation tendency due to
  !! bottom friction and percolation, formulated by Donelan et al. (2012).
  !!
  !! The result instance has the units of 1/s. If the mean water depth and
  !! wavenumber arrays are constant, this source function can be evaluated once
  !! and stored. Otherwise, the function must be re-evaluated if the mean water
  !! depth or wavenumber array change.
  !!
  !! References:
  !!
  !! Donelan, M. A., M. Curcic, S. S. Chen, and A. K. Magnusson, 2012: Modeling
  !! waves and wind stress, *J. Geophys. Res. Oceans*, **117**, C00J23,
  !! doi:10.1029/2011JC007787.
  !!
  !! Shemdin, P., K. Hasselmann, S. V. Hsiao, and K. Herterich, 1978: Non-linear
  !! and linear bottom interaction effects in shallow water, p347-372 in:
  !! Turbulent fluxes through the sea surface, wave dynamics and prediction, A.
  !! Favre and K. Hasselmann (eds), Plenum, New York, 677p.

  use mod_spectrum,only:spectrum_type

  type(spectrum_type),intent(in) :: spectrum
    !! Spectrum instance
  real(kind=rk),intent(in) :: friction_coefficient
    !! Bottom friction coefficient [m/s]
  real(kind=rk),intent(in) :: percolation_coefficient
    !! Bottom permeability coefficient [m/s]
  type(spectrum_type) :: tendency
    !! Result tendency instance

  real(kind=rk) :: d
  real(kind=rk),dimension(:,:),allocatable :: k

  d = spectrum % getDepth()
  k = spectrum % getWavenumber2d()

  tendency = friction_coefficient * k / sinh(2*k*d)&
           + percolation_coefficient / cosh(k*d)**2

endfunction sbf_DCCM2012

All Procedures

advect1dRank1 advect1dRank2 advect2dRank2 advectCentered2ndOrder advectCentered2ndOrder1dRank0 advectCentered2ndOrder1dRank1 advectCentered2ndOrder1dRank2 advectCentered2ndOrder2dRank0 advectCentered2ndOrder2dRank1 advectCentered2ndOrder2dRank2 advectUpwind1stOrder advectUpwind1stOrder1dRank0 advectUpwind1stOrder1dRank1 advectUpwind1stOrder1dRank2 advectUpwind1stOrder2dRank0 advectUpwind1stOrder2dRank1 advectUpwind1stOrder2dRank2 assign_array_1d assign_array_2d assign_spectrum_array_1d assign_spectrum_array_2d backward_euler backward_euler_domain backward_euler_spectrum constructor constructor constructor_1d constructor_2d diff diff_1d diff_2d diff_periodic diff_periodic_1d diff_periodic_2d domain_add_domain domain_add_real domain_div_domain domain_div_real domain_mult_domain domain_mult_real domain_sub_domain domain_sub_real domain_type domain_unary_minus donelanHamiltonHui donelanHamiltonHuiDirectionalSpectrum donelanHamiltonHuiDirectionalSpreading elevation eq eq exact_exponential exact_exponential_domain exact_exponential_spectrum forward_euler forward_euler_domain forward_euler_spectrum frequencyMoment frequencyMoment ge getAirDensity getAirDensity getAmplitude getAxisX getAxisY getCurrent_u getCurrent_u getCurrent_v getCurrent_v getDepth getDepth getDepthLevels getDirections getDirections getDirections2d getElevation getElevation getFrequency getFrequency getFrequency2d getGravity getGravity getGrid getGridRotation getGridSpacingX getGridSpacingXWithHalo getGridSpacingY getGridSpacingYWithHalo getGroupSpeed getGroupSpeed getGroupSpeed2d getLatitude getLongitude getLowerBounds getLowerBounds getPhaseSpeed getPhaseSpeed getPhaseSpeed2d getSpectrum getSpectrum getSpectrumArray getSurfaceTension getSurfaceTension getUpperBounds getUpperBounds getWaterDensity getWaterDensity getWaveAction getWavelength getWavenumber getWavenumber2d getWavenumberSpacing gravityClairaut grid_type gt horizontalAcceleration horizontalVelocity integrate integrate_domain integrate_spectrum isAllocated isAllocated isMonochromatic isOmnidirectional jonswap jonswapPeakFrequency le lt meanPeriod meanPeriod meanPeriodZeroCrossing meanPeriodZeroCrossing meanSquareSlope meanSquareSlopeDirectional momentum_x momentum_y momentumFlux_xx momentumFlux_xy momentumFlux_yy neq neq nondimensionalDepth nondimensionalEnergy nondimensionalFetch nondimensionalFrequency nondimensionalRoughness_H1986 nondimensionalRoughness_S1974 nondimensionalTime omnidirectionalSpectrum ones ones_int ones_real peakedness peakFrequency peakFrequencyDiscrete phillips piersonMoskowitz piersonMoskowitzPeakFrequency pressure range range_int range_real readJSON real2d_mult_spectrum real_add_domain real_add_spectrum real_div_domain real_div_spectrum real_mult_domain real_mult_spectrum real_sub_domain real_sub_spectrum saturationSpectrum sbf_DCCM2012 sbf_JONSWAP sds_DCCM2012 sdt_DCCM2012 setAirDensity setAirDensity setCurrent1d setCurrent2d setDepth setDepth setElevation setElevation setGravity setGravity setSpectrum1d setSpectrum1d setSpectrum2d setSpectrum2d setSpectrumArray1d1d setSpectrumArray1d2d setSpectrumArray2d2d setSurfaceTension setSurfaceTension setWaterDensity setWaterDensity significantSurfaceOrbitalVelocity significantWaveHeight significantWaveHeight sin_DCCM2012 snl_DCCM2012 spectrum_add_real spectrum_add_spectrum spectrum_div_real spectrum_div_spectrum spectrum_mult_real spectrum_mult_real2d spectrum_mult_spectrum spectrum_sub_real spectrum_sub_spectrum spectrum_type spectrum_unary_minus stokesDrift stokesDrift2d tile tile_1d_int tile_1d_real tile_2d_int tile_2d_real tile_3d_int tile_3d_real ursellNumber verticalAcceleration verticalVelocity waveAge wavenumber wavenumberMoment wavenumberMoment wavenumberSpectrum writeJSON writeJSON zeros zeros_int zeros_real