Storage of block matrix, shared by block matrix and its nested (Schur) sub-matrices. More...

Collaboration diagram for MoFEM::BlockStorage:

Classes
struct	Elem
	A00 element. More...

struct	ElemEntity
	DOFs on one entity (node) of A00 element. More...

struct	Indexes
	block data indexes More...

struct	Pattern
	Block pattern of A00 element and layout of element buffer. More...

struct	RowUIdLess

Public Types
enum	FactorStorage { FACTOR_NONE , FACTOR_IN_DATA , FACTOR_IN_PRECONDITIONER , FACTOR_FAILED }

Public Member Functions
void	ensureAllocated ()

bool	isFactorised () const

MoFEMErrorCode	checkNotFailed () const
	Fails if factorisation failed, storage has to be zeroed.

MoFEMErrorCode	modified () const
	Call before modification of data, fails if factors are stored in place.

void	resetFactors ()

double *	blockPtr (const Indexes &b, bool prec=false)
	values of block, preconditioner buffer if prec is true

const Indexes *	find (const UId &row, const UId &col) const
	find block by row and column entity uid, return nullptr if not found

Indexes *	findMutable (const UId &row, const UId &col)

auto	rowRange (const UId &row) const
	range of blocks with given row entity uid

auto	colRange (const UId &col) const
	range (in colOrder) of blocks with given column entity uid

Static Public Member Functions
static bool	lessRowCol (const Indexes &a, const Indexes &b)

Public Attributes
std::vector< Indexes >	blockIndex
	blocks sorted by (row uid, col uid)

std::vector< int >	feOrder
	blocks sorted by (fe uid, row uid, col uid)

std::vector< int >	colOrder
	blocks sorted by (col uid, row uid)

std::vector< Pattern >	patterns

std::vector< Elem >	elems

std::vector< ElemEntity >	elemEntities

std::vector< std::vector< double > >	elemData
	A00 element buffers.

std::vector< std::vector< double > >	elemPrec
	preconditioner buffers

std::vector< std::vector< double > >	elemDense
	dense factors (fallback)

int	maxElemSize = 0
	maximal DOFs of element

size_t	maxElemBuffer = 0
	maximal size of element buffer

size_t	dataSize = 0
	required size of data

std::vector< double >	data
	blocks not in A00, allocated on first use

std::vector< __CLPK_integer >	pivots

FactorStorage	factorStorage = FACTOR_NONE

bool	nested = false
	nested Schur structure has been created

bool	hasPreconditioner = false
	preconditioner blocks are enabled

bool	optDense = false
	-schur_a00_dense

double	optPivotThreshold = 0
	-schur_a00_pivot_threshold

double	optRcondMin = 1e-12
	-schur_a00_rcond_min

double	optBackwardError = 1e-12
	-schur_a00_backward_error

Detailed Description

Storage of block matrix, shared by block matrix and its nested (Schur) sub-matrices.

Block is dense sub-matrix coupling DOFs on one row entity with DOFs on one column entity, stored row-major at mat_shift with leading dimension ld.

Blocks which are not part of A00 are stored in data. When nested Schur structure is created (see createSchurNestedMatrixStruture), blocks of A00 which belong to one finite element are stored in a buffer of that element. Elements with the same block pattern (entities, numbers of DOFs and listed pairs) share a Pattern, which defines the layout of element buffers.

Element buffers start in listed layout (listed blocks only). At the first factorisation each pattern is analysed on a probe element: nodes (entities) whose diagonal block is a safe pivot are eliminated one by one (block LU in place, fill only where the pattern creates it), the remaining nodes form a dense core factorised with partial pivoting. Element buffers are then relaid element by element, and factors are kept until MatZeroEntries. Elements failing the pivot test at a later factorisation are factorised dense in a buffer of their own. See doc/development/schur.md.

Factorisation works on M = A^T, which is how LAPACK reads row-major element blocks. Slot (r, c), i.e. block of A coupling row node r with column node c, read column-major is block (c, r) of M.

If preconditioner blocks are requested, they are allocated for A00 element buffers only, with the same layout. Then factors of (A00 + preconditioner) are stored in place of preconditioner blocks, and A00 blocks are intact.

Definition at line 251 of file Schur.cpp.

Member Enumeration Documentation

◆ FactorStorage

enum MoFEM::BlockStorage::FactorStorage

Enumerator
FACTOR_NONE
FACTOR_IN_DATA
FACTOR_IN_PRECONDITIONER
FACTOR_FAILED	factorisation failed, data is corrupted

Definition at line 397 of file Schur.cpp.

                     {
    FACTOR_NONE,
    FACTOR_IN_DATA,
    FACTOR_IN_PRECONDITIONER,
    FACTOR_FAILED ///< factorisation failed, data is corrupted
  };

Member Function Documentation

◆ blockPtr()

double * MoFEM::BlockStorage::blockPtr	(	const Indexes &	b,
		bool	prec = `false`
	)

inline

values of block, preconditioner buffer if prec is true

Definition at line 447 of file Schur.cpp.

                                                               {
    if (b.getElem() >= 0)
      return (prec ? elemPrec : elemData)[b.getElem()].data() + b.getMatShift();
    return data.data() + b.getMatShift();
  }

◆ checkNotFailed()

MoFEMErrorCode MoFEM::BlockStorage::checkNotFailed ( ) const

inline

Fails if factorisation failed, storage has to be zeroed.

Definition at line 416 of file Schur.cpp.

                                               {
    MoFEMFunctionBeginHot;
    if (factorStorage == FACTOR_FAILED)
      SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY,
              "A00 factorisation failed and block matrix data is corrupted, "
              "call MatZeroEntries and assemble again");
    MoFEMFunctionReturnHot(0);
  }

◆ colRange()

auto MoFEM::BlockStorage::colRange ( const UId & col ) const

inline

range (in colOrder) of blocks with given column entity uid

Definition at line 494 of file Schur.cpp.

                                             {
    auto lo = std::lower_bound(
        colOrder.begin(), colOrder.end(), col,
        [this](int i, const UId &c) { return blockIndex[i].getColUId() < c; });
    auto hi = std::upper_bound(
        colOrder.begin(), colOrder.end(), col,
        [this](const UId &c, int i) { return c < blockIndex[i].getColUId(); });
    return std::make_pair(lo, hi);
  }

◆ ensureAllocated()

void MoFEM::BlockStorage::ensureAllocated ( )

inline

data is allocated on first use, such that storage is not allocated twice when layout is changed by createSchurNestedMatrixStruture

Definition at line 392 of file Schur.cpp.

                                {
    if (data.size() != dataSize)
      data.assign(dataSize, 0.);
  }

◆ find()

const Indexes * MoFEM::BlockStorage::find	(	const UId &	row,
		const UId &	col
	)		const

inline

find block by row and column entity uid, return nullptr if not found

Definition at line 460 of file Schur.cpp.

                                                                   {
    auto it = std::lower_bound(
        blockIndex.begin(), blockIndex.end(), std::make_pair(row, col),
        [](const Indexes &a, const std::pair<UId, UId> &p) {
          if (a.getRowUId() != p.first)
            return a.getRowUId() < p.first;
          return a.getColUId() < p.second;
        });
    if (it != blockIndex.end() && it->getRowUId() == row &&
        it->getColUId() == col)
      return &*it;
    return nullptr;
  }

◆ findMutable()

Indexes * MoFEM::BlockStorage::findMutable	(	const UId &	row,
		const UId &	col
	)

inline

Definition at line 474 of file Schur.cpp.

                                                              {
    return const_cast<Indexes *>(find(row, col));
  }

◆ isFactorised()

bool MoFEM::BlockStorage::isFactorised ( ) const

inline

Definition at line 413 of file Schur.cpp.

413{ return factorStorage != FACTOR_NONE; }

◆ lessRowCol()

static bool MoFEM::BlockStorage::lessRowCol	(	const Indexes &	a,
		const Indexes &	b
	)

inlinestatic

Definition at line 453 of file Schur.cpp.

                                                                    {
    if (a.getRowUId() != b.getRowUId())
      return a.getRowUId() < b.getRowUId();
    return a.getColUId() < b.getColUId();
  }

◆ modified()

MoFEMErrorCode MoFEM::BlockStorage::modified ( ) const

inline

Call before modification of data, fails if factors are stored in place.

Definition at line 426 of file Schur.cpp.

                                         {
    MoFEMFunctionBeginHot;
    CHKERR checkNotFailed();
    if (isFactorised())
      SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY,
              "A00 element matrices are factorised in place, call "
              "MatZeroEntries before assembling or modifying block matrix");
    MoFEMFunctionReturnHot(0);
  }

◆ resetFactors()

void MoFEM::BlockStorage::resetFactors ( )

inline

Definition at line 436 of file Schur.cpp.

                             {
    factorStorage = FACTOR_NONE;
    for (auto &e : elems) {
      e.factorised = false;
      e.dense = false;
    }
    for (auto &d : elemDense)
      std::vector<double>().swap(d);
  }

◆ rowRange()

auto MoFEM::BlockStorage::rowRange ( const UId & row ) const

inline

range of blocks with given row entity uid

Definition at line 488 of file Schur.cpp.

                                             {
    return std::equal_range(blockIndex.begin(), blockIndex.end(), row,
                            RowUIdLess());
  }

Member Data Documentation

◆ blockIndex

std::vector<Indexes> MoFEM::BlockStorage::blockIndex

blocks sorted by (row uid, col uid)

Definition at line 373 of file Schur.cpp.

◆ colOrder

std::vector<int> MoFEM::BlockStorage::colOrder

blocks sorted by (col uid, row uid)

Definition at line 375 of file Schur.cpp.

◆ data

std::vector<double> MoFEM::BlockStorage::data

blocks not in A00, allocated on first use

Definition at line 387 of file Schur.cpp.

◆ dataSize

size_t MoFEM::BlockStorage::dataSize = 0

required size of data

Definition at line 386 of file Schur.cpp.

◆ elemData

std::vector<std::vector<double> > MoFEM::BlockStorage::elemData

A00 element buffers.

Definition at line 380 of file Schur.cpp.

◆ elemDense

std::vector<std::vector<double> > MoFEM::BlockStorage::elemDense

dense factors (fallback)

Definition at line 382 of file Schur.cpp.

◆ elemEntities

std::vector<ElemEntity> MoFEM::BlockStorage::elemEntities

Definition at line 379 of file Schur.cpp.

◆ elemPrec

std::vector<std::vector<double> > MoFEM::BlockStorage::elemPrec

preconditioner buffers

Definition at line 381 of file Schur.cpp.

◆ elems

std::vector<Elem> MoFEM::BlockStorage::elems

Definition at line 378 of file Schur.cpp.

◆ factorStorage

FactorStorage MoFEM::BlockStorage::factorStorage = FACTOR_NONE

Definition at line 403 of file Schur.cpp.

◆ feOrder

std::vector<int> MoFEM::BlockStorage::feOrder

blocks sorted by (fe uid, row uid, col uid)

Definition at line 374 of file Schur.cpp.

◆ hasPreconditioner

bool MoFEM::BlockStorage::hasPreconditioner = false

preconditioner blocks are enabled

Definition at line 405 of file Schur.cpp.

◆ maxElemBuffer

size_t MoFEM::BlockStorage::maxElemBuffer = 0

maximal size of element buffer

Definition at line 384 of file Schur.cpp.

◆ maxElemSize

int MoFEM::BlockStorage::maxElemSize = 0

maximal DOFs of element

Definition at line 383 of file Schur.cpp.

◆ nested

bool MoFEM::BlockStorage::nested = false

nested Schur structure has been created

Definition at line 404 of file Schur.cpp.

◆ optBackwardError

double MoFEM::BlockStorage::optBackwardError = 1e-12

-schur_a00_backward_error

Definition at line 411 of file Schur.cpp.

◆ optDense

bool MoFEM::BlockStorage::optDense = false

-schur_a00_dense

Definition at line 408 of file Schur.cpp.

◆ optPivotThreshold

double MoFEM::BlockStorage::optPivotThreshold = 0

-schur_a00_pivot_threshold

Definition at line 409 of file Schur.cpp.

◆ optRcondMin

double MoFEM::BlockStorage::optRcondMin = 1e-12

-schur_a00_rcond_min

Definition at line 410 of file Schur.cpp.

◆ patterns

std::vector<Pattern> MoFEM::BlockStorage::patterns

Definition at line 377 of file Schur.cpp.

◆ pivots

std::vector<__CLPK_integer> MoFEM::BlockStorage::pivots

Definition at line 388 of file Schur.cpp.

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

src/finite_elements/impl/Schur.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ FactorStorage

Member Function Documentation

◆ blockPtr()

◆ checkNotFailed()

◆ colRange()

◆ ensureAllocated()

◆ find()

◆ findMutable()

◆ isFactorised()

◆ lessRowCol()

◆ modified()

◆ resetFactors()

◆ rowRange()

Member Data Documentation

◆ blockIndex

◆ colOrder

◆ data

◆ dataSize

◆ elemData

◆ elemDense

◆ elemEntities

◆ elemPrec

◆ elems

◆ factorStorage

◆ feOrder

◆ hasPreconditioner

◆ maxElemBuffer

◆ maxElemSize

◆ nested

◆ optBackwardError

◆ optDense

◆ optPivotThreshold

◆ optRcondMin

◆ patterns

◆ pivots