underling  0.3.2
List of all members | Public Member Functions
underling::grid Class Reference

Provides a thin RAII wrapper for underling_grid. More...

Detailed Description

Provides a thin RAII wrapper for underling_grid.

See also
underling_grid.

Public Member Functions

 grid (MPI_Comm comm, int n0, int n1, int n2, int pA=0, int pB=0)
 
template<class InputIterator1 , class InputIterator2 >
 grid (MPI_Comm comm, InputIterator1 n, InputIterator2 p)
 
template<class InputIterator >
 grid (MPI_Comm comm, InputIterator n)
 
 ~grid ()
 
int pA_size () const
 
int pB_size () const
 
underling_grid get () const
 
 operator bool () const
 

Constructor & Destructor Documentation

◆ grid() [1/3]

underling::grid::grid ( MPI_Comm  comm,
int  n0,
int  n1,
int  n2,
int  pA = 0,
int  pB = 0 
)
inline

◆ grid() [2/3]

template<class InputIterator1 , class InputIterator2 >
underling::grid::grid ( MPI_Comm  comm,
InputIterator1  n,
InputIterator2  p 
)
inline

◆ grid() [3/3]

template<class InputIterator >
underling::grid::grid ( MPI_Comm  comm,
InputIterator  n 
)
inline

◆ ~grid()

underling::grid::~grid ( )
inline

Member Function Documentation

◆ get()

underling_grid underling::grid::get ( ) const
inline
Returns
The wrapped underling_grid instance.

◆ operator bool()

underling::grid::operator bool ( ) const
inline
Returns
True if the wrapped underling_grid instance is non-NULL.

◆ pA_size()

int underling::grid::pA_size ( ) const
inline

◆ pB_size()

int underling::grid::pB_size ( ) const
inline

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

Generated on Wed Jul 1 2026 13:22:58 for underling by  doxygen 1.8.17