MLode15i: Wrapper for MatLab's ode15i builtin implicit solver. More...

Detailed Description

MLode15i: Wrapper for MatLab's ode15i builtin implicit solver.

Author: Daniel Wirtz

Date: 2011-04-14

Change in 0.8:: (Daniel Wirtz, 2013-10-24) Providing a default sparse identity matrix as dydxp-jacobian (i.e. matrix M and M-sparsity pattern). This yields a major increase in performance when providing f-Jacobian information. This is due to a ode15i sparse Miter matrix, which is dense if odenumjac is used to compute the dydxp value/pattern).

Change in 0.6:: (Daniel Wirtz, 2011-12-07) Changed the inheritance order, now inheriting from MLWrapper solver class and overriding the actual solver call (different arguments for ode15i)

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

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-14) Added this class.

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 MLode15i.m.

Public Member Functions
	MLode15i ()

Public Member Functions inherited from solvers.MLWrapper
	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
double	RelTol = 1e-3
	Relative error tolerance for solver. More...

double	AbsTol = 1e-6
	Absolute error tolerance for solver. More...

Public Attributes inherited from solvers.MLWrapper
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)
	Solves the ode specified by odefun implicitly. More...

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

Definition at line 107 of file MLode15i.m.

References solvers.SolverTypes.Implicit, solvers.BaseSolver.MaxStep, solvers.BaseSolver.Name, DPCMObject.registerProps(), and solvers.BaseSolver.SolverType.

Here is the call graph for this function:

Member Function Documentation

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

protected

Solves the ode specified by odefun implicitly.

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: []

Return values

t	The desired computation times \(t_0,\ldots,t_N\) as row vector
x	The system's state \(x_i\) at time \(t_i\) as collection of column vectors

Required fields of opts:

Definition at line 119 of file MLode15i.m.

References AbsTol, dscomponents.AMassMatrix.evaluate(), solvers.AJacobianSolver.JacFun, solvers.AJacobianSolver.JPattern, solvers.BaseSolver.M, solvers.MLWrapper.MLSolver, RelTol, dscomponents.AMassMatrix.SparsityPattern, t, and dscomponents.AMassMatrix.TimeDependent.

Here is the call graph for this function:

Member Data Documentation

solvers.MLode15i.AbsTol = 1e-6

Absolute error tolerance for solver.

Set to a lower value than the default 1e-6 of matlab ode solvers.

See the AbsTol description in the odeset documentation for the effects of this property.

Property class critical:: Absolute error tolerances require adoption to the current situation and scale of computations.

Default: 1e-6

See Also: RelTol ode15i odeset

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

Definition at line 78 of file MLode15i.m.

Referenced by solverCall().

solvers.MLode15i.RelTol = 1e-3

Relative error tolerance for solver.

Set to a lower value than the default 1e-3 of matlab ode solvers.

See the RelTol description in the odeset documentation for the effects of this property.

Property class critical:: The correct relative tolerance guarantees the right number of significant figures.

Default: 1e-3

See Also: AbsTol ode15i odeset

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

Definition at line 56 of file MLode15i.m.

Referenced by solverCall().

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

core/+solvers/MLode15i.m

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation