Package PyDSTool :: Package Generator :: Module ExplicitFnGen' :: Class ExplicitFnGen
[hide private]
[frames] | no frames]

Class ExplicitFnGen

source code

           object --+        
                    |        
baseclasses.Generator --+    
                        |    
       baseclasses.ctsGen --+
                            |
                           ExplicitFnGen

Explicit functional form specifying a trajectory.

E.g. for an external input. This class allows parametric forms of the function, but with no dependence on x or its own external inputs.

Instance Methods [hide private]
 
AuxVars(self, t, xdict, pdict=None, asarray=True)
asarray is an unused, dummy argument for compatibility with Model.AuxVars
source code
 
__del__(self) source code
 
__init__(self, kw)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
addMethods(self, usePsyco=False)
Add Python-specific functions to this object's methods, accelerating them with psyco, if it is available.
source code
 
compute(self, trajname, ics=None)
Attach specification functions to callable interface.
source code
 
haveJacobian(self)
Report whether generator has an explicit user-specified Jacobian associated with it.
source code
 
haveJacobian_pars(self)
Report whether generator has an explicit user-specified Jacobian with respect to pars associated with it.
source code
 
set(self, **kw)
Set ExplicitFnGen parameters
source code
 
validateSpec(self) source code

Inherited from baseclasses.Generator: __copy__, __deepcopy__, __getstate__, __repr__, __setstate__, __str__, addEvtPars, checkArgs, contains, get, getEventTimes, getEvents, info, query, resetEventTimes, resetEvents, setEventICs, showAuxFnSpec, showAuxSpec, showEventSpec, showSpec

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__

Class Variables [hide private]
  _needKeys = ['name', 'varspecs']
  _optionalKeys = ['globalt0', 'checklevel', 'model', 'abseps', ...
  _validKeys = ['globalt0', 'xdomain', 'tdata', 'tdomain', 'ics'...

Inherited from baseclasses.Generator (private): _querykeys

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__del__(self)
(Destructor)

source code 
Overrides: baseclasses.Generator.__del__

__init__(self, kw)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

haveJacobian(self)

source code 

Report whether generator has an explicit user-specified Jacobian associated with it.

Overrides: baseclasses.Generator.haveJacobian

haveJacobian_pars(self)

source code 

Report whether generator has an explicit user-specified Jacobian with respect to pars associated with it.

Overrides: baseclasses.Generator.haveJacobian_pars

set(self, **kw)

source code 

Set ExplicitFnGen parameters

Overrides: baseclasses.Generator.set

validateSpec(self)

source code 
Overrides: baseclasses.Generator.validateSpec

Class Variable Details [hide private]

_optionalKeys

Value:
['globalt0',
 'checklevel',
 'model',
 'abseps',
 'eventPars',
 'FScompatibleNames',
 'FScompatibleNamesInv',
 'tdomain',
...

_validKeys

Value:
['globalt0',
 'xdomain',
 'tdata',
 'tdomain',
 'ics',
 'pars',
 'checklevel',
 'pdomain',
...