KerMor  0.9
Model order reduction for nonlinear dynamical systems and nonlinear approximation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
models.motoneuron.System Class Reference

MotoSystem: The global dynamical system used within the MotoModel. More...

Detailed Description

MotoSystem: The global dynamical system used within the MotoModel.

Author
Daniel Wirtz
Date
2012-11-22
New in 0.7:
(Daniel Wirtz, 2013-07-05) Added this class.

This class is part of the framework

KerMor - Model Order Reduction using Kernels

Definition at line 19 of file System.m.

Public Member Functions

 System (models.BaseFullModel model)
 Call superclass constructor. More...
 
function  prepareSimulation (colvec< double > mu,integer inputidx)
 Limits the mean input current to a maximum value depending on the fibre type, so that the frequency of 60Hz is not exceeded. More...
 
function  setConfig (colvec< double > mu,integer inputidx)
 
function pm = plot (double t,matrix< double > y, pm)
 
- Public Member Functions inherited from models.BaseFirstOrderSystem
 BaseFirstOrderSystem (models.BaseFullModel model)
 Creates a new base dynamical system class instance. More...
 
function rsys = getReducedSystemInstance (models.ReducedModel rmodel)
 Creates a reduced system given the current system and the reduced model. More...
 
function  setConfig (mu, inputidx)
 Sets the dynamical system's configuration. More...
 
function  prepareSimulation (colvec< double > mu,integer inputidx)
 
function dx = ODEFun (double t,colvec< double > x)
 Debug variant for single evaluation. Commented in function above. More...
 
function y = computeOutput (matrix< double > x,colvec< double > mu)
 Computes the output \(y(t) = C(t,\mu)Sx(t)\) from a given state result vector \(x(t)\), using the system's time and current mu (if given). More...
 
function  updateSparsityPattern ()
 
function J = getJacobian (double t, xc)
 Computes the global jacobian of the current system. More...
 
function matrix
< double > x0
getX0 (rowvec< double > mu)
 Gets the initial state variable at \(t=0\). More...
 
function MgetMassMatrix ()
 For first order systems, only algebraic constraints need to be catered for. More...
 
function ModelParam p = addParam (char name, default, varargin)
 Adds a parameter with the given values to the parameter collection of the current dynamical system. More...
 
function pidx = getParamIndexFromName (paramname)
 Gets the index within the parameter vector \(\mu\) for a given parameter name. More...
 
function pt = getParamInfo (colvec< double > mu)
 
function  plotInputs (pm)
 
- Public Member Functions inherited from KerMorObject
 KerMorObject ()
 Constructs a new KerMor object. More...
 
function  display ()
 disp(object2str(this)); More...
 
function bool = eq (B)
 Checks equality of two KerMor objects. More...
 
function bool = ne (B)
 Checks if two KerMorObjects are different. More...
 
function cn = getClassName ()
 Returns the simple class name of this object without packages. More...
 
- Public Member Functions inherited from DPCMObject
 DPCMObject ()
 Creates a new DPCM object. More...
 
 DPCMObject ()
 

Public Attributes

 d = "[]"
 debug output More...
 
 noiseGen
 The NoiseGenerator to obtain the inputs u(t) More...
 
 upperlimit_poly
 The upper limit polynomial for maximum mean current dependent on the fibre type. More...
 
- Public Attributes inherited from models.BaseFirstOrderSystem
dscomponents.ACoreFun f
 The core f function from the dynamical system. More...
 
dscomponents.LinearCoreFun A = "[]"
 Represents a linear or affine-linear component of the dynamical system. More...
 
dscomponents.AInputConv B = "[]"
 The input conversion. More...
 
dscomponents.LinearOutputConv C
 The output conversion Defaults to an LinearOutputConv instance using a 1-matrix, which just forwards the state variables and supports projection. More...
 
dscomponents.AInitialValue x0 = "[]"
 Function handle to initial state evaluation. More...
 
dscomponents.AMassMatrix M = "[]"
 The system's mass matrix. More...
 
dscomponents.ACoreFun g = "[]"
 The system's algebraic constraints function. More...
 
 Inputs = {""}
 The system's possible input functions. A cell array of function handles, each taking a time argument t. More...
 
 Params = data.ModelParam.empty
 The parameters usable for the dynamical system. More...
 
integer DependentParamIndices = -1
 Indices of the parameter vector that are effectively used in the system's core function. More...
 
double MaxTimestep = "[]"
 The maximum timestep allowed for any ODE solvers. More...
 
colvec StateScaling = 1
 The scaling for the state vectors. More...
 
 SparsityPattern
 The global sparsity pattern for the entire RHS. More...
 
 mu = "[]"
 The current parameter \(\mu\) for simulations, [] is none used. More...
 
 u = "[]"
 The current input function \(u(t)\) as function handle, [] if none used. More...
 
 inputidx = "[]"
 The current inputindex of the function \(u(t)\). More...
 
 NumStateDofs = "[]"
 
 NumAlgebraicDofs = 0
 
 NumTotalDofs = "[]"
 
 InputCount
 The number of inputs available. More...
 
 ParamCount
 The number of the system's parameters. More...
 
 Model
 The Model this System is attached to. More...
 
- Public Attributes inherited from DPCMObject
 WorkspaceVariableName = ""
 The workspace variable name of this class. Optional. More...
 
 ID = "[]"
 An ID that allows to uniquely identify this DPCMObject (at least within the current MatLab session/context). More...
 
 PropertiesChanged = "[]"
 The Dictionary containing all the property settings as key/value pairs. More...
 
- Public Attributes inherited from handle
 addlistener
 Creates a listener for the specified event and assigns a callback function to execute when the event occurs. More...
 
 notify
 Broadcast a notice that a specific event is occurring on a specified handle object or array of handle objects. More...
 
 delete
 Handle object destructor method that is called when the object's lifecycle ends. More...
 
 disp
 Handle object disp method which is called by the display method. See the MATLAB disp function. More...
 
 display
 Handle object display method called when MATLAB software interprets an expression returning a handle object that is not terminated by a semicolon. See the MATLAB display function. More...
 
 findobj
 Finds objects matching the specified conditions from the input array of handle objects. More...
 
 findprop
 Returns a meta.property objects associated with the specified property name. More...
 
 fields
 Returns a cell array of string containing the names of public properties. More...
 
 fieldnames
 Returns a cell array of string containing the names of public properties. See the MATLAB fieldnames function. More...
 
 isvalid
 Returns a logical array in which elements are true if the corresponding elements in the input array are valid handles. This method is Sealed so you cannot override it in a handle subclass. More...
 
 eq
 Relational functions example. See details for more information. More...
 
 transpose
 Transposes the elements of the handle object array. More...
 
 permute
 Rearranges the dimensions of the handle object array. See the MATLAB permute function. More...
 
 reshape
 hanges the dimensions of the handle object array to the specified dimensions. See the MATLAB reshape function. More...
 
 sort
 ort the handle objects in any array in ascending or descending order. More...
 

Static Public Attributes

static const  dm = 6
 Dimension of motoneuron part. More...
 
static const ::double C_m_slow = 0.58
 Membrane capacitance. Different values for different fibre types, due to different action potential propagation speeds C_m is computed parameter-dependent. These constants are for both slow and fast muscle models and are also used in the first entry of the sarcomere constants computed in models.muscle.FibreDynamics.initSarcoConst. More...
 
static const  C_m_fast = 1
 

Additional Inherited Members

- Protected Member Functions inherited from models.BaseFirstOrderSystem
function  updateDimensions ()
 
function ad_ic = getAlgebraicDofsInitialConditions ()
 The default is to return all zeros. More...
 
function  validateModel (models.BaseFullModel model)
 Validates if the model to be set is a valid BaseModel at least. Extracting this function out of the setter enables subclasses to further restrict the objects that may be passed, as is being done in models.ReducedSystem, for example. More...
 
- Protected Member Functions inherited from KerMorObject
function  checkType (obj, type)
 Object typechecker. More...
 
- Protected Member Functions inherited from DPCMObject
function  registerProps (varargin)
 Call this method at any class that defines DPCM observed properties. More...
 
function  registerProps (varargin)
 
- Static Protected Member Functions inherited from DPCMObject
static function obj = loadobj (obj, from)
 Re-register any registered change listeners! More...
 
static function obj = loadobj (obj, from)
 

Constructor & Destructor Documentation

models.motoneuron.System.System ( models.BaseFullModel  model)

Call superclass constructor.

Parameters
modelA KerMor full model

Definition at line 109 of file System.m.

References models.BaseFirstOrderSystem.addParam(), models.BaseFirstOrderSystem.B, models.BaseFirstOrderSystem.f, models.BaseFirstOrderSystem.Inputs, noiseGen, models.BaseFirstOrderSystem.NumStateDofs, models.BaseFirstOrderSystem.updateDimensions(), upperlimit_poly, and models.BaseFirstOrderSystem.x0.

Referenced by models.motoneuron.Model.Model().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

function pm = models.motoneuron.System.plot ( double  t,
matrix< double y,
  pm 
)

Definition at line 184 of file System.m.

References models.BaseFirstOrderSystem.B, models.BaseFirstOrderSystem.mu, and noiseGen.

Referenced by models.motoneuron.Model.plot().

Here is the caller graph for this function:

function models.motoneuron.System.prepareSimulation ( colvec< double mu,
integer  inputidx 
)

Limits the mean input current to a maximum value depending on the fibre type, so that the frequency of 60Hz is not exceeded.

See Also
models.motoneuron.ParamDomainDetection upperlimit_poly
Parameters
muThe currently used parameter \(\vmu\). Set to \([]\) if not used.
inputidxThe index \(i\) of the currently used input function \(u_i(t)\). Set to \([]\) if not used.

Definition at line 155 of file System.m.

References models.motoneuron.Model.FibreTypeDepMaxMeanCurrent, models.BaseFirstOrderSystem.mu, polyval(), and upperlimit_poly.

Here is the call graph for this function:

function models.motoneuron.System.setConfig ( colvec< double mu,
integer  inputidx 
)

Member Data Documentation

const models.motoneuron.System.C_m_fast = 1
static

Definition at line 76 of file System.m.

models.motoneuron.System.C_m_slow = 0.58
static

Membrane capacitance. Different values for different fibre types, due to different action potential propagation speeds C_m is computed parameter-dependent. These constants are for both slow and fast muscle models and are also used in the first entry of the sarcomere constants computed in models.muscle.FibreDynamics.initSarcoConst.


Default: 0.58

Definition at line 63 of file System.m.

models.motoneuron.System.d = "[]"

debug output

Note
This property has the MATLAB attribute Transient set to true.
Matlab documentation of property attributes.
Default: "[]"

Definition at line 41 of file System.m.

models.motoneuron.System.dm = 6
static

Dimension of motoneuron part.


Default: 6

Definition at line 55 of file System.m.

models.motoneuron.System.noiseGen

The NoiseGenerator to obtain the inputs u(t)

Note
This property has non-standard access specifiers: SetAccess = Private, GetAccess = Public
Matlab documentation of property attributes.

Definition at line 81 of file System.m.

Referenced by plot(), setConfig(), and System().

models.motoneuron.System.upperlimit_poly

The upper limit polynomial for maximum mean current dependent on the fibre type.

See Also
models.motoneuron.Model.FibreTypeDepMaxMeanCurrent models.motoneuron.experiments.ParamDomainDetection
Note
This property has non-standard access specifiers: SetAccess = Private, GetAccess = Public
Matlab documentation of property attributes.

Definition at line 92 of file System.m.

Referenced by models.motoneuron.Dynamics.prepareSimulation(), prepareSimulation(), and System().


The documentation for this class was generated from the following file: