#include <MooseVariableDataBase.h>

Inheritance diagram for MooseVariableDataBase< OutputType >:

Public Types
typedef libMesh::TensorTools::IncrementRank< OutputType >::type	OutputGradient

typedef libMesh::TensorTools::IncrementRank< OutputGradient >::type	OutputSecond

typedef libMesh::TensorTools::DecrementRank< OutputType >::type	OutputDivergence

typedef MooseArray< OutputType >	FieldVariableValue

typedef MooseArray< OutputGradient >	FieldVariableGradient

typedef Moose::DOFType< OutputType >::type	DofValue

typedef Moose::ADType< DofValue >::type	ADDofValue

typedef MooseArray< DofValue >	DofValues

typedef MooseArray< ADDofValue >	ADDofValues

Public Member Functions
	MooseVariableDataBase (const MooseVariableField< OutputType > &var, SystemBase &sys, THREAD_ID tid)

virtual	~MooseVariableDataBase ()=default

virtual bool	isNodal () const =0

virtual bool	hasDoFsOnNodes () const =0
	Whether this data is associated with a variable that has DoFs on nodes.

virtual libMesh::FEContinuity	getContinuity () const =0
	Return the variable continuity.

const FieldVariableValue &	sln (Moose::SolutionState state) const
	Local solution getter.

const FieldVariableGradient &	gradSln (Moose::SolutionState state) const
	Local solution gradient getter.

unsigned int	oldestSolutionStateRequested () const
	The oldest solution state that is requested for this variable (0 = current, 1 = old, 2 = older, etc).

void	setNodalValue (const OutputType &value)
	Set nodal value.

void	insert (libMesh::NumericVector< libMesh::Number > &residual)
	Set the current local DOF values to the input vector.

void	add (libMesh::NumericVector< libMesh::Number > &residual)
	Add the current local DOF values to the input vector.

void	prepareIC ()
	prepare the initial condition

const DofValues &	dofValues () const

const DofValues &	dofValuesOld () const

const DofValues &	dofValuesOlder () const

const DofValues &	dofValuesPreviousNL () const

const OutputType &	nodalValue (Moose::SolutionState state) const

const MooseArray< OutputType > &	nodalValueArray (Moose::SolutionState state) const

const FieldVariableValue &	vectorTagValue (TagID tag) const

const FieldVariableGradient &	vectorTagGradient (TagID tag) const

const FieldVariableValue &	matrixTagValue (TagID tag) const

const DofValues &	nodalVectorTagValue (TagID tag) const

const DofValues &	nodalMatrixTagValue (TagID tag) const

const DofValues &	vectorTagDofValue (TagID tag) const

const DofValues &	vectorTagDofValue (Moose::SolutionState state) const

void	setActiveTags (const std::set< TagID > &vtags)
	Set the active vector tags.

void	prepareAux ()
	Clear aux state.

void	sizeMatrixTagData ()
	size matrix tag data

void	setNodalValue (const RealVectorValue &value)

void	insert (NumericVector< Number > &residual)

void	add (NumericVector< Number > &residual)

Protected Member Functions
virtual const MooseVariableField< OutputType > &	var () const

void	insertSolutionTag (TagID tag_id)
	insert a solution tag into our tag containers

void	needSolutionState (unsigned int state)
	Request that we have at least `state` number of older solution states/vectors.

void	fetchDofValues ()
	Helper methods for assigning dof values from their corresponding solution values.

void	zeroSizeDofValues ()

void	getArrayDofValues (const libMesh::NumericVector< libMesh::Number > &sol, unsigned int n, MooseArray< RealEigenVector > &dof_values) const

void	assignNodalValue ()

template<typename ReturnType , typename Functor >
const ReturnType &	stateToTagHelper (Moose::SolutionState state, Functor functor)
	Helper method that converts a `SolutionState` argument into a corresponding tag ID, potentially requesting necessary additional solution states and assigning tag id data members, and then calls the provided `functor` with the tag ID.

void	resizeVectorTagData (TagID tag)
	resize the vector tag need flags and data containers to accomodate this tag index

void	fetchDofValues ()

void	assignNodalValue ()

void	fetchDofValues ()

void	assignNodalValue ()

Protected Attributes
SystemBase &	_sys
	The MOOSE system which ultimately holds the vectors and matrices relevant to this variable data.

const SubProblem &	_subproblem
	The subproblem which we can query for information related to tagged vectors and matrices.

const THREAD_ID	_tid
	The thread ID that this object is on.

const libMesh::DofMap &	_dof_map
	The degree of freedom map from libMesh.

unsigned int	_count
	Number of components of the associated variable.

bool	_has_dof_values
	Whether we currently have degree of freedom values stored in our local containers (corresponding to the current element)

unsigned int	_max_state
	The maximum number of older solution states our variable needs.

TagID	_solution_tag
	The vector tag ID corresponding to the solution vector.

TagID	_old_solution_tag
	The vector tag ID corresponding to the old solution vector.

TagID	_older_solution_tag
	The vector tag ID corresponding to the older solution vector.

TagID	_previous_nl_solution_tag
	The vector tag ID corresponding to the previous nonlinear iteration's solution vector.

std::vector< dof_id_type >	_dof_indices
	The dof indices for the current element.

std::vector< bool >	_need_vector_tag_dof_u

std::vector< bool >	_need_matrix_tag_dof_u

std::vector< DofValues >	_vector_tags_dof_u

std::vector< DofValues >	_matrix_tags_dof_u

std::vector< FieldVariableValue >	_vector_tag_u

std::vector< bool >	_need_vector_tag_u

std::vector< FieldVariableGradient >	_vector_tag_grad

std::vector< bool >	_need_vector_tag_grad

std::vector< FieldVariableValue >	_matrix_tag_u

std::vector< bool >	_need_matrix_tag_u

OutputType	_nodal_value
	Nodal values.

OutputType	_nodal_value_old

OutputType	_nodal_value_older

OutputType	_nodal_value_previous_nl

MooseArray< OutputType >	_nodal_value_array
	Nodal values as MooseArrays for use with AuxKernels.

MooseArray< OutputType >	_nodal_value_old_array

MooseArray< OutputType >	_nodal_value_older_array

bool	_need_u_dot
	u dot flags

bool	_need_u_dotdot

bool	_need_u_dot_old

bool	_need_u_dotdot_old

bool	_need_du_dot_du

bool	_need_du_dotdot_du

bool	_need_grad_dot
	gradient dot flags

bool	_need_grad_dotdot

bool	_need_dof_values_dot
	local solution flags

bool	_need_dof_values_dotdot

bool	_need_dof_values_dot_old

bool	_need_dof_values_dotdot_old

bool	_need_dof_du_dot_du

bool	_need_dof_du_dotdot_du

DofValues	_dof_values_dot
	time derivative of the solution values

DofValues	_dof_values_dotdot
	second time derivative of the solution values

DofValues	_dof_values_dot_old
	the previous time step's solution value time derivative

DofValues	_dof_values_dotdot_old
	the previous time step's solution value second time derivative

MooseArray< libMesh::Number >	_dof_du_dot_du
	derivatives of the solution value time derivative with respect to the degrees of freedom

MooseArray< libMesh::Number >	_dof_du_dotdot_du
	derivatives of the solution value second time derivative with respect to the degrees of freedom

OutputType	_nodal_value_dot
	nodal values of u_dot

OutputType	_nodal_value_dotdot
	nodal values of u_dotdot

OutputType	_nodal_value_dot_old
	nodal values of u_dot_old

OutputType	_nodal_value_dotdot_old
	nodal values of u_dotdot_old

std::set< TagID >	_required_vector_tags
	The set of vector tags (residual + solution) we need to evaluate.

std::set< TagID >	_solution_tags
	The set of solution tags we need to evaluate.

Private Attributes
const MooseVariableField< OutputType > &	_var
	A const reference to the owning MooseVariableField object.

Detailed Description

template<typename OutputType>
class MooseVariableDataBase< OutputType >

Definition at line 33 of file MooseVariableDataBase.h.

Member Typedef Documentation

◆ ADDofValue

template<typename OutputType >

typedef Moose::ADType<DofValue>::type MooseVariableDataBase< OutputType >::ADDofValue

Definition at line 47 of file MooseVariableDataBase.h.

◆ ADDofValues

template<typename OutputType >

typedef MooseArray<ADDofValue> MooseVariableDataBase< OutputType >::ADDofValues

Definition at line 49 of file MooseVariableDataBase.h.

◆ DofValue

template<typename OutputType >

typedef Moose::DOFType<OutputType>::type MooseVariableDataBase< OutputType >::DofValue

Definition at line 46 of file MooseVariableDataBase.h.

◆ DofValues

template<typename OutputType >

typedef MooseArray<DofValue> MooseVariableDataBase< OutputType >::DofValues

Definition at line 48 of file MooseVariableDataBase.h.

◆ FieldVariableGradient

template<typename OutputType >

typedef MooseArray<OutputGradient> MooseVariableDataBase< OutputType >::FieldVariableGradient

Definition at line 43 of file MooseVariableDataBase.h.

◆ FieldVariableValue

template<typename OutputType >

typedef MooseArray<OutputType> MooseVariableDataBase< OutputType >::FieldVariableValue

Definition at line 42 of file MooseVariableDataBase.h.

◆ OutputDivergence

template<typename OutputType >

typedef libMesh::TensorTools::DecrementRank<OutputType>::type MooseVariableDataBase< OutputType >::OutputDivergence

Definition at line 39 of file MooseVariableDataBase.h.

◆ OutputGradient

template<typename OutputType >

typedef libMesh::TensorTools::IncrementRank<OutputType>::type MooseVariableDataBase< OutputType >::OutputGradient

Definition at line 37 of file MooseVariableDataBase.h.

◆ OutputSecond

template<typename OutputType >

typedef libMesh::TensorTools::IncrementRank<OutputGradient>::type MooseVariableDataBase< OutputType >::OutputSecond

Definition at line 38 of file MooseVariableDataBase.h.

Constructor & Destructor Documentation

◆ MooseVariableDataBase()

template<typename OutputType >

MooseVariableDataBase< OutputType >::MooseVariableDataBase	(	const MooseVariableField< OutputType > &	var,
		SystemBase &	sys,
		THREAD_ID	tid
	)

Definition at line 20 of file MooseVariableDataBase.C.

  : _sys(sys),
    _subproblem(_sys.subproblem()),
    _tid(tid),
    _dof_map(_sys.dofMap()),
    _count(var.count()),
    _has_dof_values(false),
    _max_state(0),
    _solution_tag(_subproblem.getVectorTagID(Moose::SOLUTION_TAG)),
    _old_solution_tag(Moose::INVALID_TAG_ID),
    _older_solution_tag(Moose::INVALID_TAG_ID),
    _previous_nl_solution_tag(Moose::INVALID_TAG_ID),
    _need_u_dot(false),
    _need_u_dotdot(false),
    _need_u_dot_old(false),
    _need_u_dotdot_old(false),
    _need_du_dot_du(false),
    _need_du_dotdot_du(false),
    _need_grad_dot(false),
    _need_grad_dotdot(false),
    _need_dof_values_dot(false),
    _need_dof_values_dotdot(false),
    _need_dof_values_dot_old(false),
    _need_dof_values_dotdot_old(false),
    _need_dof_du_dot_du(false),
    _need_dof_du_dotdot_du(false),
    _var(var)
{
  auto num_vector_tags = _subproblem.numVectorTags();
  // Additional solution tags corresponding to older-than-current solution states may be requested
  // on-the-fly by consumer objects after variable construction. To accomodate this we should
  // reserve the possibly requisite memory. As of now we only support old and older solution states
  // but this could potentially increase in the future
  const auto max_future_num_vector_tags = num_vector_tags + 2;
 
  _vector_tags_dof_u.reserve(max_future_num_vector_tags);
  _vector_tags_dof_u.resize(num_vector_tags);
  _need_vector_tag_dof_u.reserve(max_future_num_vector_tags);
  _need_vector_tag_dof_u.resize(num_vector_tags, false);
 
  _need_vector_tag_u.reserve(max_future_num_vector_tags);
  _need_vector_tag_u.resize(num_vector_tags, false);
  _vector_tag_u.reserve(max_future_num_vector_tags);
  _vector_tag_u.resize(num_vector_tags);
 
  _need_vector_tag_grad.reserve(max_future_num_vector_tags);
  _need_vector_tag_grad.resize(num_vector_tags, false);
  _vector_tag_grad.reserve(max_future_num_vector_tags);
  _vector_tag_grad.resize(num_vector_tags);
 
  // Always fetch the dof values for the solution tag
  const auto soln_tag = _subproblem.getVectorTagID(Moose::SOLUTION_TAG);
  _need_vector_tag_dof_u[soln_tag] = true;
  _need_vector_tag_u[soln_tag] = true;
  insertSolutionTag(soln_tag);
 
  // These MooseArray objects are used by AuxKernelBase for nodal AuxKernel objects, hence the size
  // size is always 1 (i.e, nodal kernels work with _qp=0 only).
  _nodal_value_array.resize(1);
  _nodal_value_old_array.resize(1);
  _nodal_value_older_array.resize(1);
}

◆ ~MooseVariableDataBase()

template<typename OutputType >

virtual MooseVariableDataBase< OutputType >::~MooseVariableDataBase ( )

virtualdefault

Member Function Documentation

◆ add() [1/2]

template<typename OutputType >

void MooseVariableDataBase< OutputType >::add ( libMesh::NumericVector< libMesh::Number > & residual )

Add the current local DOF values to the input vector.

Definition at line 468 of file MooseVariableDataBase.C.

{
  if (_has_dof_values)
  {
    const auto & dof_values = _vector_tags_dof_u[_solution_tag];
    residual.add_vector(&dof_values[0], _dof_indices);
  }
}

◆ add() [2/2]

void MooseVariableDataBase< RealEigenVector >::add ( NumericVector< Number > & residual )

Definition at line 479 of file MooseVariableDataBase.C.

{
  if (_has_dof_values)
  {
    const auto & dof_values = _vector_tags_dof_u[_solution_tag];
    mooseAssert(_dof_indices.size() % _count == 0,
                "Dof indices should be cleanly divisible by the variable count");
    const auto n_shapes = _dof_indices.size() / _count;
    for (const auto indx : index_range(_dof_indices))
    {
      const auto i = indx % n_shapes;
      const auto j = indx / n_shapes;
      residual.add(_dof_indices[indx], dof_values[i](j));
    }
  }
}

◆ assignNodalValue() [1/3]

template<typename OutputType >

void MooseVariableDataBase< OutputType >::assignNodalValue ( )

protected

Definition at line 763 of file MooseVariableDataBase.C.

{
  bool is_transient = _subproblem.isTransient();
  libmesh_assert(_dof_indices.size());
 
  auto & dof_values = _vector_tags_dof_u[_solution_tag];
  _nodal_value = dof_values[0];
  _nodal_value_array[0] = _nodal_value;
 
  if (is_transient)
  {
    if (oldestSolutionStateRequested() >= 1)
    {
      _nodal_value_old = _vector_tags_dof_u[_old_solution_tag][0];
      _nodal_value_old_array[0] = _nodal_value_old;
    }
    if (oldestSolutionStateRequested() >= 2)
    {
      _nodal_value_older = _vector_tags_dof_u[_older_solution_tag][0];
      _nodal_value_older_array[0] = _nodal_value_older;
    }
    if (_need_dof_values_dot)
      _nodal_value_dot = _dof_values_dot[0];
    if (_need_dof_values_dotdot)
      _nodal_value_dotdot = _dof_values_dotdot[0];
    if (_need_dof_values_dot_old)
      _nodal_value_dot_old = _dof_values_dot_old[0];
    if (_need_dof_values_dotdot_old)
      _nodal_value_dotdot_old = _dof_values_dotdot_old[0];
  }
  if (_previous_nl_solution_tag != Moose::INVALID_TAG_ID)
    _nodal_value_previous_nl = _vector_tags_dof_u[_previous_nl_solution_tag][0];
}

◆ assignNodalValue() [2/3]

void MooseVariableDataBase< RealVectorValue >::assignNodalValue ( )

protected

◆ assignNodalValue() [3/3]

void MooseVariableDataBase< RealVectorValue >::assignNodalValue ( )

protected

Definition at line 799 of file MooseVariableDataBase.C.

{
  bool is_transient = _subproblem.isTransient();
 
  auto n = _dof_indices.size();
  libmesh_assert(n);
 
  auto & dof_values = _vector_tags_dof_u[_solution_tag];
  for (decltype(n) i = 0; i < n; ++i)
    _nodal_value(i) = dof_values[i];
  _nodal_value_array[0] = _nodal_value;
 
  if (is_transient)
  {
    if (oldestSolutionStateRequested() >= 1)
    {
      auto & dof_values_old = _vector_tags_dof_u[_old_solution_tag];
      for (decltype(n) i = 0; i < n; ++i)
        _nodal_value_old(i) = dof_values_old[i];
      _nodal_value_old_array[0] = _nodal_value_old;
    }
    if (oldestSolutionStateRequested() >= 2)
    {
      auto & dof_values_older = _vector_tags_dof_u[_older_solution_tag];
      for (decltype(n) i = 0; i < n; ++i)
        _nodal_value_older(i) = dof_values_older[i];
      _nodal_value_older_array[0] = _nodal_value_older;
    }
    if (_need_dof_values_dot)
      for (decltype(n) i = 0; i < n; ++i)
        _nodal_value_dot(i) = _dof_values_dot[i];
    if (_need_dof_values_dotdot)
      for (decltype(n) i = 0; i < n; ++i)
        _nodal_value_dotdot(i) = _dof_values_dotdot[i];
    if (_need_dof_values_dot_old)
      for (decltype(n) i = 0; i < n; ++i)
        _nodal_value_dot_old(i) = _dof_values_dot_old[i];
    if (_need_dof_values_dotdot_old)
      for (decltype(n) i = 0; i < n; ++i)
        _nodal_value_dotdot_old(i) = _dof_values_dotdot_old[i];
  }
  if (_previous_nl_solution_tag != Moose::INVALID_TAG_ID)
  {
    auto & dof_values_previous_nl = _vector_tags_dof_u[_previous_nl_solution_tag];
    for (decltype(n) i = 0; i < n; ++i)
      _nodal_value_previous_nl(i) = dof_values_previous_nl[i];
  }
}

◆ dofValues()

template<typename OutputType >

const MooseVariableDataBase< OutputType >::DofValues & MooseVariableDataBase< OutputType >::dofValues ( ) const

Definition at line 354 of file MooseVariableDataBase.C.

{
  return vectorTagDofValue(Moose::Current);
}

◆ dofValuesOld()

template<typename OutputType >

const MooseVariableDataBase< OutputType >::DofValues & MooseVariableDataBase< OutputType >::dofValuesOld ( ) const

Definition at line 361 of file MooseVariableDataBase.C.

{
  return vectorTagDofValue(Moose::Old);
}

◆ dofValuesOlder()

template<typename OutputType >

const MooseVariableDataBase< OutputType >::DofValues & MooseVariableDataBase< OutputType >::dofValuesOlder ( ) const

Definition at line 368 of file MooseVariableDataBase.C.

{
  return vectorTagDofValue(Moose::Older);
}

◆ dofValuesPreviousNL()

template<typename OutputType >

const MooseVariableDataBase< OutputType >::DofValues & MooseVariableDataBase< OutputType >::dofValuesPreviousNL ( ) const

Definition at line 375 of file MooseVariableDataBase.C.

{
  return vectorTagDofValue(Moose::PreviousNL);
}

◆ fetchDofValues() [1/3]

template<typename OutputType >

void MooseVariableDataBase< OutputType >::fetchDofValues ( )

protected

Helper methods for assigning dof values from their corresponding solution values.

Definition at line 561 of file MooseVariableDataBase.C.

{
  bool is_transient = _subproblem.isTransient();
 
  auto n = _dof_indices.size();
  libmesh_assert(n);
 
  if (is_transient)
  {
    if (_need_u_dot || _need_grad_dot || _need_dof_values_dot)
    {
      libmesh_assert(_sys.solutionUDot());
      _dof_values_dot.resize(n);
      _sys.solutionUDot()->get(_dof_indices, &_dof_values_dot[0]);
    }
    if (_need_u_dotdot || _need_grad_dotdot || _need_dof_values_dotdot)
    {
      libmesh_assert(_sys.solutionUDotDot());
      _dof_values_dotdot.resize(n);
      _sys.solutionUDotDot()->get(_dof_indices, &_dof_values_dotdot[0]);
    }
    if (_need_u_dot_old || _need_dof_values_dot_old)
    {
      libmesh_assert(_sys.solutionUDotOld());
      _dof_values_dot_old.resize(n);
      _sys.solutionUDotOld()->get(_dof_indices, &_dof_values_dot_old[0]);
    }
    if (_need_u_dotdot_old || _need_dof_values_dotdot_old)
    {
      libmesh_assert(_sys.solutionUDotDotOld());
      _dof_values_dotdot_old.resize(n);
      _sys.solutionUDotDotOld()->get(_dof_indices, &_dof_values_dotdot_old[0]);
    }
    if (_need_du_dot_du || _need_dof_du_dot_du)
    {
      _dof_du_dot_du.resize(n);
      for (decltype(n) i = 0; i < n; ++i)
        _dof_du_dot_du[i] = _sys.duDotDu(_var.number());
    }
    if (_need_du_dotdot_du || _need_dof_du_dotdot_du)
    {
      _dof_du_dotdot_du.resize(n);
      for (decltype(n) i = 0; i < n; ++i)
        _dof_du_dotdot_du[i] = _sys.duDotDotDu();
    }
  }
 
  for (auto tag : _required_vector_tags)
    if (_need_vector_tag_u[tag] || _need_vector_tag_grad[tag] || _need_vector_tag_dof_u[tag])
      if ((_subproblem.vectorTagType(tag) == Moose::VECTOR_TAG_RESIDUAL &&
           _subproblem.safeAccessTaggedVectors()) ||
          _subproblem.vectorTagType(tag) == Moose::VECTOR_TAG_SOLUTION)
      {
        // tag is defined on problem but may not be used by a system
        // the grain tracker requires being able to read from solution vectors that we are also in
        // the process of writing :-/
        // Note: the extra vector tags are also still not closed when a TagVectorAux uses them
        if (_sys.hasVector(tag) /* && _sys.getVector(tag).closed()*/)
        {
          auto & vec = _sys.getVector(tag);
          _vector_tags_dof_u[tag].resize(n);
          vec.get(_dof_indices, &_vector_tags_dof_u[tag][0]);
        }
      }
 
  if (_subproblem.safeAccessTaggedMatrices())
  {
    auto & active_coupleable_matrix_tags =
        _subproblem.getActiveFEVariableCoupleableMatrixTags(_tid);
 
    for (auto tag : active_coupleable_matrix_tags)
    {
      if (_need_matrix_tag_dof_u[tag] || _need_matrix_tag_u[tag])
        if (_sys.hasMatrix(tag) && _sys.matrixTagActive(tag))
        {
          mooseAssert(_sys.getMatrix(tag).closed(),
                      "Matrix with tag '" + std::to_string(tag) + "' should be closed");
          auto & mat = _sys.getMatrix(tag);
          _matrix_tags_dof_u[tag].resize(n);
          for (unsigned i = 0; i < n; i++)
            _matrix_tags_dof_u[tag][i] = mat(_dof_indices[i], _dof_indices[i]);
        }
    }
  }
}

◆ fetchDofValues() [2/3]

void MooseVariableDataBase< RealEigenVector >::fetchDofValues ( )

protected

◆ fetchDofValues() [3/3]

void MooseVariableDataBase< RealEigenVector >::fetchDofValues ( )

protected

Definition at line 664 of file MooseVariableDataBase.C.

{
  bool is_transient = _subproblem.isTransient();
 
  auto n = _dof_indices.size() / _count;
  libmesh_assert(n);
 
  if (is_transient)
  {
    if (_need_u_dot || _need_grad_dot || _need_dof_values_dot)
    {
      libmesh_assert(_sys.solutionUDot());
      getArrayDofValues(*_sys.solutionUDot(), n, _dof_values_dot);
    }
    if (_need_u_dotdot || _need_grad_dotdot || _need_dof_values_dotdot)
    {
      libmesh_assert(_sys.solutionUDotDot());
      getArrayDofValues(*_sys.solutionUDot(), n, _dof_values_dotdot);
    }
    if (_need_u_dot_old || _need_dof_values_dot_old)
    {
      libmesh_assert(_sys.solutionUDotOld());
      getArrayDofValues(*_sys.solutionUDotOld(), n, _dof_values_dot_old);
    }
    if (_need_u_dotdot_old || _need_dof_values_dotdot_old)
    {
      libmesh_assert(_sys.solutionUDotDotOld());
      getArrayDofValues(*_sys.solutionUDotDotOld(), n, _dof_values_dotdot_old);
    }
  }
 
  for (auto tag : _required_vector_tags)
    if ((_subproblem.vectorTagType(tag) == Moose::VECTOR_TAG_RESIDUAL &&
         _subproblem.safeAccessTaggedVectors()) ||
        _subproblem.vectorTagType(tag) == Moose::VECTOR_TAG_SOLUTION)
      // tag is defined on problem but may not be used by a system
      if (_sys.hasVector(tag))
      {
        mooseAssert(_sys.getVector(tag).closed(),
                    "Vector with tag '" + std::to_string(tag) + "' should be closed");
        getArrayDofValues(_sys.getVector(tag), n, _vector_tags_dof_u[tag]);
      }
 
  if (_subproblem.safeAccessTaggedMatrices())
  {
    auto & active_coupleable_matrix_tags =
        _subproblem.getActiveFEVariableCoupleableMatrixTags(_tid);
    for (auto tag : active_coupleable_matrix_tags)
    {
      _matrix_tags_dof_u[tag].resize(n);
      if (_need_matrix_tag_dof_u[tag] || _need_matrix_tag_u[tag])
        if (_sys.hasMatrix(tag) && _sys.matrixTagActive(tag))
        {
          mooseAssert(_sys.getMatrix(tag).closed(),
                      "Matrix with tag '" + std::to_string(tag) + "' should be closed");
          auto & mat = _sys.getMatrix(tag);
          for (unsigned i = 0; i < n; i++)
            for (unsigned j = 0; j < _count; j++)
              _matrix_tags_dof_u[tag][i](j) = mat(_dof_indices[i] + j, _dof_indices[i] + j);
        }
    }
  }
 
  if (_need_du_dot_du || _need_dof_du_dot_du)
  {
    _dof_du_dot_du.resize(n);
    for (decltype(n) i = 0; i < n; ++i)
      _dof_du_dot_du[i] = _sys.duDotDu(_var.number());
  }
  if (_need_du_dotdot_du || _need_dof_du_dotdot_du)
  {
    _dof_du_dotdot_du.resize(n);
    for (decltype(n) i = 0; i < n; ++i)
      _dof_du_dotdot_du[i] = _sys.duDotDotDu();
  }
}

◆ getArrayDofValues()

template<typename OutputType >

void MooseVariableDataBase< OutputType >::getArrayDofValues	(	const libMesh::NumericVector< libMesh::Number > &	sol,
		unsigned int	n,
		MooseArray< RealEigenVector > &	dof_values
	)		const

protected

Definition at line 649 of file MooseVariableDataBase.C.

{
  dof_values.resize(nshapes);
  for (const auto i : make_range(nshapes))
  {
    dof_values[i].resize(_count);
    for (const auto j : make_range(_count))
      dof_values[i](j) = sol(_dof_indices[j * nshapes + i]);
  }
}

◆ getContinuity()

template<typename OutputType >

virtual libMesh::FEContinuity MooseVariableDataBase< OutputType >::getContinuity ( ) const

pure virtual

Return the variable continuity.

Implemented in MooseVariableData< OutputType >, MooseVariableDataFV< OutputType >, and MooseVariableDataLinearFV< OutputType >.

◆ gradSln()

template<typename OutputType >

const MooseVariableDataBase< OutputType >::FieldVariableGradient & MooseVariableDataBase< OutputType >::gradSln ( Moose::SolutionState state ) const

Local solution gradient getter.

Parameters

state The state of the simulation: current, old, older, previous nl

Definition at line 329 of file MooseVariableDataBase.C.

{
  auto functor = [this](TagID tag_id) -> const FieldVariableGradient &
  { return vectorTagGradient(tag_id); };
 
  _var.requireQpComputations();
 
  return const_cast<MooseVariableDataBase<OutputType> *>(this)
      ->stateToTagHelper<FieldVariableGradient>(state, functor);
}

◆ hasDoFsOnNodes()

template<typename OutputType >

virtual bool MooseVariableDataBase< OutputType >::hasDoFsOnNodes ( ) const

pure virtual

Whether this data is associated with a variable that has DoFs on nodes.

Implemented in MooseVariableData< OutputType >, MooseVariableDataFV< OutputType >, and MooseVariableDataLinearFV< OutputType >.

◆ insert() [1/2]

template<typename OutputType >

void MooseVariableDataBase< OutputType >::insert ( libMesh::NumericVector< libMesh::Number > & residual )

Set the current local DOF values to the input vector.

Definition at line 436 of file MooseVariableDataBase.C.

{
  if (_has_dof_values)
  {
    const auto & dof_values = _vector_tags_dof_u[_solution_tag];
    mooseAssert(dof_values.size() == _dof_indices.size(),
                "Degree of freedom values size and degree of freedom indices sizes must match.");
    residual.insert(&dof_values[0], _dof_indices);
  }
}

◆ insert() [2/2]

void MooseVariableDataBase< RealEigenVector >::insert ( NumericVector< Number > & residual )

Definition at line 449 of file MooseVariableDataBase.C.

{
  if (_has_dof_values)
  {
    const auto & dof_values = _vector_tags_dof_u[_solution_tag];
    mooseAssert(_dof_indices.size() % _count == 0,
                "Dof indices should be cleanly divisible by the variable count");
    const auto n_shapes = _dof_indices.size() / _count;
    for (const auto indx : index_range(_dof_indices))
    {
      const auto i = indx % n_shapes;
      const auto j = indx / n_shapes;
      residual.set(_dof_indices[indx], dof_values[i](j));
    }
  }
}

◆ insertSolutionTag()

template<typename OutputType >

void MooseVariableDataBase< OutputType >::insertSolutionTag ( TagID tag_id )

protected

insert a solution tag into our tag containers

Definition at line 330 of file MooseVariableDataBase.h.

{
  _solution_tags.insert(tag_id);
  _required_vector_tags.insert(tag_id);
}

Referenced by MooseVariableDataBase< OutputType >::MooseVariableDataBase().

◆ isNodal()

template<typename OutputType >

virtual bool MooseVariableDataBase< OutputType >::isNodal ( ) const

pure virtual

Returns: Whether this data is associated with a nodal variable

Implemented in MooseVariableData< OutputType >, MooseVariableDataFV< OutputType >, and MooseVariableDataLinearFV< OutputType >.

◆ matrixTagValue()

template<typename OutputType >

const MooseVariableDataBase< OutputType >::FieldVariableValue & MooseVariableDataBase< OutputType >::matrixTagValue ( TagID tag ) const

Definition at line 232 of file MooseVariableDataBase.C.

{
  if (tag >= _matrix_tag_u.size())
  {
    _need_matrix_tag_u.resize(tag + 1, false);
    const_cast<MooseVariableDataBase<OutputType> *>(this)->_matrix_tag_u.resize(tag + 1);
  }
 
  _var.requireQpComputations();
 
  _need_matrix_tag_u[tag] = true;
 
  if (_sys.hasMatrix(tag))
    return _matrix_tag_u[tag];
  else
    mooseError("Tag ", tag, " is not associated with any matrix for variable ", _var.name());
}

◆ needSolutionState()

template<typename OutputType >

void MooseVariableDataBase< OutputType >::needSolutionState ( unsigned int state )

protected

Request that we have at least state number of older solution states/vectors.

Definition at line 259 of file MooseVariableDataBase.C.

{
  if (state > _max_state)
  {
    _sys.needSolutionState(state);
    _max_state = state;
  }
}

◆ nodalMatrixTagValue()

template<typename OutputType >

const MooseVariableDataBase< OutputType >::DofValues & MooseVariableDataBase< OutputType >::nodalMatrixTagValue ( TagID tag ) const

Definition at line 123 of file MooseVariableDataBase.C.

{
  if (isNodal())
  {
    if (tag >= _matrix_tags_dof_u.size())
    {
      _need_matrix_tag_dof_u.resize(tag + 1, false);
      const_cast<MooseVariableDataBase<OutputType> *>(this)->_matrix_tags_dof_u.resize(tag + 1);
    }
 
    _need_matrix_tag_dof_u[tag] = true;
 
    if (_sys.hasMatrix(tag))
      return _matrix_tags_dof_u[tag];
    else
      mooseError(
          "Tag ", tag, " is not associated with any matrix for nodal variable ", _var.name());
  }
  else
    mooseError("Nodal values can be requested only on nodal variables, variable '",
               _var.name(),
               "' is not nodal.");
}

◆ nodalValue()

template<typename OutputType >

const OutputType & MooseVariableDataBase< OutputType >::nodalValue ( Moose::SolutionState state ) const

Definition at line 498 of file MooseVariableDataBase.C.

{
  if (isNodal())
  {
    // Request the correct solution states and data members
    vectorTagDofValue(state);
    switch (state)
    {
      case Moose::Current:
        return _nodal_value;
 
      case Moose::Old:
        return _nodal_value_old;
 
      case Moose::Older:
        return _nodal_value_older;
 
      case Moose::PreviousNL:
        return _nodal_value_previous_nl;
 
      default:
        // We should never get here but gcc requires that we have a default. See
        // htpps://stackoverflow.com/questions/18680378/after-defining-case-for-all-enum-values-compiler-still-says-control-reaches-e
        mooseError("Unknown SolutionState!");
    }
  }
  else
    mooseError("Nodal values can be requested only on nodal variables, variable '",
               _var.name(),
               "' is not nodal.");
}

◆ nodalValueArray()

template<typename OutputType >

const MooseArray< OutputType > & MooseVariableDataBase< OutputType >::nodalValueArray ( Moose::SolutionState state ) const

Definition at line 532 of file MooseVariableDataBase.C.

{
  if (isNodal())
  {
    // Request the correct solution states and data members
    vectorTagDofValue(state);
    switch (state)
    {
      case Moose::Current:
        return _nodal_value_array;
 
      case Moose::Old:
        return _nodal_value_old_array;
 
      case Moose::Older:
        return _nodal_value_older_array;
 
      default:
        mooseError("No current support for PreviousNL for nodal value array");
    }
  }
  else
    mooseError("Nodal values can be requested only on nodal variables, variable '",
               _var.name(),
               "' is not nodal.");
}

◆ nodalVectorTagValue()

template<typename OutputType >

const MooseVariableDataBase< OutputType >::DofValues & MooseVariableDataBase< OutputType >::nodalVectorTagValue ( TagID tag ) const

Definition at line 100 of file MooseVariableDataBase.C.

{
  if (isNodal())
  {
    if (tag >= _need_vector_tag_dof_u.size())
      const_cast<MooseVariableDataBase<OutputType> *>(this)->resizeVectorTagData(tag);
 
    _need_vector_tag_dof_u[tag] = true;
 
    if (_sys.hasVector(tag))
      return _vector_tags_dof_u[tag];
    else
      mooseError(
          "Tag ", tag, " is not associated with any vector for nodal variable ", _var.name());
  }
  else
    mooseError("Nodal values can be requested only on nodal variables, variable '",
               _var.name(),
               "' is not nodal.");
}

◆ oldestSolutionStateRequested()

template<typename OutputType >

unsigned int MooseVariableDataBase< OutputType >::oldestSolutionStateRequested ( ) const

The oldest solution state that is requested for this variable (0 = current, 1 = old, 2 = older, etc).

Definition at line 252 of file MooseVariableDataBase.C.

{
  return _max_state;
}

◆ prepareAux()

template<typename OutputType >

void MooseVariableDataBase< OutputType >::prepareAux ( )

inline

Clear aux state.

Definition at line 142 of file MooseVariableDataBase.h.

142{ _has_dof_values = false; }

◆ prepareIC()

template<typename OutputType >

void MooseVariableDataBase< OutputType >::prepareIC ( )

prepare the initial condition

◆ resizeVectorTagData()

template<typename OutputType >

void MooseVariableDataBase< OutputType >::resizeVectorTagData ( TagID tag )

protected

resize the vector tag need flags and data containers to accomodate this tag index

Definition at line 149 of file MooseVariableDataBase.C.

{
  mooseAssert(_need_vector_tag_dof_u.size() == _need_vector_tag_u.size() &&
                  _need_vector_tag_dof_u.size() == _need_vector_tag_grad.size() &&
                  _need_vector_tag_dof_u.size() == _vector_tags_dof_u.size() &&
                  _need_vector_tag_dof_u.size() == _vector_tag_u.size() &&
                  _need_vector_tag_dof_u.size() == _vector_tag_grad.size(),
              "These sizes should be in sync.");
 
  auto check_capacity = [tag](const auto & vector_to_check)
  {
    if (tag + 1 > vector_to_check.capacity())
      mooseError("New size greater than tag capacity. This will cause reallocation which will "
                 "invalidate any stored references.");
  };
  check_capacity(_need_vector_tag_dof_u);
  check_capacity(_need_vector_tag_u);
  check_capacity(_need_vector_tag_grad);
  check_capacity(_vector_tags_dof_u);
  check_capacity(_vector_tag_u);
  check_capacity(_vector_tag_grad);
 
  _need_vector_tag_dof_u.resize(tag + 1, false);
  _need_vector_tag_u.resize(tag + 1, false);
  _need_vector_tag_grad.resize(tag + 1, false);
  _vector_tags_dof_u.resize(tag + 1);
  _vector_tag_u.resize(tag + 1);
  _vector_tag_grad.resize(tag + 1);
}

◆ setActiveTags()

template<typename OutputType >

void MooseVariableDataBase< OutputType >::setActiveTags ( const std::set< TagID > & vtags )

Set the active vector tags.

Parameters

vtags Additional vector tags that this variable will need to query at dof indices for, in addition to our own required solution tags

Definition at line 314 of file MooseVariableDataBase.h.

{
  _required_vector_tags = _solution_tags;
  for (const auto tag : vtags)
    _required_vector_tags.insert(tag);
 
  if (!_required_vector_tags.empty())
  {
    const auto largest_tag_id = *_required_vector_tags.rbegin();
    if (largest_tag_id >= _need_vector_tag_dof_u.size())
      resizeVectorTagData(largest_tag_id);
  }
}

◆ setNodalValue() [1/2]

template<typename OutputType >

void MooseVariableDataBase< OutputType >::setNodalValue ( const OutputType & value )

Set nodal value.

Definition at line 382 of file MooseVariableDataBase.C.

{
  // dof_values here is indexed per shape function, with each entry holding all _count array
  // components packed into a single OutputType value. setNodalValue writes only one shape
  // function's value, so it is only valid for a variable with a single shape function, e.g. a
  // nodal Lagrange variable or a CONSTANT-order elemental variable; a variable with more than
  // one shape function must use setDofValues instead. A subparametric variable, e.g. the pressure
  // of a Taylor-Hood pair, has nodes on its elements that carry none of its degrees of freedom;
  // callers query isNodalDefined() to skip those nodes before reaching this method.
  mooseAssert(_dof_indices.size() == _count,
              "setNodalValue is only valid for a variable with one shape function per node");
  auto & dof_values = _vector_tags_dof_u[_solution_tag];
  dof_values.resize(/*n_shapes=*/1);
  dof_values[0] = value; // update variable nodal value
  _has_dof_values = true;
  _nodal_value = value;
 
  // Update the qp values as well
  auto & u = _vector_tag_u[_solution_tag];
  for (unsigned int qp = 0; qp < u.size(); qp++)
    u[qp] = value;
}

◆ setNodalValue() [2/2]

void MooseVariableDataBase< RealVectorValue >::setNodalValue ( const RealVectorValue & value )

Definition at line 407 of file MooseVariableDataBase.C.

{
  // Unlike the generic implementation above, a vector-valued variable is never an array
  // variable, so _count is always 1 and dof_values is indexed per component of the vector
  // rather than per shape function -- each shape function contributes one raw degree of
  // freedom per component given the finite element family and order constraints we set below.
  mooseAssert(_count == 1, "Vector-valued variables cannot be array variables");
  mooseAssert(
      _var.feType().family == LAGRANGE_VEC ||
          (_var.feType().family == MONOMIAL_VEC && _var.feType().order == CONSTANT &&
           (!_var.feType().p_refinement || !_subproblem.doingPRefinement())),
      "setNodalValue only makes sense for LAGRANGE_VEC or non-p-refined CONSTANT MONOMIAL_VEC "
      "vector variables");
  mooseAssert(_dof_indices.size() <= _var.sys().mesh().getMesh().mesh_dimension(),
              "The number of dof indices for a vector variable should be at most the mesh manifold "
              "dimension. We cannot use an exact equality because it's possible the vector "
              "variable could live on a lower-dimensional manifold.");
 
  auto & dof_values = _vector_tags_dof_u[_solution_tag];
  dof_values.resize(_dof_indices.size());
  for (const auto i : index_range(dof_values))
    dof_values[i] = value(i);
 
  _has_dof_values = true;
  _nodal_value = value;
}

◆ sizeMatrixTagData()

template<typename OutputType >

void MooseVariableDataBase< OutputType >::sizeMatrixTagData ( )

size matrix tag data

Definition at line 87 of file MooseVariableDataBase.C.

{
  auto num_matrix_tags = _subproblem.numMatrixTags();
 
  _matrix_tags_dof_u.resize(num_matrix_tags);
  _need_matrix_tag_dof_u.resize(num_matrix_tags, false);
 
  _need_matrix_tag_u.resize(num_matrix_tags, false);
  _matrix_tag_u.resize(num_matrix_tags);
}

◆ sln()

template<typename OutputType >

const MooseVariableDataBase< OutputType >::FieldVariableValue & MooseVariableDataBase< OutputType >::sln ( Moose::SolutionState state ) const

Local solution getter.

Parameters

state The state of the simulation: current, old, older, previous nl

Definition at line 316 of file MooseVariableDataBase.C.

{
  auto functor = [this](TagID tag_id) -> const FieldVariableValue &
  { return vectorTagValue(tag_id); };
 
  _var.requireQpComputations();
 
  return const_cast<MooseVariableDataBase<OutputType> *>(this)
      ->stateToTagHelper<FieldVariableValue>(state, functor);
}

Referenced by MooseVariableDataFV< OutputType >::sln().

◆ stateToTagHelper()

template<typename OutputType >

template<typename ReturnType , typename Functor >

const ReturnType & MooseVariableDataBase< OutputType >::stateToTagHelper	(	Moose::SolutionState	state,
		Functor	functor
	)

protected

Helper method that converts a SolutionState argument into a corresponding tag ID, potentially requesting necessary additional solution states and assigning tag id data members, and then calls the provided functor with the tag ID.

Definition at line 271 of file MooseVariableDataBase.C.

{
  if (state > 0)
  {
    // We need to request all states that are between current and the requested state
    stateToTagHelper<ReturnType>(Moose::SolutionState(static_cast<int>(state) - 1), functor);
    needSolutionState(cast_int<unsigned int>(state));
  }
 
  switch (state)
  {
    case Moose::Current:
      return functor(_subproblem.getVectorTagID(Moose::SOLUTION_TAG));
 
    case Moose::Old:
    {
      _old_solution_tag = _subproblem.getVectorTagID(Moose::OLD_SOLUTION_TAG);
      insertSolutionTag(_old_solution_tag);
      return functor(_old_solution_tag);
    }
 
    case Moose::Older:
    {
      _older_solution_tag = _subproblem.getVectorTagID(Moose::OLDER_SOLUTION_TAG);
      insertSolutionTag(_older_solution_tag);
      return functor(_older_solution_tag);
    }
 
    case Moose::PreviousNL:
    {
      _previous_nl_solution_tag = _subproblem.getVectorTagID(Moose::PREVIOUS_NL_SOLUTION_TAG);
      insertSolutionTag(_previous_nl_solution_tag);
      return functor(_previous_nl_solution_tag);
    }
 
    default:
      // We should never get here but gcc requires that we have a default. See
      // htpps://stackoverflow.com/questions/18680378/after-defining-case-for-all-enum-values-compiler-still-says-control-reaches-e
      mooseError("Unknown SolutionState!");
  }
}

◆ var()

template<typename OutputType >

virtual const MooseVariableField< OutputType > & MooseVariableDataBase< OutputType >::var ( ) const

inlineprotectedvirtual

Returns: The variable to which the data in this class belongs to

Reimplemented in MooseVariableDataFV< OutputType >, and MooseVariableDataLinearFV< OutputType >.

Definition at line 153 of file MooseVariableDataBase.h.

153{ return _var; }

Referenced by MooseVariableData< OutputType >::arrayGradPhi(), and MooseVariableData< OutputType >::arrayGradPhiFace().

◆ vectorTagDofValue() [1/2]

template<typename OutputType >

const MooseVariableDataBase< OutputType >::DofValues & MooseVariableDataBase< OutputType >::vectorTagDofValue ( Moose::SolutionState state ) const

Definition at line 342 of file MooseVariableDataBase.C.

{
  auto functor = [this](TagID tag_id) -> const DofValues & { return vectorTagDofValue(tag_id); };
 
  _var.requireQpComputations();
 
  return const_cast<MooseVariableDataBase<OutputType> *>(this)->stateToTagHelper<DofValues>(
      state, functor);
}

◆ vectorTagDofValue() [2/2]

template<typename OutputType >

const MooseVariableDataBase< OutputType >::DofValues & MooseVariableDataBase< OutputType >::vectorTagDofValue ( TagID tag ) const

Definition at line 198 of file MooseVariableDataBase.C.

{
  if (tag >= _need_vector_tag_dof_u.size())
    const_cast<MooseVariableDataBase<OutputType> *>(this)->resizeVectorTagData(tag);
 
  _var.requireQpComputations();
 
  _need_vector_tag_dof_u[tag] = true;
 
  if (_sys.hasVector(tag))
    return _vector_tags_dof_u[tag];
  else
    mooseError("Tag ", tag, " is not associated with any vector for variable ", _var.name());
}

◆ vectorTagGradient()

template<typename OutputType >

const MooseVariableDataBase< OutputType >::FieldVariableGradient & MooseVariableDataBase< OutputType >::vectorTagGradient ( TagID tag ) const

Definition at line 215 of file MooseVariableDataBase.C.

{
  if (tag >= _need_vector_tag_grad.size())
    const_cast<MooseVariableDataBase<OutputType> *>(this)->resizeVectorTagData(tag);
 
  _var.requireQpComputations();
 
  _need_vector_tag_grad[tag] = true;
 
  if (_sys.hasVector(tag))
    return _vector_tag_grad[tag];
  else
    mooseError("Tag ", tag, " is not associated with any vector for variable ", _var.name());
}

◆ vectorTagValue()

template<typename OutputType >

const MooseVariableDataBase< OutputType >::FieldVariableValue & MooseVariableDataBase< OutputType >::vectorTagValue ( TagID tag ) const

Definition at line 181 of file MooseVariableDataBase.C.

{
  if (tag >= _need_vector_tag_u.size())
    const_cast<MooseVariableDataBase<OutputType> *>(this)->resizeVectorTagData(tag);
 
  _var.requireQpComputations();
 
  _need_vector_tag_u[tag] = true;
 
  if (_sys.hasVector(tag))
    return _vector_tag_u[tag];
  else
    mooseError("Tag ", tag, " is not associated with any vector for variable ", _var.name());
}

◆ zeroSizeDofValues()

template<typename OutputType >

void MooseVariableDataBase< OutputType >::zeroSizeDofValues ( )

protected

Definition at line 743 of file MooseVariableDataBase.C.

{
  if (_subproblem.isTransient())
  {
    _dof_values_dot.resize(0);
    _dof_values_dotdot.resize(0);
    _dof_values_dot_old.resize(0);
    _dof_values_dotdot_old.resize(0);
    _dof_du_dot_du.resize(0);
    _dof_du_dotdot_du.resize(0);
  }
 
  for (auto & dof_values : _vector_tags_dof_u)
    dof_values.resize(0);
 
  _has_dof_values = false;
}

Member Data Documentation

◆ _count

template<typename OutputType >

unsigned int MooseVariableDataBase< OutputType >::_count

protected

Number of components of the associated variable.

Definition at line 202 of file MooseVariableDataBase.h.

◆ _dof_du_dot_du

template<typename OutputType >

MooseArray<libMesh::Number> MooseVariableDataBase< OutputType >::_dof_du_dot_du

protected

derivatives of the solution value time derivative with respect to the degrees of freedom

Definition at line 281 of file MooseVariableDataBase.h.

◆ _dof_du_dotdot_du

template<typename OutputType >

MooseArray<libMesh::Number> MooseVariableDataBase< OutputType >::_dof_du_dotdot_du

protected

derivatives of the solution value second time derivative with respect to the degrees of freedom

Definition at line 284 of file MooseVariableDataBase.h.

◆ _dof_indices

template<typename OutputType >

std::vector<dof_id_type> MooseVariableDataBase< OutputType >::_dof_indices

protected

The dof indices for the current element.

Definition at line 224 of file MooseVariableDataBase.h.

Referenced by MooseVariableData< OutputType >::clearDofIndices(), MooseVariableDataFV< OutputType >::clearDofIndices(), MooseVariableDataLinearFV< OutputType >::clearDofIndices(), MooseVariableData< OutputType >::dofIndices(), and MooseVariableData< OutputType >::numberOfDofs().

◆ _dof_map

template<typename OutputType >

const libMesh::DofMap& MooseVariableDataBase< OutputType >::_dof_map

protected

The degree of freedom map from libMesh.

Definition at line 199 of file MooseVariableDataBase.h.

◆ _dof_values_dot

template<typename OutputType >

DofValues MooseVariableDataBase< OutputType >::_dof_values_dot

protected

time derivative of the solution values

Definition at line 273 of file MooseVariableDataBase.h.

◆ _dof_values_dot_old

template<typename OutputType >

DofValues MooseVariableDataBase< OutputType >::_dof_values_dot_old

protected

the previous time step's solution value time derivative

Definition at line 277 of file MooseVariableDataBase.h.

◆ _dof_values_dotdot

template<typename OutputType >

DofValues MooseVariableDataBase< OutputType >::_dof_values_dotdot

protected

second time derivative of the solution values

Definition at line 275 of file MooseVariableDataBase.h.

◆ _dof_values_dotdot_old

template<typename OutputType >

DofValues MooseVariableDataBase< OutputType >::_dof_values_dotdot_old

protected

the previous time step's solution value second time derivative

Definition at line 279 of file MooseVariableDataBase.h.

◆ _has_dof_values

template<typename OutputType >

bool MooseVariableDataBase< OutputType >::_has_dof_values

protected

Whether we currently have degree of freedom values stored in our local containers (corresponding to the current element)

Definition at line 206 of file MooseVariableDataBase.h.

Referenced by MooseVariableDataBase< OutputType >::prepareAux().

◆ _matrix_tag_u

template<typename OutputType >

std::vector<FieldVariableValue> MooseVariableDataBase< OutputType >::_matrix_tag_u

protected

Definition at line 238 of file MooseVariableDataBase.h.

◆ _matrix_tags_dof_u

template<typename OutputType >

std::vector<DofValues> MooseVariableDataBase< OutputType >::_matrix_tags_dof_u

protected

Definition at line 232 of file MooseVariableDataBase.h.

◆ _max_state

template<typename OutputType >

unsigned int MooseVariableDataBase< OutputType >::_max_state

protected

The maximum number of older solution states our variable needs.

Definition at line 209 of file MooseVariableDataBase.h.

◆ _need_dof_du_dot_du

template<typename OutputType >

bool MooseVariableDataBase< OutputType >::_need_dof_du_dot_du

mutableprotected

Definition at line 269 of file MooseVariableDataBase.h.

◆ _need_dof_du_dotdot_du

template<typename OutputType >

bool MooseVariableDataBase< OutputType >::_need_dof_du_dotdot_du

mutableprotected

Definition at line 270 of file MooseVariableDataBase.h.

◆ _need_dof_values_dot

template<typename OutputType >

bool MooseVariableDataBase< OutputType >::_need_dof_values_dot

mutableprotected

local solution flags

Definition at line 265 of file MooseVariableDataBase.h.

◆ _need_dof_values_dot_old

template<typename OutputType >

bool MooseVariableDataBase< OutputType >::_need_dof_values_dot_old

mutableprotected

Definition at line 267 of file MooseVariableDataBase.h.

◆ _need_dof_values_dotdot

template<typename OutputType >

bool MooseVariableDataBase< OutputType >::_need_dof_values_dotdot

mutableprotected

Definition at line 266 of file MooseVariableDataBase.h.

◆ _need_dof_values_dotdot_old

template<typename OutputType >

bool MooseVariableDataBase< OutputType >::_need_dof_values_dotdot_old

mutableprotected

Definition at line 268 of file MooseVariableDataBase.h.

◆ _need_du_dot_du

template<typename OutputType >

bool MooseVariableDataBase< OutputType >::_need_du_dot_du

mutableprotected

Definition at line 257 of file MooseVariableDataBase.h.

Referenced by MooseVariableData< OutputType >::duDotDu(), and MooseVariableDataFV< OutputType >::duDotDu().

◆ _need_du_dotdot_du

template<typename OutputType >

bool MooseVariableDataBase< OutputType >::_need_du_dotdot_du

mutableprotected

Definition at line 258 of file MooseVariableDataBase.h.

Referenced by MooseVariableData< OutputType >::duDotDotDu(), and MooseVariableDataFV< OutputType >::duDotDotDu().

◆ _need_grad_dot

template<typename OutputType >

bool MooseVariableDataBase< OutputType >::_need_grad_dot

mutableprotected

gradient dot flags

Definition at line 261 of file MooseVariableDataBase.h.

Referenced by MooseVariableData< OutputType >::adGradSlnDot().

◆ _need_grad_dotdot

template<typename OutputType >

bool MooseVariableDataBase< OutputType >::_need_grad_dotdot

mutableprotected

Definition at line 262 of file MooseVariableDataBase.h.

◆ _need_matrix_tag_dof_u

template<typename OutputType >

std::vector<bool> MooseVariableDataBase< OutputType >::_need_matrix_tag_dof_u

mutableprotected

Definition at line 227 of file MooseVariableDataBase.h.

◆ _need_matrix_tag_u

template<typename OutputType >

std::vector<bool> MooseVariableDataBase< OutputType >::_need_matrix_tag_u

mutableprotected

Definition at line 239 of file MooseVariableDataBase.h.

◆ _need_u_dot

template<typename OutputType >

bool MooseVariableDataBase< OutputType >::_need_u_dot

mutableprotected

u dot flags

Definition at line 253 of file MooseVariableDataBase.h.

◆ _need_u_dot_old

template<typename OutputType >

bool MooseVariableDataBase< OutputType >::_need_u_dot_old

mutableprotected

Definition at line 255 of file MooseVariableDataBase.h.

◆ _need_u_dotdot

template<typename OutputType >

bool MooseVariableDataBase< OutputType >::_need_u_dotdot

mutableprotected

Definition at line 254 of file MooseVariableDataBase.h.

◆ _need_u_dotdot_old

template<typename OutputType >

bool MooseVariableDataBase< OutputType >::_need_u_dotdot_old

mutableprotected

Definition at line 256 of file MooseVariableDataBase.h.

◆ _need_vector_tag_dof_u

template<typename OutputType >

std::vector<bool> MooseVariableDataBase< OutputType >::_need_vector_tag_dof_u

mutableprotected

Definition at line 226 of file MooseVariableDataBase.h.

Referenced by MooseVariableDataBase< OutputType >::MooseVariableDataBase().

◆ _need_vector_tag_grad

template<typename OutputType >

std::vector<bool> MooseVariableDataBase< OutputType >::_need_vector_tag_grad

mutableprotected

Definition at line 237 of file MooseVariableDataBase.h.

Referenced by MooseVariableDataBase< OutputType >::MooseVariableDataBase().

◆ _need_vector_tag_u

template<typename OutputType >

std::vector<bool> MooseVariableDataBase< OutputType >::_need_vector_tag_u

mutableprotected

Definition at line 235 of file MooseVariableDataBase.h.

Referenced by MooseVariableDataBase< OutputType >::MooseVariableDataBase().

◆ _nodal_value

template<typename OutputType >

OutputType MooseVariableDataBase< OutputType >::_nodal_value

protected

Nodal values.

Definition at line 242 of file MooseVariableDataBase.h.

◆ _nodal_value_array

template<typename OutputType >

MooseArray<OutputType> MooseVariableDataBase< OutputType >::_nodal_value_array

protected

Nodal values as MooseArrays for use with AuxKernels.

Definition at line 248 of file MooseVariableDataBase.h.

Referenced by MooseVariableDataBase< OutputType >::MooseVariableDataBase().

◆ _nodal_value_dot

template<typename OutputType >

OutputType MooseVariableDataBase< OutputType >::_nodal_value_dot

protected

nodal values of u_dot

Definition at line 287 of file MooseVariableDataBase.h.

◆ _nodal_value_dot_old

template<typename OutputType >

OutputType MooseVariableDataBase< OutputType >::_nodal_value_dot_old

protected

nodal values of u_dot_old

Definition at line 291 of file MooseVariableDataBase.h.

◆ _nodal_value_dotdot

template<typename OutputType >

OutputType MooseVariableDataBase< OutputType >::_nodal_value_dotdot

protected

nodal values of u_dotdot

Definition at line 289 of file MooseVariableDataBase.h.

◆ _nodal_value_dotdot_old

template<typename OutputType >

OutputType MooseVariableDataBase< OutputType >::_nodal_value_dotdot_old

protected

nodal values of u_dotdot_old

Definition at line 293 of file MooseVariableDataBase.h.

◆ _nodal_value_old

template<typename OutputType >

OutputType MooseVariableDataBase< OutputType >::_nodal_value_old

protected

Definition at line 243 of file MooseVariableDataBase.h.

◆ _nodal_value_old_array

template<typename OutputType >

MooseArray<OutputType> MooseVariableDataBase< OutputType >::_nodal_value_old_array

protected

Definition at line 249 of file MooseVariableDataBase.h.

Referenced by MooseVariableDataBase< OutputType >::MooseVariableDataBase().

◆ _nodal_value_older

template<typename OutputType >

OutputType MooseVariableDataBase< OutputType >::_nodal_value_older

protected

Definition at line 244 of file MooseVariableDataBase.h.

◆ _nodal_value_older_array

template<typename OutputType >

MooseArray<OutputType> MooseVariableDataBase< OutputType >::_nodal_value_older_array

protected

Definition at line 250 of file MooseVariableDataBase.h.

Referenced by MooseVariableDataBase< OutputType >::MooseVariableDataBase().

◆ _nodal_value_previous_nl

template<typename OutputType >

OutputType MooseVariableDataBase< OutputType >::_nodal_value_previous_nl

protected

Definition at line 245 of file MooseVariableDataBase.h.

◆ _old_solution_tag

template<typename OutputType >

TagID MooseVariableDataBase< OutputType >::_old_solution_tag

protected

The vector tag ID corresponding to the old solution vector.

Definition at line 215 of file MooseVariableDataBase.h.

◆ _older_solution_tag

template<typename OutputType >

TagID MooseVariableDataBase< OutputType >::_older_solution_tag

protected

The vector tag ID corresponding to the older solution vector.

Definition at line 218 of file MooseVariableDataBase.h.

◆ _previous_nl_solution_tag

template<typename OutputType >

TagID MooseVariableDataBase< OutputType >::_previous_nl_solution_tag

protected

The vector tag ID corresponding to the previous nonlinear iteration's solution vector.

Definition at line 221 of file MooseVariableDataBase.h.

◆ _required_vector_tags

template<typename OutputType >

std::set<TagID> MooseVariableDataBase< OutputType >::_required_vector_tags

protected

The set of vector tags (residual + solution) we need to evaluate.

Definition at line 296 of file MooseVariableDataBase.h.

◆ _solution_tag

template<typename OutputType >

TagID MooseVariableDataBase< OutputType >::_solution_tag

protected

The vector tag ID corresponding to the solution vector.

Definition at line 212 of file MooseVariableDataBase.h.

◆ _solution_tags

template<typename OutputType >

std::set<TagID> MooseVariableDataBase< OutputType >::_solution_tags

protected

The set of solution tags we need to evaluate.

Definition at line 299 of file MooseVariableDataBase.h.

◆ _subproblem

template<typename OutputType >

const SubProblem& MooseVariableDataBase< OutputType >::_subproblem

protected

The subproblem which we can query for information related to tagged vectors and matrices.

Definition at line 193 of file MooseVariableDataBase.h.

Referenced by MooseVariableDataBase< OutputType >::MooseVariableDataBase(), and MooseVariableDataFV< OutputType >::MooseVariableDataFV().

◆ _sys

template<typename OutputType >

SystemBase& MooseVariableDataBase< OutputType >::_sys

protected

The MOOSE system which ultimately holds the vectors and matrices relevant to this variable data.

Definition at line 190 of file MooseVariableDataBase.h.

Referenced by MooseVariableData< OutputType >::MooseVariableData().

◆ _tid

template<typename OutputType >

const THREAD_ID MooseVariableDataBase< OutputType >::_tid

protected

The thread ID that this object is on.

Definition at line 196 of file MooseVariableDataBase.h.

◆ _var

template<typename OutputType >

const MooseVariableField<OutputType>& MooseVariableDataBase< OutputType >::_var

private

A const reference to the owning MooseVariableField object.

Definition at line 303 of file MooseVariableDataBase.h.

Referenced by MooseVariableDataBase< OutputType >::var().

◆ _vector_tag_grad

template<typename OutputType >

std::vector<FieldVariableGradient> MooseVariableDataBase< OutputType >::_vector_tag_grad

protected

Definition at line 236 of file MooseVariableDataBase.h.

Referenced by MooseVariableDataBase< OutputType >::MooseVariableDataBase().

◆ _vector_tag_u

template<typename OutputType >

std::vector<FieldVariableValue> MooseVariableDataBase< OutputType >::_vector_tag_u

protected

Definition at line 234 of file MooseVariableDataBase.h.

Referenced by MooseVariableDataBase< OutputType >::MooseVariableDataBase().

◆ _vector_tags_dof_u

template<typename OutputType >

std::vector<DofValues> MooseVariableDataBase< OutputType >::_vector_tags_dof_u

protected

Definition at line 230 of file MooseVariableDataBase.h.

Referenced by MooseVariableDataBase< OutputType >::MooseVariableDataBase().

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

include/variables/MooseVariableDataBase.h
src/variables/MooseVariableDataBase.C

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ADDofValue

◆ ADDofValues

◆ DofValue

◆ DofValues

◆ FieldVariableGradient

◆ FieldVariableValue

◆ OutputDivergence

◆ OutputGradient

◆ OutputSecond

Constructor & Destructor Documentation

◆ MooseVariableDataBase()

◆ ~MooseVariableDataBase()

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ assignNodalValue() [1/3]

◆ assignNodalValue() [2/3]

◆ assignNodalValue() [3/3]

◆ dofValues()

◆ dofValuesOld()

◆ dofValuesOlder()

◆ dofValuesPreviousNL()

◆ fetchDofValues() [1/3]

◆ fetchDofValues() [2/3]

◆ fetchDofValues() [3/3]

◆ getArrayDofValues()

◆ getContinuity()

◆ gradSln()

◆ hasDoFsOnNodes()

◆ insert() [1/2]

◆ insert() [2/2]

◆ insertSolutionTag()

◆ isNodal()

◆ matrixTagValue()

◆ needSolutionState()

◆ nodalMatrixTagValue()

◆ nodalValue()

◆ nodalValueArray()

◆ nodalVectorTagValue()

◆ oldestSolutionStateRequested()

◆ prepareAux()

◆ prepareIC()

◆ resizeVectorTagData()

◆ setActiveTags()

◆ setNodalValue() [1/2]

◆ setNodalValue() [2/2]

◆ sizeMatrixTagData()

◆ sln()

◆ stateToTagHelper()

◆ var()

◆ vectorTagDofValue() [1/2]

◆ vectorTagDofValue() [2/2]

◆ vectorTagGradient()

◆ vectorTagValue()

◆ zeroSizeDofValues()

Member Data Documentation

◆ _count

◆ _dof_du_dot_du

◆ _dof_du_dotdot_du

◆ _dof_indices

◆ _dof_map

◆ _dof_values_dot

◆ _dof_values_dot_old

◆ _dof_values_dotdot

◆ _dof_values_dotdot_old

◆ _has_dof_values

◆ _matrix_tag_u

◆ _matrix_tags_dof_u

◆ _max_state

◆ _need_dof_du_dot_du

◆ _need_dof_du_dotdot_du

◆ _need_dof_values_dot

◆ _need_dof_values_dot_old