irk_lifted_forward_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_LIFTED_IRK_FORWARD_EXPORT_HPP
#define ACADO_TOOLKIT_LIFTED_IRK_FORWARD_EXPORT_HPP

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


BEGIN_NAMESPACE_ACADO

class ForwardLiftedIRKExport : public ForwardIRKExport
{
    //
    // PUBLIC MEMBER FUNCTIONS:
    //

    public:

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

        ForwardLiftedIRKExport( const ForwardLiftedIRKExport& arg
                                                        );

        virtual ~ForwardLiftedIRKExport( );


                ForwardLiftedIRKExport& operator=(      const ForwardLiftedIRKExport& arg
                                                                                );


                virtual returnValue setup( );


                virtual returnValue setDifferentialEquation( const Expression& rhs );
        

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


                virtual returnValue getFunctionDeclarations(    ExportStatementBlock& declarations
                                                                                                                ) const;



                virtual returnValue getCode(    ExportStatementBlock& code
                                                                                );


        protected:


                virtual returnValue prepareInputSystem( ExportStatementBlock& code );


                virtual returnValue prepareOutputSystem( ExportStatementBlock& code );


                virtual returnValue solveImplicitSystem(        ExportStatementBlock* block,
                                                                                        const ExportIndex& index1,
                                                                                        const ExportIndex& index2,
                                                                                        const ExportIndex& index3,
                                                                                        const ExportIndex& tmp_index,
                                                                                        const ExportIndex& k_index,
                                                                                        const ExportVariable& Ah,
                                                                                        const ExportVariable& C,
                                                                                        const ExportVariable& det,
                                                                                        bool DERIVATIVES = false );


                virtual returnValue evaluateInexactMatrix(      ExportStatementBlock* block,
                                                                                const ExportIndex& index1,
                                                                                const ExportIndex& index2,
                                                                                const ExportIndex& tmp_index,
                                                                                const ExportIndex& k_index,
                                                                                const ExportVariable& _rk_A,
                                                                                const ExportVariable& Ah,
                                                                                const ExportVariable& C,
                                                                                bool evaluateB,
                                                                                bool DERIVATIVES );


                virtual returnValue sensitivitiesInputSystem(   ExportStatementBlock* block,
                                                                                                                const ExportIndex& index1,
                                                                                                                const ExportIndex& index2,
                                                                                                                const ExportVariable& Bh,
                                                                                                                bool STATES     );


                virtual returnValue evaluateRhsInexactSensitivities(    ExportStatementBlock* block,
                                                                                                        const ExportIndex& index1,
                                                                                                        const ExportIndex& index2,
                                                                                                        const ExportIndex& index3,
                                                                                                        const ExportIndex& tmp_index1,
                                                                                                        const ExportIndex& tmp_index2,
                                                                                                        const ExportIndex& tmp_index3,
                                                                                                        const ExportIndex& k_index,
                                                                                                        const ExportVariable& Ah );


                virtual returnValue evaluateAllStatesImplicitSystem(    ExportStatementBlock* block,
                                                                                        const ExportIndex& k_index,
                                                                                        const ExportVariable& Ah,
                                                                                        const ExportVariable& C,
                                                                                        const ExportIndex& stage,
                                                                                        const ExportIndex& i,
                                                                                        const ExportIndex& tmp_index );


                virtual returnValue evaluateStatesImplicitSystem(       ExportStatementBlock* block,
                                                                                        const ExportIndex& k_index,
                                                                                        const ExportVariable& Ah,
                                                                                        const ExportVariable& C,
                                                                                        const ExportIndex& stage,
                                                                                        const ExportIndex& i,
                                                                                        const ExportIndex& tmp_index );


                virtual returnValue evaluateRhsImplicitSystem(  ExportStatementBlock* block,
                                                                                                                const ExportIndex& k_index,
                                                                                                                const ExportIndex& stage );


                virtual returnValue allSensitivitiesImplicitSystem(     ExportStatementBlock* block,
                                                                                                        const ExportIndex& index1,
                                                                                                        const ExportIndex& index2,
                                                                                                        const ExportIndex& index3,
                                                                                                        const ExportIndex& tmp_index1,
                                                                                                        const ExportIndex& tmp_index2,
                                                                                                        const ExportIndex& tmp_index3,
                                                                                                        const ExportIndex& k_index,
                                                                                                        const ExportVariable& Bh,
                                                                                                        bool update );


                virtual returnValue evaluateRhsSensitivities(   ExportStatementBlock* block,
                                                                                                        const ExportIndex& index1,
                                                                                                        const ExportIndex& index2,
                                                                                                        const ExportIndex& index3,
                                                                                                        const ExportIndex& tmp_index1,
                                                                                                        const ExportIndex& tmp_index2 );


                virtual returnValue updateImplicitSystem(       ExportStatementBlock* block,
                                                                                                        const ExportIndex& index1,
                                                                                                        const ExportIndex& index2,
                                                                                                        const ExportIndex& tmp_index    );


                virtual returnValue sensitivitiesOutputSystem(  ExportStatementBlock* block,
                                                                                                const ExportIndex& index1,
                                                                                                const ExportIndex& index2,
                                                                                                const ExportIndex& index3,
                                                                                                const ExportIndex& index4,
                                                                                                const ExportIndex& tmp_index1,
                                                                                                const ExportIndex& tmp_index2,
                                                                                                const ExportVariable& Ah,
                                                                                                const ExportVariable& Bh,
                                                                                                bool STATES,
                                                                                                uint number             );


                returnValue sensitivitiesOutputs(       ExportStatementBlock* block,
                                                                                        const ExportIndex& index0,
                                                                                        const ExportIndex& index1,
                                                                                        const ExportIndex& index2,
                                                                                        const ExportIndex& tmp_index1,
                                                                                        const ExportIndex& tmp_index2,
                                                                                        const ExportIndex& tmp_index3,
                                                                                        const ExportVariable& tmp_meas,
                                                                                        const ExportVariable& time_tmp,
                                                                                        bool STATES,
                                                                                        uint base                       );


                virtual returnValue propagateOutputs(   ExportStatementBlock* block,
                                                                                                const ExportIndex& index,
                                                                                                const ExportIndex& index0,
                                                                                                const ExportIndex& index1,
                                                                                                const ExportIndex& index2,
                                                                                                const ExportIndex& index3,
                                                                                                const ExportIndex& tmp_index1,
                                                                                                const ExportIndex& tmp_index2,
                                                                                                const ExportIndex& tmp_index3,
                                                                                                const ExportIndex& tmp_index4,
                                                                                                const ExportVariable& tmp_meas );


                ExportVariable getAuxVariable() const;


    protected:

                ExportAcadoFunction forward_sweep;              
                ExportAcadoFunction adjoint_sweep;              
                ExportVariable  rk_b_trans;
                ExportVariable  rk_adj_traj;                    
                ExportVariable  rk_adj_diffs_tmp;
                ExportVariable  rk_seed2;
                ExportVariable  rk_xxx_traj;                    
                ExportVariable  rk_diffSweep;
                ExportVariable  rk_I;

                ExportVariable  rk_seed;                                
                ExportVariable  rk_stageValues;                 
                ExportVariable  rk_Xprev;                               
                ExportVariable  rk_Uprev;                               
                ExportVariable  rk_delta;                               
                ExportVariable  rk_xxx_lin;
                ExportVariable  rk_Khat_traj;
                ExportVariable  rk_Xhat_traj;

                ExportVariable  rk_diffK_local;

};


CLOSE_NAMESPACE_ACADO


#endif  // ACADO_TOOLKIT_LIFTED_IRK_FORWARD_EXPORT_HPP

// end of file.