SummedEI.m

classdef SummedEI < Greedy.Plugin.EICommon
  % Plugin for the Greedy.Algorithm class generating collateral reduced basis
  % space plus interpolation DOFs and a local grid for several different
  % parameterized functions or operators.
  %
  % This can be used for the empirical interpolation of parametrized functions
  % or operator evaluations.

  properties (Dependent)
    % @copybrief Greedy.Plugin.EI.stop_Mmax
    stop_Mmax;
  end

  properties(Constant)
    generated_basis_type = 'ei';
  end

  properties(Access = private)
    ei_container;

    index_map;
  end

  methods
    function seie = SummedEI(varargin)
      % function seie = SummedEI(varargin)
      % constructor "summing together a list of different EI plugin instances.
      %
      % Parameters:
      %   varargin: a list of EI plugin objects of type Greedy.Plugin.EI

      assert(all( cellfun(@(x) isa(x, 'Greedy.Plugin.Interface'), varargin) ));
      assert(all( cellfun(@(x) isequal(x.generated_basis_type, 'ei'), varargin) ));

      seie = seie@Greedy.Plugin.EICommon(varargin{end}.generator);

      seie.ei_container   = varargin;
      idlist              = cellfun(@(x) x.id, varargin, 'UniformOutput', false);
%      seie.index_map      = IdMapDataNodeMap(idlist);
      seie.index_map      = idlist;
      seie.indicator_mode = seie.ei_container{1}.indicator_mode;
      seie.relative_error = seie.ei_container{1}.relative_error;
      seie.use_l2_error   = seie.ei_container{1}.use_l2_error;
    end

    function this = set.stop_Mmax(this, value)
      for i = 1:length(this.ei_container)
        this.ei_container{i}.stop_Mmax = value{i};
      end
    end

    function value = get.stop_Mmax(this)
      value = DataTree.IdMapNode(this.index_map);
      for i = 1:length(this.ei_container)
        set(value, this.ei_container{i}.stop_Mmax);
      end
    end

    function detailed_data = init_basis(this, rmodel, model_data, M_train)
      % function detailed_data = init_basis(this, rmodel, model_data, M_train)
      % @copybrief .Greedy.Plugin.Interface.init_basis()
      %
      % @copydetails Greedy.Plugin.Interface.init_basis()
      %
      % Parameters:
      %   rmodel: of type .Greedy.User.IReducedModel
      %
      % Return values:
      %   detailed_data: of type .Greedy.DataTree.Detailed.IdMapNode
      %
      % This method initializes the detailed data node for all parametrized
      % functions/operator evaluations.
      detailed_data    = Greedy.DataTree.Detailed.IdMapNode(this.index_map);
      for i = 1:length(this.index_map)
        set(detailed_data,i, init_basis(this.ei_container{i}, rmodel, model_data, M_train));
      end
    end

    function prepare_reduced_data(this, rmodel, detailed_data)
      % function prepare_reduced_data(this, rmodel, detailed_data)
      % @copybrief Greedy.Plugin.Interface.prepare_reduced_data()
      %
      % @copydetails Greedy.Plugin.Interface.prepare_reduced_data()
      %
      % Parameters:
      %   rmodel: of type .Greedy.User.IReducedModel
      %   detailed_data: of type .Greedy.DataTree.Detailed.IdMapNode

      prepare_reduced_data(this.ei_container{1}, rmodel, get(detailed_data, 1));
%      for i = 1:length(this.index_map)
%        if this.ei_container{i}.needs_preparation
%          prepare_reduced_data(this.ei_container{i}, rmodel, get(detailed_data,i));
%        end
%      end
    end

    function [max_errs, max_err_sequence, max_mu_index] = error_indicators(this, rmodel, detailed_data, parameter_set, reuse_reduced_data)
      % function [max_errs, max_err_sequence, max_mu_index] = error_indicators(this, rmodel, detailed_data, parameter_set, reuse_reduced_data)
      % this function should never be used. It calls the error_indicators()
      % method for the first wrapped parametrized function/operator.
      %
      % @copydetails .Greedy.Plugin.Default.error_indicators()
      %
      % Parameters:
      %   rmodel: of type Greedy.User.IReducedModel
      %   detailed_data: of type Greedy.DataTree.Detailed.IdMapNode
      if nargin < 5
        reuse_reduced_data = false;
      end
      if nargin < 4
        parameter_set = [];
      end

      warning('RBmatlab:Greedy:Plugin:SummedEI:never_use', 'This function should never be used');
      [max_errs, max_err_sequence, max_mu_index] = error_indicators(this.ei_container{1}, rmodel, get(detailed_data, 1), parameter_set, reuse_reduced_data);
%      max_errs     = DataTree.IdMapNode(this.index_map);
%      max_mu_index = DataTree.IdMapNode(this.index_map);
%      for i = 1:length(this.index_map)
%        [me, mu] = error_indicator(this.ei_container{i}, model, get(detailed_data,i), detailed_gen);
%        set(max_errs,     i, me);
%        set(max_mu_index, i, mu);
%      end
    end

    function errs = compute_error(this, rmodel, reduced_data, detailed_data)
      % function errs = compute_error(this, rmodel, reduced_data, detailed_data)
      % this function should never be used. It calls the compute_error()
      % method for the first wrapped parametrized function/operator.
      %
      % @copydetails .Greedy.Plugin.Default.compute_error()
      %
      % Parameters:
      %   rmodel: of type Greedy.User.IReducedModel
      %   reduced_data: of type Greedy.User.ReducedData
      %   detailed_data: of type Greedy.DataTree.Detailed.IdMapNode

      warning('RBmatlab:Greedy:Plugin:SummedEI:never_use', 'This function should never be used');
      errs = compute_error(this.ei_container{1}, rmodel, reduced_data, get(detailed_data,1));
%      errs = DataTree.IdMapNode(this.index_map);
%      for i = 1:length(this.index_map)
%        err = compute_error(this.ei_container{i}, rmodel, get(detailed_data,i));
%        set(errs, i, err);
%      end
    end

    function Uapprox = generate_reduced(this, rmodel, reduced_data, detailed_data, U)
      % function Uapprox = generate_reduced(this, rmodel, reduced_data, detailed_data)
      % this function should never be used. It calls the generate_reduced()
      % method for the first wrapped parametrized function/operator.
      %
      % @copydetails .Greedy.Plugin.Default.generate_reduced()
      %
      % Parameters:
      %   rmodel: of type Greedy.User.IReducedModel
      %   reduced_data: of type Greedy.User.ReducedData
      %   detailed_data: of type Greedy.DataTree.Detailed.IdMapNode

      warning('RBmatlab:Greedy:Plugin:SummedEI:never_use', 'This function should never be used');
      Uapprox = generate_reduced(this.ei_container{1}, rmodel, reduced_data, get(detailed_data,1));
%      Uapprox = DataTree.IdMapNode(this.index_map);
%      for i = 1:length(this.index_map)
%        Ua = generate_reduced(this.ei_container{i}, rmodel, dummy, get(detailed_data,i));
%        set(Uapprox, i, Ua);
%      end
    end

    function [breakloop, reason] = pre_check_for_end(this, rmodel, detailed_data)
      % function [breakloop, reason] = pre_check_for_end(this, rmodel, detailed_data)
      % @copybrief Greedy.Plugin.Interface.pre_check_for_end()
      %
      % @copydetails Greedy.Plugin.Interface.pre_check_for_end()
      %
      % Parameters:
      %   rmodel: of type .Greedy.User.IReducedModel
      %   detailed_data: of type .Greedy.DataTree.Detailed.IdMapNode
      %
      % This method only stop when ALL parts are ready.
      breakloop = true;
      reason = '';
      for i = 1:length(this.index_map)
        [breakloop_new, reason_new]=pre_check_for_end(this.ei_container{i}, rmodel, get(detailed_data,i));

        breakloop = breakloop & breakloop_new;
        reason = [reason, ' ', reason_new];
      end
    end

    function detailed_data = basis_extension(this, rmodel, detailed_data, max_err_seq, mu)
      % function detailed_data = basis_extension(this, rmodel, detailed_data, max_err_seq, mu)
      % @copybrief Greedy.Plugin.Interface.basis_extension()
      %
      % @copydetails Greedy.Plugin.Interface.basis_extension()
      %
      % Parameters:
      %   rmodel: of type .Greedy.User.IReducedModel
      %   detailed_data: of type .Greedy.DataTree.Detailed.IdMapNode
      %
      % Return values:
      %   detailed_data: of type .Greedy.DataTree.Detailed.IdMapNode

      for i = 1:length(this.ei_container)
        % only update basis spaces if end check is negative
        if ~pre_check_for_end(this.ei_container{i}, rmodel, get(detailed_data,i))
          set( detailed_data,i,...
               basis_extension(this.ei_container{i}, rmodel,...
                               get(detailed_data,i), max_err_seq, mu) );
        end
      end
    end

    function detailed_data = finalize(this, rmodel, detailed_data)
      % function detailed_data = finalize(this, rmodel, detailed_data)
      % @copybrief Greedy.Plugin.Interface.finalize()
      %
      % @copydetails Greedy.Plugin.Interface.finalize()
      %
      % Parameters:
      %   rmodel: of type .Greedy.User.IReducedModel
      %   detailed_data: of type .Greedy.DataTree.Detailed.IdMapNode
      %
      % Return values:
      %   detailed_data: of type .Greedy.DataTree.Detailed.IdMapNode
      for i = 1:length(this.ei_container)
        set( detailed_data, i, ...
             finalize(this.ei_container{i}, rmodel, get(detailed_data, i)) );
      end
      dd1 = get(detailed_data, 1);
      for i = 2:length(this.ei_container)
        dd = get(detailed_data, i);
      end
    end

    function cop = copy(this)
      containercopy = cellfun(@(x) copy(x), this.ei_container, 'UniformOutput', false);
      cop           = SummedEI(containercopy);
    end
  end
end