neverworld_initialization subroutine, public subroutine, public neverworld_initialization::neverworld_initialize_topography (D, G, param_file, max_depth) neverworld_initialize_topography D D G G param_file param_file max_depth max_depth This subroutine sets up the Neverworld test case topography. g The dynamic horizontal grid type d Ocean bottom depth in the units of depth_max param_file Parameter file structure max_depth Maximum ocean depth in arbitrary units cosbell mom_error_handler::mom_mesg spike mom_fixed_initialization::mom_initialize_topography real function real function neverworld_initialization::cosbell (x, L) cosbell x x L L Returns the value of a cosine-bell function evaluated at x/L. x non-dimensional position l non-dimensional width neverworld_initialize_topography real function real function neverworld_initialization::spike (x, L) spike x x L L Returns the value of a sin-spike function evaluated at x/L. x non-dimensional position l non-dimensional width neverworld_initialize_thickness neverworld_initialize_topography real function real function neverworld_initialization::cone (x, x0, L, clip) cone x x x0 x0 L L clip clip Returns the value of a triangular function centered at x=x0 with value 1 and linearly decreasing to 0 at x=x0+/-L, and 0 otherwise. If clip is present the top of the cone is cut off at "clip", which effectively defaults to 1. x non-dimensional coordinate [nondim] x0 position of peak [nondim] l half-width of base of cone [nondim] clip clipping height of cone [nondim] circ_ridge ns_ridge real function real function neverworld_initialization::scurve (x, x0, L) scurve x x x0 x0 L L Returns an s-curve s(x) s.t. s(x0)<=0, s(x0+L)>=1 and cubic in between. x non-dimensional coordinate [nondim] x0 position of peak [nondim] l half-width of base of cone [nondim] cstprof real function real function neverworld_initialization::cstprof (x, x0, L, lf, bf, sf, sh) cstprof x x x0 x0 L L lf lf bf bf sf sf sh sh Returns a "coastal" profile. x non-dimensional coordinate [nondim] x0 position of peak [nondim] l width of profile [nondim] lf fraction of width that is "land" [nondim] bf fraction of width that is "beach" [nondim] sf fraction of width that is "continental slope" [nondim] sh depth of shelf as fraction of full depth [nondim] scurve ew_coast ns_coast real function real function neverworld_initialization::dist_line_fixed_x (x, y, x0, y0, y1) dist_line_fixed_x x x y y x0 x0 y0 y0 y1 y1 Distance between points x,y and a line segment (x0,y0) and (x0,y1). x non-dimensional x-coordinate [nondim] y non-dimensional y-coordinate [nondim] x0 x-position of line segment [nondim] y0 y-position of line segment end[nondim] y1 y-position of line segment end[nondim] dist_line_fixed_y ns_coast ns_ridge real function real function neverworld_initialization::dist_line_fixed_y (x, y, x0, x1, y0) dist_line_fixed_y x x y y x0 x0 x1 x1 y0 y0 Distance between points x,y and a line segment (x0,y0) and (x1,y0). x non-dimensional x-coordinate [nondim] y non-dimensional y-coordinate [nondim] x0 x-position of line segment end[nondim] x1 x-position of line segment end[nondim] y0 y-position of line segment [nondim] dist_line_fixed_x ew_coast real function real function neverworld_initialization::ns_coast (lon, lat, lon0, lat0, lat1, dlon, sh) ns_coast lon lon lat lat lon0 lon0 lat0 lat0 lat1 lat1 dlon dlon sh sh A "coast profile" applied in an N-S line from lon0,lat0 to lon0,lat1. lon Longitude [degrees_E] lat Latitude [degrees_N] lon0 Longitude of coast [degrees_E] lat0 Latitude of coast end [degrees_N] lat1 Latitude of coast end [degrees_N] dlon "Radius" of coast profile [degrees] sh depth of shelf as fraction of full depth [nondim] cstprof dist_line_fixed_x real function real function neverworld_initialization::ew_coast (lon, lat, lon0, lon1, lat0, dlat, sh) ew_coast lon lon lat lat lon0 lon0 lon1 lon1 lat0 lat0 dlat dlat sh sh A "coast profile" applied in an E-W line from lon0,lat0 to lon1,lat0. lon Longitude [degrees_E] lat Latitude [degrees_N] lon0 Longitude of coast end [degrees_E] lon1 Longitude of coast end [degrees_E] lat0 Latitude of coast [degrees_N] dlat "Radius" of coast profile [degrees] sh depth of shelf as fraction of full depth [nondim] cstprof dist_line_fixed_y real function real function neverworld_initialization::ns_ridge (lon, lat, lon0, lat0, lat1, dlon, rh) ns_ridge lon lon lat lat lon0 lon0 lat0 lat0 lat1 lat1 dlon dlon rh rh A NS ridge. lon Longitude [degrees_E] lat Latitude [degrees_N] lon0 Longitude of ridge center [degrees_E] lat0 Latitude of ridge end [degrees_N] lat1 Latitude of ridge end [degrees_N] dlon "Radius" of ridge profile [degrees] rh depth of ridge as fraction of full depth [nondim] cone dist_line_fixed_x real function real function neverworld_initialization::circ_ridge (lon, lat, lon0, lat0, ring_radius, ring_thickness, ridge_height) circ_ridge lon lon lat lat lon0 lon0 lat0 lat0 ring_radius ring_radius ring_thickness ring_thickness ridge_height ridge_height A circular ridge. lon Longitude [degrees_E] lat Latitude [degrees_N] lon0 Longitude of center of ring [degrees_E] lat0 Latitude of center of ring [degrees_N] ring_radius Radius of ring [degrees] ring_thickness Radial thickness of ring [degrees] ridge_height Ridge height as fraction of full depth [nondim] cone subroutine, public subroutine, public neverworld_initialization::neverworld_initialize_thickness (h, G, GV, US, param_file, eqn_of_state, P_ref) neverworld_initialize_thickness h h G G GV GV US US param_file param_file eqn_of_state eqn_of_state P_ref P_ref This subroutine initializes layer thicknesses for the Neverworld test case, by finding the depths of interfaces in a specified latitude-dependent temperature profile with an exponentially decaying thermocline on top of a linear stratification. g The ocean's grid structure. gv The ocean's vertical grid structure. us A dimensional unit scaling type h The thickness that is being initialized [H ~> m or kg m-2]. param_file A structure indicating the open file to parse for model parameter values. eqn_of_state Equation of state structure p_ref The coordinate-density reference pressure [R L2 T-2 ~> Pa]. mom_error_handler::mom_mesg spike mom_state_initialization::mom_initialize_state Initialization for the "Neverworld" configuration.