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 | Private Attributes | Static Private Attributes | List of all members
Tricrystal2CircleGrainsICAction Class Reference

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

#include <Tricrystal2CircleGrainsICAction.h>

Inheritance diagram for Tricrystal2CircleGrainsICAction:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 Tricrystal2CircleGrainsICAction (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
 
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 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 mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
void callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr) 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)
 

Public Attributes

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 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
 
Factory & _factory
 
ActionFactory & _action_factory
 
const std::string & _type
 
const std::string & _name
 
const InputParameters & _pars
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
const Parallel::Communicator & _communicator
 

Private Attributes

std::string _var_name_base
 
unsigned int _op_num
 

Static Private Attributes

static const Real _abs_zero_tol = 1e-12
 

Detailed Description

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

Definition at line 18 of file Tricrystal2CircleGrainsICAction.h.

Constructor & Destructor Documentation

◆ Tricrystal2CircleGrainsICAction()

Tricrystal2CircleGrainsICAction::Tricrystal2CircleGrainsICAction ( const InputParameters &  params)

Definition at line 44 of file Tricrystal2CircleGrainsICAction.C.

45  : Action(params),
46  _var_name_base(getParam<std::string>("var_name_base")),
47  _op_num(getParam<unsigned int>("op_num"))
48 {
49 }
Action::Action
Action(const InputParameters &parameters)

Member Function Documentation

◆ act()

void Tricrystal2CircleGrainsICAction::act ( )
virtual

Implements Action.

Definition at line 52 of file Tricrystal2CircleGrainsICAction.C.

53 {
54 #ifdef DEBUG
55  Moose::err << "Inside the Tricrystal2CircleGrainsICAction Object" << std::endl;
56 #endif
57 
58  // Loop through the number of order parameters
59  for (unsigned int op = 0; op < _op_num; op++)
60  {
61  // Create variable names
62  std::string var_name = _var_name_base;
63  std::stringstream out;
64  out << op;
65  var_name.append(out.str());
66 
67  // Set parameters for BoundingBoxIC
68  InputParameters poly_params = _factory.getValidParams("Tricrystal2CircleGrainsIC");
69  poly_params.set<VariableName>("variable") = var_name;
70  poly_params.set<unsigned int>("op_index") = op;
71  poly_params.applySpecificParameters(parameters(), {"op_num", "block"});
72 
73  // Add initial condition
74  _problem->addInitialCondition("Tricrystal2CircleGrainsIC",
75  "Tricrystal2CircleGrainsIC_" + Moose::stringify(op),
76  poly_params);
77  }
78 }
InputParameters::applySpecificParameters
void applySpecificParameters(const InputParameters &common, const std::vector< std::string > &include, bool allow_private=false)
Action::_factory
Factory & _factory
Action::parameters
const InputParameters & parameters() const
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
Factory::getValidParams
InputParameters getValidParams(const std::string &name) const
Moose::stringify
std::string stringify(const T &t)
out
OStreamProxy out
Action::_problem
std::shared_ptr< FEProblemBase > & _problem

◆ validParams()

InputParameters Tricrystal2CircleGrainsICAction::validParams ( )
static

Definition at line 31 of file Tricrystal2CircleGrainsICAction.C.

32 {
33  InputParameters params = Action::validParams();
34  params.addClassDescription("Sets initial conditions for the order parameters representing the "
35  "tri-crystal grain structure");
36  params.addRequiredParam<unsigned int>("op_num", "number of order parameters to create");
37  params.addRequiredParam<std::string>("var_name_base", "specifies the base name of the variables");
38  params.addParam<std::vector<SubdomainName>>(
39  "block", {}, "Block restriction for the initial condition");
40 
41  return params;
42 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
Action::validParams
static InputParameters validParams()
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _abs_zero_tol

const Real Tricrystal2CircleGrainsICAction::_abs_zero_tol = 1e-12
staticprivate

Definition at line 28 of file Tricrystal2CircleGrainsICAction.h.

◆ _op_num

unsigned int Tricrystal2CircleGrainsICAction::_op_num
private

Definition at line 31 of file Tricrystal2CircleGrainsICAction.h.

Referenced by act().

◆ _var_name_base

std::string Tricrystal2CircleGrainsICAction::_var_name_base
private

Definition at line 30 of file Tricrystal2CircleGrainsICAction.h.

Referenced by act().

The documentation for this class was generated from the following files:
Generated on Fri Aug 29 2025 20:26:52 for https://mooseframework.inl.gov by   doxygen 1.8.14