MooseVariableDependencyInterface.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "MooseTypes.h"

#include "libmesh/id_types.h"

#include <set>
#include <vector>
#include <algorithm>

class MooseObject;
class MooseVariableFieldBase;
namespace libMesh
{
class DofObject;
}

class MooseVariableDependencyInterface
{
public:
  // Must be a pointer in order to disambiguate with default copy constructor
  MooseVariableDependencyInterface(const MooseObject *);

#ifdef MOOSE_KOKKOS_ENABLED

  MooseVariableDependencyInterface(const MooseVariableDependencyInterface &,
                                   const Moose::Kokkos::FunctorCopy & key);
#endif

  const std::set<MooseVariableFieldBase *> & getMooseVariableDependencies() const
  {
    return _moose_variable_dependencies;
  }

  template <typename DofObjectType>
  std::set<MooseVariableFieldBase *>
  checkAllVariables(const DofObjectType & dof_object,
                    const std::set<MooseVariableFieldBase *> & vars_to_omit = {});

  virtual std::set<MooseVariableFieldBase *>
  checkVariables(const libMesh::Node & node,
                 const std::set<MooseVariableFieldBase *> & vars_to_check);

  std::set<MooseVariableFieldBase *>
  checkVariables(const libMesh::Elem & element,
                 const std::set<MooseVariableFieldBase *> & vars_to_check);

  void addMooseVariableDependency(MooseVariableFieldBase * var)
  {
    _moose_variable_dependencies.insert(var);
  }
  void addMooseVariableDependency(const std::vector<MooseVariableFieldBase *> & vars)
  {
    _moose_variable_dependencies.insert(vars.begin(), vars.end());
  }

private:
  template <typename DofObjectType>
  std::set<MooseVariableFieldBase *>
  checkVariablesHelper(const DofObjectType & dof_object,
                       const std::set<MooseVariableFieldBase *> & vars_to_check);

  std::set<MooseVariableFieldBase *> _moose_variable_dependencies;

  std::vector<libMesh::dof_id_type> _dof_indices;
};

template <typename DofObjectType>
std::set<MooseVariableFieldBase *>
MooseVariableDependencyInterface::checkAllVariables(
    const DofObjectType & dof_object, const std::set<MooseVariableFieldBase *> & vars_to_omit)
{
  if (vars_to_omit.empty())
    return checkVariables(dof_object, _moose_variable_dependencies);

  std::set<MooseVariableFieldBase *> vars_to_check;
  std::set_difference(_moose_variable_dependencies.begin(),
                      _moose_variable_dependencies.end(),
                      vars_to_omit.begin(),
                      vars_to_omit.end(),
                      std::inserter(vars_to_check, vars_to_check.begin()));
  return checkVariables(dof_object, vars_to_check);
}

inline std::set<MooseVariableFieldBase *>
MooseVariableDependencyInterface::checkVariables(
    const libMesh::Node & node, const std::set<MooseVariableFieldBase *> & vars_to_check)
{
  return checkVariablesHelper(node, vars_to_check);
}

inline std::set<MooseVariableFieldBase *>
MooseVariableDependencyInterface::checkVariables(
    const libMesh::Elem & element, const std::set<MooseVariableFieldBase *> & vars_to_check)
{
  return checkVariablesHelper(element, vars_to_check);
}