# CrossIC

under construction:Undocumented Class

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


# CrossIC

!syntax description /ICs/CrossIC

## Overview

!! Replace these lines with information regarding the CrossIC object.

## Example Input File Syntax

!! Describe and include an example of how to use the CrossIC object.

!syntax parameters /ICs/CrossIC

!syntax inputs /ICs/CrossIC

!syntax children /ICs/CrossIC


Cross-shaped initial condition

## Input Parameters

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

C++ Type:VariableName

Options:

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

### Required Parameters

• amplitude1The amplitude

Default:1

C++ Type:double

Options:

Description:The amplitude

• average0The average value

Default:0

C++ Type:double

Options:

Description:The average value

• blockThe list of block ids (SubdomainID) that this object will be applied

C++ Type:std::vector

Options:

Description:The list of block ids (SubdomainID) that this object will be applied

• boundaryThe list of boundary IDs from the mesh where this boundary condition applies

C++ Type:std::vector

Options:

Description:The list of boundary IDs from the mesh where this boundary condition applies

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

Default:0.03125

C++ Type:double

Options:

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

• interface0.03125The interface width

Default:0.03125

C++ Type:double

Options:

Description:The interface width

• length0.75The length

Default:0.75

C++ Type:double

Options:

Description:The length

• width0.125The width

Default:0.125

C++ Type:double

Options:

Description:The width

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

Default:0

C++ Type:double

Options:

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

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

Default:1

C++ Type:double

Options:

Description:The x 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

Options:

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

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

Default:1

C++ Type:double

Options:

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

### Optional Parameters

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

C++ Type:std::vector

Options:

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

• enableTrueSet the enabled status of the MooseObject.

Default:True

C++ Type:bool

Options:

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

Options:

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