CHPFCRFFSplitVariablesAction.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 "CHPFCRFFSplitVariablesAction.h"
#include "Factory.h"
#include "FEProblem.h"
#include "Conversion.h"
#include "AddVariableAction.h"

#include "libmesh/string_to_enum.h"

using namespace libMesh;

registerMooseAction("PhaseFieldApp", CHPFCRFFSplitVariablesAction, "add_variable");

InputParameters
CHPFCRFFSplitVariablesAction::validParams()
{
  InputParameters params = Action::validParams();
  MooseEnum familyEnum = AddVariableAction::getNonlinearVariableFamilies();
  params.addClassDescription("Creates the L auxiliary variables, as well as a MultiApp along with "
                             "transfers to set the variables, for the Cahn-Hilliard equation for "
                             "the RFF form of the phase field crystal model");
  params.addParam<MooseEnum>(
      "family",
      familyEnum,
      "Specifies the family of FE shape functions to use for the L variables");
  MooseEnum orderEnum = AddVariableAction::getNonlinearVariableOrders();
  params.addParam<MooseEnum>(
      "order",
      orderEnum,
      "Specifies the order of the FE shape function to use for the L variables");
  params.addParam<Real>("scaling", 1.0, "Specifies a scaling factor to apply to the L variables");
  params.addRequiredParam<unsigned int>(
      "num_L", "specifies the number of complex L variables will be solved for");
  params.addRequiredParam<std::string>("L_name_base", "Base name for the complex L variables");
  params.addRequiredParam<std::vector<FileName>>("sub_filenames",
                                                 "This is the filename of the sub.i file");
  params.addRequiredParam<AuxVariableName>("n_name", "Name of atomic density variable");

  return params;
}

CHPFCRFFSplitVariablesAction::CHPFCRFFSplitVariablesAction(const InputParameters & params)
  : Action(params),
    _num_L(getParam<unsigned int>("num_L")),
    _L_name_base(getParam<std::string>("L_name_base")),
    _sub_filenames(getParam<std::vector<FileName>>("sub_filenames")),
    _n_name(getParam<AuxVariableName>("n_name"))
{
}

void
CHPFCRFFSplitVariablesAction::act()
{
  ExecFlagEnum execute_options = MooseUtils::getDefaultExecFlagEnum();
  execute_options = EXEC_TIMESTEP_BEGIN;

  // Setup MultiApp
  InputParameters poly_params = _factory.getValidParams("TransientMultiApp");
  poly_params.set<MooseEnum>("app_type") = "PhaseFieldApp";
  poly_params.set<ExecFlagEnum>("execute_on") = execute_options;
  poly_params.set<std::vector<FileName>>("input_files") = _sub_filenames;
  poly_params.set<unsigned int>("max_procs_per_app") = 1;
  poly_params.set<std::vector<Point>>("positions") = {Point()};
  _problem->addMultiApp("TransientMultiApp", "HHEquationSolver", poly_params);

  poly_params = _factory.getValidParams("MultiAppNearestNodeTransfer");
  poly_params.set<ExecFlagEnum>("execute_on") = execute_options;
  poly_params.set<std::vector<AuxVariableName>>("variable") = {_n_name};
  poly_params.set<std::vector<VariableName>>("source_variable") = {_n_name};
  poly_params.set<MultiAppName>("to_multi_app") = "HHEquationSolver";
  _problem->addTransfer("MultiAppNearestNodeTransfer", _n_name + "_trans", poly_params);

  // Loop through the number of L variables
  for (unsigned int l = 0; l < _num_L; ++l)
  {
    // Create L base name
    std::string L_name = _L_name_base + Moose::stringify(l);

    // Create real L variable
    std::string real_name = L_name + "_real";

    // Get string name for specified L variable type
    std::string var_type = AddVariableAction::variableType(
        FEType(Utility::string_to_enum<Order>(getParam<MooseEnum>("order")),
               Utility::string_to_enum<FEFamily>(getParam<MooseEnum>("family"))),
        /* is_fv = */ false,
        /* is_array = */ false);

    // Get params for specified L variable type
    InputParameters var_params = _factory.getValidParams(var_type);

    _problem->addAuxVariable(var_type, real_name, var_params);

    poly_params = _factory.getValidParams("MultiAppNearestNodeTransfer");
    poly_params.set<std::vector<AuxVariableName>>("variable") = {real_name};
    poly_params.set<std::vector<VariableName>>("source_variable") = {real_name};
    poly_params.set<MultiAppName>("from_multi_app") = "HHEquationSolver";
    _problem->addTransfer("MultiAppNearestNodeTransfer", real_name + "_trans", poly_params);

    if (l > 0)
    {
      // Create imaginary L variable IF l > 0
      std::string imag_name = L_name + "_imag";

      _problem->addAuxVariable(var_type, imag_name, var_params);

      poly_params = _factory.getValidParams("MultiAppNearestNodeTransfer");
      poly_params.set<std::vector<AuxVariableName>>("variable") = {imag_name};
      poly_params.set<std::vector<VariableName>>("source_variable") = {imag_name};
      poly_params.set<MultiAppName>("from_multi_app") = "HHEquationSolver";
      _problem->addTransfer("MultiAppNearestNodeTransfer", imag_name + "_trans", poly_params);
    }
  }
}