PFCRFFKernelAction

construction:Undocumented Action Class

The PFCRFFKernelAction 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 an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Set up kernels for the rational function fit (RFF) phase field crystal model

Overview

Example Input File Syntax

Set up kernels for the rational function fit (RFF) phase field crystal model

Input Parameters

L_name_baseBase name for the complex L variables
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:Base name for the complex L variables
log_approachWhich approach will be used to handle the natural log
C++ Type:MooseEnum
Unit:(no unit assumed)
Options:tolerance, cancelation, expansion
Controllable:No
Description:Which approach will be used to handle the natural log
n_nameVariable name used for the n variable
C++ Type:VariableName
Unit:(no unit assumed)
Controllable:No
Description:Variable name used for the n variable
num_Lspecifies the number of complex L variables will be solved for
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:specifies the number of complex L variables will be solved for

Required Parameters

a1Parameter in the Taylor series expansion
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Parameter in the Taylor series expansion
active__all__ If specified only the blocks named will be visited and made active
Default:__all__
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:If specified only the blocks named will be visited and made active
b1Parameter in the Taylor series expansion
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Parameter in the Taylor series expansion
c1Parameter in the Taylor series expansion
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Parameter in the Taylor series expansion
inactiveIf specified blocks matching these identifiers will be skipped.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:If specified blocks matching these identifiers will be skipped.
mob_nameMThe mobility used for n in this model
Default:M
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:The mobility used for n in this model
n_exp_terms4Number of terms used in the Taylor expansion of the natural log term
Default:4
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Number of terms used in the Taylor expansion of the natural log term
tol1e-09Tolerance used when the tolerance approach is chosen
Default:1e-09
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Tolerance used when the tolerance approach is chosen
use_displaced_meshFalseWhether to use displaced mesh in the kernels
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether to use displaced mesh in the kernels

Optional Parameters