ADVolumeJunctionAdvectionKernelTempl< T > Class Template Reference

Adds advective fluxes for the junction variables for a volume junction. More...

#include <ADVolumeJunctionAdvectionScalarKernel.h>

Inheritance diagram for ADVolumeJunctionAdvectionKernelTempl< T >:

Public Member Functions
	ADVolumeJunctionAdvectionKernelTempl (const InputParameters &params)
	ADVolumeJunctionAdvectionKernelTempl (const InputParameters &params)
	ADVolumeJunctionAdvectionKernelTempl (const InputParameters &params)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual ADReal	computeQpResidual () override

Protected Attributes
const unsigned int	_equation_index
	Index within local system of the equation upon which this object acts.
const ADVolumeJunctionBaseUserObject &	_volume_junction_uo
	Volume junction user object.

Detailed Description

template<typename T>
class ADVolumeJunctionAdvectionKernelTempl< T >

Adds advective fluxes for the junction variables for a volume junction.

Definition at line 21 of file ADVolumeJunctionAdvectionScalarKernel.h.

Constructor & Destructor Documentation

ADVolumeJunctionAdvectionKernelTempl() [1/3]

template<typename T >

ADVolumeJunctionAdvectionKernelTempl< T >::ADVolumeJunctionAdvectionKernelTempl

(

const InputParameters &

params

)

ADVolumeJunctionAdvectionKernelTempl() [2/3]

ADVolumeJunctionAdvectionKernelTempl< ADKernel >::ADVolumeJunctionAdvectionKernelTempl

(

const InputParameters &

params

)

Definition at line 32 of file ADVolumeJunctionAdvectionScalarKernel.C.

  : ADKernel(params),
    _equation_index(getParam<unsigned int>("equation_index")),
    _volume_junction_uo(getUserObject<ADVolumeJunctionBaseUserObject>("volume_junction_uo"))
{
}

ADVolumeJunctionAdvectionKernelTempl() [3/3]

ADVolumeJunctionAdvectionKernelTempl< ADScalarKernel >::ADVolumeJunctionAdvectionKernelTempl

(

const InputParameters &

params

)

Definition at line 41 of file ADVolumeJunctionAdvectionScalarKernel.C.

  : ADScalarKernel(params),
    _equation_index(getParam<unsigned int>("equation_index")),
    _volume_junction_uo(getUserObject<ADVolumeJunctionBaseUserObject>("volume_junction_uo"))
{
  if (_var.order() > 1)
    mooseError(name(), ": This scalar kernel can be used only with first-order scalar variables.");
}

Member Function Documentation

computeQpResidual()

template<typename T >

ADReal ADVolumeJunctionAdvectionKernelTempl< T >::computeQpResidual ( )

overrideprotectedvirtual

Definition at line 53 of file ADVolumeJunctionAdvectionScalarKernel.C.

{
  return _volume_junction_uo.getResidual()[_equation_index];
}

validParams()

template<typename T >

InputParameters ADVolumeJunctionAdvectionKernelTempl< T >::validParams ( )

static

Definition at line 18 of file ADVolumeJunctionAdvectionScalarKernel.C.

{
  InputParameters params = T::validParams();
 
  params.addRequiredParam<unsigned int>("equation_index", "Equation index");
  params.addRequiredParam<UserObjectName>("volume_junction_uo", "Volume junction user object name");
 
  params.addClassDescription(
      "Adds advective fluxes for the junction variables for a volume junction");
 
  return params;
}

Member Data Documentation

_equation_index

template<typename T >

const unsigned int ADVolumeJunctionAdvectionKernelTempl< T >::_equation_index

protected

Index within local system of the equation upon which this object acts.

Definition at line 30 of file ADVolumeJunctionAdvectionScalarKernel.h.

_volume_junction_uo

template<typename T >

const ADVolumeJunctionBaseUserObject& ADVolumeJunctionAdvectionKernelTempl< T >::_volume_junction_uo

protected

Volume junction user object.

Definition at line 33 of file ADVolumeJunctionAdvectionScalarKernel.h.

---

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

• thermal_hydraulics/include/scalarkernels/ADVolumeJunctionAdvectionScalarKernel.h
• thermal_hydraulics/src/scalarkernels/ADVolumeJunctionAdvectionScalarKernel.C