mam_species Module Reference

The species_t type and related functions. More...

Data Types
interface	species_t

Functions/Subroutines
type(species_t) function	constructor (config)
	Constructs species_t objects. More...
complex(kind=musica_dk) elemental function	longwave_refractive_index (this, band)
	Returns the longwave refractive index at a specified band index. More...
type(string_t) function	name (this)
	Returns the species name. More...
complex(kind=musica_dk) elemental function	shortwave_refractive_index (this, band)
	Returns the shortwave refractive index at a specified band index. More...
real(kind=musica_dk) elemental function	volume__m3 (this, species_mass__kg)
	Returns the total volume occupied by the species for a given mass. More...

Detailed Description

The species_t type and related functions.

Function/Subroutine Documentation

constructor()

type(species_t) function mam_species::constructor ( class(config_t), intent(inout)  config )

private

Constructs species_t objects.

Todo:

The complex refractive indices in the NetCDF files use a different convention for specifying the complex index of refraction that results in the need to take the absolute value of the imaginary part to get the complex index of refraction used in MAM. The NetCDF files should be updated to use positive values for the imaginary part.

Definition at line 49 of file species.F90.

Referenced by mam_species::species_t::longwave_refractive_index().

longwave_refractive_index()

complex(kind=musica_dk) elemental function mam_species::longwave_refractive_index ( class(species_t), intent(in)  this, integer, intent(in)  band  )

private

Returns the longwave refractive index at a specified band index.

Definition at line 148 of file species.F90.

Referenced by longwave_refractive_index().

name()

type(string_t) function mam_species::name

(

class(species_t), intent(in)

this

)

Returns the species name.

Definition at line 112 of file species.F90.

Referenced by name().

shortwave_refractive_index()

complex(kind=musica_dk) elemental function mam_species::shortwave_refractive_index ( class(species_t), intent(in)  this, integer, intent(in)  band  )

private

Returns the shortwave refractive index at a specified band index.

Definition at line 135 of file species.F90.

Referenced by shortwave_refractive_index().

volume__m3()

real(kind=musica_dk) elemental function mam_species::volume__m3 ( class(species_t), intent(in)  this, real(kind=musica_dk), intent(in)  species_mass__kg  )

private

Returns the total volume occupied by the species for a given mass.

Definition at line 123 of file species.F90.

Referenced by volume__m3().