Storage for all of the information pretaining to a vector tag. More...

#include <VectorTag.h>

Public Member Functions
	VectorTag ()

	VectorTag (const TagID id, const unsigned int type_index, const TagName name, const Moose::VectorTagType type)

bool	operator== (const VectorTag &other) const

Public Attributes
TagID	_id
	The id associated with the vector tag. More...

TagTypeID	_type_id
	The index for this tag into a vector that contains tags of only its type ordered by ID. More...

TagName	_name
	The name of the vector tag. More...

Moose::VectorTagType	_type
	The type of the vector tag. More...

Detailed Description

Storage for all of the information pretaining to a vector tag.

Definition at line 17 of file VectorTag.h.

Constructor & Destructor Documentation

◆ VectorTag() [1/2]

VectorTag::VectorTag ( )

Definition at line 12 of file VectorTag.C.

   : _id(Moose::INVALID_TAG_ID),
     _type_id(Moose::INVALID_TAG_TYPE_ID),
     _name(""),
     _type(Moose::VECTOR_TAG_ANY)
 {
 }

◆ VectorTag() [2/2]

VectorTag::VectorTag	(	const TagID	id,
		const unsigned int	type_index,
		const TagName	name,
		const Moose::VectorTagType	type
	)

Definition at line 20 of file VectorTag.C.

   : _id(id), _type_id(type_id), _name(name), _type(type)
 {
 }

Member Function Documentation

◆ operator==()

bool VectorTag::operator== ( const VectorTag & other ) const

Definition at line 29 of file VectorTag.C.

 {
   return _id == other._id && _type_id == other._type_id && _name == other._name &&
          _type == other._type;
 }

Member Data Documentation

◆ _id

TagID VectorTag::_id

The id associated with the vector tag.

Definition at line 30 of file VectorTag.h.

Referenced by Assembly::addResidual(), Assembly::addResidualLower(), Assembly::addResidualNeighbor(), Assembly::addResidualScalar(), and operator==().

◆ _name

TagName VectorTag::_name

The name of the vector tag.

Definition at line 50 of file VectorTag.h.

Referenced by operator==().

◆ _type

Moose::VectorTagType VectorTag::_type

The type of the vector tag.

Definition at line 53 of file VectorTag.h.

Referenced by Assembly::addResidual(), Assembly::addResidualLower(), Assembly::addResidualNeighbor(), Assembly::addResidualScalar(), and operator==().

◆ _type_id

TagTypeID VectorTag::_type_id

The index for this tag into a vector that contains tags of only its type ordered by ID.

This is specifically meant for indexing into the result of SubProblem::getVectorTags(type), where type is not VECTOR_TAG_ANY

Example:

| _id | _type_id | _type |

| 0 | 0 | VECTOR_TAG_RESIDUAL | | 1 | 1 | VECTOR_TAG_RESIDUAL | | 2 | 0 | VECTOR_TAG_SOLUTION | | 3 | 2 | VECTOR_TAG_RESIDUAL | | 4 | 1 | VECTOR_TAG_SOLUTION |

Definition at line 47 of file VectorTag.h.

Referenced by Assembly::addCachedResidualDirectly(), Assembly::addResidual(), Assembly::addResidualLower(), Assembly::addResidualNeighbor(), Assembly::addResidualScalar(), Assembly::cacheResidual(), Assembly::cacheResidualNodes(), Assembly::clearCachedResiduals(), operator==(), TaggingInterface::prepareVectorTagLower(), TaggingInterface::prepareVectorTagNeighbor(), Assembly::setResidual(), and Assembly::setResidualNeighbor().

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

include/utils/VectorTag.h
src/utils/VectorTag.C

Public Member Functions

Public Attributes