UserObject template class in which the _phi and _grad_phi shape function data is available and correctly initialized on EXEC_NONLINEAR (the Jacobian calculation). More...
#include <ShapeUserObject.h>
Public Member Functions | |
ShapeUserObject (const InputParameters ¶meters, ShapeType type) | |
const bool & | computeJacobianFlag () const |
check if jacobian is to be computed in user objects More... | |
const std::set< const MooseVariableFEBase * > & | jacobianMooseVariables () const |
Returns the set of variables a Jacobian has been requested for. More... | |
virtual void | executeJacobianWrapper (unsigned int jvar, const std::vector< dof_id_type > &dof_indices) |
This function will be called with the shape functions for jvar initialized. More... | |
Static Public Member Functions | |
static InputParameters | validParams () |
Protected Member Functions | |
virtual void | executeJacobian (unsigned int)=0 |
Implement this function to compute Jacobian terms for this UserObject. More... | |
virtual unsigned int | coupled (const std::string &var_name, unsigned int comp=0) const override |
Returns the index for a coupled variable by name and requests the computation of a Jacobian w.r.t. More... | |
Protected Attributes | |
const VariablePhiValue & | _phi |
shape function values More... | |
const VariablePhiGradient & | _grad_phi |
shape function gradients More... | |
unsigned int | _j |
j-th index for enumerating the shape functions More... | |
dof_id_type | _j_global |
global DOF ID corresponding to _j More... | |
Private Attributes | |
const bool | _compute_jacobians |
std::set< const MooseVariableFEBase * > | _jacobian_moose_variables |
UserObject template class in which the _phi and _grad_phi shape function data is available and correctly initialized on EXEC_NONLINEAR (the Jacobian calculation).
This enables the calculation of Jacobian matrix contributions inside a UO.
Definition at line 41 of file ShapeUserObject.h.
ShapeUserObject< T >::ShapeUserObject | ( | const InputParameters & | parameters, |
ShapeType | type | ||
) |
Definition at line 99 of file ShapeUserObject.h.
|
inline |
check if jacobian is to be computed in user objects
Definition at line 49 of file ShapeUserObject.h.
|
overrideprotectedvirtual |
Returns the index for a coupled variable by name and requests the computation of a Jacobian w.r.t.
to this variable i.e. the call to executeJacobian() with shapefunctions initialized for this variable.
Definition at line 122 of file ShapeUserObject.h.
|
protectedpure virtual |
Implement this function to compute Jacobian terms for this UserObject.
The shape function index _j and its corrsponding global DOF index _j_global will be provided.
|
virtual |
This function will be called with the shape functions for jvar initialized.
It can be used to compute Jacobian contributions of the by implementing executeJacobian.
Definition at line 136 of file ShapeUserObject.h.
|
inline |
Returns the set of variables a Jacobian has been requested for.
Definition at line 54 of file ShapeUserObject.h.
|
static |
Definition at line 112 of file ShapeUserObject.h.
Referenced by ShapeElementUserObject::validParams(), and ShapeSideUserObject::validParams().
|
private |
Definition at line 94 of file ShapeUserObject.h.
Referenced by ShapeUserObject< SideUserObject >::computeJacobianFlag().
|
protected |
shape function gradients
Definition at line 85 of file ShapeUserObject.h.
|
protected |
j-th index for enumerating the shape functions
Definition at line 88 of file ShapeUserObject.h.
|
protected |
global DOF ID corresponding to _j
Definition at line 91 of file ShapeUserObject.h.
|
mutableprivate |
Definition at line 95 of file ShapeUserObject.h.
Referenced by ShapeUserObject< SideUserObject >::jacobianMooseVariables().
|
protected |
shape function values
Definition at line 82 of file ShapeUserObject.h.