optics_lookup.F90 File Reference

The mam_optics_lookup module. More...

Go to the source code of this file.

Data Types
interface	mam_optics_lookup::optics_data_t
interface	mam_optics_lookup::optics_lookup_t

Modules
module	mam_optics_lookup
	The optics_lookup_t type and related functions.

Functions/Subroutines
type(optics_lookup_t) function	mam_optics_lookup::constructor (config)
	Constructor of optics lookup objects. More...
type(optics_data_t) function	mam_optics_lookup::optics_data_constructor (parameter_name, lookup_file, config)
	Constructor of optics lookup data objects. More...
pure subroutine	mam_optics_lookup::optics_data_lookup (this, band_index, indices, residuals, axis, chebyshev_values)
	Looks up optical property data at a given wavelength band. More...

Variables
integer, parameter	mam_optics_lookup::knumberofparameters = 3
	Number of possible optics parameters. More...
Local indices for optics parameters
Todo: are "specific extinction", "specific absorption", and "asymmetry factor" the correct names for the optical properties returned from the lookup tables?
integer, parameter	mam_optics_lookup::kabsorption = 1
integer, parameter	mam_optics_lookup::kasymmetryfactor = 3
integer, parameter	mam_optics_lookup::kextinction = 2
optical properties (Chebychev coefficient, wavelength band)
Lookup optics properties for a given wavelength-dependent refractive index Todo: there is no check to make sure the requested data is actually present, as this would require making this not a pure function. Check to see if this being a pure function has any benefit Parameters [in] refractive_indices Complex indices of refraction (wavelength band)
real(kind=musica_dk), dimension(:,:), intent(out), optional	absorption
real(kind=musica_dk), dimension(:,:), intent(out), optional	asymmetry_factor
real(kind=musica_dk), dimension(:,:), intent(out), optional	extinction
type(wavelength_grid_t) function	mam_optics_lookup::grid (this)
	Returns the wavelength grid that the properties are returned on. More...
integer	i_band
integer, dimension(2)	indices
real(kind=musica_dk) elemental function	mam_optics_lookup::maximum_radius__m (this)
	Returns the maximum radius of the range used to calculate the Chebychev coefficients. More...
real(kind=musica_dk) elemental function	mam_optics_lookup::minimum_radius__m (this)
	Returns the minimum radius of the range used to calculate the Chebychev coefficients. More...
real(kind=musica_dk) elemental function	mam_optics_lookup::normalize_radius (this, radius__m)
	Normalizes a radius to the range used to calculate the Chebychev coefficients. More...
integer elemental function	mam_optics_lookup::number_of_chebyshev_coefficients (this)
	Returns the number of Chebyshev coefficients per band and property. More...
integer elemental function	mam_optics_lookup::number_of_wavelength_bands (this)
	Returns the number of wavelength bands for each property. More...
real(kind=musica_dk), dimension(2)	residuals
subroutine	mam_optics_lookup::set_grid (this, config, lookup_file)
	Sets the wavelength grid for an optics_lookup_t object. More...

Detailed Description

The mam_optics_lookup module.

Definition in file optics_lookup.F90.

Variable Documentation

absorption

real(kind=musica_dk), dimension(:,:), intent(out), optional absorption

private

Definition at line 171 of file optics_lookup.F90.

Referenced by mam_mode::add_longwave_optics(), mam_mode::add_shortwave_optics(), specific_absorption(), and test_optics_lookup_t().

asymmetry_factor

real(kind=musica_dk), dimension(:,:), intent(out), optional asymmetry_factor

private

Definition at line 173 of file optics_lookup.F90.

Referenced by mam_optics_util::add_shortwave_asymmetry_factor(), mam_optics_util::add_shortwave_extinction_optical_depth(), mam_optics_util::add_shortwave_forward_scattered_fraction(), mam_mode::add_shortwave_optics(), mam_optics_util::add_shortwave_property(), mam_optics_util::add_shortwave_single_scatter_albedo(), asymmetry_factor(), mam_mode::asymmetry_factor(), test_mode_t(), and test_optics_lookup_t().

extinction

real(kind=musica_dk), dimension(:,:), intent(out), optional extinction

private

Definition at line 172 of file optics_lookup.F90.

Referenced by mam_mode::add_shortwave_optics(), specific_extinction(), and test_optics_lookup_t().

i_band

integer i_band

private

Definition at line 176 of file optics_lookup.F90.

Referenced by mam_mode::asymmetry_factor(), mam_optics_lookup::constructor(), mam_mode::net_longwave_refractive_index(), mam_mode::net_shortwave_refractive_index(), mam_mode::specific_absorption__m2_kg(), and mam_mode::specific_extinction__m2_kg().

indices

integer, dimension(2) indices

private

Definition at line 176 of file optics_lookup.F90.

Referenced by mam_optics_lookup::optics_data_lookup().

residuals

real(kind=musica_dk), dimension(2) residuals

private

Definition at line 177 of file optics_lookup.F90.

Referenced by mam_optics_lookup::optics_data_lookup().