CHPFCRFF

under construction:Undocumented Class

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

Cahn-Hilliard residual for the RFF form of the phase field crystal model

Input Parameters

  • 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

  • log_approachWhich approach will be used to handle the natural log

    C++ Type:MooseEnum

    Options:tolerance cancelation expansion nothing

    Description:Which approach will be used to handle the natural log

  • vArray of names of the real parts of the L variables

    C++ Type:std::vector

    Options:

    Description:Array of names of the real parts of the L variables

Required Parameters

  • a1Constants on Taylor Series

    Default:1

    C++ Type:double

    Options:

    Description:Constants on Taylor Series

  • mob_nameMThe mobility used with the kernel

    Default:M

    C++ Type:MaterialPropertyName

    Options:

    Description:The mobility used with the kernel

  • c1Constants on Taylor Series

    Default:1

    C++ Type:double

    Options:

    Description:Constants on Taylor Series

  • b1Constants on Taylor Series

    Default:1

    C++ Type:double

    Options:

    Description:Constants on Taylor Series

  • Dmob_nameDMThe D mobility used with the kernel

    Default:DM

    C++ Type:MaterialPropertyName

    Options:

    Description:The D mobility used with the kernel

  • n_exp_terms4Number of terms used in the Taylor expansion of the natural log term

    Default:4

    C++ Type:double

    Options:

    Description:Number of terms used in the Taylor expansion of the natural log term

  • has_MJacFalseJacobian information for the mobility is defined

    Default:False

    C++ Type:bool

    Options:

    Description:Jacobian information for the mobility is defined

  • tol1e-09Tolerance used when the tolerance approach is chosen

    Default:1e-09

    C++ Type:double

    Options:

    Description:Tolerance used when the tolerance approach is chosen

  • 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

Optional Parameters

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

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

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

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

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Options:

    Description:The seed for the master random number generator

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

  • 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

Advanced Parameters

  • 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

  • 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

  • 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

Tagging Parameters

References