ShapeUserObject< T > Class Template Reference

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>

Inheritance diagram for ShapeUserObject< T >:

Public Member Functions
	ShapeUserObject (const InputParameters &parameters, ShapeType type)
const bool &	computeJacobianFlag () const
	check if jacobian is to be computed in user objects
const std::set< const MooseVariableFEBase * > &	jacobianMooseVariables () const
	Returns the set of variables a Jacobian has been requested for.
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.

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.
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.

Protected Attributes
const VariablePhiValue &	_phi
	shape function values
const VariablePhiGradient &	_grad_phi
	shape function gradients
unsigned int	_j
	j-th index for enumerating the shape functions
dof_id_type	_j_global
	global DOF ID corresponding to _j

Private Attributes
const bool	_compute_jacobians
std::set< const MooseVariableFEBase * >	_jacobian_moose_variables

Detailed Description

template<typename T>
class ShapeUserObject< T >

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.

Warning

It is up to the user to ensure _fe_problem.currentlyComputingJacobian() returns true before utilizing the shape functions.

Definition at line 41 of file ShapeUserObject.h.

Constructor & Destructor Documentation

ShapeUserObject()

template<typename T >

ShapeUserObject< T >::ShapeUserObject	(	const InputParameters &	parameters,
		ShapeType	type
	)

Definition at line 99 of file ShapeUserObject.h.

  : T(parameters),
    _phi(type == ShapeType::Element ? this->_assembly.phi() : this->_assembly.phiFace()),
    _grad_phi(type == ShapeType::Element ? this->_assembly.gradPhi()
                                         : this->_assembly.gradPhiFace()),
    _compute_jacobians(MooseObject::getParam<bool>("compute_jacobians"))
{
  mooseWarning("Jacobian calculation in UserObjects is an experimental capability with a "
               "potentially unstable interface.");
}

Member Function Documentation

computeJacobianFlag()

template<typename T >

const bool & ShapeUserObject< T >::computeJacobianFlag ( ) const

inline

check if jacobian is to be computed in user objects

Definition at line 49 of file ShapeUserObject.h.

{ return _compute_jacobians; }

coupled()

template<typename T >

unsigned int ShapeUserObject< T >::coupled ( const std::string &  var_name, unsigned int  comp = 0  ) const

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.

{
  const auto * var = this->template getVarHelper<MooseVariable>(var_name, comp);
 
  // add to the set of variables for which executeJacobian will be called
  if (_compute_jacobians && var->kind() == Moose::VAR_SOLVER)
    _jacobian_moose_variables.insert(var);
 
  // return the variable number
  return T::coupled(var_name, comp);
}

executeJacobian()

template<typename T >

virtual void ShapeUserObject< T >::executeJacobian ( unsigned int  )

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.

executeJacobianWrapper()

template<typename T >

void ShapeUserObject< T >::executeJacobianWrapper ( unsigned int  jvar, const std::vector< dof_id_type > &  dof_indices  )

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.

{
  for (_j = 0; _j < _phi.size(); ++_j)
  {
    _j_global = dof_indices[_j];
    executeJacobian(jvar);
  }
}

jacobianMooseVariables()

template<typename T >

const std::set< const MooseVariableFEBase * > & ShapeUserObject< T >::jacobianMooseVariables ( ) const

inline

Returns the set of variables a Jacobian has been requested for.

Definition at line 54 of file ShapeUserObject.h.

  {
    return _jacobian_moose_variables;
  }

validParams()

template<typename T >

InputParameters ShapeUserObject< T >::validParams ( )

static

Definition at line 112 of file ShapeUserObject.h.

{
  InputParameters params = emptyInputParameters();
  params.addParam<bool>("compute_jacobians", true, "Compute Jacobians for coupled variables");
  params.addParamNamesToGroup("compute_jacobians", "Advanced");
  return params;
}

Referenced by ShapeElementUserObject::validParams(), and ShapeSideUserObject::validParams().

Member Data Documentation

_compute_jacobians

template<typename T >

const bool ShapeUserObject< T >::_compute_jacobians

private

Definition at line 94 of file ShapeUserObject.h.

Referenced by ShapeUserObject< T >::computeJacobianFlag().

_grad_phi

template<typename T >

const VariablePhiGradient& ShapeUserObject< T >::_grad_phi

protected

shape function gradients

Definition at line 85 of file ShapeUserObject.h.

_j

template<typename T >

unsigned int ShapeUserObject< T >::_j

protected

j-th index for enumerating the shape functions

Definition at line 88 of file ShapeUserObject.h.

_j_global

template<typename T >

dof_id_type ShapeUserObject< T >::_j_global

protected

global DOF ID corresponding to _j

Definition at line 91 of file ShapeUserObject.h.

_jacobian_moose_variables

template<typename T >

std::set<const MooseVariableFEBase *> ShapeUserObject< T >::_jacobian_moose_variables

mutableprivate

Definition at line 95 of file ShapeUserObject.h.

Referenced by ShapeUserObject< T >::jacobianMooseVariables().

_phi

template<typename T >

const VariablePhiValue& ShapeUserObject< T >::_phi

protected

shape function values

Definition at line 82 of file ShapeUserObject.h.

---

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

• include/userobjects/ShapeUserObject.h