Skip to content

Change vert_diff config option #4176

@haakon-e

Description

@haakon-e

In default_config.yml, we have:

vert_diff:
  help: "Vertical diffusion [`false` (default), `VerticalDiffusion`, `true` (defaults to `VerticalDiffusion`), `DecayWithHeightDiffusion`]"
  value: "false"

This is a rather confusing combination of booleans and string flags. Additionally, many (12) configs have set this flag to:

vert_diff: true

which leads to the warning:

┌ Warning: Failed to convert `config_dict["vert_diff"] = true` to default type String, keeping original value
└ @ ClimaAtmos ~/ClimaAtmos.jl/src/solver/yaml_helper.jl:78

Ultimately, the expected vertical diffusion option is applied, but it is indeed rather confusing and not user-friendly.


I think we should update the option as follows:

vert_diff:
  help: "Vertical diffusion [`~` (no diffusion, default), `VerticalDiffusion`, `DecayWithHeightDiffusion`]"
  value: ~

that is, removing true/false options.


If changing the valid options is a breaking change, I think we should consider changing the name to something more descriptive, e.g. vertical_diffusion_model.


This issue may be less relevant when the new simulation interface is merged.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions