IReducedModel.m

classdef IReducedModel < IReducedModel
  % interface specialization for a reduced model that can be used with the
  % Greedy algorithm for basis generation.

  methods
    function rm = IReducedModel(dmodel, bg_descr)
      % function rm = IReducedModel(dmodel, bg_descr)
      % constructor for this reduced model interface
      %
      % This constructor is forwarded to the IReducedModel base class.
      if nargin == 1
        bg_descr = [];
      end
      rm = rm@IReducedModel(dmodel, bg_descr);
    end

    function reduced_data = gen_reduced_data(rmodel, detailed_data)
      % function reduced_data = gen_reduced_data(rmodel, detailed_data)
      % @copybrief .IReducedModel.gen_reduced_data()
      %
      % @copydetails .IReducedModel.gen_reduced_data()
      %
      % This method creates a Greedy.User.ReducedData object with a DataTree
      % whose leafs are generated by
      % 'rmodel.bg_descr.reduced_data_constructor'.
      %
      % Parameters:
      %   detailed_data: of type Greedy.User.IDetailedData
      %   rmodel: of type Greedy.User.IReducedModel
      %
      % Return values:
      %   reduced_data: of type Greedy.User.ReducedData

      reduced_data = Greedy.User.ReducedData(rmodel, detailed_data);
    end

%    function set_M_on_tree(this, datatree)

%      tree_mode = isa(rmodel.M, 'DataTree.INode');
%      tree_descr = get_leaf_description(datatree);
%      for leaf_descr = tree_descr
%        leaf = get(datatree, leaf_descr.basepath);
%        if tree_mode
%          leaf.M = 
%      end
%    end

  end

  methods

    function rb_sim_data = rb_simulation(rmodel, reduced_data)
      % function rb_sim_data = rb_simulation(rmodel, reduced_data)
      % forwards the reduced simulation to the method rb_simulation_impl()
      % after getting a suitable reduced data leaf element.
      %
      % @copydetails .IReducedModel.rb_simulation()
      %
      % Parameters:
      %   reduced_data: of type Greedy.User.ReducedData
      %
      reduced_data_leaf = get_leaf(reduced_data, rmodel);
      rb_sim_data = rb_simulation_impl(rmodel, reduced_data_leaf);
    end

  end

  methods (Abstract)

    % function rb_sim_data = rb_simulation_impl(rmodel, reduced_data)
    % implementation of the reduced simulation
    %
    % Parameters:
    %   reduced_data: of type Greedy.User.IReducedDataNode
    %
    % Return values:
    %   rb_sim_data: structure holding the coefficient vectors of the reduced
    %                simulations and optional error estimators.
    rb_sim_data = rb_simulation_impl(rmodel, reduced_data);
  end
end