mom_ale_sponge mom_ale_sponge::ale_sponge_cs mom_ale_sponge::initialize_ale_sponge mom_ale_sponge::p2d mom_ale_sponge::p3d mom_ale_sponge::set_up_ale_sponge_field mom_ale_sponge::set_up_ale_sponge_vel_field subroutine subroutine mom_ale_sponge::initialize_ale_sponge_fixed (Iresttime, G, param_file, CS, data_h, nz_data) initialize_ale_sponge_fixed Iresttime Iresttime G G param_file param_file CS CS data_h data_h nz_data nz_data This subroutine determines the number of points which are within sponges in this computational domain. Only points that have positive values of Iresttime and which mask2dT indicates are ocean points are included in the sponges. It also stores the target interface heights. g The ocean's grid structure. nz_data The total number of sponge input layers. iresttime The inverse of the restoring time [T-1 ~> s-1]. param_file A structure indicating the open file to parse for model parameter values. cs A pointer that is set to point to the control structure for this module (in/out). data_h The thicknesses of the sponge input layers [H ~> m or kg m-2]. mom_remapping::initialize_remapping mom_error_handler::mom_error rotate_ale_sponge integer function, public integer function, public mom_ale_sponge::get_ale_sponge_nz_data (CS) get_ale_sponge_nz_data CS CS Return the number of layers in the data with a fixed ALE sponge, or 0 if there are no sponge columns on this PE. cs A pointer that is set to point to the control structure for the ALE_sponge module. The number of layers in the fixed sponge data. rgc_tracer::initialize_rgc_tracer subroutine, public subroutine, public mom_ale_sponge::get_ale_sponge_thicknesses (G, data_h, sponge_mask, CS) get_ale_sponge_thicknesses G G data_h data_h sponge_mask sponge_mask CS CS Return the thicknesses used for the data with a fixed ALE sponge. g The ocean's grid structure (in). data_h The thicknesses of the sponge input layers [H ~> m or kg m-2]. sponge_mask A logical mask that is true where cs A pointer that is set to point to the control structure for the ALE_sponge module. mom_error_handler::mom_error subroutine subroutine mom_ale_sponge::initialize_ale_sponge_varying (Iresttime, G, param_file, CS) initialize_ale_sponge_varying Iresttime Iresttime G G param_file param_file CS CS This subroutine determines the number of points which are to be restoref in the computational domain. Only points that have positive values of Iresttime and which mask2dT indicates are ocean points are included in the sponges. g The ocean's grid structure. iresttime The inverse of the restoring time [T-1 ~> s-1]. param_file A structure indicating the open file to parse for model parameter values. cs A pointer that is set to point to the control structure for this module (in/out). mom_remapping::initialize_remapping mom_error_handler::mom_error rotate_ale_sponge subroutine, public subroutine, public mom_ale_sponge::init_ale_sponge_diags (Time, G, diag, CS) init_ale_sponge_diags Time Time G G diag diag CS CS Initialize diagnostics for the ALE_sponge module. time The current model time g The ocean's grid structure diag A structure that is used to regulate diagnostic output. cs ALE sponge control structure mom::initialize_mom subroutine subroutine mom_ale_sponge::set_up_ale_sponge_field_fixed (sp_val, G, f_ptr, CS) set_up_ale_sponge_field_fixed sp_val sp_val G G f_ptr f_ptr CS CS This subroutine stores the reference profile at h points for the variable whose address is given by f_ptr. g Grid structure cs ALE sponge control structure (in/out). sp_val Field to be used in the sponge, it has arbitrary number of layers. f_ptr Pointer to the field to be damped mom_error_handler::mom_error subroutine subroutine mom_ale_sponge::set_up_ale_sponge_field_varying (filename, fieldname, Time, G, GV, US, f_ptr, CS) set_up_ale_sponge_field_varying filename filename fieldname fieldname Time Time G G GV GV US US f_ptr f_ptr CS CS This subroutine stores the reference profile at h points for the variable whose address is given by filename and fieldname. filename The name of the file with the time varying field data fieldname The name of the field in the file with the time varying field data time The current model time g Grid structure (in). gv ocean vertical grid structure us A dimensional unit scaling type f_ptr Pointer to the field to be damped (in). cs Sponge control structure (in/out). mom_error_handler::mom_error subroutine subroutine mom_ale_sponge::set_up_ale_sponge_vel_field_fixed (u_val, v_val, G, u_ptr, v_ptr, CS) set_up_ale_sponge_vel_field_fixed u_val u_val v_val v_val G G u_ptr u_ptr v_ptr v_ptr CS CS This subroutine stores the reference profile at u and v points for the variable whose address is given by u_ptr and v_ptr. g Grid structure (in). cs Sponge structure (in/out). u_val u field to be used in the sponge, it has arbritary number of layers. v_val v field to be used in the sponge, it has arbritary number of layers. u_ptr u pointer to the field to be damped v_ptr v pointer to the field to be damped subroutine subroutine mom_ale_sponge::set_up_ale_sponge_vel_field_varying (filename_u, fieldname_u, filename_v, fieldname_v, Time, G, US, CS, u_ptr, v_ptr) set_up_ale_sponge_vel_field_varying filename_u filename_u fieldname_u fieldname_u filename_v filename_v fieldname_v fieldname_v Time Time G G US US CS CS u_ptr u_ptr v_ptr v_ptr This subroutine stores the reference profile at uand v points for the variable whose address is given by u_ptr and v_ptr. filename_u File name for u field fieldname_u Name of u variable in file filename_v File name for v field fieldname_v Name of v variable in file time Model time g Ocean grid (in) us A dimensional unit scaling type cs Sponge structure (in/out). u_ptr u pointer to the field to be damped (in). v_ptr v pointer to the field to be damped (in). subroutine, public subroutine, public mom_ale_sponge::apply_ale_sponge (h, dt, G, GV, US, CS, Time) apply_ale_sponge h h dt dt G G GV GV US US CS CS Time Time This subroutine applies damping to the layers thicknesses, temp, salt and a variety of tracers for every column where there is damping. g The ocean's grid structure (in). gv ocean vertical grid structure us A dimensional unit scaling type h Layer thickness [H ~> m or kg m-2] (in) dt The amount of time covered by this call [T ~> s]. cs A pointer to the control structure for this module that is set by a previous call to initialize_ALE_sponge (in). time The current model date mom_error_handler::mom_error mom_remapping::remapping_core_h mom_diabatic_driver::diabatic_ale mom_diabatic_driver::diabatic_ale_legacy subroutine, public subroutine, public mom_ale_sponge::rotate_ale_sponge (sponge_in, G_in, sponge, G, turns, param_file) rotate_ale_sponge sponge_in sponge_in G_in G_in sponge sponge G G turns turns param_file param_file Rotate the ALE sponge fields from the input to the model index map. sponge_in The control structure for this module with the original grid rotation g_in The ocean's grid structure with the original rotation. sponge A pointer to the control that will be set up with the new grid rotation g The ocean's grid structure with the new rotation. turns The number of 90-degree turns between grids param_file A structure indicating the open file to parse for model parameter values. initialize_ale_sponge_fixed initialize_ale_sponge_varying mom_error_handler::mom_error subroutine, public subroutine, public mom_ale_sponge::update_ale_sponge_field (sponge, p_old, G, GV, p_new) update_ale_sponge_field sponge sponge p_old p_old G G GV GV p_new p_new Scan the ALE sponge variables and replace a prescribed pointer to a new value. sponge A pointer to the control structure for this module that is set by a previous call to initialize_ALE_sponge. p_old The previous array of target values g The updated ocean grid structure gv ocean vertical grid structure p_new The new array of target values subroutine, public subroutine, public mom_ale_sponge::ale_sponge_end (CS) ale_sponge_end CS CS This subroutine deallocates any memory associated with the ALE_sponge module. cs A pointer to the control structure that is set by a previous call to initialize_ALE_sponge. This module contains the routines used to apply sponge layers when using the ALE mode. Applying sponges requires the following: initialize_ALE_sponge set_up_ALE_sponge_field (tracers) and set_up_ALE_sponge_vel_field (vel) apply_ALE_sponge init_ALE_sponge_diags (not being used for now) ALE_sponge_end (not being used for now)