This is a container to hold all coupling configurations for mHM. More...

Public Member Functions
procedure	read_config (self, file_namelist, unamelist)
	read configuration for the couple_cfg_type class from the mhm namelist

procedure	set_config (self, case, meteo_timestep, meteo_time_ref_endpoint, meteo_expect_pre, meteo_expect_temp, meteo_expect_pet, meteo_expect_tmin, meteo_expect_tmax, meteo_expect_netrad, meteo_expect_absvappress, meteo_expect_windspeed, meteo_expect_ssrd, meteo_expect_strd, meteo_expect_tann, read_nml)
	set configuration for the couple_cfg_type class

procedure	any_meteo_expected (self)
	whether any meteo data is expected

procedure	clean_up (self)
	clean up

procedure	check (self, domainmeta, optimize)
	check configuration

procedure	active (self)
	whether coupling is actived

Public Attributes
character(256)	nml_name = 'coupling'
	namelist name in mhm namelist

logical	read_nml = .true.
	whether to read the namelist (or set via routine)

integer(i4)	case
	coupling case (0: no coupling, 1: single domain coupling)

integer(i4)	meteo_timestep
	timestep for meteo-data from coupling

logical	meteo_time_ref_endpoint
	expect meteo has time reference point at end of associated time interval

logical	meteo_expect_pre
	expect meteo from coupling: [mm] Precipitation

logical	meteo_expect_temp
	expect meteo from coupling: [degC] Air temperature

logical	meteo_expect_pet
	expect meteo from coupling: [mm TS-1] Potential evapotranspiration

logical	meteo_expect_tmin
	expect meteo from coupling: [degC] minimum daily air temperature

logical	meteo_expect_tmax
	expect meteo from coupling: [degC] maximum daily air temperature

logical	meteo_expect_netrad
	expect meteo from coupling: [W m2] net radiation

logical	meteo_expect_absvappress
	expect meteo from coupling: [Pa] absolute vapour pressure

logical	meteo_expect_windspeed
	expect meteo from coupling: [m s-1] windspeed

logical	meteo_expect_ssrd
	expect meteo from coupling: [W m2] short wave radiation

logical	meteo_expect_strd
	expect meteo from coupling: [W m2] long wave radiation

logical	meteo_expect_tann
	expect meteo from coupling: [degC] annual mean air temperature

Detailed Description

This is a container to hold all coupling configurations for mHM.

Definition at line 30 of file mo_coupling_type.f90.

Member Function/Subroutine Documentation

◆ active()

procedure mo_coupling_type::couple_cfg_type::active ( class(couple_cfg_type), intent(in) self )

whether coupling is actived

Returns: True if any case > 0, else False

See also: mo_coupling_type::active

Definition at line 61 of file mo_coupling_type.f90.

◆ any_meteo_expected()

procedure mo_coupling_type::couple_cfg_type::any_meteo_expected ( class(couple_cfg_type), intent(in) self )

whether any meteo data is expected

Returns: True if any meteo data expected, else False

See also: mo_coupling_type::any_meteo_expected

Definition at line 55 of file mo_coupling_type.f90.

◆ check()

procedure mo_coupling_type::couple_cfg_type::check	(	class(couple_cfg_type), intent(inout)	self,
		type(domain_meta), intent(in)	domainmeta,
		logical, intent(in)	optimize
	)

check configuration

Parameters

[in]	domainmeta	domain general description
[in]	optimize	Optimization (.true. ) or Evaluation run (.false.)

See also: mo_coupling_type::check

Definition at line 59 of file mo_coupling_type.f90.

◆ clean_up()

procedure mo_coupling_type::couple_cfg_type::clean_up ( class(couple_cfg_type), intent(inout) self )

clean up

See also: mo_coupling_type::clean_up

Definition at line 57 of file mo_coupling_type.f90.

◆ read_config()

procedure mo_coupling_type::couple_cfg_type::read_config	(	class(couple_cfg_type), intent(inout)	self,
		character(*), intent(in)	file_namelist,
		integer, intent(in)	unamelist
	)

read configuration for the couple_cfg_type class from the mhm namelist

Parameters

[in]	file_namelist	mhm namelist file
[in]	unamelist	unit to open namelist file

See also: mo_coupling_type::read_config

Definition at line 51 of file mo_coupling_type.f90.

◆ set_config()

procedure mo_coupling_type::couple_cfg_type::set_config	(	class(couple_cfg_type), intent(inout)	self,
		integer(i4), intent(in), optional	case,
		integer(i4), intent(in), optional	meteo_timestep,
		logical, intent(in), optional	meteo_time_ref_endpoint,
		logical, intent(in), optional	meteo_expect_pre,
		logical, intent(in), optional	meteo_expect_temp,
		logical, intent(in), optional	meteo_expect_pet,
		logical, intent(in), optional	meteo_expect_tmin,
		logical, intent(in), optional	meteo_expect_tmax,
		logical, intent(in), optional	meteo_expect_netrad,
		logical, intent(in), optional	meteo_expect_absvappress,
		logical, intent(in), optional	meteo_expect_windspeed,
		logical, intent(in), optional	meteo_expect_ssrd,
		logical, intent(in), optional	meteo_expect_strd,
		logical, intent(in), optional	meteo_expect_tann,
		logical, intent(in), optional	read_nml
	)

set configuration for the couple_cfg_type class

Parameters

[in]	case	coupling case
[in]	meteo_timestep	timestep for meteo-data from coupling
[in]	meteo_time_ref_endpoint	expect meteo has time reference point at end of time interval
[in]	meteo_expect_pre	expect meteo from coupling: [mm] Precipitation
[in]	meteo_expect_temp	expect meteo from coupling: [degC] Air temperature
[in]	meteo_expect_pet	expect meteo from coupling: [mm TS-1] Potential evapotranspiration
[in]	meteo_expect_tmin	expect meteo from coupling: [degC] minimum daily air temperature
[in]	meteo_expect_tmax	expect meteo from coupling: [degC] maximum daily air temperature
[in]	meteo_expect_netrad	expect meteo from coupling: [W m2] net radiation
[in]	meteo_expect_absvappress	expect meteo from coupling: [Pa] absolute vapour pressure
[in]	meteo_expect_windspeed	expect meteo from coupling: [m s-1] windspeed
[in]	meteo_expect_ssrd	expect meteo from coupling: [W m2] short wave radiation
[in]	meteo_expect_strd	expect meteo from coupling: [W m2] long wave radiation
[in]	meteo_expect_tann	expect meteo from coupling: [degC] annual mean air temperature
[in]	read_nml	whether to read the namelist (or set via routine)

See also: mo_coupling_type::set_config

Definition at line 53 of file mo_coupling_type.f90.

Member Data Documentation

◆ case

integer(i4) mo_coupling_type::couple_cfg_type::case

coupling case (0: no coupling, 1: single domain coupling)

Definition at line 33 of file mo_coupling_type.f90.

◆ meteo_expect_absvappress

logical mo_coupling_type::couple_cfg_type::meteo_expect_absvappress

expect meteo from coupling: [Pa] absolute vapour pressure

Definition at line 42 of file mo_coupling_type.f90.

◆ meteo_expect_netrad

logical mo_coupling_type::couple_cfg_type::meteo_expect_netrad

expect meteo from coupling: [W m2] net radiation

Definition at line 41 of file mo_coupling_type.f90.

◆ meteo_expect_pet

logical mo_coupling_type::couple_cfg_type::meteo_expect_pet

expect meteo from coupling: [mm TS-1] Potential evapotranspiration

Definition at line 38 of file mo_coupling_type.f90.

◆ meteo_expect_pre

logical mo_coupling_type::couple_cfg_type::meteo_expect_pre

expect meteo from coupling: [mm] Precipitation

Definition at line 36 of file mo_coupling_type.f90.

◆ meteo_expect_ssrd

logical mo_coupling_type::couple_cfg_type::meteo_expect_ssrd

expect meteo from coupling: [W m2] short wave radiation

Definition at line 45 of file mo_coupling_type.f90.

◆ meteo_expect_strd

logical mo_coupling_type::couple_cfg_type::meteo_expect_strd

expect meteo from coupling: [W m2] long wave radiation

Definition at line 46 of file mo_coupling_type.f90.

◆ meteo_expect_tann

logical mo_coupling_type::couple_cfg_type::meteo_expect_tann

expect meteo from coupling: [degC] annual mean air temperature

Definition at line 47 of file mo_coupling_type.f90.

◆ meteo_expect_temp

logical mo_coupling_type::couple_cfg_type::meteo_expect_temp

expect meteo from coupling: [degC] Air temperature

Definition at line 37 of file mo_coupling_type.f90.

◆ meteo_expect_tmax

logical mo_coupling_type::couple_cfg_type::meteo_expect_tmax

expect meteo from coupling: [degC] maximum daily air temperature

Definition at line 40 of file mo_coupling_type.f90.

◆ meteo_expect_tmin

logical mo_coupling_type::couple_cfg_type::meteo_expect_tmin

expect meteo from coupling: [degC] minimum daily air temperature

Definition at line 39 of file mo_coupling_type.f90.

◆ meteo_expect_windspeed

logical mo_coupling_type::couple_cfg_type::meteo_expect_windspeed

expect meteo from coupling: [m s-1] windspeed

Definition at line 43 of file mo_coupling_type.f90.

◆ meteo_time_ref_endpoint

logical mo_coupling_type::couple_cfg_type::meteo_time_ref_endpoint

expect meteo has time reference point at end of associated time interval

Definition at line 35 of file mo_coupling_type.f90.

◆ meteo_timestep

integer(i4) mo_coupling_type::couple_cfg_type::meteo_timestep

timestep for meteo-data from coupling

Definition at line 34 of file mo_coupling_type.f90.

◆ nml_name

character(256) mo_coupling_type::couple_cfg_type::nml_name = 'coupling'

namelist name in mhm namelist

Definition at line 31 of file mo_coupling_type.f90.

◆ read_nml

logical mo_coupling_type::couple_cfg_type::read_nml = .true.

whether to read the namelist (or set via routine)

Definition at line 32 of file mo_coupling_type.f90.

The documentation for this module was generated from the following file:

src/coupling/mo_coupling_type.f90

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ active()

◆ any_meteo_expected()

◆ check()

◆ clean_up()

◆ read_config()

◆ set_config()

Member Data Documentation

◆ case

◆ meteo_expect_absvappress

◆ meteo_expect_netrad

◆ meteo_expect_pet

◆ meteo_expect_pre

◆ meteo_expect_ssrd

◆ meteo_expect_strd

◆ meteo_expect_tann

◆ meteo_expect_temp

◆ meteo_expect_tmax

◆ meteo_expect_tmin

◆ meteo_expect_windspeed

◆ meteo_time_ref_endpoint

◆ meteo_timestep

◆ nml_name

◆ read_nml