Automatically generates all the L variables for the RFF phase field crystal model. More...

#include <CHPFCRFFSplitVariablesAction.h>

Inheritance diagram for CHPFCRFFSplitVariablesAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	CHPFCRFFSplitVariablesAction (const InputParameters &params)

virtual void	act ()

void	timedAct ()

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)

MooseObjectName	uniqueActionName () const

const std::string &	specificTaskName () const

const std::set< std::string > &	getAllTasks () const

void	appendTask (const std::string &task)

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecatedNoTrace (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

PerfGraph &	perfGraph ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	unique_action_name_param

static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)

void	associateWithParameter (const std::string &param_name, InputParameters &params) const

void	associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) const

const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)

const T &	getMeshProperty (const std::string &data_name)

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

bool	hasMeshProperty (const std::string &data_name) const

std::string	meshPropertyName (const std::string &data_name) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
std::string	_registered_identifier

std::string	_specific_task_name

std::set< std::string >	_all_tasks

ActionWarehouse &	_awh

const std::string &	_current_task

std::shared_ptr< MooseMesh > &	_mesh

std::shared_ptr< MooseMesh > &	_displaced_mesh

std::shared_ptr< FEProblemBase > &	_problem

PerfID	_act_timer

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Private Member Functions
bool	addRelationshipManager (Moose::RelationshipManagerType input_rm_type, const InputParameters &moose_object_pars, std::string rm_name, Moose::RelationshipManagerType rm_type, Moose::RelationshipManagerInputParameterCallback rm_input_parameter_func, Moose::RMSystemType sys_type=Moose::RMSystemType::NONE)

virtual std::string	meshPropertyPrefix (const std::string &data_name) const

const RestartableDataValue &	getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const

void	mooseErrorInternal (Args &&... args) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
const unsigned int	_num_L

const std::string	_L_name_base

const std::vector< FileName >	_sub_filenames

const AuxVariableName	_n_name

const ParallelParamObject &	_parent

MooseApp &	_meta_data_app

const MooseObject *const	_meta_data_object

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

Detailed Description

Automatically generates all the L variables for the RFF phase field crystal model.

Definition at line 18 of file CHPFCRFFSplitVariablesAction.h.

Constructor & Destructor Documentation

◆ CHPFCRFFSplitVariablesAction()

CHPFCRFFSplitVariablesAction::CHPFCRFFSplitVariablesAction ( const InputParameters & params )

Definition at line 48 of file CHPFCRFFSplitVariablesAction.C.

  : 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"))
{
}

Member Function Documentation

◆ act()

void CHPFCRFFSplitVariablesAction::act ( )

virtual

Implements Action.

Definition at line 58 of file CHPFCRFFSplitVariablesAction.C.

{
  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);
    }
  }
}

◆ validParams()

InputParameters CHPFCRFFSplitVariablesAction::validParams ( )

static

Definition at line 21 of file CHPFCRFFSplitVariablesAction.C.

{
  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;
}

Member Data Documentation

◆ _L_name_base

const std::string CHPFCRFFSplitVariablesAction::_L_name_base

private

Definition at line 29 of file CHPFCRFFSplitVariablesAction.h.

Referenced by act().

◆ _n_name

const AuxVariableName CHPFCRFFSplitVariablesAction::_n_name

private

Definition at line 31 of file CHPFCRFFSplitVariablesAction.h.

Referenced by act().

◆ _num_L

const unsigned int CHPFCRFFSplitVariablesAction::_num_L

private

Definition at line 28 of file CHPFCRFFSplitVariablesAction.h.

Referenced by act().

◆ _sub_filenames

const std::vector<FileName> CHPFCRFFSplitVariablesAction::_sub_filenames

private

Definition at line 30 of file CHPFCRFFSplitVariablesAction.h.

Referenced by act().

The documentation for this class was generated from the following files:

phase_field/include/actions/CHPFCRFFSplitVariablesAction.h
phase_field/src/actions/CHPFCRFFSplitVariablesAction.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CHPFCRFFSplitVariablesAction()

Member Function Documentation

◆ act()

◆ validParams()

Member Data Documentation

◆ _L_name_base

◆ _n_name

◆ _num_L

◆ _sub_filenames