BimodalSuperellipsoidsIC

under construction:Undocumented Class

The BimodalSuperellipsoidsIC 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.

Bimodal size distribution of large particles (specified in input file) and small particles (placed randomly outside the larger particles)

Input Parameters

  • x_positionsThe x-coordinate for each superellipsoid center

    C++ Type:std::vector

    Description:The x-coordinate for each superellipsoid center

  • nsExponent n for each superellipsoid

    C++ Type:std::vector

    Description:Exponent n for each superellipsoid

  • y_positionsThe y-coordinate for each superellipsoid center

    C++ Type:std::vector

    Description:The y-coordinate for each superellipsoid center

  • large_spacminimum spacing between large and small particles, measured from closest edge to closest edge

    C++ Type:double

    Description:minimum spacing between large and small particles, measured from closest edge to closest edge

  • z_positionsThe z-coordinate for each superellipsoid center

    C++ Type:std::vector

    Description:The z-coordinate for each superellipsoid center

  • outvalueThe variable value outside the superellipsoid

    C++ Type:double

    Description:The variable value outside the superellipsoid

  • npartThe number of random (small) particles to place

    C++ Type:unsigned int

    Description:The number of random (small) particles to place

  • small_nExponent n for the randomly placed (small) superellipsoids

    C++ Type:double

    Description:Exponent n for the randomly placed (small) superellipsoids

  • asSemiaxis a for each superellipsoid

    C++ Type:std::vector

    Description:Semiaxis a for each superellipsoid

  • 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.

  • bsSemiaxis b for each superellipsoid

    C++ Type:std::vector

    Description:Semiaxis b for each superellipsoid

  • csSemiaxis c for each superellipsoid

    C++ Type:std::vector

    Description:Semiaxis c for each superellipsoid

  • invalueThe variable value inside the superellipsoid

    C++ Type:double

    Description:The variable value inside the superellipsoid

  • small_cMean semiaxis c value for the randomly placed (small) superellipsoids

    C++ Type:double

    Description:Mean semiaxis c value for the randomly placed (small) superellipsoids

  • small_bMean semiaxis b value for the randomly placed (small) superellipsoids

    C++ Type:double

    Description:Mean semiaxis b value for the randomly placed (small) superellipsoids

  • small_aMean semiaxis a value for the randomly placed (small) superellipsoids

    C++ Type:double

    Description:Mean semiaxis a value for the randomly placed (small) superellipsoids

  • small_spacminimum spacing between small particles, measured from closest edge to closest edge

    C++ Type:double

    Description:minimum spacing between small particles, measured from closest edge to closest edge

Required Parameters

  • nestedvalueThe variable value for nested particles inside the superellipsoid in inverse configuration

    C++ Type:double

    Description:The variable value for nested particles inside the superellipsoid in inverse configuration

  • size_variation0Plus or minus fraction of random variation in the semiaxes for uniform, standard deviation for normal

    Default:0

    C++ Type:double

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

  • rand_seed12345Seed value for the random number generator

    Default:12345

    C++ Type:unsigned int

    Description:Seed value for the random number generator

  • numtries1000The number of tries to place the random particles

    Default:1000

    C++ Type:unsigned int

    Description:The number of tries to place the random particles

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

    Default:False

    C++ Type:bool

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

  • 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

  • size_variation_typenoneType of distribution that random semiaxes will follow

    Default:none

    C++ Type:MooseEnum

    Description:Type of distribution that random semiaxes will follow

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