amici.amici.ModelDimensions

class amici.amici.ModelDimensions(*args)[source]

Container for model dimensions.

Holds number of states, observables, etc.

__init__(*args)[source]
Overload 1:

Default ctor


Overload 2:

Constructor with model dimensions

Parameters
  • nx_rdata (int) – Number of state variables

  • nxtrue_rdata (int) – Number of state variables of the non-augmented model

  • nx_solver (int) – Number of state variables with conservation laws applied

  • nxtrue_solver (int) – Number of state variables of the non-augmented model with conservation laws applied

  • nx_solver_reinit (int) – Number of state variables with conservation laws subject to reinitialization

  • np (int) – Number of parameters

  • nk (int) – Number of constants

  • ny (int) – Number of observables

  • nytrue (int) – Number of observables of the non-augmented model

  • nz (int) – Number of event observables

  • nztrue (int) – Number of event observables of the non-augmented model

  • ne (int) – Number of events

  • nJ (int) – Number of objective functions

  • nw (int) – Number of repeating elements

  • ndwdx (int) – Number of nonzero elements in the x derivative of the repeating elements

  • ndwdp (int) – Number of nonzero elements in the p derivative of the repeating elements

  • ndwdw (int) – Number of nonzero elements in the w derivative of the repeating elements

  • ndxdotdw (int) – Number of nonzero elements in the \(w\) derivative of \(xdot\)

  • ndJydy (IntVector) – Number of nonzero elements in the \(y\) derivative of \(dJy\) (shape nytrue)

  • nnz (int) – Number of nonzero elements in Jacobian

  • ubw (int) – Upper matrix bandwidth in the Jacobian

  • lbw (int) – Lower matrix bandwidth in the Jacobian

Methods Summary

__init__(*args)

Overload 1:

Attributes

lbw

Lower bandwidth of the Jacobian

nJ

Dimension of the augmented objective function for 2nd order ASA

ndJydy

Number of nonzero elements in the \(derivative of\f$dJy\) (dimension nytrue)

ndwdp

Number of nonzero elements in the p derivative of the repeating elements

ndwdw

Number of nonzero elements in the w derivative of the repeating elements

ndwdx

Number of nonzero elements in the x derivative of the repeating elements

ndxdotdw

Number of nonzero elements in the \(derivative of \f$xdot\)

ne

Number of events

nk

Number of constants

nnz

Number of nonzero entries in Jacobian

np

Number of parameters

nw

Number of common expressions

nx_rdata

Number of states

nx_solver

Number of states with conservation laws applied

nx_solver_reinit

Number of solver states subject to reinitialization

nxtrue_rdata

Number of states in the unaugmented system

nxtrue_solver

Number of states in the unaugmented system with conservation laws applied

ny

Number of observables

nytrue

Number of observables in the unaugmented system

nz

Number of event outputs

nztrue

Number of event outputs in the unaugmented system

ubw

Upper bandwidth of the Jacobian

Methods

__init__(*args)[source]
Overload 1:

Default ctor


Overload 2:

Constructor with model dimensions

Parameters
  • nx_rdata (int) – Number of state variables

  • nxtrue_rdata (int) – Number of state variables of the non-augmented model

  • nx_solver (int) – Number of state variables with conservation laws applied

  • nxtrue_solver (int) – Number of state variables of the non-augmented model with conservation laws applied

  • nx_solver_reinit (int) – Number of state variables with conservation laws subject to reinitialization

  • np (int) – Number of parameters

  • nk (int) – Number of constants

  • ny (int) – Number of observables

  • nytrue (int) – Number of observables of the non-augmented model

  • nz (int) – Number of event observables

  • nztrue (int) – Number of event observables of the non-augmented model

  • ne (int) – Number of events

  • nJ (int) – Number of objective functions

  • nw (int) – Number of repeating elements

  • ndwdx (int) – Number of nonzero elements in the x derivative of the repeating elements

  • ndwdp (int) – Number of nonzero elements in the p derivative of the repeating elements

  • ndwdw (int) – Number of nonzero elements in the w derivative of the repeating elements

  • ndxdotdw (int) – Number of nonzero elements in the \(w\) derivative of \(xdot\)

  • ndJydy (IntVector) – Number of nonzero elements in the \(y\) derivative of \(dJy\) (shape nytrue)

  • nnz (int) – Number of nonzero elements in Jacobian

  • ubw (int) – Upper matrix bandwidth in the Jacobian

  • lbw (int) – Lower matrix bandwidth in the Jacobian