GBAnisotropy

buildconstruction:Undocumented Class

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

A material to compute anisotropic grain boundary energies and mobilities.

Overview

Example Input File Syntax

Input Parameters

  • Anisotropic_GB_file_nameName of the file containing: 1)GB mobility prefactor; 2) GB migration activation energy; 3)GB energy

    C++ Type:FileName

    Unit:(no unit assumed)

    Controllable:No

    Description:Name of the file containing: 1)GB mobility prefactor; 2) GB migration activation energy; 3)GB energy

  • inclination_anisotropyFalseThe GB anisotropy inclination would be considered if true

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:The GB anisotropy inclination would be considered if true

  • vArray of coupled variables

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Array of coupled variables

  • wGBDiffuse GB width in nm

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Diffuse GB width in nm

Required Parameters

  • T300.0Temperature in Kelvin

    Default:300.0

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Temperature in Kelvin

  • 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

  • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

  • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

    Default:NONE

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:NONE, ELEMENT, SUBDOMAIN

    Controllable:No

    Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

  • declare_suffixAn optional suffix parameter that can be appended to any declared 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 declared properties. The suffix will be prepended with a '_' character.

  • delta_mob0.1factor determining inclination dependence of GB mobility

    Default:0.1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:factor determining inclination dependence of GB mobility

  • delta_sigma0.1factor determining inclination dependence of GB energy

    Default:0.1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:factor determining inclination dependence of GB energy

  • length_scale1e-09Length scale in m, where default is nm

    Default:1e-09

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Length scale in m, where default is nm

  • molar_volume_value7.11e-06molar volume of material in m^3/mol, by default it's the value of copper

    Default:7.11e-06

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:molar volume of material in m^3/mol, by default it's the value of copper

  • op_numArray of coupled variables (num_name)

    C++ Type:unsigned int

    Unit:(no unit assumed)

    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

    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.

  • time_scale1e-09Time scale in s, where default is ns

    Default:1e-09

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Time scale in s, where default is ns

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

  • var_name_baseArray of coupled variables (base_name)

    C++ Type:std::string

    Unit:(no unit assumed)

    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>

    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:Yes

    Description:Set the enabled status of the MooseObject.

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Determines whether this object is calculated using an implicit or explicit form

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Unit:(no unit assumed)

    Controllable:No

    Description:The seed for the master random number generator

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

  • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

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

    Unit:(no unit assumed)

    Controllable:No

    Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

  • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

    Default:none

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

Outputs Parameters