StochasticToolsAction.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 "StochasticToolsAction.h"
#include "ActionWarehouse.h"
#include "ActionFactory.h"
#include "MooseEnum.h"
#include "SetupMeshAction.h"
#include "CreateProblemAction.h"

registerMooseAction("StochasticToolsApp", StochasticToolsAction, "auto_create_mesh");
registerMooseAction("StochasticToolsApp", StochasticToolsAction, "auto_create_problem");
registerMooseAction("StochasticToolsApp", StochasticToolsAction, "auto_create_executioner");

InputParameters
StochasticToolsAction::validParams()
{
  InputParameters params = Action::validParams();
  params.addClassDescription(
      "Action for performing some common functions for running stochastic simulations.");
  params.addParam<bool>(
      "auto_create_mesh",
      true,
      "Automatically setup the Mesh block for a master application without a simulation.");
  params.addParam<bool>(
      "auto_create_problem",
      true,
      "Automatically setup the Problem block for a master application without a simulation.");
  params.addParam<bool>(
      "auto_create_executioner",
      true,
      "Automatically setup the Executioner block for a master application without a simulation.");
  return params;
}

StochasticToolsAction::StochasticToolsAction(const InputParameters & params) : Action(params) {}

void
StochasticToolsAction::act()
{
  // [Mesh]
  if (_current_task == "auto_create_mesh" && getParam<bool>("auto_create_mesh") &&
      !_awh.hasActions("setup_mesh"))
  {
    // Build the Action parameters
    InputParameters action_params = _action_factory.getValidParams("SetupMeshAction");
    action_params.set<std::string>("type") = "GeneratedMesh";

    // Associate errors with "auto_create_mesh"
    associateWithParameter("auto_create_mesh", action_params);

    // Create The Action
    auto action = std::static_pointer_cast<MooseObjectAction>(
        _action_factory.create("SetupMeshAction", "Mesh", action_params));

    // Set the object parameters
    InputParameters & params = action->getObjectParams();
    params.set<MooseEnum>("dim") = "1";
    params.set<unsigned int>("nx") = 1;

    // Add Action to the warehouse
    _awh.addActionBlock(action);
  }

  // [Problem]
  else if (_current_task == "auto_create_problem" && getParam<bool>("auto_create_problem"))
  {
    if (_awh.hasActions("create_problem"))
    {
      for (const auto & act : _awh.getActionListByName("create_problem"))
      {
        auto * action = dynamic_cast<CreateProblemAction *>(act);
        if (action)
        {
          InputParameters & params = action->getObjectParams();

          if (!params.isParamSetByUser("solve"))
            params.set<bool>("solve") = false;

          if (!params.isParamSetByUser("kernel_coverage_check"))
            params.set<MooseEnum>("kernel_coverage_check") = "false";

          if (!params.isParamSetByUser("skip_nl_system_check"))
            params.set<bool>("skip_nl_system_check") = true;
        }
      }
    }
    else
    {
      // Build the Action parameters
      InputParameters action_params = _action_factory.getValidParams("CreateProblemAction");

      // Associate errors with "auto_create_problem"
      associateWithParameter("auto_create_problem", action_params);

      // Create the action
      auto action = std::static_pointer_cast<MooseObjectAction>(
          _action_factory.create("CreateProblemAction", "Problem", action_params));

      // Set the object parameters
      InputParameters & params = action->getObjectParams();
      params.set<bool>("solve") = false;
      params.set<MooseEnum>("kernel_coverage_check") = "false";
      params.set<bool>("skip_nl_system_check") = true;

      // Add Action to the warehouse
      _awh.addActionBlock(action);
    }
  }

  // [Executioner]
  else if (_current_task == "auto_create_executioner" &&
           getParam<bool>("auto_create_executioner") && !_awh.hasActions("setup_executioner"))
  {
    // Build the Action parameters
    InputParameters action_params = _action_factory.getValidParams("CreateExecutionerAction");
    action_params.set<std::string>("type") = "Steady";

    // Associate errors with "auto_create_executioner"
    associateWithParameter("auto_create_executioner", action_params);

    // Create the action
    auto action = std::static_pointer_cast<MooseObjectAction>(
        _action_factory.create("CreateExecutionerAction", "Executioner", action_params));

    // Add Action to the warehouse
    _awh.addActionBlock(action);
  }
}