IDianaDAESO.hpp

/* -----------------------------------------------------------------------------
 *  Diana process modelling, simulation and analysis software
 *  Copyright (c) 2005, Michael Krasnyk
 *  All rights reserved.
 *
 *  This file is a part of Diana process modelling, simulation and analysis software
 *
 *  Diana is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU General Public License as published
 *  by the Free Software Foundation (see accompanying file LICENSE)
 * -----------------------------------------------------------------------------
 *  $Id: IDianaDAESO.hpp 8160 2009-03-16 18:36:30Z miha $
 * -----------------------------------------------------------------------------
 *  Description:
 */

#ifndef IDIANA_ESO_HPP
#define IDIANA_ESO_HPP

#include <CapeOpen.hpp>
#include <Diana/IDianaPetriNet.hpp>

namespace Diana {

  class IDianaDAESO : virtual public Numeric::Solvers::Eso::ICapeNumericDAESO {
#ifndef SWIG

    friend std::ostream& operator<<(std::ostream& out_file, const IDianaDAESO& eso);
#endif
  public:
    virtual ~IDianaDAESO(){};

#if defined(__GNUC__) && (__GNUC__>=4)
 #define DIANA_DAESO_CLONERET Diana::IDianaDAESO
#else
 #define DIANA_DAESO_CLONERET Common::Identification::ICapeIdentification
#endif

    virtual DIANA_DAESO_CLONERET* clone() throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) = 0;

    virtual void SaveState(const Common::Types::CapeString& filename)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) = 0;
    
    virtual void LoadState(const Common::Types::CapeString& filename)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) = 0;

    virtual void LoadStateDiva(const Common::Types::CapeString& states,
                               const Common::Types::CapeString& params,
                               const Common::Types::CapeString& mapfile=Common::Types::CapeString())
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) = 0;

    virtual Common::Collection::ICapeCollection* GetStateVariables()
            throw (Common::Error::ECapeUnknown) = 0;

    virtual Common::Collection::ICapeCollection* GetRealParameters()
            throw (Common::Error::ECapeUnknown) = 0;

    virtual void SetAllRealParameters(const Common::Types::CapeArrayDouble& varValues)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
             Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds) = 0;
    
    virtual void SetRealParameters(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& GetAllRealParameters()
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) = 0;

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

    virtual const Diana::DianaSparseArray& GetHighOrderJacobian(Common::Types::CapeLong nXOrder,
                                                                Common::Types::CapeLong nDOrder,
                                                                Common::Types::CapeLong nPOrder)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) = 0;

    virtual CapeArrayDouble GetAbsoluteError() const
      throw(Common::Error::ECapeUnknown) = 0;


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


      virtual Common::Types::CapeDouble GetPhiValue(CapeLong index) 
          throw (Common::Error::ECapeUnknown)=0;


      virtual Diana::IDianaPetriNet* GetPetriNet() 
          throw (Common::Error::ECapeUnknown) = 0;


#ifndef SWIG

    virtual void BeforeStep(Diana::IDianaNumericDAESolver *solver) throw (Common::Error::ECapeUnknown) = 0;
    
    virtual void AfterStep(Diana::IDianaNumericDAESolver *solver) throw (Common::Error::ECapeUnknown) = 0;
#endif    

    virtual const DianaSparseArray& GetAllParJacobianValues(const Common::Types::CapeArrayLong& parIndices)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) = 0;
#ifndef SWIG
    virtual const DianaSparseArray& GetAllParJacobianValues(const Common::Types::CapeArrayLong* const parIndices=NULL)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) = 0;
#endif    
        };
};

#endif // IDIANA_ESO_HPP