DEFAULTESTIMATOR Default error "estimator" for reduced models Standard estimator that is independent from any special reduced model since it computes the full error! More...

Detailed Description

DEFAULTESTIMATOR Default error "estimator" for reduced models Standard estimator that is independent from any special reduced model since it computes the full error!

Attention: This error estimator computes the true 'state space' error norm. If output is used, the correct state space error norm is mapped to the 'estimated' output error norm \(\no{y} \leq \no{C}\no{e}\), so the computed "correct" output error estimation will 'NOT' equal the real output error norm \(\no{y} = \no{C(x-Vz)}\), as only \(\no{e(t)}\) but not the vector-valued \(e(t)\) is known. However, the extra property error.DefaultEstimator.RealOutputError contains the true output error \(\no{C(x-Vz)}\) as during processing the correct error \(e(t)\) is known.

Author: Daniel Wirtz

Date: 2010-11-24

Change in 0.4:: (Daniel Wirtz, 2011-06-01) Introduced a new property error.DefaultEstimator.RealOutputError to reflect that the actual output error also cannot be obtained by this error estimator. See the class comments for details.

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

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 DefaultEstimator.m.

Public Member Functions
	DefaultEstimator (models.ReducedModel rmodel)
	Creates the default error estimator that works with every model since it computes the full system error. More...

function copy =	clone ()
	Clones this DefaultEstimator. More...

function eint =	evalODEPart ()
	The default estimator does not have an ODE part as it computes the full error in the postprocessing step. More...

function e0 =	getE0 (colvec< double > mu)
	This error estimator does not use any ODE dimensions, so the initial error part is an empty matrix. More...

function ct =	postProcess (colvec< double > x,double t,integer inputidx)
	Overwrites the default postprocess method. More...

function ct =	prepareConstants (colvec< double > mu,integer inputidx)
	Return values: ct: The time needed for postprocessing. 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...

virtual function eint =	evalODEPart (colvec x,double t,double ut)
	Template method for evaluation of the auxiliary ode part of the error estimator. 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 (varargin)

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

Public Attributes
	RealOutputError
	The true output error \(\no{C(x(t)-Vz(t))}\) for \(t\in[0,T]\). More...

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

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 DPCMObject
static function obj =	loadobj (obj, from)
	Re-register any registered change listeners! More...

static function obj =	loadobj (obj, from)

Constructor & Destructor Documentation

error.DefaultEstimator.DefaultEstimator ( models.ReducedModel rmodel )

Creates the default error estimator that works with every model since it computes the full system error.

Disabled per default since estimations are expensive.

Parameters

rmodel A KerMor reduced model

Required fields of rmodel:

Definition at line 71 of file DefaultEstimator.m.

References error.BaseEstimator.Enabled, error.BaseEstimator.ExtraODEDims, models.ReducedModel.FullModel, error.BaseEstimator.offlineComputations(), and error.BaseEstimator.prepareForReducedModel().

Here is the call graph for this function:

Member Function Documentation

function copy = error.DefaultEstimator.clone ( )

Clones this DefaultEstimator.

Definition at line 95 of file DefaultEstimator.m.

function eint = error.DefaultEstimator.evalODEPart ( )

The default estimator does not have an ODE part as it computes the full error in the postprocessing step.

Parameters

x	The full extended state variable vector. Extended means that the last ExtraODEDims rows contain the error estimators own data. If not used, implementers must take care to ditch those values if any function evaluations are performed within the integral part.
t	The current time \(t\)
mu	The current parameter \(\mu\)
ut	The value of the input function \(u(t)\) if given, [] else.

Return values

eint	The auxiliary ode part value.

Definition at line 107 of file DefaultEstimator.m.

function e0 = error.DefaultEstimator.getE0 ( colvec< double > mu )

This error estimator does not use any ODE dimensions, so the initial error part is an empty matrix.

Parameters

mu	The currently used parameter \(\vmu\). Set to \([]\) if not used.

Definition at line 129 of file DefaultEstimator.m.

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

Overwrites the default postprocess method.

Parameters

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

Definition at line 142 of file DefaultEstimator.m.

References models.BaseFirstOrderSystem.computeOutput(), error.BaseEstimator.ExtraODEDims, models.ReducedModel.FullModel, models.BaseModel.G, Norm.L2(), Norm.LG(), error.BaseEstimator.mu, RealOutputError, error.BaseEstimator.ReducedModel, models.BaseModel.simulate(), error.BaseEstimator.StateError, models.BaseModel.System, and models.ReducedModel.V.

Here is the call graph for this function:

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

Return values: ct: The time needed for postprocessing.

Parameters

mu	The currently used parameter \(\vmu\). Set to \([]\) if not used.
inputidx	The index \(i\) of the currently used input function \(u_i(t)\). Set to \([]\) if not used.

Definition at line 174 of file DefaultEstimator.m.

static function errmsg = error.DefaultEstimator.validModelForEstimator ( varargin )

static

Definition at line 192 of file DefaultEstimator.m.

Member Data Documentation

error.DefaultEstimator.RealOutputError

The true output error \(\no{C(x(t)-Vz(t))}\) for \(t\in[0,T]\).

In difference to the OutputError property, this field contains the true output error of the reduced simulation. See the class comments for details.

See Also: OutputError

Note: This property has non-standard access specifiers: SetAccess = Private, GetAccess = Public; Matlab documentation of property attributes.

Definition at line 53 of file DefaultEstimator.m.

Referenced by postProcess().

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

core/+error/DefaultEstimator.m

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation