JvarMapInterfaceBase< T > Class Template Reference

Base class ("Veneer") that implements the actual mapping from 'jvar' in into the _coupled_moose_vars array. More...

#include <JvarMapInterface.h>

Inheritance diagram for JvarMapInterfaceBase< T >:

Public Member Functions
	JvarMapInterfaceBase (const InputParameters &parameters)
unsigned int	mapJvarToCvar (unsigned int jvar)
	Return index into the _coupled_moose_vars array for a given jvar. More...
bool	mapJvarToCvar (unsigned int jvar, unsigned int &cvar)
	Set the cvar value to the mapped jvar value and return true if the mapping exists. More...

Private Attributes
std::vector< int >	_jvar_map
	look-up table to determine the _coupled_moose_vars index for the jvar parameter More...

Friends
class	JvarMapKernelInterface< T >
class	JvarMapIntegratedBCInterface< T >

Detailed Description

template<class T>
class JvarMapInterfaceBase< T >

Base class ("Veneer") that implements the actual mapping from 'jvar' in into the _coupled_moose_vars array.

Definition at line 18 of file JvarMapInterface.h.

Constructor & Destructor Documentation

JvarMapInterfaceBase()

template<class T >

JvarMapInterfaceBase< T >::JvarMapInterfaceBase

(

const InputParameters &

parameters

)

Definition at line 89 of file JvarMapInterface.h.

  : T(parameters), _jvar_map(this->_fe_problem.getNonlinearSystemBase().nVariables(), -1)
{
  // populate map;
  for (auto it : Moose::enumerate(this->_coupled_moose_vars))
  {
    auto number = it.value()->number();

    // skip AuxVars as off-diagonal jacobian entries are not calculated for them
    if (number < _jvar_map.size())
      _jvar_map[number] = it.index();
  }

  // mark the kernel variable for the check in computeOffDiagJacobian
  _jvar_map[this->_var.number()] = 0;
}

Member Function Documentation

mapJvarToCvar() [1/2]

template<class T >

unsigned int JvarMapInterfaceBase< T >::mapJvarToCvar

(

unsigned int

jvar

)

Return index into the _coupled_moose_vars array for a given jvar.

Definition at line 108 of file JvarMapInterface.h.

{
  mooseAssert(jvar < _jvar_map.size(),
              "Calling mapJvarToCvar for an invalid Moose variable number. Maybe an AuxVariable?");
  int cit = _jvar_map[jvar];

  mooseAssert(cit >= 0, "Calling mapJvarToCvar for a variable not coupled to this kernel.");
  return cit;
}

mapJvarToCvar() [2/2]

template<class T>

bool JvarMapInterfaceBase< T >::mapJvarToCvar	(	unsigned int	jvar,
		unsigned int &	cvar
	)

Set the cvar value to the mapped jvar value and return true if the mapping exists.

Otherwise return false.

Parameters

[in]	jvar	Variable number passed as argument to computeQpOffDiagJacobian
[out]	cvar	Corresponding index into the _coupled_moose_vars array

Returns

true if the requested variable is coupled, false otherwise

Friends And Related Function Documentation

JvarMapIntegratedBCInterface< T >

template<class T>

friend class JvarMapIntegratedBCInterface< T >

friend

Definition at line 85 of file JvarMapInterface.h.

JvarMapKernelInterface< T >

template<class T>

friend class JvarMapKernelInterface< T >

friend

Definition at line 84 of file JvarMapInterface.h.

Member Data Documentation

_jvar_map

template<class T>

std::vector<int> JvarMapInterfaceBase< T >::_jvar_map

private

look-up table to determine the _coupled_moose_vars index for the jvar parameter

Definition at line 82 of file JvarMapInterface.h.

Referenced by JvarMapIntegratedBCInterface< T >::computeJacobianBlock(), JvarMapKernelInterface< Kernel >::computeOffDiagJacobian(), JvarMapInterfaceBase< Kernel >::JvarMapInterfaceBase(), and JvarMapInterfaceBase< Kernel >::mapJvarToCvar().

---

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

• include/utils/JvarMapInterface.h