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 | List of all members
BicrystalCircleGrainICAction Class Reference

Bicrystal with a circular grain and an embedding outer grain. More...

#include <BicrystalCircleGrainICAction.h>

Inheritance diagram for BicrystalCircleGrainICAction:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 BicrystalCircleGrainICAction (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)
 
MooseAppgetMooseApp () 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 InputParametersparameters () 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
 
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
 
PerfGraphperfGraph ()
 
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 std::string _var_name_base
 
const unsigned int _op_num
 
const Real _radius
 
const Real _x
 
const Real _y
 
const Real _z
 
const Real _int_width
 
const bool _3D_sphere
 

Detailed Description

Bicrystal with a circular grain and an embedding outer grain.

Definition at line 18 of file BicrystalCircleGrainICAction.h.

Constructor & Destructor Documentation

◆ BicrystalCircleGrainICAction()

BicrystalCircleGrainICAction::BicrystalCircleGrainICAction ( const InputParameters params)

Definition at line 38 of file BicrystalCircleGrainICAction.C.

39  : Action(params),
40  _var_name_base(getParam<std::string>("var_name_base")),
41  _op_num(getParam<unsigned int>("op_num")),
42  _radius(getParam<Real>("radius")),
43  _x(getParam<Real>("x")),
44  _y(getParam<Real>("y")),
45  _z(getParam<Real>("z")),
46  _int_width(getParam<Real>("int_width")),
47  _3D_sphere(getParam<bool>("3D_sphere"))
48 {
49  if (_op_num != 2)
50  paramError("op_num", "op_num must equal 2 for bicrystal ICs");
51 }
Action(const InputParameters &parameters)
void paramError(const std::string &param, Args... args) const

Member Function Documentation

◆ act()

void BicrystalCircleGrainICAction::act ( )
virtual

Implements Action.

Definition at line 54 of file BicrystalCircleGrainICAction.C.

55 {
56  // Loop through the number of order parameters
57  for (unsigned int op = 0; op < _op_num; op++)
58  {
59  // Create variable names
60  std::string var_name = _var_name_base + Moose::stringify(op);
61 
62  // Set parameters for SmoothCircleIC
63  InputParameters poly_params = _factory.getValidParams("SmoothCircleIC");
64  poly_params.set<VariableName>("variable") = var_name;
65  poly_params.set<Real>("x1") = _x;
66  poly_params.set<Real>("y1") = _y;
67  poly_params.set<Real>("z1") = _z;
68  poly_params.set<Real>("radius") = _radius;
69  poly_params.set<Real>("int_width") = _int_width;
70  poly_params.set<bool>("3D_spheres") = _3D_sphere;
71  if (op == 0)
72  {
73  // Values for circle grain
74  poly_params.set<Real>("invalue") = 1.0;
75  poly_params.set<Real>("outvalue") = 0.0;
76  }
77  else
78  {
79  // Values for matrix grain
80  poly_params.set<Real>("invalue") = 0.0;
81  poly_params.set<Real>("outvalue") = 1.0;
82  }
83  poly_params.applySpecificParameters(_pars, {"block"});
84 
85  // Add initial condition
86  _problem->addInitialCondition(
87  "SmoothCircleIC", "BicrystalCircleGrainIC_" + Moose::stringify(op), poly_params);
88  }
89 }
void applySpecificParameters(const InputParameters &common, const std::vector< std::string > &include, bool allow_private=false)
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
Factory & _factory
std::string stringify(const T &t)
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
const InputParameters & _pars
std::shared_ptr< FEProblemBase > & _problem

◆ validParams()

InputParameters BicrystalCircleGrainICAction::validParams ( )
static

Definition at line 18 of file BicrystalCircleGrainICAction.C.

19 {
21  params.addClassDescription("Bicrystal with a circular grain and an embedding outer grain");
22  params.addRequiredParam<std::string>("var_name_base", "specifies the base name of the variables");
23  params.addRequiredParam<unsigned int>("op_num", "Number of grains, should be 2");
24  params.addRequiredParam<Real>("radius", "Void radius");
25  params.addRequiredParam<Real>("x", "The x coordinate of the circle grain center");
26  params.addRequiredParam<Real>("y", "The y coordinate of the circle grain center");
27  params.addParam<Real>("z", 0.0, "The z coordinate of the circle grain center");
28  params.addParam<Real>(
29  "int_width", 0.0, "The interfacial width of the void surface. Defaults to sharp interface");
30  params.addParam<bool>(
31  "3D_sphere", true, "in 3D, whether the smaller grain is a spheres or columnar grain");
32  params.addParam<std::vector<SubdomainName>>("block",
33  "Block restriction for the initial condition");
34 
35  return params;
36 }
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
void addRequiredParam(const std::string &name, const std::string &doc_string)
static InputParameters validParams()
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _3D_sphere

const bool BicrystalCircleGrainICAction::_3D_sphere
private

Definition at line 35 of file BicrystalCircleGrainICAction.h.

Referenced by act().

◆ _int_width

const Real BicrystalCircleGrainICAction::_int_width
private

Definition at line 33 of file BicrystalCircleGrainICAction.h.

Referenced by act().

◆ _op_num

const unsigned int BicrystalCircleGrainICAction::_op_num
private

Definition at line 29 of file BicrystalCircleGrainICAction.h.

Referenced by act(), and BicrystalCircleGrainICAction().

◆ _radius

const Real BicrystalCircleGrainICAction::_radius
private

Definition at line 31 of file BicrystalCircleGrainICAction.h.

Referenced by act().

◆ _var_name_base

const std::string BicrystalCircleGrainICAction::_var_name_base
private

Definition at line 28 of file BicrystalCircleGrainICAction.h.

Referenced by act().

◆ _x

const Real BicrystalCircleGrainICAction::_x
private

Definition at line 32 of file BicrystalCircleGrainICAction.h.

Referenced by act().

◆ _y

const Real BicrystalCircleGrainICAction::_y
private

Definition at line 32 of file BicrystalCircleGrainICAction.h.

Referenced by act().

◆ _z

const Real BicrystalCircleGrainICAction::_z
private

Definition at line 32 of file BicrystalCircleGrainICAction.h.

Referenced by act().


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