BimodalSuperellipsoidsIC

buildconstruction:Undocumented Class

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

Overview

Example Input File Syntax

Input Parameters

  • asSemiaxis a for each superellipsoid

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:Semiaxis a for each superellipsoid

  • bsSemiaxis b for each superellipsoid

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:Semiaxis b for each superellipsoid

  • csSemiaxis c for each superellipsoid

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:Semiaxis c for each superellipsoid

  • invalueThe variable value inside the superellipsoid

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The variable value inside the superellipsoid

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

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

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

  • npartThe number of random (small) particles to place

    C++ Type:unsigned int

    Unit:(no unit assumed)

    Controllable:No

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

  • nsExponent n for each superellipsoid

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:Exponent n for each superellipsoid

  • outvalueThe variable value outside the superellipsoid

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The variable value outside the superellipsoid

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

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

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

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

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

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

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

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

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

  • small_nExponent n for the randomly placed (small) superellipsoids

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

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

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

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

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

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

    C++ Type:VariableName

    Unit:(no unit assumed)

    Controllable:No

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

  • x_positionsThe x-coordinate for each superellipsoid center

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:The x-coordinate for each superellipsoid center

  • y_positionsThe y-coordinate for each superellipsoid center

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:The y-coordinate for each superellipsoid center

  • z_positionsThe z-coordinate for each superellipsoid center

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:The z-coordinate for each superellipsoid center

Required Parameters

  • blockThe list of blocks (ids or names) that this object will be applied

    C++ Type:std::vector<SubdomainName>

    Unit:(no unit assumed)

    Controllable:No

    Description:The list of blocks (ids or names) that this object will be applied

  • 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

  • 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

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

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

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

  • numtries1000The number of tries to place the random particles

    Default:1000

    C++ Type:unsigned int

    Unit:(no unit assumed)

    Controllable:No

    Description:The number of tries to place the random particles

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

  • 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

  • size_variation0Plus or minus fraction of random variation in the semiaxes 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 semiaxes for uniform, standard deviation for normal

  • size_variation_typenoneType of distribution that random semiaxes will follow

    Default:none

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:uniform, normal, none

    Controllable:No

    Description:Type of distribution that random semiaxes will follow

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

    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.

Optional Parameters

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

    C++ Type:std::vector<std::string>

    Unit:(no unit assumed)

    Controllable:No

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Set the enabled status of the MooseObject.

  • 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

    Unit:(no unit assumed)

    Controllable:No

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

Advanced Parameters