4.11.1.1. `refractiveIndex.core`¶

refractive module core submodule

Copyright (C) 2017 - 2018 Davide Ori dori@uni-koeln.de Institute for Geophysics and Meteorology - University of Cologne

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

This module provides a list of ice and water refractive index models to compute the dielectric properties of ice according to the requested frequencies and temeperatures. The module is completed with some Effective Medium approximation functions to compute the refractive index of inhomogeneous mixtures of materials which are directly used to compute the dielectric properties of snow as a dilution of ice in air.

This core file loads submodules and provide handy functions to consistently call ice, water or snow refractive index modules

Example

$ python >>> import refractiveIndex >>> refractiveIndex.n(temperatures, frequencies, **kwargs)

and returns the complex refractive index of ice at the requested Temperature [Kelvin] and Frequency [Hz]

Notes

It is possible to call the functions implemented in this module using nd-arrays. The function arguments must either have exactly the same shape allowing element-wise application of the functions or one of the two must be a scalar which will be spread across the nd computations

Frequencies and Temperatures are always mandatory arguments as name of the substance, but specific algorithms requires special additional arguments to be passed in order to proceed (for instance snow density must be defined). The functions check for argument consistency and raise AttributeError if a wrong list of attributes is passed.

All of the argument quatities must be provided in SI units: Temperatures in Kelvin, frequencies in Hz, densities in kg/m3. The specific called algorithm check for arguments values to be within the limits of validity of the dielectric model and raises ValueError in case they are not respected

4.11.1.1.1. Module Contents¶

4.11.1.1.1.1. Functions¶

`n`(substance, temperatures, frequencies, **kwargs)	Complex index of refraction of the requested substance according to the
`eps`(substance, temperatures, frequencies, **kwargs)	Complex relative dielectric permittivity of the requested substance
`mk`(frequency=None, wavelength=None, refractive_index=None, substance=None, **kwargs)	Interaction depth
`skin_depth`(frequency=None, wavelength=None, refractive_index=None, substance=None, **kwargs)	Skin depth in the material
`magnetic2electric_ratio`(size=None, frequency=None, wavelength=None, refractive_index=None, substance=None, **kwargs)	Ratio between the absorption cross section due to magnetic dipoles and

4.11.1.1.1.2. Attributes¶

substances_list

substances_list = ['ice', 'water', 'snow'][source]¶

n(substance, temperatures, frequencies, **kwargs)[source]¶

Complex index of refraction of the requested substance according to the: requested specifications

Parameters

temperatures (float) – nd array of temperatures [Kelvin]
frequencies (float) – nd array of frequencies [Hz]
**kwargs (additional arguments to be passed to the requested model) –

Returns

Refractive index of the requested substance using the requested options

Return type

nd - complex

Raises

AttributeError – If an uncorrect list of arguments is passed

eps(substance, temperatures, frequencies, **kwargs)[source]¶

Complex relative dielectric permittivity of the requested substance: according to the requested specifications