RandomIC

RandomIC produces a field of random numbers in the range specified by its "min" and "max" parameters (inclusive). An initial seed value may be set with the "seed" parameter.

note

The RandomIC class does not currently produce parallel or thread agnostic random fields (If you don't know what this means, don't worry about it). Additionally, this class uses the global random number generator instead of the random number system in MOOSE. It's possible that the seed value could be clobbered by other classes using the global generator.

Class Description

This class produces a random field for a variable. It is not parallel agnostic.

Input Parameters

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

Required Parameters

  • max1Upper bound of the randomly generated values

    Default:1

    C++ Type:double

    Description:Upper bound of the randomly generated values

  • 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

  • seed0Seed value for the random number generator

    Default:0

    C++ Type:unsigned int

    Description:Seed value for the random number generator

  • 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

  • min0Lower bound of the randomly generated values

    Default:0

    C++ Type:double

    Description:Lower bound of the randomly generated values

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