JvarMapKernelInterface< T > Class Template Reference

Interface class ("Veneer") for Kernel to provide a mapping from 'jvar' in computeQpOffDiagJacobian into the _coupled_moose_vars array. More...

#include <JvarMapInterface.h>

Inheritance diagram for JvarMapKernelInterface< T >:

Public Types
typedef std::vector< int >	JvarMap

Public Member Functions
	JvarMapKernelInterface (const InputParameters &parameters)
virtual void	computeOffDiagJacobian (unsigned int jvar) override
unsigned int	mapJvarToCvar (unsigned int jvar)
	Return index into the _coupled_moose_vars array for a given jvar. More...
int	mapJvarToCvar (unsigned int jvar, const JvarMap &jvar_map)
	Return an index into a specific coupled variable vector 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...
const JvarMap &	getJvarMap ()
	Obtain the map connecting libmesh variable ID number to its position in the _coupled_moose_vars vector. More...
const JvarMap &	getParameterJvarMap (std::string parameter_name)
	Make a specific map for a given parameter name representing a couple variable (vector) More...

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const unsigned int	_n_args
	number of coupled moose variables More...

Detailed Description

template<class T>
class JvarMapKernelInterface< T >

Interface class ("Veneer") for Kernel to provide a mapping from 'jvar' in computeQpOffDiagJacobian into the _coupled_moose_vars array.

This class is useful in conjunction with DerivativeMaterialInterface, where vectors of material property derivatives with respect to all coupled variables (iterating over _coupled_moose_vars array) are generated. The mapping enabled the look up of the correct material property derivatives for the current jvar.

Definition at line 30 of file JvarMapInterface.h.

Member Typedef Documentation

JvarMap

template<class T>

typedef std::vector<int> JvarMapInterfaceBase< T >::JvarMap

inherited

Definition at line 63 of file JvarMapInterface.h.

Constructor & Destructor Documentation

JvarMapKernelInterface()

template<class T >

JvarMapKernelInterface< T >::JvarMapKernelInterface

(

const InputParameters &

parameters

)

Definition at line 188 of file JvarMapInterface.h.

  : JvarMapInterfaceBase<T>(parameters)
{
}

Member Function Documentation

computeOffDiagJacobian()

template<class T >

void JvarMapKernelInterface< T >::computeOffDiagJacobian ( unsigned int  jvar )

overridevirtual

Definition at line 201 of file JvarMapInterface.h.

{
  // the Kernel is not coupled to the variable; no need to loop over QPs
  if (this->_jvar_map[jvar] < 0)
    return;

  // call the underlying class' off-diagonal Jacobian
  T::computeOffDiagJacobian(jvar);
}

getJvarMap()

template<class T>

const JvarMap& JvarMapInterfaceBase< T >::getJvarMap ( )

inlineinherited

Obtain the map connecting libmesh variable ID number to its position in the _coupled_moose_vars vector.

Definition at line 80 of file JvarMapInterface.h.

{ return _jvar_map; }

getParameterJvarMap()

template<class T >

const JvarMapInterfaceBase< T >::JvarMap & JvarMapInterfaceBase< T >::getParameterJvarMap ( std::string  parameter_name )

inherited

Make a specific map for a given parameter name representing a couple variable (vector)

Definition at line 168 of file JvarMapInterface.h.

{
  auto & jvar_map = _jvar_local_map[parameter_name];
  jvar_map.assign(_jvar_max_size, -1);

  // populate local map
  const auto num = this->coupledComponents(parameter_name);
  for (std::size_t i = 0; i < num; ++i)
  {
    const auto number = this->getVar(parameter_name, i)->number();

    // skip AuxVars as off-diagonal jacobian entries are not calculated for them
    if (number < _jvar_max_size)
      jvar_map[number] = i;
  }

  return jvar_map;
}

mapJvarToCvar() [1/3]

template<class T >

unsigned int JvarMapInterfaceBase< T >::mapJvarToCvar ( unsigned int  jvar )

inherited

Return index into the _coupled_moose_vars array for a given jvar.

Definition at line 147 of file JvarMapInterface.h.

{
  mooseAssert(jvar < _jvar_max_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/3]

template<class T >

int JvarMapInterfaceBase< T >::mapJvarToCvar ( unsigned int  jvar, const JvarMap &  jvar_map  )

inherited

Return an index into a specific coupled variable vector for a given jvar.

A negative return value indicates that the jvar value does not point to a variable in the couple variable vector corresponding to the mapped parameter.

Definition at line 159 of file JvarMapInterface.h.

{
  mooseAssert(jvar < _jvar_max_size,
              "Calling mapJvarToCvar for an invalid Moose variable number. Maybe an AuxVariable?");
  return jvar_map[jvar];
}

mapJvarToCvar() [3/3]

template<class T>

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

inherited

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

validParams()

template<class T >

InputParameters JvarMapInterfaceBase< T >::validParams ( )

staticinherited

Definition at line 115 of file JvarMapInterface.h.

{
  auto params = T::validParams();
  params.addCoupledVar("args", "Vector of nonlinear variable arguments this object depends on");
  params.deprecateCoupledVar("args", "coupled_variables", "02/07/2024");

  return params;
}

Member Data Documentation

_n_args

template<class T>

const unsigned int JvarMapInterfaceBase< T >::_n_args

protectedinherited

number of coupled moose variables

Definition at line 97 of file JvarMapInterface.h.

---

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

• include/utils/JvarMapInterface.h