KKSGlobalFreeEnergy

under construction:Undocumented Class

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

Total free energy in KKS system, including chemical, barrier and gradient terms

Input Parameters

  • variableThe name of the variable that this object applies to

    C++ Type:AuxVariableName

    Description:The name of the variable that this object applies to

  • fa_nameBase name of the free energy function F (f_name in the corresponding derivative function material)

    C++ Type:MaterialPropertyName

    Description:Base name of the free energy function F (f_name in the corresponding derivative function material)

  • fb_nameBase name of the free energy function F (f_name in the corresponding derivative function material)

    C++ Type:MaterialPropertyName

    Description:Base name of the free energy function F (f_name in the corresponding derivative function material)

  • wDouble well height parameter

    C++ Type:double

    Description:Double well height parameter

Required Parameters

  • interfacial_varsVariable names that contribute to interfacial energy

    C++ Type:std::vector

    Description:Variable names that contribute to interfacial energy

  • kappa_namesVector of kappa names corresponding to each variable name in interfacial_vars in the same order. For basic KKS, there is 1 kappa, 1 interfacial_var.

    C++ Type:std::vector

    Description:Vector of kappa names corresponding to each variable name in interfacial_vars in the same order. For basic KKS, there is 1 kappa, 1 interfacial_var.

  • h_namehBase name for the switching function h(eta)

    Default:h

    C++ Type:MaterialPropertyName

    Description:Base name for the switching function h(eta)

  • g_namegBase name for the double well function g(eta)

    Default:g

    C++ Type:MaterialPropertyName

    Description:Base name for the double well function g(eta)

  • execute_onLINEARThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

    Default:LINEAR

    C++ Type:ExecFlagEnum

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

  • 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

  • additional_free_energyCoupled variable holding additional free energy contributions to be summed up

    C++ Type:std::vector

    Description:Coupled variable holding additional free energy contributions to be summed up

  • 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

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

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    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

    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

References