CrossIC

under construction:Undocumented Class

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

Cross-shaped initial condition

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

  • y21The y coordinate of the upper right-hand corner of the box

    Default:1

    C++ Type:double

    Description:The y coordinate of the upper right-hand corner of the box

  • y10The y coordinate of the lower left-hand corner of the box

    Default:0

    C++ Type:double

    Description:The y coordinate of the lower left-hand corner of the box

  • buffer0.03125A small area between the max value and the interface

    Default:0.03125

    C++ Type:double

    Description:A small area between the max value and the interface

  • average0The average value

    Default:0

    C++ Type:double

    Description:The average value

  • x21The x coordinate of the upper right-hand corner of the box

    Default:1

    C++ Type:double

    Description:The x coordinate of the upper right-hand corner of the box

  • width0.125The width

    Default:0.125

    C++ Type:double

    Description:The width

  • length0.75The length

    Default:0.75

    C++ Type:double

    Description:The length

  • amplitude1The amplitude

    Default:1

    C++ Type:double

    Description:The amplitude

  • interface0.03125The interface width

    Default:0.03125

    C++ Type:double

    Description:The interface width

  • 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

  • x10The x coordinate of the lower left-hand corner of the box

    Default:0

    C++ Type:double

    Description:The x coordinate of the lower left-hand corner of the box

  • 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

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