rk_export.hpp

Go to the documentation of this file.

/*
 *    This file is part of ACADO Toolkit.
 *
 *    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
 *    Copyright (C) 2008-2014 by Boris Houska, Hans Joachim Ferreau,
 *    Milan Vukov, Rien Quirynen, KU Leuven.
 *    Developed within the Optimization in Engineering Center (OPTEC)
 *    under supervision of Moritz Diehl. All rights reserved.
 *
 *    ACADO Toolkit is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 3 of the License, or (at your option) any later version.
 *
 *    ACADO Toolkit 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
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with ACADO Toolkit; if not, write to the Free Software
 *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */



#ifndef ACADO_TOOLKIT_RK_EXPORT_HPP
#define ACADO_TOOLKIT_RK_EXPORT_HPP

#include <acado/code_generation/integrators/integrator_export.hpp>


BEGIN_NAMESPACE_ACADO


class RungeKuttaExport : public IntegratorExport
{
    //
    // PUBLIC MEMBER FUNCTIONS:
    //

    public:

        RungeKuttaExport(       UserInteraction* _userInteraction = 0,
                                                        const std::string& _commonHeaderName = ""
                                                        );

        RungeKuttaExport(       const RungeKuttaExport& arg
                                                        );

        virtual ~RungeKuttaExport( );

                RungeKuttaExport& operator=(    const RungeKuttaExport& arg
                                                                                );


                virtual returnValue setup( ) = 0;


                returnValue initializeButcherTableau( const DMatrix& _AA, const DVector& _bb, const DVector& _cc );


                BooleanType checkSymmetry( const DVector& _cc );


                virtual returnValue setDifferentialEquation( const Expression& rhs ) = 0;


                returnValue setNARXmodel( const uint delay, const DMatrix& parms );


                virtual returnValue getDataDeclarations(        ExportStatementBlock& declarations,
                                                                                                        ExportStruct dataStruct = ACADO_ANY
                                                                                                        ) const = 0;


                virtual returnValue getFunctionDeclarations(    ExportStatementBlock& declarations
                                                                                                                ) const = 0;



                virtual returnValue getCode(    ExportStatementBlock& code
                                                                                ) = 0;
        
        
        uint getNumStages();
                                                        
        
                virtual returnValue setupOutput(  const std::vector<Grid> outputGrids_,
                                                                                  const std::vector<Expression> rhs ) = 0;



        protected:

                virtual returnValue copy(       const RungeKuttaExport& arg
                                                        );


    protected:
        
                ExportVariable rk_kkk;                          
                DMatrix AA;                                                     
                DVector bb, cc;                                         
                BooleanType is_symmetric;                       
                uint numStages;                                         
};


CLOSE_NAMESPACE_ACADO


#endif  // ACADO_TOOLKIT_RK_EXPORT_HPP

// end of file.