hwrf.coupling.Component Class Reference

Detailed Description

This is a simple utility class that stores information about
coupler components (wrf, pom, hycom, wavewatch3, coupler, etc.)
for the CoupledWRF class.  You should never instantiate a
Component -- only CoupledWRF should do that.  It will return one
of these when you run CoupledWRF's "component" function.

You can safely modify the exe, rankname, rankdefault and initer
elements of this class, and it will modify the corresponding
information in the CoupledWRF.  Do not modify the name and order.
Modifying the name or order will break the internal data
structures in CoupledWRF

Definition at line 14 of file coupling.py.

Inheritance diagram for hwrf.coupling.Component:

Public Member Functions
def	__init__ (self, name, exe, rankname, rankdefault, initer)
def	name (self)
def	order (self)

Constructor & Destructor Documentation

def hwrf.coupling.Component.__init__	(		self,
			name,
			exe,
			rankname,
			rankdefault,
			initer
	)

Creates a Component with the given characteristics.
Initializes the order to None.  The order must be overwritten
externally, and is done in CoupledWRF.couple.

Definition at line 26 of file coupling.py.

---

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

• /mnt/pan2/projects/hwrfv3/Samuel.Trahan/trunk/ush/hwrf/coupling.py