Alien  1.3.0
User documentation
Loading...
Searching...
No Matches
Alien::VBlockSizes Class Referencefinal

Compute the actual size of variable block size algebraic elements. More...

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

Public Member Functions

 VBlockSizes (const VBlock &block, const VectorDistribution &dist)
 Constructor for vectors variable blocks.
 VBlockSizes (const VBlock &block, const MatrixDistribution &dist)
 Constructor for matrices variable blocks.
 ~VBlockSizes ()
 Free resources.
Arccore::Integer localSize () const
 Get the "scalarized" local size.
Arccore::Integer globalSize () const
 Get the "scalarized" global size.
Arccore::Integer offset () const
 Get the "scalarized" offset.
std::shared_ptr< VBlockSizesclone () const
 Copy this object.

Detailed Description

Compute the actual size of variable block size algebraic elements.

This class will refer to scalarized sizes, which means the actual size of the algebraic elements, as if it was not a block element. For exemple, a vector with two block 2x1 entries has a size of two and a scalarized size of four (2 elements for each block).

Definition at line 50 of file VBlockSizes.h.

Constructor & Destructor Documentation

◆ VBlockSizes() [1/2]

Alien::VBlockSizes::VBlockSizes ( const VBlock & block,
const VectorDistribution & dist )

Constructor for vectors variable blocks.

Parameters
[in]Block related APIThe variable blocks
[in]distThe vector distribution

Definition at line 41 of file VBlockSizes.cc.

References Alien::VBlock::blockSizes(), localSize(), Alien::VectorDistribution::localSize(), Alien::VectorDistribution::offset(), and Alien::VectorDistribution::parallelMng().

◆ VBlockSizes() [2/2]

Alien::VBlockSizes::VBlockSizes ( const VBlock & block,
const MatrixDistribution & dist )

Constructor for matrices variable blocks.

Parameters
[in]Block related APIThe variable blocks
[in]distThe matrix distribution

Definition at line 51 of file VBlockSizes.cc.

References Alien::VBlock::blockSizes(), Alien::MatrixDistribution::localRowSize(), localSize(), Alien::MatrixDistribution::parallelMng(), and Alien::MatrixDistribution::rowOffset().

◆ ~VBlockSizes()

Alien::VBlockSizes::~VBlockSizes ( )
inline

Free resources.

Definition at line 68 of file VBlockSizes.h.

Member Function Documentation

◆ clone()

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

Copy this object.

Returns
A copy of this object

◆ globalSize()

Integer Alien::VBlockSizes::globalSize ( ) const

Get the "scalarized" global size.

Returns
The actual global size

Definition at line 100 of file VBlockSizes.cc.

◆ localSize()

Integer Alien::VBlockSizes::localSize ( ) const

Get the "scalarized" local size.

Returns
The actual local size

Definition at line 91 of file VBlockSizes.cc.

Referenced by VBlockSizes(), and VBlockSizes().

◆ offset()

Integer Alien::VBlockSizes::offset ( ) const

Get the "scalarized" offset.

Returns
The actual offset

Definition at line 109 of file VBlockSizes.cc.


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