coupling::solvers::LBCouetteSolverState Class Reference

Inheritance diagram for coupling::solvers::LBCouetteSolverState:

Collaboration diagram for coupling::solvers::LBCouetteSolverState:

Public Member Functions
	LBCouetteSolverState (int size)
	LBCouetteSolverState (int size, double *pdf)
std::unique_ptr< State >	clone () const override
int	getSizeBytes () const override
std::unique_ptr< State >	operator+ (const State &rhs) override
std::unique_ptr< State >	operator- (const State &rhs) override
bool	operator== (const State &rhs) const override
double *	getData () override
const double *	getData () const override
void	print (std::ostream &os) const override

Private Attributes
std::vector< double >	_pdf

Additional Inherited Members
Public Types inherited from coupling::interface::PintableMacroSolverState
using	State = PintableMacroSolverState

Member Function Documentation

clone()

std::unique_ptr< State > coupling::solvers::LBCouetteSolverState::clone ( ) const

inlineoverridevirtual

Implements coupling::interface::PintableMacroSolverState.

getData() [1/2]

const double * coupling::solvers::LBCouetteSolverState::getData ( ) const

inlineoverridevirtual

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

Implements coupling::interface::PintableMacroSolverState.

getData() [2/2]

double * coupling::solvers::LBCouetteSolverState::getData ( )

inlineoverridevirtual

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

Implements coupling::interface::PintableMacroSolverState.

getSizeBytes()

int coupling::solvers::LBCouetteSolverState::getSizeBytes ( ) const

inlineoverridevirtual

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

Implements coupling::interface::PintableMacroSolverState.

operator+()

std::unique_ptr< State > coupling::solvers::LBCouetteSolverState::operator+ ( const State & rhs )

overridevirtual

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

Implements coupling::interface::PintableMacroSolverState.

operator-()

std::unique_ptr< State > coupling::solvers::LBCouetteSolverState::operator- ( const State & rhs )

overridevirtual

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

Implements coupling::interface::PintableMacroSolverState.

operator==()

bool coupling::solvers::LBCouetteSolverState::operator== ( const State & rhs ) const

inlineoverridevirtual

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

Implements coupling::interface::PintableMacroSolverState.

print()

void coupling::solvers::LBCouetteSolverState::print ( std::ostream & os ) const

inlineoverridevirtual

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

Implements coupling::interface::PintableMacroSolverState.

---

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

• coupling/solvers/LBCouetteSolver.h