KokkosElementL2Norm Class Reference

#include <KokkosElementL2Norm.h>

Inheritance diagram for KokkosElementL2Norm:

Public Member Functions
	KokkosElementL2Norm (const InputParameters &parameters)
virtual Real	getValue () const override
KOKKOS_FUNCTION Real	computeQpIntegral (const unsigned int qp, Datum &datum) const
MooseVariableBase *	mooseVariableBase () const
	Get the variable that this object is using.
MooseVariableField< Real > &	mooseVariableField ()
	Return the MooseVariableField object that this interface acts on.
MooseVariableFE< Real > *	mooseVariable () const
	Return the MooseVariableFE object that this interface acts on.
MooseVariableFV< Real > *	mooseVariableFV () const
	Return the MooseVariableFV object that this interface acts on.
MooseLinearVariableFV< Real > *	mooseLinearVariableFV () const
	Return the MooseLinearVariableFV object that this interface acts on.

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual const OutputTools< Real >::VariableValue &	value ()
	The value of the variable this object is operating on.
virtual const OutputTools< Real >::VariableValue &	valueOld ()
	The old value of the variable this object is operating on.
virtual const OutputTools< Real >::VariableValue &	valueOlder ()
	The older value of the variable this object is operating on.
virtual const OutputTools< Real >::VariableValue &	dot ()
	The time derivative of the variable this object is operating on.
virtual const OutputTools< Real >::VariableValue &	dotDot ()
	The second time derivative of the variable this object is operating on.
virtual const OutputTools< Real >::VariableValue &	dotOld ()
	The old time derivative of the variable this object is operating on.
virtual const OutputTools< Real >::VariableValue &	dotDotOld ()
	The old second time derivative of the variable this object is operating on.
virtual const VariableValue &	dotDu ()
	The derivative of the time derivative of the variable this object is operating on with respect to this variable's coefficients.
virtual const VariableValue &	dotDotDu ()
	The derivative of the second time derivative of the variable this object is operating on with respect to this variable's coefficients.
virtual const OutputTools< Real >::VariableGradient &	gradient ()
	The gradient of the variable this object is operating on.
virtual const OutputTools< Real >::VariableGradient &	gradientOld ()
	The old gradient of the variable this object is operating on.
virtual const OutputTools< Real >::VariableGradient &	gradientOlder ()
	The older gradient of the variable this object is operating on.
virtual const OutputTools< Real >::VariableSecond &	second ()
	The second derivative of the variable this object is operating on.
virtual const OutputTools< Real >::VariableSecond &	secondOld ()
	The old second derivative of the variable this object is operating on.
virtual const OutputTools< Real >::VariableSecond &	secondOlder ()
	The older second derivative of the variable this object is operating on.
virtual const OutputTools< Real >::VariableTestSecond &	secondTest ()
	The second derivative of the test function.
virtual const OutputTools< Real >::VariableTestSecond &	secondTestFace ()
	The second derivative of the test function on the current face.
virtual const OutputTools< Real >::VariablePhiSecond &	secondPhi ()
	The second derivative of the trial function.
virtual const OutputTools< Real >::VariablePhiSecond &	secondPhiFace ()
	The second derivative of the trial function on the current face.

Protected Attributes
Moose::Kokkos::VariableValue	_u
	Holds the solution at current quadrature points.
Moose::Kokkos::VariableGradient	_grad_u
	Holds the solution gradient at the current quadrature points.
const bool	_use_abs_value
	Option to use absolute variable value.
bool	_nodal
	Whether or not this object is acting only at nodes.
MooseVariableBase *	_var
	The variable this object is acting on.
MooseVariableFE< Real > *	_variable
MooseVariableFV< Real > *	_fv_variable
MooseLinearVariableFV< Real > *	_linear_fv_variable
MooseVariableField< Real > *	_field_variable
Assembly *	_mvi_assembly

Private Attributes
const MooseObject &	_moose_object

Detailed Description

Definition at line 14 of file KokkosElementL2Norm.h.

Constructor & Destructor Documentation

KokkosElementL2Norm()

KokkosElementL2Norm::KokkosElementL2Norm

(

const InputParameters &

parameters

)

Member Function Documentation

computeQpIntegral()

KOKKOS_FUNCTION Real KokkosElementL2Norm::computeQpIntegral ( const unsigned int  qp, Datum &  datum  ) const

inline

Definition at line 23 of file KokkosElementL2Norm.h.

  {
    Real u = _u(datum, qp);
    return u * u;
  }

dot()

const OutputTools< Real >::VariableValue & MooseVariableInterface< Real >::dot ( )

protectedvirtualinherited

The time derivative of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 103 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDot();
  else
    return _variable->uDot();
}

dotDot()

const OutputTools< Real >::VariableValue & MooseVariableInterface< Real >::dotDot ( )

protectedvirtualinherited

The second time derivative of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 110 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDotDot();
  else
    return _variable->uDotDot();
}

dotDotDu()

const VariableValue & MooseVariableInterface< Real >::dotDotDu ( )

protectedvirtualinherited

The derivative of the second time derivative of the variable this object is operating on with respect to this variable's coefficients.

This is useful for creating Jacobian entries for residual statements that use _u_dotdot

Returns

The reference to be stored off and used later.

Definition at line 144 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDuDotDotDu();
  else
    return _variable->duDotDotDu();
}

dotDotOld()

const OutputTools< Real >::VariableValue & MooseVariableInterface< Real >::dotDotOld ( )

protectedvirtualinherited

The old second time derivative of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 124 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDotDotOld();
  else
    return _variable->uDotDotOld();
}

dotDu()

const VariableValue & MooseVariableInterface< Real >::dotDu ( )

protectedvirtualinherited

The derivative of the time derivative of the variable this object is operating on with respect to this variable's coefficients.

This is useful for creating Jacobian entries for residual statements that use _u_dot

Returns

The reference to be stored off and used later.

Definition at line 134 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDuDotDu();
  else
    return _variable->duDotDu();
}

dotOld()

const OutputTools< Real >::VariableValue & MooseVariableInterface< Real >::dotOld ( )

protectedvirtualinherited

The old time derivative of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 117 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDotOld();
  else
    return _variable->uDotOld();
}

getValue()

virtual Real KokkosElementL2Norm::getValue ( ) const

overridevirtual

gradient()

const OutputTools< Real >::VariableGradient & MooseVariableInterface< Real >::gradient ( )

protectedvirtualinherited

The gradient of the variable this object is operating on.

This is computed by default and should already be available as _grad_u

Returns

The reference to be stored off and used later.

Definition at line 153 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("gradients are not defined at nodes");
 
  return _variable->gradSln();
}

gradientOld()

const OutputTools< Real >::VariableGradient & MooseVariableInterface< Real >::gradientOld ( )

protectedvirtualinherited

The old gradient of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 160 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("gradients are not defined at nodes");
 
  return _variable->gradSlnOld();
}

gradientOlder()

const OutputTools< Real >::VariableGradient & MooseVariableInterface< Real >::gradientOlder ( )

protectedvirtualinherited

The older gradient of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 167 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("gradients are not defined at nodes");
 
  return _variable->gradSlnOlder();
}

mooseLinearVariableFV()

MooseLinearVariableFV< Real > * MooseVariableInterface< Real >::mooseLinearVariableFV ( ) const

inherited

Return the MooseLinearVariableFV object that this interface acts on.

Definition at line 70 of file MooseVariableInterface.C.

{
  if (!_linear_fv_variable)
    mooseError(
        "The variable defined in ", _moose_object.name(), " is not a MooseLinearVariableFV!");
  return _linear_fv_variable;
}

mooseVariable()

MooseVariableFE< Real > * MooseVariableInterface< Real >::mooseVariable ( ) const

inherited

Return the MooseVariableFE object that this interface acts on.

Definition at line 60 of file MooseVariableInterface.C.

{
  if (!_variable)
    mooseError(
        "_variable is null in ", _moose_object.name(), ". Are you using a finite volume variable?");
  return _variable;
}

mooseVariableBase()

MooseVariableBase * MooseVariableInterface< Real >::mooseVariableBase ( ) const

inlineinherited

Get the variable that this object is using.

Returns

The variable this object is using.

Definition at line 50 of file MooseVariableInterface.h.

{ return _var; };

mooseVariableField()

MooseVariableField< Real > & MooseVariableInterface< Real >::mooseVariableField ( )

inherited

Return the MooseVariableField object that this interface acts on.

Definition at line 55 of file MooseVariableInterface.C.

{
  return *_field_variable;
}

mooseVariableFV()

MooseVariableFV< Real > * MooseVariableInterface< Real >::mooseVariableFV ( ) const

inherited

Return the MooseVariableFV object that this interface acts on.

Definition at line 65 of file MooseVariableInterface.C.

{
  if (!_fv_variable)
    mooseError("_fv_variable is null in ",
               _moose_object.name(),
               ". Did you forget to set fv = true in the Variables block?");
  return _fv_variable;
}

second()

const OutputTools< Real >::VariableSecond & MooseVariableInterface< Real >::second ( )

protectedvirtualinherited

The second derivative of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 174 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondSln();
}

secondOld()

const OutputTools< Real >::VariableSecond & MooseVariableInterface< Real >::secondOld ( )

protectedvirtualinherited

The old second derivative of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 181 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondSlnOld();
}

secondOlder()

const OutputTools< Real >::VariableSecond & MooseVariableInterface< Real >::secondOlder ( )

protectedvirtualinherited

The older second derivative of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 188 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondSlnOlder();
}

secondPhi()

const OutputTools< Real >::VariablePhiSecond & MooseVariableInterface< Real >::secondPhi ( )

protectedvirtualinherited

The second derivative of the trial function.

Returns

The reference to be stored off and used later.

Definition at line 211 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  if (_linear_fv_variable)
    mooseError("second order shape function derivatives not available for linear FV variables");
 
  return _mvi_assembly->secondPhi(*_variable);
}

secondPhiFace()

const OutputTools< Real >::VariablePhiSecond & MooseVariableInterface< Real >::secondPhiFace ( )

protectedvirtualinherited

The second derivative of the trial function on the current face.

This should be called in e.g. IntegratedBC when you need second derivatives of the trial function function on the boundary.

Returns

The reference to be stored off and used later.

Definition at line 220 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  if (_linear_fv_variable)
    mooseError("second order shape function derivatives not available for linear FV variables");
 
  return _mvi_assembly->secondPhiFace(*_variable);
}

secondTest()

const OutputTools< Real >::VariableTestSecond & MooseVariableInterface< Real >::secondTest ( )

protectedvirtualinherited

The second derivative of the test function.

Returns

The reference to be stored off and used later.

Definition at line 195 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondPhi();
}

secondTestFace()

const OutputTools< Real >::VariableTestSecond & MooseVariableInterface< Real >::secondTestFace ( )

protectedvirtualinherited

The second derivative of the test function on the current face.

This should be called in e.g. IntegratedBC when you need second derivatives of the test function function on the boundary.

Returns

The reference to be stored off and used later.

Definition at line 204 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondPhiFace();
}

validParams()

static InputParameters KokkosElementL2Norm::validParams ( )

static

value()

const OutputTools< Real >::VariableValue & MooseVariableInterface< Real >::value ( )

protectedvirtualinherited

The value of the variable this object is operating on.

This is computed by default and should already be available as _u

Returns

The reference to be stored off and used later.

Definition at line 82 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValues();
  else
    return _variable->sln();
}

valueOld()

const OutputTools< Real >::VariableValue & MooseVariableInterface< Real >::valueOld ( )

protectedvirtualinherited

The old value of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 89 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesOld();
  else
    return _variable->slnOld();
}

valueOlder()

const OutputTools< Real >::VariableValue & MooseVariableInterface< Real >::valueOlder ( )

protectedvirtualinherited

The older value of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 96 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesOlder();
  else
    return _variable->slnOlder();
}

Member Data Documentation

_field_variable

MooseVariableField<Real >* MooseVariableInterface< Real >::_field_variable

protectedinherited

Definition at line 230 of file MooseVariableInterface.h.

_fv_variable

MooseVariableFV<Real >* MooseVariableInterface< Real >::_fv_variable

protectedinherited

Definition at line 228 of file MooseVariableInterface.h.

_grad_u

template<typename Base >

Moose::Kokkos::VariableGradient KokkosIntegralVariablePostprocessor< Base >::_grad_u

protectedinherited

Holds the solution gradient at the current quadrature points.

Definition at line 29 of file KokkosIntegralVariablePostprocessor.h.

_linear_fv_variable

MooseLinearVariableFV<Real >* MooseVariableInterface< Real >::_linear_fv_variable

protectedinherited

Definition at line 229 of file MooseVariableInterface.h.

_moose_object

const MooseObject& MooseVariableInterface< Real >::_moose_object

privateinherited

Definition at line 236 of file MooseVariableInterface.h.

_mvi_assembly

Assembly* MooseVariableInterface< Real >::_mvi_assembly

protectedinherited

Definition at line 233 of file MooseVariableInterface.h.

_nodal

bool MooseVariableInterface< Real >::_nodal

protectedinherited

Whether or not this object is acting only at nodes.

Definition at line 223 of file MooseVariableInterface.h.

_u

template<typename Base >

Moose::Kokkos::VariableValue KokkosIntegralVariablePostprocessor< Base >::_u

protectedinherited

Holds the solution at current quadrature points.

Definition at line 27 of file KokkosIntegralVariablePostprocessor.h.

Referenced by computeQpIntegral().

_use_abs_value

template<typename Base >

const bool KokkosIntegralVariablePostprocessor< Base >::_use_abs_value

protectedinherited

Option to use absolute variable value.

Definition at line 31 of file KokkosIntegralVariablePostprocessor.h.

_var

MooseVariableBase* MooseVariableInterface< Real >::_var

protectedinherited

The variable this object is acting on.

Definition at line 226 of file MooseVariableInterface.h.

_variable

MooseVariableFE<Real >* MooseVariableInterface< Real >::_variable

protectedinherited

Definition at line 227 of file MooseVariableInterface.h.

---

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

• include/kokkos/postprocessors/KokkosElementL2Norm.h