IDianaSensDAESO.hpp

/* -----------------------------------------------------------------------------
*/
#ifndef IDIANA_SENS_DAESO_H
#define IDIANA_SENS_DAESO_H

#include <CapeOpen.hpp>
#include <Diana/IDianaDAESO.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 IDianaSensDAESO : virtual public IDianaDAESO {
    public:
        virtual ~IDianaSensDAESO() {};

        // TODO: Decide this function is needed for interface
        //virtual IDianaDAESO& GetModel() = 0;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    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) = 0;

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

    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) = 0;

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

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

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


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

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


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

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

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

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

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

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

    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) = 0;

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

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


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

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


 
};

#endif // IDIANA_SENS_DAESO_H