paraSolverTerminationState.h

Go to the documentation of this file.

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*                                                                           */
/*          This file is part of the program and software framework          */
/*                    UG --- Ubquity Generator Framework                     */
/*                                                                           */
/*  Copyright Written by Yuji Shinano <shinano@zib.de>,                      */
/*            Copyright (C) 2021-2026 by Zuse Institute Berlin,              */
/*            licensed under LGPL version 3 or later.                        */
/*            Commercial licenses are available through <licenses@zib.de>    */
/*                                                                           */
/* This code is free software; you can redistribute it and/or                */
/* modify it under the terms of the GNU Lesser General Public License        */
/* as published by the Free Software Foundation; either version 3            */
/* of the License, or (at your option) any later version.                    */
/*                                                                           */
/* This program is distributed in the hope that it will be useful,           */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of            */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             */
/* GNU Lesser General Public License for more details.                       */
/*                                                                           */
/* You should have received a copy of the GNU Lesser General Public License  */
/* along with this program.  If not, see <http://www.gnu.org/licenses/>.     */
/*                                                                           */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
/**@file    paraSolverTerminationState.h
 * @brief   This class contains solver termination state which is transferred form Solver to LC.
 * @author  Yuji Shinano
 *
 *
 *
 */
 
/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
 
 
#ifndef __PARA_SOLVER_TERMINATION_STATE_H__
#define __PARA_SOLVER_TERMINATION_STATE_H__
 
#include "paraComm.h"
#include "paraInitiator.h"
#ifdef UG_WITH_ZLIB
#include "gzstream.h"
#endif
 
namespace UG
{
 
///
/// class ParaSolverTerminationState
/// (Solver termination state in a ParaSolver)
///
class ParaSolverTerminationState
{
public:
 
   ParaSolverTerminationState(
         )
   {
   }
 
   virtual ~ParaSolverTerminationState(
         )
   {
   }
 
   ///
   /// stringfy ParaSolverTerminationState object
   /// @return string to show inside of ParaSolverTerminationState object
   ///
   virtual std::string toString(
         ParaInitiator *initiator     ///< pointer to ParaInitiator object
         ) = 0;
 
   ///
   /// getter of interrupted flag
   /// @return true if it is interrupted, false otherwise
   ///
   virtual int getInterruptedMode(
         ) = 0;
 
   ///
   /// getter of deterministic time
   /// @return deterministic time
   ///
   virtual double getDeterministicTime(
         ) = 0;
 
#ifdef UG_WITH_ZLIB
 
   ///
   /// write ParaSolverTerminationState to checkpoint file
   ///
   virtual void write(
         gzstream::ogzstream &out      ///< gzstream to output
         ) = 0;
 
   ///
   /// read ParaSolverTerminationState from checkpoint file
   ///
   virtual bool read(
         ParaComm *comm,               ///< communicator used
         gzstream::igzstream &in       ///< gzstream to input
         ) = 0;
 
#endif 
 
   ///
   /// send this object
   ///
   virtual void send(
         ParaComm *comm,               ///< communicator used
         int destination,              ///< destination rank
         int tag                       ///< TagTerminated
         ) = 0;
 
   ///
   /// receive this object
   ///
   virtual void receive(
         ParaComm *comm,              ///< communicator used
         int source,                  ///< source rank
         int tag                      ///< TagTerminated
         ) = 0;
 
};
 
}
 
#endif // __PARA_SOLVER_TERMINATION_STATE_H__