Alien  1.3.0
Developer documentation
Loading...
Searching...
No Matches
Alien::Block Class Referencefinal

Block elements for block matrices. More...

#include <core/alien/core/block/Block.h>

Collaboration diagram for Alien::Block:

Classes

struct  Internal
 Internal structure for square or rectangular blocks. More...

Public Member Functions

 Block (Arccore::Integer block_size)
 Square block constructor.
 Block (Arccore::Integer block_sizeX, Arccore::Integer block_sizeY)
 Rectangular block constructor.
 Block (const Block &block)
 Copy constructor.
 ~Block ()=default
 Free resources.
 Block (Block &&block)=delete
Blockoperator= (const Block &block)=delete
Arccore::Integer size () const
 Get square block size.
Arccore::Integer sizeX () const
 Get rectangular block size in the "X" direction.
Arccore::Integer sizeY () const
 Get rectangular block size in the "Y" direction.
std::shared_ptr< Blockclone () const
 Clone this object.

Private Attributes

std::shared_ptr< Internalm_internal
 Actual implementation.

Detailed Description

Block elements for block matrices.

Defines block parameters, for square or rectangulars block entries in a block matrix. All blocks in the matrix are identical in term of size.

Definition at line 44 of file Block.h.

Constructor & Destructor Documentation

◆ Block() [1/3]

Alien::Block::Block ( Arccore::Integer block_size)
explicit

Square block constructor.

Parameters
[in]block_sizeSize of the block

Referenced by Block(), Block(), and ~Block().

Here is the caller graph for this function:

◆ Block() [2/3]

Alien::Block::Block ( Arccore::Integer block_sizeX,
Arccore::Integer block_sizeY )

Rectangular block constructor.

Parameters
[in]block_sizeXSize of the block in "X" direction
[in]block_sizeYSize of the block in "Y" direction

References Block().

Here is the call graph for this function:

◆ Block() [3/3]

Alien::Block::Block ( const Block & block)

Copy constructor.

Parameters
[in]Block related APIThe block to copy

Definition at line 68 of file Block.cc.

References Block(), and m_internal.

Here is the call graph for this function:

Member Function Documentation

◆ clone()

std::shared_ptr< Block > Alien::Block::clone ( ) const

Clone this object.

Returns
A copy of this object

Definition at line 117 of file Block.cc.

Referenced by Alien::MultiMatrixImpl::setBlockInfos(), Alien::MultiVectorImpl::setBlockInfos(), and ~Block().

Here is the caller graph for this function:

◆ size()

◆ sizeX()

Integer Alien::Block::sizeX ( ) const

Get rectangular block size in the "X" direction.

Returns
Block size in the "X" direction

Definition at line 99 of file Block.cc.

References m_internal.

Referenced by Alien::Block::Internal::newFixedSizeBlock(), and ~Block().

Here is the caller graph for this function:

◆ sizeY()

Integer Alien::Block::sizeY ( ) const

Get rectangular block size in the "Y" direction.

Returns
Block size in the "Y" direction

Definition at line 108 of file Block.cc.

References m_internal.

Referenced by Alien::Block::Internal::newFixedSizeBlock(), and ~Block().

Here is the caller graph for this function:

Member Data Documentation

◆ m_internal

std::shared_ptr<Internal> Alien::Block::m_internal
private

Actual implementation.

Definition at line 100 of file Block.h.

Referenced by Block(), size(), sizeX(), and sizeY().


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