DianaSensDAESO.hpp

#ifndef DIANA_SENS_DAESO_H
#define DIANA_SENS_DAESO_H

#include <Basic/DianaBasic.hpp>
#include <Basic/CapeTypes.hpp>
#include <Diana/IDianaSensDAESO.hpp>
#include <Diana/DianaDAESO.hpp>
#include <Diana/DianaUtil.hpp>

namespace Diana{
    using Common::Types::CapeLong;
    using Common::Types::CapeDouble;
    using Common::Types::CapeBoolean;
    using Common::Types::CapeString;
    using Common::Types::CapeArrayDouble;
    using Common::Types::CapeArrayLong;
    using Common::Error::ECapeUnknown;
    using Common::Error::ECapeFailedInitialisation;
    using Common::Error::ECapeBadInvOrder;

    class DianaSensDAESO : virtual public IDianaSensDAESO, virtual public DianaDAESO {
        protected:
            DianaDAESO * model;
                DianaSparseArray::crc_type modelParJacobianCRC;
        public:


        DianaSensDAESO(DianaDAESO * _model,
                       const CapeArrayLong& parIndices,
                           const CapeArrayLong& stateIndices);
        DianaSensDAESO(const DianaSensDAESO& org);

            virtual ~DianaSensDAESO();

        DianaDAESO& GetModel();

            virtual CapeLong GetNumSensParameters() 
                throw (ECapeUnknown, ECapeFailedInitialisation);

            virtual CapeLong GetNumSensInitStates() 
                throw (ECapeUnknown, ECapeFailedInitialisation);
        
        virtual const CapeArrayLong& GetSensParametersIndices() const
                throw (ECapeUnknown, ECapeFailedInitialisation);

            virtual const CapeArrayLong& GetSensInitStatesIndices() const
                throw (ECapeUnknown, ECapeFailedInitialisation);

            virtual const CapeArrayDouble& GetSensParameters() const
                throw (ECapeUnknown, ECapeFailedInitialisation);

            virtual void SetSensParameters(const Common::Types::CapeArrayDouble& pars)
                throw (ECapeUnknown, ECapeFailedInitialisation);

            virtual const DianaSparseArray& GetSensParJacobianValues()
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl);

            virtual const CapeArrayDouble& GetSensInitStates()
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation);

            virtual void SetSensInitStates(const Common::Types::CapeArrayDouble& states)
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation);

            virtual Common::Types::CapeArrayDouble GetAllModelVariables();

        virtual void SetAllModelVariables(const Common::Types::CapeArrayDouble& vars);

        virtual Common::Types::CapeArrayDouble GetAllModelDerivatives();

    
            virtual void SetAllModelDerivatives(const Common::Types::CapeArrayDouble& vars);

        virtual const CapeArrayDouble& GetAllModelResiduals() 
            throw (ECapeUnknown, ECapeBadInvOrder, ECapeFailedInitialisation) ;

        virtual const DianaSparseArray& GetAllModelJacobianValues() const 
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl);
        
        virtual const Diana::DianaSparseArray& GetAllModelDiffJacobianValues() const
                 throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl);
                        
            virtual Common::Types::CapeArrayDouble GetAllSensitivities();

    
            virtual void SetAllSensitivities(const Common::Types::CapeArrayDouble& vars);

    

        virtual void Initialize()
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation,
                 Common::Error::ECapeOutOfResources, Common::Error::ECapeLicenceError,
                 Common::Error::ECapeBadInvOrder);

        virtual void Terminate()
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources,
                 Common::Error::ECapeBadInvOrder);
    
        virtual void SetFixedVariables(const Common::Types::CapeArrayLong& varIndices,
                           const Common::Types::CapeArrayDouble& varValues)
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds,
                 Common::Error::ECapeNoImpl);

        virtual void SetAllVariables(const Common::Types::CapeArrayDouble& varValues)
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds);

        virtual void SetVariables(const Common::Types::CapeArrayLong& varIndices,
                      const Common::Types::CapeArrayDouble& varValues)
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds);

        virtual const Common::Types::CapeArrayDouble& GetAllVariables()
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder);

        virtual Common::Types::CapeArrayDouble GetVariables(const Common::Types::CapeArrayLong& varIndices)
            throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds);

        virtual const Common::Types::CapeArrayDouble& GetAllResiduals()
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder,
                 Common::Error::ECapeFailedInitialisation);

        virtual const Diana::DianaSparseArray& GetJacobianStruct()
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl);

        virtual const Diana::DianaSparseArray& GetAllJacobianValues()
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl);

        virtual void SetVariablesIndex(const Common::Types::CapeArrayLong& varIndexes)
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeOutOfBounds, Common::Error::ECapeNoImpl);

        virtual const Common::Types::CapeArrayDouble& GetLowerBounds()
            throw (Common::Error::ECapeUnknown);

        virtual const Common::Types::CapeArrayDouble& GetUpperBounds()
                throw (Common::Error::ECapeUnknown);

        virtual void SetAllDerivatives(const Common::Types::CapeArrayDouble& varValues)
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
             Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds);

        virtual const Common::Types::CapeArrayDouble& GetAllDerivatives()
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder);

        virtual Common::Types::CapeArrayDouble GetDerivatives(const Common::Types::CapeArrayLong& varIndices)
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
             Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds);

        virtual void SetDerivatives(const Common::Types::CapeArrayLong& varIndices,
                            const Common::Types::CapeArrayDouble& varValues)
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds);

        virtual const Diana::DianaSparseArray& GetDiffJacobianStruct() 
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl);

        virtual const Diana::DianaSparseArray& GetAllDiffJacobianValues()
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl);


        virtual void SetIndependentVar(Common::Types::CapeDouble indVar)
                throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

        virtual Common::Types::CapeDouble GetIndependentVar()
                throw (Common::Error::ECapeUnknown);

        virtual void setChangedFlags(DianaVariableType bChanged);

    protected:
        CapeArrayLong       modelJacIndices;
        const CapeArrayLong sensParameterIndices;    
        CapeArrayLong       sensParameterMap;        
        DianaSparseArray    mtrValuesSensParJacobi;  
        CapeBoolean         bValuesSensParJacobiChanged;
        const CapeArrayLong sensInitStateIndices;    
        CapeLong            nSensInitStates;         
        CapeLong            nSensParameters;         

            CapeLong            nSensitivities;            
            CapeLong            nModelStates;
            CapeLong            nModelEqns;
            CapeArrayDouble     arrSensInitStates; 
            CapeArrayDouble     arrSensParameters; 
            CapeDouble *        pSensitivities;  

        virtual void calculateResiduals() ;

        virtual void calculateModelResiduals();
        virtual void calculateSensResiduals();

        virtual void initializeJacobis();
            virtual void initializeCollections();
        
        virtual DianaDAESO* createClone();
            /*
        CapeBoolean calculateFDJacobiMatrixPartition(enumJacobianType type);
        CapeBoolean calculateFDJacobiMatrixSimple(enumJacobianType type);
        */
            void setupModelJacIndices();

  };

};

#endif // DIANA_SENS_DAESO_H