Allows to wrap a MatLab ODE solver into the KerMor framework. More...

Detailed Description

Allows to wrap a MatLab ODE solver into the KerMor framework.

Author: Daniel Wirtz

Date: 2010-08-09

New in 0.7:: (Daniel Wirtz, 2013-05-16) Now inheriting from the new solvers.AJacobianSolver abstract class to all MatLab wrapper solvers (e.g. ode15s also benefits from the Jacobian)

New in 0.6:: (Daniel Wirtz, 2011-12-07) Added a new field odeopts which corresponds to the odeset options struct of MatLab. Any values set will be passed to the internal ode23 etc solver.

Change in 0.5:: (Daniel Wirtz, 2011-10-16) Adopted to the new BaseSolver.RealTimeMode flag.

Change in 0.5:: (Daniel Wirtz, 2011-10-15) Moved the creation of the SolverEventData into the solve function as creation in the constructor seems to crash Matlab versions prior to the 2011a which was used to program this functionality in the first place.

Change in 0.5:: (Daniel Wirtz, 2011-09-29) Added callback for StepPerformed to enable "real time" plotting.

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.

This class is part of the framework

KerMor - Model Order Reduction using Kernels

Homepage http://www.morepas.org/software/index.html
Documentation http://www.morepas.org/software/kermor/index.html
License KerMor license conditions

Definition at line 18 of file MLWrapper.m.

Public Member Functions
	MLWrapper (solver)

function [ double t , matrix< double > y ] =	solve (odefun,double t, x0)

Public Member Functions inherited from solvers.BaseSolver
	BaseSolver ()

virtual function [ rowvec t , matrix x ] =	solve (odefun,rowvec t,colvec x0)
	The abstract solve function for the ODE solver. More...

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 Member Functions inherited from solvers.AJacobianSolver
	AJacobianSolver ()

Public Attributes
function_handle	MLSolver = @ode23
	The wrapped Matlab-Solver. More...

struct	odeopts
	Additional ODE options. More...

Public Attributes inherited from solvers.BaseSolver
double	MaxStep = "[]"
	Maximum time step for solver. More...

double	InitialStep = "[]"
	The initial step size for the solver. So far only used by the MLWrapper class for the native matlab solvers. More...

logical	RealTimeMode = false
	Determines if the solver's StepPerformed event should be used upon solving instead of returning the full trajectory as one. More...

dscomponents.AMassMatrix	M = "[]"
	The mass matrix \(M\) of the ODE \(M(t)x'(t) = \ldots\). More...

	Name = "KerMor BaseSolver class"
	The solver's name. More...

solvers.SolverTypes	SolverType = solvers.SolverTypes.Unknown
	The type of the solver. More...

EVENT	StepPerformed
	Gets fired when an ODE solver performs an intermediate step. 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...

Public Attributes inherited from solvers.AJacobianSolver
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...

Protected Member Functions
function varargout =	solverCall (function_handle odefun,rowvec< double > t, x0,struct opts)
	Default solver call for all builtin ode solvers except ode15i. This method gets overridden in MLode15i. More...

function status =	ODEOutputFcn (t, y, flag)
	Wraps the OutputFcn of the Matlab ODE solver into the StepPerformed event. 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)

Additional Inherited Members
Static Public Member Functions inherited from solvers.BaseSolver
static function res =	test_SolverSpeedTest ()

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.MLWrapper.MLWrapper ( solver )

Definition at line 111 of file MLWrapper.m.

References solvers.SolverTypes.Explicit, solvers.SolverTypes.Implicit, MLSolver, odeopts, DPCMObject.registerProps(), and solvers.BaseSolver.SolverType.

Here is the call graph for this function:

Member Function Documentation

function status = solvers.MLWrapper.ODEOutputFcn	(	t,
		y,
		flag
	)

protected

Wraps the OutputFcn of the Matlab ODE solver into the StepPerformed event.

See Also: odeset

Parameters

t	The current time \(t\)
y	The system's output \(y(t)\)
flag	The flag passed from the ODE solver as argument of the `OutputFcn` setting in odeset.

Note: This method has the MATLAB method attribute Sealed set to true. It cannot be overwritten.; matlab documentation of method attributes.

Definition at line 241 of file MLWrapper.m.

References handle.notify, and t.

Referenced by solve().

Here is the caller graph for this function:

function [double t , matrix<double>y ] = solvers.MLWrapper.solve	(		odefun,
		double	t,
			x0
	)

Definition at line 127 of file MLWrapper.m.

References dscomponents.AMassMatrix.AlgebraicEquationDims, dscomponents.AMassMatrix.evaluate(), solvers.BaseSolver.InitialStep, solvers.AJacobianSolver.JacFun, solvers.AJacobianSolver.JPattern, solvers.BaseSolver.M, solvers.BaseSolver.MaxStep, odeopts, ODEOutputFcn(), solvers.BaseSolver.RealTimeMode, solverCall(), and t.

Here is the call graph for this function:

function varargout = solvers.MLWrapper.solverCall	(	function_handle	odefun,
		rowvec< double >	t,
			x0,
		struct	opts
	)

protected

Default solver call for all builtin ode solvers except ode15i. This method gets overridden in MLode15i.

Parameters

odefun	A function handle for the ODE's dynamic function \(f(t,x)\)
t	The times \(t_i\) on which to solve the ODE
x0	Initial condition vector \(x_0(\mu)\)
opts	Optional options struct for ODE settings obtained by `odeset`. Default: []

Definition at line 221 of file MLWrapper.m.

References MLSolver.

Referenced by solve().

Here is the caller graph for this function:

Member Data Documentation

solvers.MLWrapper.MLSolver = @ode23

The wrapped Matlab-Solver.

Has to be a function handle to one of Matlab's implemented ODE solvers.

Property class critical:: The correct underlying MatLab builtin solver can make the difference.

Default: ode23

See Also: ode23 ode45

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 60 of file MLWrapper.m.

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

solvers.MLWrapper.odeopts

Additional ODE options.

Change this value via the odeset function. This struct will be passed as a whole to the wrapped MatLab solver.

Default: odeset

See Also: odeset

Note: This property has the MATLAB attribute SetObservable set to true.; Matlab documentation of property attributes.

Definition at line 80 of file MLWrapper.m.

Referenced by MLWrapper(), and solve().

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

core/+solvers/MLWrapper.m

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation