Automatically generates all auxvariables given vectors telling it the names and how many to create. More...

#include <MultiAuxVariablesAction.h>

Inheritance diagram for MultiAuxVariablesAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	MultiAuxVariablesAction (const InputParameters &params)

virtual void	act ()

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type) override

bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)

InputParameters &	getObjectParams ()

const InputParameters &	getObjectParams () const

const std::string &	getMooseObjectType () const

void	timedAct ()

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

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () 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 &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (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

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecatedNoTrace (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) 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 ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

static MooseEnum	getAuxVariableFamilies ()

static MooseEnum	getAuxVariableOrders ()

static MooseEnum	getNonlinearVariableFamilies ()

static MooseEnum	getNonlinearVariableOrders ()

static libMesh::FEType	feType (const InputParameters &params)

static std::string	determineType (const libMesh::FEType &fe_type, unsigned int components, bool is_fv=false)

static std::string	variableType (const libMesh::FEType &fe_type, const bool is_fv=false, const bool is_array=false)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	unique_action_name_param

static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
void	init () override

void	addVariable (const std::string &var_name)

virtual std::string	varName () const

void	createInitialConditionAction (const std::vector< Real > &value)

std::set< SubdomainID >	getSubdomainIDs ()

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

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) 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

const std::vector< std::string > &	_var_name_base
	base name for the auxvariables

const unsigned int	_num_var
	number of auxvariables

const MultiMooseEnum &	_data_type
	list of material properties to be used

const unsigned int	_data_size
	number of properties

libMesh::FEType	_fe_type

bool	_scalar_var

bool	_fv_var

unsigned int	_components

std::function< void(FEProblemBase &, const std::string &, const std::string &, InputParameters &)>	_problem_add_var_method

std::string	_type

InputParameters	_moose_object_pars

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

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_name

const InputParameters &	_pars

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Private Member Functions
bool	addRelationshipManager (Moose::RelationshipManagerType input_rm_type, const InputParameters &moose_object_pars, std::string rm_name, Moose::RelationshipManagerType rm_type, Moose::RelationshipManagerInputParameterCallback rm_input_parameter_func, Moose::RMSystemType sys_type=Moose::RMSystemType::NONE)

virtual std::string	meshPropertyPrefix (const std::string &data_name) const

const RestartableDataValue &	getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const

void	mooseErrorInternal (Args &&... args) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
const ParallelParamObject &	_parent

MooseApp &	_meta_data_app

const MooseObject *const	_meta_data_object

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

Detailed Description

Automatically generates all auxvariables given vectors telling it the names and how many to create.

Definition at line 18 of file MultiAuxVariablesAction.h.

Constructor & Destructor Documentation

◆ MultiAuxVariablesAction()

MultiAuxVariablesAction::MultiAuxVariablesAction ( const InputParameters & params )

Definition at line 35 of file MultiAuxVariablesAction.C.

  : AddAuxVariableAction(params),
    _grain_num(getParam<unsigned int>("grain_num")),
    _var_name_base(getParam<std::vector<std::string>>("variable_base")),
    _num_var(_var_name_base.size()),
    _data_type(getParam<MultiMooseEnum>("data_type")),
    _data_size(_data_type.size())
{
}

Member Function Documentation

◆ act()

void MultiAuxVariablesAction::act ( )

virtual

for extracting data from MaterialProperty<std::vector<Real> >

for extracting data from MaterialProperty<std::vector<RealGradient> >

The name of the variable is the variable name base followed by the order parameter and a suffix mentioning dimension it applies to.

Reimplemented from AddAuxVariableAction.

Definition at line 46 of file MultiAuxVariablesAction.C.

{
  init();
 
  if (_num_var != _data_size)
    mooseError("Data type not provided for all the AuxVariables in MultiAuxVariablesAction");
 
  // mesh dimension & components required for gradient variables
  const unsigned int dim = _mesh->dimension();
  const std::vector<char> suffix = {'x', 'y', 'z'};
 
  // Loop through the number of order parameters
  for (unsigned int val = 0; val < _num_var; ++val)
    for (unsigned int gr = 0; gr < _grain_num; ++gr)
    {
      if (_data_type[val] == "Real")
      {
        // Create variable names with variable name base followed by the order parameter it applies
        // to.
        std::string var_name = _var_name_base[val] + Moose::stringify(gr);
 
        _problem->addAuxVariable(_type, var_name, _moose_object_pars);
      }
      if (_data_type[val] == "RealGradient")
        for (unsigned int x = 0; x < dim; ++x)
        {
          std::string var_name = _var_name_base[val] + Moose::stringify(gr) + "_" + suffix[x];
 
          _problem->addAuxVariable(_type, var_name, _moose_object_pars);
        }
    }
}

◆ validParams()

InputParameters MultiAuxVariablesAction::validParams ( )

static

Definition at line 18 of file MultiAuxVariablesAction.C.

{
  InputParameters params = AddAuxVariableAction::validParams();
  params.addClassDescription("Set up auxvariables for components of "
                             "MaterialProperty<std::vector<data_type> > for polycrystal sample.");
  params.addRequiredParam<unsigned int>(
      "grain_num", "Specifies the number of grains to create the aux variables for.");
  params.addRequiredParam<std::vector<std::string>>(
      "variable_base", "Vector that specifies the base name of the variables.");
  MultiMooseEnum data_type("Real RealGradient", "Real");
  params.addRequiredParam<MultiMooseEnum>(
      "data_type",
      data_type,
      "Specifying data type of the materials property, variables are created accordingly");
  return params;
}

Member Data Documentation

◆ _data_size

const unsigned int MultiAuxVariablesAction::_data_size

protected

number of properties

Definition at line 41 of file MultiAuxVariablesAction.h.

Referenced by act().

◆ _data_type

const MultiMooseEnum& MultiAuxVariablesAction::_data_type

protected

list of material properties to be used

Definition at line 38 of file MultiAuxVariablesAction.h.

Referenced by act().

◆ _grain_num

const unsigned int MultiAuxVariablesAction::_grain_num

protected

number of grains to create

Definition at line 29 of file MultiAuxVariablesAction.h.

Referenced by act().

◆ _num_var

const unsigned int MultiAuxVariablesAction::_num_var

protected

number of auxvariables

Definition at line 35 of file MultiAuxVariablesAction.h.

Referenced by act().

◆ _var_name_base

const std::vector<std::string>& MultiAuxVariablesAction::_var_name_base

protected

base name for the auxvariables

Definition at line 32 of file MultiAuxVariablesAction.h.

Referenced by act().

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

phase_field/include/actions/MultiAuxVariablesAction.h
phase_field/src/actions/MultiAuxVariablesAction.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MultiAuxVariablesAction()

Member Function Documentation

◆ act()

◆ validParams()

Member Data Documentation

◆ _data_size

◆ _data_type

◆ _grain_num

◆ _num_var

◆ _var_name_base