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
general.AProjectable Class Reference

Interface for all components that can be projected. More...

Detailed Description

Interface for all components that can be projected.

Projection in the KerMor context means restriction of the system's state space to a lower dimension. Therefore an biorthogonal Matrix pair \(V,W\) is used and the system's components are multiplied from the left, right or even both sides by \(V\) or \(W^t\) respectively. However, for some components the projection process infers a change to the components' underlying data. Thus, when calling project a NEW instance of the implementing class has to be returned for which all functions behave according to the changes caused by the projection. Due to this every projectable class also implements ICloneable in order to allow to create instance copies upon which the projection process can be performed.

A special case is the approx.BaseApprox class which also implements this interface. Since the approx classes approximate the system's core function they will have approximation specific data that may change during the projection. Especially here a call to project must return a new instance with the projected approximation data (if the approximation method allows for it, of course).

See Also
approx BaseApprox
Author
Daniel Wirtz
Date
2010-03-17
Change in 0.6:
(Daniel Wirtz, 2012-06-06) Moved from dscomponents to general package
Change in 0.3:
(Daniel Wirtz, 2011-04-11) Inheriting from ICloneable now in order to ensure cloning capabilities for any projectable class.
Change in 0.3:
(Daniel Wirtz, 2011-04-01) Updated documentation.
Todo:
change AProjectable to IProjectable and remove V,W properties (not needed in all components that are projectable)

Definition at line 18 of file AProjectable.m.

Public Member Functions

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

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

Static Protected Member Functions

static function obj = loadobj (obj, from)
 

Member Function Documentation

function copy = general.AProjectable.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.

Reimplemented in kernels.KernelExpansion, general.DEIM, and kernels.ParamTimeKernelExpansion.

Definition at line 117 of file AProjectable.m.

References V, and W.

Referenced by models.ReducedSystem.build(), and project().

Here is the caller graph for this function:

static function obj = general.AProjectable.loadobj (   obj,
  from 
)
staticprotected

Definition at line 128 of file AProjectable.m.

function handle target = general.AProjectable.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.

Override in inheriting classes and pass the subclasses cloned instance as fourth target parameter.

Parameters
VThe \(V\) matrix of the biorthogonal pair \(V,W\)
WThe \(W\) matrix of the biorthogonal pair \(V,W\)
targetSpecify the subclasses projection target instance if project is overridden in a subclass and the subclass has been cloned. Default: []
Return values
projectedA new cloned instance with projection performed.
Generated fields of target:

Definition at line 85 of file AProjectable.m.

References clone(), V, and W.

Referenced by models.ReducedSystem.build().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation


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