PolycrystalVoronoiVoidICAction

under construction:Undocumented Class

The PolycrystalVoronoiVoidICAction 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 an action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

!syntax description /ICs/PolycrystalICs/PolycrystalVoronoiVoidIC/PolycrystalVoronoiVoidICAction

Input Parameters

  • var_name_basespecifies the base name of the variables

    C++ Type:std::string

    Options:

    Description:specifies the base name of the variables

  • bubspacminimum spacing of bubbles, measured from center to center

    C++ Type:double

    Options:

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

  • op_numNumber of order parameters

    C++ Type:unsigned int

    Options:

    Description:Number of order parameters

  • numbubThe number of bubbles to place

    C++ Type:unsigned int

    Options:

    Description:The number of bubbles to place

  • radiusMean radius value for the circles

    C++ Type:double

    Options:

    Description:Mean radius value for the circles

  • outvalueThe variable value outside the circle

    C++ Type:double

    Options:

    Description:The variable value outside the circle

  • invalueThe variable value inside the circle

    C++ Type:double

    Options:

    Description:The variable value inside the circle

Required Parameters

  • profileCOSFunctional dependence for the interface profile

    Default:COS

    C++ Type:MooseEnum

    Options:COS TANH

    Description:Functional dependence for the interface profile

  • grain_num0Number of grains being represented by the order parameters

    Default:0

    C++ Type:unsigned int

    Options:

    Description:Number of grains being represented by the order parameters

  • file_nameFile containing grain centroids, if file_name is provided, the centroids from the file will be used.

    C++ Type:FileName

    Options:

    Description:File containing grain centroids, if file_name is provided, the centroids from the file will be used.

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

    Default:False

    C++ Type:bool

    Options:

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

  • rand_seed12444The random seed

    Default:12444

    C++ Type:unsigned int

    Options:

    Description:The random seed

  • numtries1000The number of tries

    Default:1000

    C++ Type:unsigned int

    Options:

    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

    Options:

    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

    Options:uniform normal none

    Description:Type of distribution that random circle radii will follow

  • inactiveIf specified blocks matching these identifiers will be skipped.

    C++ Type:std::vector

    Options:

    Description:If specified blocks matching these identifiers will be skipped.

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

    Default:True

    C++ Type:bool

    Options:

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

  • active__all__ If specified only the blocks named will be visited and made active

    Default:__all__

    C++ Type:std::vector

    Options:

    Description:If specified only the blocks named will be visited and made active

  • 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

    Options:

    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

    Options:

    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

    Options:

    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

    Options:

    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

    Options:

    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

    Options:

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

References