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
approx.BaseApprox Class Referenceabstract

Abstract base class for all core function approximations inside dynamical systems. More...

Detailed Description

Abstract base class for all core function approximations inside dynamical systems.

Simply provides two methods
  • selectTrainingData: Used to select a (sub-)set of the training data
  • approximateData: Abstract template method that performs the actual approximation. Possible algorithms may be i.e. component-wise approximation, multidimensional approximation or any other.
Author
Daniel Wirtz
Date
2010-03-11
Change in 0.5:
(Daniel Wirtz, 2011-07-07)
  • Changed the interface for the old approximateCoreFun to approximateSystemFunction that now takes only the full model instance instead of \(x_i,t_i,\mu_i,f_{x_i}\) values.
  • The new default value for the approx train data selector is the data.selection.DefaultSelector.
Change in 0.4:
(Daniel Wirtz, 2011-05-19) Disconnected the Approx classes from taking a BaseModel instance at approx computation. This way external tools can use the approximation algorithms, too.
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-12) New property approx.BaseApprox.TrainDataSelector. Allows to choose different strategies for training data selection.
Change in 0.3:
(Daniel Wirtz, 2011-04-01) Removed the gen_approximation_data template method as it basically only compiled the single xi,ti,mui values which will be re-joined into the dscomponents.AKernelCoreFun.Centers property in all currently implemented approximation strategies. Some similar intermediate method may be reintroduced later.

Definition at line 18 of file BaseApprox.m.

Public Member Functions

 BaseApprox (sys)
 
function copy = clone (copy)
 The interface method with returns a copy of the current class instance. More...
 
virtual function  approximateSystemFunction (model)
 Computes the approximation according to the concrete approximation strategy. More...
 
- 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 copy = clone (copy)
 The interface method with returns a copy of the current class instance. 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...
 

Static Public Member Functions

static function res = test_ApproxProjections ()
 

Public Attributes

data.selection.ASelector TrainDataSelector
 The algorithm that selects the approximation training data. 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< logicalJSparsityPattern = "[]"
 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< doublemu = "[]"
 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...
 

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

Constructor & Destructor Documentation

approx.BaseApprox.BaseApprox (   sys)

Definition at line 86 of file BaseApprox.m.

References TrainDataSelector.

Member Function Documentation

function approx.BaseApprox.approximateSystemFunction (   model)
pure virtual

Computes the approximation according to the concrete approximation strategy.

Template method.

Parameters
modelThe current model.

Referenced by models.BaseFullModel.off5_computeApproximation().

Here is the caller graph for this function:

function copy = approx.BaseApprox.clone (   target)
virtual

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

Parameters
targetIf 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.

Implements ICloneable.

Definition at line 92 of file BaseApprox.m.

References ICloneable.clone(), and TrainDataSelector.

Here is the call graph for this function:

static function res = approx.BaseApprox.test_ApproxProjections ( )
static

Definition at line 125 of file BaseApprox.m.

References cprintf(), handle.disp, MUnit.GreenCol, Norm.L2(), and t.

Here is the call graph for this function:

Member Data Documentation

approx.BaseApprox.TrainDataSelector

The algorithm that selects the approximation training data.

Property class important:
Determines the strategy used to select the approximation training data

Default: data.selection.DefaultSelector

Todo:
MOVE TO BASEFULLMODEL
See Also
data.selection.DefaultSelector LinspaceSelector TimeSelector
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 62 of file BaseApprox.m.

Referenced by BaseApprox(), clone(), and approx.TPWLApprox.TPWLApprox().


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