PFCFreezingIC

under construction:Undocumented Class

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

!syntax description /ICs/PFCFreezingIC

Input Parameters

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

    C++ Type:double

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

  • lcThe lattice constant off the crystal structure

    C++ Type:double

    Description:The lattice constant off the crystal structure

  • y1The y coordinate of the lower left-hand corner of the frozen box

    C++ Type:double

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

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

    C++ Type:double

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

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

  • x1The x coordinate of the lower left-hand corner of the frozen box

    C++ Type:double

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

Required Parameters

  • min0Lower bound of the randomly generated values

    Default:0

    C++ Type:double

    Description:Lower bound of the randomly generated values

  • max1Upper bound of the randomly generated values

    Default:1

    C++ Type:double

    Description:Upper bound of the randomly generated values

  • inside1Value inside sinusoids

    Default:1

    C++ Type:double

    Description:Value inside sinusoids

  • z20The z coordinate of the upper right-hand corner of the box

    Default:0

    C++ Type:double

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

  • outside0Value outside sinusoids

    Default:0

    C++ Type:double

    Description:Value outside sinusoids

  • seed0Seed value for the random number generator

    Default:0

    C++ Type:unsigned int

    Description:Seed value for the random number generator

  • crystal_structureThe type of crystal structure

    C++ Type:MooseEnum

    Description:The type of crystal structure

  • 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

  • z10The z coordinate of the lower left-hand corner of the box

    Default:0

    C++ Type:double

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