Action that sets up ACSEDGPoly Kernels that adds the stored energy contribution to grain growth models. More...

#include <PolycrystalStoredEnergyAction.h>

Inheritance diagram for PolycrystalStoredEnergyAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	PolycrystalStoredEnergyAction (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 &	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

PerfGraph &	perfGraph ()

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
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	_op_num
	number of grains to create More...

const std::string	_var_name_base
	base name for the order parameter variables More...

const unsigned int	_deformed_grain_num
	number of deformed grains 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

Action that sets up ACSEDGPoly Kernels that adds the stored energy contribution to grain growth models.

This allows such models to simulate recrystallization as well.

Definition at line 18 of file PolycrystalStoredEnergyAction.h.

Constructor & Destructor Documentation

◆ PolycrystalStoredEnergyAction()

PolycrystalStoredEnergyAction::PolycrystalStoredEnergyAction ( const InputParameters & params )

Definition at line 39 of file PolycrystalStoredEnergyAction.C.

   : Action(params),
     _op_num(getParam<unsigned int>("op_num")),
     _var_name_base(getParam<std::string>("var_name_base")),
     _deformed_grain_num(getParam<unsigned int>("deformed_grain_num"))
 {
 }

Member Function Documentation

◆ act()

void PolycrystalStoredEnergyAction::act ( )

virtual

Implements Action.

Definition at line 48 of file PolycrystalStoredEnergyAction.C.

 {
   for (unsigned int op = 0; op < _op_num; ++op)
   {
     //
     // Create variable names
     //
 
     std::string var_name = _var_name_base + Moose::stringify(op);
     std::vector<VariableName> v;
     v.resize(_op_num - 1);
 
     unsigned int ind = 0;
     for (unsigned int j = 0; j < _op_num; ++j)
       if (j != op)
         v[ind++] = _var_name_base + Moose::stringify(j);
 
     //
     // Set up ACSEDGPoly Stored Energy in Deformed Grains kernels
     //
 
     InputParameters params = _factory.getValidParams("ACSEDGPoly");
     params.set<NonlinearVariableName>("variable") = var_name;
     params.set<std::vector<VariableName>>("v") = v;
     params.set<UserObjectName>("grain_tracker") = getParam<UserObjectName>("grain_tracker");
     params.set<bool>("use_displaced_mesh") = getParam<bool>("use_displaced_mesh");
     params.set<unsigned int>("deformed_grain_num") = getParam<unsigned int>("deformed_grain_num");
     params.set<unsigned int>("op_index") = op;
 
     std::string kernel_name = "ACStoredEnergy_" + var_name;
     _problem->addKernel("ACSEDGPoly", kernel_name, params);
   }
 }

◆ validParams()

InputParameters PolycrystalStoredEnergyAction::validParams ( )

static

Definition at line 18 of file PolycrystalStoredEnergyAction.C.

 {
   InputParameters params = Action::validParams();
   params.addClassDescription("Action that adds the contribution of stored energy associated with "
                              "dislocations to grain growth models");
   params.addRequiredParam<unsigned int>("op_num",
                                         "specifies the total number of OPs representing "
                                         "all grains (deformed + undeformed "
                                         "(recrystallized)) to create");
   params.addRequiredParam<std::string>("var_name_base", "specifies the base name of the variables");
   params.addParam<VariableName>("c", "Name of coupled concentration variable");
   params.addRequiredParam<unsigned int>("deformed_grain_num",
                                         "specifies the number of deformed grains to create");
   params.addParam<VariableName>("T", "Name of temperature variable");
   params.addParam<bool>(
       "use_displaced_mesh", false, "Whether to use displaced mesh in the kernels");
   params.addRequiredParam<UserObjectName>("grain_tracker",
                                           "The GrainTracker UserObject to get values from.");
   return params;
 }

Member Data Documentation

◆ _deformed_grain_num

const unsigned int PolycrystalStoredEnergyAction::_deformed_grain_num

protected

number of deformed grains

Definition at line 35 of file PolycrystalStoredEnergyAction.h.

◆ _op_num

const unsigned int PolycrystalStoredEnergyAction::_op_num

protected

number of grains to create

Definition at line 29 of file PolycrystalStoredEnergyAction.h.

Referenced by act().

◆ _var_name_base

const std::string PolycrystalStoredEnergyAction::_var_name_base

protected

base name for the order parameter variables

Definition at line 32 of file PolycrystalStoredEnergyAction.h.

Referenced by act().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PolycrystalStoredEnergyAction()

Member Function Documentation

◆ act()

◆ validParams()

Member Data Documentation

◆ _deformed_grain_num

◆ _op_num

◆ _var_name_base