Base class for all space reduction algorithms. More...

Detailed Description

Base class for all space reduction algorithms.

Author: Daniel Wirtz

Date: 11.03.2010

Definition at line 18 of file BaseSpaceReducer.m.

Public Member Functions
function [ V , W ] =	generateReducedSpace (models.BaseFullModel model)
	Generates the reduced linear subspace for the given model. More...

function	plotSummary (pm, context)

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 Attributes
logical	IncludeTrajectoryFxiData = false
	Flag if to include \(f(x_i)\) values for each \(x_i\) value, too. More...

	IncludeFiniteDifferences = false

	IncludeBSpan = false

	IncludeAxData = false

varargin	TargetDimensions = ":"
	This property determines which dimensions are to be reduced. It is possible to reduce the entire number of DoFs but also only selected ones. More...

	ProjectionError = "[]"

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
function V =	getInitialSpace (blockdata, pod, subset)
	Computes the initial space, which is the first POD mode of the initial values! More...

virtual function [ V , W ] =	generateReducedSpaceImpl (models.BaseFullModel model, subset)

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)

Additional Inherited Members
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)

Member Function Documentation

function [ V , W ] = spacereduction.BaseSpaceReducer.generateReducedSpace ( models.BaseFullModel model )

Generates the reduced linear subspace for the given model.

Depending on TargetDimensions, either all DoFs are reduced or one or more subsets, if e.g. physical quantities have to be treated separately.

See Also: TargetDimensions

Parameters

model A KerMor full model

Definition at line 90 of file BaseSpaceReducer.m.

References generateReducedSpaceImpl(), and TargetDimensions.

Here is the call graph for this function:

virtual function [V , W ] = spacereduction.BaseSpaceReducer.generateReducedSpaceImpl	(	models.BaseFullModel	model,
			subset
	)

protectedpure virtual

Implemented in spacereduction.PODGreedy, spacereduction.RotationDecorator, spacereduction.ManualReduction, and spacereduction.Krylov.

Referenced by generateReducedSpace().

Here is the caller graph for this function:

function V = spacereduction.BaseSpaceReducer.getInitialSpace	(	blockdata,
		pod,
		subset
	)

protected

Computes the initial space, which is the first POD mode of the initial values!

Required fields of blockdata:

Required fields of pod:

Definition at line 122 of file BaseSpaceReducer.m.

References all(), KerMor.App(), and Utils.findVecInMatrix().

Referenced by spacereduction.PODGreedy.generateReducedSpaceImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

function spacereduction.BaseSpaceReducer.plotSummary	(	pm,
		context
	)

virtual

Implements IReductionSummaryPlotProvider.

Reimplemented in spacereduction.PODGreedy.

Definition at line 108 of file BaseSpaceReducer.m.

References DPCMObject.ID, and ProjectionError.

Member Data Documentation

spacereduction.BaseSpaceReducer.IncludeAxData = false

Note: This property has custom functionality when its value is changed.

Definition at line 54 of file BaseSpaceReducer.m.

Referenced by spacereduction.PODGreedy.generateReducedSpaceImpl().

spacereduction.BaseSpaceReducer.IncludeBSpan = false

Note: This property has custom functionality when its value is changed.

Definition at line 51 of file BaseSpaceReducer.m.

Referenced by spacereduction.PODGreedy.generateReducedSpaceImpl(), and spacereduction.PODGreedy.plotSummary().

spacereduction.BaseSpaceReducer.IncludeFiniteDifferences = false

Note: This property has custom functionality when its value is changed.

Definition at line 48 of file BaseSpaceReducer.m.

Referenced by spacereduction.PODGreedy.generateReducedSpaceImpl(), and spacereduction.PODGreedy.plotSummary().

spacereduction.BaseSpaceReducer.IncludeTrajectoryFxiData = false

Flag if to include \(f(x_i)\) values for each \(x_i\) value, too.

Property class important:: Including this data in the subspace can reduce projection errors of nonlinearities

Default: false

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 32 of file BaseSpaceReducer.m.

Referenced by spacereduction.PODGreedy.generateReducedSpaceImpl(), and spacereduction.PODGreedy.plotSummary().

spacereduction.BaseSpaceReducer.ProjectionError = "[]"

Definition at line 84 of file BaseSpaceReducer.m.

Referenced by spacereduction.PODGreedy.generateReducedSpaceImpl(), and plotSummary().

spacereduction.BaseSpaceReducer.TargetDimensions = ":"

This property determines which dimensions are to be reduced. It is possible to reduce the entire number of DoFs but also only selected ones.

There are three options

: uses all dimensions as target dimensions
A single column index vector determines one subset of DoFs that should be reduced
A cell array of index column vectors gives a list of separate subspaces that should be generated during the state space reduction process. The resulting projection matrices will have a block structure. Overlapping indices are not allowed and will throw an error.

Default: :

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 57 of file BaseSpaceReducer.m.

Referenced by generateReducedSpace(), and models.BaseFullModel.off3_computeReducedSpace().

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

core/+spacereduction/BaseSpaceReducer.m

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Member Function Documentation

Member Data Documentation