Scippy

UG

Ubiquity Generator framework

Class for the difference between instance and subproblem. More...

#include <paraDiffSubproblem.h>

Inheritance diagram for ParaDiffSubproblem:

Public Member Functions
	ParaDiffSubproblem ()
	DO NOT HAVE DATA MEMBER!! More...

virtual	~ParaDiffSubproblem ()
	destractor¥ More...

virtual ParaDiffSubproblem *	clone (ParaComm *comm)=0
	create clone of this object More...

virtual int	bcast (ParaComm *comm, int root)=0
	broadcast function for ParaDiffSubproblem object More...

virtual int	send (ParaComm *comm, int dest)=0
	send function for ParaDiffSubproblem object More...

virtual int	receive (ParaComm *comm, int source)=0
	receive function for ParaDiffSubproblem object More...

virtual void	write (gzstream::ogzstream &out)=0
	function to write ParaDiffSubproblem object to checkpoint file More...

virtual const std::string	toString ()=0
	stringfy ParaDiffSubproblem object ( for debugging ) More...

Detailed Description

Class for the difference between instance and subproblem.

This class should NOT have any data member.

Definition at line 65 of file paraDiffSubproblem.h.

Constructor & Destructor Documentation

◆ ParaDiffSubproblem()

ParaDiffSubproblem ( )

DO NOT HAVE DATA MEMBER!!

default constructor

Definition at line 76 of file paraDiffSubproblem.h.

◆ ~ParaDiffSubproblem()

virtual ~ParaDiffSubproblem ( )

virtual

destractor¥

Definition at line 84 of file paraDiffSubproblem.h.

Member Function Documentation

◆ bcast()

virtual int bcast	(	ParaComm *	comm,
		int	root
	)

pure virtual

broadcast function for ParaDiffSubproblem object

Returns: always 0 (for future extensions)

Parameters

comm	communicator used
root	root rank of broadcast

Implemented in ScipParaDiffSubproblemMpi, and ScipParaDiffSubproblemTh.

Referenced by BbParaNodeMpi::bcast().

◆ clone()

virtual ParaDiffSubproblem * clone ( ParaComm * comm )

pure virtual

create clone of this object

Returns: pointer to ParaDiffSubproblem object

Parameters

comm	communicator used

Implemented in ScipParaDiffSubproblemMpi, and ScipParaDiffSubproblemTh.

Referenced by BbParaNodeTh::bcast(), BbParaNodeMpi::clone(), BbParaNodeTh::clone(), BbParaNodeTh::receive(), and BbParaNodeTh::receiveNewSubtreeRoot().

◆ receive()

virtual int receive	(	ParaComm *	comm,
		int	source
	)

pure virtual

receive function for ParaDiffSubproblem object

Returns: always 0 (for future extensions)

Parameters

comm	communicator used
source	source rank

Implemented in ScipParaDiffSubproblemMpi, and ScipParaDiffSubproblemTh.

Referenced by BbParaNodeMpi::receive(), and BbParaNodeMpi::receiveNewSubtreeRoot().

◆ send()

virtual int send	(	ParaComm *	comm,
		int	dest
	)

pure virtual

send function for ParaDiffSubproblem object

Returns: always 0 (for future extensions)

Parameters

comm	communicator used
dest	destination rank

Implemented in ScipParaDiffSubproblemMpi, and ScipParaDiffSubproblemTh.

Referenced by BbParaNodeMpi::send(), and BbParaNodeMpi::sendNewSubtreeRoot().

◆ toString()

virtual const std::string toString ( )

pure virtual

stringfy ParaDiffSubproblem object ( for debugging )

Returns: string to show inside of this object

Implemented in ScipParaDiffSubproblem.

Referenced by ParaTask::toString(), and BbParaNode::toString().

◆ write()

virtual void write ( gzstream::ogzstream & out )

pure virtual

function to write ParaDiffSubproblem object to checkpoint file

Parameters

out	gzstream for output

Implemented in ScipParaDiffSubproblem.

Referenced by BbParaNode::write().