PolycrystalVoronoiVoidICAction

construction:Undocumented Action Class

The PolycrystalVoronoiVoidICAction has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Sets polycrystal Voronoi void initial conditions for each order parameter

Overview

Example Input File Syntax

Sets polycrystal Voronoi void initial conditions for each order parameter

Input Parameters

bubspacminimum spacing of bubbles, measured from center to center
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:minimum spacing of bubbles, measured from center to center
invalueThe variable value inside the circle
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The variable value inside the circle
numbubThe number of bubbles to place
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:The number of bubbles to place
op_numNumber of order parameters
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:Number of order parameters
outvalueThe variable value outside the circle
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The variable value outside the circle
polycrystal_ic_uoUserObject for obtaining the polycrystal grain structure.
C++ Type:UserObjectName
Unit:(no unit assumed)
Controllable:No
Description:UserObject for obtaining the polycrystal grain structure.
radiusMean radius value for the circles
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Mean radius value for the circles
var_name_basespecifies the base name of the variables
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:specifies the base name of the variables

Required Parameters

3D_spheresTruein 3D, whether the objects are spheres or columns
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
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<std::string>
Unit:(no unit assumed)
Controllable:No
Description:If specified only the blocks named will be visited and made active
blockBlock restriction for the initial condition
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
Controllable:No
Description:Block restriction for the initial condition
boundaryThe list of boundaries (ids or names) from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Unit:(no unit assumed)
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
columnar_3DFalse3D microstructure will be columnar in the z-direction?
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:3D microstructure will be columnar in the z-direction?
file_nameFile containing grain centroids, if file_name is provided, the centroids from the file will be used.
C++ Type:FileName
Unit:(no unit assumed)
Controllable:No
Description:File containing grain centroids, if file_name is provided, the centroids from the file will be used.
inactiveIf specified blocks matching these identifiers will be skipped.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:If specified blocks matching these identifiers will be skipped.
int_width0The interfacial width of the void surface. Defaults to sharp interface
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The interfacial width of the void surface. Defaults to sharp interface
numtries1000The number of tries
Default:1000
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:The number of tries
profileCOSFunctional dependence for the interface profile
Default:COS
C++ Type:MooseEnum
Unit:(no unit assumed)
Options:COS, TANH
Controllable:No
Description:Functional dependence for the interface profile
prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
radius_variation0Plus or minus fraction of random variation in the bubble radius for uniform, standard deviation for normal
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
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
Unit:(no unit assumed)
Options:uniform, normal, none
Controllable:No
Description:Type of distribution that random circle radii will follow
rand_seed12345Seed value for the random number generator
Default:12345
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:Seed value for the random number generator
use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
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
Unit:(no unit assumed)
Controllable:No
Description:Set the gradient DOFs to zero. This can avoid numerical problems with higher order shape functions and overlapping circles.

Optional Parameters