MooseVariableBase.C

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
 
#include "MooseVariableBase.h"
 
#include "AddVariableAction.h"
#include "SubProblem.h"
#include "SystemBase.h"
#include "MooseMesh.h"
#include "MooseApp.h"
#include "InputParameterWarehouse.h"
#include "BlockRestrictable.h"
#include "MooseUtils.h"
 
#include "libmesh/variable.h"
#include "libmesh/dof_map.h"
#include "libmesh/system.h"
#include "libmesh/fe_type.h"
#include "libmesh/string_to_enum.h"
 
// Users should never actually create this object
registerMooseObject("MooseApp", MooseVariableBase);
 
InputParameters
MooseVariableBase::validParams()
{
  InputParameters params = MooseObject::validParams();
  params += BlockRestrictable::validParams();
  params += OutputInterface::validParams();
 
  params.transferParam<MooseEnum>(AddVariableAction::validParams(), "order");
  params.transferParam<MooseEnum>(AddVariableAction::validParams(), "family");
 
  // ArrayVariable capability
  params.addRangeCheckedParam<unsigned int>(
      "components", 1, "components>0", "Number of components for an array variable");
 
  // Advanced input options
  params.transferParam<std::vector<Real>>(AddVariableAction::validParams(), "scaling");
  params.addParam<bool>("eigen", false, "True to make this variable an eigen variable");
  params.addParam<bool>("fv", false, "True to make this variable a finite volume variable");
  params.addParam<bool>("array",
                        false,
                        "True to make this variable a array variable regardless of number of "
                        "components. If 'components' > 1, this will automatically be set to true.");
 
  params.addParam<std::vector<std::string>>(
      "array_var_component_names",
      "Only for use with array variables, allows setting custom names for each array variable "
      "component. If this not set, the default name for each array variable componenet is "
      "`base_name`+'_'+component number. If used, a name must be provided for each component and "
      "the values are used to name the components as `base_name`+'_'+ "
      "`array_var_component_names[component]`.");
 
  params.addParam<SolverSystemName>("solver_sys",
                                    "nl0",
                                    "If this variable is a solver variable, this is the "
                                    "solver system to which it should be added.");
  params.transferParam<bool>(AddVariableAction::validParams(), "p_refinement");
  params.transferParam<bool>(AddVariableAction::validParams(), "disable_p_refinement");
 
  params.addParam<bool>("use_dual", false, "True to use dual basis for Lagrange multipliers");
  params.transferParam<std::vector<Real>>(AddVariableAction::validParams(), "initial_condition");
  params.transferParam<std::string>(AddVariableAction::validParams(), "initial_from_file_var");
  params.addParamNamesToGroup("scaling eigen use_dual", "Advanced");
 
  params.registerBase("MooseVariableBase");
  params.addPrivateParam<SystemBase *>("_system_base");
  params.addPrivateParam<FEProblemBase *>("_fe_problem_base");
  params.addPrivateParam<Moose::VarKindType>("_var_kind");
  params.addPrivateParam<unsigned int>("_var_num");
  params.addPrivateParam<THREAD_ID>("tid");
 
  params.addClassDescription(
      "Base class for Moose variables. This should never be the terminal object type");
  return params;
}
 
MooseVariableBase::MooseVariableBase(const InputParameters & parameters)
  : MooseObject(parameters),
    BlockRestrictable(this),
    OutputInterface(parameters),
    SetupInterface(this),
    _sys(*getParam<SystemBase *>("_system_base")), // TODO: get from _fe_problem_base
    _fe_type(MooseUtils::variableFEType(parameters)),
    _var_num(getParam<unsigned int>("_var_num")),
    _is_eigen(getParam<bool>("eigen")),
    _var_kind(getParam<Moose::VarKindType>("_var_kind")),
    _subproblem(_sys.subproblem()),
    _variable(_sys.system().variable(_var_num)),
    _assembly(_subproblem.assembly(getParam<THREAD_ID>("_tid"),
                                   (_var_kind == Moose::VAR_SOLVER) ? _sys.number() : 0)),
    _dof_map(_sys.dofMap()),
    _mesh(_subproblem.mesh()),
    _tid(getParam<THREAD_ID>("tid")),
    _count(getParam<unsigned int>("components")),
    _scaling_factor(_count, 1.0),
    _use_dual(getParam<bool>("use_dual"))
{
  scalingFactor(isParamValid("scaling") ? getParam<std::vector<Real>>("scaling")
                                        : std::vector<Real>(_count, 1.));
  if (getParam<bool>("fv") && getParam<bool>("eigen"))
    paramError("eigen", "finite volume (fv=true) variables do not have eigen support");
  if (getParam<bool>("fv") && _fe_type.family != MONOMIAL)
    paramError("family", "finite volume (fv=true) variables must be have MONOMIAL family");
  if (getParam<bool>("fv") && _fe_type.order != 0)
    paramError("order", "finite volume (fv=true) variables currently support CONST order only");
  if (getParam<bool>("fv") && _fe_type.p_refinement)
    paramError("p_refinement", "finite volume (fv=true) variables do not support p-refinement");
 
  if (isParamValid("array_var_component_names"))
  {
    auto name0 = _sys.system().variable(_var_num).name();
    std::size_t found = name0.find_last_of("_");
    if (found == std::string::npos)
      mooseError("Error creating ArrayMooseVariable name with base name ", name0);
    const auto name_base = name0.substr(0, found);
    const auto & name_endings = getParam<std::vector<std::string>>("array_var_component_names");
    for (const auto & name : name_endings)
      _array_var_component_names.push_back(name_base + '_' + name);
  }
  else if (_count != 1)
    mooseError("Component size of normal variable (_count) must be one; equals " +
               std::to_string(_count) + "");
 
  // check parameters set automatically by SystemBase related to array variables
  mooseAssert(
      isArray() ? _count == _array_var_component_names.size() : true,
      "An inconsistent numer of names or no names were provided for array variable components");
  if (_count > 1)
    mooseAssert(isArray(), "Must be true with component > 1");
}
 
const std::string &
MooseVariableBase::arrayVariableComponent(const unsigned int i) const
{
  mooseAssert(
      i < _array_var_component_names.size(),
      "Requested array variable component number is greater than the number of component names.");
  return _array_var_component_names[i];
}
 
const std::vector<dof_id_type> &
MooseVariableBase::allDofIndices() const
{
  const auto it = _sys.subproblem()._var_dof_map.find(name());
  if (it != _sys.subproblem()._var_dof_map.end())
    return it->second;
  else
    mooseError("VariableAllDoFMap not prepared for ",
               name(),
               " . Check nonlocal coupling requirement for the variable.");
}
 
Order
MooseVariableBase::order() const
{
  return _fe_type.order;
}
 
std::vector<dof_id_type>
MooseVariableBase::componentDofIndices(const std::vector<dof_id_type> & dof_indices,
                                       unsigned int component) const
{
  mooseAssert(dof_indices.size() % this->count() == 0,
              "The dof indices container must be a multiple of count");
  std::vector<dof_id_type> new_dof_indices(dof_indices.size() / this->count());
  for (const auto i : index_range(new_dof_indices))
    new_dof_indices[i] = dof_indices[component * new_dof_indices.size() + i];
  return new_dof_indices;
}
 
void
MooseVariableBase::scalingFactor(const std::vector<Real> & factor)
{
  mooseAssert(factor.size() == _count, "Inconsistent scaling factor size");
  for (const auto i : make_range(_count))
    _scaling_factor[i] = factor[i];
}
 
void
MooseVariableBase::initialSetup()
{
  // Currently the scaling vector is only used through AD residual computing objects
  if ((_var_kind == Moose::VAR_SOLVER) && _subproblem.haveADObjects() &&
      (_subproblem.automaticScaling() ||
       (std::find_if(_scaling_factor.begin(),
                     _scaling_factor.end(),
                     [](const Real element)
                     { return !MooseUtils::absoluteFuzzyEqual(element, 1.); }) !=
        _scaling_factor.end())))
 
    _sys.addScalingVector();
}
 
const NumericVector<Number> &
MooseVariableBase::getSolution(const Moose::StateArg & state) const
{
  // It's not safe to use solutionState(0) because it returns the libMesh System solution member
  // which is wrong during things like finite difference Jacobian evaluation, e.g. when PETSc
  // perturbs the solution vector we feed these perturbations into the current_local_solution
  // while the libMesh solution is frozen in the non-perturbed state
  return (state.state == 0) ? *this->_sys.currentSolution()
                            : this->_sys.solutionState(state.state, state.iteration_type);
}
 
bool
MooseVariableBase::supportsQpBasedLoops() const
{
  mooseAssert(false,
              "Base class should not assume anything regarding this. In an ideal world this would "
              "be pure virtual but we can't do that because we register MooseVariableBase as an "
              "available variable type for the user");
  return {};
}
 
bool
MooseVariableBase::supportsGeometricInfoBasedLoops() const
{
  mooseAssert(false,
              "Base class should not assume anything regarding this. In an ideal world this would "
              "be pure virtual but we can't do that because we register MooseVariableBase as an "
              "available variable type for the user");
  return {};
}
 
const std::set<SubdomainID> &
MooseVariableBase::activeSubdomains() const
{
  return this->_sys.system().variable(_var_num).active_subdomains();
}
 
bool
MooseVariableBase::activeOnSubdomain(SubdomainID subdomain) const
{
  return this->_sys.system().variable(_var_num).active_on_subdomain(subdomain);
}
 
bool
MooseVariableBase::activeOnSubdomains(const std::set<SubdomainID> & subdomains) const
{
  const auto & active_subs = activeSubdomains();
  return std::includes(
      active_subs.begin(), active_subs.end(), subdomains.begin(), subdomains.end());
}