ComputeElemAuxVarsThread.C

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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

#include "ComputeElemAuxVarsThread.h"

// MOOSE includes
#include "AuxiliarySystem.h"
#include "AuxKernel.h"
#include "SwapBackSentinel.h"
#include "FEProblem.h"
#include "MaterialBase.h"
#include "ThreadedElementLoop.h"

#include "libmesh/threads.h"

template <typename AuxKernelType>
ComputeElemAuxVarsThread<AuxKernelType>::ComputeElemAuxVarsThread(
    FEProblemBase & problem,
    const MooseObjectWarehouse<AuxKernelType> & storage,
    bool need_materials)
  : ThreadedElementLoop<ConstElemRange>(problem),
    _aux_sys(problem.getAuxiliarySystem()),
    _aux_kernels(storage),
    _need_materials(need_materials)
{
}

// Splitting Constructor
template <typename AuxKernelType>
ComputeElemAuxVarsThread<AuxKernelType>::ComputeElemAuxVarsThread(ComputeElemAuxVarsThread & x,
                                                                  Threads::split /*split*/)
  : ThreadedElementLoop<ConstElemRange>(x._fe_problem),
    _aux_sys(x._aux_sys),
    _aux_kernels(x._aux_kernels),
    _need_materials(x._need_materials)
{
}

template <typename AuxKernelType>
ComputeElemAuxVarsThread<AuxKernelType>::~ComputeElemAuxVarsThread()
{
}

template <typename AuxKernelType>
void
ComputeElemAuxVarsThread<AuxKernelType>::subdomainChanged()
{
  _fe_problem.subdomainSetup(_subdomain, _tid);

  std::set<MooseVariableFEBase *> needed_moose_vars;
  std::unordered_set<unsigned int> needed_mat_props;
  std::set<TagID> needed_fe_var_matrix_tags;
  std::set<TagID> needed_fe_var_vector_tags;

  _fe_problem.getMaterialWarehouse().updateBlockFEVariableCoupledVectorTagDependency(
      _subdomain, needed_fe_var_vector_tags, _tid);
  if (_aux_kernels.hasActiveBlockObjects(_subdomain, _tid))
  {
    const std::vector<std::shared_ptr<AuxKernelType>> & kernels =
        _aux_kernels.getActiveBlockObjects(_subdomain, _tid);
    for (const auto & aux : kernels)
    {
      aux->subdomainSetup();
      const auto & mv_deps = aux->getMooseVariableDependencies();
      const auto & mp_deps = aux->getMatPropDependencies();
      needed_moose_vars.insert(mv_deps.begin(), mv_deps.end());
      needed_mat_props.insert(mp_deps.begin(), mp_deps.end());

      auto & fe_var_coup_vtags = aux->getFEVariableCoupleableVectorTags();
      needed_fe_var_vector_tags.insert(fe_var_coup_vtags.begin(), fe_var_coup_vtags.end());

      auto & fe_var_coup_mtags = aux->getFEVariableCoupleableMatrixTags();
      needed_fe_var_matrix_tags.insert(fe_var_coup_mtags.begin(), fe_var_coup_mtags.end());
    }
  }

  _fe_problem.setActiveElementalMooseVariables(needed_moose_vars, _tid);
  _fe_problem.prepareMaterials(needed_mat_props, _subdomain, _tid);
  _fe_problem.setActiveFEVariableCoupleableMatrixTags(needed_fe_var_matrix_tags, _tid);
  _fe_problem.setActiveFEVariableCoupleableVectorTags(needed_fe_var_vector_tags, _tid);
}

template <typename AuxKernelType>
void
ComputeElemAuxVarsThread<AuxKernelType>::onElement(const Elem * elem)
{
  if (_aux_kernels.hasActiveBlockObjects(_subdomain, _tid))
  {
    const std::vector<std::shared_ptr<AuxKernelType>> & kernels =
        _aux_kernels.getActiveBlockObjects(_subdomain, _tid);
    _fe_problem.prepare(elem, _tid);
    _fe_problem.reinitElem(elem, _tid);

    // Set up the sentinel so that, even if reinitMaterials() throws, we
    // still remember to swap back.
    SwapBackSentinel sentinel(_fe_problem, &FEProblem::swapBackMaterials, _tid, _need_materials);

    if (_need_materials)
      _fe_problem.reinitMaterials(elem->subdomain_id(), _tid);

    for (const auto & aux : kernels)
    {
      aux->compute();
      aux->variable().insert(_aux_sys.solution());

      // update the aux solution vector if writable coupled variables are used
      if (aux->hasWritableCoupledVariables())
      {
        for (auto * var : aux->getWritableCoupledVariables())
          var->insert(_aux_sys.solution());

        _fe_problem.reinitElem(elem, _tid);
      }
    }
  }
}

template <typename AuxKernelType>
void
ComputeElemAuxVarsThread<AuxKernelType>::post()
{
  _fe_problem.clearActiveElementalMooseVariables(_tid);
  _fe_problem.clearActiveMaterialProperties(_tid);

  _fe_problem.clearActiveFEVariableCoupleableVectorTags(_tid);
  _fe_problem.clearActiveFEVariableCoupleableMatrixTags(_tid);
}

template <typename AuxKernelType>
void
ComputeElemAuxVarsThread<AuxKernelType>::join(const ComputeElemAuxVarsThread & /*y*/)
{
}

template <typename AuxKernelType>
void
ComputeElemAuxVarsThread<AuxKernelType>::printGeneralExecutionInformation() const
{
  if (!_fe_problem.shouldPrintExecution(_tid) || !_aux_kernels.hasActiveObjects())
    return;

  const auto & console = _fe_problem.console();
  const auto & execute_on = _fe_problem.getCurrentExecuteOnFlag();
  console << "[DBG] Executing auxiliary kernels on elements on " << execute_on << std::endl;
}

template <typename AuxKernelType>
void
ComputeElemAuxVarsThread<AuxKernelType>::printBlockExecutionInformation() const
{
  if (!_fe_problem.shouldPrintExecution(_tid) || _blocks_exec_printed.count(_subdomain) ||
      !_aux_kernels.hasActiveBlockObjects(_subdomain, _tid))
    return;

  const auto & console = _fe_problem.console();
  const auto & kernels = _aux_kernels.getActiveBlockObjects(_subdomain, _tid);
  console << "[DBG] Ordering of AuxKernels on block " << _subdomain << std::endl;
  printExecutionOrdering<AuxKernelType>(kernels, false);
  _blocks_exec_printed.insert(_subdomain);
}

template class ComputeElemAuxVarsThread<AuxKernel>;
template class ComputeElemAuxVarsThread<VectorAuxKernel>;
template class ComputeElemAuxVarsThread<ArrayAuxKernel>;