Automatically generates all variables to model a polycrystal with op_num orderparameters. More...

#include <PolycrystalRandomICAction.h>

Inheritance diagram for PolycrystalRandomICAction:

Public Types
typedef DataFileName	DataFileParameterType

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

Private Attributes
const unsigned int	_op_num

const std::string	_var_name_base

const MooseEnum	_random_type

Detailed Description

Automatically generates all variables to model a polycrystal with op_num orderparameters.

Definition at line 19 of file PolycrystalRandomICAction.h.

Constructor & Destructor Documentation

◆ PolycrystalRandomICAction()

PolycrystalRandomICAction::PolycrystalRandomICAction ( const InputParameters & params )

Definition at line 36 of file PolycrystalRandomICAction.C.

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

Member Function Documentation

◆ act()

void PolycrystalRandomICAction::act ( )

virtual

Implements Action.

Definition at line 45 of file PolycrystalRandomICAction.C.

 {
 #ifdef DEBUG
   Moose::err << "Inside the PolycrystalRandomICAction Object" << std::endl;
 #endif
 
   // Loop through the number of order parameters
   for (unsigned int op = 0; op < _op_num; op++)
   {
     // Set parameters for BoundingBoxIC
     InputParameters poly_params = _factory.getValidParams("PolycrystalRandomIC");
     poly_params.set<VariableName>("variable") = _var_name_base + Moose::stringify(op);
     poly_params.set<unsigned int>("op_index") = op;
     poly_params.set<unsigned int>("random_type") = _random_type;
     poly_params.applySpecificParameters(parameters(), {"op_num", "block"});
 
     // Add initial condition
     _problem->addInitialCondition("PolycrystalRandomIC",
                                   "ICs/PolycrystalICs/PolycrystalRandomIC_" + Moose::stringify(op),
                                   poly_params);
   }
 }

◆ validParams()

InputParameters PolycrystalRandomICAction::validParams ( )

static

Definition at line 18 of file PolycrystalRandomICAction.C.

 {
   InputParameters params = Action::validParams();
   params.addClassDescription("Sets random polycrystal initial conditions for each order parameter");
   params.addRequiredParam<unsigned int>("op_num", "number of order parameters to create");
   params.addRequiredParam<std::string>("var_name_base", "specifies the base name of the variables");
   MooseEnum typ_options("continuous discrete");
   params.addRequiredParam<MooseEnum>("random_type",
                                      typ_options,
                                      "The type of random polycrystal initial condition. Whether "
                                      "one order parameter is chosen to be 1 at each node or if "
                                      "each other parameter continuously varies from 0 to 1");
   params.addParam<std::vector<SubdomainName>>(
       "block", {}, "Block restriction for the initial condition");
 
   return params;
 }

Member Data Documentation

◆ _op_num

const unsigned int PolycrystalRandomICAction::_op_num

private

Definition at line 29 of file PolycrystalRandomICAction.h.

Referenced by act().

◆ _random_type

const MooseEnum PolycrystalRandomICAction::_random_type

private

Definition at line 31 of file PolycrystalRandomICAction.h.

Referenced by act().

◆ _var_name_base

const std::string PolycrystalRandomICAction::_var_name_base

private

Definition at line 30 of file PolycrystalRandomICAction.h.

Referenced by act().

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

phase_field/include/actions/PolycrystalRandomICAction.h
phase_field/src/actions/PolycrystalRandomICAction.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 Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PolycrystalRandomICAction()

Member Function Documentation

◆ act()

◆ validParams()

Member Data Documentation

◆ _op_num

◆ _random_type

◆ _var_name_base