Skip to content

Adds new ocean to ice coupling fields for frazil ice formation #460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
njeffery wants to merge 16 commits into
base: seaice-coupling
Choose a base branch
from
Open

Adds new ocean to ice coupling fields for frazil ice formation #460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
eccb199
add index_x2i_Fioo_frazils (frazil salt flux) to ice_comp_mct.F,mpass…
erinethomas May 27, 2026
a706618
Add additional frazil coupler fields.
karapeterson May 27, 2026
69be928
adding o2x_Fioo_frazilh/o2x_Fioo_frazils to mpaso
erinethomas May 28, 2026
32602c0
Add budgeting in mct coupler for new coupling fields.
karapeterson May 28, 2026
05142f5
Fix bugs leading to build errors.
karapeterson May 29, 2026
6ae78d2
Adds omega-fluxes option for frazil coupling in sea ice
njeffery May 29, 2026
9d12c7b
Update sea ice config checks
njeffery Jun 1, 2026
51b99ec
Corrects update sea ice config options
njeffery Jun 3, 2026
76e673e
Fixes salt flux units error
njeffery Jun 3, 2026
b4d14ac
Make frazil energy consistent with the ocean energy change
njeffery Jun 19, 2026
cd9595f
fixed type introduced in last commit
njeffery Jun 19, 2026
02ea1b6
Corrections to ensure BFB
njeffery Jun 30, 2026
8630cdf
Clean up ocean frazil routine
njeffery Jul 1, 2026
9ae18ee
corrects typo in frazil routine
njeffery Jul 29, 2026
1c36669
Remove redundant newFrazilEnergy
njeffery Aug 14, 2026
58b8031
Added copilot suggestions
njeffery Aug 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion components/elm/src/external_models/fates
Open in desktop
Submodule fates updated 16 files
+5 −0 .github/PULL_REQUEST_TEMPLATE.md
+1 −1 .gitmodules
+6 −0 CONTRIBUTING.md
+1 −2 README.md
+44 −9 biogeochem/EDPatchDynamicsMod.F90
+10 −3 biogeochem/EDPhysiologyMod.F90
+10 −9 biogeochem/FatesCohortMod.F90
+46 −15 biogeochem/FatesLandUseChangeMod.F90
+15 −2 main/EDInitMod.F90
+3 −1 main/EDMainMod.F90
+7 −0 main/EDPftvarcon.F90
+3 −0 main/FatesConstantsMod.F90
+8 −1 main/FatesInterfaceMod.F90
+4 −0 main/FatesInterfaceTypesMod.F90
+11 −4 parameter_files/fates_params_default.json
+1 −1 tools/landusedata
4 changes: 4 additions & 0 deletions components/mpas-ocean/driver/mpaso_cpl_indices.F
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ module mpaso_cpl_indices
integer :: index_o2x_Fioo_q
integer :: index_o2x_Foxo_q_li
integer :: index_o2x_Fioo_frazil
integer :: index_o2x_Fioo_frazils
integer :: index_o2x_Fioo_frazilh
integer :: index_o2x_Foxo_frazil_li
integer :: index_o2x_Faoo_h2otemp
integer :: index_o2x_Faoo_fco2_ocn
Expand Down Expand Up @@ -215,6 +217,8 @@ subroutine mpaso_cpl_indices_set( )
index_o2x_Fioo_q = mct_avect_indexra(o2x,'Fioo_q',perrWith='quiet')
index_o2x_Foxo_q_li = mct_avect_indexra(o2x,'Foxo_q_li',perrWith='quiet')
index_o2x_Fioo_frazil = mct_avect_indexra(o2x,'Fioo_frazil',perrWith='quiet')
index_o2x_Fioo_frazils = mct_avect_indexra(o2x,'Fioo_frazils',perrWith='quiet')
index_o2x_Fioo_frazilh = mct_avect_indexra(o2x,'Fioo_frazilh',perrWith='quiet')
index_o2x_Foxo_frazil_li= mct_avect_indexra(o2x,'Foxo_frazil_li',perrWith='quiet')
index_o2x_Faoo_h2otemp = mct_avect_indexra(o2x,'Faoo_h2otemp',perrWith='quiet')
index_o2x_Faoo_fco2_ocn = mct_avect_indexra(o2x,'Faoo_fco2_ocn',perrWith='quiet')
Expand Down
9 changes: 9 additions & 0 deletions components/mpas-ocean/driver/ocn_comp_mct.F
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3166,6 +3166,7 @@ subroutine ocn_export_mct(o2x_o, errorCode) !{{{
integer, dimension(:), pointer :: landIceMask

real (kind=RKIND), dimension(:), pointer :: seaIceEnergy, accumulatedFrazilIceMass, frazilSurfacePressure, &
accumulatedFrazilIceEnergy, &
avgTotalFreshWaterTemperatureFlux, &
avgCO2_gas_flux, DMSFlux, surfaceUpwardCO2Flux, &
avgOceanSurfaceDIC, &
Expand Down Expand Up @@ -3286,6 +3287,7 @@ subroutine ocn_export_mct(o2x_o, errorCode) !{{{
call mpas_pool_get_array(forcingPool, 'seaIceEnergy', seaIceEnergy)
call mpas_pool_get_array(forcingPool, 'frazilSurfacePressure', frazilSurfacePressure)
call mpas_pool_get_array(statePool, 'accumulatedFrazilIceMass', accumulatedFrazilIceMass, 1)
call mpas_pool_get_array(statePool, 'accumulatedFrazilIceEnergy', accumulatedFrazilIceEnergy, 1)
end if

! Cryo fields
Expand Down Expand Up @@ -3405,11 +3407,17 @@ subroutine ocn_export_mct(o2x_o, errorCode) !{{{

o2x_o(index_o2x_Fioo_q, n) = seaIceEnergy(i) / ocn_cpl_dt
o2x_o(index_o2x_Fioo_frazil, n) = accumulatedFrazilIceMass(i) / ocn_cpl_dt
o2x_o(index_o2x_Fioo_frazils, n) = accumulatedFrazilIceMass(i)/ 1000.0_RKIND * &
config_frazil_sea_ice_reference_salinity / ocn_cpl_dt
!defined positive to be consistent with Fioo_q when frazil is formed
o2x_o(index_o2x_Fioo_frazilh, n) = accumulatedFrazilIceEnergy(i)/ ocn_cpl_dt

else

o2x_o(index_o2x_Fioo_q, n) = 0.0_RKIND
o2x_o(index_o2x_Fioo_frazil, n) = 0.0_RKIND
o2x_o(index_o2x_Fioo_frazils, n) = 0.0_RKIND
o2x_o(index_o2x_Fioo_frazilh, n) = 0.0_RKIND
if (trim(config_land_ice_flux_mode) == 'standalone' .or. trim(config_land_ice_flux_mode) == 'data') then
o2x_o(index_o2x_Foxo_q_li, n) = accumulatedFrazilIceMass(i) * config_frazil_heat_of_fusion / ocn_cpl_dt
o2x_o(index_o2x_Foxo_frazil_li, n) = accumulatedFrazilIceMass(i) / ocn_cpl_dt
Expand All @@ -3420,6 +3428,7 @@ subroutine ocn_export_mct(o2x_o, errorCode) !{{{
! Reset SeaIce Energy and Accumulated Frazil Ice
seaIceEnergy(i) = 0.0_RKIND
accumulatedFrazilIceMass(i) = 0.0_RKIND
accumulatedFrazilIceEnergy(i) = 0.0_RKIND
frazilSurfacePressure(i) = 0.0_RKIND
end if

Expand Down
5 changes: 5 additions & 0 deletions components/mpas-ocean/src/Registry.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2146,6 +2146,7 @@
<var_struct name="ecosysAuxiliary"/>
<var name="accumulatedFrazilIceMass"/>
<var name="accumulatedFrazilIceSalinity"/>
<var name="accumulatedFrazilIceEnergy"/>
<var name="accumulatedLandIceMass"/>
<var name="accumulatedLandIceHeat"/>
<var name="accumulatedLandIceFrazilMass"/>
Expand Down Expand Up @@ -2517,6 +2518,10 @@
description="Mass per unit area of frazil ice produced. Reset to zero at each coupling interval"
packages="frazilIce"
/>
<var name="accumulatedFrazilIceEnergy" type="real" dimensions="nCells Time" units="J m^-2"
description="Accumulated frazil ice energy per unit area. Reset to zero at each coupling interval"
packages="frazilIce"
/>
<var name="accumulatedFrazilIceSalinity" type="real" dimensions="nCells Time" units="kg m^-2"
description="Salinity associated with accumulatedFrazilIceMass. Reset to zero at each coupling interval"
packages="frazilIce"
Expand Down
2 changes: 1 addition & 1 deletion components/mpas-ocean/src/analysis_members/Registry_conservation_check.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
description="Iceberg heat flux from coupler, integrated in space and time. Positive into the ocean."
/>
<var name="accumulatedFrazilHeatFlux" type="real" dimensions="Time" units="W m^-2"
description="Heat flux from frazil, integrated in space and time, given to couipler. Positive into the ocean."
description="Heat flux from frazil, integrated in space and time, given to coupler. Positive into the ocean."
/>
<var name="accumulatedLandIceHeatFlux" type="real" dimensions="Time" units="W m^-2"
description="Land ice heat flux, integrated in space and time. Positive into the ocean."
Expand Down
13 changes: 10 additions & 3 deletions components/mpas-ocean/src/analysis_members/mpas_ocn_conservation_check.F
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,6 +462,8 @@ subroutine energy_conservation(domain, err)
icebergTemperatureFlux, &
accumulatedFrazilIceMassNew, &
accumulatedFrazilIceMassOld, &
accumulatedFrazilIceEnergyNew, &
accumulatedFrazilIceEnergyOld, &
accumulatedLandIceFrazilMassNew, &
accumulatedLandIceFrazilMassOld

Expand Down Expand Up @@ -565,6 +567,8 @@ subroutine energy_conservation(domain, err)
call mpas_pool_get_array(tracersSurfaceFluxPool, 'activeTracersSurfaceFluxSubglacialRunoff', activeTracersSurfaceFluxSubglacialRunoff)
call mpas_pool_get_array(statePool, 'accumulatedFrazilIceMass', accumulatedFrazilIceMassNew, 2)
call mpas_pool_get_array(statePool, 'accumulatedFrazilIceMass', accumulatedFrazilIceMassOld, 1)
call mpas_pool_get_array(statePool, 'accumulatedFrazilIceEnergy', accumulatedFrazilIceEnergyNew, 2)
call mpas_pool_get_array(statePool, 'accumulatedFrazilIceEnergy', accumulatedFrazilIceEnergyOld, 1)

do iCell = 1, nCellsSolve

Expand Down Expand Up @@ -599,8 +603,10 @@ subroutine energy_conservation(domain, err)
do iCell = 1, nCellsSolve
! Frazil ice mass is negative. Negative coefficient makes heat
! flux positive, because freezing ice releases heat.
sumArray(10) = sumArray(10) - areaCell(iCell) * config_frazil_heat_of_fusion &
* (accumulatedFrazilIceMassNew(iCell) - accumulatedFrazilIceMassOld(iCell))/dt
!sumArray(10) = sumArray(10) - areaCell(iCell) * config_frazil_heat_of_fusion &
! * (accumulatedFrazilIceMassNew(iCell) - accumulatedFrazilIceMassOld(iCell))/dt
sumArray(10) = sumArray(10) - areaCell(iCell) &
* (accumulatedFrazilIceEnergyNew(iCell) - accumulatedFrazilIceEnergyOld(iCell))/dt
enddo
end if

Expand Down Expand Up @@ -749,7 +755,8 @@ subroutine energy_conservation(domain, err)
s = 0.0_RKIND
call mpas_log_write('HEAT FLUXES: explicit')
call mpas_log_write('MPAS-Ocean name W (raw sum) coupler name short name W/m^2 (flux/A)')
v=accumulatedFrazilHeatFlux ; write(m,"('frazilMass * LHF /dt ',es16.8,' o2x_Fioo_q hfreeze ',f16.8)") v,v/A; call mpas_log_write(m); s=s+v
!v=accumulatedFrazilHeatFlux ; write(m,"('frazilMass * LHF /dt ',es16.8,' o2x_Fioo_q hfreeze ',f16.8)") v,v/A; call mpas_log_write(m); s=s+v
v=accumulatedFrazilHeatFlux ; write(m,"('frazilMass * LHF /dt ',es16.8,' o2x_Fioo_frazilh hfreeze ',f16.8)") v,v/A; call mpas_log_write(m); s=s+v
v=accumulatedSeaIceHeatFlux ; write(m,"('seaIceHeatFlux ',es16.8,' x2o_Fioi_melth hmelt ',f16.8)") v,v/A; call mpas_log_write(m); s=s+v
v=accumulatedShortWaveHeatFlux ; write(m,"('shortWaveHeatFlux ',es16.8,' x2o_Foxx_swnet hnetsw ',f16.8)") v,v/A; call mpas_log_write(m); s=s+v
v=accumulatedLongWaveHeatFluxDown ; write(m,"('longWaveHeatFluxDown ',es16.8,' x2o_Faxa_lwdn hlwdn ',f16.8)") v,v/A; call mpas_log_write(m); s=s+v
Expand Down
33 changes: 24 additions & 9 deletions components/mpas-ocean/src/shared/mpas_ocn_frazil_forcing.F
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,10 +462,13 @@ subroutine ocn_frazil_forcing_build_arrays(domain, meshPool, forcingPool, stateP
real (kind=RKIND) :: newFrazilIceThickness, newThicknessWeightedSaltContent
real (kind=RKIND) :: sumNewFrazilIceThickness, sumNewThicknessWeightedSaltContent
real (kind=RKIND) :: meltedFrazilIceThickness, meltedThicknessWeightedSaltContent
real (kind=RKIND) :: sumNewFrazilEnergy, newFrazilEnergy, meltedFrazilEnergy
real (kind=RKIND) :: oceanFreezingTemperature, frazilSalinity

real (kind=RKIND), pointer, dimension(:) :: accumulatedFrazilIceMassNew
real (kind=RKIND), pointer, dimension(:) :: accumulatedFrazilIceMassOld
real (kind=RKIND), pointer, dimension(:) :: accumulatedFrazilIceEnergyNew
real (kind=RKIND), pointer, dimension(:) :: accumulatedFrazilIceEnergyOld
real (kind=RKIND), pointer, dimension(:) :: accumulatedFrazilIceSalinityNew
real (kind=RKIND), pointer, dimension(:) :: accumulatedFrazilIceSalinityOld
real (kind=RKIND), pointer, dimension(:) :: accumulatedLandIceFrazilMassNew
Expand Down Expand Up @@ -515,6 +518,8 @@ subroutine ocn_frazil_forcing_build_arrays(domain, meshPool, forcingPool, stateP
call mpas_pool_get_array(statePool, 'layerThickness', layerThickness, 1)
call mpas_pool_get_array(statePool, 'accumulatedFrazilIceMass', accumulatedFrazilIceMassNew, 2)
call mpas_pool_get_array(statePool, 'accumulatedFrazilIceMass', accumulatedFrazilIceMassOld, 1)
call mpas_pool_get_array(statePool, 'accumulatedFrazilIceEnergy', accumulatedFrazilIceEnergyNew, 2)
call mpas_pool_get_array(statePool, 'accumulatedFrazilIceEnergy', accumulatedFrazilIceEnergyOld, 1)
call mpas_pool_get_array(statePool, 'accumulatedFrazilIceSalinity', accumulatedFrazilIceSalinityNew, 2)
call mpas_pool_get_array(statePool, 'accumulatedFrazilIceSalinity', accumulatedFrazilIceSalinityOld, 1)
call mpas_pool_get_array(statePool, 'accumulatedLandIceFrazilMass', accumulatedLandIceFrazilMassNew, 2)
Expand Down Expand Up @@ -552,7 +557,8 @@ subroutine ocn_frazil_forcing_build_arrays(domain, meshPool, forcingPool, stateP
!$omp sumNewThicknessWeightedSaltContent, oceanFreezingTemperature, potential, &
!$omp freezingEnergy, meltingEnergy, frazilSalinity, newFrazilIceThickness, &
!$omp newThicknessWeightedSaltContent, meltedFrazilIceThickness, &
!$omp meltedThicknessWeightedSaltContent)
!$omp meltedThicknessWeightedSaltContent, newFrazilEnergy, meltedFrazilEnergy, &
!$omp sumNewFrazilEnergy)
do iCell=1,nCells

underLandIce = .false.
Expand Down Expand Up @@ -604,6 +610,8 @@ subroutine ocn_frazil_forcing_build_arrays(domain, meshPool, forcingPool, stateP
! initialize the sum of new frazil ice created
sumNewFrazilIceThickness = 0.0_RKIND
sumNewThicknessWeightedSaltContent = 0.0_RKIND
sumNewFrazilEnergy = 0.0_RKIND
newFrazilEnergy = 0.0_RKIND

! loop from maximum depth of frazil creation to surface
do k = kBottomFrazil, minLevelCell(iCell), -1
Expand Down Expand Up @@ -632,31 +640,29 @@ subroutine ocn_frazil_forcing_build_arrays(domain, meshPool, forcingPool, stateP

! new frazil ice formation measured in meters
newFrazilIceThickness = freezingEnergy / (config_frazil_heat_of_fusion * config_frazil_ice_density)

! limit the frazil formed appropriately
newFrazilIceThickness = min(newFrazilIceThickness, layerThickness(k,iCell) * config_frazil_fractional_thickness_limit)

! Determine new salt in frazil
newThicknessWeightedSaltContent = newFrazilIceThickness * frazilSalinity

! compute tendency to thickness, temperature and salinity
! layerTendency is scaled so that mass of ice created == mass of ocean water removed

! layer thickness decreased due to creation of frazil
! note: -- this has to be density (not rho_sw) to keep buoyancy equal
frazilLayerThicknessTendency(k,iCell) = - newFrazilIceThickness * config_frazil_ice_density / density(k,iCell) / dt

! salt is extracted with the frazil
frazilSalinityTendency(k,iCell) = - newThicknessWeightedSaltContent / dt

! ocean fluid temperature is warmed due to creation of frazil
frazilTemperatureTendency(k,iCell) = + ( newFrazilIceThickness * config_frazil_heat_of_fusion &
* config_frazil_ice_density ) / (config_specific_heat_sea_water * rho_sw) / dt

! keep track of sum of frazil ice
! Store the latent energy of the new frazil
newFrazilEnergy = newFrazilIceThickness * config_frazil_ice_density * config_frazil_heat_of_fusion
!keep track of sum of frazil ice
sumNewFrazilIceThickness = sumNewFrazilIceThickness + newFrazilIceThickness
sumNewThicknessWeightedSaltContent = sumNewThicknessWeightedSaltContent + newThicknessWeightedSaltContent

sumNewFrazilEnergy = sumNewFrazilEnergy + newFrazilEnergy
else
! ocean water is warm enough to melt frazil

Expand Down Expand Up @@ -688,18 +694,24 @@ subroutine ocn_frazil_forcing_build_arrays(domain, meshPool, forcingPool, stateP
frazilSalinityTendency(k,iCell) = + meltedThicknessWeightedSaltContent/ dt

! ocean fluid temperature is cooled due to melting of frazil
frazilTemperatureTendency(k,iCell) = - ( meltedFrazilIceThickness * config_frazil_heat_of_fusion &
frazilTemperatureTendency(k,iCell) = - ( meltedFrazilIceThickness * config_frazil_heat_of_fusion &
* config_frazil_ice_density ) / (config_specific_heat_sea_water * rho_sw) &
/ dt

! ocean fluid temperature is modified due to mixing of existing water with meltwater at the freezing point
! more consistent with the layer tendency
!frazilTemperatureTendency(k,iCell) = frazilTemperatureTendency(k,iCell) + &
! meltedFrazilIceThickness * oceanFreezingTemperature * config_frazil_ice_density / density(k,iCell) / dt
! original formulation
frazilTemperatureTendency(k,iCell) = frazilTemperatureTendency(k,iCell) + &
meltedFrazilIceThickness * oceanFreezingTemperature / dt

! keep track of new frazil ice
sumNewThicknessWeightedSaltContent = max(0.0_RKIND,sumNewThicknessWeightedSaltContent - meltedThicknessWeightedSaltContent)
sumNewFrazilIceThickness = max(0.0_RKIND,sumNewFrazilIceThickness - meltedFrazilIceThickness)

meltedFrazilEnergy = meltedFrazilIceThickness * config_frazil_ice_density * config_frazil_heat_of_fusion

sumNewFrazilEnergy = max(0.0_RKIND,sumNewFrazilEnergy - meltedFrazilEnergy)
endif ! if (sumNewFrazilIceThickness > 0.0_RKIND)

endif ! if (freezingEnergy < 0)
Expand All @@ -711,6 +723,9 @@ subroutine ocn_frazil_forcing_build_arrays(domain, meshPool, forcingPool, stateP
accumulatedFrazilIceMassNew(iCell) = accumulatedFrazilIceMassOld(iCell) + sumNewFrazilIceThickness &
* config_frazil_ice_density

!frazilIceEnergy > 0
accumulatedFrazilIceEnergyNew(iCell) = accumulatedFrazilIceEnergyOld(iCell) + sumNewFrazilEnergy

accumulatedFrazilIceSalinityNew(iCell) = accumulatedFrazilIceSalinityOld(iCell) + &
(1-usePorosity) * sumNewThicknessWeightedSaltContent

Expand Down
2 changes: 1 addition & 1 deletion components/mpas-seaice/bld/namelist_files/namelist_definition_mpassi.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -533,7 +533,7 @@ Default: Defined in namelist_defaults.xml
category="forcing" group="forcing">
Type of frazil ice coupling.

Valid values: 'external', 'internal', 'fresh_ice_correction'
Valid values: 'external', 'internal', 'fresh_ice_correction', 'omega-fluxes'
Default: Defined in namelist_defaults.xml
</entry>

Expand Down
6 changes: 6 additions & 0 deletions components/mpas-seaice/cime_config/buildnml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -852,6 +852,9 @@ def buildnml(case, caseroot, compname):
lines.append(' <var name="snowVolumeCell"/>')
lines.append(' <var name="uVelocityGeo"/>')
lines.append(' <var name="vVelocityGeo"/>')
lines.append(' <var name="frazilMassFlux"/>')
lines.append(' <var name="frazilSaltFlux"/>')
lines.append(' <var name="frazilEnthalpyFlux"/>')
if ("WW3" in compset or "DWAV%FSD" in compset or "DWAV%ZEROS" in compset):
lines.append(' <var name="floeSizeDiameter"/> ')
lines.append(' <var name="waveSpectra"/> ')
Expand Down Expand Up @@ -913,6 +916,9 @@ def buildnml(case, caseroot, compname):
lines.append(' <var name="airTemperature"/>')
lines.append(' <var name="congelation"/>')
lines.append(' <var name="frazilFormation"/>')
lines.append(' <var name="frazilMassFlux"/>')
lines.append(' <var name="frazilSaltFlux"/>')
lines.append(' <var name="frazilEnthalpyFlux"/>')
lines.append(' <var name="snowiceFormation"/>')
lines.append(' <var name="snowMelt"/>')
lines.append(' <var name="surfaceIceMelt"/>')
Expand Down
Loading