gen_rbmatlab_model_from_comsol_model.m

function model=gen_rbmatlab_model_from_comsol_model(comsol_model_name)
%function model=gen_rbmatlab_model_from_comsol_model(comsol_model_name)
%
% function creating a rbmatlab model from a comsol model automatically, so
% that mainly only the model.comsol_calculate_inner_product_matrices,
% model.operators and model.output_operators have to be
% implemented by hand but all the rest is done automatically!
%
% This function checks whether the problem is stationary or time-dependent and sets all
% the fields in the model the according way so it can be used for both!
%
% This is the first function to be called when transferring a comsol model
% to rb_matlab!!!
%
% input:
% comsol_model_name: a string with the name of the file of the comsol model
%
% output:
% model: the rbmatlab model struture that can be used to create model_data,
%        detailed_data and so on...
%
% Oliver Zeeb, 26.08.2012


model = [];
model.comsol_model_name = comsol_model_name;
comsol_model=mphload([model.comsol_model_name '.mph']);

comsol_tags = comsol_get_tags(comsol_model);
model.comsol_tags = comsol_tags;
    
%time-dependent or stationary model?
study_name = char(comsol_model.study.tags); 
study_type = char(comsol_model.study(study_name).feature.tags);


switch study_type
    case 'stat'
        model.type                   = 'stat'; 
        model.rb_problem_type        = 'comsol_model_stat';
        model.gen_model_data         = @comsol_stat_gen_model_data;
        model.detailed_simulation    = @comsol_stat_detailed_simulation;
        model.plot_sim_data          = @comsol_stat_plot_sim_data;
        model.gen_detailed_data      = @comsol_lin_stat_gen_detailed_data;
        model.RB_extension_algorithm = @comsol_RB_extension_greedy_lin_stat;
        model.reduced_data_subset    = @lin_stat_reduced_data_subset; %needed for creation of detailed_data
        model.get_dofs_from_sim_data = @(sim_data) sim_data.U;
        model.gen_reduced_data       = @comsol_lin_stat_gen_reduced_data;
        model.rb_simulation          = @lin_stat_rb_simulation;
        model.rb_reconstruction      = @rb_reconstruction_comsol;
        model.set_rb_in_detailed_data= @lin_stat_set_rb_in_detailed_data;
        model.get_rb_size            = @(model,detailed_data) size(detailed_data.RB,2);
        model.use_scm                = 0;
    case 'time'
        model.type                   = 'evol';
        model.rb_problem_type        = 'comsol_model_evol';
        model.gen_model_data         = @comsol_evol_gen_model_data;
        model.detailed_simulation    = @comsol_evol_detailed_simulation;
        model.plot_sim_data          = @comsol_evol_plot_sim_data;
        model.gen_detailed_data      = @comsol_evol_gen_detailed_data;
        model.set_rb_in_detailed_data= @(detailed_data,RB) setfield(detailed_data,'RB',RB);
        model.get_rb_size            = @(model,detailed_data)size(detailed_data.RB,2);
        model.gen_reduced_data       = @comsol_evol_gen_reduced_data;
        model.get_dofs_from_sim_data      = @(sim_data) sim_data.U;
        tlist = comsol_model.study(comsol_tags.study).feature('time').getDoubleArray('tlist');
        model.nt=length(tlist)-1;
        model.T = tlist(end);
        model.dt = model.T / model.nt;
        model.rb_simulation = @lin_evol_rb_simulation; 
        model.rb_operators = @lin_evol_rb_operators;
        model.rb_init_values = @rb_init_values_default;
        model.init_values_algorithm = @comsol_get_init_values;
        model.compute_output_functional = 0; 
        model.reduced_data_subset = @lin_evol_reduced_data_subset;
        model.error_norm='l2';
        model.data_const_in_time = 0;
        model.RB_extension_algorithm = @RB_extension_PCA_fixspace;
        model.filecache_ignore_fields_in_model={};
        model.filecache_ignore_fields_in_detailed_data={};
        model.rb_reconstruction = @comsol_evol_rb_reconstruction;
    otherwise
        error('Comsol study type not supported!')
end
  
%information about the solution, the grid and the used finite elements
model.element_type = comsol_get_element_type(comsol_model);  %determines the element type!  Must be lagrange fininte elements!
model.pdeg=comsol_get_pdeg(comsol_model);   %degree of the used fininte elements (linear, quadratic, ...?)
model.qdeg = 2;                             %quadrature degree --> needed in some rbmatlab fem_functions
model.dimrange=size(char(comsol_model.field.tags),1); %determines the number of field variables from the comsol_model

%rbmatlab parameters for debugging
model.verbose = 5;
model.debug = 0;

% Parameter values
model.set_mu = @set_mu_default;
model.get_mu = @get_mu_default;
model = comsol_get_global_params_from_comsol_model(model,comsol_model); %sets all the global parameters as rb-parameters mu
model.mu_ranges = my_mu_ranges_default(model);
model.decomp_mode = 0; % default: complete evaluation

model.compute_output_functional = 0;

% basis generation
%
% Lagrange basis:
% model.RB_generation_mode = 'lagrangian';
% model.RB_mu_list = {[...], [...]};
%
% Greedy Basis
model.RB_generation_mode = 'greedy_uniform_fixed'; %default: greedy
model.RB_error_indicator = 'estimator'; %'error'
model.RB_numintervals = 2*ones(length(model.mu_names),1);
model.rb_init_data_basis = @comsol_rb_init_data_basis;
model.get_estimator_from_sim_data = @(sim_data)sim_data.Delta(end);
model.inner_product = @calc_inner_product;
model.RB_stop_epsilon = 1e-4;
model.RB_stop_Nmax = 20; 
model.get_rb_from_detailed_data=@(detailed_data)detailed_data.RB;

model.comsol_calculate_inner_product_matrices = @comsol_calculate_inner_product_matrices_default;
model.get_inner_product_matrix = @(detailed_data)detailed_data.inner_product_matrices.L2; 


model.use_comsol = 1;% This field indicates whether the matrices are extracted from COMSOL
        % or if they are just forwarded from the model_data. That allows to
        % create the model_data using COMSOL and afterwards doing all the
        % computations without COMSOL. Especially on a Mac this really
        % accelerates things a lot!!!
        
model.comsol_get_eliminated_data = 0; %This field indicates in some functions, whether they return 
        %the full or the full or the eleiminated matrices! This is needed
        %since the eliminated matrices must be used for simulation (the
        %full matrices are singular!!!), but for some operations the full
        %matrices should be used!


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Auxiliary functions
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

function mu_ranges = my_mu_ranges_default(model) 
% sets the mu_ranges according to which mus are set in the comsol_model
    mu = get_mu(model);
    mu_var_factor = 0.5;
    mu_variation = mu_var_factor * abs(mu);
    mu_low = mu - mu_variation;
    mu_up = mu + mu_variation;
    mu_ranges = cell(1,length(mu));
    for k = 1:length(mu)
        mu_ranges{k} = [mu_low(k), mu_up(k)];
        if mu_low(k) == mu_up(k) %are both equal? --> mu must be zero!!!
            mu_ranges{k} = [-mu_var_factor mu_var_factor];
        end
    end
    
function dummy = my_rb_init_data_basis(model)
    % only needed for loading the greedy_opt stuff!
    dummy = 0;
    keyboard