PFCFreezingIC

buildconstruction:Undocumented Class

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

Base class for generating a random field for a variable.

Overview

Example Input File Syntax

Input Parameters

  • lcThe lattice constant off the crystal structure

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The lattice constant off the crystal structure

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

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

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

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

    Unit:(no unit assumed)

    Controllable:No

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

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

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

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

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

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

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

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

  • crystal_structureThe type of crystal structure

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:FCC, BCC

    Controllable:No

    Description:The type of crystal structure

  • inside1Value inside sinusoids

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Value inside sinusoids

  • legacy_generatorFalseDetermines whether or not the legacy generator (deprecated) should be used.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Determines whether or not the legacy generator (deprecated) should be used.

  • max1Upper bound of the randomly generated values

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Upper bound of the randomly generated values

  • min0Lower bound of the randomly generated values

    Default:0

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Lower bound of the randomly generated values

  • outside0Value outside sinusoids

    Default:0

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Value outside sinusoids

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

  • seed0Seed value for the random number generator

    Default:0

    C++ Type:unsigned int

    Unit:(no unit assumed)

    Controllable:No

    Description:Seed value for the random number generator

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

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

    Default:0

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

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

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

    Default:0

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

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