Edit on GitHub

FieldExchanger

This module contains general functions for the exchange of fields between the atmospheric and surface component models.

The FieldExchanger needs to populate the coupler with

  • atmospheric fields (mostly fluxes), via the import_atmos_fields! function
  • average surface properties of each coupler gridpoint, via the import_combined_surface_fields! function

The component models are updated by broadcasting the coupler fields, via the update_model_sims! function. For an update, this function requires that update_field! is defined for the particular variable and component model. Currently, we support the:

  • AtmosModelSimulation: albedo, surface_temperature
    • if calculating fluxes in the atmospheric model: roughness_momentum, roughness_buoyancy, beta
  • SurfaceModelSimulation: air_density, turbulent_energy_flux, turbulent_moisture_flux, radiative_energy_flux_sfc, liquid_precipitation, snow_precipitation

If an update_field! function is not defined for a particular component model, it will be ignored.

FieldExchanger API

ClimaCoupler.FieldExchanger.import_atmos_fields! — Function
import_atmos_fields!(csf, model_sims)

Update the coupler with the atmospheric fluxes. The Interfacer.get_field functions (:turbulent_energy_flux, :turbulent_moisture_flux, :radiative_energy_flux_sfc, :liquid_precipitation, :snow_precipitation) have to be defined for the atmospheric component model type.

Arguments

  • csf: [NamedTuple] containing coupler fields.
  • model_sims: [NamedTuple] containing ComponentModelSimulations.
source
import_atmos_fields!(csf, ::Interfacer.SurfaceModelSimulation, atmos_sim)

Updates the coupler simulation fields with atmospheric fluxes from the atmosphere simulation. This is the default function to be used for most surface model simulations, as are computed by the coupler or atmosphere and passed to the surfaces.

source
ClimaCoupler.FieldExchanger.import_combined_surface_fields! — Function
import_combined_surface_fields!(csf, model_sims)

Updates the coupler with the surface properties. The Interfacer.get_field functions for (:surface_temperature, :surface_direct_albedo, :surface_diffuse_albedo) need to be specified for each surface model.

Arguments

  • csf: [NamedTuple] containing coupler fields.
  • model_sims: [NamedTuple] containing ComponentModelSimulations.
source
ClimaCoupler.FieldExchanger.update_model_sims! — Function
update_model_sims!(model_sims, csf)

Iterates update_sim! over all component model simulations saved in cs.model_sims.

Arguments

  • model_sims: [NamedTuple] containing ComponentModelSimulations.
  • csf: [NamedTuple] containing coupler fields.
source
ClimaCoupler.FieldExchanger.update_sim! — Function
update_sim!(atmos_sim::Interfacer.AtmosModelSimulation, csf)

Updates the surface fields for temperature, roughness length, albedo, and specific humidity.

Arguments

  • atmos_sim: [Interfacer.AtmosModelSimulation] containing an atmospheric model simulation object.
  • csf: [NamedTuple] containing coupler fields.
source
update_sim!(sim::SurfaceModelSimulation, csf, area_fraction)

Updates the surface component model cache with the current coupler fields of Fturbenergy, Fradiative, Fturbmoisture, Pliq, and ρ_sfc.

Arguments

  • sim: [Interfacer.SurfaceModelSimulation] containing a surface model simulation object.
  • csf: [NamedTuple] containing coupler fields.
source
ClimaCoupler.FieldExchanger.step_model_sims! — Function
step_model_sims!(model_sims, t)

Iterates step! over all component model simulations saved in cs.model_sims.

Arguments

  • model_sims: [NamedTuple] containing ComponentModelSimulations.
  • t: [AbstractFloat] denoting the simulation time.
source
ClimaCoupler.FieldExchanger.update_surface_fractions! — Function
update_surface_fractions!(cs::Interfacer.CoupledSimulation)

Updates dynamically changing area fractions. Maintains the invariant that the sum of area fractions is 1 at all points.

Arguments

  • cs: [Interfacer.CoupledSimulation] containing area fraction information.
source

FieldExchanger Internal Functions

ClimaCoupler.FieldExchanger.combine_surfaces! — Function
combine_surfaces!(combined_field::CC.Fields.Field, sims, field_name::Val)

Sums the fields, specified by field_name, weighted by the respective area fractions of all surface simulations. THe result is saved in combined_field.

Arguments

  • combined_field: [CC.Fields.Field] output object containing weighted values.
  • sims: [NamedTuple] containing simulations .
  • field_name: [Val] containing the name Symbol of the field t be extracted by the Interfacer.get_field functions.

Example

  • combine_surfaces!(temp_field, cs.model_sims, Val(:surface_temperature))
source
ClimaCoupler.FieldExchanger.dummmy_remap! — Function
dummmy_remap!(target, source)

Simple stand-in function for remapping. For AMIP we don't need regridding of surface model CC.Fields. When we do, we re-introduce the ClimaCoreTempestRemap remapping functions.

Arguments

  • target: [CC.Fields.Field] destination of remapping.
  • source: [CC.Fields.Field] source of remapping.
source