pom.nml.nml Class Reference

Class that generates the namelist for POM. More...

Detailed Description

Class that generates the namelist for POM.

Definition at line 108 of file nml.py.

Inheritance diagram for pom.nml.nml:

Public Member Functions
def	__init__ (self)
	nml constructor. More...
def	__call__ (self, title, netcdf_file, time_start, nread_rst, read_rst_file, write_rst, days, prtd1, nbct, tnowindd, igeovel, nl)
	Updates the namelist values. More...
def	make (self, DEST)
	Writes the POM namelist pom.nml in the destination directory. More...

Public Attributes
	namelist
	a dict mapping from namelist variable name to value. More...
	keys
	A list of namelist variables. More...

Constructor & Destructor Documentation

def pom.nml.nml.__init__

(

self

)

nml constructor.

Generates the namelist.

Definition at line 110 of file nml.py.

Member Function Documentation

def pom.nml.nml.__call__	(		self,
			title,
			netcdf_file,
			time_start,
			nread_rst,
			read_rst_file,
			write_rst,
			days,
			prtd1,
			nbct,
			tnowindd,
			igeovel,
			nl
	)

Updates the namelist values.

Parameters

title	Runs' title.
netcdf_file	POM NetCDF output file (run ID)
time_start	Model analysis time in format "YYYY-MM-DD HH:MM:SS <+/->HH:MM" where the "<+/->HH:MM" is the timezone.
nread_rst	index index to indicate whether run to start from restart file (nread_rst=0: no restart input file; nread_rst=1: restart input file)
read_rst_file	restart input filename
write_rst	Restart interval.
days	Run duration (days)
prtd1	Initial print interval (days)
nbct	Surface temperature boundary condition (see initialize.f)
tnowindd	No prescribed wind after tnowindd (days)
igeovel	Initial geostrophic velocity option. 0=no, 1=yes
nl	Number of Z levels in initial condition files.

Definition at line 153 of file nml.py.

def pom.nml.nml.make	(		self,
			DEST
	)

Writes the POM namelist pom.nml in the destination directory.

Parameters

DEST	destination directory

Definition at line 185 of file nml.py.

Member Data Documentation

pom.nml.nml.keys

A list of namelist variables.

Definition at line 140 of file nml.py.

pom.nml.nml.namelist

a dict mapping from namelist variable name to value.

Definition at line 112 of file nml.py.

Referenced by pom.nml.nml.__call__().

---

The documentation for this class was generated from the following file:

• /mnt/pan2/projects/hwrfv3/Samuel.Trahan/trunk/ush/pom/nml.py