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

#include <MaterialVectorAuxKernelAction.h>

Inheritance diagram for MaterialVectorAuxKernelAction:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 MaterialVectorAuxKernelAction (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 * queryParam (const std::string &name) 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 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
 
PerfGraphperfGraph ()
 
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 unsigned int _grain_num
 number of grains to create More...
 
const std::vector< std::string > & _var_name_base
 base name for the auxvariables More...
 
const unsigned int _num_var
 number of auxvariables More...
 
const std::vector< MaterialPropertyName > & _prop
 list of material properties to be used More...
 
const unsigned int _num_prop
 number of properties More...
 
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 MaterialVectorAuxKernelAction.h.

Constructor & Destructor Documentation

◆ MaterialVectorAuxKernelAction()

MaterialVectorAuxKernelAction::MaterialVectorAuxKernelAction ( const InputParameters params)

Definition at line 34 of file MaterialVectorAuxKernelAction.C.

35  : Action(params),
36  _grain_num(getParam<unsigned int>("grain_num")),
37  _var_name_base(getParam<std::vector<std::string>>("variable_base")),
38  _num_var(_var_name_base.size()),
39  _prop(getParam<std::vector<MaterialPropertyName>>("property")),
40  _num_prop(_prop.size())
41 {
42 }
const unsigned int _grain_num
number of grains to create
const std::vector< MaterialPropertyName > & _prop
list of material properties to be used
const unsigned int _num_prop
number of properties
const unsigned int _num_var
number of auxvariables
Action(const InputParameters &parameters)
const std::vector< std::string > & _var_name_base
base name for the auxvariables
const T & getParam(const std::string &name) const

Member Function Documentation

◆ act()

void MaterialVectorAuxKernelAction::act ( )
virtual

Implements Action.

Reimplemented in MaterialVectorGradAuxKernelAction.

Definition at line 45 of file MaterialVectorAuxKernelAction.C.

46 {
47  if (_num_prop != _num_var)
48  paramError("property", "variable_base and property must be vectors of the same size");
49 
50  for (unsigned int gr = 0; gr < _grain_num; ++gr)
51  for (unsigned int val = 0; val < _num_var; ++val)
52  {
53  std::string var_name = _var_name_base[val] + Moose::stringify(gr);
54 
55  InputParameters params = _factory.getValidParams("MaterialStdVectorAux");
56  params.set<AuxVariableName>("variable") = var_name;
57  params.set<MaterialPropertyName>("property") = _prop[val];
58  params.set<unsigned int>("index") = gr;
59  params.set<bool>("use_displaced_mesh") = getParam<bool>("use_displaced_mesh");
60 
61  std::string aux_kernel_name = var_name;
62  _problem->addAuxKernel("MaterialStdVectorAux", aux_kernel_name, params);
63  }
64 }
const unsigned int _grain_num
number of grains to create
const std::vector< MaterialPropertyName > & _prop
list of material properties to be used
const unsigned int _num_prop
number of properties
const unsigned int _num_var
number of auxvariables
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
const std::vector< std::string > & _var_name_base
base name for the auxvariables
Factory & _factory
void paramError(const std::string &param, Args... args) const
std::string stringify(const T &t)
std::shared_ptr< FEProblemBase > & _problem

◆ validParams()

InputParameters MaterialVectorAuxKernelAction::validParams ( )
static

Definition at line 18 of file MaterialVectorAuxKernelAction.C.

Referenced by MaterialVectorGradAuxKernelAction::validParams().

19 {
21  params.addClassDescription(
22  "Outputs all components of the standard vector-valued properties specified");
23  params.addRequiredParam<unsigned int>(
24  "grain_num", "Value that specifies the number of grains to create aux kernels for.");
25  params.addRequiredParam<std::vector<std::string>>(
26  "variable_base", "Vector specifies the base name of the variables.");
27  params.addRequiredParam<std::vector<MaterialPropertyName>>("property",
28  "The material property names.");
29  params.addParam<bool>(
30  "use_displaced_mesh", false, "Whether to use displaced mesh in the kernels.");
31  return params;
32 }
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()
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _grain_num

const unsigned int MaterialVectorAuxKernelAction::_grain_num
protected

number of grains to create

Definition at line 25 of file MaterialVectorAuxKernelAction.h.

Referenced by act(), and MaterialVectorGradAuxKernelAction::act().

◆ _num_prop

const unsigned int MaterialVectorAuxKernelAction::_num_prop
protected

number of properties

Definition at line 37 of file MaterialVectorAuxKernelAction.h.

Referenced by act(), and MaterialVectorGradAuxKernelAction::act().

◆ _num_var

const unsigned int MaterialVectorAuxKernelAction::_num_var
protected

number of auxvariables

Definition at line 31 of file MaterialVectorAuxKernelAction.h.

Referenced by act(), and MaterialVectorGradAuxKernelAction::act().

◆ _prop

const std::vector<MaterialPropertyName>& MaterialVectorAuxKernelAction::_prop
protected

list of material properties to be used

Definition at line 34 of file MaterialVectorAuxKernelAction.h.

Referenced by act(), and MaterialVectorGradAuxKernelAction::act().

◆ _var_name_base

const std::vector<std::string>& MaterialVectorAuxKernelAction::_var_name_base
protected

base name for the auxvariables

Definition at line 28 of file MaterialVectorAuxKernelAction.h.

Referenced by act(), and MaterialVectorGradAuxKernelAction::act().


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