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

Detailed Description

Detailed model for the Thermalblock problem.

This is a specialization of a linear stationary problem with simplified methods for parameter handling, and a modified output method.

Definition at line 18 of file DetailedModel.m.

Inheritance diagram for ThermalBlock.DetailedModel:
Inheritance graph
[legend]
Collaboration diagram for ThermalBlock.DetailedModel:
Collaboration graph
[legend]

Public Member Functions

 DetailedModel (ModelDescr descr)
 constructor based on problem description More...
 
function 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 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 LinStat.DetailedModel
 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...
 
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...
 

Additional Inherited Members

- Static Public Member Functions inherited from LinStat.DetailedModel
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...
 
- 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

ThermalBlock.DetailedModel.DetailedModel ( ModelDescr  descr)

constructor based on problem description

Parameters
descrstructure describing the problem and the discretization

Definition at line 33 of file DetailedModel.m.

Member Function Documentation

function mu = ThermalBlock.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\)

Reimplemented from IDetailedModel.

Definition at line 53 of file DetailedModel.m.

function p = ThermalBlock.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_dataMatlab structure storing (possibly) high dimensional data needed by IDetailedModel.detailed_simulation().
sim_datasimulation data structure as returned by detailed_simulation()
plot_paramsstructure which controls the plot output
Return values
pGUI handle to the created MATLAB figure
Required fields of sim_data:
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 (default = none)
  • no_lines —  boolean flag indicating whether lines between the grid cell shall be skipped drawing (default = 1)
  • plot_blocks —  boolean flag indicating whether the thermal blocks shall be drawn. (default = 1)

Definition at line 58 of file DetailedModel.m.

function this = ThermalBlock.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

Reimplemented from IDetailedModel.

Definition at line 45 of file DetailedModel.m.

Here is the caller graph for this function:


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