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
PolycrystalVariablesAction Class Reference

Automatically generates all variables to model a polycrystal with op_num orderparameters. More...

#include <PolycrystalVariablesAction.h>

Inheritance diagram for PolycrystalVariablesAction:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 PolycrystalVariablesAction (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 _op_num
 
const std::string _var_name_base
 

Detailed Description

Automatically generates all variables to model a polycrystal with op_num orderparameters.

Definition at line 18 of file PolycrystalVariablesAction.h.

Constructor & Destructor Documentation

◆ PolycrystalVariablesAction()

PolycrystalVariablesAction::PolycrystalVariablesAction ( const InputParameters params)

Definition at line 52 of file PolycrystalVariablesAction.C.

53  : Action(params),
54  _op_num(getParam<unsigned int>("op_num")),
55  _var_name_base(getParam<std::string>("var_name_base"))
56 {
57 }
Action(const InputParameters &parameters)

Member Function Documentation

◆ act()

void PolycrystalVariablesAction::act ( )
virtual

Implements Action.

Definition at line 60 of file PolycrystalVariablesAction.C.

61 {
62  // take initial values from file?
63  bool initial_from_file = getParam<bool>("initial_from_file");
64 
65  // Loop through the number of order parameters
66  for (unsigned int op = 0; op < _op_num; op++)
67  {
68  // Create variable names
69  std::string var_name = _var_name_base + Moose::stringify(op);
70 
71  // Add the variable
72  if (_current_task == "add_variable")
73  {
74  auto fe_type = AddVariableAction::feType(_pars);
75  auto type = AddVariableAction::variableType(fe_type);
76  auto var_params = _factory.getValidParams(type);
77 
78  var_params.applySpecificParameters(_pars, {"order", "family", "block"});
79  var_params.set<std::vector<Real>>("scaling") = {_pars.get<Real>("scaling")};
80  _problem->addVariable(type, var_name, var_params);
81  }
82 
83  // Setup initial from file if requested
84  if (initial_from_file)
85  {
86  if (_current_task == "check_copy_nodal_vars")
88 
89  if (_current_task == "copy_nodal_vars")
90  {
91  auto * system = &_problem->getNonlinearSystemBase(/*nl_sys_num=*/0);
92  system->addVariableToCopy(var_name, var_name, "LATEST");
93  }
94  }
95  }
96 }
static std::string variableType(const FEType &fe_type, const bool is_fv=false, const bool is_array=false)
void applySpecificParameters(const InputParameters &common, const std::vector< std::string > &include, bool allow_private=false)
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
MooseApp & _app
InputParameters getValidParams(const std::string &name) const
Factory & _factory
void setExodusFileRestart(bool flag)
const std::string & type() const
const std::string & _current_task
std::string stringify(const T &t)
static FEType feType(const InputParameters &params)
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
const InputParameters & _pars
std::shared_ptr< FEProblemBase > & _problem

◆ validParams()

InputParameters PolycrystalVariablesAction::validParams ( )
static

Definition at line 24 of file PolycrystalVariablesAction.C.

25 {
27  params.addClassDescription("Set up order parameter variables for a polycrystal simulation");
28  // Get MooseEnums for the possible order/family options for this variable
31  params.addParam<MooseEnum>("family",
32  families,
33  "Specifies the family of FE "
34  "shape function to use for the order parameters");
35  params.addParam<MooseEnum>("order",
36  orders,
37  "Specifies the order of the FE "
38  "shape function to use for the order parameters");
39  params.addParam<bool>(
40  "initial_from_file",
41  false,
42  "Take the initial condition of all polycrystal variables from the mesh file");
43  params.addParam<Real>("scaling", 1.0, "Specifies a scaling factor to apply to this variable");
44  params.addRequiredParam<unsigned int>("op_num",
45  "specifies the number of order parameters to create");
46  params.addRequiredParam<std::string>("var_name_base", "specifies the base name of the variables");
47  params.addParam<std::vector<SubdomainName>>(
48  "block", {}, "Block restriction for the variables and kernels");
49  return params;
50 }
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
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _op_num

const unsigned int PolycrystalVariablesAction::_op_num
private

Definition at line 28 of file PolycrystalVariablesAction.h.

Referenced by act().

◆ _var_name_base

const std::string PolycrystalVariablesAction::_var_name_base
private

Definition at line 29 of file PolycrystalVariablesAction.h.

Referenced by act().


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