C++ mpi module for stochmagnet_main Package
Public Member Functions | Static Public Member Functions | List of all members
MPI_View Class Reference

This class describes a view as follow: More...

#include <MPI_View.h>

Inheritance diagram for MPI_View:
Inheritance graph
[legend]
Collaboration diagram for MPI_View:
Collaboration graph
[legend]

Public Member Functions

 MPI_View ()
 create a root environment
 
virtual ~MPI_View (void)
 destroy
 
const tMPIIOIndex & getStartIndex () const
 get the start index
 
const tMPIType & getType () const
 get the type of the element of the view
 
const tMPIView & getMPIView () const
 get the mpi view of the view
 
template<int N, typename T >
tBoolean createSubArrayView (const std::array< int, N > &arraySize, const std::array< int, N > &startElement, const std::array< int, N > &subarraySize)
 create a sub array view of an array with N dimension More...
 
template<typename T >
tBoolean createVariableStepView (const tMPICount &nElements, const std::valarray< tMPICount > &elementSizes, const std::valarray< tMPICount > &elementIndices)
 create a variable step view More...
 
- Public Member Functions inherited from CORE_Object
template<class T >
std::shared_ptr< T > getSharedPointer ()
 return the shared pointer for this More...
 
template<class T >
std::shared_ptr< const T > getConstSharedPointer () const
 return a const shared pointer for this More...
 
virtual tMemSize getMemorySize () const
 return the memory size of the class and the memory size of all its attributes/associations More...
 
virtual tMemSize getContentsMemorySize () const
 return nthe memory size of the included associations More...
 
template<class T >
tBoolean isInstanceOf () const
 test if the clas T is an instance of this class More...
 
tString getClassName () const
 return the name of the class More...
 
tString getPointerString () const
 retrun the pointer of the class as a string More...
 
tString getIdentityString () const
 retrun the string identification of the class More...
 
virtual tString toString () const
 return the string representation of the object node More...
 

Static Public Member Functions

static CORE_UniquePointer< MPI_ViewNew ()
 create a new instance of class within an unique pointer More...
 
- Static Public Member Functions inherited from CORE_Object
static tBoolean EnableMemoryStack (const tBoolean &isMemoryChecked)
 enable the memory stack More...
 
static void EnableMemoryStack ()
 enable the memory stack
 
static void DisableMemoryStack ()
 disable the memory stack
 
static tBoolean IsMemoryStackEnabled ()
 return trur if the memory stack is enabled
 
static tString MemoryStackToString ()
 get the memory stack in string More...
 
static tIndex GetRegisteredClassesNumber ()
 get the memory stack in string More...
 

Additional Inherited Members

- Protected Member Functions inherited from MPI_Object
 MPI_Object (void)
 create
 
virtual ~MPI_Object (void)
 destroy
 
- Protected Member Functions inherited from CORE_Object
 CORE_Object ()
 build an instance of the object
 
virtual ~CORE_Object ()
 destroy the instance of object std

 

Detailed Description

This class describes a view as follow:

a view is a tDataType

Author
Stephane Despreaux
Version
2.0

Member Function Documentation

◆ createSubArrayView()

template<int N, typename T >
tBoolean MPI_View::createSubArrayView ( const std::array< int, N > &  arraySize,
const std::array< int, N > &  startElement,
const std::array< int, N > &  subarraySize 
)
inline

create a sub array view of an array with N dimension

Template Parameters
N: dimesnion of the space
T: type of the element
Parameters
[in]arraySizesize of the array ie number of elements per directions
[in]startElement: index of the start element within the array
[in]subarraySizesize of the sub array ie the number of elements per directions

exemple createSubarrayView<2,tInteger>({4,4},{0,1},{2,2})

◆ createVariableStepView()

template<typename T >
tBoolean MPI_View::createVariableStepView ( const tMPICount &  nElements,
const std::valarray< tMPICount > &  elementSizes,
const std::valarray< tMPICount > &  elementIndices 
)
inline

create a variable step view

Template Parameters
T: type of the element
Parameters
[in]nElements: number of elements of new type
[in]elementSizes: number of T elements within the i-th element of new type
[in]elementIndicesnumber of T elements to reach the i-th elements of new type
[out]newTypenew type
Returns
an error code type --— : mask xx-x- : -holes
  • nElements=2
  • elementSizes={2,1} -elementIndices={0,3}

◆ New()

static CORE_UniquePointer<MPI_View> MPI_View::New ( )
inlinestatic

create a new instance of class within an unique pointer

Returns
a new unique pointer of this class

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