NeighborMooseVariableInterface< T > Class Template Reference

Enhances MooseVariableInterface interface provide values from neighbor elements. More...

#include <NeighborMooseVariableInterface.h>

Inheritance diagram for NeighborMooseVariableInterface< T >:

Public Member Functions
	NeighborMooseVariableInterface (const MooseObject *moose_object, bool nodal, Moose::VarKindType expected_var_type=Moose::VarKindType::VAR_ANY, Moose::VarFieldType expected_var_field_type=Moose::VarFieldType::VAR_FIELD_STANDARD)
	Constructing the object. More...
virtual	~NeighborMooseVariableInterface ()
MooseVariableFE< T > *	mooseVariable () const
	Get the variable that this object is using. More...

Protected Member Functions
virtual const OutputTools< T >::VariableValue &	neighborValue ()
	The value of the variable this object is operating on evaluated on the "neighbor" element. More...
virtual const OutputTools< T >::VariableValue &	neighborValueOld ()
	The old value of the variable this object is operating on evaluated on the "neighbor" element. More...
virtual const OutputTools< T >::VariableValue &	neighborValueOlder ()
	The older value of the variable this object is operating on evaluated on the "neighbor" element. More...
virtual const OutputTools< T >::VariableGradient &	neighborGradient ()
	The gradient of the variable this object is operating on evaluated on the "neighbor" element. More...
virtual const OutputTools< T >::VariableGradient &	neighborGradientOld ()
	The old gradient of the variable this object is operating on evaluated on the "neighbor" element. More...
virtual const OutputTools< T >::VariableGradient &	neighborGradientOlder ()
	The older gradient of the variable this object is operating on evaluated on the "neighbor" element. More...
virtual const OutputTools< T >::VariableSecond &	neighborSecond ()
	The second derivative of the variable this object is operating on evaluated on the "neighbor" element. More...
virtual const OutputTools< T >::VariableSecond &	neighborSecondOld ()
	The old second derivative of the variable this object is operating on evaluated on the "neighbor" element. More...
virtual const OutputTools< T >::VariableSecond &	neighborSecondOlder ()
	The older second derivative of the variable this object is operating on evaluated on the "neighbor" element. More...
virtual const OutputTools< T >::VariableTestSecond &	neighborSecondTest ()
	The second derivative of the neighbor's test function. More...
virtual const OutputTools< T >::VariablePhiSecond &	neighborSecondPhi ()
	The second derivative of the neighbor's shape function. More...
template<>
const VectorVariableValue &	neighborValue ()
template<>
const VectorVariableValue &	neighborValueOld ()
template<>
const VectorVariableValue &	neighborValueOlder ()
virtual const OutputTools< T >::VariableValue &	value ()
	The value of the variable this object is operating on. More...
virtual const OutputTools< T >::VariableValue &	valueOld ()
	The old value of the variable this object is operating on. More...
virtual const OutputTools< T >::VariableValue &	valueOlder ()
	The older value of the variable this object is operating on. More...
virtual const OutputTools< T >::VariableValue &	dot ()
	The time derivative of the variable this object is operating on. More...
virtual const OutputTools< T >::VariableValue &	dotDot ()
	The second time derivative of the variable this object is operating on. More...
virtual const OutputTools< T >::VariableValue &	dotOld ()
	The old time derivative of the variable this object is operating on. More...
virtual const OutputTools< T >::VariableValue &	dotDotOld ()
	The old second time derivative of the variable this object is operating on. More...
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. More...
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. More...
virtual const OutputTools< T >::VariableGradient &	gradient ()
	The gradient of the variable this object is operating on. More...
virtual const OutputTools< T >::VariableGradient &	gradientOld ()
	The old gradient of the variable this object is operating on. More...
virtual const OutputTools< T >::VariableGradient &	gradientOlder ()
	The older gradient of the variable this object is operating on. More...
virtual const OutputTools< T >::VariableSecond &	second ()
	The second derivative of the variable this object is operating on. More...
virtual const OutputTools< T >::VariableSecond &	secondOld ()
	The old second derivative of the variable this object is operating on. More...
virtual const OutputTools< T >::VariableSecond &	secondOlder ()
	The older second derivative of the variable this object is operating on. More...
virtual const OutputTools< T >::VariableTestSecond &	secondTest ()
	The second derivative of the test function. More...
virtual const OutputTools< T >::VariableTestSecond &	secondTestFace ()
	The second derivative of the test function on the current face. More...
virtual const OutputTools< T >::VariablePhiSecond &	secondPhi ()
	The second derivative of the trial function. More...
virtual const OutputTools< T >::VariablePhiSecond &	secondPhiFace ()
	The second derivative of the trial function on the current face. More...

Protected Attributes
bool	_nodal
	Whether or not this object is acting only at nodes. More...
MooseVariableFE< T > *	_variable
	The variable this object is acting on. More...
Assembly *	_mvi_assembly

Detailed Description

template<typename T>
class NeighborMooseVariableInterface< T >

Enhances MooseVariableInterface interface provide values from neighbor elements.

Definition at line 21 of file NeighborMooseVariableInterface.h.

Constructor & Destructor Documentation

NeighborMooseVariableInterface()

template<typename T >

NeighborMooseVariableInterface< T >::NeighborMooseVariableInterface	(	const MooseObject *	moose_object,
		bool	nodal,
		Moose::VarKindType	expected_var_type = Moose::VarKindType::VAR_ANY,
		Moose::VarFieldType	expected_var_field_type = Moose::VarFieldType::VAR_FIELD_STANDARD
	)

Constructing the object.

Parameters

parameters	Parameters that come from constructing the object
nodal	true if the variable is nodal

Definition at line 20 of file NeighborMooseVariableInterface.C.

  : MooseVariableInterface<T>(
        moose_object, nodal, "variable", expected_var_type, expected_var_field_type)
{
}

~NeighborMooseVariableInterface()

template<typename T >

NeighborMooseVariableInterface< T >::~NeighborMooseVariableInterface ( )

virtual

Definition at line 31 of file NeighborMooseVariableInterface.C.

{
}

Member Function Documentation

dot()

template<typename T >

const OutputTools< T >::VariableValue & MooseVariableInterface< T >::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 137 of file MooseVariableInterface.C.

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

dotDot()

template<typename T >

const OutputTools< T >::VariableValue & MooseVariableInterface< T >::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 147 of file MooseVariableInterface.C.

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

dotDotDu()

template<typename T >

const VariableValue & MooseVariableInterface< T >::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 227 of file MooseVariableInterface.C.

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

dotDotOld()

template<typename T >

const OutputTools< T >::VariableValue & MooseVariableInterface< T >::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 167 of file MooseVariableInterface.C.

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

dotDu()

template<typename T >

const VariableValue & MooseVariableInterface< T >::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 217 of file MooseVariableInterface.C.

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

dotOld()

template<typename T >

const OutputTools< T >::VariableValue & MooseVariableInterface< T >::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 157 of file MooseVariableInterface.C.

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

gradient()

template<typename T >

const OutputTools< T >::VariableGradient & MooseVariableInterface< T >::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 237 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("gradients are not defined at nodes");

  return _variable->gradSln();
}

gradientOld()

template<typename T >

const OutputTools< T >::VariableGradient & MooseVariableInterface< T >::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 247 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("gradients are not defined at nodes");

  return _variable->gradSlnOld();
}

gradientOlder()

template<typename T >

const OutputTools< T >::VariableGradient & MooseVariableInterface< T >::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 257 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("gradients are not defined at nodes");

  return _variable->gradSlnOlder();
}

mooseVariable()

template<typename T >

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

inherited

Get the variable that this object is using.

Returns

The variable this object is using.

Definition at line 70 of file MooseVariableInterface.C.

Referenced by ADIntegratedBCTempl< T, compute_stage >::ADIntegratedBCTempl(), ADKernelTempl< T, compute_stage >::ADKernelTempl(), and ADNodalBCTempl< T, compute_stage >::ADNodalBCTempl().

{
  return _variable;
}

neighborGradient()

template<typename T >

const OutputTools< T >::VariableGradient & NeighborMooseVariableInterface< T >::neighborGradient ( )

protectedvirtual

The gradient of the variable this object is operating on evaluated on the "neighbor" element.

Returns

The reference to be stored off and used later.

Definition at line 97 of file NeighborMooseVariableInterface.C.

{
  if (this->_nodal)
    mooseError("Nodal variables do not have gradients");

  return this->_variable->gradSlnNeighbor();
}

neighborGradientOld()

template<typename T >

const OutputTools< T >::VariableGradient & NeighborMooseVariableInterface< T >::neighborGradientOld ( )

protectedvirtual

The old gradient of the variable this object is operating on evaluated on the "neighbor" element.

Returns

The reference to be stored off and used later.

Definition at line 107 of file NeighborMooseVariableInterface.C.

{
  if (this->_nodal)
    mooseError("Nodal variables do not have gradients");

  return this->_variable->gradSlnOldNeighbor();
}

neighborGradientOlder()

template<typename T >

const OutputTools< T >::VariableGradient & NeighborMooseVariableInterface< T >::neighborGradientOlder ( )

protectedvirtual

The older gradient of the variable this object is operating on evaluated on the "neighbor" element.

Returns

The reference to be stored off and used later.

Definition at line 117 of file NeighborMooseVariableInterface.C.

{
  if (this->_nodal)
    mooseError("Nodal variables do not have gradients");

  return this->_variable->gradSlnOlderNeighbor();
}

neighborSecond()

template<typename T >

const OutputTools< T >::VariableSecond & NeighborMooseVariableInterface< T >::neighborSecond ( )

protectedvirtual

The second derivative of the variable this object is operating on evaluated on the "neighbor" element.

Returns

The reference to be stored off and used later.

Definition at line 127 of file NeighborMooseVariableInterface.C.

{
  if (this->_nodal)
    mooseError("Nodal variables do not have second derivatives");

  return this->_variable->secondSlnNeighbor();
}

neighborSecondOld()

template<typename T >

const OutputTools< T >::VariableSecond & NeighborMooseVariableInterface< T >::neighborSecondOld ( )

protectedvirtual

The old second derivative of the variable this object is operating on evaluated on the "neighbor" element.

Returns

The reference to be stored off and used later.

Definition at line 137 of file NeighborMooseVariableInterface.C.

{
  if (this->_nodal)
    mooseError("Nodal variables do not have second derivatives");

  return this->_variable->secondSlnOldNeighbor();
}

neighborSecondOlder()

template<typename T >

const OutputTools< T >::VariableSecond & NeighborMooseVariableInterface< T >::neighborSecondOlder ( )

protectedvirtual

The older second derivative of the variable this object is operating on evaluated on the "neighbor" element.

Returns

The reference to be stored off and used later.

Definition at line 147 of file NeighborMooseVariableInterface.C.

{
  if (this->_nodal)
    mooseError("Nodal variables do not have second derivatives");

  return this->_variable->secondSlnOlderNeighbor();
}

neighborSecondPhi()

template<typename T >

const OutputTools< T >::VariablePhiSecond & NeighborMooseVariableInterface< T >::neighborSecondPhi ( )

protectedvirtual

The second derivative of the neighbor's shape function.

Returns

The reference to be stored off and used later.

Definition at line 167 of file NeighborMooseVariableInterface.C.

{
  if (this->_nodal)
    mooseError("Nodal variables do not have second derivatives");

  return this->_mvi_assembly->secondPhiFaceNeighbor(*this->_variable);
}

neighborSecondTest()

template<typename T >

const OutputTools< T >::VariableTestSecond & NeighborMooseVariableInterface< T >::neighborSecondTest ( )

protectedvirtual

The second derivative of the neighbor's test function.

Returns

The reference to be stored off and used later.

Definition at line 157 of file NeighborMooseVariableInterface.C.

{
  if (this->_nodal)
    mooseError("Nodal variables do not have second derivatives");

  return this->_variable->secondPhiFaceNeighbor();
}

neighborValue() [1/2]

template<typename T >

const OutputTools< T >::VariableValue & NeighborMooseVariableInterface< T >::neighborValue ( )

protectedvirtual

The value of the variable this object is operating on evaluated on the "neighbor" element.

Returns

The reference to be stored off and used later.

Definition at line 37 of file NeighborMooseVariableInterface.C.

{
  if (this->_nodal)
    return this->_variable->dofValuesNeighbor();
  else
    return this->_variable->slnNeighbor();
}

neighborValue() [2/2]

template<>

const VectorVariableValue & NeighborMooseVariableInterface< RealVectorValue >::neighborValue ( )

protected

Definition at line 47 of file NeighborMooseVariableInterface.C.

{
  if (this->_nodal)
    mooseError("Dofs are scalars while vector variables have vector values. Mismatch");
  else
    return this->_variable->slnNeighbor();
}

neighborValueOld() [1/2]

template<typename T >

const OutputTools< T >::VariableValue & NeighborMooseVariableInterface< T >::neighborValueOld ( )

protectedvirtual

The old value of the variable this object is operating on evaluated on the "neighbor" element.

Returns

The reference to be stored off and used later.

Definition at line 57 of file NeighborMooseVariableInterface.C.

{
  if (this->_nodal)
    return this->_variable->dofValuesOldNeighbor();
  else
    return this->_variable->slnOldNeighbor();
}

neighborValueOld() [2/2]

template<>

const VectorVariableValue & NeighborMooseVariableInterface< RealVectorValue >::neighborValueOld ( )

protected

Definition at line 67 of file NeighborMooseVariableInterface.C.

{
  if (this->_nodal)
    mooseError("Dofs are scalars while vector variables have vector values. Mismatch");
  else
    return this->_variable->slnOldNeighbor();
}

neighborValueOlder() [1/2]

template<typename T >

const OutputTools< T >::VariableValue & NeighborMooseVariableInterface< T >::neighborValueOlder ( )

protectedvirtual

The older value of the variable this object is operating on evaluated on the "neighbor" element.

Returns

The reference to be stored off and used later.

Definition at line 77 of file NeighborMooseVariableInterface.C.

{
  if (this->_nodal)
    return this->_variable->dofValuesOlderNeighbor();
  else
    return this->_variable->slnOlderNeighbor();
}

neighborValueOlder() [2/2]

template<>

const VectorVariableValue & NeighborMooseVariableInterface< RealVectorValue >::neighborValueOlder ( )

protected

Definition at line 87 of file NeighborMooseVariableInterface.C.

{
  if (this->_nodal)
    mooseError("Dofs are scalars while vector variables have vector values. Mismatch");
  else
    return this->_variable->slnOlderNeighbor();
}

second()

template<typename T >

const OutputTools< T >::VariableSecond & MooseVariableInterface< T >::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 267 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");

  return _variable->secondSln();
}

secondOld()

template<typename T >

const OutputTools< T >::VariableSecond & MooseVariableInterface< T >::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 277 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");

  return _variable->secondSlnOld();
}

secondOlder()

template<typename T >

const OutputTools< T >::VariableSecond & MooseVariableInterface< T >::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 287 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");

  return _variable->secondSlnOlder();
}

secondPhi()

template<typename T >

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

protectedvirtualinherited

The second derivative of the trial function.

Returns

The reference to be stored off and used later.

Definition at line 317 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");

  return _mvi_assembly->secondPhi(*_variable);
}

secondPhiFace()

template<typename T >

const OutputTools< T >::VariablePhiSecond & MooseVariableInterface< T >::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 327 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");

  return _mvi_assembly->secondPhiFace(*_variable);
}

secondTest()

template<typename T >

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

protectedvirtualinherited

The second derivative of the test function.

Returns

The reference to be stored off and used later.

Definition at line 297 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");

  return _variable->secondPhi();
}

secondTestFace()

template<typename T >

const OutputTools< T >::VariableTestSecond & MooseVariableInterface< T >::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 307 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");

  return _variable->secondPhiFace();
}

value()

template<typename T >

const OutputTools< T >::VariableValue & MooseVariableInterface< T >::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 77 of file MooseVariableInterface.C.

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

valueOld()

template<typename T >

const OutputTools< T >::VariableValue & MooseVariableInterface< T >::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 97 of file MooseVariableInterface.C.

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

valueOlder()

template<typename T >

const OutputTools< T >::VariableValue & MooseVariableInterface< T >::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 117 of file MooseVariableInterface.C.

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

Member Data Documentation

_mvi_assembly

template<typename T>

Assembly* MooseVariableInterface< T >::_mvi_assembly

protectedinherited

Definition at line 204 of file MooseVariableInterface.h.

Referenced by MooseVariableInterface< Real >::MooseVariableInterface().

_nodal

template<typename T>

bool MooseVariableInterface< T >::_nodal

protectedinherited

Whether or not this object is acting only at nodes.

Definition at line 198 of file MooseVariableInterface.h.

_variable

template<typename T>

MooseVariableFE<T>* MooseVariableInterface< T >::_variable

protectedinherited

The variable this object is acting on.

Definition at line 201 of file MooseVariableInterface.h.

Referenced by MooseVariableInterface< Real >::MooseVariableInterface().

---

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

• include/variables/NeighborMooseVariableInterface.h
• src/variables/NeighborMooseVariableInterface.C