IDianaSolver.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: IDianaSolver.hpp 8160 2009-03-16 18:36:30Z miha $
 * -----------------------------------------------------------------------------
 *  Description:
 */

#ifndef IDIANA_SOLVER_H
#define IDIANA_SOLVER_H

#include <CapeOpen.hpp>
#include <Diana/IDianaReporting.hpp>
#include <Diana/IDianaNLPParalleling.hpp>

namespace Diana {

  // Foward declaration of interfaces
  class IDianaNumericSolver;
  class IDianaNumericNLPSolver;

  // Interface sequence
  typedef std::vector<IDianaNumericSolver*> DianaArrayNumericSolver;         
  typedef std::vector<IDianaNumericNLPSolver*> DianaArrayNumericNLPSolver;         


  class IDianaNumericSolver : virtual public Numeric::Solvers::Solver::ICapeNumericSolver {
  public:
    virtual void SetReportingInterface(Diana::IDianaReporting* _pReportingInterface)
      throw (Common::Error::ECapeUnknown) = 0;

    virtual void RemoveReportingInterface(Diana::IDianaReporting* _pReportingInterface)
      throw (Common::Error::ECapeUnknown) = 0;
  };

  class IDianaNumericDAESolver : virtual public Numeric::Solvers::Solver::ICapeNumericDAESolver,
                                 virtual public IDianaNumericSolver {

// #ifndef SWIG
//     /** ostream output operator for the IDianaNumericDAESolver class.*/
//     friend std::ostream& operator<<(std::ostream& out_file, const IDianaNumericDAESolver& solver);
// #endif
//     public:
//     /** This method should reinitialize solver with the values currently contained in ESO, including independent
//      *  variable. It takes part in reversing model to previous step. Needed by discrete part.*/
// #ifndef SWIG
//     virtual void StepBack() = 0;
//     /** This method should advance solver exactly to the given time. Needed by discrete part.*/
//     virtual void MakeStep(Common::Types::CapeDouble tend, Common::Types::CapeBoolean fireEvents = false) = 0;
// #endif    
//     /** This method should recalculate initial conditions. It's called when Petri net switches and 
//      * the model (parameter values, equations) changed.*/
//     virtual void RecalculateIC() = 0;
  };

  class IDianaNumericNLPSolver : virtual public Numeric::Solvers::Solver::ICapeNumericNLPSolver,
                                 virtual public IDianaNumericSolver {
  public:
    
    /* Sets class that provides parallel optimization task solving*/
    virtual void SetParallelInterface(Diana::IDianaNLPSolverParallelInterface *_pi) = 0;

    /* Gets optimization solution as parameters set */
    virtual Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint *GetNLPSolution() 
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation) = 0;
    
  };

  class IDianaHybridSolver {

  public:

    /* Adds reference to external solver that will be used in hybrid */
    virtual void SetSolver(Diana::IDianaNumericSolver *_solver)
      throw (Common::Error::ECapeUnknown) = 0;
    /* Remove solver from the list of added solvers */
    virtual void RemoveSolver(Diana::IDianaNumericSolver *_solver)
      throw (Common::Error::ECapeUnknown) = 0;
  };

  class IDianaNLPHybridSolver : virtual public IDianaHybridSolver, virtual public IDianaNumericNLPSolver {
  public:
    /* Sets class that provides parallel optimization task solving*/
    //    virtual void SetParallelInterface(Diana::IDianaNLPSolverParallelInterface *_pi) = 0;
  };

};

#endif // IDIANA_SOLVER_H