rbmatlab  1.16.09
 All Classes Namespaces Files Functions Variables Modules Pages
List of all members | Public Member Functions
ARE.GammaCalculation.GammaCalculatorInterface Class Referenceabstract

Detailed Description

BASE Basis class for the preparation and calculation of gamma Any subclass should also overwrite the.

Definition at line 19 of file GammaCalculatorInterface.m.

Inheritance diagram for ARE.GammaCalculation.GammaCalculatorInterface:
Inheritance graph
[legend]
Collaboration diagram for ARE.GammaCalculation.GammaCalculatorInterface:
Collaboration graph
[legend]

Public Member Functions

virtual function data = gen_detailed_data (ModelData model_data,IDetailedData detailed_data)
 GEN_DETAILED_DATA This function is called by the basis generation algorithm and should be used to calculate all high dimensional quantities that are required for the fast online calculation of $$. More...
 
virtual function fn = gen_reduced_data (IDetailedData detailed_data,IReducedData reduced_data)
 GEN_REDUCED_DATA The return value of this function should be a function handle that has the following form rb_gamma = fn(rmodel, reduced_data, sim) More...
 
function g = gamma (ModelData model_data, sim)
 GAMMA This function should be implemented when this method allows the calculation of the true gamma value. More...
 
function s = name ()
 This function should return the name of the gamma calculation method. By default its just the class name! More...
 

Member Function Documentation

function g = ARE.GammaCalculation.GammaCalculatorInterface.gamma ( ModelData  model_data,
  sim 
)

GAMMA This function should be implemented when this method allows the calculation of the true gamma value.

Parameters
model_dataMatlab structure storing (possibly) high dimensional data needed by IDetailedModel.detailed_simulation().
simsim
Return values
gg

Definition at line 74 of file GammaCalculatorInterface.m.

function data = ARE.GammaCalculation.GammaCalculatorInterface.gen_detailed_data ( ModelData  model_data,
IDetailedData  detailed_data 
)
pure virtual

GEN_DETAILED_DATA This function is called by the basis generation algorithm and should be used to calculate all high dimensional quantities that are required for the fast online calculation of $$.

Parameters
model_dataMatlab structure storing (possibly) high dimensional data needed by IDetailedModel.detailed_simulation().
detailed_dataobject defining the basis generation algorithm and storage for storing high dimensional data, i.e. dependent on dimension \(H\). This data is necessary for detailed simulations, construction of online matrices, reduced_data and reconstruction of reduced simulations.
Return values
datadata

Implemented in ARE.GammaCalculation.Lyapunov.

function fn = ARE.GammaCalculation.GammaCalculatorInterface.gen_reduced_data ( IDetailedData  detailed_data,
IReducedData  reduced_data 
)
pure virtual

GEN_REDUCED_DATA The return value of this function should be a function handle that has the following form rb_gamma = fn(rmodel, reduced_data, sim)

Parameters
detailed_dataobject defining the basis generation algorithm and storage for storing high dimensional data, i.e. dependent on dimension \(H\). This data is necessary for detailed simulations, construction of online matrices, reduced_data and reconstruction of reduced simulations.
reduced_dataan object constructing and storing all (low-dimensional) reduced matrices and vectors needed for reduced simulations.
Return values
fnfn
function s = ARE.GammaCalculation.GammaCalculatorInterface.name ( )

This function should return the name of the gamma calculation method. By default its just the class name!

Return values
ss

Definition at line 91 of file GammaCalculatorInterface.m.


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