Detailed Description

Detailed model for a linear stationary problem with a Finite element discretization.

This is a detailed model for a problem type rb_problem_type = "LinStat"

It solves finite element discretization of the form

\[ A u = r, \]

with a matrix \(A\) and a right hand side \(r\) returned by [A,r] = descr.operators(descr, model_data)

Furthermore, an output fuctional can be defined by the description field descr.operators_output(descr, model_data);

Definition at line 18 of file DetailedModel.m.

Inheritance diagram for LinStat.DetailedModel:

[legend]

Collaboration diagram for LinStat.DetailedModel:

[legend]

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

function sim_data =	detailed_simulation (ModelData model_data)
	function performing the detailed simulation of a lin-stat model, i.e. the matrix and RHS assembly and solving of the system, possibly also output computation. More...

function ModelData model_data =	gen_model_data ()
	generates large model data. 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 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 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

LinStat.DetailedModel.DetailedModel ( ModelDescr descr )

constructor based on problem description

Parameters

descr structure describing the problem and the discretization

Definition at line 42 of file DetailedModel.m.

Here is the call graph for this function:

Member Function Documentation

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

function performing the detailed simulation of a lin-stat model, i.e. the matrix and RHS assembly and solving of the system, possibly also output computation.

Parameters

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

Return values

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

Required fields of model_data:

df_info — feminfo object holding info about the Finite element function space.

Generated fields of sim_data:

uh — a femdiscfunc simulation result.
s — DOFs of the output functional.

Definition at line 19 of file detailed_simulation.m.

function ModelData model_data = LinStat.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 19 of file gen_model_data.m.

static function U = LinStat.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 IDetailedModel.

Definition at line 63 of file DetailedModel.m.

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

plots the simulation data as returned by detailed_simulation()

This method actually calls femdiscfunc.plot().

Parameters

model_data	Matlab structure storing (possibly) high dimensional data needed by IDetailedModel.detailed_simulation().
sim_data	simulation data structure as returned by detailed_simulation()
plot_params	structure which controls the plot output

Return values

p	GUI handle to the created MATLAB figure

Required fields of sim_data:

uh — discrete Finite element function (c.f. femdiscfunc)

Optional fields of plot_params:

subsampling_level — number of sampling steps for interpolation of discrete Finite element functions. (default = 10)
title — title of the plot

Definition at line 19 of file plot_sim_data.m.

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

rbasis/problem_types/+LinStat/@DetailedModel/DetailedModel.m
rbasis/problem_types/+LinStat/@DetailedModel/detailed_simulation.m
rbasis/problem_types/+LinStat/@DetailedModel/gen_model_data.m
rbasis/problem_types/+LinStat/@DetailedModel/plot_sim_data.m

Detailed Description

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation