pomerol  2.1
Public Member Functions | Data Fields
pMPI::PrepareWrap< PartType > Struct Template Reference

Wrapper around a computable object that calls the prepare() method of the wrapped object and carries information about the complexity of a call to that method. More...

#include <mpi_skel.hpp>

Public Member Functions

 PrepareWrap (PartType &x, int complexity=1)
 
void run ()
 Call prepare() of the wrapped object x. More...
 

Data Fields

PartType & x
 Reference to the wrapped object. More...
 
int complexity
 Complexity of a call to x.prepare(). More...
 

Detailed Description

template<typename PartType>
struct pMPI::PrepareWrap< PartType >

Wrapper around a computable object that calls the prepare() method of the wrapped object and carries information about the complexity of a call to that method.

Template Parameters
PartTypeType of the wrapped object.

Definition at line 56 of file mpi_skel.hpp.

Constructor & Destructor Documentation

◆ PrepareWrap()

template<typename PartType >
pMPI::PrepareWrap< PartType >::PrepareWrap ( PartType &  x,
int  complexity = 1 
)
inlineexplicit

Constructor.

Parameters
[in]xReference to the wrapped object.
[in]complexityComplexity of a call to x.prepare().

Definition at line 65 of file mpi_skel.hpp.

Member Function Documentation

◆ run()

template<typename PartType >
void pMPI::PrepareWrap< PartType >::run ( )
inline

Call prepare() of the wrapped object x.

Definition at line 67 of file mpi_skel.hpp.

Field Documentation

◆ complexity

template<typename PartType >
int pMPI::PrepareWrap< PartType >::complexity

Complexity of a call to x.prepare().

Definition at line 60 of file mpi_skel.hpp.

◆ x

template<typename PartType >
PartType& pMPI::PrepareWrap< PartType >::x

Reference to the wrapped object.

Definition at line 58 of file mpi_skel.hpp.


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