KKSPhaseChemicalPotential

KKS model kernel to enforce the pointwise equality of phase chemical potentials dFa/dca = dFb/dcb. The non-linear variable of this kernel is ca.

Enforces the point wise equality of the phase chemical potentials

The non-linear variable of this Kernel is .

Residual

Jacobian

For the Jacobian we need to calculate

On-Diagonal

Off-Diagonal

With the union of the argument vectors of and (represented in the code by _coupled_moose_vars[]) we get

Again the is non-zero only if , which is the case if is the argument selected through jvar.

Note that in the code jvar is not an index into _coupled_moose_vars[] but has to be resolved through the _jvar_map.

Input Parameters

  • cbPhase b concentration

    C++ Type:std::vector

    Options:

    Description:Phase b concentration

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

    C++ Type:MaterialPropertyName

    Options:

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

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

    C++ Type:MaterialPropertyName

    Options:

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

  • variableThe name of the variable that this Kernel operates on

    C++ Type:NonlinearVariableName

    Options:

    Description:The name of the variable that this Kernel operates on

Required Parameters

  • args_aVector of further parameters to Fa (optional, to add in second cross derivatives of Fa)

    C++ Type:std::vector

    Options:

    Description:Vector of further parameters to Fa (optional, to add in second cross derivatives of Fa)

  • args_bVector of further parameters to Fb (optional, to add in second cross derivatives of Fb)

    C++ Type:std::vector

    Options:

    Description:Vector of further parameters to Fb (optional, to add in second cross derivatives of Fb)

  • blockThe list of block ids (SubdomainID) that this object will be applied

    C++ Type:std::vector

    Options:

    Description:The list of block ids (SubdomainID) that this object will be applied

  • displacementsThe displacements

    C++ Type:std::vector

    Options:

    Description:The displacements

  • ka1Site fraction for the ca variable (specify this if ca is a sublattice concentration, and make sure it is a true site fraction eg. 0.6666666)

    Default:1

    C++ Type:double

    Options:

    Description:Site fraction for the ca variable (specify this if ca is a sublattice concentration, and make sure it is a true site fraction eg. 0.6666666)

  • kb1Site fraction for the cb variable (specify this if ca is a sublattice concentration, and make sure it is a true site fraction eg. 0.6666666)

    Default:1

    C++ Type:double

    Options:

    Description:Site fraction for the cb variable (specify this if ca is a sublattice concentration, and make sure it is a true site fraction eg. 0.6666666)

Optional Parameters

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

    C++ Type:std::vector

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

    C++ Type:std::vector

    Options:

    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    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

    Options:

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

  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

    C++ Type:std::vector

    Options:

    Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Options:

    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

    Options:

    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

  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

    C++ Type:std::vector

    Options:

    Description:The extra tags for the matrices this Kernel should fill

  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

    C++ Type:std::vector

    Options:

    Description:The extra tags for the vectors this Kernel should fill

  • matrix_tagssystemThe tag for the matrices this Kernel should fill

    Default:system

    C++ Type:MultiMooseEnum

    Options:nontime system

    Description:The tag for the matrices this Kernel should fill

  • vector_tagsnontimeThe tag for the vectors this Kernel should fill

    Default:nontime

    C++ Type:MultiMooseEnum

    Options:nontime time

    Description:The tag for the vectors this Kernel should fill

Tagging Parameters

Input Files