coupling::interface::PintableMacroSolverState Class Reference

#include <PintableMacroSolver.h>

Inheritance diagram for coupling::interface::PintableMacroSolverState:

Public Types
using	State = PintableMacroSolverState

Public Member Functions
virtual std::unique_ptr< State >	clone () const =0
virtual int	getSizeBytes () const =0
virtual std::unique_ptr< State >	operator+ (const State &)=0
virtual std::unique_ptr< State >	operator- (const State &)=0
virtual bool	operator== (const State &) const =0
virtual double *	getData ()=0
virtual const double *	getData () const =0
virtual void	print (std::ostream &os) const =0

Friends
std::ostream &	operator<< (std::ostream &os, const coupling::interface::PintableMacroSolverState &s)

Detailed Description

Interface for state instances

Member Function Documentation

getData() [1/2]

virtual const double * coupling::interface::PintableMacroSolverState::getData ( ) const

pure virtual

For MPI communication, raw pointer of the underlying data is needed

Implemented in coupling::solvers::LBCouetteSolverState.

getData() [2/2]

virtual double * coupling::interface::PintableMacroSolverState::getData ( )

pure virtual

For MPI communication, raw pointer of the underlying data is needed

Implemented in coupling::solvers::LBCouetteSolverState.

getSizeBytes()

virtual int coupling::interface::PintableMacroSolverState::getSizeBytes ( ) const

pure virtual

For MPI communication, size of a State object must be known

Implemented in coupling::solvers::LBCouetteSolverState.

operator+()

virtual std::unique_ptr< State > coupling::interface::PintableMacroSolverState::operator+ ( const State & )

pure virtual

For Parareal algorithm, it must be possible to add states. This is expected to operate element-wise

Implemented in coupling::solvers::LBCouetteSolverState.

operator-()

virtual std::unique_ptr< State > coupling::interface::PintableMacroSolverState::operator- ( const State & )

pure virtual

For Parareal algorithm, it must be possible to substract states. This is expected to operate element-wise

Implemented in coupling::solvers::LBCouetteSolverState.

operator==()

virtual bool coupling::interface::PintableMacroSolverState::operator== ( const State & ) const

pure virtual

For tests, it must be possible to compare states. This is expected to operate element-wise

Implemented in coupling::solvers::LBCouetteSolverState.

print()

virtual void coupling::interface::PintableMacroSolverState::print ( std::ostream & os ) const

pure virtual

this is expected to print information about the type of this state object to os

Implemented in coupling::solvers::LBCouetteSolverState.

---

The documentation for this class was generated from the following file:

• coupling/interface/PintableMacroSolver.h