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

#include <PFCRFFVariablesAction.h>

Inheritance diagram for PFCRFFVariablesAction:

Public Member Functions
	PFCRFFVariablesAction (const InputParameters &params)

virtual void	act ()

Private Attributes
const unsigned int	_num_L

const std::string	_L_name_base

Detailed Description

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

Definition at line 24 of file PFCRFFVariablesAction.h.

Constructor & Destructor Documentation

◆ PFCRFFVariablesAction()

PFCRFFVariablesAction::PFCRFFVariablesAction ( const InputParameters & params )

Definition at line 43 of file PFCRFFVariablesAction.C.

   : Action(params),
     _num_L(getParam<unsigned int>("num_L")),
     _L_name_base(getParam<std::string>("L_name_base"))
 {
 }

Member Function Documentation

◆ act()

void PFCRFFVariablesAction::act ( )

virtual

Definition at line 51 of file PFCRFFVariablesAction.C.

 {
 #ifdef DEBUG
   Moose::err << "Inside the PFCRFFVariablesAction Object\n";
   Moose::err << "VariableBase: " << _L_name_base << "\torder: " << getParam<MooseEnum>("order")
              << "\tfamily: " << getParam<MooseEnum>("family") << std::endl;
 #endif
  
   auto fe_type = AddVariableAction::feType(_pars);
   auto type = AddVariableAction::determineType(fe_type, 1);
   auto var_params = _factory.getValidParams(type);
  
   var_params.applySpecificParameters(_pars, {"family", "order"});
   var_params.set<std::vector<Real>>("scaling") = {getParam<Real>("scaling")};
  
   // 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
     const std::string real_name = L_name + "_real";
     _problem->addVariable(type, real_name, var_params);
  
     if (l > 0)
     {
       // Create imaginary L variable IF l > 0
       std::string imag_name = L_name + "_imag";
       _problem->addVariable(type, imag_name, var_params);
     }
   }
 }

Member Data Documentation

◆ _L_name_base

const std::string PFCRFFVariablesAction::_L_name_base

private

Definition at line 33 of file PFCRFFVariablesAction.h.

Referenced by act().

◆ _num_L

const unsigned int PFCRFFVariablesAction::_num_L