ParamTimeKernelCoreFun: Dynamical system core function which evaluates a contained kernel expansion, either parametric or plain state-dependence. More...

Detailed Description

ParamTimeKernelCoreFun: Dynamical system core function which evaluates a contained kernel expansion, either parametric or plain state-dependence.

Convenience class that wraps a given kernel expansion into the ACoreFun interface. The main methods clone and evaluate are redefined with explicit choice of which one to inherit.

Author: Daniel Wirtz

Date: 2011-07-07

Change in 0.7:: (Daniel Wirtz, 2014-01-15) Removed the inheritance from kernels.ParamTimeKernelExpansion and included an instance instead. (Favor inclusion over inheritance, Warwick said!)

New in 0.5:: (Daniel Wirtz, 2011-07-07) 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 ParamTimeKernelCoreFun.m.

Public Member Functions
	ParamTimeKernelCoreFun (sys)

function projected =	project (V, W)
	Call superclass method. More...

function matrix < double > fx =	evaluate (colvec< double > x,double t)
	Evaluates this CoreFun. More...

function matrix < double > fx =	evaluateMulti (matrix< double > x, varargin)
	Evaluates this CoreFun for multiple values. More...

function L =	getGlobalLipschitz (double t,colvec< double > mu)
	For some error estimators, a global Lipschitz constant estimation is performed. This function has to yield the global lipschitz constant for the spatial/state part of a CoreFunction \(f(x,t,mu)\). More...

function copy =	clone (copy)
	The interface method with returns a copy of the current class instance. More...

function matrix < double > J =	getStateJacobian (colvec< double > x,double t)
	Implement explicitly as both ACoreFun and KernelExpansion provide getStateJacobian methods. More...

function matrix < double > y =	evaluateCoreFun ()

Public Member Functions inherited from dscomponents.ACoreFun
	ACoreFun (sys)

function	setSystem (sys)

function target =	project (V, W, target)
	Sets the protected \(\vV,\vW\) matrices that can be utilized on core function evaluations after projection. More...

function fx =	evaluate (x, t)
	Evaluates the f-approximation. Depending on a possible projection and the CustomProjection-property the function either calls the inner evaluation directly which assumes \(f = f^r(z)\) or projects the reduced state variable z into the original space and evaluates the function there, so via \(f = V'f(Vz)\). More...

function fx =	evaluateMulti (colvec< double > x,double t,colvec< double > mu)
	Evaluates this function on multiple locations and maybe multiple times and parameters. More...

function	prepareSimulation (colvec< double > mu)
	A method that allows parameter-dependent computations to be performed before a simulation using this parameter starts. More...

function J =	getStateJacobian (x, t)
	Default implementation of jacobian matrix evaluation via finite differences. More...

function J =	getStateJacobianImpl (colvec< double > x,double t)
	Default implementation of state jacobians. uses finite differences. More...

function [ matrix< double > J , dx ] =	getStateJacobianFD (x, t,rowvec< integer > partidx)
	Implementation of jacobian matrix evaluation via finite differences. More...

virtual function fx =	evaluateCoreFun (colvec< double > x,double t)
	Actual method used to evaluate the dynamical sytems' core function. More...

function res =	test_MultiArgEval (mudim)
	Convenience function that tests if a custom MultiArgumentEvaluation works as if called with single arguments. More...

function logical res =	test_Jacobian (matrix< double > xa,rowvec< double > ta,matrix< double > mua)
	Tests the custom provided jacobian matrix against the default finite difference computed one. 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 general.AProjectable
function handle target =	project (matrix< double > V,matrix< double > W,handle target)
	Returns a NEW INSTANCE of the projected object that does not rely on data of the old one via references (everything must be copied to ensure separability of reduced(=projected) versions and full versions, unless. More...

function copy =	clone (copy)
	The interface method with returns a copy of the current class instance. More...

Public Attributes
kernels.KernelExpansion	Expansion
	The inner kernel expansion which is evaluated as core function. More...

Public Attributes inherited from dscomponents.ACoreFun
logical	TimeDependent = true
	Flag that indicates if the ACoreFun is (truly) time-dependent. More...

	CustomProjection = false
	Set this property if the projection process is customized by overriding the default project method. More...

sparse< logical >	JSparsityPattern = "[]"
	Sparsity pattern for the jacobian matrix. More...

integer	xDim = "[]"
	The current state space dimension of the function's argument \(x\). More...

integer	fDim = "[]"
	The current output dimension of the function. More...

models.BaseFirstOrderSystem	System
	The system associated with the current ACoreFun. More...

colvec< double >	mu = "[]"
	The current model parameter mu for evaluations. Will not be persisted as only valid for runtime during simulations. More...

	Vcache

	Wcache

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 general.AProjectable
	V
	The \(V\) matrix of the biorthogonal pair \(V,W\). More...

	W
	The \(W\) matrix of the biorthogonal pair \(V,W\). More...

Static Protected Member Functions
static function this =	loadobj ()

Static Protected Member Functions inherited from dscomponents.ACoreFun
static function obj =	loadobj (obj, from)

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)

Static Protected Member Functions inherited from general.AProjectable
static function obj =	loadobj (obj, from)

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)

Constructor & Destructor Documentation

dscomponents.ParamTimeKernelCoreFun.ParamTimeKernelCoreFun ( sys )

Definition at line 89 of file ParamTimeKernelCoreFun.m.

References handle.addlistener, dscomponents.ACoreFun.CustomProjection, Expansion, and dscomponents.ACoreFun.TimeDependent.

Member Function Documentation

function copy = dscomponents.ParamTimeKernelCoreFun.clone ( target )

virtual

The interface method with returns a copy of the current class instance.

Parameters

target If clone was called for a subclass of this class, target must contain the new instance of the subclass that is to be the cloned result.

Reimplemented from dscomponents.ACoreFun.

Definition at line 165 of file ParamTimeKernelCoreFun.m.

References kernels.KernelExpansion.clone(), Expansion, and dscomponents.ACoreFun.System.

Referenced by project().

Here is the call graph for this function:

Here is the caller graph for this function:

function matrix< double > fx = dscomponents.ParamTimeKernelCoreFun.evaluate	(	colvec< double >	x,
		double	t
	)

Evaluates this CoreFun.

Parameters

x	The current state space position
t	The time \(t\)
varargin	For ParamTimeKernelExpansions, additionally \(t\) and \(\mu\) can be provided. evaluate ( ..., mu ) Required Parameters for varargin: mu The parameter \(\mu\)

Return values

fx	The evaluation of the kernel expansion

Definition at line 115 of file ParamTimeKernelCoreFun.m.

References kernels.KernelExpansion.evaluate(), Expansion, and dscomponents.ACoreFun.mu.

Referenced by models.synth.KernelTestFun.showBaseFun().

Here is the call graph for this function:

Here is the caller graph for this function:

function matrix<double>y = dscomponents.ParamTimeKernelCoreFun.evaluateCoreFun ( )

Definition at line 191 of file ParamTimeKernelCoreFun.m.

function matrix< double > fx = dscomponents.ParamTimeKernelCoreFun.evaluateMulti	(	matrix< double >	x,
			varargin
	)

Evaluates this CoreFun for multiple values.

Parameters

x	The state space positions
varargin	For ParamTimeKernelExpansions, additionally \(t\) and \(\mu\) can be provided. evaluateMulti ( ..., t, mu ) Required Parameters for varargin: t The times \(t\) mu The parameters \(\mu\)

Return values

fx	The evaluation of the kernel expansion on all data

Definition at line 139 of file ParamTimeKernelCoreFun.m.

References kernels.KernelExpansion.evaluate(), and Expansion.

Here is the call graph for this function:

function L = dscomponents.ParamTimeKernelCoreFun.getGlobalLipschitz	(	double	t,
		colvec< double >	mu
	)

virtual

For some error estimators, a global Lipschitz constant estimation is performed. This function has to yield the global lipschitz constant for the spatial/state part of a CoreFunction \(f(x,t,mu)\).

Todo:: : what about cases where no lipschitz constants are available? somehow need to tell the error estimator etc.

Parameters

t	The current time(s) \(t \in [0, T]\)
mu	The currently used parameter \(\vmu\). Set to \([]\) if not used.

Implements dscomponents.IGlobalLipschitz.

Definition at line 160 of file ParamTimeKernelCoreFun.m.

References Expansion, and kernels.KernelExpansion.getGlobalLipschitz().

Here is the call graph for this function:

function matrix< double > J = dscomponents.ParamTimeKernelCoreFun.getStateJacobian	(	colvec< double >	x,
		double	t
	)

Implement explicitly as both ACoreFun and KernelExpansion provide getStateJacobian methods.

Parameters

x	The current state space position
t	The time \(t\)
varargin	For ParamTimeKernelExpansions, additionally \(t\) and \(\mu\) can be provided.

Return values

J	The state jacobian

Definition at line 174 of file ParamTimeKernelCoreFun.m.

References Expansion, kernels.KernelExpansion.getStateJacobian(), and dscomponents.ACoreFun.mu.

Here is the call graph for this function:

static function this = dscomponents.ParamTimeKernelCoreFun.loadobj ( )

staticprotected

Definition at line 235 of file ParamTimeKernelCoreFun.m.

References handle.addlistener, and DPCMObject.DPCMObject().

Here is the call graph for this function:

function projected = dscomponents.ParamTimeKernelCoreFun.project	(	V,
		W
	)

Call superclass method.

Generated fields of projected:

Definition at line 100 of file ParamTimeKernelCoreFun.m.

References clone(), Expansion, and kernels.KernelExpansion.project().

Here is the call graph for this function:

Member Data Documentation

dscomponents.ParamTimeKernelCoreFun.Expansion

The inner kernel expansion which is evaluated as core function.

Default:: kernels.ParamTimeKernelExpansion

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

Definition at line 50 of file ParamTimeKernelCoreFun.m.

Referenced by approx.KernelApprox.approximateSystemFunction(), clone(), evaluate(), evaluateMulti(), getGlobalLipschitz(), getStateJacobian(), models.synth.KernelTestFun.KernelTestFun(), ParamTimeKernelCoreFun(), and project().

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

core/+dscomponents/ParamTimeKernelCoreFun.m

Detailed Description

Public Member Functions

Public Attributes

Static Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation