MOM6
|
Open boundary segment data structure.
Definition at line 103 of file MOM_open_boundary.F90.
Public variables and constants | |
logical | flather |
If true, applies Flather + Chapman radiation of barotropic gravity waves. More... | |
logical | radiation |
If true, 1D Orlanksi radiation boundary conditions are applied. If False, a gradient condition is applied. More... | |
logical | radiation_tan |
If true, 1D Orlanksi radiation boundary conditions are applied to tangential flows. More... | |
logical | radiation_grad |
If true, 1D Orlanksi radiation boundary conditions are applied to dudv and dvdx. More... | |
logical | oblique |
Oblique waves supported at radiation boundary. More... | |
logical | oblique_tan |
If true, 2D radiation boundary conditions are applied to tangential flows. More... | |
logical | oblique_grad |
If true, 2D radiation boundary conditions are applied to dudv and dvdx. More... | |
logical | nudged |
Optional supplement to radiation boundary. More... | |
logical | nudged_tan |
Optional supplement to nudge tangential velocity. More... | |
logical | nudged_grad |
Optional supplement to nudge normal gradient of tangential velocity. More... | |
logical | specified |
Boundary normal velocity fixed to external value. More... | |
logical | specified_tan |
Boundary tangential velocity fixed to external value. More... | |
logical | open |
Boundary is open for continuity solver. More... | |
logical | gradient |
Zero gradient at boundary. More... | |
logical | values_needed |
Whether or not any external OBC fields are needed. More... | |
logical | u_values_needed |
Whether or not external u OBC fields are needed. More... | |
logical | v_values_needed |
Whether or not external v OBC fields are needed. More... | |
logical | t_values_needed |
Whether or not external T OBC fields are needed. More... | |
logical | s_values_needed |
Whether or not external S OBC fields are needed. More... | |
logical | z_values_needed |
Whether or not external zeta OBC fields are needed. More... | |
logical | g_values_needed |
Whether or not external gradient OBC fields are needed. More... | |
integer | direction |
Boundary faces one of the four directions. More... | |
logical | is_n_or_s |
True if the OB is facing North or South and exists on this PE. More... | |
logical | is_e_or_w |
True if the OB is facing East or West and exists on this PE. More... | |
logical | is_e_or_w_2 |
True if the OB is facing East or West anywhere. More... | |
type(obc_segment_data_type), dimension(:), pointer | field =>NULL() |
OBC data. More... | |
integer | num_fields |
number of OBC data fields (e.g. u_normal,u_parallel and eta for Flather) More... | |
character(len=32), dimension(:), pointer | field_names =>NULL() |
field names for this segment More... | |
integer | is_obc |
i-indices of boundary segment. More... | |
integer | ie_obc |
i-indices of boundary segment. More... | |
integer | js_obc |
j-indices of boundary segment. More... | |
integer | je_obc |
j-indices of boundary segment. More... | |
real | velocity_nudging_timescale_in |
Nudging timescale on inflow [T ~> s]. More... | |
real | velocity_nudging_timescale_out |
Nudging timescale on outflow [T ~> s]. More... | |
logical | on_pe |
true if segment is located in the computational domain More... | |
logical | temp_segment_data_exists |
true if temperature data arrays are present More... | |
logical | salt_segment_data_exists |
true if salinity data arrays are present More... | |
real, dimension(:,:), pointer | cg =>NULL() |
The external gravity wave speed [L T-1 ~> m s-1] at OBC-points. More... | |
real, dimension(:,:), pointer | htot =>NULL() |
The total column thickness [H ~> m or kg m-2] at OBC-points. More... | |
real, dimension(:,:,:), pointer | h =>NULL() |
The cell thickness [H ~> m or kg m-2] at OBC-points. More... | |
real, dimension(:,:,:), pointer | normal_vel =>NULL() |
The layer velocity normal to the OB segment [L T-1 ~> m s-1]. More... | |
real, dimension(:,:,:), pointer | tangential_vel =>NULL() |
The layer velocity tangential to the OB segment [L T-1 ~> m s-1]. More... | |
real, dimension(:,:,:), pointer | tangential_grad =>NULL() |
The gradient of the velocity tangential to the OB segment [T-1 ~> s-1]. More... | |
real, dimension(:,:,:), pointer | normal_trans =>NULL() |
The layer transport normal to the OB segment [H L2 T-1 ~> m3 s-1]. More... | |
real, dimension(:,:), pointer | normal_vel_bt =>NULL() |
The barotropic velocity normal to the OB segment [L T-1 ~> m s-1]. More... | |
real, dimension(:,:), pointer | eta =>NULL() |
The sea-surface elevation along the segment [m]. More... | |
real, dimension(:,:,:), pointer | grad_normal =>NULL() |
The gradient of the normal flow along the segment times the grid spacing [L T-1 ~> m s-1]. More... | |
real, dimension(:,:,:), pointer | grad_tan =>NULL() |
The gradient of the tangential flow along the segment times the grid spacing [L T-1 ~> m s-1]. More... | |
real, dimension(:,:,:), pointer | grad_gradient =>NULL() |
The gradient of the gradient of tangential flow along the segment times the grid spacing [T-1 ~> s-1]. More... | |
real, dimension(:,:,:), pointer | rx_norm_rad =>NULL() |
The previous normal phase speed use for EW radiation OBC, in grid points per timestep [nondim]. More... | |
real, dimension(:,:,:), pointer | ry_norm_rad =>NULL() |
The previous normal phase speed use for NS radiation OBC, in grid points per timestep [nondim]. More... | |
real, dimension(:,:,:), pointer | rx_norm_obl =>NULL() |
The previous normal radiation coefficient for EW oblique OBCs [L2 T-2 ~> m2 s-2]. More... | |
real, dimension(:,:,:), pointer | ry_norm_obl =>NULL() |
The previous normal radiation coefficient for NS oblique OBCs [L2 T-2 ~> m2 s-2]. More... | |
real, dimension(:,:,:), pointer | cff_normal =>NULL() |
The denominator for oblique radiation for normal velocity [L2 T-2 ~> m2 s-2]. More... | |
real, dimension(:,:,:), pointer | nudged_normal_vel =>NULL() |
The layer velocity normal to the OB segment that values should be nudged towards [L T-1 ~> m s-1]. More... | |
real, dimension(:,:,:), pointer | nudged_tangential_vel =>NULL() |
The layer velocity tangential to the OB segment that values should be nudged towards [L T-1 ~> m s-1]. More... | |
real, dimension(:,:,:), pointer | nudged_tangential_grad =>NULL() |
The layer dvdx or dudy towards which nudging can occur [T-1 ~> s-1]. More... | |
type(segment_tracer_registry_type), pointer | tr_reg => NULL() |
A pointer to the tracer registry for the segment. More... | |
type(hor_index_type) | hi |
Horizontal index ranges. More... | |
real | tr_invlscale_out |
An effective inverse length scale for restoring the tracer concentration in a ficticious reservior towards interior values when flow is exiting the domain [L-1 ~> m-1]. More... | |
real | tr_invlscale_in |
An effective inverse length scale for restoring the tracer concentration towards an externally imposed value when flow is entering [L-1 ~> m-1]. More... | |
real, dimension(:,:,:), pointer mom_open_boundary::obc_segment_type::cff_normal =>NULL() |
The denominator for oblique radiation for normal velocity [L2 T-2 ~> m2 s-2].
Definition at line 175 of file MOM_open_boundary.F90.
real, dimension(:,:), pointer mom_open_boundary::obc_segment_type::cg =>NULL() |
The external gravity wave speed [L T-1 ~> m s-1] at OBC-points.
Definition at line 146 of file MOM_open_boundary.F90.
integer mom_open_boundary::obc_segment_type::direction |
Boundary faces one of the four directions.
Definition at line 130 of file MOM_open_boundary.F90.
real, dimension(:,:), pointer mom_open_boundary::obc_segment_type::eta =>NULL() |
The sea-surface elevation along the segment [m].
Definition at line 160 of file MOM_open_boundary.F90.
type(obc_segment_data_type), dimension(:), pointer mom_open_boundary::obc_segment_type::field =>NULL() |
OBC data.
Definition at line 134 of file MOM_open_boundary.F90.
character(len=32), dimension(:), pointer mom_open_boundary::obc_segment_type::field_names =>NULL() |
field names for this segment
Definition at line 136 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::flather |
If true, applies Flather + Chapman radiation of barotropic gravity waves.
Definition at line 104 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::g_values_needed |
Whether or not external gradient OBC fields are needed.
Definition at line 129 of file MOM_open_boundary.F90.
real, dimension(:,:,:), pointer mom_open_boundary::obc_segment_type::grad_gradient =>NULL() |
The gradient of the gradient of tangential flow along the segment times the grid spacing [T-1 ~> s-1].
Definition at line 165 of file MOM_open_boundary.F90.
real, dimension(:,:,:), pointer mom_open_boundary::obc_segment_type::grad_normal =>NULL() |
The gradient of the normal flow along the segment times the grid spacing [L T-1 ~> m s-1].
Definition at line 161 of file MOM_open_boundary.F90.
real, dimension(:,:,:), pointer mom_open_boundary::obc_segment_type::grad_tan =>NULL() |
The gradient of the tangential flow along the segment times the grid spacing [L T-1 ~> m s-1].
Definition at line 163 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::gradient |
Zero gradient at boundary.
Definition at line 122 of file MOM_open_boundary.F90.
real, dimension(:,:,:), pointer mom_open_boundary::obc_segment_type::h =>NULL() |
The cell thickness [H ~> m or kg m-2] at OBC-points.
Definition at line 149 of file MOM_open_boundary.F90.
type(hor_index_type) mom_open_boundary::obc_segment_type::hi |
Horizontal index ranges.
Definition at line 184 of file MOM_open_boundary.F90.
real, dimension(:,:), pointer mom_open_boundary::obc_segment_type::htot =>NULL() |
The total column thickness [H ~> m or kg m-2] at OBC-points.
Definition at line 148 of file MOM_open_boundary.F90.
integer mom_open_boundary::obc_segment_type::ie_obc |
i-indices of boundary segment.
Definition at line 138 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::is_e_or_w |
True if the OB is facing East or West and exists on this PE.
Definition at line 132 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::is_e_or_w_2 |
True if the OB is facing East or West anywhere.
Definition at line 133 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::is_n_or_s |
True if the OB is facing North or South and exists on this PE.
Definition at line 131 of file MOM_open_boundary.F90.
integer mom_open_boundary::obc_segment_type::is_obc |
i-indices of boundary segment.
Definition at line 137 of file MOM_open_boundary.F90.
integer mom_open_boundary::obc_segment_type::je_obc |
j-indices of boundary segment.
Definition at line 140 of file MOM_open_boundary.F90.
integer mom_open_boundary::obc_segment_type::js_obc |
j-indices of boundary segment.
Definition at line 139 of file MOM_open_boundary.F90.
real, dimension(:,:,:), pointer mom_open_boundary::obc_segment_type::normal_trans =>NULL() |
The layer transport normal to the OB segment [H L2 T-1 ~> m3 s-1].
Definition at line 156 of file MOM_open_boundary.F90.
real, dimension(:,:,:), pointer mom_open_boundary::obc_segment_type::normal_vel =>NULL() |
The layer velocity normal to the OB segment [L T-1 ~> m s-1].
Definition at line 150 of file MOM_open_boundary.F90.
real, dimension(:,:), pointer mom_open_boundary::obc_segment_type::normal_vel_bt =>NULL() |
The barotropic velocity normal to the OB segment [L T-1 ~> m s-1].
Definition at line 158 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::nudged |
Optional supplement to radiation boundary.
Definition at line 116 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::nudged_grad |
Optional supplement to nudge normal gradient of tangential velocity.
Definition at line 118 of file MOM_open_boundary.F90.
real, dimension(:,:,:), pointer mom_open_boundary::obc_segment_type::nudged_normal_vel =>NULL() |
The layer velocity normal to the OB segment that values should be nudged towards [L T-1 ~> m s-1].
Definition at line 177 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::nudged_tan |
Optional supplement to nudge tangential velocity.
Definition at line 117 of file MOM_open_boundary.F90.
real, dimension(:,:,:), pointer mom_open_boundary::obc_segment_type::nudged_tangential_grad =>NULL() |
The layer dvdx or dudy towards which nudging can occur [T-1 ~> s-1].
Definition at line 181 of file MOM_open_boundary.F90.
real, dimension(:,:,:), pointer mom_open_boundary::obc_segment_type::nudged_tangential_vel =>NULL() |
The layer velocity tangential to the OB segment that values should be nudged towards [L T-1 ~> m s-1].
Definition at line 179 of file MOM_open_boundary.F90.
integer mom_open_boundary::obc_segment_type::num_fields |
number of OBC data fields (e.g. u_normal,u_parallel and eta for Flather)
Definition at line 135 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::oblique |
Oblique waves supported at radiation boundary.
Definition at line 111 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::oblique_grad |
If true, 2D radiation boundary conditions are applied to dudv and dvdx.
Definition at line 114 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::oblique_tan |
If true, 2D radiation boundary conditions are applied to tangential flows.
Definition at line 112 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::on_pe |
true if segment is located in the computational domain
Definition at line 143 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::open |
Boundary is open for continuity solver.
Definition at line 121 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::radiation |
If true, 1D Orlanksi radiation boundary conditions are applied. If False, a gradient condition is applied.
Definition at line 105 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::radiation_grad |
If true, 1D Orlanksi radiation boundary conditions are applied to dudv and dvdx.
Definition at line 109 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::radiation_tan |
If true, 1D Orlanksi radiation boundary conditions are applied to tangential flows.
Definition at line 107 of file MOM_open_boundary.F90.
real, dimension(:,:,:), pointer mom_open_boundary::obc_segment_type::rx_norm_obl =>NULL() |
The previous normal radiation coefficient for EW oblique OBCs [L2 T-2 ~> m2 s-2].
Definition at line 171 of file MOM_open_boundary.F90.
real, dimension(:,:,:), pointer mom_open_boundary::obc_segment_type::rx_norm_rad =>NULL() |
The previous normal phase speed use for EW radiation OBC, in grid points per timestep [nondim].
Definition at line 167 of file MOM_open_boundary.F90.
real, dimension(:,:,:), pointer mom_open_boundary::obc_segment_type::ry_norm_obl =>NULL() |
The previous normal radiation coefficient for NS oblique OBCs [L2 T-2 ~> m2 s-2].
Definition at line 173 of file MOM_open_boundary.F90.
real, dimension(:,:,:), pointer mom_open_boundary::obc_segment_type::ry_norm_rad =>NULL() |
The previous normal phase speed use for NS radiation OBC, in grid points per timestep [nondim].
Definition at line 169 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::s_values_needed |
Whether or not external S OBC fields are needed.
Definition at line 127 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::salt_segment_data_exists |
true if salinity data arrays are present
Definition at line 145 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::specified |
Boundary normal velocity fixed to external value.
Definition at line 119 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::specified_tan |
Boundary tangential velocity fixed to external value.
Definition at line 120 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::t_values_needed |
Whether or not external T OBC fields are needed.
Definition at line 126 of file MOM_open_boundary.F90.
real, dimension(:,:,:), pointer mom_open_boundary::obc_segment_type::tangential_grad =>NULL() |
The gradient of the velocity tangential to the OB segment [T-1 ~> s-1].
Definition at line 154 of file MOM_open_boundary.F90.
real, dimension(:,:,:), pointer mom_open_boundary::obc_segment_type::tangential_vel =>NULL() |
The layer velocity tangential to the OB segment [L T-1 ~> m s-1].
Definition at line 152 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::temp_segment_data_exists |
true if temperature data arrays are present
Definition at line 144 of file MOM_open_boundary.F90.
real mom_open_boundary::obc_segment_type::tr_invlscale_in |
An effective inverse length scale for restoring the tracer concentration towards an externally imposed value when flow is entering [L-1 ~> m-1].
Definition at line 189 of file MOM_open_boundary.F90.
real mom_open_boundary::obc_segment_type::tr_invlscale_out |
An effective inverse length scale for restoring the tracer concentration in a ficticious reservior towards interior values when flow is exiting the domain [L-1 ~> m-1].
Definition at line 185 of file MOM_open_boundary.F90.
type(segment_tracer_registry_type), pointer mom_open_boundary::obc_segment_type::tr_reg => NULL() |
A pointer to the tracer registry for the segment.
Definition at line 183 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::u_values_needed |
Whether or not external u OBC fields are needed.
Definition at line 124 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::v_values_needed |
Whether or not external v OBC fields are needed.
Definition at line 125 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::values_needed |
Whether or not any external OBC fields are needed.
Definition at line 123 of file MOM_open_boundary.F90.
real mom_open_boundary::obc_segment_type::velocity_nudging_timescale_in |
Nudging timescale on inflow [T ~> s].
Definition at line 141 of file MOM_open_boundary.F90.
real mom_open_boundary::obc_segment_type::velocity_nudging_timescale_out |
Nudging timescale on outflow [T ~> s].
Definition at line 142 of file MOM_open_boundary.F90.
logical mom_open_boundary::obc_segment_type::z_values_needed |
Whether or not external zeta OBC fields are needed.
Definition at line 128 of file MOM_open_boundary.F90.