List of standard variables - fabm-model/fabm GitHub Wiki

Below you can find a list of standard variables that FABM has built in. These variables are typically specified in biogeochemical models with standard_variables%<NAME>, and in couplers to hydrodynamic models (hosts) with fabm_standard_variables%<NAME>. For instance, a biogeochemical model can use standard_variables%temperature to register a dependency on temperature, and the host can use fabm_standard_variables%temperature to provide FABM with values for temperature. FABM then links these automatically.

If you need a variable that is not listed below, you can add your own without making any changes to FABM. To do so, declare your new standard variables in code, for instance:

type (type_surface_standard_variable), parameter :: ice_thickness = type_surface_standard_variable(name= "ice_thickness", units="m")

Then, use this new variable in place of standard_variables%<NAME> or fabm_standard_variables%<NAME>. FABM will automatically couple variables that use the same standard name and units. Thus, if you use the above declaration of ice thickness in the host to provide the thickness, and in a biogeochemical model to obtain the thickness, everything will "just work". Instead of type_surface_standard_variable, you can also use type_bottom_standard_variable, type_interior_standard_variable, type_global_standard_variable and type_universal_standard_variable, corresponding to the categories below.

If you think your new standard variable will be useful to others and is therefore worth building into FABM, post a message on Discussions. Then, also try to adhere to FABM's conventions for naming standard variables.