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 | List of all members
RigidBodyMultiKernelAction Class Reference

#include <RigidBodyMultiKernelAction.h>

Inheritance diagram for RigidBodyMultiKernelAction:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 RigidBodyMultiKernelAction (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

unsigned int _op_num
 
std::string _var_name_base
 
bool _implicit
 
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
 

Detailed Description

Definition at line 14 of file RigidBodyMultiKernelAction.h.

Constructor & Destructor Documentation

◆ RigidBodyMultiKernelAction()

RigidBodyMultiKernelAction::RigidBodyMultiKernelAction ( const InputParameters params)

Definition at line 49 of file RigidBodyMultiKernelAction.C.

50  : Action(params),
51  _op_num(getParam<unsigned int>("op_num")),
52  _var_name_base(getParam<std::string>("var_name_base")),
53  _implicit(getParam<bool>("implicit"))
54 {
55 }
Action(const InputParameters &parameters)

Member Function Documentation

◆ act()

void RigidBodyMultiKernelAction::act ( )
virtual

Implements Action.

Definition at line 58 of file RigidBodyMultiKernelAction.C.

59 {
60  for (unsigned int op = 0; op < _op_num; ++op)
61  {
62  //
63  // Create variable names
64  //
65 
66  std::string var_name = _var_name_base + Moose::stringify(op);
67 
68  //
69  // Create vector of coupled variables
70  //
71 
72  std::vector<VariableName> arg;
73  unsigned int ind = 0;
74 
75  if (isParamValid("c"))
76  {
77  VariableName c = getParam<VariableName>("c");
78  arg.resize(_op_num);
79 
80  for (unsigned int j = 0; j < _op_num; ++j)
81  if (j != op)
82  arg[ind++] = _var_name_base + Moose::stringify(j);
83 
84  arg[ind++] = c;
85  }
86  else
87  {
88  arg.resize(_op_num - 1);
89  for (unsigned int j = 0; j < _op_num; ++j)
90  if (j != op)
91  arg[ind++] = _var_name_base + Moose::stringify(j);
92  }
93 
94  //
95  // Create vector of order parameters
96  //
97 
98  std::vector<VariableName> v(_op_num);
99  for (unsigned int j = 0; j < _op_num; ++j)
101 
102  //
103  // Set up ACInterface kernels
104  //
105 
106  {
107  InputParameters params = _factory.getValidParams("ACInterface");
108  params.set<NonlinearVariableName>("variable") = var_name;
109  params.set<bool>("implicit") = getParam<bool>("implicit");
110  params.set<bool>("use_displaced_mesh") = getParam<bool>("use_displaced_mesh");
111  params.set<MaterialPropertyName>("kappa_name") = getParam<MaterialPropertyName>("kappa_name");
112  params.set<MaterialPropertyName>("mob_name") = getParam<MaterialPropertyName>("mob_name");
113 
114  std::string kernel_name = "ACInt_" + var_name;
115  _problem->addKernel("ACInterface", kernel_name, params);
116  }
117 
118  //
119  // Set up the AllenCahn kernels
120  //
121 
122  {
123  InputParameters params = _factory.getValidParams("AllenCahn");
124  params.set<NonlinearVariableName>("variable") = var_name;
125  params.set<std::vector<VariableName>>("args") = arg;
126  params.set<MaterialPropertyName>("mob_name") = getParam<MaterialPropertyName>("mob_name");
127  params.set<MaterialPropertyName>("f_name") = getParam<MaterialPropertyName>("f_name");
128  params.set<bool>("implicit") = _implicit;
129  params.set<bool>("use_displaced_mesh") = getParam<bool>("use_displaced_mesh");
130 
131  std::string kernel_name = "AC_" + var_name;
132  _problem->addKernel("AllenCahn", kernel_name, params);
133  }
134 
135  //
136  // Set up SingleGrainRigidBodyMotion kernels
137  //
138 
139  {
140  InputParameters params = _factory.getValidParams("SingleGrainRigidBodyMotion");
141  params.set<NonlinearVariableName>("variable") = var_name;
142  params.set<std::vector<VariableName>>("v") = v;
143  params.set<unsigned int>("op_index") = op;
144  params.set<std::vector<VariableName>>("c") = {getParam<VariableName>("c")};
145  if (isParamValid("base_name"))
146  params.set<std::string>("base_name") = getParam<std::string>("base_name");
147  params.set<Real>("translation_constant") = getParam<Real>("translation_constant");
148  params.set<Real>("rotation_constant") = getParam<Real>("rotation_constant");
149  params.set<UserObjectName>("grain_force") = getParam<UserObjectName>("grain_force");
150  params.set<UserObjectName>("grain_tracker_object") =
151  getParam<UserObjectName>("grain_tracker_object");
152  params.set<VectorPostprocessorName>("grain_volumes") =
153  getParam<VectorPostprocessorName>("grain_volumes");
154 
155  params.set<bool>("implicit") = _implicit;
156  params.set<bool>("use_displaced_mesh") = getParam<bool>("use_displaced_mesh");
157 
158  std::string kernel_name = "RigidBody_" + var_name;
159  _problem->addKernel("SingleGrainRigidBodyMotion", kernel_name, params);
160  }
161 
162  //
163  // Set up TimeDerivative kernels
164  //
165 
166  {
167  InputParameters params = _factory.getValidParams("TimeDerivative");
168  params.set<NonlinearVariableName>("variable") = var_name;
169  params.set<bool>("implicit") = true;
170  params.set<bool>("use_displaced_mesh") = getParam<bool>("use_displaced_mesh");
171 
172  std::string kernel_name = "IE_" + var_name;
173  _problem->addKernel("TimeDerivative", kernel_name, params);
174  }
175  }
176 }
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
bool isParamValid(const std::string &name) const
Factory & _factory
std::string stringify(const T &t)
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
static const std::string v
Definition: NS.h:82
std::shared_ptr< FEProblemBase > & _problem
static const std::complex< double > j(0, 1)
Complex number "j" (also known as "i")

◆ validParams()

InputParameters RigidBodyMultiKernelAction::validParams ( )
static

Definition at line 19 of file RigidBodyMultiKernelAction.C.

20 {
22  params.addClassDescription(
23  "Action for applying Allen-Cahn equations and SingleGrainRigidBodyMotion to grains");
24  params.addRequiredParam<unsigned int>("op_num", "specifies the number of grains to create");
25  params.addRequiredParam<std::string>("var_name_base", "specifies the base name of the variables");
26  params.addParam<VariableName>("c", "Name of coupled concentration variable");
27  params.addParam<MaterialPropertyName>("kappa_name", "kappa_op", "The kappa used with the kernel");
28  params.addParam<MaterialPropertyName>("mob_name", "L", "The mobility used with the kernel");
29  params.addParam<MaterialPropertyName>(
30  "f_name", "Base name of the free energy function F defined in a DerivativeParsedMaterial");
31  params.addParam<std::string>("base_name",
32  "Optional parameter that allows the user to define "
33  "type of force density under consideration");
34  params.addParam<Real>(
35  "translation_constant", 500, "constant value characterizing grain translation");
36  params.addParam<Real>("rotation_constant", 1.0, "constant value characterizing grain rotation");
37  params.addRequiredParam<UserObjectName>(
38  "grain_force", "userobject for getting force and torque acting on grains");
39  params.addRequiredParam<UserObjectName>("grain_tracker_object",
40  "The FeatureFloodCount UserObject to get values from.");
41  params.addRequiredParam<VectorPostprocessorName>("grain_volumes",
42  "The feature volume VectorPostprocessorValue.");
43  params.addParam<bool>("implicit", true, "Whether kernels are implicit or not");
44  params.addParam<bool>(
45  "use_displaced_mesh", false, "Whether to use displaced mesh in the kernels");
46  return params;
47 }
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 InputParameters validParams()
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _implicit

bool RigidBodyMultiKernelAction::_implicit

Definition at line 24 of file RigidBodyMultiKernelAction.h.

Referenced by act().

◆ _op_num

unsigned int RigidBodyMultiKernelAction::_op_num

Definition at line 22 of file RigidBodyMultiKernelAction.h.

Referenced by act().

◆ _var_name_base

std::string RigidBodyMultiKernelAction::_var_name_base

Definition at line 23 of file RigidBodyMultiKernelAction.h.

Referenced by act().


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