Application Usage link

Physics and Syntax

Application Development link

Framework Development link

MOOSEDocs link

Infrastructure

Questions

Information and Tools

HHPFCRFFSplitKernelAction

under construction:Undocumented Action Class

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


# HHPFCRFFSplitKernelAction

!syntax description /Kernels/HHPFCRFFSplitKernel/HHPFCRFFSplitKernelAction

## Overview

!! Replace these lines with information regarding the HHPFCRFFSplitKernelAction action.

## Example Input File Syntax

!! Describe and include an example of how to use the HHPFCRFFSplitKernelAction action.

!syntax parameters /Kernels/HHPFCRFFSplitKernel/HHPFCRFFSplitKernelAction

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

    Options:

    Description:Base name for the complex L variables

  • log_approachWhich approach will be used to handle the natural log

    C++ Type:MooseEnum

    Options:tolerance cancelation expansion

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

  • n_nameVariable name used for the n variable

    C++ Type:VariableName

    Options:

    Description:Variable name used for the n variable

  • num_Lspecifies the number of complex L variables will be solved for

    C++ Type:unsigned int

    Options:

    Description:specifies the number of complex L variables will be solved for

Required Parameters

  • active__all__ If specified only the blocks named will be visited and made active

    Default:__all__

    C++ Type:std::vector

    Options:

    Description:If specified only the blocks named will be visited and made active

  • inactiveIf specified blocks matching these identifiers will be skipped.

    C++ Type:std::vector

    Options:

    Description:If specified blocks matching these identifiers will be skipped.

  • mob_nameMThe mobility used for n in this model

    Default:M

    C++ Type:MaterialPropertyName

    Options:

    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

    Options:

    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

    Options:

    Description:Tolerance used when the tolerance approach is chosen

  • use_displaced_meshFalseWhether to use displaced mesh in the kernels

    Default:False

    C++ Type:bool

    Options:

    Description:Whether to use displaced mesh in the kernels

Optional Parameters