Model.m

classdef Model < handle & matlab.mixin.Copyable
% MODEL Abstract model class
%
%     This class represents abstract RB problems that define common
%     interfaces. 
%
% Andreas Schmidt, 2016

    properties(Abstract)
        mu;
        mu_names;
        mu_ranges;
    end

    methods(Abstract)
        % DETAILED_SIMULATION
        %     The function DETAILED_SIMULATION returns an instance of
        %     SimData and 
        dsim = detailed_simulation(model, model_data);
        
        % REDUCED_SIMULATION
        %     This function should return a reduced simulation of type
        %     RBSimData
        rsim = rb_simulation(model, reduced_data);   
    end
    
    methods
        % Note: All of the following methods can be redefined by the
        % subclasses and completely customized to fit the needs of your
        % model!
        
        % GEN_MODEL_DATA
        %     Use this function in order to create a class of type
        %     ModelData which contains all the large-scale model data such
        %     as the discretized operators
        function model_data = gen_model_data(this)
            model_data = eval([this.problem_type(), '.ModelData(this)']);
        end
        
        % GEN_DETAILED_DATA
        %     Call the basis generation algorithm.
        function detailed_data = gen_detailed_data(this, model_data)
            detailed_data = eval([this.problem_type(), '.DetailedData(this, model_data)']);
        end
        
        % GEN_REDUCED_DATA
        %     Get the reduced data structures
        function reduced_data = gen_reduced_data(this, detailed_data)
            reduced_data = eval([this.problem_type(), '.ReducedData(this, detailed_data)']);
        end
        
        % PROBLEM_TYPE
        %    Use this function to determine the problem type. So consider
        %    overwriting it if necessary!
        function pt = problem_type(this)
            % TODO: implement a smart interface that automatically
            % generates the correct 
            c = class(this);
            if isempty(find(c=='.'))
               warning('Consider reimplementing problem_type method in class %s as the return value might be incorrect', c);
               pt = c;
            else
               pt = c(1:max(find(c=='.')-1));
            end
        end
    end
    
    % =====================================================================
    % Standard functions
    methods
  
        function mu = get_mu(this)
            % Get the parameter values
            mu = this.mu;
        end
        
        function this = set_mu(this, mu)
            % Set the parameter values
            if length(mu) ~= length(this.mu_names)
                error('Mu length wrong. This model expects %d parameters: %s', length(this.mu_names), strjoin(this.mu_names,', '));
            end
            
            % Validate the parameter ranges
            for i = 1:length(mu)
                if mu(i) < this.mu_ranges{i}(1) || mu(i) > this.mu_ranges{i}(2)
                    error('The value for the parameter %s is wrong. The valid range is [%f, %f].\n', ...
                        this.mu_names{i}, this.mu_ranges{i}(1), this.mu_ranges{i}(2))
                end
            end
            
            this.mu = mu;
        end
        
    end
    
end