Detailed Description

a test model doing nothing

In this detailed model only the name of the called member function is printed. Such it enables to set-up Greedy algorithms and check wether the functions are called in the correct order.

Definition at line 18 of file DetailedModel.m.

Inheritance diagram for Test.DetailedModel:

[legend]

Collaboration diagram for Test.DetailedModel:

[legend]

Public Member Functions
	DetailedModel (ModelDescr descr)
	constructor based on problem description More...

function ModelData model_data =	gen_model_data ()
	generates large model data. More...

function sim_data =	detailed_simulation (ModelData model_data)
	executes a detailed simulation for a given parameter More...

function p =	plot_sim_data (ModelData model_data, sim_data, plot_params)
	plots the simulation data as returned by detailed_simulation() More...

Public Member Functions inherited from Greedy.User.FVDetailedModelDefault
	FVDetailedModelDefault (ModelDescr descr)
	Constructor for this class. More...

function UON =	orthonormalize (ModelData model_data, U)
	orthonormalizes a set of discrete functions \(\{ v_h^l \}_{l=1}^L\) More...

function U0 =	init_values_algorithm (ModelData model_data)
	computes the Dof vectors for the initial value function \(u_h^0(\cdot;t\mu) = {\cal P}_h[u_0(\mu)]\) More...

function UV =	inner_product (ModelData model_data, U, V)
	computes the inner project between the Dof vectors of two discrete functions More...

Public Member Functions inherited from Greedy.User.IDetailedModel
	IDetailedModel (descr)
	constructor More...

Public Member Functions inherited from IDetailedModel
	IDetailedModel (descr)
	constructor More...

function isequal =	eq (IDetailedModel other)
	overloaded equality (`==`) operator, by default comparing the descr variables More...

function IDetailedModel this =	set_mu (mu)
	sets the active parameter vector \(\mu \in {\cal M}\) More...

function mu =	get_mu ()
	returns the active parameter vector \(\boldsymbol\mu \in {\cal M}\) More...

virtual function sim_data =	detailed_simulation (model_data)
	executes a detailed simulation for a given parameter More...

virtual function p =	plot_sim_data (model_data, sim_data, plot_params)
	plots the simulation data as returned by detailed_simulation() More...

Static Public Member Functions
static function U =	get_dofs_from_sim_data (sim_data)
	extracts the \(H\) dimensional Dof vector from the `sim_data` structure More...

static function snapshot =	get_dofs_at_time (sim_data, time_index)

Static Public Member Functions inherited from Greedy.User.FVDetailedModelDefault
static function errs =	l2_error_sequence_algorithm (U, Uapprox,ModelData model_data)
	computes the \(L^2(\Omega)\) error for each "snapshot" of a trajectories and returns the sequence of these errors. More...

static function errs =	linfty_error_sequence_algorithm (U, Uapprox,ModelData model_data)
	computes the \(L^{\infty}(\Omega)\) error for each "snapshot" of a trajectories and returns the sequence of these errors. More...

static function W =	get_inner_product_matrix (ModelData model_data)
	returns the inner product matrix for efficient computation of inner products on \({\cal W}_h\) More...

Static Public Member Functions inherited from IModel
static function ok =	struct_check (descr, checks)
	executes checks on the fields of a structure object More...

Additional Inherited Members
Public Attributes inherited from IDetailedModel
	descr
	The description structure holding information about the analytical parametrized problem and its discretization. More...

	decomp_mode

	mu_names
	cell array of strings describing the parameters of the model More...

	mu_ranges
	cell array of vectors of size two defining the allowed interval range for the parameter components More...

	verbose
	an integer defining the verbosity level of information output during basis generation More...

	debug
	an integer defining the debugging level controlling error output and extra tests during basis generation More...

Public Attributes inherited from IModel
	num_cpus = 4
	The number of CPUs used for parallel sessions. More...

	decomp_mode
	Decomposition operation mode. More...

	mu_names
	cell array of strings describing the parameters of the model More...

	mu_ranges
	cell array of vectors of size two defining the allowed interval range for the parameter components More...

	verbose
	an integer defining the verbosity level of information output during basis generation More...

	debug
	an integer defining the debugging level controlling error output and extra tests during basis generation More...

Static Public Attributes inherited from IDetailedModel
static const	base_checks
	this structure holds variable names that need to be defined by the descr structure. More...

Static Public Attributes inherited from IModel
static const	time_checks
	This constant can be used for a consistency check of time evolution members in the ModelDescr with help of IModel.struct_check() More...

Constructor & Destructor Documentation

Test.DetailedModel.DetailedModel ( ModelDescr descr )

constructor based on problem description

Parameters

descr structure describing the problem and the discretization

Definition at line 34 of file DetailedModel.m.

Member Function Documentation

function sim_data = Test.DetailedModel.detailed_simulation ( ModelData model_data )

executes a detailed simulation for a given parameter

This function computes a numerical scheme defined by the descr for the parameter set via the set_mu() method.

Parameters

model_data model data

Return values

sim_data structure holding the \(H\)-dimensional simulation data.

Definition at line 64 of file DetailedModel.m.

Here is the call graph for this function:

function ModelDatamodel_data = Test.DetailedModel.gen_model_data ( )

virtual

generates large model data.

This function generates e.g. a grid, which is not to be stored in the model, but required for numerics.

Return values

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

Implements IDetailedModel.

Definition at line 48 of file DetailedModel.m.

static function U = Test.DetailedModel.get_dofs_from_sim_data ( sim_data )

staticvirtual

extracts the \(H\) dimensional Dof vector from the sim_data structure

Parameters

sim_data matlab struct with simulation data generated e.g. by detailed_simulation() or rb_reconstruction() methods.

Return values

U	\(H\) dimensional Dof vector

Implements Greedy.User.IDetailedModel.

Definition at line 117 of file DetailedModel.m.

function p = Test.DetailedModel.plot_sim_data	(	ModelData	model_data,
			sim_data,
			plot_params
	)

plots the simulation data as returned by detailed_simulation()

Parameters

sim_data	simulation data structure as returned by detailed_simulation()
plot_params	structure which controls the plot output
model_data	model data

Return values

p	GUI handle to the created MATLAB figure

Definition at line 99 of file DetailedModel.m.

Here is the call graph for this function:

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

rbasis/basisgen/oop/rbmodels/+Test/DetailedModel.m

Detailed Description

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation