rbmatlab  1.16.09
 All Classes Namespaces Files Functions Variables Modules Pages
List of all members | Public Member Functions | Static Public Member Functions
LinStatDune.DetailedModel Class Reference

Detailed Description

Detailed model for a linear stationary problem with a discretization implemented in Dune-RB.

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

It solves 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 LinStatDune.DetailedModel:
Inheritance graph
[legend]
Collaboration diagram for LinStatDune.DetailedModel:
Collaboration graph
[legend]

Public Member Functions

 DetailedModel (descr)
 constructor based on problem description 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...
 
function
sim_data = 
detailed_simulation (ModelData model_data)
 
function ModelData
model_data = 
gen_model_data ()
 generates large model data. More...
 
function p = plot_sim_data (ModelData model_data, sim_data, plot_params)
 
- 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  issue_plot_command (plot_dir, command)
 
static function  close_figure_and_vtk_plot (src, event)
 
- 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

LinStatDune.DetailedModel.DetailedModel (   descr)

constructor based on problem description

Parameters
descrstructure describing the problem and the descretization

Definition at line 42 of file DetailedModel.m.

Here is the call graph for this function:

Member Function Documentation

function ModelDatamodel_data = LinStatDune.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_dataMatlab structure storing high dimensional data needed by detailed_simulation().

Implements IDetailedModel.

Definition at line 97 of file DetailedModel.m.

static function U = LinStatDune.DetailedModel.get_dofs_from_sim_data (   sim_data)
staticvirtual

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

Parameters
sim_datamatlab 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 144 of file DetailedModel.m.

function mu = LinStatDune.DetailedModel.get_mu ( )
virtual

returns the active parameter vector \(\boldsymbol\mu \in {\cal M}\)

The default implementation returns a vector of the values of the fields of the descr structure with names descr.mu_names.

Return values
muThe parameter vector \(\boldsymbol\mu\)

Implements IModel.

Definition at line 76 of file DetailedModel.m.

function IDetailedModel this = LinStatDune.DetailedModel.set_mu (   mu)
virtual

sets the active parameter vector \(\mu \in {\cal M}\)

The parameter set here, is used by the detailed_simulation() function.

The default implementation sets all fieldnames descr.mu_names in the descr struct.

Parameters
muThe parameter vector \(\boldsymbol\mu\).
Return values
thishandle to the changed DetailedModel

Implements IModel.

Definition at line 53 of file DetailedModel.m.


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