MergedSpaceOpEvals.m

classdef MergedSpaceOpEvals < SnapshotsGenerator.SpaceOpEvals
  % this class combines two SnapshotsGenerator.SpaceOpEvals and produces the
  % combination of both operator/function evaluations.
  %
  % The generated snapshots are a concatenation of both underlying generators.
  %
  % Example:
  %   If you have more than one operator in your numerical scheme, for which
  %   you want to create a collateral reduced basis space, you can merge their
  %   space operator evaluation instances together and then create a collateral
  %   reduced basis space valid for all the operators.

  properties (Access = private);

    generator1; % first underlying object of type SnapshotsGenerator.SpaceOpEvals

    generator2; % second underlying object of type SnapshotsGenerator.SpaceOpEvals

  end

  methods
    function sumeidg = MergedSpaceOpEvals(generator1, generator2)
      % function sumeidg = MergedSpaceOpEvals(generator1, generator2)
      % constructor merging two SnapshotsGenerator.SpaceOpEvals objects together.
      %
      % Parameters:
      %   generator1: first space operator evaluation object of type SnapshotsGenerator.SpaceOpEvals.
      %   generator2: second space operator evaluation object of type SnapshotsGenerator.SpaceOpEvals.

      assert(generator1.rb_detailed_generator == generator2.rb_detailed_generator);
      id1 = generator1.id;
      id2 = generator2.id;
      if ~iscell(id1)
        id1 = {id1};
      end
      id = [ id1, id2 ];

      model1 = get_underlying_model(generator1);
      model2 = get_underlying_model(generator2);

      sumeidg = sumeidg@SnapshotsGenerator.SpaceOpEvals(model1, id, ...
                                            generator1.rb_detailed_generator, ...
                                            generator1.ophandle, ...
                                            generator1.force_delete & generator2.force_delete, ...
                                            generator1.enable_caching & generator2.enable_caching);
      assert_model_is_consistent(sumeidg, model1, model2);

      sumeidg.generator1 = generator1;
      sumeidg.generator2 = generator2;
    end

    function combination = plus(this, other)
      % function combination = plus(this, other)
      % convenience function allowing to merge several
      % SnapshotsGenerator.SpaceOpEvals instances together by "adding" them
      % together with a '+' operator.
      %
      % Parameters:
      %   other:  an "addend" of type SnapshotsGenerator.SpaceOpEvals
      %
      % Return values:
      %   combination: the merged object of type SnapshotsGenerator.MergedSpaceOpEvals
      combination = MergedSpaceOpEvals(this, other);
    end

  end
  methods(Access = protected);

    function LU = generate_ei_impl(this, dmodel, detailed_data, U)
      LU = [generate_ei_impl(this.generator1, dmodel, detailed_data, U), ...
            generate_ei_impl(this.generator2, dmodel, detailed_data, U)];
    end
  end

end