BndsCalcIC

Initialize the location of grain boundaries in a polycrystalline sample

BndsCalcIC initializes the location of the grain boundaries in a polycrystalline sample. This is beneficial for executing the initial adaptivity based on the grain boundary locations.

Note: This is only useful when the order parameters are initialized with a diffused interface.

Example Input Syntax

[./bnds]
  type = BndsCalcIC # IC is created for activating the initial adaptivity
  variable = bnds
[../]
(../moose/modules/phase_field/test/tests/initial_conditions/polycrystal_BndsCalcIC.i)

Input Parameters

  • vArray of coupled variables

    C++ Type:std::vector<VariableName>

    Controllable:No

    Description:Array of coupled variables

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

    C++ Type:VariableName

    Controllable:No

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

Required Parameters

  • blockThe list of blocks (ids or names) that this object will be applied

    C++ Type:std::vector<SubdomainName>

    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>

    Controllable:No

    Description:The list of boundaries (ids or names) from the mesh where this object applies

  • op_numArray of coupled variables (num_name)

    C++ Type:unsigned int

    Controllable:No

    Description:Array of coupled variables (num_name)

  • 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

    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.

  • var_name_baseArray of coupled variables (base_name)

    C++ Type:std::string

    Controllable:No

    Description:Array of coupled variables (base_name)

Optional Parameters

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

    C++ Type:std::vector<std::string>

    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

    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

    Controllable:No

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

Advanced Parameters

References

No citations exist within this document.