FEI Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
BlockDescriptor Class Reference

#include <fei_BlockDescriptor.hpp>

Public Member Functions

 BlockDescriptor ()
virtual ~BlockDescriptor ()
GlobalID getGlobalBlockID ()
void setGlobalBlockID (GlobalID blockID)
int setNumNodesPerElement (int numNodes)
int getNumNodesPerElement () const
int * fieldsPerNodePtr ()
int allocateFieldIDsTable ()
int ** fieldIDsTablePtr ()
bool containsField (int fieldID)
int getNumDistinctFields ()
void setNumDistinctFields (int nFields)
int getInterleaveStrategy () const
void setInterleaveStrategy (int strat)
int getLumpingStrategy () const
void setLumpingStrategy (int strat)
int getNumElements ()
void setNumElements (int numElems)
size_t getNumElemDofFieldsPerElement ()
int setElemDofFieldIDs (int numFields, const int *fieldIDs)
std::vector< int > & getElemDofFieldIDs ()
void setNumElemDOFPerElement (int ndof)
int getNumElemDOFPerElement ()
std::vector< int > & elemDOFEqnNumbers ()
int getNumEqnsPerElement ()
void setNumEqnsPerElement (int numEqns)
int getNumBlkEqnsPerElement ()
void setNumBlkEqnsPerElement (int numBlkEqns)
int getNumActiveNodes ()
void setNumActiveNodes (int num)
int getTotalNumEqns ()
void setTotalNumEqns (int numEqns)

Private Member Functions

 BlockDescriptor (const BlockDescriptor &)
BlockDescriptor & operator= (const BlockDescriptor &)
void destroyFieldArrays ()

Private Attributes

GlobalID blockID_
int numNodesPerElement_
int * numFieldsPerNode_
int ** nodalFieldIDs_
bool fieldIDsAllocated_
int numDistinctFields_
std::vector< int > elemDofFieldIDs_
int interleaveStrategy_
int lumpingStrategy_
int numElements_
int numElemDOFPerElement_
std::vector< int > elemDOFEqnNumbers_
int numEqnsPerElement_
int numBlkEqnsPerElement_
int numActiveNodes_
int totalNumEqns_

Detailed Description

The BlockDescriptor class holds the information that the FEI implementation needs to know about an element-block in the finite element problem:

Global block identifier number of nodes per element in this block list containing the number-of-fields-per-node table containing the field identifiers for those nodal fields interleaveStrategy lumpingStrategy number of elements in this block number of element-DOF per element in this block the first element-DOF equation number for each block total number of equations associated with each element

A block is a collection of homogeneous elements – which means that all elements in a block have the same topology: number of nodes, same solution fields at those nodes, etc.

Usage notes:

There is only one way to set each length/size parameter in this class, and only one way to retrieve each length/size parameter. e.g., you can't set the number of nodes to be one thing, then pass a different value to a function that allocates the fieldsPerNode list. When you set the number of nodes, the fieldsPerNode list is allocated right then. When you retrieve the fieldsPerNode list, you must obtain its length by separately calling the getNumNodesPerElement() function. Similar schemes are in place for the fieldIDsTable, etc.

There are some order-dependencies for these member functions.

  • setNumNodesPerElement should be called before fieldsPerNodePtr() is called, because fieldsPerNodePtr returns a list of length numNodesPerElem.
  • then, in turn, fieldsPerNodePtr() should be called, and the entries of that list should be set, before allocateFieldIDsTable is called, because the row-lengths of the fieldIDsTable are given by the entries in the fieldsPerNode list.
  • naturally allocateFieldIDsTable should be called before fieldIDsTablePtr() is called.
  • setNumElemDOFPerElement should be called before elemDOFEqnNumbersPtr(), because elemDOFEqnNumbersPtr returns a list of length numElemDOFPerElem.

In general, out-of-order function calls will be flagged with a message to stderr.

Definition at line 67 of file fei_BlockDescriptor.hpp.

Constructor & Destructor Documentation

◆ BlockDescriptor() [1/2]

BlockDescriptor::BlockDescriptor ( )

Definition at line 15 of file fei_BlockDescriptor.cpp.

References blockID_, elemDOFEqnNumbers_, elemDofFieldIDs_, fieldIDsAllocated_, interleaveStrategy_, lumpingStrategy_, nodalFieldIDs_, numActiveNodes_, numBlkEqnsPerElement_, numDistinctFields_, numElemDOFPerElement_, numElements_, numEqnsPerElement_, numFieldsPerNode_, numNodesPerElement_, and totalNumEqns_.

Referenced by BlockDescriptor(), and operator=().

◆ ~BlockDescriptor()

BlockDescriptor::~BlockDescriptor ( )
virtual

Definition at line 37 of file fei_BlockDescriptor.cpp.

References destroyFieldArrays(), and numElemDOFPerElement_.

◆ BlockDescriptor() [2/2]

BlockDescriptor::BlockDescriptor ( const BlockDescriptor & )
inlineprivate

Definition at line 127 of file fei_BlockDescriptor.hpp.

References BlockDescriptor(), blockID_, elemDOFEqnNumbers_, elemDofFieldIDs_, fieldIDsAllocated_, interleaveStrategy_, lumpingStrategy_, nodalFieldIDs_, numActiveNodes_, numBlkEqnsPerElement_, numDistinctFields_, numElemDOFPerElement_, numElements_, numEqnsPerElement_, numFieldsPerNode_, numNodesPerElement_, and totalNumEqns_.

Member Function Documentation

◆ getGlobalBlockID()

GlobalID BlockDescriptor::getGlobalBlockID ( )
inline

Definition at line 72 of file fei_BlockDescriptor.hpp.

References blockID_.

Referenced by SNL_FEI_Structure::initElemBlockStructure(), FEDataFilter::initLinSysCore(), and LinSysCoreFilter::initLinSysCore().

◆ setGlobalBlockID()

void BlockDescriptor::setGlobalBlockID ( GlobalID blockID)
inline

Definition at line 73 of file fei_BlockDescriptor.hpp.

References blockID_.

Referenced by SNL_FEI_Structure::addBlock().

◆ setNumNodesPerElement()

int BlockDescriptor::setNumNodesPerElement ( int numNodes)

Number of nodes per element, in this element-block.

Definition at line 60 of file fei_BlockDescriptor.cpp.

References destroyFieldArrays(), numFieldsPerNode_, and numNodesPerElement_.

Referenced by SNL_FEI_Structure::initElemBlock().

◆ getNumNodesPerElement()

int BlockDescriptor::getNumNodesPerElement ( ) const
inline

Definition at line 78 of file fei_BlockDescriptor.hpp.

References numNodesPerElement_.

Referenced by FEDataFilter::generalElemInput(), SNL_FEI_Structure::getBlkScatterIndices_index(), SNL_FEI_Structure::getElemBlockInfo(), FEI_Implementation::getNumNodesPerElement(), SNL_FEI_Structure::getScatterIndices_index(), SNL_FEI_Structure::getScatterIndices_index(), SNL_FEI_Structure::initElem(), FEDataFilter::initLinSysCore(), LinSysCoreFilter::initLinSysCore(), FEDataFilter::sumInElem(), LinSysCoreFilter::sumInElem(), FEDataFilter::sumInElemMatrix(), LinSysCoreFilter::sumInElemMatrix(), FEDataFilter::sumInElemRHS(), and LinSysCoreFilter::sumInElemRHS().

◆ fieldsPerNodePtr()

int * BlockDescriptor::fieldsPerNodePtr ( )

Definition at line 79 of file fei_BlockDescriptor.cpp.

References numFieldsPerNode_.

Referenced by FEDataFilter::generalElemInput(), SNL_FEI_Structure::getNumFieldsPerNode(), SNL_FEI_Structure::getScatterIndices_index(), SNL_FEI_Structure::getScatterIndices_index(), SNL_FEI_Structure::initElemBlock(), FEDataFilter::initLinSysCore(), and LinSysCoreFilter::initLinSysCore().

◆ allocateFieldIDsTable()

int BlockDescriptor::allocateFieldIDsTable ( )

Definition at line 85 of file fei_BlockDescriptor.cpp.

References fei::console_out(), FEI_ENDL, fieldIDsAllocated_, nodalFieldIDs_, numFieldsPerNode_, and numNodesPerElement_.

Referenced by SNL_FEI_Structure::initElemBlock().

◆ fieldIDsTablePtr()

int ** BlockDescriptor::fieldIDsTablePtr ( )
inline

Table of field-IDs. number-of-rows is getNumNodesPerElement() The row-lengths are given by the fieldsPerNodePtr() list.

Definition at line 88 of file fei_BlockDescriptor.hpp.

References nodalFieldIDs_.

Referenced by FEDataFilter::generalElemInput(), SNL_FEI_Structure::getFieldIDsTable(), SNL_FEI_Structure::getScatterIndices_index(), SNL_FEI_Structure::getScatterIndices_index(), SNL_FEI_Structure::initElemBlock(), FEDataFilter::initLinSysCore(), and LinSysCoreFilter::initLinSysCore().

◆ containsField()

bool BlockDescriptor::containsField ( int fieldID)

Definition at line 110 of file fei_BlockDescriptor.cpp.

References nodalFieldIDs_, numFieldsPerNode_, and numNodesPerElement_.

Referenced by FEDataFilter::getBlockFieldNodeSolution(), LinSysCoreFilter::getBlockFieldNodeSolution(), FEDataFilter::getBlockNodeSolution(), LinSysCoreFilter::getBlockNodeSolution(), FEDataFilter::putBlockFieldNodeSolution(), LinSysCoreFilter::putBlockFieldNodeSolution(), FEDataFilter::putBlockNodeSolution(), and LinSysCoreFilter::putBlockNodeSolution().

◆ getNumDistinctFields()

int BlockDescriptor::getNumDistinctFields ( )
inline

Definition at line 92 of file fei_BlockDescriptor.hpp.

References numDistinctFields_.

Referenced by FEDataFilter::generalElemInput().

◆ setNumDistinctFields()

void BlockDescriptor::setNumDistinctFields ( int nFields)
inline

Definition at line 93 of file fei_BlockDescriptor.hpp.

References numDistinctFields_.

Referenced by SNL_FEI_Structure::initElemBlock().

◆ getInterleaveStrategy()

int BlockDescriptor::getInterleaveStrategy ( ) const
inline

Definition at line 95 of file fei_BlockDescriptor.hpp.

References interleaveStrategy_.

Referenced by LinSysCoreFilter::generalElemInput(), SNL_FEI_Structure::getElemBlockInfo(), and SNL_FEI_Structure::initElemBlockStructure().

◆ setInterleaveStrategy()

void BlockDescriptor::setInterleaveStrategy ( int strat)
inline

Definition at line 96 of file fei_BlockDescriptor.hpp.

References interleaveStrategy_.

Referenced by SNL_FEI_Structure::initElemBlock().

◆ getLumpingStrategy()

int BlockDescriptor::getLumpingStrategy ( ) const
inline

Definition at line 98 of file fei_BlockDescriptor.hpp.

References lumpingStrategy_.

Referenced by SNL_FEI_Structure::getElemBlockInfo().

◆ setLumpingStrategy()

void BlockDescriptor::setLumpingStrategy ( int strat)
inline

Definition at line 99 of file fei_BlockDescriptor.hpp.

References lumpingStrategy_.

◆ getNumElements()

int BlockDescriptor::getNumElements ( )
inline

Definition at line 101 of file fei_BlockDescriptor.hpp.

References numElements_.

Referenced by SNL_FEI_Structure::calcTotalNumElemDOF(), FEDataFilter::getBlockElemSolution(), SNL_FEI_Structure::getElemBlockInfo(), FEI_Implementation::getNumBlockElements(), SNL_FEI_Structure::initElemBlockStructure(), SNL_FEI_Structure::initializeBlkEqnMapper(), FEDataFilter::initLinSysCore(), LinSysCoreFilter::initLinSysCore(), and FEDataFilter::putBlockElemSolution().

◆ setNumElements()

void BlockDescriptor::setNumElements ( int numElems)
inline

Definition at line 102 of file fei_BlockDescriptor.hpp.

References numElements_.

Referenced by SNL_FEI_Structure::initElemBlock(), and SNL_FEI_Structure::initElemBlockStructure().

◆ getNumElemDofFieldsPerElement()

size_t BlockDescriptor::getNumElemDofFieldsPerElement ( )
inline

Definition at line 104 of file fei_BlockDescriptor.hpp.

References elemDofFieldIDs_.

◆ setElemDofFieldIDs()

int BlockDescriptor::setElemDofFieldIDs ( int numFields,
const int * fieldIDs )

Definition at line 140 of file fei_BlockDescriptor.cpp.

References elemDOFEqnNumbers_, elemDofFieldIDs_, and numElements_.

Referenced by SNL_FEI_Structure::initElemBlock().

◆ getElemDofFieldIDs()

std::vector< int > & BlockDescriptor::getElemDofFieldIDs ( )
inline

Definition at line 106 of file fei_BlockDescriptor.hpp.

References elemDofFieldIDs_.

◆ setNumElemDOFPerElement()

void BlockDescriptor::setNumElemDOFPerElement ( int ndof)
inline

Definition at line 108 of file fei_BlockDescriptor.hpp.

References numElemDOFPerElement_.

Referenced by SNL_FEI_Structure::initElemBlock().

◆ getNumElemDOFPerElement()

int BlockDescriptor::getNumElemDOFPerElement ( )
inline

Definition at line 109 of file fei_BlockDescriptor.hpp.

References numElemDOFPerElement_.

Referenced by SNL_FEI_Structure::calcTotalNumElemDOF(), FEDataFilter::getBlockElemSolution(), LinSysCoreFilter::getBlockElemSolution(), SNL_FEI_Structure::getElemBlockInfo(), FEI_Implementation::getNumBlockElemDOF(), SNL_FEI_Structure::initializeBlkEqnMapper(), FEDataFilter::putBlockElemSolution(), LinSysCoreFilter::putBlockElemSolution(), and SNL_FEI_Structure::setElemDOFEqnInfo().

◆ elemDOFEqnNumbers()

std::vector< int > & BlockDescriptor::elemDOFEqnNumbers ( )
inline

Definition at line 112 of file fei_BlockDescriptor.hpp.

References elemDOFEqnNumbers_.

Referenced by FEDataFilter::getBlockElemSolution(), LinSysCoreFilter::getBlockElemSolution(), FEDataFilter::putBlockElemSolution(), LinSysCoreFilter::putBlockElemSolution(), and SNL_FEI_Structure::setElemDOFEqnInfo().

◆ getNumEqnsPerElement()

int BlockDescriptor::getNumEqnsPerElement ( )
inline

Definition at line 114 of file fei_BlockDescriptor.hpp.

References numEqnsPerElement_.

Referenced by FEDataFilter::allocElemStuff(), LinSysCoreFilter::allocElemStuff(), FEDataFilter::generalElemInput(), LinSysCoreFilter::generalElemInput(), SNL_FEI_Structure::getElemBlockInfo(), FEI_Implementation::getNumEqnsPerElement(), and SNL_FEI_Structure::initElemBlockStructure().

◆ setNumEqnsPerElement()

void BlockDescriptor::setNumEqnsPerElement ( int numEqns)
inline

Definition at line 115 of file fei_BlockDescriptor.hpp.

References numEqnsPerElement_.

Referenced by SNL_FEI_Structure::initElemBlock().

◆ getNumBlkEqnsPerElement()

int BlockDescriptor::getNumBlkEqnsPerElement ( )
inline

Definition at line 117 of file fei_BlockDescriptor.hpp.

References numBlkEqnsPerElement_.

Referenced by LinSysCoreFilter::generalElemInput().

◆ setNumBlkEqnsPerElement()

void BlockDescriptor::setNumBlkEqnsPerElement ( int numBlkEqns)
inline

Definition at line 118 of file fei_BlockDescriptor.hpp.

References numBlkEqnsPerElement_.

Referenced by SNL_FEI_Structure::initElemBlock().

◆ getNumActiveNodes()

int BlockDescriptor::getNumActiveNodes ( )
inline

Definition at line 120 of file fei_BlockDescriptor.hpp.

References numActiveNodes_.

Referenced by FEI_Implementation::getNumBlockActNodes().

◆ setNumActiveNodes()

void BlockDescriptor::setNumActiveNodes ( int num)
inline

Definition at line 121 of file fei_BlockDescriptor.hpp.

References numActiveNodes_.

◆ getTotalNumEqns()

int BlockDescriptor::getTotalNumEqns ( )
inline

Definition at line 123 of file fei_BlockDescriptor.hpp.

References totalNumEqns_.

Referenced by FEI_Implementation::getNumBlockActEqns().

◆ setTotalNumEqns()

void BlockDescriptor::setTotalNumEqns ( int numEqns)
inline

Definition at line 124 of file fei_BlockDescriptor.hpp.

References totalNumEqns_.

◆ operator=()

BlockDescriptor & BlockDescriptor::operator= ( const BlockDescriptor & )
inlineprivate

Definition at line 135 of file fei_BlockDescriptor.hpp.

References BlockDescriptor().

◆ destroyFieldArrays()

void BlockDescriptor::destroyFieldArrays ( )
private

Definition at line 45 of file fei_BlockDescriptor.cpp.

References nodalFieldIDs_, numFieldsPerNode_, and numNodesPerElement_.

Referenced by setNumNodesPerElement(), and ~BlockDescriptor().

Member Data Documentation

◆ blockID_

GlobalID BlockDescriptor::blockID_
private

Definition at line 142 of file fei_BlockDescriptor.hpp.

Referenced by BlockDescriptor(), BlockDescriptor(), getGlobalBlockID(), and setGlobalBlockID().

◆ numNodesPerElement_

int BlockDescriptor::numNodesPerElement_
private

Definition at line 144 of file fei_BlockDescriptor.hpp.

Referenced by allocateFieldIDsTable(), BlockDescriptor(), BlockDescriptor(), containsField(), destroyFieldArrays(), getNumNodesPerElement(), and setNumNodesPerElement().

◆ numFieldsPerNode_

int* BlockDescriptor::numFieldsPerNode_
private

Definition at line 146 of file fei_BlockDescriptor.hpp.

Referenced by allocateFieldIDsTable(), BlockDescriptor(), BlockDescriptor(), containsField(), destroyFieldArrays(), fieldsPerNodePtr(), and setNumNodesPerElement().

◆ nodalFieldIDs_

int** BlockDescriptor::nodalFieldIDs_
private

Definition at line 148 of file fei_BlockDescriptor.hpp.

Referenced by allocateFieldIDsTable(), BlockDescriptor(), BlockDescriptor(), containsField(), destroyFieldArrays(), and fieldIDsTablePtr().

◆ fieldIDsAllocated_

bool BlockDescriptor::fieldIDsAllocated_
private

Definition at line 150 of file fei_BlockDescriptor.hpp.

Referenced by allocateFieldIDsTable(), BlockDescriptor(), and BlockDescriptor().

◆ numDistinctFields_

int BlockDescriptor::numDistinctFields_
private

Definition at line 152 of file fei_BlockDescriptor.hpp.

Referenced by BlockDescriptor(), BlockDescriptor(), getNumDistinctFields(), and setNumDistinctFields().

◆ elemDofFieldIDs_

std::vector<int> BlockDescriptor::elemDofFieldIDs_
private

Definition at line 154 of file fei_BlockDescriptor.hpp.

Referenced by BlockDescriptor(), BlockDescriptor(), getElemDofFieldIDs(), getNumElemDofFieldsPerElement(), and setElemDofFieldIDs().

◆ interleaveStrategy_

int BlockDescriptor::interleaveStrategy_
private

Definition at line 156 of file fei_BlockDescriptor.hpp.

Referenced by BlockDescriptor(), BlockDescriptor(), getInterleaveStrategy(), and setInterleaveStrategy().

◆ lumpingStrategy_

int BlockDescriptor::lumpingStrategy_
private

Definition at line 157 of file fei_BlockDescriptor.hpp.

Referenced by BlockDescriptor(), BlockDescriptor(), getLumpingStrategy(), and setLumpingStrategy().

◆ numElements_

int BlockDescriptor::numElements_
private

Definition at line 159 of file fei_BlockDescriptor.hpp.

Referenced by BlockDescriptor(), BlockDescriptor(), getNumElements(), setElemDofFieldIDs(), and setNumElements().

◆ numElemDOFPerElement_

int BlockDescriptor::numElemDOFPerElement_
private

Definition at line 160 of file fei_BlockDescriptor.hpp.

Referenced by BlockDescriptor(), BlockDescriptor(), getNumElemDOFPerElement(), setNumElemDOFPerElement(), and ~BlockDescriptor().

◆ elemDOFEqnNumbers_

std::vector<int> BlockDescriptor::elemDOFEqnNumbers_
private

Definition at line 163 of file fei_BlockDescriptor.hpp.

Referenced by BlockDescriptor(), BlockDescriptor(), elemDOFEqnNumbers(), and setElemDofFieldIDs().

◆ numEqnsPerElement_

int BlockDescriptor::numEqnsPerElement_
private

Definition at line 166 of file fei_BlockDescriptor.hpp.

Referenced by BlockDescriptor(), BlockDescriptor(), getNumEqnsPerElement(), and setNumEqnsPerElement().

◆ numBlkEqnsPerElement_

int BlockDescriptor::numBlkEqnsPerElement_
private

Definition at line 167 of file fei_BlockDescriptor.hpp.

Referenced by BlockDescriptor(), BlockDescriptor(), getNumBlkEqnsPerElement(), and setNumBlkEqnsPerElement().

◆ numActiveNodes_

int BlockDescriptor::numActiveNodes_
private

Definition at line 169 of file fei_BlockDescriptor.hpp.

Referenced by BlockDescriptor(), BlockDescriptor(), getNumActiveNodes(), and setNumActiveNodes().

◆ totalNumEqns_

int BlockDescriptor::totalNumEqns_
private

Definition at line 170 of file fei_BlockDescriptor.hpp.

Referenced by BlockDescriptor(), BlockDescriptor(), getTotalNumEqns(), and setTotalNumEqns().

The documentation for this class was generated from the following files:
Generated by doxygen 1.17.0