CoupledVarNeumannBC Class Reference

#include <CoupledVarNeumannBC.h>

Inheritance diagram for CoupledVarNeumannBC:

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual Real	computeQpOffDiagJacobian (const unsigned int jvar_num) override
virtual GenericReal< is_ad >	computeQpResidual () override

Protected Attributes
const GenericVariableValue< is_ad > &	_coupled_var
	Variable providing the value of grad(u) on the boundary.
const unsigned int	_coupled_num
	The identifying number of the coupled variable.
const Real	_coef
	A coefficient that is multiplied with the residual contribution.
const GenericVariableValue< is_ad > &	_scale_factor
	Scale factor.

Detailed Description

Definition at line 52 of file CoupledVarNeumannBC.h.

Member Function Documentation

computeQpOffDiagJacobian()

Real CoupledVarNeumannBC::computeQpOffDiagJacobian ( const unsigned int  jvar_num )

overrideprotectedvirtual

Definition at line 47 of file CoupledVarNeumannBC.C.

{
  if (jvar == _coupled_num)
    return -_scale_factor[_qp] * _coef * _test[_i][_qp] * _phi[_j][_qp];
  else
    return 0;
}

computeQpResidual()

GenericReal< is_ad > CoupledVarNeumannBCTempl< is_ad >::computeQpResidual ( )

overrideprotectedvirtualinherited

Definition at line 31 of file CoupledVarNeumannBC.C.

{
  return -_scale_factor[_qp] * _coef * _test[_i][_qp] * _coupled_var[_qp];
}

validParams()

InputParameters CoupledVarNeumannBCTempl< is_ad >::validParams ( )

staticinherited

Definition at line 26 of file CoupledVarNeumannBC.C.

{
  InputParameters params = IntegratedBCParent<is_ad>::validParams();
  params.addRequiredCoupledVar("v", "Coupled variable setting the gradient on the boundary.");
  params.addCoupledVar("scale_factor", 1., "Scale factor to multiply the heat flux with");
  params.addParam<Real>(
      "coef", 1.0, "Coefficent ($\\sigma$) multiplier for the coupled force term.");
  params.addClassDescription("Imposes the integrated boundary condition "
                             "$\\frac{\\partial u}{\\partial n}=v$, "
                             "where $v$ is a variable.");
  return params;
}

Member Data Documentation

_coef

const Real CoupledVarNeumannBCTempl< is_ad >::_coef

protectedinherited

A coefficient that is multiplied with the residual contribution.

Definition at line 40 of file CoupledVarNeumannBC.h.

_coupled_num

const unsigned int CoupledVarNeumannBCTempl< is_ad >::_coupled_num

protectedinherited

The identifying number of the coupled variable.

Definition at line 37 of file CoupledVarNeumannBC.h.

_coupled_var

const GenericVariableValue<is_ad>& CoupledVarNeumannBCTempl< is_ad >::_coupled_var

protectedinherited

Variable providing the value of grad(u) on the boundary.

Definition at line 34 of file CoupledVarNeumannBC.h.

_scale_factor

const GenericVariableValue<is_ad>& CoupledVarNeumannBCTempl< is_ad >::_scale_factor

protectedinherited

Scale factor.

Definition at line 43 of file CoupledVarNeumannBC.h.

---

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

• include/bcs/CoupledVarNeumannBC.h
• src/bcs/CoupledVarNeumannBC.C