PolycrystalVoronoiVoidIC

under construction:Undocumented Class

The PolycrystalVoronoiVoidIC has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Random distribution of smooth circles with given minimum spacing

Input Parameters

  • grain_numNumber of grains being represented by the order parameters

    C++ Type:unsigned int

    Description:Number of grains being represented by the order parameters

  • bubspacminimum spacing of bubbles, measured from center to center

    C++ Type:double

    Description:minimum spacing of bubbles, measured from center to center

  • op_numNumber of order parameters

    C++ Type:unsigned int

    Description:Number of order parameters

  • numbubThe number of bubbles to place

    C++ Type:unsigned int

    Description:The number of bubbles to place

  • radiusMean radius value for the circles

    C++ Type:double

    Description:Mean radius value for the circles

  • outvalueThe variable value outside the circle

    C++ Type:double

    Description:The variable value outside the circle

  • variableThe variable this initial condition is supposed to provide values for.

    C++ Type:VariableName

    Description:The variable this initial condition is supposed to provide values for.

  • structure_typeWhich structure type is being initialized, grains or voids

    C++ Type:MooseEnum

    Description:Which structure type is being initialized, grains or voids

  • invalueThe variable value inside the circle

    C++ Type:double

    Description:The variable value inside the circle

Required Parameters

  • op_index0The index for the current order parameter, not needed if structure_type = voids

    Default:0

    C++ Type:unsigned int

    Description:The index for the current order parameter, not needed if structure_type = voids

  • columnar_3DFalse3D microstructure will be columnar in the z-direction?

    Default:False

    C++ Type:bool

    Description:3D microstructure will be columnar in the z-direction?

  • rand_seed12444The random seed

    Default:12444

    C++ Type:unsigned int

    Description:The random seed

  • numtries1000The number of tries

    Default:1000

    C++ Type:unsigned int

    Description:The number of tries

  • radius_variation0Plus or minus fraction of random variation in the bubble radius for uniform, standard deviation for normal

    Default:0

    C++ Type:double

    Description:Plus or minus fraction of random variation in the bubble radius for uniform, standard deviation for normal

  • radius_variation_typenoneType of distribution that random circle radii will follow

    Default:none

    C++ Type:MooseEnum

    Description:Type of distribution that random circle radii will follow

  • 3D_spheresTruein 3D, whether the objects are spheres or columns

    Default:True

    C++ Type:bool

    Description:in 3D, whether the objects are spheres or columns

  • zero_gradientFalseSet the gradient DOFs to zero. This can avoid numerical problems with higher order shape functions and overlapping circles.

    Default:False

    C++ Type:bool

    Description:Set the gradient DOFs to zero. This can avoid numerical problems with higher order shape functions and overlapping circles.

  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies

    C++ Type:std::vector

    Description:The list of boundary IDs from the mesh where this boundary condition applies

  • int_width0The interfacial width of the void surface. Defaults to sharp interface

    Default:0

    C++ Type:double

    Description:The interfacial width of the void surface. Defaults to sharp interface

  • blockThe list of block ids (SubdomainID) that this object will be applied

    C++ Type:std::vector

    Description:The list of block ids (SubdomainID) that this object will be applied

Optional Parameters

  • ignore_uo_dependencyFalseWhen set to true, a UserObject retrieved by this IC will not be executed before the this IC

    Default:False

    C++ Type:bool

    Description:When set to true, a UserObject retrieved by this IC will not be executed before the this IC

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

References