CoupledVarNeumannBCTempl< is_ad > Class Template Reference

Implements a Neumann BC where grad(u)=_coupled_var on the boundary. More...

#include <CoupledVarNeumannBC.h>

Inheritance diagram for CoupledVarNeumannBCTempl< is_ad >:

Public Member Functions
	CoupledVarNeumannBCTempl (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
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

template<bool is_ad>
class CoupledVarNeumannBCTempl< is_ad >

Implements a Neumann BC where grad(u)=_coupled_var on the boundary.

Uses the term produced from integrating the diffusion operator by parts.

Definition at line 23 of file CoupledVarNeumannBC.h.

Constructor & Destructor Documentation

CoupledVarNeumannBCTempl()

template<bool is_ad>

CoupledVarNeumannBCTempl< is_ad >::CoupledVarNeumannBCTempl

(

const InputParameters &

parameters

)

Definition at line 30 of file CoupledVarNeumannBC.C.

  : IntegratedBCParent<is_ad>(parameters),
    _coupled_var(this->template coupledGenericValue<is_ad>("v")),
    _coupled_num(this->coupled("v")),
    _coef(this->template getParam<Real>("coef")),
    _scale_factor(this->template coupledGenericValue<is_ad>("scale_factor"))
{
}

Member Function Documentation

computeQpResidual()

template<bool is_ad>

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

overrideprotectedvirtual

Definition at line 41 of file CoupledVarNeumannBC.C.

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

validParams()

template<bool is_ad>

InputParameters CoupledVarNeumannBCTempl< is_ad >::validParams ( )

static

Definition at line 17 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

template<bool is_ad>

const Real CoupledVarNeumannBCTempl< is_ad >::_coef

protected

A coefficient that is multiplied with the residual contribution.

Definition at line 40 of file CoupledVarNeumannBC.h.

_coupled_num

template<bool is_ad>

const unsigned int CoupledVarNeumannBCTempl< is_ad >::_coupled_num

protected

The identifying number of the coupled variable.

Definition at line 37 of file CoupledVarNeumannBC.h.

_coupled_var

template<bool is_ad>

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

protected

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

Definition at line 34 of file CoupledVarNeumannBC.h.

_scale_factor

template<bool is_ad>

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

protected

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