https://mooseframework.inl.gov
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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 >:
[legend]

Public Member Functions

 ADVolumeJunctionAdvectionKernelTempl (const InputParameters &params)
 
template<>
 ADVolumeJunctionAdvectionKernelTempl (const InputParameters &params)
 
template<>
 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. More...
 
const ADVolumeJunctionBaseUserObject_volume_junction_uo
 Volume junction user object. More...
 

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]

◆ ADVolumeJunctionAdvectionKernelTempl() [2/3]

Definition at line 32 of file ADVolumeJunctionAdvectionScalarKernel.C.

34  : ADKernel(params),
35  _equation_index(getParam<unsigned int>("equation_index")),
36  _volume_junction_uo(getUserObject<ADVolumeJunctionBaseUserObject>("volume_junction_uo"))
37 {
38 }
const ADVolumeJunctionBaseUserObject & _volume_junction_uo
Volume junction user object.
const unsigned int _equation_index
Index within local system of the equation upon which this object acts.

◆ ADVolumeJunctionAdvectionKernelTempl() [3/3]

Definition at line 41 of file ADVolumeJunctionAdvectionScalarKernel.C.

43  : ADScalarKernel(params),
44  _equation_index(getParam<unsigned int>("equation_index")),
45  _volume_junction_uo(getUserObject<ADVolumeJunctionBaseUserObject>("volume_junction_uo"))
46 {
47  if (_var.order() > 1)
48  mooseError(name(), ": This scalar kernel can be used only with first-order scalar variables.");
49 }
void mooseError(Args &&... args)
const ADVolumeJunctionBaseUserObject & _volume_junction_uo
Volume junction user object.
const std::string name
Definition: Setup.h:20
const unsigned int _equation_index
Index within local system of the equation upon which this object acts.

Member Function Documentation

◆ computeQpResidual()

template<typename T >
ADReal ADVolumeJunctionAdvectionKernelTempl< T >::computeQpResidual ( )
overrideprotectedvirtual

Definition at line 53 of file ADVolumeJunctionAdvectionScalarKernel.C.

54 {
56 }
const ADVolumeJunctionBaseUserObject & _volume_junction_uo
Volume junction user object.
const std::vector< ADReal > & getResidual() const
Returns the residual vector for the scalar variables.
const unsigned int _equation_index
Index within local system of the equation upon which this object acts.

◆ validParams()

template<typename T >
InputParameters ADVolumeJunctionAdvectionKernelTempl< T >::validParams ( )
static

Definition at line 18 of file ADVolumeJunctionAdvectionScalarKernel.C.

19 {
21 
22  params.addRequiredParam<unsigned int>("equation_index", "Equation index");
23  params.addRequiredParam<UserObjectName>("volume_junction_uo", "Volume junction user object name");
24 
25  params.addClassDescription(
26  "Adds advective fluxes for the junction variables for a volume junction");
27 
28  return params;
29 }
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters validParams()
void addClassDescription(const std::string &doc_string)

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: