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

Class ModelConstructor

source code

object --+
         |
        ModelConstructor

Instance Methods [hide private]
 
__init__(self, name, userevents=None, userfns=None, unravelInfo=True, inputs=None, checklevel=2, activateAllBounds=False, generatorspecs=None, indepvar=('t', [-inf, inf]), parvalues=None, icvalues=None, tdata=None, reuseTerms=None, withJac=None, withJacP=None, featureDicts=None, abseps=None, eventtol=None, eventPars=None, withStdEvts=None, stdEvtArgs=None)
Notes for initialization arguments.
source code
 
__repr__(self)
repr(x)
source code
 
_genFromMSpec(self, geninfodesc) source code
 
_genFromStrings(self, geninfodesc) source code
 
activateBounds(self, varname=None, which_bounds='all')
which_bounds argument is either 'all', 'lo', 'hi', or a pair ('lo', 'hi').
source code
 
addEvents(self, hostGen, evTarg, eventPars=None) source code
 
addFeatures(self, hostGen, featDict)
Update with feature -> Bool mapping dictionaries for a host generator.
source code
 
addFunctions(self, hostGen, fnTarg) source code
 
addModelInfo(self, genSpec, genTarg, genAlgPars={}, unravelInfo={}, genOpts={})
genSpec can either be a complete ModelSpec description or a string-based dictionary of definitions.
source code
 
createGenerators(self)
Create the generators from the source specs, either in the form of dicts or args objects, or as a GDescriptor.
source code
 
createJac(self) source code
 
createJacP(self) source code
 
createStdEvts(self) source code
 
getModel(self)
Build and return (hybrid) model made up of declared Generators and the mappings between events used to change vector fields in a hybrid system.
source code
 
mapEvent(self, hostGen, eventname, target, eventmapping=None)
eventmapping may be a dictionary or an EvMapping product.
source code
 
preprocessFlatten(self) source code
 
preprocessReuseTerms(self) source code
 
setInternalVars(self, arg) source code
 
setReuseTerms(self, rdict) source code

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, name, userevents=None, userfns=None, unravelInfo=True, inputs=None, checklevel=2, activateAllBounds=False, generatorspecs=None, indepvar=('t', [-inf, inf]), parvalues=None, icvalues=None, tdata=None, reuseTerms=None, withJac=None, withJacP=None, featureDicts=None, abseps=None, eventtol=None, eventPars=None, withStdEvts=None, stdEvtArgs=None)
(Constructor)

source code 
Notes for initialization arguments.

name : string name of this ModelConstructor

** The following are applied to all Generators

activateAllBounds : Boolean
checklevel : integer
indepvar : pair of (independent var name, pair giving domain interval)

** The following are dictionaries keyed by Generator name, with values:

generatorspecs : ModelSpecs
userevents : list of Event objects
userfns : dictionary of named user functions specs
inputs : dictionary of Variable objects
algparams : dictionary of algorithmic parameters for Generator
parvalues : dictionary of parameter values
icvalues : dictionary of initial condition values
reuseterms : dictionary of reused terms in specifications
eventPars : list of parameter names associated solely with events
withStdEvts : Boolean for making standard events (bounds & turning points)
stdEvtArgs : arguments for the standard events
featureDicts : dictionary of Features for making each Model Interface
withJac : Boolean for making Jacobian
withJacP : Boolean for making Jacobian with respect to parameters

RETURNS: Nothing, but getModel method returns an instantiated Model
  object when the specifications are complete and consistent.

Overrides: object.__init__

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)

activateBounds(self, varname=None, which_bounds='all')

source code 

which_bounds argument is either 'all', 'lo', 'hi', or a pair ('lo', 'hi'). Calling with no arguments defaults to activating all bounds.

createGenerators(self)

source code 

Create the generators from the source specs, either in the form of dicts or args objects, or as a GDescriptor.

Still some teething trouble getting expected types neat and tidy.

mapEvent(self, hostGen, eventname, target, eventmapping=None)

source code 

eventmapping may be a dictionary or an EvMapping product. You must have declared all generators before calling this function!