Package qtcm :: Module defaults
[hide private]
[frames] | no frames]

Module defaults

source code

Defaults for QTCM fields in the QTCM package.

QTCM fields are model parameters or variables, and includes diagnotic
and prognostic variables, run parameters, coefficients, etc.  They
can be scalars (numeric or string) or arrays.  The values of these
QTCM parameter objects can be changed in the model by a call at the
Python level, though the types of their compiled model counterparts
cannot be changed (without recompiling the compiled model, of
course).

The default values of QTCM fields that are defined in the defaults
module specify the type of the variables, as well as the rank.  This
information is used by the Qtcm class to properly interface with
the compiled model.  Thus, fields that are not specified in the
defaults module will not properly interface with the compiled model.

Module Parameters Defined:
* init_prognostic_dict:  Dictionary giving the default initial
  values of each prognostic variable and right-hand side (as defined
  by the restart file specification).
* qtcm_fields_ids:  List of all the ids in qtcm_fields.
* qtcm_fields:  Dictionary of parameters.

Examples:
>>> print qtcm_fields['dt']['long_name']
time step
>>> print qtcm_fields['dt']['units']
s
>>> print int(qtcm_fields['dt']['value'])
1200
>>> print int(init_prognostic_dict['q1'])
-50


Version: 0.1.2

Date: September 12, 2008

Author: Johnny Lin

Variables [hide private]
  __credits__ = 'http://www.johnny-lin.com/py_pkgs/qtcm/'
  __viscT = 1200000.0
  __viscQ = 1200000.0
  __viscU = 700000.0
  init_prognostic_dict = {'T1': -100.0, 'Ts': 295.0, 'WD': 0.0, ...
  qtcm_fields = {'Evap': {'long_name': '', 'units': '', 'value':...
  qtcm_fields_ids = ['viscyT', 'SSTdir', 'viscyu0', 'viscyu1', '...
Variables Details [hide private]

init_prognostic_dict

Value:
{'T1': -100.0,
 'Ts': 295.0,
 'WD': 0.0,
 'psi0': 0.0,
 'q1': -50.0,
 'rhsu0bar': 0.0,
 'rhsvort0': 0.0,
 'u0': 0.0,
...

qtcm_fields

Value:
{'Evap': {'long_name': '', 'units': '', 'value': array([[ 0.]])},
 'FLW': {'long_name': '', 'units': '', 'value': array([[ 0.]])},
 'FLWds': {'long_name': '', 'units': '', 'value': array([[ 0.]])},
 'FLWus': {'long_name': '', 'units': '', 'value': array([[ 0.]])},
 'FLWut': {'long_name': '', 'units': '', 'value': array([[ 0.]])},
 'FSW': {'long_name': '', 'units': '', 'value': array([[ 0.]])},
 'FSWds': {'long_name': '', 'units': '', 'value': array([[ 0.]])},
 'FSWus': {'long_name': '', 'units': '', 'value': array([[ 0.]])},
...

qtcm_fields_ids

Value:
['viscyT',
 'SSTdir',
 'viscyu0',
 'viscyu1',
 'ntoutr',
 'S0',
 'it',
 'FLW',
...