www.mooseframework.org
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
PFCRFFVariablesAction Class Reference

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

#include <PFCRFFVariablesAction.h>

Inheritance diagram for PFCRFFVariablesAction:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 PFCRFFVariablesAction (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)
 
MooseAppgetMooseApp () 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 InputParametersparameters () 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 & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
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 mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
PerfGraphperfGraph ()
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &name, const std::string *param=nullptr) const
 
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 PFCRFFVariablesAction.h.

Constructor & Destructor Documentation

◆ PFCRFFVariablesAction()

PFCRFFVariablesAction::PFCRFFVariablesAction ( const InputParameters params)

Definition at line 43 of file PFCRFFVariablesAction.C.

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

Member Function Documentation

◆ act()

void PFCRFFVariablesAction::act ( )
virtual

Implements Action.

Definition at line 51 of file PFCRFFVariablesAction.C.

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

◆ validParams()

InputParameters PFCRFFVariablesAction::validParams ( )
static

Definition at line 21 of file PFCRFFVariablesAction.C.

22 {
25  params.addParam<MooseEnum>(
26  "family",
27  familyEnum,
28  "Specifies the family of FE shape functions to use for the L variables");
30  params.addParam<MooseEnum>(
31  "order",
32  orderEnum,
33  "Specifies the order of the FE shape function to use for the L variables");
34  params.addParam<Real>("scaling", 1.0, "Specifies a scaling factor to apply to the L variables");
35  params.addRequiredParam<unsigned int>(
36  "num_L", "specifies the number of complex L variables will be solved for");
37  params.addRequiredParam<std::string>("L_name_base", "Base name for the complex L variables");
38  params.addParam<std::vector<SubdomainName>>(
39  "block", {}, "Block restriction for the variables and kernels");
40  return params;
41 }
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
void addRequiredParam(const std::string &name, const std::string &doc_string)
static MooseEnum getNonlinearVariableFamilies()
static InputParameters validParams()
static MooseEnum getNonlinearVariableOrders()
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

Member Data Documentation

◆ _L_name_base

const std::string PFCRFFVariablesAction::_L_name_base
private

Definition at line 29 of file PFCRFFVariablesAction.h.

Referenced by act().

◆ _num_L

const unsigned int PFCRFFVariablesAction::_num_L
private

Definition at line 28 of file PFCRFFVariablesAction.h.

Referenced by act().


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