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
solvers.AJacobianSolver Class Reference

AImplSolver: Base abstract class for solvers that can use Jacobian information for faster computation. More...

Detailed Description

AImplSolver: Base abstract class for solvers that can use Jacobian information for faster computation.

Author
Daniel Wirtz
Date
2011-04-19
Change in 0.7:
(Daniel Wirtz, 2013-05-16) Renamed this class from AImplSolver to AJacobianSolver. Now providing the jacobian stuff via this class independently from explicit/implicit solver tactics.
Change in 0.6:
(Daniel Wirtz, 2011-12-07) Renamed this class from BaseImplSolver to AImplSolver, now merely providing jacobian matrix information and a checkable interface for implicit solvers
New in 0.6:
(Daniel Wirtz, 2011-11-27) New property AImplSolver.JPattern that allows to set a sparsity pattern for the ode function.
New in 0.3:
(Daniel Wirtz, 2011-04-21) Integrated this class to the property default value changed supervision system Property classes and levels. This class now inherits from KerMorObject and has an extended constructor registering any user-relevant properties using KerMorObject.registerProps.
New in 0.3:
(Daniel Wirtz, 2011-04-19) Added this class to have a base for implicit solvers and wrap to the normal odefun interface from the explicit ones.

This class is part of the framework

KerMor - Model Order Reduction using Kernels

Definition at line 18 of file AJacobianSolver.m.

Public Member Functions

 AJacobianSolver ()
 
- 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

function_handle JacFun = "[]"
 A function handle to compute the core function's jacobian. More...
 
sparsematrix JPattern
 The sparsity pattern of the jacobian \(\nabla_x f(x,t,\mu)\). 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...
 

Additional Inherited Members

- 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

solvers.AJacobianSolver.AJacobianSolver ( )

Definition at line 101 of file AJacobianSolver.m.

References DPCMObject.registerProps().

Here is the call graph for this function:

Member Data Documentation

solvers.AJacobianSolver.JacFun = "[]"

A function handle to compute the core function's jacobian.

Sets the jacobian function handle.

Optional, any implementations must also work with this property set to [].

The function handles parameters must be
  • t The current time \(t\)
  • x The current state space vector for time \(t\) Returned must be the jacobian matrix \(\frac{\partial f}{\partial x}(t,x)\) at the point \(x(t)\) and time \(t\).
Property class important:
If available, supply a jacobian function evaluation handle to improve speed and reliability of implicit solvers.

Default: []

See Also
odeset
Note
This property has the MATLAB attribute SetObservable set to true.
Matlab documentation of property attributes.
This property has custom functionality when its value is changed.

Definition at line 56 of file AJacobianSolver.m.

Referenced by solvers.MLWrapper.solve(), and solvers.MLode15i.solverCall().

solvers.AJacobianSolver.JPattern

The sparsity pattern of the jacobian \(\nabla_x f(x,t,\mu)\).

Property class important:
Providing a sparsity pattern to implicit solvers might be crucial for the performance of the solver due to memory restrictions.

Default: []

Note
This property has the MATLAB attribute SetObservable set to true.
Matlab documentation of property attributes.
This property has custom functionality when its value is changed.

Definition at line 82 of file AJacobianSolver.m.

Referenced by solvers.MLWrapper.solve(), and solvers.MLode15i.solverCall().


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