CapeESO.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: CapeESO.hpp 8180 2009-03-18 17:41:58Z miha $
 * -----------------------------------------------------------------------------
 *  Description:
 */

#ifndef CAPE_ESO_HPP
#define CAPE_ESO_HPP

#include "CapeTypes.hpp"
#include "CapeException.hpp"
#include "CapeBasic.hpp"
#include "CapeMatrix.hpp"
#include "DianaSparseArray.hpp"


namespace Numeric{

  namespace  Solvers {

    namespace  Eso{

      class ICapeNumericESO  : virtual public Common::Identification::ICapeIdentification,
                               virtual public Common::Utilities::ICapeUtilities {
#ifndef SWIG

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

        virtual Common::Types::CapeLong GetNumVars()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) = 0;

        virtual Common::Types::CapeLong GetNumEqns()
          throw (Common::Error::ECapeUnknown) = 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 Common::Types::CapeArrayDouble GetResiduals(const Common::Types::CapeArrayLong& eqnIndices)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                  Common::Error::ECapeOutOfBounds, 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 Common::Types::CapeArrayDouble GetJacobianValues(const Common::Types::CapeArrayLong& indices)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                  Common::Error::ECapeNoImpl, Common::Error::ECapeOutOfBounds) = 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;
      };

      class ICapeNumericLAESO : public ICapeNumericESO {
#ifndef SWIG

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

        virtual void SetLHS(const Diana::DianaSparseArray& values)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeOutOfBounds) = 0;

        virtual void SetRHS(const Common::Types::CapeArrayDouble& values)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                  Common::Error::ECapeOutOfBounds) = 0;

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

        virtual Common::Types::CapeArrayDouble GetRHS()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) = 0;
      };

      class ICapeNumericNLAESO : public ICapeNumericESO {
#ifndef SWIG

      friend std::ostream& operator<<(std::ostream& out_file, const ICapeNumericNLAESO& eso);
#endif
      public:
        virtual ~ICapeNumericNLAESO(){}
      };
                                        
      class ICapeNumericDAESO : public ICapeNumericESO {
#ifndef SWIG

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

        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 Common::Types::CapeArrayDouble GetDiffJacobianValues(const Common::Types::CapeArrayLong& indices)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                  Common::Error::ECapeNoImpl, Common::Error::ECapeOutOfBounds) = 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 // CAPE_ESO_HPP