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
error.GLEstimator Class Reference

GLEstimator: Global lipschitz constant error estimator. More...

Detailed Description

GLEstimator: Global lipschitz constant error estimator.

Author
Daniel Wirtz
Date
2010-05-10
Change in 0.4:
(Daniel Wirtz, 2011-05-29) Restructured the error estimators to better adopt to the current formulation. Now the KernelEstimators have a function getBeta instead of implementing the evalODEPart by themselves.
Change in 0.4:
(Daniel Wirtz, 2011-05-25) Changed the implementation to correspond to the new comparison lemma estimator derivation. This requires only one ODE dimension and is a sharper estimate than before.
Change in 0.4:
(Daniel Wirtz, 2011-05-23) Adopted to the new error.BaseEstimator interface with separate output error computation.

This class is part of the framework

KerMor - Model Order Reduction using Kernels
Todo:
extend the GlobalLipschitz computation to also depend on t,mu (with check ahead if constant, then efficient one-time eval is possible)

Definition at line 18 of file GLEstimator.m.

Public Member Functions

function copy = clone ()
 Creates a deep copy of this estimator instance. More...
 
function b = getBeta (colvec< double > x,double t)
 
function ct = prepareConstants (colvec< double > mu,integer inputidx)
 Return values: ct: The time needed for preprocessing. More...
 
function ct = postProcess (colvec< double > x,double t,integer inputidx)
 Return values: ct: The time needed for postprocessing. More...
 
- Public Member Functions inherited from error.BaseCompLemmaEstimator
 BaseCompLemmaEstimator ()
 
function  offlineComputations (models.BaseFullModel model)
 Overrides the method from BaseEstimator and performs additional computations. More...
 
function
prepared = 
prepareForReducedModel (models.ReducedModel rm)
 Prepares this estimator for use with a given reduced model. Basically uses the projection matrices and some other reduced quantities for local storage. More...
 
function e = evalODEPart (colvec x,double t,double ut)
 Evaluates the auxiliary ode part for the comparison-lemma based error estimators. More...
 
function ct = prepareConstants (colvec< double > mu,integer inputidx)
 
function copy = clone (copy)
 The interface method with returns a copy of the current class instance. More...
 
function  clear ()
 
function a = getAlpha (colvec< double > x,double t,colvec< double > ut)
 Convenience access method for semi-implicit euler method. More...
 
function ct = postProcess (colvec< double > x,double t,integer inputidx)
 Return values: ct: The time needed for postprocessing. More...
 
virtual function b = getBeta (colvec x,double t)
 Computes the \(\beta(t)\) term from the error estimation ODE for given time and place. More...
 
- Public Member Functions inherited from error.BaseEstimator
function  offlineComputations (models.BaseFullModel model)
 Performs a validity check for the given model and sets up the estimator for use with the specified model. More...
 
function double ct = postProcess (unused1,rowvec t, unused2)
 Post-processes the error estimator ODE part after reduced simulation computation. More...
 
function  clear ()
 Clears the last error set by the estimator. More...
 
function copy = clone (copy)
 Creates a copy of this error estimator. Call only allowed from subclasses. More...
 
function e0 = getE0 (colvec< double > mu)
 Calls the inner initial error computation strategy. More...
 
function ct = prepareConstants (colvec< double > mu, unused1)
 
function
prepared = 
prepareForReducedModel (models.ReducedModel rmodel)
 Default implementation which simply clones this (subclass!)instance and returns the copy to use in reduced models. 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 ()
 

Static Public Member Functions

static function errmsg = validModelForEstimator (models.BaseFullModel model)
 Validations. More...
 
- Static Public Member Functions inherited from error.BaseCompLemmaEstimator
static function errmsg = validModelForEstimator (models.BaseFullModel model)
 Validations. More...
 
- Static Public Member Functions inherited from error.BaseEstimator
static function est = getEstimator (models.BaseFullModel model)
 Factory method that creates a suitable error estimator for the given model. More...
 
static function errmsg = validModelForEstimator (models.ReducedModel rmodel)
 Abstract static method that forces subclasses to specify whether an estimator can be used for a given model or not. More...
 

Additional Inherited Members

- Public Attributes inherited from error.BaseCompLemmaEstimator
 EstimationData = "[]"
 \(3\times n\) matrix containing the \(t,\alpha(t),\beta(t)\) values at each time step. More...
 
 aComp
 
- Public Attributes inherited from error.BaseEstimator
 Enabled
 Flag that indicates whether error estimation is used or not. More...
 
 StateError = "[]"
 The reduction state-space error from the last simulation. More...
 
 ExtraODEDims = 0
 The dimensions added to the ODE function by the estimator. More...
 
 OutputError = "[]"
 The output error from the last simulation. More...
 
models.ReducedModel ReducedModel = "[]"
 The reduced model associated with the error estimator. More...
 
 mu
 
- 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...
 
- 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 DPCMObject
static function obj = loadobj (obj, from)
 Re-register any registered change listeners! More...
 
static function obj = loadobj (obj, from)
 
- Protected Attributes inherited from error.BaseCompLemmaEstimator
 StepNr
 The current step. More...
 

Member Function Documentation

function copy = error.GLEstimator.clone ( )

Creates a deep copy of this estimator instance.

Generated fields of copy:

Definition at line 57 of file GLEstimator.m.

function b = error.GLEstimator.getBeta ( colvec< double x,
double  t 
)

Definition at line 72 of file GLEstimator.m.

References error.BaseEstimator.mu.

function ct = error.GLEstimator.postProcess ( colvec< double x,
double  t,
integer  inputidx 
)

Return values: ct: The time needed for postprocessing.

Parameters
xThe state variable vector \(\vx(t)\)
tThe current time(s) \(t \in [0, T]\)
inputidxThe index \(i\) of the currently used input function \(u_i(t)\). Set to \([]\) if not used.

Definition at line 116 of file GLEstimator.m.

References error.BaseEstimator.StateError.

function ct = error.GLEstimator.prepareConstants ( colvec< double mu,
integer  inputidx 
)

Return values: ct: The time needed for preprocessing.

Parameters
muThe currently used parameter \(\vmu\). Set to \([]\) if not used.
inputidxThe index \(i\) of the currently used input function \(u_i(t)\). Set to \([]\) if not used.

Definition at line 81 of file GLEstimator.m.

References models.ReducedModel.FullModel, and error.BaseEstimator.ReducedModel.

function errmsg = error.GLEstimator.validModelForEstimator ( models.BaseFullModel  model)
static

Validations.

Parameters
modelA KerMor full model
Required fields of model:

Definition at line 136 of file GLEstimator.m.

References models.BaseFirstOrderSystem.f, and models.BaseModel.System.


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