https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | 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 Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 HHPFCRFFSplitVariablesAction (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
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParameters & parameters () const
 
MooseObjectName uniqueName () 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 &nm) const
 
void paramError (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
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) 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 ()
 

Public Attributes

const ConsoleStream _console
 

Static Public Attributes

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
 

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
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
const Parallel::Communicator & _communicator
 

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 18 of file HHPFCRFFSplitVariablesAction.h.

Constructor & Destructor Documentation

◆ HHPFCRFFSplitVariablesAction()

HHPFCRFFSplitVariablesAction::HHPFCRFFSplitVariablesAction ( const InputParameters &  params)

Definition at line 46 of file HHPFCRFFSplitVariablesAction.C.

47  : Action(params),
48  _num_L(getParam<unsigned int>("num_L")),
49  _L_name_base(getParam<std::string>("L_name_base"))
50 {
51 }
Action::Action
Action(const InputParameters &parameters)

Member Function Documentation

◆ act()

void HHPFCRFFSplitVariablesAction::act ( )
virtual

Implements Action.

Definition at line 54 of file HHPFCRFFSplitVariablesAction.C.

55 {
56 #ifdef DEBUG
57  Moose::err << "Inside the HHPFCRFFSplitVariablesAction Object\n";
58  Moose::err << "VariableBase: " << _L_name_base << "\torder: " << getParam<MooseEnum>("order")
59  << "\tfamily: " << getParam<MooseEnum>("family") << std::endl;
60 #endif
61 
62  // Loop through the number of L variables
63  for (unsigned int l = 0; l < _num_L; ++l)
64  {
65  // Create L base name
66  std::string L_name = _L_name_base + Moose::stringify(l);
67 
68  // Create real L variable
69  std::string real_name = L_name + "_real";
70 
71  const auto type = "MooseVariable";
72  auto params = _factory.getValidParams(type);
73  params.applySpecificParameters(_pars, {"family", "order", "block"});
74  params.set<std::vector<Real>>("scaling") = {getParam<Real>("scaling")};
75 
76  _problem->addVariable(type, real_name, params);
77 
78  if (l > 0)
79  {
80  // Create imaginary L variable IF l > 0
81  std::string imag_name = L_name + "_imag";
82 
83  _problem->addVariable(type, imag_name, params);
84  }
85  }
86 }
InputParameters::applySpecificParameters
void applySpecificParameters(const InputParameters &common, const std::vector< std::string > &include, bool allow_private=false)
Factory::getValidParams
InputParameters getValidParams(const std::string &name) const
Action::_factory
Factory & _factory
Action::type
const std::string & type() const
Moose::stringify
std::string stringify(const T &t)
Action::_pars
const InputParameters & _pars
Action::_problem
std::shared_ptr< FEProblemBase > & _problem

◆ validParams()

InputParameters HHPFCRFFSplitVariablesAction::validParams ( )
static

Definition at line 21 of file HHPFCRFFSplitVariablesAction.C.

22 {
23  InputParameters params = Action::validParams();
24  params.addClassDescription(
25  "Creates the L nonlinear variables for the Cahn-Hilliard equation for the RFF form of the "
26  "phase field crystal model, when using a split approach");
27  MooseEnum familyEnum = AddVariableAction::getNonlinearVariableFamilies();
28  params.addParam<MooseEnum>(
29  "family",
30  familyEnum,
31  "Specifies the family of FE shape functions to use for the L variables");
32  MooseEnum orderEnum = AddVariableAction::getNonlinearVariableOrders();
33  params.addParam<MooseEnum>(
34  "order",
35  orderEnum,
36  "Specifies the order of the FE shape function to use for the L variables");
37  params.addParam<Real>("scaling", 1.0, "Specifies a scaling factor to apply to the L variables");
38  params.addRequiredParam<unsigned int>(
39  "num_L", "specifies the number of complex L variables will be solved for");
40  params.addRequiredParam<std::string>("L_name_base", "Base name for the complex L variables");
41  params.addParam<std::vector<SubdomainName>>(
42  "block", {}, "Block restriction for the variables and kernels");
43  return params;
44 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
AddVariableAction::getNonlinearVariableFamilies
static MooseEnum getNonlinearVariableFamilies()
Action::validParams
static InputParameters validParams()
AddVariableAction::getNonlinearVariableOrders
static MooseEnum getNonlinearVariableOrders()
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _L_name_base

const std::string HHPFCRFFSplitVariablesAction::_L_name_base
private

Definition at line 29 of file HHPFCRFFSplitVariablesAction.h.

Referenced by act().

◆ _num_L

const unsigned int HHPFCRFFSplitVariablesAction::_num_L
private

Definition at line 28 of file HHPFCRFFSplitVariablesAction.h.

Referenced by act().

The documentation for this class was generated from the following files:
Generated on Fri Jul 18 2025 13:47:39 for https://mooseframework.inl.gov by   doxygen 1.8.14