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
NodeDescriptor Class Reference

#include <fei_NodeDescriptor.hpp>

Public Member Functions

 NodeDescriptor ()
 NodeDescriptor (const NodeDescriptor &src)
virtual ~NodeDescriptor ()
GlobalID getGlobalNodeID () const
void setGlobalNodeID (GlobalID node)
int getNodeNumber () const
void setNodeNumber (int nn)
int getBlkEqnNumber () const
void setBlkEqnNumber (int blkEqn)
int getNumNodalDOF () const
void setNumNodalDOF (int dof)
void addField (int fieldID)
void setFieldEqnNumber (int fieldID, int eqn)
int getNumFields () const
const int * getFieldIDList () const
const int * getFieldEqnNumbers () const
bool getFieldEqnNumber (int fieldID, int &eqnNumber) const
void getFieldID (int eqnNumber, int &fieldID, int &offset_into_field) const
bool operator== (const NodeDescriptor &nd) const
bool operator!= (const NodeDescriptor &nd) const
bool operator< (const NodeDescriptor &nd) const
bool operator> (const NodeDescriptor &nd) const
int getOwnerProc () const
void setOwnerProc (int proc)
void addBlockIndex (unsigned blk_idx)
size_t getNumBlocks () const
const std::vector< unsigned > & getBlockIndexList () const
bool hasBlockIndex (unsigned blk_idx) const

Private Member Functions

NodeDescriptor & operator= (const NodeDescriptor &src)
void allocFieldLists ()
void allocBlockList ()

Private Attributes

GlobalID nodeID_
int nodeNumber_
int numNodalDOF_
int * fieldIDList_
int * fieldEqnNumbers_
int numFields_
int blkEqnNumber_
int ownerProc_
std::vector< unsigned > blockList_

Detailed Description

The NodeDescriptor class holds the information that the FEI implementation needs to know about the nodes in the finite element problem:

Global node identifier number of nodal degrees-of-freedom list of associated field identifiers, with their (global) equation numbers (global) blk-eqn number which processor is this node's owner list of (local) blocks that contain this node

Note: 'block' is used in two contexts here. There are element-blocks, and there are block-equations. Element-blocks refer to the blocks of elements in the finite-element problem, with all elements in a block containing the same number of solution fields per node, etc. Block-equations refer to the small dense sub-blocks of a block-entry sparse matrix. Each node is associated with a number of element-blocks, and each node has exactly one associated global 0-based block-equation number.

Definition at line 36 of file fei_NodeDescriptor.hpp.

Constructor & Destructor Documentation

◆ NodeDescriptor() [1/2]

NodeDescriptor::NodeDescriptor ( )

Definition at line 16 of file fei_NodeDescriptor.cpp.

References blkEqnNumber_, blockList_, fieldEqnNumbers_, fieldIDList_, nodeID_, nodeNumber_, numFields_, numNodalDOF_, and ownerProc_.

Referenced by NodeDescriptor(), operator!=(), operator<(), operator=(), operator==(), and operator>().

◆ NodeDescriptor() [2/2]

NodeDescriptor::NodeDescriptor ( const NodeDescriptor & src)
inline

Definition at line 40 of file fei_NodeDescriptor.hpp.

References blkEqnNumber_, blockList_, fieldEqnNumbers_, fieldIDList_, NodeDescriptor(), nodeID_, nodeNumber_, numFields_, numNodalDOF_, and ownerProc_.

◆ ~NodeDescriptor()

NodeDescriptor::~NodeDescriptor ( )
virtual

Definition at line 32 of file fei_NodeDescriptor.cpp.

References fieldEqnNumbers_, fieldIDList_, and numFields_.

Member Function Documentation

◆ getGlobalNodeID()

GlobalID NodeDescriptor::getGlobalNodeID ( ) const
inline

Definition at line 49 of file fei_NodeDescriptor.hpp.

References nodeID_.

Referenced by SNL_FEI_Structure::calculateSlaveEqns(), SNL_FEI_Structure::finalizeNodeCommMgr(), FEDataFilter::getBlockFieldNodeSolution(), LinSysCoreFilter::getBlockFieldNodeSolution(), FEI_Implementation::getBlockNodeIDList(), FEDataFilter::getBlockNodeSolution(), LinSysCoreFilter::getBlockNodeSolution(), FEDataFilter::getNodalFieldSolution(), LinSysCoreFilter::getNodalFieldSolution(), FEDataFilter::getNodalSolution(), LinSysCoreFilter::getNodalSolution(), SNL_FEI_Structure::getNodeMajorIndices(), SNL_FEI_Structure::getNodeMajorIndices(), SNL_FEI_Structure::getNodeMajorIndices(), SNL_FEI_Structure::getNumSubdomains(), FEDataFilter::getReducedSolnEntry(), SNL_FEI_Structure::getSubdomainList(), NodeCommMgr::informLocal(), SNL_FEI_Structure::isInLocalElement(), NodeCommMgr::packLocalNodesAndData(), NodeCommMgr::packRemoteNodesAndData(), NodeDatabase::synchronize(), and SNL_FEI_Structure::writeEqn2NodeMap().

◆ setGlobalNodeID()

void NodeDescriptor::setGlobalNodeID ( GlobalID node)
inline

Definition at line 50 of file fei_NodeDescriptor.hpp.

References nodeID_.

Referenced by NodeDatabase::initNodeID().

◆ getNodeNumber()

int NodeDescriptor::getNodeNumber ( ) const
inline

Definition at line 52 of file fei_NodeDescriptor.hpp.

References nodeNumber_.

Referenced by SNL_FEI_Structure::calculateSlaveEqns(), convert_eqns_to_nodenumbers_and_dof_ids(), FEDataFilter::generalElemInput(), NodeDatabase::getAssociatedNodeNumber(), FEDataFilter::getNodalFieldSolution(), FEDataFilter::giveToRHS(), FEDataFilter::initLinSysCore(), LinSysCoreFilter::initLinSysCore(), FEDataFilter::loadFEDataMultCR(), FEDataFilter::loadFEDataPenCR(), NodeCommMgr::packLocalNodesAndData(), FEDataFilter::putBlockFieldNodeSolution(), LinSysCoreFilter::putBlockFieldNodeSolution(), FEDataFilter::putNodalFieldData(), LinSysCoreFilter::putNodalFieldData(), LinSysCoreFilter::setLinSysCoreCREqns(), NodeDatabase::synchronize(), and SNL_FEI_Structure::writeEqn2NodeMap().

◆ setNodeNumber()

void NodeDescriptor::setNodeNumber ( int nn)
inline

Definition at line 53 of file fei_NodeDescriptor.hpp.

References nodeNumber_.

Referenced by NodeCommMgr::processRecvMessage(), and NodeDatabase::synchronize().

◆ getBlkEqnNumber()

int NodeDescriptor::getBlkEqnNumber ( ) const
inline

Definition at line 55 of file fei_NodeDescriptor.hpp.

References blkEqnNumber_.

Referenced by SNL_FEI_Structure::getNodeBlkIndices(), SNL_FEI_Structure::getNodeIndices_simple(), SNL_FEI_Structure::getNodeMajorIndices(), SNL_FEI_Structure::initializeBlkEqnMapper(), NodeCommMgr::packLocalNodesAndData(), and SNL_FEI_Structure::writeEqn2NodeMap().

◆ setBlkEqnNumber()

void NodeDescriptor::setBlkEqnNumber ( int blkEqn)
inline

Definition at line 56 of file fei_NodeDescriptor.hpp.

References blkEqnNumber_.

Referenced by NodeCommMgr::processRecvMessage(), and SNL_FEI_Structure::setNodalEqnInfo().

◆ getNumNodalDOF()

int NodeDescriptor::getNumNodalDOF ( ) const
inline

Definition at line 58 of file fei_NodeDescriptor.hpp.

References numNodalDOF_.

Referenced by SNL_FEI_Structure::getNodeIndices_simple(), SNL_FEI_Structure::getNodeMajorIndices(), FEI_Implementation::getNumSolnParams(), SNL_FEI_Structure::initializeBlkEqnMapper(), NodeCommMgr::packLocalNodesAndData(), NodeCommMgr::packRemoteNodesAndData(), and NodeDatabase::synchronize().

◆ setNumNodalDOF()

void NodeDescriptor::setNumNodalDOF ( int dof)
inline

Definition at line 59 of file fei_NodeDescriptor.hpp.

References numNodalDOF_.

Referenced by NodeCommMgr::processRecvMessage(), SNL_FEI_Structure::setNodalEqnInfo(), and NodeDatabase::synchronize().

◆ addField()

void NodeDescriptor::addField ( int fieldID)

Definition at line 39 of file fei_NodeDescriptor.cpp.

References fieldEqnNumbers_, fieldIDList_, fei::listInsert(), numFields_, and fei::sortedListInsert().

Referenced by SNL_FEI_Structure::finalizeActiveNodes(), and NodeCommMgr::processRecvMessage().

◆ setFieldEqnNumber()

void NodeDescriptor::setFieldEqnNumber ( int fieldID,
int eqn )

Definition at line 70 of file fei_NodeDescriptor.cpp.

References fei::binarySearch(), fieldEqnNumbers_, fieldIDList_, and numFields_.

Referenced by NodeCommMgr::processRecvMessage(), SNL_FEI_Structure::setNodalEqnInfo(), and NodeDatabase::synchronize().

◆ getNumFields()

int NodeDescriptor::getNumFields ( ) const
inline

Definition at line 64 of file fei_NodeDescriptor.hpp.

References numFields_.

Referenced by Filter::calculateResidualNorms(), NodeDatabase::countLocalNodalEqns(), NodeDatabase::getAssociatedFieldID(), NodeDatabase::getAssociatedNodeNumber(), FEDataFilter::getBlockNodeSolution(), LinSysCoreFilter::getBlockNodeSolution(), SNL_FEI_Structure::getFieldMajorIndices(), SNL_FEI_Structure::getFieldMajorIndices(), FEDataFilter::getNodalSolution(), LinSysCoreFilter::getNodalSolution(), SNL_FEI_Structure::getNodeMajorIndices(), SNL_FEI_Structure::getNodeMajorIndices(), SNL_FEI_Structure::getNodeMajorIndices(), NodeDatabase::getNodeWithEqn(), SNL_FEI_Structure::initializeBlkEqnMapper(), SNL_FEI_Structure::initializeEqnCommMgr(), SNL_FEI_Structure::nodalEqnsAllSlaves(), NodeCommMgr::packLocalNodesAndData(), NodeCommMgr::packRemoteNodesAndData(), FEDataFilter::putBlockNodeSolution(), LinSysCoreFilter::putBlockNodeSolution(), SNL_FEI_Structure::setNodalEqnInfo(), SNL_FEI_Structure::setNumNodesAndEqnsPerBlock(), NodeDatabase::synchronize(), and SNL_FEI_Structure::writeEqn2NodeMap().

◆ getFieldIDList()

const int * NodeDescriptor::getFieldIDList ( ) const
inline

Definition at line 65 of file fei_NodeDescriptor.hpp.

References fieldIDList_.

Referenced by Filter::calculateResidualNorms(), NodeDatabase::countLocalNodalEqns(), NodeDatabase::getAssociatedFieldID(), NodeDatabase::getAssociatedNodeNumber(), FEDataFilter::getBlockNodeSolution(), LinSysCoreFilter::getBlockNodeSolution(), SNL_FEI_Structure::getFieldMajorIndices(), SNL_FEI_Structure::getFieldMajorIndices(), FEDataFilter::getNodalSolution(), LinSysCoreFilter::getNodalSolution(), SNL_FEI_Structure::getNodeMajorIndices(), SNL_FEI_Structure::getNodeMajorIndices(), SNL_FEI_Structure::getNodeMajorIndices(), NodeDatabase::getNodeWithEqn(), SNL_FEI_Structure::initializeEqnCommMgr(), SNL_FEI_Structure::nodalEqnsAllSlaves(), NodeCommMgr::packLocalNodesAndData(), NodeCommMgr::packRemoteNodesAndData(), FEDataFilter::putBlockNodeSolution(), LinSysCoreFilter::putBlockNodeSolution(), SNL_FEI_Structure::setNodalEqnInfo(), SNL_FEI_Structure::setNumNodesAndEqnsPerBlock(), NodeDatabase::synchronize(), and SNL_FEI_Structure::writeEqn2NodeMap().

◆ getFieldEqnNumbers()

const int * NodeDescriptor::getFieldEqnNumbers ( ) const
inline

Definition at line 66 of file fei_NodeDescriptor.hpp.

References fieldEqnNumbers_.

Referenced by Filter::calculateResidualNorms(), NodeDatabase::getAssociatedFieldID(), NodeDatabase::getAssociatedNodeNumber(), SNL_FEI_Structure::getFieldMajorIndices(), SNL_FEI_Structure::getFieldMajorIndices(), SNL_FEI_Structure::getNodeIndices_simple(), SNL_FEI_Structure::getNodeIndices_simple(), SNL_FEI_Structure::getNodeMajorIndices(), SNL_FEI_Structure::getNodeMajorIndices(), SNL_FEI_Structure::getNodeMajorIndices(), NodeDatabase::getNodeWithEqn(), SNL_FEI_Structure::initializeBlkEqnMapper(), SNL_FEI_Structure::initializeEqnCommMgr(), SNL_FEI_Structure::nodalEqnsAllSlaves(), NodeCommMgr::packLocalNodesAndData(), FEDataFilter::putBlockNodeSolution(), LinSysCoreFilter::putBlockNodeSolution(), NodeDatabase::synchronize(), and SNL_FEI_Structure::writeEqn2NodeMap().

◆ getFieldEqnNumber()

bool NodeDescriptor::getFieldEqnNumber ( int fieldID,
int & eqnNumber ) const

Given a fieldID, return the first equation number associated with that field at this node.

Parameters
fieldID
eqnNumber
Returns
false if fieldID is not present at this node

Definition at line 89 of file fei_NodeDescriptor.cpp.

References fei::binarySearch(), fieldEqnNumbers_, fieldIDList_, and numFields_.

Referenced by convert_field_and_nodes_to_eqns(), FEDataFilter::getBlockFieldNodeSolution(), LinSysCoreFilter::getBlockFieldNodeSolution(), FEDataFilter::getBlockNodeSolution(), LinSysCoreFilter::getBlockNodeSolution(), fei::DirichletBCManager::getEqnNumber(), SNL_FEI_Structure::getEqnNumber(), SNL_FEI_Structure::getEqnNumbers(), SNL_FEI_Structure::getEqnNumbers(), FEDataFilter::getNodalFieldSolution(), LinSysCoreFilter::getNodalFieldSolution(), FEDataFilter::getNodalSolution(), LinSysCoreFilter::getNodalSolution(), FEDataFilter::loadFEDataMultCR(), FEDataFilter::loadFEDataPenCR(), FEDataFilter::loadNodeBCs(), FEDataFilter::putBlockFieldNodeSolution(), LinSysCoreFilter::putBlockFieldNodeSolution(), FEDataFilter::putNodalFieldSolution(), LinSysCoreFilter::putNodalFieldSolution(), LinSysCoreFilter::resolveConflictingCRs(), LinSysCoreFilter::setLinSysCoreCREqns(), SNL_FEI_Structure::storeLocalNodeIndices(), LinSysCoreFilter::storeNodalColumnCoefs(), SNL_FEI_Structure::storeNodalColumnIndices(), LinSysCoreFilter::storeNodalRowCoefs(), SNL_FEI_Structure::storeNodalRowIndices(), LinSysCoreFilter::storeNodalSendEqn(), SNL_FEI_Structure::storeNodalSendIndex(), SNL_FEI_Structure::storeNodalSendIndices(), LinSysCoreFilter::storePenNodeData(), and LinSysCoreFilter::storePenNodeSendData().

◆ getFieldID()

void NodeDescriptor::getFieldID ( int eqnNumber,
int & fieldID,
int & offset_into_field ) const

Given an equation-number, get the associated fieldID and offset-into-field. throws an exception if the equation-number is not associated with this node.

Definition at line 104 of file fei_NodeDescriptor.cpp.

References fieldEqnNumbers_, fieldIDList_, numFields_, and numNodalDOF_.

Referenced by convert_eqns_to_nodenumbers_and_dof_ids(), FEDataFilter::enforceEssentialBCs(), FEDataFilter::getReducedSolnEntry(), FEDataFilter::giveToLocalReducedMatrix(), FEDataFilter::giveToLocalReducedRHS(), FEDataFilter::giveToMatrix(), and FEDataFilter::giveToRHS().

◆ operator==()

bool NodeDescriptor::operator== ( const NodeDescriptor & nd) const
inline

Definition at line 81 of file fei_NodeDescriptor.hpp.

References NodeDescriptor(), and nodeID_.

◆ operator!=()

bool NodeDescriptor::operator!= ( const NodeDescriptor & nd) const
inline

Definition at line 84 of file fei_NodeDescriptor.hpp.

References NodeDescriptor(), and nodeID_.

◆ operator<()

bool NodeDescriptor::operator< ( const NodeDescriptor & nd) const
inline

Definition at line 87 of file fei_NodeDescriptor.hpp.

References NodeDescriptor(), and nodeID_.

◆ operator>()

bool NodeDescriptor::operator> ( const NodeDescriptor & nd) const
inline

Definition at line 90 of file fei_NodeDescriptor.hpp.

References NodeDescriptor(), and nodeID_.

◆ getOwnerProc()

int NodeDescriptor::getOwnerProc ( ) const
inline

Definition at line 93 of file fei_NodeDescriptor.hpp.

References ownerProc_.

Referenced by Filter::calculateResidualNorms(), SNL_FEI_Structure::calculateSlaveEqns(), NodeDatabase::countLocalNodalEqns(), SNL_FEI_Structure::finalizeNodeCommMgr(), SNL_FEI_Structure::initializeEqnCommMgr(), SNL_FEI_Structure::initMultCRStructure(), SNL_FEI_Structure::initPenCRStructure(), LinSysCoreFilter::loadCRMult(), LinSysCoreFilter::loadCRPen(), NodeCommMgr::packRemoteNodesAndData(), FEDataFilter::putBlockNodeSolution(), LinSysCoreFilter::putBlockNodeSolution(), SNL_FEI_Structure::setNodalEqnInfo(), LinSysCoreFilter::storeNodalSendEqn(), SNL_FEI_Structure::storeNodalSendIndex(), SNL_FEI_Structure::storeNodalSendIndices(), LinSysCoreFilter::storePenNodeSendData(), NodeDatabase::synchronize(), and SNL_FEI_Structure::writeEqn2NodeMap().

◆ setOwnerProc()

void NodeDescriptor::setOwnerProc ( int proc)
inline

Definition at line 94 of file fei_NodeDescriptor.hpp.

References ownerProc_.

Referenced by SNL_FEI_Structure::finalizeActiveNodes().

◆ addBlockIndex()

void NodeDescriptor::addBlockIndex ( unsigned blk_idx)
inline

Definition at line 96 of file fei_NodeDescriptor.hpp.

References blockList_, and fei::sortedListInsert().

Referenced by SNL_FEI_Structure::finalizeActiveNodes(), and NodeCommMgr::processRecvMessage().

◆ getNumBlocks()

size_t NodeDescriptor::getNumBlocks ( ) const
inline

Definition at line 99 of file fei_NodeDescriptor.hpp.

References blockList_.

Referenced by NodeCommMgr::packLocalNodesAndData(), and NodeCommMgr::packRemoteNodesAndData().

◆ getBlockIndexList()

const std::vector< unsigned > & NodeDescriptor::getBlockIndexList ( ) const
inline

Definition at line 100 of file fei_NodeDescriptor.hpp.

References blockList_.

Referenced by NodeCommMgr::packLocalNodesAndData(), NodeCommMgr::packRemoteNodesAndData(), and SNL_FEI_Structure::setNumNodesAndEqnsPerBlock().

◆ hasBlockIndex()

bool NodeDescriptor::hasBlockIndex ( unsigned blk_idx) const

Definition at line 131 of file fei_NodeDescriptor.cpp.

References fei::binarySearch(), and blockList_.

Referenced by FEI_Implementation::getBlockNodeIDList(), FEDataFilter::putBlockNodeSolution(), and LinSysCoreFilter::putBlockNodeSolution().

◆ operator=()

NodeDescriptor & NodeDescriptor::operator= ( const NodeDescriptor & src)
private

References NodeDescriptor().

◆ allocFieldLists()

void NodeDescriptor::allocFieldLists ( )
private

◆ allocBlockList()

void NodeDescriptor::allocBlockList ( )
private

Member Data Documentation

◆ nodeID_

GlobalID NodeDescriptor::nodeID_
private

Definition at line 109 of file fei_NodeDescriptor.hpp.

Referenced by getGlobalNodeID(), NodeDescriptor(), NodeDescriptor(), operator!=(), operator<(), operator==(), operator>(), and setGlobalNodeID().

◆ nodeNumber_

int NodeDescriptor::nodeNumber_
private

Definition at line 111 of file fei_NodeDescriptor.hpp.

Referenced by getNodeNumber(), NodeDescriptor(), NodeDescriptor(), and setNodeNumber().

◆ numNodalDOF_

int NodeDescriptor::numNodalDOF_
private

Definition at line 113 of file fei_NodeDescriptor.hpp.

Referenced by getFieldID(), getNumNodalDOF(), NodeDescriptor(), NodeDescriptor(), and setNumNodalDOF().

◆ fieldIDList_

int* NodeDescriptor::fieldIDList_
private

Definition at line 115 of file fei_NodeDescriptor.hpp.

Referenced by addField(), getFieldEqnNumber(), getFieldID(), getFieldIDList(), NodeDescriptor(), NodeDescriptor(), setFieldEqnNumber(), and ~NodeDescriptor().

◆ fieldEqnNumbers_

int* NodeDescriptor::fieldEqnNumbers_
private

Definition at line 116 of file fei_NodeDescriptor.hpp.

Referenced by addField(), getFieldEqnNumber(), getFieldEqnNumbers(), getFieldID(), NodeDescriptor(), NodeDescriptor(), setFieldEqnNumber(), and ~NodeDescriptor().

◆ numFields_

int NodeDescriptor::numFields_
private

Definition at line 120 of file fei_NodeDescriptor.hpp.

Referenced by addField(), getFieldEqnNumber(), getFieldID(), getNumFields(), NodeDescriptor(), NodeDescriptor(), setFieldEqnNumber(), and ~NodeDescriptor().

◆ blkEqnNumber_

int NodeDescriptor::blkEqnNumber_
private

Definition at line 122 of file fei_NodeDescriptor.hpp.

Referenced by getBlkEqnNumber(), NodeDescriptor(), NodeDescriptor(), and setBlkEqnNumber().

◆ ownerProc_

int NodeDescriptor::ownerProc_
private

Definition at line 124 of file fei_NodeDescriptor.hpp.

Referenced by getOwnerProc(), NodeDescriptor(), NodeDescriptor(), and setOwnerProc().

◆ blockList_

std::vector<unsigned> NodeDescriptor::blockList_
private

Definition at line 126 of file fei_NodeDescriptor.hpp.

Referenced by addBlockIndex(), getBlockIndexList(), getNumBlocks(), hasBlockIndex(), NodeDescriptor(), and NodeDescriptor().

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