Package PyDSTool :: Module Model :: Class HybridModel

Class HybridModel

object --+    
         |    
     Model --+
             |
            HybridModel

obsvars specifies the observable variables for this model, which must be present in all trajectory segments (regardless of which other variables are specified in those segments). intvars specifies non-observable (internal) variables for the model, which may or may not be present in trajectory segments, depending on reductions, etc., that are present in the sub-model (e.g. generator) that determines the trajectory segment.

Instance Methods

[hide private]

__init__(self, *a, **kw)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

_prepareICs(self, xdict, traj, ds, t0, ti_1)

source code

_applyStateMap(self, epochStateMaps, model_interface, next_model_interface, traj, xdict, t0)

source code

cleanupMemory(self)
Clean up memory usage from past runs of a solver that is interfaced through a dynamic link library.

source code

_findTrajInitiator(self, end_reasons, partition_num, t0, xdict, mi=None, swRules=None)

source code

_addTraj(self, trajname, trajseq, epochEvents, modelNames, force_overwrite=False)
Add a computed trajectory to database.

source code

haveJacobian(self)
Returns True iff all objects in modelInfo have defined Jacobians.

source code

haveJacobian_pars(self)
Returns True iff all objects in modelInfo have defined Jacobians.

source code

Rhs(self, dsName, t, xdict, pdict=None, asarray=False)
Direct access to a sub-model generator's Rhs function.

source code

Jacobian(self, dsName, t, xdict, pdict=None, asarray=False)
Direct access to a sub-model generator's Jacobian function (if defined).

source code

JacobianP(self, dsName, t, xdict, pdict=None, asarray=False)
Direct access to a generator's JacobianP function (if defined).

source code

MassMatrix(self, dsName, t, xdict, pdict=None, asarray=False)
Direct access to a generator's MassMatrix function (if defined).

source code

AuxVars(self, dsName, t, xdict, pdict=None, asarray=False)
Direct access to a generator's auxiliary variables definition (if defined).

source code

compute(self, trajname, **kw)
Compute a hybrid trajectory and store it internally in the 'trajectories' attribute.

source code

_validateRegistry(self, obsvars, intvars)
Validate Model's modelInfo attribute.

source code

_validateParameters(self)

source code

_infostr(self, verbose=1)
Return string information about named sub-model (if given by dsName) at given verbosity level (default 0)

source code

Inherited from Model: __call__, __copy__, __deepcopy__, __delitem__, __getitem__, __len__, __repr__, __str__, current_defining_args, defaultVars, forceIntVars, forceObsVars, getDSAlgPars, getDSEventActive, getDSEventTerm, getEndPoint, getEndTime, getEventMappings, getTrajEventStruct, getTrajEventTimes, getTrajEvents, getTrajModelName, getTrajTimeInterval, getTrajTimePartitions, has_exact_traj, info, query, renameTraj, resetEventTimes, sample, searchForNames, searchForVars, set, setDSAlgPars, setDSEventActive, setDSEventBisect, setDSEventDelay, setDSEventDir, setDSEventICs, setDSEventInterval, setDSEventPrecise, setDSEventStartTime, setDSEventTerm, setDSEventTol, setICs, setPars, showAuxFnSpec, showAuxSpec, showDSEventInfo, showDef, showEventSpec, showSpec, sub_models

Inherited from Model (private): _delTraj, _generateParamInfo, _makeDefaultVarNames, _prepareCompute, _set_for_hybrid_DS, _validateVarNames

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

Class Variables

[hide private]

Inherited from Model (private): _needKeys, _optionalKeys, _querykeys, _setkeys

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, *a, **kw)
(Constructor)

source code

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

Overrides: object.__init__: (inherited documentation)

cleanupMemory(self)

source code

Clean up memory usage from past runs of a solver that is interfaced through a dynamic link library. This will prevent the 'continue' integration option from being accessible and will delete other data about the last integration run.

Rhs(self, dsName, t, xdict, pdict=None, asarray=False)

source code

Direct access to a sub-model generator's Rhs function.
Arguments:

  dsName   Name of a sub-model
  t        time (can use 0 for an autonomous system)
  xdict    state dictionary or Point.
  pdict    parameter dictionary or Point
           (optional, default current parameters)
  asarray  (Bool, optional, default False) If true, will return an array
           in state name alphabetical order, else a Point

Jacobian(self, dsName, t, xdict, pdict=None, asarray=False)

source code

Direct access to a sub-model generator's Jacobian function (if defined).
Arguments:

  dsName   Name of a sub-model
  t        time (can use 0 for an autonomous system)
  xdict    state dictionary or Point.
  pdict    parameter dictionary or Point
           (optional, default current parameters)
  asarray  (Bool, optional, default False) If true, will return an array
           in state name alphabetical order, else a Point

JacobianP(self, dsName, t, xdict, pdict=None, asarray=False)

source code

Direct access to a generator's JacobianP function (if defined).
Arguments:

  dsName   Name of a sub-model
  t        time (can use 0 for an autonomous system)
  xdict    state dictionary or Point.
  pdict    parameter dictionary or Point
           (optional, default current parameters)
  asarray  (Bool, optional, default False) If true, will return an array
           in state name alphabetical order, else a Point

MassMatrix(self, dsName, t, xdict, pdict=None, asarray=False)

source code

Direct access to a generator's MassMatrix function (if defined).
Arguments:

  dsName   Name of a sub-model
  t        time (can use 0 for an autonomous system)
  xdict    state dictionary or Point.
  pdict    parameter dictionary or Point
           (optional, default current parameters)
  asarray  (Bool, optional, default False) If true, will return an array
           in state name alphabetical order, else a Point

AuxVars(self, dsName, t, xdict, pdict=None, asarray=False)

source code

Direct access to a generator's auxiliary variables
definition (if defined).

Arguments:

  dsName   Name of a sub-model
  t        time (can use 0 for an autonomous system)
  xdict    state dictionary or Point.
  pdict    parameter dictionary or Point
           (optional, default current parameters)
  asarray  (Bool, optional, default False) If true, will return an array
           in state name alphabetical order, else a Point

compute(self, trajname, **kw)

source code

Compute a hybrid trajectory and store it internally in the 'trajectories'
attribute.

Arguments (non-keyword):
  trajname   Name of trajectory to create (string)

Arguments (keyword only, all optional):
  force      (Bool, default False) - force overwrite of any trajectory
             stored in this object with the same name
  verboselevel  (int, default 0)
  ics        initial conditions dict or Point
  pars       parameters dict or Point
  tdata      time data (interval as sequence of 2 numeric values)

_validateRegistry(self, obsvars, intvars)

source code

Validate Model's modelInfo attribute. Now that a HybridModel is invariably built using ModelConstructor, which already has validation built in, and also has more complex ways of construction, this method is defunct.

_infostr(self, verbose=1)

source code

Return string information about named sub-model (if given by dsName) at given verbosity level (default 0)

Overrides: Model._infostr: (inherited documentation)

Class HybridModel

__init__(self, *a, **kw) (Constructor)

cleanupMemory(self)

Rhs(self, dsName, t, xdict, pdict=None, asarray=False)

Jacobian(self, dsName, t, xdict, pdict=None, asarray=False)

JacobianP(self, dsName, t, xdict, pdict=None, asarray=False)

MassMatrix(self, dsName, t, xdict, pdict=None, asarray=False)

AuxVars(self, dsName, t, xdict, pdict=None, asarray=False)

compute(self, trajname, **kw)

_validateRegistry(self, obsvars, intvars)

_infostr(self, verbose=1)

init(self, *a, **kw)
(Constructor)