ARE.DetailedData Class Reference

Detailed Description

Implementation of the detailed data interface for the ARE.

This class keeps the reduced basis and the information about the calculation of .

Andreas Schmidt, 2016

Definition at line 18 of file DetailedData.m.

Inheritance diagram for ARE.DetailedData:

Collaboration diagram for ARE.DetailedData:

Public Member Functions
	DetailedData (model,ModelData model_data)
	DETAILEDATA Constructor for the DetailedData class. More...
function s =	get_rb_size ()
	GET_RB_SIZE returns the size of the reduced basis. More...
function	set_gamma_mode (model)
	SET_GAMMA_CALCULATION set the mode for the gamma calculation If you change the gamam mode, the state will be set to uninitialized, which means you first have to run INITIAILIZE_GAMMA in order to be able to calculate. More...
function this =	initialize_gamma (model,ModelData model_data)
	INITIALIZE_GAMMA Call the gen_detailed_data method in the gamma calculation interface and populate the data to the field in detailed_data. More...
function dd =	extract_subbasis (N)
	EXTRACT_SUBBASIS Extract a part of the basis. More...

Static Public Member Functions
static function this =	initialize_with_bgen (model,ModelData model_data)
	This function is used in the gen_detailed_data function and creates an instance of the DetailedData class and instantiates the basis building procedure: More...

Public Attributes
	RB_V
	Store the reduced basis:
	RB_W
	RB_size
	The size of the reduced basis.
	info
	Information that was returned by the basis generation algorithm.
	gamma = {""}
	Handler for the norm of the inverse operator norm ||L^{-1}|| The field gamma is filled by the corresponding gamma_calculation Information returned by gen_detailed_data from the gamma interface. More...
	gamma_mode
	Name of the gamma mode, stored within this detailed data instance.
	model_data
	Model data handle, just for the easier calculation of the reduced matrices:
	algorithm
	This is a handle to the gamma calculation interface. This can be any class that implements the GAMMACALCULATORINTERFACE class. More...
	gamma_initialized = false
	gamma_calculation

Constructor & Destructor Documentation

ARE.DetailedData.DetailedData	(		model,
		ModelData	model_data
	)

DETAILEDATA Constructor for the DetailedData class.

Parameters

model	model
model_data	Matlab structure storing (possibly) high dimensional data needed by IDetailedModel.detailed_simulation().

Required fields of model:

• RB_gamma_mode —  RB gamma mode

Definition at line 106 of file DetailedData.m.

Here is the call graph for this function:

Member Function Documentation

function dd = ARE.DetailedData.extract_subbasis

(

N

)

EXTRACT_SUBBASIS Extract a part of the basis.

Parameters

N

N

Return values

dd

dd

Generated fields of dd:

• RB_V —  RB V
• RB_W —  RB W

Definition at line 196 of file DetailedData.m.

function s = ARE.DetailedData.get_rb_size

(

)

GET_RB_SIZE returns the size of the reduced basis.

Return values

s

s

Definition at line 128 of file DetailedData.m.

function this = ARE.DetailedData.initialize_gamma	(		model,
		ModelData	model_data
	)

INITIALIZE_GAMMA Call the gen_detailed_data method in the gamma calculation interface and populate the data to the field in detailed_data.

Parameters

model	model
model_data	Matlab structure storing (possibly) high dimensional data needed by IDetailedModel.detailed_simulation().

Return values

this

this

Generated fields of this:

• gamma —  gamma
• gamma_initialized —  gamma initialized

Definition at line 168 of file DetailedData.m.

Here is the caller graph for this function:

function this = ARE.DetailedData.initialize_with_bgen (   model, ModelData  model_data  )

static

This function is used in the gen_detailed_data function and creates an instance of the DetailedData class and instantiates the basis building procedure:

Parameters

model	model
model_data	Matlab structure storing (possibly) high dimensional data needed by IDetailedModel.detailed_simulation().

Return values

this

this

Required fields of model:

• problem_type —  problem type
• RB_M_train —  RB M train

Generated fields of this:

• algorithm.M_train —  algorithm.M train
• RB_V —  RB V
• RB_W —  RB W
• RB_size —  RB size
• info —  info

Definition at line 221 of file DetailedData.m.

Here is the call graph for this function:

Here is the caller graph for this function:

function ARE.DetailedData.set_gamma_mode

(

model

)

SET_GAMMA_CALCULATION set the mode for the gamma calculation If you change the gamam mode, the state will be set to uninitialized, which means you first have to run INITIAILIZE_GAMMA in order to be able to calculate.

Parameters

model

model

Required fields of model:

• RB_gamma_mode —  RB gamma mode
• problem_type —  problem type

Definition at line 139 of file DetailedData.m.

Here is the caller graph for this function:

Member Data Documentation

ARE.DetailedData.algorithm

This is a handle to the gamma calculation interface. This can be any class that implements the GAMMACALCULATORINTERFACE class.

Note

This property has non-standard access specifiers: SetAccess = Protected, GetAccess = Public

Matlab documentation of property attributes.

Definition at line 87 of file DetailedData.m.

ARE.DetailedData.gamma = {""}

Handler for the norm of the inverse operator norm ||L^{-1}|| The field gamma is filled by the corresponding gamma_calculation Information returned by gen_detailed_data from the gamma interface.

Default: {""}

Definition at line 60 of file DetailedData.m.

---

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

• rbasis/problem_types/+ARE/DetailedData.m