Base class ("Veneer") that implements the actual mapping from 'jvar' in into the _coupled_moose_vars array. More...
#include <JvarMapInterface.h>
Public Types | |
typedef std::vector< int > | JvarMap |
Public Member Functions | |
JvarMapInterfaceBase (const InputParameters ¶meters) | |
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 > |
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.
typedef std::vector<int> JvarMapInterfaceBase< T >::JvarMap |
Definition at line 63 of file JvarMapInterface.h.
JvarMapInterfaceBase< T >::JvarMapInterfaceBase | ( | const InputParameters & | parameters | ) |
Definition at line 125 of file JvarMapInterface.h.
|
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.
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.
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.
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.
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.
[in] | jvar | Variable number passed as argument to computeQpOffDiagJacobian |
[out] | cvar | Corresponding index into the _coupled_moose_vars array |
|
static |
Definition at line 115 of file JvarMapInterface.h.
|
friend |
Definition at line 110 of file JvarMapInterface.h.
|
friend |
Definition at line 109 of file JvarMapInterface.h.
|
private |
map of local look-up tables for specific parameters
Definition at line 107 of file JvarMapInterface.h.
Referenced by JvarMapInterfaceBase< Kernel >::getParameterJvarMap().
|
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().
|
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().
|
protected |
number of coupled moose variables
Definition at line 97 of file JvarMapInterface.h.