MOM6
|
Regrid columns for the adaptive coordinate.
Data Types | |
type | adapt_cs |
Control structure for adaptive coordinates (coord_adapt). More... | |
Functions/Subroutines | |
subroutine, public | init_coord_adapt (CS, nk, coordinateResolution, m_to_H) |
Initialise an adapt_CS with parameters. More... | |
subroutine, public | end_coord_adapt (CS) |
Clean up the coordinate control structure. More... | |
subroutine, public | set_adapt_params (CS, adaptTimeRatio, adaptAlpha, adaptZoom, adaptZoomCoeff, adaptBuoyCoeff, adaptDrho0, adaptDoMin) |
This subtroutine can be used to set the parameters for coord_adapt module. More... | |
subroutine, public | build_adapt_column (CS, G, GV, tv, i, j, zInt, tInt, sInt, h, zNext) |
subroutine, public coord_adapt::build_adapt_column | ( | type(adapt_cs), intent(in) | CS, |
type(ocean_grid_type), intent(in) | G, | ||
type(verticalgrid_type), intent(in) | GV, | ||
type(thermo_var_ptrs), intent(in) | tv, | ||
integer, intent(in) | i, | ||
integer, intent(in) | j, | ||
real, dimension( g %isd: g %ied, g %jsd: g %jed, gv %ke+1), intent(in) | zInt, | ||
real, dimension( g %isd: g %ied, g %jsd: g %jed, gv %ke+1), intent(in) | tInt, | ||
real, dimension( g %isd: g %ied, g %jsd: g %jed, gv %ke+1), intent(in) | sInt, | ||
real, dimension( g %isd: g %ied, g %jsd: g %jed, gv %ke), intent(in) | h, | ||
real, dimension( gv %ke+1), intent(inout) | zNext | ||
) |
[in] | cs | The control structure for this module |
[in] | g | The ocean's grid structure |
[in] | gv | The ocean's vertical grid structure |
[in] | tv | A structure pointing to various thermodynamic variables |
[in] | i | The i-index of the column to work on |
[in] | j | The j-index of the column to work on |
[in] | zint | Interface heights [H ~> m or kg m-2]. |
[in] | tint | Interface temperatures [degC] |
[in] | sint | Interface salinities [ppt] |
[in] | h | Layer thicknesses [H ~> m or kg m-2] |
[in,out] | znext | updated interface positions |
Definition at line 118 of file coord_adapt.F90.
Referenced by mom_regridding::build_grid_adaptive().
subroutine, public coord_adapt::end_coord_adapt | ( | type(adapt_cs), pointer | CS | ) |
Clean up the coordinate control structure.
cs | The control structure for this module |
Definition at line 82 of file coord_adapt.F90.
Referenced by mom_regridding::end_regridding().
subroutine, public coord_adapt::init_coord_adapt | ( | type(adapt_cs), pointer | CS, |
integer, intent(in) | nk, | ||
real, dimension(:), intent(in) | coordinateResolution, | ||
real, intent(in), optional | m_to_H | ||
) |
Initialise an adapt_CS with parameters.
cs | Unassociated pointer to hold the control structure | |
[in] | nk | Number of layers in the grid |
[in] | coordinateresolution | Nominal near-surface resolution [m] or other units specified with m_to_H |
[in] | m_to_h | A conversion factor from m to the units of thicknesses |
Definition at line 53 of file coord_adapt.F90.
References mom_error_handler::mom_error().
Referenced by mom_regridding::initcoord().
subroutine, public coord_adapt::set_adapt_params | ( | type(adapt_cs), pointer | CS, |
real, intent(in), optional | adaptTimeRatio, | ||
real, intent(in), optional | adaptAlpha, | ||
real, intent(in), optional | adaptZoom, | ||
real, intent(in), optional | adaptZoomCoeff, | ||
real, intent(in), optional | adaptBuoyCoeff, | ||
real, intent(in), optional | adaptDrho0, | ||
logical, intent(in), optional | adaptDoMin | ||
) |
This subtroutine can be used to set the parameters for coord_adapt module.
cs | The control structure for this module | |
[in] | adapttimeratio | Ratio of optimisation and diffusion timescales |
[in] | adaptalpha | Nondimensional coefficient determining how much optimisation to apply |
[in] | adaptzoom | Near-surface zooming depth [H ~> m or kg m-2] |
[in] | adaptzoomcoeff | Near-surface zooming coefficient |
[in] | adaptbuoycoeff | Stratification-dependent diffusion coefficient |
[in] | adaptdrho0 | Reference density difference for stratification-dependent diffusion |
[in] | adaptdomin | If true, form a HYCOM1-like mixed layer by preventing interfaces from becoming shallower than the depths set by coordinateResolution |
Definition at line 93 of file coord_adapt.F90.
References mom_error_handler::mom_error().
Referenced by mom_regridding::set_regrid_params().