TagAuxBase< T > Class Template Reference

The value of a tagged vector for a given node and a given variable is coupled to the current AuxVariable. More...

#include <TagAuxBase.h>

Inheritance diagram for TagAuxBase< T >:

Public Member Functions
	TagAuxBase (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

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

Protected Attributes
const bool	_scaled

Detailed Description

template<class T>
class TagAuxBase< T >

The value of a tagged vector for a given node and a given variable is coupled to the current AuxVariable.

TagVectorAux returns the coupled nodal value.

Definition at line 21 of file TagAuxBase.h.

Constructor & Destructor Documentation

TagAuxBase()

template<class T >

TagAuxBase< T >::TagAuxBase

(

const InputParameters &

parameters

)

Definition at line 63 of file TagAuxBase.h.

  : T(parameters), _scaled(this->template getParam<bool>("scaled"))
{
}

Member Function Documentation

checkCoupledVariable()

template<class T >

void TagAuxBase< T >::checkCoupledVariable ( const MooseVariableBase *  input_var, const MooseVariableFieldBase *  aux_var  )

protected

check the aux variable acting on this auxkernl has the consistent properties with the input coupled variable

Parameters

input_var	Input coupled variable
aux_var	Aux variable

Definition at line 70 of file TagAuxBase.h.

{
  if (input_var->feType() != aux_var->feType())
    paramError("variable",
               "The AuxVariable this AuxKernel is acting on has to have the same order and family "
               "as the variable 'v'");
  if (input_var->count() != aux_var->count())
    paramError("variable",
               "The AuxVariable this AuxKernel is acting on has to have the same number of "
               "components as the variable 'v'");
}

validParams()

template<class T >

InputParameters TagAuxBase< T >::validParams ( )

static

Definition at line 45 of file TagAuxBase.h.

{
  InputParameters params = T::validParams();
 
  params.addRequiredCoupledVar("v",
                               "The coupled variable whose components are coupled to AuxVariable");
  params.set<ExecFlagEnum>("execute_on", true) = {EXEC_TIMESTEP_END};
  params.suppressParameter<ExecFlagEnum>("execute_on");
  params.addDeprecatedParam<bool>(
      "scaled",
      true,
      "Return value depending on the variable scaling/autoscaling. Set this to "
      "false to obtain unscaled physical reaction forces.",
      "This parameter has been deprecated.");
  return params;
}

Referenced by TagMatrixAux::validParams(), TagVectorArrayVariableAux::validParams(), TagVectorArrayVariableValueAux::validParams(), TagVectorAux::validParams(), ScalarTagMatrixAux::validParams(), and ScalarTagVectorAux::validParams().

Member Data Documentation

_scaled

template<class T >

const bool TagAuxBase< T >::_scaled

protected

Definition at line 29 of file TagAuxBase.h.

---

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

• include/auxkernels/TagAuxBase.h