New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
Changeset 6808 for branches/NERC/dev_r5549_BDY_ZEROGRAD/NEMOGCM/TOOLS/SIREN/src/filter.f90 – NEMO

Ignore:
Timestamp:
2016-07-19T10:38:35+02:00 (8 years ago)
Author:
jamesharle
Message:

merge with trunk@6232 for consistency with SSB code

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/NERC/dev_r5549_BDY_ZEROGRAD/NEMOGCM/TOOLS/SIREN/src/filter.f90

    r5037 r6808  
    1818!>          - rad > cutoff : @f$ filter=0 @f$                
    1919!>       - 'blackman' 
    20 !>          - rad < cutoff : @f$ filter=0.42 + 0.5*COS(\pi*\frac{rad}{cutoff}) + 0.08*COS(2\pi*\frac{rad}{cutoff}) @f$ 
     20!>          - rad < cutoff : @f$ filter=0.42 + 0.5*COS(\pi*\frac{rad}{cutoff}) +  
     21!>                                      0.08*COS(2\pi*\frac{rad}{cutoff}) @f$ 
    2122!>          - rad > cutoff : @f$ filter=0 @f$ 
    2223!>       - 'gauss' 
     
    2930!> 
    3031!>    td_var\%c_filter(2) string character is the number of turn to be done<br/> 
    31 !>    td_var\%c_filter(3) string character is the cut-off frequency (count in number of mesh grid)<br/> 
    32 !>    td_var\%c_filter(4) string character is the halo radius (count in number of mesh grid)<br/> 
    33 !>    td_var\%c_filter(5) string character is the alpha parameter (for gauss and butterworth method)<br/> 
     32!>    td_var\%c_filter(3) string character is the cut-off frequency  
     33! >                       (count in number of mesh grid)<br/> 
     34!>    td_var\%c_filter(4) string character is the halo radius  
     35!>                        (count in number of mesh grid)<br/> 
     36!>    td_var\%c_filter(5) string character is the alpha parameter  
     37!>                        (for gauss and butterworth method)<br/> 
    3438!>     
    3539!>    @note Filter method could be specify for each variable in namelist _namvar_, 
     
    4044!>    The number of turn is specify using '*' separator.<br/> 
    4145!>    Example: 
    42 !>       - cn_varinfo='varname1:2*hamming(@f$cutoff@f$,@f$radius@f$)', 'varname2:gauss(@f$cutoff@f$,@f$radius@f$,@f$\alpha@f$)' 
     46!>       - cn_varinfo='varname1:flt=2*hamming(@f$cutoff@f$,@f$radius@f$)',  
     47!>                    'varname2:flt=gauss(@f$cutoff@f$,@f$radius@f$,@f$\alpha@f$)' 
    4348!> 
    4449!>    to filter variable value:<br/> 
     
    106111   !> 
    107112   !> @author J.Paul 
    108    !> - November, 2013- Initial Version 
     113   !> @date November, 2013 - Initial Version 
    109114   ! 
    110115   !> @param[inout] td_var variable structure  
     
    250255   !> 
    251256   !> @author J.Paul 
    252    !> - November, 2013- Initial Version 
     257   !> @date November, 2013 - Initial Version 
    253258   ! 
    254259   !> @param[inout] td_var variable  
     
    296301 
    297302      !3-extrapolate 
    298       CALL extrap_fill_value( td_var, id_iext=id_radius, id_jext=id_radius ) 
     303      CALL extrap_fill_value( td_var ) !, id_iext=id_radius, id_jext=id_radius ) 
    299304 
    300305      !4-filtering 
     
    341346   ! 
    342347   !> @author J.Paul 
    343    !> - November, 2013- Initial Version 
     348   !> @date November, 2013 - Initial Version 
    344349   ! 
    345350   !> @param[inout] dd_value  array of value to be filtered  
     
    393398   !> 
    394399   !> @author J.Paul 
    395    !> - November, 2013- Initial Version 
     400   !> @date November, 2013 - Initial Version 
    396401   ! 
    397402   !> @param[inout] dd_value  array of value to be filtered  
     
    439444   !> 
    440445   !> @author J.Paul 
    441    !> - November, 2013- Initial Version 
     446   !> @date November, 2013 - Initial Version 
    442447   ! 
    443448   !> @param[inout] dd_value  array of value to be filtered  
     
    482487   !> 
    483488   !> @author J.Paul 
    484    !> - November, 2013- Initial Version 
     489   !> @date November, 2013 - Initial Version 
    485490   ! 
    486491   !> @param[inout] dd_value  array of value to be filtered  
     
    537542   !> 
    538543   !> @author J.Paul 
    539    !> - Nov, 2013- Initial Version 
     544   !> @date November, 2013 - Initial Version 
    540545   ! 
    541546   !> @param[inout] dd_value  array of value to be filtered  
     
    590595   ! 
    591596   !> @author J.Paul 
    592    !> - November, 2013- Initial Version 
     597   !> @date November, 2013 - Initial Version 
    593598   ! 
    594599   !> @param[in] cd_name   filter name 
     
    649654   ! 
    650655   !> @author J.Paul 
    651    !> - November, 2013- Initial Version 
     656   !> @date November, 2013 - Initial Version 
    652657   ! 
    653658   !> @param[in] cd_name   filter name 
     
    695700   ! 
    696701   !> @author J.Paul 
    697    !> - November, 2013- Initial Version 
     702   !> @date November, 2013 - Initial Version 
    698703   ! 
    699704   !> @param[in] dd_cutoff cut-off frequency 
     
    749754   ! 
    750755   !> @author J.Paul 
    751    !> - November, 2013- Initial Version 
     756   !> @date November, 2013 - Initial Version 
    752757   ! 
    753758   !> @param[in] dd_cutoff cut-off frequency 
     
    808813   ! 
    809814   !> @author J.Paul 
    810    !> - November, 2013- Initial Version 
     815   !> @date November, 2013 - Initial Version 
    811816   ! 
    812817   !> @param[in] dd_cutoff cut-off frequency 
     
    863868   ! 
    864869   !> @author J.Paul 
    865    !> - November, 2013- Initial Version 
     870   !> @date November, 2013 - Initial Version 
    866871   ! 
    867872   !> @param[in] dd_cutoff cut-off frequency 
     
    922927   ! 
    923928   !> @author J.Paul 
    924    !> - November, 2013- Initial Version 
     929   !> @date November, 2013 - Initial Version 
    925930   ! 
    926931   !> @param[in] dd_cutoff cut-off frequency 
     
    978983   !> 
    979984   !> @author J.Paul 
    980    !> - November, 2013- Initial Version 
     985   !> @date November, 2013 - Initial Version 
    981986   !> 
    982987   !> @param[in] dd_cutoff cut-off frequency 
     
    10381043   !> 
    10391044   !> @author J.Paul 
    1040    !> - November, 2013- Initial Version 
     1045   !> @date November, 2013 - Initial Version 
    10411046   !> 
    10421047   !> @param[in] dd_cutoff cut-off frequency 
     
    10901095   !> 
    10911096   !> @author J.Paul 
    1092    !> - November, 2013- Initial Version 
     1097   !> @date November, 2013 - Initial Version 
    10931098   !> 
    10941099   !> @param[in] dd_cutoff cut-off frequency 
     
    11461151   !> 
    11471152   !> @author J.Paul 
    1148    !> - November, 2013- Initial Version 
     1153   !> @date November, 2013 - Initial Version 
    11491154   !> 
    11501155   !> @param[in] dd_cutoff cut-off frequency 
     
    11981203   !> 
    11991204   !> @author J.Paul 
    1200    !> - November, 2013- Initial Version 
     1205   !> @date November, 2013 - Initial Version 
    12011206   !> 
    12021207   !> @param[in] dd_cutoff cut-off frequency 
Note: See TracChangeset for help on using the changeset viewer.