IDetailedData.m

classdef IDetailedData < handle
  % Interface class for the generation and storage of reduced basis spaces as
  % described in @ref basisgen "Module (M2)"
  %

  properties

    % struct of type BasisGenDescr describing how the basis shall be generated.
    %
    % The fields in this structure usually override the default values of the
    % used IDetailedData object. See gen_reduced_model() for more details.
    bg_descr;

    % struct of type ModelData holding `H`-dimensional model data, which is
    % needed for an IDetailedModel.detailed_simulation(), e.g. a grid object.
    model_data;

  end

  methods
    function ddi = IDetailedData(bg_descr, model_data)
      % function ddi = IDetailedData(bg_descr, model_data)
      % constructor generating the reduced basis spaces
      %
      % It overwrites all properties of the IDetailedData implementation with
      % values given in the BasisGenDescr structure.
      %
      % Parameters:
      %   bg_descr: struct of type BasisGenDescr
      ddi.model_data = model_data;
      ddi.bg_descr   = bg_descr;

      % consistency check:
      this_fields = properties(ddi);
      descr_fields = setdiff(fieldnames(bg_descr), ...
        {'detailed_data_constructor', 'reduced_data_constructor', 'rmodel_constructor', ...
         'rb_problem_type'});
      intersect_fields = intersect(descr_fields, this_fields);

      for i = 1:length(intersect_fields)
        ddi.(intersect_fields{i}) = bg_descr.(intersect_fields{i});
      end

      unused_fields = setdiff(descr_fields, this_fields);
      if ~isempty(unused_fields) && 1 == 0
        warning('RBmatlab:IDetailedData:Consistency', ...
          ['The fields ', evalc('unused_fields'), ...
          ' are unused by IDetailedData implementation']);
      end
    end

    function ret = subsref(this, S)
      % function ret = subsref(this, S)
      % forwarding of fieldnames access to the underlying model_data struct
      %
      % If the user calls 'detailed_data.parameter' and the field 'parameter' exists
      % in the underlying 'model_data' structure, the value of
      % 'model_data.parameter' is returned. This method is implemented for
      % compatibility reasons, such that a basis generation object can be used
      % like an old model. Try to prevent usage of this method in the future.
      %
      % @note that this method throws a 'RBmatlab:Compatibility' warning if a
      % description field is accessed.

      thissubs = [properties(this); methods(this)];
      fns = setdiff(fieldnames(this.model_data), thissubs);
      if S(1).type(1) == '.' ...
         && ~isempty(intersect(fns, S(1).subs))
        warning('RBmatlab:Compatibility', ...
          ['Requesting the model_data field ''', S(1).subs, ...
           '''\nfrom a IDetailedData object! Maybe you should\n',...
           'substitute the ''detailed_data'' by a ''detailed_data.model_data''']);
        ret = this.model_data.(S(1).subs);
      else
        ret = builtin('subsref', this, S);
      end
    end
  end

  methods(Abstract)
    % function rb_size = get_rb_size(this, rmodel)
    % returns the dimension of the stored reduced basis space.
    %
    % Parameters:
    %   rmodel: model of type IReducedModel specifying which basis space
    %           dimension shall be returned in case different spaces have been
    %           generated different parameters, time intervals or variables. In
    %           most implementations this parameter is unused.
    rb_size = get_rb_size(this, rmodel);
  end

end