https://mooseframework.inl.gov
Loading...
Searching...
No Matches
TagVectorArrayVariableValueAux.C
Go to the documentation of this file.
1//* This file is part of the MOOSE framework
2//* https://mooseframework.inl.gov
3//*
4//* All rights reserved, see COPYRIGHT for full restrictions
5//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6//*
7//* Licensed under LGPL 2.1, please see LICENSE for details
8//* https://www.gnu.org/licenses/lgpl-2.1.html
9
11
13
16{
18
19 params.addRequiredParam<TagName>("vector_tag", "Tag Name this Aux works on");
20 params.addClassDescription("Couple a tagged vector, and return its array value.");
21 return params;
22}
23
25 : TagAuxBase<ArrayAuxKernel>(parameters), _v(coupledVectorTagArrayValue("v", "vector_tag"))
26{
28}
29
30RealEigenVector
registerMooseObject("MooseApp", TagVectorArrayVariableValueAux)
Base class for creating new auxiliary kernels and auxiliary boundary conditions.
Definition AuxKernel.h:28
unsigned int _qp
Quadrature point index.
Definition AuxKernel.h:155
MooseVariableField< ComputeValueType > & _var
This is a regular kernel so we cast to a regular MooseVariable, hides base _var.
Definition AuxKernel.h:113
ArrayMooseVariable * getArrayVar(const std::string &var_name, unsigned int comp)
Extract pointer to a coupled array variable.
Definition Coupleable.C:337
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump.
The value of a tagged vector for a given node and a given variable is coupled to the current AuxVaria...
Definition TagAuxBase.h:22
void checkCoupledVariable(const MooseVariableBase *input_var, const MooseVariableFieldBase *aux_var)
check the aux variable acting on this auxkernl has the consistent properties with the input coupled v...
Definition TagAuxBase.h:70
static InputParameters validParams()
Definition TagAuxBase.h:45
Couple a tagged vector, and return its array value.
RealEigenVector computeValue() override
Compute and return the value of the aux variable.
TagVectorArrayVariableValueAux(const InputParameters &parameters)