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

Detailed Description

reduced model for linear stationary problems as given by a LinStatDune.DetailedModel.

Definition at line 18 of file ReducedModel.m.

Inheritance diagram for LinStatDune.ReducedModel:
Inheritance graph
[legend]
Collaboration diagram for LinStatDune.ReducedModel:
Collaboration graph
[legend]

Public Member Functions

 ReducedModel (LinStatDune.DetailedModel dmodel,BasisGenDescr bg_descr)
 Constructor for the reduced model. More...
 
function
rb_sim_data = 
rb_simulation (IReducedData reduced_data)
 reduced simulation for linear stationary finite volume schemes 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
rb_sim_data = 
rb_reconstruction (LinEvol.DetailedData detailed_data, rb_sim_data)
 
function LinEvol.ReducedModel c = copy ()
 function that deep copies this handle class More...
 
- Public Member Functions inherited from IReducedModel
 IReducedModel (IDetailedModel dmodel, bg_descr)
 Constructor of a reduced model. More...
 
function iseq = eq (IReducedModel other)
 Comparison operator checking whether the underlying detailed_model members of this and other are equal. More...
 
function IReducedData
reduced_data = 
gen_reduced_data (detailed_data)
 Constructs the reduced_data object holding low dimensional data needed for efficient reduced simulations with rb_simulation(). More...
 
function
reduced_data_subset = 
extract_reduced_data_subset (IReducedData reduced_data)
 Extracts a subset of the reduced_data generated by gen_reduced_data(). More...
 
virtual function
rb_sim_data = 
rb_simulation (reduced_data)
 Executes a reduced simulation and optionally an error estimation. More...
 
virtual function
rb_sim_data = 
rb_reconstruction (detailed_data, rb_sim_data)
 reconstructs the reduced simulation snapshots generated by rb_simulation() in the reduced space \({\cal W}_{\text{red}}\). More...
 
function U = get_dofs_from_sim_data (sim_data)
 extracts the \(H\) dimensional Dof vector from the sim_data structure More...
 
function IDetailedData
detailed_data = 
gen_detailed_data (model_data)
 initiates the reduced basis generation process More...
 
function p = plot_sim_data (model_data, sim_data, plot_params)
 plots the simulation data as returned by detailed_simulation() More...
 
function
model_data = 
gen_model_data ()
 generates large model data. More...
 
function
sim_data = 
detailed_simulation (model_data)
 executes a detailed simulation for a given parameter More...
 
function this = set_mu (mu)
 Sets the active parameter vector \(\mu \in {\cal M}\) used for simulations on this model. More...
 
function mu = get_mu ()
 returns the active parameter vector \(\mu \in { \cal M }\) More...
 
function
rb_size = 
get_rb_size (detailed_data)
 returns the size of the generated reduced basis by the IDetailedData class. More...
 
function  couple_N_and_M (detailed_data, ratio, factor)
 sets all the basis sizes for reduced simulations by a ratio with respect to the maximum possible basis size and a factor between RB and EI basis sizes. More...
 
function this = set_Mratio (detailed_data, ratio)
 in case of multiple operators subject to empirical interpolation, this sets number of reduced basis functions used for reduced simulations by specifying a ratio. More...
 
function Mratio = get_Mratio (detailed_data)
 in case of multiple operators subject to empirical interpolation, this gets the mean of ratio between the number of reduced basis functions used for reduced simulations and the maximum possible. More...
 
function
varargout = 
subsref (S)
 forwarding of fieldnames access to the underlying detailed_model description More...
 

Static Public Member Functions

static function Delta = get_estimators_from_sim_data (rb_sim_data)
 
static function Delta = get_estimator_from_sim_data (rb_sim_data)
 Static helper method returning an error estimator for the whole reduced trajectory \(\{u_{\text{red}}(\cdot, t^k)\}_{k=0}^{K}\) generated by rb_simulation(). 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

 enable_error_estimator = false
 
 mu
 
- Public Attributes inherited from IReducedModel
 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...
 
 crb_enabled = false
 flag indicating whether this model depends on collateral reduced basis spaces. More...
 
::IDetailedModel detailed_model
 an object which shall be reduced
 
::BasisGenDescr bg_descr
 a structure defining the basis generation routines and data structures.
 
 enable_error_estimator
 boolean flag indicating whether during an rb_simulation() an a posteriori error estimator shall be computed. More...
 
 N = 0
 control variable for the size of the reduced basis used for reduced simulations. By default this is equal to the size of the generated reduced basis. More...
 
 M = 0
 control variable for the size of the (collateral) reduced basis used for empirical interpolations. By default this is equal to the size of the generated reduced basis. More...
 
 Mstrich = 0
 control variable for the number of (collateral) reduced basis vectors used for error estimation. By default this is equal to zero. 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...
 

Additional Inherited Members

- 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.ReducedModel.ReducedModel ( LinStatDune.DetailedModel  dmodel,
BasisGenDescr  bg_descr 
)

Constructor for the reduced model.

Parameters
dmodelobject specifying how the high dimensional data can be computed.
bg_descrstructure specifying how the reduced basis shall be generated.

Definition at line 37 of file ReducedModel.m.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

function LinEvol.ReducedModel c = LinStatDune.ReducedModel.copy ( )
virtual

function that deep copies this handle class

Return values
can object which is a deep copy of this object.

Implements IReducedModel.

Definition at line 189 of file ReducedModel.m.

Here is the call graph for this function:

function Delta = LinStatDune.ReducedModel.get_estimator_from_sim_data (   rb_sim_data)
staticvirtual

Static helper method returning an error estimator for the whole reduced trajectory \(\{u_{\text{red}}(\cdot, t^k)\}_{k=0}^{K}\) generated by rb_simulation().

Parameters
rb_sim_datastruct holding reduced simulation data returned by IReducedModel.rb_simulation() . struct holding reduced simulation data returned by IReducedModel.rb_simulation() .
Return values
DeltaThis is a (K+1) x 1 vector of estimates \(\eta^k(\mu)\) Delta = get_estimators_from_sim_data(rb_sim_data); This is a scalar computed from the estimates \(\eta^k(\mu)\). Usually the maximum over \(k=0,\ldots,K\) is returned.

Implements IReducedModel.

Definition at line 213 of file ReducedModel.m.

function Delta = LinStatDune.ReducedModel.get_estimators_from_sim_data (   rb_sim_data)
static

Definition at line 202 of file ReducedModel.m.

function mu = LinStatDune.ReducedModel.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 140 of file ReducedModel.m.

Here is the caller graph for this function:

function rb_sim_data = LinStatDune.ReducedModel.rb_reconstruction ( LinEvol.DetailedData  detailed_data,
  rb_sim_data 
)

Parameters
detailed_dataobject defining the basis generation algorithm and storage for storing high dimensional data, i.e. dependent on dimension \(H\). This data is necessary for detailed simulations, construction of online matrices, reduced_data and reconstruction of reduced simulations.
rb_sim_datastruct holding reduced simulation data returned by IReducedModel.rb_simulation() .
Return values
rb_sim_datastruct holding the reduced simulation results and their reconstructions.

Definition at line 163 of file ReducedModel.m.

Here is the call graph for this function:

function rb_sim_data = LinStatDune.ReducedModel.rb_simulation ( IReducedData  reduced_data)

reduced simulation for linear stationary finite volume schemes

Parameters
reduced_dataan object constructing and storing all (low-dimensional) reduced matrices and vectors needed for reduced simulations.
Return values
rb_sim_datarb sim data
Required fields of reduced_data:
  • AN_comp —  AN comp
  • fN_comp —  fN comp
  • KII —  KII
  • mI —  mI
  • m —  m
Generated fields of rb_sim_data:
  • uN —  uN
  • Delta —  Delta

Definition at line 53 of file ReducedModel.m.

Here is the call graph for this function:

function IDetailedModel this = LinStatDune.ReducedModel.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
Generated fields of this:
  • mu —  mu

Implements IModel.

Definition at line 113 of file ReducedModel.m.


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