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

Detailed Description

Interface class for the generation and storage of reduced basis spaces as described in Module (M2).

Definition at line 17 of file IDetailedData.m.

Inheritance diagram for IDetailedData:
Inheritance graph
[legend]
Collaboration diagram for IDetailedData:
Collaboration graph
[legend]

Public Member Functions

 IDetailedData (BasisGenDescr bg_descr, model_data)
 constructor generating the reduced basis spaces More...
 
function ret = subsref (S)
 forwarding of fieldnames access to the underlying model_data struct More...
 
virtual function
rb_size = 
get_rb_size (IReducedModel rmodel)
 returns the dimension of the stored reduced basis space. More...
 

Public Attributes

BasisGenDescr bg_descr
 struct describing how the basis shall be generated. More...
 
::ModelData model_data
 struct holding \(H\)-dimensional model data, which is needed for an IDetailedModel.detailed_simulation(), e.g. a grid object.
 

Constructor & Destructor Documentation

IDetailedData.IDetailedData ( BasisGenDescr  bg_descr,
  model_data 
)

constructor generating the reduced basis spaces

It overwrites all properties of the IDetailedData implementation with values given in the BasisGenDescr structure.

Parameters
bg_descrstruct
model_datamodel data

Definition at line 53 of file IDetailedData.m.

Here is the caller graph for this function:

Member Function Documentation

function rb_size = IDetailedData.get_rb_size ( IReducedModel  rmodel)
pure virtual

returns the dimension of the stored reduced basis space.

Parameters
rmodelmodel specifying which basis space dimension shall be returned in case different spaces have been generated different parameters, time intervals or variables. In most implementations this parameter is unused.
Return values
rb_sizerb size

Implemented in NonlinEvol.DetailedData, TwoPhaseFlow.DetailedData, LinEvol.DetailedData, and Test.DetailedData.

function ret = IDetailedData.subsref (   S)

forwarding of fieldnames access to the underlying model_data struct

If the user calls detailed_data.parameter and the field parameter exists in the underlying model_data structure, the value of model_data.parameter is returned. This method is implemented for compatibility reasons, such that a basis generation object can be used like an old model. Try to prevent usage of this method in the future.

Note
that this method throws a RBmatlab:Compatibility warning if a description field is accessed.
Parameters
SS
Return values
retret

Definition at line 88 of file IDetailedData.m.

Member Data Documentation

IDetailedData.bg_descr

struct describing how the basis shall be generated.

The fields in this structure usually override the default values of the used IDetailedData object. See gen_reduced_model() for more details.

Definition at line 30 of file IDetailedData.m.


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