HWRF  trunk@4391
Public Member Functions | List of all members
pom.init.phase Class Reference

Runs a later phase of the ocean init to add additional features such as cold wakes. More...

Detailed Description

Runs a later phase of the ocean init to add additional features such as cold wakes.

Definition at line 469 of file init.py.

Inheritance diagram for pom.init.phase:
pom.init.Oceanini pom.init.Hwrf

Public Member Functions

def __init__ (self, args, kargs)
 phase constructor More...
 
def getinp
 Links all input data. More...
 
def setrun
 Runs the phase initialization. More...
 
def sendout
 Delivers an output file using produtil.fileop.deliver_file() More...
 
- Public Member Functions inherited from pom.init.Oceanini
def __init__ (self, ODIR, DOMAIN, ODATA, SSTASIM, STORMNAME, STORMID, STARTDATE, EXEChwrf, PARMhwrf, FIXhwrf, LCDIR, GFSDIR, CSTREAM, COMIN, sync_frequently=False, kwargs)
 Oceanini constructor. More...
 
def setpath
 Creates the ocean run path, whose subdirectory is SUBDIR. More...
 
- Public Member Functions inherited from pom.init.Hwrf
def __init__
 Hwrf constructor. More...
 

Additional Inherited Members

- Public Attributes inherited from pom.init.Oceanini
 ODIR
 Ocean output directory in CSTREAM.
 
 DOMAIN
 Ocean domain. More...
 
 ODATA
 Type of ocean data. More...
 
 SSTASIM
 SST ASIM flag, True or False.
 
 conf
 A ConfigParser-like object to use for configuration information. More...
 
- Public Attributes inherited from pom.init.Hwrf
 STORMNAME
 Upper-case storm name for filenames (KATRINA)
 
 STORMID
 Three character storm number and basin, upper-case (12L)
 
 STARTDATE
 Simulation analysis time as a string, YYYYMMDDHH (2005082918)
 
 EXEChwrf
 Directory with HWRF executables. More...
 
 PARMhwrf
 Directory with HWRF parameter files. More...
 
 LCDIR
 Directory with loop current files.
 
 GFSDIR
 Directory with input files from GFS. More...
 
 FIXhwrf
 Directory with HWRF fixed files. More...
 
 CSTREAM
 Directory to place files for the POM forecast to read. More...
 
 COMIN
 HWRF final output directory. More...
 
 sync_frequently
 

Constructor & Destructor Documentation

def pom.init.phase.__init__ (   self,
  args,
  kargs 
)

phase constructor

Parameters
args,kargsAll arguments are passed to Oceanini.__init__()

Definition at line 472 of file init.py.

Member Function Documentation

def pom.init.phase.getinp (   self,
  DEST,
  logger = None 
)

Links all input data.

Parameters
DESTDirectory in which to link files.
loggera logging.Logger for log messages

Definition at line 476 of file init.py.

def pom.init.phase.sendout (   self,
  SRC,
  infile,
  DEST,
  outfile,
  logger = None 
)

Delivers an output file using produtil.fileop.deliver_file()

Parameters
SRCDirectory with the input file.
infileBasename of the input file inside of SRC
DESTDestination directory of the file
outfileName of the file in the DEST directory.
loggerA logging.Logger for log messages.

Definition at line 524 of file init.py.

def pom.init.phase.setrun (   self,
  DEST,
  logger = None 
)

Runs the phase initialization.

Parameters
DESTThe directory in which to run.
loggerA logging.Logger for log messages.

Definition at line 499 of file init.py.


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