rbmatlab  1.16.09
 All Classes Namespaces Files Functions Variables Modules Pages
List of all members | Public Member Functions | Public Attributes
Greedy.Interface Class Referenceabstract

Detailed Description

Interface class for all kind of reduced basis generation algorithms

Definition at line 18 of file Interface.m.

Inheritance diagram for Greedy.Interface:
Inheritance graph
[legend]
Collaboration diagram for Greedy.Interface:
Collaboration graph
[legend]

Public Member Functions

function Greedy.Combined summ = horzcat ()
 combines an arbitrary number of basis generation algorithms More...
 
function
detailed_data = 
gen_detailed_data (IReducedModel rmodel, detailed_data,Greedy.Checkpoint checkpoint)
 main entry function construction the detailed data tree storing the reduced basis functions. More...
 
virtual function  prepare (IReducedModel rmodel,ModelData model_data)
 initialization routine for basis extension More...
 
virtual function Greedy.DataTree.Detailed.INode
detailed_data = 
init_basis (IReducedModel rmodel,ModelData model_data)
 construction of an initial reduced basis More...
 
virtual function Greedy.DataTree.Detailed.INode
detailed_data = 
basis_extension (IReducedModel rmodel,Greedy.DataTree.Detailed.INode detailed_data, checkpoint)
 basis extension routine More...
 
function value = get_generated_basis_type ()
 returns the generated_basis_type property. Why??? More...
 

Public Attributes

 generated_basis_type
 string specifying the detailed data produced by this basis generation algorithm object. More...
 
 id
 This is an id string inherited by the underlying extension algorithm object implementing a Greedy.Plugin.Interface. More...
 
boolean enable_checkpointing = true
 control variable variable controlling whether check points shall be created after every reduced basis extension step. More...
 

Member Function Documentation

function Greedy.DataTree.Detailed.INode detailed_data = Greedy.Interface.basis_extension ( IReducedModel  rmodel,
Greedy.DataTree.Detailed.INode  detailed_data,
  checkpoint 
)
pure virtual

basis extension routine

This method is run by the gen_detailed_data() method at the very end, and shall actually construct the reduced basis.

Parameter values
checkpoint: an object of type Greedy.Checkpoint used for checkpointing.
Parameters
rmodelobject specifying how the reduced simulations can be computed.
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.
checkpointcheckpoint
Return values
detailed_dataobject storing the reduced basis information in the leaf nodes and information on the reduced basis generation in every node.

Here is the caller graph for this function:

function detailed_data = Greedy.Interface.gen_detailed_data ( IReducedModel  rmodel,
  detailed_data,
Greedy.Checkpoint  checkpoint 
)

main entry function construction the detailed data tree storing the reduced basis functions.

This method starts the reduced basis generation process, by calling the abstract interface methods init_basis() and basis_extension() subsequently. If enable_checkpointing is set to true, checkpoint shall be created periodically storing all data necessary to resume from this point in the algorithm, when the checkpoint is given as the optional third argument.

Parameters
rmodelobject providing descriptions of the entire model needed for basis generation.
detailed_dataeither a struct containing high dimensional model data needed to execute detailed simulations or an object of type Greedy.DataTree.Detailed.INode in case of resume from a checkpoint.
checkpointobject specifying a given point in the algorithm where it basis generation can be resumed.
Return values
detailed_dataobject storing the reduced basis information in the leaf nodes and information on the reduced basis generation in every node.
Required fields of checkpoint:
  • store —  store
  • child —  child

Definition at line 108 of file Interface.m.

Here is the call graph for this function:

function value = Greedy.Interface.get_generated_basis_type ( )

returns the generated_basis_type property. Why???

Return values
valuevalue
Note
This method has the MATLAB method attribute Hidden set to true.
matlab documentation of method attributes.

Definition at line 234 of file Interface.m.

function Greedy.Combined summ = Greedy.Interface.horzcat ( )

combines an arbitrary number of basis generation algorithms

This constructs a Greedy.Combined object from a horizontal concatenation of basis generation objects.

Example usage
sum = [ [ ei_greedy1, ei_greedy2, ei_greedy3 ], rb_greedy ];
Return values
summthe constructed object

Definition at line 86 of file Interface.m.

function Greedy.DataTree.Detailed.INode detailed_data = Greedy.Interface.init_basis ( IReducedModel  rmodel,
ModelData  model_data 
)
pure virtual

construction of an initial reduced basis

This method is called at the beginning of the gen_detailed_data() method right after a call to prepare(). It should be used to construct an initial reduced basis, e.g. approximating the initial value functions in case of evolution problems.

Parameters
rmodelobject specifying how the reduced simulations can be computed.
model_dataMatlab structure storing (possibly) high dimensional data needed by IDetailedModel.detailed_simulation().
Return values
detailed_dataobject storing the reduced basis information in the leaf nodes and information on the reduced basis generation in every node.

Here is the caller graph for this function:

function Greedy.Interface.prepare ( IReducedModel  rmodel,
ModelData  model_data 
)
pure virtual

initialization routine for basis extension

This method is run by the gen_detailed_data() method before the execution of the init_basis() methods and should be used for preparation purposes, like

  • initialization of the training and validation parameter space and
  • caching detailed simulations if necessary.
Parameters
rmodelobject specifying how the reduced simulations can be computed.
model_dataMatlab structure storing (possibly) high dimensional data needed by IDetailedModel.detailed_simulation().

Implemented in Greedy.Algorithm, Greedy.Combined, and Greedy.MetaInterface.

Here is the caller graph for this function:

Member Data Documentation

Greedy.Interface.enable_checkpointing = true

control variable variable controlling whether check points shall be created after every reduced basis extension step.

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

Definition at line 70 of file Interface.m.

Greedy.Interface.generated_basis_type

string specifying the detailed data produced by this basis generation algorithm object.

This should be one of

  • ei : for empirical interpolation basis
  • rb : for reduced basis
  • eirb : for combination fo empirical interpolation and reduced basis
Note
This property has the MATLAB attribute Dependent set to true.
This property is an abstract property without implementation.
This property has non-standard access specifiers: SetAccess = Private, GetAccess = Public
Matlab documentation of property attributes.

Definition at line 32 of file Interface.m.

Greedy.Interface.id

This is an id string inherited by the underlying extension algorithm object implementing a Greedy.Plugin.Interface.

At the moment this id is not used.

Note
This property has the MATLAB attribute Dependent set to true.
This property is an abstract property without implementation.
This property has non-standard access specifiers: SetAccess = Private, GetAccess = Public
Matlab documentation of property attributes.

Definition at line 51 of file Interface.m.


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