TaggingInterface Class Reference

#include <TaggingInterface.h>

Inheritance diagram for TaggingInterface:

Public Member Functions
	TaggingInterface (const MooseObject *moose_object)
virtual	~TaggingInterface ()
void	useVectorTag (const TagName &tag_name)
void	useMatrixTag (const TagName &tag_name)
void	useVectorTag (TagID tag_id)
void	useMatrixTag (TagID tag_id)
bool	isVectorTagged ()
bool	isMatrixTagged ()
const std::set< TagID > &	getVectorTags () const
const std::set< TagID > &	getMatrixTags () const
void	prepareVectorTag (Assembly &assembly, unsigned int ivar)
	Prepare data for computing element residual the according to active tags. More...
void	prepareVectorTagNeighbor (Assembly &assembly, unsigned int ivar)
	Prepare data for computing element residual the according to active tags for DG and interface kernels. More...
void	prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar)
	Prepare data for computing element jacobian according to the ative tags. More...
void	prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type)
	Prepare data for computing element jacobian according to the ative tags for DG and interface kernels. More...
void	accumulateTaggedLocalResidual ()
	Local residual blocks will be appended by adding the current local kernel residual. More...
void	assignTaggedLocalResidual ()
	Local residual blocks will assigned as the current local kernel residual. More...
void	accumulateTaggedLocalMatrix ()
	Local Jacobian blocks will be appended by adding the current local kernel Jacobian. More...
void	assignTaggedLocalMatrix ()
	Local Jacobian blocks will assigned as the current local kernel Jacobian. More...

Protected Attributes
std::set< TagID >	_vector_tags
	The vectors this Kernel will contribute to. More...
std::set< TagID >	_matrix_tags
	The matrices this Kernel will contribute to. More...
const MooseObject &	_moose_object
	Moose objct this tag works on. More...
const InputParameters &	_tag_params
	Parameters from moose object. More...
SubProblem &	_subproblem
	SubProblem that contains tag info. More...
std::vector< DenseVector< Number > * >	_re_blocks
	Residual blocks Vectors For each Tag. More...
std::vector< DenseMatrix< Number > * >	_ke_blocks
	Kernel blocks Vectors For each Tag. More...
DenseVector< Number >	_local_re
	Holds residual entries as they are accumulated by this Kernel. More...
DenseMatrix< Number >	_local_ke
	Holds residual entries as they are accumulated by this Kernel. More...

Detailed Description

Definition at line 37 of file TaggingInterface.h.

Constructor & Destructor Documentation

TaggingInterface()

TaggingInterface::TaggingInterface

(

const MooseObject *

moose_object

)

Definition at line 50 of file TaggingInterface.C.

  : _moose_object(*moose_object),
    _tag_params(_moose_object.parameters()),
    _subproblem(*_tag_params.getCheckedPointerParam<SubProblem *>("_subproblem"))
{
  auto & vector_tag_names = _tag_params.get<MultiMooseEnum>("vector_tags");

  if (!vector_tag_names.isValid())
    mooseError("MUST provide at least one vector_tag for Kernel: ", _moose_object.name());

  for (auto & vector_tag_name : vector_tag_names)
    _vector_tags.insert(_subproblem.getVectorTagID(vector_tag_name.name()));

  // Add extra vector tags. These tags should be created in the System already, otherwise
  // we can not add the extra tags
  auto & extra_vector_tags = _tag_params.get<std::vector<TagName>>("extra_vector_tags");

  for (auto & vector_tag_name : extra_vector_tags)
    _vector_tags.insert(_subproblem.getVectorTagID(vector_tag_name));

  auto & matrix_tag_names = _tag_params.get<MultiMooseEnum>("matrix_tags");

  if (!matrix_tag_names.isValid())
    mooseError("MUST provide at least one matrix_tag for Kernel: ", _moose_object.name());

  for (auto & matrix_tag_name : matrix_tag_names)
    _matrix_tags.insert(_subproblem.getMatrixTagID(matrix_tag_name.name()));

  auto & extra_matrix_tags = _tag_params.get<std::vector<TagName>>("extra_matrix_tags");

  for (auto & matrix_tag_name : extra_matrix_tags)
    _matrix_tags.insert(_subproblem.getMatrixTagID(matrix_tag_name));

  _re_blocks.resize(_vector_tags.size());
  _ke_blocks.resize(_matrix_tags.size());
}

~TaggingInterface()

TaggingInterface::~TaggingInterface ( )

virtual

Definition at line 206 of file TaggingInterface.C.

{}

Member Function Documentation

accumulateTaggedLocalMatrix()

void TaggingInterface::accumulateTaggedLocalMatrix

(

)

Local Jacobian blocks will be appended by adding the current local kernel Jacobian.

It should be called after the local element matrix has been computed.

Definition at line 193 of file TaggingInterface.C.

Referenced by InterfaceKernel::computeElemNeighJacobian(), DGKernel::computeElemNeighJacobian(), TimeDerivative::computeJacobian(), Kernel::computeJacobian(), ODEKernel::computeJacobian(), IntegratedBC::computeJacobian(), VectorIntegratedBC::computeJacobian(), DiracKernel::computeJacobian(), IntegratedBC::computeJacobianBlock(), VectorIntegratedBC::computeJacobianBlock(), IntegratedBC::computeJacobianBlockScalar(), VectorIntegratedBC::computeJacobianBlockScalar(), InterfaceKernel::computeOffDiagElemNeighJacobian(), DGKernel::computeOffDiagElemNeighJacobian(), ODEKernel::computeOffDiagJacobian(), Kernel::computeOffDiagJacobian(), DiracKernel::computeOffDiagJacobian(), Kernel::computeOffDiagJacobianScalar(), and ConservativeAdvection::fullUpwind().

{
  for (auto & ke : _ke_blocks)
    *ke += _local_ke;
}

accumulateTaggedLocalResidual()

void TaggingInterface::accumulateTaggedLocalResidual

(

)

Local residual blocks will be appended by adding the current local kernel residual.

It should be called after the local element vector has been computed.

Definition at line 179 of file TaggingInterface.C.

Referenced by InterfaceKernel::computeElemNeighResidual(), DGKernel::computeElemNeighResidual(), Kernel::computeResidual(), ODEKernel::computeResidual(), ODETimeKernel::computeResidual(), TimeKernel::computeResidual(), IntegratedBC::computeResidual(), VectorIntegratedBC::computeResidual(), DiracKernel::computeResidual(), and ConservativeAdvection::fullUpwind().

{
  for (auto & re : _re_blocks)
    *re += _local_re;
}

assignTaggedLocalMatrix()

void TaggingInterface::assignTaggedLocalMatrix

(

)

Local Jacobian blocks will assigned as the current local kernel Jacobian.

It should be called after the local element matrix has been computed.

Definition at line 200 of file TaggingInterface.C.

Referenced by NodalEqualValueConstraint::computeJacobian().

{
  for (auto & ke : _ke_blocks)
    *ke = _local_ke;
}

assignTaggedLocalResidual()

void TaggingInterface::assignTaggedLocalResidual

(

)

Local residual blocks will assigned as the current local kernel residual.

It should be called after the local element vector has been computed.

Definition at line 186 of file TaggingInterface.C.

Referenced by NodalEqualValueConstraint::computeResidual().

{
  for (auto & re : _re_blocks)
    *re = _local_re;
}

getMatrixTags()

const std::set<TagID>& TaggingInterface::getMatrixTags ( ) const

inline

Definition at line 57 of file TaggingInterface.h.

{ return _matrix_tags; }

getVectorTags()

const std::set<TagID>& TaggingInterface::getVectorTags ( ) const

inline

Definition at line 55 of file TaggingInterface.h.

{ return _vector_tags; }

isMatrixTagged()

bool TaggingInterface::isMatrixTagged ( )

inline

Definition at line 53 of file TaggingInterface.h.

{ return _matrix_tags.size() > 0; }

isVectorTagged()

bool TaggingInterface::isVectorTagged ( )

inline

Definition at line 51 of file TaggingInterface.h.

{ return _vector_tags.size() > 0; }

prepareMatrixTag()

void TaggingInterface::prepareMatrixTag	(	Assembly &	assembly,
		unsigned int	ivar,
		unsigned int	jvar
	)

Prepare data for computing element jacobian according to the ative tags.

Jacobian blocks for different tags will be extracted from Assembly. A local Jacobian will be zeroed. It should be called right before the local element matrix is computed.

Definition at line 150 of file TaggingInterface.C.

Referenced by InterfaceKernel::computeElemNeighJacobian(), DGKernel::computeElemNeighJacobian(), TimeDerivative::computeJacobian(), Kernel::computeJacobian(), ODEKernel::computeJacobian(), IntegratedBC::computeJacobian(), NodalEqualValueConstraint::computeJacobian(), VectorIntegratedBC::computeJacobian(), DiracKernel::computeJacobian(), IntegratedBC::computeJacobianBlock(), VectorIntegratedBC::computeJacobianBlock(), IntegratedBC::computeJacobianBlockScalar(), VectorIntegratedBC::computeJacobianBlockScalar(), InterfaceKernel::computeOffDiagElemNeighJacobian(), DGKernel::computeOffDiagElemNeighJacobian(), ODEKernel::computeOffDiagJacobian(), Kernel::computeOffDiagJacobian(), DiracKernel::computeOffDiagJacobian(), Kernel::computeOffDiagJacobianScalar(), and ConservativeAdvection::fullUpwind().

{
  _ke_blocks.resize(_matrix_tags.size());
  mooseAssert(_matrix_tags.size() >= 1, "we need at least one active tag");
  auto mat_vector = _matrix_tags.begin();
  for (auto i = beginIndex(_matrix_tags); i < _matrix_tags.size(); i++, ++mat_vector)
    _ke_blocks[i] = &assembly.jacobianBlock(ivar, jvar, *mat_vector);

  _local_ke.resize(_ke_blocks[0]->m(), _ke_blocks[0]->n());
  _local_ke.zero();
}

prepareMatrixTagNeighbor()

void TaggingInterface::prepareMatrixTagNeighbor	(	Assembly &	assembly,
		unsigned int	ivar,
		unsigned int	jvar,
		Moose::DGJacobianType	type
	)

Prepare data for computing element jacobian according to the ative tags for DG and interface kernels.

Jacobian blocks for different tags will be extracted from Assembly. A local Jacobian will be zeroed. It should be called right before the local element matrix is computed.

Definition at line 163 of file TaggingInterface.C.

Referenced by InterfaceKernel::computeElemNeighJacobian(), DGKernel::computeElemNeighJacobian(), InterfaceKernel::computeOffDiagElemNeighJacobian(), and DGKernel::computeOffDiagElemNeighJacobian().

{
  _ke_blocks.resize(_matrix_tags.size());
  mooseAssert(_matrix_tags.size() >= 1, "we need at least one active tag");
  auto mat_vector = _matrix_tags.begin();
  for (auto i = beginIndex(_matrix_tags); i < _matrix_tags.size(); i++, ++mat_vector)
    _ke_blocks[i] = &assembly.jacobianBlockNeighbor(type, ivar, jvar, *mat_vector);

  _local_ke.resize(_ke_blocks[0]->m(), _ke_blocks[0]->n());
  _local_ke.zero();
}

prepareVectorTag()

void TaggingInterface::prepareVectorTag	(	Assembly &	assembly,
		unsigned int	ivar
	)

Prepare data for computing element residual the according to active tags.

Residual blocks for different tags will be extracted from Assembly. A local residual will be zeroed. It should be called right before the local element vector is computed.

Definition at line 124 of file TaggingInterface.C.

Referenced by InterfaceKernel::computeElemNeighResidual(), DGKernel::computeElemNeighResidual(), Kernel::computeResidual(), TimeKernel::computeResidual(), ODEKernel::computeResidual(), ODETimeKernel::computeResidual(), IntegratedBC::computeResidual(), NodalEqualValueConstraint::computeResidual(), VectorIntegratedBC::computeResidual(), DiracKernel::computeResidual(), and ConservativeAdvection::fullUpwind().

{
  _re_blocks.resize(_vector_tags.size());
  mooseAssert(_vector_tags.size() >= 1, "we need at least one active tag");
  auto vector_tag = _vector_tags.begin();
  for (auto i = beginIndex(_vector_tags); i < _vector_tags.size(); i++, ++vector_tag)
    _re_blocks[i] = &assembly.residualBlock(ivar, *vector_tag);

  _local_re.resize(_re_blocks[0]->size());
  _local_re.zero();
}

prepareVectorTagNeighbor()

void TaggingInterface::prepareVectorTagNeighbor	(	Assembly &	assembly,
		unsigned int	ivar
	)

Prepare data for computing element residual the according to active tags for DG and interface kernels.

Residual blocks for different tags will be extracted from Assembly. A local residual will be zeroed. It should be called right before the local element vector is computed.

Definition at line 137 of file TaggingInterface.C.

Referenced by InterfaceKernel::computeElemNeighResidual(), and DGKernel::computeElemNeighResidual().

{
  _re_blocks.resize(_vector_tags.size());
  mooseAssert(_vector_tags.size() >= 1, "we need at least one active tag");
  auto vector_tag = _vector_tags.begin();
  for (auto i = beginIndex(_vector_tags); i < _vector_tags.size(); i++, ++vector_tag)
    _re_blocks[i] = &assembly.residualBlockNeighbor(ivar, *vector_tag);

  _local_re.resize(_re_blocks[0]->size());
  _local_re.zero();
}

useMatrixTag() [1/2]

void TaggingInterface::useMatrixTag

(

const TagName &

tag_name

)

Definition at line 97 of file TaggingInterface.C.

{
  if (!_subproblem.matrixTagExists(tag_name))
    mooseError("Matrix tag ", tag_name, " does not exsit in system");

  _matrix_tags.insert(_subproblem.getMatrixTagID(tag_name));
}

useMatrixTag() [2/2]

void TaggingInterface::useMatrixTag

(

TagID

tag_id

)

Definition at line 115 of file TaggingInterface.C.

{
  if (!_subproblem.matrixTagExists(tag_id))
    mooseError("Matrix tag ", tag_id, " does not exsit in system");

  _matrix_tags.insert(tag_id);
}

useVectorTag() [1/2]

void TaggingInterface::useVectorTag

(

const TagName &

tag_name

)

Definition at line 88 of file TaggingInterface.C.

{
  if (!_subproblem.vectorTagExists(tag_name))
    mooseError("Vector tag ", tag_name, " does not exsit in system");

  _vector_tags.insert(_subproblem.getVectorTagID(tag_name));
}

useVectorTag() [2/2]

void TaggingInterface::useVectorTag

(

TagID

tag_id

)

Definition at line 106 of file TaggingInterface.C.

{
  if (!_subproblem.vectorTagExists(tag_id))
    mooseError("Vector tag ", tag_id, " does not exsit in system");

  _vector_tags.insert(tag_id);
}

Member Data Documentation

_ke_blocks

std::vector<DenseMatrix<Number> *> TaggingInterface::_ke_blocks

protected

Kernel blocks Vectors For each Tag.

Definition at line 140 of file TaggingInterface.h.

Referenced by accumulateTaggedLocalMatrix(), assignTaggedLocalMatrix(), prepareMatrixTag(), prepareMatrixTagNeighbor(), and TaggingInterface().

_local_ke

DenseMatrix<Number> TaggingInterface::_local_ke

protected

Holds residual entries as they are accumulated by this Kernel.

Definition at line 146 of file TaggingInterface.h.

Referenced by accumulateTaggedLocalMatrix(), assignTaggedLocalMatrix(), InterfaceKernel::computeElemNeighJacobian(), DGKernel::computeElemNeighJacobian(), TimeDerivative::computeJacobian(), Kernel::computeJacobian(), VectorKernel::computeJacobian(), ODEKernel::computeJacobian(), IntegratedBC::computeJacobian(), EigenKernel::computeJacobian(), NodalEqualValueConstraint::computeJacobian(), VectorIntegratedBC::computeJacobian(), NonlocalIntegratedBC::computeJacobian(), NonlocalKernel::computeJacobian(), KernelValue::computeJacobian(), KernelGrad::computeJacobian(), DiracKernel::computeJacobian(), IntegratedBC::computeJacobianBlock(), VectorIntegratedBC::computeJacobianBlock(), IntegratedBC::computeJacobianBlockScalar(), VectorIntegratedBC::computeJacobianBlockScalar(), InterfaceKernel::computeOffDiagElemNeighJacobian(), DGKernel::computeOffDiagElemNeighJacobian(), ODEKernel::computeOffDiagJacobian(), Kernel::computeOffDiagJacobian(), EigenKernel::computeOffDiagJacobian(), DiracKernel::computeOffDiagJacobian(), Kernel::computeOffDiagJacobianScalar(), ConservativeAdvection::fullUpwind(), prepareMatrixTag(), and prepareMatrixTagNeighbor().

_local_re

DenseVector<Number> TaggingInterface::_local_re

protected

Holds residual entries as they are accumulated by this Kernel.

Definition at line 143 of file TaggingInterface.h.

Referenced by accumulateTaggedLocalResidual(), assignTaggedLocalResidual(), InterfaceKernel::computeElemNeighResidual(), DGKernel::computeElemNeighResidual(), VectorKernel::computeResidual(), Kernel::computeResidual(), ODETimeKernel::computeResidual(), ODEKernel::computeResidual(), TimeKernel::computeResidual(), EigenKernel::computeResidual(), IntegratedBC::computeResidual(), NodalEqualValueConstraint::computeResidual(), VectorIntegratedBC::computeResidual(), KernelGrad::computeResidual(), KernelValue::computeResidual(), DiracKernel::computeResidual(), ConservativeAdvection::fullUpwind(), prepareVectorTag(), and prepareVectorTagNeighbor().

_matrix_tags

std::set<TagID> TaggingInterface::_matrix_tags

protected

The matrices this Kernel will contribute to.

Definition at line 125 of file TaggingInterface.h.

Referenced by VectorNodalBC::computeJacobian(), NodalBC::computeJacobian(), NodalKernel::computeJacobian(), VectorNodalBC::computeOffDiagJacobian(), NodalBC::computeOffDiagJacobian(), NodalKernel::computeOffDiagJacobian(), getMatrixTags(), isMatrixTagged(), prepareMatrixTag(), prepareMatrixTagNeighbor(), TaggingInterface(), and useMatrixTag().

_moose_object

const MooseObject& TaggingInterface::_moose_object

protected

Moose objct this tag works on.

Definition at line 128 of file TaggingInterface.h.

Referenced by TaggingInterface().

_re_blocks

std::vector<DenseVector<Number> *> TaggingInterface::_re_blocks

protected

Residual blocks Vectors For each Tag.

Definition at line 137 of file TaggingInterface.h.

Referenced by accumulateTaggedLocalResidual(), assignTaggedLocalResidual(), prepareVectorTag(), prepareVectorTagNeighbor(), and TaggingInterface().

_subproblem

SubProblem& TaggingInterface::_subproblem

protected

SubProblem that contains tag info.

Definition at line 134 of file TaggingInterface.h.

Referenced by TaggingInterface(), useMatrixTag(), and useVectorTag().

_tag_params

const InputParameters& TaggingInterface::_tag_params

protected

Parameters from moose object.

Definition at line 131 of file TaggingInterface.h.

Referenced by TaggingInterface().

_vector_tags

std::set<TagID> TaggingInterface::_vector_tags

protected

The vectors this Kernel will contribute to.

Definition at line 122 of file TaggingInterface.h.

Referenced by TimeNodalKernel::computeResidual(), VectorNodalBC::computeResidual(), NodalBC::computeResidual(), NodalKernel::computeResidual(), getVectorTags(), isVectorTagged(), prepareVectorTag(), prepareVectorTagNeighbor(), TaggingInterface(), and useVectorTag().

---

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

• include/interfaces/TaggingInterface.h
• src/interfaces/TaggingInterface.C