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 Types
typedef std::vector< int >	JvarMap

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...
int	mapJvarToCvar (unsigned int jvar, const JvarMap &jvar_map)
	Return an index into a specific coupled variable vector for a given jvar. 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...
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...

Static Public Member Functions
static InputParameters	validParams ()

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

Private Attributes
const std::size_t	_jvar_max_size
	number of nonlinear variables in the system More...
JvarMap	_jvar_map
	look-up table to determine the _coupled_moose_vars index for the jvar parameter More...
std::map< std::string, JvarMap >	_jvar_local_map
	map of local look-up tables for specific parameters 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 17 of file JvarMapInterface.h.

Member Typedef Documentation

JvarMap

template<class T>

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

Definition at line 63 of file JvarMapInterface.h.

Constructor & Destructor Documentation

JvarMapInterfaceBase()

template<class T >

JvarMapInterfaceBase< T >::JvarMapInterfaceBase

(

const InputParameters &

parameters

)

Definition at line 125 of file JvarMapInterface.h.

  : T(parameters),
    _n_args(this->_coupled_standard_moose_vars.size()),
    _jvar_max_size(this->_sys.nVariables()),
    _jvar_map(_jvar_max_size, -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_max_size)
      _jvar_map[number] = it.index();
  }

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

Member Function Documentation

getJvarMap()

template<class T>

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

inline

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

)

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

)

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
	)

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
	)

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 ( )

static

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;
}

Friends And Related Function Documentation

JvarMapIntegratedBCInterface< T >

template<class T>

friend class JvarMapIntegratedBCInterface< T >

friend

Definition at line 110 of file JvarMapInterface.h.

JvarMapKernelInterface< T >

template<class T>

friend class JvarMapKernelInterface< T >

friend

Definition at line 109 of file JvarMapInterface.h.

Member Data Documentation

_jvar_local_map

template<class T>

std::map<std::string, JvarMap> JvarMapInterfaceBase< T >::_jvar_local_map

private

map of local look-up tables for specific parameters

Definition at line 107 of file JvarMapInterface.h.

Referenced by JvarMapInterfaceBase< Kernel >::getParameterJvarMap().

_jvar_map

template<class T>

JvarMap JvarMapInterfaceBase< T >::_jvar_map

private

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

Definition at line 104 of file JvarMapInterface.h.

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

_jvar_max_size

template<class T>

const std::size_t JvarMapInterfaceBase< T >::_jvar_max_size

private

number of nonlinear variables in the system

Definition at line 101 of file JvarMapInterface.h.

Referenced by JvarMapInterfaceBase< Kernel >::getParameterJvarMap(), JvarMapInterfaceBase< Kernel >::JvarMapInterfaceBase(), and JvarMapInterfaceBase< Kernel >::mapJvarToCvar().

_n_args

template<class T>

const unsigned int JvarMapInterfaceBase< T >::_n_args

protected

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