InitialConditionBase.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 "InitialConditionBase.h"
#include "SystemBase.h"
#include "MooseVariableFE.h"
#include "UserObject.h"

InputParameters
InitialConditionBase::validParams()
{
  InputParameters params = MooseObject::validParams();
  params += InitialConditionInterface::validParams();
  params += BlockRestrictable::validParams();
  params += BoundaryRestrictable::validParams();
  params += MaterialPropertyInterface::validParams();

  params.addRequiredParam<VariableName>("variable",
                                        "The variable this initial condition is "
                                        "supposed to provide values for.");
  params.addParam<bool>("ignore_uo_dependency",
                        false,
                        "When set to true, a UserObject retrieved "
                        "by this IC will not be executed before the "
                        "this IC");

  params.addParamNamesToGroup("ignore_uo_dependency", "Advanced");

  params.registerBase("InitialCondition");

  return params;
}

InitialConditionBase::InitialConditionBase(const InputParameters & parameters)
  : MooseObject(parameters),
    InitialConditionInterface(parameters),
    BlockRestrictable(this),
    Coupleable(this,
               getParam<SystemBase *>("_sys")
                   ->getVariable(parameters.get<THREAD_ID>("_tid"),
                                 parameters.get<VariableName>("variable"))
                   .isNodal()),
    MaterialPropertyInterface(this, blockIDs(), Moose::EMPTY_BOUNDARY_IDS),
    FunctionInterface(this),
    UserObjectInterface(this),
    PostprocessorInterface(this),
    BoundaryRestrictable(this, _c_nodal),
    DependencyResolverInterface(),
    Restartable(this, "InitialConditionBases"),
    ElementIDInterface(this),
    _sys(*getCheckedPointerParam<SystemBase *>("_sys")),
    _ignore_uo_dependency(getParam<bool>("ignore_uo_dependency"))
{
  _supplied_vars.insert(getParam<VariableName>("variable"));

  const auto & coupled_vars = getCoupledVars();
  for (const auto & it : coupled_vars)
    for (const auto & var : it.second)
      _depend_vars.insert(var->name());
}

InitialConditionBase::~InitialConditionBase() {}

const std::set<std::string> &
InitialConditionBase::getRequestedItems()
{
  return _depend_vars;
}

const std::set<std::string> &
InitialConditionBase::getSuppliedItems()
{
  return _supplied_vars;
}

void
InitialConditionBase::addUserObjectDependencyHelper(const UserObject & uo) const
{
  if (!_ignore_uo_dependency)
    _depend_uo.insert(uo.name());
}

void
InitialConditionBase::addPostprocessorDependencyHelper(const PostprocessorName & name) const
{
  if (!_ignore_uo_dependency)
    _depend_uo.insert(name);
}