#include <fei_FieldMask.hpp>

Public Member Functions
	FieldMask ()
	FieldMask (const FieldMask &fm)
	FieldMask (int numFields, const int fieldIDs, const int fieldSizes)
virtual	~FieldMask ()
int	getMaskID ()
void	addField (int fieldID, int fieldSize)
bool	hasFieldID (int fieldID) const
size_t	getNumFields () const
int	getNumIndices () const
void	setNumIndices (int numInd)
std::vector< int > &	getFieldIDs ()
const std::vector< int > &	getFieldIDs () const
std::vector< int > &	getFieldSizes ()
const std::vector< int > &	getFieldSizes () const
int	getFieldEqnOffset (int fieldID, int &offset) const
bool	operator== (const FieldMask &fm) const
bool	operator!= (const FieldMask &fm) const
bool	isSubSetOf (const FieldMask &fm) const

Static Public Member Functions
static int	calculateMaskID (int numFields, const int *fieldIDs)
static int	calculateMaskID (const FieldMask &fm, int fieldID)

Private Member Functions
FieldMask &	operator= (const FieldMask &src)
int	calculateMaskID ()

Private Attributes
int	maskID_
std::vector< int >	fieldIDs_
std::vector< int >	fieldSizes_
std::vector< int >	fieldEqnOffsets_
int	numFields_
int	numIndices_

Detailed Description

Internal implementation class. A FieldMask describes the layout of the fields associated with an identifier. Each identifier Record should have a pointer to a FieldMask. Each FieldMask will generally be shared by a large number of identifier records. (i.e., the number of field-mask objects in memory will be small – it will be the number of distinct fields-per-node combinations in the mesh. Example: If a problem has two fields (say temperature and displacement) and some nodes have 1 field, some have the other, and some have both, then there would be a total of 3 field-masks.

Definition at line 29 of file fei_FieldMask.hpp.

Constructor & Destructor Documentation

◆ FieldMask() [1/3]

fei::FieldMask::FieldMask ( )

Default Constructor

Definition at line 19 of file fei_FieldMask.cpp.

References fieldEqnOffsets_, fieldIDs_, fieldSizes_, maskID_, numFields_, and numIndices_.

Referenced by calculateMaskID(), FieldMask(), isSubSetOf(), operator!=(), operator=(), and operator==().

◆ FieldMask() [2/3]

fei::FieldMask::FieldMask ( const FieldMask & fm )

Copy Constructor

Definition at line 29 of file fei_FieldMask.cpp.

References fieldEqnOffsets_, fieldIDs_, FieldMask(), fieldSizes_, maskID_, numFields_, and numIndices_.

◆ FieldMask() [3/3]

fei::FieldMask::FieldMask	(	int	numFields,
		const int *	fieldIDs,
		const int *	fieldSizes )

Construct with initial fields

Definition at line 39 of file fei_FieldMask.cpp.

References addField(), fieldEqnOffsets_, fieldIDs_, fieldSizes_, and maskID_.

◆ ~FieldMask()

fei::FieldMask::~FieldMask ( )

virtual

Destructor

Definition at line 52 of file fei_FieldMask.cpp.

Member Function Documentation

◆ getMaskID()

int fei::FieldMask::getMaskID ( )

inline

Return the mask-id for this object.

Definition at line 46 of file fei_FieldMask.hpp.

References maskID_.

Referenced by snl_fei::RecordCollection::initRecords(), snl_fei::RecordCollection::initRecords(), snl_fei::RecordMsgHandler::mergeMaskIDs(), snl_fei::RecordMsgHandler::packMaskIDs(), and test_misc_FieldMask().

◆ calculateMaskID() [1/3]

int fei::FieldMask::calculateMaskID	(	int	numFields,
		const int *	fieldIDs )

static

Return the mask-id that corresponds to the specified data.

Definition at line 126 of file fei_FieldMask.cpp.

Referenced by addField(), calculateMaskID(), and test_misc_FieldMask().

◆ calculateMaskID() [2/3]

int fei::FieldMask::calculateMaskID	(	const FieldMask &	fm,
		int	fieldID )

static

Return the mask-id that corresponds to the specified data.

Definition at line 136 of file fei_FieldMask.cpp.

References FieldMask(), maskID_, and numFields_.

◆ addField()

void fei::FieldMask::addField	(	int	fieldID,
		int	fieldSize )

Add a field-id to this object.

Definition at line 87 of file fei_FieldMask.cpp.

References fei::binarySearch(), calculateMaskID(), fieldEqnOffsets_, fieldIDs_, fieldSizes_, maskID_, numFields_, and numIndices_.

Referenced by FieldMask(), snl_fei::RecordCollection::initRecords(), and test_misc_FieldMask().

◆ hasFieldID()

bool fei::FieldMask::hasFieldID ( int fieldID ) const

inline

Query whether the specified field is contained in this field-mask.

Definition at line 61 of file fei_FieldMask.hpp.

References fieldIDs_.

Referenced by snl_fei::RecordCollection::initRecords(), and isSubSetOf().

◆ getNumFields()

size_t fei::FieldMask::getNumFields ( ) const

inline

Return the number of fields in this field-mask.

Definition at line 69 of file fei_FieldMask.hpp.

References fieldIDs_.

Referenced by fei::VectorSpace::getNumFields(), snl_fei::RecordMsgHandler::mergeMaskIDs(), and test_misc_FieldMask().

◆ getNumIndices()

int fei::FieldMask::getNumIndices ( ) const

inline

Return the number of global indices corresponding to the set of fields represented by this mask. This is sum(fieldSizes[i]).

Definition at line 74 of file fei_FieldMask.hpp.

References numIndices_.

Referenced by fei::Lookup_Impl::buildDatabases(), snl_fei::RecordMsgHandler::eqnNumbersMsgLength(), fei::Lookup_Impl::getAssociatedFieldID(), fei::VectorSpace::getNumDegreesOfFreedom(), fei::BlkIndexAccessor::operator()(), fei::RecordAttributeCounter::operator()(), snl_fei::RecordMsgHandler::packEqnNumbersMsg(), fei::VectorSpace::setLocalEqnNumbers(), and test_misc_FieldMask().

◆ setNumIndices()

void fei::FieldMask::setNumIndices ( int numInd )

inline

Set the number of global indices corresponding to the set of fields represented by this mask.

Definition at line 79 of file fei_FieldMask.hpp.

References numIndices_.

Referenced by snl_fei::RecordMsgHandler::addFieldMasks().

◆ getFieldIDs() [1/2]

std::vector< int > & fei::FieldMask::getFieldIDs ( )

inline

Return an array of the fields in this field-mask.

Definition at line 82 of file fei_FieldMask.hpp.

References fieldIDs_.

Referenced by fei::Lookup_Impl::getAssociatedFieldID(), fei::VectorSpace::getFields(), snl_fei::RecordMsgHandler::mergeMaskIDs(), fei::ReverseMapper::ReverseMapper(), and test_misc_FieldMask().

◆ getFieldIDs() [2/2]

const std::vector< int > & fei::FieldMask::getFieldIDs ( ) const

inline

Return an array of the fields in this field-mask.

Definition at line 85 of file fei_FieldMask.hpp.

References fieldIDs_.

◆ getFieldSizes() [1/2]

std::vector< int > & fei::FieldMask::getFieldSizes ( )

inline

Return an array of the fieldSizes in this field-mask.

Definition at line 88 of file fei_FieldMask.hpp.

References fieldSizes_.

Referenced by fei::Lookup_Impl::getAssociatedFieldID(), snl_fei::RecordMsgHandler::mergeMaskIDs(), fei::ReverseMapper::ReverseMapper(), and test_misc_FieldMask().

◆ getFieldSizes() [2/2]

const std::vector< int > & fei::FieldMask::getFieldSizes ( ) const

inline

Return an array of the fieldSizes in this field-mask.

Definition at line 91 of file fei_FieldMask.hpp.

References fieldSizes_.

◆ getFieldEqnOffset()

int fei::FieldMask::getFieldEqnOffset	(	int	fieldID,
		int &	offset ) const

Given a field-id, return the offset of the corresponding equation- number in a record's list of equation-numbers. Return 0 if successful, -1 if the fieldID is not found.

Definition at line 56 of file fei_FieldMask.cpp.

References fieldEqnOffsets_, fieldIDs_, and numFields_.

Referenced by fei::Vector_core::copyOutFieldData(), fei::MatrixGraph_Impl2::createSlaveMatrices(), fei::MatrixGraph_Impl2::getConnectivityIndices_multiField(), fei::MatrixGraph_Impl2::getConnectivityIndices_singleField(), fei::Lookup_Impl::getEqnNumber(), snl_fei::RecordCollection::getGlobalIndex(), snl_fei::RecordCollection::getGlobalIndexLocalID(), fei::VectorSpace::getGlobalIndices(), fei::VectorSpace::getGlobalIndices(), fei::VectorSpace::getGlobalIndicesL(), fei::VectorSpace::getGlobalIndicesL(), fei::ReverseMapper::ReverseMapper(), and test_misc_FieldMask().

◆ operator==()

bool fei::FieldMask::operator== ( const FieldMask & fm ) const

inline

Test equality of field-masks.

Definition at line 100 of file fei_FieldMask.hpp.

References FieldMask(), and maskID_.

◆ operator!=()

bool fei::FieldMask::operator!= ( const FieldMask & fm ) const

inline

Test inequality of field-masks.

Definition at line 104 of file fei_FieldMask.hpp.

References FieldMask(), and maskID_.

◆ isSubSetOf()

bool fei::FieldMask::isSubSetOf ( const FieldMask & fm ) const

inline

Query whether 'this' is a subset of the input argument. i.e., query whether all of the fields in 'this' field-mask occur in the input field-mask.

Definition at line 111 of file fei_FieldMask.hpp.

References fieldIDs_, FieldMask(), and hasFieldID().

◆ operator=()

FieldMask & fei::FieldMask::operator= ( const FieldMask & src )

private

References FieldMask().

◆ calculateMaskID() [3/3]

int fei::FieldMask::calculateMaskID ( )

private

Definition at line 121 of file fei_FieldMask.cpp.

References calculateMaskID(), and fieldIDs_.

Referenced by snl_fei::RecordMsgHandler::addFieldMasks(), and snl_fei::RecordCollection::initRecords().

Member Data Documentation

◆ maskID_

int fei::FieldMask::maskID_

private

Definition at line 124 of file fei_FieldMask.hpp.

Referenced by addField(), calculateMaskID(), FieldMask(), FieldMask(), FieldMask(), getMaskID(), operator!=(), and operator==().

◆ fieldIDs_

std::vector<int> fei::FieldMask::fieldIDs_

private

Definition at line 126 of file fei_FieldMask.hpp.

Referenced by addField(), calculateMaskID(), FieldMask(), FieldMask(), FieldMask(), getFieldEqnOffset(), getFieldIDs(), getFieldIDs(), getNumFields(), hasFieldID(), and isSubSetOf().

◆ fieldSizes_

std::vector<int> fei::FieldMask::fieldSizes_

private

Definition at line 127 of file fei_FieldMask.hpp.

Referenced by addField(), FieldMask(), FieldMask(), FieldMask(), getFieldSizes(), and getFieldSizes().

◆ fieldEqnOffsets_

std::vector<int> fei::FieldMask::fieldEqnOffsets_

private

Definition at line 128 of file fei_FieldMask.hpp.

Referenced by addField(), FieldMask(), FieldMask(), FieldMask(), and getFieldEqnOffset().

◆ numFields_

int fei::FieldMask::numFields_

private

Definition at line 130 of file fei_FieldMask.hpp.

Referenced by addField(), calculateMaskID(), FieldMask(), FieldMask(), and getFieldEqnOffset().

◆ numIndices_

int fei::FieldMask::numIndices_

private

Definition at line 131 of file fei_FieldMask.hpp.

Referenced by addField(), FieldMask(), FieldMask(), getNumIndices(), and setNumIndices().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FieldMask() [1/3]

◆ FieldMask() [2/3]

◆ FieldMask() [3/3]

◆ ~FieldMask()

Member Function Documentation

◆ getMaskID()

◆ calculateMaskID() [1/3]

◆ calculateMaskID() [2/3]

◆ addField()

◆ hasFieldID()

◆ getNumFields()

◆ getNumIndices()

◆ setNumIndices()

◆ getFieldIDs() [1/2]

◆ getFieldIDs() [2/2]

◆ getFieldSizes() [1/2]

◆ getFieldSizes() [2/2]

◆ getFieldEqnOffset()

◆ operator==()

◆ operator!=()

◆ isSubSetOf()

◆ operator=()

◆ calculateMaskID() [3/3]

Member Data Documentation

◆ maskID_

◆ fieldIDs_

◆ fieldSizes_

◆ fieldEqnOffsets_

◆ numFields_

◆ numIndices_