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
dscomponents.AInputConv Class Referenceabstract

AInputConv: Base class for input conversion "B". For simpler input conversions, it will be convenient to simply use the Pointer versions and pass the target function. For more complex input calculations which require local setup for example subclass this class and implement the evaluate method. More...

Detailed Description

AInputConv: Base class for input conversion "B". For simpler input conversions, it will be convenient to simply use the Pointer versions and pass the target function. For more complex input calculations which require local setup for example subclass this class and implement the evaluate method.

See Also
ACoreFun AOutputConv
Author
Daniel Wirtz
Date
17.03.2010
Change in 0.5:
(Daniel Wirtz, 2011-07-07) Fixed output name from \(C\) to \(B\)

Definition at line 18 of file AInputConv.m.

Public Member Functions

function  prepareSimulation (colvec< double > mu)
 do nothing by default More...
 
virtual function B = evaluate (colvec< double > mu)
 Template method that evaluates the input conversion matrix \(B\) at the current time \(t\) and [optional] parameter \(\mu\). 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

logical TimeDependent = true
 Flag that indicates if the AInputConv is (truly) time-dependent. 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 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 obj = loadobj (obj, varargin)
 
- 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)
 

Member Function Documentation

function B = dscomponents.AInputConv.evaluate ( colvec< double mu)
pure virtual

Template method that evaluates the input conversion matrix \(B\) at the current time \(t\) and [optional] parameter \(\mu\).

Parameters
muThe currently used parameter \(\vmu\). Set to \([]\) if not used.

Referenced by error.alpha.Constant.inputOfflineComputations(), models.BaseSecondOrderSystem.ODEFun(), models.BaseFirstOrderSystem.ODEFun(), and error.TPWLLocalLipEstimator.prepareForReducedModel().

Here is the caller graph for this function:

static function obj = dscomponents.AInputConv.loadobj (   obj,
  varargin 
)
staticprotected

Definition at line 88 of file AInputConv.m.

References KerMorObject.KerMorObject().

Here is the call graph for this function:

function dscomponents.AInputConv.prepareSimulation ( colvec< double mu)

do nothing by default

Parameters
muThe currently used parameter \(\vmu\). Set to \([]\) if not used.

Definition at line 63 of file AInputConv.m.

Referenced by models.BaseFirstOrderSystem.prepareSimulation().

Here is the caller graph for this function:

Member Data Documentation

dscomponents.AInputConv.TimeDependent = true

Flag that indicates if the AInputConv is (truly) time-dependent.

Set in subclasses to the correct value for your implementation. Most built-in KerMor classes set their values correctly or guess them.

This will cause different behaviour for e.g. ODE solvers.

Property class critical:
Not setting this value in implementing subclasses causes KerMor's ODE solvers to (possibly) produce wrong results due to wrong assumptions on the time dependence of the core function.

Default: true

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

Definition at line 39 of file AInputConv.m.

Referenced by models.muscle.System.assembleB(), dscomponents.AffLinInputConv.evaluate(), and dscomponents.LinearInputConv.LinearInputConv().


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