IDetailedData Class Reference

---

Detailed Description

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

Definition at line 1 of file IDetailedData.m.

Inheritance diagram for IDetailedData:

Collaboration diagram for IDetailedData:

List of all members.

Public Member Functions
	IDetailedData ( rmodel, model_data)
	constructor generating the reduced basis spaces
function ret =	subsref ( S)
	forwarding of fieldnames access to the underlying model_data struct
virtual function rb_size =	get_rb_size ( IReducedModel rmodel)
	returns the dimension of the stored reduced basis space.
Public Attributes
IReducedModel	bg_descr
	object describing how the basis shall be generated.
::ModelData	model_data
	struct holding -dimensional model data, which is needed for an IDetailedModel.detailed_simulation(), e.g. a grid object.

---

Constructor & Destructor Documentation

IDetailedData.IDetailedData	(		rmodel,
			model_data
	)

constructor generating the reduced basis spaces

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

An implementation of this interface should at least provide a

constructor with the following synopsis

     DetailedData(rmodel, model_data)

where model_data is an appropriate ModelData implementation, and rmodel an appropriate IReducedModel implementation.

Parameters:

rmodel	rmodel
model_data	model data

Definition at line 36 of file IDetailedData.m.

---

Member Function Documentation

function rb_size = IDetailedData.get_rb_size

(

IReducedModel

rmodel

)

[pure virtual]

returns the dimension of the stored reduced basis space.

Parameters:

rmodel

model 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_size

rb size

Implemented in LinEvol.DetailedData, NonlinEvol.DetailedData, TwoPhaseFlow.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:

S

S

Return values:

ret

ret

Definition at line 95 of file IDetailedData.m.

---

Member Data Documentation

IDetailedData.bg_descr

object describing how the basis shall be generated.

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

Definition at line 14 of file IDetailedData.m.

---

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

• rbasis/interface/IDetailedData.m