rbasis/basisgen/+Greedy/Combined.m

classdef Combined < Greedy.Interface
  % combines two or more instances of a Greedy.Interface class by executing
  % them subsequently.

  properties (SetAccess = private, Dependent)
    generated_basis_type;

    id;
  end

  properties (Access = private)
    container;

    idmap;
  end

  methods

    function cbg = Combined(varargin)
      % function cbg = Combined(varargin)
      % constructor storing the Greedy.Interface instances to be combined.
      %
      % Parameters:
      %   varargin: a list of greedy algorithm instances of type Greedy.Interface
      cbg.container = varargin;
      idm           = cell(1, length(varargin));
      for i = 1:length(idm)
        idm{i} = varargin{i}.id;
      end
      cbg.idmap     = idm;
      cbg.generated_basis_type;
    end

    function generated_type = get.generated_basis_type(this)
      if all(cellfun(@(x) isequal(x.generated_basis_type, 'ei'), this.container))
        generated_type = 'ei';
      elseif all(cellfun(@(x) isequal(x.generated_basis_type, 'rb'), this.container))
        generated_type = 'rb';
      elseif length(this.container) == 2 ...
          && isequal(get_generated_basis_type(this.container{1}), 'ei') ...
          && isequal(this.container{2}.generated_basis_type, 'rb')
        generated_type = 'eirb';
      else
        error('Unsupported combination of basis generation algorithms! You can combine only EI or only RB generations, or _one_ EI with _one_ RB');
      end
    end

%    function [max_errs, max_err_seq, max_mu_index] = error_indicators(this, detailed_data, parameter_set, reuse_reduced_data)
%      if nargin < 4
%        reuse_reduced_data = false;
%      end
%      if nargin < 3
%        parameter_set = [];
%      end
%      if isequal(generated_type, 'eirb')
%        [max_errs, max_err_seq, max_mu_index] = error_indicators(this.container{2}, detailed_data, parameter_set, reuse_reduced_data);
%      elseif isequal(generated_type, 'ei')
%        max_errs     = DataTree.IdMapNode(this.idmap);
%        max_err_seqs = DataTree.IdMapNode(this.idmap);
%        max_mu_index = DataTree.IdMapNode(this.idmap);
%        parameters   = DataTree.IdMapNode(this.idmap, parameter_set);
%
%        for i = 1:length(this.idmap)
%          [me, mes, mu] = error_indicators(this.container{i}, get(detailed_data, i), ...
%                                      get(parameters,i));
%          set(max_errs,     i, me);
%          set(max_err_seqs, i, mes);
%          set(max_mu_index, i, mu);
%        end
%
%      end
%    end

    function id = get.id(this)
      id = this.idmap;
    end

    function prepare(this, rmodel, model_data)
      for i=1:length(this.container)
        prepare(this.container{i}, rmodel, model_data);
      end
    end

    function detailed_data = init_basis(this, rmodel, model_data)
      % function detailed_data = init_basis(this, rmodel, model_data)
      % @copybrief Greedy.Interface.init_basis()
      %
      % @copydoc Greedy.Interface.init_basis()
      %
      % Parameters:
      %   rmodel: of type Greedy.User.IReducedModel
      if isequal(this.generated_basis_type, 'eirb')
        detailed_data    = Greedy.DataTree.Detailed.IdMapNode({'ei', 'rb'});
        set(detailed_data, 1, init_basis(this.container{1}, rmodel, model_data));
        ddrb = init_basis(this.container{2}, rmodel, model_data);

        tree_descr = get_leaf_description(ddrb);
        for leaf_descr = tree_descr
          dd_rb_leaf = get(ddrb, leaf_descr.basepath);

          dd_podei_leaf            = Greedy.DataTree.Detailed.PODEILeafNode(model_data, false);
%          dd_podei_leaf.fields     = dd_rb_leaf.fields;
%          dd_podei_leaf.stop_flags = dd_rb_leaf.stop_flags;
%          dd_rb_leaf.fields        = [];
%          dd_rb_leaf.stop_flags    = [];

          dd_podei_leaf.rb = dd_rb_leaf;
          % TODO: extract the subtree that fits to the rb_leaf...?
          dd_podei_leaf.ei = get(detailed_data, 1);
          if ~isempty(leaf_descr.basepath)
            set(ddrb, leaf_descr.basepath, dd_podei_leaf);
          else
            ddrb = dd_podei_leaf;
          end
        end

        set(detailed_data, 2, ddrb);
        return;
      elseif isequal(this.generated_basis_type, 'ei')
%        index_map     = cellfun(@(x) x.detailed_extension.id, this.container, 'UniformOutput', false);
        detailed_data = Greedy.DataTree.Detailed.IdMapNode(this.idmap);
      else % generate several rb spaces subsequently
        error('It is not supported yet to generate several RB spaces subsequently.');
      end
      for i=1:length(this.container)
        set(detailed_data, i, init_basis(this.container{i}, rmodel, model_data));
      end
    end

    function detailed_data = basis_extension(this, rmodel, detailed_data, checkpoint)
      % function detailed_data = basis_extension(this, rmodel, detailed_data, checkpoint)
      % @copybrief Greedy.Interface.basis_extension()
      %
      % @copydetails Greedy.Interface.basis_extension()
      %
      % Parameters:
      %   rmodel: of type Greedy.User.IReducedModel
      %   detailed_data: of type Greedy.User.IDetailedData
      idname = DataTree.IdMapNode.name_from_idmap(this.idmap);
      if nargin == 2
        checkpoint = Greedy.Checkpoint;
      end
      if isequal(this.generated_basis_type, 'eirb')
        if ~get(checkpoint, 'ei_computed', false)
          set(detailed_data, 1,...
              basis_extension(this.container{1}, rmodel, ...
                              get(detailed_data,1), checkpoint.child(1) )...
             );
        end
        checkpoint = checkpoint.store(rmodel, detailed_data, idname, struct('ei_computed', true));

        set(detailed_data, 2,...
            basis_extension(this.container{2}, rmodel, ...
                            get(detailed_data,2), checkpoint.child(2) )...
           );
      else
        ei_start = get(checkpoint, 'ei_ei_start', 1);
        for i=ei_start:length(this.container)
          set(detailed_data, i, ...
              basis_extension(this.container{i}, rmodel, ...
                              get(detailed_data,i), checkpoint.child(i) )...
             );
          checkpoint = checkpoint.store(rmodel, detailed_data, idname, struct('ei_ei_start', i+1));
        end
      end
    end

    function rb_basis_gen = get_rb_basis_generator(this)
      % function rb_basis_gen = get_rb_basis_generator(this)
      % returns the snapshot generator for the reduced basis construction
      %
      % Return values:
      %   rb_basis_gen: snapshot generator of type SnapshotsGenerator.Cached
      if isequal(this.generated_basis_type, 'eirb')
        rb_basis_gen = this.container{2};
      else
        rb_basis_gen = [];
      end
    end

    function rb_basis_gen = get_ei_basis_generator(this)
      % function rb_basis_gen = get_ei_basis_generator(this)
      % returns the snapshot generator for the reduced basis construction
      %
      % Return values:
      %   rb_basis_gen: snapshot generator of type SnapshotsGenerator.Cached
      if isequal(this.generated_basis_type, 'eirb')
        rb_basis_gen = this.container{1};
      else
        rb_basis_gen = [];
      end
    end
  end
end