ty_gas_optics Derived Type

type, public, abstract, extends(ty_optical_props) :: ty_gas_optics

Inherits

Type-Bound Procedures

procedure, public :: bands_are_equal

private pure function bands_are_equal(this, that)
Are the bands of two objects the same? (same number, same wavelength limits)

Arguments

Type Intent Optional Attributes Name

class(ty_optical_props), intent(in) :: this

class(ty_optical_props), intent(in) :: that

Return Value logical

procedure, public :: convert_band2gpt

private pure function convert_band2gpt(this, band)
First and last g-point of a specific band

Arguments

Type Intent Optional Attributes Name

class(ty_optical_props), intent(in) :: this

integer, intent(in) :: band

Return Value integer,dimension(2)

procedure, public :: convert_gpt2band

private pure function convert_gpt2band(this, gpt)
Band associated with a specific g-point

Arguments

Type Intent Optional Attributes Name

class(ty_optical_props), intent(in) :: this

integer, intent(in) :: gpt

Return Value integer

procedure, public :: expand

private pure function expand(this, arr_in) result(arr_out)
Expand an array of dimension arr_in(nband) to dimension arr_out(ngpt)

Arguments

Type Intent Optional Attributes Name

class(ty_optical_props), intent(in) :: this

real(kind=wp), intent(in), dimension(:) :: arr_in

Return Value real(kind=wp),dimension(size(this%gpt2band))

procedure, public :: finalize => finalize_base

private subroutine finalize_base(this)
Base class: finalize (deallocate memory)
Read more…
Arguments

Type Intent Optional Attributes Name

class(ty_optical_props), intent(inout) :: this

generic, public :: gas_optics => gas_optics_int, gas_optics_ext

function gas_optics_int_abstract(this, play, plev, tlay, tsfc, gas_desc, optical_props, sources, col_dry, tlev) result(error_msg)Prototype

Arguments

Type	Intent	Optional	Attributes		Name
class(ty_gas_optics),	intent(in)			::	this
real(kind=wp),	intent(in),		dimension(:,:)	::	play	layer pressures [Pa, mb]; (ncol,nlay) level pressures [Pa, mb]; (ncol,nlay+1) layer temperatures [K]; (ncol,nlay)
real(kind=wp),	intent(in),		dimension(:,:)	::	plev	layer pressures [Pa, mb]; (ncol,nlay) level pressures [Pa, mb]; (ncol,nlay+1) layer temperatures [K]; (ncol,nlay)
real(kind=wp),	intent(in),		dimension(:,:)	::	tlay	layer pressures [Pa, mb]; (ncol,nlay) level pressures [Pa, mb]; (ncol,nlay+1) layer temperatures [K]; (ncol,nlay)
real(kind=wp),	intent(in),		dimension(:)	::	tsfc	surface skin temperatures [K]; (ncol)
type(ty_gas_concs),	intent(in)			::	gas_desc	Gas volume mixing ratios
class(ty_optical_props_arry),	intent(inout)			::	optical_props	Optical properties
class(ty_source_func_lw),	intent(inout)			::	sources	Planck sources
real(kind=wp),	intent(in),	optional	dimension(:,:), target	::	col_dry	Column dry amount (molecules/cm^2); dim(ncol,nlay) level temperatures [K]l (ncol,nlay+1)
real(kind=wp),	intent(in),	optional	dimension(:,:), target	::	tlev	Column dry amount (molecules/cm^2); dim(ncol,nlay) level temperatures [K]l (ncol,nlay+1)

Return Value character(len=128)

Empty if successful

function gas_optics_ext_abstract(this, play, plev, tlay, gas_desc, optical_props, toa_src, col_dry) result(error_msg)Prototype

Arguments

Type	Intent	Optional	Attributes		Name
class(ty_gas_optics),	intent(in)			::	this
real(kind=wp),	intent(in),		dimension(:,:)	::	play	layer pressures [Pa, mb]; (ncol,nlay) level pressures [Pa, mb]; (ncol,nlay+1) layer temperatures [K]; (ncol,nlay)
real(kind=wp),	intent(in),		dimension(:,:)	::	plev	layer pressures [Pa, mb]; (ncol,nlay) level pressures [Pa, mb]; (ncol,nlay+1) layer temperatures [K]; (ncol,nlay)
real(kind=wp),	intent(in),		dimension(:,:)	::	tlay	layer pressures [Pa, mb]; (ncol,nlay) level pressures [Pa, mb]; (ncol,nlay+1) layer temperatures [K]; (ncol,nlay)
type(ty_gas_concs),	intent(in)			::	gas_desc	Gas volume mixing ratios
class(ty_optical_props_arry),	intent(inout)			::	optical_props
real(kind=wp),	intent(out),		dimension(:,:)	::	toa_src	Incoming solar irradiance(ncol,ngpt)
real(kind=wp),	intent(in),	optional	dimension(:,:), target	::	col_dry	Column dry amount (molecules/cm^2); dim(ncol,nlay)

Return Value character(len=128)

Empty if successful

procedure(gas_optics_ext_abstract), public, deferred :: gas_optics_ext

function gas_optics_ext_abstract(this, play, plev, tlay, gas_desc, optical_props, toa_src, col_dry) result(error_msg)Prototype

Arguments

Type	Intent	Optional	Attributes		Name
class(ty_gas_optics),	intent(in)			::	this
real(kind=wp),	intent(in),		dimension(:,:)	::	play	layer pressures [Pa, mb]; (ncol,nlay) level pressures [Pa, mb]; (ncol,nlay+1) layer temperatures [K]; (ncol,nlay)
real(kind=wp),	intent(in),		dimension(:,:)	::	plev	layer pressures [Pa, mb]; (ncol,nlay) level pressures [Pa, mb]; (ncol,nlay+1) layer temperatures [K]; (ncol,nlay)
real(kind=wp),	intent(in),		dimension(:,:)	::	tlay	layer pressures [Pa, mb]; (ncol,nlay) level pressures [Pa, mb]; (ncol,nlay+1) layer temperatures [K]; (ncol,nlay)
type(ty_gas_concs),	intent(in)			::	gas_desc	Gas volume mixing ratios
class(ty_optical_props_arry),	intent(inout)			::	optical_props
real(kind=wp),	intent(out),		dimension(:,:)	::	toa_src	Incoming solar irradiance(ncol,ngpt)
real(kind=wp),	intent(in),	optional	dimension(:,:), target	::	col_dry	Column dry amount (molecules/cm^2); dim(ncol,nlay)

Return Value character(len=128)

Empty if successful

procedure(gas_optics_int_abstract), public, deferred :: gas_optics_int

function gas_optics_int_abstract(this, play, plev, tlay, tsfc, gas_desc, optical_props, sources, col_dry, tlev) result(error_msg)Prototype

Arguments

Type	Intent	Optional	Attributes		Name
class(ty_gas_optics),	intent(in)			::	this
real(kind=wp),	intent(in),		dimension(:,:)	::	play	layer pressures [Pa, mb]; (ncol,nlay) level pressures [Pa, mb]; (ncol,nlay+1) layer temperatures [K]; (ncol,nlay)
real(kind=wp),	intent(in),		dimension(:,:)	::	plev	layer pressures [Pa, mb]; (ncol,nlay) level pressures [Pa, mb]; (ncol,nlay+1) layer temperatures [K]; (ncol,nlay)
real(kind=wp),	intent(in),		dimension(:,:)	::	tlay	layer pressures [Pa, mb]; (ncol,nlay) level pressures [Pa, mb]; (ncol,nlay+1) layer temperatures [K]; (ncol,nlay)
real(kind=wp),	intent(in),		dimension(:)	::	tsfc	surface skin temperatures [K]; (ncol)
type(ty_gas_concs),	intent(in)			::	gas_desc	Gas volume mixing ratios
class(ty_optical_props_arry),	intent(inout)			::	optical_props	Optical properties
class(ty_source_func_lw),	intent(inout)			::	sources	Planck sources
real(kind=wp),	intent(in),	optional	dimension(:,:), target	::	col_dry	Column dry amount (molecules/cm^2); dim(ncol,nlay) level temperatures [K]l (ncol,nlay+1)
real(kind=wp),	intent(in),	optional	dimension(:,:), target	::	tlev	Column dry amount (molecules/cm^2); dim(ncol,nlay) level temperatures [K]l (ncol,nlay+1)

Return Value character(len=128)

Empty if successful

procedure, public :: get_band_lims_gpoint

private pure function get_band_lims_gpoint(this)
The first and last g-point of all bands at once dimension (2, nbands)

Arguments

Type Intent Optional Attributes Name

class(ty_optical_props), intent(in) :: this

Return Value integer,dimension(size(this%band2gpt,dim=1), size(this%band2gpt,dim=2))

procedure, public :: get_band_lims_wavelength

private pure function get_band_lims_wavelength(this)
Lower and upper wavelength of all bands

Arguments

Type Intent Optional Attributes Name

class(ty_optical_props), intent(in) :: this

Return Value real(kind=wp),dimension(size(this%band_lims_wvn,1), size(this%band_lims_wvn,2))

procedure, public :: get_band_lims_wavenumber

private pure function get_band_lims_wavenumber(this)
Lower and upper wavenumber of all bands (upper and lower wavenumber by band) = band_lims_wvn(2,band)

Arguments

Type Intent Optional Attributes Name

class(ty_optical_props), intent(in) :: this

Return Value real(kind=wp),dimension(size(this%band_lims_wvn,1), size(this%band_lims_wvn,2))

procedure, public :: get_gpoint_bands

private pure function get_gpoint_bands(this)
Bands for all the g-points at once dimension (ngpt)

Arguments

Type Intent Optional Attributes Name

class(ty_optical_props), intent(in) :: this

Return Value integer,dimension(size(this%gpt2band,dim=1))

procedure, public :: get_name

private function get_name(this)

Arguments

Type Intent Optional Attributes Name

class(ty_optical_props), intent(in) :: this

Return Value character(len=name_len)

procedure, public :: get_nband

private pure function get_nband(this)
Number of bands

Arguments

Type Intent Optional Attributes Name

class(ty_optical_props), intent(in) :: this

Return Value integer

procedure, public :: get_ngpt

private pure function get_ngpt(this)
Number of g-points

Arguments

Type Intent Optional Attributes Name

class(ty_optical_props), intent(in) :: this

Return Value integer

procedure(real_abstract), public, deferred :: get_press_max

function real_abstract(this)Prototype

Arguments

Type Intent Optional Attributes Name

class(ty_gas_optics), intent(in) :: this

Return Value real(kind=wp)

procedure(real_abstract), public, deferred :: get_press_min

function real_abstract(this)Prototype

Arguments

Type Intent Optional Attributes Name

class(ty_gas_optics), intent(in) :: this

Return Value real(kind=wp)

procedure(real_abstract), public, deferred :: get_temp_max

function real_abstract(this)Prototype

Arguments

Type Intent Optional Attributes Name

class(ty_gas_optics), intent(in) :: this

Return Value real(kind=wp)

procedure(real_abstract), public, deferred :: get_temp_min

function real_abstract(this)Prototype

Arguments

Type Intent Optional Attributes Name

class(ty_gas_optics), intent(in) :: this

Return Value real(kind=wp)

procedure, public :: gpoints_are_equal

private pure function gpoints_are_equal(this, that)
Is the g-point structure of two objects the same? (same bands, same number of g-points, same mapping between bands and g-points)

Arguments

Type Intent Optional Attributes Name

class(ty_optical_props), intent(in) :: this

class(ty_optical_props), intent(in) :: that

Return Value logical

generic, public :: init => init_base, init_base_from_copy

private function init_base(this, band_lims_wvn, band_lims_gpt, name) result(err_message)

Base class: Initialization Values are assumed to be defined in bands a mapping between bands and g-points is provided

Arguments

Type	Intent	Optional	Attributes		Name
class(ty_optical_props),	intent(inout)			::	this
real(kind=wp),	intent(in),		dimension(:,:)	::	band_lims_wvn
integer,	intent(in),	optional	dimension(:,:)	::	band_lims_gpt
character(len=*),	intent(in),	optional		::	name

Return Value character(len=128)

private function init_base_from_copy(this, spectral_desc) result(err_message)

Arguments

Type Intent Optional Attributes Name

class(ty_optical_props), intent(inout) :: this

class(ty_optical_props), intent(in) :: spectral_desc

Return Value character(len=128)

procedure, public :: is_initialized => is_initialized_base

private pure function is_initialized_base(this)
Base class: return true if initialized, false otherwise
Read more…
Arguments

Type Intent Optional Attributes Name

class(ty_optical_props), intent(in) :: this

Return Value logical

procedure, public :: set_name

private subroutine set_name(this, name)
--- Setting/getting the name
Read more…
Arguments

Type Intent Optional Attributes Name

class(ty_optical_props), intent(inout) :: this

character(len=*), intent(in) :: name

procedure(logical_abstract), public, deferred :: source_is_external

function logical_abstract(this)Prototype

Arguments

Type Intent Optional Attributes Name

class(ty_gas_optics), intent(in) :: this

Return Value logical

procedure(logical_abstract), public, deferred :: source_is_internal

function logical_abstract(this)Prototype

Arguments

Type Intent Optional Attributes Name

class(ty_gas_optics), intent(in) :: this

Return Value logical