BaseSolver.m

Go to the documentation of this file.

namespace solvers{


/* (Autoinserted by mtoc++)
 * This source code has been filtered by the mtoc++ executable,
 * which generates code that can be processed by the doxygen documentation tool.
 *
 * On the other hand, it can neither be interpreted by MATLAB, nor can it be compiled with a C++ compiler.
 * Except for the comments, the function bodies of your M-file functions are untouched.
 * Consequently, the FILTER_SOURCE_FILES doxygen switch (default in our Doxyfile.template) will produce
 * attached source files that are highly readable by humans.
 *
 * Additionally, links in the doxygen generated documentation to the source code of functions and class members refer to
 * the correct locations in the source code browser.
 * However, the line numbers most likely do not correspond to the line numbers in the original MATLAB source files.
 */

class BaseSolver
  :public KerMorObject {
    public: /* ( setObservable ) */

        double MaxStep = "[]";
        double InitialStep = "[]";
        logical RealTimeMode = false;
        dscomponents.AMassMatrix M = "[]";
    public:

        Name = "KerMor BaseSolver class";
        solvers.SolverTypes SolverType = solvers.SolverTypes.Unknown;
    public:

        BaseSolver() {
            this = this@KerMorObject;
            this.registerProps(" MaxStep "," InitialStep "," Name "," RealTimeMode "," SolverType ");
        }

    
    public: /* ( Abstract ) */

        virtual function [rowvect , matrixx ] = solve(odefun,rowvec t,colvec x0) = 0;
        /* % Getter & Setter */
    public:

        
#if 0 //mtoc++: 'set.MaxStep'
function  MaxStep(value) {
            if isempty(value)
                this.MaxStep= value;
                return;
            elseif ~isposrealscalar(value)
                error(" Positive real scalar expected. ");
            elseif value == 0
                error(" Maximum time step must be greater than zero. Use [] to unset. ");
            end
            this.MaxStep= value;
        }

#endif


        
#if 0 //mtoc++: 'set.SolverType'
function  SolverType(value) {
            if ~isa(value," solvers.SolverTypes ")
/*                  error('Solver type must be a solvers.SolverTypes') */
                  value = solvers.SolverTypes.Unknown;
            end
            this.SolverType= value;
        }

#endif


        
#if 0 //mtoc++: 'set.InitialStep'
function  InitialStep(value) {
            if ~isempty(value) && ~isposrealscalar(value)
                error(" Positive real scalar expected. ");
            end
            this.InitialStep= value;
        }

#endif


        
#if 0 //mtoc++: 'set.M'
function  M(value) {
            if ~isempty(value) && ~isa(value," dscomponents.AMassMatrix ")
                error(" Mass matrix must be a dscomponents.AMassMatrix subclass ");
            end
            this.M= value;
        }

#endif

    
    public:

        EVENT StepPerformed;
    public: /* ( Static ) */


        static function res = test_SolverSpeedTest() {
            m = models.synth.KernelTest(200);
            m.ErrorEstimator= [];
            m.offlineGenerations;
            perform(solvers.ExplEuler);
            perform(solvers.MLWrapper(@ode23));
            perform(solvers.MLWrapper(@ode45));
            perform(solvers.Heun);
            perform(solvers.FullyImplEuler(m));

            res = 1;

            function perform(solver)
                m.ODESolver= solver;
                tic;
                r = m.buildReducedModel;
                t = toc;
                fprintf(" Using solver %s (red. model build time %gs)\n ",solver.Name,t);
                ma = ModelAnalyzer(r);
                ma.compareRedFull(r.getRandomParam);
/*                  [~,~,~,t,tr,tr_noerr] = r.getTrajectories;
 *                 fprintf('Online simulations time\nFull detail: %fs\nReduced with error estimator: %fs\nReduced without error estimation:%fs\n\n',t,tr,tr_noerr); */
            end
        }


    
};
}