esys.escript.modelframe

Package esys :: Package escript :: Module modelframe

[show private | hide private]

Module esys.escript.modelframe

Environment for implementing models in escript

Classes
`Link`	A Link makes an attribute of an object callable:
`LinkableObject`	An object that allows to link its attributes to attributes of other objects via a Link object.
`Model`	A Model object represents a processess marching over time until a finalizing condition is fullfilled.
`ParameterSet`	A class which allows to emphazise attributes to be written and read to XML
`Simulation`	A Simulation object is special Model which runs a sequence of Models.

Exceptions
`FailedTimeStepError`	Exception which is thrown if the time step fails because of a step size that have been choosen to be too large.
`IterationDivergenceError`	Exception which is thrown if there is no convergence of the iteration process at a time step.
`NonPositiveStepSizeError`	Exception which is thrown if the step size is not positive.
`SimulationBreakDownError`	Exception which is thrown if the simulation does not manage to progress in time.

Function Summary
	`all(seq)`
	`any(seq)`
	`dataNode(document, tagName, data)` `dataNode`s are the building blocks of the xml documents constructed in this module.
	`esysDoc()` Global method for creating an instance of an EsysXML document.
	`getComponent(doc)` Used to get components of Simualtions, Models.
	`importName(modulename, name)` Import a named object from a module in the context of this function, which means you should use fully qualified module paths.
	`parse(xml)` Generic parse method for EsysXML.
	`registerLink(obj_id, l)`
	`registerLinkableObject(obj_id, o)`

Variable Summary
`str`	`__author__`: name of author
`str`	`__copyright__`: copyrights
`str`	`__date__`: date of the version
`str`	`__license__`: licence agreement
`str`	`__url__`: url entry point on documentation
`str`	`__version__`: version
`dict`	`LinkableObjectRegistry` = `{}`
`list`	`LinkRegistry` = `[]`
`_DevNull`	`stdout` = `<epydoc.imports._DevNull instance at 0x402244cc...`

Function Details

dataNode(document, tagName, data)

dataNodes are the building blocks of the xml documents constructed in this module.

Parameters:: document - the current xml document; tagName - the associated xml tag; data - the values in the tag

esysDoc()

Global method for creating an instance of an EsysXML document.

getComponent(doc)

Used to get components of Simualtions, Models.

importName(modulename, name)

Import a named object from a module in the context of this function, which means you should use fully qualified module paths.

Return None on failure.

This function from: http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/52241

parse(xml)

Generic parse method for EsysXML. Without this, Links don't work.

Variable Details

author

name of author

Type:: str
Value:: 'Lutz Gross, l.gross@uq.edu.au'

copyright

copyrights

Type:: str
Value:: ''' Copyright (c) 2006 by ACcESS MNRF http://www.access.edu.au Primary Business: Queensland, Australia'''

date

date of the version

Type:: str
Value:: '$Date: 2006-03-23 20:55:31 +1000 (Thu, 23 Mar 2006) $'

license

licence agreement

Type:: str
Value:: '''Licensed under the Open Software License version 3.0 http://www.opensource.org/licenses/osl-3.0.php'''

url

url entry point on documentation

Type:: str
Value:: 'http://www.iservo.edu.au/esys'

version

Type:: str
Value:: '$Revision: 637 $'

LinkableObjectRegistry

Type:: dict
Value:: {}

LinkRegistry

Type:: list
Value:: []

stdout

Type:: _DevNull
Value:: <epydoc.imports._DevNull instance at 0x402244cc>

Generated by Epydoc 2.1 on Thu Apr 27 11:16:17 2006

http://epydoc.sf.net