FVDetailedModelDefault.m

classdef FVDetailedModelDefault < Greedy.User.IDetailedModel
  % Interface specialization of an IDetailedModel ready to use with Greedy
  % algorithms for (time dependent) @ref fv discretizations.
  %

  properties (Constant)

  end
  methods
    function rbmdmed = FVDetailedModelDefault(descr)
      % function rbmdmed = IDetailedModel(descr)
      % Constructor for this class
      %
      rbmdmed = rbmdmed@Greedy.User.IDetailedModel(descr);

      if ~isfield(descr, 'init_values_algorithm')
        rbmdmed.descr.init_values_algorithm = @fv_init_values;
      end
      if ~isfield(descr, 'inner_product_matrix_algorithm')
        rbmdmed.descr.inner_product_matrix_algorithm = @fv_inner_product_matrix;
      end

    end

    function UON          = orthonormalize(this, model_data, U)
      % function UON          = orthonormalize(model, model_data, U)
      % @copybrief GreedyUser::IDetailedModelorthonormalize()
      %
      % @copydetails GreedyUser::IDetailedModelorthonormalize()
      %
      % This implements an orthonormalization with help of the QR method.

      %      UON = model.orthonormalize(model, model_data, U, eps);
      UON = model_orthonormalize_qr(this.descr, model_data, U, 1e-10);
    end

    function U0           = init_values_algorithm(dmodel, model_data)
      % function UO          = init_values_algorithm(model, model_data)
      % @copybrief GreedyUser::IDetailedModelinit_values_algorithm()
      %
      % @copydetails GreedyUser::IDetailedModelinit_values_algorithm()
      %
      % This calls the function pointer defined in the #descr structure field
      % 'init_values_algorithm'.
      U0  = dmodel.descr.init_values_algorithm(dmodel.descr, model_data);
    end

    function UV           = inner_product(this, model_data, U, V)
      % function UV           = inner_product(this, model_data, U, V)
      % @copybrief Greedy.User.IDetailedModel.inner_product()
      %
      % @copydetails Greedy.User.IDetailedModel.inner_product()
      %
      % This uses the 'W'=get_inner_product_matrix() method in order to compute
      % the inner product `\langle u_h, v_h \rangle = U' W V`
      W = Greedy.User.FVDetailedModelDefault.get_inner_product_matrix(model_data);
      UV = U' * W * V;
    end

  end

  methods(Static)
    function errs         = l2_error_sequence_algorithm(U, Uapprox, model_data)
      % function errs         = l2_error_sequence_algorithm(U, Uapprox, model_data)
      % @copybrief GreedyUser::IDetailedModell2_error_sequence_algorithm()
      %
      % @copydetails GreedyUser::IDetailedModell2_error_sequence_algorithm()
      %
      % This function calls fv_l2_error()
      errs = fv_l2_error(U, Uapprox, Greedy.User.FVDetailedModelDefault.get_inner_product_matrix(model_data));
    end

    function errs         = linfty_error_sequence_algorithm(U, Uapprox, model_data)
      % function errs         = linfty_error_sequence_algorithm(U, Uapprox, model_data)
      % @copybrief GreedyUser::IDetailedModellinfty_error_sequence_algorithm()
      %
      % @copydetails GreedyUser::IDetailedModellinfty_error_sequence_algorithm()
      %
      % This function calls fv_linfty_error();
      errs = fv_linfty_error(U, Uapprox, []);
    end

    function W            = get_inner_product_matrix(model_data)
      % function W            = get_inner_product_matrix(model_data)
      % @copybrief GreedyUser::IDetailedModelget_inner_product_matrix()
      %
      % @copydetails GreedyUser::IDetailedModelget_inner_product_matrix()
      %
      % Required fields of model_data:
      %   W:     the inner product matrix
      % This function returns the inner product matrix stored in 'model_data'
      W = model_data.W;
    end

  end

end