www.mooseframework.org
Public Member Functions | Private Attributes | List of all members
HHPFCRFFSplitVariablesAction Class Reference

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

#include <HHPFCRFFSplitVariablesAction.h>

Inheritance diagram for HHPFCRFFSplitVariablesAction:
[legend]

Public Member Functions

 HHPFCRFFSplitVariablesAction (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 HHPFCRFFSplitVariablesAction.h.

Constructor & Destructor Documentation

◆ HHPFCRFFSplitVariablesAction()

HHPFCRFFSplitVariablesAction::HHPFCRFFSplitVariablesAction ( const InputParameters &  params)

Definition at line 43 of file HHPFCRFFSplitVariablesAction.C.

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

Member Function Documentation

◆ act()

void HHPFCRFFSplitVariablesAction::act ( )
virtual

Definition at line 51 of file HHPFCRFFSplitVariablesAction.C.

52 {
53 #ifdef DEBUG
54  Moose::err << "Inside the HHPFCRFFSplitVariablesAction Object\n";
55  Moose::err << "VariableBase: " << _L_name_base << "\torder: " << getParam<MooseEnum>("order")
56  << "\tfamily: " << getParam<MooseEnum>("family") << std::endl;
57 #endif
58 
59  // Loop through the number of L variables
60  for (unsigned int l = 0; l < _num_L; ++l)
61  {
62  // Create L base name
63  std::string L_name = _L_name_base + Moose::stringify(l);
64 
65  // Create real L variable
66  std::string real_name = L_name + "_real";
67 
68  _problem->addVariable(real_name,
69  FEType(Utility::string_to_enum<Order>(getParam<MooseEnum>("order")),
70  Utility::string_to_enum<FEFamily>(getParam<MooseEnum>("family"))),
71  getParam<Real>("scaling"));
72 
73  if (l > 0)
74  {
75  // Create imaginary L variable IF l > 0
76  std::string imag_name = L_name + "_imag";
77 
78  _problem->addVariable(
79  imag_name,
80  FEType(Utility::string_to_enum<Order>(getParam<MooseEnum>("order")),
81  Utility::string_to_enum<FEFamily>(getParam<MooseEnum>("family"))),
82  getParam<Real>("scaling"));
83  }
84  }
85 }

Member Data Documentation

◆ _L_name_base

const std::string HHPFCRFFSplitVariablesAction::_L_name_base
private

Definition at line 33 of file HHPFCRFFSplitVariablesAction.h.

Referenced by act().

◆ _num_L

const unsigned int HHPFCRFFSplitVariablesAction::_num_L
private

Definition at line 32 of file HHPFCRFFSplitVariablesAction.h.

Referenced by act().


The documentation for this class was generated from the following files:
HHPFCRFFSplitVariablesAction::_num_L
const unsigned int _num_L
Definition: HHPFCRFFSplitVariablesAction.h:32
HHPFCRFFSplitVariablesAction::_L_name_base
const std::string _L_name_base
Definition: HHPFCRFFSplitVariablesAction.h:33