#include <MaterialVectorAuxKernelAction.h>

Inheritance diagram for MaterialVectorAuxKernelAction:

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)

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 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.

   : Action(params),
     _grain_num(getParam<unsigned int>("grain_num")),
     _var_name_base(getParam<std::vector<std::string>>("variable_base")),
     _num_var(_var_name_base.size()),
     _prop(getParam<std::vector<MaterialPropertyName>>("property")),
     _num_prop(_prop.size())
 {
 }

Member Function Documentation

◆ act()

void MaterialVectorAuxKernelAction::act ( )

virtual

Implements Action.

Reimplemented in MaterialVectorGradAuxKernelAction.

Definition at line 45 of file MaterialVectorAuxKernelAction.C.

 {
   if (_num_prop != _num_var)
     paramError("property", "variable_base and property must be vectors of the same size");
 
   for (unsigned int gr = 0; gr < _grain_num; ++gr)
     for (unsigned int val = 0; val < _num_var; ++val)
     {
       std::string var_name = _var_name_base[val] + Moose::stringify(gr);
 
       InputParameters params = _factory.getValidParams("MaterialStdVectorAux");
       params.set<AuxVariableName>("variable") = var_name;
       params.set<MaterialPropertyName>("property") = _prop[val];
       params.set<unsigned int>("index") = gr;
       params.set<bool>("use_displaced_mesh") = getParam<bool>("use_displaced_mesh");
 
       std::string aux_kernel_name = var_name;
       _problem->addAuxKernel("MaterialStdVectorAux", aux_kernel_name, params);
     }
 }

◆ validParams()

InputParameters MaterialVectorAuxKernelAction::validParams ( )

static

Definition at line 18 of file MaterialVectorAuxKernelAction.C.

Referenced by MaterialVectorGradAuxKernelAction::validParams().

 {
   InputParameters params = Action::validParams();
   params.addClassDescription(
       "Outputs all components of the standard vector-valued properties specified");
   params.addRequiredParam<unsigned int>(
       "grain_num", "Value that specifies the number of grains to create aux kernels for.");
   params.addRequiredParam<std::vector<std::string>>(
       "variable_base", "Vector specifies the base name of the variables.");
   params.addRequiredParam<std::vector<MaterialPropertyName>>("property",
                                                              "The material property names.");
   params.addParam<bool>(
       "use_displaced_mesh", false, "Whether to use displaced mesh in the kernels.");
   return params;
 }