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

#include <MatVecRealGradAuxKernelAction.h>

Inheritance diagram for MatVecRealGradAuxKernelAction:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

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

const AuxVariableName _div_var
 
const std::vector< MaterialPropertyName > _prop
 
const MaterialPropertyName _div_prop
 
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 MatVecRealGradAuxKernelAction.h.

Constructor & Destructor Documentation

◆ MatVecRealGradAuxKernelAction()

MatVecRealGradAuxKernelAction::MatVecRealGradAuxKernelAction ( const InputParameters &  params)

Definition at line 39 of file MatVecRealGradAuxKernelAction.C.

40  : Action(params),
41  _div_var(getParam<AuxVariableName>("divergence_variable")),
42  _prop(getParam<std::vector<MaterialPropertyName>>("property")),
43  _div_prop(getParam<MaterialPropertyName>("divergence_property"))
44 {
45  mooseDeprecated("Use 'MaterialVectorAuxKernel' or 'MaterialVectorGradAuxKernel' action instead "
46  "depending on data_type of MaterialProperty<std::vector<data_type> >");
47 }
Action::mooseDeprecated
void mooseDeprecated(Args &&... args) const
Action::Action
Action(const InputParameters &parameters)
MatVecRealGradAuxKernelAction::_prop
const std::vector< MaterialPropertyName > _prop
Definition: MatVecRealGradAuxKernelAction.h:25
Action::getParam
const T & getParam(const std::string &name) const

Member Function Documentation

◆ act()

void MatVecRealGradAuxKernelAction::act ( )
virtual

Implements Action.

Definition at line 50 of file MatVecRealGradAuxKernelAction.C.

51 {
52  const std::vector<std::string> var_name_base =
53  getParam<std::vector<std::string>>("var_name_base");
54 
55  const unsigned int op_num = getParam<unsigned int>("op_num");
56  const unsigned int dim = getParam<unsigned int>("dim");
57  const unsigned int size_v = var_name_base.size();
58  const unsigned int size_p = _prop.size();
59 
60  if (size_p != size_v)
61  paramError("property", "var_name_base and property must be vectors of the same dimension");
62 
63  for (unsigned int op = 0; op < op_num; ++op)
64  {
65  for (unsigned int val = 0; val < size_v; ++val)
66  for (unsigned int x = 0; x < dim; ++x)
67  {
68  std::string var_name = var_name_base[val] + Moose::stringify(x) + Moose::stringify(op);
69  {
70  InputParameters params = _factory.getValidParams("MaterialStdVectorRealGradientAux");
71  params.set<AuxVariableName>("variable") = var_name;
72  params.set<MaterialPropertyName>("property") = _prop[val];
73  params.set<unsigned int>("component") = x;
74  params.set<unsigned int>("index") = op;
75  params.set<bool>("use_displaced_mesh") = getParam<bool>("use_displaced_mesh");
76  _problem->addAuxKernel("MaterialStdVectorRealGradientAux", "grad_" + var_name, params);
77  }
78  }
79 
80  if (isParamValid("divergence_variable"))
81  {
82  if (isParamValid("divergence_property"))
83  {
84  InputParameters params = _factory.getValidParams("MaterialStdVectorAux");
85  params.set<AuxVariableName>("variable") = _div_var;
86  params.set<MaterialPropertyName>("property") = _div_prop;
87  params.set<unsigned int>("index") = op;
88  params.set<bool>("use_displaced_mesh") = getParam<bool>("use_displaced_mesh");
89  _problem->addAuxKernel("MaterialStdVectorAux", "div_" + Moose::stringify(op), params);
90  }
91  else
92  mooseError("Must specify a divergence_property name along with divergence_variable name");
93  }
94  }
95 }
dim
unsigned int dim
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
Factory::getValidParams
InputParameters getValidParams(const std::string &name) const
Action::isParamValid
bool isParamValid(const std::string &name) const
Action::_factory
Factory & _factory
x
const std::vector< double > x
Definition: EquilibriumConstantFitTest.C:17
MatVecRealGradAuxKernelAction::_prop
const std::vector< MaterialPropertyName > _prop
Definition: MatVecRealGradAuxKernelAction.h:25
Action::paramError
void paramError(const std::string &param, Args... args) const
Moose::stringify
std::string stringify(const T &t)
Action::mooseError
void mooseError(Args &&... args) const
Action::_problem
std::shared_ptr< FEProblemBase > & _problem

◆ validParams()

InputParameters MatVecRealGradAuxKernelAction::validParams ( )
static

Definition at line 18 of file MatVecRealGradAuxKernelAction.C.

19 {
20  InputParameters params = Action::validParams();
21  params.addClassDescription("Outputs all components of the gradient of the real standard "
22  "vector-valued properties specified");
23  params.addRequiredParam<unsigned int>("op_num",
24  "Value that specifies the number of grains to create");
25  params.addRequiredParam<std::vector<std::string>>(
26  "var_name_base", "Vector specifies the base name of the variables");
27  params.addRequiredParam<std::vector<MaterialPropertyName>>("property",
28  "the scalar material property names");
29  params.addParam<bool>(
30  "use_displaced_mesh", false, "Whether to use displaced mesh in the kernels");
31  params.addRequiredParam<unsigned int>("dim", "the dimensions of the mesh");
32  params.addParam<AuxVariableName>("divergence_variable",
33  "Name of divergence variable to generate kernels for");
34  params.addParam<MaterialPropertyName>("divergence_property",
35  "Scalar material property name for divergence variable");
36  return params;
37 }
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)
Action::validParams
static InputParameters validParams()
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _div_prop

const MaterialPropertyName MatVecRealGradAuxKernelAction::_div_prop
protected

Definition at line 26 of file MatVecRealGradAuxKernelAction.h.

Referenced by act().

◆ _div_var

const AuxVariableName MatVecRealGradAuxKernelAction::_div_var
protected

Definition at line 24 of file MatVecRealGradAuxKernelAction.h.

Referenced by act().

◆ _prop

const std::vector<MaterialPropertyName> MatVecRealGradAuxKernelAction::_prop
protected

Definition at line 25 of file MatVecRealGradAuxKernelAction.h.

Referenced by act().

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