NumericObject.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$
 * -----------------------------------------------------------------------------
 *  Description:
 */


#ifndef __NUMERIC_OBJECT_HPP
#define __NUMERIC_OBJECT_HPP


#include "MemoryBank.hpp"
#include "Timer.hpp"
#include <CapeOpen.hpp>
#include <Diana.hpp>



typedef struct
{
   CapeDouble Time;
   CapeArrayDouble ESOVariables;
   CapeArrayDouble ESODerivatives;
   CapeArrayDouble ESORealParameters;
} NumericObjectState; //State of numeric object


class CNumericObject
{
private: 
   CapeLong m_lGlobalIndex; 
   DianaNumericSolver* m_pSolver; 
   Numeric::Solvers::Model::ICapeNumericModel* m_pModel; 
   CapeString m_sModelName; 
   CapeString m_ESOName; 
   CapeLong m_lStatus; 
   std::vector< CMemoryBank* > m_pMemoryBanks;
   NumericObjectState OldState; 
   CapeDouble m_dCurrentTime;
   CapeBoolean m_bNeedToDeleteSolver;
   CapeBoolean m_bNeedToInitialize;
   
   CapeLong m_lJacCalls, m_lTotalJacCalls; 
   CapeLong m_lResCalls, m_lTotalResCalls; 
   CapeLong m_lSolCalls, m_lTotalSolCalls; 

   CTimer m_SimulationTimer; 
private:
   //Additional functions to transmit NumericObjectStates
   void SendNumericObjectState( NumericObjectState* _pState, CapeLong _nDestinationPE );
   void ReceiveNumericObjectState( NumericObjectState* _pState, CapeLong _nSourcePE );
   
   void ClearStat();
   void UpdateStat();
   
protected:   
   static void SaveStates( void* _pMemoryBanks, double X, int NEQ,
      int KOLD, double* PHI, double* PSI );
public: 
   CNumericObject( const CapeString& _sModelName, CapeLong _lGlobalIndex );
   ~CNumericObject();
   
   /* Group of some simple set and get methods   */
   CapeLong GetObjectIndex();
   CapeString GetModelName();
   CapeString GetESOName();
   void SetModel( Numeric::Solvers::Model::ICapeNumericModel* _Model );
   Numeric::Solvers::Model::ICapeNumericModel* GetModel();
   void SetSolver( DianaNumericSolver* _pSolver );
   void SetStatus( CapeLong _Status );
   CapeLong GetStatus();

   CapeLong GetSimulationTime(); 
   void ResetSimulationTime(); 


   void SetMemoryAdress( std::vector<CMemoryBank* > _MemoryAdress ); 


   void SaveState()
      throw (Common::Error::ECapeUnknown);


   void LoadState()
      throw (Common::Error::ECapeUnknown);


   CapeBoolean CheckConvergence(); 


   void ConsistentInitialize( CapeDouble _dStartTime, CapeDouble _dFinishTime, 
      CapeLong _lIterationNumber, CapeDouble _dInitialStepSize );


   void Simulate( CapeDouble _dStartTime, CapeDouble _dFinishTime, 
      CapeLong _nIterationNumber); 

   void DataSend( CRouter* _Router );
   void DataReceive( CRouter* _Router );


   Numeric::Solvers::Solver::ICapeNumericSolver* CreateSolver()
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

   void ShowStat(CapeBoolean _bShowTotalStat);
   
   void SaveInitialState();

   static void UpdateReceivedValues( void* _pMemoryBanks );
   void UpdateReceivedData( CapeDouble _dTime );

   void ResendWaveform();
};

#endif