Scippy

UG

Ubiquity Generator framework

ParaSolution Class Referenceabstract

class for solution More...

#include <paraSolution.h>

+ Inheritance diagram for ParaSolution:

Public Member Functions

 ParaSolution ()
 DO NOT HAVE DATA MEMBER!! More...
 
virtual ~ParaSolution ()
 destructor More...
 
virtual double getObjectiveFunctionValue ()=0
 get objective function value More...
 
virtual ParaSolutionclone (ParaComm *comm)=0
 create clone of this object More...
 
virtual void bcast (ParaComm *comm, int root)=0
 broadcast solution data More...
 
virtual void send (ParaComm *comm, int destination)=0
 send solution data More...
 
virtual void receive (ParaComm *comm, int source)=0
 receive solution data More...
 
virtual const std::string toString ()
 stringfy ParaSolution object More...
 

Detailed Description

class for solution

This class should NOT have any data member.

Definition at line 53 of file paraSolution.h.

Constructor & Destructor Documentation

◆ ParaSolution()

DO NOT HAVE DATA MEMBER!!

default constructor

Definition at line 65 of file paraSolution.h.

◆ ~ParaSolution()

Member Function Documentation

◆ bcast()

virtual void bcast ( ParaComm comm,
int  root 
)
pure virtual

broadcast solution data

Parameters
commcommunicator used
rootroot rank for broadcast

Implemented in ScipParaSolutionMpi, and ScipParaSolutionTh.

Referenced by ScipParaSolver::ScipParaSolver(), and ParaSolution::~ParaSolution().

◆ clone()

virtual ParaSolution* clone ( ParaComm comm)
pure virtual

create clone of this object

Returns
pointer to ParaSolution object

Implemented in ScipParaSolutionMpi, and ScipParaSolutionTh.

Referenced by BbParaLoadCoordinator::updateSolution(), and ParaSolution::~ParaSolution().

◆ getObjectiveFunctionValue()

◆ receive()

virtual void receive ( ParaComm comm,
int  source 
)
pure virtual

receive solution data

Parameters
commcommunicator used
sourcesource rank

Implemented in ScipParaSolutionMpi, and ScipParaSolutionTh.

Referenced by BbParaSolver::processTagSolution(), BbParaLoadCoordinator::processTagSolution(), and ParaSolution::~ParaSolution().

◆ send()

virtual void send ( ParaComm comm,
int  destination 
)
pure virtual

◆ toString()

virtual const std::string toString ( )
virtual

stringfy ParaSolution object

Returns
string to show inside of this object

Reimplemented in ScipParaSolution.

Definition at line 140 of file paraSolution.h.