linear_ode_solver.hh

Go to the documentation of this file.

/*!
 *
 * Copyright (C) 2015 Technical University of Liberec.  All rights reserved.
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License version 3 as published by the
 * Free Software Foundation. (http://www.gnu.org/licenses/gpl-3.0.en.html)
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 *
 * 
 * @file    linear_ode_solver.hh
 * @brief   
 */

#ifndef LINEAR_ODE_SOLVER_H_
#define LINEAR_ODE_SOLVER_H_

#include "armadillo"
#include "input/accessors.hh"


/// @brief Base class for linear ODE solver.
/** This class represents an interface to a solver of a system of linear ordinary differential 
 *  equations with constant coefficients.
 */
class LinearODESolverBase
{
public:
    /**
     * Abstract record for the linear ODE solver.
     */
    static Input::Type::Abstract & get_input_type();
    
    LinearODESolverBase();
    virtual ~LinearODESolverBase();
    
    void set_system_matrix(const arma::mat &matrix);  ///< Sets the matrix of ODE system.
    void set_step(double step);                 ///< Sets the step of the numerical method.
    
    /// Updates solution of the ODEs system.
    /**
     * @param init_vec is the column initial vector
     * @param output_vec is the column output vector containing the result
     */
    virtual void update_solution(arma::vec &init_vec, arma::vec &output_vec) = 0;
    
    /// Updates solution of the system with different initial vectors.
    /**
     * Column initial @p init_vecs and output @p output_vecs vectors are grouped in the matrices.
     * Parameter @p mask can be used to skip some of the vectors.
     */
    virtual void update_solution(arma::mat &init_vecs, arma::mat &output_vecs, 
                                 const std::vector<unsigned int> &mask = std::vector<unsigned int>(0)) = 0;
    
    /// Estimate upper bound for time step. Return true if constraint was set.
    virtual bool evaluate_time_constraint(double &time_constraint) = 0;
                                 
protected:
    arma::mat system_matrix_;     ///< the square matrix of ODE system
    arma::vec rhs_;               ///< the column vector of RHS values (not used currently)
    double step_;           ///< the step of the numerical method
    bool step_changed_;     ///< flag is true if the step has been changed
    bool system_matrix_changed_; ///< Indicates that the system_matrix_ was recently updated.
};


/** @brief Template class of the linear ODE solver.
 * 
 * It provides a common method @p update_solution which can compute the same system of ODEs with 
 * different initial vectors at once.
 * 
 * This class represents the Curiously Recurring Template Pattern (CRTP). Therefore, the method update_solution
 * of the template called inside @p update_solution using static_cast is not a virtual one.
 * 
 */
template<class Method>
class LinearODESolver : public LinearODESolverBase
{   
public:
    LinearODESolver(){};
    virtual ~LinearODESolver(){};
    
    /// Updates solution of the system with different initial vectors.
    /**
     * See the base class member documentation.
     */
    virtual void update_solution(arma::mat &init_vecs, arma::mat &output_vecs, 
                         const std::vector<unsigned int> &mask = std::vector<unsigned int>(0)) override;
    
private:
};

template<class Method>
void LinearODESolver<Method>::update_solution(arma::mat& init_vecs, arma::mat& output_vecs, const std::vector< unsigned int > &mask)
{  
    OLD_ASSERT(0,"Not implemented yet.");
    OLD_ASSERT_EQUAL(init_vecs.n_cols, output_vecs.n_cols);
    OLD_ASSERT_EQUAL(init_vecs.n_rows, output_vecs.n_rows);
    
    for(unsigned int j=0; j < init_vecs.n_cols; j++)
    {
        //static_cast<Method*>(this)->update_solution(init_vecs.col(j), output_vecs.col(j));
    }
}

#endif // LINEAR_ODE_SOLVER_H_