www.mooseframework.org
Public Member Functions | Protected Attributes | List of all members
PolycrystalVoronoiVoidICAction Class Reference

Sets up a polycrystal initial condition with voids on grain boundaries for all order parameters. More...

#include <PolycrystalVoronoiVoidICAction.h>

Inheritance diagram for PolycrystalVoronoiVoidICAction:
[legend]

Public Member Functions

 PolycrystalVoronoiVoidICAction (const InputParameters &params)
 
virtual void act ()
 

Protected Attributes

const unsigned int _op_num
 
const std::string _var_name_base
 
const FileName _file_name
 

Detailed Description

Sets up a polycrystal initial condition with voids on grain boundaries for all order parameters.

Definition at line 19 of file PolycrystalVoronoiVoidICAction.h.

Constructor & Destructor Documentation

◆ PolycrystalVoronoiVoidICAction()

PolycrystalVoronoiVoidICAction::PolycrystalVoronoiVoidICAction ( const InputParameters &  params)

Definition at line 36 of file PolycrystalVoronoiVoidICAction.C.

37  : Action(params),
38  _op_num(getParam<unsigned int>("op_num")),
39  _var_name_base(getParam<std::string>("var_name_base")),
40  _file_name(getParam<FileName>("file_name"))
41 {
42 }

Member Function Documentation

◆ act()

void PolycrystalVoronoiVoidICAction::act ( )
virtual

Definition at line 45 of file PolycrystalVoronoiVoidICAction.C.

46 {
47  // Loop through the number of order parameters
48  for (unsigned int op = 0; op < _op_num; op++)
49  {
50  // Set parameters for BoundingBoxIC
51  InputParameters poly_params = _factory.getValidParams("PolycrystalVoronoiVoidIC");
52  poly_params.applyParameters(parameters());
53  poly_params.set<unsigned int>("op_index") = op;
54  poly_params.set<VariableName>("variable") = _var_name_base + Moose::stringify(op);
55  poly_params.set<MooseEnum>("structure_type") = "grains";
56  poly_params.set<UserObjectName>("polycrystal_ic_uo") =
57  getParam<UserObjectName>("polycrystal_ic_uo");
58 
59  // Add initial condition
60  _problem->addInitialCondition(
61  "PolycrystalVoronoiVoidIC", name() + "_" + Moose::stringify(op), poly_params);
62  }
63 }

Member Data Documentation

◆ _file_name

const FileName PolycrystalVoronoiVoidICAction::_file_name
protected

Definition at line 29 of file PolycrystalVoronoiVoidICAction.h.

◆ _op_num

const unsigned int PolycrystalVoronoiVoidICAction::_op_num
protected

Definition at line 27 of file PolycrystalVoronoiVoidICAction.h.

Referenced by act().

◆ _var_name_base

const std::string PolycrystalVoronoiVoidICAction::_var_name_base
protected

Definition at line 28 of file PolycrystalVoronoiVoidICAction.h.

Referenced by act().


The documentation for this class was generated from the following files:
PolycrystalVoronoiVoidICAction::_var_name_base
const std::string _var_name_base
Definition: PolycrystalVoronoiVoidICAction.h:28
name
const std::string name
Definition: Setup.h:21
PolycrystalVoronoiVoidICAction::_op_num
const unsigned int _op_num
Definition: PolycrystalVoronoiVoidICAction.h:27
PolycrystalVoronoiVoidICAction::_file_name
const FileName _file_name
Definition: PolycrystalVoronoiVoidICAction.h:29